emdash-cms--emdash/packages/core/tests/unit/plugins/define-plugin.test.ts

/**
 * definePlugin() Tests
 *
 * Tests the plugin definition helper for:
 * - ID validation (simple and scoped formats)
 * - Version validation (semver)
 * - Capability validation and normalization
 * - Hook resolution (function vs config object)
 * - Default value handling
 */

import { describe, it, expect, vi } from "vitest";

import { definePlugin } from "../../../src/plugins/define-plugin.js";

// Error message patterns for test assertions
const INVALID_PLUGIN_ID_PATTERN = /Invalid plugin id/;
const INVALID_PLUGIN_VERSION_PATTERN = /Invalid plugin version/;
const INVALID_CAPABILITY_PATTERN = /Invalid capability/;

describe("definePlugin", () => {
	describe("ID validation", () => {
		it("accepts valid simple ID", () => {
			const plugin = definePlugin({
				id: "my-plugin",
				version: "1.0.0",
			});

			expect(plugin.id).toBe("my-plugin");
		});

		it("accepts valid simple ID with numbers", () => {
			const plugin = definePlugin({
				id: "plugin-v2",
				version: "1.0.0",
			});

			expect(plugin.id).toBe("plugin-v2");
		});

		it("accepts valid scoped ID", () => {
			const plugin = definePlugin({
				id: "@emdash-cms/seo-plugin",
				version: "1.0.0",
			});

			expect(plugin.id).toBe("@emdash-cms/seo-plugin");
		});

		it("accepts scoped ID with numbers", () => {
			const plugin = definePlugin({
				id: "@my-org/plugin-v2",
				version: "1.0.0",
			});

			expect(plugin.id).toBe("@my-org/plugin-v2");
		});

		it("rejects ID with uppercase letters", () => {
			expect(() =>
				definePlugin({
					id: "MyPlugin",
					version: "1.0.0",
				}),
			).toThrow(INVALID_PLUGIN_ID_PATTERN);
		});

		it("rejects ID with underscores", () => {
			expect(() =>
				definePlugin({
					id: "my_plugin",
					version: "1.0.0",
				}),
			).toThrow(INVALID_PLUGIN_ID_PATTERN);
		});

		it("rejects ID with spaces", () => {
			expect(() =>
				definePlugin({
					id: "my plugin",
					version: "1.0.0",
				}),
			).toThrow(INVALID_PLUGIN_ID_PATTERN);
		});

		it("rejects empty ID", () => {
			// Empty id is treated as "no id" — same code path as the
			// sandboxed-shape rejection, with a pointer at the new
			// `satisfies SandboxedPlugin` authoring flow.
			expect(() =>
				definePlugin({
					id: "",
					version: "1.0.0",
				}),
			).toThrow(/requires `id`/);
		});

		it("rejects invalid scoped ID (missing name)", () => {
			expect(() =>
				definePlugin({
					id: "@my-org/",
					version: "1.0.0",
				}),
			).toThrow(INVALID_PLUGIN_ID_PATTERN);
		});

		it("rejects invalid scoped ID (missing scope)", () => {
			expect(() =>
				definePlugin({
					id: "@/my-plugin",
					version: "1.0.0",
				}),
			).toThrow(INVALID_PLUGIN_ID_PATTERN);
		});
	});

	describe("version validation", () => {
		it("accepts valid semver", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
			});

			expect(plugin.version).toBe("1.0.0");
		});

		it("accepts semver with prerelease", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0-beta.1",
			});

			expect(plugin.version).toBe("1.0.0-beta.1");
		});

		it("accepts semver with build metadata", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0+build.123",
			});

			expect(plugin.version).toBe("1.0.0+build.123");
		});

		it("rejects invalid version format", () => {
			expect(() =>
				definePlugin({
					id: "test",
					version: "1.0",
				}),
			).toThrow(INVALID_PLUGIN_VERSION_PATTERN);
		});

		it("rejects non-numeric version", () => {
			expect(() =>
				definePlugin({
					id: "test",
					version: "latest",
				}),
			).toThrow(INVALID_PLUGIN_VERSION_PATTERN);
		});
	});

	// Regression: #1370 — the id/version validation patterns must stay
	// function-local (evaluated at call time). As module-scope consts, a
	// circular module init on Cloudflare Workers could reach defineNativePlugin
	// before they initialized, throwing "Cannot access 'SIMPLE_ID' before
	// initialization" and 500-ing every route. Validation must keep working.
	describe("#1370 — call-time validation regexes", () => {
		it("validates id and version on every call", () => {
			expect(definePlugin({ id: "first", version: "1.0.0" }).id).toBe("first");
			expect(definePlugin({ id: "@scope/second", version: "2.3.4" }).version).toBe("2.3.4");
			expect(() => definePlugin({ id: "Bad_Id", version: "1.0.0" })).toThrow(
				INVALID_PLUGIN_ID_PATTERN,
			);
			expect(() => definePlugin({ id: "ok", version: "nope" })).toThrow(
				INVALID_PLUGIN_VERSION_PATTERN,
			);
		});
	});

	describe("capability validation", () => {
		it("accepts valid capabilities", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["content:read", "content:write", "network:request"],
			});

			expect(plugin.capabilities).toContain("content:read");
			expect(plugin.capabilities).toContain("content:write");
			expect(plugin.capabilities).toContain("network:request");
		});

		it("accepts media:read and media:write", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["media:read", "media:write"],
			});

			expect(plugin.capabilities).toContain("media:read");
			expect(plugin.capabilities).toContain("media:write");
		});

		it("rejects invalid capability", () => {
			expect(() =>
				definePlugin({
					id: "test",
					version: "1.0.0",
					capabilities: ["invalid:capability" as any],
				}),
			).toThrow(INVALID_CAPABILITY_PATTERN);
		});

		it("normalizes content:write to include content:read", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["content:write"],
			});

			expect(plugin.capabilities).toContain("content:write");
			expect(plugin.capabilities).toContain("content:read");
		});

		it("normalizes media:write to include media:read", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["media:write"],
			});

			expect(plugin.capabilities).toContain("media:write");
			expect(plugin.capabilities).toContain("media:read");
		});

		it("normalizes network:request:unrestricted to include network:request", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["network:request:unrestricted"],
			});

			expect(plugin.capabilities).toContain("network:request:unrestricted");
			expect(plugin.capabilities).toContain("network:request");
		});

		it("does not duplicate read when already present", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["content:read", "content:write"],
			});

			const readCount = plugin.capabilities.filter((c) => c === "content:read").length;
			expect(readCount).toBe(1);
		});

		it("defaults to empty capabilities", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
			});

			expect(plugin.capabilities).toEqual([]);
		});

		// ── Deprecation alias layer ────────────────────────────────
		// During the deprecation window we accept the old names and
		// silently rewrite them to the new names. The runtime should
		// only ever see canonical (new) names.

		it("accepts and normalizes deprecated capability names", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: [
					"read:content",
					"write:content",
					"read:media",
					"write:media",
					"read:users",
					"network:fetch",
					"network:fetch:any",
					"email:provide",
					"email:intercept",
					"page:inject",
				],
			});

			// Normalized to current names
			expect(plugin.capabilities).toContain("content:read");
			expect(plugin.capabilities).toContain("content:write");
			expect(plugin.capabilities).toContain("media:read");
			expect(plugin.capabilities).toContain("media:write");
			expect(plugin.capabilities).toContain("users:read");
			expect(plugin.capabilities).toContain("network:request");
			expect(plugin.capabilities).toContain("network:request:unrestricted");
			expect(plugin.capabilities).toContain("hooks.email-transport:register");
			expect(plugin.capabilities).toContain("hooks.email-events:register");
			expect(plugin.capabilities).toContain("hooks.page-fragments:register");

			// And the deprecated names do NOT appear in the resolved capabilities
			expect(plugin.capabilities).not.toContain("read:content");
			expect(plugin.capabilities).not.toContain("write:content");
			expect(plugin.capabilities).not.toContain("network:fetch");
			expect(plugin.capabilities).not.toContain("network:fetch:any");
			expect(plugin.capabilities).not.toContain("email:provide");
			expect(plugin.capabilities).not.toContain("email:intercept");
			expect(plugin.capabilities).not.toContain("page:inject");
		});

		it("deduplicates when both deprecated and current names are passed", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				// Same capability, both spellings
				capabilities: ["read:content", "content:read"],
			});

			const readCount = plugin.capabilities.filter((c) => c === "content:read").length;
			expect(readCount).toBe(1);
		});

		it("normalizes deprecated names before applying implications", () => {
			// `write:content` (deprecated) should still imply `content:read`
			// after rewrite, not `read:content`.
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				capabilities: ["write:content"],
			});

			expect(plugin.capabilities).toContain("content:write");
			expect(plugin.capabilities).toContain("content:read");
			expect(plugin.capabilities).not.toContain("write:content");
			expect(plugin.capabilities).not.toContain("read:content");
		});
	});

	describe("hook resolution", () => {
		it("resolves function shorthand to full config", () => {
			const handler = vi.fn();
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				hooks: {
					"content:beforeSave": handler,
				},
			});

			const hook = plugin.hooks["content:beforeSave"];
			expect(hook).toBeDefined();
			expect(hook!.handler).toBe(handler);
			expect(hook!.priority).toBe(100);
			expect(hook!.timeout).toBe(5000);
			expect(hook!.dependencies).toEqual([]);
			expect(hook!.errorPolicy).toBe("abort");
			expect(hook!.pluginId).toBe("test");
		});

		it("resolves full config object", () => {
			const handler = vi.fn();
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				hooks: {
					"content:beforeSave": {
						handler,
						priority: 50,
						timeout: 10000,
						dependencies: ["other-plugin"],
						errorPolicy: "continue",
					},
				},
			});

			const hook = plugin.hooks["content:beforeSave"];
			expect(hook).toBeDefined();
			expect(hook!.handler).toBe(handler);
			expect(hook!.priority).toBe(50);
			expect(hook!.timeout).toBe(10000);
			expect(hook!.dependencies).toEqual(["other-plugin"]);
			expect(hook!.errorPolicy).toBe("continue");
		});

		it("applies defaults to partial config", () => {
			const handler = vi.fn();
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				hooks: {
					"content:afterSave": {
						handler,
						priority: 200,
						// timeout, dependencies, errorPolicy use defaults
					},
				},
			});

			const hook = plugin.hooks["content:afterSave"];
			expect(hook!.priority).toBe(200);
			expect(hook!.timeout).toBe(5000);
			expect(hook!.dependencies).toEqual([]);
			expect(hook!.errorPolicy).toBe("abort");
		});

		it("resolves multiple hooks", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				hooks: {
					"content:beforeSave": vi.fn(),
					"content:afterSave": vi.fn(),
					"plugin:install": vi.fn(),
				},
			});

			expect(plugin.hooks["content:beforeSave"]).toBeDefined();
			expect(plugin.hooks["content:afterSave"]).toBeDefined();
			expect(plugin.hooks["plugin:install"]).toBeDefined();
		});

		it("sets pluginId on all resolved hooks", () => {
			const plugin = definePlugin({
				id: "my-plugin",
				version: "1.0.0",
				hooks: {
					"content:beforeSave": vi.fn(),
					"media:afterUpload": { handler: vi.fn(), priority: 50 },
				},
			});

			expect(plugin.hooks["content:beforeSave"]!.pluginId).toBe("my-plugin");
			expect(plugin.hooks["media:afterUpload"]!.pluginId).toBe("my-plugin");
		});
	});

	describe("default values", () => {
		it("defaults allowedHosts to empty array", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
			});

			expect(plugin.allowedHosts).toEqual([]);
		});

		it("defaults storage to empty object", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
			});

			expect(plugin.storage).toEqual({});
		});

		it("defaults hooks to empty object", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
			});

			expect(plugin.hooks).toEqual({});
		});

		it("defaults routes to empty object", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
			});

			expect(plugin.routes).toEqual({});
		});

		it("preserves provided allowedHosts", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				allowedHosts: ["api.example.com", "*.cdn.com"],
			});

			expect(plugin.allowedHosts).toEqual(["api.example.com", "*.cdn.com"]);
		});

		it("preserves provided storage config", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				storage: {
					items: { indexes: ["type", "status"] },
					cache: { indexes: ["key"] },
				},
			});

			expect(plugin.storage).toEqual({
				items: { indexes: ["type", "status"] },
				cache: { indexes: ["key"] },
			});
		});
	});

	describe("routes passthrough", () => {
		it("preserves route definitions", () => {
			const handler = vi.fn();
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				routes: {
					sync: { handler },
					webhook: { handler, input: {} as any },
				},
			});

			expect(plugin.routes.sync).toBeDefined();
			expect(plugin.routes.sync.handler).toBe(handler);
			expect(plugin.routes.webhook).toBeDefined();
		});
	});

	describe("admin passthrough", () => {
		it("preserves admin config", () => {
			const plugin = definePlugin({
				id: "test",
				version: "1.0.0",
				admin: {
					entry: "@test/plugin/admin",
					pages: [{ id: "settings", title: "Settings" }],
					widgets: [{ id: "stats", title: "Stats", area: "dashboard" }],
				},
			});

			expect(plugin.admin.entry).toBe("@test/plugin/admin");
			expect(plugin.admin.pages).toHaveLength(1);
			expect(plugin.admin.widgets).toHaveLength(1);
		});
	});
});