swpp-backends 1.1.0 → 1.1.2

package/README.md

@@ -1,5 +1,41 @@
 ## 欢迎使用 SwppBackends
 
-  这是 Service Worker Plus Plus 的后端仓库，代码正在开发中，开发完毕后会在这里补充文档并上传到 npm。
+swpp-backends（以下简称 swpp）插件的功能是为网站生成一个高度可用的 ServiceWorker（以下简称 SW），为网站优化二次加载、提供离线体验、提高可靠性，并为此附带了一些其它的功能。
 
-  有兴趣的可以看 [hexo-swpp | 山岳库博](https://kmar.top/posts/73014407/)。
+swpp 的全拼为“ServiceWorkerPlusPlus”（或“ServiceWorker++”），但是其与已有的插件“hexo-service-worker”并没有关系，插件中所有代码均为我个人开发，这一点请不要误解。
+
+swpp 生成的 SW 与其它插件的对比：
+
+|            | swpp  | hexo-offline |
+|:----------:|:-----:|:------------:|
+|    本地缓存    |  ✔️   |      ✔️      |
+|   缓存增量更新   |  ✔️   |      ❌       |
+|   缓存过期时间   | ❌^1^  |      ✔️      |
+|   缓存大小限制   |   ❌   |      ✔️      |
+|    预缓存     |   ❌   |      ✔️      |
+| Request 篡改 |  ✔️   |      ❌       |
+|   URL 竞速   |  ✔️   |      ❌       |
+|   备用 URL   |  ✔️   |      ❌       |
+|    阻塞响应    |  ✔️   |      ❌       |
+|    逃生门     |  ✔️   |      ❌       |
+|    跨平台     | ✔️^2^ |      ❌       |
+|    高度自由    |  ✔️   |      ❌       |
+|     更新     | 非常频繁  |   超过两年没有更新   |
+
++ ✔️：支持
++ ❌：不支持
+
+1. 因为有增量更新，所以没提供过期的实现，没必要
+2. 目前只有 hexo 平台存在具体实现，其它平台的暂时还没有
+
+注：上面提到的跨平台是指跨越框架（比如 Hexo、WordPress 等）。
+
+目前支持的平台：
+
+|  平台  |     插件名     |                            文档                             |           作者            |
+|:----:|:-----------:|:---------------------------------------------------------:|:-----------------------:|
+| hexo | `hexo-swpp` | [github](https://github.com/EmptyDreams/hexo-swpp#readme) | [空梦](https://kmar.top/) |
+
+如果你为某一个平台做了适配，可以在 gh 上发布 issue 或者在文档页面发布评论~
+
+文档：[Swpp Backends 官方文档 | 山岳库博](https://kmar.top/posts/b70ec88f/)

package/dist/ServiceWorkerBuilder.js

@@ -57,7 +57,7 @@ function buildServiceWorker() {
     if (blockRequest) {
         content = content.replace('// [blockRequest call]', `
                 if (blockRequest(url))
-                    return event.respondWith(new Response(null, {status: 208}))
+                    return event.respondWith(new Response(null, {status: 204}))
             `);
     }
     // noinspection JSUnresolvedVariable
@@ -128,14 +128,16 @@ const JS_CODE_GET_SPARE_URLS = `
                 Object.assign({
                     signal: (controllers[index] = new AbortController()).signal
                 }, fetchArgs)
-            ).then(response => checkResponse(response) ? {r: response, i: index} : Promise.reject(response.status))
+            ).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 + 2).map(index => startFetch(index))
+                    }, (_, index) => index + 1).map(index => startFetch(index))
                 ]).then(res => {
                     for (let i = 0; i !== list.length; ++i) {
                         if (i !== res.i)
@@ -147,11 +149,16 @@ const JS_CODE_GET_SPARE_URLS = `
             const id = setTimeout(startAll, spare.timeout)
             const first = startFetch(0)
                 .then(res => {
-                    clearTimeout(id)
-                    resolve(res.r)
+                    if (flag) {
+                        clearTimeout(id)
+                        resolve(res.r)
+                    }
                 }).catch(() => {
-                    clearTimeout(id)
-                    startAll()
+                    if (flag) {
+                        clearTimeout(id)
+                        startAll()
+                    }
+                    return Promise.reject()
                 })
         })
     }

package/dist/SwppRules.js

@@ -104,6 +104,7 @@ function loadRules(root, fileName, selects) {
         event(rootRules);
     }
     eventList = null;
+    (0, Utils_1.deepFreeze)(rootRules);
     return _rules = rootRules;
 }
 exports.loadRules = loadRules;

