#520 ban 여부에 따른 서비스 이용 제한

src/middlewares/ban.js

@@ -0,0 +1,19 @@
+const { validateServiceBanRecord } = require("../modules/ban");
+
+const serviceMapper = new Map([
+  ["/rooms/create", "service"],
+  ["/rooms/join", "service"],
+]);
+
+const banMiddleware = async (req, res, next) => {
+  const banErrorMessage = await validateServiceBanRecord(
+    req,
+    serviceMapper.get(req.originalUrl)
+  );
+  if (banErrorMessage !== undefined) {
+    return res.status(400).json({ error: banErrorMessage });
+  }
+  next();
+};
+
+module.exports = banMiddleware;

src/modules/ban.js

@@ -0,0 +1,45 @@
+const logger = require("./logger");
+const { banModel } = require("./stores/mongo");
+
+/**
+ * @param {*} req
+ * @param {String} service
+ */
+const validateServiceBanRecord = async (req, service) => {
+  let banRecord = undefined;
+
+  try {
+    // 현재 시각이 expireAt 보다 작고, 본인인 경우(ban의 userId가 userId랑 같은 경우) 중 serviceName이 "service"인 record를 모두 가져옴
+    const bans = await banModel
+      .find({
+        userSid: req.session.loginInfo.sid,
+        expireAt: {
+          $gte: req.timestamp,
+        },
+        serviceName: service,
+      })
+      .sort({ expireAt: -1 });
+    if (bans.length > 0) {
+      // 가장 expireAt이 큰 정지 기록만 반환함.
+      banRecord = bans[0];
+    }
+  } catch (err) {
+    logger.error(
+      "Error occured while validateServiceBanRecord: " + err.message
+    );
+    return;
+  }
+  if (banRecord !== undefined) {
+    const formattedExpireAt = banRecord.expireAt
+      .toISOString()
+      .replace("T", " ")
+      .split(".")[0];
+    const banErrorMessage = `${req.originalUrl} : user ${req.userId} (${req.session.loginInfo.sid}) is temporarily restricted from service until ${formattedExpireAt}.`;
+    return banErrorMessage;
+  }
+  return;
+};
+
+module.exports = {
+  validateServiceBanRecord,
+};

src/modules/stores/mongo.js

