feat(cli-lib): [JS/TS only] experimental support for programmatic CLI api #22836

mrgrain · 2022-11-08T19:23:49Z

Experimental wrapper around the existing aws-cdk package, which is possible due to minor adjustments in the cli.

The API interface is adapted from cdk-cli-wrapper. Currently all options are passed as array args to the existing cli args parser function. In future all code from aws-cdk should move over here and the dependency between the two would be reversed. When this is done we can start refactoring the internal APIs to be more programmatically usable.

What's in a name

Currently aiming for @aws-cdk/cli-lib, but any suggestions are welcome.

Why is this bundled?

To make the package a jsii library we need to bundle non-jsii dependencies. For now most of the code is still located in the aws-cdk package which has a different build pipeline to our other packages, simply including the directory in bundledDependencies is not an option. While the aim is to eventually have most code in this package, we are not there yet. Until then, bundling is the easiest option.

The build setup as configured for this package is needed because jsii MUST operate on TypeScript files and jsii-pacmak MUST be used because this is how the various language packages are created. Therefore bundling must happen after the jsii assembly has been created, but before jsii-pacmak runs.

We should not import submodules that are not explicitly exported

Yes, that's right we should not do this and no user land code should do this.
In this situation there are two things that make this "okay":

It's our package and we are in a monorepo. The danger of importing submodules is that they can break at any time, as they are usually considered implementation detail. However with the monorepo, the build would fail on any change that's not reflected in both packages.
It's supposed to be temporary. I plan to follow-up with a code move PR very quickly. Ideally this situation will only last for a couple releases.

All Submissions:

Have you followed the guidelines in our Contributing guide?

Adding new Unconventional Dependencies:

This PR adds new unconventional dependencies following the process described here

New Features

Have you added the new feature to an integration test?
- Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

gitpod-io · 2022-11-08T19:23:58Z

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.

mrgrain · 2022-11-08T19:38:35Z

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

@@ -0,0 +1,237 @@
+import * as core from '@aws-cdk/core';
+import { exec as runCli } from 'aws-cdk/lib';


Minimal example to proof this works with the bundled package:

npm install aws-cdk node -e "const { cli } = require('aws-cdk/lib'); cli()"

cli is the existing export. I have no reason to believe exec would behave any different. Any further proof is very tricky within the constraints of the build setup (the bundled version of aws-cdk is only created at package time and as a tarball).

Additionally confirmed this by taking the produced tarball from our test build pipeline and used it in an app.

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

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

packages/@aws-cdk/cli-lib/package.json

mrgrain · 2023-01-12T13:18:50Z

packages/aws-cdk/lib/init.ts

