chore: publish /src to npm and other fixes for sourcemap debugging #1462
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
justingrant
changed the title
This was referenced Aug 25, 2020
justingrant
changed the title
|
Hi @justingrant, we recently merged the change that would unblock the CodeBuild test failure. Can you rebase this PR? |
Crrently, SDKV3 publishes sourcemaps to npm but doesn't publish source files that those sourcemaps point to. This missing source files breaks debugging use-cases, especially for VSCode users because the VSCode debugger relies on source files for setting breakpoints in the debugger, for debugger call stacks, for "step into" original source, and any other debugger use-cases. Even outside of debugging use-cases, it's helpful for developers consuming transpiled libraries to have original source so they can better understand what the library is doing. Finally, some tools will show warnings when sourcemaps are present but source files are missing, and this commit will fix these warnings.
justingrant
force-pushed
the
fix-sourcemaps-2020-08-25
branch
from
a5980ea
to
b359ee5
Compare
|
@AllanFly120 - Rebased as requested. No merge conflicts. Thanks! |
Codecov Report
@@ Coverage Diff @@
## master #1462 +/- ##
==========================================
- Coverage 79.80% 79.71% -0.09%
==========================================
Files 298 302 +4
Lines 11502 11678 +176
Branches 2475 2489 +14
==========================================
+ Hits 9179 9309 +130
- Misses 2323 2369 +46
Continue to review full report at Codecov.
|
trivikr
requested review from
AllanZhengYP
and removed request for
AllanZhengYP
alexforsyth
changed the title
Codecov Report
@@ Coverage Diff @@
## master #1462 +/- ##
==========================================
- Coverage 79.80% 79.71% -0.09%
==========================================
Files 298 302 +4
Lines 11502 11678 +176
Branches 2475 2489 +14
==========================================
+ Hits 9179 9309 +130
- Misses 2323 2369 +46
Continue to review full report at Codecov.
|
AllanZhengYP
approved these changes
Oct 7, 2020
AllanZhengYP
added a commit
to AllanZhengYP/aws-sdk-js-v3
that referenced
this pull request
Oct 7, 2020
follow up to aws#1462
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces #393. @trivikr closed that PR in January 2020 because another PR was supposed to include the same fixes, but #393 contained other fixes to problems that are still broken. Hence this PR with the remaining fixes, including updates to account for changes since Jan 2020. Content below is shamelessly copied from #393.
Currently, SDKV3 publishes sourcemaps to npm but doesn't publish the source files that those sourcemaps point to. This missing source files breaks debugging use-cases, especially for VSCode users because the VSCode debugger relies on source files for setting breakpoints in the debugger, for debugger call stacks, for "step into" original source, and any other debugger use-cases. Even outside of debugging use-cases, it's helpful for developers consuming transpiled libraries to have original source so they can better understand what the library is doing. Finally, some tools will show warnings when sourcemaps are present but source files are missing, and this PR will fix these warnings.
This PR:
jest.config.jsand*.spec.tsto non-client packages' .npmignore because test files shouldn't be in an NPM download.Removes(This is the one part of fix: remove /src/ from .npmignore (for sourcemaps) #393 that is already fixed so is excluded from this PR)*.tsfrom npm for client packages. (also removes!*.d.tswhich is now unnecessary)sourceRoottorootDirin tsconfig.json. The latter setting is used by all other SDKV3 packages, and it produces sourcemaps with an emptysourceRootfield. This is ideal, because thesourceRootfeature turned out to be buggy in some sourcemap-reading and sourcemap-writing tools. Leaving it blank maximizes compatibility with more tools.This PR is similar to aws/aws-sdk-js-crypto-helpers#5 in the AWS Crypto Helpers library, and aws-amplify/amplify-js#2680 which made similar changes to AWS Amplify library earlier this year.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.