♻️ ScriptMatchInfo 相关代码优化 (#653)

* ScriptMatchInfo 相关代码优化

* 不能使用delete

* ruleContent 不能含有 RegExp

* 修复后台脚本资源

* SUFFIX含义

* Update src/app/service/service_worker/runtime.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/app/service/service_worker/runtime.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* 增加注释

* oriMetadata  -> originalMetadata

* n和s修改为 key、valueSet 之类的名字是不是更直观一点

* a=>value & e=>item & 空值

* 类型定义的 UserConfig

* bExclude -> isExclude

* 可以修改为 const arr = Object.entries(data).sort(([, a], [, b]) => a.sort! - b.sort!); 这种链式

* SCMetadata是确定了类型的，只会为 string[]|undefined，可以不用做这么多判断selfMetadataUpdate

* 用不到第一个成员

* 用不到第一个成员(2)

* 添加单元测试

* selfMetadata! -> selfMetadata

* 增加单元测试

* 补充单元测试

* 添加单元测试

* metaCustom? -> metaCustom?

* 一般情况下请不要直接访问 loadingScript 此变数 （私有变数）

---------

Co-authored-by: 王一之 <yz@ggnb.top>
Co-authored-by: wangyizhi <i@xloli.top>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

src/app/repo/scripts.ts

@@ -81,6 +81,8 @@ export interface ScriptRunResource extends Script {
   value: { [key: string]: any };
   flag: string;
   resource: { [key: string]: { base64?: string } & Omit<Resource, "base64"> }; // 资源列表,包含脚本需要的资源
+  metadata: SCMetadata; // 经自定义覆盖的 Metadata
+  originalMetadata: SCMetadata; // 原本的 Metadata （目前只需要 match, include, exclude）
 }
 
 export class ScriptDAO extends Repo<Script> {

src/app/service/content/exec_script.ts

@@ -34,10 +34,10 @@ export default class ExecScript {
     this.scriptRes = scriptRes;
     this.logger = LoggerCore.getInstance().logger({
       component: "exec",
-      uuid: this.scriptRes.uuid,
-      name: this.scriptRes.name,
+      uuid: scriptRes.uuid,
+      name: scriptRes.name,
     });
-    const GM_info = evaluateGMInfo(envInfo, this.scriptRes);
+    const GM_info = evaluateGMInfo(envInfo, scriptRes);
     // 构建脚本资源
     if (typeof code === "string") {
       this.scriptFunc = compileScript(code);

src/app/service/content/gm_info.ts

@@ -1,5 +1,4 @@
 import { ExtVersion } from "@App/app/const";
-import { parseUserConfig } from "@App/pkg/utils/yaml";
 import type { GMInfoEnv } from "./types";
 import type { ScriptLoadInfo } from "../service_worker/types";
 
@@ -28,7 +27,7 @@ export function evaluateGMInfo(envInfo: GMInfoEnv, script: ScriptLoadInfo) {
     // "" => null
     scriptUpdateURL: script.downloadUrl || null,
     scriptMetaStr: script.metadataStr,
-    userConfig: parseUserConfig(script.userConfigStr),
+    userConfig: script.userConfig,
     userConfigStr: script.userConfigStr,
     // scriptSource: script.sourceCode,
     version: ExtVersion,

src/app/service/sandbox/runtime.ts

@@ -14,10 +14,10 @@ import { proxyUpdateRunStatus } from "../offscreen/client";
 import { BgExecScriptWarp } from "../content/exec_warp";
 import type ExecScript from "../content/exec_script";
 import type { ValueUpdateData } from "../content/types";
-import { getStorageName } from "@App/pkg/utils/utils";
+import { getStorageName, getMetadataStr, getUserConfigStr } from "@App/pkg/utils/utils";
 import type { EmitEventRequest, ScriptLoadInfo } from "../service_worker/types";
 import { CATRetryError } from "../content/exec_warp";
-import { getMetadataStr, getUserConfigStr } from "@App/pkg/utils/utils";
+import { parseUserConfig } from "@App/pkg/utils/yaml";
 
 export class Runtime {
   cronJob: Map<string, Array<CronJob>> = new Map();
@@ -83,15 +83,21 @@ export class Runtime {
     if (this.execScripts.has(script.uuid)) {
       await this.disableScript(script.uuid);
     }
-    const loadScript = script as ScriptLoadInfo;
-    loadScript.metadataStr = getMetadataStr(script.code) || "";
-    loadScript.userConfigStr = getUserConfigStr(script.code) || "";
+    const metadataStr = getMetadataStr(script.code) || "";
+    const userConfigStr = getUserConfigStr(script.code) || "";
+    const userConfig = parseUserConfig(userConfigStr);
+    const loadScript = {
+      ...script,
+      metadataStr,
+      userConfigStr,
+      userConfig,
+    } as ScriptLoadInfo;
     if (script.type === SCRIPT_TYPE_BACKGROUND) {
       // 后台脚本直接运行起来
       return this.execScript(loadScript);
     } else {
       // 定时脚本加入定时任务
-      await this.stopCronJob(script.uuid);
+      this.stopCronJob(script.uuid);
       return this.crontabScript(loadScript);
     }
   }
@@ -164,7 +170,7 @@ export class Runtime {
     return ret;
   }
 
-  private crontabSripts: ScriptLoadInfo[] = [];
+  private crontabSripts: ScriptRunResource[] = [];
 
   crontabScript(script: ScriptLoadInfo) {
     // 执行定时脚本 运行表达式
@@ -299,9 +305,15 @@ export class Runtime {
     if (exec) {
       await this.stopScript(script.uuid);
     }
-    const loadScript = script as ScriptLoadInfo;
-    loadScript.metadataStr = getMetadataStr(script.code) || "";
-    loadScript.userConfigStr = getUserConfigStr(script.code) || "";
+    const metadataStr = getMetadataStr(script.code) || "";
+    const userConfigStr = getUserConfigStr(script.code) || "";
+    const userConfig = parseUserConfig(userConfigStr);
+    const loadScript = {
+      ...script,
+      metadataStr,
+      userConfigStr,
+      userConfig,
+    } as ScriptLoadInfo;
     return this.execScript(loadScript, true);
   }
 

src/app/service/service_worker/client.ts

@@ -66,8 +66,8 @@ export class ScriptClient extends Client {
     return this.doThrow("getScriptRunResource", script);
   }
 
-  excludeUrl(uuid: string, url: string, remove: boolean) {
-    return this.do("excludeUrl", { uuid, url, remove });
+  excludeUrl(uuid: string, excludePattern: string, remove: boolean) {
+    return this.do("excludeUrl", { uuid, excludePattern, remove });
   }
 
   // 重置匹配项

src/app/service/service_worker/popup.ts

@@ -2,7 +2,7 @@ import { type MessageQueue } from "@Packages/message/message_queue";
 import { type Group } from "@Packages/message/server";
 import type { ExtMessageSender } from "@Packages/message/types";
 import { type RuntimeService } from "./runtime";
-import type { ScriptMatchInfo, ScriptMenu } from "./types";
+import type { TScriptMatchInfoEntry, ScriptMenu } from "./types";
 import type { GetPopupDataReq, GetPopupDataRes } from "./client";
 import { cacheInstance } from "@App/app/cache";
 import type { Script, ScriptDAO } from "@App/app/repo/scripts";
@@ -161,14 +161,14 @@ export class PopupService {
       runNum: script.type === SCRIPT_TYPE_NORMAL ? 0 : script.runStatus === SCRIPT_RUN_STATUS_RUNNING ? 1 : 0,
       runNumByIframe: 0,
       menus: [],
-      customUrlPatterns: (script as ScriptMatchInfo).customUrlPatterns || null,
+      isEffective: null,
     };
   }
 
   // 获取popup页面数据
   async getPopupData(req: GetPopupDataReq): Promise<GetPopupDataRes> {
-    const [scripts, runScripts, backScriptList] = await Promise.all([
-      this.runtime.getPageScriptByUrl(req.url, true),
+    const [matchingResult, runScripts, backScriptList] = await Promise.all([
+      this.runtime.getPageScriptMatchingResultByUrl(req.url, true),
       this.getScriptMenu(req.tabId),
       this.getScriptMenu(-1),
     ]);
@@ -177,15 +177,17 @@ export class PopupService {
     // 合并后结果
     const scriptMenuMap = new Map<string, ScriptMenu>();
     // 合并数据
-    for (const script of scripts) {
-      let run = runMap.get(script.uuid);
+    for (const [uuid, o] of matchingResult) {
+      const script = o.matchInfo || ({} as TScriptMatchInfoEntry);
+      let run = runMap.get(uuid);
       if (run) {
         // 如果脚本已经存在，则不添加，更新信息
         run.enable = script.status === SCRIPT_STATUS_ENABLE;
-        run.customUrlPatterns = script.customUrlPatterns || run.customUrlPatterns;
+        run.isEffective = o.effective!;
         run.hasUserConfig = !!script.config;
       } else {
         run = this.scriptToMenu(script);
+        run.isEffective = o.effective!;
       }
       scriptMenuMap.set(script.uuid, run);
     }
@@ -214,15 +216,7 @@ export class PopupService {
     return cacheInstance.tx<ScriptMenu[]>(cacheKey, (menu) => callback(menu || []));
   }
 
-  async addScriptRunNumber({
-    tabId,
-    frameId,
-    scripts,
-  }: {
-    tabId: number;
-    frameId: number;
-    scripts: ScriptMatchInfo[];
-  }) {
+  async addScriptRunNumber({ tabId, frameId, scripts }: { tabId: number; frameId: number; scripts: Script[] }) {
     // 设置数据
     return await this.txUpdateScriptMenu(tabId, async (data) => {
       if (!frameId) {
@@ -238,6 +232,7 @@ export class PopupService {
           }
         } else {
           const item = this.scriptToMenu(script);
+          item.isEffective = true;
           item.runNum = 1;
           if (frameId) {
             item.runNumByIframe = 1;
@@ -501,16 +496,7 @@ export class PopupService {
     // 监听运行次数
     this.mq.subscribe(
       "pageLoad",
-      async ({
-        tabId,
-        frameId,
-        scripts,
-      }: {
-        tabId: number;
-        frameId: number;
-        document: string;
-        scripts: ScriptMatchInfo[];
-      }) => {
+      async ({ tabId, frameId, scripts }: { tabId: number; frameId: number; document: string; scripts: Script[] }) => {
         await this.addScriptRunNumber({ tabId, frameId, scripts });
         // 设置角标
         await this.updateBadgeIcon(tabId);