Use crashpad

Author: edolstra

packaging/dependencies.nix

@@ -148,7 +148,7 @@ scope: {
     idnSupport = !stdenv.hostPlatform.isStatic;
   };
 
-  sentry-native = pkgs.sentry-native.override {
+  sentry-native = (pkgs.callPackage ./sentry-native.nix { }).override {
     # Avoid having two curls in our closure.
     inherit (scope) curl;
   };

packaging/sentry-native.nix

@@ -0,0 +1,38 @@
+{
+  lib,
+  stdenv,
+  fetchgit,
+  cmake,
+  curl,
+  pkg-config,
+}:
+
+stdenv.mkDerivation rec {
+  pname = "sentry-native";
+  version = "0.13.5";
+
+  src = fetchgit {
+    url = "https://github.com/getsentry/sentry-native";
+    tag = version;
+    hash = "sha256-vDBI6lB1DMLleAgRCfsHvTSdtmXOzvJSaNAt+NwOd3c=";
+    fetchSubmodules = true;
+  };
+
+  nativeBuildInputs = [
+    cmake
+    pkg-config
+  ];
+
+  buildInputs = [
+    curl
+  ];
+
+  cmakeBuildType = "RelWithDebInfo";
+
+  cmakeFlags = [ ];
+
+  outputs = [
+    "out"
+    "dev"
+  ];
+}

src/nix/main.cc

@@ -384,14 +384,18 @@ void mainWrapped(int argc, char ** argv)
     bool sentryEnabled = false;
 
 #if HAVE_SENTRY
-    if (getEnv("NIX_DISABLE_SENTRY").value_or("") != "1") {
+    auto sentryEndpoint =
+        getEnv("NIX_SENTRY_ENDPOINT")
+            .value_or(
+                "https://ca42fa4b6b08ae1caf3d96b998af6bac@o4506062689927168.ingest.us.sentry.io/4511151087878144");
+    if (sentryEndpoint != "") {
         sentry_options_t * options = sentry_options_new();
-        sentry_options_set_dsn(
-            options, "https://ca42fa4b6b08ae1caf3d96b998af6bac@o4506062689927168.ingest.us.sentry.io/4511151087878144");
+        sentry_options_set_dsn(options, sentryEndpoint.c_str());
         sentry_options_set_database_path(options, (getCacheDir() / "sentry").string().c_str());
         sentry_options_set_release(options, fmt("nix@%s", determinateNixVersion).c_str());
         sentry_options_set_traces_sample_rate(options, 0);
         sentry_options_set_auto_session_tracking(options, false);
+        sentry_options_set_handler_path(options, CRASHPAD_HANDLER_PATH);
         sentry_init(options);
         sentryEnabled = true;
     }

src/nix/meson.build

@@ -52,6 +52,14 @@ configdata.set_quoted('NIX_MAN_DIR', mandir)
 
 sentry_required = get_option('sentry')
 configdata.set('HAVE_SENTRY', sentry_required.enabled().to_int())
+if sentry_required.enabled()
+  crashpad_handler_path = get_option('crashpad-handler')
+  assert(
+    crashpad_handler_path != '',
+    'crashpad-handler path must be set when sentry is enabled',
+  )
+  configdata.set_quoted('CRASHPAD_HANDLER_PATH', crashpad_handler_path)
+endif
 
 config_priv_h = configure_file(
   configuration : configdata,

src/nix/meson.options

@@ -14,3 +14,10 @@ option(
   value : 'auto',
   description : 'Enable Sentry crash reporting',
 )
+
+option(
+  'crashpad-handler',
+  type : 'string',
+  value : '',
+  description : 'Path to the crashpad_handler binary (required when sentry is enabled)',
+)

src/nix/package.nix

@@ -83,7 +83,10 @@ mkMesonExecutable (finalAttrs: {
 
   mesonFlags = [
     (lib.mesonEnable "sentry" enableSentry)
-  ];
+  ]
+  ++ lib.optional enableSentry (
+    lib.mesonOption "crashpad-handler" "${sentry-native}/bin/crashpad_handler"
+  );
 
   postInstall = lib.optionalString stdenv.hostPlatform.isStatic ''
     mkdir -p $out/nix-support

tests/functional/common/init.sh

@@ -4,7 +4,7 @@
 : "${test_nix_conf_dir?}" "${test_nix_conf?}"
 
 # Don't upload crashes from tests to Sentry.
-export NIX_DISABLE_SENTRY=1
+export NIX_SENTRY_ENDPOINT=
 
 if isTestOnNixOS; then
 

tests/functional/sentry.sh

@@ -2,7 +2,8 @@
 
 source common.sh
 
-unset NIX_DISABLE_SENTRY
+# This doesn't actually work, but it prevents sentry from uploading for real.
+export NIX_SENTRY_ENDPOINT=file://$TEST_ROOT/sentry-endpoint
 
 ulimit -c 0
 
@@ -20,7 +21,7 @@ for type in segfault assert logic-error; do
 
     [[ -e $sentryDir/last_crash ]]
 
-    envelopes=("$sentryDir"/*.run/*.envelope)
+    envelopes=("$sentryDir"/pending/*.dmp)
     if [[ ! -e "${envelopes[0]}" ]]; then
         fail "No crash dump found in $sentryDir after crash"
     fi