feat(deploy): add --verbose flag for resource name and id output

Add a -v/--verbose flag to `deploy` that shows the resource name and
physical ID (UUID) for each created or updated resource. The --verbose
flag implies --output, so both flags don't need to be passed together.

Without --verbose, deploy output is unchanged.

Author: MichaelHogers

packages/cli/e2e/__tests__/deploy.spec.ts

@@ -99,9 +99,12 @@ describe('deploy', { timeout: 45_000 }, () => {
   // Create a unique ID suffix to support parallel test executions
   let projectLogicalId: string
   let privateLocationSlugname: string
+  let latestVersion = ''
   // Cleanup projects that may have not been deleted in previous runs
   beforeAll(async () => {
     await cleanupProjects()
+    const packageInformation = await axios.get('https://registry.npmjs.org/checkly/latest')
+    latestVersion = packageInformation.data.version
   })
   beforeEach(() => {
     projectLogicalId = `e2e-test-deploy-project-${uuidv4()}`
@@ -158,8 +161,8 @@ describe('deploy', { timeout: 45_000 }, () => {
         },
       })
       expect(stderr).toBe('')
-      // Non-interactive runs should no longer emit the local-dev version notice.
-      expect(stdout).not.toContain('Notice: replacing version')
+      // expect the version to be overriden with latest from NPM
+      expect(stdout).toContain(`Notice: replacing version '0.0.1-dev' with latest '${latestVersion}'`)
 
       const checks = await getAllResources('checks')
       const checkGroups = await getAllResources('check-groups')
@@ -304,7 +307,7 @@ Skip (testOnly):
         },
       })
       // Deploy a check (testOnly=true)
-      const { stdout } = await runDeploy(fixt, ['--force', '--output'], {
+      const { stdout } = await runDeploy(fixt, ['--force', '--output', '--verbose'], {
         env: {
           PROJECT_LOGICAL_ID: projectLogicalId,
           PRIVATE_LOCATION_SLUG_NAME: privateLocationSlugname,
@@ -314,13 +317,19 @@ Skip (testOnly):
       })
       // Moving the check to testOnly causes it to be deleted.
       // The check should only be listed under "Delete" and not "Skip".
-      expect(stdout).toContain(
-        `Delete:
-    Check: testonly-true-check
-
-Update and Unchanged:
-    ApiCheck: not-testonly-default-check
-    ApiCheck: not-testonly-false-check`)
+      const uuid = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
+      expect(stdout).toMatch(new RegExp(
+        `Delete:\n`
+        + `    Check: testonly-true-check\n`
+        + `\n`
+        + `Update and Unchanged:\n`
+        + `    ApiCheck: not-testonly-default-check\n`
+        + `      name: TestOnly=false \\(default\\) Check\n`
+        + `      id: ${uuid}\n`
+        + `    ApiCheck: not-testonly-false-check\n`
+        + `      name: TestOnly=false Check\n`
+        + `      id: ${uuid}`,
+      ))
     })
   })
 
