refactor(cli): make the cli use more shared code

mrgrain · mrgrain · commit 9c39e7f06c47 · 2025-03-07T11:51:15.000Z
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -725,6 +725,8 @@ tmpToolkitHelpers.eslint?.addRules({
   '@typescript-eslint/consistent-type-imports': 'error',
 });
 
+tmpToolkitHelpers.gitignore.addPatterns('test/**/*.map');
+
 //////////////////////////////////////////////////////////////////////
 
 let CLI_SDK_VERSION: '2' | '3' = ('3' as any);
diff --git a/packages/@aws-cdk/tmp-toolkit-helpers/.gitignore b/packages/@aws-cdk/tmp-toolkit-helpers/.gitignore
diff --git a/packages/@aws-cdk/tmp-toolkit-helpers/src/api/io/private/action-aware.ts b/packages/@aws-cdk/tmp-toolkit-helpers/src/api/io/private/action-aware.ts
@@ -11,6 +11,7 @@ export type ActionLessRequest<T, U> = Omit<IoRequest<T, U>, 'action'>;
  * Helper type for IoHosts that are action aware
  */
 export interface ActionAwareIoHost extends IIoHost {
+  action: ToolkitAction;
   notify<T>(msg: ActionLessMessage<T>): Promise<void>;
   requestResponse<T, U>(msg: ActionLessRequest<T, U>): Promise<U>;
 }
