Add query diagnosis warning #1006
Closed
Conversation
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
ebyhr
reviewed
Oct 14, 2019
| @@ -895,6 +896,18 @@ public FeaturesConfig setMaxGroupingSets(int maxGroupingSets) | |||
| return this; | |||
| } | |||
|
|
|||
| public boolean getQueryDiagnosisWarningEnable() | |||
There was a problem hiding this comment.
Suggested change
| public boolean getQueryDiagnosisWarningEnable() | |
| public boolean isEnableQueryDiagnosisWarning() |
ebyhr
reviewed
Oct 14, 2019
| .putAll( | ||
| Stage.DIAGNOSTIC, | ||
| new DeprecatedFunctionWarning(), | ||
| new IntegerDivisionWarning()).build(); |
ebyhr
reviewed
Oct 14, 2019
| 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 static final variable.
Suggested change
| private List<String> deprecatedFunctions = ImmutableList.of("json_array_get"); | |
| private static final List<String> DEPRECATED_FUNCTIONS = ImmutableList.of("json_array_get"); |
ebyhr
reviewed
Oct 14, 2019
| 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.
ebyhr
reviewed
Oct 14, 2019
| { | ||
| 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.
ebyhr
reviewed
Oct 14, 2019
| 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 Optional<WarningCode> to List<WarningCode> for multiple warning case?
|
Superseded by #2446. Comments are addressed there. Thanks for the review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Enhance the warning system to report risky or error-prone query. This is similar to the warnings from a language compiler or static code analysis tool.
Current there are two rules:
IntegerDivisionWarning
In Hive,
SELECT 1/2will return 0.5, but in Presto this will return 0.DeprecatedFunctionWarning
Some random thoughts that we can do using the warning system: