ZDDC/tests/form-safety.spec.js
ZDDC e6d9966593 refactor(tables): in-dir convention + unified table+form HTML bundle
Two intertwined refactors that share too many files to split cleanly.
Both are described separately below.

PART 1 — in-dir convention for table+form spec files

Old layout had the spec at the parent and rows in a child:

    archive/<party>/
      mdl.table.yaml         spec
      mdl.form.yaml          row-edit form
      mdl/                   rows-dir
        row-001.yaml ...

URLs were /<dir>/mdl.table.html and /<dir>/mdl.form.html. Copying
mdl/ elsewhere lost the spec and form because they lived next door.

New layout collapses everything into the rows-dir:

    archive/<party>/mdl/      self-contained
      table.yaml              spec
      form.yaml               row-edit form
      row-001.yaml ...        rows

URLs become /<dir>/mdl/table.html and /<dir>/mdl/form.html. The
"copying-the-folder-takes-everything" property the user asked for
falls out by construction; the row-edit URL /<dir>/<id>.yaml.html
keeps the same shape (spec is now in the same dir, not the
grandparent).

Server changes:

- internal/handler/tablehandler.go RecognizeTableRequest fires on
  /<dir>/table.html when <dir>/table.yaml exists. The .zddc.tables
  alias map is gone — pure presence-based discovery now matches
  the form system's existing convention. Default-MDL fallback at
  archive/<party>/mdl/ stays for the virgin-archive case (the
  rows-dir need not exist on disk; the URL renders fully virtually).

- internal/handler/formhandler.go RecognizeFormRequest fires on
  /<dir>/form.html and /<dir>/<id>.yaml.html with spec at
  <dir>/form.yaml. specEligible accepts on-disk files OR the
  default-MDL virtual path so an empty mdl/ dir still surfaces the
  add-row form.

- internal/handler/tablehandler.go IsDefaultMdlSpec moves to
  serving archive/<party>/mdl/{table,form}.yaml (5 segments after
  ZDDC_ROOT). New isAtArchivePartyMdlLevel predicate; new
  isAtArchivePartyMdlDir for directory-based recognition. New
  IsDefaultMdlSpecAbs accessor for callers that hold an abs path
  rather than a URL (formhandler).

- internal/handler/formhandler.go loadFormSpec(fsRoot, path) falls
  back to embedded default-MDL bytes when os.ReadFile returns
  NotExist AND the path matches the archive-party-mdl shape. Three
  call sites updated to pass cfg.Root.

- internal/handler/formhandler.go serveFormCreate writes
  submissions to filepath.Dir(req.SpecPath) — the spec, the form,
  and rows all live in one directory. The submissionsDir creation
  is idempotent (MkdirAll); cascade falls back one level for ACL
  evaluation when the dir hasn't been materialized yet.

- internal/handler/tablehandler.go tableRowsRedirect now points at
  /<dir>/table.html (was /<dir>.table.html) when the directory
  request maps to a recognized table.

- cmd/zddc-server/main.go dispatch synth flips from
  urlPath + ".table.html" to urlPath + "/table.html" for the
  no-trailing-slash → tables-app routing.

- internal/apps/availability.go DefaultAppAt comment clarified
  that the dir at archive/<party>/mdl/ IS the table (not a child).

Client changes:

- tables/js/context.js walkServer fetches <currentdir>/table.yaml
  directly — no .zddc walk for table declarations. Rows are every
  *.yaml in current dir EXCLUDING table.yaml and form.yaml. The
  .zddc fetch-for-aliases is gated on file:// (online mode 404s
  on .zddc reads via the dispatcher's reserve guard, so skipping
  the request avoids browser console noise).

- tables/js/main.js add-row button links to relative form.html
  (same dir).

- tables/js/render.js + filters.js: every column's autofilter is
  uniformly a text-contains input, even enum columns — keeps the
  filter row visually consistent and doesn't constrain users to
  the enum vocabulary.

PART 2 — unified table+form HTML bundle

The form-render and table-render code paths share field schemas,
the cell editor for excel-mode IS a form widget, and the form
system's POST-back / validation already exists. Combining the two
HTMLs eliminates duplicating jsyaml/jsonschema/theme/source-
detection/.zddc-parsing across two single-file tools.

