Files
openclaw/src/daemon/program-args.test.ts
2026-04-27 03:40:32 +01:00

209 lines
6.7 KiB
TypeScript

import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
const childProcessMocks = vi.hoisted(() => ({
execFileSync: vi.fn(),
}));
const fsMocks = vi.hoisted(() => ({
access: vi.fn(),
realpath: vi.fn(),
stat: vi.fn(),
}));
vi.mock("node:fs/promises", async () => {
const actual = await vi.importActual<typeof import("node:fs/promises")>("node:fs/promises");
return {
...actual,
default: {
...actual,
access: fsMocks.access,
realpath: fsMocks.realpath,
stat: fsMocks.stat,
},
access: fsMocks.access,
realpath: fsMocks.realpath,
stat: fsMocks.stat,
};
});
vi.mock("node:child_process", async () => {
const actual = await vi.importActual<typeof import("node:child_process")>("node:child_process");
return {
...actual,
execFileSync: childProcessMocks.execFileSync,
};
});
import { resolveGatewayProgramArguments } from "./program-args.js";
const originalArgv = [...process.argv];
afterEach(() => {
process.argv = [...originalArgv];
vi.resetAllMocks();
});
describe("resolveGatewayProgramArguments", () => {
it("prefers index.js over legacy entry.js when both exist in the same dist directory", async () => {
const entryPath = path.resolve("/opt/openclaw/dist/entry.js");
const indexPath = path.resolve("/opt/openclaw/dist/index.js");
process.argv = ["node", entryPath];
fsMocks.realpath.mockResolvedValue(entryPath);
fsMocks.access.mockResolvedValue(undefined);
const result = await resolveGatewayProgramArguments({ port: 18789 });
expect(result.programArguments).toEqual([
process.execPath,
indexPath,
"gateway",
"--port",
"18789",
]);
});
it("keeps entry.js when index.js is missing", async () => {
const entryPath = path.resolve("/opt/openclaw/dist/entry.js");
const indexPath = path.resolve("/opt/openclaw/dist/index.js");
const indexMjsPath = path.resolve("/opt/openclaw/dist/index.mjs");
process.argv = ["node", entryPath];
fsMocks.realpath.mockResolvedValue(entryPath);
fsMocks.access.mockImplementation(async (target: string) => {
if (target === indexPath || target === indexMjsPath) {
throw new Error("missing");
}
return;
});
const result = await resolveGatewayProgramArguments({ port: 18789 });
expect(result.programArguments).toEqual([
process.execPath,
entryPath,
"gateway",
"--port",
"18789",
]);
});
it("uses realpath-resolved dist entry when running via npx shim", async () => {
const argv1 = path.resolve("/tmp/.npm/_npx/63c3/node_modules/.bin/openclaw");
const entryPath = path.resolve("/tmp/.npm/_npx/63c3/node_modules/openclaw/dist/entry.js");
process.argv = ["node", argv1];
fsMocks.realpath.mockResolvedValue(entryPath);
fsMocks.access.mockImplementation(async (target: string) => {
if (target === entryPath) {
return;
}
throw new Error("missing");
});
const result = await resolveGatewayProgramArguments({ port: 18789 });
expect(result.programArguments).toEqual([
process.execPath,
entryPath,
"gateway",
"--port",
"18789",
]);
});
it("prefers symlinked path over realpath for stable service config", async () => {
// Simulates pnpm global install where node_modules/openclaw is a symlink
// to .pnpm/openclaw@X.Y.Z/node_modules/openclaw
const symlinkPath = path.resolve(
"/Users/test/Library/pnpm/global/5/node_modules/openclaw/dist/entry.js",
);
const realpathResolved = path.resolve(
"/Users/test/Library/pnpm/global/5/node_modules/.pnpm/openclaw@2026.1.21-2/node_modules/openclaw/dist/entry.js",
);
process.argv = ["node", symlinkPath];
fsMocks.realpath.mockResolvedValue(realpathResolved);
fsMocks.access.mockResolvedValue(undefined); // Both paths exist
const result = await resolveGatewayProgramArguments({ port: 18789 });
// Should use the symlinked canonical index.js path, not the realpath-resolved versioned path
expect(result.programArguments[1]).toBe(
path.resolve("/Users/test/Library/pnpm/global/5/node_modules/openclaw/dist/index.js"),
);
expect(result.programArguments[1]).not.toContain("@2026.1.21-2");
});
it("falls back to node_modules package dist when .bin path is not resolved", async () => {
const argv1 = path.resolve("/tmp/.npm/_npx/63c3/node_modules/.bin/openclaw");
const indexPath = path.resolve("/tmp/.npm/_npx/63c3/node_modules/openclaw/dist/index.js");
process.argv = ["node", argv1];
fsMocks.realpath.mockRejectedValue(new Error("no realpath"));
fsMocks.access.mockImplementation(async (target: string) => {
if (target === indexPath) {
return;
}
throw new Error("missing");
});
const result = await resolveGatewayProgramArguments({ port: 18789 });
expect(result.programArguments).toEqual([
process.execPath,
indexPath,
"gateway",
"--port",
"18789",
]);
});
it("uses src/entry.ts for bun dev mode", async () => {
const repoIndexPath = path.resolve("/repo/src/index.ts");
const repoEntryPath = path.resolve("/repo/src/entry.ts");
process.argv = ["/usr/local/bin/node", repoIndexPath];
fsMocks.realpath.mockResolvedValue(repoIndexPath);
fsMocks.access.mockResolvedValue(undefined);
childProcessMocks.execFileSync.mockReturnValue("/usr/local/bin/bun\n");
const result = await resolveGatewayProgramArguments({
dev: true,
port: 18789,
runtime: "bun",
});
expect(result.programArguments).toEqual([
"/usr/local/bin/bun",
repoEntryPath,
"gateway",
"--port",
"18789",
]);
expect(result.workingDirectory).toBe(path.resolve("/repo"));
});
it("uses an executable wrapper when provided", async () => {
const wrapperPath = path.resolve("/usr/local/bin/openclaw-doppler");
fsMocks.stat.mockResolvedValue({ isFile: () => true } as never);
fsMocks.access.mockResolvedValue(undefined);
const result = await resolveGatewayProgramArguments({
port: 18789,
wrapperPath,
});
expect(result.programArguments).toEqual([wrapperPath, "gateway", "--port", "18789"]);
expect(result.workingDirectory).toBeUndefined();
});
it("rejects a non-executable wrapper file", async () => {
const wrapperPath = path.resolve("/usr/local/bin/openclaw-doppler");
fsMocks.stat.mockResolvedValue({ isFile: () => true } as never);
fsMocks.access.mockRejectedValue(new Error("EACCES"));
await expect(
resolveGatewayProgramArguments({
port: 18789,
wrapperPath,
}),
).rejects.toThrow("OPENCLAW_WRAPPER must point to an executable file");
});
});