[improve][broker] PIP-423: Add a new admin API to acknowledge a single message by Denovo1998 · Pull Request #17 · Denovo1998/pulsar

Denovo1998 · 2025-11-09T10:01:52Z

Fixes #xyz

Main Issue: #23149

Motivation

Operators and SREs occasionally need to intervene in a topic's backlog to handle problematic messages or adapt to changing business requirements. For instance:

Cancelling Scheduled Actions: A delayed message representing a future task (e.g., a scheduled report or a notification) may become obsolete. The most efficient way to handle this is to prevent its delivery entirely by acknowledging it pre-emptively.
Removing Backlogs: A specific message in a backlog might have a malformed payload that causes consumer applications to crash repeatedly. Removing this single "poison pill" message without affecting valid messages around it is a critical operational capability. This also applies to removing a single bad message from within a larger batch.
Manual Business Logic Correction: An event may have been sent that is later determined to be invalid due to external factors. An administrator needs a precise tool to remove this specific event from a subscription's delivery queue.

The existing skip(numMessages) API is a blunt instrument, ill-suited for these precise, targeted operations. This proposal introduces an administrative API to skip messages by their specific MessageId (including ledgerId, entryId, and optional batchIndex), providing a robust and reliable way to remove any individual message—delayed or not—from a subscription's backlog.

Verifying this change

Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

Added integration tests for end-to-end deployment with large payloads (10MB)
Extended integration test for recovery after broker failure

Documentation

doc
doc-required
doc-not-needed
doc-complete

Matching PR in forked repository

PR in forked repository: apache#23907

…liveryTracker.

# Conflicts: # pulsar-broker/src/main/java/org/apache/pulsar/broker/service/Dispatcher.java

…ityQueue.

…ge message.

…Message

# Conflicts: # pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/PersistentTopicsBase.java # pulsar-broker/src/main/java/org/apache/pulsar/broker/service/persistent/PersistentSubscription.java # pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/Topics.java # pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/TestCmdTopics.java

… skipping messages

…ted classes

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2025-11-09T10:06:07Z


    CompletableFuture<Void> skipMessages(int numMessagesToSkip);

+    CompletableFuture<Void> skipMessages(List<SkipEntry> entries);


Provide SkipEntry implementation referenced by new APIs

The new skip-by-message-id flow adds a skipMessages(List<SkipEntry>) method to Subscription and imports org.apache.pulsar.broker.service.SkipEntry from several classes, but no such type exists anywhere in the project. This results in a compilation failure before any of the new code can run. Introduce the missing DTO (ledgerId, entryId, optional batch indexes) or reuse an existing type so the code builds.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2025-11-09T10:06:07Z

