feat(lab-3842): give more details on appendToLabel errors

Author: baptiste-olivier

src/kili/core/graphql/exceptions.py

@@ -0,0 +1,12 @@
+"""Helper functions to extract context from GraphQL error messages."""
+import ast
+from typing import Dict, Optional
+
+
+def extract_error_context(message: str) -> Optional[Dict[str, str]]:
+    """Parse the string error message to extract the first context information."""
+    try:
+        parsed_errors = ast.literal_eval(message)
+        return parsed_errors[0].get("extensions").get("context")
+    except (SyntaxError, ValueError):
+        return None

src/kili/core/graphql/graphql_client.py

@@ -33,6 +33,7 @@
 from kili.adapters.http_client import HttpClient
 from kili.core.constants import MAX_CALLS_PER_MINUTE
 from kili.core.graphql.clientnames import GraphQLClientName
+from kili.core.graphql.exceptions import extract_error_context
 from kili.utils.logcontext import LogContext
 
 gql_requests_logger.setLevel(logging.WARNING)
@@ -281,8 +282,8 @@ def execute(
                 raise kili.exceptions.GraphQLError(error=err.errors) from err
 
         except exceptions.TransportQueryError as err:  # remove validation error
-            # the server refused the query after some retries, we crash
-            raise kili.exceptions.GraphQLError(error=err.errors) from err
+            context = extract_error_context(str(err.errors))
+            raise kili.exceptions.GraphQLError(error=err.errors, context=context) from err
 
     @retry(
         reraise=True,  # re-raise the last exception

src/kili/exceptions.py

@@ -6,8 +6,9 @@
 class GraphQLError(Exception):
     """Raised when the GraphQL call returns an error."""
 
-    def __init__(self, error, batch_number=None) -> None:
+    def __init__(self, error, batch_number=None, context=None) -> None:
         self.error = error
+        self.context = context
 
         if isinstance(error, List):
             error = error[0]

src/kili/use_cases/label/__init__.py

@@ -14,6 +14,7 @@
 from kili.domain.project import ProjectId
 from kili.domain.types import ListOrTuple
 from kili.domain.user import UserId
+from kili.exceptions import GraphQLError
 from kili.use_cases.asset.utils import AssetUseCasesUtils
 from kili.use_cases.base import BaseUseCases
 from kili.utils.labels.parsing import parse_labels
@@ -25,6 +26,23 @@
     import pandas as pd
 
 
+LOCK_ERRORS = {
+    "AlreadyHaveLabelOnCurrentStep": "You cannot edit this asset as you've already submitted a label.",
+    "AssetAlreadyAssigned": "This asset is assigned to someone else. You cannot edit it.",
+    "AssetAlreadyLocked": "This asset is currently being edited by another user.",
+    "AssetInDoneStepStatus": "This asset is already labeled or reviewed and cannot be edited.",
+    "AssetInDoneStepStatusWithCorrectAction": "You already labeled this asset, but you can still correct it.",
+    "AssetInDoneStepStatusWithReviewAction": "This asset is completed. Take it for review to make changes.",
+    "AssetInNextStepWithCorrectAction": "This asset is awaiting to be reviewed but can still be corrected.",
+    "AssetLockedNoReason": "This asset is currently locked. You cannot edit it.",
+    "BlockedByEnforceStepSeparation": "You can't edit this asset as you already worked on another step.",
+    "LabelNotEditable": "This label was created in another step and is read-only.",
+    "NotAssignedWithAssignAction": "This asset is in read-only mode because you are not assigned to it."
+    + "To make edits, add yourself as an assignee.",
+    "NotInStepAssignees": "You cannot edit this asset in its current step.",
+}
+
+
 class LabelUseCases(BaseUseCases):
     """Label use cases."""
 
@@ -116,12 +134,20 @@ def append_labels(
             overwrite=overwrite,
             labels_data=labels_to_add,
         )
-        return self._kili_api_gateway.append_many_labels(
-            fields=fields,
-            disable_tqdm=disable_tqdm,
-            data=data,
-            project_id=project_id,
-        )
+        try:
+            return self._kili_api_gateway.append_many_labels(
+                fields=fields,
+                disable_tqdm=disable_tqdm,
+                data=data,
+                project_id=project_id,
+            )
+        except GraphQLError as e:
+            if e.context and e.context.get("reason"):
+                reason = e.context.get("reason")
+                if reason in LOCK_ERRORS:
+                    raise ValueError(LOCK_ERRORS[reason]) from e
+
+            raise e
 
     def append_to_labels(
         self,