mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 23:43:16 +01:00
Runtime #15727 is merged. This PR adds the UI. Qualification follows in
#15729.
## Thinking Path
> - Paperclip manages agent work through tasks and governed connections.
> - Chat connections already bind external conversations to those tasks.
> - Speko handles voice and telephony, while the selected Paperclip
agent does the work.
> - A call needs durable session authority, ordered follow-ups, and safe
result delivery.
> - This PR adds the Speko setup and call controls to the existing Apps
and task UI.
> - This PR depends on #15727. The qualification suite follows
separately. Speko stays experimental.
## Linked Issues or Issue Description
**Problem or motivation**
Phone and browser voice conversations cannot use the chat connection
task lifecycle. A separate voice runtime is needed to preserve task
authority, retries, and reply history.
**Proposed solution**
Add company-scoped voice sessions, signed callbacks, durable replies,
inbound intake, and an agent-facing outbound-call tool. Reuse existing
tasks, queues, secrets, and publications.
**Roadmap alignment**
This extends the experimental chat connector entry points under Agent
Chat and Connected Apps. The project owner requested this feature.
Refs #11418 for the original provider catalog proposal. This
implementation uses the newer chat connection infrastructure rather than
an MCP catalog-only integration. Refs #15721 for remote OpenCode
startup.
## What Changed
- Add the Speko Apps catalog entry, provider artwork, and browser SDK.
- Reuse existing agents in setup. Keep the optional Company Phone Agent
in the catalog, with connection instructions available to any assigned
agent.
- Add task voice controls, transcripts, phone callbacks, inbound-line
settings, and call Activity entries.
- Surface retryable connection and incoming-task inventory failures,
preserve active call controls and cached tasks, restore keyboard focus
after recovery, and bound notification polling so a stuck request cannot
hide later results.
- Put Save & exit and Connect Speko in the credential step’s shared
footer.
- Add deterministic production-component Storybook fixtures for setup,
lifecycle, failures, permissions, and phone surfaces.
- Include voice components in the design guide. Stories never request a
real microphone or place calls.
## Verification
- All 27 focused UI/controller regressions, UI typecheck, token gates,
and 28 map/catalog structural tests pass. The shared connection cache
test covers pause/resume invalidation during the 30-second fresh period.
- Storybook builds 157 Speko production-component stories. The complete
prior 156-story set passed all 624 checks on UI source 249cbc616a. After
the final cache repair, all 152 affected page/launcher checks passed
across both themes, 390/1200 widths and reduced motion. Real microphone
access and external provider requests are blocked.
- Source annotations follow the current generated-catalog contract. No
generated catalog or lockfile is included. Three inherited
GitHub-heading tests passed after master reconciliation.
- Latest-head CI and Greptile review must pass before merge. Local
fixture success does not establish provider or spoken-playback
acceptance.
- The separate integrated browser run passed two journeys and failed
browser answer retrieval. Real browser/telephone playback and timing
acceptance remain outstanding. See the dated qualification report and
E01–E16 runbook. Speko stays experimental.
## Risks
- Voice sessions add migrations and provider-dependent lifecycle
behavior. Migrations preserve existing chat and AI transports.
- Callback origins must be reachable HTTPS. Provider keys and signing
secrets remain vaulted.
- Unverified callers receive task-scoped low-trust authority. Caller ID
does not grant private task access.
- Outbound telephony incurs provider charges. Provider acceptance is not
proof that the caller heard an answer.
- Keep the feature behind the existing experimental chat setting until
the real browser, inbound, outbound, and delayed-result acceptance
matrix passes.
## Model Used
OpenAI Codex, GPT-6, with tool use and code execution. The exact serving
model ID and context window are not exposed in this session.
## Checklist
- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [ ] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge
---------
Co-authored-by: Paperclip <noreply@paperclip.ing>
73 lines
5.1 KiB
TypeScript
73 lines
5.1 KiB
TypeScript
// @vitest-environment jsdom
|
|
import { act } from "react";
|
|
import { createRoot, type Root } from "react-dom/client";
|
|
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { VoiceCallContext } from "./VoiceCallContext";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { TaskVoiceLauncher } from "./TaskVoiceLauncher";
|
|
import { spekoEndpoint } from "../../../storybook/support/speko/spekoNative";
|
|
const mocks = vi.hoisted(() => ({ list: vi.fn() }));
|
|
vi.mock("@/api/chatEndpoints", () => ({ chatEndpointsApi: { list: mocks.list } }));
|
|
vi.mock("@/hooks/useChatConnectorsEnabled", () => ({ useChatConnectorsEnabled: () => ({ enabled: true }) }));
|
|
vi.mock("./NativeVoiceConversation", () => ({ NativeVoiceConversation: () => <p>Active voice controls</p> }));
|
|
|
|
describe("task voice connection failures", () => {
|
|
let container: HTMLDivElement, root: Root, client: QueryClient;
|
|
beforeEach(() => {
|
|
vi.resetAllMocks(); container = document.createElement("div"); document.body.append(container);
|
|
root = createRoot(container); client = new QueryClient({ defaultOptions: { queries: { retry: false, staleTime: 30_000 } } });
|
|
});
|
|
afterEach(async () => { await act(async () => root.unmount()); client.clear(); container.remove(); });
|
|
async function render(bound = false, active?: boolean) {
|
|
await act(async () => root.render(<QueryClientProvider client={client}><VoiceCallContext.Provider value={active === undefined ? null : { active, open: vi.fn() }}><TaskVoiceLauncher companyId="company" issueId="issue" agentId={spekoEndpoint.assignedAgentId} boundEndpointId={bound ? spekoEndpoint.id : undefined} /></VoiceCallContext.Provider></QueryClientProvider>));
|
|
}
|
|
it.each([false, true])("shows a retryable request failure for bound=%s instead of a missing connection", async bound => {
|
|
mocks.list.mockRejectedValueOnce(new Error("Offline")).mockResolvedValue([spekoEndpoint]); await render(bound);
|
|
await vi.waitFor(() => expect(container.querySelector('[role="alert"]')?.textContent).toContain("Voice connections could not be loaded"));
|
|
expect(container.textContent).not.toContain("Voice is unavailable");
|
|
container.querySelector('button')!.focus();
|
|
await act(async () => container.querySelector('button')!.click());
|
|
await vi.waitFor(() => expect(container.textContent).toContain(`Talk to ${spekoEndpoint.assignedAgentName}`));
|
|
expect(container.querySelector('[role="alert"]')).toBeNull();
|
|
expect(document.activeElement).toBe(container.querySelector('button'));
|
|
});
|
|
it("restores persona selection and keyboard focus after the hosted panel closes", async () => {
|
|
mocks.list.mockResolvedValue([spekoEndpoint, {...spekoEndpoint, id: "second", botLabel: "Second persona"}]);
|
|
await render(false, false);
|
|
await vi.waitFor(() => expect(container.querySelector('select')).not.toBeNull());
|
|
await act(async () => container.querySelector('button')!.click());
|
|
expect(container.querySelector('select')).toBeNull();
|
|
await render(false, true);
|
|
await render(false, false);
|
|
await vi.waitFor(() => expect(container.querySelector('select')).not.toBeNull());
|
|
expect(document.activeElement).toBe(container.querySelector('button'));
|
|
await act(async () => {
|
|
const select = container.querySelector('select')!; select.value = "second";
|
|
select.dispatchEvent(new Event("change", {bubbles: true}));
|
|
});
|
|
expect(container.querySelector('select')?.value).toBe("second");
|
|
});
|
|
it("updates the mounted launcher after shared connection pause and resume invalidation", async () => {
|
|
mocks.list.mockResolvedValue([spekoEndpoint]); await render(true);
|
|
await vi.waitFor(() => expect(container.textContent).toContain(`Talk to ${spekoEndpoint.assignedAgentName}`));
|
|
mocks.list.mockResolvedValue([{...spekoEndpoint, status: "paused"}]);
|
|
await act(async () => { await client.invalidateQueries({queryKey: queryKeys.chatEndpoints.list("company")}); });
|
|
await vi.waitFor(() => expect(container.textContent).toContain("Voice is unavailable"));
|
|
expect(container.textContent).not.toContain(`Talk to ${spekoEndpoint.assignedAgentName}`);
|
|
mocks.list.mockResolvedValue([spekoEndpoint]);
|
|
await act(async () => { await client.invalidateQueries({queryKey: queryKeys.chatEndpoints.list("company")}); });
|
|
await vi.waitFor(() => expect(container.textContent).toContain(`Talk to ${spekoEndpoint.assignedAgentName}`));
|
|
});
|
|
it("keeps active controls mounted when a background connection refresh fails", async () => {
|
|
mocks.list.mockResolvedValue([spekoEndpoint]); await render();
|
|
await vi.waitFor(() => expect(container.querySelector('button')).not.toBeNull());
|
|
await act(async () => container.querySelector('button')!.click());
|
|
expect(container.textContent).toContain("Active voice controls");
|
|
mocks.list.mockRejectedValue(new Error("Offline"));
|
|
await act(async () => { await client.refetchQueries({queryKey: queryKeys.chatEndpoints.list("company")}); });
|
|
await vi.waitFor(() => expect(container.querySelector('[role="alert"]')).not.toBeNull());
|
|
expect(container.textContent).toContain("Active voice controls");
|
|
});
|
|
});
|