@cloudant/couchbackup 2.9.15-SNAPSHOT.176 → 2.9.15

package/.scannerwork/scanner-report/source-8.txt

@@ -1,281 +0,0 @@
-// Copyright © 2017, 2021 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.
-// 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.
-'use strict';
-
-const async = require('async');
-const events = require('events');
-const fs = require('fs');
-const error = require('./error.js');
-const spoolchanges = require('./spoolchanges.js');
-const logfilesummary = require('./logfilesummary.js');
-const logfilegetbatches = require('./logfilegetbatches.js');
-
-/**
- * Read documents from a database to be backed up.
- *
- * @param {string} db - `@cloudant/cloudant` DB object for source database.
- * @param {number} blocksize - number of documents to download in single request
- * @param {number} parallelism - number of concurrent downloads
- * @param {string} log - path to log file to use
- * @param {boolean} resume - whether to resume from an existing log file
- * @returns EventEmitter with following events:
- *  - `received` - called with a block of documents to write to backup
- *  - `error` - on error
- *  - `finished` - when backup process is finished (either complete or errored)
- */
-module.exports = function(db, options) {
-  const ee = new events.EventEmitter();
-  const start = new Date().getTime(); // backup start time
-  const batchesPerDownloadSession = 50; // max batches to read from log file for download at a time (prevent OOM)
-
-  function proceedWithBackup() {
-    if (options.resume) {
-      // pick up from existing log file from previous run
-      downloadRemainingBatches(options.log, db, ee, start, batchesPerDownloadSession, options.parallelism);
-    } else {
-      // create new log file and process
-      spoolchanges(db, options.log, options.bufferSize, ee, function(err) {
-        if (err) {
-          ee.emit('error', err);
-        } else {
-          downloadRemainingBatches(options.log, db, ee, start, batchesPerDownloadSession, options.parallelism);
-        }
-      });
-    }
-  }
-
-  validateBulkGetSupport(db, function(err) {
-    if (err) {
-      return ee.emit('error', err);
-    } else {
-      proceedWithBackup();
-    }
-  });
-
-  return ee;
-};
-
-/**
- * Validate /_bulk_get support for a specified database.
- *
- * @param {string} db - nodejs-cloudant db
- * @param {function} callback - called on completion with signature (err)
- */
-function validateBulkGetSupport(db, callback) {
-  db.service.postBulkGet({ db: db.db, docs: [] }).then(() => { callback(); }).catch(err => {
-    err = error.convertResponseError(err, function(err) {
-      switch (err.status) {
-        case undefined:
-          // There was no status code on the error
-          return err;
-        case 404:
-          return new error.BackupError('BulkGetError', 'Database does not support /_bulk_get endpoint');
-        default:
-          return new error.HTTPError(err);
-      }
-    });
-    callback(err);
-  });
-}
-
-/**
- * Download remaining batches in a log file, splitting batches into sets
- * to avoid enqueueing too many in one go.
- *
- * @param {string} log - log file name to maintain download state
- * @param {string} db - nodejs-cloudant db
- * @param {events.EventEmitter} ee - event emitter to emit received events on
- * @param {time} startTime - start time for backup process
- * @param {number} batchesPerDownloadSession - max batches to enqueue for
- *  download at a time. As batches contain many doc IDs, this helps avoid
- *  exhausting memory.
- * @param {number} parallelism - number of concurrent downloads
- * @returns function to call do download remaining batches with signature
- *  (err, {batches: batch, docs: doccount}) {@see spoolchanges}.
- */
-function downloadRemainingBatches(log, db, ee, startTime, batchesPerDownloadSession, parallelism) {
-  let total = 0; // running total of documents downloaded so far
-  let noRemainingBatches = false;
-
-  // Generate a set of batches (up to batchesPerDownloadSession) to download from the
-  // log file and download them. Set noRemainingBatches to `true` for last batch.
-  function downloadSingleBatchSet(done) {
-    // Fetch the doc IDs for the batches in the current set to
-    // download them.
-    function batchSetComplete(err, data) {
-      if (!err) {
-        total = data.total;
-      }
-      done(err);
-    }
-    function processRetrievedBatches(err, batches) {
-      if (!err) {
-        // process them in parallelised queue
-        processBatchSet(db, parallelism, log, batches, ee, startTime, total, batchSetComplete);
-      } else {
-        batchSetComplete(err);
-      }
-    }
-
-    readBatchSetIdsFromLogFile(log, batchesPerDownloadSession, function(err, batchSetIds) {
-      if (err) {
-        ee.emit('error', err);
-        // Stop processing changes file for fatal errors
-        noRemainingBatches = true;
-        done();
-      } else {
-        if (batchSetIds.length === 0) {
-          noRemainingBatches = true;
-          return done();
-        }
-        logfilegetbatches(log, batchSetIds, processRetrievedBatches);
-      }
-    });
-  }
-
-  // Return true if all batches in log file have been downloaded
-  function isFinished(callback) { callback(null, noRemainingBatches); }
-
-  function onComplete() {
-    ee.emit('finished', { total: total });
-  }
-
-  async.doUntil(downloadSingleBatchSet, isFinished, onComplete);
-}
-
-/**
- * Return a set of uncompleted download batch IDs from the log file.
- *
- * @param {string} log - log file path
- * @param {number} batchesPerDownloadSession - maximum IDs to return
- * @param {function} callback - sign (err, batchSetIds array)
- */
-function readBatchSetIdsFromLogFile(log, batchesPerDownloadSession, callback) {
-  logfilesummary(log, function processSummary(err, summary) {
-    if (!err) {
-      if (!summary.changesComplete) {
-        callback(new error.BackupError('IncompleteChangesInLogFile',
-          'WARNING: Changes did not finish spooling'));
-        return;
-      }
-      if (Object.keys(summary.batches).length === 0) {
-        return callback(null, []);
-      }
-
-      // batch IDs are the property names of summary.batches
-      const batchSetIds = getPropertyNames(summary.batches, batchesPerDownloadSession);
-      callback(null, batchSetIds);
-    } else {
-      callback(err);
-    }
-  });
-}
-
-/**
- * Download a set of batches retrieved from a log file. When a download is
- * complete, add a line to the logfile indicating such.
- *
- * @param {any} db - nodejs-cloudant database
- * @param {any} parallelism - number of concurrent requests to make
- * @param {any} log - log file to drive downloads from
- * @param {any} batches - batches to download
- * @param {any} ee - event emitter for progress. This funciton emits
- *  received and error events.
- * @param {any} start - time backup started, to report deltas
- * @param {any} grandtotal - count of documents downloaded prior to this set
- *  of batches
- * @param {any} callback - completion callback, (err, {total: number}).
- */
-function processBatchSet(db, parallelism, log, batches, ee, start, grandtotal, callback) {
-  let hasErrored = false;
-  let total = grandtotal;
-
-  // queue to process the fetch requests in an orderly fashion using _bulk_get
-  const q = async.queue(function(payload, done) {
-    const output = [];
-    const thisBatch = payload.batch;
-    delete payload.batch;
-    delete payload.command;
-
-    function logCompletedBatch(batch) {
-      if (log) {
-        fs.appendFile(log, ':d batch' + thisBatch + '\n', done);
-      } else {
-        done();
-      }
-    }
-
-    // do the /db/_bulk_get request
-    db.service.postBulkGet({
-      db: db.db,
-      revs: true,
-      docs: payload.docs
-    }).then(response => {
-      // create an output array with the docs returned
-      response.result.results.forEach(function(d) {
-        if (d.docs) {
-          d.docs.forEach(function(doc) {
-            if (doc.ok) {
-              output.push(doc.ok);
-            }
-          });
-        }
-      });
-      total += output.length;
-      const t = (new Date().getTime() - start) / 1000;
-      ee.emit('received', {
-        batch: thisBatch,
-        data: output,
-        length: output.length,
-        time: t,
-        total: total
-      }, q, logCompletedBatch);
-    }).catch(err => {
-      if (!hasErrored) {
-        hasErrored = true;
-        err = error.convertResponseError(err);
-        // Kill the queue for fatal errors
-        q.kill();
-        ee.emit('error', err);
-      }
-      done();
-    });
-  }, parallelism);
-
-  for (const i in batches) {
-    q.push(batches[i]);
-  }
-
-  q.drain(function() {
-    callback(null, { total: total });
-  });
-}
-
-/**
- * Returns first N properties on an object.
- *
- * @param {object} obj - object with properties
- * @param {number} count - number of properties to return
- */
-function getPropertyNames(obj, count) {
-  // decide which batch numbers to deal with
-  const batchestofetch = [];
-  let j = 0;
-  for (const i in obj) {
-    batchestofetch.push(parseInt(i));
-    j++;
-    if (j >= count) break;
-  }
-  return batchestofetch;
-}

