#3667 - Bull Scheduler increments the next scheduled job when manually promoted (Ensure Next Delayed Job) #3978

andrewsignori-aot · 2024-11-21T00:49:30Z

Ensures a scheduled job will have a delayed job created with the next expected scheduled time based on the configured cron expression.
DB row used as a lock to ensure the initialization code will not recreate delayed jobs or create them in an unwanted way if two PODs start at the same time. To be clear, the lock approach is the same used in other areas of the application and locks a single row in the table queue-consumers, please not, the table will not be locked. Please see below the sample query executed.

START TRANSACTION
select
	"QueueConfiguration"."id" AS "QueueConfiguration_id"
from
	"sims"."queue_configurations" "QueueConfiguration"
where
	(("QueueConfiguration"."queue_name" = 'archive-applications')) LIMIT 1 FOR UPDATE 
COMMIT

While the queue is paused, no other delayed jobs will be created.

dheepak-aot · 2024-11-22T00:13:26Z

sources/packages/backend/apps/queue-consumers/src/processors/schedulers/base-scheduler.ts

+    const result = cronParser.parseExpression(repeatOptions.cron, {
+      utc: true,
+    });
+    return result.next().toDate();


We can return milliseconds here result.next().getMilliseconds() and do a millisecond comparison between nextSchedulerExecutionDate and delayedJobExecutionDate

It would work but IMO it would be clear to have a proper date.
Is the idea to avoid using the dayjs?
I will give it a try to see if the readability is still good enough.

The getMilliseconds does not contain the total milliseconds.
I would prefer to keep the current implementation unless it would be a bloker.

Tested with getDate (similar to the Date) and it seems all good.

dheepak-aot · 2024-11-22T00:15:08Z

sources/packages/backend/apps/queue-consumers/src/processors/schedulers/base-scheduler.ts

