Replay: Mask RichText Widgets (#2975)

* Mask RichText

* add cl entry

* format

* Fix test

* Fix test

---------

Co-authored-by: Giancarlo Buenaflor <[email protected]>
Co-authored-by: Giancarlo Buenaflor <[email protected]>
Co-authored-by: Giancarlo Buenaflor <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Enhancements
+
+- Replay: Mask RichText Widgets ([#2975](https://github.com/getsentry/sentry-dart/pull/2975))
+
 ## 9.0.0-RC.3
 
 ### Features

flutter/example/lib/main.dart

@@ -201,6 +201,15 @@ class MainScaffold extends StatelessWidget {
       body: SingleChildScrollView(
         child: Column(
           children: [
+            RichText(
+              text: const TextSpan(
+                text: '(I am) Rich Text',
+                style: TextStyle(
+                  color: Colors.black,
+                  fontSize: 16,
+                ),
+              ),
+            ),
             if (_isIntegrationTest) const IntegrationTestWidget(),
             const Center(child: Text('Trigger an action.\n')),
             const Padding(

flutter/lib/src/sentry_privacy_options.dart

@@ -69,6 +69,10 @@ class SentryPrivacyOptions {
         mask: true,
         name: 'EditableText',
       ));
+      rules.add(const SentryMaskingConstantRule<RichText>(
+        mask: true,
+        name: 'RichText',
+      ));
     }
 
     // In Debug mode, check if users explicitly mask (or unmask) widgets that

flutter/test/screenshot/masking_config_test.dart

@@ -168,6 +168,7 @@ void main() async {
         'SentryMaskingCustomRule<Image>(Mask all images except asset images.)',
         'SentryMaskingConstantRule<Text>(mask)',
         'SentryMaskingConstantRule<EditableText>(mask)',
+        'SentryMaskingConstantRule<RichText>(mask)',
         'SentryMaskingCustomRule<Widget>(Debug-mode-only warning for potentially sensitive widgets.)'
       ]);
     });
@@ -205,6 +206,7 @@ void main() async {
         ...alwaysEnabledRules,
         'SentryMaskingConstantRule<Text>(mask)',
         'SentryMaskingConstantRule<EditableText>(mask)',
+        'SentryMaskingConstantRule<RichText>(mask)',
         'SentryMaskingCustomRule<Widget>(Debug-mode-only warning for potentially sensitive widgets.)'
       ]);
     });
@@ -226,6 +228,7 @@ void main() async {
         'SentryMaskingCustomRule<Image>(Mask all images except asset images.)',
         'SentryMaskingConstantRule<Text>(mask)',
         'SentryMaskingConstantRule<EditableText>(mask)',
+        'SentryMaskingConstantRule<RichText>(mask)',
         'SentryMaskingCustomRule<Widget>(Debug-mode-only warning for potentially sensitive widgets.)'
       ];
       test('mask() takes precedence', () {

flutter/test/screenshot/test_widget.dart

@@ -21,17 +21,27 @@ Future<Element> pumpTestElement(WidgetTester tester,
                         padding: EdgeInsets.all(15),
                         child: Center(child: Text('Centered text')),
                       ),
+                      newRichText(),
                       ElevatedButton(
                         onPressed: () {},
                         child: Text('Button title'),
                       ),
                       newCustomImage(),
                       // Invisible widgets won't be obscured.
                       Visibility(visible: false, child: Text('Invisible text')),
+                      Visibility(
+                          visible: false,
+                          child: newRichText(text: 'Invisible Rich Text')),
                       Visibility(visible: false, child: newImage()),
                       Opacity(opacity: 0, child: Text('Invisible text')),
+                      Opacity(
+                          opacity: 0,
+                          child: newRichText(text: 'Invisible Rich Text')),
                       Opacity(opacity: 0, child: newImage()),
                       Offstage(offstage: true, child: Text('Offstage text')),
+                      Offstage(
+                          offstage: true,
+                          child: newRichText(text: 'Offstage Rich Text')),
                       Offstage(offstage: true, child: newImage()),
                       Text(dummyText),
                       Material(child: TextFormField()),
@@ -92,3 +102,10 @@ class CustomImageWidget extends Image {
   CustomImageWidget.memory(super.bytes, {super.key, super.width, super.height})
       : super.memory();
 }
+
+RichText newRichText({String text = 'Rich Text'}) => RichText(
+      text: TextSpan(
+        text: text,
+        style: const TextStyle(color: Colors.black, fontSize: 16),
+      ),
+    );

flutter/test/screenshot/widget_filter_test.dart

@@ -45,7 +45,7 @@ void main() async {
           context: element,
           root: element.renderObject as RenderRepaintBoundary,
           colorScheme: colorScheme);
-      expect(sut.items.length, 6);
+      expect(sut.items.length, 7);
     });
 
     testWidgets('does not redact text when disabled', (tester) async {
@@ -77,7 +77,7 @@ void main() async {
           context: element,
           root: element.renderObject as RenderRepaintBoundary,
           colorScheme: colorScheme);
-      expect(sut.items.length, 6);
+      expect(sut.items.length, 7);
       expect(
           sut.items.map(boundsRect),
           unorderedEquals([
@@ -87,6 +87,7 @@ void main() async {
             '800x24',
             '800x24',
             '50x20',
+            '144x16',
           ]));
     });
   });