- auto-release.yml: the by-hand test run passes github.sha (what it got anyway) instead of an output that also reads workflow_run.head_sha, so CI never checks out a ref a workflow_run handed over in a job that uses caches (cache poisoning, 7 alerts in ci.yml). - tests/harness.js: the script splitter also matches end tags like </SCRIPT > (bad HTML filtering regexp). - Tests paste the fixture saves into the page with lit(), which escapes what could end a script or a string, instead of plain JSON.stringify (improper code sanitization).
145 lines
9.6 KiB
JavaScript
145 lines
9.6 KiB
JavaScript
// Loads the game page in jsdom with the animation loop disabled, so tests can drive the simulation
|
|
// directly through the game's globals (ACT, S, R, dayTick…). The page is assembled from src/ once per
|
|
// test process (scripts/lib/page.js), so tests always run what is in src/, never a stale build.
|
|
// It is the page players get; {agent: true} loads the development page instead, with the agent facade
|
|
// (src/agent/) the MCP server drives. Only the tests of that facade ask for it, so core code that leans on
|
|
// it fails here rather than in production.
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
const vm = require('node:vm');
|
|
const { JSDOM, VirtualConsole } = require('jsdom');
|
|
const { assemble } = require('../scripts/lib/page');
|
|
|
|
const PAGE = {};
|
|
const page = (dev) => PAGE[dev] || (PAGE[dev] = assemble({ dev }).html);
|
|
|
|
// The page's inline scripts, taken out of the HTML once per process and compiled once. jsdom's HTML parser is slow
|
|
// on 2 MB of script text (it was more than half of every load()), so the DOM is built from the rest of the page and
|
|
// the scripts then run in its window, in order, the same way jsdom runs them (vm.Script.runInContext). Only plain
|
|
// <script> tags run, as in the browser here; data blocks (ld+json) stay in the page untouched.
|
|
const SPLIT = new Map();
|
|
function split(html) {
|
|
let s = SPLIT.get(html);
|
|
if (s) return s;
|
|
const code = [];
|
|
const shell = html.replace(/<script>([\s\S]*?)<\/script\b[^>]*>/gi, (m, src) => {
|
|
code.push(new vm.Script(src, { filename: `page-script-${code.length}.js` }));
|
|
return '<script></script>';
|
|
});
|
|
// With scripting on, the parser keeps a <noscript>'s content as text; with scripts run from outside it builds those
|
|
// elements (an extra <h1>, <p>, <div>). Escaped, the content stays one text node, as players' browsers have it.
|
|
const page = shell.replace(/(<noscript>)([\s\S]*?)(<\/noscript>)/g, (m, a, body, b) => a + body.replace(/&/g, '&').replace(/</g, '<') + b);
|
|
SPLIT.set(html, s = { shell: page, code });
|
|
return s;
|
|
}
|
|
|
|
// opts.file: a built or older page to load instead (the perf bench, the release build test).
|
|
// opts.agent: the development page, with src/agent/.
|
|
function load(opts = {}) {
|
|
const html = opts.file ? fs.readFileSync(opts.file, 'utf8') : page(!!opts.agent);
|
|
const errors = [];
|
|
const vc = new VirtualConsole();
|
|
vc.on('jsdomError', (e) => {
|
|
// jsdom has no canvas; drawing calls are expected to be unimplemented.
|
|
if (!/getContext|Not implemented/.test(e.message)) errors.push(e.message);
|
|
});
|
|
const { shell, code } = split(html);
|
|
const dom = new JSDOM(shell, {
|
|
// opts.url: the origin the page is "served" from. Tests that dial the agent relay pass the relay's own host, so
|
|
// the page's WebSocket Origin matches (the relay refuses a cross-site one); everything else stays on a made-up
|
|
// https origin nothing can reach.
|
|
url: opts.url || 'https://tests.invalid/',
|
|
runScripts: 'outside-only',
|
|
pretendToBeVisual: true,
|
|
virtualConsole: vc,
|
|
beforeParse(window) {
|
|
window.__TUBES_TEST__ = true;
|
|
// Seed before the game script runs, so nothing random happens at load time either.
|
|
if (opts.seed !== false) { let r = opts.seed || 12345; window.Math.random = () => { r = (r * 16807) % 2147483647; return r / 2147483647; }; window.__reseed = (n) => { r = n; }; }
|
|
// opts.browser (from browser()): windows of one browser share localStorage, its storage events, a broadcast
|
|
// channel and Web Locks, like real tabs; opts.tab is one tab's sessionStorage, which survives a reload.
|
|
if (opts.browser) opts.browser.attach(window, opts.tab || new Map(), opts);
|
|
for (const [k, v] of Object.entries(opts.storage || {})) window.localStorage.setItem(k, v);
|
|
if (opts.navigatorLanguage) Object.defineProperty(window.navigator, 'language', { value: opts.navigatorLanguage });
|
|
// A non-English game: jsdom does not fetch the dictionary script, so register it up front.
|
|
// (opts.dir: the folder the dictionary comes from, e.g. a build's _site/i18n.)
|
|
if (opts.lang) { window.localStorage.setItem('sot-lang', opts.lang); window.eval(fs.readFileSync(path.join(opts.dir || path.join(__dirname, '..', 'site', 'i18n'), opts.lang + '.js'), 'utf8')); }
|
|
// jsdom has no CompressionStream; {gzip:true} lends the page Node's, the same API browsers have (#176).
|
|
if (opts.gzip) for (const k of ['CompressionStream', 'DecompressionStream', 'TextEncoder', 'TextDecoder']) window[k] = globalThis[k];
|
|
window.Path2D = class { moveTo() {} lineTo() {} quadraticCurveTo() {} bezierCurveTo() {} arc() {} rect() {} closePath() {} };
|
|
// A recording 2D context, so draw code really runs under test (jsdom has no canvas).
|
|
const fake = () => { const calls = { n: 0 };
|
|
const grad = { addColorStop() {} };
|
|
return new Proxy({ calls }, { get(t, k) {
|
|
if (k in t) return t[k];
|
|
if (k === 'measureText') return (s) => ({ width: String(s).length * 7 });
|
|
if (k === 'createLinearGradient' || k === 'createRadialGradient' || k === 'createPattern') return () => grad;
|
|
if (k === 'getImageData') return () => ({ data: new Uint8ClampedArray(4) });
|
|
if (k === 'canvas') return null;
|
|
return (...a) => { calls.n++; };
|
|
}, set(t, k, v) { t[k] = v; return true; } }); };
|
|
window.HTMLCanvasElement.prototype.getContext = function () { return this.__ctx || (this.__ctx = fake()); };
|
|
window.HTMLCanvasElement.prototype.toDataURL = () => 'data:image/png;base64,';
|
|
window.HTMLCanvasElement.prototype.toBlob = (cb) => cb(null);
|
|
},
|
|
});
|
|
// The language picker document.write()s a dictionary <script src> for a non-English player. jsdom fetched nothing
|
|
// for it anyway (opts.lang registers the dictionary), and after parsing a real write would wipe the page.
|
|
const doc = dom.window.document, ctx = dom.getInternalVMContext();
|
|
doc.write = () => {};
|
|
for (const sc of code) {
|
|
try { sc.runInContext(ctx); } catch (e) { vc.emit('jsdomError', Object.assign(new Error(`Uncaught [${e}]`), { detail: e })); }
|
|
}
|
|
delete doc.write;
|
|
const ev = (src) => dom.window.eval(src);
|
|
// Deterministic by default so a test never passes or fails by luck; pass {seed:false} to opt out.
|
|
// (Seeded in beforeParse, so the game's own seeded-games wrapper around Math.random stays in place.)
|
|
return { dom, ev, errors };
|
|
}
|
|
|
|
// Deterministic Math.random so failures are reproducible.
|
|
function seed(ev, n) {
|
|
ev(`if(window.__reseed)__reseed(${n});else Math.random=(()=>{let s=${n};return()=>{s=(s*16807)%2147483647;return s/2147483647;};})();`);
|
|
}
|
|
|
|
// A fake browser for several windows at once (see opts.browser). Storage events, broadcast messages and lock
|
|
// hand-overs arrive asynchronously, as in browsers: await settle() or flush() before checking them.
|
|
function browser({ locks = true, channel = true } = {}) {
|
|
const ls = new Map(), wins = new Set(), held = new Map(), log = [];
|
|
const later = (f) => setTimeout(f, 0);
|
|
const store = (map, win, shared) => {
|
|
const fire = (key, oldValue, newValue) => { if (shared) for (const w of wins) if (w !== win && !w.closed) later(() => { try { w.dispatchEvent(new w.StorageEvent('storage', { key, oldValue, newValue })); } catch (e) {} }); };
|
|
return {
|
|
getItem: (k) => { if (shared) log.push(['get', String(k)]); return map.has(String(k)) ? map.get(String(k)) : null; },
|
|
setItem: (k, v) => { if (win.closed) return; k = String(k); v = String(v); if (shared && b.quota && k.startsWith('sot-save-v1:') && v.length > b.quota) { const e = new win.Error('full'); e.name = 'QuotaExceededError'; throw e; } const o = map.has(k) ? map.get(k) : null; map.set(k, v); if (shared) { log.push(['set', k]); fire(k, o, v); } },
|
|
removeItem: (k) => { k = String(k); if (!map.has(k)) return; const o = map.get(k); map.delete(k); if (shared) fire(k, o, null); },
|
|
key: (i) => [...map.keys()][i] ?? null,
|
|
get length() { return map.size; },
|
|
clear: () => map.clear(),
|
|
};
|
|
};
|
|
const b = { ls, wins, log, quota: 0,
|
|
attach(win, tab, opts) {
|
|
wins.add(win);
|
|
Object.defineProperty(win, 'localStorage', { configurable: true, get: () => store(ls, win, true) });
|
|
Object.defineProperty(win, 'sessionStorage', { configurable: true, get: () => store(tab, win, false) });
|
|
if (channel) win.BroadcastChannel = class { constructor(name) { this.name = name; (b.chans = b.chans || []).push({ c: this, win }); }
|
|
postMessage(data) { const msg = JSON.parse(JSON.stringify(data)); for (const o of b.chans) if (o.c !== this && o.c.name === this.name && !o.win.closed && o.c.onmessage) later(() => o.c.onmessage({ data: msg })); }
|
|
close() {} };
|
|
if (locks) Object.defineProperty(win.navigator, 'locks', { configurable: true, value: {
|
|
request(name, o, cb) {
|
|
const cur = held.get(name);
|
|
if (cur && !cur.win.closed && !o.steal) { if (o.ifAvailable) return win.Promise.resolve().then(() => cb(null)); return win.Promise.reject(new win.Error('busy')); }
|
|
if (cur) { held.delete(name); cur.reject(new win.DOMException('stolen', 'AbortError')); }
|
|
return new win.Promise((res, rej) => { const me = { win, reject: rej }; held.set(name, me);
|
|
win.Promise.resolve().then(() => cb({ name })).then((v) => { if (held.get(name) === me) held.delete(name); res(v); }, rej); });
|
|
} } });
|
|
},
|
|
// A tab closing: its locks go with it.
|
|
close(win) { win.closed = true; for (const [k, v] of held) if (v.win === win) held.delete(k); wins.delete(win); },
|
|
};
|
|
return b;
|
|
}
|
|
const flush = (n = 3) => new Promise((r) => { const go = (i) => (i ? setTimeout(() => go(i - 1), 2) : r()); go(n); });
|
|
|
|
module.exports = { load, seed, browser, flush };
|