とあるサービスで、Stripe Checkoutの決済をどこで記録するかを作り直しました。それまでは、利用者が決済のあとに完了画面(success_url)へ戻ったときだけ記録していました。Stripeには、Webhookの送り先が1つも登録されていませんでした。
セキュリティ診断で、この作りから2つの問題が見つかりました。完了画面を再読込すると契約と請求書が二重にでき、メールも二重に届くこと。決済のあとに画面を閉じると、払われていても記録されないことです。
直したあとは完了画面とWebhookのどちらからでも同じ処理で記録し、二重にはしません。この記事では、その作りと確かめ方・一意制約やイベントIDの表を使わなかった理由を書きます。アプリはRuby on Rails(MySQL)で動いています。サービスや取引先が分かる情報は伏せ、件数は必要なものだけを残しています。
完了画面だけで記録していた作りで起きうること
完了画面の処理は、決済画面(Checkout Session)を取得してpayment_statusがpaidなら契約と請求書を作ってメールを送っていました。処理済みかどうかは見ていません。そのため完了画面を再読込するたびに、契約・請求書・メールがもう一度作られる作りでした。
最初の直しでは、完了画面の処理に次の確認を足しました。
- 決済画面の顧客IDが、その会社の
stripe_customer_idと一致しなければ処理しない - 会社と購入のレコードをロックしてから処理する
- 処理済みの決済なら、何も作らず何も送らない
- 同じ月に有効な契約がある会社には、契約を作らない
被害の跡を本番のDBで数えたとき、最初の集計では同じ月の重複契約がいくつもあるように見えました。これはUTCで月を区切っていたためで、日本時間で数え直すと重複は1件でした。その1件も銀行振込の契約で、この経路のものではありません。0円の請求書も0件でした。
もう1つの問題は、完了画面に戻ってこない決済です。Webhookの受け口はありましたが、署名を確かめたあと何もしていませんでした。利用者が決済の直後に画面を閉じたり通信が切れたりすると、払われていても記録されません。
あとからStripe側の決済画面を全件照合すると、支払済みのものはすべて記録されていました。記録漏れはなかったものの、記録できるかは利用者の画面操作しだいでした。
完了画面とWebhookから同じ処理を呼ぶ
直したあとの作りでは、決済の記録を1つの処理(CompleteCheckout)にまとめました。完了画面の処理とWebhookのcheckout.session.completedの処理が、どちらもこれを呼びます。どの種類の決済も、この処理を通ります。
どちらが先に来るかは決まっていません。リリースのあと本番で記録された決済を見ると、どれもWebhookのほうが先に届いて記録していました。完了画面のリクエストは、約2秒後に来ていました。完了画面は「記録済み」として扱われ、利用者には完了の画面が出ています。
下の図は、2つのリクエストがほぼ同時に来たときに何が起きるかを示したものです。

