New User Feedback form #4384

stefanosiano · 2025-05-09T14:56:49Z

📜 Description

Continuation of #4286
Add the new User Feedback form (an AlertDialog)
Add all relevant options for customizations and callbacks

Here is the result.

How the form is shown in the example app with light theme and no customization

How the form is shown in the example app with dark theme and no customization

How the form is shown in the example app with (pretty bad) customization

💡 Motivation and Context

Implements first part of #3613

💚 How did you test it?

ui test (UserFeedbackUiTest)

📝 Checklist

I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

Next PR will have the widget (the button that actually show the form)
After that, we'll have screenshots and whatever

Added Scopes.captureFeedback API Changed the MainActivity sample app to use the new API

captureFeedback does not update scope lastEventId anymore

added SentryOptions.beforeSendFeedback implemented SentryClient.captureFeedback

# Conflicts: # CHANGELOG.md # sentry/api/sentry.api # sentry/src/main/java/io/sentry/SentryClient.java

added first draft of SentryUserFeedbackDialog

…idget # Conflicts: # CHANGELOG.md

added feedbackOptions to SentryOptions added callbacks to SentryUserFeedbackDialog

github-actions · 2025-05-09T14:57:10Z

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

sentry/src/main/java/io/sentry/transport/HttpConnection.java
sentry/src/main/java/io/sentry/transport/RateLimiter.java

github-actions · 2025-05-09T14:57:20Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against fbbe36c

github-actions · 2025-05-09T15:06:08Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	398.62 ms	418.44 ms	19.82 ms
Size	1.58 MiB	2.12 MiB	548.70 KiB

Previous results on branch: feat/user-feedback-widget

Startup times

Revision	Plain	With Sentry	Diff
`21335f4`	451.73 ms	476.46 ms	24.73 ms
`c3914aa`	401.70 ms	437.38 ms	35.68 ms
`75996c3`	414.94 ms	454.02 ms	39.08 ms
`9f19891`	402.73 ms	525.00 ms	122.27 ms
`b79d17c`	431.40 ms	488.06 ms	56.66 ms
`799de03`	403.33 ms	460.19 ms	56.86 ms
`1792f53`	430.40 ms	486.48 ms	56.08 ms
`f362a97`	414.44 ms	463.76 ms	49.32 ms
`560a588`	466.82 ms	493.07 ms	26.25 ms
`a6cc553`	414.43 ms	463.46 ms	49.03 ms

App size

Revision	Plain	With Sentry	Diff
`21335f4`	1.58 MiB	2.12 MiB	548.14 KiB
`c3914aa`	1.58 MiB	2.12 MiB	548.00 KiB
`75996c3`	1.58 MiB	2.12 MiB	547.61 KiB
`9f19891`	1.58 MiB	2.09 MiB	515.84 KiB
`b79d17c`	1.58 MiB	2.09 MiB	517.60 KiB
`799de03`	1.58 MiB	2.12 MiB	548.40 KiB
`1792f53`	1.58 MiB	2.12 MiB	547.60 KiB
`f362a97`	1.58 MiB	2.12 MiB	548.01 KiB
`560a588`	1.58 MiB	2.12 MiB	548.00 KiB
`a6cc553`	1.58 MiB	2.12 MiB	548.39 KiB

added feedback message truncation SentryClient doesn't check for backfillable feedbacks anymore

…idget # Conflicts: # CHANGELOG.md

added dialog theme to sample app MainActivity "send user feedback" button now opens feedback dialog instead of sending feedback

# Conflicts: # sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java # sentry/api/sentry.api # sentry/src/main/java/io/sentry/HubAdapter.java # sentry/src/main/java/io/sentry/HubScopesWrapper.java # sentry/src/main/java/io/sentry/IScopes.java # sentry/src/main/java/io/sentry/NoOpHub.java # sentry/src/main/java/io/sentry/NoOpScopes.java # sentry/src/main/java/io/sentry/Scopes.java # sentry/src/main/java/io/sentry/ScopesAdapter.java # sentry/src/main/java/io/sentry/SentryClient.java # sentry/src/main/java/io/sentry/transport/RateLimiter.java

