File size: 33,329 Bytes
3201ca6 | 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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 | import { createServer, request, type Server } from "node:http";
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import {
parseArgs,
serializeForInlineScript,
startStaticServer,
} from "../../scripts/static-server.mjs";
describe("static-server.mjs", () => {
const servers: Server[] = [];
const tempDirs: string[] = [];
afterEach(async () => {
await Promise.all(
servers.splice(0).map(
(server) =>
new Promise<void>((resolve) => {
server.close(() => resolve());
}),
),
);
for (const dir of tempDirs.splice(0)) {
rmSync(dir, { recursive: true, force: true });
}
});
async function startServer(
dir: string,
overrides: Partial<Parameters<typeof startStaticServer>[0]> = {},
) {
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir,
routes: {},
...overrides,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Static server did not bind to a TCP port");
}
return `http://127.0.0.1:${address.port}`;
}
async function startHttpServer(server: Server) {
await new Promise<void>((resolve, reject) => {
server.once("error", reject);
server.listen(0, "127.0.0.1", () => {
server.off("error", reject);
resolve();
});
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Server did not bind to a TCP port");
}
return `http://127.0.0.1:${address.port}`;
}
async function getJson(url: string) {
return new Promise<{ status: number; body: unknown }>((resolve, reject) => {
const req = request(url, { method: "GET" }, (res) => {
let body = "";
res.setEncoding("utf8");
res.on("data", (chunk) => {
body += chunk;
});
res.on("end", () => {
try {
resolve({
status: res.statusCode ?? 0,
body: JSON.parse(body),
});
} catch (error) {
reject(error);
}
});
});
req.on("error", reject);
req.end();
});
}
async function getText(url: string) {
return new Promise<{ status: number; body: string }>((resolve, reject) => {
const req = request(url, { method: "GET" }, (res) => {
let body = "";
res.setEncoding("utf8");
res.on("data", (chunk) => {
body += chunk;
});
res.on("end", () => {
resolve({
status: res.statusCode ?? 0,
body,
});
});
});
req.on("error", reject);
req.end();
});
}
describe("parseArgs", () => {
it("defaults sessionApiKey to null", () => {
const config = parseArgs([]);
expect(config.sessionApiKey).toBeNull();
});
it("parses --session-api-key", () => {
const config = parseArgs(["--session-api-key", "my-test-key"]);
expect(config.sessionApiKey).toBe("my-test-key");
});
it("treats empty string as null for session key", () => {
const config = parseArgs(["--session-api-key", ""]);
expect(config.sessionApiKey).toBeNull();
});
it("defaults runtimeServicesInfo to null", () => {
const config = parseArgs([]);
expect(config.runtimeServicesInfo).toBeNull();
});
it("defaults lockToCloud to null", () => {
const config = parseArgs([]);
expect(config.lockToCloud).toBeNull();
});
it("parses --lock-to-cloud", () => {
const config = parseArgs([
"--lock-to-cloud",
"https://cloud.example.com",
]);
expect(config.lockToCloud).toBe("https://cloud.example.com");
});
it("treats empty string as null for lockToCloud", () => {
const config = parseArgs(["--lock-to-cloud", ""]);
expect(config.lockToCloud).toBeNull();
});
it("defaults disableTelemetry to false", () => {
const config = parseArgs([], {});
expect(config.disableTelemetry).toBe(false);
});
it("parses --disable-telemetry", () => {
const config = parseArgs(["--disable-telemetry"], {});
expect(config.disableTelemetry).toBe(true);
});
it("enables disableTelemetry from AGENT_CANVAS_DISABLE_TELEMETRY=1", () => {
const config = parseArgs([], { AGENT_CANVAS_DISABLE_TELEMETRY: "1" });
expect(config.disableTelemetry).toBe(true);
});
it("enables disableTelemetry from AGENT_CANVAS_DISABLE_TELEMETRY=true", () => {
const config = parseArgs([], { AGENT_CANVAS_DISABLE_TELEMETRY: "true" });
expect(config.disableTelemetry).toBe(true);
});
it("ignores a falsy AGENT_CANVAS_DISABLE_TELEMETRY value", () => {
const config = parseArgs([], { AGENT_CANVAS_DISABLE_TELEMETRY: "0" });
expect(config.disableTelemetry).toBe(false);
});
it("defaults basePath to root", () => {
const config = parseArgs([]);
expect(config.basePath).toBe("/");
});
it("parses and normalizes --base-path", () => {
const config = parseArgs(["--base-path", "canvas/"]);
expect(config.basePath).toBe("/canvas");
});
it("treats empty string as root for basePath", () => {
const config = parseArgs(["--base-path", ""]);
expect(config.basePath).toBe("/");
});
it("parses --runtime-services-info", () => {
const json = '{"mode":"docker"}';
const config = parseArgs(["--runtime-services-info", json]);
expect(config.runtimeServicesInfo).toBe(json);
});
it("treats empty string as null for runtime services info", () => {
const config = parseArgs(["--runtime-services-info", ""]);
expect(config.runtimeServicesInfo).toBeNull();
});
});
describe("serializeForInlineScript", () => {
it("escapes '<' and '>' to prevent breaking out of script tags", () => {
const input = "</script><script>alert(1)</script>";
const result = serializeForInlineScript(input);
expect(result).not.toContain("<");
expect(result).not.toContain(">");
expect(result).toBe('"\\u003c/script\\u003e\\u003cscript\\u003ealert(1)\\u003c/script\\u003e"');
});
it("escapes line and paragraph separators U+2028 and U+2029", () => {
const input = "line1\u2028line2\u2029line3";
const result = serializeForInlineScript(input);
expect(result).toContain("\\u2028");
expect(result).toContain("\\u2029");
expect(result).not.toContain("\u2028");
expect(result).not.toContain("\u2029");
});
it("serializes complex objects properly with escaping", () => {
const input = { key: "<test>", count: 42 };
const result = serializeForInlineScript(input);
expect(result).toBe('{"key":"\\u003ctest\\u003e","count":42}');
});
});
describe("--vscode-base-path", () => {
it("parses the prefix and normalizes a trailing slash", () => {
const config = parseArgs([
"--route",
"/vscode=http://127.0.0.1:8001",
"--vscode-base-path",
"/vscode/",
]);
expect(config.vscodeBasePath).toBe("/vscode");
});
it("defaults to null so an origin advertises nothing unless asked", () => {
expect(parseArgs([]).vscodeBasePath).toBeNull();
});
it("rejects a value that is not a path", () => {
expect(() => parseArgs(["--vscode-base-path", "vscode"])).toThrow(
/must start with '\//,
);
});
// The guard that makes this flag trustworthy: advertising the editor and
// routing it are the same decision, so a prefix with no route behind it
// must not start. Without it, the frontend would render the control and
// the navigation would fall through to the SPA — the exact bug the flag
// exists to prevent.
it("refuses to start when the advertised prefix has no matching route", () => {
const exit = vi.spyOn(process, "exit").mockImplementation((() => {
throw new Error("process.exit");
}) as never);
const error = vi.spyOn(console, "error").mockImplementation(() => {});
try {
expect(() =>
parseArgs([
"--route",
"/api=http://127.0.0.1:8000",
"--vscode-base-path",
"/vscode",
]),
).toThrow("process.exit");
expect(exit).toHaveBeenCalledWith(1);
expect(error.mock.calls[0][0]).toContain("has no matching --route");
} finally {
exit.mockRestore();
error.mockRestore();
}
});
});
describe("vscode base path injection", () => {
async function startServerAdvertising(
dir: string,
vscodeBasePath: string | null,
) {
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir,
routes: {},
vscodeBasePath,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Static server did not bind to a TCP port");
}
return `http://127.0.0.1:${address.port}`;
}
function makeBuildDir() {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
return buildDir;
}
// Read by getOriginVSCodeBasePath() in src/utils/vscode-origin.ts, which
// is what lets the frontend tell "this server has an editor" apart from
// "this origin can reach it".
it("exposes the prefix on window.__AGENT_CANVAS_VSCODE_BASE_PATH__", async () => {
const origin = await startServerAdvertising(makeBuildDir(), "/vscode");
const body = await (await fetch(`${origin}/`)).text();
expect(body).toContain(
'window.__AGENT_CANVAS_VSCODE_BASE_PATH__="/vscode"',
);
});
// Public mode: the same document, served without the advertisement, is
// what hides the control on an origin that has no editor route.
it("injects nothing when the origin serves no editor", async () => {
const origin = await startServerAdvertising(makeBuildDir(), null);
const body = await (await fetch(`${origin}/`)).text();
expect(body).not.toContain("__AGENT_CANVAS_VSCODE_BASE_PATH__");
});
});
describe("runtime services info exposure", () => {
async function startServerWithRuntimeInfo(
dir: string,
runtimeServicesInfo: string,
) {
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir,
routes: {},
runtimeServicesInfo,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Static server did not bind to a TCP port");
}
return `http://127.0.0.1:${address.port}`;
}
// Legacy compatibility for older Docker / published-binary frontend
// bundles, which read runtime services from this injected window global.
// New bundles read /server_info.runtime_services instead.
it("exposes the JSON on window.__AGENT_CANVAS_RUNTIME_SERVICES_INFO__", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const info = JSON.stringify({
mode: "docker",
services: {
agent_server: { url_from_agent: "http://127.0.0.1:18000" },
},
});
const origin = await startServerWithRuntimeInfo(buildDir, info);
const body = await (await fetch(`${origin}/`)).text();
expect(body).toContain("window.__AGENT_CANVAS_RUNTIME_SERVICES_INFO__");
// Stored as a JSON *string* (note the escaped quotes) so older browser
// code can JSON.parse it.
expect(body).toContain('\\"mode\\"');
expect(body).toContain("docker");
});
it("does not inject when runtimeServicesInfo is null", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir: buildDir,
routes: {},
runtimeServicesInfo: null,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") throw new Error("No port");
const origin = `http://127.0.0.1:${(address as { port: number }).port}`;
const body = await (await fetch(`${origin}/`)).text();
expect(body).not.toContain("__AGENT_CANVAS_RUNTIME_SERVICES_INFO__");
});
it("adds runtime_services to proxied /server_info", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const upstreamOrigin = await startHttpServer(
createServer((_req, res) => {
res.writeHead(200, { "Content-Type": "application/json" });
res.end(JSON.stringify({ version: "1.28.0" }));
}),
);
const runtimeServicesInfo = JSON.stringify({
mode: "docker",
services: {
agent_server: { url_from_agent: "http://127.0.0.1:18000" },
},
});
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir: buildDir,
routes: { "/server_info": upstreamOrigin },
runtimeServicesInfo,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") throw new Error("No port");
const origin = `http://127.0.0.1:${address.port}`;
const response = await getJson(`${origin}/server_info`);
const body = response.body as {
version?: string;
runtime_services?: unknown;
};
expect(response.status).toBe(200);
expect(body.version).toBe("1.28.0");
expect(body.runtime_services).toEqual(JSON.parse(runtimeServicesInfo));
});
it("returns 502 when proxied /server_info target URL is invalid", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const runtimeServicesInfo = JSON.stringify({
mode: "docker",
services: {},
});
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir: buildDir,
routes: { "/server_info": "not-a-url" },
runtimeServicesInfo,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") throw new Error("No port");
const origin = `http://127.0.0.1:${address.port}`;
const response = await getText(`${origin}/server_info`);
expect(response.status).toBe(502);
expect(response.body).toContain("Bad Gateway");
expect(response.body).toContain("Invalid backend URL");
expect(server.listening).toBe(true);
});
});
describe("lock-to-cloud injection", () => {
async function startServerLockedToCloud(dir: string, lockToCloud: string) {
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir,
routes: {},
lockToCloud,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Static server did not bind to a TCP port");
}
return `http://127.0.0.1:${address.port}`;
}
it("exposes the locked Cloud URL on window.__AGENT_CANVAS_LOCK_TO_CLOUD__", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerLockedToCloud(
buildDir,
"https://cloud.example.com",
);
const body = await (await fetch(`${origin}/`)).text();
expect(body).toContain("window.__AGENT_CANVAS_LOCK_TO_CLOUD__");
expect(body).toContain('"https://cloud.example.com"');
});
it("injects lock-to-cloud into SPA fallback index.html", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerLockedToCloud(
buildDir,
"https://cloud.example.com",
);
const response = await fetch(`${origin}/some/deep/route`);
const body = await response.text();
expect(response.status).toBe(200);
expect(body).toContain("__AGENT_CANVAS_LOCK_TO_CLOUD__");
});
});
describe("disable-telemetry injection", () => {
async function startServerWithDisabledTelemetry(dir: string) {
const origin = await startServer(dir, { disableTelemetry: true });
return origin;
}
it("exposes window.__AGENT_CANVAS_DO_NOT_TRACK__ when enabled", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerWithDisabledTelemetry(buildDir);
const body = await (await fetch(`${origin}/`)).text();
expect(body).toContain("window.__AGENT_CANVAS_DO_NOT_TRACK__=true");
});
it("injects the flag into the SPA fallback index.html", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerWithDisabledTelemetry(buildDir);
const response = await fetch(`${origin}/some/deep/route`);
const body = await response.text();
expect(response.status).toBe(200);
expect(body).toContain("window.__AGENT_CANVAS_DO_NOT_TRACK__=true");
});
it("does not inject the flag when telemetry is not disabled", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServer(buildDir);
const body = await (await fetch(`${origin}/`)).text();
expect(body).not.toContain("__AGENT_CANVAS_DO_NOT_TRACK__");
});
});
describe("session key injection", () => {
async function startServerWithKey(dir: string, sessionApiKey: string) {
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir,
routes: {},
sessionApiKey,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") {
throw new Error("Static server did not bind to a TCP port");
}
return `http://127.0.0.1:${address.port}`;
}
it("injects session key script into index.html", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerWithKey(buildDir, "test-session-key");
const response = await fetch(`${origin}/`);
expect(response.status).toBe(200);
const body = await response.text();
expect(body).toContain("openhands-agent-server-config");
expect(body).toContain("test-session-key");
expect(body).toContain("sessionApiKey");
});
// Regression test: the published `agent-canvas` binary builds without
// VITE_SESSION_API_KEY baked in, so the React app reads the key from
// `window.__AGENT_CANVAS_SESSION_API_KEY__` (see
// `getBakedSessionApiKey()` in `src/api/agent-server-config.ts`).
// Without this assignment, `makeDefaultLocalBackend()` returns null
// on a fresh install and the user gets the Manage Backends modal
// instead of onboarding.
it("exposes the session key on window.__AGENT_CANVAS_SESSION_API_KEY__", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerWithKey(buildDir, "runtime-key");
const response = await fetch(`${origin}/`);
const body = await response.text();
expect(body).toContain("window.__AGENT_CANVAS_SESSION_API_KEY__");
expect(body).toContain('"runtime-key"');
// The window assignment must precede the localStorage write so the
// global is set even if storage access throws (private mode, etc.).
const windowIdx = body.indexOf("__AGENT_CANVAS_SESSION_API_KEY__");
const localStorageIdx = body.indexOf("openhands-agent-server-config");
expect(windowIdx).toBeGreaterThan(-1);
expect(localStorageIdx).toBeGreaterThan(-1);
expect(windowIdx).toBeLessThan(localStorageIdx);
});
it("injects session key into SPA fallback index.html", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerWithKey(buildDir, "fallback-key");
const response = await fetch(`${origin}/some/deep/route`);
expect(response.status).toBe(200);
const body = await response.text();
expect(body).toContain("fallback-key");
});
it("does not inject into non-html asset responses", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
mkdirSync(path.join(buildDir, "assets"));
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
writeFileSync(
path.join(buildDir, "assets", "app.js"),
"console.log('app');",
);
const origin = await startServerWithKey(buildDir, "should-not-inject");
const response = await fetch(`${origin}/assets/app.js`);
expect(response.status).toBe(200);
const body = await response.text();
expect(body).not.toContain("should-not-inject");
});
it("sets Cache-Control: no-store when session key is injected", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServerWithKey(buildDir, "cache-test-key");
const response = await fetch(`${origin}/`);
expect(response.headers.get("cache-control")).toBe("no-store");
});
it("sets Cache-Control: no-cache when session key is not present but other config is injected", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir: buildDir,
routes: {},
authRequired: true,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") throw new Error("No port");
const origin = `http://127.0.0.1:${(address as { port: number }).port}`;
const response = await fetch(`${origin}/`);
expect(response.headers.get("cache-control")).toBe("no-cache");
});
it("escapes HTML special characters and script closing tags in injected values", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const payload = '</script><script>alert("xss")</script>';
const origin = await startServerWithKey(buildDir, payload);
const response = await fetch(`${origin}/`);
const body = await response.text();
expect(body).not.toContain("</script><script>");
expect(body).toContain("\\u003c/script\\u003e\\u003cscript\\u003e");
});
it("does not inject when sessionApiKey is null", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir: buildDir,
routes: {},
sessionApiKey: null,
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") throw new Error("No port");
const origin = `http://127.0.0.1:${(address as { port: number }).port}`;
const response = await fetch(`${origin}/`);
const body = await response.text();
expect(body).not.toContain("openhands-agent-server-config");
expect(body).not.toContain("__AGENT_CANVAS_SESSION_API_KEY__");
});
it("injects session key into HTML without </head> tag (falls back to </body>)", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><body>no-head</body></html>",
);
const origin = await startServerWithKey(buildDir, "no-head-key");
const response = await fetch(`${origin}/`);
expect(response.status).toBe(200);
const body = await response.text();
expect(body).toContain("no-head-key");
expect(body).toContain("openhands-agent-server-config");
// Script should appear before </body>, not at the very front of the document
expect(body.indexOf("no-head-key")).toBeLessThan(body.indexOf("</body>"));
expect(body.indexOf("no-head-key")).toBeGreaterThan(0);
});
});
it("serves nested build assets on all platforms", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
mkdirSync(path.join(buildDir, "assets"));
writeFileSync(path.join(buildDir, "index.html"), "<main>app</main>");
writeFileSync(
path.join(buildDir, "assets", "entry.client-test.js"),
"export const loaded = true;\n",
);
const origin = await startServer(buildDir);
const response = await fetch(`${origin}/assets/entry.client-test.js`);
expect(response.status).toBe(200);
expect(response.headers.get("content-type")).toContain(
"application/javascript",
);
await expect(response.text()).resolves.toContain("loaded = true");
});
describe("base path mounting", () => {
it("serves index.html and injects the base path under the mount", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(
path.join(buildDir, "index.html"),
"<html><head></head><body>app</body></html>",
);
const origin = await startServer(buildDir, { basePath: "/canvas" });
const response = await fetch(`${origin}/canvas/conversations/abc`);
const body = await response.text();
expect(response.status).toBe(200);
expect(body).toContain("window.__AGENT_CANVAS_BASE_PATH__");
expect(body).toContain('"/canvas"');
});
it("serves static assets from underneath the mount", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
mkdirSync(path.join(buildDir, "assets"));
writeFileSync(path.join(buildDir, "index.html"), "<main>app</main>");
writeFileSync(
path.join(buildDir, "assets", "entry.client-test.js"),
"export const loaded = true;\n",
);
const origin = await startServer(buildDir, { basePath: "/canvas" });
const response = await fetch(
`${origin}/canvas/assets/entry.client-test.js`,
);
expect(response.status).toBe(200);
expect(response.headers.get("content-type")).toContain(
"application/javascript",
);
await expect(response.text()).resolves.toContain("loaded = true");
});
it("redirects app routes outside the mount to the configured base path", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(path.join(buildDir, "index.html"), "<main>app</main>");
const origin = await startServer(buildDir, { basePath: "/canvas" });
const response = await fetch(`${origin}/conversations/abc?tab=files`, {
redirect: "manual",
});
expect(response.status).toBe(308);
expect(response.headers.get("location")).toBe(
"/canvas/conversations/abc?tab=files",
);
});
it("does not redirect asset-like requests outside the configured mount", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(path.join(buildDir, "index.html"), "<main>app</main>");
const origin = await startServer(buildDir, { basePath: "/canvas" });
const response = await fetch(`${origin}/assets/missing.js`, {
redirect: "manual",
});
expect(response.status).toBe(404);
});
});
describe("--no-referrer-prefix", () => {
it("defaults to none", () => {
expect(parseArgs([]).noReferrerPrefixes).toEqual([]);
});
it("collects repeated prefixes", () => {
const config = parseArgs([
"--no-referrer-prefix",
"/vscode",
"--no-referrer-prefix",
"/editor",
]);
expect(config.noReferrerPrefixes).toEqual(["/vscode", "/editor"]);
});
it("rejects a prefix without a leading slash", () => {
expect(() => parseArgs(["--no-referrer-prefix", "vscode"])).toThrow(
/must start with/,
);
});
// Behaviour on a live proxied response is covered in ingress.test.ts,
// which drives a real child process; an in-process proxy deadlocks against
// the MSW interceptor this suite installs globally.
});
it("keeps paths confined to the static directory", async () => {
const parentDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-parent-"));
tempDirs.push(parentDir);
const buildDir = path.join(parentDir, "build");
mkdirSync(buildDir);
writeFileSync(path.join(buildDir, "index.html"), "<main>app</main>");
writeFileSync(path.join(parentDir, "secret.txt"), "secret\n");
const origin = await startServer(buildDir);
const response = await fetch(`${origin}/../secret.txt`);
expect(response.status).not.toBe(200);
await expect(response.text()).resolves.not.toContain("secret");
});
it("returns 502 when backend target URL is invalid", async () => {
const buildDir = mkdtempSync(path.join(tmpdir(), "agent-canvas-build-"));
tempDirs.push(buildDir);
writeFileSync(path.join(buildDir, "index.html"), "<main>app</main>");
const server = await startStaticServer({
port: 0,
host: "127.0.0.1",
dir: buildDir,
routes: { "/api/invalid": "not-a-url" },
});
servers.push(server);
const address = server.address();
if (!address || typeof address === "string") throw new Error("No port");
const origin = `http://127.0.0.1:${address.port}`;
const response = await getText(`${origin}/api/invalid/test`);
expect(response.status).toBe(502);
expect(response.body).toContain("Bad Gateway");
expect(response.body).toContain("Invalid URL");
expect(server.listening).toBe(true);
});
});
|