Render API errors in a more user-friendly way (#34)

Author: derek-globus

changelog.d/20260220_092702_derek_smoother_error_messaging.rst

@@ -0,0 +1,4 @@
+Changed
+-------
+
+*   Render API errors in a more user-friendly way.

src/globus_registered_api/cli.py

@@ -5,13 +5,14 @@
 
 from __future__ import annotations
 
+import json
 import os
-import sys
 import typing as t
 from collections.abc import Iterable
 from uuid import UUID
 
 import click
+import click.exceptions
 from globus_sdk import AuthClient
 from globus_sdk import ClientApp
 from globus_sdk import FlowsClient
@@ -119,8 +120,10 @@ def _handle_globus_api_error(err: GlobusAPIError) -> None:
             "to re-authenticate.",
             err=True,
         )
-        sys.exit(1)
-    raise err
+    else:
+        msg = json.dumps(err.raw_json, indent=2)
+        click.secho(msg, fg="yellow", err=True)
+    raise click.exceptions.Exit(code=1)
 
 
 class ExceptionHandlingGroup(click.Group):

tests/commands/api/test_create.py

@@ -369,7 +369,7 @@ def test_create_registered_api_api_error(gra, patch_create, spec_path):
 
     # Assert
     assert result.exit_code != 0
-    assert "Invalid target specification" in str(result.exception)
+    assert "Invalid target specification" in result.stderr
 
 
 @pytest.mark.parametrize(

tests/commands/api/test_delete.py

@@ -100,7 +100,7 @@ def test_delete_registered_api_not_found(gra, patch_delete):
     result = gra(["api", "delete", api_id])
 
     assert result.exit_code != 0
-    assert "No Registered API exists" in str(result.exception)
+    assert "No Registered API exists" in result.stderr
 
 
 def test_delete_registered_api_forbidden(gra, patch_delete):
@@ -119,7 +119,7 @@ def test_delete_registered_api_forbidden(gra, patch_delete):
     result = gra(["api", "delete", api_id])
 
     assert result.exit_code != 0
-    assert "FORBIDDEN" in str(result.exception)
+    assert "FORBIDDEN" in result.stderr
 
 
 def test_delete_registered_api_invalid_uuid(gra):

tests/commands/api/test_show.py

@@ -112,4 +112,4 @@ def test_get_registered_api_not_found(gra, patch_show):
     result = gra(["api", "show", api_id])
 
     assert result.exit_code != 0
-    assert "No Registered API exists" in str(result.exception)
+    assert "No Registered API exists" in result.stderr

tests/commands/api/test_update.py

@@ -108,7 +108,7 @@ def test_update_registered_api_not_found(gra, patch_update):
     result = gra(["api", "update", api_id, "--name", "Test"])
 
     assert result.exit_code != 0
-    assert "No Registered API exists" in str(result.exception)
+    assert "No Registered API exists" in result.stderr
 
 
 def test_update_registered_api_with_description(gra, patch_update):

tests/test_error_handling.py

@@ -5,6 +5,7 @@
 
 from unittest.mock import MagicMock
 
+import click.exceptions
 import pytest
 from globus_sdk import GlobusAPIError
 
@@ -15,29 +16,33 @@ def _make_api_error(code: str) -> GlobusAPIError:
     """Create a GlobusAPIError with a specific error code."""
     err = MagicMock(spec=GlobusAPIError)
     err.code = code
-    err.message = None
+    err.message = "Something is very wrong here."
     # Make it a proper exception so it can be raised
     err.__class__ = GlobusAPIError
+    err.raw_json = {"code": code, "message": "Something is very wrong here."}
     return err
 
 
 def test_handle_auth_error_exits_with_message(capsys):
     err = _make_api_error("AUTHENTICATION_ERROR")
 
-    with pytest.raises(SystemExit) as exc_info:
+    with pytest.raises(click.exceptions.Exit) as exc_info:
         _handle_globus_api_error(err)
 
-    assert exc_info.value.code == 1
+    assert exc_info.value.exit_code == 1
     captured = capsys.readouterr()
     assert "Authentication Error" in captured.err
     assert "globus-registered-api logout" in captured.err
     assert "globus-registered-api whoami" in captured.err
 
 
-def test_handle_non_auth_error_reraises():
+def test_handle_non_auth_error_reraises(capsys):
     err = _make_api_error("NOT_FOUND")
 
-    with pytest.raises(TypeError):
-        # TypeError because mock can't be raised, but this proves the
-        # function attempted to re-raise rather than handling the error
+    with pytest.raises(click.exceptions.Exit) as exc_info:
         _handle_globus_api_error(err)
+
+    assert exc_info.value.exit_code == 1
+    captured = capsys.readouterr()
+    assert err.code in captured.err
+    assert err.message in captured.err