Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upType inference for ofType, removal of ActionsObservable in favor of just Observable #681
Conversation
cartant left a comment
|
LGTM |
This comment has been minimized.
This comment has been minimized.
|
|
This comment has been minimized.
This comment has been minimized.
|
I don't think it's necessary to deprecate ActionObservable before removing it. Changing the ofType method to an imported function is not a huge change and probably the only thing users will have to do, and they may have already done it. |
| @@ -42,7 +41,7 @@ export function createEpicMiddleware<T extends Action, O extends T = T, S = void | |||
| const stateSubject$ = new Subject<S>().pipe( | |||
| observeOn(uniqueQueueScheduler) | |||
| ) as any as Subject<S>; | |||
This comment has been minimized.
This comment has been minimized.
csvn
Oct 22, 2019
Contributor
Nit: as any as Subject<S> can be removed, now that a regular Observable is used instead of ActionsObservable.
I love this PR, as I think it simplifies both usage and the code quite a bit. Sorry if I just jumped in with this review.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
jayphelps
Nov 14, 2019
Author
Member
Turns out it couldn't just be removed as-is because while observeOn() uses RxJS's internal lift() function so it does return a Subject, the type definition does not reflect that with pipe() so from the type system point of view it's just an Observable and doesn't have .next() nor .asObservable(). No biggie as I was able to refactor the code in another way to avoid the casts.
…ble in favor of just Observable
BREAKING CHANGE: ActionsObservable existed so we could provide an ofType() method to the prototype of action$, before RxJS had pipeable operators. Now that pipeable operators have been out for quite some time we are removing ActionsObservable in favor or using the pipeable ofType() instead.
```js
// BEFORE
function someEpic(action$) {
return action$
.ofType('PING')
.mapTo({ type: 'PONG' });
}
// AFTER
import { ofType } from 'redux-observable';
import { mapTo } from 'rxjs/operators';
function someEpic(action$) {
return action$.pipe(
ofType('PING')
mapTo({ type: 'PONG' })
);
}
```
jayphelps
changed the title
This comment has been minimized.
This comment has been minimized.
|
Thanks for all the reviews! I've cut a pre-release |
This comment has been minimized.
This comment has been minimized.
|
@jayphelps I noticed the release commit 9a85f64, but no publish seems to have been done to NPM (https://www.npmjs.com/package/redux-observable?activeTab=versions). Maybe there's some issue with the publishing pipeline. Should I create an issue for this? |
This comment has been minimized.
This comment has been minimized.
|
Whoa. I know 100% for sure the 2.0 alpha was released and tagged as next. It’s been installed and used in several apps that I’m aware of. Not sure what happened. I’ll look into it ASAP likely this weekend. Thanks for the heads up! Feel free to make a ticket if you’d like to subscribe to updates |
This comment has been minimized.
This comment has been minimized.
|
Proof I’m not crazy. |
This comment has been minimized.
This comment has been minimized.
|
|
This comment has been minimized.
This comment has been minimized.
|
Phew! Thanks for checking that @evertbouw it must just be a UI bug or DB issue. I’m not able to try to install it right now, but anyone should let us know if you can’t install. |
This comment has been minimized.
This comment has been minimized.
|
That's weird... I didn't run
Thanks a lot, sorry for the noise! edit: Running the npm command shows |
jayphelps commentedOct 19, 2019
•
edited
Heavily inspired by examples that @thorn0 @tjfryan did in #622
For v2.0.0 I'd like to finally have ofType infer the TypeScript types automatically, so that you don't need to pass in the generic param or define your filter action(s) as the argument type of the next operator. This requires some voodoo and a new-ish version of TypeScript, but I'm not yet sure which minimum version. I'll have to try them until it breaks, before merging this, then I can document it in the changelog/docs.
At the same time, I want to get away from ActionsObservable because in the pipeable operator world, there's no need for it and it just adds friction/learning.
The primary reason StateObservable is not BehaviorSubject is because we want to expose
state$.valuebut _we do not want to exposestate$.next(something)because that would be a huge footgun that wouldn't do what you might think--no reason to do it inside your epics.Have objections or other thoughts? Please lmk! We'll likely do the normal pre-alpha, alpha, beta, rc, etc cycle for 2.0, but depending on how smooth it goes, how many changes there are (don't expect too many) we might skip a step or two of those.