refactor: implement pagination and featured songs retrieval in SongController and SongService, including new PageDto for consistent response structure

tomast1337 · tomast1337 · commit 0fcbfbe28c0a · 2025-09-23T21:28:23.000-03:00
diff --git a/apps/backend/src/song/song.controller.ts b/apps/backend/src/song/song.controller.ts
@@ -1,6 +1,5 @@
 import { UPLOAD_CONSTANTS } from '@nbw/config';
-import type { UserDocument } from '@nbw/database';
-import {  PageQueryDTO,  SongPreviewDto,  SongViewDto,  UploadSongDto,  UploadSongResponseDto,} from '@nbw/database';
+import { PageDto, UserDocument ,  PageQueryDTO,  SongPreviewDto,  SongViewDto,  UploadSongDto,  UploadSongResponseDto, FeaturedSongsDto,} from '@nbw/database';
 import type { RawBodyRequest } from '@nestjs/common';
 import {  BadRequestException,  Body,  Controller,  Delete,  Get,  Headers,  HttpStatus,  Param,  Patch,  Post,  Query,  Req,  Res,  UnauthorizedException,  UploadedFile,  UseGuards,  UseInterceptors,} from '@nestjs/common';
 import { AuthGuard } from '@nestjs/passport';
@@ -12,7 +11,6 @@ import type { Response } from 'express';
 import { FileService } from '@server/file/file.service';
 import { GetRequestToken, validateUser } from '@server/lib/GetRequestUser';
 
-import { SongBrowserService } from './song-browser/song-browser.service';
 import { SongService } from './song.service';
 
 // Handles public-facing song routes.
@@ -29,7 +27,7 @@ export class SongController {
     },
   };
 
-  constructor(  public readonly songService: SongService,  public readonly fileService: FileService,  public readonly songBrowserService: SongBrowserService,) {}
+  constructor(  public readonly songService: SongService,  public readonly fileService: FileService, ) {}
 
   @Get('/')
   @ApiOperation({
@@ -95,33 +93,59 @@ export class SongController {
     @Query('q') q?: 'featured' | 'recent' | 'categories' | 'random',
     @Param('id') id?: string,
     @Query('category') category?: string,
-  ): Promise<SongPreviewDto[] | Record<string, number>> {
+  ): Promise<PageDto<SongPreviewDto> | Record<string, number> | FeaturedSongsDto> {
     if (q) {
       switch (q) {
         case 'featured':
-          return await this.songBrowserService.getRecentSongs(query);
+          return await this.songService.getFeaturedSongs();
         case 'recent':
-          return await this.songBrowserService.getRecentSongs(query);
+          return new PageDto<SongPreviewDto>({
+            content: await this.songService.getRecentSongs(     query.page,     query.limit, ),
+            page   : query.page,
+            limit  : query.limit,
+            total  : 0,
+          });
         case 'categories':
           if (id) {
-            return await this.songBrowserService.getSongsByCategory(id, query);
+            return new PageDto<SongPreviewDto>({
+              content: await this.songService.getSongsByCategory(
+                category,
+                query.page,
+                query.limit,
+              ),
+              page : query.page,
+              limit: query.limit,
+              total: 0,
+            });
           }
-          return await this.songBrowserService.getCategories();
+          return await this.songService.getCategories();
         case 'random': {
           if (query.limit && (query.limit < 1 || query.limit > 10)) {
             throw new BadRequestException('Invalid query parameters');
           }
-          return await this.songBrowserService.getRandomSongs(
+          const data = await this.songService.getRandomSongs(
             query.limit ?? 1,
             category,
           );
+          return new PageDto<SongPreviewDto>({
+            content: data,
+            page   : query.page,
+            limit  : query.limit,
+            total  : data.length,
+          });
         }
         default:
           throw new BadRequestException('Invalid query parameters');
       }
     }
 
-    return await this.songService.getSongByPage(query);
+    const data = await this.songService.getSongByPage(query);
+    return new PageDto<SongPreviewDto>({
+      content: data,
+      page   : query.page,
+      limit  : query.limit,
+      total  : data.length,
+    });
   }
 
   @Get('/search')
@@ -131,8 +155,14 @@ export class SongController {
   public async searchSongs(
     @Query() query: PageQueryDTO,
     @Query('q') q: string,
-  ): Promise<SongPreviewDto[]> {
-    return await this.songService.searchSongs(query, q ?? '');
+  ): Promise<PageDto<SongPreviewDto>> {
+    const data = await this.songService.searchSongs(query, q ?? '');
+    return new PageDto<SongPreviewDto>({
+      content: data,
+      page   : query.page,
+      limit  : query.limit,
+      total  : data.length,
+    });
   }
 
   @Get('/:id')
diff --git a/apps/backend/src/song/song.service.spec.ts b/apps/backend/src/song/song.service.spec.ts
@@ -1047,4 +1047,30 @@ describe('SongService', () => {
       expect(mockFind.exec).toHaveBeenCalled();
     });
   });
+
+  describe('getFeaturedSongs', () => {
+    it('should return featured songs', async () => {
+      const songWithUser: SongWithUser = {
+        title: 'Test Song',
+        uploader: { username: 'testuser', profileImage: 'testimage' },
+        stats: {
+          duration: 100,
+          noteCount: 100,
+        },
+      } as any;
+
+      jest
+        .spyOn(songService, 'getSongsForTimespan')
+        .mockResolvedValue([songWithUser]);
+
+      jest
+        .spyOn(songService, 'getSongsBeforeTimespan')
+        .mockResolvedValue([songWithUser]);
+
+      await service.getFeaturedSongs();
+
+      expect(songService.getSongsForTimespan).toHaveBeenCalled();
+      expect(songService.getSongsBeforeTimespan).toHaveBeenCalled();
+    });
+  });
 });
