[Feature] 希望能加个阻塞或者锁的函数或者写法

[KingsKim]

功能描述

请清晰描述你想要的功能：
希望能加个阻塞或者锁的函数或者写法，这样在短时间内打开多个网站的话，使用缓存的时候可以避免读写到脏数据

使用场景

在什么情况下需要这个功能？（例如：处理特定网站时，提升操作效率等）
最近在做一个打开页面就记录访问痕迹的功能，如果我快速同时打开2个网站，可能只会记录到只访问过一个网站

附加说明

（可选）补充截图、示例代码或其他参考信息

[CodFrm]

不太清楚你的需求，不过我觉得 同时打开2个网站，可能只会记录到只访问过一个网站 ，这更像是脚本的bug，或者逻辑上的问题

不知道你是如何记录的

[KingsKim]

不太清楚你的需求，不过我觉得 同时打开2个网站，可能只会记录到只访问过一个网站，这更像是脚本的bug，或者逻辑上的问题

不知道你是如何记录的

例如：
let lock = GM_getValue('lock');//获取锁
if(lock==1){//锁值=1的时候等待，最多等10秒
for(let i=0;i<10;i++){
await delay(1000);
}
}
GM_setValue('lock', 1);//执行前开启锁

//添加记录
let list = GM_getValue('list');
list.push(location.href);
GM_setValue('list', list);

GM_setValue('lock', 0);//执行后关闭锁

/*
以上功能正常情况下，等一个新网页加载完再打开另一个新网页的话，是没问题的，但是如果我短时间内连续快速打开2个以上新网页的话，可能就会漏掉记录了。
例如list原来的值是['url_1']
我快速打开网址url_2和url_3后再查看值，可能会是['url_1','url_2']或者['url_1','url_3']，这和打开先后顺序无关，就看哪个页面先加载完成
*/

[CodFrm]

GM value 不适合实现锁，现有GM api 也确实没有能够实现 锁 的

[cyfung1031]

@KingsKim @CodFrm 不是锁问题，你用错API了

你使用最新的Beta版试试看

// ==UserScript==
// @name         Save Page URL to List
// @namespace    yourname.scripts
// @version      1.0
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValue
// @grant        GM.setValue
// ==/UserScript==

(async function() {
    'use strict';

    // 从存储中读取已有的列表
    let list = await GM.getValue('list', []);  // 设置默认值为空数组

    // 如果当前URL不在列表中，就添加进去
    if (!list.includes(location.href)) {
        list.push(location.href);
        await GM.setValue('list', list);
        console.log('✅ 已保存此页面到列表:', location.href);
    } else {
        console.log('ℹ️ 当前页面已在列表中');
    }

    // 可选：在控制台查看当前列表
    console.log('当前列表:', list);
})();

---

当然因为 getValue 和 setValue 是两个独立的处理
还是有机会出问题

可改成

// ==UserScript==
// @name         Save Page URL to List
// @namespace    yourname.scripts
// @version      2.0
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValues
// @grant        GM.setValue
// @grant        GM.listValues
// ==/UserScript==

(async function() {
    'use strict';
    
    await GM.setValue(`locationHref_${Date.now()}`, location.href);
    console.log('✅ 已保存此页面到列表:', location.href);

    // 从存储中读取已有的列表
    let keys = await GM.listValues();
    keys = keys.filter((key) => key.startsWith("locationHref_"));
    keys.sort();
    const list = Object.values(await GM.getValues(keys));

    // 可选：在控制台查看当前列表
    console.log('当前列表:', list);
})();

[cyfung1031]

还是需要 GM_lock 的话可以复制以下的代码或引用 GM_lock.js

不建议加 GM_lock 到ScriptCat. 否则你的脚本只能在ScriptCat跑。

---

GM_lock

// ==UserScript==
// @name         Save Page URL to List
// @namespace    yourname.scripts
// @version      3.0
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValue
// @grant        GM.setValue
// @grant        GM.deleteValue
// @grant        GM.listValues
// @grant        GM_addValueChangeListener
// @grant        GM_removeValueChangeListener
// ==/UserScript==

