**Phase 122 (image documents) — final verification pass: all green. No code changes were needed; defects found: none.**
**Verified (implementation already complete in working tree, reviewed end-to-end):**
- Toggle (`BOR_IMAGES`/`BOR_IMAGE_EXTENSIONS`/`BOR_IMAGE_DIR`, off by default) + `GET /api/config` `images` flag
- Ingest: bytes digest, `image_dir` persistent copy, `content = summary = vision description` (chat-model call; only text embedded), fail-soft skip + `images_failed` counter
- Serve/display: `/api/documents/{id}/image` route (404 matrix), viewer `<img>` + description, Sources 48px lazy thumbnails, chat inline source figure (alt = summary), agent `read` marker
- Prune guard: images-off syncs never prune `is_image` docs
**Test / lint / coverage (exact commands & outcomes):**
- `uv run pytest` → exit 0 (green; note: pytest 9.1.1 `-q` omits the final count line in output — exit code authoritative)
- `uv run pytest --cov=app --cov-report=term-missing` → **2715 passed, exit 0, TOTAL 99%** (>90% gate)
- `uv run ruff check . && uv run pyright` → "All checks passed!" / "0 errors, 0 warnings, 0 informations"
- `uv run pytest tests/e2e/test_image_documents.py -v --no-cov` → **4 passed, exit 0** (isolation)
**Completion criteria:** (1) images=true → described/embedded/displayed docs: ✅ (E2E + integration) · (2) images=false byte-identical + image docs survive sync: ✅ (E2E negative app + unit/integration) · (3) viewer + chat rendering with alt text; failed description skips + logs, sync completes: ✅ · (4) test/lint/coverage gates: ✅ · (5) commit + phase move: deferred to harness per this pass's rules (working tree left uncommitted).
**Notable deviation (pre-existing, documented in code):** image route uses `require_user` (phase-79 posture, same gate as the document content endpoint) rather than the phase text's "public" parenthetical — matches the endpoint it mirrors.
**Next pending phase:** `123_chat_image_questions`.
4.0 KiB
4.0 KiB
Task 06 — Image tests: unit + integration + isolated E2E
Phase: 122_image_documents · Source: TODO.md:6 — "Need to support images …"
Objective
Pin the whole image-document contract: the off-by-default byte-identity, the ingest/description/serve pipeline, the RAG display, and the end-to-end user path (upload → Sources → viewer → chat) as an isolated Playwright suite.
Work
tests/unit/test_image_documents.py(new) — consolidates the per-task unit cases (the tasks ship code; this task ships the full pin):- settings: defaults (
imagesFalse, six-extension frozenset, dir default), env overrides, case-insensitive parse (task 01); - the walk: image accepted iff
images=True; off → the file is ignored (the default byte-identity); _index_fileimage branch: digest over BYTES, copy toimage_dir,is_image/image_pathset, changed-image stale-copy delete, prune guard (off → survives; on + gone → pruned + copy deleted),images_failedin the log line (task 02);describe_image: mock-client prompt shape (multimodal parts, chat model), cap,Noneon error/empty, the importer skip path (no row, no orphan, counter, warning) and the success path (content == summary == description; embedding called with the description only) (task 03);- the ext→mime map (task 04);
- the source-frame
image_urlhelper (present/absent) + the agentreadmarker + house-style frontend assertions (viewerimg+ alt + fallback; sources thumbnail fallback; chat sources inline image + alt) (task 05).
- settings: defaults (
tests/integration/test_docs_api.py(extend, task 04's cases) — the image route (200 + Content-Type per ext; 404 text doc / missing id / missing file), the content endpoint'sis_image/image_urlomission rules;tests/integration/test_chat_api.py(extend, task 05's case) — the SSEimage_urlframe;tests/integration/(new filetest_image_import.pyor the existing import test file — follow whichever exists) —import_sourcesend-to-end:images=True+ mock vision → the fixture PNG becomes a doc (description content,is_summarychunk, one content chunk);images=False→ ignored + a pre-seeded image doc survives prune; a failing mock →images_failed == 1, no row, other docs indexed.- Fixtures: a tiny valid PNG (a few bytes, generated in-test or a committed fixture under
tests/— check the existing fixture conventions), a mock vision client (the existing mock-LLM test patterns intests/).
- Fixtures: a tiny valid PNG (a few bytes, generated in-test or a committed fixture under
tests/e2e/test_image_documents.py(new — isolated run per AGENTS.md §4:uv run pytest tests/e2e/test_image_documents.py -v --no-cov). The suite's app instance runs withBOR_IMAGES=true(env override in the E2E fixture — theconftest.pypattern for per-suite app env):- upload a fixture PNG (the Sources-page upload flow or
page.requestagainst the upload endpoint, then trigger the sync through the UI as the Sources page does); - the Sources page lists the image doc (thumbnail or icon fallback);
- open the document viewer → the image renders + the description text below it;
- ask a question the mock LLM grounds on the image doc (the existing mock-LLM grounding pattern) → the chat's sources block shows the inline image with its caption;
- negative: with the DEFAULT env (
BOR_IMAGESunset/false), the same upload produces NO image doc (the default-off contract).
- upload a fixture PNG (the Sources-page upload flow or
- Run the full gate:
uv run pytest,uv run pytest --cov=app --cov-report=term-missing(TOTAL >90%), the isolated E2E file,uv run ruff check . && uv run pyright.
Testing & Quality
- This task IS the phase's test suite (see Work).
- Coverage: >90% on
app/— the phase'sapp/surface (config, importer, summarizer, docs API, chat frames, agent marker) is fully exercised.
Completion Criteria
- All test artifacts exist and pass; the isolated E2E file passes standalone.
- The default-off byte-identity is asserted (unit + integration + the E2E negative case).
uv run pytest --cov=appTOTAL >90%; lint + types clean.