Migrate to MongoDB

.github/workflows/deps.yml

@@ -11,20 +11,15 @@ jobs:
     permissions:
       contents: write
     services:
-      postgres:
-        image: postgres
+      mongodb:
+        image: mongo
         env:
-          POSTGRES_PASSWORD: keepitsecret
-          POSTGRES_USER: testdb
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
+          MONGO_INITDB_ROOT_PASSWORD: keepitsecret
+          MONGO_INITDB_ROOT_USERNAME: testdb
         ports:
-          - 5432:5432
+          - 27017:27017
     env:
-      DATABASE_URL: postgres://testdb:keepitsecret@localhost:5432/testdb
+      MONGODB_URI: mongodb://testdb:keepitsecret@localhost:27017/testdb?authSource=admin
     steps:
       - uses: textbook/take-action@nodejs
         with:

.github/workflows/push.yml

@@ -20,20 +20,15 @@ jobs:
         node: [20.9, 20, 22]
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres
+      mongodb:
+        image: mongo
         env:
-          POSTGRES_PASSWORD: keepitsecret
-          POSTGRES_USER: testdb
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
+          MONGO_INITDB_ROOT_PASSWORD: keepitsecret
+          MONGO_INITDB_ROOT_USERNAME: testdb
         ports:
-          - 5432:5432
+          - 27017:27017
     env:
-      DATABASE_URL: postgres://testdb:keepitsecret@localhost:5432/testdb
+      MONGODB_URI: mongodb://testdb:keepitsecret@localhost:27017/testdb?authSource=admin
     steps:
       - uses: textbook/take-action@nodejs
         with:
@@ -49,18 +44,13 @@ jobs:
   docker:
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres
+      mongodb:
+        image: mongo
         env:
-          POSTGRES_PASSWORD: keepitsecret
-          POSTGRES_USER: testdb
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
+          MONGO_INITDB_ROOT_PASSWORD: keepitsecret
+          MONGO_INITDB_ROOT_USERNAME: testdb
         ports:
-          - 5432:5432
+          - 27017:27017
     steps:
       - uses: textbook/take-action@nodejs
         with:
@@ -74,10 +64,10 @@ jobs:
           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 'MONGODB_URI=mongodb://testdb:keepitsecret@localhost:27017/testdb?authSource=admin' >> "$ENV_FILE"
           echo 'NODE_ENV=docker' >> "$ENV_FILE"
+          echo 'PORT=4321' >> "$ENV_FILE"
           echo "file=$ENV_FILE" >> "$GITHUB_OUTPUT"
         env:
           ENV_FILE: docker.env

README.md

@@ -2,7 +2,7 @@
 
 - [x] [Node] LTS support (verified working on 20.x LTS release)
 - [x] [Express] server
-- [x] [Postgres] database with [`pg`][node-postgres]
+- [x] [MongoDB] database with [Mongoose]
 - [x] Logging with [Winston] and [Morgan]
 - [x] [React] client with [Vite]
 - [x] Client-side routing with [React Router]
@@ -36,12 +36,12 @@ commonly use:
 [Google App Engine]: https://cloud.google.com/appengine/?hl=en
 [Heroku]: https://www.heroku.com/
 [Jest]: https://jestjs.io/
+[MongoDB]: https://www.mongodb.com/
+[Mongoose]: https://mongoosejs.com/
 [Morgan]: https://github.com/expressjs/morgan
 [Node]: https://nodejs.org/en/
-[node-postgres]: https://node-postgres.com/
 [node-test]: https://nodejs.org/api/test.html
 [Playwright]: https://playwright.dev/
-[Postgres]: https://www.postgresql.org/
 [Prettier]: https://prettier.io/
 [React]: https://reactjs.org/
 [React Router]: https://reactrouter.com/en/main

api/app.js

@@ -2,7 +2,7 @@ import express from "express";
 
 import apiRouter from "./api.js";
 import { testConnection } from "./db.js";
