@cloudant/couchbackup 2.8.4-SNAPSHOT.115 → 2.9.1-7.198

package/README.md

@@ -2,8 +2,6 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@cloudant/couchbackup.svg?colorB=0000ff)](https://www.npmjs.com/package/@cloudant/couchbackup)
 [![npm (scoped with tag)](https://img.shields.io/npm/v/@cloudant/couchbackup/snapshot.svg?colorB=666699)](https://www.npmjs.com/package/@cloudant/couchbackup)
-[![Build Status](https://travis-ci.org/cloudant/couchbackup.svg?branch=master)](https://travis-ci.org/cloudant/couchbackup)
-[![Greenkeeper badge](https://badges.greenkeeper.io/cloudant/couchbackup.svg)](https://greenkeeper.io/)
 
 ```
  _____                  _    ______            _
@@ -35,12 +33,12 @@ npm install -g @cloudant/couchbackup
 ```
 
 ### Requirements
-* The minimum required Node.js version is 14.
+* Node.js LTS version 18 or 20.
 * The minimum required CouchDB version is 2.0.0.
 
 ### Snapshots
 
-The latest builds of master are published to npm with the `snapshot` tag. Use the `snapshot` tag if you want to experiment with an unreleased fix or new function, but please note that snapshot versions are **unsupported**.
+The latest builds of main are published to npm with the `snapshot` tag. Use the `snapshot` tag if you want to experiment with an unreleased fix or new function, but please note that snapshot versions are **unsupported**.
 
 ## Usage
 

package/app.js

@@ -101,10 +101,6 @@ function validateArgs(url, opts, cb) {
       cb(new error.BackupError('InvalidOption', 'Invalid URL protocol.'));
       return;
     }
-    if (!urlObject.host) {
-      cb(new error.BackupError('InvalidOption', 'Invalid URL host.'));
-      return;
-    }
     if (!urlObject.pathname || urlObject.pathname === '/') {
       cb(new error.BackupError('InvalidOption', 'Invalid URL, missing path element (no database).'));
       return;
@@ -114,7 +110,7 @@ function validateArgs(url, opts, cb) {
       return;
     }
   } catch (err) {
-    cb(err);
+    cb(error.wrapPossibleInvalidUrlError(err));
     return;
   }
 

package/bin/couchbackup.bin.js

@@ -25,53 +25,57 @@ const backupBatchDebug = debug('couchbackup:backup:batch');
 
 backupDebug.enabled = true;
 
-const program = parser.parseBackupArgs();
+try {
+  const program = parser.parseBackupArgs();
+  const databaseUrl = cliutils.databaseUrl(program.url, program.db);
 
-const databaseUrl = cliutils.databaseUrl(program.url, program.db);
-const opts = {
-  bufferSize: program.bufferSize,
-  log: program.log,
-  mode: program.mode,
-  parallelism: program.parallelism,
-  requestTimeout: program.requestTimeout,
-  resume: program.resume,
-  iamApiKey: program.iamApiKey,
-  iamTokenUrl: program.iamTokenUrl
-};
+  const opts = {
+    bufferSize: program.bufferSize,
+    log: program.log,
+    mode: program.mode,
+    parallelism: program.parallelism,
+    requestTimeout: program.requestTimeout,
+    resume: program.resume,
+    iamApiKey: program.iamApiKey,
+    iamTokenUrl: program.iamTokenUrl
+  };
 
-// log configuration to console
-console.error('='.repeat(80));
-console.error('Performing backup on ' + databaseUrl.replace(/\/\/.+@/g, '//****:****@') + ' using configuration:');
-console.error(JSON.stringify(opts, null, 2).replace(/"iamApiKey": "[^"]+"/, '"iamApiKey": "****"'));
-console.error('='.repeat(80));
+  // log configuration to console
+  console.error('='.repeat(80));
+  console.error('Performing backup on ' + databaseUrl.replace(/\/\/.+@/g, '//****:****@') + ' using configuration:');
+  console.error(JSON.stringify(opts, null, 2).replace(/"iamApiKey": "[^"]+"/, '"iamApiKey": "****"'));
+  console.error('='.repeat(80));
 
-backupBatchDebug.enabled = !program.quiet;
+  backupBatchDebug.enabled = !program.quiet;
 
-let ws = process.stdout;
+  let ws = process.stdout;
 
-// open output file
-if (program.output) {
-  let flags = 'w';
-  if (program.log && program.resume) {
-    flags = 'a';
+  // open output file
+  if (program.output) {
+    let flags = 'w';
+    if (program.log && program.resume) {
+      flags = 'a';
+    }
+    const fd = fs.openSync(program.output, flags);
+    ws = fs.createWriteStream(null, { fd });
   }
-  const fd = fs.openSync(program.output, flags);
-  ws = fs.createWriteStream(null, { fd: fd });
-}
 
-backupDebug('Fetching all database changes...');
+  backupDebug('Fetching all database changes...');
 
-return couchbackup.backup(
-  databaseUrl,
-  ws,
-  opts,
-  error.terminationCallback
-).on('changes', function(batch) {
-  backupBatchDebug('Total batches received:', batch + 1);
-}).on('written', function(obj) {
-  backupBatchDebug('Written batch ID:', obj.batch, 'Total document revisions written:', obj.total, 'Time:', obj.time);
-}).on('error', function(e) {
-  backupDebug('ERROR', e);
-}).on('finished', function(obj) {
-  backupDebug('Finished - Total document revisions written:', obj.total);
-});
+  return couchbackup.backup(
+    databaseUrl,
+    ws,
+    opts,
+    error.terminationCallback
+  ).on('changes', function(batch) {
+    backupBatchDebug('Total batches received:', batch + 1);
+  }).on('written', function(obj) {
+    backupBatchDebug('Written batch ID:', obj.batch, 'Total document revisions written:', obj.total, 'Time:', obj.time);
+  }).on('error', function(e) {
+    backupDebug('ERROR', e);
+  }).on('finished', function(obj) {
+    backupDebug('Finished - Total document revisions written:', obj.total);
+  });
+} catch (err) {
+  error.terminationCallback(err);
+}

package/bin/couchrestore.bin.js

@@ -24,33 +24,37 @@ const restoreBatchDebug = debug('couchbackup:restore:batch');
 
 restoreDebug.enabled = true;
 
-const program = parser.parseRestoreArgs();
-const databaseUrl = cliutils.databaseUrl(program.url, program.db);
-const opts = {
-  bufferSize: program.bufferSize,
-  parallelism: program.parallelism,
-  requestTimeout: program.requestTimeout,
-  iamApiKey: program.iamApiKey,
-  iamTokenUrl: program.iamTokenUrl
-};
+try {
+  const program = parser.parseRestoreArgs();
+  const databaseUrl = cliutils.databaseUrl(program.url, program.db);
+  const opts = {
+    bufferSize: program.bufferSize,
+    parallelism: program.parallelism,
+    requestTimeout: program.requestTimeout,
+    iamApiKey: program.iamApiKey,
+    iamTokenUrl: program.iamTokenUrl
+  };
 
-// log configuration to console
-console.error('='.repeat(80));
-console.error('Performing restore on ' + databaseUrl.replace(/\/\/.+@/g, '//****:****@') + ' using configuration:');
-console.error(JSON.stringify(opts, null, 2).replace(/"iamApiKey": "[^"]+"/, '"iamApiKey": "****"'));
-console.error('='.repeat(80));
+  // log configuration to console
+  console.error('='.repeat(80));
+  console.error('Performing restore on ' + databaseUrl.replace(/\/\/.+@/g, '//****:****@') + ' using configuration:');
+  console.error(JSON.stringify(opts, null, 2).replace(/"iamApiKey": "[^"]+"/, '"iamApiKey": "****"'));
+  console.error('='.repeat(80));
 
-restoreBatchDebug.enabled = !program.quiet;
+  restoreBatchDebug.enabled = !program.quiet;
 
-return couchbackup.restore(
-  process.stdin, // restore from stdin
-  databaseUrl,
-  opts,
-  error.terminationCallback
-).on('restored', function(obj) {
-  restoreBatchDebug('restored', obj.total);
-}).on('error', function(e) {
-  restoreDebug('ERROR', e);
-}).on('finished', function(obj) {
-  restoreDebug('finished', obj);
-});
+  return couchbackup.restore(
+    process.stdin, // restore from stdin
+    databaseUrl,
+    opts,
+    error.terminationCallback
+  ).on('restored', function(obj) {
+    restoreBatchDebug('restored', obj.total);
+  }).on('error', function(e) {
+    restoreDebug('ERROR', e);
+  }).on('finished', function(obj) {
+    restoreDebug('finished', obj);
+  });
+} catch (err) {
+  error.terminationCallback(err);
+}

package/includes/cliutils.js

@@ -20,6 +20,7 @@
  */
 
 const url = require('url');
+const error = require('./error.js');
 
 module.exports = {
 
@@ -37,7 +38,11 @@ module.exports = {
     if (!root.endsWith('/')) {
       root = root + '/';
     }
-    return new url.URL(encodeURIComponent(databaseName), root).toString();
+    try {
+      return new url.URL(encodeURIComponent(databaseName), root).toString();
+    } catch (err) {
+      throw error.wrapPossibleInvalidUrlError(err);
+    }
   },
 
   /**

package/includes/config.js

@@ -24,7 +24,7 @@ function apiDefaults() {
     parallelism: 5,
     bufferSize: 500,
     requestTimeout: 120000,
-    log: tmp.fileSync().name,
+    log: tmp.tmpNameSync(),
     resume: false,
     mode: 'full'
   };

package/includes/error.js

@@ -90,10 +90,19 @@ function augmentMessage(err) {
   return err;
 }
 
+function wrapPossibleInvalidUrlError(err) {
+  if (err.code === 'ERR_INVALID_URL') {
+    // Wrap ERR_INVALID_URL in our own InvalidOption
+    return new BackupError('InvalidOption', err.message);
+  }
+  return err;
+}
+
 module.exports = {
-  BackupError: BackupError,
-  HTTPError: HTTPError,
-  convertResponseError: convertResponseError,
+  BackupError,
+  HTTPError,
+  wrapPossibleInvalidUrlError,
+  convertResponseError,
   terminationCallback: function terminationCallback(err, data) {
     if (err) {
       console.error(`ERROR: ${err.message}`);

package/includes/parser.js

@@ -20,7 +20,7 @@ const path = require('path');
 const pkg = require('../package.json');
 
 function parseBackupArgs() {
-  const program = require('commander');
+  const { program } = require('commander');
 
   // Option CLI defaults
   const defaults = config.cliDefaults();
@@ -84,7 +84,7 @@ function parseBackupArgs() {
 }
 
 function parseRestoreArgs() {
-  const program = require('commander');
+  const { program } = require('commander');
 
   // Option CLI defaults
   const defaults = config.cliDefaults();

package/includes/request.js

@@ -14,8 +14,6 @@
 'use strict';
 
 const pkg = require('../package.json');
-const http = require('http');
-const https = require('https');
 const stream = require('stream');
 const { CloudantV1, CouchdbSessionAuthenticator } = require('@ibm-cloud/cloudant');
 const { IamAuthenticator, NoAuthAuthenticator } = require('ibm-cloud-sdk-core');
@@ -102,16 +100,10 @@ const errorHelper = async function(err) {
 module.exports = {
   client: function(rawUrl, opts) {
     const url = new URL(rawUrl);
-    const protocol = (url.protocol.match(/^https/)) ? https : http;
-    const keepAliveAgent = new protocol.Agent({
-      keepAlive: true,
-      keepAliveMsecs: 30000,
-      maxSockets: opts.parallelism
-    });
     // Split the URL to separate service from database
     // Use origin as the "base" to remove auth elements
-    const actUrl = new URL(url.pathname.substr(0, url.pathname.lastIndexOf('/')), url.origin);
-    const dbName = url.pathname.substr(url.pathname.lastIndexOf('/') + 1);
+    const actUrl = new URL(url.pathname.substring(0, url.pathname.lastIndexOf('/')), url.origin);
+    const dbName = url.pathname.substring(url.pathname.lastIndexOf('/') + 1);
     let authenticator;
     // Default to cookieauth unless an IAM key is provided
     if (opts.iamApiKey) {
@@ -134,11 +126,7 @@ module.exports = {
       // Axios performance options
       maxContentLength: -1
     };
-    if (url.protocol === 'https') {
-      serviceOpts.httpsAgent = keepAliveAgent;
-    } else {
-      serviceOpts.httpAgent = keepAliveAgent;
-    }
+
     const service = new CloudantV1(serviceOpts);
     // Configure retries
     const maxRetries = 2; // for 3 total attempts

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@cloudant/couchbackup",
-  "version": "2.8.4-SNAPSHOT.115",
+  "version": "2.9.1-7.198",
   "description": "CouchBackup - command-line backup utility for Cloudant/CouchDB",
-  "homepage": "https://github.com/cloudant/couchbackup",
-  "repository": "https://github.com/cloudant/couchbackup.git",
+  "homepage": "https://github.com/IBM/couchbackup",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/IBM/couchbackup.git"
+  },
   "keywords": [
     "CouchDB",
     "Cloudant",
@@ -12,23 +15,24 @@
     "command-line"
   ],
   "bugs": {
-    "url": "https://github.com/cloudant/couchbackup/issues",
+    "url": "https://github.com/IBM/couchbackup/issues",
     "email": "cldtsdks@us.ibm.com"
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=14"
+    "node": "^18 || ^20"
   },
   "dependencies": {
-    "@ibm-cloud/cloudant": "0.1.2",
-    "async": "^3.1.0",
-    "commander": "^9.0.0",
-    "debug": "~4.3.2",
+    "@ibm-cloud/cloudant": "0.8.3",
+    "async": "3.2.5",
+    "commander": "12.0.0",
+    "debug": "4.3.4",
     "tmp": "0.2.1"
   },
   "peerDependencies": {
-    "ibm-cloud-sdk-core": "^2.17.10",
-    "retry-axios": "^2.6.0"
+    "ibm-cloud-sdk-core": "^4.1.4",
+    "retry-axios": "^2.6.0",
+    "axios": "^1.6.0"
   },
   "main": "app.js",
   "bin": {
@@ -36,23 +40,29 @@
     "couchrestore": "bin/couchrestore.bin.js"
   },
   "devDependencies": {
-    "eslint": "^8.2.0",
-    "eslint-config-semistandard": "^16.0.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-header": "^3.0.0",
-    "eslint-plugin-import": "^2.8.0",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "http-proxy": "^1.16.2",
-    "mocha": "^9.2.0",
-    "nock": "^13.2.1",
-    "tail": "^2.0.0",
-    "toxy": "^0.3.16",
-    "uuid": "^8.3.2"
+    "eslint": "8.56.0",
+    "eslint-config-semistandard": "17.0.0",
+    "eslint-config-standard": "17.1.0",
+    "eslint-plugin-header": "3.1.1",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-n": "15.7.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "6.1.1",
+    "http-proxy": "1.18.1",
+    "mocha": "10.3.0",
+    "nock": "13.5.1",
+    "tail": "2.2.6",
+    "uuid": "9.0.1",
+    "lodash": "4.17.21"
   },
   "scripts": {
     "lint": "eslint --ignore-path .gitignore .",
     "unit": "mocha --grep \"#unit\"",
     "test": "npm run lint && npm run unit"
-  }
+  },
+  "files": [
+    "/app.js",
+    "/bin",
+    "/includes"
+  ]
 }

package/.secrets.baseline

@@ -1,240 +0,0 @@
-{
-  "exclude": {
-    "files": "package-lock.json|test/fixtures|^.secrets.baseline$",
-    "lines": null
-  },
-  "generated_at": "2022-04-22T01:56:11Z",
-  "plugins_used": [
-    {
-      "name": "AWSKeyDetector"
-    },
-    {
-      "name": "ArtifactoryDetector"
-    },
-    {
-      "name": "AzureStorageKeyDetector"
-    },
-    {
-      "base64_limit": 4.5,
-      "name": "Base64HighEntropyString"
-    },
-    {
-      "name": "BasicAuthDetector"
-    },
-    {
-      "name": "BoxDetector"
-    },
-    {
-      "name": "CloudantDetector"
-    },
-    {
-      "ghe_instance": "github.ibm.com",
-      "name": "GheDetector"
-    },
-    {
-      "name": "GitHubTokenDetector"
-    },
-    {
-      "hex_limit": 3,
-      "name": "HexHighEntropyString"
-    },
-    {
-      "name": "IbmCloudIamDetector"
-    },
-    {
-      "name": "IbmCosHmacDetector"
-    },
-    {
-      "name": "JwtTokenDetector"
-    },
-    {
-      "keyword_exclude": null,
-      "name": "KeywordDetector"
-    },
-    {
-      "name": "MailchimpDetector"
-    },
-    {
-      "name": "NpmDetector"
-    },
-    {
-      "name": "PrivateKeyDetector"
-    },
-    {
-      "name": "SlackDetector"
-    },
-    {
-      "name": "SoftlayerDetector"
-    },
-    {
-      "name": "SquareOAuthDetector"
-    },
-    {
-      "name": "StripeDetector"
-    },
-    {
-      "name": "TwilioKeyDetector"
-    }
-  ],
-  "results": {
-    "Jenkinsfile": [
-      {
-        "hashed_secret": "570e6c6e82c51d48f263e940a2b5281375733d54",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 66,
-        "type": "Secret Keyword",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "8e494667a94be484abba2c4d4cf9bea0c3eb39ea",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 152,
-        "type": "NPM tokens",
-        "verified_result": null
-      }
-    ],
-    "README.md": [
-      {
-        "hashed_secret": "91dfd9ddb4198affc5c194cd8ce6d338fde470e2",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 59,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "644384d5a639cb5cacbf39f25dd4c7f77fc1b24d",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 71,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      }
-    ],
-    "examples/s3-backup-file.js": [
-      {
-        "hashed_secret": "9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 39,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      }
-    ],
-    "examples/s3-backup-stream.js": [
-      {
-        "hashed_secret": "9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 37,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      }
-    ],
-    "test/app.js": [
-      {
-        "hashed_secret": "6367c48dd193d56ea7b0baad25b19455e529f5ee",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 178,
-        "type": "Secret Keyword",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "e9d71f5ee7c92d6dc9e92ffdad17b8bd49418f98",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 178,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      }
-    ],
-    "test/config.js": [
-      {
-        "hashed_secret": "9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 34,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      }
-    ],
-    "test/fatalerrors.js": [
-      {
-        "hashed_secret": "3614298f2f841910a7ef47c6ea2af096bf838c08",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 33,
-        "type": "Hex High Entropy String",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "aeca874db253d47d14de64ffbbf8f27bf3a65edb",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 33,
-        "type": "Hex High Entropy String",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "e58f351f409b818d64f94d90b3db70224b0a624a",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 33,
-        "type": "Hex High Entropy String",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "ec4e1dbc7f64a0e052e855036f9470e7881f06fd",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 192,
-        "type": "Base64 High Entropy String",
-        "verified_result": null
-      }
-    ],
-    "test/parser.js": [
-      {
-        "hashed_secret": "b4bfddf3c247a5d30734dcf84b3c8d3c6aa1f36e",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 40,
-        "type": "Secret Keyword",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 143,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "e9d71f5ee7c92d6dc9e92ffdad17b8bd49418f98",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 305,
-        "type": "Basic Auth Credentials",
-        "verified_result": null
-      }
-    ],
-    "test/request.js": [
-      {
-        "hashed_secret": "41a269ae4f24dab3ddf96b401f1ada5dfdfc5f08",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 226,
-        "type": "Secret Keyword",
-        "verified_result": null
-      }
-    ]
-  },
-  "version": "0.13.1+ibm.47.dss",
-  "word_list": {
-    "file": null,
-    "hash": null
-  }
-}

package/CHANGES.md

@@ -1,156 +0,0 @@
-# Unreleased
-- [NOTE] Updated minimum supported engine to Node.js 14 `fermium` LTS.
-
-# 2.8.3 (2022-04-05)
-- [UPGRADED] `@ibm-cloud/cloudant` dependency to version `0.1.1`.
-- [NOTE] Move `retry-axios` and `ibm-cloud-sdk-core` to peerDependencies.
-
-# 2.8.2 (2022-02-10)
-- [UPGRADED] `@ibm-cloud/cloudant` dependency to version `0.0.24`.
-
-# 2.8.1 (2021-12-02)
-- [FIXED] Regression from version 2.7 resulting in incorrect handling of percent-encoded credentials in the URL user-info.
-
-# 2.8.0 (2021-11-25)
-- [FIXED] Corrected `user-agent` header on requests.
-- [FIXED] Restore of shallow backups created with versions <=2.4.2.
-- [IMPROVED] Added quiet option to backup and restore to suppress batch messages.
-- [IMPROVED] Added a preflight check for restore function to make sure that a target database is new and empty.
-- [IMPROVED] Added handling for errors reading log file.
-- [IMPROVED] Split changes spooling to improve reliability on databases with
-  millions of documents.
-- [UPGRADED] `@ibm-cloud/cloudant`, `commander` and `debug` dependencies.
-
-# 2.7.0 (2021-09-14)
-- [UPGRADED] Cloudant client dependency from `@cloudant/cloudant` to `@ibm-cloud/cloudant`.
-
-# 2.6.2 (2021-08-27)
-- [FIXED] `Invalid document ID: _bulk_get` error when using `@cloudant/cloudant`
-  version `4.5.0`.
-- [UPGRADED] Upgraded `@cloudant/cloudant` dependency to version `4.5.0`.
-- [NOTE] Updated minimum supported engine to Node.js 12 `erbium` LTS.
-
-# 2.6.1 (2021-06-23)
-- [FIXED] Async queue pause/resume behaviour to avoid exhausting listener handles.
-- [UPGRADED] Upgraded `@cloudant/cloudant` dependency to version `4.4.0`.
-
-# 2.6.0 (2020-09-22)
-- [FIXED] Invalid parameters error when using shallow mode.
-- [UPGRADED] Upgraded `@cloudant/cloudant` dependency to version `4.3.0`.
-- [NOTE] Updated minimum supported engine to Node.js 10 `dubnium` LTS.
-
-# 2.5.2 (2020-03-02)
-- [FIXED] Issue with compatibility with Nano 8.2.0.
-
-# 2.5.1 (2019-12-06)
-- [FIXED] Issue with incorrect handling of percent-encoded user info characters
-  via @cloudant/cloudant dependency.
-- [UPGRADED] Upgraded @cloudant/cloudant dependency to minimum version 4.2.3
-- [IMPROVED] Added documentation around encoding of characters in the user info
-  subcomponent of the URL.
-
-# 2.5.0 (2019-10-24)
-- [UPGRADED] Upgraded @cloudant/cloudant dependency to version 4.2.2.
-- [NOTE] Updated minimum supported engine to Node.js 8 “Carbon” LTS.
-
-# 2.4.2 (2019-08-20)
-
-- [FIXED] Preserve document revisions in shallow backup.
-- [UPGRADED] Upgraded commander dependency to version 3.0.0.
-
-# 2.4.1 (2019-06-18)
-
-- [FIXED] Removed inadvertent npm-cli-login dependency.
-- [UPGRADED] Upgraded @cloudant/cloudant dependency to version 4.1.1.
-- [UPGRADED] Upgraded async dependency to version 3.0.1.
-
-# 2.4.0 (2019-03-15)
-
-- [NEW] Added request timeout option. Set via env var `COUCH_REQUEST_TIMEOUT`,
- as CLI option `--request-timeout`, or programmatically via
- `options.requestTimeout`.
-- [IMPROVED] Replaced usages of Node.js legacy URL API. Note this changes some
-  URL validation error messages.
-- [IMPROVED] Documentation, help text and log warnings for invalid options in
-  "shallow" mode.
-- [UPGRADED] Moved nodejs-cloudant dependency to 4.x.x.
-
-# 2.3.1 (2018-06-15)
-
-- [FIXED] Concurrent database backups use the same default log file.
-- [FIXED] IAM token URL override option.
-
-# 2.3.0 (2018-05-22)
-
-- [NEW] Check for database existence before starting backup. This provides for
- better error messages for existence, authentication, and `_bulk_get` problems.
-- [FIXED] Intermittent issues with multiple callbacks, particularly noticeable
- when using Node.js 10.
-- [FIXED] Issue where a success message could confusingly be output after a
- fatal error.
-- [UPGRADED] Increased nodejs-cloudant dependency minimum to 2.2.x.
-
-# 2.2.0 (2018-03-06)
-
-- [FIXED] An issue where the `_changes` response stream doesn't get correctly
-  decompressed.
-- [FIXED] Prevent duplicate execution of backup error callbacks.
-- [NOTE] Update engines in preparation for Node.js 4 “Argon” end-of-life.
-
-# 2.1.0 (2018-02-20)
-
-- [NEW] Added API for upcoming IBM Cloud Identity and Access Management support
-  for Cloudant on IBM Cloud. Note: IAM API key support is not yet enabled in the
-  service.
-- [IMPROVED] Enhanced resilience of backup and restore processes by enabling the
-  nodejs-cloudant retry plugin.
-- [IMPROVED] Added URL validation for presence of host and database elements.
-- [UPGRADED] Increased nodejs-cloudant dependency to 2.x.
-
-# 2.0.1 (2018-01-11)
-
-- [NEW] Changed to use nodejs-cloudant for database requests.
-- [IMPROVED] Added compression to restore process requests.
-- [FIXED] An unhandled `readstream.destroy is not a function` error when trying
-  to terminate a restore process that encountered an error.
-- [UPGRADED] Increased debug dependency to 3.0.x.
-
-# 2.0.0 (2017-07-04)
-
-- [NEW] Moved to https://github.com/cloudant/couchbackup repository.
-- [NEW] Validate backup/restore options.
-- [NEW] Add User-Agent header to all requests.
-- [NEW] Added unique CLI exit codes for known error conditions.
-- [NEW] API for using as library that is more Node.js-like.
-- [NEW] Added `changes` event for each batch spooled from the changes feed.
-- [BREAKING CHANGE] The --buffer option is now --buffer-size.
-- [BREAKING CHANGE] The `writeerror` event is now just `error`.
-- [BREAKING CHANGE] The `writecomplete` event is now `finished`.
-- [BREAKING CHANGE] For restoring, the `written` event is now `restored`.
-- [REMOVED] Removed legacy 1.x API.
-- [IMPROVED] Verify database supports `/_bulk_get` endpoint prior to running backup.
-- [IMPROVED] Existence of the restore destination database is checked before
-  starting the restore process.
-- [IMPROVED] Added compression for backup HTTP responses, where supported by the
-  server.
-- [IMPROVED] Added HTTP persistent connection pools corresponding to the backup
-  parallelism.
-- [IMPROVED] Better error handling in couchrestore when remote database
-  cannot be written to.
-- [IMPROVED] Validate HTTP responses when restoring a database.
-- [IMPROVED] Aborts backup and restore processes for known irrecoverable errors.
-- [IMPROVED] Retry restore batches on transient errors.
-- [FIXED] An issue where the process could exit before the backup content was
-  completely flushed to the destination stream.
-- [FIXED] An issue where back pressure on the output stream was ignored
-  potentially resulting in the backup process running out of memory.
-- [FIXED] An issue where the log entry could be written for a batch before the
-  batch was written to the backup file.
-- [FIXED] An issue where a restore of a resumed backup might not complete due to
-  incomplete JSON entries in the backup file.
-- [FIXED] An issue where an empty batch could be written to the backup file.
-- [FIXED] An issue where the restore-time buffer size was ignored.
-- [FIXED] Ensure body 'rows' key exists before performing shallow backup.
-- [FIXED] An issue where write errors were not correctly reported.
-- [FIXED] An issue where couchbackup would attempt to write to an
-  invalid output file.