Files
copilotkit__copilotkit/showcase/integrations/ms-agent-python/tests/e2e/headless-complete.spec.ts
Alem Tuzlak 5cd77233b7 feat(showcase/ms-agent-python): LGP parity sweep — 33/37 cells green
Brings ms-agent-python to one-to-one parity with langgraph-python (the D5
north star). Playwright e2e suite goes from 49/108 (~26%) → 164/178 (~92%),
33 of 37 cells fully green.

Manifest parity:
- Drop 4 MAF-only cells with no LGP analog: agentic-chat-reasoning,
  hitl-in-chat-booking, shared-state-write, reasoning-default-render.
  Reasoning is handled by reasoning-default + reasoning-custom (LGP);
  booking pill folds into hitl-in-chat; shared-state-write was a TODO stub.
- Rename byoc-hashbrown → declarative-hashbrown and byoc-json-render →
  declarative-json-render. Demo dir, API route dir, and frontend agent id
  follow LGP's naming. Python module files retain the legacy `byoc_*`
  prefix and FastAPI paths stay `/byoc-hashbrown` / `/byoc-json-render`
  (matches LGP's "module name retains legacy graph id" convention).
- Port LGP `_shared/`, `_shared/interrupt-fallback-slots.ts`, and
  `demos/layout.tsx` for one-to-one parity.

Cells ported verbatim from LGP (page + spec):
- agentic-chat, auth, beautiful-chat, chat-customization-css, chat-slots,
  declarative-gen-ui, declarative-hashbrown, declarative-json-render,
  frontend-tools, frontend-tools-async, gen-ui-agent, gen-ui-interrupt,
  gen-ui-tool-based, headless-complete, headless-simple, hitl-in-app,
  hitl-in-chat, shared-state-read, shared-state-read-write,
  shared-state-streaming, subagents, tool-rendering, plus all four
  tool-rendering* variants, a2ui-fixed-schema, agent-config, mcp-apps,
  multimodal, open-gen-ui, open-gen-ui-advanced, prebuilt-popup,
  prebuilt-sidebar, readonly-state-agent-context, reasoning-default,
  reasoning-custom, voice.

Backend infrastructure:
- Swap shared `OpenAIChatClient` (Responses API) → `OpenAIChatCompletionClient`
  (ChatCompletions). Root cause of the cross-cell post-tool ChatClientException
  family: Responses API is stateful and only sends NEW items per leg,
  relying on `previous_response_id` for history. aimock has no view of
  that server-side state, so second-leg requests arrived without the
  user message — fixture matchers keyed on `userMessage` couldn't fire
  and the run fell through to real OpenAI. ChatCompletions sends full
  history every leg, matching the LGP wire shape.
- Bump @ag-ui/client ^0.0.43 → ^0.0.53 (matches google-adk/LGP). Fixes
  the REASONING_* Zod discriminator trap on the catch-all agent.
- Regenerate package-lock.json in isolation outside the pnpm monorepo so
  npm-arborist doesn't resolve transitives against pnpm's hoisted
  symlinks (avoid 40+ `../../../node_modules/.pnpm/...` paths in the
  lockfile that break `npm ci` inside Docker).
- Add `yaml` (^2.8.4) for the new `src/app/demos/layout.tsx` that reads
  manifest.yaml for per-cell page titles (LGP parity).

New / re-added MAF agent backends with LGP-equivalent behavior:
- reasoning_agent.py (uses Responses API explicitly — the only chat
  client that emits AG-UI REASONING_MESSAGE_* events; rest of the
  integration stays on ChatCompletions).
- tool_rendering_agent.py (non-reasoning sibling of the existing
  reasoning_chain variant; shares tool surface via direct imports so
  they can never drift apart; routes the three catchall cells to a
  non-reasoning backend so the default renderer spec stops failing on
  leaked reasoning blocks).
- gen_ui_agent.py — `set_steps` tool + `steps` state schema +
  `predict_state_config` mirrors LGP's StateStreamingMiddleware shape.
- shared_state_streaming.py — `write_document` tool with
  `predict_state_config` that streams the `document` arg into
  `state.document` per-token.
- readonly_state_agent_context.py — minimal agent that consumes
  frontend-provided `useAgentContext` entries; no tools.
- headless_complete_agent.py — three deterministic tools (`get_weather`,
  `get_stock_price`, `get_revenue_chart`) mounted at /headless-complete
  on the mcp-apps runtime (was routing to catch-all sales agent, which
  returned seeded-random weather instead of the deterministic 68°F the
  test asserts on).

Wiring:
- copilotkit/route.ts: register the new agents, drop the stale
  shared-state-write entry, route all three tool-rendering variants to
  the non-reasoning backend (the reasoning-chain cell keeps its own
  dedicated path), register reasoning-default + reasoning-custom on
  /reasoning, register gen-ui-agent on /gen-ui-agent,
  shared-state-streaming on /shared-state-streaming,
  readonly-state-agent-context on its dedicated path.
- copilotkit-mcp-apps/route.ts: register headless-complete agent (was
  missing — the strict useAgent runtime sync in the newer
  @copilotkit/react-core surfaced the gap).
- copilotkit-declarative-hashbrown/route.ts + copilotkit-declarative-json-render/route.ts:
  new dedicated runtimes; agent IDs and runtime URLs follow LGP.
- copilotkit-declarative-gen-ui/route.ts: drop non-LGP `openGenerativeUI:
  false` for parity.

A2UI tool rename — `render_a2ui` → `_design_a2ui_surface`:
- Ported LGP's `tools/generate_a2ui.py` (LGP renamed the secondary-LLM
  tool to `_design_a2ui_surface` to avoid the A2UI middleware's bypass;
  shared d5-all.json fixtures key the response on this name).