package/dist/Utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceDevRequest = exports.fetchFile = exports.getSource = exports.readEjectData = exports.calcEjectValues = exports.warn = exports.error = void 0;
+exports.deepFreeze = exports.replaceDevRequest = exports.fetchFile = exports.getSource = exports.readEjectData = exports.calcEjectValues = exports.warn = exports.error = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const SwppRules_1 = require("./SwppRules");
 const logger = require('hexo-log').default({
@@ -190,3 +190,15 @@ async function fetchSpeed(list) {
     }
     return result.response;
 }
+/** 深度冻结一个对象，这将使得无法修改对象中的任何值，也无法添加新的值 */
+function deepFreeze(obj) {
+    if (!obj)
+        return;
+    Object.freeze(obj);
+    for (let key in obj) {
+        const value = obj[key];
+        if (typeof value === 'object')
+            deepFreeze(value);
+    }
+}
+exports.deepFreeze = deepFreeze;

package/dist/index.js

@@ -30,6 +30,6 @@ exports.default = {
         getSource: Utils_1.getSource, getShorthand: UpdateJsonBuilder_1.getShorthand, findCache: FileAnalyzer_1.findCache,
         fetchFile: Utils_1.fetchFile, replaceDevRequest: Utils_1.replaceDevRequest, replaceRequest: FileAnalyzer_1.replaceRequest,
         isStable: FileAnalyzer_1.isStable, isExclude: FileAnalyzer_1.isExclude, findFileHandler: FileAnalyzer_1.findFileHandler,
-        eachAllLinkInUrl: FileAnalyzer_1.eachAllLinkInUrl
+        eachAllLinkInUrl: FileAnalyzer_1.eachAllLinkInUrl, deepFreeze: Utils_1.deepFreeze
     }
 };

package/package.json

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

package/types/Utils.d.ts

@@ -39,3 +39,5 @@ export declare function fetchFile(link: string): Promise<import("node-fetch").Re
  * **调用该函数前必须调用过 [loadRules]**
  */
 export declare function replaceDevRequest(link: string): string[] | string;
+/** 深度冻结一个对象，这将使得无法修改对象中的任何值，也无法添加新的值 */
+export declare function deepFreeze(obj: any): void;

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import { readEjectData, getSource, fetchFile, replaceDevRequest, calcEjectValues } from './Utils';
+import { readEjectData, getSource, fetchFile, replaceDevRequest, calcEjectValues, deepFreeze } from './Utils';
 import { isExclude, isStable, loadVersionJson, readOldVersionJson, readNewVersionJson, readMergeVersionMap, buildVersionJson, eachAllLinkInUrl, findCache, findFileHandler, replaceRequest, submitCacheInfo, submitExternalUrl, registryFileHandler } from './FileAnalyzer';
 import { buildServiceWorker } from './ServiceWorkerBuilder';
 import { readRules, loadRules, addRulesMapEvent } from './SwppRules';
@@ -44,6 +44,7 @@ declare const _default: {
         isExclude: typeof isExclude;
         findFileHandler: typeof findFileHandler;
         eachAllLinkInUrl: typeof eachAllLinkInUrl;
+        deepFreeze: typeof deepFreeze;
     };
 };
 export default _default;