ibm-cloud-sdk-core 2.12.1 → 2.14.1

package/.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "package-lock.json|^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2021-08-05T20:39:19Z",
+  "generated_at": "2021-08-17T20:14:30Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -323,6 +323,14 @@
         "line_number": 29,
         "type": "Secret Keyword",
         "verified_result": null
+      },
+      {
+        "hashed_secret": "e38ad214943daad1d64c102faec29de4afe9da3d",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 36,
+        "type": "Secret Keyword",
+        "verified_result": null
       }
     ],
     "test/resources/vcap.json": [
@@ -492,7 +500,7 @@
         "hashed_secret": "407bb564bd0e4d31368cb53004c9c42adf8f7be8",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 163,
+        "line_number": 174,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -500,7 +508,7 @@
         "hashed_secret": "2863fa4b5510c46afc2bd2998dfbc0cf3d6df032",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 189,
+        "line_number": 200,
         "type": "Secret Keyword",
         "verified_result": null
       },
@@ -508,7 +516,7 @@
         "hashed_secret": "ed8c99e906cf3fdbae90a71e06142ebc72b4c056",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 207,
+        "line_number": 218,
         "type": "Secret Keyword",
         "verified_result": null
       }

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [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)
+
+
+### Features
+
+* add method `getHttpClient` to get underlying axios instance of base service ([#155](https://github.com/IBM/node-sdk-core/issues/155)) ([2aede01](https://github.com/IBM/node-sdk-core/commit/2aede013cd398a2605fd67c0412e6ca5669c415e))
+
+## [2.12.2](https://github.com/IBM/node-sdk-core/compare/v2.12.1...v2.12.2) (2021-08-13)
+
+
+### Bug Fixes
+
+* support 'AUTHTYPE' as alias for 'AUTH_TYPE' config property ([#153](https://github.com/IBM/node-sdk-core/issues/153)) ([fccf209](https://github.com/IBM/node-sdk-core/commit/fccf2093874835d9c77c08843809b79e57fb0e78))
+
 ## [2.12.1](https://github.com/IBM/node-sdk-core/compare/v2.12.0...v2.12.1) (2021-08-11)
 
 

package/auth/utils/get-authenticator-from-environment.js

@@ -53,6 +53,10 @@ function getAuthenticatorFromEnvironment(serviceName) {
     // if an apikey is provided, default to IAM
     // if not, default to container auth
     var authType = credentials.authType;
+    if (!authType) {
+        // Support the alternate "AUTHTYPE" config property.
+        authType = credentials.authtype;
+    }
     if (!authType || typeof authType !== 'string') {
         authType = credentials.apikey ? 'iam' : 'container';
     }

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.
@@ -88,6 +92,21 @@ export declare class BaseService {
      * @param {boolean} setting Will turn it on if 'true', off if 'false'.
      */
     setEnableGzipCompression(setting: boolean): void;
+    /**
+     * Get the Axios instance set on the service.
+     * All requests will be made using this instance.
+     */
+    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,10 +109,31 @@ 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;
     };
+    /**
+     * Get the Axios instance set on the service.
+     * All requests will be made using this instance.
+     */
+    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
      *
@@ -171,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);
             }
@@ -181,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,5 +52,9 @@ export declare class RequestWrapper {
      * @returns {Error}
      */
     formatError(axiosError: any): Error;
+    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;
@@ -342,6 +359,45 @@ var RequestWrapper = /** @class */ (function () {
         }
         return error;
     };
+    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.12.1",
+  "version": "2.14.1",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index",
   "repository": {
@@ -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,