fix: a popup save no longer undoes a network switch the background saved during it (closes #641)
The popup's saveState() and the background's updateState() each read the stored record, change it and write it back, each ordered only within its own context, so a write by one could land between the other's read and write and be lost. Both now hold the browser's lock (navigator.locks) from the read to the write, through withLock() in src/shared/browserApi.js, and the recovery screen's reset takes it too. A page in a Firefox private window gets locks of its own and is not covered. The lock also orders a page's own saves, so both per-context queues are gone. The unit tests get a small lock from a Jest setup file. Model: opus-5-5
This commit was merged in pull request #644.
This commit is contained in:
@@ -31,6 +31,11 @@
|
||||
// Everything is resolved on use rather than captured at module load. The MV3
|
||||
// service worker is torn down and re-evaluated repeatedly, and the unit
|
||||
// suite installs its stubs on `global.chrome` around a require().
|
||||
//
|
||||
// The module also holds withLock(), a wrapper around the browser's
|
||||
// `navigator.locks`, which is in neither namespace. It sits beside
|
||||
// storageGet() and storageSet() because every write of the stored record
|
||||
// takes it.
|
||||
|
||||
// The extension API namespace, preferring `browser.*` where it exists.
|
||||
//
|
||||
@@ -219,6 +224,33 @@ function storageRemove(keys) {
|
||||
return Promise.resolve(storage.remove(keys));
|
||||
}
|
||||
|
||||
/**
|
||||
* Run `fn` while holding the browser's lock called `name`
|
||||
* (`navigator.locks`), and settle as `fn` settles. Every page of the extension
|
||||
* and its background share these locks, except a page in a Firefox private
|
||||
* window (README, "Stored state and its version"), so while one of them holds
|
||||
* `name` another asking for it waits, in the order they asked. The lock is let
|
||||
* go when `fn` settles, whether it resolved or rejected.
|
||||
*
|
||||
* Every write of the stored record holds the lock named after its key,
|
||||
* "autistmask", from its read to its write: saveState() in
|
||||
* src/shared/state.js, updateState() in src/background/state.js, and the
|
||||
* reset in src/popup/views/stateRecovery.js.
|
||||
*
|
||||
* @param {string} name
|
||||
* @param {function(): Promise<*>} fn
|
||||
* @returns {Promise<*>} what `fn` resolved with.
|
||||
* @throws rejects, without running `fn`, where `navigator.locks` is absent.
|
||||
*/
|
||||
function withLock(name, fn) {
|
||||
if (typeof navigator === "undefined" || !navigator.locks) {
|
||||
return Promise.reject(
|
||||
new Error("navigator.locks is not available in this context"),
|
||||
);
|
||||
}
|
||||
return navigator.locks.request(name, () => fn());
|
||||
}
|
||||
|
||||
// `storage.session`, the browser's session storage: what is kept there lasts
|
||||
// until the browser closes. It survives the background worker being stopped
|
||||
// and started again, which module-level variables do not (README, Background
|
||||
@@ -373,4 +405,5 @@ module.exports = {
|
||||
windowsGetLastFocused,
|
||||
windowsRemove,
|
||||
windowsUpdate,
|
||||
withLock,
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user