mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-22 11:54:35 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Agents call tools from connected apps through the Paperclip MCP gateway > - Some tool calls take a long time: exports, builds, large searches > - The MCP progress utility lets an app report how far a call is, but Paperclip ignored it > - So the task chat showed only a spinner until the call finished, with no sign of life > - This pull request reads the app's progress and shows it on the tool's row while the call runs > - The benefit is that people can see that a long call is working, how far it is, and how long it has run ## Linked Issues or Issue Description **Subsystem affected** Connected apps (MCP gateway) and the task chat. **Problem or motivation** A long tool call from a connected MCP app shows only a spinner in the task chat. Paperclip does not send a `progressToken`, and it drops `notifications/progress` from the app. **Proposed solution** Send a `progressToken` on each `tools/call` that an agent run makes. Read the app's progress notifications from the call's response stream. Show a progress bar (or an indeterminate sweep), the latest message, and elapsed time on the running tool row. Keep the latest state so that a reload mid-call shows it. **Alternatives considered** A new transport for progress. The existing company live-events socket already carries per-run events with run read checks, so this change uses it. **Additional context** Spec: https://modelcontextprotocol.io/specification/2026-07-28/basic/utilities/progress ## What Changed - `mcp-http.ts`: `mcpHttpRequestInit` can add `_meta.progressToken`. `readMcpHttpResponse` gives each notification on the response stream to an observer before the result. The observer cannot fail or delay the call. New `mcpProgressNotificationOf` matches a notification to its token. - `tool-gateway.ts`: remote HTTP and local stdio `tools/call` from an agent run send a per-call token and forward progress to a reporter. Calls without a run send no token. - New `server/src/services/tool-call-progress.ts`: checks each update (finite, increasing, plain single-line text of at most 200 characters). It publishes a `heartbeat.run.tool_progress` live event at most every 250 ms (latest wins) and saves the latest update on the invocation at most every 1 s. Nothing is awaited by the call. A final `done` event goes out when the call ends. - DB: nullable `tool_invocations.progress` jsonb column (migration `0479`, `ADD COLUMN` only). A save never writes onto a finished call. - Live delivery: the new event follows its run like transcript output. A client gets it only for runs it follows, after the run read check, in the run's company only. - New route `GET /api/issues/:issueId/tool-call-progress` (task read check) returns the latest progress of the task's running calls, for a reload mid-call. Documented in `docs/api/issues.md`. - UI: `ToolCallProgressProvider` (one per chat) keeps the latest update per call. A running tool row subscribes and shows a bar or sweep, the message, the percent and elapsed time (design tokens, reduced motion honored). Finished rows drop it and never fetch or re-render for progress. `LiveUpdatesProvider` ignores the event for query invalidation. - `packages/kv-demo-mcp-server`: new `slow_with_progress` demo tool (`steps`, `stepMs`, `withTotal`) in its own file. - Storybook: `Tasks/Tool progress` stories (running with total, running without total, done). - Docs: new `doc/connections/MCP-PROGRESS.md`; `MCP-PROTOCOL-VERSIONS.md` no longer lists progress as unsupported. ## Verification - Red/green: on the original source, 5 of the new server tests fail (token in `_meta`, SSE with interleaved progress and result, notification matching, run-interest delivery, gateway end-to-end). With this change they pass. - `server/src/__tests__/mcp-http.test.ts` (13), `tool-call-progress.test.ts` (9: throttling, latest wins, bounded text, out-of-order drop, finish, failures never throw, company/run/tool scoping), `tool-call-progress-store.test.ts` (2, embedded Postgres: company and task scoping, no write onto a finished call), `realtime/live-event-delivery.test.ts` (run interest), `tool-gateway.test.ts` end-to-end against the real SDK kv demo server over Streamable HTTP: 6 provider updates over about 1.2 s give 3 to 7 throttled events, all for the right company, run, task and tool, the last one `done`; no event reaches another company; the invocation keeps the progress; the result is unchanged. - UI: `tool-call-progress.test.tsx` (10: name matching, row states, plain-text rendering, drop on complete, restore after reload, no fetch for finished rows). All 67 task-chat test files pass. - `packages/kv-demo-mcp-server`: 13 tests, including progress over HTTP with and without a total. - Storybook: checked the three stories in a browser. The bar fills to 40%, the sweep animates, the elapsed time ticks, and the done row shows no progress. - `pnpm verify`: see the CI checks for the final revision. ## Risks - Low. The migration adds one nullable column. - An SSE response is now bounded per message, not per stream, so handled notifications (such as progress) do not use up the result's size limit. Each message is still bounded. - Progress code runs only while a run's tool call is in flight. It adds a few bytes to the request and throttled, fire-and-forget work. Agent boot and time to first token do not change. - A row finds its call by run and tool name. If one run calls the same tool twice at the same time, both rows show the newer call's progress. - Progress from a call that became an MCP Task is not shown. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Claude Code agent with tool use and code execution. ## 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 - [x] 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 - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [ ] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
483 lines
20 KiB
TypeScript
483 lines
20 KiB
TypeScript
import { createLiveEventDelivery, sharedDeliveryRead, type LiveDeliveryReads } from "./live-event-delivery.js";
|
|
import { localAgentProcessBoundary } from "../middleware/local-agent-process-boundary.js";
|
|
import { skillAccessService } from "../services/skill-access.js";
|
|
import { createHash } from "node:crypto";
|
|
import type { IncomingMessage, Server as HttpServer } from "node:http";
|
|
import { createRequire } from "node:module";
|
|
import type { Duplex } from "node:stream";
|
|
import { and, eq, isNull } from "drizzle-orm";
|
|
import type { Db } from "@paperclipai/db";
|
|
import { agentApiKeys, companyMemberships, instanceUserRoles, heartbeatRuns, projects } from "@paperclipai/db";
|
|
import { issueActivityChangesTaskIdentity, type DeploymentMode, type LiveEvent } from "@paperclipai/shared";
|
|
import type { BetterAuthSessionResult } from "../auth/better-auth.js";
|
|
import { logger } from "../middleware/logger.js";
|
|
import { activityToastIdentity } from "./activity-toast-identity.js";
|
|
import { taskToastEligible } from "./task-toast-eligibility.js";
|
|
import { subscribeCompanyLiveEvents } from "../services/live-events.js";
|
|
import { trackIdleWork } from "../services/task-admission.js";
|
|
import { createLiveRunEventRedactor } from "../services/live-run-event-redaction.js";
|
|
|
|
interface WsSocket {
|
|
readyState: number;
|
|
ping(): void;
|
|
bufferedAmount?: number;
|
|
send(data: string, callback?: (error?: Error) => void): void;
|
|
on(event: "message", listener: (data: Buffer, isBinary: boolean) => void): void;
|
|
terminate(): void;
|
|
close(code?: number, reason?: string): void;
|
|
on(event: "pong", listener: () => void): void;
|
|
on(event: "close", listener: () => void): void;
|
|
on(event: "error", listener: (err: Error) => void): void;
|
|
}
|
|
|
|
interface WsServer {
|
|
clients: Set<WsSocket>;
|
|
close(): void;
|
|
on(event: "connection", listener: (socket: WsSocket, req: IncomingMessage) => void): void;
|
|
on(event: "close", listener: () => void): void;
|
|
handleUpgrade(
|
|
req: IncomingMessage,
|
|
socket: Duplex,
|
|
head: Buffer,
|
|
callback: (ws: WsSocket) => void,
|
|
): void;
|
|
emit(event: "connection", ws: WsSocket, req: IncomingMessage): boolean;
|
|
}
|
|
|
|
const require = createRequire(import.meta.url);
|
|
const { WebSocket, WebSocketServer } = require("ws") as {
|
|
WebSocket: { OPEN: number };
|
|
WebSocketServer: new (opts: { noServer: boolean; maxPayload: number }) => WsServer;
|
|
};
|
|
|
|
import { authorizationService, type AuthorizationActor } from "../services/authorization.js";
|
|
import { getHeartbeatRunReadDecisions } from "../services/heartbeat-run-privacy.js";
|
|
import { canActorReadCase } from "../services/case-access.js";
|
|
|
|
interface UpgradeContext {
|
|
actor: AuthorizationActor;
|
|
apiKeyId?: string;
|
|
companyId: string;
|
|
actorType: "board" | "agent";
|
|
actorId: string;
|
|
}
|
|
|
|
/** Cloud-proxied browser identity resolved from trusted x-paperclip-cloud-* headers. */
|
|
export interface CloudUpgradeActor {
|
|
userId: string;
|
|
/** Companies this actor may subscribe to (primary stack company + real memberships). */
|
|
companyIds: string[];
|
|
}
|
|
|
|
interface IncomingMessageWithContext extends IncomingMessage {
|
|
paperclipWebSocketHandled?: boolean;
|
|
paperclipUpgradeContext?: UpgradeContext;
|
|
}
|
|
|
|
function hashToken(token: string) {
|
|
return createHash("sha256").update(token).digest("hex");
|
|
}
|
|
|
|
function isWritableUpgradeSocket(socket: Duplex) {
|
|
const maybeWritableState = socket as Duplex & { writable?: boolean; writableEnded?: boolean; writableDestroyed?: boolean };
|
|
return !socket.destroyed && maybeWritableState.writable !== false && !maybeWritableState.writableEnded && !maybeWritableState.writableDestroyed;
|
|
}
|
|
|
|
function closeUpgradeSocket(socket: Duplex) {
|
|
if (!socket.destroyed) {
|
|
socket.destroy();
|
|
}
|
|
}
|
|
|
|
function rejectUpgrade(socket: Duplex, statusLine: string, message: string) {
|
|
const safe = message.replace(/[\r\n]+/g, " ").trim();
|
|
if (!isWritableUpgradeSocket(socket)) {
|
|
closeUpgradeSocket(socket);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
socket.once("finish", () => closeUpgradeSocket(socket));
|
|
socket.end(`HTTP/1.1 ${statusLine}\r\nConnection: close\r\nContent-Type: text/plain\r\n\r\n${safe}`);
|
|
} catch (err) {
|
|
logger.warn({ err }, "failed to reject live websocket upgrade");
|
|
closeUpgradeSocket(socket);
|
|
}
|
|
}
|
|
|
|
function parseCompanyId(pathname: string) {
|
|
const match = pathname.match(/^\/api\/companies\/([^/]+)\/events\/ws$/);
|
|
if (!match) return null;
|
|
|
|
try {
|
|
return decodeURIComponent(match[1] ?? "");
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function parseBearerToken(rawAuth: string | string[] | undefined) {
|
|
const auth = Array.isArray(rawAuth) ? rawAuth[0] : rawAuth;
|
|
if (!auth) return null;
|
|
if (!auth.toLowerCase().startsWith("bearer ")) return null;
|
|
const token = auth.slice("bearer ".length).trim();
|
|
return token.length > 0 ? token : null;
|
|
}
|
|
|
|
function headersFromIncomingMessage(req: IncomingMessage): Headers {
|
|
const headers = new Headers();
|
|
for (const [key, raw] of Object.entries(req.headers)) {
|
|
if (!raw) continue;
|
|
if (Array.isArray(raw)) {
|
|
for (const value of raw) headers.append(key, value);
|
|
continue;
|
|
}
|
|
headers.set(key, raw);
|
|
}
|
|
return headers;
|
|
}
|
|
|
|
async function authorizeUpgrade(
|
|
db: Db,
|
|
req: IncomingMessage,
|
|
companyId: string,
|
|
url: URL,
|
|
opts: {
|
|
deploymentMode: DeploymentMode;
|
|
resolveSessionFromHeaders?: (headers: Headers) => Promise<BetterAuthSessionResult | null>;
|
|
resolveCloudActor?: (req: IncomingMessage) => Promise<CloudUpgradeActor | null>;
|
|
},
|
|
): Promise<UpgradeContext | null> {
|
|
const queryToken = url.searchParams.get("token")?.trim() ?? "";
|
|
const authToken = parseBearerToken(req.headers.authorization);
|
|
const token = authToken ?? (queryToken.length > 0 ? queryToken : null);
|
|
|
|
// Browser board context has no bearer token in local_trusted and authenticated modes.
|
|
if (!token) {
|
|
if (opts.deploymentMode === "local_trusted") {
|
|
if (!(await localAgentProcessBoundary().grantsImplicitBoard(req.socket))) return null;
|
|
return {
|
|
companyId,
|
|
actorType: "board",
|
|
actorId: "board",
|
|
actor: { type: "board", userId: "local-board", source: "local_implicit" },
|
|
};
|
|
}
|
|
|
|
// Cloud-managed deployments authenticate proxied browsers with trusted
|
|
// x-paperclip-cloud-* headers, never a local Better Auth session — the
|
|
// session fallback below can only 403 them, which left the live-events
|
|
// socket permanently unreachable behind the Cloud front door. A resolved
|
|
// cloud actor is authoritative: authorize against its membership scope.
|
|
// Absent/invalid cloud headers fall through to the session path, so
|
|
// self-hosted behavior is unchanged.
|
|
if (opts.resolveCloudActor) {
|
|
const cloudActor = await opts.resolveCloudActor(req);
|
|
if (cloudActor) {
|
|
if (!cloudActor.companyIds.includes(companyId)) return null;
|
|
return {
|
|
companyId,
|
|
actorType: "board",
|
|
actorId: cloudActor.userId,
|
|
actor: { type: "board", userId: cloudActor.userId, source: "cloud_tenant", companyIds: cloudActor.companyIds },
|
|
};
|
|
}
|
|
}
|
|
|
|
if (opts.deploymentMode !== "authenticated" || !opts.resolveSessionFromHeaders) {
|
|
return null;
|
|
}
|
|
|
|
const session = await opts.resolveSessionFromHeaders(headersFromIncomingMessage(req));
|
|
const userId = session?.user?.id;
|
|
if (!userId) return null;
|
|
|
|
const [roleRow, memberships] = await Promise.all([
|
|
db
|
|
.select({ id: instanceUserRoles.id })
|
|
.from(instanceUserRoles)
|
|
.where(and(eq(instanceUserRoles.userId, userId), eq(instanceUserRoles.role, "instance_admin")))
|
|
.then((rows) => rows[0] ?? null),
|
|
db
|
|
.select({ companyId: companyMemberships.companyId })
|
|
.from(companyMemberships)
|
|
.where(
|
|
and(
|
|
eq(companyMemberships.principalType, "user"),
|
|
eq(companyMemberships.principalId, userId),
|
|
eq(companyMemberships.status, "active"),
|
|
),
|
|
),
|
|
]);
|
|
|
|
const hasCompanyMembership = memberships.some((row) => row.companyId === companyId);
|
|
if (!roleRow && !hasCompanyMembership) return null;
|
|
|
|
return {
|
|
companyId,
|
|
actorType: "board",
|
|
actorId: userId,
|
|
actor: { type: "board", userId, source: "session", companyIds: memberships.map(m => m.companyId) },
|
|
};
|
|
}
|
|
|
|
const tokenHash = hashToken(token);
|
|
const key = await db
|
|
.select()
|
|
.from(agentApiKeys)
|
|
.where(and(eq(agentApiKeys.keyHash, tokenHash), isNull(agentApiKeys.revokedAt)))
|
|
.then((rows) => rows[0] ?? null);
|
|
|
|
if (!key || key.companyId !== companyId || key.scopeConfig) {
|
|
return null;
|
|
}
|
|
|
|
await db
|
|
.update(agentApiKeys)
|
|
.set({ lastUsedAt: new Date() })
|
|
.where(eq(agentApiKeys.id, key.id));
|
|
|
|
return {
|
|
companyId,
|
|
actorType: "agent",
|
|
actorId: key.agentId,
|
|
apiKeyId: key.id,
|
|
actor: { type: "agent", agentId: key.agentId, companyId, source: "agent_key", onBehalfOfUserId: key.responsibleUserId },
|
|
};
|
|
}
|
|
|
|
export function setupLiveEventsWebSocketServer(
|
|
server: HttpServer,
|
|
db: Db,
|
|
opts: {
|
|
deploymentMode: DeploymentMode;
|
|
subscribeInvalidation?: (companyId: string, resync: () => void) => () => void;
|
|
resolveSessionFromHeaders?: (headers: Headers) => Promise<BetterAuthSessionResult | null>;
|
|
/**
|
|
* Resolves a Cloud-proxied browser's identity from the trusted
|
|
* x-paperclip-cloud-* headers on the upgrade request. Wired by managed
|
|
* deployments; self-hosted instances leave it unset.
|
|
*/
|
|
resolveCloudActor?: (req: IncomingMessage) => Promise<CloudUpgradeActor | null>;
|
|
},
|
|
) {
|
|
const wss = new WebSocketServer({ noServer: true, maxPayload: 64 * 1024 });
|
|
const redactRunEvent = createLiveRunEventRedactor(db);
|
|
const cleanupByClient = new Map<WsSocket, () => void>();
|
|
const aliveByClient = new Map<WsSocket, boolean>();
|
|
|
|
const pingInterval = setInterval(() => {
|
|
for (const socket of wss.clients) {
|
|
if (!aliveByClient.get(socket)) {
|
|
socket.terminate();
|
|
continue;
|
|
}
|
|
aliveByClient.set(socket, false);
|
|
socket.ping();
|
|
}
|
|
}, 30000);
|
|
|
|
wss.on("connection", (socket: WsSocket, req: IncomingMessage) => {
|
|
const context = (req as IncomingMessageWithContext).paperclipUpgradeContext;
|
|
if (!context) {
|
|
socket.close(1008, "missing context");
|
|
return;
|
|
}
|
|
|
|
const access = authorizationService(db);
|
|
async function visibleEvent(event: LiveEvent, reads: LiveDeliveryReads): Promise<LiveEvent | null> {
|
|
if (event.payload.entityType === "case" && (typeof event.payload.entityId !== "string"
|
|
|| !(await canActorReadCase(db, context!.actor, { id: event.payload.entityId, companyId: event.companyId })))) return null;
|
|
if (context!.actor.source === "local_implicit") {
|
|
if (event.type === "activity.logged" && event.payload.entityType === "issue") {
|
|
return { ...event, payload: { ...event.payload,
|
|
taskIdentityChanged: issueActivityChangesTaskIdentity(event.payload.action, event.payload.details),
|
|
...await activityToastIdentity(db, event.companyId, event.payload) } };
|
|
}
|
|
return event;
|
|
}
|
|
const principalActive = await sharedDeliveryRead(reads, "principal", async () => {
|
|
if (context!.apiKeyId) {
|
|
const active = await db.select({ id: agentApiKeys.id }).from(agentApiKeys)
|
|
.where(and(eq(agentApiKeys.id, context!.apiKeyId), isNull(agentApiKeys.revokedAt))).limit(1);
|
|
return active.length > 0;
|
|
}
|
|
const membership = await db.select({ id: companyMemberships.id }).from(companyMemberships)
|
|
.where(and(eq(companyMemberships.companyId, context!.companyId), eq(companyMemberships.principalType, "user"),
|
|
eq(companyMemberships.principalId, context!.actorId), eq(companyMemberships.status, "active"))).limit(1);
|
|
const admin = context!.actor.source !== "cloud_tenant" && await db.select({ id: instanceUserRoles.id }).from(instanceUserRoles)
|
|
.where(and(eq(instanceUserRoles.userId, context!.actorId), eq(instanceUserRoles.role, "instance_admin"))).limit(1).then(rows => rows.length > 0);
|
|
return membership.length > 0 || admin;
|
|
});
|
|
if (!principalActive) return null;
|
|
const payload = event.payload;
|
|
const issueId = typeof payload.issueId === "string" ? payload.issueId
|
|
: payload.entityType === "issue" && typeof payload.entityId === "string" ? payload.entityId : null;
|
|
const runId = typeof payload.runId === "string" ? payload.runId
|
|
: payload.entityType === "heartbeat_run" && typeof payload.entityId === "string" ? payload.entityId : null;
|
|
if (event.type === "heartbeat.run.event" || event.type === "heartbeat.run.log" || event.type === "heartbeat.run.tool_progress") {
|
|
const allowed = await sharedDeliveryRead(reads, "transcript-scope", async () => (await access.decide({
|
|
actor: context!.actor, action: "company_scope:read",
|
|
resource: { type: "company", companyId: event.companyId } })).allowed);
|
|
if (!allowed) return null;
|
|
}
|
|
const readBindings: Parameters<typeof getHeartbeatRunReadDecisions>[3][number][] = [];
|
|
if (issueId) {
|
|
readBindings.push({ companyId: event.companyId, scopeKind: "issue", issueId });
|
|
}
|
|
if (runId) {
|
|
const run = await sharedDeliveryRead(reads, `run:${runId}`, async () => (await db.select({
|
|
companyId: heartbeatRuns.companyId,
|
|
scopeKind: heartbeatRuns.scopeKind,
|
|
issueId: heartbeatRuns.issueId,
|
|
}).from(heartbeatRuns).where(and(eq(heartbeatRuns.id, runId), eq(heartbeatRuns.companyId, event.companyId))))[0]);
|
|
if (!run) return null;
|
|
readBindings.push(run);
|
|
}
|
|
if (!(await sharedDeliveryRead(reads, `read:${issueId ?? ""}:${runId ?? ""}`, async () =>
|
|
(await getHeartbeatRunReadDecisions(db, access, context!.actor, readBindings)).every(Boolean)))) return null;
|
|
if (["company_skill", "company_skill_source"].includes(String(payload.entityType)) && typeof payload.entityId === "string") {
|
|
try {
|
|
const skills = skillAccessService(db, context!.actor);
|
|
if (payload.entityType === "company_skill") await skills.assertSkill(event.companyId, payload.entityId);
|
|
else await skills.assertSource(event.companyId, payload.entityId);
|
|
} catch { return null; }
|
|
}
|
|
if (payload.entityType === "project" && typeof payload.entityId === "string") {
|
|
const [project] = await db.select({ id: projects.id }).from(projects)
|
|
.where(and(eq(projects.id, payload.entityId), eq(projects.companyId, event.companyId))).limit(1);
|
|
if (!project || !(await access.decide({ actor: context!.actor, action: "project:read",
|
|
resource: { type: "project", companyId: event.companyId, projectId: project.id } })).allowed) return null;
|
|
}
|
|
if (event.type.startsWith("heartbeat.run.")) return runId ? event : null;
|
|
if (event.type === "agent.session.goal.changed") return issueId ? event : null;
|
|
// Company-wide invalidations carry no task-derived content. Authorized
|
|
// clients obtain details through viewer-filtered HTTP reads.
|
|
if (event.type === "activity.logged") return { ...event, payload: {
|
|
action: payload.action, entityType: payload.entityType, entityId: payload.entityId,
|
|
// A handoff can attach the first case to a task. Its already-authorized
|
|
// task identity lets an empty cases panel refresh without exposing content.
|
|
...(payload.entityType === "case" && String(payload.action).startsWith("case.handoff_") && issueId ? { issueId } : {}),
|
|
// A closed boolean derived from details, so task pickers can tell a
|
|
// created, deleted, hidden or renamed task from routine progress.
|
|
...(payload.entityType === "issue"
|
|
? { taskIdentityChanged: issueActivityChangesTaskIdentity(payload.action, payload.details) }
|
|
: {}),
|
|
// The task read check above authorizes attribution, but not arbitrary details.
|
|
...(issueId ? await activityToastIdentity(db, event.companyId, payload) : {}),
|
|
} };
|
|
if (event.type === "agent.status") return { ...event, payload: { agentId: payload.agentId, status: payload.status } };
|
|
if (event.type === "agent.runtime_state.updated") return { ...event, payload: { agentId: payload.agentId } };
|
|
if (event.type === "external_object.updated") return { ...event, payload: { externalObjectId: payload.externalObjectId } };
|
|
if (event.type.startsWith("plugin.")) return event;
|
|
return null;
|
|
}
|
|
const delivery = createLiveEventDelivery({ socket, authorize: async (event, reads) => {
|
|
const visible = await visibleEvent(event, reads);
|
|
if (!visible || visible.type !== "heartbeat.run.event") return visible;
|
|
const payload = visible.payload.payload;
|
|
if (!payload || typeof payload !== "object" || Array.isArray(payload) || !("prpEvent" in payload)) return visible;
|
|
return redactRunEvent(visible, reads);
|
|
},
|
|
decorate: async visible => {
|
|
let toastEligible = false;
|
|
try {
|
|
toastEligible = await taskToastEligible(db, visible,
|
|
context.actor.type === "board" ? context.actor.userId ?? null : null);
|
|
} catch (err) { logger.warn({ err, companyId: context.companyId }, "task toast eligibility failed"); }
|
|
return { ...visible, toastEligible };
|
|
},
|
|
onError: err => logger.warn({ err, companyId: context.companyId }, "live event authorization failed"),
|
|
});
|
|
const unsubscribe = subscribeCompanyLiveEvents(context.companyId, event => delivery.enqueue(event));
|
|
const unsubscribeInvalidation = opts.subscribeInvalidation?.(context.companyId, delivery.requestResync);
|
|
socket.on("message", (data, isBinary) => {
|
|
if (isBinary) { socket.close(1003, "text messages required"); return; }
|
|
delivery.receive(data.toString());
|
|
});
|
|
cleanupByClient.set(socket, () => { unsubscribe(); unsubscribeInvalidation?.(); delivery.dispose(); });
|
|
aliveByClient.set(socket, true);
|
|
|
|
socket.on("pong", () => {
|
|
aliveByClient.set(socket, true);
|
|
});
|
|
|
|
socket.on("close", () => {
|
|
const cleanup = cleanupByClient.get(socket);
|
|
if (cleanup) cleanup();
|
|
cleanupByClient.delete(socket);
|
|
aliveByClient.delete(socket);
|
|
});
|
|
|
|
socket.on("error", (err: Error) => {
|
|
logger.warn({ err, companyId: context.companyId }, "live websocket client error");
|
|
});
|
|
});
|
|
|
|
wss.on("close", () => {
|
|
clearInterval(pingInterval);
|
|
});
|
|
|
|
server.on("upgrade", (req, socket, head) => {
|
|
if ((req as IncomingMessageWithContext).paperclipWebSocketHandled) {
|
|
return;
|
|
}
|
|
|
|
const onRawSocketError = (err: Error) => {
|
|
logger.warn({ err, path: req.url }, "live websocket upgrade socket error");
|
|
};
|
|
const cleanupRawSocketListeners = () => {
|
|
socket.off("error", onRawSocketError);
|
|
socket.off("close", cleanupRawSocketListeners);
|
|
};
|
|
|
|
socket.on("error", onRawSocketError);
|
|
socket.once("close", cleanupRawSocketListeners);
|
|
|
|
if (!req.url) {
|
|
rejectUpgrade(socket, "400 Bad Request", "missing url");
|
|
return;
|
|
}
|
|
|
|
const url = new URL(req.url, "http://localhost");
|
|
const companyId = parseCompanyId(url.pathname);
|
|
if (!companyId) {
|
|
closeUpgradeSocket(socket);
|
|
return;
|
|
}
|
|
|
|
// Upgrade admission precedes this async authentication. An idle hold or
|
|
// socket close must not make its accepted database writes disappear.
|
|
void trackIdleWork(authorizeUpgrade(db, req, companyId, url, {
|
|
deploymentMode: opts.deploymentMode,
|
|
resolveSessionFromHeaders: opts.resolveSessionFromHeaders,
|
|
resolveCloudActor: opts.resolveCloudActor,
|
|
})
|
|
.then((context) => {
|
|
if (!context) {
|
|
rejectUpgrade(socket, "403 Forbidden", "forbidden");
|
|
return;
|
|
}
|
|
|
|
if (!isWritableUpgradeSocket(socket)) {
|
|
cleanupRawSocketListeners();
|
|
return;
|
|
}
|
|
|
|
const reqWithContext = req as IncomingMessageWithContext;
|
|
reqWithContext.paperclipUpgradeContext = context;
|
|
|
|
cleanupRawSocketListeners();
|
|
wss.handleUpgrade(req, socket, head, (ws: WsSocket) => {
|
|
wss.emit("connection", ws, reqWithContext);
|
|
});
|
|
})
|
|
.catch((err) => {
|
|
logger.error({ err, path: req.url }, "failed websocket upgrade authorization");
|
|
rejectUpgrade(socket, "500 Internal Server Error", "upgrade failed");
|
|
}));
|
|
});
|
|
|
|
return wss;
|
|
}
|