Skip to content

feat(feedback): implement shake gesture detection#5150

Open
antonis wants to merge 34 commits intomainfrom
antonis/feedback-shake
Open

feat(feedback): implement shake gesture detection#5150
antonis wants to merge 34 commits intomainfrom
antonis/feedback-shake

Conversation

@antonis
Copy link
Contributor

@antonis antonis commented Mar 3, 2026 •
edited
Loading

📜 Description

Implements shake gesture detection for the user feedback form. When useShakeGesture is enabled in SentryFeedbackOptions, shaking the device opens the feedback form.

The implementation uses the device's accelerometer (via SensorManager) with a 2.7G threshold and 1-second cooldown. A new ShakeDetectionIntegration registers lifecycle callbacks to start/stop the detector when the activity resumes/pauses.

Note: this is exposed to be used on React Native too getsentry/sentry-react-native#5754

💡 Motivation and Context

The useShakeGesture property already existed in SentryFeedbackOptions but was never wired up. This PR implements the feature. The implementation is placed here (sentry-java) rather than in each SDK separately so it can be reused by all SDKs that embed the feedback UI (React Native, Flutter, .NET MAUI, Unity).

No special permissions are required — TYPE_ACCELEROMETER is not a protected sensor. Only BODY_SENSORS requires a permission.

💚 How did you test it?

  • Tested in a sample Android app (see 0cb8d00) — shaking the device opens the feedback form
  • Unit tests added for SentryShakeDetector and ShakeDetectionIntegration

📝 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. docs(android): Add shake-to-report feedback documentation sentry-docs#16792
  • 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

sentry-react-native will remove its own RNSentryShakeDetector and delegate to this class instead.

@antonis @claude
feat(feedback): implement shake gesture detection for user feedback form
c04bebe 
Adds SentryShakeDetector (accelerometer-based) and ShakeDetectionIntegration
that shows the feedback dialog when a shake is detected. Controlled by
SentryFeedbackOptions.useShakeGesture (default false).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis antonis mentioned this pull request Mar 3, 2026
Draft
7 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026 •
edited
Loading

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

New Features ✨

  • (feedback) Implement shake gesture detection by antonis in #5150

Internal Changes 🔧

Deps

  • Update Native SDK to v0.13.2 by github-actions in #5181
  • Bump github/codeql-action from 4.32.4 to 4.32.6 by dependabot in #5170
  • Bump dorny/paths-filter from 3.0.2 to 4.0.1 by dependabot in #5195
  • Bump actions/create-github-app-token from 2.2.1 to 3.0.0 by dependabot in #5196
  • Bump getsentry/craft from 2.23.1 to 2.24.1 by dependabot in #5197
  • Bump reactivecircus/android-emulator-runner from 2.35.0 to 2.37.0 by dependabot in #5194

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026 •
edited
Loading

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

Generated by 🚫 dangerJS against 8197f93

@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026 •
edited
Loading

Performance metrics 🚀

  Plain With Sentry Diff
Startup time 307.28 ms 359.06 ms 51.78 ms
Size 0 B 0 B 0 B

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
f064536 327.04 ms 405.35 ms 78.31 ms
cf708bd 408.35 ms 458.98 ms 50.63 ms
d15471f 294.13 ms 399.49 ms 105.36 ms
9fbb112 361.43 ms 427.57 ms 66.14 ms
2387c2c 317.04 ms 354.60 ms 37.56 ms
806307f 357.85 ms 424.64 ms 66.79 ms
b193867 331.08 ms 397.06 ms 65.98 ms
dc4cc7a 361.10 ms 439.53 ms 78.43 ms
694d587 379.62 ms 400.80 ms 21.18 ms
17a0955 372.53 ms 446.70 ms 74.17 ms

App size

Revision Plain With Sentry Diff
f064536 1.58 MiB 2.20 MiB 633.90 KiB
cf708bd 1.58 MiB 2.11 MiB 539.71 KiB
d15471f 1.58 MiB 2.13 MiB 559.54 KiB
9fbb112 1.58 MiB 2.11 MiB 539.18 KiB
2387c2c 1.58 MiB 2.13 MiB 559.54 KiB
806307f 1.58 MiB 2.10 MiB 533.42 KiB
b193867 1.58 MiB 2.19 MiB 620.00 KiB
dc4cc7a 1.58 MiB 2.19 MiB 619.28 KiB
694d587 1.58 MiB 2.19 MiB 620.06 KiB
17a0955 1.58 MiB 2.10 MiB 533.20 KiB

