resource version parsing

csviri · csviri · commit a5fdead6f719 · 2025-10-10T13:04:34.000+02:00
Signed-off-by: Attila Mészáros &lt;a_meszaros@apple.com&gt;
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java
@@ -447,64 +447,6 @@ default Set<Class<? extends HasMetadata>> defaultNonSSAResource() {
     return defaultNonSSAResources();
   }
 
-  /**
-   * If a javaoperatorsdk.io/previous annotation should be used so that the operator sdk can detect
-   * events from its own updates of dependent resources and then filter them.
-   *
-   * <p>Disable this if you want to react to your own dependent resource updates
-   *
-   * @return if special annotation should be used for dependent resource to filter events
-   * @since 4.5.0
-   */
-  default boolean previousAnnotationForDependentResourcesEventFiltering() {
-    return true;
-  }
-
-  /**
-   * For dependent resources, the framework can add an annotation to filter out events resulting
-   * directly from the framework's operation. There are, however, some resources that do not follow
-   * the Kubernetes API conventions that changes in metadata should not increase the generation of
-   * the resource (as recorded in the {@code generation} field of the resource's {@code metadata}).
-   * For these resources, this convention is not respected and results in a new event for the
-   * framework to process. If that particular case is not handled correctly in the resource matcher,
-   * the framework will consider that the resource doesn't match the desired state and therefore
-   * triggers an update, which in turn, will re-add the annotation, thus starting the loop again,
-   * infinitely.
-   *
-   * <p>As a workaround, we automatically skip adding previous annotation for those well-known
-   * resources. Note that if you are sure that the matcher works for your use case, and it should in
-   * most instances, you can remove the resource type from the blocklist.
-   *
-   * <p>The consequence of adding a resource type to the set is that the framework will not use
-   * event filtering to prevent events, initiated by changes made by the framework itself as a
-   * result of its processing of dependent resources, to trigger the associated reconciler again.
-   *
-   * <p>Note that this method only takes effect if annotating dependent resources to prevent
-   * dependent resources events from triggering the associated reconciler again is activated as
-   * controlled by {@link #previousAnnotationForDependentResourcesEventFiltering()}
-   *
-   * @return a Set of resource classes where the previous version annotation won't be used.
-   */
-  default Set<Class<? extends HasMetadata>> withPreviousAnnotationForDependentResourcesBlocklist() {
-    return Set.of(Deployment.class, StatefulSet.class);
-  }
-
-  /**
-   * If the event logic should parse the resourceVersion to determine the ordering of dependent
-   * resource events. This is typically not needed.
-   *
-   * <p>Disabled by default as Kubernetes does not support, and discourages, this interpretation of
-   * resourceVersions. Enable only if your api server event processing seems to lag the operator
-   * logic, and you want to further minimize the amount of work done / updates issued by the
-   * operator.
-   *
-   * @return if resource version should be parsed (as integer)
-   * @since 4.5.0
-   */
-  default boolean parseResourceVersionsForEventFilteringAndCaching() {
-    return false;
-  }
-
   /**
    * {@link io.javaoperatorsdk.operator.api.reconciler.UpdateControl} patch resource or status can
    * either use simple patches or SSA. Setting this to {@code true}, controllers will use SSA for
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java
@@ -51,11 +51,8 @@ public class ConfigurationServiceOverrider {
   private Duration reconciliationTerminationTimeout;
   private Boolean ssaBasedCreateUpdateMatchForDependentResources;
   private Set<Class<? extends HasMetadata>> defaultNonSSAResource;
-  private Boolean previousAnnotationForDependentResources;
-  private Boolean parseResourceVersions;
   private Boolean useSSAToPatchPrimaryResource;
   private Boolean cloneSecondaryResourcesWhenGettingFromCache;
-  private Set<Class<? extends HasMetadata>> previousAnnotationUsageBlocklist;
 
   @SuppressWarnings("rawtypes")
   private DependentResourceFactory dependentResourceFactory;
@@ -168,31 +165,6 @@ public ConfigurationServiceOverrider withDefaultNonSSAResource(
     return this;
   }
 
-  public ConfigurationServiceOverrider withPreviousAnnotationForDependentResources(boolean value) {
-    this.previousAnnotationForDependentResources = value;
-    return this;
-  }
-
-  /**
-   * @param value true if internal algorithms can use metadata.resourceVersion as a numeric value.
-   * @return this
-   */
-  public ConfigurationServiceOverrider withParseResourceVersions(boolean value) {
-    this.parseResourceVersions = value;
-    return this;
-  }
-
-  /**
-   * @deprecated use withParseResourceVersions
-   * @param value true if internal algorithms can use metadata.resourceVersion as a numeric value.
-   * @return this
-   */
-  @Deprecated(forRemoval = true)
-  public ConfigurationServiceOverrider wihtParseResourceVersions(boolean value) {
-    this.parseResourceVersions = value;
-    return this;
-  }
-
   public ConfigurationServiceOverrider withUseSSAToPatchPrimaryResource(boolean value) {
     this.useSSAToPatchPrimaryResource = value;
     return this;
@@ -204,12 +176,6 @@ public ConfigurationServiceOverrider withCloneSecondaryResourcesWhenGettingFromC
     return this;
   }
 
