improve error logging

Author: nicornk

libs/foundry-dev-tools/src/foundry_dev_tools/errors/sql.py

@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING
 
 from foundry_dev_tools.errors.meta import FoundryAPIError
+from foundry_dev_tools.utils.misc import decamelize
 
 if TYPE_CHECKING:
     import requests
@@ -16,8 +17,41 @@ class FoundrySqlQueryFailedError(FoundryAPIError):
     message = "Foundry SQL Query Failed."
 
     def __init__(self, response: requests.Response):
-        self.error_message = response.json().get("status", {}).get("failed", {}).get("errorMessage", "")
-        super().__init__(response=response, info=self.error_message)
+        kwargs = {}
+        info = ""
+
+        try:
+            response_json = response.json()
+            failed_data = response_json.get("status", {}).get("failed", {})
+
+            # Try to extract V2 error structure with rich parameters
+            if error_code := failed_data.get("errorCode"):
+                kwargs["error_code"] = error_code
+            if error_name := failed_data.get("errorName"):
+                kwargs["error_name"] = error_name
+            if error_instance_id := failed_data.get("errorInstanceId"):
+                kwargs["error_instance_id"] = error_instance_id
+
+            # Extract all parameters and convert camelCase to snake_case
+            if parameters := failed_data.get("parameters"):
+                for key, value in parameters.items():
+                    kwargs[decamelize(key)] = value
+
+                # Prefer userFriendlyMessage as the info text
+                info = parameters.get("userFriendlyMessage", "")
+
+            # Fall back to V1 errorMessage if userFriendlyMessage not available
+            if not info:
+                info = failed_data.get("errorMessage", "")
+
+            # Store legacy error_message attribute for backward compatibility
+            self.error_message = info
+
+        except Exception:  # noqa: BLE001
+            # If any error occurs during extraction, fall back to empty
+            self.error_message = ""
+
+        super().__init__(response=response, info=info, **kwargs)
 
 
 class FurnaceSqlSqlParseError(FoundryAPIError):

tests/unit/clients/test_foundry_sql_server.py

@@ -233,3 +233,73 @@ def test_v2_invalid_compression_codec(test_context_mock):
             "SELECT * FROM `ri.foundry.main.dataset.test-dataset`",
             arrow_compression_codec="INVALID",  # type: ignore[arg-type]
         )
+
+
+def test_v2_query_failed_error_details(mocker, test_context_mock):
+    """Test that V2 error responses with rich parameters are properly extracted."""
+    mocker.patch("time.sleep")
+
+    # Mock the api_query endpoint (initial query execution)
+    test_context_mock.mock_adapter.register_uri(
+        "POST",
+        build_api_url(TEST_HOST.url, "foundry-sql-server", "sql-endpoint/v1/queries/query"),
+        json={"type": "running", "running": {"queryHandle": {"queryId": "test-query-id", "type": "foundry"}}},
+    )
+
+    # Mock the api_status endpoint with V2 error structure containing rich parameters
+    test_context_mock.mock_adapter.register_uri(
+        "POST",
+        build_api_url(TEST_HOST.url, "foundry-sql-server", "sql-endpoint/v1/queries/status"),
+        json={
+            "status": {
+                "type": "failed",
+                "failed": {
+                    "errorCode": "INVALID_ARGUMENT",
+                    "errorName": "SqlQueryService:SqlSyntaxError",
+                    "errorInstanceId": "c16cb2b7-01ec-42a9-9ee2-0e57e2aed4ba",
+                    "parameters": {
+                        "endLine": 1,
+                        "endColumn": 15350,
+                        "dialect": "SPARK",
+                        "queryFragment": "",
+                        "startColumn": 15340,
+                        "startLine": 1,
+                        "userFriendlyMessage": (
+                            "From line 1, column 15340 to line 1, column 15350: "
+                            "Column 'COLUMN_NAME' not found in table 'my_table'; did you mean 'column_name'?"
+                        ),
+                    },
+                },
+            }
+        },
+    )
+
+    with pytest.raises(FoundrySqlQueryFailedError) as exception:
+        test_context_mock.foundry_sql_server_v2.query_foundry_sql(
+            "SELECT COLUMN_NAME FROM `ri.foundry.main.dataset.test-dataset`",
+        )
+
+    # Verify all error parameters are extracted and accessible
+    assert exception.value.error_code == "INVALID_ARGUMENT"
+    assert exception.value.error_name == "SqlQueryService:SqlSyntaxError"
+    assert exception.value.error_instance_id == "c16cb2b7-01ec-42a9-9ee2-0e57e2aed4ba"
+
+    # Verify parameters are converted from camelCase to snake_case and accessible
+    assert exception.value.start_line == 1
+    assert exception.value.end_line == 1
+    assert exception.value.start_column == 15340
+    assert exception.value.end_column == 15350
+    assert exception.value.dialect == "SPARK"
+    # query_fragment is in kwargs even if empty
+    assert "query_fragment" in exception.value.kwargs
+
+    # Verify userFriendlyMessage is used as the info text and accessible
+    assert exception.value.user_friendly_message == (
+        "From line 1, column 15340 to line 1, column 15350: "
+        "Column 'COLUMN_NAME' not found in table 'my_table'; did you mean 'column_name'?"
+    )
+
+    # Verify the exception message string includes the user-friendly message
+    exception_str = str(exception.value)
+    assert "COLUMN_NAME" in exception_str
+    assert "my_table" in exception_str