+    private void internalSkipByMessageIdsForPartitionedTopic(AsyncResponse asyncResponse,
+                                                             PartitionedTopicMetadata partitionMetadata,
+                                                             SkipMessageIdsRequest messageIds,
+                                                             String subName) {
+        final List<CompletableFuture<Void>> futures = new ArrayList<>(partitionMetadata.partitions);
+        PulsarAdmin admin;
+        try {
+            admin = pulsar().getAdminClient();
+        } catch (PulsarServerException e) {
+            asyncResponse.resume(new RestException(e));
+            return;
+        }
+        for (int i = 0; i < partitionMetadata.partitions; i++) {
+            TopicName topicNamePartition = topicName.getPartition(i);
+            // Rebuild an Admin API request using the parsed items to avoid legacy-map format
+            List<org.apache.pulsar.client.admin.SkipMessageIdsRequest.MessageIdItem> items = new ArrayList<>();
+            for (SkipMessageIdsRequest.MessageIdItem it : messageIds.getItems()) {
+                items.add(new org.apache.pulsar.client.admin.SkipMessageIdsRequest.MessageIdItem(
+                        it.getLedgerId(), it.getEntryId(), it.getBatchIndex()));
+            }
+            org.apache.pulsar.client.admin.SkipMessageIdsRequest req =
+                    org.apache.pulsar.client.admin.SkipMessageIdsRequest.forMessageIds(items);
+
+            futures.add(admin
+                    .topics()
+                    .skipMessagesAsync(topicNamePartition.toString(), subName, req));
+        }


Route message IDs to their owning partitions instead of broadcasting

The partitioned-topic handler sends the entire list of message IDs to every partition (for (int i …) calling skipMessagesAsync on each). When the request contains IDs that belong to only one partition (the normal case), the other partitions try to ack ledger/entry pairs that are not in their backlog and the whole operation fails once any partition returns an error. The admin API therefore cannot successfully skip a message on a multi-partition topic. Group message IDs by partition (e.g. via TopicName partition parsing or managed ledger ownership) and only invoke skipMessagesAsync for the partitions that actually contain each ID.

Useful? React with 👍 / 👎.

Copilot

Copilot reviewed 13 out of 13 changed files in this pull request and generated 15 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-09T10:13:23Z

+    void skipMessages(String topic, String subName, SkipMessageIdsRequest request) throws PulsarAdminException;
+
+    /**
+     * Async version of {@link #skipMessages(String, String, SkipMessageIdsRequest)}.


The javadoc for the async method is incomplete. It should include parameter and return documentation for consistency with other methods in this file. Consider:

/** * Skip messages by specifying a list of message IDs in various formats asynchronously. * Supports base64-encoded MessageId byte arrays and structured messageId objects with batchIndex. * * @param topic topic name (persistent://tenant/namespace/name) * @param subName subscription name * @param request request payload supporting multiple messageId formats * @return a future that can be used to track when the messages are skipped */

Suggested change

* Async version of {@link #skipMessages(String, String, SkipMessageIdsRequest)}.

* Skip messages by specifying a list of message IDs in various formats asynchronously.

* Supports base64-encoded MessageId byte arrays and structured messageId objects with batchIndex.

*

* @param topic topic name (persistent://tenant/namespace/name)

* @param subName subscription name

* @param request request payload supporting multiple messageId formats

* @return a future that can be used to track when the messages are skipped

Copilot · 2025-11-09T10:13:24Z

+        assertFalse((receivedMessages1.contains("msg-" + cancelMessage)
+                        || receivedMessages2.contains("msg-" + cancelMessage))
+                        && (receivedMessages1.size() + receivedMessages2.size() == 99),
+                "msg-" + cancelMessage + " should have been cancelled but was received");


The assertion logic is incorrect. The current logic assertFalse(A && B) passes if either the message was received OR the count is wrong, which is not the intended behavior. The test should verify:

The cancelled message was NOT received

Exactly 99 messages were received

Replace with:

assertFalse(receivedMessages1.contains("msg-" + cancelMessage) || receivedMessages2.contains("msg-" + cancelMessage), "msg-" + cancelMessage + " should have been cancelled but was received"); assertEquals(99, receivedMessages1.size() + receivedMessages2.size(), "Should have received exactly 99 messages");

Suggested change

assertFalse((receivedMessages1.contains("msg-" + cancelMessage)

|| receivedMessages2.contains("msg-" + cancelMessage))

&& (receivedMessages1.size() + receivedMessages2.size() == 99),

"msg-" + cancelMessage + " should have been cancelled but was received");

assertFalse(receivedMessages1.contains("msg-" + cancelMessage)

|| receivedMessages2.contains("msg-" + cancelMessage),

"msg-" + cancelMessage + " should have been cancelled but was received");

assertEquals(99, receivedMessages1.size() + receivedMessages2.size(),

"Should have received exactly 99 messages");

Copilot · 2025-11-09T10:13:25Z

+                        throw new ParameterException("Invalid --messageId-triplet: " + s + ", " + e.getMessage());
+                    }
+                    items.add(new SkipMessageIdsRequest.MessageIdItem(ledgerId, entryId, batchIndex));
+                }


After filtering null/empty triplets, the items list could be empty. Consider validating that at least one valid message ID was provided before making the API call:

if (items.isEmpty()) { throw new ParameterException("No valid message IDs provided"); }

Suggested change

}

}

