(superset) branch 3.1 updated: chore(sql_parse): Provide more meaningful SQLGlot errors (#27858)

[michaelsmolina]

This is an automated email from the ASF dual-hosted git repository.

michaelsmolina pushed a commit to branch 3.1
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/3.1 by this push:
     new 5c431f4a56 chore(sql_parse): Provide more meaningful SQLGlot errors 
(#27858)
5c431f4a56 is described below

commit 5c431f4a56a72e420c527e37ab872f4c0c279672
Author: John Bodley <4567245+john-bod...@users.noreply.github.com>
AuthorDate: Wed Apr 3 07:10:52 2024 -0700

    chore(sql_parse): Provide more meaningful SQLGlot errors (#27858)
    
    (cherry picked from commit c38529741e68f7e98bbcdfa0e543dc2ef4acf7f9)
---
 superset/sql_parse.py               | 14 ++++++++++++--
 tests/unit_tests/sql_parse_tests.py | 12 ++++++++----
 2 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/superset/sql_parse.py b/superset/sql_parse.py
index 3f4daf171a..9ef32899a5 100644
--- a/superset/sql_parse.py
+++ b/superset/sql_parse.py
@@ -297,11 +297,21 @@ class ParsedQuery:
             statements = parse(self.stripped(), dialect=self._dialect)
         except SqlglotError as ex:
             logger.warning("Unable to parse SQL (%s): %s", self._dialect, 
self.sql)
-            dialect = self._dialect or "generic"
+
+            message = (
+                "Error parsing near '{highlight}' at line 
{line}:{col}".format(  # pylint: disable=consider-using-f-string
+                    **ex.errors[0]
+                )
+                if isinstance(ex, ParseError)
+                else str(ex)
+            )
+
             raise SupersetSecurityException(
                 SupersetError(
                     error_type=SupersetErrorType.QUERY_SECURITY_ACCESS_ERROR,
-                    message=__(f"Unable to parse SQL ({dialect}): {self.sql}"),
+                    message=__(
+                        f"You may have an error in your SQL statement. 
{message}"
+                    ),
                     level=ErrorLevel.ERROR,
                 )
             ) from ex
diff --git a/tests/unit_tests/sql_parse_tests.py 
b/tests/unit_tests/sql_parse_tests.py
index 20f1823218..d3d432bb98 100644
--- a/tests/unit_tests/sql_parse_tests.py
+++ b/tests/unit_tests/sql_parse_tests.py
@@ -273,26 +273,30 @@ def test_extract_tables_illdefined() -> None:
     with pytest.raises(SupersetSecurityException) as excinfo:
         extract_tables("SELECT * FROM schemaname.")
     assert (
-        str(excinfo.value) == "Unable to parse SQL (generic): SELECT * FROM 
schemaname."
+        str(excinfo.value)
+        == "You may have an error in your SQL statement. Error parsing near 
'.' at line 1:25"
     )
 
     with pytest.raises(SupersetSecurityException) as excinfo:
         extract_tables("SELECT * FROM catalogname.schemaname.")
     assert (
         str(excinfo.value)
-        == "Unable to parse SQL (generic): SELECT * FROM 
catalogname.schemaname."
+        == "You may have an error in your SQL statement. Error parsing near 
'.' at line 1:37"
     )
 
     with pytest.raises(SupersetSecurityException) as excinfo:
         extract_tables("SELECT * FROM catalogname..")
     assert (
         str(excinfo.value)
-        == "Unable to parse SQL (generic): SELECT * FROM catalogname.."
+        == "You may have an error in your SQL statement. Error parsing near 
'.' at line 1:27"
     )
 
     with pytest.raises(SupersetSecurityException) as excinfo:
         extract_tables('SELECT * FROM "tbname')
-    assert str(excinfo.value) == 'Unable to parse SQL (generic): SELECT * FROM 
"tbname'
+    assert (
+        str(excinfo.value)
+        == "You may have an error in your SQL statement. Error tokenizing 
'SELECT * FROM \"tbnam'"
+    )
 
     # odd edge case that works
     assert extract_tables("SELECT * FROM catalogname..tbname") == {