New html-oriented manifest format for embroider

Author: thoov

package.json

@@ -30,6 +30,7 @@
     "debug": "^4.1.1",
     "resolve": "^1.15.0",
     "simple-dom": "^1.4.0",
+    "simple-html-tokenizer": "^0.5.9",
     "source-map-support": "^0.5.16"
   },
   "devDependencies": {
@@ -42,13 +43,14 @@
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-prettier": "^3.1.2",
     "express": "^4.17.1",
+    "fixturify": "^2.1.0",
     "lerna-changelog": "^1.0.0",
     "mocha": "^7.0.1",
     "prettier": "^1.19.1",
     "release-it": "^12.4.3",
     "release-it-lerna-changelog": "^2.0.0",
     "rimraf": "^3.0.1",
-    "temp": "^0.9.1"
+    "tmp": "^0.2.1"
   },
   "engines": {
     "node": "10.* || >=12"

src/ember-app.js

@@ -57,7 +57,7 @@ class EmberApp {
       this.config = allConfig;
     }
 
-    this.html = fs.readFileSync(config.htmlFile, 'utf8');
+    this.html = config.html || fs.readFileSync(config.htmlFile, 'utf8');
 
     this.sandboxRequire = this.buildWhitelistedRequire(this.moduleWhitelist, distPath);
     let filePaths = [require.resolve('./scripts/install-source-map-support')].concat(
@@ -492,20 +492,30 @@ class EmberApp {
       }
     }
 
-    debug('reading array of app file paths from manifest');
-    let appFiles = manifest.appFiles.map(function(appFile) {
-      return path.join(distPath, appFile);
-    });
+    let appFiles, vendorFiles, htmlFile, html;
 
-    debug('reading array of vendor file paths from manifest');
-    let vendorFiles = manifest.vendorFiles.map(function(vendorFile) {
-      return path.join(distPath, vendorFile);
-    });
+    if (manifest.htmlEntrypoint) {
+      let htmlEntrypoint = require('./html-entrypoint');
+      ({ appFiles, vendorFiles, html } = htmlEntrypoint(distPath, manifest.htmlEntrypoint));
+    } else {
+      debug('reading array of app file paths from manifest');
+      appFiles = manifest.appFiles.map(function(appFile) {
+        return path.join(distPath, appFile);
+      });
+
+      debug('reading array of vendor file paths from manifest');
+      vendorFiles = manifest.vendorFiles.map(function(vendorFile) {
+        return path.join(distPath, vendorFile);
+      });
+
+      htmlFile = path.join(distPath, manifest.htmlFile);
+    }
 
     return {
       appFiles,
       vendorFiles,
-      htmlFile: path.join(distPath, manifest.htmlFile),
+      htmlFile,
+      html,
       moduleWhitelist: pkg.fastboot.moduleWhitelist,
       hostWhitelist: pkg.fastboot.hostWhitelist,
       config,

src/html-entrypoint.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const { tokenize } = require('simple-html-tokenizer');
+const fs = require('fs');
+const path = require('path');
+const pattern = /<fastboot-script[^>]*><\/fastboot-script>\n*/g;
+
+function htmlEntrypoint(distPath, htmlPath) {
+  let html = fs.readFileSync(path.join(distPath, htmlPath), 'utf8');
+
+  // all the scripts we want to run go into appFiles. We don't use vendorFiles.
+  // The distinction doesn't matter here, as long as the scripts all stay in the
+  // right relative order.
+  let appFiles = [];
+
+  for (let token of tokenize(html)) {
+    if (token.type === 'StartTag' && ['script', 'fastboot-script'].includes(token.tagName)) {
+      for (let [name, value] of token.attributes) {
+        if (name === 'src') {
+          appFiles.push(path.join(distPath, value));
+        }
+      }
+    }
+  }
+
+  // we could bring a full html parser & serializer to the party, but the tags
+  // we're trying to strip out here aren't even allowed to have any textContext,
+  // so they're pretty tame.
+  html = html.replace(pattern, '');
+
+  return { html, appFiles, vendorFiles: [] };
+}
+
+module.exports = htmlEntrypoint;

test/fastboot-test.js

@@ -582,4 +582,18 @@ describe('FastBoot', function() {
       usedPrebuiltSandbox: true,
     });
   });
+
+  it('htmlEntrypoint works', function() {
+    var fastboot = new FastBoot({
+      distPath: fixture('html-entrypoint'),
+    });
+
+    return fastboot
+      .visit('/')
+      .then(r => r.html())
+      .then(html => {
+        expect(html).to.match(/Welcome to Ember/);
+        expect(html).to.not.match(/fastboot-script/);
+      });
+  });
 });