-  public ConfigurationServiceOverrider withPreviousAnnotationForDependentResourcesBlocklist(
-      Set<Class<? extends HasMetadata>> blocklist) {
-    this.previousAnnotationUsageBlocklist = blocklist;
-    return this;
-  }
-
   public ConfigurationService build() {
     return new BaseConfigurationService(original.getVersion(), cloner, client) {
       @Override
@@ -218,43 +184,43 @@ public Set<String> getKnownReconcilerNames() {
       }
 
       private <T> T overriddenValueOrDefault(
-          T value, Function<ConfigurationService, T> defaultValue) {
+              T value, Function<ConfigurationService, T> defaultValue) {
         return value != null ? value : defaultValue.apply(original);
       }
 
       @Override
       public boolean checkCRDAndValidateLocalModel() {
         return overriddenValueOrDefault(
-            checkCR, ConfigurationService::checkCRDAndValidateLocalModel);
+                checkCR, ConfigurationService::checkCRDAndValidateLocalModel);
       }
 
       @SuppressWarnings("rawtypes")
       @Override
       public DependentResourceFactory dependentResourceFactory() {
         return overriddenValueOrDefault(
-            dependentResourceFactory, ConfigurationService::dependentResourceFactory);
+                dependentResourceFactory, ConfigurationService::dependentResourceFactory);
       }
 
       @Override
       public int concurrentReconciliationThreads() {
         return Utils.ensureValid(
-            overriddenValueOrDefault(
-                concurrentReconciliationThreads,
-                ConfigurationService::concurrentReconciliationThreads),
-            "maximum reconciliation threads",
-            1,
-            original.concurrentReconciliationThreads());
+                overriddenValueOrDefault(
+                        concurrentReconciliationThreads,
+                        ConfigurationService::concurrentReconciliationThreads),
+                "maximum reconciliation threads",
+                1,
+                original.concurrentReconciliationThreads());
       }
 
       @Override
       public int concurrentWorkflowExecutorThreads() {
         return Utils.ensureValid(
-            overriddenValueOrDefault(
-                concurrentWorkflowExecutorThreads,
-                ConfigurationService::concurrentWorkflowExecutorThreads),
-            "maximum workflow execution threads",
-            1,
-            original.concurrentWorkflowExecutorThreads());
+                overriddenValueOrDefault(
+                        concurrentWorkflowExecutorThreads,
+                        ConfigurationService::concurrentWorkflowExecutorThreads),
+                "maximum workflow execution threads",
+                1,
+                original.concurrentWorkflowExecutorThreads());
       }
 
       @Override
