Files
copilotkit__copilotkit/showcase/integrations/google-adk/qa/a2ui-fixed-schema.md
Tyler Slaton ef1ca9808c feat(showcase/google-adk): QA-blitz parity ports — agent prompts, tool surface, e2e specs
Result of 10 parallel QA agents auditing all 30 active demos against
langgraph-python (north-star). Each agent ported drift back to LP-verbatim
across three axes:

1. Agent layer
   - tool_rendering_common.py: rebuilt to LP's surface — get_weather,
     search_flights(origin, destination), get_stock_price, roll_d20,
     roll_dice. Removed the ADK-only query_data.
   - tool_rendering_*_agent.py (4 variants): ported LP's travel/concierge
     prompt; reasoning-chain variant got LP's chain-two-tools prompt.
   - beautiful_chat_agent.py: ported LP's per-tool system prompt; added
     manage_sales_todos / get_sales_todos / generate_a2ui; dropped the
     redundant schedule_meeting (frontend HITL handles it).
   - open_gen_ui_agents.py: ported LP's full SYSTEM_PROMPT for both
     variants, including the Websandbox.connection.remote.* contract
     for the advanced sandbox demo (was `window.sandbox.*`, which the
     LP frontend's Websandbox bridge silently no-ops).
   - byoc_agents.py: fused LP's hashbrown + json-render prompts so the
     single ADK byoc_agent emits both wire shapes. Aliases exported for
     a future per-route split.
   - declarative_gen_ui_agent.py: ported LP's a2ui_dynamic SYSTEM_PROMPT.
   - a2ui_fixed_agent.py: picked up LP's #4734 regression guard
     ("exactly ONCE", "do NOT call again").
   - agent_config_agent.py: rewrote to read useAgentContext (was
     state["config"]); reconciled schema to LP's 3-field camelCase
     {tone, expertise, responseLength} with LP's value enums.
   - subagents_agent.py: dropped the "running" placeholder; returns
     plain str so the LP-verbatim frontend's `result?.trim()` works.
   - hitl_in_app_agent.py / hitl_in_chat_book_call_agent.py: prompts +
     tool-result shape ({approved, reason}) aligned to LP.
   - AGUIToolset() added wherever it was missing on the bespoke agents
     (multimodal, mcp_apps, a2ui_fixed) so frontend-registered tools
     reach the model.

2. Dedicated runtime routes
   - copilotkit-multimodal/route.ts (new) — mirrors LP shape with
     ADK's HttpAgent + AGENT_URL pattern.
   - copilotkit-agent-config/route.ts (new) — same pattern.
   - copilotkit-mcp-apps/route.ts — refreshed.

3. Frontend ports (ADK frontend brought to LP-verbatim where it had
   drifted from the parity blitz state)
   - tool-rendering family (4 demos): full re-port — WeatherCard,
     FlightListCard, StockCard, D20Card, ReasoningBlock, CatchallRenderer,
     suggestions, and the page wiring with all useRenderTool /
     useDefaultRenderTool / reasoningMessage registrations.
   - a2ui-fixed-schema, mcp-apps, multimodal: full frontend re-ports
     with their _components/ Tailwind primitives.
   - frontend-tools, frontend-tools-async, agent-config: ported LP's
     component structure (separate Background, NotesCard with query_notes,
     config-context-relay).
   - shared-state-read, shared-state-read-write, readonly-state-agent-context:
     ported LP's demo-layout + _components + suggestions. recipe-card.tsx
     pulled directly from LP (one QA agent had adapted to Unicode glyphs
     thinking ADK lacked lucide-react — it doesn't, after the parity blitz).
   - shared-state-streaming, subagents, hitl-in-app: ported LP's
     DocumentView / supervisor-activity / TicketsPanel structure.
     hitl-in-app/page.tsx pulled directly from LP to keep the hyphenated
     agent slug aligned with the renamed registry key.
   - auth, hitl-in-chat: ported LP's SignInCard-first auth UX and the
     time-picker Tailwind port.
   - prebuilt-popup: pulled LP's main-content + suggestions split.

4. Test fixtures
   - 30 tests/e2e/<slug>.spec.ts ported from LP, several overwriting
     stale stubs (shared-state-streaming, subagents, auth, hitl-in-chat,
     shared-state-read, agent-config).
   - 30 qa/<slug>.md ported from LP with ADK env-var and registry
     references substituted (GOOGLE_API_KEY, AGENT_URL, registry.py).
   - QA3's byoc-hashbrown / byoc-json-render specs renamed to
     declarative-hashbrown / declarative-json-render with internal
     URL references substituted (the orchestrator pass had already
     renamed the demo dirs + manifest entries).

Frontend changes from QA agents were filtered: kept where they ported
LP-verbatim into ADK, replaced with direct LP pulls where the agent
had made ADK-specific adaptations (one Unicode-glyph case, one
stale-registry-slug case).

Not touched per blitz rules: shared_chat.py, registry.py, manifest.yaml,
src/app/api/copilotkit/route.ts.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-12 17:58:06 -07:00

5.1 KiB

QA: Declarative Generative UI (A2UI — Fixed Schema) — Google ADK

Prerequisites

  • Demo is deployed and accessible at /demos/a2ui-fixed-schema on the dashboard host
  • Agent backend is healthy; GOOGLE_API_KEY is set on Railway; AGENT_URL points at the ADK agent server exposing the a2ui_fixed_schema endpoint (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_agent.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 A2UI Python SDK exposes action_handlers= on a2ui.render (see comment in src/agents/a2ui_fixed_agent.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_agent.py)
  • No UI layout breaks, no {path} leak into the DOM, no uncaught console errors