add override to http clients

Author: denrase

dart/lib/src/http_client/failed_request_client.dart

@@ -73,15 +73,22 @@ class FailedRequestClient extends BaseClient {
     this.failedRequestTargets = SentryHttpClient.defaultFailedRequestTargets,
     Client? client,
     Hub? hub,
+    bool? captureFailedRequests,
   })  : _hub = hub ?? HubAdapter(),
-        _client = client ?? Client() {
-    if (_hub.options.captureFailedRequests) {
+        _client = client ?? Client(),
+        _captureFailedRequests = captureFailedRequests {
+    if (captureFailedRequests == null) {
+      if (_hub.options.captureFailedRequests) {
+        _hub.options.sdk.addIntegration('HTTPClientError');
+      }
+    } else if (captureFailedRequests) {
       _hub.options.sdk.addIntegration('HTTPClientError');
     }
   }
 
   final Client _client;
   final Hub _hub;
+  final bool? _captureFailedRequests;
 
   /// Describes which HTTP status codes should be considered as a failed
   /// requests.
@@ -129,7 +136,11 @@ class FailedRequestClient extends BaseClient {
       StackTrace? stackTrace,
       StreamedResponse? response,
       Duration duration) async {
-    if (!_hub.options.captureFailedRequests) {
+
+    if (_captureFailedRequests == false) {
+      return;
+    }
+    if (_captureFailedRequests != true && !_hub.options.captureFailedRequests) {
       return;
     }
 

dart/lib/src/http_client/sentry_http_client.dart

@@ -73,6 +73,9 @@ import 'failed_request_client.dart';
 /// Remarks:
 /// HTTP traffic can contain PII (personal identifiable information).
 /// Read more on data scrubbing [here](https://docs.sentry.io/product/data-management-settings/advanced-datascrubbing/).
+///
+/// The constructor parameter `captureFailedRequests` will override what you
+/// have configured in options.
 /// ```
 class SentryHttpClient extends BaseClient {
   static const defaultFailedRequestStatusCodes = [
@@ -86,6 +89,7 @@ class SentryHttpClient extends BaseClient {
     List<SentryStatusCode> failedRequestStatusCodes =
         defaultFailedRequestStatusCodes,
     List<String> failedRequestTargets = defaultFailedRequestTargets,
+    bool? captureFailedRequests,
   }) {
     _hub = hub ?? HubAdapter();
 
@@ -96,6 +100,7 @@ class SentryHttpClient extends BaseClient {
       failedRequestTargets: failedRequestTargets,
       hub: _hub,
       client: innerClient,
+      captureFailedRequests: captureFailedRequests,
     );
 
     if (_hub.options.isTracingEnabled()) {

dart/test/http_client/failed_request_client_test.dart

@@ -70,12 +70,30 @@ void main() {
       expect(eventCall.contexts.response, isNull);
     });
 
-    test('event not reported if disabled', () async {
+    test('exception does not gets reported if client throws but override disables capture', () async {
+      fixture._hub.options.captureFailedRequests = true;
+      fixture._hub.options.sendDefaultPii = true;
+
       final sut = fixture.getSut(
         client: createThrowingClient(),
         captureFailedRequests: false,
       );
 
+      await expectLater(
+            () async => await sut.get(requestUri, headers: {'Cookie': 'foo=bar'}),
+        throwsException,
+      );
+
+      expect(fixture.transport.calls, 0);
+    });
+
+    test('event not reported if disabled', () async {
+      fixture._hub.options.captureFailedRequests = false;
+
+      final sut = fixture.getSut(
+        client: createThrowingClient(),
+      );
+
       await expectLater(
         () async => await sut.get(requestUri, headers: {'Cookie': 'foo=bar'}),
         throwsException,
@@ -84,10 +102,27 @@ void main() {
       expect(fixture.transport.calls, 0);
     });
 
+    test('event reported if disabled but overridden', () async {
+      fixture._hub.options.captureFailedRequests = false;
+
+      final sut = fixture.getSut(
+        client: createThrowingClient(),
+        captureFailedRequests: true,
+      );
+
+      await expectLater(
+            () async => await sut.get(requestUri, headers: {'Cookie': 'foo=bar'}),
+        throwsException,
+      );
+
+      expect(fixture.transport.calls, 1);
+    });
+
     test('event not reported if not within the targets', () async {
+      fixture._hub.options.captureFailedRequests = true;
+
       final sut = fixture.getSut(
           client: fixture.getClient(statusCode: 500),
-          captureFailedRequests: true,
           failedRequestTargets: const ["myapi.com"]);
 
       final response = await sut.get(requestUri);
@@ -335,16 +370,16 @@ class Fixture {
     List<SentryStatusCode> failedRequestStatusCodes = const [
       SentryStatusCode.defaultRange()
     ],
-    bool captureFailedRequests = true,
     List<String> failedRequestTargets = const [".*"],
+    bool? captureFailedRequests,
   }) {
     final mc = client ?? getClient();
-    _hub.options.captureFailedRequests = captureFailedRequests;
     return FailedRequestClient(
       client: mc,
       hub: _hub,
       failedRequestStatusCodes: failedRequestStatusCodes,
       failedRequestTargets: failedRequestTargets,
+      captureFailedRequests: captureFailedRequests
     );
   }
 

dart/test/http_client/sentry_http_client_test.dart

@@ -32,9 +32,10 @@ void main() {
     });
 
     test('no captured event with default config', () async {
+      fixture.hub.options.captureFailedRequests = false;
+
       final sut = fixture.getSut(
         client: createThrowingClient(),
-        captureFailedRequests: false,
       );
 
       await expectLater(() async => await sut.get(requestUri), throwsException);
@@ -43,6 +44,19 @@ void main() {
       expect(fixture.hub.addBreadcrumbCalls.length, 1);
     });
 
+    test('captured event with override', () async {
+      fixture.hub.options.captureFailedRequests = false;
+
+      final sut = fixture.getSut(
+        client: createThrowingClient(),
+          captureFailedRequests: true,
+      );
+
+      await expectLater(() async => await sut.get(requestUri), throwsException);
+
+      expect(fixture.hub.captureEventCalls.length, 1);
+    });
+
     test('one captured event with when enabling $FailedRequestClient',
         () async {
       fixture.hub.options.captureFailedRequests = true;
@@ -61,6 +75,18 @@ void main() {
       expect(fixture.hub.addBreadcrumbCalls.length, 1);
     });
 
+    test('no captured event with when enabling $FailedRequestClient with override', () async {
+      fixture.hub.options.captureFailedRequests = true;
+      final sut = fixture.getSut(
+        client: createThrowingClient(),
+        captureFailedRequests: false,
+      );
+
+      await expectLater(() async => await sut.get(requestUri), throwsException);
+
+      expect(fixture.hub.captureEventCalls.length, 0);
+    });
+
     test('close does get called for user defined client', () async {
       final mockHub = MockHub();
 
@@ -116,14 +142,14 @@ class Fixture {
   SentryHttpClient getSut({
     MockClient? client,
     List<SentryStatusCode> badStatusCodes = const [],
-    bool captureFailedRequests = true,
+    bool? captureFailedRequests,
   }) {
     final mc = client ?? getClient();
-    hub.options.captureFailedRequests = captureFailedRequests;
     return SentryHttpClient(
       client: mc,
       hub: hub,
       failedRequestStatusCodes: badStatusCodes,
+      captureFailedRequests: captureFailedRequests,
     );
   }