ci: 2024-04-28 배포 (#824)

* ci: 타입오류 메시지 상대경로 명시적으로 해소 (#643) 참고: actions/runner#659 * feat: v2 book api (#746) * refactor: v1 api와 다른 부분 수정 * refactor: books API schema default sort value 추가 및 callSign 오타 수정 * refactor: status: zod.enum -> zod.nativeEnum 변경 z.enum으로 했을때 number 반환값에 대한 처리가 되지 않아 enumStatus 생성 후 nativeEnum으로 변경하였습니다. * feat: books//:id v2 구현 * feat: books/search v2 구현 * feat: book/update v2 구현 * feat: books/info/:id v2 구현 * refactor: BookNotFoundError import 오타 수정 * feat: books/info/sorted v2 구현 * feat: books/info/tag v2 구현 book_info.id 로 distinct가 되지 않는 오류가 있어요 * refactor: 의미에 맞는 변수명으로 수정 및 코드 간략화 Co-authored-by: scarf <[email protected]> * refactor: book_info 중복 select 부분 처리 Co-authored-by: scarf <[email protected]> * feat: books/donator v2 구현 v1 구현 시 얘기했었던 기부자가 유저가 아니더라도 수정될 수 있도록 수정 & email은 더이상 관리하지 않기 때문에 변수명에서 제거 * refactor: 대출 가능 여부 boolean 반환값으로 수정 kysely 사용중 select가 없을 경우 sql syntax 에러로 해당 부분 수정 및 boolean 값 반환되도록 수정 * feat: [get] books/create v2 구현 axios.get 동작 중 발생하는 에러(catch 영역)에 대한 처리를 어떻게 해야할지 모르겠어요 * fix: 임시로 타입 오류 무시 --------- Co-authored-by: scarf <[email protected]> * style: prettier 적용 (#761) * build: prettier 설정 * style: prettier 적용 --------- Co-authored-by: nocontribute <> * [fix] backend dockerfile error (#764) Co-authored-by: kylee <[email protected]> * fix: `positiveInt` -> `nonNegativeInt` (#766) * refactor: v2 라우트 정리 적용 (#771) * refactor: `/stock` 제거 #767 (comment) * refactor: contracts에서 500번대 오류 제거 백엔드에서 복구 불가능한 오류일 시 반환하기 때문에, 프론트엔드에서 따로 처리하는 것이 좋을 것 같습니다. * refactor: `/history` -> `/lendings` #767 (comment) Co-authored-by: jwoo <[email protected]> * refactor: `/users ` 정리 #767 (comment) Co-authored-by: honeyl3ee <[email protected]> * refactor: `/tag` 서비스 임시 제거 고도화를 하기 위해서는 내부 구현을 바꾸어야 하는 문제가 있어 우선순위를 낮추었습니다. 주석처리를 할까 고민했으나 제거 이전 커밋(1565441)으로 체크아웃시 전체 코드를 확인 가능하기 때문에 복잡도 감소를 위해 코드를 제거하였습니다. * refactor: `/books` 경로 정리 #767 (comment) #767 (comment) Co-authored-by: Jeong Jihwan <[email protected]> Co-authored-by: jwoo <[email protected]> * feat: swagger에서 1줄 요약 표시 --------- Co-authored-by: jwoo <[email protected]> Co-authored-by: honeyl3ee <[email protected]> Co-authored-by: Jeong Jihwan <[email protected]> * feat: add mydata service 토큰에서 id 정보 찾아서 유저 정보 반환하는 controller * feat: 유저 search 할 때 id 가 undefined 인 경우 핸들링 * feat: add swagger && /me endpoint && apply authValidate * fix: searchUsersById 타입을 이전과 같이 리턴하도록 변경 searchUsersById 서비스 함수의 종속성이 생각보다 많음.controller 에서 items 의 length 를 확인하도록 * fix: add librarian validate in search endpoint * feat: 로그인한 유저만 본인 정보를 찾을 수 있도록 middleware 에서 권한 체크 * chore: console.log 제거 * User API 경로 정리 (#777) * refactor: 400번대 에러 반환 제거 * refactor: overDueDay 반환 값에서 제거 * fix(cursus): Access-Control-Allow-Origin 설정 (#790) * chore: dependencies 업데이트 (#796) * chore(deps): contracts의 pnpm-lock 업데이트 * chore(deps): @mapbox/npm-pre-gyp 설치 * chore(deps): npm-pre-gyp 설치 * Revert "chore(deps): npm-pre-gyp 설치" This reverts commit 8922c38 * chore(deps): package.json과 pnpm-lock.yaml 동기화 * fix: users/me 유저권한 all 로 변경 * fix: 반납 3일 전 알림이 여러 번 전송됨 (#801) * fix(notification): 3일 전 반납 알림을 중복 사용한 부분 삭제 - 3일 전 반납 알림을 보내는 함수가 notifyReturningReminder(), notifyOverdueManager() 인데, 후자가 유연한 동작을 지원하므로 전자 함수의 동작을 제거함 * fix(notification): 슬랙 연체 알림 보내는 함수 스케줄러에 추가 * Update backend/src/v1/notifications/notifications.service.ts Co-authored-by: Ji-Hyuck, Min <[email protected]> * refactor: console.log 제거 --------- Co-authored-by: Ji-Hyuck, Min <[email protected]> * fix: `dev/v2` 경로 복구 (#808) * security: 보안 취약점 해결 (#818) * feat(utils): rate limit 모듈 추가 - R, CUD에 해당하는 rate limit 모듈 추가 * refactor(cursus): rate limit 모듈 import해서 사용하도록 변경 * feat: getRateLimiter 적용 * feat(books): 유효한 ISBN인지 검사하는 로직 추가 * feat(tags): tags router에 rate limit 추가 * feat(routes): router에서 authValidate를 미들웨어로 쓰는 곳에 rate limiter 추가 * feat(auth): /get/me에 rate limiter 추가 * feat(users): 유저 생성 후 created 문장 출력 시, db에 저장된 email 값을 사용 * build: csrf 방지를 위한 lusca 패키지 추가 * feat(app): csrf 방지 로직 추가 * feat(app): csrf 방지 옵션 수정 * build: express-session 패키지 추가 * feat(app): lusca 상태 유지를 위한 세션 추가 * feat(app): cookie에도 secret 추가 * feat(app): session에서 cookie 설정 및 lusca에서 부가적인 설정 제거 * fix(auth): /get/me시, id가 null이면 400 status code 반환 (#816) - /get/me 시, id가 null이면 400 status code, errorCode.NO_USER 반환 - catch 로직 수정 * fix: 이미지 빌드 에러 수정 (#820) * feat: 파이썬 가상환경 설치 추가 및 가상환경에서 pip 동작 * feat: server_name 변경 및 루트일 때 인덱스 페이지 지정 * feat: docker-compose에서 443 포트 개방 및 letsencrypt 자동화 스크립트 추가 * feat: scripts/letsencrypt.sh 볼륨 연결 * fix: lusca 설정 수정 * chore: 불필요한 command 제거 * feat(letsencrypt 볼륨 연결): * chore: lusca 제거 * fix(users): search에서 authvalidate의 roleset을 service로 변경 * fix: 스케줄러에 의한 예약 만료 및 재할당 코드 (#814) * fix: 스케줄러에 의한 예약 만료 및 재할당 코드 scheduler.ts - midnightScheduler에서 예약만료처리 코드를 삭제했습니다. - 예약만료처리와 함께 재할당하고, 이에 따른 슬랙메시지를 바로 전송하기 위해 morningScheduler에서 모두 처리합니다. - 슬랙메시지 전송은 낮이 바람직하고, 일련의 처리를 굳이 새벽과 아침에 나누어 작동해야할 필요성을 크게 느끼지 못했습니다. notification.service.ts - notifyReservationOverdue, notifyReservation 코드는 하나로 통합하였습니다. 기존 코드의 역할을 동일하게 수행합니다. - 쿼리 구현부 코드는 모두 reservations.service.ts 에 새롭게 작성된 함수로 대체하였습니다. - 쿼리 실행 과정에서 오류 발생시 에러를 던집니다. - 슬랙 메시지 전송 과정에서 오류 발생시엔 로그만 남깁니다. reservations.service.ts - 총 3개의 함수가 추가되었습니다. - handleReservationOverdueAndAssignReservationToNextWaitingUser는 트랜잭션을 설정하고, 슬랙 메시지 전송을 위해 수행 결과를 반환합니다. - handleReservationOverdue는 예약 만료 처리를 한 뒤, 해당 예약 정보를 반환합니다. - assignReservationToNextWaitingUser는 만료된 예약정보를 받아 다음 예약자에게 할당합니다. handleReservationOverdueAndAssignReservationToNextWaitingUser() - 예약 만료 처리와 다음 예약자에게 할당하는 것이 하나의 트랜잭션안에서 수행되도록 설정합니다. - 사이드 이펙트 방지를 위해 로직을 처리하는 동안 lending에 ROCK을 설정합니다. handleReservationOverdue() - 기존 코드의 논리적 오류를 수정했습니다. - 예약 만료 처리해야할 데이터 조회 로직을 수정했습니다. status가 3이 아니라, 0이면서 && 책이 할당되었으면서 && 만료일이 지난 예약을 찾습니다. - 이제 이곳에서 정상적으로 예약만료 처리과정에서 status = 3을 부여합니다. assignReservationToNextWaitingUser() - 기존 코드의 논리적 오류를 수정했습니다. - handleReservationOverdue()를 통해 예약 만료된 책 정보를 1개씩 입력받습니다. - 해당 책에 대해서 다음 예약자가 존재하면 할당합니다. * fix: Promise.allSetteld로 변경 * chore(reservations): reservation_id 대신 reservation.id 사용 * feat(reservations): LOCK 제거 * feat(reservations): SQL문 분리 및 서브쿼리 수정 * feat(reservations): 누락된 트랜잭션 커밋 추가 * chore(reservations): 오타 수정 --------- Co-authored-by: yena <[email protected]> * cd: nginx 설정 파일에 ssl 설정 추가 (#823) * feat(nginx): nginx 설정 파일에 ssl 설정 추가 - http, https 디렉티브 분리 - certbot 인증서 설정 추가 * feat: host 비교 조건문 수정 * User API 경로 정리 (#777) * refactor: 400번대 에러 반환 제거 * refactor: overDueDay 반환 값에서 제거 * Revert "User API 경로 정리 (#777)" This reverts commit 9adc701. --------- Co-authored-by: scarf <[email protected]> Co-authored-by: Jeong Jihwan <[email protected]> Co-authored-by: gilee <[email protected]> Co-authored-by: kylee <[email protected]> Co-authored-by: jwoo <[email protected]> Co-authored-by: honeyl3ee <[email protected]> Co-authored-by: jimin <[email protected]> Co-authored-by: Ji-Hyuck, Min <[email protected]> Co-authored-by: jhj9109 <[email protected]>
jiphyeonjeon-42 · Apr 27, 2024 · 3a74c51 · 3a74c51
1 parent 4d0ed15
commit 3a74c51
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 132 deletions.
diff --git a/backend/src/v1/notifications/notifications.service.ts b/backend/src/v1/notifications/notifications.service.ts
@@ -1,138 +1,24 @@
-import { executeQuery, makeExecuteQuery, pool } from '~/mysql';
+import { executeQuery } from '~/mysql';
 import { publishMessage } from '../slack/slack.service';
+import { handleReservationOverdueAndAssignReservationToNextWaitingUser } from '../reservations/reservations.service';
+import { logger } from '~/logger';
 
-const succeedReservation = async (reservation: { bookId: number; bookInfoId: number }) => {
-  const conn = await pool.getConnection();
-  const transactionExecuteQuery = makeExecuteQuery(conn);
+const sendSlackMessage = async (slack: string, message: string) => {
   try {
-    const candidates: {
-      id: number;
-      slack: string;
-      title: string;
-    }[] = await transactionExecuteQuery(
-      `
-    SELECT
-      reservation.id AS id,
-      user.slack AS slack,
-      book_info.title AS title
-    FROM
-      reservation
-    LEFT JOIN user ON
-      user.id = reservation.userId
-    LEFT JOIN book_info ON
-      book_info.id = reservation.bookInfoId
-    WHERE
-      reservation.status = 0 AND
-      reservation.bookInfoId = ?
-    ORDER BY
-      reservation.createdAt DESC
-    LIMIT 1
-    `,
-      [reservation.bookInfoId],
-    );
-    if (candidates.length !== 0) {
-      await transactionExecuteQuery(
-        `
-        UPDATE
-          reservation
-        SET
-          bookId = ?,
-          endAt = DATE_ADD(NOW(), INTERVAL 3 DAY)
-        WHERE
-          reservation.id = ?
-      `,
-        [reservation.bookId, candidates[0].id],
-      );
-      publishMessage(
-        candidates[0].slack,
-        `:jiphyeonjeon: 예약 알림 :jiphyeonjeon:\n예약하신 도서 \`${candidates[0].title}\`(이)가 대출 가능합니다. 3일 내로 집현전에 방문해 대출해주세요. (방문하시기 전에 비치 여부를 확인해주세요)`,
-      );
-    }
-  } catch (e) {
-    await conn.rollback();
-    if (e instanceof Error) {
-      throw e;
-    }
-  } finally {
-    conn.release();
+    await publishMessage(slack, message);
+  } catch (error) {
+    logger.error('[scheduler error(slack)]', error);
   }
 };
 
-export const notifyReservation = async () => {
-  const reservations: [
-    {
-      bookId: number;
-      bookInfoId: number;
-    },
-  ] = await executeQuery(`
-      SELECT
-        reservation.bookId AS bookId,
-        reservation.bookInfoId AS bookInfoId
-      FROM
-        reservation
-      WHERE
-        reservation.status = 3 AND
-        DATE(reservation.updatedAt) = CURDATE()
-    `);
-  reservations.forEach(async (reservation) => {
-    if (reservation.bookId) {
-      succeedReservation(reservation);
-    }
-  });
-};
-
-export const notifyReservationOverdue = async () => {
-  const reservations: {
-    slack: string;
-    title: string;
-    bookId: number;
-    bookInfoId: number;
-  }[] = await executeQuery(`
-    SELECT
-      user.slack AS slack,
-      book_info.title AS title,
-      reservation.bookId AS bookId,
-      reservation.bookInfoId AS bookInfoId
-    FROM
-      reservation
-    LEFT JOIN user ON
-      user.id = reservation.userId
-    LEFT JOIN book_info ON
-      book_info.id = reservation.bookInfoId
-    WHERE
-      reservation.status = 3 AND
-      DATEDIFF(CURDATE(), DATE(reservation.endAt)) = 1
-  `);
-  reservations.forEach(async (reservation) => {
-    publishMessage(
-      reservation.slack,
-      `:jiphyeonjeon: 예약 만료 알림 :jiphyeonjeon:\n예약하신 도서 \`${reservation.title}\`의 예약이 만료되었습니다.`,
-    );
-    const ranks: [{ id: number; createdAt: Date }] = await executeQuery(
-      `
-      SELECT
-        id,
-        createdAt
-      FROM
-        reservation
-      WHERE
-        bookInfoId = ? AND status = 0
-      ORDER BY createdAt ASC
-    `,
-      [reservation.bookInfoId],
-    );
-    await executeQuery(
-      `
-      UPDATE reservation
-      SET
-        bookId = ?,
-        endAt = ADDDATE(CURDATE(),1)
-      WHERE
-        id = ?
-    `,
-      [reservation.bookId, ranks[0].id],
-    );
-  });
+/**
+ * 만료된 예약을 처리하고, 다음 예약자에게 할당하고, 슬랙 메시지를 전송합니다.
+ * @throws 만료된 예약를 처리하고, 다음 예약자에게 할당하는 쿼리 과정에서 에러가 발생하면 에러를 던집니다. 슬랙 메시지 전송 실패시엔 로그만 남깁니다.
+ */
+export const notifyReservationOverdueAndNotifyReservation = async () => {
+  const { overDueReservations, assignedReservations } = await handleReservationOverdueAndAssignReservationToNextWaitingUser();
+  await Promise.allSettled(overDueReservations.map(({slack, title}) => sendSlackMessage(slack, `:jiphyeonjeon: 예약 만료 알림 :jiphyeonjeon:\n예약하신 도서 \`${title}\`의 예약이 만료되었습니다.`)));
+  await Promise.allSettled(assignedReservations.map((data) => sendSlackMessage(data!.slack, `:jiphyeonjeon: 예약 알림 :jiphyeonjeon:\n예약하신 도서 \`${data!.title}\`(이)가 대출 가능합니다. 3일 내로 집현전에 방문해 대출해주세요.`,)));
 };
 
 /**

diff --git a/backend/src/v1/reservations/reservations.service.ts b/backend/src/v1/reservations/reservations.service.ts
@@ -187,6 +187,128 @@ export const cancel = async (reservationId: number): Promise<void> => {
   }
 };
 
+type TransactionExecuteQueryType = (queryText: string, values?: any[]) => Promise<any>;
+
+/**
+ * 만료된 예약을 처리 후, 다음 예약자에게 예약을 할당하기 위한 예약 정보를 반환합니다.
+ * - 책이 할당 될때, status는 여전히 0이지만 endAt과 bookId가 null에서 각각 값이 할당됩니다.
+ * - 따라서 status가 0이면서 책이 할당 되어 bookId와 endAt을 가졌으면서 endAt이 현재 날짜보다 이전인 예약을 찾습니다.
+ * - status를 3을 부여하여 만료된 예약임을 표시합니다.
+ * @param transactionExecuteQuery 트랜잭션 처리를 위한 executeQuery
+ */
+const handleReservationOverdue = async (transactionExecuteQuery: TransactionExecuteQueryType) => {
+  const overDueReservations: {
+    slack: string;
+    title: string;
+    bookId: number;
+    bookInfoId: number;
+  }[] = await transactionExecuteQuery(`
+    SELECT
+      user.slack AS slack,
+      book_info.title AS title,
+      reservation.bookId AS bookId,
+      reservation.bookInfoId AS bookInfoId
+    FROM
+      reservation
+    LEFT JOIN user ON
+      user.id = reservation.userId
+    LEFT JOIN book_info ON
+      book_info.id = reservation.bookInfoId
+    WHERE
+      reservation.status = 0 AND
+      bookId IS NOT NULL AND
+      IFNULL(DATEDIFF(CURDATE(), DATE(reservation.endAt)), 0) >= 1;
+      
+  `);
+  await transactionExecuteQuery(`
+    UPDATE
+      reservation
+    SET
+      reservation.status = 3
+    WHERE
+      reservation.id IN (
+        SELECT id
+          FROM (
+            SELECT
+              reservation.id
+            FROM
+              reservation
+            WHERE
+              reservation.status = 0 AND
+              reservation.bookId IS NOT NULL AND
+              IFNULL(DATEDIFF(CURDATE(), DATE(reservation.endAt)), 0) >= 1
+          ) AS expiredReservations
+      );
+  `);
+  return overDueReservations;
+}
+
+/**
+ * 예약 취소 시, 다음 예약자에게 예약을 할당합니다.
+ * - 아직 책을 할당 받지 못한 예약자는 status가 0이고, bookId와 endAt이 null입니다.
+ * - 따라서 해당 조건을 만족하면서 가장 먼저 예약한 예약자를 찾아 해당 예약자에게 책을 할당합니다.
+ * @param transactionExecuteQuery 트랜잭션 처리를 위한 executeQuery
+ * @param bookData 책 정보, title, bookId, bookInfoId를 가지고 있습니다. 해당 책은 반드시 예약가능한 상태여야 합니다.
+ * @returns 인자로 받은 transactionExecuteQuery를 이용한 함수를 반환합니다. 해당 함수를 이용해 쿼리를 실행하고, 쿼리 실행 결과를 반환합니다. 반환된 값은 결과를 슬랙 메시지로 안내시 사용가능합니다.
+ */
+const assignReservationToNextWaitingUser = (transactionExecuteQuery: TransactionExecuteQueryType) => async (bookData: {title: string, bookId: number, bookInfoId: number}) => {
+
+  const firstWaitingReservation: { id: number, slack: string }[] = await transactionExecuteQuery(
+    `
+    SELECT
+      reservation.id AS id,
+      user.slack AS slack
+    FROM
+      reservation
+    LEFT JOIN user ON
+      user.id = reservation.userId
+    WHERE
+      bookInfoId = ? AND status = 0 AND bookId IS NULL AND endAt IS NULL
+    ORDER BY
+      reservation.createdAt ASC
+    LIMIT 1
+    FOR UPDATE;
+  `,
+    [bookData.bookInfoId],
+  );
+  if (firstWaitingReservation.length > 0) {
+    await transactionExecuteQuery(
+      `
+      UPDATE reservation
+      SET
+        bookId = ?,
+        endAt = ADDDATE(CURDATE(), 3)
+      WHERE
+        id = ?;
+    `,
+      [bookData.bookId, firstWaitingReservation[0].id],
+    );
+    return { title: bookData.title, slack: firstWaitingReservation[0].slack };
+  }
+  return null;
+};
+
+/**
+ * 만료된 예약을 처리하고, 다음 예약자에게 할당하고, 슬랙 메시지 전송을 위한 정보를 반환합니다.
+ * @returns 각각 만료된 예약, 다음 예약자에게 할당된 예약 정보를 반환합니다. 해당 정보는 슬랙 메시지 전송을 위해 사용됩니다.
+ */
+export const handleReservationOverdueAndAssignReservationToNextWaitingUser = async() => {
+  const conn = await pool.getConnection();
+  const transactionExecuteQuery = makeExecuteQuery(conn);
+  await conn.beginTransaction();
+  try {
+    const overDueReservations = await handleReservationOverdue(transactionExecuteQuery);
+    const assignedReservations = await Promise.all(overDueReservations.map(assignReservationToNextWaitingUser(transactionExecuteQuery)));
+    await conn.commit();
+    return { overDueReservations, assignedReservations };
+  } catch (error) {
+    await conn.rollback();
+    throw error;
+  } finally {
+    await conn.release();
+  }
+}
+
 export const userCancel = async (userId: number, reservationId: number): Promise<void> => {
   const reservations = await executeQuery(
     `

diff --git a/backend/src/v1/utils/scheduler.ts b/backend/src/v1/utils/scheduler.ts
@@ -12,7 +12,6 @@ const midnightScheduler = () => {
   rule.tz = 'Asia/Seoul';
   schedule.scheduleJob(rule, async () => {
     await slack.updateSlackId();
-    await notifications.notifyReservationOverdue();
     await searchKeywords.renewLastPopular();
   });
 };
@@ -24,7 +23,8 @@ const morningScheduler = () => {
   rule.minute = 42;
   rule.tz = 'Asia/Seoul';
   schedule.scheduleJob(rule, async () => {
-    await notifications.notifyReservation();
+    await notifications.notifyReservationOverdueAndNotifyReservation();
+    await notifications.notifyReturningReminder();
     await notifications.notifyOverdueManager();
     await notifications.notifyOverdue();
   });

diff --git a/nginx/conf.d/default.conf b/nginx/conf.d/default.conf
@@ -1,9 +1,15 @@
 server {
-    listen       80;
+    listen       443 ssl;
     server_name  42library.kr;
 
     #access_log  /var/log/nginx/host.access.log  main;
 
+    ssl_certificate /etc/letsencrypt/live/42library.kr/fullchain.pem; # managed by Cert>
+    ssl_certificate_key /etc/letsencrypt/live/42library.kr/privkey.pem; # managed by Ce>
+
+    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
+    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
+
     location /api/ {
         proxy_pass http://backend:3000;
     }
@@ -42,3 +48,13 @@ server {
         root   /usr/share/nginx/html;
     }
 }
+
+server {
+    if ($host = 42library.kr) {
+        return 301 https://$host$request_uri;
+    } # managed by Certbot
+
+    listen 80;
+    server_name 42library.kr;
+    return 404; # managed by Certbot
+}