Deprecate Repeat functionality (#366)

chemicL · web-flow · commit b2f2af307dfb · 2025-08-04T11:18:17.000+02:00
Following previous Retry mechanisms deprecation, the remainder of the reactor.retry package has been deprecated. An alternative is available in reactor-core and this package is intended for deletion in the next major version of reactor-addons. Resolves #293. --------- Signed-off-by: Dariusz Jędrzejczyk <dariusz.jedrzejczyk@broadcom.com>
diff --git a/reactor-extra/src/main/java/reactor/retry/AbstractRetry.java b/reactor-extra/src/main/java/reactor/retry/AbstractRetry.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -31,6 +31,12 @@
 import reactor.util.Loggers;
 import reactor.util.annotation.Nullable;
 
+/*
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat or
+ * reactor.util.retry available since reactor-core 3.8.0 which provides similar
+ * capabilities.
+ */
+@Deprecated
 public abstract class AbstractRetry<T, S> implements Function<Flux<S>, Publisher<Long>> {
 
 	static final Logger log = Loggers.getLogger(AbstractRetry.class);
diff --git a/reactor-extra/src/main/java/reactor/retry/Backoff.java b/reactor-extra/src/main/java/reactor/retry/Backoff.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2022 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -24,7 +24,11 @@
 /**
  * Backoff function
  *
+ * @deprecated To be removed in 3.7.0 at the earliest.
+ * Use reactor.util.repeat or reactor.util.retry available since reactor-core 3.8.0
+ * which provides similar capabilities.
  */
+@Deprecated
 public interface Backoff extends Function<IterationContext<?>, BackoffDelay> {
 
 	Backoff ZERO_BACKOFF = new Backoff() {
diff --git a/reactor-extra/src/main/java/reactor/retry/BackoffDelay.java b/reactor-extra/src/main/java/reactor/retry/BackoffDelay.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -18,6 +18,12 @@
 
 import java.time.Duration;
 
+/*
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat or
+ * reactor.util.retry available since reactor-core 3.8.0 which provides similar
+ * capabilities.
+ */
+@Deprecated
 public class BackoffDelay {
 
 	static final BackoffDelay ZERO = new BackoffDelay(Duration.ZERO) {
diff --git a/reactor-extra/src/main/java/reactor/retry/DefaultContext.java b/reactor-extra/src/main/java/reactor/retry/DefaultContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -18,6 +18,12 @@
 
 import java.time.Duration;
 
+/*
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat or
+ * reactor.util.retry available since reactor-core 3.8.0 which provides similar
+ * capabilities.
+ */
+@Deprecated
 public class DefaultContext<T> implements RetryContext<T>, RepeatContext<T> {
 
 	final T applicationContext;
diff --git a/reactor-extra/src/main/java/reactor/retry/DefaultRepeat.java b/reactor-extra/src/main/java/reactor/retry/DefaultRepeat.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -28,6 +28,11 @@
 import reactor.util.Logger;
 import reactor.util.Loggers;
 
+/*
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat.RepeatSpec
+ *  available since reactor-core 3.8.0 which provides similar capabilities.
+ */
+@Deprecated
 public class DefaultRepeat<T> extends AbstractRetry<T, Long> implements Repeat<T> {
 
 	static final Logger log = Loggers.getLogger(DefaultRepeat.class);
diff --git a/reactor-extra/src/main/java/reactor/retry/IterationContext.java b/reactor-extra/src/main/java/reactor/retry/IterationContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -22,7 +22,12 @@
  * Context provided to retry or repeat callbacks.
  *
  * @param <T> Application context type
+ *
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat or
+ * reactor.util.retry available since reactor-core 3.8.0 which provides similar
+ * capabilities.
  */
+@Deprecated
 public interface IterationContext<T> {
 
 	/**
diff --git a/reactor-extra/src/main/java/reactor/retry/Jitter.java b/reactor-extra/src/main/java/reactor/retry/Jitter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -23,7 +23,11 @@
 /**
  * Jitter function that is applied to the backoff delay.
  *
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat or
+ * reactor.util.retry available since reactor-core 3.8.0 which provides similar
+ * capabilities.
  */
+@Deprecated
 public interface Jitter extends Function<BackoffDelay, Duration> {
 
 	Jitter NO_JITTER = new Jitter() {
diff --git a/reactor-extra/src/main/java/reactor/retry/RandomJitter.java b/reactor-extra/src/main/java/reactor/retry/RandomJitter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2018-2025 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.
@@ -24,7 +24,12 @@
  * maintain that invariant on the randomized {@literal d}.
  *
  * @author Simon Baslé
+ *
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat or
+ * reactor.util.retry available since reactor-core 3.8.0 which provides similar
+ * capabilities.
  */
+@Deprecated
 class RandomJitter implements Jitter {
 
 	private final double randomFactor;
diff --git a/reactor-extra/src/main/java/reactor/retry/Repeat.java b/reactor-extra/src/main/java/reactor/retry/Repeat.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -52,7 +52,10 @@
  * to change both the timeout and limit the attempts.
  *
  * @param <T> Application context type
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat.RepeatSpec
+ * available since reactor-core 3.8.0 which provides similar capabilities.
  */
+@Deprecated
 public interface Repeat<T> extends Function<Flux<Long>, Publisher<Long>> {
 
 	/**
diff --git a/reactor-extra/src/main/java/reactor/retry/RepeatContext.java b/reactor-extra/src/main/java/reactor/retry/RepeatContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -24,7 +24,10 @@
  * the repeat callback {@link Repeat#doOnRepeat(java.util.function.Consumer)}.
  *
  * @param <T> Application context type
+ * @deprecated To be removed in 3.7.0 at the earliest. Use reactor.util.repeat.RepeatSpec
+ * available since reactor-core 3.8.0 which provides similar capabilities.
  */
+@Deprecated
 public interface RepeatContext<T> extends IterationContext<T> {
 
 	/**
diff --git a/reactor-extra/src/test/java/reactor/retry/AbstractRetryTest.java b/reactor-extra/src/test/java/reactor/retry/AbstractRetryTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2022 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2018-2025 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.
@@ -26,6 +26,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+@Deprecated
 public class AbstractRetryTest {
 
     @Test
diff --git a/reactor-extra/src/test/java/reactor/retry/BackoffDelayTest.java b/reactor-extra/src/test/java/reactor/retry/BackoffDelayTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -25,6 +25,7 @@
 /**
  * @author Simon Baslé
  */
+@Deprecated
 public class BackoffDelayTest {
 
 	@Test
diff --git a/reactor-extra/src/test/java/reactor/retry/BackoffTest.java b/reactor-extra/src/test/java/reactor/retry/BackoffTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2022 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -24,6 +24,7 @@
 
 import static org.assertj.core.api.Assertions.*;
 
+@Deprecated
 public class BackoffTest {
 
 	@Test
diff --git a/reactor-extra/src/test/java/reactor/retry/DefaultRepeatTest.java b/reactor-extra/src/test/java/reactor/retry/DefaultRepeatTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -22,6 +22,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+@Deprecated
 public class DefaultRepeatTest {
 
 	@Test
diff --git a/reactor-extra/src/test/java/reactor/retry/RandomJitterTest.java b/reactor-extra/src/test/java/reactor/retry/RandomJitterTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2018-2025 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.
@@ -26,6 +26,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
 
+@Deprecated
 public class RandomJitterTest {
 
 	@Test
diff --git a/reactor-extra/src/test/java/reactor/retry/RepeatTests.java b/reactor-extra/src/test/java/reactor/retry/RepeatTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -35,6 +35,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.*;
 
+@Deprecated
 public class RepeatTests {
 
 	private ConcurrentLinkedQueue<RepeatContext<?>> repeats = new ConcurrentLinkedQueue<>();
diff --git a/reactor-extra/src/test/java/reactor/retry/RetryTestUtils.java b/reactor-extra/src/test/java/reactor/retry/RetryTestUtils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2021 VMware Inc. or its affiliates, All Rights Reserved.
+ * Copyright (c) 2017-2025 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.
@@ -40,6 +40,7 @@
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 
+@Deprecated
 public class RetryTestUtils {
 
 	static void assertDelays(Queue<? extends IterationContext<?>> retries, Long... delayMs) {
