Add more exception wrapping to display more useful error messages (#451)

* easy solution

* Fixed tests

src/speckleifc/ifc_geometry_processing.py

@@ -1,6 +1,6 @@
 import multiprocessing
 
-from ifcopenshell import file, ifcopenshell_wrapper, open, sqlite
+from ifcopenshell import SchemaError, file, ifcopenshell_wrapper, open, sqlite
 from ifcopenshell.geom import iterator, settings
 
 from specklepy.logging.exceptions import SpeckleException
@@ -33,7 +33,14 @@ def _create_iterator_settings() -> settings:
 
 
 def open_ifc(file_path: str) -> file:
-    ifc_file = open(file_path)
+    try:
+        ifc_file = open(file_path)
+    except SchemaError:
+        raise
+    except FileNotFoundError:
+        raise
+    except Exception as ex:
+        raise SpeckleException("File could not be opened as an IFC file") from ex
 
     if isinstance(ifc_file, file):
         return ifc_file

src/speckleifc/importer.py

@@ -34,6 +34,16 @@ class ImportJob:
     _current_storey_data_object: DataObject | None = field(default=None, init=False)
 
     def convert_element(self, step_element: entity_instance) -> Base:
+        try:
+            return self._convert_element(step_element)
+        except SpeckleException:
+            raise
+        except Exception as ex:
+            raise SpeckleException(
+                f"Failed to convert {step_element.is_a()} #{step_element.id()}"
+            ) from ex
+
+    def _convert_element(self, step_element: entity_instance) -> Base:
         # Track current storey context and store for level proxies
         previous_storey_data_object = self._current_storey_data_object
         if step_element.is_a("IfcBuildingStorey"):
@@ -110,18 +120,22 @@ class ImportJob:
     def pre_process_geometry(self) -> None:
         iterator = create_geometry_iterator(self.ifc_file)
         if not iterator.initialize():
-            raise SpeckleException(
-                "geometry iterator failed to initialize for the given file"
-            )
+            raise SpeckleException("Failed to find any geometry in file")
         self.geometries_count = 0
         while True:
             shape = cast(TriangulationElement, iterator.get())
             self.geometries_count += 1
             id = cast(int, shape.id)
 
-            display_value = geometry_to_speckle(shape, self._render_material_manager)
-            self.cached_display_values[id] = display_value
-
+            try:
+                display_value = geometry_to_speckle(
+                    shape, self._render_material_manager
+                )
+                self.cached_display_values[id] = display_value
+            except Exception as ex:
+                raise SpeckleException(
+                    f"Failed to convert geometry with id: {id}"
+                ) from ex
             if not iterator.next():
                 break
 

src/speckleifc/main.py

@@ -26,6 +26,7 @@ def open_and_convert_file(
     remote_transport = ServerTransport(project.id, account=account)
 
     ifc_file = open_ifc(file_path)  # pyright: ignore[reportUnknownVariableType]
+
     import_job = ImportJob(ifc_file)  # pyright: ignore[reportUnknownArgumentType]
     data = import_job.convert()
 

src/specklepy/core/api/client.py

@@ -131,6 +131,18 @@ class SpeckleClient:
         self.account = Account.from_token(token, self.url)
         self._set_up_client()
 
+        userData = self.active_user.get()
+
+        # None if the token lacked the profile:read scope or if it was None
+        if userData:
+            self.account.userInfo.id = userData.id
+            self.account.userInfo.email = userData.email
+            self.account.userInfo.name = userData.name
+            self.account.userInfo.company = userData.company
+            self.account.userInfo.avatar = userData.avatar
+
+        self.account.serverInfo = self.server.get()
+
     def authenticate_with_account(self, account: Account) -> None:
         """Authenticate the client using an Account object
         The account is saved in the client object and a synchronous GraphQL
@@ -143,6 +155,21 @@ class SpeckleClient:
         self.account = account
         self._set_up_client()
 
+        try:
+            _ = self.active_user.get()
+        except SpeckleException as ex:
+            if isinstance(ex.exception, TransportServerError):
+                if ex.exception.code == 403:
+                    warn(
+                        SpeckleWarning(
+                            "Possibly invalid token - could not authenticate "
+                            f"Speckle Client for server {self.url}"
+                        ),
+                        stacklevel=2,
+                    )
+                else:
+                    raise ex
+
     def _set_up_client(self) -> None:
         headers = {
             "Authorization": f"Bearer {self.account.token}",
@@ -162,21 +189,6 @@ class SpeckleClient:
 
         self._init_resources()
 
-        try:
-            _ = self.active_user.get()
-        except SpeckleException as ex:
-            if isinstance(ex.exception, TransportServerError):
-                if ex.exception.code == 403:
-                    warn(
-                        SpeckleWarning(
-                            "Possibly invalid token - could not authenticate "
-                            f"Speckle Client for server {self.url}"
-                        ),
-                        stacklevel=2,
-                    )
-                else:
-                    raise ex
-
     def execute_query(self, query: str) -> Dict:
         return self.httpclient.execute(query)
 

src/specklepy/core/api/credentials.py

@@ -37,7 +37,7 @@ class Account(BaseModel):
         return self.__repr__()
 
     @classmethod
-    def from_token(cls, token: str, server_url: str = None):
+    def from_token(cls, token: str, server_url: str | None = None):
         acct = cls(token=token)
         acct.serverInfo.url = server_url
         return acct

src/specklepy/transports/server/batch_sender.py

@@ -123,8 +123,8 @@ class BatchSender:
         upload_data = "[" + ",".join(new_objects) + "]"
         upload_data_gzip = gzip.compress(upload_data.encode())
         LOG.info(
-            "Uploading batch of {batch_size} objects {new_object_count}: ",
-            "(size: {upload_size}, compressed size: {upload_data_size})",
+            "Uploading batch of {batch_size} objects {new_object_count}: "
+            + "(size: {upload_size}, compressed size: {upload_data_size})",
             {
                 "batch_size": len(batch),
                 "new_object_count": len(new_objects),

tests/integration/client/test_client_and_ops.py

@@ -6,7 +6,7 @@ from specklepy.api import operations
 from specklepy.api.client import SpeckleClient
 from specklepy.api.credentials import Account, get_account_from_token
 from specklepy.core.helpers import speckle_path_provider
-from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+from specklepy.logging.exceptions import SpeckleException
 from specklepy.objects.base import Base
 from specklepy.transports.server import ServerTransport
 
@@ -17,7 +17,7 @@ def test_invalid_authentication():
     speckle_path_provider.override_application_data_path(gettempdir())
     client = SpeckleClient()
 
-    with pytest.warns(SpeckleWarning):
+    with pytest.raises(SpeckleException):
         client.authenticate_with_token("fake token")
 
     # remove path override