feat: remove automatic observed generation handling

Signed-off-by: Attila Mészáros <csviri@gmail.com>

Author: csviri

bootstrapper-maven-plugin/src/main/resources/templates/Status.java

@@ -1,7 +1,5 @@
 package {{groupId}};
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class {{artifactClassId}}Status extends ObservedGenerationAwareStatus {
+public class {{artifactClassId}}Status {
 
 }

caffeine-bounded-cache-support/src/test/java/io/javaoperatorsdk/operator/processing/event/source/cache/sample/namespacescope/BoundedCacheTestStatus.java

@@ -1,6 +1,4 @@
 package io.javaoperatorsdk.operator.processing.event.source.cache.sample.namespacescope;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class BoundedCacheTestStatus extends ObservedGenerationAwareStatus {
+public class BoundedCacheTestStatus {
 }

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

@@ -10,14 +10,12 @@
 import io.fabric8.kubernetes.api.model.KubernetesResourceList;
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.api.model.ObjectMeta;
-import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.KubernetesClientException;
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
 import io.fabric8.kubernetes.client.dsl.base.PatchContext;
 import io.fabric8.kubernetes.client.dsl.base.PatchType;
 import io.javaoperatorsdk.operator.OperatorException;
-import io.javaoperatorsdk.operator.api.ObservedGenerationAware;
 import io.javaoperatorsdk.operator.api.config.Cloner;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.reconciler.BaseControl;
@@ -170,13 +168,11 @@ private PostExecutionControl<P> reconcileExecution(ExecutionScope<P> executionSc
       }
     }
 
-    // check if status also needs to be updated
-    final var updateObservedGeneration = updateControl.isNoUpdate()
-        ? shouldUpdateObservedGenerationAutomatically(resourceForExecution)
-        : shouldUpdateObservedGenerationAutomatically(updatedCustomResource);
+
+
     // if using SSA the observed generation is updated only if user instructs patching the status
-    if (updateControl.isPatchStatus() || (updateObservedGeneration && !useSSA)) {
-      updatedCustomResource = patchStatusGenerationAware(toUpdate, originalResource);
+    if (updateControl.isPatchStatus()) {
+      customResourceFacade.patchStatus(toUpdate, originalResource);
     }
     return createPostExecutionControl(updatedCustomResource, updateControl);
   }
@@ -206,9 +202,8 @@ public boolean isLastAttempt() {
 
         P updatedResource = null;
         if (errorStatusUpdateControl.getResource().isPresent()) {
-          updatedResource =
-              patchStatusGenerationAware(errorStatusUpdateControl.getResource().orElseThrow(),
-                  originalResource);
+          updatedResource = customResourceFacade
+              .patchStatus(errorStatusUpdateControl.getResource().orElseThrow(), originalResource);
         }
         if (errorStatusUpdateControl.isNoRetry()) {
           PostExecutionControl<P> postExecutionControl;
@@ -234,38 +229,9 @@ private boolean isErrorStatusHandlerPresent() {
   }
 
   private P patchStatusGenerationAware(P resource, P originalResource) {
-    updateStatusObservedGenerationIfRequired(resource);
     return customResourceFacade.patchStatus(resource, originalResource);
   }
 
-  @SuppressWarnings("rawtypes")
-  private boolean shouldUpdateObservedGenerationAutomatically(P resource) {
-    if (configuration().isGenerationAware() && resource instanceof CustomResource<?, ?>) {
-      var customResource = (CustomResource) resource;
-      var status = customResource.getStatus();
-      // Note that if status is null we won't update the observed generation.
-      if (status instanceof ObservedGenerationAware) {
-        var observedGen = ((ObservedGenerationAware) status).getObservedGeneration();
-        var currentGen = resource.getMetadata().getGeneration();
-        return !currentGen.equals(observedGen);
-      }
-    }
-    return false;
-  }
-
-  @SuppressWarnings("rawtypes")
-  private void updateStatusObservedGenerationIfRequired(P resource) {
-    if (configuration().isGenerationAware() && resource instanceof CustomResource<?, ?>) {
-      var customResource = (CustomResource) resource;
-      var status = customResource.getStatus();
-      // Note that if status is null we won't update the observed generation.
-      if (status instanceof ObservedGenerationAware) {
-        ((ObservedGenerationAware) status)
-            .setObservedGeneration(resource.getMetadata().getGeneration());
-      }
-    }
-  }
-
   private PostExecutionControl<P> createPostExecutionControl(P updatedCustomResource,
       UpdateControl<P> updateControl) {
     PostExecutionControl<P> postExecutionControl;

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

@@ -435,29 +435,6 @@ void reScheduleOnDeleteWithoutFinalizerRemoval() {
         .isEqualTo(1000L);
   }
 
-  @Test
-  void setObservedGenerationForStatusIfNeeded() throws Exception {
-    var observedGenResource = createObservedGenCustomResource();
-
-    Reconciler<ObservedGenCustomResource> reconciler = mock(Reconciler.class);
-    ControllerConfiguration<ObservedGenCustomResource> config =
-        MockControllerConfiguration.forResource(ObservedGenCustomResource.class);
-    CustomResourceFacade<ObservedGenCustomResource> facade = mock(CustomResourceFacade.class);
-    var dispatcher = init(observedGenResource, reconciler, config, facade, true);
-
-    when(config.isGenerationAware()).thenReturn(true);
-
-    when(reconciler.reconcile(any(), any()))
-        .thenReturn(UpdateControl.patchStatus(observedGenResource));
-    when(facade.patchStatus(eq(observedGenResource), any())).thenReturn(observedGenResource);
-
-    PostExecutionControl<ObservedGenCustomResource> control = dispatcher.handleExecution(
-        executionScopeWithCREvent(observedGenResource));
-    assertThat(control.getUpdatedCustomResource().orElseGet(() -> fail("Missing optional"))
-        .getStatus().getObservedGeneration())
-        .isEqualTo(1L);
-  }
-
   @Test
   void doesNotUpdatesObservedGenerationIfStatusIsNotPatchedWhenUsingSSA() throws Exception {
     var observedGenResource = createObservedGenCustomResource();
@@ -476,28 +453,6 @@ void doesNotUpdatesObservedGenerationIfStatusIsNotPatchedWhenUsingSSA() throws E
     assertThat(control.getUpdatedCustomResource()).isEmpty();
   }
 
-  @Test
-  void patchObservedGenerationOnCustomResourcePatchIfNoSSA() throws Exception {
-    var observedGenResource = createObservedGenCustomResource();
-
-    Reconciler<ObservedGenCustomResource> reconciler = mock(Reconciler.class);
-    final var config = MockControllerConfiguration.forResource(ObservedGenCustomResource.class);
-    CustomResourceFacade<ObservedGenCustomResource> facade = mock(CustomResourceFacade.class);
-    when(config.isGenerationAware()).thenReturn(true);
-    when(reconciler.reconcile(any(), any()))
-        .thenReturn(UpdateControl.patchResource(observedGenResource));
-    when(facade.patchResource(any(), any())).thenReturn(observedGenResource);
-    when(facade.patchStatus(eq(observedGenResource), any())).thenReturn(observedGenResource);
-    initConfigService(false);
-    var dispatcher = init(observedGenResource, reconciler, config, facade, true);
-
-    PostExecutionControl<ObservedGenCustomResource> control = dispatcher.handleExecution(
-        executionScopeWithCREvent(observedGenResource));
-    assertThat(control.getUpdatedCustomResource().orElseGet(() -> fail("Missing optional"))
-        .getStatus().getObservedGeneration())
-        .isEqualTo(1L);
-  }
-
   @Test
   void doesNotPatchObservedGenerationOnCustomResourcePatch() throws Exception {
     var observedGenResource = createObservedGenCustomResource();

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

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.sample.observedgeneration;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class ObservedGenStatus extends ObservedGenerationAwareStatus {
+public class ObservedGenStatus {
 
 }

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

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.sample.createupdateeventfilter;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class CreateUpdateEventFilterTestCustomResourceStatus extends ObservedGenerationAwareStatus {
+public class CreateUpdateEventFilterTestCustomResourceStatus {
 
 }

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/sample/observedgeneration/ObservedGenStatus.java

@@ -1,7 +1,14 @@
 package io.javaoperatorsdk.operator.sample.gracefulstop;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
+public class GracefulStopTestCustomResourceStatus {
 
-public class GracefulStopTestCustomResourceStatus extends ObservedGenerationAwareStatus {
+  private long observedGeneration;
 
+  public long getObservedGeneration() {
+    return observedGeneration;
+  }
+
+  public void setObservedGeneration(long observedGeneration) {
+    this.observedGeneration = observedGeneration;
+  }
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/ObservedGenerationHandlingIT.java

@@ -22,6 +22,7 @@ public UpdateControl<GracefulStopTestCustomResource> reconcile(
 
     numberOfExecutions.addAndGet(1);
     resource.setStatus(new GracefulStopTestCustomResourceStatus());
+    resource.getStatus().setObservedGeneration(resource.getMetadata().getGeneration());
     Thread.sleep(RECONCILER_SLEEP);
 
     return UpdateControl.patchStatus(resource);

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/createupdateeventfilter/CreateUpdateEventFilterTestCustomResourceStatus.java

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.sample.ratelimit;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class RateLimitCustomResourceStatus extends ObservedGenerationAwareStatus {
+public class RateLimitCustomResourceStatus {
 
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/gracefulstop/GracefulStopTestCustomResourceStatus.java

@@ -1,8 +1,6 @@
 package io.javaoperatorsdk.operator.sample;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class SchemaStatus extends ObservedGenerationAwareStatus {
+public class SchemaStatus {
 
   private String url;
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/gracefulstop/GracefulStopTestReconciler.java

@@ -1,8 +1,6 @@
 package io.javaoperatorsdk.operator.sample.customresource;
 
-import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
-
-public class WebPageStatus extends ObservedGenerationAwareStatus {
+public class WebPageStatus {
 
   private String htmlConfigMap;