Merge pull request #1015 from yue9944882/chore/refactor-informer-use-common-interface

Switch to kubernetes object common interfaces for informers

Author: k8s-ci-robot

util/src/main/java/io/kubernetes/client/informer/ResyncRunnable.java

@@ -1,7 +1,6 @@
 package io.kubernetes.client.informer;
 
-import io.kubernetes.client.common.KubernetesObject;
-import io.kubernetes.client.informer.cache.Store;
+import io.kubernetes.client.informer.cache.DeltaFIFO;
 import java.util.function.Supplier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -10,14 +9,14 @@
  * ResyncRunnable class implements Runnable interface. It calls the resync function of Store
  * interface which is actually always implemented by DeltaFIFO.
  */
-public class ResyncRunnable<ApiType extends KubernetesObject> implements Runnable {
+public class ResyncRunnable implements Runnable {
 
   private static final Logger log = LoggerFactory.getLogger(ResyncRunnable.class);
 
-  private Store<ApiType> store;
+  private DeltaFIFO store;
   private Supplier<Boolean> shouldResyncFunc;
 
-  public ResyncRunnable(Store<ApiType> store, Supplier<Boolean> shouldResyncFunc) {
+  public ResyncRunnable(DeltaFIFO store, Supplier<Boolean> shouldResyncFunc) {
     this.store = store;
     this.shouldResyncFunc = shouldResyncFunc;
   }

util/src/main/java/io/kubernetes/client/informer/cache/Cache.java

@@ -23,13 +23,6 @@ public class Cache<ApiType extends KubernetesObject> implements Indexer<ApiType>
   /** keyFunc defines how to map objects into indices */
   private Function<ApiType, String> keyFunc;
 
-  /**
-   * DEPRECATE: use Caches#NAMESPACE_INDEX instead. TODO: remove after 7.0.0
-   *
-   * <p>NAMESPACE_INDEX is the default index function for caching objects
-   */
-  @Deprecated public static final String NAMESPACE_INDEX = "namespace";
-
   /** indexers stores index functions by their names */
   private Map<String, Function<ApiType, List<String>>> indexers = new HashMap<>();
 
@@ -432,48 +425,4 @@ public Function<ApiType, String> getKeyFunc() {
   public void setKeyFunc(Function<ApiType, String> keyFunc) {
     this.keyFunc = keyFunc;
   }
-
-  /**
-   * DEPRECATE: use Caches#deletionHandlingMetaNamespaceKeyFunc instead. TODO: remove after 7.0.0
-   *
-   * <p>deletionHandlingMetaNamespaceKeyFunc checks for DeletedFinalStateUnknown objects before
-   * calling metaNamespaceKeyFunc.
-   *
-   * @param <ApiType> the type parameter
-   * @param object specific object
-   * @return the key
-   */
-  @Deprecated
-  public static <ApiType> String deletionHandlingMetaNamespaceKeyFunc(ApiType object) {
-    return Caches.deletionHandlingMetaNamespaceKeyFunc(object);
-  }
-
-  /**
-   * DEPRECATE: use Caches#metaNamespaceKeyFunc instead. TODO: remove after 7.0.0
-   *
-   * <p>MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make keys for API
-   * objects which implement HasMetadata Interface. The key uses the format <namespace>/<name>
-   * unless <namespace> is empty, then it's just <name>.
-   *
-   * @param obj specific object
-   * @return the key
-   */
-  @Deprecated
-  public static String metaNamespaceKeyFunc(Object obj) {
-    return Caches.metaNamespaceKeyFunc(obj);
-  }
-
-  /**
-   * DEPRECATE: use Caches#metaNamespaceIndexFunc instead. TODO: remove after 7.0.0
-   *
-   * <p>metaNamespaceIndexFunc is a default index function that indexes based on an object's
-   * namespace.
-   *
-   * @param obj specific object
-   * @return the indexed value
-   */
-  @Deprecated
-  public static List<String> metaNamespaceIndexFunc(Object obj) {
-    return Caches.metaNamespaceIndexFunc(obj);
-  }
 }

util/src/main/java/io/kubernetes/client/informer/cache/Caches.java

@@ -1,7 +1,7 @@
 package io.kubernetes.client.informer.cache;
 
 import com.google.common.base.Strings;
-import io.kubernetes.client.informer.exception.BadObjectException;
+import io.kubernetes.client.common.KubernetesObject;
 import io.kubernetes.client.openapi.models.V1ObjectMeta;
 import io.kubernetes.client.util.ObjectAccessor;
 import io.kubernetes.client.util.exception.ObjectMetaReflectException;
@@ -22,9 +22,11 @@ public class Caches {
    * @param object specific object
    * @return the key
    */
-  public static <ApiType> String deletionHandlingMetaNamespaceKeyFunc(ApiType object) {
+  public static <ApiType extends KubernetesObject> String deletionHandlingMetaNamespaceKeyFunc(
+      ApiType object) {
     if (object instanceof DeltaFIFO.DeletedFinalStateUnknown) {
-      DeltaFIFO.DeletedFinalStateUnknown deleteObj = (DeltaFIFO.DeletedFinalStateUnknown) object;
+      DeltaFIFO.DeletedFinalStateUnknown<ApiType> deleteObj =
+          (DeltaFIFO.DeletedFinalStateUnknown<ApiType>) object;
       return deleteObj.getKey();
     }
     return metaNamespaceKeyFunc(object);
@@ -38,27 +40,12 @@ public static <ApiType> String deletionHandlingMetaNamespaceKeyFunc(ApiType obje
    * @param obj specific object
    * @return the key
    */
-  public static String metaNamespaceKeyFunc(Object obj) {
-    try {
-      V1ObjectMeta metadata;
-      if (obj instanceof String) {
-        return (String) obj;
-      } else if (obj instanceof V1ObjectMeta) {
-        metadata = (V1ObjectMeta) obj;
-      } else {
-        metadata = ObjectAccessor.objectMetadata(obj);
-        if (metadata == null) {
-          throw new BadObjectException(obj);
-        }
-      }
-      if (!Strings.isNullOrEmpty(metadata.getNamespace())) {
-        return metadata.getNamespace() + "/" + metadata.getName();
-      }
-      return metadata.getName();
-    } catch (ObjectMetaReflectException e) {
-      // NOTE(yue9944882): might want to handle this as a checked exception
-      throw new RuntimeException(e);
+  public static String metaNamespaceKeyFunc(KubernetesObject obj) {
+    V1ObjectMeta metadata = obj.getMetadata();
+    if (!Strings.isNullOrEmpty(metadata.getNamespace())) {
+      return metadata.getNamespace() + "/" + metadata.getName();
     }
+    return metadata.getName();
   }
 
   /**

util/src/main/java/io/kubernetes/client/informer/cache/Controller.java

@@ -28,7 +28,7 @@ public class Controller<
   private long fullResyncPeriod;
 
   /** Queue stores deltas produced by reflector */
-  private DeltaFIFO<ApiType> queue;
+  private DeltaFIFO queue;
 
   private ListerWatcher<ApiType, ApiListType> listerWatcher;
 
@@ -37,7 +37,7 @@ public class Controller<
   private Supplier<Boolean> resyncFunc;
 
   /** how we actually process items from the queue */
-  private Consumer<Deque<MutablePair<DeltaFIFO.DeltaType, Object>>> processFunc;
+  private Consumer<Deque<MutablePair<DeltaFIFO.DeltaType, KubernetesObject>>> processFunc;
 
   private ScheduledExecutorService reflectExecutor;
 
@@ -51,9 +51,9 @@ public class Controller<
 
   public Controller(
       Class<ApiType> apiTypeClass,
-      DeltaFIFO<ApiType> queue,
+      DeltaFIFO queue,
       ListerWatcher<ApiType, ApiListType> listerWatcher,
-      Consumer<Deque<MutablePair<DeltaFIFO.DeltaType, Object>>> processFunc,
+      Consumer<Deque<MutablePair<DeltaFIFO.DeltaType, KubernetesObject>>> processFunc,
       Supplier<Boolean> resyncFunc,
       long fullResyncPeriod) {
     this.queue = queue;
@@ -80,9 +80,9 @@ public Controller(
 
   public Controller(
       Class<ApiType> apiTypeClass,
-      DeltaFIFO<ApiType> queue,
+      DeltaFIFO queue,
       ListerWatcher<ApiType, ApiListType> listerWatcher,
-      Consumer<Deque<MutablePair<DeltaFIFO.DeltaType, Object>>> popProcessFunc) {
+      Consumer<Deque<MutablePair<DeltaFIFO.DeltaType, KubernetesObject>>> popProcessFunc) {
     this(apiTypeClass, queue, listerWatcher, popProcessFunc, null, 0);
   }