swpp-backends 0.0.1-alpha

package/dist/resources/sw-template.js

@@ -0,0 +1,257 @@
+// noinspection JSIgnoredPromiseFromCall
+
+(() => {
+    /** 缓存库名称 */
+    const CACHE_NAME = '@$$[cacheName]'
+    /** 控制信息存储地址（必须以`/`结尾） */
+    const CTRL_PATH = 'https://id.v3/'
+
+// [insertion site] values
+
+    /** 控制信息读写操作 */
+    const dbVersion = {
+        write: (id) => caches.open(CACHE_NAME)
+            .then(cache => cache.put(CTRL_PATH, new Response(JSON.stringify(id)))),
+        read: () => caches.match(CTRL_PATH).then(response => response?.json())
+    }
+
+    self.addEventListener('install', () => {
+        self.skipWaiting()
+        const escape = '@$$[escape]'
+        dbVersion.read().then(oldVersion => {
+            if (oldVersion && oldVersion.escape !== escape) {
+                oldVersion.escape = escape
+                // noinspection JSUnresolvedVariable
+                caches.delete(CACHE_NAME)
+                    .then(() => clients.matchAll())
+                    .then(list => list.forEach(client => client.postMessage({type: 'escape'})))
+            }
+        })
+    })
+
+    // sw 激活后立即对所有页面生效，而非等待刷新
+    // noinspection JSUnresolvedReference
+    self.addEventListener('activate', event => event.waitUntil(clients.claim()))
+
+    // noinspection JSFileReferences
+    const { cacheList, fetchFile, getSpareUrls } = require('../sw-rules')
+
+    // 检查请求是否成功
+    // noinspection JSUnusedLocalSymbols
+    const checkResponse = response => response.ok || [301, 302, 307, 308].includes(response.status)
+
+    /**
+     * 删除指定缓存
+     * @param list 要删除的缓存列表
+     * @return {Promise<string[]>} 删除的缓存的URL列表
+     */
+    const deleteCache = list => caches.open(CACHE_NAME).then(cache => cache.keys()
+        .then(keys => Promise.all(
+            keys.map(async it => {
+                const url = it.url
+                if (url !== CTRL_PATH && list.match(url)) {
+                    // [debug delete]
+                    // noinspection ES6MissingAwait,JSCheckFunctionSignatures
+                    cache.delete(it)
+                    return url
+                }
+                return null
+            })
+        )).then(list => list.filter(it => it))
+    )
+
+    self.addEventListener('fetch', event => {
+        let request = event.request
+        if (request.method !== 'GET' || !request.url.startsWith('http')) return
+        // [modifyRequest call]
+        const url = new URL(request.url)
+        // [blockRequest call]
+        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
+                    })
+                )
+            )
+        } else {
+            const spare = getSpareUrls(request.url)
+            if (spare) event.respondWith(fetchFile(request, false, spare))
+            // [modifyRequest else-if]
+        }
+    })
+
+    self.addEventListener('message', event => {
+        // [debug message]
+        if (event.data === 'update')
+            updateJson().then(info =>
+                // noinspection JSUnresolvedVariable
+                event.source.postMessage({
+                    type: 'update',
+                    update: info.list,
+                    version: info.version,
+                })
+            )
+    })
+
+    /** 判断指定url击中了哪一种缓存，都没有击中则返回null */
+    function findCache(url) {
+        if (url.hostname === 'localhost') return
+        for (let key in cacheList) {
+            const value = cacheList[key]
+            if (value.match(url)) return value
+        }
+    }
+
+    /**
+     * 根据JSON删除缓存
+     * @returns {Promise<{version, list}>}
+     */
+    const updateJson = () => {
+        /**
+         * 解析elements，并把结果输出到list中
+         * @return boolean 是否刷新全站缓存
+         */
+        const parseChange = (list, elements, ver) => {
+            for (let element of elements) {
+                const {version, change} = element
+                if (version === ver) return false
+                if (change) {
+                    for (let it of change)
+                        list.push(new CacheChangeExpression(it))
+                }
+            }
+            // 跨版本幅度过大，直接清理全站
+            return true
+        }
+        /** 解析字符串 */
+        const parseJson = json => dbVersion.read().then(oldVersion => {
+            const {info, global} = json
+            const newVersion = {global, local: info[0].version, escape: oldVersion?.escape}
+            //新用户不进行更新操作
+            if (!oldVersion) {
+                dbVersion.write(newVersion)
+                return newVersion
+            }
+            let list = new VersionList()
+            let refresh = parseChange(list, info, oldVersion.local)
+            dbVersion.write(newVersion)
+            // [debug escape]
+            //如果需要清理全站
+            if (refresh) {
+                if (global !== oldVersion.global) list.refresh = true
+                else list.clean(new CacheChangeExpression({'flag': 'all'}))
+            }
+            return {list, version: newVersion}
+        })
+        return fetchFile(new Request('/update.json'), false)
+            .then(response => {
+                if (checkResponse(response))
+                    return response.json().then(json =>
+                        parseJson(json).then(result => {
+                                return result.list ? deleteCache(result.list)
+                                    .then(list => list.length === 0 ? null : list)
+                                    .then(list => ({list, version: result.version}))
+                                    : {version: result}
+                            }
+                        )
+                    )
+                else throw `加载 update.json 时遇到异常，状态码：${response.status}`
+            })
+    }
+
+    /**
+     * 版本列表
+     * @constructor
+     */
+    function VersionList() {
+
+        const list = []
+
+        /**
+         * 推送一个表达式
+         * @param element {CacheChangeExpression} 要推送的表达式
+         */
+        this.push = element => {
+            list.push(element)
+        }
+
+        /**
+         * 清除列表，并将指定元素推入列表中
+         * @param element {CacheChangeExpression} 要推入的元素，留空表示不推入
+         */
+        this.clean = element => {
+            list.length = 0
+            if (!element) this.push(element)
+        }
+
+        /**
+         * 判断指定 URL 是否和某一条规则匹配
+         * @param url {string} URL
+         * @return {boolean}
+         */
+        this.match = url => {
+            if (this.refresh) return true
+            else {
+                for (let it of list) {
+                    if (it.match(url)) return true
+                }
+            }
+            return false
+        }
+
+    }
+
+    // noinspection SpellCheckingInspection
+    /**
+     * 缓存更新匹配规则表达式
+     * @param json 格式{"flag": ..., "value": ...}
+     * @see https://kmar.top/posts/bcfe8408/#23bb4130
+     * @constructor
+     */
+    function CacheChangeExpression(json) {
+        const checkCache = url => {
+            const cache = findCache(new URL(url))
+            return !cache || cache.clean
+        }
+        /**
+         * 遍历所有value
+         * @param action {function(string): boolean} 接受value并返回bool的函数
+         * @return {boolean} 如果value只有一个则返回`action(value)`，否则返回所有运算的或运算（带短路）
+         */
+        const forEachValues = action => {
+            const value = json.value
+            if (Array.isArray(value)) {
+                for (let it of value) {
+                    if (action(it)) return true
+                }
+                return false
+            } else return action(value)
+        }
+        const getMatch = () => {
+            switch (json['flag']) {
+                case 'html':
+                    return url => url.match(/(\/|\.html)$/)
+                case 'end':
+                    return url => forEachValues(value => url.endsWith(value))
+                case 'begin':
+                    return url => forEachValues(value => url.startsWith(value))
+                case 'str':
+                    return url => forEachValues(value => url.includes(value))
+                case 'reg':
+                    return url => forEachValues(value => url.match(new RegExp(value, 'i')))
+                default: throw `未知表达式：${JSON.stringify(json)}`
+            }
+        }
+        this.match = getMatch()
+    }
+})()

