Event filtering now records resource action and previous resource

csviri · csviri · commit da91b742e342 · 2026-01-15T15:53:26.000+01:00
This is important to have a correct further event propagation

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/processing/event/EventProcessor.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventProcessor.java
@@ -37,7 +37,7 @@
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter.RateLimitState;
 import io.javaoperatorsdk.operator.processing.event.source.Cache;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceDeleteEvent;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEvent;
 import io.javaoperatorsdk.operator.processing.event.source.timer.TimerEventSource;
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventSourceManager.java
@@ -37,9 +37,9 @@
 import io.javaoperatorsdk.operator.processing.LifecycleAware;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
 import io.javaoperatorsdk.operator.processing.event.source.EventSourceStartPriority;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventAware;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ControllerEventSource;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.informer.ManagedInformerEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.timer.TimerEventSource;
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/ResourceAction.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/ResourceAction.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.javaoperatorsdk.operator.processing.event.source.controller;
+package io.javaoperatorsdk.operator.processing.event.source;
 
 public enum ResourceAction {
   ADDED,
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerEventSource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerEventSource.java
@@ -28,6 +28,7 @@
 import io.javaoperatorsdk.operator.processing.Controller;
 import io.javaoperatorsdk.operator.processing.MDCUtils;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnDeleteFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
 import io.javaoperatorsdk.operator.processing.event.source.informer.ManagedInformerEventSource;
@@ -139,13 +140,15 @@ private boolean isAcceptedByFilters(ResourceAction action, T resource, T oldReso
 
   @Override
   public void onAdd(T resource) {
-    var handling = temporaryResourceCache.onAddOrUpdateEvent(resource);
+    var handling = temporaryResourceCache.onAddOrUpdateEvent(ResourceAction.ADDED, resource, null);
     handleEvent(ResourceAction.ADDED, resource, null, null, handling != EventHandling.NEW);
   }
 
   @Override
   public void onUpdate(T oldCustomResource, T newCustomResource) {
-    var handling = temporaryResourceCache.onAddOrUpdateEvent(newCustomResource);
+    var handling =
+        temporaryResourceCache.onAddOrUpdateEvent(
+            ResourceAction.UPDATED, newCustomResource, oldCustomResource);
     handleEvent(
         ResourceAction.UPDATED,
         newCustomResource,
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ResourceDeleteEvent.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ResourceDeleteEvent.java
@@ -19,6 +19,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 
 /**
  * Extends ResourceEvent for informer Delete events, it holds also information if the final state is
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ResourceEvent.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ResourceEvent.java
@@ -21,6 +21,7 @@
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 
 public class ResourceEvent extends Event {
 
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ExtendedResourceEvent.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ExtendedResourceEvent.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright Java Operator SDK Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.javaoperatorsdk.operator.processing.event.source.informer;
+
+import java.util.Optional;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
+import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEvent;
+
+/** Used only for resource event filtering. */
+public class ExtendedResourceEvent extends ResourceEvent {
+
+  private HasMetadata previousResource;
+
+  public ExtendedResourceEvent(
+      ResourceAction action,
+      ResourceID resourceID,
+      HasMetadata latestResource,
+      HasMetadata previousResource) {
+    super(action, resourceID, latestResource);
+    this.previousResource = previousResource;
+  }
+
+  public Optional<HasMetadata> getPreviousResource() {
+    return Optional.ofNullable(previousResource);
+  }
+}
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
@@ -32,7 +32,7 @@
 import io.javaoperatorsdk.operator.processing.event.EventHandler;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.PrimaryToSecondaryMapper;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.informer.TemporaryResourceCache.EventHandling;
 
 import static io.javaoperatorsdk.operator.api.reconciler.Constants.DEFAULT_COMPARABLE_RESOURCE_VERSION;
@@ -107,7 +107,7 @@ public void onAdd(R newResource) {
           resourceType().getSimpleName(),
           newResource.getMetadata().getResourceVersion());
     }
-    onAddOrUpdate(Operation.ADD, newResource, null);
+    onAddOrUpdate(ResourceAction.ADDED, newResource, null);
   }
 
   @Override
@@ -120,7 +120,7 @@ public void onUpdate(R oldObject, R newObject) {
           newObject.getMetadata().getResourceVersion(),
           oldObject.getMetadata().getResourceVersion());
     }
-    onAddOrUpdate(Operation.UPDATE, newObject, oldObject);
+    onAddOrUpdate(ResourceAction.UPDATED, newObject, oldObject);
   }
 
   @Override
@@ -156,27 +156,27 @@ public synchronized void start() {
     manager().list().forEach(primaryToSecondaryIndex::onAddOrUpdate);
   }
 
