mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Alem Tuzlak
23a3b24a01
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
70 lines
3.0 KiB
Markdown
70 lines
3.0 KiB
Markdown
# QA: Shared State (Read + Write) — AG2
|
|
|
|
## Prerequisites
|
|
|
|
- Demo is deployed and accessible at `/demos/shared-state-read-write`
|
|
- Agent backend is healthy (check `/api/copilotkit` GET → `agent_status: reachable`)
|
|
- Backend has `OPENAI_API_KEY` set
|
|
- The `shared-state-read-write` agent is mounted at `/shared-state-read-write` on
|
|
the FastAPI server (see `src/agent_server.py`)
|
|
|
|
## Test Steps
|
|
|
|
### 1. Page renders with the two cards and chat
|
|
|
|
- [ ] Navigate to `/demos/shared-state-read-write`
|
|
- [ ] Sidebar shows the **Preferences** card (`data-testid="preferences-card"`)
|
|
- [ ] Sidebar shows the **Agent notes** card (`data-testid="notes-card"`) with the
|
|
empty state copy "No notes yet. Ask the agent to remember something."
|
|
- [ ] Right-hand pane shows `<CopilotChat />` with the placeholder
|
|
"Chat with the agent..."
|
|
- [ ] The "Shared state" panel inside the preferences card shows JSON with
|
|
`name: ""`, `tone: "casual"`, `language: "English"`, `interests: []`
|
|
|
|
### 2. UI -> agent (write)
|
|
|
|
- [ ] Type a name (e.g. `Atai`) into the **Name** input. The "Shared state"
|
|
JSON inside the card updates immediately to reflect the new name.
|
|
- [ ] Change **Tone** to `playful`. JSON updates.
|
|
- [ ] Change **Language** to `Spanish`. JSON updates.
|
|
- [ ] Toggle 2-3 interests (e.g. `Cooking`, `Tech`). JSON updates and the
|
|
buttons show the selected style.
|
|
- [ ] In the chat, send: **"Greet me in one sentence."**
|
|
- [ ] The agent's reply addresses the user by name in a playful tone, in
|
|
Spanish (i.e. it actually used the preferences). It must NOT just
|
|
echo the JSON.
|
|
|
|
### 3. agent -> UI (read)
|
|
|
|
- [ ] In the chat, send: **"Remember that I prefer morning meetings and that
|
|
I don't eat dairy."**
|
|
- [ ] The **Agent notes** card transitions from the empty state to a
|
|
bulleted list with at least 2 entries (`data-testid="note-item"`),
|
|
reflecting the two facts above. The list updates in real time
|
|
while/after the agent finishes its turn.
|
|
- [ ] In the chat, send: **"Also remember I work in Pacific time."**
|
|
- [ ] The notes list now has at least 3 entries (the agent passed the FULL
|
|
list to `set_notes`, not just the new one).
|
|
|
|
### 4. Round-trip + Clear
|
|
|
|
- [ ] Click the **Clear** button on the notes card.
|
|
- [ ] The notes card returns to the empty state immediately.
|
|
- [ ] In the chat, send: **"What do you remember about me?"**
|
|
- [ ] The agent reports it has no remembered notes (because the UI cleared
|
|
them via `agent.setState`), confirming the UI's write-back was
|
|
visible to the agent on its next turn.
|
|
|
|
### 5. Error handling
|
|
|
|
- [ ] Send an empty message → handled gracefully (no crash, no broken UI).
|
|
- [ ] No console errors during normal usage.
|
|
|
|
## Expected Results
|
|
|
|
- Page loads in < 3 seconds.
|
|
- Preferences edits propagate to agent state instantly.
|
|
- Agent replies adapt visibly to preferences (name, tone, language).
|
|
- Notes card reflects every `set_notes` call from the agent.
|
|
- Clearing notes from the UI is reflected on the agent's next turn.
|