JSON parsing error handling when server returns string

Internal JIRA Ticket: IMAGEKIT-132

Author: ahnv

imagekitio/file.py

@@ -10,6 +10,10 @@
     snake_to_lower_camel,
 )
 
+try:
+    from simplejson.errors import JSONDecodeError
+except ImportError:
+    from json import JSONDecodeError
 
 class File(object):
     def __init__(self, request_obj):
@@ -47,7 +51,10 @@ def upload(self, file, file_name, options) -> Dict:
         )
 
         if resp.status_code > 200:
-            error = resp.json()
+            try:
+                error = resp.json()
+            except JSONDecodeError:
+                error = resp.text
             response = None
         else:
             error = None

tests/helpers.py

@@ -6,6 +6,10 @@
 
 from imagekitio.client import ImageKit
 from tests.dummy_data.file import AUTHENTICATION_ERR_MSG, SUCCESS_GENERIC_RESP
+try:
+    from simplejson.errors import JSONDecodeError
+except ImportError:
+    from json import JSONDecodeError
 
 
 class ClientTestCase(unittest.TestCase):
@@ -41,6 +45,16 @@ def get_mocked_failed_resp(message=None, status=401):
     return mocked_resp
 
 
+def get_mocked_failed_resp_text():
+    """GET failed mocked response returned as text not json
+    """
+    mocked_resp = Mock(spec=Response)
+    mocked_resp.status_code = 502
+    mocked_resp.text = 'Bad Gateway'
+    mocked_resp.json.side_effect = JSONDecodeError("Expecting value: ", "Bad Gateway", 0)
+    return mocked_resp
+
+
 def get_mocked_success_resp(message: dict = None, status: int = 200):
     """GET success mocked response customize by parameter
     """

tests/test_files_ops.py

@@ -15,6 +15,7 @@
 from tests.helpers import (
     ClientTestCase,
     get_mocked_failed_resp,
+    get_mocked_failed_resp_text,
     get_mocked_success_resp,
 )
 from imagekitio.utils.formatter import request_formatter
@@ -173,6 +174,27 @@ def test_upload_file_fails_without_file_or_file_name(self) -> None:
         self.assertRaises(TypeError, self.client.upload_file, file_name=self.filename)
         self.assertRaises(TypeError, self.client.upload_file, file=self.image)
 
+    def test_upload_file_fails_without_json_response_from_server(self) -> None:
+        """Test upload raises error on non json response
+        """
+        self.client.ik_request.request = MagicMock(
+            return_value=get_mocked_failed_resp_text()
+        )
+        resp = self.client.upload(
+            file=self.image,
+            file_name="fileabc",
+            options={
+                "is_private_file": True,
+                "tags": ["abc"],
+                "response_fields": ["is_private_file", "tags"],
+                "custom_coordinates": "10,10,100,100",
+                "use_unique_file_name": True,
+                "folder": "abc"
+            }
+        )
+        self.assertIsNotNone(resp["error"])
+        self.assertIsNone(resp["response"])
+
 
 class TestListFiles(ClientTestCase):
     """