@@ -28,35 +28,21 @@ const userSchema = Schema({
 
 const banSchema = Schema({
   // 정지 시킬 사용자를 기제함.
-  userId: { type: mongoose.Types.ObjectId, ref: "User", required: true },
+  userSid: { type: String, required: true },
   // 정지 사유
-  reason: {
+  reason: { type: String, required: true },
+  bannedAt: { type: Date, required: true }, // 정지 당한 시각
+  expireAt: { type: Date, required: true }, // 정지 만료 시각
+  // 정지를 당한 서비스를 기제함
+  serviceName: {
     type: String,
     required: true,
+    // 필요시 이곳에 정지를 시킬 서비스를 추가함.
+    enum: [
+      "service", // service: 방 생성/참여 제한
+      "2023-fall-event", // xxxx-xxxx-event: 특정 이벤트 참여 제한
+    ],
   },
-  bannedAt: {
-    type: Date, // 정지 당한 시각
-    required: true,
-  },
-  expireAt: {
-    type: Date, // 정지 만료 시각
-    required: true,
-  },
-  services: [
-    {
-      // 정지를 당한 서비스를 기제함
-      serviceName: {
-        type: String,
-        required: true,
-        // 필요시 이곳에 정지를 시킬 서비스를 추가함.
-        enum: [
-          "all", // all -> 과거/미래 모든 서비스 및 이벤트 이용 제한
-          "service", // service -> 방 생성/참여 제한
-          "2023-fall-event", // event -> 특정 이벤트 참여 제한
-        ],
-      },
-    },
-  ],
 });
 
 const participantSchema = Schema({

src/routes/docs/rooms.js

@@ -72,6 +72,12 @@ roomsDocs[`${apiPrefix}/create`] = {
               },
             },
             examples: {
+              "방 생성 기능이 정지당한 경우": {
+                value: {
+                  error:
+                    "Rooms/join : user monday is temporarily restricted from creating rooms until 2024-08-23 15:00:00.",
+                },
+              },
               "출발지와 도착지가 같음": {
                 value: {
                   error: "Rooms/create : locations are same",
@@ -309,6 +315,12 @@ roomsDocs[`${apiPrefix}/join`] = {
               },
             },
             examples: {
+              "방 참여 기능이 정지당한 경우": {
+                value: {
+                  error:
+                    "Rooms/join : user monday is temporarily restricted from joining rooms until 2024-08-23 15:00:00.",
+                },
+              },
               "사용자가 참여하는 진행 중 방이 5개 이상": {
                 value: {
                   error: "Rooms/join : participating in too many rooms",

src/routes/docs/users.js

@@ -330,7 +330,7 @@ usersDocs[`${apiPrefix}/resetProfileImg`] = {
   },
 };
 
-usersDocs[`${apiPrefix}/isBanned`] = {
+usersDocs[`${apiPrefix}/getBanRecord`] = {
   get: {
     tags: [tag],
     summary: "본인의 현재 정지 기록을 가져움",
@@ -344,10 +344,10 @@ usersDocs[`${apiPrefix}/isBanned`] = {
               type: "array",
               items: {
                 properties: {
-                  userId: {
+                  userSid: {
                     type: "string",
-                    description: "사용자의 ObjectId",
-                    pattern: objectId.source,
+                    description: "사용자의 SSO ID",
+                    pattern: "monday-sid",
                   },
                   reason: {
                     type: "string",
@@ -364,85 +364,10 @@ usersDocs[`${apiPrefix}/isBanned`] = {
                     description: "정지 만료 시각",
                     example: "2024-05-21 12:00",
                   },
-                  services: {
-                    type: "array",
-                    items: {
-                      properties: {
-                        serviceName: {
-                          type: "string",
-                          description: "정지를 당한 서비스 또는 이벤트 이름",
-                        },
-                      },
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-      400: {
-        content: {
-          "text/html": {
-            example: "Users/isBanned : there is no ban record",
-          },
-        },
-      },
-      500: {
-        content: {
-          "text/html": {
-            example: "Users/isBanned : internal server error",
-          },
-        },
-      },
-    },
-  },
-};
-
-usersDocs[`${apiPrefix}/getBanRecord`] = {
-  get: {
-    tags: [tag],
-    summary: "본인의 모든 정지 기록을 가져움",
-    description:
-      "정지 기록들 중 본인인 경우에 해당하는 정지 기록을 모두 가져옴",
-    responses: {
-      200: {
-        content: {
-          "application/json": {
-            schema: {
-              type: "array",
-              items: {
-                properties: {
-                  userId: {
-                    type: "string",
-                    description: "사용자의 ObjectId",
-                    pattern: objectId.source,
-                  },
-                  reason: {
+                  serviceName: {
                     type: "string",
-                    description: "정지 사유",
-                    example: "미정산",
-                  },
-                  bannedAt: {
-                    type: "date",
-                    description: "정지 당한 시각",
-                    example: "2024-05-20 12:00",
-                  },
-                  expireAt: {
-                    type: "date",
-                    description: "정지 만료 시각",
-                    example: "2024-05-21 12:00",
-                  },
-                  services: {
-                    type: "array",
-                    items: {
-                      properties: {
-                        serviceName: {
-                          type: "string",
-                          description: "정지를 당한 서비스 또는 이벤트 이름",
-                        },
-                      },
-                    },
+                    description: "정지를 당한 서비스 또는 이벤트 이름",
+                    example: "2023-fall-event",
                   },
                 },
               },

src/routes/rooms.js

@@ -35,6 +35,9 @@ router.get(
 // 이후 API 접근 시 로그인 필요
 router.use(require("../middlewares/auth"));
 
+// 방 생성/참여전 ban 여부 확인
+router.use(require("../middlewares/ban"));
+
 // 특정 id 방 세부사항 보기
 router.get(
   "/info",

src/routes/users.js

@@ -56,9 +56,6 @@ router.get("/editProfileImg/done", userHandlers.editProfileImgDoneHandler);
 // 프로필 이미지를 기본값으로 재설정합니다.
 router.get("/resetProfileImg", userHandlers.resetProfileImgHandler);
 
-// 유저의 현재 유효한 서비스 정지 기록들만 반환합니다.
-router.get("/isBanned", userHandlers.isBannedHandler);
-
 // 유저의 서비스 정지 기록들을 모두 반환합니다.
 router.get("/getBanRecord", userHandlers.getBanRecordHandler);
 

src/services/users.js

@@ -200,27 +200,14 @@ const resetProfileImgHandler = async (req, res) => {
   }
 };
 
-const isBannedHandler = async (req, res) => {
-  try {
-    // 현재 시각이 expireAt 보다 작고 본인인 경우(ban의 userId가 userOid랑 같은 경우)의 record를 모두 가져옴
-    const result = await banModel.find({
-      userId: req.userOid,
-      expireAt: {
-        $gte: req.timestamp,
-      },
-    });
-    if (!result)
-      return res.status(500).send("Users/isBanned : internal server error");
-    res.status(200).json(result);
-  } catch (err) {
-    res.status(500).send("Users/isBanned : internal server error");
-  }
-};
-
 const getBanRecordHandler = async (req, res) => {
   try {
-    // 본인인 경우(ban의 userId가 userOid랑 같은 경우)의 record를 모두 가져옴
-    const result = await banModel.find({ userId: req.userOid });
+    // 본인인 경우(ban의 userId가 userSid랑 같은 경우)의 record를 모두 가져옴
+    const result = await banModel
+      .find({
+        userSid: req.session.loginInfo.sid,
+      })
+      .sort({ expireAt: -1 });
     if (!result)
       return res.status(500).send("Users/getBanRecord : internal server error");
     res.status(200).json(result);
@@ -238,6 +225,5 @@ module.exports = {
   editProfileImgDoneHandler,
   resetNicknameHandler,
   resetProfileImgHandler,
-  isBannedHandler,
   getBanRecordHandler,
 };