Ref : rename files accordely to their content (#141)

CHANGELOG.md

@@ -40,6 +40,7 @@
 - Fix: NoOp encode for Web
 - Fix: Breadcrumb data should accept serializable types and not only String values
 - Ref: added Scope.applyToEvent
+- Ref: rename sdk files accordely to their content
 
 # `package:sentry` changelog
 

dart/example/event_example.dart

@@ -9,7 +9,7 @@ final event = SentryEvent(
   tags: const <String, String>{'project-id': '7371'},
   extra: const <String, String>{'section': '1'},
   fingerprint: const <String>['example-dart'],
-  userContext: const User(
+  user: const User(
     id: '800',
     username: 'first-user',
     email: '[email protected]',

dart/example_web/web/event.dart

@@ -9,7 +9,7 @@ final event = SentryEvent(
   tags: const <String, String>{'project-id': '7371'},
   extra: const <String, String>{'section': '1'},
   fingerprint: const <String>['example-dart'],
-  userContext: const User(
+  user: const User(
     id: '800',
     username: 'first-user',
     email: '[email protected]',

dart/lib/browser.dart

@@ -2,5 +2,5 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-export 'src/browser_client.dart';
+export 'src/sentry_browser_client.dart';
 export 'src/version.dart';

dart/lib/io.dart

@@ -2,5 +2,5 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-export 'src/io_client.dart';
+export 'src/sentry_io_client.dart';
 export 'src/version.dart';

dart/lib/sentry.dart

@@ -3,10 +3,10 @@
 // found in the LICENSE file.
 
 /// A pure Dart client for Sentry.io crash reporting.
-export 'src/client.dart';
 export 'src/protocol.dart';
 export 'src/scope.dart';
 export 'src/sentry.dart';
+export 'src/sentry_client.dart';
 export 'src/sentry_options.dart';
 export 'src/transport/transport.dart';
 export 'src/version.dart';

dart/lib/src/hub.dart

@@ -3,10 +3,10 @@ import 'dart:collection';
 
 import 'package:sentry/src/hub_adapter.dart';
 
-import 'client.dart';
 import 'noop_client.dart';
 import 'protocol.dart';
 import 'scope.dart';
+import 'sentry_client.dart';
 import 'sentry_options.dart';
 
 typedef ScopeCallback = void Function(Scope);

dart/lib/src/hub_adapter.dart

@@ -1,11 +1,13 @@
-import 'package:sentry/src/protocol/sentry_level.dart';
-import 'package:sentry/src/protocol/sentry_id.dart';
-import 'package:sentry/src/protocol/sentry_event.dart';
+import 'dart:async';
+
 import 'package:sentry/src/protocol/breadcrumb.dart';
-import 'package:sentry/src/client.dart';
+import 'package:sentry/src/protocol/sentry_event.dart';
+import 'package:sentry/src/protocol/sentry_id.dart';
+import 'package:sentry/src/protocol/sentry_level.dart';
 import 'package:sentry/src/sentry.dart';
+import 'package:sentry/src/sentry_client.dart';
+
 import 'hub.dart';
-import 'dart:async';
 
 /// Hub adapter to make Integrations testable
 class HubAdapter implements Hub {

dart/lib/src/noop_client.dart

@@ -1,8 +1,8 @@
 import 'dart:async';
 
-import 'client.dart';
 import 'protocol.dart';
 import 'scope.dart';
+import 'sentry_client.dart';
 
 class NoOpSentryClient implements SentryClient {
   NoOpSentryClient._();

dart/lib/src/noop_hub.dart

@@ -2,11 +2,11 @@ import 'dart:async';
 
 import 'package:sentry/src/protocol/breadcrumb.dart';
 
-import 'client.dart';
 import 'hub.dart';
 import 'protocol/sentry_event.dart';
-import 'protocol/sentry_level.dart';
 import 'protocol/sentry_id.dart';
+import 'protocol/sentry_level.dart';
+import 'sentry_client.dart';
 
 class NoOpHub implements Hub {
   NoOpHub._();

dart/lib/src/protocol/sentry_event.dart

@@ -29,7 +29,7 @@ class SentryEvent {
     this.tags,
     this.extra,
     this.fingerprint,
-    this.userContext,
+    this.user,
     this.contexts,
     this.breadcrumbs,
   })  : eventId = eventId ?? SentryId.newId(),
@@ -112,8 +112,8 @@ class SentryEvent {
   /// Information about the current user.
   ///
   /// The value in this field overrides the user context
-  /// set in [SentryClient.userContext] for this logged event.
-  final User userContext;
+  /// set in [SentryClient.user] for this logged event.
+  final User user;
 
   /// The context interfaces provide additional context data.
   /// Typically this is data related to the current user,
@@ -161,7 +161,7 @@ class SentryEvent {
     Map<String, String> tags,
     Map<String, dynamic> extra,
     List<String> fingerprint,
-    User userContext,
+    User user,
     Contexts contexts,
     List<Breadcrumb> breadcrumbs,
     Sdk sdk,
@@ -185,7 +185,7 @@ class SentryEvent {
         tags: tags ?? this.tags,
         extra: extra ?? this.extra,
         fingerprint: fingerprint ?? this.fingerprint,
-        userContext: userContext ?? this.userContext,
+        user: user ?? this.user,
         contexts: contexts ?? this.contexts,
         breadcrumbs: breadcrumbs ?? this.breadcrumbs,
         sdk: sdk ?? this.sdk,
@@ -288,10 +288,9 @@ class SentryEvent {
       json['contexts'] = contextsMap;
     }
 
-    Map<String, dynamic> userContextMap;
-    if (userContext != null &&
-        (userContextMap = userContext.toJson()).isNotEmpty) {
-      json['user'] = userContextMap;
+    Map<String, dynamic> userMap;
+    if (user != null && (userMap = user.toJson()).isNotEmpty) {
+      json['user'] = userMap;
     }
 
     if (fingerprint != null && fingerprint.isNotEmpty) {

dart/lib/src/protocol/user.dart

@@ -1,8 +1,8 @@
 /// Describes the current user associated with the application, such as the
 /// currently signed in user.
 ///
-/// The user can be specified globally in the [SentryClient.userContext] field,
-/// or per event in the [Event.userContext] field.
+/// The user can be specified globally in the [SentryClient.user] field,
+/// or per event in the [Event.user] field.
 ///
 /// You should provide at least either an [id] (a unique identifier for an
 /// authenticated user) or [ipAddress] (their IP address).

dart/lib/src/scope.dart

@@ -145,7 +145,7 @@ class Scope {
   SentryEvent applyToEvent(SentryEvent event, dynamic hint) {
     event = event.copyWith(
       transaction: event.transaction ?? transaction,
-      userContext: event.userContext ?? user,
+      user: event.user ?? user,
       fingerprint: event.fingerprint ?? fingerprint,
       breadcrumbs: event.breadcrumbs ?? breadcrumbs,
       tags: tags.isNotEmpty ? _mergeEventTags(event) : event.tags,

dart/lib/src/sentry.dart

@@ -2,10 +2,10 @@ import 'dart:async';
 
 import 'package:meta/meta.dart';
 
-import 'client.dart';
 import 'hub.dart';
 import 'noop_hub.dart';
 import 'protocol.dart';
+import 'sentry_client.dart';
 import 'sentry_options.dart';
 
 /// Configuration options callback

dart/lib/src/browser_client.dart → dart/lib/src/sentry_browser_client.dart

@@ -5,8 +5,8 @@
 /// A pure Dart client for Sentry.io crash reporting.
 import 'dart:html' show window;
 
-import 'client.dart';
 import 'protocol.dart';
+import 'sentry_client.dart';
 import 'sentry_options.dart';
 import 'version.dart';
 

dart/lib/src/client.dart → dart/lib/src/sentry_client.dart

@@ -4,10 +4,10 @@ import 'dart:math';
 import 'package:sentry/sentry.dart';
 import 'package:sentry/src/transport/noop_transport.dart';
 
-import 'client_stub.dart'
-    if (dart.library.html) 'browser_client.dart'
-    if (dart.library.io) 'io_client.dart';
 import 'protocol.dart';
+import 'sentry_client_stub.dart'
+    if (dart.library.html) 'sentry_browser_client.dart'
+    if (dart.library.io) 'sentry_io_client.dart';
 
 /// Logs crash reports and events to the Sentry.io service.
 abstract class SentryClient {

dart/lib/src/client_stub.dart → dart/lib/src/sentry_client_stub.dart

@@ -2,10 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import 'client.dart';
+import 'sentry_client.dart';
 import 'sentry_options.dart';
 
-/// Implemented in `browser_client.dart` and `io_client.dart`.
+/// Implemented in `sentry_browser_client.dart` and `sentry_io_client.dart`.
 SentryClient createSentryClient(SentryOptions options) =>
     throw UnsupportedError(
         'Cannot create a client without dart:html or dart:io.');

dart/lib/src/io_client.dart → dart/lib/src/sentry_io_client.dart

@@ -5,7 +5,7 @@
 import 'package:sentry/sentry.dart';
 
 /// A pure Dart client for Sentry.io crash reporting.
-import 'client.dart';
+import 'sentry_client.dart';
 import 'sentry_options.dart';
 
 SentryClient createSentryClient(SentryOptions options) =>

dart/test/event_test.dart

@@ -95,7 +95,7 @@ void main() {
             'g': 2,
           },
           fingerprint: const <String>[SentryEvent.defaultFingerprint, 'foo'],
-          userContext: user,
+          user: user,
           breadcrumbs: breadcrumbs,
         ).toJson(),
         <String, dynamic>{

dart/test/mocks.dart

@@ -25,7 +25,7 @@ final fakeEvent = SentryEvent(
   tags: const <String, String>{'project-id': '7371'},
   extra: const <String, String>{'company-name': 'Dart Inc'},
   fingerprint: const <String>['example-dart'],
-  userContext: const User(
+  user: const User(
       id: '800',
       username: 'first-user',
       email: '[email protected]',

dart/test/sentry_client_test.dart

@@ -109,7 +109,7 @@ void main() {
         options.transport.send(captureAny),
       ).captured.first) as SentryEvent;
 
-      expect(capturedEvent.userContext?.id, user.id);
+      expect(capturedEvent.user?.id, user.id);
       expect(capturedEvent.level.name, SentryLevel.error.name);
       expect(capturedEvent.transaction, transaction);
       expect(capturedEvent.fingerprint, fingerprint);
@@ -141,7 +141,7 @@ void main() {
     final event = SentryEvent(
       level: SentryLevel.warning,
       transaction: eventTransaction,
-      userContext: eventUser,
+      user: eventUser,
       fingerprint: eventFingerprint,
       breadcrumbs: eventCrumbs,
     );
@@ -164,7 +164,7 @@ void main() {
         options.transport.send(captureAny),
       ).captured.first) as SentryEvent;
 
-      expect(capturedEvent.userContext.id, eventUser.id);
+      expect(capturedEvent.user.id, eventUser.id);
       expect(capturedEvent.level.name, SentryLevel.warning.name);
       expect(capturedEvent.transaction, eventTransaction);
       expect(capturedEvent.fingerprint, eventFingerprint);

dart/test/sentry_io_test.dart

@@ -5,7 +5,7 @@
 import 'dart:io';
 
 import 'package:sentry/sentry.dart';
-import 'package:sentry/src/io_client.dart';
+import 'package:sentry/src/sentry_io_client.dart';
 import 'package:test/test.dart';
 
 import 'test_utils.dart';

dart/test/test_utils.dart

@@ -319,7 +319,7 @@ void runTest({Codec<List<int>, List<int>> gzip, bool isWeb = false}) {
     await client.close();
   });
 
-  test('$SentryEvent userContext overrides client', () async {
+  test('$SentryEvent user overrides client', () async {
     final fakeClockProvider = () => DateTime.utc(2017, 1, 2);
 
     String loggedUserId; // used to find out what user context was sent
@@ -337,13 +337,13 @@ void runTest({Codec<List<int>, List<int>> gzip, bool isWeb = false}) {
           'Unexpected request on ${request.method} ${request.url} in HttpMock');
     });
 
-    const clientUserContext = User(
+    const clientUser = User(
       id: 'client_user',
       username: 'username',
       email: '[email protected]',
       ipAddress: '127.0.0.1',
     );
-    const eventUserContext = User(
+    const eventUser = User(
       id: 'event_user',
       username: 'username',
       email: '[email protected]',
@@ -375,16 +375,16 @@ void runTest({Codec<List<int>, List<int>> gzip, bool isWeb = false}) {
         eventId: SentryId.empty(),
         exception: error,
         stackTrace: stackTrace,
-        userContext: eventUserContext,
+        user: eventUser,
       );
       await client.captureEvent(eventWithoutContext,
-          scope: Scope(options)..user = clientUserContext);
-      expect(loggedUserId, clientUserContext.id);
+          scope: Scope(options)..user = clientUser);
+      expect(loggedUserId, clientUser.id);
       await client.captureEvent(
         eventWithContext,
-        scope: Scope(options)..user = clientUserContext,
+        scope: Scope(options)..user = clientUser,
       );
-      expect(loggedUserId, eventUserContext.id);
+      expect(loggedUserId, eventUser.id);
     }
 
     await client.close();