package/.scannerwork/scanner-report/source-9.txt

@@ -1,59 +0,0 @@
-// Copyright © 2017, 2018 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.
-// 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.
-'use strict';
-
-/**
- * Utility methods for the command line interface.
- * @module cliutils
- * @see module:cliutils
- */
-
-const url = require('url');
-const error = require('./error.js');
-
-module.exports = {
-
-  /**
-   * Combine a base URL and a database name, ensuring at least single slash
-   * between root and database name. This allows users to have Couch behind
-   * proxies that mount Couch's / endpoint at some other mount point.
-   * @param {string} root - root URL
-   * @param {string} databaseName - database name
-   * @return concatenated URL.
-   *
-   * @private
-   */
-  databaseUrl: function databaseUrl(root, databaseName) {
-    if (!root.endsWith('/')) {
-      root = root + '/';
-    }
-    try {
-      return new url.URL(encodeURIComponent(databaseName), root).toString();
-    } catch (err) {
-      throw error.wrapPossibleInvalidUrlError(err);
-    }
-  },
-
-  /**
-   * Generate CLI argument usage text.
-   *
-   * @param {string} description - argument description.
-   * @param {string} defaultValue - default argument value.
-   *
-   * @private
-   */
-  getUsage: function getUsage(description, defaultValue) {
-    return `${description} ${defaultValue !== undefined ? ` (default: ${defaultValue})` : ''}`;
-  }
-};

