Merge pull request #85 from alexaustin007/main

fix: handle JSONDecodeError in _handle_response to prevent crashes

Author: gagebenne

pydexcom/dexcom.py

@@ -24,6 +24,8 @@
     ArgumentError,
     ArgumentErrorEnum,
     DexcomError,
+    ServerError,
+    ServerErrorEnum,
     SessionError,
     SessionErrorEnum,
 )
@@ -93,50 +95,50 @@ def _post(
         )
 
         try:
+            response_json = response.json()
             response.raise_for_status()
-            return response.json()
         except requests.HTTPError as http_error:
-            error = self._handle_response(response)
-            if error:
-                raise error from http_error
-            _LOGGER.exception("%s", response.text)
-            raise
-
-    def _handle_response(self, response: requests.Response) -> DexcomError | None:  # noqa: C901
-        error: DexcomError | None = None
+            raise self._handle_error_code(response_json) from http_error
+        except requests.JSONDecodeError as json_error:
+            _LOGGER.exception("JSON decode error: %s", response.text)
+            raise ServerError(ServerErrorEnum.INVALID_JSON) from json_error
+        else:
+            return response_json
+
+    def _handle_error_code(self, json: dict[str, Any]) -> DexcomError:  # noqa: C901, PLR0911
         """
-        Parse `requests.Response` for `pydexcom.errors.DexcomError`.
+        Parse `requests.Response` JSON for `pydexcom.errors.DexcomError`.
 
-        :param response: `requests.Response` to parse
+        :param response: `requests.Response` JSON to parse
         """
-        if response.json():
-            _LOGGER.debug("%s", response.json())
-            code = response.json().get("Code", None)
-            message = response.json().get("Message", None)
-            if code == "SessionIdNotFound":
-                error = SessionError(SessionErrorEnum.NOT_FOUND)
-            elif code == "SessionNotValid":
-                error = SessionError(SessionErrorEnum.INVALID)
-            elif code == "AccountPasswordInvalid":  # defunct
-                error = AccountError(AccountErrorEnum.FAILED_AUTHENTICATION)
-            elif code == "SSO_AuthenticateMaxAttemptsExceeded":
-                error = AccountError(AccountErrorEnum.MAX_ATTEMPTS)
-            elif code == "SSO_InternalError":
-                if message and (
-                    "Cannot Authenticate by AccountName" in message
-                    or "Cannot Authenticate by AccountId" in message
-                ):
-                    error = AccountError(AccountErrorEnum.FAILED_AUTHENTICATION)
-            elif code == "InvalidArgument":
-                if message and "accountName" in message:
-                    error = ArgumentError(ArgumentErrorEnum.USERNAME_INVALID)
-                elif message and "password" in message:
-                    error = ArgumentError(ArgumentErrorEnum.PASSWORD_INVALID)
-                elif message and "UUID" in message:
-                    error = ArgumentError(ArgumentErrorEnum.ACCOUNT_ID_INVALID)
-            elif code and message:
-                _LOGGER.debug("%s: %s", code, message)
-        return error
+        _LOGGER.debug("%s", json)
+        code, message = json.get("Code"), json.get("Message")
+        if code == "SessionIdNotFound":
+            return SessionError(SessionErrorEnum.NOT_FOUND)
+        if code == "SessionNotValid":
+            return SessionError(SessionErrorEnum.INVALID)
+        if code == "AccountPasswordInvalid":
+            return AccountError(AccountErrorEnum.FAILED_AUTHENTICATION)
+        if code == "SSO_AuthenticateMaxAttemptsExceeded":
+            return AccountError(AccountErrorEnum.MAX_ATTEMPTS)
+        if code == "SSO_InternalError":  # noqa: SIM102
+            if message and (
+                "Cannot Authenticate by AccountName" in message
+                or "Cannot Authenticate by AccountId" in message
+            ):
+                return AccountError(AccountErrorEnum.FAILED_AUTHENTICATION)
+        if code == "InvalidArgument":
+            if message and "accountName" in message:
+                return ArgumentError(ArgumentErrorEnum.USERNAME_INVALID)
+            if message and "password" in message:
+                return ArgumentError(ArgumentErrorEnum.PASSWORD_INVALID)
+            if message and "UUID" in message:
+                return ArgumentError(ArgumentErrorEnum.ACCOUNT_ID_INVALID)
+        if code and message:
+            _LOGGER.error("%s: %s", code, message)
+            return ServerError(ServerErrorEnum.UNKNOWN_CODE)
+        _LOGGER.error("%s", json)
+        return ServerError(ServerErrorEnum.UNEXPECTED)
 
     def _validate_region(self, region: Region) -> None:
         if region not in list(Region):

pydexcom/errors.py

@@ -38,6 +38,14 @@ class ArgumentErrorEnum(DexcomErrorEnum):
     GLUCOSE_READING_INVALID = "JSON glucose reading incorrectly formatted"
 
 
+class ServerErrorEnum(DexcomErrorEnum):
+    """`ServerErrorEnum` strings."""
+
+    INVALID_JSON = "Invalid or malformed JSON in server response"
+    UNKNOWN_CODE = "Unknown error code in server response"
+    UNEXPECTED = "Unexpected server response"
+
+
 class DexcomError(Exception):
     """Base class for all `pydexcom` errors."""
 
@@ -70,3 +78,7 @@ class SessionError(DexcomError):
 
 class ArgumentError(DexcomError):
     """Errors involving `pydexcom` arguments."""
+
+
+class ServerError(DexcomError):
+    """Errors involving unexpected or malformed server responses."""