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

Adds cacheKeyWillBeUsed lifecycle callback #1990

Merged
merged 4 commits into from
Mar 28, 2019
Merged

Conversation

jeffposnick
Copy link
Contributor

R: @philipwalton

Fixes #1709

This adds a new cacheKeyWillBeUsed lifecycle callback, following the interface described at #1709 (comment). This allows developers to override the default cache key for reads or writes (or both), for requests that pass through our cacheWrapper interface.

Once it's released, we'll need to update https://developers.google.com/web/tools/workbox/guides/using-plugins with info on usage.

packages/workbox-core/_private/cacheWrapper.mjs Outdated Show resolved Hide resolved
packages/workbox-core/_private/cacheWrapper.mjs Outdated Show resolved Hide resolved
test/workbox-core/sw/_private/test-cacheWrapper.mjs Outdated Show resolved Hide resolved
test/workbox-core/sw/_private/test-cacheWrapper.mjs Outdated Show resolved Hide resolved
@@ -366,5 +443,78 @@ describe(`cacheWrapper`, function() {
expect(spyOne.callCount).to.equal(1);
expect(spyTwo.callCount).to.equal(1);
});

it(`should call cacheKeyWillBeUsed`, async function() {
Copy link
Member

Choose a reason for hiding this comment

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

Repeat code? Looks like these two tests are the same as the ones above.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They're in different describe() blocks—one for .put() and the other for .match(). The actual test cases are different, too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In particular, the tests confirm that the correct mode value ('read' or 'write') is passed in to the plugin, and that the underlying cache.match() or cache.put() operation is actually called with the plugin's return value.

Copy link
Member

Choose a reason for hiding this comment

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

Ahh, I see. I couldn't easily see the outer blocks from the diff.

@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.34 KB 5.63 KB +5% 2.38 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.40 KB 3.40 KB 0% 1.47 KB
packages/workbox-broadcast-update/build/workbox-broadcast-update.prod.js 1.89 KB 1.89 KB 0% 944 B
packages/workbox-build/build/_types.js 41 B 41 B 0% 61 B
packages/workbox-build/build/index.js 3.64 KB 3.64 KB 0% 1.36 KB
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js 579 B 579 B 0% 344 B
packages/workbox-cli/build/app.js 5.58 KB 5.58 KB 0% 1.98 KB
packages/workbox-cli/build/bin.js 1.16 KB 1.16 KB 0% 580 B
packages/workbox-core/build/workbox-core.prod.js 5.34 KB 5.63 KB +5% 2.38 KB
packages/workbox-expiration/build/workbox-expiration.prod.js 2.89 KB 2.89 KB 0% 1.25 KB
packages/workbox-google-analytics/build/workbox-offline-ga.prod.js 1.89 KB 1.89 KB 0% 898 B
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js 652 B 652 B 0% 317 B
packages/workbox-precaching/build/workbox-precaching.prod.js 4.24 KB 4.24 KB 0% 1.70 KB
packages/workbox-range-requests/build/workbox-range-requests.prod.js 1.51 KB 1.51 KB 0% 757 B
packages/workbox-routing/build/workbox-routing.prod.js 3.38 KB 3.38 KB 0% 1.47 KB
packages/workbox-strategies/build/workbox-strategies.prod.js 4.86 KB 4.86 KB 0% 1.19 KB
packages/workbox-streams/build/workbox-streams.prod.js 1.38 KB 1.38 KB 0% 678 B
packages/workbox-sw/build/workbox-sw.js 1.33 KB 1.33 KB 0% 740 B
packages/workbox-webpack-plugin/build/generate-sw.js 5.29 KB 5.29 KB 0% 1.84 KB
packages/workbox-webpack-plugin/build/index.js 349 B 349 B 0% 255 B
packages/workbox-webpack-plugin/build/inject-manifest.js 7.22 KB 7.22 KB 0% 2.48 KB
packages/workbox-window/build/workbox-window.dev.umd.js 30.34 KB 30.34 KB 0% 8.06 KB
packages/workbox-window/build/workbox-window.prod.umd.js 4.54 KB 4.54 KB 0% 1.82 KB

Workbox Aggregate Size Plugin

8.86KB gzip'ed (59% of limit)
22.38KB uncompressed

@jeffposnick jeffposnick merged commit f327ba0 into master Mar 28, 2019
@jeffposnick jeffposnick deleted the cache-key-will-be-used branch March 28, 2019 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants