Merge pull request #1097 from JupiterOne/DP-287-add-terminal-status-t…

…o-abort-endpoint [DP-287] - Add terminalStatus to abort syncJob api endpoint
JupiterOne · Jul 5, 2024 · f33ba16 · f33ba16
2 parents 832afaa + 32ec904
commit f33ba16
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/packages/integration-sdk-core/src/types/synchronization.ts b/packages/integration-sdk-core/src/types/synchronization.ts
@@ -7,6 +7,7 @@ export enum SynchronizationJobStatus {
   FINISHED = 'FINISHED',
   UNKNOWN = 'UNKNOWN',
   ERROR_BAD_DATA = 'ERROR_BAD_DATA',
+  ABORTED_DUE_TO_INVALID_CONFIGURATION = 'ABORTED_DUE_TO_INVALID_CONFIGURATION',
 }
 
 export interface SynchronizationJob {

diff --git a/packages/integration-sdk-runtime/src/synchronization/index.ts b/packages/integration-sdk-runtime/src/synchronization/index.ts
@@ -7,6 +7,7 @@ import {
   PartialDatasets,
   Relationship,
   SynchronizationJob,
+  SynchronizationJobStatus,
 } from '@jupiterone/integration-sdk-core';
 
 import { AxiosError } from 'axios';
@@ -569,6 +570,7 @@ export async function uploadData<T extends UploadDataLookup, K extends keyof T>(
 
 interface AbortSynchronizationInput extends SynchronizationJobContext {
   reason?: string;
+  terminalStatus?: SynchronizationJobStatus;
 }
 /**
  * Aborts a synchronization job
@@ -578,15 +580,19 @@ export async function abortSynchronization({
   apiClient,
   job,
   reason,
+  terminalStatus,
 }: AbortSynchronizationInput) {
-  logger.info('Aborting synchronization job...');
+  logger.info(
+    { integrationJobId: job.id, reason, terminalStatus },
+    'Aborting synchronization job...',
+  );
 
   let abortedJob: SynchronizationJob;
 
   try {
     const response = await apiClient.post(
       `/persister/synchronization/jobs/${job.id}/abort`,
-      { reason },
+      { reason, terminalStatus },
     );
     abortedJob = response.data.job;
   } catch (err) {