@serwist/precaching 8.4.3 → 9.0.0-preview.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/PrecacheController.d.ts +4 -3
- package/dist/PrecacheController.d.ts.map +1 -0
- package/dist/PrecacheFallbackPlugin.d.ts +1 -0
- package/dist/PrecacheFallbackPlugin.d.ts.map +1 -0
- package/dist/PrecacheRoute.d.ts +1 -0
- package/dist/PrecacheRoute.d.ts.map +1 -0
- package/dist/PrecacheStrategy.d.ts +1 -0
- package/dist/PrecacheStrategy.d.ts.map +1 -0
- package/dist/_types.d.ts +3 -2
- package/dist/_types.d.ts.map +1 -0
- package/dist/addPlugins.d.ts +1 -0
- package/dist/addPlugins.d.ts.map +1 -0
- package/dist/addRoute.d.ts +1 -0
- package/dist/addRoute.d.ts.map +1 -0
- package/dist/cleanupOutdatedCaches.d.ts +1 -0
- package/dist/cleanupOutdatedCaches.d.ts.map +1 -0
- package/dist/createHandlerBoundToURL.d.ts +1 -0
- package/dist/createHandlerBoundToURL.d.ts.map +1 -0
- package/dist/getCacheKeyForURL.d.ts +1 -0
- package/dist/getCacheKeyForURL.d.ts.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/matchPrecache.d.ts +1 -0
- package/dist/matchPrecache.d.ts.map +1 -0
- package/dist/precache.d.ts +2 -1
- package/dist/precache.d.ts.map +1 -0
- package/dist/precacheAndRoute.d.ts +2 -1
- package/dist/precacheAndRoute.d.ts.map +1 -0
- package/dist/utils/PrecacheCacheKeyPlugin.d.ts +1 -0
- package/dist/utils/PrecacheCacheKeyPlugin.d.ts.map +1 -0
- package/dist/utils/PrecacheInstallReportPlugin.d.ts +1 -0
- package/dist/utils/PrecacheInstallReportPlugin.d.ts.map +1 -0
- package/dist/utils/createCacheKey.d.ts +1 -0
- package/dist/utils/createCacheKey.d.ts.map +1 -0
- package/dist/utils/deleteOutdatedCaches.d.ts +1 -0
- package/dist/utils/deleteOutdatedCaches.d.ts.map +1 -0
- package/dist/utils/generateURLVariations.d.ts +1 -0
- package/dist/utils/generateURLVariations.d.ts.map +1 -0
- package/dist/utils/getCacheKeyForURL.d.ts +1 -0
- package/dist/utils/getCacheKeyForURL.d.ts.map +1 -0
- package/dist/utils/getOrCreatePrecacheController.d.ts +1 -0
- package/dist/utils/getOrCreatePrecacheController.d.ts.map +1 -0
- package/dist/utils/printCleanupDetails.d.ts +1 -0
- package/dist/utils/printCleanupDetails.d.ts.map +1 -0
- package/dist/utils/printInstallDetails.d.ts +1 -0
- package/dist/utils/printInstallDetails.d.ts.map +1 -0
- package/dist/utils/removeIgnoredSearchParams.d.ts +1 -0
- package/dist/utils/removeIgnoredSearchParams.d.ts.map +1 -0
- package/package.json +20 -18
- package/src/PrecacheController.ts +331 -0
- package/src/PrecacheFallbackPlugin.ts +61 -0
- package/src/PrecacheRoute.ts +50 -0
- package/src/PrecacheStrategy.ts +239 -0
- package/src/_types.ts +46 -0
- package/src/addPlugins.ts +23 -0
- package/src/addRoute.ts +33 -0
- package/src/cleanupOutdatedCaches.ts +34 -0
- package/src/createHandlerBoundToURL.ts +32 -0
- package/src/getCacheKeyForURL.ts +33 -0
- package/{dist/index.d.cts → src/index.ts} +25 -1
- package/src/matchPrecache.ts +28 -0
- package/src/precache.ts +33 -0
- package/src/precacheAndRoute.ts +29 -0
- package/src/utils/PrecacheCacheKeyPlugin.ts +36 -0
- package/src/utils/PrecacheInstallReportPlugin.ts +49 -0
- package/src/utils/createCacheKey.ts +68 -0
- package/src/utils/deleteOutdatedCaches.ts +42 -0
- package/src/utils/generateURLVariations.ts +55 -0
- package/src/utils/getCacheKeyForURL.ts +36 -0
- package/src/utils/getOrCreatePrecacheController.ts +22 -0
- package/src/utils/printCleanupDetails.ts +38 -0
- package/src/utils/printInstallDetails.ts +53 -0
- package/src/utils/removeIgnoredSearchParams.ts +29 -0
- package/dist/index.cjs +0 -930
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2019 Google LLC
|
|
3
|
+
|
|
4
|
+
Use of this source code is governed by an MIT-style
|
|
5
|
+
license that can be found in the LICENSE file or at
|
|
6
|
+
https://opensource.org/licenses/MIT.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import type { RouteHandlerCallback, SerwistPlugin } from "@serwist/core";
|
|
10
|
+
import { assert, SerwistError, logger, privateCacheNames, waitUntil } from "@serwist/core/internal";
|
|
11
|
+
import type { Strategy } from "@serwist/strategies";
|
|
12
|
+
|
|
13
|
+
import { PrecacheStrategy } from "./PrecacheStrategy.js";
|
|
14
|
+
import type { CleanupResult, InstallResult, PrecacheEntry } from "./_types.js";
|
|
15
|
+
import { PrecacheCacheKeyPlugin } from "./utils/PrecacheCacheKeyPlugin.js";
|
|
16
|
+
import { PrecacheInstallReportPlugin } from "./utils/PrecacheInstallReportPlugin.js";
|
|
17
|
+
import { createCacheKey } from "./utils/createCacheKey.js";
|
|
18
|
+
import { printCleanupDetails } from "./utils/printCleanupDetails.js";
|
|
19
|
+
import { printInstallDetails } from "./utils/printInstallDetails.js";
|
|
20
|
+
|
|
21
|
+
// Give TypeScript the correct global.
|
|
22
|
+
declare let self: ServiceWorkerGlobalScope;
|
|
23
|
+
|
|
24
|
+
interface PrecacheControllerOptions {
|
|
25
|
+
/**
|
|
26
|
+
* The cache to use for precaching.
|
|
27
|
+
*/
|
|
28
|
+
cacheName?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Plugins to use when precaching as well as responding to fetch
|
|
31
|
+
* events for precached assets.
|
|
32
|
+
*/
|
|
33
|
+
plugins?: SerwistPlugin[];
|
|
34
|
+
/**
|
|
35
|
+
* Whether to attempt to get the response from the network if there's
|
|
36
|
+
* a precache miss.
|
|
37
|
+
*/
|
|
38
|
+
fallbackToNetwork?: boolean;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Performs efficient precaching of assets.
|
|
43
|
+
*/
|
|
44
|
+
class PrecacheController {
|
|
45
|
+
private _installAndActiveListenersAdded?: boolean;
|
|
46
|
+
private readonly _strategy: Strategy;
|
|
47
|
+
private readonly _urlsToCacheKeys: Map<string, string> = new Map();
|
|
48
|
+
private readonly _urlsToCacheModes: Map<string, "reload" | "default" | "no-store" | "no-cache" | "force-cache" | "only-if-cached"> = new Map();
|
|
49
|
+
private readonly _cacheKeysToIntegrities: Map<string, string> = new Map();
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Create a new PrecacheController.
|
|
53
|
+
*
|
|
54
|
+
* @param options
|
|
55
|
+
*/
|
|
56
|
+
constructor({ cacheName, plugins = [], fallbackToNetwork = true }: PrecacheControllerOptions = {}) {
|
|
57
|
+
this._strategy = new PrecacheStrategy({
|
|
58
|
+
cacheName: privateCacheNames.getPrecacheName(cacheName),
|
|
59
|
+
plugins: [...plugins, new PrecacheCacheKeyPlugin({ precacheController: this })],
|
|
60
|
+
fallbackToNetwork,
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
// Bind the install and activate methods to the instance.
|
|
64
|
+
this.install = this.install.bind(this);
|
|
65
|
+
this.activate = this.activate.bind(this);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* The strategy created by this controller and
|
|
70
|
+
* used to cache assets and respond to fetch events.
|
|
71
|
+
*/
|
|
72
|
+
get strategy(): Strategy {
|
|
73
|
+
return this._strategy;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Adds items to the precache list, removing any duplicates and
|
|
78
|
+
* stores the files in the precache cache when the service
|
|
79
|
+
* worker installs.
|
|
80
|
+
*
|
|
81
|
+
* This method can be called multiple times.
|
|
82
|
+
*
|
|
83
|
+
* @param entries Array of entries to precache.
|
|
84
|
+
*/
|
|
85
|
+
precache(entries: (PrecacheEntry | string)[]): void {
|
|
86
|
+
this.addToCacheList(entries);
|
|
87
|
+
|
|
88
|
+
if (!this._installAndActiveListenersAdded) {
|
|
89
|
+
self.addEventListener("install", this.install);
|
|
90
|
+
self.addEventListener("activate", this.activate);
|
|
91
|
+
this._installAndActiveListenersAdded = true;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* This method will add items to the precache list, removing duplicates
|
|
97
|
+
* and ensuring the information is valid.
|
|
98
|
+
*
|
|
99
|
+
* @param entries Array of entries to precache.
|
|
100
|
+
*/
|
|
101
|
+
addToCacheList(entries: (PrecacheEntry | string)[]): void {
|
|
102
|
+
if (process.env.NODE_ENV !== "production") {
|
|
103
|
+
assert!.isArray(entries, {
|
|
104
|
+
moduleName: "@serwist/precaching",
|
|
105
|
+
className: "PrecacheController",
|
|
106
|
+
funcName: "addToCacheList",
|
|
107
|
+
paramName: "entries",
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
const urlsToWarnAbout: string[] = [];
|
|
112
|
+
for (const entry of entries) {
|
|
113
|
+
// See https://github.com/GoogleChrome/workbox/issues/2259
|
|
114
|
+
if (typeof entry === "string") {
|
|
115
|
+
urlsToWarnAbout.push(entry);
|
|
116
|
+
} else if (entry && entry.revision === undefined) {
|
|
117
|
+
urlsToWarnAbout.push(entry.url);
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
const { cacheKey, url } = createCacheKey(entry);
|
|
121
|
+
const cacheMode = typeof entry !== "string" && entry.revision ? "reload" : "default";
|
|
122
|
+
|
|
123
|
+
if (this._urlsToCacheKeys.has(url) && this._urlsToCacheKeys.get(url) !== cacheKey) {
|
|
124
|
+
throw new SerwistError("add-to-cache-list-conflicting-entries", {
|
|
125
|
+
firstEntry: this._urlsToCacheKeys.get(url),
|
|
126
|
+
secondEntry: cacheKey,
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
if (typeof entry !== "string" && entry.integrity) {
|
|
131
|
+
if (this._cacheKeysToIntegrities.has(cacheKey) && this._cacheKeysToIntegrities.get(cacheKey) !== entry.integrity) {
|
|
132
|
+
throw new SerwistError("add-to-cache-list-conflicting-integrities", {
|
|
133
|
+
url,
|
|
134
|
+
});
|
|
135
|
+
}
|
|
136
|
+
this._cacheKeysToIntegrities.set(cacheKey, entry.integrity);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
this._urlsToCacheKeys.set(url, cacheKey);
|
|
140
|
+
this._urlsToCacheModes.set(url, cacheMode);
|
|
141
|
+
|
|
142
|
+
if (urlsToWarnAbout.length > 0) {
|
|
143
|
+
const warningMessage = `Serwist is precaching URLs without revision info: ${urlsToWarnAbout.join(
|
|
144
|
+
", ",
|
|
145
|
+
)}\nThis is generally NOT safe. Learn more at https://bit.ly/wb-precache`;
|
|
146
|
+
if (process.env.NODE_ENV === "production") {
|
|
147
|
+
// Use console directly to display this warning without bloating
|
|
148
|
+
// bundle sizes by pulling in all of the logger codebase in prod.
|
|
149
|
+
console.warn(warningMessage);
|
|
150
|
+
} else {
|
|
151
|
+
logger.warn(warningMessage);
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Precaches new and updated assets. Call this method from the service worker
|
|
159
|
+
* install event.
|
|
160
|
+
*
|
|
161
|
+
* Note: this method calls `event.waitUntil()` for you, so you do not need
|
|
162
|
+
* to call it yourself in your event handlers.
|
|
163
|
+
*
|
|
164
|
+
* @param event
|
|
165
|
+
* @returns
|
|
166
|
+
*/
|
|
167
|
+
install(event: ExtendableEvent): Promise<InstallResult> {
|
|
168
|
+
// waitUntil returns Promise<any>
|
|
169
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
|
170
|
+
return waitUntil(event, async () => {
|
|
171
|
+
const installReportPlugin = new PrecacheInstallReportPlugin();
|
|
172
|
+
this.strategy.plugins.push(installReportPlugin);
|
|
173
|
+
|
|
174
|
+
// Cache entries one at a time.
|
|
175
|
+
// See https://github.com/GoogleChrome/workbox/issues/2528
|
|
176
|
+
for (const [url, cacheKey] of this._urlsToCacheKeys) {
|
|
177
|
+
const integrity = this._cacheKeysToIntegrities.get(cacheKey);
|
|
178
|
+
const cacheMode = this._urlsToCacheModes.get(url);
|
|
179
|
+
|
|
180
|
+
const request = new Request(url, {
|
|
181
|
+
integrity,
|
|
182
|
+
cache: cacheMode,
|
|
183
|
+
credentials: "same-origin",
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
await Promise.all(
|
|
187
|
+
this.strategy.handleAll({
|
|
188
|
+
params: { cacheKey },
|
|
189
|
+
request,
|
|
190
|
+
event,
|
|
191
|
+
}),
|
|
192
|
+
);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
const { updatedURLs, notUpdatedURLs } = installReportPlugin;
|
|
196
|
+
|
|
197
|
+
if (process.env.NODE_ENV !== "production") {
|
|
198
|
+
printInstallDetails(updatedURLs, notUpdatedURLs);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
return { updatedURLs, notUpdatedURLs };
|
|
202
|
+
});
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Deletes assets that are no longer present in the current precache manifest.
|
|
207
|
+
* Call this method from the service worker activate event.
|
|
208
|
+
*
|
|
209
|
+
* Note: this method calls `event.waitUntil()` for you, so you do not need
|
|
210
|
+
* to call it yourself in your event handlers.
|
|
211
|
+
*
|
|
212
|
+
* @param event
|
|
213
|
+
* @returns
|
|
214
|
+
*/
|
|
215
|
+
activate(event: ExtendableEvent): Promise<CleanupResult> {
|
|
216
|
+
// waitUntil returns Promise<any>
|
|
217
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
|
|
218
|
+
return waitUntil(event, async () => {
|
|
219
|
+
const cache = await self.caches.open(this.strategy.cacheName);
|
|
220
|
+
const currentlyCachedRequests = await cache.keys();
|
|
221
|
+
const expectedCacheKeys = new Set(this._urlsToCacheKeys.values());
|
|
222
|
+
|
|
223
|
+
const deletedURLs = [];
|
|
224
|
+
for (const request of currentlyCachedRequests) {
|
|
225
|
+
if (!expectedCacheKeys.has(request.url)) {
|
|
226
|
+
await cache.delete(request);
|
|
227
|
+
deletedURLs.push(request.url);
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
if (process.env.NODE_ENV !== "production") {
|
|
232
|
+
printCleanupDetails(deletedURLs);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
return { deletedURLs };
|
|
236
|
+
});
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Returns a mapping of a precached URL to the corresponding cache key, taking
|
|
241
|
+
* into account the revision information for the URL.
|
|
242
|
+
*
|
|
243
|
+
* @returns A URL to cache key mapping.
|
|
244
|
+
*/
|
|
245
|
+
getURLsToCacheKeys(): Map<string, string> {
|
|
246
|
+
return this._urlsToCacheKeys;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* Returns a list of all the URLs that have been precached by the current
|
|
251
|
+
* service worker.
|
|
252
|
+
*
|
|
253
|
+
* @returns The precached URLs.
|
|
254
|
+
*/
|
|
255
|
+
getCachedURLs(): string[] {
|
|
256
|
+
return [...this._urlsToCacheKeys.keys()];
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* Returns the cache key used for storing a given URL. If that URL is
|
|
261
|
+
* unversioned, like `/index.html', then the cache key will be the original
|
|
262
|
+
* URL with a search parameter appended to it.
|
|
263
|
+
*
|
|
264
|
+
* @param url A URL whose cache key you want to look up.
|
|
265
|
+
* @returns The versioned URL that corresponds to a cache key
|
|
266
|
+
* for the original URL, or undefined if that URL isn't precached.
|
|
267
|
+
*/
|
|
268
|
+
getCacheKeyForURL(url: string): string | undefined {
|
|
269
|
+
const urlObject = new URL(url, location.href);
|
|
270
|
+
return this._urlsToCacheKeys.get(urlObject.href);
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* @param url A cache key whose SRI you want to look up.
|
|
275
|
+
* @returns The subresource integrity associated with the cache key,
|
|
276
|
+
* or undefined if it's not set.
|
|
277
|
+
*/
|
|
278
|
+
getIntegrityForCacheKey(cacheKey: string): string | undefined {
|
|
279
|
+
return this._cacheKeysToIntegrities.get(cacheKey);
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* This acts as a drop-in replacement for
|
|
284
|
+
* [`cache.match()`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/match)
|
|
285
|
+
* with the following differences:
|
|
286
|
+
*
|
|
287
|
+
* - It knows what the name of the precache is, and only checks in that cache.
|
|
288
|
+
* - It allows you to pass in an "original" URL without versioning parameters,
|
|
289
|
+
* and it will automatically look up the correct cache key for the currently
|
|
290
|
+
* active revision of that URL.
|
|
291
|
+
*
|
|
292
|
+
* E.g., `matchPrecache('index.html')` will find the correct precached
|
|
293
|
+
* response for the currently active service worker, even if the actual cache
|
|
294
|
+
* key is `'/index.html?__WB_REVISION__=1234abcd'`.
|
|
295
|
+
*
|
|
296
|
+
* @param request The key (without revisioning parameters)
|
|
297
|
+
* to look up in the precache.
|
|
298
|
+
* @returns
|
|
299
|
+
*/
|
|
300
|
+
async matchPrecache(request: string | Request): Promise<Response | undefined> {
|
|
301
|
+
const url = request instanceof Request ? request.url : request;
|
|
302
|
+
const cacheKey = this.getCacheKeyForURL(url);
|
|
303
|
+
if (cacheKey) {
|
|
304
|
+
const cache = await self.caches.open(this.strategy.cacheName);
|
|
305
|
+
return cache.match(cacheKey);
|
|
306
|
+
}
|
|
307
|
+
return undefined;
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Returns a function that looks up `url` in the precache (taking into
|
|
312
|
+
* account revision information), and returns the corresponding `Response`.
|
|
313
|
+
*
|
|
314
|
+
* @param url The precached URL which will be used to lookup the response.
|
|
315
|
+
* @return
|
|
316
|
+
*/
|
|
317
|
+
createHandlerBoundToURL(url: string): RouteHandlerCallback {
|
|
318
|
+
const cacheKey = this.getCacheKeyForURL(url);
|
|
319
|
+
if (!cacheKey) {
|
|
320
|
+
throw new SerwistError("non-precached-url", { url });
|
|
321
|
+
}
|
|
322
|
+
return (options) => {
|
|
323
|
+
options.request = new Request(url);
|
|
324
|
+
options.params = { cacheKey, ...options.params };
|
|
325
|
+
|
|
326
|
+
return this.strategy.handle(options);
|
|
327
|
+
};
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
export { PrecacheController };
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020 Google LLC
|
|
3
|
+
|
|
4
|
+
Use of this source code is governed by an MIT-style
|
|
5
|
+
license that can be found in the LICENSE file or at
|
|
6
|
+
https://opensource.org/licenses/MIT.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import type { SerwistPlugin } from "@serwist/core";
|
|
10
|
+
|
|
11
|
+
import type { PrecacheController } from "./PrecacheController.js";
|
|
12
|
+
import { getOrCreatePrecacheController } from "./utils/getOrCreatePrecacheController.js";
|
|
13
|
+
|
|
14
|
+
interface PrecacheFallbackPluginOptions {
|
|
15
|
+
/**
|
|
16
|
+
* A precached URL to use as the fallback
|
|
17
|
+
* if the associated strategy can't generate a response.
|
|
18
|
+
*/
|
|
19
|
+
fallbackURL: string;
|
|
20
|
+
/**
|
|
21
|
+
* An optional
|
|
22
|
+
* PrecacheController instance. If not provided, the default
|
|
23
|
+
* PrecacheController will be used.
|
|
24
|
+
*/
|
|
25
|
+
precacheController?: PrecacheController;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* `PrecacheFallbackPlugin` allows you to specify an "offline fallback"
|
|
30
|
+
* response to be used when a given strategy is unable to generate a response.
|
|
31
|
+
*
|
|
32
|
+
* It does this by intercepting the `handlerDidError` plugin callback
|
|
33
|
+
* and returning a precached response, taking the expected revision parameter
|
|
34
|
+
* into account automatically.
|
|
35
|
+
*
|
|
36
|
+
* Unless you explicitly pass in a `PrecacheController` instance to the
|
|
37
|
+
* constructor, the default instance will be used. Generally speaking, most
|
|
38
|
+
* developers will end up using the default.
|
|
39
|
+
*/
|
|
40
|
+
class PrecacheFallbackPlugin implements SerwistPlugin {
|
|
41
|
+
private readonly _fallbackURL: string;
|
|
42
|
+
private readonly _precacheController: PrecacheController;
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Constructs a new PrecacheFallbackPlugin with the associated fallbackURL.
|
|
46
|
+
*
|
|
47
|
+
* @param config
|
|
48
|
+
*/
|
|
49
|
+
constructor({ fallbackURL, precacheController }: PrecacheFallbackPluginOptions) {
|
|
50
|
+
this._fallbackURL = fallbackURL;
|
|
51
|
+
this._precacheController = precacheController || getOrCreatePrecacheController();
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* @returns The precache response for the fallback URL.
|
|
56
|
+
* @private
|
|
57
|
+
*/
|
|
58
|
+
handlerDidError: SerwistPlugin["handlerDidError"] = () => this._precacheController.matchPrecache(this._fallbackURL);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export { PrecacheFallbackPlugin };
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020 Google LLC
|
|
3
|
+
|
|
4
|
+
Use of this source code is governed by an MIT-style
|
|
5
|
+
license that can be found in the LICENSE file or at
|
|
6
|
+
https://opensource.org/licenses/MIT.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import type { RouteMatchCallback, RouteMatchCallbackOptions } from "@serwist/core";
|
|
10
|
+
import { getFriendlyURL, logger } from "@serwist/core/internal";
|
|
11
|
+
import { Route } from "@serwist/routing";
|
|
12
|
+
|
|
13
|
+
import type { PrecacheController } from "./PrecacheController.js";
|
|
14
|
+
import type { PrecacheRouteOptions } from "./_types.js";
|
|
15
|
+
import { generateURLVariations } from "./utils/generateURLVariations.js";
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* A subclass of `@serwist/routing.Route` that takes a
|
|
19
|
+
* `@serwist/precaching.PrecacheController`
|
|
20
|
+
* instance and uses it to match incoming requests and handle fetching
|
|
21
|
+
* responses from the precache.
|
|
22
|
+
*/
|
|
23
|
+
class PrecacheRoute extends Route {
|
|
24
|
+
/**
|
|
25
|
+
* @param precacheController A `PrecacheController`
|
|
26
|
+
* instance used to both match requests and respond to fetch events.
|
|
27
|
+
* @param options Options to control how requests are matched
|
|
28
|
+
* against the list of precached URLs.
|
|
29
|
+
*/
|
|
30
|
+
constructor(precacheController: PrecacheController, options?: PrecacheRouteOptions) {
|
|
31
|
+
const match: RouteMatchCallback = ({ request }: RouteMatchCallbackOptions) => {
|
|
32
|
+
const urlsToCacheKeys = precacheController.getURLsToCacheKeys();
|
|
33
|
+
for (const possibleURL of generateURLVariations(request.url, options)) {
|
|
34
|
+
const cacheKey = urlsToCacheKeys.get(possibleURL);
|
|
35
|
+
if (cacheKey) {
|
|
36
|
+
const integrity = precacheController.getIntegrityForCacheKey(cacheKey);
|
|
37
|
+
return { cacheKey, integrity };
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
if (process.env.NODE_ENV !== "production") {
|
|
41
|
+
logger.debug(`Precaching did not find a match for ${getFriendlyURL(request.url)}`);
|
|
42
|
+
}
|
|
43
|
+
return;
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
super(match, precacheController.strategy);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export { PrecacheRoute };
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright 2020 Google LLC
|
|
3
|
+
|
|
4
|
+
Use of this source code is governed by an MIT-style
|
|
5
|
+
license that can be found in the LICENSE file or at
|
|
6
|
+
https://opensource.org/licenses/MIT.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import type { SerwistPlugin } from "@serwist/core";
|
|
10
|
+
import { copyResponse } from "@serwist/core";
|
|
11
|
+
import { SerwistError, getFriendlyURL, logger, privateCacheNames } from "@serwist/core/internal";
|
|
12
|
+
import type { StrategyHandler, StrategyOptions } from "@serwist/strategies";
|
|
13
|
+
import { Strategy } from "@serwist/strategies";
|
|
14
|
+
|
|
15
|
+
interface PrecacheStrategyOptions extends StrategyOptions {
|
|
16
|
+
/**
|
|
17
|
+
* Whether to attempt to get the response from the network
|
|
18
|
+
* if there's a precache miss.
|
|
19
|
+
*/
|
|
20
|
+
fallbackToNetwork?: boolean;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* A `@serwist/strategies.Strategy` implementation
|
|
25
|
+
* specifically designed to work with
|
|
26
|
+
* `@serwist/precaching.PrecacheController`
|
|
27
|
+
* to both cache and fetch precached assets.
|
|
28
|
+
*
|
|
29
|
+
* Note: an instance of this class is created automatically when creating a
|
|
30
|
+
* `PrecacheController`; it's generally not necessary to create this yourself.
|
|
31
|
+
*/
|
|
32
|
+
class PrecacheStrategy extends Strategy {
|
|
33
|
+
private readonly _fallbackToNetwork: boolean;
|
|
34
|
+
|
|
35
|
+
static readonly defaultPrecacheCacheabilityPlugin: SerwistPlugin = {
|
|
36
|
+
async cacheWillUpdate({ response }) {
|
|
37
|
+
if (!response || response.status >= 400) {
|
|
38
|
+
return null;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
return response;
|
|
42
|
+
},
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
static readonly copyRedirectedCacheableResponsesPlugin: SerwistPlugin = {
|
|
46
|
+
async cacheWillUpdate({ response }) {
|
|
47
|
+
return response.redirected ? await copyResponse(response) : response;
|
|
48
|
+
},
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* @param options
|
|
53
|
+
*/
|
|
54
|
+
constructor(options: PrecacheStrategyOptions = {}) {
|
|
55
|
+
options.cacheName = privateCacheNames.getPrecacheName(options.cacheName);
|
|
56
|
+
super(options);
|
|
57
|
+
|
|
58
|
+
this._fallbackToNetwork = options.fallbackToNetwork === false ? false : true;
|
|
59
|
+
|
|
60
|
+
// Redirected responses cannot be used to satisfy a navigation request, so
|
|
61
|
+
// any redirected response must be "copied" rather than cloned, so the new
|
|
62
|
+
// response doesn't contain the `redirected` flag. See:
|
|
63
|
+
// https://bugs.chromium.org/p/chromium/issues/detail?id=669363&desc=2#c1
|
|
64
|
+
this.plugins.push(PrecacheStrategy.copyRedirectedCacheableResponsesPlugin);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* @private
|
|
69
|
+
* @param request A request to run this strategy for.
|
|
70
|
+
* @param handler The event that triggered the request.
|
|
71
|
+
* @returns
|
|
72
|
+
*/
|
|
73
|
+
async _handle(request: Request, handler: StrategyHandler): Promise<Response> {
|
|
74
|
+
const response = await handler.cacheMatch(request);
|
|
75
|
+
if (response) {
|
|
76
|
+
return response;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// If this is an `install` event for an entry that isn't already cached,
|
|
80
|
+
// then populate the cache.
|
|
81
|
+
if (handler.event && handler.event.type === "install") {
|
|
82
|
+
return await this._handleInstall(request, handler);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// Getting here means something went wrong. An entry that should have been
|
|
86
|
+
// precached wasn't found in the cache.
|
|
87
|
+
return await this._handleFetch(request, handler);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
async _handleFetch(request: Request, handler: StrategyHandler): Promise<Response> {
|
|
91
|
+
let response: Response | undefined = undefined;
|
|
92
|
+
const params = (handler.params || {}) as {
|
|
93
|
+
cacheKey?: string;
|
|
94
|
+
integrity?: string;
|
|
95
|
+
};
|
|
96
|
+
|
|
97
|
+
// Fallback to the network if we're configured to do so.
|
|
98
|
+
if (this._fallbackToNetwork) {
|
|
99
|
+
if (process.env.NODE_ENV !== "production") {
|
|
100
|
+
logger.warn(`The precached response for ${getFriendlyURL(request.url)} in ${this.cacheName} was not found. Falling back to the network.`);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const integrityInManifest = params.integrity;
|
|
104
|
+
const integrityInRequest = request.integrity;
|
|
105
|
+
const noIntegrityConflict = !integrityInRequest || integrityInRequest === integrityInManifest;
|
|
106
|
+
|
|
107
|
+
// Do not add integrity if the original request is no-cors
|
|
108
|
+
// See https://github.com/GoogleChrome/workbox/issues/3096
|
|
109
|
+
response = await handler.fetch(
|
|
110
|
+
new Request(request, {
|
|
111
|
+
integrity: request.mode !== "no-cors" ? integrityInRequest || integrityInManifest : undefined,
|
|
112
|
+
}),
|
|
113
|
+
);
|
|
114
|
+
|
|
115
|
+
// It's only "safe" to repair the cache if we're using SRI to guarantee
|
|
116
|
+
// that the response matches the precache manifest's expectations,
|
|
117
|
+
// and there's either a) no integrity property in the incoming request
|
|
118
|
+
// or b) there is an integrity, and it matches the precache manifest.
|
|
119
|
+
// See https://github.com/GoogleChrome/workbox/issues/2858
|
|
120
|
+
// Also if the original request users no-cors we don't use integrity.
|
|
121
|
+
// See https://github.com/GoogleChrome/workbox/issues/3096
|
|
122
|
+
if (integrityInManifest && noIntegrityConflict && request.mode !== "no-cors") {
|
|
123
|
+
this._useDefaultCacheabilityPluginIfNeeded();
|
|
124
|
+
const wasCached = await handler.cachePut(request, response.clone());
|
|
125
|
+
if (process.env.NODE_ENV !== "production") {
|
|
126
|
+
if (wasCached) {
|
|
127
|
+
logger.log(`A response for ${getFriendlyURL(request.url)} was used to "repair" the precache.`);
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
} else {
|
|
132
|
+
// This shouldn't normally happen, but there are edge cases:
|
|
133
|
+
// https://github.com/GoogleChrome/workbox/issues/1441
|
|
134
|
+
throw new SerwistError("missing-precache-entry", {
|
|
135
|
+
cacheName: this.cacheName,
|
|
136
|
+
url: request.url,
|
|
137
|
+
});
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
if (process.env.NODE_ENV !== "production") {
|
|
141
|
+
const cacheKey = params.cacheKey || (await handler.getCacheKey(request, "read"));
|
|
142
|
+
|
|
143
|
+
// Serwist is going to handle the route.
|
|
144
|
+
// print the routing details to the console.
|
|
145
|
+
logger.groupCollapsed(`Precaching is responding to: ${getFriendlyURL(request.url)}`);
|
|
146
|
+
logger.log(`Serving the precached url: ${getFriendlyURL(cacheKey instanceof Request ? cacheKey.url : cacheKey)}`);
|
|
147
|
+
|
|
148
|
+
logger.groupCollapsed("View request details here.");
|
|
149
|
+
logger.log(request);
|
|
150
|
+
logger.groupEnd();
|
|
151
|
+
|
|
152
|
+
logger.groupCollapsed("View response details here.");
|
|
153
|
+
logger.log(response);
|
|
154
|
+
logger.groupEnd();
|
|
155
|
+
|
|
156
|
+
logger.groupEnd();
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
return response;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
async _handleInstall(request: Request, handler: StrategyHandler): Promise<Response> {
|
|
163
|
+
this._useDefaultCacheabilityPluginIfNeeded();
|
|
164
|
+
|
|
165
|
+
const response = await handler.fetch(request);
|
|
166
|
+
|
|
167
|
+
// Make sure we defer cachePut() until after we know the response
|
|
168
|
+
// should be cached; see https://github.com/GoogleChrome/workbox/issues/2737
|
|
169
|
+
const wasCached = await handler.cachePut(request, response.clone());
|
|
170
|
+
if (!wasCached) {
|
|
171
|
+
// Throwing here will lead to the `install` handler failing, which
|
|
172
|
+
// we want to do if *any* of the responses aren't safe to cache.
|
|
173
|
+
throw new SerwistError("bad-precaching-response", {
|
|
174
|
+
url: request.url,
|
|
175
|
+
status: response.status,
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
return response;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* This method is complex, as there a number of things to account for:
|
|
184
|
+
*
|
|
185
|
+
* The `plugins` array can be set at construction, and/or it might be added to
|
|
186
|
+
* to at any time before the strategy is used.
|
|
187
|
+
*
|
|
188
|
+
* At the time the strategy is used (i.e. during an `install` event), there
|
|
189
|
+
* needs to be at least one plugin that implements `cacheWillUpdate` in the
|
|
190
|
+
* array, other than `copyRedirectedCacheableResponsesPlugin`.
|
|
191
|
+
*
|
|
192
|
+
* - If this method is called and there are no suitable `cacheWillUpdate`
|
|
193
|
+
* plugins, we need to add `defaultPrecacheCacheabilityPlugin`.
|
|
194
|
+
*
|
|
195
|
+
* - If this method is called and there is exactly one `cacheWillUpdate`, then
|
|
196
|
+
* we don't have to do anything (this might be a previously added
|
|
197
|
+
* `defaultPrecacheCacheabilityPlugin`, or it might be a custom plugin).
|
|
198
|
+
*
|
|
199
|
+
* - If this method is called and there is more than one `cacheWillUpdate`,
|
|
200
|
+
* then we need to check if one is `defaultPrecacheCacheabilityPlugin`. If so,
|
|
201
|
+
* we need to remove it. (This situation is unlikely, but it could happen if
|
|
202
|
+
* the strategy is used multiple times, the first without a `cacheWillUpdate`,
|
|
203
|
+
* and then later on after manually adding a custom `cacheWillUpdate`.)
|
|
204
|
+
*
|
|
205
|
+
* See https://github.com/GoogleChrome/workbox/issues/2737 for more context.
|
|
206
|
+
*
|
|
207
|
+
* @private
|
|
208
|
+
*/
|
|
209
|
+
_useDefaultCacheabilityPluginIfNeeded(): void {
|
|
210
|
+
let defaultPluginIndex: number | null = null;
|
|
211
|
+
let cacheWillUpdatePluginCount = 0;
|
|
212
|
+
|
|
213
|
+
for (const [index, plugin] of this.plugins.entries()) {
|
|
214
|
+
// Ignore the copy redirected plugin when determining what to do.
|
|
215
|
+
if (plugin === PrecacheStrategy.copyRedirectedCacheableResponsesPlugin) {
|
|
216
|
+
continue;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
// Save the default plugin's index, in case it needs to be removed.
|
|
220
|
+
if (plugin === PrecacheStrategy.defaultPrecacheCacheabilityPlugin) {
|
|
221
|
+
defaultPluginIndex = index;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
if (plugin.cacheWillUpdate) {
|
|
225
|
+
cacheWillUpdatePluginCount++;
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
if (cacheWillUpdatePluginCount === 0) {
|
|
230
|
+
this.plugins.push(PrecacheStrategy.defaultPrecacheCacheabilityPlugin);
|
|
231
|
+
} else if (cacheWillUpdatePluginCount > 1 && defaultPluginIndex !== null) {
|
|
232
|
+
// Only remove the default plugin; multiple custom plugins are allowed.
|
|
233
|
+
this.plugins.splice(defaultPluginIndex, 1);
|
|
234
|
+
}
|
|
235
|
+
// Nothing needs to be done if cacheWillUpdatePluginCount is 1
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
export { PrecacheStrategy };
|