Fix: Handle crashes and termination of RGB Lightning node

Author: pv-rahil

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.2
+current_version = 0.1.3
 commit = False
 tag = False
 allow_dirty = True

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "iris-wallet-desktop"
-version = "0.1.2"
+version = "0.1.3"
 description = ""
 readme = "README.md"
 license = ""

src/main.py

@@ -25,6 +25,7 @@
 from src.model.setting_model import IsBackupConfiguredModel
 from src.model.setting_model import IsWalletInitialized
 from src.utils.cache import Cache
+from src.utils.common_utils import disable_rln_node_termination_handling
 from src.utils.common_utils import load_translator
 from src.utils.common_utils import sigterm_handler
 from src.utils.excluded_page import excluded_page
@@ -49,6 +50,7 @@ def __init__(self):
         self.__init_ui__()
         self.progress_dialog = None
         self.ln_node_manager = LnNodeServerManager.get_instance()
+        self.wallet_type: WalletType = SettingRepository.get_wallet_type()
 
     def __init_ui__(self):
         """This method initializes the main window UI of the application."""
@@ -69,8 +71,7 @@ def closeEvent(self, event):  # pylint:disable=invalid-name
         cache = Cache.get_cache_session()
         if cache is not None:
             cache.invalidate_cache()
-        wallet_type: WalletType = SettingRepository.get_wallet_type()
-        if wallet_type.value == WalletType.REMOTE_TYPE_WALLET.value or page_name in excluded_page:
+        if self.wallet_type.value == WalletType.REMOTE_TYPE_WALLET.value or page_name in excluded_page:
             QApplication.instance().exit()
         else:
             self.show_backup_progress()
@@ -94,6 +95,7 @@ def show_backup_progress(self):
                 backup_configure_dialog_box.exec()
             else:
                 self.progress_dialog.exec(True)
+        disable_rln_node_termination_handling(self.wallet_type)
         self.progress_dialog.exec()
 
 

src/translations/en_IN.qm

@@ -1334,7 +1334,7 @@ If you understand the above remarks and wish to proceed, press the button below
     </message>
     <message>
         <source>wrong_password</source>
-        <translation>The provided password is not correct</translation>
+        <translation>The provided password is incorrect</translation>
     </message>
     <message>
         <source>invalid_invoice_error</source>
@@ -1681,24 +1681,38 @@ If you understand the above remarks and wish to proceed, press the button below
         <translation>Asset</translation>
     </message>
     <message>
-            <source>data_directory_path_label</source>
-            <translation>Data directory path:</translation>
+        <source>data_directory_path_label</source>
+        <translation>Data directory path:</translation>
     </message>
     <message>
-            <source>remote</source>
-            <translation>Remote</translation>
+        <source>remote</source>
+        <translation>Remote</translation>
     </message>
     <message>
-            <source>embedded_connection_info</source>
-            <translation>With embedded connection, an RGB Lightning Node is automatically run in the background.</translation>
+        <source>embedded_connection_info</source>
+        <translation>With embedded connection, an RGB Lightning Node is automatically run in the background.</translation>
     </message>
     <message>
-            <source>remote_connection_info</source>
-            <translation>With remote connection, an RGB Lightning Node needs to be hosted separately and its URL will need to be provided.</translation>
+        <source>remote_connection_info</source>
+        <translation>With remote connection, an RGB Lightning Node needs to be hosted separately and its URL will need to be provided.</translation>
     </message>
     <message>
-            <source>rln_node_connection_description</source>
-            <translation>An RLN (RGB Lightning Node) instance is necessary to support the app's functionalities. Clicking an option reveals details about it.</translation>
+        <source>rln_node_connection_description</source>
+        <translation>An RLN (RGB Lightning Node) instance is necessary to support the app's functionalities. Clicking an option reveals details about it.</translation>
+    </message>
+    <message>
+        <source>rgb_ln_node_connection_failed</source>
+        <translation>The RGB Lightning Node unexpectedly crashed or was terminated, causing the connection to the provided Lightning Node to fail. The application requires the RGB Lightning Node to function properly, and it must be running for a successful connection. You can report this issue on {} for assistance.
+
+        {}You can try to restart the RGB Lightning Node or close the application.</translation>
+    </message>
+    <message>
+        <source>crash_dialog_close_app</source>
+        <translation>Close the application</translation>
+    </message>
+    <message>
+        <source>crash_dialog_restart_node</source>
+        <translation>Restart RGB Lightning Node</translation>
     </message>
 </context>
 </TS>

