Add printable discription for push down Automata

Author: julian-elastic

server/src/main/java/org/elasticsearch/index/query/AutomatonQueryBuilder.java

@@ -29,8 +29,10 @@
 public class AutomatonQueryBuilder extends AbstractQueryBuilder<AutomatonQueryBuilder> implements MultiTermQueryBuilder {
     private final String fieldName;
     private final Automaton automaton;
+    private final String description;
 
-    public AutomatonQueryBuilder(String fieldName, Automaton automaton) {
+    public AutomatonQueryBuilder(String fieldName, Automaton automaton, String description) {
+        this.description = description;
         if (Strings.isEmpty(fieldName)) {
             throw new IllegalArgumentException("field name is null or empty");
         }
@@ -63,7 +65,7 @@ protected void doXContent(XContentBuilder builder, Params params) throws IOExcep
 
     @Override
     protected Query doToQuery(SearchExecutionContext context) throws IOException {
-        return new AutomatonQuery(new Term(fieldName), automaton);
+        return new AutomatonQueryWithDescription(new Term(fieldName), automaton, description);
     }
 
     @Override
@@ -80,4 +82,21 @@ protected boolean doEquals(AutomatonQueryBuilder other) {
     public TransportVersion getMinimalSupportedVersion() {
         throw new UnsupportedOperationException("AutomatonQueryBuilder does not support getMinimalSupportedVersion");
     }
+
+    static class AutomatonQueryWithDescription extends AutomatonQuery {
+        private final String description;
+
+        AutomatonQueryWithDescription(Term term, Automaton automaton, String description) {
+            super(term, automaton);
+            this.description = description;
+        }
+
+        @Override
+        public String toString(String field) {
+            if(description.isEmpty()) {
+                return super.toString(field);
+            }
+            return description;
+        }
+    }
 }

x-pack/plugin/esql-core/src/main/java/org/elasticsearch/xpack/esql/core/querydsl/query/AutomatonQuery.java

@@ -20,11 +20,13 @@ public class AutomatonQuery extends Query {
 
     private final String field;
     private final Automaton automaton;
+    private final String automatonDescription;
 
-    public AutomatonQuery(Source source, String field, Automaton automaton) {
+    public AutomatonQuery(Source source, String field, Automaton automaton, String automatonDescription) {
         super(source);
         this.field = field;
         this.automaton = automaton;
+        this.automatonDescription = automatonDescription;
     }
 
     public String field() {
@@ -33,7 +35,7 @@ public String field() {
 
     @Override
     protected QueryBuilder asBuilder() {
-        return new AutomatonQueryBuilder(field, automaton);
+        return new AutomatonQueryBuilder(field, automaton, automatonDescription);
     }
 
     @Override

x-pack/plugin/esql/qa/server/single-node/src/javaRestTest/java/org/elasticsearch/xpack/esql/qa/single_node/PushQueriesIT.java

@@ -266,7 +266,7 @@ public void testLikeList() throws IOException {
         String luceneQuery = switch (type) {
             case CONSTANT_KEYWORD, MATCH_ONLY_TEXT_WITH_KEYWORD, AUTO, TEXT_WITH_KEYWORD -> "*:*";
             case SEMANTIC_TEXT_WITH_KEYWORD -> "FieldExistsQuery [field=_primary_term]";
-            case KEYWORD -> "test:AutomatonQuery";
+            case KEYWORD -> "Automaton for test LIKE (\"%value*\", \"abc*\"), caseInsensitive=false";
         };
         ComputeSignature dataNodeSignature = switch (type) {
             case CONSTANT_KEYWORD, KEYWORD -> ComputeSignature.FILTER_IN_QUERY;
@@ -325,17 +325,12 @@ private void testPushQuery(
             equalTo(found ? List.of(List.of(value)) : List.of())
         );
 
-        Matcher<String> luceneQueryMatcher;
-        if (luceneQueryOptions.size() == 1 && luceneQueryOptions.get(0).equals("test:AutomatonQuery")) {
-            luceneQueryMatcher = anyOf(startsWith("test:AutomatonQuery"));
-        } else {
-            luceneQueryMatcher = anyOf(
-                () -> Iterators.map(
-                    luceneQueryOptions.iterator(),
-                    (String s) -> equalTo(s.replaceAll("%value", value).replaceAll("%different_value", differentValue))
-                )
-            );
-        }
+        Matcher<String> luceneQueryMatcher = anyOf(
+            () -> Iterators.map(
+                luceneQueryOptions.iterator(),
+                (String s) -> equalTo(s.replaceAll("%value", value).replaceAll("%different_value", differentValue))
+            )
+        );
 
         @SuppressWarnings("unchecked")
         List<Map<String, Object>> profiles = (List<Map<String, Object>>) ((Map<String, Object>) result.get("profile")).get("drivers");

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/regex/WildcardLikeList.java

@@ -12,6 +12,7 @@
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.xpack.esql.core.expression.Expression;
 import org.elasticsearch.xpack.esql.core.expression.FieldAttribute;
+import org.elasticsearch.xpack.esql.core.expression.predicate.regex.WildcardPattern;
 import org.elasticsearch.xpack.esql.core.expression.predicate.regex.WildcardPatternList;
 import org.elasticsearch.xpack.esql.core.querydsl.query.AutomatonQuery;
 import org.elasticsearch.xpack.esql.core.querydsl.query.Query;
@@ -24,6 +25,7 @@
 import org.elasticsearch.xpack.esql.planner.TranslatorHandler;
 
 import java.io.IOException;
+import java.util.stream.Collectors;
 
 public class WildcardLikeList extends RegexMatch<WildcardPatternList> {
     public static final NamedWriteableRegistry.Entry ENTRY = new NamedWriteableRegistry.Entry(
@@ -110,6 +112,17 @@ public Query asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHand
      * Throws an {@link IllegalArgumentException} if the pattern list contains more than one pattern.
      */
     private Query translateField(String targetFieldName) {
-        return new AutomatonQuery(source(), targetFieldName, pattern().createAutomaton(caseInsensitive()));
+        return new AutomatonQuery(
+            source(),
+            targetFieldName,
+            pattern().createAutomaton(caseInsensitive()),
+            getAutomatonDescription(targetFieldName)
+        );
+    }
+
+    private String getAutomatonDescription(String targetFieldName) {
+        // we use all the information used the create the automaton to describe the query here
+        String patternDesc = pattern().patternList().stream().map(WildcardPattern::pattern).collect(Collectors.joining("\", \""));
+        return "Automaton for " + targetFieldName + " LIKE (\"" + patternDesc + "\"), caseInsensitive=" + caseInsensitive();
     }
 }