🐛 修复uuid导致的同步问题 #141 #133

Author: CodFrm

docs/架构设计.md

@@ -96,3 +96,13 @@ LoggerCore.getInstance().logger({ env: "background" }).info("background start");
 为了兼容油猴脚本，必须引入测试，主要针对油猴运行时的沙盒进行测试，以保证每次修改不会破坏兼容性。使用[`jest`](https://jestjs.io/zh-Hans/)作为测试框架，编写时也需要考虑代码的一个可测试性。单元测试文件与代码放在同级目录下（\*.ts/\*.test.ts)，不另外开`tests`文件夹。
 
 
+## uuid生成逻辑与脚本安装
+
+### uuid生成逻辑
+随机生成uuid
+
+### 脚本安装
+首先通过name+namespace搜索是否有同名脚本, 没有则生成随机uuid安装, 有则使用同名脚本的uuid进行安装
+
+### 脚本更新
+传递脚本uuid, 使用uuid进行更新

src/app/service/script/manager.ts

@@ -1,3 +1,4 @@
+import { v4 as uuidv4 } from "uuid";
 import { fetchScriptInfo, prepareScriptByCode } from "@App/pkg/utils/script";
 import Cache from "@App/app/cache";
 import CacheKey from "@App/pkg/utils/cache_key";
@@ -97,8 +98,11 @@ export class ScriptManager extends Manager {
       },
       {
         urls: [
+          "*://*/*.user.js",
           "*://*/*.user.js?*",
+          "https://*/*.user.sub.js",
           "https://*/*.user.sub.js?*",
+          "https://*/*.user.bg.js",
           "https://*/*.user.bg.js?*",
         ],
         types: ["main_frame"],
@@ -116,7 +120,7 @@ export class ScriptManager extends Manager {
   }
 
   public openInstallPageByUrl(url: string) {
-    return fetchScriptInfo(url, "user", false).then((info) => {
+    return fetchScriptInfo(url, "user", false, uuidv4()).then((info) => {
       Cache.getInstance().set(CacheKey.scriptInfo(info.uuid), info);
       setTimeout(() => {
         // 清理缓存
@@ -141,7 +145,12 @@ export class ScriptManager extends Manager {
       name: script.name,
     });
     try {
-      const info = await fetchScriptInfo(script.checkUpdateUrl, source, false);
+      const info = await fetchScriptInfo(
+        script.checkUpdateUrl,
+        source,
+        false,
+        script.uuid
+      );
       const { metadata } = info;
       if (!metadata) {
         logger.error("parse metadata failed");
@@ -177,7 +186,12 @@ export class ScriptManager extends Manager {
       downloadUrl: script.downloadUrl,
       checkUpdateUrl: script.checkUpdateUrl,
     });
-    fetchScriptInfo(script.downloadUrl || script.checkUpdateUrl!, source, true)
+    fetchScriptInfo(
+      script.downloadUrl || script.checkUpdateUrl!,
+      source,
+      true,
+      script.uuid
+    )
       .then(async (info) => {
         // 是否静默更新
         if (this.systemConfig.silenceUpdateScript) {
@@ -217,7 +231,7 @@ export class ScriptManager extends Manager {
     source: InstallSource,
     subscribeUrl?: string
   ) {
-    const info = await fetchScriptInfo(url, "system", false);
+    const info = await fetchScriptInfo(url, "system", false, uuidv4());
     const script = await prepareScriptByCode(info.code, url, info.uuid);
     script.subscribeUrl = subscribeUrl;
     await this.event.upsertHandler(script, "system");

src/pages/install/description.tsx

@@ -128,7 +128,11 @@ export default function Description() {
         setOldScript(script.oldSubscribe);
         delete script.oldSubscribe;
       } else {
-        script = await prepareScriptByCode(resp.code, resp.url);
+        if (resp.isUpdate) {
+          script = await prepareScriptByCode(resp.code, resp.url, resp.uuid);
+        } else {
+          script = await prepareScriptByCode(resp.code, resp.url);
+        }
         setOldScript(script.oldScript);
         delete script.oldScript;
       }

src/pkg/utils/script.ts

@@ -1,4 +1,4 @@
-import { v4 as uuidv4, v5 as uuidv5 } from "uuid";
+import { v4 as uuidv4 } from "uuid";
 import {
   Metadata,
   Script,
@@ -95,7 +95,8 @@ export type ScriptInfo = {
 export async function fetchScriptInfo(
   url: string,
   source: InstallSource,
-  isUpdate: boolean
+  isUpdate: boolean,
+  uuid: string
 ): Promise<ScriptInfo> {
   const resp = await fetch(url, {
     headers: {
@@ -110,7 +111,6 @@ export async function fetchScriptInfo(
   if (!ok) {
     throw new Error("parse script info failed");
   }
-  const uuid = uuidv5(url, uuidv5.URL);
   const ret: ScriptInfo = {
     url,
     code: body,
@@ -129,7 +129,7 @@ export async function fetchScriptInfo(
 export function copyScript(script: Script, old: Script): Script {
   const ret = script;
   ret.id = old.id;
-  // ret.uuid = old.uuid;
+  ret.uuid = old.uuid;
   ret.createtime = old.createtime;
   ret.lastruntime = old.lastruntime;
   // ret.delayruntime = old.delayruntime;
@@ -247,16 +247,15 @@ export function prepareScriptByCode(
         [, domain] = urlSplit;
       }
     }
-    if (!uuid) {
-      if (url) {
-        uuid = uuidv5(url, uuidv5.URL);
-      } else {
-        uuid = uuidv4();
-      }
+    let newUUID = "";
+    if (uuid) {
+      newUUID = uuid;
+    } else {
+      newUUID = uuidv4();
     }
     let script: Script & { oldScript?: Script } = {
       id: 0,
-      uuid,
+      uuid: newUUID,
       name: metadata.name[0],
       code,
       author: metadata.author && metadata.author[0],