Single/Completable subscribe overloads to handle failures
#3112
Conversation
This file contains 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
Motivation: Currently, users can consume the result or execute a `Runnable` for successful termination of a `Single`/`Completable`. Failures will be logged at debug level. Users can only use `whenOnError` operator to intercept the error, but it may result in duplicated logging or users simply forget to handle the error case. Modifications: - Add `Single.subscribe(Consumer<? super T>, Consumer<? super Throwable>)`; - Add `Completable.subscribe(Runnable, Consumer<? super Throwable>)`; - Modify `SimpleSingleSubscriber/SimpleCompletableSubscriber` to handle error when `errorConsumer` is provided. Result: Users can easily handle error cases when they subscribe to `Single` or `Completable`.
idelpivnitskiy
commented
Nov 18, 2024
| * @return {@link Cancellable} used to invoke {@link Cancellable#cancel()} on the parameter of | ||
| * {@link Subscriber#onSubscribe(Cancellable)} for this {@link Single}. | ||
| */ | ||
| public final Cancellable subscribe(Consumer<? super T> resultConsumer, |
There was a problem hiding this comment.
2 consumers vs bi-consumer: I picked the way that exists in both rxjava (for Single and Completable) and reactor (for Mono) to be as close as possible to other implementations. We can add BiConsumer later if there is an ask.
bryce-anderson
approved these changes
Nov 18, 2024
| * {@link Subscriber#onSubscribe(Cancellable)} for this {@link Single}. | ||
| */ | ||
| public final Cancellable subscribe(Consumer<? super T> resultConsumer, | ||
| Consumer<? super Throwable> errorConsumer) { |
There was a problem hiding this comment.
Do you want to enforce that this helper doesn't receive a null errorConsumer? If not, we might as well funnel the subscribe(Consumer<? super T>) variant through this method.
The same question applies to Completable.
There was a problem hiding this comment.
Good idea, changed ctors to use requireNonNull when we expect errorConsumer
idelpivnitskiy
added a commit
to idelpivnitskiy/servicetalk
that referenced
this pull request
Nov 18, 2024
Use new `Single.subscribe(...)` overload introduced in [apple#3112](apple#3112) that takes `errorConsumer` to avoid using extra operator `whenOnError`. It will also help to avoid logging those exceptions by `SimpleSingleSubscriber` (hard to relate to a real request) and instead they will only bubble up on the caller path.
idelpivnitskiy
added a commit
that referenced
this pull request
Nov 18, 2024
…3114) Use new `Single.subscribe(...)` overload introduced in [#3112](#3112) that takes `errorConsumer` to avoid using extra operator `whenOnError`. It will also help to avoid logging those exceptions by `SimpleSingleSubscriber` (hard to relate to a real request) and instead they will only bubble up on the caller path.
mgodave
pushed a commit
to mgodave/servicetalk
that referenced
this pull request
Nov 19, 2024
…e#3112) Motivation: Currently, users can consume the result or execute a `Runnable` for successful termination of a `Single`/`Completable`. Failures will be logged at debug level. Users can only use `whenOnError` operator to intercept the error, but it may result in duplicated logging or users simply forget to handle the error case. Modifications: - Add `Single.subscribe(Consumer<? super T>, Consumer<? super Throwable>)`; - Add `Completable.subscribe(Runnable, Consumer<? super Throwable>)`; - Modify `SimpleSingleSubscriber/SimpleCompletableSubscriber` to handle error when `errorConsumer` is provided. Result: Users can easily handle error cases when they subscribe to `Single` or `Completable`.
mgodave
pushed a commit
to mgodave/servicetalk
that referenced
this pull request
Nov 19, 2024
…pple#3114) Use new `Single.subscribe(...)` overload introduced in [apple#3112](apple#3112) that takes `errorConsumer` to avoid using extra operator `whenOnError`. It will also help to avoid logging those exceptions by `SimpleSingleSubscriber` (hard to relate to a real request) and instead they will only bubble up on the caller path.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation:
Currently, users can consume the result or execute a
Runnablefor successful termination of aSingle/Completable. Failures will be logged at debug level. Users can only usewhenOnErroroperator to intercept the error, but it may result in duplicated logging or users simply forget to handle the error case.Modifications:
Single.subscribe(Consumer<? super T>, Consumer<? super Throwable>);Completable.subscribe(Runnable, Consumer<? super Throwable>);SimpleSingleSubscriber/SimpleCompletableSubscriberto handle error whenerrorConsumeris provided.Result:
Users can easily handle error cases when they subscribe to
SingleorCompletable.