refactor : add a Transport class

dart/lib/src/browser_client.dart

@@ -3,14 +3,15 @@
 // found in the LICENSE file.
 
 /// A pure Dart client for Sentry.io crash reporting.
-import 'dart:convert';
 import 'dart:html' show window;
 
 import 'package:http/browser_client.dart';
+import 'package:meta/meta.dart';
 
 import 'client.dart';
 import 'protocol.dart';
 import 'sentry_options.dart';
+import 'transport/transport.dart';
 import 'version.dart';
 
 SentryClient createSentryClient(SentryOptions options) =>
@@ -41,19 +42,19 @@ class SentryBrowserClient extends SentryClient {
     );
   }
 
-  SentryBrowserClient._(SentryOptions options, {String origin, String platform})
+  SentryBrowserClient._(SentryOptions options,
+      {String origin, @required String platform})
       : super.base(
           options,
+          transport: Transport(
+            dsn: options.dsn,
+            httpClient: options.httpClient,
+            clock: options.clock,
+            compressPayload: false,
+            sdk: Sdk(name: browserSdkName, version: sdkVersion),
+            headersBuilder: SentryClient.buildHeaders,
+            platform: platform,
+          ),
           origin: origin,
-          sdk: Sdk(name: browserSdkName, version: sdkVersion),
-          platform: platform,
         );
-
-  @override
-  List<int> bodyEncoder(
-    Map<String, dynamic> data,
-    Map<String, String> headers,
-  ) =>
-      // Gzip compression is implicit on browser
-      utf8.encode(json.encode(data));
 }

dart/lib/src/client.dart

@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'dart:convert';
 
 import 'package:meta/meta.dart';
 import 'package:sentry/sentry.dart';
@@ -9,8 +8,8 @@ import 'client_stub.dart'
     if (dart.library.io) 'io_client.dart';
 import 'protocol.dart';
 import 'stack_trace.dart';
+import 'transport/transport.dart';
 import 'utils.dart';
-import 'version.dart';
 
 /// Logs crash reports and events to the Sentry.io service.
 abstract class SentryClient {
@@ -22,36 +21,15 @@ abstract class SentryClient {
 
   SentryClient.base(
     this.options, {
-    String platform,
     this.origin,
-    Sdk sdk,
-  })  : _dsn = Dsn.parse(options.dsn),
-        _platform = platform ?? sdkPlatform,
-        sdk = sdk ?? Sdk(name: sdkName, version: sdkVersion);
-
-  final Dsn _dsn;
+    @required this.transport,
+  });
 
   @protected
   SentryOptions options;
 
-  /// The DSN URI.
-  @visibleForTesting
-  Uri get dsnUri => _dsn.uri;
-
-  /// The Sentry.io public key for the project.
   @visibleForTesting
-  // ignore: invalid_use_of_visible_for_testing_member
-  String get publicKey => _dsn.publicKey;
-
-  /// The Sentry.io secret key for the project.
-  @visibleForTesting
-  // ignore: invalid_use_of_visible_for_testing_member
-  String get secretKey => _dsn.secretKey;
-
-  /// The ID issued by Sentry.io to your project.
-  ///
-  /// Attached to the event payload.
-  String get projectId => _dsn.projectId;
+  final Transport transport;
 
   /// Information about the current user.
   ///
@@ -68,51 +46,16 @@ abstract class SentryClient {
   /// Use for browser stacktrace
   String origin;
 
-  /// Used by sentry to differentiate browser from io environment
-  final String _platform;
-
-  final Sdk sdk;
-
-  String get clientId => sdk.identifier;
-
-  @visibleForTesting
-  String get postUri {
-    final port = dsnUri.hasPort &&
-            ((dsnUri.scheme == 'http' && dsnUri.port != 80) ||
-                (dsnUri.scheme == 'https' && dsnUri.port != 443))
-        ? ':${dsnUri.port}'
-        : '';
-    final pathLength = dsnUri.pathSegments.length;
-    String apiPath;
-    if (pathLength > 1) {
-      // some paths would present before the projectID in the dsnUri
-      apiPath =
-          (dsnUri.pathSegments.sublist(0, pathLength - 1) + ['api']).join('/');
-    } else {
-      apiPath = 'api';
-    }
-    return '${dsnUri.scheme}://${dsnUri.host}$port/$apiPath/$projectId/store/';
-  }
-
   /// Reports an [event] to Sentry.io.
   Future<SentryId> captureEvent(
     SentryEvent event, {
     StackFrameFilter stackFrameFilter,
     Scope scope,
   }) async {
-    final now = options.clock();
-    var authHeader = 'Sentry sentry_version=6, sentry_client=$clientId, '
-        'sentry_timestamp=${now.millisecondsSinceEpoch}, sentry_key=$publicKey';
-    if (secretKey != null) {
-      authHeader += ', sentry_secret=$secretKey';
-    }
-
-    final headers = buildHeaders(authHeader);
+    event = _processEvent(event, eventProcessors: options.eventProcessors);
 
     final data = <String, dynamic>{
-      'project': projectId,
       'event_id': event.eventId.toString(),
-      'timestamp': formatDateAsIso8601WithSecondPrecision(event.timestamp),
     };
 
     if (options.environmentAttributes != null) {
@@ -132,22 +75,8 @@ abstract class SentryClient {
       ),
       into: data,
     );
-    mergeAttributes(<String, String>{'platform': _platform}, into: data);
-
-    final body = bodyEncoder(data, headers);
-
-    final response = await options.httpClient.post(
-      postUri,
-      headers: headers,
-      body: body,
-    );
-
-    if (response.statusCode != 200) {
-      return SentryId.empty();
-    }
 
-    final eventId = json.decode(response.body)['id'];
-    return eventId != null ? SentryId.fromId(eventId) : SentryId.empty();
+    return transport.send(data);
   }
 
   /// Reports the [throwable] and optionally its [stackTrace] to Sentry.io.
@@ -188,15 +117,22 @@ abstract class SentryClient {
     options.httpClient?.close();
   }
 
-  @override
-  String toString() => '$SentryClient("$postUri")';
+  SentryEvent _processEvent(
+    SentryEvent event, {
+    dynamic hint,
+    List<EventProcessor> eventProcessors,
+  }) {
+    for (final processor in eventProcessors) {
+      event = processor(event, hint);
+    }
+    return event;
+  }
 
-  @protected
-  List<int> bodyEncoder(Map<String, dynamic> data, Map<String, String> headers);
+  @override
+  String toString() => '$SentryClient("${options.dsn}")';
 
   @protected
-  @mustCallSuper
-  Map<String, String> buildHeaders(String authHeader) {
+  static Map<String, String> buildHeaders(String authHeader) {
     final headers = {
       'Content-Type': 'application/json',
     };

dart/lib/src/io_client.dart

@@ -2,60 +2,48 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-/// A pure Dart client for Sentry.io crash reporting.
-import 'dart:convert';
-import 'dart:io';
+import 'package:meta/meta.dart';
 
+/// A pure Dart client for Sentry.io crash reporting.
 import 'package:sentry/sentry.dart';
+import 'package:sentry/src/transport/transport.dart';
 
 import 'client.dart';
+import 'protocol.dart';
 
 SentryClient createSentryClient(SentryOptions options) =>
     SentryIOClient(options);
 
 /// Logs crash reports and events to the Sentry.io service.
 class SentryIOClient extends SentryClient {
-  /// Instantiates a client using [dsn] issued to your project by Sentry.io as
-  /// the endpoint for submitting events.
-  ///
-  /// [environmentAttributes] contain event attributes that do not change over
-  /// the course of a program's lifecycle. These attributes will be added to
-  /// all events captured via this client. The following attributes often fall
-  /// under this category: [Event.serverName], [Event.release], [Event.environment].
-  ///
-  /// If [compressPayload] is `true` the outgoing HTTP payloads are compressed
-  /// using gzip. Otherwise, the payloads are sent in plain UTF8-encoded JSON
-  /// text. If not specified, the compression is enabled by default.
-  ///
-  /// If [httpClient] is provided, it is used instead of the default client to
-  /// make HTTP calls to Sentry.io. This is useful in tests.
-  factory SentryIOClient(SentryOptions options) => SentryIOClient._(options);
-
-  SentryIOClient._(SentryOptions options) : super.base(options);
-
-  @override
-  Map<String, String> buildHeaders(String authHeader) {
-    final headers = super.buildHeaders(authHeader);
+  /// Instantiates a client using [SentryOptions]
+  factory SentryIOClient(SentryOptions options) =>
+      SentryIOClient._(options, platform: sdkPlatform);
+
+  static const sdk = Sdk(name: sdkName, version: sdkVersion);
+
+  SentryIOClient._(SentryOptions options, {@required String platform})
+      : super.base(
+          options,
+          transport: Transport(
+            compressPayload: options.compressPayload,
+            httpClient: options.httpClient,
+            clock: options.clock,
+            sdk: sdk,
+            dsn: options.dsn,
+            headersBuilder: buildHeaders,
+            platform: platform,
+          ),
+        );
+
+  @protected
+  static Map<String, String> buildHeaders(String authHeader) {
+    final headers = SentryClient.buildHeaders(authHeader);
 
     // NOTE(lejard_h) overriding user agent on VM and Flutter not sure why
     // for web it use browser user agent
-    headers['User-Agent'] = clientId;
+    headers['User-Agent'] = sdk.identifier;
 
     return headers;
   }
-
-  @override
-  List<int> bodyEncoder(
-    Map<String, dynamic> data,
-    Map<String, String> headers,
-  ) {
-    // [SentryIOClient] implement gzip compression
-    // gzip compression is not available on browser
-    var body = utf8.encode(json.encode(data));
-    if (options.compressPayload) {
-      headers['Content-Encoding'] = 'gzip';
-      body = gzip.encode(body);
-    }
-    return body;
-  }
 }

dart/lib/src/noop_client.dart

@@ -4,6 +4,7 @@ import 'client.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_options.dart';
+import 'transport/transport.dart';
 
 class NoOpSentryClient implements SentryClient {
   NoOpSentryClient._();
@@ -24,14 +25,7 @@ class NoOpSentryClient implements SentryClient {
   String origin;
 
   @override
-  List<int> bodyEncoder(
-    Map<String, dynamic> data,
-    Map<String, String> headers,
-  ) =>
-      [];
-
-  @override
-  Map<String, String> buildHeaders(String authHeader) => {};
+  Transport transport;
 
   @override
   Future<SentryId> captureEvent(SentryEvent event, {stackFrameFilter, scope}) =>
@@ -51,29 +45,8 @@ class NoOpSentryClient implements SentryClient {
   }) =>
       Future.value(SentryId.empty());
 
-  @override
-  String get clientId => 'No-op';
-
   @override
   Future<void> close() async {
     return;
   }
-
-  @override
-  Uri get dsnUri => 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/transport/body_encoder.dart

@@ -0,0 +1,17 @@
+import 'dart:convert';
+import 'dart:io';
+
+List<int> bodyEncoder(
+  Map<String, dynamic> data,
+  Map<String, String> headers, {
+  bool compressPayload,
+}) {
+  // [SentryIOClient] implement gzip compression
+  // gzip compression is not available on browser
+  var body = utf8.encode(json.encode(data));
+  if (compressPayload) {
+    headers['Content-Encoding'] = 'gzip';
+    body = gzip.encode(body);
+  }
+  return body;
+}

dart/lib/src/transport/body_encoder_browser.dart

@@ -0,0 +1,12 @@
+import 'dart:convert';
+
+List<int> bodyEncoder(
+  Map<String, dynamic> data,
+  Map<String, String> headers, {
+  bool compressPayload,
+}) {
+  // [SentryIOClient] implement gzip compression
+  // gzip compression is not available on browser
+  var body = utf8.encode(json.encode(data));
+  return body;
+}