Add NO_RETRIES type

checkly · Mar 25, 2024 · 34dcc6c · 34dcc6c
1 parent b5e2a1a
commit 34dcc6c
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 21 deletions.
diff --git a/packages/cli/src/constructs/check-group.ts b/packages/cli/src/constructs/check-group.ts
@@ -110,7 +110,7 @@ export interface CheckGroupProps {
   /**
    * Sets a retry policy for the group. Use RetryStrategyBuilder to create a retry policy.
    */
-  retryStrategy?: RetryStrategy | null
+  retryStrategy?: RetryStrategy
   /**
    * Determines whether the checks in the group should run on all selected locations in parallel or round-robin.
    * See https://www.checklyhq.com/docs/monitoring/global-locations/ to learn more about scheduling strategies.
@@ -143,7 +143,7 @@ export class CheckGroup extends Construct {
   apiCheckDefaults: ApiCheckDefaultConfig
   browserChecks?: BrowserCheckConfig
   multiStepChecks?: MultiStepCheckConfig
-  retryStrategy?: RetryStrategy | null
+  retryStrategy?: RetryStrategy
   runParallel?: boolean
   alertSettings?: AlertEscalation
   useGlobalAlertSettings?: boolean
@@ -163,6 +163,7 @@ export class CheckGroup extends Construct {
     this.name = props.name
     this.activated = props.activated
     this.muted = props.muted
+    this.doubleCheck = props.doubleCheck
     this.tags = props.tags
     this.runtimeId = props.runtimeId
     this.locations = props.locations
@@ -184,11 +185,6 @@ export class CheckGroup extends Construct {
     this.alertChannels = props.alertChannels ?? []
     this.localSetupScript = props.localSetupScript
     this.localTearDownScript = props.localTearDownScript
-    // When `retryStrategy: null` and `doubleCheck: undefined`, we want to let the user disable all retries.
-    // The backend has a Joi default of `doubleCheck: true`, though, so we need special handling for this case.
-    this.doubleCheck = props.doubleCheck === undefined && props.retryStrategy === null
-      ? false
-      : props.doubleCheck
     this.retryStrategy = props.retryStrategy
     this.runParallel = props.runParallel
     // `browserChecks` is not a CheckGroup resource property. Not present in synthesize()
@@ -286,7 +282,6 @@ export class CheckGroup extends Construct {
       name: this.name,
       activated: this.activated,
       muted: this.muted,
-      doubleCheck: this.doubleCheck,
       tags: this.tags,
       locations: this.locations,
       runtimeId: this.runtimeId,
@@ -299,7 +294,15 @@ export class CheckGroup extends Construct {
       localTearDownScript: this.localTearDownScript,
       apiCheckDefaults: this.apiCheckDefaults,
       environmentVariables: this.environmentVariables,
-      retryStrategy: this.retryStrategy,
+      // The backend doesn't actually support the `NO_RETRIES` type, it uses `null` instead.
+      retryStrategy: this.retryStrategy?.type === 'NO_RETRIES'
+        ? null
+        : this.retryStrategy,
+      // When `retryStrategy: NO_RETRIES` and `doubleCheck: undefined`, we want to let the user disable all retries.
+      // The backend has a Joi default of `doubleCheck: true`, though, so we need special handling for this case.
+      doubleCheck: this.doubleCheck === undefined && this.retryStrategy?.type === 'NO_RETRIES'
+        ? false
+        : this.doubleCheck,
       runParallel: this.runParallel,
       alertSettings: this.alertSettings,
       useGlobalAlertSettings: this.useGlobalAlertSettings,

diff --git a/packages/cli/src/constructs/check.ts b/packages/cli/src/constructs/check.ts
@@ -92,7 +92,7 @@ export interface CheckProps {
   /**
    * Sets a retry policy for the check. Use RetryStrategyBuilder to create a retry policy.
    */
-  retryStrategy?: RetryStrategy | null
+  retryStrategy?: RetryStrategy
   /**
    * Determines whether the check should run on all selected locations in parallel or round-robin.
    * See https://www.checklyhq.com/docs/monitoring/global-locations/ to learn more about scheduling strategies.
@@ -117,7 +117,7 @@ export abstract class Check extends Construct {
   groupId?: Ref
   alertChannels?: Array<AlertChannel>
   testOnly?: boolean
-  retryStrategy?: RetryStrategy | null
+  retryStrategy?: RetryStrategy
   alertSettings?: AlertEscalation
   useGlobalAlertSettings?: boolean
   runParallel?: boolean
@@ -135,6 +135,7 @@ export abstract class Check extends Construct {
     this.name = props.name
     this.activated = props.activated
     this.muted = props.muted
+    this.doubleCheck = props.doubleCheck
     this.shouldFail = props.shouldFail
     this.locations = props.locations
     this.privateLocations = props.privateLocations
@@ -155,11 +156,6 @@ export abstract class Check extends Construct {
     // alertSettings, useGlobalAlertSettings, groupId, groupOrder
 
     this.testOnly = props.testOnly ?? false
-    // When `retryStrategy: null` and `doubleCheck: undefined`, we want to let the user disable all retries.
-    // The backend has a Joi default of `doubleCheck: true`, though, so we need special handling for this case.
-    this.doubleCheck = props.doubleCheck === undefined && props.retryStrategy === null
-      ? false
-      : props.doubleCheck
     this.retryStrategy = props.retryStrategy
     this.alertSettings = props.alertEscalationPolicy
     this.useGlobalAlertSettings = !this.alertSettings
@@ -226,7 +222,6 @@ export abstract class Check extends Construct {
       name: this.name,
       activated: this.activated,
       muted: this.muted,
-      doubleCheck: this.doubleCheck,
       shouldFail: this.shouldFail,
       runtimeId: this.runtimeId,
       locations: this.locations,
@@ -239,7 +234,15 @@ export abstract class Check extends Construct {
       frequencyOffset: this.frequencyOffset,
       groupId: this.groupId,
       environmentVariables: this.environmentVariables,
-      retryStrategy: this.retryStrategy,
+      // The backend doesn't actually support the `NO_RETRIES` type, it uses `null` instead.
+      retryStrategy: this.retryStrategy?.type === 'NO_RETRIES'
+        ? null
+        : this.retryStrategy,
+      // When `retryStrategy: NO_RETRIES` and `doubleCheck: undefined`, we want to let the user disable all retries.
+      // The backend has a Joi default of `doubleCheck: true`, though, so we need special handling for this case.
+      doubleCheck: this.doubleCheck === undefined && this.retryStrategy?.type === 'NO_RETRIES'
+        ? false
+        : this.doubleCheck,
       alertSettings: this.alertSettings,
       useGlobalAlertSettings: this.useGlobalAlertSettings,
       runParallel: this.runParallel,

diff --git a/packages/cli/src/constructs/retry-strategy.ts b/packages/cli/src/constructs/retry-strategy.ts
@@ -1,4 +1,4 @@
-export type RetryStrategyType = 'LINEAR' | 'EXPONENTIAL' | 'FIXED'
+export type RetryStrategyType = 'LINEAR' | 'EXPONENTIAL' | 'FIXED' | 'NO_RETRIES'
 
 export interface RetryStrategy {
   type: RetryStrategyType,
@@ -58,8 +58,8 @@ export class RetryStrategyBuilder {
   /**
    * No retries are performed.
    */
-  static noRetries (): null {
-    return null
+  static noRetries (): RetryStrategy {
+    return RetryStrategyBuilder.retryStrategy('NO_RETRIES')
   }
 
   private static retryStrategy (type: RetryStrategyType, options?: RetryStrategyOptions): RetryStrategy {