chore: unconnected CliIoHost logger-only implementation #32503

HBobertz · 2024-12-12T19:17:52Z

Issue #32345

Reason for this change

Setting the ground work for our Programmatic Toolkit

Description of changes

Created an unconnected CLIIoHost with a singular initial action available notify. In this implementation of the soon to be defined IoHost we are only writing logs to stdout and stderr.

Description of how you validated changes

Verified via unit testing as this is currently unconnected to the greater AWS CDK CLI

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

codecov · 2024-12-12T19:58:00Z

Codecov Report

Attention: Patch coverage is 96.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 80.59%. Comparing base (5735e9e) to head (255339e).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32503      +/-   ##
==========================================
+ Coverage   80.54%   80.59%   +0.05%     
==========================================
  Files         106      107       +1     
  Lines        6954     6979      +25     
  Branches     1287     1296       +9     
==========================================
+ Hits         5601     5625      +24     
  Misses       1175     1175              
- Partials      178      179       +1

Flag	Coverage Δ
suite.unit	`80.59% <96.00%> (+0.05%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.59% <96.00%> (+0.05%)`	⬆️

mrgrain · 2024-12-13T14:35:43Z

packages/aws-cdk/toolkit/toolkit.ts

+export const _private = {
+  CliIoHost,
+  IoMessageLevel,
+  IoAction,
+} as const;


What is this?

It's so I can test it without exporting the toolkit just yet. I need to export something so I can write tests

Yeah let's not do that. You can export things from this file. Just not from the package index.

aws-cdk-automation · 2024-12-13T15:04:27Z

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

mrgrain · 2024-12-16T10:26:32Z

packages/aws-cdk/toolkit/toolkit.ts

You probably want to call this file after its contents.

This stuff still needs to be in lib.

mrgrain · 2024-12-16T10:30:19Z

packages/aws-cdk/toolkit/toolkit.ts

