310 lines
9.6 KiB
TypeScript
310 lines
9.6 KiB
TypeScript
import type { AddressInfo } from "node:net";
|
|
import fs from "node:fs/promises";
|
|
import { createServer } from "node:http";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
|
|
import { WebSocket } from "ws";
|
|
import { rawDataToString } from "../infra/ws.js";
|
|
import { defaultRuntime } from "../runtime.js";
|
|
import { A2UI_PATH, CANVAS_HOST_PATH, CANVAS_WS_PATH, injectCanvasLiveReload } from "./a2ui.js";
|
|
import { createCanvasHostHandler, startCanvasHost } from "./server.js";
|
|
|
|
const chokidarMockState = vi.hoisted(() => ({
|
|
watchers: [] as Array<{
|
|
on: (event: string, cb: (...args: unknown[]) => void) => unknown;
|
|
close: () => Promise<void>;
|
|
__emit: (event: string, ...args: unknown[]) => void;
|
|
}>,
|
|
}));
|
|
|
|
// Tests: avoid chokidar polling/fsevents; trigger "all" events manually.
|
|
vi.mock("chokidar", () => {
|
|
const createWatcher = () => {
|
|
const handlers = new Map<string, Array<(...args: unknown[]) => void>>();
|
|
const api = {
|
|
on: (event: string, cb: (...args: unknown[]) => void) => {
|
|
const list = handlers.get(event) ?? [];
|
|
list.push(cb);
|
|
handlers.set(event, list);
|
|
return api;
|
|
},
|
|
close: async () => {},
|
|
__emit: (event: string, ...args: unknown[]) => {
|
|
for (const cb of handlers.get(event) ?? []) {
|
|
cb(...args);
|
|
}
|
|
},
|
|
};
|
|
chokidarMockState.watchers.push(api);
|
|
return api;
|
|
};
|
|
|
|
const watch = () => createWatcher();
|
|
return {
|
|
default: { watch },
|
|
watch,
|
|
};
|
|
});
|
|
|
|
describe("canvas host", () => {
|
|
const quietRuntime = {
|
|
...defaultRuntime,
|
|
log: (..._args: Parameters<typeof console.log>) => {},
|
|
};
|
|
let fixtureRoot = "";
|
|
let fixtureCount = 0;
|
|
|
|
const createCaseDir = async () => {
|
|
const dir = path.join(fixtureRoot, `case-${fixtureCount++}`);
|
|
await fs.mkdir(dir, { recursive: true });
|
|
return dir;
|
|
};
|
|
|
|
beforeAll(async () => {
|
|
fixtureRoot = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-canvas-fixtures-"));
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await fs.rm(fixtureRoot, { recursive: true, force: true });
|
|
});
|
|
|
|
it("injects live reload script", () => {
|
|
const out = injectCanvasLiveReload("<html><body>Hello</body></html>");
|
|
expect(out).toContain(CANVAS_WS_PATH);
|
|
expect(out).toContain("location.reload");
|
|
expect(out).toContain("openclawCanvasA2UIAction");
|
|
expect(out).toContain("openclawSendUserAction");
|
|
});
|
|
|
|
it("creates a default index.html when missing", async () => {
|
|
const dir = await createCaseDir();
|
|
|
|
const server = await startCanvasHost({
|
|
runtime: quietRuntime,
|
|
rootDir: dir,
|
|
port: 0,
|
|
listenHost: "127.0.0.1",
|
|
allowInTests: true,
|
|
});
|
|
|
|
try {
|
|
const res = await fetch(`http://127.0.0.1:${server.port}${CANVAS_HOST_PATH}/`);
|
|
const html = await res.text();
|
|
expect(res.status).toBe(200);
|
|
expect(html).toContain("Interactive test page");
|
|
expect(html).toContain("openclawSendUserAction");
|
|
expect(html).toContain(CANVAS_WS_PATH);
|
|
} finally {
|
|
await server.close();
|
|
}
|
|
});
|
|
|
|
it("skips live reload injection when disabled", async () => {
|
|
const dir = await createCaseDir();
|
|
await fs.writeFile(path.join(dir, "index.html"), "<html><body>no-reload</body></html>", "utf8");
|
|
|
|
const server = await startCanvasHost({
|
|
runtime: quietRuntime,
|
|
rootDir: dir,
|
|
port: 0,
|
|
listenHost: "127.0.0.1",
|
|
allowInTests: true,
|
|
liveReload: false,
|
|
});
|
|
|
|
try {
|
|
const res = await fetch(`http://127.0.0.1:${server.port}${CANVAS_HOST_PATH}/`);
|
|
const html = await res.text();
|
|
expect(res.status).toBe(200);
|
|
expect(html).toContain("no-reload");
|
|
expect(html).not.toContain(CANVAS_WS_PATH);
|
|
|
|
const wsRes = await fetch(`http://127.0.0.1:${server.port}${CANVAS_WS_PATH}`);
|
|
expect(wsRes.status).toBe(404);
|
|
} finally {
|
|
await server.close();
|
|
}
|
|
});
|
|
|
|
it("serves canvas content from the mounted base path and reuses handlers without double close", async () => {
|
|
const dir = await createCaseDir();
|
|
await fs.writeFile(path.join(dir, "index.html"), "<html><body>v1</body></html>", "utf8");
|
|
|
|
const handler = await createCanvasHostHandler({
|
|
runtime: quietRuntime,
|
|
rootDir: dir,
|
|
basePath: CANVAS_HOST_PATH,
|
|
allowInTests: true,
|
|
});
|
|
|
|
const server = createServer((req, res) => {
|
|
void (async () => {
|
|
if (await handler.handleHttpRequest(req, res)) {
|
|
return;
|
|
}
|
|
res.statusCode = 404;
|
|
res.setHeader("Content-Type", "text/plain; charset=utf-8");
|
|
res.end("Not Found");
|
|
})();
|
|
});
|
|
server.on("upgrade", (req, socket, head) => {
|
|
if (handler.handleUpgrade(req, socket, head)) {
|
|
return;
|
|
}
|
|
socket.destroy();
|
|
});
|
|
|
|
await new Promise<void>((resolve) => server.listen(0, "127.0.0.1", resolve));
|
|
const port = (server.address() as AddressInfo).port;
|
|
|
|
try {
|
|
const res = await fetch(`http://127.0.0.1:${port}${CANVAS_HOST_PATH}/`);
|
|
const html = await res.text();
|
|
expect(res.status).toBe(200);
|
|
expect(html).toContain("v1");
|
|
expect(html).toContain(CANVAS_WS_PATH);
|
|
|
|
const miss = await fetch(`http://127.0.0.1:${port}/`);
|
|
expect(miss.status).toBe(404);
|
|
} finally {
|
|
await new Promise<void>((resolve, reject) =>
|
|
server.close((err) => (err ? reject(err) : resolve())),
|
|
);
|
|
}
|
|
const originalClose = handler.close;
|
|
const closeSpy = vi.fn(async () => originalClose());
|
|
handler.close = closeSpy;
|
|
|
|
const hosted = await startCanvasHost({
|
|
runtime: quietRuntime,
|
|
handler,
|
|
ownsHandler: false,
|
|
port: 0,
|
|
listenHost: "127.0.0.1",
|
|
allowInTests: true,
|
|
});
|
|
|
|
try {
|
|
expect(hosted.port).toBeGreaterThan(0);
|
|
} finally {
|
|
await hosted.close();
|
|
expect(closeSpy).not.toHaveBeenCalled();
|
|
await originalClose();
|
|
}
|
|
});
|
|
|
|
it("serves HTML with injection and broadcasts reload on file changes", async () => {
|
|
const dir = await createCaseDir();
|
|
const index = path.join(dir, "index.html");
|
|
await fs.writeFile(index, "<html><body>v1</body></html>", "utf8");
|
|
|
|
const watcherStart = chokidarMockState.watchers.length;
|
|
const server = await startCanvasHost({
|
|
runtime: quietRuntime,
|
|
rootDir: dir,
|
|
port: 0,
|
|
listenHost: "127.0.0.1",
|
|
allowInTests: true,
|
|
});
|
|
|
|
try {
|
|
const watcher = chokidarMockState.watchers[watcherStart];
|
|
expect(watcher).toBeTruthy();
|
|
|
|
const res = await fetch(`http://127.0.0.1:${server.port}${CANVAS_HOST_PATH}/`);
|
|
const html = await res.text();
|
|
expect(res.status).toBe(200);
|
|
expect(html).toContain("v1");
|
|
expect(html).toContain(CANVAS_WS_PATH);
|
|
|
|
const ws = new WebSocket(`ws://127.0.0.1:${server.port}${CANVAS_WS_PATH}`);
|
|
await new Promise<void>((resolve, reject) => {
|
|
const timer = setTimeout(() => reject(new Error("ws open timeout")), 5000);
|
|
ws.on("open", () => {
|
|
clearTimeout(timer);
|
|
resolve();
|
|
});
|
|
ws.on("error", (err) => {
|
|
clearTimeout(timer);
|
|
reject(err);
|
|
});
|
|
});
|
|
|
|
const msg = new Promise<string>((resolve, reject) => {
|
|
const timer = setTimeout(() => reject(new Error("reload timeout")), 10_000);
|
|
ws.on("message", (data) => {
|
|
clearTimeout(timer);
|
|
resolve(rawDataToString(data));
|
|
});
|
|
});
|
|
|
|
await fs.writeFile(index, "<html><body>v2</body></html>", "utf8");
|
|
watcher.__emit("all", "change", index);
|
|
expect(await msg).toBe("reload");
|
|
ws.close();
|
|
} finally {
|
|
await server.close();
|
|
}
|
|
}, 20_000);
|
|
|
|
it("serves A2UI scaffold and blocks traversal/symlink escapes", async () => {
|
|
const dir = await createCaseDir();
|
|
const a2uiRoot = path.resolve(process.cwd(), "src/canvas-host/a2ui");
|
|
const bundlePath = path.join(a2uiRoot, "a2ui.bundle.js");
|
|
const linkName = `test-link-${Date.now()}-${Math.random().toString(16).slice(2)}.txt`;
|
|
const linkPath = path.join(a2uiRoot, linkName);
|
|
let createdBundle = false;
|
|
let createdLink = false;
|
|
|
|
try {
|
|
await fs.stat(bundlePath);
|
|
} catch {
|
|
await fs.writeFile(bundlePath, "window.openclawA2UI = {};", "utf8");
|
|
createdBundle = true;
|
|
}
|
|
|
|
await fs.symlink(path.join(process.cwd(), "package.json"), linkPath);
|
|
createdLink = true;
|
|
|
|
const server = await startCanvasHost({
|
|
runtime: quietRuntime,
|
|
rootDir: dir,
|
|
port: 0,
|
|
listenHost: "127.0.0.1",
|
|
allowInTests: true,
|
|
});
|
|
|
|
try {
|
|
const res = await fetch(`http://127.0.0.1:${server.port}/__openclaw__/a2ui/`);
|
|
const html = await res.text();
|
|
expect(res.status).toBe(200);
|
|
expect(html).toContain("openclaw-a2ui-host");
|
|
expect(html).toContain("openclawCanvasA2UIAction");
|
|
|
|
const bundleRes = await fetch(
|
|
`http://127.0.0.1:${server.port}/__openclaw__/a2ui/a2ui.bundle.js`,
|
|
);
|
|
const js = await bundleRes.text();
|
|
expect(bundleRes.status).toBe(200);
|
|
expect(js).toContain("openclawA2UI");
|
|
const traversalRes = await fetch(
|
|
`http://127.0.0.1:${server.port}${A2UI_PATH}/%2e%2e%2fpackage.json`,
|
|
);
|
|
expect(traversalRes.status).toBe(404);
|
|
expect(await traversalRes.text()).toBe("not found");
|
|
const symlinkRes = await fetch(`http://127.0.0.1:${server.port}${A2UI_PATH}/${linkName}`);
|
|
expect(symlinkRes.status).toBe(404);
|
|
expect(await symlinkRes.text()).toBe("not found");
|
|
} finally {
|
|
await server.close();
|
|
if (createdLink) {
|
|
await fs.rm(linkPath, { force: true });
|
|
}
|
|
if (createdBundle) {
|
|
await fs.rm(bundlePath, { force: true });
|
|
}
|
|
}
|
|
});
|
|
});
|