Added missing DSN field into the SentryEnvelopeHeade (#1050)

Co-authored-by: vishnukvmd <[email protected]>
Co-authored-by: Neeraj Gupta <[email protected]>

.gitattributes

@@ -1 +1,2 @@
 CHANGELOG.md merge=union
+* text=auto eol=lf 

CHANGELOG.md

@@ -10,6 +10,7 @@
 ### Features
 
 - Added [Flutter renderer](https://docs.flutter.dev/development/platform-integration/web/renderers) information to events ([#1035](https://github.com/getsentry/sentry-dart/pull/1035))
+- Added missing DSN field into the SentryEnvelopeHeader ([#1050](https://github.com/getsentry/sentry-dart/pull/1050))
 
 ### Dependencies
 

dart/lib/src/sentry_client.dart

@@ -133,6 +133,7 @@ class SentryClient {
     final envelope = SentryEnvelope.fromEvent(
       preparedEvent,
       _options.sdk,
+      dsn: _options.dsn,
       traceContext: scope?.span?.traceContext(),
       attachments: scope?.attachments,
     );
@@ -318,6 +319,7 @@ class SentryClient {
     final envelope = SentryEnvelope.fromTransaction(
       preparedTransaction,
       _options.sdk,
+      dsn: _options.dsn,
       traceContext: traceContext,
       attachments: attachments,
     );
@@ -336,6 +338,7 @@ class SentryClient {
     final envelope = SentryEnvelope.fromUserFeedback(
       userFeedback,
       _options.sdk,
+      dsn: _options.dsn,
     );
     return _attachClientReportsAndSend(envelope);
   }

dart/lib/src/sentry_envelope.dart

@@ -24,13 +24,15 @@ class SentryEnvelope {
   factory SentryEnvelope.fromEvent(
     SentryEvent event,
     SdkVersion sdkVersion, {
+    String? dsn,
     SentryTraceContextHeader? traceContext,
     List<SentryAttachment>? attachments,
   }) {
     return SentryEnvelope(
       SentryEnvelopeHeader(
         event.eventId,
         sdkVersion,
+        dsn: dsn,
         traceContext: traceContext,
       ),
       [
@@ -43,11 +45,16 @@ class SentryEnvelope {
 
   factory SentryEnvelope.fromUserFeedback(
     SentryUserFeedback feedback,
-    SdkVersion sdkVersion,
-  ) {
+    SdkVersion sdkVersion, {
+    String? dsn,
+  }) {
     return SentryEnvelope(
       // no need for [traceContext]
-      SentryEnvelopeHeader(feedback.eventId, sdkVersion),
+      SentryEnvelopeHeader(
+        feedback.eventId,
+        sdkVersion,
+        dsn: dsn,
+      ),
       [SentryEnvelopeItem.fromUserFeedback(feedback)],
     );
   }
@@ -56,13 +63,15 @@ class SentryEnvelope {
   factory SentryEnvelope.fromTransaction(
     SentryTransaction transaction,
     SdkVersion sdkVersion, {
+    String? dsn,
     SentryTraceContextHeader? traceContext,
     List<SentryAttachment>? attachments,
   }) {
     return SentryEnvelope(
       SentryEnvelopeHeader(
         transaction.eventId,
         sdkVersion,
+        dsn: dsn,
         traceContext: traceContext,
       ),
       [

dart/lib/src/sentry_envelope_header.dart

@@ -7,11 +7,13 @@ class SentryEnvelopeHeader {
   SentryEnvelopeHeader(
     this.eventId,
     this.sdkVersion, {
+    this.dsn,
     this.traceContext,
   });
   SentryEnvelopeHeader.newEventId()
       : eventId = SentryId.newId(),
         sdkVersion = null,
+        dsn = null,
         traceContext = null;
 
   /// The identifier of encoded `SentryEvent`.
@@ -22,6 +24,9 @@ class SentryEnvelopeHeader {
 
   final SentryTraceContextHeader? traceContext;
 
+  /// The `DSN` of the Sentry project.
+  final String? dsn;
+
   /// Header encoded as JSON
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
@@ -41,6 +46,9 @@ class SentryEnvelopeHeader {
       json['trace'] = tempTraceContext.toJson();
     }
 
+    if (dsn != null) {
+      json['dsn'] = dsn;
+    }
     return json;
   }
 }

dart/test/mocks.dart

@@ -129,7 +129,10 @@ typedef EventProcessorFunction = FutureOr<SentryEvent?>
     Function(SentryEvent event, {dynamic hint});
 
 var fakeEnvelope = SentryEnvelope.fromEvent(
-    fakeEvent, SdkVersion(name: 'sdk1', version: '1.0.0'));
+  fakeEvent,
+  SdkVersion(name: 'sdk1', version: '1.0.0'),
+  dsn: fakeDsn,
+);
 
 class MockRateLimiter implements RateLimiter {
   bool filterReturnsNull = false;

dart/test/sentry_client_test.dart

@@ -195,6 +195,16 @@ void main() {
 
       expect(capturedEvent.threads?.first.stacktrace, isNull);
     });
+
+    test('event envelope contains dsn', () async {
+      final client = fixture.getSut();
+      final event = SentryEvent();
+      await client.captureEvent(event);
+
+      final capturedEnvelope = (fixture.transport).envelopes.first;
+
+      expect(capturedEnvelope.header.dsn, fixture.options.dsn);
+    });
   });
 
   group('SentryClient captures exception', () {
@@ -468,6 +478,16 @@ void main() {
 
       expect(id, SentryId.empty());
     });
+
+    test('transaction envelope contains dsn', () async {
+      final client = fixture.getSut();
+      final tr = SentryTransaction(fixture.tracer);
+      await client.captureTransaction(tr);
+
+      final capturedEnvelope = (fixture.transport).envelopes.first;
+
+      expect(capturedEnvelope.header.dsn, fixture.options.dsn);
+    });
   });
 
   group('SentryClient : apply scope to the captured event', () {
@@ -1193,6 +1213,20 @@ void main() {
       expect(fixture.recorder.reason, DiscardReason.sampleRate);
       expect(fixture.recorder.category, DataCategory.error);
     });
+
+    test('user feedback envelope contains dsn', () async {
+      final client = fixture.getSut();
+      final event = SentryEvent();
+      final feedback = SentryUserFeedback(
+        eventId: event.eventId,
+        name: 'test',
+      );
+      await client.captureUserFeedback(feedback);
+
+      final capturedEnvelope = (fixture.transport).envelopes.first;
+
+      expect(capturedEnvelope.header.dsn, fixture.options.dsn);
+    });
   });
 }
 

dart/test/sentry_envelope_header_test.dart

@@ -2,6 +2,8 @@ import 'package:sentry/sentry.dart';
 import 'package:sentry/src/sentry_envelope_header.dart';
 import 'package:test/test.dart';
 
+import 'mocks.dart';
+
 void main() {
   group('SentryEnvelopeHeader', () {
     test('toJson empty', () {
@@ -23,13 +25,15 @@ void main() {
       final sut = SentryEnvelopeHeader(
         eventId,
         sdkVersion,
+        dsn: fakeDsn,
         traceContext: context,
       );
       final expextedSkd = sdkVersion.toJson();
       final expected = <String, dynamic>{
         'event_id': eventId.toString(),
         'sdk': expextedSkd,
         'trace': context.toJson(),
+        'dsn': fakeDsn,
       };
       expect(sut.toJson(), expected);
     });

dart/test/sentry_envelope_test.dart

@@ -9,6 +9,7 @@ import 'package:sentry/src/sentry_tracer.dart';
 import 'package:sentry/src/utils.dart';
 import 'package:test/test.dart';
 
+import 'mocks.dart';
 import 'mocks/mock_hub.dart';
 
 void main() {
@@ -67,6 +68,7 @@ void main() {
       final sut = SentryEnvelope.fromEvent(
         sentryEvent,
         sdkVersion,
+        dsn: fakeDsn,
         traceContext: context,
       );
 
@@ -75,6 +77,7 @@ void main() {
       expect(sut.header.eventId, eventId);
       expect(sut.header.sdkVersion, sdkVersion);
       expect(sut.header.traceContext, context);
+      expect(sut.header.dsn, fakeDsn);
       expect(sut.items[0].header.contentType,
           expectedEnvelopeItem.header.contentType);
       expect(sut.items[0].header.type, expectedEnvelopeItem.header.type);
@@ -105,6 +108,7 @@ void main() {
       final sut = SentryEnvelope.fromTransaction(
         tr,
         sdkVersion,
+        dsn: fakeDsn,
         traceContext: traceContext,
       );
 
@@ -113,6 +117,7 @@ void main() {
       expect(sut.header.eventId, tr.eventId);
       expect(sut.header.sdkVersion, sdkVersion);
       expect(sut.header.traceContext, traceContext);
+      expect(sut.header.dsn, fakeDsn);
       expect(sut.items[0].header.contentType,
           expectedEnvelopeItem.header.contentType);
       expect(sut.items[0].header.type, expectedEnvelopeItem.header.type);
@@ -140,12 +145,14 @@ void main() {
       final sut = SentryEnvelope.fromEvent(
         sentryEvent,
         sdkVersion,
+        dsn: fakeDsn,
         attachments: [attachment],
       );
 
       final expectedEnvelopeItem = SentryEnvelope.fromEvent(
         sentryEvent,
         sdkVersion,
+        dsn: fakeDsn,
       );
 
       final sutEnvelopeData = <int>[];
@@ -171,6 +178,7 @@ void main() {
           name: 'test',
           version: '1',
         ),
+        dsn: fakeDsn,
       );
 
       final _ = sut.envelopeStream(SentryOptions()).map((e) => e);