update naming and comments of flag

buenaflor · buenaflor · commit f7d358e9f9e2 · 2024-08-29T14:21:38.000+02:00
diff --git a/dart/lib/src/sentry.dart b/dart/lib/src/sentry.dart
@@ -84,7 +84,7 @@ class Sentry {
       options.addIntegrationByIndex(0, IsolateErrorIntegration());
     }
 
-    if (options.enablePureDartSymbolication) {
+    if (options.enableDartSymbolication) {
       options.addIntegration(LoadDartDebugImagesIntegration());
     }
 
diff --git a/dart/lib/src/sentry_options.dart b/dart/lib/src/sentry_options.dart
@@ -358,11 +358,15 @@ class SentryOptions {
         _ignoredExceptionsForType.contains(exception.runtimeType);
   }
 
-  /// If enabled, the SDK will attempt to symbolicate pure Dart stack traces when
-  /// used in Flutter. This feature works on Flutter iOS, macOS and Android.
-  /// Due to automatic debug image loading from the native SDKs
-  /// this flag is automatically set to false in `SentryFlutter.init`.
-  bool enablePureDartSymbolication = true;
+  /// Enables Dart symbolication for stack traces in Flutter.
+  ///
+  /// If true, the SDK will attempt to symbolicate Dart stack traces when
+  /// [Sentry.init] is used instead of `SentryFlutter.init`. This is useful
+  /// when native debug images are not available.
+  ///
+  /// Automatically set to `false` when using `SentryFlutter.init`, as it uses
+  /// native SDKs for setting up symbolication on iOS, macOS, and Android.
+  bool enableDartSymbolication = true;
 
   @internal
   late ClientReportRecorder recorder = NoOpClientReportRecorder();
diff --git a/dart/test/sentry_options_test.dart b/dart/test/sentry_options_test.dart
@@ -196,6 +196,6 @@ void main() {
   test('enablePureDartSymbolication is enabled by default', () {
     final options = SentryOptions(dsn: fakeDsn);
 
-    expect(options.enablePureDartSymbolication, true);
+    expect(options.enableDartSymbolication, true);
   });
 }
diff --git a/flutter/lib/src/sentry_flutter.dart b/flutter/lib/src/sentry_flutter.dart
@@ -181,7 +181,7 @@ mixin SentryFlutter {
       integrations.add(NativeSdkIntegration(native));
       integrations.add(LoadContextsIntegration(native));
       integrations.add(LoadNativeDebugImagesIntegration(native));
-      options.enablePureDartSymbolication = false;
+      options.enableDartSymbolication = false;
     }
 
     final renderer = options.rendererWrapper.getRenderer();
diff --git a/flutter/test/sentry_flutter_test.dart b/flutter/test/sentry_flutter_test.dart
@@ -636,7 +636,7 @@ void main() {
           options.dsn = fakeDsn;
           options.automatedTestMode = true;
 
-          expect(options.enablePureDartSymbolication, false);
+          expect(options.enableDartSymbolication, false);
         },
         appRunner: appRunner,
         platformChecker: getPlatformChecker(

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ class Sentry {`
`84`	`84`	`options.addIntegrationByIndex(0, IsolateErrorIntegration());`
`85`	`85`	`}`
`86`	`86`
`87`		`- if (options.enablePureDartSymbolication) {`
	`87`	`+ if (options.enableDartSymbolication) {`
`88`	`88`	`options.addIntegration(LoadDartDebugImagesIntegration());`
`89`	`89`	`}`
`90`	`90`
Original file line number	Diff line number	Diff line change
`@@ -196,6 +196,6 @@ void main() {`
`196`	`196`	`test('enablePureDartSymbolication is enabled by default', () {`
`197`	`197`	`final options = SentryOptions(dsn: fakeDsn);`
`198`	`198`
`199`		`- expect(options.enablePureDartSymbolication, true);`
	`199`	`+ expect(options.enableDartSymbolication, true);`
`200`	`200`	`});`
`201`	`201`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ mixin SentryFlutter {`
`181`	`181`	`integrations.add(NativeSdkIntegration(native));`
`182`	`182`	`integrations.add(LoadContextsIntegration(native));`
`183`	`183`	`integrations.add(LoadNativeDebugImagesIntegration(native));`
`184`		`- options.enablePureDartSymbolication = false;`
	`184`	`+ options.enableDartSymbolication = false;`
`185`	`185`	`}`
`186`	`186`
`187`	`187`	`final renderer = options.rendererWrapper.getRenderer();`