deer-flow/frontend/tests/e2e/project-documents.spec.ts
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

244 lines
8.6 KiB
TypeScript

import { expect, test, type Page } from "@playwright/test";
import { mockLangGraphAPI } from "./utils/mock-api";
const PROJECT_ID = "11111111-1111-1111-1111-111111111111";
const THREAD_ID = "00000000-0000-0000-0000-000000000701";
function seedProject(): Parameters<typeof mockLangGraphAPI>[1] {
return {
projects: [{ id: PROJECT_ID, name: "Alpha" }],
threads: [
{
thread_id: THREAD_ID,
title: "Project chat",
updated_at: "2026-09-10T10:00:00Z",
metadata: { deerflow_project_id: PROJECT_ID },
},
],
};
}
async function openDocumentsTab(page: Page) {
await page.goto(`/workspace/projects/${PROJECT_ID}`, {
waitUntil: "domcontentloaded",
});
await page.getByRole("tab", { name: "Documents", exact: true }).click();
await expect(page.getByTestId("project-documents-shelf")).toBeVisible();
}
test("project document lifecycle: upload → shelf → attach → trash → restore → purge", async ({
page,
}) => {
mockLangGraphAPI(page, seedProject());
// Upload joins the shelf.
await openDocumentsTab(page);
await page.getByTestId("project-documents-upload-input").setInputFiles({
name: "notes.txt",
mimeType: "text/plain",
buffer: Buffer.from("hello shelf"),
});
await expect(page.getByText("notes.txt", { exact: true })).toBeVisible();
// Attach hands the thread's composer a completed attachment.
await page
.getByRole("button", { name: "Attach to chat", exact: true })
.click();
await page
.getByRole("dialog")
.getByRole("button", { name: "Project chat", exact: true })
.click();
await expect(page).toHaveURL(new RegExp(`/workspace/chats/${THREAD_ID}`));
await expect(page.getByTestId("project-attachment-chip")).toContainText(
"notes.txt",
);
// Move to trash behind its retention-window confirmation.
await openDocumentsTab(page);
await page
.getByRole("button", { name: "Move to trash", exact: true })
.click();
await expect(
page.getByText(/will move to the trash and stay recoverable for 30 days/),
).toBeVisible();
await page
.getByRole("dialog")
.getByRole("button", { name: "Move to trash", exact: true })
.click();
await expect(page.getByText("No documents yet")).toBeVisible();
// Trash view: origin project + retention, then restore into the origin.
await page.goto("/workspace/trash", { waitUntil: "domcontentloaded" });
await expect(page.getByText("notes.txt", { exact: true })).toBeVisible();
await expect(page.getByText(/from Alpha/)).toBeVisible();
await expect(page.getByText(/days left/)).toBeVisible();
await page.getByRole("button", { name: "Restore", exact: true }).click();
await expect(page.getByText("Trash is empty.")).toBeVisible();
// Restored row is back on the shelf; trash it again, then purge for good.
await openDocumentsTab(page);
await expect(page.getByText("notes.txt", { exact: true })).toBeVisible();
await page
.getByRole("button", { name: "Move to trash", exact: true })
.click();
await page
.getByRole("dialog")
.getByRole("button", { name: "Move to trash", exact: true })
.click();
await page.goto("/workspace/trash", { waitUntil: "domcontentloaded" });
await page
.getByRole("button", { name: "Delete permanently", exact: true })
.click();
await expect(
page.getByText(/will be permanently deleted. This cannot be undone./),
).toBeVisible();
await page
.getByRole("dialog")
.getByRole("button", { name: "Delete permanently", exact: true })
.click();
await expect(page.getByText("Trash is empty.")).toBeVisible();
});
test("Empty trash permanently deletes every freshly trashed row", async ({
page,
}) => {
const trashedAt = new Date(Date.now() - 60_000).toISOString();
mockLangGraphAPI(page, {
...seedProject(),
trashDocuments: ["one.txt", "two.txt"].map((name, index) => ({
id: `trash-${index}`,
project_id: PROJECT_ID,
name,
size_bytes: 32,
// Trashed a minute ago: far inside the 30-day retention window, so the
// action cannot lean on the retention sweep to delete them.
trashed_at: trashedAt,
trash_origin: { project_id: PROJECT_ID, project_name: "Alpha" },
})),
});
await page.goto("/workspace/trash", { waitUntil: "domcontentloaded" });
await expect(page.getByText("one.txt", { exact: true })).toBeVisible();
await expect(page.getByText("two.txt", { exact: true })).toBeVisible();
await page.getByTestId("trash-empty-button").click();
await expect(
page.getByText(
"2 documents will be permanently deleted. This cannot be undone.",
),
).toBeVisible();
await page
.getByRole("dialog")
.getByRole("button", { name: "Empty trash", exact: true })
.click();
// The confirmation promised both rows; both are gone.
await expect(page.getByText("Trash is empty.")).toBeVisible();
await expect(page.getByText("one.txt", { exact: true })).toHaveCount(0);
await expect(page.getByText("two.txt", { exact: true })).toHaveCount(0);
});
test("the shelf paginates past the first page and the trash confirmation names the configured retention", async ({
page,
}) => {
mockLangGraphAPI(page, {
...seedProject(),
projectsConfig: { trash_retention_days: 7 },
projectDocuments: Array.from({ length: 120 }, (_, index) => ({
id: `doc-${index}`,
project_id: PROJECT_ID,
name: `doc-${String(index).padStart(3, "0")}.txt`,
size_bytes: 128,
})),
});
await openDocumentsTab(page);
// First page: 100 of 120 loaded, with a Load more affordance.
await expect(page.getByText("Showing 100 of 120")).toBeVisible();
await expect(page.getByText("doc-099.txt", { exact: true })).toBeVisible();
await expect(page.getByText("doc-119.txt", { exact: true })).toHaveCount(0);
await page.getByTestId("project-documents-load-more").click();
await expect(page.getByText("Showing 120 of 120")).toBeVisible();
await expect(page.getByText("doc-119.txt", { exact: true })).toBeVisible();
await expect(page.getByTestId("project-documents-load-more")).toHaveCount(0);
// The confirmation names the server-configured 7-day window, not the
// 30-day default.
await page
.getByRole("button", { name: "Move to trash", exact: true })
.first()
.click();
await expect(page.getByText(/stay recoverable for 7 days/)).toBeVisible();
await page
.getByRole("dialog")
.getByRole("button", { name: "Cancel", exact: true })
.click();
});
test("the trash view paginates and counts down the configured retention window", async ({
page,
}) => {
mockLangGraphAPI(page, {
...seedProject(),
projectsConfig: { trash_retention_days: 7 },
trashDocuments: Array.from({ length: 120 }, (_, index) => ({
id: `trash-${index}`,
project_id: PROJECT_ID,
name: `trash-${String(index).padStart(3, "0")}.txt`,
size_bytes: 64,
// Trashed 10 days ago: past the configured 7-day window.
trashed_at: new Date(Date.now() - 10 * 86_400_000).toISOString(),
trash_origin: { project_id: PROJECT_ID, project_name: "Alpha" },
})),
});
await page.goto("/workspace/trash", { waitUntil: "domcontentloaded" });
await expect(page.getByText("Showing 100 of 120")).toBeVisible();
await page.getByTestId("trash-load-more").click();
await expect(page.getByText("Showing 120 of 120")).toBeVisible();
await expect(page.getByTestId("trash-load-more")).toHaveCount(0);
await expect(page.getByText(/Less than a day left/).first()).toBeVisible();
});
test("a project member thread renders no injected <project> text in the message list", async ({
page,
}) => {
mockLangGraphAPI(page, {
projects: [
{
id: PROJECT_ID,
name: "Alpha",
instructions: "Always answer in haiku.",
},
],
threads: [
{
thread_id: THREAD_ID,
title: "Project chat",
updated_at: "2026-09-10T10:00:00Z",
metadata: { deerflow_project_id: PROJECT_ID },
messages: [
{
type: "human",
id: "msg-human-1",
content: [{ type: "text", text: "status?" }],
},
{ type: "ai", id: "msg-ai-1", content: "all green" },
],
},
],
});
await page.goto(`/workspace/chats/${THREAD_ID}`, {
waitUntil: "domcontentloaded",
});
const list = page.getByTestId("main-message-list");
await expect(list.getByText("all green", { exact: true })).toBeVisible({
timeout: 15_000,
});
// Project context is injected request-side only: no <project> block, and no
// instructions text, ever reaches the rendered conversation.
await expect(list.getByText(/<project>/)).toHaveCount(0);
await expect(list.getByText(/Always answer in haiku/)).toHaveCount(0);
});