content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements. See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You 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 org.apache.kafka.streams.processor.internals;
  
  import org.apache.kafka.clients.admin.Admin;
  import org.apache.kafka.clients.admin.ListOffsetsResult;
  import org.apache.kafka.clients.admin.ListOffsetsResult.ListOffsetsResultInfo;
  import org.apache.kafka.clients.admin.OffsetSpec;
  import org.apache.kafka.clients.consumer.Consumer;
  import org.apache.kafka.clients.consumer.ConsumerConfig;
  import org.apache.kafka.clients.consumer.ConsumerRecord;
  import org.apache.kafka.clients.producer.ProducerRecord;
  import org.apache.kafka.common.KafkaException;
  import org.apache.kafka.common.KafkaFuture;
  import org.apache.kafka.common.Metric;
  import org.apache.kafka.common.MetricName;
  import org.apache.kafka.common.TopicPartition;
  import org.apache.kafka.common.errors.TimeoutException;
  import org.apache.kafka.common.header.Header;
  import org.apache.kafka.common.header.Headers;
  import org.apache.kafka.common.utils.Utils;
  import org.apache.kafka.streams.StreamsConfig;
  import org.apache.kafka.streams.errors.StreamsException;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import java.util.Collection;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.LinkedHashMap;
  import java.util.Map;
  import java.util.Set;
  import java.util.concurrent.ExecutionException;
  import java.util.function.Function;
  import java.util.stream.Collectors;
  
  public class ClientUtils {
      private static final Logger LOG = LoggerFactory.getLogger(ClientUtils.class);
  
      public static final class QuietStreamsConfig extends StreamsConfig {
          public QuietStreamsConfig(final Map<?, ?> props) {
              super(props, false);
          }
      }
  
      public static final class QuietConsumerConfig extends ConsumerConfig {
          public QuietConsumerConfig(final Map<String, Object> props) {
              super(props, false);
          }
      }
  
      public static String adminClientId(final String clientId) {
          return clientId + "-admin";
      }
  
      public static String consumerClientId(final String threadClientId) {
          return threadClientId + "-consumer";
      }
  
      public static String restoreConsumerClientId(final String threadClientId) {
          return threadClientId + "-restore-consumer";
      }
  
      public static String producerClientId(final String threadClientId) {
          return threadClientId + "-producer";
      }
  
      public static Map<MetricName, Metric> consumerMetrics(final Consumer<byte[], byte[]> mainConsumer,
                                                            final Consumer<byte[], byte[]> restoreConsumer) {
          final Map<MetricName, ? extends Metric> consumerMetrics = mainConsumer.metrics();
          final Map<MetricName, ? extends Metric> restoreConsumerMetrics = restoreConsumer.metrics();
          final LinkedHashMap<MetricName, Metric> result = new LinkedHashMap<>();
          result.putAll(consumerMetrics);
          result.putAll(restoreConsumerMetrics);
          return result;
      }
  
      public static Map<MetricName, Metric> adminClientMetrics(final Admin adminClient) {
          final Map<MetricName, ? extends Metric> adminClientMetrics = adminClient.metrics();
          return new LinkedHashMap<>(adminClientMetrics);
      }
  
      public static Map<MetricName, Metric> producerMetrics(final Collection<StreamsProducer> producers) {
          final Map<MetricName, Metric> result = new LinkedHashMap<>();
          for (final StreamsProducer producer : producers) {
              final Map<MetricName, ? extends Metric> producerMetrics = producer.metrics();
              if (producerMetrics != null) {
                  result.putAll(producerMetrics);
              }
          }
          return result;
      }
  
      /**
       * @throws StreamsException if the consumer throws an exception
       * @throws org.apache.kafka.common.errors.TimeoutException if the request times out
       */
      public static Map<TopicPartition, Long> fetchCommittedOffsets(final Set<TopicPartition> partitions,
                                                                    final Consumer<byte[], byte[]> consumer) {
          if (partitions.isEmpty()) {
              return Collections.emptyMap();
          }
  
          final Map<TopicPartition, Long> committedOffsets;
          try {
              // those which do not have a committed offset would default to 0
              committedOffsets = consumer.committed(partitions).entrySet().stream()
                  .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue() == null ? 0L : e.getValue().offset()));
          } catch (final TimeoutException timeoutException) {
              LOG.warn("The committed offsets request timed out, try increasing the consumer client's default.api.timeout.ms", timeoutException);
              throw timeoutException;
          } catch (final KafkaException fatal) {
              LOG.warn("The committed offsets request failed.", fatal);
              throw new StreamsException(String.format("Failed to retrieve end offsets for %s", partitions), fatal);
          }
  
          return committedOffsets;
      }
  
      public static KafkaFuture<Map<TopicPartition, ListOffsetsResultInfo>> fetchEndOffsetsFuture(final Collection<TopicPartition> partitions,
                                                                                                  final Admin adminClient) {
          return adminClient.listOffsets(
              partitions.stream().collect(Collectors.toMap(Function.identity(), tp -> OffsetSpec.latest()))
          ).all();
      }
  
      public static ListOffsetsResult fetchEndOffsetsResult(final Collection<TopicPartition> partitions,
                                                            final Admin adminClient) {
          return adminClient.listOffsets(
              partitions.stream().collect(Collectors.toMap(Function.identity(), tp -> OffsetSpec.latest()))
          );
      }
  
      public static Map<TopicPartition, ListOffsetsResultInfo> getEndOffsets(final ListOffsetsResult resultFuture,
                                                                             final Collection<TopicPartition> partitions) {
          final Map<TopicPartition, ListOffsetsResultInfo> result = new HashMap<>();
          for (final TopicPartition partition : partitions) {
              try {
                  final KafkaFuture<ListOffsetsResultInfo> future = resultFuture.partitionResult(partition);
  
                  if (future == null) {
                      // this NPE -> IllegalStateE translation is needed
                      // to keep exception throwing behavior consistent
                      throw new IllegalStateException("Could not get end offset for " + partition);
                  }
                  result.put(partition, future.get());
              } catch (final ExecutionException e) {
                  final Throwable cause = e.getCause();
                  final String msg = String.format("Error while attempting to read end offsets for partition '%s'", partition.toString());
                  throw new StreamsException(msg, cause);
              } catch (final InterruptedException e) {
                  Thread.interrupted();
                  final String msg = String.format("Interrupted while attempting to read end offsets for partition '%s'", partition.toString());
                  throw new StreamsException(msg, e);
              }
          }
  
          return result;
      }
  
      /**
       * A helper method that wraps the {@code Future#get} call and rethrows any thrown exception as a StreamsException
       * @throws StreamsException if the admin client request throws an exception
       */
      public static Map<TopicPartition, ListOffsetsResultInfo> getEndOffsets(final KafkaFuture<Map<TopicPartition, ListOffsetsResultInfo>> endOffsetsFuture) {
          try {
              return endOffsetsFuture.get();
          } catch (final RuntimeException | InterruptedException | ExecutionException e) {
              LOG.warn("The listOffsets request failed.", e);
              throw new StreamsException("Unable to obtain end offsets from kafka", e);
          }
      }
  
      /**
       * @throws StreamsException if the admin client request throws an exception
       */
      public static Map<TopicPartition, ListOffsetsResultInfo> fetchEndOffsets(final Collection<TopicPartition> partitions,
                                                                               final Admin adminClient) {
          if (partitions.isEmpty()) {
              return Collections.emptyMap();
          }
          return getEndOffsets(fetchEndOffsetsFuture(partitions, adminClient));
      }
  
      public static long producerRecordSizeInBytes(final ProducerRecord<byte[], byte[]> record) {
          return recordSizeInBytes(
              record.key() == null ? 0 : record.key().length,
              record.value() == null ? 0 : record.value().length,
              record.topic(),
              record.headers()
          );
      }
  
      public static long consumerRecordSizeInBytes(final ConsumerRecord<byte[], byte[]> record) {
          return recordSizeInBytes(
              record.serializedKeySize(),
              record.serializedValueSize(),
              record.topic(),
              record.headers()
          );
      }
  
      private static long recordSizeInBytes(final long keyBytes,
                                            final long valueBytes,
                                            final String topic,
                                            final Headers headers) {
          long headerSizeInBytes = 0L;
  
          if (headers != null) {
              for (final Header header : headers.toArray()) {
                  headerSizeInBytes += Utils.utf8(header.key()).length;
                  if (header.value() != null) {
                      headerSizeInBytes += header.value().length;
                  }
              }
          }
  
          return keyBytes +
              valueBytes +
              8L + // timestamp
              8L + // offset
              Utils.utf8(topic).length +
              4L + // partition
              headerSizeInBytes;
      }
  }
  