swpp-backends 2.3.2 → 2.3.7

package/README.md

@@ -8,29 +8,28 @@ swpp 的全拼为“Service Worker Plus Plus”（或“Service Worker++”）
 
 swpp 生成的 SW 与其它插件的对比：
 
-|            |     swpp      | hexo-offline |
-|:----------:|:-------------:|:------------:|
-|    本地缓存    |      ✔️       |      ✔️      |
-|   缓存增量更新   |      ✔️       |      ❌       |
-|   缓存过期时间   |       ❌       |      ✔️      |
-|   缓存大小限制   |       ❌       |      ✔️      |
-|    预缓存     | ❌<sup>1</sup> |      ✔️      |
-| Request 篡改 |      ✔️       |      ❌       |
-|   URL 竞速   |      ✔️       |      ❌       |
-|   备用 URL   |      ✔️       |      ❌       |
-|  204 阻塞响应  |      ✔️       |      ❌       |
-|    逃生门     |      ✔️       |      ❌       |
-|    请求合并    |      ✔️       |      ❌       |
-|    跨平台     |      ✔️       |      ❌       |
-|    高度自由    |      ✔️       |      ❌       |
-|     更新     |     非常频繁      |   超过两年没有更新   |
-
-<small>&emsp;注：上面提到的跨平台是指跨越框架（比如 Hexo、WordPress 等）。</small>
+|                 |     swpp      | hexo-offline |
+|:---------------:|:-------------:|:------------:|
+|      本地缓存       |      ✔️       |      ✔️      |
+|     缓存增量更新      |      ✔️       |      ❌       |
+|     缓存过期时间      |       ❌       |      ✔️      |
+|     缓存大小限制      |       ❌       |      ✔️      |
+|       预缓存       | ❌<sup>1</sup> |      ✔️      |
+|   Request 篡改    |      ✔️       |      ❌       |
+|     URL 竞速      |      ✔️       |      ❌       |
+|     备用 URL      |      ✔️       |      ❌       |
+|    204 阻塞响应     |      ✔️       |      ❌       |
+|       逃生门       |      ✔️       |      ❌       |
+|      请求合并       |      ✔️       |      ❌       |
+| 跨平台<sup>2</sup> |      ✔️       |      ❌       |
+|      高度自由       |      ✔️       |      ❌       |
+|       更新        |     非常频繁      |   超过两年没有更新   |
 
 + ✔️：支持
 + ❌：不支持
 
 1. 预缓存可以在前端实现，SW 实现这个功能容易拖延注册时间
+2. 跨平台是指跨越框架（可在 NodeJS 平台中的任意框架下工作）
 
 目前支持的平台：
 

package/dist/ServiceWorkerBuilder.js

@@ -29,14 +29,23 @@ function buildServiceWorker() {
         'cacheRules', 'modifyRequest', 'getRaceUrls', 'getSpareUrls', 'blockRequest', 'fetchFile', 'skipRequest', 'isCors', 'isMemoryQueue',
         ...('external' in rules && Array.isArray(rules.external) ? rules.external : [])
     ], true) + '\n';
+    let fetchFileReplaced;
     if (!fetchFile) {
         const { JS_CODE_GET_CDN_LIST, JS_CODE_GET_SPARE_URLS, JS_CODE_DEF_FETCH_FILE } = require('./resources/sw-fetch.js');
-        if (getRaceUrls)
-            cache += JS_CODE_GET_CDN_LIST;
-        else if (getSpareUrls)
-            cache += JS_CODE_GET_SPARE_URLS;
-        else
-            cache += JS_CODE_DEF_FETCH_FILE;
+        let selected, replaced;
+        if (getRaceUrls) {
+            selected = JS_CODE_GET_CDN_LIST;
+            fetchFileReplaced = 'getRaceUrls(request.url)';
+        }
+        else if (getSpareUrls) {
+            selected = JS_CODE_GET_SPARE_URLS;
+            fetchFileReplaced = 'getSpareUrls(request.url)';
+        }
+        else {
+            selected = JS_CODE_DEF_FETCH_FILE;
+            fetchFileReplaced = 'null';
+        }
+        cache += selected;
     }
     if (!getSpareUrls)
         cache += `\nconst getSpareUrls = _ => {}`;
