feat: Make @configured, @GradualRetry and @ratelimited Inherited (operator-framework#2091)

Author: Bram Meerten

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

@@ -1,9 +1,11 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
 import java.lang.annotation.Annotation;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 
+@Inherited
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Configured {
 

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

@@ -84,17 +84,8 @@ public static <C extends ControllerConfiguration<? extends HasMetadata>> Object
   private static ConfiguredClassPair getConfigured(
       Class<? extends DependentResource> dependentResourceClass) {
     Class<? extends DependentResource> currentClass = dependentResourceClass;
-    Configured configured;
-    ConfiguredClassPair result = null;
-    while (DependentResource.class.isAssignableFrom(currentClass)) {
-      configured = currentClass.getAnnotation(Configured.class);
-      if (configured != null) {
-        result = new ConfiguredClassPair(configured, currentClass);
-        break;
-      }
-      currentClass = (Class<? extends DependentResource>) currentClass.getSuperclass();
-    }
-    return result;
+    Configured configured = dependentResourceClass.getAnnotation(Configured.class);
+    return configured != null ? new ConfiguredClassPair(configured, currentClass) : null;
   }
 
   private static <C extends ControllerConfiguration<? extends HasMetadata>> ConverterAnnotationPair getOrCreateConverter(

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/rate/RateLimited.java

@@ -1,11 +1,13 @@
 package io.javaoperatorsdk.operator.processing.event.rate;
 
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import java.util.concurrent.TimeUnit;
 
+@Inherited
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
 public @interface RateLimited {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GradualRetry.java

@@ -1,10 +1,12 @@
 package io.javaoperatorsdk.operator.processing.retry;
 
 import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+@Inherited
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface GradualRetry {

operator-framework/src/test/java/io/javaoperatorsdk/operator/config/BaseConfigurationServiceTest.java

@@ -190,6 +190,18 @@ void configuringRateAndRetryViaAnnotationsShouldWork() {
     assertEquals(Duration.ofSeconds(3), rateLimiter.getRefreshPeriod());
   }
 
+  @Test
+  void configuringRateLimitAndGradualRetryViaSuperClassShouldWork() {
+    var config = configFor(new GradualRetryAndRateLimitedOnSuperClass());
+    final var retry = config.getRetry();
+    final var testRetry = assertInstanceOf(GenericRetry.class, retry);
+    assertEquals(BaseClassWithGradualRetryAndRateLimited.RETRY_MAX_ATTEMPTS, testRetry.getMaxAttempts());
+
+    final var rateLimiter = assertInstanceOf(LinearRateLimiter.class, config.getRateLimiter());
+    assertEquals(BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_MAX_RECONCILIATIONS, rateLimiter.getLimitForPeriod());
+    assertEquals(Duration.ofSeconds(BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_WITHIN_SECONDS), rateLimiter.getRefreshPeriod());
+  }
+
   @Test
   void checkingRetryingGraduallyWorks() {
     var config = configFor(new CheckRetryingGraduallyConfiguration());
@@ -382,6 +394,29 @@ public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap>
     }
   }
 
+  @ControllerConfiguration
+  private static class GradualRetryAndRateLimitedOnSuperClass
+          extends BaseClassWithGradualRetryAndRateLimited
+          implements Reconciler<ConfigMap> {
+
+    @Override
+    public UpdateControl<ConfigMap> reconcile(ConfigMap resource, Context<ConfigMap> context) throws Exception {
+      return null;
+    }
+  }
+
+  @RateLimited(
+          maxReconciliations = BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_MAX_RECONCILIATIONS,
+          within = BaseClassWithGradualRetryAndRateLimited.RATE_LIMITED_WITHIN_SECONDS
+  )
+  @GradualRetry(maxAttempts = BaseClassWithGradualRetryAndRateLimited.RETRY_MAX_ATTEMPTS)
+  private static class BaseClassWithGradualRetryAndRateLimited {
+
+    public static final int RATE_LIMITED_MAX_RECONCILIATIONS = 7;
+    public static final int RATE_LIMITED_WITHIN_SECONDS = 3;
+    public static final int RETRY_MAX_ATTEMPTS = 3;
+  }
+
   private static class ControllerConfigurationOnSuperClass extends BaseClass {
   }