Expose plugin registry API

2026-05-08 16:37:20 -04:00
parent b7e1cd33e2
commit e6eda3bf1f
4 changed files with 891 additions and 1 deletions
@@ -3,12 +3,16 @@ import { describe, it } from "node:test";

 import type { Env } from "../src/bindings.js";
 import { handleRequest } from "../src/index.js";
+import { pluginRegistryKvKey } from "../src/plugin_registry.js";
 import { releaseManifestKvKey } from "../src/release_manifests.js";
 import { publicSigningKeysKvKey } from "../src/signing_keys.js";

 const PUBLIC_KEY = "a".repeat(64);
 const RELEASE_SIGNATURE = "b".repeat(128);
 const RELEASE_SHA256 = "c".repeat(64);
+const PLUGIN_CHECKSUM = "d".repeat(64);
+const PLUGIN_PACKAGE_SHA256 = "e".repeat(64);
+const PLUGIN_SIGNATURE = "f".repeat(128);

 describe("worker routes", () => {
  it("returns public plugin signing keys from KV", async () => {
@@ -78,6 +82,123 @@ describe("worker routes", () => {
    assert.deepEqual(await response.json(), { error: "not_found" });
  });

+  it("returns public plugin catalog from KV", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins"),
+      testEnv(null, null, pluginRegistryDocument()),
+    );
+
+    assert.equal(response.status, 200);
+    assert.equal(
+      response.headers.get("cache-control"),
+      "public, max-age=300, stale-while-revalidate=60",
+    );
+    assert.deepEqual(await response.json(), {
+      version: 1,
+      generated_at: "2026-05-08T00:00:00.000Z",
+      plugins: [
+        {
+          id: "elydora.reader",
+          name: "Reader",
+          description: "Reading workflow tools.",
+          author: "Elydora",
+          homepage: "https://elydora.com/plugins/reader",
+          permissions: ["page:metadata", "ui:command"],
+          contributes: ["command-bar-command"],
+          min_ely_build: "0.1.0",
+        },
+      ],
+    });
+  });
+
+  it("returns public plugin details from KV", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins/elydora.reader"),
+      testEnv(null, null, pluginRegistryDocument()),
+    );
+
+    assert.equal(response.status, 200);
+    assert.deepEqual(await response.json(), {
+      version: 1,
+      generated_at: "2026-05-08T00:00:00.000Z",
+      plugin: {
+        id: "elydora.reader",
+        name: "Reader",
+        description: "Reading workflow tools.",
+        author: "Elydora",
+        homepage: "https://elydora.com/plugins/reader",
+        permissions: ["page:metadata", "ui:command"],
+        contributes: ["command-bar-command"],
+        min_ely_build: "0.1.0",
+        checksum: PLUGIN_CHECKSUM,
+        signature: {
+          algorithm: "ed25519",
+          key_id: "elydora-alpha-plugins",
+          public_key: PUBLIC_KEY,
+          value: PLUGIN_SIGNATURE,
+        },
+      },
+    });
+  });
+
+  it("returns public plugin package download information", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins/elydora.reader/package"),
+      testEnv(null, null, pluginRegistryDocument()),
+    );
+
+    assert.equal(response.status, 200);
+    assert.deepEqual(await response.json(), {
+      version: 1,
+      plugin_id: "elydora.reader",
+      url: "https://downloads.elydora.com/plugins/reader/0.1.0/reader.rplug",
+      sha256: PLUGIN_PACKAGE_SHA256,
+      signature: PLUGIN_SIGNATURE,
+      size_bytes: 65536,
+    });
+  });
+
+  it("rejects unsupported methods on public plugin catalog", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins", { method: "POST" }),
+      testEnv(null, null, pluginRegistryDocument()),
+    );
+
+    assert.equal(response.status, 405);
+    assert.equal(response.headers.get("allow"), "GET");
+    assert.deepEqual(await response.json(), { error: "method_not_allowed" });
+  });
+
+  it("returns service unavailable when plugin registry is missing", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins"),
+      testEnv(null),
+    );
+
+    assert.equal(response.status, 503);
+    assert.deepEqual(await response.json(), { error: "plugin_registry_unavailable" });
+  });
+
+  it("returns a generic server error for malformed plugin registry", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins"),
+      testEnv(null, null, "{"),
+    );
+
+    assert.equal(response.status, 500);
+    assert.deepEqual(await response.json(), { error: "plugin_registry_invalid" });
+  });
+
+  it("returns not found for unknown public plugins", async () => {
+    const response = await handleRequest(
+      new Request("https://elydora.test/api/plugins/elydora.unknown"),
+      testEnv(null, null, pluginRegistryDocument()),
+    );
+
+    assert.equal(response.status, 404);
+    assert.deepEqual(await response.json(), { error: "plugin_not_found" });
+  });
+
  it("returns release manifest from KV", async () => {
    const env = testEnv(null, releaseManifestDocument());

@@ -202,7 +323,11 @@ describe("worker routes", () => {
  });
 });

