Merge pull request #91 from kratiahuja/li-refactor

Refactor Fastboot's visit API to take additional options

Author: rwjblue

package.json

@@ -51,7 +51,6 @@
     "fs-promise": "^0.5.0",
     "mocha": "^2.4.5",
     "mocha-jshint": "^2.3.1",
-    "request-promise": "^2.0.1",
     "temp": "^0.8.3"
   }
 }

src/ember-app.js

@@ -190,20 +190,29 @@ class EmberApp {
    * @param {string} path the URL path to render, like `/photos/1`
    * @param {Object} options
    * @param {string} [options.html] the HTML document to insert the rendered app into
+   * @param {Object} [options.metadata] Per request specific data used in the app.
+   * @param {Boolean} [options.shouldRender] whether the app should do rendering or not. If set to false, it puts the app in routing-only.
+   * @param {Boolean} [options.disableShoebox] whether we should send the API data in the shoebox. If set to false, it will not send the API data used for rendering the app on server side in the index.html.
+   * @param {Integer} [options.destroyAppInstanceInMs] whether to destroy the instance in the given number of ms. This is a failure mechanism to not wedge the Node process (See: https://github.com/ember-fastboot/fastboot/issues/90)
    * @param {ClientRequest}
+   * @param {ClientResponse}
    * @returns {Promise<Result>} result
    */
   visit(path, options) {
     let req = options.request;
     let res = options.response;
     let html = options.html || this.html;
+    let disableShoebox = options.disableShoebox || false;
+    let destroyAppInstanceInMs = options.destroyAppInstanceInMs;
 
-    let bootOptions = buildBootOptions();
+    let shouldRender = (options.shouldRender !== undefined) ? options.shouldRender : true;
+    let bootOptions = buildBootOptions(shouldRender);
     let fastbootInfo = new FastBootInfo(
       req,
       res,
       { hostWhitelist: this.hostWhitelist, metadata: options.metadata }
     );
+
     let doc = bootOptions.document;
 
     let instance;
@@ -214,6 +223,19 @@ class EmberApp {
       fastbootInfo: fastbootInfo
     });
 
+    let destroyAppInstanceTimer;
+    if (parseInt(destroyAppInstanceInMs, 10) > 0) {
+      // start a timer to destroy the appInstance forcefully in the given ms.
+      // This is a failure mechanism so that node process doesn't get wedged if the `visit` never completes.
+      destroyAppInstanceTimer = setTimeout(function() {
+        if (instance && !result.instanceDestroyed) {
+          result.instanceDestroyed = true;
+          result.error = new Error('App instance was forcefully destroyed in ' + destroyAppInstanceInMs + 'ms');
+          instance.destroy();
+        }
+      }, destroyAppInstanceInMs);
+    }
+
     return this.buildAppInstance()
       .then(appInstance => {
         instance = appInstance;
@@ -225,12 +247,22 @@ class EmberApp {
       .then(() => result.instanceBooted = true)
       .then(() => instance.visit(path, bootOptions))
       .then(() => waitForApp(instance))
-      .then(() => createShoebox(doc, fastbootInfo))
+      .then(() => {
+        if (!disableShoebox) {
+          // if shoebox is not disabled, then create the shoebox and send API data
+          createShoebox(doc, fastbootInfo);
+        }
+      })
       .catch(error => result.error = error)
       .then(() => result._finalize())
       .finally(() => {
-        if (instance) {
+        if (instance && !result.instanceDestroyed) {
+          result.instanceDestroyed = true;
           instance.destroy();
+
+          if (destroyAppInstanceTimer) {
+            clearTimeout(destroyAppInstanceTimer);
+          }
         }
       });
   }
@@ -274,14 +306,15 @@ class EmberApp {
  * Builds an object with the options required to boot an ApplicationInstance in
  * FastBoot mode.
  */
-function buildBootOptions() {
+function buildBootOptions(shouldRender) {
   let doc = new SimpleDOM.Document();
   let rootElement = doc.body;
 
   return {
     isBrowser: false,
     document: doc,
-    rootElement: rootElement
+    rootElement,
+    shouldRender
   };
 }
 

src/fastboot-info.js

@@ -6,11 +6,17 @@ var FastBootResponse = require('./fastboot-response');
  * A class that encapsulates information about the
  * current HTTP request from FastBoot. This is injected
  * on to the FastBoot service.
+ *
+ * @param {ClientRequest} the incoming request object
+ * @param {ClientResponse} the response object
+ * @param {Object} additional options passed to fastboot info
+ * @param {Array} [options.hostWhitelist] expected hosts in your application
+ * @param {Object} [options.metaData] per request meta data
  */
-function FastBootInfo(request, response, options = {}) {
-  const { hostWhitelist, metadata } = options;
+function FastBootInfo(request, response, options) {
 
   this.deferredPromise = RSVP.resolve();
+  let { hostWhitelist, metadata } = options;
   if (request) {
     this.request = new FastBootRequest(request, hostWhitelist);
   }

src/index.js

@@ -56,6 +56,10 @@ class FastBoot {
    * @param {Object} options
    * @param {Boolean} [options.resilient] whether to reject the returned promise if there is an error during rendering. Overrides the instance's `resilient` setting
    * @param {string} [options.html] the HTML document to insert the rendered app into. Uses the built app's index.html by default.
+   * @param {Object} [options.metadata] per request meta data that need to be exposed in the app.
+   * @param {Boolean} [options.shouldRender] whether the app should do rendering or not. If set to false, it puts the app in routing-only.
+   * @param {Boolean} [options.disableShoebox] whether we should send the API data in the shoebox. If set to false, it will not send the API data used for rendering the app on server side in the index.html.
+   * @param {Integer} [options.destroyAppInstanceInMs] whether to destroy the instance in the given number of ms. This is a failure mechanism to not wedge the Node process (See: https://github.com/ember-fastboot/fastboot/issues/90)
    * @returns {Promise<Result>} result
    */
   visit(path, options) {

src/result.js

@@ -11,6 +11,7 @@ const HTMLSerializer = new SimpleDOM.HTMLSerializer(SimpleDOM.voidMap);
 class Result {
   constructor(options) {
     this.instanceBooted = false;
+    this.instanceDestroyed = false;
     this._doc = options.doc;
     this._html = options.html;
     this._fastbootInfo = options.fastbootInfo;
@@ -45,6 +46,18 @@ class Result {
     return Promise.resolve(insertIntoIndexHTML(this._html, this._head, this._body));
   }
 
+  /**
+   * Returns the serialized representation of DOM HEAD and DOM BODY
+   *
+   * @returns {Object} serialized version of DOM
+   */
+  domContents() {
+    return {
+      head: this._head,
+      body: this._body
+    };
+  }
+
   /**
    * @private
    *

test/fastboot-info-test.js

@@ -9,7 +9,10 @@ describe("FastBootInfo", function() {
   var response;
   var request;
   var fastbootInfo;
-  var metadata = { foo: 'bar' };
+  var metadata = {
+    'foo': 'bar',
+    'baz': 'apple'
+  };
 
   beforeEach(function () {
     response = {};
@@ -34,6 +37,7 @@ describe("FastBootInfo", function() {
     expect(fastbootInfo.response).to.be.an.instanceOf(FastBootResponse);
   });
 
+
   it("has metadata", function() {
     expect(fastbootInfo.metadata).to.deep.equal(metadata);
   });

test/fastboot-shoebox-test.js

@@ -3,8 +3,7 @@
 const expect         = require('chai').expect;
 const fs             = require('fs');
 const path           = require('path');
-const request        = require('request-promise');
-const TestHTTPServer = require('./helpers/test-http-server');
+const fixture        = require('./helpers/fixture-path');
 const alchemistRequire = require('broccoli-module-alchemist/require');
 const FastBoot       = alchemistRequire('index');
 
@@ -28,8 +27,44 @@ describe("FastBootShoebox", function() {
       });
   });
 
-});
+  it("can render the escaped shoebox HTML with shouldRender set to false", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('shoebox')
+    });
 
-function fixture(fixtureName) {
-  return path.join(__dirname, '/fixtures/', fixtureName);
-}
+    return fastboot.visit('/', {
+      shouldRender: false
+    })
+      .then(r => r.html())
+      .then(html => {
+        expect(html).to.match(/<script type="fastboot\/shoebox" id="shoebox-key1">{"foo":"bar"}<\/script>/);
+        expect(html).to.match(/<script type="fastboot\/shoebox" id="shoebox-key2">{"zip":"zap"}<\/script>/);
+
+        // Special characters are JSON encoded, most notably the </script sequence.
+        expect(html).to.include('<script type="fastboot/shoebox" id="shoebox-key4">{"nastyScriptCase":"\\u003cscript\\u003ealert(\'owned\');\\u003c/script\\u003e\\u003c/script\\u003e\\u003c/script\\u003e"}</script>');
+
+        expect(html).to.include('<script type="fastboot/shoebox" id="shoebox-key5">{"otherUnicodeChars":"\\u0026\\u0026\\u003e\\u003e\\u003c\\u003c\\u2028\\u2028\\u2029\\u2029"}</script>');
+      });
+  });
+
+  it("cannot render the escaped shoebox HTML when disableShoebox is set to true", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('shoebox')
+    });
+
+    return fastboot.visit('/', {
+      disableShoebox: true
+    })
+      .then(r => r.html())
+      .then(html => {
+        expect(html).to.not.match(/<script type="fastboot\/shoebox" id="shoebox-key1">{"foo":"bar"}<\/script>/);
+        expect(html).to.not.match(/<script type="fastboot\/shoebox" id="shoebox-key2">{"zip":"zap"}<\/script>/);
+
+        // Special characters are JSON encoded, most notably the </script sequence.
+        expect(html).to.not.include('<script type="fastboot/shoebox" id="shoebox-key4">{"nastyScriptCase":"\\u003cscript\\u003ealert(\'owned\');\\u003c/script\\u003e\\u003c/script\\u003e\\u003c/script\\u003e"}</script>');
+
+        expect(html).to.not.include('<script type="fastboot/shoebox" id="shoebox-key5">{"otherUnicodeChars":"\\u0026\\u0026\\u003e\\u003e\\u003c\\u003c\\u2028\\u2028\\u2029\\u2029"}</script>');
+      });
+  });
+
+});

test/fastboot-test.js

@@ -3,8 +3,7 @@
 const expect           = require('chai').expect;
 const fs               = require('fs');
 const path             = require('path');
-const request          = require('request-promise');
-const TestHTTPServer   = require('./helpers/test-http-server');
+const fixture          = require('./helpers/fixture-path');
 const alchemistRequire = require('broccoli-module-alchemist/require');
 const FastBoot         = alchemistRequire('index');
 
@@ -51,6 +50,47 @@ describe("FastBoot", function() {
       });
   });
 
+  it("cannot not render app HTML with shouldRender set as false", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('basic-app')
+    });
+
+    return fastboot.visit('/', {
+      shouldRender: false
+    })
+      .then(r => r.html())
+      .then(html => {
+        expect(html).to.not.match(/Welcome to Ember/);
+      });
+  });
+
+  it("can serialize the head and body", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('basic-app')
+    });
+
+    return fastboot.visit('/')
+      .then((r) => {
+        let contents = r.domContents();
+
+        expect(contents.head).to.equal('');
+        expect(contents.body).to.match(/Welcome to Ember/);
+      });
+  });
+
+  it("can forcefully destroy the app instance using destroyAppInstanceInMs", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('basic-app')
+    });
+
+    return fastboot.visit('/', {
+      destroyAppInstanceInMs: 5
+    })
+      .catch((e) => {
+        expect(e.message).to.equal('App instance was forcefully destroyed in 5ms');
+      });
+  });
+
   it("rejects the promise if an error occurs", function() {
     var fastboot = new FastBoot({
       distPath: fixture('rejected-promise')
@@ -59,6 +99,17 @@ describe("FastBoot", function() {
     return expect(fastboot.visit('/')).to.be.rejected;
   });
 
+  it("catches the error if an error occurs", function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('rejected-promise')
+    });
+
+    fastboot.visit('/')
+      .catch(function(err) {
+        return expect(err).to.be.not.null;
+      });
+  });
+
   it("renders an empty page if the resilient flag is set", function() {
     var fastboot = new FastBoot({
       distPath: fixture('rejected-promise'),
@@ -188,7 +239,3 @@ describe("FastBoot", function() {
   });
 
 });
-
-function fixture(fixtureName) {
-  return path.join(__dirname, '/fixtures/', fixtureName);
-}