Move the failJob method up to the main file

github · Aug 25, 2021 · 533bb57 · 533bb57
1 parent 5d128b3
commit 533bb57
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 36 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -15,13 +15,10 @@ jest.mock('../src/updater')
 describe('run', () => {
   let context: Context
 
-  let failJobSpy: any
   let markJobAsProcessedSpy: any
   let reportJobErrorSpy: any
 
   beforeEach(async () => {
-    failJobSpy = jest.spyOn(APIClient.prototype, 'failJob')
-
     markJobAsProcessedSpy = jest.spyOn(
       APIClient.prototype,
       'markJobAsProcessed'
@@ -56,7 +53,6 @@ describe('run', () => {
       await run(context)
 
       expect(markJobAsProcessedSpy).not.toHaveBeenCalled()
-      expect(failJobSpy).not.toHaveBeenCalled()
       expect(reportJobErrorSpy).not.toHaveBeenCalled()
     })
   })
@@ -80,7 +76,8 @@ describe('run', () => {
     test('it does not report this failed run to dependabot-api', async () => {
       await run(context)
 
-      expect(failJobSpy).not.toHaveBeenCalled()
+      expect(markJobAsProcessedSpy).not.toHaveBeenCalled()
+      expect(reportJobErrorSpy).not.toHaveBeenCalled()
     })
   })
 
@@ -108,7 +105,8 @@ describe('run', () => {
     test('it does not inform dependabot-api as it cannot instantiate a client without the params', async () => {
       await run(context)
 
-      expect(failJobSpy).not.toHaveBeenCalled()
+      expect(markJobAsProcessedSpy).not.toHaveBeenCalled()
+      expect(reportJobErrorSpy).not.toHaveBeenCalled()
     })
   })
 
@@ -138,9 +136,11 @@ describe('run', () => {
     test('it relays a failure message to the dependabot service', async () => {
       await run(context)
 
-      expect(failJobSpy).toHaveBeenCalledWith(
-        new Error('error getting job details')
-      )
+      expect(reportJobErrorSpy).toHaveBeenCalledWith({
+        'error-type': 'actions_workflow_unknown',
+        'error-detail': 'error getting job details'
+      })
+      expect(markJobAsProcessedSpy).toHaveBeenCalled()
     })
   })
 
@@ -170,9 +170,11 @@ describe('run', () => {
     test('it relays a failure message to the dependabot service', async () => {
       await run(context)
 
-      expect(failJobSpy).toHaveBeenCalledWith(
-        new Error('error getting credentials')
-      )
+      expect(reportJobErrorSpy).toHaveBeenCalledWith({
+        'error-type': 'actions_workflow_unknown',
+        'error-detail': 'error getting credentials'
+      })
+      expect(markJobAsProcessedSpy).toHaveBeenCalled()
     })
   })
 
@@ -202,9 +204,11 @@ describe('run', () => {
     test('it relays a failure message to the dependabot service', async () => {
       await run(context)
 
-      expect(failJobSpy).toHaveBeenCalledWith(
-        new Error('error running the update')
-      )
+      expect(reportJobErrorSpy).toHaveBeenCalledWith({
+        'error-type': 'actions_workflow_unknown',
+        'error-detail': 'error running the update'
+      })
+      expect(markJobAsProcessedSpy).toHaveBeenCalled()
     })
   })
 })
diff --git a/src/api-client.ts b/src/api-client.ts
@@ -25,12 +25,8 @@ export type JobDetails = {
   'package-manager': PackageManager
 }
 
-export enum JobErrorType {
-  Unknown = 'actions_workflow_unknown'
-}
-
 export type JobError = {
-  'error-type': JobErrorType
+  'error-type': string
   'error-detail': any
 }
 
@@ -95,19 +91,4 @@ export class APIClient {
 
     return res.data.data.attributes
   }
-
-  async failJob(error: Error): Promise<void> {
-    const jobError = this.jobErrorFor(error)
-    await this.reportJobError(jobError)
-    await this.markJobAsProcessed()
-  }
-
-  private jobErrorFor(error: Error): JobError {
-    const errorType = JobErrorType.Unknown
-
-    return {
-      'error-type': errorType,
-      'error-detail': error.message
-    }
-  }
 }
diff --git a/src/main.ts b/src/main.ts
@@ -12,6 +12,10 @@ export const UPDATER_IMAGE_NAME =
 export const PROXY_IMAGE_NAME =
   'docker.pkg.github.com/github/dependabot-update-job-proxy:latest'
 
+export enum DependabotErrorType {
+  Unknown = 'actions_workflow_unknown'
+}
+
 export async function run(context: Context): Promise<void> {
   try {
     // Decode JobParameters:
@@ -45,7 +49,7 @@ export async function run(context: Context): Promise<void> {
       core.info('🤖 ~fin~')
     } catch (error) {
       // Update Dependabot API on the job failure
-      apiClient.failJob(error)
+      failJob(apiClient, error)
       core.setFailed(error.message)
     }
   } catch (error) {
@@ -58,4 +62,16 @@ export async function run(context: Context): Promise<void> {
   }
 }
 
+async function failJob(
+  apiClient: APIClient,
+  error: Error,
+  errorType = DependabotErrorType.Unknown
+): Promise<void> {
+  await apiClient.reportJobError({
+    'error-type': errorType,
+    'error-detail': error.message
+  })
+  await apiClient.markJobAsProcessed()
+}
+
 run(github.context)