swpp-backends 2.0.9 → 2.1.2

package/README.md

@@ -1,3 +1,5 @@
+![swpp](./swpp.jpg)
+
 ## 欢迎使用 SwppBackends
 
 swpp-backends（以下简称 swpp）插件的功能是为网站生成一个高度可用的 ServiceWorker（以下简称 SW），为网站优化二次加载、提供离线体验、提高可靠性，并为此附带了一些其它的功能。

package/dist/FileAnalyzer.js

@@ -27,12 +27,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.replaceRequest = exports.findCache = exports.eachAllLinkInUrl = exports.findFileHandler = exports.registryFileHandler = exports.submitExternalUrl = exports.submitCacheInfo = exports.loadVersionJson = exports.isStable = exports.isExclude = exports.buildVersionJson = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const node_fetch_1 = require("node-fetch");
-const crypto = __importStar(require("crypto"));
 const buffer_1 = require("buffer");
+const crypto = __importStar(require("crypto"));
 const fast_html_parser_1 = __importDefault(require("fast-html-parser"));
+const fs_1 = __importDefault(require("fs"));
+const node_fetch_1 = require("node-fetch");
+const path_1 = __importDefault(require("path"));
+const SwppConfig_1 = require("./SwppConfig");
 const Utils_1 = require("./Utils");
 const Variant_1 = require("./Variant");
 /**
@@ -172,20 +173,22 @@ exports.isStable = isStable;
  *
  * + **执行该函数前必须调用过 [loadRules]**
  */
-async function loadVersionJson(url) {
+async function loadVersionJson(url, level = SwppConfig_1.FileFetchModeLevel.NORMAL) {
     const key = 'oldVersionJson';
     const response = await (0, Utils_1.fetchFile)(url).catch(err => err);
-    if (response.status === 404 || response?.code === 'ENOTFOUND') {
-        (0, Utils_1.warn)('VersionJsonLoader', `拉取 ${url} 时出现 404 错误，如果您是第一次构建请忽略这个警告。`);
-        return (0, Variant_1.writeVariant)(key, null);
-    }
-    else if (![200, 301, 302, 307, 308].includes(response.status)) {
-        (0, Utils_1.error)('VersionJsonLoader', `拉取 ${url} 时出现 ${response.status} 错误！`);
-        if ('status' in response)
-            throw `拉取时出现 ${response.status} 异常`;
-        throw response;
+    switch (true) {
+        case response.status == 404 && level >= SwppConfig_1.FileFetchModeLevel.NORMAL:
+        case response.code == 'ENOTFOUND' && level == SwppConfig_1.FileFetchModeLevel.LOOSE:
+            (0, Utils_1.warn)('VersionJsonLoader', `拉取 ${url} 时出现 404 错误，如果您是第一次构建请忽略这个警告。`);
+            return (0, Variant_1.writeVariant)(key, null);
+        default:
+            (0, Utils_1.error)('VersionJsonLoader', `拉取 ${url} 时出现 ${response.status} 错误！`);
+            if ('status' in response)
+                throw `拉取时出现 ${response.status} 异常`;
+            throw response;
+        case [200, 301, 302, 307, 308].includes(response.status):
+            return (0, Variant_1.writeVariant)(key, await response.json());
     }
-    return (0, Variant_1.writeVariant)(key, await response.json());
 }
 exports.loadVersionJson = loadVersionJson;
 /** 提交要存储到 version json 的值 */

package/dist/ServiceWorkerBuilder.js

@@ -30,6 +30,7 @@ function buildServiceWorker() {
         ...('external' in rules && Array.isArray(rules.external) ? rules.external : [])
     ], true) + '\n';
     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)
