feat: api status endpoint

Author: johnnyreilly

.github/workflows/shared-build-and-deploy.yaml

@@ -136,6 +136,7 @@ jobs:
                   containerRegistryUsername=${{ github.actor }} \
                   containerRegistryPassword=${{ secrets.PACKAGES_TOKEN }} \
                   branchName="$BRANCH_NAME" \
+                  gitSha="${{ needs.build.outputs.sha-short }}" \
                   workspaceName='shared-log-analytics' \
                   appInsightsName='shared-app-insights' \
                   managedEnvironmentName='shared-env' \

infra/main.bicep

@@ -6,6 +6,7 @@ param containerRegistryUsername string
 param containerRegistryPassword string
 
 param branchName string
+param gitSha string
 
 param workspaceName string
 param appInsightsName string
@@ -141,6 +142,8 @@ resource webServiceContainerApp 'Microsoft.App/containerApps@2024-03-01' = {
               name: 'APPSETTINGS_PRAYER_REQUEST_RECIPIENT_EMAIL'
               value: APPSETTINGS_PRAYER_REQUEST_RECIPIENT_EMAIL
             }
+            { name: 'APPSETTINGS_BRANCH_NAME', value: branchName }
+            { name: 'APPSETTINGS_GIT_SHA', value: gitSha }
           ]
         }
       ]

src/server/src/config.ts

@@ -1,12 +1,23 @@
-
 export interface IConfig {
     port: number;
     prettyLog: boolean;
+    apiKey: string;
+    domain: string;
+    prayerRequestFromEmail: string;
+    prayerRequestRecipientEmail: string;
+    branchName: string;
+    gitSha: string;
 }
 
-const config = {
-    port: process.env.NODE_PORT || 3000,
+const config: IConfig = {
+    port: process.env.NODE_PORT ? Number(process.env.NODE_PORT) : 3000,
     prettyLog: process.env.NODE_ENV == 'development',
+    apiKey: process.env.APPSETTINGS_API_KEY ?? 'unknown', // long guid from mailgun
+    domain: process.env.APPSETTINGS_DOMAIN ?? 'unknown', // eg 'mg.priou.co.uk';
+    prayerRequestFromEmail: process.env.APPSETTINGS_PRAYER_REQUEST_FROM_EMAIL ?? 'unknown',
+    prayerRequestRecipientEmail: process.env.APPSETTINGS_PRAYER_REQUEST_RECIPIENT_EMAIL ?? 'unknown',
+    branchName: process.env.APPSETTINGS_BRANCH_NAME ?? 'unknown',
+    gitSha: process.env.APPSETTINGS_GIT_SHA ?? 'unknown',
 };
 
 export { config };

src/server/src/index.ts

@@ -6,7 +6,7 @@ import path from 'path';
 
 import { config } from './config';
 import { logger } from './logging';
-import { routes } from './routes';
+import { routes } from './routes/index';
 
 const isDevelopment = process.env.NODE_ENV === 'development';
 
@@ -19,7 +19,7 @@ app.use(
             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);
@@ -37,5 +37,5 @@ app.use(async (ctx) => {
 app.listen(config.port);
 
 console.log(
-    `Server running on port ${config.port}; static files served from ${publicPath}, SPA template from ${indexHtmlPath}`,
+    `Server running on port ${config.port}; static files served from ${publicPath}, SPA template from ${indexHtmlPath}`
 );

src/server/src/routes.ts

@@ -0,0 +1,13 @@
+import { koaBody } from 'koa-body';
+import Router from 'koa-router';
+// import * as Mailgun from 'mailgun-js';
+
+import { prayerRequestPOST } from './prayerRequestPOST';
+import { statusGET } from './statusGET';
+
+const router = new Router();
+
+router.get('/api/Status', statusGET());
+router.post('/api/PrayerRequest', koaBody(), prayerRequestPOST());
+
+export const routes = router.routes();

src/server/src/routes/index.ts

@@ -0,0 +1,85 @@
+import FormData from 'form-data';
+import Router from 'koa-router';
+import Mailgun from 'mailgun.js';
+
+import { config } from '../config';
+
+export function prayerRequestPOST(): Router.IMiddleware<unknown, unknown> {
+    return async (ctx, _next) => {
+        // Invokes the method to send emails given the above data with the helper library
+        try {
+            const { email, prayFor } = ctx.request.body;
+
+            if (!config.apiKey || !config.domain) {
+                throw new Error('APPSETTINGS_API_KEY and / or APPSETTINGS_DOMAIN not configured');
+            }
+
+            if (!config.prayerRequestFromEmail || !config.prayerRequestRecipientEmail) {
+                throw new Error(
+                    'APPSETTINGS_PRAYER_REQUEST_FROM_EMAIL and / or APPSETTINGS_PRAYER_REQUEST_RECIPIENT_EMAIL not configured'
+                );
+            }
+
+            // 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 mg = mailgun.client({ username: 'api', key: config.apiKey });
+
+            const prayerRequest = {
+                from: email, // prayerRequestFromEmail,
+                to: config.prayerRequestRecipientEmail,
+                subject: 'Please could you pray for me',
+                text: `Hi,
+
+I'd love it if you could pray for me about this:
+
+${prayFor}`,
+            };
+            // await mailgun.messages().send(prayerRequest);
+            await mg.messages.create(config.domain, prayerRequest);
+
+            const text = `Thank you for your prayer request.
+
+You are in our thoughts and prayers.
+
+Your Poor Clare sisters, Arundel.`;
+
+            const html = `<html>
+<head>
+    <title>Thank you for your prayer request.</title>
+</head>
+<body>
+    <div>
+        <img src="https://www.poorclaresarundel.org/prayer-request-image.webp" />
+    </div>
+    <div style="padding:10px;font-family: Verdana, Helvetica, Sans-Serif;">
+        <p>Thank you for your prayer request.</p>
+
+        <p>You are in our thoughts and prayers.</p>
+
+        <p>Your Poor Clare sisters, Arundel.</p>
+    </div>
+</body>
+</html>`;
+
+            const reassuringResponse = {
+                from: config.prayerRequestFromEmail,
+                to: email,
+                subject: 'Your prayer request',
+                text,
+                html,
+            };
+            // 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.' };
+        } catch (exc) {
+            console.error(exc instanceof Error ? exc.message : exc);
+
+            ctx.body = {
+                success: false,
+                text: `Your prayer request has not been sent - please try mailing: ${config.prayerRequestFromEmail}`,
+            };
+        }
+    };
+}

src/server/src/routes/prayerRequestPOST.ts

@@ -0,0 +1,19 @@
+import Router from 'koa-router';
+
+import { config } from '../config';
+
+export function statusGET(): Router.IMiddleware<unknown, unknown> {
+    return async (ctx, _next) => {
+        try {
+            const { branchName, gitSha } = config;
+            ctx.body = { branchName, gitSha };
+        } catch (exc) {
+            console.error(exc instanceof Error ? exc.message : exc);
+
+            ctx.status = 500;
+            ctx.body = {
+                text: `There is a problem with the server. Please try again later.`,
+            };
+        }
+    };
+}