Skip to content

ESQL: Lazy collection copying during node transform #124424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 10, 2025
Merged

ESQL: Lazy collection copying during node transform #124424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd631ac
ESQL: Lazy collection copying during node transform
costin Mar 8, 2025
c80fe11
[CI] Auto commit changes from spotless
Mar 8, 2025
5125559
Update docs/changelog/124424.yaml
costin Mar 8, 2025
71ee5bb
Include NodeInfo as well
costin Mar 8, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/changelog/124424.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 124424
summary: Lazy collection copying during node transform
area: ES|QL
type: bug
issues: []
3 changes: 1 addition & 2 deletions ...k/plugin/esql-core/src/main/java/org/elasticsearch/xpack/esql/core/expression/NameId.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
import org.elasticsearch.xpack.esql.core.util.PlanStreamInput;

import java.io.IOException;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicLong;

/**
Expand All @@ -34,7 +33,7 @@ public NameId() {

@Override
public int hashCode() {
return Objects.hash(id);
return Long.hashCode(id);
}

@Override
Expand Down
25 changes: 13 additions & 12 deletions x-pack/plugin/esql-core/src/main/java/org/elasticsearch/xpack/esql/core/tree/Node.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public <E> void forEachPropertyUp(Class<E> typeToken, Consumer<? super E> rule)
protected <E> void forEachProperty(Class<E> typeToken, Consumer<? super E> rule) {
for (Object prop : info().properties()) {
// skip children (only properties are interesting)
if (prop != children && children.contains(prop) == false && typeToken.isInstance(prop)) {
if (prop != children && typeToken.isInstance(prop) && children.contains(prop) == false) {
rule.accept((E) prop);
}
}
Expand Down Expand Up @@ -203,20 +203,21 @@ public <E extends T> T transformUp(Class<E> typeToken, Function<E, ? extends T>
protected <R extends Function<? super T, ? extends T>> T transformChildren(Function<T, ? extends T> traversalOperation) {
boolean childrenChanged = false;

// stream() could be used but the code is just as complicated without any advantages
// further more, it would include bring in all the associated stream/collector object creation even though in
// most cases the immediate tree would be quite small (0,1,2 elements)
List<T> transformedChildren = new ArrayList<>(children().size());
// Avoid creating a new array of children if no change is needed.
// And when it happens, look at using replacement to minimize the amount of method invocations.
List<T> transformedChildren = null;

for (T child : children) {
for (int i = 0, s = children.size(); i < s; i++) {
T child = children.get(i);
T next = traversalOperation.apply(child);
if (child.equals(next)) {
// use the initial value
next = child;
} else {
childrenChanged = true;
if (child.equals(next) == false) {
// lazy copy + replacement in place
if (childrenChanged == false) {
childrenChanged = true;
transformedChildren = new ArrayList<>(children);
}
transformedChildren.set(i, next);
}
transformedChildren.add(next);
}

return (childrenChanged ? replaceChildrenSameSize(transformedChildren) : (T) this);
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugin/esql-core/src/main/java/org/elasticsearch/xpack/esql/core/tree/NodeInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ final <E> T transform(Function<? super E, ? extends E> rule, Class<E> typeToken)
List<?> children = node.children();

Function<Object, Object> realRule = p -> {
if (p != children && false == children.contains(p) && (p == null || typeToken.isInstance(p))) {
if (p != children && (p == null || typeToken.isInstance(p)) && false == children.contains(p)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thought: should the children.contains(p) still show up in profiles, we could maybe refactor NodeInfo to track the non-children properties separately - avoiding this check in the first place.
return rule.apply(typeToken.cast(p));
}
return p;
Expand Down
24 changes: 13 additions & 11 deletions x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/plan/QueryPlan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ public <E extends Expression> PlanType transformExpressionsUp(Class<E> typeToken

@SuppressWarnings("unchecked")
private static Object doTransformExpression(Object arg, Function<Expression, ? extends Expression> traversal) {
if (arg instanceof Expression) {
return traversal.apply((Expression) arg);
if (arg instanceof Expression exp) {
return traversal.apply(exp);
}

// WARNING: if the collection is typed, an incompatible function will be applied to it
Expand All @@ -141,17 +141,19 @@ private static Object doTransformExpression(Object arg, Function<Expression, ? e
// has no type info so it's difficult to have automatic checking without having base classes).

if (arg instanceof Collection<?> c) {
List<Object> transformed = new ArrayList<>(c.size());
List<Object> transformed = null;
boolean hasChanged = false;
int i = 0;
for (Object e : c) {
Object next = doTransformExpression(e, traversal);
if (e.equals(next)) {
// use the initial value
next = e;
} else {
hasChanged = true;
if (e.equals(next) == false) {
if (hasChanged == false) {
hasChanged = true;
transformed = new ArrayList<>(c);
}
transformed.set(i, next);
}
transformed.add(next);
i++;
}

return hasChanged ? transformed : arg;
Expand Down Expand Up @@ -186,8 +188,8 @@ public <E extends Expression> void forEachExpressionUp(Class<E> typeToken, Consu

@SuppressWarnings("unchecked")
private static void doForEachExpression(Object arg, Consumer<Expression> traversal) {
if (arg instanceof Expression) {
traversal.accept((Expression) arg);
if (arg instanceof Expression exp) {
traversal.accept(exp);
} else if (arg instanceof Collection<?> c) {
for (Object o : c) {
doForEachExpression(o, traversal);
Expand Down
3 changes: 1 addition & 2 deletions x-pack/plugin/ql/src/main/java/org/elasticsearch/xpack/ql/expression/NameId.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
*/
package org.elasticsearch.xpack.ql.expression;

