DOP-3904: SnootyBuildWebhook updates Job status (#874)

* update Job with status on SnootyBuildWebhook

* add type to status

* add to staging ecs step

* two logs, and proof

* clean

* set status back to dynamic

Author: mmeigs

api/handlers/jobs.ts

@@ -7,12 +7,13 @@ import { JobRepository } from '../../src/repositories/jobRepository';
 import { GithubCommenter } from '../../src/services/github';
 import { SlackConnector } from '../../src/services/slack';
 import { RepoEntitlementsRepository } from '../../src/repositories/repoEntitlementsRepository';
-import { EnhancedJob, Job, Payload } from '../../src/entities/job';
+import { EnhancedJob, Job, JobStatus, Payload } from '../../src/entities/job';
 
 // Although data in payload should always be present, it's not guaranteed from
 // external callers
 interface SnootyPayload {
   jobId?: string;
+  status?: JobStatus;
 }
 
 // These options should only be defined if the build summary is being called after
@@ -238,8 +239,8 @@ export async function snootyBuildComplete(event: APIGatewayEvent): Promise<APIGa
     await client.connect();
     const db = client.db(c.get<string>('dbName'));
     const jobRepository = new JobRepository(db, c, consoleLogger);
-    const { payload } = await jobRepository.updateWithCompletionStatus(jobId, null, false);
-    const previewUrl = getPreviewUrl(payload, c.get<string>('env'));
+    const updateResponse = await jobRepository.updateWithStatus(jobId, null, payload.status || JobStatus.failed, false);
+    const previewUrl = getPreviewUrl(updateResponse.payload, c.get<string>('env'));
     await notifyBuildSummary(jobId, { mongoClient: client, previewUrl });
   } catch (e) {
     consoleLogger.error('SnootyBuildCompleteError', e);
@@ -265,7 +266,6 @@ export async function snootyBuildComplete(event: APIGatewayEvent): Promise<APIGa
  * @returns string|undefined
  */
 function getPreviewUrl(payload: Payload | undefined, env: string): string | undefined {
-  console.log('PAYLOAD ', payload);
   if (!payload) return;
   const { repoOwner, branchName, project } = payload;
   const githubUsernameNoHyphens = repoOwner.split('-').join('').toLowerCase();

src/job/jobHandler.ts

@@ -99,7 +99,7 @@ export abstract class JobHandler {
           null,
           null
         );
-        await this.jobRepository.updateWithCompletionStatus(this.currJob._id, files);
+        await this.jobRepository.updateWithStatus(this.currJob._id, files, JobStatus.completed);
       } else {
         if (publishResult.error) {
           await this.jobRepository.updateWithErrorStatus(this.currJob._id, publishResult.error);
@@ -649,9 +649,8 @@ export abstract class JobHandler {
     return await axios.post(
       url,
       {
-        project: this.currJob.payload.project,
-        branch: this.currJob.payload.branchName,
         jobId: this.currJob._id,
+        status: this.currJob.status,
       },
       {
         headers: { 'x-gatsby-cloud-data-source': 'gatsby-source-snooty-preview' },

src/repositories/jobRepository.ts

@@ -1,10 +1,10 @@
 import * as mongodb from 'mongodb';
 import { BaseRepository } from './baseRepository';
-import type { EnhancedJob, Job, Payload } from '../entities/job';
+import type { EnhancedJob, Job } from '../entities/job';
 import { JobStatus } from '../entities/job';
 import { ILogger } from '../services/logger';
 import c, { IConfig } from 'config';
-import { DBError, InvalidJobError, JobExistsAlreadyError, JobNotFoundError } from '../errors/errors';
+import { DBError, JobExistsAlreadyError, JobNotFoundError } from '../errors/errors';
 import { IQueueConnector, SQSConnector } from '../services/queue';
 import { JobQueueMessage } from '../entities/queueMessage';
 
@@ -21,17 +21,18 @@ export class JobRepository extends BaseRepository {
     this._queueConnector = new SQSConnector(logger, config);
   }
 
-  async updateWithCompletionStatus(
+  async updateWithStatus(
     id: string | mongodb.ObjectId,
     result: any,
+    status: JobStatus,
     shouldNotifySqs = true
   ): Promise<mongodb.Document> {
     // Safely convert to object ID
     const objectId = new mongodb.ObjectId(id);
     const query = { _id: objectId };
     const update = {
       $set: {
-        status: 'completed',
+        status,
         endTime: new Date(),
         result,
       },
@@ -40,7 +41,7 @@ export class JobRepository extends BaseRepository {
       query,
       update,
       {},
-      `Mongo Timeout Error: Timed out while updating success status for jobId: ${id}`
+      `Mongo Timeout Error: Timed out while updating job status to "${status}" for jobId: ${id}`
     );
     if (shouldNotifySqs) {
       await this.notify(objectId.toString(), c.get('jobUpdatesQueueUrl'), JobStatus.completed, 0);

tests/unit/job/api/jobs.test.ts

@@ -15,7 +15,7 @@ jest.mock('config', () => ({
 
 jest.mock('../../../../src/repositories/jobRepository', () => ({
   JobRepository: jest.fn().mockImplementation(() => ({
-    updateWithCompletionStatus: jest.fn(() => mockJob),
+    updateWithStatus: jest.fn(() => mockJob),
     getJobById: jest.fn(),
   })),
 }));

tests/unit/job/productionJobHandler.test.ts

@@ -1,4 +1,5 @@
 import { mockReset } from 'jest-mock-extended';
+import { JobStatus } from '../../../src/entities/job';
 import { TestDataProvider } from '../../data/data';
 import { getBuildJobDef, getManifestJobDef } from '../../data/jobDef';
 import { JobHandlerTestHelper } from '../../utils/jobHandlerTestHelper';
@@ -318,11 +319,11 @@ describe('ProductionJobHandler Tests', () => {
           null,
           null
         );
-        expect(jobHandlerTestHelper.jobRepo.updateWithCompletionStatus).toBeCalledWith(jobHandlerTestHelper.job._id, [
-          '1.html',
-          '2.html',
-          '3.html',
-        ]);
+        expect(jobHandlerTestHelper.jobRepo.updateWithStatus).toBeCalledWith(
+          jobHandlerTestHelper.job._id,
+          ['1.html', '2.html', '3.html'],
+          JobStatus.completed
+        );
       });
     }
   );

tests/unit/repositories/jobRepository.test.ts

@@ -3,7 +3,7 @@ import { getBuildJobDef, getBuildJobPlain } from '../../data/jobDef';
 import { DBRepositoryHelper } from '../../utils/repositoryHelper';
 import { TestDataProvider } from '../../data/data';
 import { ObjectId } from 'mongodb';
-import { Job } from '../../../src/entities/job';
+import { Job, JobStatus } from '../../../src/entities/job';
 
 describe('Job Repository Tests', () => {
   let job: Job;
@@ -19,15 +19,17 @@ describe('Job Repository Tests', () => {
     expect(new JobRepository(dbRepoHelper.db, dbRepoHelper.config, dbRepoHelper.logger)).toBeDefined();
   });
 
-  describe('Job Repository updateWithCompletionStatus Tests', () => {
+  describe('Job Repository updateWithStatus Tests', () => {
     test('Update with completion status throws DB Error as result is undefined', async () => {
       const testData = TestDataProvider.getStatusUpdateQueryAndUpdateObject(
         '64ad959b423952aeb9341fad',
         'completed',
         'All good',
         new Date()
       );
-      await expect(jobRepo.updateWithCompletionStatus('64ad959b423952aeb9341fad', 'All good')).rejects.toThrow(
+      await expect(
+        jobRepo.updateWithStatus('64ad959b423952aeb9341fad', 'All good', JobStatus.completed)
+      ).rejects.toThrow(
         `Failed to update job (${JSON.stringify(testData.query)}) for ${JSON.stringify(testData.update)}`
       );
     });
@@ -40,15 +42,19 @@ describe('Job Repository Tests', () => {
         new Date()
       );
       dbRepoHelper.collection.findOneAndUpdate.mockReturnValue(undefined);
-      await expect(jobRepo.updateWithCompletionStatus('64ad959b423952aeb9341fad', 'All good')).rejects.toThrow(
+      await expect(
+        jobRepo.updateWithStatus('64ad959b423952aeb9341fad', 'All good', JobStatus.completed)
+      ).rejects.toThrow(
         `Failed to update job (${JSON.stringify(testData.query)}) for ${JSON.stringify(testData.update)}`
       );
       expect(dbRepoHelper.collection.findOneAndUpdate).toBeCalledTimes(1);
     });
 
     test('Update with completion status succeeds', async () => {
       setupForFindOneAndUpdateSuccess();
-      await expect(jobRepo.updateWithCompletionStatus('64ad959b423952aeb9341fad', 'All good')).resolves.toEqual(job);
+      await expect(
+        jobRepo.updateWithStatus('64ad959b423952aeb9341fad', 'All good', JobStatus.completed)
+      ).resolves.toEqual(job);
       expect(dbRepoHelper.collection.findOneAndUpdate).toBeCalledTimes(1);
       expect(dbRepoHelper.logger.error).toBeCalledTimes(0);
     });
@@ -61,10 +67,10 @@ describe('Job Repository Tests', () => {
         });
       });
       try {
-        jobRepo.updateWithCompletionStatus('64ad959b423952aeb9341fad', 'All good').catch((error) => {
+        jobRepo.updateWithStatus('64ad959b423952aeb9341fad', 'All good', JobStatus.completed).catch((error) => {
           expect(dbRepoHelper.logger.error).toBeCalledTimes(1);
           expect(error.message).toContain(
-            `Mongo Timeout Error: Timed out while updating success status for jobId: 64ad959b423952aeb9341fad`
+            `Mongo Timeout Error: Timed out while updating job status to "${JobStatus.completed}" for jobId: 64ad959b423952aeb9341fad`
           );
         });
         jest.runAllTimers();