Add User-agent to packagephobia requests

Author: oBusk

src/lib/api/packagephobia/packagephobia.ts

@@ -1,3 +1,4 @@
+import { USER_AGENT } from "../user-agent";
 import type PackagephobiaResponse from "./PackagephobiaResponse";
 import type PackagephobiaResults from "./PackagephobiaResult";
 
@@ -7,6 +8,9 @@ async function getPackage(spec: string): Promise<PackagephobiaResponse | null> {
             `https://packagephobia.com/v2/api.json?p=${spec}`,
             {
                 signal: AbortSignal.timeout(7_500),
+                headers: {
+                    "User-Agent": USER_AGENT,
+                },
             },
         );
 

src/lib/api/user-agent.ts

@@ -0,0 +1,17 @@
+const { VERCEL_ENV, VERCEL_DEPLOY_ID, VERCEL_GIT_COMMIT_SHA } = process.env;
+
+/**
+ * Be nice to APIs and inform them who we are, with traceability when deployed on Vercel.
+ */
+export const USER_AGENT = (() => {
+    const parts = [`env=${VERCEL_ENV ?? "development"}`];
+
+    if (VERCEL_DEPLOY_ID) {
+        parts.push(`deploy=${VERCEL_DEPLOY_ID}`);
+    }
+    if (VERCEL_GIT_COMMIT_SHA) {
+        parts.push(`commit=${VERCEL_GIT_COMMIT_SHA}`);
+    }
+
+    return `npm-diff.app (${parts.join("; ")}; +https://github.com/oBusk/npm-diff.app)`;
+})();