Implement envelope based transport (#391)

Author: denrase

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Unreleased
 
 * Feat: Add Culture Context (#491)
+
+## Breaking Changes:
+
+* Feat: Support envelope based transport for events (#391)
+  * The method signature of `Transport` changed from `Future<SentryId> send(SentryEvent event)` to `Future<SentryId> send(SentryEnvelope envelope)`
 * Remove `Sentry.currentHub` (#490)
 
 # 5.1.0
@@ -32,6 +37,10 @@
 * Feature: Add `withScope` callback to capture methods (#463)
 * Fix: Add missing properties `language`, `screenHeightPixels` and `screenWidthPixels` to `SentryDevice` (#465)
 
+## Sentry Self Hosted Compatibility
+
+* This version of the `sentry` Dart package requires [Sentry server >= v20.6.0](https://github.com/getsentry/onpremise/releases). This only applies to on-premise Sentry, if you are using sentry.io no action is needed.
+
 # 5.0.0
 
 * Sound null safety

dart/lib/sentry.dart

@@ -13,6 +13,7 @@ export 'src/noop_isolate_error_integration.dart'
 export 'src/protocol.dart';
 export 'src/scope.dart';
 export 'src/sentry.dart';
+export 'src/sentry_envelope.dart';
 export 'src/sentry_client.dart';
 export 'src/sentry_options.dart';
 // useful for integrations

dart/lib/src/noop_sentry_client.dart

@@ -3,6 +3,7 @@ import 'dart:async';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_client.dart';
+import 'sentry_envelope.dart';
 
 class NoOpSentryClient implements SentryClient {
   NoOpSentryClient._();
@@ -42,6 +43,10 @@ class NoOpSentryClient implements SentryClient {
   }) =>
       Future.value(SentryId.empty());
 
+  @override
+  Future<SentryId> captureEnvelope(SentryEnvelope envelope) =>
+      Future.value(SentryId.empty());
+
   @override
   Future<void> close() async {
     return;

dart/lib/src/protocol/breadcrumb.dart

@@ -76,6 +76,20 @@ class Breadcrumb {
   /// The value is submitted to Sentry with second precision.
   final DateTime timestamp;
 
+  /// Deserializes a [Breadcrumb] from JSON [Map].
+  factory Breadcrumb.fromJson(Map<String, dynamic> json) {
+    final levelName = json['level'];
+    final timestamp = json['timestamp'];
+    return Breadcrumb(
+      timestamp: timestamp != null ? DateTime.tryParse(timestamp) : null,
+      message: json['message'],
+      category: json['category'],
+      data: json['data'],
+      level: levelName != null ? SentryLevel.fromName(levelName) : null,
+      type: json['type'],
+    );
+  }
+
   /// Converts this breadcrumb to a map that can be serialized to JSON according
   /// to the Sentry protocol.
   Map<String, dynamic> toJson() {

dart/lib/src/protocol/contexts.dart

@@ -27,6 +27,7 @@ class Contexts extends MapView<String, dynamic> {
           SentryCulture.type: culture,
         });
 
+  /// Deserializes [Contexts] from JSON [Map].
   factory Contexts.fromJson(Map<String, dynamic> data) {
     final contexts = Contexts(
       device: data[SentryDevice.type] != null

dart/lib/src/protocol/debug_image.dart

@@ -50,6 +50,22 @@ class DebugImage {
     this.codeId,
   });
 
+  /// Deserializes a [DebugImage] from JSON [Map].
+  factory DebugImage.fromJson(Map<String, dynamic> json) {
+    return DebugImage(
+      type: json['type'],
+      imageAddr: json['image_addr'],
+      debugId: json['debug_id'],
+      debugFile: json['debug_file'],
+      imageSize: json['image_size'],
+      uuid: json['uuid'],
+      codeFile: json['code_file'],
+      arch: json['arch'],
+      codeId: json['code_id'],
+    );
+  }
+
+  /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
 

dart/lib/src/protocol/debug_meta.dart

@@ -18,6 +18,20 @@ class DebugMeta {
 
   DebugMeta({this.sdk, List<DebugImage>? images}) : _images = images;
 
+  /// Deserializes a [DebugMeta] from JSON [Map].
+  factory DebugMeta.fromJson(Map<String, dynamic> json) {
+    final sdkInfoJson = json['sdk_info'];
+    final debugImagesJson = json['images'] as List<dynamic>?;
+    return DebugMeta(
+      sdk: sdkInfoJson != null ? SdkInfo.fromJson(sdkInfoJson) : null,
+      images: debugImagesJson
+          ?.map((debugImageJson) =>
+              DebugImage.fromJson(debugImageJson as Map<String, dynamic>))
+          .toList(),
+    );
+  }
+
+  /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
 

dart/lib/src/protocol/dsn.dart

@@ -43,7 +43,7 @@ class Dsn {
       apiPath = 'api';
     }
     return Uri.parse(
-      '${uriCopy.scheme}://${uriCopy.host}$port/$apiPath/$projectId/store/',
+      '${uriCopy.scheme}://${uriCopy.host}$port/$apiPath/$projectId/envelope/',
     );
   }
 

dart/lib/src/protocol/mechanism.dart

@@ -74,6 +74,20 @@ class Mechanism {
         synthetic: synthetic ?? this.synthetic,
       );
 
+  /// Deserializes a [Mechanism] from JSON [Map].
+  factory Mechanism.fromJson(Map<String, dynamic> json) {
+    return Mechanism(
+      type: json['type'],
+      description: json['description'],
+      helpLink: json['help_link'],
+      handled: json['handled'],
+      meta: json['meta'],
+      data: json['data'],
+      synthetic: json['synthetic'],
+    );
+  }
+
+  /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
 

dart/lib/src/protocol/sdk_info.dart

@@ -15,6 +15,17 @@ class SdkInfo {
     this.versionPatchlevel,
   });
 
+  /// Deserializes a [SdkInfo] from JSON [Map].
+  factory SdkInfo.fromJson(Map<String, dynamic> json) {
+    return SdkInfo(
+      sdkName: json['sdk_name'],
+      versionMajor: json['version_major'],
+      versionMinor: json['version_minor'],
+      versionPatchlevel: json['version_patchlevel'],
+    );
+  }
+
+  /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
     if (sdkName != null) {

dart/lib/src/protocol/sdk_version.dart

@@ -63,6 +63,20 @@ class SdkVersion {
 
   String get identifier => '$name/$version';
 
+  /// Deserializes a [SdkVersion] from JSON [Map].
+  factory SdkVersion.fromJson(Map<String, dynamic> json) {
+    final packagesJson = json['packages'] as List<dynamic>?;
+    final integrationsJson = json['integrations'] as List<dynamic>?;
+    return SdkVersion(
+      name: json['name'],
+      version: json['version'],
+      packages: packagesJson
+          ?.map((e) => SentryPackage.fromJson(e as Map<String, dynamic>))
+          .toList(),
+      integrations: integrationsJson?.map((e) => e as String).toList(),
+    );
+  }
+
   /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};

dart/lib/src/protocol/sentry_app.dart

@@ -18,18 +18,6 @@ class SentryApp {
     this.deviceAppHash,
   });
 
-  factory SentryApp.fromJson(Map<String, dynamic> data) => SentryApp(
-        name: data['app_name'],
-        version: data['app_version'],
-        identifier: data['app_identifier'],
-        build: data['app_build'],
-        buildType: data['build_type'],
-        startTime: data['app_start_time'] != null
-            ? DateTime.tryParse(data['app_start_time'])
-            : null,
-        deviceAppHash: data['device_app_hash'],
-      );
-
   /// Human readable application name, as it appears on the platform.
   final String? name;
 
@@ -51,6 +39,19 @@ class SentryApp {
   /// Application specific device identifier.
   final String? deviceAppHash;
 
+  /// Deserializes a [SentryApp] from JSON [Map].
+  factory SentryApp.fromJson(Map<String, dynamic> data) => SentryApp(
+        name: data['app_name'],
+        version: data['app_version'],
+        identifier: data['app_identifier'],
+        build: data['app_build'],
+        buildType: data['build_type'],
+        startTime: data['app_start_time'] != null
+            ? DateTime.tryParse(data['app_start_time'])
+            : null,
+        deviceAppHash: data['device_app_hash'],
+      );
+
   /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, String>{};

dart/lib/src/protocol/sentry_browser.dart

@@ -11,17 +11,18 @@ class SentryBrowser {
   /// Creates an instance of [SentryBrowser].
   const SentryBrowser({this.name, this.version});
 
-  factory SentryBrowser.fromJson(Map<String, dynamic> data) => SentryBrowser(
-        name: data['name'],
-        version: data['version'],
-      );
-
   /// Human readable application name, as it appears on the platform.
   final String? name;
 
   /// Human readable application version, as it appears on the platform.
   final String? version;
 
+  /// Deserializes a [SentryBrowser] from JSON [Map].
+  factory SentryBrowser.fromJson(Map<String, dynamic> data) => SentryBrowser(
+        name: data['name'],
+        version: data['version'],
+      );
+
   /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};