Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: coupon-dispenser-http-type #148

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor: coupon-dispenser-http-type #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6594b03
refactor: coupon-dispenser-http-type
catpotd Jul 5, 2024
941c1d6
fix: res.send to res.json
catpotd Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion craft-functions/coupon-dispenser/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,8 @@ https://solution.karte.io/blog/2023/10/coupon-dispenser

## category

Craft Functions,Craft KVS,Craft Counter,CRAFT_ENDPOINT
Craft Functions,Craft KVS,Craft Counter,CRAFT_ENDPOINT

## functionType

http
68 changes: 41 additions & 27 deletions craft-functions/coupon-dispenser/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ function generateHash(str) {

function generateHashPrefix(key) {
const hashBase64 = crypto.createHash('sha256').update(key).digest('base64');
// 辞書順を分散させるためハッシュ値の5〜12文字目を使用
const prefix = hashBase64.substring(4, 12);
return prefix;
}
Expand All @@ -25,28 +24,30 @@ function kvsKey(recordName) {

function couponCodeKey({ couponGroupId, couponIndex }) {
const recordName = `code_${couponGroupId}_${couponIndex}`;
return kvsKey(recordName); // 例: `xxx-coupon-code_shop001_42`
return kvsKey(recordName);
}

function couponUserStatusKey({ couponGroupId, hashedUserId }) {
const recordName = `user_${couponGroupId}_${hashedUserId}`;
return kvsKey(recordName); // 例: `xxxx-coupon-user_shop001_uuuuuuuuu`
return kvsKey(recordName);
}

function couponIndexKey({ couponGroupId }) {
return `${SOLUTION_ID}-index_${couponGroupId}`; // 例: coupon-index_shop001
return `${SOLUTION_ID}-index_${couponGroupId}`;
}

function isFrequentAcquisition({ couponAcquisitionDate, logger }) {
if (!couponAcquisitionDate) return false;
const currentDate = new Date();
const diff = differenceInMinutes(currentDate, new Date(couponAcquisitionDate), 'floor'); // 端数は切り捨て. 最小値は0になる
const diff = differenceInMinutes(currentDate, new Date(couponAcquisitionDate), 'floor');
logger.debug(
`couponAcquisitionDate: ${couponAcquisitionDate}, currentDate: ${currentDate.toISOString()}, diff: ${diff}`
);
return diff < FREQUENT_ACQUISITION_ERROR_MINUTES;
}

function noRequiredParamErr(param) {
return { craft_status_code: 400, error: `"${param}" is required in the request body.` };
return { status: 400, error: `"${param}" is required in the request body.` };
}

async function fetchCouponCode({ couponGroupId, couponIndex, hashedUserId, kvs, logger }) {
Expand All @@ -65,6 +66,7 @@ async function fetchCouponCode({ couponGroupId, couponIndex, hashedUserId, kvs,
return { error: `fetch coupon code error.` };
}
}

async function updateUserStatus({ couponGroupId, hashedUserId, kvs, logger }) {
const key = couponUserStatusKey({ couponGroupId, hashedUserId });
const couponAcquisitionDate = new Date();
Expand All @@ -78,18 +80,17 @@ async function updateUserStatus({ couponGroupId, hashedUserId, kvs, logger }) {
`updateUserStatus succeeded. key: ${key}, couponAcquisitionDate: ${couponAcquisitionDate}`
);
} catch (err) {
// エラー時もクーポン払い出し処理自体は止めず、エラーログ出力だけ行う
logger.error(
`fetchUserStatus error. couponGroupId: ${couponGroupId}, hashedUserId: ${hashedUserId}, key: ${key}, couponAcquisitionDate: ${couponAcquisitionDate}, error: ${err.toString()}`
);
}
}

async function fetchUserStatus({ couponGroupId, hashedUserId, kvs, logger }) {
const key = couponUserStatusKey({ couponGroupId, hashedUserId });
try {
const v = await kvs.get({ key });

// 初取得の場合はkvs上にレコードが存在しないのでnullを返す
if (!v || !v[key]) {
return { couponAcquisitionDate: null };
}
Expand All @@ -102,11 +103,11 @@ async function fetchUserStatus({ couponGroupId, hashedUserId, kvs, logger }) {
return { error: `fetch user status error.` };
}
}

async function incrementAndFetchCouponIndex({ couponGroupId, hashedUserId, counter, logger }) {
const key = couponIndexKey({ couponGroupId });
try {
const couponIndex = await counter.increment({
// keyが存在しない場合は0とみなされ、最初は1を返す
key,
secondsToExpire: COUPON_INDEX_EXPIRE_SECONDS,
});
Expand All @@ -125,22 +126,34 @@ async function incrementAndFetchCouponIndex({ couponGroupId, hashedUserId, count
export default async function (data, { MODULES }) {
const { kvs, counter, initLogger } = MODULES;
const logger = initLogger({ logLevel: LOG_LEVEL });
const { req, res } = data;

res.setHeader('Access-Control-Allow-Origin', '*');
res.setHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS');
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');

// validation
if (data.kind !== 'karte/track-hook') {
logger.error(new Error('invalid kind. expected: karte/track-hook'));
if (req.method === 'OPTIONS') {
res.status(204).end();
return;
}
const body = data.jsonPayload.data.hook_data.body;

const body = req.body;
if (typeof body !== 'object') {
return { craft_status_code: 400, error: 'Invalid request body.' };
res.status(400).json({ error: 'Invalid request body.' });
return;
}

const { coupon_group_id: couponGroupId, user_id: userId } = body;
if (!couponGroupId) return noRequiredParamErr('coupon_group_id');
if (!userId) return noRequiredParamErr('user_id');
const hashedUserId = generateHash(userId); // リスク軽減のためにuser_idはハッシュ化してから扱う
if (!couponGroupId) {
res.status(400).json(noRequiredParamErr('coupon_group_id'));
return;
}
if (!userId) {
res.status(400).json(noRequiredParamErr('user_id'));
return;
}
const hashedUserId = generateHash(userId);

// 前回の取得から一定時間経過しているかチェック
if (FREQUENT_ACQUISITION_ERROR_MINUTES > 0) {
const { couponAcquisitionDate, error: fetchUserStatusError } = await fetchUserStatus({
couponGroupId,
Expand All @@ -149,27 +162,27 @@ export default async function (data, { MODULES }) {
logger,
});
if (fetchUserStatusError) {
return { craft_status_code: 500, error: fetchUserStatusError };
res.status(500).json({ error: fetchUserStatusError });
return;
}
if (couponAcquisitionDate && isFrequentAcquisition({ couponAcquisitionDate, logger })) {
logger.debug(`too frequent acquisition error.`);
return { craft_status_code: 400, error: 'too frequent acquisition error.' };
res.status(400).json({ error: 'too frequent acquisition error.' });
return;
}
}

// クーポン番号の取得
const { couponIndex, error: incrementAndFetchCouponIndexError } =
await incrementAndFetchCouponIndex({ couponGroupId, hashedUserId, counter, logger });
if (incrementAndFetchCouponIndexError) {
return { craft_status_code: 500, error: incrementAndFetchCouponIndexError };
res.status(500).json({ error: incrementAndFetchCouponIndexError });
return;
}

// ユーザーのクーポン取得日を更新
if (FREQUENT_ACQUISITION_ERROR_MINUTES > 0) {
await updateUserStatus({ couponGroupId, hashedUserId, kvs, logger });
}

// クーポンコードの取得
const { couponCode, error: fetchCouponCodeError } = await fetchCouponCode({
couponGroupId,
couponIndex,
Expand All @@ -178,7 +191,8 @@ export default async function (data, { MODULES }) {
logger,
});
if (fetchCouponCodeError) {
return { craft_status_code: 500, error: fetchCouponCodeError };
res.status(500).json({ error: fetchCouponCodeError });
return;
}
return { craft_status_code: 200, coupon_code: couponCode };
}
res.status(200).json({ coupon_code: couponCode });
}