feat: record resource class in InformerConfiguration

Signed-off-by: Chris Laprun <[email protected]>

Author: metacosm

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

@@ -2,20 +2,18 @@
 
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
 
 public interface ResourceConfiguration<R extends HasMetadata> {
 
   default String getResourceTypeName() {
-    return ReconcilerUtils.getResourceTypeName(getResourceClass());
+    return getInformerConfig().getResourceTypeName();
   }
 
   InformerConfiguration<R> getInformerConfig();
 
   @SuppressWarnings("unchecked")
   default Class<R> getResourceClass() {
-    return (Class<R>) Utils.getFirstTypeArgumentFromSuperClassOrInterface(getClass(),
-        ResourceConfiguration.class);
+    return getInformerConfig().getResourceClass();
   }
 }

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

@@ -5,9 +5,11 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 
+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.OperatorException;
+import io.javaoperatorsdk.operator.ReconcilerUtils;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.config.Utils;
 import io.javaoperatorsdk.operator.api.reconciler.Constants;
@@ -23,6 +25,8 @@
 @SuppressWarnings("unused")
 public class InformerConfiguration<R extends HasMetadata> {
   private final Builder builder = new Builder();
+  private final Class<R> resourceClass;
+  private final String resourceTypeName;
   private String name;
   private Set<String> namespaces;
   private Boolean followControllerNamespacesOnChange;
@@ -34,11 +38,12 @@ public class InformerConfiguration<R extends HasMetadata> {
   private ItemStore<R> itemStore;
   private Long informerListLimit;
 
-  public InformerConfiguration(String name, Set<String> namespaces,
+  protected InformerConfiguration(Class<R> resourceClass, String name, Set<String> namespaces,
       boolean followControllerNamespacesOnChange,
       String labelSelector, OnAddFilter<? super R> onAddFilter,
       OnUpdateFilter<? super R> onUpdateFilter, OnDeleteFilter<? super R> onDeleteFilter,
       GenericFilter<? super R> genericFilter, ItemStore<R> itemStore, Long informerListLimit) {
+    this(resourceClass);
     this.name = name;
     this.namespaces = namespaces;
     this.followControllerNamespacesOnChange = followControllerNamespacesOnChange;
@@ -51,23 +56,25 @@ public InformerConfiguration(String name, Set<String> namespaces,
     this.informerListLimit = informerListLimit;
   }
 
-  private InformerConfiguration() {}
-
-  @SuppressWarnings({"rawtypes", "unchecked"})
-  public static <R extends HasMetadata> InformerConfiguration<R>.Builder builder() {
-    return new InformerConfiguration().builder;
+  private InformerConfiguration(Class<R> resourceClass) {
+    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);
   }
 
   @SuppressWarnings({"rawtypes", "unchecked"})
   public static <R extends HasMetadata> InformerConfiguration<R>.Builder builder(
       Class<R> resourceClass) {
-    return new InformerConfiguration().builder;
+    return new InformerConfiguration(resourceClass).builder;
   }
 
   @SuppressWarnings({"rawtypes", "unchecked"})
   public static <R extends HasMetadata> InformerConfiguration<R>.Builder builder(
       InformerConfiguration<R> original) {
-    return new InformerConfiguration(original.name, original.namespaces,
+    return new InformerConfiguration(original.resourceClass, original.name, original.namespaces,
         original.followControllerNamespacesOnChange, original.labelSelector, original.onAddFilter,
         original.onUpdateFilter, original.onDeleteFilter, original.genericFilter,
         original.itemStore, original.informerListLimit).builder;
@@ -115,6 +122,14 @@ public static boolean inheritsNamespacesFromController(Set<String> namespaces) {
     return SAME_AS_CONTROLLER_NAMESPACES_SET.equals(namespaces);
   }
 
+  public Class<R> getResourceClass() {
+    return resourceClass;
+  }
+
+  public String getResourceTypeName() {
+    return resourceTypeName;
+  }
+
   public String getName() {
     return name;
   }

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

@@ -6,25 +6,32 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.ConfiguredDependentResource;
 
 @SuppressWarnings({"rawtypes", "unchecked"})
-public interface DependentResourceFactory<C extends ControllerConfiguration<?>> {
+public interface DependentResourceFactory<C extends ControllerConfiguration<?>, D extends DependentResourceSpec> {
 
   DependentResourceFactory DEFAULT = new DependentResourceFactory() {};
 
-  default DependentResource createFrom(DependentResourceSpec spec, C controllerConfiguration) {
+  default DependentResource createFrom(D spec, C controllerConfiguration) {
     final var dependentResourceClass = spec.getDependentResourceClass();
     return Utils.instantiateAndConfigureIfNeeded(dependentResourceClass,
         DependentResource.class,
         Utils.contextFor(controllerConfiguration, dependentResourceClass, Dependent.class),
         (instance) -> configure(instance, spec, controllerConfiguration));
   }
 
-  default void configure(DependentResource instance, DependentResourceSpec spec,
-      C controllerConfiguration) {
+  default void configure(DependentResource instance, D spec, C controllerConfiguration) {
     if (instance instanceof ConfiguredDependentResource configurable) {
       final var config = controllerConfiguration.getConfigurationFor(spec);
       if (config != null) {
         configurable.configureWith(config);
       }
     }
   }
+
+  default Class<?> associatedResourceType(D spec) {
+    final var dependentResourceClass = spec.getDependentResourceClass();
+    final var dr = Utils.instantiateAndConfigureIfNeeded(dependentResourceClass,
+        DependentResource.class,
+        null, null);
+    return dr != null ? dr.resourceType() : null;
+  }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentConverter.java

@@ -43,7 +43,10 @@ private InformerConfiguration<R> createInformerConfig(
     Class<? extends KubernetesDependentResource<?, ?>> dependentResourceClass =
         (Class<? extends KubernetesDependentResource<?, ?>>) spec.getDependentResourceClass();
 
-    InformerConfiguration<R>.Builder config = InformerConfiguration.builder();
+    final var resourceType = controllerConfig.getConfigurationService().dependentResourceFactory()
+        .associatedResourceType(spec);
+
+    InformerConfiguration<R>.Builder config = InformerConfiguration.builder(resourceType);
     if (configAnnotation != null) {
       final var informerConfig = configAnnotation.informer();
       final var context = Utils.contextFor(controllerConfig, dependentResourceClass,

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

@@ -173,16 +173,16 @@ public void broadcastOnResourceEvent(ResourceAction action, P resource, P oldRes
   }
 
   public void changeNamespaces(Set<String> namespaces) {
-    eventSources.controllerEventSource()
-        .changeNamespaces(namespaces);
-    executorServiceManager.boundedExecuteAndWaitForAllToComplete(eventSources
+    eventSources.controllerEventSource().changeNamespaces(namespaces);
+    final var namespaceChangeables = eventSources
         .additionalEventSources()
         .filter(NamespaceChangeable.class::isInstance)
         .map(NamespaceChangeable.class::cast)
-        .filter(NamespaceChangeable::allowsNamespaceChanges), e -> {
-          e.changeNamespaces(namespaces);
-          return null;
-        },
+        .filter(NamespaceChangeable::allowsNamespaceChanges);
+    executorServiceManager.boundedExecuteAndWaitForAllToComplete(namespaceChangeables, e -> {
+      e.changeNamespaces(namespaces);
+      return null;
+    },
         getEventSourceThreadNamer("changeNamespace"));
   }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/InformerConfigurationTest.java

@@ -5,6 +5,7 @@
 
 import org.junit.jupiter.api.Test;
 
+import io.fabric8.kubernetes.api.model.ConfigMap;
 import io.javaoperatorsdk.operator.api.config.informer.InformerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.Constants;
 
@@ -46,19 +47,21 @@ void currentNamespaceWatched() {
 
   @Test
   void nullLabelSelectorByDefault() {
-    final var informerConfig = InformerConfiguration.builder().buildForInformerEventSource();
+    final var informerConfig =
+        InformerConfiguration.builder(ConfigMap.class).buildForInformerEventSource();
     assertNull(informerConfig.getLabelSelector());
   }
 
   @Test
   void shouldWatchAllNamespacesByDefaultForControllers() {
-    final var informerConfig = InformerConfiguration.builder().buildForController();
+    final var informerConfig = InformerConfiguration.builder(ConfigMap.class).buildForController();
     assertTrue(informerConfig.watchAllNamespaces());
   }
 
   @Test
   void shouldFollowControllerNamespacesByDefaultForInformerEventSource() {
-    final var informerConfig = InformerConfiguration.builder().buildForInformerEventSource();
+    final var informerConfig =
+        InformerConfiguration.builder(ConfigMap.class).buildForInformerEventSource();
     assertTrue(informerConfig.isFollowControllerNamespacesOnChange());
   }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/EventSourceManagerTest.java

@@ -168,14 +168,13 @@ void changesNamespacesOnControllerAndInformerEventSources() {
     when(controllerResourceEventSourceMock.allowsNamespaceChanges()).thenCallRealMethod();
     var manager = new EventSourceManager(controller, eventSources);
 
-    InformerEventSourceConfiguration informerConfigurationMock =
+    InformerEventSourceConfiguration eventSourceConfigurationMock =
         mock(InformerEventSourceConfiguration.class);
-    when(informerConfigurationMock.followControllerNamespaceChanges()).thenReturn(true);
     InformerEventSource informerEventSource = mock(InformerEventSource.class);
     when(informerEventSource.name()).thenReturn("ies");
     when(informerEventSource.resourceType()).thenReturn(TestCustomResource.class);
-    when(informerEventSource.configuration()).thenReturn(informerConfigurationMock);
-    when(informerEventSource.allowsNamespaceChanges()).thenCallRealMethod();
+    when(informerEventSource.configuration()).thenReturn(eventSourceConfigurationMock);
+    when(informerEventSource.allowsNamespaceChanges()).thenReturn(true);
     manager.registerEventSource(informerEventSource);
 
     manager.changeNamespaces(Set.of(newNamespaces));

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageDependentsWorkflowReconciler.java

@@ -85,7 +85,7 @@ private void initDependentResources(KubernetesClient client) {
 
     Arrays.asList(configMapDR, deploymentDR, serviceDR, ingressDR)
         .forEach(dr -> dr.configureWith(new KubernetesDependentResourceConfigBuilder()
-            .withKubernetesDependentInformerConfig(InformerConfiguration.builder()
+            .withKubernetesDependentInformerConfig(InformerConfiguration.builder(dr.resourceType())
                 .withLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR)
                 .buildForInformerEventSource())
             .build()));

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java

@@ -96,7 +96,7 @@ private Workflow<WebPage> createDependentResourcesAndWorkflow() {
     // configure them with our label selector
     Arrays.asList(configMapDR, deploymentDR, serviceDR, ingressDR)
         .forEach(dr -> dr.configureWith(new KubernetesDependentResourceConfigBuilder()
-            .withKubernetesDependentInformerConfig(InformerConfiguration.builder()
+            .withKubernetesDependentInformerConfig(InformerConfiguration.builder(dr.resourceType())
                 .withLabelSelector(SELECTOR + "=true")
                 .buildForInformerEventSource())
             .build()));