feat: allow checks and groups to refer to resources they are linked to

Covers private locations and alert channels.

Author: sorccu

packages/cli/src/commands/import/plan.ts

@@ -12,7 +12,8 @@ import { splitConfigFilePath } from '../../services/util'
 import { loadChecklyConfig } from '../../services/checkly-config-loader'
 import { ImportPlan } from '../../rest/projects'
 import { Program, Output } from '../../sourcegen'
-import { ConstructCodegen } from '../../constructs/construct-codegen'
+import { ConstructCodegen, sortResources } from '../../constructs/construct-codegen'
+import { Context } from '../../constructs/internal/codegen'
 
 export default class ImportPlanCommand extends AuthCommand {
   static coreCommand = true
@@ -91,10 +92,17 @@ export default class ImportPlanCommand extends AuthCommand {
     try {
       const program = new Program()
       const codegen = new ConstructCodegen(program)
+      const context = new Context()
 
       if (plan.changes) {
+        sortResources(plan.changes.resources as any)
+
+        for (const resource of plan.changes.resources) {
+          codegen.prepare(resource.logicalId, resource as any, context)
+        }
+
         for (const resource of plan.changes.resources) {
-          codegen.gencode(resource.logicalId, resource as any)
+          codegen.gencode(resource.logicalId, resource as any, context)
         }
       }
 

packages/cli/src/constructs/alert-channel-codegen.ts

@@ -1,16 +1,26 @@
-import { Codegen } from './internal/codegen'
+import { Codegen, Context } from './internal/codegen'
 import { Program, ObjectValueBuilder } from '../sourcegen'
 
-import { EmailAlertChannelCodegen, EmailAlertChannelResource } from './email-alert-channel-codegen'
-import { OpsgenieAlertChannelCodegen, OpsgenieAlertChannelResource } from './opsgenie-alert-channel-codegen'
-import { PagerdutyAlertChannelCodegen, PagerdutyAlertChannelResource } from './pagerduty-alert-channel-codegen'
-import { PhoneCallAlertChannelCodegen, PhoneCallAlertChannelResource } from './phone-call-alert-channel-codegen'
-import { SlackAlertChannelCodegen, SlackAlertChannelResource } from './slack-alert-channel-codegen'
-import { SmsAlertChannelCodegen, SmsAlertChannelResource } from './sms-alert-channel-codegen'
-import { WebhookAlertChannelCodegen, WebhookAlertChannelResource } from './webhook-alert-channel-codegen'
+import { EmailAlertChannelCodegen } from './email-alert-channel-codegen'
+import { OpsgenieAlertChannelCodegen } from './opsgenie-alert-channel-codegen'
+import { PagerdutyAlertChannelCodegen } from './pagerduty-alert-channel-codegen'
+import { PhoneCallAlertChannelCodegen } from './phone-call-alert-channel-codegen'
+import { SlackAlertChannelCodegen } from './slack-alert-channel-codegen'
+import { SmsAlertChannelCodegen } from './sms-alert-channel-codegen'
+import { WebhookAlertChannelCodegen } from './webhook-alert-channel-codegen'
+
+export type AlertChannelType =
+  'CALL' |
+  'EMAIL' |
+  'OPSGENIE' |
+  'PAGERDUTY' |
+  'SLACK' |
+  'SMS' |
+  'WEBHOOK'
 
 export interface AlertChannelResource {
-  type: string
+  id: number
+  type: AlertChannelType
   sendRecovery: boolean
   sendFailure: boolean
   sendDegraded: boolean
@@ -48,6 +58,7 @@ export class AlertChannelCodegen extends Codegen<AlertChannelResource> {
   slackCodegen: SlackAlertChannelCodegen
   smsCodegen: SmsAlertChannelCodegen
   webhookCodegen: WebhookAlertChannelCodegen
+  codegensByType: Record<AlertChannelType, Codegen<any>>
 
   constructor (program: Program) {
     super(program)
@@ -58,26 +69,33 @@ export class AlertChannelCodegen extends Codegen<AlertChannelResource> {
     this.slackCodegen = new SlackAlertChannelCodegen(program)
     this.smsCodegen = new SmsAlertChannelCodegen(program)
     this.webhookCodegen = new WebhookAlertChannelCodegen(program)
+
+    this.codegensByType = {
+      CALL: this.phoneCallCodegen,
+      EMAIL: this.emailCodegen,
+      OPSGENIE: this.opsgenieCodegen,
+      PAGERDUTY: this.pagerdutyCodegen,
+      SLACK: this.slackCodegen,
+      SMS: this.smsCodegen,
+      WEBHOOK: this.webhookCodegen,
+    }
+  }
+
+  prepare (logicalId: string, resource: AlertChannelResource, context: Context): void {
+    const codegen = this.codegensByType[resource.type]
+    if (codegen === undefined) {
+      throw new Error(`Unable to generate code for unsupported alert channel type '${resource.type}'.`)
+    }
+
+    codegen.prepare(logicalId, resource, context)
   }
 
-  gencode (logicalId: string, resource: AlertChannelResource): void {
-    switch (resource.type) {
-      case 'CALL':
-        return this.phoneCallCodegen.gencode(logicalId, resource as PhoneCallAlertChannelResource)
-      case 'EMAIL':
-        return this.emailCodegen.gencode(logicalId, resource as EmailAlertChannelResource)
-      case 'OPSGENIE':
-        return this.opsgenieCodegen.gencode(logicalId, resource as OpsgenieAlertChannelResource)
-      case 'PAGERDUTY':
-        return this.pagerdutyCodegen.gencode(logicalId, resource as PagerdutyAlertChannelResource)
-      case 'SLACK':
-        return this.slackCodegen.gencode(logicalId, resource as SlackAlertChannelResource)
-      case 'SMS':
-        return this.smsCodegen.gencode(logicalId, resource as SmsAlertChannelResource)
-      case 'WEBHOOK':
-        return this.webhookCodegen.gencode(logicalId, resource as WebhookAlertChannelResource)
-      default:
-        throw new Error(`Unable to generate code for unsupported alert channel type '${resource.type}'.`)
+  gencode (logicalId: string, resource: AlertChannelResource, context: Context): void {
+    const codegen = this.codegensByType[resource.type]
+    if (codegen === undefined) {
+      throw new Error(`Unable to generate code for unsupported alert channel type '${resource.type}'.`)
     }
+
+    codegen.gencode(logicalId, resource, context)
   }
 }

packages/cli/src/constructs/alert-channel-subscription-codegen.ts

@@ -0,0 +1,24 @@
+import { Codegen, Context } from './internal/codegen'
+
+export interface AlertChannelSubscriptionResource {
+  alertChannelId: number
+  groupId?: number
+  checkId?: string
+}
+
+export class AlertChannelSubscriptionCodegen extends Codegen<AlertChannelSubscriptionResource> {
+  prepare (logicalId: string, resource: AlertChannelSubscriptionResource, context: Context): void {
+    if (resource.checkId !== undefined) {
+      context.registerAlertChannelCheckSubscription(resource.alertChannelId, resource.checkId)
+    }
+
+    if (resource.groupId !== undefined) {
+      context.registerAlertChannelGroupSubscription(resource.alertChannelId, resource.groupId)
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  gencode (logicalId: string, resource: AlertChannelSubscriptionResource, context: Context): void {
+    // Nothing to generate for this resource.
+  }
+}

packages/cli/src/constructs/api-check-codegen.ts

@@ -1,4 +1,4 @@
-import { Codegen } from './internal/codegen'
+import { Codegen, Context } from './internal/codegen'
 import { expr, ident, Program, Value } from '../sourcegen'
 import { Assertion, Request } from './api-check'
 import { buildCheckProps, CheckResource } from './check-codegen'
@@ -40,7 +40,7 @@ export function valueForAssertion (program: Program, assertion: Assertion): Valu
 const construct = 'ApiCheck'
 
 export class ApiCheckCodegen extends Codegen<ApiCheckResource> {
-  gencode (logicalId: string, resource: ApiCheckResource): void {
+  gencode (logicalId: string, resource: ApiCheckResource, context: Context): void {
     this.program.import(construct, 'checkly/constructs')
 
     this.program.section(expr(ident(construct), builder => {
@@ -145,7 +145,7 @@ export class ApiCheckCodegen extends Codegen<ApiCheckResource> {
             builder.number('maxResponseTime', resource.maxResponseTime)
           }
 
-          buildCheckProps(this.program, builder, resource)
+          buildCheckProps(this.program, builder, resource, context)
         })
       })
     }))

packages/cli/src/constructs/browser-check-codegen.ts

@@ -1,4 +1,4 @@
-import { Codegen } from './internal/codegen'
+import { Codegen, Context } from './internal/codegen'
 import { expr, ident } from '../sourcegen'
 import { buildCheckProps, CheckResource } from './check-codegen'
 import { PlaywrightConfigResource, valueForPlaywrightConfig } from './playwright-config-codegen'
@@ -14,7 +14,7 @@ export interface BrowserCheckResource extends CheckResource{
 const construct = 'BrowserCheck'
 
 export class BrowserCheckCodegen extends Codegen<BrowserCheckResource> {
-  gencode (logicalId: string, resource: BrowserCheckResource): void {
+  gencode (logicalId: string, resource: BrowserCheckResource, context: Context): void {
     this.program.import(construct, 'checkly/constructs')
 
     this.program.section(expr(ident(construct), builder => {
@@ -39,7 +39,7 @@ export class BrowserCheckCodegen extends Codegen<BrowserCheckResource> {
             builder.value('playwrightConfig', valueForPlaywrightConfig(resource.playwrightConfig))
           }
 
-          buildCheckProps(this.program, builder, resource)
+          buildCheckProps(this.program, builder, resource, context)
         })
       })
     }))

packages/cli/src/constructs/check-codegen.ts

@@ -1,4 +1,4 @@
-import { Codegen } from './internal/codegen'
+import { Codegen, Context } from './internal/codegen'
 import { Program, ObjectValueBuilder } from '../sourcegen'
 import { AlertEscalationResource, valueForAlertEscalation } from './alert-escalation-policy-codegen'
 import { ApiCheckCodegen, ApiCheckResource } from './api-check-codegen'
@@ -9,11 +9,11 @@ import { FrequencyResource, valueForFrequency } from './frequency-codegen'
 import { HeartbeatCheckCodegen, HeartbeatCheckResource } from './heartbeat-check-codegen'
 import { valueForKeyValuePair } from './key-value-pair-codegen'
 import { MultiStepCheckCodegen, MultiStepCheckResource } from './multi-step-check-codegen'
-import { valueForRef } from './ref-codegen'
 import { RetryStrategyResource, valueForRetryStrategy } from './retry-strategy-codegen'
 import { TcpCheckCodegen, TcpCheckResource } from './tcp-check-codegen'
 
 export interface CheckResource {
+  id: string
   checkType: string
   name: string
   activated?: boolean
@@ -22,7 +22,6 @@ export interface CheckResource {
   shouldFail?: boolean
   runtimeId?: string
   locations?: string[]
-  // TODO: privateLocations
   tags?: string[]
   frequency?: FrequencyResource
   environmentVariables?: EnvironmentVariable[]
@@ -37,6 +36,7 @@ export function buildCheckProps (
   program: Program,
   builder: ObjectValueBuilder,
   resource: CheckResource,
+  context: Context,
 ): void {
   builder.string('name', resource.name)
 
@@ -65,9 +65,21 @@ export function buildCheckProps (
     })
   }
 
-  // if (resource.privateLocations) {
-  //   // TODO: privateLocations - live variables
-  // }
+  const privateLocationIds = (() => {
+    try {
+      return context.lookupCheckPrivateLocations(resource.id)
+    } catch (err) {
+    }
+  })()
+
+  if (privateLocationIds !== undefined) {
+    builder.array('privateLocations', builder => {
+      for (const privateLocationId of privateLocationIds) {
+        const privateLocationVariable = context.lookupPrivateLocation(privateLocationId)
+        builder.value(privateLocationVariable)
+      }
+    })
+  }
 
   if (resource.tags) {
     const tags = resource.tags
@@ -91,17 +103,30 @@ export function buildCheckProps (
     })
   }
 
-  // if (resource.groupId) {
-  //   builder.value('groupId', valueForRef(program, resource.groupId))
-  // }
+  if (resource.groupId) {
+    try {
+      const groupVariable = context.lookupCheckGroup(resource.groupId)
+      builder.value('group', groupVariable)
+    } catch (err) {
+      throw new Error('Check belongs to a group that is not being imported.')
+    }
+  }
 
-  // if (resource.group) {
-  //   // TODO: group - live variables
-  // }
+  const alertChannelIds = (() => {
+    try {
+      return context.lookupCheckAlertChannels(resource.id)
+    } catch (err) {
+    }
+  })()
 
-  // if (resource.alertChannels) {
-  //   // TODO: alertChannels - live variables
-  // }
+  if (alertChannelIds !== undefined) {
+    builder.array('alertChannels', builder => {
+      for (const alertChannelId of alertChannelIds) {
+        const alertChannelVariable = context.lookupAlertChannel(alertChannelId)
+        builder.value(alertChannelVariable)
+      }
+    })
+  }
 
   if (resource.alertSettings) {
     builder.value('alertEscalationPolicy', valueForAlertEscalation(program, resource.alertSettings))
@@ -136,20 +161,20 @@ export class CheckCodegen extends Codegen<CheckResource> {
     this.tcpCheckCodegen = new TcpCheckCodegen(program)
   }
 
-  gencode (logicalId: string, resource: CheckResource): void {
+  gencode (logicalId: string, resource: CheckResource, context: Context): void {
     const { checkType } = resource
 
     switch (checkType) {
       case 'BROWSER':
-        return this.browserCheckCodegen.gencode(logicalId, resource as BrowserCheckResource)
+        return this.browserCheckCodegen.gencode(logicalId, resource as BrowserCheckResource, context)
       case 'API':
-        return this.apiCheckCodegen.gencode(logicalId, resource as ApiCheckResource)
+        return this.apiCheckCodegen.gencode(logicalId, resource as ApiCheckResource, context)
       case 'TCP':
-        return this.tcpCheckCodegen.gencode(logicalId, resource as TcpCheckResource)
+        return this.tcpCheckCodegen.gencode(logicalId, resource as TcpCheckResource, context)
       case 'MULTI_STEP':
-        return this.multiStepCheckCodegen.gencode(logicalId, resource as MultiStepCheckResource)
+        return this.multiStepCheckCodegen.gencode(logicalId, resource as MultiStepCheckResource, context)
       case 'HEARTBEAT':
-        return this.heartbeatCheckCodegen.gencode(logicalId, resource as HeartbeatCheckResource)
+        return this.heartbeatCheckCodegen.gencode(logicalId, resource as HeartbeatCheckResource, context)
       default:
         throw new Error(`Unable to generate code for unsupported check type '${checkType}'.`)
     }