generated from john/python-template
Compare commits
11
Commits
6b5b0500b3
..
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cf5d7d8c7b | ||
|
|
939b0e46e9 | ||
|
|
15af11ecb5 | ||
|
|
6dc58a8d50 | ||
|
|
e90dbe4958 | ||
|
|
c9682b0399 | ||
|
|
dd80cd60cf | ||
|
|
754a273ead | ||
|
|
06bb4290be | ||
|
|
21478a904c | ||
|
|
b94d5d2863 |
@@ -1,13 +0,0 @@
|
|||||||
.git
|
|
||||||
.gitignore
|
|
||||||
.vscode
|
|
||||||
.venv
|
|
||||||
.pytest_cache
|
|
||||||
.ruff_cache
|
|
||||||
__pycache__/
|
|
||||||
*.py[cod]
|
|
||||||
*.db
|
|
||||||
.env
|
|
||||||
tests/
|
|
||||||
docs/
|
|
||||||
uploads/
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
---
|
|
||||||
description: Follow these guidelines when editing the services
|
|
||||||
applyTo: 'src/transcription/services/*.py'
|
|
||||||
---
|
|
||||||
|
|
||||||
# Services
|
|
||||||
|
|
||||||
## Structure
|
|
||||||
|
|
||||||
- Project core data models defined in [models](../../src/transcription/models.py)
|
|
||||||
- 1 service class per data model
|
|
||||||
- Only services directly interact with the database, and only through async methods
|
|
||||||
- Services are completely independent of one another. Any operation that needs to use more than a single service, which is most of them, needs to have a separate orchestration function.
|
|
||||||
|
|
||||||
## Error Handling
|
|
||||||
|
|
||||||
- Service-specific errors defined at the top of the respective module and inherit from `AppError`
|
|
||||||
- Use a context manager for large `try/except` blocks like in [transcription](../../src/transcription/services/transcription.py)
|
|
||||||
|
|
||||||
## Checklist
|
|
||||||
|
|
||||||
- [ ] Uses `ServiceBase` for common logic
|
|
||||||
- [ ] CRUD methods created at the top
|
|
||||||
- [ ] Session kwarg for `AsyncSession` to pass in a session object to each method
|
|
||||||
- [ ] Services use `self._session_scope` in their methods to pass the session thru.
|
|
||||||
- Multiple operations on the same object(s) require sharing a session between all the methods used.
|
|
||||||
|
|
||||||
## CRUD Methods
|
|
||||||
|
|
||||||
- Create, read, update, and delete, created in that order
|
|
||||||
- Name format `<operation>_<model >`, for example `create_document` or `update_job`
|
|
||||||
- All services must define these 4 methods first, and in that order
|
|
||||||
|
|
||||||
## Transaction Finalization
|
|
||||||
|
|
||||||
When a service method accepts an optional `session` kwarg, write methods must use `self._finalize` to finalize the transaction properly according to whether or not they are sharing a session.
|
|
||||||
|
|
||||||
- If `session` is `None`: the method owns the transaction and should `commit()`.
|
|
||||||
- If `session` is provided: the method must **not** commit; it should `flush()` so IDs and FK values are available to the caller's transaction.
|
|
||||||
- Use `refresh()` on returned ORM objects when the caller needs DB-populated values (defaults, triggers, merged state).
|
|
||||||
|
|
||||||
Recommended helper behavior:
|
|
||||||
|
|
||||||
- Inputs: active session object, original `session` arg (or a boolean ownership flag), and an optional list of objects to refresh.
|
|
||||||
- Logic: `commit` when service-owned session, `flush` when caller-owned session, then refresh requested objects.
|
|
||||||
|
|
||||||
This keeps orchestration functions atomic: they can pass one shared session across multiple services and commit exactly once at the workflow boundary.
|
|
||||||
|
|
||||||
## Workflow Transaction Boundaries
|
|
||||||
|
|
||||||
For multi-step job lifecycles (for example queued transcription jobs), orchestration functions must use explicit transaction phases.
|
|
||||||
|
|
||||||
Required boundary model:
|
|
||||||
|
|
||||||
- **Transaction A (claim):** transition `JobStatus.QUEUED -> JobStatus.PROCESSING` and commit immediately.
|
|
||||||
- Perform provider/network work **outside** database transactions.
|
|
||||||
- **Transaction B (terminal success):** write transcript content and set `JobStatus.TRANSCRIBED` in the same shared-session commit.
|
|
||||||
- **Transaction B (terminal failure):** write transcript error detail and set `JobStatus.FAILED` in the same shared-session commit.
|
|
||||||
- **Transaction C (retry path):** write transcript error detail, increment retry count, and set `JobStatus.QUEUED` in one shared-session commit.
|
|
||||||
|
|
||||||
Atomicity rules:
|
|
||||||
|
|
||||||
- Never commit transcript updates separately from the paired terminal/retry job status change.
|
|
||||||
- Terminal state (`TRANSCRIBED` or `FAILED`) and transcript row changes must succeed or roll back together.
|
|
||||||
- Retry persistence (`QUEUED` + retry increment + error detail) must succeed or roll back together.
|
|
||||||
|
|
||||||
Separation of concerns:
|
|
||||||
|
|
||||||
- Worker modules should stay lightweight and delegate lifecycle transitions to service/workflow orchestration functions.
|
|
||||||
- In `workflows.py`, `process_queued_job` should own one complete attempt lifecycle: `QUEUED -> PROCESSING -> TRANSCRIBED|FAILED`.
|
|
||||||
- In `workflows.py`, `advance_job` should coordinate broader status progression around attempts (for example retry scheduling from `FAILED -> QUEUED`).
|
|
||||||
- Services should expose session-aware write helpers (flush on caller-owned session) so orchestration controls commit boundaries.
|
|
||||||
- Backoff/sleep behavior must run outside transactional scopes.
|
|
||||||
|
|
||||||
# Service Composition
|
|
||||||
|
|
||||||
Some operations, like uploading a picutre, require modifications to multiple tables, which can be done by composing methods from the service object into a separate function.
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
description: Copilot rules for modifying the UI
|
|
||||||
applyTo: 'src/transcription/ui/**/*.py'
|
|
||||||
---
|
|
||||||
|
|
||||||
The UI is forbidden from directly touching the database. All interactions should be done using the [services](../../src/transcription/services/)
|
|
||||||
@@ -14,6 +14,3 @@ wheels/
|
|||||||
|
|
||||||
# SQLite database
|
# SQLite database
|
||||||
*.db
|
*.db
|
||||||
|
|
||||||
# Document images
|
|
||||||
uploads/*
|
|
||||||
|
|||||||
Vendored
-27
@@ -1,27 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "Python: Debug transcription app",
|
|
||||||
"type": "debugpy",
|
|
||||||
"request": "launch",
|
|
||||||
"module": "debugpy",
|
|
||||||
"args": [
|
|
||||||
"-m",
|
|
||||||
"uvicorn",
|
|
||||||
"transcription.app:create_app",
|
|
||||||
"--factory",
|
|
||||||
"--host",
|
|
||||||
// "127.0.0.1",
|
|
||||||
"0.0.0.0",
|
|
||||||
"--port",
|
|
||||||
"8080"
|
|
||||||
],
|
|
||||||
"justMyCode": true,
|
|
||||||
"console": "integratedTerminal",
|
|
||||||
"env": {
|
|
||||||
"PYTHONPATH": "${workspaceFolder}/src"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
-47
@@ -1,47 +0,0 @@
|
|||||||
FROM python:3.12-slim AS builder
|
|
||||||
|
|
||||||
ENV PYTHONDONTWRITEBYTECODE=1 \
|
|
||||||
PYTHONUNBUFFERED=1 \
|
|
||||||
UV_LINK_MODE=copy
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
COPY --from=ghcr.io/astral-sh/uv:0.5.24 /uv /uvx /bin/
|
|
||||||
|
|
||||||
COPY pyproject.toml uv.lock README.md ./
|
|
||||||
RUN uv sync --frozen --no-dev --no-install-project
|
|
||||||
|
|
||||||
COPY src ./src
|
|
||||||
COPY prompts ./prompts
|
|
||||||
RUN uv sync --frozen --no-dev
|
|
||||||
|
|
||||||
|
|
||||||
FROM python:3.12-slim AS runtime
|
|
||||||
|
|
||||||
ENV PYTHONDONTWRITEBYTECODE=1 \
|
|
||||||
PYTHONUNBUFFERED=1 \
|
|
||||||
PATH="/app/.venv/bin:$PATH" \
|
|
||||||
PYTHONPATH="/app/src" \
|
|
||||||
UPLOAD_DIR="/app/uploads" \
|
|
||||||
PROMPT_DIR="/app/prompts"
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
RUN groupadd --system --gid 1001 appgroup \
|
|
||||||
&& useradd --system --uid 1001 --gid appgroup --create-home appuser
|
|
||||||
|
|
||||||
COPY --from=builder /app/.venv /app/.venv
|
|
||||||
COPY --from=builder /app/src /app/src
|
|
||||||
COPY --from=builder /app/prompts /app/prompts
|
|
||||||
|
|
||||||
RUN mkdir -p /app/uploads /app/data \
|
|
||||||
&& chown -R appuser:appgroup /app
|
|
||||||
|
|
||||||
USER appuser
|
|
||||||
|
|
||||||
EXPOSE 8000
|
|
||||||
|
|
||||||
HEALTHCHECK --interval=30s --timeout=3s --start-period=3s --retries=3 \
|
|
||||||
CMD python -c "import urllib.request; urllib.request.urlopen('http://localhost:8000/healthz')"
|
|
||||||
|
|
||||||
CMD ["uvicorn", "transcription.app:create_app", "--factory", "--host", "0.0.0.0", "--port", "8000", "--proxy-headers"]
|
|
||||||
@@ -34,25 +34,62 @@ Optional settings (defaults shown):
|
|||||||
DATABASE_URL=sqlite:///./transcription.db
|
DATABASE_URL=sqlite:///./transcription.db
|
||||||
UPLOAD_DIR=./uploads
|
UPLOAD_DIR=./uploads
|
||||||
PROMPT_DIR=./prompts
|
PROMPT_DIR=./prompts
|
||||||
WORKER_MAX_RETRIES=0
|
MAX_UPLOAD_BYTES=15728640
|
||||||
WORKER_RETRY_BACKOFF_SECONDS=0
|
OPERATOR_ACCESS_ENABLED=false
|
||||||
WORKER_PROVIDER_TIMEOUT_SECONDS=20
|
OPERATOR_USERNAME=operator
|
||||||
WORKER_MIN_TRANSCRIPTION_CHARS=0
|
# OPERATOR_PASSWORD=replace_with_secure_value
|
||||||
WORKER_MIN_TRANSCRIPTION_LINES=0
|
|
||||||
WORKER_FAIL_ON_FINISH_REASON_LENGTH=false
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### 3) Run the app
|
### 3) Run the app
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv run uvicorn transcription.app:create_app --factory --reload
|
uv run uvicorn transcription.app:create_app --factory --reload
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4) Open in browser
|
### 4) (Optional) Run explicit migrations/checks
|
||||||
|
|
||||||
|
Use the migration runner for Step 4 schema safety workflows:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run python -m transcription.migration_runner --list
|
||||||
|
uv run python -m transcription.migration_runner --apply
|
||||||
|
uv run python -m transcription.migration_runner --check
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5) Open in browser
|
||||||
|
|
||||||
|
|
||||||
- GUI: [http://[IP_ADDRESS]:8000/ui](http://[IP_ADDRESS]:8000/ui)
|
- GUI: [http://[IP_ADDRESS]:8000/ui](http://[IP_ADDRESS]:8000/ui)
|
||||||
- Health check: [http://[IP_ADDRESS]:8000/healthz](http://[IP_ADDRESS]:8000/healthz)
|
- Health check: [http://[IP_ADDRESS]:8000/healthz](http://[IP_ADDRESS]:8000/healthz)
|
||||||
|
|
||||||
|
### Schema safety settings
|
||||||
|
|
||||||
|
Optional environment settings (defaults shown):
|
||||||
|
|
||||||
|
```env
|
||||||
|
MIGRATION_AUTO_APPLY_ON_STARTUP=false
|
||||||
|
VALIDATE_SCHEMA_ON_STARTUP=true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 5 security settings
|
||||||
|
|
||||||
|
Use this baseline for trusted private-network operation:
|
||||||
|
|
||||||
|
```env
|
||||||
|
OPERATOR_ACCESS_ENABLED=true
|
||||||
|
OPERATOR_USERNAME=operator
|
||||||
|
OPERATOR_PASSWORD=replace_with_strong_local_secret
|
||||||
|
MAX_UPLOAD_BYTES=15728640
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- `/healthz` remains unauthenticated for operational checks.
|
||||||
|
- `/ui` and `/api` require HTTP Basic credentials when operator access is enabled.
|
||||||
|
- Keep `OPERATOR_PASSWORD` in environment variables only (never commit secrets).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## How to navigate the GUI
|
## How to navigate the GUI
|
||||||
|
|
||||||
- **Upload page** (`/ui`)
|
- **Upload page** (`/ui`)
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
services:
|
|
||||||
transcription:
|
|
||||||
build:
|
|
||||||
context: .
|
|
||||||
dockerfile: Dockerfile
|
|
||||||
container_name: transcription-app
|
|
||||||
env_file:
|
|
||||||
- .env
|
|
||||||
environment:
|
|
||||||
DATABASE_URL: sqlite:////app/data/transcription.db
|
|
||||||
UPLOAD_DIR: /app/uploads
|
|
||||||
PROMPT_DIR: /app/prompts
|
|
||||||
ports:
|
|
||||||
- "8002:8000"
|
|
||||||
volumes:
|
|
||||||
- ./uploads:/app/uploads
|
|
||||||
- transcription_data:/app/data
|
|
||||||
restart: unless-stopped
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
transcription_data:
|
|
||||||
+24
-8
@@ -1,24 +1,40 @@
|
|||||||
# Historical Document Transcription Design Intent
|
# Historical Document Transcription
|
||||||
I have several thousand pages of family history told through letters, postcards, books, and other documents that I want to transcribe to text.
|
I have several thousand pages of family history told through letters, postcards, books, and other documents that I want to transcribe to text.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Goals
|
## Goals
|
||||||
1. Preserve our family history
|
1. Preserve our family history
|
||||||
2. Unburden my family (and descendants) from having to store and care for the physical media. Once the documents have been transcribed and organized, they can be donated (or kept by a family member that wants to retain them).
|
2. Unburden my family (and descendants) from having to store and care for the physical media. Once the documents have been transcribed and organized, they can be donated (or kept by a family member that wants to retain them).
|
||||||
3. Make the text easily available and searchable by family members, as well as AI (which may have different requirements).
|
3. Make the text easily available and searchable by family members, as well as AI (which may have different requirements).
|
||||||
4. Ability create timelines or assemble the historical record of the family or specific individuals from across the complete document archive. Perhaps use AI to create the timelines in a more narrative form.
|
4. Ability create timelines or assemble the historical record of the family or specific individuals from across the complete document archive. Perhaps use AI to create the timelines in a more narrative form.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Source material
|
## Source material
|
||||||
1. **letters, cards, diaries** - handwritten; mostly stored in tubs, with little organization
|
1. **letters, cards, diaries** - handwritten; mostly stored in tubs, with little organization
|
||||||
2. **books** - typed or typeset; mostly self-published books 50-100 pages in length. This may be expanded to include selected pages from other publications.
|
2. **books** - typed or typeset; mostly self-published books 50-100 pages in length. This may be expanded to include selected pages from other publications.
|
||||||
3. **newspaper clippings, event programs, invitations, and other ephemera**
|
3. **newspaper clippings, event programs, invitations, and other ephemera**
|
||||||
|
|
||||||
---
|
## Methodology
|
||||||
|
### Verbatim vs. Clean Copy
|
||||||
|
Transcriptions should be Verbatim and follow scholarly research guidelines, with no modifications to the original text.
|
||||||
|
|
||||||
## Methodology
|
### Prompt Curation Policy
|
||||||
|
Transcription behavior should be implemented with prompt assets that are human-maintainable over time.
|
||||||
|
|
||||||
1. Follow current best practices per "A Guide to Documentary Editing" by Mary-Jo Kline. (See [Transcription Methodology](transcription_methodology.md))
|
1. Each transcription prompt is stored as an individual Markdown file.
|
||||||
|
2. Prompt files are refined iteratively as document quality and edge cases are discovered.
|
||||||
|
3. Prompt changes should be scoped to one prompt file at a time whenever possible to keep review history clear.
|
||||||
|
|
||||||
|
### Potential Document Issues
|
||||||
|
| Document Issue | How to Handle It | Example |
|
||||||
|
| :--- | :--- | :--- |
|
||||||
|
| **Misspellings & Errors** | Retain original spelling and insert italicized `[sic]` directly after the error. | `The weather was very cold and publick [sic] business delayed.` |
|
||||||
|
| **Missing Words / Slips** | Insert the missing word inside square brackets to restore basic readability. | `We went [to] the store to buy supplies.` |
|
||||||
|
| **Uncertain / Guesswork** | Place your best hypothesis followed by a question mark inside square brackets. | `He went to [Boston?] yesterday to meet the governor.` |
|
||||||
|
| **Completely Illegible** | Use a clear descriptive term like `[illegible]` or specify the reason (e.g., `[torn]`, `[ink blot]`). | `The total cost was [illegible] dollars.` or `The letter ends here [remainder of page torn].` |
|
||||||
|
| **Crossed-out Text** | Wrap the removed word or phrase in a deleted tag to preserve the author's edits. | `We left at [deleted: noon] one o'clock instead.` |
|
||||||
|
| **Squeezed-in Text** | Wrap text that was added above the line or in a tight space in an inserted tag. | `The [inserted: red] house on the hill was abandoned.` |
|
||||||
|
| **Superscripts & Abbreviations** | Bring raised letters down to the main line, or optionally expand them in brackets. | `Change Gen^l to Genl` OR `Change to Gen[era]l depending on project preference.` |
|
||||||
|
| **Images / Seals / Signs** | Describe the non-textual element using italicized text inside square brackets. | `[wax notary seal attached here]` or `[sketch of a fort layout]` |
|
||||||
|
| **Marginalia / Notes** | Note the spatial transition clearly before transcribing the note itself. | `[written in left margin:] Do not share this with anyone.` |
|
||||||
|
| **Line Breaks / Hyphens** | Rejoin words split across a page margin silently, dropping the line-break hyphen. | `Original: "estab- / lishment" becomes "establishment"` |
|
||||||
|
| **Ambiguous Capitalization** | Default to modern capitalization rules unless an archaic uppercase letter is clearly intentional. | `If a standard noun like 'Farm' looks randomly capitalized, type 'farm'.` |
|
||||||
|
**Hierarchical Outlines** | Preserve exact numbering characters (including lowercase Roman numerals or terminal 'j'). Replicate indentation levels using spaces/tabs. Do not correct math or sequence errors silently. | `I. Main Topic`<br>` a. Sub-point`<br>` b. Next point`<br>`III. [sic] Third Topic` |
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# ADR-0001: Lifespan-owned runtime resources
|
||||||
|
|
||||||
|
- **Status:** accepted
|
||||||
|
- **Date:** 2026-06-25
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
MVP initialized core runtime resources (database engine and worker dependencies) through module-level globals and startup side effects. `REQ-7` requires lifespan-owned runtime resources with explicit ownership and cleanup.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Adopt lifespan-owned runtime resource initialization in `transcription.app`:
|
||||||
|
|
||||||
|
1. Initialize database runtime during app lifespan startup.
|
||||||
|
2. Store runtime handles on `app.state`.
|
||||||
|
3. Pass runtime-owned dependencies (engine) to worker startup.
|
||||||
|
4. Dispose runtime resources explicitly during lifespan shutdown.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
### Positive
|
||||||
|
- Explicit startup and shutdown ownership.
|
||||||
|
- Predictable cleanup ordering.
|
||||||
|
- Reduced hidden global side effects.
|
||||||
|
|
||||||
|
### Tradeoffs
|
||||||
|
- Minor wiring complexity in app startup.
|
||||||
|
- Some call-sites still support fallback lazy initialization for compatibility.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
1. **Keep module-level global ownership**
|
||||||
|
- Rejected: conflicts with `REQ-7` and increases ambiguity.
|
||||||
|
2. **Introduce full async DB stack immediately**
|
||||||
|
- Rejected for Step 1: too broad for architecture-consolidation scope.
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
# ADR-0002: Explicit schema bootstrap policy
|
||||||
|
|
||||||
|
- **Status:** accepted
|
||||||
|
- **Date:** 2026-06-25
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
MVP called schema bootstrap (`create_all`) on every startup. `REQ-10` requires explicit, opt-in schema bootstrap behavior so normal production startup does not mutate schema.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Add environment-aware bootstrap policy:
|
||||||
|
|
||||||
|
1. New settings:
|
||||||
|
- `environment`: `development` | `test` | `production`
|
||||||
|
- `bootstrap_schema_on_startup`: optional explicit override
|
||||||
|
2. Default behavior:
|
||||||
|
- Development/test: bootstrap enabled
|
||||||
|
- Production: bootstrap disabled
|
||||||
|
3. App startup calls `create_all` only when policy evaluates true.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
### Positive
|
||||||
|
- Production startup behavior is safer and policy-driven.
|
||||||
|
- Local development remains simple by default.
|
||||||
|
|
||||||
|
### Tradeoffs
|
||||||
|
- Deployments now require explicit schema management in production.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
1. **Always bootstrap in all environments**
|
||||||
|
- Rejected: violates `REQ-10` intent.
|
||||||
|
2. **Disable bootstrap everywhere immediately**
|
||||||
|
- Rejected: hurts local developer workflow without migration tool replacement yet.
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# ADR-0003: Persistence baseline and transition path
|
||||||
|
|
||||||
|
- **Status:** accepted
|
||||||
|
- **Date:** 2026-06-25
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Architecture targets PostgreSQL baseline (optional MongoDB), while MVP currently runs on SQLite by default. V1 needs a clear transition path without destabilizing ongoing work.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
1. Preserve database URL configurability through centralized settings.
|
||||||
|
2. Keep SQLite functional for local dev/test and fast feedback.
|
||||||
|
3. Treat PostgreSQL as production baseline target for V1 completion.
|
||||||
|
4. Keep persistence access behind `transcription.db` runtime/session access points.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
### Positive
|
||||||
|
- Clear migration path without immediate broad rewrite.
|
||||||
|
- Controlled risk while preserving velocity.
|
||||||
|
|
||||||
|
### Tradeoffs
|
||||||
|
- Temporary dual-path assumptions (SQLite local vs PostgreSQL target).
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
1. **Immediate forced PostgreSQL-only migration**
|
||||||
|
- Rejected: higher short-term disruption risk.
|
||||||
|
2. **Remain SQLite-only for V1**
|
||||||
|
- Rejected: inconsistent with architecture and requirement trajectory.
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# ADR-0004: In-process worker topology for V1
|
||||||
|
|
||||||
|
- **Status:** accepted
|
||||||
|
- **Date:** 2026-06-25
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
The current system uses an in-process background worker. Architecture docs allow this in foundation stage and permit later hardening (optional external worker/queue).
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Retain in-process worker topology for V1, with improved lifecycle ownership:
|
||||||
|
|
||||||
|
1. Worker starts/stops via app lifespan.
|
||||||
|
2. Worker receives runtime-owned DB engine dependency explicitly.
|
||||||
|
3. Extension path to external worker remains behind existing service/adapter seams.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
### Positive
|
||||||
|
- Keeps operational complexity low for personal-scale use.
|
||||||
|
- Preserves delivery focus on V1 completion.
|
||||||
|
|
||||||
|
### Tradeoffs
|
||||||
|
- Throughput/scaling limits remain compared to external queue-based topology.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
1. **Immediate queue/external worker introduction**
|
||||||
|
- Rejected: premature complexity for current scale.
|
||||||
|
2. **Ad hoc thread lifecycle management outside lifespan**
|
||||||
|
- Rejected: weaker shutdown guarantees and poorer ownership clarity.
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# Architecture Decision Records (ADRs)
|
||||||
|
|
||||||
|
This directory records significant architecture decisions for Version 1.
|
||||||
|
|
||||||
|
## ADR Format
|
||||||
|
|
||||||
|
Each ADR should include:
|
||||||
|
|
||||||
|
1. **Status** (`proposed`, `accepted`, `superseded`)
|
||||||
|
2. **Context**
|
||||||
|
3. **Decision**
|
||||||
|
4. **Consequences**
|
||||||
|
5. **Alternatives Considered**
|
||||||
|
|
||||||
|
## Index
|
||||||
|
|
||||||
|
- [ADR-0001: Lifespan-owned runtime resources](ADR-0001-lifespan-owned-runtime-resources.md)
|
||||||
|
- [ADR-0002: Explicit schema bootstrap policy](ADR-0002-explicit-schema-bootstrap-policy.md)
|
||||||
|
- [ADR-0003: Persistence baseline and transition path](ADR-0003-persistence-baseline-and-transition-path.md)
|
||||||
|
- [ADR-0004: In-process worker topology for V1](ADR-0004-in-process-worker-topology.md)
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# System Architecture (Version 1)
|
# Architecture
|
||||||
|
|
||||||
This document describes the production architecture of the personal historical-document transcription system. The system is intentionally optimized for single-user operation, low operational overhead, and clean internal boundaries that support future growth without rewrites.
|
This document describes the production architecture of the personal historical-document transcription system. The system is intentionally optimized for single-user operation, low operational overhead, and clean internal boundaries that support future growth without rewrites.
|
||||||
|
|
||||||
@@ -17,10 +17,10 @@ The deployed system targets personal use and a corpus of several thousand docume
|
|||||||
|
|
||||||
Current scope includes:
|
Current scope includes:
|
||||||
|
|
||||||
- content source upload and metadata capture
|
- document upload and metadata capture
|
||||||
- asynchronous transcription jobs
|
- asynchronous transcription jobs
|
||||||
- prompt-library driven transcription behavior, with one Markdown file per prompt
|
- prompt-library driven transcription behavior, with one Markdown file per prompt
|
||||||
- original transcription review and optional revision review
|
- transcript review and revision history
|
||||||
- full-text search over accepted transcripts
|
- full-text search over accepted transcripts
|
||||||
- export of transcript data
|
- export of transcript data
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ flowchart LR
|
|||||||
Worker --> MG
|
Worker --> MG
|
||||||
```
|
```
|
||||||
|
|
||||||
## Runtime Ownership And Startup Policy
|
## Runtime Ownership And Startup Policy (V1 Step 1)
|
||||||
|
|
||||||
The current implementation now uses explicit lifespan-owned runtime resources.
|
The current implementation now uses explicit lifespan-owned runtime resources.
|
||||||
|
|
||||||
@@ -131,31 +131,22 @@ Out of scope:
|
|||||||
|
|
||||||
Production transcription flow:
|
Production transcription flow:
|
||||||
|
|
||||||
1. A user uploads one or more content sources through the UI or API.
|
1. A user uploads an image or PDF through the UI or API.
|
||||||
2. The application validates payloads and creates document, source, and job records.
|
2. The application validates payloads and creates document and job records.
|
||||||
3. The in-process worker de-queues the job and calls the transcription provider.
|
3. The in-process worker dequeues the job and calls the transcription provider.
|
||||||
4. The application persists original transcription output on the job, plus confidence metadata and provenance events.
|
4. The application persists transcript output, confidence metadata, and provenance events.
|
||||||
5. Job status transitions from queued to processing to transcribed or failed.
|
5. Job status transitions from queued to processing to transcribed or failed.
|
||||||
6. The UI and API expose status, optional revision to original transcription, and searchable transcription text.
|
6. The UI and API expose status, revision history, and searchable transcript text.
|
||||||
|
|
||||||
## Data Model Ownership
|
## Data Model Ownership
|
||||||
|
|
||||||
System-of-record entities:
|
System-of-record entities:
|
||||||
|
|
||||||
- documents and content sources
|
- documents and pages
|
||||||
- transcription jobs, original transcription, and status events
|
- transcription jobs and status events
|
||||||
- transcript revisions
|
- transcript revisions
|
||||||
- provenance metadata
|
- provenance metadata
|
||||||
|
|
||||||
### Original Transcription And Revision Ownership
|
|
||||||
|
|
||||||
- each processing job stores the original immutable provider output (`text`)
|
|
||||||
- provider metadata (`provider`, `model`, `prompt_name`) and failure detail (`error_detail`) are job-owned processing artifacts
|
|
||||||
- revisions are optional user-authored edits linked to a content source
|
|
||||||
- a revision can be created from original `job.text`
|
|
||||||
- many jobs will have zero revisions; revisions are additive and never overwrite original provider output
|
|
||||||
- a document groups one or more content sources (images, PDFs, and future source types)
|
|
||||||
|
|
||||||
Storage strategy:
|
Storage strategy:
|
||||||
|
|
||||||
- PostgreSQL for relational system-of-record entities
|
- PostgreSQL for relational system-of-record entities
|
||||||
@@ -259,14 +250,12 @@ Control:
|
|||||||
|
|
||||||
Risk:
|
Risk:
|
||||||
|
|
||||||
- transcription quality varies by content source type, handwriting legibility, and source quality
|
- transcription quality varies by document type, handwriting legibility, and image quality
|
||||||
|
|
||||||
Control:
|
Control:
|
||||||
|
|
||||||
- first-class human review and immutable revision history
|
- first-class human review and immutable revision history
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technology References
|
## Technology References
|
||||||
|
|
||||||
- [FastAPI documentation](https://fastapi.tiangolo.com/)
|
- [FastAPI documentation](https://fastapi.tiangolo.com/)
|
||||||
@@ -275,16 +264,13 @@ Control:
|
|||||||
- [PostgreSQL documentation](https://www.postgresql.org/docs/)
|
- [PostgreSQL documentation](https://www.postgresql.org/docs/)
|
||||||
- [MongoDB documentation](https://www.mongodb.com/docs/)
|
- [MongoDB documentation](https://www.mongodb.com/docs/)
|
||||||
|
|
||||||
## Related Local References
|
## Related Pages
|
||||||
|
|
||||||
- [System Overview](index_v1.md)
|
- [System overview](index.md)
|
||||||
- [System Design Intent](intent.md)
|
- [Version 1 plan](ver1/ver1.md)
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
- [Version 1 Step 1 plan](ver1/ver1-step1.md)
|
||||||
- System Architecture (this document)
|
- [Version 1 Step 1 results](ver1/ver1-step1-results.md)
|
||||||
- [System Requirements](requirements_v1.md)
|
- [Architecture decision records index](adr/README.md)
|
||||||
- [Data model](schema_v1.md)
|
|
||||||
- [Error Handling Policy](error_handling_v1.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v1.md)
|
|
||||||
|
|
||||||
## Glossary
|
## Glossary
|
||||||
|
|
||||||
@@ -303,6 +289,6 @@ Control:
|
|||||||
- Port/Interface: A stable contract used by application/domain code to call infrastructure implementations.
|
- Port/Interface: A stable contract used by application/domain code to call infrastructure implementations.
|
||||||
- Prompt artifact: A single Markdown file that defines one transcription prompt and can be revised independently.
|
- Prompt artifact: A single Markdown file that defines one transcription prompt and can be revised independently.
|
||||||
- Provenance: Metadata that records where generated data came from and how it was produced.
|
- Provenance: Metadata that records where generated data came from and how it was produced.
|
||||||
- Revision history: Optional versioned record of user-authored transcription edits over time.
|
- Revision history: Versioned record of transcript edits over time.
|
||||||
- System of record: The authoritative persistent store for canonical data.
|
- System of record: The authoritative persistent store for canonical data.
|
||||||
- Vertical slice: A minimal end-to-end feature path spanning UI/API, application logic, and persistence.
|
- Vertical slice: A minimal end-to-end feature path spanning UI/API, application logic, and persistence.
|
||||||
@@ -1,136 +0,0 @@
|
|||||||
# System Architecture (Version 2)
|
|
||||||
|
|
||||||
This document describes the V2 production architecture of the personal historical-document transcription system.
|
|
||||||
|
|
||||||
## Architecture Objectives
|
|
||||||
|
|
||||||
* Preserve source material as immutable transcribed text alongside page-level spatial AI metadata.
|
|
||||||
* Support batching multi-image and folder uploads cleanly into sequential pages (`page_number`).
|
|
||||||
* Leverage asynchronous worker pools (`asyncio`) for parallel single-image API execution bounded by rate limiters (`asyncio.Semaphore`).
|
|
||||||
* Migrate persistence to PostgreSQL using native `UUID`, `TIMESTAMPTZ`, and `JSONB` document storage.
|
|
||||||
* Standardize all data validation, API parsing, and database models on **Pydantic V2**.
|
|
||||||
* Support rich historical attribution (multi-author and multi-recipient relationships).
|
|
||||||
|
|
||||||
## Runtime Topology
|
|
||||||
|
|
||||||
The V2 runtime operates as an asynchronous Python application:
|
|
||||||
|
|
||||||
* FastAPI + NiceGUI web application process.
|
|
||||||
* In-process `asyncio` background task orchestrator for parallel API execution.
|
|
||||||
* Relational persistence via PostgreSQL (using `asyncpg` or `psycopg3`).
|
|
||||||
* Pydantic V2 validation layer wrapping API payloads and PostgreSQL `JSONB` schemas.
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
flowchart LR
|
|
||||||
U[Browser User] --> A[FastAPI + NiceGUI App]
|
|
||||||
A --> W[Asyncio Worker Engine]
|
|
||||||
A --> DB[(PostgreSQL Database)]
|
|
||||||
W --> P[Vision Provider APIs\nOpenAI / Claude]
|
|
||||||
W --> DB
|
|
||||||
```
|
|
||||||
|
|
||||||
## Lifecycle Ownership
|
|
||||||
|
|
||||||
Application lifespan owns runtime setup/teardown:
|
|
||||||
|
|
||||||
* Initialize environment logging and Pydantic configuration.
|
|
||||||
* Manage asynchronous PostgreSQL connection pools (`asyncpg` / `psycopg3`).
|
|
||||||
* Execute database migrations and index initialization.
|
|
||||||
* Recover stale processing jobs on startup.
|
|
||||||
* Manage graceful shutdown of active `asyncio` worker pools.
|
|
||||||
|
|
||||||
## Layered Module Structure
|
|
||||||
|
|
||||||
### Interface Layer
|
|
||||||
|
|
||||||
* `src/transcription/ui/**` (NiceGUI pages, multi-page renderers, person cards)
|
|
||||||
* `src/transcription/api/**` (FastAPI routes and JSON error handlers)
|
|
||||||
|
|
||||||
### Application & Async Worker Layer
|
|
||||||
|
|
||||||
* `src/transcription/services/workflows.py`
|
|
||||||
* `src/transcription/worker.py`
|
|
||||||
|
|
||||||
Responsibilities:
|
|
||||||
|
|
||||||
* Batch orchestration and status transitions (`queued` -> `processing` -> `completed` | `partial_success` | `failed`).
|
|
||||||
* Parallel single-image API execution using `asyncio.gather` bounded by `asyncio.Semaphore`.
|
|
||||||
* Pydantic schema parsing (`PageAIMetadata`) and validation prior to database storage.
|
|
||||||
|
|
||||||
### Domain & Service Layer
|
|
||||||
|
|
||||||
* `src/transcription/models/*.py` (Pydantic V2 schemas and entity definitions)
|
|
||||||
* `src/transcription/services/*.py` (Transactional operations for `Document`, `Person`, `Source`, `Job`, and `JobSource`)
|
|
||||||
|
|
||||||
### Infrastructure Layer
|
|
||||||
|
|
||||||
* `src/transcription/db/**` (PostgreSQL connection pooling and raw parameterized SQL execution)
|
|
||||||
* `src/transcription/providers/**` (OpenAI & Anthropic Vision SDK adapters)
|
|
||||||
|
|
||||||
## Processing Workflow
|
|
||||||
|
|
||||||
1. User uploads a folder or batch of images for a `Document`.
|
|
||||||
2. System creates `Document`, `Job(status='queued')`, and ordered `Source` pages (`page_number = 1..N`).
|
|
||||||
3. Worker claims job, sets `Job.status = 'processing'`, and spawns parallel `asyncio` tasks bounded by semaphore.
|
|
||||||
4. Each task calls Vision API for a **single** `Source` image.
|
|
||||||
5. On task completion:
|
|
||||||
* Writes a `JobSource` record containing `status='transcribed'`, `raw_transcription`, `ai_metadata` (bounding boxes/confidence), and `raw_api_response`.
|
|
||||||
* Caches active text to `Source.raw_transcription`.
|
|
||||||
|
|
||||||
|
|
||||||
6. On page failure:
|
|
||||||
* Writes `JobSource` record with `status='failed'` and `error_detail`.
|
|
||||||
|
|
||||||
|
|
||||||
7. Once all page tasks resolve:
|
|
||||||
* Marks `Job.status` as `completed` (100% success), `partial_success` (at least 1 success, 1 failure), or `failed` (all failed).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Domain Ownership & Invariants
|
|
||||||
|
|
||||||
* **Immutable AI Outputs:** `source.raw_transcription` and `job_source.raw_transcription` store original, point-in-time machine output and are immutable.
|
|
||||||
* **Inlined Revisions:** Human corrections occur on `source.revised_text`. UI renders `COALESCE(revised_text, raw_transcription)`.
|
|
||||||
* **Sequential Integrity:** Multi-page documents are strictly ordered by `source.page_number ASC`.
|
|
||||||
* **Page Execution Isolation:** A failure on one page image does not invalidate successful transcriptions on sister pages in the same batch job.
|
|
||||||
|
|
||||||
## Data Model Summary
|
|
||||||
|
|
||||||
* `Document` has many `Source` pages, many `Job` runs, and many `Person` records via `DocumentPerson` junction (`author` or `recipient`).
|
|
||||||
* `Source` belongs to one `Document` and can be processed across many `JobSource` executions.
|
|
||||||
* `Job` has many `JobSource` execution records.
|
|
||||||
|
|
||||||
## Test Strategy
|
|
||||||
|
|
||||||
* Unit tests for Pydantic V2 schemas, custom validators, and JSONB serialization.
|
|
||||||
* Integration tests for async PostgreSQL connection handling and parameterized queries.
|
|
||||||
* Async workflow tests using mock AI providers to verify `partial_success` and retry logic.
|
|
||||||
* UI integration tests for multi-page rendering and person management.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technology References
|
|
||||||
|
|
||||||
- [FastAPI documentation](https://fastapi.tiangolo.com/)
|
|
||||||
- [NiceGUI documentation](https://nicegui.io/documentation)
|
|
||||||
- [PostgreSQL documentation](https://www.postgresql.org/docs/)
|
|
||||||
- [Python asyncio](https://docs.python.org/3/library/asyncio.html#module-asyncio)
|
|
||||||
- [Pydantic Validation](https://pydantic.dev/docs/validation/latest/get-started/)
|
|
||||||
- [Pydantic AI](https://pydantic.dev/docs/ai/overview/)
|
|
||||||
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v1.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- System Architecture (this document)
|
|
||||||
- [System Requirements](requirements_v1.md)
|
|
||||||
- [Data model](schema_v1.md)
|
|
||||||
- [Error Handling Policy](error_handling_v1.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v1.md)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
-102
@@ -1,102 +0,0 @@
|
|||||||
## PostgreSQL DDL Specification (Version 2)
|
|
||||||
|
|
||||||
```sql
|
|
||||||
-- Enable pgcrypto for UUID generation if on PostgreSQL < 13
|
|
||||||
CREATE EXTENSION IF NOT EXISTS "pgcrypto";
|
|
||||||
|
|
||||||
-- 1. PERSON TABLE
|
|
||||||
CREATE TABLE person (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
full_name TEXT NOT NULL,
|
|
||||||
display_name TEXT,
|
|
||||||
maiden_name TEXT,
|
|
||||||
birth_date DATE,
|
|
||||||
birth_date_raw TEXT,
|
|
||||||
birth_place TEXT,
|
|
||||||
death_date DATE,
|
|
||||||
death_date_raw TEXT,
|
|
||||||
death_place TEXT,
|
|
||||||
biography TEXT,
|
|
||||||
portrait_path TEXT,
|
|
||||||
metadata JSONB DEFAULT '{}'::jsonb,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
-- 2. DOCUMENT TABLE
|
|
||||||
CREATE TABLE document (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
document_type TEXT,
|
|
||||||
document_date DATE,
|
|
||||||
document_date_raw TEXT,
|
|
||||||
location_created TEXT,
|
|
||||||
notes TEXT,
|
|
||||||
archive_identifier TEXT,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
-- 3. DOCUMENT_PERSON (Junction Table for Multi-Author / Multi-Recipient)
|
|
||||||
CREATE TABLE document_person (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
document_id UUID NOT NULL REFERENCES document(id) ON DELETE CASCADE,
|
|
||||||
person_id UUID NOT NULL REFERENCES person(id) ON DELETE CASCADE,
|
|
||||||
role VARCHAR(20) NOT NULL, -- 'author' or 'recipient'
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
CONSTRAINT unique_document_person_role UNIQUE (document_id, person_id, role)
|
|
||||||
);
|
|
||||||
|
|
||||||
-- 4. JOB TABLE (Batch-level orchestrator)
|
|
||||||
CREATE TABLE job (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
document_id UUID NOT NULL REFERENCES document(id) ON DELETE CASCADE,
|
|
||||||
status VARCHAR(50) NOT NULL DEFAULT 'queued', -- 'queued', 'processing', 'completed', 'partial_success', 'failed'
|
|
||||||
retry_count INTEGER NOT NULL DEFAULT 0,
|
|
||||||
provider TEXT NOT NULL, -- e.g., 'openai', 'anthropic'
|
|
||||||
model TEXT NOT NULL, -- e.g., 'gpt-4o', 'claude-3-5-sonnet'
|
|
||||||
prompt_name TEXT,
|
|
||||||
date_created TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
date_updated TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
-- 5. SOURCE TABLE (Physical image files & active state)
|
|
||||||
CREATE TABLE source (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
document_id UUID NOT NULL REFERENCES document(id) ON DELETE CASCADE,
|
|
||||||
page_number INTEGER NOT NULL DEFAULT 1,
|
|
||||||
upload_name TEXT NOT NULL,
|
|
||||||
filename TEXT NOT NULL,
|
|
||||||
file_path TEXT NOT NULL,
|
|
||||||
raw_transcription TEXT, -- Cached active AI text output
|
|
||||||
revised_text TEXT, -- Active human edited text
|
|
||||||
date_uploaded TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
date_revised TIMESTAMPTZ
|
|
||||||
);
|
|
||||||
|
|
||||||
-- 6. JOB_SOURCE (Junction Table: Per-Image Execution Record)
|
|
||||||
CREATE TABLE job_source (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
job_id UUID NOT NULL REFERENCES job(id) ON DELETE CASCADE,
|
|
||||||
source_id UUID NOT NULL REFERENCES source(id) ON DELETE CASCADE,
|
|
||||||
status VARCHAR(50) NOT NULL DEFAULT 'pending', -- 'pending', 'transcribed', 'failed'
|
|
||||||
raw_transcription TEXT, -- Point-in-time raw AI text output
|
|
||||||
ai_metadata JSONB, -- Page-level bounding boxes, tokens, confidence
|
|
||||||
raw_api_response JSONB, -- Complete REST response envelope
|
|
||||||
error_detail TEXT,
|
|
||||||
executed_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
CONSTRAINT unique_job_source UNIQUE (job_id, source_id)
|
|
||||||
);
|
|
||||||
|
|
||||||
-- INDEXES FOR FAST LOOKUPS & QUERY PERFORMANCE
|
|
||||||
CREATE INDEX idx_person_full_name ON person(full_name);
|
|
||||||
CREATE INDEX idx_document_date ON document(document_date);
|
|
||||||
CREATE INDEX idx_document_person_doc ON document_person(document_id);
|
|
||||||
CREATE INDEX idx_document_person_per ON document_person(person_id);
|
|
||||||
CREATE INDEX idx_source_document ON source(document_id);
|
|
||||||
CREATE INDEX idx_source_page_order ON source(document_id, page_number);
|
|
||||||
CREATE INDEX idx_job_document ON job(document_id);
|
|
||||||
CREATE INDEX idx_job_source_job ON job_source(job_id);
|
|
||||||
CREATE INDEX idx_job_source_source ON job_source(source_id);
|
|
||||||
CREATE INDEX idx_job_source_ai_metadata ON job_source USING GIN (ai_metadata);
|
|
||||||
```
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Error Handling Policy
|
# Error Handling
|
||||||
|
|
||||||
This document defines the canonical error-handling policy for the document transcription system. It is the single source of truth for how errors are classified, surfaced to users, logged for diagnosis, and handled across UI, API, service, worker, and provider boundaries.
|
This document defines the canonical error-handling policy for the document transcription system. It is the single source of truth for how errors are classified, surfaced to users, logged for diagnosis, and handled across UI, API, service, worker, and provider boundaries.
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ The system uses stable, implementation-independent categories:
|
|||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `validation_error` | Payload or parameter shape/content is invalid | UI/API input validation, service guards | no |
|
| `validation_error` | Payload or parameter shape/content is invalid | UI/API input validation, service guards | no |
|
||||||
| `user_input_error` | User-provided artifact is unacceptable though structurally valid | unsupported file type, empty file, oversized upload | sometimes |
|
| `user_input_error` | User-provided artifact is unacceptable though structurally valid | unsupported file type, empty file, oversized upload | sometimes |
|
||||||
| `not_found_error` | Requested resource does not exist | missing job/document/source/revision | no |
|
| `not_found_error` | Requested resource does not exist | missing job/document/transcript | no |
|
||||||
| `conflict_error` | Requested operation violates current state constraints | invalid state transition | no |
|
| `conflict_error` | Requested operation violates current state constraints | invalid state transition | no |
|
||||||
| `external_provider_error` | External AI/provider call fails | upstream HTTP/API/provider failures | sometimes |
|
| `external_provider_error` | External AI/provider call fails | upstream HTTP/API/provider failures | sometimes |
|
||||||
| `infrastructure_transient_error` | Temporary environment issue | network timeout, DB connection reset | yes |
|
| `infrastructure_transient_error` | Temporary environment issue | network timeout, DB connection reset | yes |
|
||||||
@@ -111,7 +111,7 @@ All logged errors must include, where available:
|
|||||||
- `category`
|
- `category`
|
||||||
- `operation` (e.g., `upload.submit`, `worker.process_job`, `jobs.refresh`)
|
- `operation` (e.g., `upload.submit`, `worker.process_job`, `jobs.refresh`)
|
||||||
- `exception_type`
|
- `exception_type`
|
||||||
- `job_id`, `document_id`, `source_id` (when relevant)
|
- `job_id`, `document_id` (when relevant)
|
||||||
- UTC timestamp
|
- UTC timestamp
|
||||||
|
|
||||||
Rules:
|
Rules:
|
||||||
@@ -266,18 +266,12 @@ Change requirements:
|
|||||||
- preserve taxonomy stability; if changed, document migration impact
|
- preserve taxonomy stability; if changed, document migration impact
|
||||||
- record noteworthy policy changes in project release notes or changelog
|
- record noteworthy policy changes in project release notes or changelog
|
||||||
|
|
||||||
---
|
## Related Pages
|
||||||
|
|
||||||
## Related Local References
|
- [System overview](index.md)
|
||||||
|
- [Architecture](architecture.md)
|
||||||
- [System Overview](index_v1.md)
|
- [Requirements](requirements.md)
|
||||||
- [System Design Intent](intent.md)
|
- [Intent](intent.md)
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v1.md)
|
|
||||||
- [System Requirements](requirements_v1.md)
|
|
||||||
- [Data model](schema_v1.md)
|
|
||||||
- Error Handling Policy (this document)
|
|
||||||
- [Implementation Plan](implementation_plan_v1.md)
|
|
||||||
|
|
||||||
## Glossary
|
## Glossary
|
||||||
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
# Error Handling Policy (Version 2)
|
|
||||||
|
|
||||||
This document defines the canonical error-handling policy for the V2 document transcription system.
|
|
||||||
|
|
||||||
## Error Handling Objectives
|
|
||||||
|
|
||||||
* Make failures visible in clear, actionable language at both the document and individual page levels.
|
|
||||||
* Support **isolated failure handling** in multi-image batches so single page errors do not crash an entire batch job.
|
|
||||||
* Preserve diagnostic detail (Pydantic validation errors, raw provider responses) in PostgreSQL `JSONB` for fast troubleshooting.
|
|
||||||
* Ensure consistent error envelope structure across API, UI, and async worker boundaries.
|
|
||||||
|
|
||||||
## Scope And Authority
|
|
||||||
|
|
||||||
Governs error behavior across NiceGUI pages, FastAPI routes, service orchestration, `asyncio` background tasks, PostgreSQL interactions, and AI provider adapters.
|
|
||||||
|
|
||||||
## Error Taxonomy
|
|
||||||
|
|
||||||
| Category | Definition | Retriable |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `validation_error` | Pydantic payload or parameter schema validation failure | no |
|
|
||||||
| `user_input_error` | Unacceptable user file (unsupported image type, corrupt file) | no |
|
|
||||||
| `not_found_error` | Requested resource (`Document`, `Source`, `Person`, `Job`) missing | no |
|
|
||||||
| `conflict_error` | Operation violates state constraints (e.g., duplicate `document_person` role) | no |
|
|
||||||
| `external_provider_error` | AI Provider API failure (rate limit, vision execution error) | yes |
|
|
||||||
| `infrastructure_transient_error` | Temporary DB connection reset or HTTP timeout | yes |
|
|
||||||
| `infrastructure_persistent_error` | Database down, missing API credentials, misconfiguration | no |
|
|
||||||
| `internal_unexpected_error` | Uncaught Python exception or logic defect | no |
|
|
||||||
|
|
||||||
## Async Batch & Page-Level Error Behavior
|
|
||||||
|
|
||||||
In multi-image `asyncio` batch processing:
|
|
||||||
|
|
||||||
1. **Page Isolation:** Exceptions caught during individual page calls are caught within the `asyncio` task wrapper.
|
|
||||||
2. **Page Record Logging:** Page failure detail is written directly to `job_source.error_detail` and `job_source.status = 'failed'`.
|
|
||||||
3. **Batch Aggregate State:**
|
|
||||||
* If **all** page tasks succeed -> `job.status = 'completed'`.
|
|
||||||
* If **some** page tasks fail -> `job.status = 'partial_success'`.
|
|
||||||
* If **all** page tasks fail -> `job.status = 'failed'`.
|
|
||||||
|
|
||||||
|
|
||||||
4. **Retry Strategy:** The UI exposes a "Retry Failed Pages" option for `partial_success` jobs, which spawns a new targeted `Job` containing *only* the `Source` IDs marked as `failed`.
|
|
||||||
|
|
||||||
## API Error Response Contract
|
|
||||||
|
|
||||||
API error responses return a structured JSON envelope:
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"error_id": "err_uuid_12345",
|
|
||||||
"category": "validation_error",
|
|
||||||
"message": "The uploaded payload failed schema validation.",
|
|
||||||
"suggestion": "Check file format and metadata fields, then try again.",
|
|
||||||
"details": {
|
|
||||||
"pydantic_errors": [...]
|
|
||||||
},
|
|
||||||
"timestamp": "2026-07-31T07:55:00Z"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
HTTP Status Mappings:
|
|
||||||
|
|
||||||
* `validation_error`, `user_input_error` -> `400`
|
|
||||||
* `not_found_error` -> `404`
|
|
||||||
* `conflict_error` -> `409`
|
|
||||||
* `external_provider_error` -> `502` / `503`
|
|
||||||
* `infrastructure_transient_error` -> `503`
|
|
||||||
* `infrastructure_persistent_error`, `internal_unexpected_error` -> `500`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technology References
|
|
||||||
|
|
||||||
- [FastAPI documentation](https://fastapi.tiangolo.com/)
|
|
||||||
- [NiceGUI documentation](https://nicegui.io/documentation)
|
|
||||||
- [PostgreSQL documentation](https://www.postgresql.org/docs/)
|
|
||||||
- [Python asyncio](https://docs.python.org/3/library/asyncio.html#module-asyncio)
|
|
||||||
- [Pydantic Validation](https://pydantic.dev/docs/validation/latest/get-started/)
|
|
||||||
- [Pydantic AI](https://pydantic.dev/docs/ai/overview/)
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v2.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v2.md)
|
|
||||||
- [System Requirements](requirements_v2.md)
|
|
||||||
- [Data model](schema_v2.md)
|
|
||||||
- Error Handling Policy (this document)
|
|
||||||
- [Implementation Plan](implementation_plan_v2.md)
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
# implementation_plan_v2
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
Replace the current V1 SQLModel schema with the approved V2 schema and make sure every database operation works through the existing async SQLAlchemy/SQLModel session layer.
|
|
||||||
|
|
||||||
Use a fresh database. There will be no migrations, data conversion, legacy compatibility shims, or parallel V1/V2 code paths.
|
|
||||||
|
|
||||||
## Current Project Impact
|
|
||||||
|
|
||||||
- `src/transcription/db/models.py` still defines the V1 `Document`, `Source`, `Job`, and `Revision` tables.
|
|
||||||
- The V2 target adds `Person`, `DocumentPerson`, and `JobSource`, moves revisions onto `Source`, and removes the direct `Source.job_id` relationship.
|
|
||||||
- The engine, session factory, transaction handling, and PostgreSQL async support already exist and do not need to be rewritten.
|
|
||||||
- Async CRUD currently lives in `DocumentService`, `JobService`, `TranscriptionService`, and the upload record helper. Their queries and eager-loading options depend on V1 relationships.
|
|
||||||
- Existing tests cover only part of the schema and CRUD surface.
|
|
||||||
|
|
||||||
## Implementation
|
|
||||||
|
|
||||||
### 1. Update the schema
|
|
||||||
|
|
||||||
- Replace the models in `src/transcription/db/models.py` with the approved V2 tables, enums, relationships, foreign keys, constraints, and indexes.
|
|
||||||
- Remove `Revision`, `Source.job_id`, and the transcription fields that no longer belong on `Job`.
|
|
||||||
- Keep `create_all()` as the schema bootstrap for a fresh database.
|
|
||||||
- Delete `_ensure_sqlite_compat_columns()` and all schema patching from `src/transcription/db/operations.py`.
|
|
||||||
- Keep the Python models, `docs/schema_v2.md`, and `docs/ddl_v2.sql` consistent.
|
|
||||||
|
|
||||||
### 2. Align the async CRUD methods
|
|
||||||
|
|
||||||
- Keep the existing `ServiceBase` session and transaction pattern.
|
|
||||||
- Update document CRUD to load and manage its ordered `Source` rows and `DocumentPerson` links.
|
|
||||||
- Update job CRUD and queue queries to use `JobSource` instead of `Source.job_id`.
|
|
||||||
- Add the missing async CRUD operations for `Person`, `Source`, `DocumentPerson`, and `JobSource` using the existing service style. Do not add another repository abstraction.
|
|
||||||
- Replace revision CRUD with direct updates to `Source.revised_text` and `Source.date_revised`.
|
|
||||||
- Remove the temporary transcript compatibility aliases instead of redirecting them.
|
|
||||||
- Update only direct database call sites that construct or query these records; UI and worker feature changes are not part of this work.
|
|
||||||
|
|
||||||
### 3. Verify the schema and CRUD
|
|
||||||
|
|
||||||
- Update the schema bootstrap test to expect `person`, `document`, `document_person`, `source`, `job`, and `job_source`, with no `revision` table.
|
|
||||||
- Add async create, read, update, delete, list, and filtered-query tests for each entity that exposes those operations.
|
|
||||||
- Test relationship loading, page ordering, uniqueness constraints, delete behavior, status values, and `JobSource` JSON fields.
|
|
||||||
- Test both service-owned sessions and caller-provided sessions so flush/commit behavior remains correct.
|
|
||||||
- Run the focused database and service tests, then the full suite with `uv run pytest`.
|
|
||||||
|
|
||||||
## Done When
|
|
||||||
|
|
||||||
- A fresh database is created directly from the V2 SQLModel metadata.
|
|
||||||
- All async CRUD methods pass against the V2 relationships and fields.
|
|
||||||
- No code references `Revision`, `Source.job_id`, removed `Job` transcription fields, or compatibility aliases.
|
|
||||||
- The focused tests and full test suite pass.
|
|
||||||
|
|
||||||
## Out of Scope
|
|
||||||
|
|
||||||
- Database migrations or preservation of V1 data
|
|
||||||
- Legacy compatibility code
|
|
||||||
- Database engine or session-layer rewrites
|
|
||||||
- UI redesign, batch orchestration, worker concurrency, deployment, and operational runbooks
|
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
## Document Transcription System Overview
|
## Document Transcription System
|
||||||
|
|
||||||
This project is a production application for transcribing and preserving historical family documents. It is intentionally designed for personal-scale use, with a simplicity-first architecture that is easy to operate and easy to extend.
|
This project is a production application for transcribing and preserving historical family documents. It is intentionally designed for personal-scale use, with a simplicity-first architecture that is easy to operate and easy to extend.
|
||||||
|
|
||||||
## Start Here
|
## Start Here
|
||||||
|
|
||||||
Read [architecture_v1.md](architecture_v1.md) first.
|
Read [architecture.md](architecture.md) first.
|
||||||
|
|
||||||
|
Then review [ver1/ver1.md](ver1/ver1.md) for completion scope.
|
||||||
|
|
||||||
The architecture page is the primary technical reference and defines:
|
The architecture page is the primary technical reference and defines:
|
||||||
|
|
||||||
@@ -15,15 +17,14 @@ The architecture page is the primary technical reference and defines:
|
|||||||
|
|
||||||
## What The Application Does
|
## What The Application Does
|
||||||
|
|
||||||
At a high level, users upload images or PDFs as content sources for handwritten, typed, or typeset documents, run asynchronous transcription jobs, review optional revisions, and search across accepted text.
|
At a high level, users upload images of handwritten, typed, or typeset documents, run asynchronous transcription jobs, review and edit transcript revisions, and search across accepted text.
|
||||||
|
|
||||||
### Core capabilities:
|
Core capabilities:
|
||||||
|
|
||||||
- document grouping with one or more content sources and metadata capture
|
- document upload and metadata capture
|
||||||
- asynchronous transcription with visible job status
|
- asynchronous transcription with visible job status
|
||||||
- immutable original transcription persisted with each job (plus provider/model/prompt metadata)
|
|
||||||
- transcription prompt management with one Markdown file per prompt for human refinement over time
|
- transcription prompt management with one Markdown file per prompt for human refinement over time
|
||||||
- optional revisions for user-authored edits of original immutable transcription text
|
- revision history for transcript edits
|
||||||
- full-text search over accepted transcripts
|
- full-text search over accepted transcripts
|
||||||
- export of transcript data
|
- export of transcript data
|
||||||
|
|
||||||
@@ -38,18 +39,14 @@ The system runs with minimal operational overhead:
|
|||||||
|
|
||||||
This operating model keeps deployment and maintenance simple while preserving clean boundaries for future scale.
|
This operating model keeps deployment and maintenance simple while preserving clean boundaries for future scale.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Documentation Map
|
## Documentation Map
|
||||||
|
|
||||||
- System Overview (this document)
|
- Version 1 implementation plan: [ver1/ver1.md](ver1/ver1.md)
|
||||||
- [System Design Intent](intent.md)
|
- Architecture and technical design: [architecture.md](architecture.md)
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
- Architecture decision records (ADR index): [adr/README.md](adr/README.md)
|
||||||
- [System Architecture](architecture_v1.md)
|
- Runtime and deployment requirements: [requirements.md](requirements.md)
|
||||||
- [System Requirements](requirements_v1.md)
|
- Error handling policy and operational guidance: [error_handling.md](error_handling.md)
|
||||||
- [Data model](schema_v1.md)
|
- Domain context and transcription policy: [intent.md](intent.md)
|
||||||
- [Error Handling Policy](error_handling_v1.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v1.md)
|
|
||||||
|
|
||||||
## Glossary
|
## Glossary
|
||||||
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
# Document Transcription System Overview (Version 2)
|
|
||||||
|
|
||||||
This project is a personal-scale application for transcribing, indexing, and preserving historical family documents, letters, postcards, and journals.
|
|
||||||
|
|
||||||
## Start Here
|
|
||||||
|
|
||||||
Read [architecture_v2.md](architecture_v2.md) first for technical overview and system design.
|
|
||||||
|
|
||||||
## Core V2 Capabilities
|
|
||||||
|
|
||||||
* **Folder & Multi-Image Ingestion:** Upload whole folders or image batches that map sequentially (`page_number`) under a single `Document`.
|
|
||||||
* **Parallel Async AI Vision Engine:** Concurrently process single-page image transcriptions using Python `asyncio` bounded by rate limiters.
|
|
||||||
* **Robust PostgreSQL Storage:** Relational storage for entities with native `UUID`, `TIMESTAMPTZ`, and `JSONB` for deep AI spatial metadata and raw envelopes.
|
|
||||||
* **Pydantic V2 Validation:** End-to-end type safety, DB row mapping, and JSONB payload validation.
|
|
||||||
* **Historical Person Management:** Track authors and recipients across documents with rich biographical entities (`Person`).
|
|
||||||
* **Page-Level Execution Auditing & Revisions:** Store immutable point-in-time machine output per run while enabling inline human corrections (`revised_text`).
|
|
||||||
* **Partial Failure Recovery:** Bounded batch execution that isolates single-page API errors (`partial_success`) for simple retries.
|
|
||||||
|
|
||||||
## Technical Stack
|
|
||||||
|
|
||||||
* **Application Web Framework:** FastAPI + NiceGUI
|
|
||||||
* **Persistence Engine:** PostgreSQL 18+
|
|
||||||
* **Data Validation & Schemas:** Pydantic V2
|
|
||||||
* **Concurrency & Workers:** Python `asyncio` worker pool with `asyncio.Semaphore`
|
|
||||||
* **Vision Providers:** OpenAI (GPT-4o) and Anthropic (Claude 3.5 Sonnet) via native SDKs
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technology References
|
|
||||||
|
|
||||||
- [FastAPI documentation](https://fastapi.tiangolo.com/)
|
|
||||||
- [NiceGUI documentation](https://nicegui.io/documentation)
|
|
||||||
- [PostgreSQL documentation](https://www.postgresql.org/docs/)
|
|
||||||
- [Python asyncio](https://docs.python.org/3/library/asyncio.html#module-asyncio)
|
|
||||||
- [Pydantic Validation](https://pydantic.dev/docs/validation/latest/get-started/)
|
|
||||||
- [Pydantic AI](https://pydantic.dev/docs/ai/overview/)
|
|
||||||
|
|
||||||
## Documentation Index
|
|
||||||
|
|
||||||
- System Overview (this document)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v2.md)
|
|
||||||
- [System Requirements](requirements_v2.md)
|
|
||||||
- [Data model](schema_v2.md)
|
|
||||||
- [Error Handling Policy](error_handling_v2.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v2.md)
|
|
||||||
@@ -0,0 +1,572 @@
|
|||||||
|
# Step 1 Implementation Plan: `config.py` + `models.py` + `db.py`
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Establish the foundational data layer and configuration system that every subsequent MVP step builds on. At the end of this step, the project has a runnable Python package with a validated schema, typed configuration, and a test suite proving the data layer works — before any UI, worker, or AI provider code exists.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. Prerequisite: Project Structure Scaffolding
|
||||||
|
|
||||||
|
Before writing any logic, create the package skeleton so imports work correctly.
|
||||||
|
|
||||||
|
### Files to create (empty `__init__.py` stubs)
|
||||||
|
|
||||||
|
```
|
||||||
|
src/
|
||||||
|
└── transcription/
|
||||||
|
├── __init__.py
|
||||||
|
├── providers/
|
||||||
|
│ └── __init__.py
|
||||||
|
├── services/
|
||||||
|
│ └── __init__.py
|
||||||
|
└── ui/
|
||||||
|
└── __init__.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Files to create (with logic — the Step 1 deliverables)
|
||||||
|
|
||||||
|
```
|
||||||
|
src/transcription/config.py
|
||||||
|
src/transcription/models.py
|
||||||
|
src/transcription/db.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test files to create
|
||||||
|
|
||||||
|
```
|
||||||
|
tests/
|
||||||
|
├── __init__.py
|
||||||
|
├── conftest.py
|
||||||
|
├── test_config.py
|
||||||
|
├── test_models.py
|
||||||
|
└── test_db.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Update `pyproject.toml`
|
||||||
|
|
||||||
|
Add the dependencies that Step 1 requires and won't change later:
|
||||||
|
|
||||||
|
```toml pyproject.toml
|
||||||
|
[project]
|
||||||
|
name = "transcription"
|
||||||
|
version = "0.1.0"
|
||||||
|
description = "Historical document transcription system"
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.12"
|
||||||
|
dependencies = [
|
||||||
|
"openrouter>=0.7.0",
|
||||||
|
"pydantic>=2.13.4",
|
||||||
|
"pydantic-settings>=2.9.1",
|
||||||
|
"sqlmodel>=0.0.25",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"pytest>=8.0",
|
||||||
|
"pytest-asyncio>=0.25",
|
||||||
|
]
|
||||||
|
|
||||||
|
[tool.pytest.ini_options]
|
||||||
|
addopts = "--strict-markers -q"
|
||||||
|
markers = [
|
||||||
|
"unit: pure logic tests with no external dependencies",
|
||||||
|
"integration: tests that touch framework or database contracts",
|
||||||
|
"external: tests that call external services (slow, requires credentials)",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
Key additions:
|
||||||
|
- **`openrouter`** — official OpenRouter Python SDK used for model calls
|
||||||
|
- **`pydantic-settings`** — for `BaseSettings` with env-var loading (this was split out of `pydantic` core in v2)
|
||||||
|
- **`sqlmodel`** — provides SQLModel (which bundles SQLAlchemy + Pydantic model integration) and the SQLite driver
|
||||||
|
- **`pytest` + `pytest-asyncio`** — in `dev` extras for test execution
|
||||||
|
- **`[tool.pytest.ini_options]`** — strict marker checking enabled from the start; markers registered upfront per pytesting skill conventions
|
||||||
|
|
||||||
|
### Delete `hello.py`
|
||||||
|
|
||||||
|
The placeholder file is no longer needed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. `config.py` — Centralized Configuration
|
||||||
|
|
||||||
|
**Satisfies:** REQ-8 (centralized config and logging at startup)
|
||||||
|
|
||||||
|
### Design Decisions
|
||||||
|
|
||||||
|
| Decision | Rationale |
|
||||||
|
|----------|-----------|
|
||||||
|
| Use `pydantic-settings` `BaseSettings` | Type-safe, validates on construction, loads from env vars and `.env` files automatically |
|
||||||
|
| `PROVIDER` constrained to `openrouter` for MVP | Keeps configuration explicit while avoiding premature multi-provider complexity |
|
||||||
|
| `OPENROUTER_API_KEY` required | Matches official SDK docs and avoids ambiguous provider-agnostic naming |
|
||||||
|
| `PROVIDER_MODEL` defaults to `None` | OpenRouter adapter (Step 3) supplies a sensible default when `None` |
|
||||||
|
| `OPENROUTER_HTTP_REFERER` and `OPENROUTER_APP_TITLE` optional | Matches SDK optional app-attribution fields |
|
||||||
|
| `DATABASE_URL` defaults to SQLite | Zero-setup local development; PostgreSQL swap is a single env-var change post-MVP |
|
||||||
|
| `UPLOAD_DIR` and `PROMPT_DIR` as `Path` objects | Enables `.mkdir(parents=True, exist_ok=True)` and path validation at startup |
|
||||||
|
| Logging configured via `logging.config.dictConfig` in `setup_logging()` | Centralized, explicit formatter/handler/root logger topology; called once at startup with `disable_existing_loggers=False` |
|
||||||
|
|
||||||
|
### Proposed Implementation
|
||||||
|
|
||||||
|
```python src/transcription/config.py
|
||||||
|
"""Centralized application configuration.
|
||||||
|
|
||||||
|
All settings are loaded from environment variables (or a .env file)
|
||||||
|
once at startup. Provider-specific defaults (model names, base URLs)
|
||||||
|
are resolved by the provider adapters, not here.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from enum import StrEnum
|
||||||
|
from functools import lru_cache
|
||||||
|
from pathlib import Path
|
||||||
|
import logging
|
||||||
|
import logging.config
|
||||||
|
|
||||||
|
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||||
|
|
||||||
|
|
||||||
|
class Provider(StrEnum):
|
||||||
|
OPENROUTER = "openrouter"
|
||||||
|
|
||||||
|
|
||||||
|
class Settings(BaseSettings):
|
||||||
|
model_config = SettingsConfigDict(
|
||||||
|
env_file=".env",
|
||||||
|
env_file_encoding="utf-8",
|
||||||
|
extra="ignore",
|
||||||
|
)
|
||||||
|
|
||||||
|
# --- AI provider ---
|
||||||
|
provider: Provider = Provider.OPENROUTER
|
||||||
|
openrouter_api_key: str
|
||||||
|
provider_model: str | None = None
|
||||||
|
openrouter_http_referer: str | None = None
|
||||||
|
openrouter_app_title: str | None = None
|
||||||
|
|
||||||
|
# --- persistence ---
|
||||||
|
database_url: str = "sqlite:///./transcription.db"
|
||||||
|
|
||||||
|
# --- filesystem paths ---
|
||||||
|
upload_dir: Path = Path("./uploads")
|
||||||
|
prompt_dir: Path = Path("./prompts")
|
||||||
|
|
||||||
|
|
||||||
|
LOGGING_CONFIG: dict[str, object] = {
|
||||||
|
"version": 1,
|
||||||
|
"disable_existing_loggers": False,
|
||||||
|
"formatters": {
|
||||||
|
"standard": {
|
||||||
|
"format": "%(asctime)s | %(levelname)-8s | %(name)s | %(message)s",
|
||||||
|
"datefmt": "%Y-%m-%d %H:%M:%S",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"handlers": {
|
||||||
|
"console": {
|
||||||
|
"class": "logging.StreamHandler",
|
||||||
|
"formatter": "standard",
|
||||||
|
"stream": "ext://sys.stdout",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": {
|
||||||
|
"level": "INFO",
|
||||||
|
"handlers": ["console"],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@lru_cache(maxsize=1)
|
||||||
|
def get_settings() -> Settings:
|
||||||
|
"""Return the singleton Settings instance.
|
||||||
|
|
||||||
|
Cached so the entire application shares one validated config.
|
||||||
|
"""
|
||||||
|
return Settings()
|
||||||
|
|
||||||
|
|
||||||
|
def setup_logging() -> None:
|
||||||
|
"""Configure root logging once at startup."""
|
||||||
|
logging.config.dictConfig(LOGGING_CONFIG)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key Behaviors
|
||||||
|
|
||||||
|
- **Startup validation**: If `OPENROUTER_API_KEY` is missing from the environment, `Settings()` raises a `ValidationError` immediately — the app won't start with a missing key.
|
||||||
|
- **`.env` support**: Developers can create a `.env` file in the project root for local keys; it's never committed (already covered by the existing `.gitignore` pattern or a new entry).
|
||||||
|
- **`extra="ignore"`**: Unknown env vars don't cause errors, keeping the config resilient to unrelated environment variables.
|
||||||
|
- **`lru_cache`**: `get_settings()` is the single access point. All modules import and call this function rather than constructing `Settings` directly.
|
||||||
|
- **Centralized logging**: `setup_logging()` calls `dictConfig` exactly once at startup; all modules should use `logging.getLogger(__name__)` and avoid `basicConfig`.
|
||||||
|
|
||||||
|
### `.env` template (not committed — add to `.gitignore`)
|
||||||
|
|
||||||
|
```bash .env.example
|
||||||
|
PROVIDER=openrouter
|
||||||
|
OPENROUTER_API_KEY=sk-or-...
|
||||||
|
# PROVIDER_MODEL= # optional: OpenRouter adapter supplies default
|
||||||
|
# OPENROUTER_HTTP_REFERER=https://example.com
|
||||||
|
# OPENROUTER_APP_TITLE=Historical Transcription MVP
|
||||||
|
# DATABASE_URL=sqlite:///./transcription.db
|
||||||
|
# UPLOAD_DIR=./uploads
|
||||||
|
# PROMPT_DIR=./prompts
|
||||||
|
```
|
||||||
|
|
||||||
|
### `.gitignore` addition
|
||||||
|
|
||||||
|
```gitignore .gitignore
|
||||||
|
# ... existing entries ...
|
||||||
|
|
||||||
|
# Environment secrets
|
||||||
|
.env
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. `models.py` — SQLModel Domain Models
|
||||||
|
|
||||||
|
**Satisfies:** REQ-3 (persist and expose job states), REQ-4 (persist transcription output and failure details)
|
||||||
|
|
||||||
|
### Design Decisions
|
||||||
|
|
||||||
|
| Decision | Rationale |
|
||||||
|
|----------|-----------|
|
||||||
|
| Three models: `Document`, `Job`, `Transcript` | Minimal set from MVP Feature 5. One-to-many from Document→Job and one-to-one from Job→Transcript |
|
||||||
|
| `JobStatus` as a `StrEnum` | Readable in the database (`"queued"` not `1`), type-safe in Python, trivially serializable to JSON for the UI |
|
||||||
|
| Status values: `queued`, `processing`, `transcribed`, `failed` | Matches MVP Feature 2 lifecycle. REQ-3 also lists `upload` and `completed` — these are deferred to post-MVP when revision/review workflows exist |
|
||||||
|
| UUIDs for primary keys | Avoids auto-increment collision concerns if we later move to PostgreSQL; safe for distributed ID generation; `uuid4` is simple |
|
||||||
|
| `uploaded_at`, `created_at`, `updated_at` as UTC `datetime` | Timezone-naive UTC by convention for MVP. Sufficient for single-user, single-timezone operation |
|
||||||
|
| `Transcript.text` is nullable | A failed job creates a Transcript with `text=None` and `error_detail` populated, keeping the query model uniform |
|
||||||
|
| Relationships via SQLModel `Relationship` | Enables `document.jobs` and `job.transcript` navigation in service code without manual joins |
|
||||||
|
|
||||||
|
### Proposed Implementation
|
||||||
|
|
||||||
|
- `resource://skills/fastapi-async-sqlalchemy-modernization/document`
|
||||||
|
|
||||||
|
```python src/transcription/models.py
|
||||||
|
"""SQLModel domain models for the transcription system.
|
||||||
|
|
||||||
|
Three models capture the MVP lifecycle:
|
||||||
|
Document → one-to-many → Job → one-to-one → Transcript
|
||||||
|
"""
|
||||||
|
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from enum import StrEnum
|
||||||
|
from uuid import UUID, uuid4
|
||||||
|
|
||||||
|
from sqlmodel import Field, Relationship, SQLModel
|
||||||
|
|
||||||
|
|
||||||
|
class JobStatus(StrEnum):
|
||||||
|
QUEUED = "queued"
|
||||||
|
PROCESSING = "processing"
|
||||||
|
TRANSCRIBED = "transcribed"
|
||||||
|
FAILED = "failed"
|
||||||
|
|
||||||
|
|
||||||
|
class Document(SQLModel, table=True):
|
||||||
|
"""An uploaded document image."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
filename: str
|
||||||
|
file_path: str
|
||||||
|
uploaded_at: datetime = Field(
|
||||||
|
default_factory=lambda: datetime.now(timezone.utc),
|
||||||
|
)
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
jobs: list["Job"] = Relationship(back_populates="document")
|
||||||
|
|
||||||
|
|
||||||
|
class Job(SQLModel, table=True):
|
||||||
|
"""A transcription job tied to a single document."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
document_id: UUID = Field(foreign_key="document.id")
|
||||||
|
status: JobStatus = Field(default=JobStatus.QUEUED)
|
||||||
|
created_at: datetime = Field(
|
||||||
|
default_factory=lambda: datetime.now(timezone.utc),
|
||||||
|
)
|
||||||
|
updated_at: datetime = Field(
|
||||||
|
default_factory=lambda: datetime.now(timezone.utc),
|
||||||
|
)
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
document: Document = Relationship(back_populates="jobs")
|
||||||
|
transcript: "Transcript | None" = Relationship(back_populates="job")
|
||||||
|
|
||||||
|
|
||||||
|
class Transcript(SQLModel, table=True):
|
||||||
|
"""The output of a transcription job."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
job_id: UUID = Field(foreign_key="job.id", unique=True)
|
||||||
|
text: str | None = None
|
||||||
|
error_detail: str | None = None
|
||||||
|
created_at: datetime = Field(
|
||||||
|
default_factory=lambda: datetime.now(timezone.utc),
|
||||||
|
)
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
job: Job = Relationship(back_populates="transcript")
|
||||||
|
```
|
||||||
|
|
||||||
|
### Entity-Relationship Summary
|
||||||
|
|
||||||
|
```
|
||||||
|
┌──────────┐ ┌──────────┐ ┌─────────────┐
|
||||||
|
│ Document │ 1───* │ Job │ 1───1 │ Transcript │
|
||||||
|
├──────────┤ ├──────────┤ ├─────────────┤
|
||||||
|
│ id (PK) │ │ id (PK) │ │ id (PK) │
|
||||||
|
│ filename │ │ doc_id │──FK──▶│ job_id (FK) │
|
||||||
|
│ file_path│ │ status │ │ text │
|
||||||
|
│ uploaded │ │ created │ │ error_detail│
|
||||||
|
│ │ │ updated │ │ created │
|
||||||
|
└──────────┘ └──────────┘ └─────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
### Why Only Four Status Values
|
||||||
|
|
||||||
|
REQ-3 lists six states: `upload`, `queued`, `processing`, `transcribed`, `failed`, `completed`. The MVP simplifies this:
|
||||||
|
|
||||||
|
| REQ-3 State | MVP Treatment |
|
||||||
|
|-------------|---------------|
|
||||||
|
| `upload` | Implicit — the Document record exists before a Job is created. No separate job state needed. |
|
||||||
|
| `queued` | ✅ Included — job created, waiting for worker pickup |
|
||||||
|
| `processing` | ✅ Included — worker is actively transcribing |
|
||||||
|
| `transcribed` | ✅ Included — AI output received and stored |
|
||||||
|
| `failed` | ✅ Included — error captured |
|
||||||
|
| `completed` | Deferred — implies human review/acceptance. In MVP, `transcribed` is the terminal success state. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. `db.py` — Database Engine and Session Management
|
||||||
|
|
||||||
|
**Satisfies:** MVP Feature 5 (SQLite auto-created on first startup)
|
||||||
|
|
||||||
|
### Design Decisions
|
||||||
|
|
||||||
|
| Decision | Rationale |
|
||||||
|
|----------|-----------|
|
||||||
|
| Module-level `create_engine` + `Session` factory | REQ-7 (lifespan-owned resources) is deferred. A module-level engine is adequate for MVP's single-process, single-user operation |
|
||||||
|
| `create_all()` as an explicit function | Called at app startup. MVP auto-creates tables (REQ-10 deferred), but the function is isolated so it's easy to gate behind a flag later |
|
||||||
|
| `get_session()` as a generator | Standard FastAPI/SQLModel pattern — yields a session, ensures cleanup. Compatible with `Depends()` when the API layer arrives in Step 5 |
|
||||||
|
| `echo=False` default | Keeps logs clean. Can be toggled for debugging |
|
||||||
|
|
||||||
|
### Proposed Implementation
|
||||||
|
|
||||||
|
```python src/transcription/db.py
|
||||||
|
"""Database engine, session factory, and schema bootstrap.
|
||||||
|
|
||||||
|
MVP uses SQLite with auto-create-tables at startup.
|
||||||
|
PostgreSQL migration is a post-MVP configuration change.
|
||||||
|
"""
|
||||||
|
import contextlib
|
||||||
|
from collections.abc import Generator
|
||||||
|
|
||||||
|
from sqlmodel import Session, SQLModel, create_engine
|
||||||
|
|
||||||
|
from transcription.config import get_settings
|
||||||
|
|
||||||
|
|
||||||
|
def _build_engine():
|
||||||
|
settings = get_settings()
|
||||||
|
connect_args = {}
|
||||||
|
if settings.database_url.startswith("sqlite"):
|
||||||
|
connect_args["check_same_thread"] = False
|
||||||
|
return create_engine(
|
||||||
|
settings.database_url,
|
||||||
|
echo=False,
|
||||||
|
connect_args=connect_args,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
engine = _build_engine()
|
||||||
|
|
||||||
|
|
||||||
|
def create_all() -> None:
|
||||||
|
"""Create all tables. Called once at application startup."""
|
||||||
|
SQLModel.metadata.create_all(engine)
|
||||||
|
|
||||||
|
|
||||||
|
@contextlib.contextmanager
|
||||||
|
def get_session() -> Generator[Session]:
|
||||||
|
"""Yield a database session and ensure cleanup."""
|
||||||
|
with Session(engine) as session:
|
||||||
|
yield session
|
||||||
|
```
|
||||||
|
|
||||||
|
### SQLite-Specific Note
|
||||||
|
|
||||||
|
`check_same_thread=False` is required for SQLite when the session may be accessed from different threads (e.g., a background worker on a different thread than the request handler). This setting is harmless and ignored for PostgreSQL connection strings.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. Test Plan
|
||||||
|
|
||||||
|
Refer to these resources for rules and guidelines about structure:
|
||||||
|
|
||||||
|
- `resource://skills/pytesting/document`
|
||||||
|
- `resource://catalog/prompts/pytest-scaffold`
|
||||||
|
- `resource://catalog/prompts/pytest-fill-scaffold`
|
||||||
|
|
||||||
|
Hierarchy pattern used in this step:
|
||||||
|
|
||||||
|
```text
|
||||||
|
tests/
|
||||||
|
conftest.py
|
||||||
|
test_config.py
|
||||||
|
TestSettingsLoading
|
||||||
|
test_loads_from_env
|
||||||
|
test_requires_api_key
|
||||||
|
TestProviderSettings
|
||||||
|
test_defaults_to_openrouter
|
||||||
|
test_rejects_invalid_value
|
||||||
|
test_optional_fields_default_to_none
|
||||||
|
TestPathSettings
|
||||||
|
test_path_fields_are_path_objects
|
||||||
|
test_models.py
|
||||||
|
TestDocumentModel
|
||||||
|
test_can_be_persisted
|
||||||
|
test_defaults_are_populated
|
||||||
|
TestJobModel
|
||||||
|
test_can_be_created_for_document
|
||||||
|
test_defaults_are_populated
|
||||||
|
test_transitions_to_transcribed
|
||||||
|
test_transitions_to_failed
|
||||||
|
TestTranscriptModel
|
||||||
|
test_success_record_persists
|
||||||
|
test_failure_record_persists
|
||||||
|
test_job_id_is_unique
|
||||||
|
TestRelationships
|
||||||
|
test_document_exposes_jobs
|
||||||
|
test_job_exposes_transcript
|
||||||
|
test_db.py
|
||||||
|
TestSchemaBootstrap
|
||||||
|
test_create_all_creates_expected_tables
|
||||||
|
TestSessionFactory
|
||||||
|
test_get_session_yields_session
|
||||||
|
test_session_is_closed_after_generator_exit
|
||||||
|
```
|
||||||
|
|
||||||
|
### `tests/conftest.py` — Shared Fixtures
|
||||||
|
|
||||||
|
```python tests/conftest.py
|
||||||
|
"""Shared test fixtures.
|
||||||
|
|
||||||
|
Every test gets a fresh in-memory SQLite database so tests are
|
||||||
|
isolated, fast, and leave no artifacts on disk.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from sqlmodel import Session, SQLModel, create_engine
|
||||||
|
from sqlmodel.pool import StaticPool
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def session():
|
||||||
|
"""Provide a clean database session for each test."""
|
||||||
|
engine = create_engine(
|
||||||
|
"sqlite://",
|
||||||
|
connect_args={"check_same_thread": False},
|
||||||
|
poolclass=StaticPool,
|
||||||
|
)
|
||||||
|
SQLModel.metadata.create_all(engine)
|
||||||
|
with Session(engine) as session:
|
||||||
|
yield session
|
||||||
|
```
|
||||||
|
|
||||||
|
`StaticPool` ensures a single in-memory SQLite connection is shared across threads, which is required when `TestClient` (Step 5) spawns threads that would otherwise get separate in-memory databases. Establishing it now keeps the fixture stable across all future steps.
|
||||||
|
|
||||||
|
### `tests/test_config.py` — Configuration Hierarchy
|
||||||
|
|
||||||
|
| Class | Method | What It Verifies |
|
||||||
|
|------|--------|------------------|
|
||||||
|
| `TestSettingsLoading` | `test_loads_from_env` | `Settings` constructs successfully when `OPENROUTER_API_KEY` is set via env var |
|
||||||
|
| `TestSettingsLoading` | `test_requires_api_key` | `Settings()` raises `ValidationError` when `OPENROUTER_API_KEY` is missing |
|
||||||
|
| `TestProviderSettings` | `test_defaults_to_openrouter` | Default provider is `openrouter` when not explicitly set |
|
||||||
|
| `TestProviderSettings` | `test_rejects_invalid_value` | Setting `PROVIDER=invalid` raises `ValidationError` |
|
||||||
|
| `TestProviderSettings` | `test_optional_fields_default_to_none` | `provider_model`, `openrouter_http_referer`, and `openrouter_app_title` are `None` when unset |
|
||||||
|
| `TestPathSettings` | `test_path_fields_are_path_objects` | `upload_dir` and `prompt_dir` are `Path` instances |
|
||||||
|
|
||||||
|
### `tests/test_models.py` — Model & Relationship Hierarchy
|
||||||
|
|
||||||
|
| Class | Method | What It Verifies |
|
||||||
|
|------|--------|------------------|
|
||||||
|
| `TestDocumentModel` | `test_can_be_persisted` | A `Document` can be persisted and read back with correct fields |
|
||||||
|
| `TestDocumentModel` | `test_defaults_are_populated` | `id` is auto-generated UUID, `uploaded_at` is populated |
|
||||||
|
| `TestJobModel` | `test_can_be_created_for_document` | A `Job` linked to a `Document` via FK persists correctly |
|
||||||
|
| `TestJobModel` | `test_defaults_are_populated` | Default status is `queued`, `created_at` and `updated_at` are populated |
|
||||||
|
| `TestJobModel` | `test_transitions_to_transcribed` | Status can be updated from `queued` → `processing` → `transcribed` |
|
||||||
|
| `TestJobModel` | `test_transitions_to_failed` | Status can be updated from `processing` → `failed` |
|
||||||
|
| `TestTranscriptModel` | `test_success_record_persists` | A `Transcript` with `text` set and `error_detail=None` persists correctly |
|
||||||
|
| `TestTranscriptModel` | `test_failure_record_persists` | A `Transcript` with `text=None` and `error_detail` set persists correctly |
|
||||||
|
| `TestRelationships` | `test_document_exposes_jobs` | `document.jobs` returns the linked `Job` list |
|
||||||
|
| `TestRelationships` | `test_job_exposes_transcript` | `job.transcript` returns the linked `Transcript` |
|
||||||
|
| `TestTranscriptModel` | `test_job_id_is_unique` | Inserting two transcripts with the same `job_id` raises an integrity error |
|
||||||
|
|
||||||
|
### `tests/test_db.py` — Database Bootstrap Hierarchy
|
||||||
|
|
||||||
|
| Class | Method | What It Verifies |
|
||||||
|
|------|--------|------------------|
|
||||||
|
| `TestSchemaBootstrap` | `test_create_all_creates_expected_tables` | After `create_all()`, the expected tables (`document`, `job`, `transcript`) exist in the database |
|
||||||
|
| `TestSessionFactory` | `test_get_session_yields_session` | `get_session()` yields a usable `Session` object |
|
||||||
|
| `TestSessionFactory` | `test_session_is_closed_after_generator_exit` | After the generator is exhausted, the session is closed |
|
||||||
|
|
||||||
|
### Marker Strategy (Step 1)
|
||||||
|
|
||||||
|
- Markers (`unit`, `integration`, `external`) are registered upfront in `pyproject.toml` with `--strict-markers` enabled, per pytesting skill conventions.
|
||||||
|
- All Step 1 tests are unmarked — they run in the default lane since they are fast, deterministic, and have no external dependencies.
|
||||||
|
- When slower integration or external tests are introduced in later steps, apply explicit markers and keep test names unchanged.
|
||||||
|
|
||||||
|
### Test Workflow
|
||||||
|
|
||||||
|
Follow the two-phase approach from `resource://catalog/prompts/pytest-scaffold` and `resource://catalog/prompts/pytest-fill-scaffold`:
|
||||||
|
|
||||||
|
1. **Scaffold phase**: Create test files with class hierarchy, method names, and one-line docstrings only. Validate collection:
|
||||||
|
- `uv run pytest --collect-only -q`
|
||||||
|
2. **Fill phase**: Implement assertions, fixtures, and minimal test data. Treat scaffolded names and docstrings as locked. Validate execution:
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
Scaffolded structure is treated as a stable baseline — do not rename, move, merge, split, or re-nest tests once the scaffold is reviewed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. Step 1 Completion Checklist
|
||||||
|
|
||||||
|
When all of the following are true, Step 1 is done and Step 2 can begin:
|
||||||
|
|
||||||
|
| # | Criterion | How to Verify |
|
||||||
|
|---|-----------|---------------|
|
||||||
|
| 1 | `src/transcription/` package exists with `config.py`, `models.py`, `db.py` | `ls` / file inspection |
|
||||||
|
| 2 | Empty `__init__.py` stubs exist for `providers/`, `services/`, `ui/` | `ls` / file inspection |
|
||||||
|
| 3 | `Settings` loads from environment and validates `OPENROUTER_API_KEY` is present | `test_config.py` passes |
|
||||||
|
| 4 | `Document`, `Job`, `Transcript` models create tables in SQLite | `test_models.py` passes |
|
||||||
|
| 5 | `JobStatus` enum has exactly four values: `queued`, `processing`, `transcribed`, `failed` | `test_models.py` passes |
|
||||||
|
| 6 | Foreign key relationships work: Document→Job→Transcript | `test_models.py` passes |
|
||||||
|
| 7 | `create_all()` bootstraps the schema; `get_session()` yields a working session | `test_db.py` passes |
|
||||||
|
| 8 | All tests pass: `uv run pytest -q` | CI / local run |
|
||||||
|
| 9 | `hello.py` is deleted | File inspection |
|
||||||
|
| 10 | `pyproject.toml` includes `openrouter`, `sqlmodel`, `pydantic-settings`, `pytest`, `pytest-asyncio` | File inspection |
|
||||||
|
| 10a | `pyproject.toml` has `[tool.pytest.ini_options]` with `--strict-markers` and registered markers | File inspection |
|
||||||
|
| 11 | `.env.example` documents all config vars; `.env` is in `.gitignore` | File inspection |
|
||||||
|
| 12 | `setup_logging()` uses `logging.config.dictConfig` with centralized formatter/handler/root config | File inspection |
|
||||||
|
| 13 | `uv run pytest --collect-only -q` shows expected test hierarchy | Local run |
|
||||||
|
| 14 | `uv run pytest -q` passes all tests | Local run |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. What This Step Does NOT Include
|
||||||
|
|
||||||
|
Explicitly out of scope to prevent scope creep:
|
||||||
|
|
||||||
|
| Excluded | Reason |
|
||||||
|
|----------|--------|
|
||||||
|
| FastAPI / NiceGUI app entrypoint | Step 5 |
|
||||||
|
| Additional provider adapters beyond OpenRouter | Post-MVP |
|
||||||
|
| Upload service logic | Step 4 |
|
||||||
|
| Worker / background processing | Step 4 |
|
||||||
|
| Transcription prompt files | Step 2 |
|
||||||
|
| Alembic or migration tooling | Post-MVP (REQ-10 deferred) |
|
||||||
|
| Async session factory | Post-MVP (REQ-7 deferred) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This plan produces a fully tested, importable data foundation. Every subsequent step imports from `transcription.config`, `transcription.models`, and `transcription.db` without modification.
|
||||||
@@ -0,0 +1,278 @@
|
|||||||
|
## Step 2: prompts/transcribe_document.md
|
||||||
|
|
||||||
|
### Goal
|
||||||
|
|
||||||
|
Implement the MVP prompt artifact system by creating a curated transcription prompt file:
|
||||||
|
|
||||||
|
- `prompts/transcribe_document.md`
|
||||||
|
|
||||||
|
This step primarily satisfies:
|
||||||
|
|
||||||
|
- **REQ-12**: prompts stored as individual Markdown artifacts
|
||||||
|
- MVP Feature 3: prompt-driven verbatim transcription behavior grounded in `docs/intent.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope for Step 2
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
1. Create prompt artifact directory and first prompt file.
|
||||||
|
2. Encode transcription rules from `docs/intent.md` into a model-facing prompt.
|
||||||
|
3. Define stable prompt structure so future revisions are easy to diff/review.
|
||||||
|
4. Add lightweight tests that validate artifact presence and baseline quality constraints.
|
||||||
|
5. Update docs/README references so Step 3 can consume prompt file directly.
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Provider integration logic (Step 3)
|
||||||
|
- Worker/job orchestration (Step 4)
|
||||||
|
- UI behavior (Step 5)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Proposed Deliverables
|
||||||
|
|
||||||
|
1. **`prompts/transcribe_document.md`**
|
||||||
|
- production prompt text for historical document transcription
|
||||||
|
|
||||||
|
2. **`prompts/README.md`** (recommended)
|
||||||
|
- conventions for prompt files, revision policy, naming
|
||||||
|
|
||||||
|
3. **`tests/test_prompts.py`** (recommended)
|
||||||
|
- artifact existence + structure checks
|
||||||
|
|
||||||
|
4. **Small docs update** (README or docs reference)
|
||||||
|
- indicate that prompts are file-based and loaded from `PROMPT_DIR`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Work Breakdown
|
||||||
|
|
||||||
|
### 1) Create prompt artifact folder and canonical file
|
||||||
|
- Add `prompts/` at repo root.
|
||||||
|
- Add `transcribe_document.md` as the first curated artifact.
|
||||||
|
- Keep filename stable; this becomes the default in Step 3 unless overridden.
|
||||||
|
|
||||||
|
### 2) Author prompt content using a strict, sectioned format
|
||||||
|
Use section headers so future diffs are clean and policy changes are isolated.
|
||||||
|
|
||||||
|
Suggested sections:
|
||||||
|
|
||||||
|
1. **Purpose**
|
||||||
|
- verbatim scholarly transcription of historical documents
|
||||||
|
|
||||||
|
2. **Output requirements**
|
||||||
|
- plain text only
|
||||||
|
- no summaries, no paraphrasing
|
||||||
|
- preserve reading order and meaningful structure
|
||||||
|
|
||||||
|
3. **Core fidelity rules**
|
||||||
|
- preserve original wording and punctuation
|
||||||
|
- don’t silently normalize grammar/spelling
|
||||||
|
- no invented content
|
||||||
|
|
||||||
|
4. **Issue-handling rules (mapped from Intent table)**
|
||||||
|
- misspellings with `[sic]`
|
||||||
|
- missing words with `[word]`
|
||||||
|
- uncertainty with `[guess?]`
|
||||||
|
- illegible with `[illegible]` / reason tags
|
||||||
|
- crossed-out text as `[deleted: ...]`
|
||||||
|
- inserted text as `[inserted: ...]`
|
||||||
|
- superscripts handling guidance
|
||||||
|
- non-text elements as `[description]`
|
||||||
|
- marginalia format `[written in left margin: ...]`
|
||||||
|
- line-break hyphen rejoin behavior
|
||||||
|
- capitalization policy
|
||||||
|
- hierarchical outline preservation (including unusual numbering)
|
||||||
|
|
||||||
|
5. **Confidence/ambiguity policy**
|
||||||
|
- prefer explicit uncertainty markers over hallucination
|
||||||
|
|
||||||
|
6. **Final self-checklist for model**
|
||||||
|
- did I preserve structure?
|
||||||
|
- did I mark uncertain text?
|
||||||
|
- did I avoid silent corrections?
|
||||||
|
|
||||||
|
### 3) Add prompt-library conventions (`prompts/README.md`)
|
||||||
|
Recommended conventions:
|
||||||
|
- one prompt per file
|
||||||
|
- snake_case names
|
||||||
|
- each file starts with purpose + behavior contract
|
||||||
|
- iterative edits, one prompt per PR where possible
|
||||||
|
- no secrets in prompt files
|
||||||
|
|
||||||
|
### 4) Add tests for prompt assets (`tests/test_prompts.py`)
|
||||||
|
Keep tests robust but not brittle.
|
||||||
|
|
||||||
|
Recommended tests:
|
||||||
|
1. `test_prompt_file_exists`
|
||||||
|
2. `test_prompt_file_is_not_empty`
|
||||||
|
3. `test_prompt_mentions_verbatim_behavior`
|
||||||
|
4. `test_prompt_includes_uncertainty_and_illegible_markers`
|
||||||
|
5. `test_prompt_includes_deleted_and_inserted_conventions`
|
||||||
|
|
||||||
|
Avoid exact full-text matching; verify key semantic anchors only.
|
||||||
|
|
||||||
|
### 5) Optional config alignment check
|
||||||
|
Current config already has:
|
||||||
|
- `prompt_dir: Path = Path("./prompts")`
|
||||||
|
|
||||||
|
In Step 2, ensure docs reflect this and that Step 3 will resolve:
|
||||||
|
- `PROMPT_DIR / "transcribe_document.md"`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task-by-Task Execution Checklist
|
||||||
|
|
||||||
|
## Phase A — Scaffold files
|
||||||
|
|
||||||
|
- [ ] **A1. Create prompt directory**
|
||||||
|
- Path: `prompts/`
|
||||||
|
- Verify: directory exists at repo root
|
||||||
|
|
||||||
|
- [ ] **A2. Create canonical prompt file**
|
||||||
|
- Path: `prompts/transcribe_document.md`
|
||||||
|
- Verify: file exists and is non-empty
|
||||||
|
|
||||||
|
- [ ] **A3. (Recommended) Create prompt library README**
|
||||||
|
- Path: `prompts/README.md`
|
||||||
|
- Verify: includes naming + revision conventions
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — Author prompt content (core work)
|
||||||
|
|
||||||
|
- [ ] **B1. Add Purpose section**
|
||||||
|
- States verbatim historical transcription objective
|
||||||
|
- Explicitly disallows summarization/paraphrase
|
||||||
|
|
||||||
|
- [ ] **B2. Add Output Contract section**
|
||||||
|
- Plain text output expectation
|
||||||
|
- Preserve meaningful structure and reading order
|
||||||
|
- No fabricated text
|
||||||
|
|
||||||
|
- [ ] **B3. Add Rule Set from `docs/intent.md`**
|
||||||
|
- Misspellings/errors: `[sic]`
|
||||||
|
- Missing words: `[word]`
|
||||||
|
- Uncertain readings: `[guess?]`
|
||||||
|
- Illegible regions: `[illegible]` / reason labels
|
||||||
|
- Crossed-out text: `[deleted: ...]`
|
||||||
|
- Squeezed-in text: `[inserted: ...]`
|
||||||
|
- Superscripts/abbrev handling guidance
|
||||||
|
- Non-text visuals: bracketed descriptive labels
|
||||||
|
- Marginalia formatting cue
|
||||||
|
- Rejoin line-break hyphenated words silently
|
||||||
|
- Ambiguous capitalization policy
|
||||||
|
- Hierarchical outline numbering preservation
|
||||||
|
|
||||||
|
- [ ] **B4. Add Ambiguity and Confidence policy**
|
||||||
|
- “Mark uncertainty instead of guessing”
|
||||||
|
- “Never silently normalize uncertain passages”
|
||||||
|
|
||||||
|
- [ ] **B5. Add Final Self-Check section**
|
||||||
|
- Checklist for fidelity, uncertainty labeling, and format compliance
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Add validations (tests)
|
||||||
|
|
||||||
|
- [ ] **C1. Create prompt tests file**
|
||||||
|
- Path: `tests/test_prompts.py`
|
||||||
|
|
||||||
|
- [ ] **C2. Add existence/health checks**
|
||||||
|
- Prompt file exists
|
||||||
|
- Prompt file has content (non-whitespace)
|
||||||
|
|
||||||
|
- [ ] **C3. Add semantic anchor checks**
|
||||||
|
- Mentions verbatim behavior
|
||||||
|
- Mentions uncertainty marker pattern (`?` in brackets conceptually)
|
||||||
|
- Mentions illegible handling
|
||||||
|
- Mentions deleted/inserted conventions
|
||||||
|
|
||||||
|
- [ ] **C4. Keep tests resilient**
|
||||||
|
- Avoid exact full-file snapshot assertions
|
||||||
|
- Assert required concepts, not precise phrasing
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Documentation alignment
|
||||||
|
|
||||||
|
- [ ] **D1. Update top-level docs/README reference**
|
||||||
|
- Mention that prompts live in `prompts/`
|
||||||
|
- Mention Step 3 loads from `PROMPT_DIR`
|
||||||
|
|
||||||
|
- [ ] **D2. Confirm config compatibility**
|
||||||
|
- `src/transcription/config.py` already uses `prompt_dir = Path("./prompts")`
|
||||||
|
- No code change needed unless naming/path mismatch appears
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — Verification
|
||||||
|
|
||||||
|
- [ ] **E1. Run targeted test file**
|
||||||
|
- `uv run pytest tests/test_prompts.py -q`
|
||||||
|
|
||||||
|
- [ ] **E2. Run full suite**
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
- [ ] **E3. Confirm no regressions**
|
||||||
|
- All existing tests still green (expected: previous 20 + new prompt tests)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase F — Commit plan (recommended granularity)
|
||||||
|
|
||||||
|
- [ ] **F1. Commit 1: scaffold**
|
||||||
|
- `prompts/transcribe_document.md` (initial structure)
|
||||||
|
- `prompts/README.md` (if included)
|
||||||
|
|
||||||
|
- [ ] **F2. Commit 2: finalized prompt content**
|
||||||
|
- full rule-complete prompt text
|
||||||
|
|
||||||
|
- [ ] **F3. Commit 3: tests + docs alignment**
|
||||||
|
- `tests/test_prompts.py`
|
||||||
|
- README/docs mention of prompt artifact pattern
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Done Criteria (quick gate)
|
||||||
|
|
||||||
|
- [ ] Canonical prompt exists and is curated for verbatim transcription.
|
||||||
|
- [ ] Prompt encodes all high-value handling rules from `docs/intent.md`.
|
||||||
|
- [ ] Prompt tests pass.
|
||||||
|
- [ ] Full project tests pass with `uv`.
|
||||||
|
- [ ] Ready for Step 3 provider integration.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Acceptance Criteria (Definition of Done)
|
||||||
|
|
||||||
|
Step 2 is complete when all are true:
|
||||||
|
|
||||||
|
1. `prompts/transcribe_document.md` exists and is committed.
|
||||||
|
2. Prompt includes all critical handling rules from `docs/intent.md`.
|
||||||
|
3. Prompt is structured with stable section headings for future curation.
|
||||||
|
4. Prompt tests pass under `uv run pytest -q`.
|
||||||
|
5. Existing tests remain green (total suite still passes).
|
||||||
|
6. Docs indicate prompt artifact location and curation policy.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk: prompt too vague → hallucinated reconstructions**
|
||||||
|
- Mitigation: explicit uncertainty/illegible conventions and “no invention” rule.
|
||||||
|
|
||||||
|
2. **Risk: prompt too rigid for mixed document types**
|
||||||
|
- Mitigation: include neutral defaults + clear annotation formats.
|
||||||
|
|
||||||
|
3. **Risk: brittle tests block iterative prompt tuning**
|
||||||
|
- Mitigation: test semantic anchors, not exact wording.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 3
|
||||||
|
|
||||||
|
After Step 2, Step 3 can immediately:
|
||||||
|
1. Load `transcribe_document.md` from `PROMPT_DIR`
|
||||||
|
2. Inject prompt into OpenRouter request
|
||||||
|
3. Start validating real transcription behavior with minimal glue code
|
||||||
@@ -0,0 +1,236 @@
|
|||||||
|
## Step 3: services/transcription.py + providers/
|
||||||
|
|
||||||
|
### Objective
|
||||||
|
|
||||||
|
Implement the **AI transcription integration layer** so the app can:
|
||||||
|
|
||||||
|
1. Read the curated prompt from `PROMPT_DIR`
|
||||||
|
2. Send prompt + image to the configured provider (OpenRouter)
|
||||||
|
3. Return normalized transcription output (or structured failure)
|
||||||
|
|
||||||
|
This corresponds to MVP Step 3 from `docs/mvp.md`:
|
||||||
|
- `services/transcription.py`
|
||||||
|
- `providers/` adapter(s)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope for Step 3
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
- Provider abstraction and OpenRouter adapter
|
||||||
|
- Prompt file loading utility in service layer
|
||||||
|
- Image payload preparation
|
||||||
|
- One high-level transcription service function usable by Step 4 worker
|
||||||
|
- Unit tests (mocked provider SDK, no external calls)
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Job polling/background loop (Step 4)
|
||||||
|
- DB status transition orchestration in worker loop (Step 4)
|
||||||
|
- UI invocation/wiring (Step 5)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planned Deliverables
|
||||||
|
|
||||||
|
### Source files
|
||||||
|
- `src/transcription/providers/base.py`
|
||||||
|
- `src/transcription/providers/openrouter.py`
|
||||||
|
- `src/transcription/providers/__init__.py` (exports + factory)
|
||||||
|
- `src/transcription/services/transcription.py`
|
||||||
|
- `src/transcription/services/__init__.py` (optional export)
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- `tests/providers/test_openrouter.py`
|
||||||
|
- `tests/services/test_transcription.py`
|
||||||
|
|
||||||
|
### Test directory convention
|
||||||
|
- Mirror source domains under `tests/`.
|
||||||
|
- Provider adapter tests live under `tests/providers/`.
|
||||||
|
- Service-layer tests live under `tests/services/`.
|
||||||
|
- Prefer one focused test module per production module (for Step 3: `test_openrouter.py`, `test_transcription.py`).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Design Decisions (before coding)
|
||||||
|
|
||||||
|
1. **Provider interface first**
|
||||||
|
- Define a stable contract independent of SDK specifics.
|
||||||
|
- Prevent Step 4 from depending on raw SDK response shapes.
|
||||||
|
|
||||||
|
2. **Service returns normalized result object**
|
||||||
|
- Include: `text`, `provider`, `model`, `raw_error`/exception metadata.
|
||||||
|
- Worker can map this cleanly to `Transcript` and `JobStatus`.
|
||||||
|
|
||||||
|
3. **Prompt loaded from file at call time**
|
||||||
|
- Uses `get_settings().prompt_dir / "transcribe_document.md"`.
|
||||||
|
- Keeps prompt edits hot-swappable without code changes.
|
||||||
|
|
||||||
|
4. **Clear exception boundary**
|
||||||
|
- SDK/network/model failures become predictable domain exceptions:
|
||||||
|
- `ProviderError`
|
||||||
|
- `PromptLoadError`
|
||||||
|
- `TranscriptionError` (optional top-level wrapper)
|
||||||
|
|
||||||
|
5. **Model resolution policy**
|
||||||
|
- Use `settings.provider_model` if set
|
||||||
|
- Otherwise use adapter default constant (e.g., vision-capable model slug)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task-by-Task Execution Checklist
|
||||||
|
|
||||||
|
## Phase A — Provider contract
|
||||||
|
|
||||||
|
- [ ] Create `src/transcription/providers/base.py`
|
||||||
|
- [ ] Define protocol/ABC for transcription providers:
|
||||||
|
- [ ] method signature accepts prompt text + image bytes (or data URL) + mime type
|
||||||
|
- [ ] returns normalized text result (and optional metadata)
|
||||||
|
- [ ] Define shared provider exceptions:
|
||||||
|
- [ ] `ProviderError`
|
||||||
|
- [ ] optional subclasses (`ProviderAuthError`, `ProviderResponseError`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — OpenRouter adapter
|
||||||
|
|
||||||
|
- [ ] Create `src/transcription/providers/openrouter.py`
|
||||||
|
- [ ] Implement `OpenRouterTranscriptionProvider` with:
|
||||||
|
- [ ] config-driven API key usage
|
||||||
|
- [ ] optional referer/title attribution headers
|
||||||
|
- [ ] model resolution fallback when `provider_model` is unset
|
||||||
|
- [ ] Implement request building:
|
||||||
|
- [ ] prompt included as instruction content
|
||||||
|
- [ ] image included in supported format for vision call
|
||||||
|
- [ ] Implement response parsing:
|
||||||
|
- [ ] extract final transcript text from SDK response
|
||||||
|
- [ ] validate non-empty text
|
||||||
|
- [ ] Wrap SDK failures into `ProviderError` with clean message
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Provider factory
|
||||||
|
|
||||||
|
- [ ] Update `src/transcription/providers/__init__.py`
|
||||||
|
- [ ] Add `get_transcription_provider()` factory:
|
||||||
|
- [ ] reads `settings.provider`
|
||||||
|
- [ ] returns OpenRouter adapter for `openrouter`
|
||||||
|
- [ ] raises explicit error for unsupported provider values
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Transcription service (Step 3 core)
|
||||||
|
|
||||||
|
- [ ] Create `src/transcription/services/transcription.py`
|
||||||
|
- [ ] Add prompt loader function:
|
||||||
|
- [ ] default file: `transcribe_document.md`
|
||||||
|
- [ ] raises `PromptLoadError` on missing/empty file
|
||||||
|
- [ ] Add image loader/validator:
|
||||||
|
- [ ] path existence check
|
||||||
|
- [ ] allowed mime detection (`.jpg/.jpeg/.png/.tiff/.pdf` policy aligned to MVP)
|
||||||
|
- [ ] Add high-level function (name example):
|
||||||
|
- [ ] `transcribe_document_image(image_path, prompt_name="transcribe_document.md")`
|
||||||
|
- [ ] loads prompt + image
|
||||||
|
- [ ] calls provider from factory
|
||||||
|
- [ ] returns normalized transcription result object
|
||||||
|
- [ ] Add structured logging at key boundaries:
|
||||||
|
- [ ] prompt loaded
|
||||||
|
- [ ] provider invoked
|
||||||
|
- [ ] success/failure outcome (no sensitive data in logs)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — Tests (two-phase scaffold -> fill)
|
||||||
|
|
||||||
|
### Required execution resources
|
||||||
|
|
||||||
|
Load and reference these directly during test planning/implementation so the two-phase flow is enforced:
|
||||||
|
|
||||||
|
- [ ] `resource://catalog/prompts/pytest-scaffold`
|
||||||
|
- [ ] `resource://prompts/pytest-scaffold/document`
|
||||||
|
- [ ] `resource://catalog/prompts/pytest-fill-scaffold`
|
||||||
|
- [ ] `resource://prompts/pytest-fill-scaffold/document`
|
||||||
|
|
||||||
|
### Phase E1 — Scaffold test structure first
|
||||||
|
|
||||||
|
Prompt: `resource://catalog/prompts/pytest-scaffold`
|
||||||
|
|
||||||
|
Suggested arguments:
|
||||||
|
- [ ] `target_modules` = `src/transcription/providers/openrouter.py`, `src/transcription/services/transcription.py`
|
||||||
|
- [ ] `mode` = `scaffold`
|
||||||
|
- [ ] `path_strategy` = `src-to-tests-mirror`
|
||||||
|
- [ ] `naming_style` = `concise-behavior`
|
||||||
|
|
||||||
|
Expected scaffold outcomes:
|
||||||
|
- [ ] `tests/providers/test_openrouter.py` exists with class/method skeletons and one-line docstrings
|
||||||
|
- [ ] `tests/services/test_transcription.py` exists with class/method skeletons and one-line docstrings
|
||||||
|
- [ ] collection succeeds on scaffold-only tests
|
||||||
|
|
||||||
|
Scaffold coverage targets:
|
||||||
|
- [ ] adapter initializes from settings
|
||||||
|
- [ ] model fallback when `provider_model is None`
|
||||||
|
- [ ] referer/title options included when set
|
||||||
|
- [ ] successful SDK response parses transcript text
|
||||||
|
- [ ] SDK exception maps to `ProviderError`
|
||||||
|
- [ ] empty/invalid response maps to `ProviderError`
|
||||||
|
- [ ] prompt loader reads canonical prompt file
|
||||||
|
- [ ] missing prompt raises `PromptLoadError`
|
||||||
|
- [ ] transcription function loads file and calls provider once
|
||||||
|
- [ ] image path missing raises clear error
|
||||||
|
- [ ] provider error is propagated/wrapped predictably
|
||||||
|
- [ ] returned result includes transcript text and metadata
|
||||||
|
|
||||||
|
### Phase E2 — Fill scaffolded tests with assertions
|
||||||
|
|
||||||
|
Prompt: `resource://catalog/prompts/pytest-fill-scaffold`
|
||||||
|
|
||||||
|
Suggested arguments:
|
||||||
|
- [ ] `target_files` = `tests/providers/test_openrouter.py`, `tests/services/test_transcription.py`
|
||||||
|
- [ ] `stack` = `pure-python`
|
||||||
|
- [ ] `strategy` = `minimal`
|
||||||
|
- [ ] `marker_lane` = `unit`
|
||||||
|
|
||||||
|
Fill constraints:
|
||||||
|
- [ ] preserve scaffold class/method names and one-line docstrings
|
||||||
|
- [ ] keep mocks to an absolute minimum; mock only network boundaries and non-deterministic failures
|
||||||
|
- [ ] keep one behavior target per test method
|
||||||
|
|
||||||
|
> Default suite should remain deterministic and fast, but mocking should be minimal and intentional.
|
||||||
|
|
||||||
|
### Optional real-endpoint validation lane
|
||||||
|
|
||||||
|
- [ ] Add an opt-in integration lane for real provider calls (for example `@pytest.mark.integration` and `@pytest.mark.live_api`).
|
||||||
|
- [ ] Gate live tests behind explicit env vars (for example `OPENROUTER_API_KEY`, optional `RUN_LIVE_API_TESTS=1`).
|
||||||
|
- [ ] Exclude live tests from default CI/local runs unless explicitly requested.
|
||||||
|
- [ ] Keep at least one thin smoke path that can validate request/response compatibility against the real endpoint.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase F — Verification commands
|
||||||
|
|
||||||
|
- [ ] E1 scaffold validation: `uv run pytest --collect-only -q`
|
||||||
|
- [ ] E2 fill validation (unit lane): `uv run pytest -m unit -q`
|
||||||
|
- [ ] E2 targeted provider file: `uv run pytest tests/providers/test_openrouter.py -q`
|
||||||
|
- [ ] E2 targeted service file: `uv run pytest tests/services/test_transcription.py -q`
|
||||||
|
- [ ] E2 final full-suite check: `uv run pytest -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Notes / Guardrails
|
||||||
|
|
||||||
|
- Avoid coupling Step 3 service to DB models directly (that belongs in Step 4 orchestration).
|
||||||
|
- Do not silently swallow provider errors.
|
||||||
|
- Keep prompt filename stable (`transcribe_document.md`) unless explicitly parameterized.
|
||||||
|
- Keep request/response normalization inside provider adapter, not worker/UI layers.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Definition of Done (Step 3)
|
||||||
|
|
||||||
|
Step 3 is done when:
|
||||||
|
|
||||||
|
1. Provider abstraction exists and OpenRouter adapter is implemented.
|
||||||
|
2. Service can transcribe a local image using prompt file content.
|
||||||
|
3. Failures are returned as structured exceptions, not raw SDK traceback noise.
|
||||||
|
4. Unit tests for provider and service pass.
|
||||||
|
5. Full suite remains green under `uv run pytest -q`.
|
||||||
|
6. Step 4 can call a single service function to process queued jobs.
|
||||||
@@ -0,0 +1,262 @@
|
|||||||
|
## Step 4: `services/upload.py` + `worker.py`
|
||||||
|
|
||||||
|
### Objective
|
||||||
|
|
||||||
|
Implement the MVP upload and background-processing pipeline so the system can:
|
||||||
|
|
||||||
|
1. Save uploaded files into `UPLOAD_DIR`
|
||||||
|
2. Create `Document` + `Job(status="queued")`
|
||||||
|
3. Process queued jobs in a worker loop:
|
||||||
|
- `queued -> processing`
|
||||||
|
- call Step 3 transcription service
|
||||||
|
- persist `Transcript`
|
||||||
|
- finalize as `transcribed` or `failed`
|
||||||
|
|
||||||
|
This step advances MVP Feature 1 + Feature 2 and supports REQ-1, REQ-2, REQ-3, REQ-4, REQ-6.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
- `src/transcription/services/upload.py`
|
||||||
|
- `src/transcription/worker.py`
|
||||||
|
- Upload persistence logic and initial job creation
|
||||||
|
- Worker polling and single-job lifecycle execution
|
||||||
|
- Deterministic test coverage for upload + worker (default suite)
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- UI integration and pages (Step 5)
|
||||||
|
- Queue infrastructure beyond in-process loop
|
||||||
|
- Async DB/session architecture refactor
|
||||||
|
- Broad production hardening beyond MVP needs
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planned Deliverables
|
||||||
|
|
||||||
|
### Source files
|
||||||
|
- `src/transcription/services/upload.py`
|
||||||
|
- `src/transcription/worker.py`
|
||||||
|
- `src/transcription/services/__init__.py` (export updates as needed)
|
||||||
|
|
||||||
|
### Test files
|
||||||
|
- `tests/services/test_upload.py`
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
|
||||||
|
### Optional external lane (already present pattern)
|
||||||
|
- reuse `external` marker for live-provider checks where appropriate
|
||||||
|
- keep external out of default lane
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Required MCP Prompt References (for test workflow)
|
||||||
|
|
||||||
|
Apply these resources directly during Step 4 test creation:
|
||||||
|
|
||||||
|
1. `resource://catalog/prompts/pytest-scaffold`
|
||||||
|
2. `resource://prompts/pytest-scaffold/document`
|
||||||
|
3. `resource://catalog/prompts/pytest-fill-scaffold`
|
||||||
|
4. `resource://prompts/pytest-fill-scaffold/document`
|
||||||
|
|
||||||
|
And (as referenced by those prompts) apply relevant pytest skill references for:
|
||||||
|
- naming/hierarchy
|
||||||
|
- marker defaults
|
||||||
|
- SQLAlchemy sync testing behavior where applicable
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Design Decisions
|
||||||
|
|
||||||
|
1. **Upload service owns initial file + record creation**
|
||||||
|
- Writes file, creates `Document`, creates queued `Job`, returns IDs/path.
|
||||||
|
|
||||||
|
2. **Worker owns lifecycle transitions**
|
||||||
|
- Worker is the single owner of `queued -> processing -> terminal` job state changes.
|
||||||
|
|
||||||
|
3. **Worker uses Step 3 service boundary**
|
||||||
|
- Worker calls `transcribe_document_image(...)`; no provider-specific SDK logic in worker.
|
||||||
|
|
||||||
|
4. **Failure information is always persisted**
|
||||||
|
- On failure: store `Transcript(text=None, error_detail=...)` and set `Job.status=failed`.
|
||||||
|
|
||||||
|
5. **Loop remains simple and stoppable**
|
||||||
|
- In-process polling loop with stop event and poll interval for MVP simplicity and testability.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task-by-Task Execution Checklist
|
||||||
|
|
||||||
|
## Phase A — Implement upload service (`src/transcription/services/upload.py`)
|
||||||
|
|
||||||
|
- [ ] Create `UploadError` exception
|
||||||
|
- [ ] Create `UploadJobResult` dataclass with:
|
||||||
|
- [ ] `document_id`
|
||||||
|
- [ ] `job_id`
|
||||||
|
- [ ] `stored_path`
|
||||||
|
- [ ] `original_filename`
|
||||||
|
- [ ] Add filename safety handling:
|
||||||
|
- [ ] normalize to basename
|
||||||
|
- [ ] avoid path traversal
|
||||||
|
- [ ] collision-safe stored name (e.g., UUID prefix/suffix)
|
||||||
|
- [ ] Validate upload payload:
|
||||||
|
- [ ] non-empty bytes required
|
||||||
|
- [ ] extension in supported set (`.jpg/.jpeg/.png/.tif/.tiff/.pdf`)
|
||||||
|
- [ ] Ensure upload directory exists (`mkdir(parents=True, exist_ok=True)`)
|
||||||
|
- [ ] Write file bytes to `UPLOAD_DIR`
|
||||||
|
- [ ] Persist DB records in one transaction:
|
||||||
|
- [ ] `Document(filename, file_path)`
|
||||||
|
- [ ] `Job(document_id=..., status=queued)`
|
||||||
|
- [ ] Return `UploadJobResult`
|
||||||
|
- [ ] Add logging for success/failure boundaries
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — Implement worker core (`src/transcription/worker.py`)
|
||||||
|
|
||||||
|
- [ ] Add `process_next_queued_job(...) -> bool`
|
||||||
|
- [ ] Fetch oldest queued job
|
||||||
|
- [ ] Return `False` when no queued jobs exist
|
||||||
|
- [ ] Transition picked job to `processing` and update timestamp
|
||||||
|
- [ ] Resolve associated `Document.file_path`
|
||||||
|
- [ ] Call `transcribe_document_image(image_path=...)`
|
||||||
|
- [ ] On success:
|
||||||
|
- [ ] insert/update transcript text
|
||||||
|
- [ ] clear error detail
|
||||||
|
- [ ] mark job `transcribed`
|
||||||
|
- [ ] update timestamp
|
||||||
|
- [ ] On failure:
|
||||||
|
- [ ] insert/update transcript with `text=None`, `error_detail=...`
|
||||||
|
- [ ] mark job `failed`
|
||||||
|
- [ ] update timestamp
|
||||||
|
- [ ] Commit terminal state and return `True`
|
||||||
|
- [ ] Add logs around job pickup, transition, and terminal outcome
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Implement worker loop (`src/transcription/worker.py`)
|
||||||
|
|
||||||
|
- [ ] Add `run_worker_loop(...)`
|
||||||
|
- [ ] Accept configurable stop event/signal
|
||||||
|
- [ ] Accept configurable poll interval
|
||||||
|
- [ ] Repeatedly call `process_next_queued_job`
|
||||||
|
- [ ] Sleep only when queue is empty
|
||||||
|
- [ ] Exit cleanly when stop event is set
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Exports
|
||||||
|
|
||||||
|
- [ ] Update `src/transcription/services/__init__.py` to expose upload APIs
|
||||||
|
- [ ] Keep existing transcription exports intact
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — Tests via MCP scaffold -> fill flow
|
||||||
|
|
||||||
|
## E1 Scaffold (structure only)
|
||||||
|
|
||||||
|
Use scaffold prompt workflow first for:
|
||||||
|
- `src/transcription/services/upload.py`
|
||||||
|
- `src/transcription/worker.py`
|
||||||
|
|
||||||
|
Expected scaffold targets:
|
||||||
|
- `tests/services/test_upload.py`
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
|
||||||
|
Scaffold rules:
|
||||||
|
- [ ] Class hierarchy + method names + one-line docstrings only
|
||||||
|
- [ ] No assertions or implementation details in scaffold phase
|
||||||
|
- [ ] Keep method names concise and behavior-focused
|
||||||
|
|
||||||
|
Validation:
|
||||||
|
- [ ] `uv run pytest --collect-only -q`
|
||||||
|
|
||||||
|
## E2 Fill scaffold (implementation)
|
||||||
|
|
||||||
|
Use fill prompt workflow for:
|
||||||
|
- `tests/services/test_upload.py`
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
- stack: `sqlalchemy-sync` (or `mixed` if combining pure + DB behaviors)
|
||||||
|
- marker lane preference: `unit` and `integration` as appropriate
|
||||||
|
- strategy: minimal deterministic implementation
|
||||||
|
|
||||||
|
Fill rules (invariants):
|
||||||
|
- [ ] Preserve scaffold class names, method names, and one-line docstrings
|
||||||
|
- [ ] Do not rename/re-nest scaffolded tests unless explicitly approved
|
||||||
|
- [ ] One behavior target per test
|
||||||
|
- [ ] Minimal mocking; mock only network/nondeterministic boundaries
|
||||||
|
|
||||||
|
Suggested test coverage:
|
||||||
|
|
||||||
|
### `tests/services/test_upload.py`
|
||||||
|
- [ ] creates file + document + queued job (`integration`)
|
||||||
|
- [ ] rejects empty bytes (`unit`)
|
||||||
|
- [ ] rejects unsupported extension (`unit`)
|
||||||
|
- [ ] writes collision-safe unique filename (`integration`)
|
||||||
|
- [ ] persisted job status is `queued` (`integration`)
|
||||||
|
|
||||||
|
### `tests/services/test_worker.py`
|
||||||
|
- [ ] returns `False` when queue empty (`integration`)
|
||||||
|
- [ ] transitions `queued -> processing -> transcribed` on success (`integration`)
|
||||||
|
- [ ] stores transcript text on success (`integration`)
|
||||||
|
- [ ] transitions to `failed` and stores `error_detail` on failure (`integration`)
|
||||||
|
- [ ] updates existing transcript instead of duplicate create (`integration`)
|
||||||
|
- [ ] worker loop exits when stop event set (`unit`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Marker Strategy
|
||||||
|
|
||||||
|
- `unit`: pure logic tests (filename handling, loop stop behavior, validation logic)
|
||||||
|
- `integration`: DB + service orchestration tests (SQLite/session/contracts)
|
||||||
|
- `external`: opt-in live provider tests only (not part of default Step 4 lane)
|
||||||
|
|
||||||
|
No new marker needed; reuse existing marker registration.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Validation Sequence (strict order)
|
||||||
|
|
||||||
|
- [ ] `uv run pytest --collect-only -q`
|
||||||
|
- [ ] `uv run pytest -m unit -q` *(if unit tests touched)*
|
||||||
|
- [ ] `uv run pytest tests/services/test_upload.py -q`
|
||||||
|
- [ ] `uv run pytest tests/services/test_worker.py -q`
|
||||||
|
- [ ] `uv run pytest -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Reporting Requirements (after implementation)
|
||||||
|
|
||||||
|
Implementation report must include:
|
||||||
|
|
||||||
|
1. Files created/updated
|
||||||
|
2. Fixture and marker decisions
|
||||||
|
3. MCP references used and why
|
||||||
|
4. Validation command results
|
||||||
|
5. Remaining risks/open questions (only blockers)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Guardrails
|
||||||
|
|
||||||
|
- Keep Step 4 independent from UI concerns.
|
||||||
|
- Do not call provider SDK directly from worker.
|
||||||
|
- Do not silently swallow exceptions.
|
||||||
|
- Always persist terminal job outcome.
|
||||||
|
- Keep default suite deterministic and fast.
|
||||||
|
- Preserve scaffold invariants during fill phase.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Definition of Done (Step 4)
|
||||||
|
|
||||||
|
Step 4 is complete when:
|
||||||
|
|
||||||
|
- [ ] Upload service writes file and creates `Document` + queued `Job`
|
||||||
|
- [ ] Worker processes queued jobs end-to-end using Step 3 transcription service
|
||||||
|
- [ ] Success path persists transcript text and sets `transcribed`
|
||||||
|
- [ ] Failure path persists error detail and sets `failed`
|
||||||
|
- [ ] Queue-empty path returns cleanly
|
||||||
|
- [ ] New tests pass and full suite is green (`uv run pytest -q`)
|
||||||
|
- [ ] Output report includes MCP reference usage + validation evidence
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
Step 5 is implemented and passing ✅
|
||||||
|
|
||||||
|
### What I implemented
|
||||||
|
|
||||||
|
#### App/bootstrap
|
||||||
|
- Added `src/transcription/app.py`:
|
||||||
|
- `create_app()` factory
|
||||||
|
- FastAPI lifespan startup/shutdown:
|
||||||
|
- `setup_logging()`
|
||||||
|
- `create_all()`
|
||||||
|
- ensure `upload_dir` and `prompt_dir`
|
||||||
|
- start/stop worker thread (`run_worker_loop`)
|
||||||
|
- includes health router
|
||||||
|
- registers NiceGUI pages
|
||||||
|
|
||||||
|
#### API
|
||||||
|
- Added `src/transcription/api/__init__.py`
|
||||||
|
- Added `src/transcription/api/health.py`:
|
||||||
|
- `GET /healthz` returns `{"status": "ok"}`
|
||||||
|
|
||||||
|
#### UI
|
||||||
|
- Added `src/transcription/ui/upload_page.py`:
|
||||||
|
- upload page route
|
||||||
|
- accepted extensions helper
|
||||||
|
- upload submit helper to Step 4 service (`create_upload_job`)
|
||||||
|
- success/error state messaging
|
||||||
|
- Added `src/transcription/ui/jobs_page.py`:
|
||||||
|
- jobs list page
|
||||||
|
- job detail page
|
||||||
|
- `fetch_jobs()` and `fetch_job_detail()` helpers
|
||||||
|
- Updated `src/transcription/ui/__init__.py`:
|
||||||
|
- explicit page registration
|
||||||
|
- NiceGUI mounted via `ui.run_with(app, mount_path="/ui", ...)`
|
||||||
|
|
||||||
|
#### Dependencies
|
||||||
|
- Added runtime dependencies:
|
||||||
|
- `fastapi`
|
||||||
|
- `nicegui`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Tests created and filled (scaffold → fill)
|
||||||
|
|
||||||
|
- `tests/test_app.py`
|
||||||
|
- `tests/api/test_health.py`
|
||||||
|
- `tests/ui/test_pages_registration.py`
|
||||||
|
- `tests/ui/test_upload_page.py`
|
||||||
|
- `tests/ui/test_jobs_page.py`
|
||||||
|
|
||||||
|
All scaffolded method names/docstrings were preserved and filled with executable assertions.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Validation results (strict sequence)
|
||||||
|
|
||||||
|
- `uv run pytest --collect-only -q` ✅
|
||||||
|
- `uv run pytest -m unit -q` ✅
|
||||||
|
- `uv run pytest tests/api/test_health.py -q` ✅
|
||||||
|
- `uv run pytest tests/ui/test_pages_registration.py -q` ✅
|
||||||
|
- `uv run pytest tests/test_app.py -q` ✅
|
||||||
|
- `uv run pytest tests/ui/test_upload_page.py -q` ✅
|
||||||
|
- `uv run pytest tests/ui/test_jobs_page.py -q` ✅
|
||||||
|
- `uv run pytest -q` ✅
|
||||||
|
|
||||||
|
Full suite is green.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Note
|
||||||
|
You’ll see one warning from FastAPI/Starlette test client about `httpx` deprecation; it does not affect correctness and all tests pass.
|
||||||
@@ -0,0 +1,310 @@
|
|||||||
|
## Step 5: `app.py` + UI Pages (NiceGUI + FastAPI composition)
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Implement the MVP user-facing application layer so users can:
|
||||||
|
|
||||||
|
1. Upload a document from the UI
|
||||||
|
2. Trigger Step 4 upload/job creation flow
|
||||||
|
3. See live job lifecycle status (`queued`, `processing`, `transcribed`, `failed`)
|
||||||
|
4. Open a job detail view to read transcript text or failure details
|
||||||
|
|
||||||
|
This step composes Steps 1–4 into a usable UI.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture Summary (NiceGUI-aligned)
|
||||||
|
|
||||||
|
Step 5 uses a **FastAPI app factory + lifespan orchestration** and mounts/registers NiceGUI pages via explicit page modules.
|
||||||
|
|
||||||
|
Reference baseline: `resource://skills/nicegui/document`
|
||||||
|
|
||||||
|
### Core architecture decisions
|
||||||
|
|
||||||
|
- **App factory:** `create_app()`
|
||||||
|
- **Lifespan-managed resources:** worker start/stop managed in startup/shutdown
|
||||||
|
- **Modular pages:** upload and jobs pages in separate modules (no monolithic UI file)
|
||||||
|
- **Health endpoint:** FastAPI-side `/healthz`
|
||||||
|
- **UI composition:** route pages stay modular and reusable shared shell/components live under `ui/components` as needed
|
||||||
|
- **Styling architecture:** shared CSS loaded once at startup; avoid ad-hoc per-page styling drift
|
||||||
|
- **Dependency direction (one-way):**
|
||||||
|
- `app` -> `config/logging/db/worker/ui/api`
|
||||||
|
- `ui/pages` -> `ui/components` + `services`
|
||||||
|
- `services` -> `db/models/providers`
|
||||||
|
- no reverse imports from services into UI/API
|
||||||
|
|
||||||
|
### DB and AI stance (explicit)
|
||||||
|
|
||||||
|
- **DB:** already enabled (SQLModel + SQLite), session lifecycle remains request/service-scoped as built in prior steps.
|
||||||
|
- **AI workflow:** already in place via Step 3 transcription service + Step 4 worker; UI does not call provider SDK directly.
|
||||||
|
- **Mounted docs:** not in Step 5 scope; docs mounting remains disabled for MVP.
|
||||||
|
|
||||||
|
### Async and responsiveness stance
|
||||||
|
|
||||||
|
- Prefer `async def` for page handlers and service boundaries when I/O is involved.
|
||||||
|
- Keep UI handlers non-blocking (no blocking sleeps or synchronous long I/O calls).
|
||||||
|
- For long-running user actions, always provide explicit loading/progress/error states.
|
||||||
|
- Keep cancellation/timeout behavior explicit for refresh/poll operations where applicable.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
- `src/transcription/app.py`
|
||||||
|
- `src/transcription/ui/upload_page.py`
|
||||||
|
- `src/transcription/ui/jobs_page.py`
|
||||||
|
- `src/transcription/ui/__init__.py`
|
||||||
|
- `src/transcription/api/health.py` (or equivalent FastAPI health route module)
|
||||||
|
- UI/app tests with MCP scaffold->fill flow
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Auth
|
||||||
|
- advanced filtering/search UX
|
||||||
|
- batch upload UX beyond MVP
|
||||||
|
- deployment/container hardening
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planned Deliverables
|
||||||
|
|
||||||
|
### Source files
|
||||||
|
- `src/transcription/app.py` (app factory + lifespan wiring)
|
||||||
|
- `src/transcription/api/health.py` (GET `/healthz`)
|
||||||
|
- `src/transcription/ui/upload_page.py` (upload flow)
|
||||||
|
- `src/transcription/ui/jobs_page.py` (status list + detail)
|
||||||
|
- `src/transcription/ui/__init__.py` (explicit `register_pages(...)` export)
|
||||||
|
- `src/transcription/ui/components/*` (shared shell/navigation/status components if introduced)
|
||||||
|
- `src/transcription/ui/static/*.css` (optional shared CSS loaded once at startup)
|
||||||
|
|
||||||
|
### Test files
|
||||||
|
- `tests/test_app.py`
|
||||||
|
- `tests/api/test_health.py`
|
||||||
|
- `tests/ui/test_pages_registration.py`
|
||||||
|
- `tests/ui/test_upload_page.py`
|
||||||
|
- `tests/ui/test_jobs_page.py`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Plan + Checklist
|
||||||
|
|
||||||
|
Plan baseline and guardrails source: `resource://skills/nicegui/document`
|
||||||
|
|
||||||
|
## Phase A — App factory and lifespan orchestration
|
||||||
|
|
||||||
|
- [ ] Create `create_app()` in `src/transcription/app.py`
|
||||||
|
- [ ] Add FastAPI lifespan startup/shutdown handlers
|
||||||
|
- [ ] Startup responsibilities:
|
||||||
|
- [ ] `setup_logging()`
|
||||||
|
- [ ] `create_all()`
|
||||||
|
- [ ] ensure directories exist (`upload_dir`, `prompt_dir`)
|
||||||
|
- [ ] create worker stop event
|
||||||
|
- [ ] start worker background thread/task
|
||||||
|
- [ ] Shutdown responsibilities:
|
||||||
|
- [ ] signal stop event
|
||||||
|
- [ ] join/cleanup worker thread/task cleanly
|
||||||
|
- [ ] Register API router(s), including health route
|
||||||
|
- [ ] Register NiceGUI pages via explicit page registration function
|
||||||
|
- [ ] Load shared CSS once at startup (if present)
|
||||||
|
|
||||||
|
## Phase B — FastAPI health endpoint
|
||||||
|
|
||||||
|
- [ ] Create `src/transcription/api/health.py`
|
||||||
|
- [ ] Add `GET /healthz` returning simple healthy payload
|
||||||
|
- [ ] Wire route into app factory
|
||||||
|
|
||||||
|
## Phase C — Upload page (`ui/upload_page.py`)
|
||||||
|
|
||||||
|
- [ ] Add upload route/page registration function
|
||||||
|
- [ ] Render file input accepting supported extensions
|
||||||
|
- [ ] On submit:
|
||||||
|
- [ ] show loading/progress state
|
||||||
|
- [ ] call `create_upload_job(filename, file_bytes, ...)`
|
||||||
|
- [ ] show success state with job reference/link
|
||||||
|
- [ ] On error:
|
||||||
|
- [ ] show user-safe error message
|
||||||
|
- [ ] restore ready UI state
|
||||||
|
- [ ] Ensure non-blocking I/O in UI event handlers; offload CPU-heavy work to worker path
|
||||||
|
- [ ] Make timeout/cancellation behavior explicit for any long-running action
|
||||||
|
|
||||||
|
## Phase D — Jobs page (`ui/jobs_page.py`)
|
||||||
|
|
||||||
|
- [ ] Add jobs list route/page registration function
|
||||||
|
- [ ] Display jobs with status + timestamps
|
||||||
|
- [ ] Add job detail route/view
|
||||||
|
- [ ] Show transcript on success, error detail on failure
|
||||||
|
- [ ] Include explicit refresh action and loading state
|
||||||
|
- [ ] Ensure error states are surfaced to user and logged
|
||||||
|
- [ ] Keep refresh path async and bounded to avoid UI freeze
|
||||||
|
|
||||||
|
## Phase E — UI registration module
|
||||||
|
|
||||||
|
- [ ] Update `src/transcription/ui/__init__.py`
|
||||||
|
- [ ] Export `register_pages(...)`
|
||||||
|
- [ ] Ensure each page module exports `register_page(...)`
|
||||||
|
- [ ] Keep page registration explicit and modular
|
||||||
|
|
||||||
|
## Phase F — Shared components and style consistency
|
||||||
|
|
||||||
|
- [ ] Add `ui/components` module only for reusable shell elements (header/nav/status chips), not page-local logic
|
||||||
|
- [ ] Keep structural layout in Python; keep visual polish in shared CSS
|
||||||
|
- [ ] Avoid one-off styling duplication across upload/jobs pages
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Testing Workflow (Required)
|
||||||
|
|
||||||
|
Use these resources directly:
|
||||||
|
|
||||||
|
- `resource://catalog/prompts/pytest-scaffold`
|
||||||
|
- `resource://prompts/pytest-scaffold/document`
|
||||||
|
- `resource://catalog/prompts/pytest-fill-scaffold`
|
||||||
|
- `resource://prompts/pytest-fill-scaffold/document`
|
||||||
|
|
||||||
|
## E1 — Scaffold tests first (structure only)
|
||||||
|
|
||||||
|
Target modules:
|
||||||
|
- `src/transcription/app.py`
|
||||||
|
- `src/transcription/api/health.py`
|
||||||
|
- `src/transcription/ui/upload_page.py`
|
||||||
|
- `src/transcription/ui/jobs_page.py`
|
||||||
|
|
||||||
|
Scaffold test files:
|
||||||
|
- `tests/test_app.py`
|
||||||
|
- `tests/api/test_health.py`
|
||||||
|
- `tests/ui/test_pages_registration.py`
|
||||||
|
- `tests/ui/test_upload_page.py`
|
||||||
|
- `tests/ui/test_jobs_page.py`
|
||||||
|
|
||||||
|
Scaffold constraints:
|
||||||
|
- [ ] class/method skeletons only
|
||||||
|
- [ ] one-line docstrings
|
||||||
|
- [ ] concise behavior-focused names
|
||||||
|
- [ ] no implementation assertions yet
|
||||||
|
|
||||||
|
Validation:
|
||||||
|
- [ ] `uv run pytest --collect-only -q`
|
||||||
|
|
||||||
|
## E2 — Fill scaffold tests
|
||||||
|
|
||||||
|
Fill constraints from MCP guidance:
|
||||||
|
- [ ] preserve scaffold class/method names and docstrings (locked baseline)
|
||||||
|
- [ ] one behavior target per method
|
||||||
|
- [ ] deterministic tests preferred
|
||||||
|
- [ ] minimal mocking; only nondeterministic boundaries
|
||||||
|
|
||||||
|
Stack:
|
||||||
|
- [ ] `fastapi` (or `mixed` if needed for UI+DB fixture combination)
|
||||||
|
|
||||||
|
Suggested coverage:
|
||||||
|
|
||||||
|
### `tests/api/test_health.py`
|
||||||
|
- [ ] `/healthz` returns success status and expected payload shape
|
||||||
|
|
||||||
|
### `tests/ui/test_pages_registration.py`
|
||||||
|
- [ ] page registration wiring succeeds
|
||||||
|
- [ ] expected routes are present
|
||||||
|
|
||||||
|
### `tests/test_app.py`
|
||||||
|
- [ ] startup path initializes runtime dependencies
|
||||||
|
- [ ] worker start is invoked on startup
|
||||||
|
- [ ] worker shutdown signal/cleanup is invoked on shutdown
|
||||||
|
|
||||||
|
### `tests/ui/test_upload_page.py`
|
||||||
|
- [ ] upload action calls upload service
|
||||||
|
- [ ] success feedback displayed
|
||||||
|
- [ ] error feedback displayed for `UploadError`
|
||||||
|
- [ ] loading/progress state behavior covered
|
||||||
|
- [ ] timeout/cancellation behavior covered (if implemented)
|
||||||
|
|
||||||
|
### `tests/ui/test_jobs_page.py`
|
||||||
|
- [ ] list renders job statuses
|
||||||
|
- [ ] detail shows transcript text for successful job
|
||||||
|
- [ ] detail shows error detail for failed job
|
||||||
|
- [ ] refresh/loading state behavior covered
|
||||||
|
|
||||||
|
Marker strategy:
|
||||||
|
- [ ] `unit` for pure helpers/state formatting
|
||||||
|
- [ ] `integration` for app/page/service+DB contracts
|
||||||
|
- [ ] `external` not required for default Step 5 lane
|
||||||
|
|
||||||
|
Async behavior assertions:
|
||||||
|
- [ ] long-running actions keep button/inputs in expected disabled state
|
||||||
|
- [ ] completion/failure returns controls to ready state
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Validation Sequence (strict)
|
||||||
|
|
||||||
|
- [ ] `uv run pytest --collect-only -q`
|
||||||
|
- [ ] `uv run pytest -m unit -q` *(if unit tests touched)*
|
||||||
|
- [ ] `uv run pytest tests/api/test_health.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_pages_registration.py -q`
|
||||||
|
- [ ] `uv run pytest tests/test_app.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_upload_page.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_jobs_page.py -q`
|
||||||
|
- [ ] `uv run pytest -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Guardrails (NiceGUI + MVP)
|
||||||
|
|
||||||
|
- [ ] Do not collapse pages into one file.
|
||||||
|
- [ ] Do not use implicit global side effects for runtime wiring.
|
||||||
|
- [ ] Keep UI responsive with explicit loading/progress/error states.
|
||||||
|
- [ ] Do not block UI handlers with synchronous long I/O.
|
||||||
|
- [ ] Do not place provider SDK calls in UI handlers.
|
||||||
|
- [ ] Keep dependency direction one-way and maintainable.
|
||||||
|
- [ ] Keep shared UI in `ui/components`; keep service logic out of page modules.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Definition of Done
|
||||||
|
|
||||||
|
- [ ] App factory + lifespan are in place
|
||||||
|
- [ ] Health endpoint exists and is tested
|
||||||
|
- [ ] Upload page creates queued jobs through service boundary
|
||||||
|
- [ ] Jobs list/detail pages render status/transcript/failure data
|
||||||
|
- [ ] Worker lifecycle is started/stopped by app lifespan
|
||||||
|
- [ ] Async UI states (loading/success/error) are deterministic and tested
|
||||||
|
- [ ] Scaffold->fill testing flow completed and validated
|
||||||
|
- [ ] Full suite passes: `uv run pytest -q`
|
||||||
|
|
||||||
|
## Completion Checks (NiceGUI skill aligned)
|
||||||
|
|
||||||
|
- [ ] Uses app factory and FastAPI lifespan
|
||||||
|
- [ ] Pages are modularized (not single-file UI)
|
||||||
|
- [ ] Health endpoint exists on FastAPI side
|
||||||
|
- [ ] Dependency direction is clean and one-way
|
||||||
|
- [ ] Async-first guidance is applied where I/O exists, with explicit non-blocking UX states
|
||||||
|
- [ ] DB/AI/docs decisions are explicit and reflected in structure
|
||||||
|
- [ ] Plan references baseline URI: `resource://skills/nicegui/document`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## PR Checklist (Integrated)
|
||||||
|
|
||||||
|
### Implementation
|
||||||
|
- [ ] `app.py` app factory + lifespan implemented
|
||||||
|
- [ ] FastAPI health route (`/healthz`) implemented
|
||||||
|
- [ ] `ui/upload_page.py` implemented
|
||||||
|
- [ ] `ui/jobs_page.py` implemented
|
||||||
|
- [ ] `ui/__init__.py` explicit page registration implemented
|
||||||
|
- [ ] Worker startup/shutdown managed by lifespan
|
||||||
|
|
||||||
|
### Testing (MCP-compliant)
|
||||||
|
- [ ] Scaffold phase completed first for all Step 5 tests
|
||||||
|
- [ ] `--collect-only` passed on scaffolds
|
||||||
|
- [ ] Fill phase completed without renaming/re-nesting scaffolded tests
|
||||||
|
- [ ] Marker decisions documented (`unit` vs `integration`)
|
||||||
|
- [ ] Targeted tests passed
|
||||||
|
- [ ] Full suite passed
|
||||||
|
|
||||||
|
### Evidence
|
||||||
|
- [ ] Validation command outputs captured
|
||||||
|
- [ ] Files created/updated listed
|
||||||
|
- [ ] MCP prompt resources referenced in implementation notes
|
||||||
|
- [ ] Any residual risks/questions documented
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
Step 6 implemented ✅
|
||||||
|
|
||||||
|
### Files added
|
||||||
|
- `tests/integration/test_pipeline_flow.py`
|
||||||
|
- `tests/test_traceability.py`
|
||||||
|
|
||||||
|
### What was implemented
|
||||||
|
|
||||||
|
#### 1) End-to-end pipeline integration coverage
|
||||||
|
`tests/integration/test_pipeline_flow.py` now verifies:
|
||||||
|
|
||||||
|
- **Success path**
|
||||||
|
- upload creates queued job
|
||||||
|
- worker processes job
|
||||||
|
- job becomes `transcribed`
|
||||||
|
- transcript text is persisted
|
||||||
|
- error detail remains `None`
|
||||||
|
|
||||||
|
- **Failure path**
|
||||||
|
- upload creates queued job
|
||||||
|
- worker processing failure is handled
|
||||||
|
- job becomes `failed`
|
||||||
|
- transcript has `text=None`
|
||||||
|
- `error_detail` contains provider failure reason
|
||||||
|
|
||||||
|
#### 2) MVP requirement traceability check
|
||||||
|
`tests/test_traceability.py` adds a concrete map:
|
||||||
|
|
||||||
|
- REQ-0, REQ-1, REQ-2, REQ-3, REQ-4, REQ-5, REQ-6, REQ-8, REQ-12
|
||||||
|
- each REQ maps to one or more existing test files
|
||||||
|
- test asserts each mapped path exists (guards against drift)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Validation run results
|
||||||
|
|
||||||
|
Executed and passed:
|
||||||
|
|
||||||
|
1. `uv run pytest --collect-only -q` ✅
|
||||||
|
2. `uv run pytest -m unit -q` ✅
|
||||||
|
3. `uv run pytest -m integration -q` ✅
|
||||||
|
4. `uv run pytest -m "not external" -q` ✅
|
||||||
|
5. `uv run pytest tests/integration/test_pipeline_flow.py -q` ✅
|
||||||
|
6. `uv run pytest tests/ui/test_upload_page.py -q` ✅
|
||||||
|
7. `uv run pytest tests/ui/test_jobs_page.py -q` ✅
|
||||||
|
8. `uv run pytest -q` ✅
|
||||||
|
|
||||||
|
All green.
|
||||||
|
(Only existing non-blocking FastAPI TestClient deprecation warning remains.)
|
||||||
|
|
||||||
@@ -0,0 +1,229 @@
|
|||||||
|
## Step 6: Test and Verification Hardening (MVP closeout)
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Complete MVP verification by building a **requirements-traceable, deterministic test strategy** across unit/integration/external lanes, then enforcing stable validation commands and reporting.
|
||||||
|
|
||||||
|
This step finalizes the MVP implementation sequence from `docs/mvp.md` (Step 6 in the build order: tests and automated verification).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Resource Integration (what was applied)
|
||||||
|
|
||||||
|
I reviewed all top-level skills/prompts from `john-stream-mcp` and integrated the relevant guidance into this plan:
|
||||||
|
|
||||||
|
### Directly applied
|
||||||
|
- `resource://skills/pytesting/document`
|
||||||
|
- `resource://catalog/prompts/pytest-scaffold`
|
||||||
|
- `resource://prompts/pytest-scaffold/document`
|
||||||
|
- `resource://catalog/prompts/pytest-fill-scaffold`
|
||||||
|
- `resource://prompts/pytest-fill-scaffold/document`
|
||||||
|
- `resource://skills/nicegui/document`
|
||||||
|
- `resource://skills/nicegui-ui-customization/document`
|
||||||
|
- `resource://skills/fastapi-uv-docker/document`
|
||||||
|
- `resource://skills/python-logging-dictconfig/document`
|
||||||
|
- `resource://skills/python-typing/document`
|
||||||
|
- `resource://skills/ruff-linting-formating/document`
|
||||||
|
|
||||||
|
### Reviewed but informational/non-blocking for Step 6
|
||||||
|
- `copilot-customization`, `mcp-details`, `vscode-configuration`, `zensical-docs`, and authoring/shim prompts.
|
||||||
|
- These are primarily customization/documentation tooling resources, not core MVP test-lane blockers.
|
||||||
|
- Step 6 includes optional workflow follow-ups where relevant (e.g., VS Code task conveniences).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
- Strengthen and complete test coverage for the shipped MVP slice (Steps 1–5)
|
||||||
|
- Add requirement-to-test traceability for REQ-0..REQ-12 (MVP subset emphasized)
|
||||||
|
- Enforce deterministic default lanes (`unit`, `integration`)
|
||||||
|
- Keep `external` lane opt-in and isolated
|
||||||
|
- Validate app/UI/service/worker contracts end-to-end at test level
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Major architecture rewrites (async SQLAlchemy migration, queue system, etc.)
|
||||||
|
- Full production deployment rollout
|
||||||
|
- Post-MVP feature expansion (revision history, search, export)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planned Deliverables
|
||||||
|
|
||||||
|
### Test files (new/updated)
|
||||||
|
- `tests/test_traceability.py` *(or docs-based traceability matrix if preferred)*
|
||||||
|
- `tests/integration/test_pipeline_flow.py` *(upload -> queued -> worker -> transcript/failed)*
|
||||||
|
- `tests/ui/test_upload_page.py` (augment loading/error/ready-state checks as practical)
|
||||||
|
- `tests/ui/test_jobs_page.py` (augment refresh/error behavior checks as practical)
|
||||||
|
- Existing tests touched only when needed; preserve naming/hierarchy unless explicitly approved.
|
||||||
|
|
||||||
|
### Optional docs output
|
||||||
|
- `docs/tests.md` or `docs/verification.md` with lane definitions and command matrix
|
||||||
|
- REQ-to-test mapping table
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Design and Policy Decisions (MCP-aligned)
|
||||||
|
|
||||||
|
1. **Scaffold-first, fill-second workflow is mandatory**
|
||||||
|
- First create/adjust skeletons and collect.
|
||||||
|
- Then fill test bodies.
|
||||||
|
- Preserve scaffold names/docstrings during fill.
|
||||||
|
|
||||||
|
2. **Deterministic-first default lanes**
|
||||||
|
- `unit` and `integration` run by default.
|
||||||
|
- `external` remains explicit opt-in.
|
||||||
|
|
||||||
|
3. **One behavior target per test**
|
||||||
|
- Short, behavior-focused names.
|
||||||
|
- Precise assertions on observable outcomes.
|
||||||
|
|
||||||
|
4. **Test double discipline (from pytesting skill)**
|
||||||
|
- Prefer real-input/real-object paths first.
|
||||||
|
- If monkeypatch/mocks/fakes are needed for a boundary, keep narrowly scoped.
|
||||||
|
- Avoid call-only assertions.
|
||||||
|
|
||||||
|
5. **NiceGUI responsiveness expectations**
|
||||||
|
- Verify loading/success/error state transitions where testable.
|
||||||
|
- Ensure user-facing feedback behavior is covered.
|
||||||
|
|
||||||
|
6. **FastAPI/ops baseline checks**
|
||||||
|
- Keep `/healthz` route validation in default lanes.
|
||||||
|
- Keep startup/shutdown lifecycle assertions present.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Plan + Checklist
|
||||||
|
|
||||||
|
## Phase A — Coverage and traceability audit
|
||||||
|
|
||||||
|
- [ ] Build a REQ-to-test matrix for MVP requirements:
|
||||||
|
- [ ] REQ-0, REQ-1, REQ-2, REQ-3, REQ-4, REQ-5, REQ-6, REQ-8, REQ-12
|
||||||
|
- [ ] Identify weak spots:
|
||||||
|
- [ ] full pipeline integration (service + worker + persistence)
|
||||||
|
- [ ] UI state transition assertions (loading/error/ready)
|
||||||
|
- [ ] failure-path persistence verification robustness
|
||||||
|
- [ ] Record current baseline command results before edits
|
||||||
|
|
||||||
|
## Phase B — Scaffold phase (pytest-scaffold resources)
|
||||||
|
|
||||||
|
Target modules/areas:
|
||||||
|
- pipeline integration flow
|
||||||
|
- UI behavior augmentations
|
||||||
|
- traceability checks/document validators (if test-backed)
|
||||||
|
|
||||||
|
- [ ] Scaffold new/adjusted test files/classes/methods only
|
||||||
|
- [ ] Keep one-line intent docstrings
|
||||||
|
- [ ] Keep behavior-focused names
|
||||||
|
- [ ] Run: `uv run pytest --collect-only -q`
|
||||||
|
|
||||||
|
## Phase C — Fill phase (pytest-fill-scaffold resources)
|
||||||
|
|
||||||
|
- [ ] Fill scaffolded methods with deterministic setup/assertions
|
||||||
|
- [ ] Preserve scaffold names/hierarchy/docstrings
|
||||||
|
- [ ] Add/adjust fixtures at nearest useful scope
|
||||||
|
- [ ] Keep DB tests in `integration`; pure helper tests in `unit`
|
||||||
|
|
||||||
|
### Required coverage additions
|
||||||
|
|
||||||
|
#### Pipeline integration
|
||||||
|
- [ ] Upload service creates document/job and file path persists
|
||||||
|
- [ ] Worker success path creates transcript and terminal status
|
||||||
|
- [ ] Worker failure path persists error detail and terminal failed status
|
||||||
|
- [ ] Queue-empty behavior remains stable (`False` return / no side effects)
|
||||||
|
|
||||||
|
#### UI behavior (practical, testable boundaries)
|
||||||
|
- [ ] Upload helper flow success and UploadError surfacing
|
||||||
|
- [ ] Jobs data helpers return stable normalized view models
|
||||||
|
- [ ] Refresh/detail fallback behavior for missing/invalid job IDs
|
||||||
|
|
||||||
|
#### Traceability
|
||||||
|
- [ ] Every in-scope MVP REQ has at least one mapped test/assertion point
|
||||||
|
- [ ] Document and/or enforce mapping consistency
|
||||||
|
|
||||||
|
## Phase D — External lane stability
|
||||||
|
|
||||||
|
- [ ] Keep real-image external tests isolated under `@pytest.mark.external`
|
||||||
|
- [ ] Ensure no external test leaks into default runs
|
||||||
|
- [ ] Confirm artifact capture behavior remains stable
|
||||||
|
|
||||||
|
## Phase E — Quality gates and workflow
|
||||||
|
|
||||||
|
- [ ] Confirm logging/lifecycle startup tests still pass after changes
|
||||||
|
- [ ] (If enabled) add/update lint/type check commands in docs:
|
||||||
|
- [ ] Ruff lane (if configured)
|
||||||
|
- [ ] typing lane (if configured)
|
||||||
|
- [ ] Optionally add VS Code task aliases for test lanes (non-blocking)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Marker and Fixture Strategy
|
||||||
|
|
||||||
|
- `unit`: pure logic, helper behavior, formatting/normalization
|
||||||
|
- `integration`: DB + service + app lifecycle contracts
|
||||||
|
- `external`: live provider/real image checks only
|
||||||
|
|
||||||
|
Fixture policy:
|
||||||
|
- Prefer reusable fixtures in `tests/conftest.py` only when broadly shared
|
||||||
|
- Use subtree/local fixtures for domain-specific setup
|
||||||
|
- Keep setup explicit and readable
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Validation Sequence (strict)
|
||||||
|
|
||||||
|
- [ ] `uv run pytest --collect-only -q`
|
||||||
|
- [ ] `uv run pytest -m unit -q`
|
||||||
|
- [ ] `uv run pytest -m integration -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
- [ ] `uv run pytest tests/integration/test_pipeline_flow.py -q` *(if added)*
|
||||||
|
- [ ] `uv run pytest tests/ui/test_upload_page.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_jobs_page.py -q`
|
||||||
|
- [ ] `uv run pytest -q`
|
||||||
|
|
||||||
|
Optional external verification:
|
||||||
|
- [ ] `uv run pytest -m external -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Guardrails
|
||||||
|
|
||||||
|
- Do not rename/re-nest scaffolded tests during fill unless explicitly requested.
|
||||||
|
- Do not broaden external dependencies in default lane.
|
||||||
|
- Do not add flaky timing-based assertions; keep deterministic boundaries.
|
||||||
|
- Keep business logic out of UI tests; test through service/helper boundaries.
|
||||||
|
- Preserve one-way dependency direction in test setup patterns.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Definition of Done (Step 6)
|
||||||
|
|
||||||
|
- [ ] MVP requirement coverage is explicitly traceable
|
||||||
|
- [ ] Deterministic lanes (`unit` + `integration`) are stable and green
|
||||||
|
- [ ] External lane remains opt-in and green when enabled
|
||||||
|
- [ ] Pipeline success/failure lifecycle paths are verified end-to-end
|
||||||
|
- [ ] UI helper/state behavior has explicit success/error assertions
|
||||||
|
- [ ] Full suite passes with `uv run pytest -q`
|
||||||
|
- [ ] Verification evidence is captured in implementation report
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## PR Checklist (Step 6)
|
||||||
|
|
||||||
|
### Implementation
|
||||||
|
- [ ] Added/updated test files per scoped gaps
|
||||||
|
- [ ] Added REQ traceability mapping
|
||||||
|
- [ ] Kept default lanes deterministic
|
||||||
|
- [ ] Preserved scaffold invariants during fill
|
||||||
|
|
||||||
|
### Testing (MCP-compliant)
|
||||||
|
- [ ] Used scaffold prompt flow first
|
||||||
|
- [ ] Used fill prompt flow second
|
||||||
|
- [ ] Preserved naming/docstrings/hierarchy
|
||||||
|
- [ ] Marker usage documented (`unit`, `integration`, `external`)
|
||||||
|
|
||||||
|
### Evidence
|
||||||
|
- [ ] Collected command outputs in strict order
|
||||||
|
- [ ] Listed files changed
|
||||||
|
- [ ] Listed MCP resources used and why
|
||||||
|
- [ ] Noted residual risks/open questions (if any)
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
## Step 7 Results: Error Handling Standardization and Operational Visibility
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Step 7 was implemented across the MVP runtime boundaries with a shared error taxonomy, actionable UI error surfacing, worker failure normalization, and API error envelope handling.
|
||||||
|
|
||||||
|
All required validation gates in `docs/step7.md` were executed and passed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope Delivered
|
||||||
|
|
||||||
|
### Implemented
|
||||||
|
- Shared application error contract and taxonomy
|
||||||
|
- Service-layer error normalization (upload + transcription)
|
||||||
|
- UI error presentation helpers with suggested actions and error references
|
||||||
|
- Worker failure persistence format with category/suggestion/error_id markers
|
||||||
|
- API exception handlers for structured error responses
|
||||||
|
- Targeted tests for new error contract behavior
|
||||||
|
|
||||||
|
### Not implemented in this step
|
||||||
|
- External lane execution (`-m external`) was not required for Step 7 completion and was not run in this pass.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Files Added
|
||||||
|
|
||||||
|
- `src/transcription/errors.py`
|
||||||
|
- `src/transcription/api/errors.py`
|
||||||
|
- `src/transcription/ui/error_presenter.py`
|
||||||
|
- `tests/test_errors.py`
|
||||||
|
- `tests/api/test_error_responses.py`
|
||||||
|
- `docs/step7.md`
|
||||||
|
|
||||||
|
## Files Updated
|
||||||
|
|
||||||
|
- `src/transcription/app.py`
|
||||||
|
- `src/transcription/services/upload.py`
|
||||||
|
- `src/transcription/services/transcription.py`
|
||||||
|
- `src/transcription/ui/upload_page.py`
|
||||||
|
- `src/transcription/ui/jobs_page.py`
|
||||||
|
- `src/transcription/worker.py`
|
||||||
|
- `tests/services/test_upload.py`
|
||||||
|
- `tests/services/test_transcription.py`
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
- `tests/integration/test_pipeline_flow.py`
|
||||||
|
- `uv.lock`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Notes by Phase
|
||||||
|
|
||||||
|
### Phase A/B (Foundation)
|
||||||
|
- Added `ErrorCategory` enum and `AppError` base type in `src/transcription/errors.py`.
|
||||||
|
- Added helper utilities:
|
||||||
|
- `new_error_id()`
|
||||||
|
- `build_error_envelope(...)`
|
||||||
|
- `classify_unexpected_error(...)`
|
||||||
|
- `format_error_detail(...)`
|
||||||
|
|
||||||
|
### Phase C (Service/Provider normalization)
|
||||||
|
- `UploadError` now extends `AppError` and includes category/suggestion/retriable metadata.
|
||||||
|
- `PromptLoadError` and `TranscriptionError` now extend `AppError`.
|
||||||
|
- Provider failures are mapped with deterministic category semantics (auth/payload/provider-failure cases).
|
||||||
|
|
||||||
|
### Phase D (UI visibility)
|
||||||
|
- Added `src/transcription/ui/error_presenter.py`.
|
||||||
|
- Upload and jobs pages now use centralized UI error rendering and summary helpers.
|
||||||
|
- UI error paths now include more visible/actionable guidance and reference IDs.
|
||||||
|
|
||||||
|
### Phase E (Worker failure handling)
|
||||||
|
- Worker now normalizes exception handling into structured persisted `error_detail` strings with:
|
||||||
|
- category marker
|
||||||
|
- suggestion marker
|
||||||
|
- error_id marker
|
||||||
|
- Logging now includes category/error_id context in failure paths.
|
||||||
|
|
||||||
|
### Phase F (API envelope)
|
||||||
|
- Added `src/transcription/api/errors.py` and registered handlers in app factory.
|
||||||
|
- AppError and unexpected exceptions now serialize to stable API envelopes with mapped status codes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Validation Commands and Outcomes
|
||||||
|
|
||||||
|
All commands were executed with `uv run python -m pytest ...` and completed successfully.
|
||||||
|
|
||||||
|
1. `uv run python -m pytest tests/test_errors.py -q` ✅
|
||||||
|
2. `uv run python -m pytest tests/services/test_upload.py -q` ✅
|
||||||
|
3. `uv run python -m pytest tests/services/test_transcription.py -q` ✅
|
||||||
|
4. `uv run python -m pytest tests/providers/test_openrouter.py -q` ✅
|
||||||
|
5. `uv run python -m pytest tests/services/test_worker.py -q` ✅
|
||||||
|
6. `uv run python -m pytest tests/integration/test_pipeline_flow.py -q` ✅
|
||||||
|
7. `uv run python -m pytest tests/api/test_error_responses.py -q` ✅
|
||||||
|
8. `uv run python -m pytest tests/ui/test_upload_page.py -q` ✅
|
||||||
|
9. `uv run python -m pytest tests/ui/test_jobs_page.py -q` ✅
|
||||||
|
10. `uv run python -m pytest -m "not external" -q` ✅
|
||||||
|
11. `uv run python -m pytest --collect-only -q` ✅
|
||||||
|
12. `uv run python -m pytest -m unit -q` ✅
|
||||||
|
13. `uv run python -m pytest -m integration -q` ✅
|
||||||
|
14. `uv run python -m pytest tests/integration/test_pipeline_flow.py -q` ✅
|
||||||
|
15. `uv run python -m pytest tests/ui/test_upload_page.py -q` ✅
|
||||||
|
16. `uv run python -m pytest tests/ui/test_jobs_page.py -q` ✅
|
||||||
|
17. `uv run python -m pytest -q` ✅
|
||||||
|
|
||||||
|
Observed warning (non-blocking): Starlette/FastAPI TestClient deprecation warning related to `httpx` package naming.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Policy Alignment Check (`docs/error_handling.md`)
|
||||||
|
|
||||||
|
Aligned items:
|
||||||
|
- Stable taxonomy categories are implemented.
|
||||||
|
- Unexpected errors are normalized.
|
||||||
|
- User-facing UI paths include actionable guidance and references.
|
||||||
|
- Worker persistence includes trace-friendly failure detail.
|
||||||
|
- API error responses are structured and category-aware.
|
||||||
|
|
||||||
|
Follow-up candidates:
|
||||||
|
- Add richer UI tests that validate rendered suggested-action content end-to-end (current tests focus helper/service contracts).
|
||||||
|
- Consider typed storage fields for error metadata instead of packed `error_detail` strings in a future schema revision.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 7 Definition of Done Status
|
||||||
|
|
||||||
|
- [x] Shared error taxonomy implemented across MVP layers
|
||||||
|
- [x] GUI error paths upgraded for visibility/actionability
|
||||||
|
- [x] Worker failure persistence and log context standardized
|
||||||
|
- [x] API error envelope handling added and tested
|
||||||
|
- [x] Phase-level and full-suite validation gates passed
|
||||||
|
- [x] Results documented in this report
|
||||||
|
|
||||||
|
Step 7 is complete.
|
||||||
@@ -0,0 +1,267 @@
|
|||||||
|
## Step 7: Error Handling Standardization and Operational Visibility
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Apply the canonical error policy from `docs/error_handling.md` to the MVP implementation so failures are:
|
||||||
|
|
||||||
|
- consistently classified
|
||||||
|
- visibly surfaced in the GUI
|
||||||
|
- paired with suggested corrective actions
|
||||||
|
- traceable through logs via error reference IDs
|
||||||
|
- validated through deterministic tests after each phase
|
||||||
|
|
||||||
|
This step extends MVP hardening by converting current ad hoc exception behavior into a stable cross-layer contract.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
- Introduce a shared application error contract and taxonomy implementation
|
||||||
|
- Normalize service/provider exceptions into taxonomy categories
|
||||||
|
- Improve GUI error visibility and suggested-action UX
|
||||||
|
- Standardize worker failure persistence and logging context
|
||||||
|
- Add API error-envelope policy hooks for current/future endpoints
|
||||||
|
- Add targeted tests and phase-level/full-suite validation gates
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Major architecture rewrites (distributed queue, multi-service decomposition)
|
||||||
|
- Post-MVP feature expansion unrelated to error handling
|
||||||
|
- Full observability platform rollout (tracing backends, APM)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Policy Source of Truth
|
||||||
|
|
||||||
|
- Canonical policy document: `docs/error_handling.md`
|
||||||
|
- If implementation and policy diverge, policy is authoritative and code/tests must be updated.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planned Deliverables
|
||||||
|
|
||||||
|
### Runtime code
|
||||||
|
- `src/transcription/errors.py` *(new shared contract module)*
|
||||||
|
- `src/transcription/ui/error_presenter.py` *(new UI error rendering helper)*
|
||||||
|
- Updates to:
|
||||||
|
- `src/transcription/services/upload.py`
|
||||||
|
- `src/transcription/services/transcription.py`
|
||||||
|
- `src/transcription/providers/openrouter.py`
|
||||||
|
- `src/transcription/worker.py`
|
||||||
|
- `src/transcription/ui/upload_page.py`
|
||||||
|
- `src/transcription/ui/jobs_page.py`
|
||||||
|
- `src/transcription/api/*` *(as needed for envelope/handlers)*
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- `tests/test_errors.py` *(new shared error contract tests)*
|
||||||
|
- updates/additions in:
|
||||||
|
- `tests/services/test_upload.py`
|
||||||
|
- `tests/services/test_transcription.py` *(add if missing)*
|
||||||
|
- `tests/providers/test_openrouter.py`
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
- `tests/ui/test_upload_page.py`
|
||||||
|
- `tests/ui/test_jobs_page.py`
|
||||||
|
- `tests/api/test_error_responses.py` *(new, if API handlers added)*
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
- Update `docs/error_handling.md` only if implementation reveals policy gaps
|
||||||
|
- Capture validation evidence in a Step 7 results artifact (`docs/step7-results.md`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Design and Policy Decisions
|
||||||
|
|
||||||
|
1. **Stable taxonomy contract**
|
||||||
|
- Use policy categories as stable identifiers (`validation_error`, `user_input_error`, etc.).
|
||||||
|
|
||||||
|
2. **Actionable UX is mandatory**
|
||||||
|
- User-visible errors must include a suggested course of action.
|
||||||
|
|
||||||
|
3. **Traceability by default**
|
||||||
|
- Non-trivial errors include an `error_id` in both logs and user-facing output.
|
||||||
|
|
||||||
|
4. **Safe surface / rich logs**
|
||||||
|
- UI/API show safe summaries; logs retain diagnostic detail and traceback.
|
||||||
|
|
||||||
|
5. **Deterministic verification cadence**
|
||||||
|
- Targeted tests after each change batch, then phase-level regression gates.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Plan + Checklist
|
||||||
|
|
||||||
|
## Phase A — Baseline Validation and Gap Confirmation
|
||||||
|
|
||||||
|
- [ ] Run baseline tests before changes
|
||||||
|
- [ ] Record baseline outputs and any known flaky behavior
|
||||||
|
- [ ] Confirm current behavior against `docs/error_handling.md` requirements
|
||||||
|
|
||||||
|
### Validation gate
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
- [ ] `uv run pytest -q`
|
||||||
|
|
||||||
|
## Phase B — Shared Error Contract Foundation
|
||||||
|
|
||||||
|
- [ ] Add `src/transcription/errors.py` with:
|
||||||
|
- [ ] stable category enum
|
||||||
|
- [ ] base `AppError` (category/message/suggestion/error_id/retriable)
|
||||||
|
- [ ] helpers for error-id generation and fallback classification
|
||||||
|
- [ ] Keep category names aligned with `docs/error_handling.md`
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- [ ] Add `tests/test_errors.py`
|
||||||
|
- [ ] category stability assertions
|
||||||
|
- [ ] error_id creation behavior
|
||||||
|
- [ ] fallback classification for unexpected exceptions
|
||||||
|
|
||||||
|
### Validation gate
|
||||||
|
- [ ] `uv run pytest tests/test_errors.py -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
|
||||||
|
## Phase C — Service and Provider Normalization
|
||||||
|
|
||||||
|
- [ ] Refactor upload service exceptions to shared taxonomy
|
||||||
|
- [ ] Refactor transcription service exceptions to shared taxonomy
|
||||||
|
- [ ] Normalize provider adapter failures into deterministic categories
|
||||||
|
- [ ] Preserve causal chaining (`raise ... from exc`)
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- [ ] Extend `tests/services/test_upload.py`:
|
||||||
|
- [ ] empty payload category/suggestion
|
||||||
|
- [ ] unsupported extension category/suggestion
|
||||||
|
- [ ] persistence failure category mapping
|
||||||
|
- [ ] Add/extend `tests/services/test_transcription.py`:
|
||||||
|
- [ ] missing/empty prompt behavior
|
||||||
|
- [ ] unsupported file type behavior
|
||||||
|
- [ ] provider failure mapping behavior
|
||||||
|
- [ ] Extend `tests/providers/test_openrouter.py`:
|
||||||
|
- [ ] auth error mapping
|
||||||
|
- [ ] malformed response mapping
|
||||||
|
|
||||||
|
### Validation gate
|
||||||
|
- [ ] `uv run pytest tests/services/test_upload.py -q`
|
||||||
|
- [ ] `uv run pytest tests/services/test_transcription.py -q`
|
||||||
|
- [ ] `uv run pytest tests/providers/test_openrouter.py -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
|
||||||
|
## Phase D — GUI Visibility and Suggested Actions
|
||||||
|
|
||||||
|
- [ ] Add `src/transcription/ui/error_presenter.py`
|
||||||
|
- [ ] Update upload/jobs pages to use centralized error presentation
|
||||||
|
- [ ] Ensure GUI surfaces:
|
||||||
|
- [ ] user-safe message
|
||||||
|
- [ ] suggested action
|
||||||
|
- [ ] error reference ID
|
||||||
|
- [ ] optional technical details panel
|
||||||
|
- [ ] Replace raw `str(exc)` UX where policy requires safer messaging
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- [ ] Extend `tests/ui/test_upload_page.py` for actionable error UX paths
|
||||||
|
- [ ] Extend `tests/ui/test_jobs_page.py` for refresh/detail error guidance
|
||||||
|
- [ ] Add `tests/ui/test_error_presenter.py` *(optional but recommended)*
|
||||||
|
|
||||||
|
### Validation gate
|
||||||
|
- [ ] `uv run pytest tests/ui/test_upload_page.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_jobs_page.py -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
|
||||||
|
## Phase E — Worker Failure Persistence and Logging Context
|
||||||
|
|
||||||
|
- [ ] Update worker failure handling to classify errors before persistence
|
||||||
|
- [ ] Ensure failed jobs persist actionable, structured error detail
|
||||||
|
- [ ] Add log context fields where available (`error_id`, `category`, `operation`, `job_id`)
|
||||||
|
- [ ] Ensure retry semantics are explicit and bounded (or clearly documented as deferred)
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- [ ] Extend `tests/services/test_worker.py`:
|
||||||
|
- [ ] missing document failure contract
|
||||||
|
- [ ] provider/transcription failure contract
|
||||||
|
- [ ] persisted error detail includes category/suggestion/error_id markers
|
||||||
|
- [ ] Validate integration failure flow in `tests/integration/test_pipeline_flow.py`
|
||||||
|
|
||||||
|
### Validation gate
|
||||||
|
- [ ] `uv run pytest tests/services/test_worker.py -q`
|
||||||
|
- [ ] `uv run pytest tests/integration/test_pipeline_flow.py -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
|
||||||
|
## Phase F — API Error Envelope Alignment (Current + Future Routes)
|
||||||
|
|
||||||
|
- [ ] Add shared API error serialization utilities/handlers (as needed)
|
||||||
|
- [ ] Ensure API responses can include:
|
||||||
|
- [ ] `error_id`
|
||||||
|
- [ ] `category`
|
||||||
|
- [ ] `message`
|
||||||
|
- [ ] `suggestion`
|
||||||
|
- [ ] `timestamp`
|
||||||
|
- [ ] Map categories to HTTP status guidance from `docs/error_handling.md`
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
- [ ] Add `tests/api/test_error_responses.py` *(if handlers added)*
|
||||||
|
- [ ] Keep `tests/api/test_health.py` passing
|
||||||
|
|
||||||
|
### Validation gate
|
||||||
|
- [ ] `uv run pytest tests/api/test_error_responses.py -q` *(if added)*
|
||||||
|
- [ ] `uv run pytest tests/api/test_health.py -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
|
||||||
|
## Phase G — Final Regression and Documentation Closure
|
||||||
|
|
||||||
|
- [ ] Reconcile implementation details with `docs/error_handling.md`
|
||||||
|
- [ ] Update policy doc only where required by confirmed implementation learning
|
||||||
|
- [ ] Capture execution evidence in `docs/step7-results.md`
|
||||||
|
|
||||||
|
### Final validation sequence (strict)
|
||||||
|
- [ ] `uv run pytest --collect-only -q`
|
||||||
|
- [ ] `uv run pytest -m unit -q`
|
||||||
|
- [ ] `uv run pytest -m integration -q`
|
||||||
|
- [ ] `uv run pytest -m "not external" -q`
|
||||||
|
- [ ] `uv run pytest tests/integration/test_pipeline_flow.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_upload_page.py -q`
|
||||||
|
- [ ] `uv run pytest tests/ui/test_jobs_page.py -q`
|
||||||
|
- [ ] `uv run pytest -q`
|
||||||
|
|
||||||
|
Optional:
|
||||||
|
- [ ] `uv run pytest -m external -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Guardrails
|
||||||
|
|
||||||
|
- Do not weaken user-facing clarity to expose raw internals.
|
||||||
|
- Do not introduce silent exception swallowing.
|
||||||
|
- Do not break category-name stability without policy update.
|
||||||
|
- Do not merge phase changes without passing that phase validation gate.
|
||||||
|
- Keep targeted tests fast and deterministic; isolate external-provider tests under `external`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Definition of Done (Step 7)
|
||||||
|
|
||||||
|
- [ ] Shared error taxonomy is implemented and used across MVP layers
|
||||||
|
- [ ] GUI error experiences are visible, actionable, and traceable
|
||||||
|
- [ ] Worker persists and logs failure context consistently
|
||||||
|
- [ ] API error contract path is aligned for current/future endpoints
|
||||||
|
- [ ] Phase-by-phase test gates pass
|
||||||
|
- [ ] Full suite remains green (`uv run pytest -q`)
|
||||||
|
- [ ] Step 7 results are documented with evidence
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## PR Checklist (Step 7)
|
||||||
|
|
||||||
|
### Implementation
|
||||||
|
- [ ] Added shared error contract module
|
||||||
|
- [ ] Updated service/provider/worker/UI error handling paths
|
||||||
|
- [ ] Added actionable GUI guidance for user-visible failures
|
||||||
|
- [ ] Added error reference IDs for traceability
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
- [ ] Added/updated tests per phase scope
|
||||||
|
- [ ] Ran targeted phase tests after each change batch
|
||||||
|
- [ ] Ran `not external` regression at each phase boundary
|
||||||
|
- [ ] Ran full suite before closeout
|
||||||
|
|
||||||
|
### Documentation and Evidence
|
||||||
|
- [ ] `docs/error_handling.md` reviewed for alignment
|
||||||
|
- [ ] `docs/step7-results.md` includes executed command outputs
|
||||||
|
- [ ] Residual risks and deferred items explicitly recorded
|
||||||
+209
@@ -0,0 +1,209 @@
|
|||||||
|
## MVP Definition: Historical Document Transcription System
|
||||||
|
|
||||||
|
### 1. MVP Objective
|
||||||
|
Deliver the thinnest possible end-to-end vertical slice — a user uploads an image of a document, the system transcribes it via the OpenRouter Python SDK, and the user reads the resulting transcript — with just enough persistence and structure to validate the core value proposition: *can AI-driven transcription, guided by curated prompts, produce useful verbatim transcripts of historical family documents?*
|
||||||
|
|
||||||
|
The MVP deliberately defers full-text search, export, revision history, MongoDB, and timeline assembly. These are additive features that don't need validation before the core transcription loop is proven.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Core User Story
|
||||||
|
*As a family historian, I can upload a photo of a historical document, wait for it to be transcribed, and read the verbatim transcript — so I can evaluate whether this system will work for my thousands of documents.*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. In-Scope Requirements (from ```requirements.md```)
|
||||||
|
|
||||||
|
| Requirement | ID | MVP Rationale |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| End-to-end transcription with lifecycle state | REQ-0 | This is the MVP. |
|
||||||
|
| Upload one or more images from the web UI | REQ-1 | Core entry point. MVP supports single-image upload (multi-image is a stretch goal). |
|
||||||
|
| Asynchronous processing → transcription or failure | REQ-2 | Validates the AI transcription pipeline. |
|
||||||
|
| Persist and expose job states (queued → processing → transcribed/failed) | REQ-3 | Minimum feedback loop for the user. |
|
||||||
|
| Persist transcription output and failure details | REQ-4 | User must be able to read the result. |
|
||||||
|
| UI views for status and transcript reading | REQ-5 | The user needs to see what happened. |
|
||||||
|
| Background processing to keep UI responsive | REQ-6 | Essential for usability during long AI calls. |
|
||||||
|
| Centralized config and logging at startup | REQ-8 | Small effort, high payoff for debugging. |
|
||||||
|
| Store transcription prompts as Markdown files | REQ-12 | Core to the Prompt Curation Policy in intent.md. Start with a single prompt file. |
|
||||||
|
|
||||||
|
|
||||||
|
### Deferred to Post-MVP
|
||||||
|
| Requirement | ID | Why Deferred |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Lifespan-owned runtime resources (engine, session factory, etc.) | REQ-7 | Important for production robustness, but a simple global or module-level setup is adequate for MVP validation. |
|
||||||
|
| Docker Compose (app + PostgreSQL + optional MongoDB) | REQ-9 | MVP runs locally with SQLite to eliminate container overhead during rapid iteration. PostgreSQL migration is Stage 1 hardening. |
|
||||||
|
| Explicit, opt-in schema bootstrap | REQ-10 | MVP uses auto-create-tables at startup (SQLModel create_all). Production schema discipline comes after the model stabilizes. |
|
||||||
|
| Service-backed persistence for core data | REQ-11 | MVP uses a thin repository layer over SQLite. Full service abstraction follows once the domain model is proven. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. MVP Feature Set
|
||||||
|
#### Feature 1: Document Upload (UI)
|
||||||
|
* A single NiceGUI page with a file-upload widget (accepts .jpg, .png, .tiff, .pdf).
|
||||||
|
* On upload: save the file to a local uploads/ directory, create a Document record, create a Job record with status queued.
|
||||||
|
* Minimal metadata capture: original filename, upload timestamp.
|
||||||
|
|
||||||
|
#### Feature 2: Asynchronous Transcription Worker
|
||||||
|
* An in-process background worker (Python asyncio task or BackgroundTasks) that:
|
||||||
|
1. Picks up queued jobs.
|
||||||
|
2. Transitions status to processing.
|
||||||
|
3. Sends the image + the curated Markdown prompt to an AI vision model via OpenRouter.
|
||||||
|
4. On success: saves the transcript text, transitions to transcribed.
|
||||||
|
5. On failure: saves the error detail, transitions to failed.
|
||||||
|
|
||||||
|
#### Feature 3: Transcription Prompt (Markdown Asset)
|
||||||
|
* A single Markdown file (prompts/transcribe_document.md) encoding the verbatim transcription rules from intent.md (the Document Issues table, scholarly guidelines, etc.).
|
||||||
|
* The worker reads this file at invocation time and injects it as the system/user prompt.
|
||||||
|
|
||||||
|
#### Feature 4: Job Status & Transcript Viewer (UI)
|
||||||
|
* A job list page showing all jobs with their current status (queued / processing / transcribed / failed).
|
||||||
|
* A transcript detail page showing:
|
||||||
|
* The original uploaded image (rendered inline).
|
||||||
|
* The transcription text (or the failure reason).
|
||||||
|
* Timestamp metadata.
|
||||||
|
|
||||||
|
#### Feature 5: Minimal Persistence (SQLite + SQLModel)
|
||||||
|
* Three tables/models:
|
||||||
|
* Document: id, filename, file_path, uploaded_at.
|
||||||
|
* Job: id, document_id (FK), status, created_at, updated_at.
|
||||||
|
* Transcript: id, job_id (FK), text, error_detail, created_at.
|
||||||
|
* SQLite database file stored locally. Auto-created on first startup.
|
||||||
|
|
||||||
|
#### Feature 6: Centralized Configuration
|
||||||
|
* A single config.py (or Pydantic BaseSettings) loading:
|
||||||
|
* PROVIDER (fixed to openrouter for MVP)
|
||||||
|
* OPENROUTER_API_KEY (required)
|
||||||
|
* PROVIDER_MODEL (default: OpenRouter model slug for vision transcription)
|
||||||
|
* OPENROUTER_HTTP_REFERER (optional; app attribution)
|
||||||
|
* OPENROUTER_APP_TITLE (optional; app attribution)
|
||||||
|
* DATABASE_URL (default: sqlite:///./transcription.db)
|
||||||
|
* UPLOAD_DIR (default: ./uploads)
|
||||||
|
* PROMPT_DIR (default: ./prompts)
|
||||||
|
|
||||||
|
#### Feature 7: MVP Dependency Baseline (OpenRouter-Centric)
|
||||||
|
* Runtime dependencies:
|
||||||
|
* openrouter (official OpenRouter Python SDK)
|
||||||
|
* pydantic
|
||||||
|
* pydantic-settings
|
||||||
|
* sqlmodel
|
||||||
|
* Explicitly out of MVP runtime dependencies:
|
||||||
|
* google-genai (deferred until/if Gemini is introduced post-MVP)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. MVP Architecture (Simplified)
|
||||||
|
|
||||||
|
```Apply
|
||||||
|
┌─────────────────────────────────────────────┐
|
||||||
|
│ NiceGUI Web UI │
|
||||||
|
│ ┌──────────────┐ ┌───────────────────┐ │
|
||||||
|
│ │ Upload Page │ │ Jobs / Transcript │ │
|
||||||
|
│ └──────┬───────┘ └───────┬───────────┘ │
|
||||||
|
│ │ │ │
|
||||||
|
│ ▼ ▼ │
|
||||||
|
│ ┌───────────────────────────┐ │
|
||||||
|
│ │ Application Service │ │
|
||||||
|
│ │ (upload, job lifecycle) │ │
|
||||||
|
│ └─────┬─────────────┬───────┘ │
|
||||||
|
│ │ │ │
|
||||||
|
│ ┌─────▼─────┐ ┌─────▼───────────────┐ │
|
||||||
|
│ │ SQLite DB │ │ Background Worker │ │
|
||||||
|
│ │ (SQLModel)│ │ → AI Vision Provider│ │
|
||||||
|
│ └───────────┘ └─────────────────────┘ │
|
||||||
|
│ │ │
|
||||||
|
│ ┌─────▼──────┐ │
|
||||||
|
│ │ prompts/ │ │
|
||||||
|
│ │ *.md files │ │
|
||||||
|
│ └────────────┘ │
|
||||||
|
└─────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 6. Proposed File Structure
|
||||||
|
|
||||||
|
```Apply
|
||||||
|
project-root/
|
||||||
|
├── docs/ # (existing)
|
||||||
|
├── prompts/
|
||||||
|
│ └── transcribe_document.md # curated transcription prompt
|
||||||
|
├── src/
|
||||||
|
│ └── transcription/
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── app.py # FastAPI + NiceGUI app entrypoint
|
||||||
|
│ ├── config.py # Pydantic BaseSettings
|
||||||
|
│ ├── models.py # SQLModel: Document, Job, Transcript
|
||||||
|
│ ├── db.py # engine, session, create_all
|
||||||
|
│ ├── providers/
|
||||||
|
│ │ ├── __init__.py
|
||||||
|
│ │ ├── base.py # provider interface (transcribe contract)
|
||||||
|
│ │ ├── openrouter.py # OpenRouter via official Python SDK
|
||||||
|
│ ├── services/
|
||||||
|
│ │ ├── __init__.py
|
||||||
|
│ │ ├── upload.py # save file + create records
|
||||||
|
│ │ └── transcription.py # call provider, update job
|
||||||
|
│ ├── worker.py # background job loop
|
||||||
|
│ └── ui/
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── upload_page.py # NiceGUI upload page
|
||||||
|
│ └── jobs_page.py # NiceGUI job list + detail
|
||||||
|
├── tests/
|
||||||
|
│ ├── test_models.py
|
||||||
|
│ ├── test_upload.py
|
||||||
|
│ └── test_transcription.py
|
||||||
|
├── pyproject.toml
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 7. MVP Validation Criteria
|
||||||
|
The MVP is considered validated when:
|
||||||
|
|
||||||
|
1. ✅ A user can upload an image of a document through the browser.
|
||||||
|
2. ✅ The system asynchronously sends the image to the configured AI vision model with the curated prompt.
|
||||||
|
3. ✅ The transcript (or failure reason) is persisted and visible in the UI.
|
||||||
|
4. ✅ The transcription follows verbatim scholarly rules defined in intent.md (spot-checked by the user on real family documents).
|
||||||
|
5. ✅ The transcription prompt is stored as a standalone Markdown file and can be edited without code changes.
|
||||||
|
6. ✅ Job status transitions are visible: queued → processing → transcribed/failed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 8. Key Feedback Questions the MVP Should Answer
|
||||||
|
These are the real unknowns this MVP exists to resolve:
|
||||||
|
|
||||||
|
| # | Question | How We Learn |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| 1 | Is AI transcription quality good enough for this document corpus? | User reviews 20–50 real transcriptions against originals. |
|
||||||
|
| 2 | Does the verbatim prompt produce scholarly-quality output, or does it need major rework? | Compare output to the Document Issues table rules in intent.md. |
|
||||||
|
| 3 | What document types are hardest (old cursive, faded ink, pencil, postcards)? | Track which uploads produce failed or low-quality results. |
|
||||||
|
| 4 | Is single-image upload sufficient, or is batch upload needed early? | User friction during real scanning sessions. |
|
||||||
|
| 5 | What metadata is missing that the user wishes they could capture at upload time? | User feedback after processing real batches. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 9. What Comes After MVP (Immediate Post-MVP)
|
||||||
|
Once the core transcription loop is validated, the next priorities (aligned to Architecture Stage 1) are:
|
||||||
|
|
||||||
|
1. **Multi-image upload** — process a batch from a scanning session.
|
||||||
|
2. **PostgreSQL migration** — swap SQLite for containerized PostgreSQL (REQ-9, REQ-10).
|
||||||
|
3. **Revision history** — allow the user to edit/correct transcripts with immutable version tracking.
|
||||||
|
4. **Full-text search** — search across all accepted transcripts.
|
||||||
|
5. **Repository/service layer formalization** — proper ports/adapters as the domain model stabilizes.
|
||||||
|
6. **Docker Compose deployment** — containerize the app for reproducible operation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### 10. Implementation Approach
|
||||||
|
Recommended build order for the MVP (each step produces a testable increment):
|
||||||
|
|
||||||
|
| Step | Deliverable | Validates |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| 1 | config.py + models.py + db.py — data layer with SQLite | Schema and config foundation |
|
||||||
|
| 2 | prompts/transcribe_document.md — curated prompt from intent.md | Prompt asset pattern |
|
||||||
|
| 3 | services/transcription.py + providers/ — call AI vision provider with prompt + image | Core AI integration |
|
||||||
|
| 4 | services/upload.py + worker.py — upload handling + background job loop | End-to-end pipeline (CLI-testable) |
|
||||||
|
| 5 | ui/upload_page.py + ui/jobs_page.py — NiceGUI pages | User-facing interface |
|
||||||
|
| 6 | tests/ — unit + integration tests Automated verification |
|
||||||
|
|
||||||
|
This MVP is deliberately narrow: **one prompt, one provider (OpenRouter), one user, one image at a time, SQLite, no containers**. Every omission is intentional — the goal is to get real family documents through the transcription pipeline as fast as possible and let the quality of the output guide every subsequent decision.
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
## Document Transcription System Requirements
|
## Document Transcription System Requirements
|
||||||
|
|
||||||
This page captures a SysML v1.6-style requirements baseline for the production system described in [index_v1.md](index_v1.md). The model is represented as concise tables and traceability lists that preserve SysML-style IDs and relationship semantics.
|
This page captures a SysML v1.6-style requirements baseline for the production system described in [index.md](index.md). The model is represented as concise tables and traceability lists that preserve SysML-style IDs and relationship semantics.
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
|
|
||||||
@@ -15,9 +15,9 @@ This page captures a SysML v1.6-style requirements baseline for the production s
|
|||||||
| ID | Category | Requirement | Risk | Verify Method |
|
| ID | Category | Requirement | Risk | Verify Method |
|
||||||
| --- | --- | --- | --- | --- |
|
| --- | --- | --- | --- | --- |
|
||||||
| REQ-0 | System | Provide end-to-end document transcription with persistent, inspectable lifecycle state. | medium | demonstration |
|
| REQ-0 | System | Provide end-to-end document transcription with persistent, inspectable lifecycle state. | medium | demonstration |
|
||||||
| REQ-1 | Functional | Allow users to upload one or more images or PDFs as sources from the web UI. | low | test |
|
| REQ-1 | Functional | Allow users to upload one or more document images from the web UI. | low | test |
|
||||||
| REQ-2 | Functional | Run each upload through asynchronous processing that returns an original transcription or explicit failure. | high | test |
|
| REQ-2 | Functional | Run each upload through asynchronous processing that returns a transcription or explicit failure. | high | test |
|
||||||
| REQ-3 | Functional | Persist and expose job states: queued, processing, transcribed, failed. | high | inspection |
|
| REQ-3 | Functional | Persist and expose job states: upload, queued, processing, transcribed, failed, completed. | high | inspection |
|
||||||
| REQ-4 | Functional | Persist transcription output, processing history, and failure details. | medium | test |
|
| REQ-4 | Functional | Persist transcription output, processing history, and failure details. | medium | test |
|
||||||
| REQ-5 | Interface | Expose API and UI views for status inspection and completed transcription reading. | medium | demonstration |
|
| REQ-5 | Interface | Expose API and UI views for status inspection and completed transcription reading. | medium | demonstration |
|
||||||
| REQ-6 | Performance | Trigger background processing on upload to preserve UI responsiveness. | medium | analysis |
|
| REQ-6 | Performance | Trigger background processing on upload to preserve UI responsiveness. | medium | analysis |
|
||||||
@@ -27,11 +27,10 @@ This page captures a SysML v1.6-style requirements baseline for the production s
|
|||||||
| REQ-10 | Design Constraint | Keep schema bootstrap explicit and opt-in; normal startup does not mutate production schema. | high | inspection |
|
| REQ-10 | Design Constraint | Keep schema bootstrap explicit and opt-in; normal startup does not mutate production schema. | high | inspection |
|
||||||
| REQ-11 | Design Constraint | Use service-backed persistence for core document and job data. | medium | inspection |
|
| REQ-11 | Design Constraint | Use service-backed persistence for core document and job data. | medium | inspection |
|
||||||
| REQ-12 | Design Constraint | Store transcription prompts as individual Markdown artifacts for iterative refinement. | medium | inspection |
|
| REQ-12 | Design Constraint | Store transcription prompts as individual Markdown artifacts for iterative refinement. | medium | inspection |
|
||||||
| REQ-13 | Functional | Allow users to create one optional revision of transcription text derived from the original job transcription. | low | test |
|
|
||||||
|
|
||||||
### Requirement Relationships
|
### Requirement Relationships
|
||||||
|
|
||||||
- Contains: REQ-0 contains REQ-1 through REQ-13.
|
- Contains: REQ-0 contains REQ-1 through REQ-12.
|
||||||
- Derives: REQ-2 -> REQ-3, REQ-3 -> REQ-4.
|
- Derives: REQ-2 -> REQ-3, REQ-3 -> REQ-4.
|
||||||
- Traces: REQ-5 -> REQ-3.
|
- Traces: REQ-5 -> REQ-3.
|
||||||
- Refines: REQ-6 -> REQ-2.
|
- Refines: REQ-6 -> REQ-2.
|
||||||
@@ -51,17 +50,17 @@ This page captures a SysML v1.6-style requirements baseline for the production s
|
|||||||
|
|
||||||
### Satisfaction Mapping
|
### Satisfaction Mapping
|
||||||
|
|
||||||
- UI satisfies REQ-1, REQ-5, REQ-13.
|
- UI satisfies REQ-1, REQ-5.
|
||||||
- API satisfies REQ-5.
|
- API satisfies REQ-5.
|
||||||
- GRAPH satisfies REQ-2, REQ-6.
|
- GRAPH satisfies REQ-2, REQ-6.
|
||||||
- DBREL satisfies REQ-3, REQ-10, REQ-13.
|
- DBREL satisfies REQ-3, REQ-10.
|
||||||
- DBDOC satisfies REQ-4, REQ-11.
|
- DBDOC satisfies REQ-4, REQ-11.
|
||||||
- OPS satisfies REQ-9.
|
- OPS satisfies REQ-9.
|
||||||
- PROMPTS satisfies REQ-12.
|
- PROMPTS satisfies REQ-12.
|
||||||
|
|
||||||
### Verification Mapping
|
### Verification Mapping
|
||||||
|
|
||||||
- TESTS verifies REQ-1, REQ-2, REQ-3, REQ-4, REQ-5, REQ-10, REQ-11, REQ-12, REQ-13.
|
- TESTS verifies REQ-1, REQ-2, REQ-3, REQ-4, REQ-5, REQ-10, REQ-11, REQ-12.
|
||||||
|
|
||||||
## Requirement Notes
|
## Requirement Notes
|
||||||
|
|
||||||
@@ -77,19 +76,6 @@ This page captures a SysML v1.6-style requirements baseline for the production s
|
|||||||
- Analysis: evaluate asynchronous execution behavior and design sufficiency.
|
- Analysis: evaluate asynchronous execution behavior and design sufficiency.
|
||||||
- Test: automate behavioral checks through pytest suites and service-level tests.
|
- Test: automate behavioral checks through pytest suites and service-level tests.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v1.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v1.md)
|
|
||||||
- System Requirements (this document)
|
|
||||||
- [Data model](schema_v1.md)
|
|
||||||
- [Error Handling Policy](error_handling_v1.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v1.md)
|
|
||||||
|
|
||||||
## Glossary
|
## Glossary
|
||||||
|
|
||||||
- Document-oriented persistence: A storage approach that uses flexible document structures for variable data shapes.
|
- Document-oriented persistence: A storage approach that uses flexible document structures for variable data shapes.
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
# Document Transcription System Requirements (Version 2)
|
|
||||||
|
|
||||||
This document captures the **Version 2 baseline requirements** for the production implementation.
|
|
||||||
|
|
||||||
## Requirements Model
|
|
||||||
|
|
||||||
| ID | Category | Requirement | Verify Method |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| REQ-0 | System | Provide end-to-end multi-page document transcription with persistent, inspectable async job states. | demonstration |
|
|
||||||
| REQ-1 | Functional | Allow users to upload folders or multi-image batches as sequential `Source` pages under a `Document`. | test |
|
|
||||||
| REQ-2 | Functional | Process multi-page jobs asynchronously using an `asyncio` worker pool bounded by rate limits. | test |
|
|
||||||
| REQ-3 | Functional | Persist page-level execution outputs (`raw_transcription`, `ai_metadata`, `raw_api_response`) on `JobSource`. | test |
|
|
||||||
| REQ-4 | Functional | Support job states (`queued`, `processing`, `completed`, `partial_success`, `failed`) and page states (`pending`, `transcribed`, `failed`). | inspection |
|
|
||||||
| REQ-5 | Functional | Allow users to manage historical `Person` records and link multiple authors/recipients to a `Document` via `DocumentPerson`. | test |
|
|
||||||
| REQ-6 | Functional | Maintain immutable original machine output on `Source.raw_transcription` while permitting inline human edits on `Source.revised_text`. | test |
|
|
||||||
| REQ-7 | Data Constraint | Store all persistent domain data in PostgreSQL using native `UUID`, `TIMESTAMPTZ`, and `JSONB` columns. | inspection |
|
|
||||||
| REQ-8 | Data Constraint | Validate all API requests, database rows, and JSONB structures using Pydantic V2 schemas. | test |
|
|
||||||
| REQ-9 | Interface | Render multi-page transcriptions sequentially by `page_number` in the web UI with author/recipient metadata. | demonstration |
|
|
||||||
| REQ-10 | Operations | Allow operators to retry only failed pages for jobs in a `partial_success` state. | test |
|
|
||||||
|
|
||||||
## Element Satisfaction Mapping
|
|
||||||
|
|
||||||
* **UI (NiceGUI):** Satisfies REQ-1, REQ-5, REQ-6, REQ-9, REQ-10.
|
|
||||||
* **API (FastAPI):** Satisfies REQ-1, REQ-4, REQ-5, REQ-8.
|
|
||||||
* **WORKER (asyncio):** Satisfies REQ-2, REQ-3, REQ-4, REQ-10.
|
|
||||||
* **PERSISTENCE (PostgreSQL):** Satisfies REQ-3, REQ-6, REQ-7.
|
|
||||||
* **MODELS (Pydantic V2):** Satisfies REQ-8.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v2.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v2.md)
|
|
||||||
- System Requirements (this document)
|
|
||||||
- [Data model](schema_v2.md)
|
|
||||||
- [Error Handling Policy](error_handling_v2.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v2.md)
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,136 +0,0 @@
|
|||||||
# Database Schema (Version 2)
|
|
||||||
|
|
||||||
This document describes the PostgreSQL relational schema for the transcription platform. It incorporates multi-image batch orchestration via `asyncio`, page-level execution tracking, many-to-many author/recipient attribution, and JSONB document storage for AI vision outputs.
|
|
||||||
|
|
||||||
All primary and foreign keys are PostgreSQL native UUIDs (`gen_random_uuid()`).
|
|
||||||
|
|
||||||
## Entity Relationship Diagram
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
erDiagram
|
|
||||||
PERSON {
|
|
||||||
UUID id PK
|
|
||||||
TEXT full_name
|
|
||||||
TEXT display_name
|
|
||||||
TEXT maiden_name
|
|
||||||
DATE birth_date
|
|
||||||
TEXT birth_date_raw
|
|
||||||
TEXT birth_place
|
|
||||||
DATE death_date
|
|
||||||
TEXT death_date_raw
|
|
||||||
TEXT death_place
|
|
||||||
TEXT biography
|
|
||||||
TEXT portrait_path
|
|
||||||
JSONB metadata
|
|
||||||
TIMESTAMPTZ created_at
|
|
||||||
TIMESTAMPTZ updated_at
|
|
||||||
}
|
|
||||||
|
|
||||||
DOCUMENT {
|
|
||||||
UUID id PK
|
|
||||||
TEXT name
|
|
||||||
TEXT document_type
|
|
||||||
DATE document_date
|
|
||||||
TEXT document_date_raw
|
|
||||||
TEXT location_created
|
|
||||||
TEXT notes
|
|
||||||
TEXT archive_identifier
|
|
||||||
TIMESTAMPTZ created_at
|
|
||||||
TIMESTAMPTZ updated_at
|
|
||||||
}
|
|
||||||
|
|
||||||
DOCUMENT_PERSON {
|
|
||||||
UUID id PK
|
|
||||||
UUID document_id FK
|
|
||||||
UUID person_id FK
|
|
||||||
VARCHAR role "author | recipient"
|
|
||||||
TIMESTAMPTZ created_at
|
|
||||||
}
|
|
||||||
|
|
||||||
JOB {
|
|
||||||
UUID id PK
|
|
||||||
UUID document_id FK
|
|
||||||
VARCHAR status "queued | processing | completed | partial_success | failed"
|
|
||||||
INTEGER retry_count
|
|
||||||
TEXT provider
|
|
||||||
TEXT model
|
|
||||||
TEXT prompt_name
|
|
||||||
TIMESTAMPTZ date_created
|
|
||||||
TIMESTAMPTZ date_updated
|
|
||||||
}
|
|
||||||
|
|
||||||
SOURCE {
|
|
||||||
UUID id PK
|
|
||||||
UUID document_id FK
|
|
||||||
INTEGER page_number
|
|
||||||
TEXT upload_name
|
|
||||||
TEXT filename
|
|
||||||
TEXT file_path
|
|
||||||
TEXT raw_transcription
|
|
||||||
TEXT revised_text
|
|
||||||
TIMESTAMPTZ date_uploaded
|
|
||||||
TIMESTAMPTZ date_revised
|
|
||||||
}
|
|
||||||
|
|
||||||
JOB_SOURCE {
|
|
||||||
UUID id PK
|
|
||||||
UUID job_id FK
|
|
||||||
UUID source_id FK
|
|
||||||
VARCHAR status "pending | transcribed | failed"
|
|
||||||
TEXT raw_transcription
|
|
||||||
JSONB ai_metadata
|
|
||||||
JSONB raw_api_response
|
|
||||||
TEXT error_detail
|
|
||||||
TIMESTAMPTZ executed_at
|
|
||||||
}
|
|
||||||
|
|
||||||
DOCUMENT ||--o{ DOCUMENT_PERSON : "has_people"
|
|
||||||
PERSON ||--o{ DOCUMENT_PERSON : "participates_in"
|
|
||||||
DOCUMENT ||--o{ JOB : "has_jobs"
|
|
||||||
DOCUMENT ||--o{ SOURCE : "contains_pages"
|
|
||||||
JOB ||--o{ JOB_SOURCE : "executes"
|
|
||||||
SOURCE ||--o{ JOB_SOURCE : "processed_in"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Domain Invariants & Rules
|
|
||||||
|
|
||||||
### Page-Level Execution & AI Outputs
|
|
||||||
|
|
||||||
* Execution Granularity: Every single image execution by an AI model produces a dedicated record in job_source.
|
|
||||||
* Point-in-Time Auditability: job_source.raw_api_response stores the unparsed REST response envelope for that specific image page call. job_source.ai_metadata stores spatial bounding boxes, token usage, and layout details for that specific image page call.
|
|
||||||
* Active Output Caching: Upon successful completion of an image call, source.raw_transcription is updated with the latest output string from job_source.raw_transcription for fast UI rendering.
|
|
||||||
|
|
||||||
### Page Ordering & Revisions
|
|
||||||
|
|
||||||
* Sequential Integrity: source.page_number dictates page ordering within a document. Reads assembling full documents must query ORDER BY source.document_id, source.page_number ASC.
|
|
||||||
* Inlined Human Corrections: User edits occur at the page level inside source.revised_text. source.raw_transcription remains immutable. If source.revised_text is non-null, application frontends must render source.revised_text.
|
|
||||||
|
|
||||||
### Async Job Lifecycle & Failure Isolation
|
|
||||||
|
|
||||||
* Batch Orchestrator: A job represents an overarching execution run across one or more source images belonging to a document.
|
|
||||||
* Isolated Failures: API requests run concurrently (e.g., using asyncio). A failure on page 3 does not invalidate successful transcriptions on page 1 or 2.
|
|
||||||
* Job States:
|
|
||||||
- queued: Created, awaiting worker execution.
|
|
||||||
- processing: Concurrent HTTP tasks actively running.
|
|
||||||
- completed: 100% of linked job_source tasks succeeded (transcribed).
|
|
||||||
- partial_success: At least one job_source succeeded and at least one failed.
|
|
||||||
- failed: All linked job_source tasks failed or a job-level runtime error occurred.
|
|
||||||
|
|
||||||
### Attribution & Person Roles
|
|
||||||
|
|
||||||
* Multi-Person Roles: Documents support zero, one, or many authors and recipients linked via document_person.
|
|
||||||
* Role Uniqueness: (document_id, person_id, role) must be unique to prevent duplicate role tagging.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v2.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v2.md)
|
|
||||||
- [System Requirements](requirements_v2.md)
|
|
||||||
- Data model (this document)
|
|
||||||
- [Error Handling Policy](error_handling_v2.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v2.md)
|
|
||||||
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
# Transcription Methodology & Style Guide
|
|
||||||
|
|
||||||
## 1. Overview & Core Philosophy
|
|
||||||
|
|
||||||
This document defines the formal transcription standard for processing historical manuscripts, letters, diaries, and printed ephemera.
|
|
||||||
|
|
||||||
Following the principles established by Mary-Jo Kline in A Guide to Documentary Editing, this project adheres to a Strict Literal Transcription (Verbatim) model as its foundational layer. The primary goal is total textual fidelity—capturing what the author wrote, not what they intended to write—while ensuring the output remains machine-readable and indexable for downstream digital query and search systems.
|
|
||||||
|
|
||||||
## 2. Textual Policy
|
|
||||||
|
|
||||||
Transcribers (human or AI) must record the exact text of the source document without silent corrections, modernizations, or stylistic smoothing except where explicitly instructed in this guide.
|
|
||||||
|
|
||||||
* **Substantives:** Words, letter forms, structural layout, and semantic content must be recorded strictly as presented in the original document.
|
|
||||||
|
|
||||||
* **Accidentals:** Punctuation, capitalization, misspellings, and archaic character representations must be preserved unless an explicit rule below allows for standardization.
|
|
||||||
|
|
||||||
## 3. Standard Transcription Rules & Markup
|
|
||||||
|
|
||||||
The following rules map directly to editorial conventions for handling common manuscript anomalies and physical document features.
|
|
||||||
|
|
||||||
### 3.1 Textual Anomalies & Corrections
|
|
||||||
|
|
||||||
| Document Feature | Rule | Standard Markup Format | Output Example |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| **Misspellings & Errors** | Retain original spelling verbatim. Insert an italicized [sic] immediately following the error. Do not correct spelling silently. | [sic] | The weather was very cold and publick [sic] business delayed. |
|
|
||||||
| **Missing Words / Omissions** | Insert necessary words required to restore basic grammatical sense inside square brackets. | [word] | We went [to] the store to buy supplies. |
|
|
||||||
| **Uncertain / Conjectural** | Place best hypothesis followed by a question mark inside square brackets when handwriting is doubtful. | [word?] | He went to [Boston?] yesterday to meet the governor. |
|
|
||||||
| **Completely Illegible** | Use [illegible] for unreadable script. Use explicit damage descriptors when physical impairment prevents reading. | [illegible] or [reason] | The total cost was [illegible] dollars. or The letter ends here [remainder of page torn]. |
|
|
||||||
| **Canceled / Struck-through** | Wrap text removed by the author inside a [deleted: ...] tag to preserve authorial revisions. | [deleted: text] | We left at [deleted: noon] one o'clock instead. |
|
|
||||||
| **Interlineations / Additions** | Wrap text inserted above, below, or in margins into the narrative flow inside an [inserted: ...] tag. | [inserted: text] | The [inserted: red] house on the hill was abandoned. |
|
|
||||||
|
|
||||||
### 3.2 Typography, Characters & Layout
|
|
||||||
|
|
||||||
| Document Feature | Rule | Standard Markup Format | Output Example |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| **Superscripts & Abbreviations** | Bring raised letters down to the main line. Optionally expand abbreviations within square brackets based on project configuration. | [expanded] | Gen^l becomes Genl or Gen[era]l. |
|
|
||||||
| **Line-End Hyphenation** | Rejoin words split across a page or line boundary silently, dropping the soft hyphen. | Silently rejoin | Original: "estab- / lishment" becomes establishment |
|
|
||||||
| **Capitalization** | Preserve explicit capitalization. Default to modern capitalization rules only when authorial intent is ambiguous or archaic forms confuse sentence structure. | Literal / Contextual | If a standard noun like 'Farm' is clearly capitalized, record 'Farm'. If ambiguous, default to 'farm'. |
|
|
||||||
| **Hierarchical Outlines** | Preserve exact numbering characters (including lowercase Roman numerals or terminal 'j'). Replicate indentation levels using standard spacing. Do not correct sequence or mathematical errors. | Preserve syntax | I. Main Topic a. Sub-point b. Next pointIII. [sic] Third Topic |
|
|
||||||
|
|
||||||
### 3.3 Visual & Spatial Elements
|
|
||||||
|
|
||||||
| Document Feature | Rule | Standard Markup Format | Output Example |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| **Non-Textual Artifacts** | Record non-textual elements (seals, stamps, sketches, physical damage) using brief descriptive text inside square brackets. | [description] | [wax notary seal attached here] or [sketch of a fort layout] |
|
|
||||||
| **Marginalia & Addenda** | Explicitly indicate spatial transitions before transcribing content located in margins or non-standard orientations. | [location:] | [written in left margin:] Do not share this with anyone. |
|
|
||||||
|
|
||||||
## 4. Prompt Asset Integration
|
|
||||||
|
|
||||||
When executing programmatic transcriptions via LLM APIs or local models, processing instructions must be packaged into single-purpose system prompts aligned with these rules.
|
|
||||||
|
|
||||||
1. **Isolation:** Each transcription prompt file exists as an independent Markdown asset in the repository.
|
|
||||||
2. **Deterministic Output:** Prompts must explicitly instruct models to follow the markup standards in Section 3 without introducing conversational wrappers, extra prose, or structural markdown outside the source document's native layout.
|
|
||||||
3. **Iterative Scoping:** Rule modifications or edge-case additions must be submitted as isolated delta commits to individual prompt files to maintain clean revision tracking.
|
|
||||||
@@ -1,203 +0,0 @@
|
|||||||
# Version 1 Implementation Plan
|
|
||||||
|
|
||||||
This plan defines the path from current implementation to **Version 1 complete**, aligned to the updated domain model:
|
|
||||||
|
|
||||||
- `Document` groups one or more content `Source` records
|
|
||||||
- `Job` owns original immutable provider output (`text`) and processing metadata
|
|
||||||
- `Revision` stores optional user-authored edits linked to a `Source`
|
|
||||||
|
|
||||||
The objective is to complete V1 scope with production readiness while keeping non-V1 enhancements out of active delivery.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## V1 Completion Definition
|
|
||||||
|
|
||||||
V1 is complete when all of the following are true:
|
|
||||||
|
|
||||||
1. **Functional complete**
|
|
||||||
- Upload, queue, processing, status display, and transcription result inspection work end-to-end.
|
|
||||||
- Optional revision workflow is implemented (create/view/update single revision).
|
|
||||||
2. **Data-model complete**
|
|
||||||
- Runtime behavior, persistence, and tests all align to `Document` / `Source` / `Job` / `Revision`.
|
|
||||||
3. **Operational complete**
|
|
||||||
- Error handling, logs, and runbooks support reliable operation.
|
|
||||||
4. **Documentation complete**
|
|
||||||
- Architecture, requirements, schema, error handling, and index are consistent and current.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 1 — Data Contract Stabilization (Schema-First)
|
|
||||||
|
|
||||||
**Goal:** Lock a single canonical contract before further feature work.
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
1. Confirm and document invariants:
|
|
||||||
- `Job.text` is original immutable transcription output.
|
|
||||||
- `Revision` is optional and user-authored.
|
|
||||||
- Revisions are derived from the original `Job.text`.
|
|
||||||
2. Verify relationship cardinality assumptions:
|
|
||||||
- `Document` -> many `Source`
|
|
||||||
- `Document` -> many `Job`
|
|
||||||
- `Source` -> one `Job`
|
|
||||||
- `Source` -> one `Revision`
|
|
||||||
3. Ensure field naming consistency (`date_created`, `date_updated`, `date_uploaded`) across code and docs.
|
|
||||||
4. Freeze V1 status lifecycle to current implementation (`queued`, `processing`, `transcribed`, `failed`).
|
|
||||||
|
|
||||||
### Deliverables
|
|
||||||
- Updated `schema_v1.md` and `requirements.md` traceability alignment.
|
|
||||||
- Explicit V1 data invariants section in architecture docs.
|
|
||||||
|
|
||||||
### Exit Criteria
|
|
||||||
- No conflicting definitions of ownership/cardinality/status remain in docs.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 2 — Service Layer Refactor To New Model
|
|
||||||
|
|
||||||
**Goal:** Remove all obsolete `Transcript` assumptions from service/workflow code.
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
1. Refactor `services/transcription.py`:
|
|
||||||
- Replace transcript CRUD assumptions with job-output + revision operations.
|
|
||||||
2. Refactor `services/jobs.py`:
|
|
||||||
- Replace old timestamp/relationship accessors with current model fields.
|
|
||||||
3. Refactor `services/documents.py` and `services/store.py`:
|
|
||||||
- Ensure upload creates and links `Document`, `Source`, and `Job` correctly.
|
|
||||||
4. Refactor `services/workflows.py`:
|
|
||||||
- Persist original provider output to `Job`.
|
|
||||||
- Persist failure detail to `Job.error_detail`.
|
|
||||||
- Use `Revision` only for user-authored edits.
|
|
||||||
|
|
||||||
### Deliverables
|
|
||||||
- Service layer fully aligned with new schema.
|
|
||||||
|
|
||||||
### Exit Criteria
|
|
||||||
- No service module imports or persists `Transcript` model artifacts.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 3 — UI Contract Alignment
|
|
||||||
|
|
||||||
**Goal:** Align pages/components to source/job/revision semantics.
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
1. Update job detail and related UI components:
|
|
||||||
- Display original immutable transcription from `Job.text`.
|
|
||||||
- Display optional revision sourced from `Source.revision` (0 or 1).
|
|
||||||
2. Align date fields with new schema naming.
|
|
||||||
3. Preserve clear user messaging when no revisions exist.
|
|
||||||
|
|
||||||
### Deliverables
|
|
||||||
- Updated jobs page and detail components.
|
|
||||||
|
|
||||||
### Exit Criteria
|
|
||||||
- UI behavior and labels match documentation and domain model.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 4 — Database Bootstrap, Migration, and Safety
|
|
||||||
|
|
||||||
**Goal:** Make schema transition safe in dev/test and repeatable for deployment.
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
1. Update bootstrap compatibility logic in `db/operations.py`:
|
|
||||||
- Remove obsolete transcript-table assumptions.
|
|
||||||
- Add forward-compatible patches for current tables only.
|
|
||||||
2. Define migration/backfill approach for existing local data.
|
|
||||||
3. Document rollback and recovery steps.
|
|
||||||
4. Rehearse migration path against representative data.
|
|
||||||
|
|
||||||
### Deliverables
|
|
||||||
- Migration/upgrade runbook.
|
|
||||||
- Validated bootstrap behavior for dev/test.
|
|
||||||
|
|
||||||
### Exit Criteria
|
|
||||||
- Migration path is documented and tested with no unresolved data-loss risk.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 5 — Test Suite Realignment
|
|
||||||
|
|
||||||
**Goal:** Restore full confidence after the schema redesign.
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
1. Rewrite model tests for:
|
|
||||||
- `Document`, `Source`, `Job`, `Revision` relationships and invariants.
|
|
||||||
2. Rewrite service/integration tests:
|
|
||||||
- Worker success/failure paths using `Job.text` / `Job.error_detail`.
|
|
||||||
- Optional single-revision creation/update behavior.
|
|
||||||
3. Update UI tests for new job-detail/revision rendering behavior.
|
|
||||||
4. Re-enable strict CI quality gates (lint, type, tests).
|
|
||||||
|
|
||||||
### Deliverables
|
|
||||||
- Updated test matrix and passing CI.
|
|
||||||
|
|
||||||
### Exit Criteria
|
|
||||||
- Critical user flows and failure paths are covered and green.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Phase 6 — Reliability, Operations, and Release Readiness
|
|
||||||
|
|
||||||
**Goal:** Ensure V1 is operable and launch-safe.
|
|
||||||
|
|
||||||
### Tasks
|
|
||||||
1. Verify error taxonomy behavior across UI/API/service/worker.
|
|
||||||
2. Confirm structured logging includes relevant identifiers (`job_id`, `document_id`, `source_id` when applicable).
|
|
||||||
3. Validate retry behavior and terminal failure handling.
|
|
||||||
4. Finalize release checklist, deployment steps, and rollback procedure.
|
|
||||||
5. Execute final acceptance run against requirements traceability.
|
|
||||||
|
|
||||||
### Deliverables
|
|
||||||
- V1 release checklist and acceptance evidence.
|
|
||||||
- `runbook_v1.md` for incident response and operator workflows.
|
|
||||||
- `release_checklist_v1.md` for release sign-off.
|
|
||||||
|
|
||||||
### Exit Criteria
|
|
||||||
- Stakeholder sign-off and launch readiness achieved.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Requirement Traceability Focus
|
|
||||||
|
|
||||||
The plan must keep clear evidence against these requirement groups:
|
|
||||||
|
|
||||||
- **Core flow:** REQ-0 to REQ-6
|
|
||||||
- **Runtime and operations constraints:** REQ-7 to REQ-12
|
|
||||||
- **Revision workflow:** REQ-13
|
|
||||||
|
|
||||||
A lightweight traceability table should be maintained with:
|
|
||||||
|
|
||||||
- requirement ID
|
|
||||||
- implementation status (`not started` / `in progress` / `done`)
|
|
||||||
- validation evidence (test name, screenshot, or runbook step)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Suggested Execution Rhythm
|
|
||||||
|
|
||||||
- **Weekly:** requirement status and risk review
|
|
||||||
- **Per PR:** contract checks (model names, field names, lifecycle values)
|
|
||||||
- **Milestone checks:** end of Phases 2, 4, and 6
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Scope Discipline Rule (V1 Focus)
|
|
||||||
|
|
||||||
- Only work required to satisfy V1 requirements enters this plan.
|
|
||||||
- Nice-to-have enhancements are captured in a separate backlog document.
|
|
||||||
- Schema or contract changes after Phase 1 require explicit approval and traceability impact review.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v1.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v1.md)
|
|
||||||
- [System Requirements](requirements_v1.md)
|
|
||||||
- [Data model](schema_v1.md)
|
|
||||||
- [Error Handling Policy](error_handling_v1.md)
|
|
||||||
- Implementation Plan (this document)
|
|
||||||
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
# V1 Release Readiness Checklist
|
|
||||||
|
|
||||||
Use this checklist before declaring V1 operationally complete.
|
|
||||||
|
|
||||||
## A) Functional Readiness
|
|
||||||
|
|
||||||
- [ ] Upload flow works for supported file types.
|
|
||||||
- [ ] Worker transitions jobs through `queued -> processing -> transcribed|failed`.
|
|
||||||
- [ ] Job detail displays immutable original transcription from `Job.text`.
|
|
||||||
- [ ] Revision workflow supports create/update/view/delete for optional single revision.
|
|
||||||
|
|
||||||
## B) Reliability and Error Handling
|
|
||||||
|
|
||||||
- [ ] Error categories surface with actionable messages in UI/API pathways.
|
|
||||||
- [ ] Failed jobs persist `error_detail` and terminal state.
|
|
||||||
- [ ] Stale processing recovery verified on restart.
|
|
||||||
- [ ] Retry/timeout behavior validated against configured limits.
|
|
||||||
|
|
||||||
## C) Operational Readiness
|
|
||||||
|
|
||||||
- [ ] `runbook_v1.md` reviewed and current.
|
|
||||||
- [ ] `migration_v1.md` reviewed and current.
|
|
||||||
- [ ] Backup and rollback procedures tested at least once.
|
|
||||||
- [ ] Incident escalation packet template is known to operators.
|
|
||||||
|
|
||||||
## D) Quality Gates
|
|
||||||
|
|
||||||
- [ ] Lint/type checks pass.
|
|
||||||
- [ ] `pytest -m "not external" -q` passes.
|
|
||||||
- [ ] Targeted external/provider checks executed (if credentials available).
|
|
||||||
- [ ] Release evidence recorded in `release_evidence_v1.md`.
|
|
||||||
|
|
||||||
## E) Traceability and Documentation
|
|
||||||
|
|
||||||
- [ ] `requirements_v1.md` aligns with implemented V1 behavior.
|
|
||||||
- [ ] `architecture_v1.md`, `schema_v1.md`, and `error_handling_v1.md` are consistent.
|
|
||||||
- [ ] `traceability_v1.md` is updated with current implementation and test evidence.
|
|
||||||
- [ ] `implementation_plan_v1.md` phase status updated with evidence references.
|
|
||||||
- [ ] REQ traceability evidence links recorded (tests/runbook/checks).
|
|
||||||
|
|
||||||
## Release Sign-Off
|
|
||||||
|
|
||||||
- [ ] Technical sign-off complete.
|
|
||||||
- [ ] Operational sign-off complete.
|
|
||||||
- [ ] V1 completion date recorded.
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
# V1 Release Evidence Log
|
|
||||||
|
|
||||||
## Step 5 Quality Gates (2026-07-29)
|
|
||||||
|
|
||||||
### Lint
|
|
||||||
|
|
||||||
- Command: `python -m ruff check .`
|
|
||||||
- Result: ✅ pass
|
|
||||||
- Notes: initial findings were auto-fixed (`ruff --fix`) plus small manual line-wrap/annotation adjustments.
|
|
||||||
|
|
||||||
### Tests (primary gate)
|
|
||||||
|
|
||||||
- Command: `python -m pytest -m "not external" -q`
|
|
||||||
- Result: ✅ pass (`[100%]`)
|
|
||||||
|
|
||||||
### Tests (external smoke)
|
|
||||||
|
|
||||||
- Command: `python -m pytest -m external -q`
|
|
||||||
- Result: ✅ pass (`[100%]`)
|
|
||||||
|
|
||||||
### Type Check
|
|
||||||
|
|
||||||
- Command: `python -m ty check src tests`
|
|
||||||
- Result: ⚠️ not passing
|
|
||||||
- Summary: existing SQLModel/SQLAlchemy typing incompatibilities and test double typing mismatches remain.
|
|
||||||
|
|
||||||
Key current blocker families:
|
|
||||||
|
|
||||||
1. SQLModel relationship/query attribute typing (`selectinload`, `order_by`, `.any()`)
|
|
||||||
2. SQLAlchemy join clause typing in `services/transcription.py`
|
|
||||||
3. Test fake client type mismatch for `OpenRouterTranscriptionProvider(client=...)`
|
|
||||||
4. `Settings(**defaults)` typed-dict strictness in `tests/test_config.py`
|
|
||||||
|
|
||||||
## Current Gate Status
|
|
||||||
|
|
||||||
- Lint: pass
|
|
||||||
- Non-external tests: pass
|
|
||||||
- External smoke tests: pass
|
|
||||||
- Type check: **blocked** (requires dedicated typing cleanup pass)
|
|
||||||
@@ -1,129 +0,0 @@
|
|||||||
# V1 Operations Runbook
|
|
||||||
|
|
||||||
This runbook provides day-2 operational procedures for the V1 baseline.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
Applies to:
|
|
||||||
|
|
||||||
- local/hosted V1 runtime
|
|
||||||
- SQLite-backed persistence
|
|
||||||
- in-process worker lifecycle
|
|
||||||
- OpenRouter provider integration
|
|
||||||
|
|
||||||
## Preconditions
|
|
||||||
|
|
||||||
- `.env` contains `OPENROUTER_API_KEY`
|
|
||||||
- app starts successfully
|
|
||||||
- `uploads/` and `prompts/` are writable
|
|
||||||
- health endpoint responds at `/healthz`
|
|
||||||
|
|
||||||
## Standard Startup Procedure
|
|
||||||
|
|
||||||
1. Start the app using the project-standard command.
|
|
||||||
2. Open `/healthz` and verify `{"status":"ok"}`.
|
|
||||||
3. Open `/ui/upload` and submit a small valid file.
|
|
||||||
4. Confirm job transitions from `queued` -> `processing` -> `transcribed` (or `failed` with detail).
|
|
||||||
|
|
||||||
## Standard Shutdown Procedure
|
|
||||||
|
|
||||||
1. Stop the application process.
|
|
||||||
2. Ensure no active process still holds the SQLite file.
|
|
||||||
3. If maintenance is planned, copy the DB file before edits:
|
|
||||||
- `transcription.db` (or configured `DATABASE_URL` file path)
|
|
||||||
|
|
||||||
## Incident: Jobs Stuck In `processing`
|
|
||||||
|
|
||||||
### Symptoms
|
|
||||||
|
|
||||||
- Jobs remain `processing` for longer than provider timeout
|
|
||||||
- New uploads queue but do not complete
|
|
||||||
- provider usage increases but no terminal job state is visible
|
|
||||||
|
|
||||||
### Checks
|
|
||||||
|
|
||||||
1. Confirm app process is still running.
|
|
||||||
2. Confirm worker loop is active (startup logs include worker lifespan start).
|
|
||||||
3. Inspect recent app logs for:
|
|
||||||
- `worker.process_job`
|
|
||||||
- `error_id`
|
|
||||||
- `category`
|
|
||||||
- `job_id` / `document_id` / `source_id`
|
|
||||||
4. Verify provider credentials and provider status.
|
|
||||||
|
|
||||||
### Recovery
|
|
||||||
|
|
||||||
1. Restart the app to trigger stale-processing recovery.
|
|
||||||
2. On startup, app re-queues stale processing jobs based on timeout policy.
|
|
||||||
3. Re-check jobs page and confirm terminal state progression.
|
|
||||||
4. If persistent, capture logs + error IDs and move to deep investigation.
|
|
||||||
|
|
||||||
## Incident: Provider Authentication Failures
|
|
||||||
|
|
||||||
### Symptoms
|
|
||||||
|
|
||||||
- failures categorized as provider/auth
|
|
||||||
- jobs fail quickly with authentication guidance
|
|
||||||
|
|
||||||
### Recovery
|
|
||||||
|
|
||||||
1. Validate `OPENROUTER_API_KEY` value.
|
|
||||||
2. Restart app after updating env.
|
|
||||||
3. Re-run a small transcription to confirm recovery.
|
|
||||||
|
|
||||||
## Incident: Upload Failures
|
|
||||||
|
|
||||||
### Symptoms
|
|
||||||
|
|
||||||
- UI reports upload errors
|
|
||||||
- unsupported extension or empty payload
|
|
||||||
|
|
||||||
### Recovery
|
|
||||||
|
|
||||||
1. Validate file extension (`.jpg`, `.jpeg`, `.png`, `.tif`, `.tiff`, `.pdf`).
|
|
||||||
2. Validate file is not empty.
|
|
||||||
3. Validate upload directory permissions.
|
|
||||||
4. Retry upload.
|
|
||||||
|
|
||||||
## Incident: Database File/Permission Issues
|
|
||||||
|
|
||||||
### Symptoms
|
|
||||||
|
|
||||||
- persistence errors during upload/job update
|
|
||||||
- startup failures around schema/runtime
|
|
||||||
|
|
||||||
### Recovery
|
|
||||||
|
|
||||||
1. Confirm the configured DB file path exists and is writable.
|
|
||||||
2. Confirm parent directory permissions.
|
|
||||||
3. Restore from last known backup copy if corruption is suspected.
|
|
||||||
4. Restart app and run smoke test.
|
|
||||||
|
|
||||||
## Logging Requirements (Operational)
|
|
||||||
|
|
||||||
Operational triage should always capture:
|
|
||||||
|
|
||||||
- `error_id`
|
|
||||||
- category
|
|
||||||
- operation name
|
|
||||||
- `job_id`, `document_id`, `source_id` when applicable
|
|
||||||
- UTC timestamp
|
|
||||||
|
|
||||||
## Escalation Packet (When opening an issue)
|
|
||||||
|
|
||||||
Include:
|
|
||||||
|
|
||||||
- exact timestamp window
|
|
||||||
- one failing `job_id`
|
|
||||||
- relevant `error_id` values
|
|
||||||
- latest 100 lines of app logs
|
|
||||||
- environment summary (`DATABASE_URL` type, app version/commit)
|
|
||||||
|
|
||||||
## Post-Incident Validation
|
|
||||||
|
|
||||||
After mitigation, verify:
|
|
||||||
|
|
||||||
1. Upload works.
|
|
||||||
2. One job reaches `transcribed`.
|
|
||||||
3. One induced failure reaches `failed` with error detail.
|
|
||||||
4. Jobs page and detail page render correctly.
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
## Database Schema (V1 Baseline)
|
|
||||||
|
|
||||||
This document describes the current relational schema for the transcription system.
|
|
||||||
|
|
||||||
All primary and foreign keys in the domain models are UUID-based in V1.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Schema Diagram
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
erDiagram
|
|
||||||
DOCUMENT {
|
|
||||||
UUID id PK
|
|
||||||
TEXT name
|
|
||||||
}
|
|
||||||
|
|
||||||
JOB {
|
|
||||||
UUID id PK
|
|
||||||
UUID document_id FK
|
|
||||||
TEXT status
|
|
||||||
INTEGER retry_count
|
|
||||||
DATETIME date_created
|
|
||||||
DATETIME date_updated
|
|
||||||
TEXT provider
|
|
||||||
TEXT model
|
|
||||||
TEXT prompt_name
|
|
||||||
TEXT text
|
|
||||||
TEXT error_detail
|
|
||||||
}
|
|
||||||
|
|
||||||
SOURCE {
|
|
||||||
UUID id PK
|
|
||||||
UUID document_id FK
|
|
||||||
UUID job_id FK
|
|
||||||
TEXT upload_name
|
|
||||||
TEXT filename
|
|
||||||
TEXT file_path
|
|
||||||
DATETIME date_uploaded
|
|
||||||
}
|
|
||||||
|
|
||||||
REVISION {
|
|
||||||
UUID id PK
|
|
||||||
UUID source_id "FK, UK"
|
|
||||||
INTEGER revision
|
|
||||||
TEXT text
|
|
||||||
DATETIME date_created
|
|
||||||
}
|
|
||||||
|
|
||||||
DOCUMENT ||--o{ SOURCE : has_many
|
|
||||||
DOCUMENT ||--o{ JOB : has_many
|
|
||||||
JOB ||--o{ SOURCE : referenced_by
|
|
||||||
SOURCE ||--o| REVISION : has_optional_one
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Table Relationships and Constraints
|
|
||||||
|
|
||||||
- A `Document` can have zero or more `Source` records.
|
|
||||||
- A `Document` can have zero or more `Job` records.
|
|
||||||
- A `Source` belongs to exactly one `Document` and one `Job`.
|
|
||||||
- A `Source` may have one optional `Revision`.
|
|
||||||
- Optional `0..1` revision cardinality is enforced by uniqueness on `revision.source_id`.
|
|
||||||
|
|
||||||
### Invariants
|
|
||||||
|
|
||||||
- `Job.text` stores immutable original provider transcription output.
|
|
||||||
- `Revision` rows are optional user-authored edits derived from original transcription.
|
|
||||||
- Revisions do not overwrite original `Job.text`.
|
|
||||||
- Job status lifecycle values are: `queued`, `processing`, `transcribed`, `failed`.
|
|
||||||
|
|
||||||
### Timestamp Fields
|
|
||||||
|
|
||||||
- `Job.date_created`
|
|
||||||
- `Job.date_updated`
|
|
||||||
- `Source.date_uploaded`
|
|
||||||
- `Revision.date_created`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Related Local References
|
|
||||||
|
|
||||||
- [System Overview](index_v1.md)
|
|
||||||
- [System Design Intent](intent.md)
|
|
||||||
- [Transcription Methodology](transcription_methodology.md)
|
|
||||||
- [System Architecture](architecture_v1.md)
|
|
||||||
- [System Requirements](requirements_v1.md)
|
|
||||||
- Data model (this document)
|
|
||||||
- [Error Handling Policy](error_handling_v1.md)
|
|
||||||
- [Implementation Plan](implementation_plan_v1.md)
|
|
||||||
|
|
||||||
## Glossary
|
|
||||||
|
|
||||||
- **Document**: logical grouping for one or more transcribed sources.
|
|
||||||
- **Source**: uploaded file content (image/PDF) linked to a job.
|
|
||||||
- **Job**: processing record that stores lifecycle status and original output.
|
|
||||||
- **Revision**: optional single user-authored edited text linked to a source.
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
# V1 Traceability Matrix
|
|
||||||
|
|
||||||
This matrix provides implementation and validation evidence for V1 requirements (`REQ-0` through `REQ-13`).
|
|
||||||
|
|
||||||
Status values:
|
|
||||||
|
|
||||||
- `done`: implemented and evidence recorded
|
|
||||||
- `in progress`: partially implemented or evidence incomplete
|
|
||||||
- `not started`: no implementation/evidence yet
|
|
||||||
|
|
||||||
## Requirement Evidence Table
|
|
||||||
|
|
||||||
| Requirement | Status | Implementation Evidence | Validation Evidence |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| REQ-0 | done | End-to-end upload + worker pipeline in `src/transcription/services/store.py`, `src/transcription/worker.py`, `src/transcription/services/workflows.py` | `tests/integration/test_pipeline_flow.py` |
|
|
||||||
| REQ-1 | done | Upload UI/page flow in `src/transcription/ui/pages/upload_page.py`, `src/transcription/ui/components/upload.py` | `tests/ui/test_upload_page.py`, `tests/integration/test_pipeline_flow.py` |
|
|
||||||
| REQ-2 | done | Async worker execution and provider call orchestration in `src/transcription/worker.py`, `src/transcription/services/workflows.py` | `tests/integration/test_pipeline_flow.py`, `tests/services/test_workflows_reliability.py` |
|
|
||||||
| REQ-3 | done | Job lifecycle state model + transitions in `src/transcription/models.py`, `src/transcription/services/jobs.py`, `src/transcription/services/workflows.py` | `tests/services/test_job_service.py`, `tests/ui/test_jobs_page.py` |
|
|
||||||
| REQ-4 | done | Persistence of original output and failure detail in `src/transcription/services/transcription.py`, `src/transcription/services/workflows.py` | `tests/integration/test_pipeline_flow.py`, `tests/services/test_workflows_reliability.py` |
|
|
||||||
| REQ-5 | done | Status/result inspection via UI pages and API health route in `src/transcription/ui/pages/jobs_page.py`, `src/transcription/api/health.py` | `tests/ui/test_jobs_page.py`, `tests/ui/test_pages_registration.py`, `tests/api/test_health.py` |
|
|
||||||
| REQ-6 | done | Background processing trigger/worker notifier and non-blocking workflow in `src/transcription/ui/components/upload.py`, `src/transcription/worker.py` | `tests/test_app.py`, `tests/services/test_workflows_reliability.py` |
|
|
||||||
| REQ-7 | done | Lifespan-owned runtime resources in `src/transcription/app.py`, `src/transcription/db/runtime.py` | `tests/test_app.py`, `tests/test_db.py` |
|
|
||||||
| REQ-8 | done | Centralized settings/logging initialization in `src/transcription/config.py`, `src/transcription/app.py` | `tests/test_config.py`, `tests/test_app.py` |
|
|
||||||
| REQ-9 | done | Containerized runtime baseline in `docker-compose.yml`, `Dockerfile` | `release_checklist_v1.md` (Ops checklist), manual demonstration step |
|
|
||||||
| REQ-10 | done | Explicit schema bootstrap policy + runtime controls in `src/transcription/config.py`, `src/transcription/app.py`, `src/transcription/db/operations.py` | `tests/test_db.py`, `tests/test_config.py` |
|
|
||||||
| REQ-11 | done | Service/workflow persistence boundaries in `src/transcription/services/*.py`, `src/transcription/services/workflows.py` | `tests/services/test_job_service.py`, `tests/services/test_transcription_service.py` |
|
|
||||||
| REQ-12 | done | Prompt artifacts in `prompts/` and loading/validation in `src/transcription/services/transcription.py` | `tests/test_prompts.py` |
|
|
||||||
| REQ-13 | done | Optional single revision create/update/view/delete in `src/transcription/services/transcription.py`, `src/transcription/ui/pages/jobs_page.py` | `tests/services/test_transcription_service.py`, `tests/ui/test_jobs_page.py` |
|
|
||||||
|
|
||||||
## Operational Evidence (Step 3 Artifacts)
|
|
||||||
|
|
||||||
- Runbook: `runbook_v1.md`
|
|
||||||
- Migration/backfill/rollback guidance: `migration_v1.md`
|
|
||||||
- Release readiness checklist: `release_checklist_v1.md`
|
|
||||||
|
|
||||||
## Verification Cadence
|
|
||||||
|
|
||||||
- Per change: maintain `tests/test_traceability.py` mappings for touched requirements.
|
|
||||||
- Per milestone: update this table status and evidence links.
|
|
||||||
- Pre-release: confirm all rows are `done` and non-external suite is green.
|
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
# Ver1 Step 1/2 Carry-Forward Checklist
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Track open Step 1 and Step 2 follow-ups through later V1 steps, with lightweight verification evidence and requirement traceability.
|
||||||
|
|
||||||
|
This artifact implements the carry-forward approach defined in:
|
||||||
|
- `docs/ver1/ver1-step1-2_revised.md`
|
||||||
|
|
||||||
|
Historical records remain unchanged:
|
||||||
|
- `docs/ver1/ver1-step1.md`
|
||||||
|
- `docs/ver1/ver1-step1-results.md`
|
||||||
|
- `docs/ver1/ver1-step2.md`
|
||||||
|
- `docs/ver1/ver1-step2-results.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Status Legend
|
||||||
|
|
||||||
|
- `not started`
|
||||||
|
- `in progress`
|
||||||
|
- `done`
|
||||||
|
- `deferred`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Carry-Forward Mapping Matrix
|
||||||
|
|
||||||
|
| ID | Carry-Forward Task | Source | Related REQ | Owning V1 Step(s) | Validation Method | Status | Evidence Link/Note |
|
||||||
|
| --- | --- | --- | --- | --- | --- | --- | --- |
|
||||||
|
| CF-A1 | Confirm remaining implicit/global runtime ownership and lift only high-impact resources to lifespan ownership | Step 1 residual follow-up | REQ-7 | Step 3, Step 9 | Inspection + test | in progress | Step 3 added `services/library.py` and `api/routes.py` using existing service/session access patterns; no new module-global runtime resource ownership introduced. Reconfirm in Step 9 release readiness. |
|
||||||
|
| CF-A2 | Finalize migration + rollback runbook usage and rehearse on representative local data | Step 1 residual follow-up | REQ-10 | Step 4, Step 9 | Demonstration + test | not started | |
|
||||||
|
| CF-A3 | Maintain lightweight boundary enforcement (review checklist and/or simple import checks) | Step 1 residual follow-up | REQ-7, REQ-11 | Step 3, Step 7 | Inspection | in progress | Step 3 implementation keeps UI/API composition thin and pushes revision/search/export logic to `services/library.py`; continue with Step 7 checks. |
|
||||||
|
| CF-B1 | Build compact error-path inventory for major failure paths and category mapping | Step 2 governance follow-up | REQ-2, REQ-3, REQ-4, REQ-5 | Step 6, Step 7 | Inspection | not started | Use `docs/ver1/ver1-step2-error-path-inventory.md` |
|
||||||
|
| CF-B2 | Standardize required logging fields at critical boundary handoffs | Step 2 residual follow-up | REQ-3, REQ-4, REQ-8 | Step 6 | Inspection + test | not started | |
|
||||||
|
| CF-B3 | Revisit retry backoff strategy only if observed runtime behavior justifies extra complexity | Step 2 residual follow-up | REQ-2, REQ-6 | Step 6, Step 8 | Analysis + test | deferred | Keep fixed backoff unless evidence suggests change |
|
||||||
|
| CF-C1 | Integrate Step 1/2 completed outcomes and open follow-ups into V1 traceability tracking | Revision-plan workstream | REQ-0..REQ-12 (traceability) | Step 3, Step 10 | Inspection | done | Step 3 artifacts added: `docs/ver1/ver1-step3.md`, `docs/ver1/ver1-step3-results.md`, and this checklist updated with Step 3 evidence and routing. |
|
||||||
|
| CF-C2 | Keep carry-forward routing aligned with revised V1 plan (architecture via 3/4/9, reliability via 6/7) | Revision-plan workstream | REQ-0..REQ-12 (execution alignment) | Step 3+ | Inspection | in progress | Step 3 execution followed routing: functional features implemented in Step 3; migration/rollback items remain in Step 4/9; logging/error-path standardization remains Step 6/7. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Execution Notes
|
||||||
|
|
||||||
|
### Step 3 (Functional Completion)
|
||||||
|
- Use CF-A1 and CF-A3 during requirement-slice implementation reviews.
|
||||||
|
- Record any discovered boundary/runtime ownership gaps in this checklist.
|
||||||
|
|
||||||
|
### Step 4 (Data Model and Migration Safety)
|
||||||
|
- Execute CF-A2 rehearsal and link evidence (commands, runbook notes, outcomes).
|
||||||
|
|
||||||
|
### Step 6 (Minimal Observability & Operability)
|
||||||
|
- Execute CF-B1 and CF-B2 with focused artifacts and log-field verification.
|
||||||
|
|
||||||
|
### Step 7 (Test Coverage and Practical Quality Gates)
|
||||||
|
- Add/verify tests supporting CF-A3 and CF-B1/B2 where meaningful.
|
||||||
|
|
||||||
|
### Step 8 (Performance Validation)
|
||||||
|
- Reassess CF-B3 only if retries/backoff are observed to cause practical issues.
|
||||||
|
|
||||||
|
### Step 9 (Release Readiness)
|
||||||
|
- Reconfirm CF-A1/A2 readiness in release checklist and rollback drill.
|
||||||
|
|
||||||
|
### Step 10 (Documentation Completion)
|
||||||
|
- Ensure final V1 docs reference outcomes from this checklist where relevant.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Acceptance Check for Carry-Forward Completion
|
||||||
|
|
||||||
|
- [ ] Historical Step 1/2 documents remain unchanged.
|
||||||
|
- [ ] Every open Step 1/2 follow-up has an owning V1 step and validation method.
|
||||||
|
- [ ] Evidence links are recorded for each completed carry-forward item.
|
||||||
|
- [ ] No carry-forward item introduces unnecessary complexity for personal-scale operation.
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
# Ver1 Step 1 & Step 2 Revision Plan (Additive)
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Define a **targeted implementation follow-through plan** for Step 1 and Step 2 outcomes so remaining V1 work stays aligned with `docs/ver1/ver1.md`:
|
||||||
|
|
||||||
|
- personal-scale operation
|
||||||
|
- single operator
|
||||||
|
- private-network assumptions
|
||||||
|
- low operational overhead
|
||||||
|
- practical, testable controls
|
||||||
|
|
||||||
|
This document is additive and does **not** replace or revise historical Step 1/Step 2 records.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Source Documents Reviewed
|
||||||
|
|
||||||
|
- `docs/ver1/ver1.md`
|
||||||
|
- `docs/ver1/ver1-step1.md`
|
||||||
|
- `docs/ver1/ver1-step1-results.md`
|
||||||
|
- `docs/ver1/ver1-step2.md`
|
||||||
|
- `docs/ver1/ver1-step2-results.md`
|
||||||
|
- `docs/architecture.md`
|
||||||
|
- `docs/error_handling.md`
|
||||||
|
- `docs/requirements.md`
|
||||||
|
- `docs/index.md`
|
||||||
|
- `docs/intent.md`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Revision Goals
|
||||||
|
|
||||||
|
1. Preserve all completed Step 1/Step 2 technical hardening work.
|
||||||
|
2. Keep historical Step 1/Step 2 documents unchanged.
|
||||||
|
3. Convert residual risks/follow-ups into concrete implementation tasks for subsequent V1 steps.
|
||||||
|
4. Preserve traceability to requirements and implemented evidence.
|
||||||
|
5. Maintain alignment with personal-scale architecture and operating model.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
### In Scope
|
||||||
|
- Define carry-forward implementation tasks based on Step 1/2 residual risks and open items.
|
||||||
|
- Map carry-forward tasks to later V1 steps (especially Steps 3, 4, 6, 7, and 9).
|
||||||
|
- Define lightweight verification evidence expected for each carry-forward task.
|
||||||
|
- Update V1 traceability references to include completed Step 1/2 outcomes and deferred follow-ups.
|
||||||
|
|
||||||
|
### Out of Scope
|
||||||
|
- Simplifying tone/structure of existing Step 1/2 documents
|
||||||
|
- Clarifying or rewriting historical Step 1/2 plan/results content
|
||||||
|
- Editing `docs/ver1/ver1-step1.md`
|
||||||
|
- Editing `docs/ver1/ver1-step1-results.md`
|
||||||
|
- Editing `docs/ver1/ver1-step2.md`
|
||||||
|
- Editing `docs/ver1/ver1-step2-results.md`
|
||||||
|
- Re-implementing Step 1/2 code changes
|
||||||
|
- Rewriting `docs/ver1/ver1.md`
|
||||||
|
- Deleting historical sections/results
|
||||||
|
- Altering requirements IDs or architecture principles
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Carry-Forward Implementation Plan
|
||||||
|
|
||||||
|
## Workstream A — Close Step 1 follow-ups through later V1 steps
|
||||||
|
|
||||||
|
### A1) Runtime ownership completion (REQ-7 continuity)
|
||||||
|
- Confirm whether any remaining runtime resources still use implicit/global ownership.
|
||||||
|
- Move only high-impact remaining resources to explicit lifespan ownership when needed.
|
||||||
|
- Keep ownership model simple and documented.
|
||||||
|
|
||||||
|
### A2) Schema/migration operations readiness (REQ-10 continuity)
|
||||||
|
- Finalize practical migration + rollback runbook usage in Step 4 execution.
|
||||||
|
- Rehearse upgrade and rollback on representative local data.
|
||||||
|
- Keep production startup free from implicit schema mutation.
|
||||||
|
|
||||||
|
### A3) Boundary enforcement (lightweight only)
|
||||||
|
- Keep architecture boundary checks lightweight (review checklist and/or simple import checks).
|
||||||
|
- Avoid heavy governance tooling unless clear recurring drift appears.
|
||||||
|
|
||||||
|
### Expected Outcome
|
||||||
|
Step 1 architecture hardening remains intact and is completed pragmatically where open items remain.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream B — Close Step 2 follow-ups through later V1 steps
|
||||||
|
|
||||||
|
### B1) Error-path inventory and coverage visibility
|
||||||
|
- Create a compact error-path inventory artifact (or equivalent matrix section) covering major failure paths.
|
||||||
|
- Ensure each critical path maps to category, retriable policy, and surfaced behavior.
|
||||||
|
|
||||||
|
### B2) Logging field consistency at key boundaries
|
||||||
|
- Standardize required fields at critical failure handoffs (`error_id`, `category`, `operation`, identifiers when available).
|
||||||
|
- Prioritize worker/API/service boundaries first.
|
||||||
|
|
||||||
|
### B3) Retry policy refinement (only if needed)
|
||||||
|
- Keep current bounded retry baseline.
|
||||||
|
- Revisit richer backoff strategy only if observed behavior justifies added complexity.
|
||||||
|
|
||||||
|
### Expected Outcome
|
||||||
|
Step 2 reliability behavior stays stable, diagnosable, and right-sized for personal-scale operation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream C — Integrate Step 1/2 outputs into ongoing V1 governance
|
||||||
|
|
||||||
|
### C1) Traceability integration
|
||||||
|
- Link completed Step 1/2 outcomes and deferred follow-ups to the V1 traceability matrix.
|
||||||
|
- Ensure open follow-ups have owning step and validation method.
|
||||||
|
|
||||||
|
### C2) Execution alignment with revised V1 plan
|
||||||
|
- Route architecture follow-ups primarily through Steps 3/4/9.
|
||||||
|
- Route reliability/diagnostics follow-ups primarily through Steps 6/7.
|
||||||
|
|
||||||
|
### Expected Outcome
|
||||||
|
Step 1/2 work is fully carried forward without revising historical documents.
|
||||||
|
|
||||||
|
## Deliverables
|
||||||
|
|
||||||
|
1. This document (`docs/ver1/ver1-step1-2_revised.md`) as the carry-forward implementation plan.
|
||||||
|
2. A compact Step 1/2 carry-forward checklist linked to V1 steps and validation methods.
|
||||||
|
3. Traceability updates showing where each open Step 1/2 follow-up will be closed.
|
||||||
|
4. Optional new artifact for error-path inventory (if created during Step 6/7 execution).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
- Historical Step 1/Step 2 documents remain unchanged.
|
||||||
|
- Open Step 1/2 follow-ups are explicitly mapped to later V1 steps with validation expectations.
|
||||||
|
- No loss of core technical intent (REQ-7, REQ-10, error taxonomy, retry safety, traceability).
|
||||||
|
- No conflicts introduced with `docs/architecture.md`, `docs/error_handling.md`, or `docs/ver1/ver1.md`.
|
||||||
|
- Carry-forward tasks remain right-sized for personal-scale operation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Order
|
||||||
|
|
||||||
|
1. Keep existing Step 1/Step 2 docs unchanged as historical records.
|
||||||
|
2. Define carry-forward tasks and owning V1 steps in this document.
|
||||||
|
3. Create and maintain carry-forward traceability artifacts:
|
||||||
|
- `docs/ver1/ver1-step1-2-carry-forward-checklist.md`
|
||||||
|
- `docs/ver1/ver1-step2-error-path-inventory.md`
|
||||||
|
4. Execute carry-forward tasks during Steps 3+ and capture evidence in step results docs.
|
||||||
|
5. Perform final consistency pass across `docs/ver1/*` references.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk:** Open Step 1/2 items are forgotten as Step 3+ work proceeds.
|
||||||
|
**Mitigation:** Track each follow-up in the V1 traceability matrix with owning step and evidence expectation.
|
||||||
|
|
||||||
|
2. **Risk:** Carry-forward work expands beyond personal-scale needs.
|
||||||
|
**Mitigation:** Apply simplicity guardrails from `docs/architecture.md` before accepting additional hardening tasks.
|
||||||
|
|
||||||
|
3. **Risk:** Reliability follow-ups become fragmented across multiple steps.
|
||||||
|
**Mitigation:** Keep one consolidated carry-forward checklist and update it at milestone check-ins.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
This revision effort is scope-alignment and implementation-follow-through focused.
|
||||||
|
Historical Step 1/Step 2 documents are intentionally preserved as-is.
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
# Ver1 Step 1 Results: Architecture Consolidation
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Step 1 implementation has been completed for the primary architecture-consolidation objectives:
|
||||||
|
|
||||||
|
1. Lifespan-owned runtime resource model introduced for DB runtime ownership.
|
||||||
|
2. Schema bootstrap policy changed from implicit-always to explicit/environment-aware.
|
||||||
|
3. Worker startup now receives lifespan-owned DB engine dependency.
|
||||||
|
4. ADR set established for key V1 architectural decisions.
|
||||||
|
|
||||||
|
## Implemented Changes
|
||||||
|
|
||||||
|
### 1) Runtime ownership
|
||||||
|
|
||||||
|
- Updated `src/transcription/db.py`:
|
||||||
|
- Added `DatabaseRuntime` resource model.
|
||||||
|
- Added explicit runtime lifecycle methods:
|
||||||
|
- `initialize_database_runtime(...)`
|
||||||
|
- `get_database_runtime()`
|
||||||
|
- `dispose_database_runtime()`
|
||||||
|
- Updated `src/transcription/app.py`:
|
||||||
|
- Lifespan initializes DB runtime and stores it on `app.state`.
|
||||||
|
- Lifespan disposes DB runtime on shutdown.
|
||||||
|
|
||||||
|
### 2) Schema bootstrap policy (REQ-10 alignment)
|
||||||
|
|
||||||
|
- Updated `src/transcription/config.py`:
|
||||||
|
- Added `environment` setting (`development`, `test`, `production`).
|
||||||
|
- Added `bootstrap_schema_on_startup` explicit override setting.
|
||||||
|
- Updated `src/transcription/db.py`:
|
||||||
|
- Added `should_bootstrap_schema(settings)` policy function.
|
||||||
|
- Updated `src/transcription/app.py`:
|
||||||
|
- Startup now calls `create_all(...)` only when policy allows.
|
||||||
|
|
||||||
|
### 3) Worker dependency ownership
|
||||||
|
|
||||||
|
- Updated `src/transcription/worker.py`:
|
||||||
|
- `process_next_queued_job(..., engine=None)` now supports explicit engine injection.
|
||||||
|
- `run_worker_loop(..., engine=None, ...)` now supports explicit engine injection.
|
||||||
|
- Updated `src/transcription/app.py`:
|
||||||
|
- Worker thread is started with lifespan-owned engine.
|
||||||
|
|
||||||
|
### 4) ADR governance
|
||||||
|
|
||||||
|
Created:
|
||||||
|
- `docs/adr/README.md`
|
||||||
|
- `docs/adr/ADR-0001-lifespan-owned-runtime-resources.md`
|
||||||
|
- `docs/adr/ADR-0002-explicit-schema-bootstrap-policy.md`
|
||||||
|
- `docs/adr/ADR-0003-persistence-baseline-and-transition-path.md`
|
||||||
|
- `docs/adr/ADR-0004-in-process-worker-topology.md`
|
||||||
|
|
||||||
|
## Test Evidence
|
||||||
|
|
||||||
|
Targeted regression checks executed successfully:
|
||||||
|
|
||||||
|
- `uv run pytest tests/test_app.py tests/test_db.py tests/services/test_worker.py -q`
|
||||||
|
- Result: pass
|
||||||
|
|
||||||
|
## Residual Risks / Follow-ups
|
||||||
|
|
||||||
|
1. Full REQ-7 completion may still require broader runtime ownership coverage for additional resources as V1 expands.
|
||||||
|
2. Production schema management workflow (migrations/runbook tooling) should be finalized in subsequent V1 steps.
|
||||||
|
3. Additional boundary enforcement automation (import-lint style checks) can be added in later hardening.
|
||||||
|
|
||||||
|
## Step 1 Exit Assessment
|
||||||
|
|
||||||
|
- Architecture ownership clarity: **met**
|
||||||
|
- Schema bootstrap policy hardening: **met**
|
||||||
|
- Worker lifecycle dependency clarity: **met**
|
||||||
|
- ADR baseline established: **met**
|
||||||
|
|
||||||
|
## Completion Checklist With Evidence
|
||||||
|
|
||||||
|
| Criterion | Status | Evidence |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Architecture conformance matrix approved | partial | Consolidation implemented and documented in `docs/ver1/ver1-step1.md` + this results doc; formal matrix artifact can be added as a follow-up appendix. |
|
||||||
|
| REQ-7 ownership gaps resolved or explicitly deferred | met | Lifespan-owned DB runtime and explicit worker engine wiring implemented in `src/transcription/app.py`, `src/transcription/db.py`, `src/transcription/worker.py`. Residual scope documented under follow-ups. |
|
||||||
|
| REQ-10 explicit bootstrap policy implemented and verified | met | Policy implemented via `environment` + `bootstrap_schema_on_startup` in `src/transcription/config.py`, `should_bootstrap_schema(...)` in `src/transcription/db.py`, startup gate in `src/transcription/app.py`, tested in `tests/test_db.py`. |
|
||||||
|
| Dependency direction rules documented and enforced | partial | Layering and runtime ownership documented in `docs/architecture.md`. Lightweight enforcement exists via review and test discipline; automated import-lint remains a follow-up. |
|
||||||
|
| ADR set created for major Step 1 decisions | met | `docs/adr/README.md` and ADR-0001 through ADR-0004 created. |
|
||||||
|
| Architecture/index docs updated to match implementation | met | `docs/architecture.md` and `docs/index.md` updated with V1 Step 1 runtime policy and links to V1/ADR artifacts. |
|
||||||
|
| Regression and full test suites pass | met | Targeted: `uv run pytest tests/test_app.py tests/test_db.py tests/services/test_worker.py -q`; full suite: `uv run pytest -q`. |
|
||||||
|
| Step 1 results artifact published | met | This document (`docs/ver1/ver1-step1-results.md`) created and updated with summary, evidence, risks, and checklist. |
|
||||||
|
|
||||||
|
Step 1 is complete and ready to hand off to Ver1 Step 2.
|
||||||
@@ -0,0 +1,309 @@
|
|||||||
|
# Step 1 Implementation Plan: Architecture Consolidation
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Align the implemented MVP codebase with the production architecture and V1 constraints documented in:
|
||||||
|
|
||||||
|
- `docs/architecture.md`
|
||||||
|
- `docs/requirements.md`
|
||||||
|
- `docs/error_handling.md`
|
||||||
|
- `docs/index.md`
|
||||||
|
- `docs/intent.md`
|
||||||
|
- `docs/ver1/ver1.md` (Step 1)
|
||||||
|
|
||||||
|
This step hardens architecture boundaries and ownership without expanding product scope.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Skill and Guide Inputs Incorporated
|
||||||
|
|
||||||
|
This plan explicitly incorporates patterns and guardrails from john-stream-mcp resources:
|
||||||
|
|
||||||
|
1. `resource://skills/fastapi-uv-docker/document`
|
||||||
|
- App factory and lifespan ownership
|
||||||
|
- Health endpoint and cloud-native baseline expectations
|
||||||
|
- Environment-driven configuration and startup discipline
|
||||||
|
|
||||||
|
2. `resource://skills/fastapi-async-sqlalchemy-modernization/document`
|
||||||
|
- Current-state gap audit first
|
||||||
|
- Target runtime model before refactor
|
||||||
|
- Explicit resource lifecycle ownership
|
||||||
|
- Transaction/session boundary clarity
|
||||||
|
- Phased migration with rollback points
|
||||||
|
|
||||||
|
3. `resource://skills/nicegui/document`
|
||||||
|
- Clear dependency direction
|
||||||
|
- UI/page registration as composition, not business logic container
|
||||||
|
- Async responsiveness and boundary separation
|
||||||
|
|
||||||
|
4. `resource://prompts/greenfield-architecture/document`
|
||||||
|
- Pattern-comparison-first planning
|
||||||
|
- Explicit tradeoffs and staged implementation
|
||||||
|
- Output contract with risks, open questions, and next steps
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Current-State Gap Summary (Architecture vs Implementation)
|
||||||
|
|
||||||
|
Based on docs and current `src/transcription` code:
|
||||||
|
|
||||||
|
1. **REQ-7 gap (lifespan-owned resources)**
|
||||||
|
- DB engine/session factory are module globals in `db.py`, not app lifespan-owned.
|
||||||
|
- Worker thread lifecycle is owned by lifespan (good), but DB/provider resource ownership is mixed.
|
||||||
|
|
||||||
|
2. **REQ-10 gap (explicit opt-in schema bootstrap)**
|
||||||
|
- `create_all()` is executed unconditionally on startup in `app.py`.
|
||||||
|
|
||||||
|
3. **Data store target gap (REQ-9 + architecture baseline)**
|
||||||
|
- Runtime still defaults to SQLite MVP setup; production architecture targets PostgreSQL baseline with optional MongoDB.
|
||||||
|
|
||||||
|
4. **Layering clarity gap (architecture layer model)**
|
||||||
|
- Boundaries exist but are not yet formally enforced (interface/app/domain/infra dependency rules are implicit, not codified).
|
||||||
|
|
||||||
|
5. **Decision record gap**
|
||||||
|
- No ADR set documenting key V1 architectural decisions and deviations from MVP.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope for Step 1
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
1. Produce architecture conformance audit and decision records.
|
||||||
|
2. Define and implement target runtime ownership model for core resources.
|
||||||
|
3. Establish explicit schema bootstrap policy (opt-in in production paths).
|
||||||
|
4. Consolidate module boundaries and dependency direction rules.
|
||||||
|
5. Update architecture docs to reflect implemented reality and V1 trajectory.
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Full async SQLAlchemy rewrite (plan and seams only if deferred)
|
||||||
|
- MongoDB feature implementation
|
||||||
|
- New user-facing features
|
||||||
|
- Major worker architecture replacement (in-process worker remains baseline)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Target Architecture Decisions for V1
|
||||||
|
|
||||||
|
1. **Keep modular monolith topology** (FastAPI + NiceGUI + in-process worker).
|
||||||
|
2. **Preserve container-light simplicity guardrails** from `architecture.md`.
|
||||||
|
3. **Move runtime ownership to lifespan** for:
|
||||||
|
- DB engine/session factory lifecycle
|
||||||
|
- Worker runtime resources
|
||||||
|
- Provider client factory/config lifecycle
|
||||||
|
4. **Adopt explicit schema bootstrap policy**:
|
||||||
|
- Dev/test: opt-in auto-bootstrap allowed
|
||||||
|
- Production: startup must not mutate schema implicitly
|
||||||
|
5. **Formalize boundary map**:
|
||||||
|
- Interface (`api`, `ui`) -> Application (`services`) -> Domain (`models/rules`) -> Infrastructure (`db`, `providers`)
|
||||||
|
- No reverse imports
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Work Breakdown
|
||||||
|
|
||||||
|
## Phase A — Architecture Audit and Baseline Freeze
|
||||||
|
|
||||||
|
- [ ] **A1. Produce architecture conformance matrix**
|
||||||
|
- Map each architecture section to current modules/files.
|
||||||
|
- Classify each row: `aligned`, `partial`, `not aligned`.
|
||||||
|
|
||||||
|
- [ ] **A2. Produce REQ-7/REQ-9/REQ-10 focused gap report**
|
||||||
|
- Explicitly capture current vs required state.
|
||||||
|
- Include operational risk if left unresolved.
|
||||||
|
|
||||||
|
- [ ] **A3. Freeze MVP architecture baseline**
|
||||||
|
- Record current baseline behavior and known temporary shortcuts.
|
||||||
|
- Link this baseline from `docs/ver1/ver1.md`.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- `docs/ver1/ver1-step1-audit.md` (or equivalent section in this doc)
|
||||||
|
- Architecture conformance table
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- No architecture changes begin before gap matrix and baseline are approved.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — Resource Ownership Consolidation (Lifespan-Centric)
|
||||||
|
|
||||||
|
- [ ] **B1. Define runtime resource ownership contract**
|
||||||
|
- `app.py` lifespan owns resource initialization and cleanup order.
|
||||||
|
- `app.state` carries resource handles/factories.
|
||||||
|
- No hidden module-global side-effect initialization for runtime resources.
|
||||||
|
|
||||||
|
- [ ] **B2. Refactor DB ownership model**
|
||||||
|
- Replace module-global engine singleton pattern with lifespan-initialized resource model.
|
||||||
|
- Define one canonical session-factory access path for app/worker/services.
|
||||||
|
|
||||||
|
- [ ] **B3. Normalize worker dependencies**
|
||||||
|
- Ensure worker uses lifespan-owned resources/factories rather than implicit globals.
|
||||||
|
- Preserve deterministic startup/shutdown behavior.
|
||||||
|
|
||||||
|
- [ ] **B4. Define provider adapter ownership**
|
||||||
|
- Provider client creation strategy is centralized and lifecycle-aware.
|
||||||
|
- Avoid per-call hidden client construction when unnecessary.
|
||||||
|
|
||||||
|
### MCP-Guided Guardrails
|
||||||
|
- Use explicit lifecycle composition patterns from `fastapi-async-sqlalchemy-modernization`.
|
||||||
|
- Maintain app-factory + lifespan structure per `fastapi-uv-docker`.
|
||||||
|
- Keep UI registration as composition only per `nicegui`.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Core runtime resources have one owner and one cleanup path.
|
||||||
|
- No critical resource has ambiguous ownership.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Schema Bootstrap Policy (REQ-10 Alignment)
|
||||||
|
|
||||||
|
- [ ] **C1. Define environment-aware bootstrap policy**
|
||||||
|
- `auto_create_schema` (or equivalent) disabled in production by default.
|
||||||
|
- Startup schema mutation is explicit and intentional.
|
||||||
|
|
||||||
|
- [ ] **C2. Split startup responsibilities**
|
||||||
|
- App startup performs health-critical initialization only.
|
||||||
|
- Schema bootstrap path is moved to explicit command/flag workflow.
|
||||||
|
|
||||||
|
- [ ] **C3. Update deployment/runbook docs**
|
||||||
|
- Document migration/bootstrap flow for dev, staging, prod.
|
||||||
|
- Ensure policy is testable and auditable.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Normal production startup path does not call schema auto-create implicitly.
|
||||||
|
- Bootstrap behavior is explicit and documented.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Module Boundary Enforcement
|
||||||
|
|
||||||
|
- [ ] **D1. Publish dependency direction rules**
|
||||||
|
- Allowed import directions across `api`, `ui`, `services`, `models/domain`, `db/providers`.
|
||||||
|
- Explicitly disallow reverse dependencies.
|
||||||
|
|
||||||
|
- [ ] **D2. Reconcile package map with docs**
|
||||||
|
- Ensure docs’ architecture elements match real package layout and naming.
|
||||||
|
- Update docs where intentional deviations remain.
|
||||||
|
|
||||||
|
- [ ] **D3. Isolate cross-layer responsibilities**
|
||||||
|
- Keep API/UI presentation concerns out of services.
|
||||||
|
- Keep provider/DB specifics out of interface layer.
|
||||||
|
|
||||||
|
- [ ] **D4. Add lightweight architecture checks**
|
||||||
|
- Add static/import checks and/or review checklist in CI/review process.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Boundary rules are documented and applied.
|
||||||
|
- Architectural drift can be detected during review/CI.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — Architecture Decision Records (ADRs)
|
||||||
|
|
||||||
|
- [ ] **E1. Create ADR index**
|
||||||
|
- Add `docs/adr/README.md` with template and status model.
|
||||||
|
|
||||||
|
- [ ] **E2. Record minimum V1 ADR set**
|
||||||
|
1. Runtime ownership model (lifespan-owned resources)
|
||||||
|
2. Schema bootstrap policy (explicit vs implicit)
|
||||||
|
3. Persistence baseline (PostgreSQL target; SQLite transition strategy)
|
||||||
|
4. Worker topology (in-process for V1, extension path preserved)
|
||||||
|
|
||||||
|
- [ ] **E3. Cross-link ADRs**
|
||||||
|
- Link from architecture and V1 docs.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Major architecture decisions are explicit, versioned, and discoverable.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase F — Documentation Consolidation
|
||||||
|
|
||||||
|
- [ ] **F1. Update `docs/architecture.md`**
|
||||||
|
- Reflect real implementation and V1 target state separately.
|
||||||
|
- Mark transitional choices clearly.
|
||||||
|
|
||||||
|
- [ ] **F2. Update `docs/index.md` navigation consistency**
|
||||||
|
- Ensure architecture/readme references match actual docs/files.
|
||||||
|
|
||||||
|
- [ ] **F3. Update `docs/requirements.md` traceability notes**
|
||||||
|
- Mark REQ-7/REQ-10 status and verification approach after consolidation.
|
||||||
|
|
||||||
|
- [ ] **F4. Add Step 1 result summary**
|
||||||
|
- Create `docs/ver1/ver1-step1-results.md` after implementation.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Docs are internally consistent and match runtime architecture reality.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Verification Plan
|
||||||
|
|
||||||
|
## Architecture Verification Matrix (Step 1)
|
||||||
|
|
||||||
|
1. **Inspection**
|
||||||
|
- Resource ownership map exists and matches code.
|
||||||
|
- Schema bootstrap policy is explicit and environment-aware.
|
||||||
|
- ADRs exist for each key architecture decision.
|
||||||
|
|
||||||
|
2. **Automated checks**
|
||||||
|
- Existing test suite remains green.
|
||||||
|
- New/updated tests validate startup policy (no implicit schema mutation in production mode).
|
||||||
|
- Import/dependency-direction checks pass (if introduced).
|
||||||
|
|
||||||
|
3. **Demonstration**
|
||||||
|
- App starts in dev mode with explicit expected behavior.
|
||||||
|
- App starts in production mode without mutating schema implicitly.
|
||||||
|
- Worker lifecycle starts/stops cleanly with app lifespan.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk:** Refactor destabilizes MVP behavior
|
||||||
|
**Mitigation:** Phase changes with small PRs and regression checks after each phase.
|
||||||
|
|
||||||
|
2. **Risk:** Over-rotation into premature async rewrite
|
||||||
|
**Mitigation:** Keep this step focused on lifecycle ownership and boundaries; defer full async migration unless required.
|
||||||
|
|
||||||
|
3. **Risk:** Schema policy changes break local DX
|
||||||
|
**Mitigation:** Keep explicit dev bootstrap path simple and documented.
|
||||||
|
|
||||||
|
4. **Risk:** Boundary rules become “doc only”
|
||||||
|
**Mitigation:** Add CI/review enforcement and architecture checklist.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended Implementation Order
|
||||||
|
|
||||||
|
1. Phase A — Audit and baseline freeze
|
||||||
|
2. Phase B — Resource ownership consolidation
|
||||||
|
3. Phase C — Schema bootstrap policy
|
||||||
|
4. Phase D — Boundary enforcement
|
||||||
|
5. Phase E — ADR authoring
|
||||||
|
6. Phase F — Documentation consolidation
|
||||||
|
|
||||||
|
This order minimizes risk: diagnose first, then refactor ownership, then lock policy, then enforce boundaries, and finally finalize docs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 1 Completion Checklist
|
||||||
|
|
||||||
|
- [ ] Architecture conformance matrix approved.
|
||||||
|
- [ ] REQ-7 ownership gaps resolved or explicitly deferred with owner/date.
|
||||||
|
- [ ] REQ-10 explicit bootstrap policy implemented and verified.
|
||||||
|
- [ ] Dependency direction rules documented and enforced.
|
||||||
|
- [ ] ADR set created for all major Step 1 decisions.
|
||||||
|
- [ ] Architecture and index docs updated to match implementation.
|
||||||
|
- [ ] Full test suite passes after consolidation.
|
||||||
|
- [ ] `docs/ver1/ver1-step1-results.md` created with evidence and residual risks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 2
|
||||||
|
|
||||||
|
Once Step 1 completes, Step 2 (Error Handling & Reliability Hardening) can proceed on stable architecture seams:
|
||||||
|
|
||||||
|
- consistent lifecycle ownership,
|
||||||
|
- explicit startup policy,
|
||||||
|
- clear module boundaries,
|
||||||
|
- documented architecture decisions.
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# Ver1 Step 2 Error-Path Inventory (Carry-Forward)
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Provide a compact inventory of major failure paths with taxonomy mapping and retry behavior, aligned with:
|
||||||
|
- `docs/error_handling.md`
|
||||||
|
- `docs/ver1/ver1-step2-results.md`
|
||||||
|
- `docs/ver1/ver1-step1-2-carry-forward-checklist.md` (CF-B1)
|
||||||
|
|
||||||
|
This is a lightweight operational artifact for Step 6/7 follow-through.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Inventory Table
|
||||||
|
|
||||||
|
| Path ID | Boundary/Operation | Typical Failure Source | Category | Retriable | Surface Behavior | Current Coverage | Notes |
|
||||||
|
| --- | --- | --- | --- | --- | --- | --- | --- |
|
||||||
|
| EP-API-001 | API upload request validation | invalid payload / empty file metadata | `validation_error` | no | structured API error envelope (400) | partial | confirm all upload variants |
|
||||||
|
| EP-API-002 | API resource lookup | missing job/document | `not_found_error` | no | structured API error envelope (404) | partial | verify consistency for all lookup routes |
|
||||||
|
| EP-SVC-001 | Service provider-call mapping | provider SDK/HTTP failure | `external_provider_error` | sometimes | normalized AppError and safe message | partial | ensure consistent mapping in service boundary tests |
|
||||||
|
| EP-WKR-001 | Worker provider timeout | timeout/unavailable upstream | `external_provider_error` or `infrastructure_transient_error` | yes | retry or terminal failed with persisted reason | partial | validate category mapping remains deterministic |
|
||||||
|
| EP-WKR-002 | Worker non-retriable domain/input failure | deterministic invalid input/state | `user_input_error` or `conflict_error` | no | immediate terminal failed with persisted reason | partial | ensure no retry on non-retriable categories |
|
||||||
|
| EP-WKR-003 | Worker retry exhaustion | repeated retriable failure | category from source; terminal state | capped then no | explicit failed status + error detail | met | implemented in Step 2; keep regression coverage |
|
||||||
|
| EP-UI-001 | UI upload action failure | surfaced AppError or fallback exception | category-based safe user message | category-driven | title + message + suggestion + error id | partial | verify consistency on all primary UI actions |
|
||||||
|
| EP-LOG-001 | Cross-boundary error logging | missing/uneven fields | n/a | n/a | logs include `error_id`, `category`, `operation`, ids when available | partial | complete in Step 6 (CF-B2) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Verification Targets (Step 6/7)
|
||||||
|
|
||||||
|
1. Every critical path has category + retriable policy defined.
|
||||||
|
2. API/UI behavior remains safe and actionable.
|
||||||
|
3. Worker terminal failures are explicit and persisted.
|
||||||
|
4. Logging fields are consistent at critical handoffs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Evidence Links
|
||||||
|
|
||||||
|
- Step 2 implementation results: `docs/ver1/ver1-step2-results.md`
|
||||||
|
- Carry-forward tracking: `docs/ver1/ver1-step1-2-carry-forward-checklist.md`
|
||||||
|
- Canonical contract: `docs/error_handling.md`
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
# Ver1 Step 2 Results: Error Handling & Reliability Hardening
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Step 2 implementation is complete for the planned reliability and error-handling hardening scope:
|
||||||
|
|
||||||
|
1. Worker retries are now explicit, bounded, and category-driven.
|
||||||
|
2. Error behavior is more consistent across worker/API/UI boundaries.
|
||||||
|
3. Logging now includes stronger boundary context in key failure paths.
|
||||||
|
4. Test coverage was expanded for retry policy and new reliability settings.
|
||||||
|
|
||||||
|
## Implemented Changes
|
||||||
|
|
||||||
|
### 1) Worker retry policy and terminal behavior
|
||||||
|
|
||||||
|
- Updated `src/transcription/models.py`:
|
||||||
|
- Added `Job.retry_count` with default `0`.
|
||||||
|
- Updated `src/transcription/config.py`:
|
||||||
|
- Added `worker_max_retries`.
|
||||||
|
- Added `worker_retry_backoff_seconds`.
|
||||||
|
- Updated `src/transcription/worker.py`:
|
||||||
|
- Added bounded retry decision path (`_should_retry`).
|
||||||
|
- Added requeue behavior (`_requeue_for_retry`) for retriable errors.
|
||||||
|
- Added deterministic terminal failure behavior (`_finalize_failed_job`).
|
||||||
|
- Preserved transcript failure detail persistence (`error_id`, `category`, suggestion).
|
||||||
|
|
||||||
|
### 2) API fallback normalization hardening
|
||||||
|
|
||||||
|
- Updated `src/transcription/api/errors.py`:
|
||||||
|
- Fallback handler now emits safe generic internal message for unhandled exceptions.
|
||||||
|
- Added structured boundary logging fields including operation and exception type.
|
||||||
|
|
||||||
|
### 3) UI interaction reliability guard
|
||||||
|
|
||||||
|
- Updated `src/transcription/ui/upload_page.py`:
|
||||||
|
- Added duplicate in-flight submission guard to prevent repeated upload handling while busy.
|
||||||
|
|
||||||
|
### 4) Observability/logging improvements
|
||||||
|
|
||||||
|
- Updated worker logs in `src/transcription/worker.py` to include operation and domain identifiers in key transitions:
|
||||||
|
- pick
|
||||||
|
- retry
|
||||||
|
- transcribed
|
||||||
|
- failed
|
||||||
|
|
||||||
|
## Test Coverage Added/Updated
|
||||||
|
|
||||||
|
- Updated `tests/test_models.py`:
|
||||||
|
- Assert `retry_count` default.
|
||||||
|
- Updated `tests/test_config.py`:
|
||||||
|
- Added worker retry settings default test.
|
||||||
|
- Updated `tests/services/test_worker.py`:
|
||||||
|
- Added retriable requeue test.
|
||||||
|
- Added retry-exhaustion terminal failure test.
|
||||||
|
- Updated existing tests for settings-driven worker behavior.
|
||||||
|
- Existing API error tests remained green with fallback behavior updates:
|
||||||
|
- `tests/api/test_error_responses.py`
|
||||||
|
|
||||||
|
## Verification Evidence
|
||||||
|
|
||||||
|
Executed and passing:
|
||||||
|
|
||||||
|
- `uv run pytest tests/services/test_worker.py tests/test_models.py tests/test_config.py tests/api/test_error_responses.py -q`
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
## Residual Risks / Follow-ups
|
||||||
|
|
||||||
|
1. Retry policy currently uses simple fixed backoff; richer strategy (exponential/jitter) can be added in later hardening.
|
||||||
|
2. Full cross-layer structured logging standardization can be expanded in Step 6 observability work.
|
||||||
|
3. A formal Step 2 error-path inventory artifact (`ver1-step2-audit.md`) is still recommended for governance completeness.
|
||||||
|
|
||||||
|
## Step 2 Exit Assessment
|
||||||
|
|
||||||
|
- Error taxonomy and envelope stability: **met**
|
||||||
|
- Bounded retry and terminal failure behavior: **met**
|
||||||
|
- Worker reliability controls: **met**
|
||||||
|
- UI interaction hardening for duplicate actions: **met**
|
||||||
|
- Test coverage expansion and full-suite regression safety: **met**
|
||||||
|
|
||||||
|
Step 2 is complete and ready to hand off to Ver1 Step 3.
|
||||||
@@ -0,0 +1,302 @@
|
|||||||
|
# Step 2 Implementation Plan: Error Handling & Reliability Hardening
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Implement **Ver1 Step 2** from `docs/ver1/ver1.md` by standardizing failure behavior and reliability controls so the system fails safely, predictably, and transparently across UI, API, services, worker, and provider boundaries.
|
||||||
|
|
||||||
|
Primary governing docs:
|
||||||
|
|
||||||
|
- `docs/error_handling.md` (authoritative contract)
|
||||||
|
- `docs/requirements.md` (REQ-2, REQ-3, REQ-4, REQ-5, REQ-6)
|
||||||
|
- `docs/architecture.md` (boundary ownership and worker lifecycle)
|
||||||
|
- `docs/ver1/ver1.md` (Step 2 objective)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Skill and Guide Inputs Incorporated
|
||||||
|
|
||||||
|
This plan integrates guidance from john-stream-mcp resources:
|
||||||
|
|
||||||
|
1. `resource://skills/python-logging-dictconfig/document`
|
||||||
|
- centralized `dictConfig` logging
|
||||||
|
- startup-only configuration
|
||||||
|
- stable named loggers and boundary-level logging discipline
|
||||||
|
|
||||||
|
2. `resource://skills/pytesting/document`
|
||||||
|
- deterministic, behavior-first tests
|
||||||
|
- explicit marker usage and fast/slow lane discipline
|
||||||
|
- integration checks for boundary behavior and error contracts
|
||||||
|
|
||||||
|
3. `resource://skills/fastapi-async-sqlalchemy-modernization/document`
|
||||||
|
- classify at source boundary
|
||||||
|
- explicit transaction/session behavior under failure
|
||||||
|
- phased rollout with quality gates and rollback awareness
|
||||||
|
|
||||||
|
4. `resource://skills/nicegui-ui-customization/document`
|
||||||
|
- explicit user-facing error feedback for each interaction
|
||||||
|
- prevent duplicate actions during in-flight operations
|
||||||
|
- preserve one-way dependency boundaries from UI -> services
|
||||||
|
|
||||||
|
5. `resource://skills/fastapi-uv-docker/document` (applied selectively)
|
||||||
|
- lifespan-safe startup/shutdown behavior
|
||||||
|
- health/readiness posture and cloud-native operational checks
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Current-State Gap Summary
|
||||||
|
|
||||||
|
The project already has a strong baseline (`AppError`, taxonomy enum, API envelope, worker persistence), but Step 2 needs completion-level hardening:
|
||||||
|
|
||||||
|
1. **Error contract consistency**
|
||||||
|
- API envelope exists, but consistency must be verified for all error pathways.
|
||||||
|
2. **Cross-boundary category normalization**
|
||||||
|
- Provider/service/worker mappings exist, but require stricter policy checks and tests.
|
||||||
|
3. **Retry policy implementation depth**
|
||||||
|
- Step 2 requires bounded retry policy and clear terminal behavior for retriable failures.
|
||||||
|
4. **Operational traceability**
|
||||||
|
- Logging exists; Step 2 requires consistent structured fields at critical boundaries.
|
||||||
|
5. **UI failure UX consistency**
|
||||||
|
- UI error handling exists; Step 2 requires explicit contract coverage and anti-duplication safeguards.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope for Step 2
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
1. Enforce canonical error taxonomy and envelope across all boundaries.
|
||||||
|
2. Standardize logging fields and boundary-level error traceability.
|
||||||
|
3. Implement/complete bounded retry and terminal failure behavior in worker paths.
|
||||||
|
4. Improve UI/API error presentation consistency and actionable guidance.
|
||||||
|
5. Add comprehensive Step 2 test coverage and verification matrix.
|
||||||
|
6. Update documentation to reflect final Step 2 policies and behavior.
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
- Major architecture/topology changes (external queue, distributed worker)
|
||||||
|
- New end-user feature expansion outside reliability/error handling
|
||||||
|
- Full async ORM migration (unless required by bug fix)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Target Decisions for Step 2
|
||||||
|
|
||||||
|
1. **Taxonomy stability is mandatory**
|
||||||
|
- `ErrorCategory` values remain stable contract identifiers.
|
||||||
|
2. **Classification occurs at source boundary**
|
||||||
|
- adapters/services normalize early; UI/API only present safely.
|
||||||
|
3. **User safety over internal detail leakage**
|
||||||
|
- expose safe message + suggestion + error_id; keep sensitive detail in logs.
|
||||||
|
4. **Retry is explicit and bounded**
|
||||||
|
- only retriable categories may retry; retries are capped; terminal failures persist reason.
|
||||||
|
5. **Boundary logs carry correlation fields**
|
||||||
|
- include `error_id`, `category`, `operation`, and domain identifiers where available.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Work Breakdown
|
||||||
|
|
||||||
|
## Phase A — Error Contract Audit and Policy Lock
|
||||||
|
|
||||||
|
- [ ] **A1. Build error-path inventory**
|
||||||
|
- Enumerate all failure entry points across:
|
||||||
|
- `api/`
|
||||||
|
- `ui/`
|
||||||
|
- `services/`
|
||||||
|
- `worker.py`
|
||||||
|
- `providers/`
|
||||||
|
|
||||||
|
- [ ] **A2. Produce taxonomy mapping table**
|
||||||
|
- For each known exception path, map:
|
||||||
|
- source exception type
|
||||||
|
- target `ErrorCategory`
|
||||||
|
- retriable flag
|
||||||
|
- API status (if exposed)
|
||||||
|
|
||||||
|
- [ ] **A3. Reconcile with `docs/error_handling.md`**
|
||||||
|
- Resolve any mismatch in category semantics, status codes, or suggested actions.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- `docs/ver1/ver1-step2-audit.md` (recommended)
|
||||||
|
- taxonomy mapping table
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Every known failure path has explicit category + retriable policy.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — API and Service Contract Hardening
|
||||||
|
|
||||||
|
- [ ] **B1. Enforce API envelope completeness**
|
||||||
|
- Ensure all API errors return:
|
||||||
|
- `error_id`, `category`, `message`, `suggestion`, `timestamp`
|
||||||
|
|
||||||
|
- [ ] **B2. Verify category-to-status mapping consistency**
|
||||||
|
- Confirm `api/errors.py` matches `docs/error_handling.md` mapping guidance.
|
||||||
|
|
||||||
|
- [ ] **B3. Normalize service exceptions at boundary**
|
||||||
|
- Services should raise `AppError` subclasses for known failures.
|
||||||
|
- Unknown exceptions must become `internal_unexpected_error` with traceable `error_id`.
|
||||||
|
|
||||||
|
- [ ] **B4. Ensure safe detail handling**
|
||||||
|
- API/UI messages remain safe.
|
||||||
|
- Diagnostic context remains in logs/persisted failure detail where appropriate.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- No unstructured/unclassified exception escapes core boundaries.
|
||||||
|
- API responses are contract-stable for all tested failure modes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Worker Retry and Terminal Failure Policy
|
||||||
|
|
||||||
|
- [ ] **C1. Define bounded retry policy**
|
||||||
|
- Add configurable retry settings (attempt limit/backoff policy).
|
||||||
|
- Limit retries to retriable categories.
|
||||||
|
|
||||||
|
- [ ] **C2. Implement terminal failure persistence**
|
||||||
|
- On retry exhaustion, persist clear terminal reason and `error_id`.
|
||||||
|
- Ensure job status transitions end deterministically at `failed`.
|
||||||
|
|
||||||
|
- [ ] **C3. Add duplicate-processing safety checks**
|
||||||
|
- Prevent duplicate terminal updates when job already resolved.
|
||||||
|
|
||||||
|
- [ ] **C4. Validate worker lifecycle under repeated transient failures**
|
||||||
|
- Ensure loop remains stable and responsive.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Retries are bounded and policy-driven.
|
||||||
|
- Exhausted retries produce deterministic failed state with evidence.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Logging and Observability Contract Enforcement
|
||||||
|
|
||||||
|
- [ ] **D1. Central logging conformance check**
|
||||||
|
- Confirm startup-only `dictConfig` use remains canonical.
|
||||||
|
- No module-level `basicConfig` use.
|
||||||
|
|
||||||
|
- [ ] **D2. Standardize error log fields**
|
||||||
|
- Require at minimum when available:
|
||||||
|
- `error_id`, `category`, `operation`, `exception_type`, `job_id`, `document_id`
|
||||||
|
|
||||||
|
- [ ] **D3. Boundary handoff logging**
|
||||||
|
- Add/normalize logs at transitions:
|
||||||
|
- UI action -> service
|
||||||
|
- service -> provider/db
|
||||||
|
- worker pickup -> terminal state
|
||||||
|
|
||||||
|
- [ ] **D4. Log noise control**
|
||||||
|
- Avoid duplicate stack-trace logging across layers for same exception.
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Critical failure events are traceable end-to-end via logs and `error_id`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — UI Error UX Consistency and Interaction Hardening
|
||||||
|
|
||||||
|
- [ ] **E1. Standardize user error presentation**
|
||||||
|
- For upload/jobs interactions, ensure:
|
||||||
|
- clear title
|
||||||
|
- plain-language message
|
||||||
|
- suggested action
|
||||||
|
- visible error reference id
|
||||||
|
|
||||||
|
- [ ] **E2. Add in-flight interaction guards**
|
||||||
|
- Prevent duplicate submits/click storms during pending operations.
|
||||||
|
|
||||||
|
- [ ] **E3. Ensure deterministic UI state recovery**
|
||||||
|
- controls re-enable after failure
|
||||||
|
- status text remains actionable
|
||||||
|
|
||||||
|
- [ ] **E4. Keep UI boundary clean**
|
||||||
|
- no provider/protocol details leaked into page modules
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- All primary UI actions have consistent success/failure interaction behavior.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase F — Test Expansion and Verification
|
||||||
|
|
||||||
|
Apply pytesting guidance: behavior-first assertions, deterministic fixtures, strict markers.
|
||||||
|
|
||||||
|
- [ ] **F1. API error contract tests**
|
||||||
|
- verify envelope fields and status mapping for each category class.
|
||||||
|
|
||||||
|
- [ ] **F2. Service classification tests**
|
||||||
|
- verify known failures map to expected `AppError` subclasses/categories.
|
||||||
|
|
||||||
|
- [ ] **F3. Worker retry policy tests**
|
||||||
|
- retriable failure retries and eventual success
|
||||||
|
- retriable failure exhaustion -> terminal failed
|
||||||
|
- non-retriable failure -> immediate failed
|
||||||
|
|
||||||
|
- [ ] **F4. UI error behavior tests**
|
||||||
|
- upload/jobs actions show actionable feedback on failures
|
||||||
|
- duplicate action guard behavior
|
||||||
|
|
||||||
|
- [ ] **F5. Regression guard tests**
|
||||||
|
- at least one test per previously observed production/real-world failure mode
|
||||||
|
|
||||||
|
### Validation Commands
|
||||||
|
- `uv run pytest --collect-only -q`
|
||||||
|
- `uv run pytest -m unit -q`
|
||||||
|
- `uv run pytest -m "not external" -q`
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- All Step 2 reliability/error contract tests pass.
|
||||||
|
- Existing suite remains green.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended Implementation Order
|
||||||
|
|
||||||
|
1. Phase A — audit and policy lock
|
||||||
|
2. Phase B — API/service contract hardening
|
||||||
|
3. Phase C — worker retry and terminal policy
|
||||||
|
4. Phase D — logging/traceability normalization
|
||||||
|
5. Phase E — UI consistency hardening
|
||||||
|
6. Phase F — test expansion and full verification
|
||||||
|
|
||||||
|
This order reduces risk by locking policy first, then applying behavior changes at core boundaries before UI polish.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk:** Overly broad retry policy causes hidden failure loops
|
||||||
|
**Mitigation:** strict category-based retry eligibility + hard cap + terminal persistence.
|
||||||
|
|
||||||
|
2. **Risk:** User-facing messages become too technical
|
||||||
|
**Mitigation:** enforce safe message + suggestion contract in tests.
|
||||||
|
|
||||||
|
3. **Risk:** Logging becomes noisy/redundant
|
||||||
|
**Mitigation:** boundary logging rules and single-trace ownership.
|
||||||
|
|
||||||
|
4. **Risk:** Reliability work introduces regressions in happy path
|
||||||
|
**Mitigation:** run full suite continuously; preserve integration pipeline tests.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 2 Completion Checklist
|
||||||
|
|
||||||
|
- [ ] Error taxonomy mapping table completed and approved.
|
||||||
|
- [ ] API envelope and HTTP status behavior verified for all relevant failure categories.
|
||||||
|
- [ ] Service/provider exception normalization is consistent and tested.
|
||||||
|
- [ ] Worker retry behavior is bounded, explicit, and terminal-state safe.
|
||||||
|
- [ ] Structured error logging fields are present at boundary handoffs.
|
||||||
|
- [ ] UI failure flows provide clear, actionable, and traceable feedback.
|
||||||
|
- [ ] Full test suite passes with new Step 2 coverage included.
|
||||||
|
- [ ] `docs/ver1/ver1-step2-results.md` created with evidence and residual risks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 3
|
||||||
|
|
||||||
|
After Step 2 completion, Step 3 (Functional Completion by Requirement Domain) proceeds on a hardened foundation:
|
||||||
|
|
||||||
|
- stable failure contracts,
|
||||||
|
- predictable retries and terminal behavior,
|
||||||
|
- actionable user/API error semantics,
|
||||||
|
- improved diagnostic traceability.
|
||||||
@@ -0,0 +1,160 @@
|
|||||||
|
# Ver1 Step 3 Results: Functional Completion by Requirement Domain
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Step 3 implementation has been completed for the planned functional-completion scope in a practical personal-scale form.
|
||||||
|
|
||||||
|
Implemented in this step:
|
||||||
|
|
||||||
|
1. Revision history and acceptance workflows for transcripts.
|
||||||
|
2. Search over accepted transcript revisions.
|
||||||
|
3. Export of accepted transcript data.
|
||||||
|
4. API routes for jobs, revisions, search, and export.
|
||||||
|
5. UI pathways for revision management, search, and export.
|
||||||
|
6. Carry-forward integration updates for Step 1/2 follow-ups owned by Step 3.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implemented Changes
|
||||||
|
|
||||||
|
### 1) Data model expansion (functional domain)
|
||||||
|
|
||||||
|
Updated `src/transcription/models.py`:
|
||||||
|
|
||||||
|
- Added `JobStatus.COMPLETED`.
|
||||||
|
- Added `TranscriptRevision` table/model:
|
||||||
|
- `job_id`
|
||||||
|
- `revision_number`
|
||||||
|
- `text`
|
||||||
|
- `source`
|
||||||
|
- `accepted`
|
||||||
|
- `created_at`
|
||||||
|
- Added `Job.revisions` relationship.
|
||||||
|
|
||||||
|
This supports immutable revision history and accepted-transcript semantics for search/export.
|
||||||
|
|
||||||
|
### 2) Step 3 service layer
|
||||||
|
|
||||||
|
Created `src/transcription/services/library.py` with service-backed functional operations:
|
||||||
|
|
||||||
|
- `list_jobs(...)`
|
||||||
|
- `get_job_detail(...)`
|
||||||
|
- `add_revision(...)`
|
||||||
|
- `accept_revision(...)`
|
||||||
|
- `list_revisions(...)`
|
||||||
|
- `search_accepted_transcripts(...)`
|
||||||
|
- `export_transcripts(...)`
|
||||||
|
|
||||||
|
Key behavior:
|
||||||
|
|
||||||
|
- revisions are append-only and incrementing
|
||||||
|
- accepted revision is unique per job
|
||||||
|
- accepting a revision syncs canonical transcript and sets job to `completed`
|
||||||
|
- search scope is accepted revisions only
|
||||||
|
- export emits deterministic record payloads for archive workflows
|
||||||
|
|
||||||
|
### 3) Worker integration for revision provenance
|
||||||
|
|
||||||
|
Updated `src/transcription/worker.py`:
|
||||||
|
|
||||||
|
- Success path now calls `add_revision(..., source="worker", accepted=False)`.
|
||||||
|
- Worker still persists canonical transcript and `transcribed` job state.
|
||||||
|
- Initial machine transcription now appears in revision history.
|
||||||
|
|
||||||
|
### 4) API functional completion
|
||||||
|
|
||||||
|
Created `src/transcription/api/routes.py` and wired in `src/transcription/app.py`.
|
||||||
|
|
||||||
|
New endpoints:
|
||||||
|
|
||||||
|
- `GET /api/jobs`
|
||||||
|
- `GET /api/jobs/{job_id}`
|
||||||
|
- `GET /api/jobs/{job_id}/revisions`
|
||||||
|
- `POST /api/jobs/{job_id}/revisions`
|
||||||
|
- `POST /api/revisions/{revision_id}/accept`
|
||||||
|
- `GET /api/search?query=...`
|
||||||
|
- `GET /api/export?accepted_only=true|false`
|
||||||
|
|
||||||
|
### 5) UI functional completion
|
||||||
|
|
||||||
|
Updated `src/transcription/ui/jobs_page.py`:
|
||||||
|
|
||||||
|
- Job detail now includes revision history panel.
|
||||||
|
- Added user revision submission.
|
||||||
|
- Added revision accept action.
|
||||||
|
- Added `/search` page for accepted transcript search.
|
||||||
|
- Added `/export` page for accepted transcript export preview.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Test Evidence
|
||||||
|
|
||||||
|
### Added/Updated Tests
|
||||||
|
|
||||||
|
1. `tests/services/test_library.py`
|
||||||
|
- revision append/accept behavior
|
||||||
|
- accepted-only search behavior
|
||||||
|
- export payload behavior
|
||||||
|
|
||||||
|
2. `tests/api/test_routes.py`
|
||||||
|
- jobs/revisions/search/export API serialization and contract behavior
|
||||||
|
|
||||||
|
3. `tests/test_models.py`
|
||||||
|
- `completed` status transition coverage
|
||||||
|
- `TranscriptRevision` persistence and relationship coverage
|
||||||
|
|
||||||
|
4. `tests/services/test_worker.py`
|
||||||
|
- success-path now verifies initial worker-generated revision persistence
|
||||||
|
|
||||||
|
### Full Validation Run
|
||||||
|
|
||||||
|
Executed and passing:
|
||||||
|
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirement Slice Coverage (Step 3)
|
||||||
|
|
||||||
|
| Slice | REQ Coverage | Status | Evidence |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| Core lifecycle completion and visibility | REQ-0, REQ-2, REQ-3, REQ-5, REQ-6 | met | worker integration + API/UI jobs routes + tests |
|
||||||
|
| Revision history and acceptance | REQ-3, REQ-4, REQ-5, REQ-11 | met | `TranscriptRevision`, `services/library.py`, UI revision panel, tests |
|
||||||
|
| Search over accepted transcripts | REQ-5, REQ-11 | met | `search_accepted_transcripts`, `/api/search`, `/ui/search`, tests |
|
||||||
|
| Export transcript data | REQ-4, REQ-5, REQ-11 | met | `export_transcripts`, `/api/export`, `/ui/export`, tests |
|
||||||
|
| Prompt and verbatim flow continuity | REQ-12 | met (continued) | worker transcription flow unchanged in prompt-loading contract |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Carry-Forward Integration Updates
|
||||||
|
|
||||||
|
Updated:
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step1-2-carry-forward-checklist.md`
|
||||||
|
|
||||||
|
Step 3 updates recorded for:
|
||||||
|
|
||||||
|
- CF-A1: in progress with Step 3 inspection evidence
|
||||||
|
- CF-A3: in progress with boundary-discipline evidence
|
||||||
|
- CF-C1: done (Step 3 traceability artifacts integrated)
|
||||||
|
- CF-C2: in progress (routing preserved for later steps)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Residual Follow-ups
|
||||||
|
|
||||||
|
1. Step 4: migration rehearsal and rollback runbook execution for schema changes.
|
||||||
|
2. Step 6/7: broader error-path inventory closure and logging field normalization.
|
||||||
|
3. Step 9: release readiness reconfirmation for runtime ownership and migration behavior.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 3 Exit Assessment
|
||||||
|
|
||||||
|
- Requirement-domain functional completion: **met**
|
||||||
|
- Data integrity and state consistency for new flows: **met**
|
||||||
|
- API/UI parity for new Step 3 features: **met**
|
||||||
|
- Test and regression safety: **met**
|
||||||
|
- Carry-forward integration obligations (Step 3-owned): **met/in progress as routed**
|
||||||
|
|
||||||
|
Step 3 is complete and ready to hand off to Step 4.
|
||||||
@@ -0,0 +1,433 @@
|
|||||||
|
# Step 3 Implementation Plan: Functional Completion by Requirement Domain
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Implement **Ver1 Step 3** from `docs/ver1/ver1.md` by completing all in-scope V1 functional requirements in a practical, user-first order while preserving:
|
||||||
|
|
||||||
|
- personal-scale operation
|
||||||
|
- single-operator workflow
|
||||||
|
- private-network deployment assumptions
|
||||||
|
- low operational overhead
|
||||||
|
- clean architecture boundaries
|
||||||
|
|
||||||
|
Primary governing docs:
|
||||||
|
|
||||||
|
- `docs/ver1/ver1.md` (Step 3 objective and sequencing)
|
||||||
|
- `docs/architecture.md` (module boundaries, workflow, simplicity guardrails)
|
||||||
|
- `docs/requirements.md` (REQ-0 through REQ-12 traceability)
|
||||||
|
- `docs/error_handling.md` (error contract across boundaries)
|
||||||
|
- `docs/intent.md` (verbatim transcription policy and prompt curation)
|
||||||
|
- `docs/ver1/ver1-step1-2-carry-forward-checklist.md` (Step 1/2 carry-forward integration)
|
||||||
|
- `docs/ver1/ver1-step2-error-path-inventory.md` (failure-path coverage visibility)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Resources Reviewed and Applied
|
||||||
|
|
||||||
|
All resources on `john-stream-mcp` were reviewed. Step 3 applies the following guidance directly:
|
||||||
|
|
||||||
|
1. `resource://skills/nicegui/document`
|
||||||
|
- modular page registration
|
||||||
|
- one-way dependency flow (`ui/api -> services -> infra`)
|
||||||
|
- async-first UI responsiveness expectations
|
||||||
|
|
||||||
|
2. `resource://skills/nicegui-ui-customization/document`
|
||||||
|
- reusable UI component extraction for repeated patterns
|
||||||
|
- in-flight guards and explicit success/failure user feedback
|
||||||
|
- event-driven updates over ad-hoc polling
|
||||||
|
|
||||||
|
3. `resource://skills/fastapi-async-sqlalchemy-modernization/document`
|
||||||
|
- explicit transaction/session boundaries
|
||||||
|
- deterministic resource ownership and cleanup continuity from Step 1
|
||||||
|
- incremental migration strategy with rollback-aware checkpoints
|
||||||
|
|
||||||
|
4. `resource://skills/pydantic-settings/document`
|
||||||
|
- typed configuration as single source of runtime truth
|
||||||
|
- explicit source precedence and environment-safe defaults
|
||||||
|
|
||||||
|
5. `resource://skills/python-logging-dictconfig/document`
|
||||||
|
- centralized startup-only logging configuration
|
||||||
|
- named logger discipline and boundary-level structured fields
|
||||||
|
|
||||||
|
6. `resource://skills/pytesting/document`
|
||||||
|
- deterministic test structure and marker discipline
|
||||||
|
- behavior-first tests with clear fast-path and full-suite validation
|
||||||
|
|
||||||
|
7. `resource://skills/fastapi-uv-docker/document`
|
||||||
|
- health endpoint and runtime startup/shutdown hygiene
|
||||||
|
- compose/deployment readiness constraints relevant to functional completion
|
||||||
|
|
||||||
|
8. `resource://skills/python-typing/document`
|
||||||
|
- modern typing updates where touched by Step 3 work
|
||||||
|
|
||||||
|
9. `resource://skills/ruff-linting-formating/document`
|
||||||
|
- maintain lint/format consistency in all modified modules
|
||||||
|
|
||||||
|
10. `resource://prompts/greenfield-architecture/document`
|
||||||
|
- explicit staged delivery with tradeoff-aware sequencing and test strategy
|
||||||
|
|
||||||
|
11. `resource://prompts/pytest-scaffold/document`
|
||||||
|
12. `resource://prompts/pytest-fill-scaffold/document`
|
||||||
|
- structure-first test planning, then deterministic implementation fill-in
|
||||||
|
|
||||||
|
Resources reviewed but not directly in Step 3 execution scope (no changes required now):
|
||||||
|
|
||||||
|
- `copilot-customization`, `mcp-details`, `vscode-configuration`, `zensical-docs`
|
||||||
|
- prompts: `authoring`, `mcp-consumer-repo-shim`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 3 Success Criteria
|
||||||
|
|
||||||
|
Step 3 is complete when:
|
||||||
|
|
||||||
|
1. All Step 3-targeted requirement slices are implemented and verified.
|
||||||
|
2. Functional behavior is available through UI/API where required.
|
||||||
|
3. Core data integrity and state transitions are deterministic.
|
||||||
|
4. Error behavior follows `docs/error_handling.md` contracts.
|
||||||
|
5. Carry-forward Step 1/2 items mapped to Step 3 are updated with evidence.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirement-Slice Execution Model (Applied to Every Slice)
|
||||||
|
|
||||||
|
For each slice, execute this sequence:
|
||||||
|
|
||||||
|
1. Confirm contract/schema and boundary ownership.
|
||||||
|
2. Implement service/domain logic.
|
||||||
|
3. Implement persistence/state transitions.
|
||||||
|
4. Integrate API and/or UI behavior.
|
||||||
|
5. Add/update unit + integration + targeted end-to-end tests.
|
||||||
|
6. Update docs and traceability artifacts.
|
||||||
|
|
||||||
|
Definition of done per slice:
|
||||||
|
|
||||||
|
- behavior is functional
|
||||||
|
- tests pass in intended marker lanes
|
||||||
|
- error pathways are classified and surfaced correctly
|
||||||
|
- requirement traceability is updated with evidence
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Workstreams
|
||||||
|
|
||||||
|
## Workstream A — Functional Baseline Audit and Slice Backlog Lock
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- establish exact Step 3 functional delta from current implementation
|
||||||
|
- lock a practical slice backlog before coding
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Build Step 3 requirement matrix (REQ -> current status -> gap -> target slice).
|
||||||
|
2. Map each gap to one of these domains:
|
||||||
|
- Upload and lifecycle integrity
|
||||||
|
- Review and revision history
|
||||||
|
- Search over accepted transcripts
|
||||||
|
- Export workflows
|
||||||
|
- Prompt asset management behavior
|
||||||
|
- API/UI parity and status visibility
|
||||||
|
3. Align each slice with architecture boundary ownership and persistence strategy.
|
||||||
|
4. Link open carry-forward items from checklist:
|
||||||
|
- CF-A1, CF-A3 (architecture continuity in Step 3)
|
||||||
|
- CF-C1, CF-C2 (traceability/execution continuity)
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- Step 3 requirement-slice matrix (appendix in this doc or separate artifact)
|
||||||
|
- prioritized slice backlog with owner and validation method
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- every Step 3 slice maps to REQ IDs and a validation method
|
||||||
|
- no ambiguous ownership remains for in-scope slices
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream B — Core End-User Flows (Upload -> Transcribe -> Review)
|
||||||
|
|
||||||
|
### Related Requirements
|
||||||
|
|
||||||
|
- REQ-0, REQ-1, REQ-2, REQ-3, REQ-4, REQ-5, REQ-6, REQ-12
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- guarantee end-to-end reliability and usability of the primary user flow
|
||||||
|
- ensure review experience supports transcript acceptance and correction
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Validate and close any lifecycle-state gaps:
|
||||||
|
- enforce valid transitions (`queued -> processing -> transcribed/failed/completed`)
|
||||||
|
- ensure transition visibility in UI/API
|
||||||
|
2. Review experience completion:
|
||||||
|
- transcript detail display stability
|
||||||
|
- failure detail readability and actionability
|
||||||
|
- acceptance/edit path for human review
|
||||||
|
3. Ensure prompt-asset integration remains file-based and auditable:
|
||||||
|
- one prompt per Markdown file
|
||||||
|
- prompt selection/usage traceability in job outcomes (if available in model)
|
||||||
|
4. Confirm worker/UI interactions remain responsive under long-running jobs:
|
||||||
|
- in-flight guards
|
||||||
|
- clear status refresh behavior
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- complete end-user flow behavior with stable lifecycle visibility
|
||||||
|
- test coverage for happy path and failure path
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- user can run upload -> process -> review reliably
|
||||||
|
- failed and successful outcomes are both actionable and traceable
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream C — Revision History and Provenance Completion
|
||||||
|
|
||||||
|
### Related Requirements
|
||||||
|
|
||||||
|
- REQ-3, REQ-4, REQ-5, REQ-11
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- finalize immutable transcript revision behavior and provenance consistency
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Define/confirm revision invariants:
|
||||||
|
- append-only revision history
|
||||||
|
- clear current/accepted revision indicator
|
||||||
|
2. Persist revision events consistently through service layer boundaries.
|
||||||
|
3. Ensure UI/API expose revision timeline and selected revision details.
|
||||||
|
4. Align error handling for revision conflicts and missing resources.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- revision-history feature completeness
|
||||||
|
- provenance and history read-path coverage
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- transcript edits produce deterministic revision records
|
||||||
|
- previous revisions remain inspectable
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream D — Search Completion (Accepted Transcript Scope)
|
||||||
|
|
||||||
|
### Related Requirements
|
||||||
|
|
||||||
|
- REQ-0, REQ-5, REQ-11
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- provide practical search over accepted transcripts for personal corpus usage
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Finalize searchable scope and indexing rules (accepted/current text only).
|
||||||
|
2. Implement service-backed search query behavior.
|
||||||
|
3. Expose search in UI/API with clear result metadata (document/job/revision context).
|
||||||
|
4. Add guardrails for empty/no-result/error scenarios with actionable messaging.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- functional search pathway with deterministic results for accepted text
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- operator can find transcripts reliably by text queries
|
||||||
|
- no-result and error states are clear and non-silent
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream E — Export Completion
|
||||||
|
|
||||||
|
### Related Requirements
|
||||||
|
|
||||||
|
- REQ-0, REQ-4, REQ-5, REQ-11
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- deliver practical export of transcript data for personal archive use
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Finalize export contract (format, included fields, scope filters).
|
||||||
|
2. Implement export service with deterministic data mapping.
|
||||||
|
3. Add UI/API trigger path and user-visible completion/failure feedback.
|
||||||
|
4. Validate export integrity against persisted source-of-record entities.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- end-to-end export capability with operator-visible outcomes
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- export output is complete, consistent, and usable for downstream personal archive workflows
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream F — API/UI Parity and Interaction Hardening
|
||||||
|
|
||||||
|
### Related Requirements
|
||||||
|
|
||||||
|
- REQ-5 plus cross-cutting REQ-2/3/4
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- ensure UI and API expose coherent feature behavior and error contracts
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Verify API/UI parity matrix for each Step 3 slice.
|
||||||
|
2. Standardize interaction behavior:
|
||||||
|
- loading and in-flight states
|
||||||
|
- success/failure notifications
|
||||||
|
- stable error_id visibility where user-facing
|
||||||
|
3. Ensure route/page modules remain composition-focused (business logic in services).
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- API/UI parity checklist with resolved gaps
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- no major flow exists in one interface with conflicting semantics in the other
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream G — Carry-Forward Integration During Step 3
|
||||||
|
|
||||||
|
### Goals
|
||||||
|
|
||||||
|
- close Step 1/2 follow-ups that are Step 3-owned
|
||||||
|
|
||||||
|
### Tasks
|
||||||
|
|
||||||
|
1. Update checklist item CF-A1 as Step 3 slices touch runtime resources.
|
||||||
|
2. Update checklist item CF-A3 with lightweight boundary enforcement evidence.
|
||||||
|
3. Update CF-C1/CF-C2 traceability mapping with Step 3 outcomes.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- updated `docs/ver1/ver1-step1-2-carry-forward-checklist.md` evidence entries
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- Step 3-owned carry-forward items are either completed or explicitly routed with evidence
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Test and Validation Plan
|
||||||
|
|
||||||
|
Apply `pytesting` guidance with deterministic, behavior-focused coverage.
|
||||||
|
|
||||||
|
### Validation Lanes
|
||||||
|
|
||||||
|
1. Structure/collection:
|
||||||
|
- `uv run pytest --collect-only -q`
|
||||||
|
2. Fast feedback lane:
|
||||||
|
- `uv run pytest -m unit -q`
|
||||||
|
3. Main verification lane:
|
||||||
|
- `uv run pytest -m "not external" -q`
|
||||||
|
4. Full suite:
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
### Required Coverage Areas
|
||||||
|
|
||||||
|
- lifecycle transition invariants
|
||||||
|
- revision history invariants
|
||||||
|
- search query behavior and result mapping
|
||||||
|
- export integrity and failure handling
|
||||||
|
- UI interaction guards and actionable failure feedback
|
||||||
|
- API envelope and status consistency for new/changed flows
|
||||||
|
|
||||||
|
### Test Design Rules
|
||||||
|
|
||||||
|
- one behavior target per test
|
||||||
|
- minimize heavy mocking; prefer real-path behavior checks where practical
|
||||||
|
- keep markers explicit and strict
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Logging, Error, and Config Guardrails for Step 3 Changes
|
||||||
|
|
||||||
|
1. Logging
|
||||||
|
- keep centralized startup logging config (`dictConfig`) as canonical
|
||||||
|
- include required error fields at boundary failures (`error_id`, `category`, `operation`, identifiers where available)
|
||||||
|
|
||||||
|
2. Error handling
|
||||||
|
- preserve taxonomy stability from `docs/error_handling.md`
|
||||||
|
- map any new failure pathways into existing categories
|
||||||
|
- surface actionable suggestions in UI/API
|
||||||
|
|
||||||
|
3. Configuration
|
||||||
|
- use typed settings and avoid ad-hoc env reads in business modules
|
||||||
|
- keep environment behavior explicit and documented
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implementation Order (Detailed)
|
||||||
|
|
||||||
|
1. Workstream A: audit and backlog lock
|
||||||
|
2. Workstream B: core flow completion
|
||||||
|
3. Workstream C: revision/provenance completion
|
||||||
|
4. Workstream D: search completion
|
||||||
|
5. Workstream E: export completion
|
||||||
|
6. Workstream F: API/UI parity hardening
|
||||||
|
7. Workstream G: carry-forward integration updates
|
||||||
|
8. Full validation pass + docs/traceability updates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Deliverables
|
||||||
|
|
||||||
|
1. Step 3 requirement-slice matrix with REQ mapping and evidence links
|
||||||
|
2. implemented Step 3 functional slices across service/persistence/API/UI
|
||||||
|
3. updated tests and passing validation lanes
|
||||||
|
4. updated carry-forward checklist entries (`CF-A1`, `CF-A3`, `CF-C1`, `CF-C2` as applicable)
|
||||||
|
5. Step 3 results document (`docs/ver1/ver1-step3-results.md`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk:** Scope creep from optional enhancements during feature completion
|
||||||
|
- **Mitigation:** enforce REQ-mapped slice backlog and defer non-REQ enhancements
|
||||||
|
|
||||||
|
2. **Risk:** Functional parity drift between UI and API
|
||||||
|
- **Mitigation:** maintain parity matrix and verify both surfaces per slice
|
||||||
|
|
||||||
|
3. **Risk:** Data-model changes introduce migration surprises
|
||||||
|
- **Mitigation:** coordinate with Step 4 runbook expectations early and test on representative data
|
||||||
|
|
||||||
|
4. **Risk:** Reliability regressions while adding functionality
|
||||||
|
- **Mitigation:** run full error-path regression checks and keep Step 2 contracts intact
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 3 Completion Checklist
|
||||||
|
|
||||||
|
- [ ] Step 3 requirement-slice matrix completed and linked to REQ IDs.
|
||||||
|
- [ ] Core end-user flow is functionally complete and verified.
|
||||||
|
- [ ] Revision history/provenance behavior is complete and test-covered.
|
||||||
|
- [ ] Search over accepted transcripts is complete and test-covered.
|
||||||
|
- [ ] Export flow is complete and test-covered.
|
||||||
|
- [ ] API/UI parity checklist has no unresolved high-impact gaps.
|
||||||
|
- [ ] Step 3-owned carry-forward items are updated with evidence.
|
||||||
|
- [ ] Validation lanes pass (`collect-only`, unit, non-external, full).
|
||||||
|
- [ ] `docs/ver1/ver1-step3-results.md` is created with evidence and residual follow-ups.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 4
|
||||||
|
|
||||||
|
Step 3 completion enables Step 4 (Data Model and Migration Safety) with:
|
||||||
|
|
||||||
|
- finalized functional domain behavior
|
||||||
|
- stable persistence expectations
|
||||||
|
- traceable requirement evidence
|
||||||
|
- clarified migration-impact surface
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
# Ver1 Step 4 Migration and Rollback Runbook
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Provide a concise, operator-safe procedure for schema migration execution,
|
||||||
|
compatibility validation, and rollback/mitigation for personal-scale deployments.
|
||||||
|
|
||||||
|
This runbook supports `docs/ver1/ver1-step4.md` and REQ-10 by keeping normal
|
||||||
|
production startup non-mutating unless explicitly configured otherwise.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Preconditions
|
||||||
|
|
||||||
|
1. Application version to deploy is known and checked out.
|
||||||
|
2. `.env` values are configured for target environment.
|
||||||
|
3. Database backup path is prepared.
|
||||||
|
4. Application process is stopped before migration on production-like systems.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
Use explicit migration runner operations:
|
||||||
|
|
||||||
|
1. List pending migrations:
|
||||||
|
- `uv run python -m transcription.migration_runner --list`
|
||||||
|
2. Apply pending migrations:
|
||||||
|
- `uv run python -m transcription.migration_runner --apply`
|
||||||
|
3. Validate schema compatibility:
|
||||||
|
- `uv run python -m transcription.migration_runner --check`
|
||||||
|
|
||||||
|
Recommended execution order:
|
||||||
|
|
||||||
|
1. `--list`
|
||||||
|
2. backup database
|
||||||
|
3. `--apply`
|
||||||
|
4. `--check`
|
||||||
|
5. start application
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Backup Procedure (SQLite Baseline)
|
||||||
|
|
||||||
|
For SQLite deployments, copy the DB file before migration:
|
||||||
|
|
||||||
|
- Example DB path default: `./transcription.db`
|
||||||
|
- Keep timestamped backup copy in a safe location.
|
||||||
|
|
||||||
|
If the file is in active use, stop the app first.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Verification Checklist
|
||||||
|
|
||||||
|
After migration apply:
|
||||||
|
|
||||||
|
1. `--check` exits successfully.
|
||||||
|
2. `schema_migration_history` includes applied revisions.
|
||||||
|
3. Application starts successfully.
|
||||||
|
4. Health endpoint responds: `/healthz`.
|
||||||
|
5. Critical flows smoke-check:
|
||||||
|
- upload
|
||||||
|
- job processing
|
||||||
|
- revision listing/acceptance
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Rollback and Mitigation Decision Tree
|
||||||
|
|
||||||
|
1. If migration fails before changes commit:
|
||||||
|
- fix issue
|
||||||
|
- re-run apply
|
||||||
|
2. If migration partially applied or compatibility check fails:
|
||||||
|
- stop app
|
||||||
|
- restore from backup
|
||||||
|
- investigate and produce forward-fix migration if needed
|
||||||
|
3. If app starts but functional invariants fail:
|
||||||
|
- stop app
|
||||||
|
- restore backup
|
||||||
|
- add corrective migration/backfill and rehearse before retry
|
||||||
|
|
||||||
|
For this Step 4 baseline, backup restore is the primary rollback mechanism.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Failure Classification Guidance
|
||||||
|
|
||||||
|
Classify migration failures using `docs/error_handling.md` categories:
|
||||||
|
|
||||||
|
- transient connection issues -> `infrastructure_transient_error`
|
||||||
|
- permissions/misconfiguration -> `infrastructure_persistent_error`
|
||||||
|
- unexpected migration logic defects -> `internal_unexpected_error`
|
||||||
|
|
||||||
|
Record failure details with operation context and timestamp.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operational Notes
|
||||||
|
|
||||||
|
- `migration_auto_apply_on_startup` defaults to `False`.
|
||||||
|
- `validate_schema_on_startup` defaults to `True`.
|
||||||
|
- Startup schema validation fails fast on incompatibility.
|
||||||
|
|
||||||
|
This protects production from accidental schema drift.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Post-Step-4 Follow-Up
|
||||||
|
|
||||||
|
If migration complexity grows beyond lightweight revision scripts,
|
||||||
|
introduce a dedicated migration framework in a future step while preserving
|
||||||
|
this runbook structure and operator-first workflow.
|
||||||
@@ -0,0 +1,153 @@
|
|||||||
|
# Ver1 Step 4 Results: Data Model and Migration Safety
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Step 4 implementation status: **complete (baseline scope)**.
|
||||||
|
|
||||||
|
This document records completed migration-safety work, validation evidence, and remaining follow-ups for Ver1 Step 4.
|
||||||
|
|
||||||
|
Implemented in this step:
|
||||||
|
|
||||||
|
1. Added explicit migration framework module with revision history tracking.
|
||||||
|
2. Added schema compatibility validation and startup guardrails.
|
||||||
|
3. Added migration runner CLI for list/apply/check operations.
|
||||||
|
4. Added migration tests and Step 4 validation evidence.
|
||||||
|
5. Added Step 4 migration/rollback runbook.
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implemented Changes
|
||||||
|
|
||||||
|
### 1) Schema audit and invariant lock
|
||||||
|
|
||||||
|
Implemented read-only compatibility checks in `src/transcription/db.py`:
|
||||||
|
|
||||||
|
- `validate_schema_compatibility(...)` verifies required V1 tables:
|
||||||
|
- `document`
|
||||||
|
- `job`
|
||||||
|
- `transcript`
|
||||||
|
- `transcriptrevision`
|
||||||
|
- verifies required `job.retry_count` column
|
||||||
|
- returns explicit issue identifiers (non-mutating check)
|
||||||
|
|
||||||
|
### 2) Migration policy/tooling lock
|
||||||
|
|
||||||
|
Added explicit migration revision model in `src/transcription/migrations.py`:
|
||||||
|
|
||||||
|
- `MigrationRevision` dataclass
|
||||||
|
- ordered `MIGRATIONS` registry
|
||||||
|
- migration history table: `schema_migration_history`
|
||||||
|
- explicit pending-list and apply operations
|
||||||
|
|
||||||
|
### 3) Forward migration implementation
|
||||||
|
|
||||||
|
Implemented two baseline forward migrations:
|
||||||
|
|
||||||
|
1. `0001_add_retry_count_to_job`
|
||||||
|
2. `0002_create_transcriptrevision_table`
|
||||||
|
|
||||||
|
Each migration is idempotent and recorded in migration history.
|
||||||
|
|
||||||
|
### 4) Rollback and mitigation runbook
|
||||||
|
|
||||||
|
Created `docs/ver1/ver1-step4-migration-runbook.md` with:
|
||||||
|
|
||||||
|
- preconditions
|
||||||
|
- list/apply/check command sequence
|
||||||
|
- backup-first procedure
|
||||||
|
- verification checklist
|
||||||
|
- rollback/mitigation decision tree
|
||||||
|
- error classification guidance aligned to `docs/error_handling.md`
|
||||||
|
|
||||||
|
### 5) Backfill implementation or explicit no-backfill decision
|
||||||
|
|
||||||
|
No backfill required for this baseline Step 4 scope.
|
||||||
|
|
||||||
|
Rationale:
|
||||||
|
|
||||||
|
- additive migration operations only
|
||||||
|
- default values and new-table creation do not require historical row rewrites for current V1 invariants
|
||||||
|
- residual advanced backfill scenarios deferred unless future schema evolution introduces incompatible transforms
|
||||||
|
---
|
||||||
|
|
||||||
|
## Test and Verification Evidence
|
||||||
|
|
||||||
|
### Added/Updated Tests
|
||||||
|
|
||||||
|
1. `tests/test_migrations.py`
|
||||||
|
- pending migration discovery
|
||||||
|
- migration apply + history recording
|
||||||
|
- idempotent re-apply behavior
|
||||||
|
2. `tests/test_db.py`
|
||||||
|
- compatibility-check behavior on fresh schema
|
||||||
|
- table expectation updates for `transcriptrevision`
|
||||||
|
3. `tests/test_config.py`
|
||||||
|
- migration safety setting defaults
|
||||||
|
4. `tests/test_app.py`
|
||||||
|
- lifespan test compatibility with migration/validation startup hooks
|
||||||
|
### Validation Runs
|
||||||
|
|
||||||
|
Run and record outcomes:
|
||||||
|
|
||||||
|
- `uv run pytest --collect-only -q` -> passed
|
||||||
|
- `uv run pytest -m unit -q` -> passed
|
||||||
|
- `uv run pytest -m "not external" -q` -> passed
|
||||||
|
- `uv run pytest -q` -> passed
|
||||||
|
### Migration Rehearsal Evidence
|
||||||
|
|
||||||
|
Migration rehearsal details (test-based):
|
||||||
|
|
||||||
|
- baseline data set used: in-memory SQLite legacy-shaped schema fixture (`job` table missing Step 4 additions)
|
||||||
|
- forward migration result: pending revisions applied successfully (`0001`, `0002`)
|
||||||
|
- post-migration verification result: schema checks pass and migration history recorded
|
||||||
|
- rollback/mitigation rehearsal result: runbook defined backup-restore primary rollback class for personal-scale SQLite deployment
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirement Traceability (Step 4)
|
||||||
|
|
||||||
|
| Step 4 Area | REQ Coverage | Status | Evidence |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| Schema lifecycle and state persistence safety | REQ-3, REQ-4, REQ-11 | met | `src/transcription/migrations.py`, `tests/test_migrations.py`, `tests/test_db.py` |
|
||||||
|
| Lifespan/runtime ownership continuity | REQ-7 | met | `src/transcription/app.py` startup checks + existing lifespan ownership model |
|
||||||
|
| Explicit non-mutating production startup policy | REQ-10 | met | `migration_auto_apply_on_startup=False` default + explicit runner workflow + startup validation gate |
|
||||||
|
| Prompt/data continuity constraints | REQ-12 | met (continued) | no prompt-contract mutation in Step 4 changes |
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operational Artifacts Produced
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step4.md`
|
||||||
|
- `docs/ver1/ver1-step4-migration-runbook.md`
|
||||||
|
- `src/transcription/migrations.py`
|
||||||
|
- `src/transcription/migration_runner.py`
|
||||||
|
- README migration workflow updates
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks, Exceptions, and Follow-Ups
|
||||||
|
|
||||||
|
1. This lightweight migration system is appropriate for current personal-scale scope but may require a dedicated framework as schema complexity grows.
|
||||||
|
2. Rollback remains backup-restore primary; reversible down-migration coverage is intentionally limited in this baseline.
|
||||||
|
3. Startup compatibility checks currently fail fast with generic runtime error text and can be further normalized under API/operator error envelopes in later hardening.
|
||||||
|
|
||||||
|
Open follow-ups to carry forward:
|
||||||
|
|
||||||
|
- Evaluate migration framework escalation criteria in Step 9/10 readiness updates.
|
||||||
|
- Add optional richer structured migration logging fields if observability scope expands.
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 4 Exit Assessment
|
||||||
|
|
||||||
|
- Schema validation against finalized V1 domain: **met**
|
||||||
|
- Forward migration path safety and repeatability: **met (baseline scope)**
|
||||||
|
- Rollback/mitigation readiness: **met (backup-restore primary path)**
|
||||||
|
- Backfill risk closure: **met (no backfill required for current deltas)**
|
||||||
|
- Test and regression safety: **met**
|
||||||
|
|
||||||
|
Step 4 completion status: **complete (baseline scope)**
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 5
|
||||||
|
|
||||||
|
Once Step 4 is marked complete, Step 5 can proceed with:
|
||||||
|
|
||||||
|
- verified migration safety baseline
|
||||||
|
- explicit rollback and recovery procedures
|
||||||
|
- reduced data-integrity risk entering private-network safety hardening
|
||||||
@@ -0,0 +1,378 @@
|
|||||||
|
# Step 4 Implementation Plan: Data Model and Migration Safety
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Implement **Ver1 Step 4** from `docs/ver1/ver1.md` by making data-model evolution safe, explicit, and repeatable for personal-scale deployment.
|
||||||
|
|
||||||
|
Step 4 ensures schema changes are handled through deterministic migration workflows rather than implicit startup mutation, while preserving:
|
||||||
|
|
||||||
|
- personal-scale operational simplicity
|
||||||
|
- single-operator deployment model
|
||||||
|
- lifecycle-owned runtime resource boundaries
|
||||||
|
- stable requirement traceability and low rollback risk
|
||||||
|
|
||||||
|
Primary governing docs:
|
||||||
|
|
||||||
|
- `docs/ver1/ver1.md` (Step 4 objective and sequencing)
|
||||||
|
- `docs/architecture.md` (runtime ownership, persistence boundaries, simplicity guardrails)
|
||||||
|
- `docs/requirements.md` (REQ-3, REQ-4, REQ-7, REQ-10, REQ-11, REQ-12 emphasis)
|
||||||
|
- `docs/error_handling.md` (failure classification and safe error surfacing)
|
||||||
|
- `docs/intent.md` (verbatim/transcription/revision domain behavior)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Resources Reviewed and Applied
|
||||||
|
|
||||||
|
All currently available resources on `john-stream-mcp` were reviewed. Step 4 applies the following guidance directly:
|
||||||
|
|
||||||
|
1. `resource://skills/fastapi-async-sqlalchemy-modernization/document`
|
||||||
|
- explicit engine/session lifecycle ownership
|
||||||
|
- transaction boundary clarity for schema transitions and backfills
|
||||||
|
- phased rollout with rollback-aware checkpoints
|
||||||
|
|
||||||
|
2. `resource://skills/pydantic-settings/document`
|
||||||
|
- typed migration/runtime safety settings
|
||||||
|
- explicit source-precedence behavior for operational toggles
|
||||||
|
- fail-fast config semantics for unsafe startup paths
|
||||||
|
|
||||||
|
3. `resource://skills/pytesting/document`
|
||||||
|
- deterministic migration verification lanes
|
||||||
|
- strict marker discipline
|
||||||
|
- behavior-first test coverage for migration outcomes
|
||||||
|
|
||||||
|
4. `resource://skills/python-logging-dictconfig/document`
|
||||||
|
- startup-centralized logging configuration
|
||||||
|
- structured migration and rollback event traceability
|
||||||
|
|
||||||
|
5. `resource://skills/fastapi-uv-docker/document`
|
||||||
|
- deployment and rehearsal discipline
|
||||||
|
- startup/health posture validation during migration windows
|
||||||
|
|
||||||
|
6. `resource://skills/python-typing/document`
|
||||||
|
- modern typing hygiene for touched migration/persistence modules
|
||||||
|
|
||||||
|
7. `resource://skills/ruff-linting-formating/document`
|
||||||
|
- lint/format consistency for migration scripts and database modules
|
||||||
|
|
||||||
|
Planning methodology inputs also applied:
|
||||||
|
|
||||||
|
8. `resource://prompts/greenfield-architecture/document`
|
||||||
|
- staged execution with explicit risk and extension handling
|
||||||
|
|
||||||
|
9. `resource://prompts/pytest-scaffold/document`
|
||||||
|
10. `resource://prompts/pytest-fill-scaffold/document`
|
||||||
|
- test-structure-first and deterministic fill-in sequencing
|
||||||
|
|
||||||
|
Reviewed but not directly Step 4 execution-critical:
|
||||||
|
|
||||||
|
- skills: `copilot-customization`, `mcp-details`, `nicegui`, `nicegui-ui-customization`, `vscode-configuration`, `zensical-docs`
|
||||||
|
- prompts: `authoring`, `mcp-consumer-repo-shim`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Current-State Gap Summary (Step 4 Scope)
|
||||||
|
|
||||||
|
Based on Step 1–3 outcomes and current docs/tests:
|
||||||
|
|
||||||
|
1. **Bootstrap policy baseline is present**
|
||||||
|
- Environment-aware schema bootstrap policy exists and aligns with REQ-10 intent.
|
||||||
|
2. **Functional model expanded in Step 3**
|
||||||
|
- Revision/acceptance features introduce schema evolution requirements that need formal migration safety rehearsal.
|
||||||
|
3. **Runbook maturity required**
|
||||||
|
- Step 4 requires explicit migration + rollback procedures and evidence.
|
||||||
|
4. **Backfill risk must be evaluated**
|
||||||
|
- New/changed fields and semantics must be checked for historical data reconciliation needs.
|
||||||
|
5. **Release-path integration needed**
|
||||||
|
- Step 4 artifacts must feed Step 9 release readiness and Step 10 docs completion.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope for Step 4
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
|
||||||
|
1. Validate final V1 schema against implemented domain behavior (post-Step 3 reality).
|
||||||
|
2. Define and implement forward-safe migration path for expected upgrades.
|
||||||
|
3. Define and document rollback/mitigation strategy for migration failures.
|
||||||
|
4. Implement backfill scripts only if required, with idempotent behavior.
|
||||||
|
5. Rehearse migration + rollback locally using representative sample data.
|
||||||
|
6. Add Step 4-specific verification tests and operational checks.
|
||||||
|
7. Produce operator-facing migration/rollback runbook and Step 4 results evidence.
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
|
||||||
|
- Distributed/externally orchestrated migration systems
|
||||||
|
- Major persistence-architecture rewrites beyond V1 scope
|
||||||
|
- Non-V1 enhancement migrations unrelated to implemented requirement slices
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Target Decisions for Step 4
|
||||||
|
|
||||||
|
1. **Production startup remains non-mutating by default**
|
||||||
|
- Preserve REQ-10 posture and avoid implicit schema mutation at normal startup.
|
||||||
|
|
||||||
|
2. **Schema changes are explicit operator workflows**
|
||||||
|
- Migrations run as deliberate operational actions, not hidden side effects.
|
||||||
|
|
||||||
|
3. **Migration safety beats migration speed**
|
||||||
|
- Additive and reversible-first patterns are preferred where possible.
|
||||||
|
|
||||||
|
4. **Rollback policy is explicit per change**
|
||||||
|
- Each migration must declare rollback class:
|
||||||
|
- direct rollback supported
|
||||||
|
- forward-fix required
|
||||||
|
- backup restore required
|
||||||
|
|
||||||
|
5. **Backfills are optional and minimal**
|
||||||
|
- Introduce only when required by correctness/invariants, never by convenience.
|
||||||
|
|
||||||
|
6. **Migration observability is mandatory**
|
||||||
|
- Structured logs include operation, migration identifier, status, and failure classification.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Work Breakdown
|
||||||
|
|
||||||
|
## Phase A — Schema and Domain Invariant Audit
|
||||||
|
|
||||||
|
- [ ] **A1. Build canonical V1 schema inventory**
|
||||||
|
- Enumerate all persisted entities and key fields:
|
||||||
|
- document records
|
||||||
|
- jobs and statuses
|
||||||
|
- transcripts
|
||||||
|
- transcript revisions
|
||||||
|
- failure/provenance fields
|
||||||
|
- [ ] **A2. Validate invariants against implemented behavior**
|
||||||
|
- Cross-check Step 3 functionality and current domain expectations:
|
||||||
|
- append-only revision history
|
||||||
|
- accepted revision semantics
|
||||||
|
- canonical transcript synchronization behavior
|
||||||
|
- [ ] **A3. Classify required schema deltas**
|
||||||
|
- Categorize deltas:
|
||||||
|
- additive and safe
|
||||||
|
- compatibility-sensitive
|
||||||
|
- potentially destructive (must be staged or deferred)
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step4-schema-audit.md` (recommended)
|
||||||
|
- schema-delta matrix with risk class and owning module
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- all required schema changes have explicit rationale and risk classification
|
||||||
|
- no ambiguous domain invariant remains
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — Migration Policy and Tooling Lock
|
||||||
|
|
||||||
|
- [ ] **B1. Lock migration workflow policy**
|
||||||
|
- Define canonical migration execution path and artifact conventions.
|
||||||
|
- [ ] **B2. Define migration authoring checklist**
|
||||||
|
- Include:
|
||||||
|
- preconditions
|
||||||
|
- forward steps
|
||||||
|
- rollback class
|
||||||
|
- post-verification checks
|
||||||
|
- [ ] **B3. Align policy with runtime startup safeguards**
|
||||||
|
- Ensure production startup remains explicit/non-mutating by default.
|
||||||
|
- [ ] **B4. Define operator invocation standard**
|
||||||
|
- One documented command path for local and production-like workflows.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- migration policy section (this doc + runbook)
|
||||||
|
- migration authoring/review checklist
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- one unambiguous migration process exists and is documented
|
||||||
|
- startup policy and migration policy are consistent and non-conflicting
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Forward Migration Implementation
|
||||||
|
|
||||||
|
- [ ] **C1. Implement required migration set**
|
||||||
|
- Build migration artifacts for all approved Step 4 deltas.
|
||||||
|
- [ ] **C2. Preserve compatibility where needed**
|
||||||
|
- Use staged expand/contract strategy when direct cutover is unsafe.
|
||||||
|
- [ ] **C3. Add migration logging checkpoints**
|
||||||
|
- Log start, phase boundaries, completion, and failure details.
|
||||||
|
- [ ] **C4. Verify post-migration schema state**
|
||||||
|
- Confirm expected tables/columns/constraints/indexes are present.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- migration artifacts/scripts for V1 target schema
|
||||||
|
- schema verification checklist outputs
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- baseline-to-target forward migration executes successfully
|
||||||
|
- post-migration checks pass deterministically
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Rollback and Mitigation Strategy
|
||||||
|
|
||||||
|
- [ ] **D1. Define rollback classes per migration**
|
||||||
|
- direct downgrade vs forward-fix vs backup-restore.
|
||||||
|
- [ ] **D2. Create rollback decision tree**
|
||||||
|
- trigger conditions, safe stop points, and recovery path.
|
||||||
|
- [ ] **D3. Align failure classification with `error_handling.md`**
|
||||||
|
- normalize migration failures into canonical categories:
|
||||||
|
- `infrastructure_transient_error`
|
||||||
|
- `infrastructure_persistent_error`
|
||||||
|
- `internal_unexpected_error` (as needed)
|
||||||
|
- [ ] **D4. Rehearse rollback flow**
|
||||||
|
- run at least one migration failure simulation and execute chosen recovery path.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- rollback/mitigation decision tree
|
||||||
|
- rehearsal evidence notes
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- operator can execute rollback/mitigation without undocumented steps
|
||||||
|
- migration failure paths are diagnosable and classified
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — Backfill Decision and Execution (Conditional)
|
||||||
|
|
||||||
|
- [ ] **E1. Determine backfill necessity**
|
||||||
|
- inspect whether existing records violate new invariants.
|
||||||
|
- [ ] **E2. If required, implement idempotent backfill**
|
||||||
|
- resumable, batch-safe, and deterministic update semantics.
|
||||||
|
- [ ] **E3. Add post-backfill verification**
|
||||||
|
- validate:
|
||||||
|
- revision sequencing integrity
|
||||||
|
- accepted/current transcript consistency
|
||||||
|
- job lifecycle consistency
|
||||||
|
- [ ] **E4. If not required, record explicit “no backfill needed” evidence**
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- backfill script(s) and checklist (if applicable)
|
||||||
|
- no-backfill rationale artifact (if not applicable)
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- required backfills completed and verified OR formally ruled out with evidence
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase F — Verification and Test Expansion
|
||||||
|
|
||||||
|
Apply `pytesting` guidance (deterministic, behavior-first, strict markers).
|
||||||
|
|
||||||
|
- [ ] **F1. Migration application tests**
|
||||||
|
- verify forward migration from representative baseline.
|
||||||
|
- [ ] **F2. Post-migration schema contract tests**
|
||||||
|
- verify expected schema shape and key constraints.
|
||||||
|
- [ ] **F3. Rollback/mitigation tests**
|
||||||
|
- verify chosen rollback class behavior where practical.
|
||||||
|
- [ ] **F4. Startup policy regression tests**
|
||||||
|
- confirm production-mode startup does not mutate schema implicitly.
|
||||||
|
- [ ] **F5. Backfill behavior tests (if applicable)**
|
||||||
|
- idempotency and invariants after repeated execution.
|
||||||
|
|
||||||
|
### Validation Commands
|
||||||
|
|
||||||
|
- `uv run pytest --collect-only -q`
|
||||||
|
- `uv run pytest -m unit -q`
|
||||||
|
- `uv run pytest -m "not external" -q`
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- all Step 4 migration-safety checks pass
|
||||||
|
- no REQ-10 regression introduced
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase G — Runbook and Documentation Closure
|
||||||
|
|
||||||
|
- [ ] **G1. Create migration and rollback runbook**
|
||||||
|
- include:
|
||||||
|
- prerequisites
|
||||||
|
- backup step
|
||||||
|
- migration execution
|
||||||
|
- verification
|
||||||
|
- rollback/mitigation
|
||||||
|
- [ ] **G2. Update traceability artifacts**
|
||||||
|
- map Step 4 outcomes to REQ IDs and evidence.
|
||||||
|
- [ ] **G3. Prepare Step 4 handoff artifacts**
|
||||||
|
- ensure outputs feed Step 9 release readiness and Step 10 docs completion.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step4-migration-runbook.md` (recommended)
|
||||||
|
- `docs/ver1/ver1-step4-results.md`
|
||||||
|
- updated traceability references where needed
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- migration operations are executable using docs alone
|
||||||
|
- Step 4 evidence is complete and auditable
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended Implementation Order
|
||||||
|
|
||||||
|
1. Phase A — schema/invariant audit
|
||||||
|
2. Phase B — migration policy and tooling lock
|
||||||
|
3. Phase C — forward migration implementation
|
||||||
|
4. Phase D — rollback/mitigation strategy + rehearsal
|
||||||
|
5. Phase E — backfill decision and execution (conditional)
|
||||||
|
6. Phase F — test and verification expansion
|
||||||
|
7. Phase G — runbook + traceability closure
|
||||||
|
|
||||||
|
This sequence minimizes risk by locking policy and scope before irreversible data changes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk:** Data loss from unsafe schema transitions
|
||||||
|
- **Mitigation:** backup-first gate, staged migration strategies, post-check verification.
|
||||||
|
|
||||||
|
2. **Risk:** Startup policy drift reintroduces implicit schema mutation
|
||||||
|
- **Mitigation:** explicit regression tests for production startup behavior (REQ-10 guard).
|
||||||
|
|
||||||
|
3. **Risk:** Rollback path is incomplete or untested
|
||||||
|
- **Mitigation:** mandatory rollback class declaration + rehearsal evidence.
|
||||||
|
|
||||||
|
4. **Risk:** Backfill scripts cause partial/inconsistent state
|
||||||
|
- **Mitigation:** idempotent design, batching, and invariant-focused verification.
|
||||||
|
|
||||||
|
5. **Risk:** Migration failure diagnostics are unclear
|
||||||
|
- **Mitigation:** structured logging + error category mapping per `error_handling.md`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 4 Completion Checklist
|
||||||
|
|
||||||
|
- [ ] V1 schema audit completed and approved.
|
||||||
|
- [ ] Migration workflow policy is locked and documented.
|
||||||
|
- [ ] Required forward migrations are implemented and validated.
|
||||||
|
- [ ] Rollback/mitigation decision tree is documented and rehearsed.
|
||||||
|
- [ ] Backfill required/not-required decision is evidenced.
|
||||||
|
- [ ] Migration-safety test coverage is added and passing.
|
||||||
|
- [ ] Startup non-mutation policy remains verified in production mode.
|
||||||
|
- [ ] Step 4 runbook and results artifacts are completed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 5
|
||||||
|
|
||||||
|
Step 4 completion enables Step 5 (Private-Network Safety Baseline) with:
|
||||||
|
|
||||||
|
- stable, explicit schema evolution mechanics
|
||||||
|
- reduced upgrade risk for single-operator deployments
|
||||||
|
- migration/rollback procedures suitable for personal-scale production
|
||||||
|
- traceable evidence for release-readiness gates
|
||||||
@@ -0,0 +1,178 @@
|
|||||||
|
# Ver1 Step 5 Results: Private-Network Safety Baseline
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Step 5 implementation status: **complete**.
|
||||||
|
|
||||||
|
This document records completed private-network safety controls, validation evidence, and residual risks for Ver1 Step 5.
|
||||||
|
|
||||||
|
Implemented in this step:
|
||||||
|
|
||||||
|
1. Added private-network security assumptions and control matrix (`docs/ver1/ver1-step5-security-assumptions.md`).
|
||||||
|
2. Implemented optional single-operator access control for `/ui*` and `/api*` via HTTP Basic auth.
|
||||||
|
3. Added upload-size guardrails (`MAX_UPLOAD_BYTES`) and config fail-fast validation for operator credential requirements.
|
||||||
|
4. Hardened unexpected-error user-facing messaging to reduce sensitive detail leakage.
|
||||||
|
5. Added Step 5 tests for access control, security settings, and upload size boundaries.
|
||||||
|
6. Executed dependency/security scans (`pip-audit`, `bandit`) with no critical/high findings.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Implemented Changes
|
||||||
|
|
||||||
|
### 1) Security assumptions and threat model
|
||||||
|
|
||||||
|
Completed.
|
||||||
|
|
||||||
|
- Added `docs/ver1/ver1-step5-security-assumptions.md` defining:
|
||||||
|
- trusted private-network deployment assumptions
|
||||||
|
- single-operator usage model
|
||||||
|
- explicit out-of-scope classes (enterprise IAM, internet-facing zero-trust, multi-tenant controls)
|
||||||
|
- Added Step 5 control/ownership matrix and residual-risk notes.
|
||||||
|
|
||||||
|
### 2) Single-operator access control baseline
|
||||||
|
|
||||||
|
Completed.
|
||||||
|
|
||||||
|
- New module: `src/transcription/security.py`
|
||||||
|
- `is_protected_path(...)` protects `/ui*` and `/api*`
|
||||||
|
- `enforce_request_access(...)` enforces optional operator auth
|
||||||
|
- robust Basic auth parsing and safe denial responses via `AccessDeniedError`
|
||||||
|
- App middleware added in `src/transcription/app.py`:
|
||||||
|
- enforces auth on protected paths
|
||||||
|
- returns consistent `401` envelope and `WWW-Authenticate: Basic` for denied requests
|
||||||
|
- Health endpoint `/healthz` remains intentionally unauthenticated.
|
||||||
|
|
||||||
|
### 3) Input validation and safe-output hardening
|
||||||
|
|
||||||
|
Completed baseline.
|
||||||
|
|
||||||
|
- `src/transcription/services/upload.py`
|
||||||
|
- added size-based validation guard (`max_upload_bytes`)
|
||||||
|
- emits `user_input_error` with actionable guidance on over-limit uploads
|
||||||
|
- `src/transcription/errors.py`
|
||||||
|
- `classify_unexpected_error(...)` now returns operation-only message without embedding raw exception text
|
||||||
|
- preserves traceability via existing `error_id` and taxonomy while reducing accidental sensitive leak risk
|
||||||
|
|
||||||
|
### 4) Secret handling and configuration safety
|
||||||
|
|
||||||
|
Completed baseline.
|
||||||
|
|
||||||
|
- `src/transcription/config.py` additions:
|
||||||
|
- `max_upload_bytes` (default `15 * 1024 * 1024`)
|
||||||
|
- `operator_access_enabled` (default `False`)
|
||||||
|
- `operator_username` (default `operator`)
|
||||||
|
- `operator_password` (optional, required when auth enabled)
|
||||||
|
- Added settings validator enforcing fail-fast config safety:
|
||||||
|
- raises validation error if `OPERATOR_ACCESS_ENABLED=true` and `OPERATOR_PASSWORD` unset
|
||||||
|
- `README.md` updated with Step 5 security env settings and explicit secret-handling guidance.
|
||||||
|
|
||||||
|
### 5) Dependency/security scanning baseline
|
||||||
|
|
||||||
|
Completed.
|
||||||
|
|
||||||
|
- Dependency vulnerability scan:
|
||||||
|
- `uvx pip-audit`
|
||||||
|
- Result: **No known vulnerabilities found**
|
||||||
|
- Static security scan:
|
||||||
|
- `uvx bandit -r src/transcription`
|
||||||
|
- Result: **No issues identified** (0 low/medium/high)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Test and Verification Evidence
|
||||||
|
|
||||||
|
### Added/Updated Tests
|
||||||
|
|
||||||
|
1. `tests/api/test_access_control.py`
|
||||||
|
- unauthorized protected API denied (`401` + challenge)
|
||||||
|
- invalid credentials denied
|
||||||
|
- valid credentials accepted
|
||||||
|
- `/ui` protected when auth enabled
|
||||||
|
- `/healthz` remains unprotected
|
||||||
|
2. `tests/services/test_upload.py`
|
||||||
|
- added rejection test for payloads above `MAX_UPLOAD_BYTES`
|
||||||
|
3. `tests/test_config.py`
|
||||||
|
- added security defaults assertions
|
||||||
|
- added fail-fast assertion for missing `OPERATOR_PASSWORD` when auth enabled
|
||||||
|
4. `tests/test_errors.py`
|
||||||
|
- updated expectations for sanitized unexpected-error message behavior
|
||||||
|
5. Updated integration expectations where failure detail should no longer include raw exception text:
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
- `tests/integration/test_pipeline_flow.py`
|
||||||
|
6. `tests/test_app.py` updated for new middleware wiring.
|
||||||
|
|
||||||
|
### Validation Runs
|
||||||
|
|
||||||
|
Run and record outcomes:
|
||||||
|
|
||||||
|
- `uv run pytest --collect-only -q` -> passed
|
||||||
|
- `uv run pytest -m unit -q` -> passed
|
||||||
|
- `uv run pytest -m "not external" -q` -> passed
|
||||||
|
- `uv run pytest -q` -> passed
|
||||||
|
|
||||||
|
### Security Scan Evidence
|
||||||
|
|
||||||
|
Record scan commands and outcomes:
|
||||||
|
|
||||||
|
- dependency scan command(s): `uvx pip-audit`
|
||||||
|
- static/security lint command(s): `uvx bandit -r src/transcription`
|
||||||
|
- critical/high findings: none
|
||||||
|
- remediation/defer decisions: no remediations required for Step 5 baseline
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirement Traceability (Step 5)
|
||||||
|
|
||||||
|
| Step 5 Area | REQ Coverage | Status | Evidence |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| Private-network and single-operator safety posture | REQ-9 | met | `docs/ver1/ver1-step5-security-assumptions.md`, README security section |
|
||||||
|
| Access control behavior at UI/API boundaries | REQ-5, REQ-7 | met | `src/transcription/security.py`, `src/transcription/app.py`, `tests/api/test_access_control.py` |
|
||||||
|
| Input validation and safe user-facing error behavior | REQ-1, REQ-2, REQ-5 | met | `src/transcription/services/upload.py`, `src/transcription/errors.py`, updated tests |
|
||||||
|
| Config and startup safety controls | REQ-8, REQ-10 | met | `src/transcription/config.py`, `tests/test_config.py`, `README.md` |
|
||||||
|
| Persistence and domain integrity continuity | REQ-11, REQ-12 | met (no regressions) | full test lane pass including integration and worker flows |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operational Artifacts Produced
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step5.md`
|
||||||
|
- `docs/ver1/ver1-step5-results.md`
|
||||||
|
- `docs/ver1/ver1-step5-security-assumptions.md`
|
||||||
|
- `src/transcription/security.py`
|
||||||
|
- `tests/api/test_access_control.py`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks, Exceptions, and Follow-Ups
|
||||||
|
|
||||||
|
1. Basic auth is intentionally right-sized for trusted private-network use; if deployment posture changes, stronger identity controls are required.
|
||||||
|
2. Current model remains single shared operator credential (no per-user audit identity).
|
||||||
|
3. No built-in brute-force/rate-limit controls in Step 5 scope; evaluate in future hardening if threat model expands.
|
||||||
|
|
||||||
|
Open follow-ups to carry forward:
|
||||||
|
|
||||||
|
- Consider stronger auth/session model if system becomes multi-user or internet-accessible.
|
||||||
|
- Consider request throttling/rate limiting if threat model changes.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 5 Exit Assessment
|
||||||
|
|
||||||
|
- Private-network assumptions and controls: **met**
|
||||||
|
- Access-control baseline effectiveness: **met**
|
||||||
|
- Validation and safe-output safety: **met (baseline)**
|
||||||
|
- Secret handling and config safety: **met**
|
||||||
|
- Dependency/security risk closure: **met (no critical/high findings)**
|
||||||
|
- Test and regression safety: **met**
|
||||||
|
|
||||||
|
Step 5 completion status: **complete**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 6
|
||||||
|
|
||||||
|
Once Step 5 is marked complete, Step 6 can proceed with:
|
||||||
|
|
||||||
|
- clearer operational security assumptions for logs/runbooks
|
||||||
|
- hardened boundary behavior for diagnosis and support
|
||||||
|
- reduced risk posture for personal-scale ongoing operations
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
# Ver1 Step 5 Security Assumptions (Private-Network Baseline)
|
||||||
|
|
||||||
|
## Operating Model
|
||||||
|
|
||||||
|
This system is operated as:
|
||||||
|
|
||||||
|
1. single operator
|
||||||
|
2. trusted private network
|
||||||
|
3. non-public deployment (no direct internet exposure for UI/API)
|
||||||
|
|
||||||
|
Out of scope for Step 5:
|
||||||
|
|
||||||
|
- enterprise IAM/SSO/RBAC
|
||||||
|
- internet-facing zero-trust edge controls
|
||||||
|
- multi-tenant user isolation
|
||||||
|
|
||||||
|
## Step 5 Controls and Ownership
|
||||||
|
|
||||||
|
| Control | Boundary Owner | Verification |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Optional operator authentication for `/ui*` and `/api*` routes | `src/transcription/security.py`, `src/transcription/app.py` | `tests/api/test_access_control.py` |
|
||||||
|
| Unauthorized contract (`401` + safe envelope + `WWW-Authenticate`) | `src/transcription/api/errors.py` | `tests/api/test_access_control.py` |
|
||||||
|
| Upload size guard (`MAX_UPLOAD_BYTES`) | `src/transcription/services/upload.py`, `src/transcription/config.py` | `tests/services/test_upload.py` |
|
||||||
|
| Fail-fast auth config when enabled | `src/transcription/config.py` | `tests/test_config.py` |
|
||||||
|
| Safe unexpected error messaging (reduced leak surface) | `src/transcription/errors.py` | `tests/test_errors.py`, worker/integration failure tests |
|
||||||
|
|
||||||
|
## Access-Control Policy (Step 5)
|
||||||
|
|
||||||
|
- Health endpoint (`/healthz`) remains unauthenticated for operability checks.
|
||||||
|
- When `OPERATOR_ACCESS_ENABLED=true`, protected paths require HTTP Basic auth:
|
||||||
|
- `/ui`
|
||||||
|
- `/ui/...`
|
||||||
|
- `/api/...`
|
||||||
|
- Credentials are runtime-configured:
|
||||||
|
- `OPERATOR_USERNAME` (default `operator`)
|
||||||
|
- `OPERATOR_PASSWORD` (required when access is enabled)
|
||||||
|
|
||||||
|
## Secrets Policy
|
||||||
|
|
||||||
|
- Secrets must be provided via runtime environment variables.
|
||||||
|
- Secrets must not be committed to source control.
|
||||||
|
- Secrets must not be logged.
|
||||||
|
- Example secret values in docs must always be placeholders.
|
||||||
|
|
||||||
|
## Residual Risks (Accepted for Step 5)
|
||||||
|
|
||||||
|
1. HTTP Basic credentials are suitable only for trusted private-network deployment.
|
||||||
|
2. No per-user identity model (single shared operator credential).
|
||||||
|
3. No advanced brute-force/rate-limit controls in Step 5 scope.
|
||||||
|
|
||||||
|
These are carried forward for future hardening only if deployment posture changes.
|
||||||
@@ -0,0 +1,459 @@
|
|||||||
|
# Step 5 Implementation Plan: Private-Network Safety Baseline
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Implement **Ver1 Step 5** from `docs/ver1/ver1.md` by applying right-sized security controls for a single-user system running on a trusted private network.
|
||||||
|
|
||||||
|
Step 5 focuses on practical risk reduction without introducing unnecessary complexity, while preserving:
|
||||||
|
|
||||||
|
- personal-scale operational simplicity
|
||||||
|
- single-operator workflow
|
||||||
|
- explicit boundary ownership from `docs/architecture.md`
|
||||||
|
- safety and diagnostics behavior defined in `docs/error_handling.md`
|
||||||
|
|
||||||
|
Primary governing docs:
|
||||||
|
|
||||||
|
- `docs/ver1/ver1.md` (Step 5 objective and sequencing)
|
||||||
|
- `docs/architecture.md` (deployment model and module boundaries)
|
||||||
|
- `docs/error_handling.md` (safe user output and diagnostic boundaries)
|
||||||
|
- `docs/requirements.md` (REQ-1, REQ-2, REQ-5, REQ-7, REQ-8, REQ-9, REQ-10, REQ-11, REQ-12)
|
||||||
|
- `docs/intent.md` (domain integrity priorities)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MCP Resources Reviewed and Applied
|
||||||
|
|
||||||
|
All currently available resources on `john-stream-mcp` were reviewed. Step 5 applies the following guidance directly:
|
||||||
|
|
||||||
|
1. `resource://skills/pydantic-settings/document`
|
||||||
|
- typed security-related runtime settings
|
||||||
|
- explicit env/source precedence
|
||||||
|
- fail-fast handling for missing/invalid required values
|
||||||
|
|
||||||
|
2. `resource://skills/fastapi-uv-docker/document`
|
||||||
|
- environment and deployment safety defaults
|
||||||
|
- startup/health posture and container hygiene assumptions
|
||||||
|
- local secret handling expectations
|
||||||
|
|
||||||
|
3. `resource://skills/pytesting/document`
|
||||||
|
- deterministic security-behavior test lanes
|
||||||
|
- marker discipline and behavior-first assertions
|
||||||
|
|
||||||
|
4. `resource://skills/python-logging-dictconfig/document`
|
||||||
|
- centralized logging discipline
|
||||||
|
- avoid leaking sensitive values in logs
|
||||||
|
|
||||||
|
5. `resource://skills/nicegui-ui-customization/document`
|
||||||
|
- user-safe failure messaging in UI
|
||||||
|
- resilient interaction behavior and clear error feedback
|
||||||
|
|
||||||
|
6. `resource://skills/ruff-linting-formating/document`
|
||||||
|
- keep lint quality baseline stable during safety changes
|
||||||
|
|
||||||
|
Planning methodology input:
|
||||||
|
|
||||||
|
7. `resource://prompts/greenfield-architecture/document`
|
||||||
|
- explicit tradeoff-oriented staging
|
||||||
|
- scope discipline for minimally sufficient security controls
|
||||||
|
|
||||||
|
Reviewed but not directly Step 5 execution-critical:
|
||||||
|
|
||||||
|
- skills: `copilot-customization`, `fastapi-async-sqlalchemy-modernization`, `mcp-details`, `nicegui`, `python-typing`, `vscode-configuration`, `zensical-docs`
|
||||||
|
- prompts: `authoring`, `mcp-consumer-repo-shim`, `pytest-scaffold`, `pytest-fill-scaffold`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Current-State Gap Summary (Step 5 Scope)
|
||||||
|
|
||||||
|
Based on current implementation and prior Step outputs:
|
||||||
|
|
||||||
|
1. **Private-network assumptions are implicit, not fully codified**
|
||||||
|
- Need explicit, documented security posture and operator constraints.
|
||||||
|
|
||||||
|
2. **Access control for UI/API is minimal or absent**
|
||||||
|
- Step 5 requires basic single-operator gating appropriate for private-network use.
|
||||||
|
|
||||||
|
3. **Input validation baseline exists but needs security-oriented audit closure**
|
||||||
|
- Upload and API validation should be verified for abuse-resistant boundaries.
|
||||||
|
|
||||||
|
4. **Safe error output baseline exists (Step 2), but needs security confirmation pass**
|
||||||
|
- Must ensure no sensitive internals leak through API/UI error payloads.
|
||||||
|
|
||||||
|
5. **Secret handling documentation needs formalization in Step 5 artifacts**
|
||||||
|
- Local workflow should clearly prohibit secrets in repo-tracked files and logs.
|
||||||
|
|
||||||
|
6. **Dependency/security scanning is not yet formalized as a recurring gate**
|
||||||
|
- Step 5 requires lightweight scanning and triage of high-risk findings.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope for Step 5
|
||||||
|
|
||||||
|
### In scope
|
||||||
|
|
||||||
|
1. Codify private-network and single-operator security assumptions in docs and config.
|
||||||
|
2. Add basic access control for UI/API actions (right-sized for trusted network model).
|
||||||
|
3. Audit and harden input-validation boundaries (upload, API params/payloads, operational flags).
|
||||||
|
4. Verify safe error surface behavior (UI/API) and prevent sensitive leak paths.
|
||||||
|
5. Formalize local secret handling policy and usage examples.
|
||||||
|
6. Add lightweight dependency/security scan workflow and triage policy.
|
||||||
|
7. Add Step 5 verification tests and results artifact.
|
||||||
|
|
||||||
|
### Out of scope
|
||||||
|
|
||||||
|
- Internet-facing zero-trust security architecture
|
||||||
|
- Enterprise IAM/SSO/role systems
|
||||||
|
- Full cryptographic key-management infrastructure
|
||||||
|
- Major security product integrations beyond lightweight V1 needs
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Target Decisions for Step 5
|
||||||
|
|
||||||
|
1. **Threat model is explicitly private-network + single operator**
|
||||||
|
- Security controls are right-sized to this posture and documented as assumptions.
|
||||||
|
|
||||||
|
2. **Access control is required, even in private network mode**
|
||||||
|
- Basic gate (single shared operator credential/token) protects UI/API mutation paths.
|
||||||
|
|
||||||
|
3. **Validation and output safety are strict defaults**
|
||||||
|
- Reject invalid inputs early; never expose sensitive internals in user-facing outputs.
|
||||||
|
|
||||||
|
4. **Secrets are runtime-only**
|
||||||
|
- No secrets committed to source control; no plaintext secret logging.
|
||||||
|
|
||||||
|
5. **Security scanning is lightweight but mandatory**
|
||||||
|
- Add recurring dependency/security checks with high-risk triage and closure workflow.
|
||||||
|
|
||||||
|
6. **No security control may violate Step 1–4 operational simplicity guardrails**
|
||||||
|
- Preserve deployability and maintainability for personal-scale use.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Detailed Work Breakdown
|
||||||
|
|
||||||
|
## Phase A — Security Posture Definition and Gap Lock
|
||||||
|
|
||||||
|
- [ ] **A1. Define Step 5 threat model**
|
||||||
|
- trusted private network
|
||||||
|
- single operator
|
||||||
|
- local deployment assumptions
|
||||||
|
- explicit out-of-scope threat classes
|
||||||
|
|
||||||
|
- [ ] **A2. Produce security baseline checklist**
|
||||||
|
- access control
|
||||||
|
- validation boundaries
|
||||||
|
- safe error behavior
|
||||||
|
- secret handling
|
||||||
|
- dependency risk checks
|
||||||
|
|
||||||
|
- [ ] **A3. Map controls to architecture boundaries**
|
||||||
|
- UI
|
||||||
|
- API
|
||||||
|
- service
|
||||||
|
- config/runtime
|
||||||
|
- operator runbooks
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step5-security-assumptions.md` (recommended)
|
||||||
|
- Step 5 control matrix (control -> owner -> validation method)
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- private-network safety posture is explicit and approved
|
||||||
|
- each in-scope control has boundary ownership and verification path
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase B — Basic Single-Operator Access Control
|
||||||
|
|
||||||
|
- [ ] **B1. Select access mechanism**
|
||||||
|
- minimal approach suitable for private-network model
|
||||||
|
- explicitly document tradeoffs and operator ergonomics
|
||||||
|
|
||||||
|
- [ ] **B2. Protect mutating operations first**
|
||||||
|
- upload/create/accept/export-trigger endpoints
|
||||||
|
- UI actions that trigger persistence changes
|
||||||
|
|
||||||
|
- [ ] **B3. Protect read operations as policy requires**
|
||||||
|
- determine read-path gating expectations and apply consistently
|
||||||
|
|
||||||
|
- [ ] **B4. Add clear unauthorized behavior contract**
|
||||||
|
- stable API status and safe message
|
||||||
|
- UI feedback with actionable operator guidance
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- access-control policy and implementation notes
|
||||||
|
- unauthorized behavior matrix (UI/API)
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- unauthorized actions are blocked consistently
|
||||||
|
- authorized operator flows remain usable and deterministic
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase C — Input Validation and Safe Output Hardening
|
||||||
|
|
||||||
|
- [ ] **C1. Validation audit for all entry points**
|
||||||
|
- file uploads (type/size/content guards)
|
||||||
|
- route/query/body constraints
|
||||||
|
- service-layer invariants
|
||||||
|
|
||||||
|
- [ ] **C2. Normalize validation failures to canonical taxonomy**
|
||||||
|
- `validation_error` vs `user_input_error` consistency
|
||||||
|
|
||||||
|
- [ ] **C3. Confirm safe error output policy under security lens**
|
||||||
|
- no stack traces/secrets/internal paths in UI/API default outputs
|
||||||
|
- preserve error reference IDs for traceability
|
||||||
|
|
||||||
|
- [ ] **C4. Add abuse-resistant guardrails where practical**
|
||||||
|
- basic request-size and payload-shape constraints
|
||||||
|
- anti-duplication interaction safeguards (where missing)
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- validation-path inventory and hardening checklist
|
||||||
|
- safe-output verification notes
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- input boundaries are deterministic and tested
|
||||||
|
- user-facing error outputs remain safe and actionable
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase D — Secrets Handling and Configuration Safety
|
||||||
|
|
||||||
|
- [ ] **D1. Define secret handling policy**
|
||||||
|
- where secrets are allowed (runtime env only)
|
||||||
|
- where secrets are prohibited (source files, docs examples beyond placeholders)
|
||||||
|
|
||||||
|
- [ ] **D2. Enforce settings expectations**
|
||||||
|
- required secret fields fail fast
|
||||||
|
- avoid fallback defaults that silently weaken safety
|
||||||
|
|
||||||
|
- [ ] **D3. Add operator documentation for local secret workflow**
|
||||||
|
- how to set environment values safely
|
||||||
|
- how to rotate/update credentials locally
|
||||||
|
|
||||||
|
- [ ] **D4. Validate logging does not leak secret values**
|
||||||
|
- startup/config logs
|
||||||
|
- error logs for provider/config failures
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- secret-handling section in runbook/README/docs
|
||||||
|
- settings and logging safety verification notes
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- no secret leakage paths remain in normal operations
|
||||||
|
- operator can configure secrets safely using docs only
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase E — Dependency and Security Scanning Baseline
|
||||||
|
|
||||||
|
- [ ] **E1. Select lightweight scanning commands for V1**
|
||||||
|
- dependency vulnerability scan
|
||||||
|
- optional static security scan if practical
|
||||||
|
|
||||||
|
- [ ] **E2. Define triage policy for findings**
|
||||||
|
- severity classification
|
||||||
|
- required closure criteria for Step 5 completion
|
||||||
|
|
||||||
|
- [ ] **E3. Run scans and capture evidence**
|
||||||
|
- record command outputs/summaries
|
||||||
|
- remediate or formally defer with risk notes
|
||||||
|
|
||||||
|
- [ ] **E4. Add recurring execution guidance**
|
||||||
|
- local pre-release checklist integration
|
||||||
|
- future CI gate handoff for Step 7/9
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- Step 5 scan report artifact (recommended)
|
||||||
|
- triage log of resolved/deferred findings
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- no unresolved critical vulnerabilities in Step 5 scope
|
||||||
|
- high-risk findings are resolved or explicitly risk-accepted with rationale
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase F — Verification and Test Expansion
|
||||||
|
|
||||||
|
Apply `pytesting` guidance (deterministic, behavior-first, strict markers).
|
||||||
|
|
||||||
|
- [ ] **F1. Access-control tests**
|
||||||
|
- unauthorized requests are rejected as expected
|
||||||
|
- authorized operator requests succeed
|
||||||
|
|
||||||
|
- [ ] **F2. Validation and abuse-boundary tests**
|
||||||
|
- invalid payloads rejected with stable category/status
|
||||||
|
- file-type/size constraints enforced
|
||||||
|
|
||||||
|
- [ ] **F3. Safe-output tests**
|
||||||
|
- API/UI error responses avoid sensitive details
|
||||||
|
- error IDs and suggestions remain present
|
||||||
|
|
||||||
|
- [ ] **F4. Config/secret safety tests**
|
||||||
|
- required secrets fail fast when missing
|
||||||
|
- no unsafe fallback behavior introduced
|
||||||
|
|
||||||
|
### Validation Commands
|
||||||
|
|
||||||
|
- `uv run pytest --collect-only -q`
|
||||||
|
- `uv run pytest -m unit -q`
|
||||||
|
- `uv run pytest -m "not external" -q`
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- Step 5 safety behavior is test-covered and passing
|
||||||
|
- no regression in core upload/transcribe/review workflows
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phase G — Documentation and Risk Closure
|
||||||
|
|
||||||
|
- [ ] **G1. Create Step 5 results artifact**
|
||||||
|
- `docs/ver1/ver1-step5-results.md`
|
||||||
|
|
||||||
|
- [ ] **G2. Update operator-facing docs**
|
||||||
|
- security assumptions and local deployment cautions
|
||||||
|
- credential handling and recovery basics
|
||||||
|
|
||||||
|
- [ ] **G3. Update traceability and carry-forward notes**
|
||||||
|
- map Step 5 controls to REQ and evidence
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
|
||||||
|
- `docs/ver1/ver1-step5-results.md`
|
||||||
|
- updated security assumptions checklist and risk summary
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
|
||||||
|
- Step 5 controls and residual risks are fully documented
|
||||||
|
- handoff is ready for Step 6 observability and Step 7 quality gates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended Implementation Order
|
||||||
|
|
||||||
|
1. Phase A — posture definition and gap lock
|
||||||
|
2. Phase B — access control baseline
|
||||||
|
3. Phase C — validation/output hardening
|
||||||
|
4. Phase D — secrets and config safety
|
||||||
|
5. Phase E — dependency/security scan baseline
|
||||||
|
6. Phase F — test expansion and verification
|
||||||
|
7. Phase G — docs and risk closure
|
||||||
|
|
||||||
|
This order reduces risk by locking assumptions first, then applying controls at highest-impact boundaries before final verification and documentation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 5 Execution Checklist (Phase-by-Phase)
|
||||||
|
|
||||||
|
Use this checklist to execute Step 5 in implementation order and record progress/evidence.
|
||||||
|
|
||||||
|
### Phase A — Security Posture Definition and Gap Lock
|
||||||
|
|
||||||
|
- [ ] Publish `docs/ver1/ver1-step5-security-assumptions.md`.
|
||||||
|
- [ ] Record explicit in-scope and out-of-scope threat classes.
|
||||||
|
- [ ] Produce Step 5 control matrix (control, owner, validation method).
|
||||||
|
- [ ] Confirm boundary ownership for each control (UI/API/service/config/docs).
|
||||||
|
|
||||||
|
### Phase B — Basic Single-Operator Access Control
|
||||||
|
|
||||||
|
- [ ] Choose and document access mechanism (with rationale and tradeoffs).
|
||||||
|
- [ ] Implement enforcement for mutating API operations.
|
||||||
|
- [ ] Implement corresponding UI-side access behavior for protected actions.
|
||||||
|
- [ ] Decide and enforce read-path protection policy.
|
||||||
|
- [ ] Add unauthorized API/UI contract tests.
|
||||||
|
|
||||||
|
### Phase C — Input Validation and Safe Output Hardening
|
||||||
|
|
||||||
|
- [ ] Complete input-validation inventory for upload/API/service boundaries.
|
||||||
|
- [ ] Tighten payload/file constraints where gaps are found.
|
||||||
|
- [ ] Ensure validation failure categories match `docs/error_handling.md`.
|
||||||
|
- [ ] Verify user-facing errors remain safe, actionable, and traceable.
|
||||||
|
- [ ] Add regression tests for invalid/boundary inputs.
|
||||||
|
|
||||||
|
### Phase D — Secrets Handling and Configuration Safety
|
||||||
|
|
||||||
|
- [ ] Document secrets policy (runtime-only, no repo storage).
|
||||||
|
- [ ] Verify required secret settings fail fast when missing.
|
||||||
|
- [ ] Audit logs for accidental secret leakage risk paths.
|
||||||
|
- [ ] Update operator docs for local secret setup/rotation workflow.
|
||||||
|
- [ ] Add tests for config safety expectations where practical.
|
||||||
|
|
||||||
|
### Phase E — Dependency and Security Scanning Baseline
|
||||||
|
|
||||||
|
- [ ] Select scanning commands and record tool versions.
|
||||||
|
- [ ] Run baseline scans and capture outputs.
|
||||||
|
- [ ] Triage findings by severity and exploitability in private-network context.
|
||||||
|
- [ ] Resolve/mitigate critical findings; document accepted residual risk.
|
||||||
|
- [ ] Add recurring scan guidance for release workflow handoff.
|
||||||
|
|
||||||
|
### Phase F — Verification and Test Expansion
|
||||||
|
|
||||||
|
- [ ] Run `uv run pytest --collect-only -q`.
|
||||||
|
- [ ] Run `uv run pytest -m unit -q`.
|
||||||
|
- [ ] Run `uv run pytest -m "not external" -q`.
|
||||||
|
- [ ] Run `uv run pytest -q`.
|
||||||
|
- [ ] Confirm no regressions in upload/transcribe/review core flows.
|
||||||
|
|
||||||
|
### Phase G — Documentation and Risk Closure
|
||||||
|
|
||||||
|
- [ ] Complete `docs/ver1/ver1-step5-results.md` with evidence.
|
||||||
|
- [ ] Update docs/README/runbooks with final Step 5 security posture.
|
||||||
|
- [ ] Record REQ traceability updates and residual risks.
|
||||||
|
- [ ] Confirm Step 5 completion checklist items are all closed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Risks and Mitigations
|
||||||
|
|
||||||
|
1. **Risk:** Over-engineering beyond private-network needs
|
||||||
|
- **Mitigation:** enforce Step 5 scope discipline and threat-model constraints.
|
||||||
|
|
||||||
|
2. **Risk:** Access controls disrupt operator usability
|
||||||
|
- **Mitigation:** keep mechanism minimal and test primary workflows thoroughly.
|
||||||
|
|
||||||
|
3. **Risk:** Sensitive details leak through errors/logging
|
||||||
|
- **Mitigation:** apply safe-output and log-sanitization checks with tests.
|
||||||
|
|
||||||
|
4. **Risk:** Unpatched dependency vulnerabilities remain invisible
|
||||||
|
- **Mitigation:** formalize scan + triage + evidence capture workflow.
|
||||||
|
|
||||||
|
5. **Risk:** Secret handling remains ad hoc
|
||||||
|
- **Mitigation:** fail-fast settings + explicit operator documentation + review checks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Step 5 Completion Checklist
|
||||||
|
|
||||||
|
- [ ] Private-network and single-operator security assumptions are documented.
|
||||||
|
- [ ] Basic single-operator access control is implemented and verified.
|
||||||
|
- [ ] Input-validation boundaries are audited, hardened, and test-covered.
|
||||||
|
- [ ] UI/API error output safety is confirmed under security tests.
|
||||||
|
- [ ] Secret handling policy and local workflow docs are complete.
|
||||||
|
- [ ] Dependency/security scans are run; critical findings are resolved.
|
||||||
|
- [ ] Step 5 tests pass across all validation lanes.
|
||||||
|
- [ ] `docs/ver1/ver1-step5-results.md` is completed with evidence and residual risks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Handoff to Step 6
|
||||||
|
|
||||||
|
Step 5 completion enables Step 6 (Minimal Observability & Operability) with:
|
||||||
|
|
||||||
|
- explicit security assumptions for operator context
|
||||||
|
- access and validation controls suitable for private-network operation
|
||||||
|
- safer runtime/configuration handling for ongoing operations
|
||||||
|
- dependency-risk visibility feeding release-readiness gates
|
||||||
@@ -0,0 +1,206 @@
|
|||||||
|
## Step 6 Goal (from `docs/ver1/ver1.md`)
|
||||||
|
Implement **minimal observability & operability** so a single operator can quickly diagnose and recover from common failures.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1) Current-State Assessment (what already exists)
|
||||||
|
|
||||||
|
### Already in place
|
||||||
|
- Central startup logging initialization via `setup_logging()` and `dictConfig` (`src/transcription/config.py`, `src/transcription/app.py`).
|
||||||
|
- Error taxonomy and `error_id` envelope contract (`src/transcription/errors.py`) aligned with `docs/error_handling.md`.
|
||||||
|
- Error handling for API and worker includes category + error IDs in some paths (`src/transcription/api/errors.py`, `src/transcription/worker.py`).
|
||||||
|
- Basic health endpoint `/healthz` (`src/transcription/api/health.py`).
|
||||||
|
- UI error display already shows actionable message + error reference (`src/transcription/ui/error_presenter.py`).
|
||||||
|
|
||||||
|
### Gaps to close for Step 6
|
||||||
|
1. **Structured logging is inconsistent** (many logs are free-form text with embedded key/value; no enforced schema).
|
||||||
|
2. **Boundary coverage is incomplete** (UI/service/API/worker don’t all emit consistent operation logs).
|
||||||
|
3. `/healthz` is very basic; no lightweight readiness/startup diagnostics endpoint/reporting.
|
||||||
|
4. No concise **operator runbook** yet (start/stop, log interpretation, recovery playbooks).
|
||||||
|
5. Minimal counters/timings are not yet standardized.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2) MCP Guidance Incorporated (relevant items)
|
||||||
|
|
||||||
|
From `john-stream-mcp`, these are directly applied:
|
||||||
|
|
||||||
|
- **`python-logging-dictconfig`**: keep one centralized `dictConfig`, configure once at startup, named loggers in modules.
|
||||||
|
- **`fastapi-async-sqlalchemy-modernization`**: include observability + health/readiness checks; explicit lifecycle and deterministic startup/shutdown checks.
|
||||||
|
- **`fastapi-uv-docker`**: keep `/healthz`; add practical readiness/ops checks for deployment clarity.
|
||||||
|
- **`pytesting`**: deterministic tests, concise structure, validation lanes (`collect-only`, `unit`, `not external`, full).
|
||||||
|
- **`pydantic-settings`**: keep typed settings as single source for logging/health behavior flags.
|
||||||
|
- **`nicegui` + `nicegui-ui-customization`**: preserve clear, actionable user-facing error feedback and non-blocking UI flows.
|
||||||
|
- **`zensical-docs`**: produce focused, navigable operator docs.
|
||||||
|
|
||||||
|
(Other MCP resources were reviewed but are not core to Step 6 implementation scope.)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3) Detailed Implementation Plan for Step 6
|
||||||
|
|
||||||
|
## Workstream A — Structured Logging Contract
|
||||||
|
|
||||||
|
### A1. Define a canonical log event schema
|
||||||
|
Create a project log schema (doc + code-level constants) with required keys:
|
||||||
|
- `timestamp` (UTC)
|
||||||
|
- `level`
|
||||||
|
- `logger`
|
||||||
|
- `operation`
|
||||||
|
- `event`
|
||||||
|
- `error_id` (when error)
|
||||||
|
- `category` (when error)
|
||||||
|
- `exception_type` (when error)
|
||||||
|
- `job_id`, `document_id` (when relevant)
|
||||||
|
- optional: `duration_ms`, `retry_count`, `status`
|
||||||
|
|
||||||
|
### A2. Standardize log emission helpers
|
||||||
|
Add small logging helpers (or adapter utilities) to reduce drift:
|
||||||
|
- `log_operation_start(...)`
|
||||||
|
- `log_operation_success(...)`
|
||||||
|
- `log_operation_error(...)`
|
||||||
|
|
||||||
|
Keep this minimal and avoid heavy observability frameworks.
|
||||||
|
|
||||||
|
### A3. Update formatter to structured output
|
||||||
|
Use `dictConfig` to emit either:
|
||||||
|
- JSON lines (preferred for structure), or
|
||||||
|
- strict key-value line format with fixed fields.
|
||||||
|
|
||||||
|
**Recommendation:** JSON lines to satisfy “structured logging” unambiguously while still simple.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream B — Boundary-by-Boundary Instrumentation
|
||||||
|
|
||||||
|
### B1. API boundary (`src/transcription/api/*`)
|
||||||
|
- Add request-level operation logs for key routes (`upload.submit`, `jobs.list`, `jobs.get`, etc.).
|
||||||
|
- Ensure API exception handler logs always include `error_id`, `category`, `operation`, `exception_type`.
|
||||||
|
|
||||||
|
### B2. Service boundary (`src/transcription/services/*`)
|
||||||
|
- Add operation logs around:
|
||||||
|
- upload validation/persist,
|
||||||
|
- transcription orchestration,
|
||||||
|
- revision add/accept,
|
||||||
|
- search/export.
|
||||||
|
- Add timing (`duration_ms`) for high-value operations only.
|
||||||
|
|
||||||
|
### B3. Worker boundary (`src/transcription/worker.py`)
|
||||||
|
- Standardize all worker log events to schema.
|
||||||
|
- Ensure retry logs include: `retriable`, `retry_count`, `max_retries`, `backoff_seconds`.
|
||||||
|
- Ensure terminal failure logs include error contract fields.
|
||||||
|
|
||||||
|
### B4. UI boundary (`src/transcription/ui/*`)
|
||||||
|
- Keep user-safe UI messages as-is.
|
||||||
|
- Add backend/UI logger events for user-triggered failures (operation + error_id + category) so UI-visible errors correlate to server logs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream C — Health, Readiness, Startup Operability
|
||||||
|
|
||||||
|
### C1. Keep `/healthz` lightweight
|
||||||
|
- Return “process is running” status quickly.
|
||||||
|
|
||||||
|
### C2. Add lightweight `/readyz`
|
||||||
|
Include small checks:
|
||||||
|
- DB connectivity ping.
|
||||||
|
- Worker thread alive check.
|
||||||
|
- Optional prompt directory existence check.
|
||||||
|
|
||||||
|
Return structured status payload with per-check pass/fail.
|
||||||
|
|
||||||
|
### C3. Startup self-check summary log
|
||||||
|
At startup, emit one concise ops summary event:
|
||||||
|
- environment
|
||||||
|
- schema validation result
|
||||||
|
- worker started
|
||||||
|
- directories checked
|
||||||
|
- bootstrap/migration mode flags
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream D — Minimal Counters & Timings
|
||||||
|
|
||||||
|
Add only high-value diagnostics:
|
||||||
|
1. `worker_jobs_processed_total`
|
||||||
|
2. `worker_jobs_failed_total`
|
||||||
|
3. `worker_retries_total`
|
||||||
|
4. `transcription_duration_ms` (per job)
|
||||||
|
5. `upload_persist_duration_ms` (per upload path)
|
||||||
|
|
||||||
|
Implementation can be log-derived counters (no external metrics backend required).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream E — Operator Runbook
|
||||||
|
|
||||||
|
Create concise runbook doc (recommended: `docs/ver1/ver1-step6-operator-runbook.md`) with:
|
||||||
|
|
||||||
|
1. **Start/Stop**
|
||||||
|
- local `uv` run mode
|
||||||
|
- docker compose mode (if applicable)
|
||||||
|
|
||||||
|
2. **Where logs are**
|
||||||
|
- stdout, docker logs commands, filtering by `error_id` / `operation`.
|
||||||
|
|
||||||
|
3. **Common failure patterns → recovery**
|
||||||
|
- provider timeout
|
||||||
|
- auth denied
|
||||||
|
- missing prompt dir
|
||||||
|
- DB unavailable
|
||||||
|
- job stuck/failed with retry exhausted
|
||||||
|
|
||||||
|
4. **Recovery procedures**
|
||||||
|
- restart sequence
|
||||||
|
- verify health/readiness
|
||||||
|
- when to requeue/re-upload
|
||||||
|
|
||||||
|
5. **Escalation artifacts**
|
||||||
|
- capture timestamp + error_id + operation + job_id/document_id
|
||||||
|
|
||||||
|
Also update `README.md` with short links to the runbook.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Workstream F — Verification & Quality Gates
|
||||||
|
|
||||||
|
### Tests to add/update
|
||||||
|
- `tests/api/test_health.py`
|
||||||
|
- `/healthz` baseline
|
||||||
|
- `/readyz` pass/fail behavior
|
||||||
|
- `tests/api/test_error_responses.py` / `tests/api/test_routes.py`
|
||||||
|
- logs include `error_id/category/operation` on failures
|
||||||
|
- `tests/services/test_worker.py`
|
||||||
|
- retry/failure log fields + timing presence
|
||||||
|
- `tests/ui/*`
|
||||||
|
- ensure UI error correlation path includes operation/ref id behavior
|
||||||
|
|
||||||
|
### Validation commands (per MCP pytest guidance)
|
||||||
|
- `uv run pytest --collect-only -q`
|
||||||
|
- `uv run pytest -m unit -q`
|
||||||
|
- `uv run pytest -m "not external" -q`
|
||||||
|
- `uv run pytest -q`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4) Traceability to Governing Docs
|
||||||
|
|
||||||
|
- **`docs/ver1/ver1.md` Step 6:** all 5 implementation bullets covered.
|
||||||
|
- **`docs/error_handling.md`:** logging contract fields and error taxonomy continuity enforced.
|
||||||
|
- **`docs/architecture.md`:** respects modular boundaries, in-process worker model, low-complexity ops.
|
||||||
|
- **`docs/requirements.md`:**
|
||||||
|
- REQ-8 (startup logging/config centralization) strengthened,
|
||||||
|
- REQ-5 (status visibility) improved operationally,
|
||||||
|
- REQ-7 lifecycle ownership observability improved.
|
||||||
|
- **`docs/intent.md`:** keeps operation simple for personal-scale archival workflow.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5) Suggested Execution Order (low risk)
|
||||||
|
|
||||||
|
1. Logging schema + formatter + helpers
|
||||||
|
2. Worker/API instrumentation (highest value)
|
||||||
|
3. Service/UI instrumentation
|
||||||
|
4. `/readyz` + startup summary check
|
||||||
|
5. Runbook + README links
|
||||||
|
6. Tests + Step 6 results artifact (`docs/ver1/ver1-step6-results.md`)
|
||||||
@@ -0,0 +1,322 @@
|
|||||||
|
# Version 1 Implementation Plan
|
||||||
|
|
||||||
|
This plan defines the path from MVP to **Version 1 complete**.
|
||||||
|
The objective is to deliver the full scoped product with readiness for reliable personal-scale operation, while explicitly separating refinements/enhancements into a future document.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 0) Plan Governance & Scope Control (Foundation)
|
||||||
|
|
||||||
|
**Goal:** Keep execution focused on V1 completion and avoid unnecessary process overhead.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Create and maintain a **V1 Traceability Matrix**:
|
||||||
|
- Requirement ID
|
||||||
|
- Current status (`done`, `partial`, `not started`)
|
||||||
|
- Validation method
|
||||||
|
2. Define V1 completion gates:
|
||||||
|
- Functional complete
|
||||||
|
- Operationally complete
|
||||||
|
- Personal-deployment ready
|
||||||
|
3. Snapshot the MVP baseline (tag/changelog reference).
|
||||||
|
4. Keep a standing rule: non-V1 ideas go to a separate enhancements backlog, and enter V1 only by explicit approval.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- `docs/ver1/ver1.md` (this plan)
|
||||||
|
- V1 traceability artifact:
|
||||||
|
- `docs/ver1/ver1-step1-2-carry-forward-checklist.md`
|
||||||
|
- `docs/ver1/ver1-step2-error-path-inventory.md` (supporting artifact)
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Every in-scope requirement has explicit status and validation evidence.
|
||||||
|
- Scope-change discipline is followed consistently.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1) Architecture Consolidation
|
||||||
|
|
||||||
|
**Goal:** Align implementation with intended architecture while preserving simplicity.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Compare implemented modules/components with architecture documentation.
|
||||||
|
2. Identify and classify architectural debt:
|
||||||
|
- Temporary coupling
|
||||||
|
- Missing interfaces
|
||||||
|
- Placeholder services/components
|
||||||
|
3. Resolve architecture gaps that threaten reliability, maintainability, or clear boundaries.
|
||||||
|
4. Record material decisions and tradeoffs in ADRs.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Updated architecture diagrams and boundaries
|
||||||
|
- ADR entries for material decisions
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Architecture documentation reflects system reality.
|
||||||
|
- High-impact architecture risks are addressed or explicitly scheduled.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2) Error Handling & Reliability Hardening
|
||||||
|
|
||||||
|
**Goal:** Ensure predictable, diagnosable behavior under expected failure conditions.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Apply the canonical taxonomy and response model from `docs/error_handling.md` across UI/API/service/worker boundaries.
|
||||||
|
2. Ensure clear distinction between:
|
||||||
|
- User-facing safe messages
|
||||||
|
- Internal diagnostic detail
|
||||||
|
- Retryable vs non-retryable failures
|
||||||
|
3. Implement practical resilience controls where needed:
|
||||||
|
- Timeouts
|
||||||
|
- Bounded retries with backoff
|
||||||
|
- Explicit terminal failure states
|
||||||
|
4. Add failure-path tests for critical workflows.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Error handling reference aligned with `docs/error_handling.md`
|
||||||
|
- Failure-mode test coverage for critical paths
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Error behavior is consistent across major flows.
|
||||||
|
- Known failure scenarios are tested and pass.
|
||||||
|
- Failed jobs include actionable, traceable failure detail.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3) Functional Completion by Requirement Domain
|
||||||
|
|
||||||
|
**Goal:** Complete all V1 requirements in a practical, user-first order.
|
||||||
|
|
||||||
|
### Recommended Order
|
||||||
|
1. End-user core flows (upload → transcribe → review)
|
||||||
|
2. Data integrity and persistence behavior
|
||||||
|
3. Minimal operator controls needed for personal use
|
||||||
|
4. In-scope UX quality improvements
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
For each requirement slice:
|
||||||
|
1. Confirm contract/schema
|
||||||
|
2. Implement service/domain logic
|
||||||
|
3. Implement persistence/state transitions
|
||||||
|
4. Integrate API/UI behavior
|
||||||
|
5. Add or update automated tests
|
||||||
|
6. Update relevant docs
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Requirement completion report with validation evidence linked to REQ IDs
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- All V1 must-have requirements are complete and verified.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4) Data Model and Migration Safety
|
||||||
|
|
||||||
|
**Goal:** Keep schema evolution safe and simple for personal-scale deployment.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Validate schema against finalized V1 domain needs.
|
||||||
|
2. Implement forward-safe migrations for expected upgrades.
|
||||||
|
3. Define a simple rollback/mitigation path for migration failures.
|
||||||
|
4. Add backfill scripts only where truly required.
|
||||||
|
5. Rehearse migration + rollback locally using representative sample data.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Migration and rollback runbook
|
||||||
|
- Backfill checklist (if applicable)
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Migration path is tested and documented.
|
||||||
|
- No unresolved data-loss risk for V1 upgrade.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5) Private-Network Safety Baseline
|
||||||
|
|
||||||
|
**Goal:** Apply right-sized security controls for a single-user system on a trusted private network.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Enforce private-network deployment assumptions in docs and configuration.
|
||||||
|
2. Ensure basic single-operator access control for UI/API actions.
|
||||||
|
3. Enforce input validation and safe error output behavior.
|
||||||
|
4. Keep secrets out of source control; document local secret handling.
|
||||||
|
5. Run lightweight dependency/security scanning and resolve high-risk findings.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Security assumptions checklist (private network, single operator)
|
||||||
|
- Basic risk update for V1 scope
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- No unresolved critical vulnerabilities.
|
||||||
|
- Access behavior and validation rules are verified for intended operating model.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6) Minimal Observability & Operability
|
||||||
|
|
||||||
|
**Goal:** Keep operation and troubleshooting simple, clear, and reliable.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Standardize structured logging across UI/API/service/worker boundaries.
|
||||||
|
2. Ensure logged errors include category and error reference IDs per `error_handling.md`.
|
||||||
|
3. Add lightweight health/startup checks.
|
||||||
|
4. Document a concise operator runbook:
|
||||||
|
- start/stop
|
||||||
|
- log locations
|
||||||
|
- common failure patterns and recovery steps
|
||||||
|
5. Add minimal counters/timings only where they clearly improve diagnosis.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Logging and error-traceability baseline
|
||||||
|
- Operator runbook
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Operator can diagnose common failures using logs + runbook.
|
||||||
|
- System recovery procedures are documented and repeatable.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7) Test Coverage and Practical Quality Gates
|
||||||
|
|
||||||
|
**Goal:** Prevent regressions in critical flows without overbuilding test infrastructure.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Expand unit and integration tests for all V1 requirement slices.
|
||||||
|
2. Add end-to-end tests for critical journeys:
|
||||||
|
- upload
|
||||||
|
- process/transcribe
|
||||||
|
- view result
|
||||||
|
- failure visibility
|
||||||
|
3. Add targeted contract tests where adapter boundaries are error-prone.
|
||||||
|
4. Keep CI gates focused on high-value checks (tests, lint, type checks, dependency scan).
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- V1 test matrix mapped to requirements and critical flows
|
||||||
|
- CI quality-gate checklist
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Critical-path regressions are automatically detected.
|
||||||
|
- Test suite gives consistent release confidence for personal-scale operation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8) Performance Validation for Personal Scale
|
||||||
|
|
||||||
|
**Goal:** Confirm acceptable responsiveness for expected personal-use workload.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Define practical performance expectations for key flows.
|
||||||
|
2. Run representative tests using real document samples.
|
||||||
|
3. Address obvious bottlenecks in queries, file handling, or worker concurrency.
|
||||||
|
4. Document known limits and expected operating bounds.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Short performance validation note
|
||||||
|
- Known-limits summary
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Core flows remain responsive for expected corpus size and usage patterns.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9) Release Readiness and Environment Simplicity
|
||||||
|
|
||||||
|
**Goal:** Make deployment and rollback repeatable for a single-operator Docker Compose setup.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Define a simple release checklist:
|
||||||
|
- run tests
|
||||||
|
- run one end-to-end transcription check
|
||||||
|
- verify migration compatibility
|
||||||
|
2. Document environment configuration requirements clearly.
|
||||||
|
3. Validate deployment and rollback steps in a local rehearsal.
|
||||||
|
4. Add backup/restore verification for core persisted data.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Release checklist
|
||||||
|
- Environment and rollback guide
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Deployment/rollback is rehearsed and documented.
|
||||||
|
- Operator can release safely without hidden steps.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 10) Documentation Completion
|
||||||
|
|
||||||
|
**Goal:** Ensure V1 can be built, operated, and supported from documentation.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Update core project docs to match final V1 behavior:
|
||||||
|
- Architecture
|
||||||
|
- Error handling
|
||||||
|
- Requirements status
|
||||||
|
- Index/navigation
|
||||||
|
- Intent alignment summary
|
||||||
|
2. Add operator troubleshooting guides.
|
||||||
|
3. Add integration/API examples for the operator and future maintainers.
|
||||||
|
4. Publish changelog/version notes for V1.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Updated documentation set for V1
|
||||||
|
- V1 release notes
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- A future maintainer can run and support the system using docs alone.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 11) Final Validation and Launch
|
||||||
|
|
||||||
|
**Goal:** Confirm V1 readiness and launch with low operational risk.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Run end-to-end acceptance validation against the V1 traceability matrix.
|
||||||
|
2. Complete operator acceptance checks on representative real documents.
|
||||||
|
3. Execute launch checklist (including backup, migration, and rollback readiness).
|
||||||
|
4. Launch and monitor logs/status closely during initial use.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Acceptance validation record
|
||||||
|
- Launch checklist completion record
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- V1 requirements are validated.
|
||||||
|
- Initial launch behavior is stable and recoverable.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 12) Post-Launch Stabilization
|
||||||
|
|
||||||
|
**Goal:** Address early issues quickly and lock in a reliable V1 baseline.
|
||||||
|
|
||||||
|
### Implementation Steps
|
||||||
|
1. Track defects and operational pain points observed after launch.
|
||||||
|
2. Prioritize short-cycle stabilization fixes.
|
||||||
|
3. Remove temporary launch-only workarounds when safe.
|
||||||
|
4. Capture a brief retrospective and update the next-phase backlog.
|
||||||
|
|
||||||
|
### Deliverables
|
||||||
|
- Stabilization summary
|
||||||
|
- Updated backlog for post-V1 enhancements
|
||||||
|
|
||||||
|
### Exit Criteria
|
||||||
|
- Major launch issues are resolved.
|
||||||
|
- System transitions to steady personal-use operation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended Execution Rhythm
|
||||||
|
|
||||||
|
- **Weekly:** Requirement closure + risk review
|
||||||
|
- **As needed (small batch releases):** Run release checklist and deploy
|
||||||
|
- **Milestone check-ins:** After phases 2, 6, 9, and 11
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope Discipline Rule (V1 Focus)
|
||||||
|
|
||||||
|
To preserve delivery focus:
|
||||||
|
- V1 execution prioritizes completion of scoped requirements.
|
||||||
|
- Refinements/enhancements are captured in a separate future document and backlog.
|
||||||
|
- Only explicitly approved scope changes may enter this plan.
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
# AI Coding Assistant Project Briefing & Context
|
|
||||||
|
|
||||||
## Project Mission
|
|
||||||
This application is a family history archival and transcription platform. Its primary goal is to accept scanned document images (letters, postcards, logbooks, diaries), execute OCR and structured transcription via AI vision models (OpenAI GPT-4o, Anthropic Claude 3.5 Sonnet), and manage historical metadata (authors, recipients, dates, and locations).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Technical Stack & Architecture
|
|
||||||
* **Database:** PostgreSQL 13+ with native `UUID` (`gen_random_uuid()`) and `JSONB` columns.
|
|
||||||
* **Backend Runtime / Concurrency:** Python utilizing `asyncio` for concurrent HTTP API calls to AI providers, with strict rate-limiting via `asyncio.Semaphore`.
|
|
||||||
* **Validation & Types:** Python with **Pydantic** model definitions. Incoming AI responses must be parsed and validated with Pydantic models *before* database insertion.
|
|
||||||
* **ORM / Database Access:** SQLModel and SQLAlchemy, using parameterized statements and PostgreSQL-native types.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core System Directives for AI Code Generation
|
|
||||||
|
|
||||||
### 1. Data Immutability vs. Human Corrections
|
|
||||||
* `job_source.raw_transcription` and `source.raw_transcription` represent original, point-in-time machine outputs and are **immutable**.
|
|
||||||
* Human corrections occur on `source.revised_text`.
|
|
||||||
* When fetching text for the UI, always display `COALESCE(source.revised_text, source.raw_transcription)`.
|
|
||||||
|
|
||||||
### 2. Async Execution & Batching Rules
|
|
||||||
* A `job` represents an overarching execution run for a folder/group of images belonging to a single `document`.
|
|
||||||
* Images are submitted to AI APIs **one at a time in rapid succession** using `asyncio` worker pools.
|
|
||||||
* Each single-image API call populates a row in `job_source` with its own `status`, `raw_transcription`, `ai_metadata`, and `raw_api_response`.
|
|
||||||
* If 9 of 10 pages succeed and 1 fails, `job_source.status` for the failed image becomes `'failed'`, while `job.status` becomes `'partial_success'`. Do not mark the entire batch as failed if partial results exist.
|
|
||||||
|
|
||||||
### 3. Entity Relationships
|
|
||||||
* **Authors/Recipients:** A `document` can have multiple authors and recipients. Do NOT put direct `author_id` foreign keys on `document`. Query authors/recipients via `document_person` where `role = 'author'` or `role = 'recipient'`.
|
|
||||||
* **Page Ordering:** Multi-page documents must always be queried using `ORDER BY page_number ASC`.
|
|
||||||
|
|
||||||
### 4. Database Mutations
|
|
||||||
* Always use parameterized SQL queries (`$1`, `$2`) to prevent SQL injection.
|
|
||||||
* Store datetimes using UTC ISO 8601 strings or native PostgreSQL `TIMESTAMPTZ`.
|
|
||||||
@@ -1,416 +0,0 @@
|
|||||||
# SQLModel Table Models
|
|
||||||
|
|
||||||
These models implement the canonical [Version 2 database schema](../schema_v2.md). Each schema entity is represented by exactly one `SQLModel` table class. Because `SQLModel` is built on Pydantic and SQLAlchemy, these classes provide application validation and PostgreSQL mappings without parallel row and create models.
|
|
||||||
|
|
||||||
Database-generated UUIDs and timestamps are `None` until PostgreSQL supplies their values during insert. The database columns remain non-nullable. `Person.metadata_` maps to the `metadata` column because `metadata` is reserved by SQLAlchemy's declarative API.
|
|
||||||
|
|
||||||
```python
|
|
||||||
from datetime import date
|
|
||||||
from datetime import datetime
|
|
||||||
from enum import StrEnum
|
|
||||||
from uuid import UUID
|
|
||||||
|
|
||||||
from pydantic import JsonValue
|
|
||||||
from sqlalchemy import Column
|
|
||||||
from sqlalchemy import Date
|
|
||||||
from sqlalchemy import DateTime
|
|
||||||
from sqlalchemy import ForeignKey
|
|
||||||
from sqlalchemy import Index
|
|
||||||
from sqlalchemy import Integer
|
|
||||||
from sqlalchemy import String
|
|
||||||
from sqlalchemy import Text
|
|
||||||
from sqlalchemy import UniqueConstraint
|
|
||||||
from sqlalchemy import text
|
|
||||||
from sqlalchemy.dialects.postgresql import JSONB
|
|
||||||
from sqlalchemy.dialects.postgresql import UUID as PostgreSQLUUID
|
|
||||||
from sqlmodel import Field
|
|
||||||
from sqlmodel import Relationship
|
|
||||||
from sqlmodel import SQLModel
|
|
||||||
|
|
||||||
|
|
||||||
class PersonRole(StrEnum):
|
|
||||||
AUTHOR = "author"
|
|
||||||
RECIPIENT = "recipient"
|
|
||||||
|
|
||||||
|
|
||||||
class JobStatus(StrEnum):
|
|
||||||
QUEUED = "queued"
|
|
||||||
PROCESSING = "processing"
|
|
||||||
COMPLETED = "completed"
|
|
||||||
PARTIAL_SUCCESS = "partial_success"
|
|
||||||
FAILED = "failed"
|
|
||||||
|
|
||||||
|
|
||||||
class JobSourceStatus(StrEnum):
|
|
||||||
PENDING = "pending"
|
|
||||||
TRANSCRIBED = "transcribed"
|
|
||||||
FAILED = "failed"
|
|
||||||
|
|
||||||
|
|
||||||
class Person(SQLModel, table=True):
|
|
||||||
__tablename__ = "person"
|
|
||||||
__table_args__ = (Index("idx_person_full_name", "full_name"),)
|
|
||||||
|
|
||||||
id: UUID | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
primary_key=True,
|
|
||||||
server_default=text("gen_random_uuid()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
full_name: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
display_name: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
maiden_name: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
birth_date: date | None = Field(default=None, sa_column=Column(Date))
|
|
||||||
birth_date_raw: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
birth_place: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
death_date: date | None = Field(default=None, sa_column=Column(Date))
|
|
||||||
death_date_raw: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
death_place: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
biography: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
portrait_path: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
metadata_: JsonValue | None = Field(
|
|
||||||
default_factory=dict,
|
|
||||||
sa_column=Column(
|
|
||||||
"metadata",
|
|
||||||
JSONB,
|
|
||||||
server_default=text("'{}'::jsonb"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
created_at: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
updated_at: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
document_people: list["DocumentPerson"] = Relationship(
|
|
||||||
back_populates="person",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise", "passive_deletes": True},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Document(SQLModel, table=True):
|
|
||||||
__tablename__ = "document"
|
|
||||||
__table_args__ = (Index("idx_document_date", "document_date"),)
|
|
||||||
|
|
||||||
id: UUID | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
primary_key=True,
|
|
||||||
server_default=text("gen_random_uuid()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
name: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
document_type: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
document_date: date | None = Field(default=None, sa_column=Column(Date))
|
|
||||||
document_date_raw: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
location_created: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
notes: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
archive_identifier: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
created_at: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
updated_at: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
document_people: list["DocumentPerson"] = Relationship(
|
|
||||||
back_populates="document",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise", "passive_deletes": True},
|
|
||||||
)
|
|
||||||
jobs: list["Job"] = Relationship(
|
|
||||||
back_populates="document",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise", "passive_deletes": True},
|
|
||||||
)
|
|
||||||
sources: list["Source"] = Relationship(
|
|
||||||
back_populates="document",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise", "passive_deletes": True},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentPerson(SQLModel, table=True):
|
|
||||||
__tablename__ = "document_person"
|
|
||||||
__table_args__ = (
|
|
||||||
UniqueConstraint(
|
|
||||||
"document_id",
|
|
||||||
"person_id",
|
|
||||||
"role",
|
|
||||||
name="unique_document_person_role",
|
|
||||||
),
|
|
||||||
Index("idx_document_person_doc", "document_id"),
|
|
||||||
Index("idx_document_person_per", "person_id"),
|
|
||||||
)
|
|
||||||
|
|
||||||
id: UUID | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
primary_key=True,
|
|
||||||
server_default=text("gen_random_uuid()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
document_id: UUID = Field(
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
ForeignKey("document.id", ondelete="CASCADE"),
|
|
||||||
nullable=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
person_id: UUID = Field(
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
ForeignKey("person.id", ondelete="CASCADE"),
|
|
||||||
nullable=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
role: PersonRole = Field(sa_column=Column(String(20), nullable=False))
|
|
||||||
created_at: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
document: Document | None = Relationship(
|
|
||||||
back_populates="document_people",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise"},
|
|
||||||
)
|
|
||||||
person: Person | None = Relationship(
|
|
||||||
back_populates="document_people",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise"},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Job(SQLModel, table=True):
|
|
||||||
__tablename__ = "job"
|
|
||||||
__table_args__ = (Index("idx_job_document", "document_id"),)
|
|
||||||
|
|
||||||
id: UUID | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
primary_key=True,
|
|
||||||
server_default=text("gen_random_uuid()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
document_id: UUID = Field(
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
ForeignKey("document.id", ondelete="CASCADE"),
|
|
||||||
nullable=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
status: JobStatus = Field(
|
|
||||||
default=JobStatus.QUEUED,
|
|
||||||
sa_column=Column(
|
|
||||||
String(50),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("'queued'"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
retry_count: int = Field(
|
|
||||||
default=0,
|
|
||||||
sa_column=Column(
|
|
||||||
Integer,
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("0"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
provider: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
model: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
prompt_name: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
date_created: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
date_updated: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
document: Document | None = Relationship(
|
|
||||||
back_populates="jobs",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise"},
|
|
||||||
)
|
|
||||||
job_sources: list["JobSource"] = Relationship(
|
|
||||||
back_populates="job",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise", "passive_deletes": True},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Source(SQLModel, table=True):
|
|
||||||
__tablename__ = "source"
|
|
||||||
__table_args__ = (
|
|
||||||
Index("idx_source_document", "document_id"),
|
|
||||||
Index("idx_source_page_order", "document_id", "page_number"),
|
|
||||||
)
|
|
||||||
|
|
||||||
id: UUID | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
primary_key=True,
|
|
||||||
server_default=text("gen_random_uuid()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
document_id: UUID = Field(
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
ForeignKey("document.id", ondelete="CASCADE"),
|
|
||||||
nullable=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
page_number: int = Field(
|
|
||||||
default=1,
|
|
||||||
sa_column=Column(
|
|
||||||
Integer,
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("1"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
upload_name: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
filename: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
file_path: str = Field(sa_column=Column(Text, nullable=False))
|
|
||||||
raw_transcription: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
revised_text: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
date_uploaded: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
date_revised: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(DateTime(timezone=True)),
|
|
||||||
)
|
|
||||||
|
|
||||||
document: Document | None = Relationship(
|
|
||||||
back_populates="sources",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise"},
|
|
||||||
)
|
|
||||||
job_sources: list["JobSource"] = Relationship(
|
|
||||||
back_populates="source",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise", "passive_deletes": True},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class JobSource(SQLModel, table=True):
|
|
||||||
__tablename__ = "job_source"
|
|
||||||
__table_args__ = (
|
|
||||||
UniqueConstraint("job_id", "source_id", name="unique_job_source"),
|
|
||||||
Index("idx_job_source_job", "job_id"),
|
|
||||||
Index("idx_job_source_source", "source_id"),
|
|
||||||
Index(
|
|
||||||
"idx_job_source_ai_metadata",
|
|
||||||
"ai_metadata",
|
|
||||||
postgresql_using="gin",
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
id: UUID | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
primary_key=True,
|
|
||||||
server_default=text("gen_random_uuid()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
job_id: UUID = Field(
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
ForeignKey("job.id", ondelete="CASCADE"),
|
|
||||||
nullable=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
source_id: UUID = Field(
|
|
||||||
sa_column=Column(
|
|
||||||
PostgreSQLUUID(as_uuid=True),
|
|
||||||
ForeignKey("source.id", ondelete="CASCADE"),
|
|
||||||
nullable=False,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
status: JobSourceStatus = Field(
|
|
||||||
default=JobSourceStatus.PENDING,
|
|
||||||
sa_column=Column(
|
|
||||||
String(50),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("'pending'"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
raw_transcription: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
ai_metadata: JsonValue | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(JSONB),
|
|
||||||
)
|
|
||||||
raw_api_response: JsonValue | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(JSONB),
|
|
||||||
)
|
|
||||||
error_detail: str | None = Field(default=None, sa_column=Column(Text))
|
|
||||||
executed_at: datetime | None = Field(
|
|
||||||
default=None,
|
|
||||||
sa_column=Column(
|
|
||||||
DateTime(timezone=True),
|
|
||||||
nullable=False,
|
|
||||||
server_default=text("now()"),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
job: Job | None = Relationship(
|
|
||||||
back_populates="job_sources",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise"},
|
|
||||||
)
|
|
||||||
source: Source | None = Relationship(
|
|
||||||
back_populates="job_sources",
|
|
||||||
sa_relationship_kwargs={"lazy": "raise"},
|
|
||||||
)
|
|
||||||
```
|
|
||||||
|
|
||||||
The enum annotations validate application values while the mapped columns retain the `VARCHAR` types specified by the DDL. PostgreSQL owns generated UUIDs and timestamps through `server_default`; call `session.refresh(instance)` after a flush or commit when those generated values are needed immediately.
|
|
||||||
|
|
||||||
`ai_metadata`, `raw_api_response`, and `metadata_` accept any JSON value supported by `JSONB`. Validate provider-specific payload structure before assigning it to these fields, while preserving the complete raw response in `raw_api_response`.
|
|
||||||
|
|
||||||
Relationships use `lazy="raise"` to prevent implicit database I/O in async code. Queries must explicitly load relationships they need, for example with `selectinload()`.
|
|
||||||
|
|
||||||
The schema's behavioral invariants are enforced outside the table shape where appropriate:
|
|
||||||
|
|
||||||
- `PersonRole`, `JobStatus`, and `JobSourceStatus` define the exact values listed by the schema.
|
|
||||||
- `unique_document_person_role` enforces role uniqueness for `(document_id, person_id, role)`.
|
|
||||||
- Services order document sources by `Source.document_id` and `Source.page_number`.
|
|
||||||
- Services derive aggregate `Job.status` from related `JobSource.status` values.
|
|
||||||
- Services preserve `JobSource.raw_transcription` and `JobSource.raw_api_response` as point-in-time outputs while updating the active text on `Source`.
|
|
||||||
+1
-16
@@ -12,37 +12,22 @@ description = "Historical document transcription system"
|
|||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.12"
|
requires-python = ">=3.12"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosqlite>=0.21.0",
|
|
||||||
"asyncpg>=0.31.0",
|
|
||||||
"fastapi>=0.138.0",
|
"fastapi>=0.138.0",
|
||||||
"nicegui==3.13.0",
|
"nicegui==3.13.0",
|
||||||
"openrouter>=0.7.0",
|
"openrouter>=0.7.0",
|
||||||
"psycopg2-binary>=2.9.12",
|
|
||||||
"pydantic>=2.13.4",
|
"pydantic>=2.13.4",
|
||||||
"pydantic-settings>=2.9.1",
|
"pydantic-settings>=2.9.1",
|
||||||
"sqlmodel>=0.0.25",
|
"sqlmodel>=0.0.25",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
[dependency-groups]
|
|
||||||
dev = [
|
dev = [
|
||||||
"pytest>=8.0",
|
"pytest>=8.0",
|
||||||
"pytest-asyncio>=0.25",
|
"pytest-asyncio>=0.25",
|
||||||
"httpx2>=2.5.0",
|
|
||||||
"ipykernel>=7.3.0",
|
|
||||||
"ipywidgets>=8.1.8",
|
|
||||||
"pre-commit>=4.6.0",
|
|
||||||
"rich>=15.0.0",
|
|
||||||
"ruff>=0.15.20",
|
|
||||||
"ty>=0.0.54",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "--strict-markers -q"
|
addopts = "--strict-markers -q"
|
||||||
asyncio_mode = "strict"
|
|
||||||
filterwarnings = [
|
|
||||||
"error:coroutine .* was never awaited:RuntimeWarning",
|
|
||||||
]
|
|
||||||
markers = [
|
markers = [
|
||||||
"unit: pure logic tests with no external dependencies",
|
"unit: pure logic tests with no external dependencies",
|
||||||
"integration: tests that touch framework or database contracts",
|
"integration: tests that touch framework or database contracts",
|
||||||
|
|||||||
@@ -1,62 +0,0 @@
|
|||||||
line-length = 120
|
|
||||||
indent-width = 4
|
|
||||||
target-version = "py313"
|
|
||||||
|
|
||||||
exclude = [
|
|
||||||
".venv",
|
|
||||||
".devenv",
|
|
||||||
".git",
|
|
||||||
".vscode",
|
|
||||||
"build",
|
|
||||||
"site",
|
|
||||||
"__pycache__",
|
|
||||||
]
|
|
||||||
|
|
||||||
[lint]
|
|
||||||
preview = true
|
|
||||||
|
|
||||||
extend-select = [
|
|
||||||
"ARG", # https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg
|
|
||||||
"B", # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
|
|
||||||
"C4", # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
|
|
||||||
"DOC102", # https://docs.astral.sh/ruff/rules/docstring-extraneous-parameter/
|
|
||||||
"DOC202", # https://docs.astral.sh/ruff/rules/docstring-extraneous-returns/
|
|
||||||
"DOC403", # https://docs.astral.sh/ruff/rules/docstring-extraneous-yields/
|
|
||||||
"DOC502", # https://docs.astral.sh/ruff/rules/docstring-extraneous-exception/
|
|
||||||
"E", "W", # https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
|
|
||||||
"F", # https://docs.astral.sh/ruff/rules/#pyflakes-f
|
|
||||||
"FURB", # https://docs.astral.sh/ruff/rules/#refurb-furb
|
|
||||||
"I", # https://docs.astral.sh/ruff/rules/#isort-i
|
|
||||||
"N", # https://docs.astral.sh/ruff/rules/#pep8-naming-n
|
|
||||||
"PD", # https://docs.astral.sh/ruff/rules/#pandas-vet-pd
|
|
||||||
"PTH", # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
|
|
||||||
"UP", # https://docs.astral.sh/ruff/rules/#pyupgrade-up
|
|
||||||
"SIM", # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
|
|
||||||
"PLR0202", # https://docs.astral.sh/ruff/rules/no-classmethod-decorator/
|
|
||||||
"PLR0203", # https://docs.astral.sh/ruff/rules/no-staticmethod-decorator/
|
|
||||||
"PLR0206", # https://docs.astral.sh/ruff/rules/property-with-parameters/
|
|
||||||
"PLR0915", # https://docs.astral.sh/ruff/rules/too-many-statements/
|
|
||||||
"PLR1702", # https://docs.astral.sh/ruff/rules/too-many-nested-blocks/
|
|
||||||
"TRY002",
|
|
||||||
]
|
|
||||||
extend-fixable = ["ALL"]
|
|
||||||
ignore = [
|
|
||||||
"UP046",
|
|
||||||
"UP047",
|
|
||||||
]
|
|
||||||
|
|
||||||
[lint.extend-per-file-ignores]
|
|
||||||
"*.ipynb" = [
|
|
||||||
"F401", # unused imports
|
|
||||||
"F841", # unused local variable
|
|
||||||
"F821", # undefined name in exploratory notebook cells
|
|
||||||
]
|
|
||||||
|
|
||||||
[lint.isort]
|
|
||||||
force-single-line = true
|
|
||||||
|
|
||||||
[format]
|
|
||||||
quote-style = "double"
|
|
||||||
indent-style = "space"
|
|
||||||
skip-magic-trailing-comma = false
|
|
||||||
line-ending = "auto"
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import uvicorn
|
|
||||||
|
|
||||||
from .config import LOGGING_CONFIG
|
|
||||||
from .config import get_settings
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
|
||||||
settings = get_settings()
|
|
||||||
uvicorn.run(
|
|
||||||
"transcription.app:create_app",
|
|
||||||
factory=True,
|
|
||||||
host=settings.host,
|
|
||||||
port=settings.port,
|
|
||||||
log_level=LOGGING_CONFIG.get("root", {}).get("level", "info").lower(),
|
|
||||||
reload=settings.reload,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -34,6 +34,12 @@ def _status_for(error: AppError) -> int:
|
|||||||
def register_error_handlers(app: FastAPI) -> None:
|
def register_error_handlers(app: FastAPI) -> None:
|
||||||
"""Register API exception handlers on the app."""
|
"""Register API exception handlers on the app."""
|
||||||
|
|
||||||
|
@app.exception_handler(AccessDeniedError)
|
||||||
|
async def access_denied_handler(_request: Request, exc: AccessDeniedError) -> JSONResponse:
|
||||||
|
envelope = build_error_envelope(exc)
|
||||||
|
headers = {"WWW-Authenticate": "Basic"} if exc.should_challenge else None
|
||||||
|
return JSONResponse(status_code=401, content=envelope.__dict__, headers=headers)
|
||||||
|
|
||||||
@app.exception_handler(AppError)
|
@app.exception_handler(AppError)
|
||||||
async def app_error_handler(_request: Request, exc: AppError) -> JSONResponse:
|
async def app_error_handler(_request: Request, exc: AppError) -> JSONResponse:
|
||||||
envelope = build_error_envelope(exc)
|
envelope = build_error_envelope(exc)
|
||||||
|
|||||||
@@ -0,0 +1,161 @@
|
|||||||
|
"""Functional API routes for jobs, revisions, search, and export."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
from fastapi import APIRouter
|
||||||
|
from pydantic import BaseModel
|
||||||
|
from pydantic import Field
|
||||||
|
|
||||||
|
from transcription.services.library import accept_revision
|
||||||
|
from transcription.services.library import add_revision
|
||||||
|
from transcription.services.library import export_transcripts
|
||||||
|
from transcription.services.library import get_job_detail
|
||||||
|
from transcription.services.library import list_jobs
|
||||||
|
from transcription.services.library import list_revisions
|
||||||
|
from transcription.services.library import search_accepted_transcripts
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/api", tags=["transcription"])
|
||||||
|
|
||||||
|
|
||||||
|
class CreateRevisionRequest(BaseModel):
|
||||||
|
text: str = Field(min_length=1)
|
||||||
|
source: str = "user"
|
||||||
|
accepted: bool = False
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/jobs")
|
||||||
|
def get_jobs() -> list[dict[str, str]]:
|
||||||
|
jobs = list_jobs()
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"id": str(job.id),
|
||||||
|
"document_id": str(job.document_id),
|
||||||
|
"status": job.status.value,
|
||||||
|
"created_at": job.created_at.isoformat(),
|
||||||
|
"updated_at": job.updated_at.isoformat(),
|
||||||
|
}
|
||||||
|
for job in jobs
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/jobs/{job_id}")
|
||||||
|
def get_job(job_id: UUID) -> dict[str, object | None]:
|
||||||
|
detail = get_job_detail(job_id=job_id)
|
||||||
|
return {
|
||||||
|
"job": {
|
||||||
|
"id": str(detail.job.id),
|
||||||
|
"document_id": str(detail.job.document_id),
|
||||||
|
"status": detail.job.status.value,
|
||||||
|
"created_at": detail.job.created_at.isoformat(),
|
||||||
|
"updated_at": detail.job.updated_at.isoformat(),
|
||||||
|
},
|
||||||
|
"document": (
|
||||||
|
{
|
||||||
|
"id": str(detail.document.id),
|
||||||
|
"filename": detail.document.filename,
|
||||||
|
"file_path": detail.document.file_path,
|
||||||
|
}
|
||||||
|
if detail.document is not None
|
||||||
|
else None
|
||||||
|
),
|
||||||
|
"transcript": (
|
||||||
|
{
|
||||||
|
"id": str(detail.transcript.id),
|
||||||
|
"text": detail.transcript.text,
|
||||||
|
"error_detail": detail.transcript.error_detail,
|
||||||
|
"created_at": detail.transcript.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
if detail.transcript is not None
|
||||||
|
else None
|
||||||
|
),
|
||||||
|
"accepted_revision": (
|
||||||
|
{
|
||||||
|
"id": str(detail.accepted_revision.id),
|
||||||
|
"revision_number": detail.accepted_revision.revision_number,
|
||||||
|
"text": detail.accepted_revision.text,
|
||||||
|
"source": detail.accepted_revision.source,
|
||||||
|
"created_at": detail.accepted_revision.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
if detail.accepted_revision is not None
|
||||||
|
else None
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/jobs/{job_id}/revisions")
|
||||||
|
def get_job_revisions(job_id: UUID) -> list[dict[str, object]]:
|
||||||
|
revisions = list_revisions(job_id=job_id)
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"id": str(revision.id),
|
||||||
|
"job_id": str(revision.job_id),
|
||||||
|
"revision_number": revision.revision_number,
|
||||||
|
"text": revision.text,
|
||||||
|
"source": revision.source,
|
||||||
|
"accepted": revision.accepted,
|
||||||
|
"created_at": revision.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
for revision in revisions
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/jobs/{job_id}/revisions")
|
||||||
|
def create_job_revision(job_id: UUID, payload: CreateRevisionRequest) -> dict[str, object]:
|
||||||
|
revision = add_revision(
|
||||||
|
job_id=job_id,
|
||||||
|
text=payload.text,
|
||||||
|
source=payload.source,
|
||||||
|
accepted=payload.accepted,
|
||||||
|
)
|
||||||
|
return {
|
||||||
|
"id": str(revision.id),
|
||||||
|
"job_id": str(revision.job_id),
|
||||||
|
"revision_number": revision.revision_number,
|
||||||
|
"text": revision.text,
|
||||||
|
"source": revision.source,
|
||||||
|
"accepted": revision.accepted,
|
||||||
|
"created_at": revision.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/revisions/{revision_id}/accept")
|
||||||
|
def accept_job_revision(revision_id: UUID) -> dict[str, object]:
|
||||||
|
revision = accept_revision(revision_id=revision_id)
|
||||||
|
return {
|
||||||
|
"id": str(revision.id),
|
||||||
|
"job_id": str(revision.job_id),
|
||||||
|
"revision_number": revision.revision_number,
|
||||||
|
"text": revision.text,
|
||||||
|
"source": revision.source,
|
||||||
|
"accepted": revision.accepted,
|
||||||
|
"created_at": revision.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/search")
|
||||||
|
def search(query: str) -> list[dict[str, object]]:
|
||||||
|
results = search_accepted_transcripts(query=query)
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"revision_id": str(revision.id),
|
||||||
|
"job_id": str(revision.job_id),
|
||||||
|
"revision_number": revision.revision_number,
|
||||||
|
"text": revision.text,
|
||||||
|
"source": revision.source,
|
||||||
|
"accepted": revision.accepted,
|
||||||
|
"created_at": revision.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
for revision in results
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/export")
|
||||||
|
def export(accepted_only: bool = True) -> dict[str, object]:
|
||||||
|
records = export_transcripts(accepted_only=accepted_only)
|
||||||
|
return {
|
||||||
|
"count": len(records),
|
||||||
|
"accepted_only": accepted_only,
|
||||||
|
"records": records,
|
||||||
|
}
|
||||||
+54
-67
@@ -2,107 +2,94 @@
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import logging
|
|
||||||
from contextlib import AsyncExitStack
|
|
||||||
from contextlib import asynccontextmanager
|
from contextlib import asynccontextmanager
|
||||||
from datetime import UTC
|
from threading import Event
|
||||||
from datetime import datetime
|
from threading import Thread
|
||||||
from datetime import timedelta
|
|
||||||
|
|
||||||
from fastapi import FastAPI
|
from fastapi import FastAPI
|
||||||
from fastapi import status
|
from sqlalchemy.ext.asyncio import async_sessionmaker
|
||||||
from fastapi.responses import RedirectResponse
|
from sqlmodel.ext.asyncio.session import AsyncSession
|
||||||
from fastapi.staticfiles import StaticFiles
|
|
||||||
|
|
||||||
from .api.errors import register_error_handlers
|
from .api.errors import register_error_handlers
|
||||||
from .api.health import router as health_router
|
from .api.health import router as health_router
|
||||||
from .config import Settings
|
|
||||||
from .config import configure_logging
|
from .config import configure_logging
|
||||||
from .config import get_settings
|
from .config import get_settings
|
||||||
|
from .db import cleanup_database
|
||||||
from .db import create_all
|
from .db import create_all
|
||||||
from .db import initialize_database_runtime
|
from .db import initialize_database_runtime
|
||||||
from .db.engine import get_database_url
|
|
||||||
from .db.engine import resolve_engine
|
|
||||||
from .db.session import dispose_session_factory
|
|
||||||
from .services import ServiceBundle
|
|
||||||
from .services.jobs import JobService
|
|
||||||
from .ui import register_pages
|
from .ui import register_pages
|
||||||
from .worker import worker_consumer_lifespan
|
from .worker import run_worker_loop
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
def _start_worker(app: FastAPI) -> None:
|
||||||
|
session_factory: async_sessionmaker[AsyncSession] = app.state.db_session_factory
|
||||||
|
stop_event = Event()
|
||||||
|
worker_thread = Thread(
|
||||||
|
target=run_worker_loop,
|
||||||
|
kwargs={
|
||||||
|
"session_factory": session_factory,
|
||||||
|
"stop_event": stop_event,
|
||||||
|
"poll_interval_seconds": 1.0,
|
||||||
|
},
|
||||||
|
daemon=True,
|
||||||
|
)
|
||||||
|
worker_thread.start()
|
||||||
|
app.state.worker_stop_event = stop_event
|
||||||
|
app.state.worker_thread = worker_thread
|
||||||
|
|
||||||
|
|
||||||
|
def _stop_worker(app: FastAPI) -> None:
|
||||||
|
stop_event = getattr(app.state, "worker_stop_event", None)
|
||||||
|
worker_thread = getattr(app.state, "worker_thread", None)
|
||||||
|
|
||||||
|
if stop_event is not None:
|
||||||
|
stop_event.set()
|
||||||
|
if worker_thread is not None:
|
||||||
|
worker_thread.join(timeout=2.0)
|
||||||
|
|
||||||
|
|
||||||
@asynccontextmanager
|
@asynccontextmanager
|
||||||
async def _lifespan(app: FastAPI):
|
async def _lifespan(app: FastAPI):
|
||||||
configure_logging()
|
configure_logging()
|
||||||
|
|
||||||
settings = getattr(app.state, "settings", None) or get_settings()
|
settings = get_settings()
|
||||||
app.state.settings = settings
|
app.state.settings = settings
|
||||||
app.state.services = ServiceBundle()
|
runtime = initialize_database_runtime(settings=settings)
|
||||||
app.state.runtime = initialize_database_runtime(settings=settings)
|
app.state.db_engine = runtime.engine
|
||||||
|
app.state.db_session_factory = runtime.session_factory
|
||||||
|
|
||||||
if settings.should_bootstrap_schema:
|
if settings.should_bootstrap_schema:
|
||||||
await create_all(engine=resolve_engine(settings=settings))
|
await create_all(engine=runtime.engine)
|
||||||
|
|
||||||
settings.upload_dir.mkdir(parents=True, exist_ok=True)
|
settings.upload_dir.mkdir(parents=True, exist_ok=True)
|
||||||
settings.prompt_dir.mkdir(parents=True, exist_ok=True)
|
settings.prompt_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
await _recover_stale_processing_jobs(app)
|
_start_worker(app)
|
||||||
|
try:
|
||||||
async with AsyncExitStack() as stack:
|
|
||||||
stack.push_async_callback(
|
|
||||||
dispose_session_factory,
|
|
||||||
database_url=get_database_url(settings),
|
|
||||||
)
|
|
||||||
stop_event, worker_notifier = await stack.enter_async_context(
|
|
||||||
worker_consumer_lifespan(
|
|
||||||
session_factory=app.state.runtime.session_factory,
|
|
||||||
poll_interval_seconds=1.0,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
app.state.worker_stop_event = stop_event
|
|
||||||
app.state.worker_notifier = worker_notifier
|
|
||||||
yield
|
yield
|
||||||
|
finally:
|
||||||
|
_stop_worker(app)
|
||||||
|
await cleanup_database()
|
||||||
|
|
||||||
|
|
||||||
async def _recover_stale_processing_jobs(app: FastAPI) -> None:
|
def create_app() -> FastAPI:
|
||||||
"""Re-queue stale processing jobs at startup.
|
|
||||||
|
|
||||||
Any job left in PROCESSING longer than the configured provider timeout is
|
|
||||||
assumed orphaned and moved back to QUEUED before the worker starts.
|
|
||||||
"""
|
|
||||||
settings = app.state.settings
|
|
||||||
stale_before = datetime.now(UTC) - timedelta(seconds=settings.worker_provider_timeout_seconds)
|
|
||||||
job_service = JobService(session_factory=app.state.runtime.session_factory)
|
|
||||||
recovered = await job_service.requeue_stale_processing_jobs(stale_before=stale_before)
|
|
||||||
if recovered > 0:
|
|
||||||
logger.warning("Recovered %s stale processing job(s) at startup", recovered)
|
|
||||||
|
|
||||||
|
|
||||||
def create_app(settings: Settings | None = None) -> FastAPI:
|
|
||||||
"""Create and configure the FastAPI application."""
|
"""Create and configure the FastAPI application."""
|
||||||
app = FastAPI(title="Transcription", lifespan=_lifespan)
|
app = FastAPI(title="Transcription", lifespan=_lifespan)
|
||||||
active_settings = settings or get_settings()
|
|
||||||
app.state.settings = active_settings
|
|
||||||
app.mount(
|
|
||||||
"/uploads",
|
|
||||||
StaticFiles(directory=active_settings.upload_dir, check_dir=False),
|
|
||||||
name="uploads",
|
|
||||||
)
|
|
||||||
|
|
||||||
@app.get("/", include_in_schema=False)
|
@app.middleware("http")
|
||||||
async def root_redirect() -> RedirectResponse:
|
async def operator_access_middleware(request: Request, call_next):
|
||||||
return RedirectResponse(url="/ui", status_code=status.HTTP_307_TEMPORARY_REDIRECT)
|
settings = get_settings()
|
||||||
|
try:
|
||||||
|
enforce_request_access(request=request, settings=settings)
|
||||||
|
except AccessDeniedError as exc:
|
||||||
|
envelope = build_error_envelope(exc)
|
||||||
|
headers = {"WWW-Authenticate": "Basic"} if exc.should_challenge else None
|
||||||
|
return JSONResponse(status_code=401, content=envelope.__dict__, headers=headers)
|
||||||
|
|
||||||
@app.get("/ui", include_in_schema=False)
|
return await call_next(request)
|
||||||
async def ui_redirect() -> RedirectResponse:
|
|
||||||
return RedirectResponse(url="/ui/upload", status_code=status.HTTP_307_TEMPORARY_REDIRECT)
|
|
||||||
|
|
||||||
@app.get("/healthz")
|
|
||||||
def health() -> dict[str, str]:
|
|
||||||
return {"status": "ok"}
|
|
||||||
|
|
||||||
register_error_handlers(app)
|
register_error_handlers(app)
|
||||||
register_pages(app)
|
register_pages(app)
|
||||||
app.include_router(health_router)
|
app.include_router(health_router)
|
||||||
|
app.include_router(transcription_router)
|
||||||
return app
|
return app
|
||||||
|
|||||||
@@ -1,39 +0,0 @@
|
|||||||
"""Helpers for accessing lifespan-owned application state resources."""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from fastapi import FastAPI
|
|
||||||
from sqlalchemy.ext.asyncio import async_sessionmaker
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from transcription.db.runtime import DatabaseRuntime
|
|
||||||
from transcription.db.session import get_session_factory
|
|
||||||
from transcription.worker import WorkerNotifier
|
|
||||||
from transcription.worker import resolve_worker_notifier
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_database_runtime(state: object) -> DatabaseRuntime | None:
|
|
||||||
"""Return database runtime from app-like state objects when available."""
|
|
||||||
runtime = getattr(state, "runtime", None)
|
|
||||||
return runtime if isinstance(runtime, DatabaseRuntime) else None
|
|
||||||
|
|
||||||
|
|
||||||
def require_database_runtime(state: object) -> DatabaseRuntime:
|
|
||||||
"""Return database runtime or raise when app lifespan has not initialized it."""
|
|
||||||
runtime = resolve_database_runtime(state)
|
|
||||||
if runtime is None:
|
|
||||||
raise RuntimeError("Database runtime is not initialized on application state")
|
|
||||||
return runtime
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_session_factory(state: object) -> async_sessionmaker[AsyncSession]:
|
|
||||||
"""Return DB session factory from state when available, otherwise shared runtime."""
|
|
||||||
runtime = resolve_database_runtime(state)
|
|
||||||
if runtime is not None:
|
|
||||||
return runtime.session_factory
|
|
||||||
return get_session_factory()
|
|
||||||
|
|
||||||
|
|
||||||
def get_worker_notifier(app: FastAPI) -> WorkerNotifier:
|
|
||||||
"""Return app worker notifier, or a no-op fallback when unavailable."""
|
|
||||||
return resolve_worker_notifier(app.state)
|
|
||||||
+25
-52
@@ -6,16 +6,11 @@ are resolved by the provider adapters, not here.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import logging.config
|
import logging.config
|
||||||
|
from contextvars import ContextVar
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
from functools import cache
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Annotated
|
|
||||||
from typing import Any
|
|
||||||
from typing import Literal
|
from typing import Literal
|
||||||
|
|
||||||
from pydantic import BaseModel
|
|
||||||
from pydantic import Field
|
|
||||||
from pydantic import SecretStr
|
|
||||||
from pydantic_settings import BaseSettings
|
from pydantic_settings import BaseSettings
|
||||||
from pydantic_settings import SettingsConfigDict
|
from pydantic_settings import SettingsConfigDict
|
||||||
|
|
||||||
@@ -26,42 +21,13 @@ class Provider(StrEnum):
|
|||||||
OPENROUTER = "openrouter"
|
OPENROUTER = "openrouter"
|
||||||
|
|
||||||
|
|
||||||
class SqliteSettings(BaseModel):
|
|
||||||
driver: Literal["sqlite"] = "sqlite"
|
|
||||||
path: str = "app.db"
|
|
||||||
|
|
||||||
|
|
||||||
class PostgresSettings(BaseModel):
|
|
||||||
driver: Literal["postgres"] = "postgres"
|
|
||||||
host: str
|
|
||||||
port: int = 5432
|
|
||||||
database: str
|
|
||||||
user: str
|
|
||||||
password: SecretStr
|
|
||||||
|
|
||||||
|
|
||||||
DatabaseSettings = Annotated[
|
|
||||||
SqliteSettings | PostgresSettings,
|
|
||||||
Field(discriminator="driver"),
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
class Settings(BaseSettings):
|
class Settings(BaseSettings):
|
||||||
model_config = SettingsConfigDict(
|
model_config = SettingsConfigDict(
|
||||||
env_file=".env",
|
env_file=".env",
|
||||||
env_file_encoding="utf-8",
|
env_file_encoding="utf-8",
|
||||||
extra="ignore",
|
extra="ignore",
|
||||||
cli_parse_args=True,
|
|
||||||
cli_implicit_flags=True,
|
|
||||||
cli_kebab_case=True,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# --- NiceGUI Server ---
|
|
||||||
host: str = "0.0.0.0"
|
|
||||||
port: int = 8000
|
|
||||||
log_level: Literal["critical", "error", "warning", "info", "debug", "trace"] = "info"
|
|
||||||
reload: bool = False
|
|
||||||
|
|
||||||
# --- AI provider ---
|
# --- AI provider ---
|
||||||
provider: Provider = Provider.OPENROUTER
|
provider: Provider = Provider.OPENROUTER
|
||||||
openrouter_api_key: str
|
openrouter_api_key: str
|
||||||
@@ -73,22 +39,26 @@ class Settings(BaseSettings):
|
|||||||
environment: Literal["development", "test", "production"] = "development"
|
environment: Literal["development", "test", "production"] = "development"
|
||||||
|
|
||||||
# --- persistence ---
|
# --- persistence ---
|
||||||
database: DatabaseSettings = Field(default_factory=SqliteSettings)
|
|
||||||
database_url: str = "sqlite:///./transcription.db"
|
database_url: str = "sqlite:///./transcription.db"
|
||||||
bootstrap_schema_on_startup: bool = False
|
bootstrap_schema_on_startup: bool | None = None
|
||||||
sqlite_check_same_thread: bool = False
|
migration_auto_apply_on_startup: bool = False
|
||||||
|
validate_schema_on_startup: bool = True
|
||||||
|
|
||||||
# --- filesystem paths ---
|
# --- filesystem paths ---
|
||||||
upload_dir: Path = Path("./uploads")
|
upload_dir: Path = Path("./uploads")
|
||||||
prompt_dir: Path = Path("./prompts")
|
prompt_dir: Path = Path("./prompts")
|
||||||
|
|
||||||
|
# --- upload safety ---
|
||||||
|
max_upload_bytes: int = 15 * 1024 * 1024
|
||||||
|
|
||||||
|
# --- single-operator access control ---
|
||||||
|
operator_access_enabled: bool = False
|
||||||
|
operator_username: str = "operator"
|
||||||
|
operator_password: str | None = None
|
||||||
|
|
||||||
# --- worker reliability ---
|
# --- worker reliability ---
|
||||||
worker_max_retries: int = 0
|
worker_max_retries: int = 0
|
||||||
worker_retry_backoff_seconds: float = 0.0
|
worker_retry_backoff_seconds: float = 0.0
|
||||||
worker_provider_timeout_seconds: float = Field(default=20.0, gt=0.0, le=20.0)
|
|
||||||
worker_min_transcription_chars: int = Field(default=0, ge=0)
|
|
||||||
worker_min_transcription_lines: int = Field(default=0, ge=0)
|
|
||||||
worker_fail_on_finish_reason_length: bool = False
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def should_bootstrap_schema(self) -> bool:
|
def should_bootstrap_schema(self) -> bool:
|
||||||
@@ -98,17 +68,23 @@ class Settings(BaseSettings):
|
|||||||
return self.environment in {"development", "test"}
|
return self.environment in {"development", "test"}
|
||||||
|
|
||||||
|
|
||||||
@cache
|
_settings: ContextVar[Settings | None] = ContextVar("settings", default=None)
|
||||||
def get_settings(**kwargs) -> Settings:
|
|
||||||
return Settings(**kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
LOGGING_CONFIG: dict[str, Any] = {
|
def get_settings() -> Settings:
|
||||||
|
settings = _settings.get()
|
||||||
|
if settings is None:
|
||||||
|
settings = Settings() # pyright: ignore[reportCallIssue]
|
||||||
|
_settings.set(settings)
|
||||||
|
return settings
|
||||||
|
|
||||||
|
|
||||||
|
LOGGING_CONFIG: dict[str, object] = {
|
||||||
"version": 1,
|
"version": 1,
|
||||||
"disable_existing_loggers": False,
|
"disable_existing_loggers": False,
|
||||||
"formatters": {
|
"formatters": {
|
||||||
"standard": {
|
"standard": {
|
||||||
"format": "%(asctime)s %(levelname)-8s | %(message)s",
|
"format": "%(asctime)s | %(levelname)-8s | %(name)s | %(message)s",
|
||||||
"datefmt": "%Y-%m-%d %H:%M:%S",
|
"datefmt": "%Y-%m-%d %H:%M:%S",
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@@ -133,10 +109,7 @@ LOGGING_CONFIG: dict[str, Any] = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def configure_logging(settings: Settings | None = None) -> None:
|
def configure_logging() -> None:
|
||||||
"""Configure root logging once at startup."""
|
"""Configure root logging once at startup."""
|
||||||
cfg = LOGGING_CONFIG.copy()
|
logging.config.dictConfig(LOGGING_CONFIG)
|
||||||
active_settings = settings or get_settings()
|
|
||||||
cfg["loggers"]["transcription"]["level"] = active_settings.log_level.upper()
|
|
||||||
logging.config.dictConfig(cfg)
|
|
||||||
logger.debug("Logging configured")
|
logger.debug("Logging configured")
|
||||||
|
|||||||
@@ -0,0 +1,149 @@
|
|||||||
|
"""Database runtime ownership, schema bootstrap, and session access.
|
||||||
|
|
||||||
|
V1 moves database resource ownership to explicit runtime initialization so
|
||||||
|
startup/shutdown behavior is predictable and lifespan-managed.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import contextlib
|
||||||
|
import logging
|
||||||
|
from collections.abc import AsyncGenerator
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
from sqlalchemy import inspect
|
||||||
|
from sqlalchemy import text
|
||||||
|
from sqlalchemy.engine import Connection
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncEngine
|
||||||
|
from sqlalchemy.ext.asyncio import async_sessionmaker
|
||||||
|
from sqlalchemy.ext.asyncio import create_async_engine
|
||||||
|
from sqlmodel import SQLModel
|
||||||
|
from sqlmodel.ext.asyncio.session import AsyncSession
|
||||||
|
|
||||||
|
from .config import Settings
|
||||||
|
from .config import get_settings
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class DatabaseRuntime:
|
||||||
|
"""Database runtime resources owned by app lifespan."""
|
||||||
|
|
||||||
|
engine: AsyncEngine
|
||||||
|
session_factory: async_sessionmaker[AsyncSession]
|
||||||
|
|
||||||
|
|
||||||
|
_runtime: DatabaseRuntime | None = None
|
||||||
|
|
||||||
|
|
||||||
|
def _to_async_database_url(database_url: str) -> str:
|
||||||
|
"""Normalize configured database URL to an async SQLAlchemy driver URL."""
|
||||||
|
if database_url.startswith("sqlite://") and not database_url.startswith("sqlite+aiosqlite://"):
|
||||||
|
return database_url.replace("sqlite://", "sqlite+aiosqlite://", 1)
|
||||||
|
if database_url.startswith("postgresql://") and not database_url.startswith("postgresql+asyncpg://"):
|
||||||
|
return database_url.replace("postgresql://", "postgresql+asyncpg://", 1)
|
||||||
|
return database_url
|
||||||
|
|
||||||
|
|
||||||
|
def _build_engine(settings: Settings) -> AsyncEngine:
|
||||||
|
database_url = _to_async_database_url(settings.database_url)
|
||||||
|
connect_args: dict[str, object] = {}
|
||||||
|
if database_url.startswith("sqlite"):
|
||||||
|
connect_args["check_same_thread"] = False
|
||||||
|
return create_async_engine(
|
||||||
|
url=database_url,
|
||||||
|
echo=False,
|
||||||
|
pool_pre_ping=True,
|
||||||
|
connect_args=connect_args,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def initialize_database_runtime(*, settings: Settings | None = None) -> DatabaseRuntime:
|
||||||
|
"""Initialize lifespan-owned async DB resources once per process."""
|
||||||
|
global _runtime
|
||||||
|
if _runtime is not None:
|
||||||
|
return _runtime
|
||||||
|
|
||||||
|
active_settings = settings or get_settings()
|
||||||
|
engine = _build_engine(active_settings)
|
||||||
|
session_factory = async_sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
|
||||||
|
_runtime = DatabaseRuntime(engine=engine, session_factory=session_factory)
|
||||||
|
logger.debug("Initialized async database runtime for database_url=%s", engine.url)
|
||||||
|
return _runtime
|
||||||
|
|
||||||
|
|
||||||
|
def get_engine() -> AsyncEngine:
|
||||||
|
"""Return the current async SQLAlchemy engine."""
|
||||||
|
runtime = _runtime or initialize_database_runtime()
|
||||||
|
return runtime.engine
|
||||||
|
|
||||||
|
|
||||||
|
def get_session_factory() -> async_sessionmaker[AsyncSession]:
|
||||||
|
"""Return the shared async session factory."""
|
||||||
|
runtime = _runtime or initialize_database_runtime()
|
||||||
|
return runtime.session_factory
|
||||||
|
|
||||||
|
|
||||||
|
async def cleanup_database() -> None:
|
||||||
|
"""Cleanup database runtime resources."""
|
||||||
|
await dispose_database_runtime()
|
||||||
|
|
||||||
|
|
||||||
|
async def dispose_database_runtime() -> None:
|
||||||
|
"""Dispose lifespan-owned async database resources."""
|
||||||
|
global _runtime
|
||||||
|
if _runtime is None:
|
||||||
|
return
|
||||||
|
await _runtime.engine.dispose()
|
||||||
|
_runtime = None
|
||||||
|
|
||||||
|
|
||||||
|
async def create_all(*, engine: AsyncEngine | None = None) -> None:
|
||||||
|
"""Create all tables on the selected engine."""
|
||||||
|
# Import models so SQLModel metadata is fully registered before bootstrap.
|
||||||
|
from transcription import models as _models # noqa: F401
|
||||||
|
|
||||||
|
active_engine = engine or get_engine()
|
||||||
|
async with active_engine.begin() as connection:
|
||||||
|
await connection.run_sync(SQLModel.metadata.create_all)
|
||||||
|
await connection.run_sync(_ensure_sqlite_compat_columns)
|
||||||
|
logger.debug("Database schema bootstrap complete for database_url=%s", active_engine.url)
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_sqlite_compat_columns(connection: Connection) -> None:
|
||||||
|
"""Apply lightweight dev/test SQLite compatibility column patches.
|
||||||
|
|
||||||
|
This performs read-only validation and never mutates schema.
|
||||||
|
"""
|
||||||
|
if connection.engine.url.get_backend_name() != "sqlite":
|
||||||
|
return
|
||||||
|
|
||||||
|
inspector = inspect(connection)
|
||||||
|
table_names = set(inspector.get_table_names())
|
||||||
|
|
||||||
|
required_tables = {"document", "job", "transcript", "transcriptrevision"}
|
||||||
|
missing_tables = sorted(required_tables - table_names)
|
||||||
|
for table_name in missing_tables:
|
||||||
|
issues.append(f"missing_table:{table_name}")
|
||||||
|
|
||||||
|
columns = {column["name"] for column in inspector.get_columns("job")}
|
||||||
|
if "retry_count" not in columns:
|
||||||
|
connection.execute(text("ALTER TABLE job ADD COLUMN retry_count INTEGER NOT NULL DEFAULT 0"))
|
||||||
|
logger.warning("Applied SQLite compatibility schema patch table=job column=retry_count default=0")
|
||||||
|
|
||||||
|
|
||||||
|
@contextlib.asynccontextmanager
|
||||||
|
async def get_session(
|
||||||
|
*,
|
||||||
|
session_factory: async_sessionmaker[AsyncSession] | None = None,
|
||||||
|
) -> AsyncGenerator[AsyncSession]:
|
||||||
|
"""Yield a database session and ensure cleanup."""
|
||||||
|
active_session_factory = session_factory or get_session_factory()
|
||||||
|
async with active_session_factory() as session:
|
||||||
|
yield session
|
||||||
|
|
||||||
|
|
||||||
|
def should_bootstrap_schema(settings: Settings) -> bool:
|
||||||
|
"""Compatibility helper for explicit bootstrap checks."""
|
||||||
|
return settings.should_bootstrap_schema
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
from .operations import create_all
|
|
||||||
from .runtime import dispose_database_runtime
|
|
||||||
from .runtime import initialize_database_runtime
|
|
||||||
from .session import session_scope
|
|
||||||
from .session import transaction_scope
|
|
||||||
|
|
||||||
__all__ = [
|
|
||||||
"create_all",
|
|
||||||
"dispose_database_runtime",
|
|
||||||
"initialize_database_runtime",
|
|
||||||
"session_scope",
|
|
||||||
"transaction_scope",
|
|
||||||
]
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
from functools import cache
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
from sqlalchemy import URL
|
|
||||||
from sqlalchemy import StaticPool
|
|
||||||
from sqlalchemy.ext.asyncio import AsyncEngine
|
|
||||||
from sqlalchemy.ext.asyncio import create_async_engine
|
|
||||||
|
|
||||||
from ..config import PostgresSettings
|
|
||||||
from ..config import Settings
|
|
||||||
from ..config import SqliteSettings
|
|
||||||
from ..config import get_settings
|
|
||||||
|
|
||||||
|
|
||||||
def get_database_url(settings: Settings) -> str:
|
|
||||||
match settings.database:
|
|
||||||
case SqliteSettings(path=path):
|
|
||||||
url = URL.create(
|
|
||||||
drivername="sqlite+aiosqlite",
|
|
||||||
database=path,
|
|
||||||
)
|
|
||||||
case PostgresSettings() as database:
|
|
||||||
url = URL.create(
|
|
||||||
drivername="postgresql+asyncpg",
|
|
||||||
host=database.host,
|
|
||||||
port=database.port,
|
|
||||||
database=database.database,
|
|
||||||
username=database.user,
|
|
||||||
password=database.password.get_secret_value(),
|
|
||||||
)
|
|
||||||
return url.render_as_string(hide_password=False)
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_engine(settings: Settings | None = None) -> AsyncEngine:
|
|
||||||
active_settings = settings or get_settings()
|
|
||||||
return get_engine(get_database_url(active_settings))
|
|
||||||
|
|
||||||
|
|
||||||
@cache
|
|
||||||
def get_engine(database_url: str) -> AsyncEngine:
|
|
||||||
kwargs: dict[str, Any] = {"echo": False, "pool_pre_ping": True}
|
|
||||||
if database_url.startswith("sqlite"):
|
|
||||||
kwargs["connect_args"] = {"check_same_thread": False}
|
|
||||||
if ":memory:" in database_url:
|
|
||||||
kwargs["poolclass"] = StaticPool
|
|
||||||
|
|
||||||
return create_async_engine(database_url, **kwargs)
|
|
||||||
|
|
||||||
|
|
||||||
async def dispose_engine(database_url: str) -> None:
|
|
||||||
engine = get_engine(database_url)
|
|
||||||
try:
|
|
||||||
await engine.dispose()
|
|
||||||
finally:
|
|
||||||
get_engine.cache_clear()
|
|
||||||
|
|
||||||
|
|
||||||
async def refresh_engine(database_url: str) -> AsyncEngine:
|
|
||||||
await dispose_engine(database_url)
|
|
||||||
return get_engine(database_url)
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
"""SQLModel domain models for the transcription system.
|
|
||||||
|
|
||||||
Core V1 lifecycle:
|
|
||||||
Document -> one-to-many -> Source
|
|
||||||
Document -> one-to-many -> Job
|
|
||||||
Source -> one-to-one? -> Revision (optional)
|
|
||||||
"""
|
|
||||||
|
|
||||||
from datetime import UTC
|
|
||||||
from datetime import datetime
|
|
||||||
from enum import StrEnum
|
|
||||||
from typing import Optional
|
|
||||||
from uuid import UUID
|
|
||||||
from uuid import uuid4
|
|
||||||
|
|
||||||
from sqlalchemy import UniqueConstraint
|
|
||||||
from sqlmodel import Field
|
|
||||||
from sqlmodel import Relationship
|
|
||||||
from sqlmodel import SQLModel
|
|
||||||
|
|
||||||
|
|
||||||
class JobStatus(StrEnum):
|
|
||||||
QUEUED = "queued"
|
|
||||||
PROCESSING = "processing"
|
|
||||||
TRANSCRIBED = "transcribed"
|
|
||||||
FAILED = "failed"
|
|
||||||
|
|
||||||
|
|
||||||
class Document(SQLModel, table=True):
|
|
||||||
"""An historical document."""
|
|
||||||
|
|
||||||
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
|
||||||
name: str
|
|
||||||
|
|
||||||
# Relationships
|
|
||||||
jobs: list["Job"] = Relationship(back_populates="document")
|
|
||||||
sources: list["Source"] = Relationship(back_populates="document")
|
|
||||||
|
|
||||||
|
|
||||||
class Source(SQLModel, table=True):
|
|
||||||
"""A document source (image or PDF)."""
|
|
||||||
|
|
||||||
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
|
||||||
document_id: UUID = Field(foreign_key="document.id")
|
|
||||||
job_id: UUID = Field(foreign_key="job.id")
|
|
||||||
upload_name: str
|
|
||||||
"""The filename of the source that was uploaded for transcription."""
|
|
||||||
filename: str
|
|
||||||
"""The system generated unique source name."""
|
|
||||||
file_path: str
|
|
||||||
"""The location where the sources are stored on the local filesystem."""
|
|
||||||
date_uploaded: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
|
||||||
|
|
||||||
# Relationships
|
|
||||||
document: Optional["Document"] = Relationship(back_populates="sources")
|
|
||||||
job: Optional["Job"] = Relationship(back_populates="sources")
|
|
||||||
revision: Optional["Revision"] = Relationship(
|
|
||||||
back_populates="source",
|
|
||||||
sa_relationship_kwargs={"uselist": False},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Job(SQLModel, table=True):
|
|
||||||
"""A transcription job tied to a single document."""
|
|
||||||
|
|
||||||
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
|
||||||
document_id: UUID = Field(foreign_key="document.id")
|
|
||||||
status: JobStatus = Field(default=JobStatus.QUEUED)
|
|
||||||
retry_count: int = Field(default=0, ge=0)
|
|
||||||
date_created: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
|
||||||
date_updated: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
|
||||||
provider: str | None = None
|
|
||||||
"""Name of the transcription provider used to generate this transcript."""
|
|
||||||
model: str | None = None
|
|
||||||
"""Model identifier used to generate this transcript."""
|
|
||||||
prompt_name: str | None = None
|
|
||||||
"""Name of the prompt used to generate this transcript."""
|
|
||||||
text: str | None = None
|
|
||||||
"""The transcribed text. This may be None if the job failed or is still in progress."""
|
|
||||||
error_detail: str | None = None
|
|
||||||
"""Details of any error that occurred during transcription."""
|
|
||||||
|
|
||||||
# Relationships
|
|
||||||
document: Optional["Document"] = Relationship(back_populates="jobs")
|
|
||||||
sources: list["Source"] = Relationship(back_populates="job")
|
|
||||||
|
|
||||||
@property
|
|
||||||
def filename(self) -> str:
|
|
||||||
"""Return the filename of the associated source, when available."""
|
|
||||||
if not self.sources:
|
|
||||||
return "unknown"
|
|
||||||
return self.sources[0].filename
|
|
||||||
|
|
||||||
|
|
||||||
class Revision(SQLModel, table=True):
|
|
||||||
"""A revision of a transcription text."""
|
|
||||||
|
|
||||||
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
|
||||||
source_id: UUID = Field(foreign_key="source.id")
|
|
||||||
"""ID for the associated source."""
|
|
||||||
revision: int = Field(default=1, ge=1)
|
|
||||||
"""Revision number of this transcription revision, starting at 1."""
|
|
||||||
text: str
|
|
||||||
"""The revised text."""
|
|
||||||
date_created: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
|
||||||
|
|
||||||
__table_args__ = (UniqueConstraint("source_id", name="uq_revision_source_id"),)
|
|
||||||
|
|
||||||
# Relationships
|
|
||||||
source: Optional["Source"] = Relationship(back_populates="revision")
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import logging
|
|
||||||
|
|
||||||
from sqlalchemy import inspect
|
|
||||||
from sqlalchemy import text
|
|
||||||
from sqlalchemy.engine import Connection
|
|
||||||
from sqlalchemy.ext.asyncio import AsyncEngine
|
|
||||||
from sqlmodel import SQLModel
|
|
||||||
from sqlmodel import select
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from .engine import resolve_engine
|
|
||||||
from .models import Job
|
|
||||||
from .models import JobStatus
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
async def create_all(*, engine: AsyncEngine | None = None) -> None:
|
|
||||||
"""Create all tables on the selected engine."""
|
|
||||||
# Import models so SQLModel metadata is fully registered before bootstrap.
|
|
||||||
from transcription.db import models as _models # noqa: F401
|
|
||||||
|
|
||||||
active_engine = engine or resolve_engine()
|
|
||||||
async with active_engine.begin() as connection:
|
|
||||||
await connection.run_sync(SQLModel.metadata.create_all)
|
|
||||||
await connection.run_sync(_ensure_sqlite_compat_columns)
|
|
||||||
logger.debug("Database schema bootstrap complete for database_url=%s", active_engine.url)
|
|
||||||
|
|
||||||
|
|
||||||
async def get_next_queued_job(*, session: AsyncSession) -> Job | None:
|
|
||||||
"""Get the next queued job, if any."""
|
|
||||||
result = await session.exec(
|
|
||||||
select(Job)
|
|
||||||
.where(Job.status == JobStatus.QUEUED)
|
|
||||||
.order_by(Job.date_created) # pyright: ignore[reportArgumentType]
|
|
||||||
.limit(1)
|
|
||||||
) # fmt: skip
|
|
||||||
return result.first()
|
|
||||||
|
|
||||||
|
|
||||||
def _ensure_sqlite_compat_columns(connection: Connection) -> None:
|
|
||||||
"""Apply lightweight dev/test SQLite compatibility column patches.
|
|
||||||
|
|
||||||
This keeps local bootstrap resilient when models evolve but no full
|
|
||||||
migration tooling is in place yet.
|
|
||||||
"""
|
|
||||||
if connection.engine.url.get_backend_name() != "sqlite":
|
|
||||||
return
|
|
||||||
|
|
||||||
inspector = inspect(connection)
|
|
||||||
table_names = set(inspector.get_table_names())
|
|
||||||
|
|
||||||
if "job" in table_names:
|
|
||||||
job_columns = {column["name"] for column in inspector.get_columns("job")}
|
|
||||||
if "retry_count" not in job_columns:
|
|
||||||
connection.execute(text("ALTER TABLE job ADD COLUMN retry_count INTEGER NOT NULL DEFAULT 0"))
|
|
||||||
logger.warning("Applied SQLite compatibility schema patch table=job column=retry_count default=0")
|
|
||||||
|
|
||||||
if "revision" in table_names:
|
|
||||||
revision_columns = {column["name"] for column in inspector.get_columns("revision")}
|
|
||||||
if "source_id" in revision_columns:
|
|
||||||
has_unique_source = False
|
|
||||||
for index in inspector.get_indexes("revision"):
|
|
||||||
if index.get("unique") and index.get("column_names") == ["source_id"]:
|
|
||||||
has_unique_source = True
|
|
||||||
break
|
|
||||||
if not has_unique_source:
|
|
||||||
connection.execute(
|
|
||||||
text("CREATE UNIQUE INDEX IF NOT EXISTS ux_revision_source_id ON revision(source_id)")
|
|
||||||
)
|
|
||||||
logger.warning(
|
|
||||||
"Applied SQLite compatibility schema patch table=revision unique_index=ux_revision_source_id"
|
|
||||||
)
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
import logging
|
|
||||||
from contextvars import ContextVar
|
|
||||||
from dataclasses import dataclass
|
|
||||||
|
|
||||||
from sqlalchemy.ext.asyncio import AsyncEngine
|
|
||||||
from sqlalchemy.ext.asyncio import async_sessionmaker
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from ..config import Settings
|
|
||||||
from ..config import get_settings
|
|
||||||
from .engine import get_database_url
|
|
||||||
from .engine import get_engine
|
|
||||||
from .session import get_session_factory
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class DatabaseRuntime:
|
|
||||||
"""Database runtime resources owned by app lifespan."""
|
|
||||||
|
|
||||||
engine: AsyncEngine
|
|
||||||
session_factory: async_sessionmaker[AsyncSession]
|
|
||||||
|
|
||||||
|
|
||||||
_runtime: ContextVar[DatabaseRuntime | None] = ContextVar("database_runtime", default=None)
|
|
||||||
|
|
||||||
|
|
||||||
async def dispose_database_runtime() -> None:
|
|
||||||
"""Dispose lifespan-owned async database resources."""
|
|
||||||
runtime = _runtime.get()
|
|
||||||
if runtime is None:
|
|
||||||
return
|
|
||||||
await runtime.engine.dispose()
|
|
||||||
_runtime.set(None)
|
|
||||||
|
|
||||||
|
|
||||||
def initialize_database_runtime(*, settings: Settings | None = None) -> DatabaseRuntime:
|
|
||||||
"""Initialize lifespan-owned async DB resources once per process."""
|
|
||||||
runtime = _runtime.get()
|
|
||||||
if runtime is not None:
|
|
||||||
return runtime
|
|
||||||
|
|
||||||
active_settings = settings or get_settings()
|
|
||||||
database_url = get_database_url(active_settings)
|
|
||||||
engine = get_engine(database_url)
|
|
||||||
session_factory = get_session_factory(database_url)
|
|
||||||
runtime = DatabaseRuntime(engine=engine, session_factory=session_factory)
|
|
||||||
_runtime.set(runtime)
|
|
||||||
logger.debug("Initialized async database runtime for database_url=%s", engine.url)
|
|
||||||
return runtime
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
from collections.abc import AsyncGenerator
|
|
||||||
from contextlib import asynccontextmanager
|
|
||||||
from functools import cache
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
from fastapi import Depends
|
|
||||||
from sqlalchemy.ext.asyncio import AsyncSessionTransaction
|
|
||||||
from sqlalchemy.ext.asyncio import async_sessionmaker
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from ..config import get_settings
|
|
||||||
from .engine import dispose_engine
|
|
||||||
from .engine import get_database_url
|
|
||||||
from .engine import get_engine
|
|
||||||
|
|
||||||
type SessionFactory = async_sessionmaker[AsyncSession]
|
|
||||||
|
|
||||||
|
|
||||||
@cache
|
|
||||||
def get_session_factory(database_url: str) -> SessionFactory:
|
|
||||||
return async_sessionmaker(
|
|
||||||
bind=get_engine(database_url),
|
|
||||||
class_=AsyncSession,
|
|
||||||
expire_on_commit=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_session_factory(database_url: str | None = None) -> SessionFactory:
|
|
||||||
return get_session_factory(database_url or get_database_url(get_settings()))
|
|
||||||
|
|
||||||
|
|
||||||
type SessionFactoryDep = Annotated[SessionFactory, Depends(resolve_session_factory)]
|
|
||||||
|
|
||||||
|
|
||||||
async def dispose_session_factory(database_url: str) -> None:
|
|
||||||
get_session_factory.cache_clear()
|
|
||||||
await dispose_engine(database_url)
|
|
||||||
|
|
||||||
|
|
||||||
@asynccontextmanager
|
|
||||||
async def session_scope(
|
|
||||||
*,
|
|
||||||
database_url: str | None = None,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> AsyncGenerator[AsyncSession]:
|
|
||||||
if session is not None:
|
|
||||||
yield session
|
|
||||||
return
|
|
||||||
|
|
||||||
session_factory = resolve_session_factory(database_url)
|
|
||||||
async with session_factory() as owned_session:
|
|
||||||
yield owned_session
|
|
||||||
|
|
||||||
|
|
||||||
type SessionScopeDep = Annotated[AsyncSession, Depends(session_scope)]
|
|
||||||
|
|
||||||
|
|
||||||
@asynccontextmanager
|
|
||||||
async def transaction_scope(
|
|
||||||
*,
|
|
||||||
database_url: str | None = None,
|
|
||||||
session: AsyncSessionTransaction | None = None,
|
|
||||||
) -> AsyncGenerator[AsyncSessionTransaction]:
|
|
||||||
match session:
|
|
||||||
case AsyncSession() as async_session:
|
|
||||||
if not async_session.in_transaction():
|
|
||||||
raise RuntimeError("A supplied session must have an active transaction")
|
|
||||||
yield async_session
|
|
||||||
return
|
|
||||||
case AsyncSessionTransaction() as async_transaction:
|
|
||||||
yield async_transaction
|
|
||||||
return
|
|
||||||
|
|
||||||
session_factory = resolve_session_factory(database_url)
|
|
||||||
async with session_factory().begin() as owned_session:
|
|
||||||
yield owned_session
|
|
||||||
|
|
||||||
|
|
||||||
type TransactionScopeDep = Annotated[AsyncSessionTransaction, Depends(transaction_scope)]
|
|
||||||
@@ -17,7 +17,6 @@ class ErrorCategory(StrEnum):
|
|||||||
NOT_FOUND = "not_found_error"
|
NOT_FOUND = "not_found_error"
|
||||||
CONFLICT = "conflict_error"
|
CONFLICT = "conflict_error"
|
||||||
EXTERNAL_PROVIDER = "external_provider_error"
|
EXTERNAL_PROVIDER = "external_provider_error"
|
||||||
PROCESSING = "processing_error"
|
|
||||||
INFRA_TRANSIENT = "infrastructure_transient_error"
|
INFRA_TRANSIENT = "infrastructure_transient_error"
|
||||||
INFRA_PERSISTENT = "infrastructure_persistent_error"
|
INFRA_PERSISTENT = "infrastructure_persistent_error"
|
||||||
INTERNAL_UNEXPECTED = "internal_unexpected_error"
|
INTERNAL_UNEXPECTED = "internal_unexpected_error"
|
||||||
@@ -72,8 +71,9 @@ def build_error_envelope(error: AppError) -> ErrorEnvelope:
|
|||||||
|
|
||||||
def classify_unexpected_error(exc: Exception, *, operation: str) -> AppError:
|
def classify_unexpected_error(exc: Exception, *, operation: str) -> AppError:
|
||||||
"""Normalize unknown exceptions into internal_unexpected_error."""
|
"""Normalize unknown exceptions into internal_unexpected_error."""
|
||||||
|
_ = exc
|
||||||
return AppError(
|
return AppError(
|
||||||
f"Unexpected error during {operation}: {exc}",
|
f"Unexpected error during {operation}",
|
||||||
category=ErrorCategory.INTERNAL_UNEXPECTED,
|
category=ErrorCategory.INTERNAL_UNEXPECTED,
|
||||||
suggestion="Retry once. If it persists, review logs and report the error reference id.",
|
suggestion="Retry once. If it persists, review logs and report the error reference id.",
|
||||||
retriable=False,
|
retriable=False,
|
||||||
@@ -82,4 +82,7 @@ def classify_unexpected_error(exc: Exception, *, operation: str) -> AppError:
|
|||||||
|
|
||||||
def format_error_detail(error: AppError) -> str:
|
def format_error_detail(error: AppError) -> str:
|
||||||
"""Return a compact persisted failure string for transcript.error_detail."""
|
"""Return a compact persisted failure string for transcript.error_detail."""
|
||||||
return f"[{error.category.value}] {error.message} | suggestion={error.suggestion} | error_id={error.error_id}"
|
return (
|
||||||
|
f"[{error.category.value}] {error.message} | "
|
||||||
|
f"suggestion={error.suggestion} | error_id={error.error_id}"
|
||||||
|
)
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
"""CLI entrypoint for explicit schema migration and compatibility checks."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
|
||||||
|
from transcription.config import get_settings
|
||||||
|
from transcription.db import initialize_database_runtime
|
||||||
|
from transcription.db import validate_schema_compatibility
|
||||||
|
from transcription.migrations import apply_pending_migrations
|
||||||
|
from transcription.migrations import list_pending_migrations
|
||||||
|
|
||||||
|
|
||||||
|
def _build_parser() -> argparse.ArgumentParser:
|
||||||
|
parser = argparse.ArgumentParser(description="Transcription schema migration runner")
|
||||||
|
parser.add_argument(
|
||||||
|
"--apply",
|
||||||
|
action="store_true",
|
||||||
|
help="Apply all pending migrations.",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--list",
|
||||||
|
action="store_true",
|
||||||
|
help="List pending migrations.",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--check",
|
||||||
|
action="store_true",
|
||||||
|
help="Run schema compatibility check.",
|
||||||
|
)
|
||||||
|
return parser
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
parser = _build_parser()
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
if not (args.apply or args.list or args.check):
|
||||||
|
parser.error("Specify at least one action: --list, --apply, or --check")
|
||||||
|
|
||||||
|
runtime = initialize_database_runtime(settings=get_settings())
|
||||||
|
engine = runtime.engine
|
||||||
|
|
||||||
|
if args.list:
|
||||||
|
pending = list_pending_migrations(engine=engine)
|
||||||
|
if not pending:
|
||||||
|
print("No pending migrations.")
|
||||||
|
else:
|
||||||
|
print("Pending migrations:")
|
||||||
|
for migration in pending:
|
||||||
|
print(f"- {migration.revision_id}: {migration.description}")
|
||||||
|
|
||||||
|
if args.apply:
|
||||||
|
applied = apply_pending_migrations(engine=engine)
|
||||||
|
if not applied:
|
||||||
|
print("No migrations applied.")
|
||||||
|
else:
|
||||||
|
print("Applied migrations:")
|
||||||
|
for revision_id in applied:
|
||||||
|
print(f"- {revision_id}")
|
||||||
|
|
||||||
|
if args.check:
|
||||||
|
issues = validate_schema_compatibility(engine=engine)
|
||||||
|
if issues:
|
||||||
|
print("Schema compatibility check failed:")
|
||||||
|
for issue in issues:
|
||||||
|
print(f"- {issue}")
|
||||||
|
return 1
|
||||||
|
print("Schema compatibility check passed.")
|
||||||
|
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
"""Lightweight schema migration helpers for V1 Step 4.
|
||||||
|
|
||||||
|
This module provides explicit, operator-invoked migration execution for
|
||||||
|
personal-scale deployments without introducing heavyweight migration tooling.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from collections.abc import Callable
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import UTC
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
from sqlalchemy import inspect
|
||||||
|
from sqlalchemy import text
|
||||||
|
from sqlalchemy.engine import Connection
|
||||||
|
from sqlalchemy.engine import Engine
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class MigrationRevision:
|
||||||
|
"""Represents one ordered schema migration revision."""
|
||||||
|
|
||||||
|
revision_id: str
|
||||||
|
description: str
|
||||||
|
apply: Callable[[Connection], None]
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_history_table(connection: Connection) -> None:
|
||||||
|
"""Create migration history table when missing."""
|
||||||
|
connection.execute(
|
||||||
|
text(
|
||||||
|
"""
|
||||||
|
CREATE TABLE IF NOT EXISTS schema_migration_history (
|
||||||
|
revision_id VARCHAR(64) PRIMARY KEY,
|
||||||
|
description VARCHAR(255) NOT NULL,
|
||||||
|
applied_at VARCHAR(64) NOT NULL
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_applied_revisions(connection: Connection) -> set[str]:
|
||||||
|
"""Return applied migration revision IDs."""
|
||||||
|
_ensure_history_table(connection)
|
||||||
|
rows = connection.execute(text("SELECT revision_id FROM schema_migration_history")).fetchall()
|
||||||
|
return {row[0] for row in rows}
|
||||||
|
|
||||||
|
|
||||||
|
def _record_revision(connection: Connection, revision: MigrationRevision) -> None:
|
||||||
|
"""Persist one applied migration revision record."""
|
||||||
|
connection.execute(
|
||||||
|
text(
|
||||||
|
"""
|
||||||
|
INSERT INTO schema_migration_history (revision_id, description, applied_at)
|
||||||
|
VALUES (:revision_id, :description, :applied_at)
|
||||||
|
"""
|
||||||
|
),
|
||||||
|
{
|
||||||
|
"revision_id": revision.revision_id,
|
||||||
|
"description": revision.description,
|
||||||
|
"applied_at": datetime.now(UTC).isoformat(),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_0001_add_retry_count(connection: Connection) -> None:
|
||||||
|
"""Ensure job.retry_count exists for legacy databases."""
|
||||||
|
inspector = inspect(connection)
|
||||||
|
table_names = set(inspector.get_table_names())
|
||||||
|
if "job" not in table_names:
|
||||||
|
return
|
||||||
|
|
||||||
|
columns = {column["name"] for column in inspector.get_columns("job")}
|
||||||
|
if "retry_count" in columns:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Compatible with SQLite and PostgreSQL for this additive integer column.
|
||||||
|
connection.execute(text("ALTER TABLE job ADD COLUMN retry_count INTEGER NOT NULL DEFAULT 0"))
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_0002_create_transcriptrevision(connection: Connection) -> None:
|
||||||
|
"""Ensure transcriptrevision table exists."""
|
||||||
|
# Import models lazily so metadata is fully populated.
|
||||||
|
from sqlmodel import SQLModel
|
||||||
|
|
||||||
|
from transcription.models import TranscriptRevision # noqa: F401
|
||||||
|
|
||||||
|
table = SQLModel.metadata.tables["transcriptrevision"]
|
||||||
|
table.create(bind=connection, checkfirst=True)
|
||||||
|
|
||||||
|
|
||||||
|
MIGRATIONS: tuple[MigrationRevision, ...] = (
|
||||||
|
MigrationRevision(
|
||||||
|
revision_id="0001_add_retry_count_to_job",
|
||||||
|
description="Add retry_count column to job table with default 0",
|
||||||
|
apply=_apply_0001_add_retry_count,
|
||||||
|
),
|
||||||
|
MigrationRevision(
|
||||||
|
revision_id="0002_create_transcriptrevision_table",
|
||||||
|
description="Create transcriptrevision table for immutable transcript history",
|
||||||
|
apply=_apply_0002_create_transcriptrevision,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def list_pending_migrations(*, engine: Engine) -> list[MigrationRevision]:
|
||||||
|
"""Return pending migrations ordered by revision."""
|
||||||
|
with engine.begin() as connection:
|
||||||
|
applied = _get_applied_revisions(connection)
|
||||||
|
return [revision for revision in MIGRATIONS if revision.revision_id not in applied]
|
||||||
|
|
||||||
|
|
||||||
|
def apply_pending_migrations(*, engine: Engine) -> list[str]:
|
||||||
|
"""Apply all pending migrations and return applied revision IDs."""
|
||||||
|
pending = list_pending_migrations(engine=engine)
|
||||||
|
applied_ids: list[str] = []
|
||||||
|
|
||||||
|
for revision in pending:
|
||||||
|
logger.info("Applying migration revision=%s", revision.revision_id)
|
||||||
|
with engine.begin() as connection:
|
||||||
|
_ensure_history_table(connection)
|
||||||
|
revision.apply(connection)
|
||||||
|
_record_revision(connection, revision)
|
||||||
|
applied_ids.append(revision.revision_id)
|
||||||
|
logger.info("Applied migration revision=%s", revision.revision_id)
|
||||||
|
|
||||||
|
return applied_ids
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
"""SQLModel domain models for the transcription system."""
|
||||||
|
|
||||||
|
from datetime import UTC
|
||||||
|
from datetime import datetime
|
||||||
|
from enum import StrEnum
|
||||||
|
from typing import Optional
|
||||||
|
from uuid import UUID
|
||||||
|
from uuid import uuid4
|
||||||
|
|
||||||
|
from sqlmodel import Field
|
||||||
|
from sqlmodel import Relationship
|
||||||
|
from sqlmodel import SQLModel
|
||||||
|
|
||||||
|
|
||||||
|
class JobStatus(StrEnum):
|
||||||
|
QUEUED = "queued"
|
||||||
|
PROCESSING = "processing"
|
||||||
|
TRANSCRIBED = "transcribed"
|
||||||
|
COMPLETED = "completed"
|
||||||
|
FAILED = "failed"
|
||||||
|
|
||||||
|
|
||||||
|
class Document(SQLModel, table=True):
|
||||||
|
"""An uploaded document image."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
filename: str
|
||||||
|
file_path: str
|
||||||
|
uploaded_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
jobs: list["Job"] = Relationship(back_populates="document")
|
||||||
|
|
||||||
|
|
||||||
|
class Job(SQLModel, table=True):
|
||||||
|
"""A transcription job tied to a single document."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
document_id: UUID = Field(foreign_key="document.id")
|
||||||
|
status: JobStatus = Field(default=JobStatus.QUEUED)
|
||||||
|
retry_count: int = Field(default=0, ge=0)
|
||||||
|
created_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
||||||
|
updated_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
document: Document = Relationship(back_populates="jobs")
|
||||||
|
transcript: Optional["Transcript"] = Relationship(back_populates="job")
|
||||||
|
revisions: list["TranscriptRevision"] = Relationship(back_populates="job")
|
||||||
|
|
||||||
|
|
||||||
|
class Transcript(SQLModel, table=True):
|
||||||
|
"""Canonical transcript state for a job (latest text or failure detail)."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
job_id: UUID = Field(foreign_key="job.id", unique=True)
|
||||||
|
text: str | None = None
|
||||||
|
error_detail: str | None = None
|
||||||
|
created_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
job: Job = Relationship(back_populates="transcript")
|
||||||
|
|
||||||
|
|
||||||
|
class TranscriptRevision(SQLModel, table=True):
|
||||||
|
"""Immutable transcript revision history for review/acceptance workflows."""
|
||||||
|
|
||||||
|
id: UUID = Field(default_factory=uuid4, primary_key=True)
|
||||||
|
job_id: UUID = Field(foreign_key="job.id", index=True)
|
||||||
|
revision_number: int = Field(ge=1)
|
||||||
|
text: str
|
||||||
|
source: str = Field(default="worker")
|
||||||
|
accepted: bool = Field(default=False)
|
||||||
|
created_at: datetime = Field(default_factory=lambda: datetime.now(UTC))
|
||||||
|
|
||||||
|
# --- relationships ---
|
||||||
|
job: Job = Relationship(back_populates="revisions")
|
||||||
@@ -22,17 +22,11 @@ class TranscriptionResult:
|
|||||||
|
|
||||||
text: str
|
text: str
|
||||||
provider: str
|
provider: str
|
||||||
prompt_name: str
|
|
||||||
model: str
|
model: str
|
||||||
finish_reason: str | None = None
|
|
||||||
usage_input_tokens: int | None = None
|
|
||||||
usage_output_tokens: int | None = None
|
|
||||||
usage_total_tokens: int | None = None
|
|
||||||
|
|
||||||
|
|
||||||
class TranscriptionProvider(Protocol):
|
class TranscriptionProvider(Protocol):
|
||||||
"""Contract every transcription provider adapter must satisfy."""
|
"""Contract every transcription provider adapter must satisfy."""
|
||||||
|
|
||||||
async def transcribe(self, *, prompt_text: str, image_bytes: bytes, mime_type: str) -> TranscriptionResult:
|
def transcribe(self, *, prompt_text: str, image_bytes: bytes, mime_type: str) -> TranscriptionResult:
|
||||||
"""Transcribe the provided image according to the prompt text."""
|
"""Transcribe the provided image according to the prompt text."""
|
||||||
...
|
|
||||||
|
|||||||
@@ -6,10 +6,8 @@ import base64
|
|||||||
import logging
|
import logging
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from typing import cast
|
|
||||||
|
|
||||||
from openrouter import OpenRouter
|
from openrouter import OpenRouter
|
||||||
from openrouter.components.chatmessages import ChatMessagesTypedDict
|
|
||||||
|
|
||||||
from transcription.config import Settings
|
from transcription.config import Settings
|
||||||
from transcription.config import get_settings
|
from transcription.config import get_settings
|
||||||
@@ -46,12 +44,12 @@ class OpenRouterTranscriptionProvider:
|
|||||||
"""Return the resolved OpenRouter model slug."""
|
"""Return the resolved OpenRouter model slug."""
|
||||||
return self._model
|
return self._model
|
||||||
|
|
||||||
async def transcribe(self, *, prompt_text: str, image_bytes: bytes, mime_type: str) -> TranscriptionResult:
|
def transcribe(self, *, prompt_text: str, image_bytes: bytes, mime_type: str) -> TranscriptionResult:
|
||||||
"""Send prompt + image to OpenRouter and return normalized text output."""
|
"""Send prompt + image to OpenRouter and return normalized text output."""
|
||||||
request = self._build_request(prompt_text=prompt_text, image_bytes=image_bytes, mime_type=mime_type)
|
request = self._build_request(prompt_text=prompt_text, image_bytes=image_bytes, mime_type=mime_type)
|
||||||
try:
|
try:
|
||||||
response = await self._client.chat.send_async(
|
response = self._client.chat.send(
|
||||||
messages=cast(list[ChatMessagesTypedDict], request.messages),
|
messages=request.messages,
|
||||||
model=request.model,
|
model=request.model,
|
||||||
http_referer=request.http_referer,
|
http_referer=request.http_referer,
|
||||||
x_open_router_title=request.x_open_router_title,
|
x_open_router_title=request.x_open_router_title,
|
||||||
@@ -64,19 +62,8 @@ class OpenRouterTranscriptionProvider:
|
|||||||
|
|
||||||
text = self._extract_text(response)
|
text = self._extract_text(response)
|
||||||
model = self._get_optional_attr(response, "model") or self.model
|
model = self._get_optional_attr(response, "model") or self.model
|
||||||
finish_reason = self._extract_finish_reason(response)
|
|
||||||
usage_input_tokens, usage_output_tokens, usage_total_tokens = self._extract_usage(response)
|
|
||||||
logger.info("OpenRouter transcription completed using model=%s", model)
|
logger.info("OpenRouter transcription completed using model=%s", model)
|
||||||
return TranscriptionResult(
|
return TranscriptionResult(text=text, provider="openrouter", model=model)
|
||||||
text=text,
|
|
||||||
provider="openrouter",
|
|
||||||
prompt_name="",
|
|
||||||
model=model,
|
|
||||||
finish_reason=finish_reason,
|
|
||||||
usage_input_tokens=usage_input_tokens,
|
|
||||||
usage_output_tokens=usage_output_tokens,
|
|
||||||
usage_total_tokens=usage_total_tokens,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _build_request(self, *, prompt_text: str, image_bytes: bytes, mime_type: str) -> OpenRouterRequest:
|
def _build_request(self, *, prompt_text: str, image_bytes: bytes, mime_type: str) -> OpenRouterRequest:
|
||||||
image_b64 = base64.b64encode(image_bytes).decode("ascii")
|
image_b64 = base64.b64encode(image_bytes).decode("ascii")
|
||||||
@@ -115,34 +102,6 @@ class OpenRouterTranscriptionProvider:
|
|||||||
raise ProviderResponseError("OpenRouter response contained no transcription text")
|
raise ProviderResponseError("OpenRouter response contained no transcription text")
|
||||||
return text
|
return text
|
||||||
|
|
||||||
def _extract_finish_reason(self, response: Any) -> str | None:
|
|
||||||
choices = self._get_optional_attr(response, "choices")
|
|
||||||
if not choices:
|
|
||||||
return None
|
|
||||||
first_choice = choices[0]
|
|
||||||
finish_reason = self._get_optional_attr(first_choice, "finish_reason")
|
|
||||||
if isinstance(finish_reason, str) and finish_reason.strip():
|
|
||||||
return finish_reason.strip()
|
|
||||||
return None
|
|
||||||
|
|
||||||
def _extract_usage(self, response: Any) -> tuple[int | None, int | None, int | None]:
|
|
||||||
usage = self._get_optional_attr(response, "usage")
|
|
||||||
if usage is None:
|
|
||||||
return None, None, None
|
|
||||||
|
|
||||||
input_tokens = self._as_int(self._get_optional_attr(usage, "prompt_tokens"))
|
|
||||||
output_tokens = self._as_int(self._get_optional_attr(usage, "completion_tokens"))
|
|
||||||
total_tokens = self._as_int(self._get_optional_attr(usage, "total_tokens"))
|
|
||||||
|
|
||||||
if input_tokens is None:
|
|
||||||
input_tokens = self._as_int(self._get_optional_attr(usage, "input_tokens"))
|
|
||||||
if output_tokens is None:
|
|
||||||
output_tokens = self._as_int(self._get_optional_attr(usage, "output_tokens"))
|
|
||||||
if total_tokens is None:
|
|
||||||
total_tokens = self._as_int(self._get_optional_attr(usage, "total"))
|
|
||||||
|
|
||||||
return input_tokens, output_tokens, total_tokens
|
|
||||||
|
|
||||||
def _normalize_content(self, content: Any) -> str:
|
def _normalize_content(self, content: Any) -> str:
|
||||||
if isinstance(content, str):
|
if isinstance(content, str):
|
||||||
return content.strip()
|
return content.strip()
|
||||||
@@ -166,9 +125,3 @@ class OpenRouterTranscriptionProvider:
|
|||||||
if isinstance(obj, dict):
|
if isinstance(obj, dict):
|
||||||
return obj.get(key)
|
return obj.get(key)
|
||||||
return getattr(obj, key, None)
|
return getattr(obj, key, None)
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _as_int(value: Any) -> int | None:
|
|
||||||
if isinstance(value, int):
|
|
||||||
return value
|
|
||||||
return None
|
|
||||||
|
|||||||
@@ -0,0 +1,82 @@
|
|||||||
|
"""Step 5 single-operator access control helpers."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import binascii
|
||||||
|
import secrets
|
||||||
|
|
||||||
|
from fastapi import Request
|
||||||
|
|
||||||
|
from transcription.config import Settings
|
||||||
|
from transcription.errors import AppError
|
||||||
|
from transcription.errors import ErrorCategory
|
||||||
|
|
||||||
|
|
||||||
|
class AccessDeniedError(AppError):
|
||||||
|
"""Raised when a request is not authorized for operator actions."""
|
||||||
|
|
||||||
|
def __init__(self, message: str, *, suggestion: str, should_challenge: bool = True) -> None:
|
||||||
|
super().__init__(message, category=ErrorCategory.USER_INPUT, suggestion=suggestion)
|
||||||
|
self.should_challenge = should_challenge
|
||||||
|
|
||||||
|
|
||||||
|
def is_protected_path(path: str) -> bool:
|
||||||
|
"""Return True when a request path requires operator authentication."""
|
||||||
|
return path == "/ui" or path.startswith(("/ui/", "/api"))
|
||||||
|
|
||||||
|
|
||||||
|
def enforce_request_access(*, request: Request, settings: Settings) -> None:
|
||||||
|
"""Enforce basic operator access control for protected paths."""
|
||||||
|
if not settings.operator_access_enabled or not is_protected_path(request.url.path):
|
||||||
|
return
|
||||||
|
|
||||||
|
if not settings.operator_password:
|
||||||
|
raise AppError(
|
||||||
|
"Operator authentication is enabled but credentials are not configured",
|
||||||
|
category=ErrorCategory.INFRA_PERSISTENT,
|
||||||
|
suggestion="Set OPERATOR_PASSWORD in the runtime environment and restart the app.",
|
||||||
|
)
|
||||||
|
|
||||||
|
authorization = request.headers.get("Authorization")
|
||||||
|
username, password = _parse_basic_authorization_header(authorization)
|
||||||
|
|
||||||
|
valid_username = secrets.compare_digest(username, settings.operator_username)
|
||||||
|
valid_password = secrets.compare_digest(password, settings.operator_password)
|
||||||
|
if not (valid_username and valid_password):
|
||||||
|
raise AccessDeniedError(
|
||||||
|
"Invalid operator credentials",
|
||||||
|
suggestion="Provide valid operator credentials and retry.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_basic_authorization_header(value: str | None) -> tuple[str, str]:
|
||||||
|
if not value:
|
||||||
|
raise AccessDeniedError(
|
||||||
|
"Operator authentication required",
|
||||||
|
suggestion="Provide HTTP Basic operator credentials and retry.",
|
||||||
|
)
|
||||||
|
|
||||||
|
scheme, _, token = value.partition(" ")
|
||||||
|
if scheme.lower() != "basic" or not token:
|
||||||
|
raise AccessDeniedError(
|
||||||
|
"Operator authentication required",
|
||||||
|
suggestion="Provide HTTP Basic operator credentials and retry.",
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
decoded = base64.b64decode(token, validate=True).decode("utf-8")
|
||||||
|
except (binascii.Error, UnicodeDecodeError) as exc:
|
||||||
|
raise AccessDeniedError(
|
||||||
|
"Invalid authentication header",
|
||||||
|
suggestion="Provide HTTP Basic operator credentials and retry.",
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
username, sep, password = decoded.partition(":")
|
||||||
|
if not sep or not username:
|
||||||
|
raise AccessDeniedError(
|
||||||
|
"Invalid authentication header",
|
||||||
|
suggestion="Provide HTTP Basic operator credentials and retry.",
|
||||||
|
)
|
||||||
|
|
||||||
|
return username, password
|
||||||
@@ -1,19 +1,25 @@
|
|||||||
"""Service layer exports."""
|
"""Service layer exports."""
|
||||||
|
|
||||||
from dataclasses import dataclass
|
from transcription.services.transcription import DEFAULT_PROMPT_FILE
|
||||||
from dataclasses import field
|
from transcription.services.transcription import PromptLoadError
|
||||||
|
from transcription.services.transcription import TranscriptionError
|
||||||
|
from transcription.services.transcription import load_image_payload
|
||||||
|
from transcription.services.transcription import load_prompt_text
|
||||||
|
from transcription.services.transcription import transcribe_document_image
|
||||||
|
from transcription.services.upload import SUPPORTED_UPLOAD_EXTENSIONS
|
||||||
|
from transcription.services.upload import UploadError
|
||||||
|
from transcription.services.upload import UploadJobResult
|
||||||
|
from transcription.services.upload import create_upload_job
|
||||||
|
|
||||||
from .documents import DocumentService
|
__all__ = [
|
||||||
from .jobs import JobService
|
"DEFAULT_PROMPT_FILE",
|
||||||
from .transcription import TranscriptionService
|
"SUPPORTED_UPLOAD_EXTENSIONS",
|
||||||
|
"PromptLoadError",
|
||||||
__all__ = ["DocumentService", "JobService", "ServiceBundle", "TranscriptionService"]
|
"TranscriptionError",
|
||||||
|
"UploadError",
|
||||||
|
"UploadJobResult",
|
||||||
@dataclass(frozen=True, slots=True)
|
"create_upload_job",
|
||||||
class ServiceBundle:
|
"load_image_payload",
|
||||||
"""Container for all service instances."""
|
"load_prompt_text",
|
||||||
|
"transcribe_document_image",
|
||||||
documents: DocumentService = field(default_factory=DocumentService)
|
]
|
||||||
jobs: JobService = field(default_factory=JobService)
|
|
||||||
transcriptions: TranscriptionService = field(default_factory=TranscriptionService)
|
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
import asyncio
|
|
||||||
from abc import ABC
|
|
||||||
from collections.abc import Sequence
|
|
||||||
from contextlib import asynccontextmanager
|
|
||||||
|
|
||||||
from sqlalchemy.ext.asyncio import async_sessionmaker
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from ..config import Settings
|
|
||||||
from ..config import get_settings
|
|
||||||
from ..db.session import resolve_session_factory
|
|
||||||
from ..db.session import session_scope
|
|
||||||
|
|
||||||
|
|
||||||
class ServiceBase(ABC):
|
|
||||||
"""Thin service class for managing documents in the database."""
|
|
||||||
|
|
||||||
settings: Settings
|
|
||||||
session_factory: async_sessionmaker[AsyncSession]
|
|
||||||
queue: asyncio.Queue
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
session_factory: async_sessionmaker[AsyncSession] | None = None,
|
|
||||||
queue: asyncio.Queue | None = None,
|
|
||||||
):
|
|
||||||
self.settings = get_settings()
|
|
||||||
self.session_factory = session_factory or resolve_session_factory()
|
|
||||||
self.queue = queue or asyncio.Queue()
|
|
||||||
|
|
||||||
@asynccontextmanager
|
|
||||||
async def _session_scope(self, session: AsyncSession | None = None):
|
|
||||||
"""Provide a transactional scope around a series of operations."""
|
|
||||||
async with session_scope(session=session) as active_session:
|
|
||||||
yield active_session
|
|
||||||
|
|
||||||
async def _finalize(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
session: AsyncSession,
|
|
||||||
caller_session: AsyncSession | None,
|
|
||||||
refresh: Sequence[object] = (),
|
|
||||||
) -> None:
|
|
||||||
"""Finalize a write based on transaction ownership.
|
|
||||||
|
|
||||||
Service-owned sessions commit immediately. Caller-owned sessions flush so
|
|
||||||
orchestration code can commit once at a larger transaction boundary.
|
|
||||||
"""
|
|
||||||
should_commit = caller_session is None
|
|
||||||
if should_commit:
|
|
||||||
await session.commit()
|
|
||||||
else:
|
|
||||||
await session.flush()
|
|
||||||
|
|
||||||
for obj in refresh:
|
|
||||||
await session.refresh(obj)
|
|
||||||
@@ -1,130 +0,0 @@
|
|||||||
import logging
|
|
||||||
from collections.abc import Sequence
|
|
||||||
from dataclasses import dataclass
|
|
||||||
from pathlib import Path
|
|
||||||
from uuid import UUID
|
|
||||||
|
|
||||||
from sqlalchemy.exc import IntegrityError
|
|
||||||
from sqlalchemy.orm import selectinload
|
|
||||||
from sqlmodel import select
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from ..db.models import Document
|
|
||||||
from ..errors import AppError
|
|
||||||
from ..errors import ErrorCategory
|
|
||||||
from .base import ServiceBase
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentError(AppError):
|
|
||||||
"""Raised when document operations fail."""
|
|
||||||
|
|
||||||
|
|
||||||
class MissingSourceError(DocumentError):
|
|
||||||
"""Raised when a document has no associated sources."""
|
|
||||||
|
|
||||||
|
|
||||||
class UploadError(DocumentError):
|
|
||||||
"""Raised when uploaded content cannot be persisted safely."""
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentAlreadyExistsError(DocumentError):
|
|
||||||
"""Raised when a document with the same name already exists in the database."""
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
|
||||||
class UploadJobResult:
|
|
||||||
"""Summary of created upload records."""
|
|
||||||
|
|
||||||
document_id: UUID
|
|
||||||
job_id: UUID
|
|
||||||
stored_path: Path
|
|
||||||
original_filename: str
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentService(ServiceBase):
|
|
||||||
"""Thin service class for managing documents in the database."""
|
|
||||||
|
|
||||||
#
|
|
||||||
# CRUD Operations
|
|
||||||
#
|
|
||||||
|
|
||||||
async def create_document(
|
|
||||||
self,
|
|
||||||
document: Document,
|
|
||||||
*,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Document:
|
|
||||||
"""Create a new document in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
_session.add(document)
|
|
||||||
try:
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(document,))
|
|
||||||
except IntegrityError as exc:
|
|
||||||
raise DocumentAlreadyExistsError(
|
|
||||||
f"Document with id {document.id} already exists",
|
|
||||||
category=ErrorCategory.VALIDATION,
|
|
||||||
suggestion="Rename the file and try again.",
|
|
||||||
) from exc
|
|
||||||
return document
|
|
||||||
|
|
||||||
async def read_document(self, document_id: UUID, *, session: AsyncSession | None = None) -> Document:
|
|
||||||
"""Read an existing document from the database.
|
|
||||||
|
|
||||||
The selectinload option is used to eagerly load related jobs and sources.
|
|
||||||
"""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
document = await _session.get(
|
|
||||||
Document,
|
|
||||||
document_id,
|
|
||||||
options=(
|
|
||||||
selectinload(Document.jobs), # pyright: ignore[reportArgumentType]
|
|
||||||
selectinload(Document.sources), # pyright: ignore[reportArgumentType]
|
|
||||||
),
|
|
||||||
)
|
|
||||||
if document is None:
|
|
||||||
raise DocumentError(
|
|
||||||
f"Document with id {document_id} not found",
|
|
||||||
category=ErrorCategory.NOT_FOUND,
|
|
||||||
suggestion="Re-upload the source document and retry.",
|
|
||||||
)
|
|
||||||
elif not document.sources:
|
|
||||||
raise MissingSourceError(
|
|
||||||
f"Document with id {document_id} has no associated source records",
|
|
||||||
category=ErrorCategory.NOT_FOUND,
|
|
||||||
suggestion="Upload at least one source for this document and retry.",
|
|
||||||
)
|
|
||||||
return document
|
|
||||||
|
|
||||||
async def update_document(self, document: Document, *, session: AsyncSession | None = None) -> Document:
|
|
||||||
"""Update an existing document in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
merged = await _session.merge(document)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(merged,))
|
|
||||||
return merged
|
|
||||||
|
|
||||||
async def delete_document(self, document: Document, *, session: AsyncSession | None = None) -> None:
|
|
||||||
"""Delete a document from the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
await _session.delete(document)
|
|
||||||
await self._finalize(session=_session, caller_session=session)
|
|
||||||
|
|
||||||
# Query Operations
|
|
||||||
|
|
||||||
async def query_documents(
|
|
||||||
self, *, name: str | None = None, session: AsyncSession | None = None
|
|
||||||
) -> Sequence[Document]:
|
|
||||||
"""Query documents from the database based on provided filters."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = select(Document)
|
|
||||||
if name is not None:
|
|
||||||
query = query.where(Document.name == name)
|
|
||||||
result = await _session.exec(query)
|
|
||||||
return result.all()
|
|
||||||
|
|
||||||
async def list_documents(self, *, session: AsyncSession | None = None) -> Sequence[Document]:
|
|
||||||
"""List all documents in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
result = await _session.exec(select(Document))
|
|
||||||
return result.all()
|
|
||||||
@@ -1,184 +0,0 @@
|
|||||||
from collections.abc import Sequence
|
|
||||||
from datetime import UTC
|
|
||||||
from datetime import datetime
|
|
||||||
from uuid import UUID
|
|
||||||
|
|
||||||
from sqlalchemy.orm import selectinload
|
|
||||||
from sqlmodel import select
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from ..db.models import Job
|
|
||||||
from ..db.models import JobStatus
|
|
||||||
from ..db.models import Source
|
|
||||||
from .base import ServiceBase
|
|
||||||
|
|
||||||
|
|
||||||
class JobService(ServiceBase):
|
|
||||||
"""Thin service class for managing jobs in the database."""
|
|
||||||
|
|
||||||
#
|
|
||||||
# CRUD Operations
|
|
||||||
#
|
|
||||||
|
|
||||||
async def create_job(self, job: Job, session: AsyncSession | None = None) -> Job:
|
|
||||||
"""Create a new job in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
_session.add(job)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(job,))
|
|
||||||
return job
|
|
||||||
|
|
||||||
async def read_job(self, job_id: UUID, session: AsyncSession | None = None) -> Job:
|
|
||||||
"""Read an existing job from the database.
|
|
||||||
|
|
||||||
The related document is always eagerly loaded so callers can safely
|
|
||||||
access ``job.document`` in async contexts without triggering lazy-load IO.
|
|
||||||
"""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = (
|
|
||||||
select(Job)
|
|
||||||
.options(
|
|
||||||
selectinload(Job.document), # pyright: ignore[reportArgumentType]
|
|
||||||
selectinload(Job.sources).selectinload(Source.revision), # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
.where(Job.id == job_id)
|
|
||||||
.execution_options(populate_existing=True)
|
|
||||||
)
|
|
||||||
job = (await _session.exec(query)).first()
|
|
||||||
if job is None:
|
|
||||||
raise ValueError(f"Job with id {job_id} not found")
|
|
||||||
return job
|
|
||||||
|
|
||||||
async def update_job(self, job: Job, session: AsyncSession | None = None) -> Job:
|
|
||||||
"""Update an existing job in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
merged = await _session.merge(job)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(merged,))
|
|
||||||
return merged
|
|
||||||
|
|
||||||
async def delete_job(self, job: Job, session: AsyncSession | None = None) -> None:
|
|
||||||
"""Delete a job from the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
await _session.delete(job)
|
|
||||||
await self._finalize(session=_session, caller_session=session)
|
|
||||||
|
|
||||||
# Query Operations
|
|
||||||
|
|
||||||
async def query_jobs(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
status: JobStatus | None = None,
|
|
||||||
filename: str | None = None,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Sequence[Job]:
|
|
||||||
"""Query jobs from the database based on provided filters."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = select(Job).options(
|
|
||||||
selectinload(Job.document), # pyright: ignore[reportArgumentType]
|
|
||||||
selectinload(Job.sources), # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
if status is not None:
|
|
||||||
query = query.where(Job.status == status)
|
|
||||||
if filename is not None:
|
|
||||||
query = query.where(Job.sources.any(Source.filename == filename))
|
|
||||||
result = await _session.exec(query)
|
|
||||||
return result.all()
|
|
||||||
|
|
||||||
async def list_jobs(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
load_docs: bool = False,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Sequence[Job]:
|
|
||||||
"""List all jobs in the database with eagerly loaded documents."""
|
|
||||||
_ = load_docs
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = select(Job).options(
|
|
||||||
selectinload(Job.document), # pyright: ignore[reportArgumentType]
|
|
||||||
selectinload(Job.sources), # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
result = await _session.exec(query)
|
|
||||||
return result.all()
|
|
||||||
|
|
||||||
# Other Operations
|
|
||||||
|
|
||||||
async def mark_job_status(
|
|
||||||
self,
|
|
||||||
job_id: UUID,
|
|
||||||
status: JobStatus,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job:
|
|
||||||
"""Mark a job with a new status."""
|
|
||||||
return await self.update_job_state(job_id=job_id, status=status, session=session)
|
|
||||||
|
|
||||||
async def update_job_state(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
job_id: UUID,
|
|
||||||
status: JobStatus,
|
|
||||||
retry_count_increment: int = 0,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job:
|
|
||||||
"""Update a job's lifecycle fields.
|
|
||||||
|
|
||||||
When ``session`` is provided, this method flushes so callers can commit
|
|
||||||
once at an orchestration boundary.
|
|
||||||
"""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = (
|
|
||||||
select(Job)
|
|
||||||
.options(selectinload(Job.document)) # pyright: ignore[reportArgumentType]
|
|
||||||
.where(Job.id == job_id)
|
|
||||||
.execution_options(populate_existing=True)
|
|
||||||
)
|
|
||||||
job = (await _session.exec(query)).first()
|
|
||||||
if job is None:
|
|
||||||
raise ValueError(f"Job with id {job_id} not found")
|
|
||||||
job.status = status
|
|
||||||
if retry_count_increment:
|
|
||||||
job.retry_count += retry_count_increment
|
|
||||||
job.date_updated = datetime.now(UTC)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(job,))
|
|
||||||
return job
|
|
||||||
|
|
||||||
async def read_next_queued_job(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job | None:
|
|
||||||
"""Read the next queued job ordered by creation time."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = (
|
|
||||||
select(Job)
|
|
||||||
.options(
|
|
||||||
selectinload(Job.document), # pyright: ignore[reportArgumentType]
|
|
||||||
selectinload(Job.sources).selectinload(Source.revision), # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
.where(Job.status == JobStatus.QUEUED)
|
|
||||||
.order_by(Job.date_created) # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
return (await _session.exec(query)).first()
|
|
||||||
|
|
||||||
async def requeue_stale_processing_jobs(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
stale_before: datetime,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> int:
|
|
||||||
"""Move stale processing jobs back to queued state.
|
|
||||||
|
|
||||||
Jobs with ``status=PROCESSING`` and ``date_updated`` older than
|
|
||||||
``stale_before`` are considered stale and re-queued.
|
|
||||||
"""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = select(Job).where(Job.status == JobStatus.PROCESSING).where(Job.date_updated < stale_before)
|
|
||||||
stale_jobs = (await _session.exec(query)).all()
|
|
||||||
if not stale_jobs:
|
|
||||||
return 0
|
|
||||||
|
|
||||||
now = datetime.now(UTC)
|
|
||||||
for job in stale_jobs:
|
|
||||||
job.status = JobStatus.QUEUED
|
|
||||||
job.date_updated = now
|
|
||||||
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=stale_jobs)
|
|
||||||
return len(stale_jobs)
|
|
||||||
@@ -0,0 +1,264 @@
|
|||||||
|
"""Step 3 functional services: job detail, revisions, search, and export."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import UTC
|
||||||
|
from datetime import datetime
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
from sqlmodel import Session
|
||||||
|
from sqlmodel import select
|
||||||
|
|
||||||
|
from transcription.db import get_session
|
||||||
|
from transcription.errors import AppError
|
||||||
|
from transcription.errors import ErrorCategory
|
||||||
|
from transcription.models import Document
|
||||||
|
from transcription.models import Job
|
||||||
|
from transcription.models import JobStatus
|
||||||
|
from transcription.models import Transcript
|
||||||
|
from transcription.models import TranscriptRevision
|
||||||
|
|
||||||
|
|
||||||
|
class LibraryError(AppError):
|
||||||
|
"""Base error for review/search/export service pathways."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class JobDetail:
|
||||||
|
"""Job detail read model including latest transcript and accepted revision."""
|
||||||
|
|
||||||
|
job: Job
|
||||||
|
document: Document | None
|
||||||
|
transcript: Transcript | None
|
||||||
|
accepted_revision: TranscriptRevision | None
|
||||||
|
|
||||||
|
|
||||||
|
def list_jobs(*, session: Session | None = None) -> list[Job]:
|
||||||
|
"""Return jobs in most-recent-first order."""
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return list_jobs(session=local_session)
|
||||||
|
|
||||||
|
return list(session.exec(select(Job).order_by(Job.created_at.desc())).all())
|
||||||
|
|
||||||
|
|
||||||
|
def get_job_detail(*, job_id: UUID, session: Session | None = None) -> JobDetail:
|
||||||
|
"""Fetch job detail with related document/transcript and accepted revision."""
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return get_job_detail(job_id=job_id, session=local_session)
|
||||||
|
|
||||||
|
job = session.get(Job, job_id)
|
||||||
|
if job is None:
|
||||||
|
raise LibraryError(
|
||||||
|
f"Job not found: {job_id}",
|
||||||
|
category=ErrorCategory.NOT_FOUND,
|
||||||
|
suggestion="Refresh jobs list and open a valid job id.",
|
||||||
|
)
|
||||||
|
|
||||||
|
document = session.get(Document, job.document_id)
|
||||||
|
transcript = session.exec(select(Transcript).where(Transcript.job_id == job.id)).first()
|
||||||
|
accepted_revision = session.exec(
|
||||||
|
select(TranscriptRevision)
|
||||||
|
.where(TranscriptRevision.job_id == job.id, TranscriptRevision.accepted.is_(True))
|
||||||
|
.order_by(TranscriptRevision.revision_number.desc())
|
||||||
|
).first()
|
||||||
|
|
||||||
|
return JobDetail(
|
||||||
|
job=job,
|
||||||
|
document=document,
|
||||||
|
transcript=transcript,
|
||||||
|
accepted_revision=accepted_revision,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def add_revision(
|
||||||
|
*,
|
||||||
|
job_id: UUID,
|
||||||
|
text: str,
|
||||||
|
source: str = "user",
|
||||||
|
accepted: bool = False,
|
||||||
|
session: Session | None = None,
|
||||||
|
) -> TranscriptRevision:
|
||||||
|
"""Append a transcript revision and optionally mark it as accepted."""
|
||||||
|
if not text.strip():
|
||||||
|
raise LibraryError(
|
||||||
|
"Revision text cannot be empty",
|
||||||
|
category=ErrorCategory.VALIDATION,
|
||||||
|
suggestion="Provide non-empty transcript text and retry.",
|
||||||
|
)
|
||||||
|
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return add_revision(
|
||||||
|
job_id=job_id,
|
||||||
|
text=text,
|
||||||
|
source=source,
|
||||||
|
accepted=accepted,
|
||||||
|
session=local_session,
|
||||||
|
)
|
||||||
|
|
||||||
|
job = session.get(Job, job_id)
|
||||||
|
if job is None:
|
||||||
|
raise LibraryError(
|
||||||
|
f"Job not found: {job_id}",
|
||||||
|
category=ErrorCategory.NOT_FOUND,
|
||||||
|
suggestion="Refresh jobs list and retry with a valid job id.",
|
||||||
|
)
|
||||||
|
|
||||||
|
revisions = list(
|
||||||
|
session.exec(
|
||||||
|
select(TranscriptRevision)
|
||||||
|
.where(TranscriptRevision.job_id == job_id)
|
||||||
|
.order_by(TranscriptRevision.revision_number)
|
||||||
|
).all()
|
||||||
|
)
|
||||||
|
next_revision_number = (revisions[-1].revision_number + 1) if revisions else 1
|
||||||
|
|
||||||
|
if accepted:
|
||||||
|
for existing in revisions:
|
||||||
|
if existing.accepted:
|
||||||
|
existing.accepted = False
|
||||||
|
session.add(existing)
|
||||||
|
|
||||||
|
revision = TranscriptRevision(
|
||||||
|
job_id=job_id,
|
||||||
|
revision_number=next_revision_number,
|
||||||
|
text=text,
|
||||||
|
source=source,
|
||||||
|
accepted=accepted,
|
||||||
|
)
|
||||||
|
session.add(revision)
|
||||||
|
|
||||||
|
transcript = session.exec(select(Transcript).where(Transcript.job_id == job_id)).first()
|
||||||
|
if transcript is None:
|
||||||
|
transcript = Transcript(job_id=job_id)
|
||||||
|
|
||||||
|
transcript.text = text
|
||||||
|
transcript.error_detail = None
|
||||||
|
session.add(transcript)
|
||||||
|
|
||||||
|
job.updated_at = datetime.now(UTC)
|
||||||
|
if accepted:
|
||||||
|
job.status = JobStatus.COMPLETED
|
||||||
|
elif job.status == JobStatus.QUEUED:
|
||||||
|
job.status = JobStatus.TRANSCRIBED
|
||||||
|
session.add(job)
|
||||||
|
|
||||||
|
session.commit()
|
||||||
|
session.refresh(revision)
|
||||||
|
return revision
|
||||||
|
|
||||||
|
|
||||||
|
def accept_revision(*, revision_id: UUID, session: Session | None = None) -> TranscriptRevision:
|
||||||
|
"""Mark one revision as accepted and synchronize canonical transcript/job state."""
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return accept_revision(revision_id=revision_id, session=local_session)
|
||||||
|
|
||||||
|
revision = session.get(TranscriptRevision, revision_id)
|
||||||
|
if revision is None:
|
||||||
|
raise LibraryError(
|
||||||
|
f"Revision not found: {revision_id}",
|
||||||
|
category=ErrorCategory.NOT_FOUND,
|
||||||
|
suggestion="Refresh job detail and select a valid revision.",
|
||||||
|
)
|
||||||
|
|
||||||
|
all_revisions = list(session.exec(select(TranscriptRevision).where(TranscriptRevision.job_id == revision.job_id)).all())
|
||||||
|
for item in all_revisions:
|
||||||
|
item.accepted = item.id == revision.id
|
||||||
|
session.add(item)
|
||||||
|
|
||||||
|
transcript = session.exec(select(Transcript).where(Transcript.job_id == revision.job_id)).first()
|
||||||
|
if transcript is None:
|
||||||
|
transcript = Transcript(job_id=revision.job_id)
|
||||||
|
|
||||||
|
transcript.text = revision.text
|
||||||
|
transcript.error_detail = None
|
||||||
|
session.add(transcript)
|
||||||
|
|
||||||
|
job = session.get(Job, revision.job_id)
|
||||||
|
if job is not None:
|
||||||
|
job.status = JobStatus.COMPLETED
|
||||||
|
job.updated_at = datetime.now(UTC)
|
||||||
|
session.add(job)
|
||||||
|
|
||||||
|
session.commit()
|
||||||
|
session.refresh(revision)
|
||||||
|
return revision
|
||||||
|
|
||||||
|
|
||||||
|
def list_revisions(*, job_id: UUID, session: Session | None = None) -> list[TranscriptRevision]:
|
||||||
|
"""Return revision history for a job in ascending revision order."""
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return list_revisions(job_id=job_id, session=local_session)
|
||||||
|
|
||||||
|
if session.get(Job, job_id) is None:
|
||||||
|
raise LibraryError(
|
||||||
|
f"Job not found: {job_id}",
|
||||||
|
category=ErrorCategory.NOT_FOUND,
|
||||||
|
suggestion="Refresh jobs list and open a valid job id.",
|
||||||
|
)
|
||||||
|
|
||||||
|
return list(
|
||||||
|
session.exec(
|
||||||
|
select(TranscriptRevision)
|
||||||
|
.where(TranscriptRevision.job_id == job_id)
|
||||||
|
.order_by(TranscriptRevision.revision_number)
|
||||||
|
).all()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def search_accepted_transcripts(*, query: str, session: Session | None = None) -> list[TranscriptRevision]:
|
||||||
|
"""Search accepted transcript revisions using case-insensitive text containment."""
|
||||||
|
if not query.strip():
|
||||||
|
raise LibraryError(
|
||||||
|
"Search query cannot be empty",
|
||||||
|
category=ErrorCategory.VALIDATION,
|
||||||
|
suggestion="Enter a non-empty search query and retry.",
|
||||||
|
)
|
||||||
|
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return search_accepted_transcripts(query=query, session=local_session)
|
||||||
|
|
||||||
|
pattern = f"%{query.strip()}%"
|
||||||
|
return list(
|
||||||
|
session.exec(
|
||||||
|
select(TranscriptRevision)
|
||||||
|
.where(TranscriptRevision.accepted.is_(True), TranscriptRevision.text.ilike(pattern))
|
||||||
|
.order_by(TranscriptRevision.created_at.desc())
|
||||||
|
).all()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def export_transcripts(*, accepted_only: bool = True, session: Session | None = None) -> list[dict[str, str | int | None]]:
|
||||||
|
"""Export transcript data as serializable records for archive workflows."""
|
||||||
|
if session is None:
|
||||||
|
with get_session() as local_session:
|
||||||
|
return export_transcripts(accepted_only=accepted_only, session=local_session)
|
||||||
|
|
||||||
|
statement = select(TranscriptRevision).order_by(TranscriptRevision.created_at)
|
||||||
|
if accepted_only:
|
||||||
|
statement = statement.where(TranscriptRevision.accepted.is_(True))
|
||||||
|
|
||||||
|
revisions = list(session.exec(statement).all())
|
||||||
|
payload: list[dict[str, str | int | None]] = []
|
||||||
|
for revision in revisions:
|
||||||
|
detail = get_job_detail(job_id=revision.job_id, session=session)
|
||||||
|
payload.append(
|
||||||
|
{
|
||||||
|
"job_id": str(revision.job_id),
|
||||||
|
"document_id": str(detail.job.document_id),
|
||||||
|
"filename": detail.document.filename if detail.document else None,
|
||||||
|
"revision_id": str(revision.id),
|
||||||
|
"revision_number": revision.revision_number,
|
||||||
|
"accepted": revision.accepted,
|
||||||
|
"source": revision.source,
|
||||||
|
"text": revision.text,
|
||||||
|
"created_at": revision.created_at.isoformat(),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return payload
|
||||||
@@ -4,23 +4,10 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import logging
|
import logging
|
||||||
import mimetypes
|
import mimetypes
|
||||||
from collections.abc import Sequence
|
|
||||||
from contextlib import contextmanager
|
|
||||||
from datetime import UTC
|
|
||||||
from datetime import datetime
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from uuid import UUID
|
|
||||||
|
|
||||||
from sqlalchemy.ext.asyncio import async_sessionmaker
|
|
||||||
from sqlalchemy.orm import selectinload
|
|
||||||
from sqlmodel import select
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from transcription.config import Settings
|
from transcription.config import Settings
|
||||||
from transcription.config import get_settings
|
from transcription.config import get_settings
|
||||||
from transcription.db.models import Job
|
|
||||||
from transcription.db.models import Revision
|
|
||||||
from transcription.db.models import Source
|
|
||||||
from transcription.errors import AppError
|
from transcription.errors import AppError
|
||||||
from transcription.errors import ErrorCategory
|
from transcription.errors import ErrorCategory
|
||||||
from transcription.providers import ProviderAuthError
|
from transcription.providers import ProviderAuthError
|
||||||
@@ -30,8 +17,6 @@ from transcription.providers import TranscriptionProvider
|
|||||||
from transcription.providers import TranscriptionResult
|
from transcription.providers import TranscriptionResult
|
||||||
from transcription.providers import get_transcription_provider
|
from transcription.providers import get_transcription_provider
|
||||||
|
|
||||||
from .base import ServiceBase
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
DEFAULT_PROMPT_FILE = "transcribe_document.md"
|
DEFAULT_PROMPT_FILE = "transcribe_document.md"
|
||||||
@@ -46,218 +31,6 @@ class TranscriptionError(AppError):
|
|||||||
"""Raised when transcription execution fails."""
|
"""Raised when transcription execution fails."""
|
||||||
|
|
||||||
|
|
||||||
class TranscriptionNotFoundError(TranscriptionError):
|
|
||||||
"""Raised when a transcription-related resource is not found."""
|
|
||||||
|
|
||||||
|
|
||||||
class TranscriptionService(ServiceBase):
|
|
||||||
"""Service class for job transcription output and optional source revisions."""
|
|
||||||
|
|
||||||
provider: TranscriptionProvider
|
|
||||||
|
|
||||||
def __init__(self, session_factory: async_sessionmaker[AsyncSession] | None = None):
|
|
||||||
super().__init__(session_factory=session_factory)
|
|
||||||
self.provider = get_transcription_provider(settings=self.settings)
|
|
||||||
|
|
||||||
async def create_revision(self, revision: Revision, *, session: AsyncSession | None = None) -> Revision:
|
|
||||||
"""Create a new revision in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
_session.add(revision)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(revision,))
|
|
||||||
return revision
|
|
||||||
|
|
||||||
async def read_revision(self, revision_id: UUID, *, session: AsyncSession | None = None) -> Revision:
|
|
||||||
"""Read an existing revision from the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
revision = await _session.get(
|
|
||||||
Revision,
|
|
||||||
revision_id,
|
|
||||||
options=(selectinload(Revision.source),), # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
if revision is None:
|
|
||||||
raise TranscriptionNotFoundError(
|
|
||||||
f"Revision with id {revision_id} not found",
|
|
||||||
category=ErrorCategory.NOT_FOUND,
|
|
||||||
suggestion="Verify the revision id and retry.",
|
|
||||||
)
|
|
||||||
return revision
|
|
||||||
|
|
||||||
async def update_revision(self, revision: Revision, *, session: AsyncSession | None = None) -> Revision:
|
|
||||||
"""Update an existing revision in the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
merged = await _session.merge(revision)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(merged,))
|
|
||||||
return merged
|
|
||||||
|
|
||||||
async def delete_revision(self, revision: Revision, *, session: AsyncSession | None = None) -> None:
|
|
||||||
"""Delete a revision from the database."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
await _session.delete(revision)
|
|
||||||
await self._finalize(session=_session, caller_session=session)
|
|
||||||
|
|
||||||
# Temporary compatibility methods for callers still using transcript naming.
|
|
||||||
|
|
||||||
async def read_transcript(self, transcript_id: UUID, *, session: AsyncSession | None = None) -> Revision:
|
|
||||||
"""Backward-compatible alias for read_revision."""
|
|
||||||
return await self.read_revision(transcript_id, session=session)
|
|
||||||
|
|
||||||
async def delete_transcript(self, transcript: Revision, *, session: AsyncSession | None = None) -> None:
|
|
||||||
"""Backward-compatible alias for delete_revision."""
|
|
||||||
await self.delete_revision(transcript, session=session)
|
|
||||||
|
|
||||||
async def transcribe_document(
|
|
||||||
self,
|
|
||||||
image_path: str | Path,
|
|
||||||
job_id: UUID,
|
|
||||||
*,
|
|
||||||
prompt_name: str = DEFAULT_PROMPT_FILE,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> None:
|
|
||||||
"""Transcribe a local image using the configured prompt and provider."""
|
|
||||||
result = await transcribe_document_image(
|
|
||||||
image_path=image_path,
|
|
||||||
prompt_name=prompt_name,
|
|
||||||
settings=self.settings,
|
|
||||||
provider=self.provider,
|
|
||||||
)
|
|
||||||
await self.update_job_transcription(
|
|
||||||
job_id=job_id,
|
|
||||||
text=result.text,
|
|
||||||
error_detail=None,
|
|
||||||
provider=result.provider,
|
|
||||||
model=result.model,
|
|
||||||
prompt_name=result.prompt_name,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
|
|
||||||
async def update_job_transcription(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
job_id: UUID,
|
|
||||||
text: str | None,
|
|
||||||
error_detail: str | None = None,
|
|
||||||
provider: str | None = None,
|
|
||||||
model: str | None = None,
|
|
||||||
prompt_name: str = DEFAULT_PROMPT_FILE,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job:
|
|
||||||
"""Persist original transcription output fields on a job."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
job = await _session.get(Job, job_id)
|
|
||||||
if job is None:
|
|
||||||
raise TranscriptionNotFoundError(
|
|
||||||
f"Job with id {job_id} not found",
|
|
||||||
category=ErrorCategory.NOT_FOUND,
|
|
||||||
suggestion="Verify the job id and retry.",
|
|
||||||
)
|
|
||||||
|
|
||||||
job.text = text
|
|
||||||
job.error_detail = error_detail
|
|
||||||
job.provider = provider or job.provider or self.settings.provider.value
|
|
||||||
job.model = model or job.model or _resolve_transcript_model(provider=self.provider, settings=self.settings)
|
|
||||||
job.prompt_name = prompt_name or job.prompt_name or DEFAULT_PROMPT_FILE
|
|
||||||
job.date_updated = datetime.now(UTC)
|
|
||||||
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(job,))
|
|
||||||
return job
|
|
||||||
|
|
||||||
async def upsert_revision_for_source(
|
|
||||||
self,
|
|
||||||
*,
|
|
||||||
source_id: UUID,
|
|
||||||
text: str,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Revision:
|
|
||||||
"""Create or replace the single optional revision for a source."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
source = await _session.get(Source, source_id)
|
|
||||||
if source is None:
|
|
||||||
raise TranscriptionNotFoundError(
|
|
||||||
f"Source with id {source_id} not found",
|
|
||||||
category=ErrorCategory.NOT_FOUND,
|
|
||||||
suggestion="Verify the source id and retry.",
|
|
||||||
)
|
|
||||||
|
|
||||||
query = select(Revision).where(Revision.source_id == source_id)
|
|
||||||
existing = (await _session.exec(query)).one_or_none()
|
|
||||||
|
|
||||||
if existing is None:
|
|
||||||
revision = Revision(source_id=source_id, text=text)
|
|
||||||
_session.add(revision)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(revision,))
|
|
||||||
return revision
|
|
||||||
|
|
||||||
existing.text = text
|
|
||||||
merged = await _session.merge(existing)
|
|
||||||
await self._finalize(session=_session, caller_session=session, refresh=(merged,))
|
|
||||||
return merged
|
|
||||||
|
|
||||||
async def read_revision_by_source(
|
|
||||||
self,
|
|
||||||
source_id: UUID,
|
|
||||||
*,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Revision | None:
|
|
||||||
"""Read the single optional revision for a source."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = select(Revision).where(Revision.source_id == source_id)
|
|
||||||
result = await _session.exec(query)
|
|
||||||
return result.one_or_none()
|
|
||||||
|
|
||||||
async def list_revisions_by_job(
|
|
||||||
self,
|
|
||||||
job_id: UUID,
|
|
||||||
*,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Sequence[Revision]:
|
|
||||||
"""List revisions connected to all sources for a job."""
|
|
||||||
async with self._session_scope(session) as _session:
|
|
||||||
query = (
|
|
||||||
select(Revision)
|
|
||||||
.join(Source, Source.id == Revision.source_id)
|
|
||||||
.where(Source.job_id == job_id)
|
|
||||||
.order_by(Revision.date_created) # pyright: ignore[reportArgumentType]
|
|
||||||
)
|
|
||||||
result = await _session.exec(query)
|
|
||||||
return result.all()
|
|
||||||
|
|
||||||
|
|
||||||
def _resolve_transcript_model(*, provider: TranscriptionProvider, settings: Settings) -> str:
|
|
||||||
provider_model = getattr(provider, "model", None)
|
|
||||||
if isinstance(provider_model, str) and provider_model.strip():
|
|
||||||
return provider_model
|
|
||||||
|
|
||||||
if settings.provider_model and settings.provider_model.strip():
|
|
||||||
return settings.provider_model
|
|
||||||
|
|
||||||
return "unknown"
|
|
||||||
|
|
||||||
|
|
||||||
async def transcribe_document_image(
|
|
||||||
image_path: str | Path,
|
|
||||||
*,
|
|
||||||
prompt_name: str = DEFAULT_PROMPT_FILE,
|
|
||||||
settings: Settings | None = None,
|
|
||||||
provider: TranscriptionProvider | None = None,
|
|
||||||
) -> TranscriptionResult:
|
|
||||||
"""Transcribe a local image using the configured prompt and provider."""
|
|
||||||
runtime_settings = settings or get_settings()
|
|
||||||
prompt_text = load_prompt_text(prompt_name=prompt_name, settings=runtime_settings)
|
|
||||||
image_bytes, mime_type = load_image_payload(image_path)
|
|
||||||
|
|
||||||
adapter = provider or get_transcription_provider(settings=runtime_settings)
|
|
||||||
logger.info("Starting transcription for image=%s mime_type=%s", image_path, mime_type)
|
|
||||||
|
|
||||||
with handle_transcription_errors():
|
|
||||||
result = await adapter.transcribe(
|
|
||||||
prompt_text=prompt_text,
|
|
||||||
image_bytes=image_bytes,
|
|
||||||
mime_type=mime_type,
|
|
||||||
)
|
|
||||||
logger.info("Transcription completed for image=%s provider=%s", image_path, result.provider)
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def load_prompt_text(*, prompt_name: str = DEFAULT_PROMPT_FILE, settings: Settings | None = None) -> str:
|
def load_prompt_text(*, prompt_name: str = DEFAULT_PROMPT_FILE, settings: Settings | None = None) -> str:
|
||||||
"""Load and validate prompt text from PROMPT_DIR."""
|
"""Load and validate prompt text from PROMPT_DIR."""
|
||||||
runtime_settings = settings or get_settings()
|
runtime_settings = settings or get_settings()
|
||||||
@@ -314,11 +87,27 @@ def load_image_payload(image_path: str | Path) -> tuple[bytes, str]:
|
|||||||
return path.read_bytes(), mime_type
|
return path.read_bytes(), mime_type
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
def transcribe_document_image(
|
||||||
def handle_transcription_errors():
|
image_path: str | Path,
|
||||||
"""Context manager to handle transcription errors."""
|
*,
|
||||||
|
prompt_name: str = DEFAULT_PROMPT_FILE,
|
||||||
|
settings: Settings | None = None,
|
||||||
|
provider: TranscriptionProvider | None = None,
|
||||||
|
) -> TranscriptionResult:
|
||||||
|
"""Transcribe a local image using the configured prompt and provider."""
|
||||||
|
runtime_settings = settings or get_settings()
|
||||||
|
prompt_text = load_prompt_text(prompt_name=prompt_name, settings=runtime_settings)
|
||||||
|
image_bytes, mime_type = load_image_payload(image_path)
|
||||||
|
|
||||||
|
adapter = provider or get_transcription_provider(settings=runtime_settings)
|
||||||
|
logger.info("Starting transcription for image=%s mime_type=%s", image_path, mime_type)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
yield
|
result = adapter.transcribe(
|
||||||
|
prompt_text=prompt_text,
|
||||||
|
image_bytes=image_bytes,
|
||||||
|
mime_type=mime_type,
|
||||||
|
)
|
||||||
except ProviderAuthError as exc:
|
except ProviderAuthError as exc:
|
||||||
raise TranscriptionError(
|
raise TranscriptionError(
|
||||||
"Provider authentication failed",
|
"Provider authentication failed",
|
||||||
@@ -339,3 +128,6 @@ def handle_transcription_errors():
|
|||||||
suggestion="Retry the transcription from jobs. If repeated, check provider availability.",
|
suggestion="Retry the transcription from jobs. If repeated, check provider availability.",
|
||||||
retriable=True,
|
retriable=True,
|
||||||
) from exc
|
) from exc
|
||||||
|
|
||||||
|
logger.info("Transcription completed for image=%s provider=%s", image_path, result.provider)
|
||||||
|
return result
|
||||||
|
|||||||
@@ -1,20 +1,23 @@
|
|||||||
|
"""Upload service for storing files and creating queued transcription jobs."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from uuid import UUID
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
from sqlmodel.ext.asyncio.session import AsyncSession
|
||||||
|
|
||||||
from transcription.config import Settings
|
from transcription.config import Settings
|
||||||
from transcription.config import get_settings
|
from transcription.config import get_settings
|
||||||
|
from transcription.db import get_session
|
||||||
from transcription.errors import AppError
|
from transcription.errors import AppError
|
||||||
from transcription.errors import ErrorCategory
|
from transcription.errors import ErrorCategory
|
||||||
|
from transcription.models import Document
|
||||||
from ..db.models import Document
|
from transcription.models import Job
|
||||||
from ..db.models import Job
|
from transcription.models import JobStatus
|
||||||
from ..db.models import Source
|
|
||||||
from .documents import UploadJobResult
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -25,26 +28,60 @@ class UploadError(AppError):
|
|||||||
"""Raised when uploaded content cannot be persisted safely."""
|
"""Raised when uploaded content cannot be persisted safely."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class UploadJobResult:
|
||||||
|
"""Summary of created upload records."""
|
||||||
|
|
||||||
|
document_id: UUID
|
||||||
|
job_id: UUID
|
||||||
|
stored_path: Path
|
||||||
|
original_filename: str
|
||||||
|
|
||||||
|
|
||||||
async def create_upload_job(
|
async def create_upload_job(
|
||||||
*,
|
*,
|
||||||
filename: str,
|
filename: str,
|
||||||
file_bytes: bytes,
|
file_bytes: bytes,
|
||||||
session: AsyncSession,
|
session: AsyncSession | None = None,
|
||||||
settings: Settings | None = None,
|
settings: Settings | None = None,
|
||||||
) -> UploadJobResult:
|
) -> UploadJobResult:
|
||||||
"""Create upload-backed document and queued job records."""
|
"""Persist an uploaded file and create document/job records."""
|
||||||
runtime_settings = settings or get_settings()
|
runtime_settings = settings or get_settings()
|
||||||
stored_path = store_file(
|
_validate_upload(
|
||||||
filename=filename,
|
filename=filename,
|
||||||
file_bytes=file_bytes,
|
file_bytes=file_bytes,
|
||||||
settings=runtime_settings,
|
max_upload_bytes=runtime_settings.max_upload_bytes,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
upload_dir = runtime_settings.upload_dir
|
||||||
|
upload_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
stored_name = _build_stored_filename(filename)
|
||||||
|
stored_path = upload_dir / stored_name
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
stored_path.write_bytes(file_bytes)
|
||||||
|
except OSError as exc:
|
||||||
|
raise UploadError(
|
||||||
|
"Failed to persist upload file",
|
||||||
|
category=ErrorCategory.INFRA_PERSISTENT,
|
||||||
|
suggestion="Check upload directory permissions and available disk space, then retry.",
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
try:
|
||||||
|
if session is not None:
|
||||||
document, job = await _create_upload_records(
|
document, job = await _create_upload_records(
|
||||||
session=session,
|
session=session,
|
||||||
original_filename=filename,
|
original_filename=filename,
|
||||||
stored_path=stored_path,
|
stored_path=stored_path,
|
||||||
)
|
)
|
||||||
|
else:
|
||||||
|
async with get_session() as local_session:
|
||||||
|
document, job = await _create_upload_records(
|
||||||
|
session=local_session,
|
||||||
|
original_filename=filename,
|
||||||
|
stored_path=stored_path,
|
||||||
|
)
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
_best_effort_delete(stored_path)
|
_best_effort_delete(stored_path)
|
||||||
raise UploadError(
|
raise UploadError(
|
||||||
@@ -63,70 +100,7 @@ async def create_upload_job(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
async def _create_upload_records(
|
def _validate_upload(*, filename: str, file_bytes: bytes, max_upload_bytes: int) -> None:
|
||||||
*,
|
|
||||||
session: AsyncSession,
|
|
||||||
original_filename: str,
|
|
||||||
stored_path: Path,
|
|
||||||
) -> tuple[Document, Job]:
|
|
||||||
document = Document(
|
|
||||||
name=Path(original_filename).name,
|
|
||||||
)
|
|
||||||
session.add(document)
|
|
||||||
await session.flush()
|
|
||||||
|
|
||||||
job = Job(document_id=document.id)
|
|
||||||
session.add(job)
|
|
||||||
await session.flush()
|
|
||||||
|
|
||||||
source = Source(
|
|
||||||
document_id=document.id,
|
|
||||||
job_id=job.id,
|
|
||||||
upload_name=Path(original_filename).name,
|
|
||||||
filename=stored_path.name,
|
|
||||||
file_path=str(stored_path),
|
|
||||||
)
|
|
||||||
session.add(source)
|
|
||||||
|
|
||||||
await session.commit()
|
|
||||||
await session.refresh(document)
|
|
||||||
await session.refresh(job)
|
|
||||||
return document, job
|
|
||||||
|
|
||||||
|
|
||||||
def _best_effort_delete(path: Path) -> None:
|
|
||||||
try:
|
|
||||||
if path.exists():
|
|
||||||
path.unlink()
|
|
||||||
except OSError:
|
|
||||||
logger.warning("Failed to clean up upload file after DB error: %s", path)
|
|
||||||
|
|
||||||
|
|
||||||
def store_file(*, filename: str, file_bytes: bytes, settings: Settings | None = None) -> Path:
|
|
||||||
"""Persist an uploaded file to the configured upload directory."""
|
|
||||||
runtime_settings = settings or get_settings()
|
|
||||||
_validate_upload(filename=filename, file_bytes=file_bytes)
|
|
||||||
|
|
||||||
upload_dir = runtime_settings.upload_dir
|
|
||||||
upload_dir.mkdir(parents=True, exist_ok=True)
|
|
||||||
|
|
||||||
stored_name = _build_stored_filename(filename)
|
|
||||||
stored_path = upload_dir / stored_name
|
|
||||||
|
|
||||||
try:
|
|
||||||
stored_path.write_bytes(file_bytes)
|
|
||||||
except OSError as exc:
|
|
||||||
raise UploadError(
|
|
||||||
"Failed to persist upload file",
|
|
||||||
category=ErrorCategory.INFRA_PERSISTENT,
|
|
||||||
suggestion="Check upload directory permissions and available disk space, then retry.",
|
|
||||||
) from exc
|
|
||||||
|
|
||||||
logger.info("Stored uploaded file: %s", stored_path)
|
|
||||||
return stored_path
|
|
||||||
|
|
||||||
|
|
||||||
def _validate_upload(*, filename: str, file_bytes: bytes) -> None:
|
|
||||||
if not file_bytes:
|
if not file_bytes:
|
||||||
raise UploadError(
|
raise UploadError(
|
||||||
"Upload payload is empty",
|
"Upload payload is empty",
|
||||||
@@ -134,6 +108,13 @@ def _validate_upload(*, filename: str, file_bytes: bytes) -> None:
|
|||||||
suggestion="Select a non-empty file and try again.",
|
suggestion="Select a non-empty file and try again.",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if len(file_bytes) > max_upload_bytes:
|
||||||
|
raise UploadError(
|
||||||
|
f"Upload exceeds maximum allowed size ({max_upload_bytes} bytes)",
|
||||||
|
category=ErrorCategory.USER_INPUT,
|
||||||
|
suggestion="Upload a smaller file or increase MAX_UPLOAD_BYTES for this deployment.",
|
||||||
|
)
|
||||||
|
|
||||||
safe_name = Path(filename).name
|
safe_name = Path(filename).name
|
||||||
if not safe_name:
|
if not safe_name:
|
||||||
raise UploadError(
|
raise UploadError(
|
||||||
@@ -154,3 +135,35 @@ def _validate_upload(*, filename: str, file_bytes: bytes) -> None:
|
|||||||
def _build_stored_filename(filename: str) -> str:
|
def _build_stored_filename(filename: str) -> str:
|
||||||
safe_name = Path(filename).name
|
safe_name = Path(filename).name
|
||||||
return f"{uuid4()}_{safe_name}"
|
return f"{uuid4()}_{safe_name}"
|
||||||
|
|
||||||
|
|
||||||
|
async def _create_upload_records(
|
||||||
|
*,
|
||||||
|
session: AsyncSession,
|
||||||
|
original_filename: str,
|
||||||
|
stored_path: Path,
|
||||||
|
) -> tuple[Document, Job]:
|
||||||
|
document = Document(
|
||||||
|
filename=Path(original_filename).name,
|
||||||
|
file_path=str(stored_path),
|
||||||
|
)
|
||||||
|
session.add(document)
|
||||||
|
await session.flush()
|
||||||
|
|
||||||
|
job = Job(
|
||||||
|
document_id=document.id,
|
||||||
|
status=JobStatus.QUEUED,
|
||||||
|
)
|
||||||
|
session.add(job)
|
||||||
|
await session.commit()
|
||||||
|
await session.refresh(document)
|
||||||
|
await session.refresh(job)
|
||||||
|
return document, job
|
||||||
|
|
||||||
|
|
||||||
|
def _best_effort_delete(path: Path) -> None:
|
||||||
|
try:
|
||||||
|
if path.exists():
|
||||||
|
path.unlink()
|
||||||
|
except OSError:
|
||||||
|
logger.warning("Failed to clean up upload file after DB error: %s", path)
|
||||||
@@ -1,345 +0,0 @@
|
|||||||
import asyncio
|
|
||||||
import logging
|
|
||||||
|
|
||||||
from sqlmodel.ext.asyncio.session import AsyncSession
|
|
||||||
|
|
||||||
from ..config import Settings
|
|
||||||
from ..config import get_settings
|
|
||||||
from ..db.models import Job
|
|
||||||
from ..db.models import JobStatus
|
|
||||||
from ..db.models import Source
|
|
||||||
from ..errors import AppError
|
|
||||||
from ..errors import ErrorCategory
|
|
||||||
from ..errors import classify_unexpected_error
|
|
||||||
from ..errors import format_error_detail
|
|
||||||
from ..providers import TranscriptionResult
|
|
||||||
from . import ServiceBundle
|
|
||||||
from .transcription import DEFAULT_PROMPT_FILE
|
|
||||||
from .transcription import transcribe_document_image
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
async def advance_job(
|
|
||||||
job: Job,
|
|
||||||
services: ServiceBundle,
|
|
||||||
settings: Settings | None = None,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job | None:
|
|
||||||
"""Advance a single job by lifecycle status."""
|
|
||||||
settings = settings or get_settings()
|
|
||||||
match job.status:
|
|
||||||
case JobStatus.QUEUED:
|
|
||||||
return await process_queued_job(job=job, services=services, settings=settings, session=session)
|
|
||||||
case JobStatus.FAILED:
|
|
||||||
if job.retry_count < settings.worker_max_retries:
|
|
||||||
return await services.jobs.update_job_state(
|
|
||||||
job_id=job.id,
|
|
||||||
status=JobStatus.QUEUED,
|
|
||||||
retry_count_increment=1,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
logger.error(f"Job {job.id} has failed and reached max retries.")
|
|
||||||
return
|
|
||||||
case _:
|
|
||||||
return
|
|
||||||
|
|
||||||
|
|
||||||
async def process_queued_job(
|
|
||||||
*,
|
|
||||||
job: Job,
|
|
||||||
services: ServiceBundle,
|
|
||||||
settings: Settings | None = None,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job | None:
|
|
||||||
"""Process one complete transcription attempt for a queued job."""
|
|
||||||
runtime_settings = settings or get_settings()
|
|
||||||
if job.status != JobStatus.QUEUED:
|
|
||||||
logger.warning(f"Job {job.id} is not queued. Current status: {job.status}")
|
|
||||||
return
|
|
||||||
|
|
||||||
# Transaction A: claim job for processing.
|
|
||||||
if session is None:
|
|
||||||
job = await services.jobs.mark_job_status(job.id, JobStatus.PROCESSING)
|
|
||||||
else:
|
|
||||||
# If we're sharing the session, need to make sure setting the Job to PROCESSING is committed before we start
|
|
||||||
# the transcription, otherwise other workers may see the job as still QUEUED and try to process it.
|
|
||||||
job = await services.jobs.mark_job_status(job.id, JobStatus.PROCESSING, session=session)
|
|
||||||
await session.commit()
|
|
||||||
|
|
||||||
source_job = await services.jobs.read_job(job_id=job.id, session=session)
|
|
||||||
source = _resolve_primary_source(source_job)
|
|
||||||
assert source is not None, f"Job {job.id} has no associated source record."
|
|
||||||
started_at = asyncio.get_running_loop().time()
|
|
||||||
|
|
||||||
try:
|
|
||||||
result = await asyncio.wait_for(
|
|
||||||
transcribe_document_image(source.file_path),
|
|
||||||
timeout=runtime_settings.worker_provider_timeout_seconds,
|
|
||||||
)
|
|
||||||
elapsed_seconds = asyncio.get_running_loop().time() - started_at
|
|
||||||
logger.info(
|
|
||||||
"Provider response diagnostics operation=worker.provider_response "
|
|
||||||
"job_id=%s document_id=%s source_id=%s provider=%s model=%s "
|
|
||||||
"finish_reason=%s usage_input_tokens=%s usage_output_tokens=%s usage_total_tokens=%s "
|
|
||||||
"latency_seconds=%.3f text_chars=%s text_lines=%s",
|
|
||||||
job.id,
|
|
||||||
job.document_id,
|
|
||||||
source.id,
|
|
||||||
result.provider,
|
|
||||||
result.model,
|
|
||||||
result.finish_reason or "unknown",
|
|
||||||
result.usage_input_tokens,
|
|
||||||
result.usage_output_tokens,
|
|
||||||
result.usage_total_tokens,
|
|
||||||
elapsed_seconds,
|
|
||||||
len(result.text),
|
|
||||||
_line_count(result.text),
|
|
||||||
)
|
|
||||||
|
|
||||||
_validate_transcription_quality(result=result, settings=runtime_settings)
|
|
||||||
|
|
||||||
job = await _finalize_transcribed(job=job, services=services, result=result, session=session)
|
|
||||||
logger.info(
|
|
||||||
"Job transcribed operation=worker.process_job job_id=%s document_id=%s source_id=%s provider=%s",
|
|
||||||
job.id,
|
|
||||||
job.document_id,
|
|
||||||
source.id,
|
|
||||||
result.provider,
|
|
||||||
)
|
|
||||||
except TimeoutError:
|
|
||||||
error = AppError(
|
|
||||||
f"Provider call timed out after {runtime_settings.worker_provider_timeout_seconds:.1f}s",
|
|
||||||
category=ErrorCategory.EXTERNAL_PROVIDER,
|
|
||||||
suggestion="Retry the job. If this repeats, verify provider latency and request payload size.",
|
|
||||||
retriable=True,
|
|
||||||
)
|
|
||||||
job = await _finalize_failed(job=job, services=services, error=error, session=session)
|
|
||||||
logger.error(
|
|
||||||
"Job failed operation=worker.process_job job_id=%s document_id=%s source_id=%s error_id=%s category=%s",
|
|
||||||
job.id,
|
|
||||||
job.document_id,
|
|
||||||
source.id,
|
|
||||||
error.error_id,
|
|
||||||
error.category.value,
|
|
||||||
)
|
|
||||||
except Exception as exc: # noqa: BLE001
|
|
||||||
match exc:
|
|
||||||
case AppError() as error:
|
|
||||||
pass
|
|
||||||
case _:
|
|
||||||
error = classify_unexpected_error(exc, operation="worker.process_job")
|
|
||||||
|
|
||||||
job = await _finalize_failed(job=job, services=services, error=error, session=session)
|
|
||||||
logger.error(
|
|
||||||
"Job failed operation=worker.process_job job_id=%s document_id=%s source_id=%s error_id=%s category=%s",
|
|
||||||
job.id,
|
|
||||||
job.document_id,
|
|
||||||
source.id,
|
|
||||||
error.error_id,
|
|
||||||
error.category.value,
|
|
||||||
)
|
|
||||||
return job
|
|
||||||
|
|
||||||
|
|
||||||
async def process_next_queued_job(
|
|
||||||
*,
|
|
||||||
services: ServiceBundle,
|
|
||||||
settings: Settings | None = None,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> bool:
|
|
||||||
"""Process the next queued job if one exists."""
|
|
||||||
job = await services.jobs.read_next_queued_job(session=session)
|
|
||||||
if job is None:
|
|
||||||
return False
|
|
||||||
|
|
||||||
await advance_job(job=job, services=services, settings=settings, session=session)
|
|
||||||
return True
|
|
||||||
|
|
||||||
|
|
||||||
async def _finalize_transcribed(
|
|
||||||
*,
|
|
||||||
job: Job,
|
|
||||||
services: ServiceBundle,
|
|
||||||
result: TranscriptionResult,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job:
|
|
||||||
"""Transaction B: job transcription output + TRANSCRIBED in one commit."""
|
|
||||||
if session is None:
|
|
||||||
async with services.jobs._session_scope() as local_session:
|
|
||||||
await services.transcriptions.update_job_transcription(
|
|
||||||
job_id=job.id,
|
|
||||||
text=result.text,
|
|
||||||
error_detail=None,
|
|
||||||
provider=result.provider,
|
|
||||||
model=result.model,
|
|
||||||
prompt_name=result.prompt_name,
|
|
||||||
session=local_session,
|
|
||||||
)
|
|
||||||
updated_job = await services.jobs.mark_job_status(
|
|
||||||
job.id,
|
|
||||||
JobStatus.TRANSCRIBED,
|
|
||||||
session=local_session,
|
|
||||||
)
|
|
||||||
await local_session.commit()
|
|
||||||
return updated_job
|
|
||||||
|
|
||||||
await services.transcriptions.update_job_transcription(
|
|
||||||
job_id=job.id,
|
|
||||||
text=result.text,
|
|
||||||
error_detail=None,
|
|
||||||
provider=result.provider,
|
|
||||||
model=result.model,
|
|
||||||
prompt_name=result.prompt_name,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
updated_job = await services.jobs.mark_job_status(
|
|
||||||
job.id,
|
|
||||||
JobStatus.TRANSCRIBED,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
await session.commit()
|
|
||||||
return updated_job
|
|
||||||
|
|
||||||
|
|
||||||
async def _finalize_retry(
|
|
||||||
*,
|
|
||||||
job: Job,
|
|
||||||
services: ServiceBundle,
|
|
||||||
error: AppError,
|
|
||||||
settings: Settings,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job:
|
|
||||||
"""Transaction C: job error detail + QUEUED + retry increment in one commit."""
|
|
||||||
if session is None:
|
|
||||||
async with services.jobs._session_scope() as local_session:
|
|
||||||
await services.transcriptions.update_job_transcription(
|
|
||||||
job_id=job.id,
|
|
||||||
text=None,
|
|
||||||
error_detail=format_error_detail(error),
|
|
||||||
prompt_name=DEFAULT_PROMPT_FILE,
|
|
||||||
session=local_session,
|
|
||||||
)
|
|
||||||
updated_job = await services.jobs.update_job_state(
|
|
||||||
job_id=job.id,
|
|
||||||
status=JobStatus.QUEUED,
|
|
||||||
retry_count_increment=1,
|
|
||||||
session=local_session,
|
|
||||||
)
|
|
||||||
await local_session.commit()
|
|
||||||
else:
|
|
||||||
await services.transcriptions.update_job_transcription(
|
|
||||||
job_id=job.id,
|
|
||||||
text=None,
|
|
||||||
error_detail=format_error_detail(error),
|
|
||||||
prompt_name=DEFAULT_PROMPT_FILE,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
updated_job = await services.jobs.update_job_state(
|
|
||||||
job_id=job.id,
|
|
||||||
status=JobStatus.QUEUED,
|
|
||||||
retry_count_increment=1,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
await session.commit()
|
|
||||||
|
|
||||||
if settings.worker_retry_backoff_seconds > 0:
|
|
||||||
await asyncio.sleep(settings.worker_retry_backoff_seconds)
|
|
||||||
return updated_job
|
|
||||||
|
|
||||||
|
|
||||||
async def _finalize_failed(
|
|
||||||
*,
|
|
||||||
job: Job,
|
|
||||||
services: ServiceBundle,
|
|
||||||
error: AppError,
|
|
||||||
session: AsyncSession | None = None,
|
|
||||||
) -> Job:
|
|
||||||
"""Transaction B: job error detail + FAILED in one commit."""
|
|
||||||
if session is None:
|
|
||||||
async with services.jobs._session_scope() as local_session:
|
|
||||||
await services.transcriptions.update_job_transcription(
|
|
||||||
job_id=job.id,
|
|
||||||
text=None,
|
|
||||||
error_detail=format_error_detail(error),
|
|
||||||
prompt_name=DEFAULT_PROMPT_FILE,
|
|
||||||
session=local_session,
|
|
||||||
)
|
|
||||||
updated_job = await services.jobs.mark_job_status(
|
|
||||||
job.id,
|
|
||||||
JobStatus.FAILED,
|
|
||||||
session=local_session,
|
|
||||||
)
|
|
||||||
await local_session.commit()
|
|
||||||
return updated_job
|
|
||||||
|
|
||||||
await services.transcriptions.update_job_transcription(
|
|
||||||
job_id=job.id,
|
|
||||||
text=None,
|
|
||||||
error_detail=format_error_detail(error),
|
|
||||||
prompt_name=DEFAULT_PROMPT_FILE,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
updated_job = await services.jobs.mark_job_status(
|
|
||||||
job.id,
|
|
||||||
JobStatus.FAILED,
|
|
||||||
session=session,
|
|
||||||
)
|
|
||||||
await session.commit()
|
|
||||||
return updated_job
|
|
||||||
|
|
||||||
|
|
||||||
def _resolve_primary_source(job: Job) -> Source | None:
|
|
||||||
if not job.sources:
|
|
||||||
return None
|
|
||||||
return job.sources[0]
|
|
||||||
|
|
||||||
|
|
||||||
def _validate_transcription_quality(*, result: TranscriptionResult, settings: Settings) -> None:
|
|
||||||
text_chars = len(result.text)
|
|
||||||
text_lines = _line_count(result.text)
|
|
||||||
|
|
||||||
if settings.worker_fail_on_finish_reason_length and (result.finish_reason or "").lower() == "length":
|
|
||||||
raise AppError(
|
|
||||||
"Provider output appears truncated (finish_reason=length)",
|
|
||||||
category=ErrorCategory.EXTERNAL_PROVIDER,
|
|
||||||
suggestion=(
|
|
||||||
"Retry the job. If this repeats, use a faster model, reduce input complexity, "
|
|
||||||
"or increase provider output budget."
|
|
||||||
),
|
|
||||||
retriable=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if settings.worker_min_transcription_chars > 0 and text_chars < settings.worker_min_transcription_chars:
|
|
||||||
raise AppError(
|
|
||||||
(
|
|
||||||
"Transcription output below configured minimum character threshold "
|
|
||||||
f"({text_chars} < {settings.worker_min_transcription_chars})"
|
|
||||||
),
|
|
||||||
category=ErrorCategory.EXTERNAL_PROVIDER,
|
|
||||||
suggestion=(
|
|
||||||
"Retry the job. If this repeats, switch model or raise minimum thresholds based on document type."
|
|
||||||
),
|
|
||||||
retriable=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if settings.worker_min_transcription_lines > 0 and text_lines < settings.worker_min_transcription_lines:
|
|
||||||
raise AppError(
|
|
||||||
(
|
|
||||||
"Transcription output below configured minimum line threshold "
|
|
||||||
f"({text_lines} < {settings.worker_min_transcription_lines})"
|
|
||||||
),
|
|
||||||
category=ErrorCategory.EXTERNAL_PROVIDER,
|
|
||||||
suggestion=(
|
|
||||||
"Retry the job. If this repeats, switch model or raise minimum thresholds based on document type."
|
|
||||||
),
|
|
||||||
retriable=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _line_count(text: str) -> int:
|
|
||||||
stripped = text.strip()
|
|
||||||
if not stripped:
|
|
||||||
return 0
|
|
||||||
return sum(1 for line in stripped.splitlines() if line.strip())
|
|
||||||
@@ -1,45 +1,14 @@
|
|||||||
"""UI page registration exports."""
|
"""UI page registration exports."""
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from fastapi import FastAPI
|
from fastapi import FastAPI
|
||||||
from nicegui import app as nicegui_app
|
|
||||||
from nicegui import ui
|
from nicegui import ui
|
||||||
|
|
||||||
from transcription.ui.pages.jobs_page import register_page as register_jobs_page
|
from transcription.ui.pages.jobs_page import register_page as register_jobs_page
|
||||||
from transcription.ui.pages.upload_page import register_page as register_upload_page
|
from transcription.ui.pages.upload_page import register_page as register_upload_page
|
||||||
|
|
||||||
_THEME_REGISTERED_STATE_KEY = "transcription_ui_theme_registered"
|
|
||||||
|
|
||||||
_THEME_COLORS: dict[str, str] = {
|
|
||||||
"primary": "#6f97e8",
|
|
||||||
"secondary": "#92b5f5",
|
|
||||||
"accent": "#7fc0de",
|
|
||||||
"dark": "#22304a",
|
|
||||||
"dark_page": "#1a2538",
|
|
||||||
"positive": "#86c8ad",
|
|
||||||
"negative": "#d98a9a",
|
|
||||||
"info": "#7ebdda",
|
|
||||||
"warning": "#e2c083",
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def _register_global_styles(app: FastAPI) -> None:
|
|
||||||
if getattr(app.state, _THEME_REGISTERED_STATE_KEY, False):
|
|
||||||
return
|
|
||||||
|
|
||||||
nicegui_app.colors(**_THEME_COLORS)
|
|
||||||
|
|
||||||
css_path = Path(__file__).resolve().parent / "static" / "colors.css"
|
|
||||||
if css_path.exists():
|
|
||||||
ui.add_css(css_path, shared=True)
|
|
||||||
|
|
||||||
setattr(app.state, _THEME_REGISTERED_STATE_KEY, True)
|
|
||||||
|
|
||||||
|
|
||||||
def register_pages(app: FastAPI) -> None:
|
def register_pages(app: FastAPI) -> None:
|
||||||
"""Register all NiceGUI pages and mount them onto the FastAPI app."""
|
"""Register all NiceGUI pages and mount them onto the FastAPI app."""
|
||||||
_register_global_styles(app)
|
|
||||||
register_upload_page()
|
register_upload_page()
|
||||||
register_jobs_page()
|
register_jobs_page()
|
||||||
ui.run_with(app, mount_path="/ui", show_welcome_message=False, dark=True)
|
ui.run_with(app, mount_path="/ui", show_welcome_message=False)
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
"""Reusable UI component exports."""
|
|
||||||
|
|
||||||
from transcription.ui.components.app_shell import NAV_ITEMS
|
|
||||||
from transcription.ui.components.app_shell import render_navigation_header
|
|
||||||
from transcription.ui.components.document_panzoom import render_document_panzoom
|
|
||||||
|
|
||||||
__all__ = ["NAV_ITEMS", "render_document_panzoom", "render_navigation_header"]
|
|
||||||
|
|||||||
@@ -1,59 +0,0 @@
|
|||||||
"""Reusable app shell primitives for page-level layout."""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from nicegui import ui
|
|
||||||
|
|
||||||
NAV_ITEMS: tuple[tuple[str, str, str], ...] = (
|
|
||||||
("Upload", "/upload", "upload_file"),
|
|
||||||
("Jobs", "/jobs", "work_history"),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _is_active_path(*, current_path: str, item_path: str) -> bool:
|
|
||||||
if item_path == "/jobs":
|
|
||||||
return current_path == "/jobs" or current_path.startswith("/jobs/")
|
|
||||||
return current_path == item_path
|
|
||||||
|
|
||||||
|
|
||||||
def _button_props(*, icon: str, is_active: bool) -> str:
|
|
||||||
if is_active:
|
|
||||||
return f"icon={icon} no-caps unelevated color=primary text-color=white"
|
|
||||||
return f"icon={icon} no-caps outline color=secondary text-color=secondary"
|
|
||||||
|
|
||||||
|
|
||||||
def _button_classes(*, is_active: bool) -> str:
|
|
||||||
base = "w-full sm:w-auto min-h-[40px] px-3 rounded-lg text-body2 text-weight-medium"
|
|
||||||
if is_active:
|
|
||||||
return f"{base}"
|
|
||||||
return f"{base}"
|
|
||||||
|
|
||||||
|
|
||||||
def _render_nav_button(*, label: str, path: str, icon: str, current_path: str) -> None:
|
|
||||||
is_active = _is_active_path(current_path=current_path, item_path=path)
|
|
||||||
button = ui.button(
|
|
||||||
label,
|
|
||||||
icon=icon,
|
|
||||||
on_click=lambda _=None, route=path: ui.navigate.to(route),
|
|
||||||
)
|
|
||||||
button.props(_button_props(icon=icon, is_active=is_active)).classes(_button_classes(is_active=is_active))
|
|
||||||
|
|
||||||
|
|
||||||
def _normalize_path(current_path: str | None) -> str:
|
|
||||||
normalized = (current_path or "").strip()
|
|
||||||
if not normalized:
|
|
||||||
return "/upload"
|
|
||||||
return normalized.rstrip("/") or "/"
|
|
||||||
|
|
||||||
|
|
||||||
def render_navigation_header(*, current_path: str | None = None) -> None:
|
|
||||||
"""Render a shared app header with links for top-level pages."""
|
|
||||||
normalized_path = _normalize_path(current_path)
|
|
||||||
|
|
||||||
with (
|
|
||||||
ui.header(elevated=True).props("bordered").classes("bg-dark text-white q-px-sm q-py-xs"),
|
|
||||||
ui.row().classes("w-full items-center justify-end q-gutter-xs"),
|
|
||||||
ui.element("div").classes("w-full grid grid-cols-2 gap-2 sm:flex sm:justify-start sm:gap-2"),
|
|
||||||
):
|
|
||||||
for label, path, icon in NAV_ITEMS:
|
|
||||||
_render_nav_button(label=label, path=path, icon=icon, current_path=normalized_path)
|
|
||||||
@@ -1,211 +0,0 @@
|
|||||||
"""Panzoom-backed document preview component."""
|
|
||||||
|
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from functools import lru_cache
|
|
||||||
from pathlib import Path
|
|
||||||
from urllib.parse import quote
|
|
||||||
from uuid import uuid4
|
|
||||||
|
|
||||||
from nicegui import ui
|
|
||||||
|
|
||||||
from transcription.config import get_settings
|
|
||||||
from transcription.db.models import Source
|
|
||||||
|
|
||||||
PANGOZOOM_CDN_URL = "https://unpkg.com/@panzoom/[email protected]/dist/panzoom.min.js"
|
|
||||||
UPLOADS_URL_PREFIX = "/uploads"
|
|
||||||
|
|
||||||
|
|
||||||
def render_document_panzoom(*, source: Source) -> None:
|
|
||||||
"""Render a source preview with pan and zoom interactions."""
|
|
||||||
_register_panzoom_assets()
|
|
||||||
|
|
||||||
host_id = f"document-panzoom-{uuid4().hex}"
|
|
||||||
document_url = _document_url(source)
|
|
||||||
document_kind = _document_kind(source)
|
|
||||||
|
|
||||||
with ui.card().classes("w-full q-pa-md"):
|
|
||||||
with ui.row().classes("w-full items-center justify-between no-wrap"):
|
|
||||||
ui.label("Document preview").classes("text-subtitle1 text-weight-medium")
|
|
||||||
ui.label(source.filename).classes("text-caption text-grey-4 ellipsis").style(
|
|
||||||
"max-width: 60%; text-align: right;"
|
|
||||||
)
|
|
||||||
|
|
||||||
with (
|
|
||||||
ui.element("div").classes("w-full document-panzoom-host rounded-borders q-mt-md")
|
|
||||||
# .style(f"height: {height};")
|
|
||||||
) as host:
|
|
||||||
host.props(f"id={host_id}")
|
|
||||||
with ui.element("div").classes("document-panzoom-surface"):
|
|
||||||
if document_kind == "pdf":
|
|
||||||
ui.html(
|
|
||||||
f'<iframe class="document-panzoom-iframe" '
|
|
||||||
f'src="{document_url}" title="{source.filename}" '
|
|
||||||
"data-panzoom-target></iframe>"
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
ui.html(
|
|
||||||
f'<img class="document-panzoom-media" '
|
|
||||||
f'src="{document_url}" alt="{source.filename}" '
|
|
||||||
"data-panzoom-target data-panzoom-media />"
|
|
||||||
)
|
|
||||||
|
|
||||||
_attach_panzoom(host_id)
|
|
||||||
|
|
||||||
|
|
||||||
@lru_cache(maxsize=1)
|
|
||||||
def _register_panzoom_assets() -> None:
|
|
||||||
ui.add_head_html(
|
|
||||||
f'<script src="{PANGOZOOM_CDN_URL}"></script>',
|
|
||||||
shared=True,
|
|
||||||
)
|
|
||||||
ui.add_head_html(
|
|
||||||
"""
|
|
||||||
<style>
|
|
||||||
.document-panzoom-host {
|
|
||||||
overflow: hidden;
|
|
||||||
touch-action: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.document-panzoom-surface {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
display: flex;
|
|
||||||
align-items: flex-start;
|
|
||||||
justify-content: flex-start;
|
|
||||||
}
|
|
||||||
|
|
||||||
.document-panzoom-media {
|
|
||||||
width: auto;
|
|
||||||
height: auto;
|
|
||||||
display: block;
|
|
||||||
max-width: 100%;
|
|
||||||
max-height: 100%;
|
|
||||||
user-select: none;
|
|
||||||
-webkit-user-drag: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.document-panzoom-iframe {
|
|
||||||
width: 100%;
|
|
||||||
height: 100%;
|
|
||||||
border: 0;
|
|
||||||
pointer-events: none;
|
|
||||||
background: white;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
""",
|
|
||||||
shared=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _document_url(source: Source) -> str:
|
|
||||||
file_path = Path(source.file_path)
|
|
||||||
upload_dir = get_settings().upload_dir
|
|
||||||
|
|
||||||
relative_path: Path
|
|
||||||
try:
|
|
||||||
relative_path = file_path.resolve().relative_to(upload_dir.resolve())
|
|
||||||
except ValueError:
|
|
||||||
parts = file_path.parts
|
|
||||||
if "uploads" in parts:
|
|
||||||
uploads_index = parts.index("uploads")
|
|
||||||
relative_path = Path(*parts[uploads_index + 1 :])
|
|
||||||
else:
|
|
||||||
relative_path = Path(file_path.name)
|
|
||||||
|
|
||||||
encoded_relative_path = "/".join(quote(part) for part in relative_path.parts)
|
|
||||||
return f"{UPLOADS_URL_PREFIX}/{encoded_relative_path}"
|
|
||||||
|
|
||||||
|
|
||||||
def _document_kind(source: Source) -> str:
|
|
||||||
suffix = Path(source.file_path).suffix.lower()
|
|
||||||
if suffix == ".pdf":
|
|
||||||
return "pdf"
|
|
||||||
return "image"
|
|
||||||
|
|
||||||
|
|
||||||
def _attach_panzoom(host_id: str) -> None:
|
|
||||||
ui.run_javascript(
|
|
||||||
f"""
|
|
||||||
(function() {{
|
|
||||||
if (!window.Panzoom) return;
|
|
||||||
window.__transcriptionPanzoom = window.__transcriptionPanzoom || {{}};
|
|
||||||
const host = document.getElementById({host_id!r});
|
|
||||||
if (!host) return;
|
|
||||||
const target = host.querySelector('[data-panzoom-target]');
|
|
||||||
const media = host.querySelector('[data-panzoom-media]');
|
|
||||||
if (!target) return;
|
|
||||||
|
|
||||||
const cleanup = () => {{
|
|
||||||
const existing = window.__transcriptionPanzoom[{host_id!r}];
|
|
||||||
if (existing?.resizeObserver) existing.resizeObserver.disconnect();
|
|
||||||
if (existing?.wheelHandler) host.removeEventListener('wheel', existing.wheelHandler);
|
|
||||||
if (existing?.instance) existing.instance.destroy();
|
|
||||||
}};
|
|
||||||
|
|
||||||
const computeFitScale = () => {{
|
|
||||||
const hostRect = host.getBoundingClientRect();
|
|
||||||
if (hostRect.width <= 0 || hostRect.height <= 0) return null;
|
|
||||||
return 1;
|
|
||||||
}};
|
|
||||||
|
|
||||||
const buildInstance = () => {{
|
|
||||||
cleanup();
|
|
||||||
|
|
||||||
const fitScale = computeFitScale();
|
|
||||||
if (fitScale === null) return false;
|
|
||||||
|
|
||||||
const minScale = Math.min(fitScale, 0.01);
|
|
||||||
const instance = Panzoom(target, {{
|
|
||||||
startX: 0,
|
|
||||||
startY: 0,
|
|
||||||
startScale: fitScale,
|
|
||||||
minScale: minScale,
|
|
||||||
maxScale: 256,
|
|
||||||
step: 0.2,
|
|
||||||
roundPixels: false,
|
|
||||||
panOnlyWhenZoomed: true,
|
|
||||||
overflow: 'hidden',
|
|
||||||
}});
|
|
||||||
|
|
||||||
const wheelHandler = (event) => instance.zoomWithWheel(event);
|
|
||||||
host.addEventListener('wheel', wheelHandler, {{ passive: false }});
|
|
||||||
|
|
||||||
requestAnimationFrame(() => {{
|
|
||||||
instance.reset({{ animate: false }});
|
|
||||||
}});
|
|
||||||
|
|
||||||
const resizeObserver = new ResizeObserver(() => {{
|
|
||||||
const nextFitScale = computeFitScale();
|
|
||||||
if (nextFitScale === null) return;
|
|
||||||
instance.setOptions({{
|
|
||||||
startScale: nextFitScale,
|
|
||||||
minScale: Math.min(nextFitScale, 0.01),
|
|
||||||
}});
|
|
||||||
instance.reset({{ animate: false }});
|
|
||||||
}});
|
|
||||||
resizeObserver.observe(host);
|
|
||||||
|
|
||||||
window.__transcriptionPanzoom[{host_id!r}] = {{
|
|
||||||
instance,
|
|
||||||
wheelHandler,
|
|
||||||
resizeObserver,
|
|
||||||
}};
|
|
||||||
return true;
|
|
||||||
}};
|
|
||||||
|
|
||||||
const initWhenReady = (retries = 15) => {{
|
|
||||||
if (buildInstance()) return;
|
|
||||||
if (retries <= 0) return;
|
|
||||||
requestAnimationFrame(() => initWhenReady(retries - 1));
|
|
||||||
}};
|
|
||||||
|
|
||||||
if (media && media.tagName === 'IMG' && !media.complete) {{
|
|
||||||
media.addEventListener('load', () => initWhenReady(), {{ once: true }});
|
|
||||||
return;
|
|
||||||
}}
|
|
||||||
|
|
||||||
initWhenReady();
|
|
||||||
}})();
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
@@ -2,90 +2,29 @@
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import logging
|
|
||||||
|
|
||||||
from nicegui import ui
|
from nicegui import ui
|
||||||
|
|
||||||
from transcription.db.models import Job
|
from transcription.models import Document
|
||||||
from transcription.db.models import Revision
|
from transcription.models import Job
|
||||||
from transcription.db.models import Source
|
from transcription.models import Transcript
|
||||||
from transcription.ui.components.document_panzoom import render_document_panzoom
|
|
||||||
from transcription.ui.components.transcript import render_original_transcription_card
|
|
||||||
from transcription.ui.components.transcript import render_revision_row
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
def _status_chip_classes(status: str) -> str:
|
def render_job_detail(*, job: Job, document: Document | None, transcript: Transcript | None) -> None:
|
||||||
if status == "queued":
|
|
||||||
return "bg-blue-1 text-blue-10"
|
|
||||||
if status == "processing":
|
|
||||||
return "bg-amber-1 text-amber-10"
|
|
||||||
if status == "transcribed":
|
|
||||||
return "bg-green-1 text-green-10"
|
|
||||||
if status == "failed":
|
|
||||||
return "bg-red-1 text-red-10"
|
|
||||||
return "bg-grey-2 text-grey-9"
|
|
||||||
|
|
||||||
|
|
||||||
def _metadata_row(label: str, value: str) -> None:
|
|
||||||
with ui.row().classes("w-full items-start justify-between q-gutter-x-md"):
|
|
||||||
ui.label(label).classes("text-caption text-grey-5 text-uppercase w-28")
|
|
||||||
ui.label(value).classes("text-body2 text-right text-grey-1 break-all")
|
|
||||||
|
|
||||||
|
|
||||||
def _render_source_section(source: Source) -> None:
|
|
||||||
with ui.card().classes("w-full q-pa-md"):
|
|
||||||
ui.label("Source").classes("text-subtitle1 text-weight-medium")
|
|
||||||
ui.separator().classes("q-my-sm")
|
|
||||||
with ui.column().classes("w-full q-gutter-y-xs"):
|
|
||||||
_metadata_row("Upload name", source.upload_name)
|
|
||||||
_metadata_row("Stored filename", source.filename)
|
|
||||||
_metadata_row("File path", source.file_path)
|
|
||||||
_metadata_row("Uploaded", source.date_uploaded.isoformat())
|
|
||||||
|
|
||||||
ui.separator().classes("q-my-md")
|
|
||||||
render_document_panzoom(source=source)
|
|
||||||
|
|
||||||
|
|
||||||
def _render_revision_section(revision: Revision | None) -> None:
|
|
||||||
with ui.card().classes("w-full q-pa-md"):
|
|
||||||
ui.label("Revision").classes("text-subtitle1 text-weight-medium")
|
|
||||||
ui.separator().classes("q-my-sm")
|
|
||||||
|
|
||||||
if revision is None:
|
|
||||||
ui.label("No revision exists for this source.").classes("text-body2 text-grey-3")
|
|
||||||
return
|
|
||||||
|
|
||||||
render_revision_row(revision=revision, initially_expanded=True)
|
|
||||||
|
|
||||||
|
|
||||||
def render_job_detail(*, job: Job, source: Source | None, revision: Revision | None) -> None:
|
|
||||||
"""Render all sections for the job detail page."""
|
"""Render all sections for the job detail page."""
|
||||||
logger.debug("Rendering job detail for job ID %s", job.id)
|
ui.label(f"Job ID: {job.id}")
|
||||||
status_text = job.status.value
|
ui.label(f"Status: {job.status.value}")
|
||||||
with ui.column().classes("w-full max-w-4xl q-gutter-md"):
|
ui.label(f"Created: {job.created_at.isoformat()}")
|
||||||
with ui.card().classes("w-full q-pa-lg"):
|
ui.label(f"Updated: {job.updated_at.isoformat()}")
|
||||||
with ui.row().classes("w-full items-center justify-between q-gutter-md"):
|
|
||||||
with ui.column().classes("q-gutter-none"):
|
|
||||||
ui.label("Job overview").classes("text-h6 text-weight-bold")
|
|
||||||
ui.label(str(job.id)).classes("text-caption text-grey-5")
|
|
||||||
status_chip_classes = (
|
|
||||||
"q-px-sm q-py-xs rounded-borders "
|
|
||||||
"text-weight-medium text-capitalize "
|
|
||||||
f"{_status_chip_classes(status_text)}"
|
|
||||||
)
|
|
||||||
ui.label(status_text).classes(status_chip_classes)
|
|
||||||
|
|
||||||
ui.separator().classes("q-my-md bg-blue-grey-7")
|
if document is not None:
|
||||||
with ui.column().classes("w-full q-gutter-y-xs"):
|
ui.label(f"Filename: {document.filename}")
|
||||||
_metadata_row("Created", job.date_created.isoformat())
|
ui.label(f"File path: {document.file_path}")
|
||||||
_metadata_row("Updated", job.date_updated.isoformat())
|
|
||||||
_metadata_row("Retries", str(job.retry_count))
|
|
||||||
|
|
||||||
render_original_transcription_card(job=job)
|
if transcript is None:
|
||||||
|
ui.label("Transcript not available yet.")
|
||||||
if source is not None:
|
elif transcript.text:
|
||||||
_render_source_section(source)
|
ui.label("Transcript:")
|
||||||
|
ui.markdown(transcript.text)
|
||||||
_render_revision_section(revision)
|
elif transcript.error_detail:
|
||||||
|
ui.label("Failure detail:")
|
||||||
|
ui.label(transcript.error_detail)
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
"""Reusable jobs table rendering helpers."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections.abc import Sequence
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from uuid import UUID
|
||||||
|
|
||||||
|
from nicegui import ui
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class JobTableRow:
|
||||||
|
"""Read model consumed by the shared jobs table component."""
|
||||||
|
|
||||||
|
id: UUID
|
||||||
|
status: str
|
||||||
|
created_at: str
|
||||||
|
updated_at: str
|
||||||
|
|
||||||
|
|
||||||
|
def _serialize_rows(rows: Sequence[JobTableRow]) -> list[dict[str, str]]:
|
||||||
|
"""Convert typed rows into table-compatible dictionaries."""
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"id": str(row.id),
|
||||||
|
"status": row.status,
|
||||||
|
"created_at": row.created_at,
|
||||||
|
"updated_at": row.updated_at,
|
||||||
|
}
|
||||||
|
for row in rows
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def render_jobs_table(rows: Sequence[JobTableRow]) -> None:
|
||||||
|
"""Render jobs table and per-row detail links."""
|
||||||
|
if not rows:
|
||||||
|
ui.label("No jobs yet.")
|
||||||
|
return
|
||||||
|
|
||||||
|
serialized_rows = _serialize_rows(rows)
|
||||||
|
ui.table(
|
||||||
|
columns=[
|
||||||
|
{"name": "id", "label": "Job ID", "field": "id"},
|
||||||
|
{"name": "status", "label": "Status", "field": "status"},
|
||||||
|
{"name": "created_at", "label": "Created", "field": "created_at"},
|
||||||
|
{"name": "updated_at", "label": "Updated", "field": "updated_at"},
|
||||||
|
],
|
||||||
|
rows=serialized_rows,
|
||||||
|
row_key="id",
|
||||||
|
).classes("w-full")
|
||||||
|
|
||||||
|
with ui.column().classes("gap-1"):
|
||||||
|
for row in serialized_rows:
|
||||||
|
ui.link(f"Open {row['id']}", f"/jobs/{row['id']}")
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
from .jobs import JobTableRow
|
|
||||||
from .jobs import render_jobs_table
|
|
||||||
|
|
||||||
__all__ = ["JobTableRow", "render_jobs_table"]
|
|
||||||
@@ -1,73 +0,0 @@
|
|||||||
"""Common logic for generating table widgets."""
|
|
||||||
|
|
||||||
import logging
|
|
||||||
from collections.abc import Callable
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
from nicegui import events
|
|
||||||
from nicegui import ui
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
def _extract_row_id(args: Any) -> str | None:
|
|
||||||
if isinstance(args, dict):
|
|
||||||
if isinstance(args.get("row"), dict):
|
|
||||||
row_id = args["row"].get("id")
|
|
||||||
return str(row_id) if row_id is not None else None
|
|
||||||
row_id = args.get("id")
|
|
||||||
return str(row_id) if row_id is not None else None
|
|
||||||
|
|
||||||
if isinstance(args, list):
|
|
||||||
for value in args:
|
|
||||||
if isinstance(value, dict):
|
|
||||||
row_id = value.get("id")
|
|
||||||
if row_id is not None:
|
|
||||||
return str(row_id)
|
|
||||||
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def _bind_row_click_handler(
|
|
||||||
table: Any,
|
|
||||||
*,
|
|
||||||
on_row_click_id: Callable[[str], None],
|
|
||||||
) -> None:
|
|
||||||
def handle_row_click(event: events.GenericEventArguments) -> None:
|
|
||||||
row_id = _extract_row_id(event.args)
|
|
||||||
if row_id is None:
|
|
||||||
return
|
|
||||||
on_row_click_id(row_id)
|
|
||||||
|
|
||||||
table.on("rowClick", handle_row_click)
|
|
||||||
logger.debug("Row click handler bound to table")
|
|
||||||
|
|
||||||
|
|
||||||
def build_table(
|
|
||||||
rows: list[dict[str, Any]],
|
|
||||||
columns: list[dict[str, Any]],
|
|
||||||
*,
|
|
||||||
default_sort_by: str | None = None,
|
|
||||||
default_descending: bool = False,
|
|
||||||
classes: str = "app-table",
|
|
||||||
on_row_click_id: Callable[[str], None] | None = None,
|
|
||||||
) -> Any:
|
|
||||||
pagination: dict[str, Any] = {"rowsPerPage": 25}
|
|
||||||
if default_sort_by is not None:
|
|
||||||
pagination["sortBy"] = default_sort_by
|
|
||||||
pagination["descending"] = default_descending
|
|
||||||
|
|
||||||
table = (
|
|
||||||
ui.table(
|
|
||||||
rows=rows,
|
|
||||||
columns=columns,
|
|
||||||
row_key="id",
|
|
||||||
pagination=pagination,
|
|
||||||
)
|
|
||||||
.classes(classes)
|
|
||||||
.props('table-style="table-layout: fixed; width: 100%;"')
|
|
||||||
)
|
|
||||||
logger.info("Table built with %d rows and %d columns", len(rows), len(columns))
|
|
||||||
if on_row_click_id is not None:
|
|
||||||
_bind_row_click_handler(table, on_row_click_id=on_row_click_id)
|
|
||||||
return table
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user