feat: add GM.runExclusive API for cross-context exclusive execution

Author: cyfung1031

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

@@ -1383,6 +1383,68 @@ export default class GMApi extends GM_Base {
   CAT_scriptLoaded() {
     return this.loadScriptPromise;
   }
+
+  @GMContext.API({ alias: "GM_runExclusive" })
+  ["GM.runExclusive"](lockKey: string, cb: (...args: any) => any, timeout: number = -1) {
+    lockKey = `${lockKey}`; // 转化为字串
+    if (!lockKey || !this.scriptRes) {
+      throw new Error("Invalid Calling");
+    }
+    const key = `${getStorageName(this.scriptRes).replace(/:/g, ":_")}::${lockKey.replace(/:/g, ":_")}`;
+    return new Promise((resolve) => {
+      let killConn: (() => any) | null | undefined = undefined;
+      let error: any;
+      let result: any;
+      let done = false;
+      const onDisconnected = () => {
+        killConn = null; // before resolve, set disconnectFn to null
+        resolve({
+          result,
+          error,
+          done,
+        });
+      };
+      const onStart = async (con: MessageConnect) => {
+        try {
+          result = await cb();
+        } catch (e) {
+          error = e;
+        }
+        done = true;
+        con.sendMessage({
+          action: "done",
+          data: error ? false : typeof result,
+        });
+        con.disconnect();
+        onDisconnected(); // in case .disconnect() not working
+      };
+      this.connect("runExclusive", [key]).then((con) => {
+        if (killConn === null) {
+          // already resolved
+          con.disconnect();
+          return;
+        }
+        killConn = () => {
+          con.disconnect();
+        };
+        con.onDisconnect(onDisconnected);
+        con.onMessage((data) => {
+          switch (data.action) {
+            case "start":
+              onStart(con);
+              break;
+          }
+        });
+      });
+      if (timeout > 0) {
+        setTimeout(() => {
+          error = new Error("timeout");
+          killConn?.();
+          onDisconnected(); // in case .disconnect() not working
+        }, timeout);
+      }
+    });
+  }
 }
 
 // 从 GM_Base 对象中解构出 createGMBase 函数并导出（可供其他模块使用）

src/app/service/service_worker/gm_api/gm_api.ts

@@ -11,6 +11,7 @@ import PermissionVerify, { PermissionVerifyApiGet } from "../permission_verify";
 import { cacheInstance } from "@App/app/cache";
 import { type RuntimeService } from "../runtime";
 import { getIcon, isFirefox, getCurrentTab, openInCurrentTab, cleanFileName, makeBlobURL } from "@App/pkg/utils/utils";
+import { deferred, type Deferred } from "@App/pkg/utils/utils";
 import { type SystemConfig } from "@App/pkg/config/config";
 import i18next, { i18nName } from "@App/locales/locales";
 import FileSystemFactory from "@Packages/filesystem/factory";
@@ -44,6 +45,7 @@ import { headerModifierMap, headersReceivedMap } from "./gm_xhr";
 import { BgGMXhr } from "@App/pkg/utils/xhr/bg_gm_xhr";
 import { mightPrepareSetClipboard, setClipboard } from "../clipboard";
 import { nativePageWindowOpen } from "../../offscreen/gm_api";
+import { stackAsyncTask } from "@App/pkg/utils/async_queue";
 
 let generatedUniqueMarkerIDs = "";
 let generatedUniqueMarkerIDWhen = "";
@@ -1305,6 +1307,43 @@ export default class GMApi {
     }
   }
 
+  @PermissionVerify.API({ link: ["GM.runExclusive", "GM_runExclusive"] })
+  runExclusive(request: GMApiRequest<[string, string, any?]>, sender: IGetSender) {
+    if (!request.params || request.params.length < 1) {
+      throw new Error("param is failed");
+    }
+    const [lockKey] = request.params as [string, string, any];
+    if (!sender.isType(GetSenderType.CONNECT)) {
+      throw new Error("GM_download ERROR: sender is not MessageConnect");
+    }
+    const msgConn = sender.getConnect();
+    if (!msgConn) {
+      throw new Error("GM_download ERROR: msgConn is undefined");
+    }
+    let isConnDisconnected = false;
+    const d = deferred<boolean>();
+    let done: boolean = false;
+    const onDisconnected = () => {
+      if (isConnDisconnected) return;
+      isConnDisconnected = true;
+      d.resolve(done);
+    };
+    msgConn.onDisconnect(onDisconnected);
+    msgConn.onMessage((data) => {
+      if (data.action === "done") {
+        done = true;
+        msgConn.disconnect();
+        onDisconnected(); // in case .disconnect() not working
+      }
+    });
+    stackAsyncTask(`${lockKey}`, async () => {
+      msgConn.sendMessage({
+        action: "start",
+      });
+      return d.promise;
+    });
+  }
+
   handlerNotification() {
     const send = async (
       event: NotificationMessageOption["event"],