Nxd 6 - Add ATS Resume Scoring To The Backend

nextstep-backend/package.json

@@ -20,6 +20,8 @@
   },
   "homepage": "https://github.com/NextStepFinalProject/NextStep#readme",
   "dependencies": {
+    "@types/pdf-parse": "^1.1.5",
+    "axios": "^1.8.3",
     "bcrypt": "^5.1.1",
     "body-parser": "^1.20.3",
     "cors": "^2.8.5",
@@ -34,13 +36,15 @@
     "jest-junit": "^16.0.0",
     "js-yaml": "^4.1.0",
     "jsonwebtoken": "^9.0.2",
+    "mammoth": "^1.9.0",
     "mongoose": "^8.8.2",
     "multer": "^1.4.5-lts.1",
+    "office-text-extractor": "^3.0.3",
+    "pdf-lib": "^1.17.1",
     "socket.io": "^4.8.1",
     "supertest": "^7.0.0",
     "swagger-jsdoc": "^6.2.8",
-    "swagger-ui-express": "^5.0.1",
-    "axios": "^1.8.3"
+    "swagger-ui-express": "^5.0.1"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.26.0",

nextstep-backend/src/app.ts

@@ -14,7 +14,7 @@ import {config} from "./config/config";
 import validateUser from "./middleware/validateUser";
 import loadOpenApiFile from "./openapi/openapi_loader";
 import resource_routes from './routes/resources_routes';
-
+import resume_routes from './routes/resume_routes';
 
 const specs = swaggerJsdoc(options);
 
@@ -43,10 +43,8 @@ app.use(bodyParser.json());
 app.use(removeUndefinedOrEmptyFields);
 app.use(bodyParser.urlencoded({ extended: true }));
 
-
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(loadOpenApiFile() as JsonObject));
 
