Files
copilotkit__copilotkit/showcase/integrations/google-adk/qa/frontend-tools-async.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.0 KiB
Raw Permalink Blame History

QA: Frontend Tools (Async) — Google ADK

Prerequisites

  • Demo is deployed and accessible at /demos/frontend-tools-async on the dashboard host
  • Agent backend is healthy (/api/copilotkit GET returns agent_status: "reachable"); GOOGLE_API_KEY is set; the Python agent_server exposes the frontend_tools_async agent (which shares _simple_chat with the other frontend-only demos)
  • Backend _simple_chat registers NO server-side query_notes tool; the frontend registers exactly ONE tool via useFrontendTool: query_notes (parameter: keyword: string)
  • The async handler sleeps 500ms (simulated client-side DB latency) then filters an in-memory NOTES_DB of 7 hard-coded notes, returning up to 5 matches against title, excerpt, or tags (case-insensitive). The tool has a custom render that mounts NotesCard

Test Steps

1. Basic Functionality

  • Navigate to /demos/frontend-tools-async; verify the CopilotChat panel renders centered (max width 4xl, rounded-2xl corners) within 3s
  • Verify the input placeholder "Type a message" is visible
  • Send "Hello"; verify the agent responds with plain text within 10s and does NOT invoke query_notes

2. Feature-Specific Checks

Suggestion Pills

  • Verify all three suggestion pills are visible with verbatim titles:
    • "Find project-planning notes"
    • "Search for 'auth'"
    • "What do I have about reading?"
  • Click "Find project-planning notes"; verify the prompt "Find my notes about project planning." is sent

query_notes — Async Handler Loading State

  • After triggering the query_notes flow (via pill or typing "Find my notes about planning"), verify within 10s a data-testid="notes-card" element renders in the transcript
  • While the handler's 500ms sleep is in flight (tool status ≠ complete), verify the card's header shows:
    • An uppercase "Notes DB" label
    • A heading data-testid="notes-keyword" reading Matching "<keyword>" where <keyword> is the agent's chosen search term (e.g. planning, project planning)
    • The subtext "Querying local notes DB..."
    • A "..." placeholder glyph (not the 📓 book emoji)

query_notes — Resolved State (Simulated DB Query)

  • After the 500ms sleep resolves, verify the card's loading state ends within 2s:
    • The placeholder glyph flips from "..." to "📓"
    • The subtext shows "N match" or "N matches" (singular when N=1)
    • A data-testid="notes-list" <ul> renders (assuming N > 0)
  • Verify the list contains between 1 and 5 <li> entries, each with data-testid="note-<id>" (IDs from n1–n7)
  • For the prompt "Find my notes about project planning", verify the returned notes include at least note-n1 (Q2 project planning kickoff) and note-n5 (Project planning retrospective notes)
  • Verify each note row renders title (bold), excerpt (grey small text), and tag pills (uppercase, rounded-full)

Round-Trip — Agent Consumes Async Handler Result

  • After the card renders, verify the agent emits a follow-up assistant text message within 10s summarizing the matches
  • Verify the summary references at least one note title or tag from the notes-card (confirms the agent awaited the async handler's resolved value, not just fired-and-forgot)
  • Ask a follow-up like "Which of those is about onboarding?"; verify the agent references note n1's excerpt ("new onboarding flow") — proving the previous tool result is retained in context

Zero-Match Branch — Notes Card Empty State

  • Send "Search my notes for xyzzy-nonsense-keyword"
  • Verify a data-testid="notes-card" renders with heading Matching "xyzzy-nonsense-keyword" (or close variant)
  • Verify the card shows italic grey text "No notes matched." (no notes-list element)
  • Verify the agent's follow-up text says no matches were found and offers to try a different keyword

3. Error Handling

  • Send an empty message; verify it is a no-op (no notes-card, no user bubble)
  • Send a ~500-character unrelated prompt; verify the agent responds without calling query_notes
  • Trigger two query_notes invocations in quick succession (e.g. "Find auth notes" then immediately "Find reading notes"); verify both resolve independently and render two separate notes-card instances in the transcript
  • Open DevTools → Console; verify no uncaught errors, no Zod parse failures, no unresolved-Promise warnings

Expected Results

  • Chat loads within 3 seconds; notes-card loading state appears within 10 seconds of prompt
  • Async handler's 500ms sleep is observable — the loading state ("Querying local notes DB...") is visible before resolution
  • After resolution, the notes-list renders with the correct subset of NOTES_DB matching the keyword
  • Agent's follow-up reply demonstrably uses the resolved notes array (round-trip verified)
  • Zero-match prompts render the empty-state branch, not a broken card
  • No uncaught console errors; handler Promise always resolves; no layout breaks