Add query diagnosis warning #1006
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,56 @@ | ||||||
| /* | ||||||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| * you may not use this file except in compliance with the License. | ||||||
| * You may obtain a copy of the License at | ||||||
| * | ||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * Unless required by applicable law or agreed to in writing, software | ||||||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| * See the License for the specific language governing permissions and | ||||||
| * limitations under the License. | ||||||
| */ | ||||||
| package io.prestosql.sql.planner.sanity.warnings; | ||||||
|
|
||||||
| import com.google.common.collect.ImmutableList; | ||||||
| import io.prestosql.Session; | ||||||
| import io.prestosql.execution.warnings.WarningCollector; | ||||||
| import io.prestosql.metadata.Metadata; | ||||||
| import io.prestosql.spi.PrestoWarning; | ||||||
| import io.prestosql.sql.planner.ExpressionExtractor; | ||||||
| import io.prestosql.sql.planner.TypeAnalyzer; | ||||||
| import io.prestosql.sql.planner.TypeProvider; | ||||||
| import io.prestosql.sql.planner.plan.PlanNode; | ||||||
| import io.prestosql.sql.planner.sanity.PlanSanityChecker; | ||||||
| import io.prestosql.sql.tree.DefaultTraversalVisitor; | ||||||
| import io.prestosql.sql.tree.Expression; | ||||||
| import io.prestosql.sql.tree.FunctionCall; | ||||||
|
|
||||||
| import java.util.List; | ||||||
|
|
||||||
| import static io.prestosql.spi.connector.StandardWarningCode.DREPRCATED_FUNCTION; | ||||||
|
|
||||||
| public final class DeprecatedFunctionWarning | ||||||
| implements PlanSanityChecker.Checker | ||||||
| { | ||||||
| private List<String> deprecatedFunctions = ImmutableList.of("json_array_get"); | ||||||
|
There was a problem hiding this comment. We can change this to
Suggested change
|
||||||
|
|
||||||
| @Override | ||||||
| public void validate(PlanNode plan, Session session, Metadata metadata, TypeAnalyzer typeAnalyzer, TypeProvider types, WarningCollector warningCollector) | ||||||
| { | ||||||
| for (Expression expression : ExpressionExtractor.extractExpressions(plan)) { | ||||||
| new DefaultTraversalVisitor<Void, Void>() | ||||||
| { | ||||||
| @Override | ||||||
| protected Void visitFunctionCall(FunctionCall node, Void context) | ||||||
| { | ||||||
| if (node.getName().getParts().stream().anyMatch(deprecatedFunctions::contains)) { | ||||||
| warningCollector.add(new PrestoWarning(DREPRCATED_FUNCTION, "Detected use of deprecated function: json_array_get()")); | ||||||
|
There was a problem hiding this comment. Can we avoid hardcoding the function name here? When we add a deprecated function later, we need to fix this line. There was a problem hiding this comment. I'll try to detect the annotation "@deprecated" instead of hardcoding. |
||||||
| } | ||||||
| return null; | ||||||
| } | ||||||
| }.process(expression, null); | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.prestosql.sql.planner.sanity.warnings; | ||
|
|
||
| import io.prestosql.Session; | ||
| import io.prestosql.execution.warnings.WarningCollector; | ||
| import io.prestosql.metadata.Metadata; | ||
| import io.prestosql.spi.PrestoWarning; | ||
| import io.prestosql.spi.type.Type; | ||
| import io.prestosql.sql.planner.ExpressionExtractor; | ||
| import io.prestosql.sql.planner.TypeAnalyzer; | ||
| import io.prestosql.sql.planner.TypeProvider; | ||
| import io.prestosql.sql.planner.plan.PlanNode; | ||
| import io.prestosql.sql.planner.sanity.PlanSanityChecker; | ||
| import io.prestosql.sql.tree.ArithmeticBinaryExpression; | ||
| import io.prestosql.sql.tree.DefaultTraversalVisitor; | ||
| import io.prestosql.sql.tree.Expression; | ||
|
|
||
| import static io.prestosql.spi.connector.StandardWarningCode.INTEGER_DIVISION; | ||
| import static io.prestosql.spi.type.IntegerType.INTEGER; | ||
| import static io.prestosql.sql.tree.ArithmeticBinaryExpression.Operator.DIVIDE; | ||
|
|
||
| public final class IntegerDivisionWarning | ||
| implements PlanSanityChecker.Checker | ||
| { | ||
| public IntegerDivisionWarning() {} | ||
|
|
||
| @Override | ||
| public void validate(PlanNode plan, Session session, Metadata metadata, TypeAnalyzer typeAnalyzer, TypeProvider types, WarningCollector warningCollector) | ||
| { | ||
| for (Expression expression : ExpressionExtractor.extractExpressions(plan)) { | ||
| new DefaultTraversalVisitor<Void, Void>() | ||
| { | ||
| @Override | ||
| protected Void visitArithmeticBinary(ArithmeticBinaryExpression node, Void context) | ||
| { | ||
| if (node.getOperator().equals(DIVIDE)) { | ||
| Type leftType = typeAnalyzer.getType(session, types, node.getLeft()); | ||
| Type rightType = typeAnalyzer.getType(session, types, node.getRight()); | ||
| if (leftType.equals(INTEGER) && rightType.equals(INTEGER)) { | ||
| warningCollector.add(new PrestoWarning(INTEGER_DIVISION, "Detected integer division. Possible loss of precision.")); | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
| }.process(expression, null); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.prestosql.execution; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import io.prestosql.Session; | ||
| import io.prestosql.execution.warnings.DefaultWarningCollector; | ||
| import io.prestosql.execution.warnings.WarningCollector; | ||
| import io.prestosql.execution.warnings.WarningCollectorConfig; | ||
| import io.prestosql.plugin.tpch.TpchConnectorFactory; | ||
| import io.prestosql.spi.PrestoWarning; | ||
| import io.prestosql.spi.WarningCode; | ||
| import io.prestosql.spi.connector.StandardWarningCode; | ||
| import io.prestosql.sql.planner.LogicalPlanner; | ||
| import io.prestosql.testing.LocalQueryRunner; | ||
| import org.intellij.lang.annotations.Language; | ||
| import org.testng.annotations.AfterClass; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
|
|
||
| import static com.google.common.collect.ImmutableSet.toImmutableSet; | ||
| import static io.prestosql.testing.TestingSession.testSessionBuilder; | ||
| import static org.testng.Assert.fail; | ||
|
|
||
| public class TestDiagnosisWarning | ||
| { | ||
| private LocalQueryRunner queryRunner; | ||
|
|
||
| @BeforeClass | ||
| public void setUp() | ||
| { | ||
| queryRunner = new LocalQueryRunner(testSessionBuilder() | ||
| .setCatalog("local") | ||
| .setSchema("tiny") | ||
| .build()); | ||
|
|
||
| queryRunner.createCatalog( | ||
| queryRunner.getDefaultSession().getCatalog().get(), | ||
| new TpchConnectorFactory(1), | ||
| ImmutableMap.of()); | ||
| } | ||
|
|
||
| @AfterClass(alwaysRun = true) | ||
| public void tearDown() | ||
| { | ||
| queryRunner.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testWarningSession() | ||
| { | ||
| WarningCode warningCode = StandardWarningCode.INTEGER_DIVISION.toWarningCode(); | ||
| // sessionProperties = null | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT 1/2", | ||
| ImmutableMap.of(), | ||
| Optional.empty()); | ||
|
|
||
| // session enable_query_diagnosis_warning = true | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT 1/2", | ||
| Optional.of(warningCode)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testIntegerDivisionWarning() | ||
| { | ||
| WarningCode warningCode = StandardWarningCode.INTEGER_DIVISION.toWarningCode(); | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT 1/2", | ||
| Optional.of(warningCode)); | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT a/2 FROM (VALUES (1)) as t(a)", | ||
| Optional.of(warningCode)); | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT 1/2.0", | ||
| Optional.empty()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testDeprecatedFunction() | ||
| { | ||
| WarningCode warningCode = StandardWarningCode.DREPRCATED_FUNCTION.toWarningCode(); | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT 123", | ||
|
There was a problem hiding this comment. I would add a normal(=non-deprecated) function to this test. |
||
| Optional.empty()); | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT json_array_get('[1, 2, 3]', 0)", | ||
| Optional.of(warningCode)); | ||
| assertPlannerWarnings(queryRunner, | ||
| "SELECT json_array_get(a, 0) FROM (VALUES ('[1, 2, 3]')) AS t(a)", | ||
| Optional.of(warningCode)); | ||
| } | ||
|
|
||
| private static void assertPlannerWarnings(LocalQueryRunner queryRunner, @Language("SQL") String sql, Optional<WarningCode> expectedWarning) | ||
| { | ||
| assertPlannerWarnings(queryRunner, sql, ImmutableMap.of("enable_query_diagnosis_warning", "true"), expectedWarning); | ||
| } | ||
|
|
||
| private static void assertPlannerWarnings(LocalQueryRunner queryRunner, @Language("SQL") String sql, Map<String, String> sessionProperties, Optional<WarningCode> expectedWarning) | ||
|
There was a problem hiding this comment. Can we change |
||
| { | ||
| Session.SessionBuilder sessionBuilder = testSessionBuilder() | ||
| .setCatalog(queryRunner.getDefaultSession().getCatalog().get()) | ||
| .setSchema(queryRunner.getDefaultSession().getSchema().get()); | ||
| sessionProperties.forEach(sessionBuilder::setSystemProperty); | ||
| WarningCollector warningCollector = new DefaultWarningCollector(new WarningCollectorConfig()); | ||
| queryRunner.inTransaction(sessionBuilder.build(), transactionSession -> { | ||
| queryRunner.createPlan(transactionSession, sql, LogicalPlanner.Stage.OPTIMIZED_AND_VALIDATED, warningCollector); | ||
| return null; | ||
| }); | ||
| Set<WarningCode> warnings = warningCollector.getWarnings().stream() | ||
| .map(PrestoWarning::getWarningCode) | ||
| .collect(toImmutableSet()); | ||
| if (expectedWarning.isPresent()) { | ||
| if (!warnings.contains(expectedWarning.get())) { | ||
| fail("Expected warning: " + expectedWarning); | ||
| } | ||
| } | ||
| else { | ||
| if (!warnings.isEmpty()) { | ||
| fail("Expect no warning"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.