mirror of
https://github.com/grp06/openclaw-studio.git
synced 2026-08-14 00:47:51 +00:00
Centralize OpenClaw agent id validation in a new module (src/lib/agents/agentIds.ts) and route every gateway, cron, ssh, and intent path through it. Tighten the safe-id regex to match the gateway's 64-char normalization and reserve "main" from UI creation. Add symlink-aware boundary checks and move rollback to trash/restoreAgentStateLocally and the SSH equivalent so a failed move never leaves the filesystem half-migrated, and restore refuses symlinks that escape stateDir. Validate session keys (hasMalformedAgentSessionKey, sessionKeyBelongsToAgent) and cron job fields before trusting gateway output, and compare cron agent ids case-insensitively. Refactor applyGatewayConfigPatch and exec-approvals retry to fetch the snapshot inside the retry callback, eliminating a stale-baseHash race. Harden the control-plane adapter: stop() now waits on in-flight start, times out hung sockets, and ignores stale ws event handlers via a connection epoch. Close a WebSocket upgrade auth bypass in server/index.js by routing upgrades through accessGate.allowUpgrade, make access-gate cookie values URL-safe and stop reconstructing redirect URLs from Host headers, and apply the access gate to all non-token requests rather than only /api/. Read media via realpath + boundary re-check, enforce MAX_MEDIA_BYTES on remote SSH responses, and whitelist response MIME types. Clean up SSE streams on client abort. Normalize localhost gateway URLs in studio-settings so token hints only apply when the draft URL matches, and write settings atomically. Make the Playwright port configurable (PLAYWRIGHT_PORT, default 3100) to avoid colliding with the running dev server, and ignore .worktrees in eslint. Add unit tests for the new agentIds module, gateway connect profile, disconnect-like errors, local gateway, and studio settings store, and extend existing tests to cover the new validation, rollback, retry, and normalization paths.
350 lines
11 KiB
TypeScript
350 lines
11 KiB
TypeScript
import { describe, expect, it, vi } from "vitest";
|
|
|
|
import type { AgentState } from "@/features/agents/state/store";
|
|
import type { PendingExecApproval } from "@/features/agents/approvals/types";
|
|
import { createRuntimeWriteTransport } from "@/features/agents/operations/runtimeWriteTransport";
|
|
import { GatewayResponseError } from "@/lib/gateway/errors";
|
|
import { resolveExecApprovalViaStudio } from "@/features/agents/approvals/execApprovalResolveOperation";
|
|
|
|
type SetState<T> = (next: T | ((current: T) => T)) => void;
|
|
|
|
const createState = <T,>(initial: T): { get: () => T; set: SetState<T> } => {
|
|
let value = initial;
|
|
return {
|
|
get: () => value,
|
|
set: (next) => {
|
|
value = typeof next === "function" ? (next as (current: T) => T)(value) : next;
|
|
},
|
|
};
|
|
};
|
|
|
|
describe("execApprovalResolveOperation", () => {
|
|
it("removes approval and refreshes history after allow-once", async () => {
|
|
const call = vi.fn(async (method: string) => {
|
|
if (method === "exec.approval.resolve") {
|
|
return { ok: true };
|
|
}
|
|
if (method === "agent.wait") {
|
|
return { status: "ok" };
|
|
}
|
|
throw new Error(`unexpected method ${method}`);
|
|
});
|
|
|
|
const approval: PendingExecApproval = {
|
|
id: "appr-1",
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
command: "echo hi",
|
|
cwd: null,
|
|
host: null,
|
|
security: null,
|
|
ask: null,
|
|
resolvedPath: null,
|
|
createdAtMs: Date.now(),
|
|
expiresAtMs: Date.now() + 60_000,
|
|
resolving: false,
|
|
error: null,
|
|
};
|
|
|
|
const agent = {
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
sessionCreated: true,
|
|
status: "running",
|
|
runId: "run-1",
|
|
} as unknown as AgentState;
|
|
|
|
const approvalsByAgentId = createState<Record<string, PendingExecApproval[]>>({
|
|
a1: [approval],
|
|
});
|
|
const unscopedApprovals = createState<PendingExecApproval[]>([]);
|
|
const requestHistoryRefresh = vi.fn();
|
|
const onAllowResolved = vi.fn();
|
|
const onAllowed = vi.fn();
|
|
|
|
await resolveExecApprovalViaStudio({
|
|
runtimeWriteTransport: createRuntimeWriteTransport({
|
|
client: { call } as never,
|
|
useDomainIntents: false,
|
|
}),
|
|
approvalId: "appr-1",
|
|
decision: "allow-once",
|
|
getAgents: () => [agent],
|
|
getLatestAgent: () => agent,
|
|
getPendingState: () => ({
|
|
approvalsByAgentId: approvalsByAgentId.get(),
|
|
unscopedApprovals: unscopedApprovals.get(),
|
|
}),
|
|
setPendingExecApprovalsByAgentId: approvalsByAgentId.set,
|
|
setUnscopedPendingExecApprovals: unscopedApprovals.set,
|
|
requestHistoryRefresh,
|
|
onAllowResolved,
|
|
onAllowed,
|
|
isDisconnectLikeError: () => false,
|
|
});
|
|
|
|
expect(call).toHaveBeenCalledWith("exec.approval.resolve", { id: "appr-1", decision: "allow-once" });
|
|
expect(call).toHaveBeenCalledWith("agent.wait", { runId: "run-1", timeoutMs: 15_000 });
|
|
|
|
expect(approvalsByAgentId.get()).toEqual({});
|
|
expect(unscopedApprovals.get()).toEqual([]);
|
|
expect(onAllowResolved).toHaveBeenCalledWith({ approval, targetAgentId: "a1" });
|
|
expect(requestHistoryRefresh).toHaveBeenCalledWith("a1");
|
|
expect(onAllowed).toHaveBeenCalledWith({ approval, targetAgentId: "a1" });
|
|
expect(onAllowResolved.mock.invocationCallOrder[0]).toBeLessThan(
|
|
requestHistoryRefresh.mock.invocationCallOrder[0]
|
|
);
|
|
});
|
|
|
|
it("treats unknown approval id as already removed", async () => {
|
|
const call = vi.fn(async (method: string) => {
|
|
if (method === "exec.approval.resolve") {
|
|
throw new GatewayResponseError({
|
|
code: "NOT_FOUND",
|
|
message: "unknown approval id appr-1",
|
|
});
|
|
}
|
|
throw new Error(`unexpected method ${method}`);
|
|
});
|
|
|
|
const approval: PendingExecApproval = {
|
|
id: "appr-1",
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
command: "echo hi",
|
|
cwd: null,
|
|
host: null,
|
|
security: null,
|
|
ask: null,
|
|
resolvedPath: null,
|
|
createdAtMs: Date.now(),
|
|
expiresAtMs: Date.now() + 60_000,
|
|
resolving: false,
|
|
error: null,
|
|
};
|
|
|
|
const agent = {
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
sessionCreated: true,
|
|
status: "running",
|
|
runId: "run-1",
|
|
} as unknown as AgentState;
|
|
|
|
const approvalsByAgentId = createState<Record<string, PendingExecApproval[]>>({
|
|
a1: [approval],
|
|
});
|
|
const unscopedApprovals = createState<PendingExecApproval[]>([]);
|
|
const onAllowed = vi.fn();
|
|
|
|
await resolveExecApprovalViaStudio({
|
|
runtimeWriteTransport: createRuntimeWriteTransport({
|
|
client: { call } as never,
|
|
useDomainIntents: false,
|
|
}),
|
|
approvalId: "appr-1",
|
|
decision: "allow-once",
|
|
getAgents: () => [agent],
|
|
getLatestAgent: () => agent,
|
|
getPendingState: () => ({
|
|
approvalsByAgentId: approvalsByAgentId.get(),
|
|
unscopedApprovals: unscopedApprovals.get(),
|
|
}),
|
|
setPendingExecApprovalsByAgentId: approvalsByAgentId.set,
|
|
setUnscopedPendingExecApprovals: unscopedApprovals.set,
|
|
requestHistoryRefresh: vi.fn(),
|
|
onAllowed,
|
|
isDisconnectLikeError: () => false,
|
|
});
|
|
|
|
expect(approvalsByAgentId.get()).toEqual({});
|
|
expect(unscopedApprovals.get()).toEqual([]);
|
|
expect(onAllowed).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("does not trigger onAllowed for deny decisions", async () => {
|
|
const call = vi.fn(async (method: string) => {
|
|
if (method === "exec.approval.resolve") {
|
|
return { ok: true };
|
|
}
|
|
throw new Error(`unexpected method ${method}`);
|
|
});
|
|
|
|
const approval: PendingExecApproval = {
|
|
id: "appr-1",
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
command: "echo hi",
|
|
cwd: null,
|
|
host: null,
|
|
security: null,
|
|
ask: null,
|
|
resolvedPath: null,
|
|
createdAtMs: Date.now(),
|
|
expiresAtMs: Date.now() + 60_000,
|
|
resolving: false,
|
|
error: null,
|
|
};
|
|
|
|
const agent = {
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
sessionCreated: true,
|
|
status: "running",
|
|
runId: "run-1",
|
|
} as unknown as AgentState;
|
|
|
|
const approvalsByAgentId = createState<Record<string, PendingExecApproval[]>>({
|
|
a1: [approval],
|
|
});
|
|
const unscopedApprovals = createState<PendingExecApproval[]>([]);
|
|
const onAllowed = vi.fn();
|
|
|
|
await resolveExecApprovalViaStudio({
|
|
runtimeWriteTransport: createRuntimeWriteTransport({
|
|
client: { call } as never,
|
|
useDomainIntents: false,
|
|
}),
|
|
approvalId: "appr-1",
|
|
decision: "deny",
|
|
getAgents: () => [agent],
|
|
getLatestAgent: () => agent,
|
|
getPendingState: () => ({
|
|
approvalsByAgentId: approvalsByAgentId.get(),
|
|
unscopedApprovals: unscopedApprovals.get(),
|
|
}),
|
|
setPendingExecApprovalsByAgentId: approvalsByAgentId.set,
|
|
setUnscopedPendingExecApprovals: unscopedApprovals.set,
|
|
requestHistoryRefresh: vi.fn(),
|
|
onAllowed,
|
|
isDisconnectLikeError: () => false,
|
|
});
|
|
|
|
expect(onAllowed).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("falls back to a matching safe session when approval agent id is unsafe", async () => {
|
|
const call = vi.fn(async (method: string) => {
|
|
if (method === "exec.approval.resolve") {
|
|
return { ok: true };
|
|
}
|
|
if (method === "agent.wait") {
|
|
return { status: "ok" };
|
|
}
|
|
throw new Error(`unexpected method ${method}`);
|
|
});
|
|
|
|
const approval: PendingExecApproval = {
|
|
id: "appr-1",
|
|
agentId: "../a1",
|
|
sessionKey: "agent:a1:main",
|
|
command: "echo hi",
|
|
cwd: null,
|
|
host: null,
|
|
security: null,
|
|
ask: null,
|
|
resolvedPath: null,
|
|
createdAtMs: Date.now(),
|
|
expiresAtMs: Date.now() + 60_000,
|
|
resolving: false,
|
|
error: null,
|
|
};
|
|
|
|
const agent = {
|
|
agentId: "a1",
|
|
sessionKey: "agent:a1:main",
|
|
sessionCreated: true,
|
|
status: "running",
|
|
runId: "run-1",
|
|
} as unknown as AgentState;
|
|
|
|
const approvalsByAgentId = createState<Record<string, PendingExecApproval[]>>({
|
|
"../a1": [approval],
|
|
});
|
|
const unscopedApprovals = createState<PendingExecApproval[]>([]);
|
|
const requestHistoryRefresh = vi.fn();
|
|
|
|
await resolveExecApprovalViaStudio({
|
|
runtimeWriteTransport: createRuntimeWriteTransport({
|
|
client: { call } as never,
|
|
useDomainIntents: false,
|
|
}),
|
|
approvalId: "appr-1",
|
|
decision: "allow-once",
|
|
getAgents: () => [agent],
|
|
getLatestAgent: () => agent,
|
|
getPendingState: () => ({
|
|
approvalsByAgentId: approvalsByAgentId.get(),
|
|
unscopedApprovals: unscopedApprovals.get(),
|
|
}),
|
|
setPendingExecApprovalsByAgentId: approvalsByAgentId.set,
|
|
setUnscopedPendingExecApprovals: unscopedApprovals.set,
|
|
requestHistoryRefresh,
|
|
isDisconnectLikeError: () => false,
|
|
});
|
|
|
|
expect(requestHistoryRefresh).toHaveBeenCalledWith("a1");
|
|
});
|
|
|
|
it("uses exec-approval-resolve intent in domain mode", async () => {
|
|
const call = vi.fn(async (method: string) => {
|
|
if (method === "exec.approval.resolve") {
|
|
throw new Error("exec.approval.resolve should not be called in domain mode");
|
|
}
|
|
return { ok: true };
|
|
});
|
|
const fetchMock = vi.fn(async () =>
|
|
new Response(JSON.stringify({ ok: true, payload: { ok: true } }), {
|
|
status: 200,
|
|
headers: { "Content-Type": "application/json" },
|
|
})
|
|
);
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
|
|
const approval: PendingExecApproval = {
|
|
id: "appr-1",
|
|
agentId: "a1",
|
|
sessionKey: "sess-1",
|
|
command: "echo hi",
|
|
cwd: null,
|
|
host: null,
|
|
security: null,
|
|
ask: null,
|
|
resolvedPath: null,
|
|
createdAtMs: Date.now(),
|
|
expiresAtMs: Date.now() + 60_000,
|
|
resolving: false,
|
|
error: null,
|
|
};
|
|
|
|
const approvalsByAgentId = createState<Record<string, PendingExecApproval[]>>({ a1: [approval] });
|
|
const unscopedApprovals = createState<PendingExecApproval[]>([]);
|
|
|
|
await resolveExecApprovalViaStudio({
|
|
runtimeWriteTransport: createRuntimeWriteTransport({
|
|
client: { call } as never,
|
|
useDomainIntents: true,
|
|
}),
|
|
approvalId: "appr-1",
|
|
decision: "deny",
|
|
getAgents: () => [],
|
|
getLatestAgent: () => null,
|
|
getPendingState: () => ({
|
|
approvalsByAgentId: approvalsByAgentId.get(),
|
|
unscopedApprovals: unscopedApprovals.get(),
|
|
}),
|
|
setPendingExecApprovalsByAgentId: approvalsByAgentId.set,
|
|
setUnscopedPendingExecApprovals: unscopedApprovals.set,
|
|
requestHistoryRefresh: vi.fn(),
|
|
isDisconnectLikeError: () => false,
|
|
});
|
|
|
|
expect(fetchMock).toHaveBeenCalledWith(
|
|
"/api/intents/exec-approval-resolve",
|
|
expect.objectContaining({ method: "POST" })
|
|
);
|
|
expect(call).not.toHaveBeenCalledWith("exec.approval.resolve", expect.anything());
|
|
vi.unstubAllGlobals();
|
|
});
|
|
});
|