…ings

fixed feedback form behaviour added manifest options

updated changelog

added delegate listener to avoid user overwriting our OnDismissListener for the feedback dialog

# Conflicts: # CHANGELOG.md

…backOptions

# Conflicts: # CHANGELOG.md

markushi

Looks good to me, I left a few comments around the API, let's sort those out before merging. On top of that: Do you know if other SDKs provide default i18n for the widget? Or is it really up the the user to provide their own?

sentry-android-core/src/main/AndroidManifest.xml

sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackDialog.java

sentry-android-core/src/main/res/layout/sentry_dialog_user_feedback.xml

markushi · 2025-05-30T06:41:00Z

sentry-android-core/src/main/res/layout/sentry_dialog_user_feedback.xml

+        android:id="@+id/sentry_dialog_user_feedback_title"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:text="Report a Bug"


You could use "tools:text" instead for some nice preview, as it all will be overwritten anyway right?

stefanosiano · 2025-05-30T09:32:35Z

Do you know if other SDKs provide default i18n for the widget? Or is it really up the the user to provide their own?

nope, all SDKs support english only by default.
Actually, i'm not sure if supporting multiple languages would actually bloat the apk size?

markushi · 2025-06-02T05:44:26Z

Do you know if other SDKs provide default i18n for the widget? Or is it really up the the user to provide their own?

nope, all SDKs support english only by default. Actually, i'm not sure if supporting multiple languages would actually bloat the apk size?

You're right, it would bloat the APK, especially if we support languages the consuming app doesn't. Let's stick to EN then.

added SentryUserFeedbackDialog.Builder, allowing a configuration being passed for the current dialog options added SentryFeedbackOptions copy constructor

markushi

Nice!

sentry-android-core/src/main/res/drawable/edit_text_border.xml

romtsn · 2025-06-16T21:03:58Z

sentry/src/main/java/io/sentry/SentryFeedbackOptions.java

+   *
+   * @param submitButtonLabel the label of the submit button
+   */
+  public void setSubmitButtonLabel(final @NotNull String submitButtonLabel) {


I'm thinking it'd be a nice DevX to have overloads that accept @StringRes int resId like this.

Also this one (and other Strings) should probably be changed to a CharSequence to make it more versatile

ah I see it's in core sentry... still thinking we could expose those just without the annotation and have something like SentryOptions.ResourceProvider which on android would return context.getResources()

That's the reason we added the SentryUserFeedback.Builder, which has the OptionsConfiguration with void configure(final @NotNull Context context, final @NotNull SentryFeedbackOptions options);
I agree on the int overload, though, and if you think it makes sense, i can add it in a followup PR

i will change the options to CharSequence

sentry-android-core/src/main/res/drawable-hdpi/sentry_logo_dark.webp

stefanosiano added 15 commits March 14, 2025 12:42

added Feedback class and extended Contexts with it

62e71ff

Added Sentry.captureFeedback API

c9b4850

Added Scopes.captureFeedback API Changed the MainActivity sample app to use the new API

updated changelog

813ff1d

added tests

dd2d6a8

added scope replay id and screen as url

6428dfa

captureFeedback does not update scope lastEventId anymore

added feedback as DataCategory for rate limit and client report

144bcca

added SentryOptions.beforeSendFeedback implemented SentryClient.captureFeedback

Merge branch 'refs/heads/main' into feat/new-user-feedback-logic

509f992

# Conflicts: # CHANGELOG.md # sentry/api/sentry.api # sentry/src/main/java/io/sentry/SentryClient.java

merged main

3c0a6fb

added tests

9e1066e

Merge branch 'refs/heads/main' into feat/new-user-feedback-logic

eadb567

fixed tests

8feeadc

started adding resources for UF widget

986772d

started SentryFeedbackOptions

e19d122

added first draft of SentryUserFeedbackDialog

Merge branch 'feat/new-user-feedback-logic' into feat/user-feedback-w…

79052ad

…idget # Conflicts: # CHANGELOG.md

added all form options

5a83bb8

added feedbackOptions to SentryOptions added callbacks to SentryUserFeedbackDialog

stefanosiano added 3 commits May 9, 2025 18:10

Merge branch 'main' into feat/new-user-feedback-logic

ee44b18

merged main

212ffbf

added feedback message truncation SentryClient doesn't check for backfillable feedbacks anymore

Merge branch 'feat/new-user-feedback-logic' into feat/user-feedback-w…

2bf99b5

…idget # Conflicts: # CHANGELOG.md

Base automatically changed from feat/new-user-feedback-logic to main May 12, 2025 11:58

stefanosiano added 4 commits May 14, 2025 16:01

user feedback dialog now uses dialogTheme

6eb876c

added dialog theme to sample app MainActivity "send user feedback" button now opens feedback dialog instead of sending feedback

merged main

d47f374

removed java options for send button colors. Replaced with theme sett…

1a758a2

…ings

stefanosiano marked this pull request as ready for review May 14, 2025 16:32

stefanosiano requested review from adinauer, romtsn and markushi as code owners May 14, 2025 16:32

stefanosiano and others added 13 commits May 16, 2025 16:43

added tests and UI tests

9315f7b

fixed feedback form behaviour added manifest options

added comments

62cea5e

updated changelog

added comments

794bd66

updated changelog

added replay capturing on feedback dialog open

f16ac66

added delegate listener to avoid user overwriting our OnDismissListener for the feedback dialog

added cancel button ui test

5388b42

added cancel button ui test

8aacd36

Merge branch 'refs/heads/main' into feat/user-feedback-widget

8750c8d

# Conflicts: # CHANGELOG.md

added Feedback.toString() and default values in javadoc of SentryFeed…

6d14499

…backOptions

merged main

fb88c1f

skipping replay in test when running on gh

b5eb64d

skipping replay in test when running on gh

d0ba126

Merge branch 'main' into feat/user-feedback-widget

202759f

Merge branch 'main' into feat/user-feedback-widget

7bc01eb

# Conflicts: # CHANGELOG.md

markushi reviewed May 30, 2025

View reviewed changes

stefanosiano added 3 commits June 6, 2025 17:14

removed rtl properties and supportsRtl flag

eebaaf3

added SentryUserFeedbackDialog.Builder, allowing a configuration being passed for the current dialog options added SentryFeedbackOptions copy constructor

updated changelog

3fef7c4

Merge branch 'main' into feat/user-feedback-widget

536d522

markushi approved these changes Jun 12, 2025

View reviewed changes

markushi reviewed Jun 12, 2025

View reviewed changes

sentry-android-core/src/main/res/drawable/edit_text_border.xml Outdated Show resolved Hide resolved

stefanosiano added 3 commits June 13, 2025 17:21

renamed edit_text_border.xml to sentry_edit_text_border.xml

994789a

Merge branch 'main' into feat/user-feedback-widget

e6e37b1

updated changelog

fbbe36c

stefanosiano enabled auto-merge (squash) June 13, 2025 15:26

stefanosiano merged commit 4152701 into main Jun 13, 2025
32 of 33 checks passed

stefanosiano deleted the feat/user-feedback-widget branch June 13, 2025 15:40

romtsn reviewed Jun 16, 2025

View reviewed changes

sentry-android-core/src/main/res/drawable-hdpi/sentry_logo_dark.webp Show resolved Hide resolved

Uh oh!

New User Feedback form #4384

New User Feedback form #4384

Uh oh!

Conversation

stefanosiano commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions bot commented May 9, 2025

🚨 Detected changes in high risk code 🚨

Uh oh!

github-actions bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Previous results on branch: feat/user-feedback-widget

Startup times

App size

Uh oh!

markushi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markushi May 30, 2025

Choose a reason for hiding this comment

Uh oh!

stefanosiano commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markushi commented Jun 2, 2025

Uh oh!

markushi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

romtsn Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

romtsn Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

stefanosiano Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

stefanosiano Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stefanosiano commented May 9, 2025 •

edited

Loading

github-actions bot commented May 9, 2025 •

edited

Loading

github-actions bot commented May 9, 2025 •

edited

Loading

stefanosiano commented May 30, 2025 •

edited

Loading