GM.runExclusive -> GM.takeTurn

Author: cyfung1031

example/gm_run_exclusive.js example/gm_take_turn.jsexample/gm_run_exclusive.js renamed to example/gm_take_turn.js

@@ -1,9 +1,9 @@
 // ==UserScript==
-// @name         GM.runExclusive Demo
+// @name         GM.takeTurn Demo
 // @namespace    https://docs.scriptcat.org/
 // @version      0.1.2
-// @match        https://example.com/*?runExclusive*
-// @grant        GM.runExclusive
+// @match        https://example.com/*?takeTurn*
+// @grant        GM.takeTurn
 // @grant        GM.setValue
 // @grant        GM.getValue
 // @run-at       document-start
@@ -13,7 +13,7 @@
 (async function () {
     'use strict';
 
-    const delayMatch = location.href.match(/runExclusive(\d+)_(\d*)/);
+    const delayMatch = location.href.match(/takeTurn(\d+)_(\d*)/);
     const timeDelay = delayMatch ? +delayMatch[1] : 0;
     const timeoutValue = (delayMatch ? +delayMatch[2] : 0) || -1;
     const isWorker = !!timeDelay;
@@ -68,7 +68,7 @@
     if (!isWorker) {
         panel.style.width = "480px";
         panel.innerHTML = `
-            <h3 style="margin-top:0">GM.runExclusive Demo</h3>
+            <h3 style="margin-top:0">GM.takeTurn Demo</h3>
             <p>Pick worker durations (ms):</p>
             <div style="display:flex; flex-direction:row; gap: 4px;">
                 <input id="durations" value="1200,2400,3800,400"
@@ -107,7 +107,7 @@
 
             delays.forEach(delay => {
                 const iframe = document.createElement('iframe');
-                iframe.src = `${location.pathname}?runExclusive${delay}_${timeoutQ}`;
+                iframe.src = `${location.pathname}?takeTurn${delay}_${timeoutQ}`;
                 iframe.style.width = '100%';
                 iframe.style.height = '160px';
                 iframe.style.border = '1px solid #444';
@@ -120,7 +120,7 @@
             if (e.data?.type !== 'close-worker') return;
             const iframes = iframeContainer.querySelectorAll('iframe');
             for (const iframe of iframes) {
-                if (iframe.src.includes(`runExclusive${e.data.delay}_`)) {
+                if (iframe.src.includes(`takeTurn${e.data.delay}_`)) {
                     iframe.remove();
                     log(`Closed worker ${e.data.delay}ms`, '#ff9800');
                     return;
@@ -157,7 +157,7 @@
     const startWait = performance.now();
 
     try {
-        const result = await GM.runExclusive('demo-lock-key', async () => {
+        const result = await GM.takeTurn('demo-lock-key', async () => {
             const waited = Math.round(performance.now() - startWait);
 
             const order = (await GM.getValue('order')) + 1;

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

@@ -1544,11 +1544,11 @@ export default class GMApi extends GM_Base {
     return this.loadScriptPromise;
   }
 
-  @GMContext.API({ alias: "GM_runExclusive" })
-  ["GM.runExclusive"]<T>(lockKey: string, cb: () => T | PromiseLike<T>, timeout: number = -1): Promise<T> {
+  @GMContext.API({ alias: "GM_takeTurn" })
+  ["GM.takeTurn"]<T>(lockKey: string, cb: () => T | PromiseLike<T>, timeout: number = -1): Promise<T> {
     lockKey = `${lockKey}`; // 转化为字串
     if (!lockKey || !this.scriptRes) {
-      throw new Error("GM.runExclusive: Invalid Calling");
+      throw new Error("GM.takeTurn: Invalid Calling");
     }
     const key = `${getStorageName(this.scriptRes).replace(/:/g, ":_")}::${lockKey.replace(/:/g, ":_")}`;
 
@@ -1563,7 +1563,7 @@ export default class GMApi extends GM_Base {
           if (error) {
             reject(error);
           } else if (state !== 2) {
-            reject(new Error("GM.runExclusive: Incomplete Action"));
+            reject(new Error("GM.takeTurn: Incomplete Action"));
           } else {
             resolve(result);
           }
@@ -1590,7 +1590,7 @@ export default class GMApi extends GM_Base {
           con.disconnect();
           onDisconnected(); // in case .disconnect() not working
         };
-        this.connect("runExclusive", [key]).then((con) => {
+        this.connect("takeTurn", [key]).then((con) => {
           if (killConn === null || state > 0) {
             // already resolved (unexpected or by timeout)
             con.disconnect();
@@ -1611,15 +1611,15 @@ export default class GMApi extends GM_Base {
         if (timeout > 0) {
           setTimeout(() => {
             if (killConn === null || state > 0) return; // 执行开始了就不进行 timeout 操作
-            error = new Error("GM.runExclusive: Timeout Error");
+            error = new Error("GM.takeTurn: Timeout Error");
             killConn?.();
             onDisconnected(); // in case .disconnect() not working
           }, timeout);
         }
       });
 
     return new Promise((resolve, reject) => {
-      stackAsyncTask(`runExclusive::${key}`, async () => {
+      stackAsyncTask(`takeTurn::${key}`, async () => {
         try {
           resolve(await taskAsync());
         } catch (e) {

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

@@ -1388,8 +1388,8 @@ export default class GMApi {
     }
   }
 
-  @PermissionVerify.API({ link: ["GM.runExclusive", "GM_runExclusive"] })
-  runExclusive(request: GMApiRequest<[string]>, sender: IGetSender) {
+  @PermissionVerify.API({ link: ["GM.takeTurn", "GM_takeTurn"] })
+  takeTurn(request: GMApiRequest<[string]>, sender: IGetSender) {
     if (!request.params || request.params.length < 1) {
       throw new Error("param is failed");
     }

src/template/scriptcat.d.tpl

@@ -306,7 +306,7 @@ declare const GM: {
   cookie(action: GMTypes.CookieAction, details: GMTypes.CookieDetails): Promise<GMTypes.Cookie[]>;
 
   /** cross-context exclusive execution */
-  runExclusive<T>(key: string, callback: () => T | PromiseLike<T>, timeout?: number): Promise<T>;
+  takeTurn<T>(key: string, callback: () => T | PromiseLike<T>, timeout?: number): Promise<T>;
 };
 
 /**

src/types/scriptcat.d.ts

@@ -306,7 +306,7 @@ declare const GM: {
   cookie(action: GMTypes.CookieAction, details: GMTypes.CookieDetails): Promise<GMTypes.Cookie[]>;
 
   /** cross-context exclusive execution */
-  runExclusive<T>(key: string, callback: () => T | PromiseLike<T>, timeout?: number): Promise<T>;
+  takeTurn<T>(key: string, callback: () => T | PromiseLike<T>, timeout?: number): Promise<T>;
 };
 
 /**