cloudcms-server 4.0.0-beta.2 → 4.0.0-beta.21

package/duster/support.js

@@ -1,436 +0,0 @@
-var async = require("async");
-var path = require("path");
-var fs = require("fs");
-
-var util = require("../util/util");
-var renditions = require("../util/renditions");
-
-/**
- * Helper functions for Dust Tags
- *
- * @type {Function}
- */
-exports = module.exports = function(dust)
-{
-    var r = {};
-
-    // used to check whether a parameter is defined, meaning it has a value and the value is NON EMPTY.
-    var isDefined = r.isDefined = function(thing)
-    {
-        return ( (typeof(thing) !== "undefined") && (thing !== "") );
-    };
-
-    /**
-     * Determines whether to use the fragment cache.  We use this cache if we're instructed to and if we're in
-     * production model.
-     *
-     * @returns {boolean}
-     */
-    var isFragmentCacheEnabled = r.isFragmentCacheEnabled = function()
-    {
-        if (!process.configuration.duster) {
-            process.configuration.duster = {};
-        }
-        if (!process.configuration.duster.fragments) {
-            process.configuration.duster.fragments = {};
-        }
-        if (typeof(process.configuration.duster.fragments.cache) === "undefined") {
-            process.configuration.duster.fragments.cache = true;
-        }
-
-        if (process.env.FORCE_CLOUDCMS_DUST_FRAGMENT_CACHE === "true")
-        {
-            process.configuration.duster.fragments.cache = true;
-        }
-        else if (process.env.FORCE_CLOUDCMS_DUST_FRAGMENT_CACHE === "false")
-        {
-            process.configuration.duster.fragments.cache = false;
-        }
-
-        if (process.env.CLOUDCMS_APPSERVER_MODE !== "production") {
-            process.configuration.duster.fragments.cache = false;
-        }
-
-        return process.configuration.duster.fragments.cache;
-    };
-
-
-    var resolveVariables = r.resolveVariables = function(variables, context, callback)
-    {
-        if (!variables) {
-            callback();
-            return;
-        }
-
-        if (variables.length === 0)
-        {
-            callback(null, []);
-            return;
-        }
-
-        var resolvedVariables = [];
-
-        var fns = [];
-        for (var i = 0; i < variables.length; i++)
-        {
-            var fn = function(variable) {
-                return function(done) {
-
-                    dust.renderSource("" + variable, context, function (err, value) {
-
-                        if (err) {
-                            done(err);
-                            return;
-                        }
-
-                        value = value.trim();
-
-                        resolvedVariables.push(value);
-                        done();
-                    });
-
-                }
-            }(variables[i]);
-            fns.push(fn);
-        }
-
-        async.series(fns, function(err) {
-            callback(err, resolvedVariables);
-        });
-    };
-
-    /**
-     * Helper function that sets the dust cursor to flushable.
-     * This is to get around an apparent bug with dust:
-     *
-     *    https://github.com/linkedin/dustjs/issues/303
-     *
-     * @param chunk
-     * @param callback
-     * @returns {*}
-     */
-    var map = r.map = function(chunk, callback)
-    {
-        var cursor = chunk.map(function(branch) {
-            callback(branch);
-        });
-        cursor.flushable = true;
-
-        return cursor;
-    };
-
-    /**
-     * Helper function to end the chunk.  This is in place because it's unclear exactly what is needed to counter
-     * the issue mentioned in:
-     *
-     *    https://github.com/linkedin/dustjs/issues/303
-     *
-     * At one point, it seemed that some throttling of the end() call was required.  It may still be at some point.
-     * So for now, we use this helper method to end() since it lets us inject our own behaviors if needed.
-     *
-     * @param chunk
-     * @param context
-     * @param err
-     */
-    var end = r.end = function(chunk, context, err)
-    {
-        if (err)
-        {
-            chunk.setError(err);
-        }
-        else
-        {
-            chunk.end();
-        }
-    };
-
-    var _MARK_INSIGHT = r._MARK_INSIGHT = function(node, result)
-    {
-        if (result)
-        {
-            result.insightNode = node.getRepositoryId() + "/" + node.getBranchId() + "/" + node.getId();
-        }
-        else
-        {
-            console.log("WARN: result node should not be null");
-            console.trace();
-        }
-    };
-
-
-    //
-    // tracker related stuff
-    //
-
-    var buildRequirements = r.buildRequirements  = function(context, requirements)
-    {
-        var badKeys = [];
-
-        for (var key in requirements)
-        {
-            if (!requirements[key])
-            {
-                badKeys.push(key);
-            }
-        }
-
-        for (var i = 0; i < badKeys.length; i++)
-        {
-            delete requirements[badKeys[i]];
-        }
-
-        // add in stuff from request if available
-        var req = context.get("req");
-        if (req)
-        {
-            if (req.repositoryId)
-            {
-                requirements["repository"] = req.repositoryId;
-            }
-
-            if (req.branchId)
-            {
-                requirements["branch"] = req.branchId;
-            }
-        }
-
-        return requirements;
-    };
-
-    var handleCacheFragmentRead = r.handleCacheFragmentRead = function(context, fragmentId, requirements, callback)
-    {
-        if (!isFragmentCacheEnabled())
-        {
-            return callback();
-        }
-
-        var req = context.get("req");
-
-        var contentStore = req.stores.content;
-
-        var fragmentsBasePath = context.get("_fragments_base_path");
-        if (!fragmentsBasePath) {
-            fragmentsBasePath = path.join("duster", "repositories", req.repositoryId, "branches", req.branchId, "fragments");
-        }
-
-        // fragment cache key
-        var fragmentCacheKey = util.generateFragmentCacheKey(fragmentId, requirements);
-
-        // disk location
-        var fragmentFilePath = path.join(fragmentsBasePath, fragmentCacheKey, "fragment.html");
-        util.safeReadStream(contentStore, fragmentFilePath, function(err, stream) {
-            callback(err, stream, fragmentFilePath, fragmentCacheKey);
-        });
-    };
-
-    var handleCacheFragmentWrite = r.handleCacheFragmentWrite = function(context, fragmentDescriptor, fragmentDependencies, requirements, text, callback)
-    {
-        // if fragment cache not enabled, return right away
-        if (!isFragmentCacheEnabled())
-        {
-            return callback();
-        }
-
-        var req = context.get("req");
-
-        var contentStore = req.stores.content;
-
-        var fragmentsBasePath = context.get("_fragments_base_path");
-        if (!fragmentsBasePath) {
-            fragmentsBasePath = path.join("duster", "repositories", req.repositoryId, "branches", req.branchId, "fragments");
-        }
-
-        // fragment cache key
-        var fragmentCacheKey = util.generateFragmentCacheKey(fragmentDescriptor.fragmentId, requirements);
-
-        // store this
-        fragmentDescriptor.fragmentCacheKey = fragmentCacheKey;
-
-        // mark the rendition
-        if (fragmentDependencies)
-        {
-            console.log("marking rendition from dust. fragmentId: " + fragmentDescriptor.fragmentId);
-            renditions.markRendition(req, fragmentDescriptor, fragmentDependencies, function (err) {
-
-                // if we got an error writing the rendition, then we have to roll back and invalidate disk cache
-                if (err)
-                {
-                    var fragmentFolderPath = path.join(fragmentsBasePath, fragmentCacheKey);
-
-                    console.log("Caught error on fragment markRendition, invalidating: " + fragmentFolderPath + ", err:" + err);
-
-                    _handleCacheFragmentInvalidate(contentStore, fragmentFolderPath, function() {
-                        // done
-                    });
-                }
-
-            });
-        }
-
-        // disk location
-        var fragmentFilePath = path.join(fragmentsBasePath, fragmentCacheKey, "fragment.html");
-        contentStore.writeFile(fragmentFilePath, text, function(err) {
-            callback(err, fragmentFilePath, fragmentCacheKey);
-        });
-    };
-
-    var handleCacheFragmentInvalidate = r.handleCacheFragmentInvalidate = function(host, fragmentsBasePath, fragmentCacheKey, callback)
-    {
-        var fragmentFolderPath = path.join(fragmentsBasePath, fragmentCacheKey);
-
-        // list all of the hosts
-        var stores = require("../middleware/stores/stores");
-        stores.produce(host, function (err, stores) {
-
-            if (err) {
-                return callback(err, fragmentFolderPath);
-            }
-
-            _handleCacheFragmentInvalidate(stores.content, fragmentFolderPath, function(err, fragmentFolderPath) {
-                return callback(null, fragmentFolderPath);
-            });
-        });
-    };
-
-    var _handleCacheFragmentInvalidate = function(contentStore, fragmentFolderPath, callback)
-    {
-        contentStore.existsDirectory(fragmentFolderPath, function (exists) {
-
-            if (!exists) {
-                return callback();
-            }
-
-            contentStore.removeDirectory(fragmentFolderPath, function () {
-                callback();
-            });
-        });
-    };
-
-    var loadFragment = r.loadFragment = function(context, fragmentId, requirements, callback)
-    {
-        if (!isFragmentCacheEnabled())
-        {
-            return callback();
-        }
-
-        if (!fragmentId)
-        {
-            return callback();
-        }
-
-        var req = context.get("req");
-
-        handleCacheFragmentRead(context, fragmentId, requirements, function(err, readStream, readPath, fragmentCacheKey) {
-
-            if (!err && readStream)
-            {
-                var req = context.get("req");
-
-                // yes, we found it in cache, so we'll simply pipe it back from disk
-                req.log("Fragment Cache Hit: " + req.url + "#" + fragmentCacheKey);
-
-                // read stream in
-                var bufs = [];
-                readStream.on('data', function(d){ bufs.push(d);});
-                readStream.on('end', function(){
-
-                    var fragment = "" + Buffer.concat(bufs).toString();
-
-                    callback(null, fragment);
-                });
-
-                return;
-            }
-
-            callback({
-                "message": "Unable to read fragment: " + fragmentId
-            });
-
-        });
-    };
-
-    var renderFragment = r.renderFragment = function(context, fragmentId, requirements, chunk, bodies, callback)
-    {
-        if (!isFragmentCacheEnabled() || !fragmentId)
-        {
-            chunk.render(bodies.block, context);
-            end(chunk, context);
-
-            return callback();
-        }
-
-        var c = chunk.capture(bodies.block, context, function(text, chunk2) {
-
-            // we leave a timeout here so that things can catch up internally within Dust (more oddness!)
-            setTimeout(function() {
-
-                // for reasons that have everything to do with Dust oddness...
-                // write to "c" and be sure to end "c" then "chunk2"
-                c.write(text);
-                c.end();
-                chunk2.end();
-                // NOTE: normally, we'd expect to do something like this
-                //chunk2.write(text);
-                //end(chunk2);
-                // but this doesn't work and it has something to do with dust.map and chunk.capture intermingling weirdly
-
-                // now let's cache it
-                var fragmentDescriptor = {};
-                var pageDescriptor = context.get("_page_descriptor");
-                if (pageDescriptor) {
-                    fragmentDescriptor = util.clone(pageDescriptor, true);
-                }
-                fragmentDescriptor.fragmentId = fragmentId;
-                fragmentDescriptor.scope = "FRAGMENT";
-
-                var tracker = context.get("__tracker");
-
-                var fragmentDependencies = {};
-                fragmentDependencies.requires = tracker.requires;
-                fragmentDependencies.produces = tracker.produces;
-
-                // write to cache
-                handleCacheFragmentWrite(context, fragmentDescriptor, fragmentDependencies, requirements, text, function(err, writtenPath, writtenCacheKey) {
-
-                    var req = context.get("req");
-
-                    if (err) {
-                        req.log("Fragment Cache Write Failed for URL: " + req.url + ", err: " + JSON.stringify(err, null, "  "));
-                        return callback(err);
-                    }
-
-                    req.log("Fragment Cache Write: " + req.url + "#" + writtenCacheKey);
-
-                    callback();
-                });
-            }, 1);
-        });
-
-        return c;
-    };
-
-    var addHelpers = r.addHelpers = function(app, dust, filepaths, callback) {
-
-        var fns = [];
-        for (var i = 0; i < filepaths.length; i++)
-        {
-            var fn = function(filepath, app, dust) {
-                return function(done) {
-
-                    require(filepath)(app, dust, function() {
-                        //console.log("Loaded dust helper: " + filepath);
-                        done();
-                    });
-                }
-            }(filepaths[i], app, dust);
-            fns.push(fn);
-        }
-
-        async.series(fns, function() {
-            callback();
-        });
-
-    };
-
-    return r;
-};

