Add module in SentryStackFrame (#2931)

* add module

* formatting

* changelog

* fix test

* only test for the module

* make it optional

* include more info in changelog

* more tests

* formatting

---------

Co-authored-by: Giancarlo Buenaflor <[email protected]>

Author: ueman

CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Features
 
 - Add `message` parameter to `captureException()` ([#2882](https://github.com/getsentry/sentry-dart/pull/2882))
+- Add module in SentryStackFrame ([#2931](https://github.com/getsentry/sentry-dart/pull/2931))
+  - Set `SentryOptions.includeModuleInStackTrace = true` to enable this. This may change grouping of exceptions. 
 
 ### Dependencies
 

dart/lib/src/sentry_options.dart

@@ -543,6 +543,11 @@ class SentryOptions {
   /// Disabled by default.
   bool enableLogs = false;
 
+  /// Enables adding the module in [SentryStackFrame.module].
+  /// This option only has an effect in non-obfuscated builds.
+  /// Enabling this option may change grouping.
+  bool includeModuleInStackTrace = false;
+
   late final SentryLogger logger = SentryLogger(clock);
 
   @internal

dart/lib/src/sentry_stack_trace_factory.dart

@@ -131,6 +131,9 @@ class SentryStackTraceFactory {
         frame.uri.pathSegments.isNotEmpty ? frame.uri.pathSegments.last : null;
     final abs = '$eventOrigin${_absolutePathForCrashReport(frame)}';
 
+    final includeModule =
+        frame.package != null && _options.includeModuleInStackTrace;
+
     var sentryStackFrame = SentryStackFrame(
       absPath: abs,
       function: member,
@@ -139,6 +142,11 @@ class SentryStackTraceFactory {
       fileName: fileName,
       package: frame.package,
       platform: platform,
+      module: includeModule
+          ? frame.uri.pathSegments
+              .sublist(0, frame.uri.pathSegments.length - 1)
+              .join('/')
+          : null,
     );
 
     final line = frame.line;

dart/test/stack_trace_test.dart

@@ -106,6 +106,40 @@ void main() {
 
       expect(serializedFrame.inApp, false);
     });
+
+    test('adds module for package frames', () {
+      final frame = Frame(
+        Uri.parse(
+            'package:app_name/features/login/ui/view_model/login_view_model.dart'),
+        1,
+        2,
+        'buzz',
+      );
+
+      final sentryStackFrame = Fixture()
+          .getSut(includeModuleInStackTrace: true)
+          .encodeStackTraceFrame(frame)!;
+
+      expect(sentryStackFrame.module, 'app_name/features/login/ui/view_model');
+    });
+
+    test(
+        'does not add module for package frames when includeModuleInStackTrace is false',
+        () {
+      final frame = Frame(
+        Uri.parse(
+            'package:app_name/features/login/ui/view_model/login_view_model.dart'),
+        1,
+        2,
+        'buzz',
+      );
+
+      final sentryStackFrame = Fixture()
+          .getSut(includeModuleInStackTrace: false)
+          .encodeStackTraceFrame(frame)!;
+
+      expect(sentryStackFrame.module, null);
+    });
   });
 
   group('encodeStackTrace', () {
@@ -306,10 +340,12 @@ class Fixture {
     List<String> inAppIncludes = const [],
     List<String> inAppExcludes = const [],
     bool considerInAppFramesByDefault = true,
+    bool includeModuleInStackTrace = false,
   }) {
     inAppIncludes.forEach(options.addInAppInclude);
     inAppExcludes.forEach(options.addInAppExclude);
     options.considerInAppFramesByDefault = considerInAppFramesByDefault;
+    options.includeModuleInStackTrace = includeModuleInStackTrace;
 
     return SentryStackTraceFactory(options);
   }