- Renamed every `render_a2ui` occurrence in src/agents/{a2ui_dynamic,
  agent,beautiful_chat}.py and `tools/__init__.py`.
- Updated 4 declarative-gen-ui aimock fixtures to pass `context` arg in
  the first-leg `generate_a2ui` tool call (agent_framework doesn't
  auto-inject AgentSession into our @tool function so `session=None` and
  the secondary-LLM `user_content` was defaulting to a catch-all string
  containing "KPI dashboard" — every pill matched the KPI fixture).

Aimock router patch persisted alongside the integration changes:
hasToolResult matcher restricted to scan only messages after the last
user message (was global). The patch lives in F:/projects/cpk/aimock —
upstream PR pending.

Test infrastructure:
- playwright.config.ts: cap local workers at 4 + retries at 1. CI keeps
  workers=1, retries=2. `agent_framework.Agent` is reused across requests
  and the shared OpenAI HTTP client serialises concurrent SSE streams;
  >4 workers makes 30s timeouts inevitable on a few cells. Confirmed
  with hard data: workers=1 = 164 passed (16.8 min), workers=4+retries=1
  = 164 passed (7.2 min), workers=undefined = 159 passed. Same green
  set, ~2x faster. Long-term upstream fix is per-request Agent
  instantiation in agent_framework_ag_ui.

Remaining 14 failures across 4 cells documented per-cell in the Notion
D5 sweep doc (declarative-gen-ui A2UI surface mounting, multimodal
attachment forwarding, tool-rendering-default-catchall multi-pill chain,
tool-rendering-reasoning-chain multi-leg chains). Each has a specific
next-pass action.
2026-05-19 18:36:01 +02:00

151 lines
5.8 KiB
TypeScript

