swpp-backends 2.1.6 → 2.1.7-beta.1

package/README.md

@@ -12,9 +12,9 @@ swpp 生成的 SW 与其它插件的对比：
 |:----------:|:-------------:|:------------:|
 |    本地缓存    |      ✔️       |      ✔️      |
 |   缓存增量更新   |      ✔️       |      ❌       |
-|   缓存过期时间   | ❌<sup>1</sup> |      ✔️      |
+|   缓存过期时间   |       ❌       |      ✔️      |
 |   缓存大小限制   |       ❌       |      ✔️      |
-|    预缓存     | ❌<sup>2</sup> |      ✔️      |
+|    预缓存     | ❌<sup>1</sup> |      ✔️      |
 | Request 篡改 |      ✔️       |      ❌       |
 |   URL 竞速   |      ✔️       |      ❌       |
 |   备用 URL   |      ✔️       |      ❌       |
@@ -30,8 +30,7 @@ swpp 生成的 SW 与其它插件的对比：
 + ✔️：支持
 + ❌：不支持
 
-1. 因为有增量更新，所以没提供过期的实现，没必要
-2. 预缓存可以在前端实现，SW 实现这个功能容易拖延注册时间
+1. 预缓存可以在前端实现，SW 实现这个功能容易拖延注册时间
 
 目前支持的平台：
 

package/dist/browser/ServiceWorkerRuntimeTypes.js

@@ -0,0 +1 @@
+"use strict";

package/dist/index.js

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

package/dist/resources/sw-dom.js

@@ -3,22 +3,22 @@ document.addEventListener('DOMContentLoaded', () => {
     const checkServiceWorker = () => 'serviceWorker' in navigator && navigator.serviceWorker.controller
     /** 发送信息到 sw */
     const postMessage2SW = type => navigator.serviceWorker.controller.postMessage(type)
-    const pjaxUpdate = url => new Promise(resolve => {
+    const pjaxUpdate = url => {
         const type = url.endsWith('js') ? 'script' : 'link'
-        const name = type.length === 4 ? 'href' : 'src'
-        for (let item of document.querySelectorAll(type)) {
+        const name = type === 'link' ? 'href' : 'src'
+        for (let item of document.getElementsByTagName(type)) {
             const itUrl = item[name]
             if (url.length > itUrl ? url.endsWith(itUrl) : itUrl.endsWith(url)) {
                 const newEle = document.createElement(type)
                 const content = item.text || item.textContent || item.innerHTML || ''
+                // noinspection JSUnresolvedReference
                 Array.from(item.attributes).forEach(attr => newEle.setAttribute(attr.name, attr.value))
                 newEle.appendChild(document.createTextNode(content))
                 item.parentNode.replaceChildren(newEle, item)
-                return resolve(true)
+                return true
             }
         }
-        resolve(false)
-    })
+    }
     if (!checkServiceWorker()) return
     if (sessionStorage.getItem('updated')) {
         sessionStorage.removeItem('updated');
@@ -33,17 +33,12 @@ document.addEventListener('DOMContentLoaded', () => {
                 sessionStorage.setItem('updated', '1')
                 // noinspection JSUnresolvedVariable,JSUnresolvedFunction
                 if (window.Pjax?.isSupported()) {
-                    Promise.all(list.map(url => {
-                        if (url.endsWith('.js'))
-                            return pjaxUpdate(url)
-                        if (url.endsWith('.css'))
-                            return pjaxUpdate(url)
-                        return Promise.resolve()
-                    })).then(() => location.reload())
-                } else location.reload()
+                    list.filter(url => /\.(js|css)$/.test(url))
+                        .forEach(pjaxUpdate)
+                }
+                location.reload()
                 break
             case 'escape':
-                sessionStorage.setItem('updated', '1')
                 location.reload()
                 break
         }

package/dist/resources/sw-template.js

@@ -5,32 +5,36 @@
     const CACHE_NAME = '@$$[cacheName]'
     /** 控制信息存储地址（必须以`/`结尾） */
     const CTRL_PATH = 'https://id.v3/'
+    let escapeTrigger
 
 // [insertion site] values
 
-    /** 控制信息读写操作 */
-    const dbVersion = {
-        write: (id) => caches.open(CACHE_NAME)
-            .then(cache => cache.put(CTRL_PATH, new Response(JSON.stringify(id)))),
-        /** @return {*} */
-        read: () => caches.match(CTRL_PATH).then(response => response?.json())
-    }
+    /**
+     * 读取本地版本号
+     * @return {Promise<BrowserVersion|undefined>}
+     */
+    const readVersion = () => caches.match(CTRL_PATH).then(response => response?.json())
+    /**
+     * 写入版本号
+     * @param version {BrowserVersion}
+     * @return {Promise<void>}
+     */
+    const writeVersion = version => caches.open(CACHE_NAME)
+        .then(cache => cache.put(CTRL_PATH, new Response(JSON.stringify(version))))
 
     self.addEventListener('install', () => {
         self.skipWaiting()
         const escape = '@$$[escape]'
         if (escape) {
-            dbVersion.read()
-                .then(async oldVersion => {
-                    if (oldVersion?.escape !== escape) {
-                        oldVersion.escape = escape
-                        await dbVersion.write(oldVersion)
-                        // noinspection JSUnresolvedVariable
-                        caches.delete(CACHE_NAME)
-                            .then(() => clients.matchAll())
-                            .then(list => list.forEach(client => client.postMessage({type: 'escape'})))
-                    }
-                })
+            readVersion().then(oldVersion => {
+                if (oldVersion?.escape !== escape) {
+                    escapeTrigger = true
+                    // noinspection JSUnresolvedVariable
+                    caches.delete(CACHE_NAME)
+                        .then(() => clients.matchAll())
+                        .then(list => list.forEach(client => client.postMessage({type: 'escape'})))
+                }
+            })
         }
     })
 
@@ -130,14 +134,10 @@
     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,
-                    old: info.old
-                })
+            updateJson().then(info => {
+                    info.type = 'update'
+                    event.source.postMessage(info)
+                }
             )
     })
 
