Slight improvement: validate configuration

.prettierrc.json

@@ -1,2 +1,3 @@
 {
-}
+  "printWidth": 80
+}

docker-compose.yml

@@ -22,7 +22,8 @@ services:
     command: sh -c "./wait-for.sh db:3306 -- npm run start:dev"
 
   db:
-    image: mysql:5.6.44
+    platform: linux/x86_64
+    image: mysql:5.6.51
     container_name: db
     restart: unless-stopped
     ports:

package.json

@@ -35,10 +35,10 @@
     "node-cron": "^2.0.3",
     "pm2": "^4.5.0",
     "resource-router-middleware": "^0.6.0",
-    "twilio": "^3.49.4"
+    "twilio": "^3.71.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.11.6",
+    "@babel/cli": "^7.16.0",
     "@babel/core": "^7.11.6",
     "@babel/node": "^7.10.5",
     "@babel/plugin-proposal-optional-chaining": "^7.11.0",
@@ -52,6 +52,7 @@
     "eslint-plugin-mocha": "^8.0.0",
     "mocha": "^8.1.3",
     "node-random-name": "^1.0.1",
+    "nodemon": "^2.0.15",
     "nyc": "^15.1.0",
     "prettier": "2.1.2",
     "proxyquire": "^2.1.3",

src/api/handlers/appointments/postAppointments.test.js

@@ -6,7 +6,7 @@ import bodyParser from "body-parser";
 import * as appointments from "../../../models/appointments";
 import * as sendReminders from "../../../services/reminders";
 import api from "../../../api";
-import config from "../../../config";
+import { config } from "../../../config";
 
 config.jwtConfig.jwtSecret = "secret";
 
