Skip to content

Feature/jobs documentation - #1140

Merged
Akanimoh12 merged 3 commits into
Akanimoh12:test-implement-dripsfrom
AbuJulaybeeb:feature/jobs-documentation
Jul 28, 2026
Merged

Feature/jobs documentation#1140
Akanimoh12 merged 3 commits into
Akanimoh12:test-implement-dripsfrom
AbuJulaybeeb:feature/jobs-documentation

Conversation

@AbuJulaybeeb

@AbuJulaybeeb AbuJulaybeeb commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Closes #995

Problem

As the backend scales to include real-time webhook delivery and scheduled tasks, there was no centralized documentation explaining how background queues, workers, and recurring schedules are architected within the src/jobs directory.

Solution

This PR introduces a README.md file in backend/src/jobs/ that serves as a dedicated guide for developers interacting with the background processing system.

Key Additions:

  • Architecture Overview: Explains the relationship between BullMQ and the shared Redis connection.
  • Queues & Best Practices: Details idempotency requirements and retry/backoff configurations.
  • Workers: Explains how workers are automatically initialized locally (npm run dev) and how to correctly throw errors to trigger BullMQ's automatic retry logic.
  • Schedules: Provides code examples for implementing Cron-like repeatable jobs.

Verification

  • Documentation accurately reflects the current webhookDelivery queue implementation.
  • Formatting uses standard Markdown.

- Initialized `webhook-delivery` BullMQ queue in `src/jobs/webhookDelivery.ts`.
- Built a Worker to execute POST requests via native `fetch` with 10s timeout.
- Added HMAC SHA256 signing for payload security.
- Included robust unit tests mocking fetch to verify retries and backoff.
- Created `backend/src/jobs/README.md`.
- Documented BullMQ queue architecture, idempotency, and retry patterns.
- Added instructions for running workers locally and handling scheduled cron jobs.
- Detailed error handling best practices for automated backoff.
@drips-wave

drips-wave Bot commented Jul 28, 2026

Copy link
Copy Markdown

@AbuJulaybeeb Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Akanimoh12
Akanimoh12 merged commit 388b936 into Akanimoh12:test-implement-drips Jul 28, 2026
4 of 5 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.

Jobs: Jobs documentation

2 participants