Merge pull request #114 from kratiahuja/schema-versioning

Introduce schema version in FastBoot

Author: rwjblue

.gitignore

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

.travis.yml

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

src/ember-app.js

@@ -3,6 +3,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 +12,7 @@ const debug = require('debug')('fastboot:ember-app');
 
 const FastBootInfo = require('./fastboot-info');
 const Result = require('./result');
+const FastBootSchemaVersions = require('./fastboot-schema-versions');
 
 /**
  * @private
@@ -344,39 +346,44 @@ 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);
     }
 
+    var appFiles = [];
+    debug("reading array of app file paths from manifest");
+    manifest.appFiles.forEach(function(appFile) {
+      appFiles.push(path.join(distPath, appFile));
+    });
+
+    var vendorFiles = [];
+    debug("reading array of vendor file paths from manifest");
+    manifest.vendorFiles.forEach(function(vendorFile) {
+      vendorFiles.push(path.join(distPath, vendorFile));
+    });
+
     return {
       appFiles:  appFiles,
       vendorFiles: vendorFiles,
@@ -386,6 +393,16 @@ class EmberApp {
       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;
+  }
 }
 
 /*

src/fastboot-schema-versions.js

@@ -0,0 +1,15 @@
+/**
+ * Map of maintaining schema version history so that transformation of the manifest
+ * file can be performed correctly to maintain backward compatibility of older
+ * schema version.
+ *
+ * Note: `latest` schema version should always be updated (and transformation
+ * should be added in fastboot lib) everytime fastboot addon schema version is bumped.
+ */
+const FastBootSchemaVersions = {
+  'latest': 2, // latest schema version supported by fastboot library
+  'base': 1, // first schema version supported by fastboot library
+  'manifestFileArrays': 2 // schema version when app and vendor in manifest supported an array of files
+};
+
+module.exports = FastBootSchemaVersions;

test/fastboot-test.js

@@ -28,6 +28,17 @@ describe("FastBoot", function() {
     expect(fn).to.throw(/Couldn't find (.+)\/fixtures\/no-package-json/);
   });
 
+  it('throws an error when manifest schema version is higher than fastboot schema version', function() {
+    var distPath = fixture('higher-schema-version');
+    var fn = function() {
+      return new FastBoot({
+        distPath: distPath
+      });
+    };
+
+    expect(fn).to.throw(/An incompatible version between `ember-cli-fastboot` and `fastboot` was found/);
+  });
+
   it("doesn't throw an exception if a package.json is provided", function() {
     var distPath = fixture('empty-package-json');
     var fn = function() {

test/fixtures/app-with-console-log/package.json

@@ -2,6 +2,7 @@
   "dependencies": {},
   "fastboot": {
     "moduleWhitelist": [],
+    "schemaVersion": 1,
     "manifest": {
       "appFile": "assets/fastboot-test.js",
       "htmlFile": "index.html",

test/fixtures/basic-app/package.json

@@ -2,6 +2,7 @@
   "dependencies": {},
   "fastboot": {
     "moduleWhitelist": [],
+    "schemaVersion": 1,
     "manifest": {
       "appFile": "assets/fastboot-test.js",
       "htmlFile": "index.html",

test/fixtures/boot-time-failing-app/package.json

@@ -2,6 +2,7 @@
   "dependencies": {},
   "fastboot": {
     "moduleWhitelist": [],
+    "schemaVersion": 1,
     "manifest": {
       "appFile": "assets/fastboot-test.js",
       "htmlFile": "index.html",

test/fixtures/config-app/package.json

@@ -2,6 +2,7 @@
   "dependencies": {},
   "fastboot": {
     "moduleWhitelist": [],
+    "schemaVersion": 1,
     "manifest": {
       "appFile": "assets/fastboot-test.js",
       "htmlFile": "index.html",

test/fixtures/config-not-in-meta-app/package.json

@@ -2,6 +2,7 @@
   "dependencies": {},
   "fastboot": {
     "moduleWhitelist": [],
+    "schemaVersion": 1,
     "manifest": {
       "appFile": "assets/fastboot-test.js",
       "htmlFile": "index.html",