User Feedback Widget through Prefab

[zoesyc]

Give users an easier way to provide user feedback using prefabs

Sentry has a User Feedback feature that is able to show the feedback collected from a user following an error, or simply initiated by a user (without the need to be connected to an error/event).

• https://docs.sentry.io/product/user-feedback/

The feedback collection allows attaching trace information as well as Session Replay. In addition to other context like tags.
In terms of SDK support, in JS we added a web widget, that's easy to add to the screen:

• https://docs.sentry.io/platforms/javascript/user-feedback/

The goal is to add a similar capability to mobile SDKs.

This SDK already has CaptureFeedback through the .NET SDK:

• Support sending User Feedback without errors/exceptions sentry-dotnet#3981

See:

• https://develop.sentry.dev/application-architecture/feedback-architecture/
• feat: User Feedback widget/form sentry-cocoa#4187

The widget has been added to the iOS SDK with quite a few features already. And is also being added to the other major SDKs:

• [EPIC] Feedback Widget for React Native sentry-react-native#4302
• User Feedback UI widget sentry-cocoa#4270
• Implement new user feedback widget sentry-java#3613
• User Feedback Widget sentry-godot#170
• User Feedback Widget sentry-unreal#893
• Support sending User Feedback without errors/exceptions sentry-dotnet#3981
• https://github.com/getsentry/sentry-dart/blob/7954fb356f96f17127c41230af433bc9ce01233c/flutter/lib/src/feedback/sentry_feedback_widget.dart#L55

Some ideas are new and are not aligned across all SDKs, for example:

• Show user feedback dialog when a screenshot is detected sentry-dart#2541
  But ideally we have a similar behavior/look/feel as much as that makes sense. Things should be idiomatic (e.g: swiping down in the modal removes the feedback widget for example)

• Add to docs: https://docs.sentry.io/product/user-feedback/setup/

[bitsandfoxes]

Implementation

Looking through the JS documentation for inspiration there are a two bigger points

The Widget - A configurable prefab

A prefab with one SentryUserFeedbackMonoBehaviour sitting on the root. The MonoBehaviour reads the feedback widget control options during Awake. The options could be stored on the ScriptableSentryUnityOptions.asset that are saved to /Resource. They could also be their own .asset.

The initially supported workflow for these would be either:

• The .prefab can be instantiated as is, wherever users want to.
• The .prefab can be copied by users, creating variants that can be freely modified.
• Adding an API to SentryUnity.CreateFeedbackWidget that would take a RectTransform and some additional arguments and instantiate the default prefab at the given place in the hierarchy.

Controls what to show

• Show Name
  • Is Name Required
• Show Email
  • Is Email Required
• Capture Screenshot

Controls how to show it

• Form Title
• Submit Button Text
• Cancel Button Text
• Add Screenshot Button Text
• Message Input Field Title
• Message Input Field Placeholder
• Name Input Field Title
• Name Input Field Placeholder
• Email Input Field Title
• Email Input Field Placeholder
• Success Message Text