+    try {
+      const templatesDir = path.join(rootDir(), 'lib', 'init-templates');
+      const templateNames = await listDirectory(templatesDir);
+      const templates = new Array<InitTemplate>();
+      for (const templateName of templateNames) {
+        templates.push(await InitTemplate.fromName(templatesDir, templateName));
+      }
+      resolve(templates);
+    } catch {
+      resolve([]);


This code should not fail if the template directory cannot be found.

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

packages/@aws-cdk/cli-lib/package.json

packages/@aws-cdk/cli-lib/README.md

rix0rrr · 2023-01-13T11:20:36Z

packages/@aws-cdk/cli-lib/README.md

+### list
+
+```ts
+// await this asynchronous method call using a language feature


Oops! Missing Rosetta feature here I think

rix0rrr

Provisionally approved after you consider my questions

rix0rrr · 2023-01-17T15:26:10Z

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

+   * }
+   * ```
+   */
+  produce(context: Record<string, any>): Promise<string>


No environment?

If this library is used via jsii, then the process.env.CDK_DEFAULT_ACCOUNt = '1234'; statements will be executed in the Node process, which is separate from the JVM so System.getEnvironment('CDK_DEFAULT_ACCOUNT') will not find it.

Well that sucks. Now I have to think gain. 😭

Just pass the environment in and let the user deal with it.

rix0rrr · 2023-01-17T15:27:24Z

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

+  /**
+   * Create the CLI from a CloudAssemblyDirectoryProducer
+   */
+  public static fromCloudAssemblyDirectoryProducer(producer: ICloudAssemblyDirectoryProducer) {


Did we drop the fromCloudAssemblyDirectory constructor on purpose?

Yes, I think there's no point to it. If someone really wants to do this, they can do a stub producer:

{ produce: async () => '/path/to/assembly/dir' }

Ya but it looks nicer

But it's pretty useless! We can always add it later if people are asking for it. 🤷🏻‍♂️

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

mergify · 2023-01-18T15:29:56Z

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

this happens on any command, not just init

aws-cdk-automation · 2023-01-18T17:00:34Z

AWS CodeBuild CI Report

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

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

mergify · 2023-01-18T17:00:50Z

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 November 8, 2022 19:24

github-actions bot added the p2 label Nov 8, 2022

mergify bot added the contribution/core This is a PR that came from AWS. label Nov 8, 2022

aws-cdk-automation previously requested changes Nov 8, 2022

View reviewed changes

mrgrain added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Nov 8, 2022

mrgrain mentioned this pull request Nov 8, 2022

feat(cli-lib): experimental support for programatic CLI api #22790

Closed

4 tasks

mrgrain force-pushed the feat/cli-lib branch 2 times, most recently from 4daabfc to 746c163 Compare November 8, 2022 19:36

mrgrain commented Nov 8, 2022

View reviewed changes

mrgrain force-pushed the feat/cli-lib branch from 746c163 to becf42b Compare November 8, 2022 19:52

mrgrain added the pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested label Nov 10, 2022

rix0rrr reviewed Nov 22, 2022

View reviewed changes

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

packages/@aws-cdk/cli-lib/package.json Show resolved Hide resolved

packages/@aws-cdk/cli-lib/package.json Outdated Show resolved Hide resolved

packages/@aws-cdk/cli-lib/package.json Outdated Show resolved Hide resolved

mrgrain marked this pull request as draft November 22, 2022 15:51

rix0rrr mentioned this pull request Jan 5, 2023

aws-cdk: separate dependencies from devDependencies to work with pnpm #23182

Open

mrgrain force-pushed the feat/cli-lib branch from becf42b to ad4fbd1 Compare January 10, 2023 11:50

aws deleted a comment from aws-cdk-automation Jan 10, 2023

aws deleted a comment from aws-cdk-automation Jan 11, 2023

mrgrain force-pushed the feat/cli-lib branch from ccad243 to 8f35c34 Compare January 11, 2023 11:39

aws deleted a comment from aws-cdk-automation Jan 11, 2023

mrgrain force-pushed the feat/cli-lib branch 3 times, most recently from ba65d15 to 5335dc1 Compare January 11, 2023 23:07

aws deleted a comment from aws-cdk-automation Jan 11, 2023

mrgrain force-pushed the feat/cli-lib branch from 5335dc1 to b6e7e36 Compare January 11, 2023 23:51

aws deleted a comment from aws-cdk-automation Jan 12, 2023

mrgrain commented Jan 12, 2023

View reviewed changes

mrgrain force-pushed the feat/cli-lib branch from 9956651 to d82a2d0 Compare January 13, 2023 11:03

mrgrain added the pr/do-not-merge This PR should not be merged at this time. label Jan 13, 2023

rix0rrr reviewed Jan 13, 2023

View reviewed changes

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

packages/@aws-cdk/cli-lib/package.json Outdated Show resolved Hide resolved

rix0rrr reviewed Jan 13, 2023

View reviewed changes

packages/@aws-cdk/cli-lib/README.md Outdated Show resolved Hide resolved

rix0rrr reviewed Jan 13, 2023

View reviewed changes

mrgrain marked this pull request as draft January 14, 2023 17:10

mrgrain force-pushed the feat/cli-lib branch 7 times, most recently from cd999c2 to 47bd963 Compare January 17, 2023 15:21

mrgrain marked this pull request as ready for review January 17, 2023 15:23

rix0rrr approved these changes Jan 17, 2023

View reviewed changes

rix0rrr reviewed Jan 17, 2023

View reviewed changes

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

rix0rrr reviewed Jan 17, 2023

View reviewed changes

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

rix0rrr changed the title ~~feat(cli-lib): experimental support for programatic CLI api~~ feat(cli-lib): experimental support for programmatic CLI api Jan 18, 2023

mrgrain changed the title ~~feat(cli-lib): experimental support for programmatic CLI api~~ feat(cli-lib): [JS/TS only] experimental support for programmatic CLI api Jan 18, 2023

mrgrain removed the pr/do-not-merge This PR should not be merged at this time. label Jan 18, 2023

mrgrain added 3 commits January 18, 2023 16:19

fix(aws-cdk): cli always throws when init-templates are not available

df6dbde

this happens on any command, not just init

chore(individual-pkg-gen): support dev dependency only on @aws-cdk/core

fafccdf

feat(cli-lib): experimental support for programmatic CLI api

cc860a9

mrgrain force-pushed the feat/cli-lib branch from ccf3bf9 to cc860a9 Compare January 18, 2023 16:19

mergify bot merged commit 0b6b716 into aws:main Jan 18, 2023

mrgrain deleted the feat/cli-lib branch January 18, 2023 23:48

filletofish mentioned this pull request Jul 2, 2023

feat(scheduler): ScheduleGroup #26196

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli-lib): [JS/TS only] experimental support for programmatic CLI api #22836

feat(cli-lib): [JS/TS only] experimental support for programmatic CLI api #22836

mrgrain commented Nov 8, 2022 •

edited

Loading

gitpod-io bot commented Nov 8, 2022

aws-cdk-automation left a comment

mrgrain Nov 8, 2022

mrgrain Jan 13, 2023

mrgrain Jan 12, 2023

rix0rrr Jan 13, 2023

mrgrain Jan 13, 2023

rix0rrr left a comment

rix0rrr Jan 17, 2023

mrgrain Jan 17, 2023

rix0rrr Jan 17, 2023

rix0rrr Jan 17, 2023

mrgrain Jan 17, 2023 •

edited

Loading

rix0rrr Jan 17, 2023

mrgrain Jan 17, 2023 •

edited

Loading

mergify bot commented Jan 18, 2023

aws-cdk-automation commented Jan 18, 2023

mergify bot commented Jan 18, 2023

		@@ -0,0 +1,237 @@
		import * as core from '@aws-cdk/core';
		import { exec as runCli } from 'aws-cdk/lib';

feat(cli-lib): [JS/TS only] experimental support for programmatic CLI api #22836

feat(cli-lib): [JS/TS only] experimental support for programmatic CLI api #22836

Conversation

mrgrain commented Nov 8, 2022 • edited Loading

What's in a name

Why is this bundled?

We should not import submodules that are not explicitly exported

All Submissions:

Adding new Unconventional Dependencies:

New Features

gitpod-io bot commented Nov 8, 2022

aws-cdk-automation 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

rix0rrr 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

mrgrain Jan 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrgrain Jan 17, 2023 • edited Loading

Choose a reason for hiding this comment

mergify bot commented Jan 18, 2023

aws-cdk-automation commented Jan 18, 2023

AWS CodeBuild CI Report

mergify bot commented Jan 18, 2023

mrgrain commented Nov 8, 2022 •

edited

Loading

mrgrain Jan 17, 2023 •

edited

Loading

mrgrain Jan 17, 2023 •

edited

Loading