Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mail channel - changed interval from minutes to hrs #1659

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

hasinaxp
Copy link
Contributor

@hasinaxp hasinaxp commented Dec 16, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced scheduling for mail reading jobs, now running at the start of each interval hour.
  • Bug Fixes

    • Improved error handling for scheduling and stopping mail reading, providing clearer error messages.
  • Refactor

    • Updated parameter name in string_to_list method for clarity and consistency.

Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request modifies the EventUtility class in the kairon/events/utility.py file, focusing on improvements to the mail reading scheduling mechanism. The changes adjust the interval calculation for scheduling jobs, ensuring a minimum interval of 1 and a maximum of 24 hours. The cron expression has been updated to run jobs at the start of each interval hour instead of every interval minute. Error handling has been enhanced to provide more descriptive exceptions during scheduling and stopping mail reading processes.

Changes

File Change Summary
kairon/events/utility.py - Modified schedule_channel_mail_reading method
- Updated interval calculation with max(1, int(mail_processor.config.get("interval", 2)) % 24)
- Changed cron expression from */{interval} * * * * to 0 */{interval} * * *
- Improved error handling with AppException wrapping
kairon/shared/utils.py - Renamed parameter in string_to_list method from comma_sep_string to dilim_sep_string
- Updated internal logic to reflect new parameter name

Suggested reviewers

  • hiteshghuge

Poem

🐰 A Rabbit's Scheduling Delight 🕰️

Hours ticking, intervals tight,
Cron jobs dancing with measured might,
From minutes to hours, we've refined the way,
Mail reading schedules now hold sway,
With error handling, smooth and bright! 📧✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 47b9d6d and 6aebca5.

📒 Files selected for processing (1)
  • kairon/shared/utils.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • kairon/shared/utils.py

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
kairon/events/utility.py (1)

52-52: LGTM! Consider refactoring the duplicated cron expression.

The cron expression correctly implements hourly scheduling at minute 0. However, the same expression is duplicated in two places.

Consider extracting the cron expression to a constant or method to avoid duplication:

 @staticmethod
 def schedule_channel_mail_reading(bot: str):
     from kairon.shared.channels.mail.processor import MailProcessor

     try:
         mail_processor = MailProcessor(bot)
         interval = max(1, int(mail_processor.config.get("interval", 2)) % 24)
+        cron_expr = f"0 */{interval} * * *"

         event_id = mail_processor.state.event_id
         if event_id:
             KScheduler().update_job(event_id,
                                   TASK_TYPE.EVENT,
-                                   f"0 */{interval} * * *",
+                                   cron_expr,
                                   EventClass.mail_channel_read_mails, {"bot": bot, "user": mail_processor.bot_settings.user})
         else:
             event_id = uuid7().hex
             mail_processor.update_event_id(event_id)
             KScheduler().add_job(event_id,
                                 TASK_TYPE.EVENT,
-                                 f"0 */{interval} * * *",
+                                 cron_expr,
                                 EventClass.mail_channel_read_mails, {"bot": bot, "user": mail_processor.bot_settings.user})

Also applies to: 59-59

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bcc1cee and 47b9d6d.

📒 Files selected for processing (1)
  • kairon/events/utility.py (1 hunks)

Comment on lines +46 to +47
interval = max(1, int(mail_processor.config.get("interval", 2)) % 24)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Interval change is safe, but tests need updates

The verification shows that the interval configuration is primarily used in tests, where it's set to 1. These test configurations need to be updated to reflect the change from minutes to hours:

  • tests/unit_test/channels/mail_scheduler_test.py: Update test configurations that use {"interval": 1} to account for the new hour-based interval.

The change is otherwise safe because:

  1. No hardcoded production configurations were found in the codebase
  2. The default value of 2 hours in the code provides a reasonable fallback
  3. The interval is only used within the mail processor context
🔗 Analysis chain

LGTM! Consider adding migration notes for existing users.

The interval calculation correctly implements the hour-based scheduling with proper bounds (1-24 hours). However, since this changes the interpretation of the interval value from minutes to hours, existing configurations might need updates.

Let's check for existing configurations that might be affected:

Consider adding migration notes in the documentation to guide users on updating their existing interval configurations from minutes to hours.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for interval configurations in the codebase
# Expected: Find any hardcoded interval values or configuration examples

# Search for interval configurations
rg -A 2 '"interval":\s*\d+' --type json
rg -A 2 'interval.*=.*\d+' --type python

Length of output: 115


Script:

#!/bin/bash
# Let's try different search patterns and file extensions

# Search for interval configurations in Python files
rg -A 2 '"interval":\s*\d+' -g '*.py'
rg -A 2 'interval.*=.*\d+' -g '*.py'

# Search for mail processor configurations
rg -A 2 'mail_processor.*config' -g '*.py'

# Search for any mail interval related configurations in yaml/yml files
rg -A 2 'interval:' -g '*.{yaml,yml}'

# Search for test configurations
rg -A 2 'interval' -g '*test*.py'

Length of output: 3532

@sfahad1414 sfahad1414 self-requested a review December 16, 2024 17:38
@sfahad1414 sfahad1414 merged commit be8816b into digiteinfotech:master Dec 16, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants