3주차 Backend API 구현

.github/workflows/server_jest.yml

@@ -0,0 +1,66 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Server Jest
+
+on:
+  push:
+    branches: [ "main", "dev","dev-be" ]
+    paths: 'server/**'
+  pull_request:
+    branches: [ "main", "dev","dev-be" ]
+    paths: 'server/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # 해당 저장소의 코드를 가져옵니다.
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      # Node 18 버전을 사용합니다.
+      - name: Install node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      # yarn을 설치합니다.
+      - name: Install Yarn
+        run: npm install yarn
+
+      # 설치된 yarn을 통해 패키지를 설치합니다.
+      - name: Install dependencies
+        run: yarn install
+
+      # 테스트 수행과 그 테스트 결과를 xml파일로 생성합니다.
+      - name: Run tests
+        run: yarn server-test | tee ./coverage.txt
+
+      # 테스트 결과를 담은 xml 파일을 레포트로 변환합니다.
+      - name: Test Report
+        uses: dorny/test-reporter@v1
+        if: success() || failure()    # run this step even if previous step failed
+        with:
+          name: test-results
+          path: server/junit.xml
+          fail-on-error: 'false'
+          reporter: jest-junit        # Format of test results
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Jest Coverage Comment
+        uses: MishaKav/jest-coverage-comment@main
+        with:
+          coverage-path: ./coverage.txt
+          coverage-summary-path: ./server/coverage/coverage-final.json
+          junitxml-path: ./server/junit.xml
+      - name: build 실패 시 Slack 알림
+        uses: 8398a7/action-slack@v3
+        with:
+          status: ${{ job.status }}
+          author_name: 백엔드 빌드 실패 알림
+          fields: repo, message, commit, author, action, eventName, ref, workflow, job, took
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_FAIL_WEBHOOK_URL }}
+        if: failure()

server/__mock__/community.mock.ts

@@ -0,0 +1,8 @@
+import { CreateCommunityDto } from '@api/src/community/dto/create-community.dto';
+
+export const communityDto1 = {
+  name: 'asnity commu',
+  managerId: '63734af9e62b37012c73e399',
+  description: 'test description',
+  profileUrl: 'test profileUrl',
+} as CreateCommunityDto;

server/apps/api/src/api.module.ts

@@ -9,9 +9,6 @@ import { UserModule } from './user/user.module';
 import * as winston from 'winston';
 import { utilities as nestWinstonModuleUtilities, WinstonModule } from 'nest-winston';
 import { AuthModule } from './auth/auth.module';
