Added "/auth" router and configured Passport, JWT.

Author: SandunWebDev

.env.example

@@ -11,6 +11,10 @@
 NODE_ENV=development
 PORT=4000 # Specifiy which PORT backend should be run on and also expose it in docker container.
 
+# Token Generting Specifics
+JWT_SECRET=mySuperSecretsP4$$w0rD
+JWT_EXPIRES=3600s
+
 # Below are mostly needed in CI enviroment.
 DOCKER_USERNAME=
 DOCKER_PASSWORD=

configs/mainConfigs.js

@@ -6,7 +6,10 @@ const { parsed: parsedEnvValues = {} } = dotenv.config(); // Loading & Parsing e
 // Default values for any enviroment. (Only applicable if specifcally not provided in terminal enviroment or .env file)
 const defaultEnvValues = {
  NODE_ENV: "development",
- PORT: "4000"
+ PORT: "4000",
+
+ JWT_SECRET: "superPassword!@#$",
+ JWT_EXPIRES: "3600s"
 };
 
 // Provide any override default value for specific enviroment here.

errorHandlers/handleCustomError.js

@@ -0,0 +1,22 @@
+// Custom Fucntion to Generate custom errors and redirect them to "customErrorHandler" middleware.
+
+module.exports = (next, config = {}) => {
+ // Configs and default values
+ const {
+ err = new Error(),
+ customErrType = "clientError",
+ statusCode = 500,
+ customErrMsg = "Server Error Occured.",
+ log = false
+ } = config;
+
+ const modifiedError = Object.assign({}, err, {
+ customErrType,
+ statusCode,
+ customErrMsg,
+ log
+ });
+
+ // This is get catched by "customErrorHandler" middleware.
+ next(modifiedError);
+};

errorHandlers/middlewares/customErrorHandler.js

@@ -0,0 +1,20 @@
+// Custome Error Middleware to catch error directed by "handleCustomError(next, config)".
+
+const config = require("../../configs/mainConfigs");
+
+module.exports = (err, req, res, next) => {
+ // Loggin error if its specified (log:true) and in development enviroment.
+ if (err.log === true && config.NODE_ENV === "development") {
+ console.log("Error Occured : \n", err);
+ }
+
+ // Only catch error that have custom property called "customErrType". All other errors get directed to next error middleware.
+ if (err.customErrType) {
+ return res.status(err.statusCode || 500).json({
+ success: false,
+ errMsg: err.customErrMsg || "Server Error Occured."
+ });
+ }
+
+ return next(err);
+};

errorHandlers/middlewares/defaultErrorHandler.js

@@ -0,0 +1,11 @@
+// Default Error Middleware to catch error directed by "next(err)" and any other errors that didn't get catched by other error middleware.
+const config = require("../../configs/mainConfigs");
+
+module.exports = (err, req, res, next) => {
+ // Loggin error in development enviroment
+ if (config.NODE_ENV === "development") {
+ console.log("Error Occured : \n", err);
+ }
+
+ res.status(500).json({ success: false, errMsg: "Server Error Occured." });
+};

expressServer.integration.test.js

@@ -1,7 +1,5 @@
 const request = require("supertest");
-
 const expressServer = require("./expressServer");
-const rootRouter = require("./routers/rootRouter");
 
 describe("Express Server Starting Point", () => {
  it("Should handle requests to Root Path sucessfully.", done => {

expressServer.js

@@ -1,10 +1,16 @@
 const express = require("express");
 const morgan = require("morgan");
 const cors = require("cors");
+const passport = require("passport");
 
+require("./passport/passportStrategies");
 const config = require("./configs/mainConfigs");
 
-const rootRouter = require("./routers/rootRouter");
+const customErrorHandler = require("./errorHandlers/middlewares/customErrorHandler");
+const defaultErrorHandler = require("./errorHandlers/middlewares/defaultErrorHandler");
+
+const rootRouter = require("./routers/rootRouter/rootRouter");
+const authRouter = require("./routers/authRouter/authRouter");
 
 const app = express();
 
@@ -17,12 +23,15 @@ app.use(cors()); // Enable all CORS requests from any origin.
 app.use(express.json());
 app.use(express.urlencoded({ extended: false }));
 
+// Public Endpoints
 app.use("/", rootRouter);
+app.use("/auth", authRouter);
 
-app.use((err, req, res, next) => {
- res.status(500).json({ success: false, errMsg: "Server Error Occured." });
-});
+// Error Handlers
+app.use(customErrorHandler);
+app.use(defaultErrorHandler);
 
+// Path not found is not a error. So we need custom middleware to catch them.
 app.use((req, res) => {
  res.status(404).json({ success: false, errMsg: "Requested Path Not Found." });
 });

package-lock.json

@@ -26,7 +26,11 @@
  "cors": "^2.8.5",
  "dotenv": "^6.2.0",
  "express": "^4.16.4",
- "morgan": "^1.9.1"
+ "jsonwebtoken": "^8.4.0",
+ "morgan": "^1.9.1",
+ "passport": "^0.4.0",
+ "passport-jwt": "^4.0.0",
+ "passport-local": "^1.0.0"
  },
  "devDependencies": {
  "codecov": "^3.1.0",

package.json

@@ -0,0 +1,32 @@
+const passport = require("passport");
+const handleCustomError = require("../../errorHandlers/handleCustomError");
+
+module.exports = (req, res, next) => {
+ passport.authenticate(
+ "jwt",
+ {
+ session: false
+ },
+ (err, user, info) => {
+ if (err) {
+ // Error Handled by "deafultErrorHandler" middleware.
+ return next(err);
+ }
+
+ // "user" not populated mean not authenticated.
+ if (!user) {
+ // Error Handled by "customErrorHandler" middleware.
+ return handleCustomError(next, {
+ customErrType: "clientError",
+ customErrMsg: "Invalid Token.",
+ statusCode: 401
+ });
+ }
+
+ // When custom error handlers used, its our responsibility to pass this if needed.
+ req.user = user;
+
+ return next();
+ }
+ )(req, res, next);
+};