deer-flow/backend/tests/blocking_io/test_project_documents_promotion.py
Zeren Wang a58ab484a6
feat(projects): Projects MVP Phase 2 — instructions, document shelf, promotion, trash (#5443)
* feat(projects): Projects MVP Phase 2 — instructions, document shelf, promotion, trash

Implements docs/superpowers/specs/2026-09-12-projects-mvp-phase2-design.md
(issue #5160, tracker #5129) in the slice order of the spec's §16.

Slices:
- A: ProjectsConfig + write-time 422 UTF-8 byte cap; PROJECT_CONTEXT_KEY
  admission pinning (both server-owned sets + worker hoist); latest-only
  request-scoped <project> block via DynamicContextMiddleware
  wrap_model_call/awrap_model_call (idempotent reassembly, reserved ID
  prefix + marker + provenance, never persisted); journal audit
  fingerprints; Instructions tab.
- B: ProjectDocumentRow + migration 0023; ProjectDocumentRepository with
  locked check-and-set; hash-qualified immutable shelf storage with
  Paths helpers; upload/list/content/delete-to-trash routes; project
  delete trashes the shelf in-transaction; request-scoped bounded
  <documents> index with honest count/shown + actionable overflow note;
  list_project_documents/read_project_document tools registered only on
  pinned runs; PAT allowlist + drift guards; blocking-IO anchors.
- C: shared thread-upload ingestion service (uploads router refactored to
  parity); POST from-thread with provenance; attach-to-thread with
  lock-staged copy (archived source allowed); read-only thread-files
  view with per-group truncation reporting.
- D: restore (restored/merged/not_found/no_target/content_missing; no
  file moves), purge (continuous row lock across unlink/delete/commit,
  retryable on FS errors), retention sweep (lazy + startup, 24h orphan
  guard, row-side reconciliation never deletes).
- E: Documents tab (shelf + conversation-files browser, provenance,
  archived banner, content-missing rows), /workspace/trash route,
  sidebar entry, composer attach handoff, i18n (en-US/zh-CN), e2e mocks
  + specs.

Review hardening folded in (10 rounds, all with tests):
- force active shelf content (HTML/XML family) to download; nosniff on
  artifact + content responses; unified unsandboxed-iframe PDF preview
  (fixes the pre-existing Chromium sandbox blank in the artifact viewer)
- scope document trash to the URL project under the document lock
- atomic no-overwrite filename reservation for ALL ingestion (seeded
  claims + os.link commit with suffix retry; same-name re-upload now
  unique-names instead of replacing); hidden staging only, no visible
  placeholders; lease cleanup on setup failure
- serialize conversion under the document lock with post-lock active
  revalidation; drain locked filesystem work on cancellation; preserve
  bytes when an insert's commit state is uncertain (including trashed
  rows)
- original-integrity checks before serving text or cached conversions;
  content_missing surfaced in list responses (UI reads the flag, no
  409-probe); downloads always serve original bytes
- bounded streaming document reads with cached char counts; shelf limits
  declared in middleware release identity
- thread-root confinement for from-thread sources; config fallback
  rejects fractional/infinite values; composer counts staged
  attachments; pending attachments persist until submission or removal;
  in-flight instruction/rename edits survive save refetches; shelf and
  trash pagination; conversation-file and thread-files pages stay
  subscribed to refetches

Docs: README/README_zh, backend API.md/ARCHITECTURE.md, AGENTS.md
contracts, config.example.yaml projects block.

Review follow-ups (head b4807477 → this revision):
- The trash retention sweep is split so repeated lazy triggers stay
  bounded: the indexed expiry purge still runs on every trigger
  (GET /api/trash/documents, POST /api/trash/purge) while the
  O(all rows + all files) reconciliation is throttled to one run per
  user per 15 minutes (process-local, per-user window). The startup
  sweep now runs as a background task instead of blocking gateway
  readiness, and shutdown awaits it (bounded).
- The export scrub (stripInternalMarkers) is fence- and indentation-aware
  like the render path, so a pasted, fenced <project>/<documents> snippet
  survives markdown export while real injected blocks (never fenced) are
  still removed. Fence regexes moved to a dependency-free leaf module to
  avoid the messages↔streamdown import cycle.
- The artifact viewer's PDF iframe no longer carries an added title
  attribute (the upstream e2e contract locates it via :not([title])), and
  the upstream artifact-preview spec now pins the new contract: PDFs
  render unsandboxed, images keep sandbox="".

* fix(projects): round-2 review — cancel an overrun trash sweep, restore the PDF frame title

- Shutdown cancelled only the shield around the background startup sweep,
  so an all-users reconciliation that outlived the 5s budget kept walking
  rows and files while the document repo and DB engine were disposed
  underneath it. The wait now lives in `_shutdown_startup_trash_sweep`,
  which cancels the task and drains it before worker exit: the shield
  keeps the wait bounded, the cancel makes it final (CancelledError lands
  at the sweep's next await, and `_run_startup_trash_sweep` only catches
  `Exception`, so nothing swallows it).
- The browser-preview iframe lost `title={getFileName(filepath)}` in the
  previous fix round, leaving the PDF frame without an accessible name
  while its siblings keep theirs. Restore it (WCAG frame titles), assert
  it in the DOM test, and anchor the e2e on `iframe[title="report.pdf"]`
  instead of `iframe:not([title])`.

* fix(projects): round-3 review — report the sweep's late finish, not a phantom cancel

`Task.cancel()` returns False when the sweep already finished inside the
window between the deadline firing and the cancel, so the shutdown log
claimed a cancellation that never happened. Branch on that outcome: the
warning stays for a real cancel, a late finish is logged at info, and both
paths still reap the task before worker exit.

* fix(projects): round-4 review — make Empty trash delete what it confirms

`POST /api/trash/purge` only ran the retention sweep, and the sweep's
candidate selection is age-gated, so a freshly trashed document survived
"Empty trash" even though the confirmation promises that every listed
document is permanently deleted. With one trashed row the route answered
`{"purged": 0}` and left it in place; `GET /api/trash/documents` sweeps
expired rows before listing, so the visible rows were normally ineligible
for the action by construction.

Empty trash now drives `purge_all_trashed`: the caller's trashed rows
(`list_all_trashed`, no age filter) each go through the same guarded,
row-locked `purge` as the single-document delete — bytes first, then the
row, in one transaction — so a row restored mid-flight is skipped instead of
force-deleted, and an unlink failure rolls that row back and answers 500 with
a retryable message. Retention expiry stays where it was: the sweep's
`purge_candidates` is now the only age-gated selection, and the lazy
retention sweep still runs on the listing and at startup.

Tests: the router suite replaces the retention-gated expectation with the
reviewer's repro (fresh row purged, bytes unlinked, shelf and other users'
trash untouched, a failing unlink stays retryable and 500); a blocking-I/O
anchor drives the new entry point through the offload; the mocked e2e covers
the action end to end; a new real-backend spec performs it against the real
gateway and re-reads `GET /api/trash/documents`. README, API, ARCHITECTURE
and the phase-2 design docs (en+zh) state the age-independent contract.
2026-09-16 18:46:18 +08:00

