Revert "remove with lock versions"

This reverts commit 68ca625.

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

@@ -11,13 +11,112 @@
 import io.fabric8.kubernetes.client.dsl.base.PatchContext;
 import io.fabric8.kubernetes.client.dsl.base.PatchType;
 import io.javaoperatorsdk.operator.api.reconciler.support.PrimaryResourceCache;
+import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
 public class PrimaryUpdateAndCacheUtils {
 
   private PrimaryUpdateAndCacheUtils() {}
 
   private static final Logger log = LoggerFactory.getLogger(PrimaryUpdateAndCacheUtils.class);
 
+  /**
+   * Makes sure that the up-to-date primary resource will be present during the next reconciliation.
+   * Using update (PUT) method.
+   *
+   * @param primary resource
+   * @param context of reconciliation
+   * @return updated resource
+   * @param <P> primary resource type
+   */
+  public static <P extends HasMetadata> P updateAndCacheStatusWithLock(
+      P primary, Context<P> context) {
+    return patchAndCacheStatusWithLock(
+        primary, context, (p, c) -> c.resource(primary).updateStatus());
+  }
+
+  /**
+   * Makes sure that the up-to-date primary resource will be present during the next reconciliation.
+   * Using JSON Merge patch.
+   *
+   * @param primary resource
+   * @param context of reconciliation
+   * @return updated resource
+   * @param <P> primary resource type
+   */
+  public static <P extends HasMetadata> P patchAndCacheStatusWithLock(
+      P primary, Context<P> context) {
+    return patchAndCacheStatusWithLock(
+        primary, context, (p, c) -> c.resource(primary).patchStatus());
+  }
+
+  /**
+   * Makes sure that the up-to-date primary resource will be present during the next reconciliation.
+   * Using JSON Patch.
+   *
+   * @param primary resource
+   * @param context of reconciliation
+   * @return updated resource
+   * @param <P> primary resource type
+   */
+  public static <P extends HasMetadata> P editAndCacheStatusWithLock(
+      P primary, Context<P> context, UnaryOperator<P> operation) {
+    return patchAndCacheStatusWithLock(
+        primary, context, (p, c) -> c.resource(primary).editStatus(operation));
+  }
+
+  /**
+   * Makes sure that the up-to-date primary resource will be present during the next reconciliation.
+   *
+   * @param primary resource
+   * @param context of reconciliation
+   * @param patch free implementation of cache - make sure you use optimistic locking during the
+   *     update
+   * @return the updated resource.
+   * @param <P> primary resource type
+   */
+  public static <P extends HasMetadata> P patchAndCacheStatusWithLock(
+      P primary, Context<P> context, BiFunction<P, KubernetesClient, P> patch) {
+    checkResourceVersionPresent(primary);
+    var updatedResource = patch.apply(primary, context.getClient());
+    context
+        .eventSourceRetriever()
+        .getControllerEventSource()
+        .handleRecentResourceUpdate(ResourceID.fromResource(primary), updatedResource, primary);
+    return updatedResource;
+  }
+
+  /**
+   * Makes sure that the up-to-date primary resource will be present during the next reconciliation.
+   * Using Server Side Apply.
+   *
+   * @param primary resource
+   * @param freshResourceWithStatus - fresh resource with target state
+   * @param context of reconciliation
+   * @return the updated resource.
+   * @param <P> primary resource type
+   */
+  public static <P extends HasMetadata> P ssaPatchAndCacheStatusWithLock(
+      P primary, P freshResourceWithStatus, Context<P> context) {
+    checkResourceVersionPresent(freshResourceWithStatus);
+    var res =
+        context
+            .getClient()
+            .resource(freshResourceWithStatus)
+            .subresource("status")
+            .patch(
+                new PatchContext.Builder()
+                    .withForce(true)
+                    .withFieldManager(context.getControllerConfiguration().fieldManager())
+                    .withPatchType(PatchType.SERVER_SIDE_APPLY)
+                    .build());
+
+    context
+        .eventSourceRetriever()
+        .getControllerEventSource()
+        .handleRecentResourceUpdate(ResourceID.fromResource(primary), res, primary);
+    return res;
+  }
+
   /**
    * Patches the resource and adds it to the {@link PrimaryResourceCache} provided. Optimistic
    * locking is not required.

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/StatusPatchPrimaryCacheCustomResource.java → operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/primarycache/StatusPatchPrimaryCacheCustomResource.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.statuscache;
+package io.javaoperatorsdk.operator.baseapi.statuscache.primarycache;
 
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.CustomResource;

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/StatusPatchPrimaryCacheIT.java → operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/primarycache/StatusPatchPrimaryCacheIT.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.statuscache;
+package io.javaoperatorsdk.operator.baseapi.statuscache.primarycache;
 
 import java.time.Duration;
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/StatusPatchPrimaryCacheReconciler.java → operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/primarycache/StatusPatchPrimaryCacheReconciler.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.statuscache;
+package io.javaoperatorsdk.operator.baseapi.statuscache.primarycache;
 
 import java.util.List;
 
@@ -12,6 +12,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import io.javaoperatorsdk.operator.api.reconciler.support.PrimaryResourceCache;
+import io.javaoperatorsdk.operator.baseapi.statuscache.PeriodicTriggerEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 
 @ControllerConfiguration

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/StatusPatchPrimaryCacheSpec.java → operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/primarycache/StatusPatchPrimaryCacheSpec.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.statuscache;
+package io.javaoperatorsdk.operator.baseapi.statuscache.primarycache;
 
 public class StatusPatchPrimaryCacheSpec {
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/StatusPatchPrimaryCacheStatus.java → operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/primarycache/StatusPatchPrimaryCacheStatus.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.baseapi.statuscache;
+package io.javaoperatorsdk.operator.baseapi.statuscache.primarycache;
 
 public class StatusPatchPrimaryCacheStatus {
 

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/withlock/StatusPatchCacheWithLockCustomResource.java

@@ -0,0 +1,14 @@
+package io.javaoperatorsdk.operator.baseapi.statuscache.withlock;
+
+import io.fabric8.kubernetes.api.model.Namespaced;
+import io.fabric8.kubernetes.client.CustomResource;
+import io.fabric8.kubernetes.model.annotation.Group;
+import io.fabric8.kubernetes.model.annotation.ShortNames;
+import io.fabric8.kubernetes.model.annotation.Version;
+
+@Group("sample.javaoperatorsdk")
+@Version("v1")
+@ShortNames("spcl")
+public class StatusPatchCacheWithLockCustomResource
+    extends CustomResource<StatusPatchCacheWithLockSpec, StatusPatchCacheWithLockStatus>
+    implements Namespaced {}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/withlock/StatusPatchCacheWithLockIT.java

@@ -0,0 +1,48 @@
+package io.javaoperatorsdk.operator.baseapi.statuscache.withlock;
+
+import java.time.Duration;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+public class StatusPatchCacheWithLockIT {
+
+  public static final String TEST_1 = "test1";
+
+  @RegisterExtension
+  LocallyRunOperatorExtension extension =
+      LocallyRunOperatorExtension.builder()
+          .withReconciler(StatusPatchCacheWithLockReconciler.class)
+          .build();
+
+  @Test
+  void testStatusAlwaysUpToDate() {
+    var reconciler = extension.getReconcilerOfType(StatusPatchCacheWithLockReconciler.class);
+
+    extension.create(testResource());
+
+    // the reconciliation id periodically triggered, the status values should be increasing
+    // monotonically
+    await()
+        .pollDelay(Duration.ofSeconds(1))
+        .pollInterval(Duration.ofMillis(30))
+        .untilAsserted(
+            () -> {
+              assertThat(reconciler.errorPresent).isFalse();
+              assertThat(reconciler.latestValue).isGreaterThan(10);
+            });
+  }
+
+  StatusPatchCacheWithLockCustomResource testResource() {
+    var res = new StatusPatchCacheWithLockCustomResource();
+    res.setMetadata(new ObjectMetaBuilder().withName(TEST_1).build());
+    res.setSpec(new StatusPatchCacheWithLockSpec());
+    return res;
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/withlock/StatusPatchCacheWithLockReconciler.java

@@ -0,0 +1,70 @@
+package io.javaoperatorsdk.operator.baseapi.statuscache.withlock;
+
+import java.util.List;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.api.reconciler.Context;
+import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
+import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.api.reconciler.PrimaryUpdateAndCacheUtils;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
+import io.javaoperatorsdk.operator.baseapi.statuscache.PeriodicTriggerEventSource;
+import io.javaoperatorsdk.operator.processing.event.source.EventSource;
+
+@ControllerConfiguration
+public class StatusPatchCacheWithLockReconciler
+    implements Reconciler<StatusPatchCacheWithLockCustomResource> {
+
+  public volatile int latestValue = 0;
+  public volatile boolean errorPresent = false;
+
+  @Override
+  public UpdateControl<StatusPatchCacheWithLockCustomResource> reconcile(
+      StatusPatchCacheWithLockCustomResource resource,
+      Context<StatusPatchCacheWithLockCustomResource> context)
+      throws InterruptedException {
+
+    if (resource.getStatus() != null && resource.getStatus().getValue() != latestValue) {
+      errorPresent = true;
+      throw new IllegalStateException(
+          "status is not up to date. Latest value: "
+              + latestValue
+              + " status values: "
+              + resource.getStatus().getValue());
+    }
+
+    var freshCopy = createFreshCopy(resource);
+    // setting the resource version
+    freshCopy.getMetadata().setResourceVersion(resource.getMetadata().getResourceVersion());
+    freshCopy
+        .getStatus()
+        .setValue(resource.getStatus() == null ? 1 : resource.getStatus().getValue() + 1);
+
+    var updated =
+        PrimaryUpdateAndCacheUtils.ssaPatchAndCacheStatusWithLock(resource, freshCopy, context);
+    latestValue = updated.getStatus().getValue();
+
+    return UpdateControl.noUpdate();
+  }
+
+  @Override
+  public List<EventSource<?, StatusPatchCacheWithLockCustomResource>> prepareEventSources(
+      EventSourceContext<StatusPatchCacheWithLockCustomResource> context) {
+    // periodic event triggering for testing purposes
+    return List.of(new PeriodicTriggerEventSource<>(context.getPrimaryCache()));
+  }
+
+  private StatusPatchCacheWithLockCustomResource createFreshCopy(
+      StatusPatchCacheWithLockCustomResource resource) {
+    var res = new StatusPatchCacheWithLockCustomResource();
+    res.setMetadata(
+        new ObjectMetaBuilder()
+            .withName(resource.getMetadata().getName())
+            .withNamespace(resource.getMetadata().getNamespace())
+            .build());
+    res.setStatus(new StatusPatchCacheWithLockStatus());
+
+    return res;
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/withlock/StatusPatchCacheWithLockSpec.java

@@ -0,0 +1,14 @@
+package io.javaoperatorsdk.operator.baseapi.statuscache.withlock;
+
+public class StatusPatchCacheWithLockSpec {
+
+  private int counter = 0;
+
+  public int getCounter() {
+    return counter;
+  }
+
+  public void setCounter(int counter) {
+    this.counter = counter;
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/baseapi/statuscache/withlock/StatusPatchCacheWithLockStatus.java

@@ -0,0 +1,15 @@
+package io.javaoperatorsdk.operator.baseapi.statuscache.withlock;
+
+public class StatusPatchCacheWithLockStatus {
+
+  private Integer value = 0;
+
+  public Integer getValue() {
+    return value;
+  }
+
+  public StatusPatchCacheWithLockStatus setValue(Integer value) {
+    this.value = value;
+    return this;
+  }
+}