Files
openclaw/test/scripts/postinstall-bundled-plugins.test.ts
2026-04-25 16:12:01 -07:00

888 lines
30 KiB
TypeScript

import fs from "node:fs/promises";
import path from "node:path";
import { describe, expect, it, vi } from "vitest";
import {
createBundledRuntimeDependencyInstallArgs,
createBundledRuntimeDependencyInstallEnv,
createNestedNpmInstallEnv,
isDirectPostinstallInvocation,
pruneInstalledPackageDist,
discoverBundledPluginRuntimeDeps,
pruneBundledPluginSourceNodeModules,
runBundledPluginPostinstall,
runPluginRegistryPostinstallMigration,
restoreLegacyUpdaterCompatSidecars,
} from "../../scripts/postinstall-bundled-plugins.mjs";
import { NPM_UPDATE_COMPAT_SIDECARS } from "../../src/infra/npm-update-compat-sidecars.ts";
import { writePackageDistInventory } from "../../src/infra/package-dist-inventory.ts";
import { createScriptTestHarness } from "./test-helpers.js";
const { createTempDirAsync } = createScriptTestHarness();
async function createExtensionsDir() {
const root = await createTempDirAsync("openclaw-postinstall-");
const extensionsDir = path.join(root, "dist", "extensions");
await fs.mkdir(extensionsDir, { recursive: true });
return extensionsDir;
}
async function writePluginPackage(
extensionsDir: string,
pluginId: string,
packageJson: Record<string, unknown>,
) {
const pluginDir = path.join(extensionsDir, pluginId);
await fs.mkdir(pluginDir, { recursive: true });
await fs.writeFile(
path.join(pluginDir, "package.json"),
`${JSON.stringify(packageJson, null, 2)}\n`,
);
const packageRoot =
path.basename(path.dirname(extensionsDir)) === "dist"
? path.dirname(path.dirname(extensionsDir))
: path.dirname(extensionsDir);
try {
await writePackageDistInventory(packageRoot);
} catch (error) {
if ((error as NodeJS.ErrnoException).code !== "ENOENT") {
throw error;
}
}
}
describe("bundled plugin postinstall", () => {
function createNpmInstallArgs(...packages: string[]) {
return createBundledRuntimeDependencyInstallArgs(packages);
}
function createBareNpmRunner(packages: string[]) {
return {
command: "npm",
args: createNpmInstallArgs(...packages),
env: {
HOME: "/tmp/home",
PATH: "/tmp/node/bin",
},
shell: false as const,
};
}
function expectNpmInstallSpawn(
spawnSync: ReturnType<typeof vi.fn>,
packageRoot: string,
packages: string[],
) {
expect(spawnSync).toHaveBeenCalledWith("npm", createNpmInstallArgs(...packages), {
cwd: packageRoot,
encoding: "utf8",
env: {
HOME: "/tmp/home",
PATH: "/tmp/node/bin",
},
shell: false,
stdio: "pipe",
windowsVerbatimArguments: undefined,
});
}
it("recognizes direct invocation through symlinked temp prefixes", () => {
const realpathSync = vi.fn((value: string) =>
value.replace(/^\/var\/folders\//u, "/private/var/folders/"),
);
expect(
isDirectPostinstallInvocation({
entryPath: "/var/folders/tmp/openclaw/scripts/postinstall-bundled-plugins.mjs",
modulePath: "/private/var/folders/tmp/openclaw/scripts/postinstall-bundled-plugins.mjs",
realpathSync,
}),
).toBe(true);
});
async function writeDiscordDaveyOptionalDependencyFixture(
extensionsDir: string,
packageRoot: string,
) {
await writePluginPackage(extensionsDir, "discord", {
dependencies: {
"@snazzah/davey": "0.1.11",
},
});
await fs.mkdir(path.join(packageRoot, "node_modules", "@snazzah", "davey"), {
recursive: true,
});
await fs.writeFile(
path.join(packageRoot, "node_modules", "@snazzah", "davey", "package.json"),
JSON.stringify({
optionalDependencies: {
"@snazzah/davey-win32-arm64-msvc": "0.1.11",
},
}),
);
}
it("clears global npm config before nested installs", () => {
expect(
createNestedNpmInstallEnv({
npm_config_global: "true",
npm_config_location: "global",
npm_config_prefix: "/opt/homebrew",
HOME: "/tmp/home",
}),
).toEqual({
HOME: "/tmp/home",
});
});
it("uses package-manager-neutral runtime install args with npm config env", () => {
expect(createBundledRuntimeDependencyInstallArgs(["acpx@0.4.1"])).toEqual([
"install",
"--ignore-scripts",
"acpx@0.4.1",
]);
expect(
createBundledRuntimeDependencyInstallEnv({
HOME: "/tmp/home",
npm_config_prefix: "/opt/homebrew",
}),
).toEqual({
HOME: "/tmp/home",
npm_config_legacy_peer_deps: "true",
npm_config_package_lock: "false",
npm_config_save: "false",
});
});
it("does not install bundled plugin deps outside of source checkouts by default", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writePluginPackage(extensionsDir, "acpx", {
dependencies: {
acpx: "0.4.1",
},
});
const spawnSync = vi.fn();
runBundledPluginPostinstall({
env: { HOME: "/tmp/home" },
extensionsDir,
packageRoot,
npmRunner: createBareNpmRunner(["acpx@0.4.1"]),
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expect(spawnSync).not.toHaveBeenCalled();
});
it("prunes source-checkout bundled plugin node_modules", async () => {
const packageRoot = await createTempDirAsync("openclaw-source-checkout-");
const extensionsDir = path.join(packageRoot, "extensions");
await fs.mkdir(path.join(packageRoot, ".git"), { recursive: true });
await fs.mkdir(path.join(packageRoot, "src"), { recursive: true });
await fs.mkdir(extensionsDir, { recursive: true });
await writePluginPackage(extensionsDir, "acpx", {
dependencies: {
acpx: "0.5.2",
},
});
await fs.mkdir(path.join(extensionsDir, "acpx", "node_modules", "acpx"), { recursive: true });
await fs.writeFile(
path.join(extensionsDir, "acpx", "node_modules", "acpx", "package.json"),
JSON.stringify({ name: "acpx", version: "0.4.1" }),
);
const spawnSync = vi.fn();
runBundledPluginPostinstall({
env: { HOME: "/tmp/home" },
packageRoot,
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
await expect(fs.stat(path.join(extensionsDir, "acpx", "node_modules"))).rejects.toMatchObject({
code: "ENOENT",
});
expect(spawnSync).not.toHaveBeenCalled();
});
it("keeps source-checkout prune non-fatal", async () => {
const packageRoot = await createTempDirAsync("openclaw-source-checkout-prune-error-");
const extensionsDir = path.join(packageRoot, "extensions");
await fs.mkdir(path.join(packageRoot, ".git"), { recursive: true });
await fs.mkdir(path.join(packageRoot, "src"), { recursive: true });
await fs.mkdir(path.join(extensionsDir, "acpx"), { recursive: true });
await fs.writeFile(path.join(extensionsDir, "acpx", "package.json"), "{}\n");
const warn = vi.fn();
expect(() =>
runBundledPluginPostinstall({
env: { HOME: "/tmp/home" },
packageRoot,
rmSync: vi.fn(() => {
throw new Error("locked");
}),
log: { log: vi.fn(), warn },
}),
).not.toThrow();
expect(warn).toHaveBeenCalledWith(
"[postinstall] could not prune bundled plugin source node_modules: Error: locked",
);
});
it("honors disable env before source-checkout pruning", async () => {
const packageRoot = await createTempDirAsync("openclaw-source-checkout-disabled-");
const extensionsDir = path.join(packageRoot, "extensions");
await fs.mkdir(path.join(packageRoot, ".git"), { recursive: true });
await fs.mkdir(path.join(packageRoot, "src"), { recursive: true });
await fs.mkdir(path.join(extensionsDir, "acpx", "node_modules"), { recursive: true });
await fs.writeFile(path.join(extensionsDir, "acpx", "package.json"), "{}\n");
runBundledPluginPostinstall({
env: { OPENCLAW_DISABLE_BUNDLED_PLUGIN_POSTINSTALL: "1" },
packageRoot,
log: { log: vi.fn(), warn: vi.fn() },
});
await expect(fs.stat(path.join(extensionsDir, "acpx", "node_modules"))).resolves.toBeTruthy();
});
it("migrates the plugin registry during postinstall from built dist contracts", async () => {
const packageRoot = await createTempDirAsync("openclaw-postinstall-registry-");
const log = { log: vi.fn(), warn: vi.fn() };
const migratePluginRegistryForInstall = vi.fn(async () => ({
status: "migrated",
migrated: true,
preflight: {
deprecationWarnings: [],
},
current: {
plugins: [{ pluginId: "demo" }],
},
}));
const importModule = vi.fn(async (specifier: string) => {
if (specifier.endsWith("/dist/commands/doctor/shared/plugin-registry-migration.js")) {
return { migratePluginRegistryForInstall };
}
throw new Error(`unexpected import: ${specifier}`);
});
const result = await runPluginRegistryPostinstallMigration({
packageRoot,
existsSync: vi.fn((filePath: string) =>
filePath.endsWith(
path.join("dist", "commands", "doctor", "shared", "plugin-registry-migration.js"),
),
),
importModule,
env: { OPENCLAW_HOME: "/tmp/home" },
log,
});
expect(result).toMatchObject({ status: "migrated" });
expect(migratePluginRegistryForInstall).toHaveBeenCalledWith({
env: { OPENCLAW_HOME: "/tmp/home" },
packageRoot,
});
expect(log.log).toHaveBeenCalledWith(
"[postinstall] migrated plugin registry: 1 plugin(s) indexed",
);
});
it("surfaces deprecated plugin registry migration break-glass warnings", async () => {
const warn = vi.fn();
const migratePluginRegistryForInstall = vi.fn(async () => ({
status: "skip-existing",
migrated: false,
preflight: {
deprecationWarnings: ["OPENCLAW_FORCE_PLUGIN_REGISTRY_MIGRATION is deprecated"],
},
}));
const importModule = vi.fn(async () => ({ migratePluginRegistryForInstall }));
await runPluginRegistryPostinstallMigration({
packageRoot: "/pkg",
existsSync: vi.fn(() => true),
importModule,
log: { log: vi.fn(), warn },
});
expect(warn).toHaveBeenCalledWith(
"[postinstall] OPENCLAW_FORCE_PLUGIN_REGISTRY_MIGRATION is deprecated",
);
});
it("keeps plugin registry postinstall migration non-fatal when dist entries are unavailable", async () => {
const warn = vi.fn();
await expect(
runPluginRegistryPostinstallMigration({
packageRoot: "/pkg",
existsSync: vi.fn(() => false),
log: { log: vi.fn(), warn },
}),
).resolves.toEqual({
status: "skipped",
reason: "missing-dist-entry",
});
expect(warn).not.toHaveBeenCalled();
});
it("honors plugin registry postinstall migration disable env", async () => {
const importModule = vi.fn(async () => {
throw new Error("dist migration module should not import when migration is disabled");
});
await expect(
runPluginRegistryPostinstallMigration({
packageRoot: "/pkg",
env: { OPENCLAW_DISABLE_PLUGIN_REGISTRY_MIGRATION: "1" },
existsSync: vi.fn(() => true),
importModule,
log: { log: vi.fn(), warn: vi.fn() },
}),
).resolves.toMatchObject({
status: "disabled",
migrated: false,
reason: "disabled-env",
});
expect(importModule).not.toHaveBeenCalled();
});
it("does not disable plugin registry migration for falsey env flag strings", async () => {
const migratePluginRegistryForInstall = vi.fn(async () => ({
status: "skip-existing",
migrated: false,
preflight: {},
}));
const importModule = vi.fn(async () => ({ migratePluginRegistryForInstall }));
await expect(
runPluginRegistryPostinstallMigration({
packageRoot: "/pkg",
env: { OPENCLAW_DISABLE_PLUGIN_REGISTRY_MIGRATION: "0" },
existsSync: vi.fn(() => true),
importModule,
log: { log: vi.fn(), warn: vi.fn() },
}),
).resolves.toMatchObject({
status: "skip-existing",
migrated: false,
});
expect(importModule).toHaveBeenCalledOnce();
expect(migratePluginRegistryForInstall).toHaveBeenCalledWith({
env: { OPENCLAW_DISABLE_PLUGIN_REGISTRY_MIGRATION: "0" },
packageRoot: "/pkg",
});
});
it("prunes stale dist files from packaged installs", async () => {
const packageRoot = await createTempDirAsync("openclaw-packaged-install-");
const currentFile = path.join(packageRoot, "dist", "channel-BOa4MfoC.js");
const staleFile = path.join(packageRoot, "dist", "channel-CJUAgRQR.js");
await fs.mkdir(path.dirname(currentFile), { recursive: true });
await fs.writeFile(currentFile, "export {};\n");
await writePackageDistInventory(packageRoot);
await fs.writeFile(staleFile, "export {};\n");
expect(
pruneInstalledPackageDist({
packageRoot,
log: { log: vi.fn(), warn: vi.fn() },
}),
).toEqual(["dist/channel-CJUAgRQR.js"]);
await expect(fs.stat(currentFile)).resolves.toBeTruthy();
await expect(fs.stat(staleFile)).rejects.toMatchObject({ code: "ENOENT" });
});
it("restores only postinstall-generated QA compat sidecars after pruning old installs", async () => {
const packageRoot = await createTempDirAsync("openclaw-packaged-install-qa-compat-");
const currentFile = path.join(packageRoot, "dist", "entry.js");
const stalePackage = path.join(packageRoot, "dist", "extensions", "qa-lab", "package.json");
const staleManifest = path.join(
packageRoot,
"dist",
"extensions",
"qa-lab",
"openclaw.plugin.json",
);
await fs.mkdir(path.dirname(stalePackage), { recursive: true });
await fs.writeFile(currentFile, "export {};\n");
await writePackageDistInventory(packageRoot);
await fs.writeFile(stalePackage, "{}\n");
await fs.writeFile(staleManifest, "{}\n");
runBundledPluginPostinstall({
packageRoot,
spawnSync: vi.fn(),
log: { log: vi.fn(), warn: vi.fn() },
});
await expect(fs.stat(stalePackage)).rejects.toMatchObject({ code: "ENOENT" });
await expect(fs.stat(staleManifest)).rejects.toMatchObject({ code: "ENOENT" });
await expect(
fs.readFile(path.join(packageRoot, "dist", "extensions", "qa-channel", "runtime-api.js"), {
encoding: "utf8",
}),
).resolves.toBe("export {};\n");
await expect(
fs.stat(path.join(packageRoot, "dist", "extensions", "qa-channel", "package.json")),
).rejects.toMatchObject({ code: "ENOENT" });
await expect(
fs.stat(path.join(packageRoot, "dist", "extensions", "qa-channel", "openclaw.plugin.json")),
).rejects.toMatchObject({ code: "ENOENT" });
await expect(
fs.readFile(path.join(packageRoot, "dist", "extensions", "qa-lab", "runtime-api.js"), {
encoding: "utf8",
}),
).resolves.toBe("export {};\n");
});
it("keeps postinstall QA compat sidecars aligned with update verification metadata", async () => {
const packageRoot = await createTempDirAsync("openclaw-packaged-install-qa-compat-");
const restored = restoreLegacyUpdaterCompatSidecars({
packageRoot,
log: { log: vi.fn(), warn: vi.fn() },
});
expect(restored).toEqual(NPM_UPDATE_COMPAT_SIDECARS.map((sidecar) => sidecar.path));
for (const sidecar of NPM_UPDATE_COMPAT_SIDECARS) {
await expect(fs.readFile(path.join(packageRoot, sidecar.path), "utf8")).resolves.toBe(
sidecar.content,
);
}
});
it("keeps packaged postinstall non-fatal when the dist inventory is missing", async () => {
const packageRoot = await createTempDirAsync("openclaw-packaged-install-missing-inventory-");
const staleFile = path.join(packageRoot, "dist", "channel-CJUAgRQR.js");
await fs.mkdir(path.dirname(staleFile), { recursive: true });
await fs.writeFile(staleFile, "export {};\n");
const warn = vi.fn();
expect(() =>
runBundledPluginPostinstall({
packageRoot,
log: { log: vi.fn(), warn },
}),
).not.toThrow();
await expect(fs.stat(staleFile)).resolves.toBeTruthy();
expect(warn).toHaveBeenCalledWith(
"[postinstall] skipping dist prune: missing dist inventory: dist/postinstall-inventory.json",
);
});
it("keeps packaged postinstall non-fatal when the dist inventory is invalid", async () => {
const packageRoot = await createTempDirAsync("openclaw-packaged-install-invalid-inventory-");
const currentFile = path.join(packageRoot, "dist", "channel-BOa4MfoC.js");
const inventoryPath = path.join(packageRoot, "dist", "postinstall-inventory.json");
await fs.mkdir(path.dirname(currentFile), { recursive: true });
await fs.writeFile(currentFile, "export {};\n");
await fs.writeFile(inventoryPath, "{not-json}\n");
const warn = vi.fn();
expect(() =>
runBundledPluginPostinstall({
packageRoot,
log: { log: vi.fn(), warn },
}),
).not.toThrow();
await expect(fs.stat(currentFile)).resolves.toBeTruthy();
expect(warn).toHaveBeenCalledWith(
"[postinstall] skipping dist prune: invalid dist inventory: dist/postinstall-inventory.json",
);
});
it("rejects symlinked dist roots in packaged installs", () => {
expect(() =>
pruneInstalledPackageDist({
packageRoot: "/pkg",
expectedFiles: new Set(),
existsSync: vi.fn(() => true),
lstatSync: vi.fn((filePath) => ({
isDirectory: () => filePath === "/pkg/dist",
isSymbolicLink: () => filePath === "/pkg/dist",
})),
realpathSync: vi.fn((filePath) => filePath),
readdirSync: vi.fn(),
rmSync: vi.fn(),
log: { log: vi.fn(), warn: vi.fn() },
}),
).toThrow("unsafe dist root: dist must be a real directory");
});
it("rejects symlink entries in packaged dist trees", () => {
expect(() =>
pruneInstalledPackageDist({
packageRoot: "/pkg",
expectedFiles: new Set(),
existsSync: vi.fn(() => true),
lstatSync: vi.fn(() => ({
isDirectory: () => true,
isSymbolicLink: () => false,
})),
realpathSync: vi.fn((filePath) => filePath),
readdirSync: vi.fn((filePath) => {
if (filePath === "/pkg/dist") {
return [
{
name: "escape",
isDirectory: () => false,
isFile: () => false,
isSymbolicLink: () => true,
},
];
}
return [];
}),
rmSync: vi.fn(),
log: { log: vi.fn(), warn: vi.fn() },
}),
).toThrow("unsafe dist entry: dist/escape");
});
it("ignores staged bundled plugin node_modules when pruning packaged dist", async () => {
const packageRoot = await createTempDirAsync("openclaw-packaged-install-runtime-deps-");
const staleFile = path.join(packageRoot, "dist", "stale-runtime.js");
const packageJson = path.join(packageRoot, "dist", "extensions", "slack", "package.json");
const binDir = path.join(packageRoot, "dist", "extensions", "slack", "node_modules", ".bin");
await fs.mkdir(path.dirname(staleFile), { recursive: true });
await fs.mkdir(path.dirname(packageJson), { recursive: true });
await fs.mkdir(binDir, { recursive: true });
await fs.writeFile(staleFile, "export {};\n");
await fs.writeFile(packageJson, "{}\n");
await fs.symlink("../fxparser/bin.js", path.join(binDir, "fxparser"));
expect(
pruneInstalledPackageDist({
packageRoot,
expectedFiles: new Set(["dist/extensions/slack/package.json"]),
log: { log: vi.fn(), warn: vi.fn() },
}),
).toEqual(["dist/stale-runtime.js"]);
});
it("unlinks stale files instead of recursive pruning them", () => {
const unlinkSync = vi.fn();
expect(
pruneInstalledPackageDist({
packageRoot: "/pkg",
expectedFiles: new Set(),
existsSync: vi.fn(() => true),
lstatSync: vi.fn(() => ({
isDirectory: () => true,
isSymbolicLink: () => false,
})),
realpathSync: vi.fn((filePath) => filePath),
readdirSync: vi.fn((filePath, options) => {
if (filePath === "/pkg/dist" && options?.withFileTypes) {
return [
{
name: "stale.js",
isDirectory: () => false,
isFile: () => true,
isSymbolicLink: () => false,
},
];
}
return [];
}),
unlinkSync,
log: { log: vi.fn(), warn: vi.fn() },
}),
).toEqual(["dist/stale.js"]);
expect(unlinkSync).toHaveBeenCalledWith("/pkg/dist/stale.js");
});
it("runs nested local installs with sanitized env when the sentinel package is missing", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writePluginPackage(extensionsDir, "acpx", {
dependencies: {
acpx: "0.4.1",
},
});
const spawnSync = vi.fn(() => ({ status: 0, stderr: "", stdout: "" }));
runBundledPluginPostinstall({
env: {
OPENCLAW_EAGER_BUNDLED_PLUGIN_DEPS: "1",
npm_config_global: "true",
npm_config_location: "global",
npm_config_prefix: "/opt/homebrew",
HOME: "/tmp/home",
},
extensionsDir,
packageRoot,
npmRunner: createBareNpmRunner(["acpx@0.4.1"]),
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expectNpmInstallSpawn(spawnSync, packageRoot, ["acpx@0.4.1"]);
});
it("skips reinstall when the bundled sentinel package already exists", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writePluginPackage(extensionsDir, "acpx", {
dependencies: {
acpx: "0.4.1",
},
});
await fs.mkdir(path.join(packageRoot, "node_modules", "acpx"), { recursive: true });
await fs.writeFile(
path.join(packageRoot, "node_modules", "acpx", "package.json"),
"{}\n",
"utf8",
);
const spawnSync = vi.fn();
runBundledPluginPostinstall({
env: { npm_config_global: "true" },
extensionsDir,
packageRoot,
spawnSync,
});
expect(spawnSync).not.toHaveBeenCalled();
});
it("reinstalls bundled runtime deps when optional native children are missing", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writeDiscordDaveyOptionalDependencyFixture(extensionsDir, packageRoot);
const spawnSync = vi.fn(() => ({ status: 0, stderr: "", stdout: "" }));
runBundledPluginPostinstall({
env: { HOME: "/tmp/home", OPENCLAW_EAGER_BUNDLED_PLUGIN_DEPS: "1" },
extensionsDir,
packageRoot,
arch: "arm64",
npmRunner: createBareNpmRunner(["@snazzah/davey@0.1.11"]),
platform: "win32",
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expectNpmInstallSpawn(spawnSync, packageRoot, ["@snazzah/davey@0.1.11"]);
});
it("does not reinstall when only another platform optional native child is missing", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writeDiscordDaveyOptionalDependencyFixture(extensionsDir, packageRoot);
const spawnSync = vi.fn();
runBundledPluginPostinstall({
env: { HOME: "/tmp/home" },
extensionsDir,
packageRoot,
arch: "arm64",
platform: "darwin",
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expect(spawnSync).not.toHaveBeenCalled();
});
it("discovers bundled plugin runtime deps from extension manifests", async () => {
const extensionsDir = await createExtensionsDir();
await writePluginPackage(extensionsDir, "slack", {
dependencies: {
"@slack/web-api": "7.11.0",
},
});
await writePluginPackage(extensionsDir, "amazon-bedrock", {
dependencies: {
"@aws-sdk/client-bedrock": "3.1020.0",
},
});
expect(discoverBundledPluginRuntimeDeps({ extensionsDir })).toEqual(
expect.arrayContaining([
{
name: "@slack/web-api",
pluginIds: ["slack"],
sentinelPath: path.join("node_modules", "@slack", "web-api", "package.json"),
version: "7.11.0",
},
{
name: "@aws-sdk/client-bedrock",
pluginIds: ["amazon-bedrock"],
sentinelPath: path.join("node_modules", "@aws-sdk", "client-bedrock", "package.json"),
version: "3.1020.0",
},
]),
);
});
it("merges duplicate bundled runtime deps across plugins", async () => {
const extensionsDir = await createExtensionsDir();
await writePluginPackage(extensionsDir, "slack", {
dependencies: {
"https-proxy-agent": "^8.0.0",
},
});
await writePluginPackage(extensionsDir, "feishu", {
dependencies: {
"https-proxy-agent": "^8.0.0",
},
});
expect(discoverBundledPluginRuntimeDeps({ extensionsDir })).toEqual(
expect.arrayContaining([
{
name: "https-proxy-agent",
pluginIds: ["feishu", "slack"],
sentinelPath: path.join("node_modules", "https-proxy-agent", "package.json"),
version: "^8.0.0",
},
]),
);
});
it("installs missing bundled plugin runtime deps during global installs", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writePluginPackage(extensionsDir, "slack", {
dependencies: {
"@slack/web-api": "7.11.0",
},
});
await writePluginPackage(extensionsDir, "telegram", {
dependencies: {
grammy: "1.38.4",
},
});
const spawnSync = vi.fn(() => ({ status: 0, stderr: "", stdout: "" }));
runBundledPluginPostinstall({
env: {
OPENCLAW_EAGER_BUNDLED_PLUGIN_DEPS: "1",
npm_config_global: "true",
npm_config_location: "global",
npm_config_prefix: "/opt/homebrew",
HOME: "/tmp/home",
},
extensionsDir,
packageRoot,
npmRunner: createBareNpmRunner(["@slack/web-api@7.11.0", "grammy@1.38.4"]),
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expectNpmInstallSpawn(spawnSync, packageRoot, ["@slack/web-api@7.11.0", "grammy@1.38.4"]);
});
it("installs only missing bundled plugin runtime deps", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writePluginPackage(extensionsDir, "slack", {
dependencies: {
"@slack/web-api": "7.11.0",
},
});
await writePluginPackage(extensionsDir, "telegram", {
dependencies: {
grammy: "1.38.4",
},
});
await fs.mkdir(path.join(packageRoot, "node_modules", "@slack", "web-api"), {
recursive: true,
});
await fs.writeFile(
path.join(packageRoot, "node_modules", "@slack", "web-api", "package.json"),
"{}\n",
);
const spawnSync = vi.fn(() => ({ status: 0, stderr: "", stdout: "" }));
runBundledPluginPostinstall({
env: {
OPENCLAW_EAGER_BUNDLED_PLUGIN_DEPS: "1",
HOME: "/tmp/home",
},
extensionsDir,
packageRoot,
npmRunner: createBareNpmRunner(["grammy@1.38.4"]),
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expectNpmInstallSpawn(spawnSync, packageRoot, ["grammy@1.38.4"]);
});
it("installs bundled plugin deps when npm location is global", async () => {
const extensionsDir = await createExtensionsDir();
const packageRoot = path.dirname(path.dirname(extensionsDir));
await writePluginPackage(extensionsDir, "telegram", {
dependencies: {
grammy: "1.38.4",
},
});
const spawnSync = vi.fn(() => ({ status: 0, stderr: "", stdout: "" }));
runBundledPluginPostinstall({
env: {
OPENCLAW_EAGER_BUNDLED_PLUGIN_DEPS: "1",
npm_config_location: "global",
npm_config_prefix: "/opt/homebrew",
HOME: "/tmp/home",
},
extensionsDir,
packageRoot,
npmRunner: createBareNpmRunner(["grammy@1.38.4"]),
spawnSync,
log: { log: vi.fn(), warn: vi.fn() },
});
expectNpmInstallSpawn(spawnSync, packageRoot, ["grammy@1.38.4"]);
});
it("prunes only bundled plugin package node_modules in source checkouts", async () => {
const packageRoot = await createTempDirAsync("openclaw-source-prune-");
const extensionsDir = path.join(packageRoot, "extensions");
await fs.mkdir(path.join(extensionsDir, "acpx", "node_modules"), { recursive: true });
await fs.mkdir(path.join(extensionsDir, "fixtures", "node_modules"), { recursive: true });
await fs.writeFile(
path.join(extensionsDir, "acpx", "package.json"),
JSON.stringify({ name: "@openclaw/acpx" }),
);
pruneBundledPluginSourceNodeModules({ extensionsDir });
await expect(fs.stat(path.join(extensionsDir, "acpx", "node_modules"))).rejects.toMatchObject({
code: "ENOENT",
});
await expect(
fs.stat(path.join(extensionsDir, "fixtures", "node_modules")),
).resolves.toBeTruthy();
});
it("skips symlink entries when pruning source-checkout bundled plugin node_modules", () => {
const removePath = vi.fn();
pruneBundledPluginSourceNodeModules({
extensionsDir: "/repo/extensions",
existsSync: vi.fn((value) => value === "/repo/extensions"),
readdirSync: vi.fn(() => [
{
name: "acpx",
isDirectory: () => true,
isSymbolicLink: () => true,
},
]),
rmSync: removePath,
});
expect(removePath).not.toHaveBeenCalled();
});
});