Infrastructure: add sentry crash reporting #7664

vadi2 · 2025-01-15T09:21:11Z

Brief overview of PR changes/additions

Add sentry for reporting when crashes happen.

Motivation for adding to Mudlet

So we can tell when Mudlet crashes - and fix any such issues!

Other info (issues closed, discussion etc)

IP address collection has been disabled in sentry settings to protect privacy of those who upload a crash.

This is a re-run of #7618 but from the Mudlet repository, enabling secrets and thus sentry upload.

This PR is still a work in progress. TODO:

get Linux to report line #'s in stack traces reliably
add sentry integration into AppImages, enable it for testing/ptb/release builds
upload source code in Linux build
upload debug symbols for Mudlet and Luarocks .so's to sentry for Linux
add sentry integration for macOS and test
upload source code in macOS build (duplicate uploads for simplicity)
upload debug symbols for Mudlet and Luarocks .so's to sentry for macOS
add sentry integration into macOS packaging, enable it for testing/ptb/release builds

…imization settings

Error: CURL: Required feature AsynchDNS is not found

This reverts commit 20bd9e2.

…preter.cpp for testing purposes

…ad of Git repository

…add-sentry-crash-reporting # Conflicts: # .github/workflows/build-mudlet.yml

…it_cast

This reverts commit d4b2a94.

add-deployment-links · 2025-01-15T09:21:14Z

Hey there! Thanks for helping Mudlet improve. 🌟

Test versions

You can directly test the changes here:

linux: https://make.mudlet.org/snapshots/696ca7/Mudlet-4.19.1-testing-pr7664-690e8e66-linux-x64.AppImage.tar (commit 690e8e6)
osx intel: https://make.mudlet.org/snapshots/0ea92a/Mudlet-4.19.1-testing-pr7664-690e8e66-x86_64.dmg (commit 690e8e6)
osx arm: https://make.mudlet.org/snapshots/f242ef/Mudlet-4.19.1-testing-pr7664-690e8e66-arm64.dmg (commit 690e8e6)
windows 64 bit: https://make.mudlet.org/snapshots/e1b5c0/Mudlet-4.19.1-testing-pr7664-690e8e66-windows-64.zip (commit 690e8e6)
windows 32 bit: https://make.mudlet.org/snapshots/814aa9/Mudlet-4.19.1-testing-pr7664-b76fabc1-windows-32.zip (commit b76fabc)

No need to install anything - just unzip and run.
Let us know if it works well, and if it doesn't, please give details.

…racking" This reverts commit 6c83661.

This reverts commit 7bd36da.

This reverts commit 605e317.

…type

greptile-apps

PR Summary

Here's a summary of the key changes in this PR that adds Sentry crash reporting to Mudlet:

Adds Sentry crash reporting integration with user privacy controls and build-specific configurations:

Added Sentry native SDK v0.7.17 integration with crashpad handler for crash reporting
Implemented user-configurable crash reporting settings in preferences dialog for both release and testing builds
Added debug symbol and source code uploading to sentry.io for better crash analysis
Disabled IP address collection in sentry settings to protect user privacy
Added conditional compilation guards to enable/disable Sentry features based on build type

Key implementation points:

Crash reports are off by default for releases but enabled for testing builds
Sentry integration is properly isolated behind USE_SENTRY compile flag
Includes proper cleanup and initialization of Sentry resources
Added GCC 11 compiler requirement for better C++20 support
Implemented build system changes to handle debug symbols and crashpad handler

_{💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!}

