#341 2023 가을학기 추석 홍보 이벤트 위한 transactions

loadenv.js

@@ -39,4 +39,20 @@ module.exports = {
     report: process.env.SLACK_REPORT_WEBHOOK_URL || "", // optional
   },
   eventMode: undefined,
+  eventIds: {
+    // required if eventMode === "2023fall"
+    firstLogin: process.env.EVENT_2023FALL_FIRST_LOGIN_ID,
+    payingAndSending: process.env.EVENT_2023FALL_PAYING_AND_SENDING_ID,
+    firstRoomCreation: process.env.EVENT_2023FALL_FIRST_ROOM_CREATION_ID,
+    roomSharing: process.env.EVENT_2023FALL_ROOM_SHARING_ID,
+    paying: process.env.EVENT_2023FALL_PAYING_ID,
+    sending: process.env.EVENT_2023FALL_SENDING_ID,
+    nicknameChanging: process.env.EVENT_2023FALL_NICKNAME_CHANGING_ID,
+    accountChanging: process.env.EVENT_2023FALL_ACCOUNT_CHANGING_ID,
+    adPushAgreement: process.env.EVENT_2023FALL_AD_PUSH_AGREEMENT_ID,
+    eventSharingOnInstagram:
+      process.env.EVENT_2023FALL_EVENT_SHARING_ON_INSTAGRAM_ID,
+    purchaseSharingOnInstagram:
+      process.env.EVENT_2023FALL_PURCHASE_SHARING_ON_INSTAGRAM_ID,
+  },
 };

src/lottery/index.js

@@ -6,17 +6,13 @@ const {
   transactionModel,
 } = require("./modules/stores/mongo");
 
+const { eventMode } = require("../../loadenv");
 const { buildResource } = require("../modules/adminResource");
-const { instagramRewardAction } = require("./modules/admin");
+const logger = require("../modules/logger");
 
 // [Routes] 기존 docs 라우터의 docs extend
 require("./routes/docs")();
 
-// [Middleware] 목표 달성 여부 검증
-const checkReward = (req, res, next) => {
-  next();
-};
-
 const lotteryRouter = express.Router();
 
 // [Middleware] 모든 API 요청에 대하여 origin 검증
@@ -27,15 +23,26 @@ lotteryRouter.use("/global-state", require("./routes/globalState"));
 lotteryRouter.use("/transactions", require("./routes/transactions"));
 lotteryRouter.use("/items", require("./routes/items"));
 
-const eventStatusResource = buildResource([instagramRewardAction])(
-  eventStatusModel
-);
-const otherResources = [eventModel, itemModel, transactionModel].map(
-  buildResource()
-);
+const resources = [
+  eventStatusModel,
+  eventModel,
+  itemModel,
+  transactionModel,
+].map(buildResource());
+
+const contracts = eventMode ? require(`./modules/contracts/${eventMode}`) : {};
+const getContract = (name) => {
+  const contract = contracts[name];
+  if (contract) return contract;
+
+  if (eventMode) {
+    logger.error(`Contract ${name}를 찾을 수 없습니다.`);
+  }
+  return () => null;
+};
 
 module.exports = {
-  checkReward,
   lotteryRouter,
-  resources: [eventStatusResource, ...otherResources],
+  resources,
+  getContract,
 };

src/lottery/modules/contracts/2023fall.js

@@ -0,0 +1,86 @@
+const { eventIds } = require("../../../../loadenv");
+const { eventHandler } = require("../events");
+
+// 로그인할 때마다 호출해 주세요.
+// 사용된 곳: auth/tryLogin, auth.mobile/tokenLoginHandler
+const requestFirstLoginEvent = async (userId) => {
+  return await eventHandler(userId, eventIds.firstLogin);
+};
+
+// 정산 요청 또는 송금이 이루어질 때마다 호출해 주세요.
+// 사용된 곳: rooms/commitPaymentHandler, rooms/settlementHandler
+const requestPayingAndSendingEvent = async (roomObject) => {
+  if (roomObject.part.length < 2) return null;
+  if (roomObject.part.length > roomObject.settlementTotal) return null;
+
+  return await Promise.all(
+    roomObject.part.map(
+      async (participant) =>
+        await eventHandler(participant.user._id, eventIds.payingAndSending)
+    )
+  );
+};
+
+// 방을 만들 때마다 호출해 주세요.
+// 사용된 곳: rooms/createHandler
+const requestFirstRoomCreation = async (userId) => {
+  return await eventHandler(userId, eventIds.firstRoomCreation);
+};
+
+const requestRoomSharingEvent = async () => {
+  // TODO
+};
+
+// 정산 요청이 이루어질 때마다 호출해 주세요.
+// 사용된 곳: rooms/commitPaymentHandler
+const requestPayingEvent = async (userId, roomObject) => {
+  if (roomObject.part.length < 2) return null;
+
+  return await eventHandler(userId, eventIds.paying);
+};
+
+// 송금이 이루어질 때마다 호출해 주세요.
+// 사용된 곳: rooms/settlementHandler
+const requestSendingEvent = async (userId, roomObject) => {
+  if (roomObject.part.length < 2) return null;
+
+  return await eventHandler(userId, eventIds.sending);
+};
+
+// 닉네임을 변경할 때마다 호출해 주세요.
+// 사용된 곳: users/editNicknameHandler
+const requestNicknameChangingEvent = async (userId) => {
+  return await eventHandler(userId, eventIds.nicknameChanging);
+};
+
+// 계좌를 변경할 때마다 호출해 주세요.
+// 사용된 곳: users/editAccountHandler
+const requestAccountChangingEvent = async (userId) => {
+  return await eventHandler(userId, eventIds.accountChanging);
+};
+
+const requestAdPushAgreementEvent = async () => {
+  // TODO
+};
+
+const requestEventSharingOnInstagram = async () => {
+  // TODO
+};
+
+const requestPurchaseSharingOnInstagram = async () => {
+  // TODO
+};
+
+module.exports = {
+  requestFirstLoginEvent,
+  requestPayingAndSendingEvent,
+  requestFirstRoomCreation,
+  requestRoomSharingEvent,
+  requestPayingEvent,
+  requestSendingEvent,
+  requestNicknameChangingEvent,
+  requestAccountChangingEvent,
+  requestAdPushAgreementEvent,
+  requestEventSharingOnInstagram,
+  requestPurchaseSharingOnInstagram,
+};