@@ -288,22 +254,22 @@ public ExecutorService getWorkflowExecutorService() {
       @Override
       public Optional<LeaderElectionConfiguration> getLeaderElectionConfiguration() {
         return leaderElectionConfiguration != null
-            ? Optional.of(leaderElectionConfiguration)
-            : original.getLeaderElectionConfiguration();
+                ? Optional.of(leaderElectionConfiguration)
+                : original.getLeaderElectionConfiguration();
       }
 
       @Override
       public Optional<InformerStoppedHandler> getInformerStoppedHandler() {
         return informerStoppedHandler != null
-            ? Optional.of(informerStoppedHandler)
-            : original.getInformerStoppedHandler();
+                ? Optional.of(informerStoppedHandler)
+                : original.getInformerStoppedHandler();
       }
 
       @Override
       public boolean stopOnInformerErrorDuringStartup() {
         return overriddenValueOrDefault(
-            stopOnInformerErrorDuringStartup,
-            ConfigurationService::stopOnInformerErrorDuringStartup);
+                stopOnInformerErrorDuringStartup,
+                ConfigurationService::stopOnInformerErrorDuringStartup);
       }
 
       @Override
@@ -314,57 +280,34 @@ public Duration cacheSyncTimeout() {
       @Override
       public Duration reconciliationTerminationTimeout() {
         return overriddenValueOrDefault(
-            reconciliationTerminationTimeout,
-            ConfigurationService::reconciliationTerminationTimeout);
+                reconciliationTerminationTimeout,
+                ConfigurationService::reconciliationTerminationTimeout);
       }
 
       @Override
       public boolean ssaBasedCreateUpdateMatchForDependentResources() {
         return overriddenValueOrDefault(
-            ssaBasedCreateUpdateMatchForDependentResources,
-            ConfigurationService::ssaBasedCreateUpdateMatchForDependentResources);
+                ssaBasedCreateUpdateMatchForDependentResources,
+                ConfigurationService::ssaBasedCreateUpdateMatchForDependentResources);
       }
 
       @Override
       public Set<Class<? extends HasMetadata>> defaultNonSSAResources() {
         return overriddenValueOrDefault(
-            defaultNonSSAResource, ConfigurationService::defaultNonSSAResources);
-      }
-
-      @Override
-      public boolean previousAnnotationForDependentResourcesEventFiltering() {
-        return overriddenValueOrDefault(
-            previousAnnotationForDependentResources,
-            ConfigurationService::previousAnnotationForDependentResourcesEventFiltering);
-      }
-
-      @Override
-      public boolean parseResourceVersionsForEventFilteringAndCaching() {
-        return overriddenValueOrDefault(
-            parseResourceVersions,
-            ConfigurationService::parseResourceVersionsForEventFilteringAndCaching);
+                defaultNonSSAResource, ConfigurationService::defaultNonSSAResources);
       }
 
       @Override
       public boolean useSSAToPatchPrimaryResource() {
         return overriddenValueOrDefault(
-            useSSAToPatchPrimaryResource, ConfigurationService::useSSAToPatchPrimaryResource);
+                useSSAToPatchPrimaryResource, ConfigurationService::useSSAToPatchPrimaryResource);
       }
 
       @Override
       public boolean cloneSecondaryResourcesWhenGettingFromCache() {
         return overriddenValueOrDefault(
-            cloneSecondaryResourcesWhenGettingFromCache,
-            ConfigurationService::cloneSecondaryResourcesWhenGettingFromCache);
-      }
-
-      @Override
-      public Set<Class<? extends HasMetadata>>
-          withPreviousAnnotationForDependentResourcesBlocklist() {
-        return overriddenValueOrDefault(
-            previousAnnotationUsageBlocklist,
-            ConfigurationService::withPreviousAnnotationForDependentResourcesBlocklist);
+                cloneSecondaryResourcesWhenGettingFromCache,
+                ConfigurationService::cloneSecondaryResourcesWhenGettingFromCache);
       }
     };
