@cloudant/couchbackup/includes/request.js

// 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';

const pkg = require('../package.json');
const http = require('http');
const https = require('https');
const cloudant = require('@cloudant/cloudant');

const userAgent = 'couchbackup-cloudant/' + pkg.version + ' (Node.js ' +
      process.version + ')';

module.exports = {
  client: function(url, opts) {
    var protocol = (url.match(/^https/)) ? https : http;
    const keepAliveAgent = new protocol.Agent({
      keepAlive: true,
      keepAliveMsecs: 30000,
      maxSockets: opts.parallelism
    });
    // Split the URL for use with nodejs-cloudant
    var actUrl = url.substr(0, url.lastIndexOf('/'));
    var dbName = url.substr(url.lastIndexOf('/') + 1);
    // Default set of plugins includes retry
    var pluginsToUse = ['retry'];
    // Default to cookieauth unless an IAM key is provided
    if (opts.iamApiKey) {
      const iamPluginConfig = { iamApiKey: opts.iamApiKey };
      if (opts.iamTokenUrl) {
        iamPluginConfig.iamTokenUrl = opts.iamTokenUrl;
      }
      pluginsToUse.push({ iamauth: iamPluginConfig });
    } else {
      pluginsToUse.push({ cookieauth: { errorOnNoCreds: false } });
    }
    return cloudant({
      url: actUrl,
      plugins: pluginsToUse,
      requestDefaults: {
        agent: keepAliveAgent,
        headers: { 'User-Agent': userAgent },
        gzip: true,
        timeout: opts.requestTimeout
      }
    }).use(dbName);
  }
};