deer-flow/backend/tests/blocking_io/test_project_trash.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

161 lines
6.8 KiB
Python

"""Regression anchors: trash-tier async paths must keep FS work off the loop.
Phase-2 spec §7.3/§13 (blocking-IO anchors): the purge unlink (inside the
row-locked transaction), the restore content checks, the post-commit merge
cleanup, and the retention sweep's storage/row reconciliation all dispatch
through ``run_file_io``. Each test spies the offload (call-through) and
asserts the specific worker went through it — removing the offload turns the
anchor red (mutation-verified style of this suite).
"""
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, converted_markdown_path, stage_document_bytes
from deerflow.projects.trash import make_purge_file_remover, purge_all_trashed, restore_document, run_trash_retention_sweep
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 shelf 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.trash.run_file_io", spy)
# ``check_document_content``/``_content_intact`` live in the documents
# module (shared with the serving path); spy its offload too.
monkeypatch.setattr("deerflow.projects.documents.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()
projects = ProjectRepository(sf)
project = await projects.create(name="P", user_id=_USER)
return SimpleNamespace(paths=paths_mod.get_paths(), projects=projects, docs=ProjectDocumentRepository(sf), project_id=project["id"])
async def _add(env: SimpleNamespace, *, name: str, data: bytes) -> dict:
staged = await stage_document_bytes(env.paths, user_id=_USER, project_id=env.project_id, chunks=[data], max_bytes=1 << 20)
result = await add_staged_document(env.docs, env.paths, user_id=_USER, project_id=env.project_id, name=name, staged=staged)
assert result is not None and result[1] is True
return result[0]
async def test_purge_unlink_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""The original + ``derived/converted.md`` unlink (``_unlink_document_files``)
runs through the offload, inside the purge transaction's row lock."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
row = await _add(env, name="notes.txt", data=b"hello")
derived = converted_markdown_path(env.paths, user_id=_USER, row=row)
derived.parent.mkdir(parents=True, exist_ok=True)
derived.write_text("# converted")
assert await env.docs.trash(row["id"], user_id=_USER) is True
calls.clear()
purged = await env.docs.purge(row["id"], remove_files=make_purge_file_remover(env.paths, user_id=_USER), user_id=_USER)
assert purged is True
assert "_unlink_document_files" in calls
assert not derived.exists()
finally:
await close_engine()
async def test_empty_trash_unlink_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""Empty trash (``purge_all_trashed``) removes every row's files through the
same offload as the single purge — one dispatch per trashed row."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
rows = [await _add(env, name=f"{name}.txt", data=name.encode()) for name in ("one", "two")]
for row in rows:
assert await env.docs.trash(row["id"], user_id=_USER) is True
calls.clear()
purged = await purge_all_trashed(env.docs, env.paths, user_id=_USER)
assert purged == len(rows)
assert calls.count("_unlink_document_files") == len(rows)
finally:
await close_engine()
async def test_restore_content_checks_dispatch_off_the_loop(tmp_path, monkeypatch) -> None:
"""Restore's original existence/size check (``_content_intact``) runs
through the offload, under the document lock."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
row = await _add(env, name="notes.txt", data=b"hello")
assert await env.docs.trash(row["id"], user_id=_USER) is True
calls.clear()
outcome, restored = await restore_document(env.docs, env.paths, user_id=_USER, document_id=row["id"], target_project_id=env.project_id)
assert outcome == "restored"
assert restored is not None
assert "_content_intact" in calls
finally:
await close_engine()
async def test_merge_cleanup_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""The post-commit merge cleanup (``_remove_namespace_tree``) runs through
the offload."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
old = await _add(env, name="report.txt", data=b"same bytes")
assert await env.docs.trash(old["id"], user_id=_USER) is True
new = await _add(env, name="report.txt", data=b"same bytes")
calls.clear()
outcome, doc = await restore_document(env.docs, env.paths, user_id=_USER, document_id=old["id"], target_project_id=env.project_id)
assert outcome == "merged"
assert doc["id"] == new["id"]
assert "_remove_namespace_tree" in calls
finally:
await close_engine()
async def test_sweep_reconciliation_dispatches_off_the_loop(tmp_path, monkeypatch) -> None:
"""Both sweep reconciliation passes (``_reconcile_storage`` /
``_reconcile_rows``) run through the offload — the sweep walks the user's
projects tree and stats every row's original."""
calls = _spy_offload(monkeypatch)
env = await _make_env(tmp_path, monkeypatch)
try:
await _add(env, name="notes.txt", data=b"hello")
calls.clear()
report = await run_trash_retention_sweep(env.docs, env.paths, retention_days=30, user_id=_USER)
assert report.purged == 0
assert "_reconcile_storage" in calls
assert "_reconcile_rows" in calls
finally:
await close_engine()