feat: capture touch breadcrumbs for all buttons #2242

vaind · 2024-08-21T10:33:34Z

📜 Description

cleanup & refactoring in the first few commits (can be filtered out while reviewing)
change the behaviour to capture all button presses, regardless of key being present
add touch path, similar to RN

💡 Motivation and Context

While working on replay, I've noticed touch is not normally captured as a breadcrumb unless user specifies keys for buttons.

💚 How did you test it?

Existing tests and new ones
manually in the example app: https://sentry-sdks.sentry.io/issues/4722238716/events/1503b86bd4754c649520d38f74a1158d/

📝 Checklist

I reviewed submitted code
I added tests to verify changes
No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
I updated the docs if needed
All tests passing
No breaking changes

🔮 Next steps

github-actions · 2024-08-21T10:34:00Z

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

Generated by 🚫 dangerJS against b58b91d

codecov · 2024-08-21T10:35:12Z

Codecov Report

Attention: Patch coverage is 92.20779% with 6 lines in your changes missing coverage. Please review.

Project coverage is 88.17%. Comparing base (77db8d4) to head (b58b91d).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...er_interaction/sentry_user_interaction_widget.dart	91.66%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2242      +/-   ##
==========================================
+ Coverage   88.14%   88.17%   +0.03%     
==========================================
  Files         245      245              
  Lines        8442     8455      +13     
==========================================
+ Hits         7441     7455      +14     
+ Misses       1001     1000       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-08-21T11:31:52Z

Android Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	477.64 ms	539.96 ms	62.32 ms
Size	6.49 MiB	7.55 MiB	1.06 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`a094100`	388.02 ms	459.50 ms	71.48 ms
`4829ad3`	381.55 ms	455.45 ms	73.90 ms
`8a7f528`	290.27 ms	341.80 ms	51.53 ms
`5f443de`	412.30 ms	491.67 ms	79.37 ms
`fdac48a`	329.50 ms	396.46 ms	66.96 ms
`90db9ff`	334.86 ms	388.14 ms	53.28 ms
`559d28f`	302.35 ms	339.53 ms	37.18 ms
`48adddf`	353.96 ms	431.10 ms	77.14 ms
`afa6e2a`	349.73 ms	428.48 ms	78.75 ms
`cc80714`	333.26 ms	388.80 ms	55.54 ms

App size

Revision	Plain	With Sentry	Diff
`a094100`	5.94 MiB	6.96 MiB	1.02 MiB
`4829ad3`	6.33 MiB	7.26 MiB	943.11 KiB
`8a7f528`	6.06 MiB	7.03 MiB	989.36 KiB
`5f443de`	6.35 MiB	7.34 MiB	1008.00 KiB
`fdac48a`	6.06 MiB	7.09 MiB	1.03 MiB
`90db9ff`	6.06 MiB	7.10 MiB	1.04 MiB
`559d28f`	5.94 MiB	6.92 MiB	1001.70 KiB
`48adddf`	6.27 MiB	7.20 MiB	959.09 KiB
`afa6e2a`	6.27 MiB	7.20 MiB	955.69 KiB
`cc80714`	6.34 MiB	7.28 MiB	966.31 KiB

Previous results on branch: feat/capture-touch-breadcrumbs

Startup times

Revision	Plain	With Sentry	Diff
`ce4719d`	450.70 ms	500.15 ms	49.44 ms
`dd15eaa`	444.78 ms	483.85 ms	39.08 ms
`7563246`	413.55 ms	464.88 ms	51.33 ms
`ed4cab2`	433.65 ms	451.38 ms	17.73 ms
`c6a4625`	467.54 ms	526.67 ms	59.13 ms

App size

Revision	Plain	With Sentry	Diff
`ce4719d`	6.52 MiB	7.61 MiB	1.09 MiB
`dd15eaa`	6.52 MiB	7.59 MiB	1.06 MiB
`7563246`	6.52 MiB	7.61 MiB	1.09 MiB
`ed4cab2`	6.52 MiB	7.61 MiB	1.09 MiB
`c6a4625`	6.52 MiB	7.59 MiB	1.06 MiB

github-actions · 2024-08-21T11:37:03Z

iOS Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1219.46 ms	1244.55 ms	25.09 ms
Size	8.38 MiB	9.73 MiB	1.35 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`a5031f1`	1244.14 ms	1268.79 ms	24.64 ms
`1a93825`	1257.25 ms	1261.55 ms	4.30 ms
`c70e01a`	1273.00 ms	1299.12 ms	26.12 ms
`e8603bb`	1240.85 ms	1254.79 ms	13.94 ms
`c978477`	1228.43 ms	1249.17 ms	20.74 ms
`c328ffc`	1236.73 ms	1260.73 ms	24.00 ms
`bffc2c5`	1239.76 ms	1264.67 ms	24.92 ms
`89ea268`	1252.33 ms	1253.58 ms	1.26 ms
`6e083bb`	1244.33 ms	1264.60 ms	20.26 ms
`d0476e1`	1259.45 ms	1280.31 ms	20.86 ms

App size

