Minor cleanup.

Signed-off-by: currantw <[email protected]>

Author: currantw

core/src/main/java/org/opensearch/sql/analysis/Analyzer.java

@@ -134,7 +134,7 @@ public class Analyzer extends AbstractNodeVisitor<LogicalPlan, AnalysisContext>
   private final BuiltinFunctionRepository repository;
 
   private static final String PATH_SEPARATOR = ".";
-  private static final Pattern PATH_COMPONENT_PATTERN =
+  private static final Pattern PATH_SEPARATOR_PATTERN =
       Pattern.compile(PATH_SEPARATOR, Pattern.LITERAL);
 
   /** Constructor. */
@@ -491,7 +491,7 @@ public LogicalPlan visitFlatten(Flatten node, AnalysisContext context) {
 
     for (java.util.Map.Entry<String, ExprType> entry : fieldsMap.entrySet()) {
       String path = entry.getKey();
-      List<String> pathComponents = Arrays.stream(PATH_COMPONENT_PATTERN.split(path)).toList();
+      List<String> pathComponents = Arrays.stream(PATH_SEPARATOR_PATTERN.split(path)).toList();
 
       // Verify that path starts with the field name.
       if (!pathComponents.getFirst().equals(fieldName)) {

core/src/main/java/org/opensearch/sql/planner/DefaultImplementor.java

@@ -103,7 +103,7 @@ public PhysicalPlan visitEval(LogicalEval node, C context) {
 
   @Override
   public PhysicalPlan visitFlatten(LogicalFlatten node, C context) {
-    return new FlattenOperator(visitChild(node, context), node.getField());
+    return new FlattenOperator(visitChild(node, context), node.getFieldRefExp());
   }
 
   @Override

core/src/main/java/org/opensearch/sql/planner/logical/LogicalFlatten.java

@@ -16,11 +16,11 @@
 @ToString
 @EqualsAndHashCode(callSuper = true)
 public class LogicalFlatten extends LogicalPlan {
-  private final ReferenceExpression field;
+  private final ReferenceExpression fieldRefExp;
 
-  public LogicalFlatten(LogicalPlan child, ReferenceExpression field) {
+  public LogicalFlatten(LogicalPlan child, ReferenceExpression fieldRefExp) {
     super(Collections.singletonList(child));
-    this.field = field;
+    this.fieldRefExp = fieldRefExp;
   }
 
   @Override

core/src/main/java/org/opensearch/sql/planner/logical/LogicalPlanDSL.java

@@ -97,8 +97,8 @@ public static LogicalPlan eval(
     return new LogicalEval(input, Arrays.asList(expressions));
   }
 
-  public LogicalPlan flatten(LogicalPlan input, ReferenceExpression field) {
-    return new LogicalFlatten(input, field);
+  public LogicalPlan flatten(LogicalPlan input, ReferenceExpression fieldRefExp) {
+    return new LogicalFlatten(input, fieldRefExp);
   }
 
   public static LogicalPlan sort(LogicalPlan input, Pair<SortOption, Expression>... sorts) {

core/src/main/java/org/opensearch/sql/planner/physical/FlattenOperator.java

@@ -53,7 +53,7 @@ public ExprValue next() {
     ExprValue inputExprValue = input.next();
     Map<String, ExprValue> fieldsMap = ExprValueUtils.getTupleValue(inputExprValue);
 
-    // Get the flattened field map.
+    // Build the flattened field map.
     String fieldName = field.getAttr();
     ExprValue exprValue = fieldsMap.get(fieldName);
 
@@ -63,7 +63,7 @@ public ExprValue next() {
     fieldsMap.putAll(flattenedFieldsMap);
     fieldsMap.remove(fieldName);
 
-    // Update environment.
+    // Update the environment.
     Environment<Expression, ExprValue> env = inputExprValue.bindingTuples();
 
     for (Entry<String, ExprValue> entry : flattenedFieldsMap.entrySet()) {

core/src/main/java/org/opensearch/sql/planner/physical/PhysicalPlanDSL.java

@@ -60,8 +60,8 @@ public static EvalOperator eval(
     return new EvalOperator(input, Arrays.asList(expressions));
   }
 
-  public FlattenOperator flatten(PhysicalPlan input, ReferenceExpression field) {
-    return new FlattenOperator(input, field);
+  public FlattenOperator flatten(PhysicalPlan input, ReferenceExpression fieldRefExp) {
+    return new FlattenOperator(input, fieldRefExp);
   }
 
   public static SortOperator sort(PhysicalPlan input, Pair<SortOption, Expression>... sorts) {

core/src/test/java/org/opensearch/sql/planner/DefaultImplementorTest.java

@@ -342,13 +342,8 @@ void visitFlatten_should_build_FlattenOperator() {
     var logicalPlan = new LogicalFlatten(logicalChild, ref(fieldName, STRUCT));
     var implemented = logicalPlan.accept(implementor, null);
 
-    assertInstanceOf(
-        FlattenOperator.class, implemented, "Visiting logical flatten builds physical flatten");
-    assertEquals(
-        fieldName,
-        ((FlattenOperator) implemented).getField().getAttr(),
-        "Physical flatten has expected field");
-    assertSame(
-        physicalChild, implemented.getChild().getFirst(), "Physical flatten has expected child");
+    assertInstanceOf(FlattenOperator.class, implemented);
+    assertEquals(fieldName, ((FlattenOperator) implemented).getField().getAttr());
+    assertSame(physicalChild, implemented.getChild().getFirst());
   }
 }

core/src/test/java/org/opensearch/sql/planner/physical/FlattenOperatorTest.java

@@ -33,6 +33,20 @@
 class FlattenOperatorTest extends PhysicalPlanTestBase {
   @Mock private PhysicalPlan inputPlan;
 
+  @Test
+  void testFlattenStructEmpty() {
+    Map<String, Object> structMap = ImmutableMap.of();
+    Map<String, Object> rowMap = ImmutableMap.of("struct_field", structMap);
+    ExprValue rowValue = ExprValueUtils.tupleValue(rowMap);
+
+    when(inputPlan.hasNext()).thenReturn(true, false);
+    when(inputPlan.next()).thenReturn(rowValue);
+
+    PhysicalPlan plan = flatten(inputPlan, DSL.ref("struct_field", STRUCT));
+
+    assertThat(execute(plan), allOf(iterableWithSize(1), hasItems()));
+  }
+
   @Test
   void testFlattenStructBasic() {
     Map<String, Object> structMap =
@@ -56,20 +70,6 @@ void testFlattenStructBasic() {
     assertThat(execute(plan), allOf(iterableWithSize(1), hasItems(expectedRowValue)));
   }
 
-  @Test
-  void testFlattenStructEmpty() {
-    Map<String, Object> structMap = ImmutableMap.of();
-    Map<String, Object> rowMap = ImmutableMap.of("struct_field", structMap);
-    ExprValue rowValue = ExprValueUtils.tupleValue(rowMap);
-
-    when(inputPlan.hasNext()).thenReturn(true, false);
-    when(inputPlan.next()).thenReturn(rowValue);
-
-    PhysicalPlan plan = flatten(inputPlan, DSL.ref("struct_field", STRUCT));
-
-    assertThat(execute(plan), allOf(iterableWithSize(1), hasItems()));
-  }
-
   @Test
   void testFlattenStructNested() {
     Map<String, Object> nestedStructMap =

opensearch/src/test/java/org/opensearch/sql/opensearch/executor/protector/OpenSearchExecutionProtectorTest.java

@@ -369,10 +369,9 @@ void test_visitOpenSearchEval() {
   void test_visitFlatten() {
     FlattenOperator flattenOperator =
         new FlattenOperator(values(emptyList()), ref("field_name", STRUCT));
+
     assertEquals(
-        resourceMonitor(flattenOperator),
-        executionProtector.visitFlatten(flattenOperator, null),
-        "flatten operator is protected");
+        resourceMonitor(flattenOperator), executionProtector.visitFlatten(flattenOperator, null));
   }
 
   PhysicalPlan resourceMonitor(PhysicalPlan input) {

ppl/src/test/java/org/opensearch/sql/ppl/utils/PPLQueryDataAnonymizerTest.java

@@ -98,10 +98,7 @@ public void testTrendlineCommand() {
 
   @Test
   public void testFlattenCommand() {
-    assertEquals(
-        "Flatten command is not modified by anonymizer",
-        "source=t | flatten field_name",
-        anonymize("source=t | flatten field_name"));
+    assertEquals("source=t | flatten field_name", anonymize("source=t | flatten field_name"));
   }
 
   @Test