WIP

Author: ueman

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+* Feat: Add support for attachments (#505)
+
 # 6.0.0-beta.1
 
 * Feat: Browser detection (#502)
@@ -8,7 +10,6 @@
 * Feat: Add DeduplicationEventProcessor (#498)
 * Feat: Capture failed requests as event (#473)
 * Feat: `beforeSend` callback accepts async code (#494)
-* Feat: Add support for attachments (#505)
 
 ## Breaking Changes:
 

dart/lib/src/scope.dart

@@ -120,7 +120,7 @@ class Scope {
     _breadcrumbs.add(breadcrumb);
   }
 
-  void addAttachment(SentryAttachment attachment) async {
+  void addAttachment(SentryAttachment attachment) {
     _attachements.add(attachment);
   }
 
@@ -299,7 +299,7 @@ class Scope {
     });
 
     for (final attachment in _attachements) {
-      clone._attachements.add(attachment);
+      clone.addAttachment(attachment);
     }
 
     return clone;

dart/lib/src/sentry_attachment/sentry_attachment.dart

@@ -8,13 +8,33 @@ typedef ContentLoader = FutureOr<Uint8List> Function();
 
 /// Arbitrary content which gets attached to an event.
 class SentryAttachment {
+  /// Standard attachment without special meaning.
+  static const String typeAttachmentDefault = 'event.attachment';
+
+  /// Minidump file that creates an error event and is symbolicated.
+  /// The file should start with the `MDMP` magic bytes.
+  static const String typeMinidump = 'event.minidump';
+
+  /// Apple crash report file that creates an error event and is symbolicated.
+  static const String typeAppleCrashReport = 'event.applecrashreport';
+
+  /// XML file containing UE4 crash meta data.
+  /// During event ingestion, event contexts and extra fields are extracted from
+  /// this file.
+  static const String typeUnrealContext = 'unreal.context';
+
+  /// Plain-text log file obtained from UE4 crashes.
+  /// During event ingestion, the last logs are extracted into event
+  /// breadcrumbs.
+  static const String typeUnrealLogs = 'unreal.logs';
+
   SentryAttachment.fromLoader({
     required ContentLoader loader,
     required this.filename,
     String? attachmentType,
     this.contentType,
   })  : _loader = loader,
-        attachmentType = attachmentType ?? AttachmentType.attachment;
+        attachmentType = attachmentType ?? typeAttachmentDefault;
 
   /// Creates an [SentryAttachment] from a [Uint8List]
   SentryAttachment.fromUint8List(
@@ -72,26 +92,3 @@ class SentryAttachment {
   /// Inferred by Sentry if it's not given.
   final String? contentType;
 }
-
-/// Attachment type.
-class AttachmentType {
-  /// Standard attachment without special meaning.
-  static const String attachment = 'event.attachment';
-
-  /// Minidump file that creates an error event and is symbolicated.
-  /// The file should start with the `MDMP` magic bytes.
-  static const String minidump = 'event.minidump';
-
-  /// Apple crash report file that creates an error event and is symbolicated.
-  static const String appleCrashReport = 'event.applecrashreport';
-
-  /// XML file containing UE4 crash meta data.
-  /// During event ingestion, event contexts and extra fields are extracted from
-  /// this file.
-  static const String unrealContext = 'unreal.context';
-
-  /// Plain-text log file obtained from UE4 crashes.
-  /// During event ingestion, the last logs are extracted into event
-  /// breadcrumbs.
-  static const String unrealLogs = 'unreal.logs';
-}

dart/lib/src/sentry_envelope.dart

@@ -37,8 +37,11 @@ class SentryEnvelope {
     yield utf8.encode(jsonEncode(header.toJson()));
     final newLineData = utf8.encode('\n');
     for (final item in items) {
-      yield newLineData;
-      yield await item.envelopeItemStream();
+      final itemStream = await item.envelopeItemStream();
+      if (itemStream.isNotEmpty) {
+        yield newLineData;
+        yield itemStream;
+      }
     }
   }
 }

dart/test/sentry_attachment_test.dart

@@ -13,15 +13,15 @@ void main() {
         loader: () => Uint8List.fromList([0, 0, 0, 0]),
         filename: 'test.txt',
       );
-      expect(attachment.attachmentType, AttachmentType.attachment);
+      expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
       expect(attachment.contentType, isNull);
       expect(attachment.filename, 'test.txt');
       await expectLater(await attachment.bytes, [0, 0, 0, 0]);
     });
 
     test('fromIntList', () async {
       final attachment = SentryAttachment.fromIntList([0, 0, 0, 0], 'test.txt');
-      expect(attachment.attachmentType, AttachmentType.attachment);
+      expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
       expect(attachment.contentType, isNull);
       expect(attachment.filename, 'test.txt');
       await expectLater(await attachment.bytes, [0, 0, 0, 0]);
@@ -32,7 +32,7 @@ void main() {
         Uint8List.fromList([0, 0, 0, 0]),
         'test.txt',
       );
-      expect(attachment.attachmentType, AttachmentType.attachment);
+      expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
       expect(attachment.contentType, isNull);
       expect(attachment.filename, 'test.txt');
       await expectLater(await attachment.bytes, [0, 0, 0, 0]);
@@ -43,7 +43,7 @@ void main() {
         ByteData.sublistView(Uint8List.fromList([0, 0, 0, 0])),
         'test.txt',
       );
-      expect(attachment.attachmentType, AttachmentType.attachment);
+      expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
       expect(attachment.contentType, isNull);
       expect(attachment.filename, 'test.txt');
       await expectLater(await attachment.bytes, [0, 0, 0, 0]);
@@ -66,7 +66,7 @@ void main() {
       final attachmentEnvelope = transport.envelopes.first.items[1];
       expect(
         attachmentEnvelope.header.attachmentType,
-        AttachmentType.attachment,
+        SentryAttachment.typeAttachmentDefault,
       );
       expect(
         attachmentEnvelope.header.contentType,

dart/test/sentry_attachment_test_io.dart

@@ -11,7 +11,7 @@ void main() {
       final file = File('test_resources/testfile.txt');
 
       final attachment = IoSentryAttachment.fromFile(file);
-      expect(attachment.attachmentType, AttachmentType.attachment);
+      expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
       expect(attachment.contentType, isNull);
       expect(attachment.filename, 'testfile.txt');
       await expectLater(
@@ -21,7 +21,7 @@ void main() {
     test('fromPath', () async {
       final attachment =
           IoSentryAttachment.fromPath('test_resources/testfile.txt');
-      expect(attachment.attachmentType, AttachmentType.attachment);
+      expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
       expect(attachment.contentType, isNull);
       expect(attachment.filename, 'testfile.txt');
       await expectLater(

dart/test/sentry_envelope_vm_test.dart

@@ -53,8 +53,11 @@ void main() {
       final attachment =
           IoSentryAttachment.fromPath('this_path_does_not_exist.txt');
 
-      final envelope = SentryEnvelope.fromEvent(event, sdkVersion,
-          attachments: [attachment]);
+      final envelope = SentryEnvelope.fromEvent(
+        event,
+        sdkVersion,
+        attachments: [attachment],
+      );
 
       final data =
           (await envelope.envelopeStream().toList()).reduce((a, b) => a + b);
@@ -292,6 +295,5 @@ final envelopeBinaryData = [
   48,
   90,
   34,
-  125,
-  10
+  125
 ];