fix(FIR-42216): improve authentication error message (#409)

Author: ptiurin

src/firebolt/client/auth/request_auth_base.py

@@ -1,11 +1,11 @@
 from time import time
 from typing import Generator
 
-from httpx import Request, Response
+from httpx import Request, Response, codes
 
 from firebolt.client.auth.base import Auth
 from firebolt.client.constants import _REQUEST_ERRORS
-from firebolt.utils.exception import AuthenticationError
+from firebolt.utils.exception import AuthenticationError, AuthorizationError
 from firebolt.utils.usage_tracker import get_user_agent_header
 
 
@@ -54,4 +54,6 @@ def get_new_token_generator(self) -> Generator[Request, Response, None]:
             self._expires = int(time()) + int(parsed["expires_in"])
 
         except _REQUEST_ERRORS as e:
+            if e.response.status_code == codes.UNAUTHORIZED:
+                raise AuthorizationError()
             raise AuthenticationError(repr(e)) from e

src/firebolt/utils/exception.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict
+from typing import Any, Dict, Optional
 
 
 class FireboltError(Exception):
@@ -179,17 +179,22 @@ def __init__(self, cause: str):
 
 
 class AuthorizationError(FireboltError):
-    """Firebolt authentication error.
+    """Firebolt authorisation error.
 
     Args:
         cause (str): Reason for authorization failure
 
-    Attributes:
-        cause (str): Reason for authorization failure
     """
 
-    def __init__(self, cause: str):
-        super().__init__(f"Authorization failed: {cause}.")
+    _default_error_message = (
+        "Failed to connect to Firebolt. Could not authenticate with the given "
+        "credentials. Please verify the provided credentials are up to date and "
+        "correct and that you have the correct user permissions"
+    )
+
+    def __init__(self, cause: Optional[str] = None):
+        error_cause = cause if cause else self._default_error_message
+        super().__init__(f"Authorization failed: {error_cause}.")
 
 
 # PEP-249

tests/unit/client/auth/test_request_auth.py

@@ -6,7 +6,7 @@
 from pytest_mock import MockerFixture
 
 from firebolt.client.auth import ClientCredentials
-from firebolt.utils.exception import AuthenticationError
+from firebolt.utils.exception import AuthenticationError, AuthorizationError
 from tests.unit.util import execute_generator_requests
 
 
@@ -44,6 +44,16 @@ def http_error(*args, **kwargs):
         assert str(excinfo.value) == "httpx", "Invalid authentication error message"
         httpx_mock.reset(True)
 
+        # HTTP error
+        httpx_mock.add_response(status_code=codes.UNAUTHORIZED)
+        with pytest.raises(AuthorizationError) as excinfo:
+            execute_generator_requests(auth.get_new_token_generator(), api_endpoint)
+        errmsg = str(excinfo.value)
+        assert (
+            "Please verify the provided credentials" in errmsg
+        ), "Invalid authorization error message"
+        httpx_mock.reset(True)
+
         # HTTP error
         httpx_mock.add_response(status_code=codes.BAD_REQUEST)
         with pytest.raises(AuthenticationError) as excinfo: