게임 방 리스트 조회 (#40)

* feat: 게임방 목록 조회 API

* feat: 게임방 응답에 현재 구성원 수 추가

player를 member로 명칭하도록 속성명 변경

Author: rrgks6221

jest.config.ts

@@ -24,6 +24,7 @@ export default {
   setupFilesAfterEnv: [
     '<rootDir>/test/after-env-setup.ts',
     'jest-extended/all',
+    'jest-sorted',
   ],
   globalSetup: '<rootDir>/test/global-setup.ts',
   globalTeardown: '<rootDir>/test/global-teardown.ts',

package-lock.json

@@ -79,6 +79,7 @@
     "globals": "^16.0.0",
     "jest": "^29.7.0",
     "jest-extended": "^6.0.0",
+    "jest-sorted": "^1.0.15",
     "prettier": "^3.4.2",
     "prisma": "6.4.0",
     "rosie": "^2.1.1",

package.json

@@ -1,5 +1,13 @@
 import { ApiProperty } from '@nestjs/swagger';
 
+import { ISort } from '@common/base/base.repository';
+
+export class SortDto implements ISort {
+  field: string;
+
+  direction: 'desc' | 'asc';
+}
+
 export class BaseResponseDto {
   constructor(props: BaseResponseDto) {
     this.id = props.id;

src/common/base/base.dto.ts

@@ -3,6 +3,11 @@ import { IBaseMapper } from '@common/base/base.mapper';
 
 import { PrismaService } from '@shared/prisma/prisma.service';
 
+export interface ISort<Field extends string = string> {
+  field: Field;
+  direction: 'desc' | 'asc';
+}
+
 export interface ICursorPaginated<T> {
   cursor?: string;
   data: T[];
@@ -96,4 +101,22 @@ export abstract class BaseRepository<
       },
     });
   }
+
+  protected toOrderBy(sort?: ISort[]): Record<string, any> | undefined {
+    if (sort === undefined || sort.length === 0) {
+      return;
+    }
+
+    return sort.reduce((acc, cur) => {
+      const { field, direction } = cur;
+
+      if (field === 'createdAt') {
+        acc['id'] = direction;
+      } else {
+        acc[field] = direction;
+      }
+
+      return acc;
+    }, {});
+  }
 }

src/common/base/base.repository.ts

@@ -0,0 +1,23 @@
+import { applyDecorators } from '@nestjs/common';
+import { ApiProperty, ApiPropertyOptions } from '@nestjs/swagger';
+
+export const ApiSort = (
+  options: ApiPropertyOptions & { allowFields: ReadonlySet<string> },
+) => {
+  return applyDecorators(
+    ApiProperty({
+      description: `
+    정렬 쿼리. 다중 정렬은 콤마(,)로 구분.
+    허용되지 않은 정렬 필드 및 방향은 무시합니다.
+    형식: field:asc | field:desc
+    허용 필드: ${Array.from(options.allowFields).join(',')},
+    예: sort=-title:asc,createdAt:asc
+      `,
+      default: 'createdAt:asc',
+      example: 'createdAt:asc',
+      required: false as any,
+      type: String,
+      ...options,
+    }),
+  );
+};

src/common/decorator/api-sort.decorator.ts

@@ -0,0 +1,26 @@
+import { parseSort } from '@common/transformer/parse-sort.transformer';
+
+describe(parseSort, () => {
+  const ALLOW_FIELDS = new Set(['id', 'createdAt']);
+
+  it('여러 필드로 정렬할 수 있다.', () => {
+    expect(parseSort('id:asc,createdAt:desc', ALLOW_FIELDS)).toEqual([
+      {
+        field: 'id',
+        direction: 'asc',
+      },
+      {
+        field: 'createdAt',
+        direction: 'desc',
+      },
+    ]);
+  });
+
+  it('허용되지 않은 필드는 무시한다.', () => {
+    expect(parseSort('qwe:desc', ALLOW_FIELDS)).toEqual([]);
+  });
+
+  it('허용되지 않은 정렬 방향은 무시한다.', () => {
+    expect(parseSort('id:qwe', ALLOW_FIELDS)).toEqual([]);
+  });
+});

src/common/transformer/__spec__/parse-sort.transformer.spec.ts

@@ -0,0 +1,56 @@
+import { applyDecorators } from '@nestjs/common';
+
+import { Transform, TransformFnParams } from 'class-transformer';
+
+import { SortDto } from '@common/base/base.dto';
+
+export const parseSort = (
+  value: unknown,
+  allowFields: ReadonlySet<string>,
+): SortDto[] | undefined => {
+  if (value === undefined) {
+    return;
+  }
+  if (typeof value !== 'string') {
+    return;
+  }
+
+  const parsedOrders = value.split(',');
+
+  const orders = parsedOrders
+    .map((parsedOrder) => {
+      const [field, direction] = parsedOrder.split(':');
+
+      return {
+        field,
+        direction,
+      };
+    })
+    .filter(({ field, direction }) => {
+      if (allowFields.has(field) === false) {
+        return false;
+      }
+      if (direction !== 'desc' && direction !== 'asc') {
+        return false;
+      }
+      return true;
+    })
+    .map(({ field, direction }) => {
+      const sortDto = new SortDto();
+
+      sortDto.field = field;
+      sortDto.direction = direction as SortDto['direction'];
+
+      return sortDto;
+    });
+
+  return orders;
+};
+
+export const ParseSort = (allowFields: ReadonlySet<string>) => {
+  return applyDecorators(
+    Transform(({ value }: TransformFnParams): SortDto[] | undefined => {
+      return parseSort(value, allowFields);
+    }),
+  );
+};

src/common/transformer/parse-sort.transformer.ts

@@ -0,0 +1,13 @@
+import { GameRoomDtoAssembler } from '@module/game-room/assemblers/game-room-dto.assembler';
+import { GameRoomCollectionDto } from '@module/game-room/dto/game-room-collection.dto';
+import { GameRoom } from '@module/game-room/entities/game-room.entity';
+
+export class GameRoomCollectionDtoAssembler {
+  static convertToDto(domainObject: GameRoom[]): GameRoomCollectionDto {
+    const dto = new GameRoomCollectionDto();
+
+    dto.data = domainObject.map(GameRoomDtoAssembler.convertToDto);
+
+    return dto;
+  }
+}

src/modules/game-room/assemblers/game-room-collection-dto.assembler.ts

@@ -12,7 +12,8 @@ export class GameRoomDtoAssembler {
     dto.hostId = gameRoom.props.hostId;
     dto.status = gameRoom.props.status;
     dto.title = gameRoom.props.title;
-    dto.maxPlayersCount = gameRoom.props.maxMembersCount;
+    dto.maxMembersCount = gameRoom.props.maxMembersCount;
+    dto.currentMembersCount = gameRoom.props.currentMembersCount;
 
     return dto;
   }