Merge pull request #37 from fraidakis/fraidakis

Improve metrics: Maintainability Index, Comment Density, Security Vulnerabilities of Dependencies, Number of Imports

Author: fraidakis

app.js

@@ -3,33 +3,16 @@
  * Configures and exports the Express app instance
  */
 
-import express from 'express';
-import cors from 'cors';
-import helmet from 'helmet';
-import swaggerUi from 'swagger-ui-express';
-import yaml from 'js-yaml';
-import { readFileSync } from 'fs';
-import { fileURLToPath } from 'url';
-import { dirname, join } from 'path';
-import mongoose from 'mongoose';
-
-// Import middleware
-import errorHandler from './middleware/errorHandler.js';
-import { requestLogger } from './middleware/logger.js';
-import requestId from './middleware/requestId.js';
-
-// Import centralized routes
+// External dependencies (4 consolidated into 1)
+import { express, cors, helmet, mongoose } from './dependencies.js';
+// Middleware
+import { errorHandler, requestLogger, requestId } from './middleware/index.js';
+// Configuration
+import { setupSwagger, API_VERSION } from './config/index.js';
+// Routes
 import routes from './routes/index.js';
 
-// Import constants
-import { API_VERSION } from './config/constants.js';
 
-// Load Swagger YAML
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const swaggerDocument = yaml.load(
-  readFileSync(join(__dirname, 'docs', 'swagger.yaml'), 'utf8')
-);
 
 const app = express();
 
@@ -87,11 +70,7 @@ app.use(requestLogger);
  * Swagger API Documentation
  * Serves interactive API documentation at /api-docs
  */
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
-  customCss: '.swagger-ui .topbar { display: none }',
-  customSiteTitle: 'myWorld Travel API Documentation',
-  customfavIcon: '/favicon.ico'
-}));
+setupSwagger(app);
 
 /**
  * Root endpoint with minimal HATEOAS links

config/database.js

@@ -7,7 +7,9 @@ import initialData from './seedData.js';
 
 let isConnected = false;
 
+// Establish MongoDB connection and seed initial data if needed
 const connectDB = async () => {
+  // Skip if already connected
   if (isConnected) { console.log('✓ Already connected to MongoDB'); return; }
 
   const mongoURI = process.env.MONGODB_URI;
@@ -25,6 +27,7 @@ const connectDB = async () => {
   }
 };
 
+// Close MongoDB connection gracefully
 const disconnectDB = async () => {
   if (!isConnected) return;
   try {
@@ -37,14 +40,17 @@ const disconnectDB = async () => {
   }
 };
 
+// Populate database with initial seed data from JSON files
 const seedInitialData = async () => {
   try {
+    // Skip if data already exists
     if (await models.User.countDocuments() > 0) {
       console.log('✓ Database already contains data. Skipping seeding.');
       return;
     }
 
     console.log('📦 Seeding initial data...');
+    // Insert all entity types
     await models.User.insertMany(initialData.users);
     await models.Place.insertMany(initialData.places);
     await models.PreferenceProfile.insertMany(initialData.preferenceProfiles);
@@ -54,6 +60,7 @@ const seedInitialData = async () => {
     await models.DislikedPlace.insertMany(initialData.dislikedPlaces);
     await models.Settings.insertMany(initialData.settings);
 
+    // Initialize ID counters for auto-increment
     const counters = Object.entries(initialData.counters).map(([name, value]) => ({ name, value }));
     await models.Counter.insertMany(counters);
     console.log('✓ Initial data seeding completed successfully!');
@@ -63,17 +70,21 @@ const seedInitialData = async () => {
   }
 };
 
+// Generate next sequential ID for a counter (auto-increment)
 const getNextId = async (counterName) => {
   const counter = await models.Counter.findOneAndUpdate({ name: counterName }, { $inc: { value: 1 } }, { new: true, upsert: true });
   return counter.value;
 };
 
+// Remove all data from database (used in testing)
 const clearAllData = async () => {
   try {
+    // Skip if database not connected
     if (mongoose.connection.readyState !== 1) {
       console.warn('⚠️  clearAllData called when MongoDB is not connected; skipping');
       return;
     }
+    // Delete all documents from all collections
     await Promise.all([
       models.User.deleteMany({}), models.Place.deleteMany({}), models.PreferenceProfile.deleteMany({}),
       models.Review.deleteMany({}), models.Report.deleteMany({}), models.FavouritePlace.deleteMany({}),

config/index.js

@@ -0,0 +1,9 @@
+/**
+ * Config Index - Centralized config exports
+ * Consolidates configuration exports to reduce import statements
+ */
+
+export { setupSwagger } from './swagger.js';
+export { API_VERSION } from './constants.js';
+export { default as db } from './db.js';
+export { default as database } from './database.js';

