plugins.test.ts

import { expect, it } from "vitest";
import infoJson from "./info.json" with { type: "json" };
import { getPluginRepo, tryResolveAssetUrl, tryResolveLatestJson } from "./plugins.js";
import { getLatestReleaseInfo } from "./utils/github.js";

function resolveAsset(url: string) {
  return tryResolveAssetUrl(new URL(url));
}

it("getPluginRepo", () => {
  expect(getPluginRepo({ repoUrl: "https://github.com/dprint/dprint-plugin-typescript" })).toEqual({
    username: "dprint",
    repoName: "dprint-plugin-typescript",
  });
  expect(getPluginRepo({ repoUrl: "https://github.com/g-plane/malva" })).toEqual({
    username: "g-plane",
    repoName: "malva",
  });
});

it("info.json entries should have a display name and say what repo they're published from", () => {
  for (const plugin of infoJson.latest) {
    expect(plugin.displayName, plugin.name).toBeTruthy();
    expect(plugin.repoUrl, plugin.name).toMatch(/^https:\/\/github\.com\/[A-Za-z0-9-]+\/[A-Za-z0-9._-]+$/);
  }
});

it("tryResolveAssetUrl", () => {
  // allowed repo — should cache
  expect(
    resolveAsset(
      "https://plugins.dprint.dev/dprint/dprint-plugin-prettier/0.67.0/asset/dprint-plugin-prettier-x86_64-apple-darwin.zip",
    ),
  ).toEqual({
    githubUrl:
      "https://github.com/dprint/dprint-plugin-prettier/releases/download/0.67.0/dprint-plugin-prettier-x86_64-apple-darwin.zip",
    shouldCache: true,
  });

  // latest tag — still resolves but not cached
  expect(
    resolveAsset(
      "https://plugins.dprint.dev/dprint/dprint-plugin-prettier/latest/asset/dprint-plugin-prettier-x86_64-apple-darwin.zip",
    ),
  ).toEqual({
    githubUrl:
      "https://github.com/dprint/dprint-plugin-prettier/releases/download/latest/dprint-plugin-prettier-x86_64-apple-darwin.zip",
    shouldCache: true,
  });

  // different repo in dprint org — should cache
  expect(
    resolveAsset("https://plugins.dprint.dev/dprint/dprint-plugin-exec/0.5.0/asset/some-binary.zip"),
  ).toEqual({
    githubUrl: "https://github.com/dprint/dprint-plugin-exec/releases/download/0.5.0/some-binary.zip",
    shouldCache: true,
  });

  // approved community repo — should cache
  expect(
    resolveAsset(
      "https://plugins.dprint.dev/drluckyspin/dprint-plugin-swift/v0.1.0/asset/dprint-plugin-swift-aarch64-apple-darwin.zip",
    ),
  ).toEqual({
    githubUrl:
      "https://github.com/drluckyspin/dprint-plugin-swift/releases/download/v0.1.0/dprint-plugin-swift-aarch64-apple-darwin.zip",
    shouldCache: true,
  });

  // org not on allow list — resolves but should not cache (redirect)
  expect(
    resolveAsset("https://plugins.dprint.dev/someone/some-repo/0.1.0/asset/file.zip"),
  ).toEqual({
    githubUrl: "https://github.com/someone/some-repo/releases/download/0.1.0/file.zip",
    shouldCache: false,
  });

  // non-matching URL
  expect(
    resolveAsset("https://plugins.dprint.dev/dprint/dprint-plugin-prettier/0.67.0/file.zip"),
  ).toEqual(undefined);
});

