Build Caddyfile from snapshot versions provided by the homepage (#13)

https://delpa.org/snapshot_versions.json

Author: xuhdev

.github/workflows/lint.yml

@@ -40,13 +40,5 @@ jobs:
       - name: Install Dependencies
         run: npm ci
 
-      - name: Install Caddy
-        run: |
-          sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
-          curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
-          curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
-          sudo apt update
-          sudo apt install caddy
-
       - name: Lint
         run: npm run lint

.github/workflows/prod_container_img.yml

@@ -0,0 +1,53 @@
+# @license AGPL-3.0-or-later
+#
+# Copyright(C) 2025 Hong Xu <[email protected]>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+name: Production Container Image Builds and Brief Tests
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  test:
+    name: Production Container Image
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Use Node.js
+        uses: actions/[email protected]
+        with:
+          node-version: 22
+          cache: "npm"
+
+      - name: Install podman
+        run: sudo apt-get update && sudo apt-get install -y podman
+
+      - name: Build
+        run: npm run build_prod
+
+      - name: Start the container
+        run: podman run --detach -p 3000:80 -p 3001:443 delpa-redirection-server
+
+      - name: Install npm dependencies
+        run: npm ci
+
+      - name: Run test
+        run: npm run test_prod

.github/workflows/runtime.yml

@@ -44,7 +44,7 @@ jobs:
         run: npm run build
 
       - name: Start the container
-        run: podman run --detach -p 3000:80 -p 3001:443 app
+        run: podman run --detach -p 3000:80 -p 3001:443 delpa-redirection-test-server
 
       - name: Install npm dependencies
         run: npm ci

Caddyfile.base

@@ -15,17 +15,42 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-FROM docker.io/node:22.12.0-alpine@sha256:6e80991f69cc7722c561e5d14d5e72ab47c0d6b6cfb3ae50fb9cf9a7b30fdf97 as builder
+# snapshot versions, either prod or test
+ARG snapshot_versions_type=prod
+
+FROM docker.io/busybox:1.37.0@sha256:2919d0172f7524b2d8df9e50066a682669e6d170ac0f6a49676d54358fe970b5 as snapshot-versions-getter-base
+
+# Production snapshot versions
+FROM snapshot-versions-getter-base as snapshot-versions-getter-prod
+
+RUN wget https://delpa.org/snapshot_versions.json && \
+    wget https://delpa.org/snapshot_versions.json.sha256
+
+# Verify that snapshot_versions.json is in the sha256 checksum file and verify
+# checksum
+RUN grep snapshot_versions.json snapshot_versions.json.sha256 && \
+    sha256sum -c snapshot_versions.json.sha256
+
+# Test snapshot versions
+FROM snapshot-versions-getter-base as snapshot-versions-getter-test
+
+COPY ./snapshot_versions.json .
+
+FROM snapshot-versions-getter-${snapshot_versions_type} as snapshot-versions-getter
+
+FROM docker.io/node:22.12.0-alpine@sha256:6e80991f69cc7722c561e5d14d5e72ab47c0d6b6cfb3ae50fb9cf9a7b30fdf97 as caddyfile-builder
+
 
 COPY package.json package-lock.json ./
 RUN npm install -g npm && npm install
 COPY . .
-RUN npx tsx gen_caddy.ts < Caddyfile.base > Caddyfile
+COPY --from=snapshot-versions-getter ./snapshot_versions.json .
+RUN npx tsx gen_caddy.ts > Caddyfile
 
 FROM docker.io/caddy:2.8.4-alpine@sha256:e97e0e3f8f51be708a9d5fadbbd75e3398c22fc0eecd4b26d48561e3f7daa9eb
 
 LABEL org.opencontainers.image.authors="Hong Xu <[email protected]>"
 LABEL org.opencontainers.image.title="Delpa Redirection Server"
 LABEL org.opencontainers.image.licenses=AGPL-3.0-or-later
 
-COPY --from=builder Caddyfile /etc/caddy/
+COPY --from=caddyfile-builder Caddyfile /etc/caddy/

Dockerfile

@@ -6,16 +6,32 @@ https://github.com/delpa-org/melpa-snapshot-*.
 
 For more information about Delpa, see https://delpa.org.
 
+## Build
+
+You need [podman][] installed.
+
+To build the server for production, run:
+
+    npm run build_prod
+
 ## Development
 
 You need [podman][] installed.
 
-To build the server, run:
+To build the server for test, run:
 
     npm run build
 
 To start the server, run:
 
     npm run start
 
+After starting the test server, to run test:
+
+    npm run test
+
+The `snapshot_versions.json` file in this repo is deliberately set wrong and for
+test purpose only. In production build, it will be replaced by the file grabbed
+from https://delpa.org/snapshot_versions.json.
+
 [podman]: https://podman.io/

README.md

@@ -16,12 +16,29 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-/** Generate caddy file.
- * Currently simply redirect stdin to stdout.
- */
+/** Generate the caddyfile. */
+
+import snapshotVersions from "./snapshot_versions.json" with { type: "json" };
+
+const snapVersionsRegexp = snapshotVersions.join("|");
+
+const caddyfile = `
+{
+	admin off
+}
+
+{$HOST_ADDRESS:localhost} {
+	redir / https://delpa.org permanent
+
+	respond /health-check "OK"
 
-import fs from "fs";
+	@snapshot path_regexp ^/snapshot/(${snapVersionsRegexp})/(.*)$
+	redir @snapshot https://raw.githubusercontent.com/delpa-org/melpa-snapshot-{re.1}/refs/heads/master/packages/{re.2} permanent
 
-const data = fs.readFileSync(0, "utf-8");
+	respond "404 Not Found" 404 {
+		close
+	}
+}
+`;
 
-console.log(data);
+console.log(caddyfile);

gen_caddy.ts

@@ -39,10 +39,10 @@ test("/health-check returns 200 with OK", async () => {
 describe("/snapshot", () => {
   const snapshotFirstPathComp = "snapshot" as const;
   for (const [name, path] of [
-    ["valid with a one-level subdir", "2025-01-02/a"],
-    ["valid with a one-level subdir with a trailing slash", "2025-01-02/a/"],
-    ["valid with a two-level subdir", "2025-01-02/a/b"],
-    ["valid with a two-level subdir with a trailing slash", "2025-01-02/a/b/"],
+    ["valid with a one-level subdir", "2024-01-01/a"],
+    ["valid with a one-level subdir with a trailing slash", "2024-01-01/a/"],
+    ["valid with a two-level subdir", "2024-01-01/a/b"],
+    ["valid with a two-level subdir with a trailing slash", "2024-01-01/a/b/"],
   ] as const) {
     test(`Redirect with valid URL under /shapshot: ${name}`, async () => {
       const response = await fetch(
@@ -55,7 +55,7 @@ describe("/snapshot", () => {
       expect(response.status).toBe(301);
       expect(response.headers.get("location")).toBe(
         delpaGitHubRawBaseUrl +
-          "/melpa-snapshot-2025-01-02/refs/heads/master/packages/" +
+          "/melpa-snapshot-2024-01-01/refs/heads/master/packages/" +
           path.slice(
             path.indexOf("/") + 1, // Remove the top-level folder in path
           ),
@@ -64,6 +64,8 @@ describe("/snapshot", () => {
   }
 
   for (const [name, path] of [
+    ["non-existing snapshot", "2025-01-01"],
+    ["non-existing partially-matched snapshot", "2024-01"],
     ["non-existing with no subdir", "non-existing"],
     ["non-existing with no subdir but with a trailing slash", "non-existing/"],
     ["non-existing with a one-level subdir", "non-existing/a"],

index.test.ts

@@ -7,11 +7,13 @@
   "author": "Hong Xu <[email protected]>",
   "type": "module",
   "scripts": {
-    "lint": "npm run compile && eslint *.ts *.mjs && prettier . --check && caddy fmt --diff Caddyfile.base",
-    "build": "podman build . -t app",
-    "start": "podman run -it --rm -p 3000:80 -p 3001:443 app",
+    "lint": "npm run compile && eslint *.ts *.mjs && prettier . --check",
+    "build": "podman build --build-arg snapshot_versions_type=test . -t delpa-redirection-test-server",
+    "build_prod": "podman build . -t delpa-redirection-server",
+    "start": "podman run -it --rm -p 3000:80 -p 3001:443 delpa-redirection-test-server",
     "test": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest --run index.test.ts",
-    "format": "eslint --fix *.ts *.mjs && prettier . --write && caddy fmt --overwrite Caddyfile.base",
+    "test_prod": "NODE_TLS_REJECT_UNAUTHORIZED=0 vitest --run prod.test.ts",
+    "format": "eslint --fix *.ts *.mjs && prettier . --write",
     "compile": "tsc -p tsconfig.json"
   },
   "devDependencies": {

package.json

@@ -0,0 +1,75 @@
+/** @license AGPL-3.0-or-later
+ *
+ * Copyright(C) 2025 Hong Xu <[email protected]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/** Briefly test a production image. Due to the changing snapshot versions and
+ * netowrk dependencies when building an image, this isn't as thorough as the
+ * test image.
+ */
+
+/** Host address. */
+const hostAddress = process.env.HOST_ADDRESS ?? "https://localhost:3001";
+
+const delpaGitHubRawBaseUrl =
+  "https://raw.githubusercontent.com/delpa-org" as const;
+
+test("/ redirects to Delpa homepage", async () => {
+  const response = await fetch(`${hostAddress}/`, {
+    redirect: "manual",
+  });
+  expect(response.status).toBe(301);
+  expect(response.headers.get("location")).toBe("https://delpa.org");
+});
+
+test("/health-check returns 200 with OK", async () => {
+  const response = await fetch(`${hostAddress}/health-check`, {
+    redirect: "manual",
+  });
+  expect(response.status).toBe(200);
+  expect(await response.text()).toBe("OK");
+});
+
+describe("/snapshot", () => {
+  const snapshotFirstPathComp = "snapshot" as const;
+  test("Redirect with valid URL under /shapshot", async () => {
+    const response = await fetch(
+      `${hostAddress}/${snapshotFirstPathComp}/2025-01-02/subpath`,
+      {
+        redirect: "manual",
+      },
+    );
+
+    expect(response.status).toBe(301);
+    expect(response.headers.get("location")).toBe(
+      delpaGitHubRawBaseUrl +
+        "/melpa-snapshot-2025-01-02/refs/heads/master/packages/subpath",
+    );
+  });
+
+  test("Return 404 with invalid URL under /shapshot", async () => {
+    const response = await fetch(
+      `${hostAddress}/${snapshotFirstPathComp}/non-existing`,
+      {
+        redirect: "manual",
+      },
+    );
+
+    expect(response.status).toBe(404);
+    expect(response.headers.get("content-type")).toContain("text/plain");
+    expect(await response.text()).toBe("404 Not Found");
+  });
+});

prod.test.ts

@@ -0,0 +1 @@
+["2024-01-01", "2024-02-02", "2024-03-03"]