From eb47953e3a9fa2350a2e393720c062ebf5233ff0 Mon Sep 17 00:00:00 2001
From: xfarrow <ale99napoli@icloud.com>
Date: Mon, 26 Feb 2024 14:56:40 +0100
Subject: [PATCH] some tidying up

---
 backend/apis/nodejs/src/app.js                | 33 ++++++++++++++++---
 .../apis/nodejs/src/routes/person_routes.js   |  2 +-
 .../{jwt_utils.js => middleware_utils.js}     |  0
 3 files changed, 29 insertions(+), 6 deletions(-)
 rename backend/apis/nodejs/src/utils/{jwt_utils.js => middleware_utils.js} (100%)

diff --git a/backend/apis/nodejs/src/app.js b/backend/apis/nodejs/src/app.js
index 7ec4504..fe42dea 100644
--- a/backend/apis/nodejs/src/app.js
+++ b/backend/apis/nodejs/src/app.js
@@ -11,7 +11,10 @@
     IN THE SOFTWARE.
 */
 
-// Importing modules
+/*
+===== BEGIN IMPORTING MODULES
+*/
+
 // TODO: clean up
 require('dotenv').config();
 const express = require('express');
@@ -21,9 +24,16 @@ const personRoutes = require('./routes/person_routes.js');
 const organizationRoutes = require('./routes/organization_routes.js');
 const organizationAdminRoutes = require('./routes/organization_admin_routes.js');
 const organizationPostRoutes = require('./routes/organization_post_routes.js');
-const jwt_utils = require('./utils/jwt_utils.js');
+const jwt_utils = require('./utils/middleware_utils.js');
+
+/*
+===== END IMPORTING MODULES
+*/
+
+/*
+===== BEGIN APPLICATION CONFIGURATION
+*/
 
-// Application configuration
 const app = express();
 app.use(express.json()); // Middleware which parses JSON for POST requests
 app.use(cors()); // Enable CORS for all routes
@@ -33,6 +43,14 @@ app.use(rateLimit({
   message: { error: 'Too many requests from this IP, please try again later' }
 })); // Apply the rate limiter middleware to all routes
 
+/*
+===== END APPLICATION CONFIGURATION
+*/
+
+/*
+===== BEGIN ROUTE HANDLING =====
+*/
+
 const publicRoutes = express.Router();
 publicRoutes.post('/register', personRoutes.registerPerson);
 publicRoutes.post('/login', personRoutes.login);
@@ -52,14 +70,19 @@ protectedRoutes.delete('/organization/:id', organizationRoutes.deleteOrganizatio
 protectedRoutes.post('/organization/post', organizationPostRoutes.createOrganizationPost);
 protectedRoutes.delete('/organization/post/:id', organizationPostRoutes.deleteOrganizationPost);
 
-// Mounting routes
 app.use('/api', publicRoutes); // Routes not requiring token
 app.use('/api', protectedRoutes); // Routes requiring token
 
-// Start the server. Default port is 3000
+/*
+===== END ROUTE HANDLING =====
+*/
+
+// Start the server
+// Default port is 3000
 const port = process.env.API_SERVER_PORT || 3000;
 app.listen(port, () => {
   console.log(`Blink API server is running on port ${port}`);
 });
 
+// Export the app for testing purposes
 module.exports = app;
diff --git a/backend/apis/nodejs/src/routes/person_routes.js b/backend/apis/nodejs/src/routes/person_routes.js
index ad62905..8ddb7b9 100644
--- a/backend/apis/nodejs/src/routes/person_routes.js
+++ b/backend/apis/nodejs/src/routes/person_routes.js
@@ -13,7 +13,7 @@
 
 const validator = require('../utils/validation');
 const knex = require('../utils/knex_config');
-const jwt_utils = require('../utils/jwt_utils');
+const jwt_utils = require('../utils/middleware_utils');
 const bcrypt = require('bcrypt');
 const crypto = require('crypto');
 const person_model = require('../models/person_model');
diff --git a/backend/apis/nodejs/src/utils/jwt_utils.js b/backend/apis/nodejs/src/utils/middleware_utils.js
similarity index 100%
rename from backend/apis/nodejs/src/utils/jwt_utils.js
rename to backend/apis/nodejs/src/utils/middleware_utils.js