Denish - volunteer completed hours

[Dk-21]

Volunteer Reporting Enhancements

This update introduces a new functionality to retrieve volunteers who logged hours meeting or exceeding their committed weekly hours, with added comparison functionality when a date range is provided.

Description

The changes in this PR include:

• Adding the getVolunteersCompletedAssignedHours function in overviewReportHelper.js.
• Updating the getVolunteerStatsData function in reportsController.js to include this new functionality.

These updates provide improved tracking of volunteer contributions and enable comparative analysis over different time periods.

---

Summary of Changes

Added Functionality

1. Helper Function:

   • Created getVolunteersCompletedAssignedHours in overviewReportHelper.js.
   • Filters volunteers based on the following criteria:
     • Volunteers who logged hours meeting or exceeding their committed weekly hours.
     • Optionally calculates percentage growth when comparison date ranges are provided.

2. API Endpoint Integration:

   • Updated the getVolunteerStatsData function in reportsController.js.
   • Ensures that the API response includes the new calculated results.

---

Related PRs

• Backend PR: Abi weekly summary reports page Abi weekly summary reports page #1062

---

Main Changes Explained

File Updates:

1. overviewReportHelper.js

• New Function:
  • getVolunteersCompletedAssignedHours: Computes volunteers who meet or exceed their committed weekly hours, and optionally calculates comparison percentages.

2. reportsController.js

• Integration:
  • Modified the getVolunteerStatsData endpoint to call getVolunteersCompletedAssignedHours.
  • Added the computed results to the API response structure.

---

How to Test

1. Check into the Current Branch:

git checkout add-getVolunteersCompletedAssignedHours

2. Install Dependencies:

npm install

3. Run the Application:

npm run dev

4. Login Using Postman:

• Endpoint:

  POST http://localhost:4500/api/login

• Use Owner Credentials to Log In.
• Authorization:
  • Copy the JWT token from the response.
  • Paste it into the Postman Headers Tab under Authorization.

5. Query the Endpoint:

• API Call:

  GET http://localhost:4500/api/reports/volunteerstats?startDate=2024-05-26&endDate=2024-06 02&comparisonStartDate=2024-05-18&comparisonEndDate=2024-05-25

• Expected Response:
  The API should return data with the count of volunteers who:
  • Logged hours meeting or exceeding their weekly commitment.
  • Include percentage growth if a comparison date range is provided.

---

Screenshots:

Additional Notes

• Ensure the startDate and endDate query parameters are provided in the API request.
• Use valid owner credentials to authenticate API calls.
• Verify the results include only the filtered volunteers as described and optional comparison growth percentages.

[strallia]

Updated aggregation pipeline to use a more consistent date field and formatted the response.

Works when comparison date parameters are and are not included in the request.

Great work, thank you!