improvements

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

Author: csviri

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

@@ -465,24 +465,28 @@ default boolean parseResourceVersionsForEventFilteringAndCaching() {
   }
 
   /**
-   * If you update the primary resource from the reconciler with or without {@link
-   * io.javaoperatorsdk.operator.api.reconciler.UpdateControl} it is not guaranteed that for the
-   * next reconciliation will receive the most up-to-date resource. This is a consequence of
-   * Informers design in the Operator pattern.
+   * Guarantees that primary resource updated by {@link
+   * io.javaoperatorsdk.operator.api.reconciler.UpdateControl} will be available for next
+   * reconciliation.
    *
-   * <p>The framework can be smart about it and make such guarantees, but this can be done
+   * <p>If by default you update the primary resource from reconciler regardless if you use {@link
+   * io.javaoperatorsdk.operator.api.reconciler.UpdateControl} or directly the Kubernetes client, it
+   * is not guaranteed that for the next reconciliation will receive the most up-to-date resource.
+   * This is a consequence of how the informers work in Operator pattern.
+   *
+   * <p>However, the framework can be smart about it and make such guarantees, but this can be done
    * absolutely reliably only if it bends some rules of the Kubernetes API contract. Thus, if we
    * parse the resourceVersion of a primary resource as an integer and compare it with the version
    * of the resource in the cache. Note that this is a gray area, since with default setup Etcd
    * guarantees such monotonically increasing resource versions. But since it is still bending the
-   * rules by default, this feature is turned off, and work only if {@link
+   * rules by default, this feature is turned off, and requires {@link
    * #parseResourceVersionsForEventFilteringAndCaching} is also set to true.
    *
    * <p>See also {@link io.javaoperatorsdk.operator.api.reconciler.PrimaryUpdateAndCacheUtils}
    *
    * @return if the framework should cache the updated resource for next reconciliation
    */
-  default boolean cacheUpdatedResourcesViaUpdateControl() {
+  default boolean guaranteeUpdatedPrimaryIsAvailableForNextReconciliation() {
     return false;
   }
 

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

@@ -189,7 +189,8 @@ public ConfigurationServiceOverrider withCloneSecondaryResourcesWhenGettingFromC
     return this;
   }
 
-  public ConfigurationServiceOverrider withCacheUpdatedResourcesViaUpdateControl(boolean value) {
+  public ConfigurationServiceOverrider withGuaranteeUpdatedPrimaryIsAvailableForNextReconciliation(
+      boolean value) {
     this.cacheUpdatedResourcesViaUpdateControl = value;
     return this;
   }
@@ -336,10 +337,10 @@ public boolean cloneSecondaryResourcesWhenGettingFromCache() {
       }
 
       @Override
-      public boolean cacheUpdatedResourcesViaUpdateControl() {
+      public boolean guaranteeUpdatedPrimaryIsAvailableForNextReconciliation() {
         return overriddenValueOrDefault(
             cacheUpdatedResourcesViaUpdateControl,
-            ConfigurationService::cacheUpdatedResourcesViaUpdateControl);
+            ConfigurationService::guaranteeUpdatedPrimaryIsAvailableForNextReconciliation);
       }
     };
   }

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

@@ -430,11 +430,21 @@ public CustomResourceFacade(
       this.fieldManager = configuration.fieldManager();
       this.cacheUpdatedResources =
           configuration
-                  .getConfigurationService()
-                  .previousAnnotationForDependentResourcesEventFiltering()
-              && configuration.getConfigurationService().cacheUpdatedResourcesViaUpdateControl();
+              .getConfigurationService()
+              .guaranteeUpdatedPrimaryIsAvailableForNextReconciliation();
+
       this.cloner = cloner;
       this.controllerEventSource = controllerEventSource;
+
+      if (cacheUpdatedResources
+          && !configuration
+              .getConfigurationService()
+              .previousAnnotationForDependentResourcesEventFiltering()) {
+        throw new OperatorException(
+            "guaranteeUpdatedPrimaryIsAvailableForNextReconciliation is set to true, but"
+                + " previousAnnotationForDependentResourcesEventFiltering is set to false, set this"
+                + " flag also to true if you want to use this feature");
+      }
     }
 
     private void cachePrimaryResource(R updatedResource, R previousVersionOfResource) {