Files
miti99bot/tests/modules/registry.test.js
tiennm99 c4314f21df feat: scaffold plug-n-play telegram bot on cloudflare workers
grammY-based bot with a module plugin system loaded from the MODULES env
var. Three command visibility levels (public/protected/private) share a
unified command namespace with conflict detection at registry build.

- 4 initial modules (util, wordle, loldle, misc); util fully implemented,
  others are stubs proving the plugin system end-to-end
- util: /info (chat/thread/sender ids) + /help (pure renderer over the
  registry, HTML parse mode, escapes user-influenced strings)
- KVStore interface with CFKVStore and a per-module prefixing factory;
  getJSON/putJSON convenience helpers; other backends drop in via one file
- Webhook at POST /webhook with secret-token validation via grammY's
  webhookCallback; no admin HTTP surface
- Post-deploy register script (npm run deploy = wrangler deploy && node
  --env-file=.env.deploy scripts/register.js) for setWebhook and
  setMyCommands; --dry-run flag for preview
- 56 vitest unit tests across 7 suites covering registry, db wrapper,
  dispatcher, help renderer, validators, and HTML escaper
- biome for lint + format; phased implementation plan under plans/
2026-04-11 09:49:06 +07:00

155 lines
5.6 KiB
JavaScript

import { beforeEach, describe, expect, it, vi } from "vitest";
import {
buildRegistry,
getCurrentRegistry,
loadModules,
resetRegistry,
} from "../../src/modules/registry.js";
import { makeFakeKv } from "../fakes/fake-kv-namespace.js";
import { makeCommand, makeFakeImportMap, makeModule } from "../fakes/fake-modules.js";
const makeEnv = (modules) => ({ MODULES: modules, KV: makeFakeKv() });
describe("registry", () => {
beforeEach(() => resetRegistry());
describe("loadModules", () => {
it("loads modules listed in env.MODULES", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")]),
b: makeModule("b", [makeCommand("bar", "public")]),
});
const mods = await loadModules({ MODULES: "a,b" }, map);
expect(mods.map((m) => m.name)).toEqual(["a", "b"]);
});
it("trims, dedupes, skips empty", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")]),
});
const mods = await loadModules({ MODULES: " a , a , " }, map);
expect(mods).toHaveLength(1);
});
it("throws on empty MODULES", async () => {
await expect(loadModules({ MODULES: "" }, {})).rejects.toThrow(/empty/);
await expect(loadModules({}, {})).rejects.toThrow(/empty/);
});
it("throws on unknown module name", async () => {
await expect(loadModules({ MODULES: "ghost" }, {})).rejects.toThrow(/unknown module: ghost/);
});
it("throws when default export name mismatches key", async () => {
const map = makeFakeImportMap({ a: makeModule("b", []) });
await expect(loadModules({ MODULES: "a" }, map)).rejects.toThrow(/mismatched name/);
});
it("throws when module has no commands array", async () => {
const map = {
a: async () => ({ default: { name: "a" } }),
};
await expect(loadModules({ MODULES: "a" }, map)).rejects.toThrow(/commands array/);
});
it("runs validateCommand on each command", async () => {
const badMap = makeFakeImportMap({
a: makeModule("a", [
{ name: "/bad", visibility: "public", description: "x", handler: async () => {} },
]),
});
await expect(loadModules({ MODULES: "a" }, badMap)).rejects.toThrow();
});
});
describe("buildRegistry", () => {
it("partitions commands across visibility maps + flat allCommands", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [
makeCommand("pub", "public"),
makeCommand("prot", "protected"),
makeCommand("priv", "private"),
]),
});
const reg = await buildRegistry(makeEnv("a"), map);
expect([...reg.publicCommands.keys()]).toEqual(["pub"]);
expect([...reg.protectedCommands.keys()]).toEqual(["prot"]);
expect([...reg.privateCommands.keys()]).toEqual(["priv"]);
expect([...reg.allCommands.keys()].sort()).toEqual(["priv", "prot", "pub"]);
});
it("throws on same-visibility conflict", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")]),
b: makeModule("b", [makeCommand("foo", "public")]),
});
await expect(buildRegistry(makeEnv("a,b"), map)).rejects.toThrow(/conflict.*foo.*a.*b/);
});
it("throws on CROSS-visibility conflict (unified namespace)", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")]),
b: makeModule("b", [makeCommand("foo", "private")]),
});
await expect(buildRegistry(makeEnv("a,b"), map)).rejects.toThrow(/conflict.*foo/);
});
it("calls init({db, env}) exactly once per module, in order", async () => {
const calls = [];
const makeInit =
(name) =>
async ({ db, env }) => {
calls.push({ name, hasDb: !!db, hasEnv: !!env });
await db.put("sentinel", "x");
};
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("one", "public")], makeInit("a")),
b: makeModule("b", [makeCommand("two", "public")], makeInit("b")),
});
const env = makeEnv("a,b");
await buildRegistry(env, map);
expect(calls).toEqual([
{ name: "a", hasDb: true, hasEnv: true },
{ name: "b", hasDb: true, hasEnv: true },
]);
// Assert prefixing: keys landed as "a:sentinel" and "b:sentinel".
expect(env.KV.store.get("a:sentinel")).toBe("x");
expect(env.KV.store.get("b:sentinel")).toBe("x");
});
it("wraps init errors with module name", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")], async () => {
throw new Error("boom");
}),
});
await expect(buildRegistry(makeEnv("a"), map)).rejects.toThrow(
/module "a" init failed.*boom/,
);
});
});
describe("getCurrentRegistry / resetRegistry", () => {
it("getCurrentRegistry throws before build", () => {
expect(() => getCurrentRegistry()).toThrow(/not built/);
});
it("getCurrentRegistry returns the same instance after build", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")]),
});
const reg = await buildRegistry(makeEnv("a"), map);
expect(getCurrentRegistry()).toBe(reg);
});
it("resetRegistry clears the memoized registry", async () => {
const map = makeFakeImportMap({
a: makeModule("a", [makeCommand("foo", "public")]),
});
await buildRegistry(makeEnv("a"), map);
resetRegistry();
expect(() => getCurrentRegistry()).toThrow(/not built/);
});
});
});