const GM_lock = async (tag, func) => {
    GM_lock.i = (GM_lock.i & 1073741823) + 1;
    const lockId = `${Date.now() + 1000000000000000}_${GM_lock.i}_${Math.floor(Math.random() * 9000 + 1000)}`; // TS_i_R
    let resolveFn, rejectFn, cid;
    const promiseRet = new Promise((resolve, reject) => {
        resolveFn = resolve;
        rejectFn = reject;
    });
    let valids = new Set();
    let listenerId = GM_addValueChangeListener(`GM_lock_changed::${tag}`, async (_key, _oldValue, newValue, _remote) => {
        valids.add(`GM_lock::${tag}::${newValue.substring(0, 17)}`); // GM_lock::TAG::TS_
        const keys = (await GM.listValues()).filter((key) => key.startsWith(`GM_lock::${tag}::`)).sort();
        if (keys[0] === `GM_lock::${tag}::${lockId}`) {
            GM_removeValueChangeListener(listenerId);
            clearTimeout(cid);
            await GM.setValue(`GM_lock_changed::${tag}`, `${lockId}_run_${Date.now()}`); // TS_i_R_run_ts
            let res;
            let err;
            try {
                res = await func();
            } catch (e) {
                err = e;
            }
            await GM.deleteValue(`GM_lock::${tag}::${lockId}`);
            await GM.setValue(`GM_lock_changed::${tag}`, `${lockId}_del_${Date.now()}`); // TS_i_R_del_ts
            err ? rejectFn(err) : resolveFn(res);
        }
    });
    await GM.setValue(`GM_lock::${tag}::${lockId}`, "1");
    await new Promise(resolve => setTimeout(resolve, 50)); // 可选：设置 delay 确保锁不会冲突.
    // 0.3秒通知記錄有效，重设锁.
    cid = setTimeout(async () => {
        await GM.setValue(`GM_lock::${tag}::${lockId}`, "1");
        await new Promise(resolve => setTimeout(resolve, 50)); // 可选：设置 delay 确保锁不会冲突.
        await GM.setValue(`GM_lock_changed::${tag}`, `${lockId}_set_${Date.now()}`); // TS_i_R_set_ts
        // 0.6秒刪除無效記錄，重设锁.
        cid = setTimeout(async () => {
            const keys = (await GM.listValues()).filter((key) => key.startsWith(`GM_lock::${tag}::`)).sort();
            for (const key of keys) {
                const startPart = key.substring(0, `GM_lock::${tag}::`.length + 17); // GM_lock::TAG::TS_
                if (valids.has(startPart)) break;
                await GM.deleteValue(key);
            }
            valids.clear();
            await GM.setValue(`GM_lock::${tag}::${lockId}`, "1");
            await new Promise(resolve => setTimeout(resolve, 50)); // 可选：设置 delay 确保锁不会冲突.
            await GM.setValue(`GM_lock_changed::${tag}`, `${lockId}_set_${Date.now()}`); // TS_i_R_set_ts
        }, 300);
    }, 300);
    await GM.setValue(`GM_lock_changed::${tag}`, `${lockId}_set_${Date.now()}`); // TS_i_R_set_ts
    return promiseRet;
};

(function () {
    'use strict';
    GM_lock("lock_urls", async () => {
        // 从存储中读取已有的列表
        let list = await GM.getValue('list', []); // 设置默认值为空数组
        // 如果当前URL不在列表中，就添加进去
        if (!list.includes(location.href)) {
            list.push(location.href);
            await GM.setValue('list', list);
            console.log('✅ 已保存此页面到列表:', location.href);
        } else {
            console.log('ℹ️ 当前页面已在列表中');
        }
        // 可选：在控制台查看当前列表
        console.log('当前列表:', list);
    });
})();

GM_lock (@require)

// ==UserScript==
// @name         Save Page URL to List
// @namespace    yourname.scripts
// @version      3.0
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValue
// @grant        GM.setValue
// @grant        GM.deleteValue
// @grant        GM.listValues
// @grant        GM_addValueChangeListener
// @grant        GM_removeValueChangeListener
// @require      https://update.greasyfork.org/scripts/554436/1687655/GM_lock.js
// ==/UserScript==

/* global GM_lock */
(function () {
    'use strict';
    GM_lock("lock_urls", async () => {
        // 从存储中读取已有的列表
        let list = await GM.getValue('list', []); // 设置默认值为空数组
        // 如果当前URL不在列表中，就添加进去
        if (!list.includes(location.href)) {
            list.push(location.href);
            await GM.setValue('list', list);
            console.log('✅ 已保存此页面到列表:', location.href);
        } else {
            console.log('ℹ️ 当前页面已在列表中');
        }
        // 可选：在控制台查看当前列表
        console.log('当前列表:', list);
    });
})();