src/translations/en_IN.ts

@@ -614,3 +614,24 @@ def get_bitcoin_info_by_network():
     'medium_checkBox': MEDIUM_TRANSACTION_FEE_BLOCKS,
     'fast_checkBox': FAST_TRANSACTION_FEE_BLOCKS,
 }
+
+
+def disable_rln_node_termination_handling(wallet_type: WalletType):
+    """
+    Disconnects the RLN node process termination handler when the user closes the application.
+
+    This ensures that the rln node termination handling logic does not trigger when the user explicitly exits.
+
+    Args:
+        wallet_type (WalletType): The type of the wallet being used.
+    """
+    if wallet_type.value == WalletType.EMBEDDED_TYPE_WALLET.value:
+        ln_node_manager = LnNodeServerManager.get_instance()
+
+        try:
+            ln_node_manager.process.finished.disconnect()
+        except CommonException as exc:
+            logger.error(
+                'Exception occurred: %s, Message: %s',
+                type(exc).__name__, str(exc),
+            )

src/utils/common_utils.py

@@ -121,7 +121,7 @@
 
 # Email and github issue url for error report
 CONTACT_EMAIL = 'iriswalletdesktop@gmail.com'
-GITHUB_ISSUE_LINK = 'https://github.com/RGB-Tools/iris-wallet-desktop/issues/new?template=Blank+issue'
+GITHUB_ISSUE_LINK = 'https://github.com/RGB-Tools/iris-wallet-desktop/issues/new/choose'
 
 # Translation context key
 IRIS_WALLET_TRANSLATIONS_CONTEXT = 'iris_wallet_desktop'

src/utils/constant.py

@@ -32,6 +32,7 @@
 from src.utils.constant import MAX_ATTEMPTS_TO_WAIT_FOR_NODE
 from src.utils.constant import NODE_CLOSE_INTERVAL
 from src.utils.endpoints import NODE_INFO_ENDPOINT
+from src.utils.logging import rln_qprocess_logger
 from src.utils.request import Request
 
 
@@ -53,6 +54,7 @@ class LnNodeServerManager(QObject):
     process_already_running = Signal()
     process_finished_on_request_app_close = Signal()
     process_finished_on_request_app_close_error = Signal()
+    main_window_loader = Signal(bool)
     _instance = None
 
     def __init__(self):
@@ -65,6 +67,8 @@ def __init__(self):
         self.process.started.connect(self.on_process_started)
         self.process.finished.connect(self.on_process_terminated)
         self.process.errorOccurred.connect(self.on_process_error)
+        self.process.readyReadStandardOutput.connect(self.handle_stdout)
+        self.process.readyReadStandardError.connect(self.handle_stderr)
         self.timer = QTimer()
         self.timer.timeout.connect(self.check_node_status)
         self.attempts = 0
@@ -129,13 +133,15 @@ def check_node_status(self):
         if self.attempts >= MAX_ATTEMPTS_TO_WAIT_FOR_NODE:
             self.process_error.emit(500, 'Unable to start server')
             self.timer.stop()
+            self.main_window_loader.emit(False)
             return
 
         try:
             response = Request.get(NODE_INFO_ENDPOINT)
             response.raise_for_status()
             self.process_started.emit()
             self.timer.stop()
+            self.main_window_loader.emit(False)
         except HTTPError:
             self.process_started.emit()
             self.timer.stop()
@@ -188,6 +194,18 @@ def _get_ln_path(self):
             return os.path.join(base_path, 'ln_node_binary', ln_binary_name)
         return os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '../../', 'ln_node_binary', ln_binary_name))
 
