Refactor: Centralize calls to emberSafeRequire (#2653)

Author: mansona

ember_debug/libs/render-tree.js

@@ -1,36 +1,36 @@
 import captureRenderTree from './capture-render-tree';
 import { guidFor } from 'ember-debug/utils/ember/object/internals';
-import { emberSafeRequire } from 'ember-debug/utils/ember';
 import { inspect } from 'ember-debug/utils/type-check';
 import { isInVersionSpecifier } from 'ember-debug/utils/version';
-import { VERSION } from 'ember-debug/utils/ember';
+import {
+  VERSION,
+  EmberDestroyable,
+  GlimmerManager,
+  GlimmerReference,
+  GlimmerRuntime,
+  GlimmerUtil,
+} from 'ember-debug/utils/ember';
 
 class InElementSupportProvider {
   constructor(owner) {
     this.nodeMap = new Map();
     this.remoteRoots = [];
-    this.runtime = emberSafeRequire('@glimmer/runtime');
-    this.reference = emberSafeRequire('@glimmer/reference');
+    this.runtime = GlimmerRuntime;
+    this.reference = GlimmerReference;
     try {
       this.Wormhole = requireModule('ember-wormhole/components/ember-wormhole');
     } catch {
       // nope
     }
 
-    try {
-      requireModule(
-        '@glimmer/manager',
-      ).CustomModifierManager.prototype.getDebugInstance = (args) =>
-        args.modifier || args.delegate;
-    } catch {
-      // nope
+    if (GlimmerManager) {
+      GlimmerManager.CustomModifierManager.prototype.getDebugInstance = (
+        args,
+      ) => args.modifier || args.delegate;
     }
 
-    this.DESTROY = emberSafeRequire('@glimmer/util')?.DESTROY;
-    this.registerDestructor =
-      emberSafeRequire('@glimmer/destroyable')?.registerDestructor ||
-      emberSafeRequire('@ember/destroyable')?.registerDestructor ||
-      emberSafeRequire('@ember/runtime')?.registerDestructor;
+    this.DESTROY = GlimmerUtil?.DESTROY;
+    this.registerDestructor = EmberDestroyable?.registerDestructor;
 
     this.debugRenderTree =
       owner.lookup('renderer:-dom')?.debugRenderTree ||

ember_debug/object-inspector.js

@@ -16,28 +16,24 @@ import {
   ObjectProxy,
   ArrayProxy,
   Service,
+  InternalsMetal,
   Component,
-  emberSafeRequire,
+  GlimmerComponent,
+  GlimmerReference,
+  GlimmerValidator,
 } from 'ember-debug/utils/ember';
 import { cacheFor, guidFor } from 'ember-debug/utils/ember/object/internals';
 import { _backburner, join } from 'ember-debug/utils/ember/runloop';
 import emberNames from './utils/ember-object-names';
 import getObjectName from './utils/get-object-name';
 
-const GlimmerComponent = (() => {
-  try {
-    return emberSafeRequire('@glimmer/component').default;
-  } catch {
-    // ignore, return undefined
-  }
-})();
-
 let tagValue, tagValidate, track, tagForProperty;
 
-try {
-  // Try to load the most recent library
-  let GlimmerValidator = emberSafeRequire('@glimmer/validator');
+const GlimmerDebugComponent = (() => GlimmerComponent?.default)();
 
+// Try to use the most recent library (GlimmerValidator), else
+// fallback on the previous implementation (GlimmerReference).
+if (GlimmerValidator) {
   tagValue = GlimmerValidator.value || GlimmerValidator.valueForTag;
   tagValidate = GlimmerValidator.validate || GlimmerValidator.validateTag;
   track = GlimmerValidator.track;
@@ -70,26 +66,15 @@ try {
     }
     return r;
   };
-} catch {
-  try {
-    // Fallback to the previous implementation
-    let GlimmerReference = emberSafeRequire('@glimmer/reference');
-
-    tagValue = GlimmerReference.value;
-    tagValidate = GlimmerReference.validate;
-  } catch {
-    // ignore
-  }
+} else if (GlimmerReference) {
+  tagValue = GlimmerReference.value;
+  tagValidate = GlimmerReference.validate;
 }
 
-try {
-  let metal = emberSafeRequire('@ember/-internals/metal');
-
-  tagForProperty = metal.tagForProperty;
+if (InternalsMetal) {
+  tagForProperty = InternalsMetal.tagForProperty;
   // If track was not already loaded, use metal's version (the previous version)
-  track = track || metal.track;
-} catch {
-  // ignore
+  track = track || InternalsMetal.track;
 }
 
 const HAS_GLIMMER_TRACKING = tagValue && tagValidate && track && tagForProperty;
@@ -1285,7 +1270,7 @@ function getDebugInfo(object) {
       'element',
       'targetObject',
     );
-  } else if (GlimmerComponent && object instanceof GlimmerComponent) {
+  } else if (GlimmerDebugComponent && object instanceof GlimmerDebugComponent) {
     // These properties don't really exist on Glimmer Components, but
     // reading their values trigger a development mode assertion. The
     // more correct long term fix is to make getters lazy (shows "..."

ember_debug/utils/ember-object-names.js

@@ -1,5 +1,4 @@
 import { compareVersion } from 'ember-debug/utils/version';
-import { emberSafeRequire } from 'ember-debug/utils/ember';
 import {
   VERSION,
   ActionHandler,
@@ -10,6 +9,8 @@ import {
   MutableArray,
   Component,
   Evented,
+  InternalsRuntime,
+  InternalsViews,
   PromiseProxyMixin,
   EmberObject,
   Observable,
@@ -33,14 +34,12 @@ const emberNames = new Map([
 ]);
 
 if (compareVersion(VERSION, '3.27.0') === -1) {
-  const TargetActionSupport = emberSafeRequire(
-    '@ember/-internals/runtime',
-  )?.TargetActionSupport;
+  const TargetActionSupport = InternalsRuntime?.TargetActionSupport;
   emberNames.set(TargetActionSupport, 'TargetActionSupport Mixin');
 }
 
 try {
-  const Views = emberSafeRequire('@ember/-internals/views') || {};
+  const Views = InternalsViews || {};
   emberNames.set(Views.ViewStateSupport, 'ViewStateSupport Mixin');
   emberNames.set(Views.ViewMixin, 'View Mixin');
   emberNames.set(Views.ActionSupport, 'ActionSupport Mixin');

ember_debug/utils/ember.js

@@ -56,11 +56,21 @@ let captureRenderTree = Ember._captureRenderTree;
 let getEnv = () => Ember.ENV;
 
 let Debug = emberSafeRequire('@ember/debug');
+let InternalsMetal = emberSafeRequire('@ember/-internals/metal');
+let InternalsRuntime = emberSafeRequire('@ember/-internals/runtime');
 let InternalsUtils = emberSafeRequire('@ember/-internals/utils');
+let InternalsViews = emberSafeRequire('@ember/-internals/views');
+let EmberDestroyable = emberSafeRequire('@ember/destroyable');
 let ObjectInternals = emberSafeRequire('@ember/object/internals');
 let Instrumentation = emberSafeRequire('@ember/instrumentation');
 let Runloop = emberSafeRequire('@ember/runloop');
 let RSVP = emberSafeRequire('rsvp');
+let GlimmerComponent = emberSafeRequire('@glimmer/component');
+let GlimmerManager = emberSafeRequire('@glimmer/manager');
+let GlimmerReference = emberSafeRequire('@glimmer/reference');
+let GlimmerRuntime = emberSafeRequire('@glimmer/runtime');
+let GlimmerUtil = emberSafeRequire('@glimmer/util');
+let GlimmerValidator = emberSafeRequire('@glimmer/validator');
 
 if (!Ember) {
   captureRenderTree = emberSafeRequire('@ember/debug')?.captureRenderTree;
@@ -94,7 +104,10 @@ if (!Ember) {
 export {
   Runloop,
   Debug,
+  InternalsMetal,
+  InternalsRuntime,
   InternalsUtils,
+  InternalsViews,
   ObjectInternals,
   Instrumentation,
   RSVP,
@@ -113,6 +126,7 @@ export {
   Evented,
   Service,
   PromiseProxyMixin,
+  EmberDestroyable,
   EmberObject,
   VERSION,
   ComputedProperty,
@@ -122,6 +136,12 @@ export {
   set,
   captureRenderTree,
   getEnv,
+  GlimmerComponent,
+  GlimmerManager,
+  GlimmerReference,
+  GlimmerRuntime,
+  GlimmerUtil,
+  GlimmerValidator,
 };
 
 export default Ember;

ember_debug/utils/type-check.js

@@ -3,7 +3,7 @@ import {
   ComputedProperty,
   EmberObject,
   meta as emberMeta,
-  emberSafeRequire,
+  InternalsMetal,
 } from 'ember-debug/utils/ember';
 
 /**
@@ -41,7 +41,7 @@ export function getDescriptorFor(object, key) {
   // exists longer than ember 3.10
   if (Debug.isComputed) {
     const { descriptorForDecorator, descriptorForProperty } =
-      emberSafeRequire('@ember/-internals/metal') || {};
+      InternalsMetal || {};
     return (
       descriptorForDecorator?.(object[key]) ||
       descriptorForProperty?.(object, key)