feat: add cookies to SentryResponse

Author: vaind

dart/lib/src/protocol/sentry_response.dart

@@ -1,4 +1,5 @@
 import 'package:meta/meta.dart';
+import 'package:collection/collection.dart';
 import 'contexts.dart';
 
 /// The response interface contains information on a HTTP request related to the event.
@@ -24,16 +25,26 @@ class SentryResponse {
 
   final Map<String, String>? _headers;
 
-  SentryResponse({
-    this.bodySize,
-    this.statusCode,
-    Map<String, String>? headers,
-  }) : _headers = headers != null ? Map.from(headers) : null;
+  /// Cookie key-value pairs as string.
+  final String? cookies;
+
+  SentryResponse(
+      {this.bodySize,
+      this.statusCode,
+      Map<String, String>? headers,
+      String? cookies})
+      : _headers = headers != null ? Map.from(headers) : null,
+        // Look for a 'Set-Cookie' header (case insensitive) if not given.
+        cookies = cookies ??
+            headers?.entries
+                .firstWhereOrNull((e) => e.key.toLowerCase() == 'set-cookie')
+                ?.value;
 
   /// Deserializes a [SentryResponse] from JSON [Map].
   factory SentryResponse.fromJson(Map<String, dynamic> json) {
     return SentryResponse(
         headers: json.containsKey('headers') ? Map.from(json['headers']) : null,
+        cookies: json['cookies'],
         bodySize: json['body_size'],
         statusCode: json['status_code']);
   }
@@ -42,6 +53,7 @@ class SentryResponse {
   Map<String, dynamic> toJson() {
     return <String, dynamic>{
       if (headers.isNotEmpty) 'headers': headers,
+      if (cookies != null) 'cookies': cookies,
       if (bodySize != null) 'body_size': bodySize,
       if (statusCode != null) 'status_code': statusCode,
     };
@@ -51,16 +63,19 @@ class SentryResponse {
     int? statusCode,
     int? bodySize,
     Map<String, String>? headers,
+    String? cookies,
   }) =>
       SentryResponse(
         headers: headers ?? _headers,
+        cookies: cookies ?? this.cookies,
         bodySize: bodySize ?? this.bodySize,
         statusCode: statusCode ?? this.statusCode,
       );
 
   SentryResponse clone() => SentryResponse(
         bodySize: bodySize,
         headers: headers,
+        cookies: cookies,
         statusCode: statusCode,
       );
 }

dart/pubspec.yaml

@@ -16,11 +16,11 @@ dependencies:
   stack_trace: ^1.10.0
   uuid: ^3.0.0
   intl: ^0.17.0
+  collection: ^1.16.0
 
 dev_dependencies:
   mockito: ^5.1.0
   lints: ^2.0.0
   test: ^1.21.1
   yaml: ^3.1.0 # needed for version match (code and pubspec)
-  collection: ^1.16.0
   coverage: ^1.3.0

dart/test/http_client/failed_request_client_test.dart

@@ -83,7 +83,9 @@ void main() {
     test('event reported if bad status code occurs', () async {
       final sut = fixture.getSut(
         client: fixture.getClient(
-            statusCode: 404, body: 'foo', headers: {'lorem': 'ipsum'}),
+            statusCode: 404,
+            body: 'foo',
+            headers: {'lorem': 'ipsum', 'set-cookie': 'foo=bar'}),
         badStatusCodes: [SentryStatusCode(404)],
       );
 
@@ -122,7 +124,9 @@ void main() {
       final response = eventCall.contexts.response!;
       expect(response.bodySize, 3);
       expect(response.statusCode, 404);
-      expect(response.headers, equals({'lorem': 'ipsum'}));
+      expect(response.headers,
+          equals({'lorem': 'ipsum', 'set-cookie': 'foo=bar'}));
+      expect(response.cookies, equals('foo=bar'));
     });
 
     test(

dart/test/protocol/sentry_response_test.dart

@@ -7,12 +7,14 @@ void main() {
     bodySize: 42,
     statusCode: 200,
     headers: {'header_key': 'header_value'},
+    cookies: 'foo=bar, another=cookie',
   );
 
   final sentryResponseJson = <String, dynamic>{
     'body_size': 42,
     'status_code': 200,
     'headers': {'header_key': 'header_value'},
+    'cookies': 'foo=bar, another=cookie',
   };
 
   group('json', () {
@@ -41,10 +43,7 @@ void main() {
 
       final copy = data.copyWith();
 
-      expect(
-        DeepCollectionEquality().equals(data.toJson(), copy.toJson()),
-        true,
-      );
+      expect(data.toJson(), copy.toJson());
     });
 
     test('copyWith takes new values', () {

dio/test/dio_event_processor_test.dart

@@ -102,7 +102,8 @@ void main() {
           response: Response<dynamic>(
             data: 'foobar',
             headers: Headers.fromMap(<String, List<String>>{
-              'foo': ['bar']
+              'foo': ['bar'],
+              'set-cookie': ['foo=bar']
             }),
             requestOptions: request,
             isRedirect: true,
@@ -117,7 +118,11 @@ void main() {
       expect(processedEvent.contexts.response, isNotNull);
       expect(processedEvent.contexts.response?.bodySize, 6);
       expect(processedEvent.contexts.response?.statusCode, 200);
-      expect(processedEvent.contexts.response?.headers, {'foo': 'bar'});
+      expect(processedEvent.contexts.response?.headers, {
+        'foo': 'bar',
+        'set-cookie': 'foo=bar',
+       });
+      expect(processedEvent.contexts.response?.cookies, 'foo=bar');
     });
 
     test('$DioEventProcessor adds response without PII', () {