package/.scannerwork/scanner-report/symbols-11.pb

@@ -1,20 +0,0 @@
-
-  (
- 
- # 
-
-% -
-/ 3"" (
-  
-" & 2
-
-  & +    
-    
-%% ** 
-% &8 9
-  
- !! 
-5 6## 
-&& (( 
-%%  !++ 
- .. 

package/.scannerwork/scanner-report/symbols-13.pb

@@ -1,59 +0,0 @@
-
- $$ 
- HH "
- MM 2
- 88 "WW  gg ii <
- ,, EE 	VV YY ^^ 
- FF 
- !$$) ,
-# -++ #--) 3
-/ 1// 88 
-F
-3 ;KK PP WW __M Ugg
- ii
- <
-!! ++ ++3 9,, -- ;; 2
-"" --= B..# (// 00 <
-## 
-$$ .. JJ OO UU __ ee (
-%% 
-'' 
-** << SS 
-**! (++( /
--- 
-55 MM Z
-55 66 	77
- 88\ ]99 :: == >> ?? 
-:: ;; 
-DD \\ !nn 
-DD EE, 1FF> C
-GG HH 
-II  #KK 
-NN  #PP <
-dd
 ff ff gg. 1hh iiZ ]
--- --C D
-++G H11 
-*** +22 
-77 99 
-:: ::  
-99 == 
-== @@ 
-66 AA 
-55  BB 
-FF* +FFf g
-II% &LL
- 
-NN% &QQ
- 
-TT XX 
-ZZ  ]] 
-]] `` 
-XX aa 
-RR# $bb
- 
-GG cc 
-ff- .hh 	
-hh5 6jj 	
-dd kk 
-DD! "ll 
-= >oo 

package/.scannerwork/scanner-report/symbols-15.pb

