#541 24-chuseok event ban middleware

src/lottery/middlewares/eventValidator.js

@@ -0,0 +1,32 @@
+const { eventStatusModel } = require("../modules/stores/mongo");
+const logger = require("../../modules/logger");
+
+/**
+ * 사용자가 차단 되었는지 여부를 판단합니다.
+ * 차단된 사용자는 이벤트에 한하여 서비스 이용에 제재를 받습니다.
+ * @param {*} req eventStatus가 성공적일 경우 req.eventStatus = eventStatus로 들어갑니다.
+ * @param {*} res
+ * @param {*} next
+ * @returns
+ */
+const eventValidator = async (req, res, next) => {
+  try {
+    const eventStatus = await eventStatusModel
+      .findOne({ userId: req.userOid })
+      .lean();
+    if (!eventStatus) {
+      return res
+        .status(400)
+        .json({ error: "eventValidator: nonexistent eventStatus" });
+    }
+    req.eventStatus = eventStatus;
+  } catch (err) {
+    logger.error(err);
+    res.error(500).json({
+      error: "eventValidator: internal server error",
+    });
+  }
+  next();
+};
+
+module.exports = eventValidator;

src/lottery/modules/contracts.js

@@ -109,8 +109,8 @@ const quests = buildQuests({
  * @returns {Promise}
  * @usage lottery/globalState - createUserGlobalStateHandler
  */
-const completeFirstLoginQuest = async (userId, timestamp) => {
-  return await completeQuest(userId, timestamp, quests.firstLogin);
+const completeFirstLoginQuest = async (req, userId, timestamp) => {
+  return await completeQuest(req, userId, timestamp, quests.firstLogin);
 };
 
 /**
@@ -121,8 +121,8 @@ const completeFirstLoginQuest = async (userId, timestamp) => {
  * @description 방을 만들 때마다 호출해 주세요.
  * @usage rooms - createHandler
  */
-const completeFirstRoomCreationQuest = async (userId, timestamp) => {
-  return await completeQuest(userId, timestamp, quests.firstRoomCreation);
+const completeFirstRoomCreationQuest = async (req, userId, timestamp) => {
+  return await completeQuest(req, userId, timestamp, quests.firstRoomCreation);
 };
 
 /**
@@ -137,7 +137,12 @@ const completeFirstRoomCreationQuest = async (userId, timestamp) => {
  * @description 정산 요청이 이루어질 때마다 호출해 주세요.
  * @usage rooms - commitSettlementHandler
  */
-const completeFareSettlementQuest = async (userId, timestamp, roomObject) => {
+const completeFareSettlementQuest = async (
+  req,
+  userId,
+  timestamp,
+  roomObject
+) => {
   logger.info(
     `User ${userId} requested to complete fareSettlementQuest in Room ${roomObject._id}`
   );
@@ -150,7 +155,7 @@ const completeFareSettlementQuest = async (userId, timestamp, roomObject) => {
   )
     return null; // 택시 출발 시각이 이벤트 기간 내에 포함되지 않는 경우 퀘스트 완료 요청을 하지 않습니다.
 
-  return await completeQuest(userId, timestamp, quests.fareSettlement);
+  return await completeQuest(req, userId, timestamp, quests.fareSettlement);
 };
 
 /**
@@ -165,7 +170,7 @@ const completeFareSettlementQuest = async (userId, timestamp, roomObject) => {
  * @description 송금이 이루어질 때마다 호출해 주세요.
  * @usage rooms - commitPaymentHandler
  */
-const completeFarePaymentQuest = async (userId, timestamp, roomObject) => {
+const completeFarePaymentQuest = async (req, userId, timestamp, roomObject) => {
   logger.info(
     `User ${userId} requested to complete farePaymentQuest in Room ${roomObject._id}`
   );
@@ -178,7 +183,7 @@ const completeFarePaymentQuest = async (userId, timestamp, roomObject) => {
   )
     return null; // 택시 출발 시각이 이벤트 기간 내에 포함되지 않는 경우 퀘스트 완료 요청을 하지 않습니다.
 
-  return await completeQuest(userId, timestamp, quests.farePayment);
+  return await completeQuest(req, userId, timestamp, quests.farePayment);
 };
 
 /**
@@ -189,8 +194,8 @@ const completeFarePaymentQuest = async (userId, timestamp, roomObject) => {
  * @description 닉네임을 변경할 때마다 호출해 주세요.
  * @usage users - editNicknameHandler
  */
-const completeNicknameChangingQuest = async (userId, timestamp) => {
-  return await completeQuest(userId, timestamp, quests.nicknameChanging);
+const completeNicknameChangingQuest = async (req, userId, timestamp) => {
+  return await completeQuest(req, userId, timestamp, quests.nicknameChanging);
 };
 
 /**
@@ -202,10 +207,15 @@ const completeNicknameChangingQuest = async (userId, timestamp) => {
  * @description 계좌를 변경할 때마다 호출해 주세요.
  * @usage users - editAccountHandler
  */
-const completeAccountChangingQuest = async (userId, timestamp, newAccount) => {
+const completeAccountChangingQuest = async (
+  req,
+  userId,
+  timestamp,
+  newAccount
+) => {
   if (newAccount === "") return null;
 
-  return await completeQuest(userId, timestamp, quests.accountChanging);
+  return await completeQuest(req, userId, timestamp, quests.accountChanging);
 };
 
 /**
@@ -218,13 +228,14 @@ const completeAccountChangingQuest = async (userId, timestamp, newAccount) => {
  * @usage notifications - editOptionsHandler
  */
 const completeAdPushAgreementQuest = async (
+  req,
   userId,
   timestamp,
   advertisement
 ) => {
   if (!advertisement) return null;
 
-  return await completeQuest(userId, timestamp, quests.adPushAgreement);
+  return await completeQuest(req, userId, timestamp, quests.adPushAgreement);
 };
 
 /**
@@ -234,8 +245,8 @@ const completeAdPushAgreementQuest = async (
  * @returns {Promise}
  * @usage lottery/globalState - createUserGlobalStateHandler
  */
-const completeEventSharingQuest = async (userId, timestamp) => {
-  return await completeQuest(userId, timestamp, quests.eventSharing);
+const completeEventSharingQuest = async (req, userId, timestamp) => {
+  return await completeQuest(req, userId, timestamp, quests.eventSharing);
 };
 
 /**
@@ -245,8 +256,8 @@ const completeEventSharingQuest = async (userId, timestamp) => {
  * @returns {Promise}
  * @description 상품을 구입할 때마다 호출해 주세요.
  */
-const completeItemPurchaseQuest = async (userId, timestamp) => {
-  return await completeQuest(userId, timestamp, quests.itemPurchase);
+const completeItemPurchaseQuest = async (req, userId, timestamp) => {
+  return await completeQuest(req, userId, timestamp, quests.itemPurchase);
 };
 
 module.exports = {

src/lottery/modules/quests.js

@@ -8,6 +8,7 @@ const logger = require("../../modules/logger");
 const mongoose = require("mongoose");
 
 const { eventConfig } = require("../../../loadenv");
+const { validateServiceBanRecord } = require("../../modules/ban");
 const eventPeriod = eventConfig && {
   startAt: new Date(eventConfig.period.startAt),
   endAt: new Date(eventConfig.period.endAt),
@@ -64,11 +65,16 @@ const buildQuests = (quests) => {
  * @param {number} quest.maxCount - 퀘스트의 최대 완료 가능 횟수입니다.
  * @returns {Object|null} 성공한 경우 Object를, 실패한 경우 null을 반환합니다. 이미 최대 완료 횟수에 도달했거나, 퀘스트가 원격으로 비활성화된 경우에도 실패로 처리됩니다.
  */
-const completeQuest = async (userId, timestamp, quest) => {
+const completeQuest = async (req, userId, timestamp, quest) => {
   try {
     // 1단계: 유저의 EventStatus를 가져옵니다. 블록드리스트인지도 확인합니다.
     const eventStatus = await eventStatusModel.findOne({ userId }).lean();
-    if (!eventStatus || eventStatus.isBanned) return null;
+    const banErrorMessage = await validateServiceBanRecord(
+      req,
+      eventConfig.mode
+    );
+
+    if (!eventStatus || !!banErrorMessage) return null;
 
     // 2단계: 이벤트 기간인지 확인합니다.
     if (

src/lottery/routes/invites.js

@@ -13,7 +13,8 @@ router.get(
 
 // 아래의 Endpoint 접근 시 로그인, 차단 여부 및 시각 체크 필요
 router.use(require("../../middlewares/auth"));
-router.use(require("../middlewares/checkBanned"));
+router.use(require("../../middlewares/ban"));
+router.use(require("../middlewares/eventValidator"));
 router.use(require("../middlewares/timestampValidator"));
 
 router.post("/create", invitesHandlers.createInviteUrlHandler);

src/lottery/routes/items.js

@@ -19,7 +19,8 @@ router.get(
 
 // 아래의 Endpoint 접근 시 로그인, 차단 여부 및 시각 체크 필요
 router.use(require("../../middlewares/auth"));
-router.use(require("../middlewares/checkBanned"));
+router.use(require("../../middlewares/ban"));
+router.use(require("../middlewares/eventValidator"));
 router.use(require("../middlewares/timestampValidator"));
 
 router.post(

src/lottery/routes/quests.js

@@ -7,7 +7,8 @@ const questsHandlers = require("../services/quests");
 
 // 아래의 Endpoint 접근 시 로그인, 차단 여부 및 시각 체크 필요
 router.use(require("../../middlewares/auth"));
-router.use(require("../middlewares/checkBanned"));
+router.use(require("../../middlewares/ban"));
+router.use(require("../middlewares/eventValidator"));
 router.use(require("../middlewares/timestampValidator"));
 
 router.post(

src/lottery/routes/transactions.js

@@ -3,8 +3,9 @@ const router = express.Router();
 
 const transactionsHandlers = require("../services/transactions");
 
-// 아래의 Endpoint 접근 시 로그인 필요
+// 아래의 Endpoint 접근 시 로그인 체크 필요
 router.use(require("../../middlewares/auth"));
+router.use(require("../middlewares/eventValidator"));
 
 router.get("/", transactionsHandlers.getUserTransactionsHandler);
 

src/lottery/services/globalState.js

@@ -6,6 +6,7 @@ const { nodeEnv } = require("../../../loadenv");
 
 const { eventConfig } = require("../../../loadenv");
 const contracts = require("../modules/contracts");
+const { validateServiceBanRecord } = require("../../modules/ban");
 const quests = Object.values(contracts.quests);
 
 // 아래의 함수는 2024 추석 이벤트에서 사용되지 않습니다.
@@ -85,11 +86,13 @@ const createUserGlobalStateHandler = async (req, res) => {
     const inviterStatus =
       req.body.inviter &&
       (await eventStatusModel.findById(req.body.inviter).lean());
+    const banErrorMessage = await validateServiceBanRecord(
+      req,
+      eventConfig.mode
+    );
     if (
       req.body.inviter &&
-      (!inviterStatus ||
-        inviterStatus.isBanned ||
-        !inviterStatus.isInviteUrlEnabled)
+      (!inviterStatus || !!banErrorMessage || !inviterStatus.isInviteUrlEnabled)
     )
       return res.status(400).json({
         error: "GlobalState/create : invalid inviter",
@@ -128,11 +131,16 @@ const createUserGlobalStateHandler = async (req, res) => {
     await eventStatus.save();
 
     // 퀘스트를 완료 처리합니다.
-    await contracts.completeFirstLoginQuest(req.userOid, req.timestamp);
+    await contracts.completeFirstLoginQuest(req, req.userOid, req.timestamp);
 
     if (inviterStatus) {
-      await contracts.completeEventSharingQuest(req.userOid, req.timestamp);
       await contracts.completeEventSharingQuest(
+        req,
+        req.userOid,
+        req.timestamp
+      );
+      await contracts.completeEventSharingQuest(
+        req,
         inviterStatus.userId,
         req.timestamp
       );

src/lottery/services/invites.js

@@ -3,6 +3,7 @@ const { userModel } = require("../../modules/stores/mongo");
 const logger = require("../../modules/logger");
 
 const { eventConfig } = require("../../../loadenv");
+const { validateServiceBanRecord } = require("../../modules/ban");
 
 const searchInviterHandler = async (req, res) => {
   try {
@@ -13,9 +14,13 @@ const searchInviterHandler = async (req, res) => {
     const inviterStatus = await eventStatusModel
       .findById(req.params.inviter)
       .lean();
+    const banErrorMessage = await validateServiceBanRecord(
+      req,
+      eventConfig.mode
+    );
     if (
       !inviterStatus ||
-      inviterStatus.isBanned ||
+      !!banErrorMessage ||
       !inviterStatus.isInviteUrlEnabled
     )
       return res

src/lottery/services/items.js

@@ -309,6 +309,7 @@ const purchaseItemHandler = async (req, res) => {
 
       // 4단계: 퀘스트를 완료 처리합니다.
       await contracts.completeItemPurchaseQuest(
+        req,
         req.userOid,
         transaction.createdAt
       );

src/middlewares/ban.js

@@ -1,3 +1,4 @@
+const { eventConfig } = require("../../loadenv");
 const { validateServiceBanRecord } = require("../modules/ban");
 
 const serviceMapper = new Map([
@@ -6,10 +7,11 @@ const serviceMapper = new Map([
 ]);
 
 const banMiddleware = async (req, res, next) => {
-  const banErrorMessage = await validateServiceBanRecord(
-    req,
-    serviceMapper.get(req.originalUrl)
-  );
+  let service = serviceMapper.get(req.originalUrl);
+  if (!service && !!eventConfig && req.originalUrl.includes(eventConfig.mode)) {
+    service = eventConfig.mode;
+  }
+  const banErrorMessage = await validateServiceBanRecord(req, service);
   if (banErrorMessage !== undefined) {
     return res.status(400).json({ error: banErrorMessage });
   }

src/modules/stores/mongo.js

@@ -40,7 +40,7 @@ const banSchema = Schema({
     // 필요시 이곳에 정지를 시킬 서비스를 추가함.
     enum: [
       "service", // service: 방 생성/참여 제한
-      "2023-fall-event", // xxxx-xxxx-event: 특정 이벤트 참여 제한
+      "2024fall", // 2024fall: 가을학기 추석 이벤트 참여 제한
     ],
   },
 });

src/services/notifications.js

@@ -109,6 +109,7 @@ const editOptionsHandler = async (req, res) => {
 
     // 이벤트 코드입니다.
     await contracts?.completeAdPushAgreementQuest(
+      req,
       req.userOid,
       req.timestamp,
       options.advertisement

src/services/rooms.js

@@ -110,7 +110,11 @@ const createHandler = async (req, res) => {
     const roomObjectFormated = formatSettlement(roomObject);
 
     // 이벤트 코드입니다.
-    await contracts?.completeFirstRoomCreationQuest(req.userOid, req.timestamp);
+    await contracts?.completeFirstRoomCreationQuest(
+      req,
+      req.userOid,
+      req.timestamp
+    );
 
     return res.send(roomObjectFormated);
   } catch (err) {
@@ -587,6 +591,7 @@ const commitSettlementHandler = async (req, res) => {
 
     // 이벤트 코드입니다.
     await contracts?.completeFareSettlementQuest(
+      req,
       req.userOid,
       req.timestamp,
       roomObject
@@ -660,6 +665,7 @@ const commitPaymentHandler = async (req, res) => {
 
     // 이벤트 코드입니다.
     await contracts?.completeFarePaymentQuest(
+      req,
       req.userOid,
       req.timestamp,
       roomObject

src/services/users.js

@@ -53,6 +53,7 @@ const editNicknameHandler = async (req, res) => {
     if (result) {
       // 이벤트 코드입니다.
       await contracts?.completeNicknameChangingQuest(
+        req,
         req.userOid,
         req.timestamp
       );
@@ -80,6 +81,7 @@ const editAccountHandler = async (req, res) => {
     if (result) {
       // 이벤트 코드입니다.
       await contracts?.completeAccountChangingQuest(
+        req,
         req.userOid,
         req.timestamp,
         newAccount