Merge pull request #57 from fingerprintjs/INTER-795-improve-response-transparency

Add better error reporting in case of wrong data shape

Author: ilfa

.github/workflows/coverage-diff.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.12"
       - name: "Install dependencies"
         run: |
           python -m pip install --upgrade pip
@@ -22,7 +22,7 @@ jobs:
           coverage run --source=fingerprint_pro_server_api_sdk -m pytest
           coverage xml
       - name: Get Cover
-        uses: orgoro/coverage@d77626a5fa35d39123e86d6c62907fabe2491496
+        uses: orgoro/coverage@3f13a558c5af7376496aa4848bf0224aead366ac
         with:
           coverageFile: ./coverage.xml
-          token: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/coverage-report.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.12"
       - name: "Install dependencies"
         run: |
           python -m pip install --upgrade pip
@@ -38,4 +38,4 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@8817a56e5bfec6e2b08345c81f4d422db53a2cdc
         with:
           branch: gh-pages
-          folder: htmlcov
+          folder: htmlcov

.github/workflows/functional_tests.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.12"
       - name: "Install dependencies"
         run: |
           python -m pip install --upgrade pip

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     with:
       appId: ${{ vars.APP_ID }}
       language: python
-      language-version: '3.9'
+      language-version: '3.12'
       semantic-release-extra-plugins: |
         [email protected]
       prepare-command: |

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
         python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12", "pypy3.10" ]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: "${{ matrix.python-version }}"

fingerprint_pro_server_api_sdk/api_client.py

@@ -24,6 +24,7 @@
 from fingerprint_pro_server_api_sdk.configuration import Configuration
 import fingerprint_pro_server_api_sdk.models
 from fingerprint_pro_server_api_sdk import rest
+from fingerprint_pro_server_api_sdk.rest import ApiException
 
 
 class ApiClient(object):
@@ -161,12 +162,17 @@ def __call_api(
         self.last_response = response_data
 
         return_data = response_data
-        if _preload_content:
-            # deserialize response data
-            if response_type:
-                return_data = self.deserialize(response_data, response_type)
-            else:
-                return_data = None
+        try:
+            if _preload_content:
+                # deserialize response data
+                if response_type:
+                    return_data = self.deserialize(response_data, response_type)
+                else:
+                    return_data = None
+        except ValueError as e:
+            error = ApiException(http_resp=response_data)
+            error.reason = e
+            raise error
 
         if _return_http_data_only:
             return (return_data)

template/api_client.mustache

@@ -19,6 +19,7 @@ import tornado.gen
 from {{packageName}}.configuration import Configuration
 import {{modelPackage}}
 from {{packageName}} import rest
+from {{packageName}}.rest import ApiException
 
 
 class ApiClient(object):
@@ -159,12 +160,17 @@ class ApiClient(object):
         self.last_response = response_data
 
         return_data = response_data
-        if _preload_content:
-            # deserialize response data
-            if response_type:
-                return_data = self.deserialize(response_data, response_type)
-            else:
-                return_data = None
+        try:
+            if _preload_content:
+                # deserialize response data
+                if response_type:
+                    return_data = self.deserialize(response_data, response_type)
+                else:
+                    return_data = None
+        except ValueError as e:
+            error = ApiException(http_resp=response_data)
+            error.reason = e
+            raise error
 
 {{^tornado}}
         if _return_http_data_only: