@cloudant/couchbackup 2.11.12-SNAPSHOT-383 → 2.11.12-SNAPSHOT-384

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,7 +13,7 @@
 // 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');
 
 /**
@@ -32,16 +32,14 @@ class Liner extends Duplex {
   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 +47,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').replace(/\u2028/, '\\u2028').replace(/\u2029/, '\\u2029'));
+            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 +77,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 +105,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 +135,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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudant/couchbackup",
-  "version": "2.11.12-SNAPSHOT-383",
+  "version": "2.11.12-SNAPSHOT-384",
   "description": "CouchBackup - command-line backup utility for Cloudant/CouchDB",
   "homepage": "https://github.com/IBM/couchbackup",
   "repository": {
@@ -20,7 +20,7 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": "^20 || ^22"
+    "node": "^20 || ^22 || ^24"
   },
   "dependencies": {
     "@ibm-cloud/cloudant": "0.12.11",
@@ -29,7 +29,7 @@
   },
   "peerDependencies": {
     "ibm-cloud-sdk-core": "^5.4.3",
-    "axios": "^1.12.2"
+    "axios": "^1.13.1"
   },
   "main": "app.js",
   "bin": {