Merge pull request #435 from boostcampwm-2024/feat/file-upload

✨ feat: 파일업로드 파이프라인 및 API 구현

Author: asn6878

.gitignore

@@ -33,6 +33,9 @@ certificate.crt
 !.vscode/extensions.json
 !.vscode/*.code-snippets
 
+### static files
+**/objects
+
 # Local History for Visual Studio Code
 .history/
 

docker-compose/docker-compose.prod.yml

@@ -21,6 +21,7 @@ services:
         condition: service_healthy
     volumes:
       - ../server/logs:/var/web05-Denamu/server/logs
+      - /var/web05-Denamu/objects:/var/web05-Denamu/objects
     environment:
       NODE_ENV: "PROD"
       TZ: "Asia/Seoul"

nginx.conf

@@ -29,6 +29,12 @@ server {
         try_files $uri $uri/ =404;
     }
 
+    # 파일 업로드 서비스에 의해 관리되는 정적 파일 서빙
+    location /objects {
+        alias /var/denamu_objects/;
+        try_files $uri $uri/ =404;
+    }
+
     # API 요청을 NestJS로 프록시
     location /api {
         proxy_pass http://127.0.0.1:8080;

nginx/nginx.conf

@@ -87,6 +87,12 @@ http {
 			try_files $uri $uri/ =404;
 		}
 
+		# 업로드된 파일 서빙
+		location /objects {
+			alias /var/web05-Denamu/objects/;
+			try_files $uri $uri/ =404;
+		}
+
 		# API 요청을 NestJS로 프록시
 		location /api {
 			proxy_pass http://app:8080;

package-lock.json

@@ -1,6 +1,7 @@
 {
   "devDependencies": {
     "@commitlint/cli": "^19.5.0",
+    "@types/multer": "^1.4.13",
     "artillery": "^2.0.21",
     "commitizen": "^4.3.1",
     "cz-cli": "^1.0.0",

package.json

@@ -0,0 +1,21 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class CreateFile1754122785239 implements MigrationInterface {
+  name = 'CreateFile1754122785239';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE \`file\` (\`id\` int NOT NULL AUTO_INCREMENT, \`original_name\` varchar(255) NOT NULL, \`mimetype\` varchar(255) NOT NULL, \`path\` varchar(255) NOT NULL, \`size\` int NOT NULL, \`created_at\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6), \`user_id\` int NULL, PRIMARY KEY (\`id\`)) ENGINE=InnoDB`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE \`file\` ADD CONSTRAINT \`FK_516f1cf15166fd07b732b4b6ab0\` FOREIGN KEY (\`user_id\`) REFERENCES \`user\`(\`id\`) ON DELETE NO ACTION ON UPDATE NO ACTION`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE \`file\` DROP FOREIGN KEY \`FK_516f1cf15166fd07b732b4b6ab0\``,
+    );
+    await queryRunner.query(`DROP TABLE \`file\``);
+  }
+}

server/src/common/database/migration/1754122785239-CreateFile.ts

@@ -0,0 +1,54 @@
+import { diskStorage } from 'multer';
+import { createDirectoryIfNotExists, getFileName } from './fileUtils';
+import {
+  validateFile,
+  ALLOWED_MIME_TYPES,
+  FILE_SIZE_LIMITS,
+  FileUploadType,
+} from './fileValidator';
+
+export const createDynamicStorage = () => {
+  return {
+    storage: diskStorage({
+      destination: (req: any, file, cb) => {
+        const uploadType: FileUploadType =
+          // TODO: 파일 업로드 타입 추론부 확정나면 변경하기
+          req.body?.uploadType ||
+          req.query?.uploadType ||
+          req.uploadType ||
+          'PROFILE_IMAGE';
+
+        const uploadPath = createDirectoryIfNotExists(uploadType);
+        cb(null, uploadPath);
+      },
+      filename: (req, file, cb) => {
+        cb(null, getFileName(file));
+      },
+    }),
+    fileFilter: (req: any, file: any, cb: any) => {
+      try {
+        const uploadType: FileUploadType =
+          req.body?.uploadType ||
+          req.query?.uploadType ||
+          req.uploadType ||
+          'PROFILE_IMAGE';
+
+        // uploadType에 따른 허용 타입 결정
+        let allowedTypes: string[] = [];
+        if (uploadType === 'PROFILE_IMAGE') {
+          allowedTypes = ALLOWED_MIME_TYPES.IMAGE;
+        } // else if 로 업로드 타입별 허용 MIME TYPE 결정 구문 추가 하기
+
+        validateFile(file, uploadType);
+        cb(null, true);
+      } catch (error) {
+        cb(error, false);
+      }
+    },
+    limits: {
+      fileSize: FILE_SIZE_LIMITS.IMAGE, // 기본적으로 이미지 크기 제한 사용
+    },
+  };
+};
+
+export const storage = createDynamicStorage();

server/src/common/disk/diskStorage.ts

@@ -0,0 +1,36 @@
+import { join } from 'path';
+import { ensureDirSync } from 'fs-extra';
+import { promises as fs } from 'fs';
+import { existsSync } from 'fs';
+import { v4 as uuidv4 } from 'uuid';
+
+// TODO: 테스트 후 기본 경로 제거 하기.
+const BASE_UPLOAD_PATH =
+  process.env.UPLOAD_BASE_PATH || '/var/web05-Denamu/objects';
+
+export const generateFilePath = (originalPath: string): string => {
+  const now = new Date();
+  const folder = `${now.getFullYear()}/${now.getMonth() + 1}/${now.getDate()}`;
+  return join(originalPath, folder);
+};
+
+export const getFileName = (file: any): string => {
+  const ext = file.originalname.split('.').pop()?.toLowerCase() || '';
+  return `${uuidv4()}.${ext}`;
+};
+
+export const createDirectoryIfNotExists = (uploadType: string): string => {
+  const now = new Date();
+  const dateFolder = `${now.getFullYear()}${String(now.getMonth() + 1).padStart(2, '0')}${String(now.getDate()).padStart(2, '0')}`;
+
+  const uploadPath = join(BASE_UPLOAD_PATH, uploadType, dateFolder);
+
+  ensureDirSync(uploadPath);
+  return uploadPath;
+};
+
+export const deleteFileIfExists = async (filePath: string): Promise<void> => {
+  if (existsSync(filePath)) {
+    await fs.unlink(filePath);
+  }
+};

server/src/common/disk/fileUtils.ts

@@ -0,0 +1,56 @@
+import { BadRequestException } from '@nestjs/common';
+
+export const ALLOWED_MIME_TYPES = {
+  IMAGE: ['image/jpeg', 'image/png', 'image/gif', 'image/webp'],
+  ALL: [] as string[],
+};
+
+export const FILE_UPLOAD_TYPE = {
+  PROFILE_IMAGE: 'profileImg',
+} as const;
+
+export type FileUploadType = keyof typeof FILE_UPLOAD_TYPE;
+
+ALLOWED_MIME_TYPES.ALL = [...ALLOWED_MIME_TYPES.IMAGE];
+
+export const FILE_SIZE_LIMITS = {
+  // MB 단위
+  IMAGE: 5 * 1024 * 1024,
+  DEFAULT: 10 * 1024 * 1024,
+};
+
+export const validateFile = (file: any, uploadType: string) => {
+  let allowedTypes: string[] = [];
+  if (uploadType === 'PROFILE_IMAGE') {
+    allowedTypes = ALLOWED_MIME_TYPES.IMAGE;
+  }
+
+  validateFileType(file, allowedTypes);
+  validateFileSize(file, uploadType);
+};
+
+const validateFileType = (file: any, allowedTypes?: string[]) => {
+  const types = allowedTypes || [];
+
+  if (!types.includes(file.mimetype)) {
+    throw new BadRequestException(
+      `지원하지 않는 파일 형식입니다. 지원 형식: ${types.join(', ')}`,
+    );
+  }
+};
+
+const validateFileSize = (file: any, uploadType: string) => {
+  let sizeLimit: number;
+
+  if (uploadType === 'PROFILE_IMAGE') {
+    sizeLimit = FILE_SIZE_LIMITS.IMAGE;
+  } else {
+    sizeLimit = FILE_SIZE_LIMITS.DEFAULT;
+  }
+
+  if (file.size > sizeLimit) {
+    throw new BadRequestException(
+      `파일 크기가 너무 큽니다. 최대 ${Math.round(sizeLimit / 1024 / 1024)}MB까지 허용됩니다.`,
+    );
+  }
+};