Fix issue with deduplcation of babel plugin when parallelized (#322)

Fix issue with deduplcation of babel plugin when parallelized

Author: Robert Jackson

lib/ember-addon-main.js

@@ -135,7 +135,7 @@ dBabelVersion: ${hasValidBabelVersion};`
 
     // add the babel-plugin-htmlbars-inline-precompile to the list of plugins
     // used by `ember-cli-babel` addon
-    if (!this._isInlinePrecompileBabelPluginRegistered(babelPlugins)) {
+    if (!utils.isInlinePrecompileBabelPluginRegistered(babelPlugins)) {
       let pluginInfo = this.astPlugins();
       let templateCompilerPath = this.templateCompilerPath();
 
@@ -184,51 +184,11 @@ dBabelVersion: ${hasValidBabelVersion};`
       }
     }
 
-    if (this._shouldColocateTemplates()) {
-      const { hasPlugin, addPlugin } = require('ember-cli-babel-plugin-helpers');
-      let colocatedPluginPath = require.resolve('./colocated-babel-plugin');
-
-      if (!hasPlugin(babelPlugins, colocatedPluginPath)) {
-        addPlugin(babelPlugins, colocatedPluginPath);
-      }
+    if (this._shouldColocateTemplates() && !utils.isColocatedBabelPluginRegistered(babelPlugins)) {
+      babelPlugins.push(require.resolve('./colocated-babel-plugin'));
     }
   },
 
-  /**
-   * This function checks if 'babel-plugin-htmlbars-inline-precompile' is already present in babelPlugins.
-   * The plugin object will be different for non parallel API and parallel API.
-   * For parallel api, check the `baseDir` of a plugin to see if it has current dirname
-   * For non parallel api, check the 'modules' to see if it contains the babel plugin
-   * @param {*} plugins
-   */
-  _isInlinePrecompileBabelPluginRegistered(plugins) {
-    return plugins.some(plugin => {
-      if (Array.isArray(plugin)) {
-        let [pluginPathOrInstance, options] = plugin;
-
-        return (
-          pluginPathOrInstance === require.resolve('babel-plugin-htmlbars-inline-precompile') &&
-          typeof options.modules === 'object' &&
-          options.modules['ember-cli-htmlbars'] === 'hbs'
-        );
-      } else if (
-        plugin !== null &&
-        typeof plugin === 'object' &&
-        plugin._parallelBabel !== undefined
-      ) {
-        return (
-          plugin._parallelBabel.requireFile ===
-            path.resolve(__dirname, 'lib/require-from-worker') &&
-          typeof plugin._parallelBabel.params === 'object' &&
-          typeof plugin._parallelBabel.params.modules === 'object' &&
-          plugin._parallelBabel.params.modules['ember-cli-htmlbars'] === 'hbs'
-        );
-      } else {
-        return false;
-      }
-    });
-  },
-
   projectConfig() {
     return this.project.config(process.env.EMBER_ENV);
   },

lib/utils.js

@@ -7,6 +7,39 @@ const debugGenerator = require('heimdalljs-logger');
 const logger = debugGenerator('ember-cli-htmlbars:utils');
 const addDependencyTracker = require('./addDependencyTracker');
 
+function isInlinePrecompileBabelPluginRegistered(plugins) {
+  return plugins.some(plugin => {
+    if (Array.isArray(plugin)) {
+      let [pluginPathOrInstance, options] = plugin;
+
+      return (
+        pluginPathOrInstance === require.resolve('babel-plugin-htmlbars-inline-precompile') &&
+        typeof options.modules === 'object' &&
+        options.modules['ember-cli-htmlbars'] === 'hbs'
+      );
+    } else if (
+      plugin !== null &&
+      typeof plugin === 'object' &&
+      plugin._parallelBabel !== undefined
+    ) {
+      return (
+        plugin._parallelBabel.requireFile === require.resolve('./require-from-worker') &&
+        typeof plugin._parallelBabel.params === 'object' &&
+        typeof plugin._parallelBabel.params.modules === 'object' &&
+        plugin._parallelBabel.params.modules['ember-cli-htmlbars'] === 'hbs'
+      );
+    } else {
+      return false;
+    }
+  });
+}
+
+function isColocatedBabelPluginRegistered(plugins) {
+  return plugins.some(
+    plugin => typeof plugin === 'string' && plugin === require.resolve('./colocated-babel-plugin')
+  );
+}
+
 function buildOptions(projectConfig, templateCompilerPath, pluginInfo) {
   let EmberENV = projectConfig.EmberENV || {};
 
@@ -221,4 +254,6 @@ module.exports = {
   setup,
   makeCacheKey,
   setupPlugins,
+  isColocatedBabelPluginRegistered,
+  isInlinePrecompileBabelPluginRegistered,
 };

node-tests/utils_test.js

@@ -111,4 +111,73 @@ describe('utils', function() {
       });
     });
   });
+
+  describe('isInlinePrecompileBabelPluginRegistered', function() {
+    let nonParallelizablePlugin, parallelizablePlugin;
+
+    beforeEach(function() {
+      let modules = {
+        'ember-cli-htmlbars': 'hbs',
+        'ember-cli-htmlbars-inline-precompile': 'default',
+        'htmlbars-inline-precompile': 'default',
+      };
+
+      nonParallelizablePlugin = [
+        require.resolve('babel-plugin-htmlbars-inline-precompile'),
+        { precompile: null, modules },
+        'ember-cli-htmlbars:inline-precompile',
+      ];
+
+      parallelizablePlugin = {
+        baseDir: () => __dirname,
+        cacheKey: () => `${Date.now()}`,
+        _parallelBabel: {
+          requireFile: require.resolve('../lib/require-from-worker'),
+          buildUsing: 'build',
+          params: {
+            templateCompilerPath: null,
+            parallelConfigs: [],
+            modules,
+          },
+        },
+      };
+      [
+        require.resolve('babel-plugin-htmlbars-inline-precompile'),
+        { precompile: null, modules },
+        'ember-cli-htmlbars:inline-precompile',
+      ];
+    });
+
+    it('is false when no plugins exist', function() {
+      let plugins = [];
+
+      assert.strictEqual(utils.isInlinePrecompileBabelPluginRegistered(plugins), false);
+    });
+
+    it('detects when the non-parallelizable version of the plugin has been installed', function() {
+      let plugins = [nonParallelizablePlugin];
+
+      assert.strictEqual(utils.isInlinePrecompileBabelPluginRegistered(plugins), true);
+    });
+
+    it('detects when the parallelizable version of the plugin has been installed', function() {
+      let plugins = [parallelizablePlugin];
+
+      assert.strictEqual(utils.isInlinePrecompileBabelPluginRegistered(plugins), true);
+    });
+  });
+
+  describe('isColocatedBabelPluginRegistered', function() {
+    it('is false when no plugins exist', function() {
+      let plugins = [];
+
+      assert.strictEqual(utils.isColocatedBabelPluginRegistered(plugins), false);
+    });
+
+    it('detects when the plugin exists', function() {
+      let plugins = [require.resolve('../lib/colocated-babel-plugin')];
+
+      assert.strictEqual(utils.isColocatedBabelPluginRegistered(plugins), true);
+    });
+  });
 });