@cloudant/couchbackup 2.9.8 → 2.9.9-SNAPSHOT.96

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

@@ -11,234 +11,94 @@
 // 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.
-
-/* global describe it beforeEach */
 'use strict';
 
-const assert = require('assert');
-const nock = require('nock');
-const request = require('../includes/request.js');
-const error = require('../includes/error.js');
-
-const url = 'http://localhost:7777/testdb';
-const db = request.client(url, { parallelism: 1 });
-const timeoutDb = request.client(url, { parallelism: 1, requestTimeout: 500 });
-const longTestTimeout = 3000;
-
-beforeEach('Clean nock', function() {
-  nock.cleanAll();
-});
-
-describe('#unit Check request headers', function() {
-  it('should have a couchbackup user-agent', function(done) {
-    const couch = nock(url)
-      .matchHeader('user-agent', /couchbackup-cloudant\/\d+\.\d+\.\d+(?:-SNAPSHOT)? \(Node.js v\d+\.\d+\.\d+\)/)
-      .head('/good')
-      .reply(200);
-
-    db.service.headDocument({ db: db.db, docId: 'good' }).then(response => {
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      done(err);
-    });
-  });
-});
-
-describe('#unit Check request response error callback', function() {
-  it('should not callback with error for 200 response', function(done) {
-    const couch = nock(url)
-      .get('/good')
-      .reply(200, { ok: true });
-
-    db.service.getDocument({ db: db.db, docId: 'good' }).then(response => {
-      assert.ok(response.result);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      err = error.convertResponseError(err);
-      done(err);
-    });
-  });
-
-  it('should callback with error after 3 500 responses', function(done) {
-    const couch = nock(url)
-      .get('/bad')
-      .times(3)
-      .reply(500, function(uri, requestBody) {
-        this.req.response.statusMessage = 'Internal Server Error';
-        return { error: 'foo', reason: 'bar' };
-      });
-
-    db.service.getDocument({ db: db.db, docId: 'bad' }).then(response => {
-      done(new Error('Successful response when error expected.'));
-    }).catch(err => {
-      err = error.convertResponseError(err);
-      assert.strictEqual(err.name, 'HTTPFatalError');
-      assert.strictEqual(err.message, `500 Internal Server Error: get ${url}/bad - Error: foo, Reason: bar`);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      // Handle assertion errors
-      done(err);
-    });
-  }).timeout(longTestTimeout);
-
-  it('should callback with error after 3 POST 503 responses', function(done) {
-    const couch = nock(url)
-      .post('/_bulk_get')
-      .query(true)
-      .times(3)
-      .reply(503, function(uri, requestBody) {
-        this.req.response.statusMessage = 'Service Unavailable';
-        return { error: 'service_unavailable', reason: 'Service unavailable' };
-      });
-
-    db.service.postBulkGet({ db: db.db, revs: true, docs: [] }).then(response => {
-      done(new Error('Successful response when error expected.'));
-    }).catch(err => {
-      err = error.convertResponseError(err);
-      assert.strictEqual(err.name, 'HTTPFatalError');
-      assert.strictEqual(err.message, `503 Service Unavailable: post ${url}/_bulk_get - Error: service_unavailable, Reason: Service unavailable`);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      // Handle assertion errors
-      done(err);
-    });
-  }).timeout(longTestTimeout);
-
-  it('should callback with error after 3 429 responses', function(done) {
-    const couch = nock(url)
-      .get('/bad')
-      .times(3)
-      .reply(429, function(uri, requestBody) {
-        this.req.response.statusMessage = 'Too Many Requests';
-        return { error: 'foo', reason: 'bar' };
-      });
-
-    db.service.getDocument({ db: db.db, docId: 'bad' }).then(response => {
-      done(new Error('Successful response when error expected.'));
-    }).catch(err => {
-      err = error.convertResponseError(err);
-      assert.strictEqual(err.name, 'HTTPFatalError');
-      assert.strictEqual(err.message, `429 Too Many Requests: get ${url}/bad - Error: foo, Reason: bar`);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      // Handle assertion errors
-      done(err);
-    });
-  }).timeout(longTestTimeout);
-
-  it('should callback with fatal error for 404 response', function(done) {
-    const couch = nock(url)
-      .get('/bad')
-      .reply(404, function(uri, requestBody) {
-        this.req.response.statusMessage = 'Not Found';
-        return { error: 'foo', reason: 'bar' };
-      });
-
-    db.service.getDocument({ db: db.db, docId: 'bad' }).then(response => {
-      done(new Error('Successful response when error expected.'));
-    }).catch(err => {
-      err = error.convertResponseError(err);
-      assert.strictEqual(err.name, 'HTTPFatalError');
-      assert.strictEqual(err.message, `404 Not Found: get ${url}/bad - Error: foo, Reason: bar`);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      // Handle assertion errors
-      done(err);
-    });
-  });
-
-  it('should callback with same error for no status code error response', function(done) {
-    const couch = nock(url)
-      .get('/bad')
-      .times(3)
-      .replyWithError('testing badness');
-
-    db.service.getDocument({ db: db.db, docId: 'bad' }).then(response => {
-      done(new Error('Successful response when error expected.'));
-    }).catch(err => {
-      const err2 = error.convertResponseError(err);
-      assert.strictEqual(err, err2);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      // Handle assertion errors
-      done(err);
-    });
-  }).timeout(longTestTimeout);
-
-  it('should retry request if HTTP request gets timed out', function(done) {
-    const couch = nock(url)
-      .post('/_bulk_get')
-      .query(true)
-      .delay(1000)
-      .reply(200, { results: { docs: [{ id: '1', ok: { _id: '1' } }] } })
-      .post('/_bulk_get')
-      .query(true)
-      .reply(200, { results: { docs: [{ id: '1', ok: { _id: '1' } }, { id: '2', ok: { _id: '2' } }] } });
-
-    timeoutDb.service.postBulkGet({ db: db.db, revs: true, docs: [] }).then(response => {
-      assert.ok(response);
-      assert.ok(response.result);
-      assert.ok(response.result.results);
-      assert.ok(response.result.results.docs);
-      assert.strictEqual(response.result.results.docs.length, 2);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      done(err);
-    });
-  });
-
-  it('should callback with error code ESOCKETTIMEDOUT if 3 HTTP requests gets timed out', function(done) {
-    // Increase the timeout for this test to allow for the delays
-    this.timeout(3000);
-    const couch = nock(url)
-      .post('/_bulk_get')
-      .query(true)
-      .delay(1000)
-      .times(3)
-      .reply(200, { ok: true });
-
-    timeoutDb.service.postBulkGet({ db: db.db, revs: true, docs: [] }).then(response => {
-      done(new Error('Successful response when error expected.'));
-    }).catch(err => {
-      err = error.convertResponseError(err);
-      // Note axios returns ECONNABORTED rather than ESOCKETTIMEDOUT
-      // See https://github.com/axios/axios/issues/2710 via https://github.com/axios/axios/issues/1543`
-      assert.strictEqual(err.statusText, 'ECONNABORTED');
-      assert.strictEqual(err.message, `timeout of 500ms exceeded: post ${url}/_bulk_get ECONNABORTED`);
-      assert.ok(couch.isDone());
-      done();
-    }).catch(err => {
-      // Handle assertion errors
-      done(err);
-    });
-  });
-  describe('#unit Check credentials', function() {
-    it('should properly decode username and password', function(done) {
-      const username = 'user%123';
-      const password = 'colon:at@321';
-      const url = `http://${encodeURIComponent(username)}:${encodeURIComponent(password)}@localhost:7777/testdb`;
-      const sessionUrl = 'http://localhost:7777';
-      const couch = nock(sessionUrl)
-        .post('/_session', { username: username, password: password })
-        .reply(200, { ok: true }, { 'Set-Cookie': 'AuthSession=ABC123DEF4356;' })
-        .get('/')
-        .reply(200);
-      const db = request.client(url, { parallelism: 1 });
-      db.service.getServerInformation().then(response => {
-        assert.ok(response);
-        assert.ok(couch.isDone());
-        done();
-      }).catch(err => {
-        done(err);
-      });
-    });
-  });
-});
+// fatal errors
+const codes = {
+  Error: 1,
+  InvalidOption: 2,
+  DatabaseNotFound: 10,
+  Unauthorized: 11,
+  Forbidden: 12,
+  DatabaseNotEmpty: 13,
+  NoLogFileName: 20,
+  LogDoesNotExist: 21,
+  IncompleteChangesInLogFile: 22,
+  SpoolChangesError: 30,
+  HTTPFatalError: 40,
+  BulkGetError: 50
+};
+
+class BackupError extends Error {
+  constructor(name, message) {
+    super(message);
+    this.name = name;
+  }
+}
+
+class HTTPError extends BackupError {
+  constructor(responseError, name) {
+    // Special case some names for more useful error messages
+    switch (responseError.status) {
+      case 401:
+        name = 'Unauthorized';
+        break;
+      case 403:
+        name = 'Forbidden';
+        break;
+      default:
+        name = name || 'HTTPFatalError';
+    }
+    super(name, responseError.message);
+  }
+}
+
+// Default function to return an error for HTTP status codes
+// < 400 -> OK
+// 4XX (except 429) -> Fatal
+// 429 & >=500 -> Transient
+function checkResponse(err) {
+  if (err) {
+    // Construct an HTTPError if there is request information on the error
+    // Codes < 400 are considered OK
+    if (err.status >= 400) {
+      return new HTTPError(err);
+    } else {
+      // Send it back again if there was no status code, e.g. a cxn error
+      return augmentMessage(err);
+    }
+  }
+}
+
+function convertResponseError(responseError, errorFactory) {
+  if (!errorFactory) {
+    errorFactory = checkResponse;
+  }
+  return errorFactory(responseError);
+}
+
+function augmentMessage(err) {
+  // For errors that don't have a status code, we are likely looking at a cxn
+  // error.
+  // Try to augment the message with more detail (core puts the code in statusText)
+  if (err && err.statusText) {
+    err.message = `${err.message} ${err.statusText}`;
+  }
+  if (err && err.description) {
+    err.message = `${err.message} ${err.description}`;
+  }
+  return err;
+}
+
+module.exports = {
+  BackupError: BackupError,
+  HTTPError: HTTPError,
+  convertResponseError: convertResponseError,
+  terminationCallback: function terminationCallback(err, data) {
+    if (err) {
+      console.error(`ERROR: ${err.message}`);
+      process.exitCode = codes[err.name] || 1;
+      process.exit();
+    }
+  }
+};

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

