Feat: Support Attachment.addToTransactions (#709)

Author: denrase

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+* Feat: Support Attachment.addToTransactions (#709)
 * Fix: captureTransaction should return emptyId when transaction is discarded (#713)
 
 # 6.3.0-beta.3

dart/lib/src/sentry_attachment/sentry_attachment.dart

@@ -33,20 +33,24 @@ class SentryAttachment {
     required this.filename,
     String? attachmentType,
     this.contentType,
+    bool? addToTransactions,
   })  : _loader = loader,
-        attachmentType = attachmentType ?? typeAttachmentDefault;
+        attachmentType = attachmentType ?? typeAttachmentDefault,
+        addToTransactions = addToTransactions ?? false;
 
   /// Creates an [SentryAttachment] from a [Uint8List]
   SentryAttachment.fromUint8List(
     Uint8List bytes,
     String fileName, {
     String? contentType,
     String? attachmentType,
+    bool? addToTransactions,
   }) : this.fromLoader(
           attachmentType: attachmentType,
           loader: () => bytes,
           filename: fileName,
           contentType: contentType,
+          addToTransactions: addToTransactions,
         );
 
   /// Creates an [SentryAttachment] from a [List<int>]
@@ -55,11 +59,13 @@ class SentryAttachment {
     String fileName, {
     String? contentType,
     String? attachmentType,
+    bool? addToTransactions,
   }) : this.fromLoader(
           attachmentType: attachmentType,
           loader: () => Uint8List.fromList(bytes),
           filename: fileName,
           contentType: contentType,
+          addToTransactions: addToTransactions,
         );
 
   /// Creates an [SentryAttachment] from [ByteData]
@@ -68,11 +74,13 @@ class SentryAttachment {
     String fileName, {
     String? contentType,
     String? attachmentType,
+    bool? addToTransactions,
   }) : this.fromLoader(
           attachmentType: attachmentType,
           loader: () => bytes.buffer.asUint8List(),
           filename: fileName,
           contentType: contentType,
+          addToTransactions: addToTransactions,
         );
 
   /// Attachment type.
@@ -91,4 +99,8 @@ class SentryAttachment {
   /// Attachment content type.
   /// Inferred by Sentry if it's not given.
   final String? contentType;
+
+  /// If true, attachment should be added to every transaction.
+  /// Defaults to false.
+  final bool addToTransactions;
 }

dart/lib/src/sentry_client.dart

@@ -260,7 +260,11 @@ class SentryClient {
     }
 
     final id = await captureEnvelope(
-        SentryEnvelope.fromTransaction(preparedTransaction, _options.sdk));
+      SentryEnvelope.fromTransaction(preparedTransaction, _options.sdk,
+          attachments: scope?.attachements
+              .where((element) => element.addToTransactions)
+              .toList()),
+    );
     return id ?? SentryId.empty();
   }
 

dart/lib/src/sentry_envelope.dart

@@ -47,11 +47,16 @@ class SentryEnvelope {
   /// Create an [SentryEnvelope] with containing one [SentryEnvelopeItem] which holds the [SentryTransaction] data.
   factory SentryEnvelope.fromTransaction(
     SentryTransaction transaction,
-    SdkVersion sdkVersion,
-  ) {
+    SdkVersion sdkVersion, {
+    List<SentryAttachment>? attachments,
+  }) {
     return SentryEnvelope(
       SentryEnvelopeHeader(transaction.eventId, sdkVersion),
-      [SentryEnvelopeItem.fromTransaction(transaction)],
+      [
+        SentryEnvelopeItem.fromTransaction(transaction),
+        if (attachments != null)
+          ...attachments.map((e) => SentryEnvelopeItem.fromAttachment(e))
+      ],
     );
   }
 

dart/test/sentry_attachment_test.dart

@@ -85,6 +85,81 @@ void main() {
       );
     });
   });
