feat: move controller informer-related configuration to InformerConfig

Signed-off-by: Chris Laprun <claprun@redhat.com>

Author: metacosm

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

@@ -13,7 +13,6 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.KubernetesClient;
-import io.fabric8.kubernetes.client.informers.cache.ItemStore;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.Utils.Configurator;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceConfigurationResolver;
@@ -24,11 +23,9 @@
 import io.javaoperatorsdk.operator.api.reconciler.Workflow;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Dependent;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfigHolder;
 import io.javaoperatorsdk.operator.processing.dependent.workflow.Condition;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
 import io.javaoperatorsdk.operator.processing.retry.Retry;
 
 import static io.javaoperatorsdk.operator.api.config.ControllerConfiguration.CONTROLLER_NAME_AS_FIELD_MANAGER;
@@ -278,43 +275,20 @@ private <P extends HasMetadata> ResolvedControllerConfiguration<P> controllerCon
         fieldManager.equals(CONTROLLER_NAME_AS_FIELD_MANAGER) ? name
             : fieldManager;
 
-    var informerListLimitValue = valueOrDefaultFromAnnotation(annotation,
-        io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::informerListLimit,
-        "informerListLimit");
-    final var informerListLimit =
-        informerListLimitValue == Constants.NO_LONG_VALUE_SET ? null
-            : informerListLimitValue;
+    InformerConfigHolder<P> informerConfig = InformerConfigHolder.builder(resourceClass)
+        .initFromAnnotation(annotation != null ? annotation.informerConfig() : null, context)
+        .buildForController();
 
     return new ResolvedControllerConfiguration<P>(
         resourceClass, name, generationAware,
         associatedReconcilerClass, retry, rateLimiter,
         ResolvedControllerConfiguration.getMaxReconciliationInterval(interval, timeUnit),
-        Utils.instantiate(valueOrDefaultFromAnnotation(annotation,
-            io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::onAddFilter,
-            "onAddFilter"), OnAddFilter.class, context),
-        Utils.instantiate(valueOrDefaultFromAnnotation(annotation,
-            io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::onUpdateFilter,
-            "onUpdateFilter"), OnUpdateFilter.class, context),
-        Utils.instantiate(valueOrDefaultFromAnnotation(annotation,
-            io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::genericFilter,
-            "genericFilter"), GenericFilter.class, context),
-        Set.of(valueOrDefaultFromAnnotation(annotation,
-            io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::namespaces,
-            "namespaces")),
         valueOrDefaultFromAnnotation(annotation,
             io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::finalizerName,
             "finalizerName"),
-        valueOrDefaultFromAnnotation(annotation,
-            io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::labelSelector,
-            "labelSelector"),
         null,
-        Utils.instantiate(
-            valueOrDefaultFromAnnotation(annotation,
-                io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration::itemStore,
-                "itemStore"),
-            ItemStore.class, context),
         dependentFieldManager,
-        this, informerListLimit);
+        this, informerConfig);
   }
 
 
@@ -326,6 +300,4 @@ protected boolean createIfNeeded() {
   public boolean checkCRDAndValidateLocalModel() {
     return Utils.shouldCheckCRDAndValidateLocalModel();
   }
-
-
 }

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

