Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove Ember.Map, Ember.MapWithDefault and Ember.OrderedSet #237

Merged
merged 4 commits into from
Apr 6, 2018
Merged

Remove Ember.Map, Ember.MapWithDefault and Ember.OrderedSet #237

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7508ac
Remove Ember.Map, Ember.MapWithDefault and Ember.OrderedSet RFC
Serabe Jul 19, 2017
b356d54
Update 0000-deprecation-ember-map.md
locks Jul 20, 2017
20e6be0
Update Transition path
Serabe Mar 2, 2018
dbc64fd
Make clear when deprecation will happen.
Serabe Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions text/0000-deprecation-ember-map.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
- Start Date: 2017-07-20
- RFC PR: (leave this empty)
- Ember Issue: (leave this empty)

# Summary

This RFC proposes the deprecation of the following classes:

- `Ember.OrderedSet`
- `Ember.Map`
- `Ember.MapWithDefault`

These classes need to be moved to an external addon given they are private classes and unused in Ember.js itself.

# Motivation

These classes have not been used in Ember itself for a while now. They have always been private but they are used in a few addons, and in particular Ember Data is using them.

# Transition Path

`Ember.Map` and `Ember.MapWithDefault` will be deprecated and not extracted, but not before the fix mentioned in the following paragraph is landed in Ember Data. There is already an addon with `Ember.OrderedSet` extracted ([@ember/ordered-set](https://github.com/emberjs/ember-ordered-set)).

Ember Data is quite likely the biggest project using these classes. There is already a PR that needs merging before deprecating `Ember.Map` and `Ember.MapWithDefault` https://github.com/emberjs/data/pull/5255. Ember Data still needs to migrate to `@ember/ordered-set` to its relationship logic.

Once Ember Data is updated to not use the classes from Ember, and that fix is released, the `Ember.Map` and `Ember.MapWithDefault` can be deprecated in Ember itself.

# How We Teach This

These classes being private would make this simple than other deprecations. People were not supposed to be using a private API and the few that were, would just need to use a new addon.

This should not impact many codebases.

# Drawbacks

This requires cooperation with Ember Data, the main user of these classes. It would be nice to have moved Ember Data to using the addon before releasing Ember with the deprecation so the average user does not see any deprecation warning.
Copy link
Sponsor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 for this option. I recall the last time something in heavy use in Ember Data was deprecated I was hit with a terrifying number of notices that I could do nothing about. While methods now exist to hep with this it should still be avoided if possible.


# Alternatives

Other option would be moving these classes to Ember Data itself or leaving things as they are now.

# Unresolved questions