Support allowUrls, denyUrls

CHANGELOG.md

@@ -4,6 +4,18 @@
 
 ### Features
 
+- 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()),
+  );
+  ```
 - Add `ignoreRoutes` parameter to `SentryNavigatorObserver`. ([#2218](https://github.com/getsentry/sentry-dart/pull/2218))
     - This will ignore the Routes and prevent the Route from being pushed to the Sentry server.
     - Ignored routes will also create no TTID and TTFD spans.

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

@@ -186,10 +186,12 @@ class SentryOptions {
 
   /// 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,9 @@
+import 'package:meta/meta.dart';
+
+@internal
+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/utils/regex_utils_test.dart

@@ -0,0 +1,24 @@
+import 'package:sentry/src/utils/regex_utils.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('regex_utils', () {
+    final testString = "this is a test";
+
+    test('testString contains string pattern', () {
+      expect(isMatchingRegexPattern(testString, ["is"]), isTrue);
+    });
+
+    test('testString does not contain string pattern', () {
+      expect(isMatchingRegexPattern(testString, ["not"]), isFalse);
+    });
+
+    test('testString contains regex pattern', () {
+      expect(isMatchingRegexPattern(testString, ["^this.*\$"]), isTrue);
+    });
+
+    test('testString does not contain regex pattern', () {
+      expect(isMatchingRegexPattern(testString, ["^is.*\$"]), isFalse);
+    });
+  });
+}

flutter/lib/src/event_processor/url_filter/html_url_filter_event_processor.dart

@@ -0,0 +1,38 @@
+import 'dart:html' as html show window, Window;
+
+import '../../../sentry_flutter.dart';
+import 'url_filter_event_processor.dart';
+// ignore: implementation_imports
+import 'package:sentry/src//utils/regex_utils.dart';
+
+// ignore_for_file: invalid_use_of_internal_member
+
+UrlFilterEventProcessor urlFilterEventProcessor(SentryFlutterOptions options) =>
+    WebUrlFilterEventProcessor(options);
+
+class WebUrlFilterEventProcessor implements UrlFilterEventProcessor {
+  WebUrlFilterEventProcessor(
+    this._options,
+  );
+
+  final html.Window _window = html.window;
+
+  final SentryFlutterOptions _options;
+
+  @override
+  SentryEvent? apply(SentryEvent event, Hint hint) {
+    final url = event.request?.url ?? _window.location.toString();
+
+    if (_options.allowUrls.isNotEmpty &&
+        !isMatchingRegexPattern(url, _options.allowUrls)) {
+      return null;
+    }
+
+    if (_options.denyUrls.isNotEmpty &&
+        isMatchingRegexPattern(url, _options.denyUrls)) {
+      return null;
+    }
+
+    return event;
+  }
+}

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

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

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

@@ -0,0 +1,9 @@
+import '../../../sentry_flutter.dart';
+import 'io_url_filter_event_processor.dart'
+    if (dart.library.html) 'html_url_filter_event_processor.dart'
+    if (dart.library.js_interop) 'web_url_filter_event_processor.dart';
+
+abstract class UrlFilterEventProcessor implements EventProcessor {
+  factory UrlFilterEventProcessor(SentryFlutterOptions options) =>
+      urlFilterEventProcessor(options);
+}

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

@@ -0,0 +1,40 @@
+// 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_flutter.dart';
+import 'url_filter_event_processor.dart';
+// ignore: implementation_imports
+import 'package:sentry/src//utils/regex_utils.dart';
+
+// ignore_for_file: invalid_use_of_internal_member
+
+UrlFilterEventProcessor urlFilterEventProcessor(SentryFlutterOptions options) =>
+    WebUrlFilterEventProcessor(options);
+
+class WebUrlFilterEventProcessor implements UrlFilterEventProcessor {
+  WebUrlFilterEventProcessor(
+    this._options,
+  );
+
+  final web.Window _window = web.window;
+
+  final SentryFlutterOptions _options;
+
+  @override
+  SentryEvent? apply(SentryEvent event, Hint hint) {
+    final url = event.request?.url ?? _window.location.toString();
+
+    if (_options.allowUrls.isNotEmpty &&
+        !isMatchingRegexPattern(url, _options.allowUrls)) {
+      return null;
+    }
+
+    if (_options.denyUrls.isNotEmpty &&
+        isMatchingRegexPattern(url, _options.denyUrls)) {
+      return null;
+    }
+
+    return event;
+  }
+}

flutter/lib/src/sentry_flutter.dart

@@ -9,6 +9,7 @@ import 'event_processor/android_platform_exception_event_processor.dart';
 import 'event_processor/flutter_enricher_event_processor.dart';
 import 'event_processor/flutter_exception_event_processor.dart';
 import 'event_processor/platform_exception_event_processor.dart';
+import 'event_processor/url_filter/url_filter_event_processor.dart';
 import 'event_processor/widget_event_processor.dart';
 import 'file_system_transport.dart';
 import 'flutter_exception_type_identifier.dart';
@@ -131,6 +132,7 @@ mixin SentryFlutter {
 
     options.addEventProcessor(FlutterEnricherEventProcessor(options));
     options.addEventProcessor(WidgetEventProcessor());
+    options.addEventProcessor(UrlFilterEventProcessor(options));
 
     if (options.platformChecker.platform.isAndroid) {
       options.addEventProcessor(

flutter/lib/src/sentry_flutter_options.dart

@@ -143,6 +143,21 @@ class SentryFlutterOptions extends SentryOptions {
   /// See https://api.flutter.dev/flutter/foundation/FlutterErrorDetails/silent.html
   bool reportSilentFlutterErrors = false;
 
+  /// (Web only) Events only occurring on these Urls will be handled and sent to sentry.
+  /// If an empty list is used, the SDK will send all errors.
+  /// `allowUrls` uses regex for the matching.
+  ///
+  /// If used on a platform other than Web, this setting will be ignored.
+  List<String> allowUrls = [];
+
+  /// (Web only) Events occurring on these Urls will be ignored and are not sent to sentry.
+  /// If an empty list is used, the SDK will send all errors.
+  /// `denyUrls` uses regex for the matching.
+  /// In combination with `allowUrls` you can block subdomains of the domains listed in `allowUrls`.
+  ///
+  /// If used on a platform other than Web, this setting will be ignored.
+  List<String> denyUrls = [];
+
   /// Enables Out of Memory Tracking for iOS and macCatalyst.
   /// See the following link for more information and possible restrictions:
   /// https://docs.sentry.io/platforms/apple/guides/ios/configuration/out-of-memory/

flutter/test/event_processor/url_filter/io_filter_event_processor_test.dart

@@ -0,0 +1,39 @@
+@TestOn('vm')
+library flutter_test;
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+import 'package:sentry_flutter/src/event_processor/url_filter/url_filter_event_processor.dart';
+
+void main() {
+  group("ignore allowUrls and denyUrls for non Web", () {
+    late Fixture fixture;
+
+    setUp(() async {
+      fixture = Fixture();
+    });
+
+    test('returns the event and ignore allowUrls and denyUrls for non Web',
+        () async {
+      SentryEvent? event = SentryEvent(
+        request: SentryRequest(
+          url: 'another.url/for/a/special/test/testing/this-feature',
+        ),
+      );
+      fixture.options.allowUrls = ["^this.is/.*\$"];
+      fixture.options.denyUrls = ["special"];
+
+      var eventProcessor = fixture.getSut();
+      event = await eventProcessor.apply(event, Hint());
+
+      expect(event, isNotNull);
+    });
+  });
+}
+
+class Fixture {
+  SentryFlutterOptions options = SentryFlutterOptions();
+  UrlFilterEventProcessor getSut() {
+    return UrlFilterEventProcessor(options);
+  }
+}