Merge pull request #404 from boostcampwm-2024/feat/get-activity-api

✨ feat: 활동 내역 조회 API 구현

Author: asn6878

server/src/activity/api-docs/readActivities.api-docs.ts

@@ -0,0 +1,86 @@
+import { applyDecorators } from '@nestjs/common';
+import {
+  ApiNotFoundResponse,
+  ApiOkResponse,
+  ApiOperation,
+  ApiParam,
+  ApiQuery,
+} from '@nestjs/swagger';
+
+export function ApiReadActivities() {
+  return applyDecorators(
+    ApiOperation({
+      summary: '사용자 활동 데이터 조회',
+      description:
+        '특정 연도의 사용자 일별 활동 데이터와 스트릭 정보를 조회합니다.',
+    }),
+    ApiOkResponse({
+      description: '활동 데이터 조회 성공',
+      schema: {
+        properties: {
+          message: {
+            type: 'string',
+          },
+          data: {
+            type: 'object',
+            properties: {
+              dailyActivities: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    date: {
+                      type: 'string',
+                      description: '활동 날짜 (YYYY-MM-DD)',
+                    },
+                    viewCount: {
+                      type: 'number',
+                      description: '해당 날짜의 조회수',
+                    },
+                  },
+                },
+                description: '연도별 일별 활동 데이터 배열',
+              },
+              maxStreak: {
+                type: 'number',
+                description: '사용자의 최장 읽기 스트릭',
+              },
+              currentStreak: {
+                type: 'number',
+                description: '사용자의 현재 읽기 스트릭',
+              },
+              totalViews: {
+                type: 'number',
+                description: '사용자의 총 읽기 횟수',
+              },
+            },
+          },
+        },
+      },
+      example: {
+        message: '요청이 성공적으로 처리되었습니다.',
+        data: {
+          dailyActivities: [
+            {
+              date: '2024-01-15',
+              viewCount: 5,
+            },
+            {
+              date: '2024-01-16',
+              viewCount: 3,
+            },
+          ],
+          maxStreak: 15,
+          currentStreak: 7,
+          totalViews: 120,
+        },
+      },
+    }),
+    ApiNotFoundResponse({
+      description: '존재하지 않는 사용자',
+      example: {
+        message: '존재하지 않는 사용자입니다.',
+      },
+    }),
+  );
+}

server/src/activity/controller/activity.controller.ts

@@ -1,14 +1,18 @@
 import { Controller, Get, Param, Query } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 
 import { ActivityService } from '../service/activity.service';
 import { ApiResponse } from '../../common/response/common.response';
 import { ActivityParamRequestDto } from '../dto/request/activity-param.dto';
 import { ActivityQueryRequestDto } from '../dto/request/activity-query.dto';
+import { ApiReadActivities } from '../api-docs/readActivities.api-docs';
 