diff --git a/apps/backend/src/song/song.service.ts b/apps/backend/src/song/song.service.ts
@@ -1,6 +1,5 @@
 import { BROWSER_SONGS } from '@nbw/config';
-import type { UserDocument } from '@nbw/database';
-import {
+import { FeaturedSongsDto, TimespanType, UserDocument ,
   PageQueryDTO,
   Song as SongEntity,
   SongPageDto,
@@ -518,7 +517,75 @@ export class SongService {
     return songs.map((song) => SongPreviewDto.fromSongDocumentWithUser(song));
   }
 
-  public async getAllSongs() {
-    return this.songModel.find({});
+  public async getFeaturedSongs(): Promise<FeaturedSongsDto> {
+    const now = new Date(Date.now());
+
+    const times: Record<TimespanType, number> = {
+      hour : new Date(Date.now()).setHours(now.getHours() - 1),
+      day  : new Date(Date.now()).setDate(now.getDate() - 1),
+      week : new Date(Date.now()).setDate(now.getDate() - 7),
+      month: new Date(Date.now()).setMonth(now.getMonth() - 1),
+      year : new Date(Date.now()).setFullYear(now.getFullYear() - 1),
+      all  : new Date(0).getTime(),
+    };
+
+    const songs: Record<TimespanType, SongWithUser[]> = {
+      hour : [],
+      day  : [],
+      week : [],
+      month: [],
+      year : [],
+      all  : [],
+    };
+
+    for (const [timespan, time] of Object.entries(times)) {
+      const songPage = await this.getSongsForTimespan(time);
+
+      // If the length is 0, send an empty array (no songs available in that timespan)
+      // If the length is less than the page size, pad it with songs "borrowed"
+      // from the nearest timestamp, regardless of view count
+      if (
+        songPage.length > 0 &&
+        songPage.length < BROWSER_SONGS.paddedFeaturedPageSize
+      ) {
+        const missing = BROWSER_SONGS.paddedFeaturedPageSize - songPage.length;
+
+        const additionalSongs = await this.getSongsBeforeTimespan(
+          time,
+        );
+
+        songPage.push(...additionalSongs.slice(0, missing));
+      }
+
+      songs[timespan as TimespanType] = songPage;
+    }
+
+    const featuredSongs = FeaturedSongsDto.create();
+
+    featuredSongs.hour = songs.hour.map((song) =>
+      SongPreviewDto.fromSongDocumentWithUser(song),
+    );
+
+    featuredSongs.day = songs.day.map((song) =>
+      SongPreviewDto.fromSongDocumentWithUser(song),
+    );
+
+    featuredSongs.week = songs.week.map((song) =>
+      SongPreviewDto.fromSongDocumentWithUser(song),
+    );
+
+    featuredSongs.month = songs.month.map((song) =>
+      SongPreviewDto.fromSongDocumentWithUser(song),
+    );
+
+    featuredSongs.year = songs.year.map((song) =>
+      SongPreviewDto.fromSongDocumentWithUser(song),
+    );
+
+    featuredSongs.all = songs.all.map((song) =>
+      SongPreviewDto.fromSongDocumentWithUser(song),
+    );
+
+    return featuredSongs;
   }
 }
diff --git a/packages/database/src/common/dto/Page.dto.ts b/packages/database/src/common/dto/Page.dto.ts
@@ -0,0 +1,78 @@
+import { ApiProperty } from '@nestjs/swagger';
+import {
+  IsArray,
+  IsBoolean,
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  ValidateNested,
+} from 'class-validator';
+
+export class PageDto<T> {
+  @IsNotEmpty()
+  @IsNumber({
+    allowNaN        : false,
+    allowInfinity   : false,
+    maxDecimalPlaces: 0,
+  })
+  @ApiProperty({
+    example    : 150,
+    description: 'Total number of items available',
+  })
+  total: number;
+
+  @IsNotEmpty()
+  @IsNumber({
+    allowNaN        : false,
+    allowInfinity   : false,
+    maxDecimalPlaces: 0,
+  })
+  @ApiProperty({
+    example    : 1,
+    description: 'Current page number',
+  })
+  page: number;
+
+  @IsNotEmpty()
+  @IsNumber({
+    allowNaN        : false,
+    allowInfinity   : false,
+    maxDecimalPlaces: 0,
+  })
+  @ApiProperty({
+    example    : 20,
+    description: 'Number of items per page',
+  })
+  limit: number;
+
+  @IsOptional()
+  @IsString()
+  @ApiProperty({
+    example    : 'createdAt',
+    description: 'Field used for sorting',
+    required   : false,
+  })
+  sort?: string;
+
+  @IsNotEmpty()
+  @IsBoolean()
+  @ApiProperty({
+    example    : false,
+    description: 'Sort order: true for ascending, false for descending',
+  })
+  order: boolean;
+
+  @IsNotEmpty()
+  @IsArray()
+  @ValidateNested({ each: true })
+  @ApiProperty({
+    description: 'Array of items for the current page',
+    isArray    : true,
+  })
+  content: T[];
+
+  constructor(partial: Partial<PageDto<T>>) {
+    Object.assign(this, partial);
+  }
+}
diff --git a/packages/database/src/index.ts b/packages/database/src/index.ts
@@ -1,3 +1,4 @@
+export * from './common/dto/Page.dto';
 export * from './common/dto/PageQuery.dto';
 export * from './common/dto/types';
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+export * from './common/dto/Page.dto';`
`1`	`2`	`export * from './common/dto/PageQuery.dto';`
`2`	`3`	`export * from './common/dto/types';`
`3`	`4`