search

digiteinfotech / kairon

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

Retry Broadcast #1359

Closed maheshsattala closed 3 months ago

maheshsattala commented 3 months ago

Added code related to Resend Broadcast. Made changes related to campaign metrics. Fixed and added test cases related to the same.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The update introduces a new broadcast message resend feature. A new endpoint has been added to facilitate resending broadcast messages, supported by modifications in validation, execution, and retry handling across various components. The changes include adjustments to data models, constants, and configurations to support the retry mechanism and logging.

Changes

File Path Change Summary
kairon/api/app/routers/bot/channels.py Added endpoint for resending broadcast messages.
kairon/events/definitions/message_broadcast.py Added methods for retry validation and broadcast resending.
kairon/events/definitions/scheduled_base.py Updated enqueue method to include resend logic and added abstract _resend_broadcast method.
kairon/shared/channels/broadcast/whatsapp.py Added resend logic with logging in Whatsapp class.
kairon/shared/chat/broadcast/constants.py Added new enum values for resend actions and broadcast types.
kairon/shared/chat/broadcast/data_objects.py Added retry_count field to MessageBroadcastSettings class.
kairon/shared/chat/broadcast/processor.py Modified methods to handle retry count and resend logic.
kairon/shared/constants.py Added resend_broadcast constant to EventRequestType enum.
kairon/shared/data/data_objects.py Added retry_broadcasting_limit field to BotSettings class.
system.yaml Added error_codes configuration for channels.
tests/integration_test/services_test.py Added tests for onboarding, resending, and listing broadcast messages.
tests/testing_data/system.yaml Added error_codes field for channels in system.yaml file.
tests/unit_test/action/action_test.py Included retry_broadcasting_limit in test dictionaries.
tests/unit_test/channels/broadcast_processor_test.py Adjusted test functions for schedules, retrieving, and deleting.
tests/unit_test/events/definitions_test.py Modified test methods for broadcast events to include retry_count.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API as API (channels.py)
    participant EventProcessor as Event Processor
    participant Config as Configuration
    participant Queue

    User->>API: POST /resend_message_broadcast_event
    API->>EventProcessor: Validate and process request
    EventProcessor->>Config: Retrieve broadcast configuration
    EventProcessor->>EventProcessor: Validate retry limit
    EventProcessor->>Queue: Enqueue resend broadcast event

    Note over EventProcessor: Execute resend logic
    Queue->>EventProcessor: Process resend event
    EventProcessor->>EventProcessor: Update retry count
    EventProcessor->>API: Send response
    API->>User: Broadcast resent

Poem

In the code, where logic flows, A retry path now gently grows. Resend the broadcast, give it a chance, To deliver the message, on a second dance. With counted tries, and error’s crest, Our system strives to do its best.

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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.