Merge pull request #409 from sparcs-kaist/dev

Main branch update from Dev branch

src/lottery/middlewares/checkBanned.js

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

src/lottery/modules/quests.js

@@ -65,9 +65,9 @@ const buildQuests = (quests) => {
  */
 const completeQuest = async (userId, timestamp, quest) => {
   try {
-    // 1단계: 유저의 EventStatus를 가져옵니다.
+    // 1단계: 유저의 EventStatus를 가져옵니다. 블록드리스트인지도 확인합니다.
     const eventStatus = await eventStatusModel.findOne({ userId }).lean();
-    if (!eventStatus) return null;
+    if (!eventStatus || eventStatus.isBanned) return null;
 
     // 2단계: 이벤트 기간인지 확인합니다.
     if (timestamp >= eventPeriod.endAt || timestamp < eventPeriod.startAt) {

src/lottery/modules/stores/mongo.js

@@ -34,6 +34,9 @@ const eventStatusSchema = Schema({
     min: 0,
     validate: integerValidator,
   },
+  isBanned: {
+    type: Boolean,
+  },
 });
 
 const questSchema = Schema({

src/lottery/routes/docs/globalState.js

@@ -120,6 +120,11 @@ globalStateDocs[`${apiPrefix}/`] = {
                     },
                   },
                 },
+                isBanned: {
+                  type: "boolean",
+                  description: "해당 유저 제재 대상 여부",
+                  example: false,
+                },
               },
             },
           },

src/lottery/routes/docs/items.js

@@ -69,6 +69,25 @@ itemsDocs[`${apiPrefix}/purchase/:itemId`] = {
           },
         },
       },
+      400: {
+        description:
+          "checkBanned에서 이벤트에 동의하지 않은 사람과 제재 대상을 선별합니다.",
+        content: {
+          "application/json": {
+            schema: {
+              type: "object",
+              required: ["error"],
+              properties: {
+                error: {
+                  type: "string",
+                  description: "",
+                  example: "checkBanned: banned user",
+                },
+              },
+            },
+          },
+        },
+      },
     },
   },
 };

src/lottery/routes/docs/quests.js

@@ -36,6 +36,25 @@ eventsDocs[`${apiPrefix}/complete/:questId`] = {
           },
         },
       },
+      400: {
+        description:
+          "checkBanned에서 이벤트에 동의하지 않은 사람과 제재 대상을 선별합니다.",
+        content: {
+          "application/json": {
+            schema: {
+              type: "object",
+              required: ["error"],
+              properties: {
+                error: {
+                  type: "string",
+                  description: "",
+                  example: "checkBanned: banned user",
+                },
+              },
+            },
+          },
+        },
+      },
     },
   },
 };

src/lottery/routes/items.js

@@ -8,8 +8,9 @@ const itemsSchema = require("./docs/itemsSchema");
 
 router.get("/list", itemsHandlers.listHandler);
 
-// 아래의 Endpoint 접근 시 로그인 및 시각 체크 필요
+// 아래의 Endpoint 접근 시 로그인, 블록드리스트 및 시각 체크 필요
 router.use(require("../../middlewares/auth"));
