Allow custom sandbox to be used in fastboot.

Fastboot had an API to allow any app to use a custom sandbox class. However, this was never fully working. This PR fixes that.

This PR also adds a `sandboxGlobals` which allows to pass any other variables that need to be exposed in the sandbox.

Author: kratiahuja

src/ember-app.js

@@ -26,6 +26,7 @@ class EmberApp {
    * @param {Object} options
    * @param {string} options.distPath - path to the built Ember application
    * @param {Sandbox} [options.sandbox=VMSandbox] - sandbox to use
+   * @param {Object} [options.sandboxGlobals] - sandbox variables that can be added or used for overrides in the sandbox.
    */
   constructor(options) {
     let distPath = path.resolve(options.distPath);
@@ -43,7 +44,7 @@ class EmberApp {
 
     this.html = fs.readFileSync(config.htmlFile, 'utf8');
 
-    this.sandbox = this.buildSandbox(distPath, options.sandbox);
+    this.sandbox = this.buildSandbox(distPath, options.sandbox, options.sandboxGlobals);
     this.app = this.retrieveSandboxedApp();
   }
 
@@ -54,23 +55,32 @@ class EmberApp {
    *
    * @param {string} distPath path to the built Ember app to load
    * @param {Sandbox} [sandboxClass=VMSandbox] sandbox class to use
+   * @param {Object} [sandboxGlobals={}] any additional variables to expose in the sandbox or override existing in the sandbox
    */
-  buildSandbox(distPath, sandboxClass) {
+  buildSandbox(distPath, sandboxClass, sandboxGlobals) {
     let Sandbox = sandboxClass || require('./vm-sandbox');
     let sandboxRequire = this.buildWhitelistedRequire(this.moduleWhitelist, distPath);
     let config = this.appConfig;
     function appConfig() {
       return { default: config };
     }
 
-    return new Sandbox({
-      globals: {
-        najax: najax,
-        FastBoot: {
-          require: sandboxRequire,
-          config: appConfig
-        }
+    // add any additional user provided variables or override the default globals in the sandbox
+    let globals = {
+      najax: najax,
+      FastBoot: {
+        require: sandboxRequire,
+        config: appConfig
+      }
+    };
+    for (let key in sandboxGlobals) {
+      if (sandboxGlobals.hasOwnProperty(key)) {
+        globals[key] = sandboxGlobals[key];
       }
+    }
+
+    return new Sandbox({
+      globals: globals
     });
   }
 

src/index.js

@@ -15,13 +15,16 @@ const EmberApp = require('./ember-app');
  *
  * By default, this sandbox is the built-in `VMSandbox` class, which uses
  * Node's `vm` module. You may provide your own sandbox implementation by
- * passing the `sandbox` option.
+ * passing the `sandbox` option or add and/or override sandbox variables by
+ * passing the `addOrOverrideSandboxGlobals` option.
  *
  * @example
  * const FastBoot = require('fastboot');
  *
  * let app = new FastBoot({
- *   distPath: 'path/to/dist'
+ *   distPath: 'path/to/dist',
+ *   sandbox: 'path/to/sandboxClass',
+ *   sandboxGlobals: {...}
  * });
  *
  * app.visit('/photos')
@@ -36,15 +39,17 @@ class FastBoot {
    * @param {string} options.distPath the path to the built Ember application
    * @param {Boolean} [options.resilient=false] if true, errors during rendering won't reject the `visit()` promise but instead resolve to a {@link Result}
    * @param {Sandbox} [options.sandbox=VMSandbox] the sandbox to use
+   * @param {Object} [options.sandboxGlobals={}] any additional sandbox variables that an app server wants to override and/or add in the sandbox
    */
   constructor(options) {
     options = options || {};
 
     this.distPath = options.distPath;
     this.sandbox = options.sandbox;
+    this.sandboxGlobals = options.sandboxGlobals || {};
     this.resilient = !!options.resilient || false;
 
-    this._buildEmberApp(this.distPath);
+    this._buildEmberApp(this.distPath, this.sandbox, this.sandboxGlobals);
   }
 
   /**
@@ -89,7 +94,7 @@ class FastBoot {
     this._buildEmberApp(options ? options.distPath : null);
   }
 
-  _buildEmberApp(distPath) {
+  _buildEmberApp(distPath, sandbox, sandboxGlobals) {
     distPath = distPath || this.distPath;
 
     if (!distPath) {
@@ -104,7 +109,9 @@ class FastBoot {
 
     this.distPath = distPath;
     this._app = new EmberApp({
-      distPath: distPath
+      distPath: distPath,
+      sandbox: sandbox,
+      sandboxGlobals: sandboxGlobals
     });
   }
 

test/fastboot-test.js

@@ -6,6 +6,7 @@ const path             = require('path');
 const fixture          = require('./helpers/fixture-path');
 const alchemistRequire = require('broccoli-module-alchemist/require');
 const FastBoot         = alchemistRequire('index');
+const CustomSandbox    = require('./fixtures/custom-sandbox/custom-sandbox');
 
 describe("FastBoot", function() {
   it("throws an exception if no distPath is provided", function() {
@@ -91,6 +92,42 @@ describe("FastBoot", function() {
       });
   });
 
+  it("can render HTML when sandboxGlobals is provided", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('custom-sandbox'),
+      sandboxGlobals: {
+        foo: 5,
+        najax: 'undefined',
+        myVar: 'undefined'
+      }
+    });
+
+    return fastboot.visit('/foo')
+      .then(r => r.html())
+      .then(html => {
+        expect(html).to.match(/foo from sandbox: 5/);
+        expect(html).to.match(/najax in sandbox: undefined/);
+      });
+  });
+
+  it("can render HTML when sandbox class is provided", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('custom-sandbox'),
+      sandboxClass: CustomSandbox,
+      sandboxGlobals: {
+        myVar: 2,
+        foo: 'undefined',
+        najax: 'undefined'
+      }
+    });
+
+    return fastboot.visit('/foo')
+      .then(r => r.html())
+      .then(html => {
+        expect(html).to.match(/myVar in sandbox: 2/);
+      });
+  });
+
   it("rejects the promise if an error occurs", function() {
     var fastboot = new FastBoot({
       distPath: fixture('rejected-promise')