- tables/template.html grows two top-level mode containers:
  #table-mode (toolbar + sortable table) and #form-mode (form +
  submit button). Both hidden at parse time; the dispatcher
  unhides one. The shared #form-context placeholder was added
  here so the server's existing injectFormContext target
  resolves.

- tables/js/mode.js (new) sets window.zddcMode synchronously
  based on URL pattern: /form.html or /<id>.yaml.html → form,
  /table.html → table, else inline-context fallback for
  file:// (whichever context blob is non-empty wins). Unhides
  the matching container at DOMContentLoaded.

- tables/js/main.js init() and form/js/main.js boot() each guard
  early when mode isn't theirs. Both apps live on different
  globals (window.tablesApp vs window.formApp) so module
  registration doesn't collide.

- form/js/main.js title write falls back from #form-title to
  #table-title (the unified bundle's shared header element)
  when the dedicated id isn't present.

- tables/build.sh concatenates form modules (widgets, render,
  object, array, errors, post, serialize, util) and form CSS.
  No new external deps. Bundle grows from ~95KB to ~120KB.

- internal/handler/formhandler.go drops the //go:embed form.html
  directive; serveFormRender now writes embeddedTablesHTML via
  a small formRenderHTML() accessor (var declared in
  tablehandler.go, same package). The embedded form.html file
  is removed.

- build script: cp form/dist/form.html → internal/handler/form.html
  step is gone (file no longer exists in the source tree). cp
  tables/dist/tables.html → internal/handler/tables.html now
  runs unconditionally rather than only on beta/stable cuts —
  the renderer is a fixed binary component and dev iteration
  needs the embedded copy refreshed every build. Channel-cascaded
  apps (internal/apps/embedded/) stay channel-gated as before.

- form/dist/form.html still builds for standalone offline-only
  use (downloadable from /releases/), but no longer goes into
  the binary.

Tests:

- internal/handler/tablehandler_test.go and formhandler_test.go
  rewritten for the in-dir layout. New test
  TestRecognizeFormRequest_DefaultMdlAtArchiveParty covers
  empty-form, create POST, re-edit row, and the negative cases
  (Working/, non-mdl name) where the fallback must NOT fire.

- internal/handler/directory_test.go updated for the new
  /<dir>/table.html redirect target.

- cmd/zddc-server/main_test.go TestDispatchSlashRouting Location
  expectation updated.

- tests/form-safety.spec.js loads tables/dist/tables.html
  (named form.html in the temp dir to trigger form-mode in the
  dispatcher) so it tests the same bytes the server returns.
  Title-element selector switches to #table-title.

- tests/tables.spec.js updates the status-filter test for the
  uniform text-input filter.

Docs:

