#3666 - Queue Monitoring - Refactoring Schedulers #4032

andrewsignori-aot · 2024-12-05T16:52:26Z

Extended the BaseScheduler from the BaseQueue to enforce all the same basic features like porcessSummary and error handling, as agreed during PR #3666 - Queue Monitoring - Default Queue Error Handling #4020.
Started the refactor os some scheduler to be used as a baseline for the upcoming refactors.
- cas-supplier-integration.scheduler.ts
- cra-process-integration.scheduler.ts
- cra-response-integration.scheduler.ts
Added the below code to every scheduler to be refactored.
Note: this is also responsible for the Sonarcloud duplication issue. There are 23 files that have exactly the same change.

/**
 * To be removed once the method {@link process} is implemented.
 * This method "hides" the {@link Process} decorator from the base class.
 */
async processQueue(): Promise<string | string[]> {
  throw new Error("Method not implemented.");
}

/**
 * When implemented in a derived class, process the queue job.
 * To be implemented.
 */
protected async process(): Promise<string | string[]> {
  throw new Error("Method not implemented.");
}

dheepak-aot · 2024-12-11T19:17:24Z

...nd/apps/queue-consumers/src/processors/assessment/cancel-application-assessment.processor.ts

@@ -49,7 +49,7 @@ export class CancelApplicationAssessmentProcessor extends BaseQueue<CancelAssess
   * @param job information to perform the process.
   * @param processSummary process summary for logging.
   * @returns processing result.   */
-  async process(
+  protected async process(


dheepak-aot · 2024-12-11T19:24:24Z

...eue-consumers/src/processors/schedulers/application/process-archive-application.scheduler.ts

-      appLogger: this.logger,
-      jobLogger: job,
-    });
-    await summary.info("Processing pending applications to be archived.");


Minor. the info message can be retained.

dheepak-aot · 2024-12-11T19:28:18Z

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

 import { QueueService } from "@sims/services/queue";
 import { QueueNames } from "@sims/utilities";
 import { ConfigService } from "@sims/utilities/config";
-import { InjectLogger } from "@sims/utilities/logger";
+import { InjectLogger, LoggerService } from "@sims/utilities/logger";


dheepak-aot · 2024-12-11T19:37:37Z

...n/application-changes-report-integration/application-changes-report-integration.scheduler.ts

+   * To be removed once the method {@link process} is implemented.
+   * This method "hides" the {@link Process} decorator from the base class.
+   */
+  async processQueue(): Promise<string | string[]> {


Can we have the default implementation in the base class itself so that we don't have to repeat in other places? - Is that approach not working?

I found that when class(indluding subclass) decorated twice the bull doesn't accept it.

dheepak-aot

Great Job! Just left one minor comment.

andrepestana-aot · 2024-12-11T22:22:00Z

...ue-consumers/src/processors/schedulers/cas-integration/cas-supplier-integration.scheduler.ts

+  protected async process(
+    _job: Job<void>,
+    processSummary: ProcessSummary,
+  ): Promise<string | string[]> {


The return can be Promise<string[]>.

andrepestana-aot · 2024-12-11T22:23:12Z

...ue-consumers/src/processors/schedulers/cra-integration/cra-response-integration.scheduler.ts

-    this.logger.log(
-      `Processing CRA integration job ${job.id} of type ${job.name}.`,
-    );
+  protected async process(


Please add processSummary to comments.

andrepestana-aot

Great job with the refactoring. Just minor comments.

sonarqubecloud · 2024-12-11T22:36:37Z

Quality Gate failed

Failed conditions
6.4% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

github-actions · 2024-12-11T22:37:04Z

Backend Unit Tests Coverage Report

Totals
Statements:	21.82% ( 3765 / 17257 )
Methods:	9.81% ( 215 / 2191 )
Lines:	25.21% ( 3270 / 12972 )
Branches:	13.37% ( 280 / 2094 )

github-actions · 2024-12-11T22:37:26Z

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-12-11T22:39:48Z

E2E Queue Consumers Coverage Report

Totals
Statements:	80% ( 1336 / 1670 )
Methods:	63.55% ( 136 / 214 )
Lines:	83.49% ( 1123 / 1345 )
Branches:	69.37% ( 77 / 111 )

github-actions · 2024-12-11T22:42:36Z

E2E SIMS API Coverage Report

Totals
Statements:	67.41% ( 5927 / 8792 )
Methods:	65.09% ( 729 / 1120 )
Lines:	71.34% ( 4650 / 6518 )
Branches:	47.49% ( 548 / 1154 )

Refactoring schedulers

bec7724

andrewsignori-aot added the Queue Consumers label Dec 5, 2024

andrewsignori-aot self-assigned this Dec 5, 2024

andrewsignori-aot added 4 commits December 9, 2024 16:22

Merge branch 'main' into feature/#3666-add-base-queue-to-schedulers

eaec81f

Added commented processQueue

22dc1db

Fix E2E tests

727167b

Merge branch 'main' into feature/#3666-add-base-queue-to-schedulers

bd1dfaf

andrewsignori-aot marked this pull request as ready for review December 11, 2024 17:03

andrewsignori-aot added the E2E/Unit tests label Dec 11, 2024

dheepak-aot self-requested a review December 11, 2024 17:28

dheepak-aot reviewed Dec 11, 2024

View reviewed changes

dheepak-aot approved these changes Dec 11, 2024

View reviewed changes

andrepestana-aot self-requested a review December 11, 2024 22:08

andrepestana-aot reviewed Dec 11, 2024

View reviewed changes

andrepestana-aot approved these changes Dec 11, 2024

View reviewed changes

PR review fixes

78fe48e

andrewsignori-aot merged commit 97dcab1 into main Dec 12, 2024
20 of 21 checks passed

andrewsignori-aot temporarily deployed to DEV December 12, 2024 18:30 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV December 12, 2024 18:31 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV December 12, 2024 18:34 — with GitHub Actions Inactive

andrewsignori-aot deleted the feature/#3666-add-base-queue-to-schedulers branch December 12, 2024 21:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#3666 - Queue Monitoring - Refactoring Schedulers #4032

#3666 - Queue Monitoring - Refactoring Schedulers #4032

andrewsignori-aot commented Dec 5, 2024 •

edited

Loading

dheepak-aot Dec 11, 2024

dheepak-aot Dec 11, 2024

dheepak-aot Dec 11, 2024

dheepak-aot Dec 11, 2024

dheepak-aot Dec 11, 2024

dheepak-aot left a comment

andrepestana-aot Dec 11, 2024

andrewsignori-aot Dec 11, 2024

andrepestana-aot Dec 11, 2024

andrewsignori-aot Dec 11, 2024

andrepestana-aot left a comment

sonarqubecloud bot commented Dec 11, 2024

github-actions bot commented Dec 11, 2024

github-actions bot commented Dec 11, 2024

github-actions bot commented Dec 11, 2024

github-actions bot commented Dec 11, 2024

#3666 - Queue Monitoring - Refactoring Schedulers #4032

#3666 - Queue Monitoring - Refactoring Schedulers #4032

Conversation

andrewsignori-aot commented Dec 5, 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

dheepak-aot left a 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

andrepestana-aot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 11, 2024

Quality Gate failed

github-actions bot commented Dec 11, 2024

Backend Unit Tests Coverage Report

github-actions bot commented Dec 11, 2024

E2E Workflow Workers Coverage Report

github-actions bot commented Dec 11, 2024

E2E Queue Consumers Coverage Report

github-actions bot commented Dec 11, 2024

E2E SIMS API Coverage Report

andrewsignori-aot commented Dec 5, 2024 •

edited

Loading