feat: Debouncing of SentryWidgetsBindingObserver.didChangeMetrics. #400

[martinhaintz]

📜 Description

Debouncing the SentryWidgetsBindingObserver.didChangeMetrics method.
This was called up to approx. 20 times if the window size was changed on flutter desktop, approx. 10 on flutter web and 4-5 times on mobile if the screen was rotated.
Setting the debouncing to 100ms seems to be enough to debounce 95% - 99% of the duplicate calls and also make sure, that the delay after the windows is resized or rotated is not to big.

💡 Motivation and Context

close #400

💚 How did you test it?

On simulator/emulator, web application and desktop application.

📝 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

[github-actions]

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

Generated by 🚫 dangerJS against 491201f

[codecov]

Codecov Report

Attention: Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.

Project coverage is 91.75%. Comparing base (73d70bf) to head (491201f).
Report is 1 commits behind head on main.

Files	Patch %	Lines
flutter/lib/src/utils/debouncer.dart	66.66%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2232      +/-   ##
==========================================
+ Coverage   88.25%   91.75%   +3.50%     
==========================================
  Files         234       64     -170     
  Lines        8141     2075    -6066     
==========================================
- Hits         7185     1904    -5281     
+ Misses        956      171     -785     

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

[github-actions]

Android Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	414.49 ms	491.88 ms	77.39 ms
Size	6.52 MiB	7.59 MiB	1.06 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
c978477	347.00 ms	409.94 ms	62.94 ms
9d7e862	426.35 ms	510.88 ms	84.53 ms
0f067d3	359.56 ms	431.28 ms	71.72 ms
613760b	373.42 ms	399.33 ms	25.92 ms
a775d3f	359.58 ms	436.68 ms	77.10 ms
408bdab	360.18 ms	434.92 ms	74.74 ms
ee0ca56	355.35 ms	421.13 ms	65.78 ms
5e8d2b3	342.17 ms	375.83 ms	33.66 ms
7e7f0b1	387.44 ms	459.14 ms	71.70 ms
bdd1a23	316.21 ms	364.80 ms	48.59 ms

App size

Revision	Plain	With Sentry	Diff
c978477	6.33 MiB	7.29 MiB	987.32 KiB
9d7e862	6.33 MiB	7.26 MiB	943.41 KiB
0f067d3	6.33 MiB	7.30 MiB	992.08 KiB
613760b	5.94 MiB	6.92 MiB	1005.98 KiB
a775d3f	6.27 MiB	7.20 MiB	957.75 KiB
408bdab	6.27 MiB	7.20 MiB	959.07 KiB
ee0ca56	6.33 MiB	7.30 MiB	992.52 KiB
5e8d2b3	6.15 MiB	7.13 MiB	1000.11 KiB
7e7f0b1	6.35 MiB	7.34 MiB	1008.33 KiB
bdd1a23	6.16 MiB	7.14 MiB	1011.19 KiB

Previous results on branch: debouncing-of-sentry-widgets-binding-observer-did-change-metrics

Startup times

Revision	Plain	With Sentry	Diff
0c84e5e	451.77 ms	547.37 ms	95.60 ms

App size

Revision	Plain	With Sentry	Diff
0c84e5e	6.52 MiB	7.59 MiB	1.06 MiB

[github-actions]

iOS Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1239.52 ms	1251.17 ms	11.64 ms
Size	8.38 MiB	9.71 MiB	1.33 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
1596141	1230.77 ms	1241.90 ms	11.13 ms
683fd34	1239.83 ms	1259.08 ms	19.25 ms
6572f8d	1242.16 ms	1246.63 ms	4.47 ms
0f067d3	1245.71 ms	1269.59 ms	23.88 ms
ca7f531	1242.51 ms	1282.61 ms	40.10 ms
90db9ff	1277.18 ms	1283.69 ms	6.51 ms
d089990	1206.19 ms	1233.08 ms	26.89 ms
bf4aed7	1274.63 ms	1286.48 ms	11.85 ms
691aa3b	1265.57 ms	1282.13 ms	16.55 ms
1c6eb5b	1277.85 ms	1285.71 ms	7.86 ms

App size

Revision	Plain	With Sentry	Diff
1596141	8.29 MiB	9.37 MiB	1.08 MiB
683fd34	8.28 MiB	9.34 MiB	1.06 MiB
6572f8d	8.29 MiB	9.36 MiB	1.07 MiB
0f067d3	8.32 MiB	9.52 MiB	1.20 MiB
ca7f531	8.32 MiB	9.38 MiB	1.06 MiB
90db9ff	8.10 MiB	9.08 MiB	1004.27 KiB
d089990	8.33 MiB	9.40 MiB	1.07 MiB
bf4aed7	8.10 MiB	9.17 MiB	1.08 MiB
691aa3b	8.16 MiB	9.17 MiB	1.01 MiB
1c6eb5b	8.15 MiB	9.12 MiB	986.27 KiB

Previous results on branch: debouncing-of-sentry-widgets-binding-observer-did-change-metrics

Startup times

Revision	Plain	With Sentry	Diff
0c84e5e	1231.24 ms	1246.88 ms	15.63 ms

App size

Revision	Plain	With Sentry	Diff
0c84e5e	8.38 MiB	9.71 MiB	1.33 MiB

[buenaflor]

looks good to me, left a few minor comments