@cloudant/couchbackup/includes/config.js

CouchBackup - command-line backup utility for Cloudant/CouchDB

// Copyright © 2017, 2024 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.

const { mkdtempSync } = require('node:fs');
const { tmpdir } = require('node:os');
const { join, normalize } = require('node:path');

/**
  Return API default settings.
*/
function apiDefaults() {
  return {
    attachments: false,
    parallelism: 5,
    bufferSize: 500,
    requestTimeout: 120000,
    log: join(mkdtempSync(join(tmpdir(), 'couchbackup-')), `${Date.now()}`),
    resume: false,
    mode: 'full'
  };
}

/**
  Return CLI default settings.
*/
function cliDefaults() {
  const defaults = apiDefaults();

  // add additional legacy settings
  defaults.db = 'test';
  defaults.url = 'http://localhost:5984';

  // add CLI only option
  defaults.quiet = false;

  return defaults;
}

/**
  Override settings **in-place** with environment variables.
*/
function applyEnvironmentVariables(opts) {
  // if we have a custom CouchDB url
  if (typeof process.env.COUCH_URL !== 'undefined') {
    opts.url = process.env.COUCH_URL;
  }

  // if we have a specified databases
  if (typeof process.env.COUCH_DATABASE !== 'undefined') {
    opts.db = process.env.COUCH_DATABASE;
  }

  // if we have a specified buffer size
  if (typeof process.env.COUCH_BUFFER_SIZE !== 'undefined') {
    opts.bufferSize = parseInt(process.env.COUCH_BUFFER_SIZE);
  }

  // if we have a specified parallelism
  if (typeof process.env.COUCH_PARALLELISM !== 'undefined') {
    opts.parallelism = parseInt(process.env.COUCH_PARALLELISM);
  }

  // if we have a specified request timeout
  if (typeof process.env.COUCH_REQUEST_TIMEOUT !== 'undefined') {
    opts.requestTimeout = parseInt(process.env.COUCH_REQUEST_TIMEOUT);
  }

  // if we have a specified log file
  if (typeof process.env.COUCH_LOG !== 'undefined') {
    opts.log = normalize(process.env.COUCH_LOG);
  }

  // if we are instructed to resume
  if (typeof process.env.COUCH_RESUME !== 'undefined' && process.env.COUCH_RESUME === 'true') {
    opts.resume = true;
  }

  // if we are given an output filename
  if (typeof process.env.COUCH_OUTPUT !== 'undefined') {
    opts.output = normalize(process.env.COUCH_OUTPUT);
  }

  // if we only want a shallow copy
  if (typeof process.env.COUCH_MODE !== 'undefined' && process.env.COUCH_MODE === 'shallow') {
    opts.mode = 'shallow';
  }

  // if we are instructed to be quiet
  if (typeof process.env.COUCH_QUIET !== 'undefined' && process.env.COUCH_QUIET === 'true') {
    opts.quiet = true;
  }

  // if we have a specified API key
  if (typeof process.env.CLOUDANT_IAM_API_KEY !== 'undefined') {
    opts.iamApiKey = process.env.CLOUDANT_IAM_API_KEY;
  }

  // if we have a specified IAM token endpoint
  if (typeof process.env.CLOUDANT_IAM_TOKEN_URL !== 'undefined') {
    opts.iamTokenUrl = process.env.CLOUDANT_IAM_TOKEN_URL;
  }

  // if we are instructed to be quiet
  if (typeof process.env.COUCH_ATTACHMENTS !== 'undefined' && process.env.COUCH_ATTACHMENTS === 'true') {
    opts.attachments = true;
  }
}

module.exports = {
  apiDefaults,
  cliDefaults,
  applyEnvironmentVariables
};