@@ -10,6 +10,7 @@
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.informers.cache.ItemStore;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfigHolder;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
@@ -189,12 +190,26 @@ public ControllerConfigurationOverrider<R> replacingNamedDependentResourceConfig
   }
 
   public ControllerConfiguration<R> build() {
+    // todo: should use an informer builder directly and share code across similar builders
+    InformerConfigHolder<R> informerConfig =
+        InformerConfigHolder.builder(original.getResourceClass())
+            .withLabelSelector(labelSelector)
+            .withItemStore(itemStore)
+            .withInformerListLimit(informerListLimit)
+            .withName(name)
+            .withNamespaces(namespaces)
+            .withOnAddFilter(onAddFilter)
+            .withOnUpdateFilter(onUpdateFilter)
+            .withGenericFilter(genericFilter)
+            .buildForController();
+
     return new ResolvedControllerConfiguration<>(original.getResourceClass(),
         name,
         generationAware, original.getAssociatedReconcilerClassName(), retry, rateLimiter,
-        reconciliationMaxInterval, onAddFilter, onUpdateFilter, genericFilter,
-        namespaces, finalizer, labelSelector, configurations, itemStore, fieldManager,
-        original.getConfigurationService(), informerListLimit,
+        reconciliationMaxInterval,
+        finalizer, configurations, fieldManager,
+        original.getConfigurationService(),
+        informerConfig,
         original.getWorkflowSpec().orElse(null));
   }
 

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

@@ -1,92 +1,41 @@
 package io.javaoperatorsdk.operator.api.config;
 
