refactor: remove backwards compatibility as impact should be low

Author: metacosm

docs/documentation/v3-1-migration.md

@@ -7,6 +7,11 @@ permalink: /docs/v3-1-migration
 
 # Migrating from v3 to v3.1
 
+## ReconciliationMaxInterval Annotation has been renamed to MaxReconciliationInterval
+
+Associated methods on both the `ControllerConfiguration` class and annotation have also been
+renamed accordingly.
+
 ## Workflows Impact on Managed Dependent Resources Behavior
 
 Version 3.1 comes with a workflow engine that replaces the previous behavior of managed dependent

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AnnotationControllerConfiguration.java

@@ -147,34 +147,13 @@ public ResourceEventFilter<P> getEventFilter() {
     return answer != null ? answer : ResourceEventFilters.passthrough();
   }
 
-  @Override
-  public Optional<Duration> reconciliationMaxInterval() {
-    return maxReconciliationInterval();
-  }
-
   @Override
   public Optional<Duration> maxReconciliationInterval() {
-    Duration oldStyle = null;
-    final var oldConfig = annotation.reconciliationMaxInterval();
-    if (oldConfig != null && oldConfig.interval() > 0) {
-      oldStyle = Duration.of(oldConfig.interval(), oldConfig.timeUnit().toChronoUnit());
-    }
-
-    Duration duration = null;
     final var newConfig = annotation.maxReconciliationInterval();
     if (newConfig != null && newConfig.interval() > 0) {
-      duration = Duration.of(newConfig.interval(), newConfig.timeUnit().toChronoUnit());
-    }
-
-    if (duration != null && oldStyle != null) {
-      log.debug(
-          "Both maxReconciliationInterval ({}) and deprecated reconciliationMaxInterval ({}) are used, keeping the non-deprecated value: {}",
-          duration, oldStyle, duration);
-    }
-    if (duration == null && oldStyle != null) {
-      return Optional.of(oldStyle);
+      return Optional.of(Duration.of(newConfig.interval(), newConfig.timeUnit().toChronoUnit()));
     }
-    return Optional.ofNullable(duration);
+    return Optional.empty();
   }
 
   @Override

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -19,6 +19,7 @@
 
 public interface ControllerConfiguration<R extends HasMetadata> extends ResourceConfiguration<R> {
 
+  @SuppressWarnings("rawtypes")
   RateLimiter DEFAULT_RATE_LIMITER = LinearRateLimiter.deactivatedRateLimiter();
 
   default String getName() {
@@ -83,15 +84,6 @@ default Optional<Duration> maxReconciliationInterval() {
     return Optional.of(Duration.ofHours(MaxReconciliationInterval.DEFAULT_INTERVAL));
   }
 
-  /**
-   *
-   * @deprecated use {@link #maxReconciliationInterval()} instead
-   */
-  @Deprecated(forRemoval = true)
-  default Optional<Duration> reconciliationMaxInterval() {
-    return Optional.of(Duration.ofHours(MaxReconciliationInterval.DEFAULT_INTERVAL));
-  }
-
   @SuppressWarnings("unused")
   default ConfigurationService getConfigurationService() {
     return ConfigurationServiceProvider.instance();

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ControllerConfiguration.java

@@ -87,17 +87,6 @@
    **/
   Class<? extends GenericFilter<? extends HasMetadata>> genericFilter() default VoidGenericFilter.class;
 
-  /**
-   * Optional configuration of the maximal interval the SDK will wait for a reconciliation request
-   * to happen before one will be automatically triggered.
-   *
-   * @return the maximal interval configuration
-   * @deprecated use {@link #maxReconciliationInterval()} instead
-   */
-  @Deprecated(forRemoval = true)
-  ReconciliationMaxInterval reconciliationMaxInterval() default @ReconciliationMaxInterval(
-      interval = MaxReconciliationInterval.DEFAULT_INTERVAL);
-
   /**
    * Optional configuration of the maximal interval the SDK will wait for a reconciliation request
    * to happen before one will be automatically triggered.

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ReconciliationMaxInterval.java

@@ -21,7 +21,6 @@
 import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.MaxReconciliationInterval;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
-import io.javaoperatorsdk.operator.api.reconciler.ReconciliationMaxInterval;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
@@ -133,7 +132,7 @@ && findByNameOptional(dependents, DependentResource.defaultNameFor(ReadOnlyDepen
   }
 
   @Test
-  void newMaxIntervalShouldTakePrecedence() {
+  void maxIntervalCanBeConfigured() {
     var config = new AnnotationControllerConfiguration<>(new MaxIntervalReconciler());
     assertEquals(50, config.maxReconciliationInterval().map(Duration::getSeconds).orElseThrow());
   }
@@ -179,8 +178,6 @@ void checkingRetryingGraduallyWorks() {
 
   @ControllerConfiguration(
       maxReconciliationInterval = @MaxReconciliationInterval(interval = 50,
-          timeUnit = TimeUnit.SECONDS),
-      reconciliationMaxInterval = @ReconciliationMaxInterval(interval = 20,
           timeUnit = TimeUnit.SECONDS))
   private static class MaxIntervalReconciler implements Reconciler<ConfigMap> {