src/lottery/modules/events.js

@@ -0,0 +1,77 @@
+const {
+  eventStatusModel,
+  eventModel,
+  transactionModel,
+} = require("./stores/mongo");
+const logger = require("../../modules/logger");
+
+const eventHandler = async (userId, eventId) => {
+  try {
+    logger.info(
+      `eventHandler(userId=${userId}, eventId=${eventId}) 함수가 호출되었습니다.`
+    );
+
+    const event = await eventModel.findOne({ _id: eventId }).lean();
+    if (!event) {
+      logger.error(`알 수 없는 이벤트 ID 입니다: ${eventId}`); // 프로그래머의 실수로 인해서만 발생하므로 logger를 통해 오류를 알립니다.
+      return null;
+    }
+
+    const eventStatus = await eventStatusModel.findOne({ userId }).lean();
+    const eventCount = eventStatus.eventList.filter(
+      (event) => event.toString() === eventId
+    ).length;
+    if (eventCount >= event.maxCount) {
+      logger.info(
+        `eventHandler(userId=${userId}, eventId=${eventId}) 함수가 종료되었습니다: 이미 최대로 달성한 이벤트입니다.`
+      );
+      return null;
+    }
+
+    const now = Date.now();
+    if (now < event.startat || now > event.expireat) {
+      logger.info(
+        `eventHandler(userId=${userId}, eventId=${eventId}) 함수가 종료되었습니다: 달성할 수 있는 기간이 아닙니다.`
+      );
+      return null;
+    }
+
+    await eventStatusModel.updateOne(
+      { userId },
+      {
+        $inc: {
+          creditAmount: event.rewardAmount,
+        },
+        $push: {
+          eventList: eventId,
+        },
+      }
+    );
+
+    const transaction = new transactionModel({
+      type: "get",
+      amount: event.rewardAmount,
+      userId,
+      event: eventId,
+      comment: `${event.name} 달성 - ${event.rewardAmount}개 획득`,
+    });
+    await transaction.save();
+
+    logger.info(
+      `eventHandler(userId=${userId}, eventId=${eventId}) 함수가 종료되었습니다: 성공했습니다.`
+    );
+    return {
+      event,
+      transactionId: transaction._id,
+    };
+  } catch (err) {
+    logger.error(
+      `eventHandler(userId=${userId}, eventId=${eventId}) 함수에서 예외가 발생했습니다: ${err}`
+    );
+    return null;
+  }
+};
+
+module.exports = {
+  eventHandler,
+};

src/lottery/modules/stores/mongo.js

@@ -42,6 +42,10 @@ const eventSchema = Schema({
     min: 0,
     validate: integerValidator,
   },
+  startat: {
+    type: Date,
+    required: true,
+  },
   expireat: {
     type: Date,
     required: true,

src/lottery/routes/docs/globalState.js

@@ -66,6 +66,11 @@ globalStateDocs[`${apiPrefix}/`] = {
                         description: "최대 달성 가능 횟수",
                         example: 1,
                       },
+                      startat: {
+                        type: "string",
+                        description: "달성할 수 있는 처음 시각",
+                        example: "2023-01-01 00:00:00",
+                      },
                       expireat: {
                         type: "string",
                         description: "달성할 수 있는 마지막 시각",

src/lottery/routes/docs/transactions.js

@@ -62,6 +62,11 @@ transactionsDocs[`${apiPrefix}/`] = {
                             description: "최대 달성 가능 횟수",
                             example: 1,
                           },
+                          startat: {
+                            type: "string",
+                            description: "달성할 수 있는 처음 시각",
+                            example: "2023-01-01 00:00:00",
+                          },
                           expireat: {
                             type: "string",
                             description: "달성할 수 있는 마지막 시각",

src/modules/adminResource.js

@@ -57,6 +57,8 @@ const defaultActionLogFeature = buildFeature({
 });
 
 const recordActionAfterHandler = (actions) => async (res, req, context) => {
+  if (!res.response) return res;
+
   const actionsWrapper = Array.isArray(actions) ? actions : [actions];
   for (const action of actionsWrapper) {
     if (typeof action === "string") {

src/services/auth.js

@@ -16,6 +16,9 @@ const {
 const jwt = require("../modules/auths/jwt");
 const logger = require("../modules/logger");
 
+// 이벤트 코드입니다.
+const { getContract } = require("../lottery");
+
 // SPARCS SSO
 const Client = require("../modules/auths/sparcssso");
 const client = new Client(sparcsssoEnv?.id, sparcsssoEnv?.key);
@@ -91,6 +94,10 @@ const tryLogin = async (req, res, userData, redirectOrigin, redirectPath) => {
     }
 
     login(req, userData.sid, user.id, user._id, user.name);
+
+    // 이벤트 코드입니다.
+    await getContract("requestFirstLoginEvent")(user._id);
+
     res.redirect(new URL(redirectPath, redirectOrigin).href);
   } catch (err) {
     logger.error(err);