ibm-cloud-sdk-core 4.0.4 → 4.0.6

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.0.6](https://github.com/IBM/node-sdk-core/compare/v4.0.5...v4.0.6) (2023-05-18)
+
+
+### Bug Fixes
+
+* use consistent message for JSON.parse() errors ([#243](https://github.com/IBM/node-sdk-core/issues/243)) ([3cc7bab](https://github.com/IBM/node-sdk-core/commit/3cc7babac6a14b1744d64cf3ab93063b2ce63643))
+
+## [4.0.5](https://github.com/IBM/node-sdk-core/compare/v4.0.4...v4.0.5) (2023-03-01)
+
+
+### Bug Fixes
+
+* correctly handle empty response bodies ([#239](https://github.com/IBM/node-sdk-core/issues/239)) ([d0c9cb3](https://github.com/IBM/node-sdk-core/commit/d0c9cb37b00adf4493fd46a3ae72123d6f1e33e7))
+
 ## [4.0.4](https://github.com/IBM/node-sdk-core/compare/v4.0.3...v4.0.4) (2023-02-27)
 
 

package/es/lib/chain-error.d.ts

@@ -0,0 +1,26 @@
+/**
+ * (C) Copyright IBM Corp. 2023.
+ *
+ * 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.
+ */
+/**
+ * Given two Error instances 'error' and 'causedBy', this function will
+ * update 'error' by chaining 'causedBy' to it.
+ * Specifically, 'causedBy''s message and stack will be appended
+ * to 'error''s message and stack, respectively, to simulate chained Errors.
+ *
+ * @param error the Error object to be updated
+ * @param causedBy an Error object that represents the cause of 'error'
+ * @returns 'error' after updating its message and stack fields
+ */
+export declare function chainError(error: Error, causedBy: Error): Error;

package/es/lib/chain-error.js

@@ -0,0 +1,32 @@
+/**
+ * (C) Copyright IBM Corp. 2023.
+ *
+ * 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.
+ */
+/**
+ * Given two Error instances 'error' and 'causedBy', this function will
+ * update 'error' by chaining 'causedBy' to it.
+ * Specifically, 'causedBy''s message and stack will be appended
+ * to 'error''s message and stack, respectively, to simulate chained Errors.
+ *
+ * @param error the Error object to be updated
+ * @param causedBy an Error object that represents the cause of 'error'
+ * @returns 'error' after updating its message and stack fields
+ */
+export function chainError(error, causedBy) {
+    error.message += ` ${causedBy.toString()}`;
+    if (causedBy.stack) {
+        error.stack += `\nCaused by: ${causedBy.stack}`;
+    }
+    return error;
+}

package/es/lib/cookie-support.d.ts

@@ -13,11 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { InternalAxiosRequestConfig, AxiosResponse } from 'axios';
 import { CookieJar } from 'tough-cookie';
 export declare class CookieInterceptor {
     private readonly cookieJar;
     constructor(cookieJar: CookieJar | boolean);
-    requestInterceptor(config: AxiosRequestConfig): Promise<AxiosRequestConfig<any>>;
+    requestInterceptor(config: InternalAxiosRequestConfig): Promise<InternalAxiosRequestConfig<any>>;
     responseInterceptor(response: AxiosResponse): Promise<AxiosResponse<any, any>>;
 }

package/es/lib/request-wrapper.js

@@ -35,6 +35,7 @@ import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata,
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
 import { CookieInterceptor } from './cookie-support';
+import { chainError } from './chain-error';
 export class RequestWrapper {
     constructor(axiosOptions) {
         axiosOptions = axiosOptions || {};
@@ -462,7 +463,11 @@ function parseServiceErrorMessage(response) {
  * @throws error - if the content is meant as JSON but is malformed
  */
 function ensureJSONResponseBodyIsObject(response) {
-    if (typeof response.data !== 'string' || !isJsonMimeType(response.headers['content-type'])) {
+    // If axios gave us an empty string, it is because the response had an empty body
+    // which can happen for a HEAD request, etc. Return the empty string in that case
+    if (typeof response.data !== 'string' ||
+        response.data === '' ||
+        !isJsonMimeType(response.headers['content-type'])) {
         return response.data;
     }
     // If the content is supposed to be JSON but axios gave us a string, it is most
@@ -475,9 +480,9 @@ function ensureJSONResponseBodyIsObject(response) {
         dataAsObject = JSON.parse(response.data);
     }
     catch (e) {
-        logger.error('Response body was supposed to have JSON content but JSON parsing failed.');
-        logger.error(`Malformed JSON string: ${response.data}`);
-        throw e;
+        logger.verbose('Response body was supposed to have JSON content but JSON parsing failed.');
+        logger.verbose(`Malformed JSON string: ${response.data}`);
+        throw chainError(new Error('Error processing HTTP response:'), e);
     }
     return dataAsObject;
 }

package/lib/chain-error.d.ts

@@ -0,0 +1,26 @@
+/**
+ * (C) Copyright IBM Corp. 2023.
+ *
+ * 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.
+ */
+/**
+ * Given two Error instances 'error' and 'causedBy', this function will
+ * update 'error' by chaining 'causedBy' to it.
+ * Specifically, 'causedBy''s message and stack will be appended
+ * to 'error''s message and stack, respectively, to simulate chained Errors.
+ *
+ * @param error the Error object to be updated
+ * @param causedBy an Error object that represents the cause of 'error'
+ * @returns 'error' after updating its message and stack fields
+ */
+export declare function chainError(error: Error, causedBy: Error): Error;

package/lib/chain-error.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * (C) Copyright IBM Corp. 2023.
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chainError = void 0;
+/**
+ * Given two Error instances 'error' and 'causedBy', this function will
+ * update 'error' by chaining 'causedBy' to it.
+ * Specifically, 'causedBy''s message and stack will be appended
+ * to 'error''s message and stack, respectively, to simulate chained Errors.
+ *
+ * @param error the Error object to be updated
+ * @param causedBy an Error object that represents the cause of 'error'
+ * @returns 'error' after updating its message and stack fields
+ */
+function chainError(error, causedBy) {
+    error.message += " ".concat(causedBy.toString());
+    if (causedBy.stack) {
+        error.stack += "\nCaused by: ".concat(causedBy.stack);
+    }
+    return error;
+}
+exports.chainError = chainError;

package/lib/cookie-support.d.ts

@@ -13,11 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { InternalAxiosRequestConfig, AxiosResponse } from 'axios';
 import { CookieJar } from 'tough-cookie';
 export declare class CookieInterceptor {
     private readonly cookieJar;
     constructor(cookieJar: CookieJar | boolean);
-    requestInterceptor(config: AxiosRequestConfig): Promise<AxiosRequestConfig<any>>;
+    requestInterceptor(config: InternalAxiosRequestConfig): Promise<InternalAxiosRequestConfig<any>>;
     responseInterceptor(response: AxiosResponse): Promise<AxiosResponse<any, any>>;
 }

package/lib/request-wrapper.js

@@ -102,6 +102,7 @@ var helper_1 = require("./helper");
 var logger_1 = __importDefault(require("./logger"));
 var stream_to_promise_1 = require("./stream-to-promise");
 var cookie_support_1 = require("./cookie-support");
+var chain_error_1 = require("./chain-error");
 var RequestWrapper = /** @class */ (function () {
     function RequestWrapper(axiosOptions) {
         var _this = this;
@@ -565,7 +566,11 @@ function parseServiceErrorMessage(response) {
  * @throws error - if the content is meant as JSON but is malformed
  */
 function ensureJSONResponseBodyIsObject(response) {
-    if (typeof response.data !== 'string' || !(0, helper_1.isJsonMimeType)(response.headers['content-type'])) {
+    // If axios gave us an empty string, it is because the response had an empty body
+    // which can happen for a HEAD request, etc. Return the empty string in that case
+    if (typeof response.data !== 'string' ||
+        response.data === '' ||
+        !(0, helper_1.isJsonMimeType)(response.headers['content-type'])) {
         return response.data;
     }
     // If the content is supposed to be JSON but axios gave us a string, it is most
@@ -578,9 +583,9 @@ function ensureJSONResponseBodyIsObject(response) {
         dataAsObject = JSON.parse(response.data);
     }
     catch (e) {
-        logger_1.default.error('Response body was supposed to have JSON content but JSON parsing failed.');
-        logger_1.default.error("Malformed JSON string: ".concat(response.data));
-        throw e;
+        logger_1.default.verbose('Response body was supposed to have JSON content but JSON parsing failed.');
+        logger_1.default.verbose("Malformed JSON string: ".concat(response.data));
+        throw (0, chain_error_1.chainError)(new Error('Error processing HTTP response:'), e);
     }
     return dataAsObject;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "4.0.4",
+  "version": "4.0.6",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",
@@ -42,7 +42,7 @@
     "@types/isstream": "^0.1.0",
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
-    "axios": "1.2.1",
+    "axios": "1.4.0",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",
     "dotenv": "^6.2.0",