Support allowUrls, denyUrls

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## Unreleased
+
+- Support allowUrls and denyUrls for Flutter Web ([#2227](https://github.com/getsentry/sentry-dart/pull/2227))
+  ```dart
+  await SentryFlutter.init(
+    (options) {
+      options.dsn = 'https://[email protected]/0';
+      options.allowUrls = ["^https://sentry.com.*\$", "my-custom-domain"];
+      options.denyUrls = ["^.*ends-with-this\$", "denied-url"];
+      ...
+    },
+    appRunner: () => runApp(MyApp()),
+  );
+  ```
+
 ## 8.7.0
 
 ### Features

dart/lib/src/event_processor/url_filter/io_url_filter_event_processor.dart

@@ -0,0 +1,10 @@
+import '../../../sentry.dart';
+import 'url_filter_event_processor.dart';
+
+UrlFilterEventProcessor urlFilterEventProcessor(SentryOptions _) =>
+    IoUrlFilterEventProcessor();
+
+class IoUrlFilterEventProcessor implements UrlFilterEventProcessor {
+  @override
+  SentryEvent apply(SentryEvent event, Hint hint) => event;
+}

dart/lib/src/event_processor/url_filter/url_filter_event_processor.dart

@@ -0,0 +1,8 @@
+import '../../../sentry.dart';
+import 'io_url_filter_event_processor.dart'
+    if (dart.library.html) 'web_url_filter_event_processor.dart';
+
+abstract class UrlFilterEventProcessor implements EventProcessor {
+  factory UrlFilterEventProcessor(SentryOptions options) =>
+      urlFilterEventProcessor(options);
+}

dart/lib/src/event_processor/url_filter/web_url_filter_event_processor.dart

@@ -0,0 +1,36 @@
+// We would lose compatibility with old dart versions by adding web to pubspec.
+// ignore: depend_on_referenced_packages
+import 'package:web/web.dart' as web show window, Window;
+
+import '../../../sentry.dart';
+import '../../utils/regex_utils.dart';
+import 'url_filter_event_processor.dart';
+
+UrlFilterEventProcessor urlFilterEventProcessor(SentryOptions options) =>
+    WebUrlFilterEventProcessor(options);
+
+class WebUrlFilterEventProcessor implements UrlFilterEventProcessor {
+  WebUrlFilterEventProcessor(
+    this._options,
+  );
+
+  final web.Window _window = web.window;
+
+  final SentryOptions _options;
+
+  @override
+  SentryEvent? apply(SentryEvent event, Hint hint) {
+    final url = event.request?.url ?? _window.location.toString();
+
+    if (isMatchingRegexPattern(url, _options.allowUrls)) {
+      if (_options.denyUrls.isNotEmpty &&
+          isMatchingRegexPattern(url, _options.denyUrls)) {
+        return null;
+      } else {
+        return event;
+      }
+    } else {
+      return null;
+    }
+  }
+}

dart/lib/src/sentry.dart

@@ -8,6 +8,7 @@ import 'run_zoned_guarded_integration.dart';
 import 'event_processor/enricher/enricher_event_processor.dart';
 import 'environment/environment_variables.dart';
 import 'event_processor/deduplication_event_processor.dart';
+import 'event_processor/url_filter/url_filter_event_processor.dart';
 import 'hint.dart';
 import 'event_processor/exception/exception_event_processor.dart';
 import 'hub.dart';
@@ -86,6 +87,7 @@ class Sentry {
     options.addEventProcessor(EnricherEventProcessor(options));
     options.addEventProcessor(ExceptionEventProcessor(options));
     options.addEventProcessor(DeduplicationEventProcessor(options));
+    options.addEventProcessor(UrlFilterEventProcessor(options));
 
     options.prependExceptionTypeIdentifier(DartExceptionTypeIdentifier());
   }

dart/lib/src/sentry_client.dart

@@ -26,6 +26,7 @@ import 'transport/rate_limiter.dart';
 import 'transport/spotlight_http_transport.dart';
 import 'transport/task_queue.dart';
 import 'utils/isolate_utils.dart';
+import 'utils/regex_utils.dart';
 import 'utils/stacktrace_utils.dart';
 import 'version.dart';
 
@@ -196,7 +197,7 @@ class SentryClient {
     }
 
     var message = event.message!.formatted;
-    return _isMatchingRegexPattern(message, _options.ignoreErrors);
+    return isMatchingRegexPattern(message, _options.ignoreErrors);
   }
 
   SentryEvent _prepareEvent(SentryEvent event, {dynamic stackTrace}) {
@@ -415,7 +416,7 @@ class SentryClient {
     }
 
     var name = transaction.tracer.name;
-    return _isMatchingRegexPattern(name, _options.ignoreTransactions);
+    return isMatchingRegexPattern(name, _options.ignoreTransactions);
   }
 
   /// Reports the [envelope] to Sentry.io.
@@ -593,11 +594,4 @@ class SentryClient {
       SentryId.empty(),
     );
   }
-
-  bool _isMatchingRegexPattern(String value, List<String> regexPattern,
-      {bool caseSensitive = false}) {
-    final combinedRegexPattern = regexPattern.join('|');
-    final regExp = RegExp(combinedRegexPattern, caseSensitive: caseSensitive);
-    return regExp.hasMatch(value);
-  }
 }