if (items.isEmpty()) {

throw new ParameterException("No valid message IDs provided");

}

Copilot · 2025-11-09T10:13:25Z

+            @ApiResponse(code = 307, message = "Current broker doesn't serve the namespace of this topic"),
+            @ApiResponse(code = 400, message = "Bad Request: invalid messageIds format"),
+            @ApiResponse(code = 403, message = "Don't have admin permission"),
+            @ApiResponse(code = 404, message = "Namesapce or topic or subscription does not exist") })


Typo in error message: "Namesapce" should be "Namespace"

Copilot · 2025-11-09T10:13:25Z

 import org.apache.pulsar.broker.service.BrokerServiceException.SubscriptionInvalidCursorPosition;
 import org.apache.pulsar.broker.service.GetStatsOptions;
 import org.apache.pulsar.broker.service.MessageExpirer;
+import org.apache.pulsar.broker.service.SkipEntry;


The imported class SkipEntry does not exist in the codebase and needs to be created. See the comment on PersistentSubscription.java for the required class structure.

Copilot · 2025-11-09T10:13:27Z

+        private String topicName;
+
+        @Option(names = { "-s",
+                "--subscription" }, description = "Subscription to be skip messages on", required = true)


Grammar issue: "Subscription to be skip messages on" should be "Subscription to skip messages on"

Copilot · 2025-11-09T10:13:27Z

+        for (int i = 0; i < partitionMetadata.partitions; i++) {
+            TopicName topicNamePartition = topicName.getPartition(i);
+            // Rebuild an Admin API request using the parsed items to avoid legacy-map format
+            List<org.apache.pulsar.client.admin.SkipMessageIdsRequest.MessageIdItem> items = new ArrayList<>();
+            for (SkipMessageIdsRequest.MessageIdItem it : messageIds.getItems()) {
+                items.add(new org.apache.pulsar.client.admin.SkipMessageIdsRequest.MessageIdItem(
+                        it.getLedgerId(), it.getEntryId(), it.getBatchIndex()));
+            }
+            org.apache.pulsar.client.admin.SkipMessageIdsRequest req =
+                    org.apache.pulsar.client.admin.SkipMessageIdsRequest.forMessageIds(items);
+
+            futures.add(admin
+                    .topics()
+                    .skipMessagesAsync(topicNamePartition.toString(), subName, req));
+        }


The logic for handling partitioned topics appears incorrect. The same message IDs are sent to all partitions (loop on lines 2000-2014), but message IDs are partition-specific - a message ID from partition-0 won't exist in partition-1.

This will likely result in errors or no-op behavior on most partitions. Consider either:

