gitlab-badge-proxy 0.1.3 → 0.1.4

package/README.md

@@ -76,6 +76,18 @@ explicitly whitelisted. The ref segment is free-form (any branch of a whiteliste
 the fixed `GITLAB_REF` used by the flat `/pipeline.svg` / `/coverage.svg` routes above. The coverage
 route also accepts `?job=<job-name>`, same as the flat route.
 
+## Project-scoped badges beyond pipeline/coverage/release
+
+The rest of the [Routes](#routes) above — stars, forks, contributors, issues, merge requests, last
+commit, license, tag, languages, language count, labels, go.mod version — aren't part of GitLab's own
+badge system, so there's no GitLab-native URL shape to mirror for them. This proxy has its own:
+`GET /<group/project>/badges/<name>.svg`, e.g. `https://badges.yourdomain.tld/ardenslab/pm2-dash/badges/stars.svg`
+or `.../badges/issues.svg?state=opened&labels=bug`. `<name>` is one of `stars`, `forks`,
+`contributors`, `issues`, `merge-requests`, `last-commit`, `license`, `tag`, `languages`,
+`languages-count`, `labels`, `go-mod` — same query params as the matching flat route (`labels.svg`
+still needs `?name=`). Gated by the same `GITLAB_PROJECTS` whitelist as the GitLab-shaped routes
+above; an unlisted project 404s the same way.
+
 ## Badge preview page
 
 `GET /debug/<group/project>?ref=<branch>` renders an HTML page with every badge this proxy can

package/dist/src/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAc,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAoBtD,OAAO,EACL,eAAe,EAkBhB,MAAM,YAAY,CAAC;AAyWpB,wBAAgB,SAAS,CAAC,SAAS,GAAE,MAAM,MAAmB,GAAG,IAAI,CAyNpE;AAED,OAAO,EAAE,eAAe,EAAE,CAAC;AAC3B,eAAO,MAAM,GAAG,4EAAc,CAAC"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAgB,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAc,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAoBtD,OAAO,EACL,eAAe,EAkBhB,MAAM,YAAY,CAAC;AAkcpB,wBAAgB,SAAS,CAAC,SAAS,GAAE,MAAM,MAAmB,GAAG,IAAI,CAoOpE;AAED,OAAO,EAAE,eAAe,EAAE,CAAC;AAC3B,eAAO,MAAM,GAAG,4EAAc,CAAC"}

package/dist/src/app.js

@@ -12,6 +12,27 @@ const UNKNOWN = { label: "gitlab", message: "unknown", color: "lightgrey" };
 const BADGE_PATH_PATTERN = /^(.+)\/badges\/([^/]+)\/(pipeline|coverage)\.svg$/;
 /** Matches GitLab's latest-release badge shape: `<project path>/-/badges/release.svg` (no ref). */
 const RELEASE_PATH_PATTERN = /^(.+)\/-\/badges\/release\.svg$/;
+/**
+ * This proxy's own badge shape (not one GitLab itself has): `<project path>/badges/<name>.svg`,
+ * for everything besides pipeline/coverage/release that isn't tied to a ref. Lets any whitelisted
+ * project use these the same way it already can use the GitLab-native ones above, instead of only
+ * the single fixed GITLAB_PROJECT getting them (via the flat /<name>.svg routes).
+ */
+const SIMPLE_BADGE_NAMES = [
+    "stars",
+    "forks",
+    "contributors",
+    "issues",
+    "merge-requests",
+    "last-commit",
+    "license",
+    "tag",
+    "languages",
+    "languages-count",
+    "labels",
+    "go-mod",
+];
+const SIMPLE_BADGE_PATH_PATTERN = new RegExp(`^(.+)\\/badges\\/(${SIMPLE_BADGE_NAMES.join("|")})\\.svg$`);
 /**
  * Known-safe `/api/v4/projects/:id/<subpath>` suffixes: just enough of the real GitLab REST API
  * for shields.io-style "point gitlab_url at a different host" badges (release/tag/pipeline/
@@ -166,6 +187,18 @@ function renderDebugPage(project, ref, origin) {
         { label: "pipeline", src: `/${project}/badges/${ref}/pipeline.svg` },
         { label: "coverage", src: `/${project}/badges/${ref}/coverage.svg` },
         { label: "release", src: `/${project}/-/badges/release.svg` },
+        { label: "stars", src: `/${project}/badges/stars.svg` },
+        { label: "forks", src: `/${project}/badges/forks.svg` },
+        { label: "contributors", src: `/${project}/badges/contributors.svg` },
+        { label: "issues", src: `/${project}/badges/issues.svg` },
+        { label: "merge requests", src: `/${project}/badges/merge-requests.svg` },
+        { label: "last commit", src: `/${project}/badges/last-commit.svg` },
+        { label: "license", src: `/${project}/badges/license.svg` },
+        { label: "tag", src: `/${project}/badges/tag.svg` },
+        { label: "top language", src: `/${project}/badges/languages.svg` },
+        { label: "language count", src: `/${project}/badges/languages-count.svg` },
+        { label: "label color (bug)", src: `/${project}/badges/labels.svg?name=bug` },
+        { label: "go.mod version", src: `/${project}/badges/go-mod.svg` },
     ];
     const nativeDefaultBadges = [
         { label: "pipeline", src: "/pipeline.svg" },
@@ -286,6 +319,54 @@ async function resolveReleaseSpec(config, projectPath) {
         return releaseToBadge(release);
     });
 }
+/** Computes one of SIMPLE_BADGE_NAMES's badges for `projectPath` - shared by the flat `/<name>.svg`
+ * routes (always `config.project`) and the project-scoped `/:project/badges/<name>.svg` routes
+ * (any whitelisted project), so the two stay identical instead of duplicating this per route. */
+async function computeSimpleBadge(config, projectPath, name, c) {
+    switch (name) {
+        case "stars":
+            return starsToBadge(await getStarsCount(config, projectPath));
+        case "forks":
+            return forksToBadge(await getForksCount(config, projectPath));
+        case "contributors":
+            return contributorsToBadge(await getContributorsCount(config, projectPath));
+        case "issues": {
+            const state = c.req.query("state") ?? "all";
+            const labels = c.req.query("labels");
+            return issuesToBadge(await getIssuesCount(config, projectPath, state, labels), state, labels);
+        }
+        case "merge-requests": {
+            const state = c.req.query("state") ?? "opened";
+            const labels = c.req.query("labels");
+            return mergeRequestsToBadge(await getMergeRequestsCount(config, projectPath, state, labels), state, labels);
+        }
+        case "last-commit": {
+            const ref = c.req.query("ref") ?? config.ref;
+            const path = c.req.query("path");
+            return lastCommitToBadge(await getLastCommitDate(config, projectPath, ref, path));
+        }
+        case "license":
+            return licenseToBadge(await getLicenseName(config, projectPath));
+        case "tag":
+            return tagToBadge(await getLatestTag(config, projectPath));
+        case "languages":
+            return topLanguageToBadge(await getLanguages(config, projectPath));
+        case "languages-count":
+            return languagesCountToBadge(await getLanguages(config, projectPath));
+        case "labels": {
+            const labelName = c.req.query("name");
+            if (!labelName) {
+                throw new Error("missing required ?name= query param");
+            }
+            return labelToBadge(labelName, await getLabelColor(config, projectPath, labelName));
+        }
+        case "go-mod": {
+            const ref = c.req.query("ref") ?? config.ref;
+            const filename = c.req.query("filename") ?? "go.mod";
+            return goModVersionToBadge(await getGoModVersion(config, projectPath, ref, filename));
+        }
+    }
+}
 /** Registers a flat `/<path>.svg` route fixed to the configured default project (and ref, where relevant). */
 function registerBadgeRoute(app, getConfig, path, fallback, context, compute) {
     app.get(path, async (c) => {
@@ -353,40 +434,18 @@ export function createApp(getConfig = loadConfig) {
         const { spec, maxAge } = await resolveReleaseSpec(config, config.project);
         return svgResponse(await fetchBadgeSvg(spec), maxAge);
     });
-    registerBadgeRoute(app, getConfig, "/stars.svg", UNKNOWN, "stars", async (config) => starsToBadge(await getStarsCount(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/forks.svg", UNKNOWN, "forks", async (config) => forksToBadge(await getForksCount(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/contributors.svg", UNKNOWN, "contributors", async (config) => contributorsToBadge(await getContributorsCount(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/issues.svg", UNKNOWN, "issues", async (config, c) => {
-        const state = c.req.query("state") ?? "all";
-        const labels = c.req.query("labels");
-        return issuesToBadge(await getIssuesCount(config, config.project, state, labels), state, labels);
-    });
-    registerBadgeRoute(app, getConfig, "/merge-requests.svg", UNKNOWN, "merge requests", async (config, c) => {
-        const state = c.req.query("state") ?? "opened";
-        const labels = c.req.query("labels");
-        return mergeRequestsToBadge(await getMergeRequestsCount(config, config.project, state, labels), state, labels);
-    });
-    registerBadgeRoute(app, getConfig, "/last-commit.svg", UNKNOWN, "last commit", async (config, c) => {
-        const ref = c.req.query("ref") ?? config.ref;
-        const path = c.req.query("path");
-        return lastCommitToBadge(await getLastCommitDate(config, config.project, ref, path));
-    });
-    registerBadgeRoute(app, getConfig, "/license.svg", UNKNOWN, "license", async (config) => licenseToBadge(await getLicenseName(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/tag.svg", UNKNOWN, "tag", async (config) => tagToBadge(await getLatestTag(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/languages.svg", UNKNOWN, "top language", async (config) => topLanguageToBadge(await getLanguages(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/languages-count.svg", UNKNOWN, "language count", async (config) => languagesCountToBadge(await getLanguages(config, config.project)));
-    registerBadgeRoute(app, getConfig, "/labels.svg", UNKNOWN, "label", async (config, c) => {
-        const name = c.req.query("name");
-        if (!name) {
-            throw new Error("missing required ?name= query param");
-        }
-        return labelToBadge(name, await getLabelColor(config, config.project, name));
-    });
-    registerBadgeRoute(app, getConfig, "/go-mod.svg", UNKNOWN, "go.mod version", async (config, c) => {
-        const ref = c.req.query("ref") ?? config.ref;
-        const filename = c.req.query("filename") ?? "go.mod";
-        return goModVersionToBadge(await getGoModVersion(config, config.project, ref, filename));
-    });
+    registerBadgeRoute(app, getConfig, "/stars.svg", UNKNOWN, "stars", (config, c) => computeSimpleBadge(config, config.project, "stars", c));
+    registerBadgeRoute(app, getConfig, "/forks.svg", UNKNOWN, "forks", (config, c) => computeSimpleBadge(config, config.project, "forks", c));
+    registerBadgeRoute(app, getConfig, "/contributors.svg", UNKNOWN, "contributors", (config, c) => computeSimpleBadge(config, config.project, "contributors", c));
+    registerBadgeRoute(app, getConfig, "/issues.svg", UNKNOWN, "issues", (config, c) => computeSimpleBadge(config, config.project, "issues", c));
+    registerBadgeRoute(app, getConfig, "/merge-requests.svg", UNKNOWN, "merge requests", (config, c) => computeSimpleBadge(config, config.project, "merge-requests", c));
+    registerBadgeRoute(app, getConfig, "/last-commit.svg", UNKNOWN, "last commit", (config, c) => computeSimpleBadge(config, config.project, "last-commit", c));
+    registerBadgeRoute(app, getConfig, "/license.svg", UNKNOWN, "license", (config, c) => computeSimpleBadge(config, config.project, "license", c));
+    registerBadgeRoute(app, getConfig, "/tag.svg", UNKNOWN, "tag", (config, c) => computeSimpleBadge(config, config.project, "tag", c));
+    registerBadgeRoute(app, getConfig, "/languages.svg", UNKNOWN, "top language", (config, c) => computeSimpleBadge(config, config.project, "languages", c));
+    registerBadgeRoute(app, getConfig, "/languages-count.svg", UNKNOWN, "language count", (config, c) => computeSimpleBadge(config, config.project, "languages-count", c));
+    registerBadgeRoute(app, getConfig, "/labels.svg", UNKNOWN, "label", (config, c) => computeSimpleBadge(config, config.project, "labels", c));
+    registerBadgeRoute(app, getConfig, "/go-mod.svg", UNKNOWN, "go.mod version", (config, c) => computeSimpleBadge(config, config.project, "go-mod", c));
     // Visual test page: every native and shields.io badge shape this proxy can produce, for one
     // project/ref given in the URL. /debug alone falls back to the fixed default project.
     app.get("/debug", (c) => {
@@ -459,26 +518,43 @@ export function createApp(getConfig = loadConfig) {
             return svgResponse(await fetchBadgeSvg(spec), maxAge);
         }
         const match = BADGE_PATH_PATTERN.exec(rest);
-        if (!match) {
-            return c.notFound();
-        }
-        const [, projectPath, ref, kind] = match;
-        let config;
-        try {
-            config = getConfig();
-        }
-        catch (error) {
-            console.error("gitlab-badge-proxy: failed to load config", error);
-            const fallback = kind === "pipeline" ? UNKNOWN_PIPELINE : UNKNOWN_COVERAGE;
-            return svgResponse(await fetchBadgeSvg(fallback), 30);
+        if (match) {
+            const [, projectPath, ref, kind] = match;
+            let config;
+            try {
+                config = getConfig();
+            }
+            catch (error) {
+                console.error("gitlab-badge-proxy: failed to load config", error);
+                const fallback = kind === "pipeline" ? UNKNOWN_PIPELINE : UNKNOWN_COVERAGE;
+                return svgResponse(await fetchBadgeSvg(fallback), 30);
+            }
+            if (!config.allowedProjects.includes(projectPath)) {
+                return c.notFound();
+            }
+            const { spec, maxAge } = kind === "pipeline"
+                ? await resolvePipelineSpec(config, projectPath, ref)
+                : await resolveCoverageSpec(config, projectPath, ref, c.req.query("job"));
+            return svgResponse(await fetchBadgeSvg(spec), maxAge);
         }
-        if (!config.allowedProjects.includes(projectPath)) {
-            return c.notFound();
+        const simpleMatch = SIMPLE_BADGE_PATH_PATTERN.exec(rest);
+        if (simpleMatch) {
+            const [, projectPath, name] = simpleMatch;
+            let config;
+            try {
+                config = getConfig();
+            }
+            catch (error) {
+                console.error("gitlab-badge-proxy: failed to load config", error);
+                return svgResponse(await fetchBadgeSvg(UNKNOWN), 30);
+            }
+            if (!config.allowedProjects.includes(projectPath)) {
+                return c.notFound();
+            }
+            const { spec, maxAge } = await resolveSpec(config, UNKNOWN, name, () => computeSimpleBadge(config, projectPath, name, c));
+            return svgResponse(await fetchBadgeSvg(spec), maxAge);
         }
-        const { spec, maxAge } = kind === "pipeline"
-            ? await resolvePipelineSpec(config, projectPath, ref)
-            : await resolveCoverageSpec(config, projectPath, ref, c.req.query("job"));
-        return svgResponse(await fetchBadgeSvg(spec), maxAge);
+        return c.notFound();
     });
     return app;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab-badge-proxy",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Server-side proxy that turns private GitLab pipeline/coverage status into public SVG badges, without ever exposing the GitLab instance's URL to clients.",
   "type": "module",
   "license": "MIT",