dart/lib/src/sentry_options.dart

@@ -184,12 +184,29 @@ class SentryOptions {
   /// sent. Events are picked randomly. Default is null (disabled)
   double? sampleRate;
 
+  /// (Web only) Errors only occurring on these Urls will be handled and sent to sentry.
+  /// If an null or an empty list is used, the SDK will send all errors.
+  /// To use regex add the `^` and the `$` to the string.
+  ///
+  /// If used on a platform other than Web, this setting will be ignored.
+  List<String> allowUrls = [];
+
+  /// (Web only) Errors occurring on these Urls will be ignored and are not sent to sentry.
+  /// If an null or an empty list is used, the SDK will send all errors.
+  /// In combination with `allowUrls` you can block subdomains of the domains listed in allowUrls.
+  /// To use regex add the `^` and the `$` to the string.
+  ///
+  /// If used on a platform other than Web, this setting will be ignored.
+  List<String> denyUrls = [];
+
   /// The ignoreErrors tells the SDK which errors should be not sent to the sentry server.
   /// If an null or an empty list is used, the SDK will send all transactions.
+  /// To use regex add the `^` and the `$` to the string.
   List<String> ignoreErrors = [];
 
   /// The ignoreTransactions tells the SDK which transactions should be not sent to the sentry server.
   /// If null or an empty list is used, the SDK will send all transactions.
+  /// To use regex add the `^` and the `$` to the string.
   List<String> ignoreTransactions = [];
 
   final List<String> _inAppExcludes = [];

dart/lib/src/utils/regex_utils.dart

@@ -0,0 +1,6 @@
+bool isMatchingRegexPattern(String value, List<String> regexPattern,
+    {bool caseSensitive = false}) {
+  final combinedRegexPattern = regexPattern.join('|');
+  final regExp = RegExp(combinedRegexPattern, caseSensitive: caseSensitive);
+  return regExp.hasMatch(value);
+}

dart/test/event_processor/web_url_filter_event_processor_test.dart

@@ -0,0 +1,153 @@
+@TestOn('browser')
+library dart_test;
+
+import 'package:sentry/sentry.dart';
+import 'package:sentry/sentry_io.dart';
+import 'package:sentry/src/event_processor/url_filter/web_url_filter_event_processor.dart';
+import 'package:test/test.dart';
+
+import '../mocks.dart';
+import '../mocks/mock_platform_checker.dart';
+
+// can be tested on command line with
+// `dart test -p chrome test/event_processor/web_url_filter_event_processor_test.dart --name web_url_filter`
+void main() {
+  group('web_url_filter', () {
+    late Fixture fixture;
+
+    setUp(() {
+      fixture = Fixture();
+    });
+
+    test('returns event if no allowUrl and no denyUrl is set', () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'foo.bar',
+        ),
+      );
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNotNull);
+    });
+
+    test('returns null if allowUrl is set and does not match with url', () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'foo.bar',
+        ),
+      );
+      fixture.options.allowUrls = ["another.url"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNull);
+    });
+
+    test('returns event if allowUrl is set and does partially match with url',
+        () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'foo.bar',
+        ),
+      );
+      fixture.options.allowUrls = ["bar"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNotNull);
+    });
+
+    test('returns event if denyUrl is set and does not match with url', () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'foo.bar',
+        ),
+      );
+      fixture.options.denyUrls = ["another.url"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNotNull);
+    });
+
+    test('returns null if denyUrl is set and partially matches with url', () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'foo.bar',
+        ),
+      );
+      fixture.options.denyUrls = ["bar"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNull);
+    });
+
+    test(
+        'returns null if it is part of the allowed domain, but blocked for subdomain',
+        () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'this.is/a/special/url/for-testing/this-feature',
+        ),
+      );
+      fixture.options.allowUrls = ["^this.is/.*\$"];
+      fixture.options.denyUrls = ["special"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNull);
+    });
+
+    test(
+        'returns event if it is part of the allowed domain, and not of the blocked for subdomain',
+        () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'this.is/a/test/url/for-testing/this-feature',
+        ),
+      );
+      fixture.options.allowUrls = ["^this.is/.*\$"];
+      fixture.options.denyUrls = ["special"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNotNull);
+    });
+
+    test(
+        'returns null if it is not part of the allowed domain, and not of the blocked for subdomain',
+        () {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'another.url/for/a/test/testing/this-feature',
+        ),
+      );
+      fixture.options.allowUrls = ["^this.is/.*\$"];
+      fixture.options.denyUrls = ["special"];
+
+      var eventProcessor = fixture.getSut();
+      event = eventProcessor.apply(event, Hint());
+
+      expect(event, isNull);
+    });
+  });
+}
+
+class Fixture {
+  SentryOptions options = SentryOptions(
+    dsn: fakeDsn,
+    checker: MockPlatformChecker(hasNativeIntegration: false),
+  );
+  WebUrlFilterEventProcessor getSut() {
+    return WebUrlFilterEventProcessor(options);
+  }
+}