feat: improvements on caching and dependent resources

Author: csviri

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

@@ -17,6 +17,7 @@ default <T> Optional<T> getSecondaryResource(Class<T> expectedType) {
 
   <T> Set<T> getSecondaryResources(Class<T> expectedType);
 
+  @Deprecated(forRemoval = true)
   <T> Optional<T> getSecondaryResource(Class<T> expectedType, String eventSourceName);
 
   ControllerConfiguration<P> getControllerConfiguration();

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

@@ -10,7 +10,7 @@
  * @param <R> the dependent resource type
  * @param <P> the associated primary resource type
  */
-public interface DependentResource<R, P extends HasMetadata> extends ResourceOwner<R, P> {
+public interface DependentResource<R, P extends HasMetadata> {
 
   /**
    * Reconciles the dependent resource given the desired primary state
@@ -21,6 +21,13 @@ public interface DependentResource<R, P extends HasMetadata> extends ResourceOwn
    */
   ReconcileResult<R> reconcile(P primary, Context<P> context);
 
+  /**
+   * Retrieves the resource type associated with this ResourceOwner
+   *
+   * @return the resource type associated with this ResourceOwner
+   */
+  Class<R> resourceType();
+
   /**
    * Computes a default name for the specified DependentResource class
    *

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

@@ -1,5 +1,7 @@
 package io.javaoperatorsdk.operator.processing.dependent;
 
+import java.util.Optional;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -27,9 +29,10 @@ public AbstractDependentResource() {
     updater = updatable ? (Updater<R, P>) this : null;
   }
 
+  @SuppressWarnings("unchecked")
   @Override
   public ReconcileResult<R> reconcile(P primary, Context<P> context) {
-    var maybeActual = getSecondaryResource(primary);
+    Optional<R> maybeActual = getSecondaryResource(primary, context);
     if (creatable || updatable) {
       if (maybeActual.isEmpty()) {
         if (creatable) {
@@ -62,6 +65,10 @@ public ReconcileResult<R> reconcile(P primary, Context<P> context) {
     return ReconcileResult.noOperation(maybeActual.orElse(null));
   }
 
+  protected Optional<R> getSecondaryResource(P primary, Context<P> context) {
+    return context.getSecondaryResource(resourceType());
+  }
+
   private void throwIfNull(R desired, P primary, String descriptor) {
     if (desired == null) {
       throw new DependentResourceException(

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractCachingDependentResource.java

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.processing.dependent.external;
 
-import java.util.Optional;
-
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.processing.dependent.AbstractEventSourceHolderDependentResource;
@@ -22,8 +20,4 @@ public Class<R> resourceType() {
     return resourceType;
   }
 
-  @Override
-  public Optional<R> getSecondaryResource(P primaryResource) {
-    return eventSource().getSecondaryResource(primaryResource);
-  }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResource.java

@@ -33,7 +33,7 @@ public AbstractSimpleDependentResource(UpdatableCache<R> cache) {
   }
 
   @Override
-  public Optional<R> getSecondaryResource(HasMetadata primaryResource) {
+  public Optional<R> getSecondaryResource(P primaryResource, Context<P> context) {
     return cache.get(ResourceID.fromResource(primaryResource));
   }
 

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

@@ -1,7 +1,6 @@
 package io.javaoperatorsdk.operator.processing.dependent.kubernetes;
 
 import java.util.HashMap;
-import java.util.Optional;
 import java.util.Set;
 
 import org.slf4j.Logger;
@@ -138,7 +137,7 @@ public Result<R> match(R actualResource, P primary, Context<P> context) {
   }
 
   public void delete(P primary, Context<P> context) {
-    var resource = getSecondaryResource(primary);
+    var resource = context.getSecondaryResource(primary.getClass());
     resource.ifPresent(r -> client.resource(r).delete());
   }
 
@@ -208,10 +207,7 @@ public Class<R> resourceType() {
     return resourceType;
   }
 
-  @Override
-  public Optional<R> getSecondaryResource(P primaryResource) {
-    return eventSource().getSecondaryResource(primaryResource);
-  }
+
 
   @Override
   public void setKubernetesClient(KubernetesClient kubernetesClient) {

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

@@ -1,6 +1,5 @@
 package io.javaoperatorsdk.operator.api.config;
 
-import java.util.Optional;
 import java.util.Set;
 
 import org.junit.jupiter.api.Test;
@@ -84,10 +83,6 @@ public Class<Object> resourceType() {
         return Object.class;
       }
 
-      @Override
-      public Optional<Object> getSecondaryResource(ConfigMap primary) {
-        return Optional.empty();
-      }
     }
   }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/AbstractDependentResourceTest.java

@@ -16,7 +16,6 @@
 
 class AbstractDependentResourceTest {
 
-
   @Test
   void throwsExceptionIfDesiredIsNullOnCreate() {
     TestDependentResource testDependentResource = new TestDependentResource();
@@ -80,7 +79,8 @@ public Class<ConfigMap> resourceType() {
     }
 
     @Override
-    public Optional<ConfigMap> getSecondaryResource(TestCustomResource primary) {
+    protected Optional<ConfigMap> getSecondaryResource(TestCustomResource primary,
+        Context<TestCustomResource> context) {
       return Optional.ofNullable(secondary);
     }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/EmptyTestDependentResource.java

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.processing.dependent;
 
-import java.util.Optional;
-
 import io.fabric8.kubernetes.api.model.apps.Deployment;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.DependentResource;
@@ -17,11 +15,6 @@ public ReconcileResult<Deployment> reconcile(TestCustomResource primary,
     return null;
   }
 
-  @Override
-  public Optional<Deployment> getSecondaryResource(TestCustomResource primaryResource) {
-    return Optional.empty();
-  }
-
   @Override
   public Class<Deployment> resourceType() {
     return Deployment.class;

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractSimpleDependentResourceTest.java

@@ -45,14 +45,14 @@ void getsTheResourceFromSupplyIfReconciling() {
     simpleDependentResource.reconcile(TestUtils.testCustomResource1(), null);
 
     verify(supplierMock, times(1)).get();
-    assertThat(simpleDependentResource.getSecondaryResource(TestUtils.testCustomResource1()))
+    assertThat(simpleDependentResource.getSecondaryResource(TestUtils.testCustomResource1(), null))
         .isPresent()
         .isEqualTo(Optional.of(SampleExternalResource.testResource1()));
   }
 
   @Test
   void getResourceReadsTheResourceFromCache() {
-    simpleDependentResource.getSecondaryResource(TestUtils.testCustomResource1());
+    simpleDependentResource.getSecondaryResource(TestUtils.testCustomResource1(), null);
 
     verify(supplierMock, times(0)).get();
     verify(updatableCacheMock, times(1)).get(any());

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/dependent/workflow/AbstractWorkflowExecutorTest.java

@@ -3,7 +3,6 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.Optional;
 
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
@@ -49,11 +48,6 @@ public Class<String> resourceType() {
       return String.class;
     }
 
-    @Override
-    public Optional<String> getSecondaryResource(TestCustomResource primary) {
-      return Optional.of(VALUE);
-    }
-
     @Override
     public String toString() {
       return name;
@@ -113,11 +107,6 @@ public Class<String> resourceType() {
       return String.class;
     }
 
-    @Override
-    public Optional<String> getSecondaryResource(TestCustomResource primary) {
-      return Optional.of(VALUE);
-    }
-
     @Override
     public String toString() {
       return name;

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/standalonedependent/StandaloneDependentTestReconciler.java

@@ -47,7 +47,7 @@ public UpdateControl<StandaloneDependentTestCustomResource> reconcile(
       StandaloneDependentTestCustomResource primary,
       Context<StandaloneDependentTestCustomResource> context) {
     deploymentDependent.reconcile(primary, context);
-    Optional<Deployment> deployment = deploymentDependent.getSecondaryResource(primary);
+    Optional<Deployment> deployment = context.getSecondaryResource(Deployment.class);
     if (deployment.isEmpty()) {
       throw new IllegalStateException("Resource should not be empty after reconcile.");
     }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/workflowallfeature/ConfigMapDeletePostCondition.java

@@ -17,7 +17,7 @@ public class ConfigMapDeletePostCondition
   public boolean isMet(
       DependentResource<ConfigMap, WorkflowAllFeatureCustomResource> dependentResource,
       WorkflowAllFeatureCustomResource primary, Context<WorkflowAllFeatureCustomResource> context) {
-    var configMapDeleted = dependentResource.getSecondaryResource(primary).isEmpty();
+    var configMapDeleted = context.getSecondaryResource(ConfigMap.class).isEmpty();
     log.debug("Config Map Deleted: {}", configMapDeleted);
     return configMapDeleted;
   }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/workflowallfeature/DeploymentReadyCondition.java

@@ -12,7 +12,7 @@ public boolean isMet(
       DependentResource<Deployment, WorkflowAllFeatureCustomResource> dependentResource,
       WorkflowAllFeatureCustomResource primary, Context<WorkflowAllFeatureCustomResource> context) {
 
-    var deployment = dependentResource.getSecondaryResource(primary).orElseThrow();
+    var deployment = context.getSecondaryResource(Deployment.class).orElseThrow();
     var readyReplicas = deployment.getStatus().getReadyReplicas();
 
     return readyReplicas != null && deployment.getSpec().getReplicas().equals(readyReplicas);

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

@@ -69,7 +69,7 @@ public UpdateControl<WebPage> reconcile(WebPage webPage, Context<WebPage> contex
 
     webPage.setStatus(
         createStatus(
-            configMapDR.getSecondaryResource(webPage).orElseThrow().getMetadata().getName()));
+            context.getSecondaryResource(ConfigMap.class).orElseThrow().getMetadata().getName()));
     return UpdateControl.patchStatus(webPage);
   }
 

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

@@ -65,7 +65,7 @@ public UpdateControl<WebPage> reconcile(WebPage webPage, Context<WebPage> contex
 
     webPage.setStatus(
         createStatus(
-            configMapDR.getSecondaryResource(webPage).orElseThrow().getMetadata().getName()));
+            context.getSecondaryResource(ConfigMap.class).orElseThrow().getMetadata().getName()));
     return UpdateControl.patchStatus(webPage);
   }