デベロッパー

Google Cloud Functions のアンチパターンを回避する（第 1 回）: べき等性を念頭に置いたコーディングで Cloud Functions のイベントドリブン関数を正しく記述する方法

2021年11月4日

Google Cloud Japan Team

※この投稿は米国時間 2021 年 10 月 21 日に、Google Cloud blog に投稿されたものの抄訳です。

編集者注: 今後数週間にわたり、Google Cloud Functions の関数を記述するためのベストプラクティスに注目するブログ投稿シリーズを公開していきます。これらのベストプラクティスは、サポートチームがよく受ける質問や、よく見かける誤解を基にしています。こうした問題をここでは「アンチパターン」と呼び、これらを回避する方法をご紹介します。この記事は、そのシリーズの第 1 回目です。

シナリオ

Cloud Functions の関数が、1 回のリクエストに対し複数回実行されていることがわかりました。たとえば、1 回のリクエストによって、Firestore に重複するエントリが保存されるような事象が起きています。

最も一般的なアンチパターン

Cloud Functions の関数がべき等ではありません。ここで「べき等」とは、同じ入力データによって関数を複数回呼び出すことができるけれども、最初の呼び出しの結果は変わらないことを意味します。以下に例を示します。

調べる方法:

バックグラウンド関数を使用する場合、実行保証について十分理解していることが重要です。バックグラウンド関数は、少なくとも 1 回呼び出されることが保証されています。それはつまり、次のことを意味します。

同じ入力データで、最初の結果を変えることなく関数を複数回呼び出すことができるかをテストする必要がある。
もしくは、べき等な関数を記述できない場合、こうした追加の呼び出しをどのように処理するかに関する計画が必要である。

べき等な関数の例

サーバーレスにおいては、べき等性を念頭に置いてコードを記述することが重要です。べき等性を確保できない場合、重複する呼び出しをどのように処理するかについて計画を立てることが重要となります。

まず、HTTP でトリガーされる関数を詳しく見て、べき等な関数がどのようなものかを確認します。次に、バックグラウンド関数におけるべき等の例を見ていきます。

HTTP 関数の例

以下のべき等の例では、リクエストに一意の値（センサー ID とタイムスタンプ）が含まれており、それが Firestore への保存のキーとして使われています。この一意のキーを指定するために Firestore.set() がどのように使われているかにご注目ください。これにより、（理論上は）HTTP 関数がリクエストを 2 回受け取っても、同じ一意のキーを使用してドキュメントが作成されているため、Firestore に重複したエントリが保存されることはありません。

読み込んでいます...

次に、非べき等の HTTP 関数の例について考えて、べき等の場合と動作がどのように異なるかを見ていきます。以下に示す HTTP 関数は、Firestore が自動生成するキーを使用して Firestore.add() を呼び出し、データを保存します。そのため、（理論上は）この HTTP 関数が 2 回リクエストを受け取ると、Firestore に 2 つの新しいエントリが作成されます。

読み込んでいます...