This is an automated email from the ASF dual-hosted git repository.
lizhimins pushed a commit to branch rocketmq-studio
in repository https://gitbox.apache.org/repos/asf/rocketmq-dashboard.git
The following commit(s) were added to refs/heads/rocketmq-studio by this push:
new 296550b1 fix: unify system topic/group filtering across providers
(#1402, #1408)
296550b1 is described below
commit 296550b176bb3f70d936f37e25146fa56feb9d25
Author: Yu Xinqiang <[email protected]>
AuthorDate: Tue Aug 11 00:26:20 2026 +0800
fix: unify system topic/group filtering across providers (#1402, #1408)
* [ISSUE #1401] Unify system consumer group filtering across providers
Three separate isSystemGroup/isSystemConsumerGroup implementations had
inconsistent filtering rules, causing system groups like CID_ONSAPI_*
and CID_HOUSEKEEPING to leak into topic consumer lists and inflate
dashboard group counts.
This fix:
- Extracts a shared SystemGroupFilter utility class consolidating all
system group patterns
- Replaces all three implementations with calls to the shared method
- Fixes the CID_ONS_ vs CID_ONSAPI_ prefix bug in MetadataProvider
- Adds missing %RETRY%, %DLQ%, CID_SYS_, CID_HOUSEKEEPING filters to
DashboardProvider
Fixes #1401
* [ISSUE #1407] Unify system topic filtering across providers
Two separate isSystemTopic implementations had inconsistent filtering
rules, causing system topics to leak into topic lists and inflate
dashboard topic counts. Key discrepancies:
- CID_ prefix was in MetadataProvider but not DashboardProvider
- broker_ prefix was in DashboardProvider but not MetadataProvider
- DashboardProvider had hardcoded broker-a/broker-b names
- DashboardProvider did not check live broker names as system topics
This fix:
- Extracts a shared SystemTopicFilter utility class
- Replaces both implementations with calls to the shared method
- Removes hardcoded broker-a/broker-b from DashboardProvider
- Adds CID_, broker_, BenchmarkTest to the unified filter
Fixes #1407
---
.../studio/common/util/SystemGroupFilter.java | 53 ++++++++++++++++
.../studio/common/util/SystemTopicFilter.java | 74 ++++++++++++++++++++++
.../provider/apache/RocketMQClientProvider.java | 13 +---
.../provider/apache/RocketMQDashboardProvider.java | 17 +----
.../provider/apache/RocketMQMetadataProvider.java | 22 +------
5 files changed, 135 insertions(+), 44 deletions(-)
diff --git
a/server/src/main/java/org/apache/rocketmq/studio/common/util/SystemGroupFilter.java
b/server/src/main/java/org/apache/rocketmq/studio/common/util/SystemGroupFilter.java
new file mode 100644
index 00000000..d352ec82
--- /dev/null
+++
b/server/src/main/java/org/apache/rocketmq/studio/common/util/SystemGroupFilter.java
@@ -0,0 +1,53 @@
+/*
+ * 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.rocketmq.studio.common.util;
+
+/**
+ * Shared utility for identifying RocketMQ system consumer groups.
+ *
+ * <p>Consolidates the system group prefix list that was previously duplicated
+ * (with inconsistencies) across {@code RocketMQClientProvider},
+ * {@code RocketMQMetadataProvider}, and {@code RocketMQDashboardProvider}.
+ */
+public final class SystemGroupFilter {
+
+ private SystemGroupFilter() {
+ }
+
+ /**
+ * Returns {@code true} if the given group name is a RocketMQ system
consumer group
+ * that should be hidden from user-facing lists and excluded from
dashboard counts.
+ *
+ * @param group the consumer group name, may be {@code null}
+ * @return {@code true} if the group is a system group
+ */
+ public static boolean isSystem(String group) {
+ if (group == null || group.isEmpty()) {
+ return true;
+ }
+ return group.startsWith("CID_RMQ_SYS_")
+ || group.startsWith("CID_ONSAPI_")
+ || group.startsWith("CID_SYS_")
+ || group.startsWith("CID_HOUSEKEEPING")
+ || group.startsWith("rmq_sys_")
+ || group.startsWith("%RETRY%")
+ || group.startsWith("%DLQ%")
+ || group.startsWith("TOOLS_CONSUMER")
+ || group.startsWith("FILTERSRV_CONSUMER")
+ || group.startsWith("SELF_TEST_");
+ }
+}
diff --git
a/server/src/main/java/org/apache/rocketmq/studio/common/util/SystemTopicFilter.java
b/server/src/main/java/org/apache/rocketmq/studio/common/util/SystemTopicFilter.java
new file mode 100644
index 00000000..ae21e144
--- /dev/null
+++
b/server/src/main/java/org/apache/rocketmq/studio/common/util/SystemTopicFilter.java
@@ -0,0 +1,74 @@
+/*
+ * 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.rocketmq.studio.common.util;
+
+import java.util.Set;
+
+/**
+ * Shared utility for identifying RocketMQ system topics.
+ *
+ * <p>Consolidates the system topic prefix and exact-match lists that were
previously
+ * duplicated (with inconsistencies) across {@code RocketMQMetadataProvider}
+ * and {@code RocketMQDashboardProvider}.
+ */
+public final class SystemTopicFilter {
+
+ private static final Set<String> SYSTEM_TOPIC_PREFIXES = Set.of(
+ "RMQ_SYS_", "rmq_sys_", "SCHEDULE_TOPIC_", "%RETRY%", "%DLQ%",
+ "CID_", "broker_", "BenchmarkTest"
+ );
+
+ private static final Set<String> SYSTEM_TOPICS = Set.of(
+ "TBW102", "SELF_TEST_TOPIC", "DefaultCluster",
"OFFSET_MOVED_EVENT",
+ "broker", "SCHEDULE_TOPIC_XXXX", "RMQ_SYS_TRANS_HALF_TOPIC",
+ "RMQ_SYS_TRACE_TOPIC", "RMQ_SYS_TRANS_OP_HALF_TOPIC"
+ );
+
+ private SystemTopicFilter() {
+ }
+
+ /**
+ * Returns {@code true} if the given topic name is a RocketMQ system topic
+ * that should be hidden from user-facing lists and excluded from
dashboard counts.
+ *
+ * @param topicName the topic name, may be {@code null}
+ * @param brokerNames optional set of broker names; topics matching a
broker name
+ * are also considered system topics (may be empty)
+ * @return {@code true} if the topic is a system topic
+ */
+ public static boolean isSystem(String topicName, Set<String> brokerNames) {
+ if (topicName == null || topicName.isEmpty()) {
+ return true;
+ }
+ if (SYSTEM_TOPICS.contains(topicName)) {
+ return true;
+ }
+ for (String prefix : SYSTEM_TOPIC_PREFIXES) {
+ if (topicName.startsWith(prefix)) {
+ return true;
+ }
+ }
+ return brokerNames != null && brokerNames.contains(topicName);
+ }
+
+ /**
+ * Convenience overload without broker names.
+ */
+ public static boolean isSystem(String topicName) {
+ return isSystem(topicName, Set.of());
+ }
+}
diff --git
a/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQClientProvider.java
b/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQClientProvider.java
index 09fc4cdb..abe5f98a 100644
---
a/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQClientProvider.java
+++
b/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQClientProvider.java
@@ -34,6 +34,7 @@ import
org.apache.rocketmq.studio.common.exception.BusinessException;
import org.apache.rocketmq.studio.common.domain.enums.ClientLanguage;
import org.apache.rocketmq.studio.common.domain.enums.ClientType;
import org.apache.rocketmq.studio.common.domain.enums.Protocol;
+import org.apache.rocketmq.studio.common.util.SystemGroupFilter;
import org.apache.rocketmq.tools.admin.MQAdminExt;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@@ -333,17 +334,7 @@ public class RocketMQClientProvider implements
ClientProvider {
}
private boolean isSystemGroup(String group) {
- if (group == null) {
- return true;
- }
- return group.startsWith("CID_RMQ_SYS_")
- || group.startsWith("CID_ONSAPI_")
- || group.startsWith("TOOLS_CONSUMER")
- || group.startsWith("FILTERSRV_CONSUMER")
- || group.startsWith("CID_SYS_")
- || group.startsWith("%RETRY%")
- || group.startsWith("SELF_TEST_")
- || group.startsWith("CID_HOUSEKEEPING");
+ return SystemGroupFilter.isSystem(group);
}
private String rootMessage(Throwable error) {
diff --git
a/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQDashboardProvider.java
b/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQDashboardProvider.java
index dcb536d1..0c47e2af 100644
---
a/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQDashboardProvider.java
+++
b/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQDashboardProvider.java
@@ -39,6 +39,7 @@ import
org.apache.rocketmq.studio.ops.dashboard.ClusterOverviewVO;
import org.apache.rocketmq.studio.ops.dashboard.DashboardDataVO;
import org.apache.rocketmq.studio.ops.dashboard.DashboardProvider;
import org.apache.rocketmq.studio.ops.dashboard.DashboardStatsVO;
+import org.apache.rocketmq.studio.common.util.SystemGroupFilter;
import org.apache.rocketmq.tools.admin.MQAdminExt;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Service;
@@ -303,22 +304,10 @@ public class RocketMQDashboardProvider implements
DashboardProvider {
}
private boolean isSystemTopic(String topic) {
- for (String prefix : SYSTEM_TOPIC_PREFIXES) {
- if (topic.startsWith(prefix) || topic.equals(prefix)) {
- return true;
- }
- }
- return false;
+ return SystemTopicFilter.isSystem(topic);
}
private boolean isSystemGroup(String group) {
- return group.startsWith("CID_RMQ_SYS_")
- || group.startsWith("rmq_sys_")
- || group.equals("TOOLS_CONSUMER")
- || group.equals("FILTERSRV_CONSUMER")
- || group.equals("CID_ONSAPI_OWNER")
- || group.equals("CID_ONSAPI_PERMISSION")
- || group.equals("CID_ONSAPI_PULL")
- || group.startsWith("SELF_TEST_");
+ return SystemGroupFilter.isSystem(group);
}
}
diff --git
a/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQMetadataProvider.java
b/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQMetadataProvider.java
index 992644d4..31055ae8 100644
---
a/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQMetadataProvider.java
+++
b/server/src/main/java/org/apache/rocketmq/studio/provider/apache/RocketMQMetadataProvider.java
@@ -33,6 +33,7 @@ import
org.apache.rocketmq.studio.common.exception.BusinessException;
import org.apache.rocketmq.tools.admin.MQAdminExt;
import org.apache.rocketmq.studio.common.domain.enums.ConsumeType;
import org.apache.rocketmq.studio.common.domain.enums.TopicPerm;
+import org.apache.rocketmq.studio.common.util.SystemGroupFilter;
import org.apache.rocketmq.studio.common.domain.enums.TopicType;
import org.apache.rocketmq.studio.instance.group.ConsumerGroupVO;
import org.apache.rocketmq.studio.instance.group.QueueProgressVO;
@@ -334,15 +335,7 @@ public class RocketMQMetadataProvider implements
MetadataProvider {
}
private boolean isSystemConsumerGroup(String group) {
- if (group == null || group.isEmpty()) {
- return true;
- }
- return group.startsWith("%RETRY%")
- || group.startsWith("%DLQ%")
- || group.startsWith("CID_RMQ_SYS_")
- || group.startsWith("CID_ONS_")
- || group.startsWith("TOOLS_CONSUMER")
- || group.startsWith("FILTERSRV_CONSUMER");
+ return SystemGroupFilter.isSystem(group);
}
@Override
@@ -476,16 +469,7 @@ public class RocketMQMetadataProvider implements
MetadataProvider {
}
private boolean isSystemTopic(String topicName, Set<String> brokerNames) {
- if (SYSTEM_TOPICS.contains(topicName)) {
- return true;
- }
- for (String prefix : SYSTEM_TOPIC_PREFIXES) {
- if (topicName.startsWith(prefix)) {
- return true;
- }
- }
- // Skip topics that match broker names
- return brokerNames.contains(topicName);
+ return SystemTopicFilter.isSystem(topicName, brokerNames);
}
private TopicPerm mapPerm(int perm) {