+   * @returns calculated execution date for the delayed job.
+   */
+  getDelayedJobExecutionDate(delayedJob: Job): Date {
+    const totalMilliseconds = delayedJob.opts.delay + delayedJob.timestamp;


It is a great analysis to consider the delay to the job timestamp. ❤️

dheepak-aot · 2024-11-22T00:19:23Z

sources/packages/backend/apps/queue-consumers/src/processors/schedulers/base-scheduler.ts

+    }
+    // Remove any non expected delayed job.
+    for (const delayedJob of delayedJobs) {
+      if (!expectedDelayedJob || delayedJob !== expectedDelayedJob) {


Asking for my understanding, will comparing the job ids alone work ? delayedJob.id !== expectedDelayedJob.id

The idea here is to compare the object reference, which will be pretty precise.
Is there a benefit using the id?

dheepak-aot · 2024-11-22T00:27:17Z

sources/packages/backend/libs/services/src/queue/queue.service.ts

+    queueName: QueueNames,
+    callback: () => Promise<void>,
+  ): Promise<void> {
+    await this.dataSource.transaction(async (entityManager) => {


dheepak-aot · 2024-11-22T00:27:59Z

Great work and analysis. Just 2 minor comments.

andrepestana-aot

Great analysis and implementation! Looks good to me!

sonarqubecloud · 2024-11-22T00:59:10Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

dheepak-aot

Thanks for making the changes. Looks good 👍

github-actions · 2024-11-22T00:59:52Z

Backend Unit Tests Coverage Report

Totals
Statements:	22.04% ( 3718 / 16866 )
Methods:	10.17% ( 214 / 2105 )
Lines:	25.38% ( 3226 / 12710 )
Branches:	13.55% ( 278 / 2051 )

github-actions · 2024-11-22T01:00:13Z

E2E Workflow Workers Coverage Report

Totals
Statements:	65.43% ( 583 / 891 )
Methods:	59.26% ( 64 / 108 )
Lines:	68.54% ( 464 / 677 )
Branches:	51.89% ( 55 / 106 )

github-actions · 2024-11-22T01:02:35Z

E2E Queue Consumers Coverage Report

Totals
Statements:	84.63% ( 1233 / 1457 )
Methods:	83.8% ( 119 / 142 )
Lines:	85.98% ( 1049 / 1220 )
Branches:	68.42% ( 65 / 95 )

github-actions · 2024-11-22T01:25:38Z

E2E SIMS API Coverage Report

Totals
Statements:	66.94% ( 5774 / 8625 )
Methods:	64.8% ( 718 / 1108 )
Lines:	70.87% ( 4531 / 6393 )
Branches:	46.71% ( 525 / 1124 )

…y promoted (Ensure Next Delayed Job) (#3978) - Ensures a scheduled job will have a delayed job created with the next expected scheduled time based on the configured cron expression. - DB row used as a lock to ensure the initialization code will not recreate delayed jobs or create them in an unwanted way if two PODs start at the same time. To be clear, the lock approach is the same used in other areas of the application and locks a single row in the table queue-consumers, please not, the table will not be locked. Please see below the sample query executed. ```sql START TRANSACTION select "QueueConfiguration"."id" AS "QueueConfiguration_id" from "sims"."queue_configurations" "QueueConfiguration" where (("QueueConfiguration"."queue_name" = 'archive-applications')) LIMIT 1 FOR UPDATE COMMIT ``` - While the queue is paused, no other delayed jobs will be created.

Added removeDuplicatedDelayedJob

2d92f6a

andrewsignori-aot added the Queue Consumers label Nov 21, 2024

andrewsignori-aot self-assigned this Nov 21, 2024

andrewsignori-aot marked this pull request as ready for review November 21, 2024 00:59

andrewsignori-aot marked this pull request as draft November 21, 2024 03:06

Ensure "next" delayed job creation

bab37dd

andrewsignori-aot changed the title ~~#3667 - Bull Scheduler increments the next scheduled job when manually promoted (Remove duplicated delayed job)~~ #3667 - Bull Scheduler increments the next scheduled job when manually promoted (Ensure Next Delayed Job) Nov 21, 2024

andrewsignori-aot added 2 commits November 21, 2024 14:00

Comments improvements

8c6a2ee

Typo fix

aaae0f2

andrewsignori-aot marked this pull request as ready for review November 21, 2024 22:12

andrepestana-aot self-requested a review November 21, 2024 22:59

dheepak-aot self-requested a review November 21, 2024 23:34

dheepak-aot reviewed Nov 22, 2024

View reviewed changes

andrepestana-aot approved these changes Nov 22, 2024

View reviewed changes

PR review suggestion.

e192d60

dheepak-aot approved these changes Nov 22, 2024

View reviewed changes

andrewsignori-aot added this pull request to the merge queue Nov 22, 2024

Merged via the queue into main with commit 3e8eb73 Nov 22, 2024
20 checks passed

andrewsignori-aot temporarily deployed to DEV November 22, 2024 01:39 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV November 22, 2024 01:40 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV November 22, 2024 01:42 — with GitHub Actions Inactive

andrewsignori-aot deleted the feature/#3667-remove-multiple-delayed-jobs branch November 25, 2024 18:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#3667 - Bull Scheduler increments the next scheduled job when manually promoted (Ensure Next Delayed Job) #3978

#3667 - Bull Scheduler increments the next scheduled job when manually promoted (Ensure Next Delayed Job) #3978

andrewsignori-aot commented Nov 21, 2024 •

edited

Loading

dheepak-aot Nov 22, 2024

andrewsignori-aot Nov 22, 2024

andrewsignori-aot Nov 22, 2024

andrewsignori-aot Nov 22, 2024

dheepak-aot Nov 22, 2024

dheepak-aot Nov 22, 2024

andrewsignori-aot Nov 22, 2024

dheepak-aot Nov 22, 2024

dheepak-aot commented Nov 22, 2024

andrepestana-aot left a comment

sonarqubecloud bot commented Nov 22, 2024

dheepak-aot left a comment

github-actions bot commented Nov 22, 2024

github-actions bot commented Nov 22, 2024

github-actions bot commented Nov 22, 2024

github-actions bot commented Nov 22, 2024

#3667 - Bull Scheduler increments the next scheduled job when manually promoted (Ensure Next Delayed Job) #3978

#3667 - Bull Scheduler increments the next scheduled job when manually promoted (Ensure Next Delayed Job) #3978

Conversation

andrewsignori-aot commented Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dheepak-aot commented Nov 22, 2024

andrepestana-aot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 22, 2024

Quality Gate passed

dheepak-aot left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 22, 2024

Backend Unit Tests Coverage Report

github-actions bot commented Nov 22, 2024

E2E Workflow Workers Coverage Report

github-actions bot commented Nov 22, 2024

E2E Queue Consumers Coverage Report

github-actions bot commented Nov 22, 2024

E2E SIMS API Coverage Report

andrewsignori-aot commented Nov 21, 2024 •

edited

Loading