Merge pull request #28 from nludb/response-error-refactor

Response error refactor

Author: dkolas

src/steamship/base/client.py

@@ -276,16 +276,16 @@ def call(
                 # if task_resp is not None and task_resp.taskId is not None:
                 #     task = Task(client=self)
                 #     task.update(task_resp)
+                if 'state' in responseData['status']:
+                    if responseData['status']['state'] == 'failed':
+                        error = SteamshipError.from_dict(responseData['status'], client=self)
 
             if 'data' in responseData:
                 if expect is not None and hasattr(expect, 'from_dict'):
                     obj = expect.from_dict(responseData['data'], client=self)
                 else:
                     obj = responseData['data']
 
-            if 'error' in responseData:
-                error = SteamshipError.from_dict(responseData['error'], client=self)
-
             if 'reason' in responseData:
                 # This is a legacy error reporting field. We should work toward being comfortable
                 # removing this handler.

src/steamship/base/error.py

@@ -2,16 +2,16 @@
 
 
 class SteamshipError(Exception):
-    message: str = None
-    suggestion: str = None
-    code: str = None
+    statusMessage: str = None
+    statusSuggestion: str = None
+    statusCode: str = None
     error: str = None
 
     def __init__(self, message: str = "Undefined remote error", suggestion: str = None, code: str = None,
                  error: Exception = None):
-        self.message = message
-        self.suggestion = suggestion
-        self.code = code
+        self.statusMessage = message
+        self.statusSuggestion = suggestion
+        self.statusCode = code
         if error is not None:
             self.error = "{}".format(error)
 
@@ -29,7 +29,7 @@ def __init__(self, message: str = "Undefined remote error", suggestion: str = No
     def from_dict(d: any, client: Any = None) -> "SteamshipError":
         """Last resort if subclass doesn't override: pass through."""
         return SteamshipError(
-            message=d.get('message', None),
-            suggestion=d.get('suggestion', None),
-            code=d.get('code', None)
+            message=d.get('statusMessage', None),
+            suggestion=d.get('statusSuggestion', None),
+            code=d.get('statusCode', None)
         )

src/steamship/base/response.py

@@ -29,7 +29,7 @@ def wait(self, max_timeout_s: float = 60, retry_delay_s: float = 1):
 
         self.check()
         if self.task is not None:
-            if self.task.taskStatus == TaskStatus.succeeded or self.task.taskStatus == TaskStatus.failed:
+            if self.task.state == TaskStatus.succeeded or self.task.state == TaskStatus.failed:
                 return
         else:
             return
@@ -39,7 +39,7 @@ def wait(self, max_timeout_s: float = 60, retry_delay_s: float = 1):
             time.sleep(retry_delay_s)
             self.check()
             if self.task is not None:
-                if self.task.taskStatus == TaskStatus.succeeded or self.task.taskStatus == TaskStatus.failed:
+                if self.task.state == TaskStatus.succeeded or self.task.state == TaskStatus.failed:
                     return
             else:
                 return

src/steamship/base/tasks.py

@@ -143,8 +143,8 @@ class Task(Generic[T]):
     """Encapsulates a unit of asynchronously performed work."""
     client: Any = None
     taskId: str = None
-    taskStatus: str = None
-    taskStatusMessage: str = None
+    state: str = None
+    statusMessage: str = None
     taskCreatedOn: str = None
     taskLastModifiedOn: str = None
     # eob: This is typed wrong, but I'm not sure how to type it..
@@ -156,8 +156,8 @@ def from_dict(d: any, client: Any = None) -> "Task":
         return Task(
             client=client,
             taskId=d.get('taskId', None),
-            taskStatus=d.get('taskStatus', None),
-            taskStatusMessage=d.get('taskStatusMessage', None),
+            state=d.get('state', None),
+            statusMessage=d.get('statusMessage', None),
             taskCreatedOn=d.get('taskCreatedOn', None),
             taskLastModifiedOn=d.get('taskLastModifiedOn', None)
         )
@@ -166,12 +166,12 @@ def update(self, other: "Task"):
         """Incorporates a `Task` into this object."""
         if other is not None:
             self.taskId = other.taskId
-            self.taskStatus = other.taskStatus
-            self.taskStatusMessage = other.taskStatusMessage
+            self.state = other.state
+            self.statusMessage = other.statusMessage
             self.taskCreatedOn = other.taskCreatedOn
             self.taskLastModifiedOn = other.taskLastModifiedOn
         else:
-            self.taskStatus = None
+            self.state = None
 
     def add_comment(self, externalId: str = None, externalType: str = None, externalGroup: str = None,
                     metadata: any = None, upsert: bool = True) -> IResponse[TaskComment]:

tests/client/test_embedding_index.py

@@ -134,12 +134,12 @@ def test_embed_task():
         res = index.embed()
 
         assert (res.task.taskId is not None)
-        assert (res.task.taskStatus is not None)
+        assert (res.task.state is not None)
         assert (res.task.taskCreatedOn is not None)
         assert (res.task.taskLastModifiedOn is not None)
-        assert (res.task.taskStatus == TaskStatus.waiting)
+        assert (res.task.state == TaskStatus.waiting)
         res.wait()
-        assert (res.task.taskStatus == TaskStatus.succeeded)
+        assert (res.task.state == TaskStatus.succeeded)
 
 
 def test_duplicate_inserts():
@@ -168,7 +168,7 @@ def test_index_usage():
         task = index.embed()
         task.wait()
         task.check()
-        assert (task.task.taskStatus == TaskStatus.succeeded)
+        assert (task.task.state == TaskStatus.succeeded)
 
         search_results = index.search(Q1)
         assert (len(search_results.data.hits) == 1)

tests/client/test_file.py

@@ -114,12 +114,12 @@ def test_file_upload_then_parse():
     task = a.convert(plugin="markdown-converter-default-v1")
     assert (task.error is None)
     assert (task.task is not None)
-    assert (task.task.taskStatus == TaskStatus.waiting)
+    assert (task.task.state == TaskStatus.waiting)
 
     task.wait()
     assert (task.error is None)
     assert (task.task is not None)
-    assert (task.task.taskStatus == TaskStatus.succeeded)
+    assert (task.task.state == TaskStatus.succeeded)
 
     q1 = a.query().data
     assert (len(q1.blocks) == 2)

tests/client/test_file_parse.py

@@ -52,12 +52,12 @@ def parse_file(client: Client, parserModel: str):
     task = a.parse(plugin="test-parser-v1")
     assert (task.error is None)
     assert (task.task is not None)
-    assert (task.task.taskStatus == TaskStatus.waiting)
+    assert (task.task.state == TaskStatus.waiting)
 
     task.wait()
     assert (task.error is None)
     assert (task.task is not None)
-    assert (task.task.taskStatus == TaskStatus.succeeded)
+    assert (task.task.state == TaskStatus.succeeded)
 
     # Now the sentences should be parsed!
     q2 = a.query(blockType=BlockTypes.Sentence).data

tests/client/test_snapshots.py

@@ -17,7 +17,7 @@ def _insert(index, items):
     task = index.embed()
     task.wait()
     task.check()
-    assert (task.task.taskStatus == TaskStatus.succeeded)
+    assert (task.task.state == TaskStatus.succeeded)
 
 
 def _snapshot(index, windowSize=None):

tests/demo_apps/demo_app.py

@@ -55,9 +55,9 @@ def learn(self, fact: str = None) -> Response:
             # Steamship error messages can be passed straight
             # back to the user
             return Error(
-                message=res.error.message,
-                suggestion=res.error.suggestion,
-                code=res.error.code
+                message=res.error.statusMessage,
+                suggestion=res.error.statusSuggestion,
+                code=res.error.statusCode
             )
 
         return Response(json=res.data)
@@ -77,9 +77,9 @@ def query(self, query: str = None, k: int = 1) -> Response:
             # Steamship error messages can be passed straight
             # back to the user
             return Error(
-                message=res.error.message,
-                suggestion=res.error.suggestion,
-                code=res.error.code
+                message=res.error.statusMessage,
+                suggestion=res.error.statusSuggestion,
+                code=res.error.statusCode
             )
 
         return Response(json=res.data)