Adds better unhandled exception dialog during project sync (#799)

Author: tomasMizera

Mergin/projects_manager.py

@@ -181,7 +181,8 @@ def create_project(self, project_name, project_dir, is_public, namespace):
                 unhandled_exception_message(
                     dlg.exception_details(),
                     "Project sync",
-                    f"Failed to sync project {project_name} due to an unhandled exception.",
+                    f"Something went wrong while synchronising your project {project_name}.",
+                    self.mc,
                 )
             return True
 
@@ -375,7 +376,8 @@ def sync_project(self, project_dir, project_name=None):
                 unhandled_exception_message(
                     dlg.exception_details(),
                     "Project sync",
-                    f"Failed to sync project {project_name} due to an unhandled exception.",
+                    f"Something went wrong while synchronising your project {project_name}.",
+                    self.mc,
                 )
             return
 
@@ -438,7 +440,8 @@ def sync_project(self, project_dir, project_name=None):
                 unhandled_exception_message(
                     dlg.exception_details(),
                     "Project sync",
-                    f"Failed to sync project {project_name} due to an unhandled exception.",
+                    f"Something went wrong while synchronising your project {project_name}.",
+                    self.mc,
                 )
             return
 
@@ -580,9 +583,9 @@ def download_project(self, project):
                 unhandled_exception_message(
                     dlg.exception_details(),
                     "Project download",
-                    f"Failed to download project {project_name} due to an unhandled exception.",
+                    f"Something went wrong while downloading your project {project_name}.",
+                    self.mc,
                     dlg.log_file,
-                    self.mc.username(),
                 )
             return
         if not dlg.is_complete:

Mergin/utils.py

@@ -7,6 +7,7 @@
 from urllib.error import URLError, HTTPError
 import configparser
 import os
+import webbrowser
 from osgeo import gdal
 import pathlib
 import platform
@@ -18,7 +19,7 @@
 import re
 
 from qgis.PyQt.QtCore import QSettings, QVariant
-from qgis.PyQt.QtWidgets import QMessageBox, QFileDialog
+from qgis.PyQt.QtWidgets import QMessageBox, QFileDialog, QCheckBox
 from qgis.PyQt.QtGui import QPalette, QColor, QIcon
 from qgis.PyQt.QtXml import QDomDocument
 from qgis.core import (
@@ -861,30 +862,48 @@ def login_error_message(e):
     QMessageBox.critical(None, "Login failed", msg, QMessageBox.StandardButton.Close)
 
 
-def unhandled_exception_message(error_details, dialog_title, error_text, log_file=None, username=None):
-    msg = (
-        error_text + "<p>This should not happen, "
-        '<a href="https://github.com/MerginMaps/qgis-mergin-plugin/issues">'
-        "please report the problem</a>."
-    )
+def unhandled_exception_message(error_details, dialog_title, error_text, mm_client, log_file=None):
     box = QMessageBox()
     box.setIcon(QMessageBox.Icon.Critical)
     box.setWindowTitle(dialog_title)
-    box.setText(msg)
-    if log_file is None:
-        box.setDetailedText(error_details)
-    else:
-        error_details = (
-            "An error occured during project synchronisation. The log was saved to "
-            f"{log_file}. Click 'Send logs' to send a diagnostic log to the developers "
-            "to help them determine the exact cause of the problem.\n\n"
-            "The log does not contain any of your data, only file names. "
-            "It would be useful if you also send a mail to support@merginmaps.com "
-            "and briefly describe the problem to add more context to the diagnostic log."
+    box.setText(error_text)
+    box.setInformativeText(
+        "An unexpected error occurred. "
+        "You can help us fix it by reporting the problem. "
+        "Click the button below to create a report we can review."
+    )
+
+    if log_file:
+        check = QCheckBox("Include diagnostic log (what is this?)")
+        check.setChecked(True)
+        check.setToolTip(
+            "The diagnostic log contains only file names and activity steps that "
+            "help us understand what went wrong. It does not include your data."
+        )
+
+        box.setCheckBox(check)
+
+        error_details = f"The diagnostic log is saved here: {log_file}.\n\n" f"Error details:\n{error_details}"
+
+    box.setDetailedText(error_details)
+    username = mm_client.username() if mm_client else "Unknown"
+
+    email_subject = "Problem with sync from QGIS"
+    email_body = (
+        "Hi,\n"
+        "I encountered an issue during synchronisation. (Please add more details here).\n\n"
+        f"Problem: {error_text}\n"
+        f"Username: {username}\n"
+        f"{error_details}"
+    )
+
+    btn = box.addButton("Report problem", QMessageBox.ButtonRole.HelpRole)
+    btn.clicked.connect(
+        lambda: (
+            send_logs(mm_client, log_file) if box.checkBox() and box.checkBox().isChecked() else None,
+            webbrowser.open(f"mailto:support@merginmaps.com?subject={email_subject}&body={email_body}"),
         )
-        box.setDetailedText(error_details)
-        btn = box.addButton("Send logs", QMessageBox.ButtonRole.ActionRole)
-        btn.clicked.connect(lambda: send_logs(username, log_file))
+    )
     box.exec()