mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-09-20 11:36:17 +00:00
* 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.
161 lines
6.4 KiB
Python
161 lines
6.4 KiB
Python
"""Conversation-files view for a project's member threads (Phase 2 Slice C).
|
|
|
|
``GET /api/projects/{project_id}/thread-files`` (§6.5/§7.4): a read-only
|
|
aggregation that pages member threads over the same non-archived ordering
|
|
the project thread list uses and reports each thread's uploads and outputs
|
|
(uploads via ``list_files_in_dir``; outputs via the new
|
|
``sandbox_outputs_dir`` listing — no outputs-listing endpoint exists
|
|
elsewhere). It keeps no storage of its own: entries disappear when their
|
|
thread is deleted, which is the honest ownership statement. The view is the
|
|
discovery route for Save to project and never feeds the shelf, the index,
|
|
or the tools. Per-thread file caps are reported per group
|
|
(``groups[].truncated``) and OR-ed into the envelope — never a silent cut.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from datetime import UTC, datetime
|
|
from typing import Literal
|
|
|
|
from fastapi import APIRouter, HTTPException, Query, Request
|
|
from pydantic import BaseModel
|
|
|
|
from app.gateway.authz import require_permission
|
|
from app.gateway.deps import get_project_repo, get_thread_store
|
|
from deerflow.config.paths import Paths, get_paths
|
|
from deerflow.runtime.user_context import get_effective_user_id
|
|
from deerflow.uploads.manager import list_files_in_dir, output_artifact_url, upload_artifact_url
|
|
from deerflow.utils.file_io import run_file_io
|
|
from deerflow.utils.time import coerce_iso
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
router = APIRouter(prefix="/api/projects/{project_id}/thread-files", tags=["project-thread-files"])
|
|
|
|
|
|
class ThreadFileEntry(BaseModel):
|
|
"""One file in a member thread's uploads or outputs directory."""
|
|
|
|
kind: Literal["upload", "output"]
|
|
name: str
|
|
size_bytes: int
|
|
modified_at: str
|
|
artifact_url: str
|
|
|
|
|
|
class ThreadFileGroup(BaseModel):
|
|
"""One member thread's contribution to the conversation-files view."""
|
|
|
|
thread_id: str
|
|
display_name: str | None = None
|
|
updated_at: str
|
|
files: list[ThreadFileEntry]
|
|
#: True when this thread's file list was cut at ``file_limit`` — the
|
|
#: per-group report behind the envelope's OR-ed ``truncated``.
|
|
truncated: bool
|
|
|
|
|
|
class ThreadFilesResponse(BaseModel):
|
|
"""Paged groups plus the member-thread cursor and the truncation report."""
|
|
|
|
groups: list[ThreadFileGroup]
|
|
next_offset: int | None = None
|
|
truncated: bool
|
|
|
|
|
|
def _not_found() -> HTTPException:
|
|
# Fail closed: foreign projects are indistinguishable from missing ones.
|
|
return HTTPException(status_code=404, detail="Project not found")
|
|
|
|
|
|
def _entry(kind: Literal["upload", "output"], thread_id: str, file: dict, artifact_url) -> ThreadFileEntry:
|
|
modified = file.get("modified")
|
|
modified_at = datetime.fromtimestamp(modified, tz=UTC).isoformat() if isinstance(modified, int | float) else ""
|
|
return ThreadFileEntry(
|
|
kind=kind,
|
|
name=file["filename"],
|
|
size_bytes=file["size"],
|
|
modified_at=modified_at,
|
|
artifact_url=artifact_url(thread_id, file["filename"]),
|
|
)
|
|
|
|
|
|
async def _list_thread_files(paths: Paths, *, user_id: str, thread_id: str, file_limit: int) -> tuple[list[ThreadFileEntry], bool]:
|
|
"""List one thread's uploads + outputs, capped at ``file_limit`` entries.
|
|
|
|
Returns ``(entries, truncated)`` — the cap is always reported, never a
|
|
silent cut (§7.4). Uploads are listed via the shared
|
|
``list_files_in_dir``; outputs use the new ``sandbox_outputs_dir``
|
|
listing this view introduces. Directory scans run in the file-IO worker.
|
|
"""
|
|
uploads_dir = paths.sandbox_uploads_dir(thread_id, user_id=user_id)
|
|
outputs_dir = paths.sandbox_outputs_dir(thread_id, user_id=user_id)
|
|
uploads_listing = await run_file_io(list_files_in_dir, uploads_dir)
|
|
outputs_listing = await run_file_io(list_files_in_dir, outputs_dir)
|
|
entries = [_entry("upload", thread_id, f, upload_artifact_url) for f in uploads_listing["files"]]
|
|
entries += [_entry("output", thread_id, f, output_artifact_url) for f in outputs_listing["files"]]
|
|
truncated = len(entries) > file_limit
|
|
return entries[:file_limit], truncated
|
|
|
|
|
|
@router.get("", response_model=ThreadFilesResponse)
|
|
@require_permission("projects", "read")
|
|
@require_permission("threads", "read")
|
|
async def list_project_thread_files(
|
|
project_id: str,
|
|
request: Request,
|
|
offset: int = Query(default=0, ge=0),
|
|
thread_limit: int = Query(default=20, ge=1, le=50),
|
|
file_limit: int = Query(default=50, ge=1, le=200),
|
|
) -> ThreadFilesResponse:
|
|
"""Aggregate member threads' files, paged by thread (§6.5/§7.4).
|
|
|
|
Member threads are paged (``thread_limit``) over the same non-archived
|
|
ordering the project thread list uses — ``offset`` is the member-thread
|
|
cursor and ``next_offset`` resumes it (``null`` when no threads remain).
|
|
Each page thread contributes up to ``file_limit`` files across its
|
|
uploads and outputs; a cut is reported per group (``groups[].truncated``)
|
|
and OR-ed into the envelope ``truncated``.
|
|
"""
|
|
if await get_project_repo(request).get(project_id) is None:
|
|
raise _not_found()
|
|
# One extra row decides whether another page exists; it is never rendered.
|
|
rows = await get_thread_store(request).search(
|
|
project_id=project_id,
|
|
archived=False,
|
|
limit=thread_limit + 1,
|
|
offset=offset,
|
|
)
|
|
has_more = len(rows) > thread_limit
|
|
page = rows[:thread_limit]
|
|
|
|
user_id = get_effective_user_id()
|
|
paths = get_paths()
|
|
truncated = False
|
|
groups: list[ThreadFileGroup] = []
|
|
for row in page:
|
|
thread_id = row["thread_id"]
|
|
try:
|
|
entries, thread_truncated = await _list_thread_files(paths, user_id=user_id, thread_id=thread_id, file_limit=file_limit)
|
|
except ValueError:
|
|
# A member row whose id cannot resolve to thread storage is
|
|
# skipped rather than failing the whole view.
|
|
logger.warning("Skipping thread-files listing for unresolvable thread id: %s", thread_id)
|
|
continue
|
|
truncated = truncated or thread_truncated
|
|
groups.append(
|
|
ThreadFileGroup(
|
|
thread_id=thread_id,
|
|
display_name=row.get("display_name"),
|
|
updated_at=coerce_iso(row.get("updated_at", "")),
|
|
files=entries,
|
|
truncated=thread_truncated,
|
|
)
|
|
)
|
|
return ThreadFilesResponse(
|
|
groups=groups,
|
|
next_offset=(offset + len(page)) if has_more else None,
|
|
truncated=truncated,
|
|
)
|