feat(toolkit-lib): diff #279

kaizencc · 2025-03-24T21:00:46Z

introduces diff support for programmatic toolkit.

has feature parity with the existing CLI diff
programmatic toolkit functionality is unit tested.
AI disclosure: no AI

does most of aws/aws-cdk#33182, but typed return will come later

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

codecov-commenter · 2025-03-24T21:06:06Z

Codecov Report

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

Project coverage is 85.43%. Comparing base (f9f6d1d) to head (c96788f).
Report is 202 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/aws-cdk/lib/api/deployments/cfn-api.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #279      +/-   ##
==========================================
+ Coverage   85.34%   85.43%   +0.09%     
==========================================
  Files         222      222              
  Lines       36885    36898      +13     
  Branches     4448     4451       +3     
==========================================
+ Hits        31478    31524      +46     
+ Misses       5310     5280      -30     
+ Partials       97       94       -3

Flag	Coverage Δ
suite.unit	`85.43% <97.77%> (+0.09%)`	⬆️

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.

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

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

kaizencc · 2025-03-26T21:14:18Z

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

@@ -12,6 +12,7 @@ export { CloudWatchLogEventMonitor, findCloudWatchLogGroups } from '../../../../
 export { type WorkGraph, WorkGraphBuilder, AssetBuildNode, AssetPublishNode, StackNode, Concurrency } from '../../../../aws-cdk/lib/api/work-graph';
 export { Bootstrapper } from '../../../../aws-cdk/lib/api/bootstrap';
 export { loadTree, some } from '../../../../aws-cdk/lib/api/tree';
+export { createDiffChangeSet } from '../../../../aws-cdk/lib/api/deployments/cfn-api';


i also need to use this function and there's not a good way of moving it to tmp-toolkit-helpers because i would basically be moving the entire deployments folder. wonder if this is ok for now

Yes fine. Will move soon. But add it to the existing import further up, you might need to export the function from the api module.

ok, but doing so means that i export the cfn-api file out of aws-cdk

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

kaizencc · 2025-03-26T21:22:34Z

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

+      expect(ioHost.notifySpy).toHaveBeenCalledWith(expect.objectContaining({
+        action: 'diff',
+        level: 'warn',
+        code: 'CDK_TOOLKIT_W0000',
+        message: expect.stringContaining('This deployment will make potentially sensitive changes according to your current security approval level (--require-approval broadening)'),
+      }));


sanity check: do we expect to have this as a warning notification when we run toolkit.diff?

No, probably not.

this comes from here

it was previously a warning() before being refactored into ioDefaultHelper.warning, so it was always printed as a warning even when the command was cdk diff (and not cdk deploy, where presumably you would need to stop and confirm the diff). cdk deploy has its own confirm message that actually prompts the user.

i think we should be able to just delete those two lines -- i don't think they are useful. alternatively, i don't think its harmful to leave them in.

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

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

kaizencc added 5 commits March 19, 2025 16:22

add diff to toolkit wip

04e800c

Merge branch 'main' into conroy/diffs

8a2da40

more refactoring

8ac30ca

mslall

6958274

another small one

31b2ec2

kaizencc had a problem deploying to integ-approval March 24, 2025 21:00 — with GitHub Actions Failure

aws-cdk-automation requested a review from a team March 24, 2025 21:00

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

mrgrain reviewed Mar 25, 2025

View reviewed changes

packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts Outdated Show resolved Hide resolved

Merge branch 'main' into conroy/diffs

8f3eaa6

kaizencc had a problem deploying to integ-approval March 26, 2025 14:50 — with GitHub Actions Failure

more merge

1d1ef8e

kaizencc had a problem deploying to integ-approval March 26, 2025 14:55 — with GitHub Actions Failure

small changes

ec39825

kaizencc had a problem deploying to integ-approval March 26, 2025 15:48 — with GitHub Actions Failure

kaizencc added 2 commits March 26, 2025 14:29

update tmp-toolkit-helpers to return information i need

ba7d5fa

wip tests

964e226

kaizencc had a problem deploying to integ-approval March 26, 2025 18:29 — with GitHub Actions Failure

kaizencc added 2 commits March 26, 2025 16:49

more tests

737dfee

final tests

17d88c1

kaizencc marked this pull request as ready for review March 26, 2025 21:01

aws-cdk-automation enabled auto-merge March 26, 2025 21:01

kaizencc commented Mar 26, 2025

View reviewed changes

packages/@aws-cdk/toolkit-lib/lib/actions/diff/index.ts Outdated Show resolved Hide resolved

kaizencc commented Mar 26, 2025

View reviewed changes

changeset tests

b18dc89

kaizencc had a problem deploying to integ-approval March 26, 2025 21:21 — with GitHub Actions Failure

kaizencc commented Mar 26, 2025

View reviewed changes

packages/aws-cdk/lib/api/deployments/cfn-api.ts Show resolved Hide resolved

kaizencc commented Mar 26, 2025

View reviewed changes

kaizencc requested a review from mrgrain March 26, 2025 21:25

mrgrain reviewed Mar 28, 2025

View reviewed changes

packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts Outdated Show resolved Hide resolved

move em around

a8c724c

kaizencc had a problem deploying to integ-approval March 28, 2025 19:09 — with GitHub Actions Failure

messages make more sense

67269a5

kaizencc had a problem deploying to integ-approval March 28, 2025 19:38 — with GitHub Actions Failure

pr feedback

3cfbc58

kaizencc had a problem deploying to integ-approval March 28, 2025 20:04 — with GitHub Actions Failure

iffoptions

cc17758

kaizencc had a problem deploying to integ-approval March 28, 2025 20:44 — with GitHub Actions Failure

mrgrain approved these changes Mar 28, 2025

View reviewed changes

export file

8cedfb7

kaizencc had a problem deploying to integ-approval March 28, 2025 21:23 — with GitHub Actions Failure

chore: self mutation

c96788f

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

aws-cdk-automation temporarily deployed to integ-approval March 28, 2025 21:52 — with GitHub Actions Inactive

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

aws-cdk-automation had a problem deploying to run-tests March 28, 2025 22:03 — with GitHub Actions Failure

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

aws-cdk-automation temporarily deployed to run-tests March 29, 2025 06:48 — with GitHub Actions Inactive

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

Merged via the queue into main with commit cd35a1c Mar 29, 2025
20 checks passed

aws-cdk-automation deleted the conroy/diffs branch March 29, 2025 07:04

kaizencc self-assigned this Apr 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(toolkit-lib): diff #279

feat(toolkit-lib): diff #279

Uh oh!

kaizencc commented Mar 24, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Mar 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

kaizencc Mar 26, 2025

Uh oh!

mrgrain Mar 26, 2025 •

edited

Loading

Uh oh!

kaizencc Mar 27, 2025

Uh oh!

Uh oh!

kaizencc Mar 26, 2025

Uh oh!

mrgrain Mar 26, 2025

Uh oh!

kaizencc Mar 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat(toolkit-lib): diff #279

feat(toolkit-lib): diff #279

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

kaizencc Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

mrgrain Mar 26, 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!

kaizencc Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kaizencc Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

mrgrain Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

kaizencc Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaizencc commented Mar 24, 2025 •

edited

Loading

codecov-commenter commented Mar 24, 2025 •

edited

Loading

mrgrain Mar 26, 2025 •

edited

Loading