Skip to content

Architecture Review Checklist

Summary

Practical checklist for reviewing SkyCMS changes that affect tenant, publishing, and delivery architecture behavior.

Purpose

Use this checklist when reviewing pull requests or design changes that may affect architecture behavior.

1. Tenant and isolation checks

  1. Tenant resolution still occurs before tenant-dependent services or data access.
  2. New queries remain tenant-safe and follow cross-provider compatibility rules.
  3. Cache keys and storage paths remain tenant-scoped for multi-tenant scenarios.
  4. Cookie and auth scope do not introduce cross-tenant leakage.

2. Delivery mode checks

  1. Route behavior is explicitly classified as static, dynamic, or hybrid.
  2. Cache policy is correct for the route class and response sensitivity.
  3. Protected routes are not accidentally cacheable at public edge layers.
  4. Mode-specific behavior is documented in the relevant profile page.

3. Publishing and lifecycle checks

  1. Publish flow still updates canonical published records correctly.
  2. Static artifact generation and cleanup logic remain consistent with route expectations.
  3. CDN purge and cache invalidation behavior is preserved or intentionally changed.
  4. Failure handling is explicit for partial publish and stale cache scenarios.

4. Middleware and security checks

  1. Middleware ordering changes are evaluated against architecture contracts.
  2. Auth, antiforgery, and rate limiting behavior remain correct for modified endpoints.
  3. Health and setup endpoints remain operationally safe.
  4. Proxy-header and domain handling remain compatible with deployment environments.

5. Operability checks

  1. Logging and diagnostics capture key architecture transitions and errors.
  2. Metrics or traces are available for high-risk architecture paths.
  3. Runbooks are updated when operational behavior changes.
  4. Rollback or mitigation steps are known for architecture-impacting failures.

Failure mode and recovery map

%%{init: {"theme":"base","themeVariables":{"primaryColor":"#eef6ff","primaryTextColor":"#0f172a","primaryBorderColor":"#2563eb","lineColor":"#334155","secondaryColor":"#f8fafc","tertiaryColor":"#ffffff","fontFamily":"Segoe UI, Arial, sans-serif"}}}%%
flowchart TB
  Failure[Architecture-impacting failure] --> Type{Failure type}

  Type --> PublishFail[Publish pipeline failure]
  Type --> CacheStale[Stale cache after publish]
  Type --> TenantMismatch[Tenant resolution mismatch]
  Type --> AuthFailure[Authorization regression]

  PublishFail --> MitigatePublish[Retry publish and verify artifact set]
  CacheStale --> MitigateCache[Targeted CDN purge and cache-header review]
  TenantMismatch --> MitigateTenant[Validate header precedence and tenant mapping]
  AuthFailure --> MitigateAuth[Revalidate policy and role checks]

  MitigatePublish --> Runbook[Runbook and incident notes update]
  MitigateCache --> Runbook
  MitigateTenant --> Runbook
  MitigateAuth --> Runbook

6. Documentation and governance checks

  1. Relevant architecture docs are updated with the same pull request.
  2. ADR updates are added when design intent or constraints change materially.
  3. Decision matrix or profile guidance is updated if route ownership changes.
  4. Reviewer confirms current-state and target-state impact where relevant.