File size: 8,484 Bytes
f778c12 | 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 | import { once } from "node:events";
import fs from "node:fs/promises";
import { afterEach, assert, describe, expect, it, vi } from "vitest";
import { WebSocketServer } from "ws";
import { ensureGatewayReadyForOperation } from "../../commands/gateway-readiness.js";
import {
buildMinimalGatewayHelloOkPayload,
closeMinimalGatewayServer,
parseMinimalGatewayRequestFrame,
sendMinimalGatewayConnectChallenge,
sendMinimalGatewayResponse,
startMinimalRealGateway,
} from "../../gateway/minimal-gateway.test-helpers.js";
import { createOpenClawTestState } from "../../test-utils/openclaw-test-state.js";
import { probeGatewayStatus } from "./probe.js";
import type { DaemonStatus } from "./status.gather.js";
const cleanups: Array<() => Promise<void>> = [];
afterEach(async () => {
for (const cleanup of cleanups.splice(0).toReversed()) {
await cleanup();
}
});
async function checkDashboardReadiness(url: string, rpc: NonNullable<DaemonStatus["rpc"]>) {
const port = Number(new URL(url).port);
const runtime = { log: vi.fn(), error: vi.fn(), exit: vi.fn() };
const confirm = vi.fn();
const startGateway = vi.fn();
const installGateway = vi.fn();
const result = await ensureGatewayReadyForOperation({
runtime,
operation: "open the dashboard",
readyWhenReachable: true,
interactive: true,
deps: {
confirm,
startGateway,
installGateway,
gatherStatus: async () => ({
service: {
label: "synthetic stopped service",
loaded: false,
loadState: { status: "not-loaded" },
loadedText: "loaded",
notLoadedText: "not loaded",
command: null,
runtime: { status: "stopped" },
},
port: { port, status: "busy", listeners: [], hints: [] },
rpc: { ...rpc, url },
extraServices: [],
}),
},
});
expect(confirm).not.toHaveBeenCalled();
expect(startGateway).not.toHaveBeenCalled();
expect(installGateway).not.toHaveBeenCalled();
return { result, output: runtime.log.mock.calls.flat().join("\n") };
}
describe("Gateway reachability over real sockets", () => {
it.each([{}, { token: "service-token" }, { password: "service-password" }])(
"freezes resolved service auth %j without pairing writes",
async (auth) => {
const state = await createOpenClawTestState({
env: {
OPENCLAW_GATEWAY_TOKEN: "ambient-token",
OPENCLAW_GATEWAY_PASSWORD: "ambient-password",
},
});
cleanups.push(() => state.cleanup());
const wss = new WebSocketServer({ host: "127.0.0.1", port: 0 });
cleanups.push(() => closeMinimalGatewayServer(wss));
let connectAuth: unknown;
wss.on("connection", (ws) => {
sendMinimalGatewayConnectChallenge(ws);
ws.on("message", (data) => {
const frame = parseMinimalGatewayRequestFrame(data);
if (frame.method === "connect") {
connectAuth = frame.params?.auth;
sendMinimalGatewayResponse(
ws,
frame.id!,
buildMinimalGatewayHelloOkPayload({
methods: ["status"],
auth: { role: "operator", scopes: ["operator.read"] },
}),
);
} else {
sendMinimalGatewayResponse(ws, frame.id!, { status: "ok" });
}
});
});
await once(wss, "listening");
const address = wss.address();
assert(address && typeof address !== "string");
const before = await fs.readdir(state.stateDir, { recursive: true });
const rpc = await probeGatewayStatus({
url: `ws://127.0.0.1:${address.port}`,
...auth,
config: {
gateway: {
mode: "local",
auth: { mode: "none", token: "config-token" },
remote: { token: "remote-token", password: "remote-password" },
},
},
timeoutMs: 2_000,
json: true,
requireRpc: true,
});
expect(rpc, JSON.stringify(rpc)).toMatchObject({ ok: true });
expect(connectAuth ?? {}).toEqual(auth);
expect(await fs.readdir(state.stateDir, { recursive: true })).toEqual(before);
},
);
it.each(["terminate", "policy-close", "silent", "upgrade-rejected"] as const)(
"does not start a second service or accept a %s listener",
async (mode) => {
const state = await createOpenClawTestState();
cleanups.push(() => state.cleanup());
const wss = new WebSocketServer({
host: "127.0.0.1",
port: 0,
...(mode === "upgrade-rejected" ? { verifyClient: () => false } : {}),
});
cleanups.push(() => closeMinimalGatewayServer(wss));
wss.on("connection", (ws) => {
if (mode === "terminate") {
ws.terminate();
} else if (mode === "policy-close") {
ws.close(1008, "pairing required");
}
});
await once(wss, "listening");
const address = wss.address();
if (typeof address === "string" || !address) {
throw new Error("missing test listener address");
}
const url = `ws://127.0.0.1:${address.port}`;
const rpc = await probeGatewayStatus({ url, config: {}, timeoutMs: 400, json: true });
assert(!rpc.ok);
expect(rpc.gatewayReached).toBeUndefined();
if (mode === "terminate") {
expect(rpc.error).toContain("gateway closed (1006)");
}
const { result, output } = await checkDashboardReadiness(url, rpc);
expect(result).toMatchObject({ ready: false, recoverable: false });
expect(output).toContain("Gateway probe failed:");
expect(output).not.toContain("Gateway is not running");
expect(output).not.toContain("gateway start");
},
);
it("preserves the accepted handshake when a subsequent status RPC fails", async () => {
const state = await createOpenClawTestState();
cleanups.push(() => state.cleanup());
const wss = new WebSocketServer({ host: "127.0.0.1", port: 0 });
cleanups.push(() => closeMinimalGatewayServer(wss));
wss.on("connection", (ws) => {
sendMinimalGatewayConnectChallenge(ws);
ws.on("message", (data) => {
const frame = parseMinimalGatewayRequestFrame(data);
if (frame.method === "connect") {
sendMinimalGatewayResponse(
ws,
frame.id!,
buildMinimalGatewayHelloOkPayload({
methods: ["status"],
auth: { role: "operator", scopes: ["operator.read"] },
}),
);
} else {
ws.send(
JSON.stringify({
type: "res",
id: frame.id,
ok: false,
error: { code: "UNAVAILABLE", message: "synthetic status failure" },
}),
);
}
});
});
await once(wss, "listening");
const address = wss.address();
if (typeof address === "string" || !address) {
throw new Error("missing test listener address");
}
const url = `ws://127.0.0.1:${address.port}`;
const rpc = await probeGatewayStatus({
url,
urlOverride: url,
token: "synthetic-token",
config: {},
timeoutMs: 2_000,
json: true,
requireRpc: true,
});
expect(rpc).toMatchObject({
ok: false,
gatewayReached: true,
error: "synthetic status failure",
capability: "read_only",
server: { version: "test", connId: "conn-test" },
});
expect((await checkDashboardReadiness(url, rpc)).result.ready).toBe(true);
});
it("accepts a real Gateway auth rejection as reachable without starting another service", async () => {
const gateway = await startMinimalRealGateway();
cleanups.push(() => gateway.close());
const rejected = await probeGatewayStatus({
url: gateway.url,
token: "synthetic-wrong-token",
config: {},
timeoutMs: 5_000,
json: true,
});
expect(rejected).toMatchObject({
ok: false,
gatewayReached: true,
connectFailure: { kind: "auth-rejected" },
});
expect((await checkDashboardReadiness(gateway.url, rejected)).result.ready).toBe(true);
const accepted = await probeGatewayStatus({
url: gateway.url,
token: gateway.token,
config: {},
timeoutMs: 5_000,
json: true,
});
expect(accepted.ok).toBe(true);
expect((await checkDashboardReadiness(gateway.url, accepted)).result.ready).toBe(true);
});
});
|