package/dist/serviceWorkerBuilder.js

@@ -0,0 +1,152 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildServiceWorker = void 0;
+const SwppRules_1 = require("./SwppRules");
+const Utils_1 = require("./Utils");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * 构建 sw
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ * + **执行该函数前必须调用过 [calcEjectValues]**
+ */
+function buildServiceWorker() {
+    const rules = (0, SwppRules_1.readRules)();
+    const eject = (0, Utils_1.readEjectData)();
+    const { modifyRequest, fetchFile, getRaceUrls, getSpareUrls, blockRequest, config } = rules;
+    const serviceWorkerConfig = config.serviceWorker;
+    const templatePath = path_1.default.resolve('./', module.path, 'sw-template.js');
+    // 获取拓展文件
+    let cache = (0, Utils_1.getSource)(rules, undefined, [
+        'cacheList', 'modifyRequest', 'getCdnList', 'getSpareUrls', 'blockRequest', 'fetchFile',
+        ...('external' in rules && Array.isArray(rules.external) ? rules.external : [])
+    ], true) + '\n';
+    if (!fetchFile) {
+        if (getRaceUrls)
+            cache += JS_CODE_GET_CDN_LIST;
+        else if (getSpareUrls)
+            cache += JS_CODE_GET_SPARE_URLS;
+        else
+            cache += JS_CODE_DEF_FETCH_FILE;
+    }
+    if (!getSpareUrls)
+        cache += `\nconst getSpareUrls = _ => {}`;
+    if ('afterJoin' in rules)
+        cache += `(${(0, Utils_1.getSource)(rules['afterJoin'])})()\n`;
+    if ('afterTheme' in rules)
+        cache += `(${(0, Utils_1.getSource)(rules['afterTheme'])})()\n`;
+    const keyword = "const { cacheList, fetchFile, getSpareUrls } = 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 (modifyRequest) {
+        content = content.replaceAll('// [modifyRequest call]', `
+                const modify = modifyRequest(request)
+                if (modify) request = modify
+            `).replaceAll('// [modifyRequest else-if]', `
+                else if (modify) event.respondWith(fetch(request))
+            `);
+    }
+    if (blockRequest) {
+        content = content.replace('// [blockRequest call]', `
+                if (blockRequest(url))
+                    return event.respondWith(new Response(null, {status: 208}))
+            `);
+    }
+    // noinspection JSUnresolvedVariable
+    if (serviceWorkerConfig.debug) {
+        content = content.replaceAll('// [debug delete]', `
+                console.debug(\`delete cache: \${url}\`)
+            `).replaceAll('// [debug put]', `
+                console.debug(\`put cache: \${key}\`)
+            `).replaceAll('// [debug message]', `
+                console.debug(\`receive: \${event.data}\`)
+            `).replaceAll('// [debug escape]', `
+                console.debug(\`escape: \${aid}\`)
+            `);
+    }
+    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'
+    })
+`;
+// getCdnList 函数的代码
+const JS_CODE_GET_CDN_LIST = `
+    const fetchFile = (request, banCache) => {
+        const fetchArgs = {
+            cache: banCache ? 'no-store' : 'default',
+            mode: 'cors',
+            credentials: 'same-origin'
+        }
+        const list = getCdnList(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 = []
+        let error = 0
+        return new Promise((resolve, reject) => {
+            const pull = () => {
+                const flag = controllers.length
+                if (flag === list.length) return
+                const plusError = () => {
+                    if (++error === list.length) reject(\`请求 \${request.url} 失败\`)
+                    else if (flag + 1 === controllers.length) {
+                        clearTimeout(controllers[flag].id)
+                        pull()
+                    }
+                }
+                controllers.push({
+                    ctrl: new AbortController(),
+                    id: setTimeout(pull, spare.timeout)
+                })
+                fetch(new Request(list[flag], request), fetchArgs).then(response => {
+                    if (checkResponse(response)) {
+                        for (let i in controllers) {
+                            if (i !== flag) controllers[i].ctrl.abort()
+                            clearTimeout(controllers[i].id)
+                        }
+                        resolve(response)
+                    } else plusError()
+                }).catch(plusError)
+            }
+            pull()
+        })
+    }
+`;

package/dist/swppRules.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadRules = exports.addRulesMapEvent = exports.readRules = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const defConfig = {
+    serviceWorker: {
+        escape: 0,
+        cacheName: 'kmarBlogCache',
+        debug: false
+    },
+    register: {
+        onerror: () => console.error('Service Worker 注册失败！可能是由于您的浏览器不支持该功能！'),
+        builder: (root, _, pluginConfig) => {
+            const registerConfig = pluginConfig.register;
+            const { onerror, onsuccess } = registerConfig;
+            return `<script>
+                (() => {
+                    let sw = navigator.serviceWorker
+                    let error = ${onerror.toString()}
+                    if (!sw?.register('${new URL(root).pathname}sw.js')
+                        ${onsuccess ? '?.then(' + onsuccess.toString() + ')' : ''}
+                        ?.catch(error)
+                    ) error()
+                })()
+            </script>`;
+        }
+    },
+    dom: {},
+    json: {
+        maxHtml: 15,
+        charLimit: 1024,
+        merge: [],
+        exclude: {
+            localhost: [/^\/sw\.js$/],
+            other: []
+        }
+    },
+    external: {
+        timeout: 5000,
+        js: [],
+        stable: [],
+        replacer: it => it
+    }
+};
+const eventList = [];
+let _rules;
+/**
+ * 读取最后一次构建的 rules
+ *
+ * **执行该函数前必须调用过 [loadRules]**
+ */
+function readRules() {
+    if (!_rules)
+        throw 'rules 尚未初始化';
+    return _rules;
+}
+exports.readRules = readRules;
+/**
+ * 添加一个 rules 映射事件，这个事件允许用户修改 rules 的内容
+ *
+ * 执行时按照注册的顺序执行
+ */
+function addRulesMapEvent(mapper) {
+    eventList.push(mapper);
+}
+exports.addRulesMapEvent = addRulesMapEvent;
+/**
+ * 加载 rules 文件
+ * @param root 项目根目录
+ * @param fileName rules 文件名称
+ * @param selects 附加的可选目录，优先级低于 [root]
+ */
+function loadRules(root, fileName, selects) {
+    // 支持的拓展名
+    const extensions = ['cjs', 'js'];
+    // 根目录下的 rules 文件
+    const rootPath = extensions.map(it => path_1.default.resolve(root, `${fileName}.${it}`))
+        .find(it => fs_1.default.existsSync(it));
+    // 其它可选目录下的 rules 文件
+    const selectPath = selects.flatMap(value => extensions.map(it => path_1.default.resolve(value, `${fileName}.${it}`))).find(it => fs_1.default.existsSync(it));
+    if (!(rootPath || selectPath))
+        throw '未查询到 rules 文件';
+    const rootRules = rootPath ? { ...require(rootPath) } : {};
+    const selectRules = selectPath ? require(selectPath) : {};
+    const config = rootRules.config ?? {};
+    mergeConfig(config, selectRules.config ?? {});
+    mergeConfig(config, defConfig);
+    Object.assign(rootRules, selectRules);
+    rootRules.config = config;
+    for (let event of eventList) {
+        event(rootRules);
+    }
+    return _rules = rootRules;
+}
+exports.loadRules = loadRules;
+/** 合并配置项 */
+function mergeConfig(dist, that) {
+    for (let key in that) {
+        const distValue = dist[key];
+        const thatValue = that[key];
+        if (!thatValue)
+            continue;
+        switch (typeof distValue) {
+            case "undefined":
+                dist[key] = thatValue;
+                break;
+            case "object":
+                mergeConfig(distValue, thatValue);
+                break;
+        }
+    }
+    return dist;
+}