kraken-js/lib/config.js

An express-based Node.js web application bootstrapping module.

/*───────────────────────────────────────────────────────────────────────────*\
 │  Copyright 2016 PayPal                                                      │
 │                                                                             │
 │hh ,'""`.                                                                    │
 │  / _  _ \  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';

var Bluebird = require('bluebird');
var path = require('path');
var confit = require('confit');
var handlers = require('shortstop-handlers');
var ssresolve = require('shortstop-resolve');


function createHandlers(options) {
    var result;

    result = {
        file:    handlers.file(options.basedir),
        path:    handlers.path(options.basedir),
        base64:  handlers.base64(),
        env:     handlers.env(),
        require: handlers.require(options.basedir),
        exec:    handlers.exec(options.basedir),
        glob:    handlers.glob(options.basedir)
    };

    Object.keys(options.protocols).forEach(function (protocol) {
        result[protocol] = options.protocols[protocol];
    });

    return result;
}

function configPath(prefix, configdir) {
  configdir = (configdir) ? configdir : 'config';
  return path.join(prefix, configdir);
}


exports.create = function create(options) {
    var deferred, appProtocols, baseProtocols, baseFactory, appFactory, baseConfig, appConfig;

    deferred = Bluebird.pending();
    appProtocols = createHandlers(options);
    baseProtocols = createHandlers(options);

    appProtocols.resolve = ssresolve(configPath(options.basedir, options.configdir));
    baseProtocols.resolve = ssresolve(configPath(path.dirname(__dirname)));

    baseConfig = Object.assign(
        {
            basedir: configPath(path.dirname(__dirname)),
            protocols: baseProtocols
        },
        options.confit || {}
    );

    baseFactory = confit(baseConfig);
    baseFactory.create(function(err, baseConf) {
        if (err) {
            deferred.reject(err);
            return;
        }

        appConfig = Object.assign(
            {
              basedir: configPath(options.basedir, options.configdir),
              protocols: appProtocols
            },
            options.confit || {}
        );
        appFactory = confit(appConfig);
        appFactory.create(function(err, appConf) {
            if (err) {
                deferred.reject(err);
                return;
            }

            baseConf.merge(appConf);
            deferred.resolve(baseConf);
        });
    });

    return deferred.promise;
};