docs(35): validation map for the gap closure
- 35-VALIDATION.md: G-35-1 and G-35-8 rows (postcard unit and Postgres, cabana Postgres, SPA, consumers through scratch modfiles); D-05 and the default-layout byte-identity rows superseded by the 35-05/35-06 notes; manual re-runs of UAT tests 1 and 8 (test 8 scoped to the built-in layouts), a real-inbox check and the deferred plugin follow-up check; open item: site name not checked for a URL scheme at save time - 35-UAT.md: closure_note and rerun_scope on G-35-8 (framework part closed, plugin part deferred); status and results unchanged
This commit is contained in:
@@ -131,3 +131,5 @@ blocked: 0
|
||||
- "Plugins after framework tag: bump framework requirement; user templates use button partial; paymentgateway order templates use button partial, drop duplicate URL; replace user/paymentgateway layout contents keeping their names; fix user.htm text wrapper"
|
||||
- "Demo: reset UAT overrides of golem15.user::mail.layouts.user and golem15.user::mail.activate before re-checking"
|
||||
debug_session: ".planning/debug/mail-layouts-unstyled.md"
|
||||
closure_note: "Framework part closed by 35-05..35-07: built-in default/system/minimal layouts with the logo or site-name header and the footer, Branding site name with the mail.from fallback, header/footer partials and button partial support in every built-in layout, CSS inlined at render with a per-layout opt-out (35-07 tests: TestBuiltinLayoutsLogo, TestHeaderFooterPartials, TestButtonPartial, TestSiteName, TestInlineCSS, TestInlineCSSOptOut, TestInlineFailure, TestMailBrandSiteName, TestMailLayoutInlineOptOut). Plugin part deferred to the follow-up after the framework tag: sm-user-plugin and sm-paymentgateway-plugin framework bump, their CTAs through the button partial, finished user/paymentgateway layouts."
|
||||
rerun_scope: "Re-run test 8 on sm-demo-app scoped to the built-in layouts: reset the UAT overrides of golem15.user::mail.activate and golem15.user::mail.layouts.user, save Branding with a logo and a Site name, preview a template switched to the default layout and to the system layout with a body override that calls the button partial; expect the logo header (or the name), the white card, the styled button and the footer. Deferred follow-up check after the plugin follow-up: the activate CTA renders as a button and the user/paymentgateway layouts look finished."
|
||||
|
||||
@@ -49,14 +49,21 @@ created: "2026-11-06"
|
||||
| D-10/D-11 | No brand row → `mail.brandCss`; saved → compiled CSS replaces it; `mail.css` still applied; bad colour 422 | unit + Postgres | `go test -short ./modules/postcard -run TestBrand`; `go test ./modules/cabana -run TestMailBrand` | ✅ 35-04 | ✅ green |
|
||||
| D-03 | Permission split per controller, preview, picker list vs upload; no default role grants | Postgres | `go test ./modules/cabana -run TestMailPermissions` | ✅ 35-04 | ✅ green |
|
||||
| D-17 | Recipient always the admin's own email; 429 + Retry-After after the limit | Postgres | `go test ./modules/cabana -run TestMailTestSend` | ✅ 35-04 | ✅ green |
|
||||
| D-05 | Locale parsed for enabled locales; locale filter | unit | `go test -short ./modules/cabana -run TestMailLocale` | ✅ 35-04 | ✅ green |
|
||||
| D-05 | Locale parsed for enabled locales; locale filter | unit | `go test -short ./modules/cabana -run TestMailLocale` | ✅ 35-04 | ⚪ superseded by `.planning/notes/2026-11-13-mail-template-locale-groups.md` (35-05): one record per template, no locale filter; see the G-35-1 row |
|
||||
| sync | Index sync idempotent, concurrency-safe, custom rows untouched | Postgres | `go test ./modules/postcard -run TestSync` | ✅ 35-04 | ✅ green |
|
||||
| consumers | user + paymentgateway mail renders unchanged | unit (sibling repos) | `bash scripts/check-phase35.sh --consumers` | ✅ | ✅ green |
|
||||
| byte-identity | Existing postcard tests pass; default layout output unchanged | unit | `go test -short ./modules/postcard/...` | ✅ | ✅ green |
|
||||
| byte-identity | Existing postcard tests pass; default layout output unchanged | unit | `go test -short ./modules/postcard/...` | ✅ | ⚪ superseded by `.planning/notes/2026-11-13-mail-layouts-css-inlining.md` (35-06): default.htm is WinterCMS's default layout and output is CSS-inlined; existing postcard tests stay green, see the G-35-8 row |
|
||||
| G-35-1 | Locale grouping: `TemplateBase` / `Catalog.TemplateFor` rules; send order `<template>-<locale>` customization → default customization → default file, file-backed names unchanged; `EnsureLocaleRows` (non-default locales without files, idempotent, customized content kept, file_hash follows the base); base_code from SyncIndex; reset of a fallback code; migrations roll back | postcard unit + Postgres | `go test -short ./modules/postcard -run '^(TestTemplateBase\|TestTemplateFor\|TestSendLocaleFallback)$'`; `go test ./modules/postcard -run '^TestEnsureLocaleRows$'` | ✅ 35-07 | ✅ green |
|
||||
| G-35-1 | Admin side: one list row per template, customized locales, grouped badges and status filter, `localeVariants` order/labels/states/current, default version on a not-customized fallback row, save then send, reset, drift through the base file, file version against the base file, out-of-group ids 404, permission split on fallback rows, a locale enabled at run time | cabana Postgres | `go test ./modules/cabana -run '^TestMailLocaleGroups$'` | ✅ 35-07 | ✅ green |
|
||||
| G-35-1 | Locale switcher: options, current, navigation (query kept), restored selection on refusal or a throwing guard; FormView shows it only with two or more variants and asks the unsaved-changes confirm | SPA unit | `npm --prefix admin run test -- tests/form/LocaleVariantSwitcher.test.ts tests/form/FormViewMail.test.ts` | ✅ 35-07 | ✅ green |
|
||||
| G-35-8 | Built-in layouts: logo img (alt = site name) in the header of default and system, above the message in minimal; site name or nothing without a logo; header/footer partials (logo, name, url; © year and name); button partial (class, href, type) in every built-in layout; site name precedence with the mail.from fallback | postcard unit | `go test -short ./modules/postcard -run '^(TestBuiltinLayoutsLogo\|TestHeaderFooterPartials\|TestButtonPartial\|TestSiteName)$'` | ✅ 35-07 | ✅ green |
|
||||
| G-35-8 | CSS inlining: brand colour on the button, DOCTYPE kept, media query left in a style block, text part unchanged, safety check on the inlined output (an unsafe raw layout override falls back to the file), per-layout opt-out (file header key, override column, layout draft), inliner failure sends the un-inlined HTML with one warning per layout per minute | postcard unit | `go test -short ./modules/postcard -run '^(TestInlineCSS\|TestInlineCSSOptOut\|TestInlineFailure)$'` | ✅ 35-07 | ✅ green |
|
||||
| G-35-8 | Admin side: Branding site name (trimmed, max 255, preview and send header, no header row without name or logo); layout form inlining switch (file layout, reset to the file value, custom layout with the switch off) | cabana Postgres | `go test ./modules/cabana -run '^(TestMailBrandSiteName\|TestMailLayoutInlineOptOut)$'` | ✅ 35-07 | ✅ green |
|
||||
| G-35-8 | Core plugins still send their mail against this checkout with the go-premailer requirement, read-only: scratch `-modfile` copies (GOWORK=off, GOPROXY=off), framework resolves to this checkout, sibling trees clean before and after | unit (sibling repos) | `bash scripts/check-phase35.sh --consumers` (self-test plants the dirty-tree and modfile cases) | ✅ 35-07 | ✅ green |
|
||||
| UI | codeeditor keys, insertImage escaping, footer record actions, preview sandbox | SPA unit + browser | `npm --prefix admin run test -- MailPreview CodeEditor insertImage FormViewMail`; `npm --prefix admin run test:browser -- codeeditor` | ✅ 35-04 | ✅ green |
|
||||
| gates | OpenAPI/schema in sync; dist matches; docs identifiers exist | scripts | `scripts/check-admin-openapi.sh --check`; `scripts/check-admin-dist.sh`; `go test ./cmd/summer -run TestDocsTree` | ✅ | ✅ green |
|
||||
|
||||
*Status key (historical): pending · green · red · flaky — all map rows above are green.*
|
||||
*Status key (historical): pending · green · red · flaky · superseded — every map row above is green or superseded.*
|
||||
|
||||
---
|
||||
|
||||
@@ -67,6 +74,7 @@ created: "2026-11-06"
|
||||
- [x] `admin/tests/form/CodeEditorField.test.ts`, `admin/tests/browser/codeeditor.test.ts`, `admin/tests/form/MailPreviewField.test.ts`, `admin/tests/form/insertImage.test.ts` — 35-04 Task 4
|
||||
- [x] Update `modules/pact/capabilities_test.go` `TestRowStateValues` and attach absolute URL coverage — 35-04 Task 2
|
||||
- [x] `scripts/check-phase35.sh` — 35-04 Task 1
|
||||
- [x] Gap closure (G-35-1, G-35-8): `modules/postcard/{locale,locale_postgres,layouts,inline}_test.go`, `modules/cabana/mail_{locale,brand_layout}_postgres_test.go`, extended `admin/tests/form/{LocaleVariantSwitcher,FormViewMail}.test.ts`; `check-phase35.sh` requires every new name and runs the consumers through scratch modfiles — 35-07
|
||||
|
||||
---
|
||||
|
||||
@@ -76,6 +84,14 @@ created: "2026-11-06"
|
||||
|----------|----------|------------|-------------------|
|
||||
| Test-send mail looks right in a real inbox | D-17 | Visual rendering in mail clients | Send a draft from the template form to Mailpit and check HTML and text parts |
|
||||
| Code editor feel (highlighting, focus, theme) | D-09 | Visual | Open a layout form in the dev SPA, edit each tab |
|
||||
| One admin entry per template with a locale switcher (UAT test 1 re-run) | G-35-1 | Placement and readability of the switcher and the Customized locales column in the embedded admin | On sm-demo-app rebuilt on this framework commit: open Mail templates, check one row per template with Customized locales, open a template, switch to a locale without a file, save it, switch back; re-run UAT test 1 in full |
|
||||
| Built-in layouts look finished (UAT test 8 re-run, scoped) | G-35-8 | Visual rendering of the layouts and the preview | On sm-demo-app: first reset the UAT overrides of `golem15.user::mail.activate` and `golem15.user::mail.layouts.user`; save Branding with a logo and a Site name; preview a template switched to the default layout, then to the system layout, with a body override that calls the button partial (`{{ partial "button" "url" "https://example.com" "body" "Go" }}`). Expect the logo header (or the name without a logo), the white card, the styled button and the footer (© year and name) |
|
||||
| Inlined mail in a real inbox | G-35-8 | Mail clients (webmail, Outlook) differ in what they keep of a style block | Test-send a template in the default layout to a real inbox; the button and card keep their colours with the style block stripped |
|
||||
| Deferred follow-up check: plugin mail | G-35-8 (plugin part) | Deferred to the plugin follow-up after the framework tag (sm-user-plugin, sm-paymentgateway-plugin: framework bump, button partial in their templates, finished user/paymentgateway layouts keeping their names) | After the plugin follow-up ships: the activate CTA renders as a button and the user and paymentgateway layouts look finished |
|
||||
|
||||
**G-35-8 status:** framework part closed by 35-05..35-07 (built-in layouts, logo, site name, button partial support, CSS inlining, consumers gate). Plugin part deferred: the plugin templates' CTA through the button partial, the replaced user/paymentgateway layouts and the plugins' framework bump wait for the plugin follow-up after the framework tag (deferred follow-up check above).
|
||||
|
||||
**Open item (not in 35-07's scope):** the Branding site name is not checked for a URL scheme at save time. A name holding `javascript:`, `vbscript:` or `data:` is saved; the rendered header then fails the safety check, so the preview refuses it (pinned by `TestMailBrandSiteName/unsafe_name_current_behaviour`) and sends in the built-in layouts fail until the name is changed. A save-time check is a follow-up.
|
||||
|
||||
---
|
||||
|
||||
@@ -88,4 +104,4 @@ created: "2026-11-06"
|
||||
- [x] Feedback latency < 120s
|
||||
- [x] `nyquist_compliant: true` set in frontmatter
|
||||
|
||||
**Approval:** pending (gate green after 35-04; formal validate-phase may follow)
|
||||
**Approval:** pending (gate green after 35-04 and again after 35-07 with the gap-closure tests; formal validate-phase may follow)
|
||||
|
||||
Reference in New Issue
Block a user