frankvicky commented on code in PR #19460: URL: https://github.com/apache/kafka/pull/19460#discussion_r2043824450
########## clients/clients-integration-tests/src/test/java/org/apache/kafka/clients/admin/ListOffsetsIntegrationTest.java: ########## @@ -0,0 +1,292 @@ +/* + * 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.clients.admin; + +import org.apache.kafka.clients.admin.ListOffsetsResult.ListOffsetsResultInfo; +import org.apache.kafka.clients.producer.Producer; +import org.apache.kafka.clients.producer.ProducerConfig; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.clients.producer.RecordMetadata; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.requests.ListOffsetsResponse; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.TestUtils; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Utils; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import java.io.File; +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.stream.Collectors; + +import scala.jdk.javaapi.CollectionConverters; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; + +@ClusterTestDefaults( + types = {Type.KRAFT}, + brokers = 3, + serverProperties = { + @ClusterConfigProperty(key = "log.retention.ms", value = "-1"), + } +) +public class ListOffsetsIntegrationTest { + private static final String TOPIC = "topic"; + private static final String CUSTOM_CONFIG_TOPIC = "custom_topic"; + private static final short REPLICAS = 1; + private static final int PARTITION = 1; + private final ClusterInstance clusterInstance; + private Admin adminClient; + + ListOffsetsIntegrationTest(ClusterInstance clusterInstance) { + this.clusterInstance = clusterInstance; + } + + @BeforeEach + public void setup() throws InterruptedException { + clusterInstance.waitForReadyBrokers(); + clusterInstance.createTopic(TOPIC, PARTITION, REPLICAS); + adminClient = clusterInstance.admin(); + } + + @AfterEach + public void teardown() { + Utils.closeQuietly(adminClient, "ListOffsetsAdminClient"); + } + + @ClusterTest + public void testListMaxTimestampWithEmptyLog() throws InterruptedException, ExecutionException { + ListOffsetsResultInfo maxTimestampOffset = runFetchOffsets(OffsetSpec.maxTimestamp(), TOPIC); + assertEquals(ListOffsetsResponse.UNKNOWN_OFFSET, maxTimestampOffset.offset()); + assertEquals(ListOffsetsResponse.UNKNOWN_TIMESTAMP, maxTimestampOffset.timestamp()); + } + + @ClusterTest + public void testThreeCompressedRecordsInOneBatch() throws InterruptedException, ExecutionException { + produceMessagesInOneBatch("gzip", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset should be the first message of the batch. + // So in this one batch test, it'll be the first offset 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInOneBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamps are the same, we choose the offset of the first record + // thus, the maxTimestampOffset should be the first record of the batch. + // So in this one batch test, it'll be the first offset which is 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInSeparateBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamp is different, it should be the last one + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + @ClusterTest + public void testThreeRecordsInOneBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeRecordsInSeparateBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeCompressedRecordsInSeparateBatch() throws InterruptedException, ExecutionException { + produceMessagesInSeparateBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset is the message in the last batch since we advance the time + // for each batch, So it'll be the last offset 2 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + private void produceMessagesInOneBatch(String compressionType, String topic) { + List<ProducerRecord<byte[], byte[]>> records = new LinkedList<>(); + records.add(new ProducerRecord<>(topic, 0, 100L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 999L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 200L, null, new byte[10])); + + // create a producer with large linger.ms and enough batch.size (default is enough for three 10 bytes records), + // so that we can confirm all records will be accumulated in producer until we flush them into one batch. + try (Producer<byte[], byte[]> producer = clusterInstance.producer(Map.of( + ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, clusterInstance.bootstrapServers(), + ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.LINGER_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.COMPRESSION_TYPE_CONFIG, compressionType))) { + + List<Future<RecordMetadata>> futures = records.stream().map(record -> producer.send(record)).toList(); Review Comment: ```suggestion List<Future<RecordMetadata>> futures = records.stream().map(producer::send).toList(); ``` ########## clients/clients-integration-tests/src/test/java/org/apache/kafka/clients/admin/ListOffsetsIntegrationTest.java: ########## @@ -0,0 +1,292 @@ +/* + * 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.clients.admin; + +import org.apache.kafka.clients.admin.ListOffsetsResult.ListOffsetsResultInfo; +import org.apache.kafka.clients.producer.Producer; +import org.apache.kafka.clients.producer.ProducerConfig; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.clients.producer.RecordMetadata; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.requests.ListOffsetsResponse; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.TestUtils; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Utils; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import java.io.File; +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.stream.Collectors; + +import scala.jdk.javaapi.CollectionConverters; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; + +@ClusterTestDefaults( + types = {Type.KRAFT}, + brokers = 3, + serverProperties = { + @ClusterConfigProperty(key = "log.retention.ms", value = "-1"), + } +) +public class ListOffsetsIntegrationTest { + private static final String TOPIC = "topic"; + private static final String CUSTOM_CONFIG_TOPIC = "custom_topic"; + private static final short REPLICAS = 1; + private static final int PARTITION = 1; + private final ClusterInstance clusterInstance; + private Admin adminClient; + + ListOffsetsIntegrationTest(ClusterInstance clusterInstance) { + this.clusterInstance = clusterInstance; + } + + @BeforeEach + public void setup() throws InterruptedException { + clusterInstance.waitForReadyBrokers(); + clusterInstance.createTopic(TOPIC, PARTITION, REPLICAS); + adminClient = clusterInstance.admin(); + } + + @AfterEach + public void teardown() { + Utils.closeQuietly(adminClient, "ListOffsetsAdminClient"); + } + + @ClusterTest + public void testListMaxTimestampWithEmptyLog() throws InterruptedException, ExecutionException { + ListOffsetsResultInfo maxTimestampOffset = runFetchOffsets(OffsetSpec.maxTimestamp(), TOPIC); + assertEquals(ListOffsetsResponse.UNKNOWN_OFFSET, maxTimestampOffset.offset()); + assertEquals(ListOffsetsResponse.UNKNOWN_TIMESTAMP, maxTimestampOffset.timestamp()); + } + + @ClusterTest + public void testThreeCompressedRecordsInOneBatch() throws InterruptedException, ExecutionException { + produceMessagesInOneBatch("gzip", TOPIC); Review Comment: We have enum `CompressionType`. Could we use the name of enum instead of plain string? ########## clients/clients-integration-tests/src/test/java/org/apache/kafka/clients/admin/ListOffsetsIntegrationTest.java: ########## @@ -0,0 +1,292 @@ +/* + * 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.clients.admin; + +import org.apache.kafka.clients.admin.ListOffsetsResult.ListOffsetsResultInfo; +import org.apache.kafka.clients.producer.Producer; +import org.apache.kafka.clients.producer.ProducerConfig; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.clients.producer.RecordMetadata; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.requests.ListOffsetsResponse; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.TestUtils; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Utils; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import java.io.File; +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.stream.Collectors; + +import scala.jdk.javaapi.CollectionConverters; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; + +@ClusterTestDefaults( + types = {Type.KRAFT}, + brokers = 3, + serverProperties = { + @ClusterConfigProperty(key = "log.retention.ms", value = "-1"), + } +) +public class ListOffsetsIntegrationTest { + private static final String TOPIC = "topic"; + private static final String CUSTOM_CONFIG_TOPIC = "custom_topic"; + private static final short REPLICAS = 1; + private static final int PARTITION = 1; + private final ClusterInstance clusterInstance; + private Admin adminClient; + + ListOffsetsIntegrationTest(ClusterInstance clusterInstance) { + this.clusterInstance = clusterInstance; + } + + @BeforeEach + public void setup() throws InterruptedException { + clusterInstance.waitForReadyBrokers(); + clusterInstance.createTopic(TOPIC, PARTITION, REPLICAS); + adminClient = clusterInstance.admin(); + } + + @AfterEach + public void teardown() { + Utils.closeQuietly(adminClient, "ListOffsetsAdminClient"); + } + + @ClusterTest + public void testListMaxTimestampWithEmptyLog() throws InterruptedException, ExecutionException { + ListOffsetsResultInfo maxTimestampOffset = runFetchOffsets(OffsetSpec.maxTimestamp(), TOPIC); + assertEquals(ListOffsetsResponse.UNKNOWN_OFFSET, maxTimestampOffset.offset()); + assertEquals(ListOffsetsResponse.UNKNOWN_TIMESTAMP, maxTimestampOffset.timestamp()); + } + + @ClusterTest + public void testThreeCompressedRecordsInOneBatch() throws InterruptedException, ExecutionException { + produceMessagesInOneBatch("gzip", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset should be the first message of the batch. + // So in this one batch test, it'll be the first offset 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInOneBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamps are the same, we choose the offset of the first record + // thus, the maxTimestampOffset should be the first record of the batch. + // So in this one batch test, it'll be the first offset which is 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInSeparateBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamp is different, it should be the last one + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + @ClusterTest + public void testThreeRecordsInOneBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeRecordsInSeparateBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeCompressedRecordsInSeparateBatch() throws InterruptedException, ExecutionException { + produceMessagesInSeparateBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset is the message in the last batch since we advance the time + // for each batch, So it'll be the last offset 2 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + private void produceMessagesInOneBatch(String compressionType, String topic) { + List<ProducerRecord<byte[], byte[]>> records = new LinkedList<>(); + records.add(new ProducerRecord<>(topic, 0, 100L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 999L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 200L, null, new byte[10])); + + // create a producer with large linger.ms and enough batch.size (default is enough for three 10 bytes records), + // so that we can confirm all records will be accumulated in producer until we flush them into one batch. + try (Producer<byte[], byte[]> producer = clusterInstance.producer(Map.of( + ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, clusterInstance.bootstrapServers(), + ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.LINGER_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.COMPRESSION_TYPE_CONFIG, compressionType))) { + + List<Future<RecordMetadata>> futures = records.stream().map(record -> producer.send(record)).toList(); + producer.flush(); + + for (Future<RecordMetadata> future : futures) { + assertDoesNotThrow(() -> future.get()); + } + } + } + + private void produceMessagesInSeparateBatch(String compressionType, String topic) throws ExecutionException, InterruptedException { + ProducerRecord<byte[], byte[]> record1 = new ProducerRecord<>(topic, 0, 100L, null, new byte[10]); + ProducerRecord<byte[], byte[]> record2 = new ProducerRecord<>(topic, 0, 999L, null, new byte[10]); + ProducerRecord<byte[], byte[]> record3 = new ProducerRecord<>(topic, 0, 200L, null, new byte[10]); + + // create a producer with large linger.ms and enough batch.size (default is enough for three 10 bytes records), + // so that we can confirm all records will be accumulated in producer until we flush them into one batch. + try (Producer<byte[], byte[]> producer = clusterInstance.producer(Map.of( + ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, clusterInstance.bootstrapServers(), + ProducerConfig.COMPRESSION_TYPE_CONFIG, compressionType))) { + + Future<RecordMetadata> future1 = producer.send(record1); + future1.get(); + // sleep some time in order to advance the server time + // after each record sent to make sure the time changed when appendTime is used + Thread.sleep(100); + + Future<RecordMetadata> future2 = producer.send(record2); + future2.get(); + Thread.sleep(100); + + Future<RecordMetadata> future3 = producer.send(record3); + future3.get(); + } + } + + private void verifyListOffsets(String topic, int expectedMaxTimestampOffset) throws ExecutionException, InterruptedException { + + // case 0: test the offsets from leader's append path + checkListOffsets(topic, expectedMaxTimestampOffset); + + // case 1: test the offsets from follower's append path. + // we make a follower be the new leader to handle the ListOffsetRequest + int previousLeader = clusterInstance.getLeaderBrokerId(new TopicPartition(topic, 0)); + int newLeader = clusterInstance.brokerIds().stream().filter(id -> id != previousLeader).findAny().get(); + + // change the leader to new one + adminClient.alterPartitionReassignments( + Map.of(new TopicPartition(topic, 0), Optional.of(new NewPartitionReassignment(List.of(newLeader)))) + ).all().get(); + // wait for all reassignments get completed + TestUtils.waitForCondition(() -> { + try { + return adminClient.listPartitionReassignments().reassignments().get().isEmpty(); + } catch (InterruptedException | ExecutionException e) { + return false; + } + }, "There still are ongoing reassignments"); + // make sure we are able to see the new leader + TestUtils.waitForCondition(() -> { + try { + return clusterInstance.getLeaderBrokerId(new TopicPartition(topic, 0)) == newLeader; + } catch (InterruptedException | ExecutionException e) { + return false; + } + }, String.format("expected leader: %d but actual: %d", newLeader, clusterInstance.getLeaderBrokerId(new TopicPartition(topic, 0)))); + checkListOffsets(topic, expectedMaxTimestampOffset); + + // case 2: test the offsets from recovery path. + // server will rebuild offset index according to log files if the index files are nonexistent + Set<String> indexFiles = clusterInstance.brokers().values().stream().flatMap(broker -> + CollectionConverters.asJava(broker.config().logDirs()).stream() + ).collect(Collectors.toUnmodifiableSet()); + clusterInstance.brokers().values().forEach(b -> b.shutdown()); Review Comment: ```suggestion clusterInstance.brokers().values().forEach(KafkaBroker::shutdown); ``` ########## clients/clients-integration-tests/src/test/java/org/apache/kafka/clients/admin/ListOffsetsIntegrationTest.java: ########## @@ -0,0 +1,292 @@ +/* + * 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.clients.admin; + +import org.apache.kafka.clients.admin.ListOffsetsResult.ListOffsetsResultInfo; +import org.apache.kafka.clients.producer.Producer; +import org.apache.kafka.clients.producer.ProducerConfig; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.clients.producer.RecordMetadata; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.requests.ListOffsetsResponse; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.TestUtils; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Utils; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import java.io.File; +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.stream.Collectors; + +import scala.jdk.javaapi.CollectionConverters; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; + +@ClusterTestDefaults( + types = {Type.KRAFT}, + brokers = 3, + serverProperties = { + @ClusterConfigProperty(key = "log.retention.ms", value = "-1"), + } +) +public class ListOffsetsIntegrationTest { + private static final String TOPIC = "topic"; + private static final String CUSTOM_CONFIG_TOPIC = "custom_topic"; + private static final short REPLICAS = 1; + private static final int PARTITION = 1; + private final ClusterInstance clusterInstance; + private Admin adminClient; + + ListOffsetsIntegrationTest(ClusterInstance clusterInstance) { + this.clusterInstance = clusterInstance; + } + + @BeforeEach + public void setup() throws InterruptedException { + clusterInstance.waitForReadyBrokers(); + clusterInstance.createTopic(TOPIC, PARTITION, REPLICAS); + adminClient = clusterInstance.admin(); + } + + @AfterEach + public void teardown() { + Utils.closeQuietly(adminClient, "ListOffsetsAdminClient"); + } + + @ClusterTest + public void testListMaxTimestampWithEmptyLog() throws InterruptedException, ExecutionException { + ListOffsetsResultInfo maxTimestampOffset = runFetchOffsets(OffsetSpec.maxTimestamp(), TOPIC); + assertEquals(ListOffsetsResponse.UNKNOWN_OFFSET, maxTimestampOffset.offset()); + assertEquals(ListOffsetsResponse.UNKNOWN_TIMESTAMP, maxTimestampOffset.timestamp()); + } + + @ClusterTest + public void testThreeCompressedRecordsInOneBatch() throws InterruptedException, ExecutionException { + produceMessagesInOneBatch("gzip", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset should be the first message of the batch. + // So in this one batch test, it'll be the first offset 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInOneBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamps are the same, we choose the offset of the first record + // thus, the maxTimestampOffset should be the first record of the batch. + // So in this one batch test, it'll be the first offset which is 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInSeparateBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamp is different, it should be the last one + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + @ClusterTest + public void testThreeRecordsInOneBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeRecordsInSeparateBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeCompressedRecordsInSeparateBatch() throws InterruptedException, ExecutionException { + produceMessagesInSeparateBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset is the message in the last batch since we advance the time + // for each batch, So it'll be the last offset 2 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + private void produceMessagesInOneBatch(String compressionType, String topic) { + List<ProducerRecord<byte[], byte[]>> records = new LinkedList<>(); + records.add(new ProducerRecord<>(topic, 0, 100L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 999L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 200L, null, new byte[10])); + + // create a producer with large linger.ms and enough batch.size (default is enough for three 10 bytes records), + // so that we can confirm all records will be accumulated in producer until we flush them into one batch. + try (Producer<byte[], byte[]> producer = clusterInstance.producer(Map.of( + ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, clusterInstance.bootstrapServers(), + ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.LINGER_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.COMPRESSION_TYPE_CONFIG, compressionType))) { + + List<Future<RecordMetadata>> futures = records.stream().map(record -> producer.send(record)).toList(); + producer.flush(); + + for (Future<RecordMetadata> future : futures) { + assertDoesNotThrow(() -> future.get()); Review Comment: We should avoid using `get()` since it could get stuck. Please use `get(long timeout, TimeUnit unit)` instead. ########## clients/clients-integration-tests/src/test/java/org/apache/kafka/clients/admin/ListOffsetsIntegrationTest.java: ########## @@ -0,0 +1,292 @@ +/* + * 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.clients.admin; + +import org.apache.kafka.clients.admin.ListOffsetsResult.ListOffsetsResultInfo; +import org.apache.kafka.clients.producer.Producer; +import org.apache.kafka.clients.producer.ProducerConfig; +import org.apache.kafka.clients.producer.ProducerRecord; +import org.apache.kafka.clients.producer.RecordMetadata; +import org.apache.kafka.common.TopicPartition; +import org.apache.kafka.common.config.TopicConfig; +import org.apache.kafka.common.requests.ListOffsetsResponse; +import org.apache.kafka.common.test.ClusterInstance; +import org.apache.kafka.common.test.TestUtils; +import org.apache.kafka.common.test.api.ClusterConfigProperty; +import org.apache.kafka.common.test.api.ClusterTest; +import org.apache.kafka.common.test.api.ClusterTestDefaults; +import org.apache.kafka.common.test.api.Type; +import org.apache.kafka.common.utils.Utils; + +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; + +import java.io.File; +import java.util.Arrays; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.stream.Collectors; + +import scala.jdk.javaapi.CollectionConverters; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; + +@ClusterTestDefaults( + types = {Type.KRAFT}, + brokers = 3, + serverProperties = { + @ClusterConfigProperty(key = "log.retention.ms", value = "-1"), + } +) +public class ListOffsetsIntegrationTest { + private static final String TOPIC = "topic"; + private static final String CUSTOM_CONFIG_TOPIC = "custom_topic"; + private static final short REPLICAS = 1; + private static final int PARTITION = 1; + private final ClusterInstance clusterInstance; + private Admin adminClient; + + ListOffsetsIntegrationTest(ClusterInstance clusterInstance) { + this.clusterInstance = clusterInstance; + } + + @BeforeEach + public void setup() throws InterruptedException { + clusterInstance.waitForReadyBrokers(); + clusterInstance.createTopic(TOPIC, PARTITION, REPLICAS); + adminClient = clusterInstance.admin(); + } + + @AfterEach + public void teardown() { + Utils.closeQuietly(adminClient, "ListOffsetsAdminClient"); + } + + @ClusterTest + public void testListMaxTimestampWithEmptyLog() throws InterruptedException, ExecutionException { + ListOffsetsResultInfo maxTimestampOffset = runFetchOffsets(OffsetSpec.maxTimestamp(), TOPIC); + assertEquals(ListOffsetsResponse.UNKNOWN_OFFSET, maxTimestampOffset.offset()); + assertEquals(ListOffsetsResponse.UNKNOWN_TIMESTAMP, maxTimestampOffset.timestamp()); + } + + @ClusterTest + public void testThreeCompressedRecordsInOneBatch() throws InterruptedException, ExecutionException { + produceMessagesInOneBatch("gzip", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset should be the first message of the batch. + // So in this one batch test, it'll be the first offset 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInOneBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamps are the same, we choose the offset of the first record + // thus, the maxTimestampOffset should be the first record of the batch. + // So in this one batch test, it'll be the first offset which is 0 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 0); + } + + @ClusterTest + public void testThreeNonCompressedRecordsInSeparateBatch() throws ExecutionException, InterruptedException { + produceMessagesInOneBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("none", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, if the timestamp is different, it should be the last one + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + @ClusterTest + public void testThreeRecordsInOneBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeRecordsInSeparateBatchHavingDifferentCompressionTypeWithServer() throws InterruptedException, ExecutionException { + createTopicWithConfig(CUSTOM_CONFIG_TOPIC, Map.of(TopicConfig.COMPRESSION_TYPE_CONFIG, "lz4")); + produceMessagesInOneBatch("none", CUSTOM_CONFIG_TOPIC); + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 1); + } + + @ClusterTest + public void testThreeCompressedRecordsInSeparateBatch() throws InterruptedException, ExecutionException { + produceMessagesInSeparateBatch("none", TOPIC); + verifyListOffsets(TOPIC, 1); + + // test LogAppendTime case + setUpForLogAppendTimeCase(); + produceMessagesInSeparateBatch("gzip", CUSTOM_CONFIG_TOPIC); + // In LogAppendTime's case, the maxTimestampOffset is the message in the last batch since we advance the time + // for each batch, So it'll be the last offset 2 + verifyListOffsets(CUSTOM_CONFIG_TOPIC, 2); + } + + private void produceMessagesInOneBatch(String compressionType, String topic) { + List<ProducerRecord<byte[], byte[]>> records = new LinkedList<>(); + records.add(new ProducerRecord<>(topic, 0, 100L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 999L, null, new byte[10])); + records.add(new ProducerRecord<>(topic, 0, 200L, null, new byte[10])); + + // create a producer with large linger.ms and enough batch.size (default is enough for three 10 bytes records), + // so that we can confirm all records will be accumulated in producer until we flush them into one batch. + try (Producer<byte[], byte[]> producer = clusterInstance.producer(Map.of( + ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, clusterInstance.bootstrapServers(), + ProducerConfig.DELIVERY_TIMEOUT_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.LINGER_MS_CONFIG, Integer.MAX_VALUE, + ProducerConfig.COMPRESSION_TYPE_CONFIG, compressionType))) { + + List<Future<RecordMetadata>> futures = records.stream().map(record -> producer.send(record)).toList(); + producer.flush(); + + for (Future<RecordMetadata> future : futures) { + assertDoesNotThrow(() -> future.get()); + } + } + } + + private void produceMessagesInSeparateBatch(String compressionType, String topic) throws ExecutionException, InterruptedException { + ProducerRecord<byte[], byte[]> record1 = new ProducerRecord<>(topic, 0, 100L, null, new byte[10]); + ProducerRecord<byte[], byte[]> record2 = new ProducerRecord<>(topic, 0, 999L, null, new byte[10]); + ProducerRecord<byte[], byte[]> record3 = new ProducerRecord<>(topic, 0, 200L, null, new byte[10]); + + // create a producer with large linger.ms and enough batch.size (default is enough for three 10 bytes records), + // so that we can confirm all records will be accumulated in producer until we flush them into one batch. + try (Producer<byte[], byte[]> producer = clusterInstance.producer(Map.of( + ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, clusterInstance.bootstrapServers(), + ProducerConfig.COMPRESSION_TYPE_CONFIG, compressionType))) { + + Future<RecordMetadata> future1 = producer.send(record1); + future1.get(); + // sleep some time in order to advance the server time + // after each record sent to make sure the time changed when appendTime is used + Thread.sleep(100); + + Future<RecordMetadata> future2 = producer.send(record2); + future2.get(); + Thread.sleep(100); + + Future<RecordMetadata> future3 = producer.send(record3); + future3.get(); + } + } + + private void verifyListOffsets(String topic, int expectedMaxTimestampOffset) throws ExecutionException, InterruptedException { + + // case 0: test the offsets from leader's append path + checkListOffsets(topic, expectedMaxTimestampOffset); + + // case 1: test the offsets from follower's append path. + // we make a follower be the new leader to handle the ListOffsetRequest + int previousLeader = clusterInstance.getLeaderBrokerId(new TopicPartition(topic, 0)); + int newLeader = clusterInstance.brokerIds().stream().filter(id -> id != previousLeader).findAny().get(); + + // change the leader to new one + adminClient.alterPartitionReassignments( + Map.of(new TopicPartition(topic, 0), Optional.of(new NewPartitionReassignment(List.of(newLeader)))) + ).all().get(); + // wait for all reassignments get completed + TestUtils.waitForCondition(() -> { + try { + return adminClient.listPartitionReassignments().reassignments().get().isEmpty(); + } catch (InterruptedException | ExecutionException e) { + return false; + } + }, "There still are ongoing reassignments"); + // make sure we are able to see the new leader + TestUtils.waitForCondition(() -> { + try { + return clusterInstance.getLeaderBrokerId(new TopicPartition(topic, 0)) == newLeader; + } catch (InterruptedException | ExecutionException e) { + return false; + } + }, String.format("expected leader: %d but actual: %d", newLeader, clusterInstance.getLeaderBrokerId(new TopicPartition(topic, 0)))); + checkListOffsets(topic, expectedMaxTimestampOffset); + + // case 2: test the offsets from recovery path. + // server will rebuild offset index according to log files if the index files are nonexistent + Set<String> indexFiles = clusterInstance.brokers().values().stream().flatMap(broker -> + CollectionConverters.asJava(broker.config().logDirs()).stream() + ).collect(Collectors.toUnmodifiableSet()); + clusterInstance.brokers().values().forEach(b -> b.shutdown()); + indexFiles.forEach(root -> { + File[] files = new File(String.format("%s/$s-0", root, topic)).listFiles(); Review Comment: You only have one token here, but pass two arguments to `format` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
