skills/copilotkit__copilotkit
1
0
Fork 0
mirror of https://github.com/CopilotKit/CopilotKit.git synced 2026-09-14 16:26:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
copilotkit__copilotkit/showcase/integrations/langgraph-python/qa/a2ui-fixed-schema.md
T
Tyler Slaton ebad989855 chore(showcase/langgraph-python): manifest, runtime, e2e, cleanup 
Cross-cutting changes that don't belong with any one demo: manifest +
landing-page tags, runtime route adjustments, e2e + QA notes that
follow the demo renames, and a few small cleanups.

Manifest (manifest.yaml + src/app/page.tsx tag labels):
- Naming convention: every demo uses `Thing: Subthing` (Generative UI:
  Tool Rendering - Default / Custom Default / Specific; Open Generative
  UI: Default / Advanced; Shared State: Streaming / Read + Write;
  Reasoning: Default / Custom; Frontend Tools: In-App Actions / Async;
  Human in the Loop: In-chat / In-App / Interrupt based; Chat
  Customization: CSS / Slots; Headless UI: Simple / Complete).
- Retags: Auth → `platform`; HITL Step Selection + Interrupt-based →
  `interactivity`; Reasoning Default + Custom → `chat-ui`; Generative
  UI: Tools → `generative-ui`.
- Renames: Readonly State (Agent Context) → Frontend Context Sharing.
- HITL slot points at /demos/hitl-in-chat (working
  useHumanInTheLoop+interrupt path) instead of the previous
  /demos/hitl that had no backend `interrupt()` calls.
- Highlight paths corrected for the rebuilt headless demos (root-level
  paths replaced with hooks/, chat/, tools/, attachments/ subdirs).
- Descriptions rewritten where they had drifted from the implementation
  (gen-ui-agent: dropped useCoAgentStateRender claim;
  headless-simple: shadcn primitives, not raw Tailwind;
  headless-complete: enumerates the actual hooks wired).

Runtime / route:
- src/app/api/copilotkit/route.ts — 30 agents registered (incl. the
  reasoning-custom rename from agentic-chat-reasoning).
- copilotkit-mcp-apps/route.ts replaced with [[...slug]]/route.ts so v2
  subpath POSTs (/v2/agent/run) resolve.
- src/app/api/copilotkit-voice/[[...slug]]/route.ts — env var standardized
  (was `AGENT_URL || LANGGRAPH_DEPLOYMENT_URL`, now matches the rest
  of the showcase with just LANGGRAPH_DEPLOYMENT_URL); trailing `/`
  removed from deploymentUrl.

Tests / QA:
- e2e specs renamed and paths updated for the demo renames.
- qa notes for a2ui-fixed-schema (booked-state checklist removed) and
  byoc-json-render (Wave 4a residue removed).
- docs-links.json key renamed for reasoning-custom.

