replace stack trace lines

Author: denrase

dart/lib/src/sentry_exception_factory.dart

@@ -58,13 +58,12 @@ class SentryExceptionFactory {
       }
     }
 
-    final throwableString = throwable.toString();
-
+    final stackTraceUtils = StackTraceUtils(throwable.toString());
     // if --obfuscate feature is enabled, 'type' won't be human readable.
     // https://flutter.dev/docs/deployment/obfuscate#caveat
     return SentryException(
       type: (throwable.runtimeType).toString(),
-      value: throwableString.isStackTrace() ? null : throwableString,
+      value: stackTraceUtils.removeStackStraceLines(),
       mechanism: mechanism,
       stackTrace: sentryStackTrace,
       throwable: throwable,

dart/lib/src/utils/stack_trace_utils.dart

@@ -1,25 +1,26 @@
 import 'package:meta/meta.dart';
 
 @internal
-extension StackTraceUtils on String {
-  bool isStackTrace() {
-    final frameNumberPrefix = RegExp(r'^#\d+', multiLine: true);
-    final matchesFrameNumber = frameNumberPrefix.hasMatch(this);
+class StackTraceUtils {
+  StackTraceUtils(this.input);
 
-    final fileAndLineNumberSuffix =
-        RegExp(r'.dart:\d+:\d+\)$', multiLine: true);
-    final matchesFileAndLineNumber = fileAndLineNumberSuffix.hasMatch(this);
+  final String input;
 
-    final abs = RegExp(r'\s(abs)\s');
-    final virt = RegExp(r'\s(virt)\s');
-    final matchesAbsAndVirt = abs.hasMatch(this) & virt.hasMatch(this);
+  late final _stackStackTrace =
+      RegExp(r'^#\d+.*\.dart:\d+:\d+\)$', multiLine: true);
+  late final _flutterStackTrace =
+      RegExp(r'^flutter:\s#\d+.*\.dart:\d+:\d+\)$', multiLine: true);
+  late final _obfuscatedStackTrace =
+      RegExp(r'^#\d+.*\+0x\w+$', multiLine: true);
+  late final _multipleNewlines = RegExp(r'\n+');
 
-    final hexSuffix = RegExp(r'\+0(x)\w+$', multiLine: true);
-    final matchesHexSuffix = hexSuffix.hasMatch(this);
-
-    final isStackTrace = matchesFrameNumber & matchesFileAndLineNumber;
-    final isObfuscatedStackTrace =
-        matchesFrameNumber & (matchesAbsAndVirt || matchesHexSuffix);
-    return isStackTrace || isObfuscatedStackTrace;
+  String removeStackStraceLines() {
+    return input
+        .replaceAll(_stackStackTrace, '')
+        .replaceAll(_flutterStackTrace, '')
+        .replaceAll(_obfuscatedStackTrace, '')
+        .replaceAll('<asynchronous suspension>', '')
+        .replaceAll(_multipleNewlines, '\n')
+        .trim();
   }
 }

dart/test/sentry_exception_factory_test.dart

@@ -174,7 +174,11 @@ void main() {
     final stackTraceError = StackTraceError();
     final sentryException =
         fixture.getSut().getSentryException(stackTraceError);
-    expect(sentryException.value, isNull);
+    final expected = '''
+StackTraceError()
+Some random description''';
+
+    expect(sentryException.value, expected);
   });
 }
 
@@ -198,10 +202,12 @@ class StackTraceError extends Error {
   @override
   String toString() {
     return '''
+StackTraceError()
+Some random description
+
 #0      baz (file:///pathto/test.dart:50:3)
 <asynchronous suspension>
-#1      bar (file:///pathto/test.dart:46:9)
-    ''';
+#1      bar (file:///pathto/test.dart:46:9)''';
   }
 }
 

dart/test/utils/stack_trace_utils_test.dart

@@ -2,13 +2,19 @@ import 'package:sentry/src/utils/stack_trace_utils.dart';
 import 'package:test/test.dart';
 
 void main() {
+  late Fixture fixture;
+
+  setUp(() {
+    fixture = Fixture();
+  });
+
   final dartStackTrace = '''
 randomPrefix
 #0      main (file:///Users/denis/Repos/other/dart-stacktrace/main.dart:2:20)
 #1      _delayEntrypointInvocation.<anonymous closure> (dart:isolate-patch/isolate_patch.dart:296:19)
 #2      _RawReceivePort._handleMessage (dart:isolate-patch/isolate_patch.dart:189:12)
 randomSuffix
-    ''';
+''';
 
   final flutterStackTrace = '''
 randomPrefix
@@ -22,53 +28,53 @@ flutter: #0      MainScaffold.build.<anonymous closure> (package:sentry_flutter_
 #7      GestureBinding.handleEvent (package:flutter/src/gestures/binding.dart:469:20)
 #8      GestureBinding.dispatchEvent (package:flutter/src/gestures/binding.dart:445:22)
 #9      RendererBinding.dispatchEvent (package:flutter/src/rendering/binding.dart:331:11)
-#10     GestureBinding._handlePointerEventImmediately (package:flutter/src/gestures/binding.dart:400:7)<…>
+#10     GestureBinding._handlePointerEventImmediately (package:flutter/src/gestures/binding.dart:400:7)
 randomSuffix
-    ''';
+''';
 
   final flutterObfuscatedStackTrace = '''
+randomPrefix
 #00 abs 00000075266c2fbf virt 0000000000697fbf _kDartIsolateSnapshotInstructions+0x37e63f
 #1 abs 000000752685211f virt 000000000082711f _kDartIsolateSnapshotInstructions+0x50d79f
 #2 abs 0000007526851cb3 virt 0000000000826cb3 _kDartIsolateSnapshotInstructions+0x50d333
 #3 abs 0000007526851c63 virt 0000000000826c63 _kDartIsolateSnapshotInstructions+0x50d2e3
 #4 abs 0000007526851bf3 virt 0000000000826bf3 _kDartIsolateSnapshotInstructions+0x50d273
-    ''';
-
-  test('dart stack trace detected', () {
-    expect(dartStackTrace.isStackTrace(), isTrue);
-  });
-
-  test('flutter stack trace detected', () {
-    expect(flutterStackTrace.isStackTrace(), isTrue);
-  });
+randomSuffix
+''';
 
-  test('flutter obfuscated stack trace detected', () {
-    expect(flutterObfuscatedStackTrace.isStackTrace(), isTrue);
-  });
+  final stackTraceWithAsyncSuspension = '''
+randomPrefix
+#0      baz (file:///pathto/test.dart:50:3)
+<asynchronous suspension>
+#1      bar (file:///pathto/test.dart:46:9)
+randomSuffix
+''';
 
-  test('stack trace not detected with frame number only', () {
-    expect('#0'.isStackTrace(), isFalse);
-  });
+  final cleanedUp = 'randomPrefix\nrandomSuffix';
 
-  test('stack trace not detected with file name and line number only', () {
-    expect('foo.dart:9000:1)'.isStackTrace(), isFalse);
+  test('removes dart stack trace', () {
+    final sut = fixture.getSut(dartStackTrace);
+    expect(sut.removeStackStraceLines(), cleanedUp);
   });
 
-  test('stack trace not detected abs only', () {
-    expect(' abs '.isStackTrace(), isFalse);
+  test('removes flutter stack trace', () {
+    final sut = fixture.getSut(flutterStackTrace);
+    expect(sut.removeStackStraceLines(), cleanedUp);
   });
 
-  test('stack trace not detected virt only', () {
-    expect(' virt '.isStackTrace(), isFalse);
+  test('removes flutter obfuscated stack trace', () {
+    final sut = fixture.getSut(flutterObfuscatedStackTrace);
+    expect(sut.removeStackStraceLines(), cleanedUp);
   });
 
-  test('stack trace not detected abs & virt only', () {
-    expect(
-        ' abs 00000075266c2fbf virt 0000000000697fbf'.isStackTrace(), isFalse);
+  test('removes stack trace with asynchronous suspension', () {
+    final sut = fixture.getSut(stackTraceWithAsyncSuspension);
+    expect(sut.removeStackStraceLines(), cleanedUp);
   });
+}
 
-  test('stack trace not detected hex suffix only', () {
-    expect(
-        '_kDartIsolateSnapshotInstructions+0x50d273'.isStackTrace(), isFalse);
-  });
+class Fixture {
+  StackTraceUtils getSut(String input) {
+    return StackTraceUtils(input);
+  }
 }