fix(toolkit-lib): whitespace is not trimmed from colored messages

packages/@aws-cdk/toolkit-lib/lib/api/io/private/io-host-wrappers.ts

@@ -61,14 +61,37 @@ export function withTrimmedWhitespace(ioHost: IIoHost): IIoHost {
     notify: async <T>(msg: IoMessage<T>) => {
       await ioHost.notify({
         ...msg,
-        message: msg.message.trim(),
+        message: trimWhitespace(msg.message),
       });
     },
     requestResponse: async <T, U>(msg: IoRequest<T, U>) => {
       return ioHost.requestResponse({
         ...msg,
-        message: msg.message.trim(),
+        message: trimWhitespace(msg.message),
       });
     },
   };
 }
+
+/**
+ * Trims whitespace at both ends of a message, also when it sits inside
+ * ANSI style codes (e.g. a colored message that starts with a newline).
+ * The style codes themselves are kept.
+ */
+function trimWhitespace(msg: string): string {
+  // Even indices are text, odd indices are the style codes between them
+  const parts = msg.split(/(\u001b\[[0-9;]*m)/);
+  for (let i = 0; i < parts.length; i += 2) {
+    parts[i] = parts[i].trimStart();
+    if (parts[i]) {
+      break;
+    }
+  }
+  for (let i = parts.length - 1; i >= 0; i -= 2) {
+    parts[i] = parts[i].trimEnd();
+    if (parts[i]) {
+      break;
+    }
+  }
+  return parts.join('');
+}

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

@@ -73,6 +73,23 @@ describe('message formatting', () => {
       message: 'test message',
     }));
   });
