Exception enhancements (#90)

* added the dummy flag to swap over to localhost

* Moving from fork

* added fastAPI and uvicorn support for fastAPI service; added basic algorithm_HTTP response failure handling (for 5xx errors).

* make sure that fastAPI is actually installed during testing

* migrated all testing logic out of the Client

* Moving from fork

* added fastAPI and uvicorn support for fastAPI service; added basic algorithm_HTTP response failure handling (for 5xx errors).

* make sure that fastAPI is actually installed during testing

* cleaned up dependencies

* removed dummy from client in init

* remove all changes made by Daniels PR

* more adaptions to separate Daniels PR

* cleaning up blank space and correcting changes

* added blankspaces to simplify changelog

* fixed typo in exception test

* ensured we were importing the right app into our test case

* pytest is run from root, not relative test dir

* added a newline

Co-authored-by: Daniel Rodriguez <daniel@danielfrg.com>

Author: zeryx

Algorithmia/CLI.py

@@ -22,7 +22,7 @@ def auth(self, apikey, apiaddress, cacert="", profile="default"):
                 config['profiles'][profile]['api_key'] = apikey
                 config['profiles'][profile]['api_server'] = apiaddress
                 config['profiles'][profile]['ca_cert'] = cacert
-                
+
             else:
                 config['profiles'][profile] = {'api_key':apikey,'api_server':apiaddress,'ca_cert':cacert}
         else:
@@ -299,7 +299,7 @@ def getconfigfile(self):
             #%LOCALAPPDATA%\Algorithmia\config
             #create the api key file if it does not exist
             keyPath = os.path.expandvars("%LOCALAPPDATA%\\Algorithmia\\")
-        
+
         keyFile = "config"
 
         if(not os.path.exists(keyPath)):

Algorithmia/__main__.py

@@ -124,7 +124,7 @@ def main():
         if len(APIkey) == 28 and APIkey.startswith("sim"):
             if APIaddress == "" or not APIaddress.startswith("https://api."):
                 APIaddress = "https://api.algorithmia.com"
-            
+
             CLI().auth(apikey=APIkey, apiaddress=APIaddress, cacert=CACert, profile=args.profile)
         else:
             print("invalid api key")

Algorithmia/algo_response.py

@@ -18,21 +18,21 @@ def __repr__(self):
             return self.__unicode__().encode('utf-8')
 
     @staticmethod
-    def create_algo_response(responseJson):
-        # Parse response JSON
-        if 'error' in responseJson:
+    def create_algo_response(response):
+        # Parse response JSON, if it's indeed JSON
+        if 'error' in response or 'metadata' not in response:
             # Failure
-            raise raiseAlgoApiError(responseJson)
+            raise raiseAlgoApiError(response)
         else:
-            metadata = Metadata(responseJson['metadata'])
+            metadata = Metadata(response['metadata'])
             # Success, check content_type
-            if responseJson['metadata']['content_type'] == 'binary':
+            if response['metadata']['content_type'] == 'binary':
                 # Decode Base64 encoded binary file
-                return AlgoResponse(base64.b64decode(responseJson['result']), metadata)
-            elif responseJson['metadata']['content_type'] == 'void':
+                return AlgoResponse(base64.b64decode(response['result']), metadata)
+            elif response['metadata']['content_type'] == 'void':
                 return AlgoResponse(None, metadata)
             else:
-                return AlgoResponse(responseJson['result'], metadata)
+                return AlgoResponse(response['result'], metadata)
 
 class Metadata(object):
     def __init__(self, metadata):

Algorithmia/client.py

@@ -41,7 +41,7 @@ def __init__(self, apiKey = None, apiAddress = None, caCert = None):
             self.catCerts(caCert)
             self.requestSession.verify = self.ca_cert
         elif caCert is not None and 'REQUESTS_CA_BUNDLE' in os.environ:
-            #if both are available, use the one supplied in the constructor. I assume that a user supplying a cert in initialization wants to use that one. 
+            #if both are available, use the one supplied in the constructor. I assume that a user supplying a cert in initialization wants to use that one.
             self.catCerts(caCert)
             self.requestSession.verify = self.ca_cert
 
@@ -141,7 +141,7 @@ def postJsonHelper(self, url, input_object, parse_response_as_json=True, **query
 
         response = self.requestSession.post(self.apiAddress + url, data=input_json, headers=headers, params=query_parameters)
 
-        if parse_response_as_json:
+        if parse_response_as_json and response.status_code == 200:
             return response.json()
         return response
 

Test/algo_failure_test.py

@@ -0,0 +1,34 @@
+import sys
+from multiprocessing import Process
+# look in ../ BEFORE trying to import Algorithmia.  If you append to the
+# you will load the version installed on the computer.
+sys.path = ['../'] + sys.path
+
+import unittest
+import Algorithmia
+import uvicorn
+import time
+from requests import Response
+from Test.api import app
+
+def start_webserver():
+    uvicorn.run(app, host="127.0.0.1", port=8080, log_level="debug")
+
+class AlgoTest(unittest.TestCase):
+    error_500 = Response()
+    error_500.status_code = 500
+
+    def setUp(self):
+        self.client = Algorithmia.client(api_address="http://localhost:8080")
+        self.uvi_p = Process(target=start_webserver)
+        self.uvi_p.start()
+        time.sleep(1)
+    def tearDown(self):
+        self.uvi_p.terminate()
+    def test_throw_500_error_HTTP_response_on_algo_request(self):
+        try:
+            result = self.client.algo('util/Echo').pipe(bytearray('foo','utf-8'))
+        except Exception as e:
+            result = e
+            pass
+        self.assertEqual(str(self.error_500), str(result))

Test/api/__init__.py

@@ -0,0 +1,16 @@
+import importlib
+from fastapi import FastAPI, Response
+
+app = FastAPI()
+
+@app.post("/v1/{username}/{algoname}/{version}")
+async def throw_error(username, algoname, version):
+    return Response("Internal Server Error", status_code=500)
+
+
+def create_endpoint(algoname):
+    module = importlib.import_module(algoname)
+    @app.get("/invocations")
+    def invocations(data):
+         return module.apply(data)
+

requirements.txt

@@ -6,3 +6,5 @@ argparse
 algorithmia-api-client>=1.3,<1.4
 algorithmia-adk>=1.0.2,<1.1
 numpy<2
+uvicorn==0.14.0
+fastapi==0.65.2