Switched topic index to lucene prefixed by default

Author: germanosin

api/src/main/java/io/kafbat/ui/config/ClustersProperties.java

@@ -221,8 +221,7 @@ public static class CacheProperties {
   @Data
   @NoArgsConstructor
   @AllArgsConstructor
-  public static class FtsProperties {
-    boolean ngram = true;
+  public static class NgramProperties {
     int ngramMin = 1;
     int ngramMax = 4;
   }
@@ -232,11 +231,10 @@ public static class FtsProperties {
   @AllArgsConstructor
   public static class ClusterFtsProperties {
     boolean enabled = false;
-    FtsProperties topics = new FtsProperties(false, 3, 5);
-    FtsProperties schemas = new FtsProperties(true, 1, 4);
-    FtsProperties consumers = new FtsProperties(true, 1, 4);
-    FtsProperties connect = new FtsProperties(true, 1, 4);
-    FtsProperties acl = new FtsProperties(true, 1, 4);
+    NgramProperties schemas = new NgramProperties(1, 4);
+    NgramProperties consumers = new NgramProperties(1, 4);
+    NgramProperties connect = new NgramProperties(1, 4);
+    NgramProperties acl = new NgramProperties(1, 4);
   }
 
   @PostConstruct

api/src/main/java/io/kafbat/ui/service/index/AclBindingNgramFilter.java

@@ -11,13 +11,13 @@ public class AclBindingNgramFilter extends NgramFilter<AclBinding> {
   private final List<Tuple2<List<String>, AclBinding>> bindings;
 
   public AclBindingNgramFilter(Collection<AclBinding> bindings) {
-    this(bindings, true, new ClustersProperties.FtsProperties(true, 1, 4));
+    this(bindings, true, new ClustersProperties.NgramProperties(1, 4));
   }
 
   public AclBindingNgramFilter(
       Collection<AclBinding> bindings,
       boolean enabled,
-      ClustersProperties.FtsProperties properties) {
+      ClustersProperties.NgramProperties properties) {
     super(properties, enabled);
     this.bindings = bindings.stream().map(g -> Tuples.of(List.of(g.entry().principal()), g)).toList();
   }

api/src/main/java/io/kafbat/ui/service/index/ConsumerGroupFilter.java

@@ -11,13 +11,13 @@ public class ConsumerGroupFilter extends NgramFilter<ConsumerGroupListing> {
   private final List<Tuple2<List<String>, ConsumerGroupListing>> groups;
 
   public ConsumerGroupFilter(Collection<ConsumerGroupListing> groups) {
-    this(groups, true, new ClustersProperties.FtsProperties(true, 1, 4));
+    this(groups, true, new ClustersProperties.NgramProperties(1, 4));
   }
 
   public ConsumerGroupFilter(
       Collection<ConsumerGroupListing> groups,
       boolean enabled,
-      ClustersProperties.FtsProperties properties) {
+      ClustersProperties.NgramProperties properties) {
     super(properties, enabled);
     this.groups = groups.stream().map(g -> Tuples.of(List.of(g.groupId()), g)).toList();
   }

api/src/main/java/io/kafbat/ui/service/index/KafkaConnectNgramFilter.java

@@ -11,13 +11,13 @@ public class KafkaConnectNgramFilter extends NgramFilter<FullConnectorInfoDTO> {
   private final List<Tuple2<List<String>, FullConnectorInfoDTO>> connectors;
 
   public KafkaConnectNgramFilter(Collection<FullConnectorInfoDTO> connectors) {
-    this(connectors, true, new ClustersProperties.FtsProperties(true, 1, 4));
+    this(connectors, true, new ClustersProperties.NgramProperties(1, 4));
   }
 
   public KafkaConnectNgramFilter(
       Collection<FullConnectorInfoDTO> connectors,
       boolean enabled,
-      ClustersProperties.FtsProperties properties) {
+      ClustersProperties.NgramProperties properties) {
     super(properties, enabled);
     this.connectors = connectors.stream().map(this::getItem).toList();
   }

api/src/main/java/io/kafbat/ui/service/index/LuceneTopicsIndex.java

@@ -24,6 +24,7 @@
 import org.apache.lucene.index.IndexWriter;
 import org.apache.lucene.index.IndexWriterConfig;
 import org.apache.lucene.index.Term;
+import org.apache.lucene.queryparser.classic.ParseException;
 import org.apache.lucene.queryparser.classic.QueryParser;
 import org.apache.lucene.search.BooleanClause;
 import org.apache.lucene.search.BooleanQuery;
@@ -46,26 +47,10 @@ public class LuceneTopicsIndex implements TopicsIndex {
   private final Analyzer analyzer;
   private final int maxSize;
   private final ReadWriteLock closeLock = new ReentrantReadWriteLock();
-  private final boolean searchNgram;
   private final Map<String, InternalTopic> topicMap;
 
   public LuceneTopicsIndex(List<InternalTopic> topics) throws IOException {
-    this(topics, new ClustersProperties.FtsProperties(true, 1, 4));
-  }
-
-  public LuceneTopicsIndex(List<InternalTopic> topics, ClustersProperties.FtsProperties properties) throws IOException {
-    boolean ngram = properties.isNgram();
-    if (ngram) {
-      this.analyzer = new ShortWordNGramAnalyzer(
-          properties.getNgramMin(),
-          properties.getNgramMax(),
-          false
-      );
-    } else {
-      this.analyzer = new ShortWordAnalyzer();
-    }
-
-    this.searchNgram = ngram;
+    this.analyzer = new ShortWordAnalyzer();
     this.topicMap = topics.stream().collect(Collectors.toMap(InternalTopic::getName, Function.identity()));
     this.directory = build(topics);
     this.indexReader = DirectoryReader.open(directory);
@@ -124,24 +109,10 @@ public List<InternalTopic> find(String search, Boolean showInternal,
     }
     closeLock.readLock().lock();
     try {
-      Query nameQuery;
-      if (this.searchNgram) {
-        List<String> ngrams = NgramFilter.tokenizeStringSimple(this.analyzer, search);
-        BooleanQuery.Builder builder = new BooleanQuery.Builder();
-        for (String ng : ngrams) {
-          builder.add(new TermQuery(new Term(FIELD_NAME, ng)), BooleanClause.Occur.MUST);
-        }
-        nameQuery = builder.build();
-      } else {
-        QueryParser queryParser = new PrefixQueryParser(FIELD_NAME, this.analyzer);
-        queryParser.setDefaultOperator(QueryParser.Operator.AND);
 
-        try {
-          nameQuery = queryParser.parse(search);
-        } catch (Exception e) {
-          throw new RuntimeException(e);
-        }
-      }
+      QueryParser queryParser = new PrefixQueryParser(FIELD_NAME, this.analyzer);
+      queryParser.setDefaultOperator(QueryParser.Operator.AND);
+      Query nameQuery = queryParser.parse(search);;
 
       Query internalFilter = new TermQuery(new Term(FIELD_INTERNAL, "true"));
 
@@ -172,6 +143,8 @@ public List<InternalTopic> find(String search, Boolean showInternal,
       return topics.stream().map(topicMap::get).filter(Objects::nonNull).toList();
     } catch (IOException e) {
       throw new UncheckedIOException(e);
+    } catch (ParseException e) {
+      throw new RuntimeException(e);
     } finally {
       this.closeLock.readLock().unlock();
     }

api/src/main/java/io/kafbat/ui/service/index/NgramFilter.java

@@ -22,7 +22,7 @@ public abstract class NgramFilter<T> {
   private final Analyzer analyzer;
   private final boolean enabled;
 
-  public NgramFilter(ClustersProperties.FtsProperties properties, boolean enabled) {
+  public NgramFilter(ClustersProperties.NgramProperties properties, boolean enabled) {
     this.enabled = enabled;
     this.analyzer = new ShortWordNGramAnalyzer(properties.getNgramMin(), properties.getNgramMax(), false);
   }

api/src/main/java/io/kafbat/ui/service/index/SchemasFilter.java

@@ -1,7 +1,5 @@
 package io.kafbat.ui.service.index;
 
-import static org.apache.commons.lang3.Strings.CI;
-
 import io.kafbat.ui.config.ClustersProperties;
 import java.util.Collection;
 import java.util.List;
@@ -11,7 +9,7 @@
 public class SchemasFilter extends NgramFilter<String> {
   private final List<Tuple2<List<String>, String>> subjects;
 
-  public SchemasFilter(Collection<String> subjects, boolean enabled, ClustersProperties.FtsProperties properties) {
+  public SchemasFilter(Collection<String> subjects, boolean enabled, ClustersProperties.NgramProperties properties) {
     super(properties, enabled);
     this.subjects = subjects.stream().map(g -> Tuples.of(List.of(g), g)).toList();
   }

api/src/main/java/io/kafbat/ui/service/metrics/scrape/ScrapedClusterState.java

@@ -110,11 +110,10 @@ public ScrapedClusterState updateTopics(Map<String, TopicDescription> descriptio
       );
     });
 
-    ScrapedClusterState state = toBuilder()
+    return toBuilder()
         .topicStates(updatedTopicStates)
         .topicIndex(buildTopicIndex(clustersProperties, updatedTopicStates))
         .build();
-    return state;
   }
 
   public ScrapedClusterState topicDeleted(String topic) {
@@ -219,14 +218,12 @@ private static TopicsIndex buildTopicIndex(ClustersProperties clustersProperties
 
     if (fts.isEnabled()) {
       try {
-        return new LuceneTopicsIndex(topics, fts.getTopics());
+        return new LuceneTopicsIndex(topics);
       } catch (Exception e) {
-        log.error("Error creating topics index", e);
+        log.error("Error creating lucene topics index", e);
       }
-    } else {
-      return new FilterTopicIndex(topics);
     }
-    return null;
+    return new FilterTopicIndex(topics);
   }
 
   private static <T> Map<Integer, T> filterTopic(String topicForFilter, Map<TopicPartition, T> tpMap) {

api/src/test/java/io/kafbat/ui/service/index/LuceneTopicsIndexTest.java

@@ -65,7 +65,11 @@ void testFindTopicsByName() throws Exception {
         Map.entry("stat", 3),
         Map.entry("changes", 1),
         Map.entry("commands", 1),
-        Map.entry("id", 2)
+        Map.entry("id", 2),
+        Map.entry("config_retention:compact", 1),
+        Map.entry("partitions:10", 1),
+        Map.entry("partitions:{1 TO *]", 1),
+        Map.entry("partitions:{* TO 9]", topics.size() - 1)
     );
 
     SoftAssertions softly = new SoftAssertions();
@@ -77,22 +81,6 @@ void testFindTopicsByName() throws Exception {
             .isEqualTo(entry.getValue());
       }
     }
-
-    HashMap<String, Integer> indexExamples = new HashMap<>(examples);
-    indexExamples.put("config_retention:compact", 1);
-    indexExamples.put("partitions:10", 1);
-    indexExamples.put("partitions:{1 TO *]", 1);
-    indexExamples.put("partitions:{* TO 9]", topics.size() - 1);
-
-    try (LuceneTopicsIndex index = new LuceneTopicsIndex(topics,
-        new ClustersProperties.FtsProperties(false, 1, 4))) {
-      for (Map.Entry<String, Integer> entry : indexExamples.entrySet()) {
-        List<InternalTopic> resultAll = index.find(entry.getKey(), null, topics.size());
-        softly.assertThat(resultAll.size())
-            .withFailMessage("Expected %d results for '%s', but got %s", entry.getValue(), entry.getKey(), resultAll)
-            .isEqualTo(entry.getValue());
-      }
-    }
     softly.assertAll();
   }