[CodFrm]

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

Lines 227 to 235 in 0627a0f

	static _GM_getValue(a: GMApi, key: string, defaultValue?: any) {
	if (!a.scriptRes) return undefined;
	const ret = a.scriptRes.value[key];
	if (ret !== undefined) {
	return ret;
	}
	return defaultValue;
	}

GM.getValue 实际上也是同步的，最开始加载的时候还是会取初始值，而不是 set 之后的值，还是会有一致性问题（回复第一个示例）

这个 GM_lock 中，使用的 await GM.listValues() 实际上也是同步的，似乎会影响这个 lock，下面这个示例就是会有问题的。

我认为 GM value 是不适合做 lock 的（也许能通过 GM_addValueChangeListener 用通讯，类似分布式的思路去实现，但是暂时没想到），就算GM get/listValue，是从 SW 取到最新值，但是也可能会出现 线程1、2同时到达，取到同样的值，然后锁也是失效的

// ==UserScript==
// @name         Save Page URL to List
// @namespace    yourname.scripts
// @version      3.0
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValue
// @grant        GM.setValue
// @grant        GM.deleteValue
// @grant        GM.listValues
// @grant        GM_addValueChangeListener
// @grant        GM_removeValueChangeListener
// @require      https://update.greasyfork.org/scripts/554436/1687655/GM_lock.js
// ==/UserScript==

/* global GM_lock */
(function () {
    'use strict';
    GM_lock("lock_urls", async () => {
        // 从存储中读取已有的列表
        let list = await GM.getValue('list', []); // 设置默认值为空数组
        // 如果当前URL不在列表中，就添加进去
        console.log("初始列表:", list);
        if (!list.includes(location.href)) {
            list.push(location.href);
            await GM.setValue('list', list);
            console.log('✅ 已保存此页面到列表:', location.href);
        } else {
            console.log('ℹ️ 当前页面已在列表中');
        }
        // 可选：在控制台查看当前列表
        console.log('当前列表:', list);
    });
    if (window.location.href.includes("scriptcat.org/zh-CN")) {
        window.open("https://docs.scriptcat.org/docs/use");
        window.open("https://bbs.tampermonkey.net.cn/");
    }
})();

[cyfung1031]

GM.getValue 实际上也是同步的，最开始加载的时候还是会取初始值，而不是 set 之后的值，还是会有一致性问题（回复第一个示例）

使用的 await GM.listValues() 实际上也是同步的，似乎会影响这个 lock

所以应该 GM.getValue 跟 GM.listValues 都要改吧
而不是单单把 GM_getValue 和 GM_listValues 包起来

[cyfung1031]

GM_lock 没问题
可以清楚看到时间区间没重叠

问题是 GM.getValue 还是取旧值

---

由于SC的 GM.getValue 会取cache, 所以要加delay

// ==UserScript==
// @name         Save Page URL to List
// @namespace    yourname.scripts
// @version      3.0
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValue
// @grant        GM.setValue
// @grant        GM.deleteValue
// @grant        GM.listValues
// @grant        GM_addValueChangeListener
// @grant        GM_removeValueChangeListener
// @require      https://update.greasyfork.org/scripts/554436/1687655/GM_lock.js
// ==/UserScript==

/* global GM_lock */
(function () {
    'use strict';
    console.log("载入了", Date.now(), performance.now());
    GM_lock("lock_urls", async () => {
        console.log("开始", Date.now(), performance.now());
        // 等一下这个页面SC的缓存更新
        await new Promise(resolve=>setTimeout(resolve, 50));
        // 从存储中读取已有的列表
        let list = await GM.getValue('list', []); // 设置默认值为空数组
        // 如果当前URL不在列表中，就添加进去
        console.log("初始列表:", list.slice());
        if (!list.includes(location.href)) {
            list.push(location.href);
            await GM.setValue('list', list);
            console.log('✅ 已保存此页面到列表:', location.href);
        } else {
            console.log('ℹ️ 当前页面已在列表中');
        }
        // 可选：在控制台查看当前列表
        console.log('当前列表:', list.slice());
        // 等一下其他页面SC的缓存更新
        await new Promise(resolve=>setTimeout(resolve, 50));
        console.log("结束", Date.now(), performance.now());
    });
    if (window.location.href.includes("scriptcat.org/zh-CN")) {
        window.open("https://docs.scriptcat.org/docs/use");
        window.open("https://bbs.tampermonkey.net.cn/");
    }
})();

