[codex] Harden plugin runtime invocation scope (#6547)
## Thinking Path > - Paperclip orchestrates AI-agent companies through a company-scoped control plane. > - Plugins extend that control plane, but plugin workers still call back into host APIs. > - Those worker-to-host calls need the same company boundary guarantees as normal API routes. > - Plugin action handlers also need authenticated actor context from the host instead of trusting caller-supplied params. > - This pull request hardens plugin bridge/action scope and keeps plugin operation issues out of normal issue surfaces. > - The benefit is safer plugin execution with clearer authorization boundaries and better test coverage. ## What Changed - Added host-owned invocation context plumbing for nested plugin worker calls. - Added actor context to plugin `performAction` calls and test harness helpers. - Enforced company invocation scope on worker-to-host calls and filtered company lists to the active invocation scope. - Extended plugin action route tests for board and agent actor context, spoofed company params, and cross-company rejection. - Extended plugin worker manager coverage for invocation-scope propagation. - Filtered typed and legacy plugin operation issue origins from default issue/inbox lists. ## Verification - `pnpm --filter @paperclipai/plugin-sdk build` - `NODE_ENV=test pnpm exec vitest run packages/plugins/sdk/tests/host-client-factory.test.ts packages/plugins/sdk/tests/testing-actions.test.ts server/src/__tests__/plugin-routes-authz.test.ts server/src/__tests__/plugin-worker-manager.test.ts server/src/__tests__/issues-service.test.ts` Note: embedded Postgres issue-service tests reported host-level Postgres init skip for 47 tests; the non-embedded targeted tests passed. ## Risks - Medium: plugin host authorization paths are sensitive, and external plugins may rely on previously loose company params. - Mitigation: the change only tightens calls when the host attached a company invocation scope and includes explicit tests for board, agent, and nested worker calls. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI GPT-5 Codex via `codex_local`, tool-enabled coding session; exact context window not exposed by this runtime. ## 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 run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge
This commit is contained in:
@@ -79,7 +79,7 @@ export class CapabilityDeniedError extends Error {
|
|||||||
*/
|
*/
|
||||||
export class InvocationScopeDeniedError extends Error {
|
export class InvocationScopeDeniedError extends Error {
|
||||||
override readonly name = "InvocationScopeDeniedError";
|
override readonly name = "InvocationScopeDeniedError";
|
||||||
readonly code = PLUGIN_RPC_ERROR_CODES.CAPABILITY_DENIED;
|
readonly code = PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED;
|
||||||
|
|
||||||
constructor(pluginId: string, method: string, message: string) {
|
constructor(pluginId: string, method: string, message: string) {
|
||||||
super(`Plugin "${pluginId}" is not allowed to perform "${method}": ${message}`);
|
super(`Plugin "${pluginId}" is not allowed to perform "${method}": ${message}`);
|
||||||
|
|||||||
@@ -149,6 +149,9 @@ export type {
|
|||||||
RunJobParams,
|
RunJobParams,
|
||||||
GetDataParams,
|
GetDataParams,
|
||||||
PerformActionParams,
|
PerformActionParams,
|
||||||
|
PluginPerformActionActorType,
|
||||||
|
PluginPerformActionActorContext,
|
||||||
|
PluginPerformActionContext,
|
||||||
ExecuteToolParams,
|
ExecuteToolParams,
|
||||||
PluginEnvironmentDiagnostic,
|
PluginEnvironmentDiagnostic,
|
||||||
PluginEnvironmentDriverBaseParams,
|
PluginEnvironmentDriverBaseParams,
|
||||||
|
|||||||
@@ -233,6 +233,8 @@ export const PLUGIN_RPC_ERROR_CODES = {
|
|||||||
TIMEOUT: -32003,
|
TIMEOUT: -32003,
|
||||||
/** The worker does not implement the requested optional method. */
|
/** The worker does not implement the requested optional method. */
|
||||||
METHOD_NOT_IMPLEMENTED: -32004,
|
METHOD_NOT_IMPLEMENTED: -32004,
|
||||||
|
/** The worker→host call attempted to escape the current invocation company scope. */
|
||||||
|
INVOCATION_SCOPE_DENIED: -32005,
|
||||||
/** A catch-all for errors that do not fit other categories. */
|
/** A catch-all for errors that do not fit other categories. */
|
||||||
UNKNOWN: -32099,
|
UNKNOWN: -32099,
|
||||||
} as const;
|
} as const;
|
||||||
@@ -368,6 +370,28 @@ export interface GetDataParams {
|
|||||||
*
|
*
|
||||||
* @see PLUGIN_SPEC.md §13.9 — `performAction`
|
* @see PLUGIN_SPEC.md §13.9 — `performAction`
|
||||||
*/
|
*/
|
||||||
|
export type PluginPerformActionActorType = "user" | "agent" | "system";
|
||||||
|
|
||||||
|
export interface PluginPerformActionActorContext {
|
||||||
|
/** Authenticated principal type resolved by the Paperclip host. */
|
||||||
|
type: PluginPerformActionActorType;
|
||||||
|
/** Authenticated board user id when `type === "user"`, otherwise null. */
|
||||||
|
userId: string | null;
|
||||||
|
/** Authenticated agent id when `type === "agent"`, otherwise null. */
|
||||||
|
agentId: string | null;
|
||||||
|
/** Authenticated heartbeat/run id when available. */
|
||||||
|
runId: string | null;
|
||||||
|
/** Company id authorized by the host bridge for this action, when applicable. */
|
||||||
|
companyId: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PluginPerformActionContext {
|
||||||
|
/** Immutable authenticated actor context supplied by the host. */
|
||||||
|
actor: Readonly<PluginPerformActionActorContext>;
|
||||||
|
/** Convenience alias for `actor.companyId`. */
|
||||||
|
companyId: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
export interface PerformActionParams {
|
export interface PerformActionParams {
|
||||||
/** Plugin-defined action key (e.g. `"resync"`). */
|
/** Plugin-defined action key (e.g. `"resync"`). */
|
||||||
key: string;
|
key: string;
|
||||||
@@ -375,6 +399,8 @@ export interface PerformActionParams {
|
|||||||
companyId?: string | null;
|
companyId?: string | null;
|
||||||
/** Action parameters from the UI. */
|
/** Action parameters from the UI. */
|
||||||
params: Record<string, unknown>;
|
params: Record<string, unknown>;
|
||||||
|
/** Authenticated actor context resolved by the host, never by caller params. */
|
||||||
|
actorContext?: PluginPerformActionActorContext | null;
|
||||||
/** Optional launcher/container metadata from the host render environment. */
|
/** Optional launcher/container metadata from the host render environment. */
|
||||||
renderEnvironment?: PluginLauncherRenderContextSnapshot | null;
|
renderEnvironment?: PluginLauncherRenderContextSnapshot | null;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -57,6 +57,8 @@ import type {
|
|||||||
PluginEnvironmentRealizeWorkspaceResult,
|
PluginEnvironmentRealizeWorkspaceResult,
|
||||||
PluginEnvironmentExecuteParams,
|
PluginEnvironmentExecuteParams,
|
||||||
PluginEnvironmentExecuteResult,
|
PluginEnvironmentExecuteResult,
|
||||||
|
PluginPerformActionActorContext,
|
||||||
|
PluginPerformActionContext,
|
||||||
} from "./protocol.js";
|
} from "./protocol.js";
|
||||||
|
|
||||||
export interface TestHarnessOptions {
|
export interface TestHarnessOptions {
|
||||||
@@ -74,6 +76,20 @@ export interface TestHarnessLogEntry {
|
|||||||
meta?: Record<string, unknown>;
|
meta?: Record<string, unknown>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface TestHarnessPerformActionOptions {
|
||||||
|
/**
|
||||||
|
* Authenticated actor context to expose to the action handler. Omitted fields
|
||||||
|
* default to null, and `type` defaults to `system`.
|
||||||
|
*/
|
||||||
|
actor?: Partial<PluginPerformActionActorContext> | null;
|
||||||
|
/**
|
||||||
|
* Host-authorized company scope. When provided, this is injected into
|
||||||
|
* `params.companyId` so tests match the production bridge's anti-spoofing
|
||||||
|
* behavior.
|
||||||
|
*/
|
||||||
|
companyId?: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
export interface TestHarness {
|
export interface TestHarness {
|
||||||
/** Fully-typed in-memory plugin context passed to `plugin.setup(ctx)`. */
|
/** Fully-typed in-memory plugin context passed to `plugin.setup(ctx)`. */
|
||||||
ctx: PluginContext;
|
ctx: PluginContext;
|
||||||
@@ -98,7 +114,11 @@ export interface TestHarness {
|
|||||||
/** Invoke a `ctx.data.register(...)` handler by key. */
|
/** Invoke a `ctx.data.register(...)` handler by key. */
|
||||||
getData<T = unknown>(key: string, params?: Record<string, unknown>): Promise<T>;
|
getData<T = unknown>(key: string, params?: Record<string, unknown>): Promise<T>;
|
||||||
/** Invoke a `ctx.actions.register(...)` handler by key. */
|
/** Invoke a `ctx.actions.register(...)` handler by key. */
|
||||||
performAction<T = unknown>(key: string, params?: Record<string, unknown>): Promise<T>;
|
performAction<T = unknown>(
|
||||||
|
key: string,
|
||||||
|
params?: Record<string, unknown>,
|
||||||
|
options?: TestHarnessPerformActionOptions,
|
||||||
|
): Promise<T>;
|
||||||
/** Execute a registered tool handler via `ctx.tools.execute(...)`. */
|
/** Execute a registered tool handler via `ctx.tools.execute(...)`. */
|
||||||
executeTool<T = ToolResult>(name: string, params: unknown, runCtx?: Partial<ToolRunContext>): Promise<T>;
|
executeTool<T = ToolResult>(name: string, params: unknown, runCtx?: Partial<ToolRunContext>): Promise<T>;
|
||||||
/** Read raw in-memory state for assertions. */
|
/** Read raw in-memory state for assertions. */
|
||||||
@@ -491,7 +511,10 @@ export function createTestHarness(options: TestHarnessOptions): TestHarness {
|
|||||||
const jobs = new Map<string, (job: PluginJobContext) => Promise<void>>();
|
const jobs = new Map<string, (job: PluginJobContext) => Promise<void>>();
|
||||||
const launchers = new Map<string, PluginLauncherRegistration>();
|
const launchers = new Map<string, PluginLauncherRegistration>();
|
||||||
const dataHandlers = new Map<string, (params: Record<string, unknown>) => Promise<unknown>>();
|
const dataHandlers = new Map<string, (params: Record<string, unknown>) => Promise<unknown>>();
|
||||||
const actionHandlers = new Map<string, (params: Record<string, unknown>) => Promise<unknown>>();
|
const actionHandlers = new Map<
|
||||||
|
string,
|
||||||
|
(params: Record<string, unknown>, context: PluginPerformActionContext) => Promise<unknown>
|
||||||
|
>();
|
||||||
const toolHandlers = new Map<string, (params: unknown, runCtx: ToolRunContext) => Promise<ToolResult>>();
|
const toolHandlers = new Map<string, (params: unknown, runCtx: ToolRunContext) => Promise<ToolResult>>();
|
||||||
|
|
||||||
function localFolderKey(companyId: string, folderKey: string): string {
|
function localFolderKey(companyId: string, folderKey: string): string {
|
||||||
@@ -502,6 +525,41 @@ export function createTestHarness(options: TestHarnessOptions): TestHarness {
|
|||||||
return `${localFolderKey(companyId, folderKey)}:${relativePath}`;
|
return `${localFolderKey(companyId, folderKey)}:${relativePath}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function stringOrNull(value: unknown): string | null {
|
||||||
|
return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function actorTypeOrSystem(value: unknown): PluginPerformActionActorContext["type"] {
|
||||||
|
return value === "user" || value === "agent" || value === "system" ? value : "system";
|
||||||
|
}
|
||||||
|
|
||||||
|
function actionContextFor(
|
||||||
|
params: Record<string, unknown>,
|
||||||
|
options?: TestHarnessPerformActionOptions,
|
||||||
|
): PluginPerformActionContext {
|
||||||
|
const actorInput = options?.actor ?? null;
|
||||||
|
const companyId = stringOrNull(options?.companyId) ?? stringOrNull(actorInput?.companyId) ?? stringOrNull(params.companyId);
|
||||||
|
const actor = Object.freeze({
|
||||||
|
type: actorTypeOrSystem(actorInput?.type),
|
||||||
|
userId: stringOrNull(actorInput?.userId),
|
||||||
|
agentId: stringOrNull(actorInput?.agentId),
|
||||||
|
runId: stringOrNull(actorInput?.runId),
|
||||||
|
companyId,
|
||||||
|
});
|
||||||
|
return Object.freeze({ actor, companyId });
|
||||||
|
}
|
||||||
|
|
||||||
|
function paramsWithHostCompanyScope(
|
||||||
|
params: Record<string, unknown>,
|
||||||
|
context: PluginPerformActionContext,
|
||||||
|
options?: TestHarnessPerformActionOptions,
|
||||||
|
): Record<string, unknown> {
|
||||||
|
if (Object.prototype.hasOwnProperty.call(options ?? {}, "companyId")) {
|
||||||
|
return context.companyId ? { ...params, companyId: context.companyId } : { ...params };
|
||||||
|
}
|
||||||
|
return params;
|
||||||
|
}
|
||||||
|
|
||||||
function normalizeLocalFolderRelativePath(relativePath: string): string {
|
function normalizeLocalFolderRelativePath(relativePath: string): string {
|
||||||
const parts: string[] = [];
|
const parts: string[] = [];
|
||||||
for (const segment of relativePath.split(/[\\/]+/)) {
|
for (const segment of relativePath.split(/[\\/]+/)) {
|
||||||
@@ -2302,10 +2360,15 @@ export function createTestHarness(options: TestHarnessOptions): TestHarness {
|
|||||||
if (!handler) throw new Error(`No data handler registered for '${key}'`);
|
if (!handler) throw new Error(`No data handler registered for '${key}'`);
|
||||||
return await handler(params) as T;
|
return await handler(params) as T;
|
||||||
},
|
},
|
||||||
async performAction<T = unknown>(key: string, params: Record<string, unknown> = {}) {
|
async performAction<T = unknown>(
|
||||||
|
key: string,
|
||||||
|
params: Record<string, unknown> = {},
|
||||||
|
options?: TestHarnessPerformActionOptions,
|
||||||
|
) {
|
||||||
const handler = actionHandlers.get(key);
|
const handler = actionHandlers.get(key);
|
||||||
if (!handler) throw new Error(`No action handler registered for '${key}'`);
|
if (!handler) throw new Error(`No action handler registered for '${key}'`);
|
||||||
return await handler(params) as T;
|
const context = actionContextFor(params, options);
|
||||||
|
return await handler(paramsWithHostCompanyScope(params, context, options), context) as T;
|
||||||
},
|
},
|
||||||
async executeTool<T = ToolResult>(name: string, params: unknown, runCtx: Partial<ToolRunContext> = {}) {
|
async executeTool<T = ToolResult>(name: string, params: unknown, runCtx: Partial<ToolRunContext> = {}) {
|
||||||
const handler = toolHandlers.get(name);
|
const handler = toolHandlers.get(name);
|
||||||
|
|||||||
@@ -46,6 +46,7 @@ import type {
|
|||||||
PrincipalPermissionGrant,
|
PrincipalPermissionGrant,
|
||||||
PrincipalType,
|
PrincipalType,
|
||||||
} from "@paperclipai/shared";
|
} from "@paperclipai/shared";
|
||||||
|
import type { PluginPerformActionContext } from "./protocol.js";
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
// Re-exports from @paperclipai/shared (plugin authors import from one place)
|
// Re-exports from @paperclipai/shared (plugin authors import from one place)
|
||||||
@@ -957,9 +958,12 @@ export interface PluginActionsClient {
|
|||||||
* Register a handler for a plugin-defined action key.
|
* Register a handler for a plugin-defined action key.
|
||||||
*
|
*
|
||||||
* @param key - Stable string identifier for this action (e.g. `"resync"`)
|
* @param key - Stable string identifier for this action (e.g. `"resync"`)
|
||||||
* @param handler - Async function that receives action params and returns a result
|
* @param handler - Async function that receives action params plus immutable host actor context and returns a result
|
||||||
*/
|
*/
|
||||||
register(key: string, handler: (params: Record<string, unknown>) => Promise<unknown>): void;
|
register(
|
||||||
|
key: string,
|
||||||
|
handler: (params: Record<string, unknown>, context: PluginPerformActionContext) => Promise<unknown>,
|
||||||
|
): void;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -54,6 +54,7 @@ export type {
|
|||||||
* Error codes:
|
* Error codes:
|
||||||
* - `WORKER_UNAVAILABLE` — plugin worker is not running
|
* - `WORKER_UNAVAILABLE` — plugin worker is not running
|
||||||
* - `CAPABILITY_DENIED` — plugin lacks the required capability
|
* - `CAPABILITY_DENIED` — plugin lacks the required capability
|
||||||
|
* - `INVOCATION_SCOPE_DENIED` — plugin call escaped the invocation company scope
|
||||||
* - `WORKER_ERROR` — worker returned an error from its handler
|
* - `WORKER_ERROR` — worker returned an error from its handler
|
||||||
* - `TIMEOUT` — worker did not respond within the configured timeout
|
* - `TIMEOUT` — worker did not respond within the configured timeout
|
||||||
* - `UNKNOWN` — unexpected bridge-level failure
|
* - `UNKNOWN` — unexpected bridge-level failure
|
||||||
|
|||||||
@@ -78,6 +78,8 @@ import type {
|
|||||||
RunJobParams,
|
RunJobParams,
|
||||||
GetDataParams,
|
GetDataParams,
|
||||||
PerformActionParams,
|
PerformActionParams,
|
||||||
|
PluginPerformActionActorContext,
|
||||||
|
PluginPerformActionContext,
|
||||||
ExecuteToolParams,
|
ExecuteToolParams,
|
||||||
PluginEnvironmentAcquireLeaseParams,
|
PluginEnvironmentAcquireLeaseParams,
|
||||||
PluginEnvironmentDestroyLeaseParams,
|
PluginEnvironmentDestroyLeaseParams,
|
||||||
@@ -289,7 +291,10 @@ export function startWorkerRpcHost(options: WorkerRpcHostOptions): WorkerRpcHost
|
|||||||
const jobHandlers = new Map<string, (job: PluginJobContext) => Promise<void>>();
|
const jobHandlers = new Map<string, (job: PluginJobContext) => Promise<void>>();
|
||||||
const launcherRegistrations = new Map<string, PluginLauncherRegistration>();
|
const launcherRegistrations = new Map<string, PluginLauncherRegistration>();
|
||||||
const dataHandlers = new Map<string, (params: Record<string, unknown>) => Promise<unknown>>();
|
const dataHandlers = new Map<string, (params: Record<string, unknown>) => Promise<unknown>>();
|
||||||
const actionHandlers = new Map<string, (params: Record<string, unknown>) => Promise<unknown>>();
|
const actionHandlers = new Map<
|
||||||
|
string,
|
||||||
|
(params: Record<string, unknown>, context: PluginPerformActionContext) => Promise<unknown>
|
||||||
|
>();
|
||||||
const toolHandlers = new Map<string, {
|
const toolHandlers = new Map<string, {
|
||||||
declaration: Pick<import("@paperclipai/shared").PluginToolDeclaration, "displayName" | "description" | "parametersSchema">;
|
declaration: Pick<import("@paperclipai/shared").PluginToolDeclaration, "displayName" | "description" | "parametersSchema">;
|
||||||
fn: (params: unknown, runCtx: ToolRunContext) => Promise<ToolResult>;
|
fn: (params: unknown, runCtx: ToolRunContext) => Promise<ToolResult>;
|
||||||
@@ -1184,7 +1189,10 @@ export function startWorkerRpcHost(options: WorkerRpcHostOptions): WorkerRpcHost
|
|||||||
},
|
},
|
||||||
|
|
||||||
actions: {
|
actions: {
|
||||||
register(key: string, handler: (params: Record<string, unknown>) => Promise<unknown>): void {
|
register(
|
||||||
|
key: string,
|
||||||
|
handler: (params: Record<string, unknown>, context: PluginPerformActionContext) => Promise<unknown>,
|
||||||
|
): void {
|
||||||
actionHandlers.set(key, handler);
|
actionHandlers.set(key, handler);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -1514,16 +1522,44 @@ export function startWorkerRpcHost(options: WorkerRpcHostOptions): WorkerRpcHost
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function stringOrNull(value: unknown): string | null {
|
||||||
|
return typeof value === "string" && value.trim().length > 0 ? value.trim() : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function actorTypeOrSystem(value: unknown): PluginPerformActionActorContext["type"] {
|
||||||
|
return value === "user" || value === "agent" || value === "system" ? value : "system";
|
||||||
|
}
|
||||||
|
|
||||||
|
function actionContextFromParams(params: PerformActionParams): PluginPerformActionContext {
|
||||||
|
const rawActor = params.actorContext && typeof params.actorContext === "object"
|
||||||
|
? params.actorContext
|
||||||
|
: null;
|
||||||
|
const actor = Object.freeze({
|
||||||
|
type: actorTypeOrSystem(rawActor?.type),
|
||||||
|
userId: stringOrNull(rawActor?.userId),
|
||||||
|
agentId: stringOrNull(rawActor?.agentId),
|
||||||
|
runId: stringOrNull(rawActor?.runId),
|
||||||
|
companyId: stringOrNull(rawActor?.companyId),
|
||||||
|
});
|
||||||
|
return Object.freeze({
|
||||||
|
actor,
|
||||||
|
companyId: actor.companyId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
async function handlePerformAction(params: PerformActionParams): Promise<unknown> {
|
async function handlePerformAction(params: PerformActionParams): Promise<unknown> {
|
||||||
const handler = actionHandlers.get(params.key);
|
const handler = actionHandlers.get(params.key);
|
||||||
if (!handler) {
|
if (!handler) {
|
||||||
throw new Error(`No action handler registered for key "${params.key}"`);
|
throw new Error(`No action handler registered for key "${params.key}"`);
|
||||||
}
|
}
|
||||||
return handler({
|
return handler(
|
||||||
...params.params,
|
{
|
||||||
...(params.companyId === undefined ? {} : { companyId: params.companyId }),
|
...params.params,
|
||||||
...(params.renderEnvironment === undefined ? {} : { renderEnvironment: params.renderEnvironment }),
|
...(params.companyId === undefined ? {} : { companyId: params.companyId }),
|
||||||
});
|
...(params.renderEnvironment === undefined ? {} : { renderEnvironment: params.renderEnvironment }),
|
||||||
|
},
|
||||||
|
actionContextFromParams(params),
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function handleExecuteTool(params: ExecuteToolParams): Promise<ToolResult> {
|
async function handleExecuteTool(params: ExecuteToolParams): Promise<ToolResult> {
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import {
|
|||||||
createHostClientHandlers,
|
createHostClientHandlers,
|
||||||
InvocationScopeDeniedError,
|
InvocationScopeDeniedError,
|
||||||
} from "../src/host-client-factory.js";
|
} from "../src/host-client-factory.js";
|
||||||
|
import { PLUGIN_RPC_ERROR_CODES } from "../src/protocol.js";
|
||||||
|
|
||||||
describe("createHostClientHandlers invocation company scope", () => {
|
describe("createHostClientHandlers invocation company scope", () => {
|
||||||
it("rejects company-scoped host calls outside the current invocation company", async () => {
|
it("rejects company-scoped host calls outside the current invocation company", async () => {
|
||||||
@@ -28,6 +29,14 @@ describe("createHostClientHandlers invocation company scope", () => {
|
|||||||
{ invocationScope: { companyId: "company-a" } },
|
{ invocationScope: { companyId: "company-a" } },
|
||||||
),
|
),
|
||||||
).rejects.toBeInstanceOf(InvocationScopeDeniedError);
|
).rejects.toBeInstanceOf(InvocationScopeDeniedError);
|
||||||
|
await expect(
|
||||||
|
handlers["projects.list"](
|
||||||
|
{ companyId: "company-b" },
|
||||||
|
{ invocationScope: { companyId: "company-a" } },
|
||||||
|
),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
code: PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED,
|
||||||
|
});
|
||||||
expect(projectsList).not.toHaveBeenCalled();
|
expect(projectsList).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,74 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import { createTestHarness } from "../src/testing.js";
|
||||||
|
import type { PaperclipPluginManifestV1 } from "../src/types.js";
|
||||||
|
|
||||||
|
const manifest = {
|
||||||
|
id: "paperclip.test-actions",
|
||||||
|
apiVersion: 1,
|
||||||
|
version: "1.0.0",
|
||||||
|
displayName: "Test Actions",
|
||||||
|
description: "Test plugin",
|
||||||
|
author: "Paperclip",
|
||||||
|
categories: ["automation"],
|
||||||
|
capabilities: [],
|
||||||
|
entrypoints: {},
|
||||||
|
} satisfies PaperclipPluginManifestV1;
|
||||||
|
|
||||||
|
describe("createTestHarness action context", () => {
|
||||||
|
it("passes immutable authenticated actor context and overrides caller company scope", async () => {
|
||||||
|
const harness = createTestHarness({ manifest });
|
||||||
|
|
||||||
|
harness.ctx.actions.register("inspect", async (params, context) => ({
|
||||||
|
paramsCompanyId: params.companyId,
|
||||||
|
actor: context.actor,
|
||||||
|
companyId: context.companyId,
|
||||||
|
contextFrozen: Object.isFrozen(context),
|
||||||
|
actorFrozen: Object.isFrozen(context.actor),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const result = await harness.performAction<{
|
||||||
|
paramsCompanyId: unknown;
|
||||||
|
actor: {
|
||||||
|
type: string;
|
||||||
|
userId: string | null;
|
||||||
|
agentId: string | null;
|
||||||
|
runId: string | null;
|
||||||
|
companyId: string | null;
|
||||||
|
};
|
||||||
|
companyId: string | null;
|
||||||
|
contextFrozen: boolean;
|
||||||
|
actorFrozen: boolean;
|
||||||
|
}>(
|
||||||
|
"inspect",
|
||||||
|
{ companyId: "spoofed-company", value: true },
|
||||||
|
{
|
||||||
|
companyId: "host-company",
|
||||||
|
actor: {
|
||||||
|
type: "user",
|
||||||
|
userId: "board-user-1",
|
||||||
|
runId: "run-1",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(result.paramsCompanyId).toBe("host-company");
|
||||||
|
expect(result.companyId).toBe("host-company");
|
||||||
|
expect(result.actor).toEqual({
|
||||||
|
type: "user",
|
||||||
|
userId: "board-user-1",
|
||||||
|
agentId: null,
|
||||||
|
runId: "run-1",
|
||||||
|
companyId: "host-company",
|
||||||
|
});
|
||||||
|
expect(result.contextFrozen).toBe(true);
|
||||||
|
expect(result.actorFrozen).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("keeps existing one-argument action handlers compatible", async () => {
|
||||||
|
const harness = createTestHarness({ manifest });
|
||||||
|
harness.ctx.actions.register("legacy", async (params) => ({ ok: params.ok }));
|
||||||
|
|
||||||
|
await expect(harness.performAction("legacy", { ok: true })).resolves.toEqual({ ok: true });
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -71,6 +71,90 @@ describe("isWorkerEntrypoint", () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("worker performAction context", () => {
|
||||||
|
it("does not derive context companyId from caller params without host actor context", async () => {
|
||||||
|
const hostToWorker = new PassThrough();
|
||||||
|
const workerToHost = new PassThrough();
|
||||||
|
const hostReadline = createInterface({ input: workerToHost });
|
||||||
|
const pending = new Map<string, (response: JsonRpcResponse) => void>();
|
||||||
|
let nextRequestId = 1;
|
||||||
|
const plugin = definePlugin({
|
||||||
|
async setup(ctx) {
|
||||||
|
ctx.actions.register("inspect", async (params, context) => ({
|
||||||
|
paramsCompanyId: params.companyId,
|
||||||
|
actor: context.actor,
|
||||||
|
companyId: context.companyId,
|
||||||
|
}));
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const worker = startWorkerRpcHost({
|
||||||
|
plugin,
|
||||||
|
stdin: hostToWorker,
|
||||||
|
stdout: workerToHost,
|
||||||
|
});
|
||||||
|
|
||||||
|
function callWorker(method: string, params: unknown) {
|
||||||
|
const id = `host-${nextRequestId++}`;
|
||||||
|
const result = new Promise<unknown>((resolve, reject) => {
|
||||||
|
pending.set(id, (response) => {
|
||||||
|
if ("error" in response && response.error) {
|
||||||
|
reject(new Error(response.error.message));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
resolve((response as { result?: unknown }).result);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
hostToWorker.write(serializeMessage(createRequest(method, params, id)));
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
hostReadline.on("line", (line) => {
|
||||||
|
const message = parseMessage(line);
|
||||||
|
if (!isJsonRpcResponse(message)) return;
|
||||||
|
pending.get(String(message.id))?.(message);
|
||||||
|
pending.delete(String(message.id));
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await expect(callWorker("initialize", {
|
||||||
|
manifest: {
|
||||||
|
id: "paperclip.test-worker-context",
|
||||||
|
apiVersion: 1,
|
||||||
|
version: "1.0.0",
|
||||||
|
displayName: "Worker Context Test",
|
||||||
|
description: "Test plugin",
|
||||||
|
author: "Paperclip",
|
||||||
|
categories: ["automation"],
|
||||||
|
capabilities: [],
|
||||||
|
entrypoints: {},
|
||||||
|
},
|
||||||
|
config: {},
|
||||||
|
databaseNamespace: null,
|
||||||
|
})).resolves.toMatchObject({ ok: true });
|
||||||
|
|
||||||
|
await expect(callWorker("performAction", {
|
||||||
|
key: "inspect",
|
||||||
|
params: { companyId: "spoofed-company" },
|
||||||
|
})).resolves.toEqual({
|
||||||
|
paramsCompanyId: "spoofed-company",
|
||||||
|
actor: {
|
||||||
|
type: "system",
|
||||||
|
userId: null,
|
||||||
|
agentId: null,
|
||||||
|
runId: null,
|
||||||
|
companyId: null,
|
||||||
|
},
|
||||||
|
companyId: null,
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
worker.stop();
|
||||||
|
hostReadline.close();
|
||||||
|
hostToWorker.destroy();
|
||||||
|
workerToHost.destroy();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe("worker invocation scope propagation", () => {
|
describe("worker invocation scope propagation", () => {
|
||||||
it("keeps overlapping company scopes local to each getData invocation", async () => {
|
it("keeps overlapping company scopes local to each getData invocation", async () => {
|
||||||
const hostToWorker = new PassThrough();
|
const hostToWorker = new PassThrough();
|
||||||
|
|||||||
@@ -1095,6 +1095,7 @@ export type PluginEventType = (typeof PLUGIN_EVENT_TYPES)[number];
|
|||||||
export const PLUGIN_BRIDGE_ERROR_CODES = [
|
export const PLUGIN_BRIDGE_ERROR_CODES = [
|
||||||
"WORKER_UNAVAILABLE",
|
"WORKER_UNAVAILABLE",
|
||||||
"CAPABILITY_DENIED",
|
"CAPABILITY_DENIED",
|
||||||
|
"INVOCATION_SCOPE_DENIED",
|
||||||
"WORKER_ERROR",
|
"WORKER_ERROR",
|
||||||
"TIMEOUT",
|
"TIMEOUT",
|
||||||
"UNKNOWN",
|
"UNKNOWN",
|
||||||
|
|||||||
@@ -68,13 +68,13 @@ rl.on("line", (line) => {
|
|||||||
id: message.id,
|
id: message.id,
|
||||||
result: {
|
result: {
|
||||||
ok: true,
|
ok: true,
|
||||||
supportedMethods: ["getData"],
|
supportedMethods: ["getData", "performAction"],
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (method === "getData") {
|
if (method === "getData" || method === "performAction") {
|
||||||
sendNestedHostRequest(message, message.paperclipInvocation?.id);
|
sendNestedHostRequest(message, message.paperclipInvocation?.id);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -773,6 +773,8 @@ describeEmbeddedPostgres("issueService.list participantAgentId", () => {
|
|||||||
const normalIssueId = randomUUID();
|
const normalIssueId = randomUUID();
|
||||||
const pluginVisibleIssueId = randomUUID();
|
const pluginVisibleIssueId = randomUUID();
|
||||||
const operationIssueId = randomUUID();
|
const operationIssueId = randomUUID();
|
||||||
|
const typedOperationIssueId = randomUUID();
|
||||||
|
const legacyContentMachineOperationIssueId = randomUUID();
|
||||||
|
|
||||||
await db.insert(companies).values({
|
await db.insert(companies).values({
|
||||||
id: companyId,
|
id: companyId,
|
||||||
@@ -826,12 +828,36 @@ describeEmbeddedPostgres("issueService.list participantAgentId", () => {
|
|||||||
originKind: "plugin:paperclip.missions:operation",
|
originKind: "plugin:paperclip.missions:operation",
|
||||||
originId: "mission-alpha:operation-1",
|
originId: "mission-alpha:operation-1",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: typedOperationIssueId,
|
||||||
|
companyId,
|
||||||
|
projectId,
|
||||||
|
title: "Typed plugin operation issue",
|
||||||
|
status: "todo",
|
||||||
|
priority: "medium",
|
||||||
|
assigneeAgentId: agentId,
|
||||||
|
originKind: "plugin:paperclip.missions:operation:evaluation",
|
||||||
|
originId: "mission-alpha:operation-2",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: legacyContentMachineOperationIssueId,
|
||||||
|
companyId,
|
||||||
|
projectId,
|
||||||
|
title: "Legacy Content Machine operation issue",
|
||||||
|
status: "todo",
|
||||||
|
priority: "medium",
|
||||||
|
assigneeAgentId: agentId,
|
||||||
|
originKind: "plugin:paperclipai.content-machine:evaluation",
|
||||||
|
originId: "content-machine-operation-1",
|
||||||
|
},
|
||||||
]);
|
]);
|
||||||
|
|
||||||
const defaultIssueIds = (await svc.list(companyId)).map((issue) => issue.id);
|
const defaultIssueIds = (await svc.list(companyId)).map((issue) => issue.id);
|
||||||
expect(defaultIssueIds).toContain(normalIssueId);
|
expect(defaultIssueIds).toContain(normalIssueId);
|
||||||
expect(defaultIssueIds).toContain(pluginVisibleIssueId);
|
expect(defaultIssueIds).toContain(pluginVisibleIssueId);
|
||||||
expect(defaultIssueIds).not.toContain(operationIssueId);
|
expect(defaultIssueIds).not.toContain(operationIssueId);
|
||||||
|
expect(defaultIssueIds).not.toContain(typedOperationIssueId);
|
||||||
|
expect(defaultIssueIds).not.toContain(legacyContentMachineOperationIssueId);
|
||||||
|
|
||||||
const inboxIssueIds = (await svc.list(companyId, {
|
const inboxIssueIds = (await svc.list(companyId, {
|
||||||
assigneeAgentId: agentId,
|
assigneeAgentId: agentId,
|
||||||
@@ -840,17 +866,28 @@ describeEmbeddedPostgres("issueService.list participantAgentId", () => {
|
|||||||
})).map((issue) => issue.id);
|
})).map((issue) => issue.id);
|
||||||
expect(inboxIssueIds).toContain(normalIssueId);
|
expect(inboxIssueIds).toContain(normalIssueId);
|
||||||
expect(inboxIssueIds).not.toContain(operationIssueId);
|
expect(inboxIssueIds).not.toContain(operationIssueId);
|
||||||
|
expect(inboxIssueIds).not.toContain(typedOperationIssueId);
|
||||||
|
expect(inboxIssueIds).not.toContain(legacyContentMachineOperationIssueId);
|
||||||
|
|
||||||
await expect(svc.list(companyId, { originKind: "plugin:paperclip.missions:operation" }))
|
await expect(svc.list(companyId, { originKind: "plugin:paperclip.missions:operation" }))
|
||||||
.resolves.toEqual([expect.objectContaining({ id: operationIssueId })]);
|
.resolves.toEqual([expect.objectContaining({ id: operationIssueId })]);
|
||||||
await expect(svc.list(companyId, { originId: "mission-alpha:operation-1" }))
|
await expect(svc.list(companyId, { originId: "mission-alpha:operation-1" }))
|
||||||
.resolves.toEqual([expect.objectContaining({ id: operationIssueId })]);
|
.resolves.toEqual([expect.objectContaining({ id: operationIssueId })]);
|
||||||
|
await expect(svc.list(companyId, { originKindPrefix: "plugin:paperclip.missions:operation" }))
|
||||||
|
.resolves.toEqual(expect.arrayContaining([
|
||||||
|
expect.objectContaining({ id: operationIssueId }),
|
||||||
|
expect.objectContaining({ id: typedOperationIssueId }),
|
||||||
|
]));
|
||||||
|
|
||||||
const projectIssueIds = (await svc.list(companyId, { projectId })).map((issue) => issue.id);
|
const projectIssueIds = (await svc.list(companyId, { projectId })).map((issue) => issue.id);
|
||||||
expect(projectIssueIds).toContain(operationIssueId);
|
expect(projectIssueIds).toContain(operationIssueId);
|
||||||
|
expect(projectIssueIds).toContain(typedOperationIssueId);
|
||||||
|
expect(projectIssueIds).toContain(legacyContentMachineOperationIssueId);
|
||||||
|
|
||||||
const advancedIssueIds = (await svc.list(companyId, { includePluginOperations: true })).map((issue) => issue.id);
|
const advancedIssueIds = (await svc.list(companyId, { includePluginOperations: true })).map((issue) => issue.id);
|
||||||
expect(advancedIssueIds).toContain(operationIssueId);
|
expect(advancedIssueIds).toContain(operationIssueId);
|
||||||
|
expect(advancedIssueIds).toContain(typedOperationIssueId);
|
||||||
|
expect(advancedIssueIds).toContain(legacyContentMachineOperationIssueId);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("excludes plugin operation issues from unread inbox counts", async () => {
|
it("excludes plugin operation issues from unread inbox counts", async () => {
|
||||||
|
|||||||
@@ -114,6 +114,17 @@ function boardActor(overrides: Record<string, unknown> = {}) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function agentActor(overrides: Record<string, unknown> = {}) {
|
||||||
|
return {
|
||||||
|
type: "agent",
|
||||||
|
agentId: agentA,
|
||||||
|
companyId: companyA,
|
||||||
|
runId: runA,
|
||||||
|
source: "agent_jwt",
|
||||||
|
...overrides,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
function readyPlugin() {
|
function readyPlugin() {
|
||||||
mockRegistry.getById.mockResolvedValue({
|
mockRegistry.getById.mockResolvedValue({
|
||||||
id: pluginId,
|
id: pluginId,
|
||||||
@@ -656,10 +667,160 @@ describe.sequential("plugin tool and bridge authz", () => {
|
|||||||
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
||||||
key: "sync",
|
key: "sync",
|
||||||
params: {},
|
params: {},
|
||||||
|
actorContext: {
|
||||||
|
type: "user",
|
||||||
|
userId: "admin-1",
|
||||||
|
agentId: null,
|
||||||
|
runId: null,
|
||||||
|
companyId: null,
|
||||||
|
},
|
||||||
renderEnvironment: null,
|
renderEnvironment: null,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("passes authenticated actor context and overrides spoofed company scope for plugin actions", async () => {
|
||||||
|
readyPlugin();
|
||||||
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
||||||
|
const { app } = await createApp(boardActor({ runId: runA }), {}, {
|
||||||
|
bridgeDeps: {
|
||||||
|
workerManager: { call },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await request(app)
|
||||||
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
||||||
|
.send({
|
||||||
|
companyId: companyA,
|
||||||
|
params: {
|
||||||
|
companyId: companyB,
|
||||||
|
reviewerUserId: "spoofed-user",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
||||||
|
key: "sync",
|
||||||
|
params: {
|
||||||
|
companyId: companyA,
|
||||||
|
reviewerUserId: "spoofed-user",
|
||||||
|
},
|
||||||
|
actorContext: {
|
||||||
|
type: "user",
|
||||||
|
userId: "user-1",
|
||||||
|
agentId: null,
|
||||||
|
runId: runA,
|
||||||
|
companyId: companyA,
|
||||||
|
},
|
||||||
|
renderEnvironment: null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("uses null for board actor userId when no authenticated user id is present", async () => {
|
||||||
|
readyPlugin();
|
||||||
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
||||||
|
const { app } = await createApp(boardActor({ userId: undefined }), {}, {
|
||||||
|
bridgeDeps: {
|
||||||
|
workerManager: { call },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await request(app)
|
||||||
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
||||||
|
.send({ companyId: companyA });
|
||||||
|
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", expect.objectContaining({
|
||||||
|
actorContext: expect.objectContaining({
|
||||||
|
type: "user",
|
||||||
|
userId: null,
|
||||||
|
companyId: companyA,
|
||||||
|
}),
|
||||||
|
}));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("allows agent-scoped plugin actions with authenticated actor context", async () => {
|
||||||
|
readyPlugin();
|
||||||
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
||||||
|
const { app } = await createApp(agentActor(), {}, {
|
||||||
|
bridgeDeps: {
|
||||||
|
workerManager: { call },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await request(app)
|
||||||
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
||||||
|
.send({
|
||||||
|
companyId: companyA,
|
||||||
|
params: {
|
||||||
|
companyId: companyB,
|
||||||
|
reviewerAgentId: "spoofed-agent",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(res.status).toBe(200);
|
||||||
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
||||||
|
key: "sync",
|
||||||
|
params: {
|
||||||
|
companyId: companyA,
|
||||||
|
reviewerAgentId: "spoofed-agent",
|
||||||
|
},
|
||||||
|
actorContext: {
|
||||||
|
type: "agent",
|
||||||
|
userId: null,
|
||||||
|
agentId: agentA,
|
||||||
|
runId: runA,
|
||||||
|
companyId: companyA,
|
||||||
|
},
|
||||||
|
renderEnvironment: null,
|
||||||
|
});
|
||||||
|
|
||||||
|
call.mockClear();
|
||||||
|
const legacyRes = await request(app)
|
||||||
|
.post(`/api/plugins/${pluginId}/bridge/action`)
|
||||||
|
.send({
|
||||||
|
key: "sync",
|
||||||
|
companyId: companyA,
|
||||||
|
params: {
|
||||||
|
companyId: companyB,
|
||||||
|
reviewerAgentId: "spoofed-agent",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(legacyRes.status).toBe(200);
|
||||||
|
expect(call).toHaveBeenCalledWith(pluginId, "performAction", {
|
||||||
|
key: "sync",
|
||||||
|
params: {
|
||||||
|
companyId: companyA,
|
||||||
|
reviewerAgentId: "spoofed-agent",
|
||||||
|
},
|
||||||
|
actorContext: {
|
||||||
|
type: "agent",
|
||||||
|
userId: null,
|
||||||
|
agentId: agentA,
|
||||||
|
runId: runA,
|
||||||
|
companyId: companyA,
|
||||||
|
},
|
||||||
|
renderEnvironment: null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects agent plugin actions outside the authenticated company scope", async () => {
|
||||||
|
readyPlugin();
|
||||||
|
const call = vi.fn().mockResolvedValue({ ok: true });
|
||||||
|
const { app } = await createApp(agentActor(), {}, {
|
||||||
|
bridgeDeps: {
|
||||||
|
workerManager: { call },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const res = await request(app)
|
||||||
|
.post(`/api/plugins/${pluginId}/actions/sync`)
|
||||||
|
.send({ companyId: companyB });
|
||||||
|
|
||||||
|
expect(res.status).toBe(403);
|
||||||
|
expect(call).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
it("attaches worker bridge errors to the HTTP logger context", async () => {
|
it("attaches worker bridge errors to the HTTP logger context", async () => {
|
||||||
readyPlugin();
|
readyPlugin();
|
||||||
const call = vi.fn().mockRejectedValue(new Error("missing source_objects column"));
|
const call = vi.fn().mockRejectedValue(new Error("missing source_objects column"));
|
||||||
|
|||||||
@@ -186,6 +186,58 @@ describe("plugin-worker-manager stderr failure context", () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("passes performAction invocation scope to nested worker host calls", async () => {
|
||||||
|
const companiesGet = vi.fn(async (
|
||||||
|
params: { companyId: string },
|
||||||
|
context?: { invocationScope?: { companyId?: string | null } | null },
|
||||||
|
) => ({
|
||||||
|
id: params.companyId,
|
||||||
|
scopedCompanyId: context?.invocationScope?.companyId ?? null,
|
||||||
|
}));
|
||||||
|
const handle = createPluginWorkerHandle("test.plugin", {
|
||||||
|
entrypointPath: INVOCATION_SCOPE_WORKER_ENTRYPOINT,
|
||||||
|
manifest: TEST_MANIFEST,
|
||||||
|
config: {},
|
||||||
|
instanceInfo: {
|
||||||
|
instanceId: "instance-1",
|
||||||
|
hostVersion: "1.0.0",
|
||||||
|
},
|
||||||
|
apiVersion: 1,
|
||||||
|
hostHandlers: {
|
||||||
|
"companies.get": companiesGet as never,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await handle.start();
|
||||||
|
|
||||||
|
await expect(handle.call("performAction", {
|
||||||
|
key: "probe",
|
||||||
|
params: {
|
||||||
|
mode: "echo",
|
||||||
|
requestedCompanyId: "company-a",
|
||||||
|
},
|
||||||
|
actorContext: {
|
||||||
|
type: "agent",
|
||||||
|
userId: null,
|
||||||
|
agentId: "agent-1",
|
||||||
|
runId: "run-1",
|
||||||
|
companyId: "company-a",
|
||||||
|
},
|
||||||
|
renderEnvironment: null,
|
||||||
|
})).resolves.toEqual({
|
||||||
|
id: "company-a",
|
||||||
|
scopedCompanyId: "company-a",
|
||||||
|
});
|
||||||
|
expect(companiesGet).toHaveBeenCalledWith(
|
||||||
|
{ companyId: "company-a" },
|
||||||
|
{ invocationScope: { companyId: "company-a" } },
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
await handle.stop().catch(() => undefined);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
it("passes echoed invocation scope to worker-to-host handlers", async () => {
|
it("passes echoed invocation scope to worker-to-host handlers", async () => {
|
||||||
const companiesGet = vi.fn(async () => ({ id: "company-1" }));
|
const companiesGet = vi.fn(async () => ({ id: "company-1" }));
|
||||||
const handle = createPluginWorkerHandle("test.plugin", {
|
const handle = createPluginWorkerHandle("test.plugin", {
|
||||||
@@ -223,6 +275,104 @@ describe("plugin-worker-manager stderr failure context", () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("rejects performAction nested host calls that omit the invocation id", async () => {
|
||||||
|
const handlers = createHostClientHandlers({
|
||||||
|
pluginId: "test.plugin",
|
||||||
|
capabilities: ["companies.read"],
|
||||||
|
services: {
|
||||||
|
companies: {
|
||||||
|
list: vi.fn(async () => []),
|
||||||
|
get: vi.fn(async (params: { companyId: string }) => ({ id: params.companyId })),
|
||||||
|
},
|
||||||
|
} as unknown as HostServices,
|
||||||
|
});
|
||||||
|
const handle = createPluginWorkerHandle("test.plugin", {
|
||||||
|
entrypointPath: INVOCATION_SCOPE_WORKER_ENTRYPOINT,
|
||||||
|
manifest: TEST_MANIFEST,
|
||||||
|
config: {},
|
||||||
|
instanceInfo: {
|
||||||
|
instanceId: "instance-1",
|
||||||
|
hostVersion: "1.0.0",
|
||||||
|
},
|
||||||
|
apiVersion: 1,
|
||||||
|
hostHandlers: handlers,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await handle.start();
|
||||||
|
|
||||||
|
await expect(handle.call("performAction", {
|
||||||
|
key: "probe",
|
||||||
|
params: {
|
||||||
|
requestedCompanyId: "company-b",
|
||||||
|
},
|
||||||
|
actorContext: {
|
||||||
|
type: "agent",
|
||||||
|
userId: null,
|
||||||
|
agentId: "agent-1",
|
||||||
|
runId: "run-1",
|
||||||
|
companyId: "company-a",
|
||||||
|
},
|
||||||
|
renderEnvironment: null,
|
||||||
|
})).rejects.toMatchObject({
|
||||||
|
code: PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED,
|
||||||
|
message: expect.stringContaining("unknown invocation scope"),
|
||||||
|
});
|
||||||
|
} finally {
|
||||||
|
await handle.stop().catch(() => undefined);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects nested worker host calls that forge an unknown invocation id", async () => {
|
||||||
|
const companiesGet = vi.fn(async (params: { companyId: string }) => ({ id: params.companyId }));
|
||||||
|
const handlers = createHostClientHandlers({
|
||||||
|
pluginId: "test.plugin",
|
||||||
|
capabilities: ["companies.read"],
|
||||||
|
services: {
|
||||||
|
companies: {
|
||||||
|
get: companiesGet,
|
||||||
|
},
|
||||||
|
} as unknown as HostServices,
|
||||||
|
});
|
||||||
|
const handle = createPluginWorkerHandle("test.plugin", {
|
||||||
|
entrypointPath: INVOCATION_SCOPE_WORKER_ENTRYPOINT,
|
||||||
|
manifest: TEST_MANIFEST,
|
||||||
|
config: {},
|
||||||
|
instanceInfo: {
|
||||||
|
instanceId: "instance-1",
|
||||||
|
hostVersion: "1.0.0",
|
||||||
|
},
|
||||||
|
apiVersion: 1,
|
||||||
|
hostHandlers: handlers,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await handle.start();
|
||||||
|
|
||||||
|
await expect(handle.call("performAction", {
|
||||||
|
key: "probe",
|
||||||
|
params: {
|
||||||
|
mode: "unknown",
|
||||||
|
requestedCompanyId: "company-a",
|
||||||
|
},
|
||||||
|
actorContext: {
|
||||||
|
type: "agent",
|
||||||
|
userId: null,
|
||||||
|
agentId: "agent-1",
|
||||||
|
runId: "run-1",
|
||||||
|
companyId: "company-a",
|
||||||
|
},
|
||||||
|
renderEnvironment: null,
|
||||||
|
})).rejects.toMatchObject({
|
||||||
|
code: PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED,
|
||||||
|
message: expect.stringContaining("unknown invocation scope"),
|
||||||
|
});
|
||||||
|
expect(companiesGet).not.toHaveBeenCalled();
|
||||||
|
} finally {
|
||||||
|
await handle.stop().catch(() => undefined);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
it("rejects missing or unknown invocation ids while a company invocation is active", async () => {
|
it("rejects missing or unknown invocation ids while a company invocation is active", async () => {
|
||||||
const companiesGet = vi.fn(async () => ({ id: "company-2" }));
|
const companiesGet = vi.fn(async () => ({ id: "company-2" }));
|
||||||
const hostHandlers = createHostClientHandlers({
|
const hostHandlers = createHostClientHandlers({
|
||||||
@@ -258,7 +408,7 @@ describe("plugin-worker-manager stderr failure context", () => {
|
|||||||
requestedCompanyId: "company-2",
|
requestedCompanyId: "company-2",
|
||||||
},
|
},
|
||||||
} as HostToWorkerMethods["getData"][0])).rejects.toMatchObject({
|
} as HostToWorkerMethods["getData"][0])).rejects.toMatchObject({
|
||||||
code: PLUGIN_RPC_ERROR_CODES.CAPABILITY_DENIED,
|
code: PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ import type { PluginJobStore } from "../services/plugin-job-store.js";
|
|||||||
import type { PluginWorkerManager } from "../services/plugin-worker-manager.js";
|
import type { PluginWorkerManager } from "../services/plugin-worker-manager.js";
|
||||||
import type { PluginStreamBus } from "../services/plugin-stream-bus.js";
|
import type { PluginStreamBus } from "../services/plugin-stream-bus.js";
|
||||||
import type { PluginToolDispatcher } from "../services/plugin-tool-dispatcher.js";
|
import type { PluginToolDispatcher } from "../services/plugin-tool-dispatcher.js";
|
||||||
import type { ToolRunContext } from "@paperclipai/plugin-sdk";
|
import type { PluginPerformActionActorContext, ToolRunContext } from "@paperclipai/plugin-sdk";
|
||||||
import { JsonRpcCallError, PLUGIN_RPC_ERROR_CODES } from "@paperclipai/plugin-sdk";
|
import { JsonRpcCallError, PLUGIN_RPC_ERROR_CODES } from "@paperclipai/plugin-sdk";
|
||||||
import {
|
import {
|
||||||
assertAuthenticated,
|
assertAuthenticated,
|
||||||
@@ -572,6 +572,43 @@ export function pluginRoutes(
|
|||||||
return companyId;
|
return companyId;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function performActionActorContext(req: Request, companyId: string | undefined): PluginPerformActionActorContext {
|
||||||
|
const scopedCompanyId = companyId ?? null;
|
||||||
|
if (req.actor.type === "agent") {
|
||||||
|
return {
|
||||||
|
type: "agent",
|
||||||
|
userId: null,
|
||||||
|
agentId: req.actor.agentId ?? null,
|
||||||
|
runId: req.actor.runId ?? null,
|
||||||
|
companyId: scopedCompanyId,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (req.actor.type === "board") {
|
||||||
|
return {
|
||||||
|
type: "user",
|
||||||
|
userId: req.actor.userId ?? null,
|
||||||
|
agentId: null,
|
||||||
|
runId: req.actor.runId ?? null,
|
||||||
|
companyId: scopedCompanyId,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
type: "system",
|
||||||
|
userId: null,
|
||||||
|
agentId: null,
|
||||||
|
runId: req.actor.runId ?? null,
|
||||||
|
companyId: scopedCompanyId,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function actionParamsWithAuthorizedCompanyScope(
|
||||||
|
params: Record<string, unknown> | undefined,
|
||||||
|
companyId: string | undefined,
|
||||||
|
): Record<string, unknown> {
|
||||||
|
const base = params ?? {};
|
||||||
|
return companyId === undefined ? base : { ...base, companyId };
|
||||||
|
}
|
||||||
|
|
||||||
async function validateToolRunContextScope(runContext: ToolRunContext): Promise<string | null> {
|
async function validateToolRunContextScope(runContext: ToolRunContext): Promise<string | null> {
|
||||||
const [agent] = await db
|
const [agent] = await db
|
||||||
.select({ companyId: agents.companyId })
|
.select({ companyId: agents.companyId })
|
||||||
@@ -984,6 +1021,12 @@ export function pluginRoutes(
|
|||||||
message: err.message,
|
message: err.message,
|
||||||
details: err.data,
|
details: err.data,
|
||||||
};
|
};
|
||||||
|
case PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED:
|
||||||
|
return {
|
||||||
|
code: "INVOCATION_SCOPE_DENIED",
|
||||||
|
message: err.message,
|
||||||
|
details: err.data,
|
||||||
|
};
|
||||||
case PLUGIN_RPC_ERROR_CODES.TIMEOUT:
|
case PLUGIN_RPC_ERROR_CODES.TIMEOUT:
|
||||||
return {
|
return {
|
||||||
code: "TIMEOUT",
|
code: "TIMEOUT",
|
||||||
@@ -1171,7 +1214,7 @@ export function pluginRoutes(
|
|||||||
* @see PLUGIN_SPEC.md §19.7 — Error Propagation Through The Bridge
|
* @see PLUGIN_SPEC.md §19.7 — Error Propagation Through The Bridge
|
||||||
*/
|
*/
|
||||||
router.post("/plugins/:pluginId/bridge/action", async (req, res) => {
|
router.post("/plugins/:pluginId/bridge/action", async (req, res) => {
|
||||||
assertBoardOrgAccess(req);
|
assertAuthenticated(req);
|
||||||
|
|
||||||
if (!bridgeDeps) {
|
if (!bridgeDeps) {
|
||||||
res.status(501).json({ error: "Plugin bridge is not enabled" });
|
res.status(501).json({ error: "Plugin bridge is not enabled" });
|
||||||
@@ -1217,8 +1260,8 @@ export function pluginRoutes(
|
|||||||
"performAction",
|
"performAction",
|
||||||
{
|
{
|
||||||
key: body.key,
|
key: body.key,
|
||||||
...(companyId ? { companyId } : {}),
|
params: actionParamsWithAuthorizedCompanyScope(body.params, companyId),
|
||||||
params: body.params ?? {},
|
actorContext: performActionActorContext(req, companyId),
|
||||||
renderEnvironment: body.renderEnvironment ?? null,
|
renderEnvironment: body.renderEnvironment ?? null,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -1355,7 +1398,7 @@ export function pluginRoutes(
|
|||||||
* @see PLUGIN_SPEC.md §19.7 — Error Propagation Through The Bridge
|
* @see PLUGIN_SPEC.md §19.7 — Error Propagation Through The Bridge
|
||||||
*/
|
*/
|
||||||
router.post("/plugins/:pluginId/actions/:key", async (req, res) => {
|
router.post("/plugins/:pluginId/actions/:key", async (req, res) => {
|
||||||
assertBoardOrgAccess(req);
|
assertAuthenticated(req);
|
||||||
|
|
||||||
if (!bridgeDeps) {
|
if (!bridgeDeps) {
|
||||||
res.status(501).json({ error: "Plugin bridge is not enabled" });
|
res.status(501).json({ error: "Plugin bridge is not enabled" });
|
||||||
@@ -1401,8 +1444,8 @@ export function pluginRoutes(
|
|||||||
"performAction",
|
"performAction",
|
||||||
{
|
{
|
||||||
key,
|
key,
|
||||||
...(companyId ? { companyId } : {}),
|
params: actionParamsWithAuthorizedCompanyScope(body?.params, companyId),
|
||||||
params: body?.params ?? {},
|
actorContext: performActionActorContext(req, companyId),
|
||||||
renderEnvironment: body?.renderEnvironment ?? null,
|
renderEnvironment: body?.renderEnvironment ?? null,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -1606,7 +1649,10 @@ export function pluginRoutes(
|
|||||||
} catch (err) {
|
} catch (err) {
|
||||||
const status = typeof (err as { status?: unknown }).status === "number"
|
const status = typeof (err as { status?: unknown }).status === "number"
|
||||||
? (err as { status: number }).status
|
? (err as { status: number }).status
|
||||||
: err instanceof JsonRpcCallError && err.code === PLUGIN_RPC_ERROR_CODES.CAPABILITY_DENIED
|
: err instanceof JsonRpcCallError && (
|
||||||
|
err.code === PLUGIN_RPC_ERROR_CODES.CAPABILITY_DENIED ||
|
||||||
|
err.code === PLUGIN_RPC_ERROR_CODES.INVOCATION_SCOPE_DENIED
|
||||||
|
)
|
||||||
? 403
|
? 403
|
||||||
: err instanceof JsonRpcCallError && err.code === PLUGIN_RPC_ERROR_CODES.METHOD_NOT_IMPLEMENTED
|
: err instanceof JsonRpcCallError && err.code === PLUGIN_RPC_ERROR_CODES.METHOD_NOT_IMPLEMENTED
|
||||||
? 501
|
? 501
|
||||||
|
|||||||
@@ -683,14 +683,25 @@ function inboxVisibleForUserCondition(companyId: string, userId: string) {
|
|||||||
`;
|
`;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const LEGACY_PLUGIN_OPERATION_ORIGIN_KINDS = [
|
||||||
|
"plugin:paperclipai.content-machine:case",
|
||||||
|
"plugin:paperclipai.content-machine:evaluation",
|
||||||
|
"plugin:paperclipai.content-machine:source-sync",
|
||||||
|
] as const;
|
||||||
|
|
||||||
function nonPluginOperationIssueCondition() {
|
function nonPluginOperationIssueCondition() {
|
||||||
return sql<boolean>`NOT (${issues.originKind} LIKE 'plugin:%:operation' OR ${issues.originKind} LIKE 'plugin:%:operation:%')`;
|
return sql<boolean>`NOT (
|
||||||
|
${issues.originKind} LIKE 'plugin:%:operation'
|
||||||
|
OR ${issues.originKind} LIKE 'plugin:%:operation:%'
|
||||||
|
OR ${inArray(issues.originKind, LEGACY_PLUGIN_OPERATION_ORIGIN_KINDS)}
|
||||||
|
)`;
|
||||||
}
|
}
|
||||||
|
|
||||||
function shouldIncludePluginOperationIssues(filters: IssueFilters | undefined) {
|
function shouldIncludePluginOperationIssues(filters: IssueFilters | undefined) {
|
||||||
return Boolean(
|
return Boolean(
|
||||||
filters?.includePluginOperations ||
|
filters?.includePluginOperations ||
|
||||||
filters?.originKind ||
|
filters?.originKind ||
|
||||||
|
filters?.originKindPrefix ||
|
||||||
filters?.originId ||
|
filters?.originId ||
|
||||||
filters?.projectId,
|
filters?.projectId,
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -204,6 +204,8 @@ interface PendingRequest {
|
|||||||
timer: ReturnType<typeof setTimeout>;
|
timer: ReturnType<typeof setTimeout>;
|
||||||
/** Timestamp when the request was sent. */
|
/** Timestamp when the request was sent. */
|
||||||
sentAt: number;
|
sentAt: number;
|
||||||
|
/** Active host-owned invocation id attached to this host→worker call. */
|
||||||
|
invocationId?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
interface ActiveInvocation {
|
interface ActiveInvocation {
|
||||||
@@ -435,6 +437,14 @@ export function createPluginWorkerHandle(
|
|||||||
childProcess.stdin.write(serialized);
|
childProcess.stdin.write(serialized);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function errorCodeForWorkerHostError(err: unknown): number {
|
||||||
|
const code = (err as { code?: unknown } | null)?.code;
|
||||||
|
const pluginErrorCodes: readonly number[] = Object.values(PLUGIN_RPC_ERROR_CODES);
|
||||||
|
return typeof code === "number" && pluginErrorCodes.includes(code)
|
||||||
|
? code
|
||||||
|
: JSONRPC_ERROR_CODES.INTERNAL_ERROR;
|
||||||
|
}
|
||||||
|
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
// Incoming message handling
|
// Incoming message handling
|
||||||
// -----------------------------------------------------------------------
|
// -----------------------------------------------------------------------
|
||||||
@@ -503,6 +513,11 @@ export function createPluginWorkerHandle(
|
|||||||
const directCompanyId = readNonEmptyString(params.companyId);
|
const directCompanyId = readNonEmptyString(params.companyId);
|
||||||
if (directCompanyId) return { companyId: directCompanyId };
|
if (directCompanyId) return { companyId: directCompanyId };
|
||||||
|
|
||||||
|
if (method === "performAction" && isRecord(params.actorContext)) {
|
||||||
|
const companyId = readNonEmptyString(params.actorContext.companyId);
|
||||||
|
return companyId ? { companyId } : null;
|
||||||
|
}
|
||||||
|
|
||||||
if (method === "executeTool" && isRecord(params.runContext)) {
|
if (method === "executeTool" && isRecord(params.runContext)) {
|
||||||
const companyId = readNonEmptyString(params.runContext.companyId);
|
const companyId = readNonEmptyString(params.runContext.companyId);
|
||||||
return companyId ? { companyId } : null;
|
return companyId ? { companyId } : null;
|
||||||
@@ -585,15 +600,12 @@ export function createPluginWorkerHandle(
|
|||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
const errorMessage = err instanceof Error ? err.message : String(err);
|
const errorMessage = err instanceof Error ? err.message : String(err);
|
||||||
const errorCode = typeof (err as { code?: unknown }).code === "number"
|
|
||||||
? (err as { code: number }).code
|
|
||||||
: JSONRPC_ERROR_CODES.INTERNAL_ERROR;
|
|
||||||
log.error({ method, err: errorMessage }, "host handler error");
|
log.error({ method, err: errorMessage }, "host handler error");
|
||||||
try {
|
try {
|
||||||
sendMessage(
|
sendMessage(
|
||||||
createErrorResponse(
|
createErrorResponse(
|
||||||
request.id,
|
request.id,
|
||||||
errorCode,
|
errorCodeForWorkerHostError(err),
|
||||||
errorMessage,
|
errorMessage,
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
@@ -1161,6 +1173,7 @@ export function createPluginWorkerHandle(
|
|||||||
},
|
},
|
||||||
timer,
|
timer,
|
||||||
sentAt: Date.now(),
|
sentAt: Date.now(),
|
||||||
|
invocationId: invocation?.id,
|
||||||
};
|
};
|
||||||
|
|
||||||
pendingRequests.set(id, pending);
|
pendingRequests.set(id, pending);
|
||||||
|
|||||||
Reference in New Issue
Block a user