Add Postgres

.eslintrc.json

@@ -0,0 +1,16 @@
+{
+	"extends": ["@codeyourfuture/standard", "prettier"],
+	"parserOptions": {
+		"ecmaVersion": 2022,
+		"sourceType": "module"
+	},
+	"plugins": ["import"],
+	"reportUnusedDisableDirectives": true,
+	"root": true,
+	"rules": {
+		"import/order": [
+			"error",
+			{ "alphabetize": { "order": "asc" }, "newlines-between": "always" }
+		]
+	}
+}

.github/workflows/push.yml

@@ -9,6 +9,21 @@ on:
 jobs:
   nodejs:
     runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: keepitsecret
+          POSTGRES_USER: testdb
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    env:
+      DATABASE_URL: postgres://testdb:keepitsecret@localhost:5432/testdb
     steps:
       - uses: textbook/take-action@nodejs
         with:
@@ -22,6 +37,19 @@ jobs:
       - run: npm run e2e:dev
   docker:
     runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: keepitsecret
+          POSTGRES_USER: testdb
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
     steps:
       - uses: textbook/take-action@nodejs
         with:
@@ -33,15 +61,24 @@ jobs:
           load: true
           push: false
           tags: textbook/starter-kit:v2
+      - id: env-file
+        run: |
+          echo 'DATABASE_URL=postgres://testdb:keepitsecret@localhost:5432/testdb' >> "$ENV_FILE"
+          echo 'LOG_LEVEL=debug' >> "$ENV_FILE"
+          echo 'PORT=4321' >> "$ENV_FILE"
+          echo 'NODE_ENV=docker' >> "$ENV_FILE"
+          echo "file=$ENV_FILE" >> "$GITHUB_OUTPUT"
+        env:
+          ENV_FILE: docker.env
       - id: docker-run
         run: |
           echo "id=$(docker run \
             --detach \
-            --env LOG_LEVEL=debug \
-            --env NODE_ENV=docker \
+            --env-file ${{ steps.env-file.outputs.file }} \
             --init \
-            --publish 4321:80 \
+            --network 'host' \
             textbook/starter-kit:v2)" >> $GITHUB_OUTPUT
+      - run: npx --yes wait-on --log --timeout 30000 http-get://localhost:4321
       - run: npm run e2e
         env:
           PLAYWRIGHT_BASE_URL: http://localhost:4321

api/.eslintrc → api/.eslintrc.json

@@ -3,7 +3,7 @@
 	"ignorePatterns": ["/static/"],
 	"overrides": [
 		{
-			"files": ["*.test.js"],
+			"files": ["*.test.js", "setupTests.js"],
 			"extends": ["plugin:jest/recommended"],
 			"rules": {
 				"jest/expect-expect": [
@@ -14,6 +14,9 @@
 			}
 		}
 	],
+	"parserOptions": {
+		"ecmaVersion": 2022
+	},
 	"rules": {
 		"no-console": "warn",
 		"no-restricted-syntax": [

api/app.js

@@ -1,7 +1,9 @@
 import express from "express";
 
+import db from "./db.js";
 import config from "./utils/config.js";
 import {
+	asyncHandler,
 	clientRouter,
 	configuredHelmet,
 	configuredMorgan,
@@ -20,7 +22,13 @@ if (config.production) {
 	app.use(httpsOnly());
 }
 
-app.get("/healthz", (_, res) => res.sendStatus(200));
+app.get(
+	"/healthz",
+	asyncHandler(async (_, res) => {
+		await db.query("SELECT 1;");
+		res.sendStatus(200);
+	}),
+);
 
 app.use(clientRouter("/api"));
 

api/db.js

@@ -0,0 +1,36 @@
+import { default as pg } from "pg";
+
+import config from "./utils/config.js";
+import logger from "./utils/logger.js";
+
+const databaseUrl = new URL(config.databaseUrl);
+
+const localDb = ["0.0.0.0", "127.0.0.1", "localhost"].includes(
+	databaseUrl.hostname,
+);
+const sslMode = ["prefer", "require", "verify-ca", "verify-full"].includes(
+	databaseUrl.searchParams.get("sslmode") ?? "none",
+);
+
+const pool = new pg.Pool({
+	connectionString: databaseUrl.toString(),
+	connectionTimeoutMillis: 5_000,
+	ssl: localDb ? false : { rejectUnauthorized: sslMode },
+});
+
+pool.on("error", (err) => logger.error("%O", err));
+
+export const connectDb = async () => {
+	const client = await pool.connect();
+	logger.info("connected to %s", client.database);
+	client.release();
+};
+
+export const disconnectDb = async () => await pool.end();
+
+export default {
+	query(...args) {
+		logger.debug("Postgres query: %O", args);
+		return pool.query.apply(pool, args);
+	},
+};

api/jest.config.js

@@ -5,4 +5,5 @@ export default {
 	coverageReporters: [["json", { file: "api.json" }], "text"],
 	rootDir: ".",
 	transform: {},
+	setupFilesAfterEnv: ["<rootDir>/setupTests.js"],
 };

api/package.json

@@ -17,6 +17,7 @@
 		"express": "^4.18.2",
 		"helmet": "^7.1.0",
 		"morgan": "^1.10.0",
+		"pg": "^8.11.3",
 		"winston": "^3.11.0"
 	},
 	"devDependencies": {

api/server.js

@@ -1,8 +1,10 @@
 import app from "./app.js";
-
+import { connectDb } from "./db.js";
 import config from "./utils/config.js";
 import logger from "./utils/logger.js";
 
 const { port } = config;
 
+await connectDb();
+
 app.listen(port, () => logger.info(`listening on ${port}`));

api/setupTests.js

@@ -0,0 +1,5 @@
+import { connectDb, disconnectDb } from "./db.js";
+
+beforeAll(() => connectDb());
+
+afterAll(() => disconnectDb());

api/utils/config.js

@@ -11,15 +11,29 @@ const dotenvPath = resolve(
 
 configDotenv({ path: dotenvPath });
 
+requireArgs(["DATABASE_URL"]);
+
 /**
+ * @property {URL} databaseUrl
  * @property {string} dotenvPath
  * @property {string} logLevel
  * @property {number} port
  * @property {boolean} production
  */
 export default {
+	databaseUrl: process.env.DATABASE_URL,
 	dotenvPath,
 	logLevel: process.env.LOG_LEVEL?.toLowerCase() ?? "info",
 	port: parseInt(process.env.PORT ?? "3000", 10),
 	production: process.env.NODE_ENV?.toLowerCase() === "production",
 };
+
+function requireArgs(required) {
+	const missing = required.filter((variable) => !process.env[variable]);
+	if (missing.length > 0) {
+		process.exitCode = 1;
+		throw new Error(
+			`missing required environment variable(s): ${missing.join(", ")}`,
+		);
+	}
+}

api/utils/middleware.js

@@ -9,6 +9,17 @@ import logger from "./logger.js";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
+export const asyncHandler = (handler) => {
+	/** @type {import("express").RequestHandler} */
+	return async (req, res, next) => {
+		try {
+			await handler(req, res, next);
+		} catch (err) {
+			next(err);
+		}
+	};
+};
+
 export const clientRouter = (apiRoot) => {
 	const staticDir = join(__dirname, "..", "static");
 	const router = Router();