feat: fastify (#77)

* feat: fastify

* feat: fastify

* feat: fastify

* feat: switch to plugin

Author: johnnyreilly

src/server/package.json

@@ -1,6 +1,7 @@
 {
     "name": "poor-clares-arundel-koa-server",
     "version": "1.0.0",
+    "type": "module",
     "scripts": {
         "build": "tsc",
         "dev:build": "pnpm run build && pnpm run client",
@@ -13,24 +14,18 @@
         "watch": "cross-env NODE_ENV=development nodemon --watch src/**/* -e ts,tsx --exec ts-node src/server/server.ts"
     },
     "dependencies": {
+        "@fastify/helmet": "^13.0.1",
+        "@fastify/static": "^8.0.3",
         "applicationinsights": "^3.4.0",
         "applicationinsights-native-metrics": "^0.0.11",
+        "fastify": "^5.2.0",
+        "fastify-plugin": "^5.0.1",
         "form-data": "^4.0.1",
-        "koa": "^2.13.4",
-        "koa-body": "^6.0.0",
-        "koa-helmet": "^8.0.0",
-        "koa-router": "^13.0.0",
-        "koa-send": "^5.0.1",
-        "koa-static": "^5.0.0",
         "mailgun.js": "^10.3.0"
     },
     "devDependencies": {
         "@eslint/js": "^9.17.0",
-        "@types/koa": "^2.13.5",
-        "@types/koa-router": "^7.4.4",
-        "@types/koa-send": "^4.1.3",
-        "@types/koa-static": "^4.0.2",
-        "@types/mailgun-js": "^0.22.13",
+        "@types/node": "^22.10.5",
         "@typescript-eslint/eslint-plugin": "^8.0.0",
         "@typescript-eslint/parser": "^8.0.0",
         "cpx2": "^8.0.0",

src/server/pnpm-lock.yaml

@@ -0,0 +1,44 @@
+import { FastifyInstance, FastifyPluginOptions } from 'fastify';
+import fp from 'fastify-plugin';
+import appInsights from 'applicationinsights';
+
+// based on https://github.com/microsoft/ApplicationInsights-node.js/issues/627#issuecomment-2194527018
+declare module 'fastify' {
+    export interface FastifyRequest {
+        app: { start: number };
+    }
+}
+
+export const appInsightsPlugin = fp(async (fastify: FastifyInstance, options: FastifyPluginOptions) => {
+    if (!options.client) {
+        console.log('App Insights not configured');
+        return;
+    }
+
+    const client: appInsights.TelemetryClient = options.client;
+
+    fastify.addHook('onRequest', async (request, _reply) => {
+        const start = Date.now();
+        request.app = { start };
+    });
+
+    fastify.addHook('onResponse', async (request, reply) => {
+        if (request.raw.url === '/') return; // Ignore health check
+
+        const duration = Date.now() - request.app.start;
+        client.trackRequest({
+            name: request.raw.method + ' ' + request.raw.url,
+            url: request.raw.url,
+            duration: duration,
+            resultCode: reply.statusCode.toString(),
+            success: reply.statusCode < 400,
+            properties: {
+                method: request.raw.method,
+                url: request.raw.url,
+            },
+            measurements: {
+                duration: duration,
+            },
+        });
+    });
+});

src/server/src/appInsightsPlugin.ts

@@ -1,13 +1,16 @@
-import Koa from 'koa';
-import helmet from 'koa-helmet';
-import send from 'koa-send';
-import serve from 'koa-static';
+import Fastify, { FastifyInstance } from 'fastify';
+import fastifyStatic from '@fastify/static';
+import helmet from '@fastify/helmet';
+
 import path from 'path';
-import * as appInsights from 'applicationinsights';
+import appInsights from 'applicationinsights';
+import { fileURLToPath } from 'url';
+
+import { config } from './config.js';
+import { routes } from './routes/index.js';
+import { appInsightsPlugin } from './appInsightsPlugin.js';
 
-import { config } from './config';
-import { logger } from './logging';
-import { routes } from './routes/index';
+let client: appInsights.TelemetryClient | undefined;
 
 if (config.appInsightsConnectionString) {
     appInsights
@@ -17,38 +20,63 @@ if (config.appInsightsConnectionString) {
         .setAutoCollectRequests(true)
         // .enableWebInstrumentation(true) // not being used on the client yet
         .start();
+
+    client = appInsights.defaultClient;
 }
 
-const app = new Koa();
+export const fastify: FastifyInstance = Fastify({
+    logger: true,
+});
+
+fastify.register(appInsightsPlugin, { client });
 
-app.use(
-    helmet.contentSecurityPolicy({
+fastify.register(helmet, {
+    contentSecurityPolicy: {
         useDefaults: true,
         directives: {
             scriptSrc: ["'self'", "'unsafe-inline'", 'storage.googleapis.com', 'www.google-analytics.com'],
             frameSrc: ['www.youtube.com', 'www.youtube-nocookie.com'],
         },
-    })
-);
-app.use(logger);
-app.use(routes);
+    },
+});
+
+routes(fastify);
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 const publicPath = path.join(__dirname, '..', 'client', 'dist');
 
-app.use(serve(publicPath));
-app.use(async (ctx) => {
-    await send(ctx, 'index.html', { root: publicPath });
+fastify.register(fastifyStatic, {
+    root: publicPath,
+    // prefix: '/public/',
+});
+
+fastify.setNotFoundHandler((_req, res) => {
+    res.sendFile('index.html');
 });
 
-app.listen(config.port);
+async function start() {
+    try {
+        await fastify.listen({
+            port: config.port,
+            host: '0.0.0.0', // necessary to run in Docker https://fastify.dev/docs/latest/Guides/Getting-Started/#note
+        });
 
-console.log(
-    `
-################
-# App started! #
-################
+        const address = fastify.server.address();
+        const port = typeof address === 'string' ? address : address?.port;
 
-- server running at: http://localhost:${config.port}
+        console.log(
+            `# App started! #
+- server running at: http://localhost:${port}
 - static files served from: ${publicPath}
 `
-);
+        );
+    } catch (err) {
+        console.error(err);
+        fastify.log.error(err);
+        process.exit(1);
+    }
+}
+
+start();

src/server/src/index.ts

@@ -1,12 +1,8 @@
-import { koaBody } from 'koa-body';
-import Router from 'koa-router';
-
-import { prayerRequestPOST } from './prayerRequestPOST';
-import { statusGET } from './statusGET';
-
-const router = new Router();
-
-router.get('/api/status', statusGET());
-router.post('/api/prayer-request', koaBody(), prayerRequestPOST());
-
-export const routes = router.routes();
+import { FastifyInstance } from 'fastify';
+import { prayerRequestPOST } from './prayerRequestPOST.js';
+import { statusGET } from './statusGET.js';
+
+export function routes(fastify: FastifyInstance) {
+    statusGET(fastify);
+    prayerRequestPOST(fastify);
+}

src/server/src/logging.ts

@@ -1,29 +1,46 @@
+import { FastifyInstance } from 'fastify';
 import FormData from 'form-data';
-import Router from 'koa-router';
-import Mailgun from 'mailgun.js';
+import mgjs from 'mailgun.js';
 
-import { config } from '../config';
+import { config } from '../config.js';
 
-export function prayerRequestPOST(): Router.IMiddleware<unknown, unknown> {
-    return async (ctx, _next) => {
-        console.log('prayerRequestPOST');
+export interface IPrayerRequest {
+    email: string;
+    prayFor: string;
+}
+
+export function prayerRequestPOST(fastify: FastifyInstance) {
+    fastify.post<{ Body: IPrayerRequest }>('/api/prayer-request', async (request, reply) => {
         // Invokes the method to send emails given the above data with the helper library
         try {
-            const { email, prayFor } = ctx.request.body;
+            const { email, prayFor } = request.body;
+
+            // console.log('email:', email);
+            // console.log('prayFor:', prayFor);
 
             if (!config.apiKey || !config.domain) {
-                throw new Error('APPSETTINGS_API_KEY and / or APPSETTINGS_DOMAIN not configured');
+                console.error('APPSETTINGS_API_KEY and / or APPSETTINGS_DOMAIN not configured');
+                reply.status(500);
+                return {
+                    success: false,
+                    text: 'Your prayer request has not been sent - please try again later.',
+                };
             }
 
             if (!config.prayerRequestFromEmail || !config.prayerRequestRecipientEmail) {
-                throw new Error(
+                console.error(
                     'APPSETTINGS_PRAYER_REQUEST_FROM_EMAIL and / or APPSETTINGS_PRAYER_REQUEST_RECIPIENT_EMAIL not configured'
                 );
+                reply.status(500);
+                return {
+                    success: false,
+                    text: 'Your prayer request has not been sent - please try again later.',
+                };
             }
 
             // We pass the api_key and domain to the wrapper, or it won't be able to identify + send emails
             // const mailgun = new Mailgun({ apiKey, domain });
-            const mailgun = new Mailgun(FormData);
+            const mailgun = new mgjs.default.default(FormData);
             const mg = mailgun.client({ username: 'api', key: config.apiKey });
 
             const prayerRequest = {
@@ -73,14 +90,14 @@ Your Poor Clare sisters, Arundel.`;
             // await mailgun.messages().send(reassuringResponse);
             await mg.messages.create(config.domain, reassuringResponse);
 
-            ctx.body = { ok: true, text: 'Thanks for sending your prayer request - we will pray.' };
+            return { ok: true, text: 'Thanks for sending your prayer request - we will pray.' };
         } catch (exc) {
             console.error(exc instanceof Error ? exc.message : exc);
 
-            ctx.body = {
+            return {
                 success: false,
                 text: `Your prayer request has not been sent - please try mailing: ${config.prayerRequestFromEmail}`,
             };
         }
-    };
+    });
 }

src/server/src/routes/index.ts

@@ -1,20 +1,20 @@
-import Router from 'koa-router';
+import { FastifyInstance } from 'fastify';
 
-import { config } from '../config';
+import { config } from '../config.js';
 
-export function statusGET(): Router.IMiddleware<unknown, unknown> {
-    return async (ctx, _next) => {
+export function statusGET(fastify: FastifyInstance) {
+    fastify.get('/api/status', async (_request, reply) => {
         try {
             console.log('statusGET');
             const { branchName, gitSha, builtAt } = config;
-            ctx.body = { 'branch-name': branchName, 'git-sha': gitSha, 'built-at': builtAt };
+            return { 'branch-name': branchName, 'git-sha': gitSha, 'built-at': builtAt };
         } catch (exc) {
             console.error(exc instanceof Error ? exc.message : exc);
 
-            ctx.status = 500;
-            ctx.body = {
+            reply.status(500);
+            return {
                 text: `There is a problem with the server. Please try again later.`,
             };
         }
-    };
+    });
 }