Remove ability to provide custom sandbox class.

Co-authored-by: Kris Selden <[email protected]>

Author: Robert Jackson

README.md

@@ -28,7 +28,6 @@ let app = new FastBoot({
   distPath: 'path/to/dist',
   // optional boolean flag when set to true does not reject the promise if there are rendering errors (defaults to false)
   resilient: <boolean>,
-  sandbox: 'path/to/sandbox/class', // optional sandbox class (defaults to vm-sandbox)
   sandboxGlobals: {...} // optional map of key value pairs to expose in the sandbox
 });
 

src/ember-app.js

@@ -9,6 +9,7 @@ const SimpleDOM = require('simple-dom');
 const resolve = require('resolve');
 const debug = require('debug')('fastboot:ember-app');
 
+const Sandbox = require('./sandbox');
 const FastBootInfo = require('./fastboot-info');
 const Result = require('./result');
 const FastBootSchemaVersions = require('./fastboot-schema-versions');
@@ -27,12 +28,10 @@ class EmberApp {
    * Create a new 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) {
     // TODO: make these two into builder functions
-    this.SandboxClass = options.sandbox;
     this.sandboxGlobals = options.sandboxGlobals;
 
     let distPath = (this.distPath = path.resolve(options.distPath));
@@ -70,7 +69,7 @@ class EmberApp {
    * Builds and initializes a new sandbox to run the Ember application in.
    */
   buildSandbox() {
-    const { distPath, SandboxClass, sandboxGlobals, config, appName, sandboxRequire } = this;
+    const { distPath, sandboxGlobals, config, appName, sandboxRequire } = this;
 
     function fastbootConfig(key) {
       if (!key) {
@@ -101,7 +100,7 @@ class EmberApp {
       sandboxGlobals
     );
 
-    return new SandboxClass(globals);
+    return new Sandbox(globals);
   }
 
   /**

src/index.js

@@ -13,17 +13,15 @@ const EmberApp = require('./ember-app');
  * are run inside a sandbox that prohibits them from accessing the normal
  * Node.js environment.
  *
- * 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 or add and/or override sandbox variables by
+ * This sandbox is the built-in `VMSandbox` class, which uses
+ * Node's `vm` module. You may add and/or override sandbox variables by
  * passing the `addOrOverrideSandboxGlobals` option.
  *
  * @example
  * const FastBoot = require('fastboot');
  *
  * let app = new FastBoot({
  *   distPath: 'path/to/dist',
- *   sandbox: 'path/to/sandboxClass',
  *   sandboxGlobals: {...}
  * });
  *
@@ -38,19 +36,17 @@ class FastBoot {
    * @param {Object} options
    * @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 = {}) {
-    let { distPath, sandbox, sandboxGlobals } = options;
+    let { distPath, sandboxGlobals } = options;
 
     this.resilient = 'resilient' in options ? Boolean(options.resilient) : false;
 
     this.distPath = distPath;
-    this.sandbox = sandbox || require('./sandbox');
     this.sandboxGlobals = sandboxGlobals || {};
 
-    this._buildEmberApp(this.distPath, this.sandbox, this.sandboxGlobals);
+    this._buildEmberApp(this.distPath, this.sandboxGlobals);
   }
 
   /**
@@ -96,11 +92,7 @@ class FastBoot {
     this._buildEmberApp(distPath);
   }
 
-  _buildEmberApp(
-    distPath = this.distPath,
-    sandbox = this.sandbox,
-    sandboxGlobals = this.sandboxGlobals
-  ) {
+  _buildEmberApp(distPath = this.distPath, sandboxGlobals = this.sandboxGlobals) {
     if (!distPath) {
       throw new Error(
         'You must instantiate FastBoot with a distPath ' +
@@ -117,7 +109,6 @@ class FastBoot {
 
     this._app = new EmberApp({
       distPath,
-      sandbox,
       sandboxGlobals,
     });
   }

test/fastboot-test.js

@@ -5,7 +5,6 @@ const fs = require('fs');
 const path = require('path');
 const fixture = require('./helpers/fixture-path');
 const FastBoot = require('./../src/index');
-const CustomSandbox = require('./fixtures/custom-sandbox/custom-sandbox');
 
 describe('FastBoot', function() {
   it('throws an exception if no distPath is provided', function() {
@@ -166,25 +165,6 @@ describe('FastBoot', function() {
       });
   });
 
-  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'),
@@ -282,35 +262,6 @@ describe('FastBoot', function() {
     }
   });
 
-  it('can reload the app using the same sandbox class', function() {
-    var fastboot = new FastBoot({
-      distPath: fixture('basic-app'),
-      sandbox: CustomSandbox,
-      sandboxGlobals: {
-        myVar: 2,
-        foo: 'undefined',
-        najax: 'undefined',
-      },
-    });
-
-    return fastboot
-      .visit('/')
-      .then(r => r.html())
-      .then(html => expect(html).to.match(/Welcome to Ember/))
-      .then(hotReloadApp)
-      .then(() => fastboot.visit('/foo'))
-      .then(r => r.html())
-      .then(html => {
-        expect(html).to.match(/myVar in sandbox: 2/);
-      });
-
-    function hotReloadApp() {
-      fastboot.reload({
-        distPath: fixture('custom-sandbox'),
-      });
-    }
-  });
-
   it('reads the config from package.json', function() {
     var fastboot = new FastBoot({
       distPath: fixture('config-app'),