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

Schedule action #1411

Closed hiteshghuge closed 3 months ago

hiteshghuge commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

This update significantly enhances the Kairon framework by introducing new scheduling functionalities for actions within the bot's architecture. New classes, API endpoints, and robust testing improve the creation and management of scheduled actions, enriching user interaction and overall system responsiveness.

Changes

Files Change Summary
kairon/actions/definitions/.../factory.py
kairon/actions/definitions/.../schedule.py
Introduced ActionSchedule class for scheduling actions; enhanced ActionFactory to map ActionType.schedule_action to ActionSchedule.
kairon/api/app/routers/bot/action.py Added endpoints to manage scheduled actions: add_schedule_action, update_schedule_action, and list_schedule_actions.
kairon/api/models.py Introduced CustomActionDynamicParameterModel and ScheduleActionRequest classes for improved parameter management and validation in scheduled actions.
kairon/chat/utils.py Enhanced get_last_session_conversation method for improved MongoDB client configuration handling.
kairon/events/scheduler/factory.py Updated scheduler retrieval logic to align with a new configuration structure.
kairon/events/scheduler/kscheduler.py Added add_job_for_date method in KScheduler for scheduling jobs based on specific date and time.
kairon/shared/actions/data_objects.py Introduced CustomActionDynamicParameters and ScheduleAction classes for managing action parameters and scheduling configurations.
kairon/shared/actions/models.py Extended ActionType enum with schedule_action, enhancing action type functionality.
kairon/shared/actions/utils.py Refactored prepare_request method to improve readability by extracting logic into get_parameter_value.
kairon/shared/constants.py Added scheduler_evaluator to EventClass enum to introduce new event types.
kairon/shared/data/processor.py Implemented methods for managing scheduled actions: add_schedule_action, update_schedule_action, list_schedule_action, and get_schedule_action.
kairon/shared/utils.py Enhanced create_mongo_client method for flexible MongoDB client configuration.
tests/integration_test/action_service_test.py Added tests for scheduled actions, including handling of invalid inputs and ensuring correct logging.
tests/integration_test/services_test.py Introduced tests for adding and updating scheduled actions via the API, validating error handling and data integrity.
tests/unit_test/data_processor/data_processor_test.py Expanded tests for MongoProcessor to cover scheduling actions, ensuring robustness in addition, updating, and error scenarios.
system.yaml Added scheduler_evaluator entry to enhance event handling capabilities.
tests/testing_data/system.yaml Introduced scheduler_evaluator entry for integrating task definitions in testing configurations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant Scheduler
    participant Database

    User->>API: Request to add schedule action
    API->>Database: Store schedule action details
    Database-->>API: Confirmation of addition
    API->>User: Success response with action ID
    User->>API: Request to execute scheduled action
    API->>Scheduler: Trigger scheduled action
    Scheduler->>Database: Retrieve action details
    Database-->>Scheduler: Action details
    Scheduler->>User: Execute action and respond

πŸ‡ Hopping through the code with glee,
New features bloom, just wait and see!
Scheduled actions, a joy to share,
Enhancing bots with thoughtful care.
So let’s celebrate, with a little cheer,
For every change brings us near! πŸŽ‰


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.