refactor: better naming

Signed-off-by: Chris Laprun <metacosm@gmail.com>

Author: metacosm

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

@@ -164,7 +164,7 @@ public DefaultContext<P> setRetryInfo(RetryInfo retryInfo) {
   }
 
   @SuppressWarnings("unchecked")
-  public <R> R desiredStateFor(
+  public <R> R getOrComputeDesiredStateFor(
       DependentResource<R, P> dependentResource, Function<P, R> desiredStateComputer) {
     return (R)
         desiredStates.computeIfAbsent(

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

@@ -86,7 +86,7 @@ protected ReconcileResult<R> reconcile(P primary, R actualResource, Context<P> c
     if (creatable() || updatable()) {
       if (actualResource == null) {
         if (creatable) {
-          var desired = doDesired(context);
+          var desired = getOrComputeDesired(context);
           throwIfNull(desired, primary, "Desired");
           logForOperation("Creating", primary, desired);
           var createdResource = handleCreate(desired, primary, context);
@@ -96,7 +96,8 @@ protected ReconcileResult<R> reconcile(P primary, R actualResource, Context<P> c
         if (updatable()) {
           final Matcher.Result<R> match = match(actualResource, primary, context);
           if (!match.matched()) {
-            final var desired = match.computedDesired().orElseGet(() -> doDesired(context));
+            final var desired =
+                match.computedDesired().orElseGet(() -> getOrComputeDesired(context));
             throwIfNull(desired, primary, "Desired");
             logForOperation("Updating", primary, desired);
             var updatedResource = handleUpdate(actualResource, desired, primary, context);
@@ -212,10 +213,25 @@ protected R desired(P primary, Context<P> context) {
             + " updated");
   }
 
-  protected R doDesired(Context<P> context) {
+  /**
+   * Retrieves the desired state from the {@link Context} if it has already been computed or calls
+   * {@link #desired(HasMetadata, Context)} and stores its result in the context for further use.
+   * This ensures that {@code desired} is only called once per reconciliation to avoid unneeded
+   * processing and supports scenarios where idempotent computation of the desired state is not
+   * feasible.
+   *
+   * <p>Note that this method should normally only be called by the SDK itself and exclusively (i.e.
+   * {@link #desired(HasMetadata, Context)} should not be called directly by the SDK) whenever the
+   * desired state is needed to ensure it is properly cached for the current reconciliation.
+   *
+   * @param context the {@link Context} in scope for the current reconciliation
+   * @return the desired state associated with this dependent resource based on the currently
+   *     in-scope primary resource as found in the context
+   */
+  protected R getOrComputeDesired(Context<P> context) {
     assert context instanceof DefaultContext<P>;
     DefaultContext<P> defaultContext = (DefaultContext<P>) context;
-    return defaultContext.desiredStateFor(this, p -> desired(p, defaultContext));
+    return defaultContext.getOrComputeDesiredStateFor(this, p -> desired(p, defaultContext));
   }
 
   public void delete(P primary, Context<P> context) {

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

@@ -105,7 +105,7 @@ protected void handleExplicitStateCreation(P primary, R created, Context<P> cont
 
   @Override
   public Matcher.Result<R> match(R resource, P primary, Context<P> context) {
-    var desired = doDesired(context);
+    var desired = getOrComputeDesired(context);
     return Matcher.Result.computed(resource.equals(desired), desired);
   }
 

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

@@ -138,7 +138,7 @@ public static <R extends HasMetadata, P extends HasMetadata> Matcher.Result<R> m
       Context<P> context,
       boolean labelsAndAnnotationsEquality,
       String... ignorePaths) {
-    final var desired = dependentResource.doDesired(context);
+    final var desired = dependentResource.getOrComputeDesired(context);
     return match(desired, actualResource, labelsAndAnnotationsEquality, context, ignorePaths);
   }
 
@@ -150,7 +150,7 @@ public static <R extends HasMetadata, P extends HasMetadata> Matcher.Result<R> m
       boolean specEquality,
       boolean labelsAndAnnotationsEquality,
       String... ignorePaths) {
-    final var desired = dependentResource.doDesired(context);
+    final var desired = dependentResource.getOrComputeDesired(context);
     return match(
         desired, actualResource, labelsAndAnnotationsEquality, specEquality, context, ignorePaths);
   }

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

@@ -123,7 +123,7 @@ public R update(R actual, R desired, P primary, Context<P> context) {
 
   @Override
   public Result<R> match(R actualResource, P primary, Context<P> context) {
-    final var desired = doDesired(context);
+    final var desired = getOrComputeDesired(context);
     return match(actualResource, desired, primary, context);
   }
 
@@ -301,16 +301,16 @@ protected Optional<R> selectTargetSecondaryResource(
    * @return id of the target managed resource
    */
   protected ResourceID targetSecondaryResourceID(P primary, Context<P> context) {
-    return ResourceID.fromResource(doDesired(context));
+    return ResourceID.fromResource(getOrComputeDesired(context));
   }
 
   protected boolean addOwnerReference() {
     return garbageCollected;
   }
 
   @Override
-  protected R doDesired(Context<P> context) {
-    return super.doDesired(context);
+  protected R getOrComputeDesired(Context<P> context) {
+    return super.getOrComputeDesired(context);
   }
 
   @Override

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

@@ -34,7 +34,7 @@ class AbstractDependentResourceTest {
 
   private static final TestCustomResource PRIMARY = new TestCustomResource();
   private static final DefaultContext<TestCustomResource> CONTEXT =
-      new DefaultContext<>(mock(), mock(), PRIMARY);
+      new DefaultContext<>(mock(), mock(), PRIMARY, false, false);
 
   @Test
   void throwsExceptionIfDesiredIsNullOnCreate() {

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

@@ -47,7 +47,7 @@ public TestContext() {
     }
 
     public TestContext(HasMetadata primary) {
-      super(mock(), mock(), primary);
+      super(mock(), mock(), primary, false, false);
     }
 
     @Override
@@ -91,7 +91,7 @@ void doesNotMatchRemovedValues() {
     final var localContext = new TestContext(createPrimary("removed"));
     assertThat(
             GenericKubernetesResourceMatcher.match(
-                    dependentResource.doDesired(localContext), actual, localContext)
+                    dependentResource.getOrComputeDesired(localContext), actual, localContext)
                 .matched())
         .withFailMessage("Removing values in metadata should lead to a mismatch")
         .isFalse();