crash: add crash reporter

Author: outfoxxed

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/crash.yml

@@ -0,0 +1,72 @@
+name: Crash Report
+description: Quickshell has crashed
+labels: ["bug", "crash"]
+body:
+  - type: textarea
+    id: crashinfo
+    attributes:
+      label: General crash information
+      description: |
+        Paste the contents of the `info.txt` file in your crash folder here.
+      value: "<details> <summary>General information</summary>
+
+
+        ```
+
+        <Paste the contents of the file here inside of the triple backticks>
+
+        ```
+
+
+        </details>"
+    validations:
+        required: true
+  - type: textarea
+    id: userinfo
+    attributes:
+      label: What caused the crash
+      description: |
+        Any information likely to help debug the crash. What were you doing when the crash occurred,
+        what changes did you make, can you get it to happen again?
+  - type: textarea
+    id: dump
+    attributes:
+      label: Minidump
+      description: |
+        Attach `minidump.dmp` here. If it is too big to upload, compress it.
+
+        You may skip this step if quickshell crashed while processing a password
+        or other sensitive information. If you skipped it write why instead.
+    validations:
+        required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Log file
+      description: |
+        Attach `log.qslog` here. If it is too big to upload, compress it.
+
+        You can preview the log if you'd like using `quickshell read-log <path-to-log>`.
+    validations:
+        required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Configuration
+      description: |
+        Attach your configuration here, preferrably in full (not just one file).
+        Compress it into a zip, tar, etc.
+
+        This will help us reproduce the crash ourselves.
+  - type: textarea
+    id: bt
+    attributes:
+      label: Backtrace
+      description: |
+        If you have gdb installed and use systemd, or otherwise know how to get a backtrace,
+        we would appreciate one. (You may have gdb installed without knowing it)
+
+        1. Run `coredumpctl debug <pid>` where `pid` is the number shown after "Crashed process ID"
+        in the crash reporter.
+        2. Once it loads, type `bt -full` (then enter)
+        3. Copy the output and attach it as a file or in a spoiler.

CMakeLists.txt

@@ -9,6 +9,7 @@ option(BUILD_TESTING "Build tests" OFF)
 option(ASAN "Enable ASAN" OFF) # note: better output with gcc than clang
 option(FRAME_POINTERS "Always keep frame pointers" ${ASAN})
 
+option(CRASH_REPORTER "Enable the crash reporter" ON)
 option(USE_JEMALLOC "Use jemalloc over the system malloc implementation" ON)
 option(SOCKETS "Enable unix socket support" ON)
 option(WAYLAND "Enable wayland support" ON)
@@ -29,6 +30,7 @@ option(SERVICE_UPOWER "UPower service" ON)
 option(SERVICE_NOTIFICATIONS "Notification server" ON)
 
 message(STATUS "Quickshell configuration")
+message(STATUS "  Crash reporter: ${CRASH_REPORTER}")
 message(STATUS "  Jemalloc: ${USE_JEMALLOC}")
 message(STATUS "  Build tests: ${BUILD_TESTING}")
 message(STATUS "  Sockets: ${SOCKETS}")

default.nix

@@ -9,6 +9,7 @@
   ninja,
   qt6,
   cli11,
+  breakpad,
   jemalloc,
   wayland,
   wayland-protocols,
@@ -28,6 +29,7 @@
      else "unknown"),
 
   debug ? false,
+  withCrashReporter ? true,
   withJemalloc ? true, # masks heap fragmentation
   withQtSvg ? true,
   withWayland ? true,
@@ -55,6 +57,7 @@
     qt6.qtdeclarative
     cli11
   ]
+  ++ (lib.optional withCrashReporter breakpad)
   ++ (lib.optional withJemalloc jemalloc)
   ++ (lib.optional withQtSvg qt6.qtsvg)
   ++ (lib.optionals withWayland [ qt6.qtwayland wayland ])
@@ -67,6 +70,7 @@
   cmakeBuildType = if debug then "Debug" else "RelWithDebInfo";
 
   cmakeFlags = [ "-DGIT_REVISION=${gitRev}" ]
+  ++ lib.optional (!withCrashReporter) "-DCRASH_REPORTER=OFF"
   ++ lib.optional (!withJemalloc) "-DUSE_JEMALLOC=OFF"
   ++ lib.optional (!withWayland) "-DWAYLAND=OFF"
   ++ lib.optional (!withPipewire) "-DSERVICE_PIPEWIRE=OFF"

src/CMakeLists.txt

@@ -5,6 +5,10 @@ install(TARGETS quickshell RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
 add_subdirectory(core)
 add_subdirectory(io)
 
+if (CRASH_REPORTER)
+	add_subdirectory(crash)
+endif()
+
 if (DBUS)
 	add_subdirectory(dbus)
 endif()

src/core/CMakeLists.txt

@@ -41,9 +41,19 @@ qt_add_library(quickshell-core STATIC
 	clock.cpp
 	logging.cpp
 	paths.cpp
+	crashinfo.cpp
+	common.cpp
 )
 
-set_source_files_properties(main.cpp PROPERTIES COMPILE_DEFINITIONS GIT_REVISION="${GIT_REVISION}")
+if (CRASH_REPORTER)
+	set(CRASH_REPORTER_DEF 1)
+endif()
+
+add_library(quickshell-build INTERFACE)
+configure_file(build.hpp.in build.hpp)
+target_include_directories(quickshell-build INTERFACE ${CMAKE_CURRENT_BINARY_DIR})
+target_link_libraries(quickshell-core PRIVATE quickshell-build)
+
 qt_add_qml_module(quickshell-core URI Quickshell VERSION 0.1)
 
 target_link_libraries(quickshell-core PRIVATE ${QT_DEPS} Qt6::QuickPrivate CLI11::CLI11)

src/core/build.hpp.in

@@ -0,0 +1,6 @@
+#pragma once
+
+// NOLINTBEGIN
+#define GIT_REVISION "@GIT_REVISION@"
+#define CRASH_REPORTER @CRASH_REPORTER_DEF@
+// NOLINTEND

src/core/common.cpp

@@ -0,0 +1,9 @@
+#include "common.hpp"
+
+#include <qdatetime.h>
+
+namespace qs {
+
+const QDateTime Common::LAUNCH_TIME = QDateTime::currentDateTime();
+
+}

src/core/common.hpp

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <qdatetime.h>
+
+namespace qs {
+
+struct Common {
+	static const QDateTime LAUNCH_TIME;
+};
+
+} // namespace qs

src/core/crashinfo.cpp

@@ -0,0 +1,19 @@
+#include "crashinfo.hpp"
+
+#include <qdatastream.h>
+
+QDataStream& operator<<(QDataStream& stream, const InstanceInfo& info) {
+	stream << info.configPath << info.shellId << info.launchTime << info.noColor;
+	return stream;
+}
+
+QDataStream& operator>>(QDataStream& stream, InstanceInfo& info) {
+	stream >> info.configPath >> info.shellId >> info.launchTime >> info.noColor;
+	return stream;
+}
+
+namespace qs::crash {
+
+CrashInfo CrashInfo::INSTANCE = {}; // NOLINT
+
+}