#3667 - Bull Scheduler Increments the Next Scheduled Job When Manually Promoted #3957

andrewsignori-aot · 2024-11-18T19:20:39Z

Updated Bull Board-related packages to take advantage of the feature present in the newer version that allows a new job to be added (same as duplicate), allowing the schedulers to be executed without affecting their current time to be executed again.

Notes:

during the local tests, when a delayed job was deleted and the queue-consumers restarted, the delayed job was restored.
this PR is intended to be part of the upcoming release. The research for the ticket will continue.

Using the add/duplicate option

While creating the new job the properties can be edited, for instance, the corn expression can be edited to create a new time to execute the scheduler.

Please note that timestamp and prevMillis should be removed. These properties are generated once the job is created.
As mentioned in the source code, timestamp is the "Timestamp when the job was created." and prevMillis is a "Internal property used by repeatable jobs."

{
  "repeat": {
    "count": 1,
    "key": "__default__::::0 7 * * *",
    "cron": "0 7 * * *"
  },
  "jobId": "repeat:2c2720c5e8b4e9ce99993becec27a0ff:1731999600000",
  "delay": 42485905,
  "timestamp": 1731957114095,
  "prevMillis": 1731999600000,
  "attempts": 3,
  "backoff": {
    "type": "fixed",
    "delay": 180000
  }
}

Refactor

Refactored the code to move the Bull Board configuration to the Nestjs modules instead of doing it on the main.ts.
The refactored code is equivalent to the one previously on the main.ts.
Updated icons and labels to make the dashboard look more like part of the SIMS. The way it was done was by targeting less effort. In case it causes some noise during the PR review the code will be removed.

sources/packages/backend/libs/services/src/constants/system-configurations-constants.ts

dheepak-aot · 2024-11-18T23:36:58Z

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

@@ -25,6 +30,12 @@ import { DatabaseModule } from "@sims/sims-db";
      inject: [ConfigService],
    }),
    BullModule.registerQueueAsync(...getQueueModules()),
