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

<html><head></head><body>こんにちは。エンジニアの矢澤です。
表題にしれっと書いていますが、KARTE Craftに<a href="https://craft.developers.karte.io/craft-functions/modules/retryable-error" target="_blank" rel="noreferrer">ファンクションの再実行機能</a>が追加されました！この記事では再実行機能の使い方を説明し、実例として、以前ブログに書いた「ユーザー行動をトリガーにWebhookを飛ばす」コードの再実装版を紹介します。
<a href="https://solution.plaid.co.jp/202306-craft-webhook">Web上のユーザー行動をトリガーにして外部にWebhookリクエストを飛ばす</a>
<h1 id="「ファンクションの再実行」とは">「ファンクションの再実行」とは</h1>
今回追加されたファンクション再実行機能は 特定のエラーでファンクションが終了した場合に、そのファンクションを再度起動して初めから処理を実行する というものです。これまでエラーのリカバリーが必要な場合は自前でリトライ用のコードを書いてましたが、この機能を使うことでもリカバリーができるようになりました。
<a href="https://craft.developers.karte.io/craft-functions/modules/retryable-error" target="_blank" rel="noreferrer">RetryableError (ファンクションを再実行する)</a>
<h2 id="「ファンクションの再実行」の使い方">「ファンクションの再実行」の使い方</h2>
ファンクションの再実行を行う場合は <code>RetryableError</code> でエラーをthrowします。
<pre><code class="language-javascript hljs">export default async function( data, { MODULES } ) {
 // MODULESからRetryableErrorを取り出す
 const { RetryableError } = MODULES;
 
 try {
 // ... なんらかの処理
 } catch (err) {
 throw new RetryableError('An error occurred. The function will retry shortly.')
 }
}
</code></pre>
<ul>
<li><code>RetryableError</code> は <code>MODULES</code> から取り出せます。</li>
<li>このコードでは <code>try ... catch</code> 構文でエラーをcatchした際に <code>RetryableError</code> をthrowしています。したがって、try節で例外が発生した場合にファンクションを再実行します。</li>
</ul>
ここでは説明のためにtry節で発生したエラーをすべて <code>RetryableError</code> としていますが、実際には リトライ対象のエラーのみを <code>RetryableError</code> の対象にしましょう 。なぜかというと、ユーザー起因のエラーはファンクションの再実行では解決せず、期限いっぱいまで無駄に再実行されてしまうためです。
<h2 id="リトライ実装との使い分け">リトライ実装との使い分け</h2>
ファンクションの再実行機能はリトライ実装をしなくて良い分便利ではありますが、注意点があります。
<ul>
<li>リカバリーのための時間が長くなる（数秒程度。再実行を繰り返すと数分かかることもある）</li>
<li>コードのはじめから再実行するため、同じ条件で実行した処理に対して同じ結果を返すような実装（べき等な実装）をする必要がある</li>
<li>再実行はファンクションの実行回数にカウントされる</li>
</ul>
多くのユースケースはファンクションの再実行機能でカバーできるかと思いますが、例えばエラー時にすぐリトライしたい場合は自前でリトライを実装するというように、必要に応じて使い分けることをお勧めします。
<h1 id="Webhook接客の再実装">Webhook接客の再実装</h1>
ここからはファンクション再実行の実用例を紹介します。以前、KARTEの接客とKARTE Craftを組み合わせてユーザー行動に応じてWebhookリクエストを飛ばす方法を紹介しました。
<a href="https://solution.plaid.co.jp/202306-craft-webhook">(再掲) Web上のユーザー行動をトリガーにして外部にWebhookリクエストを飛ばす</a>
この記事で紹介したコードを「ファンクションの再実行」を使って再実装しました。
<ul>
<li><a href="https://github.com/plaidev/craft-codes/tree/main/craft-functions/webhook-action" target="_blank" rel="noreferrer">craft-codes/craft-functions/webhook-action at main · plaidev/craft-codes</a></li>
</ul>
<h2 id="再実装版のWebhookのコードを使う">再実装版のWebhookのコードを使う</h2>
コードの利用手順は次のとおりです。
<ul>
<li>ブログ記事下部の「このSolutionをKARTE Craftで利用してみる」からテンプレートを展開する。
<ul>
<li>直前に開いていたプロジェクトでCraft Functionsの作成画面に移動するので、事前にKARTE Craftが有効なプロジェクトを開いておいてください。</li>
<li>再実装版のコードでは先日紹介した変数機能 (<a href="https://solution.plaid.co.jp/202310-craft-function-renewal">Craft Function新機能＆画面リニューアルのお知らせ</a>) を使っております。変数にはデフォルト値が入っていますが、必要に応じて変更してください。</li>
</ul>
</li>
<li>ファンクション名を指定して保存する。</li>
<li>以降の手順は以前の記事と同様です。
<ul>
<li><a href="https://solution.plaid.co.jp/202306-craft-webhook">(再掲) Web上のユーザー行動をトリガーにして外部にWebhookリクエストを飛ばす</a></li>
</ul>
</li>
</ul>
<h2 id="Webhookコード利用時の注意点">Webhookコード利用時の注意点</h2>
<ul>
<li>複数接客で異なるURLにリクエストをしたい場合でも ファンクションは1つで問題ありません。</li>
<li>このコードでは1回のWebhookが複数回実行される場合があります。リクエストを重複なく実行させたい場合は以下の記事を参考にリクエストの重複排除を実装してください。
<ul>
<li><a href="https://solution.plaid.co.jp/implementing-exactly-once-semantics-in-karte-craft">KARTE Craftでファンクションの重複実行を防ぐ</a></li>
<li>上記記事で紹介しているCraft KVSを利用する場合はKARTE Craft Growthプランのご契約が必要です。</li>
</ul>
</li>
</ul>
<h2 id="（おまけ）再実装の詳細">（おまけ）再実装の詳細</h2>
ここではコードの詳細を説明します。Craft Functionsのコードについて興味をお持ちの方はお読みください。
以前の記事で紹介したサンプルコードでは、Webhook先URLへのリクエストがエラーになった場合のリトライ処理を自前で実装していました。
<ul>
<li><a href="https://github.com/plaidev/craft-codes/tree/a41714108c30953be53f66d6565343e8a9d9babf/craft-functions/webhook-action" target="_blank" rel="noreferrer">craft-codes/craft-functions/webhook-action at a41714108c30953be53f66d6565343e8a9d9babf · plaidev/craft-codes</a></li>
</ul>
次のコードはサンプルコードの一部です。async-retryを使ってリトライを行っています。このコードでは <code>BailError</code> をハンドリングして、それ以外のエラーが発生した場合にリトライを行います。
<pre><code class="language-javascript hljs"> // async-retry を使ったリトライ実装
 return await retry(async (bail, attempt) =&gt; {
 try {
 const resStatus = await requestData({ method, url, data: hookData, headers, campaignId, id });
 logger.log(`[${campaignId}][${id}] Webhook execution completed. status: ${resStatus}`);
 return;
 } catch (err) {
 if (err instanceof BailError) {
 bail(err);
 return;
 }
 if (isTimeoutPerExec({retryOptions, attempt, startMs})) {
 bail(new Error(`[${campaignId}][${id}] Timeout per exec.`));
 return;
 }
 throw err;
 }
 }, retryOptions);
