Skip to content

fix issue 912: do dedupe with resourceVersion #1259

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

Merged
merged 5 commits into from
Sep 15, 2020
Merged

fix issue 912: do dedupe with resourceVersion #1259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
603fe98
fix issue 912: do dedupe with resourceVersion
fishautumn Sep 11, 2020
d0ab04b
fix coding style
fishautumn Sep 11, 2020
765caef
add comments
fishautumn Sep 14, 2020
c66e385
fix coding style
fishautumn Sep 14, 2020
11a4833
use factory member http client to invoke watch call; throw IllegalArg…
fishautumn Sep 15, 2020
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
25 changes: 13 additions & 12 deletions util/src/main/java/io/kubernetes/client/informer/SharedInformerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import okhttp3.Call;
import okhttp3.OkHttpClient;
import org.apache.commons.collections4.MapUtils;

/** SharedInformerFactory class constructs and caches informers for api types. */
Expand All @@ -49,7 +47,7 @@ public class SharedInformerFactory {

/** Constructor w/ default thread pool. */
public SharedInformerFactory() {
this(Configuration.getDefaultApiClient(), Executors.newCachedThreadPool());
this(Configuration.getDefaultApiClient().setReadTimeout(0), Executors.newCachedThreadPool());
}

/** Constructor w/ api client specified and default thread pool. */
Expand All @@ -63,7 +61,7 @@ public SharedInformerFactory(ApiClient apiClient) {
* @param threadPool specified thread pool
*/
public SharedInformerFactory(ExecutorService threadPool) {
this(Configuration.getDefaultApiClient(), threadPool);
this(Configuration.getDefaultApiClient().setReadTimeout(0), threadPool);
}

/**
Expand All @@ -73,6 +71,10 @@ public SharedInformerFactory(ExecutorService threadPool) {
* @param threadPool specified thread pool
*/
public SharedInformerFactory(ApiClient client, ExecutorService threadPool) {
if (client.getReadTimeout() != 0) {
throw new IllegalArgumentException("read timeout of ApiClient must be zero");
}

apiClient = client;
informerExecutor = threadPool;
informers = new HashMap<>();
Expand Down Expand Up @@ -169,11 +171,9 @@ ListerWatcher<ApiType, ApiListType> listerWatcherFor(
CallGenerator callGenerator,
Class<ApiType> apiTypeClass,
Class<ApiListType> apiListTypeClass) {
if (apiClient.getHttpClient().readTimeoutMillis() > 0) {
if (apiClient.getReadTimeout() > 0) {
// set read timeout zero to ensure client doesn't time out
OkHttpClient httpClient =
apiClient.getHttpClient().newBuilder().readTimeout(0, TimeUnit.MILLISECONDS).build();
apiClient.setHttpClient(httpClient);
apiClient.setReadTimeout(0);
}
return new ListerWatcher<ApiType, ApiListType>() {
@Override
Expand All @@ -185,6 +185,8 @@ public ApiListType list(CallGeneratorParams params) throws ApiException {
@Override
public Watch<ApiType> watch(CallGeneratorParams params) throws ApiException {
Call call = callGenerator.generate(params);
// bind call with private http client to make sure read timeout is zero.
call = apiClient.getHttpClient().newCall(call.request());
return Watch.createWatch(
apiClient,
call,
Expand All @@ -196,12 +198,11 @@ public Watch<ApiType> watch(CallGeneratorParams params) throws ApiException {
private <ApiType extends KubernetesObject, ApiListType extends KubernetesListObject>
ListerWatcher<ApiType, ApiListType> listerWatcherFor(
GenericKubernetesApi<ApiType, ApiListType> genericKubernetesApi) {
if (apiClient.getHttpClient().readTimeoutMillis() > 0) {
if (apiClient.getReadTimeout() > 0) {
// set read timeout zero to ensure client doesn't time out
OkHttpClient httpClient =
apiClient.getHttpClient().newBuilder().readTimeout(0, TimeUnit.MILLISECONDS).build();
apiClient.setHttpClient(httpClient);
apiClient.setReadTimeout(0);
}
// TODO: it seems read timeout is determined by genericKubernetesApi instead of above apiClient.
return new ListerWatcher<ApiType, ApiListType>() {
public ApiListType list(CallGeneratorParams params) throws ApiException {
return genericKubernetesApi
Expand Down
18 changes: 17 additions & 1 deletion 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 @@ -29,6 +29,7 @@
import java.util.function.Consumer;
import java.util.function.Function;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.MutablePair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -443,7 +444,22 @@ private Deque<MutablePair<DeltaType, KubernetesObject>> combineDeltas(
*/
private MutablePair<DeltaType, KubernetesObject> isDuplicate(
MutablePair<DeltaType, KubernetesObject> d1, MutablePair<DeltaType, KubernetesObject> d2) {
return isDeletionDup(d1, d2);
MutablePair<DeltaType, KubernetesObject> deletionDelta = isDeletionDup(d1, d2);

// TODO: remove this after the cause of memory leakage is confirmed
// Squashing deltas w/ the same resource version, note that is a temporary fix that eases memory
// intensity.
if (deletionDelta != null) {
return deletionDelta;
}
if (d1.getLeft() != DeltaType.Deleted
&& d2.getLeft() != DeltaType.Deleted
&& StringUtils.equals(
d1.getRight().getMetadata().getResourceVersion(),
d2.getRight().getMetadata().getResourceVersion())) {
return d1;
}
return null;
}

/**
Expand Down
11 changes: 10 additions & 1 deletion 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 @@ -20,6 +20,7 @@
import io.kubernetes.client.openapi.models.V1ObjectMeta;
import io.kubernetes.client.openapi.models.V1Pod;
import java.util.Arrays;
import java.util.Collections;
import java.util.Deque;
import java.util.LinkedList;
import org.apache.commons.lang3.tuple.MutablePair;
Expand Down Expand Up @@ -94,7 +95,9 @@ public void testDeltaFIFOBasic() throws InterruptedException {

@Test
public void testDeltaFIFODedup() {
V1Pod foo1 = new V1Pod().metadata(new V1ObjectMeta().name("foo1").namespace("default"));
V1Pod foo1 =
new V1Pod()
.metadata(new V1ObjectMeta().name("foo1").namespace("default").resourceVersion("ver"));
Cache cache = new Cache();
DeltaFIFO deltaFIFO = new DeltaFIFO(Caches::deletionHandlingMetaNamespaceKeyFunc, cache);
Deque<MutablePair<DeltaFIFO.DeltaType, KubernetesObject>> deltas;
Expand All @@ -121,6 +124,12 @@ public void testDeltaFIFODedup() {
assertEquals(foo1, deltas.peekFirst().getRight());
assertEquals(2, deltas.size());
deltaFIFO.getItems().remove(Caches.deletionHandlingMetaNamespaceKeyFunc(foo1));

// add-sync dedupe
deltaFIFO.add(foo1);
deltaFIFO.replace(Collections.singletonList(foo1), foo1.getMetadata().getResourceVersion());
deltas = deltaFIFO.getItems().get(Caches.deletionHandlingMetaNamespaceKeyFunc(foo1));
assertEquals(1, deltas.size());
}

@Test
Expand Down