Files
clawdbot/src/plugins/install.test.ts
2026-01-12 01:27:01 +00:00

194 lines
5.2 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { randomUUID } from "node:crypto";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
const tempDirs: string[] = [];
function makeTempDir() {
const dir = path.join(os.tmpdir(), `clawdbot-plugin-install-${randomUUID()}`);
fs.mkdirSync(dir, { recursive: true });
tempDirs.push(dir);
return dir;
}
function packToArchive({
pkgDir,
outDir,
outName,
}: {
pkgDir: string;
outDir: string;
outName: string;
}) {
const res = spawnSync(
"npm",
["pack", "--silent", "--pack-destination", outDir, pkgDir],
{
encoding: "utf-8",
},
);
expect(res.status).toBe(0);
if (res.status !== 0) {
throw new Error(
`npm pack failed: ${res.stderr || res.stdout || "<no output>"}`,
);
}
const packed = (res.stdout || "")
.trim()
.split(/\r?\n/)
.filter(Boolean)
.at(-1);
if (!packed) {
throw new Error(
`npm pack did not output a filename: ${res.stdout || "<no stdout>"}`,
);
}
const src = path.join(outDir, packed);
const dest = path.join(outDir, outName);
fs.rmSync(dest, { force: true });
fs.renameSync(src, dest);
return dest;
}
async function withStateDir<T>(stateDir: string, fn: () => Promise<T>) {
const prev = process.env.CLAWDBOT_STATE_DIR;
process.env.CLAWDBOT_STATE_DIR = stateDir;
vi.resetModules();
try {
return await fn();
} finally {
if (prev === undefined) {
delete process.env.CLAWDBOT_STATE_DIR;
} else {
process.env.CLAWDBOT_STATE_DIR = prev;
}
vi.resetModules();
}
}
afterEach(() => {
for (const dir of tempDirs.splice(0)) {
try {
fs.rmSync(dir, { recursive: true, force: true });
} catch {
// ignore cleanup failures
}
}
});
describe("installPluginFromArchive", () => {
it("installs into ~/.clawdbot/extensions and uses unscoped id", async () => {
const stateDir = makeTempDir();
const workDir = makeTempDir();
const pkgDir = path.join(workDir, "package");
fs.mkdirSync(path.join(pkgDir, "dist"), { recursive: true });
fs.writeFileSync(
path.join(pkgDir, "package.json"),
JSON.stringify({
name: "@clawdbot/voice-call",
version: "0.0.1",
clawdbot: { extensions: ["./dist/index.js"] },
}),
"utf-8",
);
fs.writeFileSync(
path.join(pkgDir, "dist", "index.js"),
"export {};",
"utf-8",
);
const archivePath = packToArchive({
pkgDir,
outDir: workDir,
outName: "plugin.tgz",
});
const result = await withStateDir(stateDir, async () => {
const { installPluginFromArchive } = await import("./install.js");
return await installPluginFromArchive({ archivePath });
});
expect(result.ok).toBe(true);
if (!result.ok) return;
expect(result.pluginId).toBe("voice-call");
expect(result.targetDir).toBe(
path.join(stateDir, "extensions", "voice-call"),
);
expect(fs.existsSync(path.join(result.targetDir, "package.json"))).toBe(
true,
);
expect(fs.existsSync(path.join(result.targetDir, "dist", "index.js"))).toBe(
true,
);
});
it("rejects installing when plugin already exists", async () => {
const stateDir = makeTempDir();
const workDir = makeTempDir();
const pkgDir = path.join(workDir, "package");
fs.mkdirSync(path.join(pkgDir, "dist"), { recursive: true });
fs.writeFileSync(
path.join(pkgDir, "package.json"),
JSON.stringify({
name: "@clawdbot/voice-call",
version: "0.0.1",
clawdbot: { extensions: ["./dist/index.js"] },
}),
"utf-8",
);
fs.writeFileSync(
path.join(pkgDir, "dist", "index.js"),
"export {};",
"utf-8",
);
const archivePath = packToArchive({
pkgDir,
outDir: workDir,
outName: "plugin.tgz",
});
const { first, second } = await withStateDir(stateDir, async () => {
const { installPluginFromArchive } = await import("./install.js");
const first = await installPluginFromArchive({ archivePath });
const second = await installPluginFromArchive({ archivePath });
return { first, second };
});
expect(first.ok).toBe(true);
expect(second.ok).toBe(false);
if (second.ok) return;
expect(second.error).toContain("already exists");
});
it("rejects packages without clawdbot.extensions", async () => {
const stateDir = makeTempDir();
const workDir = makeTempDir();
const pkgDir = path.join(workDir, "package");
fs.mkdirSync(pkgDir, { recursive: true });
fs.writeFileSync(
path.join(pkgDir, "package.json"),
JSON.stringify({ name: "@clawdbot/nope", version: "0.0.1" }),
"utf-8",
);
const archivePath = packToArchive({
pkgDir,
outDir: workDir,
outName: "bad.tgz",
});
const result = await withStateDir(stateDir, async () => {
const { installPluginFromArchive } = await import("./install.js");
return await installPluginFromArchive({ archivePath });
});
expect(result.ok).toBe(false);
if (result.ok) return;
expect(result.error).toContain("clawdbot.extensions");
});
});