-function testEnv(publicSigningKeys: string | null, releaseManifest?: string | null): Env {
+function testEnv(
+  publicSigningKeys: string | null,
+  releaseManifest?: string | null,
+  pluginRegistry?: string | null,
+): Env {
  const values = new Map<string, string>();
  if (publicSigningKeys !== null) {
    values.set(publicSigningKeysKvKey("local"), publicSigningKeys);
@@ -210,6 +335,9 @@ function testEnv(publicSigningKeys: string | null, releaseManifest?: string | nu
  if (releaseManifest !== undefined && releaseManifest !== null) {
    values.set(releaseManifestKvKey("local"), releaseManifest);
  }
+  if (pluginRegistry !== undefined && pluginRegistry !== null) {
+    values.set(pluginRegistryKvKey("local"), pluginRegistry);
+  }

  return {
    ELY_ENVIRONMENT: "local",
@@ -239,3 +367,34 @@ function releaseManifestDocument(): string {
    ],
  });
 }
+
+function pluginRegistryDocument(): string {
+  return JSON.stringify({
+    version: 1,
+    generated_at: "2026-05-08T00:00:00.000Z",
+    plugins: [
+      {
+        id: "elydora.reader",
+        name: "Reader",
+        description: "Reading workflow tools.",
+        author: "Elydora",
+        homepage: "https://elydora.com/plugins/reader",
+        permissions: ["page:metadata", "ui:command"],
+        contributes: ["command-bar-command"],
+        min_ely_build: "0.1.0",
+        checksum: PLUGIN_CHECKSUM,
+        signature: {
+          algorithm: "ed25519",
+          key_id: "elydora-alpha-plugins",
+          public_key: PUBLIC_KEY,
+          value: PLUGIN_SIGNATURE,
+        },
+        package: {
+          url: "https://downloads.elydora.com/plugins/reader/0.1.0/reader.rplug",
+          sha256: PLUGIN_PACKAGE_SHA256,
+          size_bytes: 65536,
+        },
+      },
+    ],
+  });
+}
@@ -0,0 +1,179 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+
+import {
+  PluginRegistrySchemaError,
+  parsePluginRegistryDocument,
+  pluginCatalogDocument,
+  pluginDetailsDocument,
+  pluginPackageDocument,
+  pluginRegistryKvKey,
+} from "../src/plugin_registry.js";
+
+const CHECKSUM = "a".repeat(64);
+const PACKAGE_SHA256 = "b".repeat(64);
+const PUBLIC_KEY = "c".repeat(64);
+const SIGNATURE = "d".repeat(128);
+
+describe("plugin registry", () => {
+  it("builds an environment-prefixed KV key", () => {
+    assert.equal(pluginRegistryKvKey("production"), "ely:production:plugin_registry_cache");
+  });
+
+  it("parses a valid plugin registry", () => {
+    const document = parsePluginRegistryDocument(validRegistry());
+
+    assert.deepEqual(document, {
+      version: 1,
+      generated_at: "2026-05-08T00:00:00.000Z",
+      plugins: [parsedPlugin()],
+    });
+  });
+
+  it("builds a public catalog document", () => {
+    const registry = parsePluginRegistryDocument(validRegistry());
+
+    assert.deepEqual(pluginCatalogDocument(registry), {
+      version: 1,
+      generated_at: "2026-05-08T00:00:00.000Z",
+      plugins: [
+        {
+          id: "elydora.reader",
+          name: "Reader",
+          description: "Reading workflow tools.",
+          author: "Elydora",
+          homepage: "https://elydora.com/plugins/reader",
+          permissions: ["page:metadata", "ui:command"],
+          contributes: ["command-bar-command"],
+          min_ely_build: "0.1.0",
+        },
+      ],
+    });
+  });
+
+  it("extracts plugin details and package download documents", () => {
+    const registry = parsePluginRegistryDocument(validRegistry());
+
+    assert.deepEqual(pluginDetailsDocument(registry, "elydora.reader"), {
+      version: 1,
+      generated_at: "2026-05-08T00:00:00.000Z",
+      plugin: {
+        id: "elydora.reader",
+        name: "Reader",
+        description: "Reading workflow tools.",
+        author: "Elydora",
+        homepage: "https://elydora.com/plugins/reader",
+        permissions: ["page:metadata", "ui:command"],
+        contributes: ["command-bar-command"],
+        min_ely_build: "0.1.0",
+        checksum: CHECKSUM,
+        signature: {
+          algorithm: "ed25519",
+          key_id: "elydora-alpha-plugins",
+          public_key: PUBLIC_KEY,
+          value: SIGNATURE,
+        },
+      },
+    });
+    assert.deepEqual(pluginPackageDocument(registry, "elydora.reader"), {
+      version: 1,
+      plugin_id: "elydora.reader",
+      url: "https://downloads.elydora.com/plugins/reader/0.1.0/reader.rplug",
+      sha256: PACKAGE_SHA256,
+      signature: SIGNATURE,
+      size_bytes: 65536,
+    });
+  });
+
+  it("rejects duplicate plugin ids", () => {
+    assert.throws(
+      () =>
+        parsePluginRegistryDocument(
+          validRegistry({
+            plugins: [validPlugin(), { ...validPlugin(), name: "Reader Copy" }],
+          }),
+        ),
+      PluginRegistrySchemaError,
+    );
+  });
+
+  it("rejects malformed permission and package URLs", () => {
+    assert.throws(
+      () =>
+        parsePluginRegistryDocument(
+          validRegistry({
+            plugins: [{ ...validPlugin(), permissions: ["tabs:admin"] }],
+          }),
+        ),
+      PluginRegistrySchemaError,
+    );
+    assert.throws(
+      () =>
+        parsePluginRegistryDocument(
+          validRegistry({
+            plugins: [
+              {
+                ...validPlugin(),
+                package: { ...validPluginPackage(), url: "http://downloads.elydora.com/a.rplug" },
+              },
+            ],
+          }),
+        ),
+      PluginRegistrySchemaError,
+    );
+  });
+});
+
+function validRegistry(overrides: Record<string, unknown> = {}): string {
+  return JSON.stringify({
+    version: 1,
+    generated_at: "2026-05-08T00:00:00.000Z",
+    plugins: [validPlugin()],
+    ...overrides,
+  });
+}
+
+function validPlugin(): Record<string, unknown> {
+  return {
+    id: "elydora.reader",
+    name: "Reader",
+    description: "Reading workflow tools.",
+    author: "Elydora",
+    homepage: "https://elydora.com/plugins/reader",
+    permissions: ["page:metadata", "ui:command"],
+    contributes: ["command-bar-command"],
+    min_ely_build: "0.1.0",
+    checksum: CHECKSUM,
+    signature: {
+      algorithm: "ed25519",
+      key_id: "elydora-alpha-plugins",
+      public_key: PUBLIC_KEY.toUpperCase(),
+      value: SIGNATURE.toUpperCase(),
+    },
+    package: validPluginPackage(),
+  };
+}
+
+function parsedPlugin(): Record<string, unknown> {
+  return {
+    ...validPlugin(),
+    signature: {
+      algorithm: "ed25519",
+      key_id: "elydora-alpha-plugins",
+      public_key: PUBLIC_KEY,
+      value: SIGNATURE,
+    },
+    package: {
+      ...validPluginPackage(),
+      sha256: PACKAGE_SHA256,
+    },
+  };
+}
+
+function validPluginPackage(): Record<string, unknown> {
+  return {
+    url: "https://downloads.elydora.com/plugins/reader/0.1.0/reader.rplug",
+    sha256: PACKAGE_SHA256.toUpperCase(),
+    size_bytes: 65536,
+  };
+}