Add Crashpad Support on Windows (#4351)

* feat: crashpad on windows

* feat: inline it

* feat: more crashpad

* chore: remove qBreakpad

* fix: add mention to crashpad

* refactor: version string

* feat: add crashpad module

* refactor: build crashpad from source

* fix: minor adjustments

* chore: add changelog entry

* fix: formatting and include

* fix: format

* build: use flags similar to release profile

* ci: build with crashpad on windows

* ci: recurse submodules

* ci: always include crashpad

* fix: try 7z

for some reason zstd just doesn't run

* fix: wrong path for symbols

* fix: copy

pls don't build

* ci: use new cache key

* fix: missing pragma

* ci: add workflow without crashpad

* docs: elevate changelog entry

* fix: add link to cmake issue

* fix: windows include issue

Someone (crashpad) includes Windows.h before winsock2.h

* fix: working directory

* fix: another working directory

.github/workflows/build.yml

@@ -26,6 +26,7 @@ jobs:
         pch: [true]
         force-lto: [false]
         skip_artifact: ["no"]
+        crashpad: [true]
         include:
           # Ubuntu 20.04, Qt 5.12
           - os: ubuntu-20.04
@@ -43,6 +44,13 @@ jobs:
             pch: false
             force-lto: true
             skip_artifact: "yes"
+          # Test for disabling crashpad on Windows
+          - os: windows-latest
+            qt-version: 5.15.2
+            pch: false
+            force-lto: true
+            skip_artifact: "yes"
+            crashpad: false
       fail-fast: false
 
     steps:
@@ -52,6 +60,12 @@ jobs:
           echo "C2_ENABLE_LTO=ON" >> "$GITHUB_ENV"
         shell: bash
 
+      - name: Set Crashpad
+        if: matrix.crashpad == true
+        run: |
+          echo "C2_ENABLE_CRASHPAD=ON" >> "$GITHUB_ENV"
+        shell: bash
+
       - name: Set environment variables for windows-latest
         if: matrix.os == 'windows-latest'
         run: |
@@ -60,7 +74,7 @@ jobs:
 
       - uses: actions/checkout@v3
         with:
-          submodules: true
+          submodules: recursive
           fetch-depth: 0 # allows for tags access
 
       - name: Install Qt
@@ -76,14 +90,14 @@ jobs:
         if: startsWith(matrix.os, 'windows')
         uses: actions/cache@v3
         with:
-          key: ${{ runner.os }}-conan-user-${{ hashFiles('**/conanfile.txt') }}
+          key: ${{ runner.os }}-${{ matrix.crashpad }}-conan-user-${{ hashFiles('**/conanfile.txt') }}
           path: ~/.conan/
 
       - name: Cache conan packages part 2
         if: startsWith(matrix.os, 'windows')
         uses: actions/cache@v3
         with:
-          key: ${{ runner.os }}-conan-root-${{ hashFiles('**/conanfile.txt') }}
+          key: ${{ runner.os }}-${{ matrix.crashpad }}-conan-root-${{ hashFiles('**/conanfile.txt') }}
           path: C:/.conan/
 
       - name: Add Conan to path
@@ -110,27 +124,50 @@ jobs:
         run: |
           mkdir build
           cd build
-          conan install .. -s build_type=Release -b missing -pr:b=default
+          conan install .. -s build_type=RelWithDebInfo -b missing -pr:b=default
           cmake `
               -G"NMake Makefiles" `
-              -DCMAKE_BUILD_TYPE=Release `
+              -DCMAKE_BUILD_TYPE=RelWithDebInfo `
               -DCMAKE_TOOLCHAIN_FILE="conan_toolchain.cmake" `
+              -DBUILD_WITH_CRASHPAD="$Env:C2_ENABLE_CRASHPAD" `
               -DCHATTERINO_LTO="$Env:C2_ENABLE_LTO" `
               ..
           set cl=/MP
           nmake /S /NOLOGO
+
+      - name: Build crashpad (Windows)
+        if: startsWith(matrix.os, 'windows') && matrix.crashpad
+        run: |
+          cd build
+          set cl=/MP
+          nmake /S /NOLOGO crashpad_handler
+          mkdir Chatterino2/crashpad
+          cp bin/crashpad/crashpad_handler.exe Chatterino2/crashpad/crashpad_handler.exe
+          7z a bin/chatterino.pdb.7z bin/chatterino.pdb
+
+      - name: Package (windows)
+        if: startsWith(matrix.os, 'windows')
+        run: |
+          cd build
           windeployqt bin/chatterino.exe --release --no-compiler-runtime --no-translations --no-opengl-sw --dir Chatterino2/
           cp bin/chatterino.exe Chatterino2/
           echo nightly > Chatterino2/modes
           7z a chatterino-windows-x86-64.zip Chatterino2/
 
-      - name: Upload artifact (Windows)
+      - name: Upload artifact (Windows - binary)
-        if: startsWith(matrix.os, 'windows')
+        if: startsWith(matrix.os, 'windows') && matrix.skip_artifact != 'yes'
         uses: actions/upload-artifact@v3
         with:
           name: chatterino-windows-x86-64-${{ matrix.qt-version }}.zip
           path: build/chatterino-windows-x86-64.zip
 
+      - name: Upload artifact (Windows - symbols)
+        if: startsWith(matrix.os, 'windows') && matrix.skip_artifact != 'yes'
+        uses: actions/upload-artifact@v3
+        with:
+          name: chatterino-windows-x86-64-${{ matrix.qt-version }}-symbols.pdb.7z
+          path: build/bin/chatterino.pdb.7z
+
       - name: Clean Conan pkgs
         if: startsWith(matrix.os, 'windows')
         run: conan remove "*" -fsb

.gitmodules

@@ -2,9 +2,6 @@
 	path = lib/libcommuni
 	url = https://github.com/Chatterino/libcommuni
 	branch = chatterino-cmake
-[submodule "lib/qBreakpad"]
-	path = lib/qBreakpad
-	url = https://github.com/jiakuan/qBreakpad.git
 [submodule "lib/WinToast"]
 	path = lib/WinToast
 	url = https://github.com/mohabouje/WinToast.git
@@ -38,3 +35,6 @@
 [submodule "lib/miniaudio"]
 	path = lib/miniaudio
 	url = https://github.com/mackron/miniaudio.git
+[submodule "lib/crashpad"]
+	path = lib/crashpad
+	url = https://github.com/getsentry/crashpad

CHANGELOG.md

@@ -14,6 +14,7 @@
 - Minor: Added setting to select which channels to log. (#4302)
 - Minor: Added support for HTTP and Socks5 proxies through environment variables. (#4321)
 - Minor: Remove sending part of the multipart emoji workaround (#4361)
+- Minor: Added crashpad to capture crashes on Windows locally. See PR for build/crash analysis instructions. (#4351)
 - Bugfix: Fixed crash that would occur when performing certain actions after removing all tabs. (#4271)
 - Bugfix: Fixed highlight sounds not reloading on change properly. (#4194)
 - Bugfix: Fixed CTRL + C not working in reply thread popups. (#4209)

CMakeLists.txt

@@ -17,6 +17,7 @@ option(USE_SYSTEM_PAJLADA_SETTINGS "Use system pajlada settings library" OFF)
 option(USE_SYSTEM_LIBCOMMUNI "Use system communi library" OFF)
 option(USE_SYSTEM_QTKEYCHAIN "Use system QtKeychain library" OFF)
 option(BUILD_WITH_QTKEYCHAIN "Build Chatterino with support for your system key chain" ON)
+option(BUILD_WITH_CRASHPAD "Build chatterino with crashpad" OFF)
 option(USE_PRECOMPILED_HEADERS "Use precompiled headers" ON)
 option(BUILD_WITH_QT6 "Use Qt6 instead of default Qt5" OFF)
 option(CHATTERINO_GENERATE_COVERAGE "Generate coverage files" OFF)
@@ -148,6 +149,10 @@ else()
     add_subdirectory("${CMAKE_SOURCE_DIR}/lib/settings" EXCLUDE_FROM_ALL)
 endif()
 
+if (BUILD_WITH_CRASHPAD)
+    add_subdirectory("${CMAKE_SOURCE_DIR}/lib/crashpad" EXCLUDE_FROM_ALL)
+endif()
+
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 

resources/licenses/crashpad.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

src/CMakeLists.txt

@@ -191,6 +191,8 @@ set(SOURCE_FILES
         messages/search/SubtierPredicate.cpp
         messages/search/SubtierPredicate.hpp
 
+        providers/Crashpad.cpp
+        providers/Crashpad.hpp
         providers/IvrApi.cpp
         providers/IvrApi.hpp
         providers/LinkResolver.cpp
@@ -630,6 +632,22 @@ else()
         )
 endif()
 
+# Set the output of TARGET to be 
+# - CMAKE_BIN_DIR/lib for libraries
+# - CMAKE_BIN_DIR/bin for BINARIES
+# an additional argument specifies the subdirectory.
+function(set_target_directory_hierarchy TARGET)
+    set_target_properties(${TARGET}
+        PROPERTIES
+        ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib/${ARGV1}"
+        LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib/${ARGV1}"
+        RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/${ARGV1}"
+        RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}/bin/${ARGV1}"
+        RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}/bin/${ARGV1}"
+        RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}/bin/${ARGV1}"
+    )
+endfunction()
+
 if (BUILD_APP)
     if (APPLE)
         add_executable(${EXECUTABLE_PROJECT} ${MACOS_BUNDLE_ICON_FILE} main.cpp)
@@ -642,15 +660,7 @@ if (BUILD_APP)
 
     target_link_libraries(${EXECUTABLE_PROJECT} PUBLIC ${LIBRARY_PROJECT})
 
-    set_target_properties(${EXECUTABLE_PROJECT}
+    set_target_directory_hierarchy(${EXECUTABLE_PROJECT})
-        PROPERTIES
-        ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
-        LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
-        RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin"
-        RUNTIME_OUTPUT_DIRECTORY_RELEASE "${CMAKE_BINARY_DIR}/bin"
-        RUNTIME_OUTPUT_DIRECTORY_DEBUG "${CMAKE_BINARY_DIR}/bin"
-        RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO "${CMAKE_BINARY_DIR}/bin"
-        )
 
     if (WIN32)
         if (NOT WINDEPLOYQT_PATH)
@@ -830,8 +840,29 @@ if (LIBRT)
         )
 endif ()
 
+if (BUILD_WITH_CRASHPAD)
+    target_compile_definitions(${LIBRARY_PROJECT} PUBLIC CHATTERINO_WITH_CRASHPAD)
+    target_link_libraries(${LIBRARY_PROJECT} PUBLIC crashpad::client)
+    set_target_directory_hierarchy(crashpad_handler crashpad)
+endif()
+
 # Configure compiler warnings
 if (MSVC)
+    # Change flags for RelWithDebInfo
+
+    # Default: "/debug /INCREMENTAL"
+    # Changes:
+    #   - Disable incremental linking to reduce padding
+    #   - Enable all optimizations - by default when /DEBUG is specified,
+    #     these optimizations will be disabled. We need /DEBUG to generate a PDB.
+    # See https://gitlab.kitware.com/cmake/cmake/-/issues/20812 for more details.
+    set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "/DEBUG /INCREMENTAL:NO /OPT:REF,ICF,LBR")
+
+    # Use the function inlining level from 'Release' mode (2).
+    string(REPLACE "/Ob1" "/Ob2" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}")
+
+    # Configure warnings
+
     # Someone adds /W3 before we add /W4.
     # This makes sure, only /W4 is specified.
     string(REPLACE "/W3" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
@@ -860,6 +891,7 @@ if (MSVC)
         /wd4100
         /wd4267
     )
+    # Disable min/max macros from Windows.h
     target_compile_definitions(${LIBRARY_PROJECT} PUBLIC NOMINMAX)
 else ()
     target_compile_options(${LIBRARY_PROJECT} PUBLIC

src/RunGui.cpp

@@ -162,7 +162,7 @@ namespace {
     // true.
     void initSignalHandler()
     {
-#ifdef NDEBUG
+#if defined(NDEBUG) && !defined(CHATTERINO_WITH_CRASHPAD)
         signalsInitTime = std::chrono::steady_clock::now();
 
         signal(SIGSEGV, handleSignal);

src/common/Version.cpp

@@ -100,6 +100,9 @@ QStringList Version::buildTags() const
 #ifdef _MSC_FULL_VER
     tags.append("MSVC " + QString::number(_MSC_FULL_VER, 10));
 #endif
+#ifdef CHATTERINO_WITH_CRASHPAD
+    tags.append("Crashpad");
+#endif
 
     return tags;
 }

src/main.cpp

@@ -4,6 +4,7 @@
 #include "common/Modes.hpp"
 #include "common/QLogging.hpp"
 #include "common/Version.hpp"
+#include "providers/Crashpad.hpp"
 #include "providers/IvrApi.hpp"
 #include "providers/NetworkConfigurationProvider.hpp"
 #include "providers/twitch/api/Helix.hpp"
@@ -11,7 +12,6 @@
 #include "singletons/Paths.hpp"
 #include "singletons/Settings.hpp"
 #include "util/AttachToConsole.hpp"
-#include "util/IncognitoBrowser.hpp"
 
 #include <QApplication>
 #include <QCommandLineParser>
@@ -59,6 +59,10 @@ int main(int argc, char **argv)
 
     initArgs(a);
 
+#ifdef CHATTERINO_WITH_CRASHPAD
+    const auto crashpadHandler = installCrashHandler();
+#endif
+
     // run in gui mode or browser extension host mode
     if (getArgs().shouldRunBrowserExtensionHost)
     {

src/providers/Crashpad.cpp

@@ -0,0 +1,95 @@
+#ifdef CHATTERINO_WITH_CRASHPAD
+#    include "providers/Crashpad.hpp"
+
+#    include "common/QLogging.hpp"
+#    include "singletons/Paths.hpp"
+
+#    include <QApplication>
+#    include <QDir>
+#    include <QString>
+
+#    include <memory>
+#    include <string>
+
+namespace {
+
+/// The name of the crashpad handler executable.
+/// This varies across platforms
+#    if defined(Q_OS_UNIX)
+const QString CRASHPAD_EXECUTABLE_NAME = QStringLiteral("crashpad_handler");
+#    elif defined(Q_OS_WINDOWS)
+const QString CRASHPAD_EXECUTABLE_NAME = QStringLiteral("crashpad_handler.exe");
+#    else
+#        error Unsupported platform
+#    endif
+
+/// Converts a QString into the platform string representation.
+#    if defined(Q_OS_UNIX)
+std::string nativeString(const QString &s)
+{
+    return s.toStdString();
+}
+#    elif defined(Q_OS_WINDOWS)
+std::wstring nativeString(const QString &s)
+{
+    return s.toStdWString();
+}
+#    else
+#        error Unsupported platform
+#    endif
+
+}  // namespace
+
+namespace chatterino {
+
+std::unique_ptr<crashpad::CrashpadClient> installCrashHandler()
+{
+    // Currently, the following directory layout is assumed:
+    // [applicationDirPath]
+    //  │
+    //  ├─chatterino
+    //  │
+    //  ╰─[crashpad]
+    //     │
+    //     ╰─crashpad_handler
+    // TODO: The location of the binary might vary across platforms
+    auto crashpadBinDir = QDir(QApplication::applicationDirPath());
+
+    if (!crashpadBinDir.cd("crashpad"))
+    {
+        qCDebug(chatterinoApp) << "Cannot find crashpad directory";
+        return nullptr;
+    }
+    if (!crashpadBinDir.exists(CRASHPAD_EXECUTABLE_NAME))
+    {
+        qCDebug(chatterinoApp) << "Cannot find crashpad handler executable";
+        return nullptr;
+    }
+
+    const auto handlerPath = base::FilePath(nativeString(
+        crashpadBinDir.absoluteFilePath(CRASHPAD_EXECUTABLE_NAME)));
+
+    // Argument passed in --database
+    // > Crash reports are written to this database, and if uploads are enabled,
+    //   uploaded from this database to a crash report collection server.
+    const auto databaseDir =
+        base::FilePath(nativeString(getPaths()->crashdumpDirectory));
+
+    auto client = std::make_unique<crashpad::CrashpadClient>();
+
+    // See https://chromium.googlesource.com/crashpad/crashpad/+/HEAD/handler/crashpad_handler.md
+    // for documentation on available options.
+    if (!client->StartHandler(handlerPath, databaseDir, {}, {}, {}, {}, true,
+                              false))
+    {
+        qCDebug(chatterinoApp) << "Failed to start crashpad handler";
+        return nullptr;
+    }
+
+    qCDebug(chatterinoApp) << "Started crashpad handler";
+    return client;
+}
+
+}  // namespace chatterino
+
+#endif

src/providers/Crashpad.hpp

@@ -0,0 +1,14 @@
+#pragma once
+
+#ifdef CHATTERINO_WITH_CRASHPAD
+#    include <client/crashpad_client.h>
+
+#    include <memory>
+
+namespace chatterino {
+
+std::unique_ptr<crashpad::CrashpadClient> installCrashHandler();
+
+}  // namespace chatterino
+
+#endif

src/providers/NetworkConfigurationProvider.hpp

@@ -3,7 +3,7 @@
 #include "common/QLogging.hpp"
 
 #include <QNetworkProxy>
-#include <websocketpp/connection.hpp>
+#include <websocketpp/error.hpp>
 
 #include <string>
 
@@ -25,9 +25,7 @@ public:
      */
     static void applyFromEnv(const Env &env);
 
-    template <class C>
+    static void applyToWebSocket(const auto &connection)
-    static void applyToWebSocket(
-        const std::shared_ptr<websocketpp::connection<C>> &connection)
     {
         const auto applicationProxy = QNetworkProxy::applicationProxy();
         if (applicationProxy.type() != QNetworkProxy::HttpProxy)

src/singletons/Paths.cpp

@@ -141,6 +141,7 @@ void Paths::initSubDirectories()
     this->messageLogDirectory = makePath("Logs");
     this->miscDirectory = makePath("Misc");
     this->twitchProfileAvatars = makePath("ProfileAvatars");
+    this->crashdumpDirectory = makePath("Crashes");
     //QDir().mkdir(this->twitchProfileAvatars + "/twitch");
 }
 

src/singletons/Paths.hpp

@@ -25,6 +25,9 @@ public:
     // Directory for miscellaneous files. Same as <appDataDirectory>/Misc
     QString miscDirectory;
 
+    // Directory for crashdumps. Same as <appDataDirectory>/Crashes
+    QString crashdumpDirectory;
+
     // Hash of QCoreApplication::applicationFilePath()
     QString applicationFilePathHash;
 

src/widgets/settingspages/AboutPage.cpp

@@ -113,6 +113,11 @@ AboutPage::AboutPage()
             addLicense(form.getElement(), "miniaudio",
                        "https://github.com/mackron/miniaudio",
                        ":/licenses/miniaudio.txt");
+#ifdef CHATTERINO_WITH_CRASHPAD
+            addLicense(form.getElement(), "sentry-crashpad",
+                       "https://github.com/getsentry/crashpad",
+                       ":/licenses/crashpad.txt");
+#endif
         }
 
         // Attributions