+@ApiTags('Activity')
 @Controller('activity')
 export class ActivityController {
   constructor(private readonly activityService: ActivityService) {}
 
+  @ApiReadActivities()
   @Get(':userId')
   async readActivities(
     @Param() paramDto: ActivityParamRequestDto,

server/src/activity/dto/response/activity-read.dto.ts

@@ -0,0 +1,49 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class DailyActivityDto {
+  @ApiProperty({
+    example: '2024-01-15',
+    description: '활동 날짜 (YYYY-MM-DD)',
+  })
+  date: string;
+
+  @ApiProperty({
+    example: 5,
+    description: '해당 날짜의 조회수',
+  })
+  viewCount: number;
+
+  constructor(partial: Partial<DailyActivityDto>) {
+    Object.assign(this, partial);
+  }
+}
+
+export class ActivityReadResponseDto {
+  @ApiProperty({
+    type: [DailyActivityDto],
+    description: '연도별 일별 활동 데이터 배열',
+  })
+  dailyActivities: DailyActivityDto[];
+
+  @ApiProperty({
+    example: 15,
+    description: '사용자의 최장 읽기 스트릭',
+  })
+  maxStreak: number;
+
+  @ApiProperty({
+    example: 7,
+    description: '사용자의 현재 읽기 스트릭',
+  })
+  currentStreak: number;
+
+  @ApiProperty({
+    example: 120,
+    description: '사용자의 총 읽기 횟수',
+  })
+  totalViews: number;
+
+  constructor(partial: Partial<ActivityReadResponseDto>) {
+    Object.assign(this, partial);
+  }
+}

server/src/activity/entity/activity.entity.ts

@@ -21,6 +21,15 @@ export class Activity extends BaseEntity {
     name: 'activity_date',
     type: 'date',
     nullable: false,
+    transformer: {
+      to: (value: Date) => value,
+      from: (value: string | Date) => {
+        if (typeof value === 'string') {
+          return new Date(value);
+        }
+        return value;
+      },
+    },
   })
   activityDate: Date;
 

server/src/activity/module/activity.module.ts

@@ -2,10 +2,11 @@ import { Module } from '@nestjs/common';
 import { ActivityRepository } from '../repository/activity.repository';
 import { ActivityController } from '../controller/activity.controller';
 import { ActivityService } from '../service/activity.service';
+import { UserModule } from '../../user/module/user.module';
 
 @Module({
   controllers: [ActivityController],
-  imports: [],
+  imports: [UserModule],
   providers: [ActivityRepository, ActivityService],
   exports: [ActivityService],
 })

server/src/activity/repository/activity.repository.ts

@@ -1,7 +1,6 @@
 import { DataSource, Repository } from 'typeorm';
 import { Injectable } from '@nestjs/common';
 import { Activity } from '../entity/activity.entity';
-import { User } from '../../user/entity/user.entity';
 
 @Injectable()
 export class ActivityRepository extends Repository<Activity> {
@@ -19,4 +18,20 @@ export class ActivityRepository extends Repository<Activity> {
       [userId],
     );
   }
+
+  async findActivitiesByUserIdAndYear(
+    userId: number,
+    year: number,
+  ): Promise<Activity[]> {
+    const startDate = `${year}-01-01`;
+    const endDate = `${year}-12-31`;
+
+    return this.createQueryBuilder('activity')
+      .leftJoinAndSelect('activity.user', 'user')
+      .where('user.id = :userId', { userId })
+      .andWhere('activity.activityDate >= :startDate', { startDate })
+      .andWhere('activity.activityDate <= :endDate', { endDate })
+      .orderBy('activity.activityDate', 'ASC')
+      .getMany();
+  }
 }

server/src/activity/service/activity.service.ts

@@ -1,20 +1,44 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, NotFoundException } from '@nestjs/common';
 import { ActivityRepository } from '../repository/activity.repository';
-import { User } from '../../user/entity/user.entity';
+import { UserRepository } from '../../user/repository/user.repository';
+import {
+  ActivityReadResponseDto,
+  DailyActivityDto,
+} from '../dto/response/activity-read.dto';
 
 @Injectable()
 export class ActivityService {
-  constructor(private readonly activityRepository: ActivityRepository) {}
+  constructor(
+    private readonly activityRepository: ActivityRepository,
+    private readonly userRepository: UserRepository,
+  ) {}
 
-  async readActivities(userId: number, year: number) {
-    // TODO: 연도별 활동 데이터 전체 조회
-    // 1. 연도별 활동 데이터 전체 반환 (일, 활동수 쌍)
+  async readActivities(
+    userId: number,
+    year: number,
+  ): Promise<ActivityReadResponseDto> {
+    const user = await this.userRepository.findOneBy({ id: userId });
+    if (!user) {
+      throw new NotFoundException('존재하지 않는 사용자입니다.');
+    }
 
-    // + metric 수집 및 반환 (User Entity에 존재함.)
-    // 1. 최장 읽기 스트릭
-    // 2. 현재 읽기 스트릭
-    // 3. 총 읽은 횟수
-    return 'foo';
+    const activities =
+      await this.activityRepository.findActivitiesByUserIdAndYear(userId, year);
+
+    const dailyActivities = activities.map(
+      (activity) =>
+        new DailyActivityDto({
+          date: activity.activityDate.toISOString().split('T')[0],
+          viewCount: activity.viewCount,
+        }),
+    );
+
+    return new ActivityReadResponseDto({
+      dailyActivities,
+      maxStreak: user.maxStreak,
+      currentStreak: user.currentStreak,
+      totalViews: user.totalViews,
+    });
   }
 
   async upsertActivity(userId: number) {

server/src/feed/interceptor/read-feed.interceptor.ts

@@ -66,7 +66,6 @@ export class ReadFeedInterceptor implements NestInterceptor {
     );
 
     if (!hasUserFlag) {
-      console.log(user.id + 'user id 발견요');
       await this.redisService.sadd(`feed:${feedId}:userId`, user.id);
       this.userService.updateUserActivity(user.id);
       await this.activityService.upsertActivity(user.id);