Abi weekly summary reports page

[Abi-Liu]

Description

This PR implements a new aggregation pipeline for volunteer trends data as well as fixes previous queries for the volunteer hours stats and work distribution stats

New URL format: api/reports/volunteerstats?startDate=2024-05-26&endDate=2024-06-02&comparisonStartDate=2024-05-18&comparisonEndDate=2024-05-25

Changes 9/13

• Updated API to retrieve comparison data for the following queries:
  • totalActiveTeams
  • totalBadgesAwarded
  • totalHoursWorked

   "totalBadgesAwarded": {
        "current": 40,
        "comparison": 40,
        "percentage": 0
    },
    "totalActiveTeams": {
        "current": 339,
        "comparison": 330,
        "percentage": 0.03
    },
   "totalHoursWorked": {
        "current": 161.93333333333334,
        "comparison": 342.56666666666666,
        "percentage": -0.53
    },

Changes 8/23

• Updated the api to require a comparisonStartDate and comparisonEndDate
  • This comparison time range is the period in time that will be compared to the current week
• Created the comparison data for the Volunteer Numbers Stats
  • The new data will be formatted like so:

"volunteerNumberStats": {
        "activeVolunteers": {
            "count": 1373,
            "comparisonPercentage": 0.01
        },
        "newVolunteers": {
            "count": 13,
            "comparisonPercentage": -0.32
        },
        "deactivatedVolunteers": {
            "count": 2,
            "comparisonPercentage": 1
        }
    },

NOTE the for the comparisonPercentage number. -0.32 means a decrese of 32% from the comparison week. 1 is a 100% increase

Related PRS (if any):

This PR is built off of #994

Main changes explained:

• Created a new query to aggregate the monthly volunteer trends data for the past year.
• Fixed bugs for the volunteer hours stats and work distribution stats to now return correct data
  …

How to test:

1. check into current branch
2. do npm install and npm run dev
3. Log in with an owner credential to Postman via the endpoint POST http://localhost:4500/api/login and paste the JWT token into the headers tab as shown below
4. Query the endpoint with Postman: api/reports/volunteerstats?startDate=2024-05-26&endDate=2024-06-02&comparisonStartDate=2024-05-18&comparisonEndDate=2024-05-25
5. verify the data is correct
   

Screenshots or videos of changes:

[SMitta11]

I tested as per given instructions, initially sent a POST request to get a token and then GET request to get this data of volunteer stats for given start and end date and data matches exactly as given here.
Below screenshots:

[AJAYINAVOLU]

Changes are working as expected.

Thank You.

[oliviahyw]

I have tested this PR and it's working as expected.

[Parth-tech]

Hi Abi,
The the response matches with the provided reference. The API endpoint is working well.

Reference Images:

[yashwanth170]

I have tested this PR and it's working as expected.

[vedantg24]

Tested the PR as per the instructions. Changes working as expected.

[vishnupriyaatheti]

@Abi-Liu I have reviewed your changes. As per dates given in the description the PR is working as expected. But when I change the dates I am the below error. Can you please check and reply

I am passing below dates:
http://localhost:4500/api/reports/volunteerstats?startDate=2024-09-01&endDate=2024-09-07&comparisonStartDate=2024-09-25&comparisonEndDate=2024-09-31

[Shreyav2000]

Tested the PR by sending the necessary GET request and verifying the returned data. The volunteer stats, trends, and comparison percentages are working as expected. The aggregation and calculation logic for the volunteerNumberStats and volunteerTrends looks accurate. Everything is functioning as intended. Ready for approval! Nice work! I have attached the screenshots below:

[sri0606]

Hello @Abi-Liu , I have tested the PR as mentioned, and it worked as expected.

[chu-ziyu]

Hi Abi,
I have tested this PR and everything worked as expected!

[Lexie5212]

I have tested the PR. And everything is good.

[ashayk9]

Changes are working as expected

[nevatiarishabh]

I have tested the PR. Everything is working as expected.

[mrinalini-raghavendran19]

This PR does a great job enhancing the reporting capabilities for volunteer statistics, allowing users to analyze trends and compare data effectively over defined time periods.

The new API now retrieves comparison data for various volunteer statistics, including Total Badges Awarded, Total Active Teams and Total Hours Worked in a given time range, with the addition of a start and end date incorporated.

It also provides counts of active, new, and deactivated volunteers, along with their respective comparison percentages relative to a previous week.

I have verified the changes via Postman with owner account credentials. Find below screenshots for the testing:

1. Passed owner account details in the Body of the POST request with the login url @PORT 4500

2. Used the JWT token generated with login for auth by passing it in the header, using the updated API that generates volunteer stats

Great job!

[pallavithorat]

I have reviewed the PR, and everything is working as expected.

[neeharikakoniki]

This PR successfully adds a new aggregation pipeline for tracking volunteer trends and fixes existing issues with volunteer hours and work distribution stats. I tested the updated API endpoint in Postman, confirming that the comparison data and formatting were accurate and aligned with the specified requirements.