- AGENTS.md form-data system rewrites the URL conventions and
  storage layout for in-dir; gains a Tables system section
  parallel to forms describing the self-contained-directory
  property; subfolder rules ("one table per folder by
  construction; subfolders allowed and silently ignored as rows
  — legitimate uses: nested sub-tables, per-row attachments,
  drafts, future history sidecars") so we don't re-derive this.

Not included (deferred):

- ACL gating on cell-level writes — not relevant until Phase 3.
- Editable cells UI — separate commit (Phase 1).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-09 09:15:26 -05:00

256 lines
11 KiB
JavaScript

import { test, expect } from '@playwright/test';
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
// Form mode is hosted by the unified tables.html bundle — same bytes the
// server returns for /<dir>/form.html and /<dir>/<id>.yaml.html. Loading
// tables/dist/tables.html via file:// (named form.html in the temp dir
// so the URL pathname triggers form-mode in the dispatcher) is the
// closest offline mirror of what online callers actually receive.
const HTML_PATH = path.resolve('tables/dist/tables.html');
const HTML_RAW = fs.readFileSync(HTML_PATH, 'utf8');
const SAFETY_SCHEMA = {
type: 'object',
required: ['date', 'location'],
additionalProperties: false,
properties: {
date: { type: 'string', format: 'date' },
location: { type: 'string', enum: ['Site A', 'Site B', 'Site C'] },
hazards: {
type: 'array',
items: {
type: 'object',
required: ['kind', 'severity'],
properties: {
kind: { type: 'string' },
severity: { type: 'integer', minimum: 1, maximum: 5 },
notes: { type: 'string' },
},
},
},
additionalNotes: { type: 'string' },
},
};
const SAFETY_UI = {
location: { 'ui:widget': 'radio' },
hazards: { 'ui:options': { addable: true, removable: true } },
additionalNotes: { 'ui:widget': 'textarea' },
};
// Inject a complete form-context into the page before form bootstraps.
// Writes a patched copy of form.html to a temp file and navigates via
// file:// — page.setContent's about:blank origin doesn't expose
// localStorage, which trips up shared/theme.js. page.route can't intercept
// file://, so this is the cleanest path. The form is fully self-contained,
// so the temp file works without relative-resource resolution.
async function loadFormWithContext(page, context) {
const ctxJson = JSON.stringify(context).replace(/<\//g, '<\\/');
const replacement = `<script id="form-context" type="application/json">${ctxJson}</script>`;
const patched = HTML_RAW.replace(
/<script id="form-context" type="application\/json">[\s\S]*?<\/script>/,
replacement
);
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'form-spec-'));
const tmpPath = path.join(tmpDir, 'form.html');
fs.writeFileSync(tmpPath, patched);
await page.goto(`file://${tmpPath}`, { waitUntil: 'load' });
}
test.describe('form/ — safety check-in renderer', () => {
test('renders all field types from the schema', async ({ page }) => {
page.on('console', msg => {
if (msg.type() === 'error') console.log('[browser-error]', msg.text());
});
page.on('pageerror', e => console.log('[pageerror]', e.message));
await loadFormWithContext(page, {
title: 'Safety Check-In',
schema: SAFETY_SCHEMA,
ui: SAFETY_UI,
data: null,
submitUrl: '/test/safety.form.html',
});
// Wait for the renderer to populate the form (#form-root has display:flex
// but is reported as "hidden" by Playwright when it has zero children).
await page.waitForFunction(
() => document.getElementById('form-root') && document.getElementById('form-root').children.length > 0,
null,
{ timeout: 5000 },
);
await expect(page.locator('#form-root input[type="date"]')).toHaveCount(1);
const radios = page.locator('#form-root input[type="radio"]');
await expect(radios).toHaveCount(3); // Site A / B / C
await expect(page.locator('#form-root textarea')).toHaveCount(1);
await expect(page.locator('#form-root .form-array__add')).toHaveCount(1);
// Title element is shared across modes in the unified bundle.
await expect(page.locator('#table-title')).toContainText('Safety Check-In');
});
test('add/remove hazard rows works', async ({ page }) => {
await loadFormWithContext(page, {
schema: SAFETY_SCHEMA,
ui: SAFETY_UI,
data: null,
submitUrl: '/test/safety.form.html',
});
await page.waitForSelector('#form-root');
await expect(page.locator('.form-array__row')).toHaveCount(0);
await page.locator('.form-array__add').click();
await expect(page.locator('.form-array__row')).toHaveCount(1);
await page.locator('.form-array__add').click();
await expect(page.locator('.form-array__row')).toHaveCount(2);
// Remove the first row.
await page.locator('.form-array__row').first().locator('button.btn-small').click();
await expect(page.locator('.form-array__row')).toHaveCount(1);
});
test('valid submission posts JSON matching schema shape', async ({ page }) => {
// Install an in-page fetch mock (page.route doesn't intercept file://).
await page.addInitScript(() => {
window.__captured = [];
window.__mockFetchResponse = {
status: 201,
headers: new Headers({ Location: '/test/safety/2026-05-01-casey.yaml', 'Content-Type': 'application/json' }),
bodyText: '{"location":"/test/safety/2026-05-01-casey.yaml"}',
};
const origFetch = window.fetch;
window.fetch = async function (input, init) {
const url = typeof input === 'string' ? input : input.url;
const method = (init && init.method) || 'GET';
if (method === 'POST') {
let body = init && init.body;
try { body = JSON.parse(body); } catch (e) { /* ignore */ }
window.__captured.push({ url, method, body });
const r = window.__mockFetchResponse;
return new Response(r.bodyText || '', { status: r.status, headers: r.headers });
}
return origFetch(input, init);
};
});
await loadFormWithContext(page, {
schema: SAFETY_SCHEMA,
ui: SAFETY_UI,
data: null,
submitUrl: '/test/safety.form.html',
});
await page.waitForSelector('#form-root');
// Fill fields.
await page.locator('#form-root input[type="date"]').fill('2026-05-01');
await page.locator('#form-root input[type="radio"][value="Site B"]').check();
await page.locator('.form-array__add').click();
await page.locator('.form-array__row input[type="text"]').first().fill('Loose handrail');
await page.locator('.form-array__row input[type="number"]').fill('3');
await page.locator('#form-root textarea').fill('Fixed during shift.');
// Submit and prevent navigation away (the form redirects on 201).
await page.evaluate(() => {
// Pin window.location.href to no-op so the test doesn't navigate.
const stub = () => {};
Object.defineProperty(window, 'location', {
value: new Proxy(window.location, {
set: () => true,
get: (target, prop) => {
if (prop === 'href') return target.href;
return target[prop];
},
}),
writable: true,
configurable: true,
});
void stub;
}).catch(() => { /* best-effort; not all browsers permit overriding location */ });
// Stub setTimeout so the post-201 navigation doesn't fire during the test.
await page.evaluate(() => {
const origSetTimeout = window.setTimeout;
window.setTimeout = function (fn, ms) {
if (ms === 400) return 0; // suppress redirect timer
return origSetTimeout(fn, ms);
};
});
await page.locator('#submit-btn').click();
await page.waitForFunction(() => window.__captured && window.__captured.length > 0, null, { timeout: 5000 });
const captured = await page.evaluate(() => window.__captured);
expect(captured.length).toBeGreaterThan(0);
const body = captured[0].body;
expect(body.date).toBe('2026-05-01');
expect(body.location).toBe('Site B');
expect(Array.isArray(body.hazards)).toBe(true);
expect(body.hazards.length).toBe(1);
expect(body.hazards[0].kind).toBe('Loose handrail');
expect(body.hazards[0].severity).toBe(3);
expect(body.additionalNotes).toBe('Fixed during shift.');
});
test('server validation errors display per-field', async ({ page }) => {
await page.addInitScript(() => {
window.fetch = async function (input, init) {
if (init && init.method === 'POST') {
return new Response(JSON.stringify({
errors: [
{ path: '/location', message: 'required' },
{ path: '/hazards/0/severity', message: 'must be at most 5' },
],
}), { status: 422, headers: { 'Content-Type': 'application/json' } });
}
throw new Error('unexpected fetch');
};
});
await loadFormWithContext(page, {
schema: SAFETY_SCHEMA,
ui: SAFETY_UI,
data: null,
submitUrl: '/test/safety.form.html',
});
await page.waitForSelector('#form-root');
await page.locator('#form-root input[type="date"]').fill('2026-05-01');
await page.locator('.form-array__add').click();
await page.locator('.form-array__row input[type="text"]').first().fill('x');
await page.locator('.form-array__row input[type="number"]').fill('99');
await page.locator('#submit-btn').click();
// Two error messages should be visible (location, severity).
await expect(page.locator('.form-field__error:not([hidden])')).toHaveCount(2);
await expect(page.locator('#form-status')).toContainText('Please correct');
});
test('pre-fills form when data is provided', async ({ page }) => {
await loadFormWithContext(page, {
schema: SAFETY_SCHEMA,
ui: SAFETY_UI,
data: {
date: '2026-04-15',
location: 'Site C',
hazards: [
{ kind: 'Slippery floor', severity: 2, notes: 'Wet from rain.' },
],
additionalNotes: 'Pre-existing draft.',
},
submitUrl: '/test/safety/2026-04-15-jamie.yaml.html',
});
await page.waitForSelector('#form-root');
await expect(page.locator('#form-root input[type="date"]')).toHaveValue('2026-04-15');
await expect(page.locator('#form-root input[type="radio"][value="Site C"]')).toBeChecked();
await expect(page.locator('.form-array__row')).toHaveCount(1);
await expect(page.locator('.form-array__row input[type="text"]').first()).toHaveValue('Slippery floor');
await expect(page.locator('.form-array__row input[type="number"]')).toHaveValue('2');
await expect(page.locator('#form-root textarea')).toHaveValue('Pre-existing draft.');
});
});