-
Notifications
You must be signed in to change notification settings - Fork 801
/
PrecacheController.mjs
327 lines (291 loc) 路 9.75 KB
/
PrecacheController.mjs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/*
Copyright 2017 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import {cacheNames} from 'workbox-core/_private/cacheNames.mjs';
import {WorkboxError} from 'workbox-core/_private/WorkboxError.mjs';
import {fetchWrapper} from 'workbox-core/_private/fetchWrapper.mjs';
import {cacheWrapper} from 'workbox-core/_private/cacheWrapper.mjs';
import {assert} from 'workbox-core/_private/assert.mjs';
import PrecacheEntry from '../models/PrecacheEntry.mjs';
import PrecachedDetailsModel from '../models/PrecachedDetailsModel.mjs';
import showWarningsIfNeeded from '../utils/showWarningsIfNeeded.mjs';
import printInstallDetails from '../utils/printInstallDetails.mjs';
import printCleanupDetails from '../utils/printCleanupDetails.mjs';
import cleanRedirect from '../utils/cleanRedirect.mjs';
import '../_version.mjs';
/**
* Performs efficient precaching of assets.
*
* @memberof workbox.precaching
*/
class PrecacheController {
/**
* Create a new PrecacheController.
*
* @param {string} cacheName
*/
constructor(cacheName) {
this._cacheName = cacheNames.getPrecacheName(cacheName);
this._entriesToCacheMap = new Map();
this._precacheDetailsModel = new PrecachedDetailsModel(this._cacheName);
}
/**
* This method will add items to the precache list, removing duplicates
* and ensuring the information is valid.
*
* @param {
* Array<module:workbox-precaching.PrecacheController.PrecacheEntry|string>
* } entries Array of entries to
* precache.
*/
addToCacheList(entries) {
if (process.env.NODE_ENV !== 'production') {
assert.isArray(entries, {
moduleName: 'workbox-precaching',
className: 'PrecacheController',
funcName: 'addToCacheList',
paramName: 'entries',
});
}
entries.map((userEntry) => {
this._addEntryToCacheList(
this._parseEntry(userEntry)
);
});
}
/**
* This method returns a precache entry.
*
* @private
* @param {string|Object} input
* @return {PrecacheEntry}
*/
_parseEntry(input) {
switch (typeof input) {
case 'string': {
if (process.env.NODE_ENV !== 'production') {
if (input.length === 0) {
throw new WorkboxError(
'add-to-cache-list-unexpected-type', {
entry: input,
}
);
}
}
return new PrecacheEntry(input, input, input);
}
case 'object': {
if (process.env.NODE_ENV !== 'production') {
if (!input || !input.url) {
throw new WorkboxError(
'add-to-cache-list-unexpected-type', {
entry: input,
}
);
}
}
return new PrecacheEntry(
input, input.url, input.revision || input.url, !!input.revision);
}
default:
throw new WorkboxError('add-to-cache-list-unexpected-type', {
entry: input,
});
}
}
/**
* Adds an entry to the precache list, accounting for possible duplicates.
*
* @private
* @param {PrecacheEntry} entryToAdd
*/
_addEntryToCacheList(entryToAdd) {
// Check if the entry is already part of the map
const existingEntry = this._entriesToCacheMap.get(entryToAdd._entryId);
if (!existingEntry) {
this._entriesToCacheMap.set(entryToAdd._entryId, entryToAdd);
return;
}
// Duplicates are fine, but make sure the revision information
// is the same.
if (existingEntry._revision !== entryToAdd._revision) {
throw new WorkboxError('add-to-cache-list-conflicting-entries', {
firstEntry: existingEntry._originalInput,
secondEntry: entryToAdd._originalInput,
});
}
}
/**
* Call this method from a service work install event to start
* precaching assets.
*
* @param {Object} options
* @param {boolean} options.suppressWarnings Suppress warning messages.
* @param {Array<Object>} options.plugins Plugins to be used for fetching
* and caching during install.
* @return {
* Promise<module:workbox-precaching.PrecacheController.InstallResult>}
*/
async install(options = {}) {
if (process.env.NODE_ENV !== 'production') {
if (options.suppressWarnings !== true) {
showWarningsIfNeeded(this._entriesToCacheMap);
}
if (options.plugins) {
assert.isArray(options.plugins, {
moduleName: 'workbox-precaching',
className: 'PrecacheController',
funcName: 'install',
paramName: 'plugins',
});
}
}
const entriesToPrecache = [];
const entriesAlreadyPrecached = [];
for (const precacheEntry of this._entriesToCacheMap.values()) {
if (await this._precacheDetailsModel._isEntryCached(precacheEntry)) {
entriesAlreadyPrecached.push(precacheEntry);
} else {
entriesToPrecache.push(precacheEntry);
}
}
// Wait for all requests to be cached.
await Promise.all(entriesToPrecache.map((precacheEntry) => {
return this._cacheEntry(precacheEntry, options.plugins);
}));
if (process.env.NODE_ENV !== 'production') {
printInstallDetails(entriesToPrecache, entriesAlreadyPrecached);
}
return {
updatedEntries: entriesToPrecache,
notUpdatedEntries: entriesAlreadyPrecached,
};
}
/**
* Requests the entry and saves it to the cache if the response
* is valid.
*
* @private
* @param {BaseCacheEntry} precacheEntry The entry to fetch and cache.
* @param {Array<Object>} plugins Array of plugins to apply to fetch and
* caching.
* @return {Promise<boolean>} Returns a promise that resolves once the entry
* has been fetched and cached or skipped if no update is needed. The
* promise resolves with true if the entry was cached / updated and
* false if the entry is already cached and up-to-date.
*/
async _cacheEntry(precacheEntry, plugins) {
let response = await fetchWrapper.fetch(
precacheEntry._networkRequest,
null,
plugins,
);
if (response.redirected) {
response = await cleanRedirect(response);
}
await cacheWrapper.put(this._cacheName,
precacheEntry._cacheRequest, response, plugins);
await this._precacheDetailsModel._addEntry(precacheEntry);
return true;
}
/**
* Compare the URLs and determines which assets are no longer required
* in the cache.
*
* This should be called in the service worker activate event.
*
* @return {
* Promise<module:workbox-precaching.PrecacheController.CleanupResult>}
* Resolves with an object containing details of the deleted cache requests
* and precache revision details.
*/
async cleanup() {
const expectedCacheUrls = [];
this._entriesToCacheMap.forEach((entry) => {
const fullUrl = new URL(entry._cacheRequest.url, location).toString();
expectedCacheUrls.push(fullUrl);
});
const [deletedCacheRequests, deletedRevisionDetails] = await Promise.all([
this._cleanupCache(expectedCacheUrls),
this._cleanupDetailsModel(expectedCacheUrls),
]);
if (process.env.NODE_ENV !== 'production') {
printCleanupDetails(deletedCacheRequests, deletedRevisionDetails);
}
return {
deletedCacheRequests,
deletedRevisionDetails,
};
}
/**
* Goes through all the cache entries and removes any that are
* outdated.
*
* @private
* @param {Array<string>} expectedCacheUrls Array of URLs that are
* expected to be cached.
* @return {Promise<Array<string>>} Resolves to an array of URLs
* of cached requests that were deleted.
*/
async _cleanupCache(expectedCacheUrls) {
if (!await caches.has(this._cacheName)) {
// Cache doesn't exist, so nothing to delete
return [];
}
const cache = await caches.open(this._cacheName);
const cachedRequests = await cache.keys();
const cachedRequestsToDelete = cachedRequests.filter((cachedRequest) => {
return !expectedCacheUrls.includes(
new URL(cachedRequest.url, location).toString()
);
});
await Promise.all(
cachedRequestsToDelete.map((cacheUrl) => cache.delete(cacheUrl))
);
return cachedRequestsToDelete.map((request) => request.url);
}
/**
* Goes through all entries in indexedDB and removes any that are outdated.
*
* @private
* @param {Array<string>} expectedCacheUrls Array of URLs that are
* expected to be cached.
* @return {Promise<Array<string>>} Resolves to an array of URLs removed
* from indexedDB.
*/
async _cleanupDetailsModel(expectedCacheUrls) {
const revisionedEntries = await this._precacheDetailsModel._getAllEntries();
const detailsToDelete = revisionedEntries
.filter((entry) => {
const fullUrl = new URL(entry.value.url, location).toString();
return !expectedCacheUrls.includes(fullUrl);
});
await Promise.all(
detailsToDelete.map(
(entry) => this._precacheDetailsModel._deleteEntry(entry.primaryKey)
)
);
return detailsToDelete.map((entry) => {
return entry.value.url;
});
}
/**
* Returns an array of fully qualified URL's that will be precached.
*
* @return {Array<string>} An array of URLs.
*/
getCachedUrls() {
return Array.from(this._entriesToCacheMap.keys())
.map((url) => new URL(url, location).href);
}
}
export default PrecacheController;