it("tryResolveUserLatestJson", async () => {
  // non-matching
  expect(
    await tryResolveLatestJson(
      new URL("https://plugins.dprint.dev/dsherret/latest.json"),
    ),
  ).toEqual(undefined);

  expect(
    await tryResolveLatestJson(
      new URL("https://plugins.dprint.dev/dsherret/non-existent/latest.json"),
    ),
  ).toEqual(404);

  // dprint repo
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/dprint/typescript/latest.json");
    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-typescript");
    expect(releaseInfo?.checksum?.length).toEqual(64);
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/typescript-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName,
      checksum: releaseInfo!.checksum,
      npm: { name: "@dprint/typescript" },
    });
  }
  // dprint repo full name
  {
    const result = await getValidResultForUrl(
      "https://plugins.dprint.dev/dprint/dprint-plugin-typescript/latest.json",
    );
    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-typescript");
    expect(releaseInfo?.checksum?.length).toEqual(64);
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/typescript-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName,
      checksum: releaseInfo!.checksum,
      npm: { name: "@dprint/typescript" },
    });
  }
  // non-dprint repo
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/malobre/vue/latest.json");
    const releaseInfo = await getLatestReleaseInfo("malobre", "dprint-plugin-vue");
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/malobre/vue-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName.replace(/^v/, ""),
      checksum: releaseInfo!.checksum,
    });
  }
  // non-dprint repo full name
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/malobre/dprint-plugin-vue/latest.json");
    const releaseInfo = await getLatestReleaseInfo("malobre", "dprint-plugin-vue");
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/malobre/vue-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName.replace(/^v/, ""),
      checksum: releaseInfo!.checksum,
    });
  }
  // process plugin repo
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/dprint/prettier/latest.json");
    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-prettier");
    expect(releaseInfo?.checksum?.length).toEqual(64);
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/prettier-${releaseInfo!.tagName}.json`,
      version: releaseInfo!.tagName,
      checksum: releaseInfo!.checksum,
      npm: { name: "@dprint/prettier" },
    });
  }
  // community repo published to npm
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/g-plane/malva/latest.json");
    const releaseInfo = await getLatestReleaseInfo("g-plane", "malva");
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/g-plane/malva-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName.replace(/^v/, ""),
      checksum: releaseInfo!.checksum,
      npm: { name: "dprint-plugin-malva" },
    });
  }
  // plugin replaced by one in the dprint org
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/kachick/kdl/latest.json");
    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-kdl");
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/kachick/kdl-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName,
      checksum: releaseInfo!.checksum,
      deprecated:
        "Replaced by dprint/dprint-plugin-kdl. Remove the kachick/kdl plugin from your config, then run `dprint add kdl`.",
    });
  }
  // community plugins aren't resolved by the name they have in info.json, so
  // they can't claim a name in the dprint org
  for (const name of ["dprint_plugin_malva", "cmakefmt"]) {
    expect(
      await tryResolveLatestJson(new URL(`https://plugins.dprint.dev/dprint/${name}/latest.json`)),
    ).toEqual(404);
  }
  // community repo that doesn't publish its plugin as plugin.wasm
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/cmakefmt/cmakefmt/latest.json");
    const releaseInfo = await getLatestReleaseInfo("cmakefmt", "cmakefmt", "dprint-cmakefmt.wasm");
    expect(releaseInfo?.checksum?.length).toEqual(64);
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/cmakefmt/cmakefmt-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName.replace(/^v/, ""),
      checksum: releaseInfo!.checksum,
    });
  }
  {
    const result = await getValidResultForUrl("https://plugins.dprint.dev/azais-corentin/cmakefmt/latest.json");
    const releaseInfo = await getLatestReleaseInfo("azais-corentin", "cmakefmt", "cmakefmt-dprint.wasm");
    expect(releaseInfo?.checksum?.length).toEqual(64);
    expect(result).toEqual({
      schemaVersion: 1,
      url: `https://plugins.dprint.dev/azais-corentin/cmakefmt-${releaseInfo!.tagName}.wasm`,
      version: releaseInfo!.tagName.replace(/^v/, ""),
      checksum: releaseInfo!.checksum,
    });
  }

  async function getValidResultForUrl(url: string) {
    const result = await tryResolveLatestJson(new URL(url))!;
    if (result == null || result === 404) {
      throw new Error("Expected result.");
    }
    return result;
  }
});