Previous results on branch: antonis/feedback-shake

Startup times

Revision Plain With Sentry Diff
395b61e 318.16 ms 373.86 ms 55.70 ms
2052d5f 331.52 ms 401.71 ms 70.19 ms
ba57364 317.45 ms 360.35 ms 42.90 ms
3a14925 327.15 ms 380.52 ms 53.37 ms
90c01e9 314.38 ms 370.51 ms 56.13 ms
a1a1e57 323.92 ms 367.22 ms 43.31 ms
58a9026 330.31 ms 370.45 ms 40.13 ms
090d0b1 331.70 ms 407.46 ms 75.75 ms
d743634 404.69 ms 507.35 ms 102.66 ms

App size

Revision Plain With Sentry Diff
395b61e 1.58 MiB 2.29 MiB 727.32 KiB
2052d5f 1.58 MiB 2.29 MiB 726.85 KiB
ba57364 1.58 MiB 2.29 MiB 727.15 KiB
3a14925 1.58 MiB 2.29 MiB 727.39 KiB
90c01e9 1.58 MiB 2.29 MiB 727.37 KiB
a1a1e57 1.58 MiB 2.29 MiB 727.28 KiB
58a9026 1.58 MiB 2.29 MiB 727.33 KiB
090d0b1 0 B 0 B 0 B
d743634 0 B 0 B 0 B

antonis and others added 2 commits March 4, 2026 13:08
@antonis @claude
fix(feedback): improve shake detection robustness and add tests
177bb48 
- Add volatile/AtomicLong for thread-safe cross-thread field access
- Use SystemClock.elapsedRealtime() instead of System.currentTimeMillis()
- Use SENSOR_DELAY_NORMAL for better battery efficiency
- Add multi-shake counting (2+ threshold crossings within 1.5s window)
- Handle deferred init for already-resumed activities
- Wrap showDialog() in try-catch to prevent app crashes
- Improve activity transition handling in onActivityPaused
- Mark SentryShakeDetector as @ApiStatus.Internal
- Add unit tests for SentryShakeDetector and ShakeDetectionIntegration

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis
Merge branch 'main' into antonis/feedback-shake
d13da1b
@antonis antonis marked this pull request as ready for review March 4, 2026 13:12
@antonis antonis requested a review from alwx March 4, 2026 13:14
@antonis @claude
fix(feedback): prevent stacking multiple feedback dialogs on repeated…
0cc2f3b 
… shakes

Track dialog visibility with an isDialogShowing flag that is set before
showing and cleared via the onFormClose callback when the dialog is
dismissed. Double-checked on both sensor and UI threads to avoid races.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis @claude
fix(feedback): restore original onFormClose to prevent callback chain…
83eed6d 
… growth

Save the user's original onFormClose once during register() and restore
it after each dialog dismiss, instead of wrapping it with a new lambda
each time.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis @claude
fix(feedback): reset isDialogShowing on activity pause to prevent stu…
dbbd37e 
…ck flag

If showDialog silently fails (e.g. activity destroyed between post and
execution), isDialogShowing would stay true forever, permanently
disabling shake-to-feedback. Reset it in onActivityPaused since the
dialog cannot outlive its host activity.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis @claude
fix(feedback): move isDialogShowing reset from onActivityPaused to on…
527abb7 
…ActivityDestroyed

AlertDialog survives pause/resume cycles (e.g. screen off/on), so
resetting isDialogShowing in onActivityPaused allowed duplicate dialogs.
Move the reset to onActivityDestroyed where the dialog truly cannot
survive.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis @claude
fix(feedback): scope dialog flag to hosting activity and restore call…
0b090bc 
…back on error

- Only reset isDialogShowing in onActivityDestroyed when it's the
  activity that hosts the dialog, not any unrelated activity.
- Restore originalOnFormClose in the catch block when showDialog throws.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@antonis @lucas-zimerman
Optimise comparison
d77d60d 
Co-authored-by: LucasZF <lucas-zimerman1@hotmail.com>
antonis and others added 2 commits March 9, 2026 16:09
@antonis @claude
fix(feedback): pass real logger to SentryShakeDetector on init
69ee931 
The detector was constructed with NoOpLogger and the logger field was
final, so all diagnostic messages (sensor unavailable warnings) were
silently swallowed. Now init(context, logger) updates the logger from
SentryOptions.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@getsentry-bot
Format code
7ba0447
@sentry
Copy link

