Don't show crash id for python crashes -- it's not representative

qgis · Dec 7, 2021 · 3bc66e4 · 3bc66e4
1 parent b78eba9
commit 3bc66e4
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/src/crashhandler/qgscrashdialog.cpp b/src/crashhandler/qgscrashdialog.cpp
@@ -61,6 +61,7 @@ void QgsCrashDialog::setPythonFault( const QgsCrashReport::PythonFault &fault )
   switch ( fault.cause )
   {
     case QgsCrashReport::LikelyPythonFaultCause::Unknown:
+    case QgsCrashReport::LikelyPythonFaultCause::NotPython:
       break;
 
     case QgsCrashReport::LikelyPythonFaultCause::ProcessingScript:

diff --git a/src/crashhandler/qgscrashreport.cpp b/src/crashhandler/qgscrashreport.cpp
@@ -39,8 +39,9 @@ void QgsCrashReport::setFlags( QgsCrashReport::Flags flags )
 const QString QgsCrashReport::toHtml() const
 {
   QStringList reportData;
-  QString thisCrashID = crashID();
-  reportData.append( QStringLiteral( "<b>Crash ID</b>: <a href='https://github.com/qgis/QGIS/search?q=%1&type=Issues'>%1</a>" ).arg( thisCrashID ) );
+  const QString thisCrashID = crashID();
+  if ( !thisCrashID.isEmpty() )
+    reportData.append( QStringLiteral( "<b>Crash ID</b>: <a href='https://github.com/qgis/QGIS/search?q=%1&type=Issues'>%1</a><br>" ).arg( thisCrashID ) );
 
   if ( flags().testFlag( QgsCrashReport::Stack ) )
   {
@@ -61,8 +62,8 @@ const QString QgsCrashReport::toHtml() const
 
     if ( !pythonStack.isEmpty() )
     {
-      reportData.append( QStringLiteral( "<br>" ) );
       QString pythonStackString = QStringLiteral( "<b>Python Stack Trace</b><pre>" );
+
       for ( const QString &line : pythonStack )
       {
         const thread_local QRegularExpression pythonTraceRx( QStringLiteral( "\\s*File\\s+\"(.*)\",\\s+line\\s+(\\d+)" ) );
@@ -100,7 +101,7 @@ const QString QgsCrashReport::toHtml() const
       reportData.append( pythonStackString );
     }
 
-    reportData.append( QStringLiteral( "<b>Stack Trace</b>" ) );
+    reportData.append( QStringLiteral( "<br><b>Stack Trace</b>" ) );
     if ( !mStackTrace || mStackTrace->lines.isEmpty() )
     {
       reportData.append( QStringLiteral( "No stack trace is available." ) );
@@ -164,6 +165,9 @@ const QString QgsCrashReport::toHtml() const
 
 const QString QgsCrashReport::crashID() const
 {
+  if ( mPythonFault.cause != LikelyPythonFaultCause::NotPython )
+    return QString(); // don't report crash IDs for python crashes -- they won't be representative of the cause of the crash
+
   if ( !mStackTrace )
     return QStringLiteral( "Not available" );
 
@@ -279,6 +283,9 @@ void QgsCrashReport::setPythonCrashLogFilePath( const QString &path )
     {
       line = inputStream.readLine();
 
+      if ( !line.trimmed().isEmpty() && mPythonFault.cause == LikelyPythonFaultCause::NotPython )
+        mPythonFault.cause = LikelyPythonFaultCause::Unknown;
+
       const thread_local QRegularExpression pythonTraceRx( QStringLiteral( "\\s*File\\s+\"(.*)\",\\s+line\\s+(\\d+)" ) );
 
       const QRegularExpressionMatch fileLineMatch = pythonTraceRx.match( line );

diff --git a/src/crashhandler/qgscrashreport.h b/src/crashhandler/qgscrashreport.h
@@ -48,6 +48,7 @@ class QgsCrashReport
 
     enum class LikelyPythonFaultCause
     {
+      NotPython,
       Unknown,
       ProcessingScript,
       Plugin,
@@ -103,7 +104,7 @@ class QgsCrashReport
 
     struct PythonFault
     {
-      LikelyPythonFaultCause cause = LikelyPythonFaultCause::Unknown;
+      LikelyPythonFaultCause cause = LikelyPythonFaultCause::NotPython;
       QString title;
       QString filePath;
     };