mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-16 05:17:41 +02:00
Third PR: depends on #15728 and #15727. The user has reviewed and authorized merging this experimental feature stack. ## 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 repeatable qualification for the Speko voice task integration. > - This PR depends on #15728, which depends on #15727. 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 a real Paperclip server/database E2E fixture that stubs only external Speko transport and the execution provider. - Add authenticated multi-user and cross-company qualification journeys. - Add Storybook interaction, accessibility, responsive, and visual-suite integration. - Add an E01–E16 runbook, component-to-story inventory, and current redacted qualification report. - Keep historical private call traces out of the PR. Provider proof tools are opt-in. ## Verification - All 21 standalone proof tests and browser client/server syntax checks pass. They cover signatures, redaction, cleanup retry, final audio saves, bounded report transport and late server write ordering. No live calls were placed. - 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 source249cbc616a. 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. - Hosted Storybook origin isolation and representative narrow-screen stories pass. Provider requests remain 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. - Commit905bc5da5dhas 55 passing checks, including required verify/E2E gates, and a fresh Greptile 5/5 review with zero unresolved findings. 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>
85 lines
4.4 KiB
TypeScript
85 lines
4.4 KiB
TypeScript
/** Throwaway acceptance instance: real app, DB, queues and publications.
|
|
* The execution provider is synthetic. Speko is live unless SPEKO_NATIVE_STUB=1.
|
|
* Run with server/node_modules/.bin/tsx tests/speko-native/server.ts.
|
|
*/
|
|
import { mkdtemp, writeFile, mkdir } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import { resolve } from "node:path";
|
|
import { randomBytes } from "node:crypto";
|
|
import { once } from "node:events";
|
|
|
|
const home = await mkdtemp(resolve(tmpdir(), "paperclip-speko-native-"));
|
|
const port = Number(process.env.SPEKO_NATIVE_PORT ?? 3449);
|
|
const origin = `http://127.0.0.1:${port}`;
|
|
const callbackOrigin = process.env.SPEKO_NATIVE_CALLBACK_ORIGIN;
|
|
if (!callbackOrigin || new URL(callbackOrigin).protocol !== "https:") throw new Error("Explicit HTTPS callback origin required");
|
|
// Set isolation before importing anything that reads Paperclip configuration.
|
|
Object.assign(process.env, {
|
|
NODE_ENV: "test", PAPERCLIP_HOME: home, PAPERCLIP_INSTANCE_ID: "speko-native-acceptance",
|
|
PAPERCLIP_CONFIG: resolve(home, "config.json"), PAPERCLIP_DISABLE_CWD_ENV_FILE: "true",
|
|
PAPERCLIP_AGENT_JWT_SECRET: randomBytes(32).toString("hex"),
|
|
PAPERCLIP_DECISION_SIGNING_SECRET: randomBytes(32).toString("hex"),
|
|
PAPERCLIP_TOOL_ACTION_SIGNING_SECRET: randomBytes(32).toString("hex"),
|
|
PAPERCLIP_SECRETS_MASTER_KEY_FILE: resolve(home, "master.key"),
|
|
PAPERCLIP_API_URL: origin, PAPERCLIP_CHAT_WEBHOOK_PUBLIC_URL: callbackOrigin,
|
|
PAPERCLIP_DEPLOYMENT_MODE: process.env.SPEKO_NATIVE_AUTH === "1" ? "authenticated" : "local_trusted",
|
|
PAPERCLIP_AUTH_PUBLIC_BASE_URL: origin, PAPERCLIP_AUTH_BASE_URL_MODE: "explicit", PAPERCLIP_DEPLOYMENT_EXPOSURE: "private",
|
|
PAPERCLIP_VITE_CACHE_DIR: resolve(home, "vite-cache"), PAPERCLIP_OPEN_ON_LISTEN: "false",
|
|
PAPERCLIP_TELEMETRY_ENABLED: "false",
|
|
});
|
|
delete process.env.DATABASE_URL;
|
|
delete process.env.PAPERCLIP_IN_WORKTREE;
|
|
delete process.env.PAPERCLIP_MANAGED_CONFIG;
|
|
await mkdir(resolve(home, "storage"));
|
|
const { startEmbeddedPostgresTestDatabase, applyPendingMigrations } = await import("../../packages/db/src/index.js");
|
|
const database = await startEmbeddedPostgresTestDatabase("paperclip-speko-native-db-");
|
|
const { spawn } = await import("node:child_process");
|
|
// The supervisor owns the temporary database. Restarting app code preserves
|
|
// calls, credentials and delivery receipts so recovery can be qualified.
|
|
const spawnApp = () => spawn("server/node_modules/.bin/tsx", [...(process.env.SPEKO_NATIVE_WATCH === "0" ? [] : ["watch"]), "tests/speko-native/app.ts"], {
|
|
cwd: resolve(import.meta.dirname, "../.."), stdio: "inherit",
|
|
env: { ...process.env, DATABASE_URL: database.connectionString },
|
|
});
|
|
let child = spawnApp();
|
|
let stopping = false, restarting = false;
|
|
function watchExit() {
|
|
child.once("exit", () => {
|
|
if (stopping || restarting) return;
|
|
if (process.env.SPEKO_NATIVE_PERSIST === "1") { console.error("Live test application stopped; database retained. SIGUSR2 restarts the app."); return; }
|
|
void database.cleanup().then(() => process.exit(1));
|
|
});
|
|
}
|
|
watchExit();
|
|
await writeFile(resolve(home, "instance.json"), JSON.stringify({ origin, callbackOrigin, startedAt: new Date().toISOString(), pid: process.pid }), { mode: 0o600 });
|
|
if (process.env.SPEKO_NATIVE_INSTANCE_FILE) await writeFile(process.env.SPEKO_NATIVE_INSTANCE_FILE, JSON.stringify({ home, origin, callbackOrigin, supervisorPid: process.pid }), { mode: 0o600 });
|
|
async function stopChild() {
|
|
if (child.exitCode !== null || child.signalCode !== null) return;
|
|
const exited = once(child, "exit");
|
|
child.kill("SIGTERM");
|
|
await exited;
|
|
}
|
|
// Only explicitly isolated fixture instances accept this restart signal.
|
|
if ((process.env.SPEKO_NATIVE_STUB === "1" || process.env.SPEKO_NATIVE_PERSIST === "1") && process.env.SPEKO_NATIVE_WATCH === "0") {
|
|
process.on("SIGUSR2", () => {
|
|
if (stopping || restarting) return;
|
|
restarting = true;
|
|
void stopChild().then(async () => {
|
|
await applyPendingMigrations(database.connectionString);
|
|
if (!stopping) { child = spawnApp(); watchExit(); }
|
|
restarting = false;
|
|
}).catch(error => {
|
|
restarting = false;
|
|
if (process.env.SPEKO_NATIVE_PERSIST === "1") console.error("Live fixture restart failed; database retained:", error.message);
|
|
else void stop();
|
|
});
|
|
});
|
|
}
|
|
async function stop() {
|
|
if (stopping) return; stopping = true;
|
|
await stopChild();
|
|
await database.cleanup();
|
|
process.exit(0);
|
|
}
|
|
process.once("SIGINT", () => void stop());
|
|
process.once("SIGTERM", () => void stop());
|