Remove usage of registerPlugin / unregisterPlugin

These APIs force Ember to use global mutable state (the list of plugins) and require some pretty gnarly cache busting techniques to avoid having addons break each other (due to the global mutable state leaking from one addon to another). In order to discourage this mutable state issue, Ember has deprecated usage of `Ember.HTMLBars.registerPlugin` and `Ember.HTMLBars.unregisterPlugin` (as of Ember 3.27). This PR changes all invocations to pass the required AST transforms directly in to the compiler invocation (instead of calling `registerPlugin` before hand), and allows us to continue working properly while avoiding the deprecation (and that evil mutable state).
ember-cli · Feb 26, 2021 · 1774d0e · 1774d0e
1 parent 72e6a6e
commit 1774d0e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 70 deletions.
diff --git a/lib/template-compiler-plugin.js b/lib/template-compiler-plugin.js
@@ -40,29 +40,15 @@ class TemplateCompiler extends Filter {
     // TODO: do we need this?
     this.precompile = this.options.templateCompiler.precompile;
 
-    let { templateCompiler, plugins, EmberENV } = options;
+    let { templateCompiler, EmberENV } = options;
 
-    utils.registerPlugins(templateCompiler, plugins);
     utils.initializeEmberENV(templateCompiler, EmberENV);
   }
 
   baseDir() {
     return __dirname;
   }
 
