Fix fastboot-config test and add test for basepagewriter

Author: xg-wang

packages/ember-cli-fastboot/index.js

@@ -11,7 +11,7 @@ const chalk = require('chalk');
 
 const fastbootAppBoot = require('./lib/utilities/fastboot-app-boot');
 const FastBootConfig = require('./lib/broccoli/fastboot-config');
-const HTMLWriter = require('./lib/broccoli/html-writer');
+const BasePageWriter = require('./lib/broccoli/html-writer');
 const fastbootAppFactoryModule = require('./lib/utilities/fastboot-app-factory-module');
 const migrateInitializers = require('./lib/build-utilities/migrate-initializers');
 const SilentError = require('silent-error');
@@ -61,7 +61,9 @@ module.exports = {
    * See: https://ember-cli.com/user-guide/#integration
    */
   included(app) {
-    let assetRev = this.project.addons.find(addon => addon.name === 'broccoli-asset-rev');
+    let assetRev = this.project.addons.find(
+      (addon) => addon.name === 'broccoli-asset-rev'
+    );
     if (assetRev && !assetRev.supportsFastboot) {
       throw new SilentError(
         'This version of ember-cli-fastboot requires a newer version of broccoli-asset-rev'
@@ -110,7 +112,10 @@ module.exports = {
     }
 
     if (type === 'app-boot') {
-      return fastbootAppBoot(config.modulePrefix, JSON.stringify(config.APP || {}));
+      return fastbootAppBoot(
+        config.modulePrefix,
+        JSON.stringify(config.APP || {})
+      );
     }
 
     // if the fastboot addon is installed, we overwrite the config-module so that the config can be read
@@ -135,15 +140,19 @@ module.exports = {
 
     // check the ember version and conditionally patch the DOM api
     if (this._getEmberVersion().lt('2.10.0-alpha.1')) {
-      fastbootHtmlBarsTree = this.treeGenerator(path.resolve(__dirname, 'fastboot-app-lt-2-9'));
-      return tree ? new MergeTrees([tree, fastbootHtmlBarsTree]) : fastbootHtmlBarsTree;
+      fastbootHtmlBarsTree = this.treeGenerator(
+        path.resolve(__dirname, 'fastboot-app-lt-2-9')
+      );
+      return tree
+        ? new MergeTrees([tree, fastbootHtmlBarsTree])
+        : fastbootHtmlBarsTree;
     }
 
     return tree;
   },
 
   _processAddons(addons, fastbootTrees) {
-    addons.forEach(addon => {
+    addons.forEach((addon) => {
       this._processAddon(addon, fastbootTrees);
     });
   },
@@ -183,7 +192,10 @@ module.exports = {
     // check the parent containing the fastboot directory
     const projectFastbootPath = path.join(this.project.root, 'fastboot');
     // ignore the project's fastboot folder if we are an addon, as that is already handled above
-    if (!this.project.isEmberCLIAddon() && this.existsSync(projectFastbootPath)) {
+    if (
+      !this.project.isEmberCLIAddon() &&
+      this.existsSync(projectFastbootPath)
+    ) {
       let fastbootTree = this.treeGenerator(projectFastbootPath);
       fastbootTrees.push(fastbootTree);
     }
@@ -196,17 +208,28 @@ module.exports = {
     let funneledFastbootTrees = new Funnel(mergedFastBootTree, {
       destDir: appName,
     });
-    const processExtraTree = p.preprocessJs(funneledFastbootTrees, '/', this._name, {
-      registry: this._appRegistry,
-    });
+    const processExtraTree = p.preprocessJs(
+      funneledFastbootTrees,
+      '/',
+      this._name,
+      {
+        registry: this._appRegistry,
+      }
+    );
 
     // FastBoot app factory module
     const writeFile = require('broccoli-file-creator');
-    let appFactoryModuleTree = writeFile('app-factory.js', fastbootAppFactoryModule(appName));
-
-    let newProcessExtraTree = new MergeTrees([processExtraTree, appFactoryModuleTree], {
-      overwrite: true,
-    });
+    let appFactoryModuleTree = writeFile(
+      'app-factory.js',
+      fastbootAppFactoryModule(appName)
+    );
+
+    let newProcessExtraTree = new MergeTrees(
+      [processExtraTree, appFactoryModuleTree],
+      {
+        overwrite: true,
+      }
+    );
 
     function stripLeadingSlash(filePath) {
       return filePath.replace(/^\//, '');
@@ -231,7 +254,8 @@ module.exports = {
 
     let newTree = new MergeTrees(trees);
 
-    let fastbootConfigTree = (this._fastbootConfigTree = this._buildFastbootConfigTree(newTree));
+    let fastbootConfigTree = (this._fastbootConfigTree =
+      this._buildFastbootConfigTree(newTree));
 
     // Merge the package.json with the existing tree
     return new MergeTrees([newTree, fastbootConfigTree], { overwrite: true });
@@ -296,15 +320,23 @@ module.exports = {
 
   _buildFastbootConfigTree(tree) {
     let appConfig = this._getHostAppConfig();
-    let fastbootAppConfig = appConfig.fastboot;
 
     return new FastBootConfig(tree, {
       project: this.project,
-      name: this.app.name,
       outputPaths: this.app.options.outputPaths,
       ui: this.ui,
-      fastbootAppConfig: fastbootAppConfig,
-      appConfig: appConfig,
+      appConfig,
+    });
+  },
+
+  _buildHTMLWriter(tree) {
+    let appConfig = this._getHostAppConfig();
+
+    return new BasePageWriter(tree, {
+      project: this.project,
+      appConfig,
+      appJsPath: this.app.options.outputPaths.app.js,
+      outputPaths: this.app.options.outputPaths,
     });
   },
 
@@ -314,16 +346,7 @@ module.exports = {
   postprocessTree(type, tree) {
     this._super(...arguments);
     if (type === 'all') {
-      let { fastbootConfig, appName, manifest } = this._fastbootConfigTree;
-      debugger;
-      let fastbootHTMLTree = new HTMLWriter(tree, {
-        annotation: 'FastBoot HTML Writer',
-        fastbootConfig,
-        appName,
-        manifest,
-        appJsPath: this.app.options.outputPaths.app.js,
-        outputPaths: this.app.options.outputPaths,
-      });
+      let fastbootHTMLTree = this._buildHTMLWriter(tree);
 
       // Merge the package.json with the existing tree
       return new MergeTrees([tree, fastbootHTMLTree], { overwrite: true });
@@ -342,8 +365,11 @@ module.exports = {
 
       app.use((req, resp, next) => {
         const fastbootQueryParam =
-          req.query.hasOwnProperty('fastboot') && req.query.fastboot === 'false' ? false : true;
-        const enableFastBootServe = !process.env.FASTBOOT_DISABLED && fastbootQueryParam;
+          req.query.hasOwnProperty('fastboot') && req.query.fastboot === 'false'
+            ? false
+            : true;
+        const enableFastBootServe =
+          !process.env.FASTBOOT_DISABLED && fastbootQueryParam;
 
         if (req.serveUrl && enableFastBootServe) {
           // if it is a base page request, then have fastboot serve the base page
@@ -410,7 +436,10 @@ module.exports = {
    * TODO Allow add-ons to provide own options and merge them with the application's options.
    */
   _fastbootOptionsFor(environment, project) {
-    const configPath = path.join(path.dirname(project.configPath()), 'fastboot.js');
+    const configPath = path.join(
+      path.dirname(project.configPath()),
+      'fastboot.js'
+    );
 
     if (fs.existsSync(configPath)) {
       return require(configPath)(environment);

packages/ember-cli-fastboot/lib/broccoli/fastboot-config.js

@@ -4,42 +4,35 @@
 const fs = require('fs');
 const fmt = require('util').format;
 const uniq = require('ember-cli-lodash-subset').uniq;
-const merge = require('ember-cli-lodash-subset').merge;
 const md5Hex = require('md5-hex');
 const path = require('path');
 const Plugin = require('broccoli-plugin');
+const SilentError = require('silent-error');
 
 const stringify = require('json-stable-stringify');
 
 const LATEST_SCHEMA_VERSION = 5;
 
 module.exports = class FastBootConfig extends Plugin {
-  constructor(inputNode, options) {
+  constructor(inputNode, { project, ui, appConfig, outputPaths }) {
     super([inputNode], {
       annotation: 'Generate: FastBoot package.json',
-      persistentOutput: true
+      persistentOutput: true,
     });
 
-    this.project = options.project;
+    this.project = project;
 
-    this.name = options.name;
-    this.ui = options.ui;
-    this.fastbootAppConfig = options.fastbootAppConfig;
-    this.outputPaths = options.outputPaths;
-    this.appName = options.appConfig.modulePrefix;
-    const appConfigModule = `${this.appName}`;
-    this.fastbootConfig = {};
-    this.fastbootConfig[appConfigModule] = options.appConfig;
+    this.ui = ui;
+    this.fastbootAppConfig = appConfig.fastboot;
+    this.outputPaths = outputPaths;
+    this.appName = appConfig.modulePrefix;
     this._fileToChecksumMap = {};
 
     if (this.fastbootAppConfig && this.fastbootAppConfig.htmlFile) {
       this.htmlFile = this.fastbootAppConfig.htmlFile;
     } else {
       this.htmlFile = 'index.html';
     }
-
-    this.prepareConfig();
-    this.prepareDependencies();
   }
 
   /**
@@ -48,18 +41,12 @@ module.exports = class FastBootConfig extends Plugin {
    * and write it to `package.json`.
    */
   build() {
+    this.prepareDependencies();
     this.buildHostWhitelist();
     let outputPath = path.join(this.outputPath, 'package.json');
     this.writeFileIfContentChanged(outputPath, this.toJSONString());
   }
 
-  get manifest() {
-    if (!this._manifest) {
-      this._manifest = this.buildManifest();
-    }
-    return this._manifest;
-  }
-
   writeFileIfContentChanged(outputPath, content) {
     let previous = this._fileToChecksumMap[outputPath];
     let next = md5Hex(content);
@@ -70,39 +57,26 @@ module.exports = class FastBootConfig extends Plugin {
     }
   }
 
-  prepareConfig() {
-    // we only walk the host app's addons to grab the config since ideally
-    // addons that have dependency on other addons would never define
-    // this advance hook.
-    this.project.addons.forEach(addon => {
-      if (addon.fastbootConfigTree) {
-        let configFromAddon = addon.fastbootConfigTree();
-
-        if (!configFromAddon) {
-          throw new Error('`fastbootConfigTree` requires a map to be returned');
-        }
-
-        merge(this.fastbootConfig, configFromAddon);
-      }
-    });
-  }
-
   prepareDependencies() {
     let dependencies = {};
     let moduleWhitelist = [];
     let ui = this.ui;
 
-    eachAddonPackage(this.project, pkg => {
+    eachAddonPackage(this.project, (pkg) => {
       let deps = getFastBootDependencies(pkg);
 
       if (deps) {
-        deps.forEach(dep => {
+        deps.forEach((dep) => {
           let version = getDependencyVersion(pkg, dep);
 
           if (dep in dependencies) {
             version = dependencies[dep];
             ui.writeLine(
-              fmt('Duplicate FastBoot dependency %s. Versions may mismatch. Using range %s.', dep, version),
+              fmt(
+                'Duplicate FastBoot dependency %s. Versions may mismatch. Using range %s.',
+                dep,
+                version
+              ),
               ui.WARNING
             );
             return;
@@ -121,7 +95,7 @@ module.exports = class FastBootConfig extends Plugin {
     let projectDeps = pkg.fastbootDependencies;
 
     if (projectDeps) {
-      projectDeps.forEach(dep => {
+      projectDeps.forEach((dep) => {
         moduleWhitelist.push(dep);
 
         let version = pkg.dependencies && pkg.dependencies[dep];
@@ -136,12 +110,14 @@ module.exports = class FastBootConfig extends Plugin {
   }
 
   updateFastBootManifest(manifest) {
-    this.project.addons.forEach(addon => {
+    this.project.addons.forEach((addon) => {
       if (addon.updateFastBootManifest) {
         manifest = addon.updateFastBootManifest(manifest);
 
         if (!manifest) {
-          throw new Error(`${addon.name} did not return the updated manifest from updateFastBootManifest hook.`);
+          throw new Error(
+            `${addon.name} did not return the updated manifest from updateFastBootManifest hook.`
+          );
         }
       }
     });
@@ -161,7 +137,7 @@ module.exports = class FastBootConfig extends Plugin {
     let manifest = {
       appFiles: [appFilePath, appFastbootFilePath],
       vendorFiles: [vendorFilePath],
-      htmlFile: this.htmlFile
+      htmlFile: this.htmlFile,
     };
 
     return this.updateFastBootManifest(manifest);
@@ -174,6 +150,7 @@ module.exports = class FastBootConfig extends Plugin {
   }
 
   toJSONString() {
+    let manifest = this.buildManifest();
     return stringify(
       {
         name: this.appName,
@@ -184,9 +161,9 @@ module.exports = class FastBootConfig extends Plugin {
           hostWhitelist: this.normalizeHostWhitelist(),
           // We can't drop manifest until broccoli-asset-rev also supports v5 HTML based manifest
           // https://github.com/ember-cli/broccoli-asset-rev/blob/78f6047c15acb3bd348611f658b03bdd1041911f/lib/fastboot-manifest-rewrite.js
-          manifest: this.manifest,
-          htmlEntrypoint: this.manifest.htmlFile
-        }
+          manifest,
+          htmlEntrypoint: manifest.htmlFile,
+        },
       },
       null,
       2
@@ -198,7 +175,7 @@ module.exports = class FastBootConfig extends Plugin {
       return;
     }
 
-    return this.hostWhitelist.map(function(entry) {
+    return this.hostWhitelist.map(function (entry) {
       // Is a regex
       if (entry.source) {
         return '/' + entry.source + '/';
@@ -210,7 +187,7 @@ module.exports = class FastBootConfig extends Plugin {
 };
 
 function eachAddonPackage(project, cb) {
-  project.addons.map(addon => cb(addon.pkg));
+  project.addons.map((addon) => cb(addon.pkg));
 }
 
 function getFastBootDependencies(pkg) {
@@ -232,7 +209,13 @@ function getFastBootDependencies(pkg) {
 
 function getDependencyVersion(pkg, dep) {
   if (!pkg.dependencies) {
-    throw new Error(fmt("Could not find FastBoot dependency '%s' in %s/package.json dependencies.", dep, pkg.name));
+    throw new Error(
+      fmt(
+        "Could not find FastBoot dependency '%s' in %s/package.json dependencies.",
+        dep,
+        pkg.name
+      )
+    );
   }
 
   return pkg.dependencies[dep];