[SWEP-60] 날짜별 태그 검색 API, 태그로 이미지 검색 API 기능 구현과 여러 설정

.github/workflows/deploy-main.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "20"
+          node-version: '20'
 
       - name: Install dependencies
         run: |
@@ -35,6 +35,7 @@ jobs:
       - name: Generate Swagger document
         run: |
           yarn tsx ./swagger/swagger.js
+          yarn tsoa spec -c ./config/tsoa.json
 
       - name: Run build
         run: |
@@ -70,6 +71,9 @@ jobs:
           ssh sweepic-ec2 'sudo mkdir -p /opt/app'
           ssh sweepic-ec2 'sudo chown ubuntu:ubuntu /opt/app'
           scp -r ./dist sweepic-ec2:/opt/app
+          ssh sweepic-ec2 'sudo echo "$SWEEPIC_AI" > /opt/app/sweepicai-00d515e813ea.json'
+        env:
+          SWEEPIC_AI: ${{secrets.SWEEPIC_AI}}
 
       # 원격 서버에서 애플리케이션을 Systemd 서비스로 등록하는 과정
       - name: Copy systemd service file
@@ -83,6 +87,7 @@ jobs:
               User=${USER}
               WorkingDirectory=/opt/app
               ExecStart=/usr/bin/node dist/app.cjs
+              ExecStart=/usr/bin/node dist/app.cjs
               Restart=always
 
               [Install]

config/tsoa.json

@@ -0,0 +1,24 @@
+{
+  "noImplicitAdditionalProperties": "throw-on-extras",
+  "entryFile": "src/app.ts",
+  "controllerPathGlobs": ["src/controllers/*.controller.ts"],
+  "spec": {
+    "outputDirectory": "./swagger",
+    "host": "3.37.137.212:3000",
+    "specVersion": 3,
+    "spec": {
+      "servers": [
+        {
+          "url": "http://3.37.137.212:3000",
+          "description": "Sweepic server"
+        }
+      ]
+    }
+  },
+  "routes": {
+    "routesDir": "./src/routers",
+    "middleware": "express",
+    "routesFileName": "tsoaRoutes.ts",
+    "esm": true
+  }
+}

package.json

@@ -15,7 +15,10 @@
     "fix": "gts fix",
     "prepare": "yarn run compile",
     "pretest": "yarn run compile",
-    "posttest": "yarn run lint"
+    "posttest": "yarn run lint",
+    "swagger": "tsx swagger/swagger.ts",
+    "tsoa-swagger": "tsoa spec -c ./config/tsoa.json",
+    "tsoa-routes": "tsoa routes -c ./config/tsoa.json"
   },
   "author": "",
   "license": "ISC",
@@ -25,6 +28,7 @@
     "@google-cloud/vision": "^4.3.2",
     "@prisma/client": "^6.1.0",
     "@quixo3/prisma-session-store": "^3.1.13",
+    "@tsoa/runtime": "^6.6.0",
     "coordinate-parser": "^1.0.7",
     "cors": "^2.8.5",
     "dotenv": "^16.4.7",
@@ -50,24 +54,24 @@
     "@types/cors": "^2.8.17",
     "@types/express": "^5.0.0",
     "@types/express-session": "^1.18.1",
+    "@types/multer": "^1.4.12",
+    "@types/multer-s3": "^3.0.3",
     "@types/node": "^22.10.3",
     "@types/passport": "^1.0.17",
     "@types/passport-google-oauth20": "^2.0.16",
-    "@types/swagger-ui-express": "^4.1.7",
-    "@typescript-eslint/eslint-plugin": "^8.19.1",
-    "@typescript-eslint/parser": "^8.19.1",
-    "@types/multer": "^1.4.12",
-    "@types/multer-s3": "^3.0.3",
     "@types/passport-kakao": "^1.0.3",
     "@types/passport-naver": "^1.0.4",
     "@types/swagger-jsdoc": "^6.0.4",
+    "@types/swagger-ui-express": "^4.1.7",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1",
     "esbuild": "^0.24.2",
     "esbuild-plugin-copy": "^2.1.1",
     "eslint": "^9.17.0",
     "gts": "^6.0.2",
     "nodemon": "^3.1.9",
+    "tsoa": "^6.6.0",
     "tsx": "^4.19.2",