+    def handle_stdout(self):
+        """Read and print the standard output."""
+        output = self.process.readAllStandardOutput().data().decode()
+        if output:
+            rln_qprocess_logger.info(output)
+
+    def handle_stderr(self):
+        """Read and print the standard error output."""
+        error_output = self.process.readAllStandardError().data().decode()
+        if error_output:
+            rln_qprocess_logger.error(error_output)
+
     @staticmethod
     def get_instance():
         """

src/utils/ln_node_manage.py

@@ -13,7 +13,7 @@
 from src.utils.local_store import local_store
 
 
-def setup_logging(application_status: str) -> logging.Logger:
+def setup_logger(logger_name: str, log_file_name: str, application_status: str | None = None) -> logging.Logger:
     """
     Sets up the logging configuration for the application.
 
@@ -22,16 +22,18 @@ def setup_logging(application_status: str) -> logging.Logger:
     size limit and backup count. For development, it logs both to a file and the console.
 
     Args:
-        application_status (str): The current status of the application, either 'production' or 'development'.
-
+        logger_name (str): Name of the logger.
+        log_file_name (str): Log file name.
+        application_status (str | None, optional): The current status of the application, either 'production',
+            'development', or None. If None, it defaults to 'development'.
     Returns:
-        logging.Logger: Configured logger instance for the application.
+        logging.Logger: Configured logger instance.
     """
     log_directory = LOG_FOLDER_NAME
     path = local_store.create_folder(log_directory)
 
     # Create a logger
-    logger_instance = logging.getLogger('iris-wallet')
+    logger_instance = logging.getLogger(logger_name)
     # Set to debug to capture all levels of messages
     logger_instance.setLevel(logging.DEBUG)
     # Prevent logging from propagating to the root logger
@@ -42,7 +44,7 @@ def setup_logging(application_status: str) -> logging.Logger:
         '%(asctime)s - %(levelname)s - %(message)s',
         datefmt='%Y-%m-%d %H:%M:%S',
     )
-    file_name = os.path.join(path, 'iris_wallet_desktop.log')
+    file_name = os.path.join(path, log_file_name)
 
     # Define and add handlers based on network
     file_handler = RotatingFileHandler(
@@ -72,5 +74,11 @@ def setup_logging(application_status: str) -> logging.Logger:
     sys, 'frozen', False,
 ) else 'development'
 
-# Set up logging based on the current network
-logger = setup_logging(APPLICATION_STATUS)
+# Set up loggers using the refactored function and capturing all logs without applying `APPLICATION_STATUS`
+logger = setup_logger(
+    'iris-wallet', 'iris_wallet_desktop.log',
+)
+
+rln_qprocess_logger = setup_logger(
+    'qprocess', 'rln_qprocess.log',
+)

src/utils/logging.py

@@ -60,6 +60,9 @@ def get(
         params = params if params is not None else {}
         url = f'{Request.load_base_url()}{endpoint}'
 
+        # Log request initiation
+        logger.info('Starting GET request to %s', url)
+
         response = requests.get(
             url,
             headers=headers,
@@ -90,6 +93,9 @@ def post(
         params = params if params is not None else {}
         url = f'{Request.load_base_url()}{endpoint}'
 
+        # Log request initiation
+        logger.info('Starting POST request to %s', url)
+
         if files is not None:
             response = requests.post(url, files=files, timeout=REQUEST_TIMEOUT)
         else:
@@ -122,6 +128,9 @@ def put(
         params = params if params is not None else {}
         url = f'{Request.load_base_url()}{endpoint}'
 
+        # Log request initiation
+        logger.info('Starting PUT request to %s', url)
+
         response = requests.put(
             url,
             json=body,
@@ -150,6 +159,9 @@ def delete(
         params = params if params is not None else {}
         url = f'{Request.load_base_url()}{endpoint}'
 
+        # Log request initiation
+        logger.info('Starting DELETE request to %s', url)
+
         response = requests.delete(
             url,
             headers=headers,