Add screenshotCacheDuration to FlutterOptions

CHANGELOG.md

@@ -74,6 +74,9 @@
   );
   ```
 
+- Add `screenshotCacheDuration` to `FlutterOptions` ([#2387](https://github.com/getsentry/sentry-dart/pull/2387))
+  - Screenshots will be cached for 100ms per default.
+
 ### Enhancements
 
 - Avoid sending too many empty client reports when Http Transport is used ([#2380](https://github.com/getsentry/sentry-dart/pull/2380))

flutter/lib/src/event_processor/screenshot_event_processor.dart

@@ -14,6 +14,9 @@
 class ScreenshotEventProcessor implements EventProcessor {
   final SentryFlutterOptions _options;
 
+  Uint8List? _cachedScreenshotData;
+  DateTime? _lastScreenshotTime;
+
   ScreenshotEventProcessor(this._options);
 
   @override
@@ -77,13 +80,26 @@
       return event;
     }
 
-    final bytes = await createScreenshot();
+    final bytes = await _getOrCreateScreenshot();
     if (bytes != null) {
       hint.screenshot = SentryAttachment.fromScreenshotData(bytes);
     }
     return event;
   }
 
+  Future<Uint8List?> _getOrCreateScreenshot() async {
+    if (_options.screenshotCacheDuration.inMilliseconds > 0 &&
+        _cachedScreenshotData != null &&
+        _lastScreenshotTime != null &&
+        DateTime.now().difference(_lastScreenshotTime!) <
+            _options.screenshotCacheDuration) {
+      return _cachedScreenshotData;
+    }
+    _cachedScreenshotData = await createScreenshot();
+    _lastScreenshotTime = DateTime.now();
+    return _cachedScreenshotData;
+  }
+
   @internal
   Future<Uint8List?> createScreenshot() async {
     try {

flutter/lib/src/sentry_flutter_options.dart

@@ -195,6 +195,10 @@ class SentryFlutterOptions extends SentryOptions {
   /// Only attach a screenshot when the app is resumed.
   bool attachScreenshotOnlyWhenResumed = false;
 
+  /// Screenshots will be cached for 100ms per default. Change this to change
+  /// the duration, or set to zero if you want to disable screenshot caching.
+  Duration screenshotCacheDuration = Duration(milliseconds: 100);
+
   /// Sets a callback which is executed before capturing screenshots. Only
   /// relevant if `attachScreenshot` is set to true. When false is returned
   /// from the function, no screenshot will be attached.