-
Notifications
You must be signed in to change notification settings - Fork 648
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
Use FutureMono instead of Mono#fromCompletionStage #2565
Merged
Merged
Changes from all commits
Commits
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 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
204 changes: 204 additions & 0 deletions
204
reactor-netty5-core/src/main/java/reactor/netty5/FutureMono.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| /* | ||
| * Copyright (c) 2011-2022 VMware, Inc. or its affiliates, All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package reactor.netty5; | ||
|
|
||
| import java.nio.channels.ClosedChannelException; | ||
| import java.util.Objects; | ||
| import java.util.function.Supplier; | ||
|
|
||
| import io.netty5.util.concurrent.Future; | ||
| import io.netty5.util.concurrent.FutureListener; | ||
| import org.reactivestreams.Subscriber; | ||
| import org.reactivestreams.Subscription; | ||
| import reactor.core.CoreSubscriber; | ||
| import reactor.core.publisher.Mono; | ||
| import reactor.core.publisher.Operators; | ||
| import reactor.netty5.channel.AbortedException; | ||
| import reactor.util.context.Context; | ||
|
|
||
| /** | ||
| * Convert Netty Future into void {@link Mono}. | ||
| * | ||
| * @author Stephane Maldini | ||
| */ | ||
| public abstract class FutureMono extends Mono<Void> { | ||
|
|
||
| /** | ||
| * Convert a {@link Future} into {@link Mono}. {@link Mono#subscribe(Subscriber)} | ||
| * will bridge to {@link Future#addListener(FutureListener)}. | ||
| * | ||
| * @param future the future to convert from | ||
| * @param <F> the future type | ||
| * | ||
| * @return A {@link Mono} forwarding {@link Future} success or failure | ||
| */ | ||
| public static <F extends Future<Void>> Mono<Void> from(F future) { | ||
| Objects.requireNonNull(future, "future"); | ||
| if (future.isDone()) { | ||
| if (!future.isSuccess()) { | ||
| return Mono.error(FutureSubscription.wrapError(future.cause())); | ||
| } | ||
| return Mono.empty(); | ||
| } | ||
| return new ImmediateFutureMono<>(future); | ||
| } | ||
|
|
||
| /** | ||
| * Convert a supplied {@link Future} for each subscriber into {@link Mono}. | ||
| * {@link Mono#subscribe(Subscriber)} | ||
| * will bridge to {@link Future#addListener(FutureListener)}. | ||
| * | ||
| * @param deferredFuture the future to evaluate and convert from | ||
| * @param <F> the future type | ||
| * | ||
| * @return A {@link Mono} forwarding {@link Future} success or failure | ||
| */ | ||
| public static <F extends Future<Void>> Mono<Void> deferFuture(Supplier<F> deferredFuture) { | ||
| return new DeferredFutureMono<>(deferredFuture); | ||
| } | ||
|
|
||
| final static class ImmediateFutureMono<F extends Future<Void>> extends FutureMono { | ||
|
|
||
| final F future; | ||
|
|
||
| ImmediateFutureMono(F future) { | ||
| this.future = Objects.requireNonNull(future, "future"); | ||
| } | ||
|
|
||
| @Override | ||
| public void subscribe(final CoreSubscriber<? super Void> s) { | ||
| doSubscribe(s, future); | ||
| } | ||
| } | ||
|
|
||
| final static class DeferredFutureMono<F extends Future<Void>> extends FutureMono { | ||
|
|
||
| final Supplier<F> deferredFuture; | ||
|
|
||
| DeferredFutureMono(Supplier<F> deferredFuture) { | ||
| this.deferredFuture = | ||
| Objects.requireNonNull(deferredFuture, "deferredFuture"); | ||
| } | ||
|
|
||
| @Override | ||
| public void subscribe(CoreSubscriber<? super Void> s) { | ||
| F f; | ||
| try { | ||
| f = deferredFuture.get(); | ||
| } | ||
| catch (Throwable t) { | ||
| Operators.error(s, t); | ||
| return; | ||
| } | ||
|
|
||
| if (f == null) { | ||
| Operators.error(s, | ||
| Operators.onOperatorError(new NullPointerException( | ||
| "Deferred supplied null"), s.currentContext())); | ||
| return; | ||
| } | ||
|
|
||
| doSubscribe(s, f); | ||
| } | ||
| } | ||
|
|
||
| static <F extends Future<Void>> void doSubscribe(CoreSubscriber<? super Void> s, F future) { | ||
| if (future.isDone()) { | ||
| if (future.isSuccess()) { | ||
| Operators.complete(s); | ||
| } | ||
| else { | ||
| Operators.error(s, FutureSubscription.wrapError(future.cause())); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| FutureSubscription<F> fs = new FutureSubscription<>(future, s); | ||
| // propagate subscription before adding listener to avoid any race between finishing future and onSubscribe | ||
| // is called | ||
| s.onSubscribe(fs); | ||
|
|
||
| // check if subscription was not cancelled immediately. | ||
| if (fs.cancelled) { | ||
| // if so do nothing anymore | ||
| return; | ||
| } | ||
|
|
||
| // add listener to the future to propagate on complete when future is done | ||
| // addListener likely to be thread safe method | ||
| future.addListener(fs); | ||
|
|
||
| // check once again if is cancelled to see if we need to removeListener in case addListener racing with | ||
| // subscription.cancel (which should remove listener) | ||
| if (fs.cancelled) { | ||
| // future.removeListener(fs); TODO | ||
| } | ||
| } | ||
|
|
||
| final static class FutureSubscription<F extends Future<Void>> | ||
| implements FutureListener<Void>, Subscription, Supplier<Context> { | ||
|
|
||
| final CoreSubscriber<? super Void> s; | ||
|
|
||
| final F future; | ||
|
|
||
| boolean cancelled; | ||
|
|
||
| FutureSubscription(F future, CoreSubscriber<? super Void> s) { | ||
| this.s = s; | ||
| this.future = future; | ||
| } | ||
|
|
||
| @Override | ||
| public void request(long n) { | ||
| //noop | ||
| } | ||
|
|
||
| @Override | ||
| public Context get() { | ||
| return s.currentContext(); | ||
| } | ||
|
|
||
| @Override | ||
| public void cancel() { | ||
| // cancel is not thread safe since we assume that removeListener is thread-safe. That said if we have | ||
| // concurrent addListener and removeListener and if addListener is after removeListener, the other Thread | ||
| // after execution addListener should see changes happened before removeListener. Thus, it should see | ||
| // cancelled flag set to true and should cleanup added handler | ||
| this.cancelled = true; | ||
| // future.removeListener(this); TODO | ||
| } | ||
|
|
||
| @Override | ||
| public void operationComplete(Future<? extends Void> future) { | ||
| if (!future.isSuccess()) { | ||
| s.onError(wrapError(future.cause())); | ||
| } | ||
| else { | ||
| s.onComplete(); | ||
| } | ||
| } | ||
|
|
||
| private static Throwable wrapError(Throwable error) { | ||
| if (error instanceof ClosedChannelException) { | ||
| return new AbortedException(error); | ||
| } | ||
| else { | ||
| return error; | ||
| } | ||
| } | ||
| } | ||
| } | ||
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you leave the line 147 commented on purpose ?
I ask this because apparently, listeners can't be removed anymore from Future in netty5. So is there something else that still needs to be implemented in case the subscription is cancelled ? If not, then can we remove the lines between L144-L148 ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the moment we will keep these TODOs until we are sure that we don't need them. This will happen post M3 release.