Merge pull request coinbase#105 from coinbase/feat/network-retry

Adding retry for failed GET requests

Author: erdimaden

package.json

@@ -28,6 +28,7 @@
     "@scure/bip32": "^1.4.0",
     "axios": "^1.6.8",
     "axios-mock-adapter": "^1.22.0",
+    "axios-retry": "^4.4.1",
     "bip32": "^4.0.0",
     "bip39": "^3.1.0",
     "decimal.js": "^10.4.3",

src/coinbase/coinbase.ts

@@ -1,4 +1,5 @@
-import globalAxios from "axios";
+import globalAxios, { AxiosError } from "axios";
+import axiosRetry from "axios-retry";
 import * as fs from "fs";
 import {
   User as UserModel,
@@ -77,6 +78,7 @@ export class Coinbase {
    * @param options.useServerSigner - Whether to use a Server-Signer or not.
    * @param options.debugging - If true, logs API requests and responses to the console.
    * @param options.basePath - The base path for the API.
+   * @param options.maxNetworkRetries - The maximum number of network retries for the API GET requests.
    * @throws {InternalError} If the configuration is invalid.
    * @throws {InvalidAPIKeyFormat} If not able to create JWT token.
    */
@@ -86,6 +88,7 @@ export class Coinbase {
     useServerSigner = false,
     debugging = false,
     basePath = BASE_PATH,
+    maxNetworkRetries = 3,
   }: CoinbaseOptions) {
     if (apiKeyName === "") {
       throw new InternalError("Invalid configuration: apiKeyName is empty");
@@ -98,6 +101,15 @@ export class Coinbase {
       basePath: basePath,
     });
     const axiosInstance = globalAxios.create();
+    axiosRetry(axiosInstance, {
+      retries: maxNetworkRetries,
+      retryCondition: (error: AxiosError) => {
+        return (
+          error.config?.method?.toUpperCase() === "GET" &&
+          (error.response?.status || 0) in [500, 502, 503, 504]
+        );
+      },
+    });
     registerAxiosInterceptors(
       axiosInstance,
       config => coinbaseAuthenticator.authenticateRequest(config, debugging),

src/coinbase/types.ts

@@ -662,6 +662,11 @@ export type CoinbaseOptions = {
    * The base path for the API.
    */
   basePath?: string;
+
+  /**
+   * The maximum number of network retries for the API GET requests.
+   */
+  maxNetworkRetries?: number;
 };
 
 /**

yarn.lock

@@ -1052,6 +1052,13 @@ axios-mock-adapter@^1.22.0:
     fast-deep-equal "^3.1.3"
     is-buffer "^2.0.5"
 
+axios-retry@^4.4.1:
+  version "4.4.1"
+  resolved "https://registry.yarnpkg.com/axios-retry/-/axios-retry-4.4.1.tgz#e5d0c851e635fd4de866aec2b9b422f05d661257"
+  integrity sha512-JGzNoglDHtHWIEvvAampB0P7jxQ/sT4COmW0FgSQkVg6o4KqNjNMBI6uFVOq517hkw/OAYYAG08ADtBlV8lvmQ==
+  dependencies:
+    is-retry-allowed "^2.2.0"
+
 axios@^1.6.8:
   version "1.6.8"
   resolved "https://registry.yarnpkg.com/axios/-/axios-1.6.8.tgz#66d294951f5d988a00e87a0ffb955316a619ea66"
@@ -2057,6 +2064,11 @@ is-path-inside@^3.0.3:
   resolved "https://registry.yarnpkg.com/is-path-inside/-/is-path-inside-3.0.3.tgz#d231362e53a07ff2b0e0ea7fed049161ffd16283"
   integrity sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==
 
+is-retry-allowed@^2.2.0:
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/is-retry-allowed/-/is-retry-allowed-2.2.0.tgz#88f34cbd236e043e71b6932d09b0c65fb7b4d71d"
+  integrity sha512-XVm7LOeLpTW4jV19QSH38vkswxoLud8sQ57YwJVTPWdiaI9I8keEhGFpBlslyVsgdQy4Opg8QOLb8YRgsyZiQg==
+
 is-stream@^2.0.0:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077"