@@ -340,7 +349,7 @@ Update and Unchanged:
     it('Should terminate when no resources are found', async () => {
       expect.assertions(1)
       try {
-        await runDeploy(fixt, ['--force'], {
+        await runDeploy(fixt, [], {
           env: {
             PROJECT_LOGICAL_ID: projectLogicalId,
             PRIVATE_LOCATION_SLUG_NAME: privateLocationSlugname,
@@ -349,7 +358,7 @@ Update and Unchanged:
         })
       } catch (err: any) {
         if (err instanceof ExecaError) {
-          expect(`${err.stdout}\n${err.stderr}`).toContain('Failed to deploy your project. Unable to find constructs to deploy.')
+          expect(err.stderr).toContain('Failed to deploy your project. Unable to find constructs to deploy.')
         } else {
           throw err
         }

packages/cli/src/commands/deploy.ts

@@ -1,6 +1,7 @@
 import { setTimeout } from 'node:timers/promises'
 import * as fs from 'fs/promises'
 import * as api from '../rest/api'
+import prompts from 'prompts'
 import { Flags } from '@oclif/core'
 import { AuthCommand } from './authCommand'
 import { parseProject } from '../services/project-parser'
@@ -14,7 +15,6 @@ import {
 import chalk from 'chalk'
 import { splitConfigFilePath, getGitInformation } from '../services/util'
 import commonMessages from '../messages/common-messages'
-import { forceFlag } from '../helpers/flags'
 import { ProjectDeployResponse } from '../rest/projects'
 import { uploadSnapshots } from '../services/snapshot-service'
 import { BrowserCheckBundle } from '../constructs/browser-check-bundle'
@@ -45,12 +45,21 @@ export default class Deploy extends AuthCommand {
       description: 'Shows the changes made after the deploy command.',
       default: false,
     }),
+    'verbose': Flags.boolean({
+      char: 'v',
+      description: 'Show resource names and IDs in the deploy output.',
+      default: false,
+    }),
     'schedule-on-deploy': Flags.boolean({
       description: 'Enables automatic check scheduling after a deploy.',
       default: true,
       allowNo: true,
     }),
-    'force': forceFlag(),
+    'force': Flags.boolean({
+      char: 'f',
+      description: commonMessages.forceMode,
+      default: false,
+    }),
     'config': Flags.string({
       char: 'c',
       description: commonMessages.configFile,
@@ -74,45 +83,26 @@ export default class Deploy extends AuthCommand {
   }
 
   async run (): Promise<void> {
+    this.style.actionStart('Parsing your project')
     const { flags } = await this.parse(Deploy)
     const {
       force,
       preview,
       'schedule-on-deploy': scheduleOnDeploy,
-      output,
+      output: outputFlag,
+      verbose,
       config: configFilename,
       'verify-runtime-dependencies': verifyRuntimeDependencies,
       'debug-bundle': debugBundle,
       'debug-bundle-output-file': debugBundleOutputFile,
     } = flags
+    const output = outputFlag || verbose
     const { configDirectory, configFilenames } = splitConfigFilePath(configFilename)
     const {
       config: checklyConfig,
       constructs: checklyConfigConstructs,
     } = await loadChecklyConfig(configDirectory, configFilenames)
     const account = this.account
-
-    if (!preview) {
-      await this.confirmOrAbort({
-        command: 'deploy',
-        description: 'Deploy project to Checkly',
-        changes: [
-          `Deploy project "${checklyConfig.projectName}" to account "${account.name}"`,
-          scheduleOnDeploy
-            ? 'Schedule checks after deploy'
-            : 'Checks will NOT be scheduled after deploy',
-        ],
-        flags,
-        classification: {
-          readOnly: Deploy.readOnly,
-          destructive: Deploy.destructive,
-          idempotent: Deploy.idempotent,
-        },
-      }, { force })
-    }
-
-    this.style.actionStart('Parsing your project')
-
     const availableRuntimes = await api.runtimes.getAll()
     const project = await parseProject({
       directory: configDirectory,
@@ -231,10 +221,21 @@ export default class Deploy extends AuthCommand {
       return
     }
 
+    if (!force && !preview) {
+      const { confirm } = await prompts({
+        name: 'confirm',
+        type: 'confirm',
+        message: `You are about to deploy your project "${project.name}" to account "${account.name}". Do you want to continue?`,
+      })
+      if (!confirm) {
+        return
+      }
+    }
+
     try {
       const { data } = await api.projects.deploy({ ...projectPayload, repoInfo }, { dryRun: preview, scheduleOnDeploy })
       if (preview || output) {
-        this.log(this.formatPreview(data, project))
+        this.log(this.formatPreview(data, project, verbose))
       }
       if (!preview) {
         await setTimeout(500)
@@ -256,15 +257,15 @@ export default class Deploy extends AuthCommand {
     }
   }
 
-  private formatPreview (previewData: ProjectDeployResponse, project: Project): string {
+  private formatPreview (previewData: ProjectDeployResponse, project: Project, verbose = false): string {
     // Current format of the data is: { checks: { logical-id-1: 'UPDATE' }, groups: { another-logical-id: 'CREATE' } }
     // We convert it into update: [{ logicalId, resourceType, construct }, ...], create: [], delete: []
     // This makes it easier to display.
     const updating = []
     const creating = []
     const deleting: Array<{ resourceType: string, logicalId: string }> = []
     for (const change of previewData?.diff ?? []) {
-      const { type, logicalId, action } = change
+      const { type, logicalId, physicalId, action } = change
       if ([
         AlertChannelSubscription.__checklyType,
         PrivateLocationCheckAssignment.__checklyType,
@@ -276,9 +277,9 @@ export default class Deploy extends AuthCommand {
       }
       const construct = project.data[type as keyof ProjectData][logicalId]
       if (action === ResourceDeployStatus.UPDATE) {
-        updating.push({ resourceType: type, logicalId, construct })
+        updating.push({ resourceType: type, logicalId, physicalId, construct })
       } else if (action === ResourceDeployStatus.CREATE) {
-        creating.push({ resourceType: type, logicalId, construct })
+        creating.push({ resourceType: type, logicalId, physicalId, construct })
       } else if (action === ResourceDeployStatus.DELETE) {
         // Since the resource is being deleted, the construct isn't in the project.
         deleting.push({ resourceType: type, logicalId })
@@ -331,8 +332,14 @@ export default class Deploy extends AuthCommand {
 
     if (sortedCreating.filter(({ construct }) => Boolean(construct)).length) {
       output.push(chalk.bold.green('Create:'))
-      for (const { logicalId, construct } of sortedCreating) {
+      for (const { logicalId, physicalId, construct } of sortedCreating) {
         output.push(`    ${construct.constructor.name}: ${logicalId}`)
+        if (verbose && (construct as any).name) {
+          output.push(`      name: ${(construct as any).name}`)
+        }
+        if (verbose && physicalId) {
+          output.push(`      id: ${physicalId}`)
+        }
       }
       output.push('')
     }
@@ -353,8 +360,14 @@ export default class Deploy extends AuthCommand {
     }
     if (sortedUpdating.length) {
       output.push(chalk.bold.magenta('Update and Unchanged:'))
-      for (const { logicalId, construct } of sortedUpdating) {
+      for (const { logicalId, physicalId, construct } of sortedUpdating) {
         output.push(`    ${construct.constructor.name}: ${logicalId}`)
+        if (verbose && (construct as any).name) {
+          output.push(`      name: ${(construct as any).name}`)
+        }
+        if (verbose && physicalId) {
+          output.push(`      id: ${physicalId}`)
+        }
       }
       output.push('')
     }