紧急修正: GM.delete/setValue Promise不fulfill

src/app/repo/scripts.ts

@@ -43,10 +43,11 @@ export interface ConfigGroup {
   [key: string]: Config;
 }
 
-export type UserConfig = {
-  [key: string]: ConfigGroup | { sort: string[] } | undefined;
-  "#options"?: { sort: string[] };
-};
+export type UserConfig = Partial<
+  Record<string, ConfigGroup> & {
+    "#options": { sort: string[] };
+  }
+>;
 
 // 排除掉 #options
 export type UserConfigWithoutOptions = Omit<{ [key: string]: ConfigGroup }, "#options">;

src/app/service/content/gm_api.test.ts

@@ -686,16 +686,16 @@ describe("GM_value", () => {
     expect(ret).toEqual({ ret1: { a: 123, b: 456, c: "789" }, ret2: { b: 456 } });
   });
 
-  it("GM_addValueChangeListener", async () => {
+  it("GM_addValueChangeListener - remote: false", async () => {
     const script = Object.assign({ uuid: uuidv4() }, scriptRes) as ScriptLoadInfo;
     script.metadata.grant = ["GM_getValue", "GM_setValue", "GM_addValueChangeListener"];
     script.metadata.storageName = ["testStorage"];
     script.code = `
     return new Promise(resolve=>{
-      GM_addValueChangeListener("a", (name, oldValue, newValue, remote)=>{
+      GM_addValueChangeListener("param1", (name, oldValue, newValue, remote)=>{
         resolve({name, oldValue, newValue, remote});
       });
-      GM_setValue("a", 123);
+      GM_setValue("param1", 123);
     });
    `;
     const mockSendMessage = vi.fn().mockResolvedValue({ code: 0 });
@@ -705,31 +705,54 @@ describe("GM_value", () => {
     // @ts-ignore
     const exec = new ExecScript(script, "content", mockMessage, nilFn, envInfo);
     exec.scriptFunc = compileScript(compileScriptCode(script));
-    let retPromise = exec.exec();
+    const retPromise = exec.exec();
     expect(mockSendMessage).toHaveBeenCalledTimes(1);
     // 模拟值变化
     exec.valueUpdate({
-      id: "123",
-      entries: encodeMessage([["a", 123, undefined]]),
+      id: "id-1",
+      entries: encodeMessage([["param1", 123, undefined]]),
       uuid: script.uuid,
       storageName: script.uuid,
       sender: { runFlag: exec.sandboxContext!.runFlag, tabId: -2 },
+      valueUpdated: true,
     });
     const ret = await retPromise;
-    expect(ret).toEqual({ name: "a", oldValue: undefined, newValue: 123, remote: false });
+    expect(ret).toEqual({ name: "param1", oldValue: undefined, newValue: 123, remote: false });
+  });
+
+  it("GM_addValueChangeListener - remote: true", async () => {
+    const script = Object.assign({ uuid: uuidv4() }, scriptRes) as ScriptLoadInfo;
+    script.metadata.grant = ["GM_getValue", "GM_setValue", "GM_addValueChangeListener"];
+    script.metadata.storageName = ["testStorage"];
+    script.code = `
+    return new Promise(resolve=>{
+      GM_addValueChangeListener("param2", (name, oldValue, newValue, remote)=>{
+        resolve({name, oldValue, newValue, remote});
+      });
+      GM_setValue("param2", 456);
+    });
+   `;
+    const mockSendMessage = vi.fn().mockResolvedValue({ code: 0 });
+    const mockMessage = {
+      sendMessage: mockSendMessage,
+    } as unknown as Message;
+    // @ts-ignore
+    const exec = new ExecScript(script, "content", mockMessage, nilFn, envInfo);
+    exec.scriptFunc = compileScript(compileScriptCode(script));
     // remote = true
-    retPromise = exec.exec();
-    expect(mockSendMessage).toHaveBeenCalledTimes(2);
+    const retPromise = exec.exec();
+    expect(mockSendMessage).toHaveBeenCalledTimes(1);
     // 模拟值变化
     exec.valueUpdate({
-      id: "123",
-      entries: encodeMessage([["a", 123, undefined]]),
+      id: "id-2",
+      entries: encodeMessage([["param2", 456, undefined]]),
       uuid: script.uuid,
       storageName: "testStorage",
       sender: { runFlag: "user", tabId: -2 },
+      valueUpdated: true,
     });
     const ret2 = await retPromise;
-    expect(ret2).toEqual({ name: "a", oldValue: undefined, newValue: 123, remote: true });
+    expect(ret2).toEqual({ name: "param2", oldValue: undefined, newValue: 456, remote: true });
   });
   it("异步GM.setValue，等待回调", async () => {
     const script = Object.assign({}, scriptRes) as ScriptLoadInfo;
@@ -750,14 +773,18 @@ describe("GM_value", () => {
     expect(mockSendMessage).toHaveBeenCalledTimes(1);
     // 获取调用参数
     const actualCall = mockSendMessage.mock.calls[0][0];
-    console.log("actualCall", actualCall.data.params[0]);
+    const id = actualCall.data.params[0];
+
+    expect(id).toBeTypeOf("string");
+    expect(id.length).greaterThan(0);
     // 触发valueUpdate
     exec.valueUpdate({
-      id: actualCall.data.params[0],
+      id: id,
       entries: encodeMessage([["a", 123, undefined]]),
       uuid: script.uuid,
       storageName: script.uuid,
       sender: { runFlag: exec.sandboxContext!.runFlag, tabId: -2 },
+      valueUpdated: true,
     });
 
     const ret = await retPromise;

src/app/service/content/gm_api.ts

@@ -145,7 +145,7 @@ class GM_Base implements IGM_Base {
   public valueUpdate(data: ValueUpdateDataEncoded) {
     if (!this.scriptRes || !this.valueChangeListener) return;
     const scriptRes = this.scriptRes;
-    const { id, uuid, entries, storageName, sender } = data;
+    const { id, uuid, entries, storageName, sender, valueUpdated } = data;
     if (uuid === scriptRes.uuid || storageName === getStorageName(scriptRes)) {
       const valueStore = scriptRes.value;
       const remote = sender.runFlag !== this.runFlag;
@@ -156,17 +156,19 @@ class GM_Base implements IGM_Base {
           fn();
         }
       }
-      const entries_ = decodeMessage(entries);
-      for (const [key, value, oldValue] of entries_) {
-        // 触发,并更新值
-        if (value === undefined) {
-          if (valueStore[key] !== undefined) {
-            delete valueStore[key];
+      if (valueUpdated) {
+        const valueChanges = decodeMessage(entries);
+        for (const [key, value, oldValue] of valueChanges) {
+          // 触发,并更新值
+          if (value === undefined) {
+            if (valueStore[key] !== undefined) {
+              delete valueStore[key];
+            }
+          } else {
+            valueStore[key] = value;
           }
-        } else {
-          valueStore[key] = value;
+          this.valueChangeListener.execute(key, oldValue, value, remote, sender.tabId);
         }
-        this.valueChangeListener.execute(key, oldValue, value, remote, sender.tabId);
       }
     }
   }

src/app/service/content/types.ts

@@ -31,6 +31,7 @@ export type ValueUpdateDataEncoded = {
   uuid: string;
   storageName: string; // 储存name
   sender: ValueUpdateSender;
+  valueUpdated: boolean;
 };
 
 // gm_api.ts

src/app/service/queue.ts

@@ -30,7 +30,7 @@ export type TEnableScript = { uuid: string; enable: boolean };
 
 export type TScriptRunStatus = { uuid: string; runStatus: SCRIPT_RUN_STATUS };
 
-export type TScriptValueUpdate = { script: Script };
+export type TScriptValueUpdate = { script: Script; valueUpdated: boolean };
 
 export type TScriptMenuRegister = {
   uuid: string;

src/app/service/service_worker/runtime.ts

@@ -454,11 +454,13 @@ export class RuntimeService {
     });
 
     // 监听脚本值变更
-    this.mq.subscribe<TScriptValueUpdate>("valueUpdate", async ({ script }: TScriptValueUpdate) => {
-      if (script.status === SCRIPT_STATUS_ENABLE && isEarlyStartScript(script.metadata)) {
-        // 如果是预加载脚本，需要更新脚本代码重新注册
-        // scriptMatchInfo 里的 value 改变 => compileInjectionCode -> injectionCode 改变
-        await this.updateResourceOnScriptChange(script);
+    this.mq.subscribe<TScriptValueUpdate>("valueUpdate", async ({ script, valueUpdated }: TScriptValueUpdate) => {
+      if (valueUpdated) {
+        if (script.status === SCRIPT_STATUS_ENABLE && isEarlyStartScript(script.metadata)) {
+          // 如果是预加载脚本，需要更新脚本代码重新注册
+          // scriptMatchInfo 里的 value 改变 => compileInjectionCode -> injectionCode 改变
+          await this.updateResourceOnScriptChange(script);
+        }
       }
     });