mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-06-09 17:12:01 +00:00
* test(e2e): record/replay front-back contract verification Guards the front-back contract with a deterministic, key-free record/replay harness (mirrors open-design's golden-trace approach): - ReplayChatModel (tests/replay_provider.py): replays recorded LLM turns by a normalized hash of the model input. Strips <system-reminder>/date/uuid/tmp-path so one fixture replays across days and from both the browser and direct-POST paths; a miss raises loudly (no silent divergence). - Recording is record-through-browser (scripts/record_gateway.py + build_fixture_from_jsonl.py + frontend/tests/e2e-record): a real run is driven through the real frontend so captured inputs match exactly what the browser sends; fixtures contain no API key. - Layer 1 — backend golden (tests/test_replay_golden.py): replay through the real gateway, assert the SSE event sequence == committed golden. - Layer 2 — full-stack render (frontend/tests/e2e-real-backend): real Next.js + real gateway (replay model) + Chromium; assert the replayed auto-title and follow-up suggestions render. DOM assertions are the gate; visual regression is a local dev gate (CI uploads the render as an artifact). - CI (.github/workflows/replay-e2e.yml): both layers, triggered on EITHER side of the contract (frontend/** or backend gateway/harness/fixtures). * test(e2e): multi-run render-order cross-stack scenario (#3352) Guards the dangerous front-back class where a backend ordering change silently breaks a frontend assumption while both sides' unit tests stay green. Reproduces issue #3352: backend list_by_thread returns runs newest-first (#2932) and the frontend prepended per-run pages, inverting chronological order once the checkpoint no longer held the older messages. - tests/seed_runs_router.py: test-only seeder, mounted on the replay gateway only when DEERFLOW_ENABLE_TEST_SEED=1 (never in the production app). Seeds a thread with >=2 runs + per-run message events and no checkpoint -- the #3352 precondition -- so the frontend per-run reload path is the sole source of truth and the prepend inversion is observable. - frontend/tests/e2e-real-backend/multi-run-order.spec.ts: drives the real frontend against the real gateway, asserts the first run renders above the second. Reverting the #3354 fix turns it red. - replay-e2e.yml: trigger on the new replay test-infra paths. - docs: REPLAY_E2E.md cross-stack scenario section. * test(e2e): address Copilot review on the replay harness - Fix stale recorder references (scripts/record_traces.py -> scripts/record_gateway.py + scripts/build_fixture_from_jsonl.py) in replay_provider.py, test_replay_golden.py, _replay_fixture.py. - MODE_CONTEXT['ultra']: thinking_enabled False -> True, mirroring the frontend's `context.mode !== 'flash'` (hooks.ts). It did not affect the hashed input (Layer 1 golden still green), but the table now matches the real frontend context it claims to mirror. - replay_provider.py docstring: stop claiming memory is recorded-enabled; the replay config disables memory/summarization for determinism (title stays, as an in-graph deterministic call). - record_gateway.py / run_replay_gateway.py: override DEER_FLOW_HOME instead of setdefault, so an outer value can't leak into the hermetic harness. - record_gateway.py: clear error when DEERFLOW_RECORD_OUT is unset (was a bare KeyError). - playwright.record.config.ts: forward OPENAI_*/DEERFLOW_RECORD_OUT only when set, so the gateway raises a clear 'missing env' error instead of getting ''. * test(e2e): address Copilot review round 2 - seed_runs_router.py: constrain SeedMessage.role to Literal['human','ai'] so a bad value is a clean 422 at the boundary instead of a 500 (KeyError on _EVENT_TYPE). - record-write-read-file.spec.ts: waitForCaptureStable now throws on timeout instead of returning the last count, so a truncated/partial recording can't pass silently. - real-backend-render.spec.ts: guard the suggestions JSON.parse; a bracket-prefixed non-JSON turn falls back to '' so the existing not.toBe('') assertion fails clearly instead of a generic parse throw.
109 lines
3.8 KiB
YAML
109 lines
3.8 KiB
YAML
name: Replay E2E (front-back contract)
|
|
|
|
# Guards the front-back contract via record/replay (no API key in CI):
|
|
# Layer 1 — backend golden: replay a recorded trace through the real gateway,
|
|
# assert the SSE event sequence matches the committed golden.
|
|
# Layer 2 — full-stack render: real Next.js frontend + real gateway (replay
|
|
# model) + Chromium; assert the replayed turns render in the browser.
|
|
# Triggered by changes on EITHER side of the contract so a backend change can no
|
|
# longer pass without the frontend-facing checks running.
|
|
|
|
on:
|
|
push:
|
|
branches: ["main"]
|
|
paths:
|
|
- "frontend/**"
|
|
- "backend/app/gateway/**"
|
|
- "backend/packages/harness/**"
|
|
- "backend/tests/fixtures/replay/**"
|
|
- "backend/tests/replay_provider.py"
|
|
- "backend/tests/_replay_fixture.py"
|
|
- "backend/tests/seed_runs_router.py"
|
|
- "backend/tests/test_replay_golden.py"
|
|
- "backend/scripts/run_replay_gateway.py"
|
|
- ".github/workflows/replay-e2e.yml"
|
|
pull_request:
|
|
types: [opened, synchronize, reopened, ready_for_review]
|
|
paths:
|
|
- "frontend/**"
|
|
- "backend/app/gateway/**"
|
|
- "backend/packages/harness/**"
|
|
- "backend/tests/fixtures/replay/**"
|
|
- "backend/tests/replay_provider.py"
|
|
- "backend/tests/_replay_fixture.py"
|
|
- "backend/tests/seed_runs_router.py"
|
|
- "backend/tests/test_replay_golden.py"
|
|
- "backend/scripts/run_replay_gateway.py"
|
|
- ".github/workflows/replay-e2e.yml"
|
|
|
|
concurrency:
|
|
group: replay-e2e-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
backend-replay-golden:
|
|
name: Layer 1 — backend golden (no API key)
|
|
if: github.event_name != 'pull_request' || github.event.pull_request.draft == false
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 15
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v6
|
|
with:
|
|
python-version: "3.12"
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v7
|
|
- name: Install backend dependencies
|
|
working-directory: backend
|
|
run: uv sync --group dev
|
|
- name: Replay golden (backend SSE contract)
|
|
working-directory: backend
|
|
run: PYTHONPATH=. uv run pytest tests/test_replay_golden.py -v
|
|
|
|
fullstack-replay-render:
|
|
name: Layer 2 — full-stack render (no API key)
|
|
if: github.event_name != 'pull_request' || github.event.pull_request.draft == false
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 25
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v6
|
|
with:
|
|
python-version: "3.12"
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v7
|
|
- name: Install backend dependencies (replay gateway)
|
|
working-directory: backend
|
|
run: uv sync --group dev
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: "22"
|
|
- name: Enable Corepack
|
|
run: corepack enable
|
|
- name: Use pinned pnpm version
|
|
run: corepack prepare pnpm@10.26.2 --activate
|
|
- name: Install frontend dependencies
|
|
working-directory: frontend
|
|
run: pnpm install --frozen-lockfile
|
|
- name: Install Playwright Chromium
|
|
working-directory: frontend
|
|
run: npx playwright install chromium --with-deps
|
|
- name: Full-stack replay render (DOM assertions are the gate)
|
|
working-directory: frontend
|
|
run: pnpm exec playwright test -c playwright.real-backend.config.ts
|
|
- name: Upload report + render artifact
|
|
uses: actions/upload-artifact@v4
|
|
if: ${{ !cancelled() }}
|
|
with:
|
|
name: replay-render
|
|
path: |
|
|
frontend/playwright-report/
|
|
frontend/test-results/
|
|
retention-days: 7
|