Merge pull request #211 from BritishYouthBandAssociation/refactor

Refactor

Author: rugulous

WPOrderProcessor.js

@@ -3,7 +3,8 @@
 const {
 	helpers: {
 		StringHelper
-	}
+	},
+	constants
 } = require(global.__lib);
 
 class WPOrderProcessor {
@@ -51,7 +52,7 @@ class WPOrderProcessor {
 			Name: StringHelper.toTitleCase(orgName),
 			Slug: slug,
 			Description: '',
-			OrganisationTypeId: 1
+			OrganisationTypeId: constants.ORGANISATION_TYPE.BAND
 		};
 
 		let matchedOrg = await this.#db.Organisation.findOne({

app.js

@@ -1,16 +1,9 @@
 'use strict';
 
 // Import modules
-const express = require('express');
-const { engine } = require('express-handlebars');
-const fs = require('fs');
-const morgan = require('morgan');
 const path = require('path');
-const serveFavicon = require('serve-favicon');
 const session = require('express-session');
 const SequelizeStore = require('connect-session-sequelize')(session.Store);
-const os = require('os');
-const formData = require('express-form-data');
 
 // Initialise library path
 const libPath = path.join(__dirname, process.env.LIB_PATH ?? '../Library');
@@ -20,80 +13,36 @@ global.__lib = libPath;
 const {
 	helpers: {
 		ConfigHelper,
-		HandlebarsHelper
-	}
+	},
+	Server,
+	constants
 } = require(libPath);
 
 //set global base dir
 global.__approot = __dirname;
 
