SDKエラー処理

左のナビゲーションメニューにある Develop->SDKs をクリックすると、それぞれのSDKのページに移動できます。それぞれのページには、"Taking your code to prod "というリンクがあり、その言語でプロダクションですぐに使えるコードを作るためのベストプラクティスが紹介されています。

Momento SDK は、あらかじめ用意された設定オブジェクトを使用して本番環境でも問題なく動作するように設計されているため、ほとんどのユーザーは運用方法を変更することなく、概念実証から本番環境に簡単に移行できます。このページでは、Momento SDK のエラー処理に関する一般的な注意点と、デフォルトの動作がほとんどのお客様に推奨される理由について説明します。

表面的なエラー

CacheClient メソッド（Get、Set、Increment など）の呼び出しで発生したエラーは、例外をスローするのではなく、呼び出しの返り値の一部として開発者に表示されます。これによって、コードを書いているときにエラーが目に見えるようになり、IDE が、気になるエラーを確実に処理するのに役立つようになります。この点に関する私たちの考え方については、ブログ記事「なぜ[例外はバグ]なのか」(https://www.gomomento.com/blog/exceptions-are-bugs)を参照し、ご意見があればお寄せください！

これは、アプリケーションが実行時にクラッシュしないようにするのにも役立ちます。Momentoはキャッシュであるため、アプリケーションは通常、キャッシュが利用できない場合にデータを取得する信頼できるデータソースを持っています。そのため、Momento SDKは例外をスローしないように設計されており、try/catchブロックを追加し忘れてもアプリケーションがクラッシュすることはありません。

その代わりに、Momentoのレスポンスオブジェクトは親クラスから拡張され、Hit,MissやErrorなどの子クラス型を持ち、パターンマッチでアクセスできるように設計されています。(ある言語では、この概念を "sealed classes "と呼び、他の言語では "algebraic data types "と呼ぶ。ポリモーフィズムの一種である)。あなたのコードはレスポンスが Hit、Miss、Error のいずれかをチェックし、それに応じて分岐する。キャッシュの読み込み結果が Miss または Error であった場合、何が起こったのかについての詳細な情報を得るために使用できる型安全なオブジェクトも得られます (Hit オブジェクトには存在しない errorCode などのプロパティがあります)。

以下は Hit/Miss/Error レスポンスのパターンマッチングの例です：

JavaScript

const result = await cacheClient.get(cacheName, 'test-key');
switch (result.type) {
  case CacheGetResponse.Hit:
    console.log(`Retrieved value for key 'test-key': ${result.valueString()}`);
    break;
  case CacheGetResponse.Miss:
    console.log(`Key 'test-key' was not found in cache '${cacheName}'`);
    break;
  case CacheGetResponse.Error:
    throw new Error(
      `An error occurred while attempting to get key 'test-key' from cache '${cacheName}': ${result.errorCode()}: ${result.toString()}`
    );
}

備考

Full example code and imports can be found here

Java

final GetResponse response = cacheClient.get("test-cache", "test-key").join();
if (response instanceof GetResponse.Hit hit) {
  System.out.println("Retrieved value for key 'test-key': " + hit.valueString());
} else if (response instanceof GetResponse.Miss) {
  System.out.println("Key 'test-key' was not found in cache 'test-cache'");
} else if (response instanceof GetResponse.Error error) {
  throw new RuntimeException(
      "An error occurred while attempting to get key 'test-key' from cache 'test-cache': "
          + error.getErrorCode(),
      error);
}

備考

Full example code and imports can be found here

Kotlin

when (val response = cacheClient.get("test-cache", "test-key")) {
    is GetResponse.Hit -> println("Retrieved value for key 'test-key': ${response.value}")
    is GetResponse.Miss -> println("Key 'test-key' was not found in cache 'test-cache'")
    is GetResponse.Error -> throw RuntimeException(
        "An error occurred while attempting to get key 'test-key' from cache 'test-cache': ${response.errorCode}",
        response
    )
}

備考

Full example code and imports can be found here

Elixir

case Momento.CacheClient.get(client, "test-cache", "test-key") do
  {:ok, hit} ->
    IO.puts("Retrieved value for key 'test-key': #{hit.value}")

  :miss ->
    IO.puts("Key 'test-key' was not found in cache 'test-cache'")

  {:error, error} ->
    IO.puts(
      "An error occurred while attempting to get key 'test-key' from cache 'test-cache': #{error.error_code}"
    )

    raise error
end

備考

Full example code and imports can be found here

書き込みAPI(例えばSetやDelete)などのいくつかのAPIは、(Hit/Missとは対照的に)SuccessとErrorレスポンスしか持ちません。これらのレスポンスを処理する例を以下に示します：

JavaScript

const result = await cacheClient.set(cacheName, 'test-key', 'test-value');
switch (result.type) {
  case CacheSetResponse.Success:
    console.log("Key 'test-key' stored successfully");
    break;
  case CacheSetResponse.Error:
    throw new Error(
      `An error occurred while attempting to store key 'test-key' in cache '${cacheName}': ${result.errorCode()}: ${result.toString()}`
    );
}

備考

Full example code and imports can be found here

Java

final SetResponse response = cacheClient.set("test-cache", "test-key", "test-value").join();
if (response instanceof SetResponse.Success) {
  System.out.println("Key 'test-key' stored successfully");
} else if (response instanceof SetResponse.Error error) {
  throw new RuntimeException(
      "An error occurred while attempting to store key 'test-key' in cache 'test-cache': "
          + error.getErrorCode(),
      error);
}

備考

Full example code and imports can be found here

Kotlin

when (val response = cacheClient.set("test-cache", "test-key", "test-value")) {
    is SetResponse.Success -> println("Key 'test-key' stored successfully")
    is SetResponse.Error -> throw RuntimeException(
        "An error occurred while attempting to store key 'test-key' in cache 'test-cache': ${response.errorCode}",
        response
    )
}

備考

Full example code and imports can be found here

Elixir

case Momento.CacheClient.set(client, "test-cache", "test-key", "test-value") do
  {:ok, _} ->
    IO.puts("Key 'test-key' stored successfully")

  {:error, error} ->
    IO.puts(
      "An error occurred while attempting to store key 'test-key' in cache 'test-cache': #{error.error_code}"
    )

    raise error
end

備考

Full example code and imports can be found here

どのような場合でも、IDEは特定のAPIでどのタイプのレスポンスが利用可能か、そしてそれぞれのレスポンスタイプでどのようなプロパティ/メソッドが利用可能かについてのヒントを与えてくれるでしょう。

エラー・レスポンスの仕組みと使い方の例については、こちらのビデオをご覧ください：

エラーを返した呼び出しの再試行

エラー応答後に呼び出しを再試行する場合、Momento SDK に期待できる一般的な動作パターンは次のとおりです：

Momento SDKは、スロット付きリクエスト(制限超過)を再試行しません。その他のエラーについては、要求された操作が idempotent でない場合、SDK は再試行しません。例えば、カウンターをインクリメントしているときにエラー応答を受け取った場合、SDKはあなたの代わりにリトライを行いません（これはオーバーカウントになる可能性があるため）。べきでない操作の場合、リトライするかどうかは開発者に選択させた方が安全です。