feat: extract specific interfaces for primary/secondary retriever

metacosm · metacosm · commit 395ddb10e8ec · 2021-12-03T09:42:11.000+01:00
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DefaultDependentResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DefaultDependentResourceConfiguration.java
@@ -1,34 +1,34 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
 import java.util.Set;
-import java.util.function.Function;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.api.config.DefaultResourceConfiguration;
-import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryRetriever;
+import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
 
 public class DefaultDependentResourceConfiguration<R extends HasMetadata>
     extends DefaultResourceConfiguration<R, DependentResourceConfiguration<R>>
     implements DependentResourceConfiguration<R> {
   private final boolean creatable;
   private final boolean updatable;
   private final boolean owned;
-  private final Function<R, Set<ResourceID>> secondaryToPrimariesMapper;
-  private final Function<HasMetadata, R> primaryToSecondaryMapper;
+  private final PrimaryResourcesRetriever<R> associatedPrimaries;
+  private final AssociatedSecondaryRetriever<R> associatedSecondary;
   private final boolean skipUpdateIfUnchanged;
 
   public DefaultDependentResourceConfiguration(String crdName, Class<R> resourceClass,
       Set<String> namespaces, String labelSelector,
       ConfigurationService service, boolean creatable, boolean updatable, boolean owned,
-      Function<R, Set<ResourceID>> secondaryToPrimariesMapper,
-      Function<HasMetadata, R> primaryToSecondaryMapper, boolean skipUpdateIfUnchanged) {
+      PrimaryResourcesRetriever<R> associatedPrimaries,
+      AssociatedSecondaryRetriever<R> associatedSecondary, boolean skipUpdateIfUnchanged) {
     super(crdName, resourceClass, namespaces, labelSelector, service);
     this.creatable = creatable;
     this.updatable = updatable;
     this.owned = owned;
-    this.secondaryToPrimariesMapper = secondaryToPrimariesMapper;
-    this.primaryToSecondaryMapper = primaryToSecondaryMapper;
+    this.associatedPrimaries = associatedPrimaries;
+    this.associatedSecondary = associatedSecondary;
     this.skipUpdateIfUnchanged = skipUpdateIfUnchanged;
   }
 
@@ -48,13 +48,13 @@ public boolean owned() {
   }
 
   @Override
-  public Function<R, Set<ResourceID>> getSecondaryToPrimaryResourcesMapper() {
-    return secondaryToPrimariesMapper;
+  public PrimaryResourcesRetriever<R> getPrimaryResourcesRetriever() {
+    return associatedPrimaries;
   }
 
   @Override
-  public Function<HasMetadata, R> getSecondaryResourceAssociatedWithPrimaryMapper() {
-    return primaryToSecondaryMapper;
+  public AssociatedSecondaryRetriever<R> getAssociatedResourceRetriever() {
+    return associatedSecondary;
   }
 
   @Override
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/dependent/DependentResourceConfiguration.java
@@ -1,12 +1,10 @@
 package io.javaoperatorsdk.operator.api.config.dependent;
 
-import java.util.Set;
-import java.util.function.Function;
-
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.config.ResourceConfiguration;
-import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryRetriever;
 import io.javaoperatorsdk.operator.processing.event.source.Mappers;
+import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
 
 import static io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfiguration.CREATABLE_DEFAULT;
 import static io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResourceConfiguration.OWNED_DEFAULT;
@@ -27,11 +25,11 @@ default boolean owned() {
     return OWNED_DEFAULT;
   }
 
-  default Function<R, Set<ResourceID>> getSecondaryToPrimaryResourcesMapper() {
+  default PrimaryResourcesRetriever<R> getPrimaryResourcesRetriever() {
     return Mappers.fromOwnerReference();
   }
 
-  Function<HasMetadata, R> getSecondaryResourceAssociatedWithPrimaryMapper();
+  AssociatedSecondaryRetriever<R> getAssociatedResourceRetriever();
 
   default boolean skipUpdateIfUnchanged() {
     return true;
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResourceConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/DependentResourceConfiguration.java
@@ -1,10 +1,12 @@
 package io.javaoperatorsdk.operator.api.reconciler.dependent;
 
 import java.util.Set;
-import java.util.function.Function;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.AssociatedSecondaryRetriever;
+import io.javaoperatorsdk.operator.processing.event.source.EventSourceRegistry;
+import io.javaoperatorsdk.operator.processing.event.source.PrimaryResourcesRetriever;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceCache;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventFilter;
 
@@ -30,9 +32,9 @@
 
   Class<? extends Fetcher> fetcher() default DEFAULT_FETCHER.class;
 
-  Class<? extends Function<? extends HasMetadata, Set<ResourceID>>> associatedPrimariesMapper() default DEFAULT_PRIMARIES_MAPPER.class;
+  Class<? extends PrimaryResourcesRetriever> associatedPrimariesRetriever() default DEFAULT_PRIMARIES_RETRIEVER.class;
 
-  Class<? extends Function<? extends HasMetadata, ? extends HasMetadata>> associatedSecondaryMapper() default DEFAULT_SECONDARY_MAPPER.class;
+  Class<? extends AssociatedSecondaryRetriever> associatedSecondaryRetriever() default DEFAULT_SECONDARY_RETRIEVER.class;
 
   boolean skipUpdateIfUnchanged() default SKIP_UPDATE_DEFAULT;
 
@@ -87,18 +89,19 @@ public HasMetadata fetchFor(HasMetadata owner, ResourceCache cache) {
     }
   }
 
-  final class DEFAULT_PRIMARIES_MAPPER implements Function<HasMetadata, Set<ResourceID>> {
+  final class DEFAULT_PRIMARIES_RETRIEVER implements PrimaryResourcesRetriever<HasMetadata> {
 
     @Override
-    public Set<ResourceID> apply(HasMetadata hasMetadata) {
+    public Set<ResourceID> associatedPrimaryResources(HasMetadata dependentResource,
+        EventSourceRegistry registry) {
       return null;
     }
   }
 
-  final class DEFAULT_SECONDARY_MAPPER implements Function<HasMetadata, HasMetadata> {
+  final class DEFAULT_SECONDARY_RETRIEVER implements AssociatedSecondaryRetriever<HasMetadata> {
 
     @Override
-    public HasMetadata apply(HasMetadata hasMetadata) {
+    public HasMetadata associatedSecondary(HasMetadata primary, EventSourceRegistry registry) {
       return null;
     }
   }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/Controller.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/Controller.java
@@ -154,8 +154,8 @@ protected ResourceEventFilter initFilter(ResourceConfiguration configuration) {
         protected EventSourceWrapper wrapEventSource(
             FilterWatchListDeletable filteredBySelectorClient, Cloner cloner) {
           return new InformerEventSourceEventSourceWrapper(filteredBySelectorClient, cloner,
-              dependentConfiguration.getSecondaryToPrimaryResourcesMapper(),
-              dependentConfiguration.getSecondaryResourceAssociatedWithPrimaryMapper(),
+              dependentConfiguration.getPrimaryResourcesRetriever(),
+              dependentConfiguration.getAssociatedResourceRetriever(),
               dependentConfiguration.skipUpdateIfUnchanged());
         }
       };
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java
@@ -95,6 +95,7 @@ public final void registerEventSource(EventSource eventSource)
     try {
       eventSources.add(eventSource);
       eventSource.setEventHandler(eventProcessor);
+      eventSource.setEventRegistry(this);
     } catch (Throwable e) {
       if (e instanceof IllegalStateException || e instanceof MissingCRDException) {
         // leave untouched
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/AbstractEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/AbstractEventSource.java
@@ -5,9 +5,20 @@
 public abstract class AbstractEventSource implements EventSource {
 
   protected volatile EventHandler eventHandler;
+  protected volatile EventSourceRegistry eventSourceRegistry;
 
   @Override
   public void setEventHandler(EventHandler eventHandler) {
     this.eventHandler = eventHandler;
   }
+
+  @Override
+  public void setEventRegistry(EventSourceRegistry registry) {
+    this.eventSourceRegistry = registry;
+  }
+
+  @Override
+  public EventSourceRegistry getEventRegistry() {
+    return eventSourceRegistry;
+  }
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/AssociatedSecondaryRetriever.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/AssociatedSecondaryRetriever.java
@@ -0,0 +1,8 @@
+package io.javaoperatorsdk.operator.processing.event.source;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+
+@FunctionalInterface
+public interface AssociatedSecondaryRetriever<T extends HasMetadata> {
+  T associatedSecondary(HasMetadata primary, EventSourceRegistry registry);
+}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/EventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/EventSource.java
@@ -8,6 +8,10 @@ public interface EventSource extends LifecycleAware {
 
   void setEventHandler(EventHandler eventHandler);
 
+  void setEventRegistry(EventSourceRegistry registry);
+
+  EventSourceRegistry getEventRegistry();
+
   /**
    * Automatically called when a custom resource is deleted from the cluster.
    *
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/InformerEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/InformerEventSource.java
@@ -1,8 +1,6 @@
 package io.javaoperatorsdk.operator.processing.event.source;
 
 import java.util.Objects;
-import java.util.Set;
-import java.util.function.Function;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -20,35 +18,35 @@ public class InformerEventSource<T extends HasMetadata> extends AbstractEventSou
   private static final Logger log = LoggerFactory.getLogger(InformerEventSource.class);
 
   private final SharedInformer<T> sharedInformer;
-  private final Function<T, Set<ResourceID>> secondaryToPrimaryResourcesIdSet;
-  private final Function<HasMetadata, T> associatedWith;
+  private final PrimaryResourcesRetriever<T> associatedPrimaries;
+  private final AssociatedSecondaryRetriever<T> associatedWith;
   private final boolean skipUpdateEventPropagationIfNoChange;
   private final ResourceCache<T> cache;
 
   public InformerEventSource(SharedInformer<T> sharedInformer,
-      Function<T, Set<ResourceID>> resourceToTargetResourceIDSet, Cloner cloner) {
-    this(sharedInformer, resourceToTargetResourceIDSet, null, true, cloner);
+      PrimaryResourcesRetriever<T> associatedPrimaries, Cloner cloner) {
+    this(sharedInformer, associatedPrimaries, null, true, cloner);
   }
 
   public InformerEventSource(KubernetesClient client, Class<T> type,
-      Function<T, Set<ResourceID>> resourceToTargetResourceIDSet, Cloner cloner) {
-    this(client, type, resourceToTargetResourceIDSet, false, cloner);
+      PrimaryResourcesRetriever<T> associatedPrimaries, Cloner cloner) {
+    this(client, type, associatedPrimaries, false, cloner);
   }
 
   InformerEventSource(KubernetesClient client, Class<T> type,
-      Function<T, Set<ResourceID>> resourceToTargetResourceIDSet,
+      PrimaryResourcesRetriever<T> associatedPrimaries,
       boolean skipUpdateEventPropagationIfNoChange, Cloner cloner) {
-    this(client.informers().sharedIndexInformerFor(type, 0), resourceToTargetResourceIDSet, null,
+    this(client.informers().sharedIndexInformerFor(type, 0), associatedPrimaries, null,
         skipUpdateEventPropagationIfNoChange, cloner);
   }
 
   public InformerEventSource(SharedInformer<T> sharedInformer,
-      Function<T, Set<ResourceID>> resourceToTargetResourceIDSet,
-      Function<HasMetadata, T> associatedWith,
+      PrimaryResourcesRetriever<T> associatedPrimaries,
+      AssociatedSecondaryRetriever<T> associatedWith,
       boolean skipUpdateEventPropagationIfNoChange,
       Cloner cloner) {
     this.sharedInformer = sharedInformer;
-    this.secondaryToPrimaryResourcesIdSet = resourceToTargetResourceIDSet;
+    this.associatedPrimaries = associatedPrimaries;
     this.skipUpdateEventPropagationIfNoChange = skipUpdateEventPropagationIfNoChange;
     if (sharedInformer.isRunning()) {
       log.warn(
@@ -58,7 +56,7 @@ public InformerEventSource(SharedInformer<T> sharedInformer,
     this.cache = new InformerResourceCache<T>(sharedInformer, cloner);
 
     this.associatedWith = Objects.requireNonNullElseGet(associatedWith,
-        () -> cr -> cache.get(ResourceID.fromResource(cr)).orElse(null));
+        () -> (cr, registry) -> cache.get(ResourceID.fromResource(cr)).orElse(null));
 
     sharedInformer.addEventHandler(new ResourceEventHandler<>() {
       @Override
@@ -84,7 +82,8 @@ public void onDelete(T t, boolean b) {
   }
 
   private void propagateEvent(T object) {
-    var primaryResourceIdSet = secondaryToPrimaryResourcesIdSet.apply(object);
+    var primaryResourceIdSet =
+        associatedPrimaries.associatedPrimaryResources(object, eventSourceRegistry);
     if (primaryResourceIdSet.isEmpty()) {
       return;
     }
@@ -123,7 +122,7 @@ public ResourceCache<T> getCache() {
    * @return the informed resource associated with the specified primary resource
    */
   public T getAssociated(HasMetadata resource) {
-    return associatedWith.apply(resource);
+    return associatedWith.associatedSecondary(resource, eventSourceRegistry);
   }
 
 }
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/InformerEventSourceEventSourceWrapper.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/InformerEventSourceEventSourceWrapper.java
@@ -1,8 +1,6 @@
 package io.javaoperatorsdk.operator.processing.event.source;
 
 import java.util.Optional;
-import java.util.Set;
-import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.stream.Stream;
 
@@ -21,8 +19,9 @@ public class InformerEventSourceEventSourceWrapper<T extends HasMetadata> implem
 
   public InformerEventSourceEventSourceWrapper(
       FilterWatchListDeletable<T, KubernetesResourceList<T>> client, Cloner cloner,
-      Function<T, Set<ResourceID>> secondaryToPrimaryResourcesIdSet,
-      Function<HasMetadata, T> associatedWith, boolean skipUpdateEventPropagationIfNoChange) {
+      PrimaryResourcesRetriever<T> secondaryToPrimaryResourcesIdSet,
+      AssociatedSecondaryRetriever<T> associatedWith,
+      boolean skipUpdateEventPropagationIfNoChange) {
     final var informer = client.runnableInformer(0);
     source = new InformerEventSource<>(informer,
         secondaryToPrimaryResourcesIdSet,
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/Mappers.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/Mappers.java
@@ -2,36 +2,35 @@
 
 import java.util.Collections;
 import java.util.Set;
-import java.util.function.Function;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
 public class Mappers {
 
-  public static <T extends HasMetadata> Function<T, Set<ResourceID>> fromAnnotation(
+  public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromAnnotation(
       String nameKey) {
     return fromMetadata(nameKey, null, false);
   }
 
-  public static <T extends HasMetadata> Function<T, Set<ResourceID>> fromAnnotation(
+  public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromAnnotation(
       String nameKey, String namespaceKey) {
     return fromMetadata(nameKey, namespaceKey, false);
   }
 
-  public static <T extends HasMetadata> Function<T, Set<ResourceID>> fromLabel(
+  public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromLabel(
       String nameKey) {
     return fromMetadata(nameKey, null, true);
   }
 
-  public static <T extends HasMetadata> Function<T, Set<ResourceID>> fromLabel(
+  public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromLabel(
       String nameKey, String namespaceKey) {
     return fromMetadata(nameKey, namespaceKey, true);
   }
 
-  private static <T extends HasMetadata> Function<T, Set<ResourceID>> fromMetadata(
+  private static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromMetadata(
       String nameKey, String namespaceKey, boolean isLabel) {
-    return resource -> {
+    return (resource, registry) -> {
       final var metadata = resource.getMetadata();
       if (metadata == null) {
         return Collections.emptySet();
@@ -45,8 +44,8 @@ private static <T extends HasMetadata> Function<T, Set<ResourceID>> fromMetadata
     };
   }
 
-  public static <T extends HasMetadata> Function<T, Set<ResourceID>> fromOwnerReference() {
-    return resource -> {
+  public static <T extends HasMetadata> PrimaryResourcesRetriever<T> fromOwnerReference() {
+    return (resource, registry) -> {
       var ownerReferences = resource.getMetadata().getOwnerReferences();
       if (!ownerReferences.isEmpty()) {
         return Set.of(new ResourceID(ownerReferences.get(0).getName(),
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/PrimaryResourcesRetriever.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/PrimaryResourcesRetriever.java
@@ -0,0 +1,11 @@
+package io.javaoperatorsdk.operator.processing.event.source;
+
+import java.util.Set;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.processing.event.ResourceID;
+
+@FunctionalInterface
+public interface PrimaryResourcesRetriever<T extends HasMetadata> {
+  Set<ResourceID> associatedPrimaryResources(T dependentResource, EventSourceRegistry registry);
+}
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,10 @@ public interface EventSource extends LifecycleAware {`
`8`	`8`
`9`	`9`	`void setEventHandler(EventHandler eventHandler);`
`10`	`10`
	`11`	`+ void setEventRegistry(EventSourceRegistry registry);`
	`12`	`+`
	`13`	`+ EventSourceRegistry getEventRegistry();`
	`14`	`+`
`11`	`15`	`/**`
`12`	`16`	`* Automatically called when a custom resource is deleted from the cluster.`
`13`	`17`	`*`