@@ -1,42 +0,0 @@
-
- BB 
-  
- CC
- 
- DD
- 
- !00 
-# *--! (
-  55	 <
- #  !! '' .. 
-
-% -
-/ 333 F
- ## )) --
- 
-
- !! 
- ## '' 
- )) $
-.. // "
-88 BB 
-88 &DD #
-88( 0FF II 
-:: >> 
-II 
-== DD 
-==  >> >> 
-EE FF 
-& '9 :
-  
-"" $$ 
-(( ** 
---B C11 
-! "22 
-5 644 
-, -66 

-:: :: 
-==" #?? 
-EE  GG 
-HH JJ 
-882 3KK 

package/.scannerwork/scanner-report/symbols-4.pb

@@ -1,30 +0,0 @@
-
- 
-PP ZZ 
- 		 
-	 %% ss 
-$$	 tt 2
-%% (( 
-)) 
-,, 
-..	 
-44	 "uu 6�

-44# '77 << AA FF KK PP UU ZZ __ dd ii nn 
-	 
- 
-  

-$$ // 

-664 588 
-;;9 :== 
-@@< =BB 
-EE< =GG 
-JJ@ ALL 
-OO4 5QQ 
-TT^ _VV 
-YY7 8[[ 
-^^] ^`` 
-cc\ ]ee 
-hh? @jj 
-mmA Boo 
-44) *pp 

-rr vv 

package/.scannerwork/scanner-report/symbols-44.pb

@@ -1,203 +0,0 @@
-�

- FF HH PP QQ pp xx zz 
-�
�
 
-�
�
 
-�
�
 
-�
�
 
-�
�
 
-�
�
 
-�
�
 
- 	 
- 
 r
- 33 66 99 << ^^ aa gg jj 
-�
�
 
-�
�
 4
- 
-,, 00 [[ 
-�
�
 *
-	 ?? mm 
-�
�
 
-  !
- "# ' 
- 
-  J
-%% 
-�
�
 
-�
�
 *
-'' 551 :``1 :
-�
�
1 :4
-(( 881 >cc1 >ff1 >
-�
�
1 >
-)) ;;1 9ii1 9
-00
- QQ 
->> RR (
->>! 'AA
- KK TT 
-@@ !AA (
-CC! %EE FF! %HH! %
-JJ KK 
-NN! %PP #
-SS TT 
-[[
- 
-�
�
 
-ll 
-�
�
 *
-ll! 'rr }} 
-�
�
 
-nn !pp "
-qq rr (
-uu! %ww xx! %zz! %
-|| }} 
-
-�
�
! %
-�
�
 #
-
-�
�
 
-�
�
 
-
-�
�

- 
-�
�
 $
-
-�
�
 
-�
�
 
-�
�
 '
-
-�
�
 
-�
�
 0
-
-�
�
! '
-�
�
 
-�
�
 
-�
�
 
-
-�
�
 !
-�
�
 "
-
-�
�
 
-�
�
 
-
-�
�
! %
-�
�
 #
-
-�
�
 
-�
�
 
-
-�
�
! %
-�
�
 #
-
-�
�
 
-�
�
 
-$ % 

-++' (-- 
-22 229 :
-55 55O P
-88 88S T
-;; ;;N O
-?? ??; <
-@@# $BB 	
-EE" #GG 
-GG II 
-DD JJ
- 
-JJ LL
- 
-CC' (MM 	
-OO SS
- 
-SS UU
- 
-NN' (VV 	
->>, -WW 
-//9 :XX 
-]] ]]9 :
-`` ``O P
-cc ccS T
-dd dd3 4
-ff ffS T
-ii iiN O
-mm mm; <
-oo qq
- 
-qq ss
- 
-nn# $tt 	
-ww" #yy 
-yy {{ 
-vv ||
- 
-|| ~~
- 
-uu' ( 	
-
-�
�
 
-�
�

- 
-
-�
�
 
-�
�

- 
-
-�
�
' (
-�
�
 	
-ll, -
-�
�
 
-ZZN O
-�
�
 
-
-�
�
 
-�
�
9 :
-
-�
�
 
-�
�
O P
-
-�
�
 
-�
�
S T
-
-�
�
 
-�
�
* +
-
-�
�
 
-�
�
; <
-
-�
�
 
-�
�

- 
-
-�
�
 
-�
�

- 
-
-�
�
# $
-�
�
 	
-
-�
�
 
-�
�

- 
-
-�
�
 
-�
�

- 
-
-�
�
' (
-�
�
 	
-
-�
�
 
-�
�

- 
-
-�
�
 
-�
�

- 
-
-�
�
' (
-�
�
 	
-
-�
�
, -
-�
�
 
-
-�
�
P Q
-�
�
 
-$$A B�
