feat: make retry strategies strictly typed for all resource types

Author: sorccu

packages/cli/src/constructs/check-group-v1.ts

@@ -9,7 +9,6 @@ import { ApiCheckDefaultConfig } from './api-check'
 import type { Region } from '..'
 import { type Frequency } from './frequency'
 import {
-  type RetryStrategy,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   type RetryStrategyBuilder, // Used for @links in comments.
 } from './retry-strategy'
@@ -28,6 +27,8 @@ import { PrivateLocationGroupAssignment } from './private-location-group-assignm
 import { Ref } from './ref'
 import { Session } from './project'
 import { validateDeprecatedDoubleCheck } from './internal/common-diagnostics'
+import { CheckRetryStrategy } from './check'
+import { MonitorRetryStrategy } from './monitor'
 
 const defaultApiCheckDefaults: ApiCheckDefaultConfig = {
   headers: [],
@@ -53,6 +54,13 @@ type MultiStepCheckConfig = CheckConfigDefaults & {
   testMatch: string | string[]
 }
 
+/**
+ * Retry strategies supported by groups.
+ */
+export type GroupRetryStrategy =
+  | CheckRetryStrategy
+  | MonitorRetryStrategy
+
 export interface CheckGroupV1Props {
   /**
    * The name of the check group.
@@ -236,7 +244,7 @@ export interface CheckGroupV1Props {
    *
    * If not set, retries are disabled for all checks in the group.
    */
-  retryStrategy?: RetryStrategy
+  retryStrategy?: GroupRetryStrategy
 
   /**
    * Determines whether the checks in the group should run on all selected
@@ -298,7 +306,7 @@ export class CheckGroupV1 extends Construct {
   apiCheckDefaults: ApiCheckDefaultConfig
   browserChecks?: BrowserCheckConfig
   multiStepChecks?: MultiStepCheckConfig
-  retryStrategy?: RetryStrategy
+  retryStrategy?: GroupRetryStrategy
   runParallel?: boolean
   alertSettings?: AlertEscalation
   useGlobalAlertSettings?: boolean

packages/cli/src/constructs/check-group-v2.ts

@@ -1,7 +1,6 @@
 import { PrivateLocation, PrivateLocationRef } from './private-location'
 import type { Region } from '..'
 import {
-  type RetryStrategy,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   type RetryStrategyBuilder, // Used for @links in comments.
 } from './retry-strategy'
@@ -11,7 +10,7 @@ import {
   type AlertEscalationBuilder, // Used for @links in comments.
 } from './alert-escalation-policy'
 import { Diagnostics } from './diagnostics'
-import { CheckGroupV1, CheckGroupV1Props } from './check-group-v1'
+import { CheckGroupV1, CheckGroupV1Props, GroupRetryStrategy } from './check-group-v1'
 import { validateRemovedDoubleCheck } from './internal/common-diagnostics'
 
 export interface CheckGroupV2Props extends Omit<CheckGroupV1Props, 'alertEscalationPolicy'> {
@@ -73,7 +72,7 @@ export interface CheckGroupV2Props extends Omit<CheckGroupV1Props, 'alertEscalat
    *
    * If not set, individual check settings are used.
    */
-  retryStrategy?: RetryStrategy
+  retryStrategy?: GroupRetryStrategy
 
   /**
    * Determines whether the checks in the group should run on all selected

packages/cli/src/constructs/check.ts

@@ -9,14 +9,30 @@ import type { Region } from '..'
 import type { CheckGroupV1, CheckGroupV2, CheckGroupRef } from './check-group'
 import { PrivateLocation, PrivateLocationRef } from './private-location'
 import { PrivateLocationCheckAssignment } from './private-location-check-assignment'
-import { RetryStrategy } from './retry-strategy'
+import {
+  ExponentialRetryStrategy,
+  FixedRetryStrategy,
+  LinearRetryStrategy,
+  NoRetriesRetryStrategy,
+  SingleRetryStrategy,
+} from './retry-strategy'
 import { AlertEscalation } from './alert-escalation-policy'
 import { IncidentTrigger } from './incident'
 import { ConfigDefaultsGetter, makeConfigDefaultsGetter } from './check-config'
 import { Diagnostics } from './diagnostics'
 import { validateDeprecatedDoubleCheck } from './internal/common-diagnostics'
 import { InvalidPropertyValueDiagnostic } from './construct-diagnostics'
 
+/**
+ * Retry strategies supported by checks.
+ */
+export type CheckRetryStrategy =
+  | LinearRetryStrategy
+  | ExponentialRetryStrategy
+  | FixedRetryStrategy
+  | SingleRetryStrategy
+  | NoRetriesRetryStrategy
+
 /**
  * Base configuration properties for all check types.
  * These properties are inherited by ApiCheck, BrowserCheck, and other check types.
@@ -195,7 +211,7 @@ export interface CheckProps {
    * })
    * ```
    */
-  retryStrategy?: RetryStrategy
+  retryStrategy?: CheckRetryStrategy
 
   /**
    * Determines whether the check should run on all selected locations in parallel or round-robin.
@@ -228,7 +244,7 @@ export abstract class Check extends Construct {
   groupId?: Ref
   alertChannels?: Array<AlertChannel | AlertChannelRef>
   testOnly?: boolean
-  retryStrategy?: RetryStrategy
+  retryStrategy?: CheckRetryStrategy
   alertSettings?: AlertEscalation
   useGlobalAlertSettings?: boolean
   runParallel?: boolean

packages/cli/src/constructs/monitor.ts

@@ -7,7 +7,7 @@ import { CheckGroupV2 } from './check-group-v2'
 import { Frequency } from './frequency'
 import { IncidentTrigger } from './incident'
 import { PrivateLocation, PrivateLocationRef } from './private-location'
-import { RetryStrategyType, SingleRetryStrategy } from './retry-strategy'
+import { NoRetriesRetryStrategy, RetryStrategyType, SingleRetryStrategy } from './retry-strategy'
 import { Check, CheckProps } from './check'
 import { Diagnostics } from './diagnostics'
 import { validateRemovedDoubleCheck } from './internal/common-diagnostics'
@@ -16,7 +16,9 @@ import { InvalidPropertyValueDiagnostic } from './construct-diagnostics'
 /**
  * Retry strategies supported by monitors.
  */
-export type MonitorRetryStrategy = SingleRetryStrategy
+export type MonitorRetryStrategy =
+  | SingleRetryStrategy
+  | NoRetriesRetryStrategy
 
 export interface MonitorProps extends Omit<CheckProps, 'doubleCheck'> {
   /**

packages/cli/src/constructs/retry-strategy.ts

@@ -7,8 +7,9 @@ export type RetryStrategyType = 'LINEAR' | 'EXPONENTIAL' | 'FIXED' | 'SINGLE' |
 export type RetryStrategyCondition = 'NETWORK_ERROR'
 
 /**
- * Configuration for check retry behavior.
- * Defines how and when to retry failed checks before marking them as permanently failed.
+ * Configuration for check and monitor retry behavior.
+ * Defines how and when to retry failed checks or monitors before marking
+ * them as permanently failed.
  */
 export interface RetryStrategy {
   /** The retry strategy type */
@@ -83,9 +84,45 @@ export interface RetryStrategy {
 export type RetryStrategyOptions = Omit<RetryStrategy, 'type'>
 
 /**
- * Configuration for single retry behavior.
+ * Configuration for linear retry strategies.
  */
-export interface SingleRetryStrategy extends Pick<RetryStrategy, 'baseBackoffSeconds' | 'sameRegion'> {
+export interface LinearRetryStrategy extends RetryStrategy {
+  type: 'LINEAR'
+}
+
+/**
+ * Options for configuring linear retry strategy behavior.
+ */
+export type LinearRetryStrategyOptions = RetryStrategyOptions
+
+/**
+ * Configuration for exponential retry strategies.
+ */
+export interface ExponentialRetryStrategy extends RetryStrategy {
+  type: 'EXPONENTIAL'
+}
+
+/**
+ * Options for configuring exponential retry strategy behavior.
+ */
+export type ExponentialRetryStrategyOptions = RetryStrategyOptions
+
+/**
+ * Configuration for fixed retry strategies.
+ */
+export interface FixedRetryStrategy extends RetryStrategy {
+  type: 'FIXED'
+}
+
+/**
+ * Options for configuring fixed retry strategy behavior.
+ */
+export type FixedRetryStrategyOptions = RetryStrategyOptions
+
+/**
+ * Configuration for single retry strategies.
+ */
+export interface SingleRetryStrategy extends Pick<RetryStrategy, 'type' | 'baseBackoffSeconds' | 'sameRegion'> {
   type: 'SINGLE'
 }
 
@@ -94,6 +131,13 @@ export interface SingleRetryStrategy extends Pick<RetryStrategy, 'baseBackoffSec
  */
 export type SingleRetryStrategyOptions = Pick<RetryStrategyOptions, 'baseBackoffSeconds' | 'sameRegion'>
 
+/**
+ * Configuration for no retry retry strategies.
+ */
+export interface NoRetriesRetryStrategy extends Pick<RetryStrategy, 'type'> {
+  type: 'NO_RETRIES'
+}
+
 /**
  * Builder class for creating retry strategies.
  * Provides convenient methods to create different types of retry strategies.
@@ -144,8 +188,11 @@ export class RetryStrategyBuilder {
   /**
    * Each retry is run with the same backoff between attempts.
    */
-  static fixedStrategy (options?: RetryStrategyOptions): RetryStrategy {
-    return RetryStrategyBuilder.retryStrategy('FIXED', options)
+  static fixedStrategy (options?: FixedRetryStrategyOptions): FixedRetryStrategy {
+    return {
+      type: 'FIXED',
+      ...RetryStrategyBuilder.defaults(options),
+    }
   }
 
   /**
@@ -154,8 +201,11 @@ export class RetryStrategyBuilder {
    * The delay between retries is calculated using `baseBackoffSeconds * attempt`.
    * For example, retries will be run with a backoff of 10s, 20s, 30s, and so on.
    */
-  static linearStrategy (options?: RetryStrategyOptions): RetryStrategy {
-    return RetryStrategyBuilder.retryStrategy('LINEAR', options)
+  static linearStrategy (options?: LinearRetryStrategyOptions): LinearRetryStrategy {
+    return {
+      type: 'LINEAR',
+      ...RetryStrategyBuilder.defaults(options),
+    }
   }
 
   /**
@@ -164,38 +214,36 @@ export class RetryStrategyBuilder {
    * The delay between retries is calculated using `baseBackoffSeconds ^ attempt`.
    * For example, retries will be run with a backoff of 10s, 100s, 1000s, and so on.
    */
-  static exponentialStrategy (options?: RetryStrategyOptions): RetryStrategy {
-    return RetryStrategyBuilder.retryStrategy('EXPONENTIAL', options)
+  static exponentialStrategy (options?: ExponentialRetryStrategyOptions): ExponentialRetryStrategy {
+    return {
+      type: 'EXPONENTIAL',
+      ...RetryStrategyBuilder.defaults(options),
+    }
   }
 
   /**
    * A single retry will be performed.
    */
-  static singleRetry (options?: SingleRetryStrategyOptions): RetryStrategy {
-    const {
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      maxRetries,
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      maxDurationSeconds,
-      ...strategy
-    } = RetryStrategyBuilder.retryStrategy('SINGLE', {
-      baseBackoffSeconds: options?.baseBackoffSeconds,
-      sameRegion: options?.sameRegion,
-    })
-
-    return strategy
+  static singleRetry (options?: SingleRetryStrategyOptions): SingleRetryStrategy {
+    const { baseBackoffSeconds, sameRegion } = RetryStrategyBuilder.defaults(options)
+    return {
+      type: 'SINGLE',
+      baseBackoffSeconds,
+      sameRegion,
+    }
   }
 
   /**
    * No retries are performed.
    */
-  static noRetries (): RetryStrategy {
-    return RetryStrategyBuilder.retryStrategy('NO_RETRIES')
+  static noRetries (): NoRetriesRetryStrategy {
+    return {
+      type: 'NO_RETRIES',
+    }
   }
 
-  private static retryStrategy (type: RetryStrategyType, options?: RetryStrategyOptions): RetryStrategy {
+  private static defaults (options?: RetryStrategyOptions): RetryStrategyOptions {
     return {
-      type,
       baseBackoffSeconds: options?.baseBackoffSeconds ?? RetryStrategyBuilder.DEFAULT_BASE_BACKOFF_SECONDS,
       maxRetries: options?.maxRetries ?? RetryStrategyBuilder.DEFAULT_MAX_RETRIES,
       maxDurationSeconds: options?.maxDurationSeconds ?? RetryStrategyBuilder.DEFAULT_MAX_DURATION_SECONDS,