</code></pre>
次のコードは <code>requestData()</code> の一部です。ここでは500系以外のエラーでファンクションを終了するために <code>BailError</code> をthrowしています。
<pre><code class="language-javascript hljs"> const response = await fetch(url, requestOptions);

 if (!response.ok) {
 if (response.status &gt;= 500 &amp;&amp; response.status &lt; 600 || [408, 429].includes(response.status)) {
 // 500系や一時的に発生するエラーはリトライ想定で通常のErrorを発生させる
 throw new Error(`[${campaignId}][${id}] Request failed with status ${response.status}`);
 }
 // ユーザー起因のエラーの場合はリトライを行わないためBailErrorをthrowする
 throw new BailError(`[${campaignId}][${id}] Request failed with status ${response.status}. Bail Error.`);
 }
</code></pre>
再実装版では、上記のコードをファンクションの再実行機能で書き換えています。
<ul>
<li>async-retryのコードは省略できるため、次のように単に <code>requestData()</code> を呼び出すだけになります。<pre><code class="language-javascript hljs"> const resStatus = await requestData({ method, url, data: hookData, headers, campaignId, id, RetryableError });
 logger.debug(
 `[${campaignId}][${id}] Webhook execution completed. status: ${resStatus}`
 );
</code></pre>
</li>
<li>実際にWebhook先にリクエストを行う <code>requestData()</code> では、500系エラーのようなリトライが必要な場合に <code>RetryableError</code> をthrowします。<pre><code class="language-javascript hljs"> const response = await fetch(url, requestOptions);

 if (!response.ok) {
 if (response.status &gt;= 500 &amp;&amp; response.status &lt; 600 || [408, 429].includes(response.status)) {
 throw new RetryableError(
 `[${campaignId}][${id}] Request failed with status ${response.status}`,
 PER_DATA_TIMEOUT_MS // ファンクションが再実行できる期限
 );
 }
 throw new Error(`[${campaignId}][${id}] Request failed with status ${response.status}. Bail Error.`);
 }
</code></pre>
</li>
</ul>
<h1 id="まとめ">まとめ</h1>
この記事ではファンクションの再実行機能について説明し、Webhookソリューションの再実装版を紹介しました。エラーハンドリングで再実行の有無が設定できるので、簡単に柔軟なリトライ制御ができるようになりました。
また、ここで紹介したWebhookのロジックはさまざまな応用ができます。ブログ記事下部のボタンでファンクションを作成して、どんどんご活用ください！
<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>

「Web上のユーザー行動をトリガーに外部にWebhookリクエストを飛ばす」機能をKARTE Craftのファンクション再実行機能で再実装しました。ファンクションの再実行機能の説明と、再実装したWebhookコードの使い方を紹介します。

Webhook接客をファンクションの再実行機能で再実装しました！