Skip to content

[BEAM-11747] Reject the mixed Java UDF and ZetaSQL builtin operator cases #13912

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
amaliujia merged 2 commits into from
Feb 16, 2021
Merged

[BEAM-11747] Reject the mixed Java UDF and ZetaSQL builtin operator cases #13912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aee37fb
[BEAM-11747] Reject the mixed Java UDF and ZetaSQL builtin operators …
amaliujia Feb 6, 2021
18cfbe1
fixup! address comments
amaliujia Feb 16, 2021
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
2 changes: 1 addition & 1 deletion ...zetasql/src/main/java/org/apache/beam/sdk/extensions/sql/zetasql/BeamJavaUdfCalcRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ private BeamJavaUdfCalcRule() {

@Override
public boolean matches(RelOptRuleCall x) {
return ZetaSQLQueryPlanner.hasUdfInProjects(x);
return ZetaSQLQueryPlanner.hasOnlyJavaUdfInProjects(x);
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion ...zetasql/src/main/java/org/apache/beam/sdk/extensions/sql/zetasql/BeamZetaSqlCalcRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ private BeamZetaSqlCalcRule() {

@Override
public boolean matches(RelOptRuleCall x) {
return !ZetaSQLQueryPlanner.hasUdfInProjects(x);
return ZetaSQLQueryPlanner.hasNoJavaUdfInProjects(x);
}

@Override
Expand Down
48 changes: 43 additions & 5 deletions ...zetasql/src/main/java/org/apache/beam/sdk/extensions/sql/zetasql/ZetaSQLQueryPlanner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,44 @@ public static Collection<RuleSet> getZetaSqlRuleSets() {
return modifyRuleSetsForZetaSql(BeamRuleSets.getRuleSets());
}

/** Returns true if the argument contains any user-defined Java functions. */
static boolean hasUdfInProjects(RelOptRuleCall x) {
/**
* Returns true if the arguments only contain user-defined Java functions, otherwise returns
* false. User-defined java functions are in the category whose function group is equal to {@code
* SqlAnalyzer.USER_DEFINED_JAVA_SCALAR_FUNCTIONS}
*/
static boolean hasOnlyJavaUdfInProjects(RelOptRuleCall x) {
List<RelNode> resList = x.getRelList();
for (RelNode relNode : resList) {
if (relNode instanceof LogicalCalc) {
LogicalCalc logicalCalc = (LogicalCalc) relNode;
for (RexNode rexNode : logicalCalc.getProgram().getExprList()) {
if (rexNode instanceof RexCall) {
RexCall call = (RexCall) rexNode;
if (call.getOperator() instanceof SqlUserDefinedFunction) {
SqlUserDefinedFunction udf = (SqlUserDefinedFunction) call.op;
if (udf.function instanceof ZetaSqlScalarFunctionImpl) {
ZetaSqlScalarFunctionImpl scalarFunction = (ZetaSqlScalarFunctionImpl) udf.function;
if (!scalarFunction.functionGroup.equals(
SqlAnalyzer.USER_DEFINED_JAVA_SCALAR_FUNCTIONS)) {
return false;
}
} else {
return false;
}
} else {
return false;
}
}
}
}
}
return true;
}

/**
* Returns false if the argument contains any user-defined Java functions, otherwise returns true.
*/
static boolean hasNoJavaUdfInProjects(RelOptRuleCall x) {
Copy link

@ibzib ibzib Feb 12, 2021

Choose a reason for hiding this comment

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

Nit: positive phrasing avoids double negatives and makes the logic easier to follow, so consider inverting this (and renaming to something like hasJavaUdfInProjects or hasAnyJavaUdfInProjects)

Copy link
Contributor Author

@amaliujia amaliujia Feb 16, 2021

Choose a reason for hiding this comment

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

I agreed this might be better. But I think it's bit tricky to implement the positive version of hasNoJavaUdfInProjects . The hasNoJavaUdfInProjects is more error prone at this moment (we only need to consider java udf).

List<RelNode> resList = x.getRelList();
for (RelNode relNode : resList) {
if (relNode instanceof LogicalCalc) {
Expand All @@ -129,15 +165,17 @@ static boolean hasUdfInProjects(RelOptRuleCall x) {
SqlUserDefinedFunction udf = (SqlUserDefinedFunction) call.op;
if (udf.function instanceof ZetaSqlScalarFunctionImpl) {
ZetaSqlScalarFunctionImpl scalarFunction = (ZetaSqlScalarFunctionImpl) udf.function;
return scalarFunction.functionGroup.equals(
SqlAnalyzer.USER_DEFINED_JAVA_SCALAR_FUNCTIONS);
if (scalarFunction.functionGroup.equals(
SqlAnalyzer.USER_DEFINED_JAVA_SCALAR_FUNCTIONS)) {
return false;
}
}
}
}
}
}
}
return false;
return true;
}

private static Collection<RuleSet> modifyRuleSetsForZetaSql(Collection<RuleSet> ruleSets) {
Expand Down
14 changes: 5 additions & 9 deletions .../zetasql/src/test/java/org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlJavaUdfTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import org.apache.beam.sdk.testing.TestPipeline;
import org.apache.beam.sdk.values.PCollection;
import org.apache.beam.sdk.values.Row;
import org.apache.beam.vendor.calcite.v1_20_0.org.apache.calcite.plan.RelOptPlanner.CannotPlanException;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.codehaus.commons.compiler.CompileException;
import org.joda.time.Duration;
Expand Down Expand Up @@ -203,15 +204,10 @@ public void testBinaryJavaUdf() {
+ "SELECT matches(\"a\", \"a\"), 'apple'='beta'",
jarPath);
ZetaSQLQueryPlanner zetaSQLQueryPlanner = new ZetaSQLQueryPlanner(config);
BeamRelNode beamRelNode = zetaSQLQueryPlanner.convertToBeamRel(sql);
PCollection<Row> stream = BeamSqlRelUtils.toPCollection(pipeline, beamRelNode);

Schema singleField =
Schema.builder().addBooleanField("field1").addBooleanField("field2").build();

PAssert.that(stream)
.containsInAnyOrder(Row.withSchema(singleField).addValues(true, false).build());
pipeline.run().waitUntilFinish(Duration.standardMinutes(PIPELINE_EXECUTION_WAITTIME_MINUTES));
thrown.expect(CannotPlanException.class);
thrown.expectMessage(
"There are not enough rules to produce a node with desired properties: convention=BEAM_LOGICAL.");
zetaSQLQueryPlanner.convertToBeamRel(sql);
}

// TODO(BEAM-11747) Add tests that mix UDFs and builtin functions that rely on the ZetaSQL C++
Expand Down