feat(modules/reports/router/controller): implement `getGenresListenin…

…gDays`
Rigtch · Sep 19, 2024 · c7331f0 · c7331f0
1 parent 0ab5be7
commit c7331f0
Show file tree

Hide file tree

Showing 2 changed files with 108 additions and 1 deletion.
diff --git a/src/modules/reports/router/reports.controller.spec.ts b/src/modules/reports/router/reports.controller.spec.ts
@@ -4,6 +4,7 @@ import { CacheInterceptor } from '@nestjs/cache-manager'
 import { ReportsService } from '../reports.service'
 
 import { ReportsController } from './reports.controller'
+import { GenresListeningDaysDocument } from './docs'
 
 import { UsersRepository } from '@modules/users'
 import { userMock } from '@common/mocks'
@@ -25,6 +26,7 @@ describe('ReportsController', () => {
           provide: ReportsService,
           useValue: {
             getListeningDays: vi.fn(),
+            getGenresListeningDays: vi.fn(),
             getListeningHours: vi.fn(),
             getTotalTracks: vi.fn(),
             getTotalArtists: vi.fn(),
@@ -143,6 +145,77 @@ describe('ReportsController', () => {
       })
     })
 
+    describe('GenresListeningDays', () => {
+      const genresListeningDaysArray: GenresListeningDaysDocument[] = [
+        {
+          dayIndex: 1,
+          data: {
+            Pop: 30,
+          },
+          date: new Date('2024-08-22T08:59:38.340Z'),
+        },
+        {
+          dayIndex: 2,
+          data: {
+            Rock: 20,
+          },
+          date: new Date('2024-08-23T08:59:38.340Z'),
+        },
+        {
+          dayIndex: 3,
+          data: {
+            Jazz: 10,
+          },
+          date: new Date('2024-08-24T08:59:38.340Z'),
+        },
+      ]
+
+      test('should get genres listening days with plays measurement', async () => {
+        const getGenresListeningDaysSpy = vi
+          .spyOn(reportsService, 'getGenresListeningDays')
+          .mockResolvedValue(genresListeningDaysArray)
+
+        expect(
+          await reportsController.getGenresListeningDays(userMock, {
+            before,
+            after,
+          })
+        ).toEqual(genresListeningDaysArray)
+
+        expect(getGenresListeningDaysSpy).toHaveBeenCalledWith(
+          {
+            before,
+            after,
+            measurement: StatsMeasurement.PLAYS,
+          },
+          userMock
+        )
+      })
+
+      test('should get genres listening days with play time measurement', async () => {
+        const getGenresListeningDaysSpy = vi
+          .spyOn(reportsService, 'getGenresListeningDays')
+          .mockResolvedValue(genresListeningDaysArray)
+
+        expect(
+          await reportsController.getGenresListeningDays(userMock, {
+            before,
+            after,
+            measurement: StatsMeasurement.PLAY_TIME,
+          })
+        ).toEqual(genresListeningDaysArray)
+
+        expect(getGenresListeningDaysSpy).toHaveBeenCalledWith(
+          {
+            before,
+            after,
+            measurement: StatsMeasurement.PLAY_TIME,
+          },
+          userMock
+        )
+      })
+    })
+
     describe('getListeningHours', () => {
       const listeningHoursObject = {
         1: 10,

diff --git a/src/modules/reports/router/reports.controller.ts b/src/modules/reports/router/reports.controller.ts
@@ -11,7 +11,11 @@ import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger'
 import { ReportsService } from '../reports.service'
 
 import { ReportsListeningQuery, ReportsTotalItemsQuery } from './dtos'
-import { ListeningDaysDocument, TotalItemsDocument } from './docs'
+import {
+  GenresListeningDaysDocument,
+  ListeningDaysDocument,
+  TotalItemsDocument,
+} from './docs'
 import {
   ApiReportsListeningQuery,
   ApiReportsTotalItemsQuery,
@@ -64,6 +68,36 @@ export class ReportsController {
     )
   }
 
+  @Get('genres-listening-days')
+  @ApiOperation({
+    summary: "Getting user's genres listening days (cached).",
+    description:
+      "Getting user's genres listening days, used for creating charts (cached).",
+  })
+  @ApiOkResponse({
+    description: MANY_SUCCESSFULLY_RETRIEVED('genres listening days'),
+    type: [GenresListeningDaysDocument],
+  })
+  @ApiReportsListeningQuery()
+  getGenresListeningDays(
+    @RequestUser() user: User,
+    @Query()
+    {
+      before = new Date(),
+      after,
+      measurement = StatsMeasurement.PLAYS,
+    }: ReportsListeningQuery
+  ) {
+    return this.reportsService.getGenresListeningDays(
+      {
+        before,
+        after,
+        measurement,
+      },
+      user
+    )
+  }
+
   @Get('listening-hours')
   @ApiOperation({
     summary: "Getting user's listening hours (cached).",