@@ -53,9 +54,12 @@ function buildServiceWorker() {
     if (modifyRequest) {
         content = content.replaceAll('// [modifyRequest call]', `
                 const modify = modifyRequest(request)
-                if (modify) request = modify
+                if (modify) {
+                    request = modify
+                    url = new URL(request.url)
+                }
             `).replaceAll('// [modifyRequest else-if]', `
-                else if (modify) event.respondWith(fetch(request))
+                else if (modify) handleFetch(fetchFile(request, false))
             `);
     }
     if (blockRequest) {
@@ -79,91 +83,3 @@ function buildServiceWorker() {
     return content;
 }
 exports.buildServiceWorker = buildServiceWorker;
-// 缺省的 fetchFile 函数的代码
-const JS_CODE_DEF_FETCH_FILE = `
-    const fetchFile = (request, banCache) => fetch(request, {
-        cache: banCache ? "no-store" : "default",
-        mode: 'cors',
-        credentials: 'same-origin'
-    })
-`;
-// getRaceUrls 函数的代码
-const JS_CODE_GET_CDN_LIST = `
-    const fetchFile = (request, banCache) => {
-        const fetchArgs = {
-            cache: banCache ? 'no-store' : 'default',
-            mode: 'cors',
-            credentials: 'same-origin'
-        }
-        const list = getRaceUrls(request.url)
-        if (!list || !Promise.any) return fetch(request, fetchArgs)
-        const res = list.map(url => new Request(url, request))
-        const controllers = []
-        return Promise.any(res.map(
-            (it, index) => fetch(it, Object.assign(
-                {signal: (controllers[index] = new AbortController()).signal},
-                fetchArgs
-            )).then(response => checkResponse(response) ? {index, response} : Promise.reject())
-        )).then(it => {
-            for (let i in controllers) {
-                if (i != it.index) controllers[i].abort()
-            }
-            return it.response
-        })
-    }
-`;
-// getSpareUrls 函数的代码
-const JS_CODE_GET_SPARE_URLS = `
-    const fetchFile = (request, banCache, spare = null) => {
-        const fetchArgs = {
-            cache: banCache ? 'no-store' : 'default',
-            mode: 'cors',
-            credentials: 'same-origin'
-        }
-        if (!spare) {
-            spare = getSpareUrls(request.url)
-            if (!spare) return fetch(request, fetchArgs)
-        }
-        const list = spare.list
-        const controllers = new Array(list.length)
-        const startFetch =
-            index => fetch(
-                new Request(list[index], request),
-                Object.assign({
-                    signal: (controllers[index] = new AbortController()).signal
-                }, fetchArgs)
-            ).then(response => checkResponse(response) ? {r: response, i: index} : Promise.reject())
-        return new Promise((resolve, reject) => {
-            let flag = true
-            const startAll = () => {
-                flag = false
-                Promise.any([
-                    first,
-                    ...Array.from({
-                        length: list.length - 1
-                    }, (_, index) => index + 1).map(index => startFetch(index))
-                ]).then(res => {
-                    for (let i = 0; i !== list.length; ++i) {
-                        if (i !== res.i)
-                            controllers[i].abort()
-                    }
-                    resolve(res.r)
-                }).catch(() => reject(\`请求 \${request.url} 失败\`))
-            }
-            const id = setTimeout(startAll, spare.timeout)
-            const first = startFetch(0)
-                .then(res => {
-                    if (flag) {
-                        clearTimeout(id)
-                        resolve(res.r)
-                    }
-                }).catch(() => {
-                    if (flag) {
-                        clearTimeout(id)
-                        startAll()
-                    }
-                    return Promise.reject()
-                })
-        })
-    }
-`;

package/dist/SwppConfig.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileFetchModeLevel = void 0;
+/** 文件拉取模式等级 */
+var FileFetchModeLevel;
+(function (FileFetchModeLevel) {
+    /** 严格，不允许 404 */
+    FileFetchModeLevel[FileFetchModeLevel["STRICT"] = 0] = "STRICT";
+    /** 普通，允许 404，但仅允许服务器返回 404 状态码 */
+    FileFetchModeLevel[FileFetchModeLevel["NORMAL"] = 1] = "NORMAL";
+    /** 宽松，允许任何形式的 404，包括服务器返回 404、DNS 解析失败等 */
+    FileFetchModeLevel[FileFetchModeLevel["LOOSE"] = 2] = "LOOSE";
+})(FileFetchModeLevel || (exports.FileFetchModeLevel = FileFetchModeLevel = {}));

package/dist/UpdateJsonBuilder.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getShorthand = exports.loadUpdateJson = exports.submitChange = exports.buildUpdateJson = void 0;
+const SwppConfig_1 = require("./SwppConfig");
 const Utils_1 = require("./Utils");
 const Variant_1 = require("./Variant");
 /**
@@ -112,20 +113,22 @@ exports.submitChange = submitChange;
  *
  * + **调用该函数前必须调用过 [loadRules]**
  */
-async function loadUpdateJson(url) {
+async function loadUpdateJson(url, level = SwppConfig_1.FileFetchModeLevel.NORMAL) {
     const key = 'oldUpdateJson';
     const response = await (0, Utils_1.fetchFile)(url).catch(err => err);
-    if (response.status === 404 || response.code === 'ENOTFOUND') {
-        (0, Utils_1.warn)('UpdateJsonLoader', `拉取 ${url} 时出现 404 错误，如果您是第一次构建请忽略这个警告。`);
-        return (0, Variant_1.writeVariant)(key, null);
+    switch (true) {
+        case response.status == 404 && (level >= SwppConfig_1.FileFetchModeLevel.NORMAL):
+        case response.code == 'ENOTFOUND' && (level == SwppConfig_1.FileFetchModeLevel.LOOSE):
+            (0, Utils_1.warn)('UpdateJsonLoader', `拉取 ${url} 时出现 404 错误，如果您是第一次构建请忽略这个警告。`);
+            return (0, Variant_1.writeVariant)(key, null);
+        default:
+            (0, Utils_1.error)('UpdateJsonLoader', `拉取 ${url} 时出现 ${response.status} 错误！`);
+            if ('status' in response)
+                throw `拉取时出现 ${response.status} 异常`;
+            throw response;
+        case [200, 301, 302, 307, 308].includes(response.status):
+            return (0, Variant_1.writeVariant)(key, await response.json());
     }
-    else if (![200, 301, 302, 307, 308].includes(response.status)) {
-        (0, Utils_1.error)('UpdateJsonLoader', `拉取 ${url} 时出现 ${response.status} 错误！`);
-        if ('status' in response)
-            throw `拉取时出现 ${response.status} 异常`;
-        throw response;
-    }
-    return (0, Variant_1.writeVariant)(key, await response.json());
 }
 exports.loadUpdateJson = loadUpdateJson;
 function zipJson(json) {

package/dist/index.js

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

package/dist/resources/sw-fetch.js

@@ -0,0 +1,92 @@
+/** @type function */
+let getRaceUrls, checkResponse, getSpareUrls
+
+module.exports.JS_CODE_DEF_FETCH_FILE = 'const fetchFile = ' + (
+    (request, banCache) => fetch(request, {
+        cache: banCache ? "no-store" : "default",
+        mode: 'cors',
+        credentials: 'same-origin'
+    })
+).toString()
+
+module.exports.JS_CODE_GET_CDN_LIST= 'const fetchFile = ' + (
+    (request, banCache) => {
+        const fetchArgs = {
+            cache: banCache ? 'no-store' : 'default',
+            mode: 'cors',
+            credentials: 'same-origin'
+        }
+        const list = getRaceUrls(request.url)
+        if (!list || !Promise.any) return fetch(request, fetchArgs)
+        const res = list.map(url => new Request(url, request))
+        const controllers = []
+        // noinspection JSCheckFunctionSignatures
+        return Promise.any(res.map(
+            (it, index) => fetch(it, Object.assign(
+                {signal: (controllers[index] = new AbortController()).signal},
+                fetchArgs
+            )).then(response => checkResponse(response) ? {index, response} : Promise.reject())
+        )).then(it => {
+            for (let i in controllers) {
+                if (i !== it.index) controllers[i].abort()
+            }
+            return it.response
+        })
+    }
+).toString()
+
+module.exports.JS_CODE_GET_SPARE_URLS = 'const fetchFile = ' + (
+    (request, banCache, spare = null) => {
+        const fetchArgs = {
+            cache: banCache ? 'no-store' : 'default',
+            mode: 'cors',
+            credentials: 'same-origin'
+        }
+        if (!spare) {
+            spare = getSpareUrls(request.url)
+            if (!spare) return fetch(request, fetchArgs)
+        }
+        const list = spare.list
+        const controllers = new Array(list.length)
+        // noinspection JSCheckFunctionSignatures
+        const startFetch =
+            index => fetch(
+                new Request(list[index], request),
+                Object.assign({
+                    signal: (controllers[index] = new AbortController()).signal
+                }, fetchArgs)
+            ).then(response => checkResponse(response) ? {r: response, i: index} : Promise.reject())
+        return new Promise((resolve, reject) => {
+            let flag = true
+            const startAll = () => {
+                flag = false
+                Promise.any([
+                    first,
+                    ...Array.from({
+                        length: list.length - 1
+                    }, (_, index) => index + 1).map(index => startFetch(index))
+                ]).then(res => {
+                    for (let i = 0; i !== list.length; ++i) {
+                        if (i !== res.i)
+                            controllers[i].abort()
+                    }
+                    resolve(res.r)
+                }).catch(() => reject(`请求 ${request.url} 失败`))
+            }
+            const id = setTimeout(startAll, spare.timeout)
+            const first = startFetch(0)
+                .then(res => {
+                    if (flag) {
+                        clearTimeout(id)
+                        resolve(res.r)
+                    }
+                }).catch(() => {
+                    if (flag) {
+                        clearTimeout(id)
+                        startAll()
+                    }
+                    return Promise.reject()
+                })
+        })
+    }
+).toString()

package/dist/resources/sw-template.js

@@ -63,33 +63,65 @@
         )).then(list => list.filter(it => it))
     )
 
+    /**
+     * 缓存列表
+     * @type {Map<string, {s, e}[]>}
+     */
+    const cacheMap = new Map()
+
     self.addEventListener('fetch', event => {
         let request = event.request
+        let url = new URL(request.url)
+        // [blockRequest call]
         if (request.method !== 'GET' || !request.url.startsWith('http')) return
         // [modifyRequest call]
-        const url = new URL(request.url)
-        // [blockRequest call]
+        let cacheKey = url.hostname + url.pathname + url.search
+        let cache = cacheMap.get(cacheKey)
+        if (cache) {
+            return event.respondWith(
+                new Promise((resolve, reject) => {
+                    cacheMap.get(cacheKey).push({s: resolve, e: reject})
+                })
+            )
+        }
+        cacheMap.set(cacheKey, cache = [])
+        /** 处理拉取 */
+        const handleFetch = promise =>
+            event.respondWith(promise.then(response => {
+                for (let item of cache) {
+                    item.s(response.clone())
+                }
+            }).catch(err => {
+                for (let item of cache) {
+                    item.e(err)
+                }
+            }).then(() => {
+                cacheMap.delete(cacheKey)
+                return promise
+            }))
         const cacheRule = findCache(url)
         if (cacheRule) {
             let key = `https://${url.host}${url.pathname}`
             if (key.endsWith('/index.html')) key = key.substring(0, key.length - 10)
             if (cacheRule.search) key += url.search
-            event.respondWith(caches.match(key)
-                .then(cache => cache ?? fetchFile(request, true)
-                    .then(response => {
-                        if (checkResponse(response)) {
-                            const clone = response.clone()
-                            caches.open(CACHE_NAME).then(it => it.put(key, clone))
-                            // [debug put]
-                        }
-                        return response
-                    })
+            handleFetch(
+                caches.match(key).then(
+                    cache => cache ?? fetchFile(request, true)
+                        .then(response => {
+                            if (checkResponse(response)) {
+                                const clone = response.clone()
+                                caches.open(CACHE_NAME).then(it => it.put(key, clone))
+                                // [debug put]
+                            }
+                            return response
+                        })
                 )
             )
         } else {
             const spare = getSpareUrls(request.url)
-            if (spare) event.respondWith(fetchFile(request, false, spare))
+            if (spare) handleFetch(fetchFile(request, false, spare))
             // [modifyRequest else-if]
+            else handleFetch(fetch(request))
         }
     })
 
@@ -106,8 +138,11 @@
             )
     })
 
-    /** 判断指定url击中了哪一种缓存，都没有击中则返回null */
-    function findCache(url) {
+    /**
+     * 判断指定 url 击中了哪一种缓存，都没有击中则返回 null
+     * @param url {URL}
+     */
+    const findCache = url => {
         if (url.hostname === 'localhost') return
         for (let key in cacheRules) {
             const value = cacheRules[key]

package/package.json

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

package/types/FileAnalyzer.d.ts

@@ -1,3 +1,4 @@
+import { FileFetchModeLevel } from './SwppConfig';
 /**
  * 构建一个 version json
  *
@@ -51,7 +52,7 @@ export declare function isStable(url: string): boolean;
  *
  * + **执行该函数前必须调用过 [loadRules]**
  */
-export declare function loadVersionJson(url: string): Promise<VersionJson | null>;
+export declare function loadVersionJson(url: string, level?: FileFetchModeLevel): Promise<VersionJson | null>;
 /** 提交要存储到 version json 的值 */
 export declare function submitCacheInfo(key: string, value: any): void;
 /** 添加一个要监听的 URL */

package/types/SwppConfig.d.ts

@@ -127,3 +127,12 @@ export interface SwppConfigTemplate {
         replacer?: (srcUrl: string) => string[] | string;
     };
 }
+/** 文件拉取模式等级 */
+export declare enum FileFetchModeLevel {
+    /** 严格，不允许 404 */
+    STRICT = 0,
+    /** 普通，允许 404，但仅允许服务器返回 404 状态码 */
+    NORMAL = 1,
+    /** 宽松，允许任何形式的 404，包括服务器返回 404、DNS 解析失败等 */
+    LOOSE = 2
+}

package/types/UpdateJsonBuilder.d.ts

@@ -1,3 +1,4 @@
+import { FileFetchModeLevel } from './SwppConfig';
 import { AnalyzeResult } from './VersionAnalyzer';
 /**
  * 构建新的 update json
@@ -18,7 +19,7 @@ export declare function submitChange(...change: ChangeExpression[]): void;
  *
  * + **调用该函数前必须调用过 [loadRules]**
  */
-export declare function loadUpdateJson(url: string): Promise<UpdateJson | null>;
+export declare function loadUpdateJson(url: string, level?: FileFetchModeLevel): Promise<UpdateJson | null>;
 /**
  * 获取 URL 的缩写形式
  *