-  unregisterPlugins() {
-    let { templateCompiler, plugins } = this.options;
-
-    utils.unregisterPlugins(templateCompiler, plugins);
-  }
-
-  registeredASTPlugins() {
-    // This is a super obtuse way to get access to the plugins we've registered
-    // it also returns other plugins that are registered by ember itself.
-    let options = this.options.templateCompiler.compileOptions();
-    return (options.plugins && options.plugins.ast) || [];
-  }
-
   processString(string, relativePath) {
     let srcDir = this.inputPaths[0];
     let srcName = path.join(srcDir, relativePath);
@@ -76,10 +62,11 @@ class TemplateCompiler extends Filter {
           parseOptions: {
             srcName: srcName,
           },
+          plugins: this.options.plugins,
         }) +
         ';';
       if (this.options.dependencyInvalidation) {
-        let plugins = pluginsWithDependencies(this.registeredASTPlugins());
+        let plugins = pluginsWithDependencies(this.options.plugins.ast);
         let dependencies = [];
         for (let i = 0; i < plugins.length; i++) {
           let pluginDeps = plugins[i].getDependencies(relativePath);

diff --git a/lib/utils.js b/lib/utils.js
@@ -154,26 +154,6 @@ function getTemplateCompiler(templateCompilerPath, EmberENV = {}) {
   return context.module.exports;
 }
 
-function registerPlugins(templateCompiler, plugins) {
-  if (plugins) {
-    for (let type in plugins) {
-      for (let i = 0, l = plugins[type].length; i < l; i++) {
-        templateCompiler.registerPlugin(type, plugins[type][i]);
-      }
-    }
-  }
-}
-
-function unregisterPlugins(templateCompiler, plugins) {
-  if (plugins) {
-    for (let type in plugins) {
-      for (let i = 0, l = plugins[type].length; i < l; i++) {
-        templateCompiler.unregisterPlugin(type, plugins[type][i]);
-      }
-    }
-  }
-}
-
 function initializeEmberENV(templateCompiler, EmberENV) {
   if (!templateCompiler || !EmberENV) {
     return;
@@ -215,14 +195,14 @@ function setup(pluginInfo, options) {
   let htmlbarsOptions = buildOptions(projectConfig, templateCompilerPath, pluginInfo);
   let { templateCompiler } = htmlbarsOptions;
 
-  registerPlugins(templateCompiler, {
-    ast: pluginInfo.plugins,
-  });
-
-  let { precompile: templatePrecompile } = templateCompiler;
+  let templatePrecompile = templateCompiler.precompile;
 
   let precompile = (template, _options) => {
-    let options = {};
+    let options = {
+      plugins: {
+        ast: pluginInfo.plugins,
+      },
+    };
 
     for (let option in _options) {
       if (option === 'scope') {
@@ -336,8 +316,6 @@ function setupPlugins(wrappers) {
 
 module.exports = {
   buildOptions,
-  registerPlugins,
-  unregisterPlugins,
   initializeEmberENV,
   template,
   setup,

diff --git a/node-tests/ast_plugins_test.js b/node-tests/ast_plugins_test.js
@@ -10,7 +10,6 @@ const { createTempDir, createBuilder } = require('broccoli-test-helper');
 const fixturify = require('fixturify');
 const addDependencyTracker = require('../lib/addDependencyTracker');
 const templateCompiler = require('ember-source/dist/ember-template-compiler.js');
-const CANNOT_UNREGISTER_PLUGINS = !templateCompiler.unregisterPlugin;
 
 describe('AST plugins', function () {
   const they = it;
@@ -33,7 +32,6 @@ describe('AST plugins', function () {
   afterEach(
     co.wrap(function* () {
       if (tree) {
-        tree.unregisterPlugins();
         if (tree.processor.processor._cache) {
           yield tree.processor.processor._cache.clear();
         }
@@ -103,9 +101,6 @@ describe('AST plugins', function () {
   they(
     'are accepted and used.',
     co.wrap(function* () {
-      if (CANNOT_UNREGISTER_PLUGINS) {
-        this.skip();
-      }
       htmlbarsOptions.plugins = {
         ast: [DivRewriter],
       };
@@ -125,9 +120,6 @@ describe('AST plugins', function () {
   they(
     'will bust the hot cache if the dependency changes.',
     co.wrap(function* () {
-      if (CANNOT_UNREGISTER_PLUGINS) {
-        this.skip();
-      }
       Object.assign(htmlbarsOptions, {
         plugins: {
           ast: [DivRewriter],
@@ -184,9 +176,6 @@ describe('AST plugins', function () {
     they(
       'will bust the persistent cache if the template cache key changes.',
       co.wrap(function* () {
-        if (CANNOT_UNREGISTER_PLUGINS) {
-          this.skip();
-        }
         Object.assign(htmlbarsOptions, {
           plugins: {
             ast: [DivRewriter],
@@ -206,7 +195,6 @@ describe('AST plugins', function () {
           assert.strictEqual(rewriterCallCount, 1);
         } finally {
           yield output.dispose();
-          firstTree.unregisterPlugins();
         }
 
         // The state didn't change. the output should be cached
@@ -223,7 +211,6 @@ describe('AST plugins', function () {
           assert.strictEqual(rewriterCallCount, 1);
         } finally {
           yield output.dispose();
-          secondTree.unregisterPlugins();
         }
 
         // The state changes. the cache key updates and the template
@@ -242,7 +229,6 @@ describe('AST plugins', function () {
           assert.strictEqual(rewriterCallCount, 2);
         } finally {
           yield output.dispose();
-          thirdTree.unregisterPlugins();
         }
       })
     );

diff --git a/node-tests/template_compiler_test.js b/node-tests/template_compiler_test.js
@@ -83,12 +83,8 @@ describe('TemplateCompiler', function () {
 
     let tree = new TemplateCompiler(input.path(), htmlbarsOptions);
 
-    try {
-      output = createBuilder(tree);
-      await output.build();
-    } finally {
-      tree.unregisterPlugins();
-    }
+    output = createBuilder(tree);
+    await output.build();
 
     let expected = `export default Ember.HTMLBars.template(${htmlbarsPrecompile(source, {
       moduleName: 'template.hbs',
@@ -124,12 +120,8 @@ describe('TemplateCompiler', function () {
 
     let tree = new TemplateCompiler(input.path(), htmlbarsOptions);
 
-    try {
-      output = createBuilder(tree);
-      await output.build();
-    } finally {
-      tree.unregisterPlugins();
-    }
+    output = createBuilder(tree);
+    await output.build();
 
     assert.ok(wasProduction);
   });