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

src/modules/ban.js

@@ -0,0 +1,64 @@
+const logger = require("./logger");
+const { banModel } = require("./stores/mongo");
+
+/**
+ *
+ * @param {*} req
+ * @param {String} service
+ */
+const validateServiceBanRecord = async (req, service) => {
+  switch (service) {
+    case "Rooms/create":
+    case "Rooms/join":
+      var _serviceName = "service";
+      break;
+    default:
+      logger.error(
+        "Error occured while validateServiceBanRecord: given service is not defined."
+      );
+      return;
+  }
+  try {
+    // 현재 시각이 expireAt 보다 작고, 본인인 경우(ban의 userId가 userId랑 같은 경우) 중 serviceName이 "service"인 record를 모두 가져옴
+    const bans = await banModel.find({
+      userSid: req.session.loginInfo.sid,
+      expireAt: {
+        $gte: req.timestamp,
+      },
+      serviceName: _serviceName,
+    });
+    var banRecord = undefined;
+    if (bans.length > 0) {
+      // 가장 expireAt이 큰 정지 기록만 반환함.
+      var banRecord = bans.reduce(
+        (max, ban) => (ban.expireAt > max.expireAt ? ban : max),
+        bans[0]
+      );
+    }
+  } catch (err) {
+    logger.error(
+      "Error occured while getValidServiceBanRecord: " + err.message
+    );
+    return;
+  }
+  if (banRecord != undefined) {
+    const formattedExpireAt = banRecord.expireAt
+      .toISOString()
+      .replace("T", " ")
+      .split(".")[0];
+    switch (service) {
+      case "Rooms/create":
+        var banErrorMessage = `Rooms/create : user ${req.userId} (${req.session.loginInfo.sid}) is temporarily restricted from creating rooms until ${formattedExpireAt}.`;
+        break;
+      case "Rooms/join":
+        var banErrorMessage = `Rooms/join : user ${req.userId} (${req.session.loginInfo.sid}) is temporarily restricted from joining rooms until ${formattedExpireAt}.`;
+        break;
+    }
+    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

@@ -346,8 +346,8 @@ usersDocs[`${apiPrefix}/isBanned`] = {
                 properties: {
                   userId: {
                     type: "string",
-                    description: "사용자의 ObjectId",
-                    pattern: objectId.source,
+                    description: "사용자의 SSO ID",
+                    pattern: "monday-sid",
                   },
                   reason: {
                     type: "string",
@@ -364,16 +364,10 @@ usersDocs[`${apiPrefix}/isBanned`] = {
                     description: "정지 만료 시각",
                     example: "2024-05-21 12:00",
                   },
-                  services: {
-                    type: "array",
-                    items: {
-                      properties: {
-                        serviceName: {
-                          type: "string",
-                          description: "정지를 당한 서비스 또는 이벤트 이름",
-                        },
-                      },
-                    },
+                  serviceName: {
+                    type: "string",
+                    description: "정지를 당한 서비스 또는 이벤트 이름",
+                    example: "2023-fall-event",
                   },
                 },
               },
@@ -415,8 +409,8 @@ usersDocs[`${apiPrefix}/getBanRecord`] = {
                 properties: {
                   userId: {
                     type: "string",
-                    description: "사용자의 ObjectId",
-                    pattern: objectId.source,
+                    description: "사용자의 SSO ID",
+                    example: "monday-sid",
                   },
                   reason: {
                     type: "string",
@@ -433,16 +427,10 @@ usersDocs[`${apiPrefix}/getBanRecord`] = {
                     description: "정지 만료 시각",
                     example: "2024-05-21 12:00",
                   },
-                  services: {
-                    type: "array",
-                    items: {
-                      properties: {
-                        serviceName: {
-                          type: "string",
-                          description: "정지를 당한 서비스 또는 이벤트 이름",
-                        },
-                      },
-                    },
+                  serviceName: {
+                    type: "string",
+                    description: "정지를 당한 서비스 또는 이벤트 이름",
+                    example: "2023-fall-event",
                   },
                 },
               },

src/services/rooms.js

@@ -21,11 +21,20 @@ const eventPeriod = eventConfig && {
   endAt: new Date(eventConfig.period.endAt),
 };
 const { contracts } = require("../lottery");
+const { validateServiceBanRecord } = require("../modules/ban");
 
 const createHandler = async (req, res) => {
   const { name, from, to, time, maxPartLength } = req.body;
 
   try {
+    // 사용자가 방 생성 기능에 대하여 이용 정지 상태인지 확인합니다.
+    const banErrorMessage = await validateServiceBanRecord(req, "Rooms/create");
+    if (banErrorMessage != undefined) {
+      return res.status(400).json({
+        error: banErrorMessage,
+      });
+    }
+
     if (from === to) {
       return res.status(400).json({
         error: "Rooms/create : locations are same",
@@ -237,6 +246,14 @@ const joinHandler = async (req, res) => {
       .findOne({ id: req.userId })
       .populate("ongoingRoom");
 
+    // 사용자가 방 참여 기능에 대하여 이용 정지 상태인지 확인합니다.
+    const banErrorMessage = await validateServiceBanRecord(req, "Rooms/join");
+    if (banErrorMessage != undefined) {
+      return res.status(400).json({
+        error: banErrorMessage,
+      });
+    }
+
     // 사용자의 참여중인 진행중인 방이 5개 이상이면 오류를 반환합니다.
     if (user.ongoingRoom.length >= 5) {
       return res.status(400).json({