Hub.configureScope

- feedbacks : remove the IHub interface
- client.captureEvent define event as a required param
- pass the scope to client.captureEvent(...)

dart/lib/src/client.dart

@@ -137,9 +137,10 @@ abstract class SentryClient {
   }
 
   /// Reports an [event] to Sentry.io.
-  Future<SentryId> captureEvent({
-    @required Event event,
+  Future<SentryId> captureEvent(
+    Event event, {
     StackFrameFilter stackFrameFilter,
+    Scope scope,
   }) async {
     final now = _clock();
     var authHeader = 'Sentry sentry_version=6, sentry_client=$clientId, '
@@ -201,7 +202,7 @@ abstract class SentryClient {
       exception: throwable,
       stackTrace: stackTrace,
     );
-    return captureEvent(event: event);
+    return captureEvent(event);
   }
 
   /// Reports the [message]
@@ -210,7 +211,7 @@ abstract class SentryClient {
     SeverityLevel level = SeverityLevel.info,
   }) {
     final event = Event(message: message, level: level);
-    return captureEvent(event: event);
+    return captureEvent(event);
   }
 
   Future<void> close() async {

dart/lib/src/hub.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 import 'dart:collection';
 
 import 'client.dart';
+import 'noop_client.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_options.dart';
@@ -76,7 +77,7 @@ class Hub {
       final item = _stack.last;
       if (item != null) {
         try {
-          sentryId = await item.client.captureEvent(event: event);
+          sentryId = await item.client.captureEvent(event, scope: item.scope);
         } catch (err) {
           /* TODO add Event.id */
           _options.logger(
@@ -116,6 +117,7 @@ class Hub {
       final item = _stack.last;
       if (item != null) {
         try {
+          // TODO pass the scope
           sentryId = await item.client.captureException(
             throwable,
             stackTrace: stackTrace,
@@ -158,10 +160,8 @@ class Hub {
       final item = _stack.last;
       if (item != null) {
         try {
-          sentryId = await item.client.captureMessage(
-            message,
-            level: level,
-          );
+          // TODO pass the scope
+          sentryId = await item.client.captureMessage(message, level: level);
         } catch (err) {
           _options.logger(
             SeverityLevel.error,
@@ -181,7 +181,26 @@ class Hub {
 
   /// Binds a different client to the hub
   void bindClient(SentryClient client) {
-    _stack.add(_StackItem(client, _stack.last.scope));
+    if (!_isEnabled) {
+      _options.logger(SeverityLevel.warning,
+          "Instance is disabled and this 'bindClient' call is a no-op.");
+    } else {
+      final item = _stack.last;
+      if (item != null) {
+        if (client != null) {
+          _options.logger(SeverityLevel.debug, 'New client bound to scope.');
+          item.client = client;
+        } else {
+          _options.logger(SeverityLevel.debug, 'NoOp client bound to scope.');
+          item.client = NoOpSentryClient();
+        }
+      } else {
+        _options.logger(
+          SeverityLevel.fatal,
+          'Stack peek was null when bindClient',
+        );
+      }
+    }
   }
 
   /// Clones the Hub
@@ -220,8 +239,29 @@ class Hub {
 
   /// Configures the scope through the callback.
   void configureScope(ScopeCallback callback) {
-    // TODO: implement configureScope
-    throw UnimplementedError();
+    if (!_isEnabled) {
+      _options.logger(
+        SeverityLevel.warning,
+        "Instance is disabled and this 'configureScope' call is a no-op.",
+      );
+    } else {
+      final item = _stack.last;
+      if (item != null) {
+        try {
+          callback(item.scope);
+        } catch (err) {
+          _options.logger(
+            SeverityLevel.error,
+            "Error in the 'configureScope' callback.",
+          );
+        }
+      } else {
+        _options.logger(
+          SeverityLevel.fatal,
+          'Stack peek was NULL when configureScope',
+        );
+      }
+    }
   }
 
   /// Runs the callback with a new scope which gets dropped at the end
@@ -243,7 +283,7 @@ class Hub {
 }
 
 class _StackItem {
-  final SentryClient client;
+  SentryClient client;
 
   final Scope scope;
 

dart/lib/src/noop_client.dart

@@ -0,0 +1,71 @@
+import 'dart:async';
+
+import 'package:http/src/client.dart';
+
+import 'client.dart';
+import 'protocol.dart';
+
+class NoOpSentryClient implements SentryClient {
+  @override
+  User userContext;
+
+  @override
+  List<int> bodyEncoder(
+    Map<String, dynamic> data,
+    Map<String, String> headers,
+  ) =>
+      [];
+
+  @override
+  Map<String, String> buildHeaders(String authHeader) => {};
+
+  @override
+  Future<SentryId> captureEvent(Event event, {stackFrameFilter, scope}) =>
+      Future.value(SentryId.empty());
+
+  @override
+  Future<SentryId> captureException(throwable, {stackTrace}) =>
+      Future.value(SentryId.empty());
+
+  @override
+  Future<SentryId> captureMessage(
+    Message message, {
+    SeverityLevel level = SeverityLevel.info,
+  }) =>
+      Future.value(SentryId.empty());
+
+  @override
+  String get clientId => 'No-op';
+
+  @override
+  Future<void> close() async {
+    return;
+  }
+
+  @override
+  Uri get dsnUri => null;
+
+  @override
+  Event get environmentAttributes => null;
+
+  @override
+  Client get httpClient => null;
+
+  @override
+  String get origin => null;
+
+  @override
+  String get postUri => null;
+
+  @override
+  String get projectId => null;
+
+  @override
+  String get publicKey => null;
+
+  @override
+  Sdk get sdk => null;
+
+  @override
+  String get secretKey => null;
+}

dart/lib/src/scope.dart

@@ -1,5 +1,7 @@
 import 'dart:collection';
 
+import 'package:collection/collection.dart';
+
 import 'protocol.dart';
 import 'sentry_options.dart';
 
@@ -136,4 +138,28 @@ class Scope {
   void removeExtra(String key) {
     _extra.remove(key);
   }
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is Scope &&
+          runtimeType == other.runtimeType &&
+          _level == other.level &&
+          _transaction == other.transaction &&
+          _user == other.user &&
+          IterableEquality().equals(_fingerprint, other.fingerprint) &&
+          IterableEquality().equals(_breadcrumbs, other.breadcrumbs) &&
+          MapEquality().equals(_tags, other.tags) &&
+          MapEquality().equals(_extra, other.extra);
+
+  @override
+  int get hashCode =>
+      _level.hashCode ^
+      _transaction.hashCode ^
+      _user.hashCode ^
+      _fingerprint.hashCode ^
+      _breadcrumbs.hashCode ^
+      _tags.hashCode ^
+      _extra.hashCode ^
+      _options.hashCode;
 }

dart/lib/src/sentry.dart

@@ -21,14 +21,6 @@ class Sentry {
     final options = SentryOptions();
     optionsConfiguration(options);
     _hub = Hub(options);
-    /*_client = SentryClient(
-      dsn: options.dsn,
-      environmentAttributes: options.environmentAttributes,
-      compressPayload: options.compressPayload,
-      httpClient: options.httpClient,
-      clock: options.clock,
-      uuidGenerator: options.uuidGenerator,
-    );*/
   }
 
   /// Reports an [event] to Sentry.io.

dart/pubspec.yaml

@@ -13,6 +13,7 @@ dependencies:
   meta: ^1.0.0
   stack_trace: ^1.0.0
   uuid: ^2.0.0
+  collection: ^1.14.13
 
 dev_dependencies:
   mockito: ^4.1.1

dart/test/hub_test.dart

@@ -18,7 +18,7 @@ void main() {
     });
 
     test('should instanciate with a dsn', () {
-      final hub = Hub(SentryOptions(dsn: fakeDns));
+      final hub = Hub(SentryOptions(dsn: fakeDsn));
       expect(hub.isEnabled, true);
     });
   });
@@ -29,15 +29,21 @@ void main() {
     MockSentryClient client;
 
     setUp(() {
-      options = SentryOptions(dsn: fakeDns);
+      options = SentryOptions(dsn: fakeDsn);
       hub = Hub(options);
       client = MockSentryClient();
       hub.bindClient(client);
     });
 
     test('should capture event', () {
       hub.captureEvent(fakeEvent);
-      verify(client.captureEvent(event: fakeEvent)).called(1);
+      verify(
+        client.captureEvent(
+          fakeEvent,
+          scope: Scope(options),
+          stackFrameFilter: null,
+        ),
+      ).called(1);
     });
 
     test('should capture exception', () {
@@ -54,11 +60,64 @@ void main() {
     });
   });
 
-  group('Close hub', () {
-    test('should close an enabled hub', () {
-      final hub = Hub(SentryOptions(dsn: fakeDns));
-      final client = MockSentryClient();
+  group('Hub scope', () {
+    Hub hub;
+    SentryClient client;
+
+    setUp(() {
+      hub = Hub(SentryOptions(dsn: fakeDsn));
+      client = MockSentryClient();
       hub.bindClient(client);
+    });
+
+    test('should configure its scope', () {
+      hub.configureScope((Scope scope) {
+        scope
+          ..level = SeverityLevel.debug
+          ..user = fakeUser
+          ..fingerprint = ['1', '2'];
+      });
+      hub.captureEvent(fakeEvent);
+
+      verify(
+        client.captureEvent(
+          fakeEvent,
+          scope: Scope(SentryOptions(dsn: fakeDsn))
+            ..level = SeverityLevel.debug
+            ..user = fakeUser
+            ..fingerprint = ['1', '2'],
+          stackFrameFilter: null,
+        ),
+      ).called(1);
+    });
+  });
+
+  group('Hub Client', () {
+    Hub hub;
+    SentryClient client;
+    SentryOptions options;
+
+    setUp(() {
+      options = SentryOptions(dsn: fakeDsn);
+      hub = Hub(options);
+      client = MockSentryClient();
+      hub.bindClient(client);
+    });
+
+    test('should bind a new client', () {
+      final client2 = MockSentryClient();
+      hub.bindClient(client2);
+      hub.captureEvent(fakeEvent);
+      verify(
+        client2.captureEvent(
+          fakeEvent,
+          scope: Scope(options),
+          stackFrameFilter: null,
+        ),
+      ).called(1);
+    });
+
+    test('should close its client', () {
       hub.close();
 
       expect(hub.isEnabled, false);

dart/test/mocks.dart

@@ -4,13 +4,15 @@ import 'package:sentry/src/protocol.dart';
 
 class MockSentryClient extends Mock implements SentryClient {}
 
-final fakeDns = 'https://[email protected]/1234567';
+final fakeDsn = 'https://[email protected]/1234567';
 
 final fakeException = Exception('Error');
 
 final fakeMessage =
     Message(formatted: 'message 1', message: 'message %d', params: ['1']);
 
+final fakeUser = User(id: '1', email: 'test@test');
+
 final fakeEvent = Event(
   loggerName: 'main',
   serverName: 'server.dart',