feat: list stack dependencies #28995

vinayak-kukreja · 2024-02-06T07:03:06Z

Reason for this change

Existing cdk list functionality does not display stack dependencies. This PR introduces that functionality.

For instance,
Existing functionality:

❯ cdk list
producer
consumer

Feature functionality:

❯ cdk list --show-dependencies
- id: producer
  dependencies: []
- id: consumer
  dependencies:
    - id: producer
      dependencies: []

Description of changes

Changes are based on internal team design discussions.

A new flag --show-dependencies is being introduced for list cli command.
A new file list-stacks.ts is being added.
- Adding listStacks function within the file for listing stack and their dependencies using cloud assembly from the cdk toolkit.

Description of how you validated changes

Unit and Integration testing

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

Co-Author

Co-authored-by: @SankyRed

NOTE: We are currently getting it reviewed by UX too so the final display output might change.

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.

vinayak-kukreja · 2024-02-06T23:08:32Z

packages/aws-cdk/README.md

 ```console
 $ # List all stacks in the CDK app 'node bin/main.js'


We need to update these examples once CLI team decides on the UX for this command.

packages/aws-cdk/test/workflows.test.ts

vinayak-kukreja · 2024-02-07T22:53:17Z

Exemption request:

Since this is a new flow path, the integration test for CLI would not make sense here. Integ tests would be added once we have the other flow path ready.

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

vinayak-kukreja · 2024-02-27T16:34:31Z

Exemption Request:

We are cli integ testing this change which would not generate a snapshot.

colifran

Looks great! I just have a few small comments.

colifran · 2024-03-01T16:04:47Z

packages/aws-cdk/lib/list-stacks.ts

+            });
+          }
+        } else {
+          data.dependencies?.push({


nit: should this be optional? Doesn't data always have a dependencies array even if it is just empty?

Hmm, good point, let me recheck and get back to you.

To be clear I just mean I think this could just be data.dependencies.push(...)

You are correct. Removing this. Good catch 💯

colifran · 2024-03-01T16:05:19Z

packages/aws-cdk/lib/list-stacks.ts

+
+        const depStack = assembly.stackById(dependencyId);
+
+        if (depStack.stackArtifacts[0].dependencies.length > 0 &&


Just curious -- why are we only getting the first stackArtifact here?

So we are getting the dependent stack by ID: assembly.stackById(dependencyId);, so there must be just one unique stack by id.

I can add a comment explaining this or/and initially I had an error if it was greater than one but I believed that validation should be done before this (I can check if that is present). Thougths?

Ahh okay that makes sense. I think maybe just a comment here would be good. It wasn't totally clear to me right away.

Ok, so stackById uses getStackArtifact which would always return one artifact but stackById wraps it in an array.

Thanks for the clarification. Not now, unrelated, and also not sure what the impact would be, but maybe this is something we can update in a future PR. It feels like stackById should return a single stack, not an array containing a single stack.

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

w-oh · 2024-03-04T19:38:34Z

Approved by UXD 3/4/24 (woh@)

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

aws-cdk-automation · 2024-03-04T21:45:09Z

➡️ 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.

Signed-off-by: SankyRed <sankyred@amazon.com>

aws-cdk-automation · 2024-03-05T02:34:17Z

AWS CodeBuild CI Report

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

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

mergify · 2024-03-05T02:34:31Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation requested a review from a team February 6, 2024 07:03

github-actions bot added the p2 label Feb 6, 2024

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

vinayak-kukreja had a problem deploying to test-pipeline February 6, 2024 07:04 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Feb 6, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Feb 6, 2024

vinayak-kukreja had a problem deploying to test-pipeline February 6, 2024 21:39 — with GitHub Actions Failure

vinayak-kukreja had a problem deploying to test-pipeline February 6, 2024 23:00 — with GitHub Actions Failure

vinayak-kukreja had a problem deploying to test-pipeline February 6, 2024 23:06 — with GitHub Actions Failure

vinayak-kukreja commented Feb 6, 2024

View reviewed changes

SankyRed had a problem deploying to test-pipeline February 7, 2024 20:45 — with GitHub Actions Failure

vinayak-kukreja commented Feb 7, 2024

View reviewed changes

packages/aws-cdk/test/workflows.test.ts Outdated Show resolved Hide resolved

vinayak-kukreja added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Feb 7, 2024

SankyRed force-pushed the vkukreja/list-stack-deps branch from 69c8a9f to 8f4b1ef Compare February 8, 2024 19:59

SankyRed had a problem deploying to test-pipeline February 8, 2024 20:00 — with GitHub Actions Failure

vinayak-kukreja and others added 6 commits February 8, 2024 14:26

feat: list stack dependencies

72964a4

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

update PR

e0c5952

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

update PR

3c0000b

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

update Readme

7daf9d2

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

Add unit tests

76cec8a

Add unit tests

43ce6f6

SankyRed force-pushed the vkukreja/list-stack-deps branch from 8f4b1ef to 43ce6f6 Compare February 8, 2024 21:44

SankyRed had a problem deploying to test-pipeline February 8, 2024 21:45 — with GitHub Actions Failure

Merge branch 'main' into vkukreja/list-stack-deps

0d2311a

vinayak-kukreja had a problem deploying to test-pipeline February 8, 2024 21:56 — with GitHub Actions Failure

vinayak-kukreja marked this pull request as ready for review February 8, 2024 22:12

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

Merge branch 'main' into vkukreja/list-stack-deps

8a8de26

vinayak-kukreja had a problem deploying to test-pipeline February 9, 2024 20:52 — with GitHub Actions Failure

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

clean up

189ead6

SankyRed temporarily deployed to test-pipeline February 27, 2024 17:00 — with GitHub Actions Inactive

Merge branch 'main' into vkukreja/list-stack-deps

bf27129

SankyRed had a problem deploying to test-pipeline February 27, 2024 19:40 — with GitHub Actions Failure

github-actions bot mentioned this pull request Mar 1, 2024

Monthly PR metrics report - Feb 2023 #29328

Closed

colifran requested changes Mar 1, 2024

View reviewed changes

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

vinayak-kukreja and others added 2 commits March 1, 2024 13:30

address feedback

3e2e075

Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>

Merge branch 'main' into vkukreja/list-stack-deps

eab7a24

vinayak-kukreja had a problem deploying to test-pipeline March 1, 2024 21:31 — with GitHub Actions Failure

vinayak-kukreja requested a review from colifran March 1, 2024 21:32

colifran approved these changes Mar 1, 2024

View reviewed changes

Merge branch 'main' into vkukreja/list-stack-deps

f262295

vinayak-kukreja temporarily deployed to test-pipeline March 4, 2024 19:41 — with GitHub Actions Inactive

colifran added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Mar 4, 2024

empty commit for rerunning build

ade7c03

Signed-off-by: SankyRed <sankyred@amazon.com>

SankyRed had a problem deploying to test-pipeline March 4, 2024 22:43 — with GitHub Actions Failure

Merge branch 'main' into vkukreja/list-stack-deps

39ae15c

vinayak-kukreja had a problem deploying to test-pipeline March 5, 2024 02:08 — with GitHub Actions Failure

vinayak-kukreja removed the pr/do-not-merge This PR should not be merged at this time. label Mar 5, 2024

mergify bot merged commit a7fac9d into main Mar 5, 2024
14 of 15 checks passed

mergify bot deleted the vkukreja/list-stack-deps branch March 5, 2024 02:34

SimonCMoore mentioned this pull request Mar 27, 2024

Show stack dependency tree #16080

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: list stack dependencies #28995

feat: list stack dependencies #28995

vinayak-kukreja commented Feb 6, 2024 •

edited

aws-cdk-automation left a comment

vinayak-kukreja Feb 6, 2024

vinayak-kukreja commented Feb 7, 2024

vinayak-kukreja commented Feb 27, 2024

colifran left a comment

colifran Mar 1, 2024

vinayak-kukreja Mar 1, 2024

colifran Mar 1, 2024

vinayak-kukreja Mar 1, 2024

colifran Mar 1, 2024

vinayak-kukreja Mar 1, 2024

colifran Mar 1, 2024

vinayak-kukreja Mar 1, 2024

colifran Mar 1, 2024

vinayak-kukreja Mar 1, 2024

w-oh commented Mar 4, 2024

aws-cdk-automation commented Mar 4, 2024

aws-cdk-automation commented Mar 5, 2024

mergify bot commented Mar 5, 2024

		```console
		$ # List all stacks in the CDK app 'node bin/main.js'


		const depStack = assembly.stackById(dependencyId);

		if (depStack.stackArtifacts[0].dependencies.length > 0 &&

feat: list stack dependencies #28995

feat: list stack dependencies #28995

Conversation

vinayak-kukreja commented Feb 6, 2024 • edited

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Co-Author

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vinayak-kukreja commented Feb 7, 2024

vinayak-kukreja commented Feb 27, 2024

colifran 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

w-oh commented Mar 4, 2024

aws-cdk-automation commented Mar 4, 2024

aws-cdk-automation commented Mar 5, 2024

AWS CodeBuild CI Report

mergify bot commented Mar 5, 2024

vinayak-kukreja commented Feb 6, 2024 •

edited