jolshan commented on code in PR #12501: URL: https://github.com/apache/kafka/pull/12501#discussion_r950318797
########## core/src/test/scala/integration/kafka/api/ProducerIdExpirationTest.scala: ########## @@ -0,0 +1,176 @@ +/** + * 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 kafka.api + +import java.util.{Collections, Properties} + +import kafka.integration.KafkaServerTestHarness +import kafka.server.KafkaConfig +import kafka.utils.{TestInfoUtils, TestUtils} +import kafka.utils.TestUtils.{consumeRecords, createAdminClient} +import org.apache.kafka.clients.admin.{Admin, ProducerState} +import org.apache.kafka.clients.consumer.KafkaConsumer +import org.apache.kafka.clients.producer.{KafkaProducer, ProducerRecord} +import org.apache.kafka.common.TopicPartition +import org.apache.kafka.common.errors.{InvalidPidMappingException, TransactionalIdNotFoundException} +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.{AfterEach, BeforeEach, TestInfo} +import org.junit.jupiter.params.ParameterizedTest +import org.junit.jupiter.params.provider.ValueSource + +import scala.jdk.CollectionConverters._ +import scala.collection.Seq + +// Test class that tests producer ID expiration +class ProducerIdExpirationTest extends KafkaServerTestHarness { + val topic1 = "topic1" + val numPartitions = 4 + val replicationFactor = 3 + val tp0 = new TopicPartition(topic1, 0) + + var producer: KafkaProducer[Array[Byte], Array[Byte]] = _ + var consumer: KafkaConsumer[Array[Byte], Array[Byte]] = _ + var admin: Admin = _ + + override def generateConfigs: Seq[KafkaConfig] = { + TestUtils.createBrokerConfigs(3, zkConnectOrNull).map(KafkaConfig.fromProps(_, serverProps())) + } + + @BeforeEach + override def setUp(testInfo: TestInfo): Unit = { + super.setUp(testInfo) + consumer = TestUtils.createConsumer(bootstrapServers(), + enableAutoCommit = false, + readCommitted = true) + admin = createAdminClient(brokers, listenerName) + + createTopic(topic1, numPartitions, 3) + } + + @AfterEach + override def tearDown(): Unit = { + if (producer != null) + producer.close() + consumer.close() + admin.close() + + super.tearDown() + } + + @ParameterizedTest(name = TestInfoUtils.TestWithParameterizedQuorumName) + @ValueSource(strings = Array("zk", "kraft")) + def testProducerIdExpirationWithNoTransactions(quorum: String): Unit = { + producer = TestUtils.createProducer(bootstrapServers(), enableIdempotence = true) + + // Send records to populate producer state cache. + producer.send(new ProducerRecord(topic1, 0, null, "key".getBytes, "value".getBytes)) + producer.flush() + + // Ensure producer IDs are added. + ensureConsistentKRaftMetadata() + assertEquals(1, producerState.size) + + // Wait for the producer ID to expire + TestUtils.waitUntilTrue(() => producerState.isEmpty, "Producer ID did not expire.") + + // Send more records to send producer ID back to brokers. + producer.send(new ProducerRecord(topic1, 0, null, "key".getBytes, "value".getBytes)) + producer.flush() + + // Producer IDs should repopulate. + assertEquals(1, producerState.size) + } + + @ParameterizedTest(name = TestInfoUtils.TestWithParameterizedQuorumName) + @ValueSource(strings = Array("zk", "kraft")) + def testTransactionAfterTransactionIdExpiresButProducerIdRemains(quorum: String): Unit = { + producer = TestUtils.createTransactionalProducer("transactionalProducer", brokers) + producer.initTransactions() + + // Start and then abort a transaction to allow the producer ID to expire + producer.beginTransaction() + producer.send(TestUtils.producerRecordWithExpectedTransactionStatus(topic1, 0, "2", "2", willBeCommitted = false)) + producer.flush() + + // Ensure producer IDs are added. + assertEquals(1, producerState.size) + + producer.abortTransaction() + + // Wait for the transactional ID to expire + Thread.sleep(3000) + + // Confirm the transactional IDs expired + val txnDescribeResult = admin.describeTransactions(Collections.singletonList("transactionalProducer")).description("transactionalProducer") + org.apache.kafka.test.TestUtils.assertFutureThrows(txnDescribeResult, classOf[TransactionalIdNotFoundException]) Review Comment: Ahaha, I should stop modeling the code from TransactionExpirationTest ########## core/src/test/scala/integration/kafka/api/ProducerIdExpirationTest.scala: ########## @@ -0,0 +1,176 @@ +/** + * 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 kafka.api + +import java.util.{Collections, Properties} + +import kafka.integration.KafkaServerTestHarness +import kafka.server.KafkaConfig +import kafka.utils.{TestInfoUtils, TestUtils} +import kafka.utils.TestUtils.{consumeRecords, createAdminClient} +import org.apache.kafka.clients.admin.{Admin, ProducerState} +import org.apache.kafka.clients.consumer.KafkaConsumer +import org.apache.kafka.clients.producer.{KafkaProducer, ProducerRecord} +import org.apache.kafka.common.TopicPartition +import org.apache.kafka.common.errors.{InvalidPidMappingException, TransactionalIdNotFoundException} +import org.junit.jupiter.api.Assertions.assertEquals +import org.junit.jupiter.api.{AfterEach, BeforeEach, TestInfo} +import org.junit.jupiter.params.ParameterizedTest +import org.junit.jupiter.params.provider.ValueSource + +import scala.jdk.CollectionConverters._ +import scala.collection.Seq + +// Test class that tests producer ID expiration +class ProducerIdExpirationTest extends KafkaServerTestHarness { + val topic1 = "topic1" + val numPartitions = 4 + val replicationFactor = 3 + val tp0 = new TopicPartition(topic1, 0) + + var producer: KafkaProducer[Array[Byte], Array[Byte]] = _ + var consumer: KafkaConsumer[Array[Byte], Array[Byte]] = _ + var admin: Admin = _ + + override def generateConfigs: Seq[KafkaConfig] = { + TestUtils.createBrokerConfigs(3, zkConnectOrNull).map(KafkaConfig.fromProps(_, serverProps())) + } + + @BeforeEach + override def setUp(testInfo: TestInfo): Unit = { + super.setUp(testInfo) + consumer = TestUtils.createConsumer(bootstrapServers(), + enableAutoCommit = false, + readCommitted = true) + admin = createAdminClient(brokers, listenerName) + + createTopic(topic1, numPartitions, 3) + } + + @AfterEach + override def tearDown(): Unit = { + if (producer != null) + producer.close() + consumer.close() + admin.close() + + super.tearDown() + } + + @ParameterizedTest(name = TestInfoUtils.TestWithParameterizedQuorumName) + @ValueSource(strings = Array("zk", "kraft")) + def testProducerIdExpirationWithNoTransactions(quorum: String): Unit = { + producer = TestUtils.createProducer(bootstrapServers(), enableIdempotence = true) + + // Send records to populate producer state cache. + producer.send(new ProducerRecord(topic1, 0, null, "key".getBytes, "value".getBytes)) + producer.flush() + + // Ensure producer IDs are added. + ensureConsistentKRaftMetadata() + assertEquals(1, producerState.size) + + // Wait for the producer ID to expire + TestUtils.waitUntilTrue(() => producerState.isEmpty, "Producer ID did not expire.") + + // Send more records to send producer ID back to brokers. + producer.send(new ProducerRecord(topic1, 0, null, "key".getBytes, "value".getBytes)) + producer.flush() + + // Producer IDs should repopulate. + assertEquals(1, producerState.size) + } + + @ParameterizedTest(name = TestInfoUtils.TestWithParameterizedQuorumName) + @ValueSource(strings = Array("zk", "kraft")) + def testTransactionAfterTransactionIdExpiresButProducerIdRemains(quorum: String): Unit = { + producer = TestUtils.createTransactionalProducer("transactionalProducer", brokers) + producer.initTransactions() + + // Start and then abort a transaction to allow the producer ID to expire + producer.beginTransaction() + producer.send(TestUtils.producerRecordWithExpectedTransactionStatus(topic1, 0, "2", "2", willBeCommitted = false)) + producer.flush() + + // Ensure producer IDs are added. + assertEquals(1, producerState.size) + + producer.abortTransaction() + + // Wait for the transactional ID to expire + Thread.sleep(3000) + + // Confirm the transactional IDs expired + val txnDescribeResult = admin.describeTransactions(Collections.singletonList("transactionalProducer")).description("transactionalProducer") + org.apache.kafka.test.TestUtils.assertFutureThrows(txnDescribeResult, classOf[TransactionalIdNotFoundException]) + + // Producer IDs should be retained. + assertEquals(1, producerState.size) + + // Start a new transaction and attempt to send, which will trigger an AddPartitionsToTxnRequest, which will fail due to the expired transactional ID + producer.beginTransaction() + val failedFuture = producer.send(TestUtils.producerRecordWithExpectedTransactionStatus(topic1, 3, "1", "1", willBeCommitted = false)) + TestUtils.waitUntilTrue(() => failedFuture.isDone, "Producer future never completed.") + + org.apache.kafka.test.TestUtils.assertFutureThrows(failedFuture, classOf[InvalidPidMappingException]) + producer.abortTransaction() + + producer.beginTransaction() + producer.send(TestUtils.producerRecordWithExpectedTransactionStatus(topic1, 2, "4", "4", willBeCommitted = true)) + producer.send(TestUtils.producerRecordWithExpectedTransactionStatus(topic1, 3, "3", "3", willBeCommitted = true)) + producer.commitTransaction() + + // Producer IDs should be retained. + assertEquals(1, producerState.size) + + // Check we can still consume the transaction + consumer.subscribe(List(topic1).asJava) + + val records = consumeRecords(consumer, 2) + records.foreach { record => + TestUtils.assertCommittedAndGetValue(record) + } + } + + private def producerState: java.util.List[ProducerState] = { Review Comment: sure. I can convert the result if that is preferred -- 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
