Abi weekly summary reports page

src/controllers/reportsController.js

@@ -20,12 +20,20 @@ const reportsController = function () {
    * In teams stats
    */
   const getVolunteerStatsData = async (req, res) => {
-    const { startDate, endDate } = req.query;
+    const { startDate, endDate, comparisonStartDate, comparisonEndDate } = req.query;
+
     if (!startDate || !endDate) {
       return res.status(400).send({ msg: 'Please provide a start and end date' });
     }
+
+    if (!comparisonStartDate || !comparisonEndDate) {
+      return res.status(400).send({ msg: 'Please provide a comparison date' });
+    }
+
     const isoStartDate = new Date(startDate);
     const isoEndDate = new Date(endDate);
+    const isoComparisonStartDate = new Date(comparisonStartDate);
+    const isoComparisonEndDate = new Date(comparisonEndDate);
 
     try {
       const [
@@ -41,19 +49,46 @@ const reportsController = function () {
         totalBadgesAwarded,
         totalActiveTeams,
         userLocations,
+        volunteerTrends,
       ] = await Promise.all([
-        overviewReportHelper.getVolunteerNumberStats(isoStartDate, isoEndDate),
-        overviewReportHelper.getHoursStats(isoStartDate, isoEndDate),
-        overviewReportHelper.getTotalHoursWorked(isoStartDate, isoEndDate),
-        overviewReportHelper.getTasksStats(isoStartDate, isoEndDate),
-        overviewReportHelper.getWorkDistributionStats(isoStartDate, isoEndDate),
+        overviewReportHelper.getVolunteerNumberStats(
+          isoStartDate,
+          isoEndDate,
+          isoComparisonStartDate,
+          isoComparisonEndDate,
+        ),
+        overviewReportHelper.getHoursStats(
+          isoStartDate,
+          isoEndDate,
+          isoComparisonStartDate,
+          isoComparisonEndDate,
+        ),
+        overviewReportHelper.getTotalHoursWorked(
+          isoStartDate,
+          isoEndDate,
+          isoComparisonStartDate,
+          isoComparisonEndDate,
+        ),
+        overviewReportHelper.getTasksStats(
+          isoStartDate,
+          isoEndDate,
+          isoComparisonStartDate,
+          isoComparisonEndDate,
+        ),
+        overviewReportHelper.getWorkDistributionStats(
+          isoStartDate,
+          isoEndDate,
+          isoComparisonStartDate,
+          isoComparisonEndDate,
+        ),
         overviewReportHelper.getRoleDistributionStats(),
         overviewReportHelper.getTeamMembersCount(),
         // overviewReportHelper.getBlueSquareStats(startDate, endDate),
         overviewReportHelper.getAnniversaries(startDate, endDate),
         overviewReportHelper.getTotalBadgesAwardedCount(startDate, endDate),
         overviewReportHelper.getTotalActiveTeamCount(),
         overviewReportHelper.getMapLocations(),
+        overviewReportHelper.getVolunteerTrends(),
       ]);
       res.status(200).send({
         volunteerNumberStats,
@@ -68,6 +103,7 @@ const reportsController = function () {
         totalBadgesAwarded,
         totalActiveTeams,
         userLocations,
+        volunteerTrends,
       });
     } catch (err) {
       console.log(err);

src/helpers/overviewReportHelper.js

@@ -1,11 +1,62 @@
 /* eslint-disable no-plusplus */
 /* eslint-disable quotes */
+const moment = require('moment');
 const Team = require('../models/team');
 const UserProfile = require('../models/userProfile');
 const TimeEntries = require('../models/timeentry');
 const Task = require('../models/task');
+const Project = require('../models/project');
+
+function calculateGrowthPercentage(current, prev) {
+  const percentage = (current - prev) / prev;
+  return Math.round(percentage * 100) / 100;
+}
 
 const overviewReportHelper = function () {
+  /**
+   * Get volunteer trends by time.
+   * Gets the total number of volunteer hours worked per month
+   * For now it will be aggregated for the past year
+   */
+  async function getVolunteerTrends() {
+    const currentDate = moment();
+    const startDate = currentDate.clone().subtract(11, 'months').startOf('month').toDate();
+    const endDate = currentDate.clone().endOf('month').toDate();
+
+    return TimeEntries.aggregate([
+      {
+        $match: {
+          dateOfWork: {
+            $gte: moment(startDate).format('YYYY-MM-DD'),
+            $lte: moment(endDate).format('YYYY-MM-DD'),
+          },
+        },
+      },
+      {
+        $group: {
+          _id: {
+            year: { $year: { $dateFromString: { dateString: '$dateOfWork' } } },
+            month: { $month: { $dateFromString: { dateString: '$dateOfWork' } } },
+          },
+          totalSecondsWorked: {
+            $sum: '$totalSeconds',
+          },
+        },
+      },
+      {
+        $project: {
+          _id: 1,
+          totalHours: {
+            $divide: ['$totalSecondsWorked', 3600],
+          },
+        },
+      },
+      {
+        $sort: { '_id.year': 1, '_id.month': 1 },
+      },
+    ]);
+  }
+
   /**
    * Get map location statistics
    * Group and count all volunteers  by their lattitude and longitude
@@ -178,30 +229,33 @@ const overviewReportHelper = function () {
    * Food, Energy, Housing, Stewardship, Society, Economics and Other
    */
   async function getWorkDistributionStats(startDate, endDate) {
-    const distributionStats = TimeEntries.aggregate([
-      {
-        $match: {
-          dateOfWork: { $gte: startDate, $lte: endDate },
-        },
-      },
+    return Project.aggregate([
       {
         $lookup: {
-          from: 'projects',
-          localField: 'projectId',
-          foreignField: '_id',
-          as: 'project',
+          from: 'timeEntries',
+          localField: '_id',
+          foreignField: 'projectId',
+          as: 'times',
         },
       },
       {
         $unwind: {
-          path: '$project',
+          path: '$times',
           preserveNullAndEmptyArrays: true,
         },
       },
+      {
+        $match: {
+          'times.dateOfWork': {
+            $gte: moment(startDate).format('YYYY-MM-DD'),
+            $lte: moment(endDate).format('YYYY-MM-DD'),
+          },
+        },
+      },
       {
         $group: {
-          _id: '$project.category',
-          aggregatedSeconds: { $sum: '$totalSeconds' },
+          _id: '$category',
+          aggregatedSeconds: { $sum: '$times.totalSeconds' },
         },
       },
       {
@@ -211,8 +265,6 @@ const overviewReportHelper = function () {
         },
       },
     ]);
-
-    return distributionStats;
   }
 
   async function getTasksStats(startDate, endDate) {
@@ -270,7 +322,12 @@ const overviewReportHelper = function () {
         $match: {
           $or: [
             { timeEntries: { $exists: false } },
-            { 'timeEntries.dateOfWork': { $gte: startDate, $lte: endDate } },
+            {
+              'timeEntries.dateOfWork': {
+                $gte: moment(startDate).format('YYYY-MM-DD'),
+                $lte: moment(endDate).format('YYYY-MM-DD'),
+              },
+            },
           ],
         },
       },
@@ -315,7 +372,10 @@ const overviewReportHelper = function () {
     const data = await TimeEntries.aggregate([
       {
         $match: {
-          dateOfWork: { $gte: startDate, $lte: endDate },
+          dateOfWork: {
+            $gte: moment(startDate).format('YYYY-MM-DD'),
+            $lte: moment(endDate).format('YYYY-MM-DD'),
+          },
         },
       },
       {
@@ -344,13 +404,40 @@ const overviewReportHelper = function () {
    * @param {string} startDate
    * @param {string} endDate
    */
-  const getVolunteerNumberStats = async (startDate, endDate) => {
+  const getVolunteerNumberStats = async (
+    startDate,
+    endDate,
+    comparisonStartDate,
+    comparisonEndDate,
+  ) => {
     const [data] = await UserProfile.aggregate([
       {
         $facet: {
-          activeVolunteers: [{ $match: { isActive: true } }, { $count: 'activeVolunteersCount' }],
+          currentActiveVolunteers: [
+            {
+              $match: {
+                createdDate: {
+                  $lte: endDate,
+                },
+                isActive: true,
+              },
+            },
+            { $count: 'activeVolunteersCount' },
+          ],
+
+          comparisonActiveVolunteers: [
+            {
+              $match: {
+                createdDate: {
+                  $lte: comparisonEndDate,
+                },
+                isActive: true,
+              },
+            },
+            { $count: 'activeVolunteersCount' },
+          ],
 
-          newVolunteers: [
+          currentNewVolunteers: [
             {
               $match: {
                 createdDate: {
@@ -362,7 +449,19 @@ const overviewReportHelper = function () {
             { $count: 'newVolunteersCount' },
           ],
 
-          deactivatedVolunteers: [
+          comparisonNewVolunteers: [
+            {
+              $match: {
+                createdDate: {
+                  $gte: comparisonStartDate,
+                  $lte: comparisonEndDate,
+                },
+              },
+            },
+            { $count: 'newVolunteersCount' },
+          ],
+
+          currentDeactivatedVolunteers: [
             {
               $match: {
                 $and: [
@@ -372,13 +471,58 @@ const overviewReportHelper = function () {
                 ],
               },
             },
-            { $count: 'deactivedVolunteersCount' },
+            { $count: 'deactivatedVolunteersCount' },
+          ],
+
+          comparisonDeactivatedVolunteers: [
+            {
+              $match: {
+                $and: [
+                  { lastModifiedDate: { $gte: comparisonStartDate } },
+                  { lastModifiedDate: { $lte: comparisonEndDate } },
+                  { isActive: false },
+                ],
+              },
+            },
+            { $count: 'deactivatedVolunteersCount' },
           ],
         },
       },
     ]);
 
-    return data;
+    const currentActiveVolunteers = data.currentActiveVolunteers[0].activeVolunteersCount;
+    const comparisonActiveVolunteers = data.comparisonActiveVolunteers[0].activeVolunteersCount;
+    const newVolunteers = data.currentNewVolunteers[0].newVolunteersCount;
+    const comparisonNewVolunteers = data.comparisonNewVolunteers[0].newVolunteersCount;
+    const currentDeactivatedVolunteers =
+      data.currentDeactivatedVolunteers[0].deactivatedVolunteersCount;
+    const comparisonDeactivatedVolunteers =
+      data.comparisonDeactivatedVolunteers[0].deactivatedVolunteersCount;
+
+    const res = {
+      activeVolunteers: {
+        count: currentActiveVolunteers,
+        comparisonPercentage: calculateGrowthPercentage(
+          currentActiveVolunteers,
+          comparisonActiveVolunteers,
+        ),
+      },
+
+      newVolunteers: {
+        count: newVolunteers,
+        comparisonPercentage: calculateGrowthPercentage(newVolunteers, comparisonNewVolunteers),
+      },
+
+      deactivatedVolunteers: {
+        count: currentDeactivatedVolunteers,
+        comparisonPercentage: calculateGrowthPercentage(
+          currentDeactivatedVolunteers,
+          comparisonDeactivatedVolunteers,
+        ),
+      },
+    };
+
+    return res;
   };
 
   /**
@@ -621,6 +765,7 @@ const overviewReportHelper = function () {
   }
 
   return {
+    getVolunteerTrends,
     getMapLocations,
     getTotalActiveTeamCount,
     getAnniversaries,