Skip to content

fix(core): validate Plan.Root output name count #812

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

Open
benbellick wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(core): validate Plan.Root output name count #812

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0eab080
fix(core): validate Plan.Root output name count
benbellick Apr 13, 2026
5a31567
style(core): apply spotless formatting
benbellick Apr 13, 2026
0043ab2
fix(core): validate Plan.Root names with depth-first count
benbellick Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions core/src/main/java/io/substrait/plan/Plan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,18 @@ public abstract static class Root {

public abstract List<String> getNames();

@Value.Check
protected void check() {
final int expectedFieldCount = getInput().getRecordType().fields().size();
final int actualNameCount = getNames().size();
if (actualNameCount != expectedFieldCount) {
Comment thread
benbellick marked this conversation as resolved.
throw new IllegalArgumentException(
String.format(
"Plan.Root names count (%d) must match input record type field count (%d)",
actualNameCount, expectedFieldCount));
}
}

public static ImmutableRoot.Builder builder() {
return ImmutableRoot.builder();
}
Expand Down
28 changes: 27 additions & 1 deletion core/src/test/java/io/substrait/plan/PlanConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import io.substrait.extension.SimpleExtension;
import io.substrait.plan.Plan.Root;
import io.substrait.relation.ImmutableVirtualTableScan;
import io.substrait.relation.NamedScan;
import io.substrait.relation.VirtualTableScan;
import io.substrait.type.NamedStruct;
import io.substrait.type.Type;
Expand All @@ -18,9 +19,27 @@
import io.substrait.utils.StringHolderHandlingProtoExtensionConverter;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.junit.jupiter.api.Test;

class PlanConverterTest {
@Test
void rootNamesMustMatchInputFieldCount() {
final NamedScan scan =
NamedScan.builder()
.addNames("test_table")
.initialSchema(
NamedStruct.builder()
.addNames("only_column")
.struct(TypeCreator.REQUIRED.struct(TypeCreator.REQUIRED.I32))
.build())
.build();

assertThrows(
IllegalArgumentException.class,
() -> Root.builder().input(scan).names(List.of("col1", "col2")).build());
}

@Test
void emptyAdvancedExtensionTest() {
final Plan plan = Plan.builder().advancedExtension(AdvancedExtension.builder().build()).build();
Expand Down Expand Up @@ -304,7 +323,14 @@ void nestedUserDefinedTypesShareExtensionCollector() {
false, nullablePointLiteral, pointLiteral, vectorOfPointLiteral))
.build();

Plan plan = Plan.builder().addRoots(Root.builder().input(virtualTable).build()).build();
Plan plan =
Plan.builder()
.addRoots(
Root.builder()
.input(virtualTable)
.names(List.of("nullable_point_col", "point_col", "vector_col"))
.build())
.build();

PlanProtoConverter toProtoConverter = new PlanProtoConverter();
io.substrait.proto.Plan protoPlan = toProtoConverter.toProto(plan);
Expand Down
Loading