feat(sentry-native): add options_set_native_database_path option

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add `options_set_native_database_path` option to set the database path for Sentry Native ([#3236](https://github.com/getsentry/sentry-dart/pull/3236))
+
 ## 9.7.0-beta.3
 
 ### Fixes

packages/flutter/ffi-native.yaml

@@ -19,6 +19,7 @@ functions:
     - sentry_options_set_dist
     - sentry_options_set_max_breadcrumbs
     - sentry_options_set_handler_path
+    - sentry_options_set_database_path
     - sentry_set_user
     - sentry_remove_user
     - sentry_add_breadcrumb

packages/flutter/lib/src/native/c/binding.dart

@@ -640,6 +640,52 @@ class SentryNative {
           void Function(
               ffi.Pointer<sentry_options_s>, ffi.Pointer<ffi.Char>)>();
 
+  /// Sets the path to the Sentry Database Directory.
+  ///
+  /// Sentry will use this path to persist user consent, sessions, and other
+  /// artifacts in case of a crash. This will also be used by the crashpad backend
+  /// if it is configured.
+  ///
+  /// The directory is used for "cached" data, which needs to persist across
+  /// application restarts to ensure proper flagging of release-health sessions,
+  /// but might otherwise be safely purged regularly.
+  ///
+  /// It is roughly equivalent to the type of `AppData/Local` on Windows and
+  /// `XDG_CACHE_HOME` on Linux, and equivalent runtime directories on other
+  /// platforms.
+  ///
+  /// It is recommended that users set an explicit absolute path, depending
+  /// on their apps runtime directory. The path will be created if it does not
+  /// exist, and will be resolved to an absolute path inside of `sentry_init`. The
+  /// directory should not be shared with other application data/configuration, as
+  /// sentry-native will enumerate and possibly delete files in that directory. An
+  /// example might be `$XDG_CACHE_HOME/your-app/sentry`
+  ///
+  /// If no explicit path it set, sentry-native will default to `.sentry-native` in
+  /// the current working directory, with no specific platform-specific handling.
+  ///
+  /// `path` is assumed to be in platform-specific filesystem path encoding.
+  /// API Users on windows are encouraged to use
+  /// `sentry_options_set_database_pathw` instead.
+  void options_set_database_path(
+    ffi.Pointer<sentry_options_s> opts,
+    ffi.Pointer<ffi.Char> path,
+  ) {
+    return _options_set_database_path(
+      opts,
+      path,
+    );
+  }
+
+  late final _options_set_database_pathPtr = _lookup<
+      ffi.NativeFunction<
+          ffi.Void Function(ffi.Pointer<sentry_options_s>,
+              ffi.Pointer<ffi.Char>)>>('sentry_options_set_database_path');
+  late final _options_set_database_path =
+      _options_set_database_pathPtr.asFunction<
+          void Function(
+              ffi.Pointer<sentry_options_s>, ffi.Pointer<ffi.Char>)>();
+
   /// Initializes the Sentry SDK with the specified options.
   ///
   /// This takes ownership of the options.  After the options have been set

packages/flutter/lib/src/native/c/sentry_native.dart

@@ -69,6 +69,10 @@ class SentryNative with SentryNativeSafeInvoker implements SentryNativeBinding {
           cOptions, options.enableAutoSessionTracking ? 1 : 0);
       native.options_set_dist(cOptions, c.str(options.dist));
       native.options_set_max_breadcrumbs(cOptions, options.maxBreadcrumbs);
+      if (options.nativeDatabasePath != null) {
+        native.options_set_database_path(
+            cOptions, c.str(options.nativeDatabasePath));
+      }
       if (options.proxy != null) {
         // sentry-native expects a single string and it doesn't support different types or authentication
         options.log(SentryLevel.warning,

packages/flutter/lib/src/sentry_flutter_options.dart

@@ -291,6 +291,22 @@ class SentryFlutterOptions extends SentryOptions {
   /// Screen content masking is enabled by default.
   final privacy = SentryPrivacyOptions();
 
+  /// Sets the path to the Sentry Database Directory used in the Sentry Native SDK.
+  ///
+  /// **Default behavior**: When `null` (the default), the path defaults to
+  /// `.sentry-native` in the current working directory (CWD).
+  ///
+  /// **Important**: While using the default is convenient for development, we
+  /// strongly recommend providing an explicit database path for production
+  /// deployments to ensure predictable behavior.
+  ///
+  /// This option is only used on platforms that utilize the Sentry Native SDK directly,
+  /// specifically Desktop Linux and Windows.
+  ///
+  /// For more information, see:
+  /// https://docs.sentry.io/platforms/native/configuration/options/#database-path
+  String? nativeDatabasePath;
+
   /// By using this, you are disabling native [Breadcrumb] tracking and instead
   /// you are just tracking [Breadcrumb]s which result from events available
   /// in the current Flutter environment.

packages/flutter/test/sentry_native/sentry_native_test_ffi.dart

@@ -139,6 +139,28 @@ void main() {
         await sut.init(MockHub());
       });
 
+      test('init creates native database path directory when configured',
+          () async {
+        final dbDir = Directory(
+            '${helper.nativeTestRoot}/db-${backend.actualValue.name}');
+        if (dbDir.existsSync()) {
+          dbDir.deleteSync(recursive: true);
+        }
+
+        options.nativeDatabasePath = dbDir.path;
+
+        addTearDown(() {
+          if (dbDir.existsSync()) {
+            dbDir.deleteSync(recursive: true);
+          }
+        });
+        addTearDown(sut.close);
+
+        await sut.init(MockHub());
+
+        expect(dbDir.existsSync(), isTrue);
+      });
+
       test('app start', () {
         expect(sut.fetchNativeAppStart(), null);
       });