@bongos/core 1.24.50 → 1.24.52

package/tests/status_page_wording.mjs

@@ -0,0 +1,129 @@
+// tests/status_page_wording.mjs — the status page speaks the project's current
+// voice, not the old Greek-city ledger (task 1005090, goal 1000138; docs/voice.md).
+//
+// The page moved onto the chrome world in task 1005089 with its words untouched;
+// this task rewrote them. What this pins: no word of the city vocabulary
+// ("citizens who shape her stones", "tablet last consulted", "works wrought",
+// "architects", drachmas…) is left anywhere a visitor can read it — the page's
+// text, its title and meta, its accessible names, and every string status.js
+// writes into the page. Class names, ids and code comments are not read, so a
+// selector like `.foundry__chart` is not a finding; a sentence is.
+//
+// Run:  node --test tests/status_page_wording.mjs
+
+import { test } from 'node:test';
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import http from 'node:http';
+import path from 'node:path';
+import vm from 'node:vm';
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'node:url';
+
+const require = createRequire(import.meta.url);
+
+const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const DIR = path.join(ROOT, 'modules', 'status-ui', 'public');
+const read = (f) => fs.readFileSync(path.join(DIR, f), 'utf8');
+
+// The retired vocabulary, as whole words.
+const CITY = /\b(citizens?|stones?|tablets?|wrought|architects?|inscri(be|bed|ption|ptions)|lately|masons?|cartographers?|purse|treasury|foundry|forge|senate|lawmen|inspector|athens|civili[sz]ation|endeavou?rs?|portraits?|consult(ed|ing)?|archive|her stones|city|city's|ledger|hand at|hands)\b|\bdr\./i;
+
+// What a visitor reads in the markup: text between tags, and the attributes that
+// are read aloud or shown (title, alt, aria-label, placeholder, meta content).
+function visibleHtml(html) {
+  const noComments = html.replace(/<!--[\s\S]*?-->/g, ' ').replace(/<(script|style)\b[\s\S]*?<\/\1>/gi, ' ');
+  const out = [];
+  for (const m of noComments.matchAll(/\b(?:aria-label|title|alt|placeholder|content)="([^"]*)"/g)) out.push(m[1]);
+  for (const m of noComments.replace(/<[^>]*>/g, '\n').split('\n')) if (m.trim()) out.push(m.trim());
+  return out;
+}
+
+// What status.js writes: its string literals, minus comments, minus any markup
+// inside a template, minus the literals that are a selector, id or key.
+function visibleJs(js) {
+  // line comments first: a `/*` inside one (a path like /public/*) would otherwise
+  // open a block comment that swallows the code after it
+  const code = js.replace(/(^|[^:\\'"`])\/\/.*$/gm, '$1').replace(/\/\*[\s\S]*?\*\//g, '');
+  const out = [];
+  for (const m of code.matchAll(/'((?:[^'\\\n]|\\.)*)'|"((?:[^"\\\n]|\\.)*)"|`((?:[^`\\]|\\.)*)`/g)) {
+    const lit = (m[1] ?? m[2] ?? m[3] ?? '').replace(/<[^>]*>/g, ' ').replace(/\$\{[^}]*\}/g, ' ').trim();
+    if (!lit) continue;
+    if (/^[a-z0-9_\-.#:[\]=" ]*$/.test(lit) && !/\s\S+\s/.test(lit)) continue; // a selector, id, class list or key
+    out.push(lit);
+  }
+  return out;
+}
+
+// The pages as the server serves them on the status host (stamped + branded), so
+// the check reads what a visitor's browser receives, not the template.
+function get(port, p) {
+  return new Promise((resolve, reject) => {
+    const req = http.request({ host: '127.0.0.1', port, path: p, headers: { Host: 'status.example.com' } }, (res) => {
+      let body = '';
+      res.setEncoding('utf8');
+      res.on('data', (c) => { body += c; });
+      res.on('end', () => resolve({ status: res.statusCode, body }));
+    });
+    req.on('error', reject);
+    req.end();
+  });
+}
+async function servedPages() {
+  const express = require('express');
+  const { mountInternalSurfaces } = require('../src/bongos/serve-internal.js');
+  const app = express();
+  mountInternalSurfaces(app);
+  const server = await new Promise((resolve) => { const s = app.listen(0, () => resolve(s)); });
+  try {
+    const port = server.address().port;
+    const out = {};
+    for (const f of fs.readdirSync(DIR).filter((n) => n.endsWith('.html'))) {
+      const r = await get(port, f === 'index.html' ? '/' : `/${f}`);
+      assert.equal(r.status, 200, f);
+      out[f] = r.body;
+    }
+    return out;
+  } finally {
+    await new Promise((r) => server.close(r));
+  }
+}
+
+test('no Greek-city word is left in what the status page shows', async () => {
+  const hits = [];
+  const pages = await servedPages();
+  assert.ok(Object.keys(pages).length >= 2);
+  for (const [f, html] of Object.entries(pages)) {
+    for (const line of visibleHtml(html)) if (CITY.test(line)) hits.push(`${f}: ${line.slice(0, 120)}`);
+  }
+  for (const f of ['status.js', 'explore.js']) {
+    for (const line of visibleJs(read(f))) if (CITY.test(line)) hits.push(`${f}: ${line.slice(0, 120)}`);
+  }
+  assert.deepEqual(hits, []);
+});
+
+test('the reader really reads the page (a guard that sees nothing passes everything)', async () => {
+  const html = visibleHtml((await servedPages())['index.html']);
+  assert.ok(html.includes('Recently shipped'), 'a heading is read');
+  assert.ok(html.some((l) => /^How .+ is being built, in the open/.test(l)), 'the meta description is read');
+  assert.ok(html.includes('Filter shipped tasks by date range'), 'an accessible name is read');
+  const js = visibleJs(read('status.js'));
+  assert.ok(js.includes('Nothing shipped in this window.'), 'a string status.js writes is read');
+  assert.ok(!js.includes('foundry__chart'), 'a class name is not');
+  // and the old lines would have been caught
+  for (const old of ['Architects of {{worldName}}', 'tablet last consulted at', 'works wrought, last 7 days', 'Citizens who have set the most stone.', '12 dr.']) {
+    assert.ok(CITY.test(old), `the guard catches "${old}"`);
+  }
+});
+
+test('money reads as dollars, not drachmas', () => {
+  // run the page's own two formatters
+  const js = read('status.js');
+  const fn = (name) => js.match(new RegExp(`function ${name}\\(n\\) \\{[\\s\\S]*?\\n\\}`))[0];
+  const ctx = vm.createContext({});
+  vm.runInContext(`${fn('fmtUsd')}\n${fn('fmtMoney')}\nthis.fmtMoney = fmtMoney;`, ctx);
+  assert.equal(ctx.fmtMoney(12.5), '$12.50');
+  assert.equal(ctx.fmtMoney(48297.4), `$${(48297).toLocaleString()}`);
+  assert.equal(ctx.fmtMoney(null), '—');
+  assert.doesNotMatch(js, /fmtDr|dr\.`/);
+});