182 lines
8.1 KiB
Python

"""Regression anchors: Slice-C async paths must keep FS work off the loop.
Guards the Phase-2 Slice-C filesystem surfaces (spec §13): the attach
path's under-lock staging copy (``_copy_original_under_lock``) and its
staged/source chunk reads (``read_file_chunks``), plus the thread-files
view's directory scans (``list_files_in_dir`` over the uploads and outputs
dirs). Same mutation-verified style as ``test_project_documents.py``: the
anchors spy on the production offload (``run_file_io``, call-through) and
assert the specific worker functions were dispatched through it — removing
an offload drops the dispatch and turns the anchor red.
"""
from __future__ import annotations
import functools
from types import SimpleNamespace
import pytest
from deerflow.persistence.engine import close_engine, get_session_factory, init_engine
from deerflow.persistence.projects import ProjectDocumentRepository, ProjectRepository
from deerflow.projects.documents import add_staged_document, read_file_chunks, stage_document_bytes, stage_document_copy_for_attach
from deerflow.utils.file_io import run_file_io as _real_run_file_io
pytestmark = [pytest.mark.asyncio, pytest.mark.allow_blocking_io]
_USER = "u1"
def _spy_offload(monkeypatch) -> list[str]:
"""Record every ``run_file_io`` dispatch in the Slice-C modules (call-through)."""
calls: list[str] = []
async def spy(func, /, *args, **kwargs):
target = func.func if isinstance(func, functools.partial) else func
calls.append(getattr(target, "__name__", repr(target)))
return await _real_run_file_io(func, *args, **kwargs)
monkeypatch.setattr("deerflow.projects.documents.run_file_io", spy)
monkeypatch.setattr("app.gateway.routers.project_thread_files.run_file_io", spy)
monkeypatch.setattr("app.gateway.upload_ingestion.run_file_io", spy)
return calls
async def _make_env(tmp_path, monkeypatch) -> SimpleNamespace:
import deerflow.config.paths as paths_mod
monkeypatch.setenv("DEER_FLOW_HOME", str(tmp_path))
monkeypatch.setattr(paths_mod, "_paths", None)
await init_engine("sqlite", url=f"sqlite+aiosqlite:///{tmp_path / 'test.db'}", sqlite_dir=str(tmp_path))
sf = get_session_factory()
project = await ProjectRepository(sf).create(name="P", user_id=_USER)
return SimpleNamespace(paths=paths_mod.get_paths(), docs=ProjectDocumentRepository(sf), project_id=project["id"])
async def _shelf_document(env) -> dict:
staged = await stage_document_bytes(env.paths, user_id=_USER, project_id=env.project_id, chunks=[b"attach anchor"], max_bytes=1 << 20)
result = await add_staged_document(env.docs, env.paths, user_id=_USER, project_id=env.project_id, name="anchor.txt", staged=staged)
assert result is not None and result[1] is True
return result[0]
async def test_attach_staging_copy_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""The under-lock source copy (existence/size check + ``shutil.copyfile``)
must go through ``run_file_io`` while the row lock is held."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
row = await _shelf_document(env)
calls.clear()
result = await stage_document_copy_for_attach(env.docs, env.paths, user_id=_USER, project_id=env.project_id, document_id=row["id"])
assert result is not None
staged_row, staged_path = result
assert staged_row["id"] == row["id"]
assert staged_path.read_bytes() == b"attach anchor"
assert "_copy_original_under_lock" in calls
staged_path.unlink()
finally:
await close_engine()
async def test_attach_staged_read_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""``read_file_chunks`` (attach ingestion source + from-thread promote
source) must dispatch the open, every chunk read, and the close through
``run_file_io``."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
row = await _shelf_document(env)
result = await stage_document_copy_for_attach(env.docs, env.paths, user_id=_USER, project_id=env.project_id, document_id=row["id"])
assert result is not None
_row, staged_path = result
calls.clear()
chunks = [chunk async for chunk in read_file_chunks(staged_path, chunk_size=4)]
assert b"".join(chunks) == b"attach anchor"
assert "_open" in calls
assert "read" in calls
assert "close" in calls
staged_path.unlink()
finally:
await close_engine()
async def test_ingestion_open_and_link_commit_dispatch_off_the_loop(tmp_path, monkeypatch) -> None:
"""``open()``'s existing-uploads seed (``list_files_in_dir``) and the
per-file atomic no-overwrite link commit (``_commit_upload_temp_no_overwrite``)
must go through ``run_file_io`` — the service never scans or links
on the event loop."""
from unittest.mock import MagicMock
from app.gateway.routers import uploads as uploads_router
from app.gateway.upload_ingestion import ThreadUploadIngestionService
provider = MagicMock()
provider.uses_thread_data_mounts = True
monkeypatch.setattr(uploads_router, "get_sandbox_provider", lambda: provider)
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
uploads_dir = env.paths.sandbox_uploads_dir("thread-1", user_id=_USER)
uploads_dir.mkdir(parents=True)
(uploads_dir / "report.txt").write_bytes(b"existing")
service = ThreadUploadIngestionService(request=None, thread_id="thread-1", user_id=_USER, app_config=SimpleNamespace(uploads={}))
await service.open()
assert service._seen_filenames == {"report.txt"}
assert "list_files_in_dir" in calls
async def _chunks():
yield b"fresh bytes"
calls.clear()
info = await service.ingest_chunks(_chunks(), display_name="report.txt")
# Claimed unique against the seeded name and reserved atomically.
assert info["filename"] == "report_1.txt"
assert (uploads_dir / "report_1.txt").read_bytes() == b"fresh bytes"
assert (uploads_dir / "report.txt").read_bytes() == b"existing"
assert "_commit_upload_temp_no_overwrite" in calls
# The converted companion is also staged hidden and link-committed
# atomically through the offload.
async def fake_convert(file_path, output_path=None):
output_path.write_text("md", encoding="utf-8")
return output_path
monkeypatch.setattr(uploads_router, "convert_file_to_markdown", fake_convert)
service._auto_convert = True
async def _pdf_chunks():
yield b"pdf-bytes"
calls.clear()
info = await service.ingest_chunks(_pdf_chunks(), display_name="doc.pdf")
assert info["markdown_file"] == "doc.md"
assert (uploads_dir / "doc.md").read_text(encoding="utf-8") == "md"
assert "_link_staged_no_overwrite" in calls
await service.aclose()
finally:
await close_engine()
async def test_thread_files_listing_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""The thread-files view's uploads/outputs directory scans must go
through ``run_file_io`` (the route never scans directories inline)."""
from app.gateway.routers.project_thread_files import _list_thread_files
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
uploads_dir = env.paths.sandbox_uploads_dir("thread-1", user_id=_USER)
outputs_dir = env.paths.sandbox_outputs_dir("thread-1", user_id=_USER)
uploads_dir.mkdir(parents=True)
outputs_dir.mkdir(parents=True)
(uploads_dir / "in.txt").write_bytes(b"in")
(outputs_dir / "out.txt").write_bytes(b"out")
calls.clear()
entries, truncated = await _list_thread_files(env.paths, user_id=_USER, thread_id="thread-1", file_limit=10)
assert truncated is False
assert {(e.kind, e.name) for e in entries} == {("upload", "in.txt"), ("output", "out.txt")}
assert calls.count("list_files_in_dir") == 2
finally:
await close_engine()