Make a vm context per visit.

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

Author: Robert Jackson

src/ember-app.js

@@ -31,7 +31,11 @@ class EmberApp {
    * @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);
+    // TODO: make these two into builder functions
+    this.SandboxClass = options.sandbox;
+    this.sandboxGlobals = options.sandboxGlobals;
+
+    let distPath = (this.distPath = path.resolve(options.distPath));
     let config = this.readPackageJSON(distPath);
 
     this.appFilePaths = config.appFiles;
@@ -57,23 +61,16 @@ class EmberApp {
 
     this.html = fs.readFileSync(config.htmlFile, 'utf8');
 
-    this.sandbox = this.buildSandbox(distPath, options.sandbox, options.sandboxGlobals);
-    this.app = this.retrieveSandboxedApp();
+    this.sandboxRequire = this.buildWhitelistedRequire(this.moduleWhitelist, distPath);
   }
 
   /**
    * @private
    *
    * Builds and initializes a new sandbox to run the Ember application in.
-   *
-   * @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, sandboxGlobals) {
-    const { config, appName } = this;
-
-    let sandboxRequire = this.buildWhitelistedRequire(this.moduleWhitelist, distPath);
+  buildSandbox() {
+    const { distPath, SandboxClass, sandboxGlobals, config, appName, sandboxRequire } = this;
 
     function fastbootConfig(key) {
       if (!key) {
@@ -89,21 +86,22 @@ class EmberApp {
     }
 
     // add any additional user provided variables or override the default globals in the sandbox
-    let globals = {
-      najax,
-      FastBoot: {
-        require: sandboxRequire,
-        config: fastbootConfig,
-
-        get distPath() {
-          return distPath;
+    let globals = Object.assign(
+      {
+        najax,
+        FastBoot: {
+          require: sandboxRequire,
+          config: fastbootConfig,
+
+          get distPath() {
+            return distPath;
+          },
         },
       },
-    };
-
-    globals = Object.assign(globals, sandboxGlobals);
+      sandboxGlobals
+    );
 
-    return new sandboxClass({ globals });
+    return new SandboxClass(globals);
   }
 
   /**
@@ -185,8 +183,7 @@ class EmberApp {
    * Loads the app and vendor files in the sandbox (Node vm).
    *
    */