import java.util.Objects;
import java.util.concurrent.atomic.AtomicLong;

/**
Expand All @@ -28,7 +27,7 @@ public NameId() {

@Override
public int hashCode() {
return Objects.hash(id);
return Long.hashCode(id);
}

@Override
Expand Down
24 changes: 13 additions & 11 deletions x-pack/plugin/ql/src/main/java/org/elasticsearch/xpack/ql/plan/QueryPlan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ public <E extends Expression> PlanType transformExpressionsUp(Class<E> typeToken

@SuppressWarnings("unchecked")
private static Object doTransformExpression(Object arg, Function<Expression, ? extends Expression> traversal) {
if (arg instanceof Expression) {
return traversal.apply((Expression) arg);
if (arg instanceof Expression exp) {
return traversal.apply(exp);
}

// WARNING: if the collection is typed, an incompatible function will be applied to it
Expand All @@ -119,17 +119,19 @@ private static Object doTransformExpression(Object arg, Function<Expression, ? e
// has no type info so it's difficult to have automatic checking without having base classes).

if (arg instanceof Collection<?> c) {
List<Object> transformed = new ArrayList<>(c.size());
List<Object> transformed = null;
boolean hasChanged = false;
int i = 0;
for (Object e : c) {
Object next = doTransformExpression(e, traversal);
if (e.equals(next)) {
// use the initial value
next = e;
} else {
hasChanged = true;
if (e.equals(next) == false) {
if (hasChanged == false) {
hasChanged = true;
transformed = new ArrayList<>(c);
}
transformed.set(i, next);
}
transformed.add(next);
i++;
}

return hasChanged ? transformed : arg;
Expand Down Expand Up @@ -164,8 +166,8 @@ public <E extends Expression> void forEachExpressionUp(Class<E> typeToken, Consu

@SuppressWarnings("unchecked")
private static void doForEachExpression(Object arg, Consumer<Expression> traversal) {
if (arg instanceof Expression) {
traversal.accept((Expression) arg);
if (arg instanceof Expression exp) {
traversal.accept(exp);
} else if (arg instanceof Collection<?> c) {
for (Object o : c) {
doForEachExpression(o, traversal);
Expand Down
25 changes: 13 additions & 12 deletions x-pack/plugin/ql/src/main/java/org/elasticsearch/xpack/ql/tree/Node.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public <E> void forEachPropertyUp(Class<E> typeToken, Consumer<? super E> rule)
protected <E> void forEachProperty(Class<E> typeToken, Consumer<? super E> rule) {
for (Object prop : info().properties()) {
// skip children (only properties are interesting)
if (prop != children && children.contains(prop) == false && typeToken.isInstance(prop)) {
if (prop != children && typeToken.isInstance(prop) && children.contains(prop) == false) {
rule.accept((E) prop);
}
}
Expand Down Expand Up @@ -202,20 +202,21 @@ public <E extends T> T transformUp(Class<E> typeToken, Function<E, ? extends T>
protected <R extends Function<? super T, ? extends T>> T transformChildren(Function<T, ? extends T> traversalOperation) {
boolean childrenChanged = false;

// stream() could be used but the code is just as complicated without any advantages
// further more, it would include bring in all the associated stream/collector object creation even though in
// most cases the immediate tree would be quite small (0,1,2 elements)
List<T> transformedChildren = new ArrayList<>(children().size());
// Avoid creating a new array of children if no change is needed.
// And when it happens, look at using replacement to minimize the amount of method invocations.
List<T> transformedChildren = null;

for (T child : children) {
for (int i = 0, s = children.size(); i < s; i++) {
T child = children.get(i);
T next = traversalOperation.apply(child);
if (child.equals(next)) {
// use the initial value
next = child;
} else {
childrenChanged = true;
if (child.equals(next) == false) {
// lazy copy + replacement in place
if (childrenChanged == false) {
childrenChanged = true;
transformedChildren = new ArrayList<>(children);
}
transformedChildren.set(i, next);
}
transformedChildren.add(next);
}

return (childrenChanged ? replaceChildrenSameSize(transformedChildren) : (T) this);
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugin/ql/src/main/java/org/elasticsearch/xpack/ql/tree/NodeInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ final <E> T transform(Function<? super E, ? extends E> rule, Class<E> typeToken)
List<?> children = node.children();

Function<Object, Object> realRule = p -> {
if (p != children && false == children.contains(p) && (p == null || typeToken.isInstance(p))) {
if (p != children && (p == null || typeToken.isInstance(p)) && false == children.contains(p)) {
return rule.apply(typeToken.cast(p));
}
return p;
Expand Down