@@ -155,9 +155,9 @@
 
     /**
      * 根据JSON删除缓存
-     * @returns {Promise<{version, list, old}>}
+     * @returns {Promise<UpdateInfo>}
      */
-    const updateJson = () => {
+    const updateJson = async () => {
         /**
          * 解析elements，并把结果输出到list中
          * @return boolean 是否刷新全站缓存
@@ -176,42 +176,46 @@
         }
         /**
          * 解析字符串
-         * @return {Promise<any>}
+         * @return {Promise<{
+         *     list?: VersionList,
+         *     new: BrowserVersion,
+         *     old: BrowserVersion
+         * }>}
          */
-        const parseJson = json => dbVersion.read().then(oldVersion => {
+        const parseJson = json => readVersion().then(oldVersion => {
             const {info, global} = json
+            /** @type {BrowserVersion} */
             const newVersion = {global, local: info[0].version, escape: oldVersion?.escape ?? 0}
-            //新用户不进行更新操作
-            if (!oldVersion) {
-                dbVersion.write(newVersion)
-                return {version: newVersion, old: oldVersion}
+            // 新用户和刚进行过逃逸操作的用户不进行更新操作
+            if (!oldVersion || escapeTrigger) {
+                // noinspection JSValidateTypes
+                newVersion.escape = '@$$[escape]'
+                escapeTrigger = false
+                writeVersion(newVersion)
+                return {new: newVersion, old: oldVersion}
             }
             let list = new VersionList()
             let refresh = parseChange(list, info, oldVersion.local)
-            dbVersion.write(newVersion)
+            writeVersion(newVersion)
             // [debug escape]
-            //如果需要清理全站
+            // 如果需要清理全站
             if (refresh) {
                 if (global !== oldVersion.global) list.force = true
                 else list.refresh = true
             }
-            return {list, version: newVersion, old: oldVersion}
+            return {list, new: newVersion, old: oldVersion}
         })
-        return fetchFile(new Request('/update.json'), false)
-            .then(response => {
-                if (checkResponse(response))
-                    return response.json().then(json =>
-                        parseJson(json).then(result => {
-                            const info = {version: result.version, old: result.old}
-                            if (result.list)
-                                return deleteCache(result.list)
-                                    .then(list => list.length === 0 ? null : list)
-                                    .then(list => Object.assign({list}, info))
-                            else return info
-                        })
-                    )
-                else throw `加载 update.json 时遇到异常，状态码：${response.status}`
-            })
+        const response = await fetchFile(new Request('/update.json'), false)
+        if (!checkResponse(response))
+            throw `加载 update.json 时遇到异常，状态码：${response.status}`
+        const json = await response.json()
+        const result = await parseJson(json)
+        if (result.list) {
+            const list = await deleteCache(result.list)
+            result.list = list?.length ? list : null
+        }
+        // noinspection JSValidateTypes
+        return result
     }
 
     /**

package/package.json

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

package/types/browser/ServiceWorkerRuntimeTypes.d.ts

@@ -0,0 +1,16 @@
+interface BrowserVersion {
+    /** 逃生门版本号 */
+    escape: number;
+    /** 静态版本号 */
+    global: number;
+    /** 动态版本号 */
+    local: number;
+}
+interface UpdateInfo {
+    /** 新的版本号 */
+    new: BrowserVersion;
+    /** 旧的版本号 */
+    old?: BrowserVersion;
+    /** 刷新的 URL 列表 */
+    list?: string[];
+}