@@ -44,13 +53,16 @@ function buildServiceWorker() {
         cache += `(${(0, Utils_1.getSource)(rules['afterJoin'])})()\n`;
     if ('afterTheme' in rules)
         cache += `(${(0, Utils_1.getSource)(rules['afterTheme'])})()\n`;
-    const keyword = "const { cacheRules, fetchFile, getSpareUrls, isCors, isMemoryQueue } = require('../sw-rules')";
+    const keyword = "const { cacheRules, fetchFile, isCors, isMemoryQueue } = require('../sw-rules')";
     // noinspection JSUnresolvedVariable
     let content = fs_1.default.readFileSync(templatePath, 'utf8')
         .replaceAll("// [insertion site] values", eject?.strValue ?? '')
         .replaceAll(keyword, cache)
         .replaceAll("'@$$[escape]'", (serviceWorkerConfig.escape).toString())
         .replaceAll("'@$$[cacheName]'", `'${serviceWorkerConfig.cacheName}'`);
+    if (fetchFileReplaced) {
+        content = content.replaceAll('[] // [spareUrls or raceUrls call]', fetchFileReplaced);
+    }
     if (modifyRequest) {
         content = content.replaceAll('// [modifyRequest call]', `
                 const modify = modifyRequest(request)

package/dist/index.js

@@ -10,7 +10,7 @@ const VersionAnalyzer_1 = require("./VersionAnalyzer");
 const DomBuilder_1 = require("./DomBuilder");
 // noinspection JSUnusedGlobalSymbols
 exports.default = {
-    version: '2.3.2',
+    version: '2.3.7',
     cache: {
         readEjectData: Utils_1.readEjectData, readUpdateJson: Variant_1.readUpdateJson,
         readRules: Variant_1.readRules, readMergeVersionMap: Variant_1.readMergeVersionMap,

package/dist/resources/sw-dom.js

@@ -23,12 +23,12 @@ document.addEventListener('DOMContentLoaded', () => {
     const {onSuccess} = require('../config')
     if (sessionStorage.getItem(SESSION_KEY)) {
         onSuccess()
-        sessionStorage.removeItem(SESSION_KEY);
+        sessionStorage.removeItem(SESSION_KEY)
     } else postMessage2SW('update')
     navigator.serviceWorker.addEventListener('message', event => {
         const data = event.data
         sessionStorage.setItem(SESSION_KEY, data.type)
-        let list = data.list?.filter(url => /\.(js|css)$/.test(url))
+        const list = data.list?.filter(url => /\.(js|css)$/.test(url))
         if (list) {
             // noinspection JSUnresolvedReference
             if (window.Pjax?.isSupported?.())
@@ -39,6 +39,7 @@ document.addEventListener('DOMContentLoaded', () => {
             if (oldVersion && (newVersion.global !== oldVersion.global || newVersion.local !== oldVersion.local)) {
                 onSuccess()
             }
+            sessionStorage.removeItem(SESSION_KEY)
         }
     })
 })

package/dist/resources/sw-fetch.js

@@ -4,10 +4,13 @@ let getRaceUrls, checkResponse, getSpareUrls, fetchWithCors
 module.exports.JS_CODE_DEF_FETCH_FILE = 'const fetchFile = fetchWithCors;'
 
 module.exports.JS_CODE_GET_CDN_LIST= 'const fetchFile = ' + (
-    (request, banCache) => {
-        const list = getRaceUrls(request.url)
-        if (!list || !Promise.any) return fetchWithCors(request, banCache)
-        const res = list.map(url => new Request(url, request))
+    (request, banCache, urls) => {
+        if (!urls) {
+            urls = getRaceUrls(request.url)
+            if (!urls) return fetchWithCors(request, banCache)
+        }
+        if (!urls || !Promise.any) return fetchWithCors(request, banCache)
+        const res = urls.map(url => new Request(url, request))
         const controllers = []
         // noinspection JSCheckFunctionSignatures
         return Promise.any(
@@ -25,16 +28,15 @@ module.exports.JS_CODE_GET_CDN_LIST= 'const fetchFile = ' + (
 ).toString()
 
 module.exports.JS_CODE_GET_SPARE_URLS = 'const fetchFile = ' + (
-    (request, banCache, spare = null) => {
-        if (!spare) {
-            spare = getSpareUrls(request.url)
-            if (!spare) return fetchWithCors(request, banCache)
+    (request, banCache, urls = null) => {
+        if (!urls) {
+            urls = getSpareUrls(request.url)
+            if (!urls) return fetchWithCors(request, banCache)
         }
-        const list = spare.list
+        const list = urls.list
         const controllers = new Array(list.length)
         // noinspection JSCheckFunctionSignatures
-        const startFetch =
-            index => fetchWithCors(
+        const startFetch = index => fetchWithCors(
                 new Request(list[index], request),
                 banCache,
                 {signal: (controllers[index] = new AbortController()).signal}
@@ -56,7 +58,7 @@ module.exports.JS_CODE_GET_SPARE_URLS = 'const fetchFile = ' + (
                     resolve(res.r)
                 }).catch(() => reject(`请求 ${request.url} 失败`))
             }
-            const id = setTimeout(startAll, spare.timeout)
+            const id = setTimeout(startAll, urls.timeout)
             const first = startFetch(0)
                 .then(res => {
                     if (flag) {

package/dist/resources/sw-template.js

@@ -48,7 +48,7 @@
     self.addEventListener('activate', event => event.waitUntil(clients.claim()))
 
     // noinspection JSFileReferences
-    const { cacheRules, fetchFile, getSpareUrls, isCors, isMemoryQueue } = require('../sw-rules')
+    const { cacheRules, fetchFile, isCors, isMemoryQueue } = require('../sw-rules')
 
     // 检查请求是否成功
     // noinspection JSUnusedLocalSymbols
@@ -136,8 +136,8 @@
                 )
             )
         } else {
-            const spare = getSpareUrls(request.url)
-            if (spare) handleFetch(fetchFile(request, false, spare))
+            const urls = [] // [spareUrls or raceUrls call]
+            if (urls) handleFetch(fetchFile(request, false, urls))
             // [modifyRequest else-if]
             else handleFetch(fetchWithCache(request).catch(err => new Response(err, {status: 499})))
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swpp-backends",
-  "version": "2.3.2",
+  "version": "2.3.7",
   "main": "dist/index.js",
   "typings": "types/index.d.ts",
   "description": "Generate a powerful ServiceWorker for your website.",

package/types/SwppRules.d.ts

@@ -87,9 +87,9 @@ export interface SwppRules {
      *
      * @param request 请求信息
      * @param banCache 是否禁用缓存
-     * @param spare 备用 URL
+     * @param urls 备用 URL 或 URL 竞速的 URL 列表，为空表示需要手动获取
      */
-    fetchFile?: (request: Request, banCache: boolean, spare?: SpareURLs) => Promise<Response>;
+    fetchFile?: (request: Request, banCache: boolean, urls?: SpareURLs | string[]) => Promise<Response>;
     /** 第三方添加的值 */
     [propName: string]: any;
 }