feat(feedback): Support runtime enable/disable of shake-to-report by markushi · Pull Request #5827 · getsentry/sentry-java

markushi · 2026-07-23T16:12:24Z

📜 Description

Adds a runtime API to toggle shake-to-report after Sentry.init():

Sentry.feedback().enableFeedbackOnShake()
Sentry.feedback().disableFeedbackOnShake()

SentryFeedbackOptions.isUseShakeGesture() now only determines the initial state; the runtime API overrides it afterwards. Propagation works similar to IFormHandler / ReplayController by introducing a new SentryFeedbackOptions.IShakeController.

This also required a bit of re-wiring on-demand Dialogs vs. the automatic ones, so no duplicate Dialogs are shown and no duplicate detectors run at the same time. The dialogs now report back to the IShakeController, which now is the only component which takes care of starting/stopping shake detection.

💡 Motivation and Context

Having a runtime option to enable / disable the feedback.
Closes #5486 (JAVA-539)

💚 How did you test it?

Unit tests + Manual Tests.

📝 Checklist

I added GH Issue ID & Linear ID
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

Docs update for the new runtime API (docs repo)
Possible follow-up: route per-form shake detection through FeedbackShakeIntegration so there's a single detector/arbitration point

github-actions · 2026-07-23T16:14:34Z

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

Generated by 🚫 dangerJS against ac4292c

sentry · 2026-07-23T16:17:04Z

📲 Install Builds

Android

🔗 App Name	App ID	Version	Configuration
SDK Size	io.sentry.tests.size	8.50.0 (1)	release

⚙️ sentry-android Build Distribution Settings

github-actions · 2026-07-23T16:24:20Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	330.76 ms	381.63 ms	50.88 ms
Size	0 B	0 B	0 B

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`22f4345`	325.23 ms	454.66 ms	129.43 ms
`22f4345`	312.78 ms	347.40 ms	34.62 ms
`8558cac`	306.16 ms	355.24 ms	49.09 ms
`bb0ff41`	317.76 ms	384.66 ms	66.90 ms
`7c1a728`	289.46 ms	368.15 ms	78.69 ms
`d501a7e`	314.55 ms	343.34 ms	28.79 ms
`4fc476b`	280.63 ms	363.04 ms	82.42 ms
`6727e14`	337.22 ms	373.94 ms	36.71 ms
`ae7fed0`	293.84 ms	380.22 ms	86.38 ms
`ee747ae`	400.46 ms	423.61 ms	23.15 ms

App size

Revision	Plain	With Sentry	Diff
`22f4345`	1.58 MiB	2.29 MiB	719.83 KiB
`22f4345`	1.58 MiB	2.29 MiB	719.83 KiB
`8558cac`	0 B	0 B	0 B
`bb0ff41`	0 B	0 B	0 B
`7c1a728`	0 B	0 B	0 B
`d501a7e`	0 B	0 B	0 B
`4fc476b`	0 B	0 B	0 B
`6727e14`	1.58 MiB	2.28 MiB	718.64 KiB
`ae7fed0`	1.58 MiB	2.12 MiB	551.77 KiB
`ee747ae`	1.58 MiB	2.10 MiB	530.95 KiB

Previous results on branch: feat/runtime-enable-disable-shake-to-report

Startup times

Revision	Plain	With Sentry	Diff
`8594d29`	355.30 ms	449.74 ms	94.44 ms

App size

Revision	Plain	With Sentry	Diff
`8594d29`	0 B	0 B	0 B

…r.setDialog to prevent overlapping feedback dialogs

…e-to-report' into feat/runtime-enable-disable-shake-to-report

cursor

Cursor Bugbot has reviewed your changes and found 3 potential issues.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit ac4292c. Configure here.}

cursor · 2026-07-23T20:06:27Z

+      startDetecting(options);
+    } else {
+      dialogRequestedShakeDetection = false;
+    }


Opt-in flag cleared on re-track

Medium Severity

setDialog with startShakeDetection=false always sets dialogRequestedShakeDetection to false, so an opted-in dialog that later calls setDialog(this, false) from onStart loses its keep-alive flag. A subsequent disable() then stops detection even though that dialog is still tracked, which contradicts the controller contract and the intended re-show behavior.

Additional Locations (1)

sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackForm.java#L241-L243

^{Reviewed by Cursor Bugbot for commit ac4292c. Configure here.}

cursor · 2026-07-23T20:06:27Z

+      }
+      return;
+    }
+    dialogRef = new WeakReference<>(dialog);


Opted-in dialog only weakly held

High Severity

