Envelope Only Transport API

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+* Feature: Envelope Only Transport API #426 (#463)
+
 # 5.1.0-beta.1
 
 * Fix: `Sentry.close()` closes native SDK integrations (#388)
@@ -25,7 +27,7 @@
 ## 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> sendSentryEvent(SentryEvent event)`
+  * The method signature of `Transport` changed from `Future<SentryId> send(SentryEvent event)` to `Future<SentryId> send(SentryEnvelope envelope)`
 
 ## Sentry Self Hosted Compatibility
 

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

@@ -25,6 +25,7 @@ class Contexts extends MapView<String, dynamic> {
           SentryGpu.type: gpu,
         });
 
+  /// 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/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>{};

dart/lib/src/protocol/sentry_device.dart

@@ -41,39 +41,6 @@ class SentryDevice {
           batteryLevel == null || (batteryLevel >= 0 && batteryLevel <= 100),
         );
 
-  factory SentryDevice.fromJson(Map<String, dynamic> data) => SentryDevice(
-        name: data['name'],
-        family: data['family'],
-        model: data['model'],
-        modelId: data['model_id'],
-        arch: data['arch'],
-        batteryLevel: data['battery_level'],
-        orientation: data['orientation'],
-        manufacturer: data['manufacturer'],
-        brand: data['brand'],
-        screenResolution: data['screen_resolution'],
-        screenHeightPixels: data['screen_height_pixels'],
-        screenWidthPixels: data['screen_width_pixels'],
-        screenDensity: data['screen_density'],
-        screenDpi: data['screen_dpi'],
-        online: data['online'],
-        charging: data['charging'],
-        lowMemory: data['low_memory'],
-        simulator: data['simulator'],
-        memorySize: data['memory_size'],
-        freeMemory: data['free_memory'],
-        usableMemory: data['usable_memory'],
-        storageSize: data['storage_size'],
-        freeStorage: data['free_storage'],
-        externalStorageSize: data['external_storage_size'],
-        externalFreeStorage: data['external_free_storage'],
-        bootTime: data['boot_time'] != null
-            ? DateTime.tryParse(data['boot_time'])
-            : null,
-        timezone: data['timezone'],
-        language: data['language'],
-      );
-
   /// The name of the device. This is typically a hostname.
   final String? name;
 
@@ -165,6 +132,44 @@ class SentryDevice {
   /// The language of the device, e.g.: `en_US`.
   final String? language;
 
+  /// Deserializes a [SentryDevice] from JSON [Map].
+  factory SentryDevice.fromJson(Map<String, dynamic> data) => SentryDevice(
+        name: data['name'],
+        family: data['family'],
+        model: data['model'],
+        modelId: data['model_id'],
+        arch: data['arch'],
+        batteryLevel: data['battery_level'],
+        orientation: data['orientation'] == 'portrait'
+            ? SentryOrientation.portrait
+            : data['orientation'] == 'landscape'
+                ? SentryOrientation.landscape
+                : null,
+        manufacturer: data['manufacturer'],
+        brand: data['brand'],
+        screenResolution: data['screen_resolution'],
+        screenHeightPixels: data['screen_height_pixels'],
+        screenWidthPixels: data['screen_width_pixels'],
+        screenDensity: data['screen_density'],
+        screenDpi: data['screen_dpi'],
+        online: data['online'],
+        charging: data['charging'],
+        lowMemory: data['low_memory'],
+        simulator: data['simulator'],
+        memorySize: data['memory_size'],
+        freeMemory: data['free_memory'],
+        usableMemory: data['usable_memory'],
+        storageSize: data['storage_size'],
+        freeStorage: data['free_storage'],
+        externalStorageSize: data['external_storage_size'],
+        externalFreeStorage: data['external_free_storage'],
+        bootTime: data['boot_time'] != null
+            ? DateTime.tryParse(data['boot_time'])
+            : null,
+        timezone: data['timezone'],
+        language: data['language'],
+      );
+
   /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
@@ -299,32 +304,34 @@ class SentryDevice {
   }
 
   SentryDevice clone() => SentryDevice(
-        name: name,
-        family: family,
-        model: model,
-        modelId: modelId,
-        arch: arch,
-        batteryLevel: batteryLevel,
-        orientation: orientation,
-        manufacturer: manufacturer,
-        brand: brand,
-        screenResolution: screenResolution,
-        screenDensity: screenDensity,
-        screenDpi: screenDpi,
-        online: online,
-        charging: charging,
-        lowMemory: lowMemory,
-        simulator: simulator,
-        memorySize: memorySize,
-        freeMemory: freeMemory,
-        usableMemory: usableMemory,
-        storageSize: storageSize,
-        freeStorage: freeStorage,
-        externalStorageSize: externalStorageSize,
-        externalFreeStorage: externalFreeStorage,
-        bootTime: bootTime,
-        timezone: timezone,
-      );
+      name: name,
+      family: family,
+      model: model,
+      modelId: modelId,
+      arch: arch,
+      batteryLevel: batteryLevel,
+      orientation: orientation,
+      manufacturer: manufacturer,
+      brand: brand,
+      screenResolution: screenResolution,
+      screenHeightPixels: screenHeightPixels,
+      screenWidthPixels: screenWidthPixels,
+      screenDensity: screenDensity,
+      screenDpi: screenDpi,
+      online: online,
+      charging: charging,
+      lowMemory: lowMemory,
+      simulator: simulator,
+      memorySize: memorySize,
+      freeMemory: freeMemory,
+      usableMemory: usableMemory,
+      storageSize: storageSize,
+      freeStorage: freeStorage,
+      externalStorageSize: externalStorageSize,
+      externalFreeStorage: externalFreeStorage,
+      bootTime: bootTime,
+      timezone: timezone,
+      language: language);
 
   SentryDevice copyWith({
     String? name,