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

Callback action mvp #1395

Closed hasinaxp closed 3 months ago

hasinaxp commented 3 months ago

Callback Action implementation and test cases

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update introduces a comprehensive callback system within the Kairon framework, enhancing bot interactions through new asynchronous capabilities. Key features include a robust ActionCallback class for managing callback actions, updated API endpoints for CRUD operations on callbacks, and improved models for callback configuration and logging. The addition of extensive testing functionalities ensures reliability and efficiency, paving the way for dynamic user interactions across various messaging platforms.

Changes

Files Change Summary
kairon/actions/definitions/callback_action.py, kairon/actions/definitions/factory.py Introduced ActionCallback class for managing callback actions; updated ActionFactory to integrate callbacks.
kairon/api/app/routers/bot/action.py Added multiple new API endpoints for managing callback configurations (CRUD operations).
kairon/api/models.py Introduced CallbackConfigRequest and CallbackActionConfigRequest models for structured data validation.
kairon/async_callback/channel_message_dispacher.py, kairon/async_callback/processor.py Added ChannelMessageDispatcher for handling messages across platforms; introduced CallbackProcessor.
kairon/shared/callback/data_objects.py Introduced CallbackConfig and utility functions for managing callback data and validation.
tests/unit_test/callback_test.py Added unit tests for validating callback system functionalities, including encryption and message handling.
requirements/prod.txt, system.yaml Updated dependencies to include fernet for encryption and added configurations for async callback actions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant CallbackProcessor
    participant Logger
    participant Database

    User->>API: Request callback action
    API->>CallbackProcessor: Validate and execute action
    CallbackProcessor->>Database: Retrieve configuration
    Database-->>CallbackProcessor: Return configuration
    CallbackProcessor->>Logger: Log execution details
    Logger-->>CallbackProcessor: Confirm log
    CallbackProcessor-->>API: Return success response
    API-->>User: Send response with action results

πŸ‡ In the meadow where bunnies play,
New callbacks hop in bright array.
With messages sent, the bots now cheer,
As actions dance, we hold them dear.
Let’s celebrate this joyful code,
With happy hops on this new road! 🌼


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.