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

Add copyResponse and more granular stream detects #2193

Merged
merged 2 commits into from
Aug 21, 2019
Merged

Conversation

philipwalton
Copy link
Member

R: @jeffposnick

Fixes #2023

This PR replaces #2128 and implements the resolution from the discussion there. It adds two new, more granular feature detects for streams to workbox-core:

  • canConstructReadableStream()
  • canConstructResponseFromBodyStream()

And these features are used by other stream-related code to detect support.

Also, based on the feature request proposed in #2023, it adds a copyResponse() function that allows you to copy a response and modify any of the values settable via the ResponseInit object (headers, status, statusText).

The API I've landed on in this PR (totally open to suggestions though) is a function that takes a response and a modifier() function, here's an example (you can also see other examples in the test file):

const newResponse = await copyResponse(oldResponse, (init) => {
  init.headers.set('Content-Type', 'text/plain');
  init.headers.set('X-One', '1');
  init.status = 203;
  init.statusText = 'Really?';

  return init;
});

In addition, as currently implement, the modifier() function is optional, and if not passed then no modifications are made. This is equivalent to the old cleanRedirect() function that this PR removes. (I'm not sure if it's weird to have the modifier() function be optional. If you think it is, I can make it required and just have it be a no-op in the redirect case.)

Copy link
Contributor

@jeffposnick jeffposnick 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 taking this approach.

(There are some test things to clean up before merging.)

@workbox-pr-bot
Copy link
Collaborator

PR-Bot Size Plugin

Changed File Sizes

File Before After Change GZipped
packages/workbox-core/build/workbox-core.prod.js 5.94 KB 6.42 KB +8% 2.66 KB
packages/workbox-precaching/build/workbox-precaching.prod.js 4.99 KB 4.84 KB -3% 1.87 KB
packages/workbox-streams/build/workbox-streams.prod.js 1.46 KB 1.44 KB -2% 699 B

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.02 KB 1.02 KB 0% 578 B
packages/workbox-build/build/_types.js 41 B 41 B 0% 61 B
packages/workbox-build/build/generate-sw.js 1.99 KB 1.99 KB 0% 966 B
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.13 KB 3.13 KB 0% 1.36 KB
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js 611 B 611 B 0% 357 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 5.94 KB 6.42 KB +8% 2.66 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% 916 B
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js 660 B 660 B 0% 323 B
packages/workbox-precaching/build/workbox-precaching.prod.js 4.99 KB 4.84 KB -3% 1.87 KB
packages/workbox-range-requests/build/workbox-range-requests.prod.js 1.58 KB 1.58 KB 0% 801 B
packages/workbox-routing/build/workbox-routing.prod.js 3.09 KB 3.09 KB 0% 1.36 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.46 KB 1.44 KB -2% 699 B
packages/workbox-sw/build/workbox-sw.js 1.34 KB 1.34 KB 0% 748 B
packages/workbox-webpack-plugin/build/generate-sw.js 4.21 KB 4.21 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 5.10 KB 0% 1.77 KB
packages/workbox-window/build/workbox-window.dev.umd.js 40.62 KB 40.62 KB 0% 8.92 KB
packages/workbox-window/build/workbox-window.prod.umd.js 4.48 KB 4.48 KB 0% 1.83 KB

Workbox Aggregate Size Plugin

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

@philipwalton philipwalton merged commit bd01715 into master Aug 21, 2019
@philipwalton philipwalton deleted the copy-response branch August 21, 2019 16:37
@philipwalton
Copy link
Member Author

Also fixes #2129

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.

The cleanRedirect logic fails in Edge 18
3 participants