Merge pull request #299 from boostcampwm2023/release-1.0.0

Author: YuHyun-P

.github/workflows/backend-deploy.yml

@@ -74,5 +74,12 @@ jobs:
               -e CONTAINER_SSH_PORT=${{ secrets.CONTAINER_SSH_PORT }} \
               -e CONTAINER_SSH_USERNAME=${{ secrets.CONTAINER_SSH_USERNAME }} \
               -e CONTAINER_SSH_PASSWORD=${{ secrets.CONTAINER_SSH_PASSWORD }} \
+              -e CONTAINER_GIT_USERNAME=${{ secrets.CONTAINER_GIT_USERNAME }} \
               -e MONGODB_HOST=${{ secrets.MONGODB_HOST }} \
+              -e SECRET_KEY=${{ secrets.SECRET_KEY }} \
+              -e X_NCP_CLOVASTUDIO_API_KEY=${{ secrets.X_NCP_CLOVASTUDIO_API_KEY }} \
+              -e X_NCP_APIGW_API_KEY=${{ secrets.X_NCP_APIGW_API_KEY }} \
+              -e X_NCP_CLOVASTUDIO_REQUEST_ID=${{ secrets.X_NCP_CLOVASTUDIO_REQUEST_ID }} \
+              -e CONTAINER_SERVER_HOST=${{ secrets.CONTAINER_SERVER_HOST }} \
+              -e CONTAINER_POOL_MAX=${{ secrets.CONTAINER_POOL_MAX }} \
               ${{ secrets.DOCKERHUB_USERNAME }}/git-challenge-backend:0.1

.github/workflows/frontend-deploy.yml

@@ -3,7 +3,7 @@ name: "frontend-docker-build"
 on:
   push:
     branches: [ "dev-fe" ]
-    
+
 jobs:
   build:
     name: Build and Test
@@ -25,7 +25,7 @@ jobs:
         run: yarn install
 
       - name: Build
-        run: | 
+        run: |
           cd packages/frontend
           yarn build
 
@@ -53,6 +53,8 @@ jobs:
           file: ./packages/frontend/Dockerfile
           push: true
           tags: ${{ secrets.DOCKERHUB_USERNAME }}/git-challenge-frontend:0.1
+          build-args: |
+            NEXT_PUBLIC_BASE_URL=${{ secrets.NEXT_PUBLIC_BASE_URL }}
 
   deploy:
     name: Deploy Frontend

packages/backend/git-challenge-quiz.csv

@@ -33,17 +33,22 @@
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/swagger": "^7.1.16",
     "@nestjs/typeorm": "^10.0.1",
+    "axios": "^1.6.2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "cookie-parser": "^1.4.6",
+    "dotenv": "^16.3.1",
+    "jest": "^29.7.0",
     "mongoose": "^8.0.1",
     "nest-winston": "^1.9.4",
     "papaparse": "^5.4.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",
+    "shell-escape": "^0.2.0",
     "sqlite3": "^5.1.6",
     "ssh2": "^1.14.0",
     "typeorm": "^0.3.17",
+    "uuid": "^9.0.1",
     "winston": "^3.11.0",
     "winston-daily-rotate-file": "^4.7.1"
   },
@@ -56,14 +61,15 @@
     "@types/jest": "^29.5.2",
     "@types/node": "^20.3.1",
     "@types/papaparse": "^5",
+    "@types/shell-escape": "^0.2.3",
     "@types/ssh2": "^1",
     "@types/supertest": "^2.0.12",
+    "@types/uuid": "^9",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
     "eslint": "^8.53.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "jest": "^29.5.0",
     "lint-staged": "^15.1.0",
     "prettier": "^3.1.0",
     "source-map-support": "^0.5.21",
@@ -89,6 +95,10 @@
       "**/*.(t|j)s"
     ],
     "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "testTimeout": 20000,
+    "globals": {
+      "NODE_ENV": "test"
+    }
   }
 }

