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

215 lines
8.0 KiB
Python

"""CRUD API for projects (Phase 1: organization only — no documents/trash)."""
import logging
from typing import Any, Literal
from fastapi import APIRouter, Depends, HTTPException, Query, Request
from pydantic import BaseModel, Field, field_validator
from app.gateway.authz import require_permission
from app.gateway.deps import get_config, get_project_repo, get_thread_store
from deerflow.config.app_config import AppConfig, get_app_config
from deerflow.config.projects_config import ProjectsConfig
from deerflow.runtime.secret_context import redact_metadata_secrets
from deerflow.utils.time import coerce_iso
logger = logging.getLogger(__name__)
router = APIRouter(prefix="/api/projects", tags=["projects"])
ProjectStatus = Literal["active", "archived"]
class ProjectResponse(BaseModel):
id: str
name: str
instructions: str
presentation: dict
status: str
created_at: str
updated_at: str
class ProjectCreateRequest(BaseModel):
name: str = Field(..., min_length=1, max_length=128)
instructions: str = ""
presentation: dict = Field(default_factory=dict)
class ProjectPatchRequest(BaseModel):
name: str | None = Field(default=None, min_length=1, max_length=128)
instructions: str | None = None
presentation: dict | None = None
class ProjectListResponse(BaseModel):
projects: list[ProjectResponse]
class ProjectsConfigResponse(BaseModel):
"""The projects-block knobs the UI needs before it can validate client-side."""
instructions_max_bytes: int
trash_retention_days: int
class ProjectThreadResponse(BaseModel):
"""A thread row from ``GET /api/projects/{id}/threads``.
Deliberately narrow — only the fields ``ProjectThread`` declares in
``frontend/src/core/projects/types.ts``. Store rows carry ownership
columns (``user_id``, ``assistant_id``) and ``ThreadMetaRow`` may grow;
without this model those would leak onto the wire and the route's
OpenAPI schema stays empty. Metadata is redacted here exactly as the
surrounding thread endpoints redact it via ``_MetadataRedactingResponse``.
"""
thread_id: str
display_name: str | None = None
created_at: str = ""
updated_at: str = ""
metadata: dict[str, Any] = Field(default_factory=dict)
@field_validator("metadata", mode="before", check_fields=False)
@classmethod
def _redact_metadata_secrets(cls, value: Any) -> Any:
return redact_metadata_secrets(value)
def _to_response(row: dict) -> ProjectResponse:
return ProjectResponse(
id=row["id"],
name=row["name"],
instructions=row.get("instructions", ""),
presentation=row.get("presentation") or {},
status=row["status"],
created_at=row.get("created_at", ""),
updated_at=row.get("updated_at", ""),
)
def _not_found() -> HTTPException:
# Fail closed: foreign projects are indistinguishable from missing ones.
return HTTPException(status_code=404, detail="Project not found")
def _projects_config() -> ProjectsConfig:
"""Projects config, falling back to defaults when the app config is unavailable."""
try:
return get_app_config().projects
except (FileNotFoundError, RuntimeError):
return ProjectsConfig()
def _validate_instructions_length(instructions: str | None) -> None:
"""Reject oversized instructions with 422 — never truncate (spec §6.5/§11).
The cap counts UTF-8 bytes, so multi-byte characters cost their encoded
length rather than one character each.
"""
if instructions is None:
return
max_bytes = _projects_config().instructions_max_bytes
if len(instructions.encode("utf-8")) > max_bytes:
raise HTTPException(status_code=422, detail=f"instructions exceeds the configured {max_bytes}-byte UTF-8 limit")
@router.post("", response_model=ProjectResponse, status_code=201)
@require_permission("projects", "write")
async def create_project(body: ProjectCreateRequest, request: Request) -> ProjectResponse:
_validate_instructions_length(body.instructions)
repo = get_project_repo(request)
return _to_response(await repo.create(name=body.name, instructions=body.instructions, presentation=body.presentation))
@router.get("", response_model=ProjectListResponse)
@require_permission("projects", "read")
async def list_projects(request: Request, status: ProjectStatus | None = None) -> ProjectListResponse:
repo = get_project_repo(request)
return ProjectListResponse(projects=[_to_response(r) for r in await repo.list(status=status)])
@router.get("/config", response_model=ProjectsConfigResponse)
@require_permission("projects", "read")
async def get_projects_config(request: Request, config: AppConfig = Depends(get_config)) -> ProjectsConfigResponse:
"""Projects config for the UI (instructions byte cap, trash retention).
Declared before ``/{project_id}`` so ``config`` is never swallowed as a
project id. Values come from the live ``projects`` config block; when the
block is absent the ``ProjectsConfig`` defaults apply.
"""
return ProjectsConfigResponse(
instructions_max_bytes=config.projects.instructions_max_bytes,
trash_retention_days=config.projects.trash_retention_days,
)
@router.get("/{project_id}", response_model=ProjectResponse)
@require_permission("projects", "read")
async def get_project(project_id: str, request: Request) -> ProjectResponse:
row = await get_project_repo(request).get(project_id)
if row is None:
raise _not_found()
return _to_response(row)
@router.patch("/{project_id}", response_model=ProjectResponse)
@require_permission("projects", "write")
async def patch_project(project_id: str, body: ProjectPatchRequest, request: Request) -> ProjectResponse:
_validate_instructions_length(body.instructions)
row = await get_project_repo(request).patch(project_id, name=body.name, instructions=body.instructions, presentation=body.presentation)
if row is None:
raise _not_found()
return _to_response(row)
@router.post("/{project_id}/archive", response_model=ProjectResponse)
@require_permission("projects", "write")
async def archive_project(project_id: str, request: Request) -> ProjectResponse:
row = await get_project_repo(request).set_status(project_id, "archived")
if row is None:
raise _not_found()
return _to_response(row)
@router.post("/{project_id}/restore", response_model=ProjectResponse)
@require_permission("projects", "write")
async def restore_project(project_id: str, request: Request) -> ProjectResponse:
row = await get_project_repo(request).set_status(project_id, "active")
if row is None:
raise _not_found()
return _to_response(row)
@router.delete("/{project_id}", status_code=204)
@require_permission("projects", "delete")
async def delete_project(project_id: str, request: Request) -> None:
if not await get_project_repo(request).delete(project_id):
raise _not_found()
@router.get("/{project_id}/threads", response_model=list[ProjectThreadResponse])
@require_permission("projects", "read")
@require_permission("threads", "read")
async def list_project_threads(project_id: str, request: Request, limit: int = Query(default=100, ge=1, le=1000), offset: int = Query(default=0, ge=0)) -> list[ProjectThreadResponse]:
if await get_project_repo(request).get(project_id) is None:
raise _not_found()
# Active members only, mirroring the sidebar's `archived: false` lists:
# an archived chat leaves the project's pages the same way it leaves the
# sidebar and returns only via the global Archived tab.
rows = await get_thread_store(request).search(
project_id=project_id,
archived=False,
limit=limit,
offset=offset,
)
return [
ProjectThreadResponse(
thread_id=r["thread_id"],
display_name=r.get("display_name"),
created_at=coerce_iso(r.get("created_at", "")),
updated_at=coerce_iso(r.get("updated_at", "")),
metadata=r.get("metadata", {}),
)
for r in rows
]