-/**
- * loadRoutes() Loads all of the routes from /routers into a map
- *
- * @return {Array<Array<String, Object>>} All of the routes
- */
-function loadRoutes() {
-	const routes = [];
-
-	const routeFiles = fs.readdirSync(path.join(__dirname, 'routes'))
-		.filter(file => file.endsWith('.js'));
-
-	for (const file of routeFiles) {
-		const route = require(path.join(__dirname, 'routes', file));
-		routes.push([route.root, route.router]);
-	}
-
-	return routes;
-}
-
 async function main() {
 	// Initialise express app
-	const app = express();
+	const app = Server({
+		dir: __dirname
+	});
 
 	// Import configuration
 	const serverOptions = ConfigHelper.importJSON(path.join(__dirname, 'config'), 'server');
 
 	// Add logging middleware
 	if (serverOptions.logging) {
-		app.use(morgan('tiny', {
-			// don't log out static files and unnecessary fluff
-			skip: (req, res) => {
-				return /(^\/(js|css|fonts|assets|favicon)|(png|jpg|css))/.test(req.path);
-			}
-		}));
+		app.enableLogging('tiny', (req) => /(^\/(js|css|fonts|assets|favicon)|(png|jpg|css))/.test(req.path));
 	}
 
 	// Set up handlebars templating engine
-	app.engine(
-		'hbs',
-		engine({
-			extname: '.hbs',
-			helpers: HandlebarsHelper,
-			runtimeOptions: {
-				allowProtoPropertiesByDefault: true,
-				allowProtoMethodsByDefault: true
-			}
-		})
-	);
-	app.set('view engine', 'hbs');
-	app.set('views', path.join(__dirname, 'views'));
-
-	//allow file uploads
-	app.use(formData.parse({
-		uploadDir: os.tmpdir(),
-		autoClean: true
-	}));
-	app.use(formData.format());
-
-	// Set up parsers to allow access to POST bodies
-	app.use(express.json());
-	app.use(express.urlencoded({
-		extended: true
-	}));
-
-	// Set up routes for static files
-	app.use(serveFavicon(
-		path.join(__dirname, 'public/assets/favicon.ico')));
+	app.useHandlebars('hbs', {
+		extname: '.hbs',
+		runtimeOptions: {
+			allowProtoPropertiesByDefault: true,
+			allowProtoMethodsByDefault: true
+		}
+	});
 
 	// Serve the production vue script if in production environment
 	app.get('/js/vue.js', (req, res, next) => {
@@ -104,17 +53,12 @@ async function main() {
 		next();
 	});
 
-	app.use(express.static(path.join(__dirname, 'public')));
+	app.addStaticDir(path.join(__dirname, 'public'));
 
 	// Get database models and connection
 	const dbPath = path.join(libPath, 'models');
 	const db = await require(dbPath)(path.join(__dirname, 'config/db'));
-
-	//add global db
-	app.use((req, res, next) => {
-		req.db = db;
-		next();
-	});
+	app.registerGlobals({db});
 
 	//... and use it for our session stuff too!
 	const sessionStore = new SequelizeStore({ db: db.sequelize });
@@ -137,11 +81,7 @@ async function main() {
 				return res.redirect(`/?next=${req.path}`);
 			}
 		} else {
-			req.session.user = await req.db.User.findOne({
-				where: {
-					id: req.session.user.id
-				}
-			});
+			req.session.user = await req.db.User.findByPk(req.session.user.id);
 
 			req.session.user.bands = await req.db.Organisation.findAll({
 				include: [{
@@ -152,7 +92,7 @@ async function main() {
 					attributes: []
 				}],
 				where: {
-					OrganisationTypeId: 1 //we only want associated bands here
+					OrganisationTypeId: constants.ORGANISATION_TYPE.BAND
 				}
 			});
 
@@ -186,17 +126,14 @@ async function main() {
 		next();
 	});
 
-	// Add external routers to express
-	for (const route of loadRoutes()) {
-		app.use(route[0], route[1]);
-	}
+	app.loadRoutes();
 
 	/*
 	 * If the request gets to the bottom of the route stack, it doesn't
 	 * have a defined route and therefore a HTTP status code 404 is sent
 	 * and an error page shown
 	 */
-	app.use((req, res) => {
+	app.use((_, res) => {
 		res.status(404).render('error', {
 			title: 'Error',
 			code: 404,

gulpfile.js

@@ -109,7 +109,7 @@ function overwriteReadme(cb) {
 	const readmePath = path.join(__dirname, 'README.md');
 	const templatePath = path.join(__dirname, 'TEMPLATE_README.md');
 
-	if (!fs.existsSync(readmePath) | !fs.existsSync(templatePath)) {
+	if (!fs.existsSync(readmePath) || !fs.existsSync(templatePath)) {
 		return cb();
 	}
 

middleware.js

@@ -0,0 +1,40 @@
+'use strict';
+
+function resolveDynamicAccessor(object, accessor){
+	if (typeof accessor == 'string'){
+		return object[accessor];
+	}
+
+	for (let i = 0; i < accessor.length; i++){
+		object = object[accessor[i]];
+
+		if (object == null){
+			return null;
+		}
+	}
+
+	return object;
+}
+
+module.exports = {
+	checkAdmin(req, res, next){
+		if (!req.session.user.IsAdmin) {
+			return res.redirect('/no-access');
+		}
+
+		next();
+	},
+
+	matchingID(paramProp, sessionProp){
+		return (req, res, next) => {
+			const id = resolveDynamicAccessor(req.params, paramProp);
+			const valueToCheck = resolveDynamicAccessor(req.session, sessionProp);
+
+			if (id != valueToCheck && !req.session.user.IsAdmin){
+				return res.redirect('/no-access');
+			}
+
+			next();
+		};
+	}
+};

routes/api.js

@@ -38,16 +38,8 @@ router.get('/organisation', validator.query(Joi.object({
 router.get('/organisation/search', validator.query(Joi.object({
 	q: Joi.string()
 		.required()
-})), async (req, res, next) => {
-	const orgs = await req.db.Organisation.findAll({
-		include: [req.db.OrganisationType],
-		where: {
-			Name: {
-				[req.db.Sequelize.Op.like]: `%${req.query.q}%`
-			}
-		}
-	});
-
+})), async (req, res) => {
+	const orgs = await req.db.Organisation.search(req.query.q);
 	res.json(orgs);
 });
 
@@ -65,24 +57,7 @@ router.get('/membership/:season', validator.query(Joi.object({
 		where.MembershipTypeId = req.query.type;
 	}
 
-	const members = await req.db.Membership.findAll({
-		include: [
-			req.db.Label,
-			req.db.MembershipType,
-			{
-				model: req.db.IndividualMembership,
-				include: [req.db.User]
-			},
-			{
-				model: req.db.OrganisationMembership,
-				include: {
-					model: req.db.Organisation,
-					include: [req.db.OrganisationType]
-				}
-			}
-		],
-		where: where
-	});
+	const members = await req.db.Membership.getAll(where);
 
 	res.json(members);
 });
@@ -100,24 +75,12 @@ router.get('/caption/:id/judges/search', validator.query(Joi.object({
 		return next();
 	}
 
-	const judges = await req.db.User.findAll({
-		include: [{
-			model: req.db.Caption,
-			where: {
-				id: caption.id
-			}
-		}],
+	const judges = await req.db.User.searchByName(req.query.q, [{
+		model: req.db.Caption,
 		where: {
-			[Op.or]: {
-				FirstName: {
-					[Op.like]: `%${req.query.q}%`
-				},
-				Surname: {
-					[Op.like]: `%${req.query.q}%`
-				}
-			}
+			id: caption.id
 		}
-	});
+	}]);
 
 	res.json(judges);
 });

routes/config.js

@@ -8,13 +8,7 @@ const validator = require('@byba/express-validator');
 
 const router = express.Router();
 
-const checkAdmin = (req, res, next) => {
-	if (!req.session.user.IsAdmin) {
-		return res.redirect('/no-access');
-	}
-
-	next();
-};
+const {checkAdmin} = require('../middleware');
 
 router.get('/', checkAdmin, (req, res) => {
 	const sections = ['Membership Type', 'Organisation Type', 'Event Type', 'Payment Type', 'Division', 'Caption', 'Season'];
@@ -158,11 +152,8 @@ router.get('/event-type', checkAdmin, validator.query(Joi.object({
 			['id'],
 			[req.db.EventTypeDiscount, 'DiscountAfter']
 		]
-	}), req.db.MembershipType.findAll({
-		where: {
-			IsOrganisation: true,
-			IsActive: true
-		}
+	}), req.db.MembershipType.getActive({
+		IsOrganisation: true
 	})]);
 
 	return res.render('config/event-type.hbs', {
@@ -433,16 +424,7 @@ router.get('/season', checkAdmin, validator.query(Joi.object({
 	next: Joi.string(),
 	needsSeason: Joi.boolean()
 })), async (req, res) => {
-	const season = await req.db.Season.findOne({
-		where: {
-			Start: {
-				[Op.lte]: Date.now()
-			},
-			End: {
-				[Op.gte]: Date.now()
-			}
-		}
-	});
+	const season = await req.db.Season.getCurrent();
 
 	const others = await req.db.Season.findAll({
 		where: {