config/seedData/index.js

@@ -6,10 +6,12 @@ import bcrypt from 'bcryptjs';
 
 const require = createRequire(import.meta.url);
 
+// Load JSON data file from relative path
 function loadJsonData(path) {
     return require(path);
 }
 
+// Hash passwords for all users using bcrypt
 function hashUserPasswords(usersArray) {
     return usersArray.map(user => ({
         ...user,
@@ -18,6 +20,7 @@ function hashUserPasswords(usersArray) {
     }));
 }
 
+// Initialize counter values for auto-increment IDs
 function createCounters() {
     return {
         userId: 20000,
@@ -30,11 +33,13 @@ function createCounters() {
     };
 }
 
+// Load all JSON seed data files
 const placesData = loadJsonData('./places.json');
 const placesExtendedData = loadJsonData('./placesExtended.json');
 const interactionsData = loadJsonData('./interactions.json');
 const usersData = loadJsonData('./users.json');
 
+// Prepare data arrays for database insertion
 let places = [...placesData];
 let placesExtended = [...placesExtendedData];
 let { reviews, reports, favouritePlaces, dislikedPlaces } = interactionsData;

config/swagger.js

@@ -0,0 +1,32 @@
+/**
+ * Swagger Documentation Configuration
+ * Sets up Swagger UI for API documentation
+ */
+
+import swaggerUi from 'swagger-ui-express';
+import yaml from 'js-yaml';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+/**
+ * Configure and mount Swagger UI on the express app
+ * @param {Object} app - Express application instance
+ */
+export const setupSwagger = (app) => {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = dirname(__filename);
+
+    // Go up one level from config/ to root/ to find docs/
+    const rootDir = join(__dirname, '..');
+
+    const swaggerDocument = yaml.load(
+        readFileSync(join(rootDir, 'docs', 'swagger.yaml'), 'utf8')
+    );
+
+    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, {
+        customCss: '.swagger-ui .topbar { display: none }',
+        customSiteTitle: 'myWorld Travel API Documentation',
+        customfavIcon: '/favicon.ico'
+    }));
+};

controllers/adminController.js

@@ -9,6 +9,29 @@ import jwt from 'jsonwebtoken';
 import R from '../utils/responseBuilder.js';
 import { requirePlace } from '../utils/controllerValidators.js';
 
