/*
 * Copyright Java Operator SDK Authors
 *
 * 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.javaoperatorsdk.operator.processing;

import io.fabric8.kubernetes.api.model.HasMetadata;
import io.javaoperatorsdk.operator.processing.event.ResourceID;
import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;

/**
 * Provides id for the target resource. This mapper is used across multiple components of the
 * framework, like:
 *
 * <ul>
 *   <li>{@link io.javaoperatorsdk.operator.processing.dependent.AbstractExternalDependentResource}
 *   <li>{@link ExternalResourceCachingEventSource}
 *   <li>{@link io.javaoperatorsdk.operator.processing.dependent.KubernetesBulkDependentResource}
 * </ul>
 *
 * @see ResourceIDProvider<ID>
 */
public interface ResourceIDMapper<R, ID> {

  /**
   * @return id for the target resource.
   */
  ID idFor(R resource);

  /**
   * Can be used if a polling event source handles only single secondary resource and the id is
   * String. See also docs for: {@link ExternalResourceCachingEventSource}; or in {@link
   * io.javaoperatorsdk.operator.processing.dependent.AbstractExternalDependentResource} when there
   * is always only one secondary resource for that dependent resource. By definition cannot be used
   * for a BulkDependent resources.
   *
   * @return static id mapper, all resources are mapped for same id.
   * @param <R> secondary resource type
   */
  static <R> ResourceIDMapper<R, String> singleResourceResourceIDMapper() {
    // the result could be any string, by definition would work with any value
    return r -> "irrelevant";
  }

  @SuppressWarnings({"rawtypes", "unchecked"})
  static <R, ID> ResourceIDMapper<R, ID> resourceIdProviderMapper() {
    return r -> {
      if (r instanceof ResourceIDProvider resourceIDProvider) {
        return (ID) resourceIDProvider.resourceId();
      } else {
        throw new IllegalStateException(
            "Resource does not implement ExternalDependentIDProvider: " + r.getClass());
      }
    };
  }

  static <R extends HasMetadata> ResourceIDMapper<R, ResourceID> kubernetesResourceIdMapper() {
    return ResourceID::fromResource;
  }
}
