Files
ARTEX/web/scripts/polling.test.mjs
T
BaaRai 73aa56c16f perf(web): pause snapshot polling in hidden tabs
Adds setVisibleInterval (web/src/lib/polling.ts): no ticks while the tab is hidden, an immediate refresh on return, no overlapping polls, errors swallowed, cleanup removes the listener. API pollers use it; local clock ticks keep setInterval. CI runs the helper tests. Backported from #209 (contributed by @renaesop).
2026-11-15 23:08:24 +01:00

121 lines
3.3 KiB
JavaScript
Executable File

import { test } from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import vm from "node:vm";
import path from "node:path";
import { fileURLToPath } from "node:url";
import ts from "typescript";
const web = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
function moduleFor(name, globals = {}) {
const output = ts.transpileModule(fs.readFileSync(path.join(web, "src/lib", name + ".ts"), "utf8"), {
compilerOptions: { module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2022 },
}).outputText;
const exports = {};
vm.runInNewContext(output, { exports, ...globals });
return exports;
}
function setup(hidden = false) {
let sequence = 0;
const timers = new Map();
const listeners = new Set();
const document = {
visibilityState: hidden ? "hidden" : "visible",
addEventListener: (_, callback) => listeners.add(callback),
removeEventListener: (_, callback) => listeners.delete(callback),
};
const { setVisibleInterval } = moduleFor("polling", {
document,
setTimeout: (callback) => {
const id = ++sequence;
timers.set(id, callback);
return id;
},
clearTimeout: (id) => timers.delete(id),
});
return {
setVisibleInterval,
timers,
listeners,
visibility(hidden) {
document.visibilityState = hidden ? "hidden" : "visible";
for (const callback of listeners) callback();
},
tick() {
const entries = [...timers];
timers.clear();
for (const [, callback] of entries) callback();
},
};
}
async function settle() {
for (let i = 0; i < 8; i++) await Promise.resolve();
}
test("hidden tabs make no scheduled requests; returning refreshes immediately and cleanup stops work", async () => {
const s = setup(true);
let calls = 0;
const stop = s.setVisibleInterval(() => {
calls++;
}, 5000);
s.tick();
await settle();
assert.equal(calls, 0);
assert.equal(s.timers.size, 0);
s.visibility(false);
await settle();
assert.equal(calls, 1);
assert.equal(s.timers.size, 1);
s.visibility(true);
assert.equal(s.timers.size, 0);
s.visibility(false);
await settle();
assert.equal(calls, 2);
stop();
s.tick();
s.visibility(false);
await settle();
assert.equal(calls, 2);
assert.equal(s.listeners.size, 0);
assert.equal(s.timers.size, 0);
});
test("a slow poll cannot overlap on timer or visibility changes; dispose while running cannot revive it", async () => {
const s = setup();
let calls = 0;
let release;
const stop = s.setVisibleInterval(() => {
calls++;
return new Promise((resolve) => {
release = resolve;
});
}, 2000);
s.tick();
assert.equal(calls, 1);
s.visibility(true);
s.visibility(false);
s.tick();
assert.equal(calls, 1);
release();
await settle();
assert.equal(s.timers.size, 1);
s.tick();
assert.equal(calls, 2);
stop();
release();
await settle();
assert.equal(s.timers.size, 0);
});
test("a failed background refresh retries on the next interval", async () => {
const s = setup();
let calls = 0;
const stop = s.setVisibleInterval(async () => {
if (++calls === 1) throw Error("temporary");
}, 1000);
s.tick();
await settle();
assert.equal(s.timers.size, 1);
s.tick();
await settle();
assert.equal(calls, 2);
stop();
});