Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(cli): remove source maps #32317

Merged
merged 4 commits into from
Nov 28, 2024
Merged

fix(cli): remove source maps #32317

merged 4 commits into from
Nov 28, 2024
+42 −9

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Nov 28, 2024

Remove the source maps from the bundled CLI. The source maps are not really useful for customers anyway, and have the following downsides:

There are 2 steps to producing a CLI build:

  • First compile with TypeScript -> JavaScript. Produces sourcemaps that are still being loaded.
  • Then bundle JavaScript -> bundle. This removes sourcemaps.

Developers running a local (non-bundled) build will benefit from the source maps generated by TypeScript.

Two other changes in this PR that came up around this:

  • Clarify what the --debug flag is for (debugging the CDK app) and what it's not for (debugging the CLI)
  • Only print the stack trace in a CLI error if we're on a developer build; due to the minification printing the stack trace on a bundled copy prints a 1000-character minified line which is not useful to anyone.

Closes #19930.

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

@rix0rrr
fix(cli): remove source maps
80876cb 
Remove the source maps from the bundled CLI. The source maps are not
really useful for customers anyway, and have the following downsides:

- They are 30+MB, which we vend to customers for no benefit.
- They tend to slow down Node as it loads and processes them. We have
  reports that on some Node versions this even leads to socket timeouts
  as the Node process was too busy loading source maps (#19930).

There are 2 steps to producing a CLI build:

- First compile with TypeScript -> JavaScript. Produces sourcemaps
  that are still being loaded.
- Then bundle JavaScript -> bundle. This removes sourcemaps.

Developers running a local (non-bundled) build will benefit from
the source maps generated by TypeScript.

Two other changes in this PR that came up around this:

* Clarify what the `--debug` flag is for (debugging the CDK app)
  and what it's not for (debugging the CLI)
* Only print the stack trace in a CLI error if we're on a developer
  build; due to the minification printing the stack trace on
  a bundled copy prints a 1000-character minified line which is not
  useful to anyone.
@rix0rrr rix0rrr requested a review from a team as a code owner November 28, 2024 10:24
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 labels Nov 28, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 28, 2024 10:24
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 28, 2024
aws-cdk-automation
aws-cdk-automation previously requested changes Nov 28, 2024
View reviewed changes
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Nov 28, 2024
@rix0rrr rix0rrr added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested labels Nov 28, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 28, 2024 10:32

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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-cli-test-run This PR needs CLI tests run against it. label Nov 28, 2024
@codecov Codecov
Copy link

codecov bot commented Nov 28, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.34%. Comparing base (62729ed) to head (764cc2a).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #32317      +/-   ##
==========================================
+ Coverage   78.22%   78.34%   +0.11%     
==========================================
  Files         105      105              
  Lines        7177     7170       -7     
  Branches     1318     1315       -3     
==========================================
+ Hits         5614     5617       +3     
+ Misses       1375     1365      -10     
  Partials      188      188
Flag Coverage Δ
suite.unit 78.34% <100.00%> (+0.11%) ⬆️

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

Components Coverage Δ
packages/aws-cdk 78.34% <100.00%> (+0.11%) ⬆️

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 28, 2024

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

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 28, 2024

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

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 28, 2024

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
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 512cf95 into main Nov 28, 2024
16 of 17 checks passed
@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 28, 2024

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

@mergify mergify bot deleted the huijbers/sourcemap-and-debug branch November 28, 2024 15:41
@github-actions GitHub Actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mrgrain mrgrain mrgrain approved these changes

@aws-cdk-automation aws-cdk-automation aws-cdk-automation left review comments

Assignees
No one assigned
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/medium Medium work item – several days of effort p1 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-test The PR linter will not require test changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

cli: Socket timed out without establishing a connection when --asset-parallelism=true
3 participants
@rix0rrr @aws-cdk-automation @mrgrain