Merge pull request #126 from sliit-foss/development

Spectator role addition and performance enhancements

Author: Akalanka47000

pnpm-lock.yaml

@@ -3,10 +3,10 @@ import context from 'express-http-context';
 import rateLimit from 'express-rate-limit';
 import httpLogger from '@sliit-foss/http-logger';
 import { moduleLogger } from '@sliit-foss/module-logger';
-import compression from 'compression';
-import cors from 'cors';
-import crypto from 'crypto';
-import helmet from 'helmet';
+import { default as compression } from 'compression';
+import { default as cors } from 'cors';
+import { default as crypto } from 'crypto';
+import { default as helmet } from 'helmet';
 import { omit, pick } from 'lodash';
 import { default as connectDB } from '@/database';
 import { errorHandler, queryMapper, responseInterceptor } from '@/middleware';
@@ -79,8 +79,6 @@ global.__basedir = __dirname;
 
 const port = process.env.PORT || 3000;
 
-app.listen(port, (err) => {
-  if (!err) {
-    logger.info(`Bashaway server successfully started on port ${port}`);
-  }
+app.listen(port, () => {
+  logger.info(`Bashaway server successfully started on port ${port}`);
 });

src/app.js

@@ -0,0 +1,2 @@
+export * from './question';
+export * from './user';

src/constants/index.js

@@ -0,0 +1,6 @@
+export const DIFFICULTY = {
+  EASY: 'EASY',
+  MEDIUM: 'MEDIUM',
+  HARD: 'HARD',
+  EXTREME: 'EXTREME'
+};

src/constants/question.js

@@ -0,0 +1,17 @@
+export const ROLE = {
+  ADMIN: 'ADMIN',
+  SPECTATOR: 'SPECTATOR',
+  GROUP: 'GROUP'
+};
+
+export const GENDER = {
+  MALE: 'M',
+  FEMALE: 'F',
+  OTHER: 'O',
+  NOT_SPECIFIED: '-'
+};
+
+export const MEAL_PREFERENCE = {
+  VEG: 'VEG',
+  NON_VEG: 'NON_VEG'
+};

src/constants/user.js

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import handlebars from 'handlebars';
 import { default as createError } from 'http-errors';
-import path from 'path';
+import { default as path } from 'path';
 import { getRegistrationDeadline } from '@/repository/settings';
 import { blacklistToken } from '@/repository/token';
 import { getOneUser } from '@/repository/user';

src/controllers/auth.js

@@ -1,8 +1,9 @@
+import { ROLE } from '@/constants';
 import { getDistinctSubmissions } from '@/repository/submission';
 
 export const attachSubmissionAttributesToQuestion = async (question, user) => {
   const submissions = await getDistinctSubmissions(question._id);
   question.total_submissions = submissions.length;
-  if (user.role === 'GROUP') question.submitted = submissions.some((s) => s.user.toString() === user._id.toString());
+  if (user.role === ROLE.GROUP) question.submitted = submissions.some((s) => s.user.toString() === user._id.toString());
   return question;
 };

src/helpers/question.js

@@ -23,7 +23,9 @@ export const protect = asyncHandler(async (req) => {
   req.user = user;
 });
 
-export const adminProtect = asyncHandler((req) => {
-  if (req.headers['x-api-key'] === process.env.API_ACCESS_KEY) return;
-  if (req.user.role !== 'ADMIN') throw new createError(403, 'You are not permitted to access this resource');
-});
+export const roleProtect = (roles = []) => {
+  return asyncHandler((req) => {
+    if (req.headers['x-api-key'] === process.env.API_ACCESS_KEY) return;
+    if (!roles.includes(req.user?.role)) throw new createError(403, 'You are not permitted to access this resource');
+  });
+};

src/middleware/auth.js

@@ -1,5 +1,6 @@
 import mongoose from 'mongoose';
 import mongoosePaginate from 'mongoose-paginate-v2';
+import { DIFFICULTY } from '@/constants';
 
 const QuestionSchema = new mongoose.Schema(
   {
@@ -14,8 +15,9 @@ const QuestionSchema = new mongoose.Schema(
     },
     difficulty: {
       type: String,
-      enum: ['EASY', 'MEDIUM', 'HARD', 'EXTREME'],
-      required: true
+      enum: Object.values(DIFFICULTY),
+      required: true,
+      index: true
     },
     constraints: [
       {
@@ -28,12 +30,14 @@ const QuestionSchema = new mongoose.Schema(
     },
     enabled: {
       type: Boolean,
-      default: true
+      default: true,
+      index: true
     },
     creator: {
       type: mongoose.Schema.Types.ObjectId,
       ref: 'User',
-      required: true
+      required: true,
+      index: true
     },
     creator_lock: {
       type: Boolean,

src/models/question.js

@@ -6,12 +6,14 @@ const SubmissionSchema = mongoose.Schema(
     user: {
       type: mongoose.Schema.Types.ObjectId,
       ref: 'User',
-      required: true
+      required: true,
+      index: true
     },
     question: {
       type: mongoose.Schema.Types.ObjectId,
       ref: 'Question',
-      required: true
+      required: true,
+      index: true
     },
     link: {
       type: String,