Sphurthy - fix: Added analytics features

[sphurthy]

Description

Related PRS (if any):

Frontend: OneCommunityGlobal/HighestGoodNetworkApp#4482

Main changes explained:

• Created src/models/studentMetrics.js: added schema for per-student analytics metrics (averageScore, totalTimeSpentMinutes, engagementRate, completionRate, assessmentsTaken, lastUpdated).
• Created src/services/analyticsService.js: logic to compute, cache, and retrieve analytics metrics from FormResponse data.
• Created src/controllers/analyticsController.js: endpoints for GET /analytics/overview and GET /analytics/student/:studentId with optional ?force=true.
• Created src/routes/analyticsRouter.js: registered analytics endpoints.
• Created src/jobs/studentMetricsJob.js: scheduled daily job to refresh student metrics.
• Updated src/startup/routes.js: registered analyticsRouter at /api/analytics.
• Updated src/server.js: scheduled the student metrics job on startup.

How to test:

1. Checkout branch.
2. Run npm install.
3. Start the server.
4. Log in via POST /api/login and copy the JWT.
5. Insert a FormResponse for a test student if needed.
6. Get overview: GET /api/analytics/overview with Authorization.
7. Get student metrics: GET /api/analytics/student/{studentId} with Authorization.
8. Force refresh: GET /api/analytics/student/{studentId}?force=true with Authorization.
9. Check MongoDB for studentMetrics collection and verify metrics are updated.

Screenshots or videos of changes:

[VijayAnirudh]

Hello!

1. "Get overview: GET /api/analytics/overview with Authorization.
   Get student metrics: GET /api/analytics/student/{studentId} with Authorization.
   Force refresh: GET /api/analytics/student/{studentId}?force=true with Authorization."

These APIs are working fine!

2. I couldn't understand what it meant to do: "Insert a FormResponse for a test student if needed." That you want me to add a student to metrics via POST? If so, please mention related API endpoint.

3. As per "Check MongoDB for studentMetrics collection and verify metrics are updated," you did not mention how to update metrics. I can't verify the metrics without updating them. Please provide an API endpoint to update metrics.

[kzou55]

Hi Spurthy, I ran the current branch locally.

I can verify the following API response works:

• /api/analytics/overview

  

---

Issues:

• Could you clarify why the two APIs: /api/analytics/student/{studentId} and /api/analytics/student/{studentId}?force=true add to the student metric collections in MongoDB? Aren’t these GET requests, not POST requests?

  • /api/analytics/student/{studentId}

    • Postman
      

    • Before
      

    • After (the total amount of data in the collection increases)
      

  • /api/analytics/student/{studentId}?force=true

    • Postman
      

    • Before
      

    • After (the total amount of data in the collection increases)
      

• Also I wasn't sure what 5. Insert a FormResponse for a test student if needed, meant. Could you clarify and give the associated api call for that.

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[HemanthNidamanuru]

Hi Sphurthy,

I tested the analytics APIs locally.

The following APIs are working fine:

GET /api/analytics/overview
GET /api/analytics/student/{studentId}
GET /api/analytics/student/{studentId}?force=true

I was not clear about the step “Insert a FormResponse for a test student if needed.” If this needs to be done through an API, please provide the related endpoint and sample payload.

Also, for MongoDB verification, please mention how the metrics should be updated and which fields need to be checked in the studentMetrics collection.

[DeepighaJ]

Tested the API in postman. The below are working fine
GET /api/analytics/overview
GET /api/analytics/student/{studentId}
GET /api/analytics/student/{studentId}?force=true
I dint have more information on Insert a formresponse and metric updating verification in MongoDB so couldn't verify those two.

[sphurthy]

Thanks for testing @DeepighaJ (and @HemanthNidamanuru / @kzou55 / @VijayAnirudh, same answer for all of you 🙏). Clarifying the two confusing steps:

1. There's no separate "update metrics" endpoint, by design. Metrics are computed on demand from FormResponse documents and cached in the studentMetrics collection. GET /api/analytics/student/{studentId} recomputes and upserts that cached doc, which is why the collection changes on a GET. Repeat calls now update the same doc instead of duplicating (fixed in d24634b, unique studentId).

2. "Insert a FormResponse" just means seeding source data. The metrics read numeric answers from FormResponse, and our form API only accepts radio/checkbox/text answers, so for testing, insert directly into the formresponses collection:

db.formresponses.insertOne({
formID: "quiz-1",
submittedBy: "test-student-1",
responses: [
{ questionLabel: "Quiz score", answer: 85 },
{ questionLabel: "Time spent", answer: 12 }
],
submittedAt: new Date()
})
Numeric answers feed averageScore; a question labeled like "time" feeds totalTimeSpentMinutes.

To verify:

Insert one or more FormResponse docs for test-student-1 (use the same value in {studentId} below).
GET /api/analytics/student/test-student-1?force=true (force skips the 1‑hour cache).
Check the studentMetrics doc for that studentId, metrics.averageScore, assessmentsTaken, completionRate, engagementRate, totalTimeSpentMinutes should now be populated.
GET /api/analytics/overview aggregates those cached metrics across all students.