@cloudant/couchbackup 2.11.0-249 → 2.11.1-266

package/README.md

@@ -33,7 +33,7 @@ npm install -g @cloudant/couchbackup
 ```
 
 ### Requirements
-* Node.js LTS version 18 or 20.
+* Node.js LTS version 18, 20, or 22.
 * The minimum required CouchDB version is 2.0.0.
 
 ### Snapshots

package/includes/request.js

@@ -1,4 +1,4 @@
-// Copyright © 2017, 2021 IBM Corp. All rights reserved.
+// Copyright © 2017, 2024 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.
@@ -16,7 +16,6 @@
 const pkg = require('../package.json');
 const { CloudantV1, CouchdbSessionAuthenticator } = require('@ibm-cloud/cloudant');
 const { IamAuthenticator, NoAuthAuthenticator } = require('ibm-cloud-sdk-core');
-const retryPlugin = require('retry-axios');
 const debug = require('debug')('couchbackup:request');
 
 const userAgent = 'couchbackup-cloudant/' + pkg.version + ' (Node.js ' +
@@ -25,7 +24,7 @@ const userAgent = 'couchbackup-cloudant/' + pkg.version + ' (Node.js ' +
 // An interceptor function to help augment error bodies with a little
 // extra information so we can continue to use consistent messaging
 // after the ugprade to @ibm-cloud/cloudant
-const errorHelper = async function(err) {
+function errorHelper(err) {
   debug('Entering error helper interceptor');
   let method;
   let requestUrl;
@@ -38,30 +37,24 @@ const errorHelper = async function(err) {
     }
     debug('Applying response error message with status, url, and method');
     // Override the status text with an improved message
-    let errorMsg = `${err.response.status} ${err.response.statusText || ''}: ` +
-    `${method} ${requestUrl}`;
+    let errorMsg = `${err.response.status} ${method} ${requestUrl}`;
     if (err.response.data) {
       debug('Found response data');
       // Check if we have a JSON response and try to get the error/reason
       if (err.response.headers['content-type'] === 'application/json') {
         debug('Response data is JSON');
-        // Append the error/reason if available
-        if (err.response.data.error) {
-          debug('Augmenting error message with error property');
-          // Override the status text with our more complete message
-          errorMsg += ` - Error: ${err.response.data.error}`;
-          if (err.response.data.reason) {
-            debug('Augmenting error message with reason property');
-            errorMsg += `, Reason: ${err.response.data.reason}`;
-          }
+        // Append the 'errors' message if available
+        if (err.response.data.errors && err.response.data.errors.length > 0) {
+          const originalError = err.response.data.errors[0];
+          originalError.message = `${errorMsg} - Error: ${originalError.message}`;
         }
       } else {
         errorMsg += err.response.data;
+        // Set a new message for use by the node-sdk-core
+        // We use the errors array because it gets processed
+        // ahead of all other service errors.
+        err.response.data.errors = [{ message: errorMsg }];
       }
-      // Set a new message for use by the node-sdk-core
-      // We use the errors array because it gets processed
-      // ahead of all other service errors.
-      err.response.data.errors = [{ message: errorMsg }];
     }
   } else if (err.request) {
     debug('Error did not include a response');
@@ -75,7 +68,18 @@ const errorHelper = async function(err) {
     }
   }
   return Promise.reject(err);
-};
+}
+
+// Interceptor function to add the User-Agent header.
+// An interceptor is used because setting UA in headers
+// option during client initialization means it gets overwritten
+// by the default value during a request.
+// This interceptor is further along the chain and able to
+// replace the default value.
+function userAgentHelper(requestConfig) {
+  requestConfig.headers['User-Agent'] = userAgent;
+  return requestConfig;
+}
 
 function newSimpleClient(rawUrl, opts) {
   const url = new URL(rawUrl);
@@ -120,43 +124,23 @@ function newSimpleClient(rawUrl, opts) {
 function newClient(rawUrl, opts) {
   const { service, dbName, actUrl } = newSimpleClient(rawUrl, opts);
   const authenticator = service.getAuthenticator();
-  // Configure retries
-  const maxRetries = 2; // for 3 total attempts
-  service.getHttpClient().defaults.raxConfig = {
-    // retries for status codes
-    retry: maxRetries,
-    // retries for non-response e.g. ETIMEDOUT
-    noResponseRetries: maxRetries,
-    backoffType: 'exponential',
-    httpMethodsToRetry: ['GET', 'HEAD', 'POST'],
-    statusCodesToRetry: [
-      [429, 429],
-      [500, 599]
-    ],
-    shouldRetry: err => {
-      const cfg = retryPlugin.getConfig(err);
-      // cap at max retries regardless of response/non-response type
-      if (cfg.currentRetryAttempt >= maxRetries) {
-        return false;
-      } else {
-        return retryPlugin.shouldRetryRequest(err);
-      }
-    },
-    instance: service.getHttpClient()
-  };
-  retryPlugin.attach(service.getHttpClient());
 
+  // Add interceptors
+  // Request interceptor to set the User-Agent header
+  // Response interceptor to put URLs in error messages
+  // Add for the token manager if present
   if (authenticator.tokenManager && authenticator.tokenManager.requestWrapperInstance) {
+    authenticator.tokenManager.requestWrapperInstance.axiosInstance.interceptors.request.use(userAgentHelper, null);
     authenticator.tokenManager.requestWrapperInstance.axiosInstance.interceptors.response.use(null, errorHelper);
   }
-  // Add error interceptors to put URLs in error messages
+  // and add for the client
+  service.getHttpClient().interceptors.request.use(userAgentHelper, null);
   service.getHttpClient().interceptors.response.use(null, errorHelper);
 
-  // Add request interceptor to add user-agent (adding it with custom request headers gets overwritten)
-  service.getHttpClient().interceptors.request.use(function(requestConfig) {
-    requestConfig.headers['User-Agent'] = userAgent;
-    return requestConfig;
-  }, null);
+  // Configure retries
+  // Note: this MUST happen last after all other interceptors have been registered
+  const maxRetries = 2; // for 3 total attempts
+  service.enableRetries({ maxRetries });
 
   return { service, dbName, url: actUrl.toString() };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudant/couchbackup",
-  "version": "2.11.0-249",
+  "version": "2.11.1-266",
   "description": "CouchBackup - command-line backup utility for Cloudant/CouchDB",
   "homepage": "https://github.com/IBM/couchbackup",
   "repository": {
@@ -20,16 +20,15 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": "^18 || ^20"
+    "node": "^18 || ^20 || ^22"
   },
   "dependencies": {
-    "@ibm-cloud/cloudant": "0.10.3",
+    "@ibm-cloud/cloudant": "0.11.0",
     "commander": "12.1.0",
     "debug": "4.3.7"
   },
   "peerDependencies": {
     "ibm-cloud-sdk-core": "^5.0.2",
-    "retry-axios": "^2.6.0",
     "axios": "^1.7.4"
   },
   "main": "app.js",
@@ -42,15 +41,15 @@
     "eslint-config-semistandard": "17.0.0",
     "eslint-config-standard": "17.1.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-import": "2.31.0",
     "eslint-plugin-n": "15.7.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.6.0",
     "http-proxy": "1.18.1",
-    "mocha": "10.7.3",
-    "nock": "13.5.5",
+    "mocha": "10.8.2",
+    "nock": "13.5.6",
     "tail": "2.2.6",
-    "uuid": "10.0.0"
+    "uuid": "11.0.3"
   },
   "scripts": {
     "lint": "eslint --ignore-path .gitignore .",