Skip to content

Fix DeltaFIFO relist deletion detection for queued objects #4988

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Fix DeltaFIFO relist deletion detection for queued objects #4988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
087e931
Initial plan
Copilot Nov 4, 2026
028aad1
Fix DeltaFIFO relist deletion detection for queued objects
Copilot Nov 4, 2026
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
63 changes: 30 additions & 33 deletions util/src/main/java/io/kubernetes/client/informer/cache/DeltaFIFO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,47 +158,44 @@ public void replace(List<KubernetesObject> list, String resourceVersion) {
this.queueActionLocked(DeltaType.Sync, obj);
}

if (this.knownObjects == null) {
for (Map.Entry<String, Deque<MutablePair<DeltaType, KubernetesObject>>> entry :
this.items.entrySet()) {
if (keys.contains(entry.getKey())) {
continue;
}

KubernetesObject deletedObj = null;
MutablePair<DeltaType, KubernetesObject> delta =
entry.getValue().peekLast(); // get newest
if (delta != null) {
deletedObj = delta.getRight();
}
this.queueActionLocked(
DeltaType.Deleted, new DeletedFinalStateUnknown(entry.getKey(), deletedObj));
int queueDeletion = 0;
for (Map.Entry<String, Deque<MutablePair<DeltaType, KubernetesObject>>> entry :
this.items.entrySet()) {
if (keys.contains(entry.getKey())) {
continue;
}

if (!this.populated) {
this.populated = true;
this.initialPopulationCount = list.size();
KubernetesObject deletedObj = null;
MutablePair<DeltaType, KubernetesObject> delta = entry.getValue().peekLast(); // get newest
if (delta != null) {
deletedObj = delta.getRight();
if (deletedObj instanceof DeletedFinalStateUnknown) {
deletedObj = ((DeletedFinalStateUnknown<?>) deletedObj).getObj();
}
}
return;
queueDeletion++;
this.queueActionLocked(
DeltaType.Deleted, new DeletedFinalStateUnknown(entry.getKey(), deletedObj));
}

// Detect deletions not already in the queue.
List<String> knownKeys = this.knownObjects.listKeys();
int queueDeletion = 0;
for (String knownKey : knownKeys) {
if (keys.contains(knownKey)) {
continue;
}
if (this.knownObjects != null) {
List<String> knownKeys = this.knownObjects.listKeys();
for (String knownKey : knownKeys) {
if (keys.contains(knownKey) || this.items.containsKey(knownKey)) {
continue;
}

KubernetesObject deletedObj = this.knownObjects.getByKey(knownKey);
if (deletedObj == null) {
log.warn(
"Key {} does not exist in known objects store, placing DeleteFinalStateUnknown marker without object",
knownKey);
KubernetesObject deletedObj = this.knownObjects.getByKey(knownKey);
if (deletedObj == null) {
log.warn(
"Key {} does not exist in known objects store, placing DeleteFinalStateUnknown marker without object",
knownKey);
}
queueDeletion++;
this.queueActionLocked(
DeltaType.Deleted, new DeletedFinalStateUnknown(knownKey, deletedObj));
}
queueDeletion++;
this.queueActionLocked(
DeltaType.Deleted, new DeletedFinalStateUnknown(knownKey, deletedObj));
}

if (!this.populated) {
Expand Down
116 changes: 116 additions & 0 deletions util/src/test/java/io/kubernetes/client/informer/cache/DeltaFIFOTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
import java.util.LinkedList;
import org.apache.commons.lang3.tuple.MutablePair;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;

class DeltaFIFOTest {
@Test
Expand Down Expand Up @@ -156,9 +158,11 @@ void deltaFIFOReplaceWithDeleteDeltaIn() throws InterruptedException {

deltaFIFO.delete(oldPod);
deltaFIFO.replace(Arrays.asList(newPod), "0");
deltaFIFO.replace(Arrays.asList(newPod), "0");

deltaFIFO.pop(
(deltas) -> {
assertThat(deltas).hasSize(1);
assertThat(deltas.getFirst().getLeft()).isEqualTo(DeltaFIFO.DeltaType.Deleted);
assertThat(deltas.getFirst().getRight()).isEqualTo(oldPod);
});
Expand All @@ -169,4 +173,116 @@ void deltaFIFOReplaceWithDeleteDeltaIn() throws InterruptedException {
assertThat(deltas.getFirst().getRight()).isEqualTo(newPod);
});
}

@ParameterizedTest
@CsvSource({"false,false", "true,false", "true,true"})
void replaceDeletesPendingObjectUsingNewestDelta(boolean withStore, boolean cached)
throws InterruptedException {
V1Pod oldPod =
new V1Pod()
.metadata(new V1ObjectMeta().namespace("default").name("foo").resourceVersion("1"));
V1Pod newPod =
new V1Pod()
.metadata(new V1ObjectMeta().namespace("default").name("foo").resourceVersion("2"));
Cache<V1Pod> cache = new Cache<>();
DeltaFIFO fifo =
new DeltaFIFO(Caches::deletionHandlingMetaNamespaceKeyFunc, withStore ? cache : null);
fifo.replace(Collections.emptyList(), "0");
if (cached) {
cache.add(oldPod);
}
fifo.add(oldPod);
fifo.update(newPod);

fifo.replace(Collections.emptyList(), "3");
fifo.replace(Collections.emptyList(), "4");

assertThat(fifo.listKeys()).containsExactly("default/foo");
fifo.pop(
deltas -> {
assertThat(deltas)
.extracting(MutablePair::getLeft)
.containsExactly(
DeltaFIFO.DeltaType.Added,
DeltaFIFO.DeltaType.Updated,
DeltaFIFO.DeltaType.Deleted);
DeltaFIFO.DeletedFinalStateUnknown<?> tombstone =
(DeltaFIFO.DeletedFinalStateUnknown<?>) deltas.peekLast().getRight();
assertThat(tombstone.getKey()).isEqualTo("default/foo");
assertThat(tombstone.getObj()).isSameAs(newPod);
});
assertThat(fifo.listKeys()).isEmpty();
assertThat(fifo.hasSynced()).isTrue();
}

@Test
void replaceDeletesRecreatedObjectUsingNewestDelta() throws InterruptedException {
V1Pod oldPod =
new V1Pod()
.metadata(
new V1ObjectMeta()
.namespace("default")
.name("foo")
.uid("old")
.resourceVersion("1"));
V1Pod newPod =
new V1Pod()
.metadata(
new V1ObjectMeta()
.namespace("default")
.name("foo")
.uid("new")
.resourceVersion("2"));
Cache<V1Pod> cache = new Cache<>();
cache.add(oldPod);
DeltaFIFO fifo = new DeltaFIFO(Caches::deletionHandlingMetaNamespaceKeyFunc, cache);
fifo.delete(oldPod);
fifo.add(newPod);

fifo.replace(Collections.emptyList(), "3");

fifo.pop(
deltas -> {
assertThat(deltas)
.extracting(MutablePair::getLeft)
.containsExactly(
DeltaFIFO.DeltaType.Deleted,
DeltaFIFO.DeltaType.Added,
DeltaFIFO.DeltaType.Deleted);
assertThat(deltas.peekFirst().getRight()).isSameAs(oldPod);
DeltaFIFO.DeletedFinalStateUnknown<?> tombstone =
(DeltaFIFO.DeletedFinalStateUnknown<?>) deltas.peekLast().getRight();
assertThat(tombstone.getObj()).isSameAs(newPod);
});
assertThat(fifo.listKeys()).isEmpty();
}

@Test
void replaceCountsCachedDeletionsDuringInitialSync() throws InterruptedException {
V1Pod missing = new V1Pod().metadata(new V1ObjectMeta().namespace("default").name("missing"));
V1Pod present = new V1Pod().metadata(new V1ObjectMeta().namespace("default").name("present"));
Cache<V1Pod> cache = new Cache<>();
cache.add(missing);
DeltaFIFO fifo = new DeltaFIFO(Caches::deletionHandlingMetaNamespaceKeyFunc, cache);

fifo.replace(Collections.singletonList(present), "1");
assertThat(fifo.hasSynced()).isFalse();
fifo.pop(
deltas -> {
assertThat(deltas).hasSize(1);
assertThat(deltas.peekFirst().getLeft()).isEqualTo(DeltaFIFO.DeltaType.Sync);
assertThat(deltas.peekFirst().getRight()).isSameAs(present);
});
assertThat(fifo.hasSynced()).isFalse();
fifo.pop(
deltas -> {
assertThat(deltas).hasSize(1);
assertThat(deltas.peekFirst().getLeft()).isEqualTo(DeltaFIFO.DeltaType.Deleted);
DeltaFIFO.DeletedFinalStateUnknown<?> tombstone =
(DeltaFIFO.DeletedFinalStateUnknown<?>) deltas.peekFirst().getRight();
assertThat(tombstone.getObj()).isSameAs(missing);
});
assertThat(fifo.hasSynced()).isTrue();
assertThat(fifo.listKeys()).isEmpty();
}
}
61 changes: 56 additions & 5 deletions util/src/test/java/io/kubernetes/client/informer/impl/DefaultSharedIndexInformerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,32 @@
*/
package io.kubernetes.client.informer.impl;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;

import io.kubernetes.client.informer.ListerWatcher;
import io.kubernetes.client.informer.cache.Cache;
import io.kubernetes.client.informer.cache.Caches;
import io.kubernetes.client.informer.cache.DeltaFIFO;
import io.kubernetes.client.informer.cache.Indexer;
import io.kubernetes.client.openapi.models.V1ObjectMeta;
import io.kubernetes.client.openapi.models.V1Pod;
import io.kubernetes.client.openapi.models.V1PodList;
import io.kubernetes.client.util.Threads;
import java.util.Collections;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;
import java.util.function.BiConsumer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class DefaultSharedIndexInformerTest {

Expand Down Expand Up @@ -80,4 +87,48 @@ void minimalConstructorExists() {

new DefaultSharedIndexInformer<>(anyApiType, listerWatcher, anyResyncPeriod);
}

@ParameterizedTest
@CsvSource({
"true,false,false",
"true,true,false",
"false,true,false",
"true,false,true",
"true,true,true",
"false,true,true"
})
void relistReconcilesPendingAndCachedObjects(boolean queued, boolean cached, boolean present)
throws InterruptedException {
V1Pod pod =
new V1Pod()
.metadata(new V1ObjectMeta().namespace("default").name("foo").resourceVersion("2"));
V1Pod listedPod =
new V1Pod()
.metadata(new V1ObjectMeta().namespace("default").name("foo").resourceVersion("3"));
Cache<V1Pod> cache = new Cache<>();
DeltaFIFO fifo = new DeltaFIFO(Caches::deletionHandlingMetaNamespaceKeyFunc, cache);
DefaultSharedIndexInformer<V1Pod, V1PodList> informer =
new DefaultSharedIndexInformer<>(anyApiType, listerWatcher, 0, fifo, cache);
fifo.replace(Collections.emptyList(), "1");
if (cached) {
cache.add(pod);
}
if (queued) {
fifo.add(pod);
}

fifo.replace(present ? Collections.singletonList(listedPod) : Collections.emptyList(), "3");
assertThat(fifo.listKeys()).containsExactly("default/foo");
fifo.pop(informer::handleDeltas);

if (present) {
assertThat(cache.list()).containsExactly(listedPod);
assertThat(cache.getByKey("default/foo")).isSameAs(listedPod);
} else {
assertThat(cache.list()).isEmpty();
assertThat(cache.getByKey("default/foo")).isNull();
}
assertThat(fifo.listKeys()).isEmpty();
assertThat(fifo.hasSynced()).isTrue();
}
}