Files
PaperClipAI/server/src/__tests__/speko-protocol.test.ts
T
DottaandPaperclip 3ec7309d91 feat(voice): add experimental Speko task connection runtime (#15727)
First PR: runtime. UI: #15728. Qualification: #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 an explicit voice transport to the existing connection
runtime.
> - The UI and qualification suites follow in linked PRs. 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 additive voice schema, shared contracts, session APIs, and
provider callbacks.
- Bind browser, inbound, and outbound sessions to an endpoint, task, and
selected agent.
- Add low-trust guest intake in an explicitly selected sandbox and keep
ordinary approval rules.
- Submit task work through session-scoped tools and push approved
replies through Speko POST /v1/calls/{id}/messages.
- Distinguish provider acceptance from confirmed spoken playback.
Reconcile reports without downloading recordings.
- Add protocol, migration, persistence, provider, and
delivery-diagnostic tests.

## Verification

- Master 3389bea708 is integrated. Database/shared builds, server
typecheck, migration upgrade/replay checks, and 46
communication-guidance/provider/protocol tests passed.
- The final persistence suite passed 85 real-database tests. Five
focused native continuation/authorization regressions passed. Five
callback ownership/rotation tests passed after the last runtime repair.
- Review repairs cover reconnect ownership, current caller authority,
duplicate delivery, multipart answers, task-page answers, guest question
handling, and saved sandbox recovery.
- A real OpenCode/OpenRouter DeepSeek task ran in Daytona and saved a
correct disk-space answer. This did not establish live-call playback.
- Full local typecheck/build passed before the final repairs; focused
typechecks passed after them. Latest-head CI runs the repository gates.
- The separate integrated browser qualification passed two journeys and
failed browser answer retrieval. The feature remains experimental. The
report in #15729 records this failure and outstanding real-provider
acceptance.
- No lockfiles are included. Speko migrations follow master as
0324–0330.

## 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-09 21:54:11 -05:00

48 lines
3.8 KiB
TypeScript

import { createHmac, randomBytes } from "node:crypto";
import { describe, expect, it } from "vitest";
import { verifySpekoToolRequest, spekoToolDefinitions } from "../services/voice/speko-protocol.js";
const now = Date.parse("2026-09-12T20:00:00Z");
const secret = `whsec_${randomBytes(32).toString("base64")}`;
function signed(value: unknown = { session_id: "s1", tool_call_id: "t1", idempotency_key: "s1:t1", tool: "submit_request", args: { text: "Please check the shipment" } }, offset = 0, key = secret) {
const body = Buffer.from(JSON.stringify(value)), timestamp = String(now / 1000 + offset), webhookId = "s1:t1";
const signature = createHmac("sha256", Buffer.from(key.slice(6), "base64")).update(`${webhookId}.${timestamp}.`).update(body).digest("base64");
return { body, headers: { "webhook-id": webhookId, "webhook-timestamp": timestamp, "webhook-signature": `v1,${signature}` }, keys: [{ secret }], now };
}
describe("Speko signed tool protocol", () => {
it("verifies original bytes and returns identities for durable replay checks", () => {
expect(verifySpekoToolRequest(signed())).toMatchObject({ webhookId: "s1:t1", envelope: { session_id: "s1", tool_call_id: "t1" } });
const tampered = signed(); tampered.body = Buffer.from(tampered.body.toString().replace("shipment", "payroll")); expect(() => verifySpekoToolRequest(tampered)).toThrow("invalid_signature");
});
it("accepts the provider's session:tool delivery id and multiple signatures", () => {
const request = signed();
request.headers["webhook-signature"] = `v1,${Buffer.alloc(32).toString("base64")} ${request.headers["webhook-signature"]}`;
expect(verifySpekoToolRequest(request).webhookId).toBe("s1:t1");
});
it.each([-301, 301])("rejects a timestamp outside the replay window: %s seconds", (offset) => { expect(() => verifySpekoToolRequest(signed(undefined, offset))).toThrow("invalid_signature"); });
it("accepts a rotation grace key only before its deadline", () => {
const request = signed(); const current = `whsec_${randomBytes(32).toString("base64")}`;
expect(() => verifySpekoToolRequest({ ...request, keys: [{ secret: current }, { secret, validUntil: new Date(now + 1) }] })).not.toThrow();
expect(() => verifySpekoToolRequest({ ...request, keys: [{ secret: current }, { secret, validUntil: new Date(now) }] })).toThrow("invalid_signature");
});
it("rejects ambiguous repeated headers and oversized payloads", () => {
const request = signed(); expect(() => verifySpekoToolRequest({ ...request, headers: { ...request.headers, "webhook-id": ["msg_1", "msg_2"] } })).toThrow("invalid_signature");
expect(() => verifySpekoToolRequest({ ...request, body: Buffer.alloc(65537) })).toThrow("body_too_large");
});
it.each([
{ tool: "approve_action", args: {} },
{ tool: "submit_request", args: { text: "ok", taskId: "another-task" } },
{ tool: "get_updates", args: { cursor: -1 } },
{ tool: "get_updates", args: { cursor: 0.5 } },
{ tool: "submit_request", args: { text: " " } },
])("rejects unauthorized tool shapes $tool $args", (operation) => {
expect(() => verifySpekoToolRequest(signed({ session_id: "s1", tool_call_id: "t1", idempotency_key: "s1:t1", ...operation }))).toThrow("invalid_envelope");
});
it("does not allow caller-supplied idempotency to substitute another session", () => {
expect(() => verifySpekoToolRequest(signed({ session_id: "s1", tool_call_id: "t1", idempotency_key: "s2:t1", tool: "get_updates", args: { cursor: 0 } }))).toThrow("invalid_envelope");
});
it("keeps tool waits below the provider timeout and requires HTTPS", () => {
expect(spekoToolDefinitions("https://paperclip.example/api/voice/callback").every((tool) => tool.source.timeoutMs < 4000)).toBe(true);
expect(() => spekoToolDefinitions("http://localhost:3100/callback")).toThrow("HTTPS");
});
});