refactor(cli): docs, doctor, context commands do not use configuration directly anymore #32578

kaizencc · 2024-12-18T18:40:48Z

This is a refactor that follows #32558. The effort is to ensure that the configuration object is not directly used by commands and instead, the relevant information is passed directly to the function.

doctor: no options needed
docs: 1 option needed
context: in addition to a few options, the context command also saves some values to cdk.context.json. this requires some modifications to the Context object to support this.

We move away from using the archaic API in command-api.ts. This seems to be an old effort to standardize CLI commands that was only used for doctor/docs/context. We have since evolved to use command-specific property bags.

Since this is a refactor PR. I aim to change no functionality of the 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-18T18:55:23Z

Codecov Report

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

Project coverage is 80.41%. Comparing base (3377c3b) to head (699fe73).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32578      +/-   ##
==========================================
+ Coverage   79.15%   80.41%   +1.26%     
==========================================
  Files         107      106       -1     
  Lines        7139     6955     -184     
  Branches     1321     1288      -33     
==========================================
- Hits         5651     5593      -58     
+ Misses       1304     1183     -121     
+ Partials      184      179       -5

Flag	Coverage Δ
suite.unit	`80.41% <96.15%> (+1.26%)`	⬆️

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

Components	Coverage Δ
packages/aws-cdk	`80.41% <96.15%> (+1.26%)`	⬆️

aws-cdk-automation · 2024-12-19T00:06:40Z

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

packages/aws-cdk/lib/commands/context.ts

mrgrain · 2024-12-19T10:59:01Z

packages/aws-cdk/lib/config.ts

@@ -373,9 +373,9 @@ export async function makeConfig(): Promise<CliConfig> {
      context: {
        description: 'Manage cached context values',
        options: {
-          reset: { alias: 'e', desc: 'The context key (or its index) to reset', type: 'string', requiresArg: true },
+          reset: { alias: 'e', desc: 'The context key (or its index) to reset', type: 'string', requiresArg: true, default: undefined },


Side note: we should probably change the codegen to always add an explicit default if none is provied.

mrgrain · 2024-12-19T11:04:15Z

packages/aws-cdk/lib/settings.ts


-  constructor(...bags: Settings[]) {
-    this.bags = bags.length > 0 ? bags : [new Settings()];
+  constructor(...bags: ({name?: string; bag: Settings})[]) {


❓ Don't think I'm wild about this API... Why are names optional?

I think eventually Context will be a public type and we need to revisit this API then.

name is optional because one context bag we have comes from the CLI option, not a file. i should have called them filenames i guess

mrgrain

Approved in principle with some minor comments for your consideration.

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

kaizencc · 2024-12-20T14:29:13Z

@Mergifyio refresh

mergify · 2024-12-20T14:29:21Z

refresh

✅ Pull request refreshed

mergify · 2024-12-20T14:38:15Z

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 · 2024-12-20T15:08:40Z

AWS CodeBuild CI Report

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

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

mergify · 2024-12-20T15:09:07Z

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).

github-actions · 2024-12-20T15:09:29Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

kaizencc added 2 commits December 18, 2024 13:01

refactor commands builds

47fbe22

fix context to be able to save to file

6be5517

kaizencc requested a review from a team as a code owner December 18, 2024 18:40

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

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

kaizencc requested a deployment to test-pipeline December 18, 2024 18:41 — with GitHub Actions Waiting

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

Merge branch 'main' into conroy/refactor-commands

7bbd9a5

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

View reviewed changes

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

kaizencc temporarily deployed to test-pipeline December 18, 2024 18:43 — with GitHub Actions Inactive

move to argv

0f10e81

kaizencc temporarily deployed to test-pipeline December 19, 2024 00:05 — with GitHub Actions Inactive

mrgrain reviewed Dec 19, 2024

View reviewed changes

packages/aws-cdk/lib/commands/context.ts Outdated Show resolved Hide resolved

mrgrain reviewed Dec 19, 2024

View reviewed changes

mrgrain added the pr/do-not-merge This PR should not be merged at this time. label Dec 19, 2024

mrgrain approved these changes Dec 19, 2024

View reviewed changes

kaizencc added pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Dec 19, 2024

pr comments

cf37cda

kaizencc requested a deployment to test-pipeline December 19, 2024 17:40 — with GitHub Actions Waiting

Merge branch 'main' into conroy/refactor-commands

36fc1d5

kaizencc requested a deployment to test-pipeline December 19, 2024 21:11 — with GitHub Actions Waiting

more tests

a60c77e

kaizencc requested a deployment to test-pipeline December 19, 2024 23:36 — with GitHub Actions Waiting

Merge branch 'main' into conroy/refactor-commands

b5eaf5a

kaizencc requested a deployment to test-pipeline December 19, 2024 23:40 — with GitHub Actions Waiting

ignore codecov on impossible to test lines

79fd29d

kaizencc requested a deployment to test-pipeline December 20, 2024 01:22 — with GitHub Actions Waiting

kaizencc removed the pr/do-not-merge This PR should not be merged at this time. label Dec 20, 2024

Merge branch 'main' into conroy/refactor-commands

699fe73

mergify bot requested a deployment to test-pipeline December 20, 2024 14:39 Waiting

mergify bot merged commit 189bae3 into main Dec 20, 2024
16 of 17 checks passed

mergify bot deleted the conroy/refactor-commands branch December 20, 2024 15:09

github-actions bot locked as resolved and limited conversation to collaborators Dec 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(cli): docs, doctor, context commands do not use configuration directly anymore #32578

refactor(cli): docs, doctor, context commands do not use configuration directly anymore #32578

kaizencc commented Dec 18, 2024 •

edited

Loading

aws-cdk-automation left a comment

codecov bot commented Dec 18, 2024 •

edited

Loading

aws-cdk-automation commented Dec 19, 2024

mrgrain Dec 19, 2024

kaizencc Dec 19, 2024

mrgrain Dec 19, 2024 •

edited

Loading

kaizencc Dec 19, 2024 •

edited

Loading

mrgrain left a comment

kaizencc commented Dec 20, 2024

mergify bot commented Dec 20, 2024

mergify bot commented Dec 20, 2024

aws-cdk-automation commented Dec 20, 2024

mergify bot commented Dec 20, 2024

github-actions bot commented Dec 20, 2024

refactor(cli): docs, doctor, context commands do not use configuration directly anymore #32578

refactor(cli): docs, doctor, context commands do not use configuration directly anymore #32578

Conversation

kaizencc commented Dec 18, 2024 • edited Loading

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Dec 18, 2024 • edited Loading

Codecov Report

aws-cdk-automation commented Dec 19, 2024

mrgrain Dec 19, 2024

Choose a reason for hiding this comment

kaizencc Dec 19, 2024

Choose a reason for hiding this comment

mrgrain Dec 19, 2024 • edited Loading

Choose a reason for hiding this comment

kaizencc Dec 19, 2024 • edited Loading

Choose a reason for hiding this comment

mrgrain left a comment

Choose a reason for hiding this comment

kaizencc commented Dec 20, 2024

mergify bot commented Dec 20, 2024

✅ Pull request refreshed

mergify bot commented Dec 20, 2024

aws-cdk-automation commented Dec 20, 2024

AWS CodeBuild CI Report

mergify bot commented Dec 20, 2024

github-actions bot commented Dec 20, 2024

kaizencc commented Dec 18, 2024 •

edited

Loading

codecov bot commented Dec 18, 2024 •

edited

Loading

mrgrain Dec 19, 2024 •

edited

Loading

kaizencc Dec 19, 2024 •

edited

Loading