+
+  group('addToTransactions', () {
+    test('defaults to false fromLoader', () async {
+      final attachment = SentryAttachment.fromLoader(
+        loader: () => Uint8List.fromList([0, 0, 0, 0]),
+        filename: 'test.txt',
+      );
+
+      expect(attachment.addToTransactions, false);
+    });
+
+    test('defaults to false fromIntList', () async {
+      final attachment = SentryAttachment.fromIntList([0, 0, 0, 0], 'test.txt');
+
+      expect(attachment.addToTransactions, false);
+    });
+
+    test('defaults to false fromUint8List', () async {
+      final attachment = SentryAttachment.fromUint8List(
+        Uint8List.fromList([0, 0, 0, 0]),
+        'test.txt',
+      );
+
+      expect(attachment.addToTransactions, false);
+    });
+
+    test('defaults to false fromByteData', () async {
+      final attachment = SentryAttachment.fromByteData(
+        ByteData.sublistView(Uint8List.fromList([0, 0, 0, 0])),
+        'test.txt',
+      );
+
+      expect(attachment.addToTransactions, false);
+    });
+
+    test('set fromLoader', () async {
+      final attachment = SentryAttachment.fromLoader(
+        loader: () => Uint8List.fromList([0, 0, 0, 0]),
+        filename: 'test.txt',
+        addToTransactions: true,
+      );
+
+      expect(attachment.addToTransactions, true);
+    });
+
+    test('defaults to false fromIntList', () async {
+      final attachment = SentryAttachment.fromIntList(
+        [0, 0, 0, 0],
+        'test.txt',
+        addToTransactions: true,
+      );
+
+      expect(attachment.addToTransactions, true);
+    });
+
+    test('defaults to false fromUint8List', () async {
+      final attachment = SentryAttachment.fromUint8List(
+        Uint8List.fromList([0, 0, 0, 0]),
+        'test.txt',
+        addToTransactions: true,
+      );
+
+      expect(attachment.addToTransactions, true);
+    });
+
+    test('defaults to false fromByteData', () async {
+      final attachment = SentryAttachment.fromByteData(
+        ByteData.sublistView(Uint8List.fromList([0, 0, 0, 0])),
+        'test.txt',
+        addToTransactions: true,
+      );
+
+      expect(attachment.addToTransactions, true);
+    });
+  });
 }
 
 class Fixture {

dart/test/sentry_client_test.dart

@@ -1,7 +1,9 @@
 import 'dart:async';
 import 'dart:convert';
+import 'dart:typed_data';
 
 import 'package:sentry/sentry.dart';
+import 'package:sentry/src/sentry_item_type.dart';
 import 'package:sentry/src/sentry_stack_trace_factory.dart';
 import 'package:sentry/src/sentry_tracer.dart';
 import 'package:test/test.dart';
@@ -347,6 +349,64 @@ void main() {
       expect(capturedEvent['exception'], isNull);
     });
 
+    test('attachments not added to captured transaction per default', () async {
+      final attachment = SentryAttachment.fromUint8List(
+        Uint8List.fromList([0, 0, 0, 0]),
+        'test.txt',
+      );
+      final scope = Scope(fixture.options);
+      scope.addAttachment(attachment);
+
+      final client = fixture.getSut();
+      final tr = SentryTransaction(fixture.tracer);
+      await client.captureTransaction(tr, scope: scope);
+
+      final capturedEnvelope = (fixture.transport).envelopes.first;
+      final capturedAttachments = capturedEnvelope.items
+          .where((item) => item.header.type == SentryItemType.attachment);
+
+      expect(capturedAttachments.isEmpty, true);
+    });
+
+    test('attachments added to captured event', () async {
+      final attachment = SentryAttachment.fromUint8List(
+        Uint8List.fromList([0, 0, 0, 0]),
+        'test.txt',
+        addToTransactions: true,
+      );
+      final scope = Scope(fixture.options);
+      scope.addAttachment(attachment);
+
+      final client = fixture.getSut();
+      final tr = SentryTransaction(fixture.tracer);
+      await client.captureTransaction(tr, scope: scope);
+
+      final capturedEnvelope = (fixture.transport).envelopes.first;
+      final capturedAttachments = capturedEnvelope.items
+          .where((item) => item.header.type == SentryItemType.attachment);
+
+      expect(capturedAttachments.isNotEmpty, true);
+    });
+
+    test('attachments added to captured event per default', () async {
+      final attachment = SentryAttachment.fromUint8List(
+        Uint8List.fromList([0, 0, 0, 0]),
+        'test.txt',
+      );
+      final scope = Scope(fixture.options);
+      scope.addAttachment(attachment);
+
+      final client = fixture.getSut();
+      final event = SentryEvent();
+      await client.captureEvent(event, scope: scope);
+
+      final capturedEnvelope = (fixture.transport).envelopes.first;
+      final capturedAttachments = capturedEnvelope.items
+          .where((item) => item.header.type == SentryItemType.attachment);
+
+      expect(capturedAttachments.isNotEmpty, true);
+    });
+
     test('should return empty for when transaction is discarded', () async {
       final client = fixture.getSut(eventProcessor: DropAllEventProcessor());
       final tr = SentryTransaction(fixture.tracer);

flutter/lib/src/flutter_sentry_attachment.dart

@@ -17,6 +17,7 @@ class FlutterSentryAttachment extends SentryAttachment {
     AssetBundle? bundle,
     String? type,
     String? contentType,
+    bool? addToTransactions,
   }) : super.fromLoader(
           loader: () async {
             final data = await (bundle ?? rootBundle).load(key);
@@ -25,5 +26,6 @@ class FlutterSentryAttachment extends SentryAttachment {
           filename: filename ?? Uri.parse(key).pathSegments.last,
           attachmentType: type,
           contentType: contentType,
+          addToTransactions: addToTransactions,
         );
 }

flutter/test/flutter_sentry_attachment_test.dart

@@ -10,11 +10,13 @@ void main() {
     final attachment = FlutterSentryAttachment.fromAsset(
       'foobar.txt',
       bundle: TestAssetBundle(),
+      addToTransactions: true,
     );
 
     expect(attachment.attachmentType, SentryAttachment.typeAttachmentDefault);
     expect(attachment.contentType, isNull);
     expect(attachment.filename, 'foobar.txt');
+    expect(attachment.addToTransactions, true);
     await expectLater(await attachment.bytes, [102, 111, 111, 32, 98, 97, 114]);
   });
 }