File size: 9,495 Bytes
4c76b0d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | import fs from "node:fs/promises";
import { createServer, type ServerResponse } from "node:http";
import path from "node:path";
import { describe, expect, it } from "vitest";
import {
writeOpenAiResponsesSse,
writeOpenAiResponsesText,
} from "../../../test/helpers/openai-responses-sse.js";
import { createDeferred, withTestTimeout } from "../../../test/helpers/promise.js";
import { createDefaultDeps } from "../../cli/deps.js";
import { loadSessionEntry } from "../../config/sessions/session-accessor.js";
import type { OpenClawConfig } from "../../config/types.openclaw.js";
import { withLocalGatewayRequestScope } from "../../gateway/local-request-context.js";
import { buildMockOpenAiResponsesProvider } from "../../gateway/test-openai-responses-model.js";
import { hasErrnoCode } from "../../infra/errno.js";
import { withOpenClawTestState } from "../../test-utils/openclaw-test-state.js";
import { createRuntimeAgent } from "./runtime-agent.js";
const sessionKey = "agent:main:discord:channel:ingress-proof";
const label = "Voice owner admitted";
const fileName = "voice-ingress.txt";
const fileContent = "Voice tool execution reached the workspace.";
function writeToolCalls(response: ServerResponse): void {
const calls = [
{ name: "sessions", arguments: { action: "patch", label } },
{ name: "write", arguments: { path: fileName, content: fileContent } },
].map((call, index) => ({
type: "function_call",
id: `fc_voice_${index}`,
call_id: `call_voice_${index}`,
name: call.name,
arguments: JSON.stringify(call.arguments),
}));
writeOpenAiResponsesSse(response, [
{
type: "response.created",
response: { id: "response_voice_tools", status: "in_progress", output: [] },
},
...calls.flatMap((item, output_index) => [
{ type: "response.output_item.added", output_index, item: { ...item, arguments: "" } },
{
type: "response.function_call_arguments.delta",
item_id: item.id,
output_index,
delta: item.arguments,
},
{ type: "response.output_item.done", output_index, item },
]),
{
type: "response.completed",
response: {
id: "response_voice_tools",
status: "completed",
output: calls,
usage: { input_tokens: 8, output_tokens: 8, total_tokens: 16 },
},
},
]);
}
async function withIngressFixture(
options: { senderIsOwner: boolean; toolsAllow: string[]; cancel?: boolean },
assertEffects: (effects: {
storedLabel: string | undefined;
file: string | undefined;
toolResults: string;
}) => void,
): Promise<void> {
await withOpenClawTestState(
{
label: "runtime-agent-ingress",
env: { OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1", OPENCLAW_SKIP_PROVIDERS: undefined },
},
async (state) => {
const received = createDeferred<ServerResponse>();
void received.promise.catch(() => {});
const cancelled = createDeferred();
const controller = new AbortController();
let toolResults = "";
let turn: Promise<unknown> | undefined;
const server = createServer((request, response) => {
void (async () => {
if (request.method === "GET" && request.url === "/v1/models") {
response.writeHead(200, { "content-type": "application/json" });
response.end(JSON.stringify({ data: [{ id: "voice-ingress", object: "model" }] }));
return;
}
if (request.method !== "POST" || request.url !== "/v1/responses") {
response.writeHead(404).end();
return;
}
const chunks: Buffer[] = [];
for await (const chunk of request) {
chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
}
const body = Buffer.concat(chunks).toString("utf8");
if (body.includes("function_call_output")) {
toolResults = body;
writeOpenAiResponsesText(response, {
text: "Voice turn finished.",
responseId: "response_voice_done",
messageId: "message_voice_done",
});
return;
}
if (options.cancel) {
response.once("close", () => {
if (!response.writableFinished) {
cancelled.resolve();
}
});
received.resolve(response);
return;
}
writeToolCalls(response);
})().catch((error: unknown) => {
received.reject(error);
response.destroy(error instanceof Error ? error : new Error(String(error)));
});
});
try {
await new Promise<void>((resolve, reject) => {
server.once("error", reject);
server.listen(0, "127.0.0.1", resolve);
});
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Voice ingress provider did not bind a loopback port");
}
const provider = buildMockOpenAiResponsesProvider(
`http://127.0.0.1:${address.port}/v1`,
"voice-ingress",
);
const cfg: OpenClawConfig = {
plugins: { enabled: false },
agents: {
entries: { main: { workspace: state.workspaceDir } },
defaults: {
model: { primary: provider.modelRef, fallbacks: [] },
models: { [provider.modelRef]: { agentRuntime: { id: "openclaw" } } },
skills: [],
skipBootstrap: true,
heartbeat: { every: "0m" },
},
},
tools: { allow: ["sessions", "write", "read"], codeMode: { enabled: false } },
models: {
mode: "replace",
providers: {
[provider.providerId]: {
...provider.config,
request: { allowPrivateNetwork: true },
},
},
},
};
await state.writeConfig(cfg);
turn = withLocalGatewayRequestScope(
{ deps: createDefaultDeps(), getRuntimeConfig: () => cfg },
() =>
createRuntimeAgent().runCommandFromIngress(
{
agentId: "main",
sessionKey,
message: "Update this session label and write the requested workspace file.",
messageChannel: "discord",
senderIsOwner: options.senderIsOwner,
toolsAllow: options.toolsAllow,
abortSignal: controller.signal,
allowModelOverride: false,
deliver: false,
timeout: "30",
},
{
log: () => {},
error: () => {},
exit: (code) => {
throw new Error(`Agent attempted to exit with code ${code}`);
},
},
),
);
if (options.cancel) {
const response = await Promise.race([
received.promise,
turn.then(() => {
throw new Error("Agent completed before the provider received the turn");
}),
]);
controller.abort(new Error("Voice participant left the room"));
await withTestTimeout(
Promise.all([Promise.allSettled([turn]), cancelled.promise]),
5_000,
"Ingress did not cancel the agent and provider request",
);
// Late provider output must never revive the cancelled run's tool authority.
writeToolCalls(response);
} else {
await turn;
expect(toolResults).toContain("function_call_output");
}
const file = await fs
.readFile(path.join(state.workspaceDir, fileName), "utf8")
.catch((error: unknown) => {
if (!hasErrnoCode(error, "ENOENT")) {
throw error;
}
return undefined;
});
assertEffects({
storedLabel: loadSessionEntry({ agentId: "main", sessionKey })?.label,
file,
toolResults,
});
} finally {
controller.abort();
server.closeAllConnections();
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
await Promise.allSettled(turn ? [turn] : []);
}
},
);
}
describe("host runtime ingress agent effects", () => {
it.each([
{ name: "owner", senderIsOwner: true, toolsAllow: ["sessions", "write"], canPatch: true },
{ name: "guest", senderIsOwner: false, toolsAllow: ["sessions", "write"], canPatch: false },
{ name: "restricted owner", senderIsOwner: true, toolsAllow: ["write"], canPatch: false },
])("enforces $name authority in the real tool loop", { timeout: 90_000 }, async (scenario) => {
await withIngressFixture(scenario, ({ storedLabel, file }) => {
expect(storedLabel).toBe(scenario.canPatch ? label : undefined);
expect(file).toBe(fileContent);
});
});
it(
"cancels before tool I/O and discards late provider tool calls",
{ timeout: 90_000 },
async () => {
await withIngressFixture(
{ senderIsOwner: true, toolsAllow: ["sessions", "write"], cancel: true },
({ storedLabel, file, toolResults }) => {
expect(storedLabel).toBeUndefined();
expect(file).toBeUndefined();
expect(toolResults).toBe("");
},
);
},
);
});
|