feat: external state management for dependent resources

Author: csviri

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

@@ -110,38 +110,38 @@ private void logForOperation(String operation, P primary, R desired) {
   }
 
   protected R handleCreate(R desired, P primary, Context<P> context) {
-    ResourceID resourceID = ResourceID.fromResource(primary);
     R created = creator.create(desired, primary, context);
     throwIfNull(created, primary, "Created resource");
-    onCreated(resourceID, created);
+    onCreated(primary, created, context);
     return created;
   }
 
   /**
    * Allows subclasses to perform additional processing (e.g. caching) on the created resource if
    * needed.
    *
-   * @param primaryResourceId the {@link ResourceID} of the primary resource associated with the
-   *        newly created resource
+   * @param primary the {@link ResourceID} of the primary resource associated with the newly created
+   *        resource
    * @param created the newly created resource
+   * @param context
    */
-  protected abstract void onCreated(ResourceID primaryResourceId, R created);
+  protected abstract void onCreated(P primary, R created, Context<P> context);
 
   /**
    * Allows subclasses to perform additional processing on the updated resource if needed.
    *
-   * @param primaryResourceId the {@link ResourceID} of the primary resource associated with the
-   *        newly updated resource
+   * @param primary the {@link ResourceID} of the primary resource associated with the newly updated
+   *        resource
    * @param updated the updated resource
    * @param actual the resource as it was before the update
+   * @param context
    */
-  protected abstract void onUpdated(ResourceID primaryResourceId, R updated, R actual);
+  protected abstract void onUpdated(P primary, R updated, R actual, Context<P> context);
 
   protected R handleUpdate(R actual, R desired, P primary, Context<P> context) {
-    ResourceID resourceID = ResourceID.fromResource(primary);
     R updated = updater.update(actual, desired, primary, context);
     throwIfNull(updated, primary, "Updated resource");
-    onUpdated(resourceID, updated, actual);
+    onUpdated(primary, updated, actual, context);
     return updated;
   }
 

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

@@ -3,6 +3,7 @@
 import java.util.Optional;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
 import io.javaoperatorsdk.operator.api.reconciler.Ignore;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.EventSourceNotFoundException;
@@ -94,15 +95,17 @@ public Optional<ResourceEventSource<R, P>> eventSource() {
     return Optional.ofNullable(eventSource);
   }
 
-  protected void onCreated(ResourceID primaryResourceId, R created) {
+  protected void onCreated(P primary, R created, Context<P> context) {
     if (isCacheFillerEventSource) {
-      recentOperationCacheFiller().handleRecentResourceCreate(primaryResourceId, created);
+      recentOperationCacheFiller().handleRecentResourceCreate(ResourceID.fromResource(primary),
+          created);
     }
   }
 
-  protected void onUpdated(ResourceID primaryResourceId, R updated, R actual) {
+  protected void onUpdated(P primary, R updated, R actual, Context<P> context) {
     if (isCacheFillerEventSource) {
-      recentOperationCacheFiller().handleRecentResourceUpdate(primaryResourceId, updated, actual);
+      recentOperationCacheFiller().handleRecentResourceUpdate(ResourceID.fromResource(primary),
+          updated, actual);
     }
   }
 

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

@@ -0,0 +1,46 @@
+package io.javaoperatorsdk.operator.processing.dependent;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.RecentOperationCacheFiller;
+import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceEventSource;
+
+public abstract class AbstractExternalDependentResource<R, P extends HasMetadata, T extends ResourceEventSource<R, P>>
+    extends AbstractEventSourceHolderDependentResource<R, P, T> {
+
+  protected AbstractExternalDependentResource(Class<R> resourceType) {
+    super(resourceType);
+  }
+
+  @Override
+  protected void onCreated(P primary, R created, Context<P> context) {
+    super.onCreated(primary, created, context);
+    if (this instanceof ExplicitIDHandler) {
+      handleExplicitIDStoring(primary, created, context);
+    }
+  }
+
+  @SuppressWarnings({"rawtypes", "unchecked"})
+  protected void handleExplicitIDStoring(P primary, R created, Context<P> context) {
+    ExplicitIDHandler<R, P, ?> handler = (ExplicitIDHandler) this;
+    HasMetadata resource = handler.stateResource(primary, created);
+    var stateResource = handler.getKubernetesClient().resource(resource).create();
+
+    String name = handler.eventSourceName().orElse(null);
+    ResourceEventSource<R, P> eventSource;
+    if (name == null) {
+      eventSource =
+          context.eventSourceRetriever()
+              .<R>getResourceEventSourceFor((Class<R>) resource.getClass());
+    } else {
+      eventSource = context.eventSourceRetriever()
+          .<R>getResourceEventSourceFor((Class<R>) resource.getClass(), name);
+    }
+    if (eventSource instanceof RecentOperationCacheFiller) {
+      ((RecentOperationCacheFiller) eventSource)
+          .handleRecentResourceCreate(ResourceID.fromResource(primary), stateResource);
+    }
+  }
+  
+}

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

@@ -11,7 +11,6 @@
 import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.ReconcileResult;
 import io.javaoperatorsdk.operator.processing.dependent.Matcher.Result;
-import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
 class BulkDependentResourceReconciler<R, P extends HasMetadata>
     implements DependentResourceReconciler<R, P> {
@@ -97,13 +96,13 @@ public Result<R> match(R resource, P primary, Context<P> context) {
     }
 
     @Override
-    protected void onCreated(ResourceID primaryResourceId, R created) {
-      asAbstractDependentResource().onCreated(primaryResourceId, created);
+    protected void onCreated(P primary, R created, Context<P> context) {
+      asAbstractDependentResource().onCreated(primary, created, context);
     }
 
     @Override
-    protected void onUpdated(ResourceID primaryResourceId, R updated, R actual) {
-      asAbstractDependentResource().onUpdated(primaryResourceId, updated, actual);
+    protected void onUpdated(P primary, R updated, R actual, Context<P> context) {
+      asAbstractDependentResource().onUpdated(primary, updated, actual, context);
     }
 
     @Override

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

@@ -0,0 +1,21 @@
+package io.javaoperatorsdk.operator.processing.dependent;
+
+import java.util.Optional;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.Deleter;
+import io.javaoperatorsdk.operator.api.reconciler.dependent.managed.KubernetesClientAware;
+
+public interface ExplicitIDHandler<R, P extends HasMetadata, S extends HasMetadata>
+    extends Creator<R, P>, Deleter<P>, KubernetesClientAware {
+
+  default Optional<String> eventSourceName() {
+    return Optional.empty();
+  }
+
+  S stateResource(P primary, R resource);
+
+  // todo for the two phase resource create
+  // void postIDStored(P primary, R resource, S stateResource);
+
+}

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

@@ -7,7 +7,6 @@
 import io.fabric8.kubernetes.api.model.ConfigMap;
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
-import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -85,10 +84,12 @@ public Optional<ConfigMap> getSecondaryResource(TestCustomResource primary,
     }
 
     @Override
-    protected void onCreated(ResourceID primaryResourceId, ConfigMap created) {}
+    protected void onCreated(TestCustomResource primary, ConfigMap created,
+        Context<TestCustomResource> context) {}
 
     @Override
-    protected void onUpdated(ResourceID primaryResourceId, ConfigMap updated, ConfigMap actual) {}
+    protected void onUpdated(TestCustomResource primary, ConfigMap updated, ConfigMap actual,
+        Context<TestCustomResource> context) {}
 
     @Override
     protected ConfigMap desired(TestCustomResource primary, Context<TestCustomResource> context) {