#527 회원 탈퇴 구현

.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /dist
+.tsbuildinfo
 /dump
 .env
 .env.test

src/lottery/services/globalState.js

@@ -95,7 +95,7 @@ const createUserGlobalStateHandler = async (req, res) => {
         error: "GlobalState/create : invalid inviter",
       });
 
-    const user = await userModel.findById(req.userOid);
+    const user = await userModel.findOne({ _id: req.userOid, withdraw: false });
     if (!user)
       return res
         .status(500)

src/lottery/services/invites.js

@@ -24,7 +24,10 @@ const searchInviterHandler = async (req, res) => {
 
     // 해당되는 유저의 닉네임과 프로필 이미지를 가져옵니다.
     const inviter = await userModel
-      .findById(inviterStatus.userId, "nickname profileImageUrl")
+      .findOne(
+        { _id: inviterStatus.userId, withdraw: false },
+        "nickname profileImageUrl"
+      )
       .lean();
     if (!inviter)
       return res

src/lottery/services/items.js

@@ -125,7 +125,13 @@ const getItemLeaderboardHandler = async (req, res) => {
       leaderboardBase
         .filter((user) => user.rank <= 20)
         .map(async (user) => {
-          const userInfo = await userModel.findById(user.userId).lean();
+          const userInfo = await userModel
+            .findOne({ _id: user.userId, withdraw: false })
+            .lean();
+          if (!userInfo) {
+            logger.error(`Fail to find user ${user.userId}`);
+            return null;
+          }
           return {
             nickname: userInfo.nickname,
             profileImageUrl: userInfo.profileImageUrl,
@@ -135,6 +141,10 @@ const getItemLeaderboardHandler = async (req, res) => {
           };
         })
     );
+    if (leaderboard.includes(null))
+      return res
+        .status(500)
+        .json({ error: "Items/leaderboard : internal server error" });
 
     const userId = isLogin(req) ? getLoginInfo(req).oid : null;
     const user = leaderboardBase.find(

src/lottery/services/publicNotice.js

@@ -41,7 +41,7 @@ const getRecentPurchaceItemListHandler = async (req, res) => {
         .find({ type: "use", itemType: 0 })
         .sort({ createAt: -1 })
         .limit(1000)
-        .populate(publicNoticePopulateOption)
+        .populate(publicNoticePopulateOption) // TODO: 회원 탈퇴 핸들링
         .lean()
     )
       .sort(
@@ -132,7 +132,9 @@ const getTicketLeaderboardHandler = async (req, res) => {
       );
     const leaderboard = await Promise.all(
       sortedUsers.slice(0, 20).map(async (user) => {
-        const userInfo = await userModel.findOne({ _id: user.userId }).lean();
+        const userInfo = await userModel
+          .findOne({ _id: user.userId, withdraw: false })
+          .lean();
         if (!userInfo) {
           logger.error(`Fail to find user ${user.userId}`);
           return null;
@@ -211,7 +213,9 @@ const getGroupLeaderboardHandler = async (req, res) => {
         if (mvp?.length !== 1)
           throw new Error(`Fail to find MVP in group ${group.group}`);
 
-        const mvpInfo = await userModel.findOne({ _id: mvp[0].userId }).lean();
+        const mvpInfo = await userModel
+          .findOne({ _id: mvp[0].userId, withdraw: false })
+          .lean();
         if (!mvpInfo) throw new Error(`Fail to find user ${mvp[0].userId}`);
 
         return {

src/middlewares/auth.ts

@@ -8,9 +8,9 @@ const authMiddleware: RequestHandler = (req, res, next) => {
       error: "not logged in",
     });
 
-  const { id, oid } = getLoginInfo(req);
-  req.userId = id;
+  const { oid } = getLoginInfo(req);
   req.userOid = oid;
+
   next();
 };
 

src/middlewares/authAdmin.ts

@@ -11,8 +11,8 @@ const authAdminMiddleware: RequestHandler = async (req, res, next) => {
     if (!isLogin(req)) return res.redirect(redirectUrl);
 
     // 관리자 유무를 확인
-    const { id } = getLoginInfo(req);
-    const user = await userModel.findOne({ id });
+    const { oid } = getLoginInfo(req);
+    const user = await userModel.findOne({ _id: oid, withdraw: false });
     if (!user?.isAdmin) return res.redirect(redirectUrl);
 
     // 접속한 IP가 화이트리스트에 있는지 확인

src/modules/ban.ts

@@ -32,7 +32,7 @@ export const validateServiceBanRecord = async (
       .toISOString()
       .replace("T", " ")
       .split(".")[0];
-    const banErrorMessage = `${req.originalUrl} : user ${req.userId} (${
+    const banErrorMessage = `${req.originalUrl} : user ${req.userOid} (${
       req.session.loginInfo!.sid
     }) is temporarily restricted from service until ${formattedExpireAt}.`;
     return banErrorMessage;

src/modules/fcm.ts

@@ -93,6 +93,28 @@ export const unregisterDeviceToken = async (deviceToken: string) => {
   }
 };
 
+/**
+ * 사용자의 ObjectId가 주어졌을 때, 해당 사용자의 모든 deviceToken을 DB에서 삭제합니다.
+ * @param userId - 사용자의 ObjectId입니다.
+ * @return 해당 사용자로부터 deviceToken을 삭제하는 데 성공하면 true, 실패하면 false를 반환합니다. 삭제할 deviceToken이 존재하지 않는 경우에는 true를 반환합니다.
+ */
+export const unregisterAllDeviceTokens = async (userId: string) => {
+  try {
+    // 사용자의 디바이스 토큰을 DB에서 가져옵니다.
+    // getTokensOfUsers 함수의 정의는 아래에 있습니다. (호이스팅)
+    const tokens = await getTokensOfUsers([userId]);
+
+    // 디바이스 토큰과 관련 설정을 DB에서 삭제합니다.
+    await deviceTokenModel.deleteMany({ userId });
+    await notificationOptionModel.deleteMany({ deviceToken: { $in: tokens } });
+
+    return true;
+  } catch (error) {
+    logger.error(error);
+    return false;
+  }
+};
+
 /**
  * 메시지 전송에 실패한 deviceToken을 DB에서 삭제합니다.
  * @param deviceTokens - 사용자의 ObjectId입니다.

src/modules/populates/chats.ts

@@ -4,9 +4,15 @@ import type { User, Chat } from "@/types/mongo";
  * 쿼리를 통해 얻은 Chat Document를 populate할 설정값을 정의합니다.
  */
 export const chatPopulateOption = [
-  { path: "authorId", select: "_id nickname profileImageUrl" },
+  {
+    path: "authorId",
+    select: "_id nickname profileImageUrl withdraw",
+  },
 ];
 
 export interface PopulatedChat extends Omit<Chat, "authorId"> {
-  authorId?: Pick<User, "_id" | "nickname" | "profileImageUrl">;
+  authorId: Pick<
+    User,
+    "_id" | "nickname" | "profileImageUrl" | "withdraw"
+  > | null;
 }

src/modules/populates/reports.ts

@@ -3,13 +3,13 @@ import type { User, Report } from "@/types/mongo";
 export const reportPopulateOption = [
   {
     path: "reportedId",
-    select: "_id id name nickname profileImageUrl",
+    select: "_id id name nickname profileImageUrl withdraw",
   },
 ];
 
 export interface PopulatedReport extends Omit<Report, "reportedId"> {
   reportedId: Pick<
     User,
-    "_id" | "id" | "name" | "nickname" | "profileImageUrl"
-  >;
+    "_id" | "id" | "name" | "nickname" | "profileImageUrl" | "withdraw"
+  > | null;
 }

src/modules/populates/rooms.ts

@@ -15,28 +15,47 @@ export const roomPopulateOption = [
   {
     path: "part",
     select: "-_id user settlementStatus readAt",
-    populate: { path: "user", select: "_id id name nickname profileImageUrl" },
+    populate: {
+      path: "user",
+      select: "_id id name nickname profileImageUrl withdraw",
+    },
   },
 ];
 
 interface PopulatedParticipant
   extends Pick<Participant, "settlementStatus" | "readAt"> {
-  user: Pick<User, "_id" | "id" | "name" | "nickname" | "profileImageUrl">;
+  user: Pick<
+    User,
+    "_id" | "id" | "name" | "nickname" | "profileImageUrl" | "withdraw"
+  > | null;
 }
 
 export interface PopulatedRoom extends Omit<Room, "from" | "to" | "part"> {
-  from: Pick<Location, "_id" | "koName" | "enName">;
-  to: Pick<Location, "_id" | "koName" | "enName">;
-  part?: PopulatedParticipant[];
+  from: Pick<Location, "_id" | "koName" | "enName"> | null;
+  to: Pick<Location, "_id" | "koName" | "enName"> | null;
+  part: PopulatedParticipant[];
 }
 
-export interface FormattedRoom
-  extends Omit<PopulatedRoom, "part" | "settlementTotal"> {
-  part?: {
+interface FormattedLocation {
+  _id: string;
+  enName: string;
+  koName: string;
+}
+
+export interface FormattedRoom {
+  _id: string;
+  name: string;
+  from: FormattedLocation;
+  to: FormattedLocation;
+  time: Date;
+  madeat: Date;
+  maxPartLength: number;
+  part: {
     _id: string;
     name: string;
     nickname: string;
     profileImageUrl: string;
+    withdraw: boolean;
     isSettlement?: SettlementStatus;
     readAt: Date;
   }[];
@@ -61,15 +80,27 @@ export const formatSettlement = (
 ): FormattedRoom => {
   return {
     ...roomObject,
-    part: roomObject.part?.map((participantSubDocument) => {
-      const { _id, name, nickname, profileImageUrl } =
-        participantSubDocument.user;
+    _id: roomObject._id!.toString(),
+    from: {
+      _id: roomObject.from!._id!.toString(),
+      enName: roomObject.from!.enName,
+      koName: roomObject.from!.koName,
+    },
+    to: {
+      _id: roomObject.to!._id!.toString(),
+      enName: roomObject.to!.enName,
+      koName: roomObject.to!.koName,
+    },
+    part: roomObject.part.map((participantSubDocument) => {
+      const { _id, name, nickname, profileImageUrl, withdraw } =
+        participantSubDocument.user!;
       const { settlementStatus, readAt } = participantSubDocument;
       return {
-        _id,
+        _id: _id!.toString(),
         name,
         nickname,
         profileImageUrl,
+        withdraw,
         isSettlement: includeSettlement ? settlementStatus : undefined,
         readAt: readAt ?? roomObject.madeat,
       };
@@ -89,7 +120,7 @@ export const formatSettlement = (
 export const getIsOver = (roomObject: PopulatedRoom, userId: string) => {
   // room document의 part subdoocument에서 사용자 id와 일치하는 정산 정보를 찾습니다.
   const participantSubDocuments = roomObject.part?.filter((part) => {
-    return part.user.id === userId;
+    return part.user?.id === userId;
   });
 
   // 방에 참여중이지 않은 사용자의 경우, undefined을 반환합니다.

src/modules/socket.js

@@ -35,8 +35,11 @@ const transformChatsForRoom = async (chats) => {
       const inOutUserIds = chat.content.split("|");
       chat.inOutNames = await Promise.all(
         inOutUserIds.map(async (userId) => {
-          const user = await userModel.findOne({ id: userId }, "nickname");
-          return user.nickname;
+          const user = await userModel.findOne(
+            { id: userId, withdraw: false }, // NOTE: SSO uid 쓰는 곳
+            "nickname"
+          );
+          return user?.nickname;
         })
       );
     }
@@ -46,6 +49,7 @@ const transformChatsForRoom = async (chats) => {
       authorId: chat.authorId?._id,
       authorName: chat.authorId?.nickname,
       authorProfileUrl: chat.authorId?.profileImageUrl,
+      authorIsWithdrew: chat.authorId?.withdraw,
       content: chat.content,
       time: chat.time,
       isValid: chat.isValid,
@@ -136,7 +140,10 @@ const emitChatEvent = async (io, chat) => {
 
     // chat optionally contains authorId
     const { nickname, profileImageUrl } = authorId
-      ? await userModel.findById(authorId, "nickname profileImageUrl")
+      ? await userModel.findOne(
+          { _id: authorId, withdraw: false },
+          "nickname profileImageUrl"
+        )
       : {};
     if (authorId && (!nickname || !profileImageUrl)) {
       throw new IllegalArgumentsException();
@@ -163,9 +170,6 @@ const emitChatEvent = async (io, chat) => {
       .lean()
       .populate(chatPopulateOption);
 
-    chatDocument.authorName = nickname;
-    chatDocument.authorProfileUrl = profileImageUrl;
-
     const userIds = part.map((participant) => participant.user);
     const userIdsExceptAuthor = authorId
       ? part

src/modules/stores/mongo.ts

@@ -19,11 +19,12 @@ import type {
 const userSchema = new Schema<User>({
   name: { type: String, required: true }, //실명
   nickname: { type: String, required: true }, //닉네임
-  id: { type: String, required: true, unique: true }, //택시 서비스에서만 사용되는 id
+  id: { type: String, required: true }, //택시 서비스에서만 사용되는 id
   profileImageUrl: { type: String, required: true }, //백엔드에서의 프로필 이미지 경로
   ongoingRoom: [{ type: Schema.Types.ObjectId, ref: "Room" }], // 참여중인 진행중인 방 배열
   doneRoom: [{ type: Schema.Types.ObjectId, ref: "Room" }], // 참여중인 완료된 방 배열
-  withdraw: { type: Boolean, default: false },
+  withdraw: { type: Boolean, default: false }, //탈퇴 여부
+  withdrawAt: { type: Date }, //탈퇴 시각
   phoneNumber: { type: String }, // 전화번호 (2023FALL 이벤트부터 추가)
   ban: { type: Boolean, default: false }, //계정 정지 여부
   joinat: { type: Date, required: true }, //가입 시각

src/routes/docs/users.js

@@ -393,4 +393,35 @@ usersDocs[`${apiPrefix}/getBanRecord`] = {
   },
 };
 
+usersDocs[`${apiPrefix}/withdraw`] = {
+  post: {
+    tags: [tag],
+    summary: "회원 탈퇴",
+    description: "회원 탈퇴를 요청합니다.",
+    responses: {
+      200: {
+        content: {
+          "text/html": {
+            example: "Users/withdraw : withdraw successful",
+          },
+        },
+      },
+      400: {
+        content: {
+          "text/html": {
+            example: "Users/withdraw : ongoing room exists",
+          },
+        },
+      },
+      500: {
+        content: {
+          "text/html": {
+            example: "Users/withdraw : internal server error",
+          },
+        },
+      },
+    },
+  },
+};
+
 module.exports = usersDocs;

src/routes/users.ts

@@ -59,4 +59,7 @@ router.get("/resetProfileImg", userHandlers.resetProfileImgHandler);
 // 유저의 서비스 정지 기록들을 모두 반환합니다.
 router.get("/getBanRecord", userHandlers.getBanRecordHandler);
 
+// 회원 탈퇴를 요청합니다.
+router.post("/withdraw", userHandlers.withdrawHandler);
+
 export default router;