deprecate tryInvoke

emberjs · Nov 12, 2020 · 15e3eb2 · janwerkhoven · May 22, 2021 · janwerkhoven
1 parent 0213b78
commit 15e3eb2
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 11 deletions.
diff --git a/packages/@ember/-internals/glimmer/tests/integration/components/life-cycle-test.js b/packages/@ember/-internals/glimmer/tests/integration/components/life-cycle-test.js
@@ -11,7 +11,6 @@ import { schedule } from '@ember/runloop';
 import { set, setProperties } from '@ember/-internals/metal';
 import { A as emberA } from '@ember/-internals/runtime';
 import { getViewId, getViewElement, jQueryDisabled } from '@ember/-internals/views';
-import { tryInvoke } from '@ember/-internals/utils';
 
 import { Component } from '../../utils/helpers';
 
@@ -1645,9 +1644,9 @@ if (!jQueryDisabled) {
         expectDeprecation(() => {
           let comp = owner.lookup('component:foo-bar');
           runAppend(comp);
-          runTask(() => tryInvoke(component, 'destroy'));
+          runTask(() => component.destroy?.());
         }, 'Using this.$() in a component has been deprecated, consider using this.element');
-        runTask(() => tryInvoke(component, 'destroy'));
+        runTask(() => component.destroy?.());
       }
     }
   );

diff --git a/packages/@ember/-internals/routing/lib/location/auto_location.ts b/packages/@ember/-internals/routing/lib/location/auto_location.ts
@@ -2,7 +2,6 @@ import { history, location, userAgent, window } from '@ember/-internals/browser-
 import { set } from '@ember/-internals/metal';
 import { getOwner } from '@ember/-internals/owner';
 import { Object as EmberObject } from '@ember/-internals/runtime';
-import { tryInvoke } from '@ember/-internals/utils';
 import { assert } from '@ember/debug';
 import { EmberLocation, UpdateCallback } from './api';
 import {
@@ -199,7 +198,7 @@ function delegateToConcreteImplementation(methodName: string) {
       "AutoLocation's detect() method should be called before calling any other hooks.",
       Boolean(concreteImplementation)
     );
-    return tryInvoke(concreteImplementation, methodName, args);
+    return concreteImplementation[methodName]?.(...args);
   };
 }
 

diff --git a/packages/@ember/-internals/runtime/lib/mixins/array.js b/packages/@ember/-internals/runtime/lib/mixins/array.js
@@ -3,7 +3,7 @@
 */
 import { DEBUG } from '@glimmer/env';
 import { PROXY_CONTENT } from '@ember/-internals/metal';
-import { setEmberArray, HAS_NATIVE_PROXY, tryInvoke } from '@ember/-internals/utils';
+import { setEmberArray, HAS_NATIVE_PROXY } from '@ember/-internals/utils';
 import {
   get,
   set,
@@ -1347,7 +1347,7 @@ const ArrayMixin = Mixin.create(Enumerable, {
   invoke(methodName, ...args) {
     let ret = A();
 
-    this.forEach((item) => ret.push(tryInvoke(item, methodName, args)));
+    this.forEach((item) => ret.push(item[methodName]?.(...args)));
 
     return ret;
   },

diff --git a/packages/@ember/-internals/utils/lib/invoke.ts b/packages/@ember/-internals/utils/lib/invoke.ts
@@ -1,3 +1,5 @@
+import { deprecate } from '@ember/debug';
+
 /**
   Checks to see if the `methodName` exists on the `obj`.
 
@@ -46,12 +48,27 @@ export function canInvoke(obj: any | null | undefined, methodName: string): obj
   @param {Array} [args] The arguments to pass to the method
   @return {*} the return value of the invoked method or undefined if it cannot be invoked
   @public
+  @deprecated Use Javascript's optional chaining instead.
 */
 export function tryInvoke(
   obj: any | undefined | null,
   methodName: string,
   args: Array<any | undefined | null>
 ) {
+  deprecate(
+    `Use of tryInvoke is deprecated. Instead, consider using JavaScript's optional chaining.`,
+    false,
+    {
+      id: 'ember-utils.try-invoke',
+      until: '4.0.0',
+      for: 'ember-source',
+      since: {
+        available: '3.24.0',
+      },
+      url: 'https://deprecations.emberjs.com/v3.x#toc_ember-utils-try-invoke',
+    }
+  );
+
   if (canInvoke(obj, methodName)) {
     let method = obj[methodName];
     return method.apply(obj, args);

diff --git a/packages/@ember/-internals/utils/tests/try_invoke_test.js b/packages/@ember/-internals/utils/tests/try_invoke_test.js
@@ -24,25 +24,37 @@ moduleFor(
     }
 
     ["@test should return undefined when the object doesn't exist"](assert) {
-      assert.equal(tryInvoke(undefined, 'aMethodThatDoesNotExist'), undefined);
+      expectDeprecation(
+        () => assert.equal(tryInvoke(undefined, 'aMethodThatDoesNotExist'), undefined),
+        /Use of tryInvoke is deprecated/
+      );
     }
 
     ["@test should return undefined when asked to perform a method that doesn't exist on the object"](
       assert
     ) {
-      assert.equal(tryInvoke(obj, 'aMethodThatDoesNotExist'), undefined);
+      expectDeprecation(
+        () => assert.equal(tryInvoke(obj, 'aMethodThatDoesNotExist'), undefined),
+        /Use of tryInvoke is deprecated/
+      );
     }
 
     ['@test should return what the method returns when asked to perform a method that exists on the object'](
       assert
     ) {
-      assert.equal(tryInvoke(obj, 'aMethodThatExists'), true);
+      expectDeprecation(
+        () => assert.equal(tryInvoke(obj, 'aMethodThatExists'), true),
+        /Use of tryInvoke is deprecated/
+      );
     }
 
     ['@test should return what the method returns when asked to perform a method that takes arguments and exists on the object'](
       assert
     ) {
-      assert.equal(tryInvoke(obj, 'aMethodThatTakesArguments', [true, true]), true);
+      expectDeprecation(
+        () => assert.equal(tryInvoke(obj, 'aMethodThatTakesArguments', [true, true]), true),
+        /Use of tryInvoke is deprecated/
+      );
     }
   }
 );