Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(api): add listen report endpoint
- Loading branch information
Showing
9 changed files
with
179 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import { IsEnum, IsISO8601 } from "class-validator"; | ||
import { User } from "../../users/user.entity"; | ||
import { Timeframe } from "../timeframe.enum"; | ||
|
||
export class GetListenReportDto { | ||
user: User; | ||
|
||
@IsEnum(Timeframe) | ||
timeFrame: Timeframe; | ||
|
||
@IsISO8601() | ||
timeStart: string; | ||
|
||
@IsISO8601() | ||
timeEnd: string; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import { Timeframe } from "../timeframe.enum"; | ||
|
||
export class ListenReportDto { | ||
items: { | ||
date: string; | ||
count: number; | ||
}[]; | ||
|
||
timeFrame: Timeframe; | ||
|
||
timeStart: string; | ||
|
||
timeEnd: string; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
import { Test, TestingModule } from '@nestjs/testing'; | ||
import { ReportsController } from './reports.controller'; | ||
|
||
describe('Reports Controller', () => { | ||
let controller: ReportsController; | ||
|
||
beforeEach(async () => { | ||
const module: TestingModule = await Test.createTestingModule({ | ||
controllers: [ReportsController], | ||
}).compile(); | ||
|
||
controller = module.get<ReportsController>(ReportsController); | ||
}); | ||
|
||
it('should be defined', () => { | ||
expect(controller).toBeDefined(); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
import { Controller, Get, Query } from "@nestjs/common"; | ||
import { Auth } from "src/auth/decorators/auth.decorator"; | ||
import { ReqUser } from "../auth/decorators/req-user.decorator"; | ||
import { User } from "../users/user.entity"; | ||
import { GetListenReportDto } from "./dto/get-listen-report.dto"; | ||
import { ListenReportDto } from "./dto/listen-report.dto"; | ||
import { ReportsService } from "./reports.service"; | ||
|
||
@Controller("api/v1/reports") | ||
export class ReportsController { | ||
constructor(private readonly reportsService: ReportsService) {} | ||
|
||
@Get("listens") | ||
@Auth() | ||
async getListens( | ||
@Query() options: Omit<GetListenReportDto, "user">, | ||
@ReqUser() user: User | ||
): Promise<ListenReportDto> { | ||
return this.reportsService.getListens({ ...options, user }); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import { Module } from "@nestjs/common"; | ||
import { ReportsService } from "./reports.service"; | ||
import { ReportsController } from "./reports.controller"; | ||
import { ListensModule } from "src/listens/listens.module"; | ||
|
||
@Module({ | ||
imports: [ListensModule], | ||
providers: [ReportsService], | ||
controllers: [ReportsController], | ||
}) | ||
export class ReportsModule {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
import { Test, TestingModule } from '@nestjs/testing'; | ||
import { ReportsService } from './reports.service'; | ||
|
||
describe('ReportsService', () => { | ||
let service: ReportsService; | ||
|
||
beforeEach(async () => { | ||
const module: TestingModule = await Test.createTestingModule({ | ||
providers: [ReportsService], | ||
}).compile(); | ||
|
||
service = module.get<ReportsService>(ReportsService); | ||
}); | ||
|
||
it('should be defined', () => { | ||
expect(service).toBeDefined(); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
import { Injectable } from "@nestjs/common"; | ||
import { | ||
eachDayOfInterval, | ||
eachMonthOfInterval, | ||
eachWeekOfInterval, | ||
eachYearOfInterval, | ||
formatISO, | ||
Interval, | ||
isSameDay, | ||
isSameMonth, | ||
isSameWeek, | ||
isSameYear, | ||
parseISO, | ||
} from "date-fns"; | ||
import { ListensService } from "../listens/listens.service"; | ||
import { GetListenReportDto } from "./dto/get-listen-report.dto"; | ||
import { ListenReportDto } from "./dto/listen-report.dto"; | ||
import { Timeframe } from "./timeframe.enum"; | ||
|
||
const timeframeToDateFns: { | ||
[x in Timeframe]: { | ||
eachOfInterval: (interval: Interval) => Date[]; | ||
isSame: (dateLeft: Date, dateRight: Date) => boolean; | ||
}; | ||
} = { | ||
[Timeframe.Day]: { | ||
eachOfInterval: eachDayOfInterval, | ||
isSame: isSameDay, | ||
}, | ||
[Timeframe.Week]: { | ||
eachOfInterval: eachWeekOfInterval, | ||
isSame: isSameWeek, | ||
}, | ||
[Timeframe.Month]: { | ||
eachOfInterval: eachMonthOfInterval, | ||
isSame: isSameMonth, | ||
}, | ||
[Timeframe.Year]: { | ||
eachOfInterval: eachYearOfInterval, | ||
isSame: isSameYear, | ||
}, | ||
}; | ||
|
||
@Injectable() | ||
export class ReportsService { | ||
constructor(private readonly listensService: ListensService) {} | ||
|
||
async getListens(options: GetListenReportDto): Promise<ListenReportDto> { | ||
const { user, timeFrame, timeStart, timeEnd } = options; | ||
|
||
const { items: listens } = await this.listensService.getListens({ | ||
user, | ||
filter: { time: { start: timeStart, end: timeEnd } }, | ||
page: 1, | ||
limit: 10000000, | ||
}); | ||
|
||
const reportInterval: Interval = { | ||
start: parseISO(timeStart), | ||
end: parseISO(timeEnd), | ||
}; | ||
|
||
const { eachOfInterval, isSame } = timeframeToDateFns[timeFrame]; | ||
|
||
const reportItems = eachOfInterval(reportInterval).map((date) => { | ||
const count = listens.filter((listen) => isSame(date, listen.playedAt)) | ||
.length; | ||
return { date: formatISO(date), count }; | ||
}); | ||
|
||
return { items: reportItems, timeStart, timeEnd, timeFrame }; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
export enum Timeframe { | ||
Day = "day", | ||
Week = "week", | ||
Month = "month", | ||
Year = "year", | ||
} |