Add publishOn/subscribeOn Executor overload
#2155
Merged
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: The signature of `publishOn(Executor)` and `subscribeOn(Executor)` methods changed between 0.41 and 0.42 from `io.servicetalk.concurrent.api.Executor` to the more general parent type `io.servicetalk.concurrent.api.Executor`. This is a source compatible change since the new type is a parent of the old type, but is not a binary compatible change; code compiled against 0.41 will not run with 0.42 as it will not find the method it expects with the `io.servicetalk.concurrent.api.Executor` signature. Modifications: Add overloads `publishOn(Executor)` and `subscribeOn(Executor)` for `io.servicetalk.concurrent.Executor`. For binary compatibility with 0.42 it will also be necessary to cast executors to `io.servicetalk.concurrent.api.Executor` to ensure that the correct overload is used. Result: Improved compatibility with ServiceTalk 0.42
bondolo
added
enhancement
Scottmitch
reviewed
Mar 18, 2022
servicetalk-concurrent-api/src/main/java/io/servicetalk/concurrent/api/Completable.java
Show resolved
Hide resolved
servicetalk-concurrent-api/src/main/java/io/servicetalk/concurrent/api/Completable.java
Outdated
Show resolved
Hide resolved
Scottmitch
requested changes
Mar 18, 2022
| * @param executor {@link Executor} to use. | ||
| * @return A new {@link Completable} that will use the passed {@link Executor} to invoke all methods of | ||
| * {@link Cancellable} and {@link #handleSubscribe(CompletableSource.Subscriber)}. | ||
| * @deprecated For compatibility with 0.42 convert to using {@link #publishOn(io.servicetalk.concurrent.Executor)} |
| * @param executor {@link Executor} to use. | ||
| * @return A new {@link Publisher} that will use the passed {@link Executor} to invoke all methods of | ||
| * {@link Subscription} and {@link #handleSubscribe(PublisherSource.Subscriber)}. | ||
| * @deprecated For compatibility with 0.42 convert to using {@link #publishOn(io.servicetalk.concurrent.Executor)} |
| * @param executor {@link Executor} to use. | ||
| * @return A new {@link Single} that will use the passed {@link Executor} to invoke all methods of | ||
| * {@link Cancellable} and {@link #handleSubscribe(SingleSource.Subscriber)}. | ||
| * @deprecated For compatibility with 0.42 convert to using {@link #publishOn(io.servicetalk.concurrent.Executor)} |
| * @param executor {@link Executor} to use. | ||
| * @return A new {@link Completable} that will use the passed {@link Executor} to invoke all methods on the | ||
| * {@link Subscriber}. | ||
| * @deprecated For compatibility with 0.42 convert to using {@link #publishOn(io.servicetalk.concurrent.Executor)} |
There was a problem hiding this comment.
For compatibility with 0.42 convert to using {@link #publishOn(io.servicetalk.concurrent.Executor)} instead. -> Use {@link #publishOn(io.servicetalk.concurrent.Executor)}.. Consider minimizing the dialog here, deprecation implies it is removed in future releases.
|
feel free to merge after comments addressed. |
Scottmitch
approved these changes
Mar 18, 2022
I converted only one set of usages in the current tests to ensure that the new code was exercised, but otherwise left all of the other references in 0.41 using the deprecated method. |
idelpivnitskiy
requested changes
Mar 18, 2022
servicetalk-concurrent-api/src/main/java/io/servicetalk/concurrent/api/Completable.java
Show resolved
Hide resolved
idelpivnitskiy
approved these changes
Mar 18, 2022
servicetalk-concurrent-api/src/main/java/io/servicetalk/concurrent/api/Completable.java
Show resolved
Hide resolved
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:
The signature of
publishOn(Executor)andsubscribeOn(Executor)methods changed between 0.41 and 0.42 from
io.servicetalk.concurrent.api.Executorto the more general parenttype
io.servicetalk.concurrent.api.Executor. This is a sourcecompatible change since the new type is a parent of the old type, but
is not a binary compatible change; code compiled against 0.41 will not
run with 0.42 as it will not find the method it expects with the
io.servicetalk.concurrent.api.Executorsignature.Modifications:
Add overloads
publishOn(Executor)andsubscribeOn(Executor)forio.servicetalk.concurrent.Executor. For binary compatibility with0.42 it will also be necessary to cast executors to
io.servicetalk.concurrent.api.Executorto ensure that the correctoverload is used.
Result:
Improved compatibility with ServiceTalk 0.42