lasso/src/Config.js

Lasso.js is a build tool and runtime library for building and bundling all of the resources needed by a web application

var extend = require('raptor-util').extend;
var BundleSetConfig = require('./BundleSetConfig');
var flags = require('./flags');
var ok = require('assert').ok;
var lassoRequirePlugin = require('./require');
var lassoImagePlugin = require('./plugins/lasso-image');
var crypto = require('crypto');

function createFilterFromContentType(contentType) {
    var contentTypeMap = {};

    if (Array.isArray(contentType)) {
        // Include this array if the actual content type is in the array of supported content types
        var contentTypeArray = contentType;
        if (contentTypeArray.length === 0) {
            return async function (lassoContext) {
                return true;
            };
        }

        for (var i = 0, len = contentTypeArray.length; i < len; i++) {
            contentTypeMap[contentTypeArray[i]] = true;
        }
    } else {
        contentTypeMap[contentType] = true;
    }

    return async function(lassoContext) {
        var contentType = lassoContext.contentType;
        return contentTypeMap[contentType] === true;
    };
}

var MAX_FINGERPRINT_DEPTH = 4;

function calculateConfigFingerprint(config) {
    // Instead of trying to be clever we we just going to hard code
    // handling of each support configuration for now...
    var hash = crypto.createHash('sha1');

    function hashObject(o, depth) {
        if (depth > MAX_FINGERPRINT_DEPTH) {
            return;
        }

        var keys = Object.keys(o);
        keys.sort();

        for (var i = 0; i < keys.length; i++) {
            var k = keys[i];
            var v = o[k];
            update(k, depth + 1);
            update(v, depth + 1);
        }
    }

    function hashArray(o, depth) {
        if (depth > MAX_FINGERPRINT_DEPTH) {
            return;
        }

        var len = o.length;

        for (var i = 0; i < len; i++) {
            update(o[i], depth + 1);
        }
    }

    function update(value, depth) {
        if (depth === undefined) {
            depth = 0;
        }

        if (depth > 0 && typeof v === 'function') {
            return;
        }

        if (value == null) {
            hash.update('');
            return;
        }

        if (Array.isArray(value)) {
            hashArray(value, depth);
        } else if (typeof value === 'object') {
            hashObject(value, depth);
        } else {
            hash.update(value.toString());
        }
    }

    update(config.rawConfig);

    return hash.digest('hex');
}

function Config(params) {
    this.configResource = null;

    this.bundlingEnabled = true;

    this.projectRoot = null;

    this.flags = flags.createFlagSet();
    this.params = {};
    this.bundleSetConfigsByName = {};
    this.fileWriterConfig = null;
    this.transforms = [];
    this.bundlingEnabled = true;
    this.basePath = null;
    this.writer = null;
    this.includeSlotNameForBundles = false;
    this._plugins = [];
    this.cacheProfiles = null;
    this.cacheProfile = null;
    this.cacheDir = null;
    this._requirePluginConfig = {};
    this._minifyJSPluginConfig = {};
    this._minifyCSSPluginConfig = {};
    this._imagePluginConfig = {};
    this.cspNonceProvider = null;
    this.fingerprintInlineCode = null;
    this.cacheKey = null; // The unique key to uniquely identify this lasso for caching purposes
    this.resolver = null;
    this.loadPrebuild = false; // Whether Lasso should load from a prebuild configuration or not

    if (params) {
        extend(this.params, params);
    }

    this.addDefaultPlugins();

    this._configFingerprint = null;
}