-  }
-}
+}}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/KubernetesDependentResource.java
@@ -55,7 +55,6 @@ public abstract class KubernetesDependentResource<R extends HasMetadata, P exten
   private final boolean garbageCollected = this instanceof GarbageCollected;
   private KubernetesDependentResourceConfig<R> kubernetesDependentResourceConfig;
   private volatile Boolean useSSA;
-  private volatile Boolean usePreviousAnnotationForEventFiltering;
 
   public KubernetesDependentResource() {}
 
@@ -158,14 +157,6 @@ protected void addMetadata(
       } else {
         annotations.remove(InformerEventSource.PREVIOUS_ANNOTATION_KEY);
       }
-    } else if (usePreviousAnnotation(context)) { // set a new one
-      eventSource()
-          .orElseThrow()
-          .addPreviousAnnotation(
-              Optional.ofNullable(actualResource)
-                  .map(r -> r.getMetadata().getResourceVersion())
-                  .orElse(null),
-              target);
     }
     addReferenceHandlingMetadata(target, primary);
   }
@@ -181,22 +172,6 @@ protected boolean useSSA(Context<P> context) {
     return useSSA;
   }
 
-  private boolean usePreviousAnnotation(Context<P> context) {
-    if (usePreviousAnnotationForEventFiltering == null) {
-      usePreviousAnnotationForEventFiltering =
-          context
-                  .getControllerConfiguration()
-                  .getConfigurationService()
-                  .previousAnnotationForDependentResourcesEventFiltering()
-              && !context
-                  .getControllerConfiguration()
-                  .getConfigurationService()
-                  .withPreviousAnnotationForDependentResourcesBlocklist()
-                  .contains(this.resourceType());
-    }
-    return usePreviousAnnotationForEventFiltering;
-  }
-
   @Override
   protected void handleDelete(P primary, R secondary, Context<P> context) {
     if (secondary != null) {
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java
@@ -84,30 +84,20 @@ public InformerEventSource(
       InformerEventSourceConfiguration<R> configuration, EventSourceContext<P> context) {
     this(
         configuration,
-        configuration.getKubernetesClient().orElse(context.getClient()),
-        context
-            .getControllerConfiguration()
-            .getConfigurationService()
-            .parseResourceVersionsForEventFilteringAndCaching());
-  }
-
-  InformerEventSource(InformerEventSourceConfiguration<R> configuration, KubernetesClient client) {
-    this(configuration, client, false);
+        configuration.getKubernetesClient().orElse(context.getClient()));
   }
 
   @SuppressWarnings({"unchecked", "rawtypes"})
   private InformerEventSource(
       InformerEventSourceConfiguration<R> configuration,
-      KubernetesClient client,
-      boolean parseResourceVersions) {
+      KubernetesClient client) {
     super(
         configuration.name(),
         configuration
             .getGroupVersionKind()
             .map(gvk -> client.genericKubernetesResources(gvk.apiVersion(), gvk.getKind()))
             .orElseGet(() -> (MixedOperation) client.resources(configuration.getResourceClass())),
-        configuration,
-        parseResourceVersions);
+        configuration);
     // If there is a primary to secondary mapper there is no need for primary to secondary index.
     primaryToSecondaryMapper = configuration.getPrimaryToSecondaryMapper();
     if (useSecondaryToPrimaryIndex()) {
@@ -333,22 +323,6 @@ private boolean acceptedByDeleteFilters(R resource, boolean b) {
         && (genericFilter == null || genericFilter.accept(resource));
   }
 
-  /**
-   * Add an annotation to the resource so that the subsequent will be omitted
-   *
-   * @param resourceVersion null if there is no prior version
-   * @param target mutable resource that will be returned
-   */
-  public R addPreviousAnnotation(String resourceVersion, R target) {
-    target
-        .getMetadata()
-        .getAnnotations()
-        .put(
-            PREVIOUS_ANNOTATION_KEY,
-            id + Optional.ofNullable(resourceVersion).map(rv -> "," + rv).orElse(""));
-    return target;
-  }
-
   private enum Operation {
     ADD,
     UPDATE
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryResourceCache.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryResourceCache.java
