ibm-cloud-sdk-core 5.0.1 → 5.1.0

package/lib/request-wrapper.js

@@ -76,7 +76,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestWrapper = void 0;
 /**
- * (C) Copyright IBM Corp. 2014, 2023.
+ * (C) Copyright IBM Corp. 2014, 2024.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -99,6 +99,7 @@ var isstream_1 = __importDefault(require("isstream"));
 var querystring_1 = require("querystring");
 var zlib_1 = require("zlib");
 var helper_1 = require("./helper");
+var private_helpers_1 = require("./private-helpers");
 var logger_1 = __importDefault(require("./logger"));
 var stream_to_promise_1 = require("./stream-to-promise");
 var cookie_support_1 = require("./cookie-support");
@@ -154,28 +155,96 @@ var RequestWrapper = /** @class */ (function () {
             }
             this.enableRetries(retryOptions);
         }
-        // set debug interceptors
-        if (process.env.NODE_DEBUG === 'axios' || process.env.DEBUG) {
-            this.axiosInstance.interceptors.request.use(function (config) {
-                logger_1.default.debug('Request:');
-                logger_1.default.debug(config);
-                return config;
+        // If debug logging is requested, set up interceptors to log http request/response messages.
+        if (logger_1.default.debug.enabled || process.env.NODE_DEBUG === 'axios') {
+            this.axiosInstance.interceptors.request.use(function (request) {
+                logger_1.default.debug("--> HTTP Request:\n".concat(_this.formatAxiosRequest(request)));
+                return request;
             }, function (error) {
-                logger_1.default.error('Error: ');
-                logger_1.default.error(error);
+                logger_1.default.debug("<-- HTTP Error:\n".concat(_this.formatAxiosError(error)));
                 return Promise.reject(error);
             });
             this.axiosInstance.interceptors.response.use(function (response) {
-                logger_1.default.debug('Response:');
-                logger_1.default.debug(response);
+                logger_1.default.debug("<-- HTTP Response:\n".concat(_this.formatAxiosResponse(response)));
                 return response;
             }, function (error) {
-                logger_1.default.error('Error: ');
-                logger_1.default.error(error);
+                logger_1.default.debug("<-- HTTP Error:\n".concat(_this.formatAxiosError(error)));
                 return Promise.reject(error);
             });
         }
     }
+    /**
+     * Formats the specified Axios request for debug logging.
+     * @param request - the request to be logged
+     * @returns the string representation of the request
+     */
+    RequestWrapper.prototype.formatAxiosRequest = function (request) {
+        var method = request.method, url = request.url, data = request.data, headers = request.headers;
+        var headersOutput = this.formatAxiosHeaders(headers);
+        var body = this.formatAxiosBody(data);
+        var output = "".concat((method || '??').toUpperCase(), " ").concat(url || '??', "\n").concat(headersOutput, "\n").concat(body);
+        return (0, private_helpers_1.redactSecrets)(output);
+    };
+    /**
+     * Formats the specified Axios response for debug logging.
+     * @param response - the response to be logged
+     * @returns the string representation of the response
+     */
+    RequestWrapper.prototype.formatAxiosResponse = function (response) {
+        var status = response.status, statusText = response.statusText, headers = response.headers, data = response.data;
+        var headersOutput = this.formatAxiosHeaders(headers);
+        var body = this.formatAxiosBody(data);
+        var statusMsg = statusText || "status_code_".concat(status);
+        var output = "".concat(status, " ").concat(statusMsg, "\n").concat(headersOutput, "\n").concat(body);
+        return (0, private_helpers_1.redactSecrets)(output);
+    };
+    /**
+     * Formats the specified Axios error for debug logging.
+     * @param error - the error to be logged
+     * @returns the string representation of the error
+     */
+    RequestWrapper.prototype.formatAxiosError = function (error) {
+        var response = error.response;
+        var output = "HTTP error message=".concat(error.message || '', ", code=").concat(error.code || '');
+        if (response) {
+            output = this.formatAxiosResponse(response);
+        }
+        return output;
+    };
+    /**
+     * Formats 'headers' to be included in the debug output
+     * like this:
+     *    Accept: application/json
+     *    Content-Type: application/json
+     *    My-Header: my-value
+     *    ...
+     * @param headers - the headers associated with an Axios request or response
+     * @returns the formatted output to be included in the HTTP message traces
+     */
+    RequestWrapper.prototype.formatAxiosHeaders = function (headers) {
+        var output = '';
+        if (headers) {
+            var lines_1 = [];
+            Object.keys(headers).forEach(function (key) {
+                lines_1.push("".concat(key, ": ").concat(headers[key]));
+            });
+            output = lines_1.join('\n');
+        }
+        return output;
+    };
+    /**
+     * Formats 'body' (either a string or object/array) to be included in the debug output
+     *
+     * @param body - a string, object or array that contains the request or response body
+     * @returns the formatted output to be included in the HTTP message traces
+     */
+    RequestWrapper.prototype.formatAxiosBody = function (body) {
+        var output = '';
+        if (body) {
+            output = typeof body === 'string' ? body : JSON.stringify(body);
+        }
+        return output;
+    };
     RequestWrapper.prototype.setCompressRequestData = function (setting) {
         this.compressRequestData = setting;
     };
@@ -381,7 +450,8 @@ var RequestWrapper = /** @class */ (function () {
             instance: axiosInstance,
             backoffType: 'exponential',
             checkRetryAfter: true,
-            maxRetryDelay: 30 * 1000, // default to 30 sec max delay
+            maxRetryDelay: 30 * 1000,
+            shouldRetry: this.retryPolicy,
         };
         if (retryOptions) {
             if (typeof retryOptions.maxRetries === 'number') {
@@ -402,13 +472,42 @@ var RequestWrapper = /** @class */ (function () {
         }
         this.raxConfig = RequestWrapper.getRaxConfig(this.axiosInstance, retryOptions);
         this.retryInterceptorId = rax.attach(this.axiosInstance);
+        logger_1.default.debug("Enabled retries; maxRetries=".concat(this.raxConfig.retry, ", maxRetryInterval=").concat(this.raxConfig.maxRetryDelay));
     };
     RequestWrapper.prototype.disableRetries = function () {
         if (typeof this.retryInterceptorId === 'number') {
             rax.detach(this.retryInterceptorId, this.axiosInstance);
             delete this.retryInterceptorId;
             delete this.raxConfig;
+            logger_1.default.debug('Disabled retries');
+        }
+    };
+    /**
+     * Returns true iff the previously-failed request contained in "error" should be retried.
+     * @param error - an AxiosError instance that contains a previously-failed request
+     * @returns true iff the request should be retried
+     */
+    RequestWrapper.retryPolicy = function (error) {
+        if (logger_1.default.debug.enabled) {
+            var details = [];
+            if (error.response) {
+                var statusText = error.response.statusText || "";
+                details.push("status_code=".concat(error.response.status, " (").concat(statusText, ")"));
+            }
+            if (error.config) {
+                if (error.config.method) {
+                    details.push("method=".concat(error.config.method.toUpperCase()));
+                }
+                if (error.config.url) {
+                    details.push("url=".concat(error.config.url));
+                }
+            }
+            logger_1.default.debug("Considering retry attempt; ".concat(details.join(', ')));
         }
+        // Delegate to the default function defined by retry-axios.
+        var shouldRetry = rax.shouldRetryRequest(error);
+        logger_1.default.debug("Retry will ".concat(shouldRetry ? '' : 'not ', "be attempted"));
+        return shouldRetry;
     };
     RequestWrapper.prototype.gzipRequestBody = function (data, headers) {
         return __awaiter(this, void 0, void 0, function () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -51,7 +51,8 @@
     "tough-cookie": "^4.1.3"
   },
   "overrides": {
-    "semver": "^7.5.3"
+    "semver": "^7.5.3",
+    "micromatch": "4.0.8"
   },
   "browser": {
     "./auth/utils/read-credentials-file": "./auth/utils/read-credentials-file.browser"
@@ -60,13 +61,13 @@
     "node": ">=18"
   },
   "scripts": {
-    "clean": "rm -fr node_modules",
+    "clean": "rm -fr node_modules sdk-test-utilities/node_modules",
     "commitmsg": "commitlint -E GIT_PARAMS",
     "eslint:config": "eslint --print-config .eslintrc.js | eslint-config-prettier-check",
     "eslint:fix": "eslint . --fix",
     "eslint:check": "eslint . --cache",
     "lint": "npm run eslint:check",
-    "lint:fix": "npm run eslint:fix",
+    "fix": "npm run eslint:fix",
     "jest": "jest",
     "test": "jest test/unit/",
     "test-travis": "jest --runInBand test/unit/",

package/sdk-test-utilities/package-lock.json

@@ -1,15 +1,18 @@
 {
   "name": "@ibm-cloud/sdk-test-utilities",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@ibm-cloud/sdk-test-utilities",
-      "version": "0.0.1",
+      "version": "1.0.0",
       "license": "Apache-2.0",
       "dependencies": {
         "expect": "^29.7.0"
+      },
+      "engines": {
+        "node": ">=18"
       }
     },
     "node_modules/@babel/code-frame": {
@@ -410,9 +413,9 @@
       "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ=="
     },
     "node_modules/micromatch": {
-      "version": "4.0.7",
-      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz",
-      "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==",
+      "version": "4.0.8",
+      "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+      "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
       "dependencies": {
         "braces": "^3.0.3",
         "picomatch": "^2.3.1"

package/sdk-test-utilities/package.json

@@ -11,6 +11,9 @@
   "dependencies": {
     "expect": "^29.7.0"
   },
+  "overrides": {
+    "micromatch": "4.0.8"
+  },
   "engines": {
     "node": ">=18"
   }