feat(history-service),fix(question-service): add all endpoints, models, and routes for history service and fixed test cases and moved env files for question-service

Author: verakohh

docker-compose.yml

@@ -115,14 +115,24 @@ services:
       dockerfile: Dockerfile
     command: ["npm", "test"]
     env_file:
-      - ./question-service/.env
+      - ./question-service/.env.test
     depends_on:
       question-db-pg:
         condition: service_healthy
     networks:
       - app-network
 
-
+# --- UI for Postgres Database ---
+  adminer:
+    image: adminer
+    container_name: adminer-ui        
+    restart: unless-stopped          
+    ports:
+      - "8087:8080" 
+    networks:
+      - app-network
+    depends_on:
+      - question-db-pg
 
   # Matching service
   matching-service:
@@ -164,6 +174,29 @@ services:
     networks:
       - app-network
 
+  # History service
+  history-service:
+    build:
+      context: ./history-service
+      dockerfile: Dockerfile
+    ports:
+      - '8085:8085'
+    environment:
+      - PORT=8085
+      - MONGO_URI=${HISTORY_DB_MONGO_URI}
+    env_file:
+      - ./.env
+    depends_on:
+      - user-db-mongodb 
+    volumes:
+      - ./history-service:/app
+      - /app/node_modules
+    networks:
+      - app-network 
+    command: npm run dev
+    
+
+
 networks:
   app-network:
     driver: bridge

history-service/.dockerignore

@@ -0,0 +1,58 @@
+# Dependencies
+node_modules
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Build outputs
+dist
+build
+*.tsbuildinfo
+
+# Environment files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# IDE files
+.vscode
+.idea
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Git
+.git
+.gitignore
+
+# Docker
+Dockerfile
+.dockerignore
+docker-compose*.yml
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Dependency directories
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache

history-service/Dockerfile

@@ -0,0 +1,20 @@
+# Dockerfile for backend services (user-service, question-service, matching-service, collaboration-service)
+FROM node:22-alpine
+
+# Set working directory
+WORKDIR /app
+
+# Copy package.json and package-lock.json (if available)
+COPY package*.json ./
+
+# Install dependencies
+RUN npm install
+
+# Copy source code
+COPY . .
+
+# Expose the port (will be overridden by docker-compose for each service)
+EXPOSE 8085
+
+# Start the application
+CMD ["npm", "run", "dev"]

history-service/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "history-service",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "ts-node-dev src/index.ts",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "mongoose": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.10.0",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.3.2"
+  }
+}

history-service/src/controllers/history.controller.ts

@@ -0,0 +1,73 @@
+import { Request, Response } from 'express';
+import { HistoryService } from '../services/history.service';
+
+export class HistoryController {
+  private historyService: HistoryService;
+
+  constructor() {
+    this.historyService = new HistoryService();
+  }
+
+  // Endpoint for Matching Service to GET history
+  public getUserHistory = async (req: Request, res: Response): Promise<Response> => {
+    try {
+      const userId = req.params['userId']; 
+      if (!userId) {
+        return res.status(400).json({ message: 'userId is required in the URL' });
+      }
+      const history = await this.historyService.getAttemptedQuestions(userId);
+      return res.status(200).json({ attemptedQuestionIds: history });
+    } catch (error) {
+      return res.status(500).json({ message: 'Server error' });
+    }
+  };
+
+  // Endpoint for Matching Service to POST a new attempt
+  public addAttempt = async (req: Request, res: Response): Promise<Response> => {
+    try {
+      const { userId, questionId } = req.body;
+      if (!userId || !questionId) {
+        return res.status(400).json({ message: 'userId and questionId are required' });
+      }
+      await this.historyService.addQuestionAttempt(userId, questionId);
+      return res.status(201).json({ message: 'History updated' });
+    } catch (error) {
+      return res.status(500).json({ message: 'Server error' });
+    }
+  };
+
+  // Updated endpoint to remove one or more questions from history
+  public removeAttempts = async (req: Request, res: Response): Promise<Response> => {
+    try {
+      const userId = req.params['userId']; 
+      const { questionIds } = req.body; // Expect an array of question IDs in the body
+
+      if (!userId) {
+        return res.status(400).json({ message: 'userId is required in the URL' });
+      }
+      if (!Array.isArray(questionIds) || questionIds.length === 0) {
+        return res.status(400).json({ message: 'questionIds must be a non-empty array in the request body' });
+      }
+
+      await this.historyService.removeQuestionAttempts(userId, questionIds);
+      return res.status(200).json({ message: 'Questions removed from history' });
+    } catch (error) {
+      return res.status(500).json({ message: 'Server error' });
+    }
+  };
+
+  // New endpoint for users to clear their entire history
+  public clearUserHistory = async (req: Request, res: Response): Promise<Response> => {
+    try {
+      const userId = req.params['userId']; 
+      if (!userId) {
+        return res.status(400).json({ message: 'userId is required in the URL' });
+      }
+      await this.historyService.clearHistory(userId);
+      return res.status(200).json({ message: 'History cleared for user' });
+    } catch (error) {
+      return res.status(500).json({ message: 'Server error' });
+    }
+  };
+}
+

history-service/src/index.ts