@@ -21,6 +22,7 @@ export interface ActionAwareIoHost extends IIoHost {
  */
 export function withAction(ioHost: IIoHost, action: ToolkitAction): ActionAwareIoHost {
   return {
+    action,
     notify: async <T>(msg: Omit<IoMessage<T>, 'action'>) => {
       await ioHost.notify({
         ...msg,
diff --git a/packages/@aws-cdk/tmp-toolkit-helpers/src/api/io/private/index.ts b/packages/@aws-cdk/tmp-toolkit-helpers/src/api/io/private/index.ts
@@ -1,3 +1,4 @@
 export * from './action-aware';
+export * from './level-priority';
 export * from './message-maker';
 export * from './types';
diff --git a/packages/@aws-cdk/tmp-toolkit-helpers/src/api/io/private/level-priority.ts b/packages/@aws-cdk/tmp-toolkit-helpers/src/api/io/private/level-priority.ts
diff --git a/packages/@aws-cdk/tmp-toolkit-helpers/test/api/io/io-message.test.ts b/packages/@aws-cdk/tmp-toolkit-helpers/test/api/io/io-message.test.ts
@@ -1,4 +1,4 @@
-import { isMessageRelevantForLevel } from '../../../lib/api/io/private/level-priority';
+import { isMessageRelevantForLevel } from '../../../src/api/io/private/level-priority';
 
 describe('IoMessageLevel', () => {
   test.each`
diff --git a/packages/@aws-cdk/toolkit-lib/test/_helpers/test-io-host.ts b/packages/@aws-cdk/toolkit-lib/test/_helpers/test-io-host.ts
@@ -1,6 +1,6 @@
 import type { IIoHost, IoMessage, IoMessageLevel, IoRequest } from '../../lib';
 import { RequireApproval } from '../../lib';
-import { isMessageRelevantForLevel } from '../../lib/api/io/private/level-priority';
+import { isMessageRelevantForLevel } from '../../lib/api/shared-private';
 
 /**
  * A test implementation of IIoHost that does nothing but can by spied on.
diff --git a/packages/@aws-cdk/toolkit-lib/test/api/io/io-message.test.d.ts.map b/packages/@aws-cdk/toolkit-lib/test/api/io/io-message.test.d.ts.map
diff --git a/packages/aws-cdk/lib/api/deployments/asset-publishing.ts b/packages/aws-cdk/lib/api/deployments/asset-publishing.ts
@@ -14,7 +14,7 @@ import {
 } from 'cdk-assets';
 import type { SDK } from '..';
 import { formatMessage } from '../../cli/messages';
-import { IIoHost, IoMessageLevel, IoMessaging, ToolkitAction } from '../../toolkit/cli-io-host';
+import { IIoHost, IoMessageLevel, IoMessaging } from '../../toolkit/cli-io-host';
 import { ToolkitError } from '../../toolkit/error';
 import type { SdkProvider } from '../aws-auth';
 import { Mode } from '../plugin';
@@ -184,7 +184,7 @@ export const EVENT_TO_LEVEL: Record<EventType, IoMessageLevel | false> = {
 
 export abstract class BasePublishProgressListener implements IPublishProgressListener {
   protected readonly ioHost: IIoHost;
-  protected readonly action: ToolkitAction;
+  protected readonly action: IoMessaging['action'];
 
   constructor({ ioHost, action }: IoMessaging) {
     this.ioHost = ioHost;
diff --git a/packages/aws-cdk/lib/api/deployments/deploy-stack.ts b/packages/aws-cdk/lib/api/deployments/deploy-stack.ts
@@ -29,7 +29,7 @@ import { ChangeSetDeploymentMethod, DeploymentMethod } from './deployment-method
 import { DeployStackResult, SuccessfulDeployStackResult } from './deployment-result';
 import { tryHotswapDeployment } from './hotswap-deployments';
 import { debug, info, warn } from '../../cli/messages';
-import { IIoHost, IoMessaging, ToolkitAction } from '../../toolkit/cli-io-host';
+import { IIoHost, IoMessaging } from '../../toolkit/cli-io-host';
 import { ToolkitError } from '../../toolkit/error';
 import { formatErrorMessage } from '../../util';
 import type { SDK, SdkProvider, ICloudFormationClient } from '../aws-auth';
@@ -368,7 +368,7 @@ class FullCloudFormationDeployment {
     private readonly stackParams: ParameterValues,
     private readonly bodyParameter: TemplateBodyParameter,
     private readonly ioHost: IIoHost,
-    private readonly action: ToolkitAction,
+    private readonly action: IoMessaging['action'],
   ) {
     this.cfn = options.sdk.cloudFormation();
     this.stackName = options.deployName ?? stackArtifact.stackName;
diff --git a/packages/aws-cdk/lib/api/deployments/deployments.ts b/packages/aws-cdk/lib/api/deployments/deployments.ts
@@ -25,7 +25,7 @@ import {
   type RootTemplateWithNestedStacks,
 } from './nested-stack-helpers';
 import { debug, warn } from '../../cli/messages';
-import { IIoHost, IoMessaging, ToolkitAction } from '../../toolkit/cli-io-host';
+import { IIoHost, IoMessaging } from '../../toolkit/cli-io-host';
 import { ToolkitError } from '../../toolkit/error';
 import { formatErrorMessage } from '../../util';
 import type { SdkProvider } from '../aws-auth/sdk-provider';
@@ -290,7 +290,7 @@ export interface DeploymentsProps {
   readonly sdkProvider: SdkProvider;
   readonly toolkitStackName?: string;
   readonly ioHost: IIoHost;
-  readonly action: ToolkitAction;
+  readonly action: IoMessaging['action'];
 }
 
 /**
@@ -326,7 +326,7 @@ export class Deployments {
   private _allowCrossAccountAssetPublishing: boolean | undefined;
 
   private readonly ioHost: IIoHost;
-  private readonly action: ToolkitAction;
+  private readonly action: IoMessaging['action'];
 
   constructor(private readonly props: DeploymentsProps) {
     this.assetSdkProvider = props.sdkProvider;
diff --git a/packages/aws-cdk/lib/api/resource-import/importer.ts b/packages/aws-cdk/lib/api/resource-import/importer.ts
@@ -5,16 +5,17 @@ import * as cxapi from '@aws-cdk/cx-api';
 import * as chalk from 'chalk';
 import * as fs from 'fs-extra';
 import * as promptly from 'promptly';
+import { ActionAwareIoHost, withAction } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
 import { error, info, warn } from '../../cli/messages';
-import { IIoHost, ToolkitAction } from '../../toolkit/cli-io-host';
+import type { IIoHost, IoMessaging } from '../../toolkit/cli-io-host';
 import { ToolkitError } from '../../toolkit/error';
 import { assertIsSuccessfulDeployStackResult, type Deployments, DeploymentMethod, ResourceIdentifierProperties, ResourcesToImport } from '../deployments';
 import type { Tag } from '../tags';
 
 export interface ResourceImporterProps {
   deployments: Deployments;
   ioHost: IIoHost;
-  action: ToolkitAction;
+  action: IoMessaging['action'];
 }
 
 export interface ImportDeploymentOptions {
@@ -102,17 +103,15 @@ export class ResourceImporter {
 
   private readonly stack: cxapi.CloudFormationStackArtifact;
   private readonly cfn: Deployments;
-  private readonly ioHost: IIoHost;
-  private readonly action: ToolkitAction;
+  private readonly ioHost: ActionAwareIoHost;
 
   constructor(
     stack: cxapi.CloudFormationStackArtifact,
     props: ResourceImporterProps,
   ) {
     this.stack = stack;
     this.cfn = props.deployments;
-    this.ioHost = props.ioHost;
-    this.action = props.action;
+    this.ioHost = withAction(props.ioHost, props.action as any);
   }
 
   /**
@@ -146,19 +145,19 @@ export class ResourceImporter {
       const descr = this.describeResource(resource.logicalId);
       const idProps = contents[resource.logicalId];
       if (idProps) {
-        await this.ioHost.notify(info(this.action, format('%s: importing using %s', chalk.blue(descr), chalk.blue(fmtdict(idProps)))));
+        await this.ioHost.notify(info(this.ioHost.action, format('%s: importing using %s', chalk.blue(descr), chalk.blue(fmtdict(idProps)))));
 
         ret.importResources.push(resource);
         ret.resourceMap[resource.logicalId] = idProps;
         delete contents[resource.logicalId];
       } else {
-        await this.ioHost.notify(info(this.action, format('%s: skipping', chalk.blue(descr))));
+        await this.ioHost.notify(info(this.ioHost.action, format('%s: skipping', chalk.blue(descr))));
       }
     }
 
     const unknown = Object.keys(contents);
     if (unknown.length > 0) {
-      await this.ioHost.notify(warn(this.action, `Unrecognized resource identifiers in mapping file: ${unknown.join(', ')}`));
+      await this.ioHost.notify(warn(this.ioHost.action, `Unrecognized resource identifiers in mapping file: ${unknown.join(', ')}`));
     }
 
     return ret;
@@ -208,9 +207,9 @@ export class ResourceImporter {
         ? ' ✅  %s (no changes)'
         : ' ✅  %s';
 
-      await this.ioHost.notify(info(this.action, '\n' + chalk.green(format(message, this.stack.displayName))));
+      await this.ioHost.notify(info(this.ioHost.action, '\n' + chalk.green(format(message, this.stack.displayName))));
     } catch (e) {
-      await this.ioHost.notify(error(this.action, format('\n ❌  %s failed: %s', chalk.bold(this.stack.displayName), e), 'CDK_TOOLKIT_E3900'));
+      await this.ioHost.notify(error(this.ioHost.action, format('\n ❌  %s failed: %s', chalk.bold(this.stack.displayName), e), 'CDK_TOOLKIT_E3900'));
       throw e;
     }
   }
@@ -239,7 +238,7 @@ export class ResourceImporter {
       const offendingResources = nonAdditions.map(([logId, _]) => this.describeResource(logId));
 
       if (allowNonAdditions) {
-        await this.ioHost.notify(warn(this.action, `Ignoring updated/deleted resources (--force): ${offendingResources.join(', ')}`));
+        await this.ioHost.notify(warn(this.ioHost.action, `Ignoring updated/deleted resources (--force): ${offendingResources.join(', ')}`));
       } else {
         throw new ToolkitError('No resource updates or deletes are allowed on import operation. Make sure to resolve pending changes ' +
           `to existing resources, before attempting an import. Updated/deleted resources: ${offendingResources.join(', ')} (--force to override)`);
@@ -327,7 +326,7 @@ export class ResourceImporter {
     // Skip resources that do not support importing
     const resourceType = chg.resourceDiff.newResourceType;
     if (resourceType === undefined || !(resourceType in resourceIdentifiers)) {
-      await this.ioHost.notify(warn(this.action, `${resourceName}: unsupported resource type ${resourceType}, skipping import.`));
+      await this.ioHost.notify(warn(this.ioHost.action, `${resourceName}: unsupported resource type ${resourceType}, skipping import.`));
       return undefined;
     }
 
@@ -353,7 +352,7 @@ export class ResourceImporter {
 
     // If we got here and the user rejected any available identifiers, then apparently they don't want the resource at all
     if (satisfiedPropSets.length > 0) {
-      await this.ioHost.notify(info(this.action, chalk.grey(`Skipping import of ${resourceName}`)));
+      await this.ioHost.notify(info(this.ioHost.action, chalk.grey(`Skipping import of ${resourceName}`)));
       return undefined;
     }
 
@@ -371,7 +370,7 @@ export class ResourceImporter {
 
     // Do the input loop here
     if (preamble) {
-      await this.ioHost.notify(info(this.action, preamble));
+      await this.ioHost.notify(info(this.ioHost.action, preamble));
     }
     for (const idProps of idPropSets) {
       const input: Record<string, string> = {};
@@ -406,7 +405,7 @@ export class ResourceImporter {
       }
     }
 
-    await this.ioHost.notify(info(this.action, chalk.grey(`Skipping import of ${resourceName}`)));
+    await this.ioHost.notify(info(this.ioHost.action, chalk.grey(`Skipping import of ${resourceName}`)));
     return undefined;
   }
 
diff --git a/packages/aws-cdk/lib/api/resource-import/migrator.ts b/packages/aws-cdk/lib/api/resource-import/migrator.ts
@@ -3,21 +3,21 @@ import * as chalk from 'chalk';
 import * as fs from 'fs-extra';
 import { ImportDeploymentOptions, ResourceImporter } from './importer';
 import { info } from '../../cli/messages';
-import type { IIoHost, ToolkitAction } from '../../toolkit/cli-io-host';
+import type { IIoHost, IoMessaging } from '../../toolkit/cli-io-host';
 import { formatTime } from '../../util';
 import { StackCollection } from '../cxapp/cloud-assembly';
 import type { Deployments, ResourcesToImport } from '../deployments';
 
 export interface ResourceMigratorProps {
   deployments: Deployments;
   ioHost: IIoHost;
-  action: ToolkitAction;
+  action: IoMessaging['action'];
 }
 
 export class ResourceMigrator {
   private readonly props: ResourceMigratorProps;
   private readonly ioHost: IIoHost;
-  private readonly action: ToolkitAction;
+  private readonly action: IoMessaging['action'];
 
   public constructor(props: ResourceMigratorProps) {
     this.props = props;
diff --git a/packages/aws-cdk/lib/cli/cli.ts b/packages/aws-cdk/lib/cli/cli.ts
@@ -78,7 +78,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
     debug(`Error while checking for platform warnings: ${e}`);
   }
 
-  debug('CDK toolkit version:', version.displayVersion());
+  debug('CDK Toolkit CLI version:', version.displayVersion());
   debug('Command line arguments:', argv);
 
   const configuration = new Configuration({
diff --git a/packages/aws-cdk/lib/cli/messages.ts b/packages/aws-cdk/lib/cli/messages.ts
@@ -2,10 +2,11 @@
 // The CLI cannot depend on the toolkit yet, because the toolkit currently depends on the CLI.
 // Once we have complete the repo split, we will create a temporary, private library package
 // for all code that is shared between CLI and toolkit. This is where this file will then live.
-import { IoMessage, IoMessageCode, IoMessageCodeCategory, IoMessageLevel, ToolkitAction } from '../toolkit/cli-io-host';
+import type { IoMessageCodeCategory } from '../logging';
+import type { IoMessage, IoMessageCode, IoMessageLevel, IoMessaging } from '../toolkit/cli-io-host';
 
 type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
-type SimplifiedMessage<T> = Omit<IoMessage<T>, 'time'>;
+type SimplifiedMessage<T> = Omit<IoMessage<T>, 'time' | 'action'> & { action: IoMessaging['action'] };
 
 /**
  * Internal helper that processes log inputs into a consistent format.
@@ -16,7 +17,7 @@ export function formatMessage<T>(msg: Optional<SimplifiedMessage<T>, 'code'>, ca
   return {
     time: new Date(),
     level: msg.level,
-    action: msg.action,
+    action: msg.action as any,
     code: msg.code ?? defaultMessageCode(msg.level, category),
     message: msg.message,
     data: msg.data,
@@ -38,7 +39,7 @@ function defaultMessageCode(level: IoMessageLevel, category: IoMessageCodeCatego
  * Creates an error level message.
  * Errors must always have a unique code.
  */
-export const error = <T>(action: ToolkitAction, message: string, code: IoMessageCode, payload?: T) => {
+export const error = <T>(action: IoMessaging['action'], message: string, code: IoMessageCode, payload?: T) => {
   return formatMessage({
     level: 'error',
     action,
@@ -55,7 +56,7 @@ export const error = <T>(action: ToolkitAction, message: string, code: IoMessage
  * However actions that operate on Cloud Assemblies might include a result per Stack.
  * Unlike other messages, results must always have a code and a payload.
  */
-export const result = <T>(action: ToolkitAction, message: string, code: IoMessageCode, payload: T) => {
+export const result = <T>(action: IoMessaging['action'], message: string, code: IoMessageCode, payload: T) => {
   return formatMessage({
     level: 'result',
     action,
@@ -68,7 +69,7 @@ export const result = <T>(action: ToolkitAction, message: string, code: IoMessag
 /**
  * Creates a warning level message.
  */
-export const warn = <T>(action: ToolkitAction, message: string, code?: IoMessageCode, payload?: T) => {
+export const warn = <T>(action: IoMessaging['action'], message: string, code?: IoMessageCode, payload?: T) => {
   return formatMessage({
     level: 'warn',
     action,
@@ -81,7 +82,7 @@ export const warn = <T>(action: ToolkitAction, message: string, code?: IoMessage
 /**
  * Creates an info level message.
  */
-export const info = <T>(action: ToolkitAction, message: string, code?: IoMessageCode, payload?: T) => {
+export const info = <T>(action: IoMessaging['action'], message: string, code?: IoMessageCode, payload?: T) => {
   return formatMessage({
     level: 'info',
     action,
@@ -94,7 +95,7 @@ export const info = <T>(action: ToolkitAction, message: string, code?: IoMessage
 /**
  * Creates a debug level message.
  */
-export const debug = <T>(action: ToolkitAction, message: string, code?: IoMessageCode, payload?: T) => {
+export const debug = <T>(action: IoMessaging['action'], message: string, code?: IoMessageCode, payload?: T) => {
   return formatMessage({
     level: 'debug',
     action,
@@ -107,7 +108,7 @@ export const debug = <T>(action: ToolkitAction, message: string, code?: IoMessag
 /**
  * Creates a trace level message.
  */
-export const trace = <T>(action: ToolkitAction, message: string, code?: IoMessageCode, payload?: T) => {
+export const trace = <T>(action: IoMessaging['action'], message: string, code?: IoMessageCode, payload?: T) => {
   return formatMessage({
     level: 'trace',
     action,
diff --git a/packages/aws-cdk/lib/logging.ts b/packages/aws-cdk/lib/logging.ts
@@ -1,6 +1,10 @@
 import * as util from 'util';
 import * as chalk from 'chalk';
-import { IoMessageLevel, IoMessage, CliIoHost, IoMessageSpecificCode, IoMessageCode, IoMessageCodeCategory, IoCodeLevel } from './toolkit/cli-io-host';
+import { IoMessageLevel, IoMessage, CliIoHost, IoMessageCode } from './toolkit/cli-io-host';
+
+export type IoMessageCodeCategory = 'TOOLKIT' | 'SDK' | 'ASSETS';
+export type IoCodeLevel = 'E' | 'W' | 'I';
+export type IoMessageSpecificCode<L extends IoCodeLevel> = `CDK_${IoMessageCodeCategory}_${L}${number}${number}${number}${number}`;
 
 /**
  * Internal helper that processes log inputs into a consistent format.
@@ -27,7 +31,7 @@ function formatMessageAndLog(
   const ioHost = CliIoHost.instance();
   const ioMessage: IoMessage<undefined> = {
     time: new Date(),
-    action: ioHost.currentAction,
+    action: ioHost.currentAction as any,
     level,
     message: finalMessage,
     code,
diff --git a/packages/aws-cdk/lib/toolkit/cli-io-host.ts b/packages/aws-cdk/lib/toolkit/cli-io-host.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { isMessageRelevantForLevel } from '../../../lib/api/io/private/level-priority';`
	`1`	`+import { isMessageRelevantForLevel } from '../../../src/api/io/private/level-priority';`
`2`	`2`
`3`	`3`	`describe('IoMessageLevel', () => {`
`4`	`4`	test.each`