Make response body accessible via hint in beforeSendTransaction callback for SentryHttpClient

CHANGELOG.md

@@ -4,6 +4,17 @@
 
 ### Features
 
+- Make response body accessible via hint in `beforSend` callback for failed web requests or if tracing is enabled in `SentryHttpClient` ([#2293](https://github.com/getsentry/sentry-dart/pull/2293))
+  ```dart
+  options.beforeSendTransaction = (transaction, hint) {
+    final firstHint = transaction.spans[0].hint;
+    final firstResponseBody = firstHint?.get(TypeCheckHint.httpResponse);
+    final secondHint = transaction.spans[1].hint;
+    final secondResponseBody = secondHint?.get(TypeCheckHint.httpResponse);
+    // user can now use it
+    return transaction;
+  };
+  ```
 - Support for screenshot PII content masking ([#2361](https://github.com/getsentry/sentry-dart/pull/2361))
   By default, masking is enabled for SessionReplay. To also enable it for screenshots captured with events, you can specify `options.experimental.privacy`:
   ```dart

dart/lib/sentry.dart

@@ -25,6 +25,7 @@ export 'src/throwable_mechanism.dart';
 export 'src/transport/transport.dart';
 export 'src/integration.dart';
 export 'src/event_processor.dart';
+// ignore: invalid_export_of_internal_element
 export 'src/http_client/sentry_http_client.dart';
 export 'src/http_client/sentry_http_client_error.dart';
 export 'src/sentry_attachment/sentry_attachment.dart';

dart/lib/src/http_client/failed_request_client.dart

@@ -1,6 +1,7 @@
 import 'package:http/http.dart';
 import '../hint.dart';
 import '../type_check_hint.dart';
+import '../utils/streamed_response_copier.dart';
 import '../utils/tracing_utils.dart';
 import 'sentry_http_client_error.dart';
 import '../protocol.dart';
@@ -99,15 +100,19 @@ class FailedRequestClient extends BaseClient {
     int? statusCode;
     Object? exception;
     StackTrace? stackTrace;
-    StreamedResponse? response;
+    StreamedResponse? originalResponse;
+    StreamedResponse? copiedResponse;
 
     final stopwatch = Stopwatch();
     stopwatch.start();
 
     try {
-      response = await _client.send(request);
-      statusCode = response.statusCode;
-      return response;
+      originalResponse = await _client.send(request);
+      final copier = StreamedResponseCopier(originalResponse);
+      originalResponse = copier.copy();
+      copiedResponse = copier.copy();
+      statusCode = originalResponse.statusCode;
+      return originalResponse;
     } catch (e, st) {
       exception = e;
       stackTrace = st;
@@ -119,7 +124,7 @@ class FailedRequestClient extends BaseClient {
         statusCode,
         exception,
         stackTrace,
-        response,
+        copiedResponse,
         stopwatch.elapsed,
       );
     }

dart/lib/src/http_client/sentry_http_client.dart

@@ -1,7 +1,6 @@
 import 'package:http/http.dart';
+import '../../sentry.dart';
 import 'tracing_client.dart';
-import '../hub.dart';
-import '../hub_adapter.dart';
 import 'breadcrumb_client.dart';
 import 'failed_request_client.dart';
 

dart/lib/src/http_client/tracing_client.dart

@@ -1,11 +1,6 @@
 import 'package:http/http.dart';
-import '../hub.dart';
-import '../hub_adapter.dart';
-import '../protocol.dart';
-import '../sentry_trace_origins.dart';
-import '../tracing.dart';
-import '../utils/tracing_utils.dart';
-import '../utils/http_sanitizer.dart';
+import '../../sentry.dart';
+import '../utils/streamed_response_copier.dart';
 
 /// A [http](https://pub.dev/packages/http)-package compatible HTTP client
 /// which adds support to Sentry Performance feature.
@@ -44,7 +39,8 @@ class TracingClient extends BaseClient {
     span?.setData('http.request.method', request.method);
     urlDetails?.applyToSpan(span);
 
-    StreamedResponse? response;
+    StreamedResponse? originalResponse;
+    final hint = Hint();
     try {
       if (containsTargetOrMatchesRegExp(
           _hub.options.tracePropagationTargets, request.url.toString())) {
@@ -71,19 +67,26 @@ class TracingClient extends BaseClient {
         }
       }
 
-      response = await _client.send(request);
-      span?.setData('http.response.status_code', response.statusCode);
-      span?.setData('http.response_content_length', response.contentLength);
-      span?.status = SpanStatus.fromHttpStatusCode(response.statusCode);
+      originalResponse = await _client.send(request);
+      final copier = StreamedResponseCopier(originalResponse);
+      originalResponse = copier.copy();
+      final copiedResponse = copier.copy();
+
+      span?.setData('http.response.status_code', originalResponse.statusCode);
+      span?.setData(
+          'http.response_content_length', originalResponse.contentLength);
+      span?.status = SpanStatus.fromHttpStatusCode(originalResponse.statusCode);
+
+      hint.set(TypeCheckHint.httpResponse, copiedResponse);
     } catch (exception) {
       span?.throwable = exception;
       span?.status = SpanStatus.internalError();
 
       rethrow;
     } finally {
-      await span?.finish();
+      await span?.finish(hint: hint);
     }
-    return response;
+    return originalResponse;
   }
 
   @override

dart/lib/src/hub.dart

@@ -576,6 +576,7 @@ class Hub {
   Future<SentryId> captureTransaction(
     SentryTransaction transaction, {
     SentryTraceContextHeader? traceContext,
+    Hint? hint,
   }) async {
     var sentryId = SentryId.empty();
 
@@ -617,6 +618,7 @@ class Hub {
             transaction,
             scope: item.scope,
             traceContext: traceContext,
+            hint: hint,
           );
         } catch (exception, stackTrace) {
           _options.logger(

dart/lib/src/hub_adapter.dart

@@ -109,10 +109,12 @@ class HubAdapter implements Hub {
   Future<SentryId> captureTransaction(
     SentryTransaction transaction, {
     SentryTraceContextHeader? traceContext,
+    Hint? hint,
   }) =>
       Sentry.currentHub.captureTransaction(
         transaction,
         traceContext: traceContext,
+        hint: hint,
       );
 
   @override

dart/lib/src/noop_hub.dart

@@ -93,6 +93,7 @@ class NoOpHub implements Hub {
   Future<SentryId> captureTransaction(
     SentryTransaction transaction, {
     SentryTraceContextHeader? traceContext,
+    Hint? hint,
   }) async =>
       SentryId.empty();
 

dart/lib/src/noop_sentry_client.dart

@@ -67,6 +67,7 @@ class NoOpSentryClient implements SentryClient {
     SentryTransaction transaction, {
     Scope? scope,
     SentryTraceContextHeader? traceContext,
+    Hint? hint,
   }) async =>
       SentryId.empty();
 

dart/lib/src/noop_sentry_span.dart

@@ -1,7 +1,5 @@
+import '../sentry.dart';
 import 'metrics/local_metrics_aggregator.dart';
-import 'protocol.dart';
-import 'tracing.dart';
-import 'utils.dart';
 
 class NoOpSentrySpan extends ISentrySpan {
   NoOpSentrySpan._();
@@ -27,7 +25,11 @@ class NoOpSentrySpan extends ISentrySpan {
   }
 
   @override
-  Future<void> finish({SpanStatus? status, DateTime? endTimestamp}) async {}
+  Future<void> finish({
+    SpanStatus? status,
+    DateTime? endTimestamp,
+    Hint? hint,
+  }) async {}
 
   @override
   void removeData(String key) {}

dart/lib/src/protocol/sentry_span.dart

@@ -7,7 +7,10 @@ import '../metrics/local_metrics_aggregator.dart';
 
 import '../sentry_tracer.dart';
 
-typedef OnFinishedCallback = Future<void> Function({DateTime? endTimestamp});
+typedef OnFinishedCallback = Future<void> Function({
+  DateTime? endTimestamp,
+  Hint? hint,
+});
 
 class SentrySpan extends ISentrySpan {
   final SentrySpanContext _context;
@@ -36,6 +39,8 @@ class SentrySpan extends ISentrySpan {
   @override
   final SentryTracesSamplingDecision? samplingDecision;
 
+  late final Hint? hint;
+
   SentrySpan(
     this._tracer,
     this._context,
@@ -55,10 +60,15 @@ class SentrySpan extends ISentrySpan {
   }
 
   @override
-  Future<void> finish({SpanStatus? status, DateTime? endTimestamp}) async {
+  Future<void> finish({
+    SpanStatus? status,
+    DateTime? endTimestamp,
+    Hint? hint,
+  }) async {
     if (finished) {
       return;
     }
+    this.hint = hint;
 
     if (status != null) {
       _status = status;

dart/lib/src/sentry_client.dart

@@ -365,8 +365,9 @@ class SentryClient {
     SentryTransaction transaction, {
     Scope? scope,
     SentryTraceContextHeader? traceContext,
+    Hint? hint,
   }) async {
-    final hint = Hint();
+    hint ??= Hint();
 
     SentryTransaction? preparedTransaction =
         _prepareEvent(transaction, hint) as SentryTransaction;
@@ -409,8 +410,10 @@ class SentryClient {
     preparedTransaction = _createUserOrSetDefaultIpAddress(preparedTransaction)
         as SentryTransaction;
 
-    preparedTransaction =
-        await _runBeforeSend(preparedTransaction, hint) as SentryTransaction?;
+    preparedTransaction = await _runBeforeSend(
+      preparedTransaction,
+      hint,
+    ) as SentryTransaction?;
 
     // dropped by beforeSendTransaction
     if (preparedTransaction == null) {
@@ -515,7 +518,7 @@ class SentryClient {
     try {
       if (event is SentryTransaction && beforeSendTransaction != null) {
         beforeSendName = 'beforeSendTransaction';
-        final callbackResult = beforeSendTransaction(event);
+        final callbackResult = beforeSendTransaction(event, hint);
         if (callbackResult is Future<SentryTransaction?>) {
           processedEvent = await callbackResult;
         } else {

dart/lib/src/sentry_options.dart

@@ -654,6 +654,7 @@ typedef BeforeSendCallback = FutureOr<SentryEvent?> Function(
 /// object or nothing to skip reporting the transaction
 typedef BeforeSendTransactionCallback = FutureOr<SentryTransaction?> Function(
   SentryTransaction transaction,
+  Hint hint,
 );
 
 /// This function is called with an SDK specific breadcrumb object before the breadcrumb is added

dart/lib/src/sentry_span_interface.dart

@@ -1,8 +1,7 @@
 import 'package:meta/meta.dart';
 
+import '../sentry.dart';
 import 'metrics/local_metrics_aggregator.dart';
-import 'protocol.dart';
-import 'tracing.dart';
 
 /// Represents performance monitoring Span.
 abstract class ISentrySpan {
@@ -26,7 +25,11 @@ abstract class ISentrySpan {
   void removeData(String key);
 
   /// Sets span timestamp marking this span as finished.
-  Future<void> finish({SpanStatus? status, DateTime? endTimestamp}) async {}
+  Future<void> finish({
+    SpanStatus? status,
+    DateTime? endTimestamp,
+    Hint? hint,
+  }) async {}
 
   /// Gets span status.
   SpanStatus? get status;

dart/lib/src/sentry_tracer.dart

@@ -92,7 +92,11 @@ class SentryTracer extends ISentrySpan {
   }
 
   @override
-  Future<void> finish({SpanStatus? status, DateTime? endTimestamp}) async {
+  Future<void> finish({
+    SpanStatus? status,
+    DateTime? endTimestamp,
+    Hint? hint,
+  }) async {
     final commonEndTimestamp = endTimestamp ?? _hub.options.clock();
     _autoFinishAfterTimer?.cancel();
     _finishStatus = SentryTracerFinishStatus.finishing(status);
@@ -160,6 +164,7 @@ class SentryTracer extends ISentrySpan {
       await _hub.captureTransaction(
         transaction,
         traceContext: traceContext(),
+        hint: hint,
       );
     } finally {
       profiler?.dispose();
@@ -274,12 +279,14 @@ class SentryTracer extends ISentrySpan {
     return child;
   }
 
-  Future<void> _finishedCallback({
-    DateTime? endTimestamp,
-  }) async {
+  Future<void> _finishedCallback({DateTime? endTimestamp, Hint? hint}) async {
     final finishStatus = _finishStatus;
     if (finishStatus.finishing) {
-      await finish(status: finishStatus.status, endTimestamp: endTimestamp);
+      await finish(
+        status: finishStatus.status,
+        endTimestamp: endTimestamp,
+        hint: hint,
+      );
     }
   }