Skip to content

fix: create state only on resource event #2899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,16 @@ public synchronized void handleEvent(Event event) {
try {
log.debug("Received event: {}", event);

final var optionalState = resourceStateManager.getOrCreateOnResourceEvent(event);
if (optionalState.isEmpty()) {
log.debug(
"Skipping event, since no state present and it is not a resource event. Resource ID:"
+ " {}",
event.getRelatedCustomResourceID());
return;
}
var state = optionalState.orElseThrow();
final var resourceID = event.getRelatedCustomResourceID();
final var state = resourceStateManager.getOrCreate(event.getRelatedCustomResourceID());
MDCUtils.addResourceIDInfo(resourceID);
metrics.receivedEvent(event, metricsMetadata);
handleEventMarking(event, state);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,33 @@

import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.Collectors;

import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEvent;

class ResourceStateManager {
// maybe we should have a way for users to specify a hint on the amount of CRs their reconciler
// will process to avoid under- or over-sizing the state maps and avoid too many resizing that
// take time and memory?
private final Map<ResourceID, ResourceState> states = new ConcurrentHashMap<>(100);

public Optional<ResourceState> getOrCreateOnResourceEvent(Event event) {
var resourceId = event.getRelatedCustomResourceID();
var state = states.get(event.getRelatedCustomResourceID());
if (state != null) {
return Optional.of(state);
}
if (event instanceof ResourceEvent) {
state = new ResourceState(resourceId);
states.put(resourceId, state);
return Optional.of(state);
} else {
return Optional.empty();
}
}

public ResourceState getOrCreate(ResourceID resourceID) {
return states.computeIfAbsent(resourceID, ResourceState::new);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,30 @@ void cancelScheduleOnceEventsOnSuccessfulExecution() {
verify(retryTimerEventSourceMock, times(1)).cancelOnceSchedule(eq(crID));
}

@Test
void skipsGenericEventIfNoResourceEventReceivedBefore() {
var crID = new ResourceID("test-cr", TEST_NAMESPACE);
eventProcessor =
spy(
new EventProcessor(
controllerConfiguration(null, LinearRateLimiter.deactivatedRateLimiter()),
reconciliationDispatcherMock,
eventSourceManagerMock,
metricsMock));

verify(reconciliationDispatcherMock, timeout(100).times(0)).handleExecution(any());

eventProcessor.start();
eventProcessor.handleEvent(new Event(crID));

await()
.pollDelay(Duration.ofMillis(100))
.untilAsserted(
() -> {
verify(reconciliationDispatcherMock, never()).handleExecution(any());
});
}

@Test
void startProcessedMarkedEventReceivedBefore() {
var crID = new ResourceID("test-cr", TEST_NAMESPACE);
Expand All @@ -287,7 +311,7 @@ void startProcessedMarkedEventReceivedBefore() {
eventSourceManagerMock,
metricsMock));
when(controllerEventSourceMock.get(eq(crID))).thenReturn(Optional.of(testCustomResource()));
eventProcessor.handleEvent(new Event(crID));
eventProcessor.handleEvent(new ResourceEvent(ResourceAction.ADDED, crID, testCustomResource()));

verify(reconciliationDispatcherMock, timeout(100).times(0)).handleExecution(any());

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
import org.junit.jupiter.api.BeforeEach;
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.controller.ResourceEvent;

import static org.assertj.core.api.Assertions.assertThat;

class ResourceStateManagerTest {
Expand Down Expand Up @@ -87,4 +91,26 @@ public void listsResourceIDSWithEventsPresent() {
assertThat(res).hasSize(1);
assertThat(res.get(0).getId()).isEqualTo(sampleResourceID2);
}

@Test
void createStateOnlyOnResourceEvent() {
var state = manager.getOrCreateOnResourceEvent(new Event(new ResourceID("newEvent")));

assertThat(state).isEmpty();

state =
manager.getOrCreateOnResourceEvent(
new ResourceEvent(
ResourceAction.ADDED, new ResourceID("newEvent"), TestUtils.testCustomResource()));

assertThat(state).isNotNull();
}

@Test
void createsOnlyResourceEventReturnsPreviouslyCreatedState() {
manager.getOrCreate(new ResourceID("newEvent"));

var res = manager.getOrCreateOnResourceEvent(new Event(new ResourceID("newEvent")));
assertThat(res).isNotNull();
}
}