add deprecation to `NAME_KEY` #16710

bekzod · 2018-06-02T10:29:42Z

since NAME_KEY is still widely used https://emberobserver.com/code-search?codeQuery=NAME_KEY

bekzod · 2018-06-02T10:34:24Z

packages/ember-runtime/lib/system/core_object.js

@@ -608,7 +609,7 @@ CoreObject.PrototypeMixin = Mixin.create({
    let hasToStringExtension = typeof this.toStringExtension === 'function';
    let extension = hasToStringExtension ? `:${this.toStringExtension()}` : '';

-    let ret = `<${getName(this) || FACTORY_FOR.get(this) || this.constructor.toString()}:${guidFor(
+    let ret = `<${ this[NAME_KEY] || getName(this) || FACTORY_FOR.get(this) || this.constructor.toString()}:${guidFor(


reverted old behavior here, as some addon depend on it right now

bekzod · 2018-06-02T10:39:41Z

@krisselden good idea ?

rwjblue · 2018-06-02T13:34:55Z

IMHO, nearly all of these cases would be better implemented via a .toString on the class/mixin/etc (which would be backwards compatible). Also, most of these addons use it speculatively, and we ensured they didn't error by continuing to have an Ember.NAME_KEY present.

tldr; unless we are aware of actual breakage, I'd rather not bring back the lookup for this[NAME_KEY]...

bekzod · 2018-06-02T14:05:19Z

Got it, should we at least keep deprecation ?

…

On 2 Jun 2018, at 18:35, Robert Jackson ***@***.***> wrote: IMHO, nearly all of these cases would be better implemented via a .toString on the class/mixin/etc (which would be backwards compatible). Also, most of these addons use it speculatively, and we ensured they didn't error by continuing to have an Ember.NAME_KEY present. tldr; unless we are aware of actual breakage, I'd rather not bring back the lookup for this[NAME_KEY]... — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

rwjblue · 2018-06-02T14:18:48Z

Yes, that seems good to me, though it will need to tell folks to use .toString instead.

krisselden · 2018-06-28T02:48:35Z

The usage of this.NAME_KEY in CoreObject instance method toString is likely never used, and the examples linked to are trying to add it to the constructor for classToString behavior. I don't remember why we did the NAME_KEY in there, I think it may have been how the factory at one point set name by passing it to create(). I'd like to redo the string stuff around just constructor.name and factory name, remove the namespace stuff.

krisselden · 2018-06-28T02:51:36Z

I see, you want to propose setName be used instead of this pattern, we use constructor to string so if they implement a toString method on the constructor, it will be used instead.

bekzod · 2018-06-28T11:23:03Z

anyway public usage should be deprecated right ? if not then you can close it

rwjblue

One minor tweak, but seems good to me after that...

rwjblue · 2018-06-28T14:32:31Z

packages/ember/index.js

+  get() {
+    deprecate('Using `Ember.NAME_KEY` is deprecated, override `.toString` instead', false, {
+      id: 'ember-name-key-usage',
+      until: '4.0.0',


Lets say 3.5.0 here, I don't think NAME_KEY was ever public API...

rwjblue

Looks good, would you mind doing a deprecation-app entry for this?

krisselden · 2018-06-28T22:44:50Z

packages/ember/tests/reexports_test.js

+    ['@test Ember.NAME_KEY is deprecated']() {
+      expectDeprecation(() => {
+        Ember.NAME_KEY;
+      }, 'Using `Ember.NAME_KEY` is deprecated, override `.toString` instead');


should make it clear that it is static toString. MyClass.toString = () => 'MyClass'

krisselden · 2018-06-28T22:45:23Z

packages/ember/index.js

@@ -202,7 +202,20 @@ Ember.canInvoke = utils.canInvoke;
 Ember.tryInvoke = utils.tryInvoke;
 Ember.wrap = utils.wrap;
 Ember.uuid = utils.uuid;
-Ember.NAME_KEY = utils.NAME_KEY;
+Ember.setName = utils.setName;


if we prefer toString on the constructor, why are we exporting this?

Derp. I missed this when I last reviewed. Good catch @krisselden.

remove this and it is good to go

krisselden · 2018-07-16T19:57:47Z

packages/ember/index.js

@@ -202,7 +202,20 @@ Ember.canInvoke = utils.canInvoke;
 Ember.tryInvoke = utils.tryInvoke;
 Ember.wrap = utils.wrap;
 Ember.uuid = utils.uuid;
-Ember.NAME_KEY = utils.NAME_KEY;
+Ember.setName = utils.setName;


remove this and it is good to go

Turbo87

rebased, and adjusted the deprecation warning to stay until v3.9.0

/cc @rwjblue

addressed

bekzod commented Jun 2, 2018

View reviewed changes

bekzod force-pushed the remove-name-key branch from 01ab5d5 to 1201c55 Compare June 2, 2018 10:38

bekzod force-pushed the remove-name-key branch from 1201c55 to bb17bcb Compare June 2, 2018 11:33

bekzod force-pushed the remove-name-key branch from bb17bcb to 7ff3f8e Compare June 2, 2018 18:51

bekzod changed the title ~~add deprecation to NAME_KEY and expose setName~~ add deprecation to NAME_KEY Jun 2, 2018

bekzod force-pushed the remove-name-key branch from 7ff3f8e to d4ac71b Compare June 2, 2018 18:52

rwjblue requested changes Jun 28, 2018

View reviewed changes

bekzod force-pushed the remove-name-key branch from d4ac71b to c4667e0 Compare June 28, 2018 19:12

rwjblue approved these changes Jun 28, 2018

View reviewed changes

krisselden reviewed Jun 28, 2018

View reviewed changes

krisselden previously requested changes Jul 16, 2018

View reviewed changes

bekzod force-pushed the remove-name-key branch from c4667e0 to c0917aa Compare July 17, 2018 13:31

add deprecation to NAME_KEY

914f3cc

Turbo87 force-pushed the remove-name-key branch from c0917aa to 914f3cc Compare December 19, 2018 16:57

Turbo87 approved these changes Dec 19, 2018

View reviewed changes

rwjblue merged commit 1032b80 into emberjs:master Dec 19, 2018

bekzod deleted the remove-name-key branch January 8, 2019 07:33

ghost mentioned this pull request Feb 19, 2019

NAME_KEY is deprecated offirgolan/ember-parachute#72

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add deprecation to `NAME_KEY` #16710

add deprecation to `NAME_KEY` #16710

bekzod commented Jun 2, 2018

bekzod Jun 2, 2018

bekzod commented Jun 2, 2018

rwjblue commented Jun 2, 2018

bekzod commented Jun 2, 2018 via email

rwjblue commented Jun 2, 2018

krisselden commented Jun 28, 2018

krisselden commented Jun 28, 2018

bekzod commented Jun 28, 2018

rwjblue left a comment

rwjblue Jun 28, 2018

bekzod Jun 28, 2018

rwjblue left a comment

krisselden Jun 28, 2018

krisselden Jun 28, 2018

rwjblue Jun 28, 2018

krisselden Jul 16, 2018

krisselden Jul 16, 2018

Turbo87 left a comment

add deprecation to NAME_KEY #16710

add deprecation to NAME_KEY #16710

Conversation

bekzod commented Jun 2, 2018

Choose a reason for hiding this comment

bekzod commented Jun 2, 2018

rwjblue commented Jun 2, 2018

bekzod commented Jun 2, 2018 via email

rwjblue commented Jun 2, 2018

krisselden commented Jun 28, 2018

krisselden commented Jun 28, 2018

bekzod commented Jun 28, 2018

rwjblue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rwjblue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Turbo87 left a comment

Choose a reason for hiding this comment

add deprecation to `NAME_KEY` #16710

add deprecation to `NAME_KEY` #16710