Merge pull request #125 from ef4/fastboot-manifest-with-tests

Maintain correctness when rewriting fastboot-capable apps
ember-cli · Mar 29, 2018 · 81de916 · 81de916
2 parents 1ad8086 + 631c552
commit 81de916
Show file tree

Hide file tree

Showing 18 changed files with 141 additions and 5 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,4 @@
 language: node_js
 node_js:
-  - "0.12"
-  - "iojs"
+  - "4"
+
diff --git a/index.js b/index.js
@@ -37,5 +37,10 @@ module.exports = {
     this.app = app;
     this.initializeOptions();
   },
-  treeFor: function() {}
-}
+  treeFor: function() {},
+
+  // ember-cli-fastboot uses the presence of this flag to give a
+  // helpful error if you're using an older version of this addon that
+  // doesn't know how to rewrite the fastboot manifest.
+  supportsFastboot: true
+};
diff --git a/lib/asset-rev.js b/lib/asset-rev.js
@@ -1,6 +1,7 @@
 var defaults = require('./default-options');
 var Fingerprint = require('./fingerprint');
 var UseRev = require('broccoli-asset-rewrite');
+var FastbootManifestRewrite = require('./fastboot-manifest-rewrite');
 
 function AssetRev(inputTree, options) {
   if (!(this instanceof AssetRev)) {
@@ -37,7 +38,7 @@ function AssetRev(inputTree, options) {
   var fingerprintTree2 = Fingerprint(assetRewrite, this);
   var assetRewrite2 = UseRev(fingerprintTree2, this);
 
-  return assetRewrite2;
+  return new FastbootManifestRewrite(assetRewrite2, this.assetMap);
 }
 
 module.exports = AssetRev;
diff --git a/lib/fastboot-manifest-rewrite.js b/lib/fastboot-manifest-rewrite.js
@@ -0,0 +1,42 @@
+/* jshint node: true */
+"use strict";
+
+var Filter = require('broccoli-persistent-filter');
+var fs = require('fs');
+
+module.exports = class FastbootManifestRewrite extends Filter {
+  constructor(inputNode, assetMap) {
+    super(inputNode, { annotation: 'broccoli-asset-rev/fastboot-manifest-rewrite'});
+    this.assetMap = assetMap;
+    this.extensions = ['json'];
+  }
+
+  getDestFilePath(relativePath) {
+    if (relativePath === 'package.json') {
+      return relativePath;
+    }
+  }
+
+  processString(contents, relativePath) {
+    var pkg = JSON.parse(contents);
+    if (pkg.fastboot && pkg.fastboot.manifest) {
+      var manifest = pkg.fastboot.manifest;
+      this._process(manifest, 'appFiles', true);
+      this._process(manifest, 'vendorFiles', true);
+      this._process(manifest, 'htmlFile', false);
+      return JSON.stringify(pkg);
+    }
+    return contents;
+  }
+
+  _process(manifest, key, asArray) {
+    if (manifest[key]) {
+      if (asArray) {
+        var assetMap = this.assetMap;
+        manifest[key] = manifest[key].map(function(filename){ return assetMap[filename] || filename; });
+      } else {
+        manifest[key] = this.assetMap[manifest[key]] || manifest[key];
+      }
+    }
+  }
+};
diff --git a/package.json b/package.json
@@ -37,6 +37,7 @@
   "dependencies": {
     "broccoli-asset-rewrite": "^1.1.0",
     "broccoli-filter": "^1.2.2",
+    "broccoli-persistent-filter": "^1.4.3",
     "json-stable-stringify": "^1.0.0",
     "minimatch": "^3.0.4",
     "rsvp": "^3.0.6"

diff --git a/tests/filter-tests.js b/tests/filter-tests.js
@@ -416,4 +416,19 @@ describe('broccoli-asset-rev', function() {
       fs.statSync.restore()
     });
   });
+
+  it('rewrites the fastboot manifest', function(){
+    var sourcePath = 'tests/fixtures/fastboot';
+
+    var node = AssetRev(sourcePath + '/input', {
+      extensions: ['js', 'css', 'png', 'jpg', 'gif', 'map'],
+      replaceExtensions: ['html', 'js', 'css']
+    });
+
+    builder = new broccoli.Builder(node);
+    return builder.build().then(function(graph) {
+      confirmOutput(graph.directory, sourcePath + '/output');
+    });
+  });
+
 });
