From 211434956598c02aa6fab1044bcf355e9a87eb35 Mon Sep 17 00:00:00 2001 From: Michal Sokolowski Date: Tue, 27 Oct 2026 11:41:06 +0000 Subject: [PATCH 1/2] #809469 Preserve Gateway validation details for missing schema ID --- src/dataworkbench/gateway.py | 24 ++++++++++++++++++------ tests/test_datacatalogue.py | 4 +++- tests/test_gateway.py | 16 +++++++++++++--- 3 files changed, 34 insertions(+), 10 deletions(-) diff --git a/src/dataworkbench/gateway.py b/src/dataworkbench/gateway.py index 14859a3..bc989b6 100644 --- a/src/dataworkbench/gateway.py +++ b/src/dataworkbench/gateway.py @@ -11,9 +11,19 @@ logger = setup_logger(__name__) -def _get_trace_id_from_response(response: requests.Response) -> str | None: +def _get_error_details_from_response( + response: requests.Response, +) -> tuple[str | None, str | None]: response_dict = json.loads(response.text) - return response_dict.get("traceId") + error_details = response_dict.get("detail") + if not error_details: + errors = response_dict.get("errors", {}) + error_details = "; ".join( + f"{field}: {message}" + for field, messages in errors.items() + for message in messages + ) + return error_details, response_dict.get("traceId") class Gateway: @@ -147,13 +157,15 @@ def import_dataset( ) return response except requests.exceptions.RequestException as e: - trace_id = ( - _get_trace_id_from_response(e.response) + error_details, trace_id = ( + _get_error_details_from_response(e.response) if e.response is not None - else None + else (None, None) ) error_msg = ( - f"Failed to create data catalog entry. correlation-id: {trace_id}" + f"Failed to create data catalog entry. " + f"{error_details + ' ' if error_details else ''}" + f"correlation-id: {trace_id}" ) logger.error(error_msg) diff --git a/tests/test_datacatalogue.py b/tests/test_datacatalogue.py index b7ceb7d..2bf7a75 100644 --- a/tests/test_datacatalogue.py +++ b/tests/test_datacatalogue.py @@ -98,9 +98,10 @@ def test_save_gateway_failure_triggers_rollback(mock_dependencies, storage_handl folder_id = uuid.uuid4() target_path = f".../{folder_id}" datacatalogue, _, _ = mock_dependencies + validation_message = "Either SchemaVersionId or SchemaId must be provided. Schemas are not created on import." datacatalogue.gateway.import_dataset = MagicMock() - datacatalogue.gateway.import_dataset.side_effect = RequestException() + datacatalogue.gateway.import_dataset.side_effect = RequestException(validation_message) storage_handler._DataCatalogue__build_storage_table_root_url.return_value = target_path @@ -114,6 +115,7 @@ def test_save_gateway_failure_triggers_rollback(mock_dependencies, storage_handl assert "error" in result assert "error_type" in result + assert validation_message in result["error"] datacatalogue.gateway.import_dataset.assert_called_once() datacatalogue._rollback_write.assert_called_once() diff --git a/tests/test_gateway.py b/tests/test_gateway.py index 0d5ec2d..ba64389 100644 --- a/tests/test_gateway.py +++ b/tests/test_gateway.py @@ -37,7 +37,16 @@ def test_import_dataset_success(mock_gateway, mock_post): def test_import_dataset_failure(mock_gateway, mock_post): """Test dataset import failure.""" - response_body = {"type":"BusinessError","traceId":"8b01e7eb14484611add6138618daf112"} + validation_message = "Either SchemaVersionId or SchemaId must be provided. Schemas are not created on import." + trace_id = "8b01e7eb14484611add6138618daf112" + response_body = { + "type": "ValidationError", + "title": "One or more validation errors occurred.", + "status": 400, + "detail": f"Validation failed: -- SchemaVersionId: {validation_message}", + "errors": {"SchemaVersionId": [validation_message]}, + "traceId": trace_id, + } mock_response = MagicMock() mock_response.return_value.status_code = 400 @@ -50,7 +59,8 @@ def test_import_dataset_failure(mock_gateway, mock_post): mock_post.return_value = mock_response with pytest.raises(RequestException) as e: - mock_gateway.import_dataset("dataset_name", "dataset_description", "schema_id", {"tag": "value"}, "folder_id") + mock_gateway.import_dataset("dataset_name", "dataset_description", None, {"tag": "value"}, "folder_id") - assert e.value.args[0] == f"Failed to create data catalog entry. correlation-id: {response_body['traceId']}" + assert validation_message in e.value.args[0] + assert f"correlation-id: {trace_id}" in e.value.args[0] mock_post.assert_called_once() From b9c2178449335c225a36888560cbb150b305f704 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 28 Oct 2026 08:17:33 +0000 Subject: [PATCH 2/2] Add gateway error tests for errors fallback and trace-only Co-authored-by: micsoko <175594233+micsoko@users.noreply.github.com> --- tests/test_gateway.py | 44 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/tests/test_gateway.py b/tests/test_gateway.py index ba64389..c7c29fe 100644 --- a/tests/test_gateway.py +++ b/tests/test_gateway.py @@ -64,3 +64,47 @@ def test_import_dataset_failure(mock_gateway, mock_post): assert validation_message in e.value.args[0] assert f"correlation-id: {trace_id}" in e.value.args[0] mock_post.assert_called_once() + + +def _failing_response(mock_post, response_body): + mock_response = MagicMock() + mock_response.text = json.dumps(response_body) + http_error = requests.exceptions.HTTPError() + http_error.response = mock_response + mock_response.raise_for_status.side_effect = http_error + mock_post.return_value = mock_response + + +def test_import_dataset_failure_without_detail_uses_errors(mock_gateway, mock_post): + """Without `detail`, all field/message entries from `errors` are reported.""" + trace_id = "trace-123" + _failing_response( + mock_post, + { + "errors": { + "SchemaVersionId": ["first problem", "second problem"], + "Name": ["name problem"], + }, + "traceId": trace_id, + }, + ) + + with pytest.raises(RequestException) as e: + mock_gateway.import_dataset("n", "d", None, {"tag": "value"}, "folder_id") + + message = e.value.args[0] + assert "SchemaVersionId: first problem" in message + assert "SchemaVersionId: second problem" in message + assert "Name: name problem" in message + assert f"correlation-id: {trace_id}" in message + + +def test_import_dataset_failure_trace_only(mock_gateway, mock_post): + """A response with only a trace ID still reports the correlation ID.""" + trace_id = "trace-456" + _failing_response(mock_post, {"traceId": trace_id}) + + with pytest.raises(RequestException) as e: + mock_gateway.import_dataset("n", "d", None, {"tag": "value"}, "folder_id") + + assert f"correlation-id: {trace_id}" in e.value.args[0]