Merge pull request #2424 from chrisr3/update-resource-version-for-wait

Author: fusesource-ci

CHANGELOG.md

@@ -48,6 +48,7 @@
 #### Improvements
 * Fix #2331: Fixed documentation for namespaced informer for all custom types implementing `Namespaced` interface
 * Fix #2406: Add documentation for serializing resources to YAML
+* Fix #2414: Allow withResourceVersion() to be followed by waitUntilCondition(), enabling recovery from HTTP 410 GONE errors.
 
 #### Dependency Upgrade
 * Fix #2360: bump mockito-core from 3.4.0 to 3.4.2

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/FilterWatchListDeletable.java

@@ -15,6 +15,6 @@
  */
 package io.fabric8.kubernetes.client.dsl;
 
-public interface FilterWatchListDeletable<T, L, B, H, W> extends Filterable<FilterWatchListDeletable<T, L, B, H, W>>, WatchListDeletable<T, L, B, H, W> {
+public interface FilterWatchListDeletable<T, L, B, H> extends Filterable<FilterWatchListDeletable<T, L, B, H>>, WatchListDeletable<T, L, B, H> {
 
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/FilterWatchListMultiDeletable.java

@@ -15,6 +15,6 @@
  */
 package io.fabric8.kubernetes.client.dsl;
 
-public interface FilterWatchListMultiDeletable<T, L, B, H, W> extends FilterWatchListDeletable<T, L, B, H, W>, MultiDeleteable<T, B> {
+public interface FilterWatchListMultiDeletable<T, L, B, H> extends FilterWatchListDeletable<T, L, B, H>, MultiDeleteable<T, B> {
 
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/NonNamespaceOperation.java

@@ -16,7 +16,6 @@
 package io.fabric8.kubernetes.client.dsl;
 
 import io.fabric8.kubernetes.client.Watch;
-import io.fabric8.kubernetes.client.Watcher;
 
 /**
  * The entry point to client operations that are either "cross namespace resources", or are available in the invocation chain
@@ -28,7 +27,7 @@
  */
 public interface NonNamespaceOperation<T, L, D, R> extends
   Nameable<R>,
-  FilterWatchListMultiDeletable<T, L, Boolean, Watch, Watcher<T>>,
+  FilterWatchListMultiDeletable<T, L, Boolean, Watch>,
   Createable<T, T, D>,
   CreateOrReplaceable<T, T, D>,
   Loadable<R> {

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/Operation.java

@@ -16,7 +16,6 @@
 package io.fabric8.kubernetes.client.dsl;
 
 import io.fabric8.kubernetes.client.Watch;
-import io.fabric8.kubernetes.client.Watcher;
 
 /**
  * The entry point to client operations.
@@ -27,8 +26,8 @@
  */
 public interface Operation<T, L, D, R>
   extends
-  AnyNamespaceable<FilterWatchListMultiDeletable<T, L, Boolean, Watch, Watcher<T>>>,
+  AnyNamespaceable<FilterWatchListMultiDeletable<T, L, Boolean, Watch>>,
   Namespaceable<NonNamespaceOperation<T, L, D, R>>,
-  FilterWatchListMultiDeletable<T, L, Boolean, Watch, Watcher<T>>,
+  FilterWatchListMultiDeletable<T, L, Boolean, Watch>,
   Loadable<R> {
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/Resource.java

@@ -16,7 +16,6 @@
 package io.fabric8.kubernetes.client.dsl;
 
 import io.fabric8.kubernetes.client.Watch;
-import io.fabric8.kubernetes.client.Watcher;
 
 /**
  * Interface that describes the operation that can be done on a Kubernetes resource (e.g. Pod, Service etc).
@@ -27,6 +26,6 @@
 public interface Resource<T, D> extends CreateOrReplaceable<T, T, D>,
   CreateFromServerGettable<T, T, D>,
   CascadingEditReplacePatchDeletable<T, T, D, Boolean>,
-  VersionWatchable<Watch, Watcher<T>>,
-  Waitable<T, T>, Requirable<T>, Readiable {
+  VersionWatchAndWaitable<Watch, T>,
+  Requirable<T>, Readiable {
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/VersionWatchable.java renamed to kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/VersionWatchAndWaitable.java

@@ -15,6 +15,5 @@
  */
 package io.fabric8.kubernetes.client.dsl;
 
-public interface VersionWatchable<H, W> extends Watchable<H, W>, Versionable<Watchable<H, W>> {
-
+public interface VersionWatchAndWaitable<H, T> extends WatchAndWaitable<H, T>, Versionable<WatchAndWaitable<H, T>> {
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/WatchAndWaitable.java

@@ -0,0 +1,21 @@
+/**
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * 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.fabric8.kubernetes.client.dsl;
+
+import io.fabric8.kubernetes.client.Watcher;
+
+public interface WatchAndWaitable<H, T> extends Watchable<H, Watcher<T>>, Waitable<T, T> {
+}

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/WatchListDeletable.java

@@ -17,8 +17,8 @@
 
 import io.fabric8.kubernetes.client.GracePeriodConfigurable;
 
-public interface WatchListDeletable<T, L, B, H, W> extends VersionWatchable<H, W>, Listable<L>, Deletable<B>,
-                                                           GracePeriodConfigurable<Deletable<B>>,
-                                                           StatusUpdatable<T>
+public interface WatchListDeletable<T, L, B, H> extends VersionWatchAndWaitable<H, T>, Listable<L>, Deletable<B>,
+                                                        GracePeriodConfigurable<Deletable<B>>,
+                                                        StatusUpdatable<T>
 {
 }

kubernetes-client/src/main/java/io/fabric8/kubernetes/client/dsl/base/BaseOperation.java

@@ -47,7 +47,6 @@
 import io.fabric8.kubernetes.client.dsl.NonNamespaceOperation;
 import io.fabric8.kubernetes.client.dsl.Replaceable;
 import io.fabric8.kubernetes.client.dsl.Resource;
-import io.fabric8.kubernetes.client.dsl.Watchable;
 import io.fabric8.kubernetes.client.dsl.base.WaitForConditionWatcher.WatchException;
 import io.fabric8.kubernetes.client.dsl.internal.DefaultOperationInfo;
 import io.fabric8.kubernetes.client.dsl.internal.WatchConnectionManager;
@@ -80,6 +79,8 @@
 import okhttp3.HttpUrl;
 import okhttp3.Request;
 
+import static java.util.concurrent.TimeUnit.NANOSECONDS;
+
 public class BaseOperation<T extends HasMetadata, L extends KubernetesResourceList<T>, D extends Doneable<T>, R extends Resource<T, D>>
   extends OperationSupport
   implements
@@ -420,13 +421,13 @@ public final T createOrReplace(T... items) {
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabels(Map<String, String> labels) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withLabels(Map<String, String> labels) {
     this.labels.putAll(labels);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabelSelector(LabelSelector selector) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withLabelSelector(LabelSelector selector) {
     Map<String, String> matchLabels = selector.getMatchLabels();
     if (matchLabels != null) {
       this.labels.putAll(matchLabels);
@@ -465,37 +466,37 @@ public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabelSelec
    */
   @Override
   @Deprecated
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withoutLabels(Map<String, String> labels) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withoutLabels(Map<String, String> labels) {
     // Re-use "withoutLabel" to convert values from String to String[]
     labels.forEach(this::withoutLabel);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabelIn(String key, String... values) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withLabelIn(String key, String... values) {
     labelsIn.put(key, values);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabelNotIn(String key, String... values) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withLabelNotIn(String key, String... values) {
     labelsNotIn.put(key, values);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabel(String key, String value) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withLabel(String key, String value) {
     labels.put(key, value);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withLabel(String key) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withLabel(String key) {
     return withLabel(key, null);
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withoutLabel(String key, String value) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withoutLabel(String key, String value) {
     labelsNot.merge(key, new String[]{value}, (oldList, newList) -> {
       final String[] concatList = (String[]) Array.newInstance(String.class, oldList.length + newList.length);
       System.arraycopy(oldList, 0, concatList, 0, oldList.length);
@@ -506,24 +507,24 @@ public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withoutLabel(S
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withoutLabel(String key) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withoutLabel(String key) {
     return withoutLabel(key, null);
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withFields(Map<String, String> fields) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withFields(Map<String, String> fields) {
     this.fields.putAll(fields);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withField(String key, String value) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withField(String key, String value) {
     fields.put(key, value);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withInvolvedObject(ObjectReference objectReference) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withInvolvedObject(ObjectReference objectReference) {
     if (objectReference != null) {
       if (objectReference.getName() != null) {
         fields.put(INVOLVED_OBJECT_NAME, objectReference.getName());
@@ -561,14 +562,14 @@ public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withInvolvedOb
    */
   @Override
   @Deprecated
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withoutFields(Map<String, String> fields) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withoutFields(Map<String, String> fields) {
     // Re-use "withoutField" to convert values from String to String[]
     labels.forEach(this::withoutField);
     return this;
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withoutField(String key, String value) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withoutField(String key, String value) {
     fieldsNot.merge(key, new String[]{value}, (oldList, newList) -> {
       if (Utils.isNotNullOrEmpty(newList[0])) { // Only add new values when not null
         final String[] concatList = (String[]) Array.newInstance(String.class, oldList.length + newList.length);
@@ -782,8 +783,8 @@ void deleteList() {
   }
 
   @Override
-  public Watchable<Watch, Watcher<T>> withResourceVersion(String resourceVersion) {
-    return newInstance(context.withResourceVersion(resourceVersion));
+  public R withResourceVersion(String resourceVersion) {
+    return (R) newInstance(context.withResourceVersion(resourceVersion));
   }
 
   public Watch watch(final Watcher<T> watcher) {
@@ -803,9 +804,9 @@ public Watch watch(String resourceVersion, Watcher<T> watcher) {
   public Watch watch(ListOptions options, final Watcher<T> watcher) {
     WatcherToggle<T> watcherToggle = new WatcherToggle<>(watcher, true);
     options.setWatch(Boolean.TRUE);
-    WatchConnectionManager watch = null;
+    WatchConnectionManager<T, L> watch = null;
     try {
-      watch = new WatchConnectionManager(
+      watch = new WatchConnectionManager<>(
         client,
         this,
         options,
@@ -839,7 +840,7 @@ public Watch watch(ListOptions options, final Watcher<T> watcher) {
       // HTTP GET. This is meant to handle cases like kubectl local proxy which does not support
       // websockets. Issue: https://github.com/kubernetes/kubernetes/issues/25126
       try {
-        return new WatchHTTPManager(
+        return new WatchHTTPManager<>(
           client,
           this,
           options,
@@ -1034,7 +1035,7 @@ public OperationInfo forOperationType(String type) {
   }
 
   @Override
-  public FilterWatchListDeletable<T, L, Boolean, Watch, Watcher<T>> withGracePeriod(long gracePeriodSeconds) {
+  public FilterWatchListDeletable<T, L, Boolean, Watch> withGracePeriod(long gracePeriodSeconds) {
     return newInstance(context.withGracePeriodSeconds(gracePeriodSeconds));
   }
 
@@ -1114,40 +1115,54 @@ public T waitUntilCondition(Predicate<T> condition, long amount, TimeUnit timeUn
 
   private T waitUntilConditionWithRetries(Predicate<T> condition, long timeoutNanos, long backoffMillis)
     throws InterruptedException {
+    ListOptions options = null;
 
-    T item = fromServer().get();
-    if (condition.test(item)) {
-      return item;
+    if (resourceVersion != null) {
+      options = createListOptions(resourceVersion);
     }
 
-    long end = System.nanoTime() + timeoutNanos;
+    long currentBackOff = backoffMillis;
+    long remainingNanosToWait = timeoutNanos;
+    while (remainingNanosToWait > 0) {
 
-    WaitForConditionWatcher<T> watcher = new WaitForConditionWatcher<>(condition);
-    Watch watch = item == null
-      ? watch(new ListOptionsBuilder()
-      .withResourceVersion(null)
-      .build(), watcher)
-      : watch(item.getMetadata().getResourceVersion(), watcher);
+      T item = fromServer().get();
+      if (condition.test(item)) {
+        return item;
+      } else if (options == null) {
+        options = createListOptions(getResourceVersion(item));
+      }
 
-    try {
-      return watcher.getFuture()
-        .get(timeoutNanos, TimeUnit.NANOSECONDS);
-    } catch (ExecutionException e) {
-      if (e.getCause() instanceof WatchException && ((WatchException) e.getCause()).isShouldRetry()) {
-        watch.close();
-        LOG.debug("retryable watch exception encountered, retrying after {} millis", backoffMillis, e.getCause());
-        Thread.sleep(backoffMillis);
-        long newTimeout = end - System.nanoTime();
-        long newBackoff = (long) (backoffMillis * watchRetryBackoffMultiplier);
-        return waitUntilConditionWithRetries(condition, newTimeout, newBackoff);
+      final WaitForConditionWatcher<T> watcher = new WaitForConditionWatcher<>(condition);
+      final long startTime = System.nanoTime();
+      try (Watch ignored = watch(options, watcher)) {
+        return watcher.getFuture().get(remainingNanosToWait, NANOSECONDS);
+      } catch (ExecutionException e) {
+        Throwable cause = e.getCause();
+        if (cause instanceof WatchException && ((WatchException) cause).isShouldRetry()) {
+          LOG.debug("retryable watch exception encountered, retrying after {} millis", currentBackOff, cause);
+          Thread.sleep(currentBackOff);
+          currentBackOff *= watchRetryBackoffMultiplier;
+          remainingNanosToWait -= (System.nanoTime() - startTime);
+        } else {
+          throw KubernetesClientException.launderThrowable(cause);
+        }
+      } catch (TimeoutException e) {
+        break;
       }
-      throw KubernetesClientException.launderThrowable(e.getCause());
-    } catch (TimeoutException e) {
-      LOG.debug("ran out of time waiting for watcher, wait condition not met");
-      throw new IllegalArgumentException(type.getSimpleName() + " with name:[" + name + "] in namespace:[" + namespace + "] matching condition not found!");
-    } finally {
-      watch.close();
     }
+
+    LOG.debug("ran out of time waiting for watcher, wait condition not met");
+    throw new IllegalArgumentException(type.getSimpleName() + " with name:[" + name + "] in namespace:[" + namespace + "] matching condition not found!");
+  }
+
+  private static String getResourceVersion(HasMetadata item) {
+    return (item == null) ? null : item.getMetadata().getResourceVersion();
+  }
+
+  private static ListOptions createListOptions(String resourceVersion) {
+    return new ListOptionsBuilder()
+      .withResourceVersion(resourceVersion)
+      .build();
   }
 
   public void setType(Class<T> type) {