feat(cli): add message when resource is hotswapped (#18058)

Add additional messages to indicate that a hotswap deployment is
occurring (or not) along with what resources are being hotswapped.

fix #17778


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: corymhall

packages/aws-cdk/lib/api/deploy-stack.ts

@@ -10,6 +10,7 @@ import { publishAssets } from '../util/asset-publishing';
 import { contentHash } from '../util/content-hash';
 import { ISDK, SdkProvider } from './aws-auth';
 import { tryHotswapDeployment } from './hotswap-deployments';
+import { ICON } from './hotswap/common';
 import { CfnEvaluationException } from './hotswap/evaluate-cloudformation-template';
 import { ToolkitInfo } from './toolkit-info';
 import {
@@ -231,6 +232,11 @@ export async function deployStack(options: DeployStackOptions): Promise<DeploySt
 
   if (await canSkipDeploy(options, cloudFormationStack, stackParams.hasChanges(cloudFormationStack.parameters))) {
     debug(`${deployName}: skipping deployment (use --force to override)`);
+    // if we can skip deployment and we are performing a hotswap, let the user know
+    // that no hotswap deployment happened
+    if (options.hotswap) {
+      print(`\n ${ICON} %s\n`, colors.bold('hotswap deployment skipped - no changes were detected (use --force to override)'));
+    }
     return {
       noOp: true,
       outputs: cloudFormationStack.outputs,

packages/aws-cdk/lib/api/hotswap-deployments.ts

@@ -1,9 +1,11 @@
 import * as cfn_diff from '@aws-cdk/cloudformation-diff';
 import * as cxapi from '@aws-cdk/cx-api';
 import { CloudFormation } from 'aws-sdk';
+import * as colors from 'colors/safe';
+import { print } from '../logging';
 import { ISDK, Mode, SdkProvider } from './aws-auth';
 import { DeployStackResult } from './deploy-stack';
-import { ChangeHotswapImpact, ChangeHotswapResult, HotswapOperation, HotswappableChangeCandidate, ListStackResources } from './hotswap/common';
+import { ICON, ChangeHotswapImpact, ChangeHotswapResult, HotswapOperation, HotswappableChangeCandidate, ListStackResources } from './hotswap/common';
 import { isHotswappableEcsServiceChange } from './hotswap/ecs-services';
 import { EvaluateCloudFormationTemplate } from './hotswap/evaluate-cloudformation-template';
 import { isHotswappableLambdaFunctionChange } from './hotswap/lambda-functions';
@@ -139,6 +141,7 @@ export function isCandidateForHotswapping(change: cfn_diff.ResourceDifference):
 async function applyAllHotswappableChanges(
   sdk: ISDK, hotswappableChanges: HotswapOperation[],
 ): Promise<void[]> {
+  print(`\n${ICON} hotswapping resources:`);
   return Promise.all(hotswappableChanges.map(hotswapOperation => {
     return applyHotswappableChange(sdk, hotswapOperation);
   }));
@@ -150,8 +153,14 @@ async function applyHotswappableChange(sdk: ISDK, hotswapOperation: HotswapOpera
   sdk.appendCustomUserAgent(customUserAgent);
 
   try {
+    for (const name of hotswapOperation.resourceNames) {
+      print(`   ${ICON} hotswapping ${hotswapOperation.service}: %s`, colors.bold(name));
+    }
     return await hotswapOperation.apply(sdk);
   } finally {
+    for (const name of hotswapOperation.resourceNames) {
+      print(`${ICON} ${hotswapOperation.service}: %s %s`, colors.bold(name), colors.green('hotswapped!'));
+    }
     sdk.removeCustomUserAgent(customUserAgent);
   }
 }

packages/aws-cdk/lib/api/hotswap/common.ts

@@ -3,6 +3,7 @@ import { CloudFormation } from 'aws-sdk';
 import { ISDK } from '../aws-auth';
 import { CfnEvaluationException, EvaluateCloudFormationTemplate } from './evaluate-cloudformation-template';
 
+export const ICON = '✨';
 export interface ListStackResources {
   listStackResources(): Promise<CloudFormation.StackResourceSummary[]>;
 }
@@ -17,6 +18,11 @@ export interface HotswapOperation {
    */
   readonly service: string;
 
+  /**
+   * The names of the resources being hotswapped.
+   */
+  readonly resourceNames: string[];
+
   apply(sdk: ISDK): Promise<any>;
 }
 

packages/aws-cdk/lib/api/hotswap/ecs-services.ts

@@ -77,11 +77,14 @@ interface EcsService {
 
 class EcsServiceHotswapOperation implements HotswapOperation {
   public readonly service = 'ecs-service';
+  public readonly resourceNames: string[] = [];
 
   constructor(
     private readonly taskDefinitionResource: any,
     private readonly servicesReferencingTaskDef: EcsService[],
-  ) {}
+  ) {
+    this.resourceNames = servicesReferencingTaskDef.map(ecsService => ecsService.serviceArn.split('/')[2]);
+  }
 
   public async apply(sdk: ISDK): Promise<any> {
     // Step 1 - update the changed TaskDefinition, creating a new TaskDefinition Revision

packages/aws-cdk/lib/api/hotswap/lambda-functions.ts

@@ -153,8 +153,10 @@ interface LambdaFunctionResource {
 
 class LambdaFunctionHotswapOperation implements HotswapOperation {
   public readonly service = 'lambda-function';
+  public readonly resourceNames: string[];
 
   constructor(private readonly lambdaFunctionResource: LambdaFunctionResource) {
+    this.resourceNames = [lambdaFunctionResource.physicalName];
   }
 
   public async apply(sdk: ISDK): Promise<any> {

packages/aws-cdk/lib/api/hotswap/s3-bucket-deployments.ts

@@ -37,8 +37,10 @@ export async function isHotswappableS3BucketDeploymentChange(
 
 class S3BucketDeploymentHotswapOperation implements HotswapOperation {
   public readonly service = 'custom-s3-deployment';
+  public readonly resourceNames: string[];
 
   constructor(private readonly functionName: string, private readonly customResourceProperties: any) {
+    this.resourceNames = [this.customResourceProperties.DestinationBucketName];
   }
 
   public async apply(sdk: ISDK): Promise<any> {
@@ -116,6 +118,7 @@ function stringifyObject(obj: any): any {
 
 class EmptyHotswapOperation implements HotswapOperation {
   readonly service = 'empty';
+  public readonly resourceNames = [];
   public async apply(sdk: ISDK): Promise<any> {
     return Promise.resolve(sdk);
   }

packages/aws-cdk/lib/api/hotswap/stepfunctions-state-machines.ts

@@ -54,8 +54,10 @@ interface StateMachineResource {
 
 class StateMachineHotswapOperation implements HotswapOperation {
   public readonly service = 'stepfunctions-state-machine';
+  public readonly resourceNames: string[];
 
   constructor(private readonly stepFunctionResource: StateMachineResource) {
+    this.resourceNames = [this.stepFunctionResource.stateMachineArn.split(':')[6]];
   }
 
   public async apply(sdk: ISDK): Promise<any> {