package/duster/tracker.js

@@ -1,262 +0,0 @@
-var exports = module.exports;
-
-var util = require("../util/util");
-
-var trackerInstance = function(context)
-{
-    return context.get("__tracker");
-};
-
-var getParentContext = function(context)
-{
-    var parentContext = null;
-
-    // if this context has a parent...
-    if (context.stack && context.stack.tail && context.stack.tail.length > 0)
-    {
-        // the current tip context
-        // pop it off and "context" modifies
-        var currentContext = context.pop();
-
-        // the new tip is the parent
-        parentContext = context.current();
-
-        // restore the current context as tip
-        context.push(currentContext);
-    }
-
-    return parentContext;
-};
-
-var id = exports.id = function(context)
-{
-    var instance = trackerInstance(context);
-
-    return instance.id;
-};
-
-/**
- * Starts a tracker within the current context.
- *
- * The tracker is bound to the Dust context's push and pop methods.  A "__tracker" instance holds the dependency
- * tracker instance for that particular frame in the stack.
- *
- * When the context is popped, the tracker for the current frame copies some of it's dependency state from the child
- * to the parent.  Dependency state is either of type "produces" or "requires".
- *
- * PRODUCES
- * --------
- *
- * The "produces" dependencies usually identify the content items or display assets that the current execution
- * rendered on the screen.  It identifies which objects produced the rendered view.
- *
- * When the context pops, these dependencies always copy from the child context to the parent.  Any wrapping fragments
- * inherit the produced dependencies of their children, all the way up to the page.
- *
- * That way, if a product dependency (i.e. a Cloud CMS content node) invalidates, all pages and nested fragments can be
- * detected and invalidated at once.
- *
- * In this sense, it is fair to think of produced dependencies as serving the purpose of how to optimize
- * invalidation.
- *
- * REQUIRES
- * --------
- *
- * The "requires" dependencies identify the required state of the parent such that the cached state of the
- * current execution context can be used.
- *
- * These dependencies are a list of "what must be true" about the outer variables such that we can use the cache
- * fragment.
- *
- * All requires variables are local.  They do not propagate up to the parent in the same way as "produces" dependencies.
- * Rather, the nested nature of HTML ensures that outer HTML fragments will contain the HTML of inner HTML fragments.
- *
- * The "requires" dependencies serve as a kind of footprint that allows for a very fast pattern match against the
- * current set of known runtime variables at any point in the execution chain.  For the top-level page, these include
- * things like the repository ID, the branchID and any other request state that was used to produce the page.
- *
- * All "requires" dependencies pass down to children but they do not pass back up to parents.
- *
- *
- * Requirements should look like:
- *
- *      {
- *          "param1": "abc",
- *          "param2": "def"
- *      }
- *
- * @param childContext
- * @param _id
- * @param _requirements
- */
-var start = exports.start = function(childContext, _id, _requirements)
-{
-    var childTracker = {
-        "requires": {},
-        "produces": {}
-    };
-
-    var fc = function(parentTracker, childTracker, key)
-    {
-        if (parentTracker[key] && parentTracker[key].length > 0)
-        {
-            for (var k in parentTracker[key])
-            {
-                if (!childTracker[key][k]) {
-                    childTracker[key][k] = [];
-                }
-
-                for (var i = 0; i < parentTracker[key][k].length; i++)
-                {
-                    childTracker[key][k].push(parentTracker[key][k][i]);
-                }
-            }
-        }
-    };
-
-    // find the parent context
-    var parentContext = getParentContext(childContext);
-    if (parentContext)
-    {
-        // copy parent "requires" and "produces" into new child tracker object
-        var parentTracker = trackerInstance(parentContext);
-        if (parentTracker)
-        {
-            fc(parentTracker, childTracker, "requires");
-            fc(parentTracker, childTracker, "produces");
-        }
-    }
-
-    if (_id)
-    {
-        childTracker.id = _id;
-    }
-
-    if (_requirements)
-    {
-        requirements(childContext, _requirements);
-    }
-};
-
-/**
- * Finishes a tracker.
- *
- * This hands back the tracker state.  It also copies tracker dependencies up to the parent tracker.
- *
- * @param parentContext
- * @param childContext
- * @returns the tracker context
- */
-var finish = exports.finish = function(childContext)
-{
-    // child tracker
-    var childTracker = trackerInstance(childContext);
-
-    // find the parent context
-    var parentContext = getParentContext(childContext);
-    if (parentContext)
-    {
-        // parent tracker
-        var parentTracker = trackerInstance(parentContext);
-
-        // now copy stuff back up
-        if (parentTracker)
-        {
-            // any "produces" dependencies always copies up
-            for (var name in childTracker.produces)
-            {
-                var array = childTracker.produces[name];
-                if (array)
-                {
-                    if (!parentTracker["produces"][name])
-                    {
-                        parentTracker["produces"][name] = [];
-                    }
-
-                    for (var i = 0; i < array.length; i++)
-                    {
-                        if (parentTracker["produces"][name].indexOf(array[i]) === -1)
-                        {
-                            parentTracker["produces"][name].push(array[i]);
-                        }
-                    }
-                }
-            }
-        }
-    }
-};
-
-/**
- * Marks that the current rendering requires the following requirements.
- *
- * @param context
- * @param requirements
- */
-var requirements = exports.requirements = function(context, requirements)
-{
-    for (var k in requirements)
-    {
-        var v = requirements[k];
-        if (v)
-        {
-            requires(context, k, v.value);
-        }
-    }
-};
-
-/**
- * Marks that the current rendering requires the following key=value to be in place.
- *
- * @param context
- * @param key
- * @param value
- */
-var requires = exports.requires = function(context, key, value)
-{
-    if (typeof(value) !== "undefined" && value !== null)
-    {
-        var instance = trackerInstance(context);
-
-        var requires = instance["requires"];
-
-        var array = requires[key];
-        if (!array)
-        {
-            requires[key] = array = [];
-        }
-
-        if (array.indexOf(value) === -1)
-        {
-            array.push(value);
-        }
-    }
-};
-
-/**
- * Marks that the current rendering produces a result that features the given key=value as part of its output.
- *
- * @param context
- * @param key
- * @param value
- */
-var produces = exports.produces = function(context, key, value)
-{
-    if (typeof(value) !== "undefined" && value !== null)
-    {
-        var instance = trackerInstance(context);
-
-        var produces = instance["produces"];
-
-        var array = produces[key];
-        if (!array)
-        {
-            array = [];
-            produces[key] = array;
-        }
-
-        if (array.indexOf(value) === -1)
-        {
-            array.push(value);
-        }
-    }
-};