feat(frontend): add editor integration shell and draft read-model views
- add editor integration shell - add editor context read flow - add draft flow entry handling - add summary, structure, validation and compare-preview views - render backend read models for draft and published states - verify sample-contract entities: 3 seats, 1 group, 1 sector
This commit is contained in:
greebo
260
doc/README.md
Normal file
260
doc/README.md
Normal file
@@ -0,0 +1,260 @@
|
||||
# svg-service backend
|
||||
|
||||
Backend for SVG scheme upload, draft editing, pricing, diagnostics, publish preview, and publish lifecycle.
|
||||
|
||||
## Stack
|
||||
|
||||
- Python 3.11
|
||||
- FastAPI
|
||||
- SQLAlchemy async
|
||||
- PostgreSQL 16
|
||||
- Docker Compose
|
||||
|
||||
## Runtime
|
||||
|
||||
Default backend port: `9020`
|
||||
|
||||
Health check:
|
||||
- `GET /healthz`
|
||||
|
||||
Main API prefix:
|
||||
- `/api/v1`
|
||||
|
||||
Auth header:
|
||||
- `X-API-Key`
|
||||
|
||||
Default local admin key:
|
||||
- `admin-local-dev-key`
|
||||
|
||||
## Core lifecycle
|
||||
|
||||
1. Upload SVG
|
||||
2. Normalize and persist structure
|
||||
3. Enter editor flow through context + ensure draft
|
||||
4. Edit sectors / groups / seats in current draft
|
||||
5. Configure pricing and inspect diagnostics
|
||||
6. Build pricing snapshot
|
||||
7. Inspect publish readiness and publish preview
|
||||
8. Publish current draft
|
||||
9. If editing is needed after publish, create or ensure a new draft again
|
||||
|
||||
## Main concepts
|
||||
|
||||
### Scheme
|
||||
Top-level business entity.
|
||||
|
||||
### Scheme version
|
||||
Concrete version of the scheme. A version can be `draft` or `published`.
|
||||
|
||||
### Current version
|
||||
The version referenced by the scheme registry as active current.
|
||||
|
||||
### Draft
|
||||
Editable current version. All editor mutations and draft pricing operations must target a current draft version only.
|
||||
|
||||
### Published version
|
||||
Non-editable current version. If current version is published, editor flow must first create or ensure a new draft.
|
||||
|
||||
### Upload artifacts
|
||||
Stored technical artifacts, including:
|
||||
- original svg
|
||||
- sanitized svg
|
||||
- normalized json
|
||||
- display svg
|
||||
- publish preview json
|
||||
|
||||
## Editor entry flow
|
||||
|
||||
### 1. Inspect editor state
|
||||
`GET /api/v1/schemes/{scheme_id}/editor/context`
|
||||
|
||||
Response tells whether:
|
||||
- current version is draft
|
||||
- editor is available
|
||||
- a new draft should be created
|
||||
- recommended action is `use_current_draft` or `create_draft`
|
||||
|
||||
### 2. Ensure editable draft
|
||||
`POST /api/v1/schemes/{scheme_id}/draft/ensure`
|
||||
|
||||
Behavior:
|
||||
- if current version is already draft: returns it with `created=false`
|
||||
- if current version is published: clones current version into a new current draft and returns it with `created=true`
|
||||
|
||||
Returned `scheme_version_id` should be reused as:
|
||||
- `expected_scheme_version_id`
|
||||
|
||||
for draft reads and mutations.
|
||||
|
||||
## Optimistic concurrency
|
||||
|
||||
Mutable draft flows support optimistic concurrency through query params:
|
||||
- `expected_current_scheme_version_id`
|
||||
- `expected_scheme_version_id`
|
||||
|
||||
Typical typed conflicts:
|
||||
- `stale_current_version`
|
||||
- `stale_draft_version`
|
||||
- `draft_not_editable`
|
||||
- `publish_not_ready`
|
||||
|
||||
## Main operator routes
|
||||
|
||||
### System
|
||||
- `GET /healthz`
|
||||
- `GET /api/v1/ping`
|
||||
- `GET /api/v1/db/ping`
|
||||
- `GET /api/v1/manifest`
|
||||
|
||||
### Uploads
|
||||
- `POST /api/v1/schemes/upload`
|
||||
- `GET /api/v1/uploads`
|
||||
- `GET /api/v1/uploads/{upload_id}`
|
||||
- `GET /api/v1/uploads/{upload_id}/normalized`
|
||||
|
||||
### Scheme registry
|
||||
- `GET /api/v1/schemes`
|
||||
- `GET /api/v1/schemes/{scheme_id}`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current`
|
||||
- `GET /api/v1/schemes/{scheme_id}/versions`
|
||||
- `POST /api/v1/schemes/{scheme_id}/versions`
|
||||
- `GET /api/v1/schemes/{scheme_id}/publish/validation`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/publish-readiness`
|
||||
- `POST /api/v1/schemes/{scheme_id}/publish`
|
||||
- `POST /api/v1/schemes/{scheme_id}/unpublish`
|
||||
- `POST /api/v1/schemes/{scheme_id}/rollback`
|
||||
|
||||
### Editor / draft
|
||||
- `GET /api/v1/schemes/{scheme_id}/editor/context`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/ensure`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/summary`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/structure`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/validation`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/compare-preview`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/seats/records/{seat_record_id}`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/sectors/records/{sector_record_id}`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/groups/records/{group_record_id}`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/sectors`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/groups`
|
||||
- `DELETE /api/v1/schemes/{scheme_id}/draft/sectors/records/{sector_record_id}`
|
||||
- `DELETE /api/v1/schemes/{scheme_id}/draft/groups/records/{group_record_id}`
|
||||
- `PATCH /api/v1/schemes/{scheme_id}/draft/seats/records/{seat_record_id}`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/seats/bulk`
|
||||
- `PATCH /api/v1/schemes/{scheme_id}/draft/sectors/records/{sector_record_id}`
|
||||
- `PATCH /api/v1/schemes/{scheme_id}/draft/groups/records/{group_record_id}`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/repair-references`
|
||||
|
||||
### Pricing
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing`
|
||||
- `POST /api/v1/schemes/{scheme_id}/pricing/categories`
|
||||
- `PUT /api/v1/schemes/{scheme_id}/pricing/categories/{pricing_category_id}`
|
||||
- `DELETE /api/v1/schemes/{scheme_id}/pricing/categories/{pricing_category_id}`
|
||||
- `POST /api/v1/schemes/{scheme_id}/pricing/rules`
|
||||
- `PUT /api/v1/schemes/{scheme_id}/pricing/rules/{price_rule_id}`
|
||||
- `DELETE /api/v1/schemes/{scheme_id}/pricing/rules/{price_rule_id}`
|
||||
|
||||
### Pricing diagnostics
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/coverage`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/unpriced-seats`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/explain/{seat_id}`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/rules/diagnostics`
|
||||
|
||||
### Publish preview
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/pricing/snapshot`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/publish-preview`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/remap/preview`
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/remap/apply`
|
||||
|
||||
### Structure read model
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/sectors`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/groups`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/seats`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/seats/{seat_id}/price`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/svg`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/svg/display`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/svg/display/meta`
|
||||
|
||||
### Test mode
|
||||
- `GET /api/v1/schemes/{scheme_id}/test/seats/{seat_id}`
|
||||
|
||||
### Audit
|
||||
- `GET /api/v1/schemes/{scheme_id}/audit`
|
||||
|
||||
### Admin / ops
|
||||
- `GET /api/v1/admin/schemes/{scheme_id}/current/artifacts`
|
||||
- `GET /api/v1/admin/schemes/{scheme_id}/current/validation`
|
||||
- `POST /api/v1/admin/schemes/{scheme_id}/current/display/regenerate`
|
||||
- `POST /api/v1/admin/display/backfill`
|
||||
- `GET /api/v1/admin/artifacts/publish-preview/audit`
|
||||
- `POST /api/v1/admin/artifacts/publish-preview/cleanup`
|
||||
- `GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview`
|
||||
- `POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup`
|
||||
|
||||
## Cleanup of test pricing data
|
||||
|
||||
Cleanup endpoints are intended for removing diagnostic / test categories accidentally accumulated in a shared scheme.
|
||||
|
||||
Preview candidates:
|
||||
`GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview`
|
||||
|
||||
Execute cleanup:
|
||||
`POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup`
|
||||
|
||||
Safety notes:
|
||||
- use `dry_run=true` first
|
||||
- keep `delete_only_without_rules=true` unless you intentionally want a harder cleanup
|
||||
- prefer matching by prefixes instead of raw ids for repetitive test artifacts
|
||||
|
||||
Helper script:
|
||||
- `backend/scripts/cleanup_test_pricing_data.sh`
|
||||
|
||||
Example:
|
||||
`SCHEME_ID=... DRY_RUN=true ./backend/scripts/cleanup_test_pricing_data.sh`
|
||||
|
||||
## Typical local flow
|
||||
|
||||
### 1. Read current version
|
||||
`GET /api/v1/schemes/{scheme_id}/current`
|
||||
|
||||
### 2. Ensure draft
|
||||
`POST /api/v1/schemes/{scheme_id}/draft/ensure`
|
||||
|
||||
Store returned:
|
||||
- `scheme_version_id`
|
||||
|
||||
### 3. Read draft state
|
||||
- `GET /draft/summary?expected_scheme_version_id=...`
|
||||
- `GET /draft/structure?expected_scheme_version_id=...`
|
||||
- `GET /draft/validation?expected_scheme_version_id=...`
|
||||
- `GET /draft/compare-preview?expected_scheme_version_id=...`
|
||||
|
||||
### 4. Perform editor mutations
|
||||
Pass:
|
||||
- `expected_scheme_version_id={draft_scheme_version_id}`
|
||||
|
||||
on every mutation route.
|
||||
|
||||
### 5. Inspect pricing quality
|
||||
- `GET /pricing/coverage`
|
||||
- `GET /pricing/unpriced-seats`
|
||||
- `GET /pricing/explain/{seat_id}`
|
||||
- `GET /pricing/rules/diagnostics`
|
||||
|
||||
### 6. Build snapshot and inspect readiness
|
||||
- `POST /draft/pricing/snapshot`
|
||||
- `GET /draft/publish-readiness`
|
||||
- `GET /draft/publish-preview?refresh=true`
|
||||
|
||||
### 7. Publish
|
||||
- `POST /publish?expected_scheme_version_id=...`
|
||||
|
||||
## Regression
|
||||
|
||||
Main operator regressions:
|
||||
- `backend/scripts/smoke_regression.sh`
|
||||
- `backend/scripts/editor_mutation_regression.sh`
|
||||
|
||||
Run:
|
||||
`API_URL=http://127.0.0.1:9020 API_KEY=admin-local-dev-key SCHEME_ID=... ./backend/scripts/smoke_regression.sh`
|
||||
|
||||
`API_URL=http://127.0.0.1:9020 API_KEY=admin-local-dev-key SCHEME_ID=... ./backend/scripts/editor_mutation_regression.sh`
|
||||
528
doc/frontend-integration-contract.md
Normal file
528
doc/frontend-integration-contract.md
Normal file
@@ -0,0 +1,528 @@
|
||||
# Backend Integration Contract
|
||||
|
||||
This document is the frontend handoff contract for the `svg-service` backend. It is written as an integration baseline, not as an internal backend README.
|
||||
|
||||
## 1. Base URL and Auth
|
||||
|
||||
- Base URL: `http://<host>:9020`
|
||||
- API prefix: `/api/v1`
|
||||
- Auth header: `X-API-Key`
|
||||
|
||||
All non-`/healthz` routes require an API key.
|
||||
|
||||
Auth failure contract:
|
||||
|
||||
- missing API key -> `401` with string detail: `Missing API key`
|
||||
- invalid API key -> `403` with string detail: `Invalid API key`
|
||||
- valid non-admin key on admin-only route -> `403` with string detail: `Admin role required`
|
||||
|
||||
## 2. Roles and Access Boundaries
|
||||
|
||||
- `admin`
|
||||
- full access to protected routes
|
||||
- required for all `/api/v1/admin/...` routes
|
||||
- `operator`
|
||||
- allowed on non-admin protected routes
|
||||
- denied on admin-only routes
|
||||
- `viewer`
|
||||
- allowed on non-admin protected routes
|
||||
- denied on admin-only routes
|
||||
|
||||
Frontend implication:
|
||||
|
||||
- admin UI must treat admin routes as optional capabilities gated by role
|
||||
- frontend must not assume `operator` or `viewer` can call cleanup, audit, backfill, or current-artifact admin routes
|
||||
|
||||
## 3. Core Entities
|
||||
|
||||
### Upload
|
||||
|
||||
Represents one uploaded SVG source and its normalized/sanitized artifacts.
|
||||
|
||||
Important fields:
|
||||
|
||||
- `upload_id`
|
||||
- `original_filename`
|
||||
- `content_type`
|
||||
- `size_bytes`
|
||||
- `original_storage_path`
|
||||
- `sanitized_storage_path`
|
||||
- `normalized_storage_path`
|
||||
- `normalized_elements_count`
|
||||
- `normalized_seats_count`
|
||||
- `normalized_groups_count`
|
||||
- `normalized_sectors_count`
|
||||
|
||||
### Scheme
|
||||
|
||||
Top-level business object created from upload.
|
||||
|
||||
Important fields:
|
||||
|
||||
- `scheme_id`
|
||||
- `source_upload_id`
|
||||
- `name`
|
||||
- `status`
|
||||
- `current_version_number`
|
||||
- `published_at`
|
||||
|
||||
### Scheme Version
|
||||
|
||||
Versioned snapshot of the scheme structure and publish state.
|
||||
|
||||
Important fields:
|
||||
|
||||
- `scheme_version_id`
|
||||
- `scheme_id`
|
||||
- `version_number`
|
||||
- `status`
|
||||
- `normalized_storage_path`
|
||||
- `normalized_*_count`
|
||||
|
||||
### Sector
|
||||
|
||||
Structure entity in a specific `scheme_version`.
|
||||
|
||||
Important fields:
|
||||
|
||||
- `sector_record_id`
|
||||
- `sector_id`
|
||||
- `element_id`
|
||||
- `name`
|
||||
|
||||
Business identity priority:
|
||||
|
||||
- use `sector_id` when present
|
||||
- fallback to `element_id`
|
||||
- never treat `sector_record_id` as business identity across versions
|
||||
|
||||
### Group
|
||||
|
||||
Important fields:
|
||||
|
||||
- `group_record_id`
|
||||
- `group_id`
|
||||
- `element_id`
|
||||
- `name`
|
||||
|
||||
Business identity priority:
|
||||
|
||||
- use `group_id` when present
|
||||
- fallback to `element_id`
|
||||
- never treat `group_record_id` as business identity across versions
|
||||
|
||||
### Seat
|
||||
|
||||
Important fields:
|
||||
|
||||
- `seat_record_id`
|
||||
- `seat_id`
|
||||
- `element_id`
|
||||
- `sector_id`
|
||||
- `group_id`
|
||||
- `row_label`
|
||||
- `seat_number`
|
||||
|
||||
Business identity priority:
|
||||
|
||||
- use `seat_id` when present
|
||||
- fallback to `element_id`
|
||||
- never treat `seat_record_id` as business identity across versions
|
||||
|
||||
### Pricing Category
|
||||
|
||||
Important fields:
|
||||
|
||||
- `pricing_category_id`
|
||||
- `scheme_id`
|
||||
- `name`
|
||||
- `code`
|
||||
|
||||
### Price Rule
|
||||
|
||||
Important fields:
|
||||
|
||||
- `price_rule_id`
|
||||
- `scheme_id`
|
||||
- `pricing_category_id`
|
||||
- `target_type`
|
||||
- `target_ref`
|
||||
- `amount`
|
||||
- `currency`
|
||||
|
||||
### Artifact
|
||||
|
||||
Artifact registry row for generated backend files.
|
||||
|
||||
Important fields:
|
||||
|
||||
- `artifact_id`
|
||||
- `artifact_type`
|
||||
- `artifact_variant`
|
||||
- `storage_path`
|
||||
- `status`
|
||||
- `meta_json`
|
||||
|
||||
Important artifact types currently exercised by regression:
|
||||
|
||||
- `sanitized_svg`
|
||||
- `normalized_json`
|
||||
- `display_svg`
|
||||
- `publish_preview`
|
||||
|
||||
## 4. Lifecycle State Machine
|
||||
|
||||
### Fresh Upload
|
||||
|
||||
Flow:
|
||||
|
||||
1. `POST /api/v1/schemes/upload`
|
||||
2. backend creates:
|
||||
- `upload`
|
||||
- `scheme`
|
||||
- initial `scheme_version`
|
||||
- structure rows
|
||||
- initial artifacts
|
||||
|
||||
Expected initial state:
|
||||
|
||||
- `scheme.status = draft`
|
||||
- `scheme.current_version_number = 1`
|
||||
- current version status = `draft`
|
||||
|
||||
### Current Draft
|
||||
|
||||
If current scheme/version is still draft:
|
||||
|
||||
- editor works directly against current version
|
||||
- `draft/ensure` is idempotent
|
||||
- `draft/ensure` returns `created=false`
|
||||
|
||||
### Ensure Draft From Published Current
|
||||
|
||||
If current scheme/version is published:
|
||||
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/ensure`
|
||||
- backend creates a new draft version
|
||||
- current pointer switches to the new draft
|
||||
- version number increments
|
||||
|
||||
### Publish
|
||||
|
||||
Preconditions:
|
||||
|
||||
- current scheme is draft
|
||||
- current version is draft
|
||||
- publish readiness must be satisfied
|
||||
|
||||
Publish path:
|
||||
|
||||
1. optional `draft/pricing/snapshot`
|
||||
2. `GET draft/publish-readiness`
|
||||
3. optional `GET draft/publish-preview`
|
||||
4. `POST /api/v1/schemes/{scheme_id}/publish`
|
||||
|
||||
Expected result:
|
||||
|
||||
- scheme becomes `published`
|
||||
- current version becomes `published`
|
||||
|
||||
### Rollback
|
||||
|
||||
Path:
|
||||
|
||||
- `POST /api/v1/schemes/{scheme_id}/rollback`
|
||||
|
||||
Effect:
|
||||
|
||||
- current pointer switches to requested historical `version_number`
|
||||
- scheme returns to `draft`
|
||||
- target version becomes current editable draft
|
||||
|
||||
### Unpublish
|
||||
|
||||
Path:
|
||||
|
||||
- `POST /api/v1/schemes/{scheme_id}/unpublish`
|
||||
|
||||
Effect:
|
||||
|
||||
- current scheme becomes `draft`
|
||||
- current version becomes `draft`
|
||||
|
||||
## 5. Editor Flow
|
||||
|
||||
### Entry Point
|
||||
|
||||
- `GET /api/v1/schemes/{scheme_id}/editor/context`
|
||||
|
||||
Use it first to decide whether:
|
||||
|
||||
- current draft can be edited directly
|
||||
- or a new draft must be created from published current
|
||||
|
||||
Important response fields:
|
||||
|
||||
- `current_scheme_version_id`
|
||||
- `current_version_number`
|
||||
- `scheme_status`
|
||||
- `scheme_version_status`
|
||||
- `current_is_draft`
|
||||
- `create_draft_available`
|
||||
- `recommended_action`
|
||||
|
||||
### Draft Read Models
|
||||
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/ensure`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/summary`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/structure`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/validation`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/compare-preview`
|
||||
|
||||
Frontend should treat `draft/structure` as the main editable read model.
|
||||
|
||||
### Patch Operations
|
||||
|
||||
Supported flows:
|
||||
|
||||
- single seat patch
|
||||
- bulk seat patch
|
||||
- sector create/patch/delete
|
||||
- group create/patch/delete
|
||||
- repair references
|
||||
- remap preview/apply
|
||||
|
||||
Frontend rule:
|
||||
|
||||
- always send `expected_scheme_version_id` when mutating or reading draft state after editor entry
|
||||
|
||||
### Stale Conflict Handling
|
||||
|
||||
If backend returns a stale or draft editability conflict:
|
||||
|
||||
- stop optimistic local mutation flow
|
||||
- re-read:
|
||||
- `editor/context`
|
||||
- `draft/summary`
|
||||
- `draft/structure`
|
||||
|
||||
Do not keep editing against stale cached `scheme_version_id`.
|
||||
|
||||
## 6. Pricing Flow
|
||||
|
||||
### Categories
|
||||
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing`
|
||||
- `POST /api/v1/schemes/{scheme_id}/pricing/categories`
|
||||
- `PUT /api/v1/schemes/{scheme_id}/pricing/categories/{pricing_category_id}`
|
||||
- `DELETE /api/v1/schemes/{scheme_id}/pricing/categories/{pricing_category_id}`
|
||||
|
||||
### Rules
|
||||
|
||||
- `POST /api/v1/schemes/{scheme_id}/pricing/rules`
|
||||
- `PUT /api/v1/schemes/{scheme_id}/pricing/rules/{price_rule_id}`
|
||||
- `DELETE /api/v1/schemes/{scheme_id}/pricing/rules/{price_rule_id}`
|
||||
|
||||
### Read Models
|
||||
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/coverage`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/unpriced-seats`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/explain/{seat_id}`
|
||||
- `GET /api/v1/schemes/{scheme_id}/pricing/rules/diagnostics`
|
||||
- `GET /api/v1/schemes/{scheme_id}/current/seats/{seat_id}/price`
|
||||
- `GET /api/v1/schemes/{scheme_id}/test/seats/{seat_id}`
|
||||
|
||||
Frontend rule:
|
||||
|
||||
- empty pricing on a fresh upload is valid
|
||||
- do not treat `categories=[]` and `rules=[]` as backend failure
|
||||
|
||||
## 7. Publish Flow
|
||||
|
||||
Main endpoints:
|
||||
|
||||
- `POST /api/v1/schemes/{scheme_id}/draft/pricing/snapshot`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/publish-readiness`
|
||||
- `GET /api/v1/schemes/{scheme_id}/draft/publish-preview`
|
||||
- `POST /api/v1/schemes/{scheme_id}/publish`
|
||||
|
||||
Frontend sequencing rule:
|
||||
|
||||
1. ensure draft
|
||||
2. mutate if needed
|
||||
3. create/refresh pricing
|
||||
4. build pricing snapshot
|
||||
5. read publish readiness
|
||||
6. read publish preview if UI needs preview surface
|
||||
7. publish
|
||||
|
||||
## 8. Admin/Ops Flow
|
||||
|
||||
Admin-only endpoints:
|
||||
|
||||
- `GET /api/v1/admin/schemes/{scheme_id}/current/artifacts`
|
||||
- `GET /api/v1/admin/schemes/{scheme_id}/current/validation`
|
||||
- `POST /api/v1/admin/schemes/{scheme_id}/current/display/regenerate`
|
||||
- `POST /api/v1/admin/display/backfill`
|
||||
- `GET /api/v1/admin/artifacts/publish-preview/audit`
|
||||
- `POST /api/v1/admin/artifacts/publish-preview/cleanup`
|
||||
- `GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview`
|
||||
- `POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup`
|
||||
|
||||
Healthy publish-preview audit contract:
|
||||
|
||||
- `orphan_files_count = 0`
|
||||
- `missing_files_for_db_rows_count = 0`
|
||||
- `db_rows_count == disk_files_count`
|
||||
|
||||
Frontend implication:
|
||||
|
||||
- admin tools must not be shown as generally available functionality
|
||||
- admin cleanup/destructive flows must be role-gated on the client and still handle backend `403`
|
||||
|
||||
## 9. Typed Error Catalog
|
||||
|
||||
### Auth
|
||||
|
||||
- `401` string detail: `Missing API key`
|
||||
- `403` string detail: `Invalid API key`
|
||||
- `403` string detail: `Admin role required`
|
||||
|
||||
### Lifecycle / Draft / Publish
|
||||
|
||||
- `stale_draft_version`
|
||||
- `stale_current_version`
|
||||
- `current_version_inconsistent`
|
||||
- `draft_not_editable`
|
||||
- `publish_not_ready`
|
||||
|
||||
### Editor Uniqueness / References
|
||||
|
||||
- `editor_uniqueness_error`
|
||||
- `editor_reference_error`
|
||||
- `duplicate_seat_id`
|
||||
- `duplicate_seat_id_in_payload`
|
||||
- `duplicate_sector_id`
|
||||
- `duplicate_group_id`
|
||||
- `duplicate_sector_element_id`
|
||||
- `duplicate_group_element_id`
|
||||
- `unknown_sector_id`
|
||||
- `unknown_group_id`
|
||||
- `unknown_sector_ids`
|
||||
- `unknown_group_ids`
|
||||
- `unknown_target_sector_id`
|
||||
- `unknown_target_group_id`
|
||||
- `business_identifier_nullification_forbidden`
|
||||
|
||||
### Pricing / Remap / Test
|
||||
|
||||
- `invalid_amount`
|
||||
- `remap_filter_required`
|
||||
- `test_preview_failed`
|
||||
|
||||
### Validation Report Codes
|
||||
|
||||
These appear inside validation report payloads rather than as top-level HTTP conflict codes:
|
||||
|
||||
- `duplicate_seat_ids`
|
||||
- `missing_seat_contract`
|
||||
- `seats_without_sector_or_group`
|
||||
- `seats_without_price`
|
||||
|
||||
Frontend rule:
|
||||
|
||||
- do not parse only HTTP status
|
||||
- always inspect structured `detail.code` when `detail` is an object
|
||||
|
||||
## 10. Frontend Obligations
|
||||
|
||||
- always handle auth failures `401` and `403`
|
||||
- always handle stale/conflict responses on draft, publish, and lifecycle operations
|
||||
- never treat `*_record_id` as stable cross-version business identity
|
||||
- always prefer business ids:
|
||||
- seat -> `seat_id`, fallback `element_id`
|
||||
- sector -> `sector_id`, fallback `element_id`
|
||||
- group -> `group_id`, fallback `element_id`
|
||||
- re-read current/draft state after:
|
||||
- any `409`
|
||||
- publish
|
||||
- rollback
|
||||
- unpublish
|
||||
- `draft/ensure` returning a newly created draft
|
||||
- do not assume current version remains stable across concurrent operator sessions
|
||||
- do not assume publish-preview artifacts or display artifacts are frontend-owned resources
|
||||
|
||||
## 11. Non-Persistent Assumptions Frontend Must Avoid
|
||||
|
||||
The frontend must not assume that these remain stable forever:
|
||||
|
||||
- `scheme_version_id`
|
||||
- `seat_record_id`
|
||||
- `sector_record_id`
|
||||
- `group_record_id`
|
||||
- artifact `storage_path`
|
||||
- publish-preview cache artifacts
|
||||
|
||||
These are safe to treat as business-stable:
|
||||
|
||||
- `scheme_id`
|
||||
- `version_number` within one scheme
|
||||
- `seat_id` when present
|
||||
- `sector_id` when present
|
||||
- `group_id` when present
|
||||
|
||||
## 12. Known Limitations / Deferred Tech Debt
|
||||
|
||||
- some lifecycle negative contracts still return mixed styles:
|
||||
- typed object conflicts for `409`
|
||||
- plain string details for some `404` and auth cases
|
||||
- validation warnings and error code families are not yet unified into one single global error envelope
|
||||
- admin/ops routes are backend-internal tools, not end-user product APIs
|
||||
- corruption remediation smoke exists only for `publish_preview`, not for every artifact type
|
||||
|
||||
## 13. Regression Baseline Frontend Can Rely On
|
||||
|
||||
The frontend can rely on the following regression-backed flows:
|
||||
|
||||
- fresh upload on clean DB
|
||||
- current/draft/editor read flow
|
||||
- editor mutations and stale draft protection
|
||||
- pricing setup and publish flow
|
||||
- version lifecycle:
|
||||
- publish
|
||||
- ensure draft from published current
|
||||
- rollback
|
||||
- unpublish
|
||||
- admin ops:
|
||||
- audit
|
||||
- cleanup
|
||||
- destructive pricing cleanup for safe fixture categories
|
||||
- full admin permission matrix on implemented admin endpoints
|
||||
- controlled `publish_preview` corruption detection and remediation
|
||||
- negative upload validation
|
||||
- negative auth matrix
|
||||
- negative lifecycle matrix
|
||||
|
||||
## 14. Recommended Frontend Integration Sequence
|
||||
|
||||
For normal editor work:
|
||||
|
||||
1. authenticate
|
||||
2. upload or pick `scheme_id`
|
||||
3. read `editor/context`
|
||||
4. call `draft/ensure` if needed
|
||||
5. read `draft/structure`
|
||||
6. mutate using current `scheme_version_id`
|
||||
7. on `409`, reload editor state before retry
|
||||
8. configure pricing if needed
|
||||
9. create pricing snapshot
|
||||
10. read publish readiness / preview
|
||||
11. publish
|
||||
|
||||
For admin UI:
|
||||
|
||||
1. verify admin role in client auth state
|
||||
2. call admin endpoints
|
||||
3. still handle backend `403`
|
||||
4. treat cleanup and remediation as explicit operator actions, not background automation
|
||||
673
doc/smoke-regression.md
Normal file
673
doc/smoke-regression.md
Normal file
@@ -0,0 +1,673 @@
|
||||
# Smoke regression checklist
|
||||
|
||||
This file is the backend manual regression baseline for svg-service.
|
||||
|
||||
## Preconditions
|
||||
|
||||
- docker compose stack is up
|
||||
- backend responds on port 9020
|
||||
- valid admin API key is available
|
||||
- stable SVG fixture exists in repository, e.g. `sample-contract.svg`
|
||||
|
||||
## Environment
|
||||
|
||||
Use these variables in shell:
|
||||
|
||||
export API_URL="http://127.0.0.1:9020"
|
||||
export API_KEY="admin-local-dev-key"
|
||||
export FIXTURE_SVG_PATH="/home/adminko/svg-service/sample-contract.svg"
|
||||
|
||||
## Active regression contour
|
||||
|
||||
Primary operator regressions:
|
||||
|
||||
- `backend/scripts/smoke_core.sh`
|
||||
- `backend/scripts/smoke_pricing_publish.sh`
|
||||
- `backend/scripts/smoke_version_lifecycle.sh`
|
||||
- `backend/scripts/smoke_lifecycle_negative.sh`
|
||||
- `backend/scripts/smoke_admin_ops.sh`
|
||||
- `backend/scripts/smoke_auth_negative.sh`
|
||||
- `backend/scripts/smoke_authz_admin_all.sh`
|
||||
- `backend/scripts/smoke_artifact_corruption.sh`
|
||||
- `backend/scripts/smoke_upload_negative.sh`
|
||||
- `backend/scripts/smoke_regression.sh`
|
||||
|
||||
Only this set is part of the active backend regression contour.
|
||||
|
||||
The scripts are expected to fail fast on any contract break or unexpected 5xx.
|
||||
|
||||
`smoke_regression.sh` is now an orchestration wrapper:
|
||||
|
||||
- first runs `smoke_core.sh`
|
||||
- then runs `smoke_pricing_publish.sh`
|
||||
- then runs `smoke_version_lifecycle.sh`
|
||||
- then runs `smoke_lifecycle_negative.sh`
|
||||
- then runs `smoke_admin_ops.sh`
|
||||
- then runs `smoke_authz_admin_all.sh`
|
||||
- then runs `smoke_auth_negative.sh`
|
||||
- then runs `smoke_artifact_corruption.sh`
|
||||
- then runs `smoke_upload_negative.sh`
|
||||
- returns non-zero if any scenario fails
|
||||
|
||||
## Standalone/manual scripts
|
||||
|
||||
- `backend/scripts/editor_mutation_regression.sh`
|
||||
- `backend/scripts/cleanup_test_pricing_data.sh`
|
||||
|
||||
These scripts are intentionally not called by `smoke_regression.sh`.
|
||||
|
||||
## Scenario split
|
||||
|
||||
### Core smoke on clean DB
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_core.sh`
|
||||
|
||||
This scenario is designed for a fully clean database.
|
||||
|
||||
It uploads a fresh SVG fixture, resolves the created `scheme_id`, validates current/draft read models, validates empty pricing state, and then runs `editor_mutation_regression.sh` on the same fresh scheme.
|
||||
|
||||
Important:
|
||||
|
||||
- it does not require pre-existing `scheme_id`
|
||||
- it does not require pricing categories or price rules
|
||||
- it does not require publish snapshot or published baseline
|
||||
- empty pricing on a fresh upload is a valid state, not a failure
|
||||
|
||||
### Pricing/publish smoke with fixture setup
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_pricing_publish.sh`
|
||||
|
||||
This scenario also uploads a fresh SVG fixture, then prepares its own pricing fixture before validating pricing and publish flow.
|
||||
|
||||
Important:
|
||||
|
||||
- it creates its own pricing category
|
||||
- it creates its own pricing rule
|
||||
- it intentionally checks both a priced seat and an unpriced seat on the same fresh scheme
|
||||
- it does not rely on historical pricing IDs, rules, or old schemes
|
||||
|
||||
### Version lifecycle smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_version_lifecycle.sh`
|
||||
|
||||
This scenario uploads a fresh SVG, publishes version 1, creates version 2 from published current, mutates the new draft, publishes version 2, rolls back to version 1, and then runs unpublish on the current scheme.
|
||||
|
||||
Important:
|
||||
|
||||
- it validates multi-version lifecycle beyond fresh upload
|
||||
- it checks that `draft/ensure` creates a new draft only after current becomes published
|
||||
- it verifies rollback switches `current_version_number` to the requested target version
|
||||
- it verifies the rolled-back current structure matches the target version semantics, not the later mutated draft
|
||||
- it checks audit trail for `scheme.published`, `scheme.version.created`, `scheme.rolled_back`, and `scheme.unpublished`
|
||||
|
||||
### Lifecycle negative smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_lifecycle_negative.sh`
|
||||
|
||||
This scenario uses fresh disposable scheme data to verify negative lifecycle contracts without leaving the database in a broken state.
|
||||
|
||||
Important:
|
||||
|
||||
- it checks rollback to a nonexistent version
|
||||
- it checks stale current-version guards on `draft/ensure`
|
||||
- it checks stale expected-version guards on `publish`
|
||||
- it creates a temporary `current_version_inconsistent` pointer only inside the scenario and restores it before exit
|
||||
|
||||
### Admin/ops smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_admin_ops.sh`
|
||||
|
||||
This scenario uploads a fresh SVG and prepares its own admin-cleanup fixture inside the scenario before checking current-artifact inspection, validation, publish-preview audit/cleanup, and pricing-category cleanup preview/dry-run.
|
||||
|
||||
Important:
|
||||
|
||||
- it creates its own pricing categories for cleanup preview
|
||||
- it creates its own protected pricing rule so cleanup preview has both deletable and skipped categories
|
||||
- it does not rely on historical orphan artifacts, old schemes, or dirty pricing state
|
||||
- it checks publish-preview cleanup in both dry-run and execute modes
|
||||
- it requires the final publish-preview audit state to be healthy: `orphan_files_count=0` and `missing_files_for_db_rows_count=0`
|
||||
- it executes destructive pricing cleanup only for self-created safe fixture data
|
||||
|
||||
### Admin authz smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_authz_admin_all.sh`
|
||||
|
||||
This scenario uploads a fresh SVG, prepares its own cleanup fixture data, and then checks permission boundaries for admin/operator/viewer on all currently implemented admin endpoints used by the regression contour.
|
||||
|
||||
Important:
|
||||
|
||||
- admin must be allowed on tested admin endpoints
|
||||
- operator and viewer must be denied with controlled 403 responses
|
||||
- the scenario does not rely on historical scheme ids or dirty pricing state
|
||||
- destructive pricing cleanup execution is validated with fresh self-created fixture categories only
|
||||
|
||||
### Artifact corruption smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_artifact_corruption.sh`
|
||||
|
||||
This scenario creates fresh publish-preview artifacts and then simulates two controlled corruption cases only on the artifacts created inside the scenario.
|
||||
|
||||
Important:
|
||||
|
||||
- case A removes a preview file while leaving its DB row in place
|
||||
- case B removes a preview DB row while leaving its file on disk
|
||||
- audit must detect both inconsistencies correctly
|
||||
- cleanup dry-run must stay readable and non-destructive
|
||||
- cleanup execute must remediate the introduced inconsistency
|
||||
- the scenario does not touch historical schemes or unrelated artifact rows/files
|
||||
|
||||
### Auth negative smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_auth_negative.sh`
|
||||
|
||||
This scenario checks the negative auth matrix on a representative route set.
|
||||
|
||||
Important:
|
||||
|
||||
- missing API key must return `401`
|
||||
- invalid API key must return `403`
|
||||
- valid non-admin key must return `403` only on admin-only endpoints
|
||||
- the route set includes protected, editor, pricing, admin, and admin-cleanup endpoints
|
||||
|
||||
### Negative upload smoke
|
||||
|
||||
Use:
|
||||
|
||||
- `backend/scripts/smoke_upload_negative.sh`
|
||||
|
||||
This scenario checks controlled upload failures for invalid inputs.
|
||||
|
||||
Important:
|
||||
|
||||
- empty upload must fail with a controlled 4xx
|
||||
- non-SVG uploads must fail with a controlled 4xx
|
||||
- invalid extension/content-type combinations must fail with a controlled 4xx
|
||||
- oversize upload must fail with a controlled 413 when the configured size limit is exceeded
|
||||
- no negative case is allowed to return 500
|
||||
|
||||
## 1. Health / system
|
||||
|
||||
- GET /healthz -> 200 (smoke uses a bounded retry/wait loop and fails explicitly if the API never becomes ready)
|
||||
- GET /api/v1/ping -> 200
|
||||
- GET /api/v1/db/ping -> 200
|
||||
- GET /api/v1/manifest -> 200
|
||||
|
||||
## 2. Core smoke coverage
|
||||
|
||||
`smoke_core.sh` checks:
|
||||
|
||||
- GET /healthz -> 200
|
||||
- GET /api/v1/ping -> 200
|
||||
- GET /api/v1/db/ping -> 200
|
||||
- GET /api/v1/manifest -> 200
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- GET /api/v1/schemes -> 200 and resolves the fresh `scheme_id`
|
||||
- GET /api/v1/schemes/{scheme_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/versions -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/editor/context -> 200
|
||||
- POST /api/v1/schemes/{scheme_id}/draft/ensure -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/summary -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/structure -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/validation -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/draft/compare-preview -> 200
|
||||
- GET draft entities by record id -> 200
|
||||
- stale `expected_scheme_version_id` conflict -> 409 with typed `stale_draft_version`
|
||||
- GET current sectors/groups/seats -> 200
|
||||
- GET current SVG display meta -> 200
|
||||
- GET pricing bundle -> 200 with empty categories/rules
|
||||
- GET pricing coverage -> 200 with zero priced seats
|
||||
- GET pricing explain/{seat_id} -> 200 with `no_price_rule`
|
||||
- GET pricing rules diagnostics -> 200 with empty state
|
||||
- GET audit -> 200
|
||||
- `backend/scripts/editor_mutation_regression.sh` on the same fresh scheme
|
||||
|
||||
Validate:
|
||||
|
||||
- fresh upload is readable immediately through current/draft/editor endpoints
|
||||
- empty pricing is accepted as normal state for a newly uploaded scheme
|
||||
- no endpoint in core smoke returns 500
|
||||
|
||||
## 3. Pricing/publish smoke coverage
|
||||
|
||||
`smoke_pricing_publish.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- GET current / POST draft ensure on the fresh scheme -> 200
|
||||
- POST pricing category -> 200
|
||||
- POST price rule -> 200
|
||||
- GET pricing bundle -> 200 with created fixture data
|
||||
- GET pricing coverage -> 200 with both priced and unpriced seats present
|
||||
- GET pricing explain/{priced_seat_id} -> 200 with matched rule
|
||||
- GET pricing explain/{unpriced_seat_id} -> 200 with `no_price_rule`
|
||||
- GET current/seats/{priced_seat_id}/price -> 200
|
||||
- GET test/seats/{priced_seat_id} -> 200
|
||||
- GET test/seats/{unpriced_seat_id} -> 200
|
||||
- POST draft/pricing/snapshot -> 200
|
||||
- GET draft/publish-readiness -> 200
|
||||
- GET draft/publish-preview?refresh=true -> 200
|
||||
- GET draft/publish-preview -> 200
|
||||
- POST publish -> 200
|
||||
- GET scheme detail/current after publish -> 200 and published state
|
||||
- GET audit -> 200 and contains `scheme.published`
|
||||
|
||||
Validate:
|
||||
|
||||
- fixture setup is fully self-contained
|
||||
- priced-seat checks happen only after explicit pricing fixture creation
|
||||
- publish flow is validated on a fresh scheme, not on historical DB data
|
||||
|
||||
## 4. Version lifecycle smoke coverage
|
||||
|
||||
`smoke_version_lifecycle.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- GET scheme detail/current immediately after upload -> version 1 draft
|
||||
- POST draft ensure on version 1 -> 200 and remains same draft
|
||||
- POST pricing category/rule fixture -> 200
|
||||
- POST draft/pricing/snapshot on version 1 -> 200
|
||||
- POST publish on version 1 -> 200
|
||||
- POST draft ensure from published current -> 200 and creates version 2
|
||||
- PATCH one draft seat field on version 2 -> 200
|
||||
- GET draft compare-preview on version 2 -> 200 and shows changed state
|
||||
- POST draft/pricing/snapshot on version 2 -> 200
|
||||
- POST publish on version 2 -> 200
|
||||
- POST rollback to version 1 -> 200
|
||||
- POST unpublish current -> 200
|
||||
- GET audit -> 200 with lifecycle events present
|
||||
|
||||
Validate:
|
||||
|
||||
- version numbering advances from 1 to 2 only when current was published
|
||||
- current pointer tracks the published version before rollback
|
||||
- rollback switches current pointer back to the requested target version
|
||||
- rolled-back current structure matches version 1 semantics after version 2 mutation
|
||||
- lifecycle audit events are present and JSON-serializable
|
||||
|
||||
## 5. Lifecycle negative smoke coverage
|
||||
|
||||
`smoke_lifecycle_negative.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- GET current on the fresh scheme -> 200
|
||||
- POST rollback with nonexistent `target_version_number` -> controlled 404
|
||||
- POST draft/ensure with stale `expected_current_scheme_version_id` -> typed 409
|
||||
- POST publish with stale `expected_scheme_version_id` -> typed 409
|
||||
- GET current after temporary `current_version_inconsistent` pointer corruption -> typed 409
|
||||
- GET current again after scenario restoration -> 200
|
||||
|
||||
Validate:
|
||||
|
||||
- rollback to missing version stays controlled and non-500
|
||||
- ensure-draft stale current pointer returns typed `stale_current_version`
|
||||
- publish stale expected version stays controlled and non-500
|
||||
- temporary pointer inconsistency returns typed `current_version_inconsistent`
|
||||
- the temporary inconsistency is restored before the scenario exits
|
||||
## 6. Admin/ops smoke coverage
|
||||
|
||||
`smoke_admin_ops.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- POST draft ensure on the fresh scheme -> 200
|
||||
- POST pricing category fixture for cleanup preview -> 200
|
||||
- POST protected pricing rule fixture -> 200
|
||||
- POST draft/pricing/snapshot -> 200
|
||||
- GET draft/publish-preview?refresh=true -> 200
|
||||
- GET draft/publish-preview -> 200
|
||||
- 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
|
||||
- POST /api/v1/admin/artifacts/publish-preview/cleanup?dry_run=false -> 200
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit after cleanup -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview -> 200
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=true -> 200
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=false -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing after destructive cleanup -> 200
|
||||
- repeated cleanup preview/dry-run after destructive cleanup -> 200
|
||||
|
||||
Validate:
|
||||
|
||||
- admin artifact listing stays readable for current draft version
|
||||
- admin validation stays readable for current draft version
|
||||
- publish-preview cleanup dry-run stays non-destructive and mirrors pre-clean audit counts
|
||||
- publish-preview cleanup execute removes all orphan preview files and missing DB rows
|
||||
- final publish-preview audit is strict healthy state: `orphan_files_count=0`, `missing_files_for_db_rows_count=0`, and `db_rows_count == disk_files_count`
|
||||
- pricing cleanup preview identifies both deletable and protected categories created inside the scenario
|
||||
- pricing cleanup dry-run never mutates fixture data
|
||||
- destructive pricing cleanup deletes only the safe category without rules
|
||||
- protected pricing category and its rule remain after destructive cleanup
|
||||
- repeated cleanup state remains stable after destructive cleanup
|
||||
|
||||
## 7. Admin authz smoke coverage
|
||||
|
||||
`smoke_authz_admin_all.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- POST draft ensure on the fresh scheme -> 200
|
||||
- POST pricing fixture categories/rule for cleanup authz checks -> 200
|
||||
- POST draft/publish-preview refresh fixture -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/current/artifacts as admin -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/current/artifacts as operator/viewer -> 403
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/current/validation as admin -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/current/validation as operator/viewer -> 403
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/current/display/regenerate as admin -> 200
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/current/display/regenerate as operator/viewer -> 403
|
||||
- POST /api/v1/admin/display/backfill as admin -> 200
|
||||
- POST /api/v1/admin/display/backfill as operator/viewer -> 403
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit as admin -> 200
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit as operator/viewer -> 403
|
||||
- POST /api/v1/admin/artifacts/publish-preview/cleanup?dry_run=true as admin -> 200
|
||||
- POST /api/v1/admin/artifacts/publish-preview/cleanup?dry_run=true as operator/viewer -> 403
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview as admin -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview as operator/viewer -> 403
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=true as admin -> 200
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=true as operator/viewer -> 403
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=false as operator/viewer -> 403
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=false as admin -> 200
|
||||
|
||||
Validate:
|
||||
|
||||
- expected role matrix is explicit and enforced
|
||||
- admin endpoints stay available to admin
|
||||
- operator and viewer are denied without 500
|
||||
- destructive cleanup execution remains constrained to self-created safe fixture data
|
||||
|
||||
## 8. Auth negative smoke coverage
|
||||
|
||||
`smoke_auth_negative.sh` checks:
|
||||
|
||||
- GET /api/v1/manifest without API key -> 401
|
||||
- GET /api/v1/manifest with invalid API key -> 403
|
||||
- GET /api/v1/schemes/{scheme_id}/editor/context without API key -> 401
|
||||
- GET /api/v1/schemes/{scheme_id}/editor/context with invalid API key -> 403
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing without API key -> 401
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing with invalid API key -> 403
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit without API key -> 401
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit with invalid API key -> 403
|
||||
- GET /api/v1/admin/artifacts/publish-preview/audit with valid viewer key -> 403
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview without API key -> 401
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview with invalid API key -> 403
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview with valid viewer key -> 403
|
||||
|
||||
Validate:
|
||||
|
||||
- missing key contract is consistently `401`
|
||||
- invalid key contract is consistently `403`
|
||||
- valid non-admin key is denied only on admin-only endpoints
|
||||
|
||||
## 9. Artifact corruption smoke coverage
|
||||
|
||||
`smoke_artifact_corruption.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload -> 200
|
||||
- POST draft ensure on the fresh scheme -> 200
|
||||
- GET initial /api/v1/admin/artifacts/publish-preview/audit -> healthy 200
|
||||
- case A: manually delete fresh preview file while keeping DB row
|
||||
- GET audit after case A -> reports exactly one missing file for DB row
|
||||
- POST cleanup dry_run=true after case A -> 200
|
||||
- POST cleanup dry_run=false after case A -> 200 and deletes the broken DB row
|
||||
- case B: manually delete fresh preview DB row while keeping file
|
||||
- GET audit after case B -> reports exactly one orphan file
|
||||
- POST cleanup dry_run=true after case B -> 200
|
||||
- POST cleanup dry_run=false after case B -> 200 and deletes the orphan file
|
||||
- final audit -> healthy 200
|
||||
|
||||
Validate:
|
||||
|
||||
- audit sees DB-row-without-file and file-without-DB-row separately and correctly
|
||||
- dry-run remains readable and non-destructive in both corruption cases
|
||||
- execute cleanup remediates only the inconsistency introduced in the scenario
|
||||
- final audit is healthy again: `orphan_files_count=0`, `missing_files_for_db_rows_count=0`
|
||||
|
||||
## 10. Negative upload smoke coverage
|
||||
|
||||
`smoke_upload_negative.sh` checks:
|
||||
|
||||
- POST /api/v1/schemes/upload with empty SVG body -> controlled 400
|
||||
- POST /api/v1/schemes/upload with non-SVG text/plain body -> controlled 400
|
||||
- POST /api/v1/schemes/upload with SVG body but invalid extension/content-type pair -> controlled 400
|
||||
- POST /api/v1/schemes/upload with body larger than manifest max_file_size_bytes -> controlled 413
|
||||
|
||||
Validate:
|
||||
|
||||
- upload validation rejects bad inputs with explicit 4xx contracts
|
||||
- configured max file size is read from manifest, not hardcoded in the script
|
||||
- no negative upload case returns 500
|
||||
|
||||
## 11. Legacy endpoint families
|
||||
|
||||
The sections below remain the API baseline by area, but regression execution is now split between clean-DB core smoke and pricing/publish smoke.
|
||||
|
||||
## 5. Scheme registry
|
||||
|
||||
- GET /api/v1/schemes -> 200
|
||||
- GET /api/v1/schemes/{scheme_id} -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/current -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/versions -> 200
|
||||
|
||||
Validate:
|
||||
- scheme_id is stable
|
||||
- current version exists
|
||||
- version list contains current version
|
||||
- status and counts are consistent
|
||||
|
||||
## 6. 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
|
||||
|
||||
## 7. 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
|
||||
|
||||
## 8. 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
|
||||
|
||||
## 9. 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
|
||||
|
||||
Validate:
|
||||
- total counts are non-negative
|
||||
- known sample scheme returns expected object lists
|
||||
- seats contain seat_id / sector_id / group_id contract where applicable
|
||||
|
||||
## 10. 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
|
||||
|
||||
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
|
||||
|
||||
## 11. Pricing read model
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing/coverage -> 200
|
||||
- GET /api/v1/schemes/{scheme_id}/pricing/unpriced-seats -> 200
|
||||
- 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 only after pricing fixture exists
|
||||
- GET /api/v1/schemes/{scheme_id}/test/seats/{seat_id} -> 200 for known seat
|
||||
|
||||
Validate:
|
||||
- fresh clean upload is allowed to have `categories=[]` and `rules=[]`
|
||||
- fresh clean upload is allowed to have zero priced seats and `no_price_rule` explanations
|
||||
- priced seat checks belong to pricing/publish smoke after fixture setup
|
||||
- diagnostics returns stable empty state with zero rules on clean upload
|
||||
- diagnostics returns matched seat visibility after fixture setup
|
||||
- priced test seat amount is serialized as string when pricing exists
|
||||
|
||||
## 12. Draft mutation regression
|
||||
|
||||
Use:
|
||||
- `backend/scripts/editor_mutation_regression.sh`
|
||||
|
||||
This script checks:
|
||||
- create sector
|
||||
- create group
|
||||
- patch seat
|
||||
- bulk seat update
|
||||
- patch sector
|
||||
- patch group
|
||||
- duplicate entity validation paths
|
||||
- stale draft conflict
|
||||
- remap preview validation path
|
||||
- repair references
|
||||
- delete created sector/group
|
||||
- post-mutation read-model consistency
|
||||
|
||||
Validate:
|
||||
- created entities are returned by API
|
||||
- patched draft records are actually changed
|
||||
- bulk update changes persisted fields
|
||||
- duplicate ids return 422
|
||||
- stale expected_scheme_version_id returns typed 409
|
||||
- remap preview without filters returns typed 422
|
||||
- post-mutation summary / validation / compare-preview remain readable and deterministic
|
||||
|
||||
## 13. Draft publish preview
|
||||
|
||||
- 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
|
||||
|
||||
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
|
||||
|
||||
## 14. Publish readiness and publish flow
|
||||
|
||||
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
|
||||
|
||||
## 15. 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
|
||||
- POST /api/v1/admin/artifacts/publish-preview/cleanup?dry_run=false -> 200
|
||||
- GET /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup-preview -> 200
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=true -> 200
|
||||
- POST /api/v1/admin/schemes/{scheme_id}/pricing/categories/cleanup with dry_run=false -> 200
|
||||
|
||||
Validate:
|
||||
- artifact audit does not report orphan files or missing files for DB rows in normal state
|
||||
- healthy publish-preview audit is strict: `orphan_files_count=0` and `missing_files_for_db_rows_count=0`
|
||||
- validation report is readable and deterministic
|
||||
- pricing cleanup preview returns matched candidates and safe_to_delete_count
|
||||
- pricing cleanup dry-run returns deleted_count=0
|
||||
- destructive pricing cleanup deletes only safe fixture categories without rules
|
||||
- admin role is allowed on admin endpoints
|
||||
- operator/viewer are denied with controlled 403 on admin endpoints
|
||||
- idempotent cleanup is valid in both states: `matched_total=0` with `would_delete_count=0`, or `matched_total>0` with `would_delete_count>0`
|
||||
- smoke does not require cleanup dry-run to always find something to delete
|
||||
- admin routes do not produce 500 for healthy scheme state
|
||||
|
||||
## 16. Audit trail
|
||||
|
||||
- GET /api/v1/schemes/{scheme_id}/audit -> 200
|
||||
|
||||
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
|
||||
|
||||
## 17. Fail criteria
|
||||
|
||||
Regression is considered failed if any of the following happen:
|
||||
|
||||
- health or db ping fails
|
||||
- any stable read endpoint returns 500
|
||||
- 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
|
||||
- editor mutation regression returns non-zero exit code
|
||||
- clean upload empty pricing state is treated as a failure
|
||||
- pricing bundle or diagnostics contract changes unexpectedly
|
||||
- admin audit/cleanup endpoints fail on healthy environment
|
||||
- pricing cleanup dry-run mutates data
|
||||
- artifact retention grows without bound for repeated preview refresh on same variant
|
||||
|
||||
## 18. 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
|
||||
- admin cleanup changes
|
||||
- editor mutation changes
|
||||
Reference in New Issue
Block a user