chore(cli): refactor cli.ts to use `CliArguments` #32760

kaizencc · 2025-01-06T22:19:38Z

To be written

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

…types

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.

…onroy/refact

aws-cdk-automation · 2025-01-09T04:09:24Z

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32760/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.

aws-cdk-automation · 2025-01-09T04:11:28Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 8564109
Result: FAILED
Build Logs (available for 30 days)

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

mrgrain · 2025-01-09T12:31:03Z

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


  /**
   * The type of the assets to be garbage collected.
   *
   * @default 'all'
   */
-  readonly type: 's3' | 'ecr' | 'all';
+  readonly type: TypeType;


Suggested change

readonly type: TypeType;

readonly type: AssetType;

mrgrain · 2025-01-09T12:31:21Z

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

@@ -1792,14 +1795,14 @@ export interface GarbageCollectionOptions {
   *
   * @default 'full'
   */
-  readonly action: 'print' | 'tag' | 'delete-tagged' | 'full';
+  readonly action: ActionType;


Suggested change

readonly action: ActionType;

readonly action: GarbageCollectionAction;

mrgrain · 2025-01-09T12:32:56Z

packages/aws-cdk/lib/api/cxapp/exec.ts

+  } else { // Skip bundling for all stacks
+    bundlingStacks = [];
+  }


The else is unnecessary if you assign bundlingStacks to the empty array earlier: let bundlingStacks = new Array<string>();

mrgrain · 2025-01-09T12:36:42Z

packages/aws-cdk/lib/api/cxapp/exec.ts

  context[cxapi.BUNDLING_STACKS] = bundlingStacks;

  debug('context:', context);

  return context;
 }

+function setBundlingStacks(config: Configuration) {


This works but is hard to parse for a human. In general I prefer this style:

// explain how this is even possible if (!config.command) { return []; } const stackCommands = [...]; // command doesn't operate on a stack selection if (!stackCommands.includes(config.command) { return []; } // If we deploy, diff, synth or watch a list of stacks exclusively we skip // bundling for all other stacks. if (config.settings.get(['exclusively']) && config.settings.get(['STACKS'])) { return config.settings.get(['STACKS']); } return ['**'];

mrgrain · 2025-01-09T12:38:15Z

packages/aws-cdk/lib/cli.ts

+  const configuration = new Configuration({
+    commandLineArguments: argv,
+  });
+  await configuration.load();
+  const settings = configuration.settings.all;


Side note: With that we still have the weird duplicity of having Configuration and Settings

mrgrain · 2025-01-09T12:40:48Z

packages/aws-cdk/lib/cli.ts

+        const diffOptions = settings.diff ?? {};
        return cli.diff({
-          stackNames: args.STACKS,
-          exclusively: args.exclusively,
-          templatePath: args.template,
-          strict: args.strict,
-          contextLines: args.contextLines,
-          securityOnly: args.securityOnly,
-          fail: args.fail != null ? args.fail : !enableDiffNoFail,
-          stream: args.ci ? process.stdout : undefined,
-          compareAgainstProcessedTemplate: args.processed,
-          quiet: args.quiet,
-          changeSet: args['change-set'],
+          stackNames: diffOptions.STACKS ?? [],
+          exclusively: diffOptions.exclusively,
+          templatePath: diffOptions.template,
+          strict: diffOptions.strict,
+          contextLines: diffOptions.contextLines,
+          securityOnly: diffOptions.securityOnly,
+          fail: diffOptions.fail != null ? diffOptions.fail : !enableDiffNoFail,
+          stream: globalOptions.ci ? process.stdout : undefined,
+          compareAgainstProcessedTemplate: diffOptions.processed,
+          quiet: diffOptions.quiet,
+          changeSet: diffOptions.changeSet,
          toolkitStackName: toolkitStackName,


This is good already, but ideally the next step would be a strongly typed helper function/method so we can do:

return cli.diff(diffSettingsToDiffOptions(settings.diff));

aws-cdk-automation · 2025-01-09T12:43:27Z

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32760/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.

kaizencc added 2 commits January 6, 2025 15:28

chore(cli): cli arguments with "count: true" are generated as number …

19d2e41

…types

chore(cli): refactor cli.ts to use CliArguments

2cc8fba

aws-cdk-automation requested a review from a team January 6, 2025 22:19

github-actions bot added the p2 label Jan 6, 2025

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

kaizencc requested a deployment to test-pipeline January 6, 2025 22:20 — with GitHub Actions Waiting

aws-cdk-automation requested changes Jan 6, 2025

View reviewed changes

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

kaizencc and others added 2 commits January 7, 2025 14:46

builds with test failures

4bc293d

Merge branch 'main' into conroy/refact

76281b7

kaizencc requested a deployment to test-pipeline January 7, 2025 19:47 — with GitHub Actions Waiting

kaizencc added 3 commits January 7, 2025 15:04

still builds

b4757bf

more building

957f079

Merge branch 'conroy/refact' of https://github.com/aws/aws-cdk into c…

d3e9d97

…onroy/refact

kaizencc requested a deployment to test-pipeline January 8, 2025 23:21 — with GitHub Actions Waiting

use settinsg

2ea4181

kaizencc requested a deployment to test-pipeline January 9, 2025 00:03 — with GitHub Actions Waiting

small chagne

a5e6e8c

kaizencc requested a deployment to test-pipeline January 9, 2025 00:50 — with GitHub Actions Waiting

kaizencc added 2 commits January 8, 2025 23:06

oneline

ed19731

updates

8564109

kaizencc requested a deployment to test-pipeline January 9, 2025 04:08 — with GitHub Actions Waiting

mrgrain requested changes Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(cli): refactor cli.ts to use `CliArguments` #32760

chore(cli): refactor cli.ts to use `CliArguments` #32760

kaizencc commented Jan 6, 2025

aws-cdk-automation left a comment

aws-cdk-automation commented Jan 9, 2025

aws-cdk-automation commented Jan 9, 2025

mrgrain Jan 9, 2025

mrgrain Jan 9, 2025

mrgrain Jan 9, 2025

mrgrain Jan 9, 2025

mrgrain Jan 9, 2025

mrgrain Jan 9, 2025

aws-cdk-automation commented Jan 9, 2025

	readonly action: ActionType;
	readonly action: GarbageCollectionAction;

chore(cli): refactor cli.ts to use CliArguments #32760

Are you sure you want to change the base?

chore(cli): refactor cli.ts to use CliArguments #32760

Conversation

kaizencc commented Jan 6, 2025

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Jan 9, 2025

aws-cdk-automation commented Jan 9, 2025

AWS CodeBuild CI Report

mrgrain Jan 9, 2025

Choose a reason for hiding this comment

mrgrain Jan 9, 2025

Choose a reason for hiding this comment

mrgrain Jan 9, 2025

Choose a reason for hiding this comment

mrgrain Jan 9, 2025

Choose a reason for hiding this comment

mrgrain Jan 9, 2025

Choose a reason for hiding this comment

mrgrain Jan 9, 2025

Choose a reason for hiding this comment

aws-cdk-automation commented Jan 9, 2025

chore(cli): refactor cli.ts to use `CliArguments` #32760

chore(cli): refactor cli.ts to use `CliArguments` #32760