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

Adding bull jobs removing #1934

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Adding bull jobs removing #1934

merged 1 commit into from
Feb 11, 2025

Conversation

kkatusic
Copy link
Collaborator

@kkatusic kkatusic commented Feb 11, 2025

Summary by CodeRabbit

  • Chores
    • Enhanced background job management by enabling automatic cleanup of completed or failed tasks for notifications and balance operations.
    • Introduced a configurable toggle for controlling background event processing, optimizing system performance and resource utilization.

@kkatusic kkatusic self-assigned this Feb 11, 2025
Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

Walkthrough

This pull request updates the configuration for job queues in two modules. In the notification adapter, the job queue initialization now includes default options that automatically remove completed or failed jobs, and a new variable isProcessingQueueEventsEnabled is introduced. Similarly, in the snapshot balance service, job options are modified to remove jobs on completion or failure. These changes adjust how job states are managed and cleaned up within the application.

Changes

File(s) Change Summary
src/adapters/notifications/NotificationCenterAdapter.ts and
src/services/cronJobs/fillSnapshotBalances.ts
Added auto-removal options (removeOnComplete: true, removeOnFail: true) to queue configurations in both modules.
src/adapters/notifications/NotificationCenterAdapter.ts Declared a new variable isProcessingQueueEventsEnabled initialized to false to control processing of queue events.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant Q as Job Queue
    participant P as Job Processor

    C->>Q: Enqueue Job
    Q->>P: Dispatch Job
    P-->>Q: Job Completed/Failed
    Q->>Q: Auto-remove job via defaultJobOptions
Loading

Possibly related PRs

Suggested reviewers

  • CarlosQ96
  • jainkrati
  • mohammadranjbarz

Poem

Hop, hop, I’m a coding bunny,
Cleaning up jobs, isn’t that funny?
With complete and failed, I swiftly scurry,
Removing old tasks in a flurry.
Embracing each change with a whisker twitch, 🐇
My carrot-code garden is now glitch-free and rich!
Hooray for clean queues and rabbit-approved fixes!


📜 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 80df1f3 and 68f55f6.

📒 Files selected for processing (2)
  • src/adapters/notifications/NotificationCenterAdapter.ts (1 hunks)
  • src/services/cronJobs/fillSnapshotBalances.ts (1 hunks)
🔇 Additional comments (3)
src/services/cronJobs/fillSnapshotBalances.ts (1)

104-108: LGTM! Good job on improving job queue management.

Adding removeOnComplete and removeOnFail options is a good practice that will help prevent job accumulation in the queue, improving memory usage and queue performance.

src/adapters/notifications/NotificationCenterAdapter.ts (2)

1284-1294: LGTM! Good job on improving job queue management.

Adding defaultJobOptions with removeOnComplete and removeOnFail is a good practice that will:

  • Prevent job accumulation in the queue
  • Improve memory usage and queue performance
  • Ensure consistent job cleanup behavior across all jobs in this queue

1295-1295: LGTM! Good job on preventing duplicate event processing.

The isProcessingQueueEventsEnabled flag is a good practice that helps prevent multiple event processors from being initialized, ensuring that notifications are processed only once.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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
Collaborator

@CarlosQ96 CarlosQ96 left a comment

Choose a reason for hiding this comment

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

Thanks Kechy, I was checking tho but there are COUNTS in the cronjobs that use bull we have to add the config to those too

Copy link
Collaborator

@CarlosQ96 CarlosQ96 left a comment

Choose a reason for hiding this comment

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

Approved!

@kkatusic kkatusic merged commit 54c1683 into staging Feb 11, 2025
6 checks passed
@kkatusic kkatusic deleted the fix/redis_memory branch February 11, 2025 13:44
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