feat: add download count (#22)

Author: g-plane

Diff for: home.tsx

@@ -70,9 +70,11 @@ function renderPlugins(data: PluginsData) {
       <div id="plugins-header">
         <div>Name</div>
         <div>URL</div>
+        <div>Latest Downloads</div>
+        <div>Total Downloads</div>
         <div></div>
       </div>
-      {data.latest.map(plugin => renderPlugin(plugin))}
+      {data.latest.map((plugin) => renderPlugin(plugin))}
     </div>
   );
 }
@@ -82,6 +84,8 @@ function renderPlugin(plugin: PluginData) {
     <div className="plugin" key={plugin.name}>
       <div>{plugin.name}</div>
       <div>{plugin.url}</div>
+      <div>{plugin.downloadCount.currentVersion}</div>
+      <div>{plugin.downloadCount.allVersions}</div>
       <div>
         <button className="copy-button" title="Copy to clipboard" data-url={plugin.url}>
           Copy

Diff for: plugins.ts

@@ -76,6 +76,7 @@ export async function getLatestInfo(username: string, repoName: string) {
       : `https://plugins.dprint.dev/${username}/${displayRepoName}-${releaseInfo.tagName}.${extension}`,
     version: releaseInfo.tagName.replace(/^v/, ""),
     checksum: releaseInfo.checksum,
+    downloadCount: releaseInfo.downloadCount,
   };
 }
 

Diff for: readInfoFile.ts

@@ -1,4 +1,5 @@
 import { getLatestInfo } from "./plugins.ts";
+import { getAllDownloadCount } from "./utils/github.ts";
 import { createAsyncLazy } from "./utils/mod.ts";
 
 const infoLazy = createAsyncLazy<Readonly<PluginsData>>(async () => {
@@ -15,6 +16,10 @@ export interface PluginData {
   name: string;
   url: string;
   version: string;
+  downloadCount: {
+    currentVersion: number;
+    allVersions: number;
+  };
 }
 
 export async function readInfoFile(): Promise<Readonly<PluginsData>> {
@@ -36,6 +41,12 @@ export async function readInfoFile(): Promise<Readonly<PluginsData>> {
           ...plugin,
           version: info.version,
           url: info.url,
+          downloadCount: {
+            currentVersion: info.downloadCount,
+            allVersions: pluginName
+              ? await getAllDownloadCount(username, pluginName)
+              : await getAllDownloadCount("dprint", plugin.name),
+          },
         });
       }
     }

Diff for: utils/github.ts

@@ -35,6 +35,7 @@ export interface ReleaseInfo {
   tagName: string;
   checksum: string | undefined;
   kind: "wasm" | "process";
+  downloadCount: number;
 }
 
 const latestReleaseTagNameCache = new LruCacheWithExpiry<string, ReleaseInfo | undefined>({
@@ -43,32 +44,20 @@ const latestReleaseTagNameCache = new LruCacheWithExpiry<string, ReleaseInfo | u
 });
 
 export async function getLatestReleaseInfo(username: string, repoName: string) {
-  if (!validateName(username) || !validateName(repoName)) {
-    return undefined;
-  }
-
-  const url = `https://api.github.com/repos/${username}/${repoName}/releases/latest`;
-  return await latestReleaseTagNameCache.getOrSet(url, async () => {
-    const response = await makeGitHubGetRequest(url, "GET");
-    if (response.status === 404) {
-      await response.text(); // todo: no way to mark this as used for the sanitizers?
-      return undefined;
-    } else if (!response.ok) {
-      const text = await response.text();
-      throw new Error(`Invalid response status: ${response.status}\n\n${text}`);
-    }
-    return getReleaseInfo(await response.json());
-  });
+  const releases = await getReleasesData(username, repoName);
+  const latest = releases?.find((release) => !release.draft && !release.prerelease);
+  return latest ? getReleaseInfo(latest) : undefined;
 }
 
-function getReleaseInfo(data: { tag_name: string; body: string; assets: { name: string }[] }): ReleaseInfo {
+function getReleaseInfo(data: GitHubRelease): 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(),
+    downloadCount: getDownloadCount(data.assets),
   };
 
   function getChecksum() {
@@ -97,6 +86,52 @@ function getReleaseInfo(data: { tag_name: string; body: string; assets: { name:
   }
 }
 
+function getDownloadCount(assets: ReleaseAsset[]) {
+  return assets.find(({ name }) => name === "plugin.wasm" || name === "plugin.json")?.download_count ?? 0;
+}
+
+interface ReleaseAsset {
+  name: string;
+  download_count: number;
+}
+
+export async function getAllDownloadCount(username: string, repoName: string) {
+  const releases = await getReleasesData(username, repoName);
+  return releases?.reduce((total, current) => total + getDownloadCount(current.assets), 0) ?? 0;
+}
+
+interface GitHubRelease {
+  tag_name: string;
+  body: string;
+  draft: boolean;
+  prerelease: boolean;
+  assets: ReleaseAsset[];
+}
+
+const releasesCache = new LruCacheWithExpiry<string, GitHubRelease[]>({
+  size: 1000,
+  expiryMs: 5 * 60 * 1_000, // keep entries for 5 minutes
+});
+
+async function getReleasesData(username: string, repoName: string) {
+  if (!validateName(username) || !validateName(repoName)) {
+    return;
+  }
+
+  const url = `https://api.github.com/repos/${username}/${repoName}/releases`;
+  return await releasesCache.getOrSet(url, async () => {
+    const response = await makeGitHubGetRequest(url, "GET");
+    if (response.status === 404) {
+      await response.text(); // todo: no way to mark this as used for the sanitizers?
+      return;
+    } else if (!response.ok) {
+      const text = await response.text();
+      throw new Error(`Invalid response status: ${response.status}\n\n${text}`);
+    }
+    return response.json();
+  });
+}
+
 const latestCliReleaseInfo = new LazyExpirableValue<any>({
   expiryMs: 10 * 60 * 1_000, // keep for 10 minutes
   createValue: async () => {