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>
347 lines
11 KiB
Go
347 lines
11 KiB
Go
package handler
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"codeberg.org/VARASYS/ZDDC/zddc/internal/config"
|
|
"codeberg.org/VARASYS/ZDDC/zddc/internal/zddc"
|
|
)
|
|
|
|
const sampleTableSpec = `title: Master Deliverables List
|
|
description: Sample MDL.
|
|
columns:
|
|
- field: id
|
|
title: ID
|
|
width: 6em
|
|
- field: title
|
|
title: Deliverable
|
|
- field: status
|
|
title: Status
|
|
enum: [pending, submitted, accepted]
|
|
defaults:
|
|
sort:
|
|
- { field: id, dir: asc }
|
|
`
|
|
|
|
const sampleRowFormSpec = `title: Deliverable
|
|
schema:
|
|
type: object
|
|
required: [id, title]
|
|
additionalProperties: false
|
|
properties:
|
|
id:
|
|
type: string
|
|
title:
|
|
type: string
|
|
status:
|
|
type: string
|
|
enum: [pending, submitted, accepted]
|
|
`
|
|
|
|
// tableTestSetup writes a directory tree under a temp root with the
|
|
// in-dir layout:
|
|
//
|
|
// <root>/Working/MDL/table.yaml → spec
|
|
// <root>/Working/MDL/form.yaml → row schema
|
|
// <root>/Working/MDL/<file>.yaml → row data (one per entry in rows)
|
|
//
|
|
// Optional extra .zddc files at relative paths can be supplied via zddcFiles.
|
|
// Returns (config, do) where do dispatches a request through ServeTable via
|
|
// the same recognize → serve path the production catch-all uses.
|
|
//
|
|
// Note: under the client-side rendering architecture the handler does not
|
|
// parse the spec or list row files — the rows/spec on disk are written
|
|
// only because the ACL cascade may evaluate paths under them.
|
|
func tableTestSetup(t *testing.T, rows map[string]string, zddcFiles map[string]string) (config.Config, func(method, target, email string) *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
root := t.TempDir()
|
|
|
|
mdlDir := filepath.Join(root, "Working", "MDL")
|
|
if err := os.MkdirAll(mdlDir, 0o755); err != nil {
|
|
t.Fatalf("mkdir: %v", err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(mdlDir, "table.yaml"), []byte(sampleTableSpec), 0o644); err != nil {
|
|
t.Fatalf("write spec: %v", err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(mdlDir, "form.yaml"), []byte(sampleRowFormSpec), 0o644); err != nil {
|
|
t.Fatalf("write form spec: %v", err)
|
|
}
|
|
for name, body := range rows {
|
|
if err := os.WriteFile(filepath.Join(mdlDir, name), []byte(body), 0o644); err != nil {
|
|
t.Fatalf("write row %s: %v", name, err)
|
|
}
|
|
}
|
|
if _, ok := zddcFiles["Working"]; !ok {
|
|
if zddcFiles == nil {
|
|
zddcFiles = make(map[string]string)
|
|
}
|
|
zddcFiles["Working"] = `acl:
|
|
permissions:
|
|
"*@example.com": rwcd
|
|
`
|
|
}
|
|
for rel, body := range zddcFiles {
|
|
dir := filepath.Join(root, rel)
|
|
if err := os.MkdirAll(dir, 0o755); err != nil {
|
|
t.Fatalf("mkdir %s: %v", dir, err)
|
|
}
|
|
zddc.InvalidateCache(dir)
|
|
if body == "" {
|
|
continue
|
|
}
|
|
if err := os.WriteFile(filepath.Join(dir, ".zddc"), []byte(body), 0o644); err != nil {
|
|
t.Fatalf("write .zddc: %v", err)
|
|
}
|
|
}
|
|
cfg := config.Config{Root: root, EmailHeader: "X-Auth-Request-Email"}
|
|
|
|
do := func(method, target, email string) *httptest.ResponseRecorder {
|
|
req := httptest.NewRequest(method, target, bytes.NewReader(nil))
|
|
ctx := context.WithValue(req.Context(), EmailKey, email)
|
|
req = req.WithContext(ctx)
|
|
rec := httptest.NewRecorder()
|
|
|
|
tableReq := RecognizeTableRequest(cfg.Root, method, target)
|
|
if tableReq == nil {
|
|
rec.WriteHeader(http.StatusNotFound)
|
|
return rec
|
|
}
|
|
ServeTable(cfg, tableReq, rec, req)
|
|
return rec
|
|
}
|
|
return cfg, do
|
|
}
|
|
|
|
func TestRecognizeTableRequest(t *testing.T) {
|
|
root := t.TempDir()
|
|
mdlDir := filepath.Join(root, "Working", "MDL")
|
|
if err := os.MkdirAll(mdlDir, 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(mdlDir, "table.yaml"), []byte(sampleTableSpec), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(mdlDir, "form.yaml"), []byte(sampleRowFormSpec), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
zddc.InvalidateCache(mdlDir)
|
|
|
|
cases := []struct {
|
|
method, url string
|
|
wantNil bool
|
|
wantSpec string
|
|
wantName string
|
|
}{
|
|
{"GET", "/Working/MDL/table.html", false, "Working/MDL/table.yaml", "MDL"},
|
|
// Same URL but POST → tables are read-only at the URL level.
|
|
{"POST", "/Working/MDL/table.html", true, "", ""},
|
|
{"PUT", "/Working/MDL/table.html", true, "", ""},
|
|
{"DELETE", "/Working/MDL/table.html", true, "", ""},
|
|
// No table.yaml in this dir → not a table request.
|
|
{"GET", "/Working/Other/table.html", true, "", ""},
|
|
// No table.yaml anywhere → not a table request.
|
|
{"GET", "/Other/MDL/table.html", true, "", ""},
|
|
// Random .html → falls through.
|
|
{"GET", "/index.html", true, "", ""},
|
|
// /form.html in the same dir is form territory, not a table.
|
|
{"GET", "/Working/MDL/form.html", true, "", ""},
|
|
// Path traversal attempt.
|
|
{"GET", "/../etc/passwd/table.html", true, "", ""},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
t.Run(tc.method+" "+tc.url, func(t *testing.T) {
|
|
got := RecognizeTableRequest(root, tc.method, tc.url)
|
|
if tc.wantNil {
|
|
if got != nil {
|
|
t.Errorf("got %+v, want nil", got)
|
|
}
|
|
return
|
|
}
|
|
if got == nil {
|
|
t.Fatalf("got nil, want a TableRequest")
|
|
}
|
|
if got.Name != tc.wantName {
|
|
t.Errorf("Name = %q want %q", got.Name, tc.wantName)
|
|
}
|
|
wantSpec := filepath.Join(root, tc.wantSpec)
|
|
if got.SpecPath != wantSpec {
|
|
t.Errorf("SpecPath = %q want %q", got.SpecPath, wantSpec)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestServeTable_ServesEmbeddedHTML — an ACL-passing GET returns the
|
|
// embedded tables.html bytes verbatim, with the empty inline context
|
|
// placeholder intact (so the client knows to walk the directory).
|
|
func TestServeTable_ServesEmbeddedHTML(t *testing.T) {
|
|
rows := map[string]string{
|
|
"D-001.yaml": "id: D-001\ntitle: One\nstatus: pending\n",
|
|
}
|
|
_, do := tableTestSetup(t, rows, nil)
|
|
rec := do(http.MethodGet, "/Working/MDL/table.html", "casey@example.com")
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("status = %d body = %s", rec.Code, rec.Body.String())
|
|
}
|
|
if ct := rec.Result().Header.Get("Content-Type"); !strings.HasPrefix(ct, "text/html") {
|
|
t.Errorf("Content-Type = %q want text/html…", ct)
|
|
}
|
|
body := rec.Body.String()
|
|
if !strings.Contains(body, `<table id="table-root"`) {
|
|
t.Error("body missing #table-root markup; embedded HTML may be stale or empty")
|
|
}
|
|
if !strings.Contains(body, `<script id="table-context" type="application/json">{}</script>`) {
|
|
t.Error("inline context placeholder not preserved verbatim — client expects {} so it knows to walk")
|
|
}
|
|
}
|
|
|
|
func TestServeTable_ACLForbidden(t *testing.T) {
|
|
zddcs := map[string]string{
|
|
"Working": `acl:
|
|
permissions:
|
|
"root@example.com": rwcd
|
|
tables:
|
|
MDL: ./MDL.table.yaml
|
|
`,
|
|
}
|
|
_, do := tableTestSetup(t, map[string]string{"D.yaml": "id: D\n"}, zddcs)
|
|
rec := do(http.MethodGet, "/Working/MDL/table.html", "stranger@example.com")
|
|
if rec.Code != http.StatusForbidden {
|
|
t.Errorf("status = %d want 403; body = %s", rec.Code, rec.Body.String())
|
|
}
|
|
}
|
|
|
|
// --- default MDL spec fallback ---------------------------------------------
|
|
|
|
// archivePartyTestSetup builds a minimal Project/archive/<party>/ tree
|
|
// with no operator-supplied tables: declaration. RecognizeTableRequest
|
|
// should still fire for "mdl" thanks to the default-spec fallback.
|
|
func archivePartyTestSetup(t *testing.T, partyZddcExtras string) (string, func(method, target, email string) *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
root := t.TempDir()
|
|
|
|
if err := os.WriteFile(filepath.Join(root, ".zddc"),
|
|
[]byte("acl:\n permissions:\n \"*@example.com\": rwcda\n"), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
partyDir := filepath.Join(root, "Project", "archive", "Acme")
|
|
if err := os.MkdirAll(partyDir, 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if partyZddcExtras != "" {
|
|
if err := os.WriteFile(filepath.Join(partyDir, ".zddc"), []byte(partyZddcExtras), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
zddc.InvalidateCache(root)
|
|
|
|
cfg := config.Config{
|
|
Root: root,
|
|
EmailHeader: "X-Auth-Request-Email",
|
|
}
|
|
do := func(method, target, email string) *httptest.ResponseRecorder {
|
|
req := httptest.NewRequest(method, target, bytes.NewReader(nil))
|
|
ctx := context.WithValue(req.Context(), EmailKey, email)
|
|
req = req.WithContext(ctx)
|
|
|
|
tr := RecognizeTableRequest(cfg.Root, method, target)
|
|
rec := httptest.NewRecorder()
|
|
if tr == nil {
|
|
rec.WriteHeader(http.StatusNotFound)
|
|
return rec
|
|
}
|
|
ServeTable(cfg, tr, rec, req)
|
|
return rec
|
|
}
|
|
return root, do
|
|
}
|
|
|
|
func TestRecognizeTableRequest_DefaultMdlAtArchiveParty(t *testing.T) {
|
|
_, do := archivePartyTestSetup(t, "")
|
|
|
|
rec := do(http.MethodGet, "/Project/archive/Acme/mdl/table.html", "alice@example.com")
|
|
if rec.Code != http.StatusOK {
|
|
t.Fatalf("default mdl recognition: want 200, got %d: %s", rec.Code, rec.Body.String())
|
|
}
|
|
body := rec.Body.String()
|
|
if !strings.Contains(body, "<html") {
|
|
t.Errorf("expected tables.html bytes, got %q…", body[:min(80, len(body))])
|
|
}
|
|
}
|
|
|
|
func TestRecognizeTableRequest_DefaultOnlyAtPartyLevel(t *testing.T) {
|
|
// Default fallback is scoped to <project>/archive/<party>/. A
|
|
// request at a deeper path (e.g. archive/Acme/mdl/sub/) or a
|
|
// non-archive path should return nil (no recognition).
|
|
_, do := archivePartyTestSetup(t, "")
|
|
|
|
rec := do(http.MethodGet, "/Project/archive/Acme/incoming/mdl/table.html", "alice@example.com")
|
|
if rec.Code != http.StatusNotFound {
|
|
t.Errorf("mdl deeper than party level should not recognise; got %d", rec.Code)
|
|
}
|
|
rec = do(http.MethodGet, "/Project/working/mdl/table.html", "alice@example.com")
|
|
if rec.Code != http.StatusNotFound {
|
|
t.Errorf("mdl outside archive/ should not recognise; got %d", rec.Code)
|
|
}
|
|
}
|
|
|
|
func TestIsDefaultMdlSpec_ServesEmbeddedYAML(t *testing.T) {
|
|
root := t.TempDir()
|
|
// archive/Acme/ exists but no mdl/table.yaml on disk.
|
|
if err := os.MkdirAll(filepath.Join(root, "Project", "archive", "Acme"), 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
bts, ok := IsDefaultMdlSpec(root, "/Project/archive/Acme/mdl/table.yaml")
|
|
if !ok {
|
|
t.Fatalf("expected fallback to fire")
|
|
}
|
|
if !strings.Contains(string(bts), "Master Deliverables List") {
|
|
t.Errorf("default table spec missing expected header; got %q…", string(bts)[:min(80, len(bts))])
|
|
}
|
|
|
|
bts, ok = IsDefaultMdlSpec(root, "/Project/archive/Acme/mdl/form.yaml")
|
|
if !ok {
|
|
t.Fatalf("expected form fallback to fire")
|
|
}
|
|
if !strings.Contains(string(bts), "Deliverable") {
|
|
t.Errorf("default form spec missing expected title")
|
|
}
|
|
}
|
|
|
|
func TestIsDefaultMdlSpec_OperatorFileWins(t *testing.T) {
|
|
root := t.TempDir()
|
|
mdlDir := filepath.Join(root, "Project", "archive", "Acme", "mdl")
|
|
if err := os.MkdirAll(mdlDir, 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(mdlDir, "table.yaml"), []byte("custom: yes\n"), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if _, ok := IsDefaultMdlSpec(root, "/Project/archive/Acme/mdl/table.yaml"); ok {
|
|
t.Errorf("operator file should win over embedded fallback")
|
|
}
|
|
}
|
|
|
|
func TestIsDefaultMdlSpec_OnlyAtArchivePartyLevel(t *testing.T) {
|
|
root := t.TempDir()
|
|
cases := []string{
|
|
"/Project/working/mdl/table.yaml",
|
|
"/Project/archive/mdl/table.yaml", // depth 3 — no party segment
|
|
"/Project/archive/Acme/sub/mdl/table.yaml",
|
|
}
|
|
for _, p := range cases {
|
|
if _, ok := IsDefaultMdlSpec(root, p); ok {
|
|
t.Errorf("path %q should NOT trigger default fallback", p)
|
|
}
|
|
}
|
|
}
|
|
|