Requiring users to specify the partition explicitly for this operation (document that it doesn't work on partitioned topic names)

Implementing logic to extract partition information from the message IDs if available

Changing the API to accept partition-specific message ID mappings

Copilot · 2025-11-09T10:13:27Z

+        public long getLedgerId() {
+            return ledgerId;
+        }
+
+        public long getEntryId() {
+            return entryId;
+        }
+
+        public Integer getBatchIndex() {
+            return batchIndex;
+        }


The getter methods (getLedgerId, getEntryId, getBatchIndex) are redundant for a Java record, as records automatically generate these methods. These explicit definitions can be removed.

Suggested change

public long getLedgerId() {

return ledgerId;

}

public long getEntryId() {

return entryId;

}

public Integer getBatchIndex() {

return batchIndex;

}

Copilot · 2025-11-09T10:13:28Z

+            @ApiResponse(code = 401, message = "Don't have permission to administrate resources on this tenant"),
+            @ApiResponse(code = 403, message = "Don't have admin permission"),
+            @ApiResponse(code = 404, message = "Namespace or topic or subscription does not exist"),
+            @ApiResponse(code = 405, message = "Skipping messages on a partitioned topic is not allowed"),


The error message "Skipping messages on a partitioned topic is not allowed" is inaccurate. The implementation supports partitioned topics by iterating over all partitions (see internalSkipByMessageIdsForPartitionedTopic). This ApiResponse should be removed or the message should be updated to reflect actual limitations.

Suggested change

@ApiResponse(code = 405, message = "Skipping messages on a partitioned topic is not allowed"),

Copilot · 2025-11-09T10:13:28Z

 import org.apache.pulsar.broker.service.Dispatcher;
 import org.apache.pulsar.broker.service.EntryFilterSupport;
 import org.apache.pulsar.broker.service.GetStatsOptions;
+import org.apache.pulsar.broker.service.SkipEntry;


The imported class SkipEntry does not exist in the codebase. This class needs to be created with the following structure based on its usage:

package org.apache.pulsar.broker.service; import java.util.List; public class SkipEntry { private final long ledgerId; private final long entryId; private final List<Integer> batchIndexes; public SkipEntry(long ledgerId, long entryId, List<Integer> batchIndexes) { this.ledgerId = ledgerId; this.entryId = entryId; this.batchIndexes = batchIndexes; } public long getLedgerId() { return ledgerId; } public long getEntryId() { return entryId; } public List<Integer> getBatchIndexes() { return batchIndexes; } }

Alternatively, it could be defined as a record.

…ndexes

…to MessageIdItem

codecov · 2026-02-24T04:24:06Z

Codecov Report

❌ Patch coverage is 41.69096% with 200 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.69%. Comparing base (9937d22) to head (c7df916).
⚠️ Report is 218 commits behind head on master.

Files with missing lines	Patch %	Lines
...ker/service/persistent/PersistentSubscription.java	19.58%	68 Missing and 10 partials ⚠️
...che/pulsar/broker/admin/SkipMessageIdsRequest.java	35.86%	41 Missing and 18 partials ⚠️
...pulsar/broker/admin/impl/PersistentTopicsBase.java	55.88%	23 Missing and 7 partials ⚠️
...in/java/org/apache/pulsar/admin/cli/CmdTopics.java	65.71%	5 Missing and 7 partials ⚠️
...pache/pulsar/broker/admin/v1/PersistentTopics.java	0.00%	8 Missing ⚠️
...pache/pulsar/broker/admin/v2/PersistentTopics.java	50.00%	4 Missing ⚠️
...che/pulsar/client/admin/SkipMessageIdsRequest.java	78.94%	4 Missing ⚠️
...va/org/apache/pulsar/broker/service/SkipEntry.java	71.42%	1 Missing and 1 partial ⚠️
...pache/pulsar/client/admin/internal/TopicsImpl.java	75.00%	1 Missing and 1 partial ⚠️
...rvice/nonpersistent/NonPersistentSubscription.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             master      #17       +/-   ##
=============================================
+ Coverage     30.86%   72.69%   +41.83%     
- Complexity       51    34503    +34452     
=============================================
  Files          1862     1962      +100     
  Lines        146347   155743     +9396     
  Branches      17011    17791      +780     
=============================================
+ Hits          45171   113225    +68054     
+ Misses        94161    33508    -60653     
- Partials       7015     9010     +1995

Flag	Coverage Δ
inttests	`25.71% <0.00%> (-0.88%)`	⬇️
systests	`22.39% <0.00%> (-0.49%)`	⬇️
unittests	`73.68% <41.69%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...org/apache/pulsar/broker/service/Subscription.java	`69.23% <ø> (+61.53%)`	⬆️
...in/java/org/apache/pulsar/client/admin/Topics.java	`83.33% <ø> (+45.23%)`	⬆️
...rvice/nonpersistent/NonPersistentSubscription.java	`57.39% <0.00%> (+29.44%)`	⬆️
...va/org/apache/pulsar/broker/service/SkipEntry.java	`71.42% <71.42%> (ø)`
...pache/pulsar/client/admin/internal/TopicsImpl.java	`84.56% <75.00%> (+76.54%)`	⬆️
...pache/pulsar/broker/admin/v2/PersistentTopics.java	`87.59% <50.00%> (+77.38%)`	⬆️
...che/pulsar/client/admin/SkipMessageIdsRequest.java	`78.94% <78.94%> (ø)`
...pache/pulsar/broker/admin/v1/PersistentTopics.java	`52.19% <0.00%> (+52.19%)`	⬆️
...in/java/org/apache/pulsar/admin/cli/CmdTopics.java	`80.33% <65.71%> (+80.33%)`	⬆️
...pulsar/broker/admin/impl/PersistentTopicsBase.java	`69.36% <55.88%> (+59.63%)`	⬆️
... and 2 more

... and 1534 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Denovo1998 added 14 commits January 29, 2025 11:48

Implementing delayed message cancellation in pulsar

7afe161

feat(broker): Add support for canceling delayed messages in DelayedDe…

88ffdf9

…liveryTracker.

add cancelDelayedMessage admin api.

212f174

Merge branch 'master' into delay_msg_cancel

8686255

# Conflicts: # pulsar-broker/src/main/java/org/apache/pulsar/broker/service/Dispatcher.java

the cancel command does not need to be added to the sharedBucketPrior…

6fe2b11

…ityQueue.

fix test.

dc079a6

clean up useless canceledMessages.

f66f1b5

Implement the delayed message cancellation function through acknowled…

391a426

…ge message.

feat(admin): add skipMessages by message IDs and remove cancelDelayed…

d7f025c

…Message

use skipByMessageIds as the new path

5f170cc

feat: enhance skipMessages functionality to support batch indices

347e52f

feat: implement SkipMessageIdsRequest to support multiple formats for…

a4911e5

… skipping messages

feat: refactor skipMessages to accept List<SkipEntry> and update rela…

2e77580

…ted classes

Copilot AI review requested due to automatic review settings November 9, 2025 10:01

Denovo1998 mentioned this pull request Nov 9, 2025

[improve][broker] PIP-423: Add a new admin API to acknowledge a single message apache/pulsar#23907

Open

5 tasks

chatgpt-codex-connector Bot reviewed Nov 9, 2025

View reviewed changes

Copilot AI reviewed Nov 9, 2025

View reviewed changes

Denovo1998 added 7 commits November 9, 2025 18:13

feat: add SkipEntry model for skipping messages with optional batch i…

e7a988a

…ndexes

fix: update subscription description for clarity and add constructor …

4613789

…to MessageIdItem

fix: remove unnecessary whitespace in SkipEntry.java

275a3cb

Merge branch 'master' into delay_msg_cancel

a88ace7

feat(broker): Support skipping messages by ID on partitioned topics

b5efe78

refactor(broker): Improve skipMessages API and test coverage

fd17f4d

test(service): Remove unused import from BucketDelayedDeliveryTest

c7df916


		CompletableFuture<Void> skipMessages(int numMessagesToSkip);

		CompletableFuture<Void> skipMessages(List<SkipEntry> entries);

-     * Async version of {@link #skipMessages(String, String, SkipMessageIdsRequest)}.
+     * Skip messages by specifying a list of message IDs in various formats asynchronously.
+     * Supports base64-encoded MessageId byte arrays and structured messageId objects with batchIndex.
+     *
+     * @param topic topic name (persistent://tenant/namespace/name)
+     * @param subName subscription name
+     * @param request request payload supporting multiple messageId formats
+     * @return a future that can be used to track when the messages are skipped

-                }
+                }
+                if (items.isEmpty()) {
+                    throw new ParameterException("No valid message IDs provided");
+                }

Conversation

Denovo1998 commented Nov 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Verifying this change

Documentation

Matching PR in forked repository

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector Bot Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Denovo1998 commented Nov 9, 2025 •

edited

Loading

codecov Bot commented Feb 24, 2026 •

edited

Loading