Merge pull request #80 from rollbar/userid

Add the ability to track Users

rollbar_common/lib/src/data/breadcrumb_record.dart

@@ -111,7 +111,7 @@ class PersistableBreadcrumbRecord implements PersistableFor {
       BreadcrumbRecord.persistingKeyTypes;
 }
 
-extension BreadcrumbRecordAttributes on JsonMap {
+extension _KeyValuePaths on JsonMap {
   UUID get id => UUID.fromList(this['id'].whereType<int>().toList());
   String get breadcrumb => this['breadcrumb'];
   DateTime get timestamp => DateTime.fromMicrosecondsSinceEpoch(

rollbar_common/lib/src/data/payload_record.dart

@@ -129,7 +129,7 @@ class PersistablePayloadRecord implements PersistableFor {
       PayloadRecord.persistingKeyTypes;
 }
 
-extension PayloadRecordAttributes on JsonMap {
+extension _KeyValuePaths on JsonMap {
   UUID get id => UUID.fromList(this['id'].whereType<int>().toList());
   String get accessToken => this['accessToken'];
   String get endpoint => this['endpoint'];

rollbar_dart/lib/rollbar.dart

@@ -10,6 +10,7 @@ export 'src/sender/sender.dart' show Sender;
 export 'src/data/payload/client.dart' show Client;
 export 'src/data/payload/payload.dart' show Payload;
 export 'src/data/payload/breadcrumb.dart' show Breadcrumb, Source;
+export 'src/data/payload/user.dart' show User;
 export 'src/data/payload/data.dart' show Data;
 export 'src/data/payload/body.dart' show Body, Report, Trace, Traces, Message;
 export 'src/data/payload/frame.dart' show Frame;

rollbar_dart/lib/src/context.dart

@@ -0,0 +1,6 @@
+import 'data/payload/user.dart';
+
+/// Context doesn't persist in-between application runs.
+class Context {
+  User? user;
+}

rollbar_dart/lib/src/data/payload/body.dart

@@ -126,7 +126,7 @@ class Message with Report, EquatableSerializableMixin {
       };
 }
 
-extension _KeyValuePath on JsonMap {
+extension _KeyValuePaths on JsonMap {
   ExceptionInfo get exception => ExceptionInfo.fromMap(this['exception']);
   String get message => this['message']['body'];
   String? get rawTrace => this['raw'];

rollbar_dart/lib/src/data/payload/data.dart

@@ -3,6 +3,7 @@ import 'package:rollbar_common/rollbar_common.dart';
 
 import 'body.dart' show Body;
 import 'client.dart' show Client;
+import 'user.dart' show User;
 
 /// Contains the data for the occurrence to be sent to Rollbar.
 @sealed
@@ -17,6 +18,7 @@ class Data with EquatableSerializableMixin implements Serializable, Equatable {
   final String language;
   final String framework;
   final String codeVersion;
+  final User? user;
   final JsonMap? custom;
   final JsonMap? platformPayload;
   final JsonMap server;
@@ -33,6 +35,7 @@ class Data with EquatableSerializableMixin implements Serializable, Equatable {
     required this.level,
     required this.timestamp,
     required this.body,
+    this.user,
     this.custom,
     this.platformPayload,
     required this.server,
@@ -49,6 +52,7 @@ class Data with EquatableSerializableMixin implements Serializable, Equatable {
     Level? level,
     DateTime? timestamp,
     Body? body,
+    User? user,
     JsonMap? custom,
     JsonMap? platformPayload,
     JsonMap? server,
@@ -64,6 +68,7 @@ class Data with EquatableSerializableMixin implements Serializable, Equatable {
         level: level ?? this.level,
         timestamp: timestamp ?? this.timestamp,
         body: body ?? this.body,
+        user: user ?? this.user,
         custom: custom ?? this.custom,
         platformPayload: platformPayload ?? this.platformPayload,
         server: server ?? this.server,
@@ -81,27 +86,26 @@ class Data with EquatableSerializableMixin implements Serializable, Equatable {
       level: other.level,
       timestamp: other.timestamp,
       body: other.body,
+      user: other.user,
       custom: other.custom,
       platformPayload: other.platformPayload,
       server: other.server);
 
-  factory Data.fromMap(JsonMap map) => Data(
-      notifier: map['notifier'],
-      environment: map['environment'],
-      client: Client.fromMap(map['client']),
-      platform: map['platform'],
-      language: map['language'],
-      framework: map['framework'],
-      codeVersion: map['code_version'],
-      level: Level.values.firstWhere((level) => level.name == map['level']),
-      body: Body.fromMap(map['body']),
-      custom: map['custom'],
-      platformPayload: map['platform_payload'],
-      server: map['server'],
-      timestamp: DateTime.fromMicrosecondsSinceEpoch(
-        map['timestamp'],
-        isUtc: true,
-      ));
+  factory Data.fromMap(JsonMap json) => Data(
+      notifier: json.notifier,
+      environment: json.environment,
+      client: json.client,
+      platform: json.platform,
+      language: json.language,
+      framework: json.framework,
+      codeVersion: json.codeVersion,
+      level: json.level,
+      body: json.body,
+      user: json.user,
+      custom: json.custom,
+      platformPayload: json.platformPayload,
+      server: json.server,
+      timestamp: json.timestamp);
 
   @override
   JsonMap toMap() => {
@@ -113,10 +117,30 @@ class Data with EquatableSerializableMixin implements Serializable, Equatable {
         'language': language,
         'level': level.name,
         'timestamp': timestamp.microsecondsSinceEpoch,
+        'person': user?.toMap(),
         'custom': custom,
         'server': server,
         'framework': framework,
         'code_version': codeVersion,
         'platform_payload': platformPayload,
       }.compact();
 }
+
+extension _KeyValuePaths on JsonMap {
+  JsonMap get notifier => this['notifier'];
+  String get environment => this['environment'];
+  Client get client => Client.fromMap(this['client']);
+  JsonMap get server => this['server'];
+  String get platform => this['platform'];
+  String get language => this['language'];
+  String get framework => this['framework'];
+  String get codeVersion => this['code_version'];
+  Level get level =>
+      Level.values.firstWhere((level) => level.name == this['level']);
+  Body get body => Body.fromMap(this['body']);
+  User? get user => (this['person'] as JsonMap?).map(User.fromMap);
+  JsonMap? get custom => this['custom'];
+  JsonMap? get platformPayload => this['platform_payload'];
+  DateTime get timestamp =>
+      DateTime.fromMicrosecondsSinceEpoch(this['timestamp'], isUtc: true);
+}

rollbar_dart/lib/src/data/payload/user.dart

@@ -0,0 +1,30 @@
+import 'package:meta/meta.dart';
+import 'package:rollbar_common/rollbar_common.dart';
+
+@sealed
+@immutable
+class User with EquatableSerializableMixin implements Equatable, Serializable {
+  final String id;
+  final String? username;
+  final String? email;
+
+  const User({
+    required this.id,
+    this.username,
+    this.email,
+  });
+
+  factory User.fromMap(JsonMap map) => User(
+        id: map['id'],
+        username: map['username'],
+        email: map['email'],
+      );
+
+  /// Converts the object into a Json encodable map.
+  @override
+  JsonMap toMap() => {
+        'id': id,
+        'username': username,
+        'email': email,
+      }.compact();
+}

rollbar_dart/lib/src/event.dart

@@ -2,6 +2,8 @@ import 'package:meta/meta.dart';
 import 'package:rollbar_common/rollbar_common.dart';
 
 import 'data/payload/breadcrumb.dart';
+import 'data/payload/user.dart';
+import 'context.dart';
 import 'telemetry.dart';
 
 @sealed
@@ -11,15 +13,19 @@ class Event {
   final dynamic error;
   final StackTrace? stackTrace;
   final String? message;
+  final User? user;
   final Breadcrumb? breadcrumb;
+  final Context? context;
   final Telemetry? telemetry;
 
   const Event({
     this.level = Level.info,
     this.error,
     this.stackTrace,
     this.message,
+    this.user,
     this.breadcrumb,
+    this.context,
     this.telemetry,
   });
 
@@ -28,15 +34,19 @@ class Event {
     dynamic error,
     StackTrace? stackTrace,
     String? message,
+    User? user,
     Breadcrumb? breadcrumb,
+    Context? context,
     Telemetry? telemetry,
   }) =>
       Event(
           level: level ?? this.level,
           error: error ?? this.error,
           stackTrace: stackTrace ?? this.stackTrace,
           message: message ?? this.message,
+          user: user ?? this.user,
           breadcrumb: breadcrumb ?? this.breadcrumb,
+          context: context ?? this.context,
           telemetry: telemetry ?? this.telemetry);
 
   @override
@@ -45,7 +55,9 @@ class Event {
       'error: $error, '
       'stackTrace: $stackTrace, '
       'message: $message, '
+      'user: $user, '
       'breadcrumb: $breadcrumb, '
+      'context: $context, '
       'telemetry: $telemetry)';
 
   @override
@@ -56,7 +68,9 @@ class Event {
           other.error == error &&
           other.stackTrace == stackTrace &&
           other.message == message &&
+          other.user == user &&
           other.breadcrumb == breadcrumb &&
+          other.context == context &&
           other.telemetry == telemetry);
 
   @override
@@ -65,7 +79,9 @@ class Event {
         error,
         stackTrace,
         message,
+        user,
         breadcrumb,
+        context,
         telemetry,
       );
 }

rollbar_dart/lib/src/notifier/async_notifier.dart

@@ -6,6 +6,7 @@ import '../data/payload/breadcrumb.dart';
 import '../sender/sender.dart';
 import '../wrangler/wrangler.dart';
 import '../config.dart';
+import '../context.dart';
 import '../event.dart';
 import '../telemetry.dart';
 import 'notifier.dart';
@@ -20,23 +21,29 @@ class AsyncNotifier implements Notifier {
   @override
   final Wrangler wrangler;
 
+  @override
+  final Context context;
+
   @override
   final Telemetry telemetry;
 
   AsyncNotifier(Config config)
       : wrangler = config.wrangler(config),
         sender = config.sender(config),
+        context = Context(),
         telemetry = Telemetry(config);
 
   @override
   FutureOr<void> notify(Event event) async {
-    if (event.breadcrumb != null) {
+    if (event.user != null) {
+      context.user = event.user;
+    } else if (event.breadcrumb != null) {
       telemetry.add(event.breadcrumb as Breadcrumb);
     } else {
       telemetry.removeExpired();
 
       final payload = await wrangler.payload(
-        event: event.copyWith(telemetry: telemetry),
+        event: event.copyWith(context: context, telemetry: telemetry),
       );
       await sender.send(payload.toMap());
     }

rollbar_dart/lib/src/notifier/isolated_notifier.dart

@@ -8,6 +8,7 @@ import '../data/payload/breadcrumb.dart';
 import '../sender/sender.dart';
 import '../wrangler/wrangler.dart';
 import '../config.dart';
+import '../context.dart';
 import '../event.dart';
 import '../telemetry.dart';
 import 'async_notifier.dart';
@@ -57,6 +58,7 @@ extension _IsolatedNotifier$Isolate on IsolatedNotifier {
   static late final Wrangler wrangler;
   static late final Sender sender;
   static late final Telemetry telemetry;
+  static late final Context context;
 
   static Future<void> run(Tuple2<SendPort, Config> tuple) async {
     final sendPort = tuple.first;
@@ -67,15 +69,18 @@ extension _IsolatedNotifier$Isolate on IsolatedNotifier {
     sender = config.sender(config);
     wrangler = config.wrangler(config);
     telemetry = Telemetry(config);
+    context = Context();
 
     await for (final Event event in receivePort) {
-      if (event.breadcrumb != null) {
+      if (event.user != null) {
+        context.user = event.user;
+      } else if (event.breadcrumb != null) {
         telemetry.add(event.breadcrumb as Breadcrumb);
       } else {
         telemetry.removeExpired();
 
         final payload = await wrangler.payload(
-          event: event.copyWith(telemetry: telemetry),
+          event: event.copyWith(context: context, telemetry: telemetry),
         );
         await sender.send(payload.toMap());
       }

rollbar_dart/lib/src/notifier/notifier.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 
 import '../sender/sender.dart';
 import '../wrangler/wrangler.dart';
+import '../context.dart';
 import '../telemetry.dart';
 import '../event.dart';
 
@@ -12,6 +13,7 @@ abstract class Notifier {
 
   Sender get sender;
   Wrangler get wrangler;
+  Context get context;
   Telemetry get telemetry;
 
   FutureOr<void> notify(Event event);

rollbar_dart/lib/src/rollbar.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 
 import 'package:meta/meta.dart';
 import 'package:rollbar_common/rollbar_common.dart';
+import 'package:rollbar_dart/src/data/payload/user.dart';
 
 import 'data/payload/breadcrumb.dart';
 import 'notifier/notifier.dart';
@@ -77,6 +78,10 @@ class Rollbar {
         stackTrace: stackTrace,
       ));
 
+  static FutureOr<void> setUser(User? user) {
+    current._notifier.notify(Event(user: user));
+  }
+
   /// Drops a breadcrumb with information about state, a change of state, an
   /// event such as the user interacting with a widget, or navigating from one
   /// place to another or any custom data.
@@ -87,8 +92,6 @@ class Rollbar {
   ///
   /// - See also: [Breadcrumb].
   static FutureOr<void> drop(Breadcrumb breadcrumb) {
-    current._notifier.notify(Event(
-      breadcrumb: breadcrumb,
-    ));
+    current._notifier.notify(Event(breadcrumb: breadcrumb));
   }
 }

rollbar_dart/lib/src/wrangler/data_wrangler.dart

@@ -41,6 +41,7 @@ extension _Data on Data {
       Data(
           body: _Body.from(event: event),
           client: _Client.fromPlatform(),
+          user: event.context?.user,
           codeVersion: config.codeVersion,
           environment: config.environment,
           framework: config.framework,