feat(api): use jobQueue method instead of pbboss directly

1024pix · Sep 24, 2024 · bb194ba · bb194ba
1 parent 2e22e9e
commit bb194ba
Show file tree

Hide file tree

Showing 4 changed files with 85 additions and 11 deletions.
diff --git a/...application/jobs/schedule-compute-organization-learners-certificability-job-controller.js b/...application/jobs/schedule-compute-organization-learners-certificability-job-controller.js
@@ -16,6 +16,10 @@ class ScheduleComputeOrganizationLearnersCertificabilityJobController extends Jo
     });
   }
 
+  get legacyName() {
+    return 'ComputeOrganizationLearnersCertificabilityJob';
+  }
+
   async handle({
     data = {},
     dependencies = { organizationLearnerRepository, computeCertificabilityJobRepository, config, logger },

diff --git a/api/src/shared/config.js b/api/src/shared/config.js
@@ -191,7 +191,7 @@ const configuration = (function () {
       pixCertifScoBlockedAccessDateCollege: process.env.PIX_CERTIF_SCO_BLOCKED_ACCESS_DATE_COLLEGE,
       scheduleComputeOrganizationLearnersCertificability: {
         cron: process.env.SCHEDULE_COMPUTE_LEARNERS_CERTIFICABILITY_JOB_CRON || '0 21 * * *',
-        chunkSize: process.env.SCHEDULE_COMPUTE_LEARNERS_CERTIFICABILITY_CHUNK_SIZE || 50000,
+        chunkSize: process.env.SCHEDULE_COMPUTE_LEARNERS_CERTIFICABILITY_CHUNK_SIZE || 1000,
       },
       scoAccountRecoveryKeyLifetimeMinutes: process.env.SCO_ACCOUNT_RECOVERY_KEY_LIFETIME_MINUTES,
     },

diff --git a/api/tests/unit/worker_test.js b/api/tests/unit/worker_test.js
@@ -1,4 +1,5 @@
 import { UserAnonymizedEventLoggingJob } from '../../src/identity-access-management/domain/models/UserAnonymizedEventLoggingJob.js';
+import { ScheduleComputeOrganizationLearnersCertificabilityJobController } from '../../src/prescription/learner-management/application/jobs/schedule-compute-organization-learners-certificability-job-controller.js';
 import { ValidateOrganizationLearnersImportFileJobController } from '../../src/prescription/learner-management/application/jobs/validate-organization-learners-import-file-job-controller.js';
 import { ValidateOrganizationImportFileJob } from '../../src/prescription/learner-management/domain/models/ValidateOrganizationImportFileJob.js';
 import { UserAnonymizedEventLoggingJobController } from '../../src/shared/application/jobs/audit-log/user-anonymized-event-logging-job-controller.js';
@@ -8,16 +9,19 @@ import { registerJobs } from '../../worker.js';
 import { catchErr, expect, sinon } from '../test-helper.js';
 
 describe('#registerJobs', function () {
-  let startPgBossStub, createJobQueuesStub, scheduleCpfJobsStub, jobQueueStub;
+  let startPgBossStub, createJobQueuesStub, jobQueueStub;
 
   beforeEach(function () {
-    const pgBossStub = { schedule: sinon.stub() };
-    jobQueueStub = { register: sinon.stub() };
+    const pgBossStub = Symbol('pgBoss');
+    jobQueueStub = { register: sinon.stub(), scheduleCronJob: sinon.stub(), unscheduleCronJob: sinon.stub() };
     startPgBossStub = sinon.stub();
     startPgBossStub.resolves(pgBossStub);
     createJobQueuesStub = sinon.stub();
     createJobQueuesStub.withArgs(pgBossStub).returns(jobQueueStub);
-    scheduleCpfJobsStub = sinon.stub();
+  });
+
+  afterEach(function () {
+    sinon.restore();
   });
 
   it('should register UserAnonymizedEventLoggingJob', async function () {
@@ -27,7 +31,6 @@ describe('#registerJobs', function () {
       dependencies: {
         startPgBoss: startPgBossStub,
         createJobQueues: createJobQueuesStub,
-        scheduleCpfJobs: scheduleCpfJobsStub,
       },
     });
 
@@ -38,6 +41,26 @@ describe('#registerJobs', function () {
     );
   });
 
+  it('should register legacyName from UserAnonymizedEventLoggingJob', async function () {
+    // when
+    sinon
+      .stub(UserAnonymizedEventLoggingJobController.prototype, 'legacyName')
+      .get(() => 'legyNameForUserAnonymizedEventLoggingJobController');
+    await registerJobs({
+      jobGroup: JobGroup.DEFAULT,
+      dependencies: {
+        startPgBoss: startPgBossStub,
+        createJobQueues: createJobQueuesStub,
+      },
+    });
+
+    // then
+    expect(jobQueueStub.register).to.have.been.calledWithExactly(
+      'legyNameForUserAnonymizedEventLoggingJobController',
+      UserAnonymizedEventLoggingJobController,
+    );
+  });
+
   it('should register ValidateOrganizationImportFileJob when job is enabled', async function () {
     //given
     sinon.stub(config.pgBoss, 'validationFileJobEnabled').value(true);
@@ -48,7 +71,6 @@ describe('#registerJobs', function () {
       dependencies: {
         startPgBoss: startPgBossStub,
         createJobQueues: createJobQueuesStub,
-        scheduleCpfJobs: scheduleCpfJobsStub,
       },
     });
 
@@ -69,7 +91,6 @@ describe('#registerJobs', function () {
       dependencies: {
         startPgBoss: startPgBossStub,
         createJobQueues: createJobQueuesStub,
-        scheduleCpfJobs: scheduleCpfJobsStub,
       },
     });
 
@@ -86,12 +107,55 @@ describe('#registerJobs', function () {
       dependencies: {
         startPgBoss: startPgBossStub,
         createJobQueues: createJobQueuesStub,
-        scheduleCpfJobs: scheduleCpfJobsStub,
       },
     });
 
     // then
     expect(error).to.be.instanceOf(Error);
     expect(error.message).to.equal(`Job group invalid, allowed Job groups are [${Object.values(JobGroup)}]`);
   });
+
+  describe('cron Job', function () {
+    it('schedule ScheduleComputeOrganizationLearnersCertificabilityJob', async function () {
+      //given
+      sinon.stub(config.features.scheduleComputeOrganizationLearnersCertificability, 'cron').value('0 21 * * *');
+
+      await registerJobs({
+        jobGroup: JobGroup.DEFAULT,
+        dependencies: {
+          startPgBoss: startPgBossStub,
+          createJobQueues: createJobQueuesStub,
+        },
+      });
+
+      // then
+      expect(jobQueueStub.scheduleCronJob).to.have.been.calledWithExactly({
+        name: 'ScheduleComputeOrganizationLearnersCertificabilityJob',
+        cron: '0 21 * * *',
+        options: { tz: 'Europe/Paris' },
+      });
+    });
+
+    it('unschedule legacyName from ScheduleComputeOrganizationLearnersCertificabilityJob', async function () {
+      //given
+      sinon
+        .stub(ScheduleComputeOrganizationLearnersCertificabilityJobController.prototype, 'legacyName')
+        .get(() => 'legyNameForScheduleComputeOrganizationLearnersCertificabilityJobController');
+
+      sinon.stub(config.features.scheduleComputeOrganizationLearnersCertificability, 'cron').value('0 21 * * *');
+
+      await registerJobs({
+        jobGroup: JobGroup.DEFAULT,
+        dependencies: {
+          startPgBoss: startPgBossStub,
+          createJobQueues: createJobQueuesStub,
+        },
+      });
+
+      // then
+      expect(jobQueueStub.unscheduleCronJob).to.have.been.calledWithExactly(
+        'legyNameForScheduleComputeOrganizationLearnersCertificabilityJobController',
+      );
+    });
+  });
 });
diff --git a/api/worker.js b/api/worker.js
@@ -93,14 +93,20 @@ export async function registerJobs({ jobGroup, dependencies = { startPgBoss, cre
       logger.info(`Job "${job.jobName}" registered from module "${moduleName}."`);
       jobQueues.register(job.jobName, ModuleClass);
 
-      if (job.legacyName) {
+      if (!job.jobCron && job.legacyName) {
         logger.warn(`Temporary Job" ${job.legacyName}" registered from module "${moduleName}."`);
         jobQueues.register(job.legacyName, ModuleClass);
       }
 
       if (job.jobCron) {
-        await pgBoss.schedule(job.jobName, job.jobCron, {}, { tz: 'Europe/Paris' });
+        await jobQueues.scheduleCronJob({ name: job.jobName, cron: job.jobCron, options: { tz: 'Europe/Paris' } });
         logger.info(`Cron for job "${job.jobName}" scheduled "${job.jobCron}"`);
+
+        // For cronJob we need to unschedule older cron
+        if (job.legacyName) {
+          await jobQueues.unscheduleCronJob(job.legacyName);
+        }
+
         cronJobCount++;
       } else {
         jobRegisteredCount++;