@commercetools-frontend-extensions/operations 3.4.0 → 3.5.0

package/src/@errors/polling-timeout-error.ts

@@ -0,0 +1,17 @@
+import { ErrorCode, OperationsError } from './base'
+
+export class PollingTimeoutError extends OperationsError {
+  readonly code = ErrorCode.POLLING_TIMEOUT
+  readonly isRetryable = true
+  readonly maxAttempts: number
+  readonly totalTimeSeconds: number
+
+  constructor(maxAttempts: number, totalTimeSeconds: number) {
+    super(
+      `Polling timeout after ${maxAttempts} attempts (${totalTimeSeconds}s)`
+    )
+    this.name = 'PollingTimeoutError'
+    this.maxAttempts = maxAttempts
+    this.totalTimeSeconds = totalTimeSeconds
+  }
+}

package/src/@errors/project-key-not-available-error.ts

@@ -1,4 +1,9 @@
-export class ProjectKeyNotAvailableError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class ProjectKeyNotAvailableError extends OperationsError {
+  readonly code = ErrorCode.PROJECT_KEY_NOT_AVAILABLE
+  readonly isRetryable = false
+
   constructor(message: string = 'Project key is not available') {
     super(message)
     this.name = 'ProjectKeyNotAvailableError'

package/src/@errors/query-predicate-error.ts

@@ -1,5 +1,9 @@
-export class QueryPredicateError extends Error {
-  field = 'queryPredicate'
+import { ErrorCode, OperationsError } from './base'
+
+export class QueryPredicateError extends OperationsError {
+  readonly code = ErrorCode.QUERY_PREDICATE_ERROR
+  readonly isRetryable = false
+  readonly field = 'queryPredicate'
 
   constructor(
     message: string = 'There is an error with the query predicate. Make sure the syntax is correct.'

package/src/@errors/unexpected-column-error.ts

@@ -1,6 +1,13 @@
-export class UnexpectedColumnError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class UnexpectedColumnError extends OperationsError {
+  readonly code = ErrorCode.UNEXPECTED_COLUMN
+  readonly isRetryable = false
+  readonly columnName: string
+
   constructor(columnName: string) {
     super(`Unexpected column "${columnName}"`)
     this.name = 'UnexpectedColumnError'
+    this.columnName = columnName
   }
 }

package/src/@errors/unexpected-operation-state-error.ts

@@ -1,8 +1,14 @@
 import { ProcessingState } from '@commercetools/importapi-sdk'
+import { ErrorCode, OperationsError } from './base'
+
+export class UnexpectedOperationStateError extends OperationsError {
+  readonly code = ErrorCode.UNEXPECTED_OPERATION_STATE
+  readonly isRetryable = false
+  readonly state: ProcessingState
 
-export class UnexpectedOperationStateError extends Error {
   constructor(state: ProcessingState) {
     super(`Unexpected operation state "${state}"`)
     this.name = 'UnexpectedOperationStateError'
+    this.state = state
   }
 }

package/src/@errors/unexpected-resource-type-error.ts

@@ -1,6 +1,13 @@
-export class UnexpectedResourceTypeError extends Error {
+import { ErrorCode, OperationsError } from './base'
+
+export class UnexpectedResourceTypeError extends OperationsError {
+  readonly code = ErrorCode.UNEXPECTED_RESOURCE_TYPE
+  readonly isRetryable = false
+  readonly resourceType: string
+
   constructor(resourceType: string) {
     super(`Unexpected resource type "${resourceType}"`)
     this.name = 'UnexpectedResourceTypeError'
+    this.resourceType = resourceType
   }
 }

package/src/@utils/poll-job-until-processing.ts

@@ -1,5 +1,5 @@
 import { getFileImportJob } from '../@api'
-import { PollingAbortedError } from '../@errors'
+import { PollingAbortedError, PollingTimeoutError } from '../@errors'
 import type { FileImportJob } from '../@types'
 import { hasImportJobStartedProcessing } from './file-import-job-helpers'
 
@@ -64,9 +64,6 @@ export const pollJobUntilProcessing = async ({
     attempts++
   }
 
-  throw new Error(
-    `Job did not start processing after ${maxAttempts} attempts (${
-      (maxAttempts * pollingInterval) / 1000
-    }s)`
-  )
+  const totalTimeSeconds = (maxAttempts * pollingInterval) / 1000
+  throw new PollingTimeoutError(maxAttempts, totalTimeSeconds)
 }

package/src/@utils/poll-job-until-validated.ts

@@ -1,5 +1,5 @@
 import { getFileImportJob } from '../@api'
-import { PollingAbortedError } from '../@errors'
+import { PollingAbortedError, PollingTimeoutError } from '../@errors'
 import type { FileImportJob } from '../@types'
 import { isImportJobTerminal } from './file-import-job-helpers'
 
@@ -68,9 +68,6 @@ export const pollJobUntilValidated = async ({
     attempts++
   }
 
-  throw new Error(
-    `Job validation timeout after ${maxAttempts} attempts (${
-      (maxAttempts * pollingInterval) / 1000
-    }s)`
-  )
+  const totalTimeSeconds = (maxAttempts * pollingInterval) / 1000
+  throw new PollingTimeoutError(maxAttempts, totalTimeSeconds)
 }