Per-form opt-in stores the dialog in a WeakReference, unlike the previous lifecycle-callback approach that kept the form alive. A create() call that does not retain the instance can be collected immediately, so a later shake finds no dialog and does nothing, while detection may keep running because nothing clears it when the weak ref goes null.

Additional Locations (1)

sentry-android-core/src/main/java/io/sentry/android/core/FeedbackShakeIntegration.java#L44-L45

^{Reviewed by Cursor Bugbot for commit ac4292c. Configure here.}

cursor · 2026-07-23T20:06:27Z

+    if (!resolvedFeedbackOptions.isUseShakeGesture()
+        || globalFeedbackOptions.isUseShakeGesture()
+        || globalFeedbackOptions.getShakeController().isEnabled()) {
+      return;


Stale option blocks per-form opt-in

Medium Severity

maybeEnableShakeToShow still bails out when globalFeedbackOptions.isUseShakeGesture() is true, even though that flag is only the initial state and is not cleared by disableFeedbackOnShake(). After a runtime disable following an initially enabled option, a per-form isUseShakeGesture opt-in never calls setDialog, so shake-to-show for that form never starts.

^{Reviewed by Cursor Bugbot for commit ac4292c. Configure here.}

sentry · 2026-07-23T20:07:54Z

+      dialogRequestedShakeDetection = true;
+      startDetecting(options);
+    } else {
+      dialogRequestedShakeDetection = false;


Bug: Calling setDialog(..., false) unconditionally resets dialogRequestedShakeDetection to false, causing shake detection to be stopped prematurely when disable() is called.
_{Severity: MEDIUM}

Suggested Fix

Modify the setDialog method. When startShakeDetection is false, do not change the value of dialogRequestedShakeDetection. The flag should only be reset to false when the dialog is cleared (i.e., dialog == null).

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: sentry-android-core/src/main/java/io/sentry/android/core/FeedbackShakeIntegration.java#L120 Potential issue: The `setDialog` method unconditionally sets `dialogRequestedShakeDetection` to `false` when its `startShakeDetection` parameter is `false`. This creates a bug in a specific scenario: 1. A form enables per-dialog shake detection by calling `setDialog(this, true)`. 2. The form's `onStart()` lifecycle method then calls `setDialog(this, false)` to track its visibility. This incorrectly resets the `dialogRequestedShakeDetection` flag. 3. If the global shake integration is then disabled via `disable()`, it will check the flag, find it `false`, and prematurely call `stopDetecting()`, disabling shake detection for the form that intended to keep it active.

Also affects:

sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackForm.java:242~242

markushi added 3 commits July 23, 2026 18:06

feat(feedback): Support runtime enable/disable of shake-to-report

849f6b8

changelog

876b66d

Merge branch 'main' into feat/runtime-enable-disable-shake-to-report

340f35b

markushi marked this pull request as ready for review July 23, 2026 16:14

markushi requested review from 0xadam-brown, adinauer, romtsn and runningcode as code owners July 23, 2026 16:14

cursor Bot reviewed Jul 23, 2026

View reviewed changes

Comment thread sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackForm.java

Comment thread sentry-android-core/src/main/java/io/sentry/android/core/FeedbackShakeIntegration.java Outdated

sentry Bot reviewed Jul 23, 2026

View reviewed changes

Comment thread sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackForm.java

markushi added 2 commits July 23, 2026 22:03

Unify shake detection in FeedbackShakeIntegration via IShakeControlle…

6176c1d

…r.setDialog to prevent overlapping feedback dialogs

Merge remote-tracking branch 'origin/feat/runtime-enable-disable-shak…

ac4292c

…e-to-report' into feat/runtime-enable-disable-shake-to-report

cursor Bot reviewed Jul 23, 2026

View reviewed changes

sentry Bot reviewed Jul 23, 2026

View reviewed changes

Uh oh!

Uh oh!

Conversation

markushi commented Jul 23, 2026 • 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 Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sentry Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📲 Install Builds

Android

Uh oh!

Uh oh!

github-actions Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/runtime-enable-disable-shake-to-report

Startup times

App size

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot Jul 23, 2026

Choose a reason for hiding this comment

Opt-in flag cleared on re-track

Uh oh!

cursor Bot Jul 23, 2026

Choose a reason for hiding this comment

Opted-in dialog only weakly held

Uh oh!

cursor Bot Jul 23, 2026

Choose a reason for hiding this comment

Stale option blocks per-form opt-in

Uh oh!

sentry Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

markushi commented Jul 23, 2026 •

edited

Loading

github-actions Bot commented Jul 23, 2026 •

edited

Loading

sentry Bot commented Jul 23, 2026 •

edited

Loading

github-actions Bot commented Jul 23, 2026 •

edited

Loading