ibm-cloud-sdk-core 2.13.0 → 2.14.3

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [2.14.3](https://github.com/IBM/node-sdk-core/compare/v2.14.2...v2.14.3) (2021-09-09)
+
+
+### Bug Fixes
+
+* **build:** update dependencies ([#161](https://github.com/IBM/node-sdk-core/issues/161)) ([8a37ef0](https://github.com/IBM/node-sdk-core/commit/8a37ef030c5ea793e79ea451043f71cd860ff14b))
+
+## [2.14.2](https://github.com/IBM/node-sdk-core/compare/v2.14.1...v2.14.2) (2021-09-09)
+
+
+### Bug Fixes
+
+* **build:** bump axios to 0.21.4 to avoid vulnerabilities ([#160](https://github.com/IBM/node-sdk-core/issues/160)) ([12a6c5b](https://github.com/IBM/node-sdk-core/commit/12a6c5b799ff349c9e5ad12df8f383f4f673417d))
+
+## [2.14.1](https://github.com/IBM/node-sdk-core/compare/v2.14.0...v2.14.1) (2021-08-31)
+
+
+### Performance Improvements
+
+* use maxContentLength -1 instead of Infinity ([#158](https://github.com/IBM/node-sdk-core/issues/158)) ([adbbb3b](https://github.com/IBM/node-sdk-core/commit/adbbb3bceb388b34753f9fe3579eec3f0520ddb3))
+
+# [2.14.0](https://github.com/IBM/node-sdk-core/compare/v2.13.0...v2.14.0) (2021-08-27)
+
+
+### Features
+
+* add enableRetries and disableRetries ([#156](https://github.com/IBM/node-sdk-core/issues/156)) ([d6f12e7](https://github.com/IBM/node-sdk-core/commit/d6f12e76c91f9f0ddce4fef09f5ff024ca3947bc))
+
 # [2.13.0](https://github.com/IBM/node-sdk-core/compare/v2.12.2...v2.13.0) (2021-08-18)
 
 

package/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/IBM/node-sdk-core.svg?branch=main)](https://travis-ci.com/IBM/node-sdk-core)
+[![Build Status](https://app.travis-ci.com/IBM/node-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/node-sdk-core)
 [![npm-version](https://img.shields.io/npm/v/ibm-cloud-sdk-core.svg)](https://www.npmjs.com/package/ibm-cloud-sdk-core)
 [![codecov](https://codecov.io/gh/IBM/node-sdk-core/branch/main/graph/badge.svg)](https://codecov.io/gh/IBM/node-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

package/auth/utils/read-external-sources.js

@@ -83,6 +83,15 @@ function filterPropertiesByServiceName(envObj, serviceName) {
     if (typeof credentials.enableGzip === 'string') {
         credentials.enableGzip = credentials.enableGzip === 'true';
     }
+    if (typeof credentials.enableRetries === 'string') {
+        credentials.enableRetries = credentials.enableRetries === 'true';
+    }
+    if (typeof credentials.maxRetries === 'string') {
+        credentials.maxRetries = parseInt(credentials.maxRetries, 10);
+    }
+    if (typeof credentials.retryInterval === 'string') {
+        credentials.retryInterval = parseInt(credentials.retryInterval, 10);
+    }
     return credentials;
 }
 /**

package/lib/base-service.d.ts

@@ -16,6 +16,7 @@
 /// <reference types="node" />
 import { OutgoingHttpHeaders } from 'http';
 import { AuthenticatorInterface } from '../auth';
+import { RetryOptions } from './request-wrapper';
 /**
  * Configuration values for a service.
  */
@@ -42,7 +43,10 @@ export interface UserOptions {
  */
 export interface BaseServiceOptions extends UserOptions {
     /** Querystring to be sent with every request. If not a string will be stringified. */
-    qs: any;
+    qs?: any;
+    enableRetries?: boolean;
+    maxRetries?: number;
+    retryInterval?: number;
 }
 /**
  * Common functionality shared by generated service classes.
@@ -92,7 +96,17 @@ export declare class BaseService {
      * Get the Axios instance set on the service.
      * All requests will be made using this instance.
      */
-    getHttpClient(): any;
+    getHttpClient(): import("axios").AxiosInstance;
+    /**
+     * Enable retries for unfulfilled requests.
+     *
+     * @param {RetryOptions} retryOptions configuration for retries
+     */
+    enableRetries(retryOptions?: RetryOptions): void;
+    /**
+     * Disables retries.
+     */
+    disableRetries(): void;
     /**
      * Configure the service using external configuration
      *

package/lib/base-service.js

@@ -109,7 +109,7 @@ var BaseService = /** @class */ (function () {
      * @param {boolean} setting Will turn it on if 'true', off if 'false'.
      */
     BaseService.prototype.setEnableGzipCompression = function (setting) {
-        this.requestWrapperInstance.compressRequestData = setting;
+        this.requestWrapperInstance.setCompressRequestData(setting);
         // persist setting so that baseOptions accurately reflects the state of the flag
         this.baseOptions.enableGzipCompression = setting;
     };
@@ -120,6 +120,20 @@ var BaseService = /** @class */ (function () {
     BaseService.prototype.getHttpClient = function () {
         return this.requestWrapperInstance.getHttpClient();
     };
+    /**
+     * Enable retries for unfulfilled requests.
+     *
+     * @param {RetryOptions} retryOptions configuration for retries
+     */
+    BaseService.prototype.enableRetries = function (retryOptions) {
+        this.requestWrapperInstance.enableRetries(retryOptions);
+    };
+    /**
+     * Disables retries.
+     */
+    BaseService.prototype.disableRetries = function () {
+        this.requestWrapperInstance.disableRetries();
+    };
     /**
      * Configure the service using external configuration
      *
@@ -178,7 +192,7 @@ var BaseService = /** @class */ (function () {
             // - url
             // - disableSsl
             // - enableGzip
-            var url = properties.url, disableSsl = properties.disableSsl, enableGzip = properties.enableGzip;
+            var url = properties.url, disableSsl = properties.disableSsl, enableGzip = properties.enableGzip, enableRetries = properties.enableRetries, maxRetries = properties.maxRetries, retryInterval = properties.retryInterval;
             if (url) {
                 results.serviceUrl = helper_1.stripTrailingSlash(url);
             }
@@ -188,6 +202,15 @@ var BaseService = /** @class */ (function () {
             if (enableGzip === true) {
                 results.enableGzipCompression = enableGzip;
             }
+            if (enableRetries !== undefined) {
+                results.enableRetries = enableRetries;
+            }
+            if (maxRetries !== undefined) {
+                results.maxRetries = maxRetries;
+            }
+            if (retryInterval !== undefined) {
+                results.retryInterval = retryInterval;
+            }
         }
         return results;
     };

package/lib/request-wrapper.d.ts

@@ -1,7 +1,39 @@
+/**
+ * Copyright 2014 IBM Corp. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AxiosInstance } from 'axios';
+/**
+ * Retry configuration options.
+ */
+export interface RetryOptions {
+    /**
+     * Maximum retries to attempt.
+     */
+    maxRetries?: number;
+    /**
+     * Ceiling for the retry delay (in seconds) - delay will not exceed this value.
+     */
+    maxRetryInterval?: number;
+}
 export declare class RequestWrapper {
     private axiosInstance;
     private compressRequestData;
+    private retryInterceptorId;
+    private raxConfig;
     constructor(axiosOptions?: any);
+    setCompressRequestData(setting: boolean): void;
     /**
      * Creates the request.
      * 1. Merge default options with user provided options
@@ -20,6 +52,9 @@ export declare class RequestWrapper {
      * @returns {Error}
      */
     formatError(axiosError: any): Error;
-    getHttpClient(): any;
+    getHttpClient(): AxiosInstance;
+    private static getRaxConfig;
+    enableRetries(retryOptions?: RetryOptions): void;
+    disableRetries(): void;
     private gzipRequestBody;
 }

package/lib/request-wrapper.js

@@ -64,6 +64,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * limitations under the License.
  */
 var axios_1 = require("axios");
+var rax = require("retry-axios");
 var axios_cookiejar_support_1 = require("axios-cookiejar-support");
 var extend = require("extend");
 var FormData = require("form-data");
@@ -83,7 +84,7 @@ var RequestWrapper = /** @class */ (function () {
         // to 'application/x-www-form-urlencoded'. This causes problems, so overriding the
         // defaults here
         var axiosConfig = {
-            maxContentLength: Infinity,
+            maxContentLength: -1,
             maxBodyLength: Infinity,
             headers: {
                 post: {
@@ -123,6 +124,17 @@ var RequestWrapper = /** @class */ (function () {
             this.axiosInstance.defaults.withCredentials = true;
             this.axiosInstance.defaults.jar = axiosOptions.jar;
         }
+        // get retry config properties and conditionally enable retries
+        if (axiosOptions.enableRetries) {
+            var retryOptions = {};
+            if (axiosOptions.maxRetries !== undefined) {
+                retryOptions.maxRetries = axiosOptions.maxRetries;
+            }
+            if (axiosOptions.retryInterval !== undefined) {
+                retryOptions.maxRetryInterval = axiosOptions.retryInterval;
+            }
+            this.enableRetries(retryOptions);
+        }
         // set debug interceptors
         if (process.env.NODE_DEBUG === 'axios' || process.env.DEBUG) {
             this.axiosInstance.interceptors.request.use(function (config) {
@@ -165,6 +177,9 @@ var RequestWrapper = /** @class */ (function () {
             });
         }
     }
+    RequestWrapper.prototype.setCompressRequestData = function (setting) {
+        this.compressRequestData = setting;
+    };
     /**
      * Creates the request.
      * 1. Merge default options with user provided options
@@ -253,6 +268,7 @@ var RequestWrapper = /** @class */ (function () {
                             headers: headers,
                             params: qs,
                             data: data,
+                            raxConfig: this.raxConfig,
                             responseType: options.responseType || 'json',
                             paramsSerializer: function (params) { return querystring.stringify(params); },
                         };
@@ -266,7 +282,8 @@ var RequestWrapper = /** @class */ (function () {
                                 delete res.config;
                                 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
                                 return res;
@@ -345,6 +362,42 @@ var RequestWrapper = /** @class */ (function () {
     RequestWrapper.prototype.getHttpClient = function () {
         return this.axiosInstance;
     };
+    RequestWrapper.getRaxConfig = function (axiosInstance, retryOptions) {
+        var config = {
+            retry: 4,
+            retryDelay: 1000,
+            instance: axiosInstance,
+            backoffType: 'exponential',
+            checkRetryAfter: true,
+            maxRetryDelay: 30 * 1000,
+        };
+        if (retryOptions) {
+            if (typeof retryOptions.maxRetries === 'number') {
+                config.retry = retryOptions.maxRetries;
+            }
+            if (typeof retryOptions.maxRetryInterval === 'number') {
+                // convert seconds to ms for retry-axios
+                config.maxRetryDelay = retryOptions.maxRetryInterval * 1000;
+            }
+        }
+        return config;
+    };
+    RequestWrapper.prototype.enableRetries = function (retryOptions) {
+        // avoid attaching the same interceptor multiple times
+        // to protect against user error and ensure disableRetries() always disables retries
+        if (typeof this.retryInterceptorId === 'number') {
+            this.disableRetries();
+        }
+        this.raxConfig = RequestWrapper.getRaxConfig(this.axiosInstance, retryOptions);
+        this.retryInterceptorId = rax.attach(this.axiosInstance);
+    };
+    RequestWrapper.prototype.disableRetries = function () {
+        if (typeof this.retryInterceptorId === 'number') {
+            rax.detach(this.retryInterceptorId, this.axiosInstance);
+            delete this.retryInterceptorId;
+            delete this.raxConfig;
+        }
+    };
     RequestWrapper.prototype.gzipRequestBody = function (data, headers) {
         return __awaiter(this, void 0, void 0, function () {
             var contentSetToGzip, reqBuffer, _a, _b, err_1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "2.13.0",
+  "version": "2.14.3",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index",
   "repository": {
@@ -37,7 +37,7 @@
     "@types/isstream": "^0.1.0",
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
-    "axios": "^0.21.1",
+    "axios": "^0.21.4",
     "axios-cookiejar-support": "^1.0.0",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",
@@ -52,6 +52,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"
   },
@@ -74,7 +75,8 @@
     "test-travis": "jest --runInBand test/unit/",
     "report-coverage": "codecov",
     "build": "tsc",
-    "postversion": "tsc-publish --no-checks --dry-run"
+    "postversion": "tsc-publish --no-checks --dry-run",
+    "all": "npm run build && npm run test && npm run lint"
   },
   "jest": {
     "collectCoverage": true,