diff --git a/src/lottery/index.js b/src/lottery/index.js index 410097be..7ca282fe 100644 --- a/src/lottery/index.js +++ b/src/lottery/index.js @@ -1,22 +1,17 @@ const express = require("express"); const { eventStatusModel, - eventModel, + questModel, itemModel, transactionModel, } = require("./modules/stores/mongo"); +const { eventMode } = require("../../loadenv"); const { buildResource } = require("../modules/adminResource"); -const { instagramRewardAction } = require("./modules/admin"); // [Routes] 기존 docs 라우터의 docs extend require("./routes/docs")(); -// [Middleware] 목표 달성 여부 검증 -const checkReward = (req, res, next) => { - next(); -}; - const lotteryRouter = express.Router(); // [Middleware] 모든 API 요청에 대하여 origin 검증 @@ -28,15 +23,17 @@ lotteryRouter.use("/transactions", require("./routes/transactions")); lotteryRouter.use("/items", require("./routes/items")); lotteryRouter.use("/public-notice", require("./routes/publicNotice")); -const eventStatusResource = buildResource([instagramRewardAction])( - eventStatusModel -); -const otherResources = [eventModel, itemModel, transactionModel].map( - buildResource() -); +const resources = [ + eventStatusModel, + questModel, + itemModel, + transactionModel, +].map(buildResource()); + +const contracts = eventMode && require(`./modules/contracts/${eventMode}`); module.exports = { - checkReward, lotteryRouter, - resources: [eventStatusResource, ...otherResources], + resources, + contracts, }; diff --git a/src/lottery/modules/admin.js b/src/lottery/modules/admin.js deleted file mode 100644 index 337d7d96..00000000 --- a/src/lottery/modules/admin.js +++ /dev/null @@ -1,74 +0,0 @@ -const { useUserCreditAmount } = require("./credit"); -const { transactionModel } = require("./stores/mongo"); -const { recordAction } = require("../../modules/adminResource"); -const { eventEnv } = require("../../../loadenv"); - -/** eventId가 없는 경우 null이 아닌 undefined를 넣어야 합니다. */ -const creditTransfer = async (userId, amount, eventId, comment) => { - const user = await useUserCreditAmount(userId); - await user.update(amount); - - const transaction = new transactionModel({ - type: "get", - amount, - userId, - event: eventId, - comment, - }); - await transaction.save(); - - return transaction._id; -}; - -/** itemId가 없는 경우 null이 아닌 undefined를 넣어야 합니다. */ -/** itemType이 없는 경우 null이 아닌 undefined를 넣어야 합니다. */ -const creditWithdraw = async (userId, amount, itemId, itemType, comment) => { - const user = await useUserCreditAmount(userId); - await user.update(-amount); - - const transaction = new transactionModel({ - type: "use", - amount, - userId, - item: itemId, - itemType, - comment, - }); - await transaction.save(); - - return transaction._id; -}; - -const instagramRewardActionHandler = async (req, res, context) => { - const transactionId = await creditTransfer( - context?.record?.params?.userId, - eventEnv.instagramReward, - eventEnv.instagramEventId, - eventEnv.instagramComment - ); - - let record = context.record.toJSON(context.currentAdmin); - record.params.creditAmount += eventEnv.instagramReward; - - return { - record, - transactionId, - }; -}; -const instagramRewardActionLogs = [ - "update", - { - action: "create", - target: (res, req, context) => `Transaction(_id = ${res.transactionId})`, - }, -]; - -const instagramRewardAction = recordAction( - "instagramReward", - instagramRewardActionHandler, - instagramRewardActionLogs -); - -module.exports = { - instagramRewardAction, -}; diff --git a/src/lottery/modules/contracts/2023fall.js b/src/lottery/modules/contracts/2023fall.js new file mode 100644 index 00000000..f5994d51 --- /dev/null +++ b/src/lottery/modules/contracts/2023fall.js @@ -0,0 +1,214 @@ +const { buildQuests, completeQuest } = require("../quests"); +const mongoose = require("mongoose"); + +/** 전체 퀘스트 목록입니다. */ +const quests = buildQuests({ + firstLogin: { + name: "이벤트 기간 첫 로그인", + description: "", + imageUrl: "", + reward: { + ticket1: 1, + }, + }, + payingAndSending: { + name: "2명 이상 탑승한 방에서 정산/송금 완료", + description: "", + imageUrl: "", + reward: 300, + maxCount: 3, + }, + firstRoomCreation: { + name: "첫 방 개설", + description: "", + imageUrl: "", + reward: 50, + }, + roomSharing: { + name: "방 공유하기", + description: "", + imageUrl: "", + reward: 50, + }, + paying: { + name: "2명 이상 탑승한 방에서 정산하기", + description: "", + imageUrl: "", + reward: 100, + maxCount: 3, + }, + sending: { + name: "2명 이상 탑승한 방에서 송금하기", + description: "", + imageUrl: "", + reward: 50, + maxCount: 3, + }, + nicknameChaning: { + name: "닉네임 변경", + description: "", + imageUrl: "", + reward: 50, + }, + accountChanging: { + name: "계좌 등록 또는 변경", + description: "", + imageUrl: "", + reward: 50, + }, + adPushAgreement: { + name: "광고성 푸시 알림 수신 동의", + description: "", + imageUrl: "", + reward: 50, + }, + eventSharingOnInstagram: { + name: "이벤트 인스타그램 스토리에 공유", + description: "", + imageUrl: "", + reward: 100, + }, + purchaseSharingOnInstagram: { + name: "아이템 구매 후 인스타그램 스토리에 공유", + description: "", + imageUrl: "", + reward: 100, + }, +}); + +const eventPeriod = { + start: new Date("2023-09-25T00:00:00+09:00"), // Inclusive + end: new Date("2023-10-10T00:00:00+09:00"), // Exclusive +}; + +/** + * firstLogin 퀘스트의 완료를 요청합니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @returns {Promise} + */ +const completeFirstLoginQuest = async (userId) => { + return await completeQuest(userId, eventPeriod, quests.firstLogin); +}; + +/** + * payingAndSending 퀘스트의 완료를 요청합니다. 방의 참가자 수가 2명 미만이거나, 모든 참가자가 정산 또는 송금을 완료하지 않았다면 요청하지 않습니다. + * @param {Object} roomObject - 방의 정보입니다. + * @param {Array<{ user: mongoose.Types.ObjectId }>} roomObject.part - 참여자 목록입니다. + * @param {number} roomObject.settlementTotal - 정산 또는 송금이 완료된 참여자 수입니다. + * @returns {Promise} + * @description 정산 요청 또는 송금이 이루어질 때마다 호출해 주세요. + * @usage rooms/commitPaymentHandler, rooms/settlementHandler + */ +const completePayingAndSendingQuest = 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 completeQuest( + participant.user._id, + eventPeriod, + quests.payingAndSending + ) + ) + ); +}; + +/** + * firstRoomCreation 퀘스트의 완료를 요청합니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @returns {Promise} + * @description 방을 만들 때마다 호출해 주세요. + * @usage rooms/createHandler + */ +const completeFirstRoomCreationQuest = async (userId) => { + return await completeQuest(userId, eventPeriod, quests.firstRoomCreation); +}; + +const completeRoomSharingQuest = async () => { + // TODO +}; + +/** + * paying 퀘스트의 완료를 요청합니다. 방의 참가자 수가 2명 미만이면 요청하지 않습니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @param {Object} roomObject - 방의 정보입니다. + * @param {Array<{ user: mongoose.Types.ObjectId }>} roomObject.part - 참여자 목록입니다. + * @returns {Promise} + * @description 정산 요청이 이루어질 때마다 호출해 주세요. + * @usage rooms/commitPaymentHandler + */ +const completePayingQuest = async (userId, roomObject) => { + if (roomObject.part.length < 2) return null; + + return await completeQuest(userId, eventPeriod, quests.paying); +}; + +/** + * sending 퀘스트의 완료를 요청합니다. 방의 참가자 수가 2명 미만이면 요청하지 않습니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @param {Object} roomObject - 방의 정보입니다. + * @param {Array<{ user: mongoose.Types.ObjectId }>} roomObject.part - 참여자 목록입니다. + * @returns {Promise} + * @description 송금이 이루어질 때마다 호출해 주세요. + * @usage rooms/settlementHandler + */ +const completeSendingQuest = async (userId, roomObject) => { + if (roomObject.part.length < 2) return null; + + return await completeQuest(userId, eventPeriod, quests.sending); +}; + +/** + * nicknameChaning 퀘스트의 완료를 요청합니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @returns {Promise} + * @description 닉네임을 변경할 때마다 호출해 주세요. + * @usage users/editNicknameHandler + */ +const completeNicknameChangingQuest = async (userId) => { + return await completeQuest(userId, eventPeriod, quests.nicknameChaning); +}; + +/** + * accountChanging 퀘스트의 완료를 요청합니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @param {string} newAccount - 변경된 계좌입니다. + * @returns {Promise} + * @description 계좌를 변경할 때마다 호출해 주세요. + * @usage users/editAccountHandler + */ +const completeAccountChangingQuest = async (userId, newAccount) => { + if (newAccount === "") return null; + + return await completeQuest(userId, eventPeriod, quests.accountChanging); +}; + +const completeAdPushAgreementQuest = async () => { + // TODO +}; + +const completeEventSharingOnInstagramQuest = async () => { + // TODO +}; + +const completePurchaseSharingOnInstagramQuest = async () => { + // TODO +}; + +module.exports = { + quests, + eventPeriod, + completeFirstLoginQuest, + completePayingAndSendingQuest, + completeFirstRoomCreationQuest, + completeRoomSharingQuest, + completePayingQuest, + completeSendingQuest, + completeNicknameChangingQuest, + completeAccountChangingQuest, + completeAdPushAgreementQuest, + completeEventSharingOnInstagramQuest, + completePurchaseSharingOnInstagramQuest, +}; diff --git a/src/lottery/modules/credit.js b/src/lottery/modules/credit.js deleted file mode 100644 index 2349d0c4..00000000 --- a/src/lottery/modules/credit.js +++ /dev/null @@ -1,24 +0,0 @@ -const { eventStatusModel } = require("../modules/stores/mongo"); - -const useUserCreditAmount = async (userId) => { - const eventStatus = await eventStatusModel.findOne({ userId }).lean(); - if (!eventStatus) return null; - - return { - amount: eventStatus.creditAmount, - update: async (delta) => { - await eventStatusModel.updateOne( - { _id: eventStatus._id }, - { - $inc: { - creditAmount: delta, - }, - } - ); - }, - }; -}; - -module.exports = { - useUserCreditAmount, -}; diff --git a/src/lottery/modules/populates/transactions.js b/src/lottery/modules/populates/transactions.js index f4206d87..9f3a958e 100644 --- a/src/lottery/modules/populates/transactions.js +++ b/src/lottery/modules/populates/transactions.js @@ -1,5 +1,4 @@ const transactionPopulateOption = [ - { path: "event" }, { path: "item", select: "name imageUrl price description isDisabled stock itemType", diff --git a/src/lottery/modules/quests.js b/src/lottery/modules/quests.js new file mode 100644 index 00000000..50371daa --- /dev/null +++ b/src/lottery/modules/quests.js @@ -0,0 +1,162 @@ +const { + eventStatusModel, + questModel, + itemModel, + transactionModel, +} = require("./stores/mongo"); +const logger = require("../../modules/logger"); +const mongoose = require("mongoose"); + +const requiredQuestFields = ["name", "description", "imageUrl", "reward"]; +const buildQuests = (quests) => { + for (const [id, quest] of Object.entries(quests)) { + // quest에 필수 필드가 모두 포함되어 있는지 확인합니다. + const hasError = requiredQuestFields.reduce((before, field) => { + if (quest[field] !== undefined) return before; + + logger.error(`There is no ${field} field in ${id}Quest`); + return true; + }, false); + if (hasError) return null; + + // quest.id 필드를 설정합니다. + quest.id = id; + + // quest.reward가 number인 경우, object로 변환합니다. + if (typeof quest.reward === "number") { + const credit = quest.reward; + quest.reward = { + credit, + }; + } + + // quest.reward에 누락된 필드가 있는 경우, 기본값(0)으로 설정합니다. + quest.reward.credit = quest.reward.credit || 0; + quest.reward.ticket1 = quest.reward.ticket1 || 0; + + // quest.maxCount가 없는 경우, 기본값(1)으로 설정합니다. + quest.maxCount = quest.maxCount || 1; + } + + return quests; +}; + +/** + * 퀘스트 완료를 요청합니다. + * @param {string|mongoose.Types.ObjectId} userId - 퀘스트를 완료한 사용자의 ObjectId입니다. + * @param {Object} eventPeriod - 이벤트의 기간입니다. + * @param {Date} eventPeriod.start - 이벤트의 시작 시각(Inclusive)입니다. + * @param {Date} eventPeriod.end - 이벤트의 종료 시각(Exclusive)입니다. + * @param {Object} quest - 퀘스트의 정보입니다. + * @param {string} quest.id - 퀘스트의 Id입니다. + * @param {string} quest.name - 퀘스트의 이름입니다. + * @param {Object} quest.reward - 퀘스트의 완료 보상입니다. + * @param {number} quest.reward.credit - 퀘스트의 완료 보상 중 재화의 양입니다. + * @param {number} quest.reward.ticket1 - 퀘스트의 완료 보상 중 일반 티켓의 개수입니다. + * @param {number} quest.maxCount - 퀘스트의 최대 완료 가능 횟수입니다. + * @returns {Object|null} 성공한 경우 Object를, 실패한 경우 null을 반환합니다. 이미 최대 완료 횟수에 도달했거나, 퀘스트가 원격으로 비활성화 된 경우에도 실패로 처리됩니다. + */ +const completeQuest = async (userId, eventPeriod, quest) => { + try { + // 1단계: 이벤트 기간인지 확인합니다. + const now = Date.now(); + if (now >= eventPeriod.end || now < eventPeriod.start) { + logger.info( + `User ${userId} failed to complete auto-disabled ${quest.id}Quest` + ); + return null; + } + + // 2단계: 유저의 EventStatus를 가져옵니다. 없으면 새롭게 생성합니다. + let eventStatus = await eventStatusModel.findOne({ userId }).lean(); + if (!eventStatus) { + eventStatus = new eventStatusModel({ userId }); + await eventStatus.save(); + } + + // 3단계: 유저의 퀘스트 완료 횟수를 확인합니다. + const questCount = eventStatus.completedQuests.filter( + (completedQuestId) => completedQuestId === quest.id + ).length; + if (questCount >= quest.maxCount) { + logger.info( + `User ${userId} already completed ${quest.id}Quest ${questCount} times` + ); + return null; + } + + // 4단계: 원격으로 비활성화된 퀘스트인지 확인합니다. + // 비활성화된 퀘스트만 DB에 저장할 것이기 때문에, questDoc이 null이어도 오류를 발생시키면 안됩니다. + const questDoc = await questModel.findOne({ id: quest.id }).lean(); + if (questDoc?.isDisabled) { + logger.info( + `User ${userId} failed to complete disabled ${quest.id}Quest` + ); + return null; + } + + // 5단계: 완료 보상 중 티켓이 있는 경우, 티켓 정보를 가져옵니다. + const ticket1 = + quest.reward.ticket1 && (await itemModel.findOne({ itemType: 1 }).lean()); + if (quest.reward.ticket1 && !ticket1) throw "Fail to find ticket1"; + + // 6단계: 유저의 EventStatus를 업데이트합니다. + await eventStatusModel.updateOne( + { userId }, + { + $inc: { + creditAmount: quest.reward.credit, + ticket1Amount: quest.reward.ticket1, + }, + $push: { + completedQuests: quest.id, + }, + } + ); + + // 7단계: Transaction을 생성합니다. + const transactionsId = []; + if (quest.reward.credit) { + const transaction = new transactionModel({ + type: "get", + amount: quest.reward.credit, + userId, + questId: quest.id, + comment: `"${quest.name}" 퀘스트를 완료해 송편 ${quest.reward.credit}개를 획득했습니다.`, + }); + await transaction.save(); + + transactionsId.push(transaction._id); + } + if (quest.reward.ticket1) { + const transaction = new transactionModel({ + type: "use", + amount: 0, + userId, + questId: quest.id, + item: ticket1._id, + comment: `"${quest.name}" 퀘스트를 완료해 "${ticket1.name}" ${quest.reward.ticket1}개를 획득했습니다.`, + }); + await transaction.save(); + + transactionsId.push(transaction._id); + } + + logger.info(`User ${userId} successfully completed ${quest.id}Quest`); + return { + quest, + transactionsId, + }; + } catch (err) { + logger.error(err); + logger.error( + `User ${userId} failed to complete ${quest.id}Quest due to exception` + ); + return null; + } +}; + +module.exports = { + buildQuests, + completeQuest, +}; diff --git a/src/lottery/modules/stores/mongo.js b/src/lottery/modules/stores/mongo.js index a3becf49..296db681 100644 --- a/src/lottery/modules/stores/mongo.js +++ b/src/lottery/modules/stores/mongo.js @@ -12,10 +12,9 @@ const eventStatusSchema = Schema({ ref: "User", required: true, }, - eventList: { - type: [Schema.Types.ObjectId], + completedQuests: { + type: [String], default: [], - ref: "Event", }, creditAmount: { type: Number, @@ -37,37 +36,14 @@ const eventStatusSchema = Schema({ }, }); -const eventSchema = Schema({ - name: { +const questSchema = Schema({ + id: { type: String, required: true, - }, - rewardAmount: { - type: Number, - required: true, - min: 0, - validate: integerValidator, - }, - maxCount: { - type: Number, - default: 1, - min: 0, - validate: integerValidator, - }, - expireat: { - type: Date, - required: true, + unique: true, }, isDisabled: { type: Boolean, - default: false, - }, - imageUrl: { - type: String, - required: true, - }, - description: { - type: String, required: true, }, }); @@ -135,31 +111,26 @@ const transactionSchema = Schema({ ref: "User", required: true, }, - event: { - type: Schema.Types.ObjectId, - ref: "Event", + questId: { + type: String, }, item: { type: Schema.Types.ObjectId, ref: "Item", }, - itemType: { - type: Number, - enum: [0, 1, 2, 3], - }, comment: { type: String, required: true, }, }); transactionSchema.set("timestamps", { - createdAt: "doneat", + createdAt: "createAt", updatedAt: false, }); module.exports = { eventStatusModel: mongoose.model("EventStatus", eventStatusSchema), - eventModel: mongoose.model("Event", eventSchema), + questModel: mongoose.model("Quest", questSchema), itemModel: mongoose.model("Item", itemSchema), transactionModel: mongoose.model("Transaction", transactionSchema), }; diff --git a/src/lottery/routes/docs/eventsSchema.js b/src/lottery/routes/docs/eventsSchema.js deleted file mode 100644 index 04fcb616..00000000 --- a/src/lottery/routes/docs/eventsSchema.js +++ /dev/null @@ -1,67 +0,0 @@ -/** Event에 대한 기본적인 프로퍼티를 갖고 있는 스키마입니다. */ -const eventBase = { - type: "object", - required: [ - "_id", - "name", - "rewardAmount", - "maxCount", - "expireat", - "isDisabled", - "imageUrl", - "description", - ], - properties: { - _id: { - type: "string", - description: "Event의 ObjectId", - example: "OBJECT ID", - }, - name: { - type: "string", - description: "이벤트의 이름", - example: "최초 로그인 이벤트", - }, - rewardAmount: { - type: "number", - description: "달성 보상", - example: 100, - }, - maxCount: { - type: "number", - description: "최대 달성 가능 횟수", - example: 1, - }, - expireat: { - type: "string", - description: "달성할 수 있는 마지막 시각", - example: "2023-01-01 00:00:00", - }, - isDisabled: { - type: "boolean", - description: "달성 불가능 여부", - example: false, - }, - imageUrl: { - type: "string", - description: "이미지 썸네일 URL", - example: "THUMBNAIL URL", - }, - description: { - type: "string", - description: "이벤트의 설명", - example: "처음으로 이벤트 기간 중 Taxi에 로그인하면 송편을 드립니다.", - }, - }, -}; - -const eventsSchema = { - event: eventBase, - relatedEvent: { - ...eventBase, - description: - "Transaction과 관련된 이벤트의 Object. 이벤트와 관련된 Transaction인 경우에만 포함됩니다.", - }, -}; - -module.exports = eventsSchema; diff --git a/src/lottery/routes/docs/globalState.js b/src/lottery/routes/docs/globalState.js index e350e35c..29173691 100644 --- a/src/lottery/routes/docs/globalState.js +++ b/src/lottery/routes/docs/globalState.js @@ -7,7 +7,7 @@ globalStateDocs[`${apiPrefix}/`] = { tags: [`${apiPrefix}`], summary: "Frontend에서 Global state로 관리하는 정보 반환", description: - "유저의 재화 개수, 이벤트 달성 상태, 추첨권 개수 등 Frontend에서 Global state로 관리할 정보를 가져옵니다. 유저에 대한 EventStatus Document가 없을 경우 새롭게 생성하며, 유일한 생성 지점입니다.", + "유저의 재화 개수, 퀘스트 완료 상태 등 Frontend에서 Global state로 관리할 정보를 가져옵니다. 유저에 대한 EventStatus Document가 없을 경우 새롭게 생성합니다.", responses: { 200: { description: "", @@ -17,10 +17,10 @@ globalStateDocs[`${apiPrefix}/`] = { type: "object", required: [ "creditAmount", - "eventStatus", + "completedQuests", "ticket1Amount", "ticket2Amount", - "events", + "quests", ], properties: { creditAmount: { @@ -28,14 +28,14 @@ globalStateDocs[`${apiPrefix}/`] = { description: "재화 개수. 0 이상입니다.", example: 10000, }, - eventStatus: { + completedQuests: { type: "array", description: - "유저가 달성한 이벤트의 배열. 여러 번 달성할 수 있는 이벤트의 경우 배열 내에 같은 이벤트가 여러 번 포함될 수 있습니다.", + "유저가 완료한 퀘스트의 배열. 여러 번 완료할 수 있는 퀘스트의 경우 배열 내에 같은 퀘스트가 여러 번 포함됩니다.", items: { type: "string", - description: "Event의 ObjectId", - example: "OBJECT ID", + description: "Quest의 Id", + example: "QUEST ID", }, }, ticket1Amount: { @@ -48,11 +48,64 @@ globalStateDocs[`${apiPrefix}/`] = { description: "고급 티켓의 개수. 0 이상입니다.", example: 10, }, - events: { + quests: { type: "array", - description: "Event의 배열", + description: "Quest의 배열", items: { - $ref: "#/components/schemas/event", + type: "object", + required: [ + "id", + "name", + "description", + "imageUrl", + "reward", + "maxCount", + ], + properties: { + id: { + type: "string", + description: "Quest의 Id", + example: "QUEST ID", + }, + name: { + type: "string", + description: "퀘스트의 이름", + example: "최초 로그인 퀘스트", + }, + description: { + type: "string", + description: "퀘스트의 설명", + example: + "처음으로 이벤트 기간 중 Taxi에 로그인하면 송편을 드립니다.", + }, + imageUrl: { + type: "string", + description: "이미지 썸네일 URL", + example: "THUMBNAIL URL", + }, + reward: { + type: "object", + description: "완료 보상", + required: ["credit", "ticket1"], + properties: { + credit: { + type: "number", + description: "완료 보상 중 재화의 개수입니다.", + example: 100, + }, + ticket1: { + type: "number", + description: "완료 보상 중 일반 티켓의 개수입니다.", + example: 1, + }, + }, + }, + maxCount: { + type: "number", + description: "최대 완료 가능 횟수", + example: 1, + }, + }, }, }, }, diff --git a/src/lottery/routes/docs/swaggerDocs.js b/src/lottery/routes/docs/swaggerDocs.js index cf48929f..96c7fe86 100644 --- a/src/lottery/routes/docs/swaggerDocs.js +++ b/src/lottery/routes/docs/swaggerDocs.js @@ -2,7 +2,6 @@ const { eventMode } = require("../../../../loadenv"); const globalStateDocs = require("./globalState"); const itemsDocs = require("./items"); const transactionsDocs = require("./transactions"); -const eventsSchema = require("./eventsSchema"); const itemsSchema = require("./itemsSchema"); const publicNoticeDocs = require("./publicNotice"); @@ -35,7 +34,6 @@ const eventSwaggerDocs = { }, components: { schemas: { - ...eventsSchema, ...itemsSchema, }, }, diff --git a/src/lottery/routes/docs/transactions.js b/src/lottery/routes/docs/transactions.js index df1e1cb9..60e7435b 100644 --- a/src/lottery/routes/docs/transactions.js +++ b/src/lottery/routes/docs/transactions.js @@ -21,7 +21,7 @@ transactionsDocs[`${apiPrefix}/`] = { description: "유저의 재화 입출금 기록의 배열", items: { type: "object", - required: ["_id", "type", "amount", "comment", "doneat"], + required: ["_id", "type", "amount", "comment", "createAt"], properties: { _id: { type: "string", @@ -39,8 +39,11 @@ transactionsDocs[`${apiPrefix}/`] = { description: "재화의 변화량의 절댓값", example: 50, }, - event: { - $ref: "#/components/schemas/relatedEvent", + questId: { + type: "string", + description: + "Transaction과 관련된 퀘스트의 Id. 퀘스트와 관련된 Transaction인 경우에만 포함됩니다.", + example: "QUEST ID", }, item: { $ref: "#/components/schemas/relatedItem", @@ -50,7 +53,7 @@ transactionsDocs[`${apiPrefix}/`] = { description: "입출금 내역에 대한 설명", example: "랜덤 상자 구입 - 50개 차감", }, - doneat: { + createAt: { type: "string", description: "입출금이 일어난 시각", example: "2023-01-01 00:00:00", diff --git a/src/lottery/services/globalState.js b/src/lottery/services/globalState.js index c55c13a3..ff55dc22 100644 --- a/src/lottery/services/globalState.js +++ b/src/lottery/services/globalState.js @@ -1,28 +1,29 @@ -const { eventStatusModel, eventModel } = require("../modules/stores/mongo"); +const { eventStatusModel } = require("../modules/stores/mongo"); const logger = require("../../modules/logger"); +const { eventMode } = require("../../../loadenv"); +const quests = eventMode + ? Object.values(require(`../modules/contracts/${eventMode}`).quests) + : undefined; + const getUserGlobalStateHandler = async (req, res) => { try { let eventStatus = await eventStatusModel .findOne({ userId: req.userOid }) .lean(); if (!eventStatus) { - // User마다 EventStatus를 가져야 하고, 현재 Taxi에는 회원 탈퇴 시스템이 없으므로, EventStatus가 없으면 새롭게 생성하도록 구현합니다. - // EventStatus의 생성은 이곳에서만 이루어집니다!! eventStatus = new eventStatusModel({ userId: req.userOid, }); await eventStatus.save(); } - const events = await eventModel.find({}, "-__v").lean(); - res.json({ creditAmount: eventStatus.creditAmount, - eventStatus: eventStatus.eventList.map((id) => id.toString()), + completedQuests: eventStatus.completedQuests, ticket1Amount: eventStatus.ticket1Amount, ticket2Amount: eventStatus.ticket2Amount, - events, + quests, }); } catch (err) { logger.error(err); diff --git a/src/lottery/services/items.js b/src/lottery/services/items.js index 63023eff..36b4bf10 100644 --- a/src/lottery/services/items.js +++ b/src/lottery/services/items.js @@ -20,8 +20,16 @@ const updateEventStatus = async ( } ); +const { eventMode } = require("../../../loadenv"); +const eventPeriod = eventMode + ? require(`../modules/contracts/${eventMode}`).eventPeriod + : undefined; + const getRandomItem = async (req, depth) => { - if (depth >= 10) return null; + if (depth >= 10) { + logger.error(`User ${req.userOid} failed to open random box`); + return null; + } const items = await itemModel .find({ @@ -40,10 +48,9 @@ const getRandomItem = async (req, depth) => { .join(","); logger.info( - `[RandomBox] getRandomItem(depth=${depth}) is called by the user(id=${req.userOid}).` - ); - logger.info( - `[RandomBox] randomItems of the user(id=${req.userOid}) is [${dumpRandomItems}].` + `User ${req.userOid}'s ${ + depth + 1 + }th random box probability is: [${dumpRandomItems}]` ); if (randomItems.length === 0) return null; @@ -84,15 +91,15 @@ const getRandomItem = async (req, depth) => { amount: 0, userId: req.userOid, item: randomItem._id, - itemType: randomItem.itemType, - comment: `랜덤박스에서 ${randomItem.name} 획득 - 0개 차감`, + comment: `랜덤 박스에서 "${randomItem.name}" 1개를 획득했습니다.`, }); await transaction.save(); return newRandomItem; } catch (err) { + logger.error(err); logger.warn( - `[RandomBox] getRandomItem(depth=${depth}) by the user(id=${req.userOid}) failed due to ${err}.` + `User ${req.userOid}'s ${depth + 1}th random box failed due to exception` ); return await getRandomItem(req, depth + 1); @@ -113,6 +120,10 @@ const listHandler = async (_, res) => { const purchaseHandler = async (req, res) => { try { + const now = Date.now(); + if (now >= eventPeriod.end || now < eventPeriod.start) + return res.status(400).json({ error: "Items/Purchase : out of date" }); + const { itemId } = req.params; const item = await itemModel.findOne({ _id: itemId }).lean(); if (!item) @@ -162,8 +173,7 @@ const purchaseHandler = async (req, res) => { amount: item.price, userId: req.userOid, item: item._id, - itemType: item.itemType, - comment: `${item.name} 구입 - ${item.price}개 차감`, + comment: `송편 ${item.price}개를 사용해 "${item.name}" 1개를 획득했습니다.`, }); await transaction.save(); diff --git a/src/lottery/services/transactions.js b/src/lottery/services/transactions.js index 2009e540..c151d81f 100644 --- a/src/lottery/services/transactions.js +++ b/src/lottery/services/transactions.js @@ -8,7 +8,7 @@ const getUserTransactionsHandler = async (req, res) => { try { // userId는 이미 Frontend에서 알고 있고, 중복되는 값이므로 제외합니다. const transactions = await transactionModel - .find({ userId: req.userOid }, "-userId -itemType -__v") + .find({ userId: req.userOid }, "-userId -__v") .populate(transactionPopulateOption) .lean(); if (transactions) diff --git a/src/modules/adminResource.js b/src/modules/adminResource.js index 655e928b..b75013b3 100644 --- a/src/modules/adminResource.js +++ b/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") { diff --git a/src/services/auth.js b/src/services/auth.js index bab3fc71..83b598de 100644 --- a/src/services/auth.js +++ b/src/services/auth.js @@ -91,6 +91,7 @@ const tryLogin = async (req, res, userData, redirectOrigin, redirectPath) => { } login(req, userData.sid, user.id, user._id, user.name); + res.redirect(new URL(redirectPath, redirectOrigin).href); } catch (err) { logger.error(err); diff --git a/src/services/auth.mobile.js b/src/services/auth.mobile.js index fac66032..0e537b33 100644 --- a/src/services/auth.mobile.js +++ b/src/services/auth.mobile.js @@ -36,6 +36,7 @@ const tokenLoginHandler = async (req, res) => { login(req, user.sid, user.id, user._id, user.name); req.session.isApp = true; req.session.deviceToken = deviceToken; + return res.status(200).json({ message: "success" }); } catch (e) { logger.error(e); diff --git a/src/services/rooms.js b/src/services/rooms.js index 0456d534..eb158278 100644 --- a/src/services/rooms.js +++ b/src/services/rooms.js @@ -11,6 +11,9 @@ const { getIsOver, } = require("../modules/populates/rooms"); +// 이벤트 코드입니다. +const { contracts } = require("../lottery"); + const createHandler = async (req, res) => { const { name, from, to, time, maxPartLength } = req.body; @@ -81,7 +84,12 @@ const createHandler = async (req, res) => { }); const roomObject = (await room.populate(roomPopulateOption)).toObject(); - return res.send(formatSettlement(roomObject)); + const roomObjectFormated = formatSettlement(roomObject); + + // 이벤트 코드입니다. + await contracts?.completeFirstRoomCreationQuest(user._id); + + return res.send(roomObjectFormated); } catch (err) { logger.error(err); res.status(500).json({ @@ -483,6 +491,10 @@ const commitPaymentHandler = async (req, res) => { authorId: user._id, }); + // 이벤트 코드입니다. + await contracts?.completePayingQuest(user._id, roomObject); + await contracts?.completePayingAndSendingQuest(roomObject); + // 수정한 방 정보를 반환합니다. res.send(formatSettlement(roomObject, { isOver: true })); } catch (err) { @@ -549,6 +561,10 @@ const settlementHandler = async (req, res) => { authorId: user._id, }); + // 이벤트 코드입니다. + await contracts?.completeSendingQuest(user._id, roomObject); + await contracts?.completePayingAndSendingQuest(roomObject); + // 수정한 방 정보를 반환합니다. res.send(formatSettlement(roomObject, { isOver: true })); } catch (err) { diff --git a/src/services/users.js b/src/services/users.js index 77af8c7d..b7b47e41 100644 --- a/src/services/users.js +++ b/src/services/users.js @@ -2,6 +2,9 @@ const { userModel } = require("../modules/stores/mongo"); const logger = require("../modules/logger"); const aws = require("../modules/stores/aws"); +// 이벤트 코드입니다. +const { contracts } = require("../lottery"); + const agreeOnTermsOfServiceHandler = async (req, res) => { try { let user = await userModel.findOne({ id: req.userId }); @@ -34,43 +37,47 @@ const getAgreeOnTermsOfServiceHandler = async (req, res) => { }; const editNicknameHandler = async (req, res) => { - const newNickname = req.body.nickname; + try { + const newNickname = req.body.nickname; + const result = await userModel.findOneAndUpdate( + { id: req.userId }, + { nickname: newNickname } + ); - // 닉네임을 갱신하고 결과를 반환 - await userModel - .findOneAndUpdate({ id: req.userId }, { nickname: newNickname }) - .then((result) => { - if (result) { - res - .status(200) - .send("User/editNickname : edit user nickname successful"); - } else { - res.status(400).send("User/editNickname : such user id does not exist"); - } - }) - .catch((err) => { - logger.error(err); - res.status(500).send("User/editNickname : internal server error"); - }); + if (result) { + // 이벤트 코드입니다. + await contracts?.completeNicknameChangingQuest(req.userOid); + + res.status(200).send("User/editNickname : edit user nickname successful"); + } else { + res.status(400).send("User/editNickname : such user id does not exist"); + } + } catch (err) { + logger.error(err); + res.status(500).send("User/editNickname : internal server error"); + } }; const editAccountHandler = async (req, res) => { - const newAccount = req.body.account; + try { + const newAccount = req.body.account; + const result = await userModel.findOneAndUpdate( + { id: req.userId }, + { account: newAccount } + ); - // 계좌번호를 갱신하고 결과를 반환 - await userModel - .findOneAndUpdate({ id: req.userId }, { account: newAccount }) - .then((result) => { - if (result) { - res.status(200).send("User/editAccount : edit user account successful"); - } else { - res.status(400).send("User/editAccount : such user id does not exist"); - } - }) - .catch((err) => { - logger.error(err); - res.status(500).send("User/editAccount : internal server error"); - }); + if (result) { + // 이벤트 코드입니다. + await contracts?.completeAccountChangingQuest(req.userOid, newAccount); + + res.status(200).send("User/editAccount : edit user account successful"); + } else { + res.status(400).send("User/editAccount : such user id does not exist"); + } + } catch (err) { + logger.error(err); + res.status(500).send("User/editAccount : internal server error"); + } }; const editProfileImgGetPUrlHandler = async (req, res) => {