refactor: enhance SongController tests to cover new song retrieval features including recent, featured, categories, and random songs

Author: tomast1337

apps/backend/src/song/song.controller.spec.ts

@@ -1,23 +1,19 @@
 import type { UserDocument } from '@nbw/database';
-import {
-  PageQueryDTO,
-  SongPreviewDto,
-  SongViewDto,
-  UploadSongDto,
-  UploadSongResponseDto,
-} from '@nbw/database';
+import {  PageQueryDTO,  SongPreviewDto,  SongViewDto,  UploadSongDto,  UploadSongResponseDto,} from '@nbw/database';
 import { HttpStatus, UnauthorizedException } from '@nestjs/common';
 import { AuthGuard } from '@nestjs/passport';
 import { Test, TestingModule } from '@nestjs/testing';
 import { Response } from 'express';
 
-import { FileService } from '@server/file/file.service';
+import { FileService } from '../file/file.service';
 
+import { SongBrowserService } from './song-browser/song-browser.service';
 import { SongController } from './song.controller';
 import { SongService } from './song.service';
 
 const mockSongService = {
   getSongByPage: jest.fn(),
+  searchSongs: jest.fn(),
   getSong: jest.fn(),
   getSongEdit: jest.fn(),
   patchSong: jest.fn(),
@@ -28,9 +24,17 @@ const mockSongService = {
 
 const mockFileService = {};
 
+const mockSongBrowserService = {
+  getRecentSongs: jest.fn(),
+  getCategories: jest.fn(),
+  getSongsByCategory: jest.fn(),
+  getRandomSongs: jest.fn(),
+};
+
 describe('SongController', () => {
   let songController: SongController;
   let songService: SongService;
+  let songBrowserService: SongBrowserService;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -44,6 +48,10 @@ describe('SongController', () => {
           provide: FileService,
           useValue: mockFileService,
         },
+        {
+          provide: SongBrowserService,
+          useValue: mockSongBrowserService,
+        },
       ],
     })
       .overrideGuard(AuthGuard('jwt-refresh'))
@@ -52,6 +60,10 @@ describe('SongController', () => {
 
     songController = module.get<SongController>(SongController);
     songService = module.get<SongService>(SongService);
+    songBrowserService = module.get<SongBrowserService>(SongBrowserService);
+
+    // Clear all mocks
+    jest.clearAllMocks();
   });
 
   it('should be defined', () => {
@@ -71,6 +83,96 @@ describe('SongController', () => {
       expect(songService.getSongByPage).toHaveBeenCalledWith(query);
     });
 
+    it('should handle featured songs', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 10 };
+      const songList: SongPreviewDto[] = [];
+
+      mockSongBrowserService.getRecentSongs.mockResolvedValueOnce(songList);
+
+      const result = await songController.getSongList(query, 'featured');
+
+      expect(result).toEqual(songList);
+      expect(mockSongBrowserService.getRecentSongs).toHaveBeenCalledWith(query);
+    });
+
+    it('should handle recent songs', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 10 };
+      const songList: SongPreviewDto[] = [];
+
+      mockSongBrowserService.getRecentSongs.mockResolvedValueOnce(songList);
+
+      const result = await songController.getSongList(query, 'recent');
+
+      expect(result).toEqual(songList);
+      expect(mockSongBrowserService.getRecentSongs).toHaveBeenCalledWith(query);
+    });
+
+    it('should return categories when q=categories without id', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 10 };
+      const categories = { pop: 42, rock: 38 };
+
+      mockSongBrowserService.getCategories.mockResolvedValueOnce(categories);
+
+      const result = await songController.getSongList(query, 'categories');
+
+      expect(result).toEqual(categories);
+      expect(mockSongBrowserService.getCategories).toHaveBeenCalled();
+    });
+
+    it('should return songs by category when q=categories with id', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 10 };
+      const songList: SongPreviewDto[] = [];
+      const categoryId = 'pop';
+
+      mockSongBrowserService.getSongsByCategory.mockResolvedValueOnce(songList);
+
+      const result = await songController.getSongList(query, 'categories', categoryId);
+
+      expect(result).toEqual(songList);
+      expect(mockSongBrowserService.getSongsByCategory).toHaveBeenCalledWith(categoryId, query);
+    });
+
+    it('should return random songs', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 5 };
+      const songList: SongPreviewDto[] = [];
+      const category = 'electronic';
+
+      mockSongBrowserService.getRandomSongs.mockResolvedValueOnce(songList);
+
+      const result = await songController.getSongList(query, 'random', undefined, category);
+
+      expect(result).toEqual(songList);
+      expect(mockSongBrowserService.getRandomSongs).toHaveBeenCalledWith(5, category);
+    });
+
+    it('should throw error for invalid random count', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 15 }; // Invalid limit > 10
+
+      await expect(
+        songController.getSongList(query, 'random')
+      ).rejects.toThrow('Invalid query parameters');
+    });
+
+    it('should handle zero limit for random (uses default)', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 0 }; // limit 0 is falsy, so uses default
+      const songList: SongPreviewDto[] = [];
+
+      mockSongBrowserService.getRandomSongs.mockResolvedValueOnce(songList);
+
+      const result = await songController.getSongList(query, 'random');
+
+      expect(result).toEqual(songList);
+      expect(mockSongBrowserService.getRandomSongs).toHaveBeenCalledWith(0, undefined); // Passes 0 (nullish coalescing doesn't apply to 0)
+    });
+
+    it('should throw error for invalid query mode', async () => {
+      const query: PageQueryDTO = { page: 1, limit: 10 };
+
+      await expect(
+        songController.getSongList(query, 'invalid' as any)
+      ).rejects.toThrow('Invalid query parameters');
+    });
+
     it('should handle errors', async () => {
       const query: PageQueryDTO = { page: 1, limit: 10 };