-import { APP_INTERCEPTOR } from '@nestjs/core';
-import { SentryInterceptor } from '../../webhook.interceptor';
-import { RavenInterceptor, RavenModule } from 'nest-raven';
 
 @Module({
   imports: [

server/apps/api/src/auth/dto/index.ts

@@ -1 +1,2 @@
-export * from './auth.dto';
+export * from './sign-in.dto';
+export * from './sign-up.dto';

server/apps/api/src/auth/dto/sign-in.dto.ts

@@ -0,0 +1,11 @@
+import { IsEmail, IsNotEmpty, IsString, MinLength } from 'class-validator';
+
+export class SignInDto {
+  @IsEmail()
+  @IsNotEmpty()
+  id: string;
+
+  @IsString()
+  @MinLength(8)
+  password: string;
+}

server/apps/api/src/auth/dto/auth.dto.ts → server/apps/api/src/auth/dto/sign-up.dto.ts

@@ -1,15 +1,5 @@
 import { IsEmail, IsNotEmpty, IsString, Length, MinLength } from 'class-validator';
 
-export class SignInDto {
-  @IsEmail()
-  @IsNotEmpty()
-  id: string;
-
-  @IsString()
-  @MinLength(8)
-  password: string;
-}
-
 export class SignUpDto {
   @IsEmail()
   @IsNotEmpty()

server/apps/api/src/auth/strategy/jwt-access.strategy.ts

@@ -19,6 +19,6 @@ export class JwtAccessStrategy extends PassportStrategy(Strategy, 'jwt-access-to
       throw new ForbiddenException('잘못된 요청입니다.');
     }
     delete user.password;
-    return user;
+    return { ...user, _id: user._id.toString() };
   }
 }

server/apps/api/src/channel/channel.controller.ts

@@ -1,4 +1,27 @@
-import { Controller } from '@nestjs/common';
+import { Body, Controller, Inject, LoggerService, Post, Req, UseGuards } from '@nestjs/common';
+import { ChannelService } from '@api/src/channel/channel.service';
+import { JwtAccessGuard } from '@api/src/auth/guard';
+import { CreateChannelDto } from '@api/src/channel/dto';
+import { responseForm } from '@utils/responseForm';
+import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 
-@Controller('channel')
-export class ChannelController {}
+@Controller('api/channel')
+export class ChannelController {
+  constructor(
+    @Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService,
+    private channelService: ChannelService,
+  ) {}
+
+  @Post()
+  @UseGuards(JwtAccessGuard)
+  async createChannel(@Body() createChannelDto: CreateChannelDto, @Req() req: any) {
+    const _id = req.user._id;
+    try {
+      await this.channelService.createChannel({ ...createChannelDto, managerId: _id });
+      return responseForm(200, { message: '채널 생성 성공!' });
+    } catch (error) {
+      this.logger.error(JSON.stringify(error.response));
+      throw error;
+    }
+  }
+}

server/apps/api/src/channel/channel.module.ts

@@ -1,9 +1,22 @@
 import { Module } from '@nestjs/common';
 import { ChannelController } from './channel.controller';
 import { ChannelService } from './channel.service';
+import { MongooseModule } from '@nestjs/mongoose';
+import { ChannelRepository } from '@repository/channel.repository';
+import { ChannelSchema } from '@schemas/channel.schema';
+import { Channel } from 'diagnostics_channel';
+import { CommunityRepository } from '@repository/community.repository';
+import { CommunityModule } from '@community/community.module';
+import { UserRepository } from '@repository/user.repository';
+import { UserModule } from '@user/user.module';
 
 @Module({
+  imports: [
+    MongooseModule.forFeature([{ name: Channel.name, schema: ChannelSchema }]),
+    CommunityModule,
+    UserModule,
+  ],
   controllers: [ChannelController],
-  providers: [ChannelService]
+  providers: [ChannelService, ChannelRepository, CommunityRepository, UserRepository],
 })
 export class ChannelModule {}

server/apps/api/src/channel/channel.service.ts

@@ -1,4 +1,39 @@
-import { Injectable } from '@nestjs/common';
+import { BadRequestException, Injectable } from '@nestjs/common';
+import { ChannelRepository } from '@repository/channel.repository';
+import { CreateChannelDto } from '@api/src/channel/dto';
+import { CommunityRepository } from '@repository/community.repository';
+import { UserRepository } from '@repository/user.repository';
+import { addChannelToUserForm } from '@utils/addObjectForm';
 
 @Injectable()
-export class ChannelService {}
+export class ChannelService {
+  constructor(
+    private readonly channelRepository: ChannelRepository,
+    private readonly communityRepository: CommunityRepository,
+    private readonly userRepository: UserRepository,
+  ) {}
+
+  async createChannel(createChannelDto: CreateChannelDto) {
+    // 자신이 속한 커뮤니티 찾기
+    try {
+      const community = await this.communityRepository.findById(createChannelDto.communityId);
+
+      // 채널 생성
+      const channel = await this.channelRepository.create({
+        ...createChannelDto,
+        users: [createChannelDto.managerId],
+      });
+
+      // 커뮤니티 목록에 채널 업데이트
+      await this.communityRepository.addArrAtArr({ _id: community.id }, 'channels', [
+        channel._id.toString(),
+      ]);
+
+      // 유저 목록에 자신이 속한 채널 업데이트
+      const newChannel = addChannelToUserForm(community._id, channel._id);
+      await this.userRepository.updateObject({ _id: createChannelDto.managerId }, newChannel);
+    } catch (error) {
+      throw new BadRequestException('채널 생성 중 오류 발생!');
+    }
+  }
+}

server/apps/api/src/channel/dto/create-channel.dto.ts

@@ -0,0 +1,37 @@
+import { IsBoolean, IsNotEmpty, IsOptional, IsString, Length } from 'class-validator';
+import { Transform } from 'class-transformer';
+
+export class CreateChannelDto {
+  @IsString()
+  @IsNotEmpty()
+  communityId: string;
+
+  @IsString()
+  @Length(2, 20)
+  @IsNotEmpty()
+  name: string;
+
+  @IsString()
+  @IsOptional()
+  managerId: string;
+
+  @IsString()
+  @IsOptional()
+  description: string;
+
+  @IsString()
+  @IsOptional()
+  profileUrl: string;
+
+  @IsString()
+  @IsNotEmpty()
+  type: 'Channel' | 'DM';
+
+  @IsBoolean()
+  @IsNotEmpty()
+  @Transform(({ value }) => value === 'true')
+  isPrivate: boolean;
+
+  @IsOptional()
+  users: string[];
+}

server/apps/api/src/channel/dto/index.ts

@@ -0,0 +1 @@
+export * from './create-channel.dto';

server/apps/api/src/community/community.controller.ts

@@ -1,4 +1,104 @@
-import { Controller } from '@nestjs/common';
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  Inject,
+  LoggerService,
+  Param,
+  Patch,
+  Post,
+  Req,
+  UseGuards,
+} from '@nestjs/common';
+import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
+import { CommunityService } from '@api/src/community/community.service';
+import { responseForm } from '@utils/responseForm';
+import { JwtAccessGuard } from '@api/src/auth/guard';
+import {
+  CreateCommunityDto,
+  AppendUsersToCommunityDto,
+  ModifyCommunityDto,
+  DeleteCommunityDto,
+} from './dto';
 
-@Controller('community')
-export class CommunityController {}
+@Controller('api/community')
+export class CommunityController {
+  constructor(
+    @Inject(WINSTON_MODULE_NEST_PROVIDER) private readonly logger: LoggerService,
+    private communityService: CommunityService,
+  ) {}
+
+  @Get()
+  @UseGuards(JwtAccessGuard)
+  async getCommunities(@Req() req: any) {
+    try {
+      const result = await this.communityService.getCommunities(req.user._doc);
+      return responseForm(200, result);
+    } catch (error) {
+      this.logger.error(JSON.stringify(error.response));
+      throw error;
+    }
+  }
+
+  @Post()
+  @UseGuards(JwtAccessGuard)
+  async crateCommunity(@Body() createCommunityDto: CreateCommunityDto, @Req() req: any) {
+    try {
+      const _id = req.user._id;
+      const result = await this.communityService.createCommunity({
+        managerId: _id,
+        ...createCommunityDto,
+      });
+      return responseForm(200, result);
+    } catch (error) {
+      this.logger.error(JSON.stringify(error.response));
+      throw error;
+    }
+  }
+
+  @Post('participants')
+  @UseGuards(JwtAccessGuard)
+  async appendParticipantsToCommunity(
+    @Body() appendUsersToCommunityDto: AppendUsersToCommunityDto,
+    @Req() req: any,
+  ) {
+    try {
+      await this.communityService.appendParticipantsToCommunity(
+        req.user,
+        appendUsersToCommunityDto,
+      );
+      return responseForm(200, { message: '커뮤니티 사용자 추가 완료' });
+    } catch (error) {
+      this.logger.error(JSON.stringify(error.response));
+      throw error;
+    }
+  }
+
+  @Patch('settings')
+  @UseGuards(JwtAccessGuard)
+  async modifyCommunitySetting(@Body() modifyCommunityDto: ModifyCommunityDto, @Req() req: any) {
+    try {
+      const _id = req.user._id;
+      await this.communityService.modifyCommunity({ ...modifyCommunityDto, managerId: _id });
+      return responseForm(200, { message: '커뮤니티 정보 수정 완료' });
+    } catch (error) {
+      this.logger.error(JSON.stringify(error.response));
+      throw error;
+    }
+  }
+
+  @Delete(':_id')
+  @UseGuards(JwtAccessGuard)
+  async deleteCommunity(@Param('_id') community_id: string, @Req() req: any) {
+    try {
+      const managerId = req.user._id;
+      const deleteCommunityDto: DeleteCommunityDto = { managerId, community_id };
+      await this.communityService.deleteCommunity(deleteCommunityDto);
+      return responseForm(200, { message: '커뮤니티 삭제 성공' });
+    } catch (error) {
+      this.logger.error(JSON.stringify(error.response));
+      throw error;
+    }
+  }
+}

server/apps/api/src/community/community.module.ts

@@ -1,9 +1,19 @@
 import { Module } from '@nestjs/common';
 import { CommunityController } from './community.controller';
 import { CommunityService } from './community.service';
+import { MongooseModule } from '@nestjs/mongoose';
+import { Community, CommunitySchema } from '@schemas/community.schema';
+import { CommunityRepository } from '@repository/community.repository';
+import { UserRepository } from '@repository/user.repository';
+import { UserModule } from '@user/user.module';
 
 @Module({
+  imports: [
+    MongooseModule.forFeature([{ name: Community.name, schema: CommunitySchema }]),
+    UserModule,
+  ],
   controllers: [CommunityController],
-  providers: [CommunityService],
+  providers: [CommunityService, CommunityRepository, UserRepository],
+  exports: [MongooseModule],
 })
 export class CommunityModule {}