レコードのロックとロック後の読み直し
二重にしないために、次のようにしています。
- どちらの処理も、最初に会社のレコードをロックする(
company.lock!)。2つ目の処理は、1つ目のトランザクションが終わるまでそこで待つ - ロックが取れたら、購入の状態を読み直す。記録済みなら何もせずに返る
- メールやチャットへの通知は、記録した側だけがコミットのあとに送る
記録の処理では、ロックを会社・購入の順で取ります。支払い方法に振込を選ぶ処理と、決済を取り消す処理にもロックを足しました。この2つはロックを取らずに購入のレコードを書き換えていたので、Webhookと同時に走ると記録を上書きするおそれがありました。
コードにすると、おおよそ次の形です(実際のコードを簡略化しています)。
ruby
class CompleteCheckout
def call
recorded = ActiveRecord::Base.transaction do
company.lock! # 2つ目の処理はここで待つ
purchase.reload # ロックを取ってから状態を読み直す
next false unless purchase.status_start?
record! # 購入を完了にし、プランと請求書を作る
true
end
deliver_notifications if recorded # 記録した側だけが、コミットのあとに送る
recorded
end
endテストでは、完了画面だけ・Webhookだけ・Webhookのあとに完了画面・Webhookの再送の4つを確かめました。ただ、これは順番に来る場合です。同時に来た場合は、別のDB接続で2つの処理を同時に走らせて確かめました。
- 先に始めた処理が、記録の途中で0.5秒止まるようにした。もう一方が必ずその最中に来る
- 2種類の決済で、それぞれ3回ずつ流した
- 6回とも一方が「記録した」、もう一方が「記録済み」になった
- どちらの種類も請求書は1件で、メールなどの通知も1回だった
- 処理はどちらも0.5秒以上かかり、後から来た側はロックで待たされていた
テストではStripeの応答を作り物に置き換えています。Stripeが署名して送った通知を受け取れることはステージングで確かめ、本物の通知で記録できることはリリースのあとの本番の決済で確かめました。
一意制約とイベントIDの表を使わなかった理由
二重の記録を防ぐ方法としては、DBの一意制約もよく使われます。Webhookは同じイベントが2回以上届くことがあるので、Stripeの公式ドキュメントも処理したイベントIDを記録しておく方法を勧めています(Receive Stripe events in your webhook endpoint)。今回は、どちらも使っていません。
購入のレコードは決済画面を作るときにすでにできていて、記録はその状態を「進行中」から「完了」に変える処理です。二重になって困るのは、それに続いて作る請求書・プラン・メールでした。一意制約で止められるのはレコードの重複までで、メールの二重送信は止められません。どのみち、ロックと読み直しで「記録した側だけが送る」形にする必要がありました。
イベントIDで重複を除けるのは、Webhookの中だけです。完了画面のリクエストにはイベントIDがないので、画面とWebhookのどちらが先に記録したかは購入の状態で見るしかありません。Webhookの再送も、購入の状態を見て「記録済みなら何もしない」で吸収できます。イベントを保存する表は、今の量では持たないことにしました。
一意制約を後から足すなら、既存の重複データ(前述の重複契約1件)を先に整理する必要もあります。今回は入れていません。
決済画面を2つ開かれたとき
もう1つ決めたのは、決済画面を2つ開いて両方で払われた場合の扱いです。ロックで防げるのは同じ決済を二重に記録することで、別々の決済画面で2回払われることは防げません。
決済画面を作るときにその会社の作りかけの決済画面があれば、先に失効させてから新しく作るようにしました。Checkout Sessionは、既定では作ってから24時間で失効します(How Checkout works)。この処理が効くのは、24時間以内に決済画面を2つ開いた場合です。前の決済画面が支払済みでまだ記録されていないときは、新しい決済画面を作りません。
それでもすり抜けて、すでに有効なプランがある会社の決済が届いたときは記録しません。エラー用のチャンネルに返金の依頼を通知し、人が返金します。振込を選んだあとにカードでも払われた場合も、同じ扱いにしました。
自動で返金する作りも考えましたが、採りませんでした。外部サービスへの取り消せない操作を、自動で行うことになるからです。照合した決済の中に、同じ契約を二重に払ったものはありませんでした。
Webhookを足すときに決めたこと
何月の記録かは処理した時刻で決める
Stripeは、Webhookに200以外を返すと最大3日間送り直します。そのため、月末の決済の通知が月をまたいで届くことがあります。
最初は、Stripeのイベントの時刻で何月の記録にするかを決める案でした。仕様のレビューで、これだと翌月のプランが作られないと指摘されました。このサービスでは月の初めに、前月に有効なプランから当月のプランを作るバッチが動きます。月末の決済の記録がそのバッチより後に前月分として入ると、当月のプランを作る処理はもう終わっています。
完了画面の処理は、もともと処理した時刻で月を決めていました。Webhookもそれにそろえ、処理した時刻で決めています。
知らない種類のイベントには200を返す
もとの受け口は、知らない種類のイベントに500を返していました。500を返すと、Stripeは同じイベントを送り直します。受け取るイベントはcheckout.session.completed・invoice.payment_failed・customer.subscription.deletedの3つにしぼり、それ以外には200を返すようにしました。
決済のあとに起きる事故は、決済を入れたあとの請求漏れや返金のずれにもまとめています。決済を足す前に確かめたいことは、決済機能を追加する前に確かめたい、請求・注文・取消のつながりに書きました。
作っているものや動かしているもので迷ったら、エンジニアに直接相談できます。自分たちでもプロダクトを作って運用している私たちが、状況を確かめるところから直して動かし続けるところまで一緒に進めます。
エンジニアの相談窓口を見る
