SentryFeedbackWidget Improvements (#2964)

* Read default values from options

* Add screenshot from camera roll

* Implmenet „Take Screenshot“ functionality

* move things around

* only read from feedback options

* remove unused import

* revert sentry widget changes

* make final instead of late final

* removeredundant comments

* implement @ueman feedback

* ui customization, logo, tests

* update and fix tests

* set screenshot, fix button shape

* cleanup, changelog

* revert

* cleanup

* move key to button

* move key to button

* replace spacing with sizedbox

* fix logo

* update cl

* Remove iamge picking for now

* remove generated files when running example

* fix comment

* remove feature from cl

* remove addScreenshotButtonLabel

* remove unneccessary call, which is also not available on lower sdk versions

* update cl

* Fix spelling error

* Save and restore form data when taking a screenshot

* fix cl

* Capture replay when feedback widget is opened

* Add integration name when feedback options are accessed

* implement mock stub

* update changelog

* flush replay on manual feedback

* format

* add comment

* introduce internal typecheckhint

* format

* format

---------

Co-authored-by: Giancarlo Buenaflor <giancarlo_buenaflor@yahoo.com>
Co-authored-by: Giancarlo Buenaflor <giancarlobuenaflor97@gmail.com>

Author: denrase

CHANGELOG.md

@@ -7,6 +7,13 @@
 - Add os and device attributes to Flutter logs ([#2978](https://github.com/getsentry/sentry-dart/pull/2978))
 - String templating for structured logs ([#3002](https://github.com/getsentry/sentry-dart/pull/3002))
 - Add user attributes to Dart/Flutter logs ([#3014](https://github.com/getsentry/sentry-dart/pull/3002))
+- SentryFeedbackWidget Improvements ([#2964](https://github.com/getsentry/sentry-dart/pull/2964))
+ - Capture a device screenshot for feedback
+ - Customize tests and required fields
+ - Customization moved from the `SentryFeedbackWidget` constructor to `SentryFlutterOptions`:
+```dart
+options.feedback.showBranding = false;
+```
 
 ### Fixes
 
@@ -59,6 +66,7 @@ void initState() {
 ```
 - Add `message` parameter to `captureException()` ([#2882](https://github.com/getsentry/sentry-dart/pull/2882))
 - Add module in SentryStackFrame ([#2931](https://github.com/getsentry/sentry-dart/pull/2931))
+  - Set `SentryOptions.includeModuleInStackTrace = true` to enable this. This may change grouping of exceptions. 
   - Set `SentryOptions.includeModuleInStackTrace = true` to enable this. This may change grouping of exceptions.
 
 ### Dependencies

dart/lib/src/sentry_attachment/sentry_attachment.dart

@@ -89,9 +89,12 @@ class SentryAttachment {
         );
 
   SentryAttachment.fromScreenshotData(Uint8List bytes)
-      : this.fromUint8List(bytes, 'screenshot.png',
-            contentType: 'image/png',
-            attachmentType: SentryAttachment.typeAttachmentDefault);
+      : this.fromUint8List(
+          bytes,
+          'screenshot.png',
+          contentType: 'image/png',
+          attachmentType: SentryAttachment.typeAttachmentDefault,
+        );
 
   SentryAttachment.fromViewHierarchy(SentryViewHierarchy sentryViewHierarchy)
       : this.fromLoader(

dart/lib/src/type_check_hint.dart

@@ -1,3 +1,4 @@
+import 'package:meta/meta.dart';
 import 'http_client/failed_request_client.dart';
 
 /// Constants used for Type Check hints.
@@ -19,4 +20,7 @@ class TypeCheckHint {
 
   /// Used to indicate that the SDK added a synthetic current stack trace.
   static const currentStackTrace = 'currentStackTrace';
+
+  @internal
+  static const isWidgetFeedback = 'isWidgetFeedback';
 }

flutter/example/lib/main.dart

@@ -513,16 +513,10 @@ class MainScaffold extends StatelessWidget {
             TooltipButton(
               onPressed: () async {
                 final id = await Sentry.captureMessage('UserFeedback');
-                final screenshot = await SentryFlutter.captureScreenshot();
-
                 if (!context.mounted) return;
-                Navigator.push(
+                SentryFeedbackWidget.show(
                   context,
-                  MaterialPageRoute(
-                    builder: (context) => SentryFeedbackWidget(
-                        associatedEventId: id, screenshot: screenshot),
-                    fullscreenDialog: true,
-                  ),
+                  associatedEventId: id,
                 );
               },
               text:

flutter/lib/src/event_processor/replay_event_processor.dart

@@ -12,11 +12,17 @@ class ReplayEventProcessor implements EventProcessor {
 
   @override
   Future<SentryEvent?> apply(SentryEvent event, Hint hint) async {
-    final hasException = event.eventId != SentryId.empty() &&
+    final isErrorEvent = event.eventId != SentryId.empty() &&
         event.exceptions?.isNotEmpty == true;
-    final isFeedback =
+
+    final isFeedbackEvent =
         event.eventId != SentryId.empty() && event.type == 'feedback';
-    final shouldCaptureReplay = hasException || isFeedback;
+    final isWidgetFeedbackEvent =
+        // ignore: invalid_use_of_internal_member
+        hint.get(TypeCheckHint.isWidgetFeedback) == true;
+
+    final shouldCaptureReplay =
+        isErrorEvent || (isFeedbackEvent && !isWidgetFeedbackEvent);
 
     if (shouldCaptureReplay) {
       final isCrash =

flutter/lib/src/feedback/sentry_feedback_options.dart

@@ -0,0 +1,74 @@
+class SentryFeedbackOptions {
+  // Form Configuration
+
+  /// The title of the feedback form.
+  var title = 'Report a Bug';
+
+  /// Requires the name field on the feedback form to be filled in.
+  var isNameRequired = false;
+
+  /// Displays the name field on the feedback form. Ignored if `isNameRequired` is `true`.
+  var showName = true;
+
+  /// Requires the email field on the feedback form to be filled in.
+  var isEmailRequired = false;
+
+  /// Displays the email field on the feedback form. Ignored if `isEmailRequired` is `true`.
+  var showEmail = true;
+
+  /// Sets the `email` and `name` fields to the corresponding Sentry SDK user fields that were called with `SentrySDK.setUser`.
+  var useSentryUser = true;
+
+  /// Displays the Sentry logo inside the form
+  var showBranding = true;
+
+  /// Displays the capture screenshot button on the feedback form
+  var showCaptureScreenshot = true;
+
+  // Form Labels Configuration
+
+  /// The title of the feedback form.
+  String formTitle = 'Report a Bug';
+
+  /// The label of the feedback description input field.
+  String messageLabel = 'Description';
+
+  /// The placeholder in the feedback description input field.
+  String messagePlaceholder = 'What\'s the bug? What did you expect?';
+
+  /// The text to attach to the title label for a required field.
+  String isRequiredLabel = ' (Required)';
+
+  /// The message displayed after a successful feedback submission.
+  String successMessageText = 'Thank you for your report!';
+
+  /// The label next to the name input field.
+  String nameLabel = 'Name';
+
+  /// The placeholder in the name input field.
+  String namePlaceholder = 'Your Name';
+
+  /// The label next to the email input field.
+  String emailLabel = 'Email';
+
+  /// The placeholder in the email input field.
+  String emailPlaceholder = 'your.email@example.org';
+
+  /// The label of the submit button.
+  String submitButtonLabel = 'Send Bug Report';
+
+  /// The label of the cancel button.
+  String cancelButtonLabel = 'Cancel';
+
+  /// The label of the validation error message.
+  String validationErrorLabel = 'Can\'t be empty';
+
+  /// The label of the capture screenshot button.
+  String captureScreenshotButtonLabel = 'Capture a screenshot';
+
+  /// The label of the remove screenshot button.
+  String removeScreenshotButtonLabel = 'Remove screenshot';
+
+  /// The label of the take screenshot button shown outside of the feedback widget.
+  String takeScreenshotButtonLabel = 'Take Screenshot';
+}