Merge pull request #8078 from OpenMined/init_exception_handling

Init exception handling

packages/syft/src/syft/exceptions/exception.py

@@ -0,0 +1,27 @@
+# stdlib
+from typing import List
+from typing import Optional
+
+# relative
+from ..service.context import NodeServiceContext
+from ..service.response import SyftError
+from ..service.user.user_roles import ServiceRole
+
+
+class PySyftException(Exception):
+    """Base class for all PySyft exceptions."""
+
+    def __init__(self, message: str, roles: Optional[List[ServiceRole]] = None):
+        super().__init__(message)
+        self.message = message
+        self.roles = roles if roles else [ServiceRole.ADMIN]
+
+    def raise_with_context(self, context: NodeServiceContext):
+        self.context = context
+        return self
+
+    def handle(self) -> SyftError:
+        # if self.context and self.context.role in self.roles:
+        return SyftError(message=self.message)
+        # else:
+        #     return SyftError(message="Access denied to exception message.")

packages/syft/src/syft/exceptions/user.py

@@ -0,0 +1,9 @@
+# stdlib
+
+# relative
+from ..service.user.user_roles import ServiceRole
+from .exception import PySyftException
+
+UserAlreadyExistsException = PySyftException(
+    message="User already exists", roles=[ServiceRole.ADMIN]
+)

packages/syft/src/syft/node/node.py

@@ -41,6 +41,7 @@
 from ..client.api import SyftAPICall
 from ..client.api import SyftAPIData
 from ..client.api import debox_signed_syftapicall_response
+from ..exceptions.exception import PySyftException
 from ..external import OBLV
 from ..serde.deserialize import _deserialize
 from ..serde.serialize import _serialize
@@ -806,6 +807,8 @@ def handle_api_call_with_unsigned_result(
             method = self.get_service_method(_private_api_path)
             try:
                 result = method(context, *api_call.args, **api_call.kwargs)
+            except PySyftException as e:
+                return e.handle()
             except Exception:
                 result = SyftError(
                     message=f"Exception calling {api_call.path}. {traceback.format_exc()}"

packages/syft/src/syft/service/user/user_service.py

@@ -6,6 +6,7 @@
 
 # relative
 from ...abstract_node import NodeType
+from ...exceptions.user import UserAlreadyExistsException
 from ...node.credentials import SyftSigningKey
 from ...node.credentials import SyftVerifyKey
 from ...node.credentials import UserLoginCredentials
@@ -235,9 +236,7 @@ def update(
                 email=user_update.email
             )
             if user_with_email_exists:
-                return SyftError(
-                    message=f"A user with the email {user_update.email} already exists."
-                )
+                raise UserAlreadyExistsException.raise_with_context(context=context)
 
         if result.is_err():
             error_msg = (

packages/syft/tests/syft/users/user_test.py

@@ -247,9 +247,7 @@ def test_guest_user_update_to_root_email_failed(
             uid=client.me.id, user_update=user_update_to_root_email
         )
         assert isinstance(res, SyftError)
-        assert (
-            res.message == f"A user with the email {default_root_email} already exists."
-        )
+        assert res.message == "User already exists"
 
 
 def test_user_view_set_password(worker: Worker, root_client: DomainClient) -> None:
@@ -299,36 +297,27 @@ def test_user_view_set_default_admin_email_failed(
     default_root_email = get_default_root_email()
     result = ds_client.me.set_email(default_root_email)
     assert isinstance(result, SyftError)
-    assert (
-        result.message == f"A user with the email {default_root_email} already exists."
-    )
+    assert result.message == "User already exists"
+
     result_2 = guest_client.me.set_email(default_root_email)
     assert isinstance(result_2, SyftError)
-    assert (
-        result.message == f"A user with the email {default_root_email} already exists."
-    )
+    assert result_2.message == "User already exists"
 
 
 def test_user_view_set_duplicated_email(
     root_client: DomainClient, ds_client: DomainClient, guest_client: DomainClient
 ) -> None:
     result = ds_client.me.set_email(root_client.me.email)
     result2 = guest_client.me.set_email(root_client.me.email)
+
     assert isinstance(result, SyftError)
-    assert (
-        result.message
-        == f"A user with the email {root_client.me.email} already exists."
-    )
+    assert result.message == "User already exists"
     assert isinstance(result2, SyftError)
-    assert (
-        result2.message
-        == f"A user with the email {root_client.me.email} already exists."
-    )
+    assert result2.message == "User already exists"
+
     result3 = guest_client.me.set_email(ds_client.me.email)
     assert isinstance(result3, SyftError)
-    assert (
-        result3.message == f"A user with the email {ds_client.me.email} already exists."
-    )
+    assert result3.message == "User already exists"
 
 
 def test_user_view_update_name_institution_website(