feat: BeforeCaptureScreenshot option

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+ - Added a `BeforeCaptureScreenshot` callback to the options: allowing the user to set an action before the screenshot is taken ([#3661](https://github.com/getsentry/sentry-dotnet/pull/3661))
 - Make `Sentry.AspNetCore.Blazor.WebAssembly` generally available. ([#3674](https://github.com/getsentry/sentry-dotnet/pull/3674))
 
 ### Fixes

samples/Sentry.Samples.Maui/MauiProgram.cs

@@ -1,3 +1,5 @@
+using System.Diagnostics;
+
 namespace Sentry.Samples.Maui;
 
 public static class MauiProgram
@@ -22,6 +24,14 @@ public static MauiApp CreateMauiApp()
 
                 options.Debug = true;
                 options.SampleRate = 1.0F;
+
+                options.SetBeforeCapture((@event, hint) =>
+                {
+                    Console.WriteLine("screenshot about to be captured.");
+
+                    // Return true to capture or false to prevent the capture
+                    return true;
+                });
             })
 
             .ConfigureFonts(fonts =>

src/Sentry.Maui/Internal/SentryMauiScreenshotProcessor.cs

@@ -18,6 +18,13 @@ public SentryMauiScreenshotProcessor(SentryMauiOptions options)
 
     public SentryEvent? Process(SentryEvent @event, SentryHint hint)
     {
+        // Call back before taking the screenshot if the callback is not null
+        if (!_options.BeforeCaptureInternal?.Invoke(@event, hint) ?? false)
+        {
+            // We basically bypass the regular process in favour of the one present in the callback
+            return @event;
+        }
+
         hint.Attachments.Add(new ScreenshotAttachment(_options));
         return @event;
     }

src/Sentry.Maui/SentryMauiOptions.cs

@@ -1,4 +1,6 @@
+using Microsoft.Extensions.Logging;
 using Sentry.Extensions.Logging;
+using Sentry.Maui.Internal;
 
 namespace Sentry.Maui;
 
@@ -65,4 +67,30 @@ public SentryMauiOptions()
     /// Screenshots can be removed from some specific events during BeforeSend through the Hint.
     /// </remarks>
     public bool AttachScreenshot { get; set; }
+
+    private Func<SentryEvent, SentryHint, bool>? _beforeCapture;
+    /// <summary>
+    /// Action performed before attaching a screenshot
+    /// </summary>
+    internal Func<SentryEvent, SentryHint, bool>? BeforeCaptureInternal => _beforeCapture;
+
+    /// <summary>
+    /// Configures a callback function to be invoked before taking a screenshot
+    /// </summary>
+    /// <remarks>
+    /// if this callback return false the capture will not take place
+    /// </remarks>
+    /// <code>
+    /// 
+    ///options.SetBeforeCapture((@event, hint) =>
+    ///{
+    ///    // Return true to capture or false to prevent the capture
+    ///    return true;
+    ///});
+    /// </code>
+    /// <param name="beforeCapture">Callback to be executed before taking a screenshot</param>
+    public void SetBeforeCapture(Func<SentryEvent, SentryHint, bool> beforeCapture)
+    {
+        _beforeCapture = beforeCapture;
+    }
 }

test/Sentry.Maui.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -13,6 +13,7 @@ namespace Sentry.Maui
     {
         public SentryMauiOptions() { }
         public bool AttachScreenshot { get; set; }
+        public System.Action BeforeCaptureScreenshot { get; set; }
         public bool CreateElementEventsBreadcrumbs { get; set; }
         public bool IncludeBackgroundingStateInBreadcrumbs { get; set; }
         public bool IncludeTextInBreadcrumbs { get; set; }

test/Sentry.Maui.Tests/SentryMauiOptionsTests.cs

@@ -1,3 +1,5 @@
+using NSubstitute.Exceptions;
+
 namespace Sentry.Maui.Tests;
 
 public class SentryMauiOptionsTests
@@ -56,4 +58,40 @@ public void AttachScreenshots_Default()
         var options = new SentryMauiOptions();
         Assert.False(options.AttachScreenshot);
     }
+
+    [Fact]
+    public void BeforeCaptureScreenshot_Default()
+    {
+        // Arrange
+        var options = new SentryMauiOptions();
+        options.AttachScreenshot = true;
+
+        // Act
+        options.SetBeforeCapture((@event, hint) =>
+        {
+            return true;
+        });
+
+        // Assert
+        Assert.NotNull(options.BeforeCaptureInternal);
+
+    }
+
+    [Fact]
+    public void BeforeCaptureScreenshot_Skip_Screenshot()
+    {
+        // Arrange
+        var options = new SentryMauiOptions();
+        options.AttachScreenshot = true;
+
+        // Act
+        options.SetBeforeCapture((@event, hint) =>
+        {
+            return false;
+        });
+
+        // Assert
+        Assert.NotNull(options.BeforeCaptureInternal);
+
+    }
 }