feat(backend): stabilize draft editor flow and complete smoke regression baseline
- add editor entry flow with editor context and ensure-draft bootstrap - add draft summary read model and single-record draft read endpoints - add typed draft, edit and publish conflicts with validation errors - add pricing diagnostics and publish readiness endpoints - fix Decimal serialization in seat price and test preview flows - harden draft lifecycle guards for published vs draft current version - update API map and smoke regression checklist - add backend README and smoke regression script
This commit is contained in:
greebo
@@ -31,19 +31,78 @@ export SCHEME_ID="82086336d385427f9d56244f9e1dd772"
|
||||
- GET /api/v1/schemes/{scheme_id}/current -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/versions -> 200
|
||||
|
||||
## 3. Structure read model
|
||||
Validate:
|
||||
- scheme_id is stable
|
||||
- current version exists
|
||||
- version list contains current version
|
||||
- status and counts are consistent
|
||||
|
||||
## 3. Editor entry flow
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/editor/context -> 200
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/ensure -> 200
|
||||
|
||||
Validate:
|
||||
- editor context returns current_scheme_version_id
|
||||
- editor context distinguishes draft vs published state correctly
|
||||
- ensure endpoint is idempotent on current draft
|
||||
- ensure endpoint creates a new draft from published current when needed
|
||||
- returned scheme_version_id is reusable as expected_scheme_version_id
|
||||
|
||||
## 4. Draft read model
|
||||
|
||||
Using current draft version id from draft/ensure:
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/summary?expected_scheme_version_id={draft_version_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/structure?expected_scheme_version_id={draft_version_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/validation?expected_scheme_version_id={draft_version_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/compare-preview?expected_scheme_version_id={draft_version_id} -> 200
|
||||
|
||||
Validate:
|
||||
- summary returns total_seats / total_sectors / total_groups
|
||||
- summary returns validation_summary / structure_diff_summary / publish_readiness
|
||||
- structure returns lists for seats / sectors / groups
|
||||
- validation is deterministic
|
||||
- compare preview returns stable diff structure
|
||||
- stale expected_scheme_version_id returns typed 409 conflict
|
||||
|
||||
## 5. Draft entity reads
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/seats/records/{seat_record_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/sectors/records/{sector_record_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/groups/records/{group_record_id} -> 200
|
||||
|
||||
Validate:
|
||||
- record endpoints return exact draft entities
|
||||
- unknown record id returns 404
|
||||
- stale expected_scheme_version_id returns typed 409 conflict
|
||||
|
||||
## 6. Structure read model
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/current/sectors -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current/groups -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current/seats -> 200
|
||||
|
||||
## 4. SVG / display pipeline
|
||||
Validate:
|
||||
- total counts are non-negative
|
||||
- known sample scheme returns expected object lists
|
||||
- seats contain seat_id / sector_id / group_id contract where applicable
|
||||
|
||||
## 7. SVG / display pipeline
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/current/svg -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current/svg/display -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current/svg/display/meta -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current/svg/display?mode=optimized -> 200 or explicit controlled failure
|
||||
- GET /api/v1/schemes/{scheme_id}/current/svg/display/meta?mode=optimized -> 200 or explicit controlled failure
|
||||
|
||||
## 5. Pricing read model / diagnostics
|
||||
Validate:
|
||||
- response content type for svg endpoints is image/svg+xml
|
||||
- meta returns scheme_id, scheme_version_id, view_box, width, height
|
||||
- no 500 on passthrough mode
|
||||
- unsupported mode returns 422
|
||||
|
||||
## 8. Pricing read model
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing/coverage -> 200
|
||||
@@ -51,71 +110,113 @@ export SCHEME_ID="82086336d385427f9d56244f9e1dd772"
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing/explain/{seat_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing/rules/diagnostics -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current/seats/{seat_id}/price -> 200 for priced seat
|
||||
- GET /api/v1/schemes/{scheme_id}/test/seats/{seat_id} -> 200 for priced and unpriced seat
|
||||
|
||||
## 6. Editor entry workflow
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/editor/context -> 200 always
|
||||
- if context.needs_new_draft=true -> POST /api/v1/schemes/{scheme_id}/draft/ensure -> 200
|
||||
- after ensure -> GET /api/v1/schemes/{scheme_id}/editor/context -> 200 and editable=true
|
||||
- GET /api/v1/schemes/{scheme_id}/test/seats/{seat_id} -> 200 for known seat
|
||||
|
||||
Validate:
|
||||
- published current version does not break editor bootstrap
|
||||
- ensure returns created_new_draft=true when current was published
|
||||
- ensure returns created_new_draft=false when current was already draft
|
||||
- pricing bundle contains categories and rules arrays
|
||||
- coverage values are internally consistent
|
||||
- unpriced seats list explains reason_code / reason_message
|
||||
- explain endpoint shows matched rule for priced seat and null for unpriced seat
|
||||
- diagnostics returns orphan/active rule visibility
|
||||
- test seat preview explains selectable / has_price state
|
||||
- priced test seat amount is serialized as string
|
||||
|
||||
## 7. Draft editor read model
|
||||
## 9. Draft mutations and validation guards
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/summary -> 200 when current version is draft
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/structure -> 200 when current version is draft
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/validation -> 200 when current version is draft
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/compare-preview -> 200 when current version is draft
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/seats/records/{seat_record_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/sectors/records/{sector_record_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/groups/records/{group_record_id} -> 200
|
||||
For current draft version:
|
||||
|
||||
## 8. Draft mutations
|
||||
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/sectors -> 200 or typed 422 conflict
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/groups -> 200 or typed 422 conflict
|
||||
- PATCH /api/v1/schemes/{scheme_id}/draft/seats/records/{seat_record_id} -> 200 or typed 422 validation error
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/seats/bulk -> 200 or typed 422 validation error
|
||||
- PATCH /api/v1/schemes/{scheme_id}/draft/sectors/records/{sector_record_id} -> 200
|
||||
- PATCH /api/v1/schemes/{scheme_id}/draft/groups/records/{group_record_id} -> 200
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/sectors -> 200 or 422
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/groups -> 200 or 422
|
||||
- PATCH /api/v1/schemes/{scheme_id}/draft/seats/records/{seat_record_id} -> 200 or 422
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/seats/bulk -> 200 or 422
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/remap/preview -> 200 or 422
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/remap/apply -> 200 or 422
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/repair-references -> 200
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/remap/preview -> 200 or typed 422 validation error
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/remap/apply -> 200 or typed 422 validation error
|
||||
|
||||
## 9. Publish preview / readiness
|
||||
Validate:
|
||||
- duplicate ids return typed 422
|
||||
- duplicate element binding returns typed 422
|
||||
- unknown sector/group references return typed 422
|
||||
- remap without filters returns typed 422
|
||||
- stale expected_scheme_version_id returns typed 409
|
||||
- published current version rejects draft mutations with typed draft_not_editable conflict
|
||||
|
||||
## 10. Draft publish preview
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/publish/validation -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/publish-readiness -> 200 when current version is draft
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/pricing/snapshot -> 200 when scheme is in draft
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/publish-preview?refresh=true -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/publish-preview -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/publish-preview?refresh=true&baseline_scheme_version_id={published_version_id} -> 200
|
||||
|
||||
## 10. Publish lifecycle
|
||||
Validate:
|
||||
- refresh and cached read both succeed
|
||||
- preview summary contains is_publishable / has_structure_changes / has_artifacts / snapshot_available
|
||||
- pricing_coverage is internally consistent
|
||||
- baseline override returns override strategy when explicit baseline is provided
|
||||
- preview retention does not grow unbounded for same version+variant
|
||||
|
||||
- POST /api/v1/schemes/{scheme_id}/publish -> 200 when draft is ready
|
||||
- POST /api/v1/schemes/{scheme_id}/publish with stale expected_scheme_version_id -> 409
|
||||
- POST /api/v1/schemes/{scheme_id}/unpublish -> 200
|
||||
- POST /api/v1/schemes/{scheme_id}/rollback -> 200
|
||||
## 11. Publish readiness and publish flow
|
||||
|
||||
## 11. Admin / ops
|
||||
For current draft version:
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/publish-readiness -> 200
|
||||
- POST /api/v1/schemes/{scheme_id}/publish?expected_scheme_version_id={draft_version_id} -> 200 or 409
|
||||
|
||||
Validate:
|
||||
- readiness explicitly shows snapshot_available and pricing gate state
|
||||
- publish with stale expected version returns typed 409
|
||||
- publish without draft state returns typed 409
|
||||
- publish success updates current status to published
|
||||
- audit trail contains scheme.published event
|
||||
|
||||
## 12. Admin / ops
|
||||
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/current/artifacts -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/current/validation -> 200
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit -> 200
|
||||
- POST /api/v1/admin/artifacts/publish-preview/cleanup?dry_run=true -> 200
|
||||
|
||||
## 12. Audit trail
|
||||
Optional:
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/current/display/regenerate?mode=passthrough -> 200
|
||||
- POST /api/v1/admin/display/backfill?mode=passthrough&limit=10&only_missing=true -> 200
|
||||
|
||||
Validate:
|
||||
- audit endpoint does not report orphan files or missing files for DB rows in normal state
|
||||
- validation report is readable and deterministic
|
||||
- admin routes do not produce 500 for healthy scheme state
|
||||
|
||||
## 13. Audit trail
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/audit -> 200
|
||||
|
||||
## 13. Fail criteria
|
||||
Validate:
|
||||
- recent publish preview / pricing / version / publish events are present when corresponding operations were run
|
||||
- audit total is non-negative
|
||||
- event payloads stay JSON-serializable
|
||||
|
||||
Regression is considered failed if:
|
||||
## 14. Fail criteria
|
||||
|
||||
Regression is considered failed if any of the following happen:
|
||||
|
||||
- health or db ping fails
|
||||
- any stable read endpoint returns 500
|
||||
- published current version cannot be converted to draft through ensure flow
|
||||
- draft editor summary/read endpoints return inconsistent data
|
||||
- publish-state mutation guard is bypassed
|
||||
- passthrough display endpoint fails on known-good sample
|
||||
- publish preview refresh or cached read returns 500
|
||||
- publish readiness returns 500
|
||||
- editor context or draft ensure returns 500
|
||||
- draft summary / structure / validation / compare-preview returns 500
|
||||
- pricing bundle or diagnostics contract changes unexpectedly
|
||||
- admin audit/cleanup endpoints fail on healthy environment
|
||||
- artifact retention grows without bound for repeated preview refresh on same variant
|
||||
|
||||
## 15. Operator note
|
||||
|
||||
Run this checklist after:
|
||||
- schema changes
|
||||
- pricing schema/repository refactors
|
||||
- artifact lifecycle changes
|
||||
- display pipeline changes
|
||||
- route reorganization
|
||||
- startup/import/config changes
|
||||
- draft lifecycle changes
|
||||
- publish readiness changes
|
||||
|
||||
Reference in New Issue
Block a user