diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e094dd..d7b9a32 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ All notable changes to this project are documented here. The project follows ## [Unreleased] +- Added routing regression checks and a benchmark for exported saves to help catch future performance changes that alter how traffic is carried. + - Series of Tubes now speaks Portuguese (Brazil). The game follows your browser's language the first time, and you can switch to Português under Settings or on the title screen. - Fiber between nearby cities bends gently again instead of looping wide around the neighbourhood, so dense regions like Toronto, Ottawa and Montreal stay readable. - Swapping router models now sells the old ones on eBuy for 30% of their price, and removing a router does too (#82). A POP takes one swap a day, so a double click no longer buys two upgrades, and optics and waves now say which port speed they need instead of naming one model. diff --git a/README.md b/README.md index 3f627bc..016bf5a 100644 --- a/README.md +++ b/README.md @@ -154,3 +154,19 @@ Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md). ## License [MIT](LICENSE) © 2026 Frederic Jung + +## Benchmark an exported save + +To measure simulation updates, actions, the closed mobile Networks sheet and +opening Connections with your own save: + +```bash +node scripts/benchmark-performance.js /path/to/save.json +git show origin/main:site/index.html > /tmp/tubes-baseline.html +node scripts/benchmark-performance.js /path/to/save.json /tmp/tubes-baseline.html +``` + +The optional baseline compares timings and asserts that the complete serialized +simulation output matches. Saves may be plain state or exports wrapped in `S`. +These are headless JavaScript/DOM timings, not phone interaction or browser +painting measurements. For the seeded network benchmark used by CI, use `npm run perf`. diff --git a/package.json b/package.json index 82c2ca6..72c00fd 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "homepage": "https://seriesoftub.es/", "repository": { "type": "git", "url": "git+https://github.com/fjaeckel/seriesoftubes.git" }, "scripts": { - "test": "node --test --test-concurrency=1 tests/game.test.js tests/build.test.js tests/persist.test.js tests/services.test.js tests/peering.test.js tests/issues.test.js tests/regions.test.js tests/modes.test.js tests/levels.test.js tests/speed.test.js tests/i18n.test.js", + "test": "node --test --test-concurrency=1 tests/game.test.js tests/build.test.js tests/persist.test.js tests/services.test.js tests/peering.test.js tests/issues.test.js tests/regions.test.js tests/modes.test.js tests/levels.test.js tests/speed.test.js tests/i18n.test.js tests/routing-reference.test.js", "build": "bash scripts/build.sh", "i18n:check": "node scripts/i18n-check.js", "serve": "npm run build && npx --yes serve@14.2.4 _site", diff --git a/scripts/benchmark-performance.js b/scripts/benchmark-performance.js new file mode 100644 index 0000000..5b0f805 --- /dev/null +++ b/scripts/benchmark-performance.js @@ -0,0 +1,43 @@ +#!/usr/bin/env node +// Headless CPU/DOM benchmark, not a browser frame-rate measurement. +// node scripts/benchmark-performance.js SAVE.json [BASELINE.html] +// git show main:site/index.html > /tmp/tubes-baseline.html +const fs = require('node:fs'); +const path = require('node:path'); +const assert = require('node:assert/strict'); +const { load } = require('../tests/harness'); + +const [saveFile, baseline] = process.argv.slice(2); +if (!saveFile) { + console.error('Usage: node scripts/benchmark-performance.js SAVE.json [BASELINE.html]'); + process.exit(1); +} +const input = JSON.parse(fs.readFileSync(saveFile, 'utf8')); +const save = input.S || input; +function benchmark(file) { + const { ev, dom, errors } = load({ file }); + try { + ev('ACT.start({})'); + dom.window.benchmarkSave = JSON.parse(JSON.stringify(save)); + ev('S=migrate(window.benchmarkSave);UI.speed=0;innerWidth=390;innerHeight=844;compute()'); + const result = JSON.parse(ev('JSON.stringify(R)')); + const measure = (setup, run, repeats) => { + ev(setup); + const samples = JSON.parse(ev(`(()=>{const out=[];for(let i=0;i<${repeats};i++){const start=performance.now();${run};out.push(performance.now()-start);}return JSON.stringify(out);})()`)); + const sorted = [...samples].sort((a, b) => a - b); + return { medianMs: +sorted[Math.floor(sorted.length / 2)].toFixed(1), samplesMs: samples.map(v => +v.toFixed(1)) }; + }; + const timings = { + compute: measure('', 'compute()', 5), + closedNetworks: measure("UI.left='nets';UI.leftOpen=false;UI.sel=null", 'renderLeft()', 3), + openConnections: measure("UI._dh=null;UI.dtab='conn'", 'ACT.connOpen()', 1), + action: measure("$('dash').hidden=true;UI.leftOpen=false;UI.left='nets'", 'after()', 3), + }; + assert.deepEqual(errors, []); + return { result, timings }; + } finally { dom.window.close(); } +} +const original = baseline ? benchmark(path.resolve(baseline)) : null; +const current = benchmark(path.join(__dirname, '..', 'site', 'index.html')); +if (original) assert.deepEqual(current.result, original.result, 'Simulation output must match the baseline'); +console.log(JSON.stringify({ baseline: original?.timings, current: current.timings, ...(original && { identicalSimulation: true }) }, null, 2)); diff --git a/tests/helpers/reference-allocation.js b/tests/helpers/reference-allocation.js new file mode 100644 index 0000000..db0508a --- /dev/null +++ b/tests/helpers/reference-allocation.js @@ -0,0 +1,18 @@ +// Deliberately scan all exits for every flow, without byRank, local-city +// shortcuts or first-group selection. Stable sorting preserves E order on ties. +module.exports = ` + for(const rank of RANKS){ + for(f of flows){ + if(f.rem<=1e-6||(rank===0&&!f.cache))continue; + Dv=SDi[f.ci];Pv=SPi[f.ci];PP=walked[f.ci]||(walked[f.ci]=[]);vis++; + const candidates=E.filter(e=>e.used(a.pref==='high'?0:1)-(b.pref==='high'?0:1)||Dv[CIDX[a.city]]-Dv[CIDX[b.city]]); + for(let i=0;i1e-6;){ + let j=i+1;while(j!n.tail).slice(0,35))S.pni.push({id:n.id+'@'+c,city:c,net:n.id,tier:0}); + for(const n of NETS.filter(n=>n.cache).slice(0,3))S.caches.push({id:'cache-'+n.id+'@'+c,net:n.id,city:c}); + } + for(let i=0;i= 0 && end > start, 'allocation loop boundaries must exist'); + ev(`window.referenceCompute=eval('('+${JSON.stringify(source.slice(0,start)+referenceAllocation+source.slice(end))}+')')`); +} + +test('indexed routing matches the simple allocation loop across network changes', () => { + const { ev, dom, errors } = load(); + try { + network(ev); + const changes = [ + '', + "S.pni.forEach((p,i)=>p.pref=i%3===0?'high':i%3===1?'low':'normal')", + "S.te={on:true,script:''}", + "S.te.script='prefer pni for goggle\\nspill at 80%\\navoid transit for netchill'", + "S.ev.rpki={nets:['ggl','nfx'],until:S.day+3};S.ev.depeer=S.day+3", + "S.ev.ddos={city:'fra',until:S.day+3,gbps:300,vec:'syn',entry:{k:'edge'}}", + "S.links[0].eqDown=S.day+2;S.links[1].cut=S.day+2;S.links[2].loss={until:S.day+2,f:0.5}", + "S.links[4].chFail={until:S.day+2,o:'tp16'};S.links[6].ch.push('zr4');S.links[8].regen=2", + "S.day+=4;S.pni.splice(0,20);S.caches.splice(0,10);S.transit[0].pref='high'", + ]; + for (const change of changes) { + ev(change); + if (change.startsWith("S.te.script=")) assert.ok(ev("teRules()"), "RouteScript scenario must be active"); + // Both implementations receive exactly the same prior load (scenic routing). + ev('window.priorR=JSON.stringify(R);referenceCompute();window.expectedR=JSON.stringify(R);R=JSON.parse(priorR);compute()'); + assert.deepEqual(JSON.parse(ev('JSON.stringify(R)')), JSON.parse(ev('expectedR')), change || 'baseline'); + } + assert.deepEqual(errors, []); + } finally { dom.window.close(); } +}); +