packages/backend/package.json

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AiController } from './ai.controller';
+
+describe('AiController', () => {
+  let controller: AiController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [AiController],
+    }).compile();
+
+    controller = module.get<AiController>(AiController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

packages/backend/src/ai/ai.controller.spec.ts

@@ -0,0 +1,19 @@
+import { Body, Controller, Post } from '@nestjs/common';
+import { AiRequestDto, AiResponseDto } from './dto/ai.dto';
+import { AiService } from './ai.service';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
+
+@Controller('api/v1/ai')
+export class AiController {
+  constructor(private readonly aiService: AiService) {}
+  @Post()
+  @ApiOperation({ summary: 'AI 답변을 받아옵니다.' })
+  @ApiResponse({
+    status: 200,
+    description: 'AI 답변을 받아옵니다.',
+    type: AiResponseDto,
+  })
+  async ai(@Body() aiDto: AiRequestDto): Promise<AiResponseDto> {
+    return await this.aiService.getApiResponse(aiDto.message);
+  }
+}

packages/backend/src/ai/ai.controller.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { AiController } from './ai.controller';
+import { AiService } from './ai.service';
+
+@Module({
+  controllers: [AiController],
+  providers: [AiService],
+})
+export class AiModule {}

packages/backend/src/ai/ai.module.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AiService } from './ai.service';
+
+describe('AiService', () => {
+  let service: AiService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [AiService],
+    }).compile();
+
+    service = module.get<AiService>(AiService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

packages/backend/src/ai/ai.service.spec.ts

@@ -0,0 +1,67 @@
+import { Inject, Injectable } from '@nestjs/common';
+import axios from 'axios';
+import { ConfigService } from '@nestjs/config';
+import { AiResponseDto } from './dto/ai.dto';
+import { Logger } from 'winston';
+import { preview } from '../common/util';
+
+@Injectable()
+export class AiService {
+  private readonly headers = {
+    'Content-Type': 'application/json',
+    Accept: 'application/json',
+  };
+  private readonly instance = axios.create({
+    baseURL:
+      'https://clovastudio.stream.ntruss.com/testapp/v1/chat-completions/HCX-002',
+    timeout: 50000,
+    headers: this.headers,
+  });
+
+  constructor(
+    private configService: ConfigService,
+    @Inject('winston') private readonly logger: Logger,
+  ) {
+    this.instance.interceptors.request.use((config) => {
+      config.headers['X-NCP-CLOVASTUDIO-API-KEY'] = this.configService.get(
+        'X_NCP_CLOVASTUDIO_API_KEY',
+      );
+      config.headers['X-NCP-APIGW-API-KEY'] = this.configService.get(
+        'X_NCP_APIGW_API_KEY',
+      );
+      config.headers['X-NCP-CLOVASTUDIO-REQUEST-ID'] = this.configService.get(
+        'X_NCP_CLOVASTUDIO_REQUEST_ID',
+      );
+      return config;
+    });
+  }
+  async getApiResponse(message: string): Promise<AiResponseDto> {
+    const response = await this.instance.post('/', {
+      messages: [
+        {
+          role: 'system',
+          content:
+            '- Git 전문가입니다.\\n- Git에 대한 질문만 대답합니다.\\n- Git 사용이 낯선 사람들에게 질문을 받습니다.\\n- Git 설치는 이미 마쳤습니다.\\n- 설명은 이해하기 쉽게 명료하고 간단하게 명령어 위주로 대답합니다.\\n- 질문한 것만 대답합니다.\\n- Git 명령어로만 해답을 제시합니다.\\n- 예를 들어 설명하지 않는다.',
+        },
+        {
+          role: 'user',
+          content: message,
+        },
+      ],
+      topP: 0.8,
+      topK: 0,
+      maxTokens: 512,
+      temperature: 0.3,
+      repeatPenalty: 5.0,
+      stopBefore: [],
+      includeAiFilters: true,
+    });
+
+    this.logger.log(
+      'info',
+      `AI response: ${preview(response.data.result.message.content)}`,
+    );
+
+    return { message: response.data.result.message.content };
+  }
+}

packages/backend/src/ai/ai.service.ts

@@ -0,0 +1,18 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class AiRequestDto {
+  @ApiProperty({
+    description: '질문할 내용',
+    example: 'git이 뭐야?',
+  })
+  message: string;
+}
+
+export class AiResponseDto {
+  @ApiProperty({
+    description: '답변 내용',
+    example:
+      'Git은 분산 버전 관리 시스템(Distributed Version Control System)으로, 소스 코드의 버전을 관리하고 협업을 지원하는 도구입니다. Git은 다음과 같은 특징을 가지고 있습니다.\\n\\n1. **분산 저장소**: Git은 중앙 집중식 저장소가 아닌 분산 저장소를 사용합니다. 각 사용자는 자신의 컴퓨터에 저장소를 가지고 있으며, 이를 로컬 저장소라고 합니다.\\n2. **빠른 속도**: Git은 빠른 속도로 파일을 처리할 수 있습니다. 이는 Git이 데이터를 압축하여 저장하고, 해시 함수를 이용하여 파일을 빠르게 검색하기 때문입니다.\\n3. **버전 관리**: Git은 소스 코드의 버전을 관리합니다. 사용자는 파일을 수정하고 커밋(commit)하면, 해당 파일의 이전 버전과 이후 버전을 모두 저장할 수 있습니다.\\n4. **협업 지원**: Git은 협업을 지원합니다. 사용자는 다른 사용자와 함께 작업을 할 수 있으며, 서로의 작업 내용을 공유할 수 있습니다.\\n5. **명령어 기반**: Git은 명령어 기반으로 동작합니다. 사용자는 Git 명령어를 입력하여 저장소를 관리하고, 파일을 수정할 수 있습니다.\\n\\nGit은 다양한 프로그래밍 언어와 운영체제에서 사용할 수 있으며, 많은 개발자들이 Git을 이용하여 소스 코드를 관리하고 있습니다.',
+  })
+  message: string;
+}

packages/backend/src/ai/dto/ai.dto.ts

@@ -10,6 +10,9 @@ import { format } from 'winston';
 import { typeOrmConfig } from './configs/typeorm.config';
 import { QuizzesModule } from './quizzes/quizzes.module';
 import { LoggingInterceptor } from './common/logging.interceptor';
+import { QuizWizardModule } from './quiz-wizard/quiz-wizard.module';
+import { AiModule } from './ai/ai.module';
+import { CommandModule } from './command/command.module';
 
 @Module({
   imports: [
@@ -38,6 +41,9 @@ import { LoggingInterceptor } from './common/logging.interceptor';
         ),
       ),
     }),
