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/claude-sdk-python/qa/shared-state-read-write.md
T
Alem Tuzlak 23a3b24a01 feat(showcase/integrations): shared-state-read-write + subagents demos across 15 packages 
Adds real working Shared State (Read+Write) and Sub-Agents demos to 15
showcase integrations, mirroring the canonical langgraph-python and
google-adk reference implementations. Fills rows previously empty on
the showcase coverage dashboard.

Packages: ag2, agno, claude-sdk-python, claude-sdk-typescript,
crewai-crews, langgraph-fastapi, langgraph-typescript, langroid,
llamaindex, mastra, ms-agent-dotnet, ms-agent-python, pydantic-ai,
spring-ai, strands. (built-in-agent landed independently on main as
PR #4321 — its variant is canonical; this PR no longer touches it.)

Per-package deliverables: framework-native backend agents
(preferences-injection middleware/callback + set_notes tool;
supervisor + 3 sub-agents wired as tools with running -> completed
/failed delegation log); frontend page.tsx + preferences-card.tsx /
notes-card.tsx for SSRW and delegation-log.tsx for subagents — wired
to useAgent({ updates: [OnStateChanged] }); manifest entries; runtime
route registration + per-package agent server config; real QA
scripts.

Includes targeted hardening fixes from a 7-agent code-review loop:

- Sub-agent failure paths now correctly emit status: "failed"
  (previously hardcoded "completed" or unreachable in
  mastra/strands/langgraph-fastapi/langgraph-typescript/ag2)
- Parallel-tool-call delegation race fixed in langgraph-fastapi
  (Annotated[list, add]) and langgraph-typescript (concat reducer)
- Silent data loss eliminated in
  claude-sdk-python/claude-sdk-typescript/crewai-crews — empty
  JSON.parse catches now log + emit error events
- ms-agent-dotnet set_notes writes to per-thread slot via AsyncLocal
- mastra working-memory writes are deterministic via
  src/mastra/tools/working-memory.ts helper
- spring-ai tool-call envelope ids match supervisor's tc.id() and
  AG-UI event ordering reordered; CopyOnWriteArrayList for
  parallel-call safety
- Stack trace + raw error message leaks scrubbed across 8+ Next.js
  routes — log server-side with errorId + return generic envelope
- Sub-agent calls no longer block event loops in ag2
  (asyncio.to_thread), langroid (llm_response_async), pydantic-ai
  (async run + async tools)
- langroid lru_cache cross-request contamination dropped
- Numerous smaller items: claude-sdk-python invalid model id, Callable
  annotation, /health endpoint exposed; crewai-crews supervisor
  no longer resets delegations every turn; pydantic-ai snapshot uses
  model_dump()

CI fixes folded in:
- crewai-crews test_forwarded_props: extend the stubbed
  ag_ui_crewai.endpoint module to expose
  add_crewai_flow_fastapi_endpoint and add stub
  agents.shared_state_read_write / agents.subagents modules
- generate-catalog test: bump crewai-crews wired-cell expectation
  28 -> 30; replace hardcoded total-wired count with an invariant
  (wired + stub + unshipped = 737) plus a lower-bound floor
- oxfmt run on the qa/shared-state-read-write.md files in mastra +
  spring-ai

Rebased onto latest main (post showcase/packages -> showcase/integrations
rename + post built-in-agent landing). Original blitz history
preserved at the blitz-pre-rebase-snapshot tag.

Known follow-ups (deferred to follow-up PR):
- agno sync sub_agent.run() blocks event loop (perf only)
- ms-agent-python asyncio thread-fallback fragility
- llamaindex initial-state coercion when UI clears state
- Manifest highlight audit (langgraph-typescript headless-complete,
  langgraph-fastapi byoc-* missing route.ts highlights)
- agno hitl-in-chat declared in demos but not features; duplicate
  /demos/hitl-in-chat route
- langgraph-typescript server.mjs graphSpec only registers 3 graphs
  vs 23 in langgraph.json (pre-existing)
- mastra hitl legacy demo missing from features list
- claude-sdk-python agents/agent.py line 474 also has the legacy
  claude-opus-4-5 default
- PARITY_NOTES vs manifest mismatches for hitl-in-app across
  spring-ai/agno/ag2 (pre-existing)
- spring-ai a2ui-fixed-schema missing from generative_ui list
2026-04-28 18:36:13 +02:00

4.4 KiB
Raw Permalink Blame History

QA: Shared State (Read + Write) — Claude Agent SDK (Python)

Prerequisites

  • Demo is deployed and accessible at /demos/shared-state-read-write on the dashboard host
  • Agent backend is healthy (/api/health); ANTHROPIC_API_KEY is set on Railway; the FastAPI backend exposes POST /shared-state-read-write

Test Steps

1. Basic Functionality

  • Navigate to /demos/shared-state-read-write; verify the page renders within 3s with the left sidebar (preferences + notes cards) and the right-side CopilotChat pane
  • Verify data-testid="preferences-card" is visible with heading "Your preferences"
  • Verify data-testid="notes-card" is visible with heading "Agent notes" and empty-state data-testid="notes-empty" reading "No notes yet. Ask the agent to remember something."
  • Verify the chat input placeholder is "Chat with the agent..."
  • Verify all 3 suggestion pills are visible with verbatim titles: "Greet me", "Remember something", "Plan a weekend"
  • Send "Hello" and verify an assistant text response appears within 10s

2. Feature-Specific Checks

UI Writes -> Agent Reads (preferences via agent.setState)

  • Type "Atai" into data-testid="pref-name"; verify data-testid="pref-state-json" updates to include "name": "Atai"
  • Change data-testid="pref-tone" to formal; verify the JSON preview reflects "tone": "formal"
  • Change data-testid="pref-language" to Spanish; verify the JSON preview reflects "language": "Spanish"
  • Click the Cooking and Travel interest pills; verify both show the selected style (border #BEC2FF, bg #BEC2FF1A) and the JSON preview's interests array contains both entries
  • Send "What do you know about me?"; verify within 15s the assistant reply references the name "Atai", a formal tone, Spanish, and the Cooking/Travel interests (the Python backend's build_preferences_block injects these into the system prompt each turn)
  • Click the "Plan a weekend" suggestion; verify the reply is tailored to the selected interests

Agent Writes -> UI Reads (notes via set_notes tool)

  • Click the "Remember something" suggestion (sends "Remember that I prefer morning meetings and that I don't eat dairy.")
  • Within 20s verify data-testid="notes-list" appears in the notes card and contains at least 2 data-testid="note-item" entries mentioning "morning meetings" and "dairy"
  • Verify data-testid="notes-empty" is no longer rendered
  • Send "Also remember I live in Berlin."; verify within 20s the notes list grows (previous notes preserved, new note added) — confirms the agent passes the FULL updated list per set_notes contract

UI Writes Back to Agent-Authored Slice (clear notes)

  • With notes present, verify data-testid="notes-clear-button" is visible
  • Click the Clear button; verify the notes list disappears and data-testid="notes-empty" re-renders
  • Ask "What do you remember about me?"; verify the agent no longer cites the cleared notes (state was written back by the UI via agent.setState({ notes: [] }))

Multi-Turn State Persistence

  • Change tone to playful and add the Music interest; send "Write me a one-line haiku greeting."; verify the reply is playful and references music
  • Send a follow-up "Do it again in French."; verify the reply remains playful, switches to French, and still acknowledges the music interest — confirms preferences persist across turns
  • Reload the page; verify preferences reset to defaults (tone: casual, language: English, empty interests, empty name) and notes reset to empty (state is per-session)

3. Error Handling

  • Attempt to send an empty message; verify it is a no-op (no user bubble, no assistant response)
  • Deselect all interests and clear the name; send "Who am I?"; verify the agent answers without crashing (the preferences block is skipped when nothing recognised is set)
  • Verify DevTools -> Console shows no uncaught errors during any flow above

Expected Results

  • Page loads within 3 seconds; assistant text response within 10 seconds for plain chat
  • Preferences writes are reflected in pref-state-json synchronously on change
  • Agent-authored notes appear in notes-card within 20 seconds of a "remember" prompt, and the full prior list is preserved on subsequent set_notes calls
  • Clear button round-trips UI -> agent state and the agent loses access to the cleared notes on the next turn
  • No UI layout breaks, no uncaught console errors
Reference in New Issue View Git Blame Copy Permalink