204 lines
13 KiB
Markdown
204 lines
13 KiB
Markdown
# Execution Plan: cms-api-foundation
|
|
|
|
## Detailed Analysis Summary
|
|
|
|
### Transformation Scope (Brownfield Only)
|
|
- **Transformation Type**: Architectural and infrastructure change across two repositories. The way Andrea's site is hosted changes from a static deployment (nginx on test, IIS on production) to being served by a CMS host. A new client host appears in the CMS repo.
|
|
- **Primary Changes**:
|
|
- CMS repo: new client project `Api.AndreaSlopFotografie`; prerendered-site mode plus per-client CSP (no module filter: the client csproj decides its modules) in the shared `CmsHost` (`SlpModularCms.Core`); per-site admin theme and admin build; CI builds the admin per client.
|
|
- This repo: the deploy of the site build into `wwwroot/web/` of the CMS host on test, and the web CI that does it.
|
|
- **Related Components**: `SlpModularCms.Core` (CmsHost), `SlpModularCms.Modules.*` (switchable), `SlpModularCms.Api.SlpSoftware` (regression), CMS `frontend/`, CMS Gitea CI/CD, this repo's `web/` build and CI, test host (Pi).
|
|
|
|
### Change Impact Assessment
|
|
- **User-facing changes**: Yes. The admin gets Andrea's look and Dutch default; the public site is served by a different host (URLs and content unchanged).
|
|
- **Structural changes**: Yes. Shared host gains a prerendered-site mode and per-client headers; new client project; deployment layout changes.
|
|
- **Data model changes**: Minimal. A new database for the new host with the existing Identity schema. No schema change to existing modules.
|
|
- **API changes**: No new business endpoints. `/api/v1/System/capabilities` reflects active modules.
|
|
- **NFR impact**: Yes. Security (CSP must not weaken, setup flow exposure, headers), performance (static serving, compression, caching), deployability.
|
|
|
|
### Component Relationships (Brownfield Only)
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
WEB["web/ (this repo)<br/>prerendered site build"]
|
|
WCI["Web CI (this repo)"]
|
|
CORE["SlpModularCms.Core<br/>CmsHost (shared)"]
|
|
CLI["Api.AndreaSlopFotografie<br/>(new client host)"]
|
|
SLP["Api.SlpSoftware<br/>(regression check)"]
|
|
FE["CMS frontend/<br/>admin + themes"]
|
|
CCI["CMS CI/CD (Gitea)"]
|
|
PI["Test host (Pi)<br/>MariaDB + release dir"]
|
|
WEB --> WCI
|
|
WCI --> PI
|
|
CORE --> CLI
|
|
CORE --> SLP
|
|
FE --> CCI
|
|
CLI --> CCI
|
|
CCI --> PI
|
|
classDef changed fill:#FFA726,stroke:#E65100,stroke-width:2px,color:#000;
|
|
classDef newc fill:#4CAF50,stroke:#1B5E20,stroke-width:2px,color:#fff;
|
|
classDef guard fill:#BDBDBD,stroke:#424242,stroke-width:2px,color:#000;
|
|
class WCI,CORE,FE,CCI changed;
|
|
class CLI newc;
|
|
class SLP,WEB,PI guard;
|
|
```
|
|
|
|
Text alternative: The web build goes through the web CI to the test host; the shared CmsHost feeds the new Andrea client and the existing SlpSoftware client; the admin frontend and the client are deployed by the CMS CI to the same host. Orange = changed, green = new, grey = unchanged or regression guard.
|
|
|
|
| Component | Change type | Reason | Priority |
|
|
|---|---|---|---|
|
|
| `SlpModularCms.Core` (CmsHost) | Major | Prerendered mode, per-client CSP policy, hosting parity | Critical |
|
|
| `Api.AndreaSlopFotografie` | New | Andrea's host | Critical |
|
|
| CMS `frontend/` | Minor | Theme selection at build, default language | Important |
|
|
| CMS CI/CD | Minor | Per-client admin build | Important |
|
|
| `Api.SlpSoftware` | None (regression guard) | Must not change behaviour | Critical |
|
|
| Web CI and deploy (this repo) | Minor | Deliver the build to `wwwroot/web/` | Important |
|
|
| `web/` application code | None | Untouched; avoids conflict with Testimonials | n/a |
|
|
|
|
### Risk Assessment
|
|
- **Risk Level**: Medium-High. A shared host is changed (SlpSoftware is in production), the site hosting model changes, and two repositories with two parallel AIDLC workspaces and a parallel session (Testimonials) are involved.
|
|
- **Rollback Complexity**: Easy on test: nginx keeps serving the site until the new route is proven; the CMS deploy uses an atomic release switch.
|
|
- **Testing Complexity**: Complex. Needs the Pi, MariaDB, prerendered output and header checks.
|
|
|
|
## Workflow Visualization
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
Start(["User Request"])
|
|
|
|
subgraph INCEPTION["🔵 INCEPTION PHASE"]
|
|
WD["Workspace Detection<br/><b>COMPLETED</b>"]
|
|
RE["Reverse Engineering<br/><b>SKIP</b>"]
|
|
RA["Requirements Analysis<br/><b>COMPLETED</b>"]
|
|
US["User Stories<br/><b>SKIP</b>"]
|
|
WP["Workflow Planning<br/><b>IN PROGRESS</b>"]
|
|
AD["Application Design<br/><b>EXECUTE</b>"]
|
|
UG["Units Generation<br/><b>EXECUTE</b>"]
|
|
end
|
|
|
|
subgraph CONSTRUCTION["🟢 CONSTRUCTION PHASE"]
|
|
FD["Functional Design<br/><b>EXECUTE (CMS unit)</b>"]
|
|
NFRA["NFR Requirements<br/><b>EXECUTE (CMS unit)</b>"]
|
|
NFRD["NFR Design<br/><b>EXECUTE (CMS unit)</b>"]
|
|
ID["Infrastructure Design<br/><b>EXECUTE</b>"]
|
|
CG["Code Generation<br/>(Planning + Generation)<br/><b>EXECUTE</b>"]
|
|
BT["Build and Test<br/><b>EXECUTE</b>"]
|
|
end
|
|
|
|
subgraph OPERATIONS["🟡 OPERATIONS PHASE"]
|
|
DS["Deployment Setup<br/><b>EXECUTE</b>"]
|
|
MS["Monitoring Setup<br/><b>EXECUTE</b>"]
|
|
PRV["Production Readiness Validation<br/><b>EXECUTE</b>"]
|
|
end
|
|
|
|
Start --> WD
|
|
WD --> RA
|
|
RA --> WP
|
|
WP --> AD
|
|
AD --> UG
|
|
UG --> FD
|
|
FD --> NFRA
|
|
NFRA --> NFRD
|
|
NFRD --> ID
|
|
ID --> CG
|
|
CG --> BT
|
|
BT --> DS
|
|
DS --> MS
|
|
MS --> PRV
|
|
PRV --> End(["Complete"])
|
|
|
|
style WD fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style RA fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style WP fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style CG fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style BT fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style RE fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style US fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style AD fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style UG fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style FD fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style NFRA fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style NFRD fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style ID fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style DS fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style MS fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style PRV fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style Start fill:#CE93D8,stroke:#6A1B9A,stroke-width:3px,color:#000
|
|
style End fill:#CE93D8,stroke:#6A1B9A,stroke-width:3px,color:#000
|
|
style INCEPTION fill:#BBDEFB,stroke:#1565C0,stroke-width:2px
|
|
style CONSTRUCTION fill:#C8E6C9,stroke:#2E7D32,stroke-width:2px
|
|
style OPERATIONS fill:#FFF59D,stroke:#F9A825,stroke-width:2px
|
|
linkStyle default stroke:#333,stroke-width:2px
|
|
```
|
|
|
|
Text alternative: Inception (detection, requirements, planning, application design, units), then Construction (functional design, NFR requirements and design, infrastructure design, code generation, build and test), then Operations (deployment, monitoring, production readiness). Green = done or always, orange dashed = executes conditionally, grey dashed = skipped.
|
|
|
|
## How the two repositories and AIDLC workspaces work together
|
|
|
|
- **This workspace** holds the cross-repo decisions, the briefs to the CMS session, the web-side unit, and the verification of the hand-back.
|
|
- **The CMS repo** has its own AIDLC workspace. For the CMS unit the Construction stages (Functional Design, NFR Requirements, NFR Design, Code Generation, CMS-side Build and Test) are executed **by the CMS session** in that workspace, with a brief from this workspace as input. Here we record the brief, the CMS session's approved design summary and the hand-back in `construction/cms-host/`.
|
|
- **Approvals** (per the collaboration decision): the owner approves the CMS requirements and design; this session answers web-side questions and escalates CMS-internal, security and data-model questions to the owner.
|
|
|
|
## Phases to Execute
|
|
|
|
### 🔵 INCEPTION PHASE
|
|
- [x] Workspace Detection (COMPLETED)
|
|
- [x] Reverse Engineering (SKIPPED)
|
|
- **Rationale**: Team agreement: no full refresh per feature; the CMS repo has its own artifacts.
|
|
- [x] Requirements Analysis (COMPLETED)
|
|
- [x] User Stories (SKIPPED)
|
|
- **Rationale**: One persona (the site administrator) and no user-experience design in this step; acceptance criteria are in the requirements (FR-14). Can be added on request.
|
|
- [x] Execution Plan (IN PROGRESS)
|
|
- [ ] Application Design - EXECUTE (minimal-to-standard depth)
|
|
- **Rationale**: New shared-host components (prerendered-site mode, per-client header policy, theme selection) and a client project need defined responsibilities, plus the deployment layout contract between the two repos. Detailed internal design stays with the CMS session.
|
|
- [ ] Units Planning - SKIP (merged into Units Generation; two units are enough)
|
|
- [ ] Units Generation - EXECUTE
|
|
- **Rationale**: Two units with different owners and an order: U1 CMS host (CMS repo), U2 site delivery (this repo).
|
|
|
|
### 🟢 CONSTRUCTION PHASE
|
|
|
|
Units: **U1 `cms-host`** (CMS repo, built by the CMS session) and **U2 `site-delivery`** (this repo). Order: U1 before U2; the `web/`-adjacent changes in U2 start only when the Testimonials feature has merged or overlap is ruled out.
|
|
|
|
- [ ] Functional Design - EXECUTE for U1, SKIP for U2
|
|
- **Rationale**: U1 has new behaviour (path-to-file resolution, canonical redirects, header policy). U2 is pipeline work with no business logic.
|
|
- [ ] NFR Requirements - EXECUTE for U1, SKIP for U2
|
|
- **Rationale**: Security Baseline applies (CSP, setup exposure, error handling, rate limiting) and PBT framework selection (PBT-09). U2's NFRs are covered by the requirements.
|
|
- [ ] NFR Design - EXECUTE for U1, SKIP for U2
|
|
- **Rationale**: Patterns for header policy per client, fail-closed behaviour and a drift guard for the CSP.
|
|
- [ ] Infrastructure Design - EXECUTE for U1 and U2
|
|
- **Rationale**: Release layout with `wwwroot/web/` outside the swapped directory, per-client admin build in CI, delivery of the site build, database for the new host, ports, and switching off the static nginx site on test.
|
|
- [ ] Code Generation - EXECUTE (ALWAYS), per unit
|
|
- **Rationale**: Implementation and tests (including PBT-02, 03, 07, 08 where applicable).
|
|
- [ ] Build and Test - EXECUTE (ALWAYS)
|
|
- **Rationale**: Cross-unit proof on test (FR-14), SlpSoftware regression, header and 404-status checks.
|
|
|
|
### 🟡 OPERATIONS PHASE
|
|
- [ ] Deployment Setup, Monitoring Setup, Production Readiness Validation - EXECUTE
|
|
- **Rationale**: Operations Configuration = Yes (decided at Requirements Analysis). Scope is test only; production readiness records what remains for production.
|
|
|
|
## Package Change Sequence (Brownfield Only)
|
|
|
|
1. `SlpModularCms.Core` (CmsHost: prerendered mode, per-client header policy, hosting parity) with tests. Critical path.
|
|
2. `Api.AndreaSlopFotografie` client project, appsettings, database. Depends on 1.
|
|
3. CMS `frontend/` theme selection and Andrea's theme. Parallel with 2.
|
|
4. CMS CI/CD: per-client admin build and deploy for the new host. Depends on 2 and 3.
|
|
5. This repo: web CI delivers the site build to the new host on test. Depends on 4.
|
|
6. Proof on test, then switch off the static test site.
|
|
|
|
## Module Update Strategy
|
|
- **Update Approach**: Sequential for the critical path (1, 2, 4, 5), parallel for the theme work (3).
|
|
- **Critical Path**: Core host changes block everything else.
|
|
- **Coordination Points**: The reserved paths and `wwwroot/web/` contract, the 404 page location, the CSP values, the admin build per client in CI.
|
|
- **Testing Checkpoints**: After step 1 (SlpSoftware regression, unit and integration tests), after step 4 (deployed admin and `/health`), after step 5 (FR-14 proof).
|
|
|
|
## Estimated Timeline
|
|
- **Total Phases**: 3 (Inception, Construction, Operations).
|
|
- **Estimated Duration**: Roughly 4 to 6 working sessions across both workspaces, depending on CMS CI complexity and the test host.
|
|
|
|
## Success Criteria
|
|
- **Primary Goal**: Andrea's site and a themed Dutch admin run from one CMS host on test, with `Offerings` off and the existing SlpSoftware host unaffected.
|
|
- **Key Deliverables**: `Api.AndreaSlopFotografie` (with only the needed module references); prerendered-site mode; per-client CSP; per-site admin theme and build; web delivery pipeline; updated CMS docs; briefs and hand-back records.
|
|
- **Quality Gates**: Security Baseline compliance (blocking), PBT partial rules, SlpSoftware regression tests green, FR-14 proof on test, site Lighthouse not lower than on nginx.
|
|
- **Integration Testing**: Site, admin and API served together from one host on test.
|
|
- **Operational Readiness**: Logging, health and alerting for the new host per the Operations phase.
|