Ensure that the same message ID is not added to UnAckedMessageTracker multiple times (#5823)
### Motivation
When a message ID is added to `UnAckedMessageTracker`, it is added as an instance of `MessageIdImpl`, not `BatchMessageIdImpl`. Since the batch index information is deleted at this time, the same message ID will be added to `UnAckedMessageTracker` multiple times when consumer receives batched messages.
https://github.com/apache/pulsar/blob/a8c8a7ee1559bc607b3454fa55134094d8a2c208/pulsar-client/src/main/java/org/apache/pulsar/client/impl/ConsumerImpl.java#L1124-L1134
There is no problem even if the same message ID is added without taking too much time. However, if the interval between these message IDs is long, the message IDs may be added to other elements of `timePartitions`.
https://github.com/apache/pulsar/blob/09360682953d0cbc154630a470492c11a4f83184/pulsar-client/src/main/java/org/apache/pulsar/client/impl/UnAckedMessageTracker.java#L163-L172
As a result, even if the consumer sends ack, some message IDs remain without being deleted from `timePartitions`, and an unnecessary ack timeout event occurs.
### Modifications
When adding a message ID to `UnAckedMessageTracker`, check if the same message ID is already included in` timePartitions`, and if it is included, do nothing.
diff --git a/pulsar-client/src/main/java/org/apache/pulsar/client/impl/UnAckedMessageTracker.java b/pulsar-client/src/main/java/org/apache/pulsar/client/impl/UnAckedMessageTracker.java
index 43065d2..d137011 100644
--- a/pulsar-client/src/main/java/org/apache/pulsar/client/impl/UnAckedMessageTracker.java
+++ b/pulsar-client/src/main/java/org/apache/pulsar/client/impl/UnAckedMessageTracker.java
@@ -164,8 +164,13 @@
writeLock.lock();
try {
ConcurrentOpenHashSet<MessageId> partition = timePartitions.peekLast();
- messageIdPartitionMap.put(messageId, partition);
- return partition.add(messageId);
+ ConcurrentOpenHashSet<MessageId> previousPartition = messageIdPartitionMap.putIfAbsent(messageId,
+ partition);
+ if (previousPartition == null) {
+ return partition.add(messageId);
+ } else {
+ return false;
+ }
} finally {
writeLock.unlock();
}
diff --git a/pulsar-client/src/test/java/org/apache/pulsar/client/impl/UnAckedMessageTrackerTest.java b/pulsar-client/src/test/java/org/apache/pulsar/client/impl/UnAckedMessageTrackerTest.java
new file mode 100644
index 0000000..94e85ff
--- /dev/null
+++ b/pulsar-client/src/test/java/org/apache/pulsar/client/impl/UnAckedMessageTrackerTest.java
@@ -0,0 +1,77 @@
+/**
+ * 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.testng.Assert.assertEquals;
+import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertTrue;
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import io.netty.util.HashedWheelTimer;
+import io.netty.util.Timer;
+import io.netty.util.concurrent.DefaultThreadFactory;
+
+import java.util.concurrent.TimeUnit;
+
+import org.apache.pulsar.client.api.MessageId;
+import org.apache.pulsar.common.util.collections.ConcurrentOpenHashSet;
+import org.testng.annotations.Test;
+
+public class UnAckedMessageTrackerTest {
+
+ @Test
+ public void testAddAndRemove() throws Exception {
+ PulsarClientImpl client = mock(PulsarClientImpl.class);
+ Timer timer = new HashedWheelTimer(new DefaultThreadFactory("pulsar-timer", Thread.currentThread().isDaemon()),
+ 1, TimeUnit.MILLISECONDS);
+ when(client.timer()).thenReturn(timer);
+
+ ConsumerBase<byte[]> consumer = mock(ConsumerBase.class);
+ doNothing().when(consumer).onAckTimeoutSend(any());
+ doNothing().when(consumer).redeliverUnacknowledgedMessages(any());
+
+ UnAckedMessageTracker tracker = new UnAckedMessageTracker(client, consumer, 1000000, 100000);
+ tracker.close();
+
+ assertTrue(tracker.isEmpty());
+ assertEquals(tracker.size(), 0);
+
+ MessageIdImpl mid = new MessageIdImpl(1L, 1L, -1);
+ assertTrue(tracker.add(mid));
+ assertFalse(tracker.add(mid));
+ assertEquals(tracker.size(), 1);
+
+ ConcurrentOpenHashSet<MessageId> headPartition = tracker.timePartitions.removeFirst();
+ headPartition.clear();
+ tracker.timePartitions.addLast(headPartition);
+
+ assertFalse(tracker.add(mid));
+ assertEquals(tracker.size(), 1);
+
+ assertTrue(tracker.remove(mid));
+ assertTrue(tracker.isEmpty());
+ assertEquals(tracker.size(), 0);
+
+ timer.stop();
+ }
+
+}
