-
-
Notifications
You must be signed in to change notification settings - Fork 405
RFC: ember data deprecate RSVP.Promise for native Promises #796
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| Stage: Proposed | ||
| Start Date: 2022-02-20 | ||
| Release Date: Unreleased | ||
| Release Versions: | ||
| ember-source: vX.Y.Z | ||
| ember-data: vX.Y.Z | ||
| Relevant Team(s): ember-data | ||
| RFC PR: https://github.com/emberjs/rfcs/pull/796 | ||
| --- | ||
|
|
||
| # Deprecate `RSVP.Promise` for native Promise | ||
|
|
||
| ## Summary | ||
|
|
||
| All methods currently returning an `RSVP.Promise` will return a native Promise. In addition, all documentation will be updated accordingly. | ||
|
|
||
| ## Motivation | ||
|
|
||
| With the removal of IE11 from our build infrastructure and browser requirements, we can now safely remove `RSVP.Promise`. From the [docs](https://github.com/tildeio/rsvp.js/): | ||
|
|
||
| > Specifically, it is a tiny implementation of Promises/A+. It works in node and the browser (IE9+, all the popular evergreen ones). | ||
|
|
||
| RSVP was Ember's polyfill since an early v1.0.0 version during a time when native Promises didn't exist in any browser. In addition, Promises have been supported since Node 0.12. | ||
|
|
||
| By removing `RSVP.Promise` in favor of native Promises, we can drop an unnecessary dependency for both client side and server side fetching of data. | ||
|
|
||
| According to [bundlephobia](https://bundlephobia.com/package/rsvp@4.8.5), this would allow us to remove a significant chunk of dependency weight. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 10kb last I checked! https://twitter.com/mehulkar/status/1460864208203960325?s=21 |
||
|
|
||
| ## Detailed design | ||
|
|
||
| Two steps will be required to fulfill deprecating `RSVP.Promise`. | ||
|
|
||
| First, we will issue a deprecation `DEPRECATE_RSVP_PROMISE` to async callbacks that might be relying on a convenient feature of `RSVP.Promise`. Namely, an `RSVP.Promise` may still be hanging by the time the underlying model instance or store has been destroyed. This will help users surface instances where their test suite or code is dealing with dangling promises. After the removal of this deprecation, this will throw an Error. | ||
|
|
||
| - `id: ember-data:rsvp-unresolved-async` | ||
|
|
||
| Second, we will also utilize the deprecation to replace all instances of `RSVP.Promise` with native Promises. | ||
|
|
||
| The final implementation will look something like: | ||
|
|
||
| ```js | ||
| ajax(options) { | ||
| if (DEPRECATE_RSVP_PROMISE) { | ||
| return new Promise((resolve, reject) => { | ||
| ... | ||
| }); | ||
| } else { | ||
| return new RSVPPromise((resolve, reject) => { | ||
| ... | ||
| }); | ||
| } | ||
| }, | ||
| ``` | ||
|
|
||
| ## How we teach this | ||
|
|
||
| We do not believe this requires any update to the Ember curriculum. API documentation may be needed to remove traces of `RSVP.Promise`. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This needs to include the information that goes into the deprecation guide. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It has been my experience that many feel that RSVP offers two features not available in native Promises: If this is not that case—
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh! This RFC is for Ember-data I thought it was for Ember proper gotcha. 👍 |
||
|
|
||
| See the informal [docs](https://github.com/emberjs/data/blob/fa18fd148e9881a860343eabf0ba15b6f048c3ea/packages/private-build-infra/addon/current-deprecations.ts) on how to configure your compatibility with ember-data deprecations. | ||
|
|
||
| ## Drawbacks | ||
|
|
||
| For users relying on `RSVP.onerror`, they will have to either refactor their code to set the global Promise to RSVP or configure [onunhandledrejection](https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onunhandledrejection) appropriately. | ||
|
|
||
| If users continue to use `rsvp` after it is dropped from ember-data, users can add `rsvp` to their package.json explicitly if they were depending on it transitively. | ||
|
|
||
| Lastly, RSVP gives meaningful labels so that the promise can be debugged easily. We may need to take this into account with a native Promise wrapper, especially how it interacts with the Ember Inspector. | ||
|
|
||
| ## Alternatives | ||
|
|
||
| Continue resolving async paths with `RSVP.Promise` will allowing users a convenient override to use native Promises. | ||
|
|
||
| ## Unresolved questions | ||
|
|
||
| - What level of an abstraction should we provide over native Promise. Derived state for `isPending`, `isResolved`, and `isRejected` seem like probable derived state we want to expose to users to avoid significant churn in their codebase. | ||
snewcomer marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Consideration of Ember's continued use of RSVP. | ||
| - After scanning the codebase, the non native equivalent methods we use from RSVP is `defer` in test files. This is an implementation detail that doesn't need to be flushed out here. | ||
Uh oh!
There was an error while loading. Please reload this page.