Merge remote-tracking branch 'upstream/master'

Author: martletandco

.gitignore

@@ -2,3 +2,4 @@
 npm-debug.log
 tmp*
 dist/
+yarn.lock

.travis.yml

@@ -2,7 +2,7 @@ language: node_js
 node_js:
   - "stable"
   - "4"
-  - "0.12"
+  - "6"
 
 env:
   - CXX=g++-4.8 WORKER_COUNT=2

Brocfile.js

@@ -1,5 +1,9 @@
 # FastBoot Changelog
 
+### 1.0.0-rc.3
+
+* Remove Node 0.12 support.
+
 ### 1.0.0-rc.2
 
 * Set the entry point to the built cjs

CHANGELOG.md

@@ -1,5 +1,6 @@
 # FastBoot
 
+[![npm version](https://badge.fury.io/js/fastboot.svg)](https://badge.fury.io/js/fastboot)
 [![Build Status](https://travis-ci.org/ember-fastboot/fastboot.svg?branch=master)](https://travis-ci.org/ember-fastboot/ember-fastboot-server)
 
 FastBoot is a library for rendering Ember.js applications in Node.js.

README.md

@@ -1,21 +1,20 @@
 {
   "name": "fastboot",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.7",
   "description": "Library for rendering Ember apps in node.js",
-  "main": "dist/cjs/index.js",
+  "main": "src/index.js",
   "scripts": {
     "test": "mocha",
-    "prebuild": "rimraf dist",
-    "build": "broccoli build dist",
     "preversion": "npm test",
-    "prepublish": "npm run build",
-    "postinstall": "broccoli-module-alchemist-install",
     "postversion": "git push origin master --tags"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ember-fastboot/fastboot.git"
   },
+  "engines": {
+    "node": ">= 4.0.0"
+  },
   "keywords": [
     "ember",
     "fastboot"
@@ -27,26 +26,19 @@
   },
   "homepage": "https://github.com/ember-fastboot/fastboot#readme",
   "dependencies": {
-    "broccoli-module-alchemist-install": "^0.1.1",
     "chalk": "^0.5.1",
     "cookie": "^0.2.3",
     "debug": "^2.1.0",
     "exists-sync": "0.0.3",
     "express": "^4.13.3",
     "express-cluster": "0.0.4",
-    "glob": "^4.0.5",
     "minimist": "^1.2.0",
-    "najax": "^1.0.0",
+    "najax": "^1.0.2",
     "rsvp": "^3.0.16",
     "simple-dom": "^0.3.0",
     "source-map-support": "^0.4.0"
   },
   "devDependencies": {
-    "babel-core": "^6.10.4",
-    "babel-preset-es2015": "^6.9.0",
-    "broccoli": "^0.16.9",
-    "broccoli-cli": "^1.0.0",
-    "broccoli-module-alchemist": "^0.2.0",
     "chai": "^3.5.0",
     "chai-as-promised": "^5.2.0",
     "fs-promise": "^0.5.0",

package.json

@@ -2,7 +2,7 @@
 
 const fs = require('fs');
 const path = require('path');
-const RSVP = require('rsvp');
+const chalk = require('chalk');
 
 const najax = require('najax');
 const SimpleDOM = require('simple-dom');
@@ -11,6 +11,7 @@ const debug = require('debug')('fastboot:ember-app');
 
 const FastBootInfo = require('./fastboot-info');
 const Result = require('./result');
+const FastBootSchemaVersions = require('./fastboot-schema-versions');
 
 /**
  * @private
@@ -58,7 +59,6 @@ class EmberApp {
    * @param {Object} [sandboxGlobals={}] any additional variables to expose in the sandbox or override existing in the sandbox
    */
   buildSandbox(distPath, sandboxClass, sandboxGlobals) {
-    let Sandbox = sandboxClass || require('./vm-sandbox');
     let sandboxRequire = this.buildWhitelistedRequire(this.moduleWhitelist, distPath);
     let config = this.appConfig;
     function appConfig() {
@@ -67,21 +67,16 @@ class EmberApp {
 
     // add any additional user provided variables or override the default globals in the sandbox
     let globals = {
-      najax: 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
-    });
+    globals = Object.assign(globals, sandboxGlobals);
+
+    return new sandboxClass({ globals });
   }
 
   /**
@@ -220,6 +215,10 @@ class EmberApp {
    * the app instance and then visits the given route and destroys the app instance
    * when the route is finished its render cycle.
    *
+   * Ember apps can manually defer rendering in FastBoot mode if they're waiting
+   * on something async the router doesn't know about. This function fetches
+   * that promise for deferred rendering from the app.
+   *
    * @param {string} path the URL path to render, like `/photos/1`
    * @param {Object} fastbootInfo An object holding per request info
    * @param {Object} bootOptions An object containing the boot options that are used by
@@ -238,18 +237,15 @@ class EmberApp {
 
         return instance.boot(bootOptions);
       })
-      .then(() => result.instanceBooted = true)
       .then(() => instance.visit(path, bootOptions))
-      .then(() => waitForApp(instance))
-      .then(() => {
-        return instance;
-      });
+      .then(() => fastbootInfo.deferredPromise)
+      .then(() => instance);
   }
 
   /**
    * Creates a new application instance and renders the instance at a specific
    * URL, returning a promise that resolves to a {@link Result}. The `Result`
-   * givesg you access to the rendered HTML as well as metadata about the
+   * gives you access to the rendered HTML as well as metadata about the
    * request such as the HTTP status code.
    *
    * If this call to `visit()` is to service an incoming HTTP request, you may
@@ -273,7 +269,7 @@ class EmberApp {
     let res = options.response;
     let html = options.html || this.html;
     let disableShoebox = options.disableShoebox || false;
-    let destroyAppInstanceInMs = options.destroyAppInstanceInMs;
+    let destroyAppInstanceInMs = parseInt(options.destroyAppInstanceInMs, 10);
 
     let shouldRender = (options.shouldRender !== undefined) ? options.shouldRender : true;
     let bootOptions = buildBootOptions(shouldRender);
@@ -292,23 +288,17 @@ class EmberApp {
     });
 
     let destroyAppInstanceTimer;
-    if (parseInt(destroyAppInstanceInMs, 10) > 0) {
+    if (destroyAppInstanceInMs > 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;
+        if (result._destroyAppInstance()) {
           result.error = new Error('App instance was forcefully destroyed in ' + destroyAppInstanceInMs + 'ms');
-          instance.destroy();
         }
       }, destroyAppInstanceInMs);
     }
 
-    let instance;
     return this.visitRoute(path, fastbootInfo, bootOptions, result)
-      .then(appInstance => {
-        instance = appInstance;
-      })
       .then(() => {
         if (!disableShoebox) {
           // if shoebox is not disabled, then create the shoebox and send API data
@@ -318,10 +308,7 @@ class EmberApp {
       .catch(error => result.error = error)
       .then(() => result._finalize())
       .finally(() => {
-        if (instance && !result.instanceDestroyed) {
-          result.instanceDestroyed = true;
-          instance.destroy();
-
+        if (result._destroyAppInstance()) {
           if (destroyAppInstanceTimer) {
             clearTimeout(destroyAppInstanceTimer);
           }
@@ -344,48 +331,61 @@ class EmberApp {
     }
 
     let manifest;
+    let schemaVersion;
     let pkg;
 
     try {
       pkg = JSON.parse(file);
       manifest = pkg.fastboot.manifest;
+      schemaVersion = pkg.fastboot.schemaVersion;
     } catch (e) {
       throw new Error(`${pkgPath} was malformed or did not contain a manifest. Ensure that you have a compatible version of ember-cli-fastboot.`);
     }
 
-    var appFiles = [];
-    if (manifest.appFiles) {
-      debug("reading array of app file paths from manifest");
-      manifest.appFiles.forEach(function(appFile) {
-        appFiles.push(path.join(distPath, appFile));
-      });
-    } else if (manifest.appFile) {
-      // TODO : remove after Fastboot 1.0
-      debug("reading app file path from manifest");
-      appFiles = [path.join(distPath, manifest.appFile)];
+    const currentSchemaVersion = FastBootSchemaVersions.latest;
+    // set schema version to 1 if not defined
+    schemaVersion = schemaVersion || FastBootSchemaVersions.base;
+    debug('Current schemaVersion from `ember-cli-fastboot` is %s while latest schema version is %s', (schemaVersion, currentSchemaVersion));
+
+    if (schemaVersion > currentSchemaVersion) {
+      let errorMsg = chalk.bold.red('An incompatible version between `ember-cli-fastboot` and `fastboot` was found. Please update the version of fastboot library that is compatible with ember-cli-fastboot.');
+      throw new Error(errorMsg);
     }
 
-    var vendorFiles = [];
-    if (manifest.vendorFiles) {
-      debug("reading array of vendor file paths from manifest");
-      manifest.vendorFiles.forEach(function(vendorFile) {
-        vendorFiles.push(path.join(distPath, vendorFile));
-      });
-    } else if (manifest.vendorFile) {
-      // TODO : remove after Fastboot 1.0
-      debug("reading vendor file path from manifest");
-      vendorFiles = [path.join(distPath, manifest.vendorFile)];
+    if (schemaVersion < FastBootSchemaVersions.manifestFileArrays) {
+      // transform app and vendor file to array of files
+      manifest = this.transformManifestFiles(manifest);
     }
 
+    debug("reading array of app file paths from manifest");
+    var appFiles = manifest.appFiles.map(function(appFile) {
+      return path.join(distPath, appFile);
+    });
+
+    debug("reading array of vendor file paths from manifest");
+    var vendorFiles = manifest.vendorFiles.map(function(vendorFile) {
+      return path.join(distPath, vendorFile);
+    });
+
     return {
-      appFiles:  appFiles,
+      appFiles: appFiles,
       vendorFiles: vendorFiles,
       htmlFile: path.join(distPath, manifest.htmlFile),
       moduleWhitelist: pkg.fastboot.moduleWhitelist,
       hostWhitelist: pkg.fastboot.hostWhitelist,
       appConfig: pkg.fastboot.appConfig
     };
   }
+
+  /**
+   * Function to transform the manifest app and vendor files to an array.
+   */
+  transformManifestFiles(manifest) {
+    manifest.appFiles = [manifest.appFile];
+    manifest.vendorFiles = [manifest.vendorFile];
+
+    return manifest;
+  }
 }
 
 /*
@@ -404,19 +404,6 @@ function buildBootOptions(shouldRender) {
   };
 }
 
-/*
- * Ember apps can manually defer rendering in FastBoot mode if they're waiting
- * on something async the router doesn't know about.  This function fetches
- * that promise for deferred rendering from the app.
- */
-function waitForApp(instance) {
-  let fastbootInfo = instance.lookup('info:-fastboot');
-
-  return fastbootInfo.deferredPromise.then(function() {
-    return instance;
-  });
-}
-
 /*
  * Writes the shoebox into the DOM for the browser rendered app to consume.
  * Uses a script tag with custom type so that the browser will treat as plain
@@ -425,13 +412,14 @@ function waitForApp(instance) {
  * parse the specific item at the time it is needed instead of everything
  * all at once.
  */
+const hasOwnProperty = Object.prototype.hasOwnProperty; // jshint ignore:line
+
 function createShoebox(doc, fastbootInfo) {
   let shoebox = fastbootInfo.shoebox;
-  if (!shoebox) { return RSVP.resolve(); }
+  if (!shoebox) { return; }
 
   for (let key in shoebox) {
-    if (!shoebox.hasOwnProperty(key)) { continue; }
-
+    if (!hasOwnProperty.call(shoebox, key)) { continue; } // TODO: remove this later #144, ember-fastboot/ember-cli-fastboot/pull/417
     let value = shoebox[key];
     let textValue = JSON.stringify(value);
     textValue = escapeJSONString(textValue);
@@ -444,8 +432,6 @@ function createShoebox(doc, fastbootInfo) {
     scriptEl.appendChild(scriptText);
     doc.body.appendChild(scriptEl);
   }
-
-  return RSVP.resolve();
 }
 
 const JSON_ESCAPE = {