Cleanup:
- Removed remaining stub agent.py files in demo dirs (real graphs in
  src/agents/); removed dead beautiful-chat/components/headless-chat.tsx
  (zero importers); removed [A2UI-DEBUG] / [A2UI-RESPONSE] print
  statements from beautiful_chat.py; gpt-5.4-mini → gpt-5-mini typo
  fix in beautiful_chat.py:249 (would have 4xx'd every model call);
  stripped iframe-restriction LLM-prompt copy bleed from
  open-gen-ui-advanced suggestion titles.

The convention pass that ran across ~28 demos earlier in this branch is
already reflected in their per-demo commits — every page.tsx reads as
imports + provider + suggestions hook + JSX, with `useConfigureSuggestions`
extracted to a sibling suggestions.ts.
2026-05-06 23:19:57 -07:00

5.1 KiB
Raw Permalink Blame History

QA: Declarative Generative UI (A2UI — Fixed Schema) — LangGraph (Python)

Prerequisites

  • Demo is deployed and accessible at /demos/a2ui-fixed-schema on the dashboard host
  • Agent backend is healthy; OPENAI_API_KEY is set on Railway; LANGGRAPH_DEPLOYMENT_URL points at a LangGraph deployment exposing the a2ui_fixed graph (registered as agent name a2ui-fixed-schema — see src/app/api/copilotkit-a2ui-fixed-schema/route.ts)
  • Note: the demo source contains no data-testid attributes. Checks below rely on verbatim visible text, DOM structure, and the JSON schema at src/agents/a2ui_schemas/flight_schema.json

Test Steps

1. Basic Functionality

  • Navigate to /demos/a2ui-fixed-schema; verify the page renders within 3s and a single CopilotChat pane is centered (max-width ~896px, rounded-2xl, full-height)
  • Verify the chat is wired to runtimeUrl="/api/copilotkit-a2ui-fixed-schema" and agent="a2ui-fixed-schema" (DevTools → Network: sending a message hits that endpoint)
  • Verify the single suggestion pill is visible with verbatim title "Find SFO → JFK" (message body: "Find me a flight from SFO to JFK on United for $289.")
  • Send "Hello" and verify an assistant text response appears within 10s (no flight card for plain text)

2. Feature-Specific Checks

Schema Wiring (fixed catalog + includeBasicCatalog)

  • DevTools → Network: after the first successful display_flight call, verify the response stream contains an a2ui_operations container with catalogId: "copilotkit://flight-fixed-catalog" (matches CATALOG_ID in src/agents/a2ui_fixed.py and src/app/demos/a2ui-fixed-schema/a2ui/catalog.ts)
  • Verify the same container carries the full FLIGHT_SCHEMA component tree (12 nodes from src/agents/a2ui_schemas/flight_schema.json: root, content, title, route, from, arrow, to, meta, airline, price, bookButton, bookButtonLabel)

Search-Flights Prompt (display_flight tool → flight_schema.json)

  • Click the "Find SFO → JFK" suggestion; within 20s verify a single flight card renders in-transcript assembled per flight_schema.json:
    • outer Card with a Column of children in this order: title row, route row, meta row, book button
    • Title node renders the literal text "Flight Details" (1.15rem / 600 weight, color #010507)
    • route row shows Airport "SFO" → Arrow (→, color #AFAFB7) → Airport "JFK" (both monospaced, 1.5rem, 600 weight, 0.05em letter-spacing)
    • meta row shows AirlineBadge "UNITED" (uppercase pill, lilac #BEC2FF border, 0.08em tracking) on the left and PriceTag "$289" (monospaced, color #189370, 1.1rem / 600 weight) on the right
    • Button renders full-width with label "Book flight" (black #010507 background, white text, 12px radius)
  • Verify all four data-model fields resolved correctly (origin=SFO, destination=JFK, airline=United, price=$289) — each is a { path: "/..." } binding in the schema and must reach the DOM as a plain string via the GenericBinder (no literal {path} leak and no React error #31)

Book-Flight Button (inert — pure presentation)

  • Verify the "Book flight" button is rendered with the schema-declared label and is clickable, but the click is a no-op: the agent is not invoked, no schema swap occurs, and the button does not transition to a "Booked" state. Schema-swap-on-action will be wired up once the Python SDK exposes action_handlers= on a2ui.render (see comment in src/agents/a2ui_fixed.py).

Follow-up Prompt (data-model refresh)

  • Send "Find me a flight from LAX to ORD on Delta for $412."; within 20s verify the card updates in place with origin=LAX, destination=ORD, airline=DELTA, price=$412 (same schema, new data model — proves the fixed-schema pattern: schema once, data streams)

3. Error Handling

  • Send an empty message; verify it is a no-op (no user bubble, no assistant response)
  • Send "What is the capital of France?"; verify the agent replies in plain text without invoking display_flight (no flight card rendered, no a2ui_operations in the response)
  • DevTools → Console: walk through all flows above; verify no uncaught errors and specifically no React error #31 ("objects are not valid as a React child, found: object with keys {path}") — the DynString union in a2ui/definitions.ts is what prevents this, so a single occurrence is a regression

Expected Results

  • Chat loads within 3s; plain-text response within 10s; flight card renders within 20s of the search prompt
  • display_flight is called exactly once per search prompt; result contains an a2ui_operations container with catalogId: "copilotkit://flight-fixed-catalog" and the full 12-node flight schema
  • All custom renderers in a2ui/renderers.tsx (Card, Title, Airport, Arrow, AirlineBadge, PriceTag, Button) render at least once per search-flights run
  • Clicking "Book flight" is a no-op (inert presentation button — see comment in src/agents/a2ui_fixed.py)
  • No UI layout breaks, no {path} leak into the DOM, no uncaught console errors
Reference in New Issue View Git Blame Copy Permalink