Merge pull request #19429 from emberjs/deprecate-global-plugin-state

[DEPRECATE] `registerPlugin` / `unregisterPlugin` and legacy class based AST plugins
emberjs · Feb 25, 2021 · 3aff3c5 · 3aff3c5
2 parents 23f1a79 + 1b0e21a
commit 3aff3c5
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 7 deletions.
diff --git a/packages/ember-template-compiler/lib/system/compile-options.ts b/packages/ember-template-compiler/lib/system/compile-options.ts
@@ -1,5 +1,5 @@
 import { EMBER_STRICT_MODE } from '@ember/canary-features';
-import { assert } from '@ember/debug';
+import { assert, deprecate } from '@ember/debug';
 import { assign } from '@ember/polyfills';
 import { PrecompileOptions } from '@glimmer/compiler';
 import { AST, ASTPlugin, ASTPluginEnvironment, Syntax } from '@glimmer/syntax';
@@ -68,6 +68,19 @@ type LegacyPluginClass = new (env: ASTPluginEnvironment) => LegacyPlugin;
 function wrapLegacyPluginIfNeeded(_plugin: PluginFunc | LegacyPluginClass): PluginFunc {
   let plugin = _plugin;
   if (_plugin.prototype && _plugin.prototype.transform) {
+    deprecate(
+      'Using class based template compilation plugins is deprecated, please update to the functional style',
+      false,
+      {
+        id: 'template-compiler.registerPlugin',
+        until: '4.0.0',
+        for: 'ember-source',
+        since: {
+          enabled: '3.27.0',
+        },
+      }
+    );
+
     const pluginFunc: PluginFunc = (env: ASTPluginEnvironment): ASTPlugin => {
       let pluginInstantiated = false;
 
@@ -97,6 +110,19 @@ function wrapLegacyPluginIfNeeded(_plugin: PluginFunc | LegacyPluginClass): Plug
 }
 
 export function registerPlugin(type: string, _plugin: PluginFunc | LegacyPluginClass): void {
+  deprecate(
+    'registerPlugin is deprecated, please pass plugins directly via `compile` and/or `precompile`.',
+    false,
+    {
+      id: 'template-compiler.registerPlugin',
+      until: '4.0.0',
+      for: 'ember-source',
+      since: {
+        enabled: '3.27.0',
+      },
+    }
+  );
+
   if (type !== 'ast') {
     throw new Error(
       `Attempting to register ${_plugin} as "${type}" which is not a valid Glimmer plugin type.`
@@ -116,6 +142,19 @@ export function registerPlugin(type: string, _plugin: PluginFunc | LegacyPluginC
 }
 
 export function unregisterPlugin(type: string, PluginClass: PluginFunc | LegacyPluginClass): void {
+  deprecate(
+    'unregisterPlugin is deprecated, please pass plugins directly via `compile` and/or `precompile`.',
+    false,
+    {
+      id: 'template-compiler.registerPlugin',
+      until: '4.0.0',
+      for: 'ember-source',
+      since: {
+        enabled: '3.27.0',
+      },
+    }
+  );
+
   if (type !== 'ast') {
     throw new Error(
       `Attempting to unregister ${PluginClass} as "${type}" which is not a valid Glimmer plugin type.`

diff --git a/packages/ember-template-compiler/tests/system/compile_options_test.js b/packages/ember-template-compiler/tests/system/compile_options_test.js
@@ -120,19 +120,34 @@ class CustomPluginsTests extends RenderingTestCase {
 }
 
 moduleFor(
-  'ember-template-compiler: registerPlugin with a custom plugins in legacy format',
+  'ember-template-compiler: [DEPRECATED] registerPlugin with a custom plugins in legacy format',
   class extends CustomPluginsTests {
     beforeEach() {
+      expectDeprecation(
+        'Using class based template compilation plugins is deprecated, please update to the functional style'
+      );
+      expectDeprecation(
+        'registerPlugin is deprecated, please pass plugins directly via `compile` and/or `precompile`.'
+      );
       registerPlugin('ast', LegacyCustomTransform);
     }
 
     afterEach() {
-      unregisterPlugin('ast', LegacyCustomTransform);
+      expectDeprecation(() => {
+        unregisterPlugin('ast', LegacyCustomTransform);
+      }, /unregisterPlugin is deprecated, please pass plugins directly via `compile` and\/or `precompile`/);
       return super.afterEach();
     }
 
     ['@test custom registered plugins are deduplicated'](assert) {
+      expectDeprecation(
+        'Using class based template compilation plugins is deprecated, please update to the functional style'
+      );
+      expectDeprecation(
+        'registerPlugin is deprecated, please pass plugins directly via `compile` and/or `precompile`.'
+      );
       registerPlugin('ast', LegacyCustomTransform);
+
       this.registerTemplate(
         'application',
         '<div data-test="foo" data-blah="derp" class="hahaha"></div>'
@@ -143,19 +158,27 @@ moduleFor(
 );
 
 moduleFor(
-  'ember-template-compiler: registerPlugin with a custom plugins',
+  'ember-template-compiler: [DEPRECATED] registerPlugin with a custom plugins',
   class extends CustomPluginsTests {
     beforeEach() {
-      registerPlugin('ast', customTransform);
+      expectDeprecation(() => {
+        registerPlugin('ast', customTransform);
+      }, /registerPlugin is deprecated, please pass plugins directly via `compile` and\/or `precompile`/);
     }
 
     afterEach() {
-      unregisterPlugin('ast', customTransform);
+      expectDeprecation(() => {
+        unregisterPlugin('ast', customTransform);
+      }, /unregisterPlugin is deprecated, please pass plugins directly via `compile` and\/or `precompile`/);
+
       return super.afterEach();
     }
 
     ['@test custom registered plugins are deduplicated'](assert) {
-      registerPlugin('ast', customTransform);
+      expectDeprecation(() => {
+        registerPlugin('ast', customTransform);
+      }, /registerPlugin is deprecated, please pass plugins directly via `compile` and\/or `precompile`/);
+
       this.registerTemplate(
         'application',
         '<div data-test="foo" data-blah="derp" class="hahaha"></div>'
@@ -170,6 +193,9 @@ moduleFor(
   class extends RenderingTestCase {
     // override so that we can provide custom AST plugins to compile
     compile(templateString) {
+      expectDeprecation(
+        'Using class based template compilation plugins is deprecated, please update to the functional style'
+      );
       return compile(templateString, {
         plugins: {
           ast: [LegacyCustomTransform],