+router.use(require("../middlewares/checkBanned"));
 router.use(require("../middlewares/timestampValidator"));
 
 router.post(

src/lottery/routes/quests.js

@@ -7,6 +7,7 @@ const { validateParams } = require("../../middlewares/ajv");
 const questsSchema = require("./docs/questsSchema");
 
 router.use(require("../../middlewares/auth"));
+router.use(require("../middlewares/checkBanned"));
 router.use(require("../middlewares/timestampValidator"));
 
 router.post(

src/lottery/services/items.js

@@ -124,12 +124,6 @@ const listHandler = async (_, res) => {
 
 const purchaseHandler = async (req, res) => {
   try {
-    const eventStatus = await eventStatusModel.findOne({ userId: req.userOid });
-    if (!eventStatus)
-      return res
-        .status(400)
-        .json({ error: "Items/Purchase : nonexistent eventStatus" });
-
     const { itemId } = req.params;
     const item = await itemModel.findOne({ _id: itemId }).lean();
     if (!item)
@@ -138,7 +132,7 @@ const purchaseHandler = async (req, res) => {
     // 구매 가능 조건: 크레딧이 충분하며, 재고가 남아있으며, 판매 중인 아이템이어야 합니다.
     if (item.isDisabled)
       return res.status(400).json({ error: "Items/Purchase : disabled item" });
-    if (eventStatus.creditAmount < item.price)
+    if (req.eventStatus.creditAmount < item.price)
       return res
         .status(400)
         .json({ error: "Items/Purchase : not enough credit" });

src/lottery/services/publicNotice.js

@@ -65,30 +65,27 @@ const getRecentPurchaceItemListHandler = async (req, res) => {
   }
 };
 
-const calculateProbabilityV2 = (users, weightSum, base, weight) => {
+const calculateProbabilityV2 = (users, weightSum, weight) => {
   // 유저 수가 상품 수보다 적거나 같으면 무조건 상품을 받게된다.
   if (users.length <= 15) return 1;
 
   /**
-   * 경험적으로 발견한 사실
+   * 실험적으로 발견한 사실
    *
-   * p를 에어팟 당첨 확률, M을 전체 티켓 수라고 하자.
-   * 모든 유저의 p값이 1/15 미만일 경우, 실제 당첨 확률은 15p이다.
-   * 그렇지 않은 경우, 실제 당첨 확률은 1-a^Mp꼴의 지수함수를 따른다. (Note: Mp는 티켓 수이다.)
-   *
-   * 계산 과정
-   *
-   * a는 유저 수, 전체 티켓 수, 티켓 분포에 의해 결정되는 값으로, 현실적으로 계산하기 어렵다.
-   * 따라서, 모든 유저가 같은 수의 티켓을 가지고 있다고 가정하고 a를 계산한 뒤, 이를 확률 계산에 사용한다.
+   * x를 티켓 수라고 하면, 실제 당첨 확률은 1-a^x꼴의 지수함수를 따르는 것을 시뮬레이션을 통해 발견하였다.
+   * 이때 a는 전체 유저 수, 전체 티켓 수, 각 유저의 티켓 수에 의해 결정되는 값이다.
    *
    * a값의 계산 과정
    *
-   * N을 유저 수라고 하자. 모든 유저가 같은 수의 티켓 M/N개를 가지고 있다고 하자.
-   * 이때 기대되는 당첨 확률은 직관적으로 15/N임을 알 수 있다. 즉, 1-a^(M/N) = 15/N이다.
-   * a에 대해 정리하면, a = (1-15/N)^(N/M)임을 알 수 있다.
+   * 매번 a값을 정확하게 계산하는 것은 현실적으로 어렵다.
+   * 따라서, 모든 유저가 같은 수의 티켓을 가지고 있다고 가정하고 a를 계산한 뒤, 이를 확률 계산에 사용한다.
+   * M을 전체 티켓 수, N을 전체 유저 수라고 하자.
+   * 모든 유저가 같은 수의 티켓 M/N개를 가지고 있다면, 한 유저가 상품에 당첨될 확률은 15/N임을 직관적으로 알 수 있다.
+   * 실제 당첨 확률은 1-a^x꼴의 지수함수를 따르므로, 1-a^(M/N) = 15/N이라는 식을 세울 수 있다.
+   * a에 대해 정리하면, a = (1-15/N)^(N/M)을 얻는다.
    */
-  if (base !== null) return 1 - Math.pow(base, weight);
-  else return (weight / weightSum) * 15;
+  const base = Math.pow(1 - 15 / users.length, users.length / weightSum);
+  return 1 - Math.pow(base, weight);
 };
 
 const getTicketLeaderboardHandler = async (req, res) => {
@@ -128,13 +125,6 @@ const getTicketLeaderboardHandler = async (req, res) => {
         },
         [0, 0, 0]
       );
-
-    const isExponential =
-      sortedUsers.find((user) => user.weight >= weightSum / 15) !== undefined;
-    const base = isExponential
-      ? Math.pow(1 - 15 / users.length, users.length / weightSum)
-      : null;
-
     const leaderboard = await Promise.all(
       sortedUsers.slice(0, 20).map(async (user) => {
         const userInfo = await userModel.findOne({ _id: user.userId }).lean();
@@ -148,12 +138,7 @@ const getTicketLeaderboardHandler = async (req, res) => {
           ticket1Amount: user.ticket1Amount,
           ticket2Amount: user.ticket2Amount,
           probability: user.weight / weightSum,
-          probabilityV2: calculateProbabilityV2(
-            users,
-            weightSum,
-            base,
-            user.weight
-          ),
+          probabilityV2: calculateProbabilityV2(users, weightSum, user.weight),
         };
       })
     );
@@ -174,7 +159,6 @@ const getTicketLeaderboardHandler = async (req, res) => {
             probabilityV2: calculateProbabilityV2(
               users,
               weightSum,
-              base,
               sortedUsers[rank].weight
             ),
           }