+  async notify(msg: IoMessage): Promise<void> {
+    const output = this.formatMessage(msg);
+
+    const stream = msg.level === 'error' ? process.stderr : process.stdout;


stream selection doesn't match what we are currently doing in this regard.

mrgrain · 2024-12-16T10:33:13Z

packages/aws-cdk/toolkit/toolkit.ts

+  code: string;
+  message: string;
+  // Specify Chalk style for stdout/stderr, if TTY is enabled
+  style?: ((str: string) => string);


This is a good thought. Is this currently used anywhere?

Beyond that, that - there's an interesting question for you: We currently use chalk inline in a number of places. How are we going to deal with that?

Might be easier to always chalk and use a global setting to deal with color vs no color.

Not currently used anywhere, but I thought this would be a nice thing to add for customers when we create the IoHost interface

I did some more recon on this and this is a very real problem I'm gonna need to address in a couple spots. This is enough though that I want to break that out into a separate pr, so I'll handle that in a follow up

can you explain the problem here?

mrgrain · 2024-12-16T10:33:54Z

packages/aws-cdk/toolkit/toolkit.ts

+enum IoMessageLevel {
+  ERROR = 'error',
+  WARN = 'warn',
+  INFO = 'info',
+  DEBUG = 'debug',
+  TRACE = 'trace',
+}


Let's make this a type instead of an enum.

mrgrain · 2024-12-16T10:33:56Z

packages/aws-cdk/toolkit/toolkit.ts

+  TRACE = 'trace',
+}
+
+enum IoAction {


Let's make this a type instead of an enum.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

aws-cdk-automation · 2024-12-24T06:37:20Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 255339e
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

kaizencc

mostly nits, almost there

kaizencc · 2024-12-24T23:49:23Z

packages/aws-cdk/toolkit/lib/cli-io-host.ts

+ * Basic message structure for toolkit notifications.
+ * Messages are emitted by the toolkit and handled by the IoHost.
+ */
+interface IoMessage {


i think all interface properties should be readonly. also I would expect a bit more documentation here to give me an idea of what these options do. also defaults

kaizencc · 2024-12-24T23:55:18Z

packages/aws-cdk/toolkit/lib/cli-io-host.ts

+    const stream = this.getStream(msg.level, msg.forceStdout ?? false);
+
+    return new Promise((resolve, reject) => {
+      stream.write(output + '\n', (err) => {


can the \n be part of this.formatMessage?

kaizencc · 2024-12-24T23:59:54Z

packages/aws-cdk/test/toolkit/cli-io-host.test.ts

+        forceStdout: true,
+      });
+
+      expect(mockStdout).toHaveBeenCalledWith(chalk.white('info message') + '\n');


just curious: would this fail if you have chalk.white('info message\n')

kaizencc · 2024-12-25T00:03:30Z

packages/aws-cdk/test/toolkit/cli-io-host.test.ts

+  });
+
+  describe('CI mode behavior', () => {
+    test('writes to stdout in CI mode regardless of level', async () => {


based on the name of this test, I would assume that you also intend to write to stdout if the notify message is error. is that true? if so, i'd like to see a test for that case.

kaizencc · 2024-12-25T00:04:41Z

packages/aws-cdk/test/toolkit/cli-io-host.test.ts

+      expect(mockStderr).not.toHaveBeenCalled();
+    });
+
+    test('respects forceStdout:false in CI mode', async () => {


i'm confused at this test. forceStdout: false is the default. what are you testing for here then?

also, you have this in your code if (level == 'error') return process.stderr;, so regardless of ci: true an error message will be sent to stderr

i think you need a forceStdout: true test.

kaizencc · 2024-12-25T00:05:52Z

packages/aws-cdk/toolkit/lib/cli-io-host.ts

+    if (level == 'error') return process.stderr;
+    return this.ci ? process.stdout : process.stderr;


can you document the reasoning for why we are sending certain things to stderr and certain things to stdout?

kaizencc · 2024-12-25T00:11:38Z

packages/aws-cdk/toolkit/lib/cli-io-host.ts

+    const pad = (n: number): string => n.toString().padStart(2, '0');
+    return `${pad(d.getHours())}:${pad(d.getMinutes())}:${pad(d.getSeconds())}`;
+  }
+


Suggested change

kaizencc · 2024-12-25T00:31:03Z

packages/aws-cdk/toolkit/toolkit.ts

+  code: string;
+  message: string;
+  // Specify Chalk style for stdout/stderr, if TTY is enabled
+  style?: ((str: string) => string);


can you explain the problem here?

kaizencc · 2024-12-25T00:36:07Z

packages/aws-cdk/toolkit/lib/cli-io-host.ts

+  message: string;
+  forceStdout?: boolean;
+  // Optionally specify Chalk style for stdout/stderr, if TTY is enabled
+  style?: ((str: string) => string);


[reviving the discussion on styling]

I thought this would be a nice thing to add for customers when we create the IoHost interface

i'm not opinionated about this either way, but isn't the point of CliIoHost to be an unopinionated 1-1 matching to what we currently have in the CDK CLI? I don't see us deciding to use custom styling beyond what our current logging styles look like.

kaizencc · 2024-12-25T00:37:15Z

packages/aws-cdk/toolkit/lib/cli-io-host.ts

+
+export type IoAction = 'synth' | 'list' | 'deploy' | 'destroy';
+
+interface CliIoHostOptions {


same comment about documentation. it's important to easily figure out what tty / ci are and why they matter when it comes to logging

initial toolkit implementation

a978966

github-actions bot added the p2 label Dec 12, 2024

aws-cdk-automation requested a review from a team December 12, 2024 19:18

mergify bot added the contribution/core This is a PR that came from AWS. label Dec 12, 2024

HBobertz requested a deployment to test-pipeline December 12, 2024 19:19 — with GitHub Actions Waiting

aws-cdk-automation previously requested changes Dec 12, 2024

View reviewed changes

fix linting problems

953fb3d

HBobertz temporarily deployed to test-pipeline December 12, 2024 19:45 — with GitHub Actions Inactive

HBobertz marked this pull request as ready for review December 12, 2024 20:22

HBobertz requested a review from a team as a code owner December 12, 2024 20:22

Merge branch 'main' into bobertzh/toolkit

66ef2f5

HBobertz temporarily deployed to test-pipeline December 13, 2024 14:27 — with GitHub Actions Inactive

mrgrain reviewed Dec 13, 2024

View reviewed changes

mrgrain reviewed Dec 16, 2024

View reviewed changes

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

TRACE = 'trace',

}

enum IoAction {

Copy link

Contributor

mrgrain Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make this a type instead of an enum.

address iohost feedback

98888d4

HBobertz requested a deployment to test-pipeline December 24, 2024 05:06 — with GitHub Actions Waiting

Merge branch 'main' into bobertzh/toolkit

634b3eb

HBobertz requested a deployment to test-pipeline December 24, 2024 05:08 — with GitHub Actions Waiting

HBobertz changed the title ~~chore: Unconnected IoHost logger-only implementation~~ chore: unconnected IoHost logger-only implementation Dec 24, 2024

HBobertz changed the title ~~chore: unconnected IoHost logger-only implementation~~ chore: unconnected CliIoHost logger-only implementation Dec 24, 2024

linting fixes

09b847f

HBobertz requested a deployment to test-pipeline December 24, 2024 05:26 — with GitHub Actions Waiting

cli-io-host stream fixes

255339e

HBobertz requested a deployment to test-pipeline December 24, 2024 06:07 — with GitHub Actions Waiting

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 24, 2024

kaizencc requested changes Dec 25, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: unconnected CliIoHost logger-only implementation #32503

chore: unconnected CliIoHost logger-only implementation #32503

HBobertz commented Dec 12, 2024 •

edited

Loading

aws-cdk-automation left a comment

codecov bot commented Dec 12, 2024 •

edited

Loading

mrgrain Dec 13, 2024

HBobertz Dec 13, 2024

mrgrain Dec 16, 2024

aws-cdk-automation commented Dec 13, 2024

mrgrain Dec 16, 2024

mrgrain Dec 16, 2024

mrgrain Dec 16, 2024

HBobertz Dec 24, 2024

HBobertz Dec 24, 2024 •

edited

Loading

kaizencc Dec 25, 2024

mrgrain Dec 16, 2024

mrgrain Dec 16, 2024

aws-cdk-automation commented Dec 24, 2024

kaizencc left a comment

kaizencc Dec 24, 2024

kaizencc Dec 24, 2024

kaizencc Dec 24, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

kaizencc Dec 25, 2024

		if (level == 'error') return process.stderr;
		return this.ci ? process.stdout : process.stderr;


		export type IoAction = 'synth' \| 'list' \| 'deploy' \| 'destroy';

		interface CliIoHostOptions {

chore: unconnected CliIoHost logger-only implementation #32503

Are you sure you want to change the base?

chore: unconnected CliIoHost logger-only implementation #32503

Conversation

HBobertz commented Dec 12, 2024 • edited Loading

Issue #32345

Reason for this change

Description of changes

Description of how you validated changes

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Dec 12, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HBobertz Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 24, 2024

AWS CodeBuild CI Report

kaizencc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HBobertz commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 12, 2024 •

edited

Loading

HBobertz Dec 24, 2024 •

edited

Loading