-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
2.x: Add retry(times, predicate) to Single & Completable and verify behavior across them and Maybe. #5753
2.x: Add retry(times, predicate) to Single & Completable and verify behavior across them and Maybe. #5753
Changes from all commits
6251268
068f7dd
657dad9
a89cb4e
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 |
---|---|---|
|
@@ -2649,6 +2649,26 @@ public final Single<T> retry(BiPredicate<? super Integer, ? super Throwable> pre | |
return toSingle(toFlowable().retry(predicate)); | ||
} | ||
|
||
/** | ||
* Repeatedly re-subscribe at most times or until the predicate returns false, whichever happens first | ||
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. Let's make it more consistent with javadoc you've added for Completable? It didn't mention 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 should be yeah but if we only change this method then this one is inconsistent with all of the other Single methods. |
||
* if it fails with an onError. | ||
* <dl> | ||
* <dt><b>Scheduler:</b></dt> | ||
* <dd>{@code retry} does not operate by default on a particular {@link Scheduler}.</dd> | ||
* </dl> | ||
* @param times the number of times to resubscribe if the current Single fails | ||
* @param predicate the predicate called with the failure Throwable | ||
* and should return true if a resubscription should happen | ||
* @return the new Single instance | ||
* @since 2.1.8 - experimental | ||
*/ | ||
@Experimental | ||
@CheckReturnValue | ||
@SchedulerSupport(SchedulerSupport.NONE) | ||
public final Single<T> retry(long times, Predicate<? super Throwable> predicate) { | ||
return toSingle(toFlowable().retry(times, predicate)); | ||
} | ||
|
||
/** | ||
* Re-subscribe to the current Single if the given predicate returns true when the Single fails | ||
* with an onError. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
/** | ||
* Copyright (c) 2017-present, RxJava Contributors. | ||
* | ||
* 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 | ||
* | ||
* http://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 io.reactivex.completable; | ||
|
||
import io.reactivex.Completable; | ||
import io.reactivex.functions.Action; | ||
import io.reactivex.functions.Predicate; | ||
import io.reactivex.internal.functions.Functions; | ||
import java.util.concurrent.atomic.AtomicInteger; | ||
import org.junit.Test; | ||
|
||
import static org.junit.Assert.assertEquals; | ||
|
||
public class CompletableRetryTest { | ||
@Test | ||
public void retryTimesPredicateWithMatchingPredicate() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(3); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Completable.fromAction(new Action() { | ||
@Override public void run() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
|
||
throw new IllegalArgumentException(); | ||
} | ||
}) | ||
.retry(Integer.MAX_VALUE, new Predicate<Throwable>() { | ||
@Override public boolean test(final Throwable throwable) throws Exception { | ||
return !(throwable instanceof IllegalArgumentException); | ||
} | ||
}) | ||
.test() | ||
.assertFailure(IllegalArgumentException.class); | ||
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. hm, I believe you should check atomicInteger value here to verify actual number of action retries 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. Same below and in tests for other reactive types |
||
|
||
assertEquals(3, numberOfSubscribeCalls.get()); | ||
} | ||
|
||
@Test | ||
public void retryTimesPredicateWithMatchingRetryAmount() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(3); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Completable.fromAction(new Action() { | ||
@Override public void run() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
} | ||
}) | ||
.retry(2, Functions.alwaysTrue()) | ||
.test() | ||
.assertResult(); | ||
|
||
assertEquals(3, numberOfSubscribeCalls.get()); | ||
} | ||
|
||
@Test | ||
public void retryTimesPredicateWithNotMatchingRetryAmount() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(3); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Completable.fromAction(new Action() { | ||
@Override public void run() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
} | ||
}) | ||
.retry(1, Functions.alwaysTrue()) | ||
.test() | ||
.assertFailure(RuntimeException.class); | ||
|
||
assertEquals(2, numberOfSubscribeCalls.get()); | ||
} | ||
|
||
@Test | ||
public void retryTimesPredicateWithZeroRetries() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(2); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Completable.fromAction(new Action() { | ||
@Override public void run() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
} | ||
}) | ||
.retry(0, Functions.alwaysTrue()) | ||
.test() | ||
.assertFailure(RuntimeException.class); | ||
|
||
assertEquals(1, numberOfSubscribeCalls.get()); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
/** | ||
* Copyright (c) 2017-present, RxJava Contributors. | ||
* | ||
* 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 | ||
* | ||
* http://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 io.reactivex.maybe; | ||
|
||
import io.reactivex.Maybe; | ||
import io.reactivex.functions.Predicate; | ||
import io.reactivex.internal.functions.Functions; | ||
import java.util.concurrent.Callable; | ||
import java.util.concurrent.atomic.AtomicInteger; | ||
import org.junit.Test; | ||
|
||
import static org.junit.Assert.assertEquals; | ||
|
||
public class MaybeRetryTest { | ||
@Test | ||
public void retryTimesPredicateWithMatchingPredicate() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(3); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Maybe.fromCallable(new Callable<Boolean>() { | ||
@Override public Boolean call() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
|
||
throw new IllegalArgumentException(); | ||
} | ||
}) | ||
.retry(Integer.MAX_VALUE, new Predicate<Throwable>() { | ||
@Override public boolean test(final Throwable throwable) throws Exception { | ||
return !(throwable instanceof IllegalArgumentException); | ||
} | ||
}) | ||
.test() | ||
.assertFailure(IllegalArgumentException.class); | ||
|
||
assertEquals(3, numberOfSubscribeCalls.get()); | ||
} | ||
|
||
@Test | ||
public void retryTimesPredicateWithMatchingRetryAmount() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(3); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Maybe.fromCallable(new Callable<Boolean>() { | ||
@Override public Boolean call() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
|
||
return true; | ||
} | ||
}) | ||
.retry(2, Functions.alwaysTrue()) | ||
.test() | ||
.assertResult(true); | ||
|
||
assertEquals(3, numberOfSubscribeCalls.get()); | ||
} | ||
|
||
@Test | ||
public void retryTimesPredicateWithNotMatchingRetryAmount() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(3); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Maybe.fromCallable(new Callable<Boolean>() { | ||
@Override public Boolean call() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
|
||
return true; | ||
} | ||
}) | ||
.retry(1, Functions.alwaysTrue()) | ||
.test() | ||
.assertFailure(RuntimeException.class); | ||
|
||
assertEquals(2, numberOfSubscribeCalls.get()); | ||
} | ||
|
||
@Test | ||
public void retryTimesPredicateWithZeroRetries() { | ||
final AtomicInteger atomicInteger = new AtomicInteger(2); | ||
final AtomicInteger numberOfSubscribeCalls = new AtomicInteger(0); | ||
|
||
Maybe.fromCallable(new Callable<Boolean>() { | ||
@Override public Boolean call() throws Exception { | ||
numberOfSubscribeCalls.incrementAndGet(); | ||
|
||
if (atomicInteger.decrementAndGet() != 0) { | ||
throw new RuntimeException(); | ||
} | ||
|
||
return true; | ||
} | ||
}) | ||
.retry(0, Functions.alwaysTrue()) | ||
.test() | ||
.assertFailure(RuntimeException.class); | ||
|
||
assertEquals(1, numberOfSubscribeCalls.get()); | ||
} | ||
} |
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.
nit: Phrasing seems a little bit off here, something like "Returns a Completable that retries when …" sounds more natural I guess
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.
I kept this in sync with all of the other retry* java doc sentences.
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.
uh, yeah all rx types have different phrasing for retry operator, alight