File size: 7,283 Bytes
5cb63c1 | 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 | import { EventEmitter } from "node:events";
import type { IncomingMessage } from "node:http";
import { describe, expect, it, vi } from "vitest";
import { GATEWAY_SERVER_CAPS } from "../../../packages/gateway-protocol/src/server-capabilities.js";
import { PROTOCOL_VERSION } from "../../../packages/gateway-protocol/src/version.js";
import { withOpenClawTestState } from "../../test-utils/openclaw-test-state.js";
import { GatewayConnectionWork } from "../server-connection-work.js";
import type { GatewayConnectionTransport } from "./connection-transport.js";
import { attachGatewayConnection } from "./connection.js";
import {
createGatewayWsTestLogger,
createGatewayWsTestRequestContext,
} from "./ws-connection.test-helpers.js";
import type { GatewayWsClient } from "./ws-types.js";
describe("Gateway connection transport", () => {
it.each(["written", "failed"] as const)(
"owns admission and cleanup without WebSocket internals (hello %s)",
async (delivery) => {
await withOpenClawTestState(
{ label: "gateway-connection-transport", layout: "state-only" },
async () => {
const incoming = new EventEmitter();
const frames: Array<{
event?: string;
ok?: boolean;
payload?: { type?: string; capabilities?: string[] };
}> = [];
const clients = new Set<GatewayWsClient>();
const connectionWork = new GatewayConnectionWork();
let readyState = 1;
let finishHello: ((error?: Error) => void) | undefined;
const socket: GatewayConnectionTransport = {
get readyState() {
return readyState;
},
bufferedAmount: 0,
send: (encoded, callback) => {
const frame = JSON.parse(encoded);
frames.push(frame);
if (frame.payload?.type === "hello-ok") {
finishHello = callback;
} else {
callback?.();
}
},
close: (code = 1000, reason = "") => {
if (readyState === 3) {
return;
}
readyState = 3;
const pending = finishHello;
finishHello = undefined;
pending?.(new Error("transport closed"));
incoming.emit("close", code, Buffer.from(reason));
},
terminate: () => socket.close(1006),
on: incoming.on.bind(incoming),
off: incoming.off.bind(incoming),
once: incoming.once.bind(incoming),
};
const releasePreauth = vi.fn();
const refreshHealthSnapshot = vi.fn(async () => ({}) as never);
const activateReceive = vi.fn(() => expect(clients.size).toBe(1));
const requestContext = {
...createGatewayWsTestRequestContext(),
terminalSessions: { handleDisconnect: vi.fn() },
};
attachGatewayConnection({
socket,
connectionKind: "gateway",
request: { headers: { host: "127.0.0.1:19001" } } as IncomingMessage,
ingressAttribution: {
kind: "direct-local",
clientIp: "127.0.0.1",
rateLimit: { subject: { key: "127.0.0.1" }, resetOnSuccess: true },
},
addresses: { remoteAddr: "127.0.0.1" },
releasePreauth,
clients,
connectionWork,
bootId: "transport-test-boot",
pluginNodeCapabilities: [],
originCheckMetrics: { hostHeaderFallbackAccepted: 0 },
prepareAuthenticatedReceive: () => {
expect(clients.size).toBe(0);
return { ok: true, value: activateReceive };
},
getResolvedAuth: () => ({
mode: "token",
token: "test-token",
allowTailscale: false,
}),
gatewayMethods: [],
events: [],
refreshHealthSnapshot,
logGateway: createGatewayWsTestLogger() as never,
logHealth: createGatewayWsTestLogger() as never,
logWsControl: createGatewayWsTestLogger() as never,
extraHandlers: {},
broadcast: vi.fn(),
buildRequestContext: () => requestContext as never,
});
try {
expect(frames[0]).toMatchObject({
event: "connect.challenge",
payload: {
capabilities: [GATEWAY_SERVER_CAPS.MODEL_CATALOG_SNAPSHOT],
},
});
const connect = (id: string) =>
Buffer.from(
JSON.stringify({
type: "req",
id,
method: "connect",
params: {
minProtocol: PROTOCOL_VERSION,
maxProtocol: PROTOCOL_VERSION,
client: {
id: "gateway-client",
version: "dev",
platform: "test",
mode: "backend",
},
role: "operator",
scopes: [],
auth: { token: "test-token" },
},
}),
);
incoming.emit("message", connect("connect-1"));
incoming.emit("message", connect("connect-2"));
await vi.waitFor(() => expect(finishHello).toBeTypeOf("function"));
expect(clients.size).toBe(1);
expect(activateReceive).toHaveBeenCalledOnce();
expect(releasePreauth).toHaveBeenCalledOnce();
expect(frames.filter((frame) => frame.payload?.type === "hello-ok")).toHaveLength(1);
expect(refreshHealthSnapshot).not.toHaveBeenCalled();
const client = [...clients][0]!;
expect(client.socket).toBe(socket);
expect(client.webSocket).toBeUndefined();
expect(client.connectionSignal?.aborted).toBe(false);
requestContext.unsubscribeAllSessionEvents.mockImplementation(() => {
expect(client.connectionSignal?.aborted).toBe(true);
});
const complete = finishHello!;
finishHello = undefined;
complete(delivery === "failed" ? new Error("write failed") : undefined);
if (delivery === "written") {
await vi.waitFor(() => expect(refreshHealthSnapshot).toHaveBeenCalledOnce());
}
await connectionWork.drain();
expect(clients.size).toBe(0);
expect(client.connectionSignal?.aborted).toBe(true);
expect(releasePreauth).toHaveBeenCalledOnce();
expect(requestContext.unsubscribeAllSessionEvents).toHaveBeenCalledExactlyOnceWith(
client.connId,
);
expect(
requestContext.terminalSessions.handleDisconnect,
).toHaveBeenCalledExactlyOnceWith(client.connId);
if (delivery === "failed") {
expect(refreshHealthSnapshot).not.toHaveBeenCalled();
}
} finally {
socket.terminate();
await connectionWork.drain();
}
},
);
},
);
});
|