fix(bundling): enclosing metafile & tsconfig paths with quotes #32725

aaarichter · 2025-01-03T15:27:00Z

Issue # (if applicable)

No

Reason for this change

Generating the metafile in a Windows environment can fail when the path are not enclosed with quotes.

Description of changes

What code changes did you make?

Enclosed paths the bundling arguments --metafile and --tsconfig

Have you made any important design decisions?

No

What AWS use cases does this change enable? To enable the use cases, which AWS service features are utilized?

Allows safe usage of metafile and tsconfig bundling options

Describe any new or updated permissions being added

<!— What new or updated IAM permissions are needed to support the changes being introduced ? -->

Description of how you validated changes

Have you added any unit tests and/or integration tests?

No, but when you have a project path with a whitespace, and use the metafile bundling argument, the metafile path should be passed correctly within quotes to esbuild.

I updated the existing tests.

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.

aaarichter · 2025-01-03T15:57:05Z

I have no idea what to do

The pull request linter fails with the following errors:

❌ Fixes must contain a change to an integration test file and the resulting snapshot.
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.

why doesn't this text say what integration file needs to be adjusted ?!!?

samson-keung · 2025-01-03T23:01:18Z

packages/@aws-cdk/custom-resource-handlers/package.json

@@ -4,13 +4,13 @@
  "private": true,
  "version": "0.0.0",
  "scripts": {
-    "build": "tsc -b && node scripts/generate.js",
+    "build": "cdk-build",


Does the cdk-build command do the same thing? I am not familiar with it. Do you mind pointing me to where the command is implemented? 🙏

@samson-keung hey - sry I'm not sure how this ended up here. I might have run some commands from the markdown files but I'm going to revert anything that is not related to adding quotes

samson-keung · 2025-01-03T23:01:31Z

packages/@aws-cdk/custom-resource-handlers/package.json

    "integ": "integ-runner --language javascript",
    "lint": "cdk-lint",
    "package": "cdk-package",
    "awslint": "cdk-awslint",
    "pkglint": "pkglint -f",
-    "test": "jest",
+    "test": "cdk-test",


Same as above

samson-keung · 2025-01-03T23:02:25Z

packages/aws-cdk/lib/parse-command-line-arguments.ts

@@ -730,7 +729,7 @@ export function parseCommandLineArguments(args: Array<string>): any {
          type: 'string',
          alias: 'l',
          desc: 'The language to be used for the new project (default can be configured in ~/.cdk.json)',
-          choices: ['csharp', 'fsharp', 'go', 'java', 'javascript', 'python', 'typescript'],
+          choices: ['app.iml', 'csharp', 'fsharp', 'go', 'java', 'javascript', 'python', 'typescript'],


Is this intentional? Do you mind explaining what this change does?

hey @samson-keung this change somehow got generated by some of the script commands in the package.json. It is unintentional.

I'll revert this and other unintended changes.

aaarichter · 2025-01-04T21:45:39Z

@samson-keung reverted accidental changes. I'm not sure about the artifacts for/of the integration changes and how to generate these

samson-keung · 2025-01-07T20:33:22Z

Thanks for updating the PR. LGTM. I have pinged the CLI team to review as well.

aws-cdk-automation · 2025-01-08T17:22:21Z

The pull request linter fails with the following errors:

❌ Fixes must contain a change to an integration test file and the resulting snapshot.

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-08T17:42:59Z

AWS CodeBuild CI Report

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

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

samson-keung · 2025-01-08T17:51:15Z

@aaarichter I see two integ tests failed. The relevant log snippet:

@aws-cdk-testing/framework-integ: Snapshot Results: 
@aws-cdk-testing/framework-integ: Tests:    2 failed, 1043 total
@aws-cdk-testing/framework-integ: Failed: /codebuild/output/src1910170678/src/github.com/aws/aws-cdk/packages/@aws-cdk-testing/framework-integ/test/aws-lambda-nodejs/test/integ.dependencies-bun.js
@aws-cdk-testing/framework-integ: Failed: /codebuild/output/src1910170678/src/github.com/aws/aws-cdk/packages/@aws-cdk-testing/framework-integ/test/aws-lambda-nodejs/test/integ.function.js
@aws-cdk/aws-scheduler-targets-alpha: Verifying integration test snapshots...
@aws-cdk-testing/framework-integ: Error: Some tests failed!
@aws-cdk-testing/framework-integ: To re-run failed tests run: integ-runner --update-on-failed
@aws-cdk-testing/framework-integ:     at main (/codebuild/output/src1910170678/src/github.com/aws/aws-cdk/packages/@aws-cdk/integ-runner/lib/cli.js:192:19)
@aws-cdk-testing/framework-integ: Error: integ-runner exited with error code 1
@aws-cdk-testing/framework-integ: Tests failed. Total time (2m19.6s) | integ-runner (2m10.4s) | /codebuild/output/src1910170678/src/github.com/aws/aws-cdk/node_modules/jest/bin/jest.js (8.3s)

Are you able to run and update them? Instructions can be found in https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#testing

aws-cdk-automation requested a review from a team January 3, 2025 15:27

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Jan 3, 2025

aws-cdk-automation requested changes Jan 3, 2025

View reviewed changes

fix(bundling): enclosing paths with quotes

f62e4dd

aaarichter force-pushed the fix/eslint-parameter-enclose branch from 1cc72bc to f62e4dd Compare January 3, 2025 15:37

test: update integration tests to include metafile & tsconfig path

e90709c

aaarichter requested a review from a team as a code owner January 3, 2025 20:20

aaarichter requested a deployment to test-pipeline January 3, 2025 20:21 — with GitHub Actions Waiting

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

samson-keung reviewed Jan 3, 2025

View reviewed changes

revert: whatever changed these

bc7e687

aaarichter requested a review from samson-keung January 7, 2025 05:58

samson-keung approved these changes Jan 7, 2025

View reviewed changes

jiayiwang7 assigned iliapolo Jan 8, 2025

Merge branch 'main' into fix/eslint-parameter-enclose

e2a7db8

samson-keung assigned samson-keung and unassigned iliapolo Jan 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(bundling): enclosing metafile & tsconfig paths with quotes #32725

fix(bundling): enclosing metafile & tsconfig paths with quotes #32725

aaarichter commented Jan 3, 2025 •

edited

Loading

aws-cdk-automation left a comment

aaarichter commented Jan 3, 2025

samson-keung Jan 3, 2025

aaarichter Jan 4, 2025

samson-keung Jan 3, 2025

samson-keung Jan 3, 2025

aaarichter Jan 4, 2025

aaarichter commented Jan 4, 2025

samson-keung commented Jan 7, 2025

aws-cdk-automation commented Jan 8, 2025

aws-cdk-automation commented Jan 8, 2025

samson-keung commented Jan 8, 2025

fix(bundling): enclosing metafile & tsconfig paths with quotes #32725

Are you sure you want to change the base?

fix(bundling): enclosing metafile & tsconfig paths with quotes #32725

Conversation

aaarichter commented Jan 3, 2025 • edited Loading

Issue # (if applicable)

Reason for this change

Description of changes

What code changes did you make?

Have you made any important design decisions?

What AWS use cases does this change enable? To enable the use cases, which AWS service features are utilized?

Describe any new or updated permissions being added

Description of how you validated changes

Have you added any unit tests and/or integration tests?

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

aaarichter commented Jan 3, 2025

samson-keung Jan 3, 2025

Choose a reason for hiding this comment

aaarichter Jan 4, 2025

Choose a reason for hiding this comment

samson-keung Jan 3, 2025

Choose a reason for hiding this comment

samson-keung Jan 3, 2025

Choose a reason for hiding this comment

aaarichter Jan 4, 2025

Choose a reason for hiding this comment

aaarichter commented Jan 4, 2025

samson-keung commented Jan 7, 2025

aws-cdk-automation commented Jan 8, 2025

aws-cdk-automation commented Jan 8, 2025

AWS CodeBuild CI Report

samson-keung commented Jan 8, 2025

aaarichter commented Jan 3, 2025 •

edited

Loading