-import config from "./utils/config.cjs";
+import config from "./utils/config.js";
 import {
 	asyncHandler,
 	clientRouter,

api/db.js

@@ -1,34 +1,31 @@
-import pg from "pg";
+import mongoose from "mongoose";
 
 import logger from "./utils/logger.js";
 
-/** @type {pg.Pool} */
-let pool;
+mongoose.connection.on("error", (err) => logger.error("%O", err));
+mongoose.set("debug", (collection, method, query, doc) => {
+	logger.debug("%O", { collection, method, query, doc });
+});
 
 /**
- * @param {import("pg").ClientConfig} config
+ * @param {string} uri
+ * @param {import("mongoose").ConnectOptions} [options]
  */
-export const connectDb = async (config) => {
-	pool = new pg.Pool(config);
-	pool.on("error", (err) => logger.error("%O", err));
-	const client = await pool.connect();
-	logger.info("connected to %s", client.database);
-	client.release();
+export const connectDb = async (uri, options) => {
+	const client = await mongoose.connect(uri, {
+		bufferCommands: false,
+		...options,
+	});
+	logger.info("connected to %s", client.connection.name);
 };
 
 export const disconnectDb = async () => {
-	if (pool) {
-		await pool.end();
-	}
+	await mongoose.disconnect();
 };
 
 export const testConnection = async () => {
-	await query("SELECT 1;");
+	const state = mongoose.connection.readyState;
+	if (state !== mongoose.ConnectionStates.connected) {
+		throw new Error(`database connection state: ${mongoose.STATES[state]}`);
+	}
 };
-
-function query(...args) {
-	logger.debug("Postgres query: %O", args);
-	return pool.query.apply(pool, args);
-}
-
-export default { query };

api/messages/messageRepository.js

@@ -1,6 +1,10 @@
-import db from "../db.js";
+import mongoose from "mongoose";
+
+const MessageSchema = new mongoose.Schema({ content: String });
+
+const Message = mongoose.model("messages", MessageSchema);
 
 export async function getAll() {
-	const { rows } = await db.query("SELECT * FROM message;");
+	const rows = await Message.find();
 	return rows;
 }

api/migrate-mongo-config.js

@@ -0,0 +1,16 @@
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import config from "./utils/config.js";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+/** @type {import("migrate-mongo").config.Config} */
+export default {
+	changelogCollectionName: "changelog",
+	migrationFileExtension: ".js",
+	migrationsDir: join(__dirname, "migrations"),
+	moduleSystem: "esm",
+	mongodb: { url: config.dbUrl },
+	useFileHash: false,
+};

api/migrations/20240916162136-welcome-message.js

@@ -0,0 +1,21 @@
+/**
+ * Template for
+ * {@link https://github.com/seppevs/migrate-mongo?tab=readme-ov-file#creating-a-new-migration-script defining migrations}.
+ */
+
+/**
+ * @param {import("mongodb").Db} db
+ * @param {import("mongodb").MongoClient} client
+ */
+export const up = async (db) => {
+	await db.collection("messages").insertOne({ content: "Hello, world!" });
+};
+
+/**
+ *
+ * @param {import("mongodb").Db} db
+ * @param {import("mongodb").MongoClient} client
+ */
+export const down = async (db) => {
+	await db.collection("messages").drop();
+};

api/migrations/sample-migration.js

@@ -0,0 +1,20 @@
+/**
+ * Template for
+ * {@link https://github.com/seppevs/migrate-mongo?tab=readme-ov-file#creating-a-new-migration-script defining migrations}.
+ */
+
+/**
+ * @param {import("mongodb").Db} db
+ * @param {import("mongodb").MongoClient} client
+ */
+export const up = async (db, client) => {
+	// TODO write your migration here.
+};
+
+/**
+ * @param {import("mongodb").Db} db
+ * @param {import("mongodb").MongoClient} client
+ */
+export const down = async (db, client) => {
+	// TODO reverse your migration here.
+};

api/package.json

@@ -7,21 +7,21 @@
 	"type": "module",
 	"scripts": {
 		"dev": "cross-env LOG_LEVEL=debug node --inspect --watch --watch-path . server.js",
-		"migration": "node-pg-migrate --config-file ./migrations/config.cjs",
-		"test": "cross-env DATABASE_URL=http://example.com NODE_OPTIONS='--experimental-vm-modules' jest",
+		"migration": "migrate-mongo",
+		"test": "cross-env MONGODB_URI=http://example.com NODE_OPTIONS='--experimental-vm-modules' jest",
 		"test:watch": "npm run test -- --watch"
 	},
 	"dependencies": {
 		"dotenv": "^16.4.5",
 		"express": "^4.21.0",
 		"helmet": "^7.1.0",
+		"migrate-mongo": "^11.0.0",
+		"mongoose": "^8.6.2",
 		"morgan": "^1.10.0",
-		"node-pg-migrate": "^7.6.1",
-		"pg": "^8.12.0",
 		"winston": "^3.14.2"
 	},
 	"devDependencies": {
-		"@testcontainers/postgresql": "^10.13.1",
+		"@testcontainers/mongodb": "^10.13.1",
 		"eslint-plugin-jest": "^28.8.3",
 		"eslint-plugin-n": "^17.10.2",
 		"jest": "^29.7.0",

api/server.js

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