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.

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

Account for injectManifest replacements in sourcemaps #2239

Merged
merged 4 commits into from
Oct 1, 2019

Conversation

jeffposnick
Copy link
Contributor

R: @philipwalton

Fixes #2235

This was quite a rabbit hole to go down.

Ultimately, I think the code that I ended up with to modify an existing sourcemap to account for the injected manifest does the job, but I would not be shocked if there are some edge cases that I'm not aware of.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.2%) to 79.191% when pulling 2067e7d on fix-source-map into 5fc46f0 on master.

Copy link
Member

@philipwalton philipwalton left a comment

Choose a reason for hiding this comment

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

Thanks for tackling this! I know working with source maps is complex, so if there are any edge cases we can address them as they arise.

@workbox-pr-bot
Copy link
Collaborator

PR-Bot Size Plugin

Changed File Sizes

File Before After Change GZipped
packages/workbox-build/build/inject-manifest.js 3.67 KB 4.93 KB +34% 1.90 KB ☠️
packages/workbox-range-requests/build/workbox-range-requests.prod.js 1.64 KB 1.58 KB -3% 800 B
packages/workbox-webpack-plugin/build/inject-manifest.js 5.10 KB 6.94 KB +36% 2.33 KB ☠️

New Files

No new files have been added.

All File Sizes

View Table
File Before After Change GZipped
packages/workbox-background-sync/build/workbox-background-sync.prod.js 3.87 KB 3.87 KB 0% 1.60 KB
packages/workbox-broadcast-update/build/workbox-broadcast-update.prod.js 1.27 KB 1.27 KB 0% 700 B
packages/workbox-build/build/_types.js 41 B 41 B 0% 61 B
packages/workbox-build/build/generate-sw.js 2.75 KB 2.75 KB 0% 1.23 KB
packages/workbox-build/build/get-manifest.js 1.60 KB 1.60 KB 0% 779 B
packages/workbox-build/build/index.js 613 B 613 B 0% 344 B
packages/workbox-build/build/inject-manifest.js 3.67 KB 4.93 KB +34% 1.90 KB ☠️
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js 610 B 610 B 0% 356 B
packages/workbox-cli/build/app.js 4.16 KB 4.16 KB 0% 1.64 KB
packages/workbox-cli/build/bin.js 940 B 940 B 0% 502 B
packages/workbox-core/build/workbox-core.prod.js 6.80 KB 6.80 KB 0% 2.82 KB
packages/workbox-expiration/build/workbox-expiration.prod.js 2.95 KB 2.95 KB 0% 1.27 KB
packages/workbox-google-analytics/build/workbox-offline-ga.prod.js 1.97 KB 1.97 KB 0% 915 B
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js 659 B 659 B 0% 322 B
packages/workbox-precaching/build/workbox-precaching.prod.js 4.95 KB 4.95 KB 0% 1.92 KB
packages/workbox-range-requests/build/workbox-range-requests.prod.js 1.64 KB 1.58 KB -3% 800 B
packages/workbox-routing/build/workbox-routing.prod.js 3.09 KB 3.09 KB 0% 1.35 KB
packages/workbox-strategies/build/workbox-strategies.prod.js 4.10 KB 4.10 KB 0% 1.13 KB
packages/workbox-streams/build/workbox-streams.prod.js 1.44 KB 1.44 KB 0% 697 B
packages/workbox-sw/build/workbox-sw.js 1.34 KB 1.34 KB 0% 746 B
packages/workbox-webpack-plugin/build/generate-sw.js 4.22 KB 4.22 KB 0% 1.61 KB
packages/workbox-webpack-plugin/build/index.js 349 B 349 B 0% 255 B
packages/workbox-webpack-plugin/build/inject-manifest.js 5.10 KB 6.94 KB +36% 2.33 KB ☠️
packages/workbox-window/build/workbox-window.dev.umd.js 41.51 KB 41.51 KB 0% 9.20 KB
packages/workbox-window/build/workbox-window.prod.umd.js 4.52 KB 4.52 KB 0% 1.85 KB

Workbox Aggregate Size Plugin

3.51KB gzip'ed (23% of limit)
7.93KB uncompressed

Copy link

@steverep steverep left a comment

Choose a reason for hiding this comment

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

I filed #3233 thinking there was no support in injectManifest, but I now see the root issues per my comments below. In short, the source map file and reference URL in the new source file will only be correct when swSrc and swDest are in different directories with the same filename, with their corresponding maps in the same folders.

// See https://github.com/GoogleChrome/workbox/issues/2235
if (url) {
const sourcemapSrcPath = upath.resolve(upath.dirname(options.swSrc), url);
const sourcemapDestPath = upath.resolve(upath.dirname(options.swDest), url);

Choose a reason for hiding this comment

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

This will always keep the same source map filename, and if swSrc and swDest are in the same folder, it'll overwrite the original source map file.

Instead, this should just append ".map" to swDest.


return {
map: JSON.stringify(updatedSourceMap),
source: src,

Choose a reason for hiding this comment

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

This is returned without changing the URL of the source map to reflect the filename in swDest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Webpack InjectManifest plugin produces incorrect source maps in Webpack production mode
5 participants