Config.prototype = {
    __Config: true,

    get outputDir() {
        return this.fileWriterConfig && this.fileWriterConfig.outputDir;
    },

    get urlPrefix() {
        return this.fileWriterConfig && this.fileWriterConfig.urlPrefix;
    },

    /**
     * The goal of this method is to return a String that uniquely identifies
     * this configuration. This is needed for caching purposes in that we want
     * to discard cached items if the configuration changes. For example, if
     * a new transform is added then the previously cached transformed items
     * should not be used.
     */
    getConfigFingerprint: function() {
        if (!this._configFingerprint) {
            this._configFingerprint = calculateConfigFingerprint(this);
        }

        return this._configFingerprint;
    },

    addDefaultPlugins: function() {
        this.addPlugin(lassoRequirePlugin, this._requirePluginConfig);
        this.addPlugin(lassoImagePlugin, this._imagePluginConfig);
    },

    getPlugins: function(pluginInfo) {
        return this._plugins;
    },

    addPlugin: function(func, config) {
        // Don't add if this is a duplicate plugin
        for (var i = 0; i < this._plugins.length; i++) {
            var curPlugin = this._plugins[i];
            if (curPlugin.func === func && curPlugin.config === config) {
                return;
            }
        }

        ok(typeof func === 'function', 'Plugin should be a function. Actual: ' + func);
        this._plugins.push({
            func: func,
            config: config || {}
        });
    },

    addTransform: function(transform) {
        if (!transform) {
            throw new Error('transform is required');
        }

        if (transform.enabled === false) {
            // Don't add transforms that are disabled
            return;
        }

        if (typeof transform === 'function') {
            transform = {
                transform: transform
            };
        }

        if (typeof transform.transform !== 'function') {
            throw new Error('Invalid transform: ' + require('util').inspect(transform));
        }

        transform.name = transform.name || transform.transform.name || '(anonymous)'; // Use the function name

        if (transform.contentType) {
            // Convert the contentType to a filter
            transform = extend({}, transform);
            transform.filter = createFilterFromContentType(transform.contentType);
            delete transform.contentType;
        }

        this.transforms.push(transform);
    },

    getResolver () {
        return this.resolver;
    },

    getTransforms: function() {
        return this.transforms;
    },

    isInPlaceDeploymentEnabled: function() {
        return this.inPlaceDeploymentEnabled === true;
    },

    isBundlingEnabled: function() {
        return this.bundlingEnabled;
    },

    addBundleSetConfig: function(bundleSetConfig) {
        if (!bundleSetConfig.name) {
            bundleSetConfig.name = 'default';
        }

        if (this.bundleSetConfigsByName[bundleSetConfig.name]) {
            throw new Error('Bundles with name "' + bundleSetConfig.name + '" defined multiple times');
        }

        this.bundleSetConfigsByName[bundleSetConfig.name] = bundleSetConfig;

        return bundleSetConfig;
    },

    getBundleSetConfig: function(name) {
        return this.bundleSetConfigsByName[name];
    },

    enableFlag: function(name) {
        this.flags.add(name);
    },

    /**
     * @deprecated
     */
    enableExtension: function(name) {
        this.flags.add(name);
    },

    getFlags: function() {
        return this.flags;
    },

    setFlags: function(newFlags) {
        this.flags = flags.createFlagSet(newFlags);
    },

    getPageBundleSetConfig: function(pageName) {
        var bundleSetConfig = this.getBundleSetConfig('default');

        if (!bundleSetConfig) {
            bundleSetConfig = this.addBundleSetConfig(new BundleSetConfig('default'));
        }

        return bundleSetConfig;
    },

    setInPlaceDeploymentEnabled: function(inPlaceDeploymentEnabled) {
        this.inPlaceDeploymentEnabled = inPlaceDeploymentEnabled;
    },

    setInPlaceUrlPrefix: function(inPlaceUrlPrefix) {
        this.inPlaceUrlPrefix = inPlaceUrlPrefix;
    },

    getInPlaceUrlPrefix: function() {
        return this.inPlaceUrlPrefix;
    },

    getBasePath: function() {
        return this.basePath;
    },

    setBasePath: function(basePath) {
        this.basePath = basePath;
    },

    getWriter: function() {
        return this.writer;
    },

    setResolver (resolver) {
        this.resolver = resolver;
    },

    setWriter: function(writer) {
        this.writer = writer;
    },

    getProjectRoot: function() {
        return this.projectRoot;
    },

    setProjectRoot: function(projectRoot) {
        if (projectRoot != null) {
            var len = projectRoot.length;
            // chop off trailing slash so that our path operations are consistent
            if (projectRoot.charAt(len - 1) === '/' || projectRoot.charAt(len - 1) === '\\') {
                projectRoot = projectRoot.substring(0, len - 1);
            }
        }
        this.projectRoot = projectRoot;
    },

    setBundlingEnabled: function(bundlingEnabled) {
        this.bundlingEnabled = bundlingEnabled;
    },

    setBundlingStrategy: function(bundlingStrategy) {
        this.bundlingStrategy = bundlingStrategy;
    },

    getBundlingStrategy: function() {
        return this.bundlingStrategy;
    },

    setCacheProfiles: function(cacheProfiles) {
        this.cacheProfiles = cacheProfiles;
    },

    getCacheProfiles: function() {
        return this.cacheProfiles;
    },

    setCacheProfile: function(cacheProfile) {
        this.cacheProfile = cacheProfile;
    },

    getCacheProfile: function() {
        return this.cacheProfile;
    },

    setCacheDir: function(cacheDir) {
        this.cacheDir = cacheDir;
    },

    getCacheDir: function() {
        return this.cacheDir;
    },

    toString: function() {
        return '[' + __filename + ']'; // eslint-disable-line no-path-concat
    },

    setBundleReadTimeout: function(timeout) {
        this.bundleReadTimeout = timeout;
    },

    getBundleReadTimeout: function() {
        return this.bundleReadTimeout;
    },

    setCSPNonceProvider: function(func) {
        this.cspNonceProvider = func;
    },

    setFingerprintInlineCode: function(func) {
        this.fingerprintInlineCode = func;
    },

    setCacheKey (value) {
        this.cacheKey = value;
    },

    /**
    * Whether Lasso should load from a prebuild configuration or not
    */
    setLoadPrebuild (value) {
        this.loadPrebuild = value;
    },

    getLoadPrebuild () {
        return this.loadPrebuild;
    }
};

module.exports = Config;