-
 // Add Authentication for all routes except the ones listed below
 app.use(authenticateToken.unless({
     path: [
@@ -68,14 +66,13 @@ app.use(authenticateToken.unless({
 // To block queries without Authentication
 app.use(authenticateTokenForParams);
 
-
-
 app.use('/auth', authRoutes);
 app.use('/comment', commentsRoutes);
 app.use('/post', postsRoutes);
 app.use("/user/:id", validateUser);
 app.use('/user', usersRoutes);
 app.use('/resource', resource_routes);
 app.use('/room', roomsRoutes);
+app.use('/resume', resume_routes);
 
 export { app, corsOptions };

nextstep-backend/src/config/config.ts

@@ -16,7 +16,9 @@ export const config = {
     },
     resources: {
         imagesDirectoryPath: () => 'resources/images',
-        imageMaxSize: () => 10 * 1024 * 1024 // Max file size: 10MB
+        imageMaxSize: () => 10 * 1024 * 1024, // Max file size: 10MB
+        resumesDirectoryPath: () => 'resources/resumes',
+        resumeMaxSize: () => 5 * 1024 * 1024 // Max file size: 5MB
     },
     chatAi: {
         api_url: () => process.env.CHAT_AI_API_URL || 'https://openrouter.ai/api/v1/chat/completions',

nextstep-backend/src/controllers/resources_controller.ts

@@ -2,13 +2,12 @@ import { Request, Response } from 'express';
 import { config } from '../config/config';
 import fs from 'fs';
 import path from 'path';
-import { uploadImage } from '../services/resources_service';
+import { uploadResume, uploadImage } from '../services/resources_service';
 import multer from 'multer';
 import {CustomRequest} from "types/customRequest";
 import {updateUserById} from "../services/users_service";
 import {handleError} from "../utils/handle_error";
 
-
 const createUserImageResource = async (req: CustomRequest, res: Response) => {
     try {
         const imageFilename = await uploadImage(req);
@@ -49,4 +48,38 @@ const getImageResource = async (req: Request, res: Response) => {
     }
 };
 
-export default { createUserImageResource, createImageResource, getImageResource };
+const createResumeResource = async (req: Request, res: Response) => {
+    try {
+        const resumeFilename = await uploadResume(req);    
+        return res.status(201).send(resumeFilename);
+    } catch (error) {
+        if (error instanceof multer.MulterError || error instanceof TypeError) {
+            return res.status(400).send(error.message);
+        } else {
+            handleError(error, res);
+        }
+    }
+};
+
+const getResumeResource = async (req: Request, res: Response) => {
+    try {
+        const { filename } = req.params;
+        const resumePath = path.resolve(config.resources.resumesDirectoryPath(), filename);
+
+        if (!fs.existsSync(resumePath)) {
+            return res.status(404).send('Resume not found');
+        }
+
+        res.sendFile(resumePath);
+    } catch (error) {
+        handleError(error, res);
+    }
+};
+
+export default {
+    createUserImageResource,
+    createImageResource,
+    getImageResource,
+    getResumeResource,
+    createResumeResource
+};

nextstep-backend/src/controllers/resume_controller.ts

@@ -0,0 +1,75 @@
+import { Request, Response } from 'express';
+import { config } from '../config/config';
+import fs from 'fs';
+import path from 'path';
+import { scoreResume, streamScoreResume } from '../services/resume_service';
+import multer from 'multer';
+import { CustomRequest } from "types/customRequest";
+import { handleError } from "../utils/handle_error";
+
+const getResumeScore = async (req: Request, res: Response) => {
+    try {
+        const { filename } = req.params;
+        const resumePath = path.resolve(config.resources.resumesDirectoryPath(), filename);
+        const jobDescription = req.query.jobDescription as string;
+
+        if (!fs.existsSync(resumePath)) {
+            return res.status(404).send('Resume not found');
+        }
+
+        const scoreAndFeedback = await scoreResume(resumePath, jobDescription);
+        return res.status(200).send(scoreAndFeedback);
+    } catch (error) {
+        if (error instanceof TypeError) {
+            return res.status(400).send(error.message);
+        } else {
+            handleError(error, res);
+        }
+    }
+};
+
+const getStreamResumeScore = async (req: Request, res: Response) => {
+    try {
+        const { filename } = req.params;
+        const resumePath = path.resolve(config.resources.resumesDirectoryPath(), filename);
+        const jobDescription = req.query.jobDescription as string;
+
+        if (!fs.existsSync(resumePath)) {
+            return res.status(404).send('Resume not found');
+        }
+
+        // Set headers for SSE
+        res.setHeader('Content-Type', 'text/event-stream');
+        res.setHeader('Cache-Control', 'no-cache');
+        res.setHeader('Connection', 'keep-alive');
+
+        // Handle client disconnect
+        req.on('close', () => {
+            res.end();
+        });
+
+        // Stream the response
+        const score = await streamScoreResume(
+            resumePath,
+            jobDescription,
+            (chunk) => {
+                res.write(`data: ${JSON.stringify({ chunk })}\n\n`);
+            }
+        );
+
+        // Send the final score
+        res.write(`data: ${JSON.stringify({ score, done: true })}\n\n`);
+        res.end();
+    } catch (error) {
+        if (error instanceof TypeError) {
+            return res.status(400).send(error.message);
+        } else {
+            handleError(error, res);
+        }
+    }
+};
+
+export default {
+    getResumeScore,
+    getStreamResumeScore
+};

nextstep-backend/src/middleware/auth.ts

@@ -11,8 +11,16 @@ const getTokenFromHeader = (req: CustomRequest): string | undefined => {
   return authHeader?.split(' ')[1];
 }
 
+const getTokenFromQueryParams = (req: CustomRequest): string | undefined => {
+  return req.query.accessToken as string;
+}
+
 const authenticateTokenHandler: any & { unless: typeof unless } = async (req: CustomRequest, res: Response, next: NextFunction, ignoreExpiration = false): Promise<void> => {
-  const token = getTokenFromHeader(req);
+  let token = getTokenFromHeader(req);
+  if (!token) {
+    // If the token was not found in the headers, fall back to the query params.
+    token = getTokenFromQueryParams(req);
+  }
 
   if (!token) {
     res.status(401).json({ message: 'Access token required' });