[py] pretty SQL compilation errors

abhizer · abhizer · commit e6b77b57d744 · 2024-10-02T17:11:15.000Z
Display SQL compliation errors in a pretty format. Also use `pretty-errors` library that improves how errors are presented in general. Fixes: #1842 Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
diff --git a/python/feldera/__init__.py b/python/feldera/__init__.py
@@ -1,3 +1,9 @@
 from feldera.rest.feldera_client import FelderaClient
 from feldera.pipeline import Pipeline
 from feldera.pipeline_builder import PipelineBuilder
+
+import pretty_errors
+
+pretty_errors.configure(
+    line_number_first=True,
+)
diff --git a/python/feldera/rest/feldera_client.py b/python/feldera/rest/feldera_client.py
@@ -88,7 +88,16 @@ def __wait_for_compilation(self, name: str):
             if status == "Success":
                 return p
             elif status not in wait:
-                # TODO: return a more detailed error message
+                # error handling for SQL compilation errors
+                if isinstance(status, dict):
+                    sql_errors = status.get("SqlError")
+                    if sql_errors:
+                        err_msg = f"Pipeline {name} failed to compile:\n"
+                        for sql_error in sql_errors:
+                            err_msg += f"{sql_error['error_type']}\n{sql_error['message']}\n"
+                            err_msg += f"Code snippet:\n{sql_error['snippet']}"
+                        raise RuntimeError(err_msg)
+
                 raise RuntimeError(f"The program failed to compile: {status}")
 
             logging.debug("still compiling %s, waiting for 100 more milliseconds", name)
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -27,6 +27,7 @@ dependencies = [
     "pandas",
     "typing-extensions",
     "numpy<2",
+    "pretty-errors",
 ]
 [project.urls]
 Homepage = "https://www.feldera.com"
diff --git a/python/tests/test_pipeline_builder.py b/python/tests/test_pipeline_builder.py
@@ -252,19 +252,31 @@ def test_df_without_columns(self):
         pipeline.delete()
 
     def test_sql_error(self):
-        TBL_NAME = "student"
+        pipeline_name = "sql_error"
 
         sql = f"""
-        CREATE TABLE {TBL_NAME} (
-            id INT,
-            name STRING
-        );
+CREATE TABLE student(
+    id INT,
+    name STRING
+);
 
-        CREATE VIEW s AS SELECT * FROM blah;
+CREATE VIEW s AS SELECT * FROM blah;
         """
 
-        with self.assertRaises(Exception):
-            PipelineBuilder(TEST_CLIENT, name="sql_error", sql=sql).create_or_replace()
+        expected = f"""
+Pipeline {pipeline_name} failed to compile:
+Error in SQL statement
+Object 'blah' not found
+Code snippet:
+    6|CREATE VIEW s AS SELECT * FROM blah;
+                                     ^^^^""".strip()
+
+        with self.assertRaises(Exception) as err:
+            PipelineBuilder(TEST_CLIENT, name=pipeline_name, sql=sql).create_or_replace()
+
+        got_err: str = err.exception.args[0].strip()
+
+        assert expected == got_err
 
         pipeline = Pipeline.get("sql_error", TEST_CLIENT)
         pipeline.delete()
diff --git a/python/uv.lock b/python/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ dependencies = [`
`27`	`27`	`"pandas",`
`28`	`28`	`"typing-extensions",`
`29`	`29`	`"numpy<2",`
	`30`	`+ "pretty-errors",`
`30`	`31`	`]`
`31`	`32`	`[project.urls]`
`32`	`33`	`Homepage = "https://www.feldera.com"`