3D-printing/Cura
1
0
Fork 0
mirror of https://github.com/Ultimaker/Cura.git synced 2025-07-23 22:54:01 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Add error messages to BackendPlugin and enhance exception handling

Browse source 
Exception handling in BackendPlugin has been improved by adding
user-friendly error messages for various exceptions. Errors during
backend plugin start or stop will now trigger a message to the user,
providing more context about the cause of the failure. This makes it
easier for users to understand and resolve possible issues. In addition,
 the EngineBackend stop function has been modified to forcibly stop all
 running backend plugins instead of allowing multiple plugins to run
 simultaneously.
This commit is contained in:
Jelle Spijker 2023-08-10 05:56:24 +02:00
parent 0fc507e556
commit dead016ed9
2 changed files with 27 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

32
cura/BackendPlugin.py
View file

@ -4,6 +4,7 @@ import subprocess
from typing import Optional, List from typing import Optional, List
from UM.Logger import Logger from UM.Logger import Logger
from UM.Message import Message
from UM.Settings.AdditionalSettingDefinitionAppender import AdditionalSettingDefinitionsAppender from UM.Settings.AdditionalSettingDefinitionAppender import AdditionalSettingDefinitionsAppender
@ -57,13 +58,25 @@ class BackendPlugin(AdditionalSettingDefinitionsAppender):
self._is_running = True self._is_running = True
return True return True
except PermissionError: except PermissionError:
Logger.log("e", f"Couldn't start backend_plugin [{self._plugin_id}]: No permission to execute process.") Logger.log("e", f"Couldn't start EnginePlugin: {self._plugin_id} No permission to execute process.")
self._showMessage(self.catalog.i18nc("@info:plugin_failed",
f"Couldn't start EnginePlugin: {self._plugin_id}\nNo permission to execute process."),
message_type = Message.MessageType.ERROR)
except FileNotFoundError: except FileNotFoundError:
Logger.logException("e", f"Unable to find backend_plugin executable [{self._plugin_id}]") Logger.logException("e", f"Unable to find local EnginePlugin server executable for: {self._plugin_id}")
self._showMessage(self.catalog.i18nc("@info:plugin_failed",
f"Unable to find local EnginePlugin server executable for: {self._plugin_id}"),
message_type = Message.MessageType.ERROR)
except BlockingIOError: except BlockingIOError:
Logger.logException("e", f"Couldn't start backend_plugin [{self._plugin_id}]: Resource is temporarily unavailable") Logger.logException("e", f"Couldn't start EnginePlugin: {self._plugin_id} Resource is temporarily unavailable")
self._showMessage(self.catalog.i18nc("@info:plugin_failed",
f"Couldn't start EnginePlugin: {self._plugin_id}\nResource is temporarily unavailable"),
message_type = Message.MessageType.ERROR)
except OSError as e: except OSError as e:
Logger.logException("e", f"Couldn't start backend_plugin [{self._plugin_id}]: Operating system is blocking it (antivirus?)") Logger.logException("e", f"Couldn't start EnginePlugin {self._plugin_id} Operating system is blocking it (antivirus?)")
self._showMessage(self.catalog.i18nc("@info:plugin_failed",
f"Couldn't start EnginePlugin: {self._plugin_id}\nOperating system is blocking it (antivirus?)"),
message_type = Message.MessageType.ERROR)
return False return False
def stop(self) -> bool: def stop(self) -> bool:
@ -75,8 +88,15 @@ class BackendPlugin(AdditionalSettingDefinitionsAppender):
self._process.terminate() self._process.terminate()
return_code = self._process.wait() return_code = self._process.wait()
self._is_running = False self._is_running = False
Logger.log("d", f"Backend_plugin [{self._plugin_id}] was killed. Received return code {return_code}") Logger.log("d", f"EnginePlugin: {self._plugin_id} was killed. Received return code {return_code}")
return True return True
except PermissionError: except PermissionError:
Logger.log("e", "Unable to kill running engine. Access is denied.") Logger.log("e", f"Unable to kill running EnginePlugin: {self._plugin_id} Access is denied.")
self._showMessage(self.catalog.i18nc("@info:plugin_failed",
f"Unable to kill running EnginePlugin: {self._plugin_id}\nAccess is denied."),
message_type = Message.MessageType.ERROR)
return False return False
def _showMessage(self, message: str, message_type: Message.MessageType = Message.MessageType.ERROR) -> None:
Message(message, title=self.catalog.i18nc("@info:title", "EnginePlugin"), message_type = message_type).show()

2
plugins/CuraEngineBackend/CuraEngineBackend.py
View file

@ -203,7 +203,7 @@ class CuraEngineBackend(QObject, Backend):
backend_plugins = CuraApplication.getInstance().getBackendPlugins() backend_plugins = CuraApplication.getInstance().getBackendPlugins()
for backend_plugin in backend_plugins: for backend_plugin in backend_plugins:
if backend_plugin.isRunning(): if backend_plugin.isRunning():
continue backend_plugin.stop()
# Set the port to prevent plugins from using the same one. # Set the port to prevent plugins from using the same one.
backend_plugin.setPort(self._last_backend_plugin_port) backend_plugin.setPort(self._last_backend_plugin_port)
self._last_backend_plugin_port += 1 self._last_backend_plugin_port += 1