feat(cli): logging can be corked

packages/aws-cdk/lib/cdk-toolkit.ts

@@ -17,7 +17,7 @@ import { CloudWatchLogEventMonitor } from './api/logs/logs-monitor';
 import { StackActivityProgress } from './api/util/cloudformation/stack-activity-monitor';
 import { printSecurityDiff, printStackDiff, RequireApproval } from './diff';
 import { ResourceImporter } from './import';
-import { data, debug, error, highlight, print, success, warning } from './logging';
+import { data, debug, error, highlight, print, success, warning, LOG_LOCK } from './logging';
 import { deserializeStructure, serializeStructure } from './serialize';
 import { Configuration, PROJECT_CONFIG } from './settings';
 import { numberFromBool, partition } from './util';
@@ -238,6 +238,8 @@ export class CdkToolkit {
       if (requireApproval !== RequireApproval.Never) {
         const currentTemplate = await this.props.deployments.readCurrentTemplate(stack);
         if (printSecurityDiff(currentTemplate, stack, requireApproval)) {
+          // Lock the logger from logging temporarily
+          LOG_LOCK[0] = true;
 
           // only talk to user if STDIN is a terminal (otherwise, fail)
           if (!process.stdin.isTTY) {
@@ -254,6 +256,11 @@ export class CdkToolkit {
           }
 
           const confirmed = await promptly.confirm('Do you wish to deploy these changes (y/n)?');
+
+          LOG_LOCK[0] = false;
+          // Calls the logger and prints any logs that happened during the lock
+          print(''); 
+
           if (!confirmed) { throw new Error('Aborted by user'); }
         }
       }

packages/aws-cdk/lib/logging.ts

@@ -7,6 +7,11 @@ const { stdout, stderr } = process;
 
 type WritableFactory = () => Writable;
 
+// LOG_LOCK is an array rather than a boolean because it needs to be modified by other
+// parts of the CLI and imported variables are always immutable.
+export const LOG_LOCK = [false];
+const logBuffer: string[] = [];
+
 const logger = (stream: Writable | WritableFactory, styles?: StyleFn[], timestamp?: boolean) => (fmt: string, ...args: unknown[]) => {
   const ts = timestamp ? `[${formatTime(new Date())}] ` : '';
 
@@ -15,8 +20,18 @@ const logger = (stream: Writable | WritableFactory, styles?: StyleFn[], timestam
     str = styles.reduce((a, style) => style(a), str);
   }
 
+  // Logger is currently locked, so we store the message to be printed
+  // later when we are unlocked.
+  if (LOG_LOCK[0]) {
+    logBuffer.push(str);
+    return;
+  }
 
   const realStream = typeof stream === 'function' ? stream() : stream;
+  if (logBuffer.length > 0) {
+    logBuffer.forEach((l) => realStream.write(l + '\n'));
+    logBuffer.splice(0);
+  }
   realStream.write(str + '\n');
 };
 

packages/cdk-assets/lib/publishing.ts

@@ -82,9 +82,6 @@ export class AssetPublishing implements IPublishProgress {
   private readonly publishInParallel: boolean;
   private readonly buildAssets: boolean;
   private readonly publishAssets: boolean;
-  private readonly startMessagePrefix: string;
-  private readonly successMessagePrefix: string;
-  private readonly errorMessagePrefix: string;
   private readonly handlerCache = new Map<IManifestEntry, IAssetHandler>();
 
   constructor(private readonly manifest: AssetManifest, private readonly options: AssetPublishingOptions) {
@@ -94,34 +91,6 @@ export class AssetPublishing implements IPublishProgress {
     this.buildAssets = options.buildAssets ?? true;
     this.publishAssets = options.publishAssets ?? true;
 
-    const getMessages = () => {
-      if (this.buildAssets && this.publishAssets) {
-        return {
-          startMessagePrefix: 'Building and publishing',
-          successMessagePrefix: 'Built and published',
-          errorMessagePrefix: 'Error building and publishing',
-        };
-      } else if (this.buildAssets) {
-        return {
-          startMessagePrefix: 'Building',
-          successMessagePrefix: 'Built',
-          errorMessagePrefix: 'Error building',
-        };
-      } else {
-        return {
-          startMessagePrefix: 'Publishing',
-          successMessagePrefix: 'Published',
-          errorMessagePrefix: 'Error publishing',
-        };
-      }
-    };
-
-    const messages = getMessages();
-
-    this.startMessagePrefix = messages.startMessagePrefix;
-    this.successMessagePrefix = messages.successMessagePrefix;
-    this.errorMessagePrefix = messages.errorMessagePrefix;
-
     const self = this;
     this.handlerHost = {
       aws: this.options.aws,
@@ -146,7 +115,7 @@ export class AssetPublishing implements IPublishProgress {
     }
 
     if ((this.options.throwOnError ?? true) && this.failures.length > 0) {
-      throw new Error(`${this.errorMessagePrefix}: ${this.failures.map(e => e.error.message)}`);
+      throw new Error(`Error publishing: ${this.failures.map(e => e.error.message)}`);
     }
   }
 
@@ -155,14 +124,17 @@ export class AssetPublishing implements IPublishProgress {
    */
   public async buildEntry(asset: IManifestEntry) {
     try {
-      if (this.progressEvent(EventType.START, `${this.startMessagePrefix} ${asset.id}`)) { return false; }
+      if (this.progressEvent(EventType.START, `Building ${asset.id}`)) { return false; }
 
       const handler = this.assetHandler(asset);
       await handler.build();
 
       if (this.aborted) {
         throw new Error('Aborted');
       }
+
+      this.completedOperations++;
+      if (this.progressEvent(EventType.SUCCESS, `Built ${asset.id}`)) { return false; }
     } catch (e: any) {
       this.failures.push({ asset, error: e });
       this.completedOperations++;
@@ -177,7 +149,7 @@ export class AssetPublishing implements IPublishProgress {
    */
   public async publishEntry(asset: IManifestEntry) {
     try {
-      if (this.progressEvent(EventType.UPLOAD, `${this.startMessagePrefix} ${asset.id}`)) { return false; }
+      if (this.progressEvent(EventType.START, `Publishing ${asset.id}`)) { return false; }
 
       const handler = this.assetHandler(asset);
       await handler.publish();
@@ -187,7 +159,7 @@ export class AssetPublishing implements IPublishProgress {
       }
 
       this.completedOperations++;
-      if (this.progressEvent(EventType.SUCCESS, `${this.successMessagePrefix} ${asset.id}`)) { return false; }
+      if (this.progressEvent(EventType.SUCCESS, `Published ${asset.id}`)) { return false; }
     } catch (e: any) {
       this.failures.push({ asset, error: e });
       this.completedOperations++;
@@ -212,7 +184,7 @@ export class AssetPublishing implements IPublishProgress {
    */
   private async publishAsset(asset: IManifestEntry) {
     try {
-      if (this.progressEvent(EventType.START, `${this.startMessagePrefix} ${asset.id}`)) { return false; }
+      if (this.progressEvent(EventType.START, `Publishing ${asset.id}`)) { return false; }
 
       const handler = this.assetHandler(asset);
 
@@ -229,7 +201,7 @@ export class AssetPublishing implements IPublishProgress {
       }
 
       this.completedOperations++;
-      if (this.progressEvent(EventType.SUCCESS, `${this.successMessagePrefix} ${asset.id}`)) { return false; }
+      if (this.progressEvent(EventType.SUCCESS, `Published ${asset.id}`)) { return false; }
     } catch (e: any) {
       this.failures.push({ asset, error: e });
       this.completedOperations++;