digiteinfotech / kairon

Conversational AI Platform to build effective Proactive Digital Assistants using Visual LLM Chaining
https://kairon.nimblework.com/bots
Apache License 2.0
247 stars 76 forks source link

Handlng access when collabarator leaves bot #1463

Closed GMayank0310 closed 3 weeks ago

GMayank0310 commented 3 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes introduce a new feature that allows users to leave a bot, including email notifications for bot owners when a member departs. This involves modifications to several files, including the addition of email templates, a new endpoint in the user router, and updates to account processing logic. Tests have been added to ensure the functionality works as intended, covering various scenarios related to leaving a bot.

Changes

Files Change Summary
email.yaml Added email template configurations for notifications when users leave a bot, including subject and body content.
kairon/api/app/routers/user.py Introduced a new asynchronous endpoint leave_bot for users to leave a bot, with access control and email notification functionality.
kairon/shared/account/data_objects.py Added a new field leave_bot_owner_notification to the MailTemplates class for storing notification details related to bot owners.
kairon/shared/account/processor.py Added a static method process_leave_bot to manage the logic for users leaving a bot, including checks for ownership and active integration tokens, and updated email template loading.
kairon/shared/utils.py Introduced a new static method __handle_member_left_bot for handling email notifications when a member leaves a bot and updated the mail formatting function to include this handler.
template/emails/leaveBotOwnerNotification.html Created a new HTML email template for notifying bot owners when a member leaves their bot, with a responsive design and dynamic content placeholders.
tests/integration_test/services_test.py Added new test functions to validate the functionality of leaving a bot, covering successful leave, owner restrictions, integration token checks, and non-existent bot scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UserRouter
    participant AccountProcessor
    participant MailUtility
    participant MailTemplates

    User->>UserRouter: leave_bot(bot_id)
    UserRouter->>AccountProcessor: process_leave_bot(bot_id, current_user)
    AccountProcessor->>AccountProcessor: Check ownership and tokens
    AccountProcessor-->>UserRouter: Success/Failure response
    UserRouter->>MailUtility: Send notification if applicable
    MailUtility->>MailTemplates: Generate email content
    MailUtility-->>User: Email sent confirmation

🐰
In the meadow, hops a little hare,
With news of bots, we’re here to share.
When members leave, an email flies,
To keep the owners wise and spry!
So hop along, and spread the cheer,
For every change brings joy, my dear!
🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 resolve` resolve all the CodeRabbit review comments. - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.