-  loadAppFiles() {
-    let sandbox = this.sandbox;
+  loadAppFiles(sandbox) {
     let appFilePaths = this.appFilePaths;
     let vendorFilePaths = this.vendorFilePaths;
 
@@ -215,9 +212,7 @@ class EmberApp {
    * Create the ember application in the sandbox.
    *
    */
-  createEmberApp() {
-    let sandbox = this.sandbox;
-
+   createEmberApp(sandbox) {
     // Retrieve the application factory from within the sandbox
     let AppFactory = sandbox.run(function(ctx) {
       return ctx.require('~fastboot/app-factory');
@@ -234,30 +229,13 @@ class EmberApp {
     return AppFactory['default']();
   }
 
-  /**
-   * @private
-   *
-   * Initializes the sandbox by evaluating the Ember app's JavaScript
-   * code, then retrieves the application factory from the sandbox and creates a new
-   * `Ember.Application`.
-   *
-   * @returns {Ember.Application} the Ember application from the sandbox
-   */
-  retrieveSandboxedApp() {
-    this.loadAppFiles();
-
-    return this.createEmberApp();
-  }
-
   /**
    * Destroys the app and its sandbox.
    */
   destroy() {
     if (this.app) {
       this.app.destroy();
     }
-
-    this.sandbox = null;
   }
 
   /**
@@ -267,11 +245,15 @@ class EmberApp {
    *
    * @returns {Promise<Ember.ApplicationInstance>} instance
    */
-  buildAppInstance() {
-    return this.app.boot().then(function(app) {
-      debug('building instance');
-      return app.buildInstance();
-    });
+  async buildAppInstance() {
+    let sandbox = this.buildSandbox();
+
+    this.loadAppFiles(sandbox);
+
+    let app = await this.createEmberApp(sandbox).boot();
+
+    debug('building instance');
+    return app.buildInstance();
   }
 
   /**
@@ -292,20 +274,15 @@ class EmberApp {
    * @param {Object} result
    * @return {Promise<instance>} instance
    */
-  visitRoute(path, fastbootInfo, bootOptions, result) {
-    let instance;
+  async visitRoute(path, fastbootInfo, bootOptions, result) {
+    let instance = await this.buildAppInstance();
 
-    return this.buildAppInstance()
-      .then(appInstance => {
-        instance = appInstance;
-        result.instance = instance;
-        registerFastBootInfo(fastbootInfo, instance);
+    result.instance = instance;
+    registerFastBootInfo(fastbootInfo, instance);
 
-        return instance.boot(bootOptions);
-      })
-      .then(() => instance.visit(path, bootOptions))
-      .then(() => fastbootInfo.deferredPromise)
-      .then(() => instance);
+    await instance.boot(bootOptions);
+    await instance.visit(path, bootOptions);
+    await fastbootInfo.deferredPromise;
   }
 
   /**
@@ -345,13 +322,9 @@ class EmberApp {
     });
 
     let doc = bootOptions.document;
+    let result = new Result(doc, html, fastbootInfo);
 
-    let result = new Result({
-      doc: doc,
-      html: html,
-      fastbootInfo: fastbootInfo,
-    });
-
+    // TODO: Use Promise.race here
     let destroyAppInstanceTimer;
     if (destroyAppInstanceInMs > 0) {
       // start a timer to destroy the appInstance forcefully in the given ms.
@@ -455,14 +428,14 @@ class EmberApp {
     });
 
     return {
-      appFiles: appFiles,
-      vendorFiles: vendorFiles,
+      appFiles,
+      vendorFiles,
       htmlFile: path.join(distPath, manifest.htmlFile),
       moduleWhitelist: pkg.fastboot.moduleWhitelist,
       hostWhitelist: pkg.fastboot.hostWhitelist,
-      config: config,
-      appName: appName,
-      schemaVersion: schemaVersion,
+      config,
+      appName,
+      schemaVersion,
     };
   }
 

src/result.js

@@ -12,14 +12,13 @@ const HTML_HEAD_REGEX = /^([\s\S]*<\/head>)([\s\S]*)/;
  * method.
  */
 class Result {
-  constructor(options = {}) {
-    let { doc, html, fastbootInfo } = options;
-
+  constructor(doc, html, fastbootInfo) {
     this._instanceDestroyed = false;
 
     this._doc = doc;
     this._html = html;
     this._fastbootInfo = fastbootInfo;
+    this.instance = undefined;
   }
 
   /**

src/sandbox.js

@@ -4,10 +4,11 @@ const chalk = require('chalk');
 const vm = require('vm');
 
 module.exports = class Sandbox {
-  constructor(options = {}) {
-    this.globals = options.globals;
-    this.sandbox = this.buildSandbox();
-    vm.createContext(this.sandbox);
+  constructor(globals) {
+    this.globals = globals;
+
+    let sandbox = this.buildSandbox();
+    this.context = vm.createContext(sandbox);
   }
 
   buildSandbox() {
@@ -16,18 +17,19 @@ module.exports = class Sandbox {
     let URL = require('url');
     let globals = this.globals;
 
-    let sandbox = {
-      sourceMapSupport,
-      console,
-      setTimeout,
-      clearTimeout,
-      URL,
-
-      // Convince jQuery not to assume it's in a browser
-      module: { exports: {} },
-    };
+    let sandbox = Object.assign(
+      {
+        sourceMapSupport,
+        console,
+        setTimeout,
+        clearTimeout,
+        URL,
 
-    Object.assign(sandbox, globals);
+        // Convince jQuery not to assume it's in a browser
+        module: { exports: {} },
+      },
+      globals
+    );
 
     // Set the global as `window`.
     sandbox.window = sandbox;
@@ -53,10 +55,10 @@ module.exports = class Sandbox {
 
   eval(source, filePath) {
     var fileScript = new vm.Script(source, { filename: filePath });
-    fileScript.runInContext(this.sandbox);
+    fileScript.runInContext(this.context);
   }
 
   run(cb) {
-    return cb.call(this.sandbox, this.sandbox);
+    return cb.call(this.context, this.context);
   }
 };

test/fixtures/custom-sandbox/custom-sandbox.js

@@ -11,18 +11,13 @@ const Sandbox = require('./../../../src/sandbox');
  *
  */
 class CustomSandbox extends Sandbox {
-  constructor(options) {
-    super(options);
-    vm.createContext(this.sandbox);
-  }
-
   /**
    * Evals the file in the sandbox.
    *
    */
   eval(source, filePath) {
     var fileScript = new vm.Script(source, { filename: filePath });
-    fileScript.runInContext(this.sandbox);
+    fileScript.runInContext(this.context);
   }
 
   /**
@@ -32,7 +27,7 @@ class CustomSandbox extends Sandbox {
    * @todo: use this when we create app factory from addon
    */
   run(cb) {
-    return cb.call(this.sandbox, this.sandbox);
+    return cb.call(this.context, this.context);
   }
 
   /**

test/result-test.js

@@ -13,11 +13,7 @@ describe('Result', function() {
     html = `<!-- EMBER_CLI_FASTBOOT_HEAD -->
             <!-- EMBER_CLI_FASTBOOT_BODY -->`;
 
-    result = new Result({
-      doc: doc,
-      html: html,
-      fastbootInfo: new FastBootInfo(req, {}, ['example.com']),
-    });
+    result = new Result(doc, html, new FastBootInfo(req, {}, ['example.com']));
   });
 
   it('constructor', function() {