@bongos/core 1.19.1062 → 1.19.1063

package/src/bongos/serve-internal.js

@@ -1205,8 +1205,12 @@ function mountInternalSurfaces(app) {
   // GET /sky/mine, with the room inside it as the list drawer. The old ambient
   // page at `sky` (task 1004105) is gone; its URL 301s to /thinking below, so it
   // leaves this regex — one URL cannot be two tiers, and a redirect is not a page.
+  // task 1004321 (BV2.TW10): `tweak-editor`, Tweak Mode's editor, the artist's
+  // own room beside the studio, on the studio's tier. Its read (GET
+  // /copy-desk/pages/:pageId/draft) is any-builder like the .docx download, and
+  // every write is the page claim's holder only, checked server-side.
   const SIGNEDIN_BUILDERS_PAGE_RE =
-    /^\/builders\/(?:work|settings|atlas|modules|goals|goal-map|roadmap|copy-desk|studio|ideas|thinking|collab|task|idea|primer(?:\.md)?|diagrams)(?:\.html)?\/?$/;
+    /^\/builders\/(?:work|settings|atlas|modules|goals|goal-map|roadmap|copy-desk|studio|tweak-editor|ideas|thinking|collab|task|idea|primer(?:\.md)?|diagrams)(?:\.html)?\/?$/;
   // The diagram image assets under /builders/diagrams/ ride the same tier as the
   // page that embeds them.
   const SIGNEDIN_BUILDERS_PREFIX_RE = /^\/builders\/diagrams\//;

package/src/module-api.js

@@ -71,7 +71,7 @@ const { responsibilityFor, ROLE_RESPONSIBILITIES } = require('./role-responsibil
 // there. scripts/gds/bump-version.js still rewrites the literal below; it appends
 // the entry to that file. Look for a version's history there, not here.
 // ---------------------------------------------------------------------------
-const CORE_VERSION = '1.19.1062'; // CI auto-patch carrier (ADR 0161); changelog: docs/module-api-changelog.md
+const CORE_VERSION = '1.19.1063'; // CI auto-patch carrier (ADR 0161); changelog: docs/module-api-changelog.md
 
 // A namespaced logger so a module's log lines are attributable + consistent.
 // Usage: const log = api.logger('dev-box'); log.info('mounted');

package/tests/copy_desk_page_editor.mjs

@@ -0,0 +1,181 @@
+// tests/copy_desk_page_editor.mjs — the read the tweak editor opens on,
+// GET /copy-desk/pages/:pageId/draft, the WHOLE path (task 1004321 / BV2.TW10,
+// ADR 0341 D4).
+//
+// The done-when's middle: an artist rewrites a page, closes the tab, and comes
+// back to the draft. So the read must give back every line of the page in page
+// order with its margin note, say whether the caller holds the round, and hand
+// back exactly the draft the autosave stored, and never a draft saved on
+// another reading (its keys may name other lines).
+//
+// Driven through the real copy-desk routes, the real lifecycle port (the page
+// claim, updateHeldTaskDescription, submitPageTweak) and the real page reads,
+// against the shared stateful fake ledger (tests/fixtures/page-ledger.mjs).
+
+import { strict as assert } from 'node:assert';
+import { createRequire } from 'node:module';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { makeRunner } from './helpers.mjs';
+import { installPageLedger } from './fixtures/page-ledger.mjs';
+
+process.env.NODE_ENV = 'test';
+const require = createRequire(import.meta.url);
+const F = require('../modules/copy-desk/tests/fixtures/page-tweak.cjs');
+const pageStatus = require('../modules/copy-desk/page-status.js');
+const api = require('../src/module-api.js');
+
+installPageLedger(api, {
+  builders: [
+    { id: '7', github_login: 'alice', display_name: 'Alice', preferred_disciplines: ['artist'] },
+    { id: '8', github_login: 'bob', display_name: 'Bob', preferred_disciplines: ['artist'] },
+  ],
+});
+const ALICE = '7';
+const BOB = '8';
+
+api.requireBuilder = (req, res, next) => {
+  req.builder = { id: String(req.headers['x-builder'] || ALICE), rank: 'metic' };
+  next();
+};
+
+const seams = require('../src/module-seams.js');
+const lifecyclePort = require('../modules/lifecycle/lifecycle.js');
+if (!seams.hasProvider('lifecycle')) seams.registerProvider('lifecycle', lifecyclePort);
+
+const pageData = require('../modules/copy-desk/page-data.js');
+const express = require('express');
+const { attachFail } = require('../src/bongos/middleware/error-envelope.js');
+const buildRouter = require('../modules/copy-desk/routes/copy-desk.js');
+
+const app = express();
+app.use(express.json());
+app.use(attachFail);
+app.use(buildRouter());
+const server = await new Promise((resolve) => { const s = app.listen(0, '127.0.0.1', () => resolve(s)); });
+const base = `http://127.0.0.1:${server.address().port}`;
+
+async function call(method, p, builder, body = {}) {
+  const r = await fetch(base + p, { method, headers: { 'content-type': 'application/json', 'x-builder': builder }, body: method === 'GET' ? undefined : JSON.stringify(body) });
+  return { status: r.status, body: await r.json() };
+}
+const errCode = (b) => (b && b.error && b.error.code) || null;
+
+const L = (key, section, text, placement, row) => ({ key, section, text, placement, ...(row || {}) });
+const STUDIO_LINES = [
+  L('L0001', 'top bar', 'Studio', 'shared', { file: 'modules/hall-ui/public/shell.js', line: 40, string_id: 'sh0001' }),
+  L('L0002', 'top bar', 'Ctrl K', 'shared'),
+  L('L0003', 'greeting', 'Welcome back', 'placed', { file: 'modules/hall-ui/public/studio.html', line: 12, string_id: 'st0003' }),
+  L('L0004', 'greeting', 'Your desk is quiet today', 'unplaced'),
+  L('L0005', 'footer', 'Resume where you left off', 'placed', { file: 'modules/hall-ui/public/studio.html', line: 90, string_id: 'st0005' }),
+];
+const readingsWith = (studioHash, lines = STUDIO_LINES) => ({
+  schema: 1,
+  pages: [{ id: 'builders:studio', reading_hash: studioHash, lines }],
+});
+
+const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'page-editor-'));
+fs.mkdirSync(path.join(tmp, 'docs'), { recursive: true });
+fs.writeFileSync(path.join(tmp, 'docs/page-inventory.json'), JSON.stringify(F.INVENTORY));
+function writeReadings(r) {
+  fs.writeFileSync(path.join(tmp, 'docs/page-readings.json'), JSON.stringify(r));
+  pageData._setRoot(tmp); // drop the (mtime, size) cache
+}
+
+const { test, summary } = makeRunner();
+const STUDIO = '/copy-desk/pages/builders:studio';
+
+try {
+  writeReadings(readingsWith('studio-h1'));
+
+  await test('before anyone claims: every line in page order, with its margin note, and no round', async () => {
+    const r = await call('GET', `${STUDIO}/draft`, ALICE);
+    assert.equal(r.status, 200, JSON.stringify(r.body));
+    assert.equal(r.body.page.title, 'Studio');
+    assert.equal(r.body.page.surface_word, 'builders hall');
+    assert.equal(r.body.reading.reading_hash, 'studio-h1');
+    assert.deepEqual(r.body.reading.lines.map((l) => [l.key, l.section, l.text, l.note]), [
+      ['L0001', 'top bar', 'Studio', 'shared'],
+      // Shared shell text with no registry row cannot be applied mechanically,
+      // so it goes to an engineer at submit, and the note says so.
+      ['L0002', 'top bar', 'Ctrl K', 'engineer'],
+      ['L0003', 'greeting', 'Welcome back', null],
+      ['L0004', 'greeting', 'Your desk is quiet today', 'engineer'],
+      ['L0005', 'footer', 'Resume where you left off', null],
+    ]);
+    assert.deepEqual(r.body.notes, { shared: 'changes this on every page', engineer: 'goes to an engineer' });
+    assert.equal(r.body.round, null);
+    assert.equal(r.body.draft, null);
+    assert.deepEqual(r.body.counter, { changed: 0, total: 5 });
+    // The read never exposes where a line lives in the code.
+    assert.equal(r.body.reading.lines.some((l) => 'file' in l || 'string_id' in l), false);
+  });
+
+  await test('rewrite, close the tab, come back: the read hands back the saved draft, held by you', async () => {
+    assert.equal((await call('POST', `${STUDIO}/claim`, ALICE)).status, 201);
+    const saved = await call('PUT', `${STUDIO}/draft`, ALICE, {
+      reading_hash: 'studio-h1',
+      lines: [{ key: 'L0003', after: 'Welcome home' }, { key: 'L0001', after: 'The studio' }],
+    });
+    assert.equal(saved.body.outcome, 'saved');
+    const back = await call('GET', `${STUDIO}/draft`, ALICE);
+    assert.equal(back.status, 200);
+    assert.equal(back.body.round.state, 'writing');
+    assert.equal(back.body.round.held_by_you, true);
+    assert.equal(back.body.round.claim.path, '/copy-desk/pages/builders:studio/claim');
+    assert.deepEqual(back.body.draft.lines, [{ key: 'L0001', after: 'The studio' }, { key: 'L0003', after: 'Welcome home' }]);
+    assert.equal(back.body.draft.saved_at, saved.body.draft.saved_at);
+    assert.deepEqual(back.body.counter, { changed: 2, total: 5 });
+  });
+
+  await test('another artist sees the round held by its writer, not by them', async () => {
+    const r = await call('GET', `${STUDIO}/draft`, BOB);
+    assert.equal(r.body.round.held_by_you, false);
+    assert.deepEqual(r.body.round.holder, { id: ALICE, login: 'alice' });
+  });
+
+  await test('a draft saved on an older reading is reported, never laid over the new lines', async () => {
+    writeReadings(readingsWith('studio-h2'));
+    const r = await call('GET', `${STUDIO}/draft`, ALICE);
+    assert.equal(r.body.draft, null);
+    assert.equal(r.body.draft_on_older_reading, true);
+    assert.deepEqual(r.body.counter, { changed: 0, total: 5 });
+    writeReadings(readingsWith('studio-h1'));
+  });
+
+  await test('after submit the round reads submitted and nobody holds it', async () => {
+    assert.equal((await call('POST', `${STUDIO}/submit`, ALICE)).body.outcome, 'submitted');
+    const r = await call('GET', `${STUDIO}/draft`, ALICE);
+    assert.equal(r.body.round.state, 'submitted');
+    assert.equal(r.body.round.held_by_you, false);
+    assert.equal(r.body.round.holder, null);
+  });
+
+  await test('an unknown page is unknown_page, and a page with no reading is page_unread', async () => {
+    const r = await call('GET', '/copy-desk/pages/landing:nowhere/draft', ALICE);
+    assert.equal(r.status, 404);
+    assert.equal(errCode(r.body), 'unknown_page');
+    const u = await call('GET', '/copy-desk/pages/landing:index/draft', ALICE);
+    assert.equal(u.status, 503);
+    assert.equal(errCode(u.body), 'page_unread');
+  });
+
+  await test('composeEditor keeps only draft lines the reading still has', () => {
+    const out = pageStatus.composeEditor({
+      page: { id: 'builders:studio', title: 'Studio', surface: 'builders' },
+      readingPage: { reading_hash: 'h', lines: [STUDIO_LINES[2]] },
+      round: { id: 9, status: 'active', holder_id: 7, holder_login: 'alice', description: '```page-tweak-draft\n' + JSON.stringify({ schema: 1, page_id: 'builders:studio', reading_hash: 'h', saved_at: 'x', lines: [
+        { key: 'L0003', section: 'greeting', before: 'Welcome back', after: 'Hi', placement: 'placed' },
+        { key: 'L0099', section: 'gone', before: 'Old', after: 'New', placement: 'placed' },
+      ] }) + '\n```\n' },
+      builderId: 7,
+    });
+    assert.deepEqual(out.draft.lines, [{ key: 'L0003', after: 'Hi' }]);
+    assert.equal(out.round.held_by_you, true);
+  });
+} finally {
+  server.close();
+  pageData._setRoot(null);
+}
+summary();

