poorbarcode commented on code in PR #23738: URL: https://github.com/apache/pulsar/pull/23738#discussion_r1889490472
########## pulsar-client/src/main/java/org/apache/pulsar/client/impl/ProducerImpl.java: ########## @@ -483,19 +486,42 @@ private ByteBuf applyCompression(ByteBuf payload) { return compressedPayload; } + /** + * Please ignore the note. below if you have a customized {@param callback}. + * + * Otherwise, please confirm the value "refCnt()" of {@param message} {@link MessageImpl#getDataBuffer}' is "2" + * when you call this method, because the ByteBuf will be released twice: + * 1. When enabled "isBatchMessagingEnabled": + * 1-1. Releasing when it was pushed into the batched message queue, see: {@link #doBatchSendAndAdd} + * 1-2. Releasing in the method {@link SendCallback#sendComplete(Throwable, OpSendMsgStats)}. + * 2. Single message, in other words, disabled "isBatchMessagingEnabled": + * 2-1. Releasing when it was writen out by + * {@link ChannelOutboundHandler#write(ChannelHandlerContext, Object, ChannelPromise)}. + * 2-2. Releasing in the method {@link SendCallback#sendComplete(Throwable, OpSendMsgStats)}. + */ public void sendAsync(Message<?> message, SendCallback callback) { checkArgument(message instanceof MessageImpl); - - if (!isValidProducerState(callback, message.getSequenceId())) { - return; - } - MessageImpl<?> msg = (MessageImpl<?>) message; MessageMetadata msgMetadata = msg.getMessageBuilder(); ByteBuf payload = msg.getDataBuffer(); final int uncompressedSize = payload.readableBytes(); + // To guarantee compatibility with customized "SendCallback", see detail the doc of this method. + if ((callback instanceof ProducerImpl.DefaultSendMessageCallback + || callback.getClass().getName().endsWith("NonPersistentReplicator$ProducerSendCallback") + || callback.getClass().getName().endsWith("ProducerSendCallback$ProducerSendCallback")) + && msg.getDataBuffer().capacity() > 0) { + checkArgument(msg.getDataBuffer().refCnt() >= 2, + "Message's data's refCnt is less than 2, see #23738"); + } Review Comment: Removed ########## pulsar-broker/src/test/java/org/apache/pulsar/client/impl/ProducerCornerCaseTest.java: ########## @@ -0,0 +1,356 @@ +/* + * 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.pulsar.client.impl; + +import static org.awaitility.reflect.WhiteboxImpl.getInternalState; +import static org.testng.Assert.assertEquals; +import static org.testng.Assert.assertTrue; +import io.netty.buffer.ByteBuf; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import lombok.extern.slf4j.Slf4j; +import org.apache.pulsar.broker.BrokerTestUtil; +import org.apache.pulsar.client.api.CompressionType; +import org.apache.pulsar.client.api.Message; +import org.apache.pulsar.client.api.MessageId; +import org.apache.pulsar.client.api.Producer; +import org.apache.pulsar.client.api.ProducerConsumerBase; +import org.apache.pulsar.client.api.Schema; +import org.apache.pulsar.client.api.interceptor.ProducerInterceptor; +import org.awaitility.Awaitility; +import org.testng.annotations.AfterClass; +import org.testng.annotations.BeforeClass; +import org.testng.annotations.DataProvider; +import org.testng.annotations.Test; + +@Slf4j +@Test(groups = "broker-api") +public class ProducerCornerCaseTest extends ProducerConsumerBase { + + @BeforeClass(alwaysRun = true) + @Override + protected void setup() throws Exception { + super.internalSetup(); + super.producerBaseSetup(); + } + + @AfterClass(alwaysRun = true) + @Override + protected void cleanup() throws Exception { + super.internalCleanup(); + } + + @Override + protected void doInitConf() throws Exception { + super.doInitConf(); + conf.setTopicLevelPoliciesEnabled(false); + } + + @Test + public void testSendQueueIsFull() throws Exception { + final String topicName = BrokerTestUtil.newUniqueName("persistent://public/default/tp_"); + admin.topics().createNonPartitionedTopic(topicName); + ProducerImpl<String> producer = (ProducerImpl<String>) pulsarClient.newProducer(Schema.STRING) + .blockIfQueueFull(false).maxPendingMessages(1) + .enableBatching(true).topic(topicName).create(); + List<MsgPayloadTouchableMessageBuilder<String>> msgBuilderList = new ArrayList<>(); + for (int i = 0; i < 100; i++) { + msgBuilderList.add(newMessage(producer)); + } + int indexCalledSend = 0; + List<CompletableFuture> sendFutureList = new ArrayList<>(); + for (MsgPayloadTouchableMessageBuilder<String> msgBuilder: msgBuilderList) { + try { + sendFutureList.add(msgBuilder.value("msg-1").sendAsync()); + if (indexCalledSend != 99) { + indexCalledSend++; + } + } catch (Exception ex) { + log.warn("", ex); + break; + } + } + try{ + sendFutureList.get(sendFutureList.size() - 1).join(); + } catch (Exception ex) { + log.warn("", ex); + } + + producer.close(); + for (int i = indexCalledSend; i > -1; i--) { + MsgPayloadTouchableMessageBuilder<String> msgBuilder = msgBuilderList.get(i); + assertEquals(msgBuilder.payload.refCnt(), 1); + } + + // cleanup. + for (int i = indexCalledSend; i > -1; i--) { + MsgPayloadTouchableMessageBuilder<String> msgBuilder = msgBuilderList.get(i); + msgBuilder.release(); + assertEquals(msgBuilder.payload.refCnt(), 0); + } + for (int i = indexCalledSend + 1; i < 100; i++) { + MsgPayloadTouchableMessageBuilder<String> msgBuilder = msgBuilderList.get(i); + msgBuilder.release(); + assertEquals(msgBuilder.payload.refCnt(), 0); + } + admin.topics().delete(topicName); + } + + /** + * The content size of msg(value is "msg-1") will be "5". + * Then provides two param: 1 and 5. + * 1: reach the limitation before adding the message metadata. + * 2: reach the limitation after adding the message metadata. + */ + @DataProvider(name = "maxMessageSizeAndCompressions") + public Object[][] maxMessageSizeAndCompressions(){ + return new Object[][] { + {1, CompressionType.NONE}, + {5, CompressionType.NONE}, + {1, CompressionType.LZ4}, + {5, CompressionType.LZ4} + }; + } + + @Test(dataProvider = "maxMessageSizeAndCompressions") + public void testSendMessageSizeExceeded(int maxMessageSize, CompressionType compressionType) throws Exception { + final String topicName = BrokerTestUtil.newUniqueName("persistent://public/default/tp_"); + admin.topics().createNonPartitionedTopic(topicName); + ProducerImpl<String> producer = (ProducerImpl<String>) pulsarClient.newProducer(Schema.STRING).topic(topicName) + .compressionType(compressionType) + .enableBatching(false) + .compressionType(CompressionType.NONE) + .create(); + final ClientCnx cnx = producer.getClientCnx(); + producer.getConnectionHandler().maxMessageSize = maxMessageSize; + MsgPayloadTouchableMessageBuilder<String> msgBuilder = newMessage(producer); + /** + * Mock an error: reached max message size, see more details {@link #maxMessageSizeAndCompressions()}. + */ + msgBuilder.value("msg-1").sendAsync().exceptionally(ex -> { + log.warn("reached maxMessageSize", ex); + return null; + }).join(); + + // Verify: message payload has been released. + // Since "MsgPayloadTouchableMessageBuilder" has called "buffer.retain" once, "refCnt()" should be "1". + producer.close(); + Awaitility.await().untilAsserted(() -> { + assertEquals(producer.getPendingQueueSize(), 0); + }); + assertEquals(msgBuilder.payload.refCnt(), 1); + + // cleanup. + cnx.ctx().close(); + msgBuilder.release(); + assertEquals(msgBuilder.payload.refCnt(), 0); + admin.topics().delete(topicName); + } + + /** + * The content size of msg(value is "msg-1") will be "5". + * Then provides two param: 1 and 5. + * 1: Less than the limitation when adding the message into the batch-container. + * 3: Less than the limitation when building batched messages payload. + * 2: Equals the limitation when building batched messages payload. + */ + @DataProvider(name = "maxMessageSizes") + public Object[][] maxMessageSizes(){ + return new Object[][] { + {1}, + {3}, + {26} + }; + } + + @Test(dataProvider = "maxMessageSizes") + public void testBatchedSendMessageSizeExceeded(int maxMessageSize) throws Exception { + final String topicName = BrokerTestUtil.newUniqueName("persistent://public/default/tp_"); + admin.topics().createNonPartitionedTopic(topicName); + ProducerImpl<String> producer = (ProducerImpl<String>) pulsarClient.newProducer(Schema.STRING).topic(topicName) + .enableBatching(true) + .compressionType(CompressionType.NONE) + .create(); + final ClientCnx cnx = producer.getClientCnx(); + producer.getConnectionHandler().maxMessageSize = maxMessageSize; + MsgPayloadTouchableMessageBuilder<String> msgBuilder1 = newMessage(producer); + MsgPayloadTouchableMessageBuilder<String> msgBuilder2 = newMessage(producer); + /** + * Mock an error: reached max message size. see more detail {@link #maxMessageSizes()}. + */ + msgBuilder1.value("msg-1").sendAsync(); + msgBuilder2.value("msg-1").sendAsync().exceptionally(ex -> { + log.warn("reached maxMessageSize", ex); + return null; + }).join(); + + // Verify: message payload has been released. + // Since "MsgPayloadTouchableMessageBuilder" has called "buffer.retain" once, "refCnt()" should be "1". + producer.close(); + Awaitility.await().untilAsserted(() -> { + assertEquals(producer.getPendingQueueSize(), 0); + }); + assertEquals(msgBuilder1.payload.refCnt(), 1); + assertEquals(msgBuilder2.payload.refCnt(), 1); + + // cleanup. + cnx.ctx().close(); + msgBuilder1.release(); + msgBuilder2.release(); + assertEquals(msgBuilder1.payload.refCnt(), 0); + assertEquals(msgBuilder2.payload.refCnt(), 0); + admin.topics().delete(topicName); + } + + @Test + public void testSendAfterClosedProducer() throws Exception { + final String topicName = BrokerTestUtil.newUniqueName("persistent://public/default/tp_"); + admin.topics().createNonPartitionedTopic(topicName); + ProducerImpl<String> producer = + (ProducerImpl<String>) pulsarClient.newProducer(Schema.STRING).topic(topicName).create(); + // Publish after the producer was closed. + MsgPayloadTouchableMessageBuilder<String> msgBuilder = newMessage(producer); + producer.close(); + msgBuilder.value("msg-1").sendAsync().exceptionally(ex -> { + log.warn("expected error", ex); Review Comment: Solved -- 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: commits-unsubscr...@pulsar.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org