[feat][pip] PIP-452: Customizable topic listing of namespace with properties #25134

coderzc · 2026-01-11T09:46:13Z

Fixes #xyz

Main Issue: #xyz

PIP: #xyz

Motivation

Modifications

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

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

Documentation

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

Matching PR in forked repository

PR in forked repository:

pip/pip-452.md

BewareMyPower · 2026-01-13T02:20:17Z

pip/pip-452.md

+     * Return an invalid result indicating that the caller should continue with the default logic.
+     */
+    public static TopicListingResult passThrough() {
+        return PASS_THROUGH_INSTANCE;


This design is a bit over-abstraction. IMO, the following design could be simpler and clearer.

public record TopicListingResult(List<String> topics, boolean filtered) {}

/** * @return the future of the result, if it's empty, fall back to the built-in implementation to list all topics */ default CompletableFuture<Optional<TopicListingResult>> interceptGetTopicsOfNamespace(

Since the built-in implementation is very simple that calls method directly on the NamespaceService, I think the fallback logic is unnecessary.

Since we allow the configuration of multiple interceptors, the return here means that the result of current interception is not processed this method. If all the interceptors do not process the method, the default logic will be used.

In addition, the interception configuration is empty by default. In this case, we still need to fall back to the default logic.

default CompletableFuture<Optional<TopicListingResult>> interceptGetTopicsOfNamespace()

Applied this suggestion

Copilot

Pull request overview

This PR introduces PIP-452, which proposes a design for customizable topic listing in Pulsar's GetTopicsOfNamespace command. The proposal aims to make topic discovery more flexible by allowing clients to pass context properties and enabling plugins to override the default metadata store scanning behavior.

Changes:

Adds protocol extension to include properties field in CommandGetTopicsOfNamespace
Introduces BrokerInterceptor interface method for custom topic listing logic
Extends REST API and CLI to support properties parameter for topic listing

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

pip/pip-452.md

…space with properties

…operties

…operties in ListTopicsOptions

pip/pip-452.md

…st watch is not supported.

pip/pip-452.md

codelipenghui · 2026-01-28T01:37:08Z

pip/pip-452.md

+
+CLI:
+```
+pulsar-admin topics list <tenant>/<namespace> -p k1=v1 -p k2=v2


Suggested change

pulsar-admin topics list <tenant>/<namespace> -p k1=v1 -p k2=v2

pulsar-admin topics list <tenant>/<namespace> -p k1=v1,k2=v2

Just make it consistent with the REST API

I think the current definition is more friendly to cli.

Just checked the Kubernetes style

kubectl get pods -l app=nginx,environment=production

pip/pip-452.md

codelipenghui · 2026-01-28T01:42:18Z

pip/pip-452.md

+broker.conf
+```properties
+# Enables watching topic add/remove events on broker side. It is separated from enableBrokerSideSubscriptionPatternEvaluation.
+enableBrokerTopicListWatcher = true


How this configuration will be used? Here defined the configuration name, but there is no detailed behavior definition for this configuration.

Out of Scope

Not support topic list watching for customized topic listing in this PIP. It can be considered in future work.
If you want to use this feature, you need to disable topic list watcher by set enableBrokerTopicListWatcher = false.

Ok, so can we remove all the related information for enableBrokerTopicListWatcher? I mean, after we supported topic list watching for customized topic listing, this configuration will be useless?

If it's required to be added, please help provide more information about how this configuration works. I'm not pretty clear about this part.

pip/pip-452.md

…listing strategies

coderzc · 2026-01-30T12:18:07Z

After discussions with @codelipenghui and @BewareMyPower, we found that the current working method of BrokerInterceptor cannot accurately specify which result to use when multiple BrokerInterceptors are configured. Therefore, a new pluggable interface PulsarResourcesExtended has been introduced to implement this feature.

PulsarResourcesExtended is defined as a general interface used as an extension for customized PulsarResources

…on and flexible topic listing method

Clarified the description of the 'properties' parameter in the listTopicOfNamespace method.

lhotari

LGTM

github-actions bot added PIP doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. labels Jan 11, 2026

coderzc force-pushed the pip-452 branch from 95e9190 to a519d12 Compare January 11, 2026 09:48

BewareMyPower reviewed Jan 12, 2026

View reviewed changes

pip/pip-452.md Outdated Show resolved Hide resolved

coderzc force-pushed the pip-452 branch 11 times, most recently from 06e3b36 to 7348e97 Compare January 12, 2026 16:42

BewareMyPower reviewed Jan 13, 2026

View reviewed changes

pip/pip-452.md Outdated Show resolved Hide resolved

BewareMyPower reviewed Jan 13, 2026

View reviewed changes

coderzc force-pushed the pip-452 branch from 93ea79a to 09dc7a5 Compare January 13, 2026 07:08

BewareMyPower requested a review from Copilot January 13, 2026 08:34

Copilot started reviewing on behalf of BewareMyPower January 13, 2026 08:40 View session

Copilot AI reviewed Jan 13, 2026

View reviewed changes

coderzc changed the title ~~[feat][broker] PIP-452: Customizable Topic Listing in GetTopicsOfNamespace with properties~~ [feat][broker] PIP-452: Customizable topic listing of namespace with properties Jan 14, 2026

coderzc force-pushed the pip-452 branch 2 times, most recently from cfa592c to 70224d9 Compare January 14, 2026 06:19

coderzc added 6 commits January 14, 2026 14:25

[feat][broker] PIP-452: Customizable Topic Listing in GetTopicsOfName…

d9ebc1a

…space with properties

Add interceptGetTopicsOfNamespace method on BrokerInterceptor

cc06f10

Enhance GetTopicsOfNamespace with customizable topic listing using pr…

3f6c0b1

…operties

update interceptGetTopicsOfNamespace to return Optional and handle pr…

5e91453

…operties in ListTopicsOptions

address comment & update title

7c064cb

improve doc

6b61215

coderzc force-pushed the pip-452 branch from 70224d9 to 6b61215 Compare January 14, 2026 06:45

coderzc added this to the 4.2.0 milestone Jan 14, 2026

lhotari reviewed Jan 14, 2026

View reviewed changes

pip/pip-452.md Show resolved Hide resolved

lhotari reviewed Jan 14, 2026

View reviewed changes

pip/pip-452.md Show resolved Hide resolved

Add enableBrokerTopicListWatcher config and explained that topic li…

50a5a63

…st watch is not supported.

coderzc force-pushed the pip-452 branch from 0ddf8f3 to 50a5a63 Compare January 14, 2026 10:02

coderzc mentioned this pull request Jan 18, 2026

[feat][broker] PIP-452: Customizable topic listing of namespace with properties #25160

Draft

15 tasks

coderzc changed the title ~~[feat][broker] PIP-452: Customizable topic listing of namespace with properties~~ [feat][pip] PIP-452: Customizable topic listing of namespace with properties Jan 18, 2026

Add Mailing List voting thread link

e6e548c

codelipenghui reviewed Jan 28, 2026

View reviewed changes

coderzc added 2 commits January 28, 2026 11:10

address comment

c0a1802

Introduce PulsarResourcesExtended interface for customizable topic …

3eaded2

…listing strategies

coderzc force-pushed the pip-452 branch 2 times, most recently from 28a5562 to a835edd Compare January 30, 2026 12:41

coderzc requested review from BewareMyPower, codelipenghui and lhotari January 30, 2026 12:41

Enhance PulsarResourcesExtended interface with detailed documentati…

cf14cdf

…on and flexible topic listing method

coderzc force-pushed the pip-452 branch from a835edd to cf14cdf Compare January 30, 2026 12:45

coderzc added 2 commits January 31, 2026 22:04

Update properties parameter description in listTopicOfNamespace

60cdd53

Clarified the description of the 'properties' parameter in the listTopicOfNamespace method.

Update pip-452.md

67b9bb9

lhotari approved these changes Feb 2, 2026

View reviewed changes

	pulsar-admin topics list <tenant>/<namespace> -p k1=v1 -p k2=v2
	pulsar-admin topics list <tenant>/<namespace> -p k1=v1,k2=v2

[feat][pip] PIP-452: Customizable topic listing of namespace with properties #25134

Are you sure you want to change the base?

[feat][pip] PIP-452: Customizable topic listing of namespace with properties #25134

Conversation

coderzc commented Jan 11, 2026

Motivation

Modifications

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

Matching PR in forked repository

Uh oh!

Uh oh!

Uh oh!

BewareMyPower Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderzc Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coderzc Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Out of Scope

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderzc commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lhotari left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

BewareMyPower Jan 13, 2026 •

edited

Loading

coderzc Jan 13, 2026 •

edited

Loading

coderzc Jan 13, 2026 •

edited

Loading

coderzc commented Jan 30, 2026 •

edited

Loading