@@ -1,4 +1,4 @@
-// Copyright © 2017, 2022 IBM Corp. All rights reserved.
+// 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.
@@ -11,70 +11,146 @@
 // 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.
+
+/* global describe it */
 'use strict';
 
-const async = require('async');
-const error = require('./error.js');
-const events = require('events');
+const assert = require('assert');
+const nock = require('nock');
+const request = require('../includes/request.js');
+const changes = require('../includes/spoolchanges.js');
+
+const url = 'http://localhost:7777';
+const dbName = 'fakenockdb';
+const longTestTimeout = 3000;
 
-module.exports = function(db, options) {
-  const ee = new events.EventEmitter();
-  const start = new Date().getTime();
-  let batch = 0;
-  let hasErrored = false;
-  let startKey = null;
-  let total = 0;
+const db = request.client(`${url}/${dbName}`, { parallelism: 1 });
 
-  async.doUntil(
-    function(callback) {
-      // Note, include_docs: true is set automatically when using the
-      // fetch function.
-      const opts = { db: db.db, limit: options.bufferSize, includeDocs: true };
+const seqSuffix = Buffer.alloc(124, 'abc123').toString('base64');
+function provideChanges(batchSize, totalChanges, fullResponse = false) {
+  let pending = totalChanges;
+  const sparseResultsArray = Array(batchSize).fill({
+    seq: null,
+    id: 'doc',
+    changes: [{ rev: '1-abcdef0123456789abcdef0123456789' }]
+  });
+  nock(url)
+    .post(`/${dbName}/_changes`)
+    .query(true)
+    .times(totalChanges / batchSize + (totalChanges % batchSize > 0 ? 1 : 0))
+    .reply(200, (uri, requestBody) => {
+      pending -= batchSize;
+      const lastSeq = (totalChanges - pending);
+      const seq = lastSeq - batchSize;
+      return {
+        results: fullResponse
+          ? Array.from(Array(batchSize), (_, i) => {
+            return {
+              seq: `${seq + i}-${seqSuffix}`,
+              id: `doc${seq + i}`,
+              changes: [{ rev: '1-abcdef0123456789abcdef0123456789' }]
+            };
+          })
+          : sparseResultsArray,
+        pending: pending,
+        last_seq: `${lastSeq}-abc`
+      };
+    });
+}
 
-      // To avoid double fetching a document solely for the purposes of getting
-      // the next ID to use as a startKey for the next page we instead use the
-      // last ID of the current page and append the lowest unicode sort
-      // character.
-      if (startKey) opts.startKey = `${startKey}\0`;
-      db.service.postAllDocs(opts).then(response => {
-        const body = response.result;
-        if (!body.rows) {
-          ee.emit('error', new error.BackupError(
-            'AllDocsError', 'ERROR: Invalid all docs response'));
-          callback();
-        } else {
-          if (body.rows.length < opts.limit) {
-            startKey = null; // last batch
-          } else {
-            startKey = body.rows[opts.limit - 1].id;
-          }
+describe('#unit Check spool changes', function() {
+  it('should terminate on request error', function(done) {
+    nock(url)
+      .post(`/${dbName}/_changes`)
+      .query(true)
+      .times(3)
+      .replyWithError({ code: 'ECONNRESET', message: 'socket hang up' });
 
-          const docs = [];
-          body.rows.forEach(function(doc) {
-            docs.push(doc.doc);
-          });
+    changes(db, '/dev/null', 500, null, function(err) {
+      assert.strictEqual(err.name, 'SpoolChangesError');
+      assert.strictEqual(err.message, `Failed changes request - socket hang up: post ${url}/${dbName}/_changes`);
+      assert.ok(nock.isDone());
+      done();
+    });
+  }).timeout(longTestTimeout);
 
-          if (docs.length > 0) {
-            ee.emit('received', {
-              batch: batch++,
-              data: docs,
-              length: docs.length,
-              time: (new Date().getTime() - start) / 1000,
-              total: total += docs.length
-            });
-          }
-          callback();
-        }
-      }).catch(err => {
-        err = error.convertResponseError(err);
-        ee.emit('error', err);
-        hasErrored = true;
-        callback();
+  it('should terminate on bad HTTP status code response', function(done) {
+    nock(url)
+      .post(`/${dbName}/_changes`)
+      .query(true)
+      .times(3)
+      .reply(500, function(uri, requestBody) {
+        this.req.response.statusMessage = 'Internal Server Error';
+        return { error: 'foo', reason: 'bar' };
       });
-    },
-    function(callback) { callback(null, hasErrored || startKey == null); },
-    function() { ee.emit('finished', { total: total }); }
-  );
 
-  return ee;
-};
+    changes(db, '/dev/null', 500, null, function(err) {
+      assert.strictEqual(err.name, 'HTTPFatalError');
+      assert.strictEqual(err.message, `500 Internal Server Error: post ${url}/${dbName}/_changes - Error: foo, Reason: bar`);
+      assert.ok(nock.isDone());
+      done();
+    });
+  }).timeout(longTestTimeout);
+
+  it('should keep collecting changes', function(done) {
+    // This test validates that spooling will correctly
+    // continue across multiple requests
+    // (4 batches of 100000 to be precise).
+    // This test might take up to 10 seconds
+    this.timeout(10 * 1000);
+
+    // Use full changes for this test
+    provideChanges(100000, 400000, true);
+    changes(db, '/dev/null', 500, null, function(err) {
+      assert.ok(!err);
+      assert.ok(nock.isDone());
+      done();
+    });
+  });
+
+  it('should keep collecting sparse changes', function(done) {
+    // This test checks that making thousands of requests doesn't
+    // make anything bad happen.
+    // This test might take up to 25 seconds
+    this.timeout(25 * 1000);
+    // Use sparse changes for this test and a batch size of 1
+    provideChanges(1, 2500);
+    changes(db, '/dev/null', 500, null, function(err) {
+      assert.ok(!err);
+      assert.ok(nock.isDone());
+      done();
+    });
+  });
+});
+
+describe('Longer spool changes checks', function() {
+  it('#slow should keep collecting changes (25M)', function(done) {
+    // This test might take up to 5 minutes
+    this.timeout(5 * 60 * 1000);
+    // Note changes spooling uses a constant batch size, we are setting
+    // a test value here and setting the buffer to match
+    const batch = 100000;
+    // Use sparse changes for this test
+    provideChanges(batch, 25000000);
+    changes(db, '/dev/null', batch, null, function(err) {
+      assert.ok(!err);
+      assert.ok(nock.isDone());
+      done();
+    });
+  });
+
+  it('#slower should keep collecting changes (500M)', function(done) {
+    // This test might take up to 90 minutes
+    this.timeout(90 * 60 * 1000);
+    // Note changes spooling uses a constant batch size, we are setting
+    // a test value here and setting the buffer to match
+    const batch = 1000000;
+    // Use full changes for this test to exercise load
+    provideChanges(batch, 500000000, true);
+    changes(db, '/dev/null', batch, null, function(err) {
+      assert.ok(!err);
+      assert.ok(nock.isDone());
+      done();
+    });
+  });
+});