Add retry option

[Sinhalite]

概要

APIのレスポンスがエラーで返却された際に、最大2回までリトライを行うオプションを追加しました。
(最初のリクエストと合わせて計3回)

Issue #38 に対応するPRとなります。
提案では、リクエスト時のオプションの案もありましたが、Clientの生成時にオプション指定する形としています。

const client = createClient({
  serviceDomain: "YOUR_DOMAIN",
  apiKey: "YOUR_API_KEY",
  retry: true 
});

リトライにあたっては、リクエストの分散のため、ExponentialBackoffが採用されています。
(async-retryライブラリにて、標準的に実装されています。)

実際の挙動

Next.jsでビルドを行った際の挙動です。
(リトライ再現の都合上、404の際にもリトライするように変更して、実施してます。)

Screen.Recording.2023-04-15.at.7.16.58.PM.mov

[Sinhalite]

リトライはデフォルトの設定ではOFFとしています、

Exponential Backoffのアルゴリズムについては、async-retryのReadmeに記載があります。
https://github.com/vercel/async-retry#api

こちらの設定の場合、
1回目のリトライ: 1回目のリクエスト失敗から、5秒〜10秒のディレイ
2回目のリトライ: 2回目のリクエスト失敗から、10秒〜20秒のディレイ
の間に実行されます。

[dc7290]

全体的に良さそうです！

1点だけ、get, createなどのメソッドを呼び出すときに上書きできる方がいいかなと思いました。
SDKの用途として、サーバー側、クライアント側の2つがありますが、このうちクライアント側はSWRなどのライブラリを使用することも多く、その場合はRetryオプションをオフにするのではないかと思いました。
そのため、デフォルトの設定をcreateClientで設定し、メソッド側でそれを上書きできるような設計はどうでしょうか？

[Sinhalite]

@dc7290
レビューどうもです！

1点だけ、get, createなどのメソッドを呼び出すときに上書きできる方がいいかなと思いました。 SDKの用途として、サーバー側、クライアント側の2つがありますが、このうちクライアント側はSWRなどのライブラリを使用することも多く、その場合はRetryオプションをオフにするのではないかと思いました。 そのため、デフォルトの設定をcreateClientで設定し、メソッド側でそれを上書きできるような設計はどうでしょうか？

クライアントサイドだと、別ライブラリでの制御としたいケースがありそうというのは、確かにですね。
こちらに関しては、ReadmeのTipsにあるようにClientを作り分ける方法でも良いかなと思ったんですが、どうでしょう？
https://github.com/microcmsio/microcms-js-sdk#tips

[himorishige]

対応ありがとうございます！すばらしい！
自分もSSGなどビルド時には必要だと思いますが、デプロイされたサイト上では利用すること少ないかなと思います。
デフォルトではOFFでビルド時だけONに上書きできるようにするとかできると運用しやすいかなと。
もしくは上記の通りClientを使い分けてもらうというのも良さそうですね。

[Sinhalite]

レビューありがとうございました！

リトライ設定のスコープをより柔軟に制限できても良さそうという件は、

• Clientの使い分けによって一定の対処ができそう
• オプショナルな仕様追加とはなりそうなので、破壊的な変更等はなく今後実装できそう

という観点があるかとおもったので、こちらについては、マージしてリリースする流れで進めたいと思います。

[dc7290]

LGTM!!

[himorishige]

上記方針で良いと思います。
対応ありがとうございます！