refactor(toolkit): cxapp to use moden messaging infrastructure #285

mrgrain · 2025-03-27T14:08:28Z

Refactors the cxapp api code to use modern messaging. This had a larger amount of knock-on effects then other refactors, to the PR is a bit bigger.

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

mrgrain · 2025-03-27T14:08:51Z

packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts

+  /**
+   * Compute the bootstrap enviornments
+   *
+   * @internal


This was previously missed to mark internal.

mrgrain · 2025-03-27T14:09:01Z

packages/@aws-cdk/toolkit-lib/lib/actions/bootstrap/index.ts

+   *
+   * @internal
+   */
+  async getEnvironments(ioHost: IIoHost): Promise<cxapi.Environment[]> {


Because it's internal, we can change this.

mrgrain · 2025-03-27T14:10:11Z

packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/prepare-source.ts

this turned into a bigger refactor. I realized a lot of these helpers share the same context, so a new abstraction (class) seemed appropriate. No functional changes.

mrgrain · 2025-03-27T14:10:57Z

packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/prepare-source.ts

+   * fine in certain scenarios.
+   */
+  public async defaultEnvVars(): Promise<Env> {
+    const debugFn = (msg: string) => this.ioHelper.notify(IO.CDK_ASSEMBLY_I0010.msg(msg));


uses a different code than the other messages in this class. probably doesn't need to. We can make a breaking change at some point.

mrgrain · 2025-03-27T14:11:42Z

packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/source-builder.ts

-          const assembly = await changeDir(async () =>
-            withContext(context.all, env, props.synthOptions ?? {}, async (envWithContext, ctx) =>
-              withEnv(envWithContext, () => {
+          const x = new ExecutionEnviornment(services, { outdir: props.outdir });


x for eXecution. Open to better suggestions.

Maybe simply execution.

mrgrain · 2025-03-27T14:13:25Z

packages/aws-cdk/lib/api/tree.ts

    const outdir = assembly.directory;
    const fileName = assembly.tree()?.file;
-    return fileName ? fs.readJSONSync(path.join(outdir, fileName)).tree : {};
+    return fileName ? fs.readJSONSync(path.join(outdir, fileName)).tree : ({} as ConstructTreeNode);


We always had it like this, but it's an error in my IDE so I thought I might as well cast it.

codecov-commenter · 2025-03-27T15:40:55Z

Codecov Report

Attention: Patch coverage is 87.50000% with 14 lines in your changes missing coverage. Please review.

Project coverage is 85.34%. Comparing base (0db3dc2) to head (868e8e1).

Files with missing lines	Patch %	Lines
packages/aws-cdk/lib/api/cxapp/cloud-assembly.ts	73.91%	6 Missing ⚠️
packages/aws-cdk/lib/api/cxapp/cloud-executable.ts	70.00%	3 Missing ⚠️
packages/aws-cdk/lib/api/cxapp/exec.ts	96.92%	2 Missing ⚠️
packages/aws-cdk/lib/api/tree.ts	33.33%	2 Missing ⚠️
packages/aws-cdk/lib/cli/cli.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #285   +/-   ##
=======================================
  Coverage   85.33%   85.34%           
=======================================
  Files         222      222           
  Lines       36761    36798   +37     
  Branches     4447     4448    +1     
=======================================
+ Hits        31370    31405   +35     
+ Misses       5294     5292    -2     
- Partials       97      101    +4

Flag	Coverage Δ
suite.unit	`85.34% <87.50%> (+<0.01%)`	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: github-actions <[email protected]>

packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/prepare-source.ts

otaviomacedo · 2025-03-28T11:11:26Z

packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/source-builder.ts

-          const assembly = await changeDir(async () =>
-            withContext(context.all, env, props.synthOptions ?? {}, async (envWithContext, ctx) =>
-              withEnv(envWithContext, () => {
+          const x = new ExecutionEnviornment(services, { outdir: props.outdir });


Maybe simply execution.

packages/@aws-cdk/toolkit-lib/lib/api/cloud-assembly/private/prepare-source.ts

otaviomacedo · 2025-03-28T11:18:28Z

packages/@aws-cdk/cli-lib-alpha/lib/cli.ts

      () => runCli(args, async (sdk, config) => {
-        const env = await prepareDefaultEnvironment(sdk);
-        const context = await prepareContext(config.settings, config.context.all, env);
+        const env = await prepareDefaultEnvironment(sdk, debugFn);


Isn't this the default value anyway?

prepareDefaultEnvironment used to have a default for debugFn, but the default was using the old legacy logging system. Removed the default, made the param mandatory. cli-lib-alpha will use legacy logging until further notice, but we plan to deprecate that package anyway soon.

mrgrain had a problem deploying to integ-approval March 27, 2025 14:08 — with GitHub Actions Failure

aws-cdk-automation enabled auto-merge March 27, 2025 14:08

mrgrain commented Mar 27, 2025

View reviewed changes

aws-cdk-automation requested a review from a team March 27, 2025 14:09

github-actions bot added the p2 label Mar 27, 2025

mrgrain commented Mar 27, 2025

View reviewed changes

mrgrain force-pushed the mrgrain/refactor/cxapp-logging branch from 8719052 to edd45e2 Compare March 27, 2025 15:34

mrgrain had a problem deploying to integ-approval March 27, 2025 15:34 — with GitHub Actions Failure

mrgrain force-pushed the mrgrain/refactor/cxapp-logging branch from edd45e2 to 802c5c1 Compare March 27, 2025 16:06

mrgrain had a problem deploying to integ-approval March 27, 2025 16:06 — with GitHub Actions Failure

refactor(toolkit): cxapp to use moden messaging infrastructure

e998ab8

mrgrain force-pushed the mrgrain/refactor/cxapp-logging branch from 802c5c1 to e998ab8 Compare March 27, 2025 16:36

mrgrain had a problem deploying to integ-approval March 27, 2025 16:36 — with GitHub Actions Error

chore: self mutation

630490c

Signed-off-by: github-actions <[email protected]>

aws-cdk-automation had a problem deploying to integ-approval March 27, 2025 16:47 — with GitHub Actions Failure

aws-cdk-automation temporarily deployed to integ-approval March 27, 2025 18:07 — with GitHub Actions Inactive

aws-cdk-automation temporarily deployed to run-tests March 27, 2025 18:28 — with GitHub Actions Inactive

otaviomacedo reviewed Mar 28, 2025

View reviewed changes

pr feedback

868e8e1

mrgrain temporarily deployed to integ-approval March 28, 2025 11:41 — with GitHub Actions Inactive

otaviomacedo approved these changes Mar 28, 2025

View reviewed changes

mrgrain temporarily deployed to run-tests March 28, 2025 12:17 — with GitHub Actions Inactive

mrgrain temporarily deployed to run-tests March 28, 2025 12:18 — with GitHub Actions Inactive

aws-cdk-automation added this pull request to the merge queue Mar 28, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 28, 2025

mrgrain added this pull request to the merge queue Mar 28, 2025

Merged via the queue into main with commit 2a9ee4c Mar 28, 2025
20 checks passed

mrgrain deleted the mrgrain/refactor/cxapp-logging branch March 28, 2025 13:42

refactor(toolkit): cxapp to use moden messaging infrastructure #285

refactor(toolkit): cxapp to use moden messaging infrastructure #285

Uh oh!

Conversation

mrgrain commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrgrain Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrgrain Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mrgrain commented Mar 27, 2025 •

edited

Loading

mrgrain Mar 27, 2025 •

edited

Loading

mrgrain Mar 27, 2025 •

edited

Loading

codecov-commenter commented Mar 27, 2025 •

edited

Loading