feat(statistics): add game launch time spans stats (#1357)

tf2pickup-org · Nov 12, 2021 · e7e6b96 · e7e6b96
1 parent 2c39f3d
commit e7e6b96
Show file tree

Hide file tree

Showing 6 changed files with 186 additions and 0 deletions.
diff --git a/src/games/services/game-event-handler.service.spec.ts b/src/games/services/game-event-handler.service.spec.ts
@@ -26,6 +26,10 @@ jest.mock('@nestjs/config');
 jest.mock('./game-runtime.service');
 jest.mock('./games.service');
 
+function flushPromises() {
+  return new Promise((resolve) => setImmediate(resolve));
+}
+
 describe('GameEventHandlerService', () => {
   let service: GameEventHandlerService;
   let mongod: MongoMemoryServer;
@@ -147,7 +151,9 @@ describe('GameEventHandlerService', () => {
       await service.onMatchEnded(mockGame.id);
 
       jest.advanceTimersByTime(5000);
+      await flushPromises();
       jest.advanceTimersByTime(serverCleanupDelay);
+      await flushPromises();
       expect(gameRuntimeService.cleanupServer).toHaveBeenCalledWith(
         gameServerId.toString(),
       );

diff --git a/src/statistics/controllers/statistics.controller.spec.ts b/src/statistics/controllers/statistics.controller.spec.ts
@@ -49,4 +49,36 @@ describe('StatisticsController', () => {
       ]);
     });
   });
+
+  describe('#getGameLaunchDays()', () => {
+    beforeEach(() => {
+      statisticsService.getGameLaunchTimeSpans.mockResolvedValue([
+        {
+          dayOfWeek: 5,
+          timeOfTheDay: 'afternoon',
+          count: 1,
+        },
+        {
+          dayOfWeek: 5,
+          timeOfTheDay: 'evening',
+          count: 2,
+        },
+      ]);
+    });
+
+    it('should return game launch time spans stats', async () => {
+      expect(await controller.getGameLaunchDays()).toEqual([
+        {
+          dayOfWeek: 5,
+          timeOfTheDay: 'afternoon',
+          count: 1,
+        },
+        {
+          dayOfWeek: 5,
+          timeOfTheDay: 'evening',
+          count: 2,
+        },
+      ]);
+    });
+  });
 });
diff --git a/src/statistics/controllers/statistics.controller.ts b/src/statistics/controllers/statistics.controller.ts
@@ -9,4 +9,9 @@ export class StatisticsController {
   async getPlayedMapsCount() {
     return await this.statisticsService.getPlayedMapsCount();
   }
+
+  @Get('game-launch-time-spans')
+  async getGameLaunchDays() {
+    return await this.statisticsService.getGameLaunchTimeSpans();
+  }
 }
diff --git a/src/statistics/interfaces/game-launch-time-span.ts b/src/statistics/interfaces/game-launch-time-span.ts
@@ -0,0 +1,11 @@
+type TimeOfTheDay =
+  | 'morning' /* 06-12 */
+  | 'afternoon' /* 12-18 */
+  | 'evening' /* 18-24 */
+  | 'night' /* 24-06 */;
+
+export interface GameLaunchTimeSpan {
+  dayOfWeek: number; // day of the week as a number between 1 (Sunday) and 7 (Saturday)
+  timeOfTheDay: TimeOfTheDay;
+  count: number;
+}
diff --git a/src/statistics/services/statistics.service.spec.ts b/src/statistics/services/statistics.service.spec.ts
@@ -73,4 +73,40 @@ describe('StatisticsService', () => {
       ]);
     });
   });
+
+  describe('#getGameLaunchTimeSpans()', () => {
+    beforeEach(async () => {
+      await gameModel.create([
+        {
+          number: 1,
+          launchedAt: new Date(2021, 10, 11, 13, 0),
+          map: 'cp_process_f7',
+        },
+        {
+          number: 2,
+          launchedAt: new Date(2021, 10, 11, 19, 0),
+          map: 'cp_process_f7',
+        },
+        {
+          number: 3,
+          launchedAt: new Date(2021, 10, 11, 22, 0),
+          map: 'cp_process_f7',
+        },
+      ]);
+
+      process.env.TZ = 'GMT';
+    });
+
+    it('should return game launch time spans', async () => {
+      const ret = await service.getGameLaunchTimeSpans();
+      expect(
+        ret.find((r) => r.dayOfWeek === 5 && r.timeOfTheDay === 'afternoon')
+          .count,
+      ).toBe(1);
+      expect(
+        ret.find((r) => r.dayOfWeek === 5 && r.timeOfTheDay === 'evening')
+          .count,
+      ).toBe(2);
+    });
+  });
 });
diff --git a/src/statistics/services/statistics.service.ts b/src/statistics/services/statistics.service.ts
@@ -2,6 +2,7 @@ import { Game, GameDocument } from '@/games/models/game';
 import { Injectable } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
 import { Model } from 'mongoose';
+import { GameLaunchTimeSpan } from '../interfaces/game-launch-time-span';
 import { PlayedMapCount } from '../interfaces/played-map-count';
 
 @Injectable()
@@ -26,4 +27,99 @@ export class StatisticsService {
       { $sort: { count: -1 } },
     ]);
   }
+
+  async getGameLaunchTimeSpans(): Promise<GameLaunchTimeSpan[]> {
+    const timezone = process.env.TZ ?? 'GMT';
+    return await this.gameModel.aggregate([
+      {
+        $project: {
+          dayOfWeek: {
+            $dayOfWeek: {
+              date: '$launchedAt',
+              timezone,
+            },
+          },
+          timeOfTheDay: {
+            $switch: {
+              branches: [
+                {
+                  case: {
+                    $in: [
+                      {
+                        $hour: {
+                          date: '$launchedAt',
+                          timezone,
+                        },
+                      },
+                      [6, 7, 8, 9, 10, 11],
+                    ],
+                  },
+                  then: 'morning',
+                },
+                {
+                  case: {
+                    $in: [
+                      {
+                        $hour: {
+                          date: '$launchedAt',
+                          timezone,
+                        },
+                      },
+                      [12, 13, 14, 15, 16, 17],
+                    ],
+                  },
+                  then: 'afternoon',
+                },
+                {
+                  case: {
+                    $in: [
+                      {
+                        $hour: {
+                          date: '$launchedAt',
+                          timezone,
+                        },
+                      },
+                      [18, 19, 20, 21, 22, 23],
+                    ],
+                  },
+                  then: 'evening',
+                },
+                {
+                  case: {
+                    $in: [
+                      {
+                        $hour: {
+                          date: '$launchedAt',
+                          timezone,
+                        },
+                      },
+                      [0, 1, 2, 3, 4, 5],
+                    ],
+                  },
+                  then: 'night',
+                },
+              ],
+            },
+          },
+        },
+      },
+      {
+        $group: {
+          _id: {
+            dayOfWeek: '$dayOfWeek',
+            timeOfTheDay: '$timeOfTheDay',
+          },
+          count: { $sum: 1 },
+        },
+      },
+      {
+        $project: {
+          dayOfWeek: '$_id.dayOfWeek',
+          timeOfTheDay: '$_id.timeOfTheDay',
+          count: 1,
+          _id: 0,
+        },
+      },
+    ]);
+  }
 }