+
+  test('whitespace inside color codes is trimmed from a message', async () => {
+    toolkit = new Toolkit({ ioHost });
+
+    await toolkit.ioHost.notify({
+      message: '\u001b[1m\n\u001b[32m test message \u001b[39m\n\u001b[22m',
+      action: 'deploy',
+      level: 'info',
+      code: 'CDK_TOOLKIT_I0000',
+      time: new Date(),
+      data: undefined,
+    });
+
+    expect(ioHost.notifySpy).toHaveBeenCalledWith(expect.objectContaining({
+      message: '\u001b[1m\u001b[32mtest message\u001b[39m\u001b[22m',
+    }));
+  });
 });
 
 test('outputs of assembly are measured', async () => {

packages/aws-cdk/test/commands/__io_snapshots__/destroy/--express_does_not_warn_when_no_resources_are_still_tearing_down.ndjson

@@ -1,4 +1,4 @@
 {"seq":0,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-B: destroying... [1/1]"}
-{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-B: destroyed"}
+{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-B: destroyed"}

packages/aws-cdk/test/commands/__io_snapshots__/destroy/--express_warns_about_resources_still_tearing_down_when_destroyStack_reports_them.ndjson

@@ -1,5 +1,5 @@
 {"seq":0,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-B: destroying... [1/1]"}
-{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-B: destroyed"}
-{"seq":4,"type":"notify","action":"destroy","level":"warn","code":"CDK_TOOLKIT_W7902","message":"⚠️  Stack deleted using Express Mode. Resources still tearing down: MyResource\n"}
+{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-B: destroyed"}
+{"seq":4,"type":"notify","action":"destroy","level":"warn","code":"CDK_TOOLKIT_W7902","message":"⚠️  Stack deleted using Express Mode. Resources still tearing down: MyResource"}

packages/aws-cdk/test/commands/__io_snapshots__/destroy/force_false_confirmation_prompt_asks_for_confirmation_and_proceeds_when_the_user_confirms.ndjson

@@ -2,4 +2,4 @@
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"request","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7010","message":"Are you sure you want to delete: Test-Stack-B","response":true}
 {"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-B: destroying... [1/1]"}
-{"seq":4,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-B: destroyed"}
+{"seq":4,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-B: destroyed"}

packages/aws-cdk/test/commands/__io_snapshots__/destroy/force_true_no_confirmation_prompt_destroys_a_single_nested_stack_fromDeploy_makes_it_say_deployed.ndjson

@@ -1,4 +1,4 @@
 {"seq":0,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"notify","action":"deploy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-A/Test-Stack-C: destroying... [1/1]"}
-{"seq":3,"type":"notify","action":"deploy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-A/Test-Stack-C: deployed"}
+{"seq":3,"type":"notify","action":"deploy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-A/Test-Stack-C: deployed"}

packages/aws-cdk/test/commands/__io_snapshots__/destroy/force_true_no_confirmation_prompt_destroys_all_top-level_stacks_with_concurrency.ndjson

@@ -2,5 +2,5 @@
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-A-Display-Name: destroying... [1/2]"}
 {"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-B: destroying... [2/2]"}
-{"seq":4,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-A-Display-Name: destroyed"}
-{"seq":5,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-B: destroyed"}
+{"seq":4,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-A-Display-Name: destroyed"}
+{"seq":5,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-B: destroyed"}

packages/aws-cdk/test/commands/__io_snapshots__/destroy/force_true_no_confirmation_prompt_forwards_the_roleArn_to_destroyStack.ndjson

@@ -1,4 +1,4 @@
 {"seq":0,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-B: destroying... [1/1]"}
-{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-B: destroyed"}
+{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-B: destroyed"}

packages/aws-cdk/test/commands/__io_snapshots__/destroy/force_true_no_confirmation_prompt_respects_dependency_order_with_concurrency.ndjson

@@ -1,6 +1,6 @@
 {"seq":0,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":1,"type":"notify","action":"destroy","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":2,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-D: destroying... [1/2]"}
-{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-D: destroyed"}
+{"seq":3,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-D: destroyed"}
 {"seq":4,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7100","message":"Test-Stack-C: destroying... [2/2]"}
-{"seq":5,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"\n✅  Test-Stack-C: destroyed"}
+{"seq":5,"type":"notify","action":"destroy","level":"info","code":"CDK_TOOLKIT_I7900","message":"✅  Test-Stack-C: destroyed"}

packages/aws-cdk/test/commands/__io_snapshots__/refactor/--dry-run_detects_a_renamed_resource_without_creating_a_refactor.ndjson

@@ -2,5 +2,5 @@
 {"seq":1,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":2,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":3,"type":"notify","action":"refactor","level":"info","code":"CDK_TOOLKIT_I1000","message":"✨  Synthesis time: <DURATION>"}
-{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1\n"}
-{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬───────────────────────────┬───────────────────────────┐\n│ Resource Type   │ Old Construct Path        │ New Construct Path        │\n├─────────────────┼───────────────────────────┼───────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/OldBucket/Resource │ Stack1/NewBucket/Resource │\n└─────────────────┴───────────────────────────┴───────────────────────────┘\n "}
+{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1"}
+{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬───────────────────────────┬───────────────────────────┐\n│ Resource Type   │ Old Construct Path        │ New Construct Path        │\n├─────────────────┼───────────────────────────┼───────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/OldBucket/Resource │ Stack1/NewBucket/Resource │\n└─────────────────┴───────────────────────────┴───────────────────────────┘"}

packages/aws-cdk/test/commands/__io_snapshots__/refactor/--dry-run_detects_a_resource_moved_to_another_stack.ndjson

@@ -2,5 +2,5 @@
 {"seq":1,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":2,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":3,"type":"notify","action":"refactor","level":"info","code":"CDK_TOOLKIT_I1000","message":"✨  Synthesis time: <DURATION>"}
-{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1\n"}
-{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬──────────────────────────┬──────────────────────────┐\n│ Resource Type   │ Old Construct Path       │ New Construct Path       │\n├─────────────────┼──────────────────────────┼──────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/MyBucket/Resource │ Stack2/MyBucket/Resource │\n└─────────────────┴──────────────────────────┴──────────────────────────┘\n "}
+{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1"}
+{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬──────────────────────────┬──────────────────────────┐\n│ Resource Type   │ Old Construct Path       │ New Construct Path       │\n├─────────────────┼──────────────────────────┼──────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/MyBucket/Resource │ Stack2/MyBucket/Resource │\n└─────────────────┴──────────────────────────┴──────────────────────────┘"}

packages/aws-cdk/test/commands/__io_snapshots__/refactor/ambiguity_--revert_swaps_the_direction_of_the_override_file.ndjson

@@ -2,5 +2,5 @@
 {"seq":1,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":2,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":3,"type":"notify","action":"refactor","level":"info","code":"CDK_TOOLKIT_I1000","message":"✨  Synthesis time: <DURATION>"}
-{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1\n"}
-{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬─────────────────────────┬─────────────────────────┐\n│ Resource Type   │ Old Construct Path      │ New Construct Path      │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket3/Resource │ Stack1/Bucket1/Resource │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket4/Resource │ Stack1/Bucket2/Resource │\n└─────────────────┴─────────────────────────┴─────────────────────────┘\n "}
+{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1"}
+{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬─────────────────────────┬─────────────────────────┐\n│ Resource Type   │ Old Construct Path      │ New Construct Path      │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket3/Resource │ Stack1/Bucket1/Resource │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket4/Resource │ Stack1/Bucket2/Resource │\n└─────────────────┴─────────────────────────┴─────────────────────────┘"}

packages/aws-cdk/test/commands/__io_snapshots__/refactor/ambiguity_an_override_file_resolves_the_ambiguity.ndjson

@@ -2,5 +2,5 @@
 {"seq":1,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1000","message":"Starting Synthesis ..."}
 {"seq":2,"type":"notify","action":"refactor","level":"trace","code":"CDK_CLI_I1001","message":"\n✨  Synthesis time: <DURATION>\n"}
 {"seq":3,"type":"notify","action":"refactor","level":"info","code":"CDK_TOOLKIT_I1000","message":"✨  Synthesis time: <DURATION>"}
-{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1\n"}
-{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬─────────────────────────┬─────────────────────────┐\n│ Resource Type   │ Old Construct Path      │ New Construct Path      │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket1/Resource │ Stack1/Bucket3/Resource │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket2/Resource │ Stack1/Bucket4/Resource │\n└─────────────────┴─────────────────────────┴─────────────────────────┘\n "}
+{"seq":4,"type":"notify","action":"refactor","level":"info","code":null,"message":"aws://123456789012/bermuda-triangle-1"}
+{"seq":5,"type":"notify","action":"refactor","level":"result","code":"CDK_TOOLKIT_I8900","message":"The following resources were moved or renamed:\n┌─────────────────┬─────────────────────────┬─────────────────────────┐\n│ Resource Type   │ Old Construct Path      │ New Construct Path      │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket1/Resource │ Stack1/Bucket3/Resource │\n├─────────────────┼─────────────────────────┼─────────────────────────┤\n│ AWS::S3::Bucket │ Stack1/Bucket2/Resource │ Stack1/Bucket4/Resource │\n└─────────────────┴─────────────────────────┴─────────────────────────┘"}