sentry bot commented Mar 9, 2026

Sentry Build Distribution

App Version Configuration
SDK Size 8.34.1 (1) release

@antonis
Copy link
Contributor Author

antonis commented Mar 9, 2026

I think there's a couple of fundamental changes we need to make here so not approving yet, but looks great otherwise!

Thank you for the feedback @romtsn 🙇

Btw, would be great if we can also add the new option to ManifestMetadataReader and update the sentry-docs PR and the changelog entry to mention it as well

Good idea 👍 Added with 65122ca
Also updated the doc with getsentry/sentry-docs@02d081a

@sentry
Copy link

sentry bot commented Mar 9, 2026

Sentry Build Distribution

App Version Configuration
SDK Size 8.34.1 (1) release

@antonis antonis marked this pull request as ready for review March 9, 2026 15:15
@antonis @claude
fix(feedback): clear stale activity ref and reset shake state on stop
a734533 
- Clear currentActivity in onActivityDestroyed to prevent holding a
  stale reference to a destroyed activity context
- Reset shakeCount and firstShakeTimestamp in stop() to prevent
  cross-session false triggers across pause/resume cycles

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sentry
Copy link

sentry bot commented Mar 9, 2026

Sentry Build Distribution

App Version Configuration
SDK Size 8.34.1 (1) release

cursor[bot]
cursor bot reviewed Mar 9, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

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

@antonis @claude
fix(feedback): clean up dialog state when a different activity resumes
8b9bab2 
When a dialog is showing on Activity A and the user navigates to
Activity B (e.g. via notification), onActivityResumed(B) overwrites
currentActivity. Later onActivityDestroyed(A) can't match and cleanup
never runs, leaving isDialogShowing permanently stuck. Now we detect
this in onActivityResumed and clean up proactively.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sentry
Copy link

sentry bot commented Mar 9, 2026

Sentry Build Distribution

App Version Configuration
SDK Size 8.34.1 (1) release

cursor[bot]
cursor bot reviewed Mar 9, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

@antonis @claude
fix(feedback): capture onFormClose as local variable in lambda
301cc33 
The onFormClose lambda was reading previousOnFormClose field at dismiss
time. If onActivityResumed or onActivityDestroyed already restored and
nulled the field, the lambda would overwrite onFormClose with null. Now
captured as a local variable at dialog creation time.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@sentry
Copy link

sentry bot commented Mar 9, 2026

Sentry Build Distribution

App Version Configuration
SDK Size 8.34.1 (1) release

cursor[bot]
cursor bot reviewed Mar 9, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

@antonis @claude
fix(feedback): restore onFormClose in close() when dialog is showing
1eb6c23 
When close() is called while a dialog is showing, lifecycle callbacks
are unregistered so onActivityDestroyed cleanup won't fire. Restore
previousOnFormClose and reset dialog state in close() to prevent
the callback from being permanently overwritten.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
cursor[bot]
cursor bot reviewed Mar 9, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

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

@sentry
Copy link

sentry bot commented Mar 9, 2026

Sentry Build Distribution

App Version Configuration
SDK Size 8.34.1 (1) release

@antonis antonis requested a review from romtsn March 9, 2026 16:41
cursor[bot]
cursor bot reviewed Mar 12, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

cursor[bot]
cursor bot reviewed Mar 16, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

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

antonis and others added 2 commits March 16, 2026 14:39
@antonis @claude
fix(feedback): check isFinishing/isDestroyed before showing dialog
8197f93 
Add proactive activity validity check inside the runOnUiThread lambda
to avoid hitting the catch block with a BadTokenException when the
activity becomes invalid between the shake callback and UI execution.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@getsentry-bot
Format code
fedd3a2
cursor[bot]
cursor bot reviewed Mar 16, 2026
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sentry sentry[bot] sentry[bot] left review comments

@cursor cursor[bot] cursor[bot] left review comments

@adinauer adinauer Awaiting requested review from adinauer adinauer is a code owner

@markushi markushi Awaiting requested review from markushi markushi is a code owner

@lcian lcian Awaiting requested review from lcian

@alwx alwx Awaiting requested review from alwx

@lucas-zimerman lucas-zimerman Awaiting requested review from lucas-zimerman

@romtsn romtsn Awaiting requested review from romtsn romtsn is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@antonis @romtsn @lucas-zimerman @getsentry-bot