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

Callback action v2 #1439

Closed hasinaxp closed 1 month ago

hasinaxp commented 1 month ago

callback action upgrades -> standalone, shorten url, state share between pyscript testcase fixes and new test cases prepare_request_with_bot

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates significantly enhance the callback management system by introducing new configuration attributes and improving error handling. Key improvements include identifier-based processing, enriched logging, and enhanced security through encryption methods. The test suite has been expanded to cover a wider range of scenarios, ensuring that the system remains robust while adapting to new functionalities.

Changes

Files Change Summary
kairon/actions/definitions/.../callback_action.py, schedule.py Updated execute methods with new logic for handling callback URLs and scheduling data, enhancing flexibility and robustness in response management.
kairon/api/models.py Added new fields to CallbackConfigRequest, improving configuration capabilities for handling callbacks.
kairon/async_callback/.../processor.py Enhanced error handling in run_pyscript and async_callback, introduced a new parsing method, and updated parameter signatures for clarity.
kairon/async_callback/router/.../pyscript_callback.py Modified process_router_message to implement a token-based identification system, streamlining routing and simplifying function internals.
kairon/chat/handlers/channels/whatsapp.py Added import to support enhanced response conversion mechanisms for WhatsApp.
kairon/shared/actions/utils.py, kairon/shared/callback/.../data_objects.py Introduced new utility methods for HTTP requests and added encryption/decryption functionalities, bolstering security for sensitive data management.
kairon/shared/data/processor.py Expanded add_callback to include new parameters for improved validation and handling of callback configurations.
system.yaml, tests/testing_data/system.yaml Introduced xor_secret, aes_key, and aes_iv parameters for enhanced security in asynchronous callback actions.
tests/integration_test/.../action_service_test.py, callback_service_test.py, services_test.py Enhanced test suites with new cases and refined logic to ensure comprehensive coverage of updated callback functionalities and configurations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CallbackService
    participant Processor
    participant Database

    User->>CallbackService: Send Callback Request
    CallbackService->>Processor: Process callback with identifier
    Processor->>Database: Verify Callback Config
    Database-->>Processor: Return Config Data
    Processor->>CallbackService: Generate Response
    CallbackService-->>User: Return Final Response

πŸ‡ "Hippity hop, the code does dance,
With callbacks now, there’s a chance!
A sprinkle of secrets, a dash of delight,
Our system now sparkles, oh what a sight!
So let’s raise our ears and cheer with glee,
For changes that make our code feel free!" πŸ‡


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.