potpie Add hidden parameter to all create conversations API

Summary by CodeRabbit

New Features
- Introduced an option during conversation creation to determine whether a conversation appears in the main interface or is archived immediately.
- Refined conversation listings so that only active conversations are shown, streamlining the conversation view for users.

Apr 04 '25 09:04 dhirenmathur

Walkthrough

The changes add a new query parameter hidden to conversation creation endpoints across multiple modules. The parameter is passed through the API router, controller, and service layers, altering the conversation’s status based on its value. Additionally, filtering logic in the user service is updated to only retrieve conversations with an active status. These modifications standardize the process of marking conversations as hidden and ensure that the updated conversation status is consistently used throughout the related components.

Changes

File(s)	Change Summary
`app/api/router.py`, `app/.../conversations_router.py`	Added a new query parameter `hidden` to conversation creation endpoints with default values (True in `app/api/router.py` and False in `.../conversations_router.py`), and updated method calls to pass this parameter.
`app/.../conversation_controller.py`, `app/.../conversation_service.py`	Modified conversation creation methods to include the `hidden` parameter. Updated internal logic and status assignment (`ARCHIVED` if hidden, otherwise `ACTIVE`), including enhanced logging and record creation.
`app/modules/users/user_service.py`	Imported `ConversationStatus` and updated the filtering logic to retrieve only active conversations for a user.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant APIRouter
    participant Controller as ConversationController
    participant Service as ConversationService
    participant DB as Database

    Client->>APIRouter: POST /create_conversation?hidden=[true/false]
    APIRouter->>Controller: create_conversation(request, hidden)
    Controller->>Service: create_conversation(request, user_id, hidden)
    Service->>DB: _create_conversation_record(request, user_id, hidden)
    DB-->>Service: New Conversation Record
    Service-->>Controller: Conversation Created
    Controller-->>APIRouter: Response with Conversation
    APIRouter-->>Client: Return Conversation

Poem

I'm a rabbit hopping with glee,
New hidden flags set our code free.
Conversations now choose their fate,
Active or archived, oh isn't it great?
With each line of code, a hop of delight,
Carrots and commits make my day bright!
🥕🐰 Happy coding in the digital night!

✨ Finishing Touches

[ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json