Add back support for readable errors for labeling service

Author: Val Brodsky

libs/labelbox/pyproject.toml

@@ -12,7 +12,7 @@ dependencies = [
     "tqdm>=4.66.2",
     "geojson>=3.1.0",
     "mypy==1.10.1",
-    "lbox-clients==1.0.0",
+    "lbox-clients==1.1.0",
 ]
 readme = "README.md"
 requires-python = ">=3.8"

libs/labelbox/src/labelbox/client.py

@@ -8,7 +8,7 @@
 import urllib.parse
 from collections import defaultdict
 from types import MappingProxyType
-from typing import Any, Dict, List, Optional, Union, overload
+from typing import Any, Callable, Dict, List, Optional, Union, overload
 
 import lbox.exceptions
 import requests
@@ -159,6 +159,9 @@ def execute(
         experimental=False,
         error_log_key="message",
         raise_return_resource_not_found=False,
+        error_handlers: Optional[
+            Dict[str, Callable[[requests.models.Response], None]]
+        ] = None,
     ) -> Dict[str, Any]:
         """Executes a GraphQL query.
 
@@ -167,6 +170,8 @@ def execute(
             variables (dict): Variables to pass to the query.
             raise_return_resource_not_found (bool): If True, raise a
                 ResourceNotFoundError if the query returns None.
+            error_handlers (dict): A dictionary mapping graphql error code to handler functions.
+                Allows a caller to handle specific errors reporting in a custom way or produce more user-friendly readable messages
 
         Returns:
             dict: The response from the server.
@@ -180,6 +185,7 @@ def execute(
             experimental=experimental,
             error_log_key=error_log_key,
             raise_return_resource_not_found=raise_return_resource_not_found,
+            error_handlers=error_handlers,
         )
 
     def upload_file(self, path: str) -> str:

libs/labelbox/src/labelbox/schema/labeling_service.py

@@ -1,7 +1,8 @@
+import json
 from datetime import datetime
 from typing import Any
 
-from lbox.exceptions import ResourceNotFoundError
+from lbox.exceptions import LabelboxError, ResourceNotFoundError
 
 from labelbox.schema.labeling_service_dashboard import LabelingServiceDashboard
 from labelbox.schema.labeling_service_status import LabelingServiceStatus
@@ -105,12 +106,24 @@ def request(self) -> "LabelingService":
             query_str,
             {"projectId": self.project_id},
             raise_return_resource_not_found=True,
+            error_handlers={"MALFORMED_REQUEST": self._raise_readable_errors},
         )
         success = result["validateAndRequestProjectBoostWorkforce"]["success"]
         if not success:
             raise Exception("Failed to start labeling service")
         return LabelingService.get(self.client, self.project_id)
 
+    def _raise_readable_errors(self, response):
+        errors = response.json().get("errors", [])
+        if errors:
+            message = errors[0].get(
+                "errors", json.dumps([{"error": "Unknown error"}])
+            )
+            error_messages = [error["error"] for error in message]
+        else:
+            error_messages = ["Uknown error"]
+        raise LabelboxError(". ".join(error_messages))
+
     @classmethod
     def getOrCreate(cls, client, project_id: Cuid) -> "LabelingService":
         """