feat: support process plugins in latest info

Author: dsherret

plugins.test.ts

@@ -1,6 +1,6 @@
 import { assertEquals } from "./deps.test.ts";
 import { pluginResolvers, tryResolveLatestJson, tryResolvePluginUrl, tryResolveSchemaUrl } from "./plugins.ts";
-import { getLatestReleaseTagName } from "./utils/mod.ts";
+import { getLatestReleaseInfo } from "./utils/mod.ts";
 
 Deno.test("should get correct info for typescript resolver", () => {
   const resolver = getResolverByName("typescript");
@@ -226,39 +226,59 @@ Deno.test("tryResolveUserLatestJson", async () => {
   // dprint repo
   {
     const result = await getValidResultForUrl("https://plugins.dprint.dev/dprint/typescript/latest.json");
-    const tagName = await getLatestReleaseTagName("dprint", "dprint-plugin-typescript");
+    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-typescript");
     assertEquals(result, {
       schemaVersion: 1,
-      url: `https://plugins.dprint.dev/typescript-${tagName!}.wasm`,
+      url: `https://plugins.dprint.dev/typescript-${releaseInfo!.tagName}.wasm`,
+      version: releaseInfo!.tagName,
+      checksum: undefined,
     });
   }
   // dprint repo full name
   {
     const result = await getValidResultForUrl(
       "https://plugins.dprint.dev/dprint/dprint-plugin-typescript/latest.json",
     );
-    const tagName = await getLatestReleaseTagName("dprint", "dprint-plugin-typescript");
+    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-typescript");
     assertEquals(result, {
       schemaVersion: 1,
-      url: `https://plugins.dprint.dev/typescript-${tagName!}.wasm`,
+      url: `https://plugins.dprint.dev/typescript-${releaseInfo!.tagName}.wasm`,
+      version: releaseInfo!.tagName,
+      checksum: undefined,
     });
   }
   // non-dprint repo
   {
     const result = await getValidResultForUrl("https://plugins.dprint.dev/malobre/vue/latest.json");
-    const tagName = await getLatestReleaseTagName("malobre", "dprint-plugin-vue");
+    const releaseInfo = await getLatestReleaseInfo("malobre", "dprint-plugin-vue");
     assertEquals(result, {
       schemaVersion: 1,
-      url: `https://plugins.dprint.dev/malobre/vue-${tagName!}.wasm`,
+      url: `https://plugins.dprint.dev/malobre/vue-${releaseInfo!.tagName}.wasm`,
+      version: releaseInfo!.tagName.replace(/^v/, ""),
+      checksum: undefined,
     });
   }
   // non-dprint repo full name
   {
     const result = await getValidResultForUrl("https://plugins.dprint.dev/malobre/dprint-plugin-vue/latest.json");
-    const tagName = await getLatestReleaseTagName("malobre", "dprint-plugin-vue");
+    const releaseInfo = await getLatestReleaseInfo("malobre", "dprint-plugin-vue");
     assertEquals(result, {
       schemaVersion: 1,
-      url: `https://plugins.dprint.dev/malobre/vue-${tagName!}.wasm`,
+      url: `https://plugins.dprint.dev/malobre/vue-${releaseInfo!.tagName}.wasm`,
+      version: releaseInfo!.tagName.replace(/^v/, ""),
+      checksum: undefined,
+    });
+  }
+  // process plugin repo
+  {
+    const result = await getValidResultForUrl("https://plugins.dprint.dev/dprint/prettier/latest.json");
+    const releaseInfo = await getLatestReleaseInfo("dprint", "dprint-plugin-prettier");
+    assertEquals(releaseInfo?.checksum?.length, 64);
+    assertEquals(result, {
+      schemaVersion: 1,
+      url: `https://plugins.dprint.dev/prettier-${releaseInfo!.tagName}.exe-plugin`,
+      version: releaseInfo!.tagName,
+      checksum: releaseInfo!.checksum,
     });
   }
 

plugins.ts

@@ -1,4 +1,4 @@
-import { checkGithubRepoExists, getLatestReleaseTagName } from "./utils/mod.ts";
+import { checkGithubRepoExists, getLatestReleaseInfo } from "./utils/mod.ts";
 import { parseVersion } from "./version.ts";
 
 export interface PluginResolver {
@@ -156,19 +156,22 @@ export async function tryResolveLatestJson(url: URL) {
   const username = result.pathname.groups[0];
   const shortRepoName = result.pathname.groups[1];
   const repoName = await getFullRepoName(username, shortRepoName);
-  const tagName = await getLatestReleaseTagName(username, repoName);
-  if (tagName == null) {
+  const releaseInfo = await getLatestReleaseInfo(username, repoName);
+  if (releaseInfo == null) {
     return 404;
   }
   const displayRepoName = shortRepoName.replace(/^dprint-plugin-/, "");
+  const extension = releaseInfo.kind === "wasm" ? "wasm" : "exe-plugin";
 
   // include the bare minimum in case someone else wants to implement
   // this behaviour on their server
   return {
     schemaVersion: 1,
     url: username === "dprint"
-      ? `https://plugins.dprint.dev/${displayRepoName}-${tagName}.wasm`
-      : `https://plugins.dprint.dev/${username}/${displayRepoName}-${tagName}.wasm`,
+      ? `https://plugins.dprint.dev/${displayRepoName}-${releaseInfo.tagName}.${extension}`
+      : `https://plugins.dprint.dev/${username}/${displayRepoName}-${releaseInfo.tagName}.${extension}`,
+    version: releaseInfo.tagName.replace(/^v/, ""),
+    checksum: releaseInfo.checksum,
   };
 }
 

utils/github.ts

@@ -30,12 +30,18 @@ export async function checkGithubRepoExists(username: string, repoName: string)
   return result;
 }
 
-const latestReleaseTagNameCache = new LruCacheWithExpiry<string, string | undefined>({
+interface ReleaseInfo {
+  tagName: string;
+  checksum: string | undefined;
+  kind: "wasm" | "process";
+}
+
+const latestReleaseTagNameCache = new LruCacheWithExpiry<string, ReleaseInfo | undefined>({
   size: 1000,
   expiryMs: 5 * 60 * 1_000, // keep entries for 5 minutes
 });
 
-export async function getLatestReleaseTagName(username: string, repoName: string) {
+export async function getLatestReleaseInfo(username: string, repoName: string) {
   if (!validateName(username) || !validateName(repoName)) {
     return undefined;
   }
@@ -51,16 +57,48 @@ export async function getLatestReleaseTagName(username: string, repoName: string
       const text = await response.text();
       throw new Error(`Invalid response status: ${response.status}\n\n${text}`);
     }
-    const data = await response.json();
-    result = data.tag_name;
-    if (typeof result !== "string") {
-      throw new Error("The tag name was not a string.");
-    }
+    result = getReleaseInfo(await response.json());
     latestReleaseTagNameCache.set(url, result);
   }
   return result;
 }
 
+function getReleaseInfo(data: { tag_name: string; body: string; assets: { name: string }[] }): ReleaseInfo {
+  if (typeof data.tag_name !== "string") {
+    throw new Error("The tag name was not a string.");
+  }
+  return {
+    tagName: data.tag_name,
+    checksum: getChecksum(),
+    kind: getPluginKind(),
+  };
+
+  function getChecksum() {
+    if (typeof data.body !== "string") {
+      return undefined;
+    }
+    // search the body text for a dprint style checksum
+    const checksum = /\@([a-z0-9]{64})\b/i.exec(data.body);
+    return checksum?.[1];
+  }
+
+  function getPluginKind(): ReleaseInfo["kind"] {
+    if (!(data.assets instanceof Array)) {
+      return "wasm";
+    }
+
+    for (const asset of data.assets) {
+      if (typeof asset === "object" && typeof asset.name === "string") {
+        if (asset.name.endsWith(".exe-plugin")) {
+          return "process";
+        }
+      }
+    }
+
+    return "wasm";
+  }
+}
+
 function validateName(name: string) {
   // usernames may only contain alphanumeric and hypens
   // repos may only contain alphanumeric, underscores, hyphens, and period