CI: guard against generated frontend api.ts drift #680

New Issue

marcel · 2026-05-27T14:22:01+02:00

marcel commented

2026-05-27 14:22:01 +02:00

Context

Recurring concern across PR #673 and PR #679 (Tobias/DevOps): when a backend model or endpoint changes, frontend/src/lib/generated/api.ts must be regenerated via npm run generate:api. In the import-migration phase work this file has repeatedly been hand-edited (no dev backend available in the isolated worktrees) to match the backend, and the only verification has been manual reading + reviewer cross-checks. There is no CI gate that fails when the committed api.ts drifts from what generate:api would produce.

Why it matters

A silent drift (a hand-edit that doesn't match the real OpenAPI output) ships type lies to the frontend — the exact failure mode that nearly bit #673.

Suggested approach

Add a CI step that regenerates the types and fails on diff. generate:api needs the OpenAPI spec — options:
- Start the backend on the dev profile in CI (heavier), run npm run generate:api, then git diff --exit-code frontend/src/lib/generated/api.ts; or
- Have the backend build emit openapi.json as an artifact, and run openapi-typescript against that file in the frontend job (no running backend needed), then diff.
Prefer the artifact approach if feasible — no live backend in the frontend job.

Out of scope / notes

Not blocking any phase PR — the hand-edits have been reviewer-verified each time. This is hardening so future drift fails loudly.
Surfaced again in #679's review.

## Context Recurring concern across PR #673 and PR #679 (Tobias/DevOps): when a backend model or endpoint changes, `frontend/src/lib/generated/api.ts` must be regenerated via `npm run generate:api`. In the import-migration phase work this file has repeatedly been **hand-edited** (no dev backend available in the isolated worktrees) to match the backend, and the only verification has been manual reading + reviewer cross-checks. There is no CI gate that fails when the committed `api.ts` drifts from what `generate:api` would produce. ## Why it matters A silent drift (a hand-edit that doesn't match the real OpenAPI output) ships type lies to the frontend — the exact failure mode that nearly bit #673. ## Suggested approach - Add a CI step that regenerates the types and fails on diff. `generate:api` needs the OpenAPI spec — options: - Start the backend on the `dev` profile in CI (heavier), run `npm run generate:api`, then `git diff --exit-code frontend/src/lib/generated/api.ts`; or - Have the backend build emit `openapi.json` as an artifact, and run `openapi-typescript` against that file in the frontend job (no running backend needed), then diff. - Prefer the artifact approach if feasible — no live backend in the frontend job. ## Out of scope / notes - Not blocking any phase PR — the hand-edits have been reviewer-verified each time. This is hardening so future drift fails loudly. - Surfaced again in #679's review.

marcel added the P2-medium devops labels 2026-05-27 14:22:36 +02:00

marcel referenced this issue

2026-05-27 14:26:16 +02:00

feat(persons): clean filterable directory + triage UI (Phase 5, #667) #679

marcel referenced this issue

2026-05-27 19:10:11 +02:00

feat(documents): honest handling of undated documents in browse & search (Phase 6, #668) #682

marcel referenced this issue

2026-05-27 19:13:07 +02:00

feat(documents): honest handling of undated documents in browse & search (Phase 6, #668) #682

marcel referenced this issue

2026-05-27 19:13:42 +02:00