+    QuizWizardModule,
+    AiModule,
+    CommandModule,
   ],
   controllers: [AppController],
   providers: [

packages/backend/src/app.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+import { CommandService } from './command.service';
+
+@Module({
+  providers: [CommandService],
+  exports: [CommandService],
+})
+export class CommandModule {}

packages/backend/src/command/command.module.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { CommandService } from './command.service';
+
+describe('CommandService', () => {
+  let service: CommandService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [CommandService],
+    }).compile();
+
+    service = module.get<CommandService>(CommandService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

packages/backend/src/command/command.service.spec.ts

@@ -0,0 +1,50 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import axios from 'axios';
+import { Logger } from 'winston';
+import { preview, processCarriageReturns } from '../common/util';
+
+@Injectable()
+export class CommandService {
+  private readonly host: string;
+  private readonly instance;
+  constructor(
+    private readonly configService: ConfigService,
+    @Inject('winston') private readonly logger: Logger,
+  ) {
+    this.host = this.configService.get<string>('CONTAINER_SERVER_HOST');
+    this.instance = axios.create({
+      baseURL: this.host,
+      timeout: 10000,
+    });
+  }
+
+  async executeCommand(
+    ...commands: string[]
+  ): Promise<{ stdoutData: string; stderrData: string }> {
+    try {
+      const command = commands.join('; ');
+      this.logger.log('info', `command: ${preview(command, 40)}`);
+      const response = await this.instance.post('/', { command });
+      return {
+        stdoutData: processCarriageReturns(response.data.stdoutData),
+        stderrData: processCarriageReturns(response.data.stderrData),
+      };
+    } catch (error) {
+      this.logger.log('info', error);
+    }
+  }
+
+  async executeCron(
+    ...commands: string[]
+  ): Promise<{ stdoutData: string; stderrData: string }> {
+    try {
+      const command = commands.join('; ');
+      this.logger.log('info', `command: ${preview(command, 40)}`);
+      const response = await this.instance.post('/cron', { command });
+      return response.data;
+    } catch (error) {
+      this.logger.log('info', error);
+    }
+  }
+}

packages/backend/src/command/command.service.ts

@@ -0,0 +1,42 @@
+import {
+  CanActivate,
+  ExecutionContext,
+  ForbiddenException,
+  Injectable,
+} from '@nestjs/common';
+
+@Injectable()
+export class CommandGuard implements CanActivate {
+  canActivate(context: ExecutionContext): boolean {
+    const request = context.switchToHttp().getRequest<Request>();
+    const mode = request.body['mode'];
+    const message = request.body['message'];
+    if (
+      !(
+        typeof mode === 'string' &&
+        typeof message === 'string' &&
+        (mode === 'editor' ||
+          (mode === 'command' &&
+            message.startsWith('git') &&
+            !this.isMessageIncluded(message, [
+              ';',
+              '>',
+              '|',
+              '<',
+              '&',
+              '$',
+              '(',
+              ')',
+              '{',
+              '}',
+            ])))
+      )
+    ) {
+      throw new ForbiddenException('금지된 명령입니다');
+    }
+    return true;
+  }
+  private isMessageIncluded(message: string, keywords: string[]): boolean {
+    return keywords.some((keyword) => message.includes(keyword));
+  }
+}