You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "fvaleri (via GitHub)" <gi...@apache.org> on 2023/02/02 10:05:39 UTC

[GitHub] [kafka] fvaleri commented on a diff in pull request #13158: KAFKA-14647: Moving TopicFilter to server-common/utils

fvaleri commented on code in PR #13158:
URL: https://github.com/apache/kafka/pull/13158#discussion_r1094209610


##########
checkstyle/import-control.xml:
##########
@@ -351,6 +351,7 @@
 
     <!-- This is required to make AlterConfigPolicyTest work. -->
     <allow pkg="org.apache.kafka.server.policy" />
+    <allow pkg="org.apache.kafka.server.util" />

Review Comment:
   Is this related to the above comment? If not please move it above right after joptsimple.



##########
server-common/src/main/java/org/apache/kafka/server/util/TopicPartitionFilter.java:
##########
@@ -0,0 +1,71 @@
+/*
+ * 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.kafka.server.util;
+
+import org.apache.kafka.common.TopicPartition;
+import org.apache.kafka.server.util.TopicFilter.IncludeList;
+
+import java.util.List;
+
+public interface TopicPartitionFilter {
+    /**
+     * Used to filter topics based on a certain criteria, for example, a set of topic names or a regular expression.
+     */
+    boolean isTopicAllowed(String topic);
+    /**
+     * Used to filter topic-partitions based on a certain criteria, for example, a topic pattern and a set of partition ids.
+     */
+    boolean isTopicPartitionAllowed(TopicPartition partition);
+
+    class TopicFilterAndPartitionFilter implements TopicPartitionFilter {
+        private final IncludeList topicFilter;
+        private final PartitionFilter partitionFilter;
+        public TopicFilterAndPartitionFilter(IncludeList topicFilter, PartitionFilter partitionFilter) {
+            this.topicFilter = topicFilter;
+            this.partitionFilter = partitionFilter;
+        }
+
+        @Override
+        public boolean isTopicAllowed(String topic) {
+            return topicFilter.isTopicAllowed(topic, false);
+        }
+
+        @Override
+        public boolean isTopicPartitionAllowed(TopicPartition partition) {
+            return isTopicAllowed(partition.topic()) && partitionFilter.isPartitionAllowed(partition.partition());
+        }
+    }
+
+    class CompositeTopicPartitionFilter implements TopicPartitionFilter {
+        private final List<TopicPartitionFilter> filters;
+
+        public CompositeTopicPartitionFilter(List<TopicPartitionFilter> filters) {
+            this.filters = filters;
+        }
+
+        @Override
+        public boolean isTopicAllowed(String topic) {
+            return filters.stream().anyMatch(tp -> tp.isTopicAllowed(topic));
+        }
+
+        @Override
+        public boolean isTopicPartitionAllowed(TopicPartition partition) {
+            return filters.stream().anyMatch(tp -> tp.isTopicPartitionAllowed(partition));
+        }
+    }
+

Review Comment:
   Remove empty line.



##########
server-common/src/test/java/org/apache/kafka/server/util/TopicFilterTest.java:
##########
@@ -0,0 +1,52 @@
+/*
+ * 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.kafka.server.util;
+
+import org.apache.kafka.common.internals.Topic;
+import org.apache.kafka.server.util.TopicFilter.IncludeList;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+
+public class TopicFilterTest {
+    @Test
+    public void testIncludeLists() {
+        IncludeList topicFilter1 = new TopicFilter.IncludeList("yes1,yes2");
+        assertTrue(topicFilter1.isTopicAllowed("yes2", true));
+        assertTrue(topicFilter1.isTopicAllowed("yes2", false));
+        assertFalse(topicFilter1.isTopicAllowed("no1", true));
+        assertFalse(topicFilter1.isTopicAllowed("no1", false));
+
+        IncludeList topicFilter2 = new IncludeList(".+");
+        assertTrue(topicFilter2.isTopicAllowed("alltopics", true));
+        assertFalse(topicFilter2.isTopicAllowed(Topic.GROUP_METADATA_TOPIC_NAME, true));
+        assertTrue(topicFilter2.isTopicAllowed(Topic.GROUP_METADATA_TOPIC_NAME, false));
+
+        assertFalse(topicFilter2.isTopicAllowed(Topic.TRANSACTION_STATE_TOPIC_NAME, true));
+        assertTrue(topicFilter2.isTopicAllowed(Topic.TRANSACTION_STATE_TOPIC_NAME, false));
+
+        IncludeList topicFilter3 = new IncludeList("included-topic.+");
+        assertTrue(topicFilter3.isTopicAllowed("included-topic1", true));
+        assertFalse(topicFilter3.isTopicAllowed("no1", true));
+
+        IncludeList topicFilter4 = new IncludeList("test-(?!bad\\b)[\\w]+");
+        assertTrue(topicFilter4.isTopicAllowed("test-good", true));
+        assertFalse(topicFilter4.isTopicAllowed("test-bad", true));
+    }
+    

Review Comment:
   Remove empty line.



##########
server-common/src/main/java/org/apache/kafka/server/util/TopicPartitionFilter.java:
##########
@@ -0,0 +1,71 @@
+/*
+ * 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.kafka.server.util;
+
+import org.apache.kafka.common.TopicPartition;
+import org.apache.kafka.server.util.TopicFilter.IncludeList;
+
+import java.util.List;
+
+public interface TopicPartitionFilter {
+    /**
+     * Used to filter topics based on a certain criteria, for example, a set of topic names or a regular expression.
+     */
+    boolean isTopicAllowed(String topic);

Review Comment:
   Add an empty line here.



-- 
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: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org