@@ -291,17 +291,14 @@ describe("POST /api/appointments", () => {
   it("should fail on letters in phone number", function (done) {
     const appointment = { ...baseAppointment };
     appointment.patientPhoneNumber = "A555555555";
-    request(app)
-      .post("/api/appointments")
-      .send(appointment)
-      .expect(
-        500,
-        {
-          message:
-            '"patientPhoneNumber" with value "A555555555" fails to match the required pattern: /^\\d+$/',
-        },
-        done
-      );
+    request(app).post("/api/appointments").send(appointment).expect(
+      500,
+      {
+        message:
+          '"patientPhoneNumber" with value "A555555555" fails to match the required pattern: /^\\d+$/',
+      },
+      done
+    );
   });
 
   it("should fail on whitespace only phone number", function (done) {

src/api/handlers/auth/getToken.js

@@ -1,5 +1,5 @@
 import jwt from "jsonwebtoken";
-import { jwtConfig } from "../../../config";
+import { config } from "../../../config";
 import { getUserByEmail, hashPassword } from "../../../models/users";
 
 /*
@@ -39,9 +39,9 @@ export async function getToken(req, res) {
   const payload = {
     userEmail: user.email,
   };
-  const token = jwt.sign(payload, jwtConfig.jwtSecret, {
+  const token = jwt.sign(payload, config.jwtConfig.jwtSecret, {
     algorithm: "HS256",
-    expiresIn: jwtConfig.jwtTokenExpiry,
+    expiresIn: config.jwtConfig.jwtTokenExpiry,
   });
 
   return res.json({

src/api/handlers/auth/getToken.test.js

@@ -5,7 +5,7 @@ import bodyParser from "body-parser";
 
 import * as users from "../../../models/users";
 import api from "../../../api";
-import config from "../../../config";
+import { config } from "../../../config";
 
 config.jwtConfig.jwtSecret = "secret";
 

src/config.js

@@ -1,6 +1,7 @@
+const Joi = require("@hapi/joi");
 const isDevelopment = process.env.NODE_ENV === "development";
 
-module.exports = {
+const config = {
   port: process.env.PORT || 8080,
   protocol: isDevelopment ? "http" : "https",
   bodyLimit: "100kb",
@@ -19,3 +20,29 @@ module.exports = {
     timezone: "America/Toronto",
   },
 };
+
+module.exports.config = config;
+
+module.exports.validateConfig = () => {
+  const { error } = Joi.object({
+    port: Joi.number().required(),
+    protocol: Joi.string().required().valid("http", "https"),
+    bodyLimit: Joi.string().required(),
+    corsHeaders: Joi.array().items(Joi.string()).required(),
+    twilioConfig: Joi.object({
+      number: Joi.string().required(),
+      accountSid: Joi.string().required(),
+      authToken: Joi.string().required(),
+    }).required(),
+    jwtConfig: Joi.object({
+      jwtSecret: Joi.string().required(),
+      jwtTokenExpiry: Joi.number().required(),
+    }).required(),
+    scheduler: Joi.object({
+      cron: Joi.string().required(),
+      timezone: Joi.string().required(),
+    }).required(),
+  }).validate(config);
+
+  if (error) throw new Error(error.message);
+};

src/index.js

@@ -6,49 +6,53 @@ import jwt from "express-jwt";
 import http from "http";
 import morgan from "morgan";
 import api from "./api";
-import config from "./config";
-import reminderScheduler from './services/scheduler'
-
-let app = express();
-app.server = http.createServer(app);
-
-// logger
-app.use(morgan("dev"));
-
-// 3rd party middleware
-app.use(
-  cors({
-    exposedHeaders: config.corsHeaders,
-  })
-);
-
-app.use(bodyParser.urlencoded({ extended: true }));
-
-app.use(
-  bodyParser.json({
-    limit: config.bodyLimit,
-  })
-);
-
-reminderScheduler.start();
-
-app.use(
-  jwt({
-    secret: config.jwtConfig.jwtSecret,
-    algorithms: ["HS256"],
-  }).unless({
-    path: [
-      "/api/twilio/reply", // Authentication handled by Twilio middleware
-      "/api/ping", // Open health check
-      "/api/auth", // Used to login
-    ],
-  })
-);
-
-app.use("/api", api({ config }));
-
-app.server.listen(config.port, () => {
-  console.log(`Started on port ${app.server.address().port}`);
-});
-
-export default app;
+import { config, validateConfig } from "./config";
+import reminderScheduler from "./services/scheduler";
+
+class Application {
+  constructor() {
+    this.app = express();
+  }
+
+  start() {
+    validateConfig();
+
+    this.app.server = http.createServer(this.app);
+    this.app.use(morgan("dev"));
+    // 3rd party middleware
+    this.app.use(cors({ exposedHeaders: config.corsHeaders }));
+    this.app.use(bodyParser.urlencoded({ extended: true }));
+    this.app.use(bodyParser.json({ limit: config.bodyLimit }));
+
+    // logger
+
+    reminderScheduler.start();
+
+    this.app.use(
+      jwt({ secret: config.jwtConfig.jwtSecret, algorithms: ["HS256"] }).unless(
+        {
+          path: [
+            "/api/twilio/reply", // Authentication handled by Twilio middleware
+            "/api/ping", // Open health check
+            "/api/auth", // Used to login
+          ],
+        }
+      )
+    );
+
+    this.app.use("/api", api({ config }));
+
+    this.app.server.listen(config.port, () => {
+      console.log(`Started on port ${this.app.server.address().port}`);
+    });
+  }
+
+  stop() {
+    this.app.server.close();
+  }
+}
+
+const application = new Application();
+application.start();
+
+export default application;

src/services/reminders.js

@@ -7,7 +7,7 @@ import {
 import { createMessage } from "../models/communications";
 import TemplatesModel from "../models/templates";
 import { sendMessage } from "./twilioClient";
-import config from "../config";
+import { config } from "../config";
 
 const daysFromNow = (interval) => {
   return moment()

src/services/scheduler.js

@@ -1,7 +1,7 @@
 var CronJob = require("cron").CronJob;
 
 import { sendReminders } from "../services/reminders";
-import config from "../config";
+import { config } from "../config";
 
 const tz = config.scheduler.timezone;
 

src/services/twilioClient.js

@@ -1,12 +1,15 @@
-import { twilioConfig } from "../config";
+import { config } from "../config";
 
 const twilio = require("twilio");
 const countryCode = "+1";
 
 export const webhook = twilio.webhook;
 
 export const sendMessage = (phoneNumber, message) => {
-  const client = twilio(twilioConfig.accountSid, twilioConfig.authToken);
+  const client = twilio(
+    config.twilioConfig.accountSid,
+    config.twilioConfig.authToken
+  );
   if (phoneNumber.length !== 10) {
     throw Error("Phone number must be 10 digits long.");
   }
@@ -17,7 +20,7 @@ export const sendMessage = (phoneNumber, message) => {
 
   return client.messages.create({
     body: message,
-    from: twilioConfig.number,
+    from: config.twilioConfig.number,
     to: `${countryCode}${phoneNumber}`,
   });
 };