Aditya-feat: Add New Bar Chart Card to the Lessons Learned Section on the Total Construction Summary Page

[Aditya-gam]

Description

This PR hardens and refactors the Lessons Learned bar-chart backend (GET /api/bm/lessons-learnt) introduced in PR 1302. It adds input validation, structured error logging, extracted helpers for maintainability, and full unit test coverage for getLessonsLearnt. No new endpoints or routes are added; the existing endpoint is made production-ready for the Lessons Learned section of the Total Construction Summary page.

Implements Add New Bar Chart Card to the Lessons Learned Section on the Total Construction Summary Page.

Related PRs (if any):

• Previous backend PR: PR #1302(merged)
• Frontend PR: PR #

Main changes explained:

Created/Updated Files:

• src/controllers/bmdashboard/bmNewLessonController.js
  • Validation (getLessonsLearnt): Before any aggregation, validate projectId (must be ALL or a valid MongoDB ObjectId), startDate, and endDate (must be Date.parse()-able). Return 400 with { error: 'Invalid projectId' }, { error: 'Invalid startDate' }, or { error: 'Invalid endDate' } respectively when invalid; no DB calls on invalid input.
  • Helpers (module-level): Added buildProjectIdFilter(projectId) (returns {} for absent/ALL, else { relatedProject: ObjectId }), calculateChangePercentage(thisMonth, lastMonth) (returns '+100%', '0%', or signed string like '+50.0%'), and constants END_HOUR, END_MINUTE, END_SECOND for month-boundary date construction.
  • getLessonsLearnt refactor: Uses the new helpers to build filters and compute change percentage; simplified aggregation pipeline (single $group stage shape) and Object.fromEntries for thisMonth/lastMonth maps. “This month” / “last month” are derived from endDate when provided; otherwise, they default to the current server date.
  • Logging: All catch blocks in this controller now use logger.logException(error, '<handlerName>', { context }) instead of console.error, including getLessonsLearnt (context: { query: req.query }).
• src/controllers/bmdashboard/__tests__/bmNewLessonController.test.js
  • getLessonsLearnt suite: New describe('getLessonsLearnt') with mocked BuildingNewLesson.aggregate (three calls per request: lessons-in-range, this-month, last-month).
  • Validation tests: Invalid projectId → 400 and aggregate not called; projectId=ALL → 200 and no relatedProject in first match; invalid startDate / endDate → 400 with correct error key.
  • Happy path / filters: No params → 200 and correct data shape with changePercentage; empty aggregates → 200 and data: []; valid projectId → relatedProject in match; date range (both, start only, end only, neither) → correct $match.date shape.
  • changePercentage tests: +100% (lastMonth 0, thisMonth > 0), 0% (both 0), positive/negative/same (e.g. +50.0%, -50.0%, +0.0%), and multi-project independence.
  • Error handling: Aggregate throws → 500 and logger.logException called with expected context.

Key Implementation Details:

• projectId: Only the literal string ALL (case-sensitive) is treated as “all projects.” Any other non-ObjectId value (e.g. all, not-a-valid-objectid) returns 400. Valid 24-char hex ObjectIds are passed through to the filter.
• Dates: Date.parse() is used for validation; invalid strings (e.g. not-a-date, 2024-13-45) yield NaN and trigger 400. No check that startDate <= endDate; a reversed range simply matches no documents and returns data: [].
• Response shape unchanged: Success still returns { data: [ { project, projectId, lessonsCount, changePercentage } ] }. lessonsCount is for the optional date range (or all time); changePercentage is month-over-month (this calendar month vs last), with “this month” based on endDate when provided.

How to test:

1. Check out the current branch:
   Aditya-feat/Add-New-Bar–Chart-Card-to–the-Lessons-Learned-Section-on-the-Total–Construction-Summary-Page.
2. Reinstall dependencies and clean cache using rm -rf node_modules package-lock.json && npm cache clean --force.
3. Run npm install to install dependencies, then start the backend locally (npm run dev)
4. Obtain a JWT by Owner/Admin login:
   • POST http://localhost:4500/api/login with { "email": "...", "password": "..." }
     Use the returned token in the Authorization header for the following requests.
5. Test GET /api/bm/lessons-learnt:
   • Basic – no params:
     GET http://localhost:4500/api/bm/lessons-learnt
     Expect 200 and { data: [ { project, projectId, lessonsCount, changePercentage }, ... ] }.
   • Basic – projectId=ALL:
     GET http://localhost:4500/api/bm/lessons-learnt?projectId=ALL
     Expect 200, same shape as above.
   • Edge – invalid projectId:
     GET http://localhost:4500/api/bm/lessons-learnt?projectId=not-a-valid-objectid
     Expect 400 and { "error": "Invalid projectId" }.
   • Edge – invalid startDate:
     GET http://localhost:4500/api/bm/lessons-learnt?startDate=not-a-date
     Expect 400 and { "error": "Invalid startDate" }.
   • Edge – invalid endDate:
     GET http://localhost:4500/api/bm/lessons-learnt?endDate=2024-13-45
     Expect 400 and { "error": "Invalid endDate" }.
   • Edge – projectId=all (lowercase):
     GET http://localhost:4500/api/bm/lessons-learnt?projectId=all
     Expect 400 and { "error": "Invalid projectId" } (case-sensitive).
6. Run unit tests:
   npm test -- --testPathPattern=bmNewLessonController
7. Verify:
   • Valid projectId (existing ObjectId from your DB) returns 200 and at most one project in data (or [] if that project has no lessons).

Screenshots or videos of changes:

• Coverage Report:

• Test Video:

TestVideo.mov

Note:

• projectId validated with mongoose.Types.ObjectId.isValid when not ALL; startDate and endDate validated with Number.isNaN(Date.parse(...)). Invalid values return 400 before any DB access.
• All errors in this controller now go through logger.logException for consistent tracking and debugging.

[sonarqubecloud]

Quality Gate passed

Issues
0 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

[Aditya-gam]

Closing in favor of #2093. The head branch was renamed to remove hidden en-dash characters (Unicode U+2013) that caused GitHub to show: "The head ref may contain hidden characters." New branch name: Aditya-feat/Add-New-Bar-Chart-Card-to-the-Lessons-Learned-Section-on-the-Total-Construction-Summary-Page (ASCII hyphens only). Please review and merge #2093 instead.