Modernize API: Update Node.js & deps, ESM, & more

.env.dist

@@ -1,5 +1,4 @@
 NODE_ENV=development
 
-BUGSNAG_API_KEY=
 DATABASE_URL=postgres://postgres:password@localhost:5432/piratepx_development
 PORT=3000

.nvmrc

@@ -1 +1 @@
-14
+22

LICENSE

@@ -1,21 +1,20 @@
 MIT License
 
-Copyright (c) 2020 piratepx
+Copyright (c) 2024 piratepx
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -15,7 +15,7 @@ there to make this possible, however, they're pretty much separate codebases.
 ### Backend
 
 The backend is a JSON REST API built in [Node.js](https://nodejs.org/) using
-[Fastify](https://www.fastify.io/) and
+[Fastify](https://www.fastify.dev/) and
 [Objection.js](https://vincit.github.io/objection.js/). It persists data to a
 [PostgreSQL](https://www.postgresql.org/) database.
 
@@ -40,14 +40,13 @@ development, with a focus on backend-specific details. See
 
 - [Node.js](https://nodejs.org/) (see `engines.node` in
   [`package.json`](package.json))
-- [PostgreSQL](https://www.postgresql.org/) >= v11
+- [PostgreSQL](https://www.postgresql.org/) >= v16
 
 [Docker Compose](https://docs.docker.com/compose/) is used to run PostgreSQL as
-configured in [`docker-compose.yml`](docker-compose.yml). Once installed, simply
-run:
+configured in [`compose.yaml`](compose.yaml). Once installed, simply run:
 
 ```bash
-$ docker-compose up
+$ docker compose up
 ```
 
 The app itself is not run in a Docker container in development, as it's easy
@@ -77,18 +76,10 @@ See [`.env.dist`](.env.dist) for an example.
 
 ### Database
 
-#### Create
-
-Ensure PostgreSQL is running, then:
-
-```bash
-$ npm run dev:db:create
-```
-
 #### Migrations
 
-[Knex.js](https://knexjs.org/#Migrations) is used to manage database migrations,
-which are located in [`api/db/migrations`](api/db/migrations).
+[Knex.js](https://knexjs.org/guide/migrations.html) is used to manage database
+migrations, which are located in [`api/db/migrations`](api/db/migrations).
 
 To run the latest migrations:
 
@@ -106,15 +97,15 @@ $ npm run dev
 
 ### Code Style & Linting
 
-[Prettier](https://prettier.com/) is setup to enforce a consistent code style.
+[Prettier](https://prettier.io/) is setup to enforce a consistent code style.
 It's highly recommended to
 [add an integration to your editor](https://prettier.io/docs/en/editors.html)
 that automatically formats on save.
 
 [ESLint](https://eslint.org/) is setup with the
-["recommended" rules](https://eslint.org/docs/rules/) to enforce a level of code
-quality. It's also highly recommended to
-[add an integration to your editor](https://eslint.org/docs/user-guide/integrations#editors)
+["recommended" rules](https://eslint.org/docs/latest/rules/) to enforce a level
+of code quality. It's also highly recommended to
+[add an integration to your editor](https://eslint.org/docs/latest/use/integrations#editors)
 that automatically formats on save.
 
 To run via the command line:

api/app.js

@@ -1,28 +1,33 @@
-const path = require('path')
+import { join } from 'node:path'
 
-const AutoLoad = require('fastify-autoload')
+import autoLoad from '@fastify/autoload'
 
-const initializers = require('./initializers')
+import initializers from '#api/initializers/index'
 
-require('@/services/bugsnag')
+import { apiDir } from '#api/lib/paths'
+import cronJobScheduler from '#api/services/cron_job_scheduler'
+import errorHandler, { errorSchema } from '#api/services/errors/error_handler'
 
-const errorHandler = require('@/plugins/error_handler')
-const scheduleCronJobs = require('@/services/schedule_cron_jobs')
-
-module.exports = async (fastify, opts) => {
+// eslint-disable-next-line no-unused-vars
+async function app(fastify, options) {
   await initializers()
 
-  fastify.register(AutoLoad, {
-    dir: path.join(__dirname, 'plugins', 'common'),
-    options: { ...opts },
-  })
+  fastify.addSchema(errorSchema)
+  fastify.setErrorHandler(errorHandler)
 
-  fastify.register(AutoLoad, {
-    dir: path.join(__dirname, 'routes'),
-    options: { ...opts },
+  await fastify.register(autoLoad, {
+    dir: join(apiDir, 'plugins'),
+    encapsulate: false,
   })
 
-  fastify.setErrorHandler(errorHandler)
+  fastify.register(autoLoad, {
+    dir: join(apiDir, 'routes'),
+    autoHooks: true,
+    cascadeHooks: true,
+    routeParams: true,
+  })
 
-  scheduleCronJobs()
+  cronJobScheduler()
 }
+
+export default app

api/db/config.js

@@ -1,9 +1,15 @@
+import { env } from 'node:process'
+
 const defaults = {
   client: 'pg',
-  connection: process.env.DATABASE_URL,
+  connection: env.DATABASE_URL,
+  pool: {
+    min: 0,
+    max: 10,
+  },
 }
 
-module.exports = {
+const config = {
   development: {
     ...defaults,
     debug: true,
@@ -12,3 +18,5 @@ module.exports = {
     ...defaults,
   },
 }
+
+export default config

api/db/index.js

@@ -1,5 +1,8 @@
-const Knex = require('knex')
+import Knex from 'knex'
+import { env } from 'node:process'
 
-const config = require('@/db/config')
+import config from '#api/db/config'
 
-module.exports = Knex(config[process.env.NODE_ENV])
+const db = Knex(config[env.NODE_ENV])
+
+export default db

api/db/migrations/20200713072454_create_uuid_ossp_extension.js

@@ -1,3 +1,9 @@
-exports.up = (knex) => knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"')
+async function up(knex) {
+  return await knex.raw('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"')
+}
 
-exports.down = (knex) => knex.raw('DROP EXTENSION IF EXISTS "uuid-ossp"')
+async function down(knex) {
+  return await knex.raw('DROP EXTENSION IF EXISTS "uuid-ossp"')
+}
+
+export { up, down }

api/db/migrations/20200713072746_create_users.js

@@ -1,5 +1,5 @@
-exports.up = (knex) =>
-  knex.schema.createTable('users', (t) => {
+async function up(knex) {
+  return await knex.schema.createTable('users', (t) => {
     t.uuid('id')
       .defaultTo(knex.raw('uuid_generate_v4()'))
       .notNullable()
@@ -8,5 +8,10 @@ exports.up = (knex) =>
     t.datetime('created_at').notNullable()
     t.datetime('updated_at').notNullable()
   })
+}
 
-exports.down = (knex) => knex.schema.dropTable('users')
+async function down(knex) {
+  return await knex.schema.dropTable('users')
+}
+
+export { up, down }

api/db/migrations/20200713073113_create_projects.js

@@ -1,5 +1,5 @@
-exports.up = (knex) =>
-  knex.schema.createTable('projects', (t) => {
+async function up(knex) {
+  return await knex.schema.createTable('projects', (t) => {
     t.uuid('id')
       .defaultTo(knex.raw('uuid_generate_v4()'))
       .notNullable()
@@ -11,5 +11,10 @@ exports.up = (knex) =>
     t.datetime('created_at').notNullable()
     t.datetime('updated_at').notNullable()
   })
+}
 
-exports.down = (knex) => knex.schema.dropTable('projects')
+async function down(knex) {
+  return await knex.schema.dropTable('projects')
+}
+
+export { up, down }

api/db/migrations/20200713073310_create_counts.js

@@ -1,5 +1,5 @@
-exports.up = (knex) =>
-  knex.schema.createTable('counts', (t) => {
+async function up(knex) {
+  return await knex.schema.createTable('counts', (t) => {
     t.uuid('id')
       .defaultTo(knex.raw('uuid_generate_v4()'))
       .notNullable()
@@ -13,5 +13,10 @@ exports.up = (knex) =>
 
     t.unique(['project_id', 'identifier', 'date'])
   })
+}
 
-exports.down = (knex) => knex.schema.dropTable('counts')
+async function down(knex) {
+  return await knex.schema.dropTable('counts')
+}
+
+export { up, down }

api/db/migrations/20201007055505_add_shared_secret_to_projects.js

@@ -1,9 +1,13 @@
-exports.up = (knex) =>
-  knex.schema.table('projects', (t) => {
+async function up(knex) {
+  return await knex.schema.table('projects', (t) => {
     t.string('shared_secret').unique()
   })
+}
 
-exports.down = (knex) =>
-  knex.schema.table('projects', (t) => {
+async function down(knex) {
+  return await knex.schema.table('projects', (t) => {
     t.dropColumn('shared_secret')
   })
+}
+
+export { up, down }

api/initializers/index.js

@@ -1,10 +1,11 @@
-require('dotenv').config()
-require('module-alias/register')
+import 'dotenv/config'
 
-const objection = require('@/initializers/objection')
-const pg = require('@/initializers/pg')
+import initializeObjection from '#api/initializers/objection'
+import initializePG from '#api/initializers/pg'
 
-module.exports = async () => {
-  pg()
-  await objection()
+async function initializers() {
+  initializePG()
+  await initializeObjection()
 }
+
+export default initializers

api/initializers/objection.js

@@ -1,9 +1,11 @@
-const { Model } = require('objection')
+import { Model } from 'objection'
 
-const db = require('@/db')
+import db from '#api/db/index'
 
-module.exports = () => {
+async function initializeObjection() {
   Model.knex(db)
 
-  return db.raw("SELECT 'Hello?'")
+  await db.raw("SELECT 'Hello?'")
 }
+
+export default initializeObjection

api/initializers/pg.js

@@ -1,7 +1,9 @@
-const { types } = require('pg')
+import pg from 'pg'
 
-module.exports = () => {
+function initializePG() {
   // Parse date type as string instead of Date to prevent time zone conversion.
   // See: https://github.com/brianc/node-postgres/issues/1844
-  types.setTypeParser(1082, (date) => date)
+  pg.types.setTypeParser(1082, (date) => date)
 }
+
+export default initializePG

api/lib/paths.js

@@ -0,0 +1,8 @@
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const rootDir = join(dirname(fileURLToPath(import.meta.url)), '..', '..')
+const apiDir = join(rootDir, 'api')
+const webDir = join(rootDir, 'web')
+
+export { rootDir, apiDir, webDir }

api/lib/pick.js

@@ -1,4 +1,4 @@
-module.exports = (obj, keys) => {
+function pick(obj, keys) {
   if (!obj) {
     return null
   }
@@ -13,3 +13,5 @@ module.exports = (obj, keys) => {
 
   return picked
 }
+
+export default pick

api/lib/px.js

@@ -1,4 +1,8 @@
-module.exports = Buffer.from(
+import { Buffer } from 'buffer'
+
+const px = Buffer.from(
   'R0lGODlhAQABAHAAACH5BAUAAAAALAAAAAABAAEAAAICRAEAOw==',
-  'base64'
+  'base64',
 )
+
+export default px