_{11 file(s) reviewed, 8 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-03-13T17:52:07Z

3rdparty/sentry/BuildSentry.cmake

+    URL https://github.com/getsentry/sentry-native/releases/download/0.7.17/sentry-native.zip
+    SOURCE_SUBDIR "NeedManualAddSubDir"


style: Add URL_HASH parameter to verify the downloaded archive integrity

greptile-apps · 2025-03-13T17:52:07Z

3rdparty/sentry/BuildSentry.cmake

+FetchContent_Declare(
+    sentry
+    URL https://github.com/getsentry/sentry-native/releases/download/0.7.17/sentry-native.zip
+    SOURCE_SUBDIR "NeedManualAddSubDir"


logic: SOURCE_SUBDIR value 'NeedManualAddSubDir' appears incorrect - should be the actual subdirectory containing CMakeLists.txt in the Sentry archive

greptile-apps · 2025-03-13T17:52:12Z

CMakeLists.txt

+  set(SENTRY_VERSION 0.7.17)
+  set(SENTRY_BACKEND "crashpad" CACHE STRING "Use crashpad backend" FORCE)
+  set(SENTRY_INTEGRATION_QT "ON" CACHE STRING "Enable Qt integration" FORCE)


style: These Sentry settings should be marked as advanced CMake options to avoid cluttering the basic configuration

greptile-apps · 2025-03-13T17:52:12Z

CMakeLists.txt

 if(USE_UPDATER)
  add_subdirectory(3rdparty/dblsqd)
 endif()

 set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
 set(CMAKE_INTERPROCEDURAL_OPTIMIZATION_RELEASE -O3)
 set(CMAKE_INTERPROCEDURAL_OPTIMIZATION_DEBUG -O0)
+


syntax: Trailing whitespace at end of file

Suggested change

greptile-apps · 2025-03-13T17:52:33Z

src/CMakeLists.txt

+    ${CMAKE_BINARY_DIR}/_deps/sentry-build/crashpad_build/handler/crashpad_handler
+    $<TARGET_FILE_DIR:mudlet>/crashpad_handler


style: Path may be incorrect on Windows where backslashes are used. Consider using file(TO_NATIVE_PATH) to ensure cross-platform compatibility.

greptile-apps · 2025-03-13T17:52:45Z

src/main.cpp

+    auto* versions = static_cast<VersionInfo*>(closure);
+    if (versions->isRelease) {
+        // For release builds, check smSendCrashesForReleases
+        if (!mudlet::self()->smSendCrashesForReleases) {


logic: Accessing mudlet::self() before mudlet::start() could cause a crash

greptile-apps · 2025-03-13T17:52:46Z

src/main.cpp

+    VersionInfo versions{releaseVersion, publicTestVersion, testingVersion};
+    sentry_options_set_before_send(options, before_send, &versions);
+


logic: VersionInfo struct passed by pointer but used after scope ends in before_send callback

Suggested change

VersionInfo versions{releaseVersion, publicTestVersion, testingVersion};

sentry_options_set_before_send(options, before_send, &versions);

static VersionInfo versions{releaseVersion, publicTestVersion, testingVersion};

sentry_options_set_before_send(options, before_send, &versions);

greptile-apps · 2025-03-13T17:53:02Z

src/dlgProfilePreferences.cpp

+    checkBox_crashreportsOfficial->setChecked(mudlet::self()->smSendCrashesForReleases);
+        checkBox_crashreportsTesting->setChecked(mudlet::self()->smSendCrashesForTesting);
+    // only show the "Crash reports" section for testing/PTB releases if we're on one,
+    // otherwise don't add visual clutter
+    if (!mudlet::self()->releaseVersion) {
+        checkBox_crashreportsTesting->show();
+    } else {
+        checkBox_crashreportsTesting->hide();
+    }


style: Indentation issue - there is an extra space before checkBox_crashreportsTesting->setChecked() that should be removed for consistency

Suggested change

checkBox_crashreportsOfficial->setChecked(mudlet::self()->smSendCrashesForReleases);

checkBox_crashreportsTesting->setChecked(mudlet::self()->smSendCrashesForTesting);

// only show the "Crash reports" section for testing/PTB releases if we're on one,

// otherwise don't add visual clutter

if (!mudlet::self()->releaseVersion) {

checkBox_crashreportsTesting->show();

} else {

checkBox_crashreportsTesting->hide();

}

checkBox_crashreportsOfficial->setChecked(mudlet::self()->smSendCrashesForReleases);

checkBox_crashreportsTesting->setChecked(mudlet::self()->smSendCrashesForTesting);

// only show the "Crash reports" section for testing/PTB releases if we're on one,

// otherwise don't add visual clutter

if (!mudlet::self()->releaseVersion) {

checkBox_crashreportsTesting->show();

} else {

checkBox_crashreportsTesting->hide();

}

vadi2 and others added 30 commits December 29, 2024 18:57

Initial config

4bec3ae

Add Sentry using FetchContent

ba2e43b

Add an example of Sentry event capture functionality

6e3e786

Link Mudlet with Sentry library in CMake configuration

d868234

Add a sample crash

87211c3

Remove EXCLUDE_FROM_ALL from Sentry subdirectory installation

e4f9159

Remove sample Sentry event capture from main.cpp

d43c8d2

Enable ccache and add status message; comment out interprocedural opt…

a2fab93

…imization settings

Fix Sentry path and simplify sample crash emulation

06dd375

Update build workflow to use Ubuntu 22.04

20bd9e2

Error: CURL: Required feature AsynchDNS is not found

Revert "Update build workflow to use Ubuntu 22.04"

d82e65f

This reverts commit 20bd9e2.

Remove sample crash emulation from mudlet.cpp and add it to TLuaInter…

6130b9f

…preter.cpp for testing purposes

Update Sentry build configuration to use the latest release zip inste…

4bd7e20

…ad of Git repository

Update Sentry build configuration to use specific version 0.7.17

0e37c27

Add custom command to copy crashpad_handler after mudlet build

17ab1ad

Update installer clone command to use 'add-sentry' branch

2beebda

Enable Sentry.io for release builds in GitHub Actions workflow

84b8f17

Add Sentry backend and Qt integration options in CMake configuration

cbf30ba

Merge branch 'development' into add-sentry-crash-reporting

75edb0b

Add libcurl4-openssl-dev to build workflow for asyncDNS support

f661193

Merge remote-tracking branch 'vadi2/add-sentry-crash-reporting' into …

40fcbac

…add-sentry-crash-reporting # Conflicts: # .github/workflows/build-mudlet.yml

Update GCC compiler version to 11 in build workflow to support std::b…

8252c95

…it_cast

Add QStandardPaths include to main.cpp

188fad8

Add QScopeGuard include to main.cpp

0430878

Update build workflow to use Ubuntu 22.04 for GCC 11

83ddd7c

Try gcc 12

94e4ee6

Remove sample crash code from TLuaInterpreter::initLuaGlobals

a974eb9

Try with GCC 13 before going to Qt6

d4b2a94

Revert "Try with GCC 13 before going to Qt6"

1df96a1

This reverts commit d4b2a94.

Merge branch 'development' into add-sentry-crash-reporting

b0bea58

vadi2 added 2 commits January 15, 2025 10:27

Add message for missing SENTRY_AUTH_TOKEN in debug symbol upload step

d27c438

Upload Luarocks in another way

de12729

vadi2 mentioned this pull request Jan 15, 2025

Infrastructure: add sentry crash reporting #7618

Closed

12 tasks

vadi2 and others added 10 commits January 15, 2025 11:12

Add debug messages for timers

605e317

Add debug messages to destructor for better traceability

7bd36da

Enable debug messages in slot_timerFires for enhanced timer tracking

6c83661

Revert "Enable debug messages in slot_timerFires for enhanced timer t…

909fed8

…racking" This reverts commit 6c83661.

Revert "Add debug messages to destructor for better traceability"

5932d1d

This reverts commit 7bd36da.

Revert "Add debug messages for timers"

6f98862

This reverts commit 605e317.

Disable debug mode in Sentry options for production readiness

9fe6c4f

Add environment configuration for Sentry based on build type

de354e9

Merge branch 'development' into add-sentry-crash-reporting

b76fabc

Merge branch 'development' into add-sentry-crash-reporting

0811b5e

vadi2 mentioned this pull request Feb 9, 2025

Implement sentry.io's Qt SDK for crash reporting #7126

Open

Arian8j2 mentioned this pull request Feb 9, 2025

Add sentry.io's Qt SDK for crash reporting #7705

Closed

vadi2 and others added 13 commits February 9, 2025 10:43

Add settings for crash reporting options in Mudlet

6559d10

Add checkboxes to UI

d590b60

UI: hide crash reporting test options in release builds

385eece

UI: update crash reporting settings in profile preferences

356af32

UI: add before-send handler for crash reporting options

3ba29b1

Fix missing closing brace in readEarlySettings function

4172e1c

UI: implement before-send handler for crash reporting based on build …

05336d8

…type

UI: add intentional crash for testing purposes in TLuaInterpreter

34e4c5e

Merge branch 'development' into add-sentry-crash-reporting

7af0be3

wrap Sentry-related code in conditional compilation block

4b445e5

UI: update intentional crash address for testing in TLuaInterpreter

87ac270

remove intentional crash for testing in TLuaInterpreter

c6546d2

Merge branch 'development' into add-sentry-crash-reporting

690e8e6

greptile-apps bot reviewed Mar 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Infrastructure: add sentry crash reporting #7664

Infrastructure: add sentry crash reporting #7664

Uh oh!

vadi2 commented Jan 15, 2025 •

edited

Loading

Uh oh!

add-deployment-links bot commented Jan 15, 2025 •

edited

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

greptile-apps bot Mar 13, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

		URL https://github.com/getsentry/sentry-native/releases/download/0.7.17/sentry-native.zip
		SOURCE_SUBDIR "NeedManualAddSubDir"

		${CMAKE_BINARY_DIR}/_deps/sentry-build/crashpad_build/handler/crashpad_handler
		$<TARGET_FILE_DIR:mudlet>/crashpad_handler

		VersionInfo versions{releaseVersion, publicTestVersion, testingVersion};
		sentry_options_set_before_send(options, before_send, &versions);

Uh oh!

Infrastructure: add sentry crash reporting #7664

Are you sure you want to change the base?

Infrastructure: add sentry crash reporting #7664

Uh oh!

Conversation

vadi2 commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Brief overview of PR changes/additions

Motivation for adding to Mudlet

Other info (issues closed, discussion etc)

Uh oh!

add-deployment-links bot commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test versions

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

vadi2 commented Jan 15, 2025 •

edited

Loading

add-deployment-links bot commented Jan 15, 2025 •

edited

Loading