Add build version and commit visibility in UI and health endpoint

Author: wilhel1812

functions/_lib/buildInfo.ts

@@ -0,0 +1,3 @@
+export const APP_VERSION = "0.0.0";
+export const APP_COMMIT = "6d0ed5c0";
+export const APP_BUILD_LABEL = `v${APP_VERSION}+${APP_COMMIT}`;

functions/_lib/types.ts

@@ -33,6 +33,9 @@ export type Env = {
   DEV_AUTH_USER_ID?: string;
   ADMIN_USER_IDS?: string;
   REGISTRATION_MODE?: string;
+  CF_PAGES_URL?: string;
+  CF_PAGES_BRANCH?: string;
+  CF_PAGES_COMMIT_SHA?: string;
   GEOCODE_RATE_LIMIT_PER_MINUTE?: string;
   PROXY_RATE_LIMIT_PER_MINUTE?: string;
   VE2DBE_TILELIST_RATE_LIMIT_PER_MINUTE?: string;

functions/api/health.ts

@@ -1,14 +1,36 @@
 import { handleOptions, json, withCors } from "../_lib/http";
 import type { Env } from "../_lib/types";
+import { APP_BUILD_LABEL, APP_COMMIT, APP_VERSION } from "../_lib/buildInfo";
 
 export const onRequestOptions: PagesFunction<Env> = async ({ request }) => handleOptions(request);
 
-export const onRequestGet: PagesFunction<Env> = async ({ request }) =>
+const PROD_HOSTS = new Set(["linksim.wilhelmfrancke.com", "linksim.pages.dev"]);
+
+const normalizeHost = (host: string): string => host.trim().toLowerCase();
+
+export const onRequestGet: PagesFunction<Env> = async ({ request, env }) =>
   withCors(
     request,
-    json({
-      ok: true,
-      service: "linksim-api",
-      ts: new Date().toISOString(),
-    }),
+    (() => {
+      const url = new URL(request.url);
+      const host = normalizeHost(url.hostname);
+      const envName = PROD_HOSTS.has(host) ? "production" : "test";
+      return json({
+        ok: true,
+        service: "linksim-api",
+        ts: new Date().toISOString(),
+        build: {
+          version: APP_VERSION,
+          commit: APP_COMMIT,
+          label: APP_BUILD_LABEL,
+        },
+        runtime: {
+          env: envName,
+          host,
+          pagesUrl: env.CF_PAGES_URL ?? null,
+          pagesBranch: env.CF_PAGES_BRANCH ?? null,
+          pagesCommitSha: env.CF_PAGES_COMMIT_SHA ?? null,
+        },
+      });
+    })(),
   );

package.json

@@ -5,10 +5,11 @@
   "license": "GPL-3.0-only",
   "type": "module",
   "scripts": {
+    "build:meta": "node scripts/generate-build-info.mjs",
     "dev": "vite --config config/vite.config.ts",
-    "build:client": "vite build --config config/vite.config.ts",
+    "build:client": "npm run build:meta && vite build --config config/vite.config.ts",
     "dev:edge": "npm run build:client && npx wrangler pages dev dist --d1 DB=linksim --r2 AVATAR_BUCKET=linksim-avatars --binding ALLOW_INSECURE_DEV_AUTH=true --binding DEV_AUTH_USER_ID=local-dev-user --local --persist-to .wrangler/state",
-    "build": "tsc -b config/tsconfig.json && vite build --config config/vite.config.ts",
+    "build": "npm run build:meta && tsc -b config/tsconfig.json && vite build --config config/vite.config.ts",
     "lint": "eslint .",
     "preview": "vite preview --config config/vite.config.ts",
     "test": "vitest run --config config/vitest.config.ts",

scripts/generate-build-info.mjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import { execSync } from "node:child_process";
+import { readFileSync, writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+const root = resolve(new URL("..", import.meta.url).pathname);
+const pkg = JSON.parse(readFileSync(resolve(root, "package.json"), "utf8"));
+
+const shortSha = (() => {
+  const envSha = process.env.CF_PAGES_COMMIT_SHA || process.env.GITHUB_SHA || "";
+  if (envSha.trim()) return envSha.trim().slice(0, 8);
+  try {
+    return execSync("git rev-parse --short=8 HEAD", { cwd: root, stdio: ["ignore", "pipe", "ignore"] })
+      .toString("utf8")
+      .trim();
+  } catch {
+    return "unknown";
+  }
+})();
+
+const version = String(pkg.version ?? "0.0.0");
+
+const content = `export const APP_VERSION = "${version}";
+export const APP_COMMIT = "${shortSha}";
+export const APP_BUILD_LABEL = \`v\${APP_VERSION}+\${APP_COMMIT}\`;
+`;
+
+writeFileSync(resolve(root, "src/lib/buildInfo.ts"), content, "utf8");
+writeFileSync(resolve(root, "functions/_lib/buildInfo.ts"), content, "utf8");
+console.log(`[build-info] ${version}+${shortSha}`);

src/components/Sidebar.tsx

@@ -17,6 +17,7 @@ import { FREQUENCY_PRESETS } from "../lib/frequencyPlans";
 import { searchLocations, type GeocodeResult } from "../lib/geocode";
 import { LEGACY_ASSETS } from "../lib/legacyAssets";
 import { isCurrentTestEnvironment } from "../lib/environment";
+import { APP_BUILD_LABEL } from "../lib/buildInfo";
 import {
   fetchCollaboratorDirectory,
   fetchResourceChanges,
@@ -2031,6 +2032,9 @@ export function Sidebar() {
           </div>
           <details className="compact-details">
             <summary>Credits & Attribution</summary>
+            <p className="field-help subtle-note">
+              Build: {APP_BUILD_LABEL} ({isCurrentTestEnvironment() ? "test" : "production"})
+            </p>
             <p className="field-help subtle-note">
               Inspired by{" "}
               <a href={PRIMARY_ATTRIBUTION.projectUrl} rel="noreferrer" target="_blank">

src/lib/buildInfo.ts

@@ -0,0 +1,3 @@
+export const APP_VERSION = "0.0.0";
+export const APP_COMMIT = "6d0ed5c0";
+export const APP_BUILD_LABEL = `v${APP_VERSION}+${APP_COMMIT}`;