refactor: move functionality out of ResourceConfiguration

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

Author: metacosm

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -213,8 +213,9 @@ public <P extends HasMetadata> RegisteredController<P> register(Reconciler<P> re
 
     controllerManager.add(controller);
 
-    final var watchedNS = configuration.watchAllNamespaces() ? "[all namespaces]"
-        : configuration.getEffectiveNamespaces();
+    final var informerConfig = configuration.getInformerConfig();
+    final var watchedNS = informerConfig.watchAllNamespaces() ? "[all namespaces]"
+        : informerConfig.getEffectiveNamespaces(configuration);
 
     log.info(
         "Registered reconciler: '{}' for resource: '{}' for namespace(s): {}",

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

@@ -86,7 +86,7 @@ default Class<P> getResourceClass() {
 
   @SuppressWarnings("unused")
   default Set<String> getEffectiveNamespaces() {
-    return ResourceConfiguration.super.getEffectiveNamespaces(this);
+    return getInformerConfig().getEffectiveNamespaces(this);
   }
 
   /**

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

@@ -35,15 +35,8 @@ public class ControllerConfigurationOverrider<R extends HasMetadata> {
   private ControllerConfigurationOverrider(ControllerConfiguration<R> original) {
     this.finalizer = original.getFinalizerName();
     this.generationAware = original.isGenerationAware();
-    this.config = InformerConfiguration.builder(original.getResourceClass())
-        .withName(name)
-        .withNamespaces(original.getNamespaces())
-        .withLabelSelector(original.getLabelSelector())
-        .withOnAddFilter(original.onAddFilter().orElse(null))
-        .withOnUpdateFilter(original.onUpdateFilter().orElse(null))
-        .withGenericFilter(original.genericFilter().orElse(null))
-        .withInformerListLimit(original.getInformerListLimit().orElse(null))
-        .withItemStore(original.getItemStore().orElse(null));
+    final var informerConfig = original.getInformerConfig();
+    this.config = InformerConfiguration.builder(informerConfig);
     this.retry = original.getRetry();
     this.reconciliationMaxInterval = original.maxReconciliationInterval().orElse(null);
     this.original = original;

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

@@ -1,24 +1,9 @@
 package io.javaoperatorsdk.operator.api.config;
 
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Optional;
-import java.util.Set;
-import java.util.stream.Collectors;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.fabric8.kubernetes.client.informers.cache.ItemStore;
-import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
-import io.javaoperatorsdk.operator.api.reconciler.Constants;
-import io.javaoperatorsdk.operator.processing.event.source.cache.BoundedItemStore;
-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 static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_NAMESPACES_SET;
-import static io.javaoperatorsdk.operator.api.reconciler.Constants.WATCH_CURRENT_NAMESPACE_SET;
 
 public interface ResourceConfiguration<R extends HasMetadata> {
 
@@ -28,134 +13,9 @@ default String getResourceTypeName() {
 
   InformerConfiguration<R> getInformerConfig();
 
-  default Optional<OnAddFilter<? super R>> onAddFilter() {
-    return Optional.ofNullable(getInformerConfig().getOnAddFilter());
-  }
-
-  default Optional<OnUpdateFilter<? super R>> onUpdateFilter() {
-    return Optional.ofNullable(getInformerConfig().getOnUpdateFilter());
-  }
-
-  default Optional<GenericFilter<? super R>> genericFilter() {
-    return Optional.ofNullable(getInformerConfig().getGenericFilter());
-  }
-
-  /**
-   * Retrieves the label selector that is used to filter which resources are actually watched by the
-   * associated event source. See the official documentation on the
-   * <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/">topic</a>
-   * for more details on syntax.
-   *
-   * @return the label selector filtering watched resources
-   */
-  default String getLabelSelector() {
-    return getInformerConfig().getLabelSelector();
-  }
-
-  static String ensureValidLabelSelector(String labelSelector) {
-    // might want to implement validation here?
-    return labelSelector;
-  }
-
   @SuppressWarnings("unchecked")
   default Class<R> getResourceClass() {
     return (Class<R>) Utils.getFirstTypeArgumentFromSuperClassOrInterface(getClass(),
         ResourceConfiguration.class);
   }
-
-  default Set<String> getNamespaces() {
-    return getInformerConfig().getNamespaces();
-  }
-
-  default boolean watchAllNamespaces() {
-    return allNamespacesWatched(getNamespaces());
-  }
-
-  static boolean allNamespacesWatched(Set<String> namespaces) {
-    failIfNotValid(namespaces);
-    return DEFAULT_NAMESPACES_SET.equals(namespaces);
-  }
-
-  default boolean watchCurrentNamespace() {
-    return currentNamespaceWatched(getNamespaces());
-  }
-
-  static boolean currentNamespaceWatched(Set<String> namespaces) {
-    failIfNotValid(namespaces);
-    return WATCH_CURRENT_NAMESPACE_SET.equals(namespaces);
-  }
-
-  static void failIfNotValid(Set<String> namespaces) {
-    if (namespaces != null && !namespaces.isEmpty()) {
-      final var present = namespaces.contains(Constants.WATCH_CURRENT_NAMESPACE)
-          || namespaces.contains(Constants.WATCH_ALL_NAMESPACES);
-      if (!present || namespaces.size() == 1) {
-        return;
-      }
-    }
-    throw new IllegalArgumentException(
-        "Must specify namespaces. To watch all namespaces, use only '"
-            + Constants.WATCH_ALL_NAMESPACES
-            + "'. To watch only the namespace in which the operator is deployed, use only '"
-            + Constants.WATCH_CURRENT_NAMESPACE + "'");
-  }
-
-  static Set<String> ensureValidNamespaces(Collection<String> namespaces) {
-    if (namespaces != null && !namespaces.isEmpty()) {
-      return namespaces.stream().map(String::trim).collect(Collectors.toSet());
-    } else {
-      return Constants.DEFAULT_NAMESPACES_SET;
-    }
-  }
-
-  /**
-   * Computes the effective namespaces based on the set specified by the user, in particular
-   * retrieves the current namespace from the client when the user specified that they wanted to
-   * watch the current namespace only.
-   *
-   * @return a Set of namespace names the associated controller will watch
-   */
-  default Set<String> getEffectiveNamespaces(ControllerConfiguration<?> controllerConfiguration) {
-    var targetNamespaces = getNamespaces();
-    if (watchCurrentNamespace()) {
-      final String namespace =
-          controllerConfiguration.getConfigurationService().getKubernetesClient().getConfiguration()
-              .getNamespace();
-      if (namespace == null) {
-        throw new OperatorException(
-            "Couldn't retrieve the currently connected namespace. Make sure it's correctly set in your ~/.kube/config file, using, e.g. 'kubectl config set-context <your context> --namespace=<your namespace>'");
-      }
-      targetNamespaces = Collections.singleton(namespace);
-    }
-    return targetNamespaces;
-  }
-
-  /**
-   * Replaces the item store in informer. See underlying <a href=
-   * "https://github.com/fabric8io/kubernetes-client/blob/43b67939fde91046ab7fb0c362f500c2b46eb59e/kubernetes-client/src/main/java/io/fabric8/kubernetes/client/informers/impl/DefaultSharedIndexInformer.java#L273">method</a>
-   * in fabric8 client informer implementation.
-   *
-   * <p>
-   * The main goal, is to be able to use limited caches or provide any custom implementation.
-   * </p>
-   *
-   * <p>
-   * See {@link BoundedItemStore} and <a href=
-   * "https://github.com/operator-framework/java-operator-sdk/blob/main/caffeine-bounded-cache-support/src/main/java/io/javaoperatorsdk/operator/processing/event/source/cache/CaffeineBoundedCache.java">CaffeineBoundedCache</a>
-   * </p>
-   *
-   * @return Optional {@link ItemStore} implementation. If present this item store will be used by
-   *         the informers.
-   */
-  default Optional<ItemStore<R>> getItemStore() {
-    return Optional.ofNullable(getInformerConfig().getItemStore());
-  }
-
-  /**
-   * The maximum amount of items to return for a single list call when starting an informer. If this
-   * is a not null it will result in paginating for the initial load of the informer cache.
-   */
-  default Optional<Long> getInformerListLimit() {
-    return Optional.ofNullable(getInformerConfig().getInformerListLimit());
-  }
 }

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

@@ -13,7 +13,7 @@
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnDeleteFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
 
-import static io.javaoperatorsdk.operator.api.config.informer.InformerEventSourceConfiguration.DEFAULT_FOLLOW_CONTROLLER_NAMESPACES_ON_CHANGE;
+import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_FOLLOW_CONTROLLER_NAMESPACES_ON_CHANGE;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_LONG_VALUE_SET;
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.NO_VALUE_SET;