Add broad error handling and file logging

Author: mwinkens

src/backend/rule_manager.py

@@ -5,6 +5,7 @@
 from src.backend.tile_status import TileStatus
 from src.config.config_manager import ConfigManager
 from src.widgets.widget_base_tile import BaseTile
+from src.logger import BroadErrorHandler
 
 RuleConfig = Dict[str, List[str]]
 
@@ -39,11 +40,13 @@ def _loadRuleFile(self, filename_base):
                 self._header = []
             self._loadedRules = True
 
+    @BroadErrorHandler
     def loadRules(self, filename):
         if not self._loadedRules:
             filename = RuleManager._getFileBase(filename)
             self._loadRuleFile(filename)
 
+    @BroadErrorHandler
     def saveRule(self, filename, rule_name):
         filename = RuleManager._getFileBase(filename)
         if not self._loadedRules:

src/config/app_state.py

@@ -41,14 +41,18 @@ def ruleManager(cls):
     def setImagePath(cls, image_path):
         cls.instance().main_image_path = image_path
         cls.instance().rule_manager.loadRules(Path(image_path).stem)
-        cls.instance().signal_emitter.application_status_signal.emit(ApplicationStatusEnum.IMAGE_LOADED, "")
+        cls.instance().signal_emitter.application_status_signal.emit(
+            ApplicationStatusEnum.IMAGE_LOADED,
+            f"image loaded: {str(image_path)}")
 
     @classmethod
     def reset(cls):
         # do not call _init here, don't overwrite the signal emitter, reset manually
         cls.instance().rule_manager: RuleManager = RuleManager()
         cls.instance().main_image_path: Optional[str] = None
-        cls.instance().signal_emitter.application_status_signal.emit(ApplicationStatusEnum.RESET_APP, "")
+        cls.instance().signal_emitter.application_status_signal.emit(
+            ApplicationStatusEnum.RESET_APP,
+            "Reset rules and images")
 
     @classmethod
     def setStatus(cls, status_type: ApplicationStatusEnum, message: str):

src/config/config_manager.py

@@ -1,3 +1,4 @@
+import logging
 from pathlib import Path
 from typing import Any
 
@@ -42,8 +43,16 @@ def _checkConfig(self) -> bool:
         return updated
 
     def createConfig(self):
-        client_path = StorageFinder.instance().getClientPath()
-        data_path = StorageFinder.instance().getDataPath()
+        client_path = ""
+        data_path = ""
+        # noinspection PyBroadException
+        try:
+            client_path = StorageFinder.instance().getClientPath()
+            data_path = StorageFinder.instance().getDataPath()
+        except Exception as e:
+            logging.error("An error occured while creating the config")
+            logging.error(str(e))
+
         data = {
             'version': "1.0.0",
             'client_path': str(client_path),

src/config/storage_finder.py

@@ -3,9 +3,7 @@
 from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import List
-import logging
-
-logger = logging.getLogger(__name__)
+from src.logger import logger
 
 
 class StorageFinderBase(ABC):
@@ -121,7 +119,7 @@ def _findLocations(self, paths: List[str], os_name):
     def _findClient(data_path, os_name):
         if data_path:
             pattern = "ddnet.exe" if os_name in ["win32", "cygwin"] else "ddnet*"
-            for p in Path(data_path).parent.glob(pattern, case_sensitive=False):
+            for p in Path(data_path).parent.glob(pattern):
                 if p.is_file():
                     return p
         return None

src/logger.py

@@ -0,0 +1,25 @@
+import logging
+import sys
+from logging.handlers import RotatingFileHandler
+
+handlers = [RotatingFileHandler(filename="simple_ddnet_mapper.log",
+                                mode='w',
+                                maxBytes=512000,
+                                backupCount=4),
+            logging.StreamHandler(sys.stdout)
+            ]
+logging.basicConfig(handlers=handlers,
+                    level=logging.DEBUG,
+                    format='%(levelname)s %(asctime)s %(message)s',
+                    datefmt='%m/%d/%Y%I:%M:%S %p')
+
+
+def BroadErrorHandler(func):
+    def innerFunction(*args, **kwargs):
+        try:
+            func(*args, **kwargs)
+        except Exception as e:
+            logger.error(f"An error occurred at {func.__name__}")
+            logger.error(str(e))
+
+    return innerFunction

src/main_window.py

@@ -10,8 +10,8 @@
 from src.config.app_state import AppState
 from src.signals.signal_emitter import ApplicationStatusEnum
 from src.backend.tile_handler import TileHandler
+import src.logger
 import logging
-
 logger = logging.getLogger(__name__)
 
 
@@ -67,7 +67,7 @@ def showAbout(self):
         QMessageBox.about(self, 'About', 'This is a PyQt6 menu example.')
 
     def statusUpdateReceived(self, status_type: ApplicationStatusEnum, message: str):
-        logger.debug(f"Status update received: {status_type}, {message}")
+        logger.debug(f"Status update received: {status_type}{', ' if len(message) else ''}{message}")
         if status_type == ApplicationStatusEnum.IMAGE_LOADED:
             self.mapper_generator.setEnabled(True)
             self.mapper_generator.widget().rulesLoaded()

src/widgets/widget_mapper_generator.py

@@ -11,6 +11,7 @@
 from src.dialogs.dialog_check_map import CheckMapDialog
 from src.config.config_manager import ConfigManager
 from src.backend.map_generator import MapGenerator
+from src.logger import BroadErrorHandler
 
 
 class MapperGeneratorWidget(QWidget):
@@ -134,6 +135,7 @@ def ruleNameToggle(self):
             self.existing_mapper.show()
         self._updateGenerateButton()
 
+    @BroadErrorHandler
     def startDDNetCheck(self):
         # TODO
         # generate Map