@cloudant/couchbackup 2.11.11 → 2.11.12-392

package/includes/liner.js

@@ -1,4 +1,4 @@
-// Copyright © 2017, 2024 IBM Corp. All rights reserved.
+// Copyright © 2017, 2025 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.
@@ -13,9 +13,8 @@
 // limitations under the License.
 
 const { createInterface } = require('node:readline');
-const { PassThrough, Duplex } = require('node:stream');
+const { Duplex, PassThrough, Transform } = require('node:stream');
 const debug = require('debug');
-
 /**
  * A Duplex stream that converts the input stream to a stream
  * of line objects using the built-in readline interface.
@@ -29,19 +28,17 @@ const debug = require('debug');
  */
 class Liner extends Duplex {
   // Configure logging
-  log = debug(('couchbackup:liner'));
+  log = debug('couchbackup:liner');
   // Flag for whether the readline interface is running
   isRunning = true;
+  // Flag for whether the readline interface is closed
+  isClosed = false;
   // Line number state
   lineNumber = 0;
   // Buffer of processed lines
   lines = [];
-  // Stream of bytes that will be processed to lines.
-  inStream = new PassThrough({ objectMode: false })
-    // if there is an error destroy this Duplex with it
-    .on('error', e => this.destroy(e));
 
-  constructor() {
+  constructor(sanitize = false) {
     // Configuration of this Duplex:
     // objectMode: false on the writable input (file chunks), true on the readable output (line objects)
     // The readableHighWaterMark controls the number of lines buffered after this implementation calls
@@ -49,6 +46,25 @@ class Liner extends Duplex {
     // there is additional buffering downstream and file processing is faster than the network ops
     // we don't bottleneck here even without a large buffer.
     super({ readableObjectMode: true, readableHighWaterMark: 0, writableObjectMode: false });
+    // Set up the stream of bytes that will be processed to lines.
+    if (sanitize) {
+      // Handle unescaped unicode "newlines" by escaping them before passing to readline
+      this.inStream = new Transform({
+        objectMode: false,
+        transform(chunk, encoding, callback) {
+          try {
+            this.push(chunk.toString('utf-8').replaceAll('\u2028', '\\u2028').replaceAll('\u2029', '\\u2029'), 'utf-8');
+            callback();
+          } catch (e) {
+            callback(e);
+          }
+        }
+      });
+    } else {
+      this.inStream = new PassThrough({ objectMode: false });
+    }
+    // if there is an error destroy this Duplex with it
+    this.inStream.on('error', e => this.destroy(e));
     // Built-in readline interface over the inStream
     this.readlineInterface = createInterface({
       input: this.inStream, // the writable side of Liner, passed through
@@ -60,7 +76,8 @@ class Liner extends Duplex {
       const bufferedLines = this.lines.push(this.wrapLine(line));
       this.log(`Liner processed line ${this.lineNumber}. Buffered lines available: ${bufferedLines}.`);
       this.pushAvailable();
-    }).on('close', () => {
+    }).once('close', () => {
+      this.isClosed = true;
       this.log('Liner readline interface closed.');
       // Push null onto our lines buffer to signal EOF to downstream consumers.
       this.lines.push(null);
@@ -87,13 +104,16 @@ class Liner extends Duplex {
     // Check readline is running flag and whether there is content to push.
     while (this.isRunning && this.lines.length > 0) {
       if (!this.push(this.lines.shift())) {
+        this.log(`Back-pressure from push. Buffered lines available: ${this.lines.length}.`);
         // Push returned false, this indicates downstream back-pressure.
         // Pause the readline interface to stop pushing more lines downstream.
         // Resumption is triggered by downstream calling _read which happens
         // when it is ready for more data.
-        this.log(`Liner pausing after back-pressure from push. Buffered lines available: ${this.lines.length}.`);
         this.isRunning = false;
-        this.readlineInterface.pause();
+        if (!this.isClosed) {
+          this.log('Liner pausing.');
+          this.readlineInterface.pause();
+        }
         break;
       } else {
         this.log(`Liner pushed. Buffered lines available: ${this.lines.length}.`);
@@ -114,9 +134,11 @@ class Liner extends Duplex {
     // is called to ensure that pushes are able to happen (and thereby trigger)
     // subsequent reads.
     if (!this.isRunning) {
-      this.log('Liner resuming after read.');
       this.isRunning = true;
-      this.readlineInterface.resume();
+      if (!this.isClosed) {
+        this.log('Liner resuming after read.');
+        this.readlineInterface.resume();
+      }
     }
     this.pushAvailable();
   }

package/includes/parser.js

@@ -1,4 +1,4 @@
-// Copyright © 2017, 2024 IBM Corp. All rights reserved.
+// Copyright © 2017, 2025 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.
@@ -62,7 +62,6 @@ function parseBackupArgs() {
       Number)
     .option('-u, --url <url>',
       cliutils.getUsage('URL of the CouchDB/Cloudant server', defaults.url))
-    .allowExcessArguments()
     .parse(process.argv);
 
   // Remove defaults that don't apply when using shallow mode
@@ -81,7 +80,6 @@ function parseBackupArgs() {
     // We have to do this check here for the CLI case because of the default.
     error.terminationCallback(new error.BackupError('NoLogFileName', 'To resume a backup, a log file must be specified'));
   }
-
   return opts;
 }
 
@@ -118,7 +116,6 @@ function parseRestoreArgs() {
       Number)
     .option('-u, --url <url>',
       cliutils.getUsage('URL of the CouchDB/Cloudant server', defaults.url))
-    .allowExcessArguments()
     .parse(process.argv);
 
   // Apply the options in order so that the CLI overrides env vars and env variables

package/includes/restore.js

@@ -50,7 +50,7 @@ module.exports = function(dbClient, options, readstream, ee) {
 
   const batchPreparationStreams = [
     readstream, // the backup file
-    new Liner(), // line by line
+    new Liner(true), // line by line (for Node.js 24 compatibility santize unicode line separators)
     new MappingStream(restore.backupLineToDocsArray), // convert line to a docs array
     new BatchingStream(options.bufferSize, true), // make new arrays of the correct buffer size
     new MappingStream(restore.docsToRestoreBatch) // make a restore batch

package/includes/transforms.js

@@ -1,4 +1,4 @@
-// Copyright © 2023, 2024 IBM Corp. All rights reserved.
+// Copyright © 2023, 2025 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.
@@ -187,45 +187,57 @@ class DelegateWritable extends Writable {
 
   _write(chunk, encoding, callback) {
     const toWrite = (this.chunkMapFn) ? this.chunkMapFn(chunk) : chunk;
-    this.targetWritable.write(toWrite, encoding, (err) => {
-      if (!err) {
-        this.log('completed target chunk write');
-        if (this.postWriteFn) {
-          this.postWriteFn(chunk);
+    if (!this.targetWritable.destroyed) {
+      this.targetWritable.write(toWrite, encoding, (err) => {
+        if (!err) {
+          this.log('completed target chunk write');
+          if (this.postWriteFn) {
+            this.postWriteFn(chunk);
+          }
         }
-      }
-      callback(err);
-    });
+        callback(err);
+      });
+    } else {
+      // Avoid write after destroy errors
+      this.log('supressing write after destroy error');
+      callback();
+    }
   }
 
   _final(callback) {
     this.log('Finalizing');
     const lastChunk = (this.lastChunkFn && this.lastChunkFn()) || null;
-    // We can't 'end' stdout, so use a final write instead for that case
-    if (this.targetWritable === process.stdout) {
-      // we can't 'write' null, so don't do anything if there is no last chunk
-      if (lastChunk) {
-        this.targetWritable.write(lastChunk, 'utf-8', (err) => {
+    if (!this.targetWritable.destroyed) {
+      // We can't 'end' stdout, so use a final write instead for that case
+      if (this.targetWritable === process.stdout) {
+        // we can't 'write' null, so don't do anything if there is no last chunk
+        if (lastChunk) {
+          this.targetWritable.write(lastChunk, 'utf-8', (err) => {
+            if (!err) {
+              this.log('wrote last chunk to stdout');
+            } else {
+              this.log('error writing last chunk to stdout');
+            }
+            callback(err);
+          });
+        } else {
+          this.log('no last chunk to write to stdout');
+          callback();
+        }
+      } else {
+        this.targetWritable.end(lastChunk, 'utf-8', (err) => {
           if (!err) {
-            this.log('wrote last chunk to stdout');
+            this.log('wrote last chunk and ended target writable');
           } else {
-            this.log('error writing last chunk to stdout');
+            this.log('error ending target writable');
           }
           callback(err);
         });
-      } else {
-        this.log('no last chunk to write to stdout');
-        callback();
       }
     } else {
-      this.targetWritable.end(lastChunk, 'utf-8', (err) => {
-        if (!err) {
-          this.log('wrote last chunk and ended target writable');
-        } else {
-          this.log('error ending target writable');
-        }
-        callback(err);
-      });
+      // Avoid write after destroy errors
+      this.log('supressing write after destroy error');
+      callback();
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudant/couchbackup",
-  "version": "2.11.11",
+  "version": "2.11.12-392",
   "description": "CouchBackup - command-line backup utility for Cloudant/CouchDB",
   "homepage": "https://github.com/IBM/couchbackup",
   "repository": {
@@ -20,16 +20,16 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": "^20 || ^22"
+    "node": "^20 || ^22 || ^24"
   },
   "dependencies": {
-    "@ibm-cloud/cloudant": "0.12.10",
-    "commander": "14.0.1",
+    "@ibm-cloud/cloudant": "0.12.13",
+    "commander": "14.0.2",
     "debug": "4.4.3"
   },
   "peerDependencies": {
-    "ibm-cloud-sdk-core": "^5.4.3",
-    "axios": "^1.12.2"
+    "ibm-cloud-sdk-core": "^5.4.5",
+    "axios": "^1.13.2"
   },
   "main": "app.js",
   "bin": {
@@ -37,11 +37,11 @@
     "couchrestore": "bin/couchrestore.bin.js"
   },
   "devDependencies": {
-    "eslint": "9.37.0",
+    "eslint": "9.39.1",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.32.0",
     "http-proxy": "1.18.1",
-    "mocha": "11.7.4",
+    "mocha": "11.7.5",
     "neostandard": "0.12.2",
     "nock": "13.5.6",
     "tail": "2.2.6",