diff --git a/tests/fixtures/fastboot/input/assets/application.js b/tests/fixtures/fastboot/input/assets/application.js
@@ -0,0 +1,5 @@
+const translations = {
+  en: 'translations/en.json'
+};
+
+console.log('Hello World');
diff --git a/tests/fixtures/fastboot/input/images/icons/favicon.png b/tests/fixtures/fastboot/input/images/icons/favicon.png
diff --git a/tests/fixtures/fastboot/input/images/sample.png b/tests/fixtures/fastboot/input/images/sample.png
diff --git a/tests/fixtures/fastboot/input/index.html b/tests/fixtures/fastboot/input/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en-us">
+<head>
+  <meta charset="utf-8">
+
+  <title>Application</title>
+
+  <link rel="stylesheet" href="/styles.css">
+  <link rel="icon" href="/images/icons/favicon.png">
+</head>
+<body>
+  <script type="text/javascript" src="/assets/application.js"></script>
+  <script type="text/javascript" src=/assets/application.js></script>
+</body>
+</html>
diff --git a/tests/fixtures/fastboot/input/package.json b/tests/fixtures/fastboot/input/package.json
@@ -0,0 +1,9 @@
+{
+  "fastboot": {
+    "manifest": {
+      "appFiles": ["assets/application.js"],
+      "htmlFile": "index.html",
+      "vendorFiles": []
+    }
+  }
+}
diff --git a/tests/fixtures/fastboot/input/styles.css b/tests/fixtures/fastboot/input/styles.css
@@ -0,0 +1,11 @@
+.sample-img {
+  width: 50px;
+  height: 50px;
+  background-image: url(images/sample.png);
+}
+
+.sample-img2 {
+  width: 50px;
+  height: 50px;
+  background-image: url('images/sample.png');
+}
diff --git a/tests/fixtures/fastboot/output/assets/application-b55acd2e0e4c88b3d29cb7fdbc768eb5.js b/tests/fixtures/fastboot/output/assets/application-b55acd2e0e4c88b3d29cb7fdbc768eb5.js
@@ -0,0 +1,5 @@
+const translations = {
+  en: 'translations/en.json'
+};
+
+console.log('Hello World');
diff --git a/...tures/fastboot/output/images/icons/favicon-9243e67fccd0c5e08a3d2c158af6500d.png b/...tures/fastboot/output/images/icons/favicon-9243e67fccd0c5e08a3d2c158af6500d.png
diff --git a/tests/fixtures/fastboot/output/images/sample-1f6b78f1b4667adc7e397f7bf94041ab.png b/tests/fixtures/fastboot/output/images/sample-1f6b78f1b4667adc7e397f7bf94041ab.png
diff --git a/tests/fixtures/fastboot/output/index.html b/tests/fixtures/fastboot/output/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en-us">
+<head>
+  <meta charset="utf-8">
+
+  <title>Application</title>
+
+  <link rel="stylesheet" href="/styles-0315ae5ce5f11670cbdea72c9bea621a.css">
+  <link rel="icon" href="/images/icons/favicon-9243e67fccd0c5e08a3d2c158af6500d.png">
+</head>
+<body>
+  <script type="text/javascript" src="/assets/application-b55acd2e0e4c88b3d29cb7fdbc768eb5.js"></script>
+  <script type="text/javascript" src=/assets/application-b55acd2e0e4c88b3d29cb7fdbc768eb5.js></script>
+</body>
+</html>
diff --git a/tests/fixtures/fastboot/output/package.json b/tests/fixtures/fastboot/output/package.json
@@ -0,0 +1 @@
+{"fastboot":{"manifest":{"appFiles":["assets/application-b55acd2e0e4c88b3d29cb7fdbc768eb5.js"],"htmlFile":"index.html","vendorFiles":[]}}}
diff --git a/tests/fixtures/fastboot/output/styles-0315ae5ce5f11670cbdea72c9bea621a.css b/tests/fixtures/fastboot/output/styles-0315ae5ce5f11670cbdea72c9bea621a.css
@@ -0,0 +1,11 @@
+.sample-img {
+  width: 50px;
+  height: 50px;
+  background-image: url(images/sample-1f6b78f1b4667adc7e397f7bf94041ab.png);
+}
+
+.sample-img2 {
+  width: 50px;
+  height: 50px;
+  background-image: url('images/sample-1f6b78f1b4667adc7e397f7bf94041ab.png');
+}