tapisSettings.js

'use strict';

//
// tapisSettings.js
// Tapis configuration settings
//
// VDJServer
// https://vdjserver.org
//
// Copyright (C) 2020 The University of Texas Southwestern Medical Center
//
// Author: Scott Christley <scott.christley@utsouthwestern.edu>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//

function parseBoolean(value)
{
    if (value == 'true') return true;
    else if (value == 1) return true;
    else return false;
}

function parseList(value)
{
    if (value) {
        let names = value.split(',');
        //console.log(names);
        return names;
    }
    return [];
}

var tapisSettings = {
    tapis_version: process.env.TAPIS_VERSION,
    config: null,

    // Tapis V3 Auth Settings
    clientKeyV3:    process.env.TAPIS_V3_CLIENT_KEY,
    clientSecretV3: process.env.TAPIS_V3_CLIENT_SECRET,
    hostnameV3:     process.env.TAPIS_V3_HOST,

    // WSO2 Auth Settings (Tapis V2)
    clientKey:    process.env.WSO2_CLIENT_KEY,
    clientSecret: process.env.WSO2_CLIENT_SECRET,
    hostname:     process.env.WSO2_HOST,

    // VDJ Service Account User
    serviceAccountKey: process.env.VDJ_SERVICE_ACCOUNT,
    serviceAccountSecret: process.env.VDJ_SERVICE_ACCOUNT_SECRET,
    serviceAccountJWT: process.env.VDJ_SERVICE_ACCOUNT_JWT,

    // VDJ Guest Account User
    guestAccountKey: process.env.VDJ_GUEST_ACCOUNT,
    guestAccountSecret: process.env.VDJ_GUEST_ACCOUNT_SECRET,
    guestAccountJWT: process.env.VDJ_GUEST_ACCOUNT_JWT,

    // User admins
    adminAccountKeys: parseList(process.env.VDJ_USER_ADMINS),

    // VDJ Backbone Location
    vdjBackbone: process.env.VDJ_BACKBONE_HOST,

    // Agave Misc.
    storageSystem: process.env.AGAVE_STORAGE_SYSTEM,

    // host URL for Tapis notifications
    notifyHost: process.env.AGAVE_NOTIFY_HOST,

    // Email
    fromAddress: process.env.EMAIL_ADDRESS,
    replyToAddress: process.env.REPLYTO_EMAIL_ADDRESS,

    // Debug
    debugConsole: parseBoolean(process.env.DEBUG_CONSOLE),

    // Tapis meta/v3 settings only needs a db name
    mongo_dbname: process.env.TAPIS_MONGODB_DB,
    // Should only be defined if direct access is needed to the db
    // These are not used for the ADC repository, those are in mongoSettings
    mongo_hostname: process.env.TAPIS_MONGODB_HOST,
    mongo_username: process.env.TAPIS_MONGODB_USER,
    mongo_userSecret: process.env.TAPIS_MONGODB_SECRET,

    // max pagesize
    max_size: 1000,
    // to deterimine if GET or POST is used for query
    large_query_size: 2 * 1024,
    large_lrq_query_size: 50 * 1024
};
module.exports = tapisSettings;

tapisSettings.get_default_tapis = function(config) {
    var context = 'tapis';
    var config_provided = false;

    if (config) {
        config.log.info(context, 'config object set for app: ' + config.name);
        tapisSettings.config = config;
        config_provided = true;
    }

    // only need to display once
    if (tapisSettings.config && config_provided) {
        if (tapisSettings.tapis_version == 2) tapisSettings.config.log.info(context, 'Using Tapis V2 API', true);
        else if (tapisSettings.tapis_version == 3) {
            tapisSettings.config.log.info(context, 'Using Tapis V3 API with ' + tapisSettings.mongo_dbname + ' DB', true);
            if (! tapisSettings.mongo_dbname) tapisSettings.config.log.error(context, 'You probably should define the Tapis V3 Meta API dbname.')
            if (tapisSettings.serviceAccountJWT)
                tapisSettings.config.log.info(context, 'Service account using long-lived token.', true);
            if (tapisSettings.adminAccountKeys.length > 0)
                tapisSettings.config.log.info(context, 'User admins accounts: ' + JSON.stringify(tapisSettings.adminAccountKeys), true);
        } else {
            tapisSettings.config.log.error(context, 'Invalid Tapis version, check TAPIS_VERSION environment variable');
            return null;
        }
    }

    var tapisV2 = require('vdj-tapis-js/tapis');
    var tapisV3 = require('vdj-tapis-js/tapisV3');
    var tapisIO = null;
    if (tapisSettings.tapis_version == 2) tapisIO = tapisV2;
    if (tapisSettings.tapis_version == 3) tapisIO = tapisV3;
    return tapisIO;
}

// TODO: not implemented
// Error injection enabled
if (tapisSettings.errorInjection) {
    global.errorInjection = require('./errorInjection');
    tapisSettings.performInjectError = function() {
        return global.errorInjection.performInjectError();
    };
}
tapisSettings.injectError = function(error) {
    if (tapisSettings.errorInjection) return global.errorInjection.setCurrentError(error);
    else return null;
};
tapisSettings.shouldInjectError = function(value) {
    if (tapisSettings.errorInjection) return global.errorInjection.shouldInjectError(value);
    else return false;
};