@@ -0,0 +1,40 @@
+import express from 'express';
+import cors from 'cors';
+import mongoose from 'mongoose';
+import { HistoryController } from './controllers/history.controller';
+
+const app = express();
+const port = process.env['PORT'] || 8085;
+const mongoUri = process.env['MONGO_URI'];
+
+// Middleware
+app.use(cors());
+app.use(express.json());
+
+// Routes
+// This assumes you will mount your router on /api in this file
+// If not, adjust Task 4 URL accordingly.
+const historyController = new HistoryController();
+app.get('/api/history/:userId', historyController.getUserHistory);
+app.post('/api/history', historyController.addAttempt);
+app.delete('/api/history/:userId/questions', historyController.removeAttempts); // Route to remove one or more questions
+app.delete('/api/history/:userId', historyController.clearUserHistory); // New route to clear all history
+
+// Connect to MongoDB
+if (!mongoUri) {
+  console.error("FATAL ERROR: MONGO_URI is not defined.");
+  process.exit(1);
+}
+
+mongoose.connect(mongoUri)
+  .then(() => {
+    console.log('Connected to MongoDB');
+    app.listen(port, () => {
+      console.log(`History service running on port ${port}`);
+    });
+  })
+  .catch(err => {
+    console.error('Database connection error', err);
+    process.exit(1);
+  });
+

history-service/src/models/history.model.ts

@@ -0,0 +1,22 @@
+import { Schema, model, Document } from 'mongoose';
+
+interface IHistory extends Document {
+  userId: string;
+  attemptedQuestionIds: string[];
+}
+
+const HistorySchema = new Schema<IHistory>({
+  userId: { 
+    type: String, 
+    required: true, 
+    unique: true,
+    index: true 
+  },
+  attemptedQuestionIds: { 
+    type: [String], 
+    default: [] 
+  },
+});
+
+export const HistoryModel = model<IHistory>('History', HistorySchema, 'userHistories');
+

history-service/src/services/history.service.ts

@@ -0,0 +1,38 @@
+import { HistoryModel } from '../models/history.model';
+
+export class HistoryService {
+  
+  public async getAttemptedQuestions(userId: string): Promise<string[]> {
+    const history = await HistoryModel.findOne({ userId: userId });
+    return history ? history.attemptedQuestionIds : [];
+  }
+
+  // This is the "log on assignment" function
+  public async addQuestionAttempt(userId: string, questionId: string): Promise<void> {
+    await HistoryModel.updateOne(
+      { userId: userId },
+      { $push: { attemptedQuestionIds: questionId } },
+      { upsert: true } // Creates a new document if one doesn't exist
+    );
+  }
+
+  // Function to remove one or more questions from history
+  public async removeQuestionAttempts(userId: string, questionIds: string[]): Promise<void> {
+    if (!Array.isArray(questionIds) || questionIds.length === 0) {
+      return; // Still good to have this check
+    }
+    await HistoryModel.updateOne(
+      { userId: userId },
+      { $pull: { attemptedQuestionIds: { $in: questionIds } } }
+    );
+  }
+  
+  // New function to clear all history for a user
+  public async clearHistory(userId: string): Promise<void> {
+    await HistoryModel.updateOne(
+      { userId: userId },
+      { $set: { attemptedQuestionIds: [] } } // Set the array to empty
+    );
+  }
+}
+

history-service/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "commonjs",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node"],
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitReturns": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "strict": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+    "esModuleInterop": true, // Added for better interop between CommonJS and ES Modules
+    "allowSyntheticDefaultImports": true // Often needed with esModuleInterop
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
+}

package.json

@@ -7,23 +7,25 @@
     "collaboration-service",
     "matching-service",
     "question-service",
-    "user-service"
+    "user-service",
+    "history-service"
   ],
   "scripts": {
-    "dev": "concurrently --names front,collab,match,question,user --pad-prefix \"npm run dev:frontend\"  \"npm run dev:collab\" \"npm run dev:match\" \"npm run dev:question\" \"npm run dev:user\"",
+    "dev": "concurrently --names front,collab,match,question,user --pad-prefix \"npm run dev:frontend\"  \"npm run dev:collab\" \"npm run dev:match\" \"npm run dev:question\" \"npm run dev:user\" \"npm run dev:history\"",
     "dev:frontend": "npm run dev -w frontend",
     "dev:collab": "npm run dev -w collaboration-service",
     "dev:match": "npm run dev -w matching-service",
     "dev:question": "npm run dev -w question-service",
     "dev:user": "npm run dev -w user-service",
+    "dev:history": "npm run dev -w history-service",
     "build": "npm run build --workspaces --if-present",
     "lint": "concurrently \"npm run lint:frontend\" \"npm run lint:backend\"",
     "lint:fix": "concurrently \"npm run lint:frontend:fix\" \"npm run lint:backend:fix\"",
     "lint:frontend": "npm run lint --prefix frontend",
     "lint:frontend:fix": "npm run lint:fix --prefix frontend",
     "lint:user:fix": "eslint user-service --ext .ts --fix",
-    "lint:backend": "eslint collaboration-service matching-service question-service user-service --ext .ts",
-    "lint:backend:fix": "eslint collaboration-service matching-service question-service user-service --ext .ts --fix",
+    "lint:backend": "eslint collaboration-service matching-service question-service user-service history-service --ext .ts",
+    "lint:backend:fix": "eslint collaboration-service matching-service question-service user-service history-service --ext .ts --fix",
     "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
     "test": "jest"
   },