Ref: Remove stackFrameFilter in favor of beforeSendCallback (#125)

Author: marandaneto

CHANGELOG.md

@@ -28,6 +28,7 @@
 - Ref: Event now is SentryEvent and added GPU #121
 - Feat: before breadcrumb and scope ref. #122
 - Ref: Hint is passed across Sentry static class, Hub and Client #124
+- Ref: Remove stackFrameFilter in favor of beforeSendCallback #125
 
 # `package:sentry` changelog
 

dart/lib/src/client.dart

@@ -8,7 +8,6 @@ import 'client_stub.dart'
     if (dart.library.html) 'browser_client.dart'
     if (dart.library.io) 'io_client.dart';
 import 'protocol.dart';
-import 'stack_trace.dart';
 import 'utils.dart';
 import 'version.dart';
 
@@ -97,7 +96,6 @@ abstract class SentryClient {
   /// Reports an [event] to Sentry.io.
   Future<SentryId> captureEvent(
     SentryEvent event, {
-    StackFrameFilter stackFrameFilter,
     Scope scope,
     dynamic hint,
   }) async {
@@ -128,7 +126,6 @@ abstract class SentryClient {
 
     mergeAttributes(
       event.toJson(
-        stackFrameFilter: stackFrameFilter,
         origin: origin,
       ),
       into: data,

dart/lib/src/noop_client.dart

@@ -4,7 +4,6 @@ import 'client.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_options.dart';
-import 'stack_trace.dart';
 
 class NoOpSentryClient implements SentryClient {
   NoOpSentryClient._();
@@ -37,15 +36,14 @@ class NoOpSentryClient implements SentryClient {
   @override
   Future<SentryId> captureEvent(
     SentryEvent event, {
-    StackFrameFilter stackFrameFilter,
     Scope scope,
     dynamic hint,
   }) =>
       Future.value(SentryId.empty());
 
   @override
   Future<SentryId> captureException(
-    dynamic throwable, {
+    throwable, {
     dynamic stackTrace,
     Scope scope,
     dynamic hint,

dart/lib/src/protocol/sentry_event.dart

@@ -193,8 +193,7 @@ class SentryEvent {
       );
 
   /// Serializes this event to JSON.
-  Map<String, dynamic> toJson(
-      {StackFrameFilter stackFrameFilter, String origin}) {
+  Map<String, dynamic> toJson({String origin}) {
     final json = <String, dynamic>{};
 
     if (eventId != null) {
@@ -254,7 +253,6 @@ class SentryEvent {
         json['stacktrace'] = <String, dynamic>{
           'frames': encodeStackTrace(
             exception.stackTrace,
-            stackFrameFilter: stackFrameFilter,
             origin: origin,
           ),
         };
@@ -265,7 +263,6 @@ class SentryEvent {
       json['stacktrace'] = <String, dynamic>{
         'frames': encodeStackTrace(
           stackTrace,
-          stackFrameFilter: stackFrameFilter,
           origin: origin,
         ),
       };

dart/lib/src/stack_trace.dart

@@ -4,16 +4,6 @@
 
 import 'package:stack_trace/stack_trace.dart';
 
-/// Used to filter or modify stack frames before sending the stack trace.
-///
-/// The input stack frames are in the Sentry.io JSON format. The output
-/// stack frames must follow the same format.
-///
-/// Detailed documentation about the stack trace format is on Sentry.io's
-/// web-site: https://docs.sentry.io/development/sdk-dev/overview/.
-typedef StackFrameFilter = List<Map<String, dynamic>> Function(
-    List<Map<String, dynamic>>);
-
 /// Sentry.io JSON encoding of a stack frame for the asynchronous suspension,
 /// which is the gap between asynchronous calls.
 const Map<String, dynamic> asynchronousGapFrameJson = <String, dynamic>{
@@ -25,7 +15,6 @@ const Map<String, dynamic> asynchronousGapFrameJson = <String, dynamic>{
 /// [stackTrace] must be [String] or [StackTrace].
 List<Map<String, dynamic>> encodeStackTrace(
   dynamic stackTrace, {
-  StackFrameFilter stackFrameFilter,
   String origin,
 }) {
   assert(stackTrace is String || stackTrace is StackTrace);
@@ -47,8 +36,7 @@ List<Map<String, dynamic>> encodeStackTrace(
     }
   }
 
-  final jsonFrames = frames.reversed.toList();
-  return stackFrameFilter != null ? stackFrameFilter(jsonFrames) : jsonFrames;
+  return frames.reversed.toList();
 }
 
 Map<String, dynamic> encodeStackTraceFrame(Frame frame, {String origin}) {

dart/test/event_test.dart

@@ -131,7 +131,6 @@ void main() {
                     'stacktrace': {
                       'frames': encodeStackTrace(
                         error.stackTrace,
-                        stackFrameFilter: null,
                         origin: null,
                       )
                     }

dart/test/hub_test.dart

@@ -57,7 +57,6 @@ void main() {
               client.captureEvent(
                 fakeEvent,
                 scope: captureAnyNamed('scope'),
-                stackFrameFilter: null,
               ),
             ).captured.first,
             Scope(options),
@@ -112,7 +111,6 @@ void main() {
             client.captureEvent(
               fakeEvent,
               scope: captureAnyNamed('scope'),
-              stackFrameFilter: null,
             ),
           ).captured.first,
           Scope(SentryOptions(dsn: fakeDsn))
@@ -145,7 +143,6 @@ void main() {
         client2.captureEvent(
           fakeEvent,
           scope: anyNamed('scope'),
-          stackFrameFilter: null,
         ),
       ).called(1);
     });

dart/test/sentry_test.dart

@@ -24,7 +24,6 @@ void main() {
         client.captureEvent(
           fakeEvent,
           scope: anyNamed('scope'),
-          stackFrameFilter: null,
         ),
       ).called(1);
     });

dart/test/stack_trace_test.dart

@@ -79,24 +79,25 @@ void main() {
       ]);
     });
 
-    test('allows changing the stack frame list before sending', () {
-      // ignore: omit_local_variable_types
-      final StackFrameFilter filter =
-          (list) => list.where((f) => f['abs_path'] != 'secret.dart').toList();
+// TODO: use beforeSend to filter stack frames
+//     test('allows changing the stack frame list before sending', () {
+//       // ignore: omit_local_variable_types
+//       final StackFrameFilter filter =
+//           (list) => list.where((f) => f['abs_path'] != 'secret.dart').toList();
 
-      expect(encodeStackTrace('''
-#0      baz (file:///pathto/test.dart:50:3)
-#1      bar (file:///pathto/secret.dart:46:9)
-      ''', stackFrameFilter: filter), [
-        {
-          'abs_path': 'test.dart',
-          'function': 'baz',
-          'lineno': 50,
-          'colno': 3,
-          'in_app': true,
-          'filename': 'test.dart'
-        },
-      ]);
-    });
+//       expect(encodeStackTrace('''
+// #0      baz (file:///pathto/test.dart:50:3)
+// #1      bar (file:///pathto/secret.dart:46:9)
+//       ''', stackFrameFilter: filter), [
+//         {
+//           'abs_path': 'test.dart',
+//           'function': 'baz',
+//           'lineno': 50,
+//           'colno': 3,
+//           'in_app': true,
+//           'filename': 'test.dart'
+//         },
+//       ]);
+//     });
   });
 }