SHOT-4407: Improve Alias start up (#205)

* Increase client time out. * Handle any server Qt error. * Update docs * Bump tk-framework-alias version dependency
shotgunsoftware · Dec 6, 2024 · 7e809f4 · 7e809f4
1 parent 34af208
commit 7e809f4
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 5 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -1,7 +1,9 @@
 What's New
 ####################################################
 
-The latest version of the Alias Engine is ``v4.1.1``.
+The latest version of the Alias Engine is ``v4.1.2``.
+
+.. include:: v4.1.2.rst
 
 .. include:: v4.1.1.rst
 

diff --git a/docs/v4.1.2.rst b/docs/v4.1.2.rst
@@ -0,0 +1,9 @@
+v4.1.2
+=====================
+
+Release highlights
+------------------
+
+* Improve error handling on Alias start up
+* Improve Alias API timeout handling
+
diff --git a/engine.py b/engine.py
@@ -915,7 +915,9 @@ def __setup_sio(self, hostname, port, namespace):
         """
 
         # Create and connect to the server to communicate with Alias
-        self.__sio = self._tk_alias.ShotGridAliasSocketIoClient(self, namespace)
+        self.__sio = self._tk_alias.ShotGridAliasSocketIoClient(
+            self, namespace, timeout=60 * 3
+        )
 
         if not self.__sio:
             raise Exception("Failed to create socketio client")

diff --git a/info.yml b/info.yml
@@ -91,5 +91,5 @@ requires_core_version: "v0.19.18"
 
 frameworks:
   - {"name": "tk-framework-aliastranslations", "version": "v0.x.x", "minimum_version": "v0.2.3"}
-  - {"name": "tk-framework-alias", "version": "v2.x.x", "minimum_version": "v2.0.0"}
+  - {"name": "tk-framework-alias", "version": "v2.x.x", "minimum_version": "v2.1.1"}
   - {"name": "tk-framework-lmv", "version": "v1.x.x"}
diff --git a/python/tk_alias/framework_alias.py b/python/tk_alias/framework_alias.py
@@ -25,3 +25,5 @@
 AliasClientModuleProxyWrapper = tk_framework_alias.client.AliasClientModuleProxyWrapper
 
 QtImportError = tk_framework_alias.server.utils.exceptions.QtImportError
+QtModuleNotFound = tk_framework_alias.server.utils.exceptions.QtModuleNotFound
+QtAppInstanceNotFound = tk_framework_alias.server.utils.exceptions.QtAppInstanceNotFound
diff --git a/python/tk_alias/shotgrid_alias_client.py b/python/tk_alias/shotgrid_alias_client.py
@@ -8,7 +8,12 @@
 # agreement to the ShotGrid Pipeline Toolkit Source Code License. All rights
 # not expressly granted therein are reserved by Autodesk, Inc.
 
-from .framework_alias import AliasSocketIoClient, QtImportError
+from .framework_alias import (
+    AliasSocketIoClient,
+    QtImportError,
+    QtModuleNotFound,
+    QtAppInstanceNotFound,
+)
 from .shotgrid_alias_client_namespace import ShotGridAliasClientNamespace
 
 
@@ -76,7 +81,11 @@ def _handle_server_error(self, error):
 
         from sgtk.platform.qt import QtGui
 
-        if not self.connected or error.__class__.__name__ == QtImportError.__name__:
+        if not self.connected or error.__class__.__name__ in (
+            QtImportError.__name__,
+            QtModuleNotFound.__name__,
+            QtAppInstanceNotFound.__name__,
+        ):
             parent = None
         else:
             parent = self.engine._get_dialog_parent()