Merge pull request #6 from boostcampwm-2024/fix/#5/refactor-query

Fixtar · web-flow · commit ac8e63b7bcc0 · 2025-01-17T16:06:27.000+09:00
[Fix] 티클 리스트 조회 쿼리 최적화
diff --git a/apps/api/package.json b/apps/api/package.json
@@ -19,10 +19,12 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "seed": "ts-node src/seeds/seed.ts"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.700.0",
+    "@faker-js/faker": "^9.3.0",
     "@nestjs/common": "^10.4.6",
     "@nestjs/config": "^3.3.0",
     "@nestjs/core": "^10.0.0",
@@ -50,6 +52,7 @@
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1",
     "typeorm": "^0.3.20",
+    "typeorm-extension": "^3.6.3",
     "winston": "^3.17.0",
     "winston-daily-rotate-file": "^5.0.0",
     "zod": "^3.23.8"
diff --git a/apps/api/src/entity/ticle.entity.ts b/apps/api/src/entity/ticle.entity.ts
@@ -19,6 +19,7 @@ import { Tag } from './tag.entity';
 import { User } from './user.entity';
 
 @Entity('ticle')
+@Index('idx_id_created_at', ['id', 'createdAt'])
 @Index('idx_fulltext_search', ['title', 'content'], { fulltext: true })
 export class Ticle {
   @PrimaryGeneratedColumn({ type: 'bigint' })
@@ -52,6 +53,7 @@ export class Ticle {
   @Column({ type: 'enum', enum: TicleStatus, default: TicleStatus.OPEN, name: 'ticle_status' })
   ticleStatus: TicleStatus;
 
+  @Index()
   @CreateDateColumn({ type: 'timestamp', name: 'created_at' })
   createdAt: Date;
 
diff --git a/apps/api/src/seeds/applicant.seeder.ts b/apps/api/src/seeds/applicant.seeder.ts
@@ -0,0 +1,37 @@
+import { faker } from '@faker-js/faker';
+import { DataSource } from 'typeorm';
+
+import { Applicant } from '../entity/applicant.entity'; // Applicant 엔티티 경로 확인
+import { Ticle } from '../entity/ticle.entity'; // Ticle 엔티티 경로 확인
+import { User } from '../entity/user.entity'; // User 엔티티 경로 확인
+
+export const seedApplicants = async (dataSource: DataSource, count: number) => {
+  const applicantRepository = dataSource.getRepository(Applicant);
+  const ticleRepository = dataSource.getRepository(Ticle);
+  const userRepository = dataSource.getRepository(User);
+
+  const existingTicles = await ticleRepository.find();
+  const existingUsers = await userRepository.find();
+
+  for (let i = 0; i < count; i++) {
+    // 랜덤한 타이클과 사용자 선택
+    const randomTicle = faker.helpers.arrayElement(existingTicles);
+    const randomUser = faker.helpers.arrayElement(existingUsers);
+
+    const applicant = applicantRepository.create({
+      ticle: randomTicle,
+      user: randomUser,
+    });
+
+    try {
+      await applicantRepository.save(applicant);
+    } catch (error) {
+      console.error(
+        `Error seeding applicant for Ticle ID ${randomTicle.id} and User ID ${randomUser.id}:`,
+        error
+      );
+    }
+  }
+
+  console.log(`${count} applicants seeded!`);
+};
diff --git a/apps/api/src/seeds/datasource.ts b/apps/api/src/seeds/datasource.ts
@@ -0,0 +1,21 @@
+import 'reflect-metadata';
+import { DataSource } from 'typeorm';
+
+import { Applicant } from '../entity/applicant.entity';
+import { Summary } from '../entity/summary.entity';
+import { Tag } from '../entity/tag.entity';
+import { Ticle } from '../entity/ticle.entity';
+import { User } from '../entity/user.entity';
+
+// 데이터 소스 초기화
+export const AppDataSource = new DataSource({
+  type: 'mysql', // 사용할 데이터베이스 종류
+  host: 'localhost', // 데이터베이스 호스트
+  port: 3306, // 데이터베이스 포트
+  username: 'root', // 사용자 이름
+  password: '123', // 비밀번호
+  database: 'ticle_test', // 데이터베이스 이름
+  synchronize: true, // 개발 중에는 true로 설정 (생성된 엔티티에 따라 테이블을 동기화)
+  logging: true, // 쿼리 로깅
+  entities: [User, Ticle, Tag, Applicant, Summary], // 사용할 엔티티 목록
+});
diff --git a/apps/api/src/seeds/seed.ts b/apps/api/src/seeds/seed.ts
@@ -0,0 +1,27 @@
+import { seedApplicants } from './applicant.seeder';
+import { AppDataSource } from './datasource';
+import { seedTags } from './tag.seeder';
+import { seedTicles } from './ticle.seeder';
+import { seedUsers } from './user.seeder';
+
+const seedDatabase = async () => {
+  try {
+    // 데이터 소스 초기화
+    await AppDataSource.initialize();
+    console.log('Database connected successfully!');
+
+    // User 데이터를 Seed
+    // await seedUsers(AppDataSource, 1000);
+    // await seedTicles(AppDataSource, 3_000_000);
+    // await seedTags(AppDataSource, 100);
+    // await seedApplicants(AppDataSource, 1000);
+
+    console.log('Seeding completed!');
+    process.exit(0);
+  } catch (error) {
+    console.error('Error seeding database:', error);
+    process.exit(1);
+  }
+};
+
+seedDatabase();
diff --git a/apps/api/src/seeds/tag.seeder.ts b/apps/api/src/seeds/tag.seeder.ts
@@ -0,0 +1,43 @@
+import { faker } from '@faker-js/faker';
+import { DataSource } from 'typeorm';
+
+import { Tag } from '../entity/tag.entity'; // Tag 엔티티 경로 확인
+import { Ticle } from '../entity/ticle.entity'; // Ticle 엔티티 경로 확인
+
+export const seedTags = async (dataSource: DataSource, count: number) => {
+  const tagRepository = dataSource.getRepository(Tag);
+  const ticleRepository = dataSource.getRepository(Ticle);
+
+  // 기존 태그와 타이클을 가져옵니다.
+  const existingTags = await tagRepository.find();
+  const existingTagNames = new Set(existingTags.map((tag) => tag.name));
+  const existingTicles = await ticleRepository.find();
+
+  for (let i = 0; i < count; i++) {
+    let name;
+    do {
+      name = faker.word.adjective(); // 랜덤한 단어 생성
+    } while (existingTagNames.has(name)); // 중복 확인
+
+    const tag = tagRepository.create({
+      name,
+    });
+
+    // 태그 저장
+    await tagRepository.save(tag);
+    existingTagNames.add(name); // 새로 생성된 태그 이름 추가
+
+    // 랜덤하게 타이클을 선택하고 연결합니다.
+    if (existingTicles.length > 0) {
+      const randomTicle = faker.helpers.arrayElement(existingTicles);
+      // 이미 태그가 있으면 추가하고, 없으면 새로 만들어서 연결
+      if (!randomTicle.tags) {
+        randomTicle.tags = [];
+      }
+      randomTicle.tags.push(tag);
+      await ticleRepository.save(randomTicle); // 수정된 타이클 저장
+    }
+  }
+
+  console.log(`${count} tags seeded!`);
+};
diff --git a/apps/api/src/seeds/ticle.seeder.ts b/apps/api/src/seeds/ticle.seeder.ts
@@ -0,0 +1,36 @@
+import { faker } from '@faker-js/faker';
+import { DataSource } from 'typeorm';
+import { TicleStatus } from '@repo/types'; // TicleStatus enum 경로 확인
+
+import { Ticle } from '../entity/ticle.entity';
+import { User } from '../entity/user.entity';
+
+export const seedTicles = async (dataSource: DataSource, count: number) => {
+  const ticleRepository = dataSource.getRepository(Ticle);
+  const userRepository = dataSource.getRepository(User);
+
+  // 사용자 목록을 가져옵니다.
+  const users = await userRepository.find();
+
+  for (let i = 0; i < count; i++) {
+    // 임의의 사용자 선택
+    const randomUser = users[Math.floor(Math.random() * users.length)];
+
+    const ticle = ticleRepository.create({
+      speaker: randomUser,
+      speakerName: randomUser.nickname, // 사용자 이름 사용
+      speakerEmail: randomUser.email, // 사용자 이메일 사용
+      speakerIntroduce: faker.lorem.sentence(),
+      title: faker.lorem.sentence(),
+      content: faker.lorem.paragraphs(),
+      startTime: faker.date.future(),
+      endTime: faker.date.future(),
+      ticleStatus: TicleStatus.OPEN,
+      createdAt: new Date(),
+      profileImageUrl: faker.image.avatar(),
+    });
+    await ticleRepository.save(ticle);
+  }
+
+  console.log('Ticles seeded!');
+};
diff --git a/apps/api/src/seeds/user.seeder.ts b/apps/api/src/seeds/user.seeder.ts
@@ -0,0 +1,23 @@
+import { faker } from '@faker-js/faker';
+import { DataSource } from 'typeorm';
+
+import { User } from '../entity/user.entity';
+
+export const seedUsers = async (dataSource: DataSource, count: number) => {
+  const userRepository = dataSource.getRepository(User);
+
+  for (let i = 0; i < count; i++) {
+    const user = userRepository.create({
+      username: faker.internet.userName(),
+      password: faker.internet.password(),
+      nickname: faker.name.firstName(),
+      email: faker.internet.email(),
+      introduce: faker.lorem.sentence(),
+      profileImageUrl: faker.image.avatar(),
+      provider: 'local',
+    });
+    await userRepository.save(user);
+  }
+
+  console.log('Users seeded!');
+};
diff --git a/apps/api/src/ticle/dto/getTicleListQueryDto.ts b/apps/api/src/ticle/dto/getTicleListQueryDto.ts
@@ -4,14 +4,6 @@ import { Transform } from 'class-transformer';
 import { SortType } from '../sortType.enum';
 
 export class GetTicleListQueryDto {
-  @ApiProperty({
-    example: 1,
-    description: '페이지 번호',
-    default: 1,
-    required: false,
-  })
-  page?: number = 1;
-
   @ApiProperty({
     example: 10,
     description: '페이지당 항목 수',
@@ -37,4 +29,11 @@ export class GetTicleListQueryDto {
     required: false,
   })
   sort?: SortType = SortType.NEWEST;
+
+  @ApiProperty({
+    example: '2025-01-14T12:00:00Z',
+    description: 'lastCreatedAt',
+    required: false,
+  })
+  lastSeenCreatedAt?: Date;
 }
diff --git a/apps/api/src/ticle/ticle.controller.ts b/apps/api/src/ticle/ticle.controller.ts
@@ -28,10 +28,10 @@ export class TicleController {
   @Get('list')
   async getTicleList(@Query() query: GetTicleListQueryDto) {
     const parsedQuery = {
-      page: query.page ? Number(query.page) : 1,
       pageSize: query.pageSize ? Number(query.pageSize) : 10,
       isOpen: query.isOpen === undefined ? true : query.isOpen,
       sort: query.sort || SortType.NEWEST,
+      lastSeenCreatedAt: query.lastSeenCreatedAt ? query.lastSeenCreatedAt : null,
     };
     return this.ticleService.getTicleList(parsedQuery);
   }
diff --git a/apps/api/src/ticle/ticle.service.spec.ts b/apps/api/src/ticle/ticle.service.spec.ts
@@ -0,0 +1,60 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { DataSource } from 'typeorm';
+
+import { SortType } from './sortType.enum';
+import { TicleService } from './ticle.service'; // 서비스 경로에 맞게 수정
+import { Applicant } from '../entity/applicant.entity';
+import { Summary } from '../entity/summary.entity';
+import { Tag } from '../entity/tag.entity';
+import { Ticle } from '../entity/ticle.entity';
+import { User } from '../entity/user.entity';
+
+describe('TicleService', () => {
+  let service: TicleService;
+  let dataSource: DataSource;
+
+  beforeAll(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      imports: [
+        TypeOrmModule.forRoot({
+          type: 'mysql',
+          host: 'localhost',
+          port: 3306,
+          username: 'root',
+          password: '123',
+          database: 'ticle_test',
+          entities: [Ticle, User, Applicant, Summary, Tag],
+          synchronize: true, // 테스트 환경에서는 true로 설정
+        }),
+        TypeOrmModule.forFeature([Ticle, User, Applicant, Summary, Tag]),
+      ],
+      providers: [TicleService], // TicleService를 providers에 추가
+    }).compile();
+
+    service = module.get<TicleService>(TicleService);
+    dataSource = module.get<DataSource>(DataSource);
+  });
+
+  afterAll(async () => {
+    await dataSource.destroy(); // DB 연결 종료
+  });
+
+  it('should measure query performance', async () => {
+    const query = {
+      page: 1,
+      pageSize: 10,
+      isOpen: true,
+      sort: SortType.OLDEST, // 원하는 정렬 타입으로 수정
+    };
+
+    const startTime = Date.now();
+    const result = await service.getTicleList(query);
+    const duration = Date.now() - startTime;
+
+    console.log(`Query executed in: ${duration}ms`);
+
+    expect(result).toHaveProperty('ticles');
+    expect(Number(result.meta.totalItems)).toBeGreaterThan(0); // 적어도 결과가 있어야 함
+  });
+});
diff --git a/apps/api/src/ticle/ticle.service.ts b/apps/api/src/ticle/ticle.service.ts
diff --git a/apps/media/package.json b/apps/media/package.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