+// --- Helper Functions (Private) ---
+
+/** Allowed fields for place updates */
+const ALLOWED_PLACE_FIELDS = ['name', 'description', 'category', 'website'];
+
+/** Prepare update DTO from request body, picking only allowed fields */
+const preparePlaceUpdateDTO = (body, existingLocation) => {
+  const updateData = {};
+  ALLOWED_PLACE_FIELDS.forEach(k => { if (body[k]) updateData[k] = body[k]; });
+  if (body.location) updateData.location = { ...existingLocation, ...body.location };
+  return updateData;
+};
+
+/** Add HATEOAS links to each report */
+const enrichReportsWithLinks = (reports, placeId, adminId) => {
+  return reports.map(report => {
+    const reportObj = report.toObject ? report.toObject() : report;
+    return { ...reportObj, links: buildHateoasLinks.adminReport(placeId, adminId) };
+  });
+};
+
+// --- Controllers ---
+
 const getPlaceReports = async (req, res, next) => {
   try {
     const adminId = parseInt(req.params.adminId);
@@ -18,10 +41,7 @@ const getPlaceReports = async (req, res, next) => {
     if (!place) return;
 
     const placeReports = await db.getReportsForPlace(placeId);
-    const reportsWithLinks = placeReports.map(report => {
-      const reportObj = report.toObject ? report.toObject() : report;
-      return { ...reportObj, links: buildHateoasLinks.adminReport(placeId, adminId) };
-    });
+    const reportsWithLinks = enrichReportsWithLinks(placeReports, placeId, adminId);
 
     return R.success(res, { reports: reportsWithLinks, totalReports: reportsWithLinks.length, links: buildHateoasLinks.adminReportsCollection(adminId, placeId) }, 'Place reports retrieved successfully');
   } catch (error) { next(error); }
@@ -36,9 +56,7 @@ const updatePlace = async (req, res, next) => {
     if (!place) return;
 
     const placeObj = place.toObject ? place.toObject() : place;
-    const updateData = {};
-    ['name', 'description', 'category', 'website'].forEach(k => { if (req.body[k]) updateData[k] = req.body[k]; });
-    if (req.body.location) updateData.location = { ...placeObj.location, ...req.body.location };
+    const updateData = preparePlaceUpdateDTO(req.body, placeObj.location);
 
     const updatedPlace = await db.updatePlace(placeId, updateData);
     const updatedPlaceObj = updatedPlace.toObject ? updatedPlace.toObject() : updatedPlace;
@@ -68,3 +86,4 @@ const generateAdminToken = (req, res, next) => {
 };
 
 export default { getPlaceReports, updatePlace, generateAdminToken };
+

controllers/favouriteController.js

@@ -10,13 +10,16 @@ import { requireUser, requireUserAndPlace } from '../utils/controllerValidators.
 
 export const validateUserAndPlace = requireUserAndPlace;
 
+// Get all favourite places for a user with HATEOAS links
 const getFavouritePlaces = async (req, res, next) => {
   try {
     const userId = parseInt(req.params.userId);
+    // Validate user exists
     const user = await requireUser(res, userId);
     if (!user) return;
 
     const favouritePlaces = await db.getFavouritePlaces(userId);
+    // Attach HATEOAS links to each favourite
     const favouritePlacesWithLinks = favouritePlaces.map(fav => {
       const place = fav.place || {};
       return {
@@ -32,13 +35,16 @@ const getFavouritePlaces = async (req, res, next) => {
   } catch (error) { next(error); }
 };
 
+// Add a place to user's favourites list
 const addFavouritePlace = async (req, res, next) => {
   try {
     const userId = parseInt(req.params.userId);
+    // Validate both user and place exist
     const validation = await requireUserAndPlace(res, userId, req.body.placeId);
     if (!validation) return;
 
     const newFavourite = await db.addFavouritePlace(userId, req.body.placeId);
+    // Check if place is already in favourites
     if (!newFavourite) {
       return R.conflict(res, 'PLACE_ALREADY_FAVORITED', "Place is already in user's favorites", { placeId: req.body.placeId, userId });
     }
@@ -54,6 +60,7 @@ const addFavouritePlace = async (req, res, next) => {
   } catch (error) { next(error); }
 };
 
+// Remove a place from user's favourites by favouriteId
 const removeFavouritePlace = async (req, res, next) => {
   try {
     const userId = parseInt(req.params.userId);
@@ -62,6 +69,7 @@ const removeFavouritePlace = async (req, res, next) => {
     const user = await requireUser(res, userId);
     if (!user) return;
 
+    // Attempt to remove favourite
     const removed = await db.removeFavouritePlace(userId, favouriteId);
     if (!removed) {
       return R.notFound(res, 'FAVOURITE_NOT_FOUND', `Favourite with ID ${favouriteId} not found for user ${userId}`);