[CodFrm]

GM.getValue 实际上也是同步的，最开始加载的时候还是会取初始值，而不是 set 之后的值，还是会有一致性问题（回复第一个示例）
使用的 await GM.listValues() 实际上也是同步的，似乎会影响这个 lock

所以应该 GM.getValue 跟 GM.listValues 都要改吧 而不是单单把 GM_getValue 和 GM_listValues 包起来

也许是，但是似乎也没有核心的差别

---

唔，加上这个延迟正常了。。。但是这样我觉得不完全是这个 GM_lock 在起作用了

[cyfung1031]

GM.getValue 实际上也是同步的，最开始加载的时候还是会取初始值，而不是 set 之后的值，还是会有一致性问题（回复第一个示例）
使用的 await GM.listValues() 实际上也是同步的，似乎会影响这个 lock

所以应该 GM.getValue 跟 GM.listValues 都要改吧 而不是单单把 GM_getValue 和 GM_listValues 包起来

也许是，但是似乎也没有核心的差别

不要直接取 cache, 向 service_worker 那边问最新值
service_worker 那边有 事务锁 （ await stackAsyncTask<boolean>(cacheKey, async () => { )
所以 setValue 之类正在SW处理中的话， service_worker 会先处理完再返回 getValue / listValues 的结果到 content/page

[CodFrm]

GM.getValue 实际上也是同步的，最开始加载的时候还是会取初始值，而不是 set 之后的值，还是会有一致性问题（回复第一个示例）
使用的 await GM.listValues() 实际上也是同步的，似乎会影响这个 lock

所以应该 GM.getValue 跟 GM.listValues 都要改吧 而不是单单把 GM_getValue 和 GM_listValues 包起来

也许是，但是似乎也没有核心的差别

不要直接取 cache, 向 service_worker 那边问最新值 service_worker 那边有 事务锁 （ await stackAsyncTask<boolean>(cacheKey, async () => { ) 所以 setValue 之类正在SW处理中的话， service_worker 会先处理完再返回 getValue / listValues 的结果到 content/page

听起来可以，下个版本处理一下

[cyfung1031]

GM.getValue 实际上也是同步的，最开始加载的时候还是会取初始值，而不是 set 之后的值，还是会有一致性问题（回复第一个示例）
使用的 await GM.listValues() 实际上也是同步的，似乎会影响这个 lock

所以应该 GM.getValue 跟 GM.listValues 都要改吧 而不是单单把 GM_getValue 和 GM_listValues 包起来

也许是，但是似乎也没有核心的差别

不要直接取 cache, 向 service_worker 那边问最新值 service_worker 那边有 事务锁 （ await stackAsyncTask<boolean>(cacheKey, async () => { ) 所以 setValue 之类正在SW处理中的话， service_worker 会先处理完再返回 getValue / listValues 的结果到 content/page

听起来可以，下个版本处理一下

#898

[KingsKim]

哈哈，如果下个版本会有的话就太好了，感谢脚本猫作者和各位大佬！

[cyfung1031]

哈哈，如果下个版本会有的话就太好了，感谢脚本猫作者和各位大佬！

GM_lock 应该不会加到ScriptCat吧。不然相容不了 TM

GM.getValues/getValue/listValues 是本身SC的问题，有PR修正

要求不高的话，暂时用这个就能满足你的需要

// ==UserScript==
// @name         Example Script for GM_lock
// @namespace    yourname.scripts
// @version      0.1
// @description  把当前网页URL保存到存储列表中
// @author       You
// @match        *://*/*
// @grant        GM.getValue
// @grant        GM.setValue
// @grant        GM.deleteValue
// @grant        GM.listValues
// @grant        GM_addValueChangeListener
// @grant        GM_removeValueChangeListener
// @require      https://update.greasyfork.org/scripts/554436/1687655/GM_lock.js
// ==/UserScript==

/* global GM_lock */
(function () {
    'use strict';
    GM_lock("lock_urls", async () => {
        await new Promise(resolve=>setTimeout(resolve, 50)); // 等一下这个页面SC的缓存更新
        // ....
        // ....
        // 在这里做你的动作
        // ....
        // ....
        await new Promise(resolve=>setTimeout(resolve, 50)); // 等一下其他页面SC的缓存更新
    });
})();