import { test, expect } from "@playwright/test";
/**
* Headless Chat (Complete) — full headless surface in one demo. The
* hand-rolled chat shell wires every render hook CopilotKit exposes
* (useRenderTool, useDefaultRenderTool, useComponent, useRenderToolCall,
* useSuggestions, useAttachments) on top of shadcn primitives.
*
* The 5-test plan drives the 4 empty-state pills and asserts:
* - the per-tool render component (Weather / Stock / Highlight / Chart)
* is mounted on the headless surface (scoped testid)
* - the assistant narration arrives in the custom message-assistant
* bubble (`[data-testid="headless-message-assistant"]`)
*
* Each pill exercises a DIFFERENT render-hook path. If any hook regresses,
* only that test fails. If the surface silently demotes back to the default
* <CopilotChat />, the headless-specific testids vanish and all 4 tool
* tests fail.
*/
const PILL_WEATHER = "Try suggestion: What's the weather in Tokyo?";
const PILL_STOCK = "Try suggestion: What's AAPL trading at?";
const PILL_HIGHLIGHT = "Try suggestion: Highlight: ship the demo on Friday";
const PILL_CHART =
"Try suggestion: Show me a chart of revenue over the last six months";
const ASSERT_TIMEOUT = 45_000;
test.describe("Headless Chat (Complete)", () => {
test.beforeEach(async ({ page }) => {
await page.goto("/demos/headless-complete");
});
test("page loads with custom composer and four suggestion pills", async ({
page,
}) => {
await expect(
page.locator('[data-testid="headless-composer"]'),
).toBeVisible();
// Pills use aria-label `Try suggestion: ${prompt}` so screen readers can
// disambiguate. We assert all four are mounted on first paint.
await expect(
page.getByRole("button", { name: PILL_WEATHER, exact: true }),
).toBeVisible();
await expect(
page.getByRole("button", { name: PILL_STOCK, exact: true }),
).toBeVisible();
await expect(
page.getByRole("button", { name: PILL_HIGHLIGHT, exact: true }),
).toBeVisible();
await expect(
page.getByRole("button", { name: PILL_CHART, exact: true }),
).toBeVisible();
});
test("weather pill renders the headless WeatherCard via useRenderTool plus the deterministic narration", async ({
page,
}) => {
await page.getByRole("button", { name: PILL_WEATHER, exact: true }).click();
const card = page.locator('[data-testid="headless-weather-card"]').first();
await expect(card).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(card).toContainText("Tokyo");
await expect(card).toContainText("Sunny");
await expect(card).toContainText("68°F");
const assistant = page
.locator('[data-testid="headless-message-assistant"]')
.last();
await expect(assistant).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(assistant).toContainText("Tokyo is 22°C and partly cloudy.", {
timeout: ASSERT_TIMEOUT,
});
});
test("AAPL pill renders the headless StockCard via useRenderTool plus the deterministic narration", async ({
page,
}) => {
await page.getByRole("button", { name: PILL_STOCK, exact: true }).click();
const card = page.locator('[data-testid="headless-stock-card"]').first();
await expect(card).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(card).toContainText("AAPL");
await expect(card).toContainText("$189.42");
await expect(card).toContainText("+1.27%");
const assistant = page
.locator('[data-testid="headless-message-assistant"]')
.last();
await expect(assistant).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(assistant).toContainText(
"AAPL is trading at $189.42, up 1.27% on the day",
{ timeout: ASSERT_TIMEOUT },
);
});
test("highlight pill renders the headless HighlightNote via useComponent plus the deterministic narration", async ({
page,
}) => {
await page
.getByRole("button", { name: PILL_HIGHLIGHT, exact: true })
.click();
// The highlight card is the frontend-tool render surface (useComponent).
const card = page
.locator('[data-testid="headless-highlight-card"]')
.first();
await expect(card).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(card).toContainText("ship the demo on Friday");
// Narration leading phrase comes from the new high-priority fixture in
// d5-all.json; the showcase-assistant catch-all in feature-parity.json
// would otherwise win and reply with "Hi there! I'm your showcase
// assistant…".
const assistant = page
.locator('[data-testid="headless-message-assistant"]')
.last();
await expect(assistant).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(assistant).toContainText("ship the demo on Friday", {
timeout: ASSERT_TIMEOUT,
});
});
test("revenue chart pill renders the headless ChartCard via useRenderTool plus the deterministic narration", async ({
page,
}) => {
await page.getByRole("button", { name: PILL_CHART, exact: true }).click();
const card = page.locator('[data-testid="headless-revenue-chart"]').first();
await expect(card).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(card).toContainText("Quarterly revenue");
await expect(card).toContainText("Last six months · USD thousands");
// Month labels come from the python tool's deterministic mock series
// (Jan…Jun); recharts renders them as <text> tick labels inside the SVG.
for (const month of ["Jan", "Feb", "Mar", "Apr", "May", "Jun"]) {
await expect(card).toContainText(month);
}
const assistant = page
.locator('[data-testid="headless-message-assistant"]')
.last();
await expect(assistant).toBeVisible({ timeout: ASSERT_TIMEOUT });
await expect(assistant).toContainText(
"Here is the chart of revenue over the last six months",
{ timeout: ASSERT_TIMEOUT },
);
});
});