fix!: 로그 저장 경로를 backend/logs로 원복 (#629)

* chore: 자동 백업을 cron 으로 진행하기 위한 환경변수 추가 (#606)

서버에서 매일 백업하고 진행 결과를 admin 유저에게 슬랙 알림으로 보내주기 위함

* fix: 로그 저장 경로를 `backend/logs`로 원복

* refactor: 타입만 import

* refactor: config에서 `logFormatOption`만 내보내기

* fix: log 마운트 경로를 새 workdir에 맞춰 수정

---------

Co-authored-by: Ji-Hyuck, Min <45284810+jhMin95@users.noreply.github.com>

.github/workflows/main.yml

@@ -51,6 +51,9 @@ jobs:
           MYSQL_DATABASE=${{ secrets.MYSQL_DATABASE }}
           MYSQL_USER=${{ secrets.MYSQL_USER }}
           MYSQL_PASSWORD=${{ secrets.MYSQL_PASSWORD }}
+          BACKUP_USER=${{ secrets.BACKUP_USER}}
+          BACKUP_PASSWORD=${{ secrets.BACKUP_PASSWORD }}
+          ADMIN_SLACK_ID=${{ secrets.ADMIN_SLACK_ID }}
           DB_SCHEMA=${{ secrets.DB_SCHEMA }}
           MODE=${{ secrets.MODE }}
           NODE_ENV=${{ secrets.NODE_ENV }}

backend/src/app.ts

@@ -6,11 +6,11 @@ import swaggerJsdoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
 import jipDataSource from '~/app-data-source';
 import { connectMode } from '~/config';
+import { logger, morganMiddleware } from '~/logger';
 import { FtAuthentication, FtStrategy, JwtStrategy } from '~/v1/auth/auth.strategy';
 import swaggerOptions from '~/v1/swagger/swagger';
 import errorConverter from '~/v1/utils/error/errorConverter';
 import errorHandler from '~/v1/utils/error/errorHandler';
-import { logger, morganMiddleware } from '~/v1/utils/logger';
 
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { contract } from '@jiphyeonjeon-42/contracts';

backend/src/config/index.ts

@@ -9,6 +9,8 @@ import { getOauth42ApiOption, getOauthUrlOption } from './oauthOption';
 import { getRuntimeMode } from './runtimeOption';
 import { getSlackbotOAuthToken } from './slackbotOAuthTokenOption';
 
+export * as logFormatOption from './logOption';
+
 // .env 파일을 읽어서 process.env에 추가
 dotenv.config();
 

backend/src/config/logOption.ts

@@ -1,4 +1,4 @@
-import { LogLevel, LogLevelOption } from './config.type';
+import type { LogLevel, LogLevelOption } from './config.type';
 import { RuntimeMode } from './runtimeOption';
 
 export const levels = {

backend/src/v1/utils/logger.ts → backend/src/logger.ts

@@ -7,19 +7,17 @@ import {
   transports,
 } from 'winston';
 import WinstonDaily from 'winston-daily-rotate-file';
-import { logLevelOption } from '~/config';
-import {
-  colors,
-  levels,
-} from '~/config/logOption';
+import { logFormatOption, logLevelOption } from '~/config';
+
+const { colors, levels } = logFormatOption;
 
 const {
   combine, timestamp, printf, colorize, errors,
 } = format;
 
 addColors(colors);
 
-const logDir = '../../logs';
+const logDir = '../logs';
 const logTimestampFormat = 'YYYY-MM-DD HH:mm:ss:ms';
 const datePattern = 'YYYY-MM-DD';
 

backend/src/mysql.ts

@@ -1,7 +1,7 @@
 import { FieldPacket } from 'mysql2';
 import mysql from 'mysql2/promise';
-import { logger } from '~/v1/utils/logger';
 import { connectOption } from '~/config';
+import { logger } from '~/logger';
 
 export const DBError = 'DB error';
 

backend/src/server.ts

@@ -1,8 +1,8 @@
 import { createHttpTerminator } from 'http-terminator';
-import { logger } from '~/v1/utils/logger';
-import scheduler from '~/v1/utils/scheduler';
-import { gracefulTerminationTimeout } from '~/config';
 import jipDataSource from '~/app-data-source';
+import { gracefulTerminationTimeout } from '~/config';
+import { logger } from '~/logger';
+import scheduler from '~/v1/utils/scheduler';
 import app from './app';
 
 const port = '3000';

backend/src/v1/auth/auth.controller.ts

@@ -2,11 +2,11 @@ import * as bcrypt from 'bcrypt';
 import { NextFunction, Request, Response } from 'express';
 import * as status from 'http-status';
 import { randomUUID } from 'node:crypto';
-import * as errorCode from '~/v1/utils/error/errorCode';
-import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
 import { oauth42ApiOption, oauthUrlOption } from '~/config';
+import { logger } from '~/logger';
 import UsersService from '~/v1/users/users.service';
+import * as errorCode from '~/v1/utils/error/errorCode';
+import ErrorResponse from '~/v1/utils/error/errorResponse';
 import * as models from '../DTO/users.model';
 import { updateSlackIdByUserId } from '../slack/slack.service';
 import * as authJwt from './auth.jwt';

backend/src/v1/auth/auth.validate.ts

@@ -1,11 +1,11 @@
 import { Request, Response } from 'express';
 import * as status from 'http-status';
 import { verify } from 'jsonwebtoken';
-import * as errorCode from '~/v1/utils/error/errorCode';
-import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
 import { jwtOption } from '~/config';
+import { logger } from '~/logger';
 import UsersService from '~/v1/users/users.service';
+import * as errorCode from '~/v1/utils/error/errorCode';
+import ErrorResponse from '~/v1/utils/error/errorResponse';
 import { User } from '../DTO/users.model';
 import { role } from './auth.type';
 

backend/src/v1/auth/auth.validateDefaultNullUser.ts

@@ -1,11 +1,11 @@
 import { Request, Response } from 'express';
 import * as status from 'http-status';
 import { verify } from 'jsonwebtoken';
-import * as errorCode from '~/v1/utils/error/errorCode';
-import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
 import { jwtOption } from '~/config';
+import { logger } from '~/logger';
 import UsersService from '~/v1/users/users.service';
+import * as errorCode from '~/v1/utils/error/errorCode';
+import ErrorResponse from '~/v1/utils/error/errorResponse';
 import { User } from '../DTO/users.model';
 import { role } from './auth.type';
 

backend/src/v1/books/books.controller.ts

@@ -2,10 +2,10 @@ import {
   NextFunction, Request, RequestHandler, Response,
 } from 'express';
 import * as status from 'http-status';
+import { logger } from '~/logger';
 import * as errorCode from '~/v1/utils/error/errorCode';
 import ErrorResponse from '~/v1/utils/error/errorResponse';
 import isNullish from '~/v1/utils/isNullish';
-import { logger } from '~/v1/utils/logger';
 import * as BooksService from './books.service';
 import * as types from './books.type';
 import LikesService from './likes.service';

backend/src/v1/books/books.service.ts

@@ -1,12 +1,12 @@
 /* eslint-disable prefer-regex-literals */
 /* eslint-disable prefer-destructuring */
 import axios from 'axios';
+import jipDataSource from '~/app-data-source';
 import { nationalIsbnApiKey, naverBookApiOption } from '~/config';
+import { logger } from '~/logger';
 import { executeQuery } from '~/mysql';
 import * as errorCode from '~/v1/utils/error/errorCode';
-import { logger } from '~/v1/utils/logger';
 import { StringRows } from '~/v1/utils/types';
-import jipDataSource from '~/app-data-source';
 import * as models from './books.model';
 import BooksRepository from './books.repository';
 import {

backend/src/v1/histories/histories.controller.ts

@@ -2,9 +2,9 @@ import {
   NextFunction, Request, Response,
 } from 'express';
 import * as status from 'http-status';
-import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
+import { logger } from '~/logger';
 import * as errorCode from '~/v1/utils/error/errorCode';
+import ErrorResponse from '~/v1/utils/error/errorResponse';
 import * as historiesService from './histories.service';
 
 // eslint-disable-next-line import/prefer-default-export

backend/src/v1/lendings/lendings.controller.ts

@@ -2,9 +2,9 @@ import {
   NextFunction, Request, RequestHandler, Response,
 } from 'express';
 import * as status from 'http-status';
+import { logger } from '~/logger';
 import * as errorCode from '~/v1/utils/error/errorCode';
 import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
 import * as lendingsService from './lendings.service';
 
 export const create: RequestHandler = async (

backend/src/v1/reservations/reservations.controller.ts

@@ -2,10 +2,10 @@ import {
   NextFunction, Request, RequestHandler, Response,
 } from 'express';
 import * as status from 'http-status';
-import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
-import * as errorCode from '~/v1/utils/error/errorCode';
+import { logger } from '~/logger';
 import * as userUtils from '~/v1/users/users.utils';
+import * as errorCode from '~/v1/utils/error/errorCode';
+import ErrorResponse from '~/v1/utils/error/errorResponse';
 import * as reservationsService from './reservations.service';
 
 export const create: RequestHandler = async (

backend/src/v1/slack/slack.controller.ts

@@ -1,8 +1,8 @@
 import { NextFunction, Request, Response } from 'express';
 import * as status from 'http-status';
+import { logger } from '~/logger';
 import * as errorCode from '~/v1/utils/error/errorCode';
 import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
 import * as slack from './slack.service';
 
 export const updateSlackList = async (

backend/src/v1/slack/slack.service.ts

@@ -1,7 +1,7 @@
 import { WebClient } from '@slack/web-api';
 import { ResultSetHeader } from 'mysql2';
-import { logger } from '~/v1/utils/logger';
 import { botOAuthToken as token } from '~/config';
+import { logger } from '~/logger';
 import { executeQuery } from '~/mysql';
 import UsersService from '~/v1/users/users.service';
 import * as models from '../DTO/users.model';

backend/src/v1/users/users.controller.ts

@@ -1,11 +1,10 @@
 import bcrypt from 'bcrypt';
 import { NextFunction, Request, Response } from 'express';
-import PasswordValidator from 'password-validator';
 import * as status from 'http-status';
-import { z } from 'zod';
-import ErrorResponse from '~/v1/utils/error/errorResponse';
-import { logger } from '~/v1/utils/logger';
+import PasswordValidator from 'password-validator';
+import { logger } from '~/logger';
 import * as errorCode from '~/v1/utils/error/errorCode';
+import ErrorResponse from '~/v1/utils/error/errorResponse';
 import { User } from '../DTO/users.model';
 import UsersService from './users.service';
 import { searchSchema } from './users.types';

backend/src/v1/users/users.service.spec.ts

@@ -2,7 +2,7 @@
 import { QueryRunner } from 'typeorm';
 import jipDataSource from '~/app-data-source';
 import { connectMode } from '~/config';
-import { logger } from '~/v1/utils/logger';
+import { logger } from '~/logger';
 import UsersService from './users.service';
 
 const usersService = new UsersService();

backend/src/v1/utils/error/errorConverter.ts

@@ -1,8 +1,6 @@
 import { NextFunction, Request, Response } from 'express';
-import * as Status from 'http-status';
-import ErrorResponse from './errorResponse';
-import { logger } from '../logger';
 import * as errorCode from './errorCode';
+import ErrorResponse from './errorResponse';
 
 export default function errorConverter(
   err: Error | ErrorResponse,

backend/src/v1/utils/error/errorHandler.ts

@@ -1,8 +1,8 @@
 import { NextFunction, Request, Response } from 'express';
 import * as Status from 'http-status';
-import ErrorResponse from './errorResponse';
-import { logger } from '../logger';
+import { logger } from '~/logger';
 import * as errorCode from './errorCode';
+import ErrorResponse from './errorResponse';
 
 export default function errorHandler(
   err: Error | ErrorResponse,

docker-compose.yaml

@@ -27,13 +27,10 @@ services:
 
   backend:
     container_name: backend
-    #image : node:16
     build:
       context: .
     volumes:
-      #- ./backend/src/:/src/
-      - ./backend/logs:/logs
-    #command: ${MODE}
+      - ./backend/logs:/app/backend/logs
     ports:
       - 3000:3000
     env_file: .env