「回答後に集計結果がリアルタイム表示されるアンケート」をCraft Counterで実装する

<html><head></head><body>こんにちは、Customer Engineerのgamiです。
先日 <a href="https://solution.plaid.co.jp/202310-craft-function-renewal">Craft Functionsのエディタ画面リニューアル&amp;変数機能リリース</a> が行われたばかりですが、またもや新機能の発表です！この度、Craft Functions内で利用できる高速なカウンター 「Craft Counter」 が利用可能になりました。
<h1 id="Craft Counterとは？">Craft Counterとは？</h1>
今回リリースされたCraft Counterは、key とそれに紐づくvalueからなるKey-Value Storeです。
Craftファミリーにはすでに <a href="https://craft.developers.karte.io/craft-key-value-store/gets-started" target="_blank" rel="noreferrer">Craft KVS</a> というKey-Value Storeがありますが、それと比べてCraft Counterには次のような特徴があります。
<ul>
<li>特徴1: valueにはnumber 型の整数値しか格納できない</li>
<li>特徴2: 秒間数十回以上のカウントアップ・ダウンリクエストに対応可能</li>
<li>特徴3: increment処理がアトミックに行われる</li>
</ul>
今回の記事では、この3つの特徴について詳しく説明します。
<h2 id="特徴1: valueにはnumber 型の整数値しか格納できない">特徴1: valueにはnumber 型の整数値しか格納できない</h2>
Craft KVSではvalueに任意のオブジェクトを指定してwriteすることができました。
<pre><code class="language-js hljs">export default async function (data, { MODULES }) {
 const { kvs } = MODULES;
 const value = { foo: "bar", baz: 42};

 await kvs.write({ key: "key1", value });
};
</code></pre>
一方、Craft Counterではvalueに整数値しか指定することができません。
<pre><code class="language-js hljs">export default async function (data, { MODULES }) {
 const { counter } = MODULES;
 const value = 1000;
 await counter.set({ key: "key1", value });
}
</code></pre>
"Counter" という名前だけあって、数値をカウントする用途で利用されるデータベースということです。
<h2 id="特徴2: 秒間数十回以上のカウントアップ・ダウンリクエストに対応可能">特徴2: 秒間数十回以上のカウントアップ・ダウンリクエストに対応可能</h2>
ここまでの説明では単にCraft Counterの方ができることが少ないように見えます。その代わりとして、Craft Counterはパフォーマンスの面で強みがあります。
特にCraft Counterでは <code>increment()</code> メソッドがサポートされており、 「複数のクライアントから同時多発的に飛んできたリクエストを余すことなくカウントする」 という用途に特化しています。
<pre><code class="language-js hljs">export default async function (data, { MODULES }) {
 const { counter } = MODULES;
 await counter.set({ key: "key1", value: 0 }); // 0
 count n1 = await counter.increment({ key: "key1" }); // 1
 count n2 = await counter.increment({ key: "key1" }); // 2
 // ...
}
</code></pre>
なお、<code>counter.increment()</code>を呼び出すとincrement後の数値が返されます。現在の数値を取得して+1して更新する場合、Craft KVSでは<code>kvs.get()</code>と<code>kvs.write()</code>をそれぞれ呼ぶ必要がありますが、<code>counter.increment()</code>では1回のリクエストでまとめて実現できます。便利ですね。
さて、たとえばKARTEの施策ニーズとして、次のようにユーザー横断の集計をリアルタイムに実施したいケースがあります。
<ul>
<li>特定接客サービスの表示数 をカウントし、一定数を超えたら自動停止したい</li>
<li>選択式のアンケートを配信し、 全アンケート回答 をリアルタイムに集計してユーザーに表示したい</li>
<li>アイテム詳細ページで 「いま何人が見てます」 と表示したい</li>
</ul>
こうしたケースでは、サイト来訪しているアクティブなユーザー数が急に増えた場合に、集計を担うFunctionにもリクエストが集中します。その際のデータベースにCraft KVSを採用することもできますが、 「高速に数をカウントアップしたい」 というケースではCraft Counterの方が高いパフォーマンスが期待できるというわけです。
実際、私も同様の施策をCraft KVSとCraft Counterの両方で実装して簡単な負荷検証をしたところ、Craft KVSでは負荷が高まりtimeoutになってしまうケースでも、Craft Counterでは高速にリクエストを捌くことができました。
（なお、便宜上「秒間数十回以上」と書きましたが、より高いパフォーマンスが求められる場合はご相談ください。）
<h2 id="特徴3: increment処理がアトミックに行われる">特徴3: increment処理がアトミックに行われる</h2>
最後の特徴は、increment処理がアトミックに行われるということです。具体例とともに紹介します。
Craft Counterの他の代表的なユースケースとして、 「クーポンコードの順次払い出し」 に利用するというものがあります。具体的には次のような施策です。
<ul>
<li>事前にクーポンコードの在庫を用意し、1番から始まる通し番号を付与しておく</li>
<li>サイト来訪中に特定の条件を満たしたエンドユーザーに対して、1番から順にクーポンコードを払い出し、サイトに配信した接客サービス上に表示する</li>
</ul>
これをCraftで実装するとき、すべてCraft KVSを使うと次のようになります。
<ul>
<li>事前にクーポンコード在庫を通し番号付きでCraft KVSに格納しておく</li>
<li>接客サービスのJavaScriptからエンドポイントトリガー経由でアクセスできるCraft Functionsを実装する
<ul>
<li>Craft KVS上で管理する「現在の通し番号」をgetし、+1してからwriteする</li>
<li>その「現在の通し番号」に対応するクーポンコードをCraft KVSから取得してレスポンスする</li>
</ul>
</li>
</ul>
<img src="https://ik.imagekit.io/plaid/39b376ca-c8cd-430f-992e-6556cd134814/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-10-0318.25.56.png" alt="スクリーンショット2023-10-0318.25.56.png">
ここで注意が必要なのは、 ほぼ同時にアクセスしてきた複数ユーザーに対して同一の通し番号が割り当てられないようにする必要がある という点です。
仮にCraft KVSで「通し番号を1から順番に重複なく払い出す」ということを実現する場合、 <a href="https://craft.developers.karte.io/reference/craft-key-value-store/index.html#checkandwrite" target="_blank" rel="noreferrer">checkAndWrite()</a> を利用することになります。
<pre><code class="language-js hljs">export default async function (data, { MODULES }) {
 const { kvs } = MODULES;
 const key = 'coupon_index';
 const v = await kvs.get({ key });
 const { current_index, created_at } = v[key];
 await kvs.checkAndWrite({
 key,
 value: { index: current_index+1 }, // 予めCraft KVSから取得した通し番号に+1してwriteする
 operator: '&lt;=',
 unixtimeMs: new Date(created_at).getTime() // 書き込み時点の更新日が元のレコードの更新日以前なら書き込む
 });
}
</code></pre>
<code>checkAndWrite()</code> はKVS内の更新対象のレコードの更新日時（ <code>created_at</code> ）をチェックして、更新日時が意図と反する場合にエラーを投げてくれます。今回の例ではレコード取得した時点よりも後に他のリクエストで同一レコードが更新されてしまった場合、重複実行エラーにすることができます。これにより排他制御を実装でき、「通し番号を1から順番に重複なく払い出す」ということが実現できます。
しかし、重複実行エラーになったリクエストに対しては、再度クーポンコード取得処理を呼ぶ必要があります。このretry処理実装が必要になるのが、Craft KVSを使った実装パターンの大変な点でした。
他方、Craft Counterでは実装する場合は <code>counter.increment()</code> を利用します。前述のように、Craft KVSでは <code>get()</code> と <code>write()</code> の両方が必要でしたが、クーポン通し番号の取得と更新を1つのメソッド呼び出しで実現できます。
<pre><code class="language-js hljs">export default async function (data, { MODULES }) {
 const { counter } = MODULES;
 const key = 'coupon_index';
 const current_index = await counter.increment({ key }); // +1して、+1した後の値を返す
}
</code></pre>
そしてCraft Counterの <code>increment()</code> は「アトミックに行われる」という特徴があります。言い換えると、 あるincrement処理の途中で別のincrement処理が割り込むことができない ようになっています。そのため、ほぼ同時に2人のユーザーがクーポンコードの通し番号を取得した場合であっても、increment処理は順次行われます。
要するに、 <code>counter.increment()</code> を利用するだけで自然と「通し番号を1から順番に重複なく払い出す」という要件が実現され、 独自にretry処理を実装しなくてもよくなります 。非同期処理のretryは実装難易度も高いので、個人的にはかなり嬉しいポイントでした。
以上です！その他、Craft Counterの仕様詳細をまとめたドキュメントがすでに公開されています。気になる方はぜひご覧ください。
<a href="https://craft.developers.karte.io/craft-counter/gets-startedr" target="_blank" rel="noreferrer">Craft Counter</a>
<h1 id="おわりに">おわりに</h1>
今回は新しくリリースされたCraft Counterの特徴を3つ紹介しました。特に高いパフォーマンスが求められるケースや排他処理の実装が必要なケースでは、Craft KVSよりもCraft Counterの方が適しています。
なお現時点で Craft CounterはCraftのGrowthプラン以上を契約頂いているプロジェクトで利用可能 です。現在は利用開始に際してプレイド側での初期設定が必要となりますので、利用を希望される方はサポートや営業担当までご連絡ください。
また本ブログでもCraft Counterを使ったソリューションの記事をいくつか公開予定です。お楽しみに！
<hr>
プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！ 
ぜひ気軽にお問い合わせください。
↓ パートナー企業になりたい
<ul>
<li><a href="https://ecosystem.plaid.co.jp/" target="_blank" rel="noreferrer">CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem</a></li>
</ul>
↓ PLAIDで働きたい
<ul>
<li><a href="https://recruit.plaid.co.jp/requisitions/general-customer-engineer" target="_blank" rel="noreferrer">Customer Engineer | 募集ポジション | 株式会社プレイド</a></li>
<li><a href="https://recruit.plaid.co.jp/requisitions/product-engineer" target="_blank" rel="noreferrer">Product Engineer | 募集ポジション | 株式会社プレイド</a></li>
</ul>
</body></html>

Craft Functions内で利用できる高速なカウンター「Craft Counter」がリリースされました。この記事では、新しいデータベースであるCraft Counterの特徴を3つお伝えします。

高パフォーマンスなカウンター用データベース 「Craft Counter」 がリリースされました🎉

高パフォーマンスなカウンター用データベース「Craft Counter」がリリースされました🎉