Remove use of deprecated field highlight parameter (#719)

Yelp · Sep 17, 2024 · ab103d0 · ab103d0
1 parent 65509c9
commit ab103d0
Show file tree

Hide file tree

Showing 8 changed files with 4 additions and 104 deletions.
diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/Constants.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/Constants.java
diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/AtomFieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/AtomFieldDef.java
@@ -37,14 +37,6 @@ public AtomFieldDef(String name, Field requestField) {
 
   @Override
   protected void validateRequest(Field requestField) {
-    if (requestField.getHighlight() && !requestField.getSearch()) {
-      throw new IllegalArgumentException("search must be true when highlight is true");
-    }
-
-    if (requestField.getHighlight() && !requestField.getStore()) {
-      throw new IllegalArgumentException("store must be true when highlight is true");
-    }
-
     if (hasAnalyzer(requestField)) {
       throw new IllegalArgumentException(
           "no analyzer allowed with atom (it's hardwired to KeywordAnalyzer internally)");

diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/BooleanFieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/BooleanFieldDef.java
@@ -45,13 +45,6 @@ protected BooleanFieldDef(String name, Field requestField) {
   protected void validateRequest(Field requestField) {
     super.validateRequest(requestField);
 
-    if (requestField.getHighlight()) {
-      throw new IllegalArgumentException(
-          String.format(
-              "Field: %s cannot have highlight=true. only type=text or type=atom fields can have highlight=true",
-              getName()));
-    }
-
     if (hasAnalyzer(requestField) && !requestField.getSearch()) {
       throw new IllegalArgumentException("No analyzer allowed when search=false");
     }

diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/DateTimeFieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/DateTimeFieldDef.java
@@ -153,13 +153,6 @@ private void ensureUpperIsMoreThanLower(RangeQuery rangeQuery, long lower, long
   protected void validateRequest(Field requestField) {
     super.validateRequest(requestField);
 
-    if (requestField.getHighlight()) {
-      throw new IllegalArgumentException(
-          String.format(
-              "field: %s cannot have highlight=true. only type=text or type=atom fields can have highlight=true",
-              getName()));
-    }
-
     if (hasAnalyzer(requestField)) {
       throw new IllegalArgumentException("no analyzer allowed on datetime field");
     }

diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/LatLonFieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/LatLonFieldDef.java
@@ -54,13 +54,6 @@ public LatLonFieldDef(String name, Field requestField) {
   protected void validateRequest(Field requestField) {
     super.validateRequest(requestField);
 
-    if (requestField.getHighlight()) {
-      throw new IllegalArgumentException(
-          String.format(
-              "field: %s cannot have highlight=true. only type=text or type=atom fields can have highlight=true",
-              getName()));
-    }
-
     if (requestField.getStore()) {
       throw new IllegalArgumentException("latlon fields cannot be stored");
     }

diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/NumberFieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/NumberFieldDef.java
@@ -77,13 +77,6 @@ protected NumberFieldDef(String name, Field requestField, Function<String, Numbe
   protected void validateRequest(Field requestField) {
     super.validateRequest(requestField);
 
-    if (requestField.getHighlight()) {
-      throw new IllegalArgumentException(
-          String.format(
-              "field: %s cannot have highlight=true. only type=text or type=atom fields can have highlight=true",
-              getName()));
-    }
-
     if (hasAnalyzer(requestField)) {
       throw new IllegalArgumentException("no analyzer allowed on Number fields");
     }

diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/PolygonfieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/PolygonfieldDef.java
@@ -48,13 +48,6 @@ protected PolygonfieldDef(String name, Field requestField) {
   protected void validateRequest(Field requestField) {
     super.validateRequest(requestField);
 
-    if (requestField.getHighlight()) {
-      throw new IllegalArgumentException(
-          String.format(
-              "field: %s cannot have highlight=true. only type=text or type=atom fields can have highlight=true",
-              getName()));
-    }
-
     if (hasAnalyzer(requestField)) {
       throw new IllegalArgumentException("no analyzer allowed on polygon field");
     }

diff --git a/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/TextBaseFieldDef.java b/src/main/java/com/yelp/nrtsearch/server/luceneserver/field/TextBaseFieldDef.java
@@ -17,7 +17,6 @@
 
 import com.yelp.nrtsearch.server.grpc.*;
 import com.yelp.nrtsearch.server.grpc.Field;
-import com.yelp.nrtsearch.server.luceneserver.Constants;
 import com.yelp.nrtsearch.server.luceneserver.analysis.AnalyzerCreator;
 import com.yelp.nrtsearch.server.luceneserver.analysis.PosIncGapAnalyzerWrapper;
 import com.yelp.nrtsearch.server.luceneserver.doc.DocValuesFactory;
@@ -51,13 +50,12 @@
 
 /**
  * Base class for all text base field definitions. In addition to the properties from {@link
- * IndexableFieldDef}, text fields have the option for {@link Analyzer}s and highlighting.
+ * IndexableFieldDef}, text fields have the option for {@link Analyzer}s.
  */
 public abstract class TextBaseFieldDef extends IndexableFieldDef
     implements TermQueryable, GlobalOrdinalable {
   static final int DEFAULT_POSITION_INCREMENT_GAP = 100;
 
-  private final boolean isHighlighted;
   private final Analyzer indexAnalyzer;
   private final Analyzer searchAnalyzer;
   private final boolean eagerFieldGlobalOrdinals;
@@ -67,16 +65,14 @@ public abstract class TextBaseFieldDef extends IndexableFieldDef
 
   /**
    * Field constructor. Uses {@link IndexableFieldDef#IndexableFieldDef(String, Field)} to do common
-   * initialization, then sets up highlighting and analyzers. Analyzers are parsed through calls to
-   * the protected methods {@link #parseIndexAnalyzer(Field)} and {@link
-   * #parseSearchAnalyzer(Field)}.
+   * initialization, then sets up analyzers. Analyzers are parsed through calls to the protected
+   * methods {@link #parseIndexAnalyzer(Field)} and {@link #parseSearchAnalyzer(Field)}.
    *
    * @param name field name
    * @param requestField field definition from grpc request
    */
   protected TextBaseFieldDef(String name, Field requestField) {
     super(name, requestField);
-    isHighlighted = requestField.getHighlight();
     indexAnalyzer = parseIndexAnalyzer(requestField);
     searchAnalyzer = parseSearchAnalyzer(requestField);
     eagerFieldGlobalOrdinals = requestField.getEagerFieldGlobalOrdinals();
@@ -119,9 +115,6 @@ protected DocValuesType parseDocValuesType(Field requestField) {
   protected FacetValueType parseFacetValueType(Field requestField) {
     FacetType facetType = requestField.getFacet();
     if (facetType.equals(FacetType.HIERARCHY)) {
-      if (requestField.getHighlight()) {
-        throw new IllegalArgumentException("facet=hierarchy fields cannot have highlight=true");
-      }
       if (requestField.getSearch()) {
         throw new IllegalArgumentException("facet=hierarchy fields cannot have search=true");
       }
@@ -239,16 +232,6 @@ public void parseDocumentField(
 
     for (int i = 0; i < fieldValues.size(); i++) {
       String fieldStr = fieldValues.get(i);
-      if (isHighlighted && isMultiValue() && fieldStr.indexOf(Constants.INFORMATION_SEP) != -1) {
-        // TODO: we could remove this restriction if it
-        // ever matters ... we can highlight multi-valued
-        // fields at search time without stealing a
-        // character:
-        throw new IllegalArgumentException(
-            String.format(
-                "%s multiValued and highlighted fields cannot contain INFORMATION_SEPARATOR (U+001F) character: this character is used internally when highlighting multi-valued fields",
-                getName()));
-      }
       if (hasDocValues()) {
         BytesRef stringBytes = new BytesRef(fieldStr);
         if (docValuesType == DocValuesType.BINARY) {
@@ -280,7 +263,7 @@ private void addFacet(Document document, String value, List<String> paths) {
       if (paths.isEmpty()) {
         document.add(new FacetField(getName(), value));
       } else {
-        document.add(new FacetField(getName(), paths.toArray(new String[paths.size()])));
+        document.add(new FacetField(getName(), paths.toArray(new String[0])));
       }
     } else if (facetValueType == FacetValueType.FLAT) {
       document.add(new FacetField(getName(), value));
@@ -290,15 +273,6 @@ private void addFacet(Document document, String value, List<String> paths) {
     }
   }
 
-  /**
-   * Get if this field is highlighted.
-   *
-   * @return if this field is highlighted
-   */
-  public boolean isHighlighted() {
-    return isHighlighted;
-  }
-
   @Override
   public Query getTermQueryFromTextValue(String textValue) {
     return new org.apache.lucene.search.TermQuery(new Term(getName(), textValue));