package/tests/hall_audit.mjs

@@ -424,6 +424,11 @@ const LITERAL_EXEMPT = {
   'thinking.css': 'the sky\'s own sheet is its token tier (task 1004231, ADR 0331 — the design of record)',
   'sky-interaction.js': 'the sky\'s hover card writes the template\'s ring colour inline (task 1004231)',
   'sky-panel.js': 'the sky\'s panel writes the template\'s dead-bar colour inline (task 1004231)',
+  // The tweak editor (task 1004321 / BV2.TW10): docs/design/mocks/tweak-mode/
+  // Editor.dc.html is the owner-approved master design, built 1:1: the night
+  // studio, the glass bar, and a sheet of PAPER that stays paper in both modes,
+  // so its palette cannot be the hall's mode-flipping tier. The sky precedent.
+  'tweak-editor.css': 'the tweak editor\'s stage is the artboard\'s own palette (task 1004321, the pixel contract: paper in both modes)',
 };
 const COLOUR_PROPS = 'color|background|background-color|border|border-color|border-top-color|border-bottom-color|fill|stroke|outline|outline-color|box-shadow|text-shadow';
 const colourLiteralRe = () =>

package/tests/hall_page_gate_map.mjs

@@ -62,6 +62,9 @@ const ORACLE = {
   // whole gate, and its two reads (GET /tasks, GET /copy-desk/queue) already gate
   // themselves server-side.
   '/builders/studio': 'requireBuilderPage',
+  // task 1004321 (BV2.TW10): the tweak editor, on the studio's own tier. Its read
+  // is any-builder like the .docx download; every write is the page holder's only.
+  '/builders/tweak-editor': 'requireBuilderPage',
   '/builders/ideas': 'requireBuilderPage',
   // THE ROOM (task 1004098 / BV2.R03) — a builder's own idea trail. Sign-in and
   // no rank floor, the tier /ideas sits on: there is no permission gate on