+    BullBoardModule.forRootAsync({


As discussed, the queue module is shared with API (to publish messages to queue) and loading bull board module here will stand up the bull dashboard in SIMS API as well.

The modules are now added only to the queue-consumers.

dheepak-aot · 2024-11-18T23:44:09Z

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

+ * @returns Bull Board module options with the dashboard route,
+ * authentication middleware and the board options.
+ */
+async function bullBoardModuleFactory(configService: ConfigService) {


Please specify the return type in the method.

async function bullBoardModuleFactory( configService: ConfigService, ): Promise<BullBoardModuleOptions>

Return type added.

dheepak-aot · 2024-11-18T23:49:51Z

sources/packages/backend/libs/services/src/queue/bull-board-queues-module.ts

+  /**
+   * Adds all queues to the bull board during application initialization.
+   * checking if the queue is active and if it is a scheduler.
+   */


Minor please check the comment and period.

Also please add returns.

Add the period.
About the return type, I do not believe that we usually add comments for Promise void. Please let me know if that is what you meant.

You are right about the return type.

dheepak-aot · 2024-11-18T23:50:53Z

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

+        boardLogo: {
+          path: "https://sims.studentaidbc.ca/favicon-32x32.png",
+        },
+        favIcon: {
+          default: "https://sims.studentaidbc.ca/favicon-16x16.png",
+          alternative: "https://sims.studentaidbc.ca/favicon-32x32.png",


❤️Looks great with SIMS logo.

dheepak-aot · 2024-11-18T23:51:34Z

Great Job! Please have a look at the comments. Except one rest all are minor.

guru-aot

LGTM, nice work @andrewsignori-aot

dheepak-aot · 2024-11-19T00:38:13Z

...packages/backend/apps/queue-consumers/test/helpers/testing-modules/testing-modules-helper.ts

+      replace: BullBoardQueuesModule,
+      by: BullBoardQueuesModuleMock,


dheepak-aot

Thanks for doing the changes. Looks good 👍

This reverts commit d986735.

sonarqubecloud · 2024-11-19T00:54:59Z

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

github-actions · 2024-11-19T00:55:36Z

Backend Unit Tests Coverage Report

Totals
Statements:	22.1% ( 3718 / 16821 )
Methods:	10.19% ( 214 / 2100 )
Lines:	25.44% ( 3226 / 12680 )
Branches:	13.62% ( 278 / 2041 )

github-actions · 2024-11-19T00:56:02Z

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-19T00:58:12Z

E2E Queue Consumers Coverage Report

Totals
Statements:	86.93% ( 1244 / 1431 )
Methods:	88.57% ( 124 / 140 )
Lines:	87.78% ( 1056 / 1203 )
Branches:	72.73% ( 64 / 88 )

github-actions · 2024-11-19T01:01:04Z

E2E SIMS API Coverage Report

Totals
Statements:	66.96% ( 5773 / 8621 )
Methods:	64.8% ( 718 / 1108 )
Lines:	70.89% ( 4530 / 6390 )
Branches:	46.75% ( 525 / 1123 )

Updated bull board packages

865d516

andrewsignori-aot self-assigned this Nov 18, 2024

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

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

dheepak-aot self-requested a review November 18, 2024 21:32

dheepak-aot reviewed Nov 18, 2024

View reviewed changes

sources/packages/backend/libs/services/src/constants/system-configurations-constants.ts Outdated Show resolved Hide resolved

Updated packages with most recent versions

de1c611

dheepak-aot reviewed Nov 18, 2024

View reviewed changes

Removed bull board from queue module.

01e428f

guru-aot approved these changes Nov 19, 2024

View reviewed changes

Fix E2E tests

224e91a

dheepak-aot reviewed Nov 19, 2024

View reviewed changes

dheepak-aot approved these changes Nov 19, 2024

View reviewed changes

andrewsignori-aot added 2 commits November 18, 2024 16:44

Used overrideModule

d986735

Revert "Used overrideModule"

c59aa5d

This reverts commit d986735.

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

Merged via the queue into main with commit 7b8df04 Nov 19, 2024
20 checks passed

andrewsignori-aot temporarily deployed to DEV November 19, 2024 16:38 — with GitHub Actions Inactive

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

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

andrewsignori-aot deleted the feature/#3667-bull-scheduler 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 #3957

#3667 - Bull Scheduler Increments the Next Scheduled Job When Manually Promoted #3957

andrewsignori-aot commented Nov 18, 2024 •

edited

Loading

dheepak-aot Nov 18, 2024

andrewsignori-aot Nov 19, 2024

dheepak-aot Nov 18, 2024

andrewsignori-aot Nov 19, 2024

dheepak-aot Nov 18, 2024

andrewsignori-aot Nov 19, 2024 •

edited

Loading

dheepak-aot Nov 19, 2024

dheepak-aot Nov 18, 2024

dheepak-aot commented Nov 18, 2024

guru-aot left a comment

dheepak-aot Nov 19, 2024

dheepak-aot left a comment

sonarqubecloud bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

github-actions bot commented Nov 19, 2024

		replace: BullBoardQueuesModule,
		by: BullBoardQueuesModuleMock,

#3667 - Bull Scheduler Increments the Next Scheduled Job When Manually Promoted #3957

#3667 - Bull Scheduler Increments the Next Scheduled Job When Manually Promoted #3957

Conversation

andrewsignori-aot commented Nov 18, 2024 • edited Loading

Using the add/duplicate option

Refactor

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

andrewsignori-aot Nov 19, 2024 • edited Loading

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 18, 2024

guru-aot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dheepak-aot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 19, 2024

Quality Gate passed

github-actions bot commented Nov 19, 2024

Backend Unit Tests Coverage Report

github-actions bot commented Nov 19, 2024

E2E Workflow Workers Coverage Report

github-actions bot commented Nov 19, 2024

E2E Queue Consumers Coverage Report

github-actions bot commented Nov 19, 2024

E2E SIMS API Coverage Report

andrewsignori-aot commented Nov 18, 2024 •

edited

Loading

andrewsignori-aot Nov 19, 2024 •

edited

Loading