-
Notifications
You must be signed in to change notification settings - Fork 14.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
validate_sql_json endpoint for checking that a given sql query …
…is valid for the chosen database (#7422) * Add "validation_only" queries to the backend This is the first step toward supporting live as-you-type SQL validation against databases that support doing it (for starters just presto). I'm trying to stick as much to the existing query machinery as possible to avoid introducing too much new state for handling this, so I plumbed it through as a db spec parameter and an option you can set on an individual query. As of this commit: - [X] Plumb validation db_spec options - [X] Add validation_only option and transform to the sql_json view - [ ] Tests for the above on the backend - [ ] Debounced requestValidationQuery in onSqlChange - [ ] Check incoming results -- full query vs validation - [ ] Tests for the above on the frontend - [ ] Highlight error lines - [ ] Print error message in alert-danger box above toolbar controls * Review comments, phase 1. Factors out the validation process to a separate class which does validation inline, rather than passing it through the existing query flow implicitly. This is meant to address Dave's feedback requesting that the validation flow not be explicitly tied to a query transform since that's uniquely a presto-ism. Next up in this stack: unit tests. * Split validation off to a separate endpoint Just to demo it and see if it's cleaner this wak. * Add unit tests covering validation The new validator files are >90% covered, and the coverage on the core view is back up to about where it was before this changeset. * Fix flake8 lints `tox -e flake8` is clean now * Hacky test fix: bind mock validator for pg/mysql * Fix pylint lints Also fix the flake8s that showed up from fixing pylint. * Use 400 Bad Request for validation user-error Consider it user-error and respond with 400 instead of 500 if somebody requests validation with template parameters, for a backend with no configured validator, or for an invalid database ID. These are in contrast to the actual server error reply for exceptions thrown by the underlying validator implementation, which still (IMO correctly) returns 500. * Move validator config to a feature flag * Add docs on configuring validators * Fix linter complaints * Extend DatabaseError catch block and document it The pyhive presto client yields EXPLAIN (TYPE VALIDATE) responses as though they were normal queries -- in other words it doesn't know that errors for that kind of request aren't exceptional. To work around that, we have to trap the exceptions it returns and translate the ones that express problems with the SQL query. * fix postgresql test environment * Hit pylint with a hammer It's convinced these are the wrong type. They aren't. * More lint fixes
- Loading branch information
Showing
8 changed files
with
605 additions
and
15 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
| from typing import Optional | ||
|
|
||
| from . import base # noqa | ||
| from . import presto_db # noqa | ||
| from .base import SQLValidationAnnotation # noqa | ||
|
|
||
|
|
||
| def get_validator_by_name(name: str) -> Optional[base.BaseSQLValidator]: | ||
| return { | ||
| 'PrestoDBSQLValidator': presto_db.PrestoDBSQLValidator, | ||
| }.get(name) |
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,66 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
|
|
||
| # pylint: disable=too-few-public-methods | ||
|
|
||
| from typing import ( | ||
| Any, | ||
| Dict, | ||
| List, | ||
| Optional, | ||
| ) | ||
|
|
||
|
|
||
| class SQLValidationAnnotation: | ||
| """Represents a single annotation (error/warning) in an SQL querytext""" | ||
| def __init__( | ||
| self, | ||
| message: str, | ||
| line_number: Optional[int], | ||
| start_column: Optional[int], | ||
| end_column: Optional[int], | ||
| ): | ||
| self.message = message | ||
| self.line_number = line_number | ||
| self.start_column = start_column | ||
| self.end_column = end_column | ||
|
|
||
| def to_dict(self) -> Dict: | ||
| """Return a dictionary representation of this annotation""" | ||
| return { | ||
| 'line_number': self.line_number, | ||
| 'start_column': self.start_column, | ||
| 'end_column': self.end_column, | ||
| 'message': self.message, | ||
| } | ||
|
|
||
|
|
||
| class BaseSQLValidator: | ||
| """BaseSQLValidator defines the interface for checking that a given sql | ||
| query is valid for a given database engine.""" | ||
|
|
||
| name = 'BaseSQLValidator' | ||
|
|
||
| @classmethod | ||
| def validate( | ||
| cls, | ||
| sql: str, | ||
| schema: str, | ||
| database: Any, | ||
| ) -> List[SQLValidationAnnotation]: | ||
| """Check that the given SQL querystring is valid for the given engine""" | ||
| raise NotImplementedError |
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,186 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
|
|
||
| from contextlib import closing | ||
| import logging | ||
| import time | ||
| from typing import ( | ||
| Any, | ||
| Dict, | ||
| List, | ||
| Optional, | ||
| ) | ||
|
|
||
| from flask import g | ||
| from pyhive.exc import DatabaseError | ||
|
|
||
| from superset import app, security_manager | ||
| from superset.sql_parse import ParsedQuery | ||
| from superset.sql_validators.base import ( | ||
| BaseSQLValidator, | ||
| SQLValidationAnnotation, | ||
| ) | ||
| from superset.utils.core import sources | ||
|
|
||
| MAX_ERROR_ROWS = 10 | ||
|
|
||
| config = app.config | ||
|
|
||
|
|
||
| class PrestoSQLValidationError(Exception): | ||
| """Error in the process of asking Presto to validate SQL querytext""" | ||
|
|
||
|
|
||
| class PrestoDBSQLValidator(BaseSQLValidator): | ||
| """Validate SQL queries using Presto's built-in EXPLAIN subtype""" | ||
|
|
||
| name = 'PrestoDBSQLValidator' | ||
|
|
||
| @classmethod | ||
| def validate_statement( | ||
| cls, | ||
| statement, | ||
| database, | ||
| cursor, | ||
| user_name, | ||
| ) -> Optional[SQLValidationAnnotation]: | ||
| # pylint: disable=too-many-locals | ||
| db_engine_spec = database.db_engine_spec | ||
| parsed_query = ParsedQuery(statement) | ||
| sql = parsed_query.stripped() | ||
|
|
||
| # Hook to allow environment-specific mutation (usually comments) to the SQL | ||
| # pylint: disable=invalid-name | ||
| SQL_QUERY_MUTATOR = config.get('SQL_QUERY_MUTATOR') | ||
| if SQL_QUERY_MUTATOR: | ||
| sql = SQL_QUERY_MUTATOR(sql, user_name, security_manager, database) | ||
|
|
||
| # Transform the final statement to an explain call before sending it on | ||
| # to presto to validate | ||
| sql = f'EXPLAIN (TYPE VALIDATE) {sql}' | ||
|
|
||
| # Invoke the query against presto. NB this deliberately doesn't use the | ||
| # engine spec's handle_cursor implementation since we don't record | ||
| # these EXPLAIN queries done in validation as proper Query objects | ||
| # in the superset ORM. | ||
| try: | ||
| db_engine_spec.execute(cursor, sql) | ||
| polled = cursor.poll() | ||
| while polled: | ||
| logging.info('polling presto for validation progress') | ||
| stats = polled.get('stats', {}) | ||
| if stats: | ||
| state = stats.get('state') | ||
| if state == 'FINISHED': | ||
| break | ||
| time.sleep(0.2) | ||
| polled = cursor.poll() | ||
| db_engine_spec.fetch_data(cursor, MAX_ERROR_ROWS) | ||
| return None | ||
| except DatabaseError as db_error: | ||
| # The pyhive presto client yields EXPLAIN (TYPE VALIDATE) responses | ||
| # as though they were normal queries. In other words, it doesn't | ||
| # know that errors here are not exceptional. To map this back to | ||
| # ordinary control flow, we have to trap the category of exception | ||
| # raised by the underlying client, match the exception arguments | ||
| # pyhive provides against the shape of dictionary for a presto query | ||
| # invalid error, and restructure that error as an annotation we can | ||
| # return up. | ||
|
|
||
| # Confirm the first element in the DatabaseError constructor is a | ||
| # dictionary with error information. This is currently provided by | ||
| # the pyhive client, but may break if their interface changes when | ||
| # we update at some point in the future. | ||
| if not db_error.args or not isinstance(db_error.args[0], dict): | ||
| raise PrestoSQLValidationError( | ||
| 'The pyhive presto client returned an unhandled ' | ||
| 'database error.', | ||
| ) from db_error | ||
| error_args: Dict[str, Any] = db_error.args[0] | ||
|
|
||
| # Confirm the two fields we need to be able to present an annotation | ||
| # are present in the error response -- a message, and a location. | ||
| if 'message' not in error_args: | ||
| raise PrestoSQLValidationError( | ||
| 'The pyhive presto client did not report an error message', | ||
| ) from db_error | ||
| if 'errorLocation' not in error_args: | ||
| raise PrestoSQLValidationError( | ||
| 'The pyhive presto client did not report an error location', | ||
| ) from db_error | ||
|
|
||
| # Pylint is confused about the type of error_args, despite the hints | ||
| # and checks above. | ||
| # pylint: disable=invalid-sequence-index | ||
| message = error_args['message'] | ||
| err_loc = error_args['errorLocation'] | ||
| line_number = err_loc.get('lineNumber', None) | ||
| start_column = err_loc.get('columnNumber', None) | ||
| end_column = err_loc.get('columnNumber', None) | ||
|
|
||
| return SQLValidationAnnotation( | ||
| message=message, | ||
| line_number=line_number, | ||
| start_column=start_column, | ||
| end_column=end_column, | ||
| ) | ||
| except Exception as e: | ||
| logging.exception(f'Unexpected error running validation query: {e}') | ||
| raise e | ||
|
|
||
| @classmethod | ||
| def validate( | ||
| cls, | ||
| sql: str, | ||
| schema: str, | ||
| database: Any, | ||
| ) -> List[SQLValidationAnnotation]: | ||
| """ | ||
| Presto supports query-validation queries by running them with a | ||
| prepended explain. | ||
| For example, "SELECT 1 FROM default.mytable" becomes "EXPLAIN (TYPE | ||
| VALIDATE) SELECT 1 FROM default.mytable. | ||
| """ | ||
| user_name = g.user.username if g.user else None | ||
| parsed_query = ParsedQuery(sql) | ||
| statements = parsed_query.get_statements() | ||
|
|
||
| logging.info(f'Validating {len(statements)} statement(s)') | ||
| engine = database.get_sqla_engine( | ||
| schema=schema, | ||
| nullpool=True, | ||
| user_name=user_name, | ||
| source=sources.get('sql_lab', None), | ||
| ) | ||
| # Sharing a single connection and cursor across the | ||
| # execution of all statements (if many) | ||
| annotations: List[SQLValidationAnnotation] = [] | ||
| with closing(engine.raw_connection()) as conn: | ||
| with closing(conn.cursor()) as cursor: | ||
| for statement in parsed_query.get_statements(): | ||
| annotation = cls.validate_statement( | ||
| statement, | ||
| database, | ||
| cursor, | ||
| user_name, | ||
| ) | ||
| if annotation: | ||
| annotations.append(annotation) | ||
| logging.debug(f'Validation found {len(annotations)} error(s)') | ||
|
|
||
| return annotations |
Oops, something went wrong.