-  private synchronized void onAddOrUpdate(Operation operation, R newObject, R oldObject) {
+  private synchronized void onAddOrUpdate(ResourceAction action, R newObject, R oldObject) {
     primaryToSecondaryIndex.onAddOrUpdate(newObject);
     var resourceID = ResourceID.fromResource(newObject);
 
-    var eventHandling = temporaryResourceCache.onAddOrUpdateEvent(newObject);
+    var eventHandling = temporaryResourceCache.onAddOrUpdateEvent(action, newObject, oldObject);
 
     if (eventHandling != EventHandling.NEW) {
       log.debug(
           "{} event propagation for {}. Resource ID: {}",
           eventHandling == EventHandling.DEFER ? "Deferring" : "Skipping",
-          operation,
+          action,
           ResourceID.fromResource(newObject));
-    } else if (eventAcceptedByFilter(operation, newObject, oldObject)) {
+    } else if (eventAcceptedByFilter(action, newObject, oldObject)) {
       log.debug(
           "Propagating event for {}, resource with same version not result of a reconciliation."
               + " Resource ID: {}",
-          operation,
+          action,
           resourceID);
       propagateEvent(newObject);
     } else {
-      log.debug("Event filtered out for operation: {}, resourceID: {}", operation, resourceID);
+      log.debug("Event filtered out for operation: {}, resourceID: {}", action, resourceID);
     }
   }
 
@@ -251,11 +251,11 @@ public boolean allowsNamespaceChanges() {
     return configuration().followControllerNamespaceChanges();
   }
 
-  private boolean eventAcceptedByFilter(Operation operation, R newObject, R oldObject) {
+  private boolean eventAcceptedByFilter(ResourceAction operation, R newObject, R oldObject) {
     if (genericFilter != null && !genericFilter.accept(newObject)) {
       return false;
     }
-    if (operation == Operation.ADD) {
+    if (operation == ResourceAction.ADDED) {
       return onAddFilter == null || onAddFilter.accept(newObject);
     } else {
       return onUpdateFilter == null || onUpdateFilter.accept(newObject, oldObject);
@@ -266,9 +266,4 @@ private boolean acceptedByDeleteFilters(R resource, boolean b) {
     return (onDeleteFilter == null || onDeleteFilter.accept(resource, b))
         && (genericFilter == null || genericFilter.accept(resource));
   }
-
-  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
@@ -42,7 +42,7 @@
 import io.javaoperatorsdk.operator.health.Status;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.*;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceDeleteEvent;
 
 @SuppressWarnings("rawtypes")
@@ -90,6 +90,7 @@ public void changeNamespaces(Set<String> namespaces) {
    * Also makes sure that the even produced by this update is filtered, thus does not trigger the
    * reconciliation.
    */
+  @SuppressWarnings("unchecked")
   public R eventFilteringUpdateAndCacheResource(R resourceToUpdate, UnaryOperator<R> updateMethod) {
     ResourceID id = ResourceID.fromResource(resourceToUpdate);
     if (log.isDebugEnabled()) {
@@ -110,12 +111,21 @@ public R eventFilteringUpdateAndCacheResource(R resourceToUpdate, UnaryOperator<
       res.ifPresent(
           r -> {
             R latestResource = (R) r.getResource().orElseThrow();
-            // for update we need to have a historic resource, this might be improved to mimic more
-            // realistic scenario
+
+            // as previous resource version we use the one from successful update, since
+            // we process new event here only if that is more recent then the event from our update.
+            // Note that this is equivalent with the scenario when an informer watch connection
+            // would
+            // reconnect and loose some events in between.
+            // If that update was not successful we still record the previous version from the
+            // actual
+            // event in the ExtendedResourceEvent.
+            R extendedResourcePrevVersion =
+                (r instanceof ExtendedResourceEvent)
+                    ? (R) ((ExtendedResourceEvent) r).getPreviousResource().orElse(null)
+                    : null;
             R prevVersionOfResource =
-                updatedForLambda != null
-                    ? updatedForLambda
-                    : (r.getAction() == ResourceAction.UPDATED ? latestResource : null);
+                updatedForLambda != null ? updatedForLambda : extendedResourcePrevVersion;
             handleEvent(
                 r.getAction(),
                 latestResource,
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
@@ -27,7 +27,7 @@
 import io.javaoperatorsdk.operator.api.reconciler.ReconcileUtils;
 import io.javaoperatorsdk.operator.processing.dependent.kubernetes.KubernetesDependentResource;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceDeleteEvent;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEvent;
 
@@ -94,17 +94,23 @@ public synchronized Optional<ResourceEvent> doneEventFilterModify(
   }
 
   public void onDeleteEvent(T resource, boolean unknownState) {
-    onEvent(resource, unknownState, true);
+    onEvent(ResourceAction.DELETED, resource, null, unknownState, true);
   }
 
   /**
    * @return true if the resourceVersion was obsolete
    */
-  public EventHandling onAddOrUpdateEvent(T resource) {
-    return onEvent(resource, false, false);
+  public EventHandling onAddOrUpdateEvent(
+      ResourceAction action, T resource, T prevResourceVersion) {
+    return onEvent(action, resource, prevResourceVersion, false, false);
   }
 
-  private synchronized EventHandling onEvent(T resource, boolean unknownState, boolean delete) {
+  private synchronized EventHandling onEvent(
+      ResourceAction action,
+      T resource,
+      T prevResourceVersion,
+      boolean unknownState,
+      boolean delete) {
     if (!comparableResourceVersions) {
       return EventHandling.NEW;
     }
@@ -139,8 +145,7 @@ private synchronized EventHandling onEvent(T resource, boolean unknownState, boo
       ed.setLastEvent(
           delete
               ? new ResourceDeleteEvent(ResourceAction.DELETED, resourceId, resource, unknownState)
-              : new ResourceEvent(
-                  ResourceAction.UPDATED, resourceId, resource)); // todo true action
+              : new ExtendedResourceEvent(action, resourceId, resource, prevResourceVersion));
       return EventHandling.DEFER;
     } else {
       return result;
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/EventProcessorTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/EventProcessorTest.java
@@ -38,8 +38,8 @@
 import io.javaoperatorsdk.operator.processing.event.rate.LinearRateLimiter;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter;
 import io.javaoperatorsdk.operator.processing.event.rate.RateLimiter.RateLimitState;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ControllerEventSource;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceDeleteEvent;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEvent;
 import io.javaoperatorsdk.operator.processing.event.source.timer.TimerEventSource;
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ResourceStateManagerTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ResourceStateManagerTest.java
@@ -20,7 +20,7 @@
 import org.junit.jupiter.api.Test;
 
 import io.javaoperatorsdk.operator.TestUtils;
-import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceAction;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEvent;
 
 import static org.assertj.core.api.Assertions.assertThat;
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerEventSourceTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerEventSourceTest.java
@@ -34,6 +34,7 @@
 import io.javaoperatorsdk.operator.processing.event.EventHandler;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;
 import io.javaoperatorsdk.operator.processing.event.source.AbstractEventSourceTestBase;
+import io.javaoperatorsdk.operator.processing.event.source.ResourceAction;
 import io.javaoperatorsdk.operator.processing.event.source.filter.GenericFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnAddFilter;
 import io.javaoperatorsdk.operator.processing.event.source.filter.OnUpdateFilter;
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSourceTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSourceTest.java
@@ -99,7 +99,8 @@ void skipsEventPropagation() {
     when(temporaryResourceCacheMock.getResourceFromCache(any()))
         .thenReturn(Optional.of(testDeployment()));
 
-    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any())).thenReturn(EventHandling.OBSOLETE);
+    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any(), any(), any()))
+        .thenReturn(EventHandling.OBSOLETE);
 
     informerEventSource.onAdd(testDeployment());
     informerEventSource.onUpdate(testDeployment(), testDeployment());
@@ -109,15 +110,17 @@ void skipsEventPropagation() {
 
   @Test
   void processEventPropagationWithoutAnnotation() {
-    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any())).thenReturn(EventHandling.NEW);
+    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any(), any(), any()))
+        .thenReturn(EventHandling.NEW);
     informerEventSource.onUpdate(testDeployment(), testDeployment());
 
     verify(eventHandlerMock, times(1)).handleEvent(any());
   }
 
   @Test
   void processEventPropagationWithIncorrectAnnotation() {
-    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any())).thenReturn(EventHandling.NEW);
+    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any(), any(), any()))
+        .thenReturn(EventHandling.NEW);
     informerEventSource.onAdd(
         new DeploymentBuilder(testDeployment())
             .editMetadata()
@@ -134,12 +137,14 @@ void propagateEventAndRemoveResourceFromTempCacheIfResourceVersionMismatch() {
     cachedDeployment.getMetadata().setResourceVersion(PREV_RESOURCE_VERSION);
     when(temporaryResourceCacheMock.getResourceFromCache(any()))
         .thenReturn(Optional.of(cachedDeployment));
-    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any())).thenReturn(EventHandling.NEW);
+    when(temporaryResourceCacheMock.onAddOrUpdateEvent(any(), any(), any()))
+        .thenReturn(EventHandling.NEW);
 
     informerEventSource.onUpdate(cachedDeployment, testDeployment());
 
     verify(eventHandlerMock, times(1)).handleEvent(any());
-    verify(temporaryResourceCacheMock, times(1)).onAddOrUpdateEvent(testDeployment());
+    verify(temporaryResourceCacheMock, times(1))
+        .onAddOrUpdateEvent(any(), eq(testDeployment()), any());
   }
 
   @Test
diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryPrimaryResourceCacheTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryPrimaryResourceCacheTest.java
