Feat/more protocol

CHANGELOG.md

@@ -9,6 +9,7 @@
 ## 4.0.0-alpha.2
 
 - feat: add contexts to scope
+- feat: add missing protocol classes
 - fix: logger method and refactoring little things
 - fix: sentry protocol is v7
 

dart/example/event_example.dart

@@ -35,7 +35,7 @@ final event = SentryEvent(
           'Linux version 3.4.39-5726670 (dpi@SWHC3807) (gcc version 4.8 (GCC) ) #1 SMP PREEMPT Thu Dec 1 19:42:39 KST 2016',
       rooted: false,
     ),
-    runtimes: [const Runtime(name: 'ART', version: '5')],
+    runtimes: [const SentryRuntime(name: 'ART', version: '5')],
     app: App(
       name: 'Example Dart App',
       version: '1.42.0',

dart/example_web/web/event.dart

@@ -35,7 +35,7 @@ final event = SentryEvent(
           'Linux version 3.4.39-5726670 (dpi@SWHC3807) (gcc version 4.8 (GCC) ) #1 SMP PREEMPT Thu Dec 1 19:42:39 KST 2016',
       rooted: false,
     ),
-    runtimes: [const Runtime(name: 'ART', version: '5')],
+    runtimes: [const SentryRuntime(name: 'ART', version: '5')],
     app: App(
       name: 'Example Dart App',
       version: '1.42.0',

dart/lib/src/hub.dart

@@ -35,11 +35,11 @@ class Hub {
 
   static void _validateOptions(SentryOptions options) {
     if (options == null) {
-      throw ArgumentError.notNull('SentryOptions is required.');
+      throw ArgumentError('SentryOptions is required.');
     }
 
     if (options.dsn?.isNotEmpty != true) {
-      throw ArgumentError.notNull('DSN is required.');
+      throw ArgumentError('DSN is required.');
     }
   }
 
@@ -96,7 +96,7 @@ class Hub {
 
   /// Captures the exception
   Future<SentryId> captureException(
-    dynamic exception, {
+    dynamic throwable, {
     dynamic stackTrace,
     dynamic hint,
   }) async {
@@ -107,7 +107,7 @@ class Hub {
         SentryLevel.warning,
         "Instance is disabled and this 'captureException' call is a no-op.",
       );
-    } else if (exception == null) {
+    } else if (throwable == null) {
       _options.logger(
         SentryLevel.warning,
         'captureException called with null parameter.',
@@ -117,15 +117,15 @@ class Hub {
       if (item != null) {
         try {
           sentryId = await item.client.captureException(
-            exception,
+            throwable,
             stackTrace: stackTrace,
             scope: item.scope,
             hint: hint,
           );
         } catch (err) {
           _options.logger(
             SentryLevel.error,
-            'Error while capturing exception : ${exception}',
+            'Error while capturing exception : ${throwable}',
           );
         } finally {
           _lastEventId = sentryId;

dart/lib/src/hub_adapter.dart

@@ -28,12 +28,12 @@ class HubAdapter implements Hub {
 
   @override
   Future<SentryId> captureException(
-    dynamic exception, {
+    dynamic throwable, {
     dynamic stackTrace,
     dynamic hint,
   }) =>
       Sentry.captureException(
-        exception,
+        throwable,
         stackTrace: stackTrace,
         hint: hint,
       );

dart/lib/src/noop_hub.dart

@@ -25,7 +25,7 @@ class NoOpHub implements Hub {
 
   @override
   Future<SentryId> captureException(
-    dynamic exception, {
+    dynamic throwable, {
     dynamic stackTrace,
     dynamic hint,
   }) =>

dart/lib/src/protocol.dart

@@ -2,15 +2,22 @@ export 'protocol/app.dart';
 export 'protocol/breadcrumb.dart';
 export 'protocol/browser.dart';
 export 'protocol/contexts.dart';
+export 'protocol/debug_image.dart';
+export 'protocol/debug_meta.dart';
 export 'protocol/device.dart';
 export 'protocol/dsn.dart';
 export 'protocol/gpu.dart';
+export 'protocol/mechanism.dart';
 export 'protocol/message.dart';
-export 'protocol/package.dart';
-export 'protocol/runtime.dart';
-export 'protocol/sdk.dart';
+export 'protocol/operating_system.dart';
+export 'protocol/sdk_info.dart';
+export 'protocol/sdk_version.dart';
 export 'protocol/sentry_event.dart';
+export 'protocol/sentry_exception.dart';
 export 'protocol/sentry_id.dart';
 export 'protocol/sentry_level.dart';
-export 'protocol/system.dart';
+export 'protocol/sentry_package.dart';
+export 'protocol/sentry_runtime.dart';
+export 'protocol/sentry_stack_frame.dart';
+export 'protocol/sentry_stack_trace.dart';
 export 'protocol/user.dart';

dart/lib/src/protocol/contexts.dart

@@ -5,7 +5,7 @@ import 'app.dart';
 import 'browser.dart';
 import 'device.dart';
 import 'gpu.dart';
-import 'runtime.dart';
+import 'sentry_runtime.dart';
 
 /// The context interfaces provide additional context data.
 ///
@@ -17,14 +17,14 @@ class Contexts extends MapView<String, dynamic> {
   Contexts({
     Device device,
     OperatingSystem operatingSystem,
-    List<Runtime> runtimes,
+    List<SentryRuntime> runtimes,
     App app,
     Browser browser,
     Gpu gpu,
   }) : super({
           Device.type: device,
           OperatingSystem.type: operatingSystem,
-          Runtime.listType: runtimes ?? [],
+          SentryRuntime.listType: runtimes ?? [],
           App.type: app,
           Browser.type: browser,
           Gpu.type: gpu,
@@ -47,11 +47,14 @@ class Contexts extends MapView<String, dynamic> {
   /// Describes a list of runtimes in more detail
   /// (for instance if you have a Flutter application running
   /// on top of Android).
-  List<Runtime> get runtimes => List.unmodifiable(this[Runtime.listType]);
+  List<SentryRuntime> get runtimes =>
+      List.unmodifiable(this[SentryRuntime.listType]);
 
-  void addRuntime(Runtime runtime) => this[Runtime.listType].add(runtime);
+  void addRuntime(SentryRuntime runtime) =>
+      this[SentryRuntime.listType].add(runtime);
 
-  void removeRuntime(Runtime runtime) => this[Runtime.listType].remove(runtime);
+  void removeRuntime(SentryRuntime runtime) =>
+      this[SentryRuntime.listType].remove(runtime);
 
   /// App context describes the application.
   ///
@@ -116,12 +119,12 @@ class Contexts extends MapView<String, dynamic> {
           }
           break;
 
-        case Runtime.listType:
+        case SentryRuntime.listType:
           if (runtimes != null) {
             if (runtimes.length == 1) {
               final runtime = runtimes[0];
               if (runtime != null) {
-                final key = runtime.key ?? Runtime.type;
+                final key = runtime.key ?? SentryRuntime.type;
                 json[key] = runtime.toJson();
               }
             } else if (runtimes.length > 1) {
@@ -138,7 +141,7 @@ class Contexts extends MapView<String, dynamic> {
                   }
 
                   json[key] = runtime.toJson()
-                    ..addAll(<String, String>{'type': Runtime.type});
+                    ..addAll(<String, String>{'type': SentryRuntime.type});
                 }
               }
             }
@@ -173,8 +176,8 @@ class Contexts extends MapView<String, dynamic> {
     App.type,
     Device.type,
     OperatingSystem.type,
-    Runtime.listType,
-    Runtime.type,
+    SentryRuntime.listType,
+    SentryRuntime.type,
     Gpu.type,
     Browser.type,
   ];

dart/lib/src/protocol/debug_image.dart

@@ -0,0 +1,113 @@
+/// The list of debug images contains all dynamic libraries loaded into
+/// the process and their memory addresses.
+/// Instruction addresses in the Stack Trace are mapped into the list of debug
+/// images in order to retrieve debug files for symbolication.
+/// There are two kinds of debug images:
+//
+/// Native debug images with types macho, elf, and pe
+/// Android debug images with type proguard
+/// more details : https://develop.sentry.dev/sdk/event-payloads/debugmeta/
+class DebugImage {
+  final String uuid;
+
+  /// Required. Type of the debug image. Must be "macho".
+  final String type;
+
+  /// Required. Identifier of the dynamic library or executable. It is the value of the LC_UUID load command in the Mach header, formatted as UUID.
+  final String debugId;
+
+  /// Required. Memory address, at which the image is mounted in the virtual address space of the process.
+  /// Should be a string in hex representation prefixed with "0x".
+  final String imageAddr;
+
+  /// Required. The size of the image in virtual memory. If missing, Sentry will assume that the image spans up to the next image, which might lead to invalid stack traces.
+  final int imageSize;
+
+  /// OptionalName or absolute path to the dSYM file containing debug information for this image. This value might be required to retrieve debug files from certain symbol servers.
+  final String debugFile;
+
+  /// Optional. The absolute path to the dynamic library or executable. This helps to locate the file if it is missing on Sentry.
+  final String codeFile;
+
+  /// Optional Architecture of the module. If missing, this will be backfilled by Sentry.
+  final String arch;
+
+  /// Optional. Identifier of the dynamic library or executable. It is the value of the LC_UUID load command in the Mach header, formatted as UUID. Can be empty for Mach images, as it is equivalent to the debug identifier.
+  final String codeId;
+
+  DebugImage({
+    this.type,
+    this.imageAddr,
+    this.debugId,
+    this.debugFile,
+    this.imageSize,
+    this.uuid,
+    this.codeFile,
+    this.arch,
+    this.codeId,
+  });
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+
+    if (uuid != null) {
+      json['uuid'] = uuid;
+    }
+
+    if (type != null) {
+      json['type'] = type;
+    }
+
+    if (debugId != null) {
+      json['debug_id'] = debugId;
+    }
+
+    if (debugFile != null) {
+      json['debug_file'] = debugFile;
+    }
+
+    if (codeFile != null) {
+      json['codeFile'] = codeFile;
+    }
+
+    if (imageAddr != null) {
+      json['image_addr'] = imageAddr;
+    }
+
+    if (imageSize != null) {
+      json['imageSize'] = imageSize;
+    }
+
+    if (arch != null) {
+      json['arch'] = arch;
+    }
+
+    if (codeId != null) {
+      json['codeId'] = codeId;
+    }
+
+    return json;
+  }
+
+  DebugImage copyWith({
+    String uuid,
+    String type,
+    String debugId,
+    String debugFile,
+    String codeFile,
+    String imageAddr,
+    int imageSize,
+    String arch,
+    String codeId,
+  }) =>
+      DebugImage(
+        uuid: uuid ?? this.uuid,
+        type: type ?? this.type,
+        debugId: debugId ?? this.debugId,
+        codeFile: codeFile ?? this.codeFile,
+        imageAddr: imageAddr ?? this.imageAddr,
+        imageSize: imageSize ?? this.imageSize,
+        arch: arch ?? this.arch,
+        codeId: codeId ?? this.codeId,
+      );
+}

dart/lib/src/protocol/debug_meta.dart

@@ -0,0 +1,31 @@
+import '../protocol.dart';
+
+/// The debug meta interface carries debug information for processing errors and crash reports.
+class DebugMeta {
+  /// An object describing the system SDK.
+  final SdkInfo sdk;
+
+  final List<DebugImage> _images;
+
+  /// An immutable list of dynamic libraries loaded into the process (see below).
+  List<DebugImage> get images => List.unmodifiable(_images);
+
+  DebugMeta({this.sdk, List<DebugImage> images}) : _images = images;
+
+  Map<String, dynamic> toJson() {
+    final json = <String, dynamic>{};
+
+    if (sdk != null) {
+      json['sdk_info'] = sdk.toJson();
+    }
+
+    if (_images != null && _images.isNotEmpty) {
+      json['images'] = _images.map((e) => e.toJson());
+    }
+
+    return json;
+  }
+
+  DebugMeta copyWith({SdkVersion sdk, List<DebugImage> images}) =>
+      DebugMeta(sdk: sdk ?? this.sdk, images: images ?? _images);
+}