Revision	Plain	With Sentry	Diff
`a5031f1`	8.32 MiB	9.50 MiB	1.18 MiB
`1a93825`	8.28 MiB	9.34 MiB	1.05 MiB
`c70e01a`	8.16 MiB	9.17 MiB	1.01 MiB
`e8603bb`	8.33 MiB	9.40 MiB	1.07 MiB
`c978477`	8.32 MiB	9.50 MiB	1.18 MiB
`c328ffc`	8.34 MiB	9.67 MiB	1.33 MiB
`bffc2c5`	8.33 MiB	9.40 MiB	1.07 MiB
`89ea268`	8.09 MiB	9.16 MiB	1.06 MiB
`6e083bb`	8.16 MiB	9.17 MiB	1.01 MiB
`d0476e1`	8.33 MiB	9.64 MiB	1.31 MiB

Previous results on branch: feat/capture-touch-breadcrumbs

Startup times

Revision	Plain	With Sentry	Diff
`ce4719d`	1238.06 ms	1253.20 ms	15.14 ms
`ed4cab2`	1245.75 ms	1267.19 ms	21.44 ms
`c6a4625`	1238.80 ms	1260.31 ms	21.51 ms
`dd15eaa`	1247.70 ms	1261.09 ms	13.39 ms
`7563246`	1264.69 ms	1283.59 ms	18.90 ms

App size

Revision	Plain	With Sentry	Diff
`ce4719d`	8.38 MiB	9.73 MiB	1.35 MiB
`ed4cab2`	8.38 MiB	9.73 MiB	1.35 MiB
`c6a4625`	8.38 MiB	9.71 MiB	1.33 MiB
`dd15eaa`	8.38 MiB	9.71 MiB	1.33 MiB
`7563246`	8.38 MiB	9.73 MiB	1.35 MiB

buenaflor · 2024-09-09T11:06:26Z

flutter/lib/src/user_interaction/sentry_user_interaction_widget.dart

+        }
+      }
+
+      return path.length < 10;


is 10 something we strictly define or is that set by yourself?

is 10 something we strictly define

not that I'm aware of, it's rather arbitrary

…tsentry/sentry-dart into fix/flutter-multiview-support * 'fix/flutter-multiview-support' of https://github.com/getsentry/sentry-dart: Update CHANGELOG.md release: 8.9.0 chore: rename errorSampleRate to onErrorSampleRate (#2270) fix: repost replay screenshots on android while idle (#2275) feat: capture touch breadcrumbs for all buttons (#2242) Symbolicate Dart stacktrace on Flutter Android and iOS without debug images from native sdks (#2256) Fix: Support allowUrls, denyUrls (#2271) chore(deps): update Flutter SDK (metrics) to v3.24.2 (#2272)

vaind added 11 commits September 2, 2024 16:35

chore: cleanup user interaction widget code

5ac2fce

renames & more cleanup

1445ba4

more cleanup

8deed2e

more refactoring & clenaup before actual functional changes

6510624

more refactoring

e307397

feat: collect touch element path

4e36260

update tests

3a3696b

add tests for the new support of non-keyed button presses

0102a0f

cleanup & improve existing code

06e60cb

chore: update changelog

d9abf70

update native replay integration with touch breadcrumb path

30cc34b

vaind force-pushed the feat/capture-touch-breadcrumbs branch from 3620bb4 to 30cc34b Compare September 2, 2024 17:57

vaind and others added 3 commits September 2, 2024 20:02

fix tests

ce4719d

Update CHANGELOG.md

301b327

linter issues

ed4cab2

vaind marked this pull request as ready for review September 4, 2024 06:46

vaind requested review from krystofwoldrich, stefanosiano and buenaflor as code owners September 4, 2024 06:46

Merge branch 'main' into feat/capture-touch-breadcrumbs

7563246

buenaflor approved these changes Sep 9, 2024

View reviewed changes

Merge branch 'main' into feat/capture-touch-breadcrumbs

b58b91d

vaind merged commit 3751dbc into main Sep 9, 2024
133 of 134 checks passed

vaind deleted the feat/capture-touch-breadcrumbs branch September 9, 2024 11:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: capture touch breadcrumbs for all buttons #2242

feat: capture touch breadcrumbs for all buttons #2242

vaind commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

codecov bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/capture-touch-breadcrumbs

Startup times

App size

github-actions bot commented Aug 21, 2024 •

edited

Loading

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/capture-touch-breadcrumbs

Startup times

App size

buenaflor Sep 9, 2024

vaind Sep 9, 2024 •

edited

Loading

feat: capture touch breadcrumbs for all buttons #2242

feat: capture touch breadcrumbs for all buttons #2242

Conversation

vaind commented Aug 21, 2024 • edited Loading

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Aug 21, 2024 • edited Loading

codecov bot commented Aug 21, 2024 • edited Loading

Codecov Report

github-actions bot commented Aug 21, 2024 • edited Loading

Android Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/capture-touch-breadcrumbs

Startup times

App size

github-actions bot commented Aug 21, 2024 • edited Loading

iOS Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/capture-touch-breadcrumbs

Startup times

App size

buenaflor Sep 9, 2024

Choose a reason for hiding this comment

vaind Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

vaind commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

codecov bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

vaind Sep 9, 2024 •

edited

Loading