Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 1 addition & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

109 changes: 109 additions & 0 deletions src/controllers/optAnalyticsController.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
const CandidateOPTStatus = require('../models/CandidateOPTStatus');

const isValidDate = (date) => {
const dateRegex = /^\d{4}-\d{2}-\d{2}$/;
if (!dateRegex.test(date)) return false;
const parsedDate = new Date(date);
return !Number.isNaN(parsedDate.getTime());
};

const parseDateParam = (dateStr, fieldName, res) => {
if (!isValidDate(dateStr)) {
res.status(400).json({ message: `Invalid ${fieldName}. Use ISO format (YYYY-MM-DD).` });
return null;
}
const parsed = new Date(dateStr);
if (Number.isNaN(parsed.getTime())) {
res.status(400).json({ message: `Invalid ${fieldName}. Use ISO format (YYYY-MM-DD).` });
return null;
}
return parsed;
};

const validateDateRange = (start, end, startDate, endDate, res) => {
if (start && end && start > end) {
res.status(400).json({ message: 'startDate cannot be greater than endDate.' });
return false;
}
if (startDate && endDate && start.toDateString() === end.toDateString()) {
res.status(400).json({ message: 'startDate and endDate cannot be the same.' });
return false;
}
return true;
};

const sanitizeRole = (role) => {
if (!role) return null;
const str = String(role);
return str.replace(/[^a-zA-Z0-9 _-]/g, '');

Check warning on line 38 in src/controllers/optAnalyticsController.js

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Prefer `String#replaceAll()` over `String#replace()`.

See more on https://sonarcloud.io/project/issues?id=OneCommunityGlobal_HGNRest&issues=AZzL0ipbU6zsUdRlHxjw&open=AZzL0ipbU6zsUdRlHxjw&pullRequest=1663
};

const buildQuery = (start, end, role) => {
const query = {};
if (start || end) {
query.applicationDate = {};
if (start) query.applicationDate.$gte = start;
if (end) query.applicationDate.$lte = end;
}
const safeRole = sanitizeRole(role);
if (safeRole) {
query.role = safeRole;
}
return query;
};

const computeBreakdown = (result) => {
const totalCandidates = result.length;
const breakDownMap = {};
result.forEach(({ optStatus }) => {
breakDownMap[optStatus] = (breakDownMap[optStatus] || 0) + 1;
});
const breakDown = Object.entries(breakDownMap).map(([optStatus, count]) => ({
optStatus,
count,
percentage: Number(((count / totalCandidates) * 100).toFixed(2)),
}));
return { totalCandidates, breakDown };
};

module.exports = function optAnalyticsController() {
return {
getOPTStatusBreakdown: async function getOPTStatusBreakdown(req, res, next) {
try {
const { startDate, endDate, role } = req.query;

let start;
let end;

if (startDate) {
start = parseDateParam(startDate, 'startDate', res);
if (start === null) return null;
}

if (endDate) {
end = parseDateParam(endDate, 'endDate', res);
if (end === null) return null;
}

if (!validateDateRange(start, end, startDate, endDate, res)) return null;

const query = buildQuery(start, end, role);

const result = await CandidateOPTStatus.find(query);

if (!result.length) {
return res.json({
totalCandidates: 0,
breakDown: [],
message: 'No records found for the given filters.',
});
}

return res.json(computeBreakdown(result));
} catch (err) {
next(err);
}
return null;
},
};
};
23 changes: 23 additions & 0 deletions src/models/CandidateOPTStatus.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
const mongoose = require('mongoose');

const CandidateOPTStatusSchema = new mongoose.Schema({
candidateId: {
type: Number,
required: true,
},
role: {
type: String,
required: true,
},
optStatus: {
type: String,
enum: ['OPT started', 'CPT not eligible', 'Citizen', 'OPT not yet started', 'N/A'],
required: true,
},
applicationDate: {
type: Date,
required: true,
},
});

module.exports = mongoose.model('CandidateOPTStatus', CandidateOPTStatusSchema);
8 changes: 8 additions & 0 deletions src/routes/optanalyticsRoutes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
const express = require('express');

module.exports = function optAnalyticsRoutes() {
const router = express.Router();
const optAnalyticsController = require('../controllers/optAnalyticsController')();
router.get('/opt-status', optAnalyticsController.getOPTStatusBreakdown);
return router;
};
6 changes: 4 additions & 2 deletions src/startup/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ console.log('PlannedCostRouter loaded:', plannedCostRouter ? 'success' : 'failed
const projectCostRouter = require('../routes/bmdashboard/projectCostRouter')(projectCost);

const tagRouter = require('../routes/tagRouter')(tag);
const educationTaskRouter = require('../routes/educationTaskRouter');
const applicantVolunteerRatioRouter = require('../routes/applicantVolunteerRatioRouter');const educationTaskRouter = require('../routes/educationTaskRouter');
const educatorRouter = require('../routes/educatorRouter');
const atomRouter = require('../routes/atomRouter');
const intermediateTaskRouter = require('../routes/intermediateTaskRouter');
Expand All @@ -351,7 +351,7 @@ const bidNotificationsRouter = require('../routes/lbdashboard/bidNotificationsRo
const bidDeadlinesRouter = require('../routes/lbdashboard/bidDeadlinesRouter');
const SMSRouter = require('../routes/lbdashboard/SMSRouter')();

const applicantVolunteerRatioRouter = require('../routes/applicantVolunteerRatioRouter');
const analyticsRouter = require('../routes/optanalyticsRoutes')();
const applicationRoutes = require('../routes/applications');
const announcementRouter = require('../routes/announcementRouter')();

Expand Down Expand Up @@ -565,4 +565,6 @@ module.exports = function (app) {
app.use('/api', materialCostRouter);

app.use('/api/lp', lessonPlanSubmissionRouter);

app.use('/api/analytics', analyticsRouter);
};
Loading