Skip to content

⚡️ GM 值更新改用 Port 定向推送,修复回执丢失、空闲重连与断线漏收(基于 #1848) - #1854

Open
CodFrm wants to merge 10 commits into
mainfrom
fix/1848-port-recovery
Open

CodFrm wants to merge 10 commits into
mainfrom
fix/1848-port-recovery

Conversation

@CodFrm

@CodFrm CodFrm commented Nov 12, 2026

Copy link
Copy Markdown
Member

Checklist / 检查清单

  • Fixes mentioned issues / 修复已提及的问题
  • Code reviewed by human / 代码通过人工检查
  • Changes tested / 已完成测试

第一项未勾:#1834 的广播放大路径已修改,但整包保存 GM value 的问题还在,没有用 #1834 的真实场景(导入大量 B 站历史)验收,所以不宣称完整解决。

背景

#1834:scripting.js 在所有页面的所有 frame 里监听 chrome.storage.local.onChanged。任何一次 storage.local 写入,包括整包保存的 value:<storageName>,都会被投递并反序列化到每个 frame。存储大、标签页多时 CPU 和内存都会被放大。

#1848 改为按 storageName 订阅的 Port 定向推送,方向是对的。在 baa60b62 上实测还有几个问题:

  • 写入方回执只靠 Port 推送:50 页同时写时回执 46/48,6 次写入有页面漏收。
  • SW 空闲回收后立刻写会卡住,0/9。
  • 重载扩展后,旧页面持续报错(90s 内 29 个)。
  • Port 断开期间(SW 重启、bfcache)漏收的更新不会补齐。

#1848 后续的 dc7bcdf8 也在修这些问题,但目前 CI 的 Lint 和测试第 1 片都失败,并且引入了几处超出这个问题的行为改动(见下文「与 #1848 最新版的差异」)。所以这个 PR 从 baa60b62 出发重新修,保留 @cyfung1031 的三个提交。

本次改动

在 #1848 baa60b62 的基础上:

  1. 写入回执改由 SW 的 RPC 响应完成:GM_setValue / GM_setValues 的响应直接带回这次更新。同一 id 的 Port 推送会被忽略,不会重复触发监听。
  2. 重连策略:Port 订阅已确认、且存活超过 1s 后才断开的,立即重连;否则按退避重试,避免 SW 反复出错时陷入紧密重连循环。扩展上下文失效(重载、更新、卸载)后停止重连。
  3. 按版本补齐漏收的更新:
    • 每次保存 Value 记录时写入递增的 revision。
    • 重订阅时带上 frame 已知的版本;SW 在与写入共用的锁里先登记订阅、再读版本,版本不同就返回各脚本的值快照。
    • 脚本还没开始运行时,快照直接作为初始值;已经在运行时,按键比较,对变化的键以 remote=true 触发 GM_addValueChangeListener。
  4. 修复 getScriptValueDetails 合并用户配置默认值时改写 ValueDAO 缓存记录的问题。这是补齐快照时发现的。
  5. 测试:修复 scripting 测试在共享 window 上残留 pageshow 监听,导致的跨文件偶发失败。
  6. 文档:docs/references/architecture-gm-api.md 新增 Value updates 一节。

存储变动:Value 新增可选字段 revision,pageLoad 下发的 ScriptRunResource 新增 valueRevision。旧数据没有该字段时按 0 处理,不需要迁移。

实现考虑

  • 写锁复用 CACHE_KEY_SET_VALUE + storageName 的 stackAsyncTask,订阅和保存不会交错:一次并发保存要么包含在快照里,要么会推送给刚登记的 Port,不会两边都漏。
  • revision = max(Date.now() * 1000, prev + 1):SW 重启或记录被删后重建时,版本仍然递增。
  • 收到订阅确认之前,frame 先缓存收到的推送;确认后先应用快照,再丢弃版本不比快照新的推送。
  • 补齐只给最终值:断开期间的中间值不会重放。main 当前在 bfcache 恢复后会逐次触发(见验证)。

与 #1848 最新版(dc7bcdf8)的差异

本 PR dc7bcdf8
存储字段 revision / valueRevision revision + epoch / valueRevision + valueEpoch
补齐后的监听器 按键比较,以 remote=true 触发 快照直接替换缓存,不触发监听
通用消息层 不改 ExtensionMessage.sendMessage 在 lastError 时改为 reject
GM.setValue 行为不变 30s 超时或回执不合法时 reject
断线重连 存活超过 1s 才立即重连,否则退避 总是立即重连;SW 快照失败时会主动断开
非测试、非文档代码(相对 main) 15 个文件,+505/−84 19 个文件,+1202/−253
CI — Lint、测试第 1 片失败

已知限制

建议审查重点

  • ValueService.subscribeSnapshot 和 setValues 的加锁顺序,以及 frame 端「先缓存推送、确认后再按版本过滤」的配合(content/value_port.ts、content/scripting.ts)。
  • content/value_port.ts 的重连与停止条件。
  • GMApi.valueSync 的逐键比较和监听触发。

关联

fix #1834
related #1835 #1838 #1848

验证

单元测试、lint 和构建都在 ca4390c5 上运行:

  • pnpm lint:通过(exit 0);tsc --noEmit:通过。
  • pnpm build:通过。
  • pnpm test 全量:两次运行分别失败 22 个和 131 个用例,失败集合每次都不同,绝大部分在 agent、options UI 等与本 PR 无关的文件里,主要表现为 340ms / 850ms 超时,以及 chrome mock 被共享状态污染。这两次运行时本机负载在 100 以上;baa60b62 基线本身也有同类不稳定(曾一次失败 81 个)。为了把这些干扰和本 PR 分开,我把两次运行中失败的文件和本 PR 改动的测试文件合计 79 个,逐个单独运行,全部通过。

真实浏览器实测:远端 Linux 机器上用 headless Chrome 裸启动,只附着页面、不附着 SW,让 SW 能被正常空闲回收;有负载门控。测试用的构建来自 rebase 前的 9822faed;rebase 只带进了 #1853(popup 通知),文档提交不改代码。

场景 baa60b62 本 PR dc7bcdf8
50 页同时写:写入方回执 / 每次写入送达 / 最终收敛 46/48,6 次写入漏收 48/48,49/49,49/49 48/48,49/49,49/49
SW 空闲回收后立刻写(3 轮) 卡住,0/9 9/9,回执约 3ms 9/9,回执约 4ms
冷启动写入 — 5/5 5/5
重载扩展后旧页面报错(90s) 29 0 0
180s 内 SW 实例数 3 3 3
Firefox MV3:后台页停止后写入,另一页能否收到 1/2 2/2 1/1(只跑了 1 轮)

bfcache 期间漏收:A 页连写 gap1、gap2、gap3,B 页在 bfcache 里,恢复后看 B 的监听器。每个版本跑 2 次,结果一致。

版本 恢复后监听器调用 下一次更新拿到的 oldValue
main gap1、gap2、gap3(remote=true) gap3
本 PR gap3(remote=true) gap3
dc7bcdf8 无 gap3

性能:50 页,3 轮取中位数,单位 ms。

场景 main 本 PR dc7bcdf8
50 页运行脚本、单页写 0KB:setValue p50 4.8 2.0–2.1 4.5
单页写 100KB:setValue p50 175 11.4–11.8 12.5
只有 1 页运行脚本:setValue p50 7.3 1.3–1.5 2.1
50 页都在写 0KB:setValue p50 103 78–83 85.5

本 PR 与 dc7bcdf8 的 12 轮对比中,每轮都是全部 500/500 送达。main 与本 PR 的数据来自更早的一组矩阵,dc7bcdf8 来自本轮矩阵,跨组对比只看量级。

CodFrm and others added 10 commits November 12, 2026 15:43
scripting.js 以 <all_urls> + allFrames 注册并监听 chrome.storage.local.onChanged,
任何一次 local 写入(包括整包的 value:*)的新旧值都会被投递并反序列化到所有页面的所有 frame,
存储数据较大或标签页较多时导致 CPU 占用高(#1834)。

- SW 按弹窗的标签页脚本缓存找出运行该 storageName 的标签页,外加发起写入的标签页,逐个 tabs.sendMessage
- scripting 去掉 storage.local.onChanged 监听,runtime/valueUpdate 按本 frame 的 storageName 过滤
- 删除不再使用的 deliveryStorage 与 setSessionAccessLevel
SW 重启或 Port 重连期间推送会丢失,写入方的 GM.setValue Promise 因此一直挂起。
setValues 把推送的同一份更新数据作为响应返回;content 端让响应和推送都走 valueUpdate,
谁先到谁处理,后到的按 id 跳过,本 frame 监听器仍然先于 Promise 完成触发。
SW 空闲回收后 Port 断开,原来要等 250 ms 起的随机退避才重连,这段时间里别的页面的写入全部漏收。
已确认订阅且存活超过 1 秒的 Port 断开时立刻重连;握手未完成或很快又断开时仍按退避重试。
扩展重载、更新后旧页面的 chrome.runtime.id 为空,连接失败或断开时直接停止,不再无限重试。
ScriptingRuntime 没有销毁接口,测试里创建的实例会把 pageshow 监听一直留在 window 上。
fast 项目 isolate: false,utils.test 的 vi.resetAllMocks 清掉这些实例的 mock 后,
value_port.test 派发 pageshow 时残留监听调用 connect 得到 undefined 而抛错,
在 baa60b6 上连跑 3 次复现 1 次。测试结束时移除本测试注册的 pageshow 监听。
getScriptValueDetails 直接在记录的 data 对象上合并默认值。共用 @storageName 的脚本因此会拿到
彼此的默认值,默认值还会随下一次写入被持久化。合并前先复制一份。
SW 重启后 Port 要经过重连和订阅握手才能再收到推送,这期间其他页面的写入会漏收,
页面缓存会一直停在旧值,直到这个键再被写一次。

- Value 记录增加单调递增的 revision,每次保存时在写锁内更新,并随推送和 pageLoad 下发
- 订阅改为按 storageName 带上已知版本和运行中的脚本;SW 在该存储的写锁里先登记、再读版本,
  版本不一致时按脚本 uuid 返回当前全部值(含各自的用户配置默认值)
- scripting 在确认前缓存推送,确认后先应用快照,再丢弃版本不新的推送
- 首次订阅的快照和确认前到达的推送在脚本启动前合并进 pageLoad 数据,
  顺带补上 pageLoad 读取 value 之后、订阅确认之前的写入
- 脚本已启动时经新消息 runtime/valueSync 交给对应脚本,GMApi 逐键对比,
  对变化的键以 remote=true 触发监听;快照只有最终值,中间状态会合并
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Compatibility] 出现CPU占用多,内存一直增长的问题

2 participants