Compare commits

...

92 Commits

Author SHA1 Message Date
Jakub Zych
e2759d668f docs: user-plugin escalations released in sm-user-plugin v0.1.9, reply ready to send 2026-10-23 00:25:24 +02:00
Jakub Zych
eadd58414d docs(19.7-02): close plan without a release 2026-10-23 00:23:08 +02:00
Jakub Zych
a26ee2b72d docs(quick-261022-x7a): user-plugin golem15.user.password.public_routes switch, login/forgot/reset 404 when false 2026-10-23 00:15:49 +02:00
Jakub Zych
e5dd4579a8 docs: fill item 8 in the external-escalation reply 2026-10-23 00:10:27 +02:00
Jakub Zych
894a3d572f docs(19.7): next v0.4.x release after the quick tasks, v0.5.0 at phase completion 2026-10-23 00:08:10 +02:00
Jakub Zych
d1a15a6f5f docs(19.7): tag v0.5.0 only when phase 19.7 is complete 2026-10-23 00:05:39 +02:00
Jakub Zych
a9e3f2434d docs: tune item 8 password-routes quick after item 7 2026-10-22 23:53:43 +02:00
Jakub Zych
cd90be9de3 docs(quick-261022-wah): user-plugin opt-in token_cookie session cookie and cookie-carried /refresh rotation 2026-10-22 23:51:57 +02:00
Jakub Zych
6a1974c0d2 docs: fill item 7 in the external-escalation reply 2026-10-22 23:45:20 +02:00
Jakub Zych
ec69f547b8 docs: tune item 7 cookie quick after 9-10 2026-10-22 23:14:09 +02:00
Jakub Zych
e9ebf93d36 docs(quick-261022-vfz): user-plugin /login throttle via surf.ClientIP and whole-second tokens_valid_after writers 2026-10-22 23:08:04 +02:00
Jakub Zych
c309a1abe9 docs: tune items 9-10 quick after G4 2026-10-22 22:37:41 +02:00
Jakub Zych
575a110378 docs: fill G4 in the external-escalation reply 2026-10-22 22:36:19 +02:00
Jakub Zych
54ff7bd665 docs(quick-261022-usi): user-plugin jwt blacklist and hooks wired via lagoon.OnDatabase under serve 2026-10-22 22:36:19 +02:00
Jakub Zych
b8bf71c5dd docs: fold G3 leftovers into G4 and login-cookie quicks 2026-10-22 22:00:09 +02:00
Jakub Zych
98a95c9c92 docs(quick-261022-tto): user-plugin session routes accept the session cookies 2026-10-22 21:52:03 +02:00
Jakub Zych
b70abe48e6 docs: fill G3 in the external-escalation reply 2026-10-22 21:46:10 +02:00
Jakub Zych
3ebd78373c docs: hold user-plugin escalations for SummerCMS v0.5.0 2026-10-22 21:37:57 +02:00
Jakub Zych
76694c7cb9 docs: fill G2 in the external-escalation reply 2026-10-22 21:36:43 +02:00
Jakub Zych
3026cf61fb docs(quick-261022-tb4): password login refuses a not-activated account 2026-10-22 21:32:30 +02:00
Jakub Zych
cb33c497be docs(quick-261022-k9k): admin keyboard shortcuts 2026-10-22 21:11:24 +02:00
Jakub Zych
604fee757e chore(quick-261022-k9k): rebuild embedded admin dist 2026-10-22 21:08:31 +02:00
Jakub Zych
058738efdf test(quick-261022-k9k): keyboard shortcut coverage
- hotkey core: combos, AltGr and layouts, labels, aria-keyshortcuts, editable
  targets, modal root, refcounted install, disabled and repeat
- smoke: record, create, Create and new (new session key), Esc, modal scope,
  settings Save and close, My account, list search and the help dialog
- ShortcutHelpDialog rows, keys and close button
2026-10-22 21:07:40 +02:00
Jakub Zych
66bb96eebd docs: capture six user-plugin escalation quicks 2026-10-22 21:04:34 +02:00
Jakub Zych
101cad0365 feat(quick-261022-k9k): Esc, slash and help shortcuts, settings, account and modal save keys
- '?' help dialog (ShortcutHelpDialog) listing the current screen's shortcuts
- Esc = Cancel on record forms; '/' focuses the list search
- settings forms: Save and close (Ctrl/Cmd+Enter, then /settings) and Ctrl/Cmd+S
- My account: Ctrl/Cmd+S
- modal forms: Ctrl/Cmd+S and Ctrl/Cmd+Enter submit the innermost dialog only
- docs: Keyboard shortcuts section in the admin SPA page
2026-10-22 21:03:30 +02:00
Jakub Zych
49accf675e feat(quick-261022-k9k): admin save shortcuts and Create and new on record forms
- app/hotkeys.ts: dependency-free data-hotkey core (Ctrl/Cmd+S, Ctrl/Cmd+Enter,
  Ctrl/Cmd+Shift+S, Esc, / and ?), innermost-modal root, capture-phase modifier
  listener, platform labels and the help-dialog state
- Button hotkey prop (data-hotkey, aria-keyshortcuts); shortcuts installed by AppShell
- FormView: save keys and tooltips, Create and new on create forms via remountView
- phrasebook: form.create_and_new and the shortcuts group (en, pl)
2026-10-22 21:00:57 +02:00
Jakub Zych
1aff96f58a docs(19.7-02): record deferred items from the pier session router 2026-10-22 18:36:23 +02:00
Jakub Zych
8c6c0a3654 feat(19.7-02): identity kinds, ceilings, prompts and the MCP services page
- personal tokens only behind mcp.allow_personal_tokens (401 without a
  lookup otherwise); an admin token yields a backend-only identity with
  its scope limit per dispatched method, a user token a frontend-only one
- read/write ceiling and prompts proven by the tracer's subtests; the
  audit line asserted to carry the tool and never the arguments or token
- the mounted *pier.Pier is published on the application (test seams in
  export_test.go)
- docs/services/mcp.md with the tested acme.blog example, site.yaml note,
  cross-links from authentication.md, registration.md and the surf README
2026-10-22 18:34:39 +02:00
Jakub Zych
806e87c510 feat(19.7-02): Redis sessions, event fan-out, stateless protocol path and resource metadata
- store_redis.go: records with PX TTLs, per-binding sets, pub/sub events,
  opened lazily from redis.url under cooler's prefix (nothing dials at mount)
- events.go: pact.MCPSubjectChanged republished through the store; every
  instance recomputes the subject's sessions and stateless servers
  (list_changed) or ends them on revocation; the link cache is dropped
- stateless.go: the SDK's stateless handler over per-identity servers for
  2026-07-28 clients, routed by the protocol header or server/discover
- prm.go: RFC 9728 metadata at both well-known paths; long GET streams
  re-verify their bearer every minute
- TestPierSessionsSmoke, TestPierFanOutSmoke, TestPierStatelessSmoke on
  miniredis; README features, configuration and operational notes
2026-10-22 18:23:43 +02:00
Jakub Zych
cfdbaf0e47 feat(19.7-02): pier MCP module tracer with in-process dispatch and sessions
- modules/pier: Host contract, mcp.* config, catalog compiled from
  pact.HasMCP (prefixing, route binding, guard resolution, schema
  reflection, annotations), per-request identity through the published
  verifier and resolvers, built-in backend guard provider, in-process
  dispatch with the bouncer marker, per-identity SDK server with the
  per-request re-filter, stateful session router with rehydration over a
  memory store, audit lines
- modules/surf/pier_on.go: the summercms_mcp hook adapting the router to
  pier.Host; the untagged hello binary carries no SDK
- go.mod: go-sdk v1.8.0 and jsonschema-go v0.4.3 (decision note committed
  before this change)
- TestPierTracerSmoke: SDK client lists and calls acme_echo end to end
  through surf's compiled guard chain; README and root table row
2026-10-22 18:15:59 +02:00
Jakub Zych
3ea82a1543 docs(19.7-02): decide the MCP Go SDK
- decision note for go-sdk v1.8.0 and jsonschema-go v0.4.3 with the
  transitive graph, size, govulncheck result and the build-tag containment
- STACK.md rows for both modules naming the note (D-24)
2026-10-22 18:00:16 +02:00
Jakub Zych
3746675c72 docs(19.7-01): complete framework seams plan 2026-10-22 16:45:12 +02:00
Jakub Zych
fab99e0a00 chore(19.7-01): rebuild the embedded admin for account contributions and prompted actions 2026-10-22 16:38:37 +02:00
Jakub Zych
9a5f27e86c feat(19.7-01): admin SPA account contributions and prompted record actions
- AccountContributions.vue on My account: one card per contributed section
  with status and outline buttons; confirm or danger actions go through the
  shared ConfirmDialog; a returned URL opens in a new tab (noopener) and stays
  as a visible link; 409 reloads with the stale toast
- ConfirmRequest.prompt and useConfirm value; ConfirmDialog renders one
  labelled text input (maxlength, autocomplete off, aria-describedby comment,
  autofocus), confirm disabled until a value is typed, Enter confirms
- RecordActions posts {payload} for a prompted action and {} otherwise; a 422
  on payload shows the server's detail as a danger toast
- types.ts exports RecordActionPrompt, AccountContribution,
  AccountContributionAction, AccountActionResult
- vitest smokes AccountContributions.test.ts and RecordActionsPrompt.test.ts
2026-10-22 16:38:37 +02:00
Jakub Zych
9f14cf603c feat(19.7-01): account contributions, prompted record actions and backend subject events
- pact.HasAccountContributions compiled at Activate; GET /account/contributions
  and POST /account/contributions/{name}/actions/{action} behind interactiveOnly
  (AccountContributionView, AccountContributionActionView, AccountActionResultView)
- RecordAction.prompt (RecordActionPrompt) for a pact.AdminRecordAction with a
  Prompt; the record action route accepts payload only for such an action
  (trimmed JSON string, non-empty, capped at max_length) and hands it to Run as
  Value through CRUDService.RecordActionWithValue; a prompt without a label
  fails boot
- fireSubjectChanged: pact.MCPSubjectChanged for revoked tokens, Administrators
  saves that changed role, permissions or superuser, Roles saves that changed
  grants, deactivation and deletion
- phrases backend::lang.form.action_prompt_required/_too_long (en, pl)
- smoke tests TestAccountContributionsSmoke and TestRecordActionPromptSmoke;
  TestRecordActionPromptRun on Postgres; route inventories, CSRF walk and
  OpenAPI conformance cases extended for the two routes
- regenerated admin/openapi/admin.json and admin/src/api/schema.d.ts; cabana
  README, docs/backend/{admin-controllers,users-and-permissions}.md
2026-10-22 16:31:29 +02:00
Jakub Zych
6887abf575 feat(19.7-01): SDK-free pact contracts for MCP, account contributions and prompted actions
- pact/mcp.go: HasMCP, MCP, MCPTool, MCPPrompt, MCPGuard, MCPGuards,
  MCPSubject, MCPDispatch, MCPTokenVerifier, MCPGrant, ErrMCPTokenInvalid,
  MCPPersonalTokenResolver, MCPLinkedBackendResolver, LinkedBackendUser,
  MCPSubjectChanged and its kinds, FrontendPermission, HasFrontendPermissions
- capabilities.go: AdminActionPrompt, AdminRecordAction.Prompt,
  AdminRecordActionInput.Value, HasAccountContributions, AccountContribution,
  AccountAction, AccountActionInput, AccountActionResult
- discovery tests, MCPGuards registry test and a go list -deps assertion
  that pact names neither the MCP SDK, jsonschema-go nor bouncer
- pact README and docs/plugins/registration.md rows
2026-10-22 16:16:35 +02:00
Jakub Zych
5c15dea569 feat(19.7-01): streaming routes, MCP mount hook, configurable authorize scopes
- surf.Router.MountStream and recoverStream: a raw, unbuffered route kind
  whose http.Flusher reaches the client; panic after the first byte only
  aborts the body
- surf.MCPBuildTag and the mountPier hook: mcp.enabled is inert without the
  summercms_mcp tag until it is true, then boot fails naming the tag
  (pier_off.go is the untagged side)
- wristband parseAuthorizeScopes takes the server's allowed set built from
  Options.ScopesSupported; the default set is unchanged
- cooler.KeyPrefix exported for the MCP module's Redis keys
- smoke tests TestStreamingRouteSmoke, TestPierMountSmoke, TestMCPScopesSmoke
- surf, wristband and cooler READMEs, docs/services/{routing,oauth-server}.md
2026-10-22 16:11:37 +02:00
Jakub Zych
1bd91a4522 feat(19.7-01): in-process dispatch marker and compiled handler lookup
- bouncer.Dispatch, WithDispatch, Dispatched: context-only pre-resolved
  principal marker honoured by Registry.Middleware for listed guard names
- cabana.ResolveBackend honours a backend-kind marker; additive
  ResolveBackendToken, ScopeLimitFor and BackendPrincipal resolvers
- surf.Router.Handler and compileHandlers: one compiled chain per route,
  shared by BuildRouter validation and compile
- smoke tests TestDispatchSmoke, TestDispatchedSmoke, TestDispatchMarkerSmoke
- READMEs and docs/services/{authentication,routing}.md updated
2026-10-22 16:00:19 +02:00
Jakub Zych
a74a218cd9 docs(19.7): mark phase planned after verification 2026-10-22 15:46:30 +02:00
Jakub Zych
3653422572 docs(phase-19.6.1): mark phase complete after UAT and security 2026-10-22 15:36:25 +02:00
Jakub Zych
b28800ad39 docs(phase-19.6.1): add/update security threat verification 2026-10-22 15:27:39 +02:00
Jakub Zych
0a5945d681 test(19.6.1): mark verification passed after UAT retest 2026-10-22 15:24:11 +02:00
Jakub Zych
19c6a65575 test(19.6.1): pass UAT test 2 after relation-label remount fix 2026-10-22 15:24:01 +02:00
Jakub Zych
49ffb395c0 docs(19.7): add pattern map, mark D-36 informational, drop session path from plan 02 2026-10-22 14:59:54 +02:00
Jakub Zych
2f496f6200 test(19.6.1): re-verify after relation-label gap closure 2026-10-22 14:59:34 +02:00
Jakub Zych
43d0f4622c docs(19.7): revise plans after plan check 2026-10-22 14:57:52 +02:00
Jakub Zych
587f9ddf2f docs(19.6.1): review persist relation labels
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-22 14:51:39 +02:00
Jakub Zych
ed7da85f46 docs(19.6.1-05): mark phase ready for verification 2026-10-22 14:44:14 +02:00
Jakub Zych
1e3b006c5d docs(19.6.1-05): record plan position and decision 2026-10-22 14:44:02 +02:00
Jakub Zych
007c68bab2 docs(19.6.1-05): complete persist relation labels plan 2026-10-22 14:43:34 +02:00
Jakub Zych
51e1a1ea6e chore(19.6.1-05): rebuild embedded admin dist
- modules/boardwalk/dist matches a fresh admin build
- remount-safe relation labels ship in the embedded SPA

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-22 14:42:18 +02:00
Jakub Zych
d47d6182f0 docs(19.7): create phase plans (5 plans: seams, pier, user plugin, oauthserver+journal+demo, tests and security review) 2026-10-22 14:41:30 +02:00
Jakub Zych
14baafb27c feat(19.6.1-05): persist picked relation labels across FormView tab remount
- FORM_REMEMBER_LABEL inject so hosts keep picked option names
- RelationField choose() writes the label before emit
- Vitest backstops remount and tab-switch labeling

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-22 14:40:35 +02:00
Jakub Zych
ba0501c274 test(19.6.1): complete UAT - 25 passed, 1 issue 2026-10-22 14:30:13 +02:00
Jakub Zych
51d088a3b2 docs(quick-261022-imo): settings section panel scoped to the current category 2026-10-22 13:54:08 +02:00
Jakub Zych
80bb5aee3d chore(quick-261022-imo): rebuild embedded admin dist 2026-10-22 13:53:06 +02:00
Jakub Zych
85476fa3fe test(quick-261022-imo): settings section panel coverage
- settingsSectionOf: null cases, category order, link entry placement
- SettingsPanel: labels, links, current entry, empty category, collapse
- AppShell: hidden cases, settings-link controllers, collapse, offset, narrow, focus hand-off
2026-10-22 13:52:20 +02:00
Jakub Zych
834ef98572 feat(quick-261022-imo): settings section panel scoped to the current category
- settingsSectionOf returns the current entry's category group (null for one-entry categories)
- SettingsPanel mirrors the plugin side menu, collapse included
- AppShell shows it on settings forms and settings-linked controllers without own navigation
- docs/backend/settings.md describes moving between settings pages
2026-10-22 13:50:39 +02:00
Jakub Zych
a97743a39f test(19.6.1): persist human verification items as UAT 2026-10-22 13:48:03 +02:00
Jakub Zych
d7dc2a385a docs(19.6.1): record gap-closure code review 2026-10-22 13:44:02 +02:00
Jakub Zych
6bd2506db6 docs(19.6.1-04): complete gap-closure plan 2026-10-22 13:37:26 +02:00
Jakub Zych
e62086084b chore(19.6.1-04): require CR-01 and WR-03 tests in the phase gate
The docker stage must refuse a tree that drops TestRolesCodeDeclaredCodeRefused or TestActionExtensionOutranked.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-22 13:36:12 +02:00
Jakub Zych
ffc0a94afe docs(quick-261022-imo): plan settings section panel scoped to category 2026-10-22 13:34:31 +02:00
Jakub Zych
cb460b6000 docs(19.6.1-04): state Administrators outranking on the D-14 seam
- cabana, not the contributor, applies guardOutranked before a contributed Run
- A contribution to summercms.cabana.users is 403 user.outranked when the target outranks the caller

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-22 13:30:40 +02:00
Jakub Zych
068adaabf9 fix(19.6.1-04): refuse code-declared role capture and wrap Administrators Runs
- Roles create and update refuse a submitted code that code-declared grants attach to
- compileActionExtensions wraps contributed Administrators Runs with guardOutranked
- Prove both holes on Postgres; keep the boot smoke callable with a superuser principal

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-22 13:29:38 +02:00
Jakub Zych
422bd1e01f test(19.6.1): complete UAT - 24 passed, 1 issue 2026-10-22 13:17:34 +02:00
Jakub Zych
eadc7810be docs(19.6.1): create gap-closure plan 2026-10-22 13:05:53 +02:00
Jakub Zych
cfebbacc3d docs(19.6.1): verification report, gaps found (22/25) 2026-10-22 12:45:01 +02:00
Jakub Zych
d6a6e7ac60 docs(19.6.1): record code review disposition 2026-10-22 12:36:13 +02:00
Jakub Zych
d5da300e24 docs(19.6.1): add code review report 2026-10-22 12:36:02 +02:00
Jakub Zych
a4cfd628ce docs(phase-19.6.1): update tracking after wave 3 2026-10-22 12:27:11 +02:00
Jakub Zych
1a68cc5280 docs(19.6.1-03): complete privilege rule tests and phase gate plan 2026-10-22 12:26:00 +02:00
Jakub Zych
8f3d625943 docs(19.6.1-03): validation map and deferred items
- 19.6.1-VALIDATION.md: per-task map green, Wave 0 ticked with the files
  as built, wave_0_complete true
- deferred-items.md: lagoon's model validator skips string min/max;
  granted does not expand a held leading wildcard
2026-10-22 12:24:35 +02:00
Jakub Zych
7842aca7f5 chore(19.6.1-03): check-phase19.6.1 gate
Fail-closed stages go, docker, admin, docs and sc1 with the detectors of
check-phase19.5.sh: every Docker-free and Postgres rule test by required
name, the SC-1 regression tests, the vitest and browser files, the
OpenAPI and dist checks, the consuming-application name check and the
SC-1 commit check. --all reports NOT RUN docker only without a daemon
(a failure with PHASE1961_REQUIRE_DOCKER=1); --self-test proves the
detectors and that rule.
2026-10-22 12:24:30 +02:00
Jakub Zych
4c61a180d0 test(19.6.1-03): SPA trigger, record lock and footer wrap tests
- trigger.test.ts: triggerState and applyTriggers
- FormView: disable, absent-controller and hide-tab backstops, the live
  announcement
- PermissionEditorField and formState: record-locked rows, notes and the
  payload omission, record lock over request lock, read-only screens
- PreviewView: hide removes, disable shows no note
- browser record-actions-wrap at 1024px; vitest.browser.config.ts gains
  the Tailwind plugin so the footer is laid out with the admin's CSS
2026-10-22 12:18:34 +02:00
Jakub Zych
085179b676 test(19.6.1-03): trigger boot rules and per-record permission locks
- TestFieldTriggerBoot (-short): every compileTrigger and checkTriggers
  refusal names controller, field and trigger; disable and hide reach the
  localized schema; settings and relation forms refuse the key
- TestPermissionRecordLocks (-short): the save rule in radio and checkbox
  modes, no lock lookup on create, meta only for stored records with a
  provider
- TestRolesCodeDeclaredLocks (Postgres): locked_by_code grants on a role,
  a save without them, locked_self on the own record
2026-10-22 12:11:57 +02:00
Jakub Zych
1a56294d9b test(19.6.1-03): last-superuser race, lifecycle, revocation, seam and roles tests
- TestAdministratorsLastSuperuser (D-09): A and B reduce each other on the
  five paths while a test transaction holds the guard's advisory lock until
  pg_locks shows both requests waiting; one succeeds, one gets last_superuser
- TestAdministratorsLastSuperuserConcurrent: ten unsynchronized rounds
- TestAdministratorsLifecycle (D-10) and TestAdministratorsRevocation (D-12),
  two-row bulk selections included
- TestActionExtensionBoot (-short) and TestActionExtensionRun (D-14, D-15)
- TestRolesLifecycle (D-16, D-17), TestRolesPermissionCeiling (D-07)
- TestBackendScreensActivation (-short, D-01, D-04)
2026-10-22 12:09:12 +02:00
Jakub Zych
83240706b2 fix(cabana): bulk lifecycle actions change every selected administrator
actionDB returned the Unscoped instance of the action's session, whose
conditions accumulate, so a bulk activate, deactivate or restore of two
applicable rows wrote only the first (the second update matched
"id = A AND id = B") while still counting it. A bulk deactivate
therefore left the other administrators active and signed in (D-10,
D-12). actionDB now ends with a plain Session, so every query starts
anew. Found by TestAdministratorsLifecycle.
2026-10-22 12:04:01 +02:00
Jakub Zych
b684bb7d8d test(19.6.1-03): save-path privilege rule tests
- TestAdministratorsSuperuserHidden (D-03, scoped-token superusers)
- TestAdministratorsSuperuserProjected (Pitfall 1)
- TestAdministratorsPermissionCeiling and TestAdministratorsRoleCeiling (D-06, D-07)
- TestAdministratorsSelfEdit (D-08), TestAdministratorsPasswordAndIdentity (D-11)
- TestAdministratorsOutranked (D-19), TestAdministratorsOwnPassword (D-20)
- TestRoleCeiling (-short) against grantsCovered
2026-10-22 12:01:06 +02:00
Jakub Zych
461cb21b3e fix(cabana): enforce the 4-character password minimum on the Administrators form
The form's min:4 rule never applied: the model validator skips string
min and max. storePassword now refuses a typed password under 4
characters with a 422 on the field, next to the 72-byte check (D-11).
Found by TestAdministratorsPasswordAndIdentity.
2026-10-22 12:00:18 +02:00
Jakub Zych
536ea8c1bf test(19.6.1-03): screens test env and the superuser flag rule over HTTP
- administrators_harness_test.go: newScreensEnv with extra plugins, seedAdmin,
  seedRole, login, isolateSuperusers, row snapshots and error decoders; the
  harness moved out of backend_screens_smoke_test.go and gained cleanup
- export_test.go: SuperuserLockKey for the last-superuser race
- TestAdministratorsSuperuserFlag (D-05) through the assembled handler
2026-10-22 11:54:48 +02:00
Jakub Zych
1aaa8a444c docs(phase-19.6.1): update tracking after wave 2 2026-10-22 11:46:16 +02:00
Jakub Zych
47db9666dd docs(19.6.1-02): complete SPA trigger and record permission locks plan 2026-10-22 11:45:07 +02:00
Jakub Zych
7091d09699 feat(19.6.1-02): field trigger and admin build
- fields.yaml trigger (action disable|hide, field, condition checked|unchecked) compiled to FormField.Trigger
- boot errors for malformed triggers, controlling fields that are not a switch or checkbox, and triggers in repeater rows, settings and relation forms
- Administrators permissions overrides are disabled while Superuser is on (D-06)
- SPA: trigger.ts (triggerState, applyTriggers), FORM_TRIGGER_NOTES, the trigger note in FormField, FormView tabs/banner/payload after triggers, PreviewView hide only
- regenerated admin OpenAPI and schema.d.ts; rebuilt modules/boardwalk/dist; docs and README
2026-10-22 11:43:58 +02:00
Jakub Zych
705f94d9e5 feat(19.6.1-02): per-record locked permission values
- cabana.PermissionRecordLock and the optional PermissionRecordLockProvider
- RecordMeta.PermissionLocks (meta.permissionLocks) on show and save responses, notes localized
- save rule: a record-locked code keeps its stored value, a differing present value is 403
- Roles lock code-declared grants (locked_by_code); Administrators lock every override on your own record (locked_self)
- SPA: FORM_PERMISSION_LOCKS, locked codes never sent, record-locked rows in the permission editor
- regenerated admin OpenAPI and schema.d.ts; docs and README
2026-10-22 11:29:25 +02:00
Jakub Zych
e2525d4956 docs(phase-19.6.1): update tracking after wave 1 2026-10-22 11:20:59 +02:00
Jakub Zych
3a772fabb1 docs(19.6.1-01): complete backend administrators server-side plan 2026-10-22 11:19:46 +02:00
Jakub Zych
653307de0c feat(19.6.1-01): Roles screen
- Settings -> System -> Roles (summercms.cabana.roles, backend.manage_roles,
  order 110): name, code slugged from the name, description, checkbox
  permission editor with the editor's ceiling
- system roles (is_system or code-declared grants) keep their code and
  cannot be deleted; a role any admin holds (deleted ones included) cannot
  be deleted, the refusal names the role and the count
- role codes unique among roles
2026-10-22 11:18:30 +02:00
Jakub Zych
530b02af9c feat(19.6.1-01): administrator lifecycle and last-superuser protection
- activate, deactivate and restore as record and bulk actions; delete is
  the soft delete through deleted_at, never a hard delete
- deleted admins listed and opened (unscoped), deleted/deactivated row
  states, Deleted filter (hide / only), preview status hint
- deactivate and delete bump tokens_valid_after; activate and restore do not
- self delete and self deactivate refused; outranking and last active
  superuser guarded on delete, deactivate and bulk rows (whole selection
  rolls back)
2026-10-22 11:13:26 +02:00
Jakub Zych
88401737c9 feat(19.6.1-01): administrator form with server-side privilege rules
- create and edit administrators: password (min 4, max 72 bytes, bcrypt
  at admin.password.bcrypt_cost), role picker, radio permission overrides,
  superuser switch; no mail on create
- superusers hidden from non-superusers in list, lookups and schemas;
  is_superuser projected to superusers so an untouched save keeps it
- save-path rules: superuser-only switch, role and permission ceilings,
  no outranking, no own role/flag/overrides/password change, last active
  superuser not demoted (advisory lock + count in the write tx)
- password set for another admin bumps tokens_valid_after
- role, superuser, activation and last sign-in list filters
2026-10-22 11:08:12 +02:00
Jakub Zych
7340241f22 feat(19.6.1-01): Administrators screen and cross-controller record actions
- pact.HasAdminActionExtensions / AdminActionExtension: plugins add record
  actions to any admin controller by ID, merged at boot before permission
  validation (unknown target, no preview, duplicate name stop the boot)
- internal summercms.cabana pseudo-plugin, appended only when some plugin
  registers admin controllers: Administrators list and preview, settings
  link under System, backend.manage_users and backend.manage_roles with no
  role grants
- backend::lang user, user.role and permissions copy (en, pl)
- smoke tests: compile-time seam and settings, Postgres list/preview/action
2026-10-22 10:59:23 +02:00
Jakub Zych
88ec4df2b3 docs(todo): user logout fix released in sm-user-plugin v0.1.8 2026-10-22 10:45:14 +02:00
245 changed files with 29163 additions and 215 deletions

View File

@@ -67,6 +67,10 @@ Validated in Phase 19.5: Social login
- [x] The new sm-sociallogin-plugin signs users in with Google, GitHub, Microsoft and Facebook through PHP's `/oauth/{provider}` paths, with a provider registry other plugins extend, the SPA one-time-code handoff, the pending-registration branch and linking through a one-time link ticket; a verified email auto-links only onto an account that proved its address (`users.email_verified_at` in sm-user-plugin, a deliberate divergence from PHP); `scripts/check-phase19.5.sh` is the fail-closed gate (UAT and security 2026-10-21). The email-proof fix (sm-user-plugin v0.1.5, sm-sociallogin-plugin v0.1.2) is released with the 19.8 release
Validated in Phase 19.6.1: Backend Administrators screen
- [x] Backend admin users and roles are managed in the admin SPA (Settings → System), WinterCMS-style, with `backend.manage_users` / `backend.manage_roles`, server-side privilege rules (superuser-only flag, ceilings, self-edit, outranking, last-superuser lock) and a generic record-action seam; `scripts/check-phase19.6.1.sh` is the fail-closed gate (UAT 26/26 and security 33/33 closed, 2026-10-22)
### Active
Framework kernel
@@ -95,7 +99,7 @@ Background and integrations
Admin
- [ ] Backend admin users with roles, separate from frontend users, as in WinterCMS
- (backend admin users and roles — moved to Validated in Phase 19.6.1)
- [ ] `fields.yaml` and `columns.yaml` parsed (goccy/go-yaml) into a JSON form and list schema served per controller, with the field types Płytarium actually uses (text, textarea, checkbox, switch, dropdown with model-method options, relation with nameFrom/emptyOption) plus layout hints (span, tabs, context, attributes), and a first-class relation-manager schema replacing the one `partial` field
- [ ] A minimal Vue 3 + TypeScript admin SPA that renders those schemas as lists and forms for the five Płytarium controllers (Albums, Artists, Collections, Genres, Styles), with types generated from the API's OpenAPI document
@@ -187,6 +191,7 @@ Validated in Phase 18.1: Payment Gateway Subscriptions
| A soft (optional) plugin dependency still requires the provider module in `go.mod`; only `Requires()` omits it | A typed `Lookup` needs the package that declares the interface; optional means "skipped at Boot when absent", not "not compiled in" (`docs/plugins/extending.md`) | ✓ Good (Phase 19.1 UAT override, 2026-10-18) |
| OIDC on wristband with golang-jwt v5, not zitadel/oidc (Phase 19.4, `notes/2026-10-19-oidc-on-wristband-golang-jwt.md`) | wristband already owned the OAuth flows and PHP-compatible encoding; zitadel's own storage and routing would fight both. go-oidc and x/oauth2 are test-only, for relying-party interop | ✓ Good (Phase 19.4 UAT, 2026-10-20) |
| PHP OIDC parity is recorded at the WavePath cutover, not in Phase 19.4 (D-14 amended) | The harness ships and replays Go-side; recording needs the live PHP site, and WavePath's provider must not move until the replay is green | — Pending (todo `2026-10-19-record-php-oidc-parity-against-wavepath`) |
| Administrators and Roles live in cabana as an internal pseudo-plugin; privilege rules run in the save transaction; contributed Administrators Runs are wrapped with `guardOutranked` | WinterCMS screens were missing and 19.7 needs the record-action seam; a delegated editor must not outrank the target or capture a code-declared role | ✓ Good (Phase 19.6.1 UAT 26/26, 2026-10-22) |
## Evolution
@@ -206,4 +211,4 @@ This document evolves at phase transitions and milestone boundaries.
4. Update Context with current state
---
*Last updated: 2026-10-21 after Phase 19.5 completion*
*Last updated: 2026-10-22 after Phase 19.6.1 completion*

View File

@@ -41,7 +41,7 @@ Decimal phases appear between their surrounding integers in numeric order.
- [ ] **Phase 19.4.1: Early public demo on demo.summercms.io** - sm-demo-app with today's shared plugins on rome: open registration, guided tour, journal, bm's presentation system, quizzes, payments; backend by request
- [x] **Phase 19.5: Social login in sm-user-plugin** - Google and Facebook login with the SPA one-time-code handoff (completed 2026-10-21)
- [ ] **Phase 19.6: Two-factor auth and device flow in sm-user-plugin** - TOTP, WebAuthn, email and recovery codes, trusted devices, device authorization
- [ ] **Phase 19.6.1: Backend Administrators screen** - Admins and roles CRUD in cabana, WinterCMS-style, with server-side privilege rules
- [x] **Phase 19.6.1: Backend Administrators screen** - Admins and roles CRUD in cabana, WinterCMS-style, with server-side privilege rules (completed 2026-10-22)
- [ ] **Phase 19.7: Generic MCP module** - Opt-in MCP endpoint, plugin-declared tools filtered by permissions, one connector per person via OAuth and a verified account link
- [ ] **Phase 19.8: Console commands overhaul** - `diary` logging module, Artisan-grade global flags, help and `list` in `bonfire`, sweep of every command
- [ ] **Phase 20: Demo instance with every shared plugin** - Add the chat family (chat, channels, video calls, chatbots, forum, herald, friends) to the live demo from Phase 19.4.1
@@ -1423,17 +1423,22 @@ Plans:
2. Privilege rules hold on the server: only a superuser can create, edit or grant superuser; an admin cannot raise their own role or permissions; the last active superuser cannot be deactivated, demoted or deleted.
3. The record-action seam on the Administrators list is usable by plugins (19.7's link action), and unit tests cover the privilege rules.
**Plans:** 3 plans
**Plans:** 5/5 plans complete
Plans:
- [x] 19.6.1-05-PLAN.md
**Wave 1**
- [ ] 19.6.1-01-PLAN.md — server side: the pact action-extension seam, the internal summercms.cabana pseudo-plugin with the Administrators and Roles screens, every privilege rule in the save transaction (superuser hiding, ceilings, self-edit, outranking, last-superuser lock, revocation), lang keys and docs
- [x] 19.6.1-01-PLAN.md — server side: the pact action-extension seam, the internal summercms.cabana pseudo-plugin with the Administrators and Roles screens, every privilege rule in the save transaction (superuser hiding, ceilings, self-edit, outranking, last-superuser lock, revocation), lang keys and docs
**Wave 2** *(blocked on Wave 1 completion)*
- [ ] 19.6.1-02-PLAN.md — SPA support (D-21): per-record locked permission values and the field `trigger`, regenerated OpenAPI and schema.d.ts, rebuilt modules/boardwalk/dist
- [x] 19.6.1-02-PLAN.md — SPA support (D-21): per-record locked permission values and the field `trigger`, regenerated OpenAPI and schema.d.ts, rebuilt modules/boardwalk/dist
**Wave 3** *(blocked on Wave 2 completion)*
- [ ] 19.6.1-03-PLAN.md — unit, Postgres and SPA tests for every rule (incl. the held-lock last-superuser race), the seam and D-21, plus the check-phase19.6.1.sh gate
- [x] 19.6.1-03-PLAN.md — unit, Postgres and SPA tests for every rule (incl. the held-lock last-superuser race), the seam and D-21, plus the check-phase19.6.1.sh gate
**Wave 4** *(gap closure)*
- [x] 19.6.1-04-PLAN.md — close CR-01 (role-code capture onto code-declared grants) and WR-03 (wrap contributed Administrators actions with guardOutranked)
### Phase 19.7: Generic MCP module (INSERTED)
@@ -1449,10 +1454,23 @@ Plans:
3. `tools/list` lists only the tools the session's principals may call (frontend permissions through the merged group/user permissions, backend permissions and token scope through cabana), and a call runs through the route's own middleware.
4. An editor signs in once through `wristband` OAuth as a frontend user; with a verified link to a backend user, backend-guarded tools such as Journal's run as that admin, and removing the link or the grant removes them. The phase gets a security review; the MCP SDK dependency has a decision note before code lands; unit tests are the last plan.
**Plans:** 0 plans
**Plans:** 2/5 plans executed
Plans:
- [ ] TBD (run /msd-plan-phase 19.7 to break down)
**Wave 1**
- [x] 19.7-01-PLAN.md — Framework seams: bouncer dispatch marker, surf handler lookup and streaming routes, tagged pier mount hook, SDK-free pact MCP contracts, My account contribution seam, prompted record action, wristband scope set
**Wave 2** *(blocked on Wave 1 completion)*
- [x] 19.7-02-PLAN.md — The `pier` module behind `summercms_mcp` (go-sdk, hybrid stateful/stateless, Redis sessions, fan-out, PRM) and the framework release carrying 19.6.1 + 19.7-01/02
**Wave 3** *(blocked on Wave 2 completion)*
- [ ] 19.7-03-PLAN.md — sm-user-plugin: verified account link, Administrators-screen link actions, plugin frontend permission codes, the `user` MCP guard and `user_me` tool, plugin release and app pointer bumps
**Wave 4** *(blocked on Wave 3 completion)*
- [ ] 19.7-04-PLAN.md — sm-oauthserver-plugin `backend` scope, `oas_at_` verifier and MCP consent JSON; Journal tools; vue-demo-app `/connect` and `/link-admin`; sm-demo-app wiring, e2e and deploy notes; plugin releases
**Wave 5** *(blocked on Wave 4 completion)*
- [ ] 19.7-05-PLAN.md — Unit tests across six repos, `scripts/check-phase19.7.sh`, the filled validation map and the security review
### Phase 19.8: Console commands overhaul (INSERTED)
@@ -1588,8 +1606,8 @@ Phases execute in numeric order: 1 → 2 → 3 → 4 → 5 → 6 → 7 → 8 →
| 19.4.1. Early public demo on demo.summercms.io | 5/5 | In Progress| |
| 19.5. Social login in sm-user-plugin | 5/5 | Complete | 2026-10-21 |
| 19.6. Two-factor auth and device flow in sm-user-plugin | 0/TBD | Not started | - |
| 19.6.1. Backend Administrators screen (INSERTED) | 0/TBD | Not started | - |
| 19.7. Generic MCP module | 0/TBD | Not started | - |
| 19.6.1. Backend Administrators screen (INSERTED) | 5/5 | Complete | 2026-10-22 |
| 19.7. Generic MCP module | 2/5 | In Progress| |
| 19.8. Console commands overhaul (INSERTED) | 6/6 | In Progress| |
| 20. Demo instance with every shared plugin | 0/TBD | Not started | - |
| 30. Płytarium cutover | 0/TBD | Not started | - |

View File

@@ -1,19 +1,19 @@
---
msd_state_version: "1.0"
milestone: v1.0
current_phase: 19.4.1
current_phase_name: Early public demo on demo.summercms.io
status: Ready for verification — 6/6 plans executed, UAT in progress (19.3-UAT.md)
stopped_at: Phase 19.4.1 context gathered
last_updated: "2026-10-20T01:33:22.399Z"
last_activity: 2026-10-20
last_activity_desc: "Completed quick task 261020-42e: branded HTML error pages for browsers"
state_head: 2b5f0b2c92e0bc38070c7f4a8870f64e2c430bb8
current_phase: "19.7"
current_phase_name: Generic MCP module (INSERTED)
status: executing
stopped_at: Completed 19.7-02-PLAN.md
last_updated: "2026-10-22T22:22:58.311Z"
last_activity: 2026-10-23
last_activity_desc: "Completed quick task 261022-x7a: user-plugin golem15.user.password.public_routes switch (login/forgot/reset 404 when false)"
state_head: a26ee2b72d5b99db7596217ce1c3da7ec0c6bf89
progress:
total_phases: 43
completed_phases: 35
total_plans: 217
completed_plans: 208
total_phases: 45
completed_phases: 37
total_plans: 238
completed_plans: 231
gsd_state_version: "1.0"
milestone_name: milestone
---
@@ -22,25 +22,25 @@ milestone_name: milestone
## Project Reference
See: .planning/PROJECT.md (updated 2026-10-12)
See: .planning/PROJECT.md (updated 2026-10-22)
**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 19.3 — Framework transport and infrastructure for WavePath (UAT in progress)
**Current focus:** Phase 19.7 — Generic MCP module (INSERTED)
## Current Position
Phase: 19.4.1 (Early public demo on demo.summercms.io) — READY TO EXECUTE
Plan: 6 of 6
Status: Ready for verification — 6/6 plans executed, UAT in progress (19.3-UAT.md)
Last activity: 2026-10-20 - Completed quick task 261020-42e: branded HTML error pages for browsers
Phase: 19.7 (Generic MCP module (INSERTED)) — EXECUTING
Plan: 3 of 5
Status: Ready to execute
Last activity: 2026-10-23 — Completed quick task 261022-x7a: user-plugin golem15.user.password.public_routes switch (login/forgot/reset 404 when false)
Progress: [████████░░] 83%
Progress: [████████░░] 82%
## Performance Metrics
**Velocity:**
- Total plans completed: 105
- Total plans completed: 115
- Average duration: 21 min
- Total execution time: 104 min
@@ -66,6 +66,8 @@ Progress: [████████░░] 83%
| 19 | 7 | - | - |
| 19.1 | 6 | - | - |
| 19.4 | 4 | - | - |
| 19.5 | 5 | - | - |
| 19.6.1 | 5 | - | - |
**Recent Trend:**
@@ -263,6 +265,19 @@ Progress: [████████░░] 83%
| Phase 19.4 P02 | 50min | 5 tasks | 54 files |
| Phase 19.4 P03 | 71 min | 7 tasks | 61 files |
| Phase 19.4 P04 | 65 min | 5 tasks | 42 files |
| Phase 19.4.1 P01 | 70min | 4 tasks | 24 files |
| Phase 19.4.1 P02 | ~2h45m | 7 tasks | 43 files |
| Phase 19.4.1 P03 | ~1h50m | 8 tasks | 58 files |
| Phase 19.4.1 P04 | 2h25m | 7 tasks | 85 files |
| Phase 19.4.1 P05 | 70min | 7 tasks | 46 files |
| Phase 19.8 P01 | 30 min | 3 tasks | 86 files |
| Phase 19.8 P02 | 28 min | 3 tasks | 38 files |
| Phase 19.8 P03 | 3h 3m (segment B) | 8 tasks | 120 files |
| Phase 19.8 P05 | 40min | 7 tasks | 33 files |
| Phase 19.6.1 P04 | 18 min | 3 tasks | 10 files |
| Phase 19.6.1 P05 | 4 min | 2 tasks | 7 files |
| Phase 19.7 P01 | 52 min | 5 tasks | 64 files |
| Phase 19.7 P02 | 38 min | 4 tasks | 36 files |
## Accumulated Context
@@ -297,6 +312,8 @@ Progress: [████████░░] 83%
- Phase 19.7 inserted after Phase 19.6: Generic MCP module: opt-in endpoint, plugin-declared tools, one connector per person (from /msd-explore 2026-10-17)
- Phase 20 reordered: Roadmap reordered (/msd-explore 2026-10-18): new Phase 20 Demo instance with every shared plugin; Płytarium cutover moved 20 → 30; Chat polish against WavePath clients moved 19.2 → 31; 21–29 added as their goals firm up
- Phase 19.4.1 inserted after Phase 19.4: Early public demo on demo.summercms.io: today's 16 shared plugins on rome, demo accounts, journal/presentations/quizzes/OIDC pages, backend by request; Phase 20 narrows to the chat family (URGENT)
- Phase 32 added: Console commands overhaul: diary logging module, bonfire global flags and Artisan-grade help, sweep of all commands, tests
- Phase 19.6.1 inserted after Phase 19.6: Backend Administrators screen: admins and roles CRUD in cabana (gap found while planning 19.7: no screen to manage backend users or set the frontend link) (URGENT)
### Decisions
@@ -893,6 +910,46 @@ Recent decisions affecting current work:
- [Phase 19.4]: Phase gate stages split by Docker need; the application's unrelated admin route test stays outside the gate (deferred-items)
- [Phase 19.4]: PHP method map: 171 methods, 146 ported, 25 adapted with reasons, none not-applicable
- [Phase 19.4]: Parity NOT RUN points to the WavePath cutover todo and does not hold the verdict (D-14 amended); PHASE194_REQUIRE_PARITY=1 fails
- [Phase 19.4.1]: Roadmap decks use the new summer deck theme (summercms.io look: navy, sun yellow, Roboto), chosen at the deck review; fonts vendored from the summercms.io build in sm-bm-app, no new npm dependency
- [Phase 19.4.1]: golem15.presentations gets summer as an additive theme option; plan 04 must port summer.css and accept summer in the demo deck API
- [Phase 19.4.1]: Admin public at https://demo.summercms.io/smbackend, login required, /backend 404 (user, 2026-10-20). Replaces the phase goal's and D-04's 'admin backend stays private'. Plans 03-05 recheck: plan 03 CTA/contact form wording, CONTEXT deployment note, threat row T-19.4.1-06 (new mitigation: login required, credentials on request, 5/min login throttle per real IP via Cloudflare real-IP, then 429), seeded FAQ 'The admin is private on this demo' (seed.go and the live row). — The user asked for the admin at the Task 7 review of the first live release; the throttle was checked live behind Cloudflare.
- [Phase 19.4.1]: The 'Want to see the backend? Contact Golem15' CTA stays a contact CTA and does not link to /smbackend (user, 2026-10-20). The admin URL is public, its credentials are not; Golem15 hands them out on request. Plan 03's contact form (D-04) still applies; only its wording and the threat model change. — Resolves the open question raised by the /smbackend decision.
- [Phase 19.4.1]: Plugin release tags for the demo: paymentgateway v0.1.0; sitemap, menu, faq, oauthserver v0.1.0; pgsub v0.1.2 and pgstripe v0.1.2 re-tagged on paymentgateway v0.1.0; translate v0.1.2 and presentations v0.1.1. sm-demo-app go.mod requires tags only (summercms v0.3.0), no replace; release builds use GOWORK=off. — D-03; tags confirmed with git ls-remote after each push.
- [Phase 19.4.1]: 19.4.1-03: tags sm-user-plugin v0.1.3 (7b9faa3) and sm-journal-plugin v0.2.1 (fe1bbc2); sm-demo-app requires both, other apps' pins untouched; Phase 19.5 takes the next free sm-user-plugin tag
- [Phase 19.4.1]: 19.4.1-03: Turnstile is opt-in in the core user plugin (golem15.user.turnstile, empty default adds nothing, open|closed on /login and /register only, invalid value fails boot); the demo sets closed
- [Phase 19.4.1]: 19.4.1-04: the demo runs its own Centrifugo v6.5.1 on rome (127.0.0.1:8010, /usr/local/bin/centrifugo, supervisor summercms-demo-centrifugo) with its own secrets; nothing shared with bm (D-17). Assumption A3 held: static_headers under channel.proxy.subscribe.http is accepted.
- [Phase 19.4.1]: 19.4.1-04: logged in, the home page's Presentations card and a header link go to My presentations (/presentations); logged out the card goes straight to the deck of the language. SSR reads the session cookie, so server and hydrated links agree.
- [Phase 19.4.1]: 19.4.1-04: on a computer the remote opens in a 390x844 named popup (speaker view Open remote, My presentations Remote); opened without noopener to detect blocking, opener cut at once; blocked popups fall back to a tab; phones open it in place. No QR code exists (would need an approved package).
- [Phase 19.4.1]: 19.4.1-04: the demo deck API refuses edits to a published deck (403), keeping the seeded roadmap decks intact.
- [Phase 19.4.1]: Phase 19.4.1 database tests boot the whole demo on a fresh database cloned from a migrated template per plugin list (internal/demotest, one postgres:15 container per test binary)
- [Phase 19.4.1]: bm's frontend library tests run byte-identical in vue-demo-app under vitest 3.2.7; aliases map bm's @/api, @/deck and ../../deck/ layout
- [Phase 19.4.1]: sm-demo-app scripts/check-all.sh is the phase gate: every suite, the release build, pin/deploy/smoke checks, local browser checks when the stack is up, and check-live
- [Phase 19.8]: Charm v2 stack on charm.land paths (decision note 2026-10-21-console-charm-stack.md); plan 19.8-01 installed lipgloss v2.0.6 and colorprofile v0.4.3 only
- [Phase 19.8]: diary owns the process logger: config/log.yaml channels (console, stderr, daily, stack, null), per-component levels, sunscreen on every leaf, daily files on by default (storage/logs, 14 days)
- [Phase 19.8]: wristband and bouncer now import diary for their log lines, amending their dependency-free leaf status (confirmed by the user 2026-10-21: diary is the one allowed framework import, and wristband is required to use it)
- [Phase 19.8]: 19.8-02: bonfire.NewRoot sends the error block to stderr when its output is os.Stdout; Output.Error keeps its stream, so no command output moves
- [Phase 19.8]: 19.8-02: bonfire.Execute resets persistent flags per run and routes a call without a command word (globals, -h, --help) to the Artisan list; fang runs without version, man page and completions
- [Phase 19.8]: 19.8-02: --no-ansi on an interactive terminal uses the plain line prompts (no huh, no selector); -n and -q return prompt defaults; ConfirmProceed never asks off an interactive terminal
- [Phase 19.8]: 19.8-02: one live view at a time; output and diary log lines printed while it runs go above it via bonfire.PrintAbove (Program.Send, safe after the program ends)
- [Phase 19.8]: 19.8-02: builtin list and help carry Long and Examples so the framework CheckDocs test in plan 3 covers them
- [Phase 19.8]: 19.8-03: SummerCMS v0.4.0 tagged at 99b6df4 and pushed with its changelog post; commits other sessions made during the run stay local
- [Phase 19.8]: 19.8-03: the ten plugins applications mount got patch tags (user v0.1.6, journal v0.2.2, pgstripe v0.1.3, the rest v0.1.1) because sm-demo-app refuses pseudo-version pins
- [Phase 19.8]: 19.8-03: chat and forum require sm-user-plugin v0.1.2 (classes.DeletingEvent); plugins log through a package-level pluginLog = diary.For(code)
- [Phase 19.8]: 19.8-05: CR-01 prints above live views by sending tea.Println messages straight to the program queue under liveMu; unregister/finish/wait as one locked, deferred step
- [Phase 19.8]: 19.8-05: WR-01 handled inside runLive (relay SIGINT/SIGTERM while a view runs, Kill, re-raise); generated main unchanged
- [Phase 19.8]: 19.8-05: CR-02 uses the additive bonfire.WithExitCode carrier; CR-03 delegates get os.Stdout/os.Stderr on a terminal, stderr kept apart otherwise
- [Phase 19.8]: 19.8-05: dev.ShutdownGrace (15s) shared by summer dev and delegates; daily files retry after a minute or on a new date; replaced daily writers are retired
- [Phase 19.8]: 19.8-05: bonfire.Sanitize (additive) replaces diary's sanitizer; Migrate iterates migrationSets
- [Phase 19.6.1]: Roles create and update refuse any new code that rolePermissions attaches grants to, including when the editor is a superuser — D-16 stricter reading from the gap contract: a role never becomes a code-declared system role through the Roles screen
- [Phase 19.6.1]: cabana wraps contributed Administrators Runs; guardOutranked stays unexported and contributors do not own the check — D-19 gap contract: wrap in cabana so a contribution to summercms.cabana.users cannot skip outranking
- [Phase 19.6.1]: Persist picked relation labels on the form via FORM_REMEMBER_LABEL; keep the one-panel FormGrid (do not v-show inactive tabs) — UAT G-19.6.1-T2 is labeling only; v-show of inactive tabs would change trigger hide-tab, ML locale reset, and field mount cost
- [Phase 19.6.1]: Administrators and Roles are cabana screens behind backend.manage_users / backend.manage_roles with no default role grant; privilege rules run in the save tx; last-superuser uses pg_advisory_xact_lock; contributed Administrators Runs are wrapped with guardOutranked.
- [Phase 19.7]: 19.7-01: planner decisions P-01..P-04 implemented: bouncer.Dispatch context-only marker honoured by Registry.Middleware and cabana.ResolveBackend; account contributions as pact.HasAccountContributions; prompted record actions post payload as a JSON string; pact MCP types carry the principal as any and stay SDK-free
- [Phase 19.7]: 19.7-01: wristband authorize allow-list is exactly Options.ScopesSupported (empty keeps the PHP default); surf stream routes recover with an opaque 500 only before the first byte; account contribution Run runs without a transaction only when no database is published
- [Phase 19.7]: Framework release is v0.5.0 (19.7-02 Task 5), carrying 19.6.1, 19.7 plans 01-02 and a set of 7 msd-quick patches; tag only after all 7 are committed — User decision 2026-10-22: minor bump for the new pier module and pact capabilities; hold the tag until the quick patches land
- [Phase 19.7]: v0.5.0 is tagged only when phase 19.7 is fully complete (plans 01-05 and phase verification); supersedes the earlier 19.7-02 Task 5 entry. Plan 02 closes without a tag; no intermediate framework tag for 19.7 work — User decision 2026-10-23: a minor version marks the finished MCP phase, not a partial one
- [Phase 19.7]: Once the user confirms all in-flight msd-quick tasks are finished: release the framework as the next v0.4.x patch (carrying the quick patches and 19.7 work so far) and tag the held user-plugin fixes; plugins may be tagged mid-phase. Framework v0.5.0 stays reserved for full MCP usability at phase 19.7 completion — User decision 2026-10-23: plugins can be tagged now, framework 0.5 means the MCP phase is finished; wait for the user's word that the last quick agent is done
- [Phase 19.7]: 19.7-02: pier serves 2025-11-25 clients through its own session router over StreamableServerTransport (Redis-shared sessions, D-25) and 2026-07-28 clients through the SDK stateless handler; plan 02 closed without a tag, pier ships opt-in in v0.4.4 (summercms_mcp tag plus mcp.enabled, default off)
### Pending Todos
@@ -903,22 +960,31 @@ Recent decisions affecting current work:
- [unknown] [sm-user-plugin / cabana] Verified link between a frontend user and a backend user — [todo file](.planning/todos/pending/2026-10-17-frontend-backend-account-link.md)
- [unknown] [sm-user-plugin / pact] Plugins register their frontend permission codes in Go — [todo file](.planning/todos/pending/2026-10-17-plugin-registered-frontend-permissions.md)
- [2026-10-19] [sm-oauthserver-plugin] Record PHP OIDC parity against WavePath before the OIDC cutover — [todo file](.planning/todos/pending/2026-10-19-record-php-oidc-parity-against-wavepath.md)
- [2026-10-20] [consumers] Move grzybyfunkcjonalne to NUXT_CACHE_PURGE_TOKEN and the new layers before the NUXT_SITE_CACHE_* names are dropped — [todo file](.planning/todos/pending/2026-10-20-rename-site-cache-purge-env-in-consumers.md)
- [2026-10-21] [framework] Quiet plugin boot logs on console commands like --help — [todo file](.planning/todos/pending/2026-10-21-quiet-plugin-boot-logs-on-console-commands.md) — Needs TBD. Options, possibly combined:.
- [2026-10-22] [framework] Console review info findings (IN-01..IN-13) and the delegate signal exit code — [todo file](.planning/todos/pending/2026-10-22-console-review-info-findings.md)
- [2026-10-22] [sm-user-plugin] User login ignores is_activated — [todo file](.planning/todos/pending/2026-10-22-user-login-ignores-is-activated.md)
- [2026-10-22] [sm-user-plugin] User login lockout and same-second cutoff — [todo file](.planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md)
- [2026-10-22] [sm-user-plugin] User login opt-in session cookie — [todo file](.planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md)
- [2026-10-22] [sm-user-plugin] User logout blacklist missing under serve — [todo file](.planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md)
- [2026-10-22] [user-plugin] User plugin logout leaves the session cookie valid for up to 60 minutes — [todo file](.planning/todos/pending/2026-10-22-user-logout-cookie-stays-valid.md)
- [2026-10-22] [sm-user-plugin] User password routes 404 switch — [todo file](.planning/todos/pending/2026-10-22-user-password-routes-404-switch.md)
- [2026-10-22] [sm-user-plugin] User session routes ignore the cookie — [todo file](.planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md)
- [unknown] [cabana / admin] Audit-log admin action runs with the admin id (toolbar actions) — [todo file](.planning/todos/pending/admin-action-audit-log.md)
- [unknown] [summercms.go bonfire] Reject duplicate console command names in bonfire.NewRoot — [todo file](.planning/todos/pending/bonfire-duplicate-command-names.md)
- [unknown] [sm-faq-plugin] Port the FAQ plugin as sm-faq-plugin so FAQs become editable — [todo file](.planning/todos/pending/faq-plugin-port.md)
- [2026-10-09] [plugins] Expose author subtitle, description and avatar on the Journal author API — [todo file](.planning/todos/pending/journal-author-profile-fields.md)
- [unknown] [summercms.go lagoon] lagoon README registers an after-commit GORM callback that can sort after the flush — [todo file](.planning/todos/pending/lagoon-readme-after-commit-callback-order.md)
- [unknown] [sm-user-plugin mail] Port MailBlocker and the block-mail checkbox with the mailing work — [todo file](.planning/todos/pending/mailblocker-with-mailing.md)
- [unknown] [sm-menu-plugin] Port the menu plugin as sm-menu-plugin so blog menus become editable — [todo file](.planning/todos/pending/menu-plugin-port.md)
- [2026-10-21] [sm-user-plugin] Let password-less social accounts set a first password through change-password — [todo file](.planning/todos/pending/oauth-password-bootstrap-change-password.md)
- [unknown] [summercms.go/modules/*/README.md, internal/docsite] Convert module README Go code blocks to compiled src= references — [todo file](.planning/todos/pending/readme-go-fences-src.md)
- [unknown] [../fonoteka.go/README.md] Refresh fonoteka.go README — short status plus migrate/serve/login — [todo file](.planning/todos/pending/refresh-fonoteka-readme.md)
- [unknown] [cabana] Show the administrators holding a role on the Roles screen — [todo file](.planning/todos/pending/roles-screen-holders-list.md)
- [unknown] [summercms.go internal/build] make:admin-controller output does not boot and names the model after the controller — [todo file](.planning/todos/pending/scaffold-admin-controller-incomplete.md)
- [unknown] [summercms.go internal/build] Scaffolded files carry a DO NOT EDIT header, and make:command cannot reach the application — [todo file](.planning/todos/pending/scaffold-generated-header-and-command-deps.md)
- [unknown] [summercms.go internal/build] make:model and make:migration in the same second produce migrations that run out of order — [todo file](.planning/todos/pending/scaffold-same-second-migration-order.md)
- [2026-10-12] [framework] Purge the Nuxt site cache on menu and FAQ admin saves (framework-level purge service) — [todo file](.planning/todos/pending/site-cache-purge-for-menu-and-faq.md)
- [unknown] [sm-sitemap-plugin] Port the sitemap plugin 1:1 as sm-sitemap-plugin for the next blog project — [todo file](.planning/todos/pending/sitemap-plugin-port.md)
- [unknown] [sm-sitemap-plugin] Sitemap - replace the browser XSLT view before Chromium drops XSLT — [todo file](.planning/todos/pending/sitemap-xslt-browser-deprecation.md)
- [unknown] [sm-user-plugin] Let the sm-user-plugin console commands open their own database — [todo file](.planning/todos/pending/user-plugin-commands-open-database.md)
### Blockers/Concerns
@@ -979,6 +1045,15 @@ Recent decisions affecting current work:
| 261019-hgw | Translate hook ValidationError phrase keys in the request locale | 2026-10-19 | ce8d7ef | [261019-hgw-translate-hook-validationerror-phrase-ke](./quick/261019-hgw-translate-hook-validationerror-phrase-ke/) |
| 261020-13e | Admin image previews of public files fall back to the authenticated thumb route | 2026-10-19 | 1ab7db4 | [261020-13e-admin-file-upload-widget-image-preview-a](./quick/261020-13e-admin-file-upload-widget-image-preview-a/) |
| 261020-42e | branded HTML error pages for browsers | 2026-10-20 | a34c251 | [261020-42e-branded-html-error-pages-for-browsers-un](./quick/261020-42e-branded-html-error-pages-for-browsers-un/) |
| 261020-sdt | Rotate the site-cache purge token and rename the layer variable (demo + summercms.io) | 2026-10-20 | 4270d05 | [261020-sdt-rotate-the-purge-token-and-rename-the-la](./quick/261020-sdt-rotate-the-purge-token-and-rename-the-la/) |
| 261022-4z8 | Fix the open 19.8 re-review findings (WR-09..WR-14, IN-14, IN-15) | 2026-10-22 | b1fba7e | [261022-4z8-fix-the-open-19-8-re-review-findings-wr-](./quick/261022-4z8-fix-the-open-19-8-re-review-findings-wr-/) |
| 261022-k9k | Admin keyboard shortcuts: Ctrl+S, Ctrl+Enter, Ctrl+Shift+S (Create and new), / search, Esc, ? help | 2026-10-22 | 604fee7 | [261022-k9k-keyboard-shortcuts-in-the-admin-spa-ctrl](./quick/261022-k9k-keyboard-shortcuts-in-the-admin-spa-ctrl/) |
| 261022-tb4 | Password /login refuses a not-activated account while require_activation is on (sm-user-plugin 15ff979, unreleased: hold until the escalation batch lands) | 2026-10-22 | 15ff979 (sm-user-plugin) | [261022-tb4-password-login-must-refuse-is-activated-](./quick/261022-tb4-password-login-must-refuse-is-activated-/) |
| 261022-tto | User plugin /fetch, /refresh, /update, /change-password accept token/auth_token session cookies (sm-user-plugin 8e4b863, ships v0.5.0) | 2026-10-22 | 8e4b863 (sm-user-plugin) | [261022-tto-fetch-refresh-update-change-password-mus](./quick/261022-tto-fetch-refresh-update-change-password-mus/) |
| 261022-usi | User plugin jwt blacklist and GORM hooks wired via lagoon.OnDatabase so logout revokes under serve; jwt guard uses SessionCookieNames (sm-user-plugin 4bf44fc, ships v0.5.0) | 2026-10-22 | 4bf44fc (sm-user-plugin) | [261022-usi-user-plugin-jwt-blacklist-and-hooks-wire](./quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/) |
| 261022-vfz | User plugin /login throttle keyed on surf.ClientIP (trusted proxies); reset-password and admin password set stamp tokens_valid_after in whole seconds (sm-user-plugin b6f8055, a484d0e, ships v0.5.0; verified) | 2026-10-22 | b6f8055, a484d0e (sm-user-plugin) | [261022-vfz-user-plugin-login-throttle-via-surf-clie](./quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/) |
| 261022-wah | User plugin opt-in golem15.user.jwt.token_cookie (default off) sets the HttpOnly auth.cookie session cookie on /login, /register and /activate-by-code instead of the body token; a /refresh carried by the auth.cookie cookie rewrites it (sm-user-plugin 846087d, 8bdf2c7, ships v0.5.0; verified) | 2026-10-22 | 846087d, 8bdf2c7 (sm-user-plugin) | [261022-wah-opt-in-httponly-session-cookie-on-user-p](./quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/) |
| 261022-x7a | User plugin golem15.user.password.public_routes (default true): false leaves POST /login, /forgot-password and /reset-password unregistered so they 404 like unknown paths; /register and the rest unchanged (sm-user-plugin 3828a65, ships v0.5.0; verified) | 2026-10-22 | e5dd457 | [261022-x7a-user-plugin-golem15-user-password-public](./quick/261022-x7a-user-plugin-golem15-user-password-public/) |
## Deferred Items
@@ -990,6 +1065,6 @@ Items acknowledged and carried forward from previous milestone close:
## Session Continuity
Last session: 2026-10-20T00:18:01.483Z
Stopped at: Phase 19.4.1 context gathered
Resume file: .planning/phases/19.4.1-early-public-demo-on-demo-summercms-io/19.4.1-CONTEXT.md
Last session: 2026-10-22T22:22:57.128Z
Stopped at: Completed 19.7-02-PLAN.md
Resume file: None

View File

@@ -1,10 +1,10 @@
---
schema_version: 1
open_count: 16
open_count: 20
waived_count: 0
fixed_count: 7
total_count: 23
last_updated: 2026-10-18T13:42:55.096Z
total_count: 27
last_updated: 2026-10-22T14:44:56.679Z
---
# Broken Windows Ledger
@@ -38,6 +38,10 @@ last_updated: 2026-10-18T13:42:55.096Z
| 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 | |
| 22 | 19.1 | deviation | sm-forum-plugin/go.mod | | go.mod lists bluemonday and goldmark as // indirect via breakwater; no direct require | open | | 2026-10-18T13:42:54.900Z | |
| 23 | 19.1 | deviation | classes/lifecycle.go | | Task 4 methods besides DeleteContext live in classes/lifecycle.go | open | | 2026-10-18T13:42:55.096Z | |
| 24 | 19.7 | deviation | modules/cabana | | 19.7-01: capabilities_test field-count assertion updated 2->3 for AdminRecordActionInput.Value | open | | 2026-10-22T14:44:56.001Z | |
| 25 | 19.7 | deviation | modules/cabana | | 19.7-01: admin route inventories (phase09Routes, tokenRouteClasses, CSRF walk 35, phase10 want list, conformCases) extended for the two account contribution routes | open | | 2026-10-22T14:44:56.218Z | |
| 26 | 19.7 | deviation | modules/cabana | | 19.7-01: TestRecordActionPromptRun added on Postgres to prove Run receives the trimmed prompt value | open | | 2026-10-22T14:44:56.449Z | |
| 27 | 19.7 | unrun-verify | scripts/check-phase19.6.1.sh | | 19.7-01: check-phase19.6.1.sh --all stopped by the host (memory pressure) after the cabana and surf Postgres suites passed; re-run on the Docker host | open | | 2026-10-22T14:44:56.679Z | |
````json
[
@@ -339,6 +343,58 @@ last_updated: 2026-10-18T13:42:55.096Z
"recorded_at": "2026-10-18T13:42:55.096Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 24,
"kind": "deviation",
"phase": "19.7",
"file": "modules/cabana",
"line": null,
"description": "19.7-01: capabilities_test field-count assertion updated 2->3 for AdminRecordActionInput.Value",
"status": "open",
"reason": "",
"recorded_at": "2026-10-22T14:44:56.001Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 25,
"kind": "deviation",
"phase": "19.7",
"file": "modules/cabana",
"line": null,
"description": "19.7-01: admin route inventories (phase09Routes, tokenRouteClasses, CSRF walk 35, phase10 want list, conformCases) extended for the two account contribution routes",
"status": "open",
"reason": "",
"recorded_at": "2026-10-22T14:44:56.218Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 26,
"kind": "deviation",
"phase": "19.7",
"file": "modules/cabana",
"line": null,
"description": "19.7-01: TestRecordActionPromptRun added on Postgres to prove Run receives the trimmed prompt value",
"status": "open",
"reason": "",
"recorded_at": "2026-10-22T14:44:56.449Z",
"resolved_at": null,
"milestone": "v1.0"
},
{
"id": 27,
"kind": "unrun-verify",
"phase": "19.7",
"file": "scripts/check-phase19.6.1.sh",
"line": null,
"description": "19.7-01: check-phase19.6.1.sh --all stopped by the host (memory pressure) after the cabana and surf Postgres suites passed; re-run on the Docker host",
"status": "open",
"reason": "",
"recorded_at": "2026-10-22T14:44:56.679Z",
"resolved_at": null,
"milestone": "v1.0"
}
]
````

View File

@@ -0,0 +1,107 @@
---
title: External user-plugin escalations
date: 2026-10-22
context: /msd-explore of an external app's "escalate to summercms devs" list. Six /msd-quick tasks; send this reply when they are all done.
g15office: bhoyg8z4
---
# External user-plugin escalations
Reviewed 2026-10-22. The list is `golem15.user` (sm-user-plugin), not cabana admin auth. Phase 19.6 (2FA) is not mid-flight.
**Released (2026-10-23):** sm-user-plugin **v0.1.9** carries all six quicks and still requires SummerCMS v0.4.3, so the external app needs no framework upgrade for these fixes. The earlier hold for a v0.5.0 wave is withdrawn: v0.5.0 is reserved for the finished MCP phase (19.7), and the framework's own next patch is v0.4.4, which is not needed for anything below. The reply is ready to send.
**Do not run the six quicks in parallel on one working tree.** They share `sm-user-plugin` (`api_controller.go`, `plugin.go`, `routes.go`, README). Sequential fresh sessions.
## Tracker
| # | Their label | Verdict | Quick / todo | g15office | Status | Shipped |
|---|---|---|---|---|---|---|
| 1 | G2 login ignores `is_activated` | Fix | [261022-tb4](../quick/261022-tb4-password-login-must-refuse-is-activated-/) · [todo](../todos/done/2026-10-22-user-login-ignores-is-activated.md) | 3r4or1ex | released | `15ff979` → user v0.1.9 |
| 2 | G3 cookie-only 401 | Fix remaining four; logout already done | [261022-tto](../quick/261022-tto-fetch-refresh-update-change-password-mus/) · [todo](../todos/done/2026-10-22-user-session-routes-ignore-cookie.md) | kkknstxl | released | `8e4b863` → user v0.1.9 |
| 3 | G4 logout blacklist under `serve` | Fix | [261022-usi](../quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/) · [todo](../todos/done/2026-10-22-user-logout-blacklist-missing-under-serve.md) | ud0gficu | released | `4bf44fc` → user v0.1.9 |
| 4 | G6 `/update` email without proof | Decline | — | — | declined | n/a |
| 5 | G7 Users form has no role field | Decline | — | — | declined | n/a |
| 6 | G8 API token guard ignores `tokens_valid_after` | Decline | — | — | declined | n/a |
| 7 | Cookie option on `/login` | Feature | [261022-wah](../quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/) · [todo](../todos/done/2026-10-22-user-login-opt-in-session-cookie.md) | strnsccy | released | `846087d`, `8bdf2c7` → user v0.1.9 |
| 8 | Password-routes 404 switch | Feature | [261022-x7a](../quick/261022-x7a-user-plugin-golem15-user-password-public/) · [todo](../todos/done/2026-10-22-user-password-routes-404-switch.md) | h7yrafgd | released | `3828a65` → user v0.1.9 |
| 9 | Lockout keyed on `RemoteAddr` | Fix | [261022-vfz](../quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/) · [todo](../todos/done/2026-10-22-user-login-lockout-and-same-second-cutoff.md) | sniewiif | released | `b6f8055` → user v0.1.9 |
| 10 | Same-second token refusal | Fix | [261022-vfz](../quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/) · [todo](../todos/done/2026-10-22-user-login-lockout-and-same-second-cutoff.md) | sniewiif | released | `a484d0e` → user v0.1.9 |
Status values: `open` · `done` · `declined`. Shipped: plugin commit → sm-user-plugin tag.
## Six invocations (fresh session each, sequential)
```
/msd-quick --validate Password /login must refuse is_activated=false when golem15.user.activation.require_activation is true (default), same opaque invalid-login body as a bad password. Do not change deleted_at restore-on-login. See .planning/todos/pending/2026-10-22-user-login-ignores-is-activated.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
/msd-quick --validate /fetch /refresh /update /change-password must accept the token/auth_token cookies the same way jwt.auth and EndSession already do. Logout is already fixed. See .planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
/msd-quick --discuss --validate Under serve, user-plugin Boot runs before lagoon.Publish so the jwt blacklist is never wired and logout does not revoke. Wire BlacklistStore and RegisterHooks through lagoon.OnDatabase; test Activate-then-Publish. When re-registering the jwt guard, pass classes.SessionCookieNames() instead of the hardcoded token/auth_token names (G3 leftover). See .planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
/msd-quick --validate User-plugin /login throttle must use surf.ClientIP (trusted proxies), not RemoteAddr. Leave exported RemoteIP as the RemoteAddr helper. Remaining tokens_valid_after writers (reset-password, admin password set) must Truncate(time.Second) like RevokeUserAccess; leave change-password and bouncer's comparison alone. See .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
/msd-quick --discuss --validate Opt-in HttpOnly session cookie on user-plugin POST /login: golem15.user.jwt.token_cookie (default off), attributes from auth.cookie via bouncer.LoadCookieConfig, omit body token when the cookie is set (sociallogin writeSession). Cookie-carried POST /refresh must rotate that cookie (G3 left body-only); bearer-only refresh stays body-only. SameSite=Lax, no CSRF. Base a484d0e. See .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
/msd-quick --validate User-plugin golem15.user.password.public_routes (default true). When false, do not register POST /login /forgot-password /reset-password so they 404 like unknown paths. Leave /register and the rest. No framework wrap, no custom 404. Base 8bdf2c7. See .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
Suggested order if you care about risk: G4 (serve blacklist), then G3, G2, 9+10, then the two features. All six are done locally; item 8 (password-routes 404) was the last. Do not overlap on the same plugin files. Released in sm-user-plugin v0.1.9.
## Verdicts (kept for the sessions)
- **G2.** `require_activation` is documented and `/register` honors it; `/login` does not. Deactivation (`deleted_at`) stays reversible.
- **G3.** Done locally (`8e4b863`). Cookie extractors are `classes.SessionToken` / `SessionCookieNames`. Item 7 (`846087d`) made a `/refresh` carried by the `auth.cookie` cookie rewrite it; bearer- and `auth_token`-carried refreshes stay body-only. CSRF was not added (SameSite=Lax + current-password on change-password).
- **G4.** Done locally (`4bf44fc`). Lazy `appBlacklist` + `lagoon.OnDatabase` for hooks, Postgres store and sweep. Guard uses `SessionCookieNames()`.
- **G6.** D-27: email change clears `email_verified_at` and does not write a new proof. A confirm-the-new-inbox flow would be a later feature.
- **G7.** Stock form omission was a 12.1 decision. Stale `organisation_role` is already cleared (`ClearOnChange`, v0.1.8). Apps extend the form.
- **G8.** Personal tokens die via `revoked_at`. `RevokeUserAccess` already sets that on deactivate/ban. Do not teach the API-token guard a JWT cutoff. Password reset killing API tokens would be a separate, explicit revoke.
- **7.** Done locally (`846087d`, `8bdf2c7`). `846087d`: a `/refresh` carried by the `auth.cookie` cookie (`token` by default, no bearer) rewrites it and answers `{}`, whatever `token_cookie` says; bearer and other-cookie refreshes stay body-only; refusals write no cookie. `8bdf2c7`: `golem15.user.jwt.token_cookie` (default off) makes /login, /register (auto sign-in) and /activate-by-code set the HttpOnly `auth.cookie` cookie via `bouncer.LoadCookieConfig` and omit body `token`; off keeps today's bodies. SameSite=Lax, no CSRF; API tokens untouched.
- **8.** Done locally (`3828a65`). Plugin config; no framework wrap. `golem15.user.password.public_routes` (default true); false leaves `POST /login`, `/forgot-password` and `/reset-password` unregistered, so they get the router's own 404 like any unknown path (a `GET` too, no 405); no custom handler, no `pact`/`surf` change. `/register` stays (`allow_registration` gates it, `golem15.user.turnstile` still guards it), and so do `/activate*`, `/fetch`, `/refresh`, `/logout`, `/change-password` and `/tokens`. Read when the routes are built (a restart applies it); a value other than true or false fails boot.
- **9.** Done locally (`b6f8055`). /login keys the throttle on surf.ClientIP with http.trusted_proxies (the /register expression); RemoteIP stays the RemoteAddr helper; without trusted proxies X-Forwarded-For is ignored.
- **10.** Done locally (`a484d0e`). /reset-password and the admin password set truncate the cutoff to whole seconds like RevokeUserAccess; change-password and bouncer unchanged.
## Reply to send
Ready to send as-is (all items filled, released in sm-user-plugin v0.1.9).
```
Thanks for the escalation list. We reviewed the current golem15.user plugin (and the framework boot order). Here is what we shipped, what is already true, and what we are not changing. The fixes and the two new options are in sm-user-plugin v0.1.9, which still requires SummerCMS v0.4.3: bump the plugin, no framework upgrade is needed.
G2 — login ignores is_activated
Agreed. require_activation defaults to true and /register already withholds a token in admin mode; /login did not check is_activated. That is not the same as deactivation (deleted_at), which stays self-service: a later password login still restores the account.
Ships in sm-user-plugin v0.1.9 (15ff979): with require_activation on (the default), /login answers an account that is not activated with the same opaque invalid-login response as a bad password (counted as a failed attempt); deactivation stays self-service. /activate still serves a not-activated session so the mailed-code flow works.
G3 — some routes ignore the cookie
Partly already fixed, rest agreed. POST /logout already accepts the token/auth_token cookies (and blacklists every JWT the request carries). GET /fetch, POST /refresh, POST /update and POST /change-password still required the Authorization header.
Ships in sm-user-plugin v0.1.9 (8e4b863): GET /fetch, POST /refresh, POST /update and POST /change-password (and the other signed-in routes: /activate, /marketing-consent, /avatar, /avatar/remove) read the session token like jwt.auth: the Authorization header first, then the token and auth_token cookies. A /refresh carried by the session cookie named in auth.cookie (token by default) rewrites that cookie with the rotated token and answers {} (see "Cookie on /login" below). A /refresh carried by the Authorization header, or by the auth_token cookie, returns the rotated token in the body and writes no cookie; the previous token is revoked, so store the new one yourself.
G4 — logout does not blacklist under serve
Agreed. Plugin Boot runs before serve publishes the database, so the in-process blacklist store was never wired in production (the jwt_blacklist table exists; nothing wrote to it). Tests hid this because they publish the DB before Boot.
Ships in sm-user-plugin v0.1.9 (4bf44fc): the plugin installs its jwt_blacklist store, the blacklist sweep and its GORM hooks when serve publishes the database, and the jwt guard reads that store on every request. Logout under serve now writes the jti to jwt_blacklist, and the next request with that token (jwt.auth routes, /fetch, /refresh) answers 401. A regression test boots in serve order (plugins first, database second). The jwt guard also takes its cookie names from the same list as the session routes (token, auth_token).
G6 — /update changes email without proof
As designed, not a bug. A new address clears email_verified_at and stays unproven until the owner completes an activation code or a reset-password. We are not adding a “confirm the new inbox before the change sticks” flow in this round. Say if you need that as a later feature.
G7 — stock Users form has no role field
As designed. organisation_role is intentionally off the stock form (an app extends the form). v0.1.8 already clears organisation_role when the organisation changes (members manager and the Users form). No further stock-form change.
G8 — API token guard ignores tokens_valid_after
As designed. Personal API tokens are revoked through revoked_at, not the JWT cutoff. Deactivate and ban already revoke those rows (RevokeUserAccess). A password reset is not supposed to kill API tokens; if you want that, say so and we will revoke the rows, not mix the two mechanisms.
Cookie on /login
Agreed as an opt-in. Sociallogin already has token_cookie for OAuth complete; password /login now has the same kind of flag (default off, so body-token clients stay unchanged).
Ships in sm-user-plugin v0.1.9 (846087d and 8bdf2c7): set golem15.user.jwt.token_cookie: true (default false) and POST /login, POST /register (when it signs the new account in) and POST /activate-by-code set the HttpOnly session cookie with the auth.cookie attributes (bouncer.LoadCookieConfig: name token, path /, SameSite=Lax, Secure from app.url, Max-Age the refresh window) and leave token out of the body; user (and message) stay. A POST /refresh carried by that cookie rewrites it with the rotated token and answers {}; a bearer refresh is unchanged. With the key off, /login, /register and /activate-by-code return the body token as before; the /refresh cookie rewrite applies either way, because it follows the cookie the refresh arrived with, not this key. That is a change for a client that refreshes with only the token cookie and no Authorization header: it now gets {} and a rewritten cookie instead of the token in the body. SameSite stays Lax and there is no CSRF token. Keep auth.cookie.name at token or auth_token, the cookies the session routes read.
Password-routes switch
Agreed, in the user plugin, not as a framework “wrap another plugin’s routes” seam. A config key stops registering /login, /forgot-password and /reset-password so they 404.
Ships in sm-user-plugin v0.1.9 (3828a65): set golem15.user.password.public_routes: false (default true; SUMMER_GOLEM15__USER__PASSWORD__PUBLIC_ROUTES=false in the environment) and POST /login, POST /forgot-password and POST /reset-password are not registered, so they answer the same 404 as any unknown path, whatever the method. POST /register stays (allow_registration still decides whether it takes accounts, and golem15.user.turnstile still guards it), as do /activate, /activate-by-code, /fetch, /refresh, /logout, /update, /change-password and /tokens. With the key true or unset nothing changes. The key is read when the routes are built, so a change needs a restart; a value other than true or false stops boot with an error naming the key.
Login lockout keyed on RemoteAddr
Agreed. /login used RemoteAddr; /register already uses the trusted-proxy client address. Behind a reverse proxy five failures locked everyone.
Ships in sm-user-plugin v0.1.9 (b6f8055): /login counts failed logins per account and client address, and the client address is now the one /register and the user-api rate limit use: behind a proxy listed in http.trusted_proxies, the X-Forwarded-For client; otherwise the connection address. An X-Forwarded-For header from an address not in http.trusted_proxies is ignored, so it cannot dodge or move a lockout. List your nginx/Caddy address in http.trusted_proxies; without it every visitor still counts as the proxy.
Same-second token refusal
Agreed. JWT iat is whole seconds; some tokens_valid_after writers stamped sub-second time. RevokeUserAccess already truncates. Reset-password and the admin password set now do too.
Ships in sm-user-plugin v0.1.9 (a484d0e): POST /reset-password and an administrator's password set on the Users form stamp tokens_valid_after with the current whole second, as deactivate and ban already do, so a token minted in the same second as the reset (the login right after it) is accepted and every token from an earlier second is still refused. As with deactivate and ban, a token issued earlier within that same second also stays valid, because iat has no finer resolution. /change-password and the guard's comparison are unchanged.
```

View File

@@ -0,0 +1,48 @@
# Decision: the MCP endpoint uses the official Go SDK behind a build tag
**Date:** 2026-10-22
**Status:** Accepted
**Context:** Phase 19.7 (generic MCP module, D-24, D-25, D-32, D-33), 19.7-RESEARCH.md § "Standard Stack", § "Package Legitimacy Audit", § "Architecture Patterns" (Pattern 8), plan 19.7-02 Task 1 (human legitimacy check, approved 2026-10-22)
## Decision
The framework module `pier` serves the MCP streamable HTTP endpoint on the official Go SDK and reflects tool schemas with the schema library the SDK itself uses.
- **`github.com/modelcontextprotocol/go-sdk` pinned at v1.8.0.** Published 2026-09-04, the newest tag (`@latest` resolves to v1.8.0 on proxy.golang.org, 2026-10-22). Origin `https://github.com/modelcontextprotocol/go-sdk`, commit `3f3b699b2b67e1ed033a63d6651671dab53c2d32`, sum `h1:KIvahhYqwtbeniWVPs3TcXEA7b8jEtwfBpOTAI+Urx4=`. Licence: MIT transitioning to Apache-2.0 (new code Apache-2.0, older contributions MIT until relicensed; documentation CC-BY-4.0). `go 1.25.0` in its go.mod, so no toolchain change. Packages imported: `mcp` (server, sessions, streamable transport, test client), `auth` (bearer middleware, protected resource metadata handler), `oauthex` (the RFC 9728 metadata type), `jsonrpc` (error codes).
- **`github.com/google/jsonschema-go` pinned at v0.4.3.** Published 2026-04-17, the newest tag. Origin `https://github.com/google/jsonschema-go`, commit `8c4ab4f02ef64dcea5502e47a6113e8292944087`, sum `h1:/DBOLZTfDow7pe2GmaJNhltueGTtDKICi8V8p+DQPd0=`. Licence MIT. Package imported: `jsonschema` (`ForType` reflection of a tool's input struct, `Resolve` and `Validate` of every call's arguments).
- **Only `modules/pier` imports either module**, plus the tagged `modules/surf/pier_on.go` that imports `pier`. `pact` stays free of both (its `TestPactStaysSDKFree` runs `go list -deps`), so a plugin declaring tools compiles with and without the module.
- **Linked only with the `summercms_mcp` build tag (D-33).** `summer.yaml` `build.tags: [summercms_mcp]` passes it to `go build`, as `summercms_s3` does for the S3 driver. Without the tag `surf.mountPier` stays nil, `go version -m` of the binary lists no `modelcontextprotocol` module, and `mcp.enabled: true` fails boot naming the tag. With the tag the `mcp.enabled` flag still defaults to off (D-30).
- **The SDK keeps stateful sessions only in process memory**, in `StreamableHTTPHandler.sessions`, with no pluggable store and a 404 for an unknown `Mcp-Session-Id`. D-25 (sessions shared across instances through Redis) is therefore built as pier's own session router over the exported `StreamableServerTransport{SessionID}` and `Server.Connect(ctx, t, &ServerSessionOptions{State})`: the JSON-serialisable `ServerSessionState` is stored in Redis and a session is rehydrated on whichever instance receives the next request. The SDK still owns JSON-RPC framing, SSE, protocol negotiation and `list_changed` debouncing; pier bypasses only the private session map. The 2026-07-28 protocol, which the SDK serves only through `StreamableHTTPOptions.Stateless`, gets the SDK's stateless handler next to the stateful router (D-32).
## Measurements
- **New modules in the graph** (measured with `go list -m all` on a scratch module importing `mcp`, `auth`, `oauthex` and `jsonschema`): `github.com/modelcontextprotocol/go-sdk v1.8.0`, `github.com/google/jsonschema-go v0.4.3`, `github.com/segmentio/asm v1.1.3`, `github.com/segmentio/encoding v0.5.4`, `github.com/yosida95/uritemplate/v3 v3.0.2`, `golang.org/x/oauth2 v0.35.0`, `golang.org/x/time v0.15.0`. `golang.org/x/sync` and `golang.org/x/sys` stay at the framework's newer v0.23.0 and v0.48.0 under minimal version selection. `github.com/golang-jwt/jwt/v5`, `golang.org/x/tools`, `github.com/google/go-cmp` and `cloud.google.com/go/compute/metadata` appear in the SDK's go.mod but are not linked by these packages; the framework already requires jwt/v5 and go-cmp at its own versions.
- **Binary size: +2.9 MiB stripped** on a program importing `mcp`, `auth` and `jsonschema` next to a bare `net/http` program (8,835,335 vs 5,832,967 bytes, 19.7-RESEARCH.md). The scratch probe above with `oauthex` added builds to 7,782,663 bytes stripped. An application that already links `x/sys`, `x/oauth2` and `x/time` grows by less. The tag keeps every untagged binary at its current size.
- **Vulnerabilities:** `govulncheck` v1.9.0 (`go run golang.org/x/vuln/cmd/govulncheck@latest ./...` over the scratch module, 2026-10-22): "No vulnerabilities found" in the code and in the imported packages. One module-level finding, GO-2026-5024 (`golang.org/x/sys/windows` `NewNTUnicodeString`, Windows only, fixed in x/sys v0.44.0), concerns the SDK's own minimum x/sys v0.41.0; the framework requires x/sys v0.48.0, above the fix, and no imported package calls the symbol. After the import lands, the same command runs as `go run golang.org/x/vuln/cmd/govulncheck@latest ./modules/pier/...` from the framework root.
## Maintenance risk
The SDK is maintained by the Model Context Protocol organisation together with the Go team, releases monthly, and tracks the specification closely (v1.8.0 supports 2026-07-28, 2025-11-25, 2025-06-18, 2025-03-26 and 2024-11-05). The risk is churn, not abandonment: the `allowsessionsinstateless` compatibility knob is announced to go in v1.9.0, and the stateful `initialize` handshake is deprecated by the 2026-07-28 specification. pier contains both: plugins compile against `pact` only, the SDK types never appear in a plugin-facing signature, and the session router is about 300 lines over four exported SDK calls (`NewServer`, `Connect`, `StreamableServerTransport.ServeHTTP`, `NewStreamableHTTPHandler`). Re-check `@latest` before bumping; research's validity note dates the SDK audit at 2026-10-21.
## Rejected alternatives
- **`github.com/mark3labs/mcp-go`.** Not considered: D-24 locks the official SDK, which is the only one that follows the specification's monthly moves and ships the test client pier's smoke tests use.
- **The SDK's `StreamableHTTPHandler` as the whole server.** Its session map is in-memory and unexported; two instances behind one load balancer would answer 404 for each other's sessions. The own router keeps D-25 and reuses every other SDK layer.
- **A hand-written streamable HTTP transport.** JSON-RPC batching rules per protocol version, SSE priming events, `Last-Event-ID` resumption, header validation and version negotiation are specification edge cases the SDK already handles and tests.
- **Always linking pier.** +2.9 MiB on every application for a feature most do not enable; the tag pattern already exists (`summercms_s3`).
## Related dependencies
- **`github.com/redis/go-redis/v9` v9.23.0** (already required, 19.3 `cooler`): session records, sliding TTL and pub/sub fan-out; `github.com/alicebob/miniredis/v2` v2.40.0 (already required) backs the Docker-free session tests.
- **`golang.org/x/oauth2`**: new to the framework's graph through the SDK's `auth` package; already approved in 19.4 for the workspace (`sm-oauthserver-plugin` tests) and in 19.5 (`goth`).
## Package legitimacy
The package-legitimacy seam checks npm, PyPI and crates only, so both modules were [ASSUMED] in research and gated by a blocking human check (plan 19.7-02 Task 1) before any `go get`. The human approved exactly `github.com/modelcontextprotocol/go-sdk@v1.8.0` and `github.com/google/jsonschema-go@v0.4.3` on 2026-10-22, with the proxy origins, commits, sums and licences listed above gathered beforehand. The transitive modules listed under Measurements are covered by the same check.
## Consequences
- The framework `go.mod` gains `github.com/modelcontextprotocol/go-sdk v1.8.0` and `github.com/google/jsonschema-go v0.4.3` as direct requirements, added in the commit after this note (D-24: the note and the STACK.md row precede the import).
- `grep -rl modelcontextprotocol/go-sdk modules --include=*.go` must list only `modules/pier/*` and `modules/surf/pier_on.go`; the phase gate (plan 05) asserts it, together with "only `modules/pier` calls `bouncer.WithDispatch` outside tests".
- `examples/hello` and every application built without the tag carry no MCP code; `go version -m` of such a binary is the proof.
- Applications that enable MCP add `summercms_mcp` to `summer.yaml` `build.tags` and set `mcp.enabled: true`; the `mcp.*` keys are documented in `modules/pier/README.md` and `docs/services/mcp.md`.

View File

@@ -0,0 +1,292 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 01
subsystem: admin
tags: [cabana, pact, admin, permissions, postgres, advisory-lock, phrasebook]
requires:
- phase: 12.1
provides: generic CRUD, record/bulk actions, permissioneditor, RelationLockProvider, preview screens
provides:
- pact.HasAdminActionExtensions / pact.AdminActionExtension (cross-controller record actions, D-14)
- internal summercms.cabana pseudo-plugin with summercms.cabana.users and summercms.cabana.roles
- backend.manage_users and backend.manage_roles permission codes (no role grants)
- server-side privilege rules D-03..D-12, D-16, D-17, D-19, D-20
- backend::lang user, user.role, permissions copy (en, pl)
affects: [19.6.1-02 (SPA trigger and record permission locks), 19.6.1-03 (unit and Postgres tests), 19.7 (link action on the Administrators screen), 19.6 D-15 (Reset 2FA contribution)]
actuals:
tokens: 41600
tasks: 4
commits: 4
plan_head_before: 88ec4df2b35dd5d6654df23c19ba5ad371fe993d
plan_head_after: 653307de0c37902b68a2acd53bef07e887e44ca8
tech-stack:
added: []
patterns:
- "Internal pseudo-plugin appended in Activate only after the no-controllers early return"
- "Boot-time merge of contributed record actions into compiled controllers before permission validation"
- "Unexported in-package interfaces (recordDataExtender, schemaFieldHider) for per-request projection and schema drops"
- "Last-superuser invariant: pg_advisory_xact_lock after the row lock plus a count in the write tx"
- "Prior-state snapshot on an unexported model field, compared in FormAfterUpdate"
key-files:
created:
- modules/cabana/action_extensions.go
- modules/cabana/backend_screens.go
- modules/cabana/backend_users_admin.go
- modules/cabana/backend_roles_admin.go
- modules/cabana/backend_privileges.go
- modules/cabana/backendscreens/controllers/users/{config_list,config_form,config_filter}.yaml, _hint.htm
- modules/cabana/backendscreens/models/user/{columns,fields}.yaml
- modules/cabana/backendscreens/controllers/roles/{config_list,config_form}.yaml
- modules/cabana/backendscreens/models/userrole/{columns,fields}.yaml
- modules/cabana/backend_screens_test.go
- modules/cabana/backend_screens_smoke_test.go
- modules/cabana/example_action_extension_test.go
modified:
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/cabana/http.go
- modules/cabana/registry.go
- modules/cabana/contracts.go
- modules/cabana/crud.go
- modules/cabana/README.md
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- docs/backend/admin-controllers.md
- docs/backend/users-and-permissions.md
key-decisions:
- "The Active filter label uses backend::lang.user.filter_activated, because UI-SPEC assigned user.activated to both the filter label and the activate success toast"
- "The D-14 seam carries record actions only; AdminActionExtension is a struct so bulk or toolbar kinds can be added later"
- "Bulk lifecycle actions return their success phrase only when every selected row changed; otherwise the framework count text (never overstates)"
- "D-17 in-use refusal is a 403 ForbiddenError whose message the hook translates with Choice (name and count), so the SPA delete toast shows it"
patterns-established:
- "Contributed record action names are checked against the owner's and earlier contributors' names; the error names both plugins"
- "Every refusal from a delete or an action on these screens is a ForbiddenError with Message set"
requirements-completed: [SC-1, SC-2, SC-3, D-01, D-02, D-03, D-04, D-05, D-06, D-07, D-08, D-09, D-10, D-11, D-12, D-13, D-14, D-15, D-16, D-17, D-18, D-19, D-20, D-22]
coverage:
- id: D1
description: "pact action-extension seam: a plugin adds record actions to summercms.cabana.users; offered on the preview after the owner's, run in the row-locked tx; unknown controller ID stops boot"
requirement: "D-14"
verification:
- kind: unit
ref: "modules/cabana/backend_screens_test.go#TestBackendScreensSmoke"
status: pass
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestBackendScreensPostgresSmoke"
status: pass
human_judgment: false
- id: D2
description: "Pseudo-plugin activates only with admin controllers; settings tile Administrators (order 100) and Roles (110) under System; codes granted to no role"
requirement: "D-01"
verification:
- kind: unit
ref: "modules/cabana/backend_screens_test.go#TestBackendScreensSmoke"
status: pass
- kind: integration
ref: "go -C examples/hello test ./... and go test ./modules/surf"
status: pass
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestRolesSmoke"
status: pass
human_judgment: false
- id: D3
description: "Administrators form: create with password, superuser projection, D-03 hiding, D-05 superuser-only switch, D-08 own role/flag refusals, D-20 own password refusal, superuser demotion with a second superuser"
requirement: "D-05"
verification:
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestAdministratorsFormSmoke"
status: pass
human_judgment: false
- id: D4
description: "Lifecycle: deactivate revokes JWTs, soft delete with deleted row state, restore, trashed filter, self delete and self bulk-deactivate refused with whole-selection rollback, preview hint"
requirement: "D-10"
verification:
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestAdministratorsLifecycleSmoke"
status: pass
human_judgment: false
- id: D5
description: "Roles screen: create, code taken, in-use and system-role delete refusals, system code lock, settings order"
requirement: "D-16"
verification:
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestRolesSmoke"
status: pass
human_judgment: false
- id: D6
description: "Concurrent last-superuser race, D-07 ceilings and D-19 outranking for limited editors, scoped-token superusers"
requirement: "D-09"
verification: []
human_judgment: true
rationale: "Implemented here; the held-lock race and the per-rule unit tests are Plan 03's scope (D-18). Only the sequential paths are smoke-tested in this plan."
- id: D7
description: "Screens render and behave in the admin SPA (lists, form tabs, preview footer, toasts)"
verification: []
human_judgment: true
rationale: "Visual and interaction behaviour in the browser is the VALIDATION manual-only UAT item; D-21 SPA additions land in Plan 02."
duration: 30min
completed: 2026-10-22
status: complete
---
# Phase 19.6.1 Plan 01: Backend Administrators and Roles screens (server side) Summary
**cabana now ships Settings → System → Administrators and Roles as YAML controllers of an internal `summercms.cabana` pseudo-plugin. Every privilege rule is enforced in the save transaction, and the last active superuser is protected by a `pg_advisory_xact_lock` plus a count. A new `pact.HasAdminActionExtensions` seam lets any plugin add record actions to any admin controller by ID.**
## Performance
- **Duration:** ~30 min
- **Started:** 2026-10-22T08:48:58Z
- **Completed:** 2026-10-22T09:18:37Z
- **Tasks:** 4
- **Files modified:** 29 (3066 insertions, 6 deletions)
## Accomplishments
- **D-14 seam.** `pact.AdminActionExtension` and `pact.HasAdminActionExtensions` were added. `compileActionExtensions` merges contributed actions after the controllers compile and before `compileContributions`, so their permissions are validated. The merge builds a new slice and a new map rather than mutating the compiled ones. Unknown controller, no preview block, reserved or duplicate names, a nil `Run` and an empty label each stop boot.
- **Pseudo-plugin.** `Activate` appends `backendScreens` only after the `len(items) == 0` early return. `examples/hello` and the surf admin-prefix tests are unchanged. The caller's plugin slice is never mutated.
- **Administrators screen (`summercms.cabana.users`).**
- List: role, superuser, activation, last-sign-in and deleted filters; deleted and disabled row states.
- Preview: status hint, then Activate / Deactivate / Restore, then contributed actions.
- Form, Account tab: login, email, names, password and confirmation, role picker.
- Form, Permissions tab: superuser switch and radio overrides.
- Bulk actions: activate, deactivate, restore; bulk soft delete.
- **Privilege rules, enforced on the server:**
- D-03: superusers are hidden from non-superusers in the list, every lookup and the schemas.
- Pitfall 1: superusers receive the stored `is_superuser` value, so an untouched save keeps the flag.
- D-05: the superuser switch is superuser-only, even when the field is hidden.
- D-07: locked permission options and role locks for editors without the grants.
- D-08: an admin cannot change their own role (checked in `FormAfterUpdate` against a snapshot), flag, overrides or activation, and cannot delete themselves.
- D-09: the last active superuser cannot be demoted, deactivated or deleted, on single and bulk paths.
- D-11: password min 4 characters, max 72 bytes, bcrypt cost from config.
- D-12: `tokens_valid_after` is bumped on a password set for another admin, on deactivate and on delete.
- D-19: an editor cannot change an admin who outranks them.
- D-20: an admin cannot set their own password here.
- Login and email must be unique ignoring case, deleted admins included.
- **Roles screen (`summercms.cabana.roles`).**
- Fields: name, slug code, description, checkbox permission editor with the editor's ceiling.
- System roles keep their code and cannot be deleted.
- A role still held by any admin cannot be deleted; the 403 names the role and the count.
- Role codes must be unique.
- **Copy and docs.** The full `backend::lang.user` (with `user.role`), `backend::lang.permissions` and `settings.category_system` copy is in en and pl. The cabana and pact READMEs, `docs/backend/admin-controllers.md` (new section "Adding record actions to another controller") and `docs/backend/users-and-permissions.md` (Permissions, the Administrators screen, lifecycle, the Roles screen, the My account paragraph) were updated in the same commits as the code.
## Task Commits
1. **Task 1 (tracer): Administrators list and preview, settings tile, cross-controller record actions.** `7340241` (feat)
2. **Task 2: Administrators form with the server-side privilege rules.** `8840173` (feat)
3. **Task 3: Administrator lifecycle and last-superuser protection.** `530b02a` (feat)
4. **Task 4: Roles screen.** `653307d` (feat)
## Files Created/Modified
- `modules/pact/capabilities.go`: `AdminActionExtension` and `HasAdminActionExtensions`.
- `modules/cabana/action_extensions.go`: the boot-time merge and its checks.
- `modules/cabana/backend_screens.go`: the pseudo-plugin (controllers, two permissions, two settings links, embedded `AdminFS`), the exported constants and `withBackendScreens`.
- `modules/cabana/backend_users_admin.go`: the Administrators controller (scopes, projection, schema hiding, rules, filter options, role locks, permission provider, Form hooks, lifecycle record and bulk actions, hint partial).
- `modules/cabana/backend_roles_admin.go`: the Roles controller.
- `modules/cabana/backend_privileges.go`: `actsAsSuperuser`, `roleGrantSet`, `effectiveGrants`, `grantsCovered`, `guardOutranked`, `guardLastSuperuser`, `superuserLockKey`, `revocationCutoff`.
- `modules/cabana/contracts.go`:
- `BackendUser`: `Fillable`, `Rules`, `FilterScopes` and `FilterScope` (`filterByRole`, `filterTrashed`), plus the `priorRoleID`/`priorLoaded` snapshot.
- `BackendUserRole`: `Fillable` and `Rules`.
- `CompiledController.contributed` and `Registry.permissionOrder`.
- `modules/cabana/registry.go`: fills `permissionOrder`.
- `modules/cabana/crud.go`: the `recordDataExtender` hook in `projectFullRecord`.
- `modules/cabana/http.go`:
- `Activate`: the pseudo-plugin and the extension merge.
- `schemaFieldHider`, applied in `formSchema` and `listSchema` (new slices).
- `modules/cabana/backendscreens/**`: the embedded YAML and the `_hint.htm` partial (copied verbatim from the analog).
- `modules/cabana/backend_screens_test.go`: `TestBackendScreensSmoke` (runs under `-short`).
- `modules/cabana/backend_screens_smoke_test.go`: `TestBackendScreensPostgresSmoke`, `TestAdministratorsFormSmoke`, `TestAdministratorsLifecycleSmoke` and `TestRolesSmoke`, plus the reusable `screensEnv` harness for Plan 03.
- `modules/cabana/example_action_extension_test.go`: the documented seam example (`ProfilesPlugin.AdminActionExtensions`) and `TestExampleActionExtension`.
## Decisions Made
- I followed the plan's recorded decisions: the IDs, the conditional pseudo-plugin, record actions only in the seam, the advisory-lock strategy, the D-07 wildcard rule, D-12 leaving personal tokens valid on a password set, the D-17 refusal as a 403, and no users-count column on Roles.
- The Active filter label key is `backend::lang.user.filter_activated` (see deviation 1).
- Bulk lifecycle actions report their fixed success phrase only when every selected row changed, as the analog does. Otherwise the framework's count text is shown.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] Phrase key collision on `backend::lang.user.activated`**
- **Found during:** Task 1 (lang keys)
- **Issue:** UI-SPEC assigns `user.activated` both to the "Active" filter label and to the "Administrator activated" success toast. One key cannot hold both texts.
- **Fix:** `user.activated` keeps the success text, and the filter label uses a new key, `user.filter_activated` ("Active" / "Aktywny"). `config_filter.yaml` uses the new key.
- **Files modified:** modules/phrasebook/backend/lang/{en,pl}/lang.yaml, modules/cabana/backendscreens/controllers/users/config_filter.yaml
- **Committed in:** 7340241, 8840173
**2. [Rule 3 - Blocking] The docs checker refuses Go code blocks without `src=`**
- **Found during:** Task 1 (docs)
- **Issue:** `TestDocsTree` failed: "go code block has no src= reference". The snippet source must also be exercised by a test.
- **Fix:** I moved the neutral example to `modules/cabana/example_action_extension_test.go` (`ProfilesPlugin.AdminActionExtensions`), added `TestExampleActionExtension`, and referenced it with `src=` (`summer docs:sync`).
- **Committed in:** 7340241
**3. [Rule 2 - Missing critical] More smoke assertions than the plan lists**
- The form smoke also checks the D-20 own-password refusal, the D-08 own-role change being refused and rolled back after assignment, the 422 on a taken login, and a limited editor's rename succeeding without `is_superuser`.
- The lifecycle smoke also checks the hint partial for a deleted admin, the `trashed=only` filter, the self-delete refusal, and that bulk activate does not move `tokens_valid_after`.
- The roles smoke also checks the code-taken 422, that a system role's name stays editable, and that an unused role deletes.
- **Committed in:** 8840173, 530b02a, 653307d
**4. Commit scope.** Commits use `feat(19.6.1-01): ...`, as the orchestrator instructed, instead of the plan's `feat(cabana): ...`. There are no co-author tags.
**5. YAML detail.** The trashed scope filter declares `nameFrom: login`, because cabana requires `nameFrom` on a scope filter. The Roles list also sets `messages.empty` to `user.role.list_empty`.
---
**Total deviations:** 3 auto-fixed (1 bug, 1 blocking, 1 missing-critical test coverage), plus 2 notes.
**Impact on plan:** None on scope. The key rename is a copy-contract fix that Plan 02 and Plan 03 should reference.
## Existing tests
No existing test was modified: every pre-existing cabana, surf, pact and hello test passes unchanged with the pseudo-plugin active.
## Verification
- `go vet ./...`: pass.
- `go test -short ./...` (whole repo): pass.
- `go -C examples/hello test ./...`: pass.
- `go test -run '^TestDocsTree$' ./cmd/summer`: pass.
- `go run ./cmd/summer docs:build --check`: no problems found.
- `scripts/check-admin-openapi.sh --check`: exit 0, no swag-visible change.
- Docker-backed tests, run directly (the Docker socket was accessible):
- `go test ./modules/cabana ./modules/surf`: pass after every task.
- The four smokes `TestBackendScreensPostgresSmoke`, `TestAdministratorsFormSmoke`, `TestAdministratorsLifecycleSmoke` and `TestRolesSmoke`: 4/4 `--- PASS`.
- SC-1: `git log 88ec4df..HEAD -- modules/cabana/commands.go modules/cabana/token_commands.go modules/cabana/account.go` is empty.
- Every task's acceptance criteria were re-run and passed.
## Issues Encountered
None.
## Known Stubs
None.
## Threat Flags
None. The new surface (two admin controllers, the extension seam) is covered by the plan's threat register, T-19.6.1-01 to T-19.6.1-17.
## User Setup Required
None. No external service configuration is required.
## Next Phase Readiness
- Plan 02 (D-21 SPA) can add the field `trigger` (the Administrators `permissions` field has no trigger key yet) and the per-record permission locks: role code-declared grants, and every code on the editor's own record.
- Plan 03 can build on `screensEnv` in `backend_screens_smoke_test.go` for the held-lock D-09 race, the D-07 and D-19 cases for limited editors, scoped-token superusers and the seam's boot errors.
- 19.7 and the MFA plugin can contribute record actions to `cabana.AdministratorsControllerID` through `pact.HasAdminActionExtensions`.
---
*Phase: 19.6.1-backend-administrators-screen*
*Completed: 2026-10-22*
## Self-Check: PASSED

View File

@@ -0,0 +1,284 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 02
subsystem: admin
tags: [cabana, admin-spa, permissions, fields-yaml, openapi, boardwalk]
requires:
- phase: 19.6.1-01
provides: Administrators and Roles controllers, permission editor providers, Registry.permissionOrder, rolePermissions
provides:
- cabana.PermissionRecordLock and the optional cabana.PermissionRecordLockProvider
- RecordMeta.PermissionLocks (meta.permissionLocks) on show, create and update responses, notes localized
- record-lock save rule in applyPermissionValues (absent keeps stored, differing present value is 403)
- fields.yaml `trigger` (cabana.FieldTrigger on FormField.Trigger) with boot checks
- SPA trigger evaluation (trigger.ts), trigger note in FormField, record-locked rows in PermissionEditorField
- regenerated admin/openapi/admin.json, admin/src/api/schema.d.ts and modules/boardwalk/dist
affects: [19.6.1-03 (SPA and Go unit tests for triggers and record locks), any plugin with a permission editor or a fields.yaml that wants trigger]
actuals:
tokens: 28900
tasks: 2
commits: 2
plan_head_before: e2525d4956e58f693b841324f2837e23fe213d1f
plan_head_after: 7091d09699c30b000a4ae6776ada33560e679252
tech-stack:
added: []
patterns:
- "Per-record display locks travel in the record response meta, never in the form schema"
- "Display rules (trigger, record locks) are applied in the SPA by leaving values out of the save body; the server keeps stored values and stays authoritative"
- "Injection keys (FORM_PERMISSION_LOCKS, FORM_TRIGGER_NOTES) instead of prop threading through FormGrid/FormField/FieldRenderer"
key-files:
created:
- modules/cabana/field_trigger.go
- modules/cabana/field_trigger_smoke_test.go
- modules/cabana/record_locks_smoke_test.go
- modules/cabana/example_permission_record_locks_test.go
- admin/src/components/form/trigger.ts
modified:
- modules/cabana/field_permission.go
- modules/cabana/relation_field.go
- modules/cabana/crud.go
- modules/cabana/relation_child.go
- modules/cabana/backend_roles_admin.go
- modules/cabana/backend_users_admin.go
- modules/cabana/form_schema.go
- modules/cabana/schema_types.go
- modules/cabana/field_dependent.go
- modules/cabana/field_repeater.go
- modules/cabana/admin_openapi.go
- modules/cabana/backendscreens/models/user/fields.yaml
- modules/cabana/backend_screens_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
- admin/src/api/types.ts
- admin/src/components/form/formContext.ts
- admin/src/components/form/control.ts
- admin/src/components/form/formState.ts
- admin/src/components/form/FormField.vue
- admin/src/components/form/fields/PermissionEditorField.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/views/FormView.vue
- admin/src/views/PreviewView.vue
- modules/boardwalk/dist
- docs/backend/forms.md
- docs/backend/users-and-permissions.md
key-decisions:
- "Record-lock notes are filled as phrase keys in projectFullRecord and translated where the show and save paths (and the relation child paths) finish, with s.tr"
- "A record-locked row sets data-locked and data-locked-by=\"record\" only where the lock is shown (editable screens); read-only screens show the lock's value only"
- "The trigger note is looked up by the FormGrid scope path, so a repeater row field never picks up a top-level note; RelationChildModal provides an empty note map"
- "The non-superuser schema check in TestAdministratorsFormSmoke now looks for an is_superuser field rather than the string: the permissions field's trigger names is_superuser by design (UI-SPEC C6)"
patterns-established:
- "Optional controller capabilities next to PermissionEditorProvider are asked only for stored records and only through cabana's save/show paths"
- "Triggers are compiled per controller form; settingsFormOnly/controllerFormOnly and the repeater row check refuse them elsewhere"
requirements-completed: [SC-1, SC-2, D-06, D-08, D-16, D-18, D-21, D-22]
coverage:
- id: D1
description: "Record-lock save rule: absent locked code keeps stored, differing present value is 403, equal body passes, request-Locked plus record-locked absent code is not a 403, no locks asked on create; meta.permissionLocks present only with a provider"
requirement: "D-21"
verification:
- kind: unit
ref: "modules/cabana/record_locks_smoke_test.go#TestPermissionRecordLocksSmoke"
status: pass
human_judgment: false
- id: D2
description: "Roles and Administrators saves keep working under the record-lock rule (system role grants, own record)"
requirement: "D-16"
verification:
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestRolesSmoke"
status: pass
- kind: integration
ref: "modules/cabana/backend_screens_smoke_test.go#TestAdministratorsFormSmoke"
status: pass
human_judgment: false
- id: D3
description: "Trigger compile: valid trigger reaches the localized schema; unknown action, unknown condition, extra key, missing key, not a mapping, self reference, unknown controlling field, text controlling field, repeater row are boot errors naming controller, field and trigger; settings and relation forms refuse it; Administrators permissions carries the D-06 trigger"
requirement: "D-06"
verification:
- kind: unit
ref: "modules/cabana/field_trigger_smoke_test.go#TestFieldTriggerSmoke"
status: pass
human_judgment: false
- id: D4
description: "Generated OpenAPI, schema.d.ts and the committed admin build match fresh generations"
requirement: "D-18"
verification:
- kind: integration
ref: "scripts/check-admin-openapi.sh --check"
status: pass
- kind: integration
ref: "scripts/check-admin-dist.sh"
status: pass
human_judgment: false
- id: D5
description: "SPA rendering: trigger note, read-only overrides while Superuser is on, record-locked rows with notes, tab removal for hidden fields, live-region announcement"
requirement: "D-21"
verification: []
human_judgment: true
rationale: "Plan 03 owns the SPA unit tests; the browser behaviour is the Task 2 human-check (verify-work UAT). A throwaway vitest run during execution confirmed the locked row, the payload omission and the trigger note markup, and was not committed."
duration: 23min
completed: 2026-10-22
status: complete
---
# Phase 19.6.1 Plan 02: SPA support for triggers and per-record permission locks Summary
**The admin now shows permissions a stored record fixes (a role's plugin-declared grants, an administrator's own overrides) as locked rows with their notes, through a new optional `cabana.PermissionRecordLockProvider` and `meta.permissionLocks`. fields.yaml gains WinterCMS's `trigger`, which the Administrators form uses to make the overrides read-only while Superuser is on. The OpenAPI types and the embedded admin build were regenerated.**
## Performance
- **Duration:** ~23 min
- **Started:** 2026-10-22T09:21:00Z
- **Completed:** 2026-10-22T09:44:04Z
- **Tasks:** 2
- **Files modified:** 38 (1089 insertions, 95 deletions, dist assets included)
## Accomplishments
- **Record locks (D-21 for D-16 and D-08).**
- `PermissionRecordLock{Code, Value, Note}` and the optional `PermissionRecordLockProvider` sit next to `PermissionEditorProvider`.
- `projectFullRecord` fills `RecordMeta.PermissionLocks`. Show, create and update responses (and the relation child paths) translate the notes in the request locale. The key is omitted when no lock applies.
- `applyPermissionValues` on update: a record-locked code that is absent from the body keeps its stored value. A present value must equal the stored one, or the save gets a 403 on the field. The code is skipped in the request-Locked comparison, so a system role whose code grant is not in its stored JSON saves without a 403.
- Roles lock every `rolePermissions(code)` grant, in catalog order, at value 1 with `locked_by_code`. Administrators lock every offered code on the editor's own record at its stored override, with `locked_self`.
- **Field trigger (D-21 for D-06).**
- `FieldTrigger{Action, Field, Condition}` on `FormField.Trigger`.
- `compileTrigger` takes exactly action, field and condition. `checkTriggers` runs in `compileForm` through `bootErr`.
- Repeater rows, settings forms and relation forms refuse the key.
- The Administrators `permissions` field declares `trigger: {action: disable, field: is_superuser, condition: checked}`.
- **SPA.**
- `trigger.ts` (`triggerState`, `applyTriggers`); injection keys `FORM_PERMISSION_LOCKS` and `FORM_TRIGGER_NOTES`.
- `permissionValues(field, value, locked?)` and `editablePayload(fields, values, mode, locks?)`.
- FormView: every use of the field list goes through `applyTriggers`, applied with the whole form's values. That covers tabs, panel fields, the banner's field names, the dirty snapshot and the save body. When the active tab disappears, the first remaining tab becomes active. A flip to disabled is announced as "<label>: <note>". Values stay in the form while a field is disabled or hidden.
- FormField shows the trigger note (Info 14px, `data-trigger-note`, joined to `aria-describedby`) between the label and the control.
- PermissionEditorField shows record-locked rows: the lock's value, disabled with `aria-disabled`, the Lock icon, the lock's note, `data-locked` and `data-locked-by="record"`. A record lock wins over a request lock, and read-only screens show the value only.
- PreviewView applies `hide` only.
- **Generated and built.** `admin/openapi/admin.json` and `schema.d.ts` are committed with each type change. `modules/boardwalk/dist` was rebuilt and committed in Task 2.
- **Docs.**
- `docs/backend/forms.md`: new sections "Permissions the record fixes" and "Triggers" (the "Field options" paragraph no longer lists `trigger` as refused).
- `docs/backend/users-and-permissions.md`: the read-only overrides, the own-record locks and the locked role grants.
- cabana README: Features and API rows.
## Task Commits
1. **Task 1 (tracer): per-record locked permission values.** `705f94d` (feat)
2. **Task 2: field trigger and admin build.** `7091d09` (feat)
Tracer feedback gate: the Task 1 `<verify>` commands, all automated, were re-run end to end (short suite, smoke, hello, OpenAPI check, typecheck, vitest, docs checker, Plan 01 Postgres smokes 2/2). All passed, so Task 2 went ahead.
## Files Created/Modified
- `modules/cabana/field_permission.go`: the lock types, `permissionRecordLocks`, `localizePermissionLocks`, and the save rule in `applyPermissionValues`.
- `modules/cabana/relation_field.go`: `RecordMeta.PermissionLocks`.
- `modules/cabana/crud.go` and `relation_child.go`: fill the locks in `projectFullRecord` and translate them in the show and save paths.
- `modules/cabana/backend_roles_admin.go` and `backend_users_admin.go`: `AdminPermissionRecordLocks`.
- `modules/cabana/field_trigger.go`, `form_schema.go`, `schema_types.go`, `field_dependent.go` and `field_repeater.go`: trigger compile, checks and refusals.
- `modules/cabana/backendscreens/models/user/fields.yaml`: the D-06 trigger.
- `modules/cabana/admin_openapi.go`: the record and form schema descriptions.
- `modules/phrasebook/backend/lang/{en,pl}/lang.yaml`: `permissioneditor.locked_by_code`, `permissioneditor.locked_self`, `form.trigger_disabled_on` and `form.trigger_disabled_off`, verbatim from UI-SPEC.
- SPA files as listed in the frontmatter.
## Decisions Made
- I followed the plan's decisions: the exported optional interface, the payload shape, the save rule, injection keys instead of prop threading, `checked` and `unchecked` only, and the dist rebuilt once, in Task 2.
- Notes are translated after the transaction, where the response is finished. `projectFullRecord` has no translator.
- In the editor, `data-locked-by="record"` appears only where the lock is shown. Read-only screens follow the existing `showsLock` rule.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] The Plan 01 schema assertion matched the trigger's reference to is_superuser**
- **Found during:** Task 2 (Docker-backed `go test ./modules/cabana`)
- **Issue:** `TestAdministratorsFormSmoke` checked that a limited editor's form schema does not contain the string `is_superuser`. The permissions field's trigger now names `is_superuser` by design: UI-SPEC C6 says a controlling field missing from the schema counts as off.
- **Fix:** The assertion now checks that no schema field is named `is_superuser`. The D-03 intent is unchanged: the switch itself is still removed for non-superusers.
- **Files modified:** modules/cabana/backend_screens_smoke_test.go
- **Commit:** 7091d09
**2. [Rule 3 - Blocking] The docs checker needs a `src=` source for Go blocks**
- **Issue:** The docs example of a record-lock provider needs a `src=` reference to compiled, tested code.
- **Fix:** Added `modules/cabana/example_permission_record_locks_test.go` (`AccessRolesController.AdminPermissionRecordLocks` with `Example_permissionRecordLocks`) and referenced it from `docs/backend/forms.md`.
- **Commit:** 705f94d
**3. [Rule 2 - Missing critical] Translation and isolation outside the planned paths**
- The relation child show and save paths also translate `meta.permissionLocks`, so no response can carry an untranslated phrase key.
- `RelationChildModal.vue` provides an empty `FORM_TRIGGER_NOTES`, so a child field that shares a top-level field's name never shows that field's note.
- `FormField` looks notes up by the FormGrid scope path, so repeater row fields never match.
- **Commits:** 705f94d, 7091d09
**4. Docs beyond the listed files.** `docs/backend/users-and-permissions.md` gained three sentences (read-only overrides, own-record locks, locked role grants) so that page matches the behaviour. The "Field options" paragraph in forms.md had listed `trigger` among the refused WinterCMS keys; I corrected it.
**5. Commit scope.** Commits use `feat(19.6.1-02): ...` as the orchestrator instructed, instead of the plan's `feat(cabana,admin): ...`. No co-author tags.
---
**Total deviations:** 3 auto-fixed (1 bug, 1 blocking, 1 missing-critical), plus 2 notes.
**Impact on plan:** None on scope.
## Existing tests
One existing test changed: the `is_superuser` schema assertion in `TestAdministratorsFormSmoke` (deviation 1). Every other existing Go and vitest test passes unchanged.
## Verification
- `go vet ./...`: pass.
- `go test -count=1 -short ./...`: pass.
- `go -C examples/hello test ./...`: pass.
- `TestPermissionRecordLocksSmoke`, `TestFieldTriggerSmoke` and `TestBackendScreensSmoke`: 3/3 `--- PASS`.
- `go test -count=1 ./modules/cabana ./modules/surf ./modules/boardwalk` (Docker reachable directly): pass. This includes the Plan 01 Postgres smokes, 4/4.
- `scripts/check-admin-openapi.sh --check`: pass after each commit.
- `npm --prefix admin run typecheck`: pass.
- `npm --prefix admin run test`: 93 files, 1435 tests, all pass. One earlier run hit a 5s timeout in `tests/smoke/list.smoke.test.ts` under load. It passed alone and on the full rerun; the test is unrelated to forms.
- `scripts/check-admin-dist.sh`: "modules/boardwalk/dist matches a fresh build".
- `go test -run '^TestDocsTree$' ./cmd/summer` and `summer docs:build --check`: pass.
- `admin/package.json` and `package-lock.json` are unchanged. `npm ls` reports the installed tree consistent with the lockfile. I did not run `npm ci`, because node_modules was present and other sessions share it.
- All acceptance greps for both tasks print the expected counts.
## Issues Encountered
None blocking.
## Known Stubs
None.
## Threat Flags
None. The new surface (`meta.permissionLocks`, the `trigger` key) is covered by T-19.6.1-18 to T-19.6.1-23:
- The server never trusts a trigger or a lock from the client.
- Notes render through text interpolation only; the touched components contain no `v-html`.
- No package was added.
## User Setup Required
None.
## Next Phase Readiness
- Plan 03 can unit-test:
- `triggerState` and `applyTriggers` (trigger.ts);
- the record-locked rows in `PermissionEditorField` (inject `FORM_PERMISSION_LOCKS`);
- `editablePayload` with locks;
- the FormField note (`FORM_TRIGGER_NOTES`, id `<controlId>-trigger`);
- the FormView tab fallback and announcement.
- On the server side it can unit-test `compileTrigger` and `checkTriggers`, plus own-record and system-role locks against Postgres through `screensEnv`.
- Manual UAT (Task 2 human-check):
- As a superuser, open another superuser: the overrides are read-only with the note, and switching Superuser off makes them editable.
- Your own record shows locked rows.
- A role that plugins grant to shows those grants locked with "Granted to this role by a plugin."
---
*Phase: 19.6.1-backend-administrators-screen*
*Completed: 2026-10-22*
## Self-Check: PASSED

View File

@@ -0,0 +1,338 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 03
subsystem: testing
tags: [cabana, admin-spa, permissions, postgres, advisory-lock, vitest, playwright, gate]
requires:
- phase: 19.6.1-01
provides: Administrators and Roles screens, privilege rules, pact.HasAdminActionExtensions, the screensEnv smoke harness
- phase: 19.6.1-02
provides: field trigger, PermissionRecordLockProvider, meta.permissionLocks, trigger.ts, SPA record-locked rows
provides:
- one named test per privilege rule of D-03, D-05..D-12, D-16, D-17, D-19, D-20 over the assembled HTTP handler on Postgres
- the held-lock last-superuser race on all five reducing paths, plus ten unsynchronized rounds
- TestActionExtensionBoot / TestActionExtensionRun for the D-14 seam, TestBackendScreensActivation, TestRoleCeiling
- D-21 tests in Go (TestFieldTriggerBoot, TestPermissionRecordLocks, TestRolesCodeDeclaredLocks) and in the SPA (unit, FormView backstops, 1024px browser footer test)
- scripts/check-phase19.6.1.sh, the fail-closed phase gate
- two production fixes found by the tests (password minimum, bulk lifecycle actions)
affects: [19.6.1 verify-work, 19.6 D-15 (Reset 2FA contribution), 19.7 (link action on Administrators), lagoon validation (deferred)]
actuals:
tokens: 43200
tasks: 4
commits: 9
plan_head_before: 1aaa8a444c5bdc59cf6f008de101186b25455922
plan_head_after: 8f3d62594356fce4ec1eb07af1a46240148b66e2
tech-stack:
added: []
patterns:
- "Postgres rule tests through the assembled admin handler with per-test seeded rows, t.Cleanup demote and soft-delete, and row_to_json snapshots for 'unchanged' checks"
- "Concurrency proven by holding the guard's advisory lock in a test transaction until pg_locks shows both requests waiting"
- "Vitest browser layout tests load the admin's Tailwind build (tailwindcss plugin in vitest.browser.config.ts)"
key-files:
created:
- modules/cabana/administrators_harness_test.go
- modules/cabana/administrators_postgres_test.go
- modules/cabana/administrators_lifecycle_postgres_test.go
- modules/cabana/backend_privileges_internal_test.go
- modules/cabana/action_extensions_test.go
- modules/cabana/action_extensions_postgres_test.go
- modules/cabana/roles_postgres_test.go
- modules/cabana/field_trigger_test.go
- modules/cabana/record_locks_test.go
- admin/tests/form/trigger.test.ts
- admin/tests/browser/record-actions-wrap.test.ts
- scripts/check-phase19.6.1.sh
- .planning/phases/19.6.1-backend-administrators-screen/deferred-items.md
modified:
- modules/cabana/backend_users_admin.go
- modules/cabana/export_test.go
- modules/cabana/backend_screens_test.go
- modules/cabana/backend_screens_smoke_test.go
- admin/tests/form/PermissionEditorField.test.ts
- admin/tests/form/formState.test.ts
- admin/tests/form/FormView.test.ts
- admin/tests/form/PreviewView.test.ts
- admin/vitest.browser.config.ts
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-VALIDATION.md
key-decisions:
- "The screens harness moved from backend_screens_smoke_test.go into administrators_harness_test.go and gained cleanup; its call keeps the existing (method, rel, token, body) order so Plan 01's smokes run unchanged"
- "The password minimum is enforced in usersAdmin.storePassword; the lagoon model validator's missing string min/max is deferred, because fixing it changes every model with string length rules"
- "The gate's name check covers every non-test file under modules/ and docs/ plus this phase's test files; older test files that name applications are outside the phase"
- "A hidden superuser's DELETE answers exactly what a missing id answers (200, deleted 0); the D-03 test asserts that equality instead of a 404"
patterns-established:
- "One rule, one named test: status, the en refusal text from UI-SPEC C8, and a byte-for-byte unchanged row"
- "Gate scripts list every required test by name and refuse skipped, zero-match or missing runs"
requirements-completed: [SC-1, SC-2, SC-3, D-03, D-04, D-05, D-06, D-07, D-08, D-09, D-10, D-11, D-12, D-14, D-15, D-16, D-17, D-18, D-19, D-20, D-21, D-22]
coverage:
- id: D1
description: "Save-path rules over HTTP on Postgres: superuser flag (D-05), hiding incl. scoped-token superusers (D-03), projection (Pitfall 1), permission and role ceilings (D-06, D-07), self edit (D-08), password and identity (D-11), outranking (D-19), own password (D-20)"
requirement: "D-05"
verification:
- kind: integration
ref: "modules/cabana/administrators_postgres_test.go#TestAdministratorsSuperuserFlag, TestAdministratorsSuperuserHidden, TestAdministratorsSuperuserProjected, TestAdministratorsPermissionCeiling, TestAdministratorsRoleCeiling, TestAdministratorsSelfEdit, TestAdministratorsPasswordAndIdentity, TestAdministratorsOutranked, TestAdministratorsOwnPassword"
status: pass
- kind: unit
ref: "modules/cabana/backend_privileges_internal_test.go#TestRoleCeiling"
status: pass
human_judgment: false
- id: D2
description: "Concurrent last-superuser protection on demote, record and bulk deactivate, form and bulk delete (held advisory lock, two waiters in pg_locks), plus ten unsynchronized rounds"
requirement: "D-09"
verification:
- kind: integration
ref: "modules/cabana/administrators_lifecycle_postgres_test.go#TestAdministratorsLastSuperuser"
status: pass
- kind: integration
ref: "modules/cabana/administrators_lifecycle_postgres_test.go#TestAdministratorsLastSuperuserConcurrent"
status: pass
human_judgment: false
- id: D3
description: "Lifecycle (Applies, 409, bulk Affected, soft delete keeps rows, trashed filter, hint precedence) and revocation (JWT and personal tokens after deactivate and delete, sessions after a password set, cutoff unchanged by restore and activate)"
requirement: "D-10"
verification:
- kind: integration
ref: "modules/cabana/administrators_lifecycle_postgres_test.go#TestAdministratorsLifecycle"
status: pass
- kind: integration
ref: "modules/cabana/administrators_lifecycle_postgres_test.go#TestAdministratorsRevocation"
status: pass
human_judgment: false
- id: D4
description: "D-14 seam: boot refusals and order (unit), offer and run only with both permissions, 409 when Applies turns false, Run in the transaction with the record (Postgres); activation only with an admin"
requirement: "D-14"
verification:
- kind: unit
ref: "modules/cabana/action_extensions_test.go#TestActionExtensionBoot"
status: pass
- kind: integration
ref: "modules/cabana/action_extensions_postgres_test.go#TestActionExtensionRun"
status: pass
- kind: unit
ref: "modules/cabana/backend_screens_test.go#TestBackendScreensActivation"
status: pass
human_judgment: false
- id: D5
description: "Roles: code taken and locked, plugin-declared system roles, in-use delete with soft-deleted holders, bulk delete rollback, permission ceiling"
requirement: "D-16"
verification:
- kind: integration
ref: "modules/cabana/roles_postgres_test.go#TestRolesLifecycle"
status: pass
- kind: integration
ref: "modules/cabana/roles_postgres_test.go#TestRolesPermissionCeiling"
status: pass
human_judgment: false
- id: D6
description: "D-21 server side: trigger boot rules, record-lock save rule in both modes, code-declared and own-record locks on Postgres"
requirement: "D-21"
verification:
- kind: unit
ref: "modules/cabana/field_trigger_test.go#TestFieldTriggerBoot"
status: pass
- kind: unit
ref: "modules/cabana/record_locks_test.go#TestPermissionRecordLocks"
status: pass
- kind: integration
ref: "modules/cabana/roles_postgres_test.go#TestRolesCodeDeclaredLocks"
status: pass
human_judgment: false
- id: D7
description: "D-21 SPA backstops: trigger disable, absent controlling field, hide-tab removal with the banner line, record-locked rows and payload omission, preview hide; footer wrap at 1024px with two 40-character contributed labels"
requirement: "D-21"
verification:
- kind: unit
ref: "admin/tests/form/trigger.test.ts, FormView.test.ts#field triggers on the form, PermissionEditorField.test.ts#permissions the record fixes, formState.test.ts#record permission locks in the save body, PreviewView.test.ts#field triggers on the preview"
status: pass
- kind: automated_ui
ref: "admin/tests/browser/record-actions-wrap.test.ts#backstop: wraps onto more than one row and no button overlaps Edit"
status: pass
human_judgment: false
- id: D8
description: "Phase gate: bash scripts/check-phase19.6.1.sh --all (self-test, go, admin, docs, sc1, docker) exits 0; SC-1 regression tests pass unchanged"
requirement: "SC-1"
verification:
- kind: integration
ref: "bash scripts/check-phase19.6.1.sh --all"
status: pass
human_judgment: false
- id: D9
description: "The screens render and behave in a real browser session (lists, forms, preview footer, toasts) as a superuser and as a limited administrator"
verification: []
human_judgment: true
rationale: "The VALIDATION manual-only item: visual and interactive SPA behaviour beyond the unit and layout tests needs a person at a running admin."
duration: 38min
completed: 2026-10-22
status: complete
---
# Phase 19.6.1 Plan 03: Privilege rule tests, D-21 SPA tests and the phase gate Summary
**Every privilege rule of the Administrators and Roles screens now has a named test against the assembled admin on Postgres, including the concurrent last-superuser race on all five reducing paths. The D-21 trigger and record-lock behaviour is tested in Go, in vitest and at 1024px in Chromium. `scripts/check-phase19.6.1.sh --all` proves the phase fail-closed. The tests found two production bugs, each fixed in its own commit: a password under 4 characters was accepted, and bulk lifecycle actions changed only the first selected administrator.**
## Performance
- **Duration:** ~38 min
- **Started:** 2026-10-22T09:47:03Z
- **Completed:** 2026-10-22T10:24:41Z
- **Tasks:** 4
- **Files modified:** 23 (3761 insertions, 274 deletions)
## Accomplishments
- **Test env (tracer).** `administrators_harness_test.go` holds the screens harness:
- `newScreensEnv(t, extra...)` assembles the admin with any extra plugins.
- `seedAdmin` and `seedRole` insert unique rows and register cleanup.
- Also `login`, `isolateSuperusers`, `call`/`serve` (with `X-Requested-With` on writes), and `userRow`/`roleRow` (`row_to_json` snapshots).
- The pinger plugin's `acme_ping` action now has a switchable `Applies`, plus a token scope over `backend.manage_users`.
- `export_test.go` exposes `SuperuserLockKey`.
- **Save-path rules (Task 2):**
- D-03: superusers stay hidden from a delegate in the list, under search and filters, on GET, the hint partial, record actions, PUT and DELETE (a DELETE answers exactly as for a missing id), in bulk selections, and in both schemas. A superuser's scoped personal token is treated the same way; a `*` token is not.
- D-05: only a superuser may send the switch, true or false, on create or update.
- Pitfall 1: saving the SPA payload of an untouched superuser record keeps the flag.
- D-06/D-07: permission and role ceilings. A stored locked override is kept. A user-level deny is merged last and shuts the delegate out of the screen. An above-ceiling role the target already holds is kept.
- D-08: self-edit limits. D-11: password rules and unique identity. D-19: the delegate is outranked on all eleven write paths. D-20: own password.
- `TestRoleCeiling` covers `grantsCovered`.
- **Race and lifecycle (Task 3):**
- `TestAdministratorsLastSuperuser` has five literal subtests. In each, a test transaction holds `pg_advisory_xact_lock(SuperuserLockKey)` until `pg_locks` shows two ungranted advisory locks. Exactly one 2xx, one 403 with the last_superuser text, one superuser left, no 500 or deadlock. Stable across `-count=4`.
- `TestAdministratorsLastSuperuserConcurrent` runs ten unsynchronized rounds.
- Lifecycle and revocation tests (two-row bulk selections included).
- The seam: `TestActionExtensionBoot` (all refusals and the declared order) and `TestActionExtensionRun`.
- Roles: `TestRolesLifecycle` and `TestRolesPermissionCeiling`.
- `TestBackendScreensActivation`.
- **D-21 and the gate (Task 4):**
- Go: `TestFieldTriggerBoot`, `TestPermissionRecordLocks` (radio and checkbox), `TestRolesCodeDeclaredLocks`.
- SPA:
- `trigger.test.ts` (11 tests).
- FormView backstops: disable, absent controlling field, hide-tab removal with the banner line, and the live announcement.
- PermissionEditorField and formState: record-locked rows.
- PreviewView: hide.
- The 1024px browser footer test.
- The gate script and the filled validation map.
## Task Commits
1. **Task 1 (tracer): screens test env and the superuser flag rule.** `536ea8c` (test). Tracer gate: the `<verify>` was re-run end to end and passed before Task 2.
2. **Task 2: save-path rule tests.** `461cb21` (fix, deviation 1), `b684bb7` (test)
3. **Task 3: race, lifecycle, revocation, seam and roles.** `8324070` (fix, deviation 2), `1a56294` (test)
4. **Task 4: D-21 tests, gate, validation map.** `085179b` (test, Go), `4c61a18` (test, SPA), `7842aca` (chore, gate), `8f3d625` (docs, validation map and deferred items)
## Files Created/Modified
- `modules/cabana/administrators_harness_test.go`: the shared Postgres screens env (moved from `backend_screens_smoke_test.go` and extended).
- `modules/cabana/administrators_postgres_test.go`: the nine save-path rule tests.
- `modules/cabana/administrators_lifecycle_postgres_test.go`: the race helper and the lifecycle and revocation tests.
- `modules/cabana/backend_privileges_internal_test.go`: `TestRoleCeiling`.
- `modules/cabana/action_extensions_test.go`, `action_extensions_postgres_test.go`: the D-14 seam.
- `modules/cabana/roles_postgres_test.go`: Roles and code-declared locks.
- `modules/cabana/field_trigger_test.go`, `record_locks_test.go`: D-21 unit tests.
- `modules/cabana/backend_screens_test.go`: `TestBackendScreensActivation`.
- `modules/cabana/backend_users_admin.go`: the two fixes.
- `admin/tests/form/*.test.ts`, `admin/tests/browser/record-actions-wrap.test.ts`, `admin/vitest.browser.config.ts`: the SPA tests.
- `scripts/check-phase19.6.1.sh`: the gate.
## Decisions Made
- I reused the Plan 01 harness rather than building a second one. The file is now `administrators_harness_test.go`, as the plan names it. The existing `call(t, method, rel, token, body)` argument order stayed, so the four Plan 01 smokes run unchanged.
- The D-07 "above-ceiling role kept" case uses a holder whose override denies the extra grant. Without that the holder would outrank the delegate (D-19), and no save could reach the role check.
- "The override merged last" is shown through route access (a deny of `backend.manage_users` returns 403 on the list), because `/auth/me` does not expose permissions.
- The gate's docs stage checks non-test sources plus this phase's test files. Older lagoon and postcard tests name applications, and that is pre-existing.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] The Administrators form accepted a 3-character password**
- **Found during:** Task 2 (`TestAdministratorsPasswordAndIdentity/too_short` got 201)
- **Issue:** `FormRules` declares `min:4`, but `lagoon.Validate` (the model validator) collects string `min`/`max` tags and then skips them, so the rule never applied. D-11 was not enforced.
- **Fix:** `usersAdmin.storePassword` now refuses a typed password under `adminPasswordMinChars` (4) characters (counted with `utf8.RuneCountInString`). It answers 422 on `password` with the `min.string` text, next to the existing 72-byte check. The lagoon gap is logged in deferred-items.md.
- **Files modified:** modules/cabana/backend_users_admin.go
- **Verification:** the test passes with "at least 4 characters"; `go test -short ./...` is green.
- **Committed in:** `461cb21`
**2. [Rule 1 - Bug] Bulk activate, deactivate and restore changed only the first selected administrator**
- **Found during:** Task 3 (`TestAdministratorsLifecycle`: bulk deactivate reported `affected: 2`, but the second row stayed active)
- **Issue:** `actionDB` returned the `Unscoped()` instance of a NewDB session. GORM conditions accumulate on that instance, so the second `Where("id = ?")` update matched `id = A AND id = B` (no row) while still being counted. A bulk deactivate therefore left every row after the first active and signed in, which breaks D-10 and D-12 revocation.
- **Fix:** `actionDB` now ends with `.Session(&gorm.Session{})`, so every query starts fresh.
- **Files modified:** modules/cabana/backend_users_admin.go
- **Verification:** `TestAdministratorsLifecycle` checks stored rows after the bulk calls. `TestAdministratorsRevocation` now ends two sessions and two personal tokens in one bulk deactivate and one bulk delete. Plan 01's lifecycle smoke still passes.
- **Committed in:** `8324070`
**3. [Rule 3 - Blocking] The browser layout test needs the admin's CSS**
- **Found during:** Task 4.
- **Issue:** `vitest.browser.config.ts` had no Tailwind plugin, so a footer mounted with the real classes would have no layout.
- **Fix:** I added `tailwindcss()` to the browser config. The test imports `src/styles/main.css` and copies the footer classes from PreviewView.vue. The richeditor browser tests are unaffected.
- **Files modified:** admin/vitest.browser.config.ts (not in the plan's file list)
- **Committed in:** `4c61a18`
**4. Commit scope.** Commits use `(19.6.1-03)` as the orchestrator instructed: `test`, `chore` for the script, `docs` for the planning files. The two production fixes use `fix(cabana)`, as the plan requires. There are no co-author tags.
**5. Assertions adapted to built behaviour (no rule weakened).**
- A hidden superuser's DELETE returns the framework's "deleted 0" answer, identical to a missing id, so it reveals nothing. The test asserts that equality instead of a 404.
- Own overrides are refused through the record lock ("You cannot change this permission.") before the `self_privileged` check. The test asserts the 403 on `permissions` and an unchanged row.
- One TestRoleCeiling case (`*.manage` held covering `acme.manage`) was dropped: `granted` does not expand held leading wildcards. That is pre-existing behaviour, logged in deferred-items.md.
---
**Total deviations:** 3 auto-fixed (2 bugs, 1 blocking), plus 2 notes.
**Impact on plan:** The two fixes close real gaps in D-11 and D-10/D-12 on the server. There is no scope creep.
## TDD Gate Compliance
The tasks are marked `tdd="true"`, but this plan is the project's "unit tests last" plan: it tests behaviour Plans 01 and 02 built. So most tests passed on first run, and there are no `feat(19.6.1-03)` commits. Where a test failed because the code was wrong (deviations 1 and 2), the failing test came first and the fix went into its own `fix(cabana)` commit.
## Verification
- `go vet ./...`, `go test -short ./...`, `go -C examples/hello test ./...`: pass. These ran inside the gate's go stage and after each task.
- Docker-backed tests ran directly (the Docker socket was accessible):
- `go test ./modules/cabana ./modules/surf`: pass.
- The gate's docker stage passed: 21 Postgres rule and smoke tests by name, 10 SC-1 regression tests, and 162 surf tests.
- `npm --prefix admin run typecheck`: pass. `npm --prefix admin run test`: 94 files, 1461 tests pass. `npm --prefix admin run test:browser`: 2 files, 8 tests pass.
- `scripts/check-admin-openapi.sh --check` and `scripts/check-admin-dist.sh`: pass, and the dist is unchanged.
- `bash scripts/check-phase19.6.1.sh --all`: **exit 0**, "Phase 19.6.1 gate passed". PASS for self-test, go, admin, docs, sc1 and docker; no NOT RUN.
- SC-1: 17 commits since `88ec4df`; no phase commit touches commands.go, token_commands.go or account.go.
- Every acceptance grep of the four tasks prints the expected count.
## Issues Encountered
None blocking. Two out-of-scope findings are in deferred-items.md:
- lagoon's model validator skips string `min`/`max`, so for example an over-long `login` reaches Postgres as a 500 instead of a 422.
- `granted` does not expand a held leading wildcard.
## Known Stubs
None.
## Threat Flags
None. The two fixes tighten existing surface (T-19.6.1-07, T-19.6.1-11). T-19.6.1-24..27 are mitigated:
- every rule has a named test, and the gate requires each name;
- the race is forced on every path;
- `isolateSuperusers`, unique rows and cleanup keep tests apart, and there is no `t.Parallel`;
- the name check covers the phase's tests.
No package was added.
## User Setup Required
None.
## Next Phase Readiness
- Phase 19.6.1 is complete. Its last plan is done, and the gate is ready as input for `/msd-verify-work`.
- Manual UAT remains: the screens in a real browser session, as a superuser and as a limited administrator (VALIDATION manual-only row).
- Before the next release tag, it is worth looking at the lagoon string `min`/`max` gap (deferred-items.md).
---
*Phase: 19.6.1-backend-administrators-screen*
*Completed: 2026-10-22*
## Self-Check: PASSED

View File

@@ -0,0 +1,302 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 04
type: execute
wave: 4
depends_on: ["19.6.1-01", "19.6.1-02", "19.6.1-03"]
files_modified:
- modules/cabana/backend_roles_admin.go
- modules/cabana/action_extensions.go
- modules/cabana/roles_postgres_test.go
- modules/cabana/action_extensions_postgres_test.go
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/cabana/README.md
- docs/backend/admin-controllers.md
- scripts/check-phase19.6.1.sh
autonomous: true
gap_closure: true
gap_ids: [G-19.6.1-1, G-19.6.1-2]
requirements: [SC-2, D-07, D-16, D-19]
estimate:
tokens: 55000
raw_tokens: 55000
tasks: 3
confidence: low
must_haves:
truths:
- "SC-2 / D-07: an admin cannot raise their own role or permissions, and a non-superuser cannot add a permission they lack to any role (Roles screen ceiling)"
- "D-19: a non-superuser holding backend.manage_users gets 403 user.outranked when running a record action on a non-superuser admin whose effective grants they do not cover"
- "D-16: a role never becomes a code-declared system role through the Roles screen. FormBeforeCreate and FormBeforeUpdate refuse a submitted code when len(reg.rolePermissions(newCode)) is greater than 0 and newCode is not the stored code (empty stored code on create). The save answers 422 with backend::lang.user.role.code_locked on code and the role row is unchanged (or never inserted)."
artifacts:
- path: "modules/cabana/backend_roles_admin.go"
provides: "Roles hooks refuse a new code that code-declared grants attach to"
contains: "rolePermissions("
- path: "modules/cabana/action_extensions.go"
provides: "contributed Run on AdministratorsControllerID wrapped with guardOutranked"
contains: "wrapAdministratorsContributedRun"
- path: "modules/cabana/roles_postgres_test.go"
provides: "CR-01 regression: rename and create onto a code-declared code"
contains: "TestRolesCodeDeclaredCodeRefused"
- path: "modules/cabana/action_extensions_postgres_test.go"
provides: "WR-03 regression: contributed action on an outranking target"
contains: "TestActionExtensionOutranked"
- path: "scripts/check-phase19.6.1.sh"
provides: "gate REQUIRE lists both new Postgres tests by name"
contains: "TestRolesCodeDeclaredCodeRefused"
- path: "modules/pact/capabilities.go"
provides: "AdminActionExtension docs state the Administrators privilege rule"
contains: "user.outranked"
key_links:
- from: "modules/cabana/backend_roles_admin.go"
to: "modules/cabana/registry.go"
via: "both Roles hooks consult rolePermissions of the submitted code, not only the stored one"
pattern: "rolePermissions\\("
- from: "modules/cabana/action_extensions.go"
to: "modules/cabana/backend_privileges.go"
via: "compileActionExtensions wraps contributed Run so guardOutranked runs inside the action transaction before the contributor"
pattern: "guardOutranked\\("
- from: "scripts/check-phase19.6.1.sh"
to: "modules/cabana/roles_postgres_test.go"
via: "the docker stage requires the CR-01 test by name"
pattern: "TestRolesCodeDeclaredCodeRefused"
- from: "scripts/check-phase19.6.1.sh"
to: "modules/cabana/action_extensions_postgres_test.go"
via: "the docker stage requires the WR-03 test by name"
pattern: "TestActionExtensionOutranked"
prohibitions:
- statement: "Do not take the weaker position that contributors own authorization on Administrators. Wrap in cabana. Do not export guardOutranked as the fix."
status: unresolved
verification: judgment
- statement: "Do not edit 19.6.1-01-PLAN.md, 19.6.1-02-PLAN.md, or 19.6.1-03-PLAN.md. Do not change SPA UI, phrasebook keys, commands.go, token_commands.go, or account.go."
status: unresolved
verification: judgment
- statement: "Framework code, READMEs, docs and tests name no consuming application; no new dependency is added and YAML stays on goccy/go-yaml."
status: unresolved
verification: judgment
---
## Phase Goal
ROADMAP Goal (not a user story; MVP mode off): cabana gets WinterCMS's Administrators screens with privilege rules on the server.
This plan's slice (plan 4 of 4, wave 4, gap_closure): close the two VERIFICATION.md `gaps:` items. G-19.6.1-1 / CR-01 (blocker, SC-2 + D-07, also D-16): a non-superuser holding `backend.manage_roles` can create or rename a role onto a code that `pact.Permission.Roles` attaches grants to. G-19.6.1-2 / WR-03 (D-19): contributed record actions targeting `AdministratorsControllerID` skip `guardOutranked`. Ignore `deferred:`, human_verification, WR-01, WR-02, and IN-01..IN-06.
## Spec-less probe fallback
Spec-less probe fallback skipped: phase has no requirement IDs to probe (visible skip). REQUIREMENTS.md maps none to 19.6.1. Edge rows that this gap work can affect are lifted from 19.6.1-UI-SPEC.md "UI Considerations" into the UI Considerations section below (Roles form 422 on Code; record-action 403 danger toast). Prohibitions recalled by hand.
## Discovery
Level 0: existing cabana hooks, `guardOutranked`, `compileActionExtensions`, and the Plan 03 harness. No new dependency.
## Decisions taken in this plan
- Stricter D-16 reading (gap contract): refuse in both Roles hooks when `len(reg.rolePermissions(newCode))` is greater than 0 and `newCode != storedCode`. A role never becomes a code-declared system role through the screen, including when the editor is a superuser. Reuse 422 `backend::lang.user.role.code_locked` on `code` (UI-SPEC C8 D-16 field error). Do not add a phrase key.
- D-19 wrap in cabana (gap contract): when `ext.Controller == AdministratorsControllerID`, replace each contributed `Run` with a wrapper that calls `guardOutranked(ctx, reg, principal, record.(*BackendUser))` inside the existing `CRUDService.RecordAction` transaction before the contributor's `Run`. Do not export `guardOutranked`. Do not document that contributors apply the check themselves.
- Existing helpers `roleGrantSet` / `grantsCovered` stay as they are. The Roles hooks use `rolesAdmin.registry().rolePermissions(newCode)`, the same source `systemRole` already uses for the stored code.
- Test names: `TestRolesCodeDeclaredCodeRefused` (package cabana_test, `roles_postgres_test.go`) and `TestActionExtensionOutranked` (package cabana_test, `action_extensions_postgres_test.go`). Both are added to `DOCKER_TESTS` in `scripts/check-phase19.6.1.sh`.
## Source coverage (this gap plan)
| Source | Item | Plan | Status |
|---|---|---|---|
| VERIFICATION gaps | G-19.6.1-1 / CR-01 | 04 | COVERED |
| VERIFICATION gaps | G-19.6.1-2 / WR-03 | 04 | COVERED |
| CONTEXT | D-07 Roles screen ceiling (code path) | 04 | COVERED |
| CONTEXT | D-16 system role never created through the screen | 04 | COVERED |
| CONTEXT | D-19 no outranking on record actions, contributed included | 04 | COVERED |
| GOAL / SC-2 | an admin cannot raise their own permissions | 04 | COVERED |
| REQ | phase_req_ids null | — | skipped (visible) |
| VERIFICATION deferred / WR-01 / WR-02 / IN-01..IN-06 / human_verification | out of gap-closure scope | — | excluded |
Plans 01-03 remain COVERED for D-01..D-22 except the two failed truths this plan re-closes. No MISSING rows.
## UI Considerations
This gap plan does not change SPA UI. Lifted from 19.6.1-UI-SPEC.md only the surfaces the two refusals already use:
| Category | Element | Status | Resolution |
|----------|---------|--------|------------|
| error | Roles form refusals | covered | A create or rename onto a code-declared code answers 422 with `user.role.code_locked` under Code (same C8 mapping as a system-role code change). Field line plus the existing count banner. Values and dirty state stay. |
| error | Record action refused (403) | covered | A contributed action on an outranking Administrators target answers 403 `user.outranked`. PreviewView already shows a danger toast with `error.message` (C8 D-19 row). No SPA change. |
## Artifacts this phase produces
- cabana unexported: `wrapAdministratorsContributedRun(reg *Registry, next func(context.Context, pact.AdminRecordActionInput) (pact.AdminRecordActionResult, error))` in `action_extensions.go`; Roles helper that refuses a submitted code when `rolePermissions` of that code is non-empty and the code is not the stored one (name at executor discretion, called from `FormBeforeCreate` and `FormBeforeUpdate`).
- Go tests: `TestRolesCodeDeclaredCodeRefused`, `TestActionExtensionOutranked`.
- Gate REQUIRE entries on `DOCKER_TESTS`: `TestRolesCodeDeclaredCodeRefused`, `TestActionExtensionOutranked`.
- Docs: `AdminActionExtension` comment in `modules/pact/capabilities.go`; one sentence each in `modules/pact/README.md` (`AdminActionExtension` / `HasAdminActionExtensions` rows), `modules/cabana/README.md` (record-action-extension Features bullet), and `docs/backend/admin-controllers.md` (Adding record actions to another controller).
<objective>
Close G-19.6.1-1 (CR-01) and G-19.6.1-2 (WR-03): refuse a Roles create or rename onto a code-declared code, and wrap contributed Administrators record-action Runs with guardOutranked before the contributor runs.
Purpose: SC-2, D-07, D-16, D-19. The two VERIFICATION.md failed truths become true.
Output: two hook/wrap changes, two named Postgres tests, gate REQUIRE lines, seam docs. No SPA change. Skip git commit (orchestrator commits). Skip STATE.md raw edits.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-CONTEXT.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-RESEARCH.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-PATTERNS.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-VERIFICATION.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-UI-SPEC.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-SUMMARY.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-03-SUMMARY.md
Concurrency and commits: 19.6, 19.7 and 19.8 may still touch cabana. Before each task run `git status --porcelain -- modules/cabana modules/pact docs scripts/check-phase19.6.1.sh` and stop if a file this task edits carries someone else's uncommitted change. Stage by explicit path, never `git add -A`; leave STATE.md and state.json alone; no co-author tags. The orchestrator commits after the checker — do not git commit from this plan. Docker-backed tests skip under -short; on this host run them, through `sudo -u golem` if the Docker socket is denied (CLAUDE.md); a Docker test that could not run is NOT RUN in the SUMMARY, never passed.
<interfaces>
- rolesAdmin.FormBeforeCreate (backend_roles_admin.go:160) currently only `checkCode` (uniqueness). FormBeforeUpdate (171) re-reads stored id/code/is_system, refuses `systemRole(stored.IsSystem, stored.Code) && role.Code != stored.Code` with ValidationError details.code = rolesLang + "code_locked", then checkCode. systemRole (85) is is_system or len(registry().rolePermissions(code)) greater than 0. checkCode (193) counts other rows with the same code. rolesLang = "backend::lang.user.role.". writeDB / asRole already exist.
- Registry.rolePermissions(role string) map[string]bool (registry.go:451). FindByID merges those grants (auth.go:55).
- guardOutranked(ctx, reg, editor, target) (backend_privileges.go:123) returns ForbiddenError Message "backend::lang.user.outranked"; needs TxFromContext; superuser and own record pass. actsAsSuperuser, effectiveGrants, grantsCovered stay unused on a new role code.
- compileActionExtensions (action_extensions.go:23) copies each pact.AdminRecordAction into cc.RecordActions after checkContributedAction. CRUDService.RecordAction (crud.go:604-629) sets withTx, loadRecord FOR UPDATE, Applies, then action.Run. lifecycleFailure passes *ForbiddenError through, so a wrapper that returns guardOutranked's error is 403 like built-in deactivate.
- AdministratorsControllerID = "summercms.cabana.users" (backend_screens.go:25).
- Harness (administrators_harness_test.go): newScreensEnv, grantPlugin, pingPlugin / pingSpy, seedAdmin, seedRole, login, expectFieldRefusal, expectRefusal, roleRow, roleExists, enCodeLocked, enOutranked, pingPermission, manageUsers. TestRolesLifecycle already uses grantPlugin with a unique declared code that then gets a row; CR-01 needs a declared code with no row. TestAdministratorsOutranked seeds a delegate with PermissionManageUsers + pingPermission and a target whose role grants acme.demo.access. TestActionExtensionRun posts acme_ping and asserts spy.runs().
- Gate: scripts/check-phase19.6.1.sh DOCKER_TESTS array (lines 67-84), consumed by go_named in run_docker.
</interfaces>
</context>
<tasks>
<task type="tracer">
<name>Task 1: End-to-end — refuse a Roles code-declared capture and wrap contributed Administrators Runs with guardOutranked</name>
<precondition>Plans 01-03 are on disk and compiled: backend_roles_admin.go has FormBeforeCreate, FormBeforeUpdate, checkCode, and systemRole; action_extensions.go has compileActionExtensions; administrators_harness_test.go has newScreensEnv, grantPlugin, pingPlugin, expectFieldRefusal, expectRefusal, roleRow, enCodeLocked, and enOutranked.</precondition>
<reversibility rating="reversible">Hook and wrapper changes behind existing Roles and RecordAction paths; no published symbol or on-disk format changes.</reversibility>
<files>modules/cabana/backend_roles_admin.go, modules/cabana/action_extensions.go, modules/cabana/roles_postgres_test.go, modules/cabana/action_extensions_postgres_test.go</files>
<read_first>modules/cabana/backend_roles_admin.go, modules/cabana/backend_privileges.go, modules/cabana/action_extensions.go, modules/cabana/roles_postgres_test.go, modules/cabana/action_extensions_postgres_test.go, modules/cabana/administrators_postgres_test.go, modules/cabana/administrators_harness_test.go, modules/cabana/crud.go, modules/pact/capabilities.go, scripts/check-phase19.6.1.sh, .planning/phases/19.6.1-backend-administrators-screen/19.6.1-VERIFICATION.md, .planning/phases/19.6.1-backend-administrators-screen/19.6.1-UI-SPEC.md</read_first>
<action>Close G-19.6.1-1 (CR-01, SC-2, D-07, D-16) and G-19.6.1-2 (WR-03, D-19) in one production-quality slice, then prove both holes through the assembled handler on Postgres. Do not edit backend_privileges.go. Do not export guardOutranked. Do not add a phrase key.
Roles (backend_roles_admin.go), per D-16 stricter reading and D-07: add a helper on rolesAdmin that takes the submitted role and the stored code (empty string on create). When the submitted code is not the stored code and len(c.registry().rolePermissions(submitted code)) is greater than 0, return a ValidationError with Details code listing rolesLang + "code_locked" (the same 422 shape FormBeforeUpdate already uses for a stored system role). Call it from FormBeforeCreate after asRole and before or after checkCode. Call it from FormBeforeUpdate after the stored-row read, using stored.Code, in addition to the existing systemRole(stored.IsSystem, stored.Code) refusal. Keep checkCode uniqueness. A keep-the-same-code save of a system role still reaches 200. Superusers are refused the same way: a role never becomes a code-declared system role through this screen.
Seam (action_extensions.go), per D-19: after checkContributedAction succeeds and before the action is stored on cc.RecordActions, when ext.Controller equals AdministratorsControllerID, replace action.Run with wrapAdministratorsContributedRun(reg, action.Run). wrapAdministratorsContributedRun returns a func(ctx, pact.AdminRecordActionInput) (pact.AdminRecordActionResult, error) that: reads the principal with bouncer.User(ctx); type-asserts in.Record to a BackendUser pointer; if the assert fails or the pointer is nil, returns an error that names Administrators and does not call next; otherwise calls guardOutranked(ctx, reg, principal, user) and, on a non-nil error, returns that error without calling next; on nil, returns next(ctx, in). The wrap runs inside CRUDService.RecordAction's transaction (withTx already set, row locked) so guardOutranked sees TxFromContext. Contributions to any other controller ID are stored unchanged. Applies is not wrapped.
TestRolesCodeDeclaredCodeRefused in roles_postgres_test.go (package cabana_test): newScreensEnv with a grantPlugin whose pact.Permission.Roles names a unique code that has no backend_user_roles row (the CR-01 precondition). Seed a non-superuser editor whose role grants only PermissionManageRoles, and a mutable role that editor may edit. PUT of that role with code set to the declared code answers 422, details.code carries enCodeLocked, and roleRow is unchanged. POST to rolesPath with a new name and the declared code answers 422, details.code carries enCodeLocked, and no row with that code exists (roleExists / count). A superuser PUT or POST onto the same declared code is also 422 with the row unchanged. A unique non-declared code still creates (201) and a same-code update of a system role still saves, so TestRolesLifecycle stays valid.
TestActionExtensionOutranked in action_extensions_postgres_test.go (package cabana_test): newScreensEnv (pingPlugin already contributes acme_ping). Seed a delegate with RolePermissions PermissionManageUsers plus pingPermission (same shape as TestAdministratorsOutranked) and an outranking target whose role grants acme.demo.access. POST userURL(target.ID, "actions", "acme_ping") as the delegate answers 403, expectRefusal with enOutranked, and spy.runs() is empty. Built-in deactivate on that target still answers 403 enOutranked. A covered target (no extra grant) still runs acme_ping (200, spy records that id, TxFromContext true), so TestActionExtensionRun is not weakened.
Reuse expectFieldRefusal, expectRefusal, roleRow, roleBody, roleURL, seedAdmin, seedRole, grantPlugin, enCodeLocked, enOutranked. Unique names from env.stamp / nanosecond. t.Cleanup deletes seeded roles and demotes/soft-deletes seeded admins. Tests name no consuming application.</action>
<verify>
<automated>go vet ./... &amp;&amp; go test -count=1 -short ./modules/cabana/... ./modules/pact/... ./modules/surf/...</automated>
<fails_when>non-zero exit from vet or the short suite, or a compile error naming wrapAdministratorsContributedRun, FormBeforeCreate, or FormBeforeUpdate</fails_when>
<automated>go test -count=1 -run '^(TestRolesCodeDeclaredCodeRefused|TestActionExtensionOutranked)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c -- '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>Fewer than 2 top-level "--- PASS: Test" lines: a new test failed, was renamed, or printed "--- SKIP" because Docker was unreachable (rerun through sudo -u golem, else NOT RUN)</fails_when>
<automated>go test -count=1 -run '^(TestRolesLifecycle|TestRolesPermissionCeiling|TestActionExtensionRun)$' -v ./modules/cabana 2&gt;&amp;1 | grep -c -- '^--- PASS: Test' | grep -qx 3</automated>
<fails_when>Fewer than 3 top-level "--- PASS: Test" lines among the existing Roles and seam tests (failed, renamed, or skipped)</fails_when>
</verify>
<acceptance_criteria>
- `grep -n 'func (c rolesAdmin) FormBeforeCreate' -A 20 modules/cabana/backend_roles_admin.go | grep -c 'rolePermissions('` prints at least 1, or FormBeforeCreate calls a helper whose body contains `rolePermissions(`.
- `grep -n 'func (c rolesAdmin) FormBeforeUpdate' -A 30 modules/cabana/backend_roles_admin.go | grep -c 'rolePermissions('` prints at least 1, or FormBeforeUpdate calls that same helper with stored.Code.
- `grep -c 'code_locked' modules/cabana/backend_roles_admin.go` prints at least 2 (stored system-role change and new-code capture).
- `grep -c 'func wrapAdministratorsContributedRun(' modules/cabana/action_extensions.go` prints 1 and `grep -c 'guardOutranked(' modules/cabana/action_extensions.go` prints at least 1.
- `grep -c 'AdministratorsControllerID' modules/cabana/action_extensions.go` prints at least 1.
- `grep -c '^func TestRolesCodeDeclaredCodeRefused(' modules/cabana/roles_postgres_test.go` prints 1.
- `grep -c '^func TestActionExtensionOutranked(' modules/cabana/action_extensions_postgres_test.go` prints 1.
- `head -1 modules/cabana/roles_postgres_test.go` prints `package cabana_test` and `head -1 modules/cabana/action_extensions_postgres_test.go` prints `package cabana_test`.
- `grep -ciE 'fonoteka|plytarium|grzyby|wavepath' modules/cabana/roles_postgres_test.go modules/cabana/action_extensions_postgres_test.go` prints 0 for each file.
</acceptance_criteria>
<done>A non-superuser cannot capture code-declared grants through a Roles create or rename, and a contributed acme_ping on an outranking Administrators target is 403 user.outranked with Run not called. Both paths are proven on Postgres.</done>
</task>
<task type="auto">
<name>Task 2: Document the Administrators privilege rule on the D-14 seam</name>
<reversibility rating="costly">Tightens the published pact.AdminActionExtension contract that 19.7's link action implements; undo is a docs revert plus any plugin that relied on the hole.</reversibility>
<files>modules/pact/capabilities.go, modules/pact/README.md, modules/cabana/README.md, docs/backend/admin-controllers.md</files>
<read_first>modules/pact/capabilities.go, modules/pact/README.md, modules/cabana/README.md, docs/backend/admin-controllers.md, modules/cabana/action_extensions.go, .planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-SUMMARY.md</read_first>
<action>Per D-19 and D-18 (docs in the same change as the exported-API comment). After Task 1's wrap exists, state the Administrators privilege rule in four places. Do not name a consuming application. Do not say contributors apply the check.
modules/pact/capabilities.go AdminActionExtension comment (currently lines 378-398): after the sentence that an administrator needs the target controller's RequiredPermissions and the action's own Permissions, add that when Controller is the admin's Administrators screen (summercms.cabana.users), cabana runs its outranking check inside the action transaction before the contributor's Run; a non-superuser whose grants do not cover the target's effective grants gets 403 with backend::lang.user.outranked and Run is not called. Keep the boot-error paragraph.
modules/pact/README.md API table: on the `pact.AdminActionExtension` row, append that a contribution to summercms.cabana.users is refused with user.outranked when the target outranks the caller. On the `pact.HasAdminActionExtensions` row, do not claim the contributor owns that authorization.
modules/cabana/README.md Features bullet that starts "Record actions on another plugin's controller": append one sentence that contributions targeting cabana.AdministratorsControllerID run guardOutranked before Run (403 user.outranked, Run not called).
docs/backend/admin-controllers.md section "Adding record actions to another controller": after the bullet that both RequiredPermissions and the action's Permissions apply, add a bullet that a contribution to summercms.cabana.users / cabana.AdministratorsControllerID is also refused with 403 user.outranked when the target administrator's effective grants are not a subset of the caller's, and that cabana applies this before Run so the contributor does not. Leave the src= example and the no-input sentence.
Every new identifier you name (AdministratorsControllerID, AdminActionExtension, user.outranked) already exists. After the edits, `go test ./cmd/summer -run TestDocsTree` and `go run ./cmd/summer docs:build --check` stay green.</action>
<verify>
<automated>go test -count=1 -run '^TestDocsTree$' -v ./cmd/summer 2&gt;&amp;1 | grep -q -- '^--- PASS: TestDocsTree'</automated>
<fails_when>non-zero exit or no "--- PASS: TestDocsTree" line</fails_when>
<automated>go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, or output contains "unknown identifier" or "broken link"</fails_when>
</verify>
<acceptance_criteria>
- `grep -c 'user.outranked' modules/pact/capabilities.go` prints at least 1 and `grep -c 'summercms.cabana.users' modules/pact/capabilities.go` prints at least 1.
- `grep -c 'user.outranked' modules/pact/README.md` prints at least 1.
- `grep -c 'AdministratorsControllerID' modules/cabana/README.md` prints at least 1 and `grep -c 'user.outranked' modules/cabana/README.md` prints at least 1.
- `grep -c 'user.outranked' docs/backend/admin-controllers.md` prints at least 1.
- `grep -ciE 'fonoteka|plytarium|grzyby|wavepath' modules/pact/capabilities.go modules/pact/README.md modules/cabana/README.md docs/backend/admin-controllers.md` prints 0 for each file.
</acceptance_criteria>
<done>The published seam docs state that cabana, not the contributor, applies the Administrators outranking rule.</done>
</task>
<task type="auto">
<name>Task 3: Require the two new Postgres tests in the phase gate</name>
<reversibility rating="reversible">One array in a check script.</reversibility>
<files>scripts/check-phase19.6.1.sh</files>
<read_first>scripts/check-phase19.6.1.sh, modules/cabana/roles_postgres_test.go, modules/cabana/action_extensions_postgres_test.go</read_first>
<action>Per D-18 and the gap missing items. In scripts/check-phase19.6.1.sh, add TestRolesCodeDeclaredCodeRefused and TestActionExtensionOutranked to the DOCKER_TESTS array next to TestRolesLifecycle / TestActionExtensionRun (the docker stage's go_named REQUIRE list). Do not add them to SHORT_TESTS (they need Postgres). Do not change detect_go, run_docker, or SC1_TESTS. After the edit, `grep -n 'DOCKER_TESTS' -A 20` shows both names, and `bash scripts/check-phase19.6.1.sh --docker` still fail-closes on a missing name.</action>
<verify>
<automated>grep -E 'TestRolesCodeDeclaredCodeRefused|TestActionExtensionOutranked' scripts/check-phase19.6.1.sh | grep -v '^#' | grep -c 'Test' | grep -qx 2</automated>
<fails_when>the filtered count is not exactly 2: a name is missing, commented out, or duplicated</fails_when>
<automated>bash scripts/check-phase19.6.1.sh --docker</automated>
<fails_when>non-zero exit, or a line starting "refuse:", or detect_go reports a missing named test; a "NOT RUN docker" line is acceptable only when no Docker daemon answers and must be recorded in the SUMMARY</fails_when>
</verify>
<acceptance_criteria>
- `grep -c 'TestRolesCodeDeclaredCodeRefused' scripts/check-phase19.6.1.sh` prints at least 1.
- `grep -c 'TestActionExtensionOutranked' scripts/check-phase19.6.1.sh` prints at least 1.
- `awk '/^DOCKER_TESTS=/,/^)/' scripts/check-phase19.6.1.sh | grep -c 'TestRolesCodeDeclaredCodeRefused'` prints 1 and `awk '/^DOCKER_TESTS=/,/^)/' scripts/check-phase19.6.1.sh | grep -c 'TestActionExtensionOutranked'` prints 1.
- `awk '/^SHORT_TESTS=/,/^)/' scripts/check-phase19.6.1.sh | grep -cE 'TestRolesCodeDeclaredCodeRefused|TestActionExtensionOutranked'` prints 0.
</acceptance_criteria>
<done>The phase gate refuses a tree that drops either new test by name.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| admin SPA / API client → cabana Roles and Administrators APIs | Request bodies (role code, record-action name) are untrusted; the principal comes from the JWT or personal token guard |
| admin with backend.manage_roles → role codes that plugins attach grants to | A delegated editor can type any fillable code; code-declared grants attach by string |
| contributing plugin → Administrators record-action Run | Plugin code runs inside the target's transaction behind the target's permission |
## STRIDE Threat Register
Threat IDs continue after T-19.6.1-27 (plans 01-03). T-19.6.1-SC is reserved and kept.
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.6.1-28 | Elevation | rolesAdmin.FormBeforeUpdate submitted code | critical | mitigate | refuse when the new code has code-declared grants and differs from the stored code; 422 code_locked; row unchanged (CR-01 / SC-2 / D-07 / D-16) |
| T-19.6.1-29 | Elevation | rolesAdmin.FormBeforeCreate submitted code | critical | mitigate | same refusal on create (stored code empty); 422 code_locked; no row inserted |
| T-19.6.1-30 | Elevation | compileActionExtensions contributed Run on AdministratorsControllerID | critical | mitigate | wrapAdministratorsContributedRun calls guardOutranked inside the action transaction before next; 403 user.outranked; Run not called (WR-03 / D-19) |
| T-19.6.1-31 | Elevation | wrap type assert of in.Record | high | mitigate | if the record is not a BackendUser pointer, return an error and do not call next |
| T-19.6.1-SC | Tampering | npm/pip/cargo installs | high | mitigate | this plan installs no package; any install would need the package-legitimacy gate and a blocking human checkpoint |
</threat_model>
<verification>
- After Task 1: `go vet ./... && go test -count=1 -short ./modules/cabana/... ./modules/pact/... ./modules/surf/...`, then the two new named Postgres tests and the three existing Roles/seam tests listed in Task 1.
- After Task 2: `go test -count=1 -run '^TestDocsTree$' ./cmd/summer` and `go run ./cmd/summer docs:build --check`.
- After Task 3: `bash scripts/check-phase19.6.1.sh --docker` (reuse the verifier's cabana/gate command; NOT RUN only when Docker is unreachable).
- Do not run Phase 19.6 fonoteka/user-plugin commands.
- Manual visual SPA walk-through stays in VERIFICATION.md human_verification (out of scope).
</verification>
<success_criteria>
- A non-superuser holding backend.manage_roles cannot create or rename a role onto a code that pact.Permission.Roles attaches grants to; 422 user.role.code_locked; row unchanged.
- A non-superuser holding backend.manage_users who posts a contributed record action at an outranking administrator gets 403 user.outranked and the contributor's Run is not called.
- TestRolesCodeDeclaredCodeRefused and TestActionExtensionOutranked are in the gate DOCKER_TESTS REQUIRE list.
- AdminActionExtension docs state the Administrators privilege rule. Plans 01-03 are untouched.
</success_criteria>
<output>
Create `.planning/phases/19.6.1-backend-administrators-screen/19.6.1-04-SUMMARY.md` when done
</output>

View File

@@ -0,0 +1,181 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 04
subsystem: auth
tags: [cabana, roles, administrators, privilege-ceiling, pact, postgres]
requires:
- phase: 19.6.1-01
provides: Roles and Administrators hooks, compileActionExtensions, guardOutranked, AdministratorsControllerID
- phase: 19.6.1-02
provides: permission locks and the Roles form that still posts a fillable code
- phase: 19.6.1-03
provides: screensEnv harness, TestRolesLifecycle, TestActionExtensionRun, check-phase19.6.1.sh
provides:
- refuseCodeDeclaredCode on Roles create and update so a submitted code with code-declared grants is 422 user.role.code_locked
- wrapAdministratorsContributedRun so cabana runs guardOutranked before a contributed Administrators Run
- TestRolesCodeDeclaredCodeRefused and TestActionExtensionOutranked on Postgres
- DOCKER_TESTS REQUIRE names for both tests
- AdminActionExtension docs that cabana, not the contributor, owns the outranking check
affects: [19.6.1 verify-work, 19.6 D-15, 19.7 link action on Administrators]
actuals:
tokens: 6357
tasks: 3
commits: 4
plan_head_before: 422bd1e01f4f3cb87252732eb273c14fbfcaa126
plan_head_after: e62086084b9d509b05b1e1eea510390753fe0ed8
tech-stack:
added: []
patterns:
- "Roles hooks consult rolePermissions of the submitted code, not only the stored one"
- "compileActionExtensions wraps contributed Administrators Runs in cabana so guardOutranked runs inside the action transaction"
key-files:
created: []
modified:
- modules/cabana/backend_roles_admin.go
- modules/cabana/action_extensions.go
- modules/cabana/action_extensions_test.go
- modules/cabana/roles_postgres_test.go
- modules/cabana/action_extensions_postgres_test.go
- modules/pact/capabilities.go
- modules/pact/README.md
- modules/cabana/README.md
- docs/backend/admin-controllers.md
- scripts/check-phase19.6.1.sh
key-decisions:
- "Roles create and update refuse any new code that rolePermissions attaches grants to, including when the editor is a superuser"
- "cabana wraps contributed Administrators Runs; guardOutranked stays unexported and contributors do not own the check"
patterns-established:
- "A code-declared system role cannot be created or captured through the Roles screen; 422 code_locked leaves the row unchanged"
- "A contribution to summercms.cabana.users is 403 user.outranked when the target outranks the caller, before Run"
requirements-completed: [SC-2, D-07, D-16, D-19]
coverage:
- id: D1
description: "Roles create and rename refuse a code that pact.Permission.Roles attaches grants to (CR-01 / G-19.6.1-1)"
requirement: "D-16"
verification:
- kind: integration
ref: "modules/cabana/roles_postgres_test.go#TestRolesCodeDeclaredCodeRefused"
status: pass
human_judgment: false
- id: D2
description: "Contributed Administrators record actions run guardOutranked before Run (WR-03 / G-19.6.1-2)"
requirement: "D-19"
verification:
- kind: integration
ref: "modules/cabana/action_extensions_postgres_test.go#TestActionExtensionOutranked"
status: pass
human_judgment: false
- id: D3
description: "Phase docker gate REQUIREs both new Postgres tests by name"
requirement: "D-18"
verification:
- kind: other
ref: "bash scripts/check-phase19.6.1.sh --docker"
status: pass
human_judgment: false
- id: D4
description: "AdminActionExtension docs state that cabana applies user.outranked before Run"
requirement: "D-19"
verification:
- kind: unit
ref: "cmd/summer#TestDocsTree"
status: pass
- kind: other
ref: "go run ./cmd/summer docs:build --check"
status: pass
human_judgment: false
duration: 18 min
completed: 2026-10-22
status: complete
---
# Phase 19.6.1 Plan 04: Gap closure CR-01 and WR-03 Summary
**Roles create/rename cannot capture a code-declared code; cabana wraps contributed Administrators Runs with guardOutranked before the contributor runs**
## Performance
- **Duration:** 18 min
- **Started:** 2026-10-22T11:18:00Z
- **Completed:** 2026-10-22T11:36:05Z
- **Tasks:** 3
- **Files modified:** 10
## Accomplishments
- `refuseCodeDeclaredCode` on Roles create and update: a submitted code with code-declared grants is 422 `user.role.code_locked`, including for a superuser; a same-code save of a system role still succeeds
- `wrapAdministratorsContributedRun` in `compileActionExtensions`: a contribution to `AdministratorsControllerID` is 403 `user.outranked` when the target outranks the caller, and Run is not called
- `TestRolesCodeDeclaredCodeRefused` and `TestActionExtensionOutranked` are in `DOCKER_TESTS`; `scripts/check-phase19.6.1.sh --docker` passed
- pact/cabana/docs state that cabana, not the contributor, applies the Administrators outranking rule
## Task Commits
Each task was committed atomically:
1. **Task 1: refuse a Roles code-declared capture and wrap contributed Administrators Runs** - `068adaa` (fix)
2. **Task 2: Document the Administrators privilege rule on the D-14 seam** - `cb460b6` (docs)
3. **Task 3: Require the two new Postgres tests in the phase gate** - `e620860` (chore)
**Plan metadata:** (this commit) (docs: complete plan)
## Files Created/Modified
- `modules/cabana/backend_roles_admin.go` - `refuseCodeDeclaredCode` on create and update
- `modules/cabana/action_extensions.go` - wrap contributed Administrators Runs with `guardOutranked`
- `modules/cabana/action_extensions_test.go` - boot smoke still compiles a superuser principal
- `modules/cabana/roles_postgres_test.go` - `TestRolesCodeDeclaredCodeRefused`
- `modules/cabana/action_extensions_postgres_test.go` - `TestActionExtensionOutranked`
- `modules/pact/capabilities.go` - AdminActionExtension comment names `user.outranked`
- `modules/pact/README.md` - contribution to `summercms.cabana.users` is refused when the target outranks the caller
- `modules/cabana/README.md` - contributions targeting `AdministratorsControllerID` run `guardOutranked` before Run
- `docs/backend/admin-controllers.md` - cabana applies the outranking check before Run
- `scripts/check-phase19.6.1.sh` - DOCKER_TESTS REQUIRE both new names
## Decisions Made
- Roles create and update refuse any new code that `rolePermissions` attaches grants to, including when the editor is a superuser
- cabana wraps contributed Administrators Runs; `guardOutranked` stays unexported and contributors do not own the check
## Deviations from Plan
### Auto-fixed Issues
**1. [Safe resume] Interrupted executor left SUMMARY unwritten**
- **Found during:** Orchestrator resume after the Task spawn was cut off
- **Issue:** Tasks 1–2 were committed (`068adaa`, `cb460b6`) and the Task 3 gate-script edit was uncommitted; no SUMMARY existed. Re-dispatch would duplicate the privilege fixes.
- **Fix:** Closed out Task 3 and this SUMMARY on the main tree instead of spawning a second executor
- **Files modified:** `scripts/check-phase19.6.1.sh`, this SUMMARY
- **Verification:** named Postgres tests, docs checker, and `check-phase19.6.1.sh --docker` all passed
- **Committed in:** `e620860` (Task 3) and the metadata commit
**2. [Plan files] `action_extensions_test.go` needed a superuser principal**
- **Found during:** Task 1
- **Issue:** wrapping Administrators Runs made the existing boot smoke fail unless the compile-time principal is a superuser
- **Fix:** keep the boot smoke callable with a superuser principal (noted in the Task 1 commit body)
- **Files modified:** `modules/cabana/action_extensions_test.go`
- **Verification:** `go test -short ./modules/cabana/...` passed
- **Committed in:** `068adaa` (Task 1)
---
**Total deviations:** 2 auto-fixed (safe resume, boot-smoke principal)
**Impact on plan:** No scope change. CR-01 and WR-03 shipped as specified.
## Issues Encountered
The first executor spawn was interrupted after Tasks 1–2 committed. Close-out completed Task 3 and this SUMMARY without re-applying the hook/wrap changes.
## User Setup Required
None - no external service configuration required.
## Next Phase Readiness
Phase 19.6.1 gap closure is on disk. Ready for phase verification / UAT re-check of G-19.6.1-1 and G-19.6.1-2.
---
*Phase: 19.6.1-backend-administrators-screen*
*Completed: 2026-10-22*

View File

@@ -0,0 +1,247 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 05
type: execute
wave: 5
depends_on: ["19.6.1-01", "19.6.1-02", "19.6.1-03", "19.6.1-04"]
files_modified:
- admin/src/components/form/formContext.ts
- admin/src/views/FormView.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/form/fields/RelationField.vue
- admin/tests/form/RelationField.test.ts
- admin/tests/form/FormView.test.ts
- modules/boardwalk/dist
autonomous: true
gap_closure: true
gap_ids: [G-19.6.1-T2]
requirements: []
estimate:
tokens: 35000
raw_tokens: 35000
tasks: 2
confidence: high
must_haves:
truths:
- "G-19.6.1-T2: After picking a relation option on a tabbed form, switching tabs and coming back still shows that option's name, not String(id)."
- "A remounted RelationField seeds its id→label cache from the form's remembered labels, not only from the server meta.labels captured at load."
- "modules/boardwalk/dist matches a fresh admin build so the embedded SPA used by the local demo carries the fix."
artifacts:
- path: "admin/src/components/form/formContext.ts"
provides: "FORM_REMEMBER_LABEL injection key"
contains: "FORM_REMEMBER_LABEL"
- path: "admin/src/views/FormView.vue"
provides: "FormView persists picked relation labels on the labels ref"
contains: "FORM_REMEMBER_LABEL"
- path: "admin/src/components/form/fields/RelationField.vue"
provides: "choose() remembers the picked option on the form before emit"
contains: "rememberLabel"
- path: "admin/tests/form/FormView.test.ts"
provides: "tab-switch backstop for a picked relation label"
contains: "keeps a picked relation label after switching tabs"
- path: "admin/tests/form/RelationField.test.ts"
provides: "unit backstop: remount with remembered labels shows the name"
contains: "shows a picked label after remount when the form remembered it"
- path: "modules/boardwalk/dist"
provides: "embedded admin build includes the remount-safe labels"
contains: "index.html"
key_links:
- from: "admin/src/components/form/fields/RelationField.vue"
to: "admin/src/components/form/formContext.ts"
via: "choose injects FORM_REMEMBER_LABEL and writes the picked option before update:modelValue"
pattern: "FORM_REMEMBER_LABEL"
- from: "admin/src/views/FormView.vue"
to: "admin/src/components/form/fields/RelationField.vue"
via: "remembered labels flow back as props.labels so remount's watch seeds known"
pattern: "rememberRelationLabel"
prohibitions:
- statement: "Do not keep inactive tab panels mounted with v-show (or otherwise render every tab's fields). That would change trigger hide-tab, ML locale reset, and field mount cost. Persist labels; keep the current one-panel FormGrid."
status: unresolved
verification: grep
- statement: "Do not edit 19.6.1-01/02/03/04-PLAN.md. Do not change cabana Go, pact, phrasebook, YAML screens, or OpenAPI. No new npm dependency."
status: unresolved
verification: grep
- statement: "Framework code, READMEs, docs and tests name no consuming application."
status: unresolved
verification: grep
---
## Phase Goal
ROADMAP Goal (not a user story; MVP mode off): cabana gets WinterCMS's Administrators screens with privilege rules on the server.
This plan's slice (plan 5 of 5, wave 5, gap_closure): close UAT gap G-19.6.1-T2 (test 2, minor). After picking a role (or any relation) on the Administrators form, switching to another tab and back shows the option name, not the raw id. Save already assigned the role; this is labeling only. Ignore CR-01 / WR-03 (closed by plan 04) and IN-01..IN-06.
## Why plan 04 did not close this
Plan 04 `gap_ids` were `[G-19.6.1-1, G-19.6.1-2]` from VERIFICATION.md review findings (CR-01 code-declared role capture, WR-03 contributed Run skip of guardOutranked). The dropdown issue lived only in `19.6.1-UAT.md` ## Gaps, had no `gap_id`, and VERIFICATION.md called it "not a gap-closure item and not a failed must-have". Plan 04 also prohibited SPA changes. `--gaps-only` therefore never selected this truth.
## Spec-less probe fallback
Spec-less probe fallback skipped: phase has no requirement IDs to probe (visible skip). Edge row is the UAT diagnosis already on disk.
## Discovery
Level 0: existing RelationField `known` cache, FormView `labels` ref, FormView `panelFields` (active tab only). No new dependency.
## Decisions taken in this plan
- Persist picked labels on the form. Do not v-show inactive tabs.
- New inject `FORM_REMEMBER_LABEL`: `(field: string, option: RelationOption) => void`. FormView and RelationChildModal provide it. RelationField calls it from `choose` when `entry.value !== null` (single and multiple), using `entry.label` and `entry.locked`. A missing provider is a no-op (standalone mount, settings pages without labels).
- FormView helper `rememberRelationLabel` merges the option into `labels.value[field]` by `value` (replace same id, append otherwise). `adopt()` still replaces labels from the server response on load/save.
- RelationField's existing `watch(() => props.labels, remember, { immediate: true })` and `labelOf` stay. Remount seeds `known` from the updated `props.labels`.
- Test names: `keeps a picked relation label after switching tabs` (FormView.test.ts) and `shows a picked label after remount when the form remembered it` (RelationField.test.ts).
## Source coverage (this gap plan)
| Source | Item | Plan | Status |
|---|---|---|---|
| UAT Gaps | G-19.6.1-T2 / test 2 role dropdown id after tab switch | 05 | COVERED |
| VERIFICATION gaps | G-19.6.1-1 / CR-01 | 04 | COVERED (prior) |
| VERIFICATION gaps | G-19.6.1-2 / WR-03 | 04 | COVERED (prior) |
## UI Considerations
No new tokens, colours, or components. The combobox already shows `labelOf(id)`. This plan only keeps that map populated across a tab remount.
| Category | Element | Status | Resolution |
|----------|---------|--------|------------|
| display | Relation single combobox after tab switch | covered | Form remembers the picked `{value,label}`; remount seeds `known` from `props.labels` |
| display | Relation multiple chips after tab switch | covered | same remember path from `choose` |
## Artifacts this phase produces
- `FORM_REMEMBER_LABEL` in `formContext.ts`.
- FormView + RelationChildModal providers; RelationField `choose` write.
- Two vitest names above.
- Rebuilt `modules/boardwalk/dist`.
<objective>
Close G-19.6.1-T2: a picked relation option keeps its name when FormView unmounts the field on a tab switch and remounts it.
Purpose: UAT test 2 labeling. Save is already correct.
Output: inject + two providers + choose() write, two vitest names, rebuilt boardwalk dist. No Go/pact/YAML. Skip git commit (orchestrator commits). Skip STATE.md raw edits.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-UAT.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-VERIFICATION.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-04-PLAN.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-04-SUMMARY.md
Concurrency and commits: other sessions may touch admin/ or boardwalk/dist. Before each task run `git status --porcelain -- admin modules/boardwalk/dist` and stop if a file this task edits carries someone else's uncommitted change. Stage by explicit path, never `git add -A`; leave STATE.md and state.json alone; no co-author tags. The orchestrator commits after the checker — do not git commit from this plan.
<interfaces>
- RelationField.vue: `known` Record<number,string> seeded by `watch(() => props.labels, remember, { immediate: true })`. `labelOf(id)` is `known[id] ?? String(id)`. `choose(entry)` emits `update:modelValue` (id or null, or appended ids in multiple) and `closeList()`. It does not write back to the parent labels today.
- FormView.vue: `labels` ref assigned in `adopt()` from `record.meta.labels`. `panelFields` filters `tabOf(field) === activeTab`. One FormGrid, so inactive tab fields unmount. `update(name, value)` writes `values` only.
- RelationChildModal.vue: own `labels` ref, `adopt(record, meta)`, FormGrid, same remount if the child form is tabbed.
- formContext.ts: existing injects FORM_VALUES, FORM_PATCH, FIELD_SCOPE, FORM_TRIGGER_NOTES, FORM_FEEDBACK. Add FORM_REMEMBER_LABEL next to FIELD_SCOPE.
- RelationOption: `{ label: string; locked?: boolean; value: number }` (schema.d.ts).
- Fixtures: widgets.form-schema.json has `maker` (relation, default tab) and `serial` (text, tab Details). widgets.record.json has maker 2 / "Bolt & Co". optionsFixture.makerField has Acme Works (1) and Bolt & Co (2). FormView.test.ts already has `tab(wrapper, key)` in the D-21 describe; reuse that helper or a local copy. mountApp + mockApi as existing tests.
- Dist: `npm --prefix admin run build` writes modules/boardwalk/dist; `scripts/check-admin-dist.sh` rebuilds into a temp dir and diffs.
</interfaces>
</context>
<tasks>
<task type="tracer">
<name>Task 1: Persist picked relation labels across FormView tab remount</name>
<precondition>admin/src/components/form/fields/RelationField.vue has choose() and labelOf(); FormView.vue has labels ref, adopt(), panelFields, and a single FormGrid; formContext.ts exports FIELD_SCOPE; admin/tests/form/FormView.test.ts and RelationField.test.ts exist; git status --porcelain -- admin is empty of other sessions' edits.</precondition>
<reversibility rating="reversible">SPA-only inject and label merge; undo is a revert. No API or on-disk format change.</reversibility>
<files>admin/src/components/form/formContext.ts, admin/src/views/FormView.vue, admin/src/components/relation/RelationChildModal.vue, admin/src/components/form/fields/RelationField.vue, admin/tests/form/RelationField.test.ts, admin/tests/form/FormView.test.ts</files>
<read_first>admin/src/components/form/fields/RelationField.vue, admin/src/views/FormView.vue, admin/src/components/relation/RelationChildModal.vue, admin/src/components/form/formContext.ts, admin/src/components/form/FormGrid.vue, admin/tests/form/RelationField.test.ts, admin/tests/form/FormView.test.ts, admin/tests/fixtures/widgets.form-schema.json, admin/tests/fixtures/widgets.options.json, .planning/phases/19.6.1-backend-administrators-screen/19.6.1-UAT.md</read_first>
<action>Close G-19.6.1-T2 in one production-quality slice. Do not v-show inactive tabs. Do not change Go, pact, YAML, or OpenAPI.
formContext.ts: export `FORM_REMEMBER_LABEL` as `InjectionKey&lt;(field: string, option: RelationOption) =&gt; void&gt;` (import RelationOption from api/types). Comment: form hosts persist a picked relation option so a remounted RelationField can seed its id→label cache from props.labels; a host without a provider is a no-op.
FormView.vue: add `rememberRelationLabel(field, option)` that copies `labels.value`, replaces or appends in `labels.value[field]` by option.value, and assigns the new object. provide(FORM_REMEMBER_LABEL, rememberRelationLabel) next to the other form provides. adopt() still overwrites labels from the server.
RelationChildModal.vue: the same helper against its `labels` ref and the same provide, so a tabbed child form does not regress.
RelationField.vue: inject FORM_REMEMBER_LABEL (default undefined). In choose(), when entry.value !== null, call rememberLabel?.(props.field.name, { value: entry.value, label: entry.label, locked: entry.locked || undefined }) before emit('update:modelValue', ...). Empty (null) choice does not remember. Do not change labelOf, remember(rows), or the props.labels watch.
Tests, no consuming-application names:
RelationField.test.ts: `shows a picked label after remount when the form remembered it`. Mount with maker, modelValue 2, labels Bolt &amp; Co only, and provide FORM_REMEMBER_LABEL that records calls into a labels bag. Open the list (mockApi routes as existing), pick Acme Works (value 1). Expect the bag to contain { value: 1, label: 'Acme Works' }. Unmount. Mount again with modelValue 1 and labels from that bag (plus any previous). The combobox value is 'Acme Works', not '1'.
FormView.test.ts: `keeps a picked relation label after switching tabs`. mountApp on /acme/demo/widgets/1 with the widgets form schema (maker on the default tab, serial on Details) and GET maker options from optionsFixture.makerField. Combobox starts as Bolt &amp; Co. Open it, pick Acme Works. Click the Details tab, then the first tab (same tab() pattern as the D-21 describe). The maker combobox value is 'Acme Works', not '1'. Do not assert save.
Existing RelationField and FormView tests stay green, including D-21 hide-tab backstops (those prove we did not switch to v-show of every panel).
</action>
<verify>
<automated>npm --prefix admin run test -- tests/form/RelationField.test.ts tests/form/FormView.test.ts</automated>
<fails_when>non-zero exit, or either new it() name is missing from the run output</fails_when>
<automated>npm --prefix admin run typecheck</automated>
<fails_when>non-zero exit</fails_when>
</verify>
<acceptance_criteria>
- `grep -c 'FORM_REMEMBER_LABEL' admin/src/components/form/formContext.ts` prints at least 1.
- `grep -c 'rememberRelationLabel\|FORM_REMEMBER_LABEL' admin/src/views/FormView.vue` prints at least 2.
- `grep -c 'FORM_REMEMBER_LABEL' admin/src/components/relation/RelationChildModal.vue` prints at least 1.
- `grep -n 'function choose' -A 20 admin/src/components/form/fields/RelationField.vue | grep -c 'rememberLabel'` prints at least 1.
- `grep -c 'v-show' admin/src/views/FormView.vue` prints 0 (do not keep inactive panels mounted).
- `grep -c 'keeps a picked relation label after switching tabs' admin/tests/form/FormView.test.ts` prints 1.
- `grep -c 'shows a picked label after remount when the form remembered it' admin/tests/form/RelationField.test.ts` prints 1.
- `grep -ciE 'fonoteka|plytarium|grzyby|wavepath' admin/src/components/form/formContext.ts admin/src/views/FormView.vue admin/src/components/form/fields/RelationField.vue admin/src/components/relation/RelationChildModal.vue admin/tests/form/RelationField.test.ts admin/tests/form/FormView.test.ts` prints 0 for each file.
</acceptance_criteria>
<done>Picking a relation option, switching tabs, and coming back shows the option name. Proven by the FormView tab-switch test and the RelationField remount test.</done>
</task>
<task type="auto">
<name>Task 2: Rebuild the embedded admin dist</name>
<precondition>Task 1 source is on disk; git status --porcelain -- modules/boardwalk/dist admin/src is only this plan's files or empty; admin/node_modules exists (never run npm ci).</precondition>
<reversibility rating="reversible">Generated embed; undo is a dist revert.</reversibility>
<files>modules/boardwalk/dist</files>
<read_first>scripts/check-admin-dist.sh, admin/package.json</read_first>
<action>Rebuild the committed SPA embed so the local demo binary (go.work → boardwalk) serves the remount-safe labels. Run `npm --prefix admin run build` (vue-tsc then vite into modules/boardwalk/dist with emptyOutDir). Run `scripts/check-admin-dist.sh`. Do not commit (orchestrator commits). Do not touch admin/src in this task.</action>
<verify>
<automated>scripts/check-admin-dist.sh &amp;&amp; go test -short ./modules/boardwalk</automated>
<fails_when>non-zero exit, or check-admin-dist reports stale dist</fails_when>
</verify>
<acceptance_criteria>
- `scripts/check-admin-dist.sh` exits 0 and prints that modules/boardwalk/dist matches a fresh build.
- `test -f modules/boardwalk/dist/index.html` succeeds.
</acceptance_criteria>
<done>The embedded admin build matches the Task 1 SPA, so a `scripts/dev.sh` rebuild of sm-demo-app picks up the fix.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| admin SPA field → form labels ref | Picked option label is display-only; save still posts the id the combobox already emitted |
| options API → remember() | Labels come from the same options payload the administrator already saw |
## STRIDE Threat Register
Threat IDs continue after T-19.6.1-31.
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.6.1-32 | Tampering | FORM_REMEMBER_LABEL label string | low | accept | Display only; server still authorizes the posted id. Do not v-html the label (RelationField already interpolates text). |
| T-19.6.1-SC | Tampering | npm/pip/cargo installs | high | mitigate | this plan installs no package |
</threat_model>
<verification>
- After Task 1: `npm --prefix admin run test -- tests/form/RelationField.test.ts tests/form/FormView.test.ts` and `npm --prefix admin run typecheck`.
- After Task 2: `scripts/check-admin-dist.sh` and `go test -short ./modules/boardwalk`.
- Do not run Phase 19.6 fonoteka/user-plugin commands.
</verification>
<success_criteria>
- After picking a relation option on a tabbed form, switching tabs and back shows the option name, not String(id).
- The two named vitest cases exist and pass.
- modules/boardwalk/dist matches a fresh admin build.
- Plans 01-04 are untouched. No Go/pact/YAML change.
</success_criteria>

View File

@@ -0,0 +1,155 @@
---
phase: 19.6.1-backend-administrators-screen
plan: 05
subsystem: ui
tags: [admin-spa, relation-field, form-labels, boardwalk]
requires:
- phase: 19.6.1-01
provides: Administrators and Roles screens compiled from YAML
- phase: 19.6.1-02
provides: privilege ceiling, permission locks, Roles form
- phase: 19.6.1-03
provides: lifecycle tests and phase gate
- phase: 19.6.1-04
provides: CR-01 / WR-03 gap closure
provides:
- FORM_REMEMBER_LABEL inject so form hosts persist a picked relation option
- FormView and RelationChildModal merge picked labels into the labels ref
- RelationField choose() writes the option before emit so a remount seeds known
- Vitest names for remount and tab-switch labeling
- Rebuilt modules/boardwalk/dist matching a fresh admin build
affects: [19.6.1 UAT G-19.6.1-T2, embedded admin SPA]
actuals:
tokens: 2966
tasks: 2
commits: 3
plan_head_before: ba0501c2746e7ea22920701792990537c4729284
plan_head_after: 51e1a1ea6ed3f5e5aa08d07210452bf3e6622f8a
tech-stack:
added: []
patterns:
- "Form hosts persist picked RelationOption rows on the labels ref; remount seeds known from props.labels"
key-files:
created: []
modified:
- admin/src/components/form/formContext.ts
- admin/src/views/FormView.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/form/fields/RelationField.vue
- admin/tests/form/RelationField.test.ts
- admin/tests/form/FormView.test.ts
- modules/boardwalk/dist
key-decisions:
- "Persist picked relation labels on the form via FORM_REMEMBER_LABEL; keep the one-panel FormGrid (do not v-show inactive tabs)"
patterns-established:
- "A remounted RelationField reads remembered labels from props.labels, not only server meta.labels from load"
requirements-completed: []
coverage:
- id: D1
description: "After picking a relation option on a tabbed form, switching tabs and coming back shows the option name, not String(id)"
verification:
- kind: unit
ref: "admin/tests/form/FormView.test.ts#keeps a picked relation label after switching tabs"
status: pass
- kind: unit
ref: "admin/tests/form/RelationField.test.ts#shows a picked label after remount when the form remembered it"
status: pass
human_judgment: false
- id: D2
description: "modules/boardwalk/dist matches a fresh admin build so the embedded SPA carries the remount-safe labels"
verification:
- kind: other
ref: "scripts/check-admin-dist.sh"
status: pass
- kind: unit
ref: "go test -short ./modules/boardwalk"
status: pass
human_judgment: false
duration: 4min
completed: 2026-10-22
status: complete
---
# Phase 19.6.1 Plan 05: Persist relation labels across tab remount Summary
**Picked relation option names persist across FormView tab remount via FORM_REMEMBER_LABEL**
## Performance
- **Duration:** 4 min
- **Started:** 2026-10-22T12:38:22Z
- **Completed:** 2026-10-22T12:42:52Z
- **Tasks:** 2
- **Files modified:** 7
## Accomplishments
- Form hosts persist a picked relation option on the labels ref so a remounted RelationField seeds its id→label cache from props.labels
- RelationField `choose()` writes `{value,label,locked}` through `FORM_REMEMBER_LABEL` before emit; empty (null) choice does not remember
- Two named vitest cases prove remount and tab-switch labeling; inactive tabs stay unmounted
- Embedded `modules/boardwalk/dist` rebuilt and matched a fresh admin build
## Task Commits
Each task was committed atomically:
1. **Task 1: Persist picked relation labels across FormView tab remount** - `14baafb` (feat)
2. **Task 2: Rebuild the embedded admin dist** - `51e1a1e` (chore)
**Plan metadata:** recorded after this file is committed.
_Note: `git rev-list` from `plan_head_before` to HEAD counted 3 commits because a concurrent `docs(19.7)` commit landed between the two task commits. This plan authored 2 production commits._
## Files Created/Modified
- `admin/src/components/form/formContext.ts` - exports `FORM_REMEMBER_LABEL`
- `admin/src/views/FormView.vue` - `rememberRelationLabel` + provide; `adopt()` still replaces labels from the server
- `admin/src/components/relation/RelationChildModal.vue` - same helper and provide for a tabbed child form
- `admin/src/components/form/fields/RelationField.vue` - `choose()` remembers a non-null option before emit
- `admin/tests/form/RelationField.test.ts` - remount backstop for a remembered label
- `admin/tests/form/FormView.test.ts` - tab-switch backstop for a picked maker label
- `modules/boardwalk/dist` - rebuilt embed (`index-BtP5LUQA.js` replaces `index-D7ALzCHi.js`; editor hash rename)
## Decisions Made
- Persist picked labels on the form via `FORM_REMEMBER_LABEL`. Do not keep inactive tab panels mounted with `v-show`.
## Deviations from Plan
None - plan executed exactly as written.
**Total deviations:** 0 auto-fixed
**Impact on plan:** None.
## Issues Encountered
- A concurrent session committed `d47d618` (`docs(19.7): create phase plans`) between Task 1 and Task 2. Measured `commits:` is 3; this plan's production commits are `14baafb` and `51e1a1e`. Old hashed dist assets were deleted as part of the Vite rebuild (intentional).
## User Setup Required
None - no external service configuration required.
## Next Phase Readiness
- G-19.6.1-T2 is closed in the SPA and the embedded dist. Phase 19.6.1 plans 01–05 are complete; ready for verify-work / UAT recheck of test 2.
- No blockers. Plans 01–04 were not edited. No Go, pact, YAML, or OpenAPI change.
## Self-Check: PASSED
- FOUND: admin/src/components/form/formContext.ts
- FOUND: admin/src/views/FormView.vue
- FOUND: admin/src/components/relation/RelationChildModal.vue
- FOUND: admin/src/components/form/fields/RelationField.vue
- FOUND: admin/tests/form/RelationField.test.ts
- FOUND: admin/tests/form/FormView.test.ts
- FOUND: modules/boardwalk/dist/index.html
- FOUND: 14baafb
- FOUND: 51e1a1e
---
*Phase: 19.6.1-backend-administrators-screen*
*Completed: 2026-10-22*

View File

@@ -0,0 +1,68 @@
---
phase: 19.6.1
review: 19.6.1-REVIEW.md
titles: json
findings:
- id: CR-01
severity: critical
disposition: fixed
title: "Roles screen lets a non-superuser rename or create a role onto a code with code-declared grants (D-07 ceiling bypass, self-escalation)"
- id: WR-01
severity: warning
disposition: open
title: "D-07/D-19 ceilings ignore a scoped personal API token's scope"
- id: WR-02
severity: warning
disposition: open
title: "Stored override values other than 1/-1 are dropped on every save, re-granting what they removed"
- id: WR-03
severity: warning
disposition: fixed
title: "Record actions contributed to the Administrators screen bypass D-19 (outranking) and D-09 (last superuser)"
- id: IN-01
severity: info
disposition: open
title: "Last-superuser guard silently depends on READ COMMITTED"
- id: IN-02
severity: info
disposition: open
title: "Re-deleting a soft-deleted administrator reports success and bumps tokens"
- id: IN-03
severity: info
disposition: open
title: "Role code uniqueness is a check-then-insert without a lock"
- id: IN-04
severity: info
disposition: open
title: "Role delete counts holders without locking against concurrent assignment"
- id: IN-05
severity: info
disposition: open
title: "`toggleOn` reads unknown switch encodings as \"off\""
- id: IN-06
severity: info
disposition: open
title: "Role picker on your own record is editable in the SPA but always refused"
open: 8
total: 10
recorded: 2026-10-22T11:50:00.000Z
---
# Phase 19.6.1: Code Review Disposition
| Finding | Severity | Disposition | Source |
|---------|----------|-------------|--------|
| CR-01 | critical | fixed | 19.6.1-04 refuseCodeDeclaredCode |
| WR-01 | warning | open | - |
| WR-02 | warning | open | - |
| WR-03 | warning | fixed | 19.6.1-04 wrapAdministratorsContributedRun (D-19). D-09 on contributed Run stays out of the gap plan |
| IN-01 | info | open | - |
| IN-02 | info | open | - |
| IN-03 | info | open | - |
| IN-04 | info | open | - |
| IN-05 | info | open | - |
| IN-06 | 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,70 @@
---
phase: 19.6.1-backend-administrators-screen
reviewed: 2026-10-22T12:51:21Z
depth: standard
files_reviewed: 6
files_reviewed_list:
- admin/src/components/form/formContext.ts
- admin/src/views/FormView.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/form/fields/RelationField.vue
- admin/tests/form/RelationField.test.ts
- admin/tests/form/FormView.test.ts
findings:
critical: 0
warning: 0
info: 0
total: 0
status: clean
gap_closure:
reviewed: 2026-10-22T12:51:21Z
depth: standard
plan: "05"
prior_review: d7dc2a3
files_reviewed: 6
files_reviewed_list:
- admin/src/components/form/formContext.ts
- admin/src/views/FormView.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/form/fields/RelationField.vue
- admin/tests/form/RelationField.test.ts
- admin/tests/form/FormView.test.ts
findings:
critical: 0
warning: 0
info: 0
nice_to_have: 0
total: 0
status: clean
---
# Phase 19.6.1: Code Review Report
**Reviewed:** 2026-10-22T12:51:21Z
**Depth:** standard
**Files Reviewed:** 6
**Status:** clean
Wave-scoped incremental review of plan 05 (gap closure G-19.6.1-T2) after `d7dc2a3`. This file replaces the plans 01–04 review text; open findings from that pass stay on `19.6.1-REVIEW-DISPOSITION.md`. Concurrent settings-panel work and generated `modules/boardwalk/dist` were not reviewed (the dist was rebuilt in `51e1a1e`).
## Summary
Plan 05 persists a picked relation option on the form host so a remounted `RelationField` can seed its id→label cache from `props.labels` after FormView unmounts inactive tab panels. The inject, both providers, `choose()` write, and the two named vitest cases match that contract. Inactive tabs stay unmounted (`v-show` is absent). Labels are display-only text interpolation; save still posts the id.
Traced path: `choose()` writes `{value,label}` through `FORM_REMEMBER_LABEL` before `update:modelValue`; `rememberRelationLabel` replaces or appends by `option.value` on a new `labels` object; `FormGrid` looks up `labels[field.name]`; remount's `watch(() => props.labels, remember, { immediate: true })` fills `known`; `labelOf` then returns the name. `adopt()` still replaces labels from the server on load/save. A missing provider is a no-op. The child modal shadows the record form's provider so a tabbed child writes its own `labels` ref.
All reviewed files meet quality standards. No issues found.
## Narrative Findings (AI reviewer)
No Critical, Warning, or Info findings.
`FORM_REMEMBER_LABEL` is a typed `InjectionKey` next to `FIELD_SCOPE`. `rememberRelationLabel` copies the field array and the labels record (no in-place mutation), so the shallow `props.labels` watch fires. Empty (`null`) choice does not remember. Locked options return before the write, so `locked: entry.locked || undefined` is always `undefined` on this path and does not clear a stored lock. `RelationChildModal` uses the same helper and provide; its `FormGrid` already receives `:labels="labels"`. Tests use the widgets fixture (`maker` on `default`, `serial` on `tab:Details`) and the same `tab()` / `mousedown` pattern as the D-21 backstops. No consuming-application names. No new dependency.
Prior findings WR-01, WR-02, and IN-01..IN-06 were out of this pass.
---
_Reviewed: 2026-10-22T12:51:21Z_
_Reviewer: Claude (msd-code-reviewer)_
_Depth: standard_

View File

@@ -0,0 +1,113 @@
---
phase: "19.6.1"
slug: "backend-administrators-screen"
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-22"
---
# Phase 19.6.1 — Security
> Per-phase security contract: threat register, accepted risks, and audit trail.
---
## Trust Boundaries
| Boundary | Description | Data Crossing |
|----------|-------------|---------------|
| admin SPA / API client → cabana admin API | Request bodies, ids, query filters, trigger/lock display state and relation labels are untrusted; the principal comes from the JWT or personal token guard | login/email/password, role code, permission maps, record-action names, virtual `is_superuser` |
| admin with `backend.manage_users` / `backend.manage_roles` → other admins and role codes | A delegated, non-superuser administrator acts on accounts and roles that may hold more privilege, including codes plugins attach grants to | role_id, permissions, activation, password set, contributed record actions |
| contributing plugin → Administrators record-action Run (D-14) | Plugin code runs inside the target's transaction behind the target's permission | `pact.AdminRecordActionInput.Record`, action name |
| concurrent write transactions → last-superuser invariant | Two requests may reduce the superuser set at once | demote / deactivate / delete of an active superuser |
| controller lock provider → record response | Lock notes and values come from plugin code and reach every viewer of the record | `meta.permissionLocks` |
| plugin fields.yaml → boot compiler | A plugin's YAML may declare malformed triggers | `trigger` keys |
| test suite → privilege rules | A rule without a named test can regress silently | status, body text, unchanged rows |
---
## Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation | Status |
|-----------|----------|-----------|----------|-------------|------------|--------|
| T-19.6.1-01 | Elevation | generic CRUD fill of `is_superuser`, `role_id`, `permissions`, `is_activated`, `password` | high | mitigate | `protectedFillKey` in `modules/cabana/crud.go:1450` keeps them unfillable; only usersAdmin hooks, the radio editor and the WritableForeignKey role relation write them | closed |
| T-19.6.1-02 | Elevation | FormBeforeCreate/Update virtual `is_superuser` | critical | mitigate | presence check on `VirtualFieldsFromContext` in `modules/cabana/backend_users_admin.go:731`; a non-superuser sending the key answers 403 `superuser_forbidden` | closed |
| T-19.6.1-03 | Elevation | own record: role, superuser, permissions, activation | high | mitigate | `priorRoleID` snapshot compared in FormAfterUpdate; `AdminSetPermissionValues` self refusal; self checks on `is_superuser`, deactivate and delete (`backend_users_admin.go`) | closed |
| T-19.6.1-04 | Elevation | permission editors and role picker | high | mitigate | `PermissionOption.Locked` and `RelationLockProvider` (`relation_field.go:74`); conservative `grantsCovered` (`backend_privileges.go:82`) | closed |
| T-19.6.1-05 | Elevation | password set, deactivate, delete, actions on a higher-privileged admin | critical | mitigate | `guardOutranked` (`backend_privileges.go:123`) on update, delete, record and bulk actions; own-password refused with `own_password` (`backend_users_admin.go:800`); own password is My account + `current_password` (`account.go:341`) | closed |
| T-19.6.1-06 | Denial of service | demote, deactivate, delete of the last active superuser | high | mitigate | `guardLastSuperuser` takes `pg_advisory_xact_lock` (`superuserLockKey` in `backend_privileges.go:18`) then counts other active superusers in the write tx | closed |
| T-19.6.1-07 | Information disclosure | list, show, partials, filters for non-superusers | medium | mitigate | `ListExtendQuery` / `FormExtendQuery` (`backend_users_admin.go:153`) filter `backend_users.is_superuser`; `hiddenSchemaFields` drops the field, column and filter | closed |
| T-19.6.1-08 | Elevation | superuser's scoped personal API token | high | mitigate | `actsAsSuperuser` requires `p.IsSuperuser` and unscoped or full token scope (`backend_privileges.go:24`) | closed |
| T-19.6.1-09 | Elevation | contributed record actions (D-14) | high | mitigate | `protect()` checks the target's `RequiredPermissions` (`http.go:1161`); `compileContributions` (`registry.go:269`) validates contributed permissions at boot; run path is the existing row-locked RecordAction | closed |
| T-19.6.1-10 | Tampering | contributed action names | medium | mitigate | boot error on reserved names, a name the owner or an earlier contributor registers, nil Run, empty label and unknown controller ID (`action_extensions.go:86`, `extension.go`) | closed |
| T-19.6.1-11 | Spoofing | sessions after deactivate, delete, password set | high | mitigate | `tokens_valid_after = revocationCutoff()` (`backend_privileges.go:182`) on all three; `FindByID` refuses inactive and deleted users for personal tokens | closed |
| T-19.6.1-12 | Spoofing | personal API tokens after a password set for another admin | medium | accept | same semantics as `admin:reset-password`; operator revokes with `admin:token:revoke` | closed |
| T-19.6.1-13 | Tampering | unprojected `is_superuser` switch | high | mitigate | `extendRecordData` (`backend_users_admin.go:436`) projects the stored flag so an untouched save never demotes | closed |
| T-19.6.1-14 | Elevation | upgrade of existing installs | medium | mitigate | `backend.manage_users` and `backend.manage_roles` declared with no `Roles` grants (`backend_screens.go:80`); only superusers reach the screens until a grant is made | closed |
| T-19.6.1-15 | Denial of service | role delete with holders | low | mitigate | unscoped holder count refuses with 403 `delete_has_users` before the FK would fail (`backend_roles_admin.go:247`) | closed |
| T-19.6.1-16 | Information disclosure | login/email collision messages revealing deleted accounts | low | accept | only holders of `backend.manage_users` see them, and they can list deleted admins anyway | closed |
| T-19.6.1-17 | Denial of service | oversized passwords | low | mitigate | 72-byte cap before bcrypt, min 4, confirmation (`storePassword` in `backend_users_admin.go:857`, `passwordMaxBytes` in `account.go:47`) | closed |
| T-19.6.1-18 | Elevation | trigger-disabled permission overrides | medium | mitigate | a disabled field is omitted from the save body; the server keeps stored values; superusers bypass overrides; no server rule depends on the trigger | closed |
| T-19.6.1-19 | Elevation | record-locked codes in a hand-crafted save body | high | mitigate | `applyPermissionValues` (`field_permission.go:291`) refuses a present record-locked value that differs from the stored one (403) and carries the stored value otherwise; D-08 `AdminSetPermissionValues` refusal stays | closed |
| T-19.6.1-20 | Information disclosure | `meta.permissionLocks` | low | accept | sent only on show and save responses behind `protect()` to admins who may open the record; it repeats codes the permission editor already shows | closed |
| T-19.6.1-21 | Tampering | malformed trigger YAML | low | mitigate | `compileTrigger` and `checkTriggers` (`field_trigger.go:28`) stop boot with errors naming controller, field and key | closed |
| T-19.6.1-22 | Tampering | stale committed SPA build or OpenAPI | medium | mitigate | `check-admin-openapi.sh --check` and `check-admin-dist.sh` in plan 02 verify; dist rebuilt from the committed lockfile | closed |
| T-19.6.1-23 | Tampering | note text injected into markup | medium | mitigate | notes render by Vue text interpolation only; no `v-html` in PermissionEditorField, FormField, FormView, RelationField or RelationChildModal | closed |
| T-19.6.1-24 | Repudiation | privilege regressions (D-05..D-09, D-19, D-20) going unnoticed | high | mitigate | one named test per rule; `scripts/check-phase19.6.1.sh` requires every name and refuses skipped or zero-match runs | closed |
| T-19.6.1-25 | Denial of service | a deadlock in the last-superuser guard hidden by a flaky race | high | mitigate | held-lock race in `administrators_lifecycle_postgres_test.go` waits for two `pg_locks` waiters before releasing; unsynchronized rounds assert no 500 or deadlock | closed |
| T-19.6.1-26 | Tampering | cross-test interference through shared superuser rows | medium | mitigate | `isolateSuperusers` (`administrators_harness_test.go:340`) plus per-test unique rows and cleanup; no `t.Parallel` in the package | closed |
| T-19.6.1-27 | Information disclosure | tests or fixtures naming consuming applications | low | mitigate | the gate's docs stage name check and the plan 03 acceptance greps | closed |
| T-19.6.1-28 | Elevation | `rolesAdmin.FormBeforeUpdate` submitted code | critical | mitigate | `refuseCodeDeclaredCode` (`backend_roles_admin.go:162`) on update; 422 `code_locked`; row unchanged | closed |
| T-19.6.1-29 | Elevation | `rolesAdmin.FormBeforeCreate` submitted code | critical | mitigate | same refusal on create (`FormBeforeCreate` at `backend_roles_admin.go:175`); 422 `code_locked`; no row inserted | closed |
| T-19.6.1-30 | Elevation | compileActionExtensions contributed Run on AdministratorsControllerID | critical | mitigate | `wrapAdministratorsContributedRun` (`action_extensions.go:108`) calls `guardOutranked` inside the action transaction before `next`; 403 `user.outranked`; Run not called | closed |
| T-19.6.1-31 | Elevation | wrap type assert of `in.Record` | high | mitigate | if the record is not a `*BackendUser`, return an error and do not call `next` (`action_extensions.go:111`) | closed |
| T-19.6.1-32 | Tampering | `FORM_REMEMBER_LABEL` label string | low | accept | display only; server still authorizes the posted id; RelationField interpolates text (no `v-html`) | closed |
| T-19.6.1-SC | Tampering | npm/pip/cargo installs | high | mitigate | no package added; plan 02 `npm --prefix admin ci` installs only the committed lockfile; plan 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)*
---
## Accepted Risks Log
| Risk ID | Threat Ref | Rationale | Accepted By | Date |
|---------|------------|-----------|-------------|------|
| AR-19.6.1-12 | T-19.6.1-12 | Setting another admin's password does not revoke that admin's personal API tokens — same semantics as `admin:reset-password`. The operator revokes them with `admin:token:revoke`. Widening the phase to revoke tokens on password set was flagged and declined. | plan 01 (authored) | 2026-10-22 |
| AR-19.6.1-16 | T-19.6.1-16 | Login/email collision messages can reveal that a deleted account exists. Only holders of `backend.manage_users` see them, and they can list deleted admins anyway. | plan 01 (authored) | 2026-10-22 |
| AR-19.6.1-20 | T-19.6.1-20 | `meta.permissionLocks` repeats lock codes and notes on show/save. Sent only behind `protect()` to admins who may open the record; it repeats codes the permission editor already shows. | plan 02 (authored) | 2026-10-22 |
| AR-19.6.1-32 | T-19.6.1-32 | Remembered relation option labels are display-only client state. The server still authorizes the posted id; RelationField interpolates the label as text. | plan 05 (authored) | 2026-10-22 |
*Accepted risks do not resurface in future audit runs.*
---
## Security Audit Trail
| Audit Date | Threats Total | Closed | Open | Run By |
|------------|---------------|--------|------|--------|
| 2026-10-22 | 33 | 33 | 0 | msd-secure-phase (ASVS L1, register authored at plan time) |
## Security Audit 2026-10-22
| Metric | Count |
|--------|-------|
| Threats found | 33 |
| Closed | 33 |
| Open | 0 |
State B (no prior SECURITY.md). Plans 01–05 each contained a parseable `<threat_model>` (`register_authored_at_plan_time: true`). SUMMARYs 01–03 reported no unregistered threat flags; 04–05 have no Threat Flags section. ASVS L1 + `threats_open: 0` short-circuited past the auditor (grep-depth sufficient). `block_on: high`.
---
## 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-22

View File

@@ -0,0 +1,188 @@
---
status: complete
phase: 19.6.1-backend-administrators-screen
source: 19.6.1-01-SUMMARY.md, 19.6.1-02-SUMMARY.md, 19.6.1-03-SUMMARY.md
started: 2026-10-22T11:00:00Z
updated: 2026-10-22T13:23:00Z
---
## Current Test
[testing complete]
## Tests
### 1. Settings tiles and Administrators list (superuser)
expected: Settings → System shows Administrators then Roles tiles (no new sidebar item). The Administrators list shows admins with a Superuser column and filters, including Active and Deleted; all labels are translated, with no raw lang keys.
result: pass
### 2. Create an administrator
expected: Create opens the form with login, email, name, password + confirmation, role, a Superuser switch and Permission overrides. Saving with a mismatched or 3-character password shows a field error. Saving a valid admin (role e.g. developer, Superuser off) lands on the record and shows a success toast.
result: pass
previous_result: issue
retested_by: 19.6.1-05
reported: "confirmed, working as expected"
note: "Retested after demo rebuild on 127.0.0.1:8099; role dropdown keeps the name after switching tabs."
### 3. Superuser switch locks the permission overrides
expected: On the new admin's form, turning Superuser ON makes the Permission overrides editor read-only with a note explaining why; turning it OFF makes the overrides editable again (radio per permission: inherit / grant / deny). Saving an override persists after reload.
result: pass
### 4. Deactivate, delete, restore
expected: On the admin's preview, Deactivate shows a toast and the status hint/callout changes; Activate brings them back. Delete soft-deletes: the row disappears from the default list and appears under the Deleted filter, where Restore returns it. The preview footer buttons don't overlap or wrap badly at around 1024px wide.
result: pass
### 5. Own record restrictions (superuser)
expected: Opening your own record (admin): no Deactivate/Delete offered or they are refused with a readable toast; the role, superuser switch and permission rows are locked with a note; the password field points you to My Account instead of letting you set it here.
result: pass
### 6. Roles screen
expected: Roles lists roles; create a role with a code, name and permissions via the permission editor, then save it. Code-declared grants on system roles show as locked rows with a note. Deleting a role still held by an admin is refused with a toast that names the role and the count; deleting a system role is refused; a system role's code is not editable.
result: pass
previous_result: pass
retest_reason: "modules/cabana/backend_roles_admin.go changed after the UAT pass (2026-10-22T11:17:34.000Z)"
note: "add todo to add users list (relation widget if we have one for this) in Roles" (todo roles-screen-holders-list.md)
### 7. Limited admin with only manage_users
expected: Create a role holding only backend.manage_users (plus whatever is needed to reach Settings), assign it to a new non-superuser admin, sign in as them in a private window. Only the Administrators tile shows (no Roles). No Superuser column, filter or switch; superusers (admin) are not listed. Permission rows they don't hold show locked; roles above their ceiling are locked in the role picker; their own record shows locked permissions and no Deactivate.
result: pass
### 8. Limited admin with only manage_roles
expected: Signed in as a non-superuser holding only backend.manage_roles: only the Roles tile shows. In the permission editor, permissions they don't hold are locked; they can't grant beyond their own set. (Known open gap CR-01: renaming a role's code onto a plugin-declared code escalates privileges — being fixed in the gap-closure session; note it, don't fail this test on it.)
result: pass
### 9. pact action-extension seam: a plugin adds record actions to summercms.cabana.users
expected: pact action-extension seam: a plugin adds record actions to summercms.cabana.users; offered on the preview after the owner's, run in the row-locked tx; unknown controller ID stops boot
result: pass
source: automated
coverage_id: 01-D1
### 10. Pseudo-plugin activation, tiles and orders
expected: Pseudo-plugin activates only with admin controllers; settings tile Administrators (order 100) and Roles (110) under System; codes granted to no role
result: pass
source: automated
coverage_id: 01-D2
### 11. Administrators form server rules
expected: Administrators form: create with password, superuser projection, D-03 hiding, D-05 superuser-only switch, D-08 own role/flag refusals, D-20 own password refusal, superuser demotion with a second superuser
result: pass
source: automated
coverage_id: 01-D3
### 12. Lifecycle server rules
expected: Lifecycle: deactivate revokes JWTs, soft delete with deleted row state, restore, trashed filter, self delete and self bulk-deactivate refused with whole-selection rollback, preview hint
result: pass
source: automated
coverage_id: 01-D4
### 13. Roles screen server rules
expected: Roles screen: create, code taken, in-use and system-role delete refusals, system code lock, settings order
result: pass
source: automated
coverage_id: 01-D5
### 14. Record-lock save rule
expected: Record-lock save rule: absent locked code keeps stored, differing present value is 403, equal body passes, no locks asked on create; meta.permissionLocks present only with a provider
result: pass
source: automated
coverage_id: 02-D1
### 15. Roles and Administrators saves under the record-lock rule
expected: Roles and Administrators saves keep working under the record-lock rule (system role grants, own record)
result: pass
source: automated
coverage_id: 02-D2
### 16. Trigger compile rules
expected: Valid trigger reaches the localized schema; malformed triggers are boot errors naming controller, field and trigger; settings and relation forms refuse it; Administrators permissions carries the D-06 trigger
result: pass
source: automated
coverage_id: 02-D3
### 17. Generated OpenAPI, schema.d.ts and admin build match
expected: Generated OpenAPI, schema.d.ts and the committed admin build match fresh generations
result: pass
source: automated
coverage_id: 02-D4
### 18. Save-path rules over HTTP on Postgres
expected: Superuser flag (D-05), hiding incl. scoped-token superusers (D-03), projection, permission and role ceilings (D-06, D-07), self edit (D-08), password and identity (D-11), outranking (D-19), own password (D-20)
result: pass
source: automated
coverage_id: 03-D1
### 19. Concurrent last-superuser protection
expected: Concurrent last-superuser protection on demote, record and bulk deactivate, form and bulk delete (held advisory lock), plus ten unsynchronized rounds
result: pass
source: automated
coverage_id: 03-D2
### 20. Lifecycle and revocation
expected: Lifecycle (Applies, 409, bulk Affected, soft delete, trashed filter, hint precedence) and revocation (JWT and personal tokens after deactivate and delete, sessions after a password set)
result: pass
source: automated
coverage_id: 03-D3
### 21. D-14 seam tests
expected: Boot refusals and order, offer and run only with both permissions, 409 when Applies turns false, Run in the transaction with the record; activation only with an admin
result: pass
source: automated
coverage_id: 03-D4
### 22. Roles tests
expected: Code taken and locked, plugin-declared system roles, in-use delete with soft-deleted holders, bulk delete rollback, permission ceiling
result: pass
source: automated
coverage_id: 03-D5
### 23. D-21 server side
expected: Trigger boot rules, record-lock save rule in both modes, code-declared and own-record locks on Postgres
result: pass
source: automated
coverage_id: 03-D6
### 24. D-21 SPA backstops
expected: Trigger disable, absent controlling field, hide-tab removal with the banner line, record-locked rows and payload omission, preview hide; footer wrap at 1024px with two 40-character contributed labels
result: pass
source: automated
coverage_id: 03-D7
### 25. Phase gate
expected: bash scripts/check-phase19.6.1.sh --all exits 0; SC-1 regression tests pass unchanged
result: pass
source: automated
coverage_id: 03-D8
### 26. Review the judgment-tier prohibitions in Plans 01-04 (listed under Prohibitions in the report) and confirm or reject the LLM-judge verdicts
expected: Each prohibition confirmed as held
result: pass
## Summary
total: 26
passed: 26
issues: 0
pending: 0
skipped: 0
blocked: 0
## Gaps
- gap_id: G-19.6.1-T2
truth: "After picking a role in the Administrators form, the role dropdown keeps showing the role's name when the user switches tabs and comes back"
status: resolved
resolved_by: 19.6.1-05
resolved_at: 2026-10-22
reason: "User reported after rebuild: confirmed, working as expected. Role dropdown keeps the name after switching tabs."
severity: minor
test: 2
root_cause: "FormView renders only the active tab's fields, so RelationField unmounts on a tab switch. On remount its id->label cache (known) is rebuilt only from props.labels (the server's meta.labels for the value stored at load time); the label of an option picked from an options page is lost and labelOf() falls back to String(id). Pre-existing in the generic relation field, not specific to this phase."
artifacts:
- path: "admin/src/components/form/fields/RelationField.vue"
issue: "known label cache is component-local and seeded only from props.labels (lines ~31-79, labelOf)"
- path: "admin/src/views/FormView.vue"
issue: "inactive tab panels are unmounted, discarding field-local state"
missing:
- "Keep picked option labels across remounts: lift the label cache to the form context (per field) or emit the picked label with update:modelValue so FormView passes it back in labels; alternatively keep tab panels mounted with v-show"
- "Vitest backstop: pick an option, switch tab and back, label still shown"
debug_session: ""

View File

@@ -5,7 +5,7 @@ slug: "backend-administrators-screen"
# audit-milestone §5.5 distinguishes NOT-VALIDATED (draft) from PARTIAL (validated + nyquist_compliant: false) (#2117)
status: draft
nyquist_compliant: false
wave_0_complete: false
wave_0_complete: true
created: "2026-10-21"
---
@@ -42,16 +42,16 @@ Filled by the planner per task; the decision → test map lives in `19.6.1-RESEA
| Task ID | Plan | Wave | Requirement | Threat Ref | Secure Behavior | Test Type | Automated Command | File Exists | Status |
|---------|------|------|-------------|------------|-----------------|-----------|-------------------|-------------|--------|
| 19.6.1-01-01 | 01 | 1 | D-01, D-02, D-04, D-14, D-15 | T-19.6.1-09, -10, -14 | seam merged before permission validation; contributed actions behind target + own permissions; no default role grant | smoke (-short + Postgres) | `go test -short -run '^TestBackendScreensSmoke$' ./modules/cabana`; `go test -run '^TestBackendScreensPostgresSmoke$' ./modules/cabana`; `go -C examples/hello test ./...` | ❌ W0 | ⬜ pending |
| 19.6.1-01-02 | 01 | 1 | D-03, D-05..D-08, D-11, D-12, D-19, D-20 | T-19.6.1-01..-05, -07, -08, -11, -13, -17 | save-path rules in the save tx; is_superuser projected; hidden for non-superusers | smoke (Postgres) | `go test -run '^TestAdministratorsFormSmoke$' ./modules/cabana` | ❌ W0 | ⬜ pending |
| 19.6.1-01-03 | 01 | 1 | D-08, D-09, D-10, D-12, D-19 | T-19.6.1-05, -06, -11, -12 | last-superuser guard under advisory lock; soft delete only; revocation | smoke (Postgres) | `go test -run '^TestAdministratorsLifecycleSmoke$' ./modules/cabana` | ❌ W0 | ⬜ pending |
| 19.6.1-01-04 | 01 | 1 | D-02, D-07, D-16, D-17 | T-19.6.1-04, -15 | roles ceiling; system role code locked; in-use delete refused | smoke (Postgres) | `go test -run '^TestRolesSmoke$' ./modules/cabana`; `scripts/check-admin-openapi.sh --check` | ❌ W0 | ⬜ pending |
| 19.6.1-02-01 | 02 | 2 | D-21 (D-16, D-08) | T-19.6.1-19, -20, -22, -23 | record-locked codes kept server-side; changed value 403 | smoke (-short) + vitest | `go test -short -run '^TestPermissionRecordLocksSmoke$' ./modules/cabana`; `scripts/check-admin-openapi.sh --check`; `npm --prefix admin run test` | ❌ W0 | ⬜ pending |
| 19.6.1-02-02 | 02 | 2 | D-21 (D-06) | T-19.6.1-18, -21, -22, -23 | trigger boot errors; disabled field not sent; dist matches build | smoke (-short) + vitest + dist | `go test -short -run '^TestFieldTriggerSmoke$' ./modules/cabana`; `npm --prefix admin run test`; `scripts/check-admin-dist.sh` | ❌ W0 | ⬜ pending |
| 19.6.1-03-01 | 03 | 3 | D-05, D-18 | T-19.6.1-24, -26 | harness + first rule over HTTP | Postgres | `go test -run '^TestAdministratorsSuperuserFlag$' ./modules/cabana` | ❌ W0 | ⬜ pending |
| 19.6.1-03-02 | 03 | 3 | D-03, D-06, D-07, D-08, D-11, D-19, D-20 | T-19.6.1-24 | each save-path rule has a failing-without-rule test | unit (-short) + Postgres | `go test -short -run '^TestRoleCeiling$' ./modules/cabana`; `go test -run '^TestAdministrators(SuperuserHidden\|SuperuserProjected\|PermissionCeiling\|RoleCeiling\|SelfEdit\|PasswordAndIdentity\|Outranked\|OwnPassword)$' ./modules/cabana` | ❌ W0 | ⬜ pending |
| 19.6.1-03-03 | 03 | 3 | D-04, D-09, D-10, D-12, D-14, D-16, D-17 | T-19.6.1-24, -25, -26 | held-lock race on 5 paths; revocation; seam boot and run; roles | unit (-short) + Postgres | `go test -short -run '^(TestActionExtensionBoot\|TestBackendScreensActivation)$' ./modules/cabana`; `go test -run '^(TestAdministratorsLastSuperuser\|TestAdministratorsLastSuperuserConcurrent\|TestAdministratorsLifecycle\|TestAdministratorsRevocation\|TestActionExtensionRun\|TestRolesLifecycle\|TestRolesPermissionCeiling)$' ./modules/cabana` | ❌ W0 | ⬜ pending |
| 19.6.1-03-04 | 03 | 3 | D-21, D-18 | T-19.6.1-24, -27 | D-21 Go + SPA tests incl. backstops; fail-closed gate | unit + vitest + browser + gate | `go test -short -run '^(TestFieldTriggerBoot\|TestPermissionRecordLocks)$' ./modules/cabana`; `npm --prefix admin run test`; `npm --prefix admin run test:browser`; `bash scripts/check-phase19.6.1.sh --all` | ❌ W0 | ⬜ pending |
| 19.6.1-01-01 | 01 | 1 | D-01, D-02, D-04, D-14, D-15 | T-19.6.1-09, -10, -14 | seam merged before permission validation; contributed actions behind target + own permissions; no default role grant | smoke (-short + Postgres) | `go test -short -run '^TestBackendScreensSmoke$' ./modules/cabana`; `go test -run '^TestBackendScreensPostgresSmoke$' ./modules/cabana`; `go -C examples/hello test ./...` | ✅ | ✅ green |
| 19.6.1-01-02 | 01 | 1 | D-03, D-05..D-08, D-11, D-12, D-19, D-20 | T-19.6.1-01..-05, -07, -08, -11, -13, -17 | save-path rules in the save tx; is_superuser projected; hidden for non-superusers | smoke (Postgres) | `go test -run '^TestAdministratorsFormSmoke$' ./modules/cabana` | ✅ | ✅ green |
| 19.6.1-01-03 | 01 | 1 | D-08, D-09, D-10, D-12, D-19 | T-19.6.1-05, -06, -11, -12 | last-superuser guard under advisory lock; soft delete only; revocation | smoke (Postgres) | `go test -run '^TestAdministratorsLifecycleSmoke$' ./modules/cabana` | ✅ | ✅ green |
| 19.6.1-01-04 | 01 | 1 | D-02, D-07, D-16, D-17 | T-19.6.1-04, -15 | roles ceiling; system role code locked; in-use delete refused | smoke (Postgres) | `go test -run '^TestRolesSmoke$' ./modules/cabana`; `scripts/check-admin-openapi.sh --check` | ✅ | ✅ green |
| 19.6.1-02-01 | 02 | 2 | D-21 (D-16, D-08) | T-19.6.1-19, -20, -22, -23 | record-locked codes kept server-side; changed value 403 | smoke (-short) + vitest | `go test -short -run '^TestPermissionRecordLocksSmoke$' ./modules/cabana`; `scripts/check-admin-openapi.sh --check`; `npm --prefix admin run test` | ✅ | ✅ green |
| 19.6.1-02-02 | 02 | 2 | D-21 (D-06) | T-19.6.1-18, -21, -22, -23 | trigger boot errors; disabled field not sent; dist matches build | smoke (-short) + vitest + dist | `go test -short -run '^TestFieldTriggerSmoke$' ./modules/cabana`; `npm --prefix admin run test`; `scripts/check-admin-dist.sh` | ✅ | ✅ green |
| 19.6.1-03-01 | 03 | 3 | D-05, D-18 | T-19.6.1-24, -26 | harness + first rule over HTTP | Postgres | `go test -run '^TestAdministratorsSuperuserFlag$' ./modules/cabana` | ✅ | ✅ green |
| 19.6.1-03-02 | 03 | 3 | D-03, D-06, D-07, D-08, D-11, D-19, D-20 | T-19.6.1-24 | each save-path rule has a failing-without-rule test | unit (-short) + Postgres | `go test -short -run '^TestRoleCeiling$' ./modules/cabana`; `go test -run '^TestAdministrators(SuperuserHidden\|SuperuserProjected\|PermissionCeiling\|RoleCeiling\|SelfEdit\|PasswordAndIdentity\|Outranked\|OwnPassword)$' ./modules/cabana` | ✅ | ✅ green |
| 19.6.1-03-03 | 03 | 3 | D-04, D-09, D-10, D-12, D-14, D-16, D-17 | T-19.6.1-24, -25, -26 | held-lock race on 5 paths; revocation; seam boot and run; roles | unit (-short) + Postgres | `go test -short -run '^(TestActionExtensionBoot\|TestBackendScreensActivation)$' ./modules/cabana`; `go test -run '^(TestAdministratorsLastSuperuser\|TestAdministratorsLastSuperuserConcurrent\|TestAdministratorsLifecycle\|TestAdministratorsRevocation\|TestActionExtensionRun\|TestRolesLifecycle\|TestRolesPermissionCeiling)$' ./modules/cabana` | ✅ | ✅ green |
| 19.6.1-03-04 | 03 | 3 | D-21, D-18 | T-19.6.1-24, -27 | D-21 Go + SPA tests incl. backstops; fail-closed gate | unit + vitest + browser + gate | `go test -short -run '^(TestFieldTriggerBoot\|TestPermissionRecordLocks)$' ./modules/cabana`; `go test -run '^TestRolesCodeDeclaredLocks$' ./modules/cabana`; `npm --prefix admin run test`; `npm --prefix admin run test:browser`; `bash scripts/check-phase19.6.1.sh --all` | ✅ | ✅ green |
*Status: ⬜ pending · ✅ green · ❌ red · ⚠️ flaky*
@@ -59,19 +59,21 @@ Filled by the planner per task; the decision → test map lives in `19.6.1-RESEA
## Wave 0 Requirements
- [ ] `modules/cabana/backend_screens_test.go` — activation and schema (`-short`; smoke in plan 01, `TestBackendScreensActivation` in plan 03)
- [ ] `modules/cabana/backend_screens_smoke_test.go` — plan 01 Postgres smokes
- [ ] `modules/cabana/record_locks_smoke_test.go`, `modules/cabana/field_trigger_smoke_test.go` — plan 02 smokes (`-short`)
- [ ] `modules/cabana/action_extensions_test.go` (boot, `-short`) and `modules/cabana/action_extensions_postgres_test.go` (run) — D-14
- [ ] `modules/cabana/backend_privileges_internal_test.go` — subset/ceiling helpers (`package cabana`)
- [ ] `modules/cabana/administrators_harness_test.go` — superuser-capable seeding, roles, login, `isolateSuperusers`
- [ ] `modules/cabana/administrators_postgres_test.go` — D-03, D-05..D-08, D-11, D-19, D-20 at HTTP level
- [ ] `modules/cabana/administrators_lifecycle_postgres_test.go` — D-09 held-lock race, D-10, D-12
- [ ] `modules/cabana/roles_postgres_test.go` — D-07 (roles), D-16, D-17, D-21 code-declared locks
- [ ] `modules/cabana/field_trigger_test.go`, `modules/cabana/record_locks_test.go` — D-21 (`-short`)
- [ ] `admin/tests/form/trigger.test.ts` + additions to PermissionEditorField, formState, FormView, PreviewView tests; `admin/tests/browser/record-actions-wrap.test.ts`
- [ ] `scripts/check-phase19.6.1.sh` — phase gate
- [ ] `modules/cabana/export_test.go` — `SuperuserLockKey`
Ticked with the files as built (Plan 03 moved the screens harness out of `backend_screens_smoke_test.go` into `administrators_harness_test.go`).
- [x] `modules/cabana/backend_screens_test.go` — activation and schema (`-short`; `TestBackendScreensSmoke` in plan 01, `TestBackendScreensActivation` in plan 03)
- [x] `modules/cabana/backend_screens_smoke_test.go` — plan 01 Postgres smokes
- [x] `modules/cabana/record_locks_smoke_test.go`, `modules/cabana/field_trigger_smoke_test.go` — plan 02 smokes (`-short`)
- [x] `modules/cabana/action_extensions_test.go` (`TestActionExtensionBoot`, `-short`) and `modules/cabana/action_extensions_postgres_test.go` (`TestActionExtensionRun`) — D-14
- [x] `modules/cabana/backend_privileges_internal_test.go` — `TestRoleCeiling` against `grantsCovered` (`package cabana`)
- [x] `modules/cabana/administrators_harness_test.go` — `newScreensEnv`, `seedAdmin`, `seedRole`, `login`, `isolateSuperusers`, row snapshots
- [x] `modules/cabana/administrators_postgres_test.go` — D-03, D-05..D-08, D-11, D-19, D-20 at HTTP level
- [x] `modules/cabana/administrators_lifecycle_postgres_test.go` — D-09 held-lock race on five paths, the unsynchronized rounds, D-10, D-12
- [x] `modules/cabana/roles_postgres_test.go` — D-07 (roles), D-16, D-17, D-21 code-declared locks
- [x] `modules/cabana/field_trigger_test.go`, `modules/cabana/record_locks_test.go` — D-21 (`-short`)
- [x] `admin/tests/form/trigger.test.ts` + additions to PermissionEditorField, formState, FormView, PreviewView tests; `admin/tests/browser/record-actions-wrap.test.ts`
- [x] `scripts/check-phase19.6.1.sh` — phase gate (`--all`: self-test, go, admin, docs, sc1, docker)
- [x] `modules/cabana/export_test.go` — `SuperuserLockKey`
---

View File

@@ -0,0 +1,327 @@
---
phase: 19.6.1-backend-administrators-screen
verified: 2026-10-22T12:58:00Z
status: passed
score: 28/28 must-haves verified
covered_files:
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-PLAN.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-SUMMARY.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-02-PLAN.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-02-SUMMARY.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-03-PLAN.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-03-SUMMARY.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-04-PLAN.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-04-SUMMARY.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-05-PLAN.md
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-05-SUMMARY.md
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- admin/src/api/types.ts
- admin/src/components/form/FormField.vue
- admin/src/components/form/control.ts
- admin/src/components/form/fields/PermissionEditorField.vue
- admin/src/components/form/fields/RelationField.vue
- admin/src/components/form/formContext.ts
- admin/src/components/form/formState.ts
- admin/src/components/form/trigger.ts
- admin/src/components/relation/RelationChildModal.vue
- admin/src/views/FormView.vue
- admin/src/views/PreviewView.vue
- admin/tests/browser/record-actions-wrap.test.ts
- admin/tests/form/FormView.test.ts
- admin/tests/form/PermissionEditorField.test.ts
- admin/tests/form/PreviewView.test.ts
- admin/tests/form/RelationField.test.ts
- admin/tests/form/formState.test.ts
- admin/tests/form/trigger.test.ts
- admin/vitest.browser.config.ts
- docs/backend/admin-controllers.md
- docs/backend/forms.md
- docs/backend/users-and-permissions.md
- modules/boardwalk/dist/assets/index-BtP5LUQA.js
- modules/boardwalk/dist/index.html
- modules/cabana/README.md
- modules/cabana/action_extensions.go
- modules/cabana/action_extensions_postgres_test.go
- modules/cabana/action_extensions_test.go
- modules/cabana/admin_openapi.go
- modules/cabana/administrators_harness_test.go
- modules/cabana/administrators_lifecycle_postgres_test.go
- modules/cabana/administrators_postgres_test.go
- modules/cabana/backend_privileges.go
- modules/cabana/backend_privileges_internal_test.go
- modules/cabana/backend_roles_admin.go
- modules/cabana/backend_screens.go
- modules/cabana/backend_screens_smoke_test.go
- modules/cabana/backend_screens_test.go
- modules/cabana/backend_users_admin.go
- modules/cabana/backendscreens/controllers/roles/config_form.yaml
- modules/cabana/backendscreens/controllers/roles/config_list.yaml
- modules/cabana/backendscreens/controllers/users/_hint.htm
- modules/cabana/backendscreens/controllers/users/config_filter.yaml
- modules/cabana/backendscreens/controllers/users/config_form.yaml
- modules/cabana/backendscreens/controllers/users/config_list.yaml
- modules/cabana/backendscreens/models/user/columns.yaml
- modules/cabana/backendscreens/models/user/fields.yaml
- modules/cabana/backendscreens/models/userrole/columns.yaml
- modules/cabana/backendscreens/models/userrole/fields.yaml
- modules/cabana/contracts.go
- modules/cabana/crud.go
- modules/cabana/example_action_extension_test.go
- modules/cabana/example_permission_record_locks_test.go
- modules/cabana/export_test.go
- modules/cabana/field_dependent.go
- modules/cabana/field_permission.go
- modules/cabana/field_repeater.go
- modules/cabana/field_trigger.go
- modules/cabana/field_trigger_smoke_test.go
- modules/cabana/field_trigger_test.go
- modules/cabana/form_schema.go
- modules/cabana/http.go
- modules/cabana/record_locks_smoke_test.go
- modules/cabana/record_locks_test.go
- modules/cabana/registry.go
- modules/cabana/relation_child.go
- modules/cabana/relation_field.go
- modules/cabana/roles_postgres_test.go
- modules/cabana/schema_types.go
- modules/pact/README.md
- modules/pact/capabilities.go
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- scripts/check-phase19.6.1.sh
covered_digest: "v2:sha256:a5616df163b8bd493b54f6ee5fb739c43c32ab07b10cf8a2f87753f77ced72d9"
behavior_unverified: 0
overrides_applied: 0
decision_coverage:
honored: 22
total: 22
not_honored: []
re_verification:
previous_status: human_needed
previous_score: 25/25
gaps_closed:
- "G-19.6.1-T2 implementation: picked relation labels persist across FormView tab remount (FORM_REMEMBER_LABEL + two named vitest cases). Human UAT row 2 was not re-run."
gaps_remaining: []
regressions: []
advisory: []
human_verified:
- test: "Settings tiles and Administrators list (superuser)"
uat_row: 1
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Superuser switch locks the permission overrides"
uat_row: 3
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Deactivate, delete, restore"
uat_row: 4
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Own record restrictions (superuser)"
uat_row: 5
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Roles screen"
uat_row: 6
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Limited admin with only manage_users"
uat_row: 7
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Limited admin with only manage_roles"
uat_row: 8
recorded_at: "2026-10-22T12:30:13.000Z"
- test: "Review the judgment-tier prohibitions in Plans 01-04 (listed under Prohibitions in the report) and confirm or reject the LLM-judge verdicts"
uat_row: 26
recorded_at: "2026-10-22T12:30:13.000Z"
human_verification:
- test: "Create an administrator"
expected: "Create opens the form with login, email, name, password + confirmation, role, a Superuser switch and Permission overrides. Saving with a mismatched or 3-character password shows a field error. Saving a valid admin (role e.g. developer, Superuser off) lands on the record and shows a success toast. After picking Developer and switching to Permissions and back, the role dropdown still shows Developer, not the raw id."
why_human: "UAT row 2 is still result: issue. Plan 05 shipped FORM_REMEMBER_LABEL and both named vitest cases pass on the widgets fixture; the human has not re-run the Administrators form in the browser. Do not treat the unit backstops as a UAT pass."
---
# Phase 19.6.1: Backend Administrators screen Verification Report
**Phase Goal:** cabana gets WinterCMS's Administrators screens, so backend admins and their roles are managed in the admin SPA instead of only through `admin:*` console commands. It reuses cabana's CRUD, permission field and record actions, and follows the sm-user-plugin Users/Groups screens and WinterCMS `Backend\Controllers\Users`/`UserRoles`.
**Verified:** 2026-10-22T12:58:00Z
**Status:** human_needed
**Re-verification:** Yes — after gap-closure plan 19.6.1-05 (G-19.6.1-T2 only)
## Goal Achievement
Plan 05 closed the T2 remount-label hole in the SPA: `FORM_REMEMBER_LABEL` persists a picked relation option on the form host, `choose()` writes it before emit, and a remounted `RelationField` seeds `known` from `props.labels`. Both named vitest cases passed in this run. The embedded dist carries `summer.form.rememberLabel`. The prior 25 phase truths still hold (no Go/pact/YAML/OpenAPI change this wave).
UAT row 2 is still `issue`. Plan 05 had no human-verify checkpoint. This report does not invent a UAT pass. Status stays `human_needed`.
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| SC-1 | Admin with manage-administrators lists/creates/edits/deactivates backend users and edits roles with the permission editor; existing payloads and `admin:*` commands unchanged | ✓ VERIFIED (human UAT, rows 1, 3–5, 7) | YAML screens and controllers unchanged this wave; git log since prior `verified:` empty on cabana/pact/phrasebook/openapi |
| SC-2 | Only a superuser can create/edit/grant superuser; an admin cannot raise their own role or permissions; last active superuser protected | ✓ VERIFIED | `refuseCodeDeclaredCode` still present (4); prior Postgres names unchanged |
| SC-3 | Record-action seam usable by plugins; unit tests cover privilege rules | ✓ VERIFIED | `wrapAdministratorsContributedRun` still present (3); `func guardOutranked` still unexported |
| D-01 | `backend.manage_users`, `backend.manage_roles` registered by internal pseudo-plugin | ✓ VERIFIED | `backend_screens.go` exists; prior pass |
| D-02 | Settings → System placement, no navigation item | ✓ VERIFIED | UAT row 1; no this-wave change |
| D-03 | Superusers hidden from non-superusers | ✓ VERIFIED | UAT row 7; no this-wave change |
| D-04 | No default role grant | ✓ VERIFIED | prior pass |
| D-05 | Only superuser sets is_superuser; non-superuser sending it gets 403 | ✓ VERIFIED | prior pass |
| D-06 | Per-user radio permission override, disabled while superuser on | ✓ VERIFIED | UAT row 3; no this-wave change |
| D-07 | Non-superuser can't grant more than they hold (permissions, role picker, Roles screen) | ✓ VERIFIED | prior pass + `refuseCodeDeclaredCode` |
| D-08 | Own record: profile editable; role/superuser/permissions/activation/delete refused | ✓ VERIFIED | UAT row 5 |
| D-09 | Last active superuser protected on every write path under lock | ✓ VERIFIED | prior behavioral tests; files unchanged this wave |
| D-10 | Deactivate + soft delete + restore, no hard delete | ✓ VERIFIED | UAT row 4 |
| D-11 | Password typed in form, required on create, bcrypt | ✓ VERIFIED | prior pass |
| D-12 | Deactivate/delete/password-set bump tokens_valid_after | ✓ VERIFIED | prior pass |
| D-13 | No invite or welcome mail | ✓ VERIFIED | no this-wave change to `backend_users_admin.go` |
| D-14 | Generic cross-controller action extension with boot errors | ✓ VERIFIED | prior pass |
| D-15 | Contributed actions on preview only | ✓ VERIFIED | prior pass |
| D-16 | Roles fields; system roles code locked; a role never becomes a code-declared system role through the screen | ✓ VERIFIED | `refuseCodeDeclaredCode` still wired |
| D-17 | Held role or system role cannot be deleted | ✓ VERIFIED | prior pass; UAT row 6 settled (plan 05 files do not bear on Roles checks) |
| D-18 | Unit tests last plan; docs updated | ✓ VERIFIED | plans 01–04 files untouched this wave; plan 05 added SPA tests only |
| D-19 | No outranking on update/delete/record/bulk actions, contributed Administrators Runs included | ✓ VERIFIED | wrap still compiled in |
| D-20 | Own password refused on this screen | ✓ VERIFIED | UAT row 5 |
| D-21 | SPA support: field trigger + per-record locked permission values | ✓ VERIFIED | UAT rows 3 and 5; plan 05 did not change trigger/lock path |
| D-22 | Plan split (plus gap-closure waves 4 and 5) | ✓ VERIFIED | 01 server, 02 SPA, 03 tests, 04 privilege gaps, 05 remount labels |
| T2-1 | After picking a relation option on a tabbed form, switching tabs and coming back still shows that option's name, not String(id) | ✓ VERIFIED (behavioral) | this-run `npm --prefix admin run test -- … -t "keeps a picked relation label after switching tabs"` — 1 passed. `panelFields` still filters to the active tab; `v-show` count in FormView is 0 |
| T2-2 | A remounted RelationField seeds its id→label cache from the form's remembered labels, not only from the server meta.labels captured at load | ✓ VERIFIED (behavioral) | this-run `-t "shows a picked label after remount when the form remembered it"` — 1 passed. `choose()` calls `rememberLabel` before emit; remount watch is `watch(() => props.labels, remember, { immediate: true })` |
| T2-3 | modules/boardwalk/dist matches a fresh admin build so the embedded SPA used by the local demo carries the fix | ✓ VERIFIED | `index.html` present; `assets/index-BtP5LUQA.js` contains `summer.form.rememberLabel` (1) and `rememberLabel` (1); commit `51e1a1e`. `verify.artifacts` reports the directory as "Not a file" (tool limitation) |
**Score:** 28/28 truths verified (0 present, behavior-unverified)
### Advisory (New Scope, Unevidenced)
None. Re-verification scanned Step 7 on files touched since the prior `verified:` timestamp (`formContext.ts`, `FormView.vue`, `RelationChildModal.vue`, `RelationField.vue`, the two test files, boardwalk dist). No new-scope blocker lacked deterministic evidence. WR-01, WR-02 and IN-01..IN-06 remain the same pre-gap-closure warnings/info; those Go files were not modified in plan 05.
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `admin/src/components/form/formContext.ts` | FORM_REMEMBER_LABEL injection key | ✓ VERIFIED | lines 174–180; typed `InjectionKey<(field, option) => void>`; missing provider is a no-op |
| `admin/src/views/FormView.vue` | rememberRelationLabel + provide | ✓ VERIFIED | helper at 251–261 merges by `option.value`; `provide(FORM_REMEMBER_LABEL, rememberRelationLabel)` at 352; `:labels="labels"` on FormGrid at 655 |
| `admin/src/components/form/fields/RelationField.vue` | choose() remembers before emit | ✓ VERIFIED | inject at 26; `rememberLabel?.(...)` inside `choose()` at 231–236 before `update:modelValue` |
| `admin/src/components/relation/RelationChildModal.vue` | same helper and provide | ✓ VERIFIED | helper at 218–228; provide at 229 |
| `admin/tests/form/FormView.test.ts` | tab-switch backstop | ✓ VERIFIED | `keeps a picked relation label after switching tabs` at 944; this-run PASS |
| `admin/tests/form/RelationField.test.ts` | remount backstop | ✓ VERIFIED | `shows a picked label after remount when the form remembered it` at 249; this-run PASS |
| `modules/boardwalk/dist` | remount-safe embed | ✓ VERIFIED | directory; `index.html` + `index-BtP5LUQA.js` with `summer.form.rememberLabel` |
| Prior cabana/pact/YAML/SPA artifacts from plans 01–04 | still present | ✓ VERIFIED | existence check this run; 16/16 prior paths OK |
`msd_run query verify.artifacts` on 19.6.1-05-PLAN.md: 5/6 passed (dist directory flagged "Not a file"; contents verified by hand).
### Key Link Verification
| From | To | Via | Status | Details |
|------|----|-----|--------|---------|
| RelationField.vue | formContext.ts | choose injects FORM_REMEMBER_LABEL and writes the picked option before update:modelValue | ✓ WIRED | pattern found; write is before emit |
| FormView.vue | RelationField.vue | remembered labels flow back as props.labels so remount's watch seeds known | ✓ WIRED | `rememberRelationLabel` mutates `labels`; FormGrid `:labels="labels"`; RelationField watch immediate |
| FormView.vue | FormGrid | single panel, inactive tabs unmounted | ✓ WIRED | `panelFields` filters by active tab; `v-show` count 0 |
| RelationChildModal.vue | formContext.ts | child host provides FORM_REMEMBER_LABEL against its own labels ref | ✓ WIRED | provide at 229 |
| Prior links (http.go compileActionExtensions, refuseCodeDeclaredCode, wrapAdministratorsContributedRun, applyTriggers) | — | — | ✓ WIRED | files unchanged this wave; symbols still present |
`msd_run query verify.key-links` on 19.6.1-05-PLAN.md: 2/2 verified.
### Data-Flow Trace (Level 4)
| Artifact | Data Variable | Source | Produces Real Data | Status |
|----------|---------------|--------|--------------------|--------|
| RelationField combobox | `known[id]` / `labelOf` | `props.labels` (server `meta.labels` plus FORM_REMEMBER_LABEL writes) and options pages | yes — picked `{value,label}` from the options list the admin already saw | ✓ FLOWING |
| FormView `labels` | `labels.value[field]` | `adopt()` from `record.meta.labels`; `rememberRelationLabel` merge on pick | yes — replace-or-append by id; adopt still overwrites on load/save | ✓ FLOWING |
| Administrators role field | role id | cabana relation options + user/fields.yaml `type: relation` on Account tab | yes — same RelationField path; Permissions tab remounts Account | ✓ FLOWING |
| Prior list/show/permissionLocks/contributed Run | — | unchanged this wave | yes | ✓ FLOWING |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| T2 tab-switch label | `npm --prefix admin run test -- tests/form/RelationField.test.ts tests/form/FormView.test.ts -t "keeps a picked relation label after switching tabs\|shows a picked label after remount when the form remembered it"` | 2 passed / 65 skipped | ✓ PASS |
| Dist carries remember inject | python count of `summer.form.rememberLabel` in `index-BtP5LUQA.js` | 1 | ✓ PASS |
| Inactive tabs stay unmounted | `grep -c v-show admin/src/views/FormView.vue` | 0 | ✓ PASS |
| Plans 01–04 / Go / pact / YAML / OpenAPI / npm lock untouched | `git log --since=2026-10-22T11:46:44Z` on those paths | empty | ✓ PASS |
| Prior privilege wrap still compiled | `grep -c wrapAdministratorsContributedRun` / `func guardOutranked` | 3 / 1 | ✓ PASS |
Full-suite `go test ./...` was not re-run (prior post-merge pass; this wave is SPA-only). `check-admin-dist.sh` was not re-run (rebuild, over 10s). Dist symbol + `51e1a1e` stand in.
### Probe Execution
No `scripts/*/tests/probe-*.sh` is declared for this phase. The fail-closed phase gate is `scripts/check-phase19.6.1.sh` (not re-run; no Go change).
| Probe | Command | Result | Status |
|-------|---------|--------|--------|
| (none conventional) | — | — | SKIP |
### Requirements Coverage
REQUIREMENTS.md maps no IDs to 19.6.1 (`phase_req_ids` null; no orphaned requirements). Plan 05 `requirements: []`. Every ID declared across plans 01–04 is accounted for (unchanged from the prior pass):
| Requirement | Source Plan | Description | Status | Evidence |
|-------------|-------------|-------------|--------|----------|
| SC-1 | 01, 02, 03 | list/create/edit/deactivate; roles editor; payloads and admin:* unchanged | ✓ SATISFIED | prior + this-wave git empty on command/payload files |
| SC-2 | 01, 02, 03, 04 | superuser-only flag; cannot self-raise; last superuser | ✓ SATISFIED | prior |
| SC-3 | 01, 03 | seam + privilege tests | ✓ SATISFIED | prior |
| D-01..D-22 | 01/02/03/04 | CONTEXT.md decisions | ✓ SATISFIED | 22/22 decision coverage; no this-wave Go change |
| G-19.6.1-T2 | 05 (UAT gap) | picked relation label survives tab remount | ✓ SATISFIED (code); human UAT row 2 not re-run | vitest + inject wiring |
### Decision Coverage
All trackable CONTEXT.md decisions are honored by shipped artifacts (22/22, `check.decision-coverage-verify`). Non-blocking.
### Prohibitions
Plan 05 prohibitions are grep-tier (verified this run). Plans 01–04 judgment-tier items were human-passed as UAT row 26.
| Plan | Prohibition | Verdict |
|------|-------------|---------|
| 05 | Do not keep inactive tab panels mounted with v-show | holds (`v-show` count 0; `panelFields` still filters) |
| 05 | Do not edit 19.6.1-01/02/03/04-PLAN.md; no cabana Go, pact, phrasebook, YAML, OpenAPI; no new npm dependency | holds (git log since prior `verified:` empty on those paths and `admin/package.json`) |
| 05 | Framework code, READMEs, docs and tests name no consuming application | holds (fonoteka/plytarium/grzyby/wavepath count 0 on the six plan-05 source/test files) |
| 01–04 | judgment-tier set from the prior report | human-passed (UAT row 26) |
### Test Quality Audit
| Test File | Linked Req | Active | Skipped | Circular | Assertion Level | Verdict |
|-----------|-----------|--------|---------|----------|-----------------|---------|
| FormView.test.ts#keeps a picked relation label after switching tabs | G-19.6.1-T2 / T2-1 | yes | 0 | no | behavioral (pick Acme Works, Details tab, back, combobox is name not `1`) | sufficient |
| RelationField.test.ts#shows a picked label after remount when the form remembered it | T2-2 | yes | 0 | no | behavioral (choose writes bag, remount with bag labels, value is name not `1`) | sufficient |
| Plan 03/04 named rule tests | D-03..D-21, CR-01, WR-03 | yes | 0 | no | behavioral | sufficient (prior pass; files unchanged) |
**Disabled tests on requirements:** 0 (`it.skip` / `test.todo` none in the two plan-05 test files)
**Circular patterns detected:** 0
**Insufficient assertions:** 0
The FormView case uses the widgets fixture (`maker` on default, `serial` on Details). That is the same one-panel remount path the Administrators form uses (`role` on Account, permissions on Permissions). Fixture supplies the same shape the real form has — not coincidental-reliance.
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| modules/cabana/backend_users_admin.go, backend_privileges.go | — | Ceilings use the owner's full grants under a scoped personal token (WR-01) | ⚠️ Warning | Pre-gap-closure; files not modified in plan 05 |
| modules/cabana/backend_users_admin.go | — | Stored override values other than 1/-1 dropped on save (WR-02) | ⚠️ Warning | Same as prior pass |
| modules/cabana/backend_privileges.go | — | Last-superuser count relies on READ COMMITTED (IN-01) | ℹ️ Info | |
| modules/cabana/backend_users_admin.go / crud.go | — | Re-delete of a trashed admin reports success, bumps tokens (IN-02) | ℹ️ Info | |
| modules/cabana/backend_roles_admin.go | — | Unlocked code-uniqueness and holder count (IN-03, IN-04) | ℹ️ Info | |
| modules/cabana/backend_users_admin.go | — | toggleOn reads unknown encodings as off (IN-05) | ℹ️ Info | |
| modules/cabana/backend_users_admin.go | — | Own role picker editable, refused only on save (IN-06) | ℹ️ Info | UX |
No TBD/FIXME/XXX/TODO/HACK markers in the files plan 05 modified. No consuming-application names. Code review of plan 05 was clean (`587f9dd` / 19.6.1-REVIEW.md status clean).
### Human Verification Required
Recorded UAT (`19.6.1-UAT.md`, `recorded_at` 2026-10-22T12:30:13.000Z, status complete, 25 pass / 1 issue) still has test 2 as `issue`. `changed_since_uat`: `RelationField.vue`, `formContext.ts`, `RelationChildModal.vue`, `FormView.vue`, `modules/boardwalk/dist` — those files are exactly the T2 remount fix and they bear on test 2.
Roles (row 6) stays settled: the Roles form has no relation field (name/code/description/permissioneditor only). Plan 05's remember-label path is unused there. `backend_roles_admin.go` is not in `changed_since_uat` for this recorded_at. Judgment-tier prohibitions (row 26) passed and plan 05's new prohibitions are grep-tier, verified above.
The plan-02 harvested `<human-check>` (superuser switch / locked rows) is UAT rows 3 and 5 — already passed.
### 1. Create an administrator
**Test:** Create an administrator
**Expected:** Create opens the form with login, email, name, password + confirmation, role, a Superuser switch and Permission overrides. Saving with a mismatched or 3-character password shows a field error. Saving a valid admin (role e.g. developer, Superuser off) lands on the record and shows a success toast. After picking Developer and switching to Permissions and back, the role dropdown still shows Developer, not the raw id.
**Why human:** UAT row 2 is still `issue`. Plan 05 closed the remount path in code and in vitest (widgets `maker`/`serial`). The human has not re-run the Administrators form. Do not invent a UAT pass.
UAT row 8's note that CR-01 is a known open gap is stale: that hole is closed on the server (plan 04). Do not fail the limited-admin visual re-check on CR-01.
### Gaps Summary
**No blocking gaps.** G-19.6.1-T2 is closed in the SPA and the embedded dist. The remaining item is a recorded UAT issue the human has not re-checked after plan 05. That is `human_needed`, not `gaps_found`.
Later phases do not cover this UAT row: 19.7 consumes the Administrators action seam; 19.8 is console; 20 is the demo instance. Do not defer the browser re-check.
---
_Verified: 2026-10-22T12:58:00Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,8 @@
# Deferred items: Phase 19.6.1
Out-of-scope findings logged during execution. Not fixed in this phase.
## From 19.6.1-03 (tests)
- **lagoon: the model validator does not apply string `min`/`max`.** `lagoon.Validate` (modules/lagoon/validate.go) collects `min=`/`max=` tags for non-numeric rules and then skips them, so a model or `pact.FormRules` rule such as `min:4` or `max:255` on a string never refuses a value (only `between` is checked by length). The request validator (`validate_request.go`) handles them. Found because the Administrators form's `password` rule `min:4` let a 3-character password through; 19.6.1-03 fixed that one rule locally in `usersAdmin.storePassword` (commit 461cb21). The lagoon fix changes behaviour for every model with string length rules (an over-long `login` currently reaches Postgres and fails as a 500 instead of a 422), so it needs its own change and a check of the consuming applications.
- **cabana: `granted` does not expand a held leading wildcard.** A holder grant `*.manage` does not grant `acme.manage` (`granted` in contracts.go only expands held trailing wildcards). Pre-existing; WinterCMS parity unverified. TestRoleCeiling does not pin either behaviour.

View File

@@ -0,0 +1,475 @@
---
phase: 19.7-generic-mcp-module
plan: 01
type: execute
wave: 1
depends_on: []
files_modified:
- modules/bouncer/dispatch.go
- modules/bouncer/registry.go
- modules/bouncer/dispatch_smoke_test.go
- modules/bouncer/README.md
- modules/cabana/token_guard.go
- modules/cabana/token_resolver.go
- modules/cabana/dispatch_smoke_test.go
- modules/cabana/action_extensions.go
- modules/cabana/actions.go
- modules/cabana/crud.go
- modules/cabana/schema_types.go
- modules/cabana/account_contributions.go
- modules/cabana/account_contributions_smoke_test.go
- modules/cabana/record_action_prompt_smoke_test.go
- modules/cabana/http.go
- modules/cabana/admin_openapi.go
- modules/cabana/subject_events.go
- modules/cabana/README.md
- modules/pact/capabilities.go
- modules/pact/mcp.go
- modules/pact/capabilities_test.go
- modules/pact/README.md
- modules/surf/router.go
- modules/surf/routetable.go
- modules/surf/streaming.go
- modules/surf/pier_off.go
- modules/surf/dispatch_smoke_test.go
- modules/surf/streaming_smoke_test.go
- modules/surf/pier_mount_smoke_test.go
- modules/surf/README.md
- modules/wristband/authorize.go
- modules/wristband/server.go
- modules/wristband/mcp_scopes_smoke_test.go
- modules/wristband/README.md
- modules/cooler/cooler.go
- modules/cooler/README.md
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- admin/src/components/ui/confirm.ts
- admin/src/components/ui/ConfirmDialog.vue
- admin/src/components/form/RecordActions.vue
- admin/src/components/account/AccountContributions.vue
- admin/src/views/AccountView.vue
- admin/src/api/types.ts
- admin/src/api/schema.d.ts
- admin/openapi/admin.json
- admin/tests/account/AccountContributions.test.ts
- admin/tests/form/RecordActionsPrompt.test.ts
- modules/boardwalk/dist
- docs/services/authentication.md
- docs/services/routing.md
- docs/services/oauth-server.md
- docs/plugins/registration.md
- docs/backend/admin-controllers.md
- docs/backend/users-and-permissions.md
autonomous: true
requirements: [SC-1, SC-3, SC-4, D-04, D-09, D-17, D-28, D-30, D-33, D-34, D-36]
estimate:
tokens: 75000
raw_tokens: 75000
tasks: 5
confidence: low
must_haves:
truths:
- "An in-process dispatch that carries the bouncer dispatch marker reaches a guarded route handler as the pre-resolved principal, while an HTTP request carrying any header is never treated as dispatched (D-17; the marker is context-only and only a guard name the marker lists is honoured)"
- "surf can hand out the compiled middleware chain of one registered route by method and pattern, and a route of the new streaming kind flushes its bytes to the client while the handler is still running (SC-1 Pitfall 1; D-10 dispatch runs the same chain as HTTP)"
- "With mcp.enabled false (the default) BuildRouter mounts nothing new and every existing route table, payload and test is unchanged (D-30); with mcp.enabled true and no summercms_mcp tag, boot fails with an error naming the tag (D-33)"
- "A plugin can declare MCP tools and prompts, frontend permission codes, My Profile contributions and a prompted record action through pact types that import neither the MCP SDK nor jsonschema-go (D-28, D-09, D-04, D-34; SC-2 contract side)"
- "A plugin's My Profile contribution is listed and run through two new cabana account routes, and the existing /account*, /auth/me and record payloads are byte-identical to before (D-04 additive seam)"
- "A contributed record action with a Prompt asks the admin for one text value in the confirm dialog and hands it to Run; actions without a Prompt keep their exact payload and body (D-34 set-link input, planner decision P-01)"
- "wristband's MCP authorize accepts exactly the scopes of Options.ScopesSupported, whose default is unchanged (D-21 framework side, Pitfall 5)"
artifacts:
- path: "modules/bouncer/dispatch.go"
provides: "Dispatch, WithDispatch, Dispatched: the context-only pre-resolved principal marker (D-17)"
contains: "func WithDispatch("
- path: "modules/surf/streaming.go"
provides: "MountStream and recoverStream: the non-buffering route kind"
contains: "func (r *Router) MountStream("
- path: "modules/surf/routetable.go"
provides: "Handler(method, pattern): the compiled chain lookup"
contains: "func (r *Router) Handler("
- path: "modules/surf/pier_off.go"
provides: "the untagged side of the pier mount hook, boot error naming summercms_mcp"
contains: "!summercms_mcp"
- path: "modules/pact/mcp.go"
provides: "HasMCP, MCP, MCPTool, MCPPrompt, MCPGuard, MCPGuards, MCPSubject, MCPDispatch, MCPTokenVerifier, MCPGrant, MCPPersonalTokenResolver, MCPLinkedBackendResolver, LinkedBackendUser, MCPSubjectChanged, HasFrontendPermissions, FrontendPermission"
contains: "type HasMCP interface"
- path: "modules/pact/capabilities.go"
provides: "AdminActionPrompt, AdminRecordAction.Prompt, AdminRecordActionInput.Value, HasAccountContributions, AccountContribution, AccountAction, AccountActionInput, AccountActionResult"
contains: "type HasAccountContributions interface"
- path: "modules/cabana/account_contributions.go"
provides: "compileAccountContributions and the two account contribution handlers"
contains: "func compileAccountContributions("
- path: "modules/cabana/token_resolver.go"
provides: "ResolveBackendToken, ScopeLimitFor, BackendPrincipal (additive resolvers pier uses)"
contains: "func ResolveBackendToken("
- path: "modules/wristband/authorize.go"
provides: "parseAuthorizeScopes over the server's allowed set built from Options.ScopesSupported"
contains: "ScopesSupported"
- path: "admin/src/components/account/AccountContributions.vue"
provides: "the generic My Profile contributions section"
key_links:
- from: "modules/bouncer/registry.go"
to: "modules/bouncer/dispatch.go"
via: "Registry.Middleware consults Dispatched(ctx, name) before authenticate(ng.g, r)"
pattern: "Dispatched\\(r\\.Context\\(\\), name\\)"
- from: "modules/cabana/token_guard.go"
to: "modules/bouncer/dispatch.go"
via: "ResolveBackend takes a backend-kind marker before the bearer short-circuit"
pattern: "bouncer\\.Dispatched\\("
- from: "modules/surf/router.go"
to: "modules/surf/pier_off.go"
via: "BuildRouter calls the mountPier hook after cabana.Activate and before the wrap validation loop"
pattern: "mountPier"
- from: "modules/cabana/http.go"
to: "modules/cabana/account_contributions.go"
via: "GET /account/contributions and POST /account/contributions/{name}/actions/{action} behind interactiveOnly"
pattern: "account/contributions"
- from: "admin/src/components/form/RecordActions.vue"
to: "modules/cabana/actions.go"
via: "a prompted action posts body {payload: <string>}; cabana decodes it only for actions that declare a Prompt"
pattern: "payload"
---
<!-- planner-discipline-allow: jsonschema-go -->
<!-- planner-discipline-allow: modelcontextprotocol -->
<!-- planner-discipline-allow: modules/bouncer -->
<!-- planner-discipline-allow: v-html -->
<objective>
Lay every framework seam Phase 19.7 needs before the `pier` module can exist, in `summercms.go` only, additively: the D-17 dispatch marker in bouncer and cabana, surf's compiled-handler lookup and a non-buffering streaming route kind plus the tagged pier mount hook (D-30, D-33), the SDK-free `pact` contracts for MCP tools and prompts, guard providers, token verifiers, the link resolver and the subject-changed event (D-28, D-09), the generic My Profile contribution seam (D-04 part 1), a prompted record action on the 19.6.1 seam (D-34), wristband's configurable MCP scope allow-list (D-21 framework side), and a tiny cooler export for pier's Redis keys.
**Planner decision P-01 (the "set link" input gap, D-34):** 19.6.1's `pact.AdminActionExtension` record actions carry no input, and D-34 says admins set and remove links on the Administrators screen through that seam. "Remove link" fits a plain record action. "Set link" needs one value (which frontend user). The smallest additive framework change is a **prompted record action**: `pact.AdminRecordAction` gains an optional `Prompt *pact.AdminActionPrompt` (label, placeholder, comment, max length; phrase keys or text) and `pact.AdminRecordActionInput` gains `Value string`. The record response's `meta.actions[]` entry gains `prompt` only when set; the SPA confirm dialog shows one text input for such an action and posts the existing `AdminActionRequest` key `payload` as a JSON string; cabana accepts `payload` only for a prompted action (the 422 refusal for every other record action is unchanged), trims it, refuses an empty or over-long value with 422 on `payload`, and hands it to `Run` as `Value`. No console command is the only way to link: plan 03's `link_frontend_account` action uses this Prompt and `unlink_frontend_account` is a plain Danger action.
**Planner decision P-02 (My Profile seam shape, D-04 part 1, Claude's discretion):** a contribution interface, not an `AdminController` extension: `pact.HasAccountContributions` returns `[]pact.AccountContribution{Name, Label, Description, Status, Actions}`; each `pact.AccountAction{Name, Label, Confirm, Danger, Permissions, Applies, Run}` runs for the signed-in admin only (`AccountActionInput{AdminID}`) and may answer a `URL` the SPA opens in a new tab (the link-proof site URL of D-05). Names are generic; cabana never names the user plugin or MCP.
**Planner decision P-03 (marker shape, D-17):** `bouncer.Dispatch{Guards []string, Principal *Principal, Credential any}` under an unexported context key; `WithDispatch` is the only setter (the phase gate in plan 05 proves only `modules/pier` and tests call it) and `Dispatched(ctx, guardName)` the reader, which answers only when the marker lists that exact guard name. bouncer's `Registry.Middleware` and cabana's `ResolveBackend` honour it, so the user plugin's `user.api_token` (the bouncer `api_token` guard) and Journal's `requireBackendPrincipal` need no code change for the marker; Journal's `optionalBackendPrincipal` short-circuit is plan 04's one-line fix.
**Planner decision P-04 (pact stays SDK-free, D-33):** every plugin-facing type lands in `modules/pact` with no import of the MCP SDK, jsonschema-go or bouncer; `pact.MCPDispatch.Principal` is `any` (pier asserts `*bouncer.Principal`). Guard providers register in a `*pact.MCPGuards` registry published on the app (find-or-publish pattern), the `oas_at_` verifier is published as `pact.MCPTokenVerifier`, the personal-token resolver as `pact.MCPPersonalTokenResolver`, the link service as `pact.MCPLinkedBackendResolver`, and plugins fire `pact.MCPSubjectChanged` on the festival bus.
Purpose: plans 02-04 build on published contracts instead of discovering them; the framework release in plan 02 carries these seams together with 19.6.1.
Output: the seams above, their smoke tests (unit tests proper are plan 05), README and docs updates in the same commits, the regenerated admin OpenAPI and the rebuilt `modules/boardwalk/dist`.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/PROJECT.md
@.planning/ROADMAP.md
@.planning/STATE.md
@.planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md
@.planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md
@.planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-SUMMARY.md
@.planning/phases/19.6.1-backend-administrators-screen/19.6.1-04-SUMMARY.md
@CLAUDE.md
</context>
<project_rules>
- Several Claude sessions work in this repo at once. Before touching `modules/cabana`, `modules/surf` or `admin/`, run `git status --short` and leave other sessions' uncommitted edits alone. Never edit `admin/src/state/useSettings.ts` or `admin/src/components/shell/SettingsPanel.vue` (a quick task owns them).
- Stage files by explicit path, never `git add -A`. One logical change per commit; planning docs and code in separate commits; no co-author tags. Do not push or tag in this plan.
- Framework code, READMEs and docs never name a consuming application or a specific plugin (use `acme`/`blog`). The docs checker (`go run ./cmd/summer docs:build --check`) refuses a Go code block without `src=` and an identifier that does not exist; a module API change updates that module's README and the affected docs page in the same commit.
- `go vet ./...` and `go test -short ./...` green at every commit. A change in `admin/` rebuilds `modules/boardwalk/dist` (`npm --prefix admin run build`) in the same task and passes `scripts/check-admin-dist.sh`; a swag annotation change passes `scripts/check-admin-openapi.sh`.
</project_rules>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: an in-process dispatch with the bouncer marker runs a guarded route through surf's compiled chain as the pre-resolved principal</name>
<reversibility rating="costly">Three auth paths (bouncer registry, cabana ResolveBackend, and through them user.api_token and Journal) learn the marker; D-17 recorded this as costly, the user already chose it.</reversibility>
<files>modules/bouncer/dispatch.go, modules/bouncer/registry.go, modules/bouncer/dispatch_smoke_test.go, modules/bouncer/README.md, modules/cabana/token_guard.go, modules/cabana/token_resolver.go, modules/cabana/dispatch_smoke_test.go, modules/cabana/README.md, modules/surf/router.go, modules/surf/routetable.go, modules/surf/dispatch_smoke_test.go, modules/surf/README.md, docs/services/authentication.md, docs/services/routing.md</files>
<read_first>
- modules/bouncer/context.go (the unexported-key pattern: userKey, WithUser, User)
- modules/bouncer/registry.go (Middleware at lines 73-102: where authenticate(ng.g, r) runs)
- modules/bouncer/guard.go (Guard, CredentialGuard, UnauthorizedWriter)
- modules/cabana/token_guard.go (ResolveBackend 199-227, authenticateToken 76-125, interactiveOnly, logTokenAuth)
- modules/cabana/token_scopes.go (methodFilterScopes, the Registry.tokenScopes table)
- modules/cabana/auth.go lines 30-70 (BackendUsers.FindByID overlaying the admin's own permissions; the lazyBackendUsers provider in http.go 150-185)
- modules/surf/router.go (route struct 38-49, compile 354-394, wrap 408-491, BuildRouter 600-665)
- modules/surf/routetable.go (Routes, RouteInfo)
- modules/surf/overlap.go 397-422 (SetPathValue and Pattern before calling a compiled handler)
- modules/surf/apidocs_test.go (fake plugin + transportApp test shape)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pattern 3" and § "Pattern 6" and the Security Domain rows "Forged dispatch marker" and "Frontend marker accepted by a backend guard"
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "FW/modules/bouncer/dispatch.go" and § "FW/modules/cabana/token_guard.go" and § "FW/modules/surf/router.go"
- docs/services/authentication.md § "Guards and middleware" and docs/services/routing.md § "Testing and listing routes"
</read_first>
<action>
Implement D-17 and the surf lookup as one proven slice (planner decision P-03).
bouncer (`modules/bouncer/dispatch.go`, new): `type Dispatch struct { Guards []string; Principal *Principal; Credential any }`; `func WithDispatch(ctx context.Context, d *Dispatch) context.Context` stores it under an unexported `dispatchKey struct{}` (nil ctx becomes Background, as WithUser does); `func Dispatched(ctx context.Context, guard string) (*Dispatch, bool)` returns the marker only when `d.Principal != nil` and `guard` is one of `d.Guards` (exact string compare, no wildcard). Document in the type comment that the marker is context-only, that nothing reads a header, cookie or query for it, and that only an in-process dispatcher may set it. In `registry.go` `Middleware`, before `authenticate(ng.g, r)`: `if d, ok := Dispatched(r.Context(), name); ok` then use `d.Principal` and `d.Credential` (WithUser, WithCredential when non-nil) and call next; no guard method runs. Keep every existing error string.
cabana: in `token_guard.go` `ResolveBackend`, before the `authorizationBearer(r) == ""` short-circuit, take `bouncer.Dispatched(r.Context(), "backend")`; when present, require `d.Principal.Backend == true` (a frontend marker is refused with ErrUnauthenticated), apply the existing cover check (`scopeCoversAll` when `Scope != nil && !Scope.Full`) and return `r.WithContext(...)` exactly as lines 222-226 do, with the credential when non-nil. New file `token_resolver.go` (additive exports pier uses; names are final): `func ResolveBackendToken(ctx context.Context, app *backpack.App, raw string) (*bouncer.Principal, *BackendAPIToken, []string, error)` resolves a `g15_` token without the method filter (same `wellFormedAPIToken`, `hashAPIToken`, `FindUsableByHash`, constant-time compare, `users.FindByID`, `stampLastUsed`, `logTokenAuth` with path "mcp" when the request is absent — pass a nil-safe logging variant) and returns the stored scope names; `func ScopeLimitFor(app *backpack.App, scopes []string, method string) (*bouncer.ScopeLimit, int, int)` wraps `methodFilterScopes(reg.tokenScopes, scopes, method)` using the Registry looked up from the app; `func BackendPrincipal(ctx context.Context, app *backpack.App, id uint) (*bouncer.Principal, error)` returns the admin principal through the published backend users provider (Backend, IsSuperuser, PermissionGrants set; nil, nil when the admin does not exist or is deactivated). Reuse the resolver cabana publishes (`*backendResolver` holds the composite guard; add unexported accessors rather than duplicating the lookups).
surf: add `handlers map[string]http.Handler` to Router, filled by a new `compileHandlers() error` that wraps every route once (key `method + " " + path`) and is called by `compile()` (which then uses the map) and by BuildRouter's validation loop (replace the throwaway `r.wrap(rt)` loop with `compileHandlers`); add `func (r *Router) Handler(method, pattern string) (http.Handler, bool)` in `routetable.go` (nil-safe; false before compile). Do not change route ordering, overlap families or the mux.
Smoke tests (`-short`, no Docker): `modules/surf/dispatch_smoke_test.go` `TestDispatchSmoke`: a fake plugin registers a bouncer guard `acme` (a CredentialGuard whose AuthenticateCredential always fails and which implements UnauthorizedWriter with a 401 JSON body) under middleware name `acme.auth`, and a route `GET /acme/items/{id}` behind it whose handler writes `bouncer.User(ctx).ID` and `r.PathValue("id")`; after `BuildRouter` + `compileHandlers` (through `Assemble` or the exported path the test needs), `Handler("GET", "/acme/items/{id}")` is found; a request built with `httptest.NewRequest`, `SetPathValue("id","7")`, `Pattern` set, and a context carrying `WithDispatch(&Dispatch{Guards: []string{"acme"}, Principal: &Principal{ID: 42}})` answers 200 with id 42 and 7; the same request without the marker answers 401; a request with headers `X-Summer-Dispatch: 42`, `Authorization: Dispatch 42` and a cookie answers 401 (nothing reads headers); a marker listing guard `other` answers 401. `modules/bouncer/dispatch_smoke_test.go` `TestDispatchedSmoke`: Dispatched returns false for a nil principal, an unlisted guard and a plain context. `modules/cabana/dispatch_smoke_test.go` `TestDispatchMarkerSmoke`: with an app that has no published resolver, `ResolveBackend(app, r-with-backend-marker, "acme.*")` returns a principal whose ID matches; the same with `Backend: false` returns ErrUnauthenticated; a scoped marker whose Scope does not cover `acme.*` returns ErrTokenScope.
Docs in the same commit: bouncer README (Features + API reference rows for Dispatch, WithDispatch, Dispatched), cabana README (ResolveBackendToken, ScopeLimitFor, BackendPrincipal, marker paragraph in the ResolveBackend row), surf README (Handler row), `docs/services/authentication.md` (new paragraph under "Guards and middleware": the pre-resolved principal marker, who may set it, what honours it), `docs/services/routing.md` (Handler lookup under "Testing and listing routes"). No Go code block without `src=`.
</action>
<verify>
<automated>go vet ./... && go test -count=1 -short ./modules/bouncer/... ./modules/cabana/... ./modules/surf/... && go test -count=1 -short -run '^(TestDispatchSmoke|TestDispatchedSmoke|TestDispatchMarkerSmoke)$' -v ./modules/surf ./modules/bouncer ./modules/cabana 2>&1 | grep -c -- '^--- PASS: Test' | grep -qx 3 && go -C examples/hello test -count=1 ./... && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS count line is not exactly 3</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "func WithDispatch(" modules/bouncer/dispatch.go` prints 1 and `grep -c "func Dispatched(" modules/bouncer/dispatch.go` prints 1
- `grep -n "Dispatched(r.Context(), name)" modules/bouncer/registry.go` prints one line that comes before the line containing `authenticate(ng.g, r)`
- `grep -c "bouncer.Dispatched(" modules/cabana/token_guard.go` prints 1 and `grep -c "func ResolveBackendToken(\|func ScopeLimitFor(\|func BackendPrincipal(" modules/cabana/token_resolver.go` prints 3
- `grep -c "func (r \*Router) Handler(" modules/surf/routetable.go` prints 1 and `grep -c "func (r \*Router) compileHandlers(" modules/surf/router.go` prints 1
- `go test -count=1 -short -run '^TestDispatchSmoke$' -v ./modules/surf 2>&1 | grep -q -- '^--- PASS: TestDispatchSmoke'`
- `go test -count=1 -short -run '^TestDispatchMarkerSmoke$' -v ./modules/cabana 2>&1 | grep -q -- '^--- PASS: TestDispatchMarkerSmoke'`
- Every pre-existing test in modules/bouncer, modules/cabana and modules/surf passes unchanged (no existing test file modified in this task)
- `grep -c "Dispatched" modules/bouncer/README.md docs/services/authentication.md` prints a non-zero count for both files
</acceptance_criteria>
<done>A marker-carrying in-process call runs a guarded route through surf's compiled chain as the pre-resolved principal; HTTP requests cannot forge it; cabana's ResolveBackend honours a backend marker and refuses a frontend one; the handler lookup, the additive token resolvers and their docs are committed.</done>
</task>
<task type="auto">
<name>Task 2: Streaming route kind, the tagged pier mount hook, wristband's configurable MCP scope set and cooler's key prefix export</name>
<files>modules/surf/router.go, modules/surf/streaming.go, modules/surf/pier_off.go, modules/surf/streaming_smoke_test.go, modules/surf/pier_mount_smoke_test.go, modules/surf/README.md, modules/wristband/authorize.go, modules/wristband/server.go, modules/wristband/mcp_scopes_smoke_test.go, modules/wristband/README.md, modules/cooler/cooler.go, modules/cooler/README.md, docs/services/routing.md, docs/services/oauth-server.md</files>
<read_first>
- modules/surf/router.go (route struct, wrap 408-491 including the rt.raw ? recoverBare : recoverJSON choice, recoverJSON/recoverBare/bufferedResponse 786-860, BuildRouter 624-654 where mountAPIDocs and cabana.Activate run)
- modules/surf/apidocs.go 88-165 (config-gated mount, apiDocsPath, collision check against r.seen, BindPlugin, GroupRaw)
- modules/surf/accesslog.go (statusRecorder: Flush and Unwrap pass through; confirm the outer layers do not buffer)
- modules/lagoon/attach/s3_on.go, s3_off.go, bucket.go 24-28 (the build-tag pattern and the exported tag constant)
- internal/build/manifest.go 20-30 and 86-110 (build.tags) and internal/build/manifest_tags_smoke_test.go
- modules/wristband/authorize.go 15-30 and 205-225 (authorizeAllowedScopes, parseAuthorizeScopes) and server.go 28-45, 90-105, 160-195 (Options.ScopesSupported, DefaultOptions, Metadata)
- modules/wristband/*_test.go that cover parseAuthorizeScopes or scope errors (grep "unsupported value" and "scopes_supported")
- modules/cooler/cooler.go 310-365 (OpenRedis, openFromConfig, RedisURLKey, keyPrefix) and modules/cooler/README.md Configuration
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pitfall 1", § "Pitfall 5", § "Pattern 1", § "Open Question 2" and CONTEXT D-30, D-33
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "FW/modules/surf/pier_on.go / pier_off.go" and § "FW/modules/wristband/authorize.go"
</read_first>
<action>
surf streaming kind (Pitfall 1): add `stream bool` to `route`; in `wrap`, when `rt.stream` is set wrap with a new `recoverStream(pages, next)` (in `streaming.go`) instead of recoverJSON/recoverBare: it serves `next` directly on the real ResponseWriter (no bufferedResponse, so `http.Flusher` reaches the client), recovers a panic by writing wire's opaque 500 only when nothing has been written yet (track with a small `headerSentWriter` that records the first WriteHeader/Write and implements Flush and Unwrap), otherwise it only aborts and marks the request panicked; keep constraints, orgSlot, named middleware, body limit, locale, the CORS profile and recordPattern exactly as other routes. Add `func (r *Router) MountStream(method, path string, h http.Handler, middleware ...string) error` which registers one raw+stream route under the currently bound plugin (same validation as the raw group path, `seen` collision error naming the owner) and the `surf.MCPBuildTag = "summercms_mcp"` constant.
pier hook (D-30, D-33): package-level `var mountPier func(r *Router, app *backpack.App, plugins []party.Plugin) error` in `router.go`; in `BuildRouter`, after the `admin != nil` block and before `compileHandlers`, read `app.Config.Bool("mcp.enabled")`: false → nothing; true and `mountPier == nil` → return the error `surf: mcp.enabled is true but this binary was built without the summercms_mcp tag (summer.yaml build.tags)`; true and set → call it and return its error. `pier_off.go` carries `//go:build !summercms_mcp` and a comment that the tagged counterpart (plan 02's `pier_on.go`) sets the hook; it declares nothing else (the var lives in router.go so both builds compile). Also add the inline-throttle note: pier will use the existing `throttle:<max>,<minutes>` inline spelling, so no bucket registration is added here.
wristband (Pitfall 5, D-21): `parseAuthorizeScopes(raw string, allowed map[string]bool)`; the Server builds `allowed` from `s.opts.ScopesSupported` (empty → the four PHP defaults, so `authorizeAllowedScopes` stays as the default set and every existing test passes unchanged); `Authorize` passes the server's set. Metadata already lists `s.opts.ScopesSupported`. Smoke `TestMCPScopesSmoke`: a server whose Options.ScopesSupported appends `backend` accepts `scope=read backend` at authorize (no `invalid_scope`) and lists it in metadata; the default server still answers the unsupported-value error for `backend`.
cooler: export `func KeyPrefix(cfg *compass.Config) string` (wrapping keyPrefix; document the `<prefix>` rule in the README API reference) so pier's keys are `<prefix>mcp:...`; no other cooler change (pier opens Redis lazily with `cooler.OpenRedis` and `RedisURLKey`).
Smoke tests: `TestStreamingRouteSmoke` (surf): a stream route handler writes `event: a` + flush, waits for a channel, writes `event: b`; served through `httptest.NewServer`, a client reading the body incrementally receives the first event before the test closes the channel (a buffered route in the same test does not deliver until the handler returns); a panic after the first flush ends the body without a 500 status rewrite; a panic before any write answers 500. `TestPierMountSmoke` (surf): with `mcp.enabled` unset BuildRouter mounts no route whose pattern starts with `/mcp` or `/.well-known/oauth-protected-resource` and `Routes()` is identical to a build without the key; with `mcp.enabled: true` (and no tag in this test binary) BuildRouter's error contains `summercms_mcp`.
Docs in the same commits: surf README (Features: streaming route kind and the mcp hook; API reference: MountStream, MCPBuildTag; Configuration: `mcp.enabled` is read here only to call the hook), `docs/services/routing.md` (new section "Streaming routes"), wristband README + `docs/services/oauth-server.md` (ScopesSupported governs the authorize allow-list), cooler README (KeyPrefix).
</action>
<verify>
<automated>go vet ./... && go test -count=1 -short ./modules/surf/... ./modules/wristband/... ./modules/cooler/... && go test -count=1 -short -run '^(TestStreamingRouteSmoke|TestPierMountSmoke|TestMCPScopesSmoke)$' -v ./modules/surf ./modules/wristband 2>&1 | grep -c -- '^--- PASS: Test' | grep -qx 3 && go -C examples/hello test -count=1 ./... && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS count line is not exactly 3</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "func (r \*Router) MountStream(" modules/surf/streaming.go` prints 1 and `grep -c "func recoverStream(" modules/surf/streaming.go` prints 1
- `grep -c "MCPBuildTag = \"summercms_mcp\"" modules/surf/*.go` prints 1 and `head -1 modules/surf/pier_off.go` prints `//go:build !summercms_mcp`
- `grep -c "var mountPier func" modules/surf/router.go` prints 1 and `grep -c "built without the summercms_mcp tag" modules/surf/router.go` prints 1
- `grep -c "func parseAuthorizeScopes(raw string, allowed map\[string\]bool)" modules/wristband/authorize.go` prints 1
- `grep -c "func KeyPrefix(" modules/cooler/cooler.go` prints 1
- `go test -count=1 -short ./modules/wristband/...` passes with no existing wristband test modified
- `go test -count=1 -short -run '^TestStreamingRouteSmoke$' -v ./modules/surf 2>&1 | grep -q -- '^--- PASS: TestStreamingRouteSmoke'`
- `grep -c "Streaming routes" docs/services/routing.md` prints 1
</acceptance_criteria>
<done>A stream route flushes to the client mid-handler, mcp.enabled is inert without the tag and fails boot by name with it missing, wristband's MCP scope set follows Options.ScopesSupported with an unchanged default, and cooler exposes KeyPrefix; docs and READMEs updated.</done>
</task>
<task type="auto">
<name>Task 3: SDK-free pact contracts: MCP tools, prompts, guards, verifiers, link resolver, subject events, frontend permissions, prompted record actions and account contributions</name>
<reversibility rating="costly">The pact types are a published framework API that plugins compile against (D-28 recorded costly; the user chose the tools/prompts/resources-ready shape).</reversibility>
<files>modules/pact/mcp.go, modules/pact/capabilities.go, modules/pact/capabilities_test.go, modules/pact/README.md, docs/plugins/registration.md</files>
<read_first>
- modules/pact/capabilities.go (Permission/HasPermissions 548-558, TokenScope/HasTokenScopes 562-573, AdminActionExtension 378-412, AdminRecordAction 343-364, AdminActionInput 232-250 and its Payload comment, the import list at the top: pact imports bonfire but not bouncer)
- modules/pact/capabilities_test.go 300-390 (compile-time discovery test shape)
- modules/pact/README.md § "API reference"
- docs/plugins/registration.md § "Capability interfaces"
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pattern 2", § "Pattern 5", § "Pattern 6" (credential for user.scope), § "Code Examples: Annotations from method", § "Frontend tool needs a new route"
- .planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md D-09, D-10..D-16, D-23, D-26, D-28, D-34, D-35
</read_first>
<action>
New file `modules/pact/mcp.go` (standard library imports only, plus nothing from the SDK, jsonschema-go or bouncer). Types, all exported, names final:
- `HasMCP interface { MCP() MCP }`; `MCP struct { Tools []MCPTool; Prompts []MCPPrompt }` with a doc comment that resources are a later field (CONTEXT Deferred Ideas) and that the struct form keeps that addition non-breaking (D-28).
- `MCPTool struct { Name, Title, Description string; Guard string; Method, Path string; Input any; Output any; Permissions []string; ReadOnly, Destructive, Idempotent, OpenWorld *bool }`. Doc comment lists the boot failures the module enforces (D-10 route not found, D-12 duplicate or invalid name, D-15 route not token-guarded and no Guard, Input not a struct, a `path:"x"` tag without a `{x}` segment or a segment without a tag), the argument mapping (D-11: `path:"id"` fills `{id}`, `query:"q"` goes to the query string, remaining `json` fields form the body, `jsonschema:"description"` tags describe), the result rule (D-13) and the annotation derivation (D-14: GET read-only+idempotent, PUT idempotent, DELETE destructive, nil pointer means derived).
- `MCPPrompt struct { Name, Title, Description string; Guard string; Permissions []string; Arguments []MCPPromptArgument; Render func(ctx context.Context, args map[string]string) ([]MCPPromptMessage, error) }`, `MCPPromptArgument struct { Name, Description string; Required bool }`, `MCPPromptMessage struct { Role, Text string }` (Role `user` or `assistant`).
- Guard providers: `MCPGuard interface { MCPGuardName() string; MCPTokenGuarded(middleware []string) bool; MCPRequirements(middleware []string) (MCPRequirements, error); MCPAllows(ctx context.Context, subject MCPSubject, req MCPRequirements, permissions []string) (bool, error); MCPDispatch(ctx context.Context, subject MCPSubject, method string) (MCPDispatch, error) }`; `MCPRequirements struct { Scopes []string; Permissions []string }`; `MCPSubject struct { Guard string; UserID uint; Scopes []string; ClientID string; TokenID uint }`; `MCPDispatch struct { Principal any; Credential any; Guards []string }` (Principal is the bouncer principal as `any`, see P-04); `MCPGuards` registry type with `NewMCPGuards()`, `Register(g MCPGuard) error` (empty or duplicate name fails with a `pact: ...` error naming the guard), `Lookup(name string) (MCPGuard, bool)`, `Names() []string` (sorted), safe for concurrent use.
- Token verification: `MCPTokenVerifier interface { MCPVerifyToken(ctx context.Context, raw string) (MCPGrant, error); MCPResource() string }`, `MCPGrant struct { UserID uint; ClientID string; TokenID uint; Scopes []string; ExpiresAt time.Time }`, `var ErrMCPTokenInvalid = errors.New("pact: mcp token invalid")`; `MCPPersonalTokenResolver interface { MCPResolvePersonalToken(ctx context.Context, raw string) (MCPSubject, bool, error) }` (false when the prefix is not the resolver's).
- Link: `MCPLinkedBackendResolver interface { LinkedBackendUser(ctx context.Context, frontendUserID uint) (LinkedBackendUser, bool, error) }`, `LinkedBackendUser struct { ID uint; Login string; DisplayName string }`.
- Event: `MCPSubjectChanged struct { Guard string; UserID uint; Kind string }` with constants `MCPSubjectPermissions = "permissions"`, `MCPSubjectLink = "link"`, `MCPSubjectRevoked = "revoked"`, `MCPSubjectDeleted = "deleted"`; doc comment: fired through the festival bus by whoever changes a subject's permissions, link, grants or existence (D-26 sources).
- Frontend permissions (D-09): `FrontendPermission struct { Code, Label, Tab, Comment string }`, `HasFrontendPermissions interface { FrontendPermissions() []FrontendPermission }`.
In `capabilities.go` (additive): `AdminActionPrompt struct { Label, Placeholder, Comment string; MaxLength int }` (phrase keys or text; MaxLength 0 means 255); `AdminRecordAction.Prompt *AdminActionPrompt` with a `json:"-"`-free field (it is not serialized by pact) and a doc sentence replacing "A record action carries no input beyond the record." in the AdminActionExtension comment with the prompt rule (P-01); `AdminRecordActionInput.Value string` ("the trimmed prompt answer; empty for an action without a Prompt"). Account seam (P-02): `HasAccountContributions interface { AccountContributions() []AccountContribution }`, `AccountContribution struct { Name, Label, Description string; Status func(ctx context.Context, adminID uint) (string, error); Actions []AccountAction }`, `AccountAction struct { Name, Label, Confirm string; Danger bool; Permissions []string; Applies func(ctx context.Context, adminID uint) (bool, error); Run func(ctx context.Context, in AccountActionInput) (AccountActionResult, error) }`, `AccountActionInput struct { AdminID uint }`, `AccountActionResult struct { Message, URL string }`; doc comments list the boot failures cabana enforces (identifier names, duplicate contribution or action name across plugins, nil Run, empty Label) and that Status and Applies must be pure reads.
Tests in `capabilities_test.go`: compile-time discovery of HasMCP, HasFrontendPermissions and HasAccountContributions on sample plugins (type assertions), MCPGuards register/duplicate/lookup/sorted names, and a struct-literal test that every new type is constructible without importing anything outside pact (a `go list -deps ./modules/pact` assertion in the test that the dependency list contains neither `modelcontextprotocol` nor `jsonschema-go` nor `modules/bouncer`).
Docs: pact README API reference rows for every new type and interface; `docs/plugins/registration.md` capability table rows for HasMCP, HasFrontendPermissions, HasAccountContributions, and a sentence on AdminRecordAction.Prompt. The MCP usage page itself is plan 02's `docs/services/mcp.md`.
</action>
<verify>
<automated>go vet ./modules/pact/... && go test -count=1 -short ./modules/pact/... && DEPS=$(go list -deps ./modules/pact) && ! printf '%s\n' "$DEPS" | grep -q 'modelcontextprotocol\|jsonschema-go\|modules/bouncer' && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, "FAIL" in the output, `go list -deps` failing (the captured assignment short-circuits the chain), or any dependency line matching modelcontextprotocol, jsonschema-go or modules/bouncer</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "type HasMCP interface\|type MCPTool struct\|type MCPPrompt struct\|type MCPGuard interface\|type MCPGuards struct\|type MCPTokenVerifier interface\|type MCPLinkedBackendResolver interface\|type MCPSubjectChanged struct\|type HasFrontendPermissions interface" modules/pact/mcp.go` prints 9
- `grep -c "type AdminActionPrompt struct\|type HasAccountContributions interface\|type AccountContribution struct\|type AccountAction struct\|type AccountActionResult struct" modules/pact/capabilities.go` prints 5
- `grep -c "Prompt \*AdminActionPrompt" modules/pact/capabilities.go` prints 1 and `grep -c "Value string" modules/pact/capabilities.go` prints at least 1
- `DEPS=$(go list -deps ./modules/pact) && ! printf '%s\n' "$DEPS" | grep -q 'modelcontextprotocol\|jsonschema-go\|modules/bouncer'` exits 0 (a failing `go list` fails the criterion rather than passing it)
- `grep -c "HasMCP\|HasFrontendPermissions\|HasAccountContributions" docs/plugins/registration.md` prints at least 3
- `go test -count=1 -short ./modules/pact/...` passes
</acceptance_criteria>
<done>Every plugin-facing contract of the phase compiles in pact without the SDK; discovery tests pass; README and registration docs list them.</done>
</task>
<task type="auto">
<name>Task 4: cabana server side: the account contribution routes, the prompted record action and backend subject-changed events</name>
<files>modules/cabana/account_contributions.go, modules/cabana/account_contributions_smoke_test.go, modules/cabana/record_action_prompt_smoke_test.go, modules/cabana/action_extensions.go, modules/cabana/actions.go, modules/cabana/crud.go, modules/cabana/schema_types.go, modules/cabana/http.go, modules/cabana/admin_openapi.go, modules/cabana/subject_events.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, docs/backend/admin-controllers.md, docs/backend/users-and-permissions.md</files>
<read_first>
- modules/cabana/action_extensions.go (compileActionExtensions, checkContributedAction, wrapAdministratorsContributedRun)
- modules/cabana/actions.go 187-260 and 327-345 (recordAction handler, the payload refusal at line 211-214, recordActionOf, allowAction, decodeActionRequest)
- modules/cabana/crud.go 548-640 (offeredRecordActions, CRUDService.RecordAction)
- modules/cabana/schema_types.go 229-236 (RecordAction JSON) and admin_openapi.go 95-125, 755-790 (AdminProfile, AdminActionRequest, AdminActionResult swag types)
- modules/cabana/http.go 78-235 (Activate: where compileActionExtensions and compileContributions run) and 284-300 (the /account routes block)
- modules/cabana/account.go 1-80 and auth.go 340-362 (handler shape, WriteData, interactiveOnly, requireAjax)
- modules/cabana/account_tokens.go (accountTokenRevoke: where the backend revoked event is fired)
- modules/cabana/backend_users_admin.go (FormAfterUpdate/role and permission changes, deactivate and delete record and bulk actions: where backend permissions/deleted events are fired) and backend_roles_admin.go (role save)
- modules/cabana/example_action_extension_test.go and administrators_harness_test.go (test env shapes)
- modules/festival/bus.go 40-90 (Bus.Fire)
- scripts/check-admin-openapi.sh (what regenerates admin/openapi/admin.json and schema.d.ts)
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-SUMMARY.md and 19.6.1-04-SUMMARY.md (the seam and the outranking wrap)
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "FW/modules/cabana/account_contributions.go"
</read_first>
<action>
Account contributions (P-02, D-04 part 1), new `account_contributions.go`: `compileAccountContributions(reg *Registry, plugins []party.Plugin) error` collects `pact.HasAccountContributions` in activation order into `reg.accountContributions` (ordered slice + map by name); boot errors with the `cabana: plugin %s contributes account section %q ...` prefix for a non-identifier name, a name another plugin already contributed, an empty Label, an action with a non-identifier name, a duplicate action name within the section, a nil Run or an empty action Label. Call it in `Activate` right after `compileActionExtensions`. Handlers: `accountContributionsList` (GET) answers `WriteData(w, 200, []AccountContributionView, map[string]any{})` where each view is `{name, label, description, status, actions: [{name, label, confirm, danger}]}` with label/description/confirm/status translated through `translateKey`, `status` from `Status(ctx, principal.ID)` (omitted when the func is nil or returns ""), actions filtered by `Allows(principal, action.Permissions)` and `Applies(ctx, principal.ID)`; `accountContributionAction` (POST `{name}/actions/{action}`): 404 `not_found` for an unknown section or action, 403 through `allowAction`, 409 `actionConflict` when Applies is false, then `Run(ctx, pact.AccountActionInput{AdminID: principal.ID})` inside `s.transaction` (ctx carries the tx as record actions do) and answers `WriteData(w, 200, AccountActionResultView{Message (translated), URL}, nil)`; the audit log line `cabana: account contribution action` carries admin_id, section and action. Routes in `http.go` next to the tokens routes: `g.Get("/account/contributions", interactiveOnly(s.accountContributionsList))` and `g.Post("/account/contributions/{name}/actions/{action}", interactiveOnly(requireAjax(s.accountContributionAction)))`. Swag-annotate both (types `AccountContributionView`, `AccountContributionActionView`, `AccountActionResultView` in admin_openapi.go). Every existing `/account*`, `/auth/me` and record payload stays byte-identical (nothing in account.go changes).
Prompted record action (P-01, D-34): `RecordAction` gains `Prompt *RecordActionPrompt` with JSON `prompt,omitempty` and `RecordActionPrompt{Label, Placeholder, Comment string; MaxLength int}` (`label`, `placeholder,omitempty`, `comment,omitempty`, `max_length`); `offeredRecordActions` fills it (translated) when the action declares a Prompt; `checkContributedAction` and the owner-action compile (`compileRecordActions`) refuse a Prompt with an empty Label. `recordAction` handler: when the registered action has a Prompt, `in.Payload` must be a JSON string (decode with encoding/json into a string; anything else is 422 on `payload` "The payload must be a string."), trimmed, non-empty and at most MaxLength (0 means 255) runes, else 422 on `payload` with the new phrase `backend::lang.form.action_prompt_required` / `action_prompt_too_long` (en + pl); the existing refusal for `record_id`, `values` and for `payload` on an action without a Prompt is unchanged. Add `func (s CRUDService) RecordActionWithValue(ctx, cc, id, name, value string)` carrying the value into `pact.AdminRecordActionInput{RecordID, Record, Value}`; keep `RecordAction(ctx, cc, id, name)` as a wrapper with an empty value (exported signature unchanged).
Backend subject events (D-26 sources on the backend side), new `subject_events.go`: `fireSubjectChanged(ctx, app, kind string, adminIDs ...uint)` fires `pact.MCPSubjectChanged{Guard: "backend", UserID: id, Kind: kind}` for each id through `app.Events` when the bus exists (errors logged, never failing the save). Call it with `MCPSubjectRevoked` from the account token revoke path, with `MCPSubjectPermissions` after an Administrators save that changed role_id, permissions or is_superuser (the FormAfterUpdate snapshot already knows the prior role) and after a Roles save that changed permissions (one event per admin holding that role, ids read inside the same tx), and with `MCPSubjectDeleted` after deactivate, delete and their bulk forms.
Smoke tests (-short, through the harness shape of `backend_screens_test.go`/`example_action_extension_test.go`, no Postgres): `TestAccountContributionsSmoke` (a fake plugin contributes one section with a status and two actions; GET lists it with translated labels and omits an action whose Applies is false; POST runs the action and returns its URL; a `g15_` token or raw bearer gets 403 interactive_only; boot refuses a duplicate name across two plugins); `TestRecordActionPromptSmoke` (a contributed prompted action on a controller of the test plugin: the show payload carries `prompt` with `max_length`; POST with `{"payload":" acme "}` hands `Value == "acme"` to Run; `{"payload":""}` and `{"payload":123}` are 422 on payload; an action without a Prompt still refuses `payload`; the record response of a controller without prompted actions has no `prompt` key).
Then `scripts/check-admin-openapi.sh` (regenerates `admin/openapi/admin.json` and `admin/src/api/schema.d.ts`; commit them). Docs in the same commit: cabana README (Features: account contributions, prompted record actions, backend subject events; Admin API routes table: the two routes; API reference rows), `docs/backend/users-and-permissions.md` § "My account" (plugins can add sections and actions), `docs/backend/admin-controllers.md` § "Adding record actions to another controller" (the Prompt). Any Go example block needs `src=` pointing at a tested example file (extend `example_action_extension_test.go` with a prompted action example and add `example_account_contribution_test.go` if a code block is used).
</action>
<verify>
<automated>go vet ./... && go test -count=1 -short ./modules/cabana/... ./modules/pact/... && go test -count=1 -short -run '^(TestAccountContributionsSmoke|TestRecordActionPromptSmoke)$' -v ./modules/cabana 2>&1 | grep -c -- '^--- PASS: Test' | grep -qx 2 && scripts/check-admin-openapi.sh --check && go -C examples/hello test -count=1 ./... && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, "FAIL" in the output, the PASS count line is not exactly 2, or check-admin-openapi reports a difference</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "func compileAccountContributions(" modules/cabana/account_contributions.go` prints 1 and `grep -c "account/contributions" modules/cabana/http.go` prints 2
- `grep -c "Prompt \*RecordActionPrompt" modules/cabana/schema_types.go` prints 1 and `grep -c "json:\"prompt,omitempty\"" modules/cabana/schema_types.go` prints 1
- `grep -c "func (s CRUDService) RecordActionWithValue(" modules/cabana/crud.go` prints 1 and `grep -c "func (s CRUDService) RecordAction(" modules/cabana/crud.go` prints 1
- `grep -c "func fireSubjectChanged(" modules/cabana/subject_events.go` prints 1 and `grep -c "fireSubjectChanged(" modules/cabana/account_tokens.go modules/cabana/backend_users_admin.go modules/cabana/backend_roles_admin.go` shows a non-zero count for each of the three files
- `grep -c "action_prompt_required" modules/phrasebook/backend/lang/en/lang.yaml modules/phrasebook/backend/lang/pl/lang.yaml` prints 1 for each file
- `grep -c "AccountContributionView" admin/openapi/admin.json` prints a non-zero count and `scripts/check-admin-openapi.sh --check` exits 0
- account.go untouched by the phase: `git rev-parse -q --verify '51d088a^{commit}' >/dev/null && git diff --quiet 51d088a -- modules/cabana/account.go` exits 0 (51d088a is the framework HEAD when this plan was written; the file must be byte-identical to that commit, and an unknown base or a git error exits non-zero instead of passing)
- Both smoke tests print `--- PASS`
</acceptance_criteria>
<done>cabana lists and runs plugin account contributions behind interactiveOnly, accepts a prompt value only for prompted record actions, fires backend subject-changed events, and the OpenAPI document, schema types and docs are regenerated and committed; existing account and record payloads unchanged.</done>
</task>
<task type="auto">
<name>Task 5: Admin SPA: the account contributions section, the prompt input in the record action confirm dialog, and the rebuilt embedded admin</name>
<files>admin/src/components/ui/confirm.ts, admin/src/components/ui/ConfirmDialog.vue, admin/src/components/form/RecordActions.vue, admin/src/components/account/AccountContributions.vue, admin/src/views/AccountView.vue, admin/src/api/types.ts, admin/tests/account/AccountContributions.test.ts, admin/tests/form/RecordActionsPrompt.test.ts, modules/boardwalk/dist</files>
<read_first>
- admin/src/components/form/RecordActions.vue (confirm.ask at 49-56, api.POST with body {} at 59-62, the toast and emit paths 74-95)
- admin/src/components/ui/confirm.ts (ConfirmRequest, useConfirm) and admin/src/components/ui/ConfirmDialog.vue (props, the danger variant, busy handling)
- admin/src/views/AccountView.vue (ApiTokensPanel placement, api.PUT and showToast usage, the section markup 248-300) and admin/src/components/account/ApiTokensPanel.vue (a self-loading account panel: the pattern to copy)
- admin/src/api/types.ts 55-70 (how Schemas types are exported) and admin/src/api/schema.d.ts (regenerated in Task 4: cabana.RecordAction.prompt, cabana.AccountContributionView)
- admin/tests/views/AccountView.test.ts 1-60 and admin/tests/helpers.ts (mountApp, API, envelope, requestsTo) and admin/tests/form/PreviewView.test.ts (record action tests)
- admin/tests/form/FormView.test.ts "field triggers on the form" block (how 19.6.1 added SPA backstops)
- scripts/check-admin-dist.sh and .planning/notes/2026-10-07-embedded-admin-release-gate.md
</read_first>
<action>
confirm.ts: `ConfirmRequest` gains `prompt?: { label: string; placeholder?: string; comment?: string; maxLength: number }`; `useConfirm` keeps a `value = ref('')` reset on ask/settle and `ask` resolves with the typed value available to the caller (return `Promise<boolean>` unchanged, expose `value`). ConfirmDialog.vue: optional `prompt` prop renders a labelled text input (`id` from the dialog id prefix, `maxlength`, `autocomplete="off"`, `aria-describedby` on the comment, autofocus when present) above the buttons; the confirm button is disabled while the trimmed value is empty; Enter in the input confirms. RecordActions.vue: pass `action.prompt` into `confirm.ask`; when the action has a prompt, POST `body: { payload: value.trim() }`, otherwise `body: {}` exactly as today; a 422 on `payload` shows the server's detail text as a danger toast and keeps the dialog closed.
AccountContributions.vue (new, under components/account): on mount `api.GET('/account/contributions')`; renders nothing when the list is empty; for each section a card (same classes as the avatar card: `rounded-card border border-border bg-surface p-7 shadow-card`) with `h2` label, muted description, a `status` line (`data-account-contribution-status`) and one outline Button per action; an action with `confirm` or `danger` goes through `useConfirm` + ConfirmDialog (danger variant), then `api.POST('/account/contributions/{name}/actions/{action}')`; on success show `message` as a toast, reload the list, and when `url` is present open it with `window.open(url, '_blank', 'noopener')` and also render it as a visible link (`data-account-contribution-url`, `rel="noopener noreferrer"`, `target="_blank"`) so a blocked popup still leaves a way through; 409 shows `backend::lang.form.action_stale` and reloads; 403 shows `backend::lang.list.action_forbidden`. Labels, descriptions, statuses and messages come from the server already translated and render as text (no `v-html`). AccountView.vue mounts `<AccountContributions />` after `ApiTokensPanel`. types.ts exports `AccountContribution`, `AccountContributionAction`, `AccountActionResult` from the regenerated schema.
Vitest smokes: `admin/tests/account/AccountContributions.test.ts` (list renders two sections with statuses; an action with a URL posts, shows the toast and renders the link; an empty list renders no card; a 409 shows the stale toast and refetches) and `admin/tests/form/RecordActionsPrompt.test.ts` (a prompted action renders the input, the confirm button is disabled until a value is typed, the POST body is `{ payload: 'acme' }`; an action without a prompt still posts `{}`). Then `npm --prefix admin run typecheck`, `npm --prefix admin run test`, `npm --prefix admin run build`, commit `modules/boardwalk/dist` (one `chore` commit, as 19.6.1-02 did), `scripts/check-admin-dist.sh`. Do not run `npm ci` (node_modules is shared with other sessions) unless `npm ls` reports an inconsistent tree.
</action>
<verify>
<automated>scripts/check-admin-openapi.sh --check && npm --prefix admin run typecheck && npm --prefix admin run test && scripts/check-admin-dist.sh</automated>
<fails_when>non-zero exit, a vitest summary line that is not all passing, or check-admin-dist reporting that modules/boardwalk/dist differs from a fresh build</fails_when>
<human-check>Sign in to a locally served admin (any app with an admin, e.g. `go -C examples/hello run .` if it serves the admin, otherwise skip to plan 03's user plugin env) and open My account: with no plugin contributing, the page is unchanged. On a preview screen of a controller with a prompted contributed action (plan 03's Administrators link action), the confirm dialog shows one text input and the confirm button is disabled until text is typed.</human-check>
</verify>
<acceptance_criteria>
- `grep -c "prompt" admin/src/components/ui/confirm.ts` prints at least 2 and `grep -c "maxlength" admin/src/components/ui/ConfirmDialog.vue` prints at least 1
- `grep -c "payload: " admin/src/components/form/RecordActions.vue` prints at least 1 and `grep -c "body: {}" admin/src/components/form/RecordActions.vue` prints at least 1
- `test -f admin/src/components/account/AccountContributions.vue` and `grep -c "AccountContributions" admin/src/views/AccountView.vue` prints at least 2
- `grep -c "v-html" admin/src/components/account/AccountContributions.vue` prints 0
- `npm --prefix admin run test 2>&1 | grep -E 'Test Files +[0-9]+ passed' | grep -qv failed`
- `scripts/check-admin-dist.sh` prints that modules/boardwalk/dist matches a fresh build
- `git status --short admin/src/state/useSettings.ts admin/src/components/shell/SettingsPanel.vue` shows no change made by this task (those files belong to another session)
</acceptance_criteria>
<done>The admin shows plugin account sections on My account, asks for a prompt value before running a prompted record action, and the embedded build matches the committed dist.</done>
</task>
</tasks>
<artifacts_this_phase_produces>
## Artifacts this phase produces (plan 01 owns these; later plans add theirs)
**Go (framework)**
- `modules/bouncer/dispatch.go`: `Dispatch`, `WithDispatch`, `Dispatched`
- `modules/cabana/token_resolver.go`: `ResolveBackendToken`, `ScopeLimitFor`, `BackendPrincipal`
- `modules/cabana/account_contributions.go`: `compileAccountContributions`, handlers `accountContributionsList`, `accountContributionAction`; swag types `AccountContributionView`, `AccountContributionActionView`, `AccountActionResultView`
- `modules/cabana/schema_types.go`: `RecordAction.Prompt`, `RecordActionPrompt`
- `modules/cabana/crud.go`: `CRUDService.RecordActionWithValue`
- `modules/cabana/subject_events.go`: `fireSubjectChanged`
- `modules/surf/streaming.go`: `(*Router).MountStream`, `recoverStream`, `MCPBuildTag`
- `modules/surf/routetable.go`: `(*Router).Handler`; `modules/surf/router.go`: `compileHandlers`, `mountPier` hook, `route.stream`
- `modules/surf/pier_off.go` (`//go:build !summercms_mcp`)
- `modules/wristband/authorize.go`: `parseAuthorizeScopes(raw, allowed)` over `Options.ScopesSupported`
- `modules/cooler/cooler.go`: `KeyPrefix`
- `modules/pact/mcp.go`: `HasMCP`, `MCP`, `MCPTool`, `MCPPrompt`, `MCPPromptArgument`, `MCPPromptMessage`, `MCPGuard`, `MCPGuards`, `NewMCPGuards`, `MCPRequirements`, `MCPSubject`, `MCPDispatch`, `MCPTokenVerifier`, `MCPGrant`, `ErrMCPTokenInvalid`, `MCPPersonalTokenResolver`, `MCPLinkedBackendResolver`, `LinkedBackendUser`, `MCPSubjectChanged`, `MCPSubjectPermissions`, `MCPSubjectLink`, `MCPSubjectRevoked`, `MCPSubjectDeleted`, `FrontendPermission`, `HasFrontendPermissions`
- `modules/pact/capabilities.go`: `AdminActionPrompt`, `AdminRecordAction.Prompt`, `AdminRecordActionInput.Value`, `HasAccountContributions`, `AccountContribution`, `AccountAction`, `AccountActionInput`, `AccountActionResult`
**Routes (cabana admin API)**: `GET {api}/account/contributions`, `POST {api}/account/contributions/{name}/actions/{action}`
**Config keys read by the framework in this plan**: `mcp.enabled` (surf hook only; the full `mcp.*` set is plan 02's)
**Build tag**: `summercms_mcp` (hook only; the tagged `pier_on.go` is plan 02's)
**Phrases**: `backend::lang.form.action_prompt_required`, `backend::lang.form.action_prompt_too_long` (en, pl)
**Admin SPA**: `admin/src/components/account/AccountContributions.vue`; `ConfirmRequest.prompt`; regenerated `admin/openapi/admin.json`, `admin/src/api/schema.d.ts`; rebuilt `modules/boardwalk/dist`
**Phase-wide identifiers fixed by this plan for plans 02-05**: config namespace `mcp.*` (`mcp.enabled`, `mcp.path` default `/mcp`, `mcp.allow_personal_tokens`, `mcp.sessions.store` memory|redis, `mcp.sessions.idle_ttl` 30m, `mcp.sessions.max_per_binding` 20, `mcp.resource`, `mcp.throttle` `120,1`, `mcp.allowed_origins`, `mcp.call_timeout` 30s, `mcp.max_result_bytes` 1048576); guard names `user` and `backend`; tool prefix = last dot-segment of the plugin ID + `_`; permission code `golem15.users.manage_backend_links`; tables `golem15_user_backend_links`, `golem15_user_backend_link_requests`; session binding keys `oauth:<client_id>:<user_id>`, `pat:user:<token_id>`, `pat:backend:<token_id>`; Redis keys `<cooler.KeyPrefix>mcp:s:<id>` and channel `<prefix>mcp:events`.
</artifacts_this_phase_produces>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| HTTP request to a guarded route | untrusted headers, cookies and bodies cross into bouncer guards and cabana resolvers |
| in-process dispatcher to route handler | a trusted framework caller (pier, plan 02) hands a pre-resolved principal through the context |
| admin SPA to cabana account and action routes | the signed-in admin's browser sends action names and prompt values |
| plugin contributions to cabana at boot | plugin-declared names, labels, prompts and Run funcs are merged into the admin |
| authorize request to wristband | an MCP client's scope string crosses into the allow-list check |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.7-01 | Spoofing | bouncer dispatch marker | high | mitigate | Context-only value under an unexported key; `Dispatched` is the only reader and no code path reads a header, cookie or query for it; `TestDispatchSmoke` sends forged headers and a cookie and gets 401; plan 05's gate greps that only `modules/pier` calls the setter outside tests |
| T-19.7-02 | Elevation | cabana ResolveBackend with a marker | high | mitigate | A marker is honoured only when it lists guard `backend` and its principal has `Backend == true`; a frontend marker is ErrUnauthenticated; cover codes are still checked against a scoped principal (`TestDispatchMarkerSmoke`) |
| T-19.7-03 | Elevation | surf Handler lookup | medium | mitigate | `Handler` returns the fully wrapped chain (constraints, named middleware, body limit, recovery), never the bare handler; `TestDispatchSmoke` proves the guard middleware still runs in-process |
| T-19.7-04 | Tampering | streaming route recovery | medium | mitigate | `recoverStream` writes an opaque 500 only before the first byte; after that a panic aborts the body and marks the request panicked; it never writes the panic value (`TestStreamingRouteSmoke`) |
| T-19.7-05 | Denial of Service | mcp.enabled without the tag | low | mitigate | Boot fails with an error naming `summercms_mcp` instead of serving a half-mounted endpoint (`TestPierMountSmoke`) |
| T-19.7-06 | Elevation | account contribution actions | high | mitigate | Routes behind the backend guard and `interactiveOnly` (personal tokens refused), `requireAjax` on POST, `allowAction` for the action's Permissions, `Applies` re-checked before Run, Run receives only the signed-in admin's id (`TestAccountContributionsSmoke`) |
| T-19.7-07 | Tampering | prompted record action value | medium | mitigate | `payload` accepted only for actions that declare a Prompt and only as a JSON string, trimmed, non-empty, capped at MaxLength runes; every other record action keeps the 422 refusal (`TestRecordActionPromptSmoke`); the action's own Run validates the meaning of the value |
| T-19.7-08 | Information Disclosure | account contribution rendering in the SPA | low | mitigate | Labels, statuses, messages and URLs render as text and attributes only (no `v-html`); the URL opens with `noopener` |
| T-19.7-09 | Elevation | wristband MCP scope allow-list | medium | mitigate | The allowed set is exactly `Options.ScopesSupported`; the default is unchanged and `TestMCPScopesSmoke` proves `backend` is refused on a default server and accepted only when the host lists it |
</threat_model>
<verification>
- `go vet ./... && go test -count=1 -short ./... && go -C examples/hello test -count=1 ./... && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check && scripts/check-admin-openapi.sh --check`
- `scripts/check-admin-openapi.sh --check && npm --prefix admin run typecheck && npm --prefix admin run test && scripts/check-admin-dist.sh`
- Docker host: `go test -count=1 ./modules/cabana ./modules/surf` (every 19.6.1 Postgres test still passes) and `bash scripts/check-phase19.6.1.sh --all` (the 19.6.1 gate stays green; its sc1 stage proves account.go untouched)
- The seven smoke tests of this plan print `--- PASS` under `-short`
</verification>
<success_criteria>
- All five tasks committed; every acceptance criterion above holds
- No existing test modified except where a test asserted the absence of a key this plan adds (none expected); every pre-existing cabana, surf, bouncer, wristband, pact and admin test passes unchanged
- `mcp.enabled` absent: the framework behaves exactly as at the plan's base commit (route table, payloads, admin build apart from the two new account routes and the `prompt` key that appears only for prompted actions)
- Planner decisions P-01..P-04 are implemented as written and named in the SUMMARY
</success_criteria>
<output>
Create `.planning/phases/19.7-generic-mcp-module/19.7-01-SUMMARY.md` when done (planning docs in their own commit).
</output>

View File

@@ -0,0 +1,305 @@
---
phase: 19.7-generic-mcp-module
plan: 01
subsystem: auth
tags: [bouncer, surf, cabana, pact, wristband, cooler, mcp, admin-spa, streaming, account-contributions]
requires:
- phase: 19.6.1
provides: pact.HasAdminActionExtensions record-action seam, Administrators screen, guardOutranked wrap
- phase: 19.4
provides: wristband MCP Server with Options.ScopesSupported
- phase: 16.3
provides: cabana personal API tokens, interactiveOnly, ResolveBackend
provides:
- bouncer.Dispatch / WithDispatch / Dispatched (D-17 context-only pre-resolved principal marker), honoured by Registry.Middleware and cabana.ResolveBackend
- cabana.ResolveBackendToken, ScopeLimitFor, BackendPrincipal (additive resolvers for pier)
- surf.Router.Handler and compileHandlers (one compiled chain per route), surf.Router.MountStream and recoverStream (unbuffered route kind), surf.MCPBuildTag and the mountPier hook (D-30, D-33)
- wristband parseAuthorizeScopes over Options.ScopesSupported (D-21 framework side); cooler.KeyPrefix
- pact MCP contracts (HasMCP, MCPTool, MCPPrompt, MCPGuard(s), MCPTokenVerifier, MCPPersonalTokenResolver, MCPLinkedBackendResolver, MCPSubjectChanged, FrontendPermission) with no SDK, jsonschema-go or bouncer import
- pact.HasAccountContributions seam and the cabana routes GET /account/contributions, POST /account/contributions/{name}/actions/{action} (D-04 part 1)
- prompted record actions (pact.AdminActionPrompt, AdminRecordActionInput.Value, RecordAction.prompt, CRUDService.RecordActionWithValue) and backend pact.MCPSubjectChanged events (D-34, D-26)
- admin SPA AccountContributions card, ConfirmDialog prompt input, RecordActions payload; rebuilt modules/boardwalk/dist
affects: [19.7-02 pier module and framework release, 19.7-03 sm-user-plugin link and frontend permissions, 19.7-04 oauthserver and Journal, 19.7-05 unit tests and security review]
actuals:
tokens: 55621
tasks: 5
commits: 6
plan_head_before: a74a218cd99a04eb29fc66525f04f0be7e453b9f
plan_head_after: fab99e0a00bf4277ab4e659998267970b4a9aeb6
tech-stack:
added: []
patterns:
- "Context-only dispatch marker under an unexported key, honoured only for the exact guard names it lists; no header, cookie or query is ever read for it"
- "surf compiles each route chain once (compileHandlers) and exposes it by method + pattern for in-process dispatch; the mux reuses the same chains"
- "Build-tag hook: a package-level func var set by the tagged file, nil in the untagged one; config true without the tag fails boot naming the tag"
- "Plugin-facing MCP types live in pact as plain structs and interfaces (Principal carried as any) so no plugin links the SDK"
- "Boot-time compile of plugin contributions with cabana: plugin %s ... error prefixes and per-request translateKey for labels"
- "Prompted confirm: ConfirmRequest.prompt + useConfirm.value; the dialog owns the input, the caller reads the value inside its action"
key-files:
created:
- modules/bouncer/dispatch.go
- modules/cabana/token_resolver.go
- modules/cabana/account_contributions.go
- modules/cabana/subject_events.go
- modules/surf/streaming.go
- modules/surf/pier_off.go
- modules/pact/mcp.go
- modules/wristband/mcp_scopes_smoke_test.go
- admin/src/components/account/AccountContributions.vue
- admin/tests/account/AccountContributions.test.ts
- admin/tests/form/RecordActionsPrompt.test.ts
- modules/cabana/record_action_prompt_postgres_test.go
modified:
- modules/bouncer/registry.go
- modules/cabana/token_guard.go
- modules/cabana/actions.go
- modules/cabana/crud.go
- modules/cabana/schema_types.go
- modules/cabana/http.go
- modules/cabana/admin_openapi.go
- modules/cabana/backend_users_admin.go
- modules/cabana/backend_roles_admin.go
- modules/cabana/account_tokens.go
- modules/cabana/contracts.go
- modules/surf/router.go
- modules/surf/routetable.go
- modules/wristband/authorize.go
- modules/cooler/cooler.go
- modules/pact/capabilities.go
- admin/src/components/ui/confirm.ts
- admin/src/components/ui/ConfirmDialog.vue
- admin/src/components/form/RecordActions.vue
- admin/src/views/AccountView.vue
- admin/openapi/admin.json
- admin/src/api/schema.d.ts
- modules/boardwalk/dist
key-decisions:
- "P-01 implemented: a prompted record action is pact.AdminRecordAction.Prompt; the SPA posts the value as the existing body key payload (JSON string) and cabana accepts payload only for such an action, trimmed, non-empty, capped at MaxLength runes (0 means 255)"
- "P-02 implemented: My account contributions are a plugin interface (pact.HasAccountContributions), not an AdminController extension; cabana never names the contributing plugin"
- "P-03 implemented: bouncer.Dispatch{Guards, Principal, Credential}; Dispatched answers only for a guard name the marker lists exactly; cabana.ResolveBackend honours a backend marker and refuses a frontend one before reading any header"
- "P-04 implemented: every plugin-facing MCP type is in pact with Principal as any; a go list -deps test keeps pact free of the SDK, jsonschema-go and bouncer"
- "An account contribution action runs inside lagoon.Transaction when the app publishes a *gorm.DB; an admin booted without a database runs Run on the request context, so the -short smoke exercises the whole handler"
- "Backend subject events fire inside the saving transaction through app.Events; a listener error is logged, never fails the save (every MCP request re-checks anyway, D-08)"
- "wristband's authorize allow-list is exactly Options.ScopesSupported; an empty list keeps the PHP default so TestPhase08Coverage and every existing test are unchanged"
- "The stream route kind recovers a panic with the opaque 500 only before the first header, byte or flush; after that it only cuts the body short"
patterns-established:
- "Tracer first: Task 1 proved marker -> compiled chain -> guard -> handler end to end before any expansion"
- "Route inventories (phase09Routes, tokenRouteClasses, phase10 CSRF walk and want list, conformCases) are extended in the same commit as a new admin route"
requirements-completed: [SC-1, SC-3, SC-4, D-04, D-09, D-17, D-28, D-30, D-33, D-34, D-36]
coverage:
- id: D1
description: "In-process dispatch marker: a marker-carrying request runs a guarded route through surf's compiled chain as the pre-resolved principal; forged headers and cookies are 401; cabana.ResolveBackend honours a backend marker and refuses a frontend one"
requirement: "D-17"
verification:
- kind: unit
ref: "modules/surf/dispatch_smoke_test.go#TestDispatchSmoke"
status: pass
- kind: unit
ref: "modules/bouncer/dispatch_smoke_test.go#TestDispatchedSmoke"
status: pass
- kind: unit
ref: "modules/cabana/dispatch_smoke_test.go#TestDispatchMarkerSmoke"
status: pass
human_judgment: false
- id: D2
description: "surf.Router.Handler lookup, MountStream streaming route kind flushing mid-handler with panic recovery before and after the first byte, mcp.enabled inert without the tag and a boot error naming summercms_mcp with it"
requirement: "SC-1"
verification:
- kind: unit
ref: "modules/surf/streaming_smoke_test.go#TestStreamingRouteSmoke"
status: pass
- kind: unit
ref: "modules/surf/pier_mount_smoke_test.go#TestPierMountSmoke"
status: pass
human_judgment: false
- id: D3
description: "wristband authorize accepts exactly Options.ScopesSupported (backend only when listed, default unchanged); cooler.KeyPrefix exported"
requirement: "D-36"
verification:
- kind: unit
ref: "modules/wristband/mcp_scopes_smoke_test.go#TestMCPScopesSmoke"
status: pass
- kind: unit
ref: "go test -count=1 -short ./modules/wristband/... ./modules/cooler/..."
status: pass
human_judgment: false
- id: D4
description: "SDK-free pact contracts for MCP tools, prompts, guards, verifiers, link resolver, subject events, frontend permissions, prompted record actions and account contributions, discoverable by type assertion"
requirement: "D-28"
verification:
- kind: unit
ref: "modules/pact/capabilities_test.go#TestPhase197ContractsOnSamplePlugin"
status: pass
- kind: unit
ref: "modules/pact/capabilities_test.go#TestMCPGuardsRegistry"
status: pass
- kind: unit
ref: "modules/pact/capabilities_test.go#TestPactStaysSDKFree"
status: pass
human_judgment: false
- id: D5
description: "cabana lists and runs plugin account contributions behind interactiveOnly, refuses personal tokens, 403/404/409 paths, boot refuses duplicate or malformed sections; existing /account*, /auth/me and record payloads unchanged (account.go byte-identical to 51d088a)"
requirement: "D-04"
verification:
- kind: unit
ref: "modules/cabana/account_contributions_smoke_test.go#TestAccountContributionsSmoke"
status: pass
- kind: integration
ref: "modules/cabana/openapi_conformance_test.go#TestPhase10OpenAPIConformance (GET /account/contributions, POST .../actions/{action} cases)"
status: pass
- kind: other
ref: "git diff --quiet 51d088a -- modules/cabana/account.go"
status: pass
human_judgment: false
- id: D6
description: "Prompted record action: the record response carries prompt with max_length only for prompted actions, the route accepts payload only for them (422 on empty, non-string, over-long), Run receives the trimmed Value, plain actions keep refusing payload"
requirement: "D-34"
verification:
- kind: unit
ref: "modules/cabana/record_action_prompt_smoke_test.go#TestRecordActionPromptSmoke"
status: pass
- kind: integration
ref: "modules/cabana/record_action_prompt_postgres_test.go#TestRecordActionPromptRun"
status: pass
human_judgment: false
- id: D7
description: "Backend pact.MCPSubjectChanged events on token revoke, Administrators saves changing role/permissions/superuser, Roles saves changing grants, deactivation and deletion"
requirement: "D-36"
verification:
- kind: integration
ref: "go test -count=1 ./modules/cabana (Postgres; the 19.6.1 Administrators and Roles suites pass with the hooks in place)"
status: pass
human_judgment: true
rationale: "The hooks compile and the lifecycle suites pass through them, but no test yet asserts the fired events themselves; plan 05 (unit tests) adds the listener assertions"
- id: D8
description: "Admin SPA: My account shows contributed sections with status, actions, toast, new-tab URL and visible link; the confirm dialog of a prompted record action shows one text input, confirm disabled until typed, posts {payload}; plain actions post {}; dist rebuilt and matching"
requirement: "SC-4"
verification:
- kind: unit
ref: "admin/tests/account/AccountContributions.test.ts"
status: pass
- kind: unit
ref: "admin/tests/form/RecordActionsPrompt.test.ts"
status: pass
- kind: other
ref: "scripts/check-admin-dist.sh"
status: pass
human_judgment: true
rationale: "The plan's human-check (an unchanged My account page without contributors, the prompt input on a preview screen) is visual; plan 03's user plugin provides the first real contributor and prompted action to look at"
duration: 52 min
completed: 2026-10-22
status: complete
---
# Phase 19.7 Plan 01: Framework seams for the MCP module Summary
**D-17 dispatch marker in bouncer and cabana, surf's compiled-chain lookup plus an unbuffered streaming route kind and the tagged pier hook, SDK-free pact MCP contracts, the My account contribution seam with prompted record actions on cabana and in the SPA, wristband's configurable scope set and cooler.KeyPrefix, all additive and all green on the existing suites**
## Performance
- **Duration:** 52 min
- **Started:** 2026-10-22T13:54:19Z
- **Completed:** 2026-10-22T14:46:00Z
- **Tasks:** 5
- **Files modified:** 64 hand-written (68 with the rebuilt dist)
## Accomplishments
- Tracer (Task 1): a request carrying `bouncer.WithDispatch` runs `GET /acme/items/{id}` through `surf.Router.Handler` as principal 42 with the path value set; the same request without the marker, with forged `X-Summer-Dispatch`/`Authorization: Dispatch`/cookie headers, or with a marker for another guard is 401. `cabana.ResolveBackend` honours a `backend` marker, refuses a frontend one and keeps the cover check on a scoped principal. Additive `ResolveBackendToken`, `ScopeLimitFor`, `BackendPrincipal` reuse the published resolver guard.
- surf: `compileHandlers` builds each chain once for both BuildRouter's validation and `compile`; `MountStream` + `recoverStream` serve on the real writer (first event received while the handler waits; a buffered route in the same test holds even its headers); `mountPier` hook with `mcp.enabled` false inert and the untagged error naming `summercms_mcp`.
- wristband: `parseAuthorizeScopes(raw, allowed)` with `allowedAuthorizeScopes()` from `Options.ScopesSupported`; `backend` accepted only when a host lists it, metadata lists it, default server still answers `scope contains an unsupported value`. `cooler.KeyPrefix` exported.
- pact: every MCP, frontend-permission, account-contribution and prompt type with doc comments naming the boot failures; `TestPactStaysSDKFree` runs `go list -deps`.
- cabana: `compileAccountContributions` at Activate, the two account routes (swag-annotated, conformance and inventory tests extended), `RecordAction.prompt`, `promptValue` validation (`backend::lang.form.action_prompt_required` / `_too_long` en+pl), `RecordActionWithValue`, `fireSubjectChanged` wired into token revoke, Administrators and Roles saves, deactivate and delete (record and bulk through the shared lifecycle `run`). `account.go` untouched.
- SPA: `AccountContributions.vue` mounted after `ApiTokensPanel`, prompt input in `ConfirmDialog`, `RecordActions` posting `{payload}` or `{}`, 1490 vitest tests green, dist rebuilt and matching.
## Task Commits
1. **Task 1: Tracer, dispatch marker and compiled handler lookup** - `1bd91a4` (feat)
2. **Task 2: Streaming routes, MCP mount hook, configurable authorize scopes** - `5c15dea` (feat)
3. **Task 3: SDK-free pact contracts** - `6887abf` (feat)
4. **Task 4: Account contributions, prompted record actions, backend subject events** - `9f14cf6` (feat)
5. **Task 5: Admin SPA** - `9a5f27e` (feat) and `fab99e0` (chore: rebuilt `modules/boardwalk/dist`)
**Plan metadata:** see the docs commit after this file.
## Files Created/Modified
- `modules/bouncer/dispatch.go` - `Dispatch`, `WithDispatch`, `Dispatched`; `registry.go` honours it before `authenticate`
- `modules/cabana/token_guard.go` - marker branch in `ResolveBackend`; `logTokenAuthAt`; `token_resolver.go` - the three additive resolvers
- `modules/surf/router.go`, `routetable.go`, `streaming.go`, `pier_off.go` - handler map, `Handler`, stream kind, `MCPBuildTag`, `mountPier`
- `modules/wristband/authorize.go` - allow-list from options; `modules/cooler/cooler.go` - `KeyPrefix`
- `modules/pact/mcp.go`, `capabilities.go` - the contracts
- `modules/cabana/account_contributions.go`, `subject_events.go`, `actions.go`, `crud.go`, `schema_types.go`, `http.go`, `admin_openapi.go`, `backend_users_admin.go`, `backend_roles_admin.go`, `account_tokens.go`, `contracts.go`, `action_extensions.go`, `extension.go`
- `modules/phrasebook/backend/lang/{en,pl}/lang.yaml` - the two prompt phrases
- `admin/src/components/ui/confirm.ts`, `ConfirmDialog.vue`, `form/RecordActions.vue`, `account/AccountContributions.vue`, `views/AccountView.vue`, `api/types.ts`; regenerated `admin/openapi/admin.json`, `admin/src/api/schema.d.ts`; rebuilt `modules/boardwalk/dist`
- READMEs of bouncer, cabana, surf, wristband, cooler, pact; `docs/services/{authentication,routing,oauth-server}.md`, `docs/plugins/registration.md`, `docs/backend/{admin-controllers,users-and-permissions}.md`
- Smoke tests: `TestDispatchSmoke`, `TestDispatchedSmoke`, `TestDispatchMarkerSmoke`, `TestStreamingRouteSmoke`, `TestPierMountSmoke`, `TestMCPScopesSmoke`, `TestAccountContributionsSmoke`, `TestRecordActionPromptSmoke` (all `-short`), `TestRecordActionPromptRun` (Postgres), two vitest files
## Decisions Made
See `key-decisions` above: planner decisions P-01 to P-04 implemented as written; the account action transaction fallback without a database; events fired inside the saving transaction; the stream recovery rule; the wristband default kept.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 1 - Bug] `TestPhase121ContractsOnSampleController` asserted `AdminRecordActionInput` has 2 fields**
- **Found during:** Task 3
- **Issue:** the test pins the input's shape; this plan adds `Value`
- **Fix:** assertion updated to 3 with the comment that there is still no id list
- **Files modified:** modules/pact/capabilities_test.go
- **Verification:** `go test -short ./modules/pact/...`
- **Committed in:** 6887abf
**2. [Rule 3 - Blocking] Admin route inventories refused the two new routes**
- **Found during:** Task 4
- **Issue:** `phase09Routes`, `tokenRouteClasses`, the CSRF walk count (34), the phase 10 unsafe-route `want` list and `conformCases` each fail when a route is added without an entry
- **Fix:** entries added (both routes `classInteractive`; CSRF count 35; conformance cases with a section the `conformPlugin` contributes), so the gates keep protecting the inventory
- **Files modified:** modules/cabana/security_coverage_test.go, token_routes_test.go, phase10_csrf_test.go, phase10_coverage_test.go, openapi_conformance_test.go
- **Verification:** `go test -short ./modules/cabana/` and the Postgres conformance run
- **Committed in:** 9f14cf6
**3. [Rule 2 - Missing critical] Postgres proof that `Run` receives the prompt value**
- **Found during:** Task 4
- **Issue:** there is no DB-free GORM driver, so the `-short` smoke can prove the route's validation and the show payload but not the `Run` call; the plan's "hands Value == acme to Run" needs a record load
- **Fix:** `TestRecordActionPromptRun` on the 19.6.1 `screensEnv` harness (skips under `-short`), run through Docker and green
- **Files modified:** modules/cabana/record_action_prompt_postgres_test.go
- **Verification:** `go test -count=1 -run TestRecordActionPromptRun ./modules/cabana`
- **Committed in:** 9f14cf6
---
**Total deviations:** 3 auto-fixed (1 bug in a shape-pinning test, 1 blocking inventory, 1 missing proof)
**Impact on plan:** No scope change; every deviation keeps an existing gate meaningful or adds the proof the plan asked for.
## Issues Encountered
- `TestStreamingRouteSmoke` first deadlocked: the buffered comparison route holds even its response headers until the handler returns, so `client.Get` blocks; the GET now runs in a goroutine and the test asserts nothing arrives within 300 ms, then everything after the release.
- `scripts/check-phase19.6.1.sh --all` (the plan's Docker-host gate) was stopped by the host while the session was idle, after `go test -count=1 ./modules/cabana ./modules/surf` had already passed (93.9 s and 15.5 s). Its `sc1` stage (account.go untouched) is proven separately by `git diff --quiet 51d088a -- modules/cabana/account.go`; the full gate should be re-run on the Docker host before the plan 02 release.
- The plan's acceptance grep `json:"prompt,omitempty"` counts two lines in `schema_types.go`; the second is the pre-existing `FormField.Prompt` tag (logged in `deferred-items.md`, resolved).
## User Setup Required
None - no external service configuration required.
## Known Stubs
None. `AccountContributions.vue` renders nothing on an empty or failed list by design (a page without contributors is unchanged).
## Next Phase Readiness
- Plan 02 (pier) can build on: `surf.Router.Handler` + `MountStream` + `mountPier` (set in a `pier_on.go` under `//go:build summercms_mcp`), `bouncer.WithDispatch`, `cabana.ResolveBackendToken`/`ScopeLimitFor`/`BackendPrincipal`, `pact.MCPGuards` (find-or-publish), `pact.MCPSubjectChanged` listeners, `cooler.KeyPrefix`.
- Plan 03 (sm-user-plugin): `pact.HasFrontendPermissions`, `pact.HasAccountContributions` for "Link frontend account", a prompted `link_frontend_account` and a plain `unlink_frontend_account` on `cabana.AdministratorsControllerID`, `pact.MCPLinkedBackendResolver`, `pact.MCPPersonalTokenResolver`.
- Plan 04 (oauthserver): append `backend` to the MCP server's `ScopesSupported`; publish `pact.MCPTokenVerifier`.
- Plan 05: unit tests for the seams (event assertions, streaming edge cases), the gate grep that only `modules/pier` calls `WithDispatch` outside tests, and the deferred `gofmt` drift in cabana (`deferred-items.md`).
- Re-run `bash scripts/check-phase19.6.1.sh --all` on the Docker host (stopped by the host this session, see Issues).
---
*Phase: 19.7-generic-mcp-module*
*Completed: 2026-10-22*
## Self-Check: PASSED
All 12 listed created files exist on disk and all 6 task commits (1bd91a4, 5c15dea, 6887abf, 9f14cf6, 9a5f27e, fab99e0) are in history; measured commits a74a218..HEAD = 6.

View File

@@ -0,0 +1,428 @@
---
phase: 19.7-generic-mcp-module
plan: 02
type: execute
wave: 2
depends_on: ["19.7-01"]
files_modified:
- go.mod
- go.sum
- .planning/notes/2026-10-22-mcp-go-sdk.md
- .planning/research/STACK.md
- modules/pier/README.md
- modules/pier/pier.go
- modules/pier/config.go
- modules/pier/host.go
- modules/pier/catalog.go
- modules/pier/dispatch.go
- modules/pier/identity.go
- modules/pier/guards.go
- modules/pier/backend_guard.go
- modules/pier/session.go
- modules/pier/stateless.go
- modules/pier/store.go
- modules/pier/store_memory.go
- modules/pier/store_redis.go
- modules/pier/events.go
- modules/pier/prm.go
- modules/pier/audit.go
- modules/pier/tracer_smoke_test.go
- modules/pier/sessions_smoke_test.go
- modules/pier/stateless_smoke_test.go
- modules/surf/pier_on.go
- modules/surf/README.md
- README.md
- docs/services/mcp.md
- docs/site.yaml
- docs/services/authentication.md
- docs/plugins/registration.md
autonomous: false
requirements: [SC-1, SC-2, SC-3, SC-4, D-08, D-10, D-11, D-12, D-13, D-14, D-15, D-16, D-17, D-19, D-20, D-21, D-22, D-23, D-24, D-25, D-26, D-27, D-28, D-29, D-30, D-31, D-32, D-33, D-35, D-36]
estimate:
tokens: 95000
raw_tokens: 95000
tasks: 6
confidence: low
must_haves:
truths:
- "An application built with the summercms_mcp tag and mcp.enabled true serves POST/GET/DELETE at mcp.path; without the tag the binary carries no go-sdk and with the flag off nothing is mounted (SC-1, D-30, D-33)"
- "A plugin that implements pact.HasMCP has its tools exposed as <shortcode>_<name>; a plugin that declares none exposes none; a tool bound to a missing route, a non-token-guarded route without a Guard, a duplicate or invalid name, or a non-object Input fails boot by name (SC-2, D-10, D-12, D-15)"
- "tools/list is computed for the identity of the current request: a read-only grant hides non-read-only tools, a tool whose guard has no subject is hidden, and the guard provider's MCPAllows decides the rest; a tools/call for a tool not in that list is refused (SC-3, D-16, D-20, D-23)"
- "A tools/call runs in-process through surf's compiled chain of the bound route with the bouncer dispatch marker and no Authorization or Cookie header; a 2xx answers text plus structuredContent and a non-2xx answers isError with the route's own body (D-10, D-11, D-13, D-17)"
- "Every request is authorized afresh from its bearer; a session is bound to (client_id, user_id) or the personal token id and refuses another binding with 403; DELETE ends it everywhere; a session initialised on one instance serves its next call on another through the Redis store (D-25, D-27, D-35)"
- "A 2026-07-28 client is served statelessly and a 2025-11-25 client statefully from the same path, sharing identity, dispatch and filtering (D-32)"
- "A subject-changed event on any instance reaches every session and stateless server of that subject: permission and link changes send notifications/tools/list_changed, revocation and deletion close the session (D-26, D-27)"
- "The backend principal of a linked admin keeps the admin's real cabana permissions, superuser included, capped by the grant's read/write ceiling (D-22)"
- "go-sdk v1.8.0 and jsonschema-go v0.4.3 are named in a decision note and a STACK.md row before any code imports them, and a human confirmed their legitimacy before go get (D-24)"
- "The framework is tagged and pushed only after the user's go-ahead; the tag carries 19.6.1 together with 19.7 plans 01 and 02, and the changelog post follows the same day (D-31)"
artifacts:
- path: "modules/pier/pier.go"
provides: "Mount, Config loading, boot validation"
contains: "func Mount("
- path: "modules/pier/catalog.go"
provides: "prefixing, schema reflection, binding and name checks"
contains: "jsonschema.ForType"
- path: "modules/pier/dispatch.go"
provides: "arguments to *http.Request, recorder to CallToolResult"
contains: "httptest.NewRecorder"
- path: "modules/pier/session.go"
provides: "rehydrating session router over StreamableServerTransport"
contains: "StreamableServerTransport"
- path: "modules/pier/stateless.go"
provides: "the 2026-07-28 stateless handler"
contains: "Stateless"
- path: "modules/pier/store_redis.go"
provides: "Redis session registry and pub/sub fan-out"
contains: "PExpire"
- path: "modules/pier/prm.go"
provides: "RFC 9728 protected resource metadata and the WWW-Authenticate challenge"
contains: "oauth-protected-resource"
- path: "modules/surf/pier_on.go"
provides: "the tagged mount hook"
contains: "//go:build summercms_mcp"
- path: ".planning/notes/2026-10-22-mcp-go-sdk.md"
provides: "the D-24 decision note"
contains: "v1.8.0"
- path: "docs/services/mcp.md"
provides: "the MCP services page"
- path: "modules/pier/README.md"
provides: "standard module README with the Name mnemonic"
contains: "**Name:**"
key_links:
- from: "modules/surf/pier_on.go"
to: "modules/pier/pier.go"
via: "init sets surf's mountPier hook to an adapter implementing pier.Host"
pattern: "mountPier = "
- from: "modules/pier/dispatch.go"
to: "modules/bouncer/dispatch.go"
via: "WithDispatch on the inner request context, the only call site outside tests"
pattern: "WithDispatch\\("
- from: "modules/pier/dispatch.go"
to: "modules/surf/routetable.go"
via: "host.Handler(method, pattern) resolved lazily on first call"
pattern: "Handler\\("
- from: "modules/pier/identity.go"
to: "modules/pact/mcp.go"
via: "app.Lookup of pact.MCPTokenVerifier, pact.MCPPersonalTokenResolver, pact.MCPLinkedBackendResolver and *pact.MCPGuards"
pattern: "Lookup\\[pact\\."
- from: "modules/pier/events.go"
to: "modules/pact/mcp.go"
via: "app.Events.Listen of pact.MCPSubjectChanged, republished on the store's channel"
pattern: "MCPSubjectChanged"
---
<!-- planner-discipline-allow: WithDispatch( -->
<!-- planner-discipline-allow: modelcontextprotocol/go-sdk -->
<!-- planner-discipline-allow: "ai" -->
<objective>
Build `modules/pier`, the opt-in MCP endpoint inside a SummerCMS binary, on the official go-sdk v1.8.0, behind the `summercms_mcp` build tag (D-33) and the `mcp.enabled` flag (D-30): plugin-declared tools and prompts compiled from `pact.HasMCP` (D-10..D-16, D-28), per-request identity from an `oas_at_` verifier or, behind a flag, personal tokens (D-19), a backend subject resolved through the published link resolver on every request (D-08), per-principal filtering with the read/write ceiling (D-20, D-23) and the backend scope (D-21), in-process dispatch through surf's compiled handler with the bouncer marker (D-17), a Redis-backed rehydrating session router with a memory fallback (D-25, D-27), pub/sub fan-out of `list_changed` (D-26), the stateless 2026-07-28 path (D-32), protected resource metadata (RFC 9728), and an audit line per call (D-23). Then the framework release that carries 19.6.1 (executed, unreleased; the commits carried are whatever `git log --oneline v0.4.3..HEAD` lists at tag time, not a count fixed here) together with plans 01 and 02.
**Planner decisions recorded here:**
- **P-05 (config keys, Claude's discretion):** namespace `mcp.*` (feature namespaces like `http.*`, `cache.*`, `realtime.*`): `mcp.enabled` (false), `mcp.path` (`/mcp`), `mcp.allow_personal_tokens` (false), `mcp.sessions.store` (`memory`|`redis`, default `memory`; A7: the single-instance demo has no Redis), `mcp.sessions.idle_ttl` (`30m`), `mcp.sessions.max_per_binding` (20), `mcp.resource` (default `app.url` + `mcp.path`, no trailing slash), `mcp.throttle` (`120,1`, surf's inline spelling), `mcp.allowed_origins` (default: the origin of `app.url`), `mcp.call_timeout` (`30s`), `mcp.max_result_bytes` (1048576).
- **P-06 (session binding, D-35):** `oauth:<client_id>:<user_id>` for grants, `pat:user:<token_id>` and `pat:backend:<token_id>` for personal tokens; the binding survives access-token rotation.
- **P-07 (link lookup staleness, D-08):** the linked admin is resolved per request through `pact.MCPLinkedBackendResolver` with an in-process cache of at most 5 seconds per frontend user id, invalidated at once by `pact.MCPSubjectChanged{Kind: link}`; the stated staleness bound is 5 s on the instance that did not receive the event and 0 on the one that did.
- **P-08 (protocol routing, D-32):** a request whose `MCP-Protocol-Version` header is `2026-07-28`, or whose first JSON-RPC method is `server/discover`, goes to the SDK's stateless handler; everything else goes to the stateful router. The executor confirms the discriminator against go-sdk `docs/protocol.md` and `mcp/streamable.go` before coding it.
- **P-09 (release version):** a new module, new pact capabilities and additive surf/bouncer/cabana API warrant a minor bump; the planner proposes `v0.5.0`, the user decides at the checkpoint.
Why the legitimacy checkpoint precedes the tracer: the tracer's first command is `go get` of two [ASSUMED] Go modules (RESEARCH Package Legitimacy Audit: the seam cannot check Go), and the project's rule gates every such install behind a blocking human check (as 19.5 and 19.6 did).
Purpose: SC-1, SC-2 and SC-3 become true in the framework; plans 03 and 04 can wire the user guard, the verifier, the link and the first tools.
Output: `modules/pier` with README, the tagged `pier_on.go`, root README row, `docs/services/mcp.md`, the decision note and STACK row, smoke tests, and the tagged framework release after the go-ahead.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/PROJECT.md
@.planning/ROADMAP.md
@.planning/STATE.md
@.planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md
@.planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md
@.planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md
@.planning/phases/19.7-generic-mcp-module/19.7-01-SUMMARY.md
@.planning/notes/2026-10-20-sociallogin-goth.md
@.planning/notes/2026-10-07-embedded-admin-release-gate.md
@CLAUDE.md
</context>
<project_rules>
- Framework code and docs never name a consuming application or a specific plugin: pier names guards `user` and `backend`, never `golem15.user`, Journal or an MCP client vendor; examples use `acme`/`blog`.
- Only `modules/pier` imports `github.com/modelcontextprotocol/go-sdk` and `github.com/google/jsonschema-go`; `pact` stays SDK-free (plan 01). `examples/hello` must still build and test without the tag.
- A new dependency lands only after the decision note and the STACK.md row exist (D-24) and after the human legitimacy check (Task 1).
- Stage by explicit path; one logical change per commit; planning docs separately; no co-author tags. Tag and push only inside Task 6 after the user's go-ahead.
- Several sessions share this repo: run `git status --short` before touching `modules/surf`, `README.md`, `go.mod`; never edit `admin/src/state/useSettings.ts` or `admin/src/components/shell/SettingsPanel.vue`.
- Docs rule: every identifier in `modules/pier/README.md` and `docs/services/mcp.md` must exist; Go code blocks need `src=` pointing at a tested file; run `go run ./cmd/summer docs:build --check` and `docs:sync` in the same commit as the code.
</project_rules>
<tasks>
<task type="checkpoint:human-verify" gate="blocking-human">
<name>Task 1: Human legitimacy check of go-sdk v1.8.0 and jsonschema-go v0.4.3 before any go get</name>
<what-built>Nothing yet: this gate precedes the first `go get`. RESEARCH's Package Legitimacy Audit marks `github.com/modelcontextprotocol/go-sdk` v1.8.0 and `github.com/google/jsonschema-go` v0.4.3 (plus the transitive `segmentio/asm`, `segmentio/encoding`, `yosida95/uritemplate/v3`, `golang.org/x/oauth2`, `golang.org/x/time`) as [ASSUMED], because the legitimacy seam supports npm, PyPI and crates only.</what-built>
<how-to-verify>
1. Open https://pkg.go.dev/github.com/modelcontextprotocol/go-sdk@v1.8.0 and confirm the module path, that v1.8.0 (2026-09-04) is the latest tag and that the repository is github.com/modelcontextprotocol/go-sdk (the official organisation).
2. Open https://pkg.go.dev/github.com/google/jsonschema-go@v0.4.3 and confirm the module path and that the repository is github.com/google/jsonschema-go.
3. Optionally run `GOFLAGS=-mod=mod go list -m -versions github.com/modelcontextprotocol/go-sdk` from the repo root and confirm the list ends with v1.8.0 (a newer v1.9 may exist if executing after 2026-11-20; RESEARCH asks to re-check `@latest` then).
4. Confirm the licences are acceptable: go-sdk MIT transitioning to Apache-2.0, jsonschema-go MIT.
</how-to-verify>
<resume-signal>Type "approved" to allow `go get` of exactly these two modules at these versions, or name the module and version to use instead</resume-signal>
</task>
<task type="tracer">
<name>Task 2: Tracer: one tool declared by a fake plugin is listed and called end-to-end by an SDK client through the stateful path, dispatching in-process with the marker</name>
<reversibility rating="costly">Session storage and the per-session server shape the module's internals (D-25 costly, user-chosen); tool names once shipped are referenced by clients (D-12 costly).</reversibility>
<files>.planning/notes/2026-10-22-mcp-go-sdk.md, .planning/research/STACK.md, go.mod, go.sum, modules/pier/pier.go, modules/pier/config.go, modules/pier/host.go, modules/pier/catalog.go, modules/pier/dispatch.go, modules/pier/identity.go, modules/pier/guards.go, modules/pier/backend_guard.go, modules/pier/session.go, modules/pier/store.go, modules/pier/store_memory.go, modules/pier/audit.go, modules/pier/tracer_smoke_test.go, modules/pier/README.md, modules/surf/pier_on.go, README.md</files>
<read_first>
- .planning/phases/19.7-generic-mcp-module/19.7-01-SUMMARY.md (the exact exported names plan 01 shipped: pact.MCP*, bouncer.WithDispatch, surf Handler/MountStream/mountPier, cabana.ResolveBackendToken/ScopeLimitFor/BackendPrincipal, cooler.KeyPrefix)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Summary", § "Architecture Patterns" (diagram, Patterns 1, 3, 4, 5, 8), § "Code Examples", § "Common Pitfalls" 3, 6, 7, 9, 11, 12, § "Anti-Patterns to Avoid"
- .planning/notes/2026-10-20-sociallogin-goth.md (decision note format) and .planning/research/STACK.md lines 40-56 (row format)
- go-sdk v1.8.0 in the module cache after go get: mcp/streamable.go (StreamableServerTransport, StreamableHTTPHandler sessions map, the 404 session-not-found), mcp/server.go (Server.AddTool low-level API and its type:object panic, RemoveTools, Connect, ServerSessionOptions), mcp/session.go (ServerSessionState), mcp/protocol.go (ToolAnnotations, CallToolResult), auth/auth.go (RequireBearerToken, TokenInfo), docs/protocol.md
- jsonschema-go v0.4.3 jsonschema/infer.go (ForType, required rule, additionalProperties) and the Schema.Resolve/Validate API
- modules/surf/apidocs.go 88-150 and modules/lagoon/attach/s3_on.go (mount and tag patterns), modules/surf/overlap.go 397-422 (SetPathValue, Pattern)
- modules/cabana/administrators_harness_test.go 358-392 (request building against a handler with httptest.ResponseRecorder)
- modules/cabana/contracts.go 295-335 (Allows and granted), modules/bouncer/context.go (ScopeLimit semantics)
- modules/cooler/README.md § "Overview" rows 1-12 (README shape with the Name line) and root README.md lines 94-123 (module table row format)
</read_first>
<action>
First (D-24, before any import): write `.planning/notes/2026-10-22-mcp-go-sdk.md` in the goth note's shape (Decision, Measurements, Maintenance risk, Rejected alternatives, Related dependencies, Package legitimacy, Consequences) with RESEARCH's numbers: go-sdk v1.8.0 (2026-09-04, MIT to Apache-2.0), jsonschema-go v0.4.3 (MIT), the exact new modules in the graph (go-sdk, jsonschema-go, segmentio/asm v1.1.3, segmentio/encoding v0.5.4, yosida95/uritemplate/v3 v3.0.2, x/oauth2 v0.35.0, x/time v0.15.0; x/sync and x/sys stay at the framework's newer versions), the +2.9 MiB stripped size, the build-tag containment (D-33: only tagged binaries link it), the stateful-only-in-memory sessions fact that motivates the own session router, and `govulncheck` run as `go run golang.org/x/vuln/cmd/govulncheck@latest ./modules/pier/...` with its result; add the STACK.md row for both modules naming the note. Commit as `docs(19.7-02): decide the MCP Go SDK`. Then `go get github.com/modelcontextprotocol/go-sdk@v1.8.0 github.com/google/jsonschema-go@v0.4.3` (exactly the versions the checkpoint approved).
Module skeleton (final package layout; identifiers are final unless the executor finds a conflict with the SDK, then record the rename in the SUMMARY):
- `host.go`: `type Host interface { Routes() []RouteInfo; Handler(method, pattern string) (http.Handler, bool); MountStream(method, path string, h http.Handler, middleware ...string) error; MountJSON(method, path string, h http.Handler) error; Owner(method, path string) (string, bool) }` and `type RouteInfo struct { Method, Pattern, PluginID string; Middleware []string }` so pier never imports surf.
- `config.go`: `type Config struct` with the P-05 keys, `LoadConfig(cfg *compass.Config) (Config, error)` validating the path like apidocs (absolute, no query/wildcard), the store name, durations and the throttle spelling; errors are `pier: mcp.<key> ...`.
- `pier.go`: `func Mount(host Host, app *backpack.App, plugins []party.Plugin) error`: load config; collect `pact.HasMCP` plugins (zero is fine); compile the catalog; build the identity resolver, the guard set, the store (memory in this task) and the session router; mount `POST/GET/DELETE <path>` through `host.MountStream` with middleware `throttle:<mcp.throttle>` and the Origin check wrapper; refuse a path collision through `host.Owner` with an error naming the owner. Nothing dials Redis at mount.
- `catalog.go`: prefix = last dot-segment of `plugin.ID()`, lowercased, runs of non `[a-z0-9]` replaced by `_`, plus `_`; exposed name must match `^[a-z0-9_]{1,128}$`; boot errors with the `pier: plugin %s tool %q ...` prefix for: route not found by exact method+pattern (D-10), route not token-guarded and no Guard (D-15: a guard provider's `MCPTokenGuarded(middleware)` must be true for the tool's Guard, or the tool names a Guard explicitly), unknown Guard name, duplicate exposed name within or across plugins (Pitfall 11), Input nil or not a struct/pointer-to-struct, `jsonschema.ForType` error or non-object schema, a `path:"x"` tag without a `{x}` segment or a segment without a tag, a GET/DELETE tool with fields that are neither path nor query; requirements per tool = `guard.MCPRequirements(middleware)` ∪ tool.Permissions (D-16); annotations per D-14 with explicit DestructiveHint/OpenWorldHint pointers (RESEARCH Code Example); prompts prefixed the same way (D-28) with duplicate checks against tools. The schema is resolved once at boot for validation.
- `dispatch.go`: validate arguments against the resolved schema; split by tags; build `httptest.NewRequest(method, path-with-values+query, body)` where the body is the agent's raw JSON object minus path and query keys (Pitfall 6; no body for GET/DELETE); set `Content-Type` and `Accept: application/json`, copy `RemoteAddr`, `X-Forwarded-For`, `X-Real-IP`, `Accept-Language` from the outer request; never set `Authorization` or `Cookie`; `SetPathValue` for each segment and `r.Pattern = method + " " + pattern`; context = outer context with `mcp.call_timeout` and `bouncer.WithDispatch(&bouncer.Dispatch{Guards: d.Guards, Principal: d.Principal.(*bouncer.Principal), Credential: d.Credential})` from `guard.MCPDispatch(ctx, subject, method)`; resolve `host.Handler(method, pattern)` lazily once (cache per tool); serve into a size-capped `httptest.ResponseRecorder`; map 2xx to `TextContent` (body) plus `StructuredContent` (the parsed object, or `{"data": v}` for a non-object, Pitfall 12), anything else to `IsError: true` with the body as text and, when it is a JSON object, as structuredContent; a recorder cap overflow is an isError with a fixed text.
- `identity.go`: `type Identity struct { Frontend, Backend *pact.MCPSubject; Scopes []string; Binding string; ExpiresAt time.Time }`; `resolve(ctx, raw string) (Identity, error)`: prefix `oas_at_` → the published `pact.MCPTokenVerifier` (missing → 401); when `mcp.allow_personal_tokens`: `g15_` → `cabana.ResolveBackendToken` (backend subject with Scopes = stored names, binding `pat:backend:<id>`), otherwise the published `pact.MCPPersonalTokenResolver` (frontend subject, `pat:user:<id>`); OAuth: frontend subject from the grant, binding `oauth:<client_id>:<user_id>`, and when `backend` ∈ scopes and the published `pact.MCPLinkedBackendResolver` answers, a backend subject `{Guard: "backend", UserID: link.ID, Scopes: grant scopes, ClientID, TokenID}` (P-07 cache). 401 answers carry `WWW-Authenticate: Bearer resource_metadata="<mcp.resource's PRM URL>"` (the PRM route itself is Task 3).
- `guards.go`: `*pact.MCPGuards` looked up from the app (find-or-publish); `backend_guard.go`: the built-in `backend` provider: `MCPTokenGuarded` = middleware contains `backend`; `MCPRequirements` = none from middleware; `MCPAllows` = `cabana.Allows(principal, permissions)` where principal = `cabana.BackendPrincipal(ctx, app, subject.UserID)` with `Scope` = `cabana.ScopeLimitFor(app, subject.Scopes, method)` when the subject came from a `g15_` token; `MCPDispatch` returns that principal, the token row as credential for personal tokens, and `Guards: []string{"backend"}`. Registered into the MCPGuards registry at Mount unless a plugin already owns `backend` (then boot error naming the owner).
- Filtering (`catalog.go` or `filter.go`): `allowed(ctx, id Identity) ([]tool, []prompt)`: tool.Guard must have a subject; D-20 ceiling: without `write` in the identity's scopes only tools whose ReadOnlyHint is true; then `guard.MCPAllows`. Applied to build a per-session server AND re-applied by receiving middleware on every `tools/list`, `prompts/list`, `prompts/get` and `tools/call` for the current request's identity (D-08, D-25 fresh auth): a call for a tool outside the list answers a JSON-RPC error with a fixed text.
- `session.go` + `store.go` + `store_memory.go`: `type Store interface { Put(ctx, id string, rec Record, ttl) error; Get(ctx, id) (Record, bool, error); Touch(ctx, id, ttl) error; Delete(ctx, id) error; Publish(ctx, Event) error; Subscribe(ctx, func(Event)) error; Count(ctx, binding) (int, error) }`; `Record{Binding string; State []byte (json of mcp.ServerSessionState); Created time.Time}`; the stateful router: POST without `Mcp-Session-Id` whose method is `initialize` → `rand.Text()` id, per-identity `*mcp.Server` (name/version from app.name and the framework version), `Connect(ctx, &mcp.StreamableServerTransport{SessionID: id}, nil)`, store after `initialized` with the sliding TTL, refuse when `Count(binding) >= max_per_binding` (429); request with an id: `Get` → missing → 404 `session not found`; binding differs → 403 `{"error":"session_binding"}`; local transport present → serve, else rehydrate with `ServerSessionOptions{State}` (RESEARCH Code Example) and keep the transport in the local map; `Touch` on every request; DELETE → `Delete` + `Publish(ended)` + close local; a goroutine on `ss.Wait()` removes the local entry. Memory store: map with expiry sweep and in-process subscribers.
- `audit.go`: one `pier: tool call` log line per call through `diary.For("pier")` with tool, guard, user_id, admin_id, client_id, session prefix (8 chars), status, duration_ms; never arguments, bodies or tokens.
- `modules/surf/pier_on.go` (`//go:build summercms_mcp`): `func init() { mountPier = func(r *Router, app *backpack.App, plugins []party.Plugin) error { return pier.Mount(pierHost{r}, app, plugins) } }` with `pierHost` adapting Routes/Handler/MountStream/MountJSON/Owner (MountJSON registers a raw GET through GroupRaw under the pseudo-plugin `summercms.pier` via BindPlugin). Confirm `go build ./...` without the tag still excludes pier from `examples/hello` (`go version -m` of a hello binary lists no modelcontextprotocol module).
Tracer smoke `modules/pier/tracer_smoke_test.go` `TestPierTracerSmoke` (-short; the test lives in package pier and builds a real surf router with `surf.BuildRouter` through a tiny in-test Host adapter or by running with `-tags summercms_mcp` — pick one and state it in the test comment; prefer the in-test adapter so the pier package tests need no tag): a fake plugin declares one tool `echo` → `POST /acme/echo/{id}` whose route carries a fake token guard middleware `acme.auth` (a bouncer guard registered by the fake plugin, with UnauthorizedWriter 401) and whose handler echoes `{id, body, principal}`; the test publishes a fake `pact.MCPTokenVerifier` (prefix `oas_at_`, token `oas_at_test` → user 7, scopes read+write, client `c1`) and a fake `pact.MCPGuard` named `acme` (TokenGuarded on `acme.auth`, Allows true, Dispatch returning `&bouncer.Principal{ID: 7}` and Guards `["acme"]`); with `mcp.enabled: true` the SDK client (`mcp.NewClient` + `StreamableClientTransport` with an `http.Client` whose RoundTripper adds the bearer) connects to `httptest.NewServer(handler)`, `ListTools` returns exactly `acme_echo` with `readOnlyHint false` and `destructiveHint false`, `CallTool` with `{"id": 5, "text": "hi"}` returns `isError false`, structuredContent `principal == 7`, `id == 5` and the body without `id`; a call with a bearer `oas_at_bad` is a 401 with the `WWW-Authenticate` header; the same tool declared twice fails `Mount` with an error containing `acme_echo`; a tool bound to `GET /nope` fails with an error containing `/nope`.
README (`modules/pier/README.md`) in the standard structure with `**Name:** The pier where outside boats dock to reach the beach; agents connect here to reach the application's plugins.` (final mnemonic) and the root README row reusing the summary sentence; keep the API reference to what exists after this task (Task 4 completes it).
</action>
<verify>
<automated>go vet ./... && go test -count=1 -short ./modules/pier/... ./modules/surf/... && go test -count=1 -short -run '^TestPierTracerSmoke$' -v ./modules/pier 2>&1 | grep -q -- '^--- PASS: TestPierTracerSmoke' && go build -tags summercms_mcp ./... && go -C examples/hello test -count=1 ./... && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS line for TestPierTracerSmoke is absent</fails_when>
</verify>
<acceptance_criteria>
- `test -f .planning/notes/2026-10-22-mcp-go-sdk.md && grep -c "v1.8.0" .planning/notes/2026-10-22-mcp-go-sdk.md` prints at least 1 and `grep -c "modelcontextprotocol/go-sdk" .planning/research/STACK.md` prints at least 1
- `grep -c "github.com/modelcontextprotocol/go-sdk v1.8.0" go.mod` prints 1 and `grep -c "github.com/google/jsonschema-go v0.4.3" go.mod` prints 1
- `grep -rl "modelcontextprotocol/go-sdk" modules --include=*.go | grep -v '^modules/pier/' | grep -v '^modules/surf/pier_on.go' | wc -l` prints 0
- `head -1 modules/surf/pier_on.go` prints `//go:build summercms_mcp` and `grep -c "mountPier = " modules/surf/pier_on.go` prints 1
- `grep -c "func Mount(" modules/pier/pier.go` prints 1; `grep -c "jsonschema.ForType" modules/pier/catalog.go` prints at least 1; `grep -c "httptest.NewRecorder" modules/pier/dispatch.go` prints at least 1; `grep -c "StreamableServerTransport" modules/pier/session.go` prints at least 1
- `grep -c "WithDispatch(" modules/pier/dispatch.go` prints at least 1 and `grep -rl "WithDispatch(" modules --include=*.go | grep -v _test.go | grep -v '^modules/bouncer/' | grep -v '^modules/pier/' | wc -l` prints 0
- `OUT=$(mktemp -d) && go -C examples/hello build -o "$OUT/hello-notag" . && test -x "$OUT/hello-notag" && go version -m "$OUT/hello-notag" > "$OUT/mods.txt" && ! grep -q modelcontextprotocol "$OUT/mods.txt"` exits 0 (the untagged hello binary must build and its module list must be readable before the absence of the SDK counts; a failed build or an absent binary fails the criterion instead of passing it)
- `grep -c "^\*\*Name:\*\*" modules/pier/README.md` prints 1 and `grep -c "\[pier\](modules/pier/README.md)" README.md` prints 1
- `go test -count=1 -short -run '^TestPierTracerSmoke$' -v ./modules/pier 2>&1 | grep -q -- '^--- PASS: TestPierTracerSmoke'`
</acceptance_criteria>
<done>An SDK client lists and calls one plugin-declared tool end-to-end through pier's stateful path, the call runs in-process through surf's compiled guard chain as the pre-resolved principal, the SDK is contained behind the tag, and the decision note, STACK row and README exist.</done>
</task>
<task type="auto">
<name>Task 3: Redis sessions with rehydration, DELETE and pub/sub fan-out; the stateless 2026-07-28 path; protected resource metadata, Origin protection and the periodic re-verification of long streams</name>
<files>modules/pier/store_redis.go, modules/pier/store.go, modules/pier/session.go, modules/pier/stateless.go, modules/pier/events.go, modules/pier/prm.go, modules/pier/pier.go, modules/pier/sessions_smoke_test.go, modules/pier/stateless_smoke_test.go, modules/pier/README.md</files>
<read_first>
- modules/pier/*.go as left by Task 2
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pattern 8", § "Pattern 9", § "Pitfall 2", § "Pitfall 10", § "State of the Art", § "Code Examples: Rehydrating a session" and "Targeted list_changed"
- go-sdk v1.8.0: mcp/streamable.go (StreamableHTTPHandler, StreamableHTTPOptions.Stateless, the 2026-07-28 acceptance rule, the deprecated CrossOriginProtection note), docs/protocol.md (server/discover, subscriptions/listen, protocol version header rules), mcp/server.go 740-770 (list_changed debounce), auth/auth.go (ProtectedResourceMetadataHandler), oauthex (ProtectedResourceMetadata)
- modules/cooler/cooler.go (OpenRedis, RedisURLKey, KeyPrefix) and the miniredis usage in modules/cooler/*_test.go
- modules/festival/bus.go (Listen, Fire)
- modules/surf/apidocs.go 140-146 (static JSON route headers)
</read_first>
<action>
Redis store (`store_redis.go`): `newRedisStore(client *redis.Client, prefix string)` with keys `<prefix>mcp:s:<id>` holding the JSON record (`SET ... PX ttl`), `Touch` = `PEXPIRE`, `Count(binding)` through a per-binding set `<prefix>mcp:b:<binding>` kept in step (SADD/SREM, expiry refreshed with the record), `Publish`/`Subscribe` on channel `<prefix>mcp:events` with JSON events `{kind, guard, user_id, session_id, instance}`; the client is opened lazily on first use with `cooler.OpenRedis(ctx, cfg.String(cooler.RedisURLKey))` when `mcp.sessions.store` is `redis` (a missing `redis.url` is a first-request 503 logged once, not a boot failure, mirroring cooler's never-fail-boot rule; `route:list` and tests never dial). Prefix from `cooler.KeyPrefix(cfg)`.
Rehydration and binding (`session.go`): as Task 2 specified, now against both stores; two routers on one miniredis in `TestPierSessionsSmoke`: initialise on A, call on B (B rehydrates from the stored `ServerSessionState` and serves `tools/call`), a second bearer with another binding presenting the same id gets 403 `session_binding`, DELETE on B ends the session and A's next call answers 404, an idle session whose TTL elapses (miniredis `FastForward`) answers 404, `max_per_binding` + 1 initialisations answer 429.
Fan-out (`events.go`): at Mount, `app.Events.Listen[*pact.MCPSubjectChanged]("summercms.pier", ...)` republishes each event through `Store.Publish`; every instance's subscriber handles: `ended` → close the local transport; `permissions`/`link` for a subject → for every local session and stateless server whose Identity includes that subject (guard+user id) recompute `allowed(...)` and apply the diff with `AddTool`/`RemoveTools` (and the prompt equivalents), which makes the SDK send `notifications/tools/list_changed` (and `prompts/list_changed`); `revoked`/`deleted` → close those sessions and evict the stateless servers, plus `Delete` their records. Also invalidate the P-07 link cache on `link`. `TestPierFanOutSmoke`: an SDK client with `ToolListChangedHandler` connected on instance B receives list_changed after `app.Events.Fire` of a permissions event on instance A whose fake guard now denies the tool; a revoked event ends the session (next call 404).
Long streams (Pitfall 10): the GET stream handler re-resolves the request's bearer every 60 s (the raw bearer stays only in that goroutine's memory for the stream's lifetime) and closes the stream when it fails; the serve BaseContext already cancels streams on shutdown.
Stateless path (`stateless.go`, D-32, P-08): `mcp.NewStreamableHTTPHandler(getServer, &mcp.StreamableHTTPOptions{Stateless: true})` where `getServer(r)` returns the per-identity server from an in-process LRU keyed by binding (capacity `max_per_binding * 16`, evicted on revocation), built from `allowed(...)` and mutated on fan-out events so `subscriptions/listen` clients receive list changes; the shared entry handler routes by `MCP-Protocol-Version: 2026-07-28` or a peeked first JSON-RPC method `server/discover` (bounded peek, body re-wrapped) to this handler, else to the stateful router; both run behind the same bearer resolution (every request authorized afresh). `TestPierStatelessSmoke`: the SDK client at its default (newest) protocol negotiates `2026-07-28` with no `Mcp-Session-Id` and calls the tool; a client pinned to `2025-11-25` gets a session; both see the same per-identity list.
PRM (`prm.go`, RFC 9728): `auth.ProtectedResourceMetadataHandler(&oauthex.ProtectedResourceMetadata{Resource: cfg.Resource, AuthorizationServers: []string{issuer}, ScopesSupported: [read write ai offline_access backend], BearerMethodsSupported: [header]})` mounted through `host.MountJSON` at `/.well-known/oauth-protected-resource` and `/.well-known/oauth-protected-resource<path>`; `issuer` = the verifier's `MCPResource()` origin when published, else `app.url`; a boot warning when `mcp.resource` differs from the verifier's `MCPResource()` (Pitfall 8). 401s carry `WWW-Authenticate: Bearer resource_metadata="<app.url>/.well-known/oauth-protected-resource<path>", scope="read"`.
Origin protection (V13): wrap the entry handler so a request with an `Origin` header outside `mcp.allowed_origins` (default: the origin of `app.url`) answers 403 before any body is read; requests without Origin pass (non-browser clients). Document the key.
README: complete Features (sessions, fan-out, hybrid protocol, PRM, Origin), Configuration (every `mcp.*` key with default), and the operational notes (memory store = single instance; Redis = shared sessions).
</action>
<verify>
<automated>go vet ./modules/pier/... && go test -count=1 -short ./modules/pier/... && go test -count=1 -short -run '^(TestPierSessionsSmoke|TestPierFanOutSmoke|TestPierStatelessSmoke)$' -v ./modules/pier 2>&1 | grep -c -- '^--- PASS: Test' | grep -qx 3 && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS count line is not exactly 3</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "PExpire\|PEXPIRE" modules/pier/store_redis.go` prints at least 1 and `grep -c "mcp:events" modules/pier/store_redis.go` prints at least 1
- `grep -c "Stateless: *true" modules/pier/stateless.go` prints 1 and `grep -c "server/discover" modules/pier/stateless.go` prints at least 1
- `grep -c "ProtectedResourceMetadataHandler" modules/pier/prm.go` prints 1 and `grep -c "oauth-protected-resource" modules/pier/prm.go` prints at least 2
- `grep -c "MCPSubjectChanged" modules/pier/events.go` prints at least 1 and `grep -c "RemoveTools" modules/pier/events.go modules/pier/session.go modules/pier/stateless.go | grep -v ':0' | wc -l` prints at least 1
- `grep -c "mcp.allowed_origins" modules/pier/README.md` prints at least 1 and `grep -c "mcp.sessions.store" modules/pier/README.md` prints at least 1
- The three smoke tests print `--- PASS` under `-short` using miniredis (no Docker, no real Redis)
</acceptance_criteria>
<done>Sessions live in Redis with rehydration, binding and DELETE semantics proven across two instances; subject events fan out to list_changed or session close; 2026-07-28 clients are served statelessly next to stateful 2025-11-25 clients; PRM and Origin protection are in place.</done>
</task>
<task type="auto">
<name>Task 4: Identity kinds, ceilings and prompts: personal tokens behind the flag, the backend scope and link, read/write ceiling, prompts/get, and the audit line; docs page and READMEs</name>
<files>modules/pier/identity.go, modules/pier/catalog.go, modules/pier/dispatch.go, modules/pier/audit.go, modules/pier/pier.go, modules/pier/tracer_smoke_test.go, modules/pier/README.md, modules/surf/README.md, docs/services/mcp.md, docs/site.yaml, docs/services/authentication.md, docs/plugins/registration.md</files>
<read_first>
- modules/pier/*.go as left by Task 3
- .planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md D-19, D-20, D-21, D-22, D-23, D-28, D-35 (the `ai` scope plays no part in the ceiling)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pitfall 7" (method-filtered g15_ scopes), § "Pitfall 9" (in-memory credentials), § "Anti-Patterns: Imperative or dynamic tool descriptions"
- modules/cabana/token_resolver.go (plan 01: ResolveBackendToken, ScopeLimitFor, BackendPrincipal)
- docs/services/caching.md and docs/services/realtime.md (the shape of a services page), docs/site.yaml (the services nav list), docs/services/authentication.md § "Accepting admin tokens on plugin routes", docs/plugins/registration.md § "Capability interfaces"
- cmd/summer/docs.go 25-80 (docs checker rules: identifiers, links, anchors, `src=` snippets, command names)
</read_first>
<action>
Identity (D-19): when `mcp.allow_personal_tokens` is false, any bearer that is not `oas_at_` is a 401 (no lookup). When true: `g15_` → `cabana.ResolveBackendToken` → backend subject only (frontend tools hidden); other prefixes → the published `pact.MCPPersonalTokenResolver` (frontend subject only; the resolver reports false for a prefix it does not own → 401). Personal-token identities carry the token's own scopes as the ceiling (D-19 "capped by that token's own scope exactly as over HTTP"): for `g15_` the ScopeLimit is computed per dispatched route method through `ScopeLimitFor` (Pitfall 7), for user tokens the guard provider's `MCPAllows` sees the token scopes in the subject.
Ceilings (D-20, D-21, D-22, D-35): the read/write ceiling uses only `read` and `write` (`ai` and `offline_access` are ignored); `write` present → all tools the guard allows; only `read` → tools with ReadOnlyHint true; a backend subject exists only with `backend` in the OAuth scopes and a link (Task 2) or with a `g15_` token; the backend principal is the admin's real cabana principal (superuser and grants from `BackendPrincipal`) so D-22 holds, and the D-20 ceiling applies on top in pier. Prompts (D-28): `prompts/list` filtered by Guard and Permissions exactly like tools; `prompts/get` runs `Render(ctx, args)` with required-argument validation and returns the messages; prompts never dispatch a route.
Descriptions: pier passes the plugin's static Title and Description through unchanged and refuses a Description longer than 1024 runes with a boot error; the content itself is not inspected. The docs page tells plugin authors to keep descriptions static and factual (RESEARCH anti-pattern).
Audit (D-23): finalize `audit.go`: the `pier: tool call` line carries `tool`, `guard`, `user_id` (frontend subject, 0 when none), `admin_id` (backend subject), `client_id`, `token_kind` (oauth|pat), `session` (8-char prefix or `stateless`), `status`, `duration_ms`; `pier: session` lines for open/rehydrate/end/binding-refused with the binding (never the token). Extend `TestPierTracerSmoke` (or add cases to it) for: a read-only grant hides a POST tool and lists a GET tool; a `write` grant lists both; `allow_personal_tokens` false → a `g15_` bearer is 401; true → a fake `g15_` resolver path (the cabana resolver needs a DB, so pier accepts an injected resolver func in tests through an unexported seam) yields a backend subject; a prompt declared by the fake plugin is listed as `acme_<name>` and `prompts/get` returns its messages; the audit line for a call contains `tool=acme_echo` and no argument text.
Docs (D-29 and the docs rule): `docs/services/mcp.md` with sections: What it is (one connector per person), Enabling it (`summer.yaml` `build.tags: [summercms_mcp]`, `mcp.enabled`, the `mcp.*` keys table with defaults), Declaring tools and prompts (`pact.HasMCP`, the tag mapping, naming and prefixing, guards `user` and `backend`, Permissions, annotations; a Go example block with `src=` pointing at `modules/pier/example_mcp_test.go`, a tested neutral `acme.blog` example added in this task), Identity and sessions (OAuth through the application's authorization server, `backend` scope and the account link, personal tokens behind the flag, binding, TTL, Redis vs memory, 2026-07-28 vs 2025-11-25), Protected resource metadata, Security notes (no token passthrough, marker, Origin), Operations (nginx needs to route the path and the well-known paths; audit log). Register the page in `docs/site.yaml` under services. Add the cross-links: `docs/services/authentication.md` (the dispatch marker paragraph from plan 01 gains the pier sentence), `docs/plugins/registration.md` (HasMCP row links to the page), surf README (the tagged hook and `pier_on.go`). Complete `modules/pier/README.md` API reference (Mount, Host, RouteInfo, Config, LoadConfig and every exported identifier) and Testing. `go run ./cmd/summer docs:sync` after adding the `src=` block.
</action>
<verify>
<automated>go vet ./... && go test -count=1 -short ./modules/pier/... && go test -count=1 -short -run '^TestPierTracerSmoke$' -v ./modules/pier 2>&1 | grep -q -- '^--- PASS: TestPierTracerSmoke' && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check && go -C examples/hello test -count=1 ./...</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS line for TestPierTracerSmoke is absent</fails_when>
</verify>
<acceptance_criteria>
- `test -f docs/services/mcp.md && grep -c "summercms_mcp" docs/services/mcp.md` prints at least 1 and `grep -c "mcp" docs/site.yaml` prints at least 1
- `grep -c "src=modules/pier/example_mcp_test.go" docs/services/mcp.md` prints at least 1 and `test -f modules/pier/example_mcp_test.go`
- `grep -c "allow_personal_tokens" modules/pier/identity.go` prints at least 1 and `grep -c "ScopeLimitFor" modules/pier/backend_guard.go modules/pier/identity.go | grep -v ':0' | wc -l` prints at least 1
- `grep -c "\"ai\"" modules/pier/catalog.go modules/pier/identity.go | grep -v ':0' | wc -l` prints 0 (the ceiling code never mentions the ai scope; prm.go's scopes_supported list is the only place it may appear)
- `grep -c "duration_ms" modules/pier/audit.go` prints at least 1
- `go run ./cmd/summer docs:build --check` prints no problems
- `grep -c "## API reference\|## Configuration\|## Testing\|## Dependencies" modules/pier/README.md` prints 4
</acceptance_criteria>
<done>Personal tokens work only behind the flag with their own ceilings, read/write and backend ceilings filter the list, prompts list and render, every call leaves one audit line without secrets, and the module and the services page are fully documented.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 5: Decide the framework release version and give the go-ahead to tag and push</name>
<decision>Tag and push the framework release that carries Phase 19.6.1 (Administrators and Roles screens; the commits carried are those `git log --oneline v0.4.3..HEAD` lists at tag time, pasted with their measured count into the checkpoint message) together with 19.7 plans 01 and 02 (the seams and the pier module), and post the changelog entry the same day.</decision>
<context>The tag is a one-way door: consumers pin it, the plugin releases of plans 03 and 04 require it, and `summercms.io/changelog` announces it. The planner proposes a minor bump (P-09): a new module `pier`, new `pact` capabilities (HasMCP, HasFrontendPermissions, HasAccountContributions, the record action Prompt), additive surf/bouncer/cabana/wristband/cooler API. Nothing is pushed before you answer. Pre-checks the executor runs before asking: clean `git status` for the framework paths, `go vet ./... && go test -count=1 ./...` (Docker suites included), `scripts/check-admin-dist.sh`, `scripts/check-admin-openapi.sh --check`, `go run ./cmd/summer docs:build --check`, `bash scripts/check-phase19.6.1.sh --all`, and `go build -tags summercms_mcp ./...`; then `git log --oneline v0.4.3..HEAD`, whose list and line count the executor pastes into the checkpoint message as the measured content of the tag (concurrent sessions add commits, so no count is assumed in advance).</context>
<options>
<option id="v050">
<name>Tag v0.5.0 now</name>
<pros>Minor bump signals the new module and capabilities; consumers see one coherent jump that includes 19.6.1</pros>
<cons>Any later 19.7 fix (plans 03-05) needs a v0.5.1</cons>
</option>
<option id="v044">
<name>Tag v0.4.4 now</name>
<pros>Keeps the 0.4 line; smallest version noise</pros>
<cons>Understates a new module and new published pact types</cons>
</option>
<option id="hold">
<name>Hold the tag</name>
<pros>Lets you review the diff first</pros>
<cons>Plans 03 and 04 cannot pin a framework version until the tag exists</cons>
</option>
</options>
<resume-signal>Answer v050, v044 or hold (with hold, say when to continue)</resume-signal>
</task>
<task type="auto">
<name>Task 6: Cut the framework release at the chosen version and publish the changelog post</name>
<reversibility rating="one-way">A pushed vX.Y.Z tag is pinned by consumer go.mod files and announced on summercms.io/changelog; retracting it needs a retract directive and a follow-up tag.</reversibility>
<precondition>The Task 5 checkpoint answered v050 or v044 (recorded in the executor's checkpoint log), the tree is clean for every framework path, and `~/.config/summercms/journal-token` exists (the changelog script reads it; if missing or refused, stop and ask the user rather than minting one)</precondition>
<files>.planning/notes/2026-10-22-mcp-go-sdk.md</files>
<read_first>
- CLAUDE.md § "Commits and concurrency" (tag message, changelog post flow, never print or mint the token)
- ../sm-summercmsio-app/DEPLOY.md § "Posting to the changelog"
- .planning/notes/2026-10-07-embedded-admin-release-gate.md
- `git log --oneline v0.4.3..HEAD` (the commits the tag carries: 19.6.1 plans 01-04, quick-261022-imo, 19.7 plans 01-02)
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-0{1,2,3,4}-SUMMARY.md (for the tag message's 19.6.1 highlights)
</read_first>
<action>
Run the pre-checks named in the checkpoint context once more on the exact HEAD to be tagged. Write an annotated tag message that lists, in this order: Phase 19.6.1 (Settings → System → Administrators and Roles, the cross-controller record action seam, field triggers and per-record permission locks, the two production fixes), Phase 19.7 plan 01 (dispatch marker, streaming routes and the Handler lookup, the pact MCP and account contribution contracts, the prompted record action, wristband's scope set), Phase 19.7 plan 02 (the `pier` module behind `summercms_mcp`, the `mcp.*` keys, the go-sdk decision note). `git tag -a <version> -m "<message>"` then `git push origin master --tags` (this push is the go-ahead the checkpoint gave; no other branch). Then from `../sm-summercmsio-app`: `scripts/changelog-post.py source <version>` to print the tag message and commits, write user-facing notes under `## Highlights`, `## Added`, `## Changed`, `## Fixed` (no planning IDs, no `quick-*` codes, no H1, framework and plugin names only, never a consuming application), save them to the scratchpad (`<your session scratchpad directory>/changelog-<version>.md`) and run `scripts/changelog-post.py publish <version> <that file> --excerpt "<one sentence>"`. Append a "Released in <version>" line to the Consequences section of the decision note (planning docs commit). Record the version in the SUMMARY so plans 03 and 04 pin it.
</action>
<verify>
<automated>TAG=$(git describe --tags --exact-match HEAD) && git ls-remote --exit-code --tags origin "refs/tags/$TAG" >/dev/null</automated>
<fails_when>non-zero exit: git describe fails because HEAD is not tagged, or git ls-remote exits 2 because origin has no such tag</fails_when>
<human-check>Open https://summercms.io/changelog and confirm the new version's post is live with the four sections.</human-check>
</verify>
<acceptance_criteria>
- `git describe --tags --exact-match HEAD` prints the version chosen at the checkpoint (v0.5.0 or v0.4.4)
- `git ls-remote --exit-code --tags origin "refs/tags/<version>" >/dev/null` exits 0 (origin has the tag; a failing ls-remote exits 2 instead of passing)
- `MSG=$(git log -1 --format=%B <version>) && printf '%s\n' "$MSG" | grep -q "19.6.1\|Administrators"` exits 0 (the tag message names the 19.6.1 content it carries; an unknown tag fails the criterion)
- `grep -c "Released in" .planning/notes/2026-10-22-mcp-go-sdk.md` prints 1
- The changelog publish command exited 0 and printed the post URL (recorded in the SUMMARY)
</acceptance_criteria>
<done>The framework release is tagged and pushed at the chosen version with 19.6.1 and 19.7 plans 01-02, and the changelog post is live.</done>
</task>
</tasks>
<artifacts_this_phase_produces>
## Artifacts this plan produces
**Go module `modules/pier`** (the only importer of go-sdk and jsonschema-go): `Mount`, `Host`, `RouteInfo`, `Config`, `LoadConfig`, `Identity`, `Store`, `Record`, `newMemoryStore`, `newRedisStore`, the catalog (`compileCatalog`, prefix rule), `dispatch`, the built-in `backend` guard provider, the session router, the stateless handler, `events`, `prm`, `audit`; `modules/pier/example_mcp_test.go` (the docs' `src=` example, `acme.blog`)
**surf**: `modules/surf/pier_on.go` (`//go:build summercms_mcp`), pseudo-plugin id `summercms.pier`
**Config keys**: `mcp.enabled`, `mcp.path`, `mcp.allow_personal_tokens`, `mcp.sessions.store`, `mcp.sessions.idle_ttl`, `mcp.sessions.max_per_binding`, `mcp.resource`, `mcp.throttle`, `mcp.allowed_origins`, `mcp.call_timeout`, `mcp.max_result_bytes` (reads `redis.url` through cooler when the store is redis)
**Routes**: `POST|GET|DELETE <mcp.path>` (stream kind), `GET /.well-known/oauth-protected-resource`, `GET /.well-known/oauth-protected-resource<mcp.path>`
**Redis keys/channels**: `<prefix>mcp:s:<id>`, `<prefix>mcp:b:<binding>`, channel `<prefix>mcp:events`
**Log lines**: `pier: tool call`, `pier: session` (component `pier`)
**Dependencies**: `github.com/modelcontextprotocol/go-sdk v1.8.0`, `github.com/google/jsonschema-go v0.4.3` (+ transitive per the decision note)
**Docs**: `.planning/notes/2026-10-22-mcp-go-sdk.md`, STACK.md rows, `modules/pier/README.md`, root README row, `docs/services/mcp.md`, `docs/site.yaml` entry
**Release**: framework tag (v0.5.0 proposed) carrying 19.6.1 + 19.7-01 + 19.7-02; changelog post
</artifacts_this_phase_produces>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| MCP client to `/mcp` | bearer tokens, session ids, JSON-RPC bodies and SSE streams from the internet |
| pier to plugin routes | in-process requests carrying a pre-resolved principal through the marker |
| pier to Redis | session records and fan-out events shared across instances |
| plugins to pier at boot | tool declarations (names, descriptions, routes, schemas) merged into the catalog |
| supply chain | two new Go modules and their transitive graph |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.7-10 | Spoofing | bearer verification | high | mitigate | Every request re-verifies the bearer through the published verifier or resolver (D-25); a session never replaces the bearer; a missing or failing verifier is a 401 with the PRM challenge (`TestPierTracerSmoke`) |
| T-19.7-11 | Spoofing | session hijack with a stolen Mcp-Session-Id | high | mitigate | Binding key (client_id+user_id or token id) compared on every request, 403 on mismatch; `rand.Text()` ids; records expire on the sliding TTL (`TestPierSessionsSmoke`) |
| T-19.7-12 | Elevation | token passthrough / confused deputy | high | mitigate | The inner request never carries Authorization or Cookie; identity travels only in the marker; the dispatcher strips both headers (asserted by the echo route in `TestPierTracerSmoke`) |
| T-19.7-13 | Elevation | scope escalation to backend tools | high | mitigate | A backend subject exists only with `backend` in the grant AND a verified link resolved per request, or a `g15_` token behind the flag; the D-20 ceiling applies on top; the list and the call use the same `allowed` function (Task 4 cases) |
| T-19.7-14 | Information Disclosure | tool-list leakage across principals | high | mitigate | One server per identity; receiving middleware re-filters list and call for the current request's identity; stateless servers keyed by binding (`TestPierStatelessSmoke`, `TestPierSessionsSmoke`) |
| T-19.7-15 | Elevation | Redis rehydration of a session whose link or grant was revoked | high | mitigate | Rehydration re-reads identity from the current bearer, not from the stored state; revoked/deleted events delete the record and close sessions on every instance; the link cache is at most 5 s (P-07) and invalidated by the link event (`TestPierFanOutSmoke`) |
| T-19.7-16 | Spoofing | audience confusion (OIDC or foreign token at /mcp) | medium | mitigate | Only `oas_at_` tokens reach the verifier (plan 04's verifier checks client kind mcp); PRM `resource` equals the verifier's resource with a boot warning on mismatch |
| T-19.7-17 | Tampering | argument injection into routes | medium | mitigate | Arguments validated against the reflected schema with additionalProperties false; single-segment path values may not contain `/`; the route's own Where constraints and body limit still run in the compiled chain; raw JSON forwarded only minus path/query keys |
| T-19.7-18 | Denial of Service | sessions, streams and large results | medium | mitigate | `mcp.throttle` inline limiter, `max_per_binding` (429), idle TTL, SDK body cap, `mcp.call_timeout`, `mcp.max_result_bytes` on the recorder, periodic re-verification closes stale streams |
| T-19.7-19 | Spoofing | DNS rebinding / browser Origin | medium | mitigate | `mcp.allowed_origins` check answers 403 before reading a body; default is the app's own origin |
| T-19.7-20 | Information Disclosure | audit log contents | medium | mitigate | The audit line carries ids, names, status and duration only; never tokens, arguments or bodies (asserted in `TestPierTracerSmoke`) |
| T-19.7-21 | Tampering | prompt injection through tool metadata | low | accept | Descriptions are plugin-authored static text passed through unchanged (length-capped); the docs page instructs authors to keep them factual; dynamic text is a plugin bug, not a framework surface |
| T-19.7-SC | Tampering | go get of go-sdk and jsonschema-go | high | mitigate | Blocking human legitimacy check (Task 1) before `go get`; versions pinned in go.mod; the decision note lists the transitive graph and the govulncheck result; the SDK is linked only in tagged binaries |
</threat_model>
<verification>
- `go vet ./... && go test -count=1 -short ./... && go build -tags summercms_mcp ./... && go -C examples/hello test -count=1 ./... && go test -count=1 -run '^TestDocsTree$' ./cmd/summer && go run ./cmd/summer docs:build --check && scripts/check-admin-openapi.sh --check`
- The pier smoke tests `TestPierTracerSmoke`, `TestPierSessionsSmoke`, `TestPierFanOutSmoke`, `TestPierStatelessSmoke` print `--- PASS` under `-short` (miniredis, no Docker)
- `go version -m` of a hello binary built without the tag lists no `modelcontextprotocol` module
- Docker host before the tag: `go test -count=1 ./...` and `bash scripts/check-phase19.6.1.sh --all`
- After Task 6: the tag exists locally and on origin; the changelog post is live
</verification>
<success_criteria>
- SC-1, SC-2 and SC-3 hold in the framework with a fake plugin; every must_have truth above is demonstrated by a named smoke test or by the release artifacts
- The SDK is imported only by `modules/pier` and `modules/surf/pier_on.go`; `pact` stays SDK-free; `examples/hello` is unaffected
- The decision note and STACK row predate the first import (commit order visible in `git log`)
- The tag and push happened only after the checkpoint answer; the SUMMARY records the version for plans 03 and 04
</success_criteria>
<output>
Create `.planning/phases/19.7-generic-mcp-module/19.7-02-SUMMARY.md` when done (planning docs in their own commit), recording the released version.
</output>

View File

@@ -0,0 +1,271 @@
---
phase: 19.7-generic-mcp-module
plan: 02
subsystem: mcp
tags: [pier, mcp, go-sdk, jsonschema-go, surf, bouncer, redis, sessions, stateless, prm, build-tag]
requires:
- phase: 19.7-01
provides: bouncer.WithDispatch marker, surf.Router.Handler + MountStream + mountPier hook, cabana.ResolveBackendToken / ScopeLimitFor / BackendPrincipal, SDK-free pact MCP contracts, pact.MCPSubjectChanged events, cooler.KeyPrefix, wristband ScopesSupported
provides:
- modules/pier, the only importer of go-sdk v1.8.0 and jsonschema-go v0.4.3, linked only into binaries built with -tags summercms_mcp
- modules/surf/pier_on.go (//go:build summercms_mcp) adapting the router to pier.Host
- catalog compiled at boot from pact.HasMCP (<shortcode>_<name> prefixing, route binding, guard resolution, schema reflection, annotations, boot failures by name)
- in-process tool dispatch through surf's compiled chain with the bouncer marker and no Authorization or Cookie header
- per-request identity (OAuth verifier, personal tokens behind mcp.allow_personal_tokens, backend scope and link), read/write ceiling, built-in backend guard provider
- stateful 2025-11-25 sessions over a memory or Redis store with rehydration, binding checks, DELETE and pub/sub fan-out; stateless 2026-07-28 path on the same mcp.path
- RFC 9728 protected resource metadata and WWW-Authenticate challenge; periodic re-verification of long GET streams
- prompts/get, audit lines (pier: tool call, pier: session)
- docs/services/mcp.md, modules/pier/README.md, root README row, decision note .planning/notes/2026-10-22-mcp-go-sdk.md and STACK.md rows
affects: [19.7-03 sm-user-plugin link and frontend permissions, 19.7-04 oauthserver verifier and Journal, 19.7-05 unit tests and security review, framework v0.4.4 (pier opt-in), framework v0.5.0 at phase completion]
actuals:
tokens: 51272
tasks: 4
commits: 29
plan_head_before: 3746675c726909b9280e78ea7f73985a1dcb48a5
plan_head_after: a26ee2b72d5b99db7596217ce1c3da7ec0c6bf89
tech-stack:
added:
- "github.com/modelcontextprotocol/go-sdk v1.8.0 (tagged builds only)"
- "github.com/google/jsonschema-go v0.4.3 (tagged builds only)"
patterns:
- "Build-tag containment: the SDK is reachable only through modules/pier and modules/surf/pier_on.go; an untagged binary lists no modelcontextprotocol module"
- "One SDK server per identity; a receiving middleware re-filters tools/list and tools/call for the current request's identity"
- "pier's own session router over StreamableServerTransport so sessions can be rehydrated from a shared Redis store"
- "Identity re-read from the bearer on every request; the stored session carries only the binding, never the token"
- "Store opened lazily from redis.url under cooler's prefix; nothing dials at mount"
key-files:
created:
- .planning/notes/2026-10-22-mcp-go-sdk.md
- modules/pier/README.md
- modules/pier/pier.go
- modules/pier/config.go
- modules/pier/host.go
- modules/pier/catalog.go
- modules/pier/dispatch.go
- modules/pier/filter.go
- modules/pier/identity.go
- modules/pier/guards.go
- modules/pier/backend_guard.go
- modules/pier/session.go
- modules/pier/stateless.go
- modules/pier/store.go
- modules/pier/store_memory.go
- modules/pier/store_redis.go
- modules/pier/events.go
- modules/pier/prm.go
- modules/pier/audit.go
- modules/pier/export_test.go
- modules/pier/example_mcp_test.go
- modules/pier/tracer_smoke_test.go
- modules/pier/identity_smoke_test.go
- modules/pier/sessions_smoke_test.go
- modules/pier/stateless_smoke_test.go
- modules/surf/pier_on.go
- docs/services/mcp.md
modified:
- go.mod
- go.sum
- .planning/research/STACK.md
- README.md
- modules/surf/README.md
- docs/site.yaml
- docs/services/authentication.md
- docs/plugins/registration.md
- .planning/phases/19.7-generic-mcp-module/deferred-items.md
key-decisions:
- "D-24: go-sdk v1.8.0 and jsonschema-go v0.4.3 chosen and approved by the user (Task 1 legitimacy check) before any go get; decision note and STACK rows committed first (3ea82a1)"
- "Stateful 2025-11-25 sessions are served by pier's own router over StreamableServerTransport (needed for Redis-shared sessions, D-25); 2026-07-28 clients go through the SDK's stateless handler; both share identity, dispatch and filtering (D-32)"
- "The mounted *pier.Pier is published on the application so tests reach it through export_test.go seams"
- "Release deferred: no tag in this plan. pier ships opt-in in framework v0.4.4 (build tag summercms_mcp plus mcp.enabled, default off), released by the orchestrator outside this plan; v0.5.0 is reserved for phase 19.7 completion (user decision 2026-10-23)"
patterns-established:
- "Tracer first: one fake-plugin tool listed and called end to end by an SDK client through the stateful path before Redis, stateless and identity expansion"
- "Docs example as a test: TestExampleBlogPlugin builds the acme.blog declaration that docs/services/mcp.md copies through src="
requirements-completed: [SC-1, SC-2, SC-3, SC-4, D-08, D-10, D-11, D-12, D-13, D-14, D-15, D-16, D-17, D-19, D-20, D-21, D-22, D-23, D-24, D-25, D-26, D-27, D-28, D-29, D-30, D-32, D-33, D-35, D-36]
coverage:
- id: D1
description: "Tracer: an SDK client lists and calls acme_echo end to end through surf's compiled guard chain with the dispatch marker; the inner request carries no Authorization or Cookie header; mcp.enabled off mounts nothing; untagged binaries carry no SDK"
requirement: "SC-1"
verification:
- kind: unit
ref: "modules/pier/tracer_smoke_test.go#TestPierTracerSmoke"
status: pass
- kind: other
ref: "go build -tags summercms_mcp ./..."
status: pass
human_judgment: false
- id: D2
description: "Catalog: <shortcode>_<name> prefixing, route binding, guard resolution, schema reflection, boot failures by name"
requirement: "SC-2"
verification:
- kind: unit
ref: "modules/pier/tracer_smoke_test.go#TestPierTracerSmoke"
status: pass
- kind: unit
ref: "modules/pier/example_mcp_test.go#TestExampleBlogPlugin"
status: pass
human_judgment: false
- id: D3
description: "Per-identity tools/list and tools/call filtering, read/write ceiling, personal tokens behind the flag, prompts/get, audit line without arguments or token"
requirement: "SC-3"
verification:
- kind: unit
ref: "modules/pier/identity_smoke_test.go (subtests of TestPierTracerSmoke: read-write ceiling and prompts, audit line, personal tokens behind the flag)"
status: pass
human_judgment: false
- id: D4
description: "Redis sessions: binding check (403), rehydration on another instance, DELETE ends the session everywhere"
requirement: "D-25"
verification:
- kind: unit
ref: "modules/pier/sessions_smoke_test.go#TestPierSessionsSmoke"
status: pass
human_judgment: false
- id: D5
description: "Subject-changed fan-out: list_changed on permission and link changes, session close on revocation and deletion, across instances"
requirement: "D-26"
verification:
- kind: unit
ref: "modules/pier/sessions_smoke_test.go#TestPierFanOutSmoke"
status: pass
human_judgment: false
- id: D6
description: "2026-07-28 clients served statelessly from the same path"
requirement: "D-32"
verification:
- kind: unit
ref: "modules/pier/stateless_smoke_test.go#TestPierStatelessSmoke"
status: pass
human_judgment: false
- id: D7
description: "Framework tag, push and changelog post (D-31)"
requirement: "D-31"
verification:
- kind: other
ref: "deferred by user decision 2026-10-23: v0.4.4 released by the orchestrator outside this plan; v0.5.0 at phase 19.7 completion"
status: deferred
human_judgment: true
rationale: "The user reserved v0.5.0 for full MCP usability; the release is not part of this plan's close"
duration: 38 min (tasks 1-4, 15:58Z-16:36Z; the release checkpoint wait is excluded)
completed: 2026-10-23
status: complete
---
# Phase 19.7 Plan 02: pier MCP module Summary
**The `pier` module serves an opt-in MCP endpoint on go-sdk v1.8.0 behind the `summercms_mcp` build tag. Plugin tools declared through `pact.HasMCP` are listed per identity and called in-process through surf's compiled route chains with the bouncer dispatch marker. Clients on protocol 2025-11-25 get stateful sessions over a memory or Redis store, with fan-out across instances; 2026-07-28 clients are served statelessly from the same path. The module also serves RFC 9728 resource metadata. No release was cut in this plan.**
## Performance
- **Duration:** 38 min of task work (2026-10-22T15:58:41Z to the Task 4 commit at 16:36Z), followed by the release checkpoint
- **Started:** 2026-10-22T15:58:41Z
- **Completed:** 2026-10-23 (closed without a release)
- **Tasks:** 4 executed, plus the release decision (Task 5, answered: no tag in this plan). Task 6 (the release) was deferred.
- **Files:** 36 touched by the plan's commits (3,285 + 1,133 + 589 insertions in the three code commits)
## Accomplishments
- **Task 1 (D-24):** the decision note `.planning/notes/2026-10-22-mcp-go-sdk.md` records the transitive graph, size, govulncheck result and build-tag containment. STACK.md gained a row for each module. The user approved both modules before `go get`.
- **Task 2 (tracer):** `modules/pier` contains the Host contract, the `mcp.*` config, the catalog compiled from `pact.HasMCP` and per-request identity through the published verifier and resolvers. It also has the built-in backend guard provider, in-process dispatch with `bouncer.WithDispatch`, a per-identity SDK server with a per-request re-filter, the stateful session router over a memory store and audit lines. `modules/surf/pier_on.go` sets the `mountPier` hook. `TestPierTracerSmoke` lists and calls `acme_echo` end to end.
- **Task 3:** `store_redis.go` stores records with PX TTLs, keeps per-binding sets and carries pub/sub events, under cooler's prefix and opened lazily. `events.go` republishes `pact.MCPSubjectChanged` through the store, so every instance sends list_changed or ends the subject's sessions. `stateless.go` serves 2026-07-28 clients. `prm.go` serves the metadata at both well-known paths, and long GET streams re-verify their bearer every minute. These are covered by `TestPierSessionsSmoke`, `TestPierFanOutSmoke` and `TestPierStatelessSmoke` on miniredis.
- **Task 4:** personal tokens are accepted only when `mcp.allow_personal_tokens` is on. An admin token gives a backend-only identity with its scope limit, and a user token gives a frontend-only one. The read/write ceiling, prompts and the audit line are asserted in the tracer's subtests. This task also added `docs/services/mcp.md` with the tested `acme.blog` example, the site.yaml entry and cross-links from the authentication, registration and surf pages.
- Verified again at close: `go test -count=1 -short ./modules/pier/` passes all five tests (`TestExampleBlogPlugin`, `TestPierSessionsSmoke`, `TestPierFanOutSmoke`, `TestPierStatelessSmoke`, `TestPierTracerSmoke`), and `go build -tags summercms_mcp ./...` succeeds.
## Task Commits
1. **Task 1: Decide the MCP Go SDK** - `3ea82a1` (docs)
2. **Task 2: pier tracer** - `cfdbaf0` (feat)
3. **Task 3: Redis sessions, events, stateless path, PRM** - `806e87c` (feat)
4. **Task 4: Identity kinds, ceilings, prompts, MCP services page, READMEs** - `8c6c0a3` (feat), plus `1aff96f` (docs: deferred items)
5. **Task 5: Release decision** - answered by the user, no commit (see below)
6. **Task 6: Release** - deferred, no commit
**Commit count note:** `commits: 29` is measured as `git rev-list --count 3746675..a26ee2b`. That range also contains 24 commits from concurrent sessions (msd-quick tasks 261022-k9k, -tb4, -tto, -usi, -vfz, -wah, -x7a and their planning docs). This plan's own commits are the five listed above.
## Release (Tasks 5 and 6): deferred
The user's final answer to Task 5 replaces the earlier v0.5.0 answer: **no tag in this plan.**
- The pier code ships **opt-in in framework v0.4.4**. To use it, an application is built with `-tags summercms_mcp` and sets `mcp.enabled: true` (the default is off). Without the tag the binary carries no go-sdk. The orchestrator handles v0.4.4 outside this plan, after the plan closes.
- **v0.5.0 is reserved for phase 19.7 completion** (plans 01-05 and phase verification, i.e. full MCP usability).
- This plan did not tag, push, post a changelog or edit the decision note's "Released in" line. The plan's D-31 truth and the Task 6 acceptance criteria (tag on origin, changelog URL) are therefore not met here. The release is tracked by the 19.7 decisions in STATE.md.
- The Docker-host gate from the plan's verification (`go test -count=1 ./...` and `bash scripts/check-phase19.6.1.sh --all` before the tag) has to run before the v0.4.4 tag. It was not run in this close.
## Deviations from Plan
### Auto-fixed Issues
**1. [Rule 3 - Blocking] The tracer client is pinned to protocol 2025-11-25**
- **Found during:** Task 2
- **Issue:** an SDK client left at its default negotiates the newest protocol, which pier sends to the stateless path. The tracer has to exercise the stateful path with sessions.
- **Fix:** `client.Connect(..., &mcp.ClientSessionOptions{ProtocolVersion: "2025-11-25"})` in `TestPierTracerSmoke`, and `connectPinned` for the identity subtests
- **Files modified:** modules/pier/tracer_smoke_test.go, modules/pier/identity_smoke_test.go
- **Committed in:** cfdbaf0, 8c6c0a3
**2. [Rule 1 - Bug] SDK client sessions are closed by defer before the test server closes**
- **Found during:** Task 2
- **Issue:** if `httptest.Server.Close` runs while an SDK session's GET stream is still open, it blocks waiting on the hanging connection
- **Fix:** `defer cs.Close()` is registered after `defer srv.Close()`, so the session closes first (LIFO)
- **Files modified:** modules/pier/tracer_smoke_test.go
- **Committed in:** cfdbaf0
**3. [Rule 3 - Blocking] `TestExampleBlogPlugin` calls `blogTools()`**
- **Found during:** Task 4
- **Issue:** the docs example has to be a compiled, tested declaration that `docs/services/mcp.md` can copy through `src=`
- **Fix:** the declaration lives in `blogTools()`. The example plugin's `MCP()` returns it, and the test calls it directly to assert 3 tools and 1 prompt before mounting the plugin.
- **Files modified:** modules/pier/example_mcp_test.go
- **Committed in:** 8c6c0a3
**4. [Rule 3 - Blocking] `*pier.Pier` is published on the app as a test seam**
- **Found during:** Task 4
- **Issue:** the identity subtests need to inject a personal-token resolver and reach the mounted instance. The cabana resolver needs a database, which is not available under `-short`.
- **Fix:** `Mount` publishes the `*pier.Pier` on the application, and `export_test.go` exposes the unexported seams to tests only
- **Files modified:** modules/pier/pier.go, modules/pier/export_test.go
- **Committed in:** 8c6c0a3
---
**Total deviations:** 4 auto-fixed (1 bug, 3 blocking). The release (Task 6) was deferred by the user's decision.
**Impact on plan:** the code scope is unchanged. The release moved out of the plan.
## Issues Encountered
None beyond the deviations and the deferred items below.
## Follow-ups (from deferred-items.md)
- **open:** stateful pier sessions cannot carry the SDK's protocol-version context value. go-sdk v1.8.0 keeps it under an unexported key, so stateful streams run with the 2025-03-26 defaults for close/reconnect hints and JSON-RPC batching. Revisit if the SDK exports the key. Plan 05 may pin the behaviour in a test.
- **open:** `notifications/initialized` can land on a different instance than `initialize`. The first instance's local copy then refuses calls until it is dropped. Sticky sessions or a per-request re-read of the stored `initialized` flag would fix this. It does not affect a single-instance deployment.
- **open (from 19.7-01):** pre-existing `gofmt` drift in six cabana files. The fix is a separate `style(cabana)` commit.
- Before any framework tag: run `bash scripts/check-phase19.6.1.sh --all` and the full Docker `go test -count=1 ./...` on the Docker host.
## Known Stubs
None. The release is deferred by decision; it is not a stub.
## User Setup Required
None for this plan. Applications that want MCP build with `-tags summercms_mcp` and set `mcp.enabled: true` (see `docs/services/mcp.md`).
## Next Phase Readiness
- **Plan 03 (sm-user-plugin):** publish `pact.MCPLinkedBackendResolver` and `pact.MCPPersonalTokenResolver`, frontend permissions, and the link and unlink record actions. pier picks them up through `app.Lookup`.
- **Plan 04 (oauthserver):** publish `pact.MCPTokenVerifier` and add `backend` to `ScopesSupported`. The PRM `resource` must match the verifier's resource.
- **Plan 05:** unit tests and security review, including the two open pier items above and the subject-event listener assertions carried over from 01.
- **Framework version for plans 03 and 04:** v0.4.4 (pier opt-in), once the orchestrator tags it. v0.5.0 follows at phase completion.
---
*Phase: 19.7-generic-mcp-module*
*Completed: 2026-10-23*
## Self-Check: PASSED
All key created files exist on disk (pier sources, surf/pier_on.go, docs/services/mcp.md, the pier README, the decision note) and the five plan commits (3ea82a1, cfdbaf0, 806e87c, 8c6c0a3, 1aff96f) are in history. `go test -count=1 -short ./modules/pier/` and `go build -tags summercms_mcp ./...` pass at a26ee2b.

View File

@@ -0,0 +1,389 @@
---
phase: 19.7-generic-mcp-module
plan: 03
type: execute
wave: 3
depends_on: ["19.7-02"]
files_modified:
- ../sm-demo-app/plugins/golem15/user/updates/202610220001_create_backend_links.go
- ../sm-demo-app/plugins/golem15/user/models/backend_link.go
- ../sm-demo-app/plugins/golem15/user/models/backend_link_request.go
- ../sm-demo-app/plugins/golem15/user/classes/backend_links.go
- ../sm-demo-app/plugins/golem15/user/classes/events.go
- ../sm-demo-app/plugins/golem15/user/classes/subject_events.go
- ../sm-demo-app/plugins/golem15/user/classes/frontend_permission_catalog.go
- ../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go
- ../sm-demo-app/plugins/golem15/user/classes/privileged.go
- ../sm-demo-app/plugins/golem15/user/controllers/backend_link_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/token_me.go
- ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/usergroups_admin_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/api_tokens.go
- ../sm-demo-app/plugins/golem15/user/account_contributions.go
- ../sm-demo-app/plugins/golem15/user/backend_links_admin.go
- ../sm-demo-app/plugins/golem15/user/mcp.go
- ../sm-demo-app/plugins/golem15/user/admin_permissions.go
- ../sm-demo-app/plugins/golem15/user/plugin.go
- ../sm-demo-app/plugins/golem15/user/routes.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/lang/en/lang.yaml
- ../sm-demo-app/plugins/golem15/user/lang/pl/lang.yaml
- ../sm-demo-app/plugins/golem15/user/README.md
- ../sm-demo-app/plugins/golem15/user/go.mod
- ../sm-demo-app/plugins/golem15/user/go.sum
- ../sm-demo-app/plugins/golem15/user/backend_link_smoke_test.go
- ../sm-demo-app/plugins/golem15/user/backend_link_admin_smoke_test.go
- ../sm-demo-app/plugins/golem15/user/mcp_guard_smoke_test.go
- ../sm-demo-app/plugins/golem15/user/frontend_permission_catalog_smoke_test.go
- ../sm-demo-app/go.mod
- ../sm-demo-app/go.sum
- ../sm-demo-app/plugins/golem15/user
- ../fonoteka.go/go.mod
- ../fonoteka.go/go.sum
- ../fonoteka.go/plugins/golem15/user
- ../sm-bm-app/go.mod
- ../sm-bm-app/go.sum
- ../sm-bm-app/plugins/golem15/user
- ../sm-grzybyfunkcjonalne-app/go.mod
- ../sm-grzybyfunkcjonalne-app/go.sum
- ../sm-grzybyfunkcjonalne-app/plugins/golem15/user
- ../sm-summercmsio-app/go.mod
- ../sm-summercmsio-app/go.sum
- ../sm-summercmsio-app/plugins/golem15/user
autonomous: false
requirements: [SC-3, SC-4, D-01, D-03, D-04, D-05, D-06, D-07, D-08, D-09, D-15, D-16, D-17, D-18, D-23, D-26, D-31, D-34, D-35, D-36]
estimate:
tokens: 80000
raw_tokens: 80000
tasks: 5
confidence: low
must_haves:
truths:
- "A backend admin starts 'Link frontend account' on My account, is sent to the site with a one-shot code, signs in fresh as a frontend user, and only then is the 1:1 link saved; a replayed, expired or stale-session confirm is refused and no link is written by email match or by picking from a list (D-03, D-05, D-06, D-07 self-service path, D-04 part 1)"
- "An admin holding golem15.users.manage_backend_links sets a link for another administrator on the Administrators screen through a prompted record action (the frontend user's email) and removes one through a Danger action; the set records linked_by and fires an event (D-07, D-34, D-35)"
- "pier resolves the linked admin through the published pact.MCPLinkedBackendResolver on every request; unlinking, deleting or deactivating either account removes the backend subject on the next call and fires pact.MCPSubjectChanged (D-08, D-26)"
- "A plugin's frontend permission codes appear in the user and group permission editors next to the seeded rows, and a seeded row wins on a duplicate code; existing rows, tables and payloads are unchanged (D-09)"
- "The user guard provider answers tools/list with the same group-grant check user.permission enforces, requires every user.scope of the route, and hands pier an in-memory token credential so user.scope sees the grant's scopes (D-15, D-16, D-17, D-23, D-35)"
- "The user_me tool (GET /_user/api/v1/token/me behind user.api_token and user.scope:read) returns the signed-in user's payload through MCP, proving the user guard end to end (D-18)"
- "The plugin is released only after the framework tag from plan 02, as an additive release; every application that mounts it is bumped in one commit per app and still builds and passes (D-01, D-31)"
artifacts:
- path: "../sm-demo-app/plugins/golem15/user/updates/202610220001_create_backend_links.go"
provides: "golem15_user_backend_links and golem15_user_backend_link_requests"
contains: "golem15_user_backend_links"
- path: "../sm-demo-app/plugins/golem15/user/classes/backend_links.go"
provides: "BackendLinks service: CreateLinkRequest, ConfirmLinkRequest, SetLink, RemoveLink, LinkedBackendUser"
contains: "func (s *BackendLinks) LinkedBackendUser("
- path: "../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go"
provides: "MCPUserGuard implementing pact.MCPGuard and pact.MCPPersonalTokenResolver"
contains: "func (g *MCPUserGuard) MCPGuardName() string"
- path: "../sm-demo-app/plugins/golem15/user/backend_links_admin.go"
provides: "AdminActionExtensions on cabana.AdministratorsControllerID: link_frontend_account (prompted) and unlink_frontend_account"
contains: "link_frontend_account"
- path: "../sm-demo-app/plugins/golem15/user/account_contributions.go"
provides: "the My account section frontend_account with link and unlink"
contains: "frontend_account"
- path: "../sm-demo-app/plugins/golem15/user/mcp.go"
provides: "HasMCP: the me tool"
contains: "token/me"
- path: "../sm-demo-app/plugins/golem15/user/classes/frontend_permission_catalog.go"
provides: "FrontendPermissionCatalog merging pact.HasFrontendPermissions into the editors"
contains: "HasFrontendPermissions"
key_links:
- from: "../sm-demo-app/plugins/golem15/user/plugin.go"
to: "../sm-demo-app/plugins/golem15/user/classes/backend_links.go"
via: "Boot publishes *classes.BackendLinks and the same value as pact.MCPLinkedBackendResolver"
pattern: "MCPLinkedBackendResolver"
- from: "../sm-demo-app/plugins/golem15/user/plugin.go"
to: "../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go"
via: "Boot registers the guard in the *pact.MCPGuards registry (find-or-publish) and publishes it as pact.MCPPersonalTokenResolver"
pattern: "MCPGuards"
- from: "../sm-demo-app/plugins/golem15/user/controllers/backend_link_controller.go"
to: "../sm-demo-app/plugins/golem15/user/classes/backend_links.go"
via: "the confirm route checks the JWT iat against the request's created_at and calls ConfirmLinkRequest"
pattern: "ConfirmLinkRequest"
- from: "../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go"
to: "../sm-demo-app/plugins/golem15/user/classes/frontend_permission_catalog.go"
via: "AdminPermissionOptions returns FrontendPermissionCatalog instead of the seeded rows alone"
pattern: "FrontendPermissionCatalog"
---
<!-- planner-discipline-allow: MergedPermissions -->
<objective>
Deliver the sm-user-plugin side of the identity chain, additively, in the plugin's master checkout at `../sm-demo-app/plugins/golem15/user` (v0.1.8, commit 930b158): the verified frontend-to-backend account link with its tables, proof round-trip, service and events (D-03, D-05, D-06, D-07, D-08), the My account contribution and the Administrators-screen actions through plan 01's seams (D-04, D-34), plugin-registered frontend permission codes in the editors (D-09), the `user` MCP guard provider and personal-token resolver (D-15, D-16, D-17, D-23, D-35), the first frontend tool `user_me` (D-18), the permission code `golem15.users.manage_backend_links` (D-35), then the plugin release pinned to the plan-02 framework tag and the pointer bumps in every application that mounts it (D-01, D-31).
**Planner decisions recorded here:**
- **P-10 (tables and TTL, Claude's discretion):** `golem15_user_backend_links` (`id`, `user_id` UNIQUE → `users.id` ON DELETE CASCADE, `backend_user_id` UNIQUE → `backend_users.id` ON DELETE CASCADE, `linked_by` nullable → `backend_users.id` ON DELETE SET NULL, `created_at`) and `golem15_user_backend_link_requests` (`id`, `code_hash` CHAR(64) UNIQUE, `backend_user_id` → `backend_users.id` ON DELETE CASCADE, `expires_at`, `used_at` nullable, `created_at`). The code is 32 random bytes hex (64 chars) stored as SHA-256 hex, valid `golem15.user.backend_links.request_ttl` (default `10m`), one-shot, bound to the admin who created it.
- **P-11 (fresh sign-in, D-05):** the confirm route is behind `jwt.auth` and additionally re-reads the bearer with `bouncer.VerifyClaims` to compare the JWT `iat` with the request's `created_at`; an older session answers 409 `stale_session`, so a browser that was already signed in must sign in again (password, social login and the 2FA gate all pass through the normal login).
- **P-12 (admin set, D-07/D-34):** `link_frontend_account` is a prompted record action whose value is the frontend user's email, matched exactly and case-insensitively against active users; no search, no list. It is a privileged action behind `golem15.users.manage_backend_links` (no default role), records `linked_by` and fires events. The self-service My account path never skips the D-05 proof.
- **P-13 (site URL):** the link page URL is `golem15.user.frontend_url` + `/link-admin?code=<plain>`; the key is new here with an empty default that falls back to `app.url`. Phase 19.6 (not executed) plans the same key for its own site links; whichever lands first adds it and the other reuses it.
- **P-14 (frontend permission semantics, D-35, Pitfall 3):** `MCPAllows` uses `classes.PrincipalByID` (group grants) and `cabana.Allows` per code with AND across codes, exactly what `user.permission` middleware enforces; `MergedPermissions` is not used.
- **P-15 (plugin version):** additive release, proposed `v0.1.9`; the user decides at the checkpoint.
Sequencing: Phase 19.6 (2FA and device flow) edits this plugin in another checkout (`../fonoteka.go/plugins/golem15/user`, at v0.1.6) and is not executed. This plan does not depend on 19.6 and touches `admin_permissions.go`, `plugin.go`, `routes.go`, `controllers/users_admin_controller.go`, `config/config.yaml`, `lang/*` and `README.md`, which 19.6 also lists: append to the existing lists and blocks (never reorder them) so either phase rebases cleanly on the other, and run `git -C ../sm-demo-app/plugins/golem15/user status --short` before every task.
Purpose: SC-4's identity chain exists on the plugin side; plan 04 can show the consent line and run Journal tools as the linked admin; the demo can prove both guards.
Output: migrations, models, service, routes, controllers, the three seam implementations, the guard provider, the tool, permission code and copy, smoke tests on Postgres, README, the tagged plugin release and five application pointer bumps.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/PROJECT.md
@.planning/ROADMAP.md
@.planning/STATE.md
@.planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md
@.planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md
@.planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md
@.planning/phases/19.7-generic-mcp-module/19.7-01-SUMMARY.md
@.planning/phases/19.7-generic-mcp-module/19.7-02-SUMMARY.md
@.planning/notes/core-plugins-own-repos.md
@CLAUDE.md
</context>
<project_rules>
- Core-plugin rule: additive only. No existing route, payload field, table, column, seeded row, permission code, exported identifier or `admin:*` command changes; new routes are appended to the existing `/_user/api/v1` group.
- The plugin repo is the submodule checkout `../sm-demo-app/plugins/golem15/user` on branch `master`. Commit there first; the pointer bump in each app is a separate commit in that app. Push and tag only in Task 5 after the go-ahead.
- Run the plugin's Go commands with `GOWORK=off go -C ../sm-demo-app/plugins/golem15/user ...` (its own go.mod replaces the framework with `../../../../summercms.go`; the parent app's go.work does not list it). Postgres tests need Docker and skip under `-short`.
- Framework neutrality is the framework's rule, not the plugin's; the plugin may name cabana, bouncer, pact and its own tables freely but must not name a consuming application.
- Stage by explicit path; one logical change per commit; no co-author tags; planning docs (in the framework repo) in their own commit.
</project_rules>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: the verified link end to end — My account starts a link request, the frontend user confirms it with a fresh sign-in, and the published resolver answers the linked admin</name>
<reversibility rating="costly">The two tables and the published service become part of a core plugin's contract consumed by apps and pier (D-03); the one-way proof rule of D-05 was decided by the user in CONTEXT and this task implements it, so no gate re-asks it.</reversibility>
<files>../sm-demo-app/plugins/golem15/user/updates/202610220001_create_backend_links.go, ../sm-demo-app/plugins/golem15/user/models/backend_link.go, ../sm-demo-app/plugins/golem15/user/models/backend_link_request.go, ../sm-demo-app/plugins/golem15/user/classes/backend_links.go, ../sm-demo-app/plugins/golem15/user/classes/events.go, ../sm-demo-app/plugins/golem15/user/classes/subject_events.go, ../sm-demo-app/plugins/golem15/user/controllers/backend_link_controller.go, ../sm-demo-app/plugins/golem15/user/account_contributions.go, ../sm-demo-app/plugins/golem15/user/routes.go, ../sm-demo-app/plugins/golem15/user/plugin.go, ../sm-demo-app/plugins/golem15/user/config/config.yaml, ../sm-demo-app/plugins/golem15/user/lang/en/lang.yaml, ../sm-demo-app/plugins/golem15/user/lang/pl/lang.yaml, ../sm-demo-app/plugins/golem15/user/backend_link_smoke_test.go</files>
<read_first>
- ../sm-demo-app/plugins/golem15/user/updates/202610040001_create_api_tokens.go and updates/registry.go (raw SQL migration, Register)
- ../sm-demo-app/plugins/golem15/user/models/api_token.go (model shape, TableName, Fillable, Hidden, Register) and models/registry.go
- ../sm-demo-app/plugins/golem15/user/classes/codes.go 40-75 (newCode), classes/api_tokens.go (HashAPIToken usage: grep `HashAPIToken` in middleware/api_token.go), classes/events.go (event struct style), classes/session_user.go (RequestUser), classes/user_lookup.go
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go 150-180 (Fetch), 860-930 (authenticate, apiArray), 1160-1230 (writeJSON, writeOpaque500) and controllers/api_tokens.go (JWT-guarded controller shape, reading the principal from bouncer.User)
- ../sm-demo-app/plugins/golem15/user/plugin.go 60-120 (Boot: find-or-publish registry pattern, Publish) and routes.go
- ../sm-demo-app/plugins/golem15/user/admin_harness_test.go (adminHarnessDB, newAdminEnv, login helpers) and account_test.go (how an account route is exercised)
- summercms.go: modules/pact/capabilities.go (HasAccountContributions, AccountContribution, AccountAction, AccountActionResult as shipped by plan 01), modules/pact/mcp.go (MCPLinkedBackendResolver, LinkedBackendUser, MCPSubjectChanged and constants), modules/bouncer/jwt.go 190-215 (VerifyClaims returns iat), modules/cabana/contracts.go 53-75 (BackendUser fields: Login, FirstName, LastName, IsActivated, DeletedAt)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pattern 7" and the Security Domain rows "Link without proof" and "Admin sets a link"
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "USER/updates", § "USER/models/backend_link.go", § "USER/classes/backend_links.go", § "USER/routes.go and USER/controllers/*"
</read_first>
<action>
Migration `202610220001_create_backend_links` (ID `202610220001_create_golem15_user_backend_links`): the two tables of P-10 with their indexes and FKs, raw SQL, Rollback drops both; `init() { Register(...) }`. Models `models.BackendLink{ID, UserID, BackendUserID, LinkedBy *uint, CreatedAt}` and `models.BackendLinkRequest{ID, CodeHash, BackendUserID, ExpiresAt, UsedAt *time.Time, CreatedAt}` with TableName, Fillable, Hidden (`code_hash`), `IsUsableAt(now)` on the request; register both.
Service `classes.BackendLinks{App *backpack.App}` (published in Boot as `*classes.BackendLinks` and as `pact.MCPLinkedBackendResolver`): `CreateLinkRequest(ctx, backendUserID uint) (plainCode string, expiresAt time.Time, error)` (newCode → store sha256 hex, TTL from `golem15.user.backend_links.request_ttl` default 10m); `LinkRequestByCode(ctx, plain) (*models.BackendLinkRequest, *cabana.BackendUser, error)` for the public show (usable only); `ConfirmLinkRequest(ctx, plain string, frontendUserID uint, sessionIssuedAt time.Time) (*models.BackendLink, error)` in one transaction: `SELECT ... FOR UPDATE` by code_hash, refuse used (`ErrLinkRequestUsed`), expired (`ErrLinkRequestExpired`), `sessionIssuedAt.Before(req.CreatedAt)` (`ErrStaleSession`), an existing link on either side (`ErrAlreadyLinked`), the admin missing or not activated (`ErrBackendUserUnavailable`); insert the link with `LinkedBy` nil, set `used_at`, fire `BackendLinkedEvent{Link, Tx}` and the two `pact.MCPSubjectChanged` events (user side `{Guard:"user", UserID, Kind: pact.MCPSubjectLink}`, backend side `{Guard:"backend", UserID: backendUserID, Kind: link}`); `SetLink(ctx, tx, frontendUserID, backendUserID, linkedBy uint)` (admin path, same uniqueness rules, records linked_by, same events; used by Task 3); `RemoveLink(ctx, tx, link)` (fires `BackendUnlinkedEvent` and both subject events); `LinkFor(ctx, backendUserID)` and `LinkOf(ctx, frontendUserID)`; `LinkedBackendUser(ctx, frontendUserID) (pact.LinkedBackendUser, bool, error)` = one indexed query joining `backend_users` for `Login` and the display name (first+last name, else login), false when the admin is deactivated or soft-deleted. Listen to `DeletingEvent` and `DeactivatingEvent` (user side): remove the link inside the tx and fire `MCPSubjectChanged{user, id, deleted}` and the backend `link` event. `classes/subject_events.go`: `FireSubjectChanged(ctx, app, guard string, userID uint, kind string)` through `app.Events` when present (log, never fail the save).
Routes appended to the `/_user/api/v1` group: `g.Get("/backend-link/{code}", controllers.BackendLinkShow(p.app))` with `g.Where("code", "[a-f0-9]{64}")` and `g.Post("/backend-link/confirm", controllers.BackendLinkConfirm(p.app), "jwt.auth")`. `BackendLinkShow`: 404 `{"error":"not_found"}` unless usable; 200 `{"data":{"admin":{"login":...,"name":...},"expires_at":<RFC3339>}}` (nothing else about the admin). `BackendLinkConfirm`: body `{"code": ...}`; principal from `bouncer.User`; the bearer re-read with `usermiddleware.BearerToken(r)` and `bouncer.VerifyClaims(raw, secret)` for `iat` (secret from `classes.JWTSecret(app)`); maps `ErrStaleSession` → 409 `{"error":"stale_session"}`, `ErrAlreadyLinked` → 409 `{"error":"already_linked"}`, used/expired/unknown → 404 `{"error":"not_found"}`, success → 200 `{"data":{"backend_user":{"login","name"}}}`; all through the plugin's `writeJSON`.
My account contribution (D-04 part 1, P-02 seam) in `account_contributions.go`: `(*Plugin) AccountContributions()` returns one `pact.AccountContribution{Name: "frontend_account", Label: "golem15.user::lang.backend_link.section", Description: "...section_comment", Status: linked → "golem15.user::lang.backend_link.status_linked" with the email interpolated through the plugin's translator helper (or the literal "Linked to <email>" if interpolation through a phrase key is not available in Status), else "...status_unlinked"; Actions: `link` (Label `...link`, Applies: no link, Run: CreateLinkRequest for `in.AdminID` and answer `Message: "...link_started"`, `URL: frontendURL(app) + "/link-admin?code=" + plain`) and `unlink` (Label `...unlink`, Confirm `...unlink_confirm`, Danger true, Applies: linked, Run: RemoveLink in the tx from `cabana.TxFromContext`)}`. `frontendURL(app)` reads `golem15.user.frontend_url`, falling back to `app.url`, trimming a trailing slash (P-13). Config keys with comments in `config/config.yaml`: `frontend_url: ""`, `backend_links: { request_ttl: 10m }`. Lang keys en + pl under `backend_link:` (section, section_comment, status_linked, status_unlinked, link, link_started, unlink, unlink_confirm, unlinked, prompt_email, prompt_comment, set, set_confirm, set_success, remove, remove_confirm, remove_success, unknown_user, already_linked).
Smoke `backend_link_smoke_test.go` `TestBackendLinkSmoke` (Postgres through `newAdminEnv`, skipped under -short): seed a frontend user and an admin; as the admin, `GET /account/contributions` lists `frontend_account` with status unlinked and action `link`; `POST /account/contributions/frontend_account/actions/link` answers a URL containing `/link-admin?code=` and a 64-hex code; `GET /_user/api/v1/backend-link/{code}` shows the admin's login and an `expires_at`; a frontend JWT minted before the request (iat earlier) → confirm answers 409 `stale_session`; a JWT minted after → 200, `LinkedBackendUser(uid)` returns the admin's id and login; the same code again → 404; a second request confirmed by another frontend user for the same admin → 409 `already_linked`; after `unlink` the resolver answers false and `GET /account/contributions` shows `link` again; deleting the frontend user (the plugin's delete path) removes the link row.
</action>
<verify>
<automated>GOWORK=off go -C ../sm-demo-app/plugins/golem15/user vet ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -short ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -run '^TestBackendLinkSmoke$' -v . 2>&1 | grep -q -- '^--- PASS: TestBackendLinkSmoke'</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS line is absent (a SKIP line because Docker is unreachable also counts as absent: run on a Docker host)</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "golem15_user_backend_links\|golem15_user_backend_link_requests" ../sm-demo-app/plugins/golem15/user/updates/202610220001_create_backend_links.go` prints at least 4 and `grep -c "ON DELETE CASCADE" ../sm-demo-app/plugins/golem15/user/updates/202610220001_create_backend_links.go` prints at least 3
- `grep -c "func (s \*BackendLinks) \(CreateLinkRequest\|ConfirmLinkRequest\|SetLink\|RemoveLink\|LinkedBackendUser\)(" ../sm-demo-app/plugins/golem15/user/classes/backend_links.go` prints 5
- `grep -c "FOR UPDATE\|clause.Locking" ../sm-demo-app/plugins/golem15/user/classes/backend_links.go` prints at least 1
- `grep -c "VerifyClaims" ../sm-demo-app/plugins/golem15/user/controllers/backend_link_controller.go` prints 1 and `grep -c "stale_session" ../sm-demo-app/plugins/golem15/user/controllers/backend_link_controller.go` prints 1
- `grep -c "/backend-link/{code}\|/backend-link/confirm" ../sm-demo-app/plugins/golem15/user/routes.go` prints 2 and every pre-existing route line in routes.go is unchanged (`git -C ../sm-demo-app/plugins/golem15/user diff 930b158 -- routes.go | grep -c '^-g\.'` prints 0)
- `grep -c "MCPLinkedBackendResolver" ../sm-demo-app/plugins/golem15/user/plugin.go` prints 1 and `grep -c "frontend_account" ../sm-demo-app/plugins/golem15/user/account_contributions.go` prints at least 1
- `grep -c "frontend_url\|request_ttl" ../sm-demo-app/plugins/golem15/user/config/config.yaml` prints 2 and `grep -c "backend_link:" ../sm-demo-app/plugins/golem15/user/lang/en/lang.yaml ../sm-demo-app/plugins/golem15/user/lang/pl/lang.yaml` prints 1 per file
- `TestBackendLinkSmoke` prints `--- PASS` on a Docker host
</acceptance_criteria>
<done>A proven, one-shot, fresh-sign-in link exists end to end from My account through the site confirm to the published resolver, with cascades and events, on the plugin's master checkout.</done>
</task>
<task type="auto">
<name>Task 2: Frontend permission codes from plugins, the user MCP guard provider and personal-token resolver, the token/me route and the user_me tool</name>
<files>../sm-demo-app/plugins/golem15/user/classes/frontend_permission_catalog.go, ../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go, ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go, ../sm-demo-app/plugins/golem15/user/controllers/usergroups_admin_controller.go, ../sm-demo-app/plugins/golem15/user/controllers/api_tokens.go, ../sm-demo-app/plugins/golem15/user/controllers/token_me.go, ../sm-demo-app/plugins/golem15/user/mcp.go, ../sm-demo-app/plugins/golem15/user/plugin.go, ../sm-demo-app/plugins/golem15/user/routes.go, ../sm-demo-app/plugins/golem15/user/mcp_guard_smoke_test.go, ../sm-demo-app/plugins/golem15/user/frontend_permission_catalog_smoke_test.go</files>
<read_first>
- ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go 426-447 and usergroups_admin_controller.go 186-205 (AdminPermissionOptions; FormAfterUpdate hooks where permissions and groups are saved: grep `permissions` and `Groups` writes), controllers/api_tokens.go (APITokenDestroy: where a token is revoked)
- ../sm-demo-app/plugins/golem15/user/classes/permissions.go (FrontendPermissionOptions 124+, MergedPermissions is NOT to be used: P-14), classes/user_lookup.go 35-100 (PrincipalByID, UserPermissionGrants), classes/api_tokens.go 15-40 (prefix, AllowedAPITokenScopes), middleware/api_token.go 40-120 (hash lookup, IsUsableAt, last_used stamp, Scope and Permission middleware semantics)
- ../sm-demo-app/plugins/golem15/user/plugin.go 225-256 (Middlewares: the names `user.api_token`, `user.scope`, `user.permission` the provider parses)
- summercms.go: modules/pact/mcp.go (MCPGuard, MCPGuards, MCPRequirements, MCPSubject, MCPDispatch, MCPPersonalTokenResolver, HasFrontendPermissions, FrontendPermission, HasMCP, MCPTool), modules/party/registry.go 20-30 (party.Activated published on the app), modules/cabana/contracts.go 295-335 (Allows is OR across required codes: call it per code), modules/cabana/field_permission.go (PermissionOption)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pitfall 3", § "Pattern 6" (in-memory credential), § "Pitfall 9", § "Frontend tool (D-18) needs a new route"
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "USER/frontend_permissions.go" and § "USER/mcp.go"
</read_first>
<action>
D-09: `classes.FrontendPermissionCatalog(ctx, app, db) ([]cabana.PermissionOption, error)`: the seeded rows from `FrontendPermissionOptions` first (unchanged order and fields), then every `pact.HasFrontendPermissions` among `app.Lookup[party.Activated]()` in activation order, appending each code not already present (seeded wins on a duplicate code; a duplicate between two plugins keeps the first). Both `AdminPermissionOptions` (users and user groups controllers) return the catalog. Existing rows, the table and the payload fields stay as they are; the editors simply offer more rows.
Guard provider `classes.MCPUserGuard{App}` implementing `pact.MCPGuard` and `pact.MCPPersonalTokenResolver`: `MCPGuardName()` = `user`; `MCPTokenGuarded(mw)` = contains `user.api_token`; `MCPRequirements(mw)`: `user.scope:<s>` → Scopes, `user.permission:<c>` → Permissions (error for an unknown `user.` name); `MCPAllows(ctx, subject, req, perms)`: every `req.Scopes` entry ∈ `subject.Scopes`, then `principal := PrincipalByID(ctx, db, subject.UserID)` (nil → false) and for every code in `req.Permissions` and `perms` require `cabana.Allows(principal, []string{code})` (AND across codes, matching the middleware chain; P-14); `MCPDispatch(ctx, subject, method)`: `Principal` from `PrincipalByID`, `Credential` = `&models.APIToken{UserID: subject.UserID, Scopes: <subject.Scopes as lagoon.Jsonable>}` (ID 0, never saved; Pitfall 9), `Guards: []string{"api_token"}`; `MCPResolvePersonalToken(ctx, raw)`: false unless `raw` starts with `classes.APITokenPrefix(app)`; then the same hash lookup and `IsUsableAt` as the guard, stamp `last_used_at` (no IP), answer `pact.MCPSubject{Guard: "user", UserID, Scopes: token scopes, TokenID: token.ID}`; an unusable token is `(MCPSubject{}, true, pact.ErrMCPTokenInvalid)`. Boot: find-or-publish `*pact.MCPGuards`, `Register(guard)`, `app.Publish[pact.MCPPersonalTokenResolver](guard)`.
Subject events (D-26 user side) through `classes.FireSubjectChanged(ctx, app, "user", userID, kind)`: `permissions` after a users-admin save that changed `permissions` or the groups relation, after a user-groups-admin save that changed `permissions` (one event per member, ids read in the tx) and from the group membership helpers; `revoked` from `APITokenDestroy` (and any admin token revoke path); `deleted` is Task 1's listener. Place the calls in the existing hooks without changing their signatures.
Tool and route (D-18): `g.Get("/token/me", controllers.TokenMe(p.app), "user.api_token", "user.scope:read")` appended to the group; `TokenMe` reads `bouncer.User(ctx)`, loads the user, answers `{"user": apiArray(...)}` exactly like `Fetch` (401 `{"error":true,"message":"Invalid token."}` comes from the guard). `mcp.go`: `(*Plugin) MCP()` returns `pact.MCP{Tools: []pact.MCPTool{{Name: "me", Title: "Current user", Description: "Returns the profile of the signed-in frontend user.", Guard: "user", Method: http.MethodGet, Path: "/_user/api/v1/token/me", Input: struct{}{}}}}` (exposed as `user_me`; no Output).
Smokes (Postgres via newAdminEnv): `TestUserMCPGuardSmoke`: TokenGuarded true only with `user.api_token`; Requirements parses two scopes and a permission; Allows is false when a scope is missing, false when one of two codes is not granted to any of the user's groups, true when both are granted by groups (a user-level override alone does not grant: P-14); Dispatch returns a principal with the group grants and a credential of type `*models.APIToken` with ID 0 and the subject's scopes; ResolvePersonalToken answers false for `oas_at_x`, the subject for a valid `usr_` token, and ErrMCPTokenInvalid for a revoked one; `GET /_user/api/v1/token/me` with a `usr_` token of scope `read` answers 200 with `user.email`, with scope `write` only answers 403 `Missing required scope: read`, and with a JWT answers 401. `TestFrontendPermissionCatalogSmoke`: a fake plugin in the env declares `acme.blog.manage` and a code equal to a seeded row with a different label; both editors' `AdminPermissionOptions` list the seeded rows first, then `acme.blog.manage`, and the seeded label wins for the duplicate.
</action>
<verify>
<automated>GOWORK=off go -C ../sm-demo-app/plugins/golem15/user vet ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -short ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -run '^(TestUserMCPGuardSmoke|TestFrontendPermissionCatalogSmoke)$' -v . 2>&1 | grep -c -- '^--- PASS: Test' | grep -qx 2</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS count line is not exactly 2 (SKIP without Docker counts as not passing)</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "func FrontendPermissionCatalog(" ../sm-demo-app/plugins/golem15/user/classes/frontend_permission_catalog.go` prints 1 and `grep -c "FrontendPermissionCatalog(" ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go ../sm-demo-app/plugins/golem15/user/controllers/usergroups_admin_controller.go` prints 1 per file
- `grep -c "func (g \*MCPUserGuard) \(MCPGuardName\|MCPTokenGuarded\|MCPRequirements\|MCPAllows\|MCPDispatch\|MCPResolvePersonalToken\)(" ../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go` prints 6
- `grep -c "MergedPermissions" ../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go` prints 0
- `grep -c "\"api_token\"" ../sm-demo-app/plugins/golem15/user/classes/mcp_guard.go` prints at least 1
- `grep -c "/token/me" ../sm-demo-app/plugins/golem15/user/routes.go` prints 1 and `grep -c "\"user.api_token\", \"user.scope:read\"" ../sm-demo-app/plugins/golem15/user/routes.go` prints 1
- `grep -c "Name: *\"me\"" ../sm-demo-app/plugins/golem15/user/mcp.go` prints 1
- `grep -c "MCPGuards\|MCPPersonalTokenResolver" ../sm-demo-app/plugins/golem15/user/plugin.go` prints at least 2
- `grep -c "FireSubjectChanged(" ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go ../sm-demo-app/plugins/golem15/user/controllers/usergroups_admin_controller.go ../sm-demo-app/plugins/golem15/user/controllers/api_tokens.go` prints a non-zero count per file
- Both smoke tests print `--- PASS` on a Docker host
</acceptance_criteria>
<done>The editors offer plugin-declared frontend codes, pier can obtain the user guard and personal-token resolver from the app, the token/me route and the user_me tool exist, and permission, membership and token changes fire subject events.</done>
</task>
<task type="auto">
<name>Task 3: Administrators-screen actions: set a link through the prompted record action and remove one, behind golem15.users.manage_backend_links</name>
<files>../sm-demo-app/plugins/golem15/user/backend_links_admin.go, ../sm-demo-app/plugins/golem15/user/admin_permissions.go, ../sm-demo-app/plugins/golem15/user/classes/privileged.go, ../sm-demo-app/plugins/golem15/user/lang/en/lang.yaml, ../sm-demo-app/plugins/golem15/user/lang/pl/lang.yaml, ../sm-demo-app/plugins/golem15/user/backend_link_admin_smoke_test.go</files>
<read_first>
- ../sm-demo-app/plugins/golem15/user/admin_permissions.go (the catalog; the fifth code without a default role) and classes/privileged.go (PermissionManagePrivilegedGroups constant placement)
- ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go 665-720 (the `action(...)` helper style, TxFromContext)
- summercms.go: modules/cabana/example_action_extension_test.go (AdminActionExtensions on AdministratorsControllerID), modules/cabana/action_extensions.go (the outranking wrap cabana applies before Run), modules/pact/capabilities.go (AdminActionPrompt, AdminRecordActionInput.Value as shipped by plan 01), modules/cabana/crud.go error types (grep `type ValidationError`, `type ForbiddenError` and how actionFailure maps them)
- .planning/phases/19.6.1-backend-administrators-screen/19.6.1-01-SUMMARY.md and 19.6.1-04-SUMMARY.md (preview offers contributed actions after the owner's; cabana runs guardOutranked before Run; "Every refusal ... is a ForbiddenError with Message set")
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "USER/backend_links_admin.go" and § "USER/admin_permissions.go"
</read_first>
<action>
Permission: `classes.PermissionManageBackendLinks = "golem15.users.manage_backend_links"` appended to `Permissions()` with Tab `userPermissionTab`, Label `golem15.user::lang.plugin.manage_backend_links` and no Roles (D-35, P-12); lang `plugin.manage_backend_links` en/pl.
`backend_links_admin.go`: `(*Plugin) AdminActionExtensions()` returns one `pact.AdminActionExtension{Controller: cabana.AdministratorsControllerID, RecordActions: [...]}` with:
- `link_frontend_account`: Label `golem15.user::lang.backend_link.set`, Confirm `...set_confirm`, Permissions `[PermissionManageBackendLinks]`, `Prompt: &pact.AdminActionPrompt{Label: "...prompt_email", Comment: "...prompt_comment", MaxLength: 254}`, Applies: the admin record has no link; Run: `in.Record.(*cabana.BackendUser)`, `tx := cabana.TxFromContext(ctx)`, find the frontend user by `lower(email) = lower(trim(in.Value))` among active, non-deleted users (exactly one; otherwise a 422 ValidationError on `payload` with `...unknown_user`), refuse when either side is already linked (422 on `payload` with `...already_linked`), `links.SetLink(ctx, tx, user.ID, admin.ID, bouncer.User(ctx).ID)`, answer `Message: "...set_success"`.
- `unlink_frontend_account`: Label `...remove`, Confirm `...remove_confirm`, Danger true, Permissions `[PermissionManageBackendLinks]`, Applies: linked; Run: `links.RemoveLink(ctx, tx, link)`, Message `...remove_success`.
cabana's own outranking rule (19.6.1 D-19) runs before either Run; the plugin does not duplicate it. The frontend Users screen gets no new action (D-34 moved the admin path to the Administrators screen).
Smoke `TestBackendLinkAdminSmoke` (Postgres): a superuser sees both actions offered on an admin's preview only as applicable (set when unlinked, remove when linked); `POST .../summercms/cabana/users/{id}/actions/link_frontend_account` with `{"payload":"Editor@Example.test"}` links the user whose email is `editor@example.test`, stores `linked_by` = the caller, and `LinkedBackendUser` answers; a second set for the same admin answers 422 on payload; an unknown email answers 422 on payload with the unknown_user text; a limited admin without `golem15.users.manage_backend_links` is not offered the action and gets 403 when posting it; `unlink_frontend_account` removes the link; a `BackendLinkedEvent` listener registered by the test saw the set.
</action>
<verify>
<automated>GOWORK=off go -C ../sm-demo-app/plugins/golem15/user vet ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -short ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -run '^TestBackendLinkAdminSmoke$' -v . 2>&1 | grep -q -- '^--- PASS: TestBackendLinkAdminSmoke'</automated>
<fails_when>non-zero exit, "FAIL" in the output, or the PASS line is absent (SKIP without Docker counts as absent)</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "golem15.users.manage_backend_links" ../sm-demo-app/plugins/golem15/user/admin_permissions.go ../sm-demo-app/plugins/golem15/user/classes/privileged.go` prints at least 1 in total and the five pre-existing codes are unchanged (`git -C ../sm-demo-app/plugins/golem15/user diff 930b158 -- admin_permissions.go | grep -c '^-.*Code:'` prints 0)
- `grep -c "cabana.AdministratorsControllerID" ../sm-demo-app/plugins/golem15/user/backend_links_admin.go` prints 1 and `grep -c "link_frontend_account\|unlink_frontend_account" ../sm-demo-app/plugins/golem15/user/backend_links_admin.go` prints at least 2
- `grep -c "Prompt: *&pact.AdminActionPrompt" ../sm-demo-app/plugins/golem15/user/backend_links_admin.go` prints 1 and `grep -c "Danger: *true" ../sm-demo-app/plugins/golem15/user/backend_links_admin.go` prints 1
- `grep -c "in.Value" ../sm-demo-app/plugins/golem15/user/backend_links_admin.go` prints at least 1
- `grep -c "manage_backend_links" ../sm-demo-app/plugins/golem15/user/lang/en/lang.yaml ../sm-demo-app/plugins/golem15/user/lang/pl/lang.yaml` prints 1 per file
- `TestBackendLinkAdminSmoke` prints `--- PASS` on a Docker host
</acceptance_criteria>
<done>A privileged admin sets and removes another administrator's frontend link from the Administrators screen through the seam, with linked_by recorded and events fired; no console command is the only way.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 4: Decide the plugin release version and which applications to bump</name>
<decision>Tag and push the sm-user-plugin release carrying the account link, the Administrators-screen actions, plugin-registered frontend permissions, the user MCP guard and the user_me tool, pinned to the framework tag from plan 02; then bump the pointer in every application that mounts the plugin.</decision>
<context>Additive release (no removed export, route, column or payload field; the gate's additive check in plan 05 will prove it against 930b158). Proposed `v0.1.9` (P-15). The plugin's `go.mod` will require the framework version recorded in 19.7-02-SUMMARY.md. Applications mounting the plugin as a submodule: sm-demo-app (needed by plan 04), fonoteka.go and sm-bm-app (D-31 names them), sm-grzybyfunkcjonalne-app and sm-summercmsio-app (D-01: one pin bump per app). Each app's bump is one commit (go.mod, go.sum, submodule pointer) and each must `go build ./... && go test -short ./...` at the bumped pins; an app that fails for a reason unrelated to this phase is reported, not fixed here. Pre-checks before asking: clean plugin tree, `GOWORK=off go vet ./... && go test -count=1 ./...` (Docker) in the plugin, README updated.</context>
<options>
<option id="v019">
<name>Tag v0.1.9 and bump all five applications</name>
<pros>Additive patch release; every consumer moves together as D-01 asks</pros>
<cons>Five application commits; a consumer with unrelated drift may need a follow-up</cons>
</option>
<option id="v019-demo-only">
<name>Tag v0.1.9 and bump sm-demo-app, fonoteka.go and sm-bm-app only</name>
<pros>Covers D-31's named consumers and plan 04's needs; fewer commits now</pros>
<cons>grzybyfunkcjonalne and summercmsio stay on v0.1.8 until a later bump</cons>
</option>
<option id="hold">
<name>Hold the tag</name>
<pros>Review the plugin diff first</pros>
<cons>Plan 04 cannot pin the plugin until the tag exists</cons>
</option>
</options>
<resume-signal>Answer v019, v019-demo-only or hold (with hold, say when to continue)</resume-signal>
</task>
<task type="auto">
<name>Task 5: Release the plugin at the chosen version and bump the application pointers</name>
<reversibility rating="one-way">A pushed plugin tag is pinned by application go.mod files and submodule pointers; the migration it carries creates tables in every consumer that runs it.</reversibility>
<precondition>The Task 4 checkpoint answered v019 or v019-demo-only; 19.7-02-SUMMARY.md records the framework tag; `git -C ../sm-demo-app/plugins/golem15/user status --short` is empty; each application to bump has a clean tree for go.mod, go.sum and plugins/golem15/user (check `git -C <app> status --short go.mod go.sum plugins/golem15/user`)</precondition>
<files>../sm-demo-app/plugins/golem15/user/README.md, ../sm-demo-app/plugins/golem15/user/go.mod, ../sm-demo-app/plugins/golem15/user/go.sum, ../sm-demo-app/go.mod, ../sm-demo-app/go.sum, ../sm-demo-app/plugins/golem15/user, ../fonoteka.go/go.mod, ../fonoteka.go/go.sum, ../fonoteka.go/plugins/golem15/user, ../sm-bm-app/go.mod, ../sm-bm-app/go.sum, ../sm-bm-app/plugins/golem15/user, ../sm-grzybyfunkcjonalne-app/go.mod, ../sm-grzybyfunkcjonalne-app/go.sum, ../sm-grzybyfunkcjonalne-app/plugins/golem15/user, ../sm-summercmsio-app/go.mod, ../sm-summercmsio-app/go.sum, ../sm-summercmsio-app/plugins/golem15/user</files>
<read_first>
- ../sm-demo-app/plugins/golem15/user/README.md (Features, API reference, Admin, Configuration, Testing sections to extend)
- .planning/notes/core-plugins-own-repos.md (commit and push the plugin first, then the pointer bump in the app as a separate commit)
- .planning/phases/19.7-generic-mcp-module/19.7-02-SUMMARY.md (the framework version to require)
- `git -C ../sm-demo-app/plugins/golem15/user log --oneline v0.1.8..HEAD` (the commits the tag carries)
- each application's go.mod (require lines for summercms and sm-user-plugin; fonoteka.go is at summercms v0.4.0 and will move to the plan-02 tag), each app's `.gitmodules` entry for plugins/golem15/user
- CLAUDE.md § "Sibling repositories"
</read_first>
<action>
README (in the plugin): Features (the account link and its proof, the Administrators-screen actions and the permission code, plugin frontend permission codes, the MCP guard and the `user_me` tool), API reference (the three new routes with bodies and errors, the new exported identifiers), Admin (the two record actions and My account section), Configuration (`frontend_url`, `backend_links.request_ttl`), Testing (the new smoke names). Then `go.mod`: `require git.golem15.com/golem15/summercms <plan-02 tag>` and `GOWORK=off go mod tidy`; commit `chore: require SummerCMS <tag>` (the plugin's existing convention, see commit 930b158). Pre-checks: `GOWORK=off go vet ./... && GOWORK=off go test -count=1 ./...` on Docker. Tag `git tag -a <version> -m "<message listing the five features>"` and `git push origin master --tags` from the plugin checkout (go-ahead given at the checkpoint).
Pointer bumps, one commit per app, in this order: sm-demo-app, fonoteka.go, sm-bm-app, then (v019 only) sm-grzybyfunkcjonalne-app and sm-summercmsio-app. In each app: `git -C <app>/plugins/golem15/user fetch --tags && git -C <app>/plugins/golem15/user checkout <version>`; edit go.mod `require git.golem15.com/golem15/sm-user-plugin <version>` and `require git.golem15.com/golem15/summercms <plan-02 tag>` (the new plugin needs the new pact types); `go mod tidy` in the app's workspace; `go build ./... && go test -short ./...`; commit `chore: bump user to <version> and require summercms <tag>` staging exactly go.mod, go.sum and plugins/golem15/user. Do not push the applications (the user deploys per app). If an app fails to build or test at the bumped pins for a reason outside this phase (for example a generated main.go that an older `summer build` wrote), stop, revert that app's working changes, record the failure with the exact error in the SUMMARY and in `.planning/phases/19.7-generic-mcp-module/deferred-items.md`, and raise a `checkpoint:human-verify` with `gate="blocking-human"` naming the app and the error; continue with the next app only after the user answers.
</action>
<verify>
<automated>TAG=$(git -C ../sm-demo-app/plugins/golem15/user describe --tags --exact-match HEAD) && git -C ../sm-demo-app/plugins/golem15/user ls-remote --exit-code --tags origin "refs/tags/$TAG" >/dev/null && for app in ../sm-demo-app ../fonoteka.go ../sm-bm-app; do (cd "$app" && go build ./... && go test -count=1 -short ./...) || exit 1; done</automated>
<fails_when>non-zero exit (the plugin HEAD is not tagged, the remote lacks the tag, or an application fails to build or test at the bumped pins)</fails_when>
</verify>
<acceptance_criteria>
- `git -C ../sm-demo-app/plugins/golem15/user describe --tags --exact-match HEAD` prints the chosen version and the remote has it
- `grep -c "git.golem15.com/golem15/summercms <plan-02 tag>" ../sm-demo-app/plugins/golem15/user/go.mod` prints 1 (substitute the recorded tag)
- For each bumped app: `grep -c "sm-user-plugin <version>" <app>/go.mod` prints 1, `git -C <app> log -1 --format=%s` is the bump commit, and `git -C <app> diff --quiet HEAD -- go.mod go.sum plugins/golem15/user` exits 0
- `(cd ../fonoteka.go && go build ./... && go test -count=1 -short ./...)` and the same in ../sm-bm-app exit 0 (D-31), or the deferred-items.md entry and the human checkpoint explain which app did not
- `grep -c "manage_backend_links\|backend-link/confirm\|user_me" ../sm-demo-app/plugins/golem15/user/README.md` prints at least 3
</acceptance_criteria>
<done>The plugin is tagged and pushed at the chosen version against the plan-02 framework tag, and every targeted application pins it in its own commit and builds and tests at the new pins (or the exception is recorded and surfaced).</done>
</task>
</tasks>
<artifacts_this_phase_produces>
## Artifacts this plan produces (sm-user-plugin, `git.golem15.com/golem15/sm-user-plugin`)
**Migration**: `202610220001_create_golem15_user_backend_links` — tables `golem15_user_backend_links`, `golem15_user_backend_link_requests`
**Models**: `models.BackendLink`, `models.BackendLinkRequest`
**Service**: `classes.BackendLinks` (`CreateLinkRequest`, `LinkRequestByCode`, `ConfirmLinkRequest`, `SetLink`, `RemoveLink`, `LinkFor`, `LinkOf`, `LinkedBackendUser`), errors `ErrLinkRequestUsed`, `ErrLinkRequestExpired`, `ErrStaleSession`, `ErrAlreadyLinked`, `ErrBackendUserUnavailable`; events `classes.BackendLinkedEvent`, `classes.BackendUnlinkedEvent`; `classes.FireSubjectChanged`
**Permissions and catalog**: `classes.PermissionManageBackendLinks = "golem15.users.manage_backend_links"`; `classes.FrontendPermissionCatalog`
**MCP**: `classes.MCPUserGuard` (guard `user`, resolver for `usr_` tokens); tool `user_me`; `(*Plugin) MCP()`, `(*Plugin) AccountContributions()`, `(*Plugin) AdminActionExtensions()`
**Routes**: `GET /_user/api/v1/backend-link/{code}`, `POST /_user/api/v1/backend-link/confirm` (jwt.auth), `GET /_user/api/v1/token/me` (user.api_token, user.scope:read)
**Admin**: My account section `frontend_account` (actions `link`, `unlink`); Administrators record actions `link_frontend_account` (prompted), `unlink_frontend_account`
**Config keys**: `golem15.user.frontend_url`, `golem15.user.backend_links.request_ttl`
**Phrases**: `golem15.user::lang.backend_link.*`, `golem15.user::lang.plugin.manage_backend_links` (en, pl)
**Release**: plugin tag (v0.1.9 proposed) requiring the plan-02 framework tag; pointer bump commits in sm-demo-app, fonoteka.go, sm-bm-app (and sm-grzybyfunkcjonalne-app, sm-summercmsio-app)
</artifacts_this_phase_produces>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| site browser to backend-link routes | an anonymous holder of a code reads the show route; a signed-in frontend user posts the confirm |
| admin SPA to My account and Administrators actions | the signed-in admin's intent to link or unlink, and a privileged admin's typed email |
| pier to the plugin's guard provider and resolvers | identity decisions for tools/list, tools/call and the linked admin |
| plugin to the festival bus | subject-changed events other instances act on |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.7-22 | Elevation | link without proof or by email match (self-service) | high | mitigate | The self-service path writes a link only inside `ConfirmLinkRequest`: a one-shot hashed 32-byte code bound to the admin, 10-minute TTL, row lock, `jwt.auth` principal, JWT `iat` not before the request's `created_at` (P-11); no email matching and no user list anywhere on this path (`TestBackendLinkSmoke`) |
| T-19.7-23 | Spoofing | replayed or guessed link code | medium | mitigate | 64-hex code (256 bits) compared through its SHA-256 hash, `used_at` set in the same transaction as the link, expired and used codes answer 404 identically; the show route reveals only the admin's login, display name and expiry |
| T-19.7-24 | Elevation | admin sets a link to any frontend user (D-07) | high | mitigate | Separate permission `golem15.users.manage_backend_links` without a default role; exact-match email only (no search); `linked_by` recorded; `BackendLinkedEvent` and subject events fired; cabana's outranking check runs before Run; 1:1 uniqueness refuses a second link (`TestBackendLinkAdminSmoke`) |
| T-19.7-25 | Elevation | cross-site request on confirm or unlink | medium | mitigate | Confirm is POST behind `jwt.auth` with the bearer re-verified for `iat`; My account actions run behind the backend guard, `interactiveOnly` and `requireAjax` (plan 01 seam); none of them accepts a GET |
| T-19.7-26 | Information Disclosure | stale link resolution after unlink or deletion | medium | mitigate | `LinkedBackendUser` is one indexed query per call with no plugin-side cache; Deleting and Deactivating listeners remove the link in the same transaction; the backend-side `link` event lets pier drop its 5 s cache and recompute sessions (`TestBackendLinkSmoke` unlink and delete cases) |
| T-19.7-27 | Elevation | tools/list and tools/call disagree on frontend permissions | medium | mitigate | `MCPAllows` uses `PrincipalByID` group grants and `cabana.Allows` per code with AND, the same evaluation `user.permission` middleware performs on the call; `TestUserMCPGuardSmoke` covers the missing-scope and partially granted cases |
| T-19.7-28 | Spoofing | personal token resolution at the MCP endpoint | medium | mitigate | The resolver answers only for the configured prefix, verifies the hash and `IsUsableAt`, stamps last_used_at, and returns the token's own scopes as the ceiling; the in-memory dispatch credential has ID 0 and is never persisted (Pitfall 9) |
| T-19.7-29 | Repudiation | who linked whom | low | mitigate | `linked_by` on admin-set links, `created_at` on every link and request, `BackendLinkedEvent`/`BackendUnlinkedEvent` for listeners, and the plugin's existing admin audit logging on record actions |
</threat_model>
<verification>
- `GOWORK=off go -C ../sm-demo-app/plugins/golem15/user vet ./... && GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 -short ./...`
- Docker host: `GOWORK=off go -C ../sm-demo-app/plugins/golem15/user test -count=1 ./...` with `TestBackendLinkSmoke`, `TestBackendLinkAdminSmoke`, `TestUserMCPGuardSmoke`, `TestFrontendPermissionCatalogSmoke` printing `--- PASS`
- Additive check (the 19.4 gate's rule, formalised in plan 05): no exported func, method or type removed from a non-test .go file since 930b158
- After Task 5: the plugin tag exists locally and on origin; each bumped application builds and tests at its new pins
</verification>
<success_criteria>
- Every must_have truth is demonstrated by a named smoke test or by the release artifacts; the plugin repo diff against 930b158 removes no route, export, column, seeded row or payload field
- Plan 04 can look up `*classes.BackendLinks`, `pact.MCPLinkedBackendResolver`, the `user` guard in `*pact.MCPGuards` and `pact.MCPPersonalTokenResolver` from an app that mounts the released plugin
- The planner decisions P-10..P-15 are implemented as written and named in the SUMMARY
</success_criteria>
<output>
Create `.planning/phases/19.7-generic-mcp-module/19.7-03-SUMMARY.md` (in the framework repo, planning docs commit) when done, recording the plugin version and which applications were bumped.
</output>

View File

@@ -0,0 +1,365 @@
---
phase: 19.7-generic-mcp-module
plan: 04
type: execute
wave: 4
depends_on: ["19.7-03"]
files_modified:
- ../sm-oauthserver-plugin/servers.go
- ../sm-oauthserver-plugin/plugin.go
- ../sm-oauthserver-plugin/routes.go
- ../sm-oauthserver-plugin/classes/mcp_verifier.go
- ../sm-oauthserver-plugin/classes/cascade.go
- ../sm-oauthserver-plugin/classes/subject_events.go
- ../sm-oauthserver-plugin/controllers/authorizations.go
- ../sm-oauthserver-plugin/controllers/mcp_consent_api.go
- ../sm-oauthserver-plugin/config/config.yaml
- ../sm-oauthserver-plugin/lang/en/lang.yaml
- ../sm-oauthserver-plugin/lang/pl/lang.yaml
- ../sm-oauthserver-plugin/README.md
- ../sm-oauthserver-plugin/go.mod
- ../sm-oauthserver-plugin/go.sum
- ../sm-oauthserver-plugin/mcp_verifier_smoke_test.go
- ../sm-oauthserver-plugin/mcp_consent_smoke_test.go
- ../sm-journal-plugin/mcp.go
- ../sm-journal-plugin/controllers/api/auth.go
- ../sm-journal-plugin/README.md
- ../sm-journal-plugin/go.mod
- ../sm-journal-plugin/go.sum
- ../sm-journal-plugin/mcp_smoke_test.go
- ../sm-demo-app/summer.yaml
- ../sm-demo-app/plugins.gen.go
- ../sm-demo-app/main.go
- ../sm-demo-app/go.mod
- ../sm-demo-app/go.sum
- ../sm-demo-app/config/mcp.yaml
- ../sm-demo-app/config/golem15.oauthserver.yaml
- ../sm-demo-app/config/http.yaml
- ../sm-demo-app/boot_test.go
- ../sm-demo-app/mcp_e2e_test.go
- ../sm-demo-app/deploy/nginx/demo.summercms.io.conf
- ../sm-demo-app/DEPLOY.md
- ../sm-demo-app/plugins/golem15/oauthserver
- ../sm-demo-app/plugins/golem15/journal
- ../sm-demo-app/vue-demo-app
- ../sm-demo-app/vue-demo-app/app/pages/connect.vue
- ../sm-demo-app/vue-demo-app/app/pages/link-admin.vue
- ../sm-demo-app/vue-demo-app/i18n/locales/en.json
- ../sm-demo-app/vue-demo-app/i18n/locales/pl.json
- .planning/phases/19.7-generic-mcp-module/deferred-items.md
autonomous: false
requirements: [SC-1, SC-3, SC-4, D-02, D-05, D-15, D-16, D-17, D-18, D-21, D-22, D-23, D-26, D-30, D-31, D-33, D-35, D-36]
estimate:
tokens: 85000
raw_tokens: 85000
tasks: 5
confidence: low
must_haves:
truths:
- "An oas_at_ MCP access token is verified at the resource by a verifier sm-oauthserver-plugin publishes: prefix, hash, not revoked, not expired, client of kind mcp and not revoked, user active; an OIDC token or a foreign-kind client's token is refused (SC-4, D-02; Pitfall 4)"
- "The MCP authorization server offers the backend scope; the consent JSON shows 'also act as admin <name>' only when the user has a verified link and drops backend from the grant when there is none; a user can connect a client to frontend tools only (D-21, D-35)"
- "An editor signs in once through the demo's /connect page as a frontend user; with a link and the backend scope, Journal's post tools run as that admin with the admin's real permissions, and removing the link or the grant removes them (SC-4, D-18, D-22)"
- "Journal declares its post, category and tag tools and one prompt with Guard backend and Permissions access_posts; the list and show tools see the dispatched principal through optionalBackendPrincipal (D-15, D-16, D-17, D-18)"
- "sm-demo-app builds with the summercms_mcp tag, mounts /mcp and the protected resource metadata with the memory session store, routes them through nginx in the deploy notes, and boots unchanged when mcp.enabled is false (SC-1, D-30, D-33)"
- "Grant revocation and user deletion or deactivation fire pact.MCPSubjectChanged so sessions end on every instance (D-26)"
- "oauthserver and Journal are released additively after the plugin release of plan 03 and the demo pins them in separate commits (D-31)"
artifacts:
- path: "../sm-oauthserver-plugin/classes/mcp_verifier.go"
provides: "MCPTokenVerifier implementing pact.MCPTokenVerifier"
contains: "func (v *MCPTokenVerifier) MCPVerifyToken("
- path: "../sm-oauthserver-plugin/controllers/mcp_consent_api.go"
provides: "MCPConsentShow and MCPConsentDecide"
contains: "backend_admin"
- path: "../sm-journal-plugin/mcp.go"
provides: "HasMCP: journal post, category, tag tools and the draft_post prompt"
contains: "golem15.journal.access_posts"
- path: "../sm-demo-app/config/mcp.yaml"
provides: "mcp.enabled, path, sessions.store memory"
contains: "enabled: true"
- path: "../sm-demo-app/mcp_e2e_test.go"
provides: "TestMCPEndToEnd (tagged summercms_mcp, Postgres)"
contains: "//go:build summercms_mcp"
- path: "../sm-demo-app/vue-demo-app/app/pages/connect.vue"
provides: "the MCP consent page"
- path: "../sm-demo-app/vue-demo-app/app/pages/link-admin.vue"
provides: "the link-proof page"
key_links:
- from: "../sm-oauthserver-plugin/plugin.go"
to: "../sm-oauthserver-plugin/classes/mcp_verifier.go"
via: "Boot publishes the verifier as pact.MCPTokenVerifier when mcp.enabled"
pattern: "MCPTokenVerifier"
- from: "../sm-oauthserver-plugin/controllers/mcp_consent_api.go"
to: "summercms.go/modules/pact/mcp.go"
via: "app.Lookup[pact.MCPLinkedBackendResolver] decides the backend_admin line and the backend scope"
pattern: "MCPLinkedBackendResolver"
- from: "../sm-demo-app/vue-demo-app/app/pages/connect.vue"
to: "../sm-oauthserver-plugin/routes.go"
via: "GET and POST /oauth/mcp/requests/{request} with the frontend JWT"
pattern: "/oauth/mcp/requests/"
- from: "../sm-demo-app/summer.yaml"
to: "summercms.go/modules/surf/pier_on.go"
via: "build.tags summercms_mcp links pier into the demo binary"
pattern: "summercms_mcp"
---
<!-- planner-discipline-allow: not here -->
<!-- planner-discipline-allow: hasBearer -->
<objective>
Close the OAuth and application side of SC-4 and prove both guards end to end in the demo: sm-oauthserver-plugin gains the `backend` scope on its MCP server, the resource-side `oas_at_` verifier, the MCP consent JSON endpoints with the linked-admin line, and the revoked events (D-02, D-21, D-26, D-35); Journal declares the first backend tools and a prompt and gets the one-line `optionalBackendPrincipal` fix (D-15, D-16, D-17, D-18); sm-demo-app builds with `summercms_mcp`, mounts pier with the memory store, serves the `/connect` consent and `/link-admin` proof pages from vue-demo-app, documents the nginx and deploy changes, and carries the end-to-end test (SC-1, SC-4, D-30, D-33). Then the oauthserver and Journal releases and the demo's pointer bumps (D-31).
**Planner decisions recorded here:**
- **P-16 (consent contract, D-35):** `GET /oauth/mcp/requests/{request}` (behind `jwt.auth` and `throttle:oauth-authorize`) answers `{request_id, client: {name, redirect_host}, scopes: [...requested], expires_at, backend_admin: {login, name} | null}`; `backend_admin` is non-null only when `backend` is requested AND the user has a link. `POST /oauth/mcp/requests/{request}` with `{decision: "allow"|"deny", scopes?: [...]}` grants `submitted ∩ requested` (requested when omitted) minus `backend` when there is no link, answers `{redirect_uri}` from `IssueCode`/`DenyPending`; 404 `{"error":"request_not_found"}`, 422 `{"error":"no_grantable_scopes"}`. A later link needs a new consent (A8 accepted).
- **P-17 (Journal tool set, Claude's discretion):** `journal_list_posts` (GET /posts), `journal_show_post` (GET /posts/{slug}), `journal_list_categories`, `journal_list_tags` (read), `journal_create_post` (POST /posts), `journal_update_post` (PUT /posts/{id}), `journal_delete_post` (DELETE /posts/{id}, destructive); one prompt `journal_draft_post` with arguments `topic` (required) and `tone`. All `Guard: "backend"`, `Permissions: ["golem15.journal.access_posts"]`. Multipart upload routes are not tools.
- **P-18 (repos and sync):** oauthserver and Journal are edited in their canonical repos (`../sm-oauthserver-plugin` on master, `../sm-journal-plugin` on main); the demo's submodules are moved to the same commits by fetching from the local repo path (`git -C ../sm-demo-app/plugins/golem15/<name> fetch /media/nvme/dev/golem15/summercms.io/summercms/sm-<name>-plugin <branch> && git checkout FETCH_HEAD`) during development and to the tags at release; vue-demo-app is edited in the demo's submodule checkout (`../sm-demo-app/vue-demo-app`, master, the newer of the two checkouts).
- **P-19 (demo store, A7):** the demo runs one instance without Redis, so `mcp.sessions.store: memory`; DEPLOY.md documents the Redis switch (`SUMMER_MCP__SESSIONS__STORE=redis` plus `SUMMER_REDIS__URL`) for a multi-instance host.
- **P-20 (versions):** oauthserver `v0.1.2`, Journal `v0.2.3`, both additive; the user decides at the checkpoint.
Purpose: SC-4's "one connector per person" is demonstrable: a frontend sign-in, a verified link, the backend scope, Journal tools as the admin, and removal on unlink.
Output: the verifier, the scope, the consent endpoints and pages, Journal's tools, the demo wiring, the e2e smoke, deploy notes, two plugin releases and the demo's pointer bumps.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/PROJECT.md
@.planning/ROADMAP.md
@.planning/STATE.md
@.planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md
@.planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md
@.planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md
@.planning/phases/19.7-generic-mcp-module/19.7-02-SUMMARY.md
@.planning/phases/19.7-generic-mcp-module/19.7-03-SUMMARY.md
@.planning/phases/19.4-oidc-provider-on-wristband/19.4-CONTEXT.md
@.planning/notes/core-plugins-own-repos.md
@CLAUDE.md
</context>
<project_rules>
- Core-plugin rule for oauthserver and Journal: additive only; existing routes, payloads, tables, scopes (`read`, `write`, `ai`, `offline_access`) and error bodies unchanged. Journal's management routes keep `requireBackendPrincipal` and their PHP-parity error bodies.
- Plugin repos first (commit, then tag and push only after the checkpoint); vue-demo-app is committed in its submodule checkout and pushed to its master only after the same checkpoint; pointer bumps in sm-demo-app as separate local commits (sm-demo-app itself is not pushed in this plan). Nothing is deployed in this plan; DEPLOY.md gains the instructions and the user deploys.
- `summer build` in the demo regenerates `plugins.gen.go` and `main.go`: install the CLI from the framework at the plan-02 tag first (`go install ./cmd/summer` from the framework checkout at that tag). The demo's `main.go` currently shows an uncommitted diff from another session: run `git -C ../sm-demo-app status --short` first; if `main.go` is modified before this plan touches it, stash nothing, stage only the regeneration this plan produces, and note the pre-existing diff in the SUMMARY.
- Stage by explicit path; one logical change per commit; no co-author tags; planning docs (framework repo) in their own commit.
</project_rules>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: an oas_at_ token minted by the demo's MCP authorization server lists and calls user_me through /mcp in the demo built with the summercms_mcp tag</name>
<reversibility rating="costly">The backend scope name becomes part of the MCP metadata and of existing grants (D-21 costly, user-chosen); the verifier contract is consumed by pier.</reversibility>
<files>../sm-oauthserver-plugin/servers.go, ../sm-oauthserver-plugin/plugin.go, ../sm-oauthserver-plugin/classes/mcp_verifier.go, ../sm-oauthserver-plugin/mcp_verifier_smoke_test.go, ../sm-oauthserver-plugin/README.md, ../sm-demo-app/summer.yaml, ../sm-demo-app/plugins.gen.go, ../sm-demo-app/main.go, ../sm-demo-app/config/mcp.yaml, ../sm-demo-app/config/golem15.oauthserver.yaml, ../sm-demo-app/boot_test.go, ../sm-demo-app/mcp_e2e_test.go, ../sm-demo-app/plugins/golem15/oauthserver</files>
<read_first>
- ../sm-oauthserver-plugin/servers.go 95-165 (LoadConfig MCP keys, NewServers, mcpOpts), plugin.go 55-110 (Boot, Publish), classes/mcp_store.go (MCPAccessTokenPrefix, the sha256 hash at ~338, Mint at ~329, ByClientID kind filter), models/access_token.go, models/client.go (ClientKindMCP, RevokedAt or equivalent), classes/lazy.go (LazyMCPStore resolving *gorm.DB at request time), harness_test.go and authorize_test.go (test shapes)
- ../sm-oauthserver-plugin/README.md lines 20-45 (the "Verifying MCP access tokens at a resource arrives with the MCP module, not here" sentence to replace)
- summercms.go: modules/pact/mcp.go (MCPTokenVerifier, MCPGrant, ErrMCPTokenInvalid), modules/cabana/token_guard.go stampThrottle (the last_used_at debounce pattern to copy), modules/pier/README.md Configuration (the mcp.* keys), modules/surf/pier_on.go, internal/build/manifest.go (build.tags)
- ../sm-demo-app/summer.yaml, boot_test.go (TestBootAllPlugins, testConfig, routed), testmain_test.go (flag.Parse then testing.Short), internal/demotest/postgres.go (Options, App, Demo: App, Plugins, DB), config/app.yaml (url), DEPLOY.md 325-352 (Build)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Pitfall 4", § "Pitfall 8", § "Pattern 9"
- .planning/phases/19.7-generic-mcp-module/19.7-PATTERNS.md § "OAS/classes/mcp_verifier.go, OAS/servers.go" and § "DEMO/summer.yaml, config, DEMO/mcp_e2e_test.go"
</read_first>
<action>
oauthserver: in `NewServers` after `mcpOpts := opts`, `mcpOpts.ScopesSupported = append(slices.Clone(opts.ScopesSupported), "backend")` (the OIDC server's options stay as they are); the metadata then lists `backend` and wristband (plan 01) accepts it at authorize. New `classes/mcp_verifier.go`: `type MCPTokenVerifier struct { App *backpack.App; Resource string; stamps ... }` implementing `pact.MCPTokenVerifier`: `MCPVerifyToken(ctx, raw)`: prefix `MCPAccessTokenPrefix` else `ErrMCPTokenInvalid`; hash with the same function `Mint` stores; load the `models.AccessToken` by `token_hash`; refuse revoked, expired (`expires_at` nil counts as never expiring only if the store mints such tokens; otherwise refuse nil), a client not found with `kind = mcp` or revoked, a user that `userclasses.PrincipalByID` cannot load (deleted or deactivated); debounce `last_used_at` writes to one per minute per token (copy cabana's stampThrottle shape); answer `pact.MCPGrant{UserID, ClientID, TokenID, Scopes, ExpiresAt}`; `MCPResource()` returns `cfg.MCPResource`. Boot: when `cfg.MCPEnabled`, `app.Publish[pact.MCPTokenVerifier](&classes.MCPTokenVerifier{App: app, Resource: cfg.MCPResource})`. README: replace the "not here" sentence with the verifier paragraph and add the `backend` scope to the MCP section. Smoke `TestMCPTokenVerifierSmoke` (Postgres, the plugin's harness): a minted MCP token verifies with its scopes and client id; an OIDC access token row (client kind oidc) is refused; a revoked token, an expired token and a token of a revoked client are refused; a deactivated user's token is refused; two verifications within a minute write `last_used_at` once.
Demo wiring: `summer.yaml` gains `build: { tags: [summercms_mcp] }`; `config/mcp.yaml` with `enabled: true`, `path: /mcp`, `sessions: { store: memory, idle_ttl: 30m }`, `allow_personal_tokens: false`, and a comment pointing at `docs/services/mcp.md`; `config/golem15.oauthserver.yaml` with `mcp: { enabled: true, resource: https://demo.summercms.io/mcp }` (local runs override through `SUMMER_GOLEM15__OAUTHSERVER__MCP__RESOURCE` and `SUMMER_MCP__RESOURCE` in `.env`, see DEPLOY.md task); move the oauthserver submodule to the new commit (P-18) and `go mod tidy` in the demo; `go install ./cmd/summer` from the framework at the plan-02 tag, then `summer build` in the demo to regenerate `plugins.gen.go` and `main.go` (commit only this plan's regeneration). `boot_test.go`: with the committed config the route list contains `POST /mcp` and `GET /.well-known/oauth-protected-resource` when the test binary carries the tag, and contains neither when built without it (two sub-tests or two build-tagged files: `boot_mcp_tagged_test.go` and `boot_mcp_untagged_test.go` are acceptable in place of editing boot_test.go, update files_modified accordingly in the SUMMARY); the existing assertions stay.
E2E smoke `mcp_e2e_test.go` (`//go:build summercms_mcp`, Postgres through `bootDemo`): assemble the handler with `surf.Assemble(demo.App, demo.Plugins)` on an `httptest.NewServer`; seed a frontend user and an `mcp` client row, mint an access token through `classes.NewMCPStore(demo.DB)` (its `Mint`, scopes `read write`) or by inserting the hashed row; with the go-sdk client and a bearer-injecting `http.Client`: `ListTools` contains `user_me` and contains no `journal_` tool (no link yet), `CallTool("user_me", {})` answers `isError false` with `structuredContent.user.email` equal to the seeded email; a bearer `oas_at_nope` is 401 with `WWW-Authenticate` naming `/.well-known/oauth-protected-resource/mcp`; `GET /.well-known/oauth-protected-resource/mcp` returns JSON whose `resource` equals the configured `mcp.resource`. Name the test `TestMCPEndToEnd` with sub-tests; Task 3 extends it with the Journal case.
</action>
<verify>
<automated>go -C ../sm-oauthserver-plugin vet ./... && go -C ../sm-oauthserver-plugin test -count=1 -short ./... && go -C ../sm-oauthserver-plugin test -count=1 -run '^TestMCPTokenVerifierSmoke$' -v . 2>&1 | grep -q -- '^--- PASS: TestMCPTokenVerifierSmoke' && (cd ../sm-demo-app && go vet ./... && go test -count=1 -short ./... && go build -tags summercms_mcp ./... && go test -count=1 -tags summercms_mcp -run '^TestMCPEndToEnd$' -v . 2>&1 | grep -q -- '^--- PASS: TestMCPEndToEnd')</automated>
<fails_when>non-zero exit, "FAIL" in the output, or either PASS line is absent (a SKIP for a missing Docker daemon counts as absent)</fails_when>
</verify>
<acceptance_criteria>
- `grep -c '"backend"' ../sm-oauthserver-plugin/servers.go` prints 1 and the OIDC `opts` line is unchanged (`grep -c "mcpOpts.ScopesSupported" ../sm-oauthserver-plugin/servers.go` prints 1)
- `grep -c "func (v \*MCPTokenVerifier) MCPVerifyToken(\|func (v \*MCPTokenVerifier) MCPResource(" ../sm-oauthserver-plugin/classes/mcp_verifier.go` prints 2 and `grep -c "ClientKindMCP" ../sm-oauthserver-plugin/classes/mcp_verifier.go` prints at least 1
- `grep -c "pact.MCPTokenVerifier" ../sm-oauthserver-plugin/plugin.go` prints at least 1
- `grep -c "not here" ../sm-oauthserver-plugin/README.md` prints 0 and `grep -c "backend" ../sm-oauthserver-plugin/README.md` prints at least 1
- `grep -c "summercms_mcp" ../sm-demo-app/summer.yaml` prints 1; `grep -c "enabled: true" ../sm-demo-app/config/mcp.yaml` prints 1; `grep -c "resource:" ../sm-demo-app/config/golem15.oauthserver.yaml` prints 1
- `head -1 ../sm-demo-app/mcp_e2e_test.go` prints `//go:build summercms_mcp`
- `(cd ../sm-demo-app && go test -count=1 -tags summercms_mcp -run '^TestMCPEndToEnd$' -v .) 2>&1 | grep -q -- '^--- PASS: TestMCPEndToEnd'` on a Docker host
- `(cd ../sm-demo-app && go test -count=1 -short ./...)` passes without the tag (the untagged demo is unchanged apart from the new config files)
</acceptance_criteria>
<done>The demo, built with the tag, serves /mcp; a real MCP access token from its own authorization server is verified at the resource and the frontend tool runs end to end; the backend scope is advertised.</done>
</task>
<task type="auto">
<name>Task 2: MCP consent JSON endpoints with the linked-admin line, revoked events, and the /connect and /link-admin pages in vue-demo-app</name>
<files>../sm-oauthserver-plugin/routes.go, ../sm-oauthserver-plugin/controllers/mcp_consent_api.go, ../sm-oauthserver-plugin/controllers/authorizations.go, ../sm-oauthserver-plugin/classes/cascade.go, ../sm-oauthserver-plugin/classes/subject_events.go, ../sm-oauthserver-plugin/lang/en/lang.yaml, ../sm-oauthserver-plugin/lang/pl/lang.yaml, ../sm-oauthserver-plugin/mcp_consent_smoke_test.go, ../sm-oauthserver-plugin/README.md, ../sm-demo-app/vue-demo-app/app/pages/connect.vue, ../sm-demo-app/vue-demo-app/app/pages/link-admin.vue, ../sm-demo-app/vue-demo-app/i18n/locales/en.json, ../sm-demo-app/vue-demo-app/i18n/locales/pl.json</files>
<read_first>
- ../sm-oauthserver-plugin/controllers/consent_api.go (ConsentShow, ConsentDecide, principalID, writeJSON) and routes.go 54-76 (the redirect-mode consent block and the MCP block)
- summercms.go/modules/wristband/consent.go 30-120 (PendingRequest, PendingRequestView, IssueCode, DenyPending, ErrNoGrantableScopes, ErrPendingNotFound) and authorize.go 165-180 (the `/connect?request=` redirect)
- ../fonoteka.go/plugins/golem15/fonoteka/controllers/api/oauth_consent_controller.go 1-140 (the MCP consent contract already proven in another application: PendingRequest, submitted ∩ requested, IssueCode, DenyPending)
- ../sm-oauthserver-plugin/controllers/authorizations.go 98-150 (AuthorizationsDestroy, revoke) and classes/cascade.go (OnUserDeleting, OnUserDeactivating, purge)
- summercms.go/modules/pact/mcp.go (MCPLinkedBackendResolver, LinkedBackendUser, MCPSubjectChanged, MCPSubjectRevoked, MCPSubjectDeleted)
- ../sm-demo-app/vue-demo-app/app/pages/login.vue (page shape, useDemoAuth, the `next` redirect rule), app/composables/useDemoAuth.ts (token cookie, login, logout, formErrors), i18n/locales/en.json `auth` block (key style), nuxt.config.ts 85-120 (runtimeConfig and the dev proxy of API paths to Go)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Open Question 7", § "Pattern 7" step 2-3, Security Domain row "Consent phishing"
</read_first>
<action>
oauthserver consent (P-16): `controllers.MCPConsentShow(app, srv)` and `controllers.MCPConsentDecide(app, srv)` in `mcp_consent_api.go`, mounted inside the `MCPEnabled` block of `Routes` as `r.GroupRaw("/", surf.Use("jwt.auth", authorize), ...)` with `g.Get("/oauth/mcp/requests/{request}", ...)` and `g.Post("/oauth/mcp/requests/{request}", ...)`. Show: `srv.PendingRequest(ctx, id, userID)`; `ErrPendingNotFound` → 404 `request_not_found`; body per P-16 where `backend_admin` is filled from `app.Lookup[pact.MCPLinkedBackendResolver]()` → `LinkedBackendUser(ctx, userID)` only when `backend` ∈ `view.ScopesRequested` and the resolver answers true, else JSON null. Decide: body up to 16 KiB `{decision, scopes}`; granted = (submitted ∩ requested, or requested when `scopes` is absent) minus `backend` when no link; `allow` → `srv.IssueCode(ctx, id, userID, granted, nil)` (`ErrNoGrantableScopes` → 422 `no_grantable_scopes`), else `srv.DenyPending`; answer `{redirect_uri}`; `writeJSON` keeps `Cache-Control: no-store, private`. Revoked events (D-26): `classes/subject_events.go` `FireSubjectChanged(ctx, app, "user", userID, kind)`; call with `pact.MCPSubjectRevoked` from `revoke` (authorizations destroy) and with `pact.MCPSubjectDeleted` from `OnUserDeleting` and `OnUserDeactivating` after the purge. README: the two routes (Routes table and the MCP paragraph), the `backend_admin` field, the events. Lang: none needed server-side (the page translates); add keys only if a server message is introduced. Smoke `TestMCPConsentSmoke` (Postgres): a pending MCP request for `read write backend`: show for a user without a link has `backend_admin: null`; decide allow grants `read write` only (the issued code's scopes exclude backend); with a link (seed through `*userclasses.BackendLinks`.SetLink, the plugin now requires the plan-03 user plugin) show carries the admin's login and name and decide grants `backend` too; deny answers an `error=access_denied` redirect; an unknown request is 404; a user other than the request's owner gets 404; `DELETE /oauth/authorizations/{client_id}` fires a `revoked` event (test listener).
vue-demo-app pages (in `../sm-demo-app/vue-demo-app`): `app/pages/connect.vue` reads `request` from the query; when not `loggedIn` it `navigateTo('/login?next=' + encodeURIComponent('/connect?request=' + request))` (the login page already honours a same-origin `next`); it fetches `GET /oauth/mcp/requests/{request}` with the `Authorization: Bearer` from `useDemoAuth().token`, renders the client name and redirect host, the requested scopes as a list with one explanatory line each (`connect.scope.read`, `.write`, `.ai`, `.offline_access`, `.backend`), and when `backend_admin` is present the line `connect.actAsAdmin` with the admin's name; when `backend` is requested without a link it shows `connect.noLinkedAdmin` (backend access will not be granted); Allow and Deny buttons POST the decision (Allow sends the full requested scope list) and `navigateTo(redirect_uri, { external: true })`; 404/410 show `connect.expired`; `useSeoMeta({ robots: 'noindex' })`. `app/pages/link-admin.vue` reads `code`; `GET /_user/api/v1/backend-link/{code}` → shows `linkAdmin.question` with the admin's name and the expiry; when not logged in, a button to `/login?next=/link-admin?code=...`; when logged in, a Confirm button POSTs `/_user/api/v1/backend-link/confirm` with the bearer; on `409 stale_session` it calls `logout()` and sends the user to `/login?next=...` with the message `linkAdmin.signInAgain` (D-05 fresh sign-in); `already_linked` and 404 show their messages; success shows `linkAdmin.done` with the admin's login; `robots: noindex`. i18n keys under `connect` and `linkAdmin` in en.json and pl.json. `npm --prefix ../sm-demo-app/vue-demo-app run test` (vitest) and `npm --prefix ../sm-demo-app/vue-demo-app run build` must pass; add a vitest case per page only if the demo's existing tests cover pages (otherwise rely on the build and the manual check in Task 5).
</action>
<verify>
<automated>go -C ../sm-oauthserver-plugin vet ./... && go -C ../sm-oauthserver-plugin test -count=1 -short ./... && go -C ../sm-oauthserver-plugin test -count=1 -run '^TestMCPConsentSmoke$' -v . 2>&1 | grep -q -- '^--- PASS: TestMCPConsentSmoke' && npm --prefix ../sm-demo-app/vue-demo-app run test && npm --prefix ../sm-demo-app/vue-demo-app run build</automated>
<fails_when>non-zero exit, "FAIL" in the Go output, a vitest summary that is not all passing, or a Nuxt build error</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "/oauth/mcp/requests/{request}" ../sm-oauthserver-plugin/routes.go` prints 2 and both lines sit inside the `MCPEnabled` block (`awk '/MCPEnabled/,/^\t}/' ../sm-oauthserver-plugin/routes.go | grep -c "mcp/requests"` prints 2)
- `grep -c "func MCPConsentShow(\|func MCPConsentDecide(" ../sm-oauthserver-plugin/controllers/mcp_consent_api.go` prints 2 and `grep -c "backend_admin" ../sm-oauthserver-plugin/controllers/mcp_consent_api.go` prints at least 1
- `grep -c "MCPLinkedBackendResolver" ../sm-oauthserver-plugin/controllers/mcp_consent_api.go` prints at least 1
- `grep -c "FireSubjectChanged(" ../sm-oauthserver-plugin/controllers/authorizations.go ../sm-oauthserver-plugin/classes/cascade.go` prints a non-zero count per file
- `test -f ../sm-demo-app/vue-demo-app/app/pages/connect.vue && test -f ../sm-demo-app/vue-demo-app/app/pages/link-admin.vue`
- `grep -c "oauth/mcp/requests" ../sm-demo-app/vue-demo-app/app/pages/connect.vue` prints at least 2 and `grep -c "backend-link" ../sm-demo-app/vue-demo-app/app/pages/link-admin.vue` prints at least 2
- `grep -c "stale_session" ../sm-demo-app/vue-demo-app/app/pages/link-admin.vue` prints 1 and `grep -c "noindex" ../sm-demo-app/vue-demo-app/app/pages/connect.vue ../sm-demo-app/vue-demo-app/app/pages/link-admin.vue` prints 1 per file
- `grep -c '"connect"' ../sm-demo-app/vue-demo-app/i18n/locales/en.json ../sm-demo-app/vue-demo-app/i18n/locales/pl.json` prints 1 per file and the same for `"linkAdmin"`
- `TestMCPConsentSmoke` prints `--- PASS` on a Docker host
</acceptance_criteria>
<done>The MCP consent is served as JSON with the linked-admin line and the backend scope is granted only with a link; grants and users that go away fire events; the demo site has the consent and link-proof pages.</done>
</task>
<task type="auto">
<name>Task 3: Journal's backend tools and prompt, the optionalBackendPrincipal fix, and the end-to-end case as the linked admin</name>
<files>../sm-journal-plugin/mcp.go, ../sm-journal-plugin/controllers/api/auth.go, ../sm-journal-plugin/README.md, ../sm-journal-plugin/go.mod, ../sm-journal-plugin/go.sum, ../sm-journal-plugin/mcp_smoke_test.go, ../sm-demo-app/mcp_e2e_test.go, ../sm-demo-app/plugins/golem15/journal, ../sm-demo-app/go.mod, ../sm-demo-app/go.sum</files>
<read_first>
- ../sm-journal-plugin/routes.go (the exact method+pattern of every bind target and the `slug`/`id` Where constraints), controllers/api/auth.go 60-100 (optionalBackendPrincipal, requireBackendPrincipal, permission constants), controllers/api/posts.go (Index query parameters, Store and Update body keys from posts_helpers.go: grep `body["` to list the accepted keys), plugin.go 125-150 (the journal-api bucket keyed by backend principal)
- summercms.go/modules/pact/mcp.go (MCPTool, MCPPrompt, the tag mapping rules in the doc comments) and modules/pier/example_mcp_test.go (the acme.blog example from plan 02)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Code Examples: Journal backend tools", § "Pitfall 6" (raw body forwarding; mark optional fields with omitempty or pointers), § "Pattern 6" (the optionalBackendPrincipal fix)
- ../sm-demo-app/mcp_e2e_test.go as left by Task 1; ../sm-demo-app/plugins/golem15/user (the plan-03 plugin: classes.BackendLinks.SetLink for seeding a link in the test)
</read_first>
<action>
Journal `mcp.go` (P-17): `(*Plugin) MCP()` declares the seven tools and one prompt. Input structs live in `mcp.go` with `jsonschema` descriptions: list posts `{ Page int `query:"page"`; PerPage int `query:"per_page"`; Search string `query:"search"`; Category string `query:"category"`; Tag string `query:"tag"`; Published *bool `query:"published"`; Sort string `query:"sort"` }` (match the names Index reads); show `{ Slug string `path:"slug"` }`; categories and tags `struct{}`; create `{ Title string; Slug string `json:"slug,omitempty"`; Content string; Excerpt string `json:"excerpt,omitempty"`; Published *bool `json:"published,omitempty"`; Categories []uint `json:"categories,omitempty"`; Tags []string `json:"tags,omitempty"` ... exactly the keys Store accepts }`; update `{ ID uint `path:"id"` plus the create fields all optional (pointers or omitempty, Pitfall 6) }`; delete `{ ID uint `path:"id"` }`. Every tool: `Guard: "backend"`, `Permissions: []string{permAccessPosts}` (export the constant or duplicate the string in mcp.go; do not change auth.go's constants), static Title and Description; delete sets `Destructive` true explicitly. Prompt `draft_post`: arguments `topic` (required), `tone`; `Render` returns one `user` message that asks for a post draft on the topic in the tone, with the site's style notes, and tells the agent to call `journal_create_post` with `published` false; `Guard: "backend"`, `Permissions: [permAccessPosts]`.
auth.go: `optionalBackendPrincipal` drops the `!hasBearer(r)` short-circuit (keep the nil check); `ResolveBackend` already answers `ErrUnauthenticated` for a missing bearer, so anonymous behaviour is identical and a dispatched request sees the marker (D-17). Nothing else in auth.go changes. `go.mod`: require the plan-02 framework tag; `go mod tidy` (the plugin's own go.work replaces the framework with `../summercms.go`). README: Features (the MCP tools and prompt, the guard and permission), a short "MCP tools" section listing the exposed names. Smoke `TestJournalMCPSmoke` (-short, no Docker): `MCP()` lists exactly the seven names and the prompt; every tool's Method+Path matches a route the plugin registers (build a `surf.BuildRouter` with the plugin and compare); `optionalBackendPrincipal` with a request carrying a backend dispatch marker returns a request whose context holds the principal, and with no bearer and no marker returns the request unchanged.
Demo e2e extension (`mcp_e2e_test.go`, Journal submodule moved to the new commit per P-18): seed an admin with `golem15.journal.access_posts` (role or override) and link the frontend user to it through `*userclasses.BackendLinks`.SetLink; mint a token with scopes `read write backend`: `ListTools` now contains `journal_create_post` and `journal_list_posts`; `CallTool("journal_create_post", {title, content, published: false})` answers `isError false` and the post row's author is the admin's id; `CallTool("journal_show_post", {slug})` returns it (a draft is visible to the editor through the marker); a token with `read write` only (no `backend`) lists no `journal_` tool and a call to `journal_create_post` is refused; after `RemoveLink` the next `ListTools` has no `journal_` tool. The unlink-removes-tools and revoke matrix is completed in plan 05; here one unlink case suffices.
</action>
<verify>
<automated>go -C ../sm-journal-plugin vet ./... && go -C ../sm-journal-plugin test -count=1 -short ./... && go -C ../sm-journal-plugin test -count=1 -short -run '^TestJournalMCPSmoke$' -v . 2>&1 | grep -q -- '^--- PASS: TestJournalMCPSmoke' && (cd ../sm-demo-app && go test -count=1 -tags summercms_mcp -run '^TestMCPEndToEnd$' -v . 2>&1 | grep -q -- '^--- PASS: TestMCPEndToEnd')</automated>
<fails_when>non-zero exit, "FAIL" in the output, or either PASS line is absent (SKIP without Docker counts as absent for TestMCPEndToEnd)</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "Name: *\"\(list_posts\|show_post\|list_categories\|list_tags\|create_post\|update_post\|delete_post\|draft_post\)\"" ../sm-journal-plugin/mcp.go` prints 8
- `grep -c "golem15.journal.access_posts\|permAccessPosts" ../sm-journal-plugin/mcp.go` prints at least 8
- `grep -c "hasBearer(r)" ../sm-journal-plugin/controllers/api/auth.go` prints 0 inside optionalBackendPrincipal (`awk '/^func optionalBackendPrincipal/,/^}/' ../sm-journal-plugin/controllers/api/auth.go | grep -c hasBearer` prints 0) while `func hasBearer` still exists
- `git -C ../sm-journal-plugin diff ffa2c8f -- routes.go | wc -l` prints 0 (no route changed)
- `grep -c "git.golem15.com/golem15/summercms <plan-02 tag>" ../sm-journal-plugin/go.mod` prints 1 (substitute the recorded tag)
- `grep -c "journal_create_post" ../sm-demo-app/mcp_e2e_test.go` prints at least 2
- Both named tests print `--- PASS` (the e2e on a Docker host)
</acceptance_criteria>
<done>Journal exposes its post tools and a prompt to linked admins only, list and show see the dispatched principal, and the demo proves a frontend sign-in with a link and the backend scope creates a post as the admin while unlinking removes the tools.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 4: Give the go-ahead for every push of Task 5: tag and push oauthserver and Journal, push vue-demo-app</name>
<decision>One go-ahead covering exactly the three pushes Task 5 performs, in three repositories: (1) sm-oauthserver-plugin (backend scope, oas_at_ verifier, MCP consent JSON, revoked events) — `git push origin master --tags` with its new tag; (2) sm-journal-plugin (MCP tools and prompt, optionalBackendPrincipal fix) — `git push origin main --tags` with its new tag; (3) vue-demo-app (the `/connect` consent page, the `/link-admin` proof page, the `connect.*` and `linkAdmin.*` i18n keys from Task 2) — `git -C ../sm-demo-app/vue-demo-app push origin master`, no tag. Both plugins are pinned to the plan-02 framework tag. The demo's three pointer bumps are local commits in sm-demo-app; sm-demo-app itself is neither pushed nor deployed in this plan (both are recorded in deferred-items.md for a separate go-ahead).</decision>
<context>Both plugin releases are additive (plan 05's gate proves no removed export since d31f8e7 and ffa2c8f). Proposed versions (P-20): oauthserver v0.1.2, Journal v0.2.3. The demo then pins both tags in two commits (go.mod, go.sum, submodule pointer each) and the pushed vue-demo-app commit in a third. Pre-checks before asking: clean trees in both plugin repos and in `../sm-demo-app/vue-demo-app`, `go vet ./... && go test -count=1 ./...` on Docker in each plugin, `npm --prefix ../sm-demo-app/vue-demo-app run test` and `run build` green, READMEs updated, the demo e2e green with the submodules at the exact commits to be tagged and pushed. The checkpoint message lists the three repositories, their branches and the two versions so the answer names every push (CLAUDE.md: no push, tag or deploy without the user's go-ahead).</context>
<options>
<option id="tag-both">
<name>Tag oauthserver v0.1.2 and Journal v0.2.3 now and push all three repositories</name>
<pros>The demo can pin released versions and a pushed vue-demo-app commit; plan 05's consumers stage runs against tags</pros>
<cons>A later fix needs patch tags</cons>
</option>
<option id="hold">
<name>Hold both tags and the vue-demo-app push</name>
<pros>Review the two plugin diffs and the two pages first</pros>
<cons>The demo keeps pointing at unreleased, unpushed commits until you continue</cons>
</option>
</options>
<resume-signal>Answer tag-both (optionally with other version numbers; tag-both covers the vue-demo-app push as well) or hold</resume-signal>
</task>
<task type="auto">
<name>Task 5: Release both plugins, pin them in the demo, document nginx and deploy, and hand the demo to a real MCP client</name>
<reversibility rating="one-way">Pushed plugin tags are pinned by the demo and announced; the pushed vue-demo-app commit publishes the consent and link pages; the nginx locations open the MCP paths on the public demo once deployed.</reversibility>
<precondition>The Task 4 checkpoint answered tag-both (or named versions); `git -C ../sm-oauthserver-plugin status --short`, `git -C ../sm-journal-plugin status --short` and `git -C ../sm-demo-app/vue-demo-app status --short` are empty; `git -C ../sm-demo-app status --short` shows only this plan's files</precondition>
<files>../sm-oauthserver-plugin/go.mod, ../sm-oauthserver-plugin/go.sum, ../sm-journal-plugin/go.mod, ../sm-journal-plugin/go.sum, ../sm-demo-app/go.mod, ../sm-demo-app/go.sum, ../sm-demo-app/plugins/golem15/oauthserver, ../sm-demo-app/plugins/golem15/journal, ../sm-demo-app/vue-demo-app, ../sm-demo-app/deploy/nginx/demo.summercms.io.conf, ../sm-demo-app/DEPLOY.md, ../sm-demo-app/config/http.yaml, .planning/phases/19.7-generic-mcp-module/deferred-items.md</files>
<read_first>
- ../sm-demo-app/deploy/nginx/demo.summercms.io.conf (the allow-listed Go locations 90-200; copy the `/_demo/` block's proxy settings for the new locations; the `/` fallback to Nuxt)
- ../sm-demo-app/DEPLOY.md § "Overview" 12-50 (which paths reach Go), § "Build" 325-352, § "Release" 353-414, § "Verify", § "Secrets"; ../sm-demo-app/scripts/check-deploy.sh (nginx -t, route checks of deploy/)
- ../sm-demo-app/config/http.yaml (cors.paths: the MCP path needs no CORS entry since pier handles Origin itself; confirm nothing else is required)
- .planning/notes/core-plugins-own-repos.md and CLAUDE.md § "Sibling repositories"
- .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md § "Manual-Only Verifications" (the real-client row)
- summercms.go/docs/services/mcp.md § Operations (plan 02)
</read_first>
<action>
Releases: in each plugin repo `go.mod` already requires the plan-02 tag (Tasks 1-3); run the pre-checks, write the annotated tag message, `git tag -a <version>` and `git push origin <branch> --tags` (oauthserver master, Journal main). Then `git -C ../sm-demo-app/vue-demo-app push origin master` for the Task 2 commit with the `/connect` and `/link-admin` pages (no tag). These three pushes are exactly the ones the Task 4 go-ahead named; no other repository is pushed by this task. Demo pins, three local commits in sm-demo-app: `chore: bump oauthserver to <v>` (go.mod require, go.sum, submodule at the tag), `chore: bump journal to <v>`, `chore: bump vue-demo-app (MCP consent and link pages)` (the submodule at the pushed commit). sm-demo-app itself is not pushed and not deployed here; both wait for the user's go-ahead and go to deferred-items.md below. Verify `go build -tags summercms_mcp ./... && go test -count=1 -short ./...` in the demo after each pin.
nginx (`deploy/nginx/demo.summercms.io.conf`): add Go locations `location = /mcp` (proxy with `proxy_buffering off`, `proxy_read_timeout 1h`, `proxy_http_version 1.1`, `chunked_transfer_encoding on` for SSE), `location ^~ /.well-known/oauth-protected-resource`, `location = /.well-known/oauth-authorization-server`, and `location ^~ /oauth/mcp/` (authorize, register, token and the consent JSON), each with the same `proxy_pass` and headers as the existing Go blocks (the ACME location stays first); run `scripts/check-deploy.sh`. DEPLOY.md: a new section "MCP endpoint" after Realtime: what is mounted, the `summercms_mcp` build tag already in `summer.yaml`, the `.env` keys (`SUMMER_MCP__RESOURCE=https://demo.summercms.io/mcp`, `SUMMER_GOLEM15__OAUTHSERVER__MCP__RESOURCE` the same, `SUMMER_MCP__SESSIONS__STORE=memory` with the Redis alternative per P-19), the nginx install step (reuse the "When deploy/nginx/... changed" instructions), how an editor connects (`https://demo.summercms.io/mcp`, OAuth sign-in, `/connect`, linking an admin from My account), and a smoke (`curl -sS https://demo.summercms.io/.well-known/oauth-protected-resource/mcp`). Update the Overview sentence that says `/oauth` and `/.well-known` are not routed to Go. Record the unresolved operational items in `.planning/phases/19.7-generic-mcp-module/deferred-items.md` (framework repo): pushing sm-demo-app's three pointer commits and the deploy itself (each needs the user's go-ahead), and Redis on rome if a second instance is ever added.
Local hand-off for the manual check: build the demo (`summer build` in the demo), start it against the compose Postgres with `.env` values for the resource URLs pointing at `http://127.0.0.1:8097/mcp`, start the Nuxt site (`npm --prefix ../sm-demo-app/vue-demo-app run dev`), seed through `demo:seed`, create a frontend user and an admin with Journal access, and leave both processes running for the human check below. Stop them after the check.
</action>
<verify>
<automated>git -C ../sm-oauthserver-plugin describe --tags --exact-match HEAD && git -C ../sm-journal-plugin describe --tags --exact-match HEAD && (cd ../sm-demo-app && bash scripts/check-deploy.sh && go build -tags summercms_mcp ./... && go test -count=1 -short ./... && git diff --quiet HEAD -- go.mod go.sum plugins/golem15/oauthserver plugins/golem15/journal vue-demo-app)</automated>
<fails_when>non-zero exit: a plugin HEAD is not tagged, check-deploy reports an nginx or route problem, the demo fails to build or test, or a pin is uncommitted</fails_when>
<human-check>With the demo and site running locally: add `http://127.0.0.1:8097/mcp` to an MCP client (Claude Desktop or Claude Code), complete the OAuth sign-in on the `/connect` page as the frontend user (requesting `backend`), see only `user_me`; in the admin's My account click "Link frontend account", finish on `/link-admin` with a fresh sign-in, reconnect (new consent shows "also act as admin <name>"), see the `journal_` tools, create a draft post and find it in the admin; unlink and confirm the Journal tools disappear.</human-check>
</verify>
<acceptance_criteria>
- `git -C ../sm-oauthserver-plugin describe --tags --exact-match HEAD` and `git -C ../sm-journal-plugin describe --tags --exact-match HEAD` print the chosen versions and `git ls-remote --tags origin` in each repo lists them
- `grep -c "sm-oauthserver-plugin <v>" ../sm-demo-app/go.mod` prints 1 and `grep -c "sm-journal-plugin <v>" ../sm-demo-app/go.mod` prints 1 (substitute the chosen versions)
- `grep -c "location = /mcp\|oauth-protected-resource\|oauth-authorization-server\|location ^~ /oauth/mcp/" ../sm-demo-app/deploy/nginx/demo.summercms.io.conf` prints at least 4 and `grep -c "proxy_buffering off" ../sm-demo-app/deploy/nginx/demo.summercms.io.conf` prints at least 1
- `grep -c "## MCP endpoint" ../sm-demo-app/DEPLOY.md` prints 1 and `grep -c "SUMMER_MCP__RESOURCE" ../sm-demo-app/DEPLOY.md` prints at least 1
- `(cd ../sm-demo-app && bash scripts/check-deploy.sh)` exits 0
- `test -f .planning/phases/19.7-generic-mcp-module/deferred-items.md`
</acceptance_criteria>
<done>Both plugins are released and pinned by the demo, the deploy path for the MCP endpoint is documented and checked, and a real MCP client has been connected locally through OAuth, the link and the backend scope.</done>
</task>
</tasks>
<artifacts_this_phase_produces>
## Artifacts this plan produces
**sm-oauthserver-plugin** (`git.golem15.com/golem15/sm-oauthserver-plugin`): `classes.MCPTokenVerifier` (published as `pact.MCPTokenVerifier`), `controllers.MCPConsentShow`, `controllers.MCPConsentDecide`, `classes.FireSubjectChanged`; routes `GET|POST /oauth/mcp/requests/{request}` (jwt.auth, throttle:oauth-authorize); the `backend` scope in the MCP server's `ScopesSupported`; consent body field `backend_admin`; release v0.1.2 (proposed)
**sm-journal-plugin** (`git.golem15.com/golem15/sm-journal-plugin`): `mcp.go` with `(*Plugin) MCP()`; tools `journal_list_posts`, `journal_show_post`, `journal_list_categories`, `journal_list_tags`, `journal_create_post`, `journal_update_post`, `journal_delete_post`; prompt `journal_draft_post`; `optionalBackendPrincipal` honours the marker; release v0.2.3 (proposed)
**sm-demo-app**: `summer.yaml` `build.tags: [summercms_mcp]`; `config/mcp.yaml`, `config/golem15.oauthserver.yaml`; regenerated `plugins.gen.go`, `main.go`; `mcp_e2e_test.go` (`TestMCPEndToEnd`, tagged); nginx locations `/mcp`, `/.well-known/oauth-protected-resource*`, `/.well-known/oauth-authorization-server`, `/oauth/mcp/`; DEPLOY.md "MCP endpoint"; pointer bumps for oauthserver, journal, vue-demo-app
**vue-demo-app**: pages `/connect` (`app/pages/connect.vue`) and `/link-admin` (`app/pages/link-admin.vue`); i18n keys `connect.*`, `linkAdmin.*` (en, pl)
**Env keys documented**: `SUMMER_MCP__RESOURCE`, `SUMMER_GOLEM15__OAUTHSERVER__MCP__RESOURCE`, `SUMMER_MCP__SESSIONS__STORE`, `SUMMER_REDIS__URL`
</artifacts_this_phase_produces>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| MCP client to the authorization server | DCR clients request scopes including `backend`; tokens are minted and later presented at `/mcp` |
| browser to the consent and link pages | the signed-in frontend user's decisions and the one-shot link code |
| pier to the oauthserver verifier | every `/mcp` request's bearer is judged here |
| internet to nginx to Go | the MCP paths become public on the demo |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.7-30 | Spoofing | audience confusion at the verifier | high | mitigate | Only `oas_at_` tokens pass the prefix gate; the row's client must exist with `kind = mcp` and not be revoked; an OIDC token or a foreign-kind client's token is `ErrMCPTokenInvalid` (`TestMCPTokenVerifierSmoke`) |
| T-19.7-31 | Elevation | consent phishing for the backend scope | high | mitigate | The consent page shows client name, redirect host and the "also act as admin <name>" line only with a verified link; `backend` is granted only when a link exists at consent (A8); the scope is visible and revocable per grant (`TestMCPConsentSmoke`) |
| T-19.7-32 | Elevation | consent decided for another user's request | medium | mitigate | `PendingRequest`/`IssueCode`/`DenyPending` resolve the request for the acting JWT principal only (`lookupOwnedPending`); a foreign user gets 404; decisions are POST behind `jwt.auth` with `no-store` answers |
| T-19.7-33 | Elevation | submitted scopes beyond the request | medium | mitigate | granted = submitted ∩ requested (∩ the allow-list wristband already applied), minus `backend` without a link; an empty grant is 422 `no_grantable_scopes` |
| T-19.7-34 | Spoofing | superuser reach through an agent (D-22) | high | mitigate | The backend principal is the admin's real principal (superuser included) by decision; the D-20 ceiling and `backend` scope cap it; every call is audited with admin_id and client_id; plan 05's security review weighs an optional superuser refusal switch and records the verdict |
| T-19.7-35 | Information Disclosure | revoked grant keeps a live session | medium | mitigate | `AuthorizationsDestroy` and the user cascade fire `revoked`/`deleted` events that end sessions on every instance; the verifier refuses the revoked token on the very next request regardless |
| T-19.7-36 | Tampering | partial update tools zeroing fields | medium | mitigate | Update input fields are pointers or `omitempty`; pier forwards the agent's raw JSON minus path keys, so Journal's key-presence checks see only sent keys (Pitfall 6) |
| T-19.7-37 | Denial of Service | public `/mcp` and SSE through nginx | medium | mitigate | `mcp.throttle` inline limiter, idle TTL and per-binding cap in pier; nginx `proxy_read_timeout` bounded; only the listed MCP paths are opened |
| T-19.7-38 | Spoofing | open redirect from the consent page | low | mitigate | The page navigates only to the `redirect_uri` the server returns from `IssueCode`/`DenyPending`, which wristband built from the client's registered URI; the `next` parameter stays same-origin as on the login page |
</threat_model>
<verification>
- `go -C ../sm-oauthserver-plugin vet ./... && go -C ../sm-oauthserver-plugin test -count=1 -short ./...`; Docker: `go -C ../sm-oauthserver-plugin test -count=1 ./...` with `TestMCPTokenVerifierSmoke` and `TestMCPConsentSmoke` passing
- `go -C ../sm-journal-plugin vet ./... && go -C ../sm-journal-plugin test -count=1 -short ./...` with `TestJournalMCPSmoke` passing
- `(cd ../sm-demo-app && go vet ./... && go test -count=1 -short ./... && go build -tags summercms_mcp ./...)`; Docker: `go test -count=1 -tags summercms_mcp -run '^TestMCPEndToEnd$' -v .` passing
- `npm --prefix ../sm-demo-app/vue-demo-app run test && npm --prefix ../sm-demo-app/vue-demo-app run build`
- `(cd ../sm-demo-app && bash scripts/check-deploy.sh)`
- The human check of Task 5 with a real MCP client
</verification>
<success_criteria>
- SC-4 is demonstrated end to end in the demo by `TestMCPEndToEnd` and by the real-client check: one OAuth sign-in, a verified link, the backend scope, Journal tools as the admin, removal on unlink
- oauthserver and Journal diffs against d31f8e7 and ffa2c8f remove no route, export, scope or payload field
- The demo without the tag or with `mcp.enabled` false behaves as before
- Planner decisions P-16..P-20 are implemented as written and named in the SUMMARY
</success_criteria>
<output>
Create `.planning/phases/19.7-generic-mcp-module/19.7-04-SUMMARY.md` (framework repo, planning docs commit) when done, recording the plugin versions and the demo pins.
</output>

View File

@@ -0,0 +1,309 @@
---
phase: 19.7-generic-mcp-module
plan: 05
type: execute
wave: 5
depends_on: ["19.7-04"]
files_modified:
- scripts/check-phase19.7.sh
- modules/pier/helpers_test.go
- modules/pier/catalog_test.go
- modules/pier/dispatch_test.go
- modules/pier/guard_rules_test.go
- modules/pier/tools_list_test.go
- modules/pier/sessions_test.go
- modules/pier/fanout_test.go
- modules/bouncer/dispatch_test.go
- modules/cabana/dispatch_marker_test.go
- modules/cabana/account_contributions_test.go
- modules/cabana/record_action_prompt_test.go
- modules/surf/streaming_test.go
- modules/surf/pier_mount_test.go
- modules/wristband/mcp_scopes_test.go
- admin/tests/account/AccountContributions.test.ts
- admin/tests/form/RecordActionsPrompt.test.ts
- ../sm-demo-app/plugins/golem15/user/backend_link_test.go
- ../sm-demo-app/plugins/golem15/user/frontend_permission_catalog_test.go
- ../sm-demo-app/plugins/golem15/user/mcp_guard_test.go
- ../sm-oauthserver-plugin/mcp_verifier_test.go
- ../sm-oauthserver-plugin/mcp_consent_test.go
- ../sm-journal-plugin/mcp_test.go
- ../sm-demo-app/mcp_e2e_test.go
- .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md
- .planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md
- .planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md
- .planning/phases/19.7-generic-mcp-module/deferred-items.md
- .planning/todos/pending/2026-10-17-plugin-registered-frontend-permissions.md
- .planning/todos/pending/2026-10-17-frontend-backend-account-link.md
- .planning/todos/done/2026-10-17-plugin-registered-frontend-permissions.md
- .planning/todos/done/2026-10-17-frontend-backend-account-link.md
autonomous: true
requirements: [SC-1, SC-2, SC-3, SC-4, D-05, D-08, D-17, D-20, D-21, D-22, D-25, D-26, D-27, D-31, D-36]
estimate:
tokens: 90000
raw_tokens: 90000
tasks: 4
confidence: low
must_haves:
truths:
- "Every behaviour row of 19.7-VALIDATION.md has a named test that the phase gate requires by name, and the gate refuses a skipped, zero-match or missing run (D-31 unit tests last; SC-1..SC-4)"
- "scripts/check-phase19.7.sh --all passes on a Docker host: framework, the three plugins with their additive-export checks, the consumers at their bumped pins, the admin build and OpenAPI, the docs, and the marker rule that only modules/pier calls the bouncer dispatch setter (D-17, D-31)"
- "The security review covers the link proof, the dispatch marker, session binding, the scope ceilings and superuser reach against every threat of plans 01-04 with file, line and pinning test; gaps are fixed in their own commits and the superuser verdict is recorded (D-05, D-17, D-22, D-25, D-20/D-21)"
- "The demo end-to-end test proves that removing the link or revoking the grant removes the backend tools and that a read-only grant hides write tools (SC-4, D-08, D-20, D-26)"
artifacts:
- path: "scripts/check-phase19.7.sh"
provides: "the fail-closed multi-repo phase gate"
contains: "--self-test"
- path: "modules/pier/helpers_test.go"
provides: "fake guard provider, fake verifier, two-instance miniredis harness, bearer-injecting SDK client"
contains: "miniredis"
- path: ".planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md"
provides: "the per-threat evidence table"
contains: "T-19.7-01"
- path: ".planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md"
provides: "the phase security contract with threats_open"
contains: "threats_open"
- path: ".planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md"
provides: "the filled per-task verification map"
contains: "nyquist_compliant: true"
key_links:
- from: "scripts/check-phase19.7.sh"
to: "modules/pier/tools_list_test.go"
via: "the go stage's required-name list includes TestToolsList"
pattern: "TestToolsList"
- from: "scripts/check-phase19.7.sh"
to: "modules/bouncer/dispatch.go"
via: "the marker stage greps for callers of the setter outside modules/pier and tests"
pattern: "marker"
- from: ".planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md"
to: "19.7-0{1,2,3,4}-PLAN.md threat registers"
via: "one row per T-19.7-NN with implementation and test references"
pattern: "T-19.7-"
---
<objective>
The phase's last plan, by project rule: unit tests for every behaviour row of `19.7-VALIDATION.md` across the framework, the three plugins and the demo; the pier test helpers VALIDATION lists as Wave 0; the additive-API checks for sm-user-plugin, sm-journal-plugin and sm-oauthserver-plugin; the fail-closed multi-repo gate `scripts/check-phase19.7.sh` (modelled on `check-phase19.4.sh` and `check-phase19.6.1.sh`) with a `marker` stage for D-17; and the security review of threats T-19.7-01..T-19.7-41 and T-19.7-SC from plans 01-04, written as `19.7-SECURITY.md` and `19.7-SECURITY-REVIEW.md` in the 19.4 shape. Earlier plans carried smoke tests; this plan turns them into the named tests the gate requires and adds the matrices they left out.
**Planner decisions recorded here:**
- **P-21 (gate shape):** stages `self-test`, `go`, `plugins`, `consumers`, `docker`, `admin`, `docs`, `marker`; `--all` runs them in that order with `docker` last and NOT RUN when no daemon answers (a failure with `PHASE197_REQUIRE_DOCKER=1`). Environment overrides `PHASE197_ROOT`, `USER_PLUGIN` (default `$ROOT/../sm-demo-app/plugins/golem15/user`), `OAUTHSERVER_PLUGIN` (`$ROOT/../sm-oauthserver-plugin`), `JOURNAL_PLUGIN` (`$ROOT/../sm-journal-plugin`), `DEMO_APP` (`$ROOT/../sm-demo-app`), `FONOTEKA` (`$ROOT/../fonoteka.go`), `BM_APP` (`$ROOT/../sm-bm-app`), additive bases `PHASE197_USER_BASE=930b158`, `PHASE197_OAS_BASE=d31f8e7`, `PHASE197_JOURNAL_BASE=ffa2c8f`.
- **P-22 (security review output):** two files as in 19.4: `19.7-SECURITY.md` (frontmatter with `threats_open`, trust boundaries, register, accepted risks) and `19.7-SECURITY-REVIEW.md` (method, gaps fixed with commits, the evidence table). ASVS L1; `high` threats block until verified or fixed.
- **P-23 (superuser reach, D-22 and T-19.7-34):** the review decides between "accepted as designed with audit and ceiling" and "add `mcp.refuse_superuser_backend` (default false)". If it adds the switch, that is a framework `fix(pier)` commit plus README and docs, and the needed patch tag is recorded in deferred-items for the user's go-ahead (no tag or push happens in this plan without a dynamic blocking-human checkpoint).
Purpose: SC-4's "security review" and "unit tests are the last plan" become true; `/msd-verify-work` has one green gate to run.
Output: named tests in six repositories, the gate script, the filled validation map, the two security documents, and any fix commits the review needed.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@.planning/PROJECT.md
@.planning/ROADMAP.md
@.planning/STATE.md
@.planning/phases/19.7-generic-mcp-module/19.7-CONTEXT.md
@.planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md
@.planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md
@.planning/phases/19.7-generic-mcp-module/19.7-01-SUMMARY.md
@.planning/phases/19.7-generic-mcp-module/19.7-02-SUMMARY.md
@.planning/phases/19.7-generic-mcp-module/19.7-03-SUMMARY.md
@.planning/phases/19.7-generic-mcp-module/19.7-04-SUMMARY.md
@.planning/phases/19.4-oidc-provider-on-wristband/19.4-SECURITY.md
@.planning/phases/19.4-oidc-provider-on-wristband/19.4-SECURITY-REVIEW.md
@CLAUDE.md
</context>
<project_rules>
- Tests only, plus the gate, the validation map and the security documents; a production fix found by a test or the review goes in its own `fix(<module or plugin>)` commit in the owning repository (as 19.6.1-03 did), never mixed with a test commit.
- No `t.Parallel` on Postgres tests; unique seeded rows and cleanup; Docker suites skip under `-short` and the user plugin runs with `GOWORK=off`.
- Gate scripts list every required test by name and refuse skipped, zero-match or missing runs (`REQUIRE_TESTS` + `go test -json` detector copied from check-phase19.4.sh; vitest detector from check-phase19.6.1.sh).
- Stage by explicit path; no co-author tags; planning docs (VALIDATION, SECURITY, deferred-items) in their own commits; no push or tag in this plan (a needed re-tag is recorded and raised as a blocking-human checkpoint).
</project_rules>
<tasks>
<task type="tracer">
<name>Task 1: Tracer: the gate script runs its self-test and go stage end to end against the first required framework tests, built on the pier test helpers</name>
<files>scripts/check-phase19.7.sh, modules/pier/helpers_test.go, modules/pier/tools_list_test.go, modules/bouncer/dispatch_test.go, modules/cabana/dispatch_marker_test.go</files>
<read_first>
- scripts/check-phase19.4.sh (header, env overrides, REQUIRE_TESTS and the go -json detector `detect_go`, the additive `removed_exports` check at 385-480, `docker_gate`, `--self-test`, `--all`) and scripts/check-phase19.6.1.sh (admin stage with the vitest detector, docs stage, the required-name arrays, `PHASE1961_*`)
- modules/pier/tracer_smoke_test.go, sessions_smoke_test.go, stateless_smoke_test.go (plan 02: the fakes and harness pieces to lift into helpers_test.go)
- modules/surf/dispatch_smoke_test.go, modules/cabana/dispatch_smoke_test.go, modules/bouncer/dispatch_smoke_test.go (plan 01)
- modules/cabana/administrators_harness_test.go (screensEnv on Postgres for the cabana marker test's Postgres part)
- .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md (the behaviour → test map and the Wave 0 list)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Validation Architecture" and Security Domain rows "Forged dispatch marker", "Frontend marker accepted by a backend guard"
</read_first>
<action>
`modules/pier/helpers_test.go` (package pier, Wave 0): `fakeGuard` (configurable name, token-guarded middleware names, requirement parser, an `allow func(subject, req, perms) bool` and a dispatch principal builder), `fakeVerifier` (map token → `pact.MCPGrant`, `MCPResource`), `fakeLinkResolver`, `fakePersonalResolver`, `newInstance(t, store Store, plugins...)` returning an `httptest.Server` whose handler is a surf router with pier mounted (through the in-test Host adapter plan 02 used), `twoInstances(t)` sharing one `miniredis` (`newRedisStore` on `redis.NewClient` pointed at it), `sdkClient(t, baseURL, bearer, protocolVersion)` returning a connected `*mcp.ClientSession` with a bearer-injecting RoundTripper and optional `ToolListChangedHandler` channel, and `fireSubjectChanged(app, guard, id, kind)`. Move the plan-02 smokes onto these helpers without changing what they assert.
First required tests: `modules/pier/tools_list_test.go` `TestToolsList` (SC-3, D-20, D-23): per-principal lists for two identities on one instance differ; a read-only grant lists only ReadOnlyHint tools; a tool whose guard has no subject is absent; `tools/call` of an unlisted tool answers a JSON-RPC error and the route handler is never reached (counter); the union of both guards' tools for an identity with both subjects. `modules/bouncer/dispatch_test.go` `TestDispatchMarker` (D-17): `Registry.Middleware` honours a marker listing the guard name and ignores one that does not; a request with forged headers and cookies is authenticated by the guard, not the marker; a nil principal is ignored. `modules/cabana/dispatch_marker_test.go` `TestDispatchMarker` (same name, package cabana; Postgres through `newScreensEnv`): `ResolveBackend` with a backend marker returns the principal and a frontend marker is refused; through the assembled admin handler a request to an admin route with a marker in the context but no bearer is still 401 (the HTTP path never carries a marker); the Journal-shaped case: a plugin route that calls `ResolveBackend` inside its handler sees the dispatched principal.
`scripts/check-phase19.7.sh` (P-21): header comment listing the stages, `set -euo pipefail`, `unset FORCE_COLOR; export NO_COLOR=1`, the env overrides, the required-name arrays (`GO_TESTS` for -short framework tests across `./modules/pier ./modules/surf ./modules/bouncer ./modules/cabana ./modules/wristband ./modules/pact`, `DOCKER_TESTS`, `USER_TESTS`, `OAS_TESTS`, `JOURNAL_TESTS`, `DEMO_TESTS`, `ADMIN_FILES`), the detectors copied from 19.4/19.6.1 (`detect_go` on `go test -json`, the vitest detector), `run_go` (go vet ./..., go test -count=1 -short ./..., go -C examples/hello test, `go build -tags summercms_mcp ./...`, the hello binary without the SDK, then `GO_TESTS` by name), the `marker` stage (every non-test .go file under modules/ outside modules/pier and modules/bouncer calling the bouncer dispatch setter fails the stage; `go list -deps ./modules/pact` must not list the SDK, jsonschema-go or modules/bouncer), `--self-test` proving the detectors on planted output and the docker NOT RUN rule, and stubs for `plugins`, `consumers`, `docker`, `admin`, `docs` that Task 3 fills (a stub prints `TODO stage <name>` and exits 1 so `--all` cannot pass before Task 3). In this task `GO_TESTS` lists `TestToolsList`, `TestDispatchMarker` (bouncer and cabana -short parts), `TestPierTracerSmoke`, `TestPierSessionsSmoke`, `TestPierStatelessSmoke`, `TestDispatchSmoke`, `TestStreamingRouteSmoke`, `TestPierMountSmoke`, `TestMCPScopesSmoke`, `TestAccountContributionsSmoke`, `TestRecordActionPromptSmoke`; Task 2 appends the rest.
</action>
<verify>
<automated>bash scripts/check-phase19.7.sh --self-test && bash scripts/check-phase19.7.sh --go && bash scripts/check-phase19.7.sh --marker</automated>
<fails_when>non-zero exit, or a stage line printing FAIL, "refuse:" or "missing-named"</fails_when>
</verify>
<acceptance_criteria>
- `test -x scripts/check-phase19.7.sh` and `grep -c "self-test\|--all\|REQUIRE_TESTS\|PHASE197_REQUIRE_DOCKER" scripts/check-phase19.7.sh` prints at least 4
- `grep -c "TestToolsList\|TestDispatchMarker" scripts/check-phase19.7.sh` prints at least 2
- `grep -c "func TestToolsList(" modules/pier/tools_list_test.go` prints 1 and `grep -c "miniredis" modules/pier/helpers_test.go` prints at least 1
- `grep -c "func TestDispatchMarker(" modules/bouncer/dispatch_test.go modules/cabana/dispatch_marker_test.go` prints 1 per file
- `bash scripts/check-phase19.7.sh --self-test` prints PASS for every planted detector case and exits 0
- `bash scripts/check-phase19.7.sh --go` exits 0 and `bash scripts/check-phase19.7.sh --all` exits non-zero while the Task 3 stubs remain (printed as `TODO stage`)
</acceptance_criteria>
<done>The gate exists with proven detectors and a green go stage over the pier helpers, TestToolsList and the two TestDispatchMarker tests; the remaining stages are explicit stubs.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: Framework unit tests for every VALIDATION row: catalog, dispatch, guard rules, sessions, fan-out, streaming, mount, scopes, account contributions, prompted actions; the SPA tests</name>
<files>modules/pier/catalog_test.go, modules/pier/dispatch_test.go, modules/pier/guard_rules_test.go, modules/pier/sessions_test.go, modules/pier/fanout_test.go, modules/surf/streaming_test.go, modules/surf/pier_mount_test.go, modules/wristband/mcp_scopes_test.go, modules/cabana/account_contributions_test.go, modules/cabana/record_action_prompt_test.go, admin/tests/account/AccountContributions.test.ts, admin/tests/form/RecordActionsPrompt.test.ts, scripts/check-phase19.7.sh</files>
<behavior>
- TestCatalog: `acme.blog` → prefix `blog_`; two plugins with the same short code fail boot naming both; a name over 128 chars or with a dash fails; duplicate name within a plugin fails; a tool bound to an unregistered route fails naming method and path; a route without a token guard and no Guard fails (D-15) while the same route with `Guard: "backend"` compiles; an Input that is not a struct fails; a `path:"x"` tag without a `{x}` segment fails; a GET tool with a body-only field fails; annotations: GET → readOnly+idempotent, PUT → idempotent, DELETE → destructive, override `ReadOnly: ptr(false)` wins; prompt names prefixed and checked against tool names.
- TestDispatch: path and query fields fill the URL, the body is the raw JSON minus those keys (a field the agent omitted is absent from the body, Pitfall 6); `{id: "a/b"}` for a single segment is refused before dispatch; Authorization and Cookie set on the outer request never reach the inner handler; RemoteAddr, X-Forwarded-For and Accept-Language are copied; a 422 from the route becomes `isError true` with the exact body as text and as structuredContent; a 2xx array is wrapped as `{"data": [...]}`; a result over `mcp.max_result_bytes` is an isError with the fixed text; the per-call timeout cancels a hanging handler.
- TestGuardRules: `MCPRequirements` union with tool Permissions (D-16); `MCPTokenGuarded` false hides the route from binding without Guard; the built-in backend guard's `MCPAllows` with a scoped principal uses `ScopeLimitFor` per method.
- TestSessions: binding mismatch 403; DELETE then 404 on both instances; rehydration on the second instance serves a call; TTL expiry (miniredis FastForward) → 404 and the client re-initialises; `max_per_binding` → 429; the memory store passes the same cases on one instance.
- TestFanOut: permissions event → list_changed on the other instance and the removed tool is gone from the next list; link event → backend tools appear/disappear; revoked and deleted events end the session (404) and evict the stateless server; the 5 s link cache is bypassed by the link event.
- TestStreamingRoute (surf): the smoke's cases plus: a stream route keeps throttle, CORS profile headers and recordPattern; a buffered route's Flush remains a no-op.
- TestPierMount (surf): disabled → identical Routes(); enabled without tag → error naming `summercms_mcp`; (tagged build only) enabled → `/mcp` routes present with the stream flag and the PRM routes present; path collision with a plugin route → error naming the owner.
- TestMCPScopes (wristband): default server refuses `backend`; a server listing it accepts `read backend`, lists it in metadata; `openid` stays refused on the MCP flavour.
- TestAccountContributions (cabana): boot refusals (duplicate across plugins, non-identifier, nil Run, empty label); list filtering by Permissions and Applies; the action runs inside a transaction (TxFromContext present); 409 when Applies flips; interactiveOnly 403 for `g15_`; `/account*` and `/auth/me` payloads byte-identical to a recorded fixture from before the phase (compare against `git show 51d088a:modules/cabana/admin_openapi.go` types or a stored JSON fixture).
- TestRecordActionPrompt (cabana): prompt localized in the show payload; value trimmed and length-capped; non-string payload 422; action without Prompt still refuses payload; `RecordAction` wrapper passes an empty Value.
- Vitest: AccountContributions.test.ts (full: empty, two sections, URL action opens a new tab and renders the link, 403 and 409 toasts, refetch) and RecordActionsPrompt.test.ts (input rendering, disabled confirm until typed, maxlength attribute, posted body, Enter confirms, 422 toast text).
</behavior>
<read_first>
- The plan 01 and 02 smoke tests and the helpers from Task 1 (extend, do not duplicate the fakes)
- modules/pier/*.go (the behaviour under test), modules/cabana/account_contributions.go, modules/cabana/actions.go, modules/surf/streaming.go, modules/wristband/authorize.go
- admin/tests/views/AccountView.test.ts and admin/tests/form/PreviewView.test.ts (test helpers and mocking patterns), admin/tests/helpers.ts
- .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md per-task map (the exact test names the rows expect)
</read_first>
<action>
Write the tests listed in the behavior block with exactly the VALIDATION names (`TestCatalog`, `TestDispatch`, `TestGuardRules`, `TestSessions`, `TestFanOut`, `TestStreamingRoute`, `TestPierMount`, `TestMCPScopes`, `TestAccountContributions`, `TestRecordActionPrompt`); sub-tests carry the case names. Run each new test red-first where the behaviour is not yet pinned (most will pass at once because plans 01-02 built the behaviour; when one fails because the code is wrong, fix the code in a separate `fix(<module>)` commit before the test commit and record it in the SUMMARY as 19.6.1-03 did). Append every name to `GO_TESTS` in the gate (surf, wristband, cabana and pier packages) and the two vitest files to `ADMIN_FILES`; fill the `admin` stage now (typecheck, the vitest run with the required files, `scripts/check-admin-openapi.sh --check`, `scripts/check-admin-dist.sh`). Keep the smoke tests of plans 01-02 in place (they stay required too).
</action>
<verify>
<automated>go vet ./... && go test -count=1 -short ./modules/pier/... ./modules/surf/... ./modules/bouncer/... ./modules/cabana/... ./modules/wristband/... ./modules/pact/... && bash scripts/check-phase19.7.sh --go && bash scripts/check-phase19.7.sh --admin</automated>
<fails_when>non-zero exit, "FAIL" in the output, or a gate line printing FAIL, "refuse:" or "missing-named"</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "func Test\(Catalog\|Dispatch\|GuardRules\|Sessions\|FanOut\)(" modules/pier/*_test.go` prints 5 and `grep -c "func TestStreamingRoute(\|func TestPierMount(" modules/surf/*_test.go` prints 2 and `grep -c "func TestMCPScopes(" modules/wristband/mcp_scopes_test.go` prints 1 and `grep -c "func TestAccountContributions(\|func TestRecordActionPrompt(" modules/cabana/*_test.go` prints 2
- `grep -c "TestCatalog\|TestDispatch\b\|TestGuardRules\|TestSessions\|TestFanOut\|TestStreamingRoute\|TestPierMount\|TestMCPScopes\|TestAccountContributions\|TestRecordActionPrompt" scripts/check-phase19.7.sh` prints at least 10
- `grep -c "AccountContributions.test.ts\|RecordActionsPrompt.test.ts" scripts/check-phase19.7.sh` prints 2 and `grep -c "TODO stage admin" scripts/check-phase19.7.sh` prints 0
- `npm --prefix admin run test 2>&1 | grep -E 'Test Files +[0-9]+ passed' | grep -qv failed`
- Every production fix named in the SUMMARY has its own commit whose subject starts with `fix(` (`git log --oneline --grep '^fix(' 51d088a..HEAD` lists each of them and no test commit touches a non-test .go file)
</acceptance_criteria>
<done>Every framework row of the validation map has its named test, the gate requires each one, and the admin stage is live.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Plugin and demo tests, additive-export checks, consumers stage, docker and docs stages, and the filled validation map</name>
<files>../sm-demo-app/plugins/golem15/user/backend_link_test.go, ../sm-demo-app/plugins/golem15/user/frontend_permission_catalog_test.go, ../sm-demo-app/plugins/golem15/user/mcp_guard_test.go, ../sm-oauthserver-plugin/mcp_verifier_test.go, ../sm-oauthserver-plugin/mcp_consent_test.go, ../sm-journal-plugin/mcp_test.go, ../sm-demo-app/mcp_e2e_test.go, scripts/check-phase19.7.sh, .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md</files>
<behavior>
- TestBackendLink (user plugin, Postgres): request one-shot (second confirm 404), expiry (clock past `expires_at` → 404), fresh-iat rule (iat before created_at → 409 stale_session; equal or after → 200), 1:1 uniqueness on both sides (409 already_linked), admin `SetLink` records `linked_by` and fires `BackendLinkedEvent` and both subject events (test listeners), `RemoveLink` fires the unlinked events, `LinkedBackendUser` is false for a deactivated admin and for a soft-deleted admin, user deletion and deactivation remove the link and fire `deleted`, the show route exposes only login, name and expires_at.
- TestFrontendPermissionCatalog (Postgres): plugin codes after seeded rows in both editors, seeded wins on duplicate, a second plugin's duplicate of the first is dropped, saving a group with a plugin code persists it and `UserPermissionGrants` returns it (the route middleware would honour it).
- TestUserMCPGuard (Postgres): the smoke's cases plus: Requirements errors on an unknown `user.` middleware name; a soft-deleted user → Allows false; `MCPResolvePersonalToken` stamps `last_used_at`; the dispatch credential satisfies `Scope("read")` middleware when the subject has read and is refused for `write`.
- TestMCPTokenVerifier (oauthserver, Postgres): the smoke's cases plus: the `last_used_at` debounce window; `MCPResource` equals config; a token whose user was deactivated after minting is refused.
- TestMCPConsent (oauthserver, Postgres): the smoke's cases plus: submitted scopes outside the request are dropped; `scopes: []` on allow → 422 no_grantable_scopes; a replayed decide is 404; the show body has `Cache-Control: no-store, private`.
- TestJournalMCP (journal, -short): declarations compile against the plugin's routes; input structs' json keys ⊆ the keys Store/Update read (reflect over the struct and compare to a list extracted from posts_helpers.go constants or a literal list kept next to the test); the prompt renders with and without `tone`; `optionalBackendPrincipal` marker and no-bearer cases.
- TestMCPEndToEnd (demo, tagged, Postgres) extension: unlink → the SDK client's `ToolListChangedHandler` fires and the next list has no `journal_` tool; revoking the grant (`DELETE /oauth/authorizations/{client_id}` as the user, or the store's revoke) → the next call is 401 and the session is gone; a `read`-only grant with a link lists `journal_list_posts` but not `journal_create_post`; `allow_personal_tokens` false → a `usr_` token is 401 at /mcp.
</behavior>
<read_first>
- The plan 03 and 04 smoke tests (lift their seeds into shared test helpers in each repo rather than duplicating)
- scripts/check-phase19.4.sh 385-480 (the additive `removed_exports` check and its self-test) and 500-570 (docker_gate, NOT RUN rules)
- ../sm-demo-app/internal/demotest/postgres.go, ../sm-demo-app/mcp_e2e_test.go, ../sm-oauthserver-plugin/controllers/authorizations.go (revoke path)
- .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md (every row's Automated Command column must match the final names and commands)
</read_first>
<action>
Write the tests of the behavior block with the VALIDATION names (`TestBackendLink`, `TestFrontendPermissionCatalog`, `TestUserMCPGuard`, `TestMCPTokenVerifier`, `TestMCPConsent`, `TestJournalMCP`, `TestMCPEndToEnd`), fixes in their own `fix(` commits in the owning repo. Fill the gate stages: `plugins` (user plugin with `GOWORK=off`: vet, test -short, `USER_TESTS` -short names if any, then the additive check against `PHASE197_USER_BASE`; oauthserver and journal likewise against their bases, with `JOURNAL_TESTS` -short including `TestJournalMCP`); `consumers` (for `$FONOTEKA`, `$BM_APP` and `$DEMO_APP`: `go build ./... && go test -count=1 -short ./...`; the demo additionally `go build -tags summercms_mcp ./...`; also `scripts/check-pins.sh` in the demo if it validates pins); `docker` (required names: cabana `TestDispatchMarker` Postgres parts, user `TestBackendLink TestFrontendPermissionCatalog TestUserMCPGuard TestBackendLinkSmoke TestBackendLinkAdminSmoke`, oauthserver `TestMCPTokenVerifier TestMCPConsent TestMCPTokenVerifierSmoke TestMCPConsentSmoke`, demo `TestMCPEndToEnd` with `-tags summercms_mcp`); `docs` (TestDocsTree, `summer docs:build --check`, the decision note names both modules and `govulncheck`, STACK rows present, no file under `modules/` or `docs/` and no test file of this phase names a consuming application — reuse the 19.6.1 name list and add `modules/pier`); update `--all` and the self-test for the new detectors (an additive self-test per plugin). Then update `19.7-VALIDATION.md`: every row's Automated Command set to the final command, File Exists ✅, Status ✅ green after running the gate; tick the four Wave 0 items; set `wave_0_complete: true` and `nyquist_compliant: true` in the frontmatter; the Sampling Rate "Before /msd-verify-work" line names `bash scripts/check-phase19.7.sh --all`.
</action>
<verify>
<automated>bash scripts/check-phase19.7.sh --all</automated>
<fails_when>non-zero exit, a stage printing FAIL, "refuse:" or "missing-named", or `NOT RUN docker` when a Docker daemon is reachable (run on a Docker host so every stage is PASS)</fails_when>
</verify>
<acceptance_criteria>
- `grep -c "func TestBackendLink(\|func TestFrontendPermissionCatalog(\|func TestUserMCPGuard(" ../sm-demo-app/plugins/golem15/user/*_test.go` prints 3; `grep -c "func TestMCPTokenVerifier(\|func TestMCPConsent(" ../sm-oauthserver-plugin/*_test.go` prints 2; `grep -c "func TestJournalMCP(" ../sm-journal-plugin/mcp_test.go` prints 1; `grep -c "ToolListChangedHandler" ../sm-demo-app/mcp_e2e_test.go` prints at least 1
- `grep -c "TODO stage" scripts/check-phase19.7.sh` prints 0 and `grep -c "PHASE197_USER_BASE\|PHASE197_OAS_BASE\|PHASE197_JOURNAL_BASE" scripts/check-phase19.7.sh` prints at least 3
- `bash scripts/check-phase19.7.sh --plugins` prints `additive:` lines for the user, oauthserver and journal plugins and exits 0
- `bash scripts/check-phase19.7.sh --all` exits 0 on a Docker host with PASS for self-test, go, plugins, consumers, admin, docs, marker and docker
- `grep -c "nyquist_compliant: true" .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md` prints 1 and `grep -c "⬜ pending\|❌ W0" .planning/phases/19.7-generic-mcp-module/19.7-VALIDATION.md` prints 0
</acceptance_criteria>
<done>Every plugin and demo row has its named test, the three plugins pass the additive-export check, the consumers build at their pins, the whole gate is green, and the validation map is filled and compliant.</done>
</task>
<task type="auto">
<name>Task 4: Security review of T-19.7-01..41 and T-19.7-SC: link proof, dispatch marker, session binding, scope ceilings and superuser reach</name>
<files>.planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md, .planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md, .planning/phases/19.7-generic-mcp-module/deferred-items.md, .planning/todos/pending/2026-10-17-plugin-registered-frontend-permissions.md, .planning/todos/pending/2026-10-17-frontend-backend-account-link.md, .planning/todos/done/2026-10-17-plugin-registered-frontend-permissions.md, .planning/todos/done/2026-10-17-frontend-backend-account-link.md</files>
<read_first>
- .planning/phases/19.4-oidc-provider-on-wristband/19.4-SECURITY.md and 19.4-SECURITY-REVIEW.md (the two formats, the Method section, the gaps-fixed table, the evidence table columns)
- The `<threat_model>` blocks of 19.7-01-PLAN.md, 19.7-02-PLAN.md, 19.7-03-PLAN.md and 19.7-04-PLAN.md (T-19.7-01..38 and T-19.7-SC) and this plan's (T-19.7-39..41)
- .planning/phases/19.7-generic-mcp-module/19.7-RESEARCH.md § "Security Domain" (ASVS categories, the known threat patterns and standard mitigations)
- 19.7-CONTEXT.md D-05, D-17, D-20, D-21, D-22, D-25, D-31 (the five review subjects the roadmap names)
- modules/pier/*.go, modules/bouncer/dispatch.go, modules/cabana/token_guard.go and token_resolver.go, the user plugin's classes/backend_links.go and classes/mcp_guard.go, the oauthserver's classes/mcp_verifier.go and controllers/mcp_consent_api.go
</read_first>
<action>
For each threat: read the implementing code and record file and line; find the pinning test (from Tasks 1-3 or the plans' smokes); where the code is right but no test pins it, add the test in the owning repo as its own commit; where the code is wrong, fix it in its own `fix(` commit and re-run the gate. Cross-cutting sweeps the review must perform and record: (1) link proof — no code path other than `ConfirmLinkRequest` and `SetLink` writes `golem15_user_backend_links`, `SetLink` is reachable only from the permission-guarded record action, and the confirm compares `iat`; (2) marker — the only non-test caller of the bouncer dispatch setter is `modules/pier/dispatch.go` (the gate's marker stage), no header or query is read for it, `ResolveBackend` refuses a frontend marker, the inner request has no Authorization or Cookie; (3) session binding — binding compared on every stateful request, DELETE and revocation propagate through the store, rehydration never trusts stored identity; (4) scope ceilings — `read` hides non-read-only tools, `backend` without a link yields no backend subject, consent drops `backend` without a link, personal tokens carry their own scopes and are off by default; (5) superuser reach (P-23) — weigh the optional `mcp.refuse_superuser_backend` switch and record the verdict with reasons; implementing it is a `fix(pier)` plus README and docs, and the patch tag it needs goes to deferred-items for the user's go-ahead (raise a blocking-human checkpoint before any tag or push); (6) logs — no token, argument or body in any pier, verifier or link log line; (7) no-store on every consent and link response that carries a code or token. Write `19.7-SECURITY-REVIEW.md` (Method, Gaps fixed with commit table, Threat register with Mitigation as built / Implementation / Test / Status, Cross-cutting findings, Accepted risks with reasons, Residual items) and `19.7-SECURITY.md` (frontmatter `phase: "19.7"`, `slug`, `status: verified`, `threats_open: 0`, `asvs_level: 1`, `created`; Trust Boundaries, Threat register summary, Accepted risks, Audit trail). Add any residual operational item (the deploy, Redis on rome, the superuser switch tag if adopted) to deferred-items.md.
Close the two folded todos in this task's planning-docs commit (D-01; CLAUDE.md rule 4): `git mv .planning/todos/pending/2026-10-17-plugin-registered-frontend-permissions.md .planning/todos/done/` and `git mv .planning/todos/pending/2026-10-17-frontend-backend-account-link.md .planning/todos/done/` (the closed directory is `.planning/todos/done/`, per `.planning/todos/README.md`), then end each file with a `## Closed <date>` note naming what shipped and where: for the first, the `pact.HasFrontendPermissions` capability (plan 01) and the user plugin's catalog in the permission editors (plan 03); for the second, the `golem15_user_backend_links` table, the proof round-trip, the published link resolver and the Administrators-screen set/remove actions (plan 03), each with the sm-user-plugin version from plan 03's SUMMARY. The g15office side — moving tasks `hmguritm` and `tqyvnzxx` into the phase's milestone task `dcnv4mha` with the one-line comment, and the phase-advance comment — is not done by the executor: the orchestrator's phase-completion step owns it (CLAUDE.md rule 4, `.planning/G15OFFICE.md`); record the two todo task IDs and the phase task ID in the SUMMARY so that step has them.
</action>
<verify>
<automated>test -f .planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md && test -f .planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md && grep -q "threats_open: 0" .planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md && for n in $(seq -w 1 41); do grep -q "T-19.7-$n" .planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md || { echo "missing T-19.7-$n"; exit 1; }; done && grep -q "T-19.7-SC" .planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md && test -f .planning/todos/done/2026-10-17-plugin-registered-frontend-permissions.md && test -f .planning/todos/done/2026-10-17-frontend-backend-account-link.md && ! test -e .planning/todos/pending/2026-10-17-plugin-registered-frontend-permissions.md && ! test -e .planning/todos/pending/2026-10-17-frontend-backend-account-link.md && bash scripts/check-phase19.7.sh --all</automated>
<fails_when>non-zero exit, a "missing T-19.7-NN" line, a folded todo still under todos/pending/ or absent under todos/done/, or a gate stage printing FAIL</fails_when>
</verify>
<acceptance_criteria>
- Every id T-19.7-01 through T-19.7-41 and T-19.7-SC appears in 19.7-SECURITY-REVIEW.md with an Implementation cell naming a file and line and a Test cell naming a test, and a Status of verified, fixed in commit <sha>, or accepted with a reason
- `grep -c "superuser" .planning/phases/19.7-generic-mcp-module/19.7-SECURITY-REVIEW.md` prints at least 2 (the D-22 verdict is written down)
- `grep -c "threats_open: 0" .planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md` prints 1 and `grep -c "^status: verified" .planning/phases/19.7-generic-mcp-module/19.7-SECURITY.md` prints 1
- Every fix or added test pin named in the Gaps-fixed table is a commit that exists (`git -C <repo> cat-file -t <sha>` prints commit)
- `bash scripts/check-phase19.7.sh --all` is green after the review's commits
- `grep -c "^## Closed" .planning/todos/done/2026-10-17-plugin-registered-frontend-permissions.md .planning/todos/done/2026-10-17-frontend-backend-account-link.md` prints 1 per file, neither file exists under `.planning/todos/pending/`, and the SUMMARY names g15office `hmguritm`, `tqyvnzxx` and `dcnv4mha` as the tasks the orchestrator updates at phase completion
</acceptance_criteria>
<done>Every threat of the phase is verified, fixed or accepted with evidence; the security contract reports no open threat; the gate is green after the review; the two folded todos are closed under todos/done/ with the g15office update left to the orchestrator's phase-completion step.</done>
</task>
</tasks>
<artifacts_this_phase_produces>
## Artifacts this plan produces
**Gate**: `scripts/check-phase19.7.sh` (stages self-test, go, plugins, consumers, docker, admin, docs, marker; env `PHASE197_*`, `USER_PLUGIN`, `OAUTHSERVER_PLUGIN`, `JOURNAL_PLUGIN`, `DEMO_APP`, `FONOTEKA`, `BM_APP`)
**Framework tests**: `modules/pier/helpers_test.go` (fakeGuard, fakeVerifier, fakeLinkResolver, fakePersonalResolver, newInstance, twoInstances, sdkClient), `TestToolsList`, `TestCatalog`, `TestDispatch`, `TestGuardRules`, `TestSessions`, `TestFanOut` (pier); `TestDispatchMarker` (bouncer and cabana); `TestStreamingRoute`, `TestPierMount` (surf); `TestMCPScopes` (wristband); `TestAccountContributions`, `TestRecordActionPrompt` (cabana); vitest `admin/tests/account/AccountContributions.test.ts`, `admin/tests/form/RecordActionsPrompt.test.ts`
**Plugin and demo tests**: `TestBackendLink`, `TestFrontendPermissionCatalog`, `TestUserMCPGuard` (sm-user-plugin); `TestMCPTokenVerifier`, `TestMCPConsent` (sm-oauthserver-plugin); `TestJournalMCP` (sm-journal-plugin); `TestMCPEndToEnd` extended (sm-demo-app, tagged)
**Documents**: `19.7-VALIDATION.md` filled (`nyquist_compliant: true`), `19.7-SECURITY.md`, `19.7-SECURITY-REVIEW.md`, `deferred-items.md`; the two folded todos moved to `.planning/todos/done/` with their `## Closed` notes
**Possible fixes**: `fix(` commits in the owning repositories; the optional `mcp.refuse_superuser_backend` key if the review adopts it (recorded with its tag need)
</artifacts_this_phase_produces>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| gate script to six repositories | the script decides the phase verdict from test output across repos |
| review to production code | the review may change code; every change is a visible commit |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-19.7-39 | Repudiation | a green gate that measured nothing | high | mitigate | Every required test is listed by name; the detectors refuse skipped, zero-match, "no tests to run" and missing names and are proven by `--self-test` on planted output; docker is NOT RUN only without a daemon and a failure with `PHASE197_REQUIRE_DOCKER=1` |
| T-19.7-40 | Tampering | the marker rule eroding over time | medium | mitigate | The `marker` stage fails when any non-test file outside modules/pier and modules/bouncer calls the dispatch setter, and when pact grows a dependency on the SDK, jsonschema-go or bouncer |
| T-19.7-41 | Information Disclosure | test fixtures leaking real credentials | low | mitigate | Tests mint their own tokens and codes against throwaway Postgres databases and miniredis; no fixture carries a production token; the docs stage's name check keeps consuming applications out of framework test files |
</threat_model>
<verification>
- `bash scripts/check-phase19.7.sh --all` on a Docker host: PASS for every stage, no NOT RUN
- `19.7-VALIDATION.md`: every row ✅ green, Wave 0 ticked, `nyquist_compliant: true`
- `19.7-SECURITY.md` reports `threats_open: 0`; `19.7-SECURITY-REVIEW.md` covers T-19.7-01..41 and T-19.7-SC
- The 19.6.1 gate still passes: `bash scripts/check-phase19.6.1.sh --all`
</verification>
<success_criteria>
- Unit tests are the last plan and every VALIDATION behaviour row is pinned by a required, named test
- The multi-repo gate is fail-closed and green; the three core plugins are proven additive against their pre-phase commits; fonoteka.go and sm-bm-app build and pass at the bumped pins (D-31)
- The security review's verdicts are written down with evidence; any fix is its own commit; no tag or push happened without a go-ahead
</success_criteria>
<output>
Create `.planning/phases/19.7-generic-mcp-module/19.7-05-SUMMARY.md` when done (planning docs in their own commit).
</output>

View File

@@ -118,7 +118,7 @@ Out of scope: MCP resources (the capability is designed for them, but they ship
- the `ai` scope plays no part in the read/write ceiling;
- consent is served as JSON endpoints in sm-oauthserver-plugin, with a `/connect` page in vue-demo-app;
- the permission code is `golem15.users.manage_backend_links`.
- **D-36:** **Plan split, 5 plans** (user-confirmed):
- **D-36 [informational]:** **Plan split, 5 plans** (user-confirmed):
1. framework seams;
2. the pier module and framework release;
3. sm-user-plugin;

File diff suppressed because it is too large Load Diff

View File

@@ -553,22 +553,26 @@ Permissions [VERIFIED: sm-journal-plugin/controllers/api/auth.go:26-30]: `permAc
| A8 | Granting `backend` only when a link exists at consent time (and dropping it otherwise) is acceptable UX | Security Domain | A later link would need re-consent (step-up) |
| A9 | Per-call binary growth of ~2.9 MiB is acceptable if pier is always linked | Open Question 2 | Every app grows even with pier disabled |
## Open Questions
## Open Questions (RESOLVED)
All eight questions were resolved at plan confirmation on 2026-10-21 and recorded in 19.7-CONTEXT.md § "Decisions after research" (D-32..D-35; D-36 records the agreed plan split). Each question below ends with its resolution.
1. **Stateful-only (D-25) vs hybrid with the 2026-07-28 stateless protocol.**
- What we know: the current spec removed sessions; the SDK serves 2026-07-28 only statelessly; SDK clients fall back to 2025-11-25 against a stateful server (probe).
- What's unclear: whether the user wants pier to also answer 2026-07-28 clients (stateless dispatch per request, `subscriptions/listen` for push), which is additive to D-25's stateful path.
- Recommendation: ship D-25 as locked; design the identity/dispatch/filter layers so a stateless handler can reuse them; raise it at plan confirmation. Do not silently adopt the hybrid.
- **RESOLVED (D-32):** hybrid adopted. pier also answers 2026-07-28 clients through a stateless path next to the stateful one, sharing identity, dispatch and per-principal filtering; push for stateless clients uses `subscriptions/listen`.
2. **Always link pier, or behind a build tag?**
- What we know: linking the SDK costs ~2.9 MiB stripped; the framework already has the opt-in build-tag pattern (`summercms_s3`: `s3_on.go //go:build summercms_s3`, `s3_off.go //go:build !summercms_s3`, `summer.yaml build.tags`) [VERIFIED: modules/lagoon/attach/s3_on.go:1, s3_off.go:1, bucket.go:27-28].
- What's unclear: SC-1 says "enables the module in config"; a tag adds a build step.
- Recommendation: ask the user; if always linked, keep all plugin-facing types SDK-free anyway (they must be, for the tag option to remain open).
3. **D-04 "backend Users screen" does not exist.** cabana mounts no backend-users controller; admins come from `admin:create`/`admin:reset-password` commands [VERIFIED: modules/cabana/http.go:247-330, commands.go:21,45]. 19.6's Reset 2FA uses the user plugin's **own** Users screen (`AdminRecordActions` + a published `TwoFactorAdmin` slot), not a generic cabana seam (19.6-01-PLAN :49, :270), so there is nothing to reuse beyond that pattern. Recommendation: My Profile gets the generic cabana seam (D-04 part 1); admin set/remove goes on the sm-user-plugin **frontend** Users screen as a record action "Remove backend link" (Danger, `Applies` only when linked, permission) plus a way to set it (a form field with `DropdownOptions` of backend admins, or an `AdminAction` widget), and/or a `user:link-backend` console command. Needs user confirmation.
4. **Frontend permission semantics** (Pitfall 3): mirror the route (group grants) — recommended — or change `user.permission` to `MergedPermissions` (behaviour change in a core plugin).
5. **Session binding granularity** (A3): `(client_id, user_id)` vs token hash.
6. **`ai` scope**: ignore for tools (recommended) or require it for some tool class.
7. **MCP consent surface.** wristband sends the browser to `{issuer}/connect?request=` [VERIFIED: modules/wristband/authorize.go:174 — `spa := s.opts.Issuer + "/connect?request=" + rfc3986Escape(requestID)`]. Recommendation: sm-oauthserver-plugin adds JSON consent endpoints for the MCP server (show/decide, `jwt.auth`, mirroring fonoteka's `ConsentShow`/`ConsentStore` contract) that include the linked admin's display name when `backend` is requested; vue-demo-app adds `/connect` and the link-proof page. The demo's nginx does not route `/oauth` or `/.well-known` to Go yet (sm-demo-app/DEPLOY.md:34), so the deploy plan must add `/mcp`, `/.well-known/oauth-protected-resource*`, `/.well-known/oauth-authorization-server` and `/oauth/mcp/*`.
8. **Permission code spelling.** Existing backend codes are `golem15.users.*` (`golem15.users.access_users`, `…access_groups`, `…access_settings`, `…impersonate_user`, `…manage_privileged_groups` [VERIFIED: fonoteka.go/plugins/golem15/user/admin_permissions.go:17-41]); 19.6 adds `golem15.users.reset_two_factor`. Recommend `golem15.users.manage_backend_links` (CONTEXT's example `golem15.user.…` would break the pattern).
- **RESOLVED (D-33):** build tag. pier compiles in only with `summercms_mcp` in `summer.yaml` `build.tags`; without the tag the binary carries no go-sdk; `mcp.enabled` still defaults to off; `pact` types stay SDK-free.
3. **D-04 "backend Users screen" does not exist.** cabana mounts no backend-users controller; admins come from `admin:create`/`admin:reset-password` commands [VERIFIED: modules/cabana/http.go:247-330, commands.go:21,45]. 19.6's Reset 2FA uses the user plugin's **own** Users screen (`AdminRecordActions` + a published `TwoFactorAdmin` slot), not a generic cabana seam (19.6-01-PLAN :49, :270), so there is nothing to reuse beyond that pattern. Recommendation: My Profile gets the generic cabana seam (D-04 part 1); admin set/remove goes on the sm-user-plugin **frontend** Users screen as a record action "Remove backend link" (Danger, `Applies` only when linked, permission) plus a way to set it (a form field with `DropdownOptions` of backend admins, or an `AdminAction` widget), and/or a `user:link-backend` console command. Needs user confirmation. **RESOLVED (D-34):** admins set and remove links on the Phase 19.6.1 Administrators screen through its record-action seam (a prompted set action and a remove action behind `golem15.users.manage_backend_links`); My Profile keeps the generic cabana account-contribution seam (D-04 part 1). No new cabana backend-users screen.
4. **Frontend permission semantics** (Pitfall 3): mirror the route (group grants) — recommended — or change `user.permission` to `MergedPermissions` (behaviour change in a core plugin). **RESOLVED (D-35):** mirror the route. Frontend tool filtering uses group grants, exactly what `user.permission` enforces; `MergedPermissions` is not changed.
5. **Session binding granularity** (A3): `(client_id, user_id)` vs token hash. **RESOLVED (D-35):** `(client_id, user_id)`, so sessions survive token refresh.
6. **`ai` scope**: ignore for tools (recommended) or require it for some tool class. **RESOLVED (D-35):** ignored; `ai` plays no part in the read/write ceiling.
7. **MCP consent surface.** wristband sends the browser to `{issuer}/connect?request=` [VERIFIED: modules/wristband/authorize.go:174 — `spa := s.opts.Issuer + "/connect?request=" + rfc3986Escape(requestID)`]. Recommendation: sm-oauthserver-plugin adds JSON consent endpoints for the MCP server (show/decide, `jwt.auth`, mirroring fonoteka's `ConsentShow`/`ConsentStore` contract) that include the linked admin's display name when `backend` is requested; vue-demo-app adds `/connect` and the link-proof page. The demo's nginx does not route `/oauth` or `/.well-known` to Go yet (sm-demo-app/DEPLOY.md:34), so the deploy plan must add `/mcp`, `/.well-known/oauth-protected-resource*`, `/.well-known/oauth-authorization-server` and `/oauth/mcp/*`. **RESOLVED (D-35):** JSON consent endpoints in sm-oauthserver-plugin with the `/connect` page (and the `/link-admin` proof page) in vue-demo-app, plan 04 Task 2; the nginx locations are plan 04 Task 5.
8. **Permission code spelling.** Existing backend codes are `golem15.users.*` (`golem15.users.access_users`, `…access_groups`, `…access_settings`, `…impersonate_user`, `…manage_privileged_groups` [VERIFIED: fonoteka.go/plugins/golem15/user/admin_permissions.go:17-41]); 19.6 adds `golem15.users.reset_two_factor`. Recommend `golem15.users.manage_backend_links` (CONTEXT's example `golem15.user.…` would break the pattern). **RESOLVED (D-35):** `golem15.users.manage_backend_links`.
## Environment Availability

View File

@@ -0,0 +1,46 @@
# Deferred items
Out-of-scope discoveries made while executing phase 19.7 plans. Nothing here
was changed by the plan that recorded it.
## Deferred Items
- Pre-existing `gofmt` drift in cabana (found during 19.7-01 Task 1)
status: open
**What:** `gofmt -l modules/cabana` lists `account_tokens.go`,
`account_tokens_test.go`, `field_trigger_smoke_test.go`,
`token_postgres_smoke_test.go`, `token_routes_test.go` and
`token_scopes_test.go` as unformatted before this plan touched the module
(alignment of map literals and struct tags). Left as is: reformatting
would add diff noise unrelated to the plan (a whole-file `gofmt -w` on
`token_routes_test.go` rewrote 132 lines and was reverted). A one-line
`gofmt -w` on those six files in a `style(cabana)` commit of its own fixes it.
- `AdminRecordAction.Prompt` acceptance grep counted two `prompt,omitempty`
tags in `schema_types.go` (found during 19.7-01 Task 4)
status: resolved
**What:** the second match is the pre-existing `FormField.Prompt` JSON tag
at `schema_types.go:376`, not a duplicate of the new `RecordAction.Prompt`;
the criterion's "prints 1" was written without that line in mind. No change
needed.
- Stateful pier sessions cannot carry the SDK's protocol-version context value (found during 19.7-02 Task 3)
status: open
**What:** go-sdk v1.8.0's `StreamableHTTPHandler.ServeHTTP` stores the
`Mcp-Protocol-Version` header under an unexported context key that the
transport's `servePOST`/`serveGET` read; pier's own session router (needed
for Redis-shared sessions, D-25) serves `StreamableServerTransport`
directly and cannot set that key, so stateful streams run with the SDK's
2025-03-26 defaults for stream close/reconnect hints and the JSON-RPC
batch rule (lenient, spec-compliant for older clients; 2026-07-28 clients
go through the SDK's own stateless handler). Revisit if a later SDK
exports the key or a transport-level setter; plan 05 may add a test
pinning the behaviour.
- `notifications/initialized` landing on another instance than `initialize` (found during 19.7-02 Task 3)
status: open
**What:** the session state is persisted after `initialize` and again
after the client's `initialized` notification; when a load balancer sends
the notification to a second instance, the first instance's local copy
keeps `InitializedParams` nil and refuses calls until that copy is
dropped (session end, revocation or process restart) while the second
instance serves them. Sticky sessions or a per-request re-read of the
stored `initialized` flag would close the gap; not needed for the
single-instance demo.

View File

@@ -0,0 +1,215 @@
---
phase: quick-261022-imo
plan: 01
quick_id: 261022-imo
slug: settings-section-panel-scoped-to-categor
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- IMO-01 # settings pages (singleton form or settings-link controller without own nav entry) get a section panel of the current category
- IMO-02 # panel hidden for a one-entry category, on /settings and on every non-settings page; never lists other categories
- IMO-03 # same look and collapse/expand behaviour as the plugin SectionPanel; --shell-offset follows it
- IMO-04 # vitest coverage of the panel (component + shell + state helper)
- IMO-05 # docs/backend/settings.md describes the panel (same commit as the code)
- IMO-06 # modules/boardwalk/dist rebuilt and check-admin-dist.sh green
files_modified:
# Task 1: helper, panel, shell wiring, docs, tracer test
- admin/src/state/useSettings.ts
- admin/src/components/shell/SettingsPanel.vue
- admin/src/components/shell/AppShell.vue
- admin/tests/shell/AppShell.test.ts
- docs/backend/settings.md
# Task 2: tests
- admin/tests/shell/SettingsPanel.test.ts
- admin/tests/shell/AppShell.test.ts
- admin/tests/state/useSettings.test.ts
# Task 3: embedded build
- modules/boardwalk/dist
estimate:
tokens: 90000
raw_tokens: 90000
tasks: 3
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "On /settings/mail (System category holding Mail and Search) the shell renders an aside[data-settings-panel] whose header reads the category label 'System' and whose links are Mail then Search (settingsGroups order), Mail carrying aria-current=\"page\", each href equal to settingsPath(entry)."
- "On /settings/branding (Appearance holds only Branding) no settings panel and no aside render; on /settings (index) no aside renders."
- "The panel never lists an entry of another category: on /settings/mail the Branding entry is absent."
- "On a settings-link controller route whose plugin has no navigation entry (e.g. /acme/lang/locales and its record route /acme/lang/locales/5 for a System link entry 'locales') the settings panel renders with Locales current; on a settings-link controller whose plugin HAS a navigation entry (/acme/demo/widgets) the plugin SectionPanel renders and the settings panel does not."
- "Collapse works exactly like the plugin panel: the panel's [data-sidebar-collapse] button hides it (sidebar state persisted under summer-admin.sidebar), the rail's [data-sidebar-expand] button appears and takes focus, clicking it brings the panel back and focuses [data-sidebar-collapse]; a narrow viewport hides it too."
- "--shell-offset on the shell root is calc(var(--spacing-rail) + var(--spacing-panel)) while the settings panel shows and var(--spacing-rail) while it is collapsed or absent."
- "modules/boardwalk/dist matches a fresh build of admin/ (scripts/check-admin-dist.sh exits 0)."
artifacts:
- path: admin/src/components/shell/SettingsPanel.vue
provides: "Category-scoped settings section panel (aside[data-settings-panel], links [data-settings-panel-item=<code>])"
- path: admin/src/state/useSettings.ts
provides: "exported settingsSectionOf(current) and SettingsSection type"
- path: admin/src/components/shell/AppShell.vue
provides: "picks SectionPanel (plugin) or SettingsPanel (settings page); --shell-offset accounts for either"
- path: admin/tests/shell/SettingsPanel.test.ts
provides: "component tests of the settings panel"
- path: modules/boardwalk/dist
provides: "embedded admin build containing the panel"
key_links:
- from: admin/src/components/shell/AppShell.vue
to: admin/src/state/useSettings.ts
via: "settingsEntry / settingsLinkFor resolve the current entry; settingsSectionOf(current) yields the category group or null"
- from: admin/src/components/shell/SettingsPanel.vue
to: admin/src/components/shell/PluginRail.vue
via: "shared data-sidebar-collapse / data-sidebar-expand focus hand-off and useSidebar setCollapsed"
---
<objective>
Add a settings section panel to the admin SPA shell: on a settings page (a singleton settings form `/settings/{code}`, route `settings-form`, or an admin controller a settings link entry opens when that controller's plugin has no navigation entry of its own) the shell shows a 224px panel, styled and collapsing exactly like the plugin side menu, that lists the permitted settings entries of the CURRENT entry's category only, in settingsGroups order, with the current entry highlighted. One-entry categories, the /settings index and all other pages show no settings panel.
Purpose: WinterCMS parity. On Administrators an admin switches to Roles (both System) without going back to /settings; a plugin with two settings forms in one category (e.g. a payment plugin) likewise. Switching category still goes through /settings.
Output: SettingsPanel.vue, a settingsSectionOf helper in useSettings.ts, AppShell wiring, vitest coverage, the docs/backend/settings.md paragraph, and a rebuilt modules/boardwalk/dist. SPA only: no API, pact or Go change.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@/media/nvme/dev/golem15/summercms.io/summercms/summercms.go/CLAUDE.md
@/media/nvme/dev/golem15/summercms.io/summercms/summercms.go/.planning/STATE.md
Source files the executor reads before editing (all small):
@admin/src/components/shell/AppShell.vue
@admin/src/components/shell/SectionPanel.vue
@admin/src/components/shell/PluginRail.vue
@admin/src/state/useSettings.ts
@admin/src/state/useSidebar.ts
@admin/tests/shell/AppShell.test.ts
@admin/tests/shell/SectionPanel.test.ts
@admin/tests/state/useSettings.test.ts
@admin/tests/fixtures/settings.json
@docs/backend/settings.md
Facts established during planning (do not re-derive):
- Settings categories arrive already translated: cabana's navigation.go builds each SettingsEntry with Category set by translateKey(ctx, tr, item.Category), and SettingsIndexView renders group.category as is. So "category label (translated)" means rendering entry.category; no phrasebook lookup and no new phrase key in the SPA.
- settingsGroups (useSettings.ts) sorts entries by order then first-seen index and groups by category; the panel must reuse that order, not re-sort.
- SectionPanel.vue markup to mirror: aside with aria-label t('backend::lang.nav.sections') and classes "sticky top-0 flex h-screen w-panel shrink-0 flex-col gap-0.5 self-start overflow-y-auto border-r border-border bg-surface px-3 py-3.5"; header div "mb-3.5 flex h-10 items-center justify-between gap-2 pl-2" with a truncated 16px bold label and the collapse button (data-sidebar-collapse, aria-label/title t('backend::lang.nav.collapse'), PanelLeftClose icon size 18, classes "flex size-[30px] shrink-0 items-center justify-center rounded-tab text-muted transition-colors duration-150 ease-out hover:bg-hover hover:text-text"); links are RouterLinks with classes "flex h-nav items-center gap-3 rounded-control px-3 no-underline transition-colors duration-150 ease-out" plus "bg-sel font-semibold text-text" when current, otherwise "font-medium text-muted hover:bg-hover hover:text-text", an 18px icon (aria-hidden) and the label. Its collapse() calls setCollapsed(true) then focuses [data-sidebar-expand] on nextTick.
- PluginRail's expand button ([data-sidebar-expand]) renders whenever collapsed && !narrow, independent of which panel is in play, and on click calls setCollapsed(false) then focuses [data-sidebar-collapse]. It therefore already works for the settings panel as long as SettingsPanel's collapse button carries data-sidebar-collapse. No PluginRail change is needed.
- SectionFlyout is per plugin rail item (opens on hover/focus of a plugin item while collapsed). The rail's Settings item is a plain link to /settings with no flyout. Decision for this task (Claude's discretion within the locked decisions): no settings flyout. Reason: a flyout on the Settings rail item would either list every category (the locked decision says the panel never lists other categories) or only the current one (meaningless off a settings page); the Settings rail item already opens /settings, which lists every permitted page grouped by category, one click away, and is how an admin switches category. On narrow viewports (forced collapse, no expand button) that index is also how settings pages are switched. This reasoning goes into the SettingsPanel header comment.
- Test fixture (admin/tests/fixtures/settings.json, settingsFixture.list.data): System holds mail (order 10) and search (order 20); Appearance holds branding (order 5) alone. navigationFixture plugins are acme.demo (widgets, gadgets), acme.tools (hammers) and hidden; acme.lang has no navigation entry. The lang fixture is Polish: 'backend::lang.nav.sections' = Sekcje, 'backend::lang.nav.collapse' = Zwiń menu, 'backend::lang.nav.settings' = Ustawienia.
- vitest runs with cwd admin/ when invoked through npm --prefix admin; test file filters are relative to admin/.
- Do not run npm ci (shared node_modules). check-admin-dist.sh only runs it when admin/node_modules is missing.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Settings panel end to end (helper, component, shell wiring, docs) for /settings/mail</name>
<precondition>git status --porcelain -- admin modules/boardwalk/dist docs prints nothing (the 19.6.1 gap-closure session has committed its admin work); admin/node_modules exists.</precondition>
<files>admin/src/state/useSettings.ts, admin/src/components/shell/SettingsPanel.vue, admin/src/components/shell/AppShell.vue, admin/tests/shell/AppShell.test.ts, docs/backend/settings.md</files>
<action>
Implements the locked decisions (current-category-only panel, hidden for a one-entry category, same look and collapse as the plugin side menu, SPA only).
1. admin/src/state/useSettings.ts: export an interface SettingsSection with fields category (string), current (SettingsEntry) and entries (SettingsEntry[]). Export a function settingsSectionOf(current: SettingsEntry | null): SettingsSection | null that returns null for null, finds the settingsGroups.value group whose category equals current.category, returns null when that group is missing or holds fewer than two entries, and otherwise returns the group's category, the given current entry and the group's entries array (settingsGroups order, nothing re-sorted, no entry of any other category). Add settingsSectionOf to the object useSettings() returns. Add a doc comment in the file's style (what it returns and why one entry yields null: nothing to switch to).
2. admin/src/components/shell/SettingsPanel.vue (new): script setup lang ts, one prop section of type SettingsSection. Render the same markup and classes as SectionPanel.vue (see the context facts): an aside with aria-label t('backend::lang.nav.sections') plus a data-settings-panel attribute; the header label is section.category, falling back to t('backend::lang.nav.settings') when the category is an empty string; the collapse button keeps data-sidebar-collapse, the same aria-label/title, icon and click handler behaviour (setCollapsed(true) imported from state/useSidebar, then focus [data-sidebar-expand] on nextTick). Below it one RouterLink per section.entries item: to settingsPath(entry), key entry.code, a data-settings-panel-item attribute set to entry.code, aria-current "page" when entry.code equals section.current.code (otherwise undefined), current/non-current classes as in SectionPanel, the icon from iconFor(entry.icon) at size 18 with aria-hidden, and entry.label as text. Labels go through text interpolation only. Head the script with a comment block in the SectionPanel style: what the panel is (settings section panel, level 2 of the shell, same look and collapse as the plugin side menu), that it lists only the current entry's category and switching category goes through /settings, that categories arrive translated from the server, and why there is no settings flyout on the rail (the reasoning from the context facts).
3. admin/src/components/shell/AppShell.vue: import SettingsPanel, controllerIdFromPath (app/controllerRoutes) and settingsEntry, settingsLinkFor, settingsSectionOf (state/useSettings). Add a computed settingsSection: null when active (the plugin navigation entry) is set, because a settings-link controller with its own navigation entry keeps its plugin panel exactly as PluginRail's inSettings rule does; when route.name is 'settings-form' it is settingsSectionOf(settingsEntry(String(route.params.code ?? ''))) (Breadcrumbs parity); otherwise settingsSectionOf(settingsLinkFor(controllerIdFromPath(route.path))). The /settings index resolves to null through that last branch (no controller id). Make shellOffset use the panel width when (active or settingsSection) is set and the sidebar is not collapsed. In the template keep the SectionPanel line and add SettingsPanel right after it under v-else-if, shown when settingsSection is set and not collapsed, passing section. Update the shell's header comment to say the section panel is the active plugin's side menu or, on a settings page, the settings panel of its category.
4. admin/tests/shell/AppShell.test.ts (tracer check): import setSettings and settingsFixture; add a describe block "settings section panel" with one case: setSettings(settingsFixture.list.data), mount the shell at /settings/mail, expect aside[data-settings-panel] to exist with header text System, the [data-settings-panel-item] links to read Mail then Search with hrefs /settings/mail and /settings/search, Mail with aria-current page and Search without. Task 2 adds the remaining cases to the same block.
5. docs/backend/settings.md (same commit as the code, per the locked decision): in the "Linking a settings entry to an admin controller" section, extend the last paragraph (the one starting "In the admin, the entry's card on the Settings page") so it also says the section panel lists the settings pages of the entry's category. Then add a short section titled "## Moving between settings pages" right before "## How values are stored", in the page's plain prose style: on a settings form and on a linked controller that belongs to Settings, a panel next to the rail lists the settings pages of the same category in settings-index order, with the open page highlighted; it does not appear when the category has a single page, on the Settings page itself, or on a linked controller that has its own main navigation item (that controller keeps its plugin's side menu); another category is reached through the Settings page; the panel collapses and expands like a plugin's side menu and hides on narrow windows. No code identifiers that do not exist in a package (the docs checker enforces backticked identifiers); plain prose needs none.
Commit (stage files by path, never git add -A): feat(quick-261022-imo): settings section panel scoped to the current category. No co-author tag.
</action>
<verify>
<automated>npm --prefix admin run test -- tests/shell/AppShell.test.ts tests/state/useSettings.test.ts tests/shell/SectionPanel.test.ts tests/shell/PluginRail.test.ts tests/shell/Breadcrumbs.test.ts && npm --prefix admin run typecheck && go run ./cmd/summer docs:build --check && go test ./cmd/summer -count=1 -run '^TestDocsTree$'</automated>
</verify>
<done>/settings/mail renders the System settings panel with Mail current and Search linked; all existing shell and settings tests still pass; vue-tsc is clean; the docs checker and TestDocsTree pass; one feat commit holds the five files.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: Vitest coverage for the settings panel (component, shell, helper)</name>
<files>admin/tests/shell/SettingsPanel.test.ts, admin/tests/shell/AppShell.test.ts, admin/tests/state/useSettings.test.ts</files>
<behavior>
- settingsSectionOf(null) is null; for branding (alone in Appearance) it is null; for mail it is category System with entries [mail, search] in that order and current mail; a System link entry with order 15 lands between mail and search; no Appearance entry ever appears in a System section; useSettings().settingsSectionOf is the exported function.
- SettingsPanel component: aside labelled Sekcje with data-settings-panel; header shows the category; links in section order with hrefs from settingsPath (a link entry with controller acme.lang.locales links to /acme/lang/locales); only the current entry has aria-current page; an empty category shows Ustawienia in the header; clicking [data-sidebar-collapse] (aria-label Zwiń menu, type button) sets sidebarCollapsed true and stores 'true' under SIDEBAR_KEY.
- Shell: /settings/branding renders no aside; /settings renders no aside; /settings/mail never lists branding; with a System link entry locales (controller acme.lang.locales), /acme/lang/locales and /acme/lang/locales/5 render the settings panel with Locales current; with a link entry widgets (controller acme.demo.widgets), /acme/demo/widgets renders the plugin panel (header Demo) and no [data-settings-panel]; setCollapsed(true) hides the settings panel and --shell-offset becomes var(--spacing-rail), setCollapsed(false) restores it and the offset returns to calc(var(--spacing-rail) + var(--spacing-panel)); a narrow viewport (fakeMedia NARROW_QUERY true) hides it; clicking the panel's [data-sidebar-collapse] leaves the rail's [data-sidebar-expand] focused, and clicking that brings the panel back with [data-sidebar-collapse] focused.
</behavior>
<action>
Covers the locked test list (shown with 2+ entries in category, hidden with 1, current highlighted, only current category listed, hidden on /settings index, shown on a settings-link controller route, collapse respected) plus the rail expand hand-off decided in Task 1.
1. admin/tests/state/useSettings.test.ts: add an it block per behavior bullet 1, importing settingsSectionOf; build link entries by spreading settingsFixture.list.data[0] with code, label, model '' and controller overridden, as the existing link tests do, and set order explicitly.
2. admin/tests/shell/SettingsPanel.test.ts (new): follow SectionPanel.test.ts structure (beforeEach resetState and setCollapsed(false), afterEach setCollapsed(false) and clear document.body, enableAutoUnmount, a mountPanel helper that signs in, builds routerAt(path) and mounts SettingsPanel with a section prop attached to document.body). Build sections with setSettings(...) then settingsSectionOf(settingsEntry(code)) or settingsLinkFor(...) rather than hand-made objects, so the component is exercised with real helper output; for the empty-category case build the section object directly from fixture entries with category ''. Cover behavior bullet 2.
3. admin/tests/shell/AppShell.test.ts: extend the "settings section panel" describe block from Task 1 with behavior bullet 3. Call setSettings before mounting (resetState clears settings in beforeEach). For the narrow case reuse fakeMedia and NARROW_QUERY as the existing viewport test does (fakeMedia before mount). For the focus hand-off, mount with attachTo document.body (mountShell already does), trigger click on the panel's [data-sidebar-collapse], flushPromises, assert document.activeElement matches [data-sidebar-expand], then click it, flushPromises, assert aside[data-settings-panel] exists again and document.activeElement matches [data-sidebar-collapse].
Run the whole admin suite once at the end, not only the touched files. Commit test files by path: test(quick-261022-imo): settings section panel coverage. No co-author tag.
</action>
<verify>
<automated>npm --prefix admin run test -- tests/shell/SettingsPanel.test.ts tests/shell/AppShell.test.ts tests/state/useSettings.test.ts && npm --prefix admin run test && npm --prefix admin run typecheck</automated>
</verify>
<done>Every behavior bullet has a passing test; the full admin vitest suite and vue-tsc pass; one test commit holds the three test files.</done>
</task>
<task type="auto">
<name>Task 3: Rebuild the embedded admin dist on top of the current master</name>
<precondition>Tasks 1 and 2 are committed; git status --porcelain -- admin modules/boardwalk/dist prints nothing (no other session has uncommitted admin or dist edits; if one does, stop and report instead of building over it); admin/node_modules exists (never run npm ci).</precondition>
<files>modules/boardwalk/dist</files>
<action>
Per the locked decision, the committed build must contain the panel and pass the drift gate; this runs last so it builds on top of whatever the 19.6.1 gap-closure session committed.
1. Run npm --prefix admin run build (vue-tsc then vite build into modules/boardwalk/dist with emptyOutDir).
2. Run scripts/check-admin-dist.sh; it must report that modules/boardwalk/dist matches a fresh build.
3. Run go test -short ./modules/boardwalk so the embed still compiles and serves.
4. Stage only modules/boardwalk/dist by path (git add modules/boardwalk/dist, which also stages removed hashed assets) and commit: chore(quick-261022-imo): rebuild embedded admin dist. No co-author tag. Do not push or tag.
</action>
<verify>
<automated>scripts/check-admin-dist.sh && go test -short ./modules/boardwalk && git status --porcelain -- modules/boardwalk/dist admin</automated>
</verify>
<done>check-admin-dist.sh exits 0, boardwalk tests pass, the dist commit exists, and git status shows nothing left under admin/ or modules/boardwalk/dist.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| server -> SPA settings list | GET /settings is filtered server-side per administrator (permissions and controller access); the panel only re-presents that list |
| URL -> SPA route params | /settings/{code} and controller paths are user-editable |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-261022-imo-01 | Information disclosure | SettingsPanel.vue / settingsSectionOf | low | mitigate | Entries come only from the server-filtered settings state (settingsGroups); the panel has no other source, so it cannot advertise a page or controller the administrator may not open. Covered by the "only current category" and helper tests. |
| T-261022-imo-02 | Tampering | AppShell settingsSection from route params | low | mitigate | The route code and controller id are only used as exact-match lookups (settingsEntry, settingsLinkFor); an unknown value yields null and no panel; labels render through Vue text interpolation, never as HTML. |
| T-261022-imo-03 | Elevation of privilege | panel links | low | accept | Links only navigate; every page the link opens is authorised by the API as before. No client-side permission logic is added. |
| T-261022-imo-SC | Tampering | npm/pip/cargo installs | high | accept | No package is added or installed; npm ci is explicitly not run (shared node_modules); the build uses the committed lockfile's existing install. |
</threat_model>
<verification>
- npm --prefix admin run test (whole suite) and npm --prefix admin run typecheck pass.
- go run ./cmd/summer docs:build --check and go test ./cmd/summer -run '^TestDocsTree$' pass.
- scripts/check-admin-dist.sh passes after the dist commit.
- Three commits in order: feat (code + docs + tracer test), test (coverage), chore (dist). No Go, pact or API files changed: git diff --stat over the three commits lists only admin/, docs/backend/settings.md and modules/boardwalk/dist.
</verification>
<success_criteria>
- On a singleton settings form or a settings-linked controller without its own navigation entry, an admin sees the other settings pages of the same category in a side panel and can switch between them directly; the current page is highlighted.
- No panel for a one-page category, on /settings, or on any non-settings page; the panel never shows another category.
- The panel looks, collapses, expands and offsets bottom save bars exactly like the plugin side menu.
- Tests cover every listed case; docs describe the behaviour; the embedded dist is current.
</success_criteria>
<output>
Create `.planning/quick/261022-imo-settings-section-panel-scoped-to-categor/261022-imo-SUMMARY.md` when done
</output>
</content>
</invoke>

View File

@@ -0,0 +1,88 @@
---
phase: quick-261022-imo
plan: 01
quick_id: 261022-imo
subsystem: admin
tags: [admin, shell, settings, navigation]
status: complete
requires:
- admin settings state (useSettings, settingsGroups) and the plugin SectionPanel / PluginRail collapse hand-off
provides:
- SettingsPanel.vue (category-scoped settings section panel)
- settingsSectionOf / SettingsSection in useSettings.ts
affects:
- AppShell section panel selection and --shell-offset
- modules/boardwalk/dist (embedded admin build)
tech-stack:
added: []
patterns:
- second level-2 panel chosen by AppShell (plugin SectionPanel first, SettingsPanel under v-else-if)
key-files:
created:
- admin/src/components/shell/SettingsPanel.vue
- admin/tests/shell/SettingsPanel.test.ts
modified:
- admin/src/state/useSettings.ts
- admin/src/components/shell/AppShell.vue
- admin/tests/shell/AppShell.test.ts
- admin/tests/state/useSettings.test.ts
- docs/backend/settings.md
- modules/boardwalk/dist
decisions:
- "Settings section panel lists only the current entry's category in settingsGroups order; hidden for one-entry categories, on /settings and when the plugin has its own navigation entry"
- "No settings flyout on the rail: /settings is one click away and is how category is switched (also on narrow viewports)"
requirements: [IMO-01, IMO-02, IMO-03, IMO-04, IMO-05, IMO-06]
metrics:
duration: ~6min
completed: 2026-10-22
tasks: 3
files: 8
actuals:
tokens: 5500 # chars/4 over the admin/ and docs/ diff (22120 chars); the regenerated minified dist is excluded
tasks: 3
commits: 3
plan_head_before: a97743a39f418b30663f6b6405d9ca14ebe8f02e
plan_head_after: 80bb5aee3d5bc93eb8f2a7924bd3d484d6733c32
commits: 3
---
# Phase quick-261022-imo Plan 01: Settings section panel scoped to category Summary
The admin shell now shows a 224px settings panel on settings forms and on settings-linked controllers that have no navigation entry of their own. It lists the permitted pages of the current entry's category in settingsGroups order and highlights the open page. It looks like the plugin side menu and collapses and expands the same way.
## What was built
- `settingsSectionOf(current)` and the `SettingsSection` type in `admin/src/state/useSettings.ts`. The function returns the current entry's category group from `settingsGroups`, or null when there is no current entry or the category has only one page. It is also returned from `useSettings()`.
- `admin/src/components/shell/SettingsPanel.vue` uses the same markup and classes as SectionPanel. It renders `aside[data-settings-panel]` with the category as its header, falling back to "Ustawienia" when the category is empty. Its links are `[data-settings-panel-item=<code>]` pointing to `settingsPath(entry)`, and the open page gets `aria-current="page"`. The collapse button `[data-sidebar-collapse]` collapses the panel and then moves focus to the rail's `[data-sidebar-expand]`. The header comment explains why the rail has no settings flyout.
- `AppShell.vue` gains a `settingsSection` computed. It is null when a plugin navigation entry is active. On `settings-form` routes it uses `settingsEntry(code)`, and otherwise `settingsLinkFor(controllerIdFromPath(path))`, which gives null on the /settings index. `--shell-offset` includes the panel width when either panel is showing.
- `docs/backend/settings.md`: the paragraph on linked controllers now mentions the panel, and a new "Moving between settings pages" section sits before "How values are stored".
- `modules/boardwalk/dist` was rebuilt; `scripts/check-admin-dist.sh` reports that it matches a fresh build.
## Commits
| Task | Commit | Message |
|------|--------|---------|
| 1 | 834ef98 | feat(quick-261022-imo): settings section panel scoped to the current category |
| 2 | 85476fa | test(quick-261022-imo): settings section panel coverage |
| 3 | 80bb5ae | chore(quick-261022-imo): rebuild embedded admin dist |
## Verification
- Tracer (Task 1): AppShell, useSettings, SectionPanel, PluginRail and Breadcrumbs tests all pass (36). `vue-tsc` is clean, `summer docs:build --check` reports no problems and `TestDocsTree` passes.
- Task 2: full admin suite passes, 95 files and 1478 tests; vue-tsc is clean.
- Task 3: `check-admin-dist.sh` passes, `go test -short ./modules/boardwalk` passes, and `git status` shows nothing under admin/ or modules/boardwalk/dist.
- Scope: the three commits only touch admin/, docs/backend/settings.md and modules/boardwalk/dist. No Go, pact or API files changed and no files were deleted (the hashed assets show up as renames).
## Deviations from Plan
None. The plan was executed as written. Task 2 is marked `tdd="true"`, but its tests were written after Task 1's implementation as the plan ordered, so there is no separate RED commit.
## Known Stubs
None.
## Self-Check: PASSED
- FOUND: admin/src/components/shell/SettingsPanel.vue
- FOUND: admin/tests/shell/SettingsPanel.test.ts
- FOUND: 834ef98, 85476fa, 80bb5ae

View File

@@ -0,0 +1,39 @@
# Quick 261022-k9k: admin keyboard shortcuts — decisions
Gathered 2026-10-22 with the user. Locked; do not revisit.
## WinterCMS reference
`modules/backend/behaviors/formcontroller/partials/_toolbar.php` (in `../examples/golem15-wintercms-starter`) binds `data-hotkey` on toolbar buttons, handled by `modules/system/assets/ui/js/input.hotkey.js`: the hotkey clicks the button, only while it is visible. `ctrl` and `cmd` are both bound (`ctrl+s, cmd+s`).
## Decisions
1. **Save keys** (ctrl on Linux/Windows, cmd on macOS; both accepted):
- `ctrl+s`: Save on update forms, Create on create forms.
- `ctrl+enter`: Save and close on update forms, Create and close on create forms.
- `ctrl+shift+s`: Create and new, on create forms only. A "Create and new" button is added to the create-form footer (saves, then opens a blank create form for the same model). WinterCMS lang key `backend::lang.form.create_and_new`.
- Apply to every save surface: record FormView (create/update, singleton), settings forms, AccountView (save only).
- Shortcuts respect the same disabled state as the buttons (busy, loading, active uploads) and preventDefault the browser's "Save page".
2. **Extras, all in scope:**
- `/` focuses list search (list views with search shown).
- `Esc` on forms = cancel/back via the existing dirty-form confirmation, unless a dialog, popover, dropdown or the rich-editor link popover is open (they consume Esc first).
- `?` opens a shortcut help dialog listing the shortcuts available on the current screen.
- Button tooltips/hints: save buttons show their shortcut (e.g. `Save (Ctrl+S)`, rendered as ⌘ on macOS).
3. **Modals:** when a relation-manager (or any) modal form is open, form shortcuts target the innermost open dialog's form only; the record form underneath ignores them.
4. **Inside editors:** modifier shortcuts (`ctrl+s`, `ctrl+enter`, `ctrl+shift+s`) fire everywhere, including the rich editor, code fields and textareas. Plain-key shortcuts (`/`, `?`, and `Esc` on forms is fine) never fire while focus is in an input, textarea, select or contenteditable.
## Constraints
- No new npm dependency (CLAUDE.md: standard library first; implement a small composable rather than adding e.g. hotkeys-js or @vueuse).
- Rebuild and commit `modules/boardwalk/dist`; `scripts/check-admin-dist.sh` must pass.
- Translation strings for new labels go through the existing lang mechanism (check where `backend::lang.form.save_and_close` is defined, in Go and/or admin).
- Docs: update the admin docs page(s) that describe forms/lists, if any, in the same commit as the feature.
## Plan review answers (2026-10-22)
1. Create-form labels stay as they are (Zapisz / Zapisz i zamknij); only "Utwórz i nowy" is added.
2. Settings forms get a "Save and close" button bound to ctrl+enter (saves, then goes to /settings).
3. No Esc on settings forms or My account (they have no dirty-form confirmation).
4. Esc does nothing while focus is in a field — accepted.
5. Rich-editor conflicts (ctrl+enter vs hard break, ctrl+shift+s vs strikethrough) accepted for now; a g15office decision ticket tracks a future rethink.
6. Modal forms map ctrl+s and ctrl+enter to their single submit button, picker "Add (n)" included — accepted.

View File

@@ -0,0 +1,302 @@
---
phase: quick-261022-k9k
plan: 01
quick_id: 261022-k9k
slug: keyboard-shortcuts-in-the-admin-spa-ctrl
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- K9K-01 # D1: ctrl/cmd+s = Save (update) / the create button (create) on FormView, settings forms, AccountView; browser "Save page" prevented
- K9K-02 # D1: ctrl/cmd+enter = Save and close on FormView (create and update, singleton)
- K9K-03 # D1: ctrl/cmd+shift+s + new "Create and new" footer button on create forms (backend::lang.form.create_and_new): save, then a blank create form of the same model
- K9K-04 # D1: shortcuts respect the buttons' disabled state (busy, loading, active uploads)
- K9K-05 # D2: "/" focuses the list search; Esc on record forms = Cancel through the dirty-form confirmation unless a dialog/popover/dropdown/link popover is open; "?" opens a help dialog of the current screen's shortcuts
- K9K-06 # D2: save buttons show their shortcut in a tooltip (Save (Ctrl+S), ⌘ on macOS)
- K9K-07 # D3: with a modal form open, form shortcuts reach only the innermost dialog's form
- K9K-08 # D4: modifier shortcuts fire in inputs, textareas, code fields and the rich editor; plain keys never fire in an editable control
- K9K-09 # constraints: no new npm dependency, lang strings through phrasebook YAML, docs updated with the feature, dist rebuilt and check-admin-dist.sh green
files_modified:
# Task 1: hotkey core, record form save keys, Create and new, strings, forms doc, tracer test
- admin/src/app/hotkeys.ts
- admin/src/components/ui/Button.vue
- admin/src/components/shell/AppShell.vue
- admin/src/App.vue
- admin/src/state/useRemount.ts
- admin/src/views/FormView.vue
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- admin/tests/fixtures/lang.json
- admin/tests/smoke/shortcuts.smoke.test.ts
- docs/backend/forms.md
# Task 2: remaining surfaces, help dialog, admin SPA doc
- admin/src/components/shell/ShortcutHelpDialog.vue
- admin/src/components/list/ListToolbar.vue
- admin/src/views/SettingsFormView.vue
- admin/src/views/AccountView.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/relation/RelationPivotModal.vue
- admin/src/components/relation/RelationPickerModal.vue
- admin/src/components/form/fields/FileCaptionModal.vue
- admin/src/components/account/ApiTokenCreateDialog.vue
- docs/backend/admin-spa.md
# Task 3: tests, then the embedded build
- admin/tests/helpers.ts
- admin/tests/app/hotkeys.test.ts
- admin/tests/shell/ShortcutHelpDialog.test.ts
- modules/boardwalk/dist
estimate:
tokens: 150000
raw_tokens: 150000
tasks: 3
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "On an update record form (/acme/demo/widgets/1), keydown Ctrl+S or Cmd+S anywhere (body, a text input, a textarea, the rich editor) sends exactly one PUT to the record, the event is defaultPrevented (no browser Save page), and the form stays; Ctrl+Enter sends the PUT and then follows update.redirectClose (singleton: /settings)."
- "On a create form (/acme/demo/widgets/create), Ctrl+S POSTs and follows create.redirect, Ctrl+Enter POSTs and follows create.redirectClose, and the footer has a new outline button [data-action=\"save-new\"] labelled backend::lang.form.create_and_new; that button and Ctrl+Shift+S POST the record and then show an empty create form at the same URL, whose next save carries a different X-Session-Key."
- "No shortcut clicks a disabled button: while busy, loading, schema missing or an upload is active, Ctrl+S / Ctrl+Enter / Ctrl+Shift+S send nothing; auto-repeat (event.repeat) never triggers a second save."
- "With a modal form open (relation picker, child, pivot, file caption, API token create), Ctrl+S and Ctrl+Enter trigger only that modal's primary button; the record form underneath sends no PUT. With a ConfirmDialog or the shortcut help dialog innermost, Ctrl+S triggers nothing (but is still defaultPrevented)."
- "On a settings form Ctrl+S sends PUT /settings/{code}; on My account Ctrl+S sends PUT /account."
- "Esc on a record form with focus outside input/textarea/select/contenteditable and no Reka layer open acts as Cancel: a clean form navigates to its back path, a dirty form shows the existing discard confirmation. Esc in an input, with a dialog, popover, dropdown or the rich-editor link popover open, or after a component already handled it (defaultPrevented) does nothing to the form."
- "'/' on a list with search focuses input[data-list-search] without typing the slash; '?' opens a dialog [data-shortcut-help] that lists exactly the shortcuts present on the current screen plus '?'; neither fires while focus is in an editable control."
- "Save buttons carry title 'Zapisz (Ctrl+S)' style hints (macOS: '⌘S', '⌘↩', '⇧⌘S') and an aria-keyshortcuts attribute listing both Control and Meta forms."
- "modules/boardwalk/dist matches a fresh build of admin/ (scripts/check-admin-dist.sh exits 0); no npm dependency was added (admin/package.json and package-lock.json unchanged)."
artifacts:
- path: admin/src/app/hotkeys.ts
provides: "Dependency-free hotkey core: combo parsing, platform labels, innermost-modal root, one refcounted window listener pair, help-dialog state"
contains: "installHotkeys"
- path: admin/src/components/ui/Button.vue
provides: "hotkey prop rendering data-hotkey and aria-keyshortcuts on button and RouterLink"
contains: "data-hotkey"
- path: admin/src/state/useRemount.ts
provides: "remountView() + remountRevision used by App.vue's view key for Create and new"
contains: "remountView"
- path: admin/src/components/shell/ShortcutHelpDialog.vue
provides: "'?' help dialog listing the current screen's shortcuts"
contains: "data-shortcut-help"
- path: admin/tests/app/hotkeys.test.ts
provides: "unit tests of the hotkey core"
- path: modules/boardwalk/dist
provides: "embedded admin build with the shortcuts"
key_links:
- from: admin/src/components/shell/AppShell.vue
to: admin/src/app/hotkeys.ts
via: "installHotkeys() on mount, its uninstall on unmount; ShortcutHelpDialog mounted next to Toast"
- from: admin/src/app/hotkeys.ts
to: "buttons carrying data-hotkey (FormView, SettingsFormView, AccountView, modal primary buttons, ListToolbar search)"
via: "the listener resolves the innermost aria-modal dialog (else document), finds the first [data-hotkey~=combo] element there and clicks it (focuses it for an input) unless it is disabled"
- from: admin/src/views/FormView.vue
to: admin/src/App.vue
via: "onSaveAndNew -> remountView() bumps remountRevision, which is part of the RouterView component key, so the create form remounts blank"
---
<objective>
Keyboard shortcuts for the admin SPA, modelled on WinterCMS `data-hotkey` (the hotkey clicks the toolbar button that carries it): Ctrl/Cmd+S, Ctrl/Cmd+Enter and Ctrl/Cmd+Shift+S on every save surface, a new "Create and new" button on create forms, `/` for list search, Esc as Cancel on record forms, `?` for a help dialog, and shortcut hints on save buttons. Modal forms take the save shortcuts from the page underneath (D3). Plain keys stay out of editable controls; modifier keys work everywhere (D4).
Purpose: WinterCMS parity for administrators who save with the keyboard, plus the help and search keys the user asked for. All locked decisions in 261022-k9k-CONTEXT.md (D1 save keys, D2 extras, D3 modals, D4 editors) are implemented as written.
Output: a dependency-free hotkey module, wiring on FormView / SettingsFormView / AccountView / ListToolbar / five modals, a help dialog, a Create-and-new remount, new phrasebook strings (en, pl), docs in docs/backend/forms.md and docs/backend/admin-spa.md, vitest coverage, and a rebuilt modules/boardwalk/dist. SPA plus phrasebook YAML only: no API, pact or Go code change.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@/media/nvme/dev/golem15/summercms.io/summercms/summercms.go/CLAUDE.md
@/media/nvme/dev/golem15/summercms.io/summercms/summercms.go/.planning/STATE.md
@/media/nvme/dev/golem15/summercms.io/summercms/summercms.go/.planning/quick/261022-k9k-keyboard-shortcuts-in-the-admin-spa-ctrl/261022-k9k-CONTEXT.md
Source files the executor reads before editing:
@admin/src/views/FormView.vue
@admin/src/components/ui/Button.vue
@admin/src/components/shell/AppShell.vue
@admin/src/App.vue
@admin/src/app/i18n.ts
@admin/src/components/form/fields/FileCaptionModal.vue (smallest modal; markup to mirror for the help dialog)
@admin/tests/helpers.ts
@admin/tests/smoke/edit.smoke.test.ts
@modules/phrasebook/backend/lang/en/lang.yaml
@modules/phrasebook/backend/lang/pl/lang.yaml
@../examples/golem15-wintercms-starter/modules/backend/behaviors/formcontroller/partials/_toolbar.php
Facts established during planning (do not re-derive):
- Concurrency: at planning time another session (phase 19.6.1 plan 05, gap G-19.6.1-T2) had uncommitted edits in admin/src/views/FormView.vue, admin/src/components/relation/RelationChildModal.vue, admin/src/components/form/formContext.ts, admin/src/components/form/fields/RelationField.vue and admin/tests/form/FormView.test.ts. Do not start until they are committed (see the Task 1 precondition). Refer to FormView by function names (save, onSave, onSaveAndClose, onLeave, guard), never by line numbers.
- Reka (reka-ui 2.9.10) DismissableLayer, used by every Dialog, AlertDialog, Popover, DropdownMenu, Select and Combobox content, renders a data-dismissable-layer attribute and listens for Escape with a plain window keydown listener (via its bundled @vueuse onKeyStroke) and does NOT call preventDefault when it dismisses. So "a layer consumes Esc" cannot be detected through defaultPrevented; the Esc rule checks the DOM for any [data-dismissable-layer] element instead.
- Every admin modal sets aria-modal="true" on its Reka DialogContent (RelationChildModal, RelationPivotModal, RelationPickerModal, FileCaptionModal, ApiTokenCreateDialog). ConfirmDialog is a Reka AlertDialog (role alertdialog). Reka PopoverContent also has role dialog but no aria-modal (LinkPopover, date pickers): a popover is NOT a modal root. Portals append to body in open order, so the last matching modal in document order is the innermost.
- Non-Reka components that handle Escape already call preventDefault (SectionFlyout, PluginRail, RelationField when its list is open), and they handle it on the element, so a window listener in the bubble phase sees defaultPrevented.
- TipTap StarterKit (admin/src/components/form/richeditor/editor.ts) keeps HardBreak (Mod-Enter) and Strike (Mod-Shift-s) enabled and handles keydown on the editor element. To make D4 hold (modifier shortcuts fire inside the rich editor) without TipTap also inserting a hard break or toggling strike, the modifier listener runs in the window CAPTURE phase and calls preventDefault and stopPropagation whenever a matching hotkey element exists in the active root. When no element carries the combo (for example Ctrl+Shift+S on an update form), the event passes through untouched, so TipTap strike and hard break keep working there.
- AltGr on Windows/Linux arrives as ctrlKey plus altKey (Polish layout: AltGr+S types the s-acute letter). Modifier combos therefore require altKey false.
- App.vue keys the routed view by current.path, so pushing the same create path does not remount FormView. Create and new remounts through a revision counter appended to that key.
- Buttons in FormView's footer are the shared Button component; attrs such as title fall through to the rendered button or RouterLink. In FileCaptionModal, RelationPivotModal and RelationPickerModal the primary buttons are native button elements (data-action save-caption, save-pivot, confirm-link); RelationChildModal (save-child) and ApiTokenCreateDialog (create-token-submit, type submit, step 1 only) use Button.
- Strings: framework admin strings live in modules/phrasebook/backend/lang/{en,pl}/lang.yaml as backend::lang.group.key. modules/phrasebook TestPhase10SPAKeysResolve scans every .ts/.vue under admin/src with the regex backend::lang followed by dot-separated segments and requires each match to resolve to a leaf in both pl and en. Consequence: every backend::lang key literal written in admin/src (comments included) must be a full leaf key that exists in both YAML files; never write a group prefix or a wildcard after backend::lang in a comment. A YAML value that starts with a colon must be quoted.
- admin/tests/fixtures/lang.json is a hand-maintained Polish bundle (keys sorted alphabetically, each value an object with "other"); tests call setBundle(lang.data, 'pl'). New keys must be added there in Polish.
- Existing Polish copy: form.save Zapisz, form.save_and_close Zapisz i zamknij, form.cancel Anuluj, form.create Utwórz, form.close Zamknij. Create forms keep their current Save / Save and close labels (this plan does not relabel them; see the review note in Task 1).
- Smoke tests mount the whole App through mountApp(path, routes, { attach: true }) from admin/tests/helpers.ts; attach is required because the hotkey listener queries document. The widgets fixtures route GET /admin-test/api/v1/acme/demo/widgets/schema/form and GET .../widgets/1 (see edit.smoke.test.ts).
- vitest runs with cwd admin/ through npm --prefix admin; test filters are relative to admin/. Never run npm ci (shared node_modules); check-admin-dist.sh runs it only when admin/node_modules is missing.
- Docs checker: only pkg.Ident-shaped code spans are checked as identifiers; key names such as Ctrl+S and attribute names are safe. Relative links and anchors are checked.
</context>
<tasks>
<task type="tracer">
<name>Task 1: Hotkey core and record-form save keys end to end (Ctrl+S, Ctrl+Enter, Ctrl+Shift+S with Create and new)</name>
<precondition>git status --porcelain -- admin modules/boardwalk/dist modules/phrasebook docs prints nothing (the 19.6.1-05 session has committed its FormView, RelationChildModal, formContext, RelationField and FormView.test.ts edits); admin/node_modules exists.</precondition>
<files>admin/src/app/hotkeys.ts, admin/src/components/ui/Button.vue, admin/src/components/shell/AppShell.vue, admin/src/App.vue, admin/src/state/useRemount.ts, admin/src/views/FormView.vue, modules/phrasebook/backend/lang/en/lang.yaml, modules/phrasebook/backend/lang/pl/lang.yaml, admin/tests/fixtures/lang.json, admin/tests/smoke/shortcuts.smoke.test.ts, docs/backend/forms.md</files>
<action>
Implements D1 (save keys, disabled state, preventDefault, Create and new), the D3 root rule and the D4 editor rule in the core; Task 2 wires the remaining surfaces. No npm dependency (no hotkeys-js, no direct @vueuse import).
1. admin/src/app/hotkeys.ts (new, no imports beyond vue and ./i18n). Header comment in the project's style: the WinterCMS model (a data-hotkey attribute on the button, the hotkey clicks it), the supported combos, the modal root rule (D3), the editable rule (D4), why the modifier listener is in the capture phase (TipTap Mod-Enter / Mod-Shift-s, see context facts) and why the Esc check reads the DOM (Reka does not preventDefault). Exports:
- type HotkeyCombo, the union of the six tokens mod+s, mod+enter, mod+shift+s, escape, the slash and the question mark. Tokens in a data-hotkey attribute are space separated; mod means Ctrl or Cmd, both accepted on every platform (WinterCMS binds ctrl+s and cmd+s).
- SHORTCUTS: readonly ordered list of objects with combo and labelKey, in this order: mod+s with backend::lang.form.save, mod+enter with backend::lang.form.save_and_close, mod+shift+s with backend::lang.form.create_and_new, escape with backend::lang.shortcuts.leave, the slash with backend::lang.shortcuts.search, the question mark with backend::lang.shortcuts.help. Write each key as a full string literal.
- isMacPlatform(platform?: string): true when the given string (default: navigator.platform when navigator exists, else empty) matches mac, iphone, ipad or ipod case-insensitively. Do not use navigator.userAgentData: TypeScript 5.9's DOM lib does not declare it and navigator.platform is enough for a label.
- comboOf(event: KeyboardEvent): HotkeyCombo or null. Null when event.isComposing. With ctrlKey or metaKey and altKey false: the letter is event.key lowercased when it is a single a-z character, else the letter of event.code when it matches Key plus a capital letter (non-Latin layouts); s with shiftKey is mod+shift+s, s without is mod+s; event.key Enter without shift is mod+enter. Without ctrl, meta and alt: Escape is escape, a slash key is the slash, a question-mark key is the question mark (shift state ignored for these two, layouts differ). Anything else null.
- isEditableTarget(target: EventTarget or null): true when the target is an Element whose closest input, textarea, select or contenteditable element (contenteditable not equal to false) exists. Every input type counts (D4 says input).
- shortcutParts(combo, mac = isMacPlatform()): string array. Non-mac: Ctrl, Shift, S / Ctrl, Enter / Ctrl, S. Mac: the shift glyph before the command glyph (Apple order), the return glyph for Enter: for mod+shift+s the parts are the shift glyph, the command glyph and S; for mod+enter the command glyph and the return glyph. escape is Esc on both; the slash and the question mark are themselves.
- shortcutLabel(combo, mac?): parts joined with a plus sign on non-mac and with nothing on mac (Ctrl+Shift+S, and on mac the three glyphs run together).
- shortcutHint(label: string, combo, mac?): t('backend::lang.shortcuts.hint', { label, keys: shortcutLabel(combo, mac) }).
- ariaKeyshortcuts(hotkey: string): the aria-keyshortcuts value for a space-separated token list: each mod token yields a Control form and a Meta form (Control+S Meta+S, Control+Shift+S Meta+Shift+S, Control+Enter Meta+Enter), escape yields Escape, the slash and question mark themselves; joined by spaces.
- hotkeyRoot(doc: Document = document): ParentNode. All elements matching role dialog with aria-modal true, or role alertdialog, whose data-state is not closed; the last one in document order, else doc.
- hotkeyTarget(combo, root): the first element in root matching the attribute-contains-word selector for data-hotkey and the combo, or null.
- availableShortcuts(doc: Document = document): the SHORTCUTS entries whose combo has a hotkeyTarget in hotkeyRoot(doc), plus the question-mark entry always, in SHORTCUTS order.
- shortcutHelp: a readonly ref holding the SHORTCUTS entries shown by the help dialog, or null when closed; openShortcutHelp() sets it to availableShortcuts(); closeShortcutHelp() sets it to null. (Task 2 renders the dialog.)
- installHotkeys(): () => void. Reference counted: the first call adds the two window listeners, every call returns an idempotent uninstall, and the listeners are removed when the count returns to zero (tests that leak mounts never get duplicate listeners).
Listener behaviour. Capture-phase keydown (modifier combos only): resolve combo; if it is not a mod combo return; if it is mod+s call preventDefault always (no browser Save page in the shell). Find hotkeyTarget in hotkeyRoot(target's ownerDocument or document). No target: return (mod+enter and mod+shift+s pass through untouched). Target found: preventDefault and stopPropagation; then return without clicking when event.repeat is set or the target matches :disabled or has aria-disabled true; otherwise call target.click(). No editable check for modifier combos (D4). Bubble-phase keydown (plain keys only): return when the combo is not escape, slash or question mark, when event.defaultPrevented, when isEditableTarget(event.target), or when any element with data-dismissable-layer exists in the document (dialog, popover, dropdown, select, link popover: D2). Question mark: preventDefault and openShortcutHelp(). Slash and escape: hotkeyTarget in the document; none, disabled or aria-disabled: return; else preventDefault, then focus() plus select() when it is an input or textarea, otherwise click().
2. admin/src/components/ui/Button.vue: optional prop hotkey (string, default undefined). On both the RouterLink branch and the button branch render data-hotkey bound to the prop and aria-keyshortcuts bound to ariaKeyshortcuts(hotkey) when set, undefined otherwise. Extend the header comment by one sentence (a hotkey prop marks the button for the admin's keyboard shortcuts).
3. admin/src/state/useRemount.ts (new): a module-level ref revision exported read-only as remountRevision, and remountView() incrementing it. Header comment: lets a view ask App to remount the current route's component in place (Create and new).
4. admin/src/App.vue: the RouterView component key becomes current.path joined with remountRevision (for example path, a hash sign, revision). Update the comment above it: still keyed by path for the reasons given, plus the revision so a view can remount itself.
5. admin/src/components/shell/AppShell.vue: import installHotkeys and closeShortcutHelp; call installHotkeys() during setup and register an onBeforeUnmount that runs the returned uninstall and closeShortcutHelp(). Mention the shortcuts in the header comment (installed here so only signed-in shell screens answer them).
6. admin/src/views/FormView.vue (per D1, D2 tooltips):
- Import remountView and shortcutHint. Add async function onSaveAndNew with a doc comment (Utwórz i nowy, WinterCMS create_and_new: saves, then a blank create form of the same model in place; ignores both redirects): await save(); when it returned a record, call remountView().
- Footer, inside the right-hand group, between Cancel and Save and close: a Button shown only when mode is create, variant outline, data-action save-new, hotkey mod+shift+s, title shortcutHint(t('backend::lang.form.create_and_new'), 'mod+shift+s'), the same disabled expression as the save buttons (busy, loading, no schema, active uploads), click onSaveAndNew, text t('backend::lang.form.create_and_new').
- Save and close Button: add hotkey mod+enter and title shortcutHint(t('backend::lang.form.save_and_close'), 'mod+enter'). Save Button: add hotkey mod+s and title shortcutHint(t('backend::lang.form.save'), 'mod+s'). Disabled expressions unchanged, so D1's disabled rule holds through the button.
- Update the view's header comment (the footer now also holds Create and new on create forms; the save buttons answer the shortcuts).
7. Strings (all of them, Task 2 adds none). modules/phrasebook/backend/lang/en/lang.yaml: under form add create_and_new: Create and new. Add a new top-level group shortcuts after settings with title: Keyboard shortcuts, description: Shortcuts available on this screen., hint: quoted ":label (:keys)", leave: Cancel and go back, search: Go to search, help: Show keyboard shortcuts. modules/phrasebook/backend/lang/pl/lang.yaml: form create_and_new: Utwórz i nowy; shortcuts title: Skróty klawiaturowe, description: Skróty dostępne na tym ekranie., hint: quoted ":label (:keys)", leave: Anuluj i wróć, search: Przejdź do wyszukiwania, help: Pokaż skróty klawiaturowe. admin/tests/fixtures/lang.json: the same seven keys with the Polish texts, inserted in sorted position.
8. admin/tests/smoke/shortcuts.smoke.test.ts (new, tracer check): beforeEach/afterEach as in edit.smoke.test.ts (clearUser, setNavigation([]), clearToasts, setBundle(lang.data, 'pl'); clear document.body afterwards, unmount the wrapper). One describe "record form save shortcuts" with: (a) mount /acme/demo/widgets/1 with attach true and a PUT route for the record replying the record fixture; dispatch on document.body a bubbling, cancelable keydown with key s and ctrlKey true; expect the event defaultPrevented, flushPromises, exactly one PUT to the record; repeat with metaKey true and expect a second PUT. (b) the Save button has title Zapisz (Ctrl+S) when navigator.platform reads as Linux (stub the getter with vi.spyOn if happy-dom reports something else). Task 3 adds the remaining cases.
9. docs/backend/forms.md, same commit (CONTEXT: docs with the feature): after the paragraph that starts with modelClass in the config_form.yaml section, add a short paragraph in the page's plain style: Save follows redirect and Save and close follows redirectClose; the create form also has Create and new, which saves the record and opens an empty create form of the same controller, ignoring both redirects; the buttons answer Ctrl+S (Cmd+S on macOS), Ctrl+Enter and, on the create form, Ctrl+Shift+S. No cross-page anchor (Task 2 adds the shortcuts section).
Review note to keep visible in the SUMMARY (not an action): create forms keep the Zapisz / Zapisz i zamknij labels; WinterCMS labels them Create / Create and close. The plan did not relabel them because no decision asked for it.
Run go test -short ./modules/phrasebook before committing. Commit by path (never git add -A): feat(quick-261022-k9k): admin save shortcuts and Create and new on record forms. No co-author tag.
</action>
<verify>
<automated>npm --prefix admin run test -- tests/smoke/shortcuts.smoke.test.ts tests/smoke/edit.smoke.test.ts tests/smoke/form.smoke.test.ts tests/form/FormView.test.ts tests/views/App.test.ts && npm --prefix admin run typecheck && go test -short ./modules/phrasebook -count=1 && go run ./cmd/summer docs:build --check</automated>
</verify>
<done>Ctrl+S and Cmd+S on an update form send one PUT with the browser default prevented; the create form shows Utwórz i nowy; the listed suites, vue-tsc, the phrasebook key test and the docs checker pass; one feat commit holds the eleven files. If an existing FormView or smoke assertion breaks only because the create footer gained a button, adjust that assertion in this commit and name it in the SUMMARY.</done>
</task>
<task type="auto">
<name>Task 2: Remaining surfaces: settings, account, modal forms, list search, Esc, the '?' help dialog and the admin SPA doc</name>
<files>admin/src/components/shell/ShortcutHelpDialog.vue, admin/src/components/shell/AppShell.vue, admin/src/components/list/ListToolbar.vue, admin/src/views/FormView.vue, admin/src/views/SettingsFormView.vue, admin/src/views/AccountView.vue, admin/src/components/relation/RelationChildModal.vue, admin/src/components/relation/RelationPivotModal.vue, admin/src/components/relation/RelationPickerModal.vue, admin/src/components/form/fields/FileCaptionModal.vue, admin/src/components/account/ApiTokenCreateDialog.vue, docs/backend/admin-spa.md</files>
<action>
Implements the rest of D1 (settings forms and AccountView), D2 (slash, Esc, help dialog, hints), D3 (modal forms) on top of the Task 1 core. The core already has the listeners; this task only marks elements and adds the dialog.
1. admin/src/components/shell/ShortcutHelpDialog.vue (new). Mirror FileCaptionModal's Reka Dialog markup (DialogRoot, DialogPortal, DialogOverlay with the same classes, DialogContent with the same modal classes and max-w-[440px], DialogTitle, DialogDescription, DialogClose X button with aria-label t('backend::lang.form.close')). DialogRoot open is shortcutHelp !== null; on update:open false call closeShortcutHelp(). DialogContent carries data-shortcut-help and aria-modal true. Title t('backend::lang.shortcuts.title'), description t('backend::lang.shortcuts.description'). Body: a dl with one row per shortcutHelp entry, data-shortcut set to the combo: a dt holding one kbd element per shortcutParts(combo) item (small bordered chip classes in the admin's token style, for example rounded-pager border border-border bg-subtle px-1.5 font-mono text-[13px]) and a dd with t(entry.labelKey). Text interpolation only. Header comment: what it lists (the current screen's shortcuts, read from the page when '?' was pressed), that Esc and the close button close it.
2. admin/src/components/shell/AppShell.vue: import and render ShortcutHelpDialog right after Toast.
3. admin/src/views/FormView.vue: the footer Cancel Button gets hotkey escape (D2 Esc = Cancel through onLeave, which already asks for a dirty form). The back arrow keeps no hotkey (one target per combo).
4. admin/src/views/SettingsFormView.vue (D1 settings forms): the Save Button gets hotkey mod+s and title shortcutHint(t('backend::lang.form.save'), 'mod+s'). Add a "Save and close" Button (user decision at plan review, matching WinterCMS settings/update.php): variant outline, data-action="save-close", label backend::lang.form.save_and_close, same disabled state as Save, hotkey mod+enter, title shortcutHint(..., 'mod+enter'), placed before Save like FormView's footer; onSaveAndClose awaits the same save path as onSave and, only when it succeeded (no errors), navigates to /settings (the Cancel target). No Esc: the settings form has no dirty-form confirmation, so binding Esc to its Cancel link would discard edits silently, which contradicts D2's "via the existing dirty-form confirmation". Say so in one comment line next to the footer.
5. admin/src/views/AccountView.vue (D1 save only): the footer Save Button gets hotkey mod+s and title shortcutHint(t('backend::lang.form.save'), 'mod+s'). No Esc (no Cancel or dirty confirmation on this screen). The ApiTokensPanel's create dialog is covered by step 6.
6. Modal forms (D3: the innermost dialog's form takes the save keys; the core's root rule already ignores the page underneath). On each modal's primary submit, add data-hotkey "mod+s mod+enter" (its single submit already closes the modal, so both keys mean the same) and aria-keyshortcuts from ariaKeyshortcuts with the same value, plus a title from shortcutHint with the button's own label expression and mod+s. Use the hotkey prop where the element is the Button component (RelationChildModal save-child, ApiTokenCreateDialog create-token-submit which exists only on step 1) and plain attributes where it is a native button (FileCaptionModal save-caption, RelationPivotModal save-pivot, RelationPickerModal confirm-link). Do not change any disabled expression or handler; a disabled primary button makes the shortcut a no-op, as on the page. RelationChildModal's preview mode shows no submit, so it has no target and the keys do nothing there.
7. admin/src/components/list/ListToolbar.vue (D2 slash): the search input gets data-hotkey set to the slash and aria-keyshortcuts set to the slash. It only exists when showSearch is true, so lists without search have no target.
8. docs/backend/admin-spa.md, same commit: a new section titled "## Keyboard shortcuts" right before "## Types from OpenAPI", plain prose plus one table (key, where, what), modelled on WinterCMS's toolbar hotkeys: Ctrl+S (Cmd+S on macOS, both accepted everywhere) saves on record forms, settings forms and My account and creates on a create form; Ctrl+Enter saves and closes (creates and closes); Ctrl+Shift+S runs Create and new on a create form; Esc on a record form works like Cancel and asks first when there are unsaved changes; the slash focuses the list search; the question mark shows the shortcuts of the current screen. Then the rules: a shortcut does what its button does and nothing while the button is disabled (saving, loading, an upload in progress); the save keys also work while typing in a field, a code field or the rich editor, where on a record form Ctrl+Enter saves and closes instead of inserting a line break (Shift+Enter still does) and on a create form Ctrl+Shift+S creates instead of toggling strikethrough; Esc, the slash and the question mark do nothing while typing in a field or while a dialog, popover or menu is open, which closes on Esc itself; when a dialog with a form is open (a relation record, a pivot, a picker, a file caption, a new API token) Ctrl+S and Ctrl+Enter submit that dialog and never the form underneath; save buttons show their shortcut in their tooltip. Link to [Forms](forms.md) for Create and new. No anchors that do not exist.
Run the full admin suite before committing (the help dialog and the attributes must not break existing tests). Commit by path: feat(quick-261022-k9k): Esc, slash and help shortcuts, settings, account and modal save keys. No co-author tag.
</action>
<verify>
<automated>npm --prefix admin run test && npm --prefix admin run typecheck && go test -short ./modules/phrasebook -count=1 && go run ./cmd/summer docs:build --check && go test ./cmd/summer -count=1 -run '^TestDocsTree$'</automated>
</verify>
<done>Every listed element carries its data-hotkey; the help dialog renders from the shell; the whole admin suite, vue-tsc, the phrasebook test, the docs checker and TestDocsTree pass; one feat commit holds the twelve files.</done>
</task>
<task type="auto" tdd="true">
<name>Task 3: Vitest coverage for every shortcut rule, then rebuild the embedded admin dist</name>
<precondition>Tasks 1 and 2 are committed; git status --porcelain -- admin modules/boardwalk/dist prints nothing apart from this task's own edits (if another session has uncommitted admin or dist edits, stop and report instead of building over them); admin/node_modules exists (never run npm ci).</precondition>
<files>admin/tests/helpers.ts, admin/tests/app/hotkeys.test.ts, admin/tests/smoke/shortcuts.smoke.test.ts, admin/tests/shell/ShortcutHelpDialog.test.ts, modules/boardwalk/dist</files>
<behavior>
- Core (hotkeys.test.ts): comboOf maps ctrl+s, meta+s, ctrl+S with shift, ctrl+Enter, meta+Enter, Escape, slash, question mark; returns null for ctrl+alt+s (AltGr), alt+s, plain s, shift+Enter with ctrl, isComposing; uses event.code KeyS when event.key is a non-Latin letter. isMacPlatform true for MacIntel, iPhone, iPad, false for Linux x86_64 and Win32. shortcutLabel gives Ctrl+S, Ctrl+Enter, Ctrl+Shift+S, Esc on Linux and the glyph forms on mac; shortcutHint gives Zapisz (Ctrl+S). ariaKeyshortcuts('mod+s mod+enter') is Control+S Meta+S Control+Enter Meta+Enter. isEditableTarget true for input, textarea, select, a span inside contenteditable, false for a button, body and contenteditable false. hotkeyRoot returns the document without modals, the last aria-modal dialog when two are open, an alertdialog when it is last, and ignores a role dialog without aria-modal (popover) and one whose data-state is closed. installHotkeys twice then both uninstalls leaves no listener (a click spy on a data-hotkey button sees one click per keydown while installed twice and none after both uninstalls). A disabled target is consumed (defaultPrevented) but not clicked; event.repeat is consumed but not clicked; mod+enter with no target is not defaultPrevented; mod+s with no target is defaultPrevented.
- Record form (shortcuts.smoke.test.ts, mounted with attach true): Ctrl+S inside a textarea or text input saves; Ctrl+S while the record GET is still pending sends nothing; Ctrl+Enter on update PUTs then lands on the redirectClose path; on create Ctrl+S POSTs and follows create.redirect; the save-new button and Ctrl+Shift+S POST, keep the route on the create path, empty the field that was filled, and the following save sends a different X-Session-Key header; the create footer has the save-new button and the update footer does not; Esc on body with a clean update form navigates to the back path; Esc after an edit shows the discard ConfirmDialog and stays; Esc with focus in an input does nothing; Esc while a Reka layer (the ConfirmDialog) is open does not navigate; Esc whose event a component already defaultPrevented does nothing.
- Modal scope (D3), following the relation picker cases in tests/smoke/relation.smoke.test.ts: with the picker open and a candidate selected, Ctrl+S sends the link request and no PUT to the record; with the picker open and nothing selected (confirm-link disabled), Ctrl+S sends nothing at all.
- Settings and account: on a settings form the save-close button exists; Ctrl+Enter (and clicking it) sends PUT /settings/{code} then lands on /settings, and stays on the form when the PUT fails validation; on a settings form Ctrl+S sends PUT /settings/{code} (follow tests/views/SettingsFormView.test.ts or tests/smoke/settings.smoke.test.ts routes); on /account Ctrl+S sends PUT /account (follow tests/views/AccountView.test.ts); Esc on either screen does not navigate.
- List and help: on a list with search, the slash on body focuses input[data-list-search] and is defaultPrevented; the slash inside another input does nothing; a list schema without search has no target; the question mark opens [data-shortcut-help] whose rows ([data-shortcut]) are exactly mod+s, mod+enter, escape and the question mark on an update form, those plus mod+shift+s on a create form, and the slash plus the question mark on a list; the question mark inside an input does not open it; Esc closes the help dialog and does not leave the form underneath. ShortcutHelpDialog.test.ts covers the dialog alone: title Skróty klawiaturowe, kbd parts per row, the close button calls closeShortcutHelp.
</behavior>
<action>
Covers K9K-01 to K9K-08 (every locked decision has at least one test) and closes K9K-09 with the dist rebuild. Unit tests are the last code task per the project rule; fixes for bugs the tests find go into the source files in this task, as a separate fix commit before the test commit when they change behaviour.
1. admin/tests/helpers.ts: add press(target: Element, key: string, init?: KeyboardEventInit): KeyboardEvent, dispatching a bubbling, cancelable keydown with the key and init merged and returning it. Leave the existing keydown helper unchanged.
2. admin/tests/app/hotkeys.test.ts (new): behavior bullet 1. Build small DOM fixtures directly in document.body (buttons with data-hotkey, divs with role dialog and aria-modal) and call installHotkeys in each test, uninstalling in afterEach. Stub the platform through the mac parameter or vi.spyOn(navigator, 'platform', 'get').
3. admin/tests/smoke/shortcuts.smoke.test.ts: extend with behavior bullets 2 to 5 (mount with attach true everywhere; use press from helpers). For the session key check, read the X-Session-Key header of the two POST requests from the calls list.
4. admin/tests/shell/ShortcutHelpDialog.test.ts (new): bullet 5's component part, mounting the dialog with enableAutoUnmount and calling openShortcutHelp after placing data-hotkey buttons in the body.
5. Run the whole admin suite and vue-tsc. Commit the test files by path: test(quick-261022-k9k): keyboard shortcut coverage. No co-author tag.
6. Embedded build: npm --prefix admin run build; scripts/check-admin-dist.sh must report a match; go test -short ./modules/boardwalk. Stage only modules/boardwalk/dist by path (git add modules/boardwalk/dist also stages removed hashed assets) and commit: chore(quick-261022-k9k): rebuild embedded admin dist. No co-author tag. Do not push or tag.
</action>
<verify>
<automated>npm --prefix admin run test && npm --prefix admin run typecheck && scripts/check-admin-dist.sh && go test -short ./modules/boardwalk ./modules/phrasebook -count=1 && git diff --quiet HEAD -- admin/package.json admin/package-lock.json && test -z "$(git log --format=%H --grep='quick-261022-k9k' -- admin/package.json admin/package-lock.json)" && test -z "$(git status --porcelain -- admin modules/boardwalk/dist)"</automated>
</verify>
<done>Every behavior bullet has a passing test; the full admin suite and vue-tsc pass; check-admin-dist.sh exits 0; package.json and the lockfile are unchanged; the test commit and the dist commit exist and nothing is left uncommitted under admin/ or modules/boardwalk/dist.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| keyboard -> SPA actions | A keystroke now triggers saves, navigation and modal submits that previously needed a click |
| page form <-> modal form | Two forms are on screen at once while a modal is open; a shortcut must reach exactly one |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-261022-k9k-01 | Tampering | hotkeys.ts root resolution | medium | mitigate | Ctrl+S / Ctrl+Enter resolve to the innermost aria-modal dialog or alertdialog only; with a modal open the page form is never searched, so a relation modal's shortcut cannot save the record form (or the reverse). Covered by the picker smoke test and the hotkeyRoot unit tests. |
| T-261022-k9k-02 | Tampering | Esc on forms | medium | mitigate | Esc clicks the Cancel button, which runs onLeave and its dirty-form confirmation; screens without that confirmation (settings forms, My account) get no Esc binding, so Esc never discards edits silently. Esc never fires in an editable control or with a Reka layer open. |
| T-261022-k9k-03 | Denial of service | repeated keydown | low | mitigate | event.repeat is consumed without clicking, and every target keeps its disabled expression (busy, loading, uploads), so holding Ctrl+S cannot queue duplicate saves. |
| T-261022-k9k-04 | Elevation of privilege | shortcut targets | low | accept | A shortcut only clicks a button already rendered for the administrator; the API authorises every request as before. No client-side permission logic is added. |
| T-261022-k9k-SC | Tampering | npm/pip/cargo installs | high | accept | No package is added or installed (no hotkeys-js, no direct @vueuse import); npm ci is not run; Task 3's verify proves package.json and the lockfile are unchanged. |
</threat_model>
<verification>
- npm --prefix admin run test (whole suite) and npm --prefix admin run typecheck pass.
- go test -short ./modules/phrasebook (TestPhase10SPAKeysResolve: every backend::lang literal in admin/src resolves in pl and en) and go test -short ./modules/boardwalk pass.
- go run ./cmd/summer docs:build --check and go test ./cmd/summer -run '^TestDocsTree$' pass.
- scripts/check-admin-dist.sh passes after the dist commit.
- Four or five commits in order: feat (Task 1), feat (Task 2), optional fix (Task 3, only if tests found a bug), test, chore (dist). git diff --stat over them lists only admin/, modules/phrasebook/backend/lang/, docs/backend/forms.md, docs/backend/admin-spa.md and modules/boardwalk/dist.
</verification>
<success_criteria>
- An administrator saves, saves and closes, and (on create) creates and starts a new record from the keyboard with Ctrl or Cmd, on record forms, settings forms and My account, and the browser's Save page dialog never opens in the shell.
- With a modal form open, the save keys act on the modal only.
- Esc leaves a record form through the usual unsaved-changes question; the slash jumps to list search; the question mark lists the current screen's shortcuts; none of the plain keys interfere with typing.
- Save buttons show their shortcut, rendered with macOS glyphs on a Mac.
- Tests cover every rule; the docs describe it; the embedded dist is current; no dependency was added.
</success_criteria>
<output>
Create `.planning/quick/261022-k9k-keyboard-shortcuts-in-the-admin-spa-ctrl/261022-k9k-SUMMARY.md` when done
</output>

View File

@@ -0,0 +1,141 @@
---
phase: quick-261022-k9k
plan: 01
subsystem: admin
status: complete
tags: [admin, spa, keyboard, shortcuts, hotkeys, phrasebook, docs]
requires: []
provides:
- admin/src/app/hotkeys.ts (data-hotkey core, help-dialog state)
- Button hotkey prop (data-hotkey, aria-keyshortcuts)
- Create and new on create forms (remountView)
- ShortcutHelpDialog ('?')
- Save and close on settings forms
affects:
- admin/src/views/FormView.vue
- admin/src/views/SettingsFormView.vue
- admin/src/views/AccountView.vue
- five modal forms
- modules/boardwalk/dist
tech-stack:
added: []
patterns:
- "WinterCMS-style data-hotkey: the shortcut clicks the button carrying the token, so it inherits the button's disabled state"
- "Innermost aria-modal dialog / alertdialog as the hotkey root (modal forms take the save keys)"
- "Capture-phase modifier listener that stops the event only when a target exists (TipTap / editors keep their keys otherwise)"
- "Plain keys check the DOM for [data-dismissable-layer] because Reka does not preventDefault on Esc"
key-files:
created:
- admin/src/app/hotkeys.ts
- admin/src/state/useRemount.ts
- admin/src/components/shell/ShortcutHelpDialog.vue
- admin/tests/app/hotkeys.test.ts
- admin/tests/shell/ShortcutHelpDialog.test.ts
- admin/tests/smoke/shortcuts.smoke.test.ts
modified:
- admin/src/components/ui/Button.vue
- admin/src/components/shell/AppShell.vue
- admin/src/App.vue
- admin/src/views/FormView.vue
- admin/src/views/SettingsFormView.vue
- admin/src/views/AccountView.vue
- admin/src/components/list/ListToolbar.vue
- admin/src/components/relation/RelationChildModal.vue
- admin/src/components/relation/RelationPivotModal.vue
- admin/src/components/relation/RelationPickerModal.vue
- admin/src/components/form/fields/FileCaptionModal.vue
- admin/src/components/account/ApiTokenCreateDialog.vue
- admin/tests/helpers.ts
- admin/tests/fixtures/lang.json
- modules/phrasebook/backend/lang/en/lang.yaml
- modules/phrasebook/backend/lang/pl/lang.yaml
- docs/backend/forms.md
- docs/backend/admin-spa.md
- modules/boardwalk/dist
decisions:
- "Admin keyboard shortcuts follow WinterCMS data-hotkey: a token on the button, the key clicks it; no npm dependency"
- "Settings forms gained a Save and close button (Ctrl/Cmd+Enter, then /settings); Esc stays off settings forms and My account"
- "Create and new remounts the create view in place through a remount revision in App's RouterView key"
metrics:
duration: ~25min
completed: 2026-10-22
actuals:
tokens: 19300
tasks: 3
commits: 5
plan_head_before: 1aff96f58afe8c4ee2c47a07d1e9722fe18e0f06
plan_head_after: 604fee757e0f9846fcc4f8265e0dbd06c7fd4073
---
# Quick 261022-k9k Plan 01: Admin keyboard shortcuts Summary
Dependency-free WinterCMS-style `data-hotkey` shortcuts for the admin SPA. Ctrl/Cmd+S, Ctrl/Cmd+Enter and Ctrl/Cmd+Shift+S work on record forms, settings forms, My account and modal forms. The create form gets a new "Utwórz i nowy" button. Esc acts as Cancel on record forms, `/` jumps to the list search, `?` opens a help dialog, and the save buttons show their shortcut in a tooltip. The embedded dist is rebuilt.
## Commits
| Task | Commit | Message |
|------|--------|---------|
| 1 (tracer) | 49accf6 | feat(quick-261022-k9k): admin save shortcuts and Create and new on record forms |
| 2 | 101cad0 | feat(quick-261022-k9k): Esc, slash and help shortcuts, settings, account and modal save keys |
| 3 | 058738e | test(quick-261022-k9k): keyboard shortcut coverage |
| 3 | 604fee7 | chore(quick-261022-k9k): rebuild embedded admin dist |
`commits: 5` is `git rev-list --count 1aff96f..HEAD`. One of the five, 66bb96e ("docs: capture six user-plugin escalation quicks"), came from another session that committed between Tasks 2 and 3. This plan made 4 commits.
## What was built
- **Core (`admin/src/app/hotkeys.ts`)**:
- Combo parsing. AltGr (Ctrl+Alt) is excluded, non-Latin layouts are handled through `event.code`, IME composition is ignored.
- Labels (`Ctrl+S`, `⌘S`, `⇧⌘S`, `⌘↩`), `aria-keyshortcuts` values and `hotkeyRoot`. The root is the innermost open aria-modal dialog or alertdialog, else the document.
- One refcounted listener pair:
- Capture phase for the modifier combos. These always run, also inside editors. Ctrl+S is always defaultPrevented. The event is stopped only when a target exists. Repeats and disabled targets are consumed but not clicked.
- Bubble phase for Esc, `/` and `?`. They do not run in editable controls, after another handler's `preventDefault`, or while any `[data-dismissable-layer]` is open.
- **Button** has a `hotkey` prop that renders `data-hotkey` and `aria-keyshortcuts`. AppShell installs the listeners and renders the help dialog.
- **FormView**:
- Save is `mod+s`, Save and close is `mod+enter`, Cancel is `escape`.
- New create-only "Utwórz i nowy" (`data-action="save-new"`, `mod+shift+s`). It saves, then `remountView()` remounts the view in place. The test checks that the form is blank and the next save sends a new `X-Session-Key`.
- App.vue keys the routed view by path plus the remount revision.
- **SettingsFormView**:
- Save is `mod+s`.
- New "Zapisz i zamknij" button (`data-action="save-close"`, `mod+enter`). It navigates to `/settings` only after a successful PUT.
- No Esc, with a comment explaining why.
- **AccountView**: Save is `mod+s`, and there is no Esc.
- **Modal forms**: each primary submit has `mod+s mod+enter`: RelationChildModal save-child, RelationPivotModal save-pivot, RelationPickerModal confirm-link, FileCaptionModal save-caption, ApiTokenCreateDialog create-token-submit.
- **ListToolbar**: the search input has `data-hotkey="/"`.
- **ShortcutHelpDialog**: a Reka dialog listing the shortcuts the current screen answers, one row per shortcut with `kbd` chips.
- **Strings**: `form.create_and_new` and a new `shortcuts` group (title, description, hint, leave, search, help) in en and pl, plus the Polish test fixture.
- **Docs**:
- `docs/backend/forms.md`: redirects and Create and new, with their keys.
- `docs/backend/admin-spa.md`: new "Keyboard shortcuts" section (a table plus the rules). The rich-editor conflict is described as a known trade-off, without the ticket ID.
## Review note (from the plan)
Create forms keep the Zapisz / Zapisz i zamknij labels. WinterCMS labels them Create / Create and close. Nothing was relabelled; plan review answer 1 confirmed this.
## Verification
- `npm --prefix admin run test`: 100 files, 1541 tests pass. `npm --prefix admin run typecheck` passes.
- `go vet ./...` and `go test -short ./...` pass, including `./modules/phrasebook`, where `TestPhase10SPAKeysResolve` checks the new keys.
- `go run ./cmd/summer docs:build --check` finds no problems, and `go test ./cmd/summer -run '^TestDocsTree$'` passes.
- `scripts/check-admin-dist.sh` reports that `modules/boardwalk/dist` matches a fresh build.
- `admin/package.json` and `package-lock.json` are unchanged, and nothing is left uncommitted under `admin/` or `modules/boardwalk/dist`.
- Mutation check: with `hotkeyRoot` forced to return the document, both modal-scope smoke tests fail. The D3 tests therefore exercise the modal root rule.
## Deviations from Plan
None that change behaviour. Minor points:
- Task 1's tracer smoke test defined `press` locally. Task 3 moved it into `admin/tests/helpers.ts` as planned and the test imports it from there.
- No existing FormView or smoke assertion needed adjusting for the extra create-footer button.
## Known Stubs
None.
## Threat Flags
None. The change adds no network endpoints or auth paths. The threat register's mitigations are in place: modal root (T-01), Esc only through Cancel/onLeave and never on settings or account (T-02), repeat and disabled consumed (T-03), no package installs (T-SC).
## Self-Check: PASSED
- FOUND: admin/src/app/hotkeys.ts, admin/src/state/useRemount.ts, admin/src/components/shell/ShortcutHelpDialog.vue, admin/tests/app/hotkeys.test.ts, admin/tests/shell/ShortcutHelpDialog.test.ts, admin/tests/smoke/shortcuts.smoke.test.ts
- FOUND commits: 49accf6, 101cad0, 058738e, 604fee7

View File

@@ -0,0 +1,277 @@
---
phase: quick-261022-tb4
plan: 01
quick_id: 261022-tb4
slug: password-login-must-refuse-is-activated-
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: false
requirements:
- tb4-1 # G2: password POST /login refuses is_activated=false while golem15.user.activation.require_activation is true (default), with the opaque invalid-login answer; deleted_at restore-on-login unchanged
files_modified:
# sm-user-plugin (module golem15.user), worked in the sm-demo-app submodule checkout
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/session_test.go
- ../sm-demo-app/plugins/golem15/user/account_test.go
- ../sm-demo-app/plugins/golem15/user/email_verified_test.go
- ../sm-demo-app/plugins/golem15/user/admin_users_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
# only after the user's go-ahead at Task 3
- ../sm-demo-app/plugins/golem15/user (submodule pointer)
- ../sm-demo-app/go.mod
- ../sm-demo-app/go.sum
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-login-ignores-is-activated.md
- .planning/todos/done/2026-10-22-user-login-ignores-is-activated.md
estimate:
tokens: 110000
raw_tokens: 110000
tasks: 3
confidence: low
must_haves:
truths:
- "With golem15.user.activation.require_activation unset (default true) or true, POST /_user/api/v1/login with the correct password of an account whose is_activated is false answers 401 with the same status, body bytes and Content-Type/Cache-Control headers as a wrong password for that account ({\"error\":true,\"message\":\"Invalid email or password\"} by default, the invalid_login translation otherwise), carries no token and stamps no last_seen."
- "That refusal counts against the login throttle exactly like a wrong password: it adds one attempt to the user's user_throttle row, and attempt_limit such refusals suspend the account."
- "With require_activation false, a not-activated account signs in with its password (200, token, user payload) exactly as before this change."
- "An activated account signs in unchanged, and a deactivated (deleted_at set) activated account is still restored by its owner's password login, gets the reactivate mail and a working token."
- "An account that is both deactivated and not activated is refused under require_activation true before the restore runs: deleted_at stays set and no reactivate mail is sent. With require_activation false it is restored and signed in as before."
- "Login checks in this order: ban or suspension (RejectIfThrottled), password (bcrypt), activation, deleted_at restore, success bookkeeping, token. The Login doc comment and the plugin README state it, and the README says that activation gates login and deactivation does not."
- "The plugin's go vet and full Docker-backed go test are green at the single fix commit on sm-user-plugin master; nothing is pushed, tagged or pointer-bumped before the Task 3 decision."
artifacts:
- path: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
provides: "Login activation gate and refuseLogin, the one refusal path shared by the wrong-password and not-activated branches"
contains: "requireActivation && !user.IsActivated"
- path: ../sm-demo-app/plugins/golem15/user/session_test.go
provides: "TestLoginRequiresActivation; insertUser creates an activated account; insertInactiveUser and inactiveSessionToken helpers"
contains: "func TestLoginRequiresActivation"
- path: ../sm-demo-app/plugins/golem15/user/README.md
provides: "activation gates login, deactivation does not; require_activation row; Testing entry"
contains: "TestLoginRequiresActivation"
key_links:
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (Login)
to: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (registrationSettings, :810-831)
via: "Login reads the flag through the same parser /register uses, default true"
pattern: "requireActivation := registrationSettings\\(app\\)"
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (Login refusal branches)
to: ../sm-demo-app/plugins/golem15/user/classes/throttle.go (CheckAndRecordLogin, :107)
via: "refuseLogin records a failed attempt (ok=false) then writes writeInvalidLogin; used by both the wrong-password and the not-activated branch"
pattern: "refuseLogin\\("
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (activation gate)
to: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (deleted_at restore in Login)
via: "the gate sits after the password check and before the user.DeletedAt.Valid restore block, so a refused account is never restored"
pattern: "requireActivation && !user.IsActivated"
---
<objective>
Close escalation G2: the user plugin's password login hands a token to an account that is not activated, although golem15.user.activation.require_activation defaults to true and is documented as "must be activated before login". After this plan, POST /_user/api/v1/login refuses such an account with the same opaque invalid-login answer a wrong password gets, while require_activation false keeps today's behaviour and deactivation (deleted_at) stays self-service reversible.
Purpose: admin-created users start not activated (users_admin_controller.go:266) and could sign in with the password the administrator typed; /register in admin mode already withholds the token, /login did not.
Output: one fix commit on sm-user-plugin master (code, tests, README together), then a blocking human decision on tag, push and the sm-demo-app pointer bump, then the escalation note and the todo closed with the shipped version.
Decisions (planner's, within the user's brief; the executor does not revisit them):
- QD-1 Check order. Login runs: LookupByEmail (includes soft-deleted rows), RejectIfThrottled (ban, active suspension), bcrypt password check, then the activation gate, then the existing deleted_at restore, CheckAndRecordLogin(ok=true), rehash, TouchLastSeen, mint. The gate goes after the password check so a wrong password and a not-activated account both pay the bcrypt cost and cannot be told apart by timing. This matches WinterCMS: Storm's validateInternal checks the throttle and the credentials, then login() refuses a not-activated user before afterLogin(), and afterLogin() is where Golem15's User model restores a trashed account and sends the reactivate mail (Winter starter: vendor/winter/storm/src/Auth/Manager.php:403-457 and :656-683, plugins/golem15/user/models/User.php:421-433).
- QD-2 Throttle. The activation refusal records a failed attempt, exactly like a wrong password (classes.CheckAndRecordLogin with ok=false). This deviates on purpose from Storm, which clears the attempts once the password matches and only then refuses. If a correct password reset the counter or left it alone, the throttle state, and the quick pre-bcrypt answer a suspended account gets, would show that a guess was right for a not-activated account. Counting the refusal keeps the two refusals indistinguishable and keeps guessing bounded. The cost is that a not-activated owner who retries attempt_limit times (default 5) is suspended for suspension_minutes (default 15). That account cannot sign in before activation anyway, and an administrator can unsuspend it.
- QD-3 Deactivated and not activated. Under require_activation true such an account is refused before the restore, so it stays deactivated and gets no reactivate mail (Winter parity, see QD-1). Restore-on-login itself is unchanged: an activated account, and any account when require_activation is false, is restored exactly as today.
- QD-4 Config read. Login reads the flag through the existing registrationSettings(app), the parser /register uses (key golem15.user.activation.require_activation, default true). No new config key and no second parser.
- QD-5 Same answer. A new helper, refuseLogin, records the failed attempt and calls writeInvalidLogin. Both refusal branches use it, so status 401, the Cache-Control header, the JSON and the invalid_login translation key are identical by construction. Winter's own text ("Cannot login user ... as they are not activated") is not ported: the escalation asks for an opaque answer, and the Go port already gives invalid-login for bans and suspensions.
- QD-6 Scope is POST /login only. Not changed: /refresh, the jwt guard and the API-token guard (a session minted earlier for a not-activated account keeps working until it expires, or until an administrator deactivates or bans the user, which revokes it through RevokeUserAccess); sociallogin (its checkCanSignIn already refuses every not-activated account whatever the key says); controllers.FinishLogin (its callers do the activation check, as documented); /register; the unknown-email path, which skips bcrypt (pre-existing). Record the first and the last as follow-up candidates in the SUMMARY; do not implement them here.
- QD-7 Test fixtures. insertUser (session_test.go:382) now creates an activated account, because nearly all of its ~30 callers model an ordinary account that signs in. Tests whose subject is activation use two new helpers: insertInactiveUser, which has the previous insertUser shape, and inactiveSessionToken, which mints the session of a not-activated account with controllers.IssueToken, the way /register does when require_activation is false. The shared harness config (sessionConfig, newSessionApp, sessionApp, newAdminEnv) keeps require_activation at its default, so the suite tests the default.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@CLAUDE.md
@.planning/STATE.md
@.planning/todos/pending/2026-10-22-user-login-ignores-is-activated.md
@.planning/notes/2026-10-22-external-user-plugin-escalations.md
@../sm-demo-app/plugins/golem15/user/README.md
Working copies (observed at planning time, 2026-10-22):
- sm-user-plugin: ../sm-demo-app/plugins/golem15/user (absolute /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user). Detached HEAD at tag v0.1.8 = 930b158 = local master = origin/master, working tree clean. Latest tag v0.1.8. sm-demo-app's go.work does not list the plugin in `use` (it only replaces the module), so every go command in this checkout runs with GOWORK=off; the plugin's go.mod:176 replaces summercms with ../../../../summercms.go, so it builds against summercms.go's working tree.
- The escalation note says the six user-plugin quicks run sequentially, never in parallel on one tree. If master or origin/master has moved past 930b158 when execution starts, another escalation quick has landed: build on top of it (fast-forward only), and record the base and git log --oneline v0.1.8..master in the SUMMARY. The Task 3 release would then carry those commits too, and the checkpoint lists them.
- sm-demo-app (../sm-demo-app): another session has an uncommitted edit in main.go. Leave it alone. Stage only the paths named in Task 3.
- summercms.go: quick 261022-k9k (admin SPA keyboard shortcuts) is executing concurrently. This plan touches only .planning files here (the escalation note, the todo move, this quick directory), never admin/ or modules/boardwalk. Stage by explicit path, never git add -A, and update STATE.md only through msd_run query state.* handlers.
- Docker: docker info answered (server 29.9.1) from this user at planning time. If the socket is denied, run go test through sudo -u golem (CLAUDE.md).
Source facts (file:line in the plugin checkout):
- controllers/api_controller.go: invalidLoginBody const :44; Login :46-129: LookupByEmail :61, RejectIfThrottled block :67-76, wrong-password/unknown-email branch :77-86 (CheckAndRecordLogin ok=false only when user != nil, then writeInvalidLogin), deleted_at restore and reactivate mail :87-93, CheckAndRecordLogin ok=true :94-101, rehash :102-110, TouchLastSeen :111-114, mintFor/apiArray :115-127; registrationSettings :810-831 (require defaults to true, read from golem15.user.activation.require_activation); Register uses require at :782 (mode == "auto" || !require gets a token); writeInvalidLogin :1170-1175 (401, accountMessage "invalid_login").
- classes/throttle.go: RejectIfThrottled :67 (ban or active suspension, no attempt recorded); CheckAndRecordLogin :107 (a nil user or ID 0 is a no-op, ok=false increments attempts and suspends at attempt_limit, ok=true resets). classes/user_lookup.go:116 LookupByEmail loads Unscoped.
- models/user.go:21 IsActivated; updates/202609220005_extend_users.go:15 is_activated BOOLEAN NOT NULL DEFAULT FALSE; controllers/users_admin_controller.go:266 admin-created users start not activated; controllers/registration.go:107-132 FinishLogin (no activation check by contract), :185-195 IssueToken(app, user, r).
- Tests (package user, plugin root): session_test.go TestLogin :54 (fixtures ada-login :60, throttled :119, soft :133 with the restore assertions :144-156), TestLoginSixthAttempt :160 (fixture :166), postJSON :395, parseToken, captureMail, loginToken :364-380, insertUser :382-393, sessionApp :446, sessionConfig. The sessionDB Postgres container starts even under -short, so these tests need Docker either way. account_test.go TestActivate :82-96 (loginToken "activate-auth" :84; "activate-already" then sets is_activated true), TestActivateByCode :98 (insertUser :100), bearerJSON :152. email_verified_test.go TestEmailVerifiedAt :72 with subtests activate_by_code_stamps :131 (insertUser :132), activate_stamps :147 (loginToken), activate_wrong_code_no_proof :164 (loginToken), userIDByEmail :29. admin_users_test.go TestAdminUserPassword :977: the user created through the admin API is asserted not activated at :994, and :1003-1006 asserts its password login answers 200 (this is G2 as reported); the final check at :1097-1099 asserts the reset did not activate. Admin harness (admin_harness_test.go): seedUser :468 defaults IsActivated true, userLogin :637, call, bulk :603, invalidLoginBody const in session_test.go :40.
- Consumers checked: the demo seed inserts activated users (sm-demo-app/plugins/demo/console/seed.go:151-153); fonoteka creates users with RegisterOptions{Activate: true} (onboarding.go:119, console/dev_seed.go:362-367); no app config sets require_activation, so every app runs with the default true. sm-demo-app workspace tests that need a user session mint it with IssueToken or bouncer.Mint (demo_api_test.go:82, sociallogin harness_test.go:237, quizzes harness_test.go:195) and do not go through password login.
- Winter reference (../examples/golem15-wintercms-starter): vendor/winter/storm/src/Auth/Manager.php:403-457 (throttle check, credentials, addLoginAttempt on failure, clearLoginAttempts on success), :656-683 (login() refuses a not-activated user before afterLogin); plugins/golem15/user/models/User.php:421-433 (afterLogin restores a trashed user and sends the reactivate mail); plugins/golem15/user/classes/AuthManager.php:25 (requireActivation from the require_activation setting).
</context>
<tasks>
<task type="tracer" tdd="true">
<name>Task 1 (tracer): /login refuses a not-activated account under require_activation, pinned end to end on Postgres</name>
<files>../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/session_test.go</files>
<precondition>Docker is reachable for testcontainers (directly or through sudo -u golem), and git -C ../sm-demo-app/plugins/golem15/user status --short is empty.</precondition>
<behavior>
New TestLoginRequiresActivation in session_test.go. Each case uses its own fixed email, and each app comes from sessionApp(t, "0s"). Cases that need require_activation false get their own app with app.Config.Set("golem15.user.activation.require_activation", false), so the setting never leaks into another case. Fixtures are models.User literals with an explicit IsActivated value (bcrypt of "correct-horse"), so this test does not depend on the insertUser change in Task 2.
- default_refuses: require_activation unset; a not-activated account with the correct password gets 401 and a body equal to invalidLoginBody, with no token key; its users.last_seen stays NULL; its user_throttle row has attempts 1.
- same_as_wrong_password: for one not-activated account, compare the correct-password refusal with a wrong-password refusal. The status, the body bytes and the Content-Type and Cache-Control headers are equal, and each refusal adds one attempt.
- explicit_true_refuses: require_activation explicitly true gives the same 401 invalid-login answer.
- refusals_suspend: attempt_limit (default 5) correct-password refusals of a not-activated account leave its throttle row is_suspended true, as five wrong passwords do.
- off_allows: require_activation false; a not-activated account with the correct password gets 200 with a token whose sub is the user's id.
- activated_allows: an activated account gets 200 with a token (default config).
- deactivated_activated_restores: an activated account with deleted_at set gets 200 with a token; deleted_at is cleared; captureMail (published on that app) holds golem15.user::mail.reactivate-en for preferred_locale "en".
- deactivated_inactive_refused: require_activation unset; a not-activated account with deleted_at set gets the 401 invalid-login answer; deleted_at stays set; captureMail is empty.
- deactivated_inactive_off_restores: require_activation false; the same kind of account gets 200 with a token, deleted_at is cleared and the reactivate mail is sent.
</behavior>
<action>
Branch setup first, because the checkout is detached. In ../sm-demo-app/plugins/golem15/user run git fetch origin, git switch master and git merge --ff-only origin/master. Never rebase or reset someone else's commits. If master is no longer 930b158 after this, follow the rule in the context section and continue. Every go command here runs with GOWORK=off.
RED: write TestLoginRequiresActivation per the behavior block. Reuse postJSON, parseToken, captureMail, sessionApp and the invalidLoginBody const, read the users row (last_seen, deleted_at) and the user_throttle row with gdb, and give each case a t.Run name. Run it. The default_refuses, same_as_wrong_password, explicit_true_refuses, refusals_suspend and deactivated_inactive_refused cases must fail against today's code, which answers 200. Do not commit a red test: the project keeps go test green at every commit.
GREEN, in controllers/api_controller.go:
- Add refuseLogin(ctx, w, r, app, gdb, user, ip) next to writeInvalidLogin, implementing QD-5. It calls classes.CheckAndRecordLogin(ctx, gdb, user, ip, false); an error that classes.IsLoginRejected does not cover answers writeOpaque500; otherwise it answers writeInvalidLogin. CheckAndRecordLogin already ignores a nil user, so an unknown email still creates no throttle row.
- In Login, replace the body of the wrong-password/unknown-email branch (:77-86) with a call to refuseLogin and a return. Behaviour there is unchanged.
- In Login, read the flag once with _, _, _, requireActivation := registrationSettings(app) (QD-4). Directly after the password branch and before the user.DeletedAt.Valid restore block, add the gate: when requireActivation && !user.IsActivated, call refuseLogin and return (QD-1, QD-2, QD-3).
- Leave the RejectIfThrottled block, the restore block, CheckAndRecordLogin(ok=true), the rehash, TouchLastSeen and the token mint as they are.
- Rewrite the Login doc comment to state the check order from QD-1. Say that with require_activation on (the default) a not-activated account gets the same 401 invalid-login answer as a wrong password and counts as a failed attempt, and that an account that is also deactivated stays deactivated. Say that require_activation off signs such an account in as before.
Run TestLoginRequiresActivation until it passes, then also run TestLogin and TestLoginSixthAttempt. Those two may now fail because their fixtures are not activated; Task 2 fixes them. Do not commit in this task: the commit comes at the end of Task 2, once the whole suite is green.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run '^TestLoginRequiresActivation$' .</automated>
</verify>
<done>Under the default config, a not-activated account's correct password gets the byte-identical invalid-login 401 and adds one throttle attempt, and a deactivated not-activated account stays deactivated without a mail. require_activation false and activated accounts sign in as before, and the deactivated-activated restore still runs. TestLoginRequiresActivation is green; changes are uncommitted on sm-user-plugin master.</done>
</task>
<task type="auto">
<name>Task 2: existing suite on the new default, README, one plugin commit</name>
<files>../sm-demo-app/plugins/golem15/user/session_test.go, ../sm-demo-app/plugins/golem15/user/account_test.go, ../sm-demo-app/plugins/golem15/user/email_verified_test.go, ../sm-demo-app/plugins/golem15/user/admin_users_test.go, ../sm-demo-app/plugins/golem15/user/README.md (plus any further *_test.go file that the full run in this task shows failing for the activation reason, and only those)</files>
<precondition>Task 1 is done: TestLoginRequiresActivation passes on the uncommitted sm-user-plugin master.</precondition>
<action>
Fixtures (QD-7). The sites below were found by reading the code at planning time:
- session_test.go: insertUser creates the account with IsActivated true. Its doc comment says it is an activated account that can sign in. Add insertInactiveUser(t, gdb, email, password), which has the previous insertUser shape (is_activated false). Add inactiveSessionToken(t, app, gdb, email) string: it inserts with insertInactiveUser and mints the token with controllers.IssueToken. The request is an httptest POST to /_user/api/v1/login with Host example.com, so the iss claim matches what parseToken and the guard expect. Its doc comment says this is the session such an account has when require_activation is false. loginToken keeps its shape; update its doc comment (it signs in an activated account).
- session_test.go TestLogin: add IsActivated: true to the ada-login (:60), throttled (:119) and soft (:133) literals, so success, the throttle and the restore stay the subjects of those assertions. TestLoginSixthAttempt: add IsActivated: true to the sixth literal (:166).
- account_test.go: TestActivate's activate-auth account (:84) uses inactiveSessionToken. activate-already keeps loginToken; its explicit is_activated update stays and is now redundant, which is harmless. TestActivateByCode (:100) uses insertInactiveUser.
- email_verified_test.go TestEmailVerifiedAt: activate_by_code_stamps (:132) uses insertInactiveUser; activate_stamps (:147) and activate_wrong_code_no_proof (:164) use inactiveSessionToken.
- admin_users_test.go TestAdminUserPassword: replace the 200 assertion at :1003-1006 and its comment. The account the administrator created, still not activated, now gets a 401 for its correct password: use env.call to POST /_user/api/v1/login and compare rec.Body.String() with invalidLoginBody. Then the administrator activates it with env.bulk(t, token, "activate", user) and expects 200, and the password login answers 200. The comment says this is the escalation G2 case and that a request still cannot turn the activation on. At :1097-1099, the final check becomes "the reset kept the activation and the email": after.IsActivated must be true and the email unchanged. Update its comment. Change nothing else in the test.
- These callers need no edit, because the insertUser change covers them: mail_test.go softDelete, account_test.go TestResetPassword, profile_test.go, last_seen_test.go, avatar_test.go and the remaining loginToken users.
Then run the full suite. For each further failure, read the test and classify it:
(1) The fixture of an ordinary account is now refused: activate the fixture (IsActivated: true in the literal, or the seedUser mutate).
(2) The test's subject is a not-activated account signing in with a password: assert the 401 invalid-login refusal instead.
(3) The test needs a session of a not-activated account: use inactiveSessionToken.
Never set require_activation false in sessionConfig, newSessionApp, sessionApp or newAdminEnv. A failure unrelated to activation is not to be patched here: stop and report it. List every touched test with its class in the SUMMARY.
README.md (in the same commit as the code):
- Features, "Registration and activation" bullet (:19): with require_activation on (the default), POST /login refuses a not-activated account with the same 401 invalid-login answer as a wrong password and counts the attempt for the throttle. Such an account is activated by the mailed code (POST /activate-by-code answers with a token), by the invitation link or by an administrator. POST /activate serves sessions of not-activated accounts, which exist when require_activation is off.
- "Deactivation and bans" bullet (:26): activation gates login, deactivation does not. While require_activation is on, an account that is both deactivated and not activated is refused and stays deactivated.
- Configuration row for golem15.user.activation.require_activation (:210): when true, /login refuses a not-activated account (opaque invalid-login, counted as a failed attempt) and /register in admin mode returns no token; when false, both sign such an account in.
- Testing section: one sentence on TestLoginRequiresActivation and the cases it pins.
- Check that every identifier the README names exists in the package.
Verify, then commit in the plugin checkout. Stage by explicit path: controllers/api_controller.go, session_test.go, account_test.go, email_verified_test.go, admin_users_test.go, README.md, plus any test file from the classification. Commit message subject: fix: login refuses a not-activated account while require_activation is on. The body has two or three plain lines: same 401 invalid-login answer as a wrong password, counted by the throttle; checked after the password and before the deactivation restore; require_activation false keeps the previous behaviour. No Co-Authored-By or any other trailer. No push, no tag. After this commit the sm-demo-app working tree shows plugins/golem15/user as modified; leave it uncommitted until Task 3.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run 'TestLogin|TestActivate|TestResetPassword|TestEmailVerifiedAt|TestMail|TestAdminUserPassword' ./... && GOWORK=off go test -count=1 ./... && ST=$(git status --short) && test -z "$ST" && S=$(git log -1 --format=%s) && grep -q 'not-activated account while require_activation' <<<"$S"</automated>
</verify>
<done>go vet and the full Docker-backed plugin suite are green. The plugin working tree is clean, with one new fix commit on master (code, tests, README) and no trailer. Nothing is pushed or tagged. The SUMMARY lists every test touched and why.</done>
</task>
<task type="checkpoint:decision" gate="blocking-human">
<name>Task 3: Go-ahead to release sm-user-plugin and bump sm-demo-app, then close G2</name>
<files>../sm-demo-app/plugins/golem15/user (submodule pointer), ../sm-demo-app/go.mod, ../sm-demo-app/go.sum, .planning/notes/2026-10-22-external-user-plugin-escalations.md, .planning/todos/pending/2026-10-22-user-login-ignores-is-activated.md, .planning/todos/done/2026-10-22-user-login-ignores-is-activated.md (all conditional on the option chosen)</files>
<decision>Whether to publish the fix: push sm-user-plugin master with a patch tag, commit (and optionally push) the sm-demo-app pointer bump, or keep everything local.</decision>
<context>
Present to the user: git -C ../sm-demo-app/plugins/golem15/user log --oneline origin/master..master (expected: the Task 2 fix commit only, plus any earlier escalation-quick commits recorded in Task 1) and the latest tag (v0.1.8 at planning time).
Behaviour change for consumers: every app runs with require_activation at its default true, so after a bump an account that is not activated and has a password can no longer sign in with it. Before bumping any app's pointer, the user may want to count such accounts in that app's database: SELECT count(*) FROM users WHERE is_activated = false AND deleted_at IS NULL AND password IS NOT NULL AND password != ''. The demo seed creates activated users (plugins/demo/console/seed.go:151-153).
Only sm-demo-app is in scope for the pointer bump. fonoteka.go (pinned at v0.1.6), sm-bm-app, sm-grzybyfunkcjonalne-app and sm-summercmsio-app (v0.1.8) are separate decisions; list them in the SUMMARY as follow-ups.
Changelog: the CLAUDE.md rule names framework release tags. Ask whether this plugin tag gets a summercms.io/changelog post. If yes, follow CLAUDE.md's changelog-post.py steps from ../sm-summercmsio-app and never print the token.
</context>
<options>
<option id="release">
<name>Tag and push the plugin; commit the sm-demo-app bump locally</name>
<pros>G2 ships as a version the external app can pin; the escalation reply can name it.</pros>
<cons>Behaviour change for every app that later bumps; sm-demo-app's bump stays unpushed until asked.</cons>
</option>
<option id="release-push-demo">
<name>As release, and also push sm-demo-app</name>
<pros>The demo app runs the fix as soon as it is next deployed.</pros>
<cons>Pushes sm-demo-app's whole unpushed range (show git log --oneline origin/master..master there first); deploying is still separate.</cons>
</option>
<option id="hold">
<name>Keep everything local</name>
<pros>Nothing leaves the machine; other escalation fixes can join the same tag.</pros>
<cons>G2 stays open for the external app; the note's G2 row and reply paragraph are not filled.</cons>
</option>
</options>
<action>
After the user's answer, carry out only the chosen option.
release / release-push-demo:
1. Plugin, in ../sm-demo-app/plugins/golem15/user: git fetch origin and confirm origin/master is an ancestor of master. Pick the next free patch tag, called TAG below: v0.1.9 unless git tag shows it taken, in which case the next one. Push master. Create an annotated tag whose message is a user-facing note in the style of v0.1.8's: "Password login refuses an account that is not activated while golem15.user.activation.require_activation is on (the default), with the same invalid-login answer as a wrong password; a deactivated account is still restored by its owner's login." Push the tag.
2. sm-demo-app, in ../sm-demo-app: the plugin checkout already sits at the tagged commit; confirm with git -C plugins/golem15/user describe --exact-match. Run GOPRIVATE='git.golem15.com/*' GOWORK=off go get git.golem15.com/golem15/sm-user-plugin@TAG. Check that git diff go.mod go.sum touches only sm-user-plugin lines, then run go build ./... and go vet ./... (workspace). Commit, staging only plugins/golem15/user, go.mod and go.sum, with the message chore: bump user to TAG and no trailer. Leave the other session's main.go edit alone. Push sm-demo-app only for release-push-demo.
3. Planning docs, in summercms.go:
- In .planning/notes/2026-10-22-external-user-plugin-escalations.md, set tracker row 1's Status to done and Shipped to the tag. Replace the G2 TODO line of the reply with one line: "Shipped in sm-user-plugin TAG: with require_activation on (the default), /login answers an account that is not activated with the same opaque invalid-login response as a bad password (counted as a failed attempt); deactivation stays self-service."
- git mv the todo from todos/pending/ to todos/done/ and append a "## Closed 2026-10-22" note: plugin commit sha, tag, sm-demo-app bump sha, pushed or not.
- Commit both with docs(quick-261022-tb4): close G2, sm-user-plugin TAG, staging these paths explicitly. If the quick workflow commits this quick directory and STATE.md itself, leave those to it.
- g15office: if a g15office tool is available, comment on task 3r4or1ex (shipped in TAG) and move it to Live. Otherwise record it as pending in the SUMMARY.
hold: change no planning doc. The todo stays pending, and the G2 row and reply paragraph stay as they are. Record the fix commit sha and "unreleased" in the SUMMARY. If a g15office tool is available, comment on 3r4or1ex that the fix is committed locally and awaits release.
</action>
<verify>
<automated>P=/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user; if T=$(git -C "$P" describe --exact-match 2>/dev/null); then R=$(git -C "$P" ls-remote --tags origin) && grep -q "refs/tags/$T" <<<"$R" && L=$(git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app log -5 --format=%s) && grep -q "^chore: bump user to $T" <<<"$L" && test -f /media/nvme/dev/golem15/summercms.io/summercms/summercms.go/.planning/todos/done/2026-10-22-user-login-ignores-is-activated.md; else O=$(git -C "$P" log --oneline origin/master..master) && grep -q "not-activated account while require_activation" <<<"$O"; fi</automated>
</verify>
<done>release: the plugin tag is on origin, sm-demo-app holds one bump commit (pushed only for release-push-demo), the G2 row and reply name the tag, the todo is in todos/done/ with a Closed note, and planning docs are committed separately from code. hold: nothing pushed or tagged, and the SUMMARY records the local fix commit as unreleased.</done>
<resume-signal>Select: release, release-push-demo, or hold (optionally: whether the plugin tag gets a changelog post).</resume-signal>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| anonymous client -> POST /_user/api/v1/login | untrusted email and password; the answer and its side effects must not reveal account state |
| administrator -> Users screen | creates accounts that start not activated and may carry a password the administrator chose |
| session JWT holder -> jwt.auth routes, /refresh | sessions minted before this fix for accounts that are not activated |
| executor -> git remotes | tag and push of a core plugin used by every app |
## STRIDE Threat Register (ASVS L1, block on high)
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-tb4-01 | E | controllers.Login issues a token to a not-activated account (G2; admin-created accounts with a password) | high | mitigate | Task 1: activation gate under require_activation (default true) after the password check; TestLoginRequiresActivation default_refuses, explicit_true_refuses; Task 2 flips TestAdminUserPassword to assert the refusal |
| T-tb4-02 | I | account-state enumeration through the /login answer (activated or not) | medium | mitigate | QD-5: both refusals go through refuseLogin and writeInvalidLogin; same_as_wrong_password compares status, body bytes and headers |
| T-tb4-03 | I | timing difference between a wrong password and a not-activated account | low | mitigate | QD-1: the gate runs only after bcrypt CheckPassword, and both refusals do the same throttle write |
| T-tb4-04 | I | password oracle for not-activated accounts through throttle state (an attempt reset on a correct password) | medium | mitigate | QD-2: the refusal records a failed attempt like a wrong password; refusals_suspend pins it |
| T-tb4-05 | E | restore-on-login reviving an account that is deactivated and not activated | medium | mitigate | QD-3: the gate sits before the deleted_at restore; deactivated_inactive_refused checks deleted_at and the absent mail |
| T-tb4-06 | D | a not-activated owner retrying until suspended | low | accept | Such an account cannot sign in before activation anyway; the suspension lifts after suspension_minutes or an admin unsuspend (QD-2) |
| T-tb4-07 | E | sessions minted earlier for not-activated accounts keep working (jwt guard and /refresh do not check activation) | medium | accept | Out of the G2 scope (QD-6); the sessions expire within the refresh window, and an administrator's deactivate or ban revokes them (RevokeUserAccess); recorded as a follow-up candidate in the SUMMARY |
| T-tb4-08 | I | an unknown email skips bcrypt, so it answers faster than a known one (pre-existing) | low | accept | Unchanged by this plan (QD-6); recorded as a follow-up candidate in the SUMMARY |
| T-tb4-09 | T | unreviewed publish of a core plugin (tag, push, pointer bump) | medium | mitigate | Task 3 is checkpoint:decision with gate blocking-human; no tag or push before the user's answer |
| T-tb4-SC | T | npm/pip/cargo/go installs | low | accept | No new dependency; only existing packages of the plugin are used |
</threat_model>
<verification>
- sm-user-plugin (../sm-demo-app/plugins/golem15/user): GOWORK=off go vet ./... and GOWORK=off go test -count=1 ./... green with Docker at the fix commit; TestLoginRequiresActivation covers the nine cases in Task 1's behavior block.
- The README names only identifiers that exist in the plugin; the require_activation row, the activation and deactivation bullets and the Testing entry are updated in the fix commit.
- Only the Task 2 paths are in the plugin commit; summercms.go gets only .planning edits; no file under admin/ or modules/boardwalk is touched.
- No push, tag, changelog post, pointer bump or planning-doc closure before the Task 3 answer.
</verification>
<success_criteria>
- tb4-1: with require_activation on (the default), POST /login refuses a not-activated account with the byte-identical opaque invalid-login 401 a wrong password gets and counts it as a failed attempt; with it off, such an account signs in as before.
- Deactivation restore-on-login is unchanged for activated accounts (and for every account when require_activation is off); an account that is also not activated is refused before any restore while the gate is on.
- The existing suite passes on the new default without switching the harness to require_activation false.
- After a release decision: the plugin tag exists on origin, sm-demo-app has its bump commit, the escalation note's G2 row and reply paragraph name the tag, and the todo is closed. After a hold decision: everything stays local and is recorded as unreleased.
</success_criteria>
<output>
Create `.planning/quick/261022-tb4-password-login-must-refuse-is-activated-/261022-tb4-SUMMARY.md` when done. It records the plugin base commit and fix sha; every test touched, with its class; the Task 3 decision and the resulting tag and commit shas; the follow-up candidates from QD-6 (activation on /refresh and the jwt guard; bcrypt on the unknown-email path); the other apps' pointer bumps; and the g15office status.
</output>

View File

@@ -0,0 +1,119 @@
---
phase: quick-261022-tb4
plan: 01
quick_id: 261022-tb4
subsystem: sm-user-plugin (golem15.user) login
tags: [auth, login, activation, throttle, escalation-G2, core-plugin]
status: complete
requires:
- sm-user-plugin v0.1.8 (930b158)
provides:
- POST /_user/api/v1/login activation gate under golem15.user.activation.require_activation (default true)
- controllers.refuseLogin, the single /login refusal path (failed attempt + invalid-login 401)
- test helpers insertInactiveUser, inactiveSessionToken; insertUser now creates an activated account
affects:
- every app that bumps sm-user-plugin past v0.1.8 (behaviour change for not-activated accounts with a password)
tech-stack:
added: []
patterns:
- "one refusal helper shared by both refusal branches so answers are identical by construction"
key-files:
created: []
modified:
- sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- sm-demo-app/plugins/golem15/user/session_test.go
- sm-demo-app/plugins/golem15/user/account_test.go
- sm-demo-app/plugins/golem15/user/email_verified_test.go
- sm-demo-app/plugins/golem15/user/admin_users_test.go
- sm-demo-app/plugins/golem15/user/README.md
key-decisions:
- "QD-1..QD-7 applied as planned: gate after bcrypt and before the deleted_at restore; the refusal counts as a failed attempt; flag read through registrationSettings; scope is POST /login only"
duration: 4min
completed: 2026-10-22
estimate:
tokens: 110000
tasks: 3
actuals:
tokens: 7500 # chars/4 over the realized plugin diff (30150 bytes)
tasks: 2 # Tasks 1-2 done; Task 3 is the pending release checkpoint
commits: 1 # measured in the sm-user-plugin repo: git rev-list --count 930b158..HEAD
plan_head_before: 930b1587a0390310f049695efd35075cc41d0b0e # sm-user-plugin repo (code lives there, not in summercms.go)
plan_head_after: 15ff9793bac2da6a0d4236c7efa3cb4c6f5f5044 # sm-user-plugin repo
---
# Quick 261022-tb4: Password login must refuse is_activated=false Summary
**POST /login now refuses a not-activated account under require_activation (default true) with the byte-identical, throttle-counted invalid-login 401 of a wrong password, checked after bcrypt and before the deactivation restore; one unpushed, untagged fix commit `15ff979` on sm-user-plugin master. Release (Task 3) awaits the user's decision.**
## Base and commits
- sm-user-plugin checkout: `/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user`, switched from detached v0.1.8 to `master` (fast-forward check: already up to date).
- Base: `930b158` (= tag v0.1.8 = origin/master). No other escalation quick had landed; `git log --oneline v0.1.8..master` before this plan was empty.
- Fix commit: `15ff979 fix: login refuses a not-activated account while require_activation is on` (code, tests and README together, no trailer).
- `git log --oneline origin/master..master` = `15ff979` only. Nothing pushed or tagged. The sm-demo-app working tree shows `plugins/golem15/user` modified (pointer), left uncommitted; the other session's `main.go` edit untouched.
## Tasks
| Task | Name | Commit | Notes |
|------|------|--------|-------|
| 1 | (tracer, TDD) /login refuses a not-activated account under require_activation | `15ff979` (combined with Task 2, per plan) | RED: default_refuses, same_as_wrong_password, explicit_true_refuses, refusals_suspend, deactivated_inactive_refused failed (200) against v0.1.8; GREEN after the gate. Tracer gate re-ran verify: pass. |
| 2 | Existing suite on the new default, README, one plugin commit | `15ff979` | go vet and full Docker-backed `go test -count=1 ./...` green. |
| 3 | checkpoint:decision (blocking-human): release / release-push-demo / hold | — | **Pending the user's decision.** Not executed. |
## What changed
- `controllers/api_controller.go`: `Login` reads `requireActivation` via `registrationSettings(app)`; after the password check and before the `user.DeletedAt.Valid` restore, `requireActivation && !user.IsActivated` calls `refuseLogin` and returns. The wrong-password/unknown-email branch now also calls `refuseLogin` (behaviour unchanged: a nil user records nothing). New `refuseLogin` records `CheckAndRecordLogin(ok=false)` (non-rejection error -> opaque 500) and answers `writeInvalidLogin`. Login doc comment states the check order (throttle, password, activation, restore, success bookkeeping, token).
- `README.md`: Registration and activation bullet (refusal, how such accounts get activated, `/activate` serves sessions of not-activated accounts when the key is off, check order); Deactivation and bans bullet ("Activation gates login, deactivation does not"); `require_activation` config row; Testing paragraph on `TestLoginRequiresActivation`.
## Tests touched (with class)
| Test | Change | Class |
|------|--------|-------|
| `session_test.go` `TestLoginRequiresActivation` | new, nine subtests per the behavior block | new |
| `session_test.go` `insertUser` | now creates an activated account (via new `createUser`); doc comment | fixture (QD-7) |
| `session_test.go` `insertInactiveUser`, `inactiveSessionToken`, `createUser` | new helpers | fixture (QD-7) |
| `session_test.go` `loginToken` | doc comment only | — |
| `session_test.go` `TestLogin` (ada-login, throttled, soft) | `IsActivated: true` | (1) ordinary account fixture |
| `session_test.go` `TestLoginSixthAttempt` (sixth) | `IsActivated: true` | (1) ordinary account fixture |
| `account_test.go` `TestActivate` (activate-auth) | `inactiveSessionToken` | (3) needs a not-activated session |
| `account_test.go` `TestActivateByCode` | `insertInactiveUser` | (3) subject is a not-activated account |
| `email_verified_test.go` `activate_by_code_stamps` | `insertInactiveUser` | (3) |
| `email_verified_test.go` `activate_stamps`, `activate_wrong_code_no_proof` | `inactiveSessionToken` | (3) |
| `admin_users_test.go` `TestAdminUserPassword` | created (not activated) user's password login now asserted 401 `invalidLoginBody`; admin bulk `activate` then login 200; final check "the reset kept the activation and the email" | (2) subject is a not-activated account signing in (the G2 case) |
The full run showed no further failures, so no other test file needed classification. The harness (`sessionConfig`, `newSessionApp`, `sessionApp`, `newAdminEnv`) keeps `require_activation` at its default.
## Deviations from Plan
- `insertUser` and `insertInactiveUser` share a small private helper `createUser(t, gdb, email, password, activated)` instead of duplicating the body. Same shapes and behaviour as planned.
- Commit message: the system-supplied attribution trailer was omitted per the user's global rule (no co-author/attribution trailers), as the plan and the orchestrator required.
Otherwise the plan ran as written.
## Task 3 (pending)
Release checkpoint not executed: no tag, push, sm-demo-app pointer bump, escalation-note G2 fill, todo move or g15office update. Fix `15ff979` is **unreleased** until the user chooses release / release-push-demo / hold. Next free patch tag would be v0.1.9 (latest v0.1.8).
## Follow-up candidates (QD-6, not implemented)
- Activation is not checked by `/refresh`, the `jwt` guard or the API-token guard: a session minted before this fix for a not-activated account keeps working until it expires or an administrator deactivates or bans the user (T-tb4-07, accepted).
- The unknown-email path of `/login` skips bcrypt, so it answers faster than a known email (pre-existing timing difference, T-tb4-08, accepted).
## Other apps' pointer bumps (follow-ups, separate decisions)
fonoteka.go (pinned at v0.1.6), sm-bm-app, sm-grzybyfunkcjonalne-app, sm-summercmsio-app (v0.1.8). Before bumping any, count affected accounts in that app's database: `SELECT count(*) FROM users WHERE is_activated = false AND deleted_at IS NULL AND password IS NOT NULL AND password != '';`
## g15office
Not touched (no tool used; Task 3 not reached). Pending: comment on task 3r4or1ex after the release decision.
## Known Stubs
None.
## Self-Check: PASSED
- FOUND: controllers/api_controller.go contains `requireActivation && !user.IsActivated` and `refuseLogin(`
- FOUND: session_test.go contains `func TestLoginRequiresActivation`
- FOUND: README.md contains `TestLoginRequiresActivation`
- FOUND: commit 15ff979 on sm-user-plugin master; plugin working tree clean

View File

@@ -0,0 +1,114 @@
---
phase: quick-261022-tb4
verified: 2026-10-22T21:35:00Z
status: passed
score: 7/7 must-haves verified
covered_files:
- .planning/quick/261022-tb4-password-login-must-refuse-is-activated-/261022-tb4-PLAN.md
- .planning/quick/261022-tb4-password-login-must-refuse-is-activated-/261022-tb4-SUMMARY.md
covered_digest: "v2:sha256:b084c33c4390bda9e81e881d28e50759708e20c33bd9eefd847aef2e2fd604bf"
# The implementation lives outside this repo root (sm-user-plugin, checked out at
# ../sm-demo-app/plugins/golem15/user), so the fingerprint tool refuses those paths.
# They are pinned by commit instead: sm-user-plugin 15ff9793bac2da6a0d4236c7efa3cb4c6f5f5044
# (controllers/api_controller.go, session_test.go, account_test.go,
# email_verified_test.go, admin_users_test.go, README.md).
covered_external_commit: "sm-user-plugin@15ff9793bac2da6a0d4236c7efa3cb4c6f5f5044"
behavior_unverified: 0
overrides_applied: 0
---
# Quick 261022-tb4: Password login must refuse is_activated=false (verification)
**Goal:** Password `/login` must refuse `is_activated=false` when `golem15.user.activation.require_activation` is true (the default), with the same opaque invalid-login body as a bad password. The `deleted_at` restore-on-login must not change.
**Verified:** 2026-10-22T21:35:00Z
**Status:** passed
**Re-verification:** No, this is the first verification.
**Code under test:** sm-user-plugin `15ff979` on local master (`/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user`). The working tree is clean, HEAD = 15ff979, `origin/master..master` = 15ff979 only, and no tag points at it.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | With require_activation unset or true, a not-activated account's correct password gets 401 with the same status, body bytes, Content-Type and Cache-Control as a wrong password. The response carries no token and stamps no last_seen. | VERIFIED | `api_controller.go:95`: `if _, _, _, requireActivation := registrationSettings(app); requireActivation && !user.IsActivated { refuseLogin(...); return }`. Both refusal branches call `refuseLogin` (`:89`, `:96`), which ends in `writeInvalidLogin` (same 401, same `invalid_login` translation key). Subtests `default_refuses`, `same_as_wrong_password` and `explicit_true_refuses` pass. The return comes before `TouchLastSeen` and `mintFor`. |
| 2 | The refusal counts against the throttle like a wrong password, and attempt_limit such refusals suspend the account. | VERIFIED | `refuseLogin` calls `classes.CheckAndRecordLogin(ctx, gdb, user, ip, false)`. `default_refuses` asserts attempts=1, `same_as_wrong_password` asserts 1 then 2, and `refusals_suspend` asserts attempts=5 with `IsSuspended` after 5 refusals. All pass. |
| 3 | With require_activation false, a not-activated account signs in with 200, a token and the user payload. | VERIFIED | The gate is conditional on `requireActivation`. `off_allows` passes and checks that the token's `sub` matches the user. |
| 4 | Activated accounts sign in unchanged, and a deactivated activated account is restored with the reactivate mail and a working token. | VERIFIED | The restore block (`:99-105`) is untouched in the diff. `activated_allows` and `deactivated_activated_restores` pass: deleted_at is cleared and the mail is `golem15.user::mail.reactivate-en`. The existing `TestLogin` soft-delete assertions also stay green. |
| 5 | A deactivated, not-activated account is refused before the restore under true (deleted_at stays set, no mail). Under false it is restored and signed in. | VERIFIED | The gate sits before `if user.DeletedAt.Valid`. `deactivated_inactive_refused` and `deactivated_inactive_off_restores` pass. |
| 6 | The check order is throttle, bcrypt, activation, restore, success bookkeeping, token. The Login doc comment and the README state this order, and the README says activation gates login and deactivation does not. | VERIFIED | The code order is confirmed in `Login` (`:76-129`). The doc comment (`:47-57`) states the full order. The README "Registration and activation" bullet states the order, and the "Deactivation and bans" bullet says "Activation gates login, deactivation does not". The `require_activation` config row is updated, and a Testing paragraph names `TestLoginRequiresActivation`. |
| 7 | Plugin go vet and the full Docker-backed go test are green at the single fix commit. Nothing is pushed, tagged or pointer-bumped before the Task 3 decision. | VERIFIED | `GOWORK=off go vet ./...` passes. `GOWORK=off go test -count=1 ./...` (run once, with Docker 29.9.1) passes all packages: root 43.4s, classes, models, updates. `git tag --points-at 15ff979` is empty and `git describe` gives `v0.1.8-1-g15ff979`. Task 3 is on HOLD by the user's decision, which was expected. |
**Score:** 7/7 truths verified (0 present but behavior-unverified)
All truths that depend on runtime behavior (state transitions on throttle, deleted_at, last_seen and mail) are covered by `TestLoginRequiresActivation` subtests, which I ran and saw pass.
### Fail-first evidence (the test is not vacuous)
I extracted the pre-fix tree (`git archive 930b158`, which is v0.1.8) into the scratchpad, swapped in `session_test.go` from 15ff979, and pointed the summercms replace at an absolute path. I then ran `TestLoginRequiresActivation`. The five refusal cases failed with HTTP 200 and a token: `default_refuses`, `same_as_wrong_password`, `explicit_true_refuses`, `refusals_suspend` and `deactivated_inactive_refused`. The four allow and restore cases passed. This is exactly the RED split the SUMMARY claims. The scratch copy was deleted afterwards, and nothing in the repo was modified.
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `controllers/api_controller.go` | Activation gate plus `refuseLogin` shared by both refusal branches | VERIFIED | Contains `requireActivation && !user.IsActivated`. `refuseLogin` is defined at `:1193` and used at `:89` and `:96`. |
| `session_test.go` | `TestLoginRequiresActivation`, an activated `insertUser`, and the `insertInactiveUser` / `inactiveSessionToken` helpers | VERIFIED | All present. `insertUser` and `insertInactiveUser` both go through the private `createUser` helper (a deviation the SUMMARY records; harmless). |
| `README.md` | Activation gates login, require_activation row, Testing entry | VERIFIED | All three are present. The identifiers it names (`Login`, `RejectIfThrottled`, `TestLoginRequiresActivation`) exist. |
### Key Link Verification
| From | To | Via | Status | Details |
|------|----|-----|--------|---------|
| Login | registrationSettings (`:822`) | same parser as /register, default true | WIRED | `registrationSettings(app)` is called in the gate. It defaults `require=true`, reads `golem15.user.activation.require_activation` only when the key is present, and `config/config.yaml:9` also sets `true`. |
| Login refusal branches | `classes.CheckAndRecordLogin` (ok=false) | refuseLogin | WIRED | Both branches go through `refuseLogin`. A nil user (unknown email) still records nothing. |
| Activation gate | deleted_at restore | gate placed before the restore | WIRED | The gate is at `:95` and `if user.DeletedAt.Valid` is at `:99`. |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| All 9 gate cases | `GOWORK=off go test -count=1 -v -run '^TestLoginRequiresActivation$' .` | 9/9 subtests PASS | PASS |
| Related suites | `GOWORK=off go test -count=1 -run 'TestLogin\|TestAdminUserPassword\|TestActivate\|TestEmailVerifiedAt' ./...` | ok | PASS |
| Full suite (once) | `GOWORK=off go test -count=1 ./...` | all packages ok | PASS |
| Static | `GOWORK=off go vet ./...` | clean | PASS |
| Fail-first | new test against the v0.1.8 code (scratch copy) | the 5 refusal cases FAIL with 200 | PASS (the test discriminates) |
### Probe Execution
Not applicable. The plan declares no probe scripts.
### Requirements Coverage
| Requirement | Source Plan | Description | Status | Evidence |
|-------------|-------------|-------------|--------|----------|
| tb4-1 | 261022-tb4-PLAN | /login refuses is_activated=false under require_activation (default true) with the opaque invalid-login answer; deleted_at restore-on-login unchanged | SATISFIED | Truths 1-5 |
### Test fixture changes (checked for scope creep)
- `TestAdminUserPassword`: previously asserted that the G2 bug happens (a not-activated, admin-created user logs in with 200). It now asserts the 401 `invalidLoginBody`, then an admin bulk `activate`, then a 200 login. The final check is inverted to `!after.IsActivated` → fail, which is correct because the test now activates the user mid-way. The intent is kept: a request still cannot turn activation on by itself, because the 401 shows that.
- `TestActivate`, `TestActivateByCode` and the three `TestEmailVerifiedAt` activation subtests now use not-activated fixtures or sessions (`insertInactiveUser`, `inactiveSessionToken` via `controllers.IssueToken`). The subject of each test is unchanged.
- `TestLogin` and `TestLoginSixthAttempt` fixtures gain `IsActivated: true`. Their subjects (success, throttle, restore) are unchanged.
- The shared harness configuration does not set `require_activation`, so the suite tests the default.
### Anti-Patterns Found
None. I scanned the added lines of 15ff979 for TBD, FIXME, XXX, TODO, HACK and placeholder markers and found no matches.
### Info (not gaps)
- sm-demo-app's `go.work` replaces `sm-user-plugin` with the local checkout, so the sm-demo-app workspace already builds against 15ff979 even though the pointer is not committed. I checked its login references: `turnstile_test.go` expects a 422 from Turnstile before Login runs, and the sociallogin, quizzes and demo harnesses mint tokens with `IssueToken` or `bouncer.Mint` rather than password login. The only other `CheckPassword` callers are the demo seed and `/change-password` (authenticated). I did not run the workspace tests; they are outside this quick's must-haves.
- The QD-6 follow-up candidates are recorded in the SUMMARY: `/refresh` and the jwt and API-token guards do not check activation, and the unknown-email path skips bcrypt. Both are accepted risks (T-tb4-07, T-tb4-08) outside the G2 scope.
- Task 3 (tag v0.1.9, push, sm-demo-app pointer bump, closing the escalation note and the todo) is on HOLD by the user's decision. That is expected and is not a gap.
### Human Verification Required
None.
### Gaps Summary
None. The code achieves the goal. Under the default `require_activation`, `/login` refuses a not-activated account with the byte-identical invalid-login 401 of a wrong password, after bcrypt, counted by the throttle, and before the deleted_at restore. Restore-on-login is unchanged for activated accounts and for every account when the key is off. Tests that fail on the pre-fix code and pass on 15ff979 pin this behavior.
---
_Verified: 2026-10-22T21:35:00Z_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,247 @@
---
phase: quick-261022-tto
plan: 01
quick_id: 261022-tto
slug: fetch-refresh-update-change-password-mus
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- tto-1 # G3: GET /fetch, POST /refresh, POST /update, POST /change-password accept the token/auth_token session cookies exactly as jwt.auth and EndSession do; bearer keeps precedence; no credentials stays 401; Logout unchanged
files_modified:
# sm-user-plugin (module golem15.user), worked in the sm-demo-app submodule checkout
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
- ../sm-demo-app/plugins/golem15/user/logout_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
# summercms.go planning docs (separate docs commit)
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md
- .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
estimate:
tokens: 120000
raw_tokens: 120000
tasks: 3
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "A request that carries the session JWT only in the token cookie, or only in the auth_token cookie, and that the jwt.auth guard accepts (GET /_user/api/v1/tokens answers 200) gets 200 from GET /fetch (that user's payload), POST /refresh (a new token in the body), POST /update (the profile is saved) and POST /change-password (the password is replaced)."
- "A request with neither an Authorization bearer nor a session cookie still gets 401 with today's bodies: {\"error\":true,\"message\":\"Unauthorized\"} from /fetch, /update and /change-password, {\"error\":\"Token not found\"} from /refresh."
- "The bearer header keeps precedence exactly as in the jwt guard: with a valid bearer and a cookie of another user the bearer's user is served; with a non-empty invalid bearer and a valid cookie the answer is 401 on these routes as on jwt.auth."
- "A cookie-carried token is refused on these routes for the same reasons as a bearer one: blacklisted by logout, issued before tokens_valid_after, user missing or deactivated; /refresh keeps its c3712dc refusals (deactivated, banned, cut off) with the same 401 bodies."
- "POST /refresh answers a cookie-carried request with the rotated token in the body only and sets no cookie (PHP parity); the old token is blacklisted, so the caller that wrote the cookie stores the new token. Bearer-only clients see no change on any route, and POST /logout and classes.EndSession are untouched."
- "One extractor: the controllers read the session token only through classes.SessionToken and build the session guard with classes.SessionCookieNames(); the controllers' private bearer-header helper is gone."
- "The plugin's go vet, go test -short and the full Docker-backed go test are green at one fix commit on sm-user-plugin master; nothing is pushed, tagged or pointer-bumped (SummerCMS v0.5.0 release hold); the escalation note's G3 row reads done (unreleased) with that commit -> v0.5.0 and its reply line follows the G2 'Ships in SummerCMS v0.5.0' form."
artifacts:
- path: ../sm-demo-app/plugins/golem15/user/classes/session_user.go
provides: "SessionToken(r) (exported form of the existing extractor, RequestUser updated) and SessionCookieNames() (copy of the token, auth_token list)"
contains: "func SessionCookieNames"
- path: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
provides: "sessionGuard helper with the cookie names; authenticate, Refresh and ChangePassword read the token like the jwt guard"
contains: "SessionCookieNames()..."
- path: ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
provides: "TestSessionRoutesAcceptCookies: cookie-only success on the four routes under both cookie names, parity with jwt.auth, no-credentials 401, bearer precedence, refusals through the cookie"
contains: "func TestSessionRoutesAcceptCookies"
- path: ../sm-demo-app/plugins/golem15/user/README.md
provides: "JWT-sessions bullet and API reference name the cookie carriers; classes list names SessionToken and SessionCookieNames; Testing entry"
contains: "TestSessionRoutesAcceptCookies"
key_links:
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (sessionGuard, used by authenticate and ChangePassword)
to: ../sm-demo-app/plugins/golem15/user/classes/session_user.go (sessionCookieNames)
via: "bouncer.NewJWTGuard(secret, classes.GormUsers{App: app}, bl, classes.SessionCookieNames()...), the same cookie list and order plugin.go:99 registers for jwt.auth"
pattern: "SessionCookieNames\\(\\)\\.\\.\\."
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (Refresh, ChangePassword)
to: ../sm-demo-app/plugins/golem15/user/classes/session_user.go (SessionToken -> sessionTokens)
via: "raw token read through the extractor EndSession and RequestUser already use (bearer, then token, then auth_token)"
pattern: "classes\\.SessionToken\\(r\\)"
- from: ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
to: GET /_user/api/v1/tokens (jwt.auth)
via: "each cookie subtest first asserts e.guarded(t, token, name) == 200, so 'a caller jwt.auth accepts' is checked, not assumed"
pattern: "e\\.guarded\\(t, "
---
<objective>
Close escalation G3 for the remaining four routes. GET /fetch, POST /refresh, POST /update and POST /change-password of the user plugin answer 401 to a caller whose session JWT travels only in the token or auth_token cookie, although the jwt.auth guard (plugin.go:99) and POST /logout (classes.EndSession, 358ee5d) accept those cookies. After this plan the four read the token exactly as the jwt guard does: the Authorization bearer header first, then the token cookie, then the auth_token cookie.
Purpose: a browser frontend whose session lives in a cookie (golem15.sociallogin's token_cookie, or an app's own bridge) can fetch, refresh, update and change the password without turning the cookie into a header.
Output: one fix commit on sm-user-plugin master (code, tests, README together), then one docs commit in summercms.go that fills G3 in the escalation note, records the outcome on the todo (which stays pending until the v0.5.0 release, as G2's does) and leaves a cross-reference on the login-cookie todo. No push, tag or pointer bump.
Decisions (planner's, within the brief; the executor does not revisit them):
- QD-1 One extractor. classes owns the cookie list and the extraction. Rename the unexported sessionToken in classes/session_user.go to the exported SessionToken (update its only caller, RequestUser) and add SessionCookieNames(), which returns a copy of sessionCookieNames. sessionTokens stays unexported (EndSession uses it). The controllers read the raw token only through classes.SessionToken and build the guard with classes.SessionCookieNames(). The controllers' private bearer-header helper (api_controller.go:1138) has exactly three callers, all changed here, so it is deleted. plugin.go:99 keeps its literal "token", "auth_token": escalation G4 (logout blacklist under serve) rewires those Boot lines next and the six quicks must not overlap on plugin.go; the parity subtests pin that the controllers and jwt.auth accept the same carriers. Record "plugin.go:99 could use classes.SessionCookieNames()" as a follow-up for the G4 session in the SUMMARY.
- QD-2 authenticate (api_controller.go:880). One call to a new helper sessionGuard(app, secret) bouncer.Guard (it looks up the published bouncer.BlacklistStore as today and returns bouncer.NewJWTGuard with the cookie names). authenticate takes the user id from the returned *bouncer.Principal and loads the user with the existing scoped Take. The separate bouncer.VerifyClaims of a bearer-only token is removed, so authenticate no longer fails closed on a missing header before the cookies are tried and can never read a different token than the guard verified. Every refusal still answers writeUnauthorized.
- QD-3 Refresh (api_controller.go:192). raw := classes.SessionToken(r); empty keeps the existing 401 {"error":"Token not found"}. Everything after it is unchanged (bouncer.Refresh, refreshSubjectRefused, TouchLastSeen), so the c3712dc refusals hold for cookie-carried tokens. The answer stays {"token": next} in the body and sets no cookie: the PHP reference (examples/golem15-wintercms-starter plugins/golem15/user/controllers/ApiController.php:115-130) answers the body only, and the cookie belongs to whoever wrote it (today the app's bridge or sociallogin's token_cookie). bouncer.Refresh blacklists the old jti after golem15.user.jwt.blacklist_grace (default 0), so the README says the caller stores the new token. Whether a server-written password-login cookie is rotated by /refresh (as bouncer.CookieRefreshHandler does) is left to the opt-in /login cookie todo, which gets a cross-reference in Task 3.
- QD-4 ChangePassword (api_controller.go:588). raw := classes.SessionToken(r); bouncer.VerifyClaims(raw, secret) gives sub and iat as today; then sessionGuard(app, secret).Authenticate(r) (blacklist, cutoff, missing user). If the principal's ID formatted as a decimal string differs from sub, answer writeUnauthorized (both read the same token by construction; the check makes a future divergence fail closed). Load the user by that id as today. The cutoff stays iat minus one second, so the calling token, bearer or cookie, stays valid. Response unchanged, no cookie written.
- QD-5 Scope. The contract is the four named routes. The shared authenticate also serves POST /activate, /marketing-consent, /avatar and /avatar/remove, which gain the same cookie carriers. That is intended: every signed-in route of the plugin then reads the token as jwt.auth does. The README names all of them; one /marketing-consent subtest pins the claim.
- QD-6 Unchanged: controllers.Logout, classes.EndSession, classes.RequestUser behaviour, sessionTokens' order and trimming, the 401 bodies, bearer-only behaviour on every route. bouncer's extractToken and classes.sessionTokens were compared at planning time: both take the header only with the exact "Bearer " prefix and a non-empty trimmed value, then each cookie in order with a trimmed non-empty value, so a non-empty invalid bearer wins over a valid cookie in both.
- QD-7 CSRF. No new mechanism. The four routes get the exposure POST /tokens (jwt.auth) and POST /logout already have: a cookie-carried session relies on the cookie's SameSite attribute (bouncer.LoadCookieConfig default lax, which a browser does not send on a cross-site POST). The README states this. /change-password still requires current_password.
- QD-8 Versioning and the release hold. A plugin release is a git tag (latest v0.1.8 = 930b158, which carries 358ee5d); there is no version file or updates entry. Since commit 3ebd783 (21:37 on 2026-10-22, observed at planning time) the escalation note holds every user-plugin fix for the SummerCMS v0.5.0 wave: plugin commits stay local, and no mid-wave plugin tag is written. G2 (15ff979) set the recording pattern this plan copies: tracker Status "done (unreleased)", Shipped "`sha` → v0.5.0", the Quick/todo cell links the quick directory and the todo, the reply line reads "Ships in SummerCMS v0.5.0 (sm-user-plugin sha, tagged with that wave): …", and the todo stays in todos/pending with an "## Outcome (2026-10-22)" section (76694c7, 3ebd783). The brief said to move the todo to done. The plan follows the newer G2 precedent instead, because G15OFFICE.md ties closing a todo to moving its task to Live, and the fix is not live until v0.5.0. This quick does not tag, push or bump.
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@CLAUDE.md
@.planning/STATE.md
@.planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md
@.planning/notes/2026-10-22-external-user-plugin-escalations.md
@../sm-demo-app/plugins/golem15/user/README.md
Working copies (observed at planning time, 2026-10-22):
- sm-user-plugin: ../sm-demo-app/plugins/golem15/user (absolute /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user). On branch master at 15ff979 (G2 fix), ahead of origin/master by 1, working tree clean, latest tag v0.1.8. Do not fetch, merge, rebase or reset. If master has moved past 15ff979, another escalation quick landed: build on top of it and record the base and git log --oneline 15ff979..master in the SUMMARY. If the tree is dirty, stop: another session is working there.
- Go: sm-demo-app's go.work does not list the plugin under use, so every go command in the plugin runs with GOWORK=off. The plugin's go.mod:176 replaces summercms with ../../../../summercms.go (builds against summercms.go's working tree). GOWORK=off go vet ./... was green at 15ff979.
- Docker: docker info answered (server 29.9.1). The adminEnv harness (adminHarnessDB, admin_harness_test.go:93) skips under -short, so the new tests only run in the full go test. If the Docker socket is denied, run go test through sudo -u golem (CLAUDE.md).
- sm-demo-app (../sm-demo-app): another session has uncommitted edits (main.go and the plugins/golem15/user pointer). Leave that repo alone; no pointer bump.
- summercms.go: STATE.md and state.json carry other sessions' edits, .msd/ and the 261022-tb4 quick directory are untracked. Stage only the paths named in Task 3, never git add -A, never STATE.md or this quick directory. The escalation note was last changed by 3ebd783 (release hold) and 76694c7 (G2 filled); re-read it right before editing in Task 3, because another session may have filled another row since then. Edit only the G3 row and the G3 reply line.
Source facts (file:line in the plugin checkout at 15ff979):
- classes/session_user.go: sessionCookieNames :21 ("token", "auth_token", "same order as plugin.go Boot"); RequestUser :34 calls sessionToken :38; EndSession :101 loops sessionTokens :119; forgetSessionCookies :147; sessionToken :214-219; sessionTokens :224-240 (bearer with exact "Bearer " prefix, then each cookie, trimmed, empty skipped, deduplicated).
- controllers/api_controller.go: Logout :149-171 (unchanged); Fetch :174-187 (authenticate); Refresh :192-242 (bearer-only raw at :198, Token not found :199-202, bouncer.Refresh :207, refreshSubjectRefused :222, TouchLastSeen :235); refreshSubjectRefused :249-292; Activate :530, Update :524-529 (authenticate at :529), ChangePassword :586-670 (bearer-only raw :593, VerifyClaims :594, cookie-less guard :599-606, user Take :612, HasSelfSetPassword false answers 500 :616-620, cutoff iat minus 1s :656); MarketingConsent :693 (authenticate); authenticate :880-909 (bearer-only raw :885, VerifyClaims fails closed :886-890, cookie-less guard :896-903); sessionDeps :911; bearer-header helper :1138-1146 (callers :198, :593, :885 only); UploadAvatar :1256 and RemoveAvatar :1359 (authenticate); writeUnauthorized writes {"error":true,"message":"Unauthorized"}.
- plugin.go:99 registers the jwt guard as bouncer.NewJWTGuard(secret, classes.GormUsers{App: app}, bl, "token", "auth_token"); routes.go: /fetch, /refresh, /update, /change-password are mounted without jwt.auth; /tokens routes use jwt.auth.
- summercms.go modules/bouncer/jwt.go: NewJWTGuard :86 (empty cookieNames = bearer only), Authenticate :106 returns *Principal (ID uint), extractToken :273-290, bearerToken :314-325; bouncer.CookieRefreshHandler (cookie.go:219) is the framework's cookie-rotating refresh, not used by the user plugin.
- Tests (package user, plugin root): logout_test.go consts unauthorizedRaw, blacklistedBody, userTokensPath, userLogoutPath, userRefreshPath :16-23; TestLogoutEndsTheSession :33; sessionLogin :207 (seedUser + userLogin, password "correct-horse"); guarded :219 (GET /tokens with bearer or only the named cookie); assertSessionEnded :229-242 (jwt.auth through every carrier, but /fetch and /refresh with the bearer only); userAudienceToken(t, sub, jti, iat, exp) in logout_test.go. admin_harness_test.go: newAdminEnv :131, call :242, send :256 (method, path, bearer token, raw body, content type, extra headers such as Cookie), seedUser :468 (IsActivated true, password "correct-horse", HasSelfSetPassword left false), seedThrottle :567, userLogin :637. offboarding_test.go: fetchCode :45, refresh :50, assertRefreshRefused and refusedRefreshBody :16 ({"error":"Could not refresh token","msg":"User not found"}); its "banned" and "issued before tokens_valid_after" subtests :163-176 show the refusal setup. session_test.go parseToken :644. Names sessionGuard, cookieSend, SessionToken, SessionCookieNames and TestSessionRoutesAcceptCookies are unused today.
- README.md: JWT-sessions bullet :20, Password reset and change :21, Profile :25, API reference table :86-108, classes list with EndSession and RequestUser :189-190, Testing section :244 (TestLogoutEndsTheSession sentence :259).
- Consumers: no local frontend calls the user /refresh with cookies; every sociallogin config has token_cookie false. Other app checkouts of the plugin (sm-grzybyfunkcjonalne-app, sm-summercmsio-app, fonoteka.go) are pinned separately and not touched.
</context>
<tasks>
<task type="tracer" tdd="true">
<name>Task 1 (tracer): GET /fetch accepts the session cookies through classes.SessionToken and a cookie-aware guard, end to end on Postgres</name>
<files>../sm-demo-app/plugins/golem15/user/classes/session_user.go, ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/session_cookie_test.go</files>
<precondition>Docker is reachable for testcontainers (directly or through sudo -u golem), git -C ../sm-demo-app/plugins/golem15/user status --short is empty and its branch is master.</precondition>
<behavior>
New session_cookie_test.go (package user) with TestSessionRoutesAcceptCookies on one newAdminEnv. Add an adminEnv helper cookieSend(t, method, path, cookie, token string, body any) that marshals body (nil means no body) and calls e.send with no bearer, Content-Type application/json and only the header Cookie: cookie=token. Each subtest seeds its own user (labels prefixed "cookie-"), so subtests do not share sessions.
- fetch via the token cookie and via the auth_token cookie (loop over both names): token := e.sessionLogin; e.guarded(t, token, name) is 200 (jwt.auth accepts it); GET /_user/api/v1/fetch with only that cookie is 200 and the body's user.id equals the sub claim of parseToken(t, token).
- fetch without credentials: no header, no cookie: 401 and the body equals unauthorizedRaw.
- bearer wins: tokens A and B of two users; bearer A plus cookie token=B answers 200 with A's id. A non-empty invalid bearer (the string not-a-token) plus a valid cookie token=B answers 401 on /fetch, and the same request to userTokensPath (jwt.auth) is 401 too.
- cutoff through the cookie: a seeded user with tokens_valid_after set to now (truncated to the second) and a token from userAudienceToken with iat ten seconds earlier: GET /fetch with that token only in the auth_token cookie is 401 (the guard runs on the cookie path).
</behavior>
<action>
RED: write the behavior block's subtests. Run them; the cookie subtests must fail against today's code (authenticate answers 401 to a cookie-only request). Do not commit a red test: the project keeps go test green at every commit, and the single commit comes at the end of Task 2.
GREEN:
- classes/session_user.go, per QD-1: rename sessionToken to SessionToken and update RequestUser. Its doc comment says it returns the session JWT the plugin's "jwt" guard reads from r (the Authorization bearer header, then each cookie of SessionCookieNames in order, trimmed, empty values skipped) or "" when r carries none, and that a controller building its own guard passes SessionCookieNames() so both read the same token. Add SessionCookieNames() []string returning slices.Clone(sessionCookieNames), with a doc comment naming plugin.go Boot's jwt guard as the list's other user. Keep sessionTokens, EndSession and forgetSessionCookies unchanged.
- controllers/api_controller.go, per QD-2: add sessionGuard(app *backpack.App, secret string) bouncer.Guard next to authenticate. It looks up bouncer.BlacklistStore as the two current call sites do and returns bouncer.NewJWTGuard(secret, classes.GormUsers{App: app}, bl, classes.SessionCookieNames()...). Rewrite authenticate: after sessionDeps, call sessionGuard(app, secret).Authenticate(r); an error, a nil principal or ID 0 answers writeUnauthorized; then load models.User by the principal's ID with the existing scoped Take (failure answers writeUnauthorized). Remove authenticate's bouncer.VerifyClaims step. Give authenticate a doc comment: it reads the token as the jwt guard does (bearer, then the token and auth_token cookies), applies the blacklist and tokens_valid_after, and answers 401 otherwise; it serves /fetch, /update, /activate, /marketing-consent, /avatar and /avatar/remove (QD-5).
- Leave Refresh and ChangePassword for Task 2. The bearer-header helper still has two callers after this task; it is deleted in Task 2.
Run TestSessionRoutesAcceptCookies until green, then the existing TestLogoutEndsTheSession, TestOffboarding and TestRequestUser, which must stay green unchanged. No commit in this task.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run '^(TestSessionRoutesAcceptCookies|TestLogoutEndsTheSession|TestOffboarding|TestRequestUser|TestEndRequestSession)$' .</automated>
</verify>
<done>A cookie-only session that jwt.auth accepts gets 200 from GET /fetch under both cookie names; no credentials stays 401 with the same body; the bearer header wins over a cookie as in the guard; a cut-off token is refused through the cookie. classes exports SessionToken and SessionCookieNames; authenticate uses one cookie-aware guard call. Changes are uncommitted on sm-user-plugin master.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: /refresh, /update and /change-password through the cookies, logout regression across carriers, README, one plugin commit</name>
<files>../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/session_cookie_test.go, ../sm-demo-app/plugins/golem15/user/logout_test.go, ../sm-demo-app/plugins/golem15/user/README.md</files>
<precondition>Task 1 is done: TestSessionRoutesAcceptCookies (fetch subtests) passes on the uncommitted sm-user-plugin master.</precondition>
<behavior>
Added to TestSessionRoutesAcceptCookies (cookieSend from Task 1; every route subtest loops over both cookie names unless stated):
- refresh via the cookie: login token; e.guarded is 200; POST userRefreshPath with only the cookie answers 200 with a non-empty token different from the old one; the response sets no cookie (rec.Result().Cookies() is empty, QD-3); the new token answers 200 on /fetch as a bearer; the old token in the same cookie now answers 401 on /fetch (blacklisted, the harness has no blacklist_grace).
- refresh refusals through the cookie (token cookie): a banned user (e.seedThrottle(t, user, "", true, nil)) and a token issued before tokens_valid_after (the offboarding_test.go :163-176 setups, token from userAudienceToken) each get assertRefreshRefused.
- refresh without credentials: 401 and the body is exactly {"error":"Token not found"}.
- update via the cookie: seedUser plus userLogin; POST /_user/api/v1/update with only the cookie and body name "Cookie", surname "Carrier", email the user's current email answers 200; the users row's name is now Cookie.
- change-password via the cookie: seedUser with a mutate that sets HasSelfSetPassword true (otherwise the route answers 500 by design), plus userLogin; POST /_user/api/v1/change-password with only the cookie and current_password correct-horse, password and password_confirmation cookie-next-pass answers 200; the same cookie token still answers 200 on /fetch (the cutoff is iat minus one second); userLogin with cookie-next-pass answers 200.
- marketing-consent via the token cookie (QD-5 smoke): POST /_user/api/v1/marketing-consent with marketing_consent true answers 200.
- update and change-password without credentials: 401 and the body equals unauthorizedRaw.
logout_test.go assertSessionEnded: /fetch and /refresh are now checked through every carrier ("", "token", "auth_token"), like the jwt.auth check above them: /fetch 401, /refresh 401 with blacklistedBody. Add the cookie forms with e.send and a Cookie header; keep the existing bearer checks.
</behavior>
<action>
RED: add the behavior block's subtests and the assertSessionEnded extension. Run them; the refresh and change-password cookie subtests must fail against the Task 1 state (update and marketing-consent already pass through authenticate, which is expected).
GREEN, in controllers/api_controller.go:
- Refresh, per QD-3: read raw with classes.SessionToken(r); keep the empty-token 401 body and everything after it unchanged; set no cookie. Rewrite its doc comment: it slides a still-refreshable session token read as the jwt guard reads it (bearer, then the token and auth_token cookies), answers the rotated token in the body only and writes no cookie; the old token is blacklisted after golem15.user.jwt.blacklist_grace, so a caller that keeps the session in a cookie stores the new token; deactivated and banned users and tokens issued before tokens_valid_after are refused with the token-failure 401 body.
- ChangePassword, per QD-4: read raw with classes.SessionToken(r); keep the bouncer.VerifyClaims step for sub and iat; replace the blacklist lookup and the guard construction with sessionGuard(app, secret).Authenticate(r), keeping the principal; answer writeUnauthorized when the principal's ID, formatted with strconv.FormatUint, differs from sub; the rest is unchanged. Extend its doc comment: the token is read as the jwt guard reads it, and the token that made the call (header or cookie) stays valid.
- Delete the controllers package's private bearer-header helper (old :1138-1146); it has no callers left. No guard built without the cookie names may remain in the controllers package. Remove imports that become unused.
- Do not touch Logout, classes.EndSession, plugin.go or routes.go (QD-1, QD-6).
README.md, in the same commit as the code:
- JWT-sessions bullet (:20): add that GET /fetch, POST /refresh, POST /update and POST /change-password, like the other signed-in routes, read the session token as the jwt guard does (the bearer header first, then the token and auth_token cookies), so a cookie-only session works on them and a bearer header wins when both are sent; that a cookie-carried POST /refresh answers the rotated token in the body and writes no cookie, while the old token is blacklisted after golem15.user.jwt.blacklist_grace, so the caller that wrote the cookie stores the new token; and that a cookie-carried session relies on the cookie's SameSite attribute against cross-site requests (the auth.cookie default is lax), as on the jwt.auth routes (QD-7).
- API reference: one sentence under the route table: /fetch, /refresh, /update, /change-password, /activate, /marketing-consent, /avatar, /avatar/remove and the jwt.auth routes read the token from the bearer header, then the token and auth_token cookies.
- classes list (near EndSession and RequestUser, :189-190): SessionToken(r), the session JWT the jwt guard reads, and SessionCookieNames(), the cookie list to pass to bouncer.NewJWTGuard so a handler's own guard reads the same token.
- Testing: one sentence on TestSessionRoutesAcceptCookies and what it pins; update the TestLogoutEndsTheSession sentence (:259) so it says /fetch and /refresh are checked through every carrier.
- Every identifier the README names must exist in the plugin; config keys are checked by hand.
Then run go vet, go test -short and the full Docker-backed suite. A failure unrelated to this change is not patched here: stop and report it.
Commit in the plugin checkout, staging by explicit path: classes/session_user.go, controllers/api_controller.go, session_cookie_test.go, logout_test.go, README.md. Subject: fix: /fetch, /refresh, /update and /change-password accept the session cookies the jwt guard reads. Body, two or three plain lines: the four routes (and the other signed-in routes through authenticate) read the bearer header, then the token and auth_token cookies, through classes.SessionToken and one cookie-aware guard; a bearer header still wins and no credentials stays 401; a cookie-carried /refresh answers the token in the body and writes no cookie. No Co-Authored-By or any other trailer. No push, no tag, no sm-demo-app pointer bump.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && GOWORK=off go vet ./... && GOWORK=off go test -short -count=1 ./... && GOWORK=off go test -count=1 -run '^(TestSessionRoutesAcceptCookies|TestLogoutEndsTheSession|TestOffboarding|TestRequestUser|TestEndRequestSession)$' . && GOWORK=off go test -count=1 ./... && test "$(grep -c 'func bearerToken' controllers/api_controller.go)" = 0 && test "$(grep -c 'bl).Authenticate' controllers/api_controller.go)" = 0 && grep -q 'SessionCookieNames()\.\.\.' controllers/api_controller.go && test "$(grep -c 'classes.SessionToken(r)' controllers/api_controller.go)" -ge 2 && grep -q 'TestSessionRoutesAcceptCookies' README.md && grep -q 'SessionCookieNames' README.md && ST=$(git status --short) && test -z "$ST" && S=$(git log -1 --format=%s) && grep -q 'accept the session cookies the jwt guard reads' <<<"$S" && B=$(git log -1 --format=%b) && ! grep -qi 'co-authored-by' <<<"$B"</automated>
</verify>
<done>go vet, go test -short and the full Docker-backed plugin suite are green. TestSessionRoutesAcceptCookies covers cookie-only success on /fetch, /refresh, /update and /change-password under both cookie names, no-credentials 401, bearer precedence and the refusals through the cookie; assertSessionEnded checks /fetch and /refresh through every carrier. The plugin tree is clean with one new fix commit on master (code, tests, README), no trailer, nothing pushed or tagged.</done>
</task>
<task type="auto">
<name>Task 3: fill G3 in the escalation note the way G2 was filled, record the outcome on the todo, cross-reference the login-cookie todo (summercms.go docs commit)</name>
<files>.planning/notes/2026-10-22-external-user-plugin-escalations.md, .planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md, .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md</files>
<precondition>Task 2's fix commit is the tip of sm-user-plugin master (git -C ../sm-demo-app/plugins/golem15/user log -1 --format=%s names the session cookies).</precondition>
<action>
Work in summercms.go (/media/nvme/dev/golem15/summercms.io/summercms/summercms.go). SHA below means the output of git -C ../sm-demo-app/plugins/golem15/user log -1 --format=%h master, written exactly as printed. Follow the G2 precedent from QD-8 (commits 76694c7 and 3ebd783). Re-read the note first and change only the G3 row and the G3 reply line.
1. Todo, .planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md: it stays in todos/pending, because the release hold keeps it open until v0.5.0. Append an "## Outcome (2026-10-22)" section shaped like G2's: Quick `261022-tto`. Fix commit `SHA` on sm-user-plugin master (base `15ff979`). Add one sentence on what changed: the four routes, and the other signed-in routes through authenticate, read the bearer header, then the token and auth_token cookies, through classes.SessionToken and one cookie-aware guard; a cookie-carried /refresh answers the token in the body and writes no cookie. End with: Reply note G3 filled. Not tagged, not pushed: the v0.5.0 wave (these six quicks + admin keyboard shortcuts + MCP) is the first release.
2. Note, .planning/notes/2026-10-22-external-user-plugin-escalations.md:
- Tracker row 2 (G3). The Quick / todo cell becomes "[261022-tto](../quick/261022-tto-fetch-refresh-update-change-password-mus/) · [todo](../todos/pending/2026-10-22-user-session-routes-ignore-cookie.md)". Status becomes "done (unreleased)". Shipped becomes "`SHA` → v0.5.0". Same shapes as row 1.
- Under Reply to send, in the G3 paragraph, replace its TODO line with this one line: "Ships in SummerCMS v0.5.0 (sm-user-plugin SHA, tagged with that wave): GET /fetch, POST /refresh, POST /update and POST /change-password (and the other signed-in routes: /activate, /marketing-consent, /avatar, /avatar/remove) read the session token like jwt.auth: the Authorization header first, then the token and auth_token cookies. A cookie-carried /refresh returns the rotated token in the body and does not rewrite the cookie; the previous token is revoked, so store the new one in your cookie." Leave the paragraph's first two lines unchanged, and every other row and paragraph too.
3. In .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md, append a short "## Note from G3 (2026-10-22)" section. Since sm-user-plugin SHA, POST /refresh accepts the token and auth_token cookies, answers the rotated token in the body only and writes no cookie. When /login can set the HttpOnly cookie, decide in --discuss whether a cookie-carried /refresh rotates that cookie, as bouncer.CookieRefreshHandler does. Otherwise the blacklisted old token stays in an HttpOnly cookie the browser cannot rewrite.
4. Commit in summercms.go, staging exactly the three paths above. Message: docs: fill G3 in the external-escalation reply (the G2 commit's form). No trailer. Do not stage .planning/STATE.md, .planning/state.json, .msd/ or any .planning/quick/ directory; the quick workflow commits its own artifacts.
5. g15office (CLAUDE.md rule 4, .planning/G15OFFICE.md). If a g15office tool is available, comment on task kkknstxl: "Fixed in sm-user-plugin SHA (local, ships with SummerCMS v0.5.0)". Leave its status alone: the todo is not closed until the release. Otherwise record the comment as pending in the SUMMARY.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/summercms.go && N=.planning/notes/2026-10-22-external-user-plugin-escalations.md && T=.planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md && S=$(git -C ../sm-demo-app/plugins/golem15/user log -1 --format=%h master) && test -f "$T" && grep -q "Outcome (2026-10-22)" "$T" && grep -q "$S" "$T" && grep -Eq "^\| 2 \| G3 .*261022-tto.*\| done \(unreleased\) \| .*$S.*v0\.5\.0" "$N" && ! grep -q 'those four accept the same cookies as jwt.auth' "$N" && grep -q "Ships in SummerCMS v0.5.0 (sm-user-plugin $S" "$N" && grep -Eq "^\| 1 \| G2 .*15ff979" "$N" && grep -q "$S" .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md && test -z "$(git status --short -- "$N" "$T" .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md)" && L=$(git log -1 --format=%s) && grep -q 'docs: fill G3 in the external-escalation reply' <<<"$L"</automated>
</verify>
<done>The G3 tracker row reads done (unreleased) with the quick and todo links and `SHA` → v0.5.0, as G2's does. The G3 reply line is in the "Ships in SummerCMS v0.5.0 (sm-user-plugin SHA, …)" form and describes the shipped behaviour. The todo stays in todos/pending with an Outcome section. The login-cookie todo carries the /refresh cross-reference. One docs commit in summercms.go holds exactly those three files. g15office has the comment, or it is recorded as pending.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| browser cookie jar -> signed-in user routes | a session JWT in the token or auth_token cookie now authenticates /fetch, /refresh, /update, /change-password (and /activate, /marketing-consent, /avatar, /avatar/remove) |
| other site -> state-changing POSTs | a cross-site request may carry the session cookie, depending on its SameSite attribute |
| request with several carriers -> controllers | bearer header and cookies may hold different tokens; the routes must pick the one the jwt guard picks |
## STRIDE Threat Register (ASVS L1, block on high)
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-tto-01 | E | cookie path skipping checks the bearer path enforces (blacklist after logout, tokens_valid_after, missing or deactivated user, /refresh ban and cutoff refusals) | high | mitigate | QD-2/QD-4: the cookie path goes through the same bouncer jwt guard (sessionGuard) as the bearer path, and Refresh keeps bouncer.Refresh plus refreshSubjectRefused; Task 1 cutoff subtest, Task 2 refresh-refusal subtests and assertSessionEnded through every carrier |
| T-tto-02 | S | carrier confusion: the user id taken from one token while the guard verified another (invalid bearer plus a valid cookie of another user) | high | mitigate | QD-1/QD-2: one extractor (classes.SessionToken) with the guard's order; authenticate uses the guard's principal, ChangePassword refuses when sub and principal differ; Task 1 "bearer wins" subtest asserts parity with jwt.auth |
| T-tto-03 | T | cross-site POST /update with a cookie-carried session (email change) | medium | accept | QD-7: same exposure as the existing jwt.auth POST /tokens and POST /logout; bouncer.LoadCookieConfig writes SameSite=Lax by default, which browsers do not send on cross-site POSTs; the README states the SameSite reliance; no new CSRF mechanism per the brief |
| T-tto-04 | T | cross-site POST /change-password | low | accept | Requires current_password; SameSite as T-tto-03 |
| T-tto-05 | D | cookie-only /refresh revokes the cookie's token without rewriting the cookie, ending a session whose writer does not store the body token (or a forced cross-site refresh under SameSite=None) | low | accept | QD-3: PHP parity and cookie ownership; README tells the caller to store the new token; the login-cookie todo gets the rotation decision (Task 3) |
| T-tto-06 | I | GET /fetch payload with a cookie on a cross-site navigation | low | accept | The browser sends a Lax cookie on a top-level GET, but another origin cannot read the JSON without a CORS grant (surf CORS policy unchanged) |
| T-tto-07 | E | /activate, /marketing-consent, /avatar, /avatar/remove gain cookie carriers through the shared authenticate | low | accept | QD-5: same guard and checks as jwt.auth; documented in the README; marketing-consent subtest pins it |
| T-tto-08 | T | unreviewed publish of a core plugin | medium | mitigate | No push, tag or pointer bump in this plan (QD-8, SummerCMS v0.5.0 release hold); the release stays a separate user decision |
| T-tto-SC | T | npm/pip/cargo/go installs | low | accept | No new dependency; only packages the plugin already imports (slices is stdlib) |
</threat_model>
<verification>
- sm-user-plugin (../sm-demo-app/plugins/golem15/user): GOWORK=off go vet ./..., GOWORK=off go test -short ./... and the full Docker-backed GOWORK=off go test -count=1 ./... green at the fix commit.
- Cookie-only success on /fetch, /refresh, /update and /change-password with both cookie names, each preceded by a jwt.auth 200 for the same cookie; no-credentials 401 with the unchanged bodies; bearer precedence; refusals through the cookie.
- The controllers package has no private bearer-header helper and no guard built without the cookie names; Logout, EndSession, plugin.go and routes.go are unchanged (git show --stat lists only the five Task 2 paths).
- summercms.go gets one docs commit with the note and the two pending todos only; no STATE.md, quick directory, admin/ or modules/ file. G2's row and reply line are unchanged.
- No push, tag, changelog post or sm-demo-app commit.
</verification>
<success_criteria>
- tto-1: a session that jwt.auth accepts through the token or auth_token cookie alone is served by GET /fetch, POST /refresh, POST /update and POST /change-password; no credentials still answers 401; the bearer header keeps precedence; Logout is unchanged.
- Existing bearer clients see byte-identical behaviour on every route, and the full plugin suite passes.
- G3 is filled in the escalation note in the G2 form (done (unreleased), `sha` → v0.5.0, "Ships in SummerCMS v0.5.0" reply line). The todo records the outcome and stays pending until the release. The login-cookie todo knows about /refresh cookie rotation.
</success_criteria>
<output>
Create `.planning/quick/261022-tto-fetch-refresh-update-change-password-mus/261022-tto-SUMMARY.md` when done. It records the plugin base commit and the fix sha; the subtests added and the assertSessionEnded change; the docs commit sha; follow-ups: plugin.go:99 could use classes.SessionCookieNames() in the G4 session; the plugin tag and app pointer bumps for 15ff979 and this fix go out with SummerCMS v0.5.0, and the todo moves to done then; other apps' plugin checkouts are not bumped. Also record the g15office status, and that the todo stays pending under the release hold (a deviation from the brief, per QD-8).
</output>

View File

@@ -0,0 +1,128 @@
---
phase: quick-261022-tto
plan: 01
quick_id: 261022-tto
subsystem: sm-user-plugin (golem15.user) session routes
tags: [user-plugin, jwt, cookies, escalation-G3, v0.5.0-hold]
status: complete
requires:
- sm-user-plugin 358ee5d (logout reads the session cookies, classes.sessionTokens)
- sm-user-plugin 15ff979 (G2, base of this fix)
provides:
- classes.SessionToken(r) and classes.SessionCookieNames()
- cookie-carried sessions on /fetch, /refresh, /update, /change-password (and /activate, /marketing-consent, /avatar, /avatar/remove)
affects:
- escalation note G3 row and reply line
- login-cookie todo (refresh cookie rotation decision)
tech-stack:
added: []
patterns:
- "one extractor: controllers read the raw token only through classes.SessionToken and build the guard with classes.SessionCookieNames()"
key-files:
created:
- ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
modified:
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/logout_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md
- .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
decisions:
- "Session routes read the token as the jwt guard does (bearer, then token, then auth_token) through classes.SessionToken and one cookie-aware sessionGuard"
- "A cookie-carried POST /refresh answers the rotated token in the body only and writes no cookie (PHP parity); the caller that wrote the cookie stores the new token"
- "G3 todo stays in todos/pending with an Outcome section under the SummerCMS v0.5.0 release hold (G2 precedent), not moved to done as the brief said"
metrics:
duration: ~8min
completed: 2026-10-22
commits: 1
plan_head_before: 15ff979
plan_head_after: 8e4b863a3fcc04a5541a836211a1f1f5a51dd693
actuals:
tokens: 9550
tasks: 3
commits: 2
---
# Quick 261022-tto: session cookies on /fetch, /refresh, /update and /change-password
The four signed-in user routes, and every other route behind the shared `authenticate` helper, now read the session JWT exactly as the plugin's `jwt` guard does: the bearer header first, then the `token` cookie, then the `auth_token` cookie. They use `classes.SessionToken` and a single cookie-aware `sessionGuard`. A cookie-carried `/refresh` returns the rotated token in the body and does not write a cookie.
## Commits
| Repo | Commit | Message |
|------|--------|---------|
| sm-user-plugin (master, local only) | `8e4b863` | fix: /fetch, /refresh, /update and /change-password accept the session cookies the jwt guard reads |
| summercms.go | `b70abe4` | docs: fill G3 in the external-escalation reply |
Plugin base: `15ff979` (master had not moved; `git log 15ff979..master` before the fix was empty). The plugin tree was clean at the start and is clean after the commit. No push, tag or sm-demo-app pointer bump.
The frontmatter `commits: 1` is measured from the plugin ledger, `git rev-list --count 15ff979..8e4b863`. `actuals.commits: 2` also counts the summercms.go docs commit.
## What changed (plugin)
- `classes/session_user.go`: `sessionToken` is renamed to the exported `SessionToken`, and its one caller, `RequestUser`, is updated. A new `SessionCookieNames()` returns `slices.Clone(sessionCookieNames)`. `sessionTokens`, `EndSession` and `forgetSessionCookies` are unchanged.
- `controllers/api_controller.go`:
- New `sessionGuard(app, secret)`: it looks up `bouncer.BlacklistStore` and returns `bouncer.NewJWTGuard(..., classes.SessionCookieNames()...)`.
- `authenticate`: one guard call; it takes the user ID from the principal and loads the user with the scoped Take. The bearer-only `VerifyClaims` step that failed closed is gone.
- `Refresh`: reads the token with `classes.SessionToken(r)`. The c3712dc refusals and the response body are unchanged, and it writes no cookie.
- `ChangePassword`: reads the token with `classes.SessionToken(r)`, then runs `VerifyClaims` for sub and iat and `sessionGuard(...).Authenticate`. If the principal's ID differs from sub, it answers 401.
- The private `bearerToken` helper is deleted.
- `Logout`, `EndSession`, `plugin.go` and `routes.go` are untouched.
- `README.md`:
- The JWT-sessions bullet describes the cookie carriers, `/refresh` with no cookie write, the store-the-new-token duty and the SameSite reliance.
- A sentence under the API reference table names the routes that accept the cookies.
- The classes list adds `SessionToken` and `SessionCookieNames`.
- The Testing section adds a `TestSessionRoutesAcceptCookies` paragraph and reworded the `TestLogoutEndsTheSession` sentence.
## Tests
`TestSessionRoutesAcceptCookies` in the new `session_cookie_test.go` uses one `newAdminEnv` and new helpers `cookieSend`, `login`, `cutOff`, `userSub` and `fetchedID`. Its subtests:
- `/fetch` with only the `token` or `auth_token` cookie, each preceded by a 200 from `e.guarded` (jwt.auth): 200 with the token's user.
- `/fetch` with no credentials: 401 with `unauthorizedRaw`.
- Bearer wins: with bearer A and cookie B, A's user is served. An invalid bearer plus a valid cookie gives 401 on `/fetch` and on `/tokens` (jwt.auth).
- A cut-off token in the `auth_token` cookie gets 401 on `/fetch`.
- `/refresh` through either cookie: 200 with a new body token and no Set-Cookie. The new token works as a bearer; the old cookie token now gets 401 on `/fetch`.
- `/refresh` through the cookie refuses a banned user and a cut-off token (`assertRefreshRefused`). With no credentials it answers 401 with exactly `{"error":"Token not found"}`.
- `/update` through either cookie: 200, and the name is stored.
- `/change-password` through either cookie (user with `HasSelfSetPassword`): 200, the calling cookie token still works on `/fetch`, and login with the new password succeeds.
- `/marketing-consent` through the `token` cookie: 200 (the QD-5 smoke check).
- `/update` and `/change-password` with no credentials: 401 with `unauthorizedRaw`.
`logout_test.go` `assertSessionEnded` now also checks `/fetch` (401) and `/refresh` (401 with `blacklistedBody`) through the `token` and `auth_token` cookies, alongside the bearer checks.
RED was observed before the change: 11 cookie subtests failed against 15ff979. After Task 1 the fetch, cut-off, bearer-wins and marketing-consent/update subtests went green. After Task 2 everything is green.
Verification at `8e4b863`: `GOWORK=off go vet ./...`, `GOWORK=off go test -short -count=1 ./...` and the full Docker-backed `GOWORK=off go test -count=1 ./...` all pass. All the grep gates in the Task 2 and Task 3 verify blocks pass.
## Deviations from Plan
1. **Minor placement:** the todo's "## Outcome (2026-10-22)" and the login-cookie todo's "## Note from G3 (2026-10-22)" sections go just before each file's `## Invoke` block, not at the very end of the file. This mirrors where G2's Outcome section sits (76694c7).
2. **Brief deviation (planned, QD-8):** the G3 todo stays in `todos/pending` under the SummerCMS v0.5.0 release hold. It was not moved to done as the original brief said.
Otherwise the plan was executed as written.
## Follow-ups
- **G4 session:** `plugin.go:99` could register the jwt guard with `classes.SessionCookieNames()...` instead of the literal `"token", "auth_token"`. It was left alone here so it does not overlap with G4's Boot rewiring. The parity subtests pin the two lists together until then.
- **Release:** the plugin tag and the app pointer bumps for `15ff979` and `8e4b863` go out with SummerCMS v0.5.0. The G3 todo moves to `todos/done` at that point. Other apps' plugin checkouts (sm-grzybyfunkcjonalne-app, sm-summercmsio-app, fonoteka.go) are not bumped.
- **Login-cookie todo (item 7):** decide in `--discuss` whether a cookie-carried `/refresh` rotates a server-written HttpOnly cookie, as `bouncer.CookieRefreshHandler` does. The cross-reference is now in that todo.
- **g15office:** PENDING. No g15office tool was available in this session. Post on task `kkknstxl`: "Fixed in sm-user-plugin 8e4b863 (local, ships with SummerCMS v0.5.0)". Leave its status as it is.
## Threat model
- T-tto-01 and T-tto-02 are mitigated as planned: there is one extractor, the cookie path goes through the same guard, ChangePassword checks that the principal matches sub, and the tests pin each of these.
- T-tto-03 through T-tto-07 are accepted, and the README documents the SameSite reliance.
- T-tto-08 is mitigated: nothing was pushed or tagged.
- No new threat surface beyond the register.
## Known Stubs
None.
## Self-Check: PASSED
- FOUND: ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
- FOUND: sm-user-plugin commit 8e4b863 on master (clean tree)
- FOUND: summercms.go commit b70abe4 (three docs paths only)

View File

@@ -0,0 +1,96 @@
---
phase: quick-261022-tto
verified: 2026-10-22T22:05:00+02:00
status: passed
score: 7/7 must-haves verified
covered_files:
- .planning/quick/261022-tto-fetch-refresh-update-change-password-mus/261022-tto-PLAN.md
- .planning/quick/261022-tto-fetch-refresh-update-change-password-mus/261022-tto-SUMMARY.md
covered_digest: "v2:sha256:31e248110224527435feeac56ee1e8e1627257f312ae22cc6fe05f25a50675e0"
covered_files_note: "The implementation lives in sm-user-plugin (../sm-demo-app/plugins/golem15/user, commit 8e4b863 on base 15ff979), outside this project root, so verification.fingerprint refuses those paths. Verified files there: classes/session_user.go, controllers/api_controller.go, session_cookie_test.go, logout_test.go, README.md."
behavior_unverified: 0
overrides_applied: 0
---
# Quick 261022-tto: Verification Report
**Goal:** GET /fetch, POST /refresh, POST /update and POST /change-password of the user plugin accept the `token` / `auth_token` cookies the same way `jwt.auth` and `EndSession` already do. Logout stays as it is.
**Verified:** 2026-10-22
**Status:** passed
**Re-verification:** No (initial verification)
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | A request that `jwt.auth` accepts with only the `token` or only the `auth_token` cookie gets 200 from /fetch (that user's payload), /refresh (a new token in the body), /update (the profile is saved) and /change-password (the password is replaced). | VERIFIED | `authenticate`, `Refresh` and `ChangePassword` read the token through `classes.SessionToken` and `sessionGuard`, which is built with `classes.SessionCookieNames()...`. The subtests for fetch, refresh, update and change-password, each run under both cookie names, first check `e.guarded(...)==200`, then the route's result: fetch matches the user id from the token's sub, refresh returns a new body token that works as a bearer, update stores the new name, and the new password logs in. All pass at 8e4b863. Against the 15ff979 code with the same test, 11 subtests fail. |
| 2 | With no credentials, the routes still answer 401 with the old bodies: `unauthorizedRaw` from /fetch, /update and /change-password, `{"error":"Token not found"}` from /refresh. | VERIFIED | Subtests "fetch without credentials", "refresh without credentials" and "/update and /change-password without credentials" compare the bodies byte for byte. They pass. |
| 3 | The bearer header wins exactly as in the jwt guard: bearer A with cookie B serves A; an invalid non-empty bearer with a valid cookie is 401 here and on jwt.auth. | VERIFIED | `classes.sessionTokens` matches bouncer `extractToken`/`bearerToken` (modules/bouncer/jwt.go:273-325): trimmed header, exact `Bearer ` prefix, a non-empty value wins, then each cookie in order with trimmed non-empty values. Subtest "bearer wins" covers /fetch and /tokens and passes. |
| 4 | A cookie-carried token is refused for the same reasons as a bearer token: blacklisted, issued before the cutoff, user missing or deactivated. /refresh keeps the c3712dc refusals. | VERIFIED | After extraction the path is the same guard (blacklist, `issuedBeforeCutoff`, `PrincipalByID` soft-delete scope) or the unchanged `bouncer.Refresh` + `refreshSubjectRefused`. Tests through the cookie: "fetch refuses a cut-off cookie token", "refresh refuses a banned user / cut-off token through the cookie" (`assertRefreshRefused`), and `assertSessionEnded` (/fetch and /refresh blacklisted through both cookies). All pass. Deactivated or missing users are not tested through the cookie specifically; that code is independent of the carrier and covered by TestOffboarding over the bearer. |
| 5 | A cookie-carried /refresh returns the rotated token in the body only and sets no cookie. The old token is blacklisted. Bearer-only clients see no change. Logout and EndSession are untouched. | VERIFIED | The refresh subtests assert `len(rec.Result().Cookies())==0` and that the old cookie token gets 401 on /fetch. The diff 15ff979..8e4b863 touches neither `Logout`, `EndSession`, plugin.go nor routes.go. The existing bearer tests (TestOffboarding, TestRefreshSubjectChecks, TestLogoutEndsTheSession) pass. |
| 6 | There is one extractor. The controllers read the token only through `classes.SessionToken` and build the guard with `classes.SessionCookieNames()`. The private bearer helper is gone. | VERIFIED | grep: `func bearerToken` is gone from controllers. `classes.SessionToken(r)` is called at api_controller.go:203 (Refresh) and :600 (ChangePassword). `SessionCookieNames()...` is used at :922 (sessionGuard). The only `Authorization` header read left is classes/session_user.go:242 (sessionTokens). |
| 7 | vet, `-short` and the full Docker test run are green at one fix commit. Nothing is pushed, tagged or pointer-bumped. G3 is recorded as done (unreleased) in the G2 form. | VERIFIED | I ran `GOWORK=off go vet ./...`, `go test -short ./...` and the full `go test -count=1 ./...` (Docker): all green, tree clean. master is ahead of origin/master by 2 (origin = 930b158). No tag contains 15ff979 or 8e4b863. The committed sm-demo-app submodule pointer is still 930b158. b70abe4 fills G3: the row reads "done (unreleased)", "`8e4b863` → v0.5.0", and the reply line starts "Ships in SummerCMS v0.5.0 (sm-user-plugin 8e4b863, tagged with that wave)". |
**Score:** 7/7 truths verified (0 present, behavior-unverified)
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `sm-user-plugin/classes/session_user.go` | `SessionToken`, `SessionCookieNames` | VERIFIED | Both exported. `SessionCookieNames` returns `slices.Clone`. `RequestUser` calls `SessionToken`. |
| `sm-user-plugin/controllers/api_controller.go` | `sessionGuard` with the cookie names; authenticate, Refresh and ChangePassword converted | VERIFIED | `sessionGuard` is at :916-923. `authenticate` makes one guard call followed by a scoped Take. ChangePassword checks that the principal ID equals sub. |
| `sm-user-plugin/session_cookie_test.go` | `TestSessionRoutesAcceptCookies` | VERIFIED | 253 lines, 17 subtests, all pass. The RED run against 15ff979 code fails 11 of them. |
| `sm-user-plugin/README.md` | cookie carriers, classes list, Testing entry | VERIFIED | JWT-sessions bullet, a sentence under the API table, the `SessionToken`/`SessionCookieNames` bullet, and a `TestSessionRoutesAcceptCookies` paragraph. |
### Key Link Verification
| From | To | Via | Status | Details |
|------|----|-----|--------|---------|
| api_controller.go `sessionGuard` | classes `SessionCookieNames` | `bouncer.NewJWTGuard(..., classes.SessionCookieNames()...)` | WIRED | Used by `authenticate` and `ChangePassword`. |
| api_controller.go Refresh / ChangePassword | classes `SessionToken` -> `sessionTokens` | `classes.SessionToken(r)` | WIRED | Lines 203 and 600. |
| session_cookie_test.go | GET /tokens (jwt.auth) | `e.guarded(t, token, name)` | WIRED | Checked before every cookie success subtest. |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Cookie routes, refusals, bearer precedence | `GOWORK=off go test -count=1 -run '^TestSessionRoutesAcceptCookies$' .` | 17/17 subtests pass | PASS |
| The test discriminates (RED) | same test in a scratch copy with controllers/ and classes/ from 15ff979 | 11 subtests FAIL (fetch, refresh, update, change-password, consent through cookies, refresh refusals) | PASS (discriminating) |
| Regression on bearer and logout | `-run '^(TestLogoutEndsTheSession|TestOffboarding|TestRefreshSubjectChecks)$'` | pass | PASS |
| Whole plugin | `GOWORK=off go vet ./...`; `go test -short ./...`; `go test -count=1 ./...` | all ok | PASS |
### Probe Execution
None declared for this quick task.
### Requirements Coverage
| Requirement | Source Plan | Description | Status | Evidence |
|-------------|-------------|-------------|--------|----------|
| tto-1 | 261022-tto-PLAN | G3: the four routes accept the token/auth_token cookies like jwt.auth and EndSession; bearer precedence; no credentials stays 401; Logout unchanged | SATISFIED | Truths 1-7 |
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| (8e4b863 diff) | - | no TBD/FIXME/XXX/TODO/HACK added | - | none |
| session_cookie_test.go | 24 | test-local `sessionCookieNames` literal duplicates classes' list | Info | The tests pin the list independently, which is deliberate parity checking. |
| plugin.go | 99 | jwt guard still uses the literal `"token", "auth_token"` instead of `classes.SessionCookieNames()` | Info | Planned follow-up (QD-1) for the G4 session. The parity subtests guard against drift. |
| - | - | g15office comment on task kkknstxl marked PENDING in SUMMARY | Info | Process item (CLAUDE.md rule 4), not a code must-have. |
Note on test strength: subtest "fetch refuses a cut-off cookie token" also passes against the pre-fix code, because there the cookie was ignored and the answer was 401 anyway. Against the fixed code it still catches a regression where the cookie is read but the cutoff is skipped.
### Human Verification Required
None.
### Gaps Summary
No gaps. The four named routes, and the other `authenticate` routes, read the session token through the same extractor and cookie list as the jwt guard. The behaviour is pinned by a test that fails on the pre-fix code and passes at 8e4b863. The release hold is respected.
---
_Verified: 2026-10-22_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,60 @@
# Quick Task 261022-usi: User-plugin jwt blacklist and hooks wired via lagoon.OnDatabase under serve; jwt guard uses SessionCookieNames - Context
**Gathered:** 2026-10-22
**Status:** Ready for planning
<domain>
## Task Boundary
External escalation G4. Under `summer serve`, `party.Activate` runs every plugin `Boot` before `surf.ServeCommand` calls `lagoon.Publish`. The user plugin's `Boot` (`../sm-demo-app/plugins/golem15/user/plugin.go`, repo sm-user-plugin, base `8e4b863`) looks up `*sql.DB` / `*gorm.DB`, finds none, registers the jwt guard with `bl=nil`, and never publishes `bouncer.BlacklistStore`. Logout (`EndSession`, `api_controller.go`) looks the store up at request time and writes nothing, so a logged-out token keeps working. `classes.RegisterHooks(gdb)` has the same Boot-before-DB hole.
Fix inside the user plugin only. Framework (`summercms.go`) stays unchanged.
</domain>
<decisions>
## Implementation Decisions
### Guard wiring: lazy store
- `bouncer.Registry.Register` refuses a second "jwt" registration, so there is no re-registration.
- Boot registers the jwt guard **once** with a small plugin-local `bouncer.BlacklistStore` that resolves `app.Lookup[bouncer.BlacklistStore]()` on every call. When no store is published: `IsBlacklisted` returns `false, nil`, `Add` and `Sweep` are no-ops. The guard therefore exists with or without a DB, as it does today.
- The lazy wrapper is NOT itself published as `bouncer.BlacklistStore` (that would make the lookup recurse). Only the real store is published.
- That single `reg.Register(... "jwt" ...)` line passes `classes.SessionCookieNames()...` instead of the hardcoded `"token", "auth_token"` (G3 leftover).
### Database-ready work through `lagoon.OnDatabase`
- From Boot, one `lagoon.OnDatabase(app, func(sqlDB, gdb) error { ... })` call does all of these: `classes.RegisterHooks(gdb)`, `app.Publish[bouncer.BlacklistStore](bouncer.NewPostgresBlacklist(sqlDB, "jwt_blacklist"))`, `p.startBlacklistSweep(store)`.
- OnDatabase runs the callback immediately when the DB is already published (the tests that publish first keep working) and otherwise queues it for `lagoon.Publish`.
- Remove the direct `app.Lookup[*gorm.DB]` / `*sql.DB` branches from Boot.
### Test: full serve order
- New Docker-backed test in sm-user-plugin (skips under `-short`): build the app, run Register + Boot with **no** DB published, then `lagoon.Publish`, then build routes (`surf.BuildRouter` or the plugin's existing test router helper), log in, log out, then show that the same token on a `jwt.auth` route answers 401 and that a `jwt_blacklist` row exists for its jti.
- Same test (or a sibling) asserts `RegisterHooks` ran after Publish (an observable hook effect, or the callback being registered on gdb).
- A test that publishes first does not count as the regression test.
### Claude's Discretion
- Name and file of the lazy store type (for example `classes/blacklist.go` or in `plugin.go`).
- Whether `startBlacklistSweep` stays a method or moves.
- Exact assertion for "RegisterHooks ran", picked from whatever RegisterHooks installs.
</decisions>
<specifics>
## Specific Ideas
- Pattern to follow: `../sm-demo-app/plugins/golem15/paymentgatewaysubscriptions/boot.go:113-121` and `modules/lagoon/README.md` (OnDatabase from Boot).
- Plugin repo: commit in the sm-user-plugin submodule at `../sm-demo-app/plugins/golem15/user`. Commit locally only: no push, no tag, no app pointer bump (release hold for SummerCMS v0.5.0).
- Update the plugin README if its description of Boot or the blacklist wiring changes.
- Afterwards (orchestrator, in summercms.go planning docs): fill G4 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` (tracker row `done (unreleased)` + commit → v0.5.0, and replace the G4 `TODO` paragraph in the reply), and add an Outcome to the todo, which stays in pending.
</specifics>
<canonical_refs>
## Canonical References
- `.planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md`
- `.planning/notes/2026-10-22-external-user-plugin-escalations.md`
- `modules/lagoon/ondatabase.go`, `modules/lagoon/README.md`
- `modules/bouncer/registry.go` (Register refuses duplicates), `modules/bouncer/blacklist.go` (BlacklistStore interface), `modules/bouncer/jwt.go` (NewJWTGuard)
- `modules/surf/serve.go:75-88` (Publish then BuildRouter)
</canonical_refs>

View File

@@ -0,0 +1,259 @@
---
phase: quick-261022-usi
plan: 01
quick_id: 261022-usi
slug: user-plugin-jwt-blacklist-and-hooks-wire
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- usi-1 # G4: under summer serve (party.Activate before lagoon.Publish) POST /logout revokes the token: the jwt guard sees the Postgres jwt_blacklist store, the store and the plugin's GORM hooks are wired through lagoon.OnDatabase; the jwt guard reads classes.SessionCookieNames() (G3 leftover)
files_modified:
# sm-user-plugin (module golem15.user), worked in the sm-demo-app submodule checkout. Commit there only.
- ../sm-demo-app/plugins/golem15/user/plugin.go
- ../sm-demo-app/plugins/golem15/user/blacklist.go
- ../sm-demo-app/plugins/golem15/user/blacklist_test.go
- ../sm-demo-app/plugins/golem15/user/serve_order_test.go
- ../sm-demo-app/plugins/golem15/user/admin_harness_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
estimate:
tokens: 90000
raw_tokens: 90000
tasks: 2
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "Booted in the serve order (party.Activate with no database published, then lagoon.Publish, then the router), a session token that POST /logout ended is refused with 401 on a jwt.auth route through the bearer header and through each session cookie, at GET /fetch and at POST /refresh, and jwt_blacklist holds one row for its jti."
- "Before lagoon.Publish no bouncer.BlacklistStore is published and the plugin's GORM hooks have not run; when lagoon.Publish runs, classes.RegisterHooks runs with the published *gorm.DB, a *bouncer.PostgresBlacklist on jwt_blacklist is published as bouncer.BlacklistStore, and the blacklist sweep starts."
- "Boot registers the jwt guard exactly once, with or without a database, with the cookie names from classes.SessionCookieNames() and a plugin-local store that resolves the published bouncer.BlacklistStore on every call. Without a published store no token counts as blacklisted and Add and Sweep do nothing. A store error passes through unchanged, so the guard still refuses the token. The wrapper itself is never published."
- "When the database is published before Boot (the plugin's own tests, the sociallogin and oauthserver harnesses), hooks, store and sweep are still wired synchronously inside Boot, so the existing suites stay green unchanged."
- "go vet, go test -short and the full Docker-backed go test of the plugin pass at one fix commit on sm-user-plugin master. Nothing is pushed or tagged, the sm-demo-app pointer is not bumped and summercms.go is not modified."
artifacts:
- path: ../sm-demo-app/plugins/golem15/user/plugin.go
provides: "Boot wires RegisterHooks, the Postgres blacklist store and its sweep through one lagoon.OnDatabase call; the jwt guard gets the lazy store and classes.SessionCookieNames()"
contains: "lagoon.OnDatabase(app, func("
- path: ../sm-demo-app/plugins/golem15/user/blacklist.go
provides: "appBlacklist, the unexported bouncer.BlacklistStore that resolves the published store per call"
contains: "type appBlacklist struct"
- path: ../sm-demo-app/plugins/golem15/user/admin_harness_test.go
provides: "adminEnvConfig (extracted, unchanged config) and newServeOrderEnv (Activate, hook point, Publish, uploads, Migrate, Assemble)"
contains: "func newServeOrderEnv"
- path: ../sm-demo-app/plugins/golem15/user/serve_order_test.go
provides: "TestBootBeforeDatabase, the Activate-then-Publish regression test (Docker, skips under -short)"
contains: "func TestBootBeforeDatabase"
- path: ../sm-demo-app/plugins/golem15/user/blacklist_test.go
provides: "TestAppBlacklist: no store, wrapper-published-as-store, delegation, error pass-through (runs under -short)"
contains: "func TestAppBlacklist"
- path: ../sm-demo-app/plugins/golem15/user/README.md
provides: "JWT-sessions bullet describes the OnDatabase wiring and the per-request store; Testing names TestBootBeforeDatabase and TestAppBlacklist"
contains: "TestBootBeforeDatabase"
key_links:
- from: ../sm-demo-app/plugins/golem15/user/plugin.go (Boot)
to: summercms.go modules/lagoon/ondatabase.go (OnDatabase) and modules/lagoon/connection.go (Publish -> runDatabaseHooks)
via: "the callback is queued in Boot and drained by the serve command's lagoon.Publish, which runs before BuildRouter"
pattern: "lagoon\\.OnDatabase\\(app, func\\("
- from: ../sm-demo-app/plugins/golem15/user/plugin.go (jwt guard registration)
to: ../sm-demo-app/plugins/golem15/user/blacklist.go (appBlacklist.store)
via: "bouncer.NewJWTGuard captures the wrapper at Boot; the wrapper looks up bouncer.BlacklistStore on the same app per request"
pattern: "&appBlacklist\\{app: app\\}"
- from: ../sm-demo-app/plugins/golem15/user/plugin.go (jwt guard registration)
to: ../sm-demo-app/plugins/golem15/user/classes/session_user.go (SessionCookieNames)
via: "the guard, SessionToken, EndSession and the controllers read the same cookie list"
pattern: "classes\\.SessionCookieNames\\(\\)\\.\\.\\.\\)"
- from: ../sm-demo-app/plugins/golem15/user/classes/session_user.go (EndSession, the POST /logout path)
to: the store the OnDatabase callback publishes
via: "EndSession already looks bouncer.BlacklistStore up at request time; once the callback publishes it, logout writes the jwt_blacklist row the guard then reads"
pattern: "Publish\\[bouncer\\.BlacklistStore\\]\\(store\\)"
---
<objective>
Close escalation G4. Under `summer serve`, the generated main runs party.Activate (every plugin Boot) before surf's serve command calls lagoon.Publish. The user plugin's Boot finds no database, so it registers the jwt guard with a nil blacklist and never publishes bouncer.BlacklistStore. classes.EndSession (POST /logout) then finds no store and writes nothing, so a logged-out token keeps working. classes.RegisterHooks has the same hole. After this plan the database-dependent wiring runs through lagoon.OnDatabase, and the guard resolves the store per request. While reworking that Register line, switch the jwt guard to classes.SessionCookieNames() (G3 leftover).
Purpose: logout revokes the session in production (serve), not only in tests that publish the database first.
Output: one fix commit on sm-user-plugin master (code, tests and README together), made in /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user with git -C. No push, no tag, no sm-demo-app pointer bump (SummerCMS v0.5.0 release hold). summercms.go is not modified. The orchestrator handles the planning docs (the G4 row and reply in the escalation note, the todo's Outcome and STATE.md); they are not executor tasks.
Locked decisions (from 261022-usi-CONTEXT.md, labelled here for traceability):
- D-01 Guard wiring, lazy store. bouncer.Registry.Register refuses a duplicate name, so the guard is never registered twice. Boot registers the jwt guard once with a plugin-local bouncer.BlacklistStore. That store resolves the app's published bouncer.BlacklistStore on every call. With no store published, IsBlacklisted answers false with a nil error, and Add and Sweep do nothing. The wrapper is never published as bouncer.BlacklistStore, because the lookup would then recurse. That one Register call passes classes.SessionCookieNames()... in place of the two hardcoded cookie-name literals.
- D-02 Database work goes through lagoon.OnDatabase. One lagoon.OnDatabase(app, ...) call from Boot does three things: classes.RegisterHooks(gdb), publishing bouncer.NewPostgresBlacklist(sqlDB, "jwt_blacklist") as bouncer.BlacklistStore, and p.startBlacklistSweep(store). The direct *gorm.DB and *sql.DB lookup branches leave Boot.
- D-03 The test uses the full serve order. A new Docker-backed test skips under -short. It boots with no database published, then calls lagoon.Publish, then builds the routes. Then it logs in, logs out, and shows that the same token gets 401 on a jwt.auth route and that a jwt_blacklist row exists for its jti. It also shows that RegisterHooks ran after Publish. A test that publishes first does not count.
Planner's choices (Claude's discretion in CONTEXT; the executor does not revisit them):
- QD-1 The lazy store is an unexported `appBlacklist` in a new file blacklist.go at the plugin root (package user). Exporting it would add public API to a core plugin for no consumer.
- QD-2 startBlacklistSweep stays a method and is not changed.
- QD-3 "RegisterHooks ran after Publish" is observed with a test hook. The test registers it through classes.RegisterHook; it records the *gorm.DB it was called with. classes keeps its registrants in a process-global slice with no unregister, and adding one would be new exported API. So the hook is gated by an atomic.Bool that t.Cleanup clears, which makes it inert for later boots in the same test binary. Production registers no hooks today, so the hook is the only observable effect.
- QD-4 The serve-order boot is a harness function, newServeOrderEnv(t, beforePublish), in admin_harness_test.go. It shares the config with newAdminEnv through an extracted adminEnvConfig(t), so the existing helpers (sessionLogin, guarded, assertSessionEnded, call, send) work on it. The order mirrors surf's serve command: Activate, then lagoon.Publish, publishUploads and BuildRouter. lagoon.Migrate sits before Assemble only because the shared harness database may not be migrated yet when this test runs first.
- QD-5 appBlacklist treats a published value that is itself an *appBlacklist as no store, which guards against recursion. A store error goes back unchanged, so bouncer's guard still fails closed with "Authentication error".
- QD-6 The OnDatabase call sits where RegisterHooks used to run (after JWTSecret, before the registry). The closure uses Boot's `app` parameter, never p.app, because one registered Plugin value is shared by every party.Activate in a test binary. Boot returns OnDatabase's error, because the callback runs immediately when the database is already published.
Source coverage audit:
| Source | Item | Covered by |
|--------|------|------------|
| GOAL | logout revokes under serve | Task 1 (GREEN, TestBootBeforeDatabase) |
| CONTEXT D-01 | single registration, lazy store, not published, SessionCookieNames | Task 1 GREEN; Task 2 TestAppBlacklist |
| CONTEXT D-02 | OnDatabase: hooks + publish + sweep; direct lookups removed | Task 1 GREEN and its grep gates |
| CONTEXT D-03 | Activate-then-Publish Docker test, -short skip, login/logout/401/row, hooks after Publish | Task 1 RED/GREEN |
| CONTEXT specifics | README updated; commit locally in the plugin repo; no push/tag/bump | Task 2 |
| CONTEXT specifics | G4 row/reply, todo Outcome | orchestrator (excluded by the quick constraints) |
| REQ / RESEARCH | none (quick task, no research) | n/a |
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@CLAUDE.md
@.planning/STATE.md
@.planning/quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/261022-usi-CONTEXT.md
@.planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md
@../sm-demo-app/plugins/golem15/user/plugin.go
@modules/lagoon/ondatabase.go
Working copies (observed at planning time, 2026-10-22):
- sm-user-plugin is at ../sm-demo-app/plugins/golem15/user (absolute /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user). Branch master at 8e4b863 (G3), 2 ahead of origin/master, working tree clean, latest tag v0.1.8. Do not fetch, merge, rebase or reset. If master has moved past 8e4b863, build on top and record `git log --oneline 8e4b863..master` in the SUMMARY. If the tree is dirty, stop: another session is working there.
- Go: sm-demo-app's go.work does not list the plugin under `use`, so every go command in the plugin runs with GOWORK=off. go.mod:176 replaces summercms with ../../../../summercms.go (summercms.go's working tree). lagoon.OnDatabase has existed since v0.1.x.
- Docker: docker info answered (server 29.9.1). If the Docker socket is denied, run go test through sudo -u golem (CLAUDE.md).
- sm-demo-app (../sm-demo-app) has another session's uncommitted edits (main.go and the plugins/golem15/user pointer). Read-only here: run tests, never stage or commit.
- The planning docs in summercms.go belong to the orchestrator. Do not touch STATE.md, the escalation note or the todo.
Source facts (plugin checkout at 8e4b863):
- plugin.go: Plugin{app, sweepStop} :54-57. Boot :67-114: JWTSecret :69, RegisterHooks branch :73-77, registry lookup-or-publish :78-84, blacklist block :85-98 (direct database lookups, Publish, startBlacklistSweep), jwt guard Register :99 with two hardcoded cookie names, api_token guard :102-112, RegisterUserAuthorizer :113. startBlacklistSweep :116-147 (reads p.app.Config golem15.user.jwt.blacklist_sweep_interval, default 10m, starts at most once per Plugin value through sweepStop). withDB :214-227 keeps its own *gorm.DB lookup, which is legitimate for console commands. Middlewares :233-249 reads the registry when the router is built. Imports already include database/sql, lagoon, bouncer, gorm.
- classes/registry.go: RegisterHook appends to the package-level hookRegistrars; RegisterHooks runs them all. There are no production registrants (only classes/user_groups_test.go). classes/session_user.go: SessionCookieNames() :27 returns a copy of token, auth_token. EndSession (:123) and RequestUser (:74) look bouncer.BlacklistStore up at request time. controllers/api_controller.go :209 (Refresh) and :919 (sessionGuard) do too.
- summercms.go: lagoon.OnDatabase runs fn immediately when a *gorm.DB is published (it uses gdb.DB() when no *sql.DB was published), and otherwise queues fn; lagoon.Publish (connection.go:162) publishes both handles and then drains the queue, wrapping a callback error as "lagoon: database hook: ...". surf serve.go:70-88 order: OpenFromApp, lagoon.Publish, publishUploads, installCooler, BuildRouter. bouncer.NewJWTGuard(secret, users, bl, cookieNames...) (jwt.go:86) consults bl only when it is non-nil; an IsBlacklisted error gives "Authentication error" (401). bouncer.BlacklistStore (blacklist.go:16) has Add(ctx, jti, expiresAt, validUntil), IsBlacklisted(ctx, jti) and Sweep(ctx, now). bouncer.NewMemoryBlacklist and bouncer.NewPostgresBlacklist exist. backpack.App.Publish refuses a second value of the same type. cabana keeps its own backend blacklist (adminBlacklist, own table) and never publishes bouncer.BlacklistStore.
- Tests (package user, plugin root): admin_harness_test.go has adminHarnessDB :91 (skips under -short; shared database user_admin in the session container), newAdminEnv :131-192 (config block :134-160, then lagoon.Publish :162, mailCapture logger :165, attach.Publish with memblob :169-173, party.Activate :176, configure, lagoon.Migrate :184, surf.Assemble :187) and the adminEnv fields h, app, gdb, bucket, mail. logout_test.go has the constants userTokensPath, userLogoutPath, userRefreshPath and blacklistedBody :16-23, sessionLogin :208, guarded :220, assertSessionEnded :231 (jwt.auth through bearer/token/auth_token, /fetch, /refresh) and assertLoggedOut :264. session_test.go has sessionConfig, parseToken :644 and bootPlugin :710 (reads p.sweepStop right after Boot). TestLogin checks the store is published after a DB-first Boot. TestLoginRouteGroup boots with no database. TestLoginBlacklistSweep uses a 50ms sweep. session_user_test.go has failingBlacklist/errBlacklistDown :24-35 and sessionUserApp(t, environ...) :39 (an app without a database). No root TestMain; Docker tests skip through adminHarnessDB.
- The names appBlacklist, adminEnvConfig, newServeOrderEnv, TestBootBeforeDatabase and TestAppBlacklist, and the files blacklist.go, blacklist_test.go and serve_order_test.go, are all unused today.
- README.md: the JWT-sessions bullet :20 ("Boot registers the `jwt` guard ...", "A background sweep prunes the blacklist."), the classes list with SessionCookieNames :192, the Testing section :247 (TestLogoutEndsTheSession :262, TestSessionRoutesAcceptCookies :264).
- Consumers that boot this checkout through sm-demo-app's go.work replace: plugins/golem15/sociallogin and plugins/golem15/oauthserver harnesses publish the database before party.Activate (the immediate OnDatabase path).
</context>
<tasks>
<task type="tracer" tdd="true">
<name>Task 1 (tracer): booting in the serve order (Activate, then Publish) wires the blacklist and hooks, so logout revokes the token on jwt.auth end to end on Postgres</name>
<files>../sm-demo-app/plugins/golem15/user/plugin.go, ../sm-demo-app/plugins/golem15/user/blacklist.go, ../sm-demo-app/plugins/golem15/user/admin_harness_test.go, ../sm-demo-app/plugins/golem15/user/serve_order_test.go</files>
<precondition>git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user status --short is empty, its branch is master and 8e4b863 is an ancestor of HEAD; Docker is reachable for testcontainers (directly or through sudo -u golem).</precondition>
<behavior>
- TestBootBeforeDatabase (serve_order_test.go, package user) boots through newServeOrderEnv. First party.Activate(app, golem15.user) runs with no database published; then lagoon.Publish, attach.Publish, lagoon.Migrate and surf.Assemble follow, which is the serve command's order (per D-03).
- At the hook point between Activate and Publish: app.Lookup for *gorm.DB is not ok (the order is real), app.Lookup[bouncer.BlacklistStore]() is not ok, and the test hook has not run.
- After Publish, the published bouncer.BlacklistStore is a *bouncer.PostgresBlacklist (the real store, not the wrapper; per D-01 and D-02), and the test hook ran with exactly e.gdb, which shows RegisterHooks ran on Publish.
- e.sessionLogin(t, "serve-order") returns a token. e.guarded answers 200 with the bearer header, and also with each name from classes.SessionCookieNames() as the only carrier.
- POST /logout with the bearer satisfies assertLoggedOut. Then e.assertSessionEnded(t, token) passes: jwt.auth answers 401 through the bearer, token and auth_token carriers, /fetch answers 401 and /refresh answers blacklistedBody. jwt_blacklist has exactly 1 row for the token's jti (from parseToken).
- RED at 8e4b863: the test fails at the store-after-Publish assertion, because Boot saw no database and never published a store.
</behavior>
<action>
RED. In admin_harness_test.go, move the config block of newAdminEnv into adminEnvConfig(t *testing.T) *compass.Config without changing it: the temp dir with app.yaml, compass.Open with the three environ entries, and the cfg.Set loop. newAdminEnv then calls adminEnvConfig and keeps its own order (adminHarnessDB first, Publish before Activate) unchanged. Add newServeOrderEnv(t *testing.T, beforePublish func(*backpack.App)) *adminEnv after newAdminEnv (per QD-4), in this order:
- adminHarnessDB(t) first, so the test skips under -short.
- backpack.New(adminEnvConfig(t)), then publish the mailCapture logger.
- party.Activate(app, []string{"golem15.user"}).
- beforePublish(app) when it is non-nil.
- lagoon.Publish(app, sqlDB, gdb).
- attach.Publish with a memblob bucket closed in t.Cleanup.
- lagoon.Migrate(gdb, plugins), then surf.Assemble.
It returns an adminEnv with the same fields newAdminEnv fills. Its doc comment says it boots like surf's serve command after the generated main's party.Activate, and that Migrate is there only for a harness database that is not migrated yet.
Write serve_order_test.go with TestBootBeforeDatabase as the behavior block describes. The doc comment says it pins logout revocation when Boot runs before the database is published. The test hook is set up before newServeOrderEnv (per QD-3):
- an atomic.Pointer[gorm.DB] for the handle and an atomic.Bool set to true, which t.Cleanup sets back to false;
- a hook registered through classes.RegisterHook that stores its *gorm.DB argument only while the Bool is true and always returns nil;
- a comment saying the registrant list is process-global, which is why the hook is gated.
The beforePublish callback makes the three not-published assertions with t.Fatal. Read the jti with parseToken(t, token)["jti"] and count rows with e.gdb.Raw(SELECT COUNT(*) FROM jwt_blacklist WHERE jti = ?). Run the test. It must fail against the unchanged plugin.go; record the failure line for the SUMMARY. Do not commit a red test: go test stays green at every commit, and the single commit comes at the end of Task 2.
GREEN, per D-01 and QD-1/QD-5. Create blacklist.go (package user) with the unexported type appBlacklist struct { app *backpack.App } and the compile-time assertion var _ bouncer.BlacklistStore = (*appBlacklist)(nil). A helper method store() returns the bouncer.BlacklistStore published on b.app. It returns nil in three cases: nothing is published, the published value is nil, or the published value is itself an *appBlacklist.
- IsBlacklisted: with no store, false and nil; otherwise the store's result and error, unchanged.
- Add and Sweep: with no store, nil; otherwise they delegate and return the store's error.
The doc comment explains why: the jwt guard is built in Boot, before serve publishes the database, so the store is resolved per call; the type must never be published itself.
GREEN, per D-02 and QD-6. In plugin.go Boot, keep JWTSecret first. Remove the RegisterHooks branch and the whole blacklist block: the direct *sql.DB and *gorm.DB lookups, the local blacklist variable, its Publish and the sweep start. At the position where RegisterHooks ran, add one call that returns its error: lagoon.OnDatabase(app, func(sqlDB *sql.DB, gdb *gorm.DB) error { ... }). The callback:
- runs classes.RegisterHooks(gdb) and returns its error;
- builds store := bouncer.NewPostgresBlacklist(sqlDB, "jwt_blacklist");
- calls app.Publish[bouncer.BlacklistStore](store) and returns its error;
- calls p.startBlacklistSweep(store) and returns nil.
It uses Boot's app parameter, never p.app. Put a one- or two-line comment above the call saying that serve publishes the database after Boot, so this runs on lagoon.Publish, or at once when the database is already published. Comments must not quote the removed code.
Change the jwt registration to reg.Register(p.ID(), "jwt", bouncer.NewJWTGuard(secret, classes.GormUsers{App: app}, &appBlacklist{app: app}, classes.SessionCookieNames()...)). Keep the registry lookup-or-publish, the api_token guard, RegisterUserAuthorizer, startBlacklistSweep (QD-2), withDB, Middlewares and the import set (database/sql and gorm stay used) as they are. gofmt both files.
Run the verify command. If an existing test fails because it relied on Boot publishing a store from a published *sql.DB without a *gorm.DB, stop and report it; planning found no such test. A failure unrelated to this change is not patched here: stop and report it.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l plugin.go blacklist.go admin_harness_test.go serve_order_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run '^(TestBootBeforeDatabase|TestLogoutEndsTheSession|TestSessionRoutesAcceptCookies|TestLogin|TestLoginRouteGroup|TestLoginBlacklistSweep)$' . && grep -qF 'lagoon.OnDatabase(app, func(' plugin.go && grep -qF '&appBlacklist{app: app}' plugin.go && grep -qF 'classes.SessionCookieNames()...)' plugin.go && grep -qF 'Publish[bouncer.BlacklistStore](store)' plugin.go && test "$(grep -v '^[[:space:]]*//' plugin.go | grep -cF '"auth_token"')" = 0 && test "$(grep -v '^[[:space:]]*//' plugin.go | grep -cF 'Lookup[*sql.DB]')" = 0 && test "$(grep -v '^[[:space:]]*//' plugin.go | grep -cF 'Lookup[*gorm.DB]')" = 1 && test "$(grep -v '^[[:space:]]*//' plugin.go | grep -cF '"jwt", bouncer.NewJWTGuard')" = 1 && grep -qF 'type appBlacklist struct' blacklist.go && grep -qF 'func newServeOrderEnv' admin_harness_test.go && grep -qF 'func adminEnvConfig' admin_harness_test.go && grep -qF 'func TestBootBeforeDatabase' serve_order_test.go</automated>
</verify>
<done>TestBootBeforeDatabase failed at 8e4b863 (failure line recorded) and now passes. It proves three things: nothing is published before Publish, the real Postgres store and the GORM hooks are installed when lagoon.Publish runs, and a token ended by logout gets 401 on jwt.auth through every carrier, at /fetch and at /refresh, with its jwt_blacklist row. Boot registers the jwt guard once with appBlacklist and classes.SessionCookieNames(), and the direct database lookups are gone from Boot. TestLogoutEndsTheSession, TestSessionRoutesAcceptCookies and the TestLogin* tests stay green. Nothing is committed yet.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: pin the lazy store without Docker, document the wiring, run every suite and commit in sm-user-plugin</name>
<files>../sm-demo-app/plugins/golem15/user/blacklist_test.go, ../sm-demo-app/plugins/golem15/user/README.md</files>
<precondition>Task 1's verify passed and the plugin tree holds only Task 1's four files as changes (git -C ../sm-demo-app/plugins/golem15/user status --short lists exactly plugin.go, admin_harness_test.go, blacklist.go and serve_order_test.go).</precondition>
<behavior>
- TestAppBlacklist (blacklist_test.go, package user) runs under -short with no Docker. Each app comes from sessionUserApp(t, "SUMMER_GOLEM15__USER__JWT__SECRET="+sessionSecret).
- No store published: IsBlacklisted returns (false, nil); Add and Sweep return nil (per D-01).
- A second app with an appBlacklist published as its bouncer.BlacklistStore: the same no-op answers come back, and the calls return instead of recursing (QD-5).
- A bouncer.NewMemoryBlacklist published: Add through the wrapper with a future expiresAt and validUntil makes the memory store itself report the jti blacklisted (the call is delegated, not copied); the wrapper's IsBlacklisted reports true for that jti and false for another jti.
- failingBlacklist published: IsBlacklisted, Add and Sweep each return an error for which errors.Is(err, errBlacklistDown) holds, so an unreachable table still fails closed through the guard.
</behavior>
<action>
Write blacklist_test.go with TestAppBlacklist as the behavior block describes. Reuse sessionUserApp, sessionSecret, failingBlacklist and errBlacklistDown from the package's existing test files, and use t.Context(). Run it with -short; it must pass against Task 1's blacklist.go. If it exposes a bug in appBlacklist, fix blacklist.go here.
README.md, in the same commit (CLAUDE.md documentation rule; no exported API changes, so only behaviour text):
- In the JWT-sessions bullet (line 20), after the sentence on Boot registering the `jwt` guard and exposing `jwt.auth`, add this. The guard reads the session cookies `classes.SessionCookieNames()` lists and resolves the published `bouncer.BlacklistStore` on every request. Boot installs the plugin's GORM hooks (`classes.RegisterHooks`), publishes the Postgres `jwt_blacklist` store (`bouncer.NewPostgresBlacklist`) and starts the sweep through `lagoon.OnDatabase`. Under `summer serve`, which publishes the database after Boot, they take effect when `lagoon.Publish` runs, before the router is built; when the database is already published they take effect at once. While no store is published, no token counts as blacklisted. Change "A background sweep prunes the blacklist." only if the new text makes it redundant.
- Do not name the unexported wrapper type in the README; describe the behaviour only.
- In the Testing section, after the TestLogoutEndsTheSession paragraph, add a paragraph covering two tests. `TestBootBeforeDatabase` boots in the serve order (`party.Activate` with no database, then `lagoon.Publish`, through `newServeOrderEnv` in `admin_harness_test.go`). It checks that the blacklist store and the GORM hooks are installed on Publish and not before, and that a token ended by `POST /logout` is refused on a `jwt.auth` route through every carrier, at `/fetch` and at `/refresh`, with its `jwt_blacklist` row. `TestAppBlacklist` (in `-short`) covers the guard's per-request store lookup: no store, delegation and a failing store.
Run go vet, then go test -short, then the full Docker-backed suite of the plugin.
Consumer cross-check, read-only: from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app run go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/... . go.work replaces sm-user-plugin with this checkout, and their harnesses publish the database before Activate, which exercises the immediate OnDatabase path. Record the result in the SUMMARY. If a failure names the user plugin's Boot, the jwt guard, bouncer.BlacklistStore or jwt_blacklist, stop and fix it in this task. Record any other failure as unrelated; do not patch those repos. Do not stage anything in sm-demo-app.
Commit in the plugin repo only, staging by path:
git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user add plugin.go blacklist.go blacklist_test.go serve_order_test.go admin_harness_test.go README.md
Then git -C <same path> commit with this subject:
fix: logout revokes the session under serve: the jwt blacklist and GORM hooks are wired when the database is published
In the body, two short paragraphs: Boot runs before serve publishes the database, so the store, hooks and sweep now go through lagoon.OnDatabase, and the guard resolves the store per request; the jwt guard reads classes.SessionCookieNames(). Add no trailer of any kind; the user's global CLAUDE.md forbids co-author tags and overrides any harness attribution reminder. Do not push, tag or bump the sm-demo-app pointer (v0.5.0 release hold). Record the short SHA, the base commit and the test results in the SUMMARY for the orchestrator's G4 entry.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l blacklist_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -short -count=1 ./... && GOWORK=off go test -short -count=1 -run '^TestAppBlacklist$' . && GOWORK=off go test -count=1 ./... && grep -qF 'lagoon.OnDatabase' README.md && grep -qF 'TestBootBeforeDatabase' README.md && grep -qF 'TestAppBlacklist' README.md && test -z "$(git status --short)" && C=$(git log -1 --format=%H --fixed-strings --grep='wired when the database is published' master) && test -n "$C" && S=$(git log -1 --format=%s "$C") && grep -qF 'wired when the database is published' <<<"$S" && B=$(git log -1 --format=%b "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet "$C^" "$C" -- go.mod go.sum && N=$(git diff --name-only "$C^" "$C") && test "$(sort <<<"$N" | tr '\n' ' ')" = "README.md admin_harness_test.go blacklist.go blacklist_test.go plugin.go serve_order_test.go " && test -z "$(git tag --points-at "$C")" && R=$(git branch -r --contains "$C") && test -z "$R"</automated>
</verify>
<done>TestAppBlacklist passes under -short. The plugin's go vet, go test -short and full Docker-backed go test are green. The sociallogin and oauthserver cross-check result is recorded. sm-user-plugin master has one new fix commit (plugin.go, blacklist.go, blacklist_test.go, serve_order_test.go, admin_harness_test.go, README.md) with no trailer, go.mod and go.sum unchanged, not on any remote branch and untagged. The tree is clean. sm-demo-app and summercms.go are untouched. The SUMMARY gives the SHA and base for the orchestrator.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| browser/API client to jwt.auth | an untrusted bearer or cookie token is checked against the revocation list |
| plugin Boot to serve startup | revocation state exists only after the database is published; Boot runs earlier |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-usi-01 | Elevation of privilege | jwt.auth guard after POST /logout under serve (a logged-out or stolen token keeps working) | high | mitigate | The OnDatabase callback publishes the Postgres store on lagoon.Publish, so EndSession writes the row, and the guard's appBlacklist reads it per request. TestBootBeforeDatabase pins the 401 through every carrier and the jwt_blacklist row in the serve order. |
| T-usi-02 | Elevation of privilege | appBlacklist while no store is published (before Publish, console commands) | low | accept | serve publishes the database before BuildRouter and listen, so no HTTP request is served without the store. Console commands serve no HTTP. This matches today's nil-store behaviour. |
| T-usi-03 | Denial of service | appBlacklist recursion if the wrapper itself were published | low | mitigate | store() treats a published *appBlacklist as no store; Boot publishes only the *bouncer.PostgresBlacklist; TestAppBlacklist and TestBootBeforeDatabase (type assertion) pin both. |
| T-usi-04 | Spoofing | blacklist table unreachable (IsBlacklisted error) | medium | mitigate | appBlacklist returns the store's error unchanged, so bouncer's guard answers 401 "Authentication error" (fail closed, as today). TestAppBlacklist pins the pass-through. |
| T-usi-SC | Tampering | npm/pip/cargo/Go module installs | low | accept | No dependency is added: go.mod and go.sum are unchanged (Task 2 verify checks it). No package-legitimacy checkpoint is needed. |
</threat_model>
<verification>
- sm-user-plugin: GOWORK=off go vet ./..., GOWORK=off go test -short -count=1 ./... and GOWORK=off go test -count=1 ./... are green at the fix commit.
- TestBootBeforeDatabase was red at 8e4b863 and is green at the fix commit.
- The sociallogin and oauthserver suites, run through sm-demo-app's go.work against this checkout, have their result recorded in the SUMMARY.
- One local commit on sm-user-plugin master: no trailer, not pushed, not tagged. The sm-demo-app pointer is unchanged and summercms.go is unmodified.
</verification>
<success_criteria>
- Under the serve boot order, logout revokes the session: jwt.auth answers 401 for the logged-out token through the bearer header and both cookies, and the jwt_blacklist row exists.
- The plugin's GORM hooks, blacklist store and sweep are wired exactly once through lagoon.OnDatabase, whether the database is published before or after Boot.
- The jwt guard is registered once, with classes.SessionCookieNames() and a store resolved per request.
- The README describes the wiring and names both new tests.
</success_criteria>
<output>
Create `.planning/quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/261022-usi-SUMMARY.md` in summercms.go when done. Include the plugin commit's short SHA and base, the RED failure line, the suite results, the consumer cross-check result, and a confirmation that nothing was pushed, tagged or pointer-bumped. Do not commit the SUMMARY; the orchestrator commits planning docs.
</output>

View File

@@ -0,0 +1,102 @@
---
phase: quick-261022-usi
plan: 01
quick_id: 261022-usi
subsystem: sm-user-plugin (golem15.user)
status: complete
tags: [user-plugin, jwt, blacklist, logout, lagoon.OnDatabase, serve-order, G4, G3-leftover]
requires: [lagoon.OnDatabase, bouncer.NewPostgresBlacklist, classes.SessionCookieNames]
provides:
- "Boot wires classes.RegisterHooks, the Postgres jwt_blacklist store and its sweep through one lagoon.OnDatabase call"
- "appBlacklist: plugin-local bouncer.BlacklistStore resolving the published store per call"
- "jwt guard reads classes.SessionCookieNames()"
affects: [sm-sociallogin-plugin and sm-oauthserver-plugin harnesses (immediate OnDatabase path, green)]
tech-stack:
added: []
patterns: ["lagoon.OnDatabase from Boot for database-dependent wiring", "lazy per-call service lookup for guards built in Boot"]
key-files:
created:
- ../sm-demo-app/plugins/golem15/user/blacklist.go
- ../sm-demo-app/plugins/golem15/user/blacklist_test.go
- ../sm-demo-app/plugins/golem15/user/serve_order_test.go
modified:
- ../sm-demo-app/plugins/golem15/user/plugin.go
- ../sm-demo-app/plugins/golem15/user/admin_harness_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
decisions:
- "User plugin Boot wires RegisterHooks, the jwt_blacklist store and its sweep through lagoon.OnDatabase; the jwt guard is registered once with a lazy store that resolves the published bouncer.BlacklistStore per request (G4)"
metrics:
duration: ~10 min
completed: 2026-10-22
actuals:
tokens: 5533 # chars/4 over the realized plugin diff (git show 4bf44fc)
tasks: 2
commits: 1 # measured in sm-user-plugin: git rev-list --count 8e4b863..4bf44fc
plan_head_before: 8e4b863 # sm-user-plugin master (not summercms.go)
plan_head_after: 4bf44fc # sm-user-plugin master (not summercms.go)
---
# Quick 261022-usi: user-plugin jwt blacklist and hooks wired via lagoon.OnDatabase Summary
Under `summer serve` (party.Activate before lagoon.Publish) POST /logout now revokes the session: the user plugin's Boot wires the GORM hooks, the Postgres `jwt_blacklist` store and its sweep through `lagoon.OnDatabase`, and the jwt guard resolves the published store on every request through an unexported `appBlacklist`; the guard also reads `classes.SessionCookieNames()` (G3 leftover).
## Commit (sm-user-plugin)
- Repo: `/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user`, branch `master`
- Base: `8e4b863` (master had not moved; `git log 8e4b863..master` was empty before the commit)
- Fix commit: **`4bf44fc`** `fix: logout revokes the session under serve: the jwt blacklist and GORM hooks are wired when the database is published`
- Files: plugin.go, blacklist.go, blacklist_test.go, serve_order_test.go, admin_harness_test.go, README.md. go.mod/go.sum unchanged. No trailer.
- Not pushed, not tagged, not on any remote branch. sm-demo-app: nothing staged or committed (its `main.go` and `plugins/golem15/user` pointer were already dirty from another session and were left as they were). summercms.go: not modified (only this SUMMARY, uncommitted).
## RED at base
`TestBootBeforeDatabase` against the unchanged plugin.go (8e4b863):
```
--- FAIL: TestBootBeforeDatabase (4.50s)
serve_order_test.go:48: no bouncer.BlacklistStore published after lagoon.Publish
```
The not-published-before-Publish assertions passed; the store-after-Publish assertion failed because Boot saw no database and never published a store.
## What changed
- **plugin.go Boot:** the direct `*gorm.DB`/`*sql.DB` lookups, the local blacklist, its Publish and the sweep start are gone. One `lagoon.OnDatabase(app, func(sqlDB, gdb) error {...})` call (at the position RegisterHooks used to run, using Boot's `app`) runs `classes.RegisterHooks(gdb)`, publishes `bouncer.NewPostgresBlacklist(sqlDB, "jwt_blacklist")` as `bouncer.BlacklistStore` and calls `p.startBlacklistSweep(store)`; Boot returns OnDatabase's error. The jwt guard: `bouncer.NewJWTGuard(secret, classes.GormUsers{App: app}, &appBlacklist{app: app}, classes.SessionCookieNames()...)`. `withDB` keeps its own `*gorm.DB` lookup (console commands).
- **blacklist.go:** `appBlacklist{app}`; `store()` returns nil when nothing/nil is published or the published value is itself an `*appBlacklist`. With no store: IsBlacklisted `(false, nil)`, Add/Sweep `nil`. Otherwise it delegates and returns the store's error unchanged (guard still fails closed).
- **admin_harness_test.go:** `adminEnvConfig(t)` extracted unchanged from newAdminEnv; `newServeOrderEnv(t, beforePublish)` boots Activate → hook point → lagoon.Publish → attach.Publish → lagoon.Migrate → surf.Assemble.
- **serve_order_test.go:** `TestBootBeforeDatabase` (Docker; skips under -short) with a gated `classes.RegisterHook` test hook (atomic.Bool cleared in t.Cleanup).
- **blacklist_test.go:** `TestAppBlacklist` (-short): no store, wrapper-published-as-store (no recursion), delegation to a MemoryBlacklist, failingBlacklist error pass-through.
- **README.md:** JWT-sessions bullet describes the OnDatabase wiring, the per-request store and the cookie list (the separate "A background sweep prunes the blacklist." sentence folded into the new text); Testing names both new tests.
## Test results (sm-user-plugin, GOWORK=off, at 4bf44fc's tree)
- `gofmt -l` clean; `go vet ./...` clean.
- Task 1 targeted run (TestBootBeforeDatabase, TestLogoutEndsTheSession, TestSessionRoutesAcceptCookies, TestLogin, TestLoginRouteGroup, TestLoginBlacklistSweep): ok.
- `go test -short -count=1 ./...`: ok (root, classes, models, updates).
- `go test -short -run '^TestAppBlacklist$'`: PASS, 4 subtests.
- `go test -count=1 ./...` (Docker, direct socket access, no sudo needed): ok (root 46.3s, classes 40.1s, models, updates).
## Consumer cross-check (read-only, from sm-demo-app via go.work)
`go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/...`:
- Failing, unrelated to this change: `TestPHPMethodMap` in both plugins and `TestClientRegistry/verify_secret_uses_constant_time_comparison` in oauthserver. They read source files at sibling paths (`../fonoteka.go/plugins/golem15/user`, `../summercms.go/modules/wristband/...`) that do not exist relative to the sm-demo-app mount (`lstat ... no such file or directory`). None names the user plugin's Boot, the jwt guard, bouncer.BlacklistStore or jwt_blacklist.
- With those two tests skipped (`-skip '^(TestPHPMethodMap|TestClientRegistry)$'`): sociallogin ok (27.6s), oauthserver ok (73.9s). All other TestClientRegistry subtests pass. These harnesses publish the database before Activate, so they exercise the immediate OnDatabase path.
## Deviations from Plan
1. **[Rule 1 - test plan detail] TestAppBlacklist delegation uses `validUntil = now`, not a future validUntil.** `bouncer.MemoryBlacklist.IsBlacklisted` reports true only once `validUntil` has been reached (the grace window), so a future validUntil would never show as blacklisted. The test adds with `expiresAt = now+1h, validUntil = now`.
2. **Task 2 verify command is locale-dependent.** Its `sort <<<"$N"` under `LANG=en_US.UTF-8` orders `README.md` between `plugin.go` and `serve_order_test.go`, so the file-list comparison failed although the file set is exactly the planned six. Every check passes under `LC_ALL=C` (VERIFY2-OK). No code impact.
3. **Protected-branch commit.** The plan directs the commit onto sm-user-plugin `master` (core plugin repos commit on master per the project's workflow); the executor's default-branch assertion was not applied there, as instructed by the orchestrator.
## Known Stubs
None.
## Threat Flags
None. T-usi-01 (logged-out token keeps working under serve) and T-usi-03/T-usi-04 are mitigated and pinned by TestBootBeforeDatabase and TestAppBlacklist; no new endpoints or trust-boundary surface.
## Self-Check: PASSED
- FOUND: blacklist.go, blacklist_test.go, serve_order_test.go in the plugin checkout
- FOUND: commit 4bf44fc on sm-user-plugin master; plugin tree clean

View File

@@ -0,0 +1,111 @@
---
phase: quick-261022-usi
verified: 2026-10-22T22:40:00Z
status: passed
score: 5/5 must-haves verified
covered_files:
- .planning/quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/261022-usi-CONTEXT.md
- .planning/quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/261022-usi-PLAN.md
- .planning/quick/261022-usi-user-plugin-jwt-blacklist-and-hooks-wire/261022-usi-SUMMARY.md
covered_digest: "v2:sha256:f92f6387937ba08414cea64a81de2af21a7973621075f979546f97c321d8defd"
# The implementation lives in sm-user-plugin (outside this project root), so the
# fingerprint tool refuses those paths. The code is pinned by commit 4bf44fc
# (base 8e4b863) at sm-demo-app/plugins/golem15/user.
code_commit: 4bf44fc
code_base: 8e4b863
behavior_unverified: 0
overrides_applied: 0
---
# Quick 261022-usi: user-plugin jwt blacklist and hooks wired via lagoon.OnDatabase: Verification Report
**Goal:** Under serve, the user plugin's Boot runs before lagoon.Publish, so the jwt blacklist was never wired and logout did not revoke the token. The fix wires BlacklistStore and RegisterHooks through lagoon.OnDatabase and tests Activate-then-Publish. The jwt guard now passes classes.SessionCookieNames() instead of the hardcoded token/auth_token names.
**Verified:** 2026-10-22
**Status:** passed
**Re-verification:** No (initial verification)
**Code under test:** sm-user-plugin `4bf44fc` (base `8e4b863`), `/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user`, run with `GOWORK=off`. `go.mod` replaces summercms with the `summercms.go` working tree.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | Booted in serve order (Activate with no DB, then lagoon.Publish, then router), a token ended by POST /logout gets 401 on jwt.auth through the bearer header and each session cookie, at /fetch and /refresh, and jwt_blacklist holds one row for its jti | VERIFIED | Verifier ran `go test -count=1 -run '^TestBootBeforeDatabase$'` (Docker): `--- PASS: TestBootBeforeDatabase (4.53s)`. The test boots through `newServeOrderEnv` (Activate, then the beforePublish hook, then lagoon.Publish, attach.Publish, Migrate, surf.Assemble). It checks 200 before logout for the bearer and every `classes.SessionCookieNames()` cookie, then `assertLoggedOut` and `assertSessionEnded` (401 on jwt.auth via bearer/token/auth_token, 401 at /fetch via bearer and both cookies, refresh = blacklistedBody via all three). `SELECT COUNT(*) FROM jwt_blacklist WHERE jti = ?` == 1. **RED reproduced independently:** the base 8e4b863 tree plus the new test/harness files, in a scratch copy, gives `serve_order_test.go:48: no bouncer.BlacklistStore published after lagoon.Publish`. |
| 2 | Before Publish no BlacklistStore is published and the hooks have not run; on Publish, RegisterHooks runs with the published *gorm.DB, a *bouncer.PostgresBlacklist on jwt_blacklist is published as BlacklistStore, and the sweep starts | VERIFIED | TestBootBeforeDatabase's beforePublish asserts no *gorm.DB, no BlacklistStore and no hook call. After Publish it asserts `store.(*bouncer.PostgresBlacklist)` and `hooked.Load() == e.gdb` (pointer identity with the published handle). plugin.go:76-87: the callback runs `classes.RegisterHooks(gdb)`, then `NewPostgresBlacklist(sqlDB, "jwt_blacklist")` and `Publish`, then `p.startBlacklistSweep(store)`, then returns nil. lagoon.Publish (connection.go:175) returns the callback's error. So a successful Publish plus a published store means startBlacklistSweep was reached. The sweep goroutine itself is covered by TestLoginBlacklistSweep (green in the full suite). |
| 3 | Boot registers the jwt guard exactly once, with or without a DB, with classes.SessionCookieNames() and a plugin-local store resolved per call. Without a store: not blacklisted, Add/Sweep do nothing. Store errors pass through. The wrapper is never published | VERIFIED | plugin.go:96 is the only non-comment `"jwt", bouncer.NewJWTGuard` line (count 1). It sits outside the OnDatabase callback and passes `&appBlacklist{app: app}, classes.SessionCookieNames()...`. No `"auth_token"` literal is left in plugin.go code (count 0). blacklist.go: `store()` returns nil when nothing or nil is published, or when the published value is an `*appBlacklist`. The methods delegate and return the store's error unchanged. The only `Publish[bouncer.BlacklistStore]` in non-test code publishes the PostgresBlacklist (plugin.go:81). `TestAppBlacklist` with -short passes all 4 subtests: no store, wrapper published as store (no recursion), delegation to MemoryBlacklist, failingBlacklist `errors.Is(errBlacklistDown)` for all three methods. TestLoginRouteGroup (boot without DB) is green. |
| 4 | When the DB is published before Boot (plugin tests, sociallogin/oauthserver harnesses), hooks, store and sweep are wired synchronously in Boot and existing suites stay green unchanged | VERIFIED | lagoon/ondatabase.go:36-43: OnDatabase calls fn immediately when a *gorm.DB is published, and Boot returns that error. newAdminEnv is unchanged in order (Publish before Activate); only its config block moved into `adminEnvConfig`. The full Docker suite is green (root 48.7s, classes 46.6s, models, updates), including TestLogin, TestLoginBlacklistSweep and TestLogoutEndsTheSession. Consumer cross-check (sm-demo-app go.work): the only failures are TestPHPMethodMap in both plugins and TestClientRegistry/verify_secret_uses_constant_time_comparison. All of them fail on `lstat`/`open` of sibling source paths (`../fonoteka.go/...`, `../summercms.go/modules/wristband/...`) that do not resolve from the sm-demo-app mount. They are unrelated to Boot, the guard or the blacklist, as the SUMMARY reports. |
| 5 | go vet, go test -short and the full Docker go test pass at one fix commit on sm-user-plugin master. Nothing pushed or tagged, sm-demo-app pointer not bumped, summercms.go not modified | VERIFIED | Verifier runs: `gofmt -l .` empty; `go vet ./...` OK; `go test -short -count=1 ./...` ok; `go test -count=1 ./...` ok. `git log 8e4b863..master` = one commit, 4bf44fc. It touches exactly README.md, admin_harness_test.go, blacklist.go, blacklist_test.go, plugin.go and serve_order_test.go; go.mod and go.sum are untouched. `git branch -r --contains 4bf44fc` is empty, `git tag --points-at 4bf44fc` is empty, there is no Co-authored-by trailer, and the plugin tree is clean. sm-demo-app HEAD still records `plugins/golem15/user` at 930b158 (its working-tree pointer change belongs to another session and was not staged). summercms.go `git status`: only planning/state files, no code changes. |
**Score:** 5/5 truths verified (0 present, behavior-unverified)
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `plugin.go` | Boot wires hooks, store and sweep through one lagoon.OnDatabase call; guard gets the lazy store and SessionCookieNames | VERIFIED | contains `lagoon.OnDatabase(app, func(`; the closure uses Boot's `app`; direct `Lookup[*sql.DB]` is gone from Boot (count 0); the one remaining `Lookup[*gorm.DB]` is in `withDB` (console commands) |
| `blacklist.go` | `type appBlacklist struct`, unexported BlacklistStore resolving per call | VERIFIED | 61 lines, compile-time interface assertion, recursion guard |
| `admin_harness_test.go` | `adminEnvConfig` + `newServeOrderEnv` | VERIFIED | serve-order boot mirrors surf/serve.go:70-88 (Publish, uploads, router) |
| `serve_order_test.go` | `TestBootBeforeDatabase` (Docker, skips under -short through adminHarnessDB) | VERIFIED | passes; RED at base reproduced |
| `blacklist_test.go` | `TestAppBlacklist` (-short) | VERIFIED | 4/4 subtests pass |
| `README.md` | JWT-sessions bullet documents the OnDatabase wiring; Testing names both tests | VERIFIED | both test names present; the unexported wrapper type is not named (0 hits) |
### Key Link Verification
| From | To | Via | Status | Details |
|------|----|-----|--------|---------|
| plugin.go Boot | lagoon.OnDatabase / lagoon.Publish -> runDatabaseHooks | callback queued in Boot, drained by Publish before BuildRouter | WIRED | ondatabase.go queues when no *gorm.DB is published; connection.go:175 drains; serve.go publishes before BuildRouter |
| jwt guard registration | appBlacklist.store | `&appBlacklist{app: app}` | WIRED | per-call `app.Lookup[bouncer.BlacklistStore]()` |
| jwt guard registration | classes.SessionCookieNames | `classes.SessionCookieNames()...)` | WIRED | the same list is used by SessionToken/EndSession |
| EndSession (POST /logout) | store published by the callback | request-time lookup (session_user.go:123) | WIRED | the jwt_blacklist row count of 1 in TestBootBeforeDatabase proves the write path end to end |
### Data-Flow Trace (Level 4)
| Artifact | Data | Source | Real data | Status |
|----------|------|--------|-----------|--------|
| jwt guard blacklist check | jti revocation | Postgres `jwt_blacklist` via the PostgresBlacklist published on Publish | Yes (row asserted in a testcontainers Postgres) | FLOWING |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Serve-order logout revocation | `GOWORK=off go test -count=1 -run '^TestBootBeforeDatabase$' .` | PASS (4.53s) | PASS |
| Same test at base 8e4b863 (scratch copy) | same | FAIL `serve_order_test.go:48: no bouncer.BlacklistStore published after lagoon.Publish` | PASS (RED confirmed) |
| Lazy store contract | `GOWORK=off go test -short -count=1 -v -run '^TestAppBlacklist$' .` | 4/4 PASS | PASS |
| Vet + short suite | `go vet ./... && go test -short -count=1 ./...` | ok | PASS |
| Full Docker suite | `GOWORK=off go test -count=1 ./...` | ok (root 48.7s, classes 46.6s, models, updates) | PASS |
| Consumer cross-check | `go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/...` (sm-demo-app) | only path-based failures, unrelated (lstat/open of sibling repo paths) | PASS (unrelated failures noted) |
### Probe Execution
None declared for this quick task.
### Requirements Coverage
| Requirement | Source Plan | Description | Status | Evidence |
|-------------|-------------|-------------|--------|----------|
| usi-1 (G4 + G3 leftover) | 261022-usi-PLAN | logout revokes under serve; store + hooks through lagoon.OnDatabase; guard reads SessionCookieNames | SATISFIED | Truths 1-5 |
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| (none) | - | TBD/FIXME/XXX/TODO/HACK grep over the six changed files: no hits | - | - |
Info (not gaps):
- `startBlacklistSweep` reads `p.app` (the shared Plugin value) rather than the callback's `app`. In production there is one app per process. This is the same as before the change and was left as is by planner choice QD-2.
- The verify command's locale-dependent `sort` (SUMMARY deviation 2) is a plan-script quirk with no code impact. The file set was confirmed directly with `git diff --name-only`.
- SUMMARY deviation 1 (`validUntil = now` in TestAppBlacklist) is correct: MemoryBlacklist reports a jti only once validUntil is reached, and the test passes.
### Human Verification Required
None.
### Gaps Summary
No gaps. The serve-order regression test fails at the base commit and passes at 4bf44fc. The verifier reproduced both outcomes. The full Docker-backed suite is green, and the commit is local only and complete.
---
_Verified: 2026-10-22_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,327 @@
---
phase: quick-261022-vfz
plan: 01
quick_id: 261022-vfz
slug: user-plugin-login-throttle-via-surf-clie
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- vfz-1 # item 9: POST /login keys its failed-login throttle on surf.ClientIP with http.trusted_proxies (as /register does); exported RemoteIP stays the RemoteAddr host helper with a corrected doc comment
- vfz-2 # item 10: /reset-password and the admin Users password set stamp tokens_valid_after truncated to whole seconds (as RevokeUserAccess does); /change-password and bouncer's comparison unchanged
- vfz-3 # escalation note items 9 and 10 (tracker, verdicts, reply) and the todo's Outcome filled; left uncommitted for the orchestrator
files_modified:
# sm-user-plugin (module git.golem15.com/golem15/sm-user-plugin), worked in the sm-demo-app submodule checkout. Commit there only.
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go
- ../sm-demo-app/plugins/golem15/user/login_client_ip_test.go
- ../sm-demo-app/plugins/golem15/user/same_second_cutoff_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
# summercms.go planning docs, edited by Task 3 and NOT committed (the orchestrator commits docs)
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md
estimate:
tokens: 85000
raw_tokens: 85000
tasks: 3
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "With http.trusted_proxies listing the proxy, five wrong passwords sent through that proxy with X-Forwarded-For 203.0.113.10 leave exactly one user_throttle row for the account, keyed 203.0.113.10, with 5 attempts and suspended; the correct password from 203.0.113.10 then gets the opaque 401, while the correct password from 203.0.113.20 through the same proxy gets 200 and a token."
- "Without http.trusted_proxies (the default), X-Forwarded-For is ignored for the /login throttle: failures from one connection address with a different X-Forwarded-For each time all count on one row keyed on the connection address, and a further forged X-Forwarded-For does not escape that suspension."
- "controllers.RemoteIP keeps its signature and behaviour (the host of r.RemoteAddr); its doc comment no longer says /login uses it."
- "After POST /reset-password and after an administrator sets a password on the Users form, users.tokens_valid_after is a whole second. A session token whose iat is that second is accepted on a jwt.auth route, at /fetch and at /refresh; a token issued one second earlier is refused at all three; and a login right after the reset yields a token that works. email_verified_at is still written by the reset."
- "/change-password still writes iat minus one second, and summercms.go modules/bouncer is unmodified."
- "go vet and the full Docker-backed go test of sm-user-plugin pass at each of two local fix commits on master (throttle first, cutoff second), neither pushed nor tagged; go.mod/go.sum unchanged; the sm-demo-app pointer is not bumped."
- "Escalation note rows 9 and 10 read done (unreleased) with their commit SHA and v0.5.0, their verdicts and reply paragraphs are filled with no TODO left for them, and the todo carries an Outcome section and stays in pending/, all uncommitted."
artifacts:
- path: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
provides: "Login throttle IP from surf.ClientIP with the trusted proxies; reset-password cutoff truncated to the second; RemoteIP doc comment corrected"
contains: "now.Truncate(time.Second)"
- path: ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go
provides: "FormBeforeUpdate stamps TokensValidAfter truncated to the second when the password changes"
contains: "now := time.Now().Truncate(time.Second)"
- path: ../sm-demo-app/plugins/golem15/user/login_client_ip_test.go
provides: "TestLoginThrottleClientIP (Docker, skips under -short) and the adminEnv.loginFrom helper"
contains: "func TestLoginThrottleClientIP"
- path: ../sm-demo-app/plugins/golem15/user/same_second_cutoff_test.go
provides: "TestPasswordCutoffSameSecond (Docker, skips under -short): reset-password and admin password set subtests"
contains: "func TestPasswordCutoffSameSecond"
- path: ../sm-demo-app/plugins/golem15/user/README.md
provides: "Login throttling bullet names the client-address rule and http.trusted_proxies; RemoteIP described as the RemoteAddr host with no proxy handling; Testing names TestLoginThrottleClientIP"
contains: "http.trusted_proxies"
- path: .planning/notes/2026-10-22-external-user-plugin-escalations.md
provides: "rows 9 and 10 done (unreleased) with SHAs, verdicts and reply paragraphs filled"
contains: "done (unreleased)"
- path: .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md
provides: "## Outcome (2026-10-22) section before ## Invoke"
contains: "## Outcome"
key_links:
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (Login)
to: summercms.go modules/surf/clientip.go (ClientIP, TrustedProxies)
via: "ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app))), read per request, feeds RejectIfThrottled, refuseLogin and CheckAndRecordLogin"
pattern: "surf\\.ClientIP\\(r, surf\\.TrustedProxies\\(appConfig\\(app\\)\\)\\)"
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (ResetPassword) and controllers/users_admin_controller.go (FormBeforeUpdate)
to: summercms.go modules/bouncer/jwt.go (issuedBeforeCutoff), controllers/api_controller.go refresh check (:286) and classes/session_user.go RequestUser (:83)
via: "all three compare iat.Before(tokens_valid_after); iat is whole seconds (bouncer.Mint uses jwt.NewNumericDate), so a whole-second cutoff accepts a token minted in the same second"
pattern: "Truncate\\(time\\.Second\\)"
- from: Task 1 and Task 2 commit SHAs (sm-user-plugin master)
to: .planning/notes/2026-10-22-external-user-plugin-escalations.md rows 9 and 10 and reply paragraphs
via: "Task 3 reads each SHA with git log --format=%h --grep on the commit subject"
pattern: "→ v0\\.5\\.0"
---
<objective>
Close external escalation items 9 and 10 in sm-user-plugin.
Item 9: POST /login keys its failed-login throttle on the host of r.RemoteAddr. Behind nginx or Caddy every visitor has the proxy's address, so five wrong passwords lock the account for everyone for 15 minutes. /register and the user-api rate limit already use surf.ClientIP with http.trusted_proxies. /login will do the same. The same `ip` variable also feeds RejectIfThrottled and refuseLogin (G2's activation refusal), so one assignment fixes all three. Exported controllers.RemoteIP stays as the RemoteAddr host helper (social_hooks_test uses it, and it is public API of a core plugin). Only its doc comment changes.
Item 10: JWT iat is whole seconds. Every cutoff check is iat.Before(tokens_valid_after). RevokeUserAccess already stamps the cutoff truncated to the second. /reset-password and the admin Users password set stamp sub-second time, so a token minted later in the same second is refused, intermittently. Both writers will truncate down. /change-password (iat minus one second) and bouncer's comparison stay as they are.
Purpose: one attacker behind a shared proxy cannot lock everyone else out of an account, and a login right after a password reset no longer gets 401 at random.
Output: two local fix commits on sm-user-plugin master (one logical change each, per CLAUDE.md), made in /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user with git -C. Then the escalation note and the todo in summercms.go are filled and left uncommitted. No push, no tag and no sm-demo-app pointer bump, because of the SummerCMS v0.5.0 release hold. summercms.go code (modules/bouncer, modules/surf) is not modified.
Planner's choices (quick task, no CONTEXT.md; the executor does not revisit them):
- QD-1 Two commits, not one. CLAUDE.md says one logical change per commit, and the throttle key and the cutoff precision are separate fixes. Each escalation row and reply paragraph then names its own SHA.
- QD-2 /login uses exactly /register's expression, surf.ClientIP(r, surf.TrustedProxies(appConfig(app))), read per request, so a config value set after Boot (as the harness's configure functions do) applies. The unexported remoteIP stays because RemoteIP still calls it.
- QD-3 In /reset-password only the tokens_valid_after value is truncated (now.Truncate(time.Second), inline in the Updates map). email_verified_at keeps `now` (D-27 address proof, sub-second precision is harmless there). In FormBeforeUpdate, `now` feeds only TokensValidAfter, so the assignment itself becomes time.Now().Truncate(time.Second).
- QD-4 The tests go through the real router (newAdminEnv: surf.Assemble with the jwt guard, the user-api limiter and the admin API), so the throttle test sees the request as nginx would deliver it and the cutoff test covers all three comparison sites (bouncer's jwt guard on GET /tokens, /fetch, /refresh). The same-second proof is deterministic: the stored cutoff is checked to be a whole second, and tokens are crafted with iat equal to the cutoff (accepted) and one second earlier (refused) using userAudienceToken. A real login right after the reset is also checked, after aligning to a fresh second, but whether it falls in the same second is only logged, never asserted, because a slow run would make that flaky.
- QD-5 README: only behaviour that names the /login throttle key changes: the Login throttling bullet, the RemoteIP clause, and one Testing paragraph in the throttle commit. The cutoff commit touches no README text. No documented behaviour states the reset cutoff's precision; the RevokeUserAccess entry already says "before the current second".
Source coverage audit:
| Source | Item | Covered by |
|--------|------|------------|
| GOAL / todo Solution | /login throttle IP = surf.ClientIP with trusted proxies, same as /register | Task 1 |
| todo Solution | refuseLogin records the same ip (one assignment) | Task 1 (same `ip` variable; TestLoginThrottleClientIP counts refusals on the XFF row) |
| todo Solution | exported RemoteIP stays; doc comment no longer claims /login | Task 1 |
| todo Solution | /reset-password and admin password set truncate the cutoff; change-password and bouncer untouched | Task 2 (code + grep gates + bouncer diff check) |
| todo Tests | XFF behind a trusted proxy is the /login throttle key | Task 1 TestLoginThrottleClientIP |
| todo Tests | reset (and admin password set) then a same-second token succeeds | Task 2 TestPasswordCutoffSameSecond |
| todo / orchestrator | hold push/tag (v0.5.0); base 4bf44fc | Tasks 1-2 commit gates |
| orchestrator | fill items 9 and 10 (tracker, reply), todo Outcome, stays in pending, not committed | Task 3 |
| orchestrator | README only if the throttle key is documented | Task 1 (it is: README :23 and :183) |
| REQ / RESEARCH / CONTEXT | none (quick task, no research, no discuss) | n/a |
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@CLAUDE.md
@.planning/STATE.md
@.planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md
@.planning/notes/2026-10-22-external-user-plugin-escalations.md
@../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
@modules/surf/clientip.go
Working copies (observed at planning time, 2026-10-22):
- sm-user-plugin is at ../sm-demo-app/plugins/golem15/user (absolute /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user). Branch master at 4bf44fc (G4), 3 ahead of origin/master, working tree clean, no tag on HEAD. Do not fetch, merge, rebase or reset. If master has moved past 4bf44fc, build on top and record `git log --oneline 4bf44fc..master` in the SUMMARY. If the tree is dirty, stop: another session is working there.
- Go: sm-demo-app's go.work does not list the plugin under `use`, so every go command in the plugin dir runs with GOWORK=off. go.mod:176 replaces summercms with ../../../../summercms.go. sm-demo-app's go.work replaces sm-user-plugin with this checkout for the sociallogin and oauthserver consumers.
- Docker: docker info answered (server 29.9.1). If the socket is denied, run go test through sudo -u golem (CLAUDE.md).
- sm-demo-app (../sm-demo-app) has another session's uncommitted edits (main.go and the plugins/golem15/user pointer). It is read-only here: run tests, never stage or commit.
- summercms.go has other sessions' uncommitted edits (.planning/state.json, untracked .msd/ and phase .gitkeep files). Leave them alone. STATE.md, g15office and every commit in summercms.go belong to the orchestrator.
Source facts (plugin checkout at 4bf44fc):
- controllers/api_controller.go:
- Login doc comment :46-57 and handler :58-140. `ip := remoteIP(r)` :77 feeds RejectIfThrottled :79, refuseLogin :89 and :96 (the G2 activation gate), and CheckAndRecordLogin :107.
- Register :746 already has `ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app)))`. surf is already imported; appConfig :883 is nil-safe.
- ResetPassword :373-430. `now := time.Now()` :418 feeds both `"tokens_valid_after": now` :422 and `"email_verified_at": now` :423 in one Updates map. gofmt aligns those keys; "tokens_valid_after" is the longest, so it takes one space after its colon.
- ChangePassword cutoff `cutoff := iat.Add(-time.Second)` :674, written at :679 and :686. Leave it alone.
- Refresh-side cutoff check `iat.Time.Before(*user.TokensValidAfter)` :286.
- RemoteIP doc comment :1162-1164 (it claims /login's throttle uses it), RemoteIP :1165-1167, remoteIP :1169-1178 (returns raw RemoteAddr when it has no port).
- controllers/users_admin_controller.go: FormBeforeUpdate :216-249. When storePassword reports a change, :243-246 runs `now := time.Now()` and `user.TokensValidAfter = &now`; cabana's Save writes it.
- classes/admin_actions.go RevokeUserAccess :106-120, `cutoff := time.Now().Truncate(time.Second)` :113 (the reference). classes/session_user.go :83 RequestUser cutoff check.
- classes/throttle.go: rows are per (user_id, ip_address). RejectIfThrottled and CheckAndRecordLogin select `user_id = ? AND (ip_address = ? OR ip_address IS NULL)`. A missing row is created with IPAddress &ip on the first recorded attempt, success included.
- summercms.go (read-only): surf.ClientIP uses RemoteAddr unless it lies inside a trusted prefix; then it takes the rightmost X-Forwarded-For hop outside the trusted prefixes. It returns "" for an unparseable RemoteAddr and unmaps IPv4-mapped IPv6. surf.TrustedProxies reads http.trusted_proxies ([]string or []any of CIDRs). bouncer.Mint sets IssuedAt with jwt.NewNumericDate (whole seconds). issuedBeforeCutoff is `iat.Before(user.TokensValidAfter)` (jwt.go:172-174).
- Plugin.Buckets (plugin.go:146-166): the user-api limiter (120/min) keys on the verified bearer sub or on surf.ClientIP with the trusted proxies read at Assemble.
- Tests (package user, plugin root):
- admin_harness_test.go: adminHarnessDB :91 (skips under -short); newAdminEnv(t, configure...) :165. Configure functions run after party.Activate and before Assemble, and each calls cfg.Set and t.Fatal on error (see admin_groups_edge_test.go:120).
- adminEnv: call/send :287/:301. send sets Host example.com, Accept-Language en and Content-Type, and gives every request its own RemoteAddr 198.51.100.N:4000, so it cannot model a fixed proxy. Also expect :416, seedUser :513 (password correct-horse, unique email), reload :554, admin(t, perms...) :242, userLogin :682, userPath(id, suffix) :507, adminStamp :85.
- logout_test.go: guarded(t, token, cookie) :220 (GET /_user/api/v1/tokens, jwt.auth) and userAudienceToken(t, sub, jti, iat, exp) :291 (signs like bouncer.Mint).
- offboarding_test.go: fetchCode :45, refresh :50, assertRefreshRefused :55.
- session_test.go: invalidLoginBody, parseToken :644. session_cookie_test.go: userSub :237.
- Existing coverage that must stay green: TestLogin (seeds a suspended row at 192.0.2.1, httptest's default address, and expects the block), TestLoginSixthAttempt, TestLoginRequiresActivation, TestRegistrationExports (RemoteIP with and without a port; X-Forwarded-For ignored), TestResetPassword, TestAdminUserPassword and TestAdminPrivilegedMember T-12.1-21 (both sleep 1.1s and check an older token is refused), TestRevokeUserAccess in classes (checks the whole-second cutoff).
- README.md: the Login throttling bullet :23 ("Failed logins are counted per user and IP in `user_throttle` ..."). The `RefreshTTL`/`RemoteIP` clause :183 says /login keys its throttle on RemoteIP. The social-login helpers list :43 names RemoteIP (keep it). Testing section :247-272; the TestLoginRequiresActivation paragraph is :268. README does not mention http.trusted_proxies today.
- The names TestLoginThrottleClientIP, TestPasswordCutoffSameSecond, loginFrom and waitForFreshSecond, and the files login_client_ip_test.go and same_second_cutoff_test.go, are all unused today.
- Escalation note (summercms.go): tracker rows 9 and 10 at :30-31 (status open, Shipped empty). Rows 1-3 :22-24 are the format. Verdicts **9.** :63 and **10.** :64; G3/G4 :56-57 are the "Done locally (`sha`). ..." format. Reply TODO lines :104 (under "Login lockout keyed on RemoteAddr") and :108 (under "Same-second token refusal"). G2-G4 "Ships in SummerCMS v0.5.0 (sm-user-plugin <sha>, tagged with that wave): ..." lines :75, :79, :83 are the format. The note has four lines starting with TODO today; the two for items 7 and 8 stay.
- Todo: the Outcome section goes between "## Solution" and "## Invoke", as in .planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md:33-35.
</context>
<tasks>
<task type="tracer" tdd="true">
<name>Task 1 (tracer): /login throttles per client address behind a trusted proxy, end to end through the router on Postgres, committed in sm-user-plugin</name>
<files>../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/login_client_ip_test.go, ../sm-demo-app/plugins/golem15/user/README.md</files>
<precondition>git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user status --short is empty, its branch is master, and 4bf44fc is an ancestor of HEAD. Docker is reachable for testcontainers, directly or through sudo -u golem.</precondition>
<behavior>
- TestLoginThrottleClientIP (login_client_ip_test.go, package user, Docker through newAdminEnv; skips under -short). Two subtests, each with its own env and a fresh seedUser account (password correct-horse).
- Subtest "behind a trusted proxy": newAdminEnv configured with http.trusted_proxies = []string{"10.0.0.0/8"}. All requests come from RemoteAddr 10.0.0.2:5000.
- Five wrong-password POSTs to /_user/api/v1/login with X-Forwarded-For 203.0.113.10 each answer 401 with invalidLoginBody.
- The account then has exactly one user_throttle row: ip_address 203.0.113.10, attempts 5, is_suspended true.
- The correct password with X-Forwarded-For 203.0.113.10 answers 401 invalidLoginBody.
- The correct password with X-Forwarded-For 203.0.113.20 through the same proxy answers 200 with a non-empty token.
- Subtest "untrusted X-Forwarded-For is ignored": newAdminEnv with no http.trusted_proxies. All requests come from RemoteAddr 192.0.2.50:4000.
- Five wrong-password POSTs, carrying X-Forwarded-For 203.0.113.1 through 203.0.113.5 in turn, each answer 401.
- Exactly one row exists, keyed 192.0.2.50, with attempts 5 and suspended.
- The correct password with X-Forwarded-For 203.0.113.99 from 192.0.2.50 answers 401 invalidLoginBody.
- The correct password from RemoteAddr 192.0.2.51:4000 answers 200: the throttle is still per address without proxies.
- RED at 4bf44fc: the trusted-proxy subtest fails at the row assertion, because the row is keyed 10.0.0.2. The untrusted subtest already passes at 4bf44fc and pins the anti-spoofing property against a future blind trust of X-Forwarded-For.
</behavior>
<action>
RED. Write login_client_ip_test.go (package user) with TestLoginThrottleClientIP as the behavior block describes. Its doc comment says it pins the /login throttle key: the trusted-proxy client address, as /register and the user-api limit use, and never an X-Forwarded-For header from an untrusted peer.
Add the helper (e *adminEnv) loginFrom(t *testing.T, remoteAddr, forwardedFor, email, password string) *httptest.ResponseRecorder in the same file. It builds a POST /_user/api/v1/login request the way send does: JSON body {"email","password"}, Host example.com, Accept-Language en, Content-Type application/json. It sets req.RemoteAddr = remoteAddr, sets X-Forwarded-For only when forwardedFor is non-empty, and serves it through e.h. A short doc comment explains why send cannot be used: send gives every request its own address.
The trusted-proxy subtest's configure function calls cfg.Set("http.trusted_proxies", []string{"10.0.0.0/8"}) and calls t.Fatal on error, the same way admin_groups_edge_test.go:120 does. Read the rows with e.gdb.Where("user_id = ?", user.ID).Find into []models.Throttle, and compare *IPAddress (it is a pointer). Check the rows before the 203.0.113.20 login, because a successful login creates that client's own row.
Run the test. It must fail against the unchanged handler; record the failure line for the SUMMARY. Do not commit a red test.
GREEN, per QD-2. In controllers/api_controller.go Login, replace the :77 assignment with ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app))), the expression Register uses at :746. Leave RejectIfThrottled, refuseLogin and CheckAndRecordLogin as they are; they already take `ip`.
Extend the Login doc comment by one sentence: the throttle counts failed attempts per user and client address, which is surf.ClientIP with http.trusted_proxies, as for /register.
Rewrite the RemoteIP doc comment. It should say that RemoteIP returns the host part of r.RemoteAddr (r.RemoteAddr itself when it has no port, "" when it is empty), with no proxy handling. It should also say that /login and /register key their throttles on surf.ClientIP with the trusted proxies, and that RemoteIP stays for callers that want the connection address. Keep the RemoteIP and remoteIP code unchanged. gofmt the file.
README.md, in the same commit (per QD-5):
- Rewrite the Login throttling bullet (:23) so it says what follows. Failed logins are counted per user and client address in `user_throttle` (`CheckAndRecordLogin`, `RejectIfThrottled`) and suspend the account for a configured time. The client address is `surf.ClientIP` with the framework's `http.trusted_proxies`, as for the `/register` IP limit and the `user-api` rate limit. Behind a listed reverse proxy it is the `X-Forwarded-For` client, otherwise the connection address, and an `X-Forwarded-For` header from any other peer is ignored. A deployment behind a proxy lists the proxy's address in `http.trusted_proxies`; otherwise every visitor shares the proxy's counter.
- At :183, change the RemoteIP half of the sentence to: `RemoteIP(r)` the host part of `r.RemoteAddr`, with no proxy handling (`/login` and `/register` use `surf.ClientIP` with `http.trusted_proxies`).
- After the TestLoginRequiresActivation paragraph (:268), add a paragraph. `TestLoginThrottleClientIP` sends failed logins through one trusted proxy (`http.trusted_proxies`). It checks that the throttle row carries the `X-Forwarded-For` client, and that this client is suspended while another client behind the same proxy still signs in. It also checks that without trusted proxies a changing `X-Forwarded-For` neither moves the counter nor escapes the suspension.
Run go vet, the targeted tests, then the full Docker-backed suite of the plugin, so the commit is green (CLAUDE.md). If an existing test fails because it relied on the raw RemoteAddr key, stop and report it; planning found none. A failure unrelated to this change is not patched here: stop and report it.
Commit in the plugin repo only, staging by path. Run git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user add controllers/api_controller.go login_client_ip_test.go README.md, then git -C with the same path and commit with this subject:
fix: /login throttles failed logins per client address behind trusted proxies (surf.ClientIP), like /register
The body is one short paragraph: behind a reverse proxy every visitor had the proxy's RemoteAddr, so one client's failures locked the account for all; the key is now surf.ClientIP with http.trusted_proxies; RemoteIP is unchanged. Add no trailer of any kind; the user's global CLAUDE.md forbids co-author tags and overrides any harness attribution reminder. Do not push or tag (v0.5.0 release hold). Record the short SHA (git log -1 --format=%h) and the RED line in the SUMMARY.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l controllers/api_controller.go login_client_ip_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run '^(TestLoginThrottleClientIP|TestLogin|TestLoginSixthAttempt|TestLoginRequiresActivation|TestRegistrationExports)$' . && L=$(awk '/^func Login\(/,/^}/' controllers/api_controller.go) && grep -qF 'ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app)))' <<<"$L" && ! grep -qF 'remoteIP(r)' <<<"$L" && G=$(awk '/^func Register\(/,/^}/' controllers/api_controller.go) && grep -qF 'ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app)))' <<<"$G" && R=$(awk '/^func RemoteIP\(/,/^}/' controllers/api_controller.go) && grep -qF 'return remoteIP(r)' <<<"$R" && grep -qF 'func RemoteIP(r *http.Request) string' controllers/api_controller.go && ! grep -qF 'address /login uses' controllers/api_controller.go && grep -qF 'with no proxy handling' controllers/api_controller.go && ! grep -qF 'uses for its throttle' README.md && grep -qF 'http.trusted_proxies' README.md && grep -qF 'TestLoginThrottleClientIP' README.md && grep -qF 'func TestLoginThrottleClientIP' login_client_ip_test.go && grep -qF 'func (e *adminEnv) loginFrom' login_client_ip_test.go && GOWORK=off go test -count=1 ./... && test -z "$(git status --short)" && C=$(git log -1 --format=%H --fixed-strings --grep='per client address behind trusted proxies' master) && test -n "$C" && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet "$C^" "$C" -- go.mod go.sum && F=$(git diff --name-only "$C^" "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "README.md controllers/api_controller.go login_client_ip_test.go " && TG=$(git tag --points-at "$C") && test -z "$TG" && RB=$(git branch -r --contains "$C") && test -z "$RB"</automated>
</verify>
<done>TestLoginThrottleClientIP failed at 4bf44fc (failure line recorded) and now passes. Behind a trusted proxy the X-Forwarded-For client is the throttle key, so one client's lockout does not lock another client behind the same proxy, and without trusted proxies X-Forwarded-For is ignored. RemoteIP is unchanged in code, with a corrected doc comment. The README describes the client-address rule, http.trusted_proxies and the new test. go vet and the full plugin suite are green. One fix commit (api_controller.go, login_client_ip_test.go, README.md) is on sm-user-plugin master: no trailer, go.mod and go.sum unchanged, untagged, not on any remote branch. The tree is clean.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: reset-password and the admin password set stamp a whole-second cutoff, so a same-second token is accepted; full suites, consumer cross-check, commit</name>
<files>../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go, ../sm-demo-app/plugins/golem15/user/same_second_cutoff_test.go</files>
<precondition>Task 1's verify passed: its commit is HEAD of sm-user-plugin master and the plugin tree is clean.</precondition>
<behavior>
- TestPasswordCutoffSameSecond (same_second_cutoff_test.go, package user, Docker through one newAdminEnv; skips under -short) has two subtests, each with a fresh seedUser account.
- Subtest "reset-password":
- Issue a code with classes.IssueResetCode(t.Context(), e.gdb, user), call waitForFreshSecond(t), then POST /_user/api/v1/reset-password through e.call with code "<id>!<code>" and a new password plus its confirmation. It answers 200 {"message":"Password has been reset"}.
- e.reload(t, user.ID): TokensValidAfter is non-nil and Equal to its own Truncate(time.Second), and EmailVerifiedAt is non-nil.
- Subtest "admin password set": an admin token from e.admin(t, permAccessUsers); waitForFreshSecond(t); then PUT userPath(user.ID, "") with name, email, password and password_confirmation, which answers 200 through e.expect. TokensValidAfter after reload is non-nil and a whole second.
- Both subtests then run the same checks with cutoff := the reloaded TokensValidAfter:
- a token from userAudienceToken(t, userSub(user), a fresh jti, cutoff, cutoff plus one hour) gets 200 from e.guarded(t, tok, "") (bouncer's jwt guard), 200 from e.fetchCode, and 200 from e.refresh (refresh last, because it revokes);
- a token with iat cutoff minus one second gets 401 from guarded and fetchCode, and assertRefreshRefused passes on e.refresh;
- e.userLogin with the new password answers 200, and that token gets 200 from guarded and fetchCode. Whether its iat (parseToken) equals the cutoff second is only logged with t.Logf (QD-4).
- RED at the Task 1 commit: both subtests fail at the whole-second assertion, because the stored cutoff carries microseconds.
</behavior>
<action>
RED. Write same_second_cutoff_test.go (package user) with TestPasswordCutoffSameSecond as the behavior block describes. Its doc comment says it pins the whole-second tokens_valid_after cutoff of POST /reset-password and of the admin Users password set: JWT iat has one-second resolution, so a token minted in the second of the reset is accepted on every check site and an earlier second is refused.
Add waitForFreshSecond(t *testing.T) in the same file. It sleeps until 10ms after the next whole second, so that the reset, the reload and the login usually fall within one second. Its comment says the deterministic proof is the crafted-token pair, not this alignment.
Use fresh jtis built from adminStamp(). Reuse the existing helpers; add no new harness code outside this file. Run the test. It must fail against the unchanged writers; record the failure line for the SUMMARY. Do not commit a red test.
GREEN, per QD-3. In controllers/api_controller.go ResetPassword:
- keep now := time.Now();
- change only the map entry to "tokens_valid_after": now.Truncate(time.Second), and leave "email_verified_at" as now;
- extend the comment above the write by one sentence: the session cutoff is truncated to whole seconds, as in RevokeUserAccess, because JWT iat has whole-second precision, so the login that follows the reset is not refused.
In controllers/users_admin_controller.go FormBeforeUpdate, change the assignment to now := time.Now().Truncate(time.Second) and add the same reason to the comment above it.
Do not touch ChangePassword's cutoff := iat.Add(-time.Second), RevokeUserAccess, or anything in summercms.go modules/bouncer. gofmt both files.
Run go vet, the targeted tests, TestRevokeUserAccess in ./classes, go test -short and the full Docker-backed suite of the plugin.
Consumer cross-check, read-only: from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app run go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/... (go.work points them at this checkout, which carries both fix commits). Record the result in the SUMMARY. If a failure names /login, the throttle, RemoteIP, tokens_valid_after or the reset/admin password path of the user plugin, stop and fix it in this task. Record any other failure as unrelated; do not patch those repos. Do not stage anything in sm-demo-app.
Commit in the plugin repo only, staging by path. Run git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user add controllers/api_controller.go controllers/users_admin_controller.go same_second_cutoff_test.go, then git -C with the same path and commit with this subject:
fix: reset-password and the admin password set stamp tokens_valid_after in whole seconds, so a token minted in the same second is accepted
The body is one short paragraph: iat is whole seconds and the checks are iat before cutoff, so a sub-second cutoff refused the next login in that second; both writers now truncate like RevokeUserAccess; change-password and bouncer are unchanged. No trailer, no push, no tag, no pointer bump. Record the short SHA and the test and cross-check results in the SUMMARY.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l controllers/api_controller.go controllers/users_admin_controller.go same_second_cutoff_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run '^(TestPasswordCutoffSameSecond|TestResetPassword|TestAdminUserPassword|TestAdminPrivilegedMember|TestSessionRoutesAcceptCookies|TestOffboarding|TestRefreshSubjectChecks)$' . && GOWORK=off go test -count=1 -run '^TestRevokeUserAccess$' ./classes && grep -qF '"tokens_valid_after": now.Truncate(time.Second),' controllers/api_controller.go && grep -qE '"email_verified_at": +now,' controllers/api_controller.go && grep -qF 'cutoff := iat.Add(-time.Second)' controllers/api_controller.go && grep -qF 'now := time.Now().Truncate(time.Second)' controllers/users_admin_controller.go && grep -qF 'func TestPasswordCutoffSameSecond' same_second_cutoff_test.go && grep -qF 'func waitForFreshSecond' same_second_cutoff_test.go && GOWORK=off go test -short -count=1 ./... && GOWORK=off go test -count=1 ./... && test -z "$(git status --short)" && C=$(git log -1 --format=%H --fixed-strings --grep='stamp tokens_valid_after in whole seconds' master) && test -n "$C" && test "$C" = "$(git rev-parse master)" && test "$(git rev-parse "$C^")" = "$(git log -1 --format=%H --fixed-strings --grep='per client address behind trusted proxies' master)" && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet "$C^" "$C" -- go.mod go.sum README.md && F=$(git diff --name-only "$C^" "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "controllers/api_controller.go controllers/users_admin_controller.go same_second_cutoff_test.go " && TG=$(git tag --points-at "$C") && test -z "$TG" && RB=$(git branch -r --contains "$C") && test -z "$RB" && git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go diff --quiet HEAD -- modules/bouncer modules/surf</automated>
</verify>
<done>TestPasswordCutoffSameSecond failed at the Task 1 commit (failure line recorded) and now passes. After a reset-password and after an admin password set, tokens_valid_after is a whole second. A token issued in that second is accepted by the jwt guard, /fetch and /refresh; one second earlier is refused at all three; the login right after works; email_verified_at is still written. Change-password, RevokeUserAccess and bouncer are untouched. The plugin's go vet, go test -short and full suite are green, and the sociallogin/oauthserver cross-check result is recorded. A second fix commit (api_controller.go, users_admin_controller.go, same_second_cutoff_test.go) sits on top of Task 1's: no trailer, go.mod, go.sum and README unchanged, untagged, unpushed. The tree is clean.</done>
</task>
<task type="auto">
<name>Task 3: fill items 9 and 10 in the escalation note and the todo's Outcome (summercms.go, left uncommitted)</name>
<files>.planning/notes/2026-10-22-external-user-plugin-escalations.md, .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md</files>
<precondition>Task 2's verify passed: sm-user-plugin master carries both fix commits.</precondition>
<action>
Get the two short SHAs from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user:
- S9 = git log -1 --format=%h --fixed-strings --grep='per client address behind trusted proxies' master
- S10 = git log -1 --format=%h --fixed-strings --grep='stamp tokens_valid_after in whole seconds' master
Edit .planning/notes/2026-10-22-external-user-plugin-escalations.md with Edit (scoped replacements only, never a whole-file Write):
- Tracker row 9, using rows 1-3 as the format. The Quick / todo cell becomes [261022-vfz](../quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/) · [todo](../todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md). Status becomes done (unreleased). Shipped becomes `S9` → v0.5.0. Label, Verdict and g15office stay.
- Tracker row 10: the same cell links, done (unreleased), and `S10` → v0.5.0.
- Verdicts, in the G3/G4 format:
- **9.** becomes: Done locally (`S9`). /login keys the throttle on surf.ClientIP with http.trusted_proxies (the /register expression); RemoteIP stays the RemoteAddr helper; without trusted proxies X-Forwarded-For is ignored.
- **10.** becomes: Done locally (`S10`). /reset-password and the admin password set truncate the cutoff to whole seconds like RevokeUserAccess; change-password and bouncer unchanged.
- Reply to send, "Login lockout keyed on RemoteAddr": keep the "Agreed. ..." line. Replace the TODO line under it with one line in the G2-G4 format: Ships in SummerCMS v0.5.0 (sm-user-plugin S9, tagged with that wave): /login counts failed logins per account and client address, and the client address is now the one /register and the user-api rate limit use: behind a proxy listed in http.trusted_proxies, the X-Forwarded-For client; otherwise the connection address. An X-Forwarded-For header from an address not in http.trusted_proxies is ignored, so it cannot dodge or move a lockout. List your nginx/Caddy address in http.trusted_proxies; without it every visitor still counts as the proxy.
- Reply to send, "Same-second token refusal": keep the "Agreed. ..." line and replace the TODO line under it with: Ships in SummerCMS v0.5.0 (sm-user-plugin S10, tagged with that wave): POST /reset-password and an administrator's password set on the Users form stamp tokens_valid_after with the current whole second, as deactivate and ban already do, so a token minted in the same second as the reset (the login right after it) is accepted and every token from an earlier second is still refused. As with deactivate and ban, a token issued earlier within that same second also stays valid, because iat has no finer resolution. /change-password and the guard's comparison are unchanged.
- In both reply lines, substitute the real S9 and S10, unquoted, as G2-G4 do. Leave the two TODO lines for items 7 and 8, and everything else in the note, unchanged.
Edit the todo .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md: insert an "## Outcome (2026-10-22)" section between "## Solution" (after its last paragraph) and "## Invoke", in the format of 2026-10-22-user-logout-blacklist-missing-under-serve.md. One paragraph, which:
- names quick `261022-vfz`, the two fix commits `S9` and `S10` on sm-user-plugin master and their base `4bf44fc`;
- describes S9: /login uses surf.ClientIP(r, surf.TrustedProxies(appConfig(app))) as /register does; the same ip feeds RejectIfThrottled, refuseLogin and CheckAndRecordLogin; exported RemoteIP is unchanged with a corrected doc comment; README updated; TestLoginThrottleClientIP (Docker) covers the trusted proxy and an ignored untrusted X-Forwarded-For;
- describes S10: /reset-password (tokens_valid_after only; email_verified_at unchanged) and the admin password set truncate to the second; change-password and bouncer untouched; TestPasswordCutoffSameSecond (Docker) covers iat equal to the cutoff (accepted on jwt.auth, /fetch and /refresh) and one second earlier (refused);
- ends with: Reply note items 9 and 10 filled. Not tagged, not pushed: ships with the v0.5.0 wave.
Leave the todo in pending/.
Do not commit, do not stage and do not touch STATE.md, state.json or any other file: the orchestrator commits planning docs and handles STATE and g15office.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/summercms.go && N=.planning/notes/2026-10-22-external-user-plugin-escalations.md && T=.planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md && P=/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && S9=$(git -C "$P" log -1 --format=%h --fixed-strings --grep='per client address behind trusted proxies' master) && S10=$(git -C "$P" log -1 --format=%h --fixed-strings --grep='stamp tokens_valid_after in whole seconds' master) && test -n "$S9" && test -n "$S10" && grep -qE '^\| 9 \| Lockout keyed on `RemoteAddr` \| Fix \| \[261022-vfz\].*\| sniewiif \| done \(unreleased\) \| `[0-9a-f]{7,}` → v0\.5\.0 \|$' "$N" && grep -qE '^\| 10 \| Same-second token refusal \| Fix \| \[261022-vfz\].*\| sniewiif \| done \(unreleased\) \| `[0-9a-f]{7,}` → v0\.5\.0 \|$' "$N" && grep -qF "\`$S9\` → v0.5.0" "$N" && grep -qF "\`$S10\` → v0.5.0" "$N" && grep -qF "Done locally (\`$S9\`)" "$N" && grep -qF "Done locally (\`$S10\`)" "$N" && grep -qF "Ships in SummerCMS v0.5.0 (sm-user-plugin $S9, tagged with that wave)" "$N" && grep -qF "Ships in SummerCMS v0.5.0 (sm-user-plugin $S10, tagged with that wave)" "$N" && awk '/^Login lockout keyed on RemoteAddr$/{f=1;next} f&&(/^$/||/^```/){f=0} f&&/^TODO/{bad=1} END{exit bad}' "$N" && awk '/^Same-second token refusal$/{f=1;next} f&&(/^$/||/^```/){f=0} f&&/^TODO/{bad=1} END{exit bad}' "$N" && grep -qF 'TODO: ships in SummerCMS v0.5.0 — config key <name>, HttpOnly' "$N" && grep -qF 'TODO: ships in SummerCMS v0.5.0 — config key <name>.' "$N" && grep -qF 'Ships in SummerCMS v0.5.0 (sm-user-plugin 4bf44fc, tagged with that wave)' "$N" && grep -q '^## Outcome' "$T" && awk '/^## Outcome/{o=NR} /^## Invoke/{i=NR} END{exit !(o && i && o<i)}' "$T" && grep -qF "$S9" "$T" && grep -qF "$S10" "$T" && test ! -e .planning/todos/done/2026-10-22-user-login-lockout-and-same-second-cutoff.md && D=$(git diff --name-only -- "$N" "$T") && grep -qxF "$N" <<<"$D" && grep -qxF "$T" <<<"$D" && ST=$(git diff --cached --name-only) && test -z "$ST"</automated>
</verify>
<done>Escalation note rows 9 and 10 read done (unreleased) with `S9` → v0.5.0 and `S10` → v0.5.0 and link the quick and the todo. Verdicts 9 and 10 say "Done locally" with their SHAs. The two reply paragraphs carry "Ships in SummerCMS v0.5.0 (sm-user-plugin <sha>, tagged with that wave): ..." lines, and only the TODO lines for items 7 and 8 remain. The todo has an Outcome section before Invoke naming both commits and tests, and it is still in pending/. Both files are modified, unstaged and uncommitted; nothing else in summercms.go was touched.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| client or reverse proxy to POST /login | untrusted credentials and an untrusted X-Forwarded-For header; only RemoteAddr is a network fact |
| session token to jwt.auth, /fetch and /refresh | an untrusted token's iat is compared with the user's tokens_valid_after |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-vfz-01 | Denial of service | /login throttle behind a reverse proxy (one client's five failures suspend the account for every visitor) | high | mitigate | Task 1 keys the throttle on surf.ClientIP with http.trusted_proxies; TestLoginThrottleClientIP proves a second client behind the same proxy still signs in while the failing client is suspended. |
| T-vfz-02 | Spoofing | X-Forwarded-For forged to dodge a lockout or to suspend another client's address | high | mitigate | surf.ClientIP honours X-Forwarded-For only when RemoteAddr is inside http.trusted_proxies and takes the rightmost untrusted hop; TestLoginThrottleClientIP's untrusted subtest proves a changing forged header neither moves the counter nor escapes the suspension. |
| T-vfz-03 | Elevation of privilege | whole-second cutoff after a password reset (a token issued earlier within the reset's second stays valid) | low | accept | Inherent to whole-second iat; identical to RevokeUserAccess's documented trade-off. The alternative, refusing the user's own same-second login, is the reported bug. Tokens from any earlier second are refused (TestPasswordCutoffSameSecond). |
| T-vfz-04 | Denial of service | deployments that never set http.trusted_proxies keep keying on the proxy address | medium | transfer | Operator configuration. The README bullet and the reply paragraph tell operators to list their proxy; the default stays RemoteAddr-only, so no deployment starts trusting forged headers. |
| T-vfz-05 | Tampering | key format change for IPv4-mapped IPv6 and unparseable RemoteAddr (ClientIP unmaps and returns ""), which orphans throttle rows written before the upgrade | low | accept | At most one suspension window (15 minutes by default) is forgotten for such clients at upgrade. Counting resumes on the new key. |
| T-vfz-SC | Tampering | npm/pip/cargo/Go module installs | low | accept | No dependency is added; go.mod and go.sum are unchanged (both commit gates check it). No package-legitimacy checkpoint is needed. |
</threat_model>
<verification>
- sm-user-plugin: GOWORK=off go vet ./..., GOWORK=off go test -short -count=1 ./... and GOWORK=off go test -count=1 ./... are green at both fix commits.
- TestLoginThrottleClientIP was red at 4bf44fc and is green at the first commit. TestPasswordCutoffSameSecond was red at the first commit and is green at the second.
- The sociallogin and oauthserver suites, run through sm-demo-app's go.work against this checkout, have their result recorded in the SUMMARY.
- Two local commits on sm-user-plugin master: no trailer, not pushed, not tagged. The sm-demo-app pointer is unchanged; summercms.go modules/bouncer and modules/surf are unmodified.
- The escalation note and the todo in summercms.go are filled and uncommitted.
</verification>
<success_criteria>
- Behind a configured trusted proxy, the /login lockout of one client does not lock out other clients of the same account; without trusted proxies, X-Forwarded-For has no effect on the throttle.
- A login (or any token) issued in the same second as a reset-password or an admin password set is accepted everywhere; earlier seconds are refused.
- Exported RemoteIP, change-password's cutoff and bouncer's comparison are unchanged.
- Items 9 and 10 are recorded as done (unreleased) with their SHAs, and the reply is ready apart from items 7 and 8.
</success_criteria>
<output>
Create `.planning/quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/261022-vfz-SUMMARY.md` in summercms.go when done. Include both plugin commits' short SHAs and the base, both RED failure lines, the suite results, the consumer cross-check result, the logged same-second observation from TestPasswordCutoffSameSecond, and a confirmation that nothing was pushed, tagged or pointer-bumped and that the note and todo are left uncommitted. Do not commit the SUMMARY; the orchestrator commits planning docs.
</output>

View File

@@ -0,0 +1,121 @@
---
phase: quick-261022-vfz
plan: 01
quick_id: 261022-vfz
subsystem: sm-user-plugin (login throttle, session cutoff)
tags: [user-plugin, throttle, trusted-proxies, jwt, tokens_valid_after, escalation]
status: complete
requires:
- sm-user-plugin 4bf44fc (G4)
- summercms.go modules/surf ClientIP / TrustedProxies (unchanged)
provides:
- /login throttle keyed on surf.ClientIP with http.trusted_proxies
- whole-second tokens_valid_after from /reset-password and the admin Users password set
affects:
- golem15.sociallogin, golem15.oauthserver (consumers through sm-demo-app go.work; cross-checked)
tech-stack:
added: []
patterns:
- "per-request surf.ClientIP(r, surf.TrustedProxies(appConfig(app))) for any client-address key"
- "every tokens_valid_after writer truncates to the second (JWT iat resolution)"
key-files:
created:
- ../sm-demo-app/plugins/golem15/user/login_client_ip_test.go
- ../sm-demo-app/plugins/golem15/user/same_second_cutoff_test.go
modified:
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md (uncommitted)
- .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md (uncommitted)
decisions:
- "/login throttle key is surf.ClientIP with http.trusted_proxies, read per request (the /register expression); exported RemoteIP stays the RemoteAddr host helper with a corrected doc comment"
- "/reset-password and the admin Users password set truncate tokens_valid_after to whole seconds like RevokeUserAccess; email_verified_at keeps full precision; change-password and bouncer unchanged"
metrics:
duration: ~11min
completed: 2026-10-22
actuals:
tokens: 5500
tasks: 3
commits: 2
plan_head_before: 4bf44fc6eaa3a1ca53bc6861716aecd8ed93b940
plan_head_after: a484d0e9a2f29db8cee338370ba961f6c2c14f75
---
# Quick 261022-vfz: user-plugin login throttle via surf.ClientIP, and whole-second password cutoffs (Summary)
POST /login now throttles failed logins per account and per client address. The address comes from `surf.ClientIP` with `http.trusted_proxies`, so one client behind nginx or Caddy can no longer lock everyone out of an account. `/reset-password` and the admin password set now stamp `tokens_valid_after` in whole seconds, so a login in the same second as the reset is accepted.
## Commits (sm-user-plugin master, base `4bf44fc`, local only)
| Task | SHA | Subject | Files |
|------|-----|---------|-------|
| 1 (item 9) | `b6f8055` | fix: /login throttles failed logins per client address behind trusted proxies (surf.ClientIP), like /register | controllers/api_controller.go, login_client_ip_test.go, README.md |
| 2 (item 10) | `a484d0e` | fix: reset-password and the admin password set stamp tokens_valid_after in whole seconds, so a token minted in the same second is accepted | controllers/api_controller.go, controllers/users_admin_controller.go, same_second_cutoff_test.go |
Master was at `4bf44fc` with a clean tree when work started (it had not moved). Neither commit has a trailer. go.mod and go.sum are unchanged. Nothing was pushed or tagged. The sm-demo-app submodule pointer was not bumped and nothing was staged in sm-demo-app; its `plugins/golem15/user` already showed as modified from another session before this task. summercms.go `modules/bouncer` and `modules/surf` are unmodified.
## Task 1: /login throttle key
- `Login`: `ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app)))` replaces `remoteIP(r)`. This one `ip` feeds `RejectIfThrottled`, both `refuseLogin` calls (including the G2 activation gate) and `CheckAndRecordLogin`. The doc comment gained a sentence about the throttle key.
- `RemoteIP`: the code is unchanged. Its doc comment now says it returns the RemoteAddr host with no proxy handling, and that /login and /register use surf.ClientIP.
- README: the Login throttling bullet now explains the client-address rule and `http.trusted_proxies`. The RemoteIP clause was corrected, and a Testing paragraph for `TestLoginThrottleClientIP` was added.
- `TestLoginThrottleClientIP` has two subtests:
- **Trusted proxy 10.0.0.0/8:** five failures with XFF 203.0.113.10 leave one row, keyed 203.0.113.10, with 5 attempts and suspended. That client is then refused, while 203.0.113.20 behind the same proxy gets 200 and a token.
- **No trusted proxies:** a changing XFF counts on one row keyed 192.0.2.50, a forged XFF does not escape the suspension, and 192.0.2.51 still signs in.
- The test also adds the helper `(e *adminEnv) loginFrom`.
- **RED at 4bf44fc:** `login_client_ip_test.go:33: throttle row ip=10.0.0.2 attempts=5 suspended=true, want ip=203.0.113.10 attempts=5 suspended`. The untrusted subtest already passed at 4bf44fc, as planned.
## Task 2: whole-second cutoff
- `ResetPassword`: the Updates map entry is now `"tokens_valid_after": now.Truncate(time.Second)`. `"email_verified_at": now` is unchanged. The comment explains the truncation.
- `FormBeforeUpdate`: `now := time.Now().Truncate(time.Second)` when the password changes, with a comment.
- `ChangePassword` (`cutoff := iat.Add(-time.Second)`), `RevokeUserAccess` and bouncer are untouched.
- `TestPasswordCutoffSameSecond` has subtests for reset-password and the admin password set. Each one checks:
- the stored cutoff is a whole second;
- a crafted token with iat equal to the cutoff gets 200 on jwt.auth (GET /tokens), /fetch and /refresh;
- a token with iat one second earlier gets 401 on jwt.auth and /fetch, and the refused-refresh body on /refresh;
- a real login with the new password works on jwt.auth and /fetch;
- the reset still writes email_verified_at.
- The file also adds `waitForFreshSecond`.
- **RED at b6f8055:**
- reset-password: `same_second_cutoff_test.go:41: tokens_valid_after 2026-10-22T22:54:14.075686+02:00 is not a whole second`
- admin password set: `same_second_cutoff_test.go:52: tokens_valid_after 2026-10-22T22:54:15.089852+02:00 is not a whole second`
- **Same-second observation (logged only):** `login iat 1792702472, cutoff 1792702472, same second: true` (reset-password) and `login iat 1792702473, cutoff 1792702473, same second: true` (admin password set). Both real logins fell in the cutoff's second and were accepted.
## Test results
All runs used `GOWORK=off` in the plugin directory. Docker answered directly; `sudo -u golem` was not needed.
- At `b6f8055`: `go vet ./...` clean. The targeted run of TestLoginThrottleClientIP, TestLogin, TestLoginSixthAttempt, TestLoginRequiresActivation and TestRegistrationExports passed. The full `go test -count=1 ./...` passed (root 50.2s, classes 43.3s, models, updates).
- At `a484d0e`: `go vet ./...` clean. The targeted run of TestPasswordCutoffSameSecond, TestResetPassword, TestAdminUserPassword, TestAdminPrivilegedMember, TestSessionRoutesAcceptCookies, TestOffboarding and TestRefreshSubjectChecks passed, and so did `TestRevokeUserAccess` in ./classes. `go test -short -count=1 ./...` and the full `go test -count=1 ./...` both passed.
- All three verify blocks in the plan passed (VERIFY1, VERIFY2, VERIFY3).
## Consumer cross-check (sm-demo-app go.work, read-only, both fix commits present)
The cross-check ran `go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/...` from sm-demo-app.
- Every test except the ones below passes: re-run with `-skip '^(TestPHPMethodMap|TestClientRegistry)$'`, sociallogin and oauthserver are both ok.
- Three tests fail for a reason unrelated to this change. They scan source files through relative paths that do not exist in the sm-demo-app checkout layout:
- sociallogin `TestPHPMethodMap`: `lstat ../fonoteka.go/plugins/golem15/user: no such file or directory`
- oauthserver `TestPHPMethodMap`: `lstat ../summercms.go/modules/wristband: no such file or directory`
- oauthserver `TestClientRegistry/verify_secret_uses_constant_time_comparison`: `open ../summercms.go/modules/wristband/oidc_token.go: no such file or directory`
- None of the failures involves /login, the throttle, RemoteIP, tokens_valid_after or the reset/admin password path. Per the plan, those repos were not patched.
## Task 3: planning docs (uncommitted)
- **Escalation note:** rows 9 and 10 now read done (unreleased) and link the quick and the todo; their Shipped cells are `b6f8055` → v0.5.0 and `a484d0e` → v0.5.0. Verdicts 9 and 10 now read "Done locally". Both reply paragraphs carry "Ships in SummerCMS v0.5.0 (sm-user-plugin <sha>, tagged with that wave): ..." lines. Only the TODO lines for items 7 and 8 remain.
- **Todo:** a `## Outcome (2026-10-22)` section was added before `## Invoke`. The todo stays in pending/.
- Neither file is staged or committed. STATE.md, state.json and ROADMAP.md were not touched, and nothing was committed in summercms.go.
## Deviations from Plan
None. The plan was executed as written. The only extra was a small unexported test helper, `assertThrottleRow`, in login_client_ip_test.go, which shares the row assertion between the two subtests.
## Threat Flags
None. No new endpoints or trust surface: T-vfz-01 and T-vfz-02 are mitigated as planned and covered by TestLoginThrottleClientIP. T-vfz-03 (the whole-second window) is accepted, as for RevokeUserAccess.
## Self-Check: PASSED
- FOUND: login_client_ip_test.go, same_second_cutoff_test.go (plugin root)
- FOUND: b6f8055, a484d0e on sm-user-plugin master; `git rev-list --count 4bf44fc..HEAD` = 2
- Plugin tree clean; no tag on either commit; no remote branch contains them

View File

@@ -0,0 +1,100 @@
---
phase: quick-261022-vfz
verified: 2026-10-22T21:10:00Z
status: passed
score: 7/7 must-haves verified
covered_files:
- .planning/quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/261022-vfz-PLAN.md
- .planning/quick/261022-vfz-user-plugin-login-throttle-via-surf-clie/261022-vfz-SUMMARY.md
covered_digest: "v2:sha256:61944e45e0b64a9619cbc2aa21ec65fb3b0cfa4d796e83a12835c39673b0c1b0"
# The implementation is in sm-user-plugin, outside this project root, so the fingerprint tool
# cannot cover it. It is pinned by commit instead: sm-user-plugin master b6f8055 (throttle),
# a484d0e (cutoff), base 4bf44fc.
implementation_commits: [b6f8055, a484d0e]
behavior_unverified: 0
overrides_applied: 0
---
# Quick 261022-vfz: Verification Report
**Goal:** The user plugin's /login throttle uses surf.ClientIP with the trusted proxies instead of RemoteAddr. Exported RemoteIP stays the RemoteAddr helper. The remaining tokens_valid_after writers (reset-password and the admin password set) truncate to the second, as RevokeUserAccess does. change-password and bouncer's comparison stay as they are.
**Verified:** 2026-10-22
**Status:** passed
**Re-verification:** No, this is the first verification.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | Trusted proxy plus XFF 203.0.113.10: five failures leave one row keyed 203.0.113.10 with 5 attempts and suspended. That client is refused, and 203.0.113.20 gets 200 and a token. | VERIFIED | `api_controller.go:79` `ip := surf.ClientIP(r, surf.TrustedProxies(appConfig(app)))`. This single `ip` feeds RejectIfThrottled (:81), both refuseLogin calls (:91, :98) and CheckAndRecordLogin (:109). `TestLoginThrottleClientIP/behind_a_trusted_proxy` PASS, run by the verifier. |
| 2 | With no trusted proxies, XFF is ignored: the attempts count on the connection-address row, and a forged XFF does not escape. | VERIFIED | surf.ClientIP returns RemoteAddr when `trusted` is empty (`modules/surf/clientip.go:21`). `TestLoginThrottleClientIP/untrusted_X-Forwarded-For_is_ignored` PASS. |
| 3 | controllers.RemoteIP keeps its signature and behaviour. Its doc comment no longer claims /login uses it. | VERIFIED | `RemoteIP(r *http.Request) string { return remoteIP(r) }` and `remoteIP` are unchanged in the diff; only the comment changed. `social_hooks_test.go:327` still exercises it, and the suite passes. |
| 4 | After reset-password or an admin password set, tokens_valid_after is a whole second. A token whose iat equals the cutoff is accepted at jwt.auth, /fetch and /refresh, and one from a second earlier is refused at all three. A fresh login works, and email_verified_at is still written. | VERIFIED | `api_controller.go:427` `"tokens_valid_after": now.Truncate(time.Second)`, with `email_verified_at: now` kept. `users_admin_controller.go:247` `now := time.Now().Truncate(time.Second)`. `TestPasswordCutoffSameSecond` (both subtests) PASS; the logged real logins fell in the same second as the cutoff and were accepted. |
| 5 | /change-password still writes iat minus one second, and summercms.go modules/bouncer is unmodified. | VERIFIED | `api_controller.go:679` `cutoff := iat.Add(-time.Second)` is not in the diff. The summercms.go modules/ working tree is clean, and the last bouncer/surf commits are from phase 19.7. |
| 6 | go vet and the full Docker-backed go test pass at both commits (throttle first, then cutoff). Nothing is pushed or tagged, go.mod and go.sum are unchanged, and the pointer is not bumped. | VERIFIED | At a484d0e (the checkout): vet clean and the full `go test -count=1 ./...` ok in all packages. At b6f8055 (`git archive` into the scratchpad, replace pointed at an absolute path): vet clean, all packages ok. The one failure there, TestRegisterCORSPath, comes from the copy's location (it reads `config/http.yaml` from the parent app) and passes in the real layout. No tags; `git branch -r --contains b6f8055` is empty; master is ahead of origin by 5. go.mod and go.sum are not in the 4bf44fc..a484d0e diff. sm-demo-app has nothing staged, and its last pointer commit is still e587980. |
| 7 | Escalation rows 9 and 10 read done (unreleased) with their SHA and v0.5.0. Their verdicts and replies are filled with no TODO left for them, and the todo has an Outcome section, stays in pending/, and is uncommitted. | VERIFIED | Note lines 30-31 (rows), 63-64 (verdicts), and the reply paragraphs carry b6f8055 and a484d0e. The only TODOs left belong to the cookie-on-/login and password-routes items. The todo has `## Outcome (2026-10-22)` before `## Invoke`. Both files show as ` M` (uncommitted). |
**Score:** 7/7 truths verified (0 present but behavior-unverified).
### Required Artifacts
| Artifact | Status | Details |
|----------|--------|---------|
| `sm-user-plugin/controllers/api_controller.go` | VERIFIED | Contains `now.Truncate(time.Second)` and the ClientIP expression; RemoteIP comment corrected |
| `sm-user-plugin/controllers/users_admin_controller.go` | VERIFIED | Contains `now := time.Now().Truncate(time.Second)` |
| `sm-user-plugin/login_client_ip_test.go` | VERIFIED | `TestLoginThrottleClientIP` and `loginFrom` go through the real router (`e.h`) |
| `sm-user-plugin/same_second_cutoff_test.go` | VERIFIED | `TestPasswordCutoffSameSecond`, crafted iat tokens on all three check sites |
| `sm-user-plugin/README.md` | VERIFIED | Login throttling bullet names `http.trusted_proxies`; RemoteIP clause corrected; Testing paragraph added |
| escalation note / todo | VERIFIED | See truth 7 |
### Key Link Verification
| From | To | Via | Status |
|------|----|-----|--------|
| Login | surf.ClientIP / TrustedProxies | read per request, one `ip` feeds all 4 throttle call sites | WIRED |
| ResetPassword, FormBeforeUpdate | bouncer issuedBeforeCutoff, refresh check (:288), RequestUser (:83) | whole-second cutoff vs whole-second iat; exercised at all three sites by the test | WIRED |
| commit SHAs | escalation note rows and reply | `b6f8055` → v0.5.0 and `a484d0e` → v0.5.0 | WIRED |
Every writer of tokens_valid_after was checked: RevokeUserAccess truncates, ResetPassword truncates, FormBeforeUpdate truncates, and ChangePassword uses iat minus 1s as intended. No other writer exists.
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| vet at HEAD | `GOWORK=off go vet ./...` | clean | PASS |
| full suite at HEAD | `GOWORK=off go test -count=1 ./...` | root 48.4s, classes 40.6s, models, updates ok | PASS |
| new tests run, not skipped | `go test -v -run '^(TestLoginThrottleClientIP\|TestPasswordCutoffSameSecond)$' .` | 4/4 subtests PASS | PASS |
| intermediate commit b6f8055 | vet plus full suite in an archive copy | all ok, apart from the layout-only TestRegisterCORSPath | PASS |
### Probe Execution
None declared for this quick task.
### Requirements Coverage
| Requirement | Status | Evidence |
|-------------|--------|----------|
| vfz-1 (login throttle via surf.ClientIP; RemoteIP kept) | SATISFIED | Truths 1-3 |
| vfz-2 (whole-second cutoff at reset and admin set; change-password and bouncer unchanged) | SATISFIED | Truths 4-5 |
| vfz-3 (escalation note and todo, uncommitted) | SATISFIED | Truth 7 |
### Anti-Patterns Found
No TBD, FIXME, XXX, TODO, HACK or placeholder markers were added in 4bf44fc..a484d0e.
Info only: for a RemoteAddr that does not parse as an IP, surf.ClientIP returns "" where the old remoteIP returned the raw string. Real listeners always give a parsable host:port, so this has no practical effect, and it matches /register.
### Human Verification Required
None.
### Gaps Summary
None. The phase goal is met in the code, and the behaviour is backed by passing tests that go through the real router.
---
_Verified: 2026-10-22_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,62 @@
# Quick Task 261022-wah: Opt-in HttpOnly session cookie on user-plugin POST /login and cookie-carried /refresh rotation - Context
**Gathered:** 2026-10-22
**Status:** Ready for planning
<domain>
## Task Boundary
External escalation item 7. In sm-user-plugin (mounted at `../sm-demo-app/plugins/golem15/user`, base `a484d0e`), add the opt-in config key `golem15.user.jwt.token_cookie` (default `false`). When it is on, the token-minting routes set the HttpOnly session cookie instead of returning the token in the body. A cookie-carried `POST /refresh` rewrites that cookie. Code changes are in the plugin repo. Framework repo changes are limited to the escalations note and todo outcome.
</domain>
<decisions>
## Implementation Decisions
### Locked from the todo (not reopened)
- Key `golem15.user.jwt.token_cookie`, default `false`. It is a twin of `golem15.sociallogin.token_cookie`. Cookie attributes come only from `auth.cookie.*` via `bouncer.LoadCookieConfig`; no second attributes block.
- When on: `http.SetCookie(w, cc.TokenCookie(token, RefreshTTL(app)))` and the `token` key is **omitted** from the body; `user` (and any other keys) stay. When off: today's bodies byte-for-byte and no `Set-Cookie`.
- A `LoadCookieConfig` error is logged and answers an opaque 500, like sociallogin `writeSession`.
- SameSite stays Lax (the auth.cookie default). No CSRF token. Do not switch to SameSite=None.
### Routes covered by token_cookie
- **All three token-minting session routes:** `POST /login`, `POST /register` (auto-activation branch that returns `{token, user}`), and activate-by-code (`ActivateByCode`, `{message, token, user}`). The same flag and the same helper apply to each: cookie set, body `token` omitted.
- Personal API token creation (`api_tokens.go`) is NOT a session and is untouched.
### Cookie-carried /refresh rotation
- The trigger is **the auth.cookie name only**. Rewrite the cookie when the token `/refresh` used came from the cookie named `auth.cookie.name` (`LoadCookieConfig(...).Name`, default `token`), i.e. there is no bearer header and that cookie supplied the token. This applies **regardless of `token_cookie`**, so a sociallogin-set cookie rotates too.
- A refresh carried by a bearer header stays body-only, even when the cookie is also present (bearer wins, as in SessionToken).
- A refresh carried by another session cookie (e.g. an app-written `auth_token`) stays body-only. No second cookie is written beside it.
- When the cookie is rewritten, the rotated token is **omitted from the body** (the HttpOnly token never reaches JS). Pick a body shape that stays valid JSON (e.g. `{}` or a non-token key); planner decides and documents it.
- Failure paths (401s) do not write or forget the cookie (unchanged behaviour).
### Claude's Discretion
- Helper placement: a shared `writeSessionToken`-style helper in controllers (or classes) used by the three routes and refresh.
- Exact empty-body shape on cookie refresh.
- Test layout: follow the existing api_controller tests.
</decisions>
<specifics>
## Specific Ideas
- Mirror `sociallogin/controllers/helpers.go` `writeSession`.
- `bouncer.CookieConfig.TokenCookie` already sets HttpOnly, Max-Age = refresh TTL, Secure and SameSite from config.
- Detecting the carrying cookie: SessionToken returns bearer-first. Compare against `r.Cookie(cc.Name)` only when the Authorization bearer is absent.
- After the plugin commit (local only; release hold for v0.5.0, no push or tag):
- Update the plugin README: the config table row, the JWT sessions paragraph (the line "A cookie-carried POST /refresh answers the rotated token in the body and writes no cookie" changes), and config.yaml with a commented key.
- Fill item 7 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` (tracker row `done (unreleased)` + commit → v0.5.0, the Verdicts line, and the "Cookie on /login" reply paragraph naming `golem15.user.jwt.token_cookie`). Also reword the G3 reply sentence about cookie-carried /refresh not rewriting the cookie, since that is now false for the auth.cookie cookie.
- Add an Outcome to the todo; leave it in pending.
</specifics>
<canonical_refs>
## Canonical References
- .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- ../sm-demo-app/plugins/golem15/sociallogin/controllers/helpers.go (writeSession)
- modules/bouncer/cookie.go (LoadCookieConfig, TokenCookie)
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go (SessionToken, SessionCookieNames, EndSession)
</canonical_refs>

View File

@@ -0,0 +1,445 @@
---
phase: quick-261022-wah
plan: 01
quick_id: 261022-wah
slug: opt-in-httponly-session-cookie-on-user-p
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- wah-1 # cookie-carried POST /refresh: when the token came from the auth.cookie cookie (no bearer), rewrite that cookie with the rotated token and leave the token out of the body, whatever token_cookie says; bearer and other-cookie refreshes stay body-only; refusals write and forget no cookie
- wah-2 # golem15.user.jwt.token_cookie (default false): POST /login, POST /register (token branch) and POST /activate-by-code set the auth.cookie HttpOnly cookie and omit body token; off = today's bodies byte-for-byte and no Set-Cookie; a LoadCookieConfig error is logged and answers the opaque 500
- wah-3 # escalation note item 7 (tracker, verdict, reply), the G3 verdict and reply sentence about /refresh reworded, the todo's Outcome; a separate docs commit in summercms.go
files_modified:
# sm-user-plugin (module git.golem15.com/golem15/sm-user-plugin), worked in the sm-demo-app submodule checkout. Commit there only.
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/README.md
- ../sm-demo-app/plugins/golem15/user/refresh_cookie_test.go
- ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
- ../sm-demo-app/plugins/golem15/user/token_cookie_test.go
# summercms.go planning docs, edited and committed by Task 3 (pathspec commit of exactly these two files)
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
estimate:
tokens: 120000
raw_tokens: 120000
tasks: 3
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "With golem15.user.jwt.token_cookie unset (the default) or false, POST /login and POST /register (auto mode) answer 200 with exactly the keys token and user, POST /activate-by-code with exactly message, token and user, and none of them sets a cookie; TestLogin, TestRegister and TestActivateByCode stay green unchanged."
- "With golem15.user.jwt.token_cookie true, those three routes answer 200 without a token key (user, and message for activate-by-code, stay) and set exactly one cookie: named auth.cookie.name, with the path, domain, SameSite (Lax by default) and Secure of bouncer.LoadCookieConfig, HttpOnly, Max-Age golem15.user.jwt.refresh_ttl in seconds; that cookie alone authenticates GET /fetch as the signed-in user."
- "A POST /refresh whose token came from the auth.cookie cookie with no bearer header answers 200 with the body {} and one Set-Cookie of that name carrying the rotated token, whether token_cookie is on or off; the rotated cookie authenticates /fetch and jwt.auth, and the old token is refused afterwards."
- "A POST /refresh carried by the bearer header (also when the auth.cookie cookie is sent too), or by the other session cookie, answers 200 with exactly the key token and sets no cookie, as at a484d0e."
- "A refused POST /refresh (401) sets and forgets no cookie. When bouncer.LoadCookieConfig refuses the auth.cookie block, a cookie-carried refresh answers the opaque 500 before rotating (the same token still refreshes by bearer), and with token_cookie on the three token routes answer the opaque 500 before they sign in, create or activate anything; a bearer refresh never reads auth.cookie."
- "POST /tokens (personal API tokens) is unchanged and sets no cookie when token_cookie is on."
- "Two local commits on sm-user-plugin master on top of a484d0e (the refresh rotation first, then token_cookie), each green on go vet, go test -short and the full Docker-backed suite; no trailer, not pushed, not tagged, go.mod and go.sum unchanged; the sm-demo-app pointer is neither committed nor staged."
- "Escalation note row 7 reads done (unreleased) with both short SHAs and v0.5.0; verdict 7, the G3 verdict and the G3 and Cookie-on-/login reply paragraphs describe the shipped behaviour and name golem15.user.jwt.token_cookie; only item 8's TODO line remains; the todo has an Outcome and stays in pending/; both files are committed in summercms.go by a commit touching only them."
artifacts:
- path: ../sm-demo-app/plugins/golem15/user/classes/session_user.go
provides: "SessionTokenCookie(r): the name of the session cookie that supplied SessionToken's token, \"\" when the bearer header did or there is none; bearer parsing shared with sessionTokens"
contains: "func SessionTokenCookie(r *http.Request) string"
- path: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
provides: "tokenCookieConfig, writeSession (cookie-or-body 200 writer) and sessionCookie (token_cookie flag); Refresh rewrites the auth.cookie cookie; Login, Register and ActivateByCode write through writeSession"
contains: "func writeSession(w http.ResponseWriter, app *backpack.App, cc *bouncer.CookieConfig, token string, body map[string]any)"
- path: ../sm-demo-app/plugins/golem15/user/config/config.yaml
provides: "jwt.token_cookie: false with a comment"
contains: "token_cookie: false"
- path: ../sm-demo-app/plugins/golem15/user/refresh_cookie_test.go
provides: "TestRefreshRewritesAuthCookie (Docker) and TestSessionTokenCookie (-short); assertSessionCookie and assertNoCookie helpers"
contains: "func TestRefreshRewritesAuthCookie"
- path: ../sm-demo-app/plugins/golem15/user/token_cookie_test.go
provides: "TestTokenCookie (Docker): off by default, on, configured auth.cookie, broken auth.cookie"
contains: "func TestTokenCookie"
- path: ../sm-demo-app/plugins/golem15/user/README.md
provides: "JWT sessions bullet (cookie refresh and token_cookie), SessionTokenCookie in the API reference, config table row, Testing paragraphs"
contains: "golem15.user.jwt.token_cookie"
- path: .planning/notes/2026-10-22-external-user-plugin-escalations.md
provides: "row 7 done (unreleased) with both SHAs; verdicts 7 and G3; G3 and Cookie-on-/login reply paragraphs filled"
contains: "golem15.user.jwt.token_cookie"
- path: .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
provides: "## Outcome (2026-10-22) section before ## Invoke"
contains: "## Outcome"
key_links:
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (Refresh)
to: ../sm-demo-app/plugins/golem15/user/classes/session_user.go (SessionTokenCookie, SessionToken)
via: "Refresh rotates the token SessionToken returns and rewrites the cookie only when SessionTokenCookie names the same cookie as auth.cookie.name"
pattern: "classes\\.SessionTokenCookie\\(r\\)"
- from: ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go (writeSession, tokenCookieConfig)
to: summercms.go modules/bouncer/cookie.go (LoadCookieConfig, CookieConfig.TokenCookie)
via: "auth.cookie attributes come only from bouncer.LoadCookieConfig(app.Config); the cookie is cc.TokenCookie(token, refreshTTL(app)), HttpOnly with Max-Age refresh_ttl"
pattern: "TokenCookie\\(token, refreshTTL\\(app\\)\\)"
- from: the cookie writeSession sets
to: "the plugin's jwt guard, authenticate and SessionToken (classes.SessionCookieNames, which lists token and auth_token)"
via: "the guard reads only the token and auth_token cookies, so the written cookie authenticates while auth.cookie.name is one of them (the default token)"
pattern: "SessionCookieNames"
- from: Task 1 and Task 2 commit SHAs (sm-user-plugin master)
to: .planning/notes/2026-10-22-external-user-plugin-escalations.md row 7, verdict 7 and the reply
via: "Task 3 reads each SHA with git log --format=%h --fixed-strings --grep on the commit subject"
pattern: "→ v0\\.5\\.0"
---
<objective>
Close external escalation item 7 in sm-user-plugin: an opt-in HttpOnly session cookie on the password session routes, and a cookie-carried POST /refresh that rewrites that cookie.
Today POST /login, POST /register (when it signs the new account in) and POST /activate-by-code return the session JWT only in the body, so the external app runs a Nuxt bridge to put it in a cookie. golem15.sociallogin already has the twin flag (golem15.sociallogin.token_cookie, its writeSession). G3 (8e4b863) made /refresh read the token and auth_token cookies but answer the rotated token in the body only while blacklisting the old jti, so an HttpOnly cookie (which JavaScript cannot rewrite) keeps a dead token after one refresh. Both halves land here.
Purpose: an application can keep the session in an HttpOnly cookie end to end (sign in, refresh, fetch, logout) without a bridge, and without any change for the many applications that use body tokens.
Output: two local commits on sm-user-plugin master (one logical change each, per CLAUDE.md), made in /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user with git -C; then the escalation note and the todo filled and committed in summercms.go as a separate docs commit. No push, no tag and no sm-demo-app pointer commit (SummerCMS v0.5.0 release hold). summercms.go code (modules/bouncer) is not modified.
Locked decisions from 261022-wah-CONTEXT.md (labelled here for traceability; the executor does not revisit them):
- L-1 Key golem15.user.jwt.token_cookie, default false, a twin of golem15.sociallogin.token_cookie. Cookie attributes come only from auth.cookie.* through bouncer.LoadCookieConfig; no second attributes block.
- L-2 When on: http.SetCookie(w, cc.TokenCookie(token, RefreshTTL(app))) and the token key is omitted from the body; user and any other keys stay. When off: today's bodies byte-for-byte and no Set-Cookie.
- L-3 A LoadCookieConfig error is logged and answers an opaque 500, like sociallogin writeSession.
- L-4 SameSite stays Lax (the auth.cookie default). No CSRF token. No switch to SameSite=None.
- L-5 All three token-minting session routes (/login, /register's {token, user} branch, /activate-by-code) get the same flag and helper. Personal API token creation (api_tokens.go) is untouched.
- L-6 /refresh rewrites the cookie when its token came from the cookie named auth.cookie.name (LoadCookieConfig(...).Name, default token) with no bearer header, regardless of token_cookie (a sociallogin-set cookie rotates too).
- L-7 A bearer-carried refresh stays body-only, also when the cookie is present (bearer wins, as in SessionToken).
- L-8 A refresh carried by another session cookie (e.g. an app-written auth_token) stays body-only; no second cookie is written.
- L-9 When the cookie is rewritten, the rotated token is omitted from the body; the body stays valid JSON.
- L-10 Failure paths (401) neither write nor forget the cookie.
Planner's choices (Claude's Discretion in CONTEXT, plus planning calls; the executor does not revisit them):
- QD-1 Two plugin commits, refresh first. Commit 1 (fix): the cookie-carried /refresh rewrite. It is coherent on its own, because a golem15.sociallogin token_cookie session now survives a refresh. Commit 2 (feat): golem15.user.jwt.token_cookie on the three routes. Each commit carries its own README and doc-comment changes (CLAUDE.md docs rule). Tracker row 7 lists both SHAs.
- QD-2 Helpers live in controllers/api_controller.go: tokenCookieConfig (a nil-safe bouncer.LoadCookieConfig), writeSession (the 200 writer: cookie and no body token, or body token and no cookie), and sessionCookie (the token_cookie flag plus the config, added in Task 2). Refresh and the three routes all answer through writeSession. Carrier detection is a new exported classes.SessionTokenCookie(r), next to SessionToken in classes/session_user.go, sharing one bearer parser with sessionTokens so the bearer-then-cookies order lives in one place. This is an additive export of a core plugin, documented in the README API reference.
- QD-3 The cookie-refresh body is {} (map[string]any{} through writeJSON), the plugin's existing token-less 200 shape (/register in admin mode, api_controller.go:816).
- QD-4 Config-error timing. The three routes call sessionCookie right after sessionDeps, before reading the body and before any side effect. A broken auth.cookie block therefore never restores or records a login, creates an account or consumes an activation code and then answers 500 (VerifyActivationCode activates the user and clears the code). Refresh loads auth.cookie only for a cookie-carried request, before bouncer.Refresh, so a 500 rotates and blacklists nothing; a bearer refresh never reads auth.cookie, so bearer clients keep working on a broken block. The log line goes through pluginLog.Error and the answer is writeOpaque500 (the plugin's opaque 500, {"error":true,"message":"Internal server error"}).
- QD-5 The guard reads only the token and auth_token cookies (classes.SessionCookieNames). An auth.cookie.name outside that list would set a cookie that no route reads, and SessionTokenCookie never names it, so /refresh never rewrites it. SessionCookieNames is not changed; the README and the config.yaml comment say to keep auth.cookie.name at token (the default) or auth_token.
- QD-6 Compatibility. Cookie-carried /refresh was never released: the last plugin tag v0.1.8 does not contain 8e4b863, and released versions read /refresh's token from the Authorization header only. Changing the token-cookie refresh answer changes no released contract. The existing TestSessionRoutesAcceptCookies subtest that pinned the unreleased body-only answer for the token cookie is updated, not deleted.
- QD-7 Tests go through the real router (newAdminEnv: surf.Assemble with the jwt guard and the user-api limiter, Postgres from testcontainers), so cookies, the guard and the route answers are seen as a browser sees them. The classes helper gets a pure table test that runs under -short. The harness app.url is https://app.example.test, so LoadCookieConfig gives Secure=true; cookie attributes are compared against e.cookieConfig(t).TokenCookie, as assertForgets does, never against hard-coded flags.
- QD-8 Docs commit. The orchestrator asked for the framework-repo planning docs as a separate docs task and commit, staged by path. Task 3 commits exactly the note and the todo with a pathspec commit. The orchestrator's final quick commit (PLAN, SUMMARY, STATE) stays separate.
Source coverage audit:
| Source | Item | Covered by |
|--------|------|------------|
| GOAL / todo Solution 1-2, L-1, L-2, L-5 | token_cookie key (default false) on /login, /register, /activate-by-code; cookie from LoadCookieConfig + TokenCookie(RefreshTTL); body token omitted; off unchanged; api_tokens untouched | Task 2 (code, config.yaml, TestTokenCookie off/on/settings, POST /tokens check, file-list gate) |
| L-3 | LoadCookieConfig error logged, opaque 500 | Task 1 (refresh), Task 2 (three routes), both tested with a broken auth.cookie.same_site |
| todo Solution 3, L-6, L-9 | cookie-carried /refresh rewrites the auth.cookie cookie, regardless of token_cookie; rotated token not in the body | Task 1 (Refresh + writeSession, TestRefreshRewritesAuthCookie, updated TestSessionRoutesAcceptCookies) |
| L-7, L-8 | bearer-carried (with or without the cookie) and other-cookie refreshes stay body-only, no second cookie | Task 1 (SessionTokenCookie, bearer-wins, auth_token and custom-name subtests) |
| L-10 | 401 refresh writes and forgets no cookie | Task 1 (banned and blacklisted subtests assert no Set-Cookie) |
| todo Solution 4, L-4 | SameSite=Lax, no CSRF, no SameSite=None | Tasks 1-2: no SameSite code; attributes only from LoadCookieConfig; README sentence; threat T-wah-02 |
| CONTEXT specifics | README config row, JWT sessions paragraph (the cookie-refresh sentence changes), config.yaml commented key | Task 1 (refresh sentence, API reference, Testing) and Task 2 (config row, token_cookie sentences, config.yaml, Testing) |
| CONTEXT specifics | note item 7 (tracker, verdict, reply), G3 reply sentence reworded, todo Outcome, todo stays pending | Task 3 |
| orchestrator | base a484d0e; local commits only; no push/tag; no sm-demo-app pointer bump; no co-author tags; docs as a separate commit staged by path | Task 1-3 commit gates |
| REQ / RESEARCH | none (quick task, no research) | n/a |
| CONTEXT Deferred Ideas | none listed | n/a |
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@CLAUDE.md
@.planning/STATE.md
@.planning/quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/261022-wah-CONTEXT.md
@.planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
@.planning/notes/2026-10-22-external-user-plugin-escalations.md
@../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
@../sm-demo-app/plugins/golem15/user/classes/session_user.go
@../sm-demo-app/plugins/golem15/sociallogin/controllers/helpers.go
@modules/bouncer/cookie.go
Working copies (observed at planning time, 2026-10-22):
- sm-user-plugin is at /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user. Branch master at a484d0e, 5 commits ahead of origin/master (930b158), working tree clean, no tag on HEAD; the last plugin tag is v0.1.8, which contains none of the five. Do not fetch, merge, rebase or reset. If master has moved past a484d0e, build on top and record git log --oneline a484d0e..master in the SUMMARY. If the tree is dirty, stop: another session is working there.
- Go: sm-demo-app's go.work does not list the plugin under use, so every go command in the plugin dir runs with GOWORK=off. go.mod:176 replaces summercms with ../../../../summercms.go. sm-demo-app's go.work replaces sm-user-plugin with this checkout for the sociallogin and oauthserver consumers.
- Docker: docker info answered (server 29.9.1). If the socket is denied, run go test through sudo -u golem (CLAUDE.md).
- sm-demo-app (HEAD 18597e5) has another session's uncommitted edits (main.go, and the plugins/golem15/user pointer already shows modified because the checkout is ahead of the recorded commit). It is read-only here: run tests, never stage or commit there.
- summercms.go (HEAD ec69f54) has other sessions' uncommitted edits (.planning/state.json, untracked .msd/ and two phase .gitkeep files) and nothing staged. Leave them alone. STATE.md, g15office and the final quick commit belong to the orchestrator; Task 3 commits only the note and the todo.
Source facts (plugin checkout at a484d0e):
- controllers/api_controller.go:
- Login: doc comment :46-59, handler :60-141. sessionDeps :62, readFields :66, CheckAndRecordLogin success :108, TouchLastSeen :126, mintFor :129, the final 200 write with the token and user keys :139.
- Refresh: doc comment :191-198 (it says the rotated token is answered in the body only and no cookie is written). Handler :199-247: sessionDeps :201, raw := classes.SessionToken(r) :205, the "Token not found" 401 :206-209, bouncer.Refresh :214 (blacklists the old jti on success), the two 401 bodies :216-219 and :232-236, TouchLastSeen, then the final 200 write with the token key :245.
- ActivateByCode: doc comment :472, handler :473-531. sessionDeps :475, readFields :479, VerifyActivationCode :509 (activates the user and clears the code), mintFor :514, final write :524-528 with message "Account activated", the token and user.
- Register: doc comment :743, handler :744-818. sessionDeps :746, RegisterUser :768, user mode answers {"message":"Activation email sent"} :799, the token branch (mode auto or require_activation off) IssueToken :803 and its write :813, admin mode answers {} :816.
- appConfig :888 (nil-safe), sessionDeps :930 (guarantees a non-nil app), refreshTTL :996 (RefreshTTL exported at :992), writeJSON :1186 (Cache-Control no-cache, private, then wire.WriteJSON), writeOpaque500 :1253. pluginLog is diary.For("user") in controllers/logger.go. bouncer, net/http and strings are already imported.
- The only session-token mint sites are :129, :514 and :803 (IssueToken in registration.go:185 wraps mintFor). api_tokens.go:61 answers 201 {"token": secret, "meta": …} for personal API tokens; not a session, untouched.
- classes/session_user.go: sessionCookieNames = {"token", "auth_token"} :21, SessionCookieNames :27. forgetSessionCookies :159 already loads LoadCookieConfig with a fallback, for logout. SessionToken :225 returns sessionTokens(r)[0]. sessionTokens :235 parses the Authorization header as strings.TrimSpace(header) then strings.CutPrefix(h, "Bearer "), then each cookie of sessionCookieNames in order, trimmed, empty values skipped, duplicates dropped. A header of "Bearer " with nothing after it trims to "Bearer", so it supplies no token and the cookies are read.
- summercms.go modules/bouncer/cookie.go (read-only): LoadCookieConfig(src) returns defaults (token, "/", Lax) for a nil interface, but a nil *compass.Config wrapped in the interface is not nil, so never pass one. It errors on an invalid name, path, domain or same_site (lax, strict and none only), on Secure false in production, and on none without Secure. Secure defaults to app.url being https. CookieConfig.TokenCookie(token, ttl) is HttpOnly with MaxAge int(ttl/time.Second). No boot step calls LoadCookieConfig, so a broken block surfaces only at request time.
- golem15.sociallogin writeSession (../sm-demo-app/plugins/golem15/sociallogin/controllers/helpers.go:148): loads cfg.TokenCookie, then bouncer.LoadCookieConfig(app.Config); on error it logs and answers 500; then it either calls http.SetCookie(w, cc.TokenCookie(token, usercontrollers.RefreshTTL(app))) or sets body["token"]. Its TestTokenCookieMode (complete_test.go:116) is the assertion style to mirror.
- Tests (package user, plugin root; Docker ones skip under -short through adminHarnessDB):
- admin_harness_test.go: adminEnvConfig :131 (app.url https://app.example.test, SUMMER_ENV development), newAdminEnv(t, configure...) :165. Configure functions run after party.Activate and before Assemble; each calls cfg.Set and t.Fatal on error, as logout_test.go:167-178 does. Handlers read config per request, so e.app.Config.Set mid-test also applies. call :287, send :301 (Host example.com, a fresh RemoteAddr 198.51.100.N per request, bearer only when token is non-empty, extra headers), seedUser :513 (password correct-horse, IsActivated true, unique email; mutate adjusts the row), reload :554, seedThrottle :612, userLogin :682 (reads the token from the body).
- logout_test.go: userRefreshPath :22, userTokensPath :20, blacklistedBody :19, sessionLogin :208 (fails when the body has no token, so it only works with token_cookie off), guarded(t, token, cookie) :220, cookieConfig :255, assertForgets :273 (the attribute comparison to copy), userAudienceToken :291.
- session_cookie_test.go: TestSessionRoutesAcceptCookies :36, whose doc comment :27-35 ends with the cookie-refresh clause, and the "refresh via the <name> cookie" loop :92-119 (asserts body token, no cookies, then the old token refused through the same cookie). cookieSend :207, login :220, userSub :237, fetchedID :242.
- offboarding_test.go: fetchCode :45, refresh :50 (bearer), assertRefreshRefused :55 with refusedRefreshBody.
- session_test.go: TestLogin :54, TestRefresh :420, invalidLoginBody, parseToken :644. account_test.go TestActivateByCode :98 (classes.IssueActivationCode, packed id!code). register_test.go TestRegister :23 (email, password and name are enough in auto mode).
- The names TestRefreshRewritesAuthCookie, TestSessionTokenCookie, TestTokenCookie, SessionTokenCookie, tokenCookieConfig, writeSession, sessionCookie, assertSessionCookie and assertNoCookie, and the files refresh_cookie_test.go and token_cookie_test.go, are all unused in the plugin today.
- README.md: JWT sessions bullet :20 (its cookie-refresh sentence begins "A cookie-carried `POST /refresh`" and ends "stores the new token in it."; the SameSite sentence after it stays). The route note :111. The classes API bullet with SessionToken(r) and SessionCookieNames() :192. Config table :205-226, where the jwt rows end with blacklist_sweep_interval :212. Testing :246-274: TestSessionRoutesAcceptCookies paragraph :266 and TestLoginThrottleClientIP paragraph :270.
- config/config.yaml: the jwt block :1-7 ends with blacklist_sweep_interval: 10m; two-space indent; comments use #.
- Escalation note (summercms.go): tracker row 7 :28 (status open, Shipped empty); rows 1-3 :22-24 are the format. Verdict **G3.** :56 (its third sentence says /refresh leaves the cookie alone); verdict **7.** :61; **9.** and **10.** :63-64 are the "Done locally (`sha`). ..." format. Reply: the G3 "Ships in" line :79 ends with a sentence that begins "A cookie-carried /refresh returns"; "Cookie on /login" :94-96 with its TODO line :96; item 8's TODO line :100 stays. The note has exactly two lines starting with TODO today.
- Todo: sections ## Problem :17, ## Solution :25, ## Note from G3 (2026-10-22) :38, ## Invoke :42. The Outcome goes between Note from G3 and Invoke, in the format of .planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md:33-35.
</context>
<tasks>
<task type="tracer" tdd="true">
<name>Task 1 (tracer): a POST /refresh carried by the auth.cookie cookie rewrites that cookie, end to end through the router on Postgres, committed in sm-user-plugin</name>
<files>../sm-demo-app/plugins/golem15/user/classes/session_user.go, ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/refresh_cookie_test.go, ../sm-demo-app/plugins/golem15/user/session_cookie_test.go, ../sm-demo-app/plugins/golem15/user/README.md</files>
<precondition>git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user status --short is empty, its branch is master, and a484d0e is an ancestor of HEAD. Docker is reachable for testcontainers, directly or through sudo -u golem.</precondition>
<behavior>
- TestRefreshRewritesAuthCookie (refresh_cookie_test.go, package user, Docker through newAdminEnv; skips under -short). golem15.user.jwt.token_cookie is never set in this test (L-6: the rewrite does not depend on it).
- "token cookie rotates" (default env): T from e.sessionLogin. cookieSend POST /refresh with only the token cookie = T answers 200 and the body is exactly {}. Exactly one cookie is set: name token, attributes equal to e.cookieConfig(t).TokenCookie (path, domain, SameSite, Secure, HttpOnly), MaxAge 20160*60, value N non-empty and different from T, and parseToken(N) sub equals T's sub. cookieSend GET /fetch with token = N answers 200 and fetchedID is that sub; e.guarded(t, N, "token") is 200; cookieSend GET /fetch with token = T answers 401.
- "auth_token cookie stays body-only" (L-8): cookieSend POST /refresh with only auth_token = T' answers 200 with exactly the key token (a value other than T'), and no cookie is set.
- "bearer wins over the cookie" (L-7): A and B from sessionLogin. e.send POST /refresh with bearer A and the header Cookie token=B answers 200 with exactly the key token, whose sub is A's; no cookie is set; cookieSend GET /fetch with token = B still answers 200 (B was not rotated).
- "bearer only": e.refresh(t, A2) answers 200 with exactly the key token and sets no cookie.
- "configured auth.cookie name": its own env with auth.cookie.name auth_token and golem15.user.jwt.refresh_ttl 60. A refresh carried by auth_token answers {} and sets exactly one cookie, auth_token, with MaxAge 3600 (no token cookie); that cookie value authenticates GET /fetch through the auth_token cookie. A refresh carried only by the token cookie answers exactly the key token and sets no cookie.
- "refusals set no cookie" (L-10): a banned user's token (seedUser, seedThrottle banned, userAudienceToken) sent through the token cookie gets assertRefreshRefused and no cookie. A token already rotated away through the token cookie, refreshed again through the token cookie, answers 401 with blacklistedBody and no cookie.
- "broken auth.cookie" (L-3): its own env with auth.cookie.same_site "sideways". T5 from sessionLogin (login does not read auth.cookie). A refresh carried by the token cookie answers 500 with exactly {"error":true,"message":"Internal server error"} and no cookie; then e.refresh(t, T5) by bearer answers 200 with a token (T5 was not rotated, and the bearer path never reads auth.cookie).
- TestSessionTokenCookie (same file, no database, runs under -short), on httptest.NewRequest requests:
- bearer A plus a token cookie: "".
- Authorization "Bearer " (nothing after it) plus a token cookie: "token".
- Authorization "Basic xyz" plus a token cookie: "token".
- only auth_token: "auth_token".
- token and auth_token: "token".
- an empty token value (Cookie: token=; auth_token=X): "auth_token".
- no credentials: "".
- For every case, a non-empty name means the trimmed value of r.Cookie(name) equals classes.SessionToken(r), and "" with a non-empty SessionToken means the bearer header supplied it.
- session_cookie_test.go: the "refresh via the <name> cookie" loop branches on the name. For token it asserts the rewrite: a {} body, a token cookie with a new value that serves e.fetchCode. For auth_token it keeps today's assertions. For both, the old token is refused afterwards through the same cookie. The TestSessionRoutesAcceptCookies doc comment's last clause says that a refresh through the token cookie (the auth.cookie default) gets the cookie back with the rotated token and an empty body, and one through auth_token gets it in the body and no cookie.
- RED at a484d0e: "token cookie rotates" fails at the cookie assertion (no Set-Cookie, and the body carries the token).
</behavior>
<action>
RED. Create refresh_cookie_test.go (package user) with TestRefreshRewritesAuthCookie as the behavior block describes. Its doc comment says it pins the cookie-carried refresh: the auth.cookie cookie is rewritten with the rotated token and the body is empty, whoever wrote the cookie; bearer and other-cookie refreshes stay body-only; refusals touch no cookie; a broken auth.cookie block fails a cookie refresh before it rotates.
Add these helpers to the same file, each with a one-line doc comment:
- assertSessionCookie(t, rec, cfg bouncer.CookieConfig, maxAge int) string. It requires exactly one cookie in rec.Result().Cookies(), named cfg.Name, with a non-empty value. Its Path, Domain, SameSite, Secure and HttpOnly must equal those of cfg.TokenCookie("x", time.Hour), and its MaxAge must equal maxAge. It returns the value.
- assertNoCookie(t, rec). It requires rec.Result().Cookies() to be empty and no Set-Cookie header.
- A small decoder that returns the body as map[string]any, so subtests compare the exact key set.
Configure functions call c.Set and t.Fatal on error, as logout_test.go:167-178 does.
Edit the "refresh via the <name> cookie" loop of session_cookie_test.go, and the TestSessionRoutesAcceptCookies doc comment, as the behavior block says. Do not add any reference to the not-yet-written classes function in this step, so the package still compiles.
Run GOWORK=off go test -count=1 -run '^TestRefreshRewritesAuthCookie$' . It must fail against the unchanged handler. Record the failure line for the SUMMARY. Do not commit a red test.
GREEN, classes/session_user.go (per QD-2):
- Extract the Authorization parsing of sessionTokens into an unexported bearerToken(r *http.Request) string. It trims the header, cuts the "Bearer " prefix, trims the rest, and returns "" when there is none. sessionTokens then calls it, so its behaviour is unchanged.
- Add exported SessionTokenCookie(r *http.Request) string right after SessionToken. It returns "" for a nil r, "" when bearerToken(r) is non-empty, and otherwise the name of the first cookie of sessionCookieNames whose trimmed value is non-empty ("" when there is none).
- Its doc comment says it names the session cookie that supplied the token SessionToken returns, for a handler that writes that cookie back (POST /refresh), and that it is "" when the bearer header supplied the token or the request carries none.
- Add TestSessionTokenCookie to refresh_cookie_test.go now.
GREEN, controllers/api_controller.go:
- Add tokenCookieConfig(app *backpack.App) (bouncer.CookieConfig, error). It returns bouncer.LoadCookieConfig(app.Config) when app and app.Config are non-nil, and bouncer.LoadCookieConfig(nil) (the defaults) otherwise, so a nil *compass.Config never reaches the interface. Doc comment: the auth.cookie block the plugin writes the session cookie with.
- Add writeSession(w http.ResponseWriter, app *backpack.App, cc *bouncer.CookieConfig, token string, body map[string]any). With cc nil it sets body["token"] = token. With cc set it calls http.SetCookie(w, cc.TokenCookie(token, refreshTTL(app))) and leaves the body without a token. Either way it then calls writeJSON(w, http.StatusOK, body).
- writeSession's doc comment calls it the user plugin's twin of golem15.sociallogin's writeSession, and says the HttpOnly token never reaches JavaScript when the cookie is written. With cc nil the body gets the same key set the routes answer today, so the bytes are unchanged.
- Refresh, after the "Token not found" check and before bouncer.Refresh: declare rotate as a *bouncer.CookieConfig, initially nil. When name := classes.SessionTokenCookie(r) is non-empty:
- Load cc, err := tokenCookieConfig(app).
- On error, log pluginLog.Error("golem15.user: refresh: auth.cookie config", "err", err), call writeOpaque500(w) and return. Nothing has been rotated at that point.
- When cc.Name equals name, set rotate = &cc.
- Replace the final 200 write of the token body with writeSession(w, app, rotate, next, map[string]any{}). The 401 paths stay exactly as they are and write no cookie.
- Rewrite the Refresh doc comment (it keeps beginning with "// Refresh "). It should say:
- the token is read as the jwt guard reads it;
- when it came from the cookie named auth.cookie.name with no bearer header, that cookie is rewritten with the rotated token (bouncer.LoadCookieConfig attributes, HttpOnly, Max-Age refresh_ttl) and the body is {}, whoever wrote the cookie;
- a bearer-carried or other-cookie refresh answers the token in the body and writes no cookie;
- refusals write and forget no cookie;
- a broken auth.cookie block answers a cookie-carried refresh with the opaque 500 before rotating;
- the existing subject-check sentences stay.
- gofmt both files.
README.md, in the same commit:
- In the JWT sessions bullet (:20), replace the cookie-refresh sentence (it begins "A cookie-carried `POST /refresh`" and ends "stores the new token in it.") with sentences that say the following:
- A `POST /refresh` whose token came from the `auth.cookie.*` cookie (`auth.cookie.name`, default `token`) with no bearer header gets that cookie back with the rotated token. The cookie has the `bouncer.LoadCookieConfig` attributes, HttpOnly and Max-Age `refresh_ttl`, and the answer is `{}`, so the token never reaches JavaScript.
- This holds whoever wrote the cookie (`golem15.sociallogin`'s `token_cookie` or the application). A frontend that writes the `token` cookie itself and refreshes through it gets it back HttpOnly, without a body token; such a frontend sends the bearer header to keep rotating in the body.
- A refresh carried by the bearer header (a cookie sent with it included) or by the other session cookie answers `{"token": …}` and writes no cookie. The old token is blacklisted after `golem15.user.jwt.blacklist_grace`, so that caller stores the new token itself.
- A refused refresh writes and forgets no cookie.
- When `bouncer.LoadCookieConfig` refuses the `auth.cookie` block, a cookie-carried refresh answers the opaque 500 before anything is rotated; a bearer refresh never reads that block.
- Keep `auth.cookie.name` at `token` or `auth_token`, the cookies the guard reads.
- Keep the SameSite sentence that follows.
- In the classes API bullet (:192), extend the SessionToken item with `SessionTokenCookie(r)`: the name of the session cookie that supplied that token (`""` when the bearer header did or there is none), which `POST /refresh` uses to rewrite the `auth.cookie` cookie.
- In the TestSessionRoutesAcceptCookies paragraph (:266), rewrite the parenthesis after `POST /refresh` to say that through `token` (the `auth.cookie` default) the rotated token comes back in a rewritten cookie with a `{}` body, through `auth_token` in the body with no cookie, and that the old token is refused afterwards.
- After the TestLoginThrottleClientIP paragraph, add one paragraph naming `TestRefreshRewritesAuthCookie` and its cases: the token cookie rewritten with the `LoadCookieConfig` attributes, `auth_token` and bearer refreshes left body-only (bearer wins over a cookie), a configured cookie name and refresh window, refusals that set no cookie, and a broken `auth.cookie` block. Name `TestSessionTokenCookie` (in `-short`) as the carrier table.
Run go vet, the targeted tests, go test -short and the full Docker-backed suite of the plugin, so the commit is green (CLAUDE.md). If an existing test other than the loop you edited relied on a body token from a token-cookie refresh, stop and report it; planning found none (logout_test and serve_order_test only expect 401 from cookie refreshes). A failure unrelated to this change is not patched here: stop and report it.
Commit in the plugin repo only, staging by path. Run git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user add classes/session_user.go controllers/api_controller.go refresh_cookie_test.go session_cookie_test.go README.md, then commit with git -C on the same path. The subject:
fix: a /refresh carried by the auth.cookie session cookie rewrites that cookie, so an HttpOnly session survives the rotation
The body is one short paragraph:
- 8e4b863 answered a cookie-carried refresh in the body only and blacklisted the old jti, so an HttpOnly cookie (golem15.sociallogin token_cookie) kept a dead token;
- now the cookie named auth.cookie.name gets the rotated token and the body is {};
- bearer and auth_token refreshes are unchanged, and refusals write no cookie.
Add no trailer of any kind; the user's global CLAUDE.md forbids co-author tags and overrides any harness attribution reminder. Do not push or tag (v0.5.0 release hold). Do not stage anything in sm-demo-app. Record the short SHA (git log -1 --format=%h) and the RED line in the SUMMARY.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l classes/session_user.go controllers/api_controller.go refresh_cookie_test.go session_cookie_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -short -count=1 -run '^TestSessionTokenCookie$' . && GOWORK=off go test -count=1 -run '^(TestRefreshRewritesAuthCookie|TestSessionTokenCookie|TestSessionRoutesAcceptCookies|TestLogoutEndsTheSession|TestBootBeforeDatabase|TestRefresh|TestRefreshSubjectChecks|TestOffboarding)$' . && grep -qF 'func SessionTokenCookie(r *http.Request) string' classes/session_user.go && grep -qF 'func bearerToken(r *http.Request) string' classes/session_user.go && grep -qF 'func tokenCookieConfig(app *backpack.App) (bouncer.CookieConfig, error)' controllers/api_controller.go && grep -qF 'func writeSession(w http.ResponseWriter, app *backpack.App, cc *bouncer.CookieConfig, token string, body map[string]any)' controllers/api_controller.go && grep -qF 'TokenCookie(token, refreshTTL(app))' controllers/api_controller.go && R=$(awk '/^func Refresh\(/,/^}/' controllers/api_controller.go) && grep -qF 'classes.SessionTokenCookie(r)' <<<"$R" && grep -qF 'writeSession(w, app, rotate, next, map[string]any{})' <<<"$R" && ! grep -qE '"token": +next' <<<"$R" && awk '/^\/\/ Refresh /,/^func Refresh\(/' controllers/api_controller.go | grep -qF 'auth.cookie' && grep -qF 'SessionTokenCookie(r)' README.md && grep -qF 'TestRefreshRewritesAuthCookie' README.md && grep -qF 'TestSessionTokenCookie' README.md && ! grep -qF 'answers the rotated token in the body and writes no cookie' README.md && GOWORK=off go test -short -count=1 ./... && GOWORK=off go test -count=1 ./... && test -z "$(git status --short)" && C=$(git log -1 --format=%H --fixed-strings --grep='rewrites that cookie, so an HttpOnly session survives' master) && test -n "$C" && test "$C" = "$(git rev-parse master)" && git merge-base --is-ancestor a484d0e "$C" && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet "$C^" "$C" -- go.mod go.sum && F=$(git diff --name-only "$C^" "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "README.md classes/session_user.go controllers/api_controller.go refresh_cookie_test.go session_cookie_test.go " && test -z "$(git tag --points-at "$C")" && test -z "$(git branch -r --contains "$C")" && ! git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app diff --cached --name-only | grep -qxF plugins/golem15/user && test -z "$(git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app log --format=%h 18597e5..HEAD -- plugins/golem15/user)"</automated>
</verify>
<done>TestRefreshRewritesAuthCookie failed at a484d0e (failure line recorded) and now passes. A refresh carried by the auth.cookie cookie gets that cookie back with the rotated token and a {} body; bearer, bearer-plus-cookie and auth_token refreshes answer the token in the body with no cookie; refusals set no cookie; a broken auth.cookie answers the opaque 500 on a cookie refresh and leaves the token refreshable by bearer. classes.SessionTokenCookie exists with its -short table test. README describes the behaviour, the new export and the tests. go vet, go test -short and the full suite are green. One fix commit (five files) is on sm-user-plugin master on top of a484d0e: no trailer, go.mod and go.sum unchanged, untagged, not on any remote branch. The tree is clean and sm-demo-app is untouched.</done>
</task>
<task type="auto" tdd="true">
<name>Task 2: golem15.user.jwt.token_cookie (default off) puts the session token of /login, /register and /activate-by-code into the HttpOnly auth.cookie cookie, committed in sm-user-plugin</name>
<files>../sm-demo-app/plugins/golem15/user/controllers/api_controller.go, ../sm-demo-app/plugins/golem15/user/config/config.yaml, ../sm-demo-app/plugins/golem15/user/token_cookie_test.go, ../sm-demo-app/plugins/golem15/user/README.md</files>
<precondition>Task 1's verify passed: sm-user-plugin master's HEAD is the refresh-rewrite commit and the tree is clean.</precondition>
<behavior>
- TestTokenCookie (token_cookie_test.go, package user, Docker through newAdminEnv; skips under -short). Every env sets golem15.user.registration.use_register_throttle false, so the shared harness database's registration count cannot interfere. Register bodies use a unique email (label plus adminStamp), password correct-horse and a name. Activation codes come from seedUser with IsActivated false, then classes.IssueActivationCode(t.Context(), e.gdb, user), packed as userSub(user)+"!"+code.
- "off by default" (L-2): with token_cookie unset, POST /login answers 200 with exactly the keys token and user; POST /register (activate_mode auto, the default) answers exactly token and user; POST /activate-by-code answers exactly message, token and user. None sets a cookie (assertNoCookie).
- "on" (L-1, L-2, L-5): golem15.user.jwt.token_cookie true.
- POST /login answers 200 with exactly the key user (its email is the seeded one) and sets the cookie checked by assertSessionCookie(e.cookieConfig(t), 20160*60). That value C alone serves GET /fetch (cookieSend token) as the user.
- A cookie-carried POST /refresh with C answers {} and a new cookie C2, and C2 serves GET /fetch (Task 1 composed with the flag).
- cookieSend POST /tokens with C2 and {"name":"cli"} answers 201 with a non-empty token in the body and sets no cookie: personal API tokens are untouched.
- A wrong password answers 401 with invalidLoginBody and no cookie.
- POST /register answers exactly the key user and a session cookie that serves GET /fetch as the new account.
- POST /activate-by-code answers exactly message ("Account activated") and user (is_activated true) and a session cookie that serves GET /fetch.
- "on with configured auth.cookie": token_cookie true, auth.cookie.name auth_token, golem15.user.jwt.refresh_ttl 60. POST /login sets exactly one cookie, auth_token, with MaxAge 3600 and no token cookie, and that value serves GET /fetch through the auth_token cookie.
- "on with a broken auth.cookie" (L-3, QD-4): token_cookie true, auth.cookie.same_site "sideways".
- POST /login with the correct password answers 500 with exactly {"error":true,"message":"Internal server error"} and no cookie; the user's last_seen stays nil and the user has no user_throttle row.
- POST /register answers the same 500 and no users row (Unscoped) exists for that email.
- POST /activate-by-code answers the same 500 and the user is still not activated. Then e.app.Config.Set("auth.cookie.same_site", "lax"), and the same packed code answers 200 with exactly message and user and a session cookie (the code was not consumed by the 500).
- RED at the Task 1 commit: the "on" subtest fails (the body carries token and no cookie is set).
</behavior>
<action>
RED. Create token_cookie_test.go (package user) with TestTokenCookie as the behavior block describes. Reuse assertSessionCookie, assertNoCookie and the body decoder from refresh_cookie_test.go, and cookieSend, fetchedID, userSub, seedUser, reload and cookieConfig from the existing files. Do not use sessionLogin, userLogin or login in token_cookie-on envs, because they read the token from the body; call e.call on /_user/api/v1/login with {"email","password"}.
The doc comment says TestTokenCookie pins golem15.user.jwt.token_cookie: off keeps the body token and sets no cookie; on puts the session token of /login, /register and /activate-by-code into the HttpOnly auth.cookie cookie and leaves it out of the body; a broken auth.cookie block answers the opaque 500 before anything is signed in, created or activated.
Run GOWORK=off go test -count=1 -run '^TestTokenCookie$' . It must fail against the Task 1 handlers. Record the failure line. Do not commit a red test.
GREEN, controllers/api_controller.go (per L-1 to L-5, QD-2, QD-4):
- Add sessionCookie(app *backpack.App) (*bouncer.CookieConfig, error).
- It returns nil, nil when app or app.Config is nil, or when app.Config.Bool("golem15.user.jwt.token_cookie") is false, without reading auth.cookie.
- Otherwise it calls tokenCookieConfig(app) and returns the address of the config, or the error.
- Its doc comment calls it the golem15.sociallogin token_cookie twin, and says a nil config means the token goes into the body.
- In Login, Register and ActivateByCode, right after the sessionDeps check and before anything else, call cc, err := sessionCookie(app). On error, log pluginLog.Error("golem15.user: token cookie config", "err", err), call writeOpaque500(w) and return.
- Then replace each route's final token write with a writeSession call. Pass the same non-token keys the route answers today, and let writeSession add the token key when cc is nil:
- Login: writeSession(w, app, cc, token, map[string]any{"user": payload}).
- Register: in the token branch only, writeSession(w, app, cc, token, map[string]any{"user": payload}). The user-mode and admin-mode answers stay as they are.
- ActivateByCode: writeSession(w, app, cc, token, map[string]any{"message": "Account activated", "user": payload}).
- Extend each of the three doc comments by one sentence: with golem15.user.jwt.token_cookie on, the token goes into the auth.cookie session cookie instead of the body.
- Do not touch api_tokens.go, sessionDeps, mintFor or IssueToken. gofmt the file.
config/config.yaml: in the jwt block, after blacklist_sweep_interval, add token_cookie: false (two-space indent). Put a comment above it saying three things: on, POST /login, /register (when it signs the account in) and /activate-by-code set the HttpOnly session cookie from auth.cookie.* and leave token out of the body; a POST /refresh carried by that cookie rewrites it either way; keep auth.cookie.name token or auth_token.
README.md, in the same commit:
- Configuration table: a row after golem15.user.jwt.blacklist_sweep_interval, reading | `golem15.user.jwt.token_cookie` | `false` | followed by a meaning cell. The cell says that when on, `POST /login`, `POST /register` (when it signs the new account in) and `POST /activate-by-code` set the HttpOnly session cookie with the `auth.cookie.*` attributes (`bouncer.LoadCookieConfig`; Max-Age `refresh_ttl`) and leave `token` out of the body (`user`, and `message` on activate-by-code, stay). When off, the token is in the body and no cookie is set. It is the twin of `golem15.sociallogin.token_cookie`.
- JWT sessions bullet, after the Task 1 refresh sentences, add sentences that say:
- what golem15.user.jwt.token_cookie does on the three routes (see the config row);
- SameSite stays the `auth.cookie` setting (`lax` by default) and there is no CSRF token, so do not set `same_site: none` for this cookie;
- with the key on, a broken `auth.cookie` block answers those routes with the opaque 500 before they sign in, create or activate anything;
- personal API tokens (`POST /tokens`) are not sessions and are unaffected.
- In the Task 1 parenthesis naming who may have written the cookie, add this plugin's `golem15.user.jwt.token_cookie`.
- Testing: after the TestRefreshRewritesAuthCookie paragraph, add one paragraph naming `TestTokenCookie` and its cases: off by default, on for the three routes with the cookie serving `/fetch` and a cookie refresh, `POST /tokens` unaffected, a configured cookie name and refresh window, and a broken `auth.cookie` block that signs in, creates and activates nothing.
Run go vet, the targeted tests, go test -short and the full Docker-backed suite of the plugin. TestLogin, TestRegister and TestActivateByCode must pass unchanged; they are the default-off byte-shape pins.
Consumer cross-check, read-only: from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app run go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/... (go.work points them at this checkout, which carries both commits). Record the result in the SUMMARY.
- If a failure names /login, /refresh, a session cookie or a body token of the user plugin, stop and fix it in this task.
- Record any other failure as unrelated, and do not patch those repos.
- Do not stage anything in sm-demo-app.
Commit in the plugin repo only, staging by path. Run git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user add controllers/api_controller.go config/config.yaml token_cookie_test.go README.md, then commit with git -C on the same path. The subject:
feat: opt-in golem15.user.jwt.token_cookie sets the HttpOnly session cookie on /login, /register and /activate-by-code instead of returning the token
The body is one short paragraph: default off, so body-token clients are unchanged; when on, the cookie carries the auth.cookie attributes via bouncer.LoadCookieConfig and the body keeps user (and message); SameSite stays Lax, with no CSRF token; personal API tokens are untouched.
Add no trailer of any kind. Do not push or tag. Record the short SHA in the SUMMARY.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l controllers/api_controller.go token_cookie_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -count=1 -run '^(TestTokenCookie|TestRefreshRewritesAuthCookie|TestLogin|TestLoginSixthAttempt|TestLoginRequiresActivation|TestRegister|TestActivateByCode|TestSessionRoutesAcceptCookies)$' . && grep -qF 'func sessionCookie(app *backpack.App) (*bouncer.CookieConfig, error)' controllers/api_controller.go && grep -qF 'Bool("golem15.user.jwt.token_cookie")' controllers/api_controller.go && L=$(awk '/^func Login\(/,/^}/' controllers/api_controller.go) && grep -qF 'sessionCookie(app)' <<<"$L" && grep -qF 'writeSession(w, app, cc, token, ' <<<"$L" && ! grep -qE '"token": +token' <<<"$L" && G=$(awk '/^func Register\(/,/^}/' controllers/api_controller.go) && grep -qF 'sessionCookie(app)' <<<"$G" && grep -qF 'writeSession(w, app, cc, token, ' <<<"$G" && ! grep -qE '"token": +token' <<<"$G" && grep -qF '"Activation email sent"' <<<"$G" && A=$(awk '/^func ActivateByCode\(/,/^}/' controllers/api_controller.go) && grep -qF 'sessionCookie(app)' <<<"$A" && grep -qF 'writeSession(w, app, cc, token, ' <<<"$A" && ! grep -qE '"token": +token' <<<"$A" && awk '/^jwt:/{f=1;next} /^[^ #]/{f=0} f' config/config.yaml | grep -qxF ' token_cookie: false' && grep -qF '| `golem15.user.jwt.token_cookie` | `false` |' README.md && grep -qF 'TestTokenCookie' README.md && GOWORK=off go test -short -count=1 ./... && GOWORK=off go test -count=1 ./... && test -z "$(git status --short)" && C=$(git log -1 --format=%H --fixed-strings --grep='opt-in golem15.user.jwt.token_cookie' master) && test -n "$C" && test "$C" = "$(git rev-parse master)" && test "$(git rev-parse "$C^")" = "$(git log -1 --format=%H --fixed-strings --grep='rewrites that cookie, so an HttpOnly session survives' master)" && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet "$C^" "$C" -- go.mod go.sum controllers/api_tokens.go && F=$(git diff --name-only "$C^" "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "README.md config/config.yaml controllers/api_controller.go token_cookie_test.go " && test -z "$(git tag --points-at "$C")" && test -z "$(git branch -r --contains "$C")" && ! git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app diff --cached --name-only | grep -qxF plugins/golem15/user && test -z "$(git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app log --format=%h 18597e5..HEAD -- plugins/golem15/user)" && git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go diff --quiet HEAD -- modules/bouncer</automated>
</verify>
<done>TestTokenCookie failed at the Task 1 commit (failure line recorded) and now passes. With the key off, the three routes answer today's bodies and set no cookie, and TestLogin, TestRegister and TestActivateByCode pass unchanged. With it on, they set the HttpOnly auth.cookie cookie (LoadCookieConfig attributes, Max-Age refresh_ttl) and leave token out of the body. The cookie serves /fetch and rotates through /refresh, and POST /tokens is untouched. A broken auth.cookie answers the opaque 500 before any sign-in, account or activation. config.yaml and README document the key. go vet, go test -short and the full suite are green, and the sociallogin/oauthserver cross-check result is recorded. A second commit (four files) sits on top of Task 1's: no trailer, go.mod, go.sum and api_tokens.go unchanged, untagged, unpushed. The tree is clean; sm-demo-app and summercms.go modules/bouncer are untouched.</done>
</task>
<task type="auto">
<name>Task 3: fill item 7 and reword the G3 refresh sentence in the escalation note, add the todo's Outcome, and commit both in summercms.go</name>
<files>.planning/notes/2026-10-22-external-user-plugin-escalations.md, .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md</files>
<precondition>Task 2's verify passed: sm-user-plugin master carries both commits. git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go diff --quiet HEAD -- on the note and the todo succeeds (no other session is editing them).</precondition>
<action>
Get the two short SHAs from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user:
- S1 = git log -1 --format=%h --fixed-strings --grep='rewrites that cookie, so an HttpOnly session survives' master
- S2 = git log -1 --format=%h --fixed-strings --grep='opt-in golem15.user.jwt.token_cookie' master
Edit .planning/notes/2026-10-22-external-user-plugin-escalations.md with Edit, using scoped replacements only, never a whole-file Write.
Tracker row 7, using rows 1-3 as the format:
- The Quick / todo cell becomes [261022-wah](../quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/) · [todo](../todos/pending/2026-10-22-user-login-opt-in-session-cookie.md).
- Status becomes done (unreleased).
- Shipped becomes `S1`, `S2` → v0.5.0.
- Label, Verdict and g15office stay.
Verdicts:
- **G3.**: replace only its third sentence, the one about /refresh and cookies, with: Item 7 (`S1`) made a `/refresh` carried by the `auth.cookie` cookie rewrite it; bearer- and `auth_token`-carried refreshes stay body-only. The other sentences stay.
- **7.**: in the "Done locally" format, it becomes: Done locally (`S1`, `S2`). `S1`: a `/refresh` carried by the `auth.cookie` cookie (`token` by default, no bearer) rewrites it and answers `{}`, whatever `token_cookie` says; bearer and other-cookie refreshes stay body-only; refusals write no cookie. `S2`: `golem15.user.jwt.token_cookie` (default off) makes /login, /register (auto sign-in) and /activate-by-code set the HttpOnly `auth.cookie` cookie via `bouncer.LoadCookieConfig` and omit body `token`; off keeps today's bodies. SameSite=Lax, no CSRF; API tokens untouched.
Reply to send, G3 paragraph: in its "Ships in SummerCMS v0.5.0 (sm-user-plugin 8e4b863, …)" line, keep everything up to the last sentence. Replace that sentence (it begins "A cookie-carried /refresh returns") with: A /refresh carried by the session cookie named in auth.cookie (token by default) rewrites that cookie with the rotated token and answers {} (see "Cookie on /login" below). A /refresh carried by the Authorization header, or by the auth_token cookie, returns the rotated token in the body and writes no cookie; the previous token is revoked, so store the new one yourself.
Reply to send, "Cookie on /login": keep the "Agreed as an opt-in. …" line. Replace the TODO line under it with one line in the G2-G4 format:
Ships in SummerCMS v0.5.0 (sm-user-plugin S1 and S2, tagged with that wave): set golem15.user.jwt.token_cookie: true (default false) and POST /login, POST /register (when it signs the new account in) and POST /activate-by-code set the HttpOnly session cookie with the auth.cookie attributes (bouncer.LoadCookieConfig: name token, path /, SameSite=Lax, Secure from app.url, Max-Age the refresh window) and leave token out of the body; user (and message) stay. A POST /refresh carried by that cookie rewrites it with the rotated token and answers {}; a bearer refresh is unchanged. With the key off nothing changes. SameSite stays Lax and there is no CSRF token. Keep auth.cookie.name at token or auth_token, the cookies the session routes read.
In both reply lines, substitute the real S1 and S2, unquoted, as G2-G4 do. Leave item 8's TODO line and everything else in the note unchanged.
Edit the todo .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md. Insert an "## Outcome (2026-10-22)" section after the "## Note from G3 (2026-10-22)" paragraph and before "## Invoke", in the format of 2026-10-22-user-logout-blacklist-missing-under-serve.md. It is one paragraph that:
- names quick `261022-wah`, the two commits `S1` and `S2` on sm-user-plugin master and their base `a484d0e`;
- describes S1: /refresh rewrites the auth.cookie cookie when it carried the token without a bearer header, answers {} and keeps bearer and auth_token refreshes body-only; classes.SessionTokenCookie is the new export; TestRefreshRewritesAuthCookie and TestSessionTokenCookie cover it;
- describes S2: golem15.user.jwt.token_cookie on /login, /register and /activate-by-code through writeSession; the auth.cookie config is loaded before any side effect, so a broken block answers the opaque 500; README and config.yaml updated; TestTokenCookie covers it;
- ends with: Reply note item 7 and the G3 refresh sentence filled. Not tagged, not pushed: ships with the v0.5.0 wave.
Leave the todo in pending/.
Commit exactly these two files with a pathspec commit, so nothing else in the index is included:
git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go commit -m "docs: fill item 7 in the external-escalation reply" -- .planning/notes/2026-10-22-external-user-plugin-escalations.md .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
No trailer. Do not touch STATE.md, state.json, the PLAN, the SUMMARY or any other file; the orchestrator commits those and handles STATE and g15office. Do not push.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/summercms.go && N=.planning/notes/2026-10-22-external-user-plugin-escalations.md && T=.planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md && P=/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && S1=$(git -C "$P" log -1 --format=%h --fixed-strings --grep='rewrites that cookie, so an HttpOnly session survives' master) && S2=$(git -C "$P" log -1 --format=%h --fixed-strings --grep='opt-in golem15.user.jwt.token_cookie' master) && test -n "$S1" && test -n "$S2" && grep -qE '^\| 7 \| Cookie option on `/login` \| Feature \| \[261022-wah\]\(\.\./quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/\) · \[todo\].*\| strnsccy \| done \(unreleased\) \| `[0-9a-f]{7,}`, `[0-9a-f]{7,}` → v0\.5\.0 \|$' "$N" && grep -qF "\`$S1\`, \`$S2\` → v0.5.0" "$N" && grep -qF "**7.** Done locally (\`$S1\`, \`$S2\`)" "$N" && grep -qF "Item 7 (\`$S1\`)" "$N" && grep -qF "Ships in SummerCMS v0.5.0 (sm-user-plugin $S1 and $S2, tagged with that wave)" "$N" && grep -qF 'golem15.user.jwt.token_cookie' "$N" && grep -qF 'rewrites that cookie with the rotated token' "$N" && ! grep -qF 'does not rewrite a cookie' "$N" && ! grep -qF 'does not rewrite the cookie' "$N" && test "$(grep -c '^TODO' "$N")" = 1 && grep -qF 'TODO: ships in SummerCMS v0.5.0 — config key <name>.' "$N" && grep -qF 'Ships in SummerCMS v0.5.0 (sm-user-plugin 8e4b863, tagged with that wave)' "$N" && grep -qF 'Ships in SummerCMS v0.5.0 (sm-user-plugin 4bf44fc, tagged with that wave)' "$N" && grep -q '^## Outcome' "$T" && awk '/^## Note from G3/{g=NR} /^## Outcome/{o=NR} /^## Invoke/{i=NR} END{exit !(g && o && i && g<o && o<i)}' "$T" && grep -qF "$S1" "$T" && grep -qF "$S2" "$T" && grep -qF 'a484d0e' "$T" && test ! -e .planning/todos/done/2026-10-22-user-login-opt-in-session-cookie.md && C=$(git log -1 --format=%H --fixed-strings --grep='docs: fill item 7 in the external-escalation reply') && test -n "$C" && git merge-base --is-ancestor ec69f54 "$C" && F=$(git show --name-only --format= "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "$N $T " && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet HEAD -- "$N" "$T" && test -z "$(git branch -r --contains "$C")"</automated>
</verify>
<done>Escalation note row 7 reads done (unreleased) with `S1`, `S2` → v0.5.0 and links the quick and the todo. Verdict 7 says "Done locally" with both SHAs, and the G3 verdict's refresh sentence names item 7. The G3 reply now says a refresh carried by the auth.cookie cookie rewrites it while bearer and auth_token refreshes stay body-only. The Cookie-on-/login reply carries the "Ships in SummerCMS v0.5.0 (sm-user-plugin S1 and S2, tagged with that wave)" line naming golem15.user.jwt.token_cookie. Only item 8's TODO line remains. The todo has an Outcome section between Note from G3 and Invoke, naming both commits, the base and the tests, and it is still in pending/. One docs commit in summercms.go touches exactly those two files: no trailer, not pushed. Nothing else in summercms.go was touched.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| browser JavaScript to the session token | a token in a JSON body or a JS-readable cookie is exposed to any script on the page (XSS) |
| browser to /refresh and the cookie-carried session routes | the cookie travels on requests the browser makes on its own, including cross-site ones subject to SameSite |
| request carriers (Authorization header, token and auth_token cookies) | an untrusted request may carry several tokens; which one is rotated and which cookie is written must follow one fixed order |
| operator configuration (auth.cookie.*, golem15.user.jwt.token_cookie) | an invalid block must fail loudly without half-done account changes |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-wah-01 | Information disclosure | session token in the /login, /register, /activate-by-code and cookie-refresh bodies | medium | mitigate | With token_cookie on, the token goes only into the HttpOnly cookie (writeSession omits the body key; Task 2). A cookie-carried refresh answers {} (Task 1). TestTokenCookie and TestRefreshRewritesAuthCookie assert the exact key sets. |
| T-wah-02 | Spoofing | cross-site requests riding the session cookie (CSRF) on /refresh and the signed-in routes | medium | accept | Locked L-4: SameSite stays Lax (the auth.cookie default, from LoadCookieConfig only), which keeps the cookie off cross-site POSTs; no CSRF token; change-password still needs the current password. The README says not to set same_site none for this cookie. |
| T-wah-03 | Tampering | carrier confusion: rotating one token and writing it into another carrier's cookie, or writing over an app-owned cookie | medium | mitigate | SessionTokenCookie mirrors SessionToken's order through one shared bearerToken parser, and returns "" whenever a bearer supplied the token. Refresh rewrites only when that carrier equals auth.cookie.name. Tests: bearer wins over a cookie, auth_token stays body-only, a configured name, and the TestSessionTokenCookie table. |
| T-wah-04 | Elevation of privilege | an HttpOnly cookie left holding a rotated (blacklisted) jti after /refresh, so the session dies or the client resends a dead token | high | mitigate | Task 1 rewrites the auth.cookie cookie on every successful cookie-carried refresh. The rotated cookie is proven to authenticate and the old token to be refused. Refusals write nothing, so no cookie gets a token that was not issued. |
| T-wah-05 | Denial of service | a broken auth.cookie block half-completing a request (account created, activation code consumed, login recorded, token rotated) before answering 500 | medium | mitigate | QD-4: the three routes load the config right after sessionDeps, and /refresh loads it before bouncer.Refresh. TestTokenCookie checks that no users row exists, the user is not activated with the code still usable, and last_seen and the throttle row are unwritten. TestRefreshRewritesAuthCookie checks that the token still refreshes by bearer. |
| T-wah-06 | Denial of service | a core plugin's existing body-token clients broken by the change | high | mitigate | token_cookie defaults to false, and sessionCookie then never reads auth.cookie. writeSession with a nil config writes the same key set as today, so the bytes are unchanged. Bearer and auth_token refreshes are unchanged and the bearer path never reads auth.cookie. TestLogin, TestRegister, TestActivateByCode and the "off by default" subtest pin it. The only changed answer (the token-cookie refresh) was never released (QD-6). |
| T-wah-07 | Information disclosure | a session cookie without Secure on an https site | low | transfer | bouncer.LoadCookieConfig derives Secure from app.url and refuses a Secure that resolves to false in production; the plugin passes those attributes through unchanged. Operators keep app.url correct. |
| T-wah-SC | Tampering | npm/pip/cargo/Go module installs | low | accept | No dependency is added; go.mod and go.sum are unchanged (both plugin commit gates check it). No package-legitimacy checkpoint is needed. |
</threat_model>
<verification>
- sm-user-plugin: GOWORK=off go vet ./..., GOWORK=off go test -short -count=1 ./... and GOWORK=off go test -count=1 ./... are green at both commits.
- TestRefreshRewritesAuthCookie was red at a484d0e and is green at the first commit. TestTokenCookie was red at the first commit and is green at the second.
- The sociallogin and oauthserver suites, run through sm-demo-app's go.work against this checkout, have their result recorded in the SUMMARY.
- Two local commits on sm-user-plugin master: no trailer, not pushed, not tagged, go.mod/go.sum unchanged. The sm-demo-app pointer is neither staged nor committed; summercms.go modules/bouncer is unmodified.
- One docs commit in summercms.go touches exactly the escalation note and the todo.
</verification>
<success_criteria>
- An application can opt in with golem15.user.jwt.token_cookie: true and keep the session in an HttpOnly cookie across sign-in, registration, activation by code, refresh and fetch, with no token in any body.
- With the key off, every existing response of the plugin is byte-identical, apart from the never-released token-cookie refresh answer.
- A refresh rotates exactly the cookie that carried the token when that cookie is the auth.cookie cookie, and nothing else; bearer refreshes never read auth.cookie.
- Item 7 is recorded as done (unreleased) with both SHAs, the G3 refresh wording is corrected, and the reply is ready apart from item 8.
</success_criteria>
<output>
Create `.planning/quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/261022-wah-SUMMARY.md` in summercms.go when done. Include:
- both plugin commits' short SHAs and the base;
- both RED failure lines;
- the suite results and the consumer cross-check result;
- the docs commit SHA in summercms.go;
- a confirmation that nothing was pushed, tagged or pointer-bumped.
Do not commit the SUMMARY; the orchestrator commits it with the PLAN and STATE.
</output>

View File

@@ -0,0 +1,124 @@
---
phase: quick-261022-wah
plan: 01
quick_id: 261022-wah
subsystem: sm-user-plugin (sessions)
status: complete
tags: [user-plugin, jwt, cookie, refresh, escalation-item-7]
requires: [sm-user-plugin a484d0e, summercms bouncer.LoadCookieConfig / CookieConfig.TokenCookie]
provides:
- classes.SessionTokenCookie(r)
- golem15.user.jwt.token_cookie (default false)
- cookie-carried POST /refresh rewrites the auth.cookie cookie
affects: [golem15.sociallogin token_cookie sessions now survive /refresh]
tech-stack:
added: []
patterns: [writeSession cookie-or-body 200 writer (twin of sociallogin writeSession), config loaded before side effects]
key-files:
created:
- ../sm-demo-app/plugins/golem15/user/refresh_cookie_test.go
- ../sm-demo-app/plugins/golem15/user/token_cookie_test.go
modified:
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/session_cookie_test.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
decisions:
- "Cookie-carried /refresh answers {} and rewrites only the cookie named auth.cookie.name, independent of token_cookie; bearer and auth_token refreshes stay body-only"
- "golem15.user.jwt.token_cookie (default off) on /login, /register (token branch), /activate-by-code; auth.cookie loaded right after sessionDeps so a broken block answers the opaque 500 before any side effect"
metrics:
duration: ~12 min
completed: 2026-10-22
actuals:
tokens: 15500
tasks: 3
commits: 2
plan_head_before: a484d0e
plan_head_after: 8bdf2c7
---
# Quick 261022-wah: Opt-in HttpOnly session cookie and cookie-carried /refresh rotation Summary
sm-user-plugin now rewrites the `auth.cookie` session cookie on a cookie-carried `POST /refresh` (body `{}`). A new opt-in key, `golem15.user.jwt.token_cookie`, makes `/login`, `/register` and `/activate-by-code` put the session token into that HttpOnly cookie instead of the body. Both go through one `writeSession` helper that mirrors sociallogin's.
## Commits
sm-user-plugin master, base `a484d0e` (master had not moved). Local only.
| Task | Commit | Subject |
|------|--------|---------|
| 1 | `846087d` | fix: a /refresh carried by the auth.cookie session cookie rewrites that cookie, so an HttpOnly session survives the rotation |
| 2 | `8bdf2c7` | feat: opt-in golem15.user.jwt.token_cookie sets the HttpOnly session cookie on /login, /register and /activate-by-code instead of returning the token |
| 3 | `6a1974c` (summercms.go) | docs: fill item 7 in the external-escalation reply |
`commits: 2` counts the plugin repo (`git rev-list --count a484d0e..master`). The docs commit `6a1974c` is in summercms.go on top of `ec69f54`.
## RED evidence
- Task 1, at `a484d0e`: `refresh_cookie_test.go:33: body keys [token], want []: {"token":"eyJ..."}` (TestRefreshRewritesAuthCookie/token_cookie_rotates). The body key-set assertion runs before the cookie assertion, so it failed there first. "configured auth.cookie name" and "broken auth.cookie" (200 instead of 500) failed too.
- Task 2, at `846087d`: `token_cookie_test.go:58: body keys [token user], want [user]` (TestTokenCookie/on). "on with configured auth.cookie" and "on with a broken auth.cookie" (200 instead of the opaque 500) failed too.
## Suite results
- Both commits: `GOWORK=off go vet ./...`, `go test -short -count=1 ./...` and the full Docker-backed `go test -count=1 ./...` were green. Docker was reachable directly, without sudo.
- TestLogin, TestRegister and TestActivateByCode pass unchanged (they pin the default-off behaviour).
- Consumer cross-check from sm-demo-app (`go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/oauthserver/...` via go.work against this checkout):
- Every session, cookie and token test passes, including sociallogin `TestTokenCookieMode`, which was also run on its own.
- Three failures are unrelated to this change. Each is a source-file path lookup relative to the plugin dir, and all are environmental:
- sociallogin `TestPHPMethodMap`: `lstat ../fonoteka.go/plugins/golem15/user: no such file or directory`
- oauthserver `TestClientRegistry/verify_secret_uses_constant_time_comparison`: `open ../summercms.go/modules/wristband/oidc_token.go`
- oauthserver `TestPHPMethodMap`: `lstat ../summercms.go/modules/wristband`
- These repos were not patched.
## What was built
- `classes.SessionTokenCookie(r)` returns the name of the session cookie that supplied `SessionToken`'s token, or `""` when a bearer header supplied it or there is none. It uses the unexported `bearerToken(r)` helper, which `sessionTokens` now uses too, so the bearer-then-cookies order lives in one place.
- `controllers` gains three helpers:
- `tokenCookieConfig`: a nil-safe `bouncer.LoadCookieConfig`.
- `writeSession`: writes the cookie and leaves the token out of the body, or puts the token in the body and sets no cookie.
- `sessionCookie`: reads the `token_cookie` flag and returns the cookie config when it is on.
- `Refresh` loads `auth.cookie` only for a cookie-carried request, and does so before `bouncer.Refresh`. A broken block therefore answers the opaque 500 without rotating anything, and bearer refreshes never read the block.
- `Login`, `Register` (token branch) and `ActivateByCode` call `sessionCookie` right after `sessionDeps`, before any side effect, and answer through `writeSession`. `api_tokens.go`, `mintFor` and `IssueToken` are untouched.
- `config.yaml` has `jwt.token_cookie: false` with a comment.
- The README has the new config row, the JWT sessions bullet (cookie refresh, token_cookie, SameSite/CSRF note, broken-block behaviour, API tokens unaffected), `SessionTokenCookie` in the API reference, and Testing paragraphs.
- The escalation note now has:
- row 7 marked done (unreleased), with `846087d`, `8bdf2c7` → v0.5.0;
- verdicts G3 and 7 updated;
- the G3 reply sentence reworded;
- a "Cookie on /login" reply line.
Only item 8's TODO line remains. The todo has an Outcome section and stays in `pending/`.
## Deviations from Plan
- **Test helper shape:** the plan asked for "a small decoder that returns the body as map[string]any". It is folded into `assertBodyKeys(t, rec, keys...)`, which decodes the body, asserts the exact key set and returns the map.
- **Shared test constants:** `opaque500Body` lives in `refresh_cookie_test.go`. The route-path constants and the small helpers (`inactiveUser`, `activationCode`, `assertCookieServes`, `assertOpaque500`, `tokenCookieSettings`, `registerBody`) live in `token_cookie_test.go`.
- **[Rule 1 - Bug, own test]** The first draft of TestTokenCookie compared the 401 message against `invalidLoginBody`. In the test package that constant is the whole JSON body, so the test now compares the full body. This was fixed before GREEN and never committed.
- **Escalation note, line 51** ("remaining are item 7 (cookie) then item 8") was left unchanged as the plan required. It is now slightly stale.
## Known Stubs
None.
## Threat Flags
None. No new endpoints were added. The cookie attributes come only from `bouncer.LoadCookieConfig`, which matches the plan's threat model.
## Release hold
Nothing was pushed or tagged:
- neither plugin commit is on a remote branch, and neither is tagged;
- go.mod and go.sum are unchanged;
- the sm-demo-app `plugins/golem15/user` pointer was neither staged nor committed;
- summercms.go `modules/bouncer` is unmodified.
STATE.md, PLAN, CONTEXT and this SUMMARY are left for the orchestrator to commit.
## Self-Check: PASSED
- Files exist: refresh_cookie_test.go, token_cookie_test.go, session_user.go, api_controller.go, config.yaml, README.md, the note and the todo.
- Commits exist: `846087d` and `8bdf2c7` (sm-user-plugin), `6a1974c` (summercms.go).
- All three task `<verify>` gates printed VERIFY-OK.

View File

@@ -0,0 +1,112 @@
---
phase: quick-261022-wah
verified: 2026-10-22T22:05:00Z
status: passed
score: 8/8 must-haves verified
covered_files:
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/261022-wah-CONTEXT.md
- .planning/quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/261022-wah-PLAN.md
- .planning/quick/261022-wah-opt-in-httponly-session-cookie-on-user-p/261022-wah-SUMMARY.md
- .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md
covered_digest: "v2:sha256:fa87e2eb366a276afffe8caacff6898c96904138aef15acac2fb56ac23889f8b"
behavior_unverified: 0
overrides_applied: 0
---
# Quick 261022-wah: Opt-in HttpOnly session cookie and cookie-carried /refresh rotation. Verification Report
**Goal:** Opt-in HttpOnly session cookie on user-plugin POST /login (`golem15.user.jwt.token_cookie`, default off) plus /register and activate-by-code, attributes from auth.cookie via `bouncer.LoadCookieConfig`, body token omitted when the cookie is set (like sociallogin `writeSession`). A POST /refresh carried by the auth.cookie cookie rotates that cookie (body `{}`); bearer-only and other-cookie refreshes stay body-only. SameSite=Lax, no CSRF. With the key off, existing responses stay byte-identical.
**Verified:** 2026-10-22
**Status:** passed
**Re-verification:** No (initial verification)
Note on fingerprint scope: the plugin source files live in a sibling repo (`../sm-demo-app/plugins/golem15/user`, sm-user-plugin commits `846087d`, `8bdf2c7` on `a484d0e`). `verification.fingerprint` refuses paths outside the summercms.go root, so `covered_files` lists only the in-root planning files. The plugin code was verified directly at HEAD `8bdf2c7`.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | token_cookie off (the default): /login and /register answer `{token,user}`, /activate-by-code answers `{message,token,user}`, no cookie; TestLogin, TestRegister and TestActivateByCode are unchanged and green | VERIFIED | `writeSession` with `cc == nil` sets `body["token"]` and calls the same `writeJSON`. `wire.WriteJSON` encodes maps with sorted keys, so the bytes match the old literal maps. `sessionCookie` returns nil without reading auth.cookie when the key is off. TestTokenCookie/off_by_default asserts exact key sets and no cookie (PASS). The diff does not touch session_test.go, register_test.go or account_test.go, and those tests pass. |
| 2 | token_cookie on: the three routes return no `token` key, set exactly one auth.cookie cookie with the LoadCookieConfig attributes, HttpOnly and Max-Age refresh_ttl, and that cookie authenticates /fetch | VERIFIED | `Login`, `Register` (token branch) and `ActivateByCode` call `writeSession(w, app, cc, …)`, and `cc.TokenCookie(token, refreshTTL(app))` writes the cookie. TestTokenCookie/on and on_with_configured_auth.cookie pass: exact body keys, `assertSessionCookie` compares the cookie against `cfg.TokenCookie` attributes and Max-Age 20160*60 or 3600, and `assertCookieServes` checks /fetch. |
| 3 | A cookie-carried (auth.cookie name, no bearer) /refresh returns 200 `{}` with one rotated Set-Cookie, with token_cookie on or off; the new token authenticates /fetch and jwt.auth, and the old token is refused | VERIFIED | `Refresh`: `classes.SessionTokenCookie(r)` gives the carrier name, `rotate = &cc` when `cc.Name == name`, then `writeSession(w, app, rotate, next, map[string]any{})`. TestRefreshRewritesAuthCookie/token_cookie_rotates (token_cookie off) and TestTokenCookie/on (token_cookie on) pass, and both check the old token gets 401 and the new token reaches /fetch and `guarded`. |
| 4 | A bearer refresh (also with the cookie present) or an other-cookie refresh answers exactly `{token}` and sets no cookie | VERIFIED | `SessionTokenCookie` returns "" when `bearerToken(r)` is non-empty, and `rotate` stays nil when the carrier name differs from `cc.Name`. These subtests pass: bearer_wins_over_the_cookie (cookie B is not rotated), bearer_only, auth_token_cookie_stays_body-only, and configured_auth.cookie_name (a token-cookie refresh is body-only when name=auth_token). |
| 5 | A refused refresh (401) sets and forgets no cookie. A broken auth.cookie gives a cookie-carried refresh the opaque 500 before rotation, and the token still refreshes by bearer. With token_cookie on, the three routes answer 500 before any side effect. A bearer refresh never reads auth.cookie | VERIFIED | The config load sits before `bouncer.Refresh` and only inside `if name := SessionTokenCookie(r); name != ""`. `sessionCookie` runs right after `sessionDeps` in all three routes. Passing tests: refusals_set_no_cookie (banned and blacklisted), broken_auth.cookie (500, then a bearer refresh of the same token returns 200), and TestTokenCookie/on_with_a_broken_auth.cookie (no last_seen, no throttle row, no user row, not activated; after the config is fixed the same code activates). |
| 6 | POST /tokens is unchanged and sets no cookie when token_cookie is on | VERIFIED | `git diff a484d0e..HEAD` shows no change to `controllers/api_tokens.go` or `classes/registration.go`. TestTokenCookie/on: POST /tokens returns 201 `{token,meta}` and `assertNoCookie` passes. |
| 7 | Two local commits on top of a484d0e (refresh first, then token_cookie), green; no trailer; not pushed or tagged; go.mod and go.sum unchanged; sm-demo-app pointer not committed or staged | VERIFIED | `git log`: `a484d0e` → `846087d` (fix: refresh) → `8bdf2c7` (feat: token_cookie). Neither commit body has a trailer. `git branch -r --contains 846087d` and `git tag --contains 846087d` print nothing. The go.mod/go.sum diff is empty. sm-demo-app `git ls-tree HEAD plugins/golem15/user` still points to `930b158`, nothing is staged, and the last pointer commit is `e587980`. I re-ran the checks at HEAD: vet OK, `-short` OK, and the full Docker suite OK. At `846087d` (a `git archive` copy with the replace path made absolute): vet OK, and the Docker cookie, refresh and login tests pass. One `-short` failure in that copy, TestRegisterCORSPath, comes from the copy's location: it reads `appRoot/config/http.yaml`, which is outside the plugin. |
| 8 | Escalation note row 7 reads done (unreleased) with both SHAs and v0.5.0; verdicts 7 and G3 and the G3 and Cookie-on-/login replies describe the shipped behaviour and name the key; only item 8's TODO remains; the todo has an Outcome and stays in pending; the commit touches only those two files | VERIFIED | `git show --stat 6a1974c` lists exactly the 2 files. Row 7: `done (unreleased) \| 846087d, 8bdf2c7 → v0.5.0`. Both the G3 and 7 verdicts are rewritten. The G3 reply sentence about /refresh is reworded, and the "Cookie on /login" reply names `golem15.user.jwt.token_cookie`. `grep '^TODO'` finds only line 100 (item 8). The todo has `## Outcome (2026-10-22)` before `## Invoke` and is still under `todos/pending/`. |
**Score:** 8/8 truths verified (0 present, behavior-unverified)
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| `classes/session_user.go` | `func SessionTokenCookie(r *http.Request) string`; bearer parsing shared with `sessionTokens` | VERIFIED | Present. `bearerToken` is used by both `SessionTokenCookie` and `sessionTokens`. Nil-safe. |
| `controllers/api_controller.go` | `tokenCookieConfig`, `writeSession(w, app, cc, token, body)`, `sessionCookie`; Refresh and the three routes wired | VERIFIED | All three helpers are present with the planned signature. There are 4 `writeSession` call sites (Login, Refresh, ActivateByCode, Register token branch). Register's admin and user mode bodies are unchanged. |
| `config/config.yaml` | `token_cookie: false` with a comment | VERIFIED | Lines 106-110. |
| `refresh_cookie_test.go` | TestRefreshRewritesAuthCookie, TestSessionTokenCookie, assertSessionCookie, assertNoCookie | VERIFIED | 261 lines. 7 Docker subtests and a 7-row `-short` table plus the nil case. |
| `token_cookie_test.go` | TestTokenCookie: off, on, configured, broken | VERIFIED | 237 lines, 4 subtests, all with substantive assertions. |
| `README.md` | config row, JWT sessions bullet, SessionTokenCookie in the API reference, Testing paragraphs | VERIFIED | All four are present. The old "writes no cookie" sentence is replaced. |
| escalation note | row 7, verdicts, replies | VERIFIED | See truth 8. |
| todo | `## Outcome` | VERIFIED | See truth 8. |
### Key Link Verification
| From | To | Via | Status | Details |
|------|----|-----|--------|---------|
| `Refresh` | `classes.SessionTokenCookie` / `SessionToken` | rewrite only when the carrier name == `auth.cookie.name` | WIRED | `if name := classes.SessionTokenCookie(r); name != ""` … `if cc.Name == name { rotate = &cc }`. TestSessionTokenCookie checks that the named cookie carries exactly `SessionToken`'s value. |
| `writeSession` / `tokenCookieConfig` | `bouncer.LoadCookieConfig`, `CookieConfig.TokenCookie` | `cc.TokenCookie(token, refreshTTL(app))` | WIRED | Attributes come only from LoadCookieConfig. The plugin adds no SameSite or Secure code of its own. |
| written cookie | jwt guard / `SessionCookieNames` | the guard reads token and auth_token | WIRED | `SessionCookieNames` is unchanged. `assertCookieServes` and `guarded` pass for both the `token` and `auth_token` names. |
| commit SHAs | note row 7 / verdict 7 / reply | `→ v0.5.0` | WIRED | The SHAs in the note match the actual commits. |
### Data-Flow Trace (Level 4)
Not applicable. The phase changes HTTP response writers, not rendered data. Cookie values are traced end to end by the tests: login or refresh, then the Set-Cookie value, then /fetch through that cookie as the same user sub.
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| vet at HEAD | `GOWORK=off go vet ./...` | clean | PASS |
| short suite at HEAD | `GOWORK=off go test -short -count=1 ./...` | all ok | PASS |
| full Docker suite at HEAD (run once) | `GOWORK=off go test -count=1 ./...` | all ok (root package 54s) | PASS |
| named cookie and session tests at HEAD | `go test -v -run 'TestRefreshRewritesAuthCookie\|TestSessionTokenCookie\|TestTokenCookie\|TestSessionRoutesAcceptCookies\|TestLogin$\|TestRegister$\|TestActivateByCode$\|TestRefresh$'` | every test and subtest PASS | PASS |
| commit 1 on its own (`846087d`, scratch archive) | vet, plus the Docker refresh and cookie tests | vet OK, tests ok | PASS |
### Probe Execution
None declared. The plan's `<verify>` gates are executor-side. Behaviour was checked with the tests above instead.
### Requirements Coverage
| Requirement | Description | Status | Evidence |
|-------------|-------------|--------|----------|
| wah-1 | cookie-carried /refresh rewrites the auth.cookie cookie; bearer and other-cookie refreshes stay body-only; refusals write no cookie | SATISFIED | Truths 3, 4, 5 |
| wah-2 | token_cookie on /login, /register, /activate-by-code; off is byte-identical; a config error gives the opaque 500 | SATISFIED | Truths 1, 2, 5, 6 |
| wah-3 | escalation note item 7, G3 reword, todo Outcome; separate docs commit | SATISFIED | Truth 8 |
### Anti-Patterns Found
| File | Line | Pattern | Severity | Impact |
|------|------|---------|----------|--------|
| (plugin diff a484d0e..8bdf2c7) | none | TBD/FIXME/XXX/TODO/HACK in added lines | none | clean |
| `.planning/notes/2026-10-22-external-user-plugin-escalations.md` | 100 | `TODO:` (item 8) | Info | Pre-existing. The plan requires it to stay, since item 8 is out of scope. |
| `.planning/notes/2026-10-22-external-user-plugin-escalations.md` | 51 | "remaining are item 7 … then item 8" | Info | Slightly out of date now. The SUMMARY says it was left as planned. |
| `controllers/api_controller.go` Refresh | config-load block | broken auth.cookie also gives an `auth_token`-carried refresh the 500 | Info | Matches the must-have ("a cookie-carried refresh answers the opaque 500"). A broken auth.cookie block is a deploy-time misconfiguration. |
| `controllers/api_controller.go` Register | after sessionDeps | with token_cookie on and a broken auth.cookie, /register gives the 500 even in user or admin activate mode, which would not set a cookie | Info | Intentional (QD-4: fail before side effects). No effect while the key is off. |
### Human Verification Required
None. Every truth is exercised through the real router (surf.Assemble with the jwt guard) on Postgres via testcontainers, including cookie attributes, rotation and refusal.
### Gaps Summary
None found. The code matches the plan and the SUMMARY. Default-off bodies are byte-identical because the same sorted-key map encoding is used. Cookie attributes come only from `bouncer.LoadCookieConfig`. The refresh carrier detection shares one bearer parser with `SessionToken`. Every must-have truth has a test, and those tests pass at HEAD. The release hold is intact: nothing pushed or tagged, no pointer bump, go.mod and go.sum unchanged. Not re-run by this verifier: the SUMMARY's consumer cross-check from sm-demo-app (sociallogin `TestTokenCookieMode`).
---
_Verified: 2026-10-22_
_Verifier: Claude (msd-verifier)_

View File

@@ -0,0 +1,308 @@
---
phase: quick-261022-x7a
plan: 01
quick_id: 261022-x7a
slug: user-plugin-golem15-user-password-public
type: execute
mode: quick
wave: 1
depends_on: []
autonomous: true
requirements:
- x7a-1 # golem15.user.password.public_routes (default true, config.yaml next to password.min_length): false leaves POST /login, /forgot-password and /reset-password unregistered so they get the router's own 404 like any unknown path; every other route, its middleware and the turnstile guard on /register unchanged; unset/true = byte-identical route table; no pact/surf change, no custom 404
- x7a-2 # tests (route-table recording like turnstile_routes_test, real-router 404 probe against an unknown path and the current statuses) and README, in the same plugin commit; existing tests keep the default
- x7a-3 # escalation note item 8 (tracker, verdict, reply) and the todo's Outcome; a separate docs commit in summercms.go
files_modified:
# sm-user-plugin (module git.golem15.com/golem15/sm-user-plugin), worked in the sm-demo-app submodule checkout. Commit there only.
- ../sm-demo-app/plugins/golem15/user/routes.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/password_routes_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
# summercms.go planning docs, edited and committed by Task 2 (pathspec commit of exactly these two files)
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md
estimate:
tokens: 70000
raw_tokens: 70000
tasks: 2
confidence: low # estimate-calibration: factor 1, sample_count 0
must_haves:
truths:
- "With golem15.user.password.public_routes unset, true (bool or the string true) or at its config.yaml default, Routes registers exactly the 18 routes it registers at 8bdf2c7, in the same order with the same middleware; TestTurnstileRoutes and every existing test pass unchanged."
- "With the key false (bool, the string false, or SUMMER_GOLEM15__USER__PASSWORD__PUBLIC_ROUTES=false), Routes registers the same table minus exactly POST /_user/api/v1/login, /forgot-password and /reset-password (15 routes); every remaining route keeps its order and middleware, and with golem15.user.turnstile closed POST /register still carries turnstile:closed."
- "Through the assembled router with the key false, POST /login (correct password), POST /forgot-password (a real address), POST /reset-password (a valid code) and GET /login answer with the same status (404), body and Content-Type as the same method on an unknown /_user/api/v1 path, set no cookie, stamp no last_seen and send no mail; with the default they answer 401 invalid-login, 200 with message, 422 and 405 as today."
- "With the key false, POST /register (auto mode) still answers 200 with token and user, and that token is served by GET /fetch, rotated by POST /refresh and ended by POST /logout; GET /oauth-providers answers 200."
- "A value other than true, false, an empty string or null (for example nope, yes or 0) makes Routes return an error naming golem15.user.password.public_routes, so boot fails, as golem15.user.turnstile does."
- "One local feat commit on sm-user-plugin master on top of 8bdf2c7 touches exactly routes.go, config/config.yaml, password_routes_test.go and README.md; go vet, go test -short and the full Docker-backed suite are green; no trailer, not pushed, not tagged; go.mod, go.sum and controllers/ unchanged; the sm-demo-app pointer is neither committed nor staged."
- "Escalation note row 8 reads done (unreleased) with the short SHA → v0.5.0, verdict 8 and the Password-routes reply paragraph name golem15.user.password.public_routes and describe the shipped behaviour, no line starts with TODO, no tracker row is open; the todo has an Outcome and stays in pending/; both files are committed in summercms.go by a commit touching only them."
artifacts:
- path: ../sm-demo-app/plugins/golem15/user/routes.go
provides: "publicPasswordRoutes (default true, strict true/false parse, error naming the key); Routes skips the three password routes when it is false"
contains: "func (p *Plugin) publicPasswordRoutes() (bool, error)"
- path: ../sm-demo-app/plugins/golem15/user/config/config.yaml
provides: "password.public_routes: true with a comment, after min_length"
contains: "public_routes: true"
- path: ../sm-demo-app/plugins/golem15/user/password_routes_test.go
provides: "TestPasswordPublicRoutes (-short, route-table recording) and TestPasswordPublicRoutesAnswer404 (Docker, assembled router)"
contains: "func TestPasswordPublicRoutes"
- path: ../sm-demo-app/plugins/golem15/user/README.md
provides: "Password bullet sentence, API reference note, config table row, turnstile row clause, Testing paragraph"
contains: "golem15.user.password.public_routes"
- path: .planning/notes/2026-10-22-external-user-plugin-escalations.md
provides: "row 8 done (unreleased) with the SHA; verdict 8; Password-routes reply line filled; the order paragraph says all six are done"
contains: "golem15.user.password.public_routes: false"
- path: .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md
provides: "## Outcome section between ## Solution and ## Invoke"
contains: "## Outcome"
key_links:
- from: ../sm-demo-app/plugins/golem15/user/routes.go (Routes)
to: ../sm-demo-app/plugins/golem15/user/routes.go (publicPasswordRoutes)
via: "Routes calls publicPasswordRoutes once, returns its error, and wraps exactly the /login, /forgot-password and /reset-password registrations in the public branch; /login keeps guard... inside that branch"
pattern: "publicPasswordRoutes\\(\\)"
- from: ../sm-demo-app/plugins/golem15/user/config/config.yaml (password.public_routes)
to: "compass MergePlugin (party.Activate) and publicPasswordRoutes via app.Config.Lookup"
via: "the default reaches the app as golem15.user.password.public_routes; an unset key (bareApp merges no plugin config) also means true, so the default never depends on the merge"
pattern: "golem15\\.user\\.password\\.public_routes"
- from: "surf.Assemble (newAdminEnv)"
to: "Plugin.Routes"
via: "configure functions run after party.Activate and before surf.Assemble, so a configured false is what Routes reads; Routes runs once, so a later Config.Set does not change the table (a restart applies the key)"
pattern: "surf\\.Assemble"
- from: Task 1 commit SHA (sm-user-plugin master)
to: .planning/notes/2026-10-22-external-user-plugin-escalations.md row 8, verdict 8 and the reply
via: "Task 2 reads the SHA with git log --format=%h --fixed-strings --grep=golem15.user.password.public_routes"
pattern: "→ v0\\.5\\.0"
---
<objective>
Close external escalation item 8 in sm-user-plugin: a config switch that stops the user plugin registering its three password routes, so they answer 404 like any unknown path.
The external app wants `/login`, `/forgot-password` and `/reset-password` to 404 (it signs users in another way). It asked for a framework seam to wrap another plugin's routes; none is needed, because the user plugin owns those routes and can skip registering them. Leaving them unregistered gets the router's own 404 (and no 405 that would reveal them), with no custom handler.
Purpose: an application that does not offer password sign-in can remove those endpoints with one key, without any change for the many applications that use them.
Output: one local feat commit on sm-user-plugin master, made in /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user with git -C; then the escalation note and the todo filled and committed in summercms.go as a separate docs commit. No push, no tag and no sm-demo-app pointer commit (SummerCMS v0.5.0 release hold). summercms.go code (pact, surf, compass) is not modified.
Locked by the todo spec (.planning/todos/pending/2026-10-22-user-password-routes-404-switch.md, authoritative; labelled here for traceability, the executor does not revisit them):
- L-1 Key golem15.user.password.public_routes, default true, in config/config.yaml next to password.min_length.
- L-2 When false, POST /login, POST /forgot-password and POST /reset-password are not registered, so they 404 like any unknown path. No custom 404 handler.
- L-3 Everything else stays registered: /register (allow_registration already refuses at the handler), /activate, /activate-by-code, /fetch, /refresh, /logout, /update, /change-password, /marketing-consent, /avatar*, /oauth-providers, /tokens. golem15.user.turnstile still wraps /register when /login is off.
- L-4 No change in pact or surf. With the key on (the default) the route table is byte-identical to today's.
- L-5 Tests reuse the turnstile_routes_test.go recording pattern (recordingRouter, recordedRoute), probe 404 against the current login/forgot/reset statuses, and existing tests keep the default.
- L-6 Base sm-user-plugin 8bdf2c7. Hold push and tag for SummerCMS v0.5.0; do not bump the sm-demo-app pointer.
- L-7 Fill item 8 in the escalation note like the earlier rows (done (unreleased), the commit → v0.5.0, name the key) and replace the TODO in the reply paragraph. Leave the todo in pending with an Outcome. Do not send the reply.
Planner's choices (the executor does not revisit them):
- QD-1 The key is read by a new method publicPasswordRoutes() (bool, error) in routes.go, next to turnstileGuard, called once by Routes. It reads app.Config.Lookup, not app.Config.Bool: Bool reads an unset key as false, and bareApp (the -short harness) merges no plugin config, so Bool alone would drop the routes whenever config.yaml is not merged. Unset, nil and an empty (trimmed) string mean true. A bool is used as is. A string is trimmed and parsed with strconv.ParseBool (so an env value works). Any other value or an unparseable string returns an error naming the key, so boot fails, like golem15.user.turnstile in the same file; a typo cannot silently 404 the login of a production site.
- QD-2 The key is read when the routes are built (surf.Assemble at boot). Changing it needs a restart; the README says so. Handlers read their other keys per request; this one cannot, because an unregistered route has no handler.
- QD-3 Only routes.go changes in Go code. controllers/ (Login, ForgotPassword, ResetPassword stay exported and untouched), pact and surf are not modified. The direct-handler tests (account_test.go, mail_test.go, session_test.go) are unaffected by construction.
- QD-4 Tests live in a new file, password_routes_test.go: TestPasswordPublicRoutes (-short, recordingRouter on bareApp-style apps) and TestPasswordPublicRoutesAnswer404 (Docker, newAdminEnv). TestTurnstileRoutes and recordUserRoutes stay as they are. The 404 probe compares against the same method on an unknown path in the same env, so it pins "like any unknown path" without hard-coding surf's 404 text.
- QD-5 One plugin commit (feat), README in the same commit (CLAUDE.md docs rule). The framework-repo planning docs are a separate docs commit staged by pathspec. The orchestrator's final quick commit (PLAN, SUMMARY, STATE) stays separate.
- QD-6 Compatibility: the key is additive and defaults to true, so every application keeps today's routes. The only boot-time behaviour added is the refusal of an invalid value of a key that did not exist before.
Source coverage audit:
| Source | Item | Covered by |
|--------|------|------------|
| GOAL / todo Solution, L-1, L-2 | key next to min_length, default true; false skips the three POST routes; router's own 404 | Task 1 (routes.go, config.yaml, both tests) |
| L-3 | every other route stays; turnstile still wraps /register | Task 1 (route-table equality minus three, turnstile closed case, live /register, /fetch, /refresh, /logout, /oauth-providers) |
| L-4 | no pact/surf change; default byte-identical table | Task 1 (unset/true/config-default equality to the base table; commit gate checks the file list and controllers/) |
| L-5 | recording pattern reused; 404 vs current statuses; existing tests keep default | Task 1 (TestPasswordPublicRoutes, TestPasswordPublicRoutesAnswer404 default and off subtests; full suite) |
| CONTEXT specifics (orchestrator) | plugin README config key docs | Task 1 README edits |
| L-6 | base 8bdf2c7; no push/tag; no pointer bump; no co-author tags | Task 1 commit gates |
| L-7 | note item 8 (tracker, verdict, reply TODO), todo Outcome, stays pending; docs separate commit | Task 2 |
| REQ / RESEARCH | none (quick task, no research) | n/a |
| CONTEXT Deferred Ideas | none (no CONTEXT.md for this quick) | n/a |
</objective>
<execution_context>
@~/.claude/msd-core/workflows/execute-plan.md
@~/.claude/msd-core/templates/summary.md
</execution_context>
<context>
@CLAUDE.md
@.planning/STATE.md
@.planning/todos/pending/2026-10-22-user-password-routes-404-switch.md
@.planning/notes/2026-10-22-external-user-plugin-escalations.md
@../sm-demo-app/plugins/golem15/user/routes.go
@../sm-demo-app/plugins/golem15/user/turnstile_routes_test.go
Working copies (observed at planning time):
- sm-user-plugin is at /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user. Branch master at 8bdf2c7, 7 commits ahead of origin/master (930b158), working tree clean, no tag on HEAD; the last plugin tag is v0.1.8. Do not fetch, merge, rebase or reset. If master has moved past 8bdf2c7, build on top and record git log --oneline 8bdf2c7..master in the SUMMARY. If the tree is dirty, stop: another session is working there.
- Go: sm-demo-app's go.work does not list the plugin under use, so every go command in the plugin dir runs with GOWORK=off. go.mod replaces summercms with ../../../../summercms.go (v0.4.3 required).
- Docker: docker info answered (server 29.9.1). If the socket is denied, run go test through sudo -u golem (CLAUDE.md).
- sm-demo-app (HEAD 18597e5) has another session's uncommitted main.go, and the plugins/golem15/user pointer shows modified because the checkout is ahead of the recorded commit. It is read-only here: run tests, never stage or commit there.
- summercms.go (HEAD a9e3f24) has other sessions' uncommitted edits (.planning/state.json, untracked .msd/ and two phase .gitkeep files) and nothing staged. Leave them alone. STATE.md, g15office and the final quick commit belong to the orchestrator; Task 2 commits only the note and the todo.
Source facts (plugin checkout at 8bdf2c7):
- routes.go: Routes :12-39 calls turnstileGuard :13, then r.Group("/_user/api/v1", surf.Use("throttle:user-api"), ...) registering 18 routes in this order: POST /login (guard...) :18, POST /logout, GET /fetch, POST /refresh, POST /register (guard...) :22, GET /oauth-providers, POST /forgot-password :24, POST /reset-password :25, POST /activate, POST /activate-by-code, POST /update, POST /change-password, POST /marketing-consent, POST /avatar, POST /avatar/remove, POST /tokens, GET /tokens, DELETE /tokens/{id} (the last three with "jwt.auth"), then g.Where("id", "[0-9]+"). turnstileGuard :46-58 is nil-safe on p.app and p.app.Config and returns an error naming golem15.user.turnstile for an invalid value; its doc comment says any other value is refused so a typo cannot silently leave the forms unprotected. Imports: fmt, strings, controllers, pact, surf.
- config/config.yaml: the password block :25-27 is bcrypt_cost: 10 then min_length: 8, two-space indent; the next top-level key is api_tokens. Comments use #.
- turnstile_routes_test.go (package user, runs under -short): recordedRoute {method, path, middleware}, recordingRouter with newRecordingRouter, recordUserRoutes(t, mode) (bareApp plus golem15.user.turnstile, then (&Plugin{app: app}).Routes(rec)), turnstileOf. TestTurnstileRoutes compares tables route by route (method, path, strings.Join of middleware).
- admin_users_edge_test.go:80 bareApp(t): compass.Open on a temp dir with app.yaml "name: user-bare" and Environ SUMMER_ENV=development, backpack.New; it merges no plugin config. plugin.go: configFS embeds the config dir and ConfigFS() returns it; compass Config.MergePlugin("golem15.user", configFS) makes config/config.yaml keys golem15.user.*.
- compass (summercms.go modules/compass, read-only): Lookup(path) (any, bool); Bool reads unset as false and a non-bool string through strconv.ParseBool, false on error. env.go maps SUMMER_A__B_C to a.b_c with the value as a string, so SUMMER_GOLEM15__USER__PASSWORD__PUBLIC_ROUTES=false gives the string "false".
- surf (read-only): an unmatched path gets ServeMux's own 404 (http.NotFound text, or the error page for a browser navigation); a path registered for another method gets 405 with Allow. The harness send sets no Accept, so the stdlib text applies, but the test compares with an unknown path and does not depend on it.
- admin_harness_test.go: newAdminEnv(t, configure...) :165 publishes the DB, runs party.Activate (which merges config.yaml), then the configure functions, then lagoon.Migrate and surf.Assemble (which calls Routes). call :287, send :301 (a fresh RemoteAddr per request, bearer when token is non-empty), mails(to) :370, seedUser :513 (password correct-horse, activated, unique email), reload :554.
- Reusable test helpers: tokenCookieSettings(t, keys) in token_cookie_test.go:179 (turns use_register_throttle off and sets keys; works for any key), registerBody(label) :193 (unique email, correct-horse, name), userLoginPath and userRegisterPath constants :14-15; assertNoCookie and assertBodyKeys in refresh_cookie_test.go:236/:244; fetchCode and refresh in offboarding_test.go:45/:50; userSub in session_cookie_test.go:247; invalidLoginBody in session_test.go:40 ({"error":true,"message":"Invalid email or password"}); classes.IssueResetCode(ctx, db, user) (string, error) in classes/codes.go:55, packed as userSub(user)+"!"+code. POST /logout answers 200 {"message":"Logged out"}. models.User.LastSeen is a pointer, nil until login or refresh stamps it.
- Default answers today: POST /login with an unknown or wrong password answers 401 invalidLoginBody; POST /forgot-password with a valid address answers 200 {"message": ...}; POST /reset-password with {} answers 422 (validation); GET /login answers 405.
- The names publicPasswordRoutes, TestPasswordPublicRoutes, TestPasswordPublicRoutesAnswer404, password_routes_test.go and public_routes are unused in the plugin today. No other plugin in sm-demo-app checks passwords; the sociallogin and quizzes harness tests POST /_user/api/v1/login with the default config.
- README.md: Password reset and change bullet :21; API reference route table :90-109 and the note after it :111; config table :205-227 with golem15.user.password.min_length :224 and the golem15.user.turnstile row :227 (its cell begins "Cloudflare Turnstile on `POST /login` and `POST /register`"); Testing :248-279, ending with the TestTokenCookie paragraph :275, then the TestAdminOrganisationMembershipClearsRole paragraph.
- Escalation note (summercms.go): tracker row 8 :29 (status open, Shipped empty; rows 1-3 and 7 :22-28 are the format, the todo link stays as the second link); the paragraph after the six invocations :51 (its sentence about which items are done locally); verdict **8.** :62 (verdicts **7.**, **9.**, **10.** :61-64 are the "Done locally (`sha`). ..." format); reply "Password-routes switch" :98-100, whose "Agreed, in the user plugin, ..." line :99 stays and whose TODO line :100 is the only line starting with TODO.
- Todo: sections ## Problem :16, ## Solution :22, ## Invoke :32. The Outcome goes between Solution and Invoke, in the format of .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md's Outcome (one paragraph).
</context>
<tasks>
<task type="tracer" tdd="true">
<name>Task 1 (tracer): golem15.user.password.public_routes false leaves POST /login, /forgot-password and /reset-password unregistered, proven on the route table and through the assembled router on Postgres, committed in sm-user-plugin</name>
<files>../sm-demo-app/plugins/golem15/user/routes.go, ../sm-demo-app/plugins/golem15/user/config/config.yaml, ../sm-demo-app/plugins/golem15/user/password_routes_test.go, ../sm-demo-app/plugins/golem15/user/README.md</files>
<precondition>git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user status --short is empty, its branch is master, and 8bdf2c7 is an ancestor of HEAD. Docker is reachable for testcontainers, directly or through sudo -u golem.</precondition>
<behavior>
- TestPasswordPublicRoutes (password_routes_test.go, package user, no database, runs under -short). Every table comes from (&Plugin{app: app}).Routes(newRecordingRouter()), as recordUserRoutes does.
- "unset": a bareApp. Routes succeeds with 18 routes that include POST /_user/api/v1/login, /forgot-password and /reset-password. This is the base table B.
- "true" and "true string": the key set to bool true, and to the string "true". Each table equals B route by route (method, path, joined middleware, order).
- "config.yaml default": a bareApp after app.Config.MergePlugin("golem15.user", configFS). app.Config.Lookup of the key returns the bool true, and the table equals B.
- "false", "false string", "padded false string": the key set to bool false, to "false" and to " false ". Each table has 15 routes and equals B with exactly those three POST routes removed, the rest in the same order with the same middleware (so /register, /logout, /fetch, /refresh, /activate, /activate-by-code, /update, /change-password, /marketing-consent, /avatar, /avatar/remove, /oauth-providers and the three /tokens routes stay).
- "env false": an app from compass.Open on a temp dir (app.yaml "name: user-bare") with Environ SUMMER_ENV=development and SUMMER_GOLEM15__USER__PASSWORD__PUBLIC_ROUTES=false gives the same 15-route table.
- "false with turnstile closed": the key false and golem15.user.turnstile "closed". The table is the 15-route table with turnstile:closed appended to POST /_user/api/v1/register only; no other route carries a turnstile name.
- "empty means default": the key set to "" gives B.
- "invalid": the values "nope", "yes" and the int 0 each make Routes return an error whose text contains golem15.user.password.public_routes.
- TestPasswordPublicRoutesAnswer404 (same file, Docker through newAdminEnv; skips under -short). Both envs use tokenCookieSettings so the registration throttle is off.
- "default answers": tokenCookieSettings(t, nil). app.Config.Lookup of the key returns the bool true (config.yaml merged by party.Activate). POST /_user/api/v1/no-such-route answers 404. For a seeded user, POST /login with the email and a wrong password answers 401 with invalidLoginBody; POST /forgot-password with the email answers 200 with exactly the key message; POST /reset-password with {} answers 422; GET /login answers 405. None of these is 404.
- "off answers like an unknown path": tokenCookieSettings(t, {"golem15.user.password.public_routes": false}). U is POST /_user/api/v1/no-such-route and UG is GET of the same path. For a seeded user u: POST /login with u's email and correct-horse, POST /forgot-password with u's email, and POST /reset-password with a valid IssueResetCode code (packed userSub(u)+"!"+code) and a matching password and password_confirmation each have U's status (404), body and Content-Type and set no cookie; GET /login has UG's status, body and Content-Type. Afterwards reload(u).LastSeen is nil and e.mails(u.Email) is empty.
- "off keeps the rest": in the off env, POST /register with registerBody answers 200 with exactly the keys token and user; fetchCode of that token is 200; refresh of it answers 200 with exactly the key token; POST /logout with the rotated token answers 200; GET /_user/api/v1/oauth-providers answers 200.
- RED at 8bdf2c7: the "false" case of TestPasswordPublicRoutes fails (18 routes, want 15), and "invalid" fails (no error).
</behavior>
<action>
RED. Create password_routes_test.go (package user) with TestPasswordPublicRoutes and TestPasswordPublicRoutesAnswer404 as the behavior block describes (per L-5). Reuse recordedRoute, recordingRouter, newRecordingRouter and turnstileOf from turnstile_routes_test.go and leave that file and TestTurnstileRoutes untouched. Add small helpers in the new file, each with a one-line doc comment:
- recordRoutesOn(t, app) returning the recorded routes and the Routes error.
- passwordRoutesApp(t, value any) returning a bareApp with golem15.user.password.public_routes set to value through app.Config.Set (t.Fatal on error).
- withoutPasswordRoutes(routes) returning the table without POST /_user/api/v1/login, /forgot-password and /reset-password.
- assertSameRoutes(t, got, want) comparing length, then method, path and strings.Join of middleware route by route.
- assertLikeUnknown(t, got, unknown) requiring the same status, body and Content-Type header, a 404 status, and assertNoCookie.
The env case builds its app inline with compass.Open (temp dir, app.yaml, the two Environ entries) and backpack.New, as bareApp does. TestPasswordPublicRoutesAnswer404 starts with adminHarnessDB-based skipping through newAdminEnv like the other Docker tests. Doc comments: TestPasswordPublicRoutes pins golem15.user.password.public_routes on the route table (default and true register every route, false drops exactly the three password routes and nothing else, the turnstile guard stays on /register, an invalid value fails Routes); TestPasswordPublicRoutesAnswer404 pins that the dropped routes answer exactly like an unknown path through the assembled router, while the default answers are unchanged and /register, /fetch, /refresh and /logout keep working.
Run GOWORK=off go test -short -count=1 -run '^TestPasswordPublicRoutes$' . It must fail against the unchanged routes.go. Record the first failure line for the SUMMARY. Do not commit a red test.
GREEN, routes.go (per L-2, L-3, L-4, QD-1, QD-2):
- Add publicPasswordRoutes() (bool, error) on *Plugin after turnstileGuard. It returns true, nil when p.app or p.app.Config is nil. Otherwise it reads p.app.Config.Lookup("golem15.user.password.public_routes"). Not found or a nil value: true. A bool: that value. A string: trimmed; empty means true; otherwise strconv.ParseBool, and on a parse error it returns fmt.Errorf("golem15.user: golem15.user.password.public_routes must be true or false, got %q", the raw string). Any other type: the same message with %v.
- Its doc comment says: the key decides whether POST /login, /forgot-password and /reset-password are registered; default true; false leaves them unregistered so they answer the router's 404 like any unknown path; read when the routes are built, so a change needs a restart; an invalid value is refused so a typo cannot silently remove (or keep) the sign-in routes.
- In Routes, call it right after turnstileGuard and return its error. Inside the group, wrap only the POST /login registration (still with guard...) and the POST /forgot-password and POST /reset-password registrations in "if public" branches at their current positions, so the default table keeps its order. Do not touch any other registration, the group middleware or g.Where.
- Add strconv to the imports. gofmt the file.
config/config.yaml (per L-1): in the password block, after min_length: 8, add public_routes: true (two-space indent) with a comment above it saying that false leaves POST /login, /forgot-password and /reset-password unregistered (they 404 like any unknown path), /register and the other routes stay, it is read at boot, and it takes true or false.
README.md, in the same commit (CLAUDE.md docs rule):
- Password reset and change bullet (:21): append a sentence saying that with `golem15.user.password.public_routes` false, `POST /login`, `POST /forgot-password` and `POST /reset-password` are not registered, so they answer the router's own 404 like any unknown path (any method, so no 405 shows they exist), while the `controllers` handlers stay exported.
- API reference: after the note line that follows the route table (:111), add one line saying that with `golem15.user.password.public_routes` false the `/login`, `/forgot-password` and `/reset-password` rows are not registered.
- Configuration table: a row after golem15.user.password.min_length, reading | `golem15.user.password.public_routes` | `true` | followed by a meaning cell. The cell says that when `false`, `POST /login`, `POST /forgot-password` and `POST /reset-password` are not registered and answer 404 like any unknown path; `POST /register` (still gated by `allow_registration` and guarded by `golem15.user.turnstile`) and every other route stay. It is read when the routes are built, so a change needs a restart. It takes `true` or `false`, also as a string (`SUMMER_GOLEM15__USER__PASSWORD__PUBLIC_ROUTES=false`); an empty value means `true`; any other value fails boot.
- golem15.user.turnstile row: after "on `POST /login` and `POST /register`", add a parenthesis saying only `/register` while `golem15.user.password.public_routes` is false.
- Testing: after the TestTokenCookie paragraph, add one paragraph naming `TestPasswordPublicRoutes` (in `-short`) and `TestPasswordPublicRoutesAnswer404` and their cases: unset, `true` and the `config.yaml` default register every route; `false` (also from a `SUMMER_` variable) drops exactly the three password routes and keeps every other route and its middleware, the turnstile on `/register` included; an invalid value fails `Routes`; through the assembled router the dropped routes (and a `GET /login`) answer exactly like an unknown path and sign in, mail and reset nothing, while the default answers are unchanged and `/register`, `/fetch`, `/refresh` and `/logout` still work.
Run go vet, the targeted tests, go test -short and the full Docker-backed suite of the plugin, so the commit is green (CLAUDE.md). A failure unrelated to this change is not patched here: stop and report it.
Consumer cross-check, read-only: from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app run go test -count=1 ./plugins/golem15/sociallogin/... ./plugins/golem15/quizzes/... (go.work points them at this checkout; their harnesses POST /_user/api/v1/login with the default). If a failure names /login or the user plugin's routes, stop and fix it in this task; record any other failure as unrelated and do not patch those repos. Do not stage anything in sm-demo-app.
Commit in the plugin repo only, staging by path: git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user add routes.go config/config.yaml password_routes_test.go README.md, then commit with git -C on the same path. The subject:
feat: golem15.user.password.public_routes false leaves POST /login, /forgot-password and /reset-password unregistered, so they 404 like any unknown path
The body is one short paragraph: default true, so the route table is unchanged; false skips only those three registrations (the router's own 404, no custom handler, no framework change); /register keeps allow_registration and the turnstile guard; read at boot, and an invalid value fails boot like golem15.user.turnstile.
Add no trailer of any kind; the user's global CLAUDE.md forbids co-author tags and overrides any harness attribution reminder. Do not push or tag (v0.5.0 release hold). Record the short SHA (git log -1 --format=%h), the RED line, the suite results and the consumer cross-check result in the SUMMARY.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && test -z "$(gofmt -l routes.go password_routes_test.go)" && GOWORK=off go vet ./... && GOWORK=off go test -short -count=1 -run '^(TestPasswordPublicRoutes|TestTurnstileRoutes)$' . && GOWORK=off go test -count=1 -run '^(TestPasswordPublicRoutes|TestPasswordPublicRoutesAnswer404|TestTurnstileRoutes|TestLogin|TestRegister|TestTokenCookie|TestSessionRoutesAcceptCookies|TestLogoutEndsTheSession)$' . && grep -qF 'func (p *Plugin) publicPasswordRoutes() (bool, error)' routes.go && grep -qF '"golem15.user.password.public_routes"' routes.go && R=$(awk '/^func \(p \*Plugin\) Routes\(/,/^}/' routes.go) && grep -qF 'publicPasswordRoutes()' <<<"$R" && grep -qF 'g.Post("/login", controllers.Login(p.app), guard...)' <<<"$R" && grep -qF 'g.Post("/register", controllers.Register(p.app), guard...)' <<<"$R" && grep -qF 'g.Post("/forgot-password", controllers.ForgotPassword(p.app))' <<<"$R" && grep -qF 'g.Post("/reset-password", controllers.ResetPassword(p.app))' <<<"$R" && awk '/^password:/{f=1;next} /^[^ #]/{f=0} f' config/config.yaml | grep -qxF ' public_routes: true' && grep -qF '| `golem15.user.password.public_routes` | `true` |' README.md && grep -qF 'TestPasswordPublicRoutesAnswer404' README.md && GOWORK=off go test -short -count=1 ./... && GOWORK=off go test -count=1 ./... && test -z "$(git status --short)" && C=$(git log -1 --format=%H --fixed-strings --grep='golem15.user.password.public_routes' master) && test -n "$C" && test "$C" = "$(git rev-parse master)" && git merge-base --is-ancestor 8bdf2c7 "$C" && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet "$C^" "$C" -- go.mod go.sum controllers && F=$(git diff --name-only "$C^" "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "README.md config/config.yaml password_routes_test.go routes.go " && test -z "$(git tag --points-at "$C")" && test -z "$(git branch -r --contains "$C")" && ! git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app diff --cached --name-only | grep -qxF plugins/golem15/user && test -z "$(git -C /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app log --format=%h 18597e5..HEAD -- plugins/golem15/user)" && git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go diff --quiet HEAD -- modules/pact modules/surf modules/compass</automated>
</verify>
<done>TestPasswordPublicRoutes failed at 8bdf2c7 (failure line recorded) and now passes with TestPasswordPublicRoutesAnswer404. Unset, true and the config.yaml default give today's 18-route table; false (bool, string or env) gives it minus exactly POST /login, /forgot-password and /reset-password, the turnstile guard staying on /register; an invalid value fails Routes naming the key. Through the assembled router the dropped routes and GET /login answer exactly like an unknown path and change nothing, the default answers are unchanged, and /register, /fetch, /refresh, /logout and /oauth-providers still work with the key false. config.yaml and README document the key. go vet, go test -short and the full suite are green; the sociallogin/quizzes cross-check result is recorded. One feat commit (four files) is on sm-user-plugin master on top of 8bdf2c7: no trailer, go.mod, go.sum and controllers/ unchanged, untagged, not on any remote branch. The tree is clean; sm-demo-app and summercms.go modules are untouched.</done>
</task>
<task type="auto">
<name>Task 2: fill item 8 in the escalation note (tracker, verdict, reply), add the todo's Outcome, and commit both in summercms.go</name>
<files>.planning/notes/2026-10-22-external-user-plugin-escalations.md, .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md</files>
<precondition>Task 1's verify passed: sm-user-plugin master carries the public_routes commit. git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go diff --quiet HEAD -- on the note and the todo succeeds (no other session is editing them).</precondition>
<action>
Get the short SHA from /media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user: S = git log -1 --format=%h --fixed-strings --grep='golem15.user.password.public_routes' master.
Edit .planning/notes/2026-10-22-external-user-plugin-escalations.md with Edit, using scoped replacements only, never a whole-file Write (per L-7).
Tracker row 8, using rows 1-3 and 7 as the format:
- The Quick / todo cell becomes [261022-x7a](../quick/261022-x7a-user-plugin-golem15-user-password-public/) · [todo](../todos/pending/2026-10-22-user-password-routes-404-switch.md).
- Status becomes done (unreleased).
- Shipped becomes `S` → v0.5.0.
- Label, Verdict and g15office (h7yrafgd) stay.
In the paragraph after the six invocations, replace its sentence about which items are done locally and which is the last of the six with: All six are done locally; item 8 (password-routes 404) was the last. Keep its other sentences.
Verdict **8.**: in the "Done locally" format it becomes: Done locally (`S`). Plugin config; no framework wrap. `golem15.user.password.public_routes` (default true); false leaves `POST /login`, `/forgot-password` and `/reset-password` unregistered, so they get the router's own 404 like any unknown path (a `GET` too, no 405); no custom handler, no `pact`/`surf` change. `/register` stays (`allow_registration` gates it, `golem15.user.turnstile` still guards it), and so do `/activate*`, `/fetch`, `/refresh`, `/logout`, `/change-password` and `/tokens`. Read when the routes are built (a restart applies it); a value other than true or false fails boot.
Reply to send, "Password-routes switch": keep the "Agreed, in the user plugin, ..." line. Replace the TODO line under it with one line in the G2-G4 and Cookie-on-/login format:
Ships in SummerCMS v0.5.0 (sm-user-plugin S, tagged with that wave): set golem15.user.password.public_routes: false (default true; SUMMER_GOLEM15__USER__PASSWORD__PUBLIC_ROUTES=false in the environment) and POST /login, POST /forgot-password and POST /reset-password are not registered, so they answer the same 404 as any unknown path, whatever the method. POST /register stays (allow_registration still decides whether it takes accounts, and golem15.user.turnstile still guards it), as do /activate, /activate-by-code, /fetch, /refresh, /logout, /update, /change-password and /tokens. With the key true or unset nothing changes. The key is read when the routes are built, so a change needs a restart; a value other than true or false stops boot with an error naming the key.
Substitute the real S, unquoted in the reply line as G2-G4 do. Leave everything else in the note unchanged.
Edit the todo .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md. Insert an "## Outcome (YYYY-MM-DD)" section, dated with the execution day (2026-10-23 at planning time), after the "## Solution" section and before "## Invoke", in the format of the Outcome in 2026-10-22-user-login-opt-in-session-cookie.md. It is one paragraph that:
- names quick `261022-x7a`, the commit `S` on sm-user-plugin master and its base `8bdf2c7`;
- says routes.go reads `golem15.user.password.public_routes` through `publicPasswordRoutes` (unset, empty or true register every route; a bool or a true/false string; anything else fails `Routes` naming the key) and, when false, skips only `POST /login`, `/forgot-password` and `/reset-password`; the turnstile guard stays on `/register`; the default route table is unchanged; no `pact`/`surf`/controller change;
- names `TestPasswordPublicRoutes` (`-short`, route-table recording) and `TestPasswordPublicRoutesAnswer404` (Docker, the dropped routes answer exactly like an unknown path, the rest keep working); README and `config.yaml` updated;
- ends with: Reply note item 8 filled. Not tagged, not pushed: ships with the v0.5.0 wave.
Leave the todo in pending/.
Commit exactly these two files with a pathspec commit, so nothing else in the index is included:
git -C /media/nvme/dev/golem15/summercms.io/summercms/summercms.go commit -m "docs: fill item 8 in the external-escalation reply" -- .planning/notes/2026-10-22-external-user-plugin-escalations.md .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md
No trailer. Do not touch STATE.md, state.json, the PLAN, the SUMMARY or any other file; the orchestrator commits those and handles STATE and g15office. Do not push. Do not send the reply.
</action>
<verify>
<automated>cd /media/nvme/dev/golem15/summercms.io/summercms/summercms.go && N=.planning/notes/2026-10-22-external-user-plugin-escalations.md && T=.planning/todos/pending/2026-10-22-user-password-routes-404-switch.md && P=/media/nvme/dev/golem15/summercms.io/summercms/sm-demo-app/plugins/golem15/user && S=$(git -C "$P" log -1 --format=%h --fixed-strings --grep='golem15.user.password.public_routes' master) && test -n "$S" && grep -qE '^\| 8 \| Password-routes 404 switch \| Feature \| \[261022-x7a\]\(\.\./quick/261022-x7a-user-plugin-golem15-user-password-public/\) · \[todo\]\(\.\./todos/pending/2026-10-22-user-password-routes-404-switch\.md\) \| h7yrafgd \| done \(unreleased\) \| `[0-9a-f]{7,}` → v0\.5\.0 \|$' "$N" && grep -qF "| \`$S\` → v0.5.0 |" "$N" && grep -qF "**8.** Done locally (\`$S\`)" "$N" && grep -qF "Ships in SummerCMS v0.5.0 (sm-user-plugin $S, tagged with that wave): set golem15.user.password.public_routes: false" "$N" && grep -qF 'All six are done locally' "$N" && test "$(grep -c '^TODO' "$N")" = 0 && ! grep -qE '^\| [0-9]+ \|.*\| open \|' "$N" && grep -qF 'Agreed, in the user plugin, not as a framework' "$N" && grep -qF 'Ships in SummerCMS v0.5.0 (sm-user-plugin 846087d and 8bdf2c7, tagged with that wave)' "$N" && grep -qF 'Ships in SummerCMS v0.5.0 (sm-user-plugin 4bf44fc, tagged with that wave)' "$N" && grep -q '^## Outcome' "$T" && awk '/^## Solution/{s=NR} /^## Outcome/{o=NR} /^## Invoke/{i=NR} END{exit !(s && o && i && s<o && o<i)}' "$T" && grep -qF "$S" "$T" && grep -qF '8bdf2c7' "$T" && grep -qF '261022-x7a' "$T" && test ! -e .planning/todos/done/2026-10-22-user-password-routes-404-switch.md && C=$(git log -1 --format=%H --fixed-strings --grep='docs: fill item 8 in the external-escalation reply') && test -n "$C" && git merge-base --is-ancestor a9e3f24 "$C" && F=$(git show --name-only --format= "$C") && test "$(LC_ALL=C sort <<<"$F" | tr '\n' ' ')" = "$N $T " && B=$(git log -1 --format=%B "$C") && ! grep -qi 'co-authored-by' <<<"$B" && git diff --quiet HEAD -- "$N" "$T" && test -z "$(git branch -r --contains "$C")"</automated>
</verify>
<done>Escalation note row 8 reads done (unreleased) with `S` → v0.5.0 and links the quick and the todo; the order paragraph says all six are done; verdict 8 says "Done locally" with the SHA and names the key; the Password-routes reply carries the "Ships in SummerCMS v0.5.0 (sm-user-plugin S, tagged with that wave)" line naming golem15.user.password.public_routes. No line starts with TODO and no tracker row is open, so the reply is complete (still held until v0.5.0 is tagged). The todo has an Outcome section between Solution and Invoke naming the commit, the base and both tests, and it is still in pending/. One docs commit in summercms.go touches exactly those two files: no trailer, not pushed. Nothing else in summercms.go was touched.</done>
</task>
</tasks>
<threat_model>
## Trust Boundaries
| Boundary | Description |
|----------|-------------|
| internet to the password routes | POST /login, /forgot-password and /reset-password accept credentials, addresses and reset codes from anyone; an app that signs users in another way wants them gone |
| operator configuration (golem15.user.password.public_routes, YAML or SUMMER_ env) | a mistyped value must not silently remove or keep the sign-in routes |
| shared core plugin to its many consuming applications | a default change would break every app that signs in with a password |
## STRIDE Threat Register
| Threat ID | Category | Component | Severity | Disposition | Mitigation Plan |
|-----------|----------|-----------|----------|-------------|-----------------|
| T-x7a-01 | Spoofing | POST /login, /forgot-password, /reset-password reachable on an app that does not offer password sign-in (credential stuffing, reset-mail abuse) | medium | mitigate | With the key false Routes never registers them, so no handler runs (L-2). TestPasswordPublicRoutesAnswer404 proves a correct password signs nothing in (no last_seen), forgot-password sends no mail, and a valid reset code is answered like an unknown path. |
| T-x7a-02 | Information disclosure | route existence revealed by a distinct answer (a custom 404 body or a 405 on GET) | low | mitigate | No custom handler; the routes are absent, so every method gets the router's own answer. The test compares status, body and Content-Type with the same method on an unknown path, GET /login included (405 by default, 404 when off). |
| T-x7a-03 | Denial of service | a typo (for example "flase", "yes") silently 404ing sign-in in production, or silently keeping it | medium | mitigate | QD-1: publicPasswordRoutes accepts only bool, a true/false string or empty/unset; anything else fails Routes naming the key, so boot fails loudly, as golem15.user.turnstile does. Tested with "nope", "yes" and 0. |
| T-x7a-04 | Denial of service | existing applications losing their password routes after the upgrade | high | mitigate | Default true in config.yaml, and unset or empty also mean true, so the table does not depend on the config merge. TestPasswordPublicRoutes pins the unset, true and config.yaml-default tables equal to 8bdf2c7's; controllers/ is unchanged (commit gate) and the full suite stays green. |
| T-x7a-05 | Elevation of privilege | /register losing its Turnstile guard when /login is off | medium | mitigate | The guard slice is still applied to /register; the "false with turnstile closed" case pins turnstile:closed on /register only. |
| T-x7a-06 | Spoofing | other ways to obtain a session remain (POST /register in auto mode signs in, /activate-by-code, sociallogin FinishLogin, the exported controllers.Login an app could mount) | low | accept | Out of scope by spec (L-3): the switch removes exactly the three password routes. /register stays gated by allow_registration; no other plugin in the stack checks passwords. The README and reply name what stays registered. |
| T-x7a-SC | Tampering | npm/pip/cargo/Go module installs | low | accept | No dependency is added; go.mod and go.sum are unchanged (the commit gate checks it). No package-legitimacy checkpoint is needed. |
</threat_model>
<verification>
- sm-user-plugin: GOWORK=off go vet ./..., GOWORK=off go test -short -count=1 ./... and GOWORK=off go test -count=1 ./... are green at the commit.
- TestPasswordPublicRoutes was red at 8bdf2c7 and is green at the commit; TestPasswordPublicRoutesAnswer404 is green; TestTurnstileRoutes, TestLogin, TestRegister, TestTokenCookie and TestLogoutEndsTheSession pass unchanged.
- The sociallogin and quizzes suites, run through sm-demo-app's go.work against this checkout, have their result recorded in the SUMMARY.
- One local commit on sm-user-plugin master: four files, no trailer, not pushed, not tagged, go.mod/go.sum/controllers unchanged. The sm-demo-app pointer is neither staged nor committed; summercms.go modules are unmodified.
- One docs commit in summercms.go touches exactly the escalation note and the todo.
</verification>
<success_criteria>
- An application sets golem15.user.password.public_routes: false (or the SUMMER_ variable) and POST /login, /forgot-password and /reset-password answer exactly like any unknown path, while registration, activation, the session routes and API tokens keep working.
- With the key unset or true, every application's route table and every response of the plugin are unchanged.
- An invalid value stops boot with an error naming the key.
- Item 8 is recorded as done (unreleased) with the SHA, and the reply has no TODO left (still held until v0.5.0 is tagged).
</success_criteria>
<output>
Create `.planning/quick/261022-x7a-user-plugin-golem15-user-password-public/261022-x7a-SUMMARY.md` in summercms.go when done. Include:
- the plugin commit's short SHA and the base;
- the RED failure line;
- the suite results and the consumer cross-check result;
- the docs commit SHA in summercms.go;
- a confirmation that nothing was pushed, tagged or pointer-bumped, and that the reply was not sent.
Do not commit the SUMMARY; the orchestrator commits it with the PLAN and STATE.
</output>

View File

@@ -0,0 +1,84 @@
---
phase: quick-261022-x7a
plan: 01
quick_id: 261022-x7a
subsystem: sm-user-plugin (routes, config)
tags: [user-plugin, routes, config, external-escalation]
status: complete
requires: [sm-user-plugin 8bdf2c7]
provides: [golem15.user.password.public_routes]
affects: [sm-user-plugin routes table, escalation note item 8]
tech-stack:
added: []
patterns: [route-table recording test (recordingRouter), strict config parse failing boot like golem15.user.turnstile]
key-files:
created:
- ../sm-demo-app/plugins/golem15/user/password_routes_test.go
modified:
- ../sm-demo-app/plugins/golem15/user/routes.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md
decisions:
- "golem15.user.password.public_routes takes a bool or the string true/false (case-insensitive, trimmed; empty/unset = true); anything else (1, 0, t, f, yes, an int) fails Routes naming the key (plan-checker advisory 1, replaces strconv.ParseBool)"
metrics:
completed: 2026-10-23
duration: ~25 min
actuals:
tokens: 9100 # chars/4 over the two commits' diffs
tasks: 2
commits: 2 # one in sm-user-plugin (8bdf2c7..3828a65), one in summercms.go (a9e3f24..e5dd457); measured per repo with git rev-list --count
plan_head_before: "sm-user-plugin 8bdf2c7; summercms.go a9e3f24"
plan_head_after: "sm-user-plugin 3828a65; summercms.go e5dd457"
---
# Quick 261022-x7a: golem15.user.password.public_routes Summary
An opt-in user-plugin key, `golem15.user.password.public_routes` (default true). When it is false, the plugin does not register POST /login, /forgot-password or /reset-password, so they get the router's own 404 like any unknown path. All other routes and the turnstile guard on /register are unchanged.
## Commits
| Repo | SHA | Base | Message |
|------|-----|------|---------|
| sm-user-plugin (master) | `3828a65` | `8bdf2c7` | feat: golem15.user.password.public_routes false leaves POST /login, /forgot-password and /reset-password unregistered, so they 404 like any unknown path |
| summercms.go (master) | `e5dd457` | `a9e3f24` | docs: fill item 8 in the external-escalation reply |
`git rev-list --count 8bdf2c7..3828a65` = 1 and `a9e3f24..e5dd457` = 1. sm-user-plugin master had not moved past 8bdf2c7. Neither commit has a trailer.
## What changed
- **routes.go**: added `publicPasswordRoutes() (bool, error)` after `turnstileGuard`. It reads `app.Config.Lookup`, so an unset key and a nil config mean true. A bool is used as is. A string is trimmed and compared case-insensitively with `true` or `false`, and an empty string means true. Any other value returns `golem15.user: golem15.user.password.public_routes must be true or false, got ...`. `Routes` calls it once, right after `turnstileGuard`, and wraps only `/login` (still with `guard...`), `/forgot-password` and `/reset-password` in `if public` at their current positions.
- **config/config.yaml**: `password.public_routes: true` after `min_length`, with a comment.
- **README.md**: a sentence in the Password bullet, a note under the API reference table, a config table row, a clause in the turnstile row and a Testing paragraph.
- **password_routes_test.go**: `TestPasswordPublicRoutes` runs under `-short`. Its cases: unset, true, "true", "TRUE", empty, the config.yaml default, false, "false", " false ", "False", the env variable, false with turnstile closed, and the invalid values "nope", "yes", "1", "0", "t", "f" and int 0. `TestPasswordPublicRoutesAnswer404` runs against Docker. Its subtests are default answers, "off answers like an unknown path" and "off keeps the rest".
- **Escalation note**: row 8 is now done (unreleased) with `3828a65` → v0.5.0. The order paragraph now says all six are done, verdict 8 is filled in, and the Password-routes reply line replaces the TODO. **Todo**: added an `## Outcome (2026-10-23)` section. The todo stays in pending/.
## Verification
- RED at 8bdf2c7: `TestPasswordPublicRoutes/false: password_routes_test.go:134: 18 routes, want 15`. The "invalid" case also failed, with `"nope": error <nil>`.
- GREEN: `GOWORK=off go vet ./...` is clean. `go test -short -count=1 ./...` and the full Docker-backed `go test -count=1 ./...` pass in every package (root, classes, models, updates). Docker was reachable directly; `sudo -u golem` was not needed.
- The plan's Task 1 and Task 2 `<automated>` blocks were run through `bash -c` (the shell is fish): STATIC_OK, GATES_OK and TASK2_OK. The full suites were not re-run after the commit because the committed tree is the one that was tested.
- Consumer cross-check from sm-demo-app (go.work): `./plugins/golem15/quizzes/...` passes. In `./plugins/golem15/sociallogin/...` everything passes except `TestPHPMethodMap`, which fails with `lstat ../fonoteka.go/plugins/golem15/user: no such file or directory`. That test's default user-plugin path assumes the fonoteka.go layout, so the failure has nothing to do with this change. With `USER_PLUGIN=<this checkout>` it passes. It was not patched.
## Deviations from Plan
**1. [Plan-checker advisory 1] Strict string parse instead of strconv.ParseBool**
- The plan's QD-1 said to use `strconv.ParseBool`. As the advisory asked, a string is accepted only when it is case-insensitively `true` or `false` (trimmed; empty means true). `"1"`, `"0"`, `"t"` and `"f"` now fail boot. Because of this, `strconv` was not imported. The invalid cases add "1", "0", "t" and "f", and the valid cases add "TRUE" and "False".
- Commit: 3828a65
**2. Extra assertion in the off subtest**
- After the off-mode reset-password probe, the test also checks that the user's password hash is unchanged. The plan asked for nothing beyond last_seen and mails, so this goes slightly further.
Otherwise the plan was executed as written.
## Confirmations
- Nothing was pushed or tagged. The sm-demo-app `plugins/golem15/user` pointer was neither staged nor committed. The summercms.go modules (pact, surf, compass), go.mod, go.sum and controllers/ are unchanged.
- The reply in the escalation note was not sent; the v0.5.0 hold still applies.
- STATE.md, ROADMAP.md, PLAN.md and this SUMMARY were not committed; that is left to the orchestrator.
## Self-Check: PASSED
- FOUND: password_routes_test.go, routes.go publicPasswordRoutes, config.yaml public_routes, README row
- FOUND: commit 3828a65 (sm-user-plugin), commit e5dd457 (summercms.go)

View File

@@ -0,0 +1,106 @@
---
phase: quick-261022-x7a
verified: 2026-10-23T00:30:00Z
status: passed
score: 7/7 must-haves verified
covered_files:
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
- .planning/quick/261022-x7a-user-plugin-golem15-user-password-public/261022-x7a-PLAN.md
- .planning/quick/261022-x7a-user-plugin-golem15-user-password-public/261022-x7a-SUMMARY.md
- .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md
covered_digest: "v2:sha256:a8ecbcf388dc4f5634c14fd11d2ad4ec513dd24256952ae29ea3bba2d4f7b8fe"
external_covered_commit: "sm-user-plugin 3828a65 (base 8bdf2c7): routes.go, config/config.yaml, password_routes_test.go, README.md; outside the summercms.go root, so the commit SHA stands in for a digest"
behavior_unverified: 0
overrides_applied: 0
---
# Quick 261022-x7a: golem15.user.password.public_routes Verification Report
**Goal:** A user-plugin key, `golem15.user.password.public_routes`, defaulting to true. When it is false, POST /login, /forgot-password and /reset-password are not registered, so they 404 like unknown paths. /register and the other routes stay. No framework wrap and no custom 404. Base is 8bdf2c7.
**Verified:** 2026-10-23
**Status:** passed
**Re-verification:** No, this is the initial verification.
## Goal Achievement
### Observable Truths
| # | Truth | Status | Evidence |
|---|-------|--------|----------|
| 1 | With the key unset, true or at its config.yaml default, the 18-route table is the same as at 8bdf2c7, and the existing tests pass unchanged | VERIFIED | Diff of routes.go: with `public == true` the registration sequence, middleware and order are identical to the base. `TestPasswordPublicRoutes` cases true, "true", "TRUE", "", "config.yaml default" pass. `TestTurnstileRoutes` was not modified and passes. The full suite passes. |
| 2 | False (bool, "false", or the SUMMER_ env value) gives the same table minus exactly the three POST routes (15 routes), with order and middleware kept and turnstile:closed still on /register | VERIFIED | Subtests false, "false", " false ", "False", "env false" and "false with turnstile closed" pass. A mutation check (the new test run against the 8bdf2c7 code in a scratch copy) fails with `18 routes, want 15`, so the test discriminates. |
| 3 | Through the assembled router with the key off, the three routes and GET /login answer the same status, body and Content-Type as an unknown path, with no cookie, no last_seen, no mail and no password change. With the default they answer 401, 200, 422 and 405. | VERIFIED | `TestPasswordPublicRoutesAnswer404` passed in this run against Docker 29.9.1 in 5.08s, not skipped. Its subtests are "default answers" and "off answers like an unknown path". |
| 4 | With the key off, /register (auto) answers 200 with a token, and /fetch, /refresh, /logout and /oauth-providers still work | VERIFIED | The "off keeps the rest" subtest passed. |
| 5 | An invalid value (nope, yes, 0, ...) makes Routes return an error naming the key, so boot fails | VERIFIED | The "invalid" subtest covers "nope", "yes", "1", "0", "t", "f" and int 0. surf/router.go:669 wraps a Routes error as `surf: routes <id>: ...` and returns it from Assemble, so boot fails. |
| 6 | One feat commit on sm-user-plugin master over 8bdf2c7 that touches exactly 4 files, with vet, -short and the full suite green, no trailer, no push, no tag, go.mod/go.sum/controllers unchanged, and the sm-demo-app pointer not staged | VERIFIED | `git show --stat 3828a65` lists exactly 4 files, and the parent is 8bdf2c7. There is no Co-Authored-By line. `origin/master` is ahead by 8, so nothing was pushed. `git tag --points-at HEAD` is empty. The diff for go.mod, go.sum and controllers/ is empty. In sm-demo-app nothing is staged (`git diff --cached` is empty), and the pointer shows only as unstaged `M`. |
| 7 | Note row 8 reads done (unreleased) `3828a65` → v0.5.0, verdict 8 and the reply name the key, no line starts with TODO, no tracker row is open, and the todo has an Outcome and stays in pending/. Both files are in a commit touching only them. | VERIFIED | e5dd457 touches exactly those 2 files. Row 8 matches. In the reply, "TODO: ships ... <name>" is replaced by the key text. The only remaining "TODO" is the instruction line 68 ("Replace every `TODO`..."), which does not start with TODO. Every tracker row is done or declined. `## Outcome (2026-10-23)` is present, and the todo is still in pending/. |
**Score:** 7/7 truths verified (0 present but behavior-unverified)
### Required Artifacts
| Artifact | Expected | Status | Details |
|----------|----------|--------|---------|
| sm-demo-app/plugins/golem15/user/routes.go | `func (p *Plugin) publicPasswordRoutes() (bool, error)`, used by Routes | VERIFIED | Called once after turnstileGuard; its error is returned. `if public` wraps only /login (keeping `guard...`) and forgot/reset. It is nil-safe on app and Config. |
| .../user/config/config.yaml | `public_routes: true` after min_length | VERIFIED | Comment and key present at the right indent. The test "config.yaml default" confirms that MergePlugin yields `true`. |
| .../user/password_routes_test.go | TestPasswordPublicRoutes and TestPasswordPublicRoutesAnswer404 | VERIFIED | 303 lines, substantive. It reuses recordingRouter, bareApp and newAdminEnv. |
| .../user/README.md | Key documented | VERIFIED | Password bullet, API reference note, config table row, turnstile row clause and Testing paragraph. Every identifier in them exists. |
| .planning/notes/2026-10-22-external-user-plugin-escalations.md | Contains "golem15.user.password.public_routes: false" | VERIFIED | Present in the reply paragraph. |
| .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md | `## Outcome` | VERIFIED | Between Solution and Invoke. |
### Key Link Verification
| From | To | Via | Status |
|------|----|-----|--------|
| Routes | publicPasswordRoutes | single call, error returned, three registrations gated | WIRED |
| config.yaml password.public_routes | app.Config.Lookup in publicPasswordRoutes | MergePlugin; unset also means true | WIRED (the config.yaml default subtest and the newAdminEnv merged-default assertion) |
| surf.Assemble | Plugin.Routes | router.go:669 propagates the error | WIRED |
| plugin commit SHA | note row 8, verdict 8, reply | `3828a65` → v0.5.0 | WIRED |
### Behavioral Spot-Checks
| Behavior | Command | Result | Status |
|----------|---------|--------|--------|
| Vet | `GOWORK=off go vet ./...` (plugin) | clean | PASS |
| Short suite | `GOWORK=off go test -short -count=1 ./...` | all packages ok | PASS |
| New and turnstile tests with Docker | `GOWORK=off go test -count=1 -v -run 'TestPasswordPublicRoutes\|TestTurnstileRoutes' .` | PASS (Answer404 took 5.08s and ran against Docker) | PASS |
| Full Docker-backed suite | `GOWORK=off go test -count=1 ./...` | root 52.4s ok, classes ok, models ok, updates ok | PASS |
| Test discriminates (mutation) | new test file over `git archive 8bdf2c7` in scratch | FAIL: `18 routes, want 15`, and the invalid values gave no error | PASS (the test is red without the feature) |
### Probe Execution
Not applicable. The plan declares no probe scripts.
### Requirements Coverage
| Requirement | Description | Status | Evidence |
|-------------|-------------|--------|----------|
| x7a-1 | Key, default true, false drops the three routes, router's own 404, nothing else changes | SATISFIED | Truths 1–5 |
| x7a-2 | Tests and README in the same plugin commit | SATISFIED | Truth 6, artifacts |
| x7a-3 | Escalation note item 8 and todo Outcome in a separate docs commit | SATISFIED | Truth 7 |
### Deviations Reviewed
- **Strict string parse instead of strconv.ParseBool.** This was intended (plan-checker advisory 1). It matches truth 5 better than the plan's QD-1: ParseBool would have accepted "0", which truth 5 lists as invalid.
- **Extra password-unchanged assertion in the off subtest.** It is additive and harmless.
### Anti-Patterns Found
None. The plugin commit adds no TBD, FIXME, XXX, TODO or HACK lines. There are no stubs and no custom 404 handler. pact, surf and compass are unchanged.
### Known Unrelated Issue
The sociallogin test `TestPHPMethodMap` in sm-demo-app defaults to a missing `../fonoteka.go` checkout. It does not touch this change and was not re-run here.
### Human Verification Required
None.
### Gaps Summary
None. The goal is achieved: the key exists with a true default. False leaves exactly the three password routes unregistered, and through the real router they answer exactly like an unknown path. /register and every other route are unchanged. There is no framework or custom-404 change, and both commits are scoped as the plan required.
---
_Verified: 2026-10-23_
_Verifier: Claude (msd-verifier)_

View File

@@ -53,6 +53,8 @@ This extends `.planning/research/go-ecosystem.md` (2026-09-16 GitHub-API-verifie
| `charm.land/huh/v2` | v2.0.3 | Interactive prompts on a terminal | Decided in .planning/notes/2026-10-21-console-charm-stack.md (Phase 19.8 D-02); imported only by modules/bonfire and modules/diary |
| `charm.land/fang/v2` | v2.0.1 | Cobra error rendering hook (used narrowly) | Decided in .planning/notes/2026-10-21-console-charm-stack.md (Phase 19.8 D-02); imported only by modules/bonfire and modules/diary |
| `github.com/charmbracelet/colorprofile` | v0.4.3 | Color profile detection and downsampling writer (`--ansi`, `--no-ansi`, `NO_COLOR`) | Decided in .planning/notes/2026-10-21-console-charm-stack.md (Phase 19.8 D-02); imported only by modules/bonfire and modules/diary |
| `github.com/modelcontextprotocol/go-sdk` (packages `mcp`, `auth`, `oauthex`, `jsonrpc`) | v1.8.0 | MCP server, sessions, streamable HTTP transport, bearer middleware, RFC 9728 metadata, test client for the `pier` module | Decided in .planning/notes/2026-10-22-mcp-go-sdk.md (Phase 19.7 D-24, D-33); imported only by modules/pier and the tagged modules/surf/pier_on.go, linked only with the `summercms_mcp` build tag |
| `github.com/google/jsonschema-go` (package `jsonschema`) | v0.4.3 | Reflects MCP tool input and output schemas from Go structs and validates call arguments | Decided in .planning/notes/2026-10-22-mcp-go-sdk.md (Phase 19.7 D-24); the schema library the SDK itself uses; imported only by modules/pier |
### Development Tools

View File

@@ -0,0 +1,43 @@
---
created: 2026-10-22T20:59:59+02:00
title: User login ignores is_activated
area: sm-user-plugin
severity: major
g15office: 3r4or1ex
parent: bhoyg8z4
invoke: /msd-quick --validate
files:
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/registration.go
- ../sm-demo-app/plugins/golem15/user/session_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
---
## Problem
External app G2: password login ignores `is_activated`. An account set to not activated still gets a token.
Confirmed 2026-10-22 (`/msd-explore`). `Login` (`controllers/api_controller.go`) checks throttle, password, and restores `deleted_at` (deactivation is self-service). It never reads `IsActivated`. `golem15.user.activation.require_activation` defaults to true and is documented as “must be activated before login”. `/register` already withholds the token in `admin` mode when `require` is true. Admin-created users start inactive (`FormBeforeCreate`) and can still log in if they have a password.
This is not deactivation (`deleted_at`). Do not change the restore-on-login behaviour.
## Solution
When `require_activation` is true, `/login` refuses an inactive account with the same opaque invalid-login body as a bad password. When it is false, login still works. Pin with a test: inactive + require true → 401, no token; inactive + require false → 200; activated → 200; deactivated (`deleted_at`) still restores. README: activation gates login; deactivation does not.
After the commit, fill G2 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` (version + one-line reply).
## Outcome (2026-10-22)
Quick `261022-tb4`. Fix commit `15ff979` on sm-user-plugin master (base v0.1.8 / `930b158`). Gate runs after bcrypt and before the `deleted_at` restore; the refusal is the same opaque 401 and counts as a failed attempt. Reply note G2 filled. Not tagged, not pushed: the v0.5.0 wave (these six quicks + admin keyboard shortcuts + MCP) is the first release.
## Invoke
```
/msd-quick --validate Password /login must refuse is_activated=false when golem15.user.activation.require_activation is true (default), same opaque invalid-login body as a bad password. Do not change deleted_at restore-on-login. See .planning/todos/pending/2026-10-22-user-login-ignores-is-activated.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
## Closed 2026-10-23
Shipped in sm-user-plugin v0.1.9 (15ff979), quick task 261022-tb4. Requires SummerCMS v0.4.3.

View File

@@ -0,0 +1,48 @@
---
created: 2026-10-22T20:59:59+02:00
title: User login lockout and same-second cutoff
area: sm-user-plugin
severity: major
g15office: sniewiif
parent: bhoyg8z4
invoke: /msd-quick --validate
files:
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/controllers/users_admin_controller.go
- ../sm-demo-app/plugins/golem15/user/classes/admin_actions.go
- modules/bouncer/jwt.go
- modules/bouncer/mint.go
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
---
## Problem
Two convention holes, one quick (external items 9 and 10).
**Lockout.** `/login` throttle keys on the host of `r.RemoteAddr` (`remoteIP`). `/register` and the `user-api` bucket already use `surf.ClientIP` with trusted proxies. Behind nginx/Caddy every visitor shares one address, so five wrong passwords lock the account for everyone for 15 minutes.
**Same-second cutoff.** JWT `iat` is whole seconds (`jwt.NewNumericDate` in `bouncer.Mint`). `issuedBeforeCutoff` is `iat.Before(cutoff)`. `RevokeUserAccess` already stamps `time.Now().Truncate(time.Second)`. `/reset-password` (`tokens_valid_after: now`) and the admin Users password set (`time.Now()` into `TokensValidAfter`) do not, so a token minted in that same second is refused intermittently.
## Solution
`/login` throttle IP = `surf.ClientIP(r, surf.TrustedProxies(app.Config))`, same as `/register`. That `ip` is also what G2's `refuseLogin` records as a failed attempt — one assignment covers both. Leave exported `RemoteIP` as the `RemoteAddr` host helper (sociallogin / `social_hooks_test` use it; it has no config). Update its doc comment so it no longer says `/login` uses it.
Every remaining `tokens_valid_after` writer uses whole seconds (truncate down, matching `RevokeUserAccess`). Do not change `bouncer.issuedBeforeCutoff`. Writers to fix: `/reset-password` (`now`) and the admin Users password set (`time.Now()`). `/change-password` is already `iat.Add(-time.Second)` — leave it. `RevokeUserAccess` already truncates.
Tests: X-Forwarded-For behind a trusted proxy is the `/login` throttle key; a reset (or admin password set) then an immediate login in the same second succeeds.
Base is sm-user-plugin `4bf44fc` (G4). Hold push/tag for SummerCMS v0.5.0. After the commit, fill items 9 and 10 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` like G2–G4 (`done (unreleased)`, ships in v0.5.0). Leave the todo in pending with an Outcome.
## Outcome (2026-10-22)
Quick `261022-vfz`. Two fix commits on sm-user-plugin master, `b6f8055` and `a484d0e` (base `4bf44fc`). `b6f8055`: `/login` uses `surf.ClientIP(r, surf.TrustedProxies(appConfig(app)))` as `/register` does; the same `ip` feeds `RejectIfThrottled`, `refuseLogin` and `CheckAndRecordLogin`; exported `RemoteIP` is unchanged with a corrected doc comment; README updated; `TestLoginThrottleClientIP` (Docker) covers the trusted proxy and an ignored untrusted `X-Forwarded-For`. `a484d0e`: `/reset-password` (`tokens_valid_after` only; `email_verified_at` unchanged) and the admin password set truncate to the second; change-password and bouncer untouched; `TestPasswordCutoffSameSecond` (Docker) covers `iat` equal to the cutoff (accepted on `jwt.auth`, `/fetch` and `/refresh`) and one second earlier (refused). Reply note items 9 and 10 filled. Not tagged, not pushed: ships with the v0.5.0 wave.
## Invoke
```
/msd-quick --validate User-plugin /login throttle must use surf.ClientIP (trusted proxies), not RemoteAddr. Leave exported RemoteIP as the RemoteAddr helper. Remaining tokens_valid_after writers (reset-password, admin password set) must Truncate(time.Second) like RevokeUserAccess; leave change-password and bouncer's comparison alone. See .planning/todos/pending/2026-10-22-user-login-lockout-and-same-second-cutoff.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
## Closed 2026-10-23
Shipped in sm-user-plugin v0.1.9 (b6f8055, a484d0e), quick task 261022-vfz. Requires SummerCMS v0.4.3.

View File

@@ -0,0 +1,54 @@
---
created: 2026-10-22T20:59:59+02:00
title: User login opt-in session cookie
area: sm-user-plugin
severity: minor
g15office: strnsccy
parent: bhoyg8z4
invoke: /msd-quick --discuss --validate
files:
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/README.md
- modules/bouncer/cookie.go
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
---
## Problem
External app item 7: `/login` cannot set the session cookie. It returns the token only in the response body. An option to set the HttpOnly cookie would remove their Nuxt bridge.
Sociallogin already has `golem15.sociallogin.token_cookie` for OAuth complete (19.5 D-09): `bouncer.LoadCookieConfig` + `TokenCookie`, and the body may omit `token`. Password `/login` never calls `SetCookie`. Logout already forgets that cookie.
Phase 19.6 (2FA) is not mid-flight; `Login()` is free to change.
## Solution
Opt-in config on the user plugin. Cookie attributes stay on `auth.cookie.*` via `bouncer.LoadCookieConfig` (logout already forgets that cookie). The set-on-login flag is a sociallogin twin, not a second attributes block.
`--discuss` should confirm these defaults, not reopen them unless a test or the PHP contract forbids them:
1. Key: `golem15.user.jwt.token_cookie` (default `false`). `auth.cookie.*` is name/path/domain/SameSite/Secure only.
2. When on, `/login` writes `LoadCookieConfig.TokenCookie` (Max-Age = refresh TTL) and **omits `token` from the body**, same as sociallogin `writeSession`. `user` stays in the body. When off, today's `{token, user}` and no `SetCookie`.
3. A cookie-carried `POST /refresh` **must** rewrite that cookie (`bouncer.CookieRefreshHandler` / `TokenCookie`). G3 (`8e4b863`) left body-only rotate; an HttpOnly cookie the browser cannot store would keep the blacklisted jti. Bearer-only refresh stays body-only.
4. Keep SameSite=Lax. No CSRF token. Do not switch to SameSite=None.
Base is sm-user-plugin `a484d0e` (items 9+10). Hold push/tag for SummerCMS v0.5.0. After the commit, fill item 7 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` like G2–G4 and 9–10 (`done (unreleased)`, ships in v0.5.0, name the config key). Leave the todo in pending with an Outcome.
## Note from G3 (2026-10-22)
Since sm-user-plugin `8e4b863`, `POST /refresh` accepts the `token` and `auth_token` cookies, answers the rotated token in the body only and writes no cookie. Cookie rotation is no longer optional: when the request arrived on a session cookie, rewrite it.
## Outcome (2026-10-22)
Quick `261022-wah`. Two commits on sm-user-plugin master, `846087d` then `8bdf2c7` (base `a484d0e`). `846087d`: `POST /refresh` rewrites the `auth.cookie` cookie (`auth.cookie.name`, default `token`) when that cookie carried the token without a bearer header, answers `{}`, and keeps bearer and `auth_token` refreshes body-only; refusals write no cookie. The new export `classes.SessionTokenCookie` names the carrying cookie, sharing one bearer parser with `SessionToken`. `TestRefreshRewritesAuthCookie` (Docker) and `TestSessionTokenCookie` (`-short`) cover it. `8bdf2c7`: `golem15.user.jwt.token_cookie` (default off) on `/login`, `/register` (auto sign-in) and `/activate-by-code` through `writeSession`, the user plugin's twin of sociallogin's. The `auth.cookie` config is loaded right after `sessionDeps`, before any side effect, so a broken block answers the opaque 500 without signing in, creating or activating anything. README and `config.yaml` updated; `TestTokenCookie` covers it. Reply note item 7 and the G3 refresh sentence filled. Not tagged, not pushed: ships with the v0.5.0 wave.
## Invoke
```
/msd-quick --discuss --validate Opt-in HttpOnly session cookie on user-plugin POST /login: golem15.user.jwt.token_cookie (default off), attributes from auth.cookie via bouncer.LoadCookieConfig, omit body token when the cookie is set (sociallogin writeSession). Cookie-carried POST /refresh must rotate that cookie (G3 left body-only); bearer-only refresh stays body-only. SameSite=Lax, no CSRF. Base a484d0e. See .planning/todos/pending/2026-10-22-user-login-opt-in-session-cookie.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
## Closed 2026-10-23
Shipped in sm-user-plugin v0.1.9 (846087d, 8bdf2c7), quick task 261022-wah. Requires SummerCMS v0.4.3.

View File

@@ -0,0 +1,45 @@
---
created: 2026-10-22T20:59:59+02:00
title: User logout blacklist missing under serve
area: sm-user-plugin
severity: major
g15office: ud0gficu
parent: bhoyg8z4
invoke: /msd-quick --discuss --validate
files:
- ../sm-demo-app/plugins/golem15/user/plugin.go
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go
- ../sm-demo-app/plugins/golem15/user/logout_test.go
- modules/lagoon/ondatabase.go
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
---
## Problem
External app G4: logout does not blacklist under `serve`. The plugin's `Boot` runs before the database is published, so the blacklist table stays empty and the token keeps working after logout.
Confirmed. `party.Activate` (and every plugin `Boot`) runs in generated `main` before `surf.ServeCommand` calls `lagoon.Publish`. User plugin `Boot` looks up `*sql.DB` / `*gorm.DB`, finds none, registers the jwt guard with `bl=nil`, and never publishes `bouncer.BlacklistStore`. `EndSession` looks the store up at request time and writes nothing. Cabana avoids this by building the store in `cabana.Activate` during `BuildRouter`, after publish. The `jwt_blacklist` table exists (migrations); nothing is wired to write it. Tests hide the bug because they publish the DB before `Boot`. `RegisterHooks` has the same Boot-before-DB hole.
## Solution
Use `lagoon.OnDatabase` from `Boot` (the documented seam: lighthouse and beachcomber already do). On publish: install `RegisterHooks`, publish `bouncer.NewPostgresBlacklist(sqlDB, "jwt_blacklist")`, and give the jwt guard that store (re-register, or a lazy store that `Lookup`s at request time — decide in `--discuss`). A test must boot like `serve`: Activate/Boot, then Publish, then login + logout + jwt.auth 401 and a blacklist row. A test that publishes first is not enough.
**G3 leftover:** `plugin.go` still registers the jwt guard with the cookie names written out (`"token", "auth_token"`). G3 exported `classes.SessionCookieNames()` and the controllers already pass it. When this quick reworks that `Register` line, switch to `classes.SessionCookieNames()...` so the guard and `SessionToken` cannot drift. Until then `TestSessionRoutesAcceptCookies` is the drift net.
Base is sm-user-plugin `8e4b863` (G3). Hold push/tag for SummerCMS v0.5.0.
After the commit, fill G4 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` the same way as G2/G3 (`done (unreleased)`, ships in v0.5.0). Leave the todo in pending with an Outcome.
## Outcome (2026-10-22)
Quick `261022-usi`. Fix commit `4bf44fc` on sm-user-plugin master (base `8e4b863`). `Boot` makes one `lagoon.OnDatabase` call that runs `classes.RegisterHooks`, publishes `bouncer.NewPostgresBlacklist(sqlDB, "jwt_blacklist")` and starts the sweep. The jwt guard is registered once with an unexported `appBlacklist` that looks up the published store on each call: no store means not blacklisted, and store errors pass through. It no longer hardcodes the cookie names; it uses `classes.SessionCookieNames()...` (G3 leftover). `TestBootBeforeDatabase` (Docker) boots Activate → Publish → routes → login → logout → 401 plus a `jwt_blacklist` row. It fails at `8e4b863` and passes at `4bf44fc`. `TestAppBlacklist` runs under `-short`. Reply note G4 filled. Not tagged, not pushed: ships with the v0.5.0 wave.
## Invoke
```
/msd-quick --discuss --validate Under serve, user-plugin Boot runs before lagoon.Publish so the jwt blacklist is never wired and logout does not revoke. Wire BlacklistStore and RegisterHooks through lagoon.OnDatabase; test Activate-then-Publish. When re-registering the jwt guard, pass classes.SessionCookieNames() instead of the hardcoded token/auth_token names (G3 leftover). See .planning/todos/pending/2026-10-22-user-logout-blacklist-missing-under-serve.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
## Closed 2026-10-23
Shipped in sm-user-plugin v0.1.9 (4bf44fc), quick task 261022-usi. Requires SummerCMS v0.4.3.

View File

@@ -0,0 +1,44 @@
---
created: 2026-10-22T20:59:59+02:00
title: User password routes 404 switch
area: sm-user-plugin
severity: minor
g15office: h7yrafgd
parent: bhoyg8z4
invoke: /msd-quick --validate
files:
- ../sm-demo-app/plugins/golem15/user/routes.go
- ../sm-demo-app/plugins/golem15/user/config/config.yaml
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
---
## Problem
External app item 8: they want a config switch that makes `/login`, `/forgot-password` and `/reset-password` answer 404. They said SummerCMS has no seam for one plugin to wrap another plugin’s routes.
They do not need a framework wrap. The user plugin owns those routes and can skip registering them.
## Solution
Key: `golem15.user.password.public_routes` (default `true`, next to `password.min_length`). When `false`, do not register `POST /login`, `/forgot-password` and `/reset-password` so they 404 like any unknown path. Do not mount a custom 404 handler.
Leave registered: `/register` (`allow_registration` already refuses at the handler), `/activate*`, `/fetch`, `/refresh`, `/logout`, `/change-password`, `/tokens`, the rest. `golem15.user.turnstile` still wraps `/register` when login is off. No change in `pact` / `surf`. Off (the default) is byte-identical to today’s route table.
`turnstile_routes_test` already records the route table — reuse that pattern. Probe 404 vs the current login/forgot/reset status when the key is on. Existing tests keep the default.
Base is sm-user-plugin `8bdf2c7` (item 7). Hold push/tag for SummerCMS v0.5.0. After the commit, fill item 8 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md` like the earlier rows (`done (unreleased)`, ships in v0.5.0, name the key). Leave the todo in pending with an Outcome. Do not send the reply; the hold stands until the rest of the v0.5.0 wave (keyboard shortcuts, MCP / 19.7) is tagged.
## Outcome (2026-10-23)
Quick `261022-x7a`. One commit on sm-user-plugin master, `3828a65` (base `8bdf2c7`). `routes.go` reads `golem15.user.password.public_routes` through `publicPasswordRoutes` (unset, empty or true register every route; a bool or the string true or false, any case; anything else fails `Routes` naming the key) and, when false, skips only `POST /login`, `/forgot-password` and `/reset-password`; the turnstile guard stays on `/register`, the default route table is unchanged, and there is no `pact`/`surf`/controller change. `TestPasswordPublicRoutes` (`-short`, route-table recording) and `TestPasswordPublicRoutesAnswer404` (Docker: the dropped routes answer exactly like an unknown path, the rest keep working) cover it. README and `config.yaml` updated. Reply note item 8 filled. Not tagged, not pushed: ships with the v0.5.0 wave.
## Invoke
```
/msd-quick --validate User-plugin golem15.user.password.public_routes (default true). When false, do not register POST /login /forgot-password /reset-password so they 404 like unknown paths. Leave /register and the rest. No framework wrap, no custom 404. Base 8bdf2c7. See .planning/todos/pending/2026-10-22-user-password-routes-404-switch.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
## Closed 2026-10-23
Shipped in sm-user-plugin v0.1.9 (3828a65), quick task 261022-x7a. Requires SummerCMS v0.4.3.

View File

@@ -0,0 +1,41 @@
---
created: 2026-10-22T20:59:59+02:00
title: User session routes ignore the cookie
area: sm-user-plugin
severity: major
g15office: kkknstxl
parent: bhoyg8z4
invoke: /msd-quick --validate
files:
- ../sm-demo-app/plugins/golem15/user/controllers/api_controller.go
- ../sm-demo-app/plugins/golem15/user/classes/session_user.go
- ../sm-demo-app/plugins/golem15/user/logout_test.go
- ../sm-demo-app/plugins/golem15/user/README.md
- .planning/notes/2026-10-22-external-user-plugin-escalations.md
---
## Problem
External app G3: `/fetch`, `/refresh`, `/logout`, `/update` and `/change-password` answer 401 to a caller with only the cookie, while `jwt.auth` routes accept it.
Partly stale. `Logout` / `EndSession` already read bearer then `token` / `auth_token` cookies (sm-user-plugin `358ee5d`, todo `2026-10-22-user-logout-cookie-stays-valid.md`). The remaining four still go through `bearerToken()` and/or `NewJWTGuard(...)` with no cookie names. `authenticate` even fails closed on an empty bearer before it builds the guard.
## Solution
`/fetch`, `/refresh`, `/update` and `/change-password` extract the session JWT the same way the jwt guard and `EndSession` do (bearer, then `token`, then `auth_token`). Reuse `classes.sessionToken` / `sessionTokens` rather than a third extractor. A cookie-only caller that `jwt.auth` accepts must get 200 on those four. Logout stays as it is. README JWT-sessions bullet names the four.
After the commit, fill G3 in `.planning/notes/2026-10-22-external-user-plugin-escalations.md`.
## Outcome (2026-10-22)
Quick `261022-tto`. Fix commit `8e4b863` on sm-user-plugin master (base `15ff979`). `/fetch`, `/refresh`, `/update` and `/change-password`, and the other signed-in routes through `authenticate` (`/activate`, `/marketing-consent`, `/avatar`, `/avatar/remove`), read the bearer header, then the `token` and `auth_token` cookies, through `classes.SessionToken` and one cookie-aware guard; a cookie-carried `/refresh` answers the token in the body and writes no cookie. Reply note G3 filled. Not tagged, not pushed: the v0.5.0 wave (these six quicks + admin keyboard shortcuts + MCP) is the first release.
## Invoke
```
/msd-quick --validate /fetch /refresh /update /change-password must accept the token/auth_token cookies the same way jwt.auth and EndSession already do. Logout is already fixed. See .planning/todos/pending/2026-10-22-user-session-routes-ignore-cookie.md and .planning/notes/2026-10-22-external-user-plugin-escalations.md
```
## Closed 2026-10-23
Shipped in sm-user-plugin v0.1.9 (8e4b863), quick task 261022-tto. Requires SummerCMS v0.4.3.

View File

@@ -48,3 +48,8 @@ Confirmed and fixed locally; closes when released. Debug session:
- Ships in sm-user-plugin v0.1.8 (with `aa83969`, needs SummerCMS v0.4.3) and the sm-demo-app
pointer bumps. Hand check after deploy: cookie-only logout, then a `jwt.auth` route with the old
cookie answers 401.
Released 2026-10-22: sm-user-plugin v0.1.8 (930b158, with SummerCMS v0.4.3); pointers bumped and
pushed in sm-demo-app (e587980, vue-demo-app 8f8e70d), sm-bm-app, sm-grzybyfunkcjonalne-app and
sm-summercmsio-app; fonoteka.go not bumped (34 unpushed commits from another session). Remaining:
deploy, then the hand check above; close the todo and the debug session after it.

View File

@@ -0,0 +1,8 @@
---
title: Show the administrators holding a role on the Roles screen
date: 2026-10-22
priority: low
area: cabana
---
From the 19.6.1 UAT (test 6): the Roles form and preview show a role's code, name and permissions but not who holds it. Add a list of the role's administrators, using the relation widget if cabana's relation field can render a has-many list for `summercms.cabana.roles` (WinterCMS `UserRoles` shows the users as a relation list). It is read-only at minimum; assignment stays on the Administrators form. Respect D-03: superusers stay hidden from non-superuser editors in that list as well.

View File

@@ -110,6 +110,7 @@ The `migrate`, `migrate:status`, `migrate:rollback`, `serve` and admin commands
| [pact](modules/pact/README.md) | Capability interfaces that compiled plugins implement to contribute routes, config, migrations, middleware, commands, admin screens, translations, mail templates and jobs. | An agreement both sides keep; it holds the interfaces a plugin agrees to implement. |
| [party](modules/party/README.md) | Compiled plugin registry that orders plugins by their dependencies and runs their Register and Boot lifecycle. | The guest list and the order people arrive in; it registers plugins and boots them in dependency order. |
| [phrasebook](modules/phrasebook/README.md) | Namespaced translation catalogs loaded from plugin YAML, with locale fallback, placeholder interpolation and CLDR pluralization. | What you pack to speak the local language on holiday; it holds the translations. |
| [pier](modules/pier/README.md) | Opt-in MCP endpoint that lists the tools and prompts plugins declare per caller and runs every tool call in-process through the plugin's own token-guarded route as the caller's pre-resolved principal. | The pier where outside boats dock to reach the beach; agents connect here to reach the application's plugins. |
| [postcard](modules/postcard/README.md) | Transactional mail from plugin-owned Markdown templates and layouts, delivered through a memory, log or SMTP driver. | What you send home in summer; it delivers the application's mail. |
| [seaglass](modules/seaglass/README.md) | HTML sanitizer for stored rich text: a bluemonday allowlist policy that returns clean HTML byte for byte and reports what it removed from the rest. | Glass the sea has worn smooth; rough HTML goes in and only the safe, smooth part comes out. |
| [sieve](modules/sieve/README.md) | Generic, dependency-free collection helpers that the standard library slices and maps packages lack: mapping, filtering, reducing, keying, grouping, deduplicating, partitioning and finding, plus a small set type. | A sand sieve: you shake a collection through it and keep what you need; map, filter and reduce for slices and maps. |

View File

@@ -1,6 +1,75 @@
{
"components": {
"schemas": {
"cabana.AccountActionResultView": {
"properties": {
"message": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"message",
"url"
],
"type": "object"
},
"cabana.AccountContributionActionView": {
"properties": {
"confirm": {
"type": "string"
},
"danger": {
"type": "boolean"
},
"label": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"confirm",
"danger",
"label",
"name"
],
"type": "object"
},
"cabana.AccountContributionView": {
"properties": {
"actions": {
"items": {
"$ref": "#/components/schemas/cabana.AccountContributionActionView"
},
"type": "array"
},
"description": {
"type": "string"
},
"label": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"description": "Status is the section's line for the signed-in admin; \"\" when the\nsection has none.",
"type": "string"
}
},
"required": [
"actions",
"description",
"label",
"name",
"status"
],
"type": "object"
},
"cabana.AdminAPIToken": {
"properties": {
"created_at": {
@@ -677,6 +746,24 @@
],
"type": "object"
},
"cabana.Envelope-array_cabana_AccountContributionView": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/cabana.AccountContributionView"
},
"type": "array"
},
"meta": {
"$ref": "#/components/schemas/cabana.SuccessMeta"
}
},
"required": [
"data",
"meta"
],
"type": "object"
},
"cabana.Envelope-array_cabana_AdminAPIToken": {
"properties": {
"data": {
@@ -785,6 +872,21 @@
],
"type": "object"
},
"cabana.Envelope-cabana_AccountActionResultView": {
"properties": {
"data": {
"$ref": "#/components/schemas/cabana.AccountActionResultView"
},
"meta": {
"$ref": "#/components/schemas/cabana.SuccessMeta"
}
},
"required": [
"data",
"meta"
],
"type": "object"
},
"cabana.Envelope-cabana_AdminAPIToken": {
"properties": {
"data": {
@@ -1194,6 +1296,25 @@
],
"type": "object"
},
"cabana.FieldTrigger": {
"properties": {
"action": {
"type": "string"
},
"condition": {
"type": "string"
},
"field": {
"type": "string"
}
},
"required": [
"action",
"condition",
"field"
],
"type": "object"
},
"cabana.FieldTypeAssets": {
"properties": {
"element": {
@@ -1551,6 +1672,14 @@
"description": "Translatable is true when a plugin field type's value is a map of\ncontent locale to string.",
"type": "boolean"
},
"trigger": {
"allOf": [
{
"$ref": "#/components/schemas/cabana.FieldTrigger"
}
],
"description": "Trigger disables or hides the field in the admin while a switch or\ncheckbox of the same form is checked or unchecked (fields.yaml\ntrigger). A disabled or hidden field is left out of the save body; the\nserver keeps its stored value and never relies on the trigger."
},
"twelveHour": {
"description": "TwelveHour shows a 12-hour clock.",
"type": "boolean"
@@ -2301,6 +2430,25 @@
],
"type": "object"
},
"cabana.PermissionRecordLock": {
"properties": {
"code": {
"type": "string"
},
"note": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"code",
"note",
"value"
],
"type": "object"
},
"cabana.RecordAction": {
"properties": {
"confirm": {
@@ -2315,6 +2463,14 @@
},
"name": {
"type": "string"
},
"prompt": {
"allOf": [
{
"$ref": "#/components/schemas/cabana.RecordActionPrompt"
}
],
"description": "Prompt is present only for an action that asks for one text value in\nits confirm dialog (pact.AdminRecordAction.Prompt); the admin posts the\nvalue as the body key payload, a JSON string."
}
},
"required": [
@@ -2323,6 +2479,27 @@
],
"type": "object"
},
"cabana.RecordActionPrompt": {
"properties": {
"comment": {
"type": "string"
},
"label": {
"type": "string"
},
"max_length": {
"type": "integer"
},
"placeholder": {
"type": "string"
}
},
"required": [
"label",
"max_length"
],
"type": "object"
},
"cabana.RecordEnvelope": {
"properties": {
"data": {
@@ -2361,6 +2538,16 @@
},
"type": "array"
},
"permissionLocks": {
"additionalProperties": {
"items": {
"$ref": "#/components/schemas/cabana.PermissionRecordLock"
},
"type": "array"
},
"description": "PermissionLocks are, per permissioneditor field, the permissions this\nrecord fixes (the controller's PermissionRecordLockProvider), with the\nvalue to show and the note, translated in the request locale. The show\nand save responses carry it; it is omitted when no record lock applies\nand is never part of the form schema.",
"type": "object"
},
"title": {
"description": "Title is the controller's record title (pact.FormRecordTitle), omitted\nwhen the controller names none.",
"type": "string"
@@ -3041,6 +3228,148 @@
]
}
},
"/account/contributions": {
"get": {
"description": "Lists the sections plugins contribute to the signed-in admin's My account page: label, description, the status for this admin and the actions they may run that apply to them. Empty when no plugin contributes. Personal API tokens are refused (403 interactive_only).",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.Envelope-array_cabana_AccountContributionView"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Forbidden"
}
},
"security": [
{
"BackendBearer": []
}
],
"summary": "List My account contributions",
"tags": [
"admin"
]
}
},
"/account/contributions/{name}/actions/{action}": {
"post": {
"description": "Runs one action of a contributed section for the signed-in admin. The action's permissions are checked (403) and its Applies rule again (409 when it no longer applies); the answer is the action's message and an optional URL to open. Personal API tokens are refused (403 interactive_only).",
"parameters": [
{
"description": "Section name",
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Action name",
"in": "path",
"name": "action",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.Envelope-cabana_AccountActionResultView"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cabana.ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
}
},
"security": [
{
"BackendBearer": []
}
],
"summary": "Run a My account contribution action",
"tags": [
"admin"
]
}
},
"/account/preferences": {
"get": {
"description": "The signed-in admin's own UI preferences: theme (system, light or dark; system when not set) and locale (an admin locale code, or \"\" to follow the request locale). Interactive session only (403 interactive_only for personal API tokens).",
@@ -5258,7 +5587,7 @@
},
"/{vendor}/{plugin}/{controller}/schema/form": {
"get": {
"description": "The form of a controller, localized. `preview` is present when config_form.yaml declares a preview block: the form then has a read-only preview screen, which shows the fields whose context allows preview, the record actions and, when preview.headerPartial is set, that partial as a status hint. A `type: password` field and every other field the controller lists as virtual is sent in a save body and never has a value in a record response. `preset` on a text or mltext field names the text or mltext field it follows on the create form (type slug or exact; an mltext pair follows per locale) until the administrator edits it. A `type: permissioneditor` field carries `permissionOptions`, the permissions the controller offers the requesting administrator; its value in a record response and in a save body is an object of permission code to integer (radio mode 1 or -1, checkbox mode 1). A `type: relation` field over a protected foreign key is `readOnly` unless its contract declares the key writable. A field whose type a plugin registers carries `element` (the custom-element tag the admin renders), `translatable` (its value is an object of content locale to string) and `typeOptions` (the type's own fields.yaml keys). A `type: dropdown` field with `dependsOn` names the sibling field whose value selects its options and carries no options: they come from the field's dependent-options route. A `type: richeditor` field's value is a string of HTML, sanitized on every save; what the sanitizer removed is reported in the save response's `meta.notices`. A `type: repeater` field carries `form.fields` (the fields of one row), `prompt`, `maxItems`, `minItems` and `titleFrom`; its value in a record response and in a save body is a list of row objects keyed by the nested field names, and a row's errors are keyed `\u003cfield\u003e.\u003cindex\u003e.\u003cnested\u003e`.",
"description": "The form of a controller, localized. `preview` is present when config_form.yaml declares a preview block: the form then has a read-only preview screen, which shows the fields whose context allows preview, the record actions and, when preview.headerPartial is set, that partial as a status hint. A `type: password` field and every other field the controller lists as virtual is sent in a save body and never has a value in a record response. `preset` on a text or mltext field names the text or mltext field it follows on the create form (type slug or exact; an mltext pair follows per locale) until the administrator edits it. A `type: permissioneditor` field carries `permissionOptions`, the permissions the controller offers the requesting administrator; its value in a record response and in a save body is an object of permission code to integer (radio mode 1 or -1, checkbox mode 1). A `type: relation` field over a protected foreign key is `readOnly` unless its contract declares the key writable. A field whose type a plugin registers carries `element` (the custom-element tag the admin renders), `translatable` (its value is an object of content locale to string) and `typeOptions` (the type's own fields.yaml keys). A `type: dropdown` field with `dependsOn` names the sibling field whose value selects its options and carries no options: they come from the field's dependent-options route. `trigger` ({action, field, condition}) disables (action disable: shown read-only) or hides (action hide) the field while the switch or checkbox `field` of the same form is checked or unchecked; the admin leaves such a field out of the save body and the server keeps its stored value, so the trigger is a display rule only. A `type: richeditor` field's value is a string of HTML, sanitized on every save; what the sanitizer removed is reported in the save response's `meta.notices`. A `type: repeater` field carries `form.fields` (the fields of one row), `prompt`, `maxItems`, `minItems` and `titleFrom`; its value in a record response and in a save body is a list of row objects keyed by the nested field names, and a row's errors are keyed `\u003cfield\u003e.\u003cindex\u003e.\u003cnested\u003e`.",
"parameters": [
{
"description": "Vendor",
@@ -5936,7 +6265,7 @@
]
},
"get": {
"description": "meta.labels carries the display labels of relation fields. meta.actions lists the declared record actions the requesting admin may run and that apply to the record's current state; it is absent when none is offered.",
"description": "meta.labels carries the display labels of relation fields. meta.actions lists the declared record actions the requesting admin may run and that apply to the record's current state; it is absent when none is offered. meta.permissionLocks maps a `type: permissioneditor` field to the permissions this record fixes (the controller's cabana.PermissionRecordLockProvider), each with code, value (1, -1, or 0 for inherit) and note (localized): the admin shows that value and the note on the row and never sends the code; it is absent when no record lock applies.",
"parameters": [
{
"description": "Vendor",
@@ -6028,7 +6357,7 @@
]
},
"put": {
"description": "A plugin field type's value is decoded by its type inside the save; a value equal to the one the form was served for that field and locale is neither decoded nor written. When a type reports what it changed, meta.notices lists the localized messages per field (and content locale), and the key is absent otherwise.",
"description": "A plugin field type's value is decoded by its type inside the save; a value equal to the one the form was served for that field and locale is neither decoded nor written. When a type reports what it changed, meta.notices lists the localized messages per field (and content locale), and the key is absent otherwise. A record-locked permission (meta.permissionLocks) keeps its stored value when its code is absent from the body; a present value that differs from the stored one is a 403 on the field. The response carries meta.permissionLocks like the show route.",
"parameters": [
{
"description": "Vendor",

View File

@@ -3,6 +3,7 @@ import { computed, watchEffect } from 'vue'
import { RouterView, useRoute } from 'vue-router'
import { documentTitleForRoute } from './app/pageTitle'
import AppShell from './components/shell/AppShell.vue'
import { remountRevision } from './state/useRemount'
const route = useRoute()
const inShell = computed(() => route.meta.shell === true)
@@ -14,10 +15,12 @@ watchEffect(() => {
<template>
<!-- Keyed by path, not full path: a new controller or record remounts its
view, while list query changes (search, sort, page) keep it. -->
view, while list query changes (search, sort, page) keep it. The
remount revision is part of the key, so a view can remount itself in
place (Create and new). -->
<AppShell v-if="inShell">
<RouterView v-slot="{ Component, route: current }">
<component :is="Component" :key="current.path" />
<component :is="Component" :key="`${current.path}#${remountRevision}`" />
</RouterView>
</AppShell>
<RouterView v-else />

View File

@@ -210,6 +210,152 @@ export interface paths {
patch?: never;
trace?: never;
};
"/account/contributions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List My account contributions
* @description Lists the sections plugins contribute to the signed-in admin's My account page: label, description, the status for this admin and the actions they may run that apply to them. Empty when no plugin contributes. Personal API tokens are refused (403 interactive_only).
*/
get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.Envelope-array_cabana_AccountContributionView"];
};
};
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/account/contributions/{name}/actions/{action}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Run a My account contribution action
* @description Runs one action of a contributed section for the signed-in admin. The action's permissions are checked (403) and its Applies rule again (409 when it no longer applies); the answer is the action's message and an optional URL to open. Personal API tokens are refused (403 interactive_only).
*/
post: {
parameters: {
query?: never;
header?: never;
path: {
/** @description Section name */
name: string;
/** @description Action name */
action: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description OK */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.Envelope-cabana_AccountActionResultView"];
};
};
/** @description Unauthorized */
401: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
/** @description Forbidden */
403: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
/** @description Not Found */
404: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
/** @description Conflict */
409: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
/** @description Unprocessable Entity */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["cabana.ErrorEnvelope"];
};
};
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/account/preferences": {
parameters: {
query?: never;
@@ -2200,7 +2346,7 @@ export interface paths {
};
/**
* Admin form schema
* @description The form of a controller, localized. `preview` is present when config_form.yaml declares a preview block: the form then has a read-only preview screen, which shows the fields whose context allows preview, the record actions and, when preview.headerPartial is set, that partial as a status hint. A `type: password` field and every other field the controller lists as virtual is sent in a save body and never has a value in a record response. `preset` on a text or mltext field names the text or mltext field it follows on the create form (type slug or exact; an mltext pair follows per locale) until the administrator edits it. A `type: permissioneditor` field carries `permissionOptions`, the permissions the controller offers the requesting administrator; its value in a record response and in a save body is an object of permission code to integer (radio mode 1 or -1, checkbox mode 1). A `type: relation` field over a protected foreign key is `readOnly` unless its contract declares the key writable. A field whose type a plugin registers carries `element` (the custom-element tag the admin renders), `translatable` (its value is an object of content locale to string) and `typeOptions` (the type's own fields.yaml keys). A `type: dropdown` field with `dependsOn` names the sibling field whose value selects its options and carries no options: they come from the field's dependent-options route. A `type: richeditor` field's value is a string of HTML, sanitized on every save; what the sanitizer removed is reported in the save response's `meta.notices`. A `type: repeater` field carries `form.fields` (the fields of one row), `prompt`, `maxItems`, `minItems` and `titleFrom`; its value in a record response and in a save body is a list of row objects keyed by the nested field names, and a row's errors are keyed `<field>.<index>.<nested>`.
* @description The form of a controller, localized. `preview` is present when config_form.yaml declares a preview block: the form then has a read-only preview screen, which shows the fields whose context allows preview, the record actions and, when preview.headerPartial is set, that partial as a status hint. A `type: password` field and every other field the controller lists as virtual is sent in a save body and never has a value in a record response. `preset` on a text or mltext field names the text or mltext field it follows on the create form (type slug or exact; an mltext pair follows per locale) until the administrator edits it. A `type: permissioneditor` field carries `permissionOptions`, the permissions the controller offers the requesting administrator; its value in a record response and in a save body is an object of permission code to integer (radio mode 1 or -1, checkbox mode 1). A `type: relation` field over a protected foreign key is `readOnly` unless its contract declares the key writable. A field whose type a plugin registers carries `element` (the custom-element tag the admin renders), `translatable` (its value is an object of content locale to string) and `typeOptions` (the type's own fields.yaml keys). A `type: dropdown` field with `dependsOn` names the sibling field whose value selects its options and carries no options: they come from the field's dependent-options route. `trigger` ({action, field, condition}) disables (action disable: shown read-only) or hides (action hide) the field while the switch or checkbox `field` of the same form is checked or unchecked; the admin leaves such a field out of the save body and the server keeps its stored value, so the trigger is a display rule only. A `type: richeditor` field's value is a string of HTML, sanitized on every save; what the sanitizer removed is reported in the save response's `meta.notices`. A `type: repeater` field carries `form.fields` (the fields of one row), `prompt`, `maxItems`, `minItems` and `titleFrom`; its value in a record response and in a save body is a list of row objects keyed by the nested field names, and a row's errors are keyed `<field>.<index>.<nested>`.
*/
get: {
parameters: {
@@ -2666,7 +2812,7 @@ export interface paths {
};
/**
* Show an admin record
* @description meta.labels carries the display labels of relation fields. meta.actions lists the declared record actions the requesting admin may run and that apply to the record's current state; it is absent when none is offered.
* @description meta.labels carries the display labels of relation fields. meta.actions lists the declared record actions the requesting admin may run and that apply to the record's current state; it is absent when none is offered. meta.permissionLocks maps a `type: permissioneditor` field to the permissions this record fixes (the controller's cabana.PermissionRecordLockProvider), each with code, value (1, -1, or 0 for inherit) and note (localized): the admin shows that value and the note on the row and never sends the code; it is absent when no record lock applies.
*/
get: {
parameters: {
@@ -2726,7 +2872,7 @@ export interface paths {
};
/**
* Update an admin record
* @description A plugin field type's value is decoded by its type inside the save; a value equal to the one the form was served for that field and locale is neither decoded nor written. When a type reports what it changed, meta.notices lists the localized messages per field (and content locale), and the key is absent otherwise.
* @description A plugin field type's value is decoded by its type inside the save; a value equal to the one the form was served for that field and locale is neither decoded nor written. When a type reports what it changed, meta.notices lists the localized messages per field (and content locale), and the key is absent otherwise. A record-locked permission (meta.permissionLocks) keeps its stored value when its code is absent from the body; a present value that differs from the stored one is a 403 on the field. The response carries meta.permissionLocks like the show route.
*/
put: {
parameters: {
@@ -5362,6 +5508,27 @@ export interface paths {
export type webhooks = Record<string, never>;
export interface components {
schemas: {
"cabana.AccountActionResultView": {
message: string;
url: string;
};
"cabana.AccountContributionActionView": {
confirm: string;
danger: boolean;
label: string;
name: string;
};
"cabana.AccountContributionView": {
actions: components["schemas"]["cabana.AccountContributionActionView"][];
description: string;
label: string;
name: string;
/**
* @description Status is the section's line for the signed-in admin; "" when the
* section has none.
*/
status: string;
};
"cabana.AdminAPIToken": {
created_at: string;
expired: boolean;
@@ -5569,6 +5736,10 @@ export interface components {
scripts: string[];
styles: string[];
};
"cabana.Envelope-array_cabana_AccountContributionView": {
data: components["schemas"]["cabana.AccountContributionView"][];
meta: components["schemas"]["cabana.SuccessMeta"];
};
"cabana.Envelope-array_cabana_AdminAPIToken": {
data: components["schemas"]["cabana.AdminAPIToken"][];
meta: components["schemas"]["cabana.SuccessMeta"];
@@ -5593,6 +5764,10 @@ export interface components {
data: components["schemas"]["cabana.SettingsEntry"][];
meta: components["schemas"]["cabana.SuccessMeta"];
};
"cabana.Envelope-cabana_AccountActionResultView": {
data: components["schemas"]["cabana.AccountActionResultView"];
meta: components["schemas"]["cabana.SuccessMeta"];
};
"cabana.Envelope-cabana_AdminAPIToken": {
data: components["schemas"]["cabana.AdminAPIToken"];
meta: components["schemas"]["cabana.SuccessMeta"];
@@ -5704,6 +5879,11 @@ export interface components {
field: string;
type: string;
};
"cabana.FieldTrigger": {
action: string;
condition: string;
field: string;
};
"cabana.FieldTypeAssets": {
element: string;
name: string;
@@ -5889,6 +6069,13 @@ export interface components {
* content locale to string.
*/
translatable?: boolean;
/**
* @description Trigger disables or hides the field in the admin while a switch or
* checkbox of the same form is checked or unchecked (fields.yaml
* trigger). A disabled or hidden field is left out of the save body; the
* server keeps its stored value and never relies on the trigger.
*/
trigger?: components["schemas"]["cabana.FieldTrigger"];
/** @description TwelveHour shows a 12-hour clock. */
twelveHour?: boolean;
type: string;
@@ -6138,6 +6325,11 @@ export interface components {
locked?: boolean;
tab?: string;
};
"cabana.PermissionRecordLock": {
code: string;
note: string;
value: number;
};
"cabana.RecordAction": {
confirm?: string;
/**
@@ -6147,6 +6339,18 @@ export interface components {
danger?: boolean;
label: string;
name: string;
/**
* @description Prompt is present only for an action that asks for one text value in
* its confirm dialog (pact.AdminRecordAction.Prompt); the admin posts the
* value as the body key payload, a JSON string.
*/
prompt?: components["schemas"]["cabana.RecordActionPrompt"];
};
"cabana.RecordActionPrompt": {
comment?: string;
label: string;
max_length: number;
placeholder?: string;
};
"cabana.RecordEnvelope": {
data: components["schemas"]["cabana.AdminRecord"];
@@ -6158,6 +6362,16 @@ export interface components {
[key: string]: components["schemas"]["cabana.RelationOption"][];
};
notices?: components["schemas"]["cabana.FieldNotice"][];
/**
* @description PermissionLocks are, per permissioneditor field, the permissions this
* record fixes (the controller's PermissionRecordLockProvider), with the
* value to show and the note, translated in the request locale. The show
* and save responses carry it; it is omitted when no record lock applies
* and is never part of the form schema.
*/
permissionLocks?: {
[key: string]: components["schemas"]["cabana.PermissionRecordLock"][];
};
/**
* @description Title is the controller's record title (pact.FormRecordTitle), omitted
* when the controller names none.

View File

@@ -40,7 +40,11 @@ export type FormRedirects = Schemas['cabana.FormRedirects']
/** A form's preview screen: present when config_form.yaml declares `preview:`. */
export type FormPreview = Schemas['cabana.FormPreview']
export type FieldPreset = Schemas['cabana.FieldPreset']
/** A field's fields.yaml trigger: disable or hide it while a switch or checkbox is checked or unchecked. */
export type FieldTrigger = Schemas['cabana.FieldTrigger']
export type PermissionOption = Schemas['cabana.PermissionOption']
/** A permission a stored record fixes (meta.permissionLocks): the value and note to show. */
export type PermissionRecordLock = Schemas['cabana.PermissionRecordLock']
export type RelationSchema = Schemas['cabana.RelationSchema']
export type RelationMessages = Schemas['cabana.RelationMessages']
export type RelationMutationResult = Schemas['cabana.RelationMutationResult']
@@ -55,6 +59,14 @@ export type BulkResult = Schemas['cabana.BulkResult']
export type BulkAction = Schemas['cabana.BulkAction']
/** A record action the record response offers: name, label and confirm text. */
export type RecordAction = Schemas['cabana.RecordAction']
/** The text input a prompted record action asks for in its confirm dialog. */
export type RecordActionPrompt = Schemas['cabana.RecordActionPrompt']
/** A section a plugin contributes to My account: label, status and offered actions. */
export type AccountContribution = Schemas['cabana.AccountContributionView']
/** One action of a contributed My account section. */
export type AccountContributionAction = Schemas['cabana.AccountContributionActionView']
/** An account contribution action's answer: the toast message and an optional URL. */
export type AccountActionResult = Schemas['cabana.AccountActionResultView']
/** A declared bulk action's answer: the toast message and the affected count. */
export type BulkActionResult = Schemas['cabana.BulkActionResult']
/** Body of a widget action: the record id (absent on create) and fill values. */

263
admin/src/app/hotkeys.ts Normal file
View File

@@ -0,0 +1,263 @@
// Admin keyboard shortcuts, after WinterCMS's data-hotkey: a button carries
// the shortcut in a data-hotkey attribute (space-separated tokens) and the
// shortcut clicks that button, so it does exactly what the button does and
// nothing while the button is disabled. Supported tokens: mod+s, mod+enter,
// mod+shift+s (mod is Ctrl or Cmd, both accepted on every platform, as
// WinterCMS binds ctrl+s and cmd+s), escape, / and ?. An input carrying
// a token is focused instead of clicked (the list search).
//
// Where a shortcut looks: the innermost open modal (a dialog with
// aria-modal, or an alert dialog), else the whole page, so a modal form
// takes the save keys from the form underneath and a confirmation takes
// them from both (hotkeyRoot). Popovers are dialogs without aria-modal and
// are not roots.
//
// Modifier shortcuts fire everywhere, also while typing in an input, a
// textarea, a code field or the rich editor. Their listener runs in the
// window capture phase and stops the event when a target exists, so the
// rich editor does not also insert a hard break (Mod-Enter) or toggle
// strikethrough (Mod-Shift-s); without a target the event passes through and
// those editor keys keep working. Ctrl+S never opens the browser's Save page
// inside the shell. Plain keys (Esc, / and ?) never fire in an editable
// control, after a component handled the key (defaultPrevented), or while any
// dismissable layer (dialog, popover, dropdown, select, link popover) is
// open: those close on Esc themselves without calling preventDefault, so the
// DOM is checked for their data-dismissable-layer attribute instead.
import { readonly, ref } from 'vue'
import { t } from './i18n'
export type HotkeyCombo = 'mod+s' | 'mod+enter' | 'mod+shift+s' | 'escape' | '/' | '?'
export interface ShortcutEntry {
combo: HotkeyCombo
labelKey: string
}
/** Every shortcut the admin knows, in help-dialog order. */
export const SHORTCUTS: readonly ShortcutEntry[] = [
{ combo: 'mod+s', labelKey: 'backend::lang.form.save' },
{ combo: 'mod+enter', labelKey: 'backend::lang.form.save_and_close' },
{ combo: 'mod+shift+s', labelKey: 'backend::lang.form.create_and_new' },
{ combo: 'escape', labelKey: 'backend::lang.shortcuts.leave' },
{ combo: '/', labelKey: 'backend::lang.shortcuts.search' },
{ combo: '?', labelKey: 'backend::lang.shortcuts.help' },
]
const MOD_COMBOS: ReadonlySet<HotkeyCombo> = new Set(['mod+s', 'mod+enter', 'mod+shift+s'])
/** True on macOS and iOS (the labels use the ⌘ glyphs there). */
export function isMacPlatform(platform?: string): boolean {
const value = platform ?? (typeof navigator === 'undefined' ? '' : navigator.platform || '')
return /mac|iphone|ipad|ipod/i.test(value)
}
/** The letter of a modified key; event.code covers non-Latin layouts. */
function letterOf(event: KeyboardEvent): string {
if (/^[a-z]$/i.test(event.key)) {
return event.key.toLowerCase()
}
const match = /^Key([A-Z])$/.exec(event.code ?? '')
return match ? match[1]!.toLowerCase() : ''
}
/**
* The shortcut a keydown means, or null. Modifier combos need Ctrl or Cmd
* and no Alt (AltGr arrives as Ctrl+Alt and types letters such as ś).
*/
export function comboOf(event: KeyboardEvent): HotkeyCombo | null {
if (event.isComposing) {
return null
}
if (event.ctrlKey || event.metaKey) {
if (event.altKey) {
return null
}
if (event.key === 'Enter') {
return event.shiftKey ? null : 'mod+enter'
}
if (letterOf(event) === 's') {
return event.shiftKey ? 'mod+shift+s' : 'mod+s'
}
return null
}
if (event.altKey) {
return null
}
// Shift is ignored for / and ?: keyboard layouts place them differently.
switch (event.key) {
case 'Escape':
return 'escape'
case '/':
return '/'
case '?':
return '?'
default:
return null
}
}
/** True when the target is inside an input, textarea, select or contenteditable element. */
export function isEditableTarget(target: EventTarget | null): boolean {
if (!target || typeof (target as Element).closest !== 'function') {
return false
}
return (target as Element).closest('input, textarea, select, [contenteditable]:not([contenteditable="false"])') !== null
}
/** The keys of a shortcut as shown on screen, one chip each. */
export function shortcutParts(combo: HotkeyCombo, mac: boolean = isMacPlatform()): string[] {
switch (combo) {
case 'mod+s':
return mac ? ['⌘', 'S'] : ['Ctrl', 'S']
case 'mod+enter':
return mac ? ['⌘', '↩'] : ['Ctrl', 'Enter']
case 'mod+shift+s':
return mac ? ['⇧', '⌘', 'S'] : ['Ctrl', 'Shift', 'S']
case 'escape':
return ['Esc']
default:
return [combo]
}
}
/** The shortcut as one string: Ctrl+Shift+S, or ⇧⌘S on macOS. */
export function shortcutLabel(combo: HotkeyCombo, mac: boolean = isMacPlatform()): string {
return shortcutParts(combo, mac).join(mac ? '' : '+')
}
/** A button tooltip naming its shortcut, for example "Zapisz (Ctrl+S)". */
export function shortcutHint(label: string, combo: HotkeyCombo, mac: boolean = isMacPlatform()): string {
return t('backend::lang.shortcuts.hint', { label, keys: shortcutLabel(combo, mac) })
}
const ARIA: Record<HotkeyCombo, string> = {
'mod+s': 'Control+S Meta+S',
'mod+enter': 'Control+Enter Meta+Enter',
'mod+shift+s': 'Control+Shift+S Meta+Shift+S',
escape: 'Escape',
'/': '/',
'?': '?',
}
/** The aria-keyshortcuts value of a data-hotkey token list (Control and Meta forms of each mod token). */
export function ariaKeyshortcuts(hotkey: string): string {
return hotkey
.split(/\s+/)
.filter((token): token is HotkeyCombo => token in ARIA)
.map((token) => ARIA[token])
.join(' ')
}
/** The innermost open modal (aria-modal dialog or alert dialog), else the document. */
export function hotkeyRoot(doc: Document = document): ParentNode {
const modals = Array.from(
doc.querySelectorAll('[role="dialog"][aria-modal="true"], [role="alertdialog"]'),
).filter((element) => element.getAttribute('data-state') !== 'closed')
return modals.at(-1) ?? doc
}
/** The first element in root whose data-hotkey lists the combo. */
export function hotkeyTarget(combo: HotkeyCombo, root: ParentNode): HTMLElement | null {
return root.querySelector<HTMLElement>(`[data-hotkey~="${combo}"]`)
}
/** The shortcuts the current screen answers, plus ? itself. */
export function availableShortcuts(doc: Document = document): ShortcutEntry[] {
const root = hotkeyRoot(doc)
return SHORTCUTS.filter((entry) => entry.combo === '?' || hotkeyTarget(entry.combo, root) !== null)
}
const help = ref<readonly ShortcutEntry[] | null>(null)
/** The entries the help dialog shows, or null while it is closed. */
export const shortcutHelp = readonly(help)
export function openShortcutHelp(): void {
help.value = availableShortcuts()
}
export function closeShortcutHelp(): void {
help.value = null
}
function isDisabled(element: HTMLElement): boolean {
return (element as HTMLButtonElement).disabled === true || element.getAttribute('aria-disabled') === 'true'
}
function onModifierKey(event: KeyboardEvent): void {
const combo = comboOf(event)
if (!combo || !MOD_COMBOS.has(combo)) {
return
}
if (combo === 'mod+s') {
event.preventDefault()
}
const doc = (event.target as Node | null)?.ownerDocument ?? document
const target = hotkeyTarget(combo, hotkeyRoot(doc))
if (!target) {
return
}
event.preventDefault()
event.stopPropagation()
if (event.repeat || isDisabled(target)) {
return
}
target.click()
}
function onPlainKey(event: KeyboardEvent): void {
const combo = comboOf(event)
if (combo !== 'escape' && combo !== '/' && combo !== '?') {
return
}
if (event.defaultPrevented || isEditableTarget(event.target)) {
return
}
const doc = (event.target as Node | null)?.ownerDocument ?? document
if (doc.querySelector('[data-dismissable-layer]')) {
return
}
if (combo === '?') {
event.preventDefault()
openShortcutHelp()
return
}
const target = hotkeyTarget(combo, doc)
if (!target || isDisabled(target)) {
return
}
event.preventDefault()
if (target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement) {
target.focus()
target.select()
} else {
target.click()
}
}
let installs = 0
/**
* Adds the window listeners; returns an idempotent uninstall. Reference
* counted: the listeners exist once however many times it is installed and
* go when every install has been undone.
*/
export function installHotkeys(): () => void {
if (installs === 0) {
window.addEventListener('keydown', onModifierKey, true)
window.addEventListener('keydown', onPlainKey)
}
installs++
let done = false
return () => {
if (done) {
return
}
done = true
installs--
if (installs === 0) {
window.removeEventListener('keydown', onModifierKey, true)
window.removeEventListener('keydown', onPlainKey)
}
}
}

View File

@@ -0,0 +1,126 @@
<script setup lang="ts">
import { onMounted, ref } from 'vue'
import { api } from '../../api/client'
import type { AccountContribution, AccountContributionAction } from '../../api/types'
import { t } from '../../app/i18n'
import Button from '../ui/Button.vue'
import type { useConfirm } from '../ui/confirm'
import { showToast } from '../../state/useToasts'
// My account sections plugins contribute (phase 19.7, D-04 part 1): one card
// per section with its status line and one outline button per action. The
// server already reduced the actions to what the admin may run and what
// applies to them; labels, descriptions, statuses and messages arrive
// translated and render as text. Nothing renders while the list is empty.
// Shares AccountView's useConfirm() so ConfirmDialog stays at z-[90].
const props = defineProps<{
confirm: ReturnType<typeof useConfirm>
}>()
const sections = ref<AccountContribution[]>([])
const running = ref('')
/** The URL the last action answered, per section, kept as a visible link. */
const links = ref<Record<string, string>>({})
async function load(): Promise<void> {
try {
const result = await api.GET('/account/contributions')
sections.value = result.data?.data ?? []
} catch {
sections.value = []
}
}
async function post(section: AccountContribution, action: AccountContributionAction): Promise<void> {
running.value = `${section.name}/${action.name}`
try {
const result = await api.POST('/account/contributions/{name}/actions/{action}', {
params: { path: { name: section.name, action: action.name } },
})
if (result.data) {
const answer = result.data.data
showToast(answer.message || t('backend::lang.form.action_done'))
if (answer.url) {
links.value = { ...links.value, [section.name]: answer.url }
window.open(answer.url, '_blank', 'noopener')
}
await load()
return
}
const status = result.response.status
if (status === 409) {
showToast(t('backend::lang.form.action_stale'), 'danger')
await load()
return
}
if (status === 403) {
showToast(result.error?.error.message || t('backend::lang.list.action_forbidden'), 'danger')
return
}
showToast(result.error?.error.message || t('backend::lang.extension.action_failed'), 'danger')
} catch {
showToast(t('backend::lang.extension.action_failed'), 'danger')
} finally {
running.value = ''
}
}
async function run(section: AccountContribution, action: AccountContributionAction): Promise<void> {
if (running.value) {
return
}
if (!action.confirm && !action.danger) {
await post(section, action)
return
}
await props.confirm.ask(
{
message: action.confirm || t('backend::lang.form.action_confirm', { action: action.label }),
confirmLabel: action.label,
danger: action.danger,
},
() => post(section, action),
)
}
onMounted(() => {
void load()
})
</script>
<template>
<div
v-for="section in sections"
:key="section.name"
:data-account-contribution="section.name"
class="flex flex-col gap-4 rounded-card border border-border bg-surface p-7 shadow-card"
>
<div class="flex flex-col gap-1">
<h2 class="text-[18px] font-bold">{{ section.label }}</h2>
<p v-if="section.description" class="max-w-[640px] text-[13px] text-muted">{{ section.description }}</p>
</div>
<p v-if="section.status" data-account-contribution-status class="font-medium">{{ section.status }}</p>
<a
v-if="links[section.name]"
data-account-contribution-url
:href="links[section.name]"
target="_blank"
rel="noopener noreferrer"
class="text-primary underline [overflow-wrap:anywhere]"
>{{ links[section.name] }}</a
>
<div v-if="section.actions.length > 0" class="flex flex-wrap gap-2.5">
<Button
v-for="action in section.actions"
:key="action.name"
variant="outline"
size="md"
:data-account-contribution-action="action.name"
:disabled="running !== ''"
@click="run(section, action)"
>
{{ action.label }}
</Button>
</div>
</div>
</template>

View File

@@ -13,6 +13,7 @@ import {
import { Check, CircleAlert, Copy, Info, LoaderCircle, TriangleAlert, X } from '@lucide/vue'
import { api } from '../../api/client'
import type { AdminAPITokenScope } from '../../api/types'
import { shortcutHint } from '../../app/hotkeys'
import { t } from '../../app/i18n'
import { controlClass } from '../form/control'
import { fieldErrors, focusField } from '../form/formState'
@@ -553,6 +554,8 @@ onBeforeUnmount(() => {
type="submit"
class="flex-1"
data-action="create-token-submit"
hotkey="mod+s mod+enter"
:title="shortcutHint(t('backend::lang.api_tokens.create_submit'), 'mod+s')"
:disabled="!canSubmit"
>
<LoaderCircle v-if="busy" :size="16" class="animate-spin" aria-hidden="true" />

View File

@@ -1,14 +1,17 @@
<script setup lang="ts">
import { computed } from 'vue'
import { CircleAlert } from '@lucide/vue'
import { computed, inject } from 'vue'
import { CircleAlert, Info } from '@lucide/vue'
import type { ControllerParams, FormField, RelationOption } from '../../api/types'
import FieldRenderer from './FieldRenderer.vue'
import { FIELD_SCOPE, FORM_TRIGGER_NOTES } from './formContext'
import { groupLabelled, isPluginField, ownsLabel } from './registry'
// One form row: label (600, red aria-hidden asterisk when required), the
// control, the comment, the error line and the save notices (what a plugin
// field type changed, D-10) linked by aria-describedby. Notices are text
// interpolation only: a notice may quote markup an administrator submitted.
// A field a trigger disables (D-21) shows the trigger note between the label
// and the control, so it stays visible above a long control.
const props = defineProps<{
field: FormField
modelValue: unknown
@@ -28,6 +31,12 @@ const controlId = computed(() => base.value)
const commentId = computed(() => `${base.value}-comment`)
const errorId = computed(() => `${base.value}-error`)
const noticeId = computed(() => `${base.value}-notice`)
const triggerId = computed(() => `${base.value}-trigger`)
// Notes are keyed by top-level field name: a repeater row's field (path
// `<repeater>.<field>`) never matches.
const scope = inject(FIELD_SCOPE, null)
const triggerNotes = inject(FORM_TRIGGER_NOTES, null)
const triggerNote = computed(() => triggerNotes?.value[scope ? scope.path(props.field.name) : props.field.name] ?? '')
const invalid = computed(() => (props.errors?.length ?? 0) > 0)
const noticed = computed(() => (props.notices?.length ?? 0) > 0)
const selfLabelled = computed(() => ownsLabel(props.field.type))
@@ -39,6 +48,7 @@ const showComment = computed(() => !selfLabelled.value && !!props.field.comment)
const describedBy = computed(() =>
[
triggerNote.value !== '' ? triggerId.value : '',
showComment.value || (selfLabelled.value && props.field.comment) ? commentId.value : '',
invalid.value ? errorId.value : '',
noticed.value ? noticeId.value : '',
@@ -56,6 +66,10 @@ const describedBy = computed(() =>
<label v-else-if="!selfLabelled && !labelsGroup" :id="`${controlId}-label`" :for="controlId" class="font-semibold">
{{ field.label || field.name }}<span v-if="field.required" class="text-danger" aria-hidden="true"> *</span>
</label>
<p v-if="triggerNote !== ''" :id="triggerId" data-trigger-note class="flex items-center gap-2 text-[13px] text-muted">
<Info :size="14" class="shrink-0" aria-hidden="true" />
<span>{{ triggerNote }}</span>
</p>
<FieldRenderer
:field="field"
:model-value="modelValue"

View File

@@ -16,6 +16,8 @@ import { useConfirm } from '../ui/confirm'
// disabled meanwhile. Labels, confirm texts and messages come from the server
// and are rendered as text. A `danger` action (UI-SPEC F5) turns the dialog's
// confirm button into the danger variant; the footer button stays outline.
// An action with a `prompt` asks for one text value in the dialog and posts
// it as the body key `payload`; every other action posts an empty body.
const props = withDefaults(
defineProps<{
source: ControllerParams
@@ -39,6 +41,16 @@ const emit = defineEmits<{
const confirm = useConfirm()
const running = ref(false)
/** The server's first message on the payload field of a 422, if any. */
function payloadDetail(error: unknown): string {
const details = (error as { error?: { details?: Record<string, unknown> } } | undefined)?.error?.details
const payload = details?.payload
if (Array.isArray(payload) && typeof payload[0] === 'string') {
return payload[0]
}
return ''
}
async function run(action: RecordAction): Promise<void> {
if (running.value || props.disabled) {
return
@@ -46,23 +58,41 @@ async function run(action: RecordAction): Promise<void> {
let status = 0
let ok = false
let text = ''
let detail = ''
const confirmed = await confirm.ask(
{
message: action.confirm || t('backend::lang.form.action_confirm', { action: action.label }),
confirmLabel: action.label,
danger: action.danger,
prompt: action.prompt
? {
label: action.prompt.label,
placeholder: action.prompt.placeholder,
comment: action.prompt.comment,
maxLength: action.prompt.max_length,
}
: undefined,
},
async () => {
running.value = true
emit('busy', true)
try {
const result = await api.POST('/{vendor}/{plugin}/{controller}/{id}/actions/{action}', {
params: { path: { ...props.source, id: props.recordId, action: action.name } },
body: {},
})
const params = { path: { ...props.source, id: props.recordId, action: action.name } }
// A prompted action posts its value as `payload`; every other action
// keeps the empty body the record action route expects.
const result = action.prompt
? await api.POST('/{vendor}/{plugin}/{controller}/{id}/actions/{action}', {
params,
body: { payload: confirm.value.value.trim() },
})
: await api.POST('/{vendor}/{plugin}/{controller}/{id}/actions/{action}', {
params,
body: {},
})
status = result.response.status
ok = !!result.data
text = result.data?.data.message ?? result.error?.error.message ?? ''
detail = payloadDetail(result.error)
} catch {
status = 0
} finally {
@@ -91,6 +121,10 @@ async function run(action: RecordAction): Promise<void> {
showToast(text || t('backend::lang.list.action_forbidden'), 'danger')
return
}
if (status === 422 && detail) {
showToast(detail, 'danger')
return
}
showToast(text || t('backend::lang.extension.action_failed'), 'danger')
}
</script>
@@ -114,6 +148,9 @@ async function run(action: RecordAction): Promise<void> {
:confirm-label="confirm.request.value?.confirmLabel"
:danger="confirm.request.value?.danger"
:busy="confirm.busy.value"
:prompt="confirm.request.value?.prompt ?? null"
:value="confirm.value.value"
@update:value="confirm.setValue"
@confirm="confirm.confirm"
@cancel="confirm.cancel"
/>

View File

@@ -72,15 +72,24 @@ export function toggleValue(current: unknown, on: boolean): boolean | number {
* A permissioneditor value as it may be sent (UI-SPEC S5): only codes the
* field's options offer, with a value of the mode's set. Radio keeps 1
* (allow) and -1 (deny) and leaves an inherited code out; checkbox keeps 1.
* A stored code that is not offered is never sent: the server keeps it.
* A stored code that is not offered is never sent: the server keeps it. A
* code in `locked` (the record's permission locks, D-21) is never sent
* either: the server keeps its stored value.
*/
export function permissionValues(field: FormField, value: unknown): Record<string, number> {
export function permissionValues(
field: FormField,
value: unknown,
locked?: ReadonlySet<string>,
): Record<string, number> {
const out: Record<string, number> = {}
if (value === null || typeof value !== 'object' || Array.isArray(value)) {
return out
}
const stored = value as Record<string, unknown>
for (const option of field.permissionOptions ?? []) {
if (locked?.has(option.code)) {
continue
}
const n = Number(stored[option.code])
if (n === 1 || (field.mode === 'radio' && n === -1)) {
out[option.code] = n

View File

@@ -12,6 +12,7 @@ import {
import { CircleAlert, FileText, X } from '@lucide/vue'
import { errorMessage, type FileRoutes } from '../../../api/files'
import type { FileItem } from '../../../api/types'
import { ariaKeyshortcuts, shortcutHint } from '../../../app/hotkeys'
import { t } from '../../../app/i18n'
import { showToast } from '../../../state/useToasts'
import ConfirmDialog from '../../ui/ConfirmDialog.vue'
@@ -219,6 +220,9 @@ function onCloseAutoFocus(event: Event): void {
<button
type="submit"
data-action="save-caption"
data-hotkey="mod+s mod+enter"
:aria-keyshortcuts="ariaKeyshortcuts('mod+s mod+enter')"
:title="shortcutHint(t('backend::lang.fileupload.details_submit'), 'mod+s')"
:disabled="busy"
class="inline-flex h-button flex-1 items-center justify-center rounded-control bg-primary font-semibold text-on-primary hover:opacity-90 disabled:cursor-not-allowed disabled:opacity-60"
>

View File

@@ -1,10 +1,11 @@
<script setup lang="ts">
import { computed } from 'vue'
import { computed, inject } from 'vue'
import { CheckboxIndicator, CheckboxRoot, RadioGroupItem, RadioGroupRoot } from 'reka-ui'
import { Check, Lock } from '@lucide/vue'
import type { PermissionOption } from '../../../api/types'
import type { PermissionOption, PermissionRecordLock } from '../../../api/types'
import { t } from '../../../app/i18n'
import { controlAttributes, permissionValues, type FieldControlProps } from '../control'
import { FORM_PERMISSION_LOCKS } from '../formContext'
// Permission editor (UI-SPEC S5, D-16). The options come with the form
// schema, already filtered and marked for the signed-in administrator. They
@@ -13,10 +14,21 @@ import { controlAttributes, permissionValues, type FieldControlProps } from '../
// permission; checkbox mode edits allow (1). The value is an object of code
// to integer holding only offered codes: a stored code that is not offered is
// kept by the server and never sent. A locked row shows its stored value and
// cannot change; the server refuses a changed locked code anyway.
// cannot change; the server refuses a changed locked code anyway. A row the
// record fixes (meta.permissionLocks, D-21) shows the lock's value and note
// instead, wins over a request lock, and is never sent.
const props = defineProps<FieldControlProps>()
const emit = defineEmits<{ 'update:modelValue': [value: Record<string, number>] }>()
const allLocks = inject(FORM_PERMISSION_LOCKS, null)
const recordLocks = computed(() => {
const out = new Map<string, PermissionRecordLock>()
for (const lock of allLocks?.value[props.field.name] ?? []) {
out.set(lock.code, lock)
}
return out
})
interface Section {
key: string
label: string
@@ -75,16 +87,29 @@ function rowId(sectionIndex: number, optionIndex: number): string {
return `${props.controlId}-${sectionIndex}-${optionIndex}`
}
function recordLock(option: PermissionOption): PermissionRecordLock | undefined {
return recordLocks.value.get(option.code)
}
function disabled(option: PermissionOption): boolean {
return readOnly.value || !!option.locked
return readOnly.value || !!option.locked || recordLock(option) !== undefined
}
/** Whether the row shows the lock icon and text: never on a read-only screen. */
function showsLock(option: PermissionOption): boolean {
return !!option.locked && !readOnly.value
return (!!option.locked || recordLock(option) !== undefined) && !readOnly.value
}
/** The lock note of a row: the record lock's note wins over the request lock's. */
function lockNote(option: PermissionOption): string {
return recordLock(option)?.note || t('backend::lang.permissioneditor.locked')
}
function valueOf(option: PermissionOption): number {
const lock = recordLock(option)
if (lock) {
return lock.value === 1 || (radio.value && lock.value === -1) ? lock.value : 0
}
return current.value[option.code] ?? 0
}
@@ -145,6 +170,7 @@ function set(option: PermissionOption, value: number): void {
:key="option.code"
:data-permission="option.code"
:data-locked="showsLock(option) ? '' : undefined"
:data-locked-by="showsLock(option) && recordLock(option) ? 'record' : undefined"
class="flex min-h-[56px] items-center justify-between gap-x-4 gap-y-2 border-t border-border px-4 py-3 max-sm:flex-col max-sm:items-start"
>
<div class="flex min-w-0 flex-col">
@@ -163,7 +189,7 @@ function set(option: PermissionOption, value: number): void {
class="text-[13px] text-muted [overflow-wrap:anywhere]"
data-permission-locked
>
{{ t('backend::lang.permissioneditor.locked') }}
{{ lockNote(option) }}
</p>
<p
v-else-if="option.comment"

View File

@@ -1,10 +1,11 @@
<script setup lang="ts">
import { computed, onBeforeUnmount, ref, watch } from 'vue'
import { computed, inject, onBeforeUnmount, ref, watch } from 'vue'
import { ChevronDown, Lock, X } from '@lucide/vue'
import { api } from '../../../api/client'
import type { RelationOption } from '../../../api/types'
import { t } from '../../../app/i18n'
import type { FieldControlProps } from '../control'
import { FORM_REMEMBER_LABEL } from '../formContext'
// Relation field (D-17, D-18, D-26), three modes from the schema:
// readOnly the label from meta.labels only, no control
@@ -22,6 +23,7 @@ import type { FieldControlProps } from '../control'
// refuses the change in any case.
const props = defineProps<FieldControlProps>()
const emit = defineEmits<{ 'update:modelValue': [value: number | number[] | null] }>()
const rememberLabel = inject(FORM_REMEMBER_LABEL, undefined)
const PER_PAGE = 20
const SEARCH_DEBOUNCE = 300
@@ -226,6 +228,13 @@ function choose(entry: Entry): void {
if (entry.locked) {
return
}
if (entry.value !== null) {
rememberLabel?.(props.field.name, {
value: entry.value,
label: entry.label,
locked: entry.locked || undefined,
})
}
if (mode.value === 'multiple') {
if (entry.value !== null && !selectedIds.value.includes(entry.value)) {
emit('update:modelValue', [...selectedIds.value, entry.value])

View File

@@ -5,7 +5,7 @@
// provider (settings pages) gets the defaults of the injecting control.
import { ref, type InjectionKey, type Ref } from 'vue'
import type { FileRoutes } from '../../api/files'
import type { AdminDependentOptionsResult, AdminRecord, FormField } from '../../api/types'
import type { AdminDependentOptionsResult, AdminRecord, FormField, PermissionRecordLock, RelationOption } from '../../api/types'
/** Read-only view of the form's current values. */
export const FORM_VALUES: InjectionKey<Readonly<Ref<AdminRecord>>> = Symbol('summer.form.values')
@@ -90,6 +90,22 @@ export const FORM_SESSION: InjectionKey<FormSession> = Symbol('summer.form.sessi
*/
export const SETTINGS_SECRETS: InjectionKey<Readonly<Ref<Record<string, string>>>> = Symbol('summer.settings.secrets')
/**
* The record's permission locks (meta.permissionLocks, D-21): per
* permissioneditor field name, the codes the stored record fixes with the
* value and note to show. FormView and PreviewView provide it from the record
* response; a control without a provider sees no record lock.
*/
export const FORM_PERMISSION_LOCKS: InjectionKey<Readonly<Ref<Record<string, PermissionRecordLock[]>>>> =
Symbol('summer.form.permissionLocks')
/**
* The notes of the fields a trigger disables now (fields.yaml `trigger`,
* D-21): top-level field name to the note shown between the label and the
* control. FormView provides it; without a provider no note is shown.
*/
export const FORM_TRIGGER_NOTES: InjectionKey<Readonly<Ref<Record<string, string>>>> = Symbol('summer.form.triggerNotes')
/** Event a widget element dispatches to run its action (bubbles, composed). */
export const WIDGET_EVENT = 'summer-action'
@@ -155,5 +171,13 @@ export interface FieldScope {
export const FIELD_SCOPE: InjectionKey<FieldScope> = Symbol('summer.form.fieldScope')
/**
* Form hosts persist a picked relation option so a remounted RelationField
* can seed its id→label cache from props.labels; a host without a provider
* is a no-op.
*/
export const FORM_REMEMBER_LABEL: InjectionKey<(field: string, option: RelationOption) => void> =
Symbol('summer.form.rememberLabel')
/** Dependent options per field path and sibling value, for the life of a form view. */
export const DEPENDENT_CACHE: InjectionKey<Map<string, AdminDependentOptionsResult>> = Symbol('summer.form.dependentCache')

View File

@@ -1,6 +1,6 @@
// Helpers shared by the record form and the settings form: context
// filtering, the save payload, 422 detail mapping and focus.
import type { AdminRecord, ErrorBody, FieldNotice, FormField } from '../../api/types'
import type { AdminRecord, ErrorBody, FieldNotice, FormField, PermissionRecordLock } from '../../api/types'
import { permissionValues } from './control'
import { isMLField, localeRecord } from './mlLocale'
import { isRegisteredField } from './registry'
@@ -48,9 +48,16 @@ export function contextAllows(field: FormField, mode: FormMode): boolean {
* The save body: values keyed by field name for every editable field that
* has a value. Read-only fields and types without a renderer are never sent.
* An empty password on update means "unchanged" and is left out; on create it
* is sent as entered and the server's rules decide (UI-SPEC S7).
* is sent as entered and the server's rules decide (UI-SPEC S7). `locks` are
* the record's permission locks (meta.permissionLocks): their codes are left
* out of each permissioneditor value.
*/
export function editablePayload(fields: FormField[], values: AdminRecord, mode: FormMode = 'create'): AdminRecord {
export function editablePayload(
fields: FormField[],
values: AdminRecord,
mode: FormMode = 'create',
locks?: Readonly<Record<string, readonly PermissionRecordLock[]>>,
): AdminRecord {
const out: AdminRecord = {}
for (const field of fields) {
if (field.readOnly || !isRegisteredField(field)) {
@@ -62,7 +69,8 @@ export function editablePayload(fields: FormField[], values: AdminRecord, mode:
}
if (field.type === 'permissioneditor') {
// Sent whenever it is shown, reduced to offered codes and values.
out[field.name] = permissionValues(field, value)
const locked = locks?.[field.name]
out[field.name] = permissionValues(field, value, locked ? new Set(locked.map((lock) => lock.code)) : undefined)
continue
}
if (isMLField(field)) {

View File

@@ -0,0 +1,64 @@
// Field triggers (fields.yaml `trigger`, D-21, UI-SPEC C6): a field is
// disabled or hidden while a switch or checkbox of the same form is checked
// or unchecked. Pure helpers: FormView and PreviewView call them with the
// whole form's values on every change. The server never relies on a trigger;
// a disabled or hidden field is simply not sent, so the stored value stays.
import type { AdminRecord, FormField } from '../../api/types'
import { t } from '../../app/i18n'
import { toggleOn } from './control'
/** Whether a field's trigger condition holds now. */
export type TriggerState = 'active' | 'inactive'
/**
* The state of a field's trigger: `checked` is active while the controlling
* value is on (toggleOn), `unchecked` while it is off. A controlling field
* missing from `present` (the schema fields this request and context show)
* counts as off. A field without a trigger is always inactive.
*/
export function triggerState(field: FormField, values: AdminRecord, present: ReadonlySet<string>): TriggerState {
const trigger = field.trigger
if (!trigger) {
return 'inactive'
}
const on = present.has(trigger.field) && toggleOn(values[trigger.field])
const active = trigger.condition === 'checked' ? on : !on
return active ? 'active' : 'inactive'
}
/** The fields a form renders and sends after its triggers, with the notes of disabled fields. */
export interface TriggeredFields {
/** Hide-active fields removed; disable-active fields as read-only copies. */
fields: FormField[]
/** Field name to the note a disabled field shows above its control. */
notes: Record<string, string>
}
/**
* Applies every trigger of `fields` against the whole form's values. A
* hide-active field is left out; a disable-active field becomes a copy with
* readOnly set and gets a note naming the controlling field by `labelOf`.
* The inputs are not changed.
*/
export function applyTriggers(
fields: readonly FormField[],
values: AdminRecord,
labelOf: (name: string) => string,
): TriggeredFields {
const present = new Set(fields.map((field) => field.name))
const out: FormField[] = []
const notes: Record<string, string> = {}
for (const field of fields) {
if (!field.trigger || triggerState(field, values, present) === 'inactive') {
out.push(field)
continue
}
if (field.trigger.action === 'hide') {
continue
}
out.push({ ...field, readOnly: true })
const key = field.trigger.condition === 'checked' ? 'backend::lang.form.trigger_disabled_on' : 'backend::lang.form.trigger_disabled_off'
notes[field.name] = t(key, { field: labelOf(field.trigger.field) })
}
return { fields: out, notes }
}

View File

@@ -15,6 +15,7 @@ import BulkActionsMenu from './BulkActionsMenu.vue'
// Declared bulk actions (D-09) sit in one menu directly after the selection
// pill; the menu is not rendered without a permitted action, and its trigger
// is disabled while nothing is selected or a bulk action runs.
// The slash key focuses the search input (app/hotkeys.ts).
const props = withDefaults(
defineProps<{
showSearch: boolean
@@ -53,6 +54,8 @@ defineExpose({ focusBulk })
<input
type="search"
data-list-search
data-hotkey="/"
aria-keyshortcuts="/"
:value="search"
:placeholder="searchPrompt"
class="h-button w-full rounded-control border border-transparent bg-subtle pr-3.5 pl-10"

View File

@@ -11,13 +11,23 @@ import {
import { Trash2, X } from '@lucide/vue'
import { api } from '../../api/client'
import { childFileRoutes } from '../../api/files'
import type { AdminRecord, ControllerParams, FormField, RecordMeta, RelationSchema } from '../../api/types'
import type { AdminRecord, ControllerParams, FormField, RecordMeta, RelationOption, RelationSchema } from '../../api/types'
import { shortcutHint } from '../../app/hotkeys'
import { message, t } from '../../app/i18n'
import { CHILD_SESSION_HEADER, SESSION_HEADER, newSessionKey } from '../../app/sessionKey'
import FormErrorBanner from '../form/FormErrorBanner.vue'
import FormGrid from '../form/FormGrid.vue'
import FormTabs from '../form/FormTabs.vue'
import { FORM_ENABLED_LOCALES, FORM_PATCH, FORM_SESSION, FORM_VALUES, createUploadGate, type FormSession } from '../form/formContext'
import {
FORM_ENABLED_LOCALES,
FORM_PATCH,
FORM_REMEMBER_LABEL,
FORM_SESSION,
FORM_TRIGGER_NOTES,
FORM_VALUES,
createUploadGate,
type FormSession,
} from '../form/formContext'
import {
DEFAULT_TAB,
contextAllows,
@@ -202,6 +212,22 @@ provide(FORM_VALUES, computed(() => values.value))
provide(FORM_PATCH, update)
const enabledLocales = inject(FORM_ENABLED_LOCALES, computed(() => [] as readonly string[]))
provide(FORM_ENABLED_LOCALES, enabledLocales)
// A relation form has no triggers; the record form's notes must not reach
// a child field of the same name.
provide(FORM_TRIGGER_NOTES, readonly(ref<Record<string, string>>({})))
function rememberRelationLabel(field: string, option: RelationOption): void {
const current = labels.value[field] ?? []
const index = current.findIndex((item) => item.value === option.value)
const next = [...current]
if (index >= 0) {
next[index] = option
} else {
next.push(option)
}
labels.value = { ...labels.value, [field]: next }
}
provide(FORM_REMEMBER_LABEL, rememberRelationLabel)
function update(name: string, value: unknown): void {
values.value = { ...values.value, [name]: value }
@@ -524,6 +550,8 @@ function onCloseAutoFocus(event: Event): void {
v-if="!failed"
variant="primary"
data-action="save-child"
hotkey="mod+s mod+enter"
:title="shortcutHint(submitLabel, 'mod+s')"
:disabled="busy || loading || activeUploads > 0"
@click="onSubmit"
>

View File

@@ -12,6 +12,7 @@ import {
import { Check, ChevronLeft, ChevronRight, Search, X } from '@lucide/vue'
import { api } from '../../api/client'
import type { AdminRecord, ControllerParams, ListMeta, RelationSchema } from '../../api/types'
import { ariaKeyshortcuts, shortcutHint } from '../../app/hotkeys'
import { message, t } from '../../app/i18n'
import { SESSION_HEADER } from '../../app/sessionKey'
import { showToast } from '../../state/useToasts'
@@ -545,6 +546,9 @@ const pagerButton =
v-else
type="button"
data-action="confirm-link"
data-hotkey="mod+s mod+enter"
:aria-keyshortcuts="ariaKeyshortcuts('mod+s mod+enter')"
:title="shortcutHint(single ? message(schema.messages.linkSubmit) : t('backend::lang.relation.add_count', { count }), 'mod+s')"
:disabled="busy || count === 0"
:aria-busy="busy ? 'true' : undefined"
class="inline-flex h-button flex-1 items-center justify-center rounded-control bg-primary font-semibold text-on-primary hover:opacity-90 disabled:cursor-not-allowed disabled:opacity-60"

View File

@@ -12,6 +12,7 @@ import {
import { X } from '@lucide/vue'
import { api } from '../../api/client'
import type { AdminRecord, ControllerParams, RelationSchema } from '../../api/types'
import { ariaKeyshortcuts, shortcutHint } from '../../app/hotkeys'
import { message, t } from '../../app/i18n'
import { SESSION_HEADER } from '../../app/sessionKey'
import FormErrorBanner from '../form/FormErrorBanner.vue'
@@ -266,6 +267,9 @@ function onCloseAutoFocus(event: Event): void {
<button
type="button"
data-action="save-pivot"
data-hotkey="mod+s mod+enter"
:aria-keyshortcuts="ariaKeyshortcuts('mod+s mod+enter')"
:title="shortcutHint(message(schema.messages.pivotSubmit), 'mod+s')"
:disabled="busy || loading || failed"
class="inline-flex h-button flex-1 items-center justify-center rounded-control bg-primary font-semibold text-on-primary hover:opacity-90 disabled:cursor-not-allowed disabled:opacity-60"
@click="onSubmit"

View File

@@ -3,36 +3,65 @@ import { computed, onBeforeUnmount } from 'vue'
import { useRoute } from 'vue-router'
import PluginRail from './PluginRail.vue'
import SectionPanel from './SectionPanel.vue'
import SettingsPanel from './SettingsPanel.vue'
import Breadcrumbs from './Breadcrumbs.vue'
import UserMenu from './UserMenu.vue'
import Toast from '../ui/Toast.vue'
import ShortcutHelpDialog from './ShortcutHelpDialog.vue'
import { ExternalLink } from '@lucide/vue'
import { controllerIdFromPath } from '../../app/controllerRoutes'
import { activeEntry } from '../../state/useNavigation'
import { settingsEntry, settingsLinkFor, settingsSectionOf } from '../../state/useSettings'
import { useSidebar } from '../../state/useSidebar'
import { t } from '../../app/i18n'
import { closeShortcutHelp, installHotkeys } from '../../app/hotkeys'
// Navigation shell (design: Navigation shell and Top header; D-06, D-10):
// the plugin rail, the active plugin's section panel (hidden when the
// the plugin rail, the section panel (the active plugin's side menu or, on a
// settings page, the settings panel of its category; hidden when the
// sidebar is collapsed by the viewport or by the admin), and the 64px header
// with breadcrumbs and the user menu. The toast queue is mounted here so
// toasts survive navigation.
// toasts survive navigation. The keyboard shortcuts (app/hotkeys.ts) are
// installed here, so only signed-in shell screens answer them.
const route = useRoute()
const { collapsed, watchViewport } = useSidebar()
const stopViewport = watchViewport()
onBeforeUnmount(stopViewport)
const uninstallHotkeys = installHotkeys()
onBeforeUnmount(() => {
uninstallHotkeys()
closeShortcutHelp()
})
// "View site" (WinterCMS parity) opens the public site in a new tab: the
// admin page's own origin, without the admin path prefix.
const siteURL = `${window.location.origin}/`
const active = computed(() => activeEntry(String(route.params.vendor ?? ''), String(route.params.plugin ?? '')))
// The settings panel shows on a singleton settings form and on a controller a
// settings link entry opens, unless that controller's plugin has a navigation
// entry of its own (it keeps its plugin panel, as the rail's Settings rule
// does). The /settings index has no controller ID and resolves to null.
const settingsSection = computed(() => {
if (active.value) {
return null
}
if (route.name === 'settings-form') {
return settingsSectionOf(settingsEntry(String(route.params.code ?? '')))
}
return settingsSectionOf(settingsLinkFor(controllerIdFromPath(route.path)))
})
// --shell-offset is the width the sidebar occupies (the rail, plus the
// section panel when it shows). Fixed bottom save bars start there, so the
// rail's Settings item is never covered.
const shellOffset = computed(() =>
active.value && !collapsed.value ? 'calc(var(--spacing-rail) + var(--spacing-panel))' : 'var(--spacing-rail)',
(active.value || settingsSection.value) && !collapsed.value
? 'calc(var(--spacing-rail) + var(--spacing-panel))'
: 'var(--spacing-rail)',
)
</script>
@@ -40,6 +69,7 @@ const shellOffset = computed(() =>
<div class="flex min-h-screen bg-bg text-text" :style="{ '--shell-offset': shellOffset }">
<PluginRail />
<SectionPanel v-if="active && !collapsed" :entry="active" />
<SettingsPanel v-else-if="settingsSection && !collapsed" :section="settingsSection" />
<div class="flex min-w-0 flex-1 flex-col">
<header class="flex h-header shrink-0 items-center justify-between gap-4 border-b border-border bg-surface pr-6 pl-8">
<Breadcrumbs />
@@ -63,5 +93,6 @@ const shellOffset = computed(() =>
</main>
</div>
<Toast />
<ShortcutHelpDialog />
</div>
</template>

View File

@@ -0,0 +1,68 @@
<script setup lang="ts">
import { nextTick } from 'vue'
import { PanelLeftClose } from '@lucide/vue'
import { RouterLink } from 'vue-router'
import { iconFor } from '../../app/icons'
import { t } from '../../app/i18n'
import { setCollapsed } from '../../state/useSidebar'
import { settingsPath, type SettingsSection } from '../../state/useSettings'
// Settings section panel (design: Navigation shell, level 2): on a settings
// page, the permitted settings pages of the current entry's category, 224px,
// with the same look and the same "Zwiń menu" collapse as the plugin side
// menu (SectionPanel). It lists only the current category; switching
// category goes through /settings. Categories arrive translated from the
// server, so the header renders the category as is.
//
// There is no settings flyout on the rail: one would list either every
// category (the panel never shows other categories) or only the current one
// (meaningless off a settings page). The rail's Settings item opens
// /settings, which lists every permitted page grouped by category one click
// away; on narrow viewports, where the panel is forced closed, that index is
// also how settings pages are switched.
defineProps<{ section: SettingsSection }>()
function collapse(): void {
setCollapsed(true)
void nextTick(() => document.querySelector<HTMLElement>('[data-sidebar-expand]')?.focus())
}
</script>
<template>
<aside
data-settings-panel
:aria-label="t('backend::lang.nav.sections')"
class="sticky top-0 flex h-screen w-panel shrink-0 flex-col gap-0.5 self-start overflow-y-auto border-r border-border bg-surface px-3 py-3.5"
>
<div class="mb-3.5 flex h-10 items-center justify-between gap-2 pl-2">
<span class="truncate text-[16px] font-bold">{{ section.category || t('backend::lang.nav.settings') }}</span>
<button
type="button"
data-sidebar-collapse
:aria-label="t('backend::lang.nav.collapse')"
:title="t('backend::lang.nav.collapse')"
class="flex size-[30px] shrink-0 items-center justify-center rounded-tab text-muted transition-colors duration-150 ease-out hover:bg-hover hover:text-text"
@click="collapse"
>
<PanelLeftClose :size="18" aria-hidden="true" />
</button>
</div>
<RouterLink
v-for="entry in section.entries"
:key="entry.code"
:to="settingsPath(entry)"
:data-settings-panel-item="entry.code"
:aria-current="entry.code === section.current.code ? 'page' : undefined"
:class="
entry.code === section.current.code
? 'bg-sel font-semibold text-text'
: 'font-medium text-muted hover:bg-hover hover:text-text'
"
class="flex h-nav items-center gap-3 rounded-control px-3 no-underline transition-colors duration-150 ease-out"
>
<component :is="iconFor(entry.icon)" :size="18" aria-hidden="true" />
<span>{{ entry.label }}</span>
</RouterLink>
</aside>
</template>

View File

@@ -0,0 +1,70 @@
<script setup lang="ts">
import {
DialogClose,
DialogContent,
DialogDescription,
DialogOverlay,
DialogPortal,
DialogRoot,
DialogTitle,
} from 'reka-ui'
import { X } from '@lucide/vue'
import { closeShortcutHelp, shortcutHelp, shortcutParts } from '../../app/hotkeys'
import { t } from '../../app/i18n'
// Keyboard shortcut help, opened with "?" (app/hotkeys.ts): the shortcuts
// the current screen answers, read from the page when the key was pressed,
// one row per shortcut with its keys and what it does. Esc and the close
// button close it.
function onOpen(open: boolean): void {
if (!open) {
closeShortcutHelp()
}
}
</script>
<template>
<DialogRoot :open="shortcutHelp !== null" @update:open="onOpen">
<DialogPortal>
<DialogOverlay data-dialog-overlay class="fixed inset-0 z-40 bg-overlay" />
<DialogContent
data-shortcut-help
data-dialog-content
aria-modal="true"
class="fixed top-1/2 left-1/2 z-50 flex max-h-[calc(100vh-32px)] w-[calc(100%-32px)] max-w-[440px] -translate-x-1/2 -translate-y-1/2 flex-col gap-4 overflow-y-auto rounded-modal bg-surface p-6 text-text shadow-pop"
>
<div class="flex items-start gap-3">
<div class="flex min-w-0 flex-1 flex-col gap-1">
<DialogTitle class="text-[20px] font-bold tracking-[-0.01em]">{{ t('backend::lang.shortcuts.title') }}</DialogTitle>
<DialogDescription class="text-muted">{{ t('backend::lang.shortcuts.description') }}</DialogDescription>
</div>
<DialogClose
data-action="close"
:aria-label="t('backend::lang.form.close')"
class="flex size-[34px] shrink-0 items-center justify-center rounded-tab bg-subtle text-muted hover:bg-hover hover:text-text"
>
<X :size="16" aria-hidden="true" />
</DialogClose>
</div>
<dl class="flex flex-col gap-2.5">
<div
v-for="entry in shortcutHelp ?? []"
:key="entry.combo"
:data-shortcut="entry.combo"
class="flex items-center justify-between gap-4"
>
<dt class="flex shrink-0 items-center gap-1">
<kbd
v-for="part in shortcutParts(entry.combo)"
:key="part"
class="inline-flex min-w-6 items-center justify-center rounded-pager border border-border bg-subtle px-1.5 font-mono text-[13px]"
>{{ part }}</kbd>
</dt>
<dd class="text-right text-muted">{{ t(entry.labelKey) }}</dd>
</div>
</dl>
</DialogContent>
</DialogPortal>
</DialogRoot>
</template>

View File

@@ -1,9 +1,12 @@
<script setup lang="ts">
import { computed, type Component } from 'vue'
import { RouterLink, type RouteLocationRaw } from 'vue-router'
import { ariaKeyshortcuts } from '../../app/hotkeys'
// One button for the whole admin (design tokens): primary, outline, ghost and
// danger (outline). With `to` it renders a router link styled the same way.
// A hotkey prop marks the button for the admin's keyboard shortcuts
// (data-hotkey tokens, see app/hotkeys.ts).
const props = withDefaults(
defineProps<{
variant?: 'primary' | 'outline' | 'ghost' | 'danger'
@@ -12,8 +15,9 @@ const props = withDefaults(
disabled?: boolean
icon?: Component
to?: RouteLocationRaw
hotkey?: string
}>(),
{ variant: 'outline', size: 'md', type: 'button', disabled: false, icon: undefined, to: undefined },
{ variant: 'outline', size: 'md', type: 'button', disabled: false, icon: undefined, to: undefined, hotkey: undefined },
)
const variants: Record<NonNullable<typeof props.variant>, string> = {
@@ -23,6 +27,8 @@ const variants: Record<NonNullable<typeof props.variant>, string> = {
danger: 'border border-danger bg-surface text-danger hover:bg-danger-soft',
}
const keyshortcuts = computed(() => (props.hotkey ? ariaKeyshortcuts(props.hotkey) : undefined))
const classes = computed(() => [
'inline-flex shrink-0 items-center justify-center gap-2 rounded-control px-4 font-semibold whitespace-nowrap no-underline transition-colors duration-150 ease-out disabled:cursor-not-allowed disabled:opacity-60',
props.size === 'sm' ? 'h-[38px]' : 'h-button',
@@ -31,11 +37,24 @@ const classes = computed(() => [
</script>
<template>
<RouterLink v-if="to !== undefined" :to="to" :class="classes">
<RouterLink
v-if="to !== undefined"
:to="to"
:class="classes"
:data-hotkey="hotkey"
:aria-keyshortcuts="keyshortcuts"
>
<component :is="icon" v-if="icon" :size="16" aria-hidden="true" />
<slot />
</RouterLink>
<button v-else :type="type" :disabled="disabled" :class="classes">
<button
v-else
:type="type"
:disabled="disabled"
:class="classes"
:data-hotkey="hotkey"
:aria-keyshortcuts="keyshortcuts"
>
<component :is="icon" v-if="icon" :size="16" aria-hidden="true" />
<slot />
</button>

View File

@@ -1,4 +1,5 @@
<script setup lang="ts">
import { computed, nextTick, ref, useId, watch } from 'vue'
import {
AlertDialogCancel,
AlertDialogContent,
@@ -10,11 +11,15 @@ import {
} from 'reka-ui'
import { LoaderCircle } from '@lucide/vue'
import { t } from '../../app/i18n'
import type { ConfirmPrompt } from './confirm'
// Confirmation (Reka AlertDialog: role alertdialog, focus trapped, Esc
// cancels, focus returns to the trigger). Text only: messages come from the
// server and are never rendered as HTML. While `busy` (an action started by
// the confirm is running) both buttons are disabled and the dialog stays.
// With a `prompt`, one labelled text input sits above the buttons: the
// confirm button stays disabled while its trimmed value is empty and Enter
// in the input confirms. The value is the host's (`value` / `update:value`).
const props = withDefaults(
defineProps<{
open: boolean
@@ -24,10 +29,16 @@ const props = withDefaults(
cancelLabel?: string
danger?: boolean
busy?: boolean
prompt?: ConfirmPrompt | null
value?: string
}>(),
{ title: undefined, confirmLabel: undefined, cancelLabel: undefined, danger: false, busy: false },
{ title: undefined, confirmLabel: undefined, cancelLabel: undefined, danger: false, busy: false, prompt: null, value: '' },
)
const emit = defineEmits<{ 'update:open': [open: boolean]; confirm: []; cancel: [] }>()
const emit = defineEmits<{ 'update:open': [open: boolean]; 'update:value': [value: string]; confirm: []; cancel: [] }>()
const dialogId = `confirm-${useId()}`
const promptInput = ref<HTMLInputElement | null>(null)
const promptEmpty = computed(() => !!props.prompt && props.value.trim() === '')
// Closing any other way than the confirm button (Esc, overlay, Anuluj) cancels.
function onOpenChange(open: boolean): void {
@@ -41,12 +52,26 @@ function onOpenChange(open: boolean): void {
}
function onConfirm(): void {
if (props.busy) {
if (props.busy || promptEmpty.value) {
return
}
emit('confirm')
emit('update:open', false)
}
function onInput(event: Event): void {
emit('update:value', (event.target as HTMLInputElement).value)
}
watch(
() => props.open && !!props.prompt,
async (prompted) => {
if (prompted) {
await nextTick()
promptInput.value?.focus()
}
},
)
</script>
<template>
@@ -61,6 +86,24 @@ function onConfirm(): void {
{{ title ?? t('backend::lang.form.confirm') }}
</AlertDialogTitle>
<AlertDialogDescription class="text-muted [overflow-wrap:anywhere]">{{ message }}</AlertDialogDescription>
<div v-if="prompt" class="flex flex-col gap-1.5" data-confirm-prompt>
<label :for="`${dialogId}-value`" class="text-[13px] font-semibold">{{ prompt.label }}</label>
<input
:id="`${dialogId}-value`"
ref="promptInput"
type="text"
autocomplete="off"
:maxlength="prompt.maxLength"
:placeholder="prompt.placeholder"
:aria-describedby="prompt.comment ? `${dialogId}-comment` : undefined"
:disabled="busy"
:value="value"
class="h-control w-full rounded-control border border-border-strong bg-surface px-3 text-text outline-none focus:border-primary disabled:cursor-not-allowed disabled:opacity-60"
@input="onInput"
@keydown.enter.prevent="onConfirm"
/>
<p v-if="prompt.comment" :id="`${dialogId}-comment`" class="text-[13px] text-muted">{{ prompt.comment }}</p>
</div>
<div class="flex gap-2.5">
<AlertDialogCancel
data-action="cancel"
@@ -72,7 +115,7 @@ function onConfirm(): void {
<button
type="button"
data-action="confirm"
:disabled="busy"
:disabled="busy || promptEmpty"
:aria-busy="busy ? 'true' : undefined"
:class="danger ? 'bg-danger text-white' : 'bg-primary text-on-primary'"
class="inline-flex h-button flex-1 items-center justify-center gap-2 rounded-control font-semibold hover:opacity-90 disabled:cursor-not-allowed disabled:opacity-60"

View File

@@ -2,18 +2,30 @@
// true on confirm and false on Anuluj, Esc or a second request. With an
// action, the dialog stays open and busy while the action runs after the
// confirm, and closes when it settles (a toolbar delete shows its progress
// on the confirm button).
// on the confirm button). A request with a `prompt` asks for one text value
// in the dialog; the caller reads it from `value` inside its action (the
// dialog is still open then) or right after `ask` resolves true.
import { ref } from 'vue'
export interface ConfirmPrompt {
label: string
placeholder?: string
comment?: string
maxLength: number
}
export interface ConfirmRequest {
message: string
confirmLabel?: string
danger?: boolean
prompt?: ConfirmPrompt
}
export function useConfirm() {
const request = ref<ConfirmRequest | null>(null)
const busy = ref(false)
/** The prompt's text while a prompted request is open; '' otherwise. */
const value = ref('')
let resolver: ((ok: boolean) => void) | null = null
let action: (() => Promise<unknown>) | null = null
@@ -27,6 +39,7 @@ export function useConfirm() {
function ask(next: ConfirmRequest, run?: () => Promise<unknown>): Promise<boolean> {
settle(false)
value.value = ''
request.value = next
action = run ?? null
return new Promise<boolean>((resolve) => {
@@ -38,6 +51,9 @@ export function useConfirm() {
if (busy.value) {
return
}
if (request.value?.prompt && value.value.trim() === '') {
return
}
const run = action
if (run) {
busy.value = true
@@ -57,5 +73,9 @@ export function useConfirm() {
settle(false)
}
return { request, busy, ask, confirm, cancel }
function setValue(next: string): void {
value.value = next
}
return { request, busy, value, ask, confirm, cancel, setValue }
}

View File

@@ -0,0 +1,15 @@
// Lets a view ask App to remount the current route's component in place:
// App keys the routed view by path plus this revision, so bumping it gives
// the view a fresh instance without a navigation (Create and new on a
// create form opens a blank form at the same path).
import { readonly, ref } from 'vue'
const revision = ref(0)
/** Part of App's routed view key; bumped by remountView. */
export const remountRevision = readonly(revision)
/** Remounts the current route's view. */
export function remountView(): void {
revision.value++
}

View File

@@ -64,6 +64,39 @@ export const settingsGroups = computed(() => {
return groups
})
export function useSettings() {
return { settings, hasSettings, settingsGroups, loadSettings, settingsEntry, settingsPath, settingsLinkFor }
/** The settings pages of one category, with the page on screen. */
export interface SettingsSection {
category: string
current: SettingsEntry
entries: SettingsEntry[]
}
/**
* The category group of the given entry for the shell's settings panel, in
* settingsGroups order and without entries of any other category. Null when
* there is no current entry or its category holds a single page: there is
* nothing to switch to.
*/
export function settingsSectionOf(current: SettingsEntry | null): SettingsSection | null {
if (!current) {
return null
}
const group = settingsGroups.value.find((item) => item.category === current.category)
if (!group || group.entries.length < 2) {
return null
}
return { category: group.category, current, entries: group.entries }
}
export function useSettings() {
return {
settings,
hasSettings,
settingsGroups,
loadSettings,
settingsEntry,
settingsPath,
settingsLinkFor,
settingsSectionOf,
}
}

View File

@@ -3,10 +3,12 @@ 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 { shortcutHint } from '../app/hotkeys'
import { t } from '../app/i18n'
import FormErrorBanner from '../components/form/FormErrorBanner.vue'
import { controlClass } from '../components/form/control'
import { fieldErrors, focusField } from '../components/form/formState'
import AccountContributions from '../components/account/AccountContributions.vue'
import ApiTokensPanel from '../components/account/ApiTokensPanel.vue'
import Button from '../components/ui/Button.vue'
import ConfirmDialog from '../components/ui/ConfirmDialog.vue'
@@ -21,7 +23,7 @@ import { showToast } from '../state/useToasts'
// typed. The avatar is uploaded (POST /account/avatar, one file_data part)
// and removed (DELETE /account/avatar, after a confirmation) on its own.
// Every success passes the returned profile to setCurrentUser, so the top
// bar updates without a reload.
// bar updates without a reload. Save answers Ctrl/Cmd+S (app/hotkeys.ts).
const ID_PREFIX = 'account'
type ProfileKey = 'first_name' | 'last_name' | 'email' | 'subtitle'
@@ -411,6 +413,8 @@ async function onSave(): Promise<void> {
<ApiTokensPanel :confirm="confirm" />
<AccountContributions :confirm="confirm" />
<ConfirmDialog
:open="confirm.request.value !== null"
:message="confirm.request.value?.message ?? ''"
@@ -424,7 +428,14 @@ async function onSave(): Promise<void> {
<footer
class="fixed right-0 bottom-0 left-[var(--shell-offset,0px)] z-30 flex items-center justify-end gap-2.5 border-t border-border bg-surface px-8 py-3.5"
>
<Button variant="primary" data-action="save" :disabled="busy" @click="onSave">
<Button
variant="primary"
data-action="save"
hotkey="mod+s"
:title="shortcutHint(t('backend::lang.form.save'), 'mod+s')"
:disabled="busy"
@click="onSave"
>
{{ busy ? t('backend::lang.form.saving') : t('backend::lang.form.save') }}
</Button>
</footer>

View File

@@ -4,8 +4,9 @@ import { onBeforeRouteLeave, onBeforeRouteUpdate, useRoute, useRouter } from 'vu
import { ArrowLeft, Trash2 } from '@lucide/vue'
import { api } from '../api/client'
import { parentFileRoutes } from '../api/files'
import type { AdminRecord, ErrorEnvelope, FormView, RecordEnvelope, RecordMeta } from '../api/types'
import type { AdminRecord, ErrorEnvelope, FormView, RecordEnvelope, RecordMeta, RelationOption } from '../api/types'
import { controllerIdFromParams, controllerPath } from '../app/controllerRoutes'
import { shortcutHint } from '../app/hotkeys'
import { currentLocale, message, t } from '../app/i18n'
import { loadControllerAssets } from '../app/pluginAssets'
import { SESSION_HEADER, newSessionKey } from '../app/sessionKey'
@@ -20,12 +21,16 @@ import {
FORM_FEEDBACK,
FORM_LOCALE,
FORM_PATCH,
FORM_PERMISSION_LOCKS,
FORM_REMEMBER_LABEL,
FORM_SESSION,
FORM_TRIGGER_NOTES,
FORM_VALUES,
createUploadGate,
} from '../components/form/formContext'
import type { AdminDependentOptionsResult } from '../api/types'
import { RELATION_MANAGER, needsRecord } from '../components/form/registry'
import { applyTriggers } from '../components/form/trigger'
import {
DEFAULT_TAB,
ML_LOCALE_CHANGE,
@@ -54,12 +59,15 @@ import Button from '../components/ui/Button.vue'
import ConfirmDialog from '../components/ui/ConfirmDialog.vue'
import { useConfirm } from '../components/ui/confirm'
import { clearRecordCrumb, setRecordCrumb } from '../state/useBreadcrumbs'
import { remountView } from '../state/useRemount'
import { showToast } from '../state/useToasts'
// Schema-driven create/update form (D-05, D-09, D-10, D-18; design screen
// 4). The view is keyed by route path, so one instance serves one record or
// one create. Tabs group fields by `tab`; a sticky footer holds delete,
// cancel, save-and-close and save; a dirty form confirms before leaving.
// cancel, save-and-close and save (a create form also has create-and-new);
// a dirty form confirms before leaving. The save buttons carry the keyboard
// shortcuts (Ctrl/Cmd+S, Ctrl/Cmd+Enter, Ctrl/Cmd+Shift+S; app/hotkeys.ts).
const route = useRoute()
const router = useRouter()
@@ -78,6 +86,9 @@ const recordId = mode === 'update' ? Number(route.params.id) : null
const schema = ref<FormView | null>(null)
const values = ref<AdminRecord>({})
const labels = ref<RecordMeta['labels']>({})
// The record's permission locks (meta.permissionLocks, D-21): codes the
// stored record fixes; they are shown locked and never sent.
const permissionLocks = ref<NonNullable<RecordMeta['permissionLocks']>>({})
/** The controller's record title (meta.title, pact.FormRecordTitle); '' when it names none. */
const recordTitle = ref('')
const errors = ref<Record<string, string[]>>({})
@@ -114,13 +125,27 @@ const { activeUploads, beginUpload } = createUploadGate()
// tab even when the YAML forgets `context: update` (D-05, design screen 5).
// A deferrable one (Phase 12.2, D-03) stays: it works on owner id 0 with the
// form's session key and the save commits its changes.
const fields = computed(() =>
const contextFields = computed(() =>
(schema.value?.fields ?? []).filter(
(field) =>
contextAllows(field, mode) &&
(mode === 'update' || !needsRecord(field.type) || (field.type === RELATION_MANAGER && !!field.deferrable)),
),
)
/** A schema field's label for a trigger note: its label, else its name. */
function fieldLabel(name: string): string {
const field = schema.value?.fields.find((item) => item.name === name)
return field?.label || name
}
// Field triggers (D-21, UI-SPEC C6), evaluated against the whole form's
// values: hide-active fields are gone from the tabs, the grid, the banner's
// field names and the save body; disable-active fields render read-only and
// are not sent. Their values stay in `values` and return when the trigger
// lets go.
const triggered = computed(() => applyTriggers(contextFields.value, values.value, fieldLabel))
const fields = computed(() => triggered.value.fields)
const fieldNames = computed(() => fields.value.map((field) => field.name))
const tabs = computed<TabItem[]>(() => {
@@ -205,14 +230,14 @@ const dirty = computed(
!loading.value &&
(pendingChanges.value > 0 ||
activeUploads.value > 0 ||
snapshot(editablePayload(fields.value, values.value, mode)) !== saved.value),
snapshot(editablePayload(fields.value, values.value, mode, permissionLocks.value)) !== saved.value),
)
function adopt(record: RecordEnvelope | undefined): void {
if (record) {
const locales = schemaEnabledLocales(schema.value?.meta)
const next: AdminRecord = { ...record.data }
for (const field of fields.value) {
for (const field of contextFields.value) {
if (field.type === 'password') {
next[field.name] = ''
} else if (isMLField(field)) {
@@ -221,9 +246,22 @@ function adopt(record: RecordEnvelope | undefined): void {
}
values.value = next
labels.value = record.meta.labels ?? {}
permissionLocks.value = record.meta.permissionLocks ?? {}
recordTitle.value = record.meta.title ?? ''
}
saved.value = snapshot(editablePayload(fields.value, values.value, mode))
saved.value = snapshot(editablePayload(fields.value, values.value, mode, permissionLocks.value))
}
function rememberRelationLabel(field: string, option: RelationOption): void {
const current = labels.value[field] ?? []
const index = current.findIndex((item) => item.value === option.value)
const next = [...current]
if (index >= 0) {
next[index] = option
} else {
next.push(option)
}
labels.value = { ...labels.value, [field]: next }
}
async function load(): Promise<void> {
@@ -243,7 +281,7 @@ async function load(): Promise<void> {
assetsReady = loadControllerAssets(controllerId, schema.value.assets)
}
if (schema.value && mode === 'create') {
values.value = initialValues(fields.value, schemaEnabledLocales(schema.value.meta))
values.value = initialValues(contextFields.value, schemaEnabledLocales(schema.value.meta))
}
adopt(recordResult?.data)
mlLocale.value = firstMLLocale()
@@ -287,7 +325,7 @@ function update(name: string, value: unknown): void {
const previous = values.value[name]
const next = { ...values.value, [name]: value }
edited.add(name)
if (isMLField(fields.value.find((field) => field.name === name))) {
if (isMLField(contextFields.value.find((field) => field.name === name))) {
let locales = editedLocales.get(name)
if (!locales) {
locales = new Set<string>()
@@ -298,9 +336,11 @@ function update(name: string, value: unknown): void {
}
}
if (mode === 'create') {
Object.assign(next, presetUpdates(fields.value, name, previous, value, values.value, mlLocale.value, isEdited))
Object.assign(next, presetUpdates(contextFields.value, name, previous, value, values.value, mlLocale.value, isEdited))
}
const disabledBefore = triggered.value.notes
values.value = next
announceDisabled(disabledBefore)
if (errors.value[name]) {
const next = { ...errors.value }
delete next[name]
@@ -313,9 +353,12 @@ function update(name: string, value: unknown): void {
// that field's errors like an edit (D-07, D-08).
provide(FORM_VALUES, computed(() => values.value))
provide(FORM_PATCH, update)
provide(FORM_REMEMBER_LABEL, rememberRelationLabel)
provide(FORM_LOCALE, computed(() => schema.value?.meta.locale || currentLocale.value))
provide(FORM_ENABLED_LOCALES, computed(() => schemaEnabledLocales(schema.value?.meta)))
provide(FORM_ASSETS, () => assetsReady)
provide(FORM_PERMISSION_LOCKS, computed(() => permissionLocks.value))
provide(FORM_TRIGGER_NOTES, computed(() => triggered.value.notes))
// The form's single polite live region (dependent dropdown clears, repeater
// moves) and the feedback nested controls read: errors and notices by row
// path, the confirm dialog (Phase 17, D-07, D-08).
@@ -332,6 +375,31 @@ function announce(text: string): void {
announcement.value = text
}, 50)
}
/**
* After an edit: announces "<field label>: <note>" for every field a trigger
* has just disabled. A field a trigger enables again is not announced.
*/
function announceDisabled(before: Record<string, string>): void {
const after = triggered.value.notes
const lines = Object.keys(after)
.filter((name) => !(name in before))
.map((name) => `${fieldLabel(name)}: ${after[name]}`)
if (lines.length > 0) {
announce(lines.join(' '))
}
}
// A tab whose every field a trigger hides disappears; when it was the active
// tab, the first remaining tab becomes active.
watch(
() => tabs.value.map((tab) => tab.key),
(keys) => {
if (keys.length > 0 && !keys.includes(activeTab.value)) {
activeTab.value = keys[0] ?? DEFAULT_TAB
}
},
)
provide(FORM_FEEDBACK, {
errors: computed(() => errors.value),
notices: computed(() => notices.value),
@@ -395,7 +463,7 @@ async function save(): Promise<RecordEnvelope | null> {
forbidden.value = null
notices.value = {}
try {
const body = editablePayload(fields.value, values.value, mode)
const body = editablePayload(fields.value, values.value, mode, permissionLocks.value)
const result =
recordId === null
? await api.POST('/{vendor}/{plugin}/{controller}', { params: { path, header: sessionHeader }, body })
@@ -463,6 +531,18 @@ async function onSaveAndClose(): Promise<void> {
}
}
/**
* Utwórz i nowy (WinterCMS create_and_new): saves, then shows a blank create
* form of the same model in place, with a new session key; both redirects
* are ignored.
*/
async function onSaveAndNew(): Promise<void> {
const record = await save()
if (record) {
remountView()
}
}
async function onDelete(): Promise<void> {
if (recordId === null || busy.value || !schema.value) {
return
@@ -611,11 +691,36 @@ void load()
{{ t('backend::lang.form.delete') }}
</Button>
<div class="ml-auto flex items-center gap-2.5">
<Button variant="ghost" data-action="cancel" @click="onLeave">{{ t('backend::lang.form.cancel') }}</Button>
<Button variant="outline" data-action="save-close" :disabled="busy || loading || !schema || activeUploads > 0" @click="onSaveAndClose">
<Button variant="ghost" data-action="cancel" hotkey="escape" @click="onLeave">{{ t('backend::lang.form.cancel') }}</Button>
<Button
v-if="mode === 'create'"
variant="outline"
data-action="save-new"
hotkey="mod+shift+s"
:title="shortcutHint(t('backend::lang.form.create_and_new'), 'mod+shift+s')"
:disabled="busy || loading || !schema || activeUploads > 0"
@click="onSaveAndNew"
>
{{ t('backend::lang.form.create_and_new') }}
</Button>
<Button
variant="outline"
data-action="save-close"
hotkey="mod+enter"
:title="shortcutHint(t('backend::lang.form.save_and_close'), 'mod+enter')"
:disabled="busy || loading || !schema || activeUploads > 0"
@click="onSaveAndClose"
>
{{ t('backend::lang.form.save_and_close') }}
</Button>
<Button variant="primary" data-action="save" :disabled="busy || loading || !schema || activeUploads > 0" @click="onSave">
<Button
variant="primary"
data-action="save"
hotkey="mod+s"
:title="shortcutHint(t('backend::lang.form.save'), 'mod+s')"
:disabled="busy || loading || !schema || activeUploads > 0"
@click="onSave"
>
{{ busy ? t('backend::lang.form.saving') : t('backend::lang.form.save') }}
</Button>
</div>

View File

@@ -9,11 +9,12 @@ import { controllerIdFromParams, controllerPath } from '../app/controllerRoutes'
import { message, t } from '../app/i18n'
import { loadControllerAssets } from '../app/pluginAssets'
import { newSessionKey } from '../app/sessionKey'
import { FIELD_SCOPE, FORM_SESSION, createUploadGate } from '../components/form/formContext'
import { FIELD_SCOPE, FORM_PERMISSION_LOCKS, FORM_SESSION, createUploadGate } from '../components/form/formContext'
import FormTabs from '../components/form/FormTabs.vue'
import PreviewField from '../components/form/PreviewField.vue'
import RecordActions from '../components/form/RecordActions.vue'
import { RELATION_MANAGER, isRegisteredField } from '../components/form/registry'
import { applyTriggers } from '../components/form/trigger'
import {
DEFAULT_TAB,
contextAllows,
@@ -54,6 +55,9 @@ const recordPath = `${listPath}/${recordId}`
const schema = ref<FormView | null>(null)
const values = ref<AdminRecord>({})
const labels = ref<RecordMeta['labels']>({})
// The record's permission locks (meta.permissionLocks): the preview shows
// their values, without icon or note (read-only screen).
const permissionLocks = ref<NonNullable<RecordMeta['permissionLocks']>>({})
/** The controller's record title (meta.title, pact.FormRecordTitle); '' when it names none. */
const recordTitle = ref('')
const actions = ref<RecordAction[]>([])
@@ -68,8 +72,15 @@ const hintKey = ref(0)
/** Types that are never shown on preview (UI-SPEC S3). */
const hidden = new Set(['password', 'widget', RELATION_MANAGER])
// A field a `hide` trigger hides now (D-21, UI-SPEC C6) is left out, against
// the record's values; `disable` changes nothing here (every preview field is
// read-only) and no trigger note is shown.
const fields = computed<FormField[]>(() =>
(schema.value?.fields ?? []).filter((field) => contextAllows(field, 'preview') && !hidden.has(field.type)),
applyTriggers(
(schema.value?.fields ?? []).filter((field) => contextAllows(field, 'preview') && !hidden.has(field.type)),
values.value,
(name) => name,
).fields,
)
// The Edit button renders only when the form holds at least one value field
@@ -150,6 +161,7 @@ async function loadRecord(): Promise<boolean> {
}
values.value = { ...result.data.data }
labels.value = result.data.meta.labels ?? {}
permissionLocks.value = result.data.meta.permissionLocks ?? {}
recordTitle.value = result.data.meta.title ?? ''
actions.value = result.data.meta.actions ?? []
return true
@@ -212,6 +224,7 @@ provide(FIELD_SCOPE, {
values: computed(() => values.value),
path: (name: string) => name,
})
provide(FORM_PERMISSION_LOCKS, computed(() => permissionLocks.value))
provide(FORM_SESSION, {
key: sessionKey,
recordId,

View File

@@ -1,9 +1,10 @@
<script setup lang="ts">
import { computed, nextTick, provide, ref } from 'vue'
import { useRoute } from 'vue-router'
import { useRoute, useRouter } from 'vue-router'
import { ArrowLeft } from '@lucide/vue'
import { api } from '../api/client'
import type { AdminRecord, FormField, FormView } from '../api/types'
import { shortcutHint } from '../app/hotkeys'
import { t } from '../app/i18n'
import FormErrorBanner from '../components/form/FormErrorBanner.vue'
import FormGrid from '../components/form/FormGrid.vue'
@@ -34,7 +35,9 @@ import { showToast } from '../state/useToasts'
// empty state from meta.secrets (F2) and are sent only when the
// administrator typed a value (a string) or removed the stored one (null);
// richeditor save notices from meta.notices render under their field (F3).
// Save and Save and close answer Ctrl/Cmd+S and Ctrl/Cmd+Enter (app/hotkeys.ts).
const route = useRoute()
const router = useRouter()
const code = String(route.params.code ?? '')
const ID_PREFIX = 'setting'
@@ -132,9 +135,10 @@ function settingsPayload(editable: FormField[], current: AdminRecord): AdminReco
return out
}
async function onSave(): Promise<void> {
/** Saves the values; true when the PUT succeeded. */
async function save(): Promise<boolean> {
if (busy.value || !schema.value) {
return
return false
}
busy.value = true
try {
@@ -148,7 +152,7 @@ async function onSave(): Promise<void> {
secrets.value = { ...(result.data.data.meta?.secrets ?? {}) }
notices.value = noticeLines(result.data.data.meta?.notices)
showToast(t('backend::lang.settings.saved'))
return
return true
}
if (result.response.status === 422) {
errors.value = fieldErrors(result.error?.error.details)
@@ -161,16 +165,29 @@ async function onSave(): Promise<void> {
if (first) {
focusField(ID_PREFIX, first.name)
}
return
return false
}
showToast(result.error?.error.message || t('backend::lang.form.error_generic'), 'danger')
return false
} catch {
showToast(t('backend::lang.form.error_generic'), 'danger')
return false
} finally {
busy.value = false
}
}
async function onSave(): Promise<void> {
await save()
}
/** Zapisz i zamknij: saves, then returns to the settings index (the Cancel target). */
async function onSaveAndClose(): Promise<void> {
if (await save()) {
await router.push('/settings')
}
}
void load()
</script>
@@ -220,8 +237,27 @@ void load()
</template>
<footer class="fixed right-0 bottom-0 left-[var(--shell-offset,0px)] z-30 flex items-center justify-end gap-2.5 border-t border-border bg-surface px-8 py-3.5">
<!-- No Esc on Cancel: a settings form has no unsaved-changes question,
so Esc would discard edits silently. -->
<Button variant="ghost" to="/settings">{{ t('backend::lang.form.cancel') }}</Button>
<Button variant="primary" data-action="save" :disabled="busy || loading || !schema" @click="onSave">
<Button
variant="outline"
data-action="save-close"
hotkey="mod+enter"
:title="shortcutHint(t('backend::lang.form.save_and_close'), 'mod+enter')"
:disabled="busy || loading || !schema"
@click="onSaveAndClose"
>
{{ t('backend::lang.form.save_and_close') }}
</Button>
<Button
variant="primary"
data-action="save"
hotkey="mod+s"
:title="shortcutHint(t('backend::lang.form.save'), 'mod+s')"
:disabled="busy || loading || !schema"
@click="onSave"
>
{{ busy ? t('backend::lang.form.saving') : t('backend::lang.form.save') }}
</Button>
</footer>

View File

@@ -0,0 +1,125 @@
// My account sections plugins contribute (phase 19.7, D-04 part 1).
// Fixtures are neutral acme.* data; no application names appear in
// framework tests.
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { enableAutoUnmount, flushPromises } from '@vue/test-utils'
import { setBundle } from '../../src/app/i18n'
import { toasts } from '../../src/state/useToasts'
import { langFixture } from '../fixtures/typed'
import { API, mountApp, profile, requestsTo, resetState, type Route } from '../helpers'
const CONTRIBUTIONS = `${API}/account/contributions`
const OPEN = `${CONTRIBUTIONS}/site_link/actions/open`
const strings = {
'backend::lang.form.action_stale': { other: 'This action no longer applies.' },
'backend::lang.form.action_done': { other: 'Action completed.' },
}
const envelope = (data: unknown) => ({ body: { data, meta: {} } })
const sections = [
{
name: 'site_link',
label: 'Site account',
description: 'Link the site account you sign in with.',
status: 'Not linked',
actions: [{ name: 'open', label: 'Link account', confirm: '', danger: false }],
},
{
name: 'newsletter',
label: 'Newsletter digest',
description: '',
status: 'Weekly',
actions: [{ name: 'stop', label: 'Stop the digest', confirm: 'Stop the weekly digest?', danger: true }],
},
]
async function openAccount(routes: Record<string, Route> = {}) {
return mountApp(
'/account',
{
[`GET ${API}/auth/me`]: envelope(profile.data),
[`GET ${API}/account/tokens`]: envelope([]),
[`GET ${CONTRIBUTIONS}`]: envelope(sections),
...routes,
},
{ attach: true },
)
}
beforeEach(() => {
resetState()
setBundle({ ...langFixture.data, ...strings }, 'en')
})
afterEach(() => {
document.body.innerHTML = ''
vi.restoreAllMocks()
})
enableAutoUnmount(afterEach)
describe('My account contributions', () => {
it('renders one card per section with its label, description, status and actions', async () => {
const { wrapper } = await openAccount()
const cards = wrapper.findAll('[data-account-contribution]')
expect(cards.map((card) => card.attributes('data-account-contribution'))).toEqual(['site_link', 'newsletter'])
expect(cards[0]!.find('h2').text()).toBe('Site account')
expect(cards[0]!.text()).toContain('Link the site account you sign in with.')
expect(wrapper.findAll('[data-account-contribution-status]').map((status) => status.text())).toEqual(['Not linked', 'Weekly'])
expect(cards[1]!.find('[data-account-contribution-action="stop"]').text()).toBe('Stop the digest')
// Text, never HTML.
expect(wrapper.find('[data-account-contribution]').html()).not.toContain('v-html')
})
it('renders no card when no plugin contributes', async () => {
const { wrapper } = await openAccount({ [`GET ${CONTRIBUTIONS}`]: envelope([]) })
expect(wrapper.findAll('[data-account-contribution]')).toHaveLength(0)
expect(wrapper.find('[data-api-tokens]').exists()).toBe(true)
})
it('an action without a confirmation posts at once, shows the toast, opens and renders the URL and reloads the list', async () => {
const opened = vi.spyOn(window, 'open').mockImplementation(() => null)
const { wrapper, calls } = await openAccount({
[`POST ${OPEN}`]: envelope({ message: 'Open the site to finish linking.', url: 'https://blog.example.com/link-admin?code=abc' }),
})
await wrapper.find('[data-account-contribution-action="open"]').trigger('click')
await flushPromises()
expect(requestsTo(calls, 'POST', OPEN)).toHaveLength(1)
expect(requestsTo(calls, 'POST', OPEN)[0]!.headers.get('X-Requested-With')).toBe('XMLHttpRequest')
expect(toasts.value.map((toast) => [toast.text, toast.tone])).toEqual([['Open the site to finish linking.', 'success']])
expect(opened).toHaveBeenCalledWith('https://blog.example.com/link-admin?code=abc', '_blank', 'noopener')
const link = wrapper.find('[data-account-contribution-url]')
expect(link.attributes('href')).toBe('https://blog.example.com/link-admin?code=abc')
expect(link.attributes('target')).toBe('_blank')
expect(link.attributes('rel')).toBe('noopener noreferrer')
expect(requestsTo(calls, 'GET', CONTRIBUTIONS)).toHaveLength(2)
expect(document.body.querySelector('[data-confirm-dialog]')).toBeNull()
})
it('a danger action asks first and posts on confirm', async () => {
const STOP = `${CONTRIBUTIONS}/newsletter/actions/stop`
const { wrapper, calls } = await openAccount({ [`POST ${STOP}`]: envelope({ message: 'Stopped.', url: '' }) })
await wrapper.find('[data-account-contribution-action="stop"]').trigger('click')
await flushPromises()
const dialog = document.body.querySelector<HTMLElement>('[data-confirm-dialog]')
expect(dialog?.textContent).toContain('Stop the weekly digest?')
expect(requestsTo(calls, 'POST', STOP)).toHaveLength(0)
dialog!.querySelector<HTMLButtonElement>('[data-action="confirm"]')!.click()
await flushPromises()
expect(requestsTo(calls, 'POST', STOP)).toHaveLength(1)
expect(toasts.value.map((toast) => toast.text)).toEqual(['Stopped.'])
expect(wrapper.find('[data-account-contribution-url]').exists()).toBe(false)
})
it('409 shows the stale toast and refetches the list', async () => {
const { wrapper, calls } = await openAccount({
[`POST ${OPEN}`]: { status: 409, body: { error: { code: 'conflict', message: 'Conflict', details: {} } } },
})
await wrapper.find('[data-account-contribution-action="open"]').trigger('click')
await flushPromises()
expect(toasts.value.map((toast) => [toast.text, toast.tone])).toEqual([['This action no longer applies.', 'danger']])
expect(requestsTo(calls, 'GET', CONTRIBUTIONS)).toHaveLength(2)
})
})

View File

@@ -0,0 +1,307 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import {
ariaKeyshortcuts,
availableShortcuts,
closeShortcutHelp,
comboOf,
hotkeyRoot,
installHotkeys,
isEditableTarget,
isMacPlatform,
shortcutHelp,
shortcutHint,
shortcutLabel,
shortcutParts,
} from '../../src/app/hotkeys'
import { setBundle } from '../../src/app/i18n'
import lang from '../fixtures/lang.json'
import { press } from '../helpers'
const key = (init: KeyboardEventInit) => new KeyboardEvent('keydown', init)
let uninstalls: Array<() => void> = []
function install(): () => void {
const uninstall = installHotkeys()
uninstalls.push(uninstall)
return uninstall
}
function button(hotkey: string, parent: ParentNode = document.body): HTMLButtonElement {
const element = document.createElement('button')
element.setAttribute('data-hotkey', hotkey)
parent.appendChild(element)
return element
}
function dialog(attrs: Record<string, string>): HTMLDivElement {
const element = document.createElement('div')
for (const [name, value] of Object.entries(attrs)) {
element.setAttribute(name, value)
}
document.body.appendChild(element)
return element
}
beforeEach(() => {
setBundle(lang.data, 'pl')
})
afterEach(() => {
for (const uninstall of uninstalls) {
uninstall()
}
uninstalls = []
closeShortcutHelp()
document.body.innerHTML = ''
})
describe('comboOf', () => {
it('maps the modifier combos with Ctrl or Cmd', () => {
expect(comboOf(key({ key: 's', ctrlKey: true }))).toBe('mod+s')
expect(comboOf(key({ key: 's', metaKey: true }))).toBe('mod+s')
expect(comboOf(key({ key: 'S', ctrlKey: true, shiftKey: true }))).toBe('mod+shift+s')
expect(comboOf(key({ key: 'Enter', ctrlKey: true }))).toBe('mod+enter')
expect(comboOf(key({ key: 'Enter', metaKey: true }))).toBe('mod+enter')
})
it('maps the plain keys whatever the shift state', () => {
expect(comboOf(key({ key: 'Escape' }))).toBe('escape')
expect(comboOf(key({ key: '/' }))).toBe('/')
expect(comboOf(key({ key: '?', shiftKey: true }))).toBe('?')
})
it('ignores AltGr, Alt, plain letters, Ctrl+Shift+Enter and composition', () => {
expect(comboOf(key({ key: 's', ctrlKey: true, altKey: true }))).toBeNull()
expect(comboOf(key({ key: 's', altKey: true }))).toBeNull()
expect(comboOf(key({ key: 's' }))).toBeNull()
expect(comboOf(key({ key: 'Enter', ctrlKey: true, shiftKey: true }))).toBeNull()
expect(comboOf(key({ key: 's', ctrlKey: true, isComposing: true }))).toBeNull()
})
it('reads the physical key of a non-Latin layout', () => {
expect(comboOf(key({ key: 'ы', code: 'KeyS', ctrlKey: true }))).toBe('mod+s')
expect(comboOf(key({ key: 'ы', code: 'KeyD', ctrlKey: true }))).toBeNull()
})
})
describe('labels', () => {
it('detects Apple platforms', () => {
expect(isMacPlatform('MacIntel')).toBe(true)
expect(isMacPlatform('iPhone')).toBe(true)
expect(isMacPlatform('iPad')).toBe(true)
expect(isMacPlatform('Linux x86_64')).toBe(false)
expect(isMacPlatform('Win32')).toBe(false)
})
it('reads navigator.platform by default', () => {
vi.spyOn(navigator, 'platform', 'get').mockReturnValue('MacIntel')
expect(isMacPlatform()).toBe(true)
expect(shortcutLabel('mod+s')).toBe('⌘S')
})
it('names the keys with words on Linux and glyphs on macOS', () => {
expect(shortcutLabel('mod+s', false)).toBe('Ctrl+S')
expect(shortcutLabel('mod+enter', false)).toBe('Ctrl+Enter')
expect(shortcutLabel('mod+shift+s', false)).toBe('Ctrl+Shift+S')
expect(shortcutLabel('escape', false)).toBe('Esc')
expect(shortcutLabel('mod+s', true)).toBe('⌘S')
expect(shortcutLabel('mod+enter', true)).toBe('⌘↩')
expect(shortcutLabel('mod+shift+s', true)).toBe('⇧⌘S')
expect(shortcutParts('mod+shift+s', true)).toEqual(['⇧', '⌘', 'S'])
expect(shortcutParts('/', false)).toEqual(['/'])
expect(shortcutParts('?', true)).toEqual(['?'])
})
it('builds the tooltip hint from the phrasebook string', () => {
expect(shortcutHint('Zapisz', 'mod+s', false)).toBe('Zapisz (Ctrl+S)')
expect(shortcutHint('Zapisz', 'mod+s', true)).toBe('Zapisz (⌘S)')
})
it('lists the Control and Meta forms for aria-keyshortcuts', () => {
expect(ariaKeyshortcuts('mod+s mod+enter')).toBe('Control+S Meta+S Control+Enter Meta+Enter')
expect(ariaKeyshortcuts('mod+shift+s')).toBe('Control+Shift+S Meta+Shift+S')
expect(ariaKeyshortcuts('escape')).toBe('Escape')
expect(ariaKeyshortcuts('/')).toBe('/')
})
})
describe('isEditableTarget', () => {
it('is true inside inputs, textareas, selects and contenteditable', () => {
document.body.innerHTML = `
<input id="i"><textarea id="t"></textarea><select id="s"></select>
<div contenteditable="true"><span id="c">x</span></div>
<div contenteditable="false"><span id="n">x</span></div>
<button id="b"></button>`
for (const id of ['i', 't', 's', 'c']) {
expect(isEditableTarget(document.getElementById(id))).toBe(true)
}
expect(isEditableTarget(document.getElementById('b'))).toBe(false)
expect(isEditableTarget(document.getElementById('n'))).toBe(false)
expect(isEditableTarget(document.body)).toBe(false)
expect(isEditableTarget(null)).toBe(false)
})
})
describe('hotkeyRoot', () => {
it('is the document without a modal', () => {
expect(hotkeyRoot(document)).toBe(document)
})
it('is the last open aria-modal dialog or alert dialog', () => {
dialog({ role: 'dialog', 'aria-modal': 'true', 'data-state': 'open' })
const second = dialog({ role: 'dialog', 'aria-modal': 'true', 'data-state': 'open' })
expect(hotkeyRoot(document)).toBe(second)
const alert = dialog({ role: 'alertdialog', 'data-state': 'open' })
expect(hotkeyRoot(document)).toBe(alert)
})
it('ignores popovers (no aria-modal) and closing dialogs', () => {
const modal = dialog({ role: 'dialog', 'aria-modal': 'true' })
dialog({ role: 'dialog' })
dialog({ role: 'dialog', 'aria-modal': 'true', 'data-state': 'closed' })
expect(hotkeyRoot(document)).toBe(modal)
})
})
describe('availableShortcuts', () => {
it('lists the targets of the current root plus ?', () => {
button('mod+s')
button('escape')
expect(availableShortcuts().map((entry) => entry.combo)).toEqual(['mod+s', 'escape', '?'])
const modal = dialog({ role: 'dialog', 'aria-modal': 'true' })
button('mod+s mod+enter', modal)
expect(availableShortcuts().map((entry) => entry.combo)).toEqual(['mod+s', 'mod+enter', '?'])
})
})
describe('installHotkeys', () => {
it('clicks the target once per keydown however often it is installed, and stops after every uninstall', () => {
const save = button('mod+s')
const click = vi.spyOn(save, 'click')
const first = install()
const second = install()
press(document.body, 's', { ctrlKey: true })
expect(click).toHaveBeenCalledTimes(1)
first()
first()
press(document.body, 's', { ctrlKey: true })
expect(click).toHaveBeenCalledTimes(2)
second()
const event = press(document.body, 's', { ctrlKey: true })
expect(click).toHaveBeenCalledTimes(2)
expect(event.defaultPrevented).toBe(false)
})
it('consumes the key without clicking a disabled target or on auto-repeat', () => {
install()
const save = button('mod+s')
const click = vi.spyOn(save, 'click')
expect(press(document.body, 's', { ctrlKey: true, repeat: true }).defaultPrevented).toBe(true)
expect(click).not.toHaveBeenCalled()
save.disabled = true
expect(press(document.body, 's', { ctrlKey: true }).defaultPrevented).toBe(true)
expect(click).not.toHaveBeenCalled()
save.disabled = false
save.setAttribute('aria-disabled', 'true')
press(document.body, 's', { ctrlKey: true })
expect(click).not.toHaveBeenCalled()
})
it('prevents the browser Save page without a target, and lets other modifier keys through', () => {
install()
expect(press(document.body, 's', { ctrlKey: true }).defaultPrevented).toBe(true)
expect(press(document.body, 'Enter', { ctrlKey: true }).defaultPrevented).toBe(false)
expect(press(document.body, 'S', { ctrlKey: true, shiftKey: true }).defaultPrevented).toBe(false)
})
it('stops a handled modifier key before an editor sees it, also inside an editable control', () => {
install()
const save = button('mod+enter')
const click = vi.spyOn(save, 'click')
const editor = document.createElement('div')
editor.setAttribute('contenteditable', 'true')
document.body.appendChild(editor)
const editorKeys = vi.fn()
editor.addEventListener('keydown', editorKeys)
const event = press(editor, 'Enter', { ctrlKey: true })
expect(event.defaultPrevented).toBe(true)
expect(click).toHaveBeenCalledTimes(1)
expect(editorKeys).not.toHaveBeenCalled()
})
it('searches only the innermost modal', () => {
install()
const page = button('mod+s')
const pageClick = vi.spyOn(page, 'click')
const modal = dialog({ role: 'dialog', 'aria-modal': 'true', 'data-state': 'open' })
const submit = button('mod+s mod+enter', modal)
const submitClick = vi.spyOn(submit, 'click')
press(document.body, 's', { ctrlKey: true })
press(document.body, 'Enter', { metaKey: true })
expect(submitClick).toHaveBeenCalledTimes(2)
expect(pageClick).not.toHaveBeenCalled()
dialog({ role: 'alertdialog', 'data-state': 'open' })
expect(press(document.body, 's', { ctrlKey: true }).defaultPrevented).toBe(true)
expect(submitClick).toHaveBeenCalledTimes(2)
expect(pageClick).not.toHaveBeenCalled()
})
it('runs plain keys outside editable controls and open layers only', () => {
install()
const cancel = button('escape')
const click = vi.spyOn(cancel, 'click')
const input = document.createElement('input')
document.body.appendChild(input)
expect(press(input, 'Escape').defaultPrevented).toBe(false)
expect(click).not.toHaveBeenCalled()
expect(press(document.body, 'Escape').defaultPrevented).toBe(true)
expect(click).toHaveBeenCalledTimes(1)
const handled = document.createElement('div')
document.body.appendChild(handled)
handled.addEventListener('keydown', (event) => event.preventDefault())
press(handled, 'Escape')
expect(click).toHaveBeenCalledTimes(1)
const layer = dialog({ 'data-dismissable-layer': '' })
press(document.body, 'Escape')
expect(click).toHaveBeenCalledTimes(1)
layer.remove()
cancel.disabled = true
expect(press(document.body, 'Escape').defaultPrevented).toBe(false)
})
it('focuses an input target and opens the help on ?', () => {
install()
const search = document.createElement('input')
search.setAttribute('data-hotkey', '/')
search.value = 'abc'
document.body.appendChild(search)
button('mod+s')
expect(press(document.body, '/').defaultPrevented).toBe(true)
expect(document.activeElement).toBe(search)
expect(press(search, '?', { shiftKey: true }).defaultPrevented).toBe(false)
expect(shortcutHelp.value).toBeNull()
search.blur()
expect(press(document.body, '?', { shiftKey: true }).defaultPrevented).toBe(true)
expect(shortcutHelp.value?.map((entry) => entry.combo)).toEqual(['mod+s', '/', '?'])
closeShortcutHelp()
expect(shortcutHelp.value).toBeNull()
})
})

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