Files
PaperClipAI/ui/src/lib/voice-call-attempt.test.ts
T
DottaandPaperclip 22d05644f4 feat(ui): add Speko voice setup, task calls, and Storybook coverage (#15728)
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>
2026-10-13 16:26:38 -05:00

75 lines
5.6 KiB
TypeScript

import { describe, expect, it, vi } from "vitest";
import type { voiceSessionsApi } from "@/api/voiceSessions";
import type { VoiceSession, VoiceSessionMedia } from "@paperclipai/shared";
import { createVoiceCallAttempt, voiceCallJournal } from "./voice-call-attempt";
import { ApiError } from "@/api/client";
import { VoiceSessionStartError } from "./voice-session-controller";
function fixture() {
const rows = new Map<string, string>();
const storage = { getItem: (key: string) => rows.get(key) ?? null, setItem: (key: string, value: string) => { rows.set(key, value); }, removeItem: (key: string) => { rows.delete(key); } };
const session = { id: "session", state: "active" } as VoiceSession;
const media = { sessionId: "session", generation: 1, transportToken: "must-never-be-saved", transportUrl: "wss://test.invalid" } satisfies VoiceSessionMedia;
const client = { start: vi.fn(async (..._args: Parameters<typeof voiceSessionsApi.start>) => ({ session, media })), end: vi.fn(async () => ({ ...session, state: "ended" as const })), get: vi.fn(async () => session), notification: vi.fn(async () => null) };
const journal = voiceCallJournal(storage, "company", "operator");
return { rows, storage, client, journal };
}
describe("voice reload recovery", () => {
it.each([400, 401, 403, 404, 422])("allows a new endpoint after definitive admission rejection %s", async (status) => {
const f = fixture();
f.client.start.mockRejectedValueOnce(new ApiError("Rejected", status, {error: "Rejected"}));
const attempt = createVoiceCallAttempt("company", f.client, f.journal);
await expect(attempt.start({endpointId: "stale"})).rejects.toBeInstanceOf(ApiError);
expect(f.journal.read()).toBeUndefined();
await attempt.start({endpointId: "valid", issueId: "new-task"});
expect(f.client.start.mock.calls[1]?.[1]).toMatchObject({endpointId: "valid", issueId: "new-task"});
expect(f.client.start.mock.calls[1]?.[1].idempotencyKey).not.toBe(f.client.start.mock.calls[0]?.[1].idempotencyKey);
});
it("retains exact cleanup identity and a safe credit reason after a rejected creation", async () => {
const f=fixture();f.client.start.mockRejectedValue(new ApiError("private provider detail",409,{details:{code:"voice_credits_required",sessionId:"failed-call"}}));
const attempt=createVoiceCallAttempt("company",f.client,f.journal);
await expect(attempt.start({endpointId:"endpoint"})).rejects.toMatchObject({sessionId:"failed-call",reason:"credits_required"});
expect(f.client.start).toHaveBeenCalledOnce();expect(f.journal.read()?.sessionId).toBe("failed-call");
await attempt.end("failed-call");expect(f.journal.read()).toBeUndefined();
});
it("closes the saved call on reload without minting or reissuing media", async () => {
const f = fixture();
const original = createVoiceCallAttempt("company", f.client, f.journal);
await original.start({ endpointId: "endpoint", issueId: "task" });
expect([...f.rows.values()].join()).not.toContain("must-never-be-saved");
const reloaded = createVoiceCallAttempt("company", f.client, f.journal);
await expect(reloaded.start({ endpointId: "different-endpoint" })).rejects.toMatchObject({ sessionId: "session" });
expect(f.client.start).toHaveBeenCalledOnce();
await reloaded.end("session"); expect(f.journal.read()).toBeUndefined();
await reloaded.start({ endpointId: "different-endpoint" }); expect(f.client.start).toHaveBeenCalledTimes(2);
});
it("recovers a lost creation response using the original key and exact task intent", async () => {
const f = fixture(); f.client.start.mockRejectedValueOnce(new Error("Lost response"));
await expect(createVoiceCallAttempt("company", f.client, f.journal).start({ endpointId: "endpoint", newConversation: true })).rejects.toThrow("Lost response");
const reloaded = createVoiceCallAttempt("company", f.client, f.journal);
await expect(reloaded.start({ endpointId: "different", issueId: "other-task" })).rejects.toBeInstanceOf(VoiceSessionStartError);
expect(f.client.start.mock.calls[0]).toEqual(f.client.start.mock.calls[1]);
await reloaded.end("session");
});
it("preserves recovery across an uncertain hangup and isolates company/user scopes", async () => {
const f = fixture(); const attempt = createVoiceCallAttempt("company", f.client, f.journal);
await attempt.start({ endpointId: "endpoint" });
f.client.end.mockRejectedValueOnce(new Error("Unconfirmed"));
await expect(attempt.end("session")).rejects.toThrow("Unconfirmed");
expect(f.journal.read()?.sessionId).toBe("session");
expect(voiceCallJournal(f.storage, "other-company", "operator").read()).toBeUndefined();
expect(voiceCallJournal(f.storage, "company", "another-user").read()).toBeUndefined();
await attempt.end("session"); expect(f.journal.read()).toBeUndefined();
});
it("does not open a provider call if recovery identity cannot be persisted", async () => {
const f = fixture(); const journal = { ...f.journal, write() { throw new Error("Storage unavailable"); } };
await expect(createVoiceCallAttempt("company", f.client, journal).start({ endpointId: "endpoint" })).rejects.toThrow("Storage unavailable");
expect(f.client.start).not.toHaveBeenCalled();
});
it("still identifies the exact call for cleanup if storage fails after creation", async () => {
const f = fixture(); let writes = 0;
const journal = { ...f.journal, write: (value: Parameters<typeof f.journal.write>[0]) => { if (++writes > 1) throw new Error("Storage full"); f.journal.write(value); } };
await expect(createVoiceCallAttempt("company", f.client, journal).start({ endpointId: "endpoint" })).rejects.toMatchObject({ sessionId: "session" });
});
});