wip

Author: csviri

docs/content/en/docs/documentation/dependent-resource-and-workflows/dependent-resources.md

@@ -370,13 +370,13 @@ or we can use a matcher based SSA in most of the cases if the resource is manage
 
 Unfortunately this is not true for external resources. So to make sure we are selecting
 the target resources from an event source, we provide a [mechanism](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractExternalDependentResource.java#L114-L138) that helps with that logic.
-Your POJO representing an external resource can implement [`ExternalResourceIDProvider`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/ExternalDependentIDProvider.java) : 
+Your POJO representing an external resource can implement [`ResourceIDProvider`](https://github.com/operator-framework/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDProvider.java) : 
 
 ```java
 
-public interface ExternalDependentIDProvider<T> {
+public interface ResourceIDProvider<T> {
 
-  T externalResourceId();
+  T resourceId();
 }
 ```
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/ExternalDependentIDProvider.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDProvider.java

@@ -13,16 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.javaoperatorsdk.operator.processing.dependent;
+package io.javaoperatorsdk.operator.processing;
 
 /**
- * Provides the identifier for an object that represents an external resource. This ID is used to
- * select target resource for a dependent resource from the resources returned by `{@link
- * io.javaoperatorsdk.operator.api.reconciler.Context#getSecondaryResources(Class)}`.
+ * Provides the identifier for an object that represents resource. This ID is used to select target
+ * external resource for a dependent resource from the resources returned by `{@link
+ * io.javaoperatorsdk.operator.api.reconciler.Context#getSecondaryResources(Class)}`. But also for
+ * {@link io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper} for event sources in
+ * external resources
  *
  * @param <T>
  */
-public interface ExternalDependentIDProvider<T> {
+public interface ResourceIDProvider<T> {
 
-  T externalResourceId();
+  T resourceId();
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/AbstractExternalDependentResource.java

@@ -22,6 +22,7 @@
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.RecentOperationCacheFiller;
+import io.javaoperatorsdk.operator.processing.ResourceIDProvider;
 import io.javaoperatorsdk.operator.processing.event.EventSourceRetriever;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.EventSource;
@@ -131,14 +132,11 @@ protected Optional<R> selectTargetSecondaryResource(
       Set<R> secondaryResources, P primary, Context<P> context) {
     R desired = desired(primary, context);
     List<R> targetResources;
-    if (desired instanceof ExternalDependentIDProvider<?> desiredWithId) {
+    if (desired instanceof ResourceIDProvider<?> desiredWithId) {
       targetResources =
           secondaryResources.stream()
               .filter(
-                  r ->
-                      ((ExternalDependentIDProvider<?>) r)
-                          .externalResourceId()
-                          .equals(desiredWithId.externalResourceId()))
+                  r -> ((ResourceIDProvider<?>) r).resourceId().equals(desiredWithId.resourceId()))
               .toList();
     } else {
       throw new IllegalStateException(

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractPollingDependentResource.java

@@ -53,6 +53,6 @@ public Duration getPollingPeriod() {
   // for now dependent resources support event sources only with one owned resource.
   @Override
   public ID keyFor(R resource) {
-    return CacheKeyMapper.<R, ID>externalIdProviderMapper().keyFor(resource);
+    return CacheKeyMapper.<R, ID>resourceIdProviderMapper().keyFor(resource);
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CacheKeyMapper.java

@@ -15,15 +15,15 @@
  */
 package io.javaoperatorsdk.operator.processing.event.source;
 
-import io.javaoperatorsdk.operator.processing.dependent.ExternalDependentIDProvider;
+import io.javaoperatorsdk.operator.processing.ResourceIDProvider;
 
 public interface CacheKeyMapper<R, ID> {
 
   ID keyFor(R resource);
 
   /**
-   * Used if a polling event source handles only single secondary resource. See also docs for:
-   * {@link ExternalResourceCachingEventSource}
+   * Used if a polling event source handles only single secondary resource and the id is String. See
+   * also docs for: {@link ExternalResourceCachingEventSource}
    *
    * @return static id mapper, all resources are mapped for same id.
    * @param <T> secondary resource type
@@ -32,11 +32,10 @@ static <T> CacheKeyMapper<T, String> singleResourceCacheKeyMapper() {
     return r -> "id";
   }
 
-  static <T, ID> CacheKeyMapper<T, ID> externalIdProviderMapper() {
-
+  static <T, ID> CacheKeyMapper<T, ID> resourceIdProviderMapper() {
     return r -> {
-      if (r instanceof ExternalDependentIDProvider externalDependentIDProvider) {
-        return (ID) externalDependentIDProvider.externalResourceId();
+      if (r instanceof ResourceIDProvider resourceIDProvider) {
+        return (ID) resourceIDProvider.resourceId();
       } else {
         throw new IllegalStateException(
             "Resource does not implement ExternalDependentIDProvider: " + r.getClass());

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/ExternalResourceCachingEventSource.java

@@ -32,6 +32,7 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.dependent.RecentOperationCacheFiller;
+import io.javaoperatorsdk.operator.processing.ResourceIDProvider;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
@@ -72,6 +73,11 @@ protected ExternalResourceCachingEventSource(
   protected ExternalResourceCachingEventSource(
       String name, Class<R> resourceClass, CacheKeyMapper<R, ID> cacheKeyMapper) {
     super(resourceClass, name);
+    if (cacheKeyMapper == CacheKeyMapper.resourceIdProviderMapper()
+        && !ResourceIDProvider.class.isAssignableFrom(resourceClass)) {
+      throw new IllegalArgumentException(
+          "resource class is not a " + ResourceIDProvider.class.getSimpleName());
+    }
     this.cacheKeyMapper = cacheKeyMapper;
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/polling/PerResourcePollingConfiguration.java

@@ -47,7 +47,7 @@ public PerResourcePollingConfiguration(
             ? new ScheduledThreadPoolExecutor(DEFAULT_EXECUTOR_THREAD_NUMBER)
             : executorService;
     this.cacheKeyMapper =
-        cacheKeyMapper == null ? CacheKeyMapper.externalIdProviderMapper() : cacheKeyMapper;
+        cacheKeyMapper == null ? CacheKeyMapper.resourceIdProviderMapper() : cacheKeyMapper;
     this.resourceFetcher = Objects.requireNonNull(resourceFetcher);
     this.registerPredicate = registerPredicate;
     this.defaultPollingPeriod = defaultPollingPeriod;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/polling/PollingConfiguration.java

@@ -35,6 +35,6 @@ public PollingConfiguration(
     this.genericResourceFetcher = Objects.requireNonNull(genericResourceFetcher);
     this.period = period;
     this.cacheKeyMapper =
-        cacheKeyMapper == null ? CacheKeyMapper.externalIdProviderMapper() : cacheKeyMapper;
+        cacheKeyMapper == null ? CacheKeyMapper.resourceIdProviderMapper() : cacheKeyMapper;
   }
 }

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/SampleExternalResource.java

@@ -18,10 +18,10 @@
 import java.io.Serializable;
 import java.util.Objects;
 
-import io.javaoperatorsdk.operator.processing.dependent.ExternalDependentIDProvider;
+import io.javaoperatorsdk.operator.processing.ResourceIDProvider;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
-public class SampleExternalResource implements Serializable, ExternalDependentIDProvider<String> {
+public class SampleExternalResource implements Serializable, ResourceIDProvider<String> {
 
   public static final String DEFAULT_VALUE_1 = "value1";
   public static final String DEFAULT_VALUE_2 = "value2";
@@ -84,7 +84,7 @@ public int hashCode() {
   }
 
   @Override
-  public String externalResourceId() {
+  public String resourceId() {
     return name;
   }
 }

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/polling/PerResourcePollingEventSourceTest.java

@@ -99,7 +99,7 @@ void registeringTaskOnAPredicate() {
                     supplier, Duration.ofMillis(PERIOD))
                 .withRegisterPredicate(
                     testCustomResource -> testCustomResource.getMetadata().getGeneration() > 1)
-                .withCacheKeyMapper(CacheKeyMapper.externalIdProviderMapper())
+                .withCacheKeyMapper(CacheKeyMapper.resourceIdProviderMapper())
                 .build()));
 
     source.onResourceCreated(testCustomResource);