feature: improvements on reschedule (#587)

The the execution is rescheduled only if there are no buffered events.

Author: csviri

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

@@ -152,7 +152,7 @@ public void close() {
     }
   }
 
-  private void executeBufferedEvents(String customResourceUid) {
+  private boolean executeBufferedEvents(String customResourceUid) {
     boolean newEventForResourceId = eventBuffer.containsEvents(customResourceUid);
     boolean controllerUnderExecution = isControllerUnderExecution(customResourceUid);
     Optional<CustomResource> latestCustomResource =
@@ -167,6 +167,7 @@ private void executeBufferedEvents(String customResourceUid) {
               retryInfo(customResourceUid));
       log.debug("Executing events for custom resource. Scope: {}", executionScope);
       executor.execute(new ControllerExecution(executionScope));
+      return true;
     } else {
       log.debug(
           "Skipping executing controller for resource id: {}. Events in queue: {}."
@@ -175,6 +176,7 @@ private void executeBufferedEvents(String customResourceUid) {
           newEventForResourceId,
           controllerUnderExecution,
           latestCustomResource.isPresent());
+      return false;
     }
   }
 
@@ -211,8 +213,10 @@ void eventProcessingFinished(
         cleanupAfterDeletedEvent(executionScope.getCustomResourceUid());
       } else {
         cacheUpdatedResourceIfChanged(executionScope, postExecutionControl);
-        reScheduleExecutionIfInstructed(postExecutionControl, executionScope.getCustomResource());
-        executeBufferedEvents(executionScope.getCustomResourceUid());
+        var executed = executeBufferedEvents(executionScope.getCustomResourceUid());
+        if (!executed) {
+          reScheduleExecutionIfInstructed(postExecutionControl, executionScope.getCustomResource());
+        }
       }
     } finally {
       lock.unlock();

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

@@ -232,6 +232,19 @@ public void scheduleTimedEventIfInstructedByPostExecutionControl() {
         .scheduleOnce(any(), eq(testDelay));
   }
 
+  @Test
+  public void reScheduleOnlyIfNotExecutedBufferedEvents() {
+    var testDelay = 10000l;
+    when(eventDispatcherMock.handleExecution(any()))
+        .thenReturn(PostExecutionControl.defaultDispatch().withReSchedule(testDelay));
+
+    defaultEventHandler.handleEvent(prepareCREvent());
+    defaultEventHandler.handleEvent(prepareCREvent());
+
+    verify(retryTimerEventSourceMock, timeout(SEPARATE_EXECUTION_TIMEOUT).times(0))
+        .scheduleOnce(any(), eq(testDelay));
+  }
+
   @Test
   public void doNotFireEventsIfClosing() {
     defaultEventHandler.close();

samples/common/crd/test_object.yaml

@@ -4,4 +4,4 @@ metadata:
   name: custom-service1
 spec:
   name: testservice1
-  label: testlabel
+  label: testlabel