Ensure inline precompile and colocated templates run template AS… (#309)

Robert Jackson · web-flow · commit 2a3eed274376 · 2019-09-29T21:33:57.000-04:00
Ensure inline precompile and colocated templates run template AST plugins.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -24,6 +24,7 @@ module.exports = {
         'blueprints/*/index.js',
         'config/**/*.js',
         'tests/dummy/config/**/*.js',
+        'tests/dummy/lib/**/*.js',
       ],
       excludedFiles: ['addon/**', 'addon-test-support/**', 'app/**', 'tests/dummy/app/**'],
       parserOptions: {
diff --git a/config/ember-try.js b/config/ember-try.js
@@ -101,6 +101,16 @@ module.exports = function() {
             devDependencies: {},
           },
         },
+        {
+          name: 'ember-octane',
+          ENV: {
+            // need to add a convienient API for this to @ember/edition-utils
+            EMBER_EDITION: 'octane',
+          },
+          npm: {
+            devDependencies: {},
+          },
+        },
         {
           name: 'with-ember-cli-htmlbars-inline-precompile',
           npm: {
diff --git a/ember-cli-build.js b/ember-cli-build.js
@@ -1,11 +1,43 @@
 'use strict';
 
 const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
+const MergeTree = require('broccoli-merge-trees');
+const { has } = require('@ember/edition-utils');
 
 module.exports = function(defaults) {
+  let hasOctane = has('octane');
+  let appTree = 'tests/dummy/app';
+  if (hasOctane) {
+    appTree = new MergeTree(['tests/dummy/app', 'tests/colocation/app']);
+  }
+
   let app = new EmberAddon(defaults, {
     // Add options here
     throwUnlessParallelizable: true,
+
+    trees: {
+      app: appTree,
+    },
+
+    babel: {
+      plugins: [
+        [
+          require.resolve('babel-plugin-debug-macros'),
+          {
+            flags: [
+              {
+                name: '@ember/edition-fake-module',
+                source: '@ember/edition-fake-module',
+                flags: {
+                  HAS_OCTANE: hasOctane,
+                },
+              },
+            ],
+          },
+          'debug macros - octane flag',
+        ],
+      ],
+    },
   });
 
   /*
diff --git a/lib/colocated-broccoli-plugin.js b/lib/colocated-broccoli-plugin.js
@@ -6,6 +6,7 @@ const copyFileSync = require('fs-copy-file-sync');
 const path = require('path');
 const walkSync = require('walk-sync');
 const Plugin = require('broccoli-plugin');
+const logger = require('heimdalljs-logger')('ember-cli-htmlbars:colocated-broccoli-plugin');
 
 function detectRootName(files) {
   let [first] = files;
@@ -79,8 +80,19 @@ module.exports = class ColocatedTemplateProcessor extends Plugin {
       let templateContents = fs.readFileSync(inputPath, { encoding: 'utf8' });
       let jsContents = null;
 
-      // TODO: deal with hygiene?
-      let prefix = `import { hbs } from 'ember-cli-htmlbars';\nconst __COLOCATED_TEMPLATE__ = hbs\`${templateContents}\`;\n`;
+      let hbsInvocationOptions = {
+        contents: templateContents,
+        moduleName: filePath,
+        parseOptions: {
+          srcName: filePath,
+        },
+      };
+      let hbsInvocation = `hbs(${JSON.stringify(templateContents)}, ${JSON.stringify(
+        hbsInvocationOptions
+      )})`;
+      let prefix = `import { hbs } from 'ember-cli-htmlbars';\nconst __COLOCATED_TEMPLATE__ = ${hbsInvocation};\n`;
+
+      logger.debug(`processing colocated template: ${filePath} (template-only: ${hasJSFile})`);
 
       if (hasJSFile) {
         // add the template, call setComponentTemplate
@@ -118,9 +130,13 @@ module.exports = class ColocatedTemplateProcessor extends Plugin {
         return;
       }
 
+      logger.debug(`copying unchanged file: ${filePath}`);
+
       // TODO: don't speculatively mkdirSync (likely do in a try/catch with ENOENT)
       mkdirp.sync(path.dirname(outputPath));
       copyFileSync(inputPath, outputPath);
     });
+
+    logger.info(`copied over (unchanged): ${filesToCopy.length} files`);
   }
 };
diff --git a/lib/ember-addon-main.js b/lib/ember-addon-main.js
@@ -36,6 +36,11 @@ module.exports = {
     this._cachedShouldColocateTemplates =
       hasOctane && hasValidBabelVersion && hasValidEmberCLIVersion;
 
+    logger.info(
+      `Colocation processing: ${this._cachedShouldColocateTemplates} (hasOctane: ${hasOctane}; hasValidEmberCLIVersion: ${hasValidEmberCLIVersion}; hasVali
+dBabelVersion: ${hasValidBabelVersion};`
+    );
+
     return this._cachedShouldColocateTemplates;
   },
 
@@ -94,9 +99,8 @@ module.exports = {
     // add the babel-plugin-htmlbars-inline-precompile to the list of plugins
     // used by `ember-cli-babel` addon
     if (!this._isInlinePrecompileBabelPluginRegistered(babelPlugins)) {
-      let pluginWrappers = this.astPlugins();
+      let pluginInfo = this.astPlugins();
       let templateCompilerPath = this.templateCompilerPath();
-      let pluginInfo = utils.setupPlugins(pluginWrappers);
 
       let modules = {
         'ember-cli-htmlbars': 'hbs',
@@ -137,16 +141,7 @@ module.exports = {
         });
       } else {
         logger.debug('NOT using parallel API with for babel inline precompilation plugin');
-
-        let blockingPlugins = pluginWrappers
-          .map(wrapper => {
-            if (wrapper.parallelBabel === undefined) {
-              return wrapper.name;
-            }
-          })
-          .filter(Boolean);
-
-        logger.debug('Prevented by these plugins: ' + blockingPlugins);
+        logger.debug('Prevented by these plugins: ' + pluginInfo.unparallelizableWrappers);
 
         let htmlBarsPlugin = utils.setup(pluginInfo, {
           projectConfig: this.projectConfig(),
diff --git a/lib/utils.js b/lib/utils.js
@@ -120,7 +120,6 @@ function template(templateCompiler, string, options) {
 }
 
 function setup(pluginInfo, options) {
-  // borrowed from ember-cli-htmlbars http://git.io/vJDrW
   let projectConfig = options.projectConfig || {};
   let templateCompilerPath = options.templateCompilerPath;
 
@@ -129,7 +128,9 @@ function setup(pluginInfo, options) {
 
   let cacheKey = makeCacheKey(templateCompilerPath, pluginInfo);
 
-  registerPlugins(templateCompiler, pluginInfo.plugins);
+  registerPlugins(templateCompiler, {
+    ast: pluginInfo.plugins,
+  });
 
   let { precompile } = templateCompiler;
   precompile.baseDir = () => path.resolve(__dirname, '..');
@@ -156,6 +157,7 @@ function setupPlugins(wrappers) {
   let plugins = [];
   let cacheKeys = [];
   let parallelConfigs = [];
+  let unparallelizableWrappers = [];
   let dependencyInvalidation = false;
   let canParallelize = true;
 
@@ -170,6 +172,7 @@ function setupPlugins(wrappers) {
     if (wrapper.parallelBabel) {
       parallelConfigs.push(wrapper.parallelBabel);
     } else {
+      unparallelizableWrappers.push(wrapper.name);
       canParallelize = false;
     }
 
@@ -203,6 +206,7 @@ function setupPlugins(wrappers) {
     cacheKeys,
     parallelConfigs,
     canParallelize,
+    unparallelizableWrappers,
     hasDependencyInvalidation: !!dependencyInvalidation,
   };
 }
diff --git a/node-tests/colocated-plugin-test.js b/node-tests/colocated-plugin-test.js
@@ -49,7 +49,7 @@ describe('ColocatedTemplateCompiler', function() {
           'foo.js':
             stripIndent`
             import { hbs } from 'ember-cli-htmlbars';
-            const __COLOCATED_TEMPLATE__ = hbs\`{{yield}}\`;
+            const __COLOCATED_TEMPLATE__ = hbs("{{yield}}", {"contents":"{{yield}}","moduleName":"app-name-here/components/foo.hbs","parseOptions":{"srcName":"app-name-here/components/foo.hbs"}});
             import templateOnly from '@ember/component/template-only';
 
             export default templateOnly();` + '\n',
@@ -92,7 +92,7 @@ describe('ColocatedTemplateCompiler', function() {
         components: {
           'foo.js': stripIndent`
             import { hbs } from 'ember-cli-htmlbars';
-            const __COLOCATED_TEMPLATE__ = hbs\`{{yield}}\`;
+            const __COLOCATED_TEMPLATE__ = hbs("{{yield}}", {"contents":"{{yield}}","moduleName":"app-name-here/components/foo.hbs","parseOptions":{"srcName":"app-name-here/components/foo.hbs"}});
             import Component from '@glimmer/component';
 
             export default class FooComponent extends Component {}
@@ -135,7 +135,7 @@ describe('ColocatedTemplateCompiler', function() {
             'foo.js':
               stripIndent`
             import { hbs } from 'ember-cli-htmlbars';
-            const __COLOCATED_TEMPLATE__ = hbs\`{{yield}}\`;
+            const __COLOCATED_TEMPLATE__ = hbs("{{yield}}", {"contents":"{{yield}}","moduleName":"@scope-name/addon-name-here/components/foo.hbs","parseOptions":{"srcName":"@scope-name/addon-name-here/components/foo.hbs"}});
             import templateOnly from '@ember/component/template-only';
 
             export default templateOnly();` + '\n',
@@ -182,7 +182,7 @@ describe('ColocatedTemplateCompiler', function() {
           components: {
             'foo.js': stripIndent`
             import { hbs } from 'ember-cli-htmlbars';
-            const __COLOCATED_TEMPLATE__ = hbs\`{{yield}}\`;
+            const __COLOCATED_TEMPLATE__ = hbs("{{yield}}", {"contents":"{{yield}}","moduleName":"@scope-name/addon-name-here/components/foo.hbs","parseOptions":{"srcName":"@scope-name/addon-name-here/components/foo.hbs"}});
             import Component from '@glimmer/component';
 
             export default class FooComponent extends Component {}
diff --git a/node-tests/utils_test.js b/node-tests/utils_test.js
@@ -45,6 +45,7 @@ describe('utils', function() {
         cacheKeys: [],
         parallelConfigs: [],
         canParallelize: true,
+        unparallelizableWrappers: [],
         hasDependencyInvalidation: false,
       });
     });
@@ -74,20 +75,23 @@ describe('utils', function() {
         cacheKeys: ['something', 'something else'],
         parallelConfigs: ['something', 'something else'],
         canParallelize: true,
+        unparallelizableWrappers: [],
         hasDependencyInvalidation: false,
       });
     });
 
     it('canParallelize is false for 1+ plugins without "parallelBabel" property', function() {
       let pluginWrappers = [
         {
+          name: 'first',
           plugin() {},
           cacheKey() {
             return this.parallelBabel;
           },
           parallelBabel: 'something',
         },
         {
+          name: 'second',
           plugin() {},
           cacheKey() {
             return 'something else';
@@ -102,6 +106,7 @@ describe('utils', function() {
         cacheKeys: ['something', 'something else'],
         parallelConfigs: ['something'],
         canParallelize: false,
+        unparallelizableWrappers: ['second'],
         hasDependencyInvalidation: false,
       });
     });
diff --git a/package.json b/package.json
@@ -49,15 +49,18 @@
   },
   "devDependencies": {
     "@ember/optional-features": "^1.0.0",
+    "babel-plugin-debug-macros": "^0.3.3",
+    "broccoli-merge-trees": "^3.0.2",
     "broccoli-test-helper": "^2.0.0",
     "chai": "^4.2.0",
     "co": "^4.6.0",
-    "ember-cli": "~3.12.0",
+    "ember-cli": "~3.13.0",
     "ember-cli-app-version": "^3.2.0",
     "ember-cli-babel": "^7.11.1",
     "ember-cli-dependency-checker": "^3.2.0",
     "ember-cli-inject-live-reload": "^2.0.1",
     "ember-cli-template-lint": "^1.0.0-beta.3",
+    "ember-cli-version-checker": "^3.1.3",
     "ember-export-application-global": "^2.0.0",
     "ember-load-initializers": "^2.1.0",
     "ember-maybe-import-regenerator": "^0.1.6",
@@ -75,6 +78,7 @@
     "fixturify": "^1.2.0",
     "loader.js": "^4.7.0",
     "mocha": "^6.2.0",
+    "module-name-inliner": "link:./tests/dummy/lib/module-name-inliner",
     "prettier": "^1.18.2",
     "qunit-dom": "^0.9.0",
     "release-it": "^12.2.1",
diff --git a/tests/colocation/app/components/bar.hbs b/tests/colocation/app/components/bar.hbs
diff --git a/tests/colocation/app/components/bar.js b/tests/colocation/app/components/bar.js
diff --git a/tests/colocation/app/components/foo.hbs b/tests/colocation/app/components/foo.hbs
@@ -0,0 +1 @@
+Module: {{module-name-inliner}}
diff --git a/tests/dummy/app/components/foo.hbs b/tests/dummy/app/components/foo.hbs
diff --git a/tests/dummy/config/optional-features.json b/tests/dummy/config/optional-features.json
@@ -1,3 +1,5 @@
 {
-  "jquery-integration": false
+  "application-template-wrapper": false,
+  "jquery-integration": false,
+  "template-only-glimmer-components": true
 }
diff --git a/tests/dummy/lib/module-name-inliner/index.js b/tests/dummy/lib/module-name-inliner/index.js
@@ -0,0 +1,49 @@
+'use strict';
+
+let VersionChecker = require('ember-cli-version-checker');
+
+module.exports = {
+  name: require('./package').name,
+
+  isDevelopingAddon() {
+    return true;
+  },
+
+  setupPreprocessorRegistry(type, registry) {
+    // can only add the plugin with this style on newer Ember versions
+    let checker = new VersionChecker(this.project);
+    if (checker.forEmber().gte('3.1.0')) {
+      registry.add('htmlbars-ast-plugin', this.buildPlugin());
+    }
+  },
+
+  buildPlugin() {
+    // https://astexplorer.net/#/gist/7c8399056873e1ddbd2b1acf0a41592a/e08f2f850de449b77b8ad995085496a1100dfd1f
+    return {
+      name: 'module-name-inliner',
+      baseDir() {
+        return __dirname;
+      },
+      parallelBabel: {
+        requireFile: __filename,
+        buildUsing: 'buildPlugin',
+        params: {},
+      },
+      plugin(env) {
+        let { builders } = env.syntax;
+
+        return {
+          name: 'module-name-inliner',
+
+          visitor: {
+            PathExpression(node) {
+              if (node.original === 'module-name-inliner') {
+                return builders.string(env.moduleName);
+              }
+            },
+          },
+        };
+      },
+    };
+  },
+};
diff --git a/tests/dummy/lib/module-name-inliner/package.json b/tests/dummy/lib/module-name-inliner/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "module-name-inliner",
+  "version": "0.1.0",
+  "keywords": [
+    "ember-addon"
+  ],
+  "dependencies": {
+    "ember-cli-version-checker": "*"
+  }
+}
diff --git a/tests/integration/components/colocation-test.js b/tests/integration/components/colocation-test.js
@@ -0,0 +1,20 @@
+import { module, test } from 'qunit';
+import { setupRenderingTest } from 'ember-qunit';
+import { render } from '@ember/test-helpers';
+import { hbs } from 'ember-cli-htmlbars';
+import { HAS_OCTANE } from '@ember/edition-fake-module';
+
+module('tests/integration/components/test-inline-precompile', function(hooks) {
+  if (!HAS_OCTANE) {
+    // can only run against 3.13+ (due to colocation support)
+    return;
+  }
+
+  setupRenderingTest(hooks);
+
+  test('registered ast plugins run against colocated templates (template-only)', async function(assert) {
+    await render(hbs`<Foo />`);
+
+    assert.equal(this.element.textContent.trim(), 'Module: dummy/components/foo.hbs');
+  });
+});
diff --git a/yarn.lock b/yarn.lock