-import java.util.Optional;
-import java.util.Set;
 
 import io.fabric8.kubernetes.api.model.GenericKubernetesResource;
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.fabric8.kubernetes.client.informers.cache.ItemStore;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
-import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfigHolder;
 
 public class DefaultResourceConfiguration<R extends HasMetadata>
     implements ResourceConfiguration<R> {
 
   private final Class<R> resourceClass;
   private final String resourceTypeName;
-  private final OnAddFilter<? super R> onAddFilter;
-  private final OnUpdateFilter<? super R> onUpdateFilter;
-  private final GenericFilter<? super R> genericFilter;
-  private final String labelSelector;
-  private final Set<String> namespaces;
-  private final ItemStore<R> itemStore;
-  private final Long informerListLimit;
+  private final InformerConfigHolder<R> informerConfig;
 
   protected DefaultResourceConfiguration(Class<R> resourceClass,
-      Set<String> namespaces, String labelSelector, OnAddFilter<? super R> onAddFilter,
-      OnUpdateFilter<? super R> onUpdateFilter, GenericFilter<? super R> genericFilter,
-      ItemStore<R> itemStore, Long informerListLimit) {
+      InformerConfigHolder<R> informerConfig) {
     this.resourceClass = resourceClass;
     this.resourceTypeName = resourceClass.isAssignableFrom(GenericKubernetesResource.class)
         // in general this is irrelevant now for secondary resources it is used just by controller
         // where GenericKubernetesResource now does not apply
         ? GenericKubernetesResource.class.getSimpleName()
         : ReconcilerUtils.getResourceTypeName(resourceClass);
-    this.onAddFilter = onAddFilter;
-    this.onUpdateFilter = onUpdateFilter;
-    this.genericFilter = genericFilter;
-
-    this.namespaces = ResourceConfiguration.ensureValidNamespaces(namespaces);
-    this.labelSelector = ResourceConfiguration.ensureValidLabelSelector(labelSelector);
-    this.itemStore = itemStore;
-    this.informerListLimit = informerListLimit;
+    this.informerConfig = informerConfig;
   }
 
   @Override
   public String getResourceTypeName() {
     return resourceTypeName;
   }
 
-  @Override
-  public String getLabelSelector() {
-    return labelSelector;
-  }
-
-  @Override
-  public Set<String> getNamespaces() {
-    return namespaces;
-  }
-
   @Override
   public Class<R> getResourceClass() {
     return resourceClass;
   }
 
   @Override
-  public Optional<OnAddFilter<? super R>> onAddFilter() {
-    return Optional.ofNullable(onAddFilter);
-  }
-
-  @Override
-  public Optional<OnUpdateFilter<? super R>> onUpdateFilter() {
-    return Optional.ofNullable(onUpdateFilter);
+  public InformerConfigHolder<R> getInformerConfig() {
+    return informerConfig;
   }
-
-  @Override
-  public Optional<GenericFilter<? super R>> genericFilter() {
-    return Optional.ofNullable(genericFilter);
-  }
-
-  @Override
-  public Optional<ItemStore<R>> getItemStore() {
-    return Optional.ofNullable(itemStore);
-  }
-
-  @Override
-  public Optional<Long> getInformerListLimit() {
-    return Optional.ofNullable(informerListLimit);
-  }
-
 }

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

@@ -4,18 +4,14 @@
 import java.util.Collections;
 import java.util.Map;
 import java.util.Optional;
-import java.util.Set;
 import java.util.concurrent.TimeUnit;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.fabric8.kubernetes.client.informers.cache.ItemStore;
 import io.javaoperatorsdk.operator.api.config.dependent.DependentResourceSpec;
 import io.javaoperatorsdk.operator.api.config.workflow.WorkflowSpec;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.processing.dependent.kubernetes.InformerConfigHolder;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
-import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
 import io.javaoperatorsdk.operator.processing.retry.Retry;
 
 @SuppressWarnings("rawtypes")
@@ -31,7 +27,6 @@ public class ResolvedControllerConfiguration<P extends HasMetadata>
   private final Duration maxReconciliationInterval;
   private final String finalizer;
   private final Map<DependentResourceSpec, Object> configurations;
-  private final ItemStore<P> itemStore;
   private final ConfigurationService configurationService;
   private final String fieldManager;
   private WorkflowSpec workflowSpec;
@@ -40,60 +35,35 @@ public ResolvedControllerConfiguration(Class<P> resourceClass, ControllerConfigu
     this(resourceClass, other.getName(), other.isGenerationAware(),
         other.getAssociatedReconcilerClassName(), other.getRetry(), other.getRateLimiter(),
         other.maxReconciliationInterval().orElse(null),
-        other.onAddFilter().orElse(null), other.onUpdateFilter().orElse(null),
-        other.genericFilter().orElse(null),
-        other.getNamespaces(),
-        other.getFinalizerName(), other.getLabelSelector(), Collections.emptyMap(),
-        other.getItemStore().orElse(null), other.fieldManager(),
+        other.getFinalizerName(), Collections.emptyMap(),
+        other.fieldManager(),
         other.getConfigurationService(),
-        other.getInformerListLimit().orElse(null), other.getWorkflowSpec().orElse(null));
-  }
-
-  public static Duration getMaxReconciliationInterval(long interval, TimeUnit timeUnit) {
-    return interval > 0 ? Duration.of(interval, timeUnit.toChronoUnit()) : null;
-  }
-
-  public static String getAssociatedReconcilerClassName(
-      Class<? extends Reconciler> reconcilerClass) {
-    return reconcilerClass.getCanonicalName();
-  }
-
-  protected Retry ensureRetry(Retry given) {
-    return given == null ? ControllerConfiguration.super.getRetry() : given;
-  }
-
-  protected RateLimiter ensureRateLimiter(RateLimiter given) {
-    return given == null ? ControllerConfiguration.super.getRateLimiter() : given;
+        other.getInformerConfig(),
+        other.getWorkflowSpec().orElse(null));
   }
 
   public ResolvedControllerConfiguration(Class<P> resourceClass, String name,
       boolean generationAware, String associatedReconcilerClassName, Retry retry,
       RateLimiter rateLimiter, Duration maxReconciliationInterval,
-      OnAddFilter<? super P> onAddFilter, OnUpdateFilter<? super P> onUpdateFilter,
-      GenericFilter<? super P> genericFilter,
-      Set<String> namespaces, String finalizer, String labelSelector,
-      Map<DependentResourceSpec, Object> configurations, ItemStore<P> itemStore,
+      String finalizer,
+      Map<DependentResourceSpec, Object> configurations,
       String fieldManager,
-      ConfigurationService configurationService, Long informerListLimit,
+      ConfigurationService configurationService,
+      InformerConfigHolder<P> informerConfig,
       WorkflowSpec workflowSpec) {
     this(resourceClass, name, generationAware, associatedReconcilerClassName, retry, rateLimiter,
-        maxReconciliationInterval, onAddFilter, onUpdateFilter, genericFilter,
-        namespaces, finalizer, labelSelector, configurations, itemStore, fieldManager,
-        configurationService, informerListLimit);
+        maxReconciliationInterval, finalizer, configurations, fieldManager,
+        configurationService, informerConfig);
     setWorkflowSpec(workflowSpec);
   }
 
   protected ResolvedControllerConfiguration(Class<P> resourceClass, String name,
       boolean generationAware, String associatedReconcilerClassName, Retry retry,
-      RateLimiter rateLimiter, Duration maxReconciliationInterval,
-      OnAddFilter<? super P> onAddFilter, OnUpdateFilter<? super P> onUpdateFilter,
-      GenericFilter<? super P> genericFilter,
-      Set<String> namespaces, String finalizer, String labelSelector,
-      Map<DependentResourceSpec, Object> configurations, ItemStore<P> itemStore,
+      RateLimiter rateLimiter, Duration maxReconciliationInterval, String finalizer,
+      Map<DependentResourceSpec, Object> configurations,
       String fieldManager,
-      ConfigurationService configurationService, Long informerListLimit) {
-    super(resourceClass, namespaces, labelSelector, onAddFilter, onUpdateFilter, genericFilter,
-        itemStore, informerListLimit);
+      ConfigurationService configurationService, InformerConfigHolder<P> informerConfig) {
+    super(resourceClass, informerConfig);
     this.configurationService = configurationService;
     this.name = ControllerConfiguration.ensureValidName(name, associatedReconcilerClassName);
     this.generationAware = generationAware;
@@ -102,7 +72,6 @@ protected ResolvedControllerConfiguration(Class<P> resourceClass, String name,
     this.rateLimiter = ensureRateLimiter(rateLimiter);
     this.maxReconciliationInterval = maxReconciliationInterval;
     this.configurations = configurations != null ? configurations : Collections.emptyMap();
-    this.itemStore = itemStore;
     this.finalizer =
         ControllerConfiguration.ensureValidFinalizerName(finalizer, getResourceTypeName());
     this.fieldManager = fieldManager;
@@ -111,8 +80,25 @@ protected ResolvedControllerConfiguration(Class<P> resourceClass, String name,
   protected ResolvedControllerConfiguration(Class<P> resourceClass, String name,
       Class<? extends Reconciler> reconcilerClas, ConfigurationService configurationService) {
     this(resourceClass, name, false, getAssociatedReconcilerClassName(reconcilerClas), null, null,
-        null, null, null, null, null,
-        null, null, null, null, null, configurationService, null);
+        null, null, null, null, configurationService,
+        InformerConfigHolder.builder(resourceClass).buildForController());
+  }
+
+  public static Duration getMaxReconciliationInterval(long interval, TimeUnit timeUnit) {
+    return interval > 0 ? Duration.of(interval, timeUnit.toChronoUnit()) : null;
+  }
+
+  public static String getAssociatedReconcilerClassName(
+      Class<? extends Reconciler> reconcilerClass) {
+    return reconcilerClass.getCanonicalName();
+  }
+
+  protected Retry ensureRetry(Retry given) {
+    return given == null ? ControllerConfiguration.super.getRetry() : given;
+  }
+
+  protected RateLimiter ensureRateLimiter(RateLimiter given) {
+    return given == null ? ControllerConfiguration.super.getRateLimiter() : given;
   }
 
   @Override
@@ -177,11 +163,6 @@ public <C> C getConfigurationFor(DependentResourceSpec<?, P, C> spec) {
     return (C) config;
   }
 
-  @Override
-  public Optional<ItemStore<P>> getItemStore() {
-    return Optional.ofNullable(itemStore);
-  }
-
   @Override
   public String fieldManager() {
     return fieldManager;