Refactor Overrides infrastructure, add more tests

Also fixed a few minor errors in the message (wrong version number etc) Included a list of hardcoded known dormant addons (polyfills mostly) to make the suggestions more reliable.
emberjs · Jun 3, 2021 · 35689f9 · 35689f9
1 parent fffe619
commit 35689f9
Show file tree

Hide file tree

Showing 13 changed files with 1,527 additions and 597 deletions.
diff --git a/lib/global-deprecation-utils.js b/lib/global-deprecation-utils.js
diff --git a/lib/index.js b/lib/index.js
@@ -10,8 +10,7 @@ const buildStripClassCallcheckPlugin = require('./build-strip-class-callcheck-pl
 const injectBabelHelpers = require('./transforms/inject-babel-helpers').injectBabelHelpers;
 const debugTree = require('broccoli-debug').buildDebugCallback('ember-source:addon');
 const vmBabelPlugins = require('@glimmer/vm-babel-plugins');
-const globalDeprecationInfo = require('./global-deprecation-utils');
-const createFile = require('broccoli-file-creator');
+const Overrides = require('./overrides');
 
 const PRE_BUILT_TARGETS = [
   'last 1 Chrome versions',
@@ -67,57 +66,19 @@ module.exports = {
   paths,
   absolutePaths,
   _jqueryIntegrationEnabled: true,
+  _overrideTree: undefined,
 
   included() {
     this._super.included.apply(this, arguments);
 
-    let {
-      hasActionableSuggestions,
-      globalMessage,
-      shouldIssueSingleDeprecation,
+    let overrides = Overrides.for(this.project);
 
-      dotAccessOverride,
-    } = globalDeprecationInfo(this.project);
-
-    if (hasActionableSuggestions) {
-      let shouldIssueSingleDotAccessDeprecation =
-        hasActionableSuggestions &&
-        process.env.EMBER_RUNLOOP_AND_COMPUTED_DOT_ACCESS_DEPRECATIONS !== 'all';
-
-      this._bootstrapMessageOverrideTree = createFile(
-        'packages/@ember/-internals/bootstrap/lib/overrides.js',
-
-        `export const message = ${JSON.stringify(globalMessage)};
-         export const deprecateOnce = ${shouldIssueSingleDeprecation};
-
-         import { _onDotAccess as runloopDotAccessOverride } from '@ember/runloop';
-         import { _onDotAccess as objectDotAccessOverride } from '@ember/object';
-
-         export function setupDotAccess() {
-           let disabled = false;
-           let once = ${shouldIssueSingleDotAccessDeprecation};
-
-           function onDotAccess(dotKey, importKey, module) {
-             if (disabled) {
-               return null;
-             } else {
-               disabled = once;
-
-               ${dotAccessOverride};
-
-               return message;
-             }
-           }
-
-           runloopDotAccessOverride(onDotAccess);
-           objectDotAccessOverride(onDotAccess);
-         }
-        `
-      );
+    if (overrides.hasOverrides) {
+      this._overrideTree = overrides.toTree();
     }
 
-    if (hasActionableSuggestions) {
-      this.ui.writeWarnLine('[DEPRECATION] ' + globalMessage);
+    if (overrides.hasBuildTimeWarning) {
+      this.ui.writeWarnLine('[DEPRECATION] ' + overrides.buildTimeWarning);
     }
 
     const { has } = require('@ember/edition-utils');
@@ -260,8 +221,8 @@ module.exports = {
   },
 
   buildEmberBundles(tree, isProduction) {
-    if (this._bootstrapMessageOverrideTree) {
-      tree = new MergeTrees([tree, this._bootstrapMessageOverrideTree], { overwrite: true });
+    if (this._overrideTree) {
+      tree = new MergeTrees([tree, this._overrideTree], { overwrite: true });
     }
 
     let packages = this.transpileTree(new Funnel(tree, { srcDir: 'packages' }), isProduction);
@@ -349,8 +310,8 @@ module.exports = {
       targets.length === PRE_BUILT_TARGETS.length &&
       // if node is defined in targets we can't reliably use the prebuilt bundles
       !targetNode &&
-      // if we have a custom override for bootstrapping (e.g. for globals deprecations) we can't use the prebuilt bundles
-      !this._bootstrapMessageOverrideTree
+      // if we have a custom override (e.g. for globals deprecations) we can't use the prebuilt bundles
+      !this._overrideTree
     ) {
       ember = new Funnel(tree, {
         destDir: 'ember',