-    "typescript": "^5.6.3",
-    "tsoa": "^6.6.0"
+    "typescript": "^5.6.3"
   }
 }

scripts/build.ts

@@ -10,7 +10,7 @@ async function build() {
     outExtension: {'.js': '.cjs'},
     platform: 'node',
     target: 'node20',
-    minify: true,
+    minify: false,
     keepNames: true,
     plugins: [
       copy({

src/app.ts

@@ -6,18 +6,20 @@ import express, {
   NextFunction,
   ErrorRequestHandler,
 } from 'express';
-import swaggerAutogen from 'swagger-autogen';
 import swaggerUiExpress from 'swagger-ui-express';
 import {memoFolderRouter} from './routers/memo.router.js';
+import {RegisterRoutes} from './routers/tsoaRoutes.js';
 import {challengeRouter} from './routers/challenge.router.js';
 import {authRouter} from './routers/auth.routers.js';
 
 import passport from 'passport';
 import session from 'express-session';
 import {PrismaSessionStore} from '@quixo3/prisma-session-store';
 import {prisma} from './db.config.js';
+import swaggerDocumentOne from '../swagger/openapi.json' assert {type: 'json'};
+import swaggerDocumentTwo from '../swagger/swagger.json' assert {type: 'json'};
 import {BaseError} from './errors.js';
-import swaggerDocument from '../swagger/openapi.json' assert {type: 'json'};
+import {ValidateError} from 'tsoa';
 
 dotenv.config();
 
@@ -32,9 +34,15 @@ app.use(express.urlencoded({extended: false}));
 
 // Swagger Docs
 app.use(
-  '/docs',
-  swaggerUiExpress.serve,
-  swaggerUiExpress.setup(swaggerDocument),
+  '/docs/v1',
+  swaggerUiExpress.serveFiles(swaggerDocumentOne),
+  swaggerUiExpress.setup(swaggerDocumentOne),
+);
+
+app.use(
+  '/docs/v2',
+  swaggerUiExpress.serveFiles(swaggerDocumentTwo),
+  swaggerUiExpress.setup(swaggerDocumentTwo),
 );
 
 // Response customization middleware
@@ -85,10 +93,11 @@ app.use(
 
 app.use(passport.initialize());
 app.use(passport.session());
-
 app.use('/oauth2', authRouter);
+
 app.use('/memo', memoFolderRouter);
 app.use('/challenge', challengeRouter);
+RegisterRoutes(app);
 
 app.get('/', (req: Request, res: Response) => {
   res.send('Sweepic');
@@ -113,6 +122,18 @@ const errorHandler: ErrorRequestHandler = (err, req, res, next) => {
     return;
   }
 
+  if (err instanceof ValidateError) {
+    res.status(err.status).json({
+      resultType: 'FAIL',
+      error: {
+        errorCode: 'VAL-001',
+        reason: 'Validation Error',
+        data: err.fields,
+      },
+      success: null,
+    });
+  }
+
   console.error('Unexpected error:', err);
   res.status(500).json({
     resultType: 'FAIL',

src/controllers/tsoaImage.controller.ts

@@ -0,0 +1,39 @@
+import {
+  Body,
+  Controller,
+  Get,
+  Path,
+  Post,
+  Query,
+  Res,
+  Route,
+  SuccessResponse,
+  Tags,
+  TsoaResponse,
+} from 'tsoa';
+import {RequestTagSearch} from '../dtos/tsoaImage.dto.js';
+import {findImagesFromTag} from '../services/tsoaImage.service.js';
+import {BaseError, ServerError} from '../errors.js';
+import {Response} from '../models/tsoaResponse.js';
+
+@Route('images')
+export class ImagesController extends Controller {
+  @Get('/users/{userId}')
+  @Tags('Image')
+  @SuccessResponse('200', 'OK')
+  public async getImageListFromTag(
+    @Path() userId: string,
+    @Query() tag: string,
+  ): Promise<Response> {
+    const dto = new RequestTagSearch(tag, userId);
+    const images = await findImagesFromTag(dto).catch(err => {
+      if (err instanceof BaseError) {
+        throw err;
+      } else {
+        throw new ServerError();
+      }
+    });
+
+    return new Response(images);
+  }
+}

src/controllers/tsoaTag.controller.ts

@@ -0,0 +1,45 @@
+import {
+  Body,
+  Controller,
+  Get,
+  Path,
+  Post,
+  Query,
+  Res,
+  Route,
+  SuccessResponse,
+  TsoaResponse,
+  Tags,
+} from 'tsoa';
+import {findTagsByDate} from '../services/tsoaTag.service.js';
+import {DateToTags} from '../dtos/tsoaTag.dto.js';
+import {BaseError, ServerError, TagBadRequest} from '../errors.js';
+import {Response} from '../models/tsoaResponse.js';
+
+@Route('tags')
+export class TagsController extends Controller {
+  @Get('/users/{userId}')
+  @Tags('Tag')
+  @SuccessResponse('200', 'OK')
+  public async getTagListWithDate(
+    @Path() userId: string,
+    @Query() year: number,
+    @Query() month: number,
+    @Query() date?: number,
+  ): Promise<Response> {
+    const dto = new DateToTags(userId, year, month, date);
+    const tags = await findTagsByDate(dto)
+      .then(result => {
+        return {tags: result};
+      })
+      .catch(err => {
+        if (!(err instanceof BaseError)) {
+          throw new ServerError();
+        } else {
+          throw err;
+        }
+      });
+
+    return new Response(tags);
+  }
+}

src/dtos/tsoaImage.dto.ts

@@ -0,0 +1,9 @@
+export class RequestTagSearch {
+  tag: string;
+  userId: bigint;
+
+  constructor(tag: string, userId: string) {
+    this.tag = tag;
+    this.userId = BigInt(userId);
+  }
+}

src/dtos/tsoaTag.dto.ts

@@ -0,0 +1,14 @@
+export class DateToTags {
+  createdAt: Date;
+  userId: bigint;
+  dateExisted: boolean = true;
+
+  constructor(userId: string, year: number, month: number, date?: number) {
+    if (!date) {
+      date = 1;
+      this.dateExisted = false;
+    }
+    this.createdAt = new Date(Date.UTC(year, month - 1, date));
+    this.userId = BigInt(userId);
+  }
+}

src/errors.ts

@@ -1,3 +1,5 @@
+import {extname} from 'path';
+
 export type ErrorDetails =
   | {folderId?: bigint; userId?: bigint; folderName?: string}
   | {imageId?: bigint; imageUrl?: string}
@@ -122,3 +124,29 @@ export class PhotoDataNotFoundError extends BaseError {
     super(404, 'PHO-404', '사진 데이터가 없습니다.', details);
   }
 }
+
+// 태그 데이터 관련 에러(TAG)
+export class TagNotFound extends BaseError {
+  constructor() {
+    super(404, 'TAG-001', '태그가 없습니다.');
+  }
+}
+
+export class TagBadRequest extends BaseError {
+  constructor() {
+    super(400, 'TAG-002', '잘못된 요청입니다.');
+  }
+}
+
+// 공용 에러
+export class DBError extends BaseError {
+  constructor(details?: ErrorDetails) {
+    super(500, 'DB-001', 'DB 에러입니다.', details);
+  }
+}
+
+export class ServerError extends BaseError {
+  constructor(details?: ErrorDetails) {
+    super(500, 'SER-001', '내부 서버 오류입니다.', details);
+  }
+}

src/models/tsoaResponse.ts

@@ -0,0 +1,9 @@
+export class Response {
+  resultType: string = 'SUCCESS';
+  error = null;
+  success: {data: any};
+
+  constructor(data: any) {
+    this.success = {data};
+  }
+}

src/models/tsoaTag.model.ts

@@ -0,0 +1,3 @@
+export interface ResponseFromTags {
+  tags: string[];
+}

src/repositories/tsoaImage.repository.ts

@@ -0,0 +1,36 @@
+import {Image} from '@prisma/client';
+import {prisma} from '../db.config.js';
+import {DBError} from '../errors.js';
+
+export const selectImagesFromTag = async (
+  tag: string,
+  userId: bigint,
+): Promise<Pick<Image, 'id' | 'mediaId'>[]> => {
+  const images = await prisma.image
+    .findMany({
+      where: {
+        AND: [
+          {
+            tags: {
+              some: {
+                tag: {
+                  content: tag,
+                },
+              },
+            },
+          },
+          {
+            userId: userId,
+          },
+        ],
+      },
+      select: {
+        id: true,
+        mediaId: true,
+      },
+    })
+    .catch(() => {
+      throw new DBError();
+    });
+  return images;
+};