feat: add enableRetries and disableRetries

lib/base-service.ts

@@ -18,7 +18,7 @@ import { OutgoingHttpHeaders } from 'http';
 import { AuthenticatorInterface, checkCredentials, readExternalSources } from '../auth';
 import { stripTrailingSlash } from './helper';
 import logger from './logger';
-import { RequestWrapper } from './request-wrapper';
+import { RequestWrapper, RetryOptions } from './request-wrapper';
 
 /**
  * Configuration values for a service.
@@ -65,7 +65,7 @@ export class BaseService {
 
   private authenticator: AuthenticatorInterface;
 
-  private requestWrapperInstance;
+  private requestWrapperInstance: RequestWrapper;
 
   /**
    * Configuration values for a service.
@@ -170,6 +170,22 @@ export class BaseService {
     return this.requestWrapperInstance.getHttpClient();
   }
 
+  /**
+   * Enable retries for unfulfilled requests.
+   *
+   * @param {Map<string, number>} retryConfig configuration for retries
+   */
+  public enableRetries(retryConfig?: RetryOptions) {
+    return this.requestWrapperInstance.enableRetries(retryConfig);
+  }
+
+  /**
+   * Disables retries.
+   */
+  public disableRetries() {
+    return this.requestWrapperInstance.disableRetries();
+  }
+
   /**
    * Configure the service using external configuration
    *

lib/request-wrapper.ts

@@ -16,7 +16,8 @@
  * limitations under the License.
  */
 
-import axios, { AxiosRequestConfig } from 'axios';
+import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
+import * as rax from 'retry-axios';
 
 import axiosCookieJarSupport from 'axios-cookiejar-support';
 import extend = require('extend');
@@ -36,10 +37,29 @@ import {
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
 
+/**
+ * Retry configuration options.
+ */
+export interface RetryOptions {
+  /**
+   * Maximum retries to attempt.
+   */
+  maxRetries?: number;
+
+  /**
+   * Ceiling for the retry delay (in ms) - delay will not exceed this value.
+   */
+  maxRetryInterval?: number;
+}
+
 export class RequestWrapper {
-  private axiosInstance;
+  private axiosInstance: AxiosInstance;
 
-  private compressRequestData: boolean;
+  private retryInterceptorId: number;
+
+  private retryConfig: rax.RetryConfig;
+
+  public compressRequestData: boolean;
 
   constructor(axiosOptions?) {
     axiosOptions = axiosOptions || {};
@@ -240,6 +260,7 @@ export class RequestWrapper {
       headers,
       params: qs,
       data,
+      raxConfig: this.retryConfig ?? this.retryConfig,
       responseType: options.responseType || 'json',
       paramsSerializer: (params) => querystring.stringify(params),
     };
@@ -257,7 +278,8 @@ export class RequestWrapper {
         delete res.request;
 
         // the other sdks use the interface `result` for the body
-        res.result = res.data;
+        // eslint-disable-next-line @typescript-eslint/dot-notation
+        res['result'] = res.data;
         delete res.data;
 
         // return another promise that resolves with 'res' to be handled in generated code
@@ -346,6 +368,40 @@ export class RequestWrapper {
     return this.axiosInstance;
   }
 
+  private static getRetryConfig(
+    axiosInstance: AxiosInstance,
+    retryConfig?: RetryOptions
+  ): rax.RetryConfig {
+    const config: rax.RetryConfig = {
+      instance: axiosInstance,
+      backoffType: 'exponential',
+      checkRetryAfter: true,
+    };
+    if (retryConfig) {
+      if (typeof retryConfig.maxRetries === 'number') {
+        config.retry = retryConfig.maxRetries;
+      }
+      if (typeof retryConfig.maxRetryInterval === 'number') {
+        config.maxRetryDelay = retryConfig.maxRetryInterval;
+      }
+    }
+    return config;
+  }
+
+  public enableRetries(retryConfig?: RetryOptions) {
+    this.axiosInstance.defaults.raxConfig = {
+      instance: this.axiosInstance,
+    };
+    this.retryConfig = RequestWrapper.getRetryConfig(this.axiosInstance, retryConfig);
+    this.retryInterceptorId = rax.attach(this.axiosInstance);
+  }
+
+  public disableRetries() {
+    if (this.retryInterceptorId) {
+      rax.detach(this.retryInterceptorId, this.axiosInstance);
+    }
+  }
+
   private async gzipRequestBody(data: any, headers: OutgoingHttpHeaders): Promise<Buffer | any> {
     // skip compression if user has set the encoding header to gzip
     const contentSetToGzip =

package.json

@@ -78,6 +78,7 @@
     "mime-types": "~2.1.18",
     "object.omit": "~3.0.0",
     "object.pick": "~1.3.0",
+    "retry-axios": "^2.6.0",
     "semver": "^6.2.0",
     "tough-cookie": "^4.0.0"
   },