-
-
Notifications
You must be signed in to change notification settings - Fork 407
Deprecate Observers #1115
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.
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
Open
wagenet
wants to merge
3
commits into
emberjs:main
Choose a base branch
from
wagenet:deprecate-observable
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Deprecate Observers #1115
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| --- | ||
| stage: accepted | ||
| start-date: 2025-06-16T00:00:00.000Z | ||
| release-date: | ||
| release-versions: | ||
| teams: # delete teams that aren't relevant | ||
| - cli | ||
| - data | ||
| - framework | ||
| - learning | ||
| - steering | ||
| - typescript | ||
| prs: | ||
| accepted: https://github.com/emberjs/rfcs/pull/1115 | ||
| project-link: | ||
| --- | ||
|
|
||
| # Deprecate Observers | ||
|
|
||
| ## Summary | ||
|
|
||
| Deprecate the `Observable` Mixin, `observer` helper, and public observer functionality. | ||
|
|
||
| ## Motivation | ||
|
|
||
| Using observers has been soft-deprecated ever since the introduction of tracking. Removing | ||
| support for them will significantly clean up the code base. (Note that for us to entirely | ||
| remove observer support internally, we will likely need to deprecate other functionality | ||
| in addition to what is include here.) | ||
|
|
||
| Additionally, Ember has also not recommended the use of Mixins for a while. Since | ||
| `Observable` uses the Mixin architecture, it will also need to be deprecated for us | ||
| to fully remove Mixins. | ||
|
|
||
| ## Transition Path | ||
|
|
||
| ### Observable Mixin | ||
|
|
||
| Some of the methods provided by `Observable` are available as standalone methods, | ||
| for these the transition path is straight-forward: | ||
|
|
||
| * `get` -> Import from `@ember/object` | ||
| * `getProperties` -> Import from `@ember/object` | ||
| * `set` -> Import from `@ember/object` | ||
| * `setProperties` -> Import from `@ember/object` | ||
| * `notifyPropertyChange` -> Import from `@ember/object` | ||
|
|
||
| For sugar helpers they can easily be replaced with a bit more verbosity: | ||
|
|
||
| * `incrementProperty` | ||
| ```js | ||
| this.count += 1; // Tracking | ||
| set(this, 'count', get(this, 'count') + 1); // Legacy | ||
| ``` | ||
| * `decrementProperty` | ||
| ```js | ||
| this.count -= 1; // Tracking | ||
| set(this, 'count', get(this, 'count') - 1); // Legacy | ||
| ``` | ||
| * `toggleProperty` | ||
| ```js | ||
| this.flag = !this.flag; // Tracking | ||
| set(this, 'flag', !get(this, 'flag')); // Legacy | ||
| ``` | ||
|
|
||
| For others, there will no replacement and code that depends on them | ||
| will have to be refactored: | ||
|
|
||
| * `addObserver` | ||
| * `removeObserver` | ||
| * `cacheFor` | ||
|
|
||
| ### Observable Helper | ||
|
|
||
| This function does not work with native class syntax and as such, shouldn't be relied upon. | ||
| It will not be replaced. | ||
|
|
||
| ## Exploration | ||
|
|
||
| To validate this deprecation, I've tried removing this functionality in the following PRs: | ||
| * Inline Observable Mixin: https://github.com/emberjs/ember.js/pull/20928 | ||
| * Remove `observer` helper and inlined Observable methods: https://github.com/emberjs/ember.js/pull/20937 | ||
|
|
||
| ## How We Teach This | ||
|
|
||
| We should remove all references to this functionality from the guides. | ||
|
|
||
| ## Drawbacks | ||
|
|
||
| Many users probably rely on this functionality. However, it's almost certainly | ||
| something that we don't want to support long-term. | ||
|
|
||
| ## Alternatives | ||
|
|
||
| * Just inline this functionality so that we can at least get rid of Mixins. | ||
|
|
||
| ## Unresolved questions | ||
|
|
||
| None | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.