add subquery serialization tests and add comments to each subquery test in PushDownAndCombineFiltersTests to include the plan strings

Author: fang-xing-esql

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/optimizer/rules/logical/PushDownAndCombineFiltersTests.java

@@ -1014,6 +1014,27 @@ public void testPushDownLookupJoinExpressionMultipleWhere() {
         assertEquals(expectedPushedFilters, actualPushedFilters);
     }
 
+    /**
+     * Limit[1000[INTEGER],false]
+     * \_UnionAll[[_meta_field{r}#44, emp_no{r}#45, first_name{r}#46, gender{r}#47, hire_date{r}#48, job{r}#49, job.raw{r}#50, l
+     * anguages{r}#51, last_name{r}#52, long_noidx{r}#53, salary{r}#54, language_code{r}#55, language_name{r}#56]]
+     *   |_EsqlProject[[_meta_field{f}#11, emp_no{f}#5, first_name{f}#6, gender{f}#7, hire_date{f}#12, job{f}#13, job.raw{f}#14, lang
+     * uages{f}#8, last_name{f}#9, long_noidx{f}#15, salary{f}#10, language_code{r}#29, language_name{r}#30]]
+     *   | \_Eval[[null[INTEGER] AS language_code#29, null[KEYWORD] AS language_name#30]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Filter[emp_no{f}#5 > 10000[INTEGER]]
+     *   |       \_EsRelation[test][_meta_field{f}#11, emp_no{f}#5, first_name{f}#6, ge..]
+     *   |_EsqlProject[[_meta_field{f}#22, emp_no{f}#16, first_name{f}#17, gender{f}#18, hire_date{f}#23, job{f}#24, job.raw{f}#25, l
+     * anguages{f}#19, last_name{f}#20, long_noidx{f}#26, salary{f}#21, language_code{r}#31, language_name{r}#32]]
+     *   | \_Eval[[null[INTEGER] AS language_code#31, null[KEYWORD] AS language_name#32]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Subquery[]
+     *   |       \_Filter[languages{f}#19 > 0[INTEGER] AND emp_no{f}#16 > 10000[INTEGER]]
+     *   |         \_EsRelation[test1][_meta_field{f}#22, emp_no{f}#16, first_name{f}#17, ..]
+     *   \_LocalRelation[[_meta_field{r}#33, emp_no{r}#34, first_name{r}#35, gender{r}#36, hire_date{r}#37, job{r}#38, job.raw{r}#39, l
+     * anguages{r}#40, last_name{r}#41, long_noidx{r}#42, salary{r}#43, language_code{f}#27, language_name{f}#28],EMPT
+     * Y]
+     */
     public void testPushDownSimpleFilterPastUnionAll() {
         assumeTrue("Requires subquery in FROM command support", EsqlCapabilities.Cap.SUBQUERY_IN_FROM_COMMAND.isEnabled());
         var plan = planSubquery("""
@@ -1059,6 +1080,27 @@ public void testPushDownSimpleFilterPastUnionAll() {
         LocalRelation localRelation = as(unionAll.children().get(2), LocalRelation.class);
     }
 
+    /**
+     * Limit[1000[INTEGER],false]
+     * \_UnionAll[[_meta_field{r}#45, emp_no{r}#46, first_name{r}#47, gender{r}#48, hire_date{r}#49, job{r}#50, job.raw{r}#51, l
+     * anguages{r}#52, last_name{r}#53, long_noidx{r}#54, salary{r}#55, language_code{r}#56, language_name{r}#57]]
+     *   |_EsqlProject[[_meta_field{f}#12, emp_no{f}#6, first_name{f}#7, gender{f}#8, hire_date{f}#13, job{f}#14, job.raw{f}#15, lang
+     * uages{f}#9, last_name{f}#10, long_noidx{f}#16, salary{f}#11, language_code{r}#30, language_name{r}#31]]
+     *   | \_Eval[[null[INTEGER] AS language_code#30, null[KEYWORD] AS language_name#31]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Filter[emp_no{f}#6 > 10000[INTEGER] AND salary{f}#11 > 50000[INTEGER]]
+     *   |       \_EsRelation[test][_meta_field{f}#12, emp_no{f}#6, first_name{f}#7, ge..]
+     *   |_EsqlProject[[_meta_field{f}#23, emp_no{f}#17, first_name{f}#18, gender{f}#19, hire_date{f}#24, job{f}#25, job.raw{f}#26, l
+     * anguages{f}#20, last_name{f}#21, long_noidx{f}#27, salary{f}#22, language_code{r}#32, language_name{r}#33]]
+     *   | \_Eval[[null[INTEGER] AS language_code#32, null[KEYWORD] AS language_name#33]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Subquery[]
+     *   |       \_Filter[languages{f}#20 > 0[INTEGER] AND emp_no{f}#17 > 10000[INTEGER] AND salary{f}#22 > 50000[INTEGER]]
+     *   |         \_EsRelation[test1][_meta_field{f}#23, emp_no{f}#17, first_name{f}#18, ..]
+     *   \_LocalRelation[[_meta_field{r}#34, emp_no{r}#35, first_name{r}#36, gender{r}#37, hire_date{r}#38, job{r}#39, job.raw{r}#40, l
+     * anguages{r}#41, last_name{r}#42, long_noidx{r}#43, salary{r}#44, language_code{f}#28, language_name{f}#29],EMPT
+     * Y]
+     */
     public void testPushDownConjunctiveFilterPastUnionAll() {
         assumeTrue("Requires subquery in FROM command support", EsqlCapabilities.Cap.SUBQUERY_IN_FROM_COMMAND.isEnabled());
         var plan = planSubquery("""
@@ -1116,6 +1158,27 @@ public void testPushDownConjunctiveFilterPastUnionAll() {
         LocalRelation localRelation = as(unionAll.children().get(2), LocalRelation.class);
     }
 
+    /**
+     * Limit[1000[INTEGER],false]
+     * \_UnionAll[[_meta_field{r}#45, emp_no{r}#46, first_name{r}#47, gender{r}#48, hire_date{r}#49, job{r}#50, job.raw{r}#51, l
+     * anguages{r}#52, last_name{r}#53, long_noidx{r}#54, salary{r}#55, language_code{r}#56, language_name{r}#57]]
+     *   |_EsqlProject[[_meta_field{f}#12, emp_no{f}#6, first_name{f}#7, gender{f}#8, hire_date{f}#13, job{f}#14, job.raw{f}#15, lang
+     * uages{f}#9, last_name{f}#10, long_noidx{f}#16, salary{f}#11, language_code{r}#30, language_name{r}#31]]
+     *   | \_Eval[[null[INTEGER] AS language_code#30, null[KEYWORD] AS language_name#31]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Filter[emp_no{f}#6 > 10000[INTEGER] OR salary{f}#11 > 50000[INTEGER]]
+     *   |       \_EsRelation[test][_meta_field{f}#12, emp_no{f}#6, first_name{f}#7, ge..]
+     *   |_EsqlProject[[_meta_field{f}#23, emp_no{f}#17, first_name{f}#18, gender{f}#19, hire_date{f}#24, job{f}#25, job.raw{f}#26, l
+     * anguages{f}#20, last_name{f}#21, long_noidx{f}#27, salary{f}#22, language_code{r}#32, language_name{r}#33]]
+     *   | \_Eval[[null[INTEGER] AS language_code#32, null[KEYWORD] AS language_name#33]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Subquery[]
+     *   |       \_Filter[languages{f}#20 > 0[INTEGER] AND emp_no{f}#17 > 10000[INTEGER] OR salary{f}#22 > 50000[INTEGER]]
+     *   |         \_EsRelation[test1][_meta_field{f}#23, emp_no{f}#17, first_name{f}#18, ..]
+     *   \_LocalRelation[[_meta_field{r}#34, emp_no{r}#35, first_name{r}#36, gender{r}#37, hire_date{r}#38, job{r}#39, job.raw{r}#40, l
+     * anguages{r}#41, last_name{r}#42, long_noidx{r}#43, salary{r}#44, language_code{f}#28, language_name{f}#29],EMPT
+     * Y]
+     */
     public void testPushDownDisjunctiveFilterPastUnionAll() {
         assumeTrue("Requires subquery in FROM command support", EsqlCapabilities.Cap.SUBQUERY_IN_FROM_COMMAND.isEnabled());
         var plan = planSubquery("""
@@ -1173,16 +1236,38 @@ public void testPushDownDisjunctiveFilterPastUnionAll() {
         LocalRelation localRelation = as(unionAll.children().get(2), LocalRelation.class);
     }
 
+    /**
+     * Limit[1000[INTEGER],false]
+     * \_UnionAll[[_meta_field{r}#45, emp_no{r}#46, first_name{r}#47, gender{r}#48, hire_date{r}#49, job{r}#50, job.raw{r}#51, l
+     * anguages{r}#52, last_name{r}#53, long_noidx{r}#54, salary{r}#55, language_code{r}#56, language_name{r}#57]]
+     *   |_EsqlProject[[_meta_field{f}#12, emp_no{f}#6, first_name{f}#7, gender{f}#8, hire_date{f}#13, job{f}#14, job.raw{f}#15, lang
+     * uages{f}#9, last_name{f}#10, long_noidx{f}#16, salary{f}#11, language_code{r}#30, language_name{r}#31]]
+     *   | \_Eval[[null[INTEGER] AS language_code#30, null[KEYWORD] AS language_name#31]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Filter[emp_no{f}#6 > 10000[INTEGER] AND salary{f}#11 < 50000[INTEGER]]
+     *   |       \_EsRelation[test][_meta_field{f}#12, emp_no{f}#6, first_name{f}#7, ge..]
+     *   |_EsqlProject[[_meta_field{f}#23, emp_no{f}#17, first_name{f}#18, gender{f}#19, hire_date{f}#24, job{f}#25, job.raw{f}#26, l
+     * anguages{f}#20, last_name{f}#21, long_noidx{f}#27, salary{f}#22, language_code{r}#32, language_name{r}#33]]
+     *   | \_Eval[[null[INTEGER] AS language_code#32, null[KEYWORD] AS language_name#33]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Subquery[]
+     *   |       \_Filter[salary{f}#22 < 50000[INTEGER] AND emp_no{f}#17 > 10000[INTEGER]]
+     *   |         \_EsRelation[test1][_meta_field{f}#23, emp_no{f}#17, first_name{f}#18, ..]
+     *   \_LocalRelation[[_meta_field{r}#34, emp_no{r}#35, first_name{r}#36, gender{r}#37, hire_date{r}#38, job{r}#39, job.raw{r}#40, l
+     * anguages{r}#41, last_name{r}#42, long_noidx{r}#43, salary{r}#44, language_code{f}#28, language_name{f}#29],EMPT
+     * Y]
+     */
     public void testPushDownFilterPastUnionAllAndCombineWithFilterInSubquery() {
         assumeTrue("Requires subquery in FROM command support", EsqlCapabilities.Cap.SUBQUERY_IN_FROM_COMMAND.isEnabled());
         var plan = planSubquery("""
             FROM test, (FROM test1 | where salary < 100000), (FROM languages  | WHERE language_code > 0)
-            | WHERE emp_no > 10000 and salary > 50000
+            | WHERE emp_no > 10000 and salary < 50000
             """);
 
         Limit limit = as(plan, Limit.class);
         UnionAll unionAll = as(limit.child(), UnionAll.class);
         assertEquals(3, unionAll.children().size());
+
         EsqlProject child1 = as(unionAll.children().get(0), EsqlProject.class);
         Eval eval = as(child1.child(), Eval.class);
         Limit childLimit = as(eval.child(), Limit.class);
@@ -1193,7 +1278,7 @@ public void testPushDownFilterPastUnionAllAndCombineWithFilterInSubquery() {
         assertEquals("emp_no", empNo.name());
         Literal right = as(emp_no.right(), Literal.class);
         assertEquals(10000, right.value());
-        GreaterThan salary = as(and.right(), GreaterThan.class);
+        LessThan salary = as(and.right(), LessThan.class);
         FieldAttribute salaryField = as(salary.left(), FieldAttribute.class);
         assertEquals("salary", salaryField.name());
         right = as(salary.right(), Literal.class);
@@ -1207,29 +1292,67 @@ public void testPushDownFilterPastUnionAllAndCombineWithFilterInSubquery() {
         Subquery subquery = as(childLimit.child(), Subquery.class);
         childFilter = as(subquery.child(), Filter.class);
         and = as(childFilter.condition(), And.class);
-        And empNoAndSalary = as(and.right(), And.class);
-        emp_no = as(empNoAndSalary.left(), GreaterThan.class);
+        emp_no = as(and.right(), GreaterThan.class);
         empNo = as(emp_no.left(), FieldAttribute.class);
         assertEquals("emp_no", empNo.name());
         right = as(emp_no.right(), Literal.class);
         assertEquals(10000, right.value());
-        salary = as(empNoAndSalary.right(), GreaterThan.class);
+        salary = as(and.left(), LessThan.class);
         salaryField = as(salary.left(), FieldAttribute.class);
         assertEquals("salary", salaryField.name());
         right = as(salary.right(), Literal.class);
         assertEquals(50000, right.value());
-        LessThan lessThan = as(and.left(), LessThan.class);
-        salaryField = as(lessThan.left(), FieldAttribute.class);
-        assertEquals("salary", salaryField.name());
-        right = as(lessThan.right(), Literal.class);
-        assertEquals(100000, right.value());
         relation = as(childFilter.child(), EsRelation.class);
         assertEquals("test1", relation.indexPattern());
 
         LocalRelation localRelation = as(unionAll.children().get(2), LocalRelation.class);
     }
 
-    public void testPushDownFilterOnReferenceAttributesPastUnionAllDebug() {
+    /**
+     * Limit[1000[INTEGER],false]
+     * \_UnionAll[[_meta_field{r}#95, emp_no{r}#96, first_name{r}#97, gender{r}#98, hire_date{r}#99, job{r}#100, job.raw{r}#101,
+     *  languages{r}#102, last_name{r}#103, long_noidx{r}#104, salary{r}#105, x{r}#106, y{r}#107, z{r}#108, language_name{r}#109]]
+     *   |_LocalRelation[[_meta_field{f}#44, emp_no{f}#38, first_name{f}#39, gender{f}#40, hire_date{f}#45, job{f}#46, job.raw{f}#47, l
+     * anguages{f}#41, last_name{f}#42, long_noidx{f}#48, salary{f}#43, x{r}#75, y{r}#110, z{r}#77, language_name{r}#78],
+     * EMPTY]
+     *   |_EsqlProject[[_meta_field{f}#55, emp_no{f}#49, first_name{f}#50, gender{f}#51, hire_date{f}#56, job{f}#57, job.raw{f}#58, l
+     * anguages{f}#52, last_name{f}#53, long_noidx{f}#59, salary{f}#54, x{r}#4, y{r}#111, z{r}#10, language_name{r}#79]]
+     *   | \_Filter[ISNOTNULL(y{r}#111)]
+     *   |   \_Eval[[null[KEYWORD] AS language_name#79, TOLONG(y{r}#7) AS y#111]]
+     *   |     \_Limit[1000[INTEGER],false]
+     *   |       \_Subquery[]
+     *   |         \_Project[[_meta_field{f}#55, emp_no{f}#49, first_name{f}#50, gender{f}#51, hire_date{f}#56, job{f}#57, job.raw{f}#58, l
+     * anguages{f}#52, last_name{f}#53, long_noidx{f}#59, salary{f}#54, x{r}#4, emp_no{f}#49 AS y#7, z{r}#10]]
+     *   |           \_Filter[z{r}#10 &gt; 0[INTEGER]]
+     *   |             \_Eval[[1[INTEGER] AS x#4, emp_no{f}#49 + 1[INTEGER] AS z#10]]
+     *   |               \_Filter[salary{f}#54 &lt; 100000[INTEGER]]
+     *   |                 \_EsRelation[test1][_meta_field{f}#55, emp_no{f}#49, first_name{f}#50, ..]
+     *   |_EsqlProject[[_meta_field{r}#80, emp_no{r}#81, first_name{r}#82, gender{r}#83, hire_date{r}#84, job{r}#85, job.raw{r}#86, l
+     * anguages{r}#87, last_name{r}#88, long_noidx{r}#89, salary{r}#90, x{r}#21, y{r}#19, z{r}#16, language_name{r}#91]]
+     *   | \_Eval[[null[KEYWORD] AS _meta_field#80, null[INTEGER] AS emp_no#81, null[KEYWORD] AS first_name#82, null[TEXT] AS ge
+     * nder#83, null[DATETIME] AS hire_date#84, null[TEXT] AS job#85, null[KEYWORD] AS job.raw#86, null[INTEGER] AS languages#87,
+     * null[KEYWORD] AS last_name#88, null[LONG] AS long_noidx#89, null[INTEGER] AS salary#90, null[KEYWORD] AS language_name#91]]
+     *   |   \_Limit[1000[INTEGER],false]
+     *   |     \_Subquery[]
+     *   |       \_Eval[[1[INTEGER] AS x#21]]
+     *   |         \_Filter[ISNOTNULL(y{r}#19) AND z{r}#16 &gt; 0[INTEGER]]
+     *   |           \_Aggregate[[language_code{f}#60],[COUNT(*[KEYWORD],true[BOOLEAN]) AS y#19, language_code{f}#60 AS z#16]]
+     *   |             \_EsRelation[languages][language_code{f}#60, language_name{f}#61]
+     *   \_EsqlProject[[_meta_field{f}#68, emp_no{r}#92, first_name{f}#63, gender{f}#64, hire_date{f}#69, job{f}#70, job.raw{f}#71, l
+     * anguages{r}#93, last_name{f}#66, long_noidx{f}#72, salary{r}#94, x{r}#28, y{r}#112, z{r}#34, language_name{f}#74]]
+     *     \_Filter[ISNOTNULL(y{r}#112)]
+     *       \_Eval[[null[INTEGER] AS emp_no#92, null[INTEGER] AS languages#93, null[INTEGER] AS salary#94, TOLONG(y{r}#31) AS y#1
+     * 12]]
+     *         \_Limit[1000[INTEGER],false]
+     *           \_Subquery[]
+     *             \_Project[[_meta_field{f}#68, emp_no{f}#62 AS x#28, first_name{f}#63, gender{f}#64, hire_date{f}#69, job{f}#70, job.raw{
+     * f}#71, languages{f}#65 AS z#34, last_name{f}#66, long_noidx{f}#72, salary{f}#67 AS y#31, language_name{f}#74]]
+     *               \_Join[LEFT,[languages{f}#65],[language_code{f}#73],null]
+     *                 |_Filter[ISNOTNULL(emp_no{f}#62) AND languages{f}#65 &gt; 0[INTEGER]]
+     *                 | \_EsRelation[test1][_meta_field{f}#68, emp_no{f}#62, first_name{f}#63, ..]
+     *                 \_EsRelation[languages_lookup][LOOKUP][language_code{f}#73, language_name{f}#74]
+     */
+    public void testPushDownFilterOnReferenceAttributesPastUnionAll() {
         assumeTrue("Requires subquery in FROM command support", EsqlCapabilities.Cap.SUBQUERY_IN_FROM_COMMAND.isEnabled());
         var plan = planSubquery("""
             FROM test
@@ -1345,7 +1468,22 @@ public void testPushDownFilterOnReferenceAttributesPastUnionAllDebug() {
         assertEquals("languages_lookup", relation.indexPattern());
     }
 
-    public void testPushDownFilterOnReferenceAttributesAndFieldAttributesPastUnionAllDebug() {
+    /**
+     * Limit[1000[INTEGER],false]
+     * \_UnionAll[[_meta_field{r}#35, emp_no{r}#36, first_name{r}#37, gender{r}#38, hire_date{r}#39, job{r}#40, job.raw{r}#41, l
+     * anguages{r}#42, last_name{r}#43, long_noidx{r}#44, salary{r}#45, x{r}#46, y{r}#47]]
+     *   |_LocalRelation[[_meta_field{f}#17, emp_no{f}#11, first_name{f}#12, gender{f}#13, hire_date{f}#18, job{f}#19, job.raw{f}#20, l
+     * anguages{f}#14, last_name{f}#15, long_noidx{f}#21, salary{f}#16, x{r}#33, y{r}#34],EMPTY]
+     *   \_EsqlProject[[_meta_field{f}#28, emp_no{f}#22, first_name{f}#23, gender{f}#24, hire_date{f}#29, job{f}#30, job.raw{f}#31, l
+     * anguages{f}#25, last_name{f}#26, long_noidx{f}#32, salary{f}#27, x{r}#4, y{r}#7]]
+     *     \_Limit[1000[INTEGER],false]
+     *       \_Subquery[]
+     *         \_Filter[y{r}#7 &gt; 0[INTEGER]]
+     *           \_Eval[[1[INTEGER] AS x#4, emp_no{f}#22 + 1[INTEGER] AS y#7]]
+     *             \_Filter[salary{f}#27 &lt; 100000[INTEGER] AND emp_no{f}#22 &gt; 0[INTEGER]]
+     *               \_EsRelation[test1][_meta_field{f}#28, emp_no{f}#22, first_name{f}#23, ..]
+     */
+    public void testPushDownFilterOnReferenceAttributesAndFieldAttributesPastUnionAll() {
         assumeTrue("Requires subquery in FROM command support", EsqlCapabilities.Cap.SUBQUERY_IN_FROM_COMMAND.isEnabled());
         var plan = planSubquery("""
             FROM test, (FROM test1 | where salary < 100000 | EVAL x = 1, y = emp_no + 1)

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/plan/logical/SubquerySerializationTests.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+package org.elasticsearch.xpack.esql.plan.logical;
+
+import org.elasticsearch.xpack.esql.core.tree.Source;
+
+import java.io.IOException;
+
+public class SubquerySerializationTests extends AbstractLogicalPlanSerializationTests<Subquery> {
+    @Override
+    protected Subquery createTestInstance() {
+        Source source = randomSource();
+        LogicalPlan child = randomChild(0);
+        return new Subquery(source, child);
+    }
+
+    @Override
+    protected Subquery mutateInstance(Subquery instance) throws IOException {
+        LogicalPlan child = instance.child();
+        child = randomValueOtherThan(child, () -> randomChild(0));
+        return new Subquery(instance.source(), child);
+    }
+
+    @Override
+    protected boolean alwaysEmptySource() {
+        return true;
+    }
+}