Skip to content

feat(feedback): Use only image uri in the onAddScreenshot callback #4546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Feb 18, 2025

Conversation

antonis
Copy link
Collaborator

@antonis antonis commented Feb 14, 2025

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

Based on #4545

📜 Description

Simplifies onAddScreenshot callback by requiring image uri string instead of UInt8Array of for data.

💡 Motivation and Context

Rendering screenshots for which we only have Uint8Array data as part of #4545 requires conversion to base64 which adds processing overhead and is not straightforward without an external library. Given that acquiring just the the image uri should be easier for developers that want to use a custom implementation with the onAddScreenshot callback, it might make sense to deprecate Uint8Array on the api level and just use it to send the data.

⚠️ The docs PR needs to be updated with the added styles getsentry/sentry-docs#12503

💚 How did you test it?

Manual

📝 Checklist

  • 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.
  • I updated the wizard if needed.
  • All tests passing
  • No breaking changes

🔮 Next steps

#skip-changelog

@antonis antonis marked this pull request as ready for review February 14, 2025 16:18
Copy link
Contributor

github-actions bot commented Feb 14, 2025

Android (legacy) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 426.02 ms 452.36 ms 26.33 ms
Size 17.75 MiB 20.12 MiB 2.38 MiB

Baseline results on branch: feedback-ui

Startup times

Revision Plain With Sentry Diff
9402883 448.53 ms 468.73 ms 20.20 ms
e42816c 401.30 ms 410.04 ms 8.74 ms
3e4cdf5 462.35 ms 474.96 ms 12.61 ms
77e88fc 478.48 ms 487.21 ms 8.73 ms
8cb898b 438.83 ms 420.58 ms -18.25 ms
2646c98 429.98 ms 421.63 ms -8.35 ms
6b1624f 462.78 ms 465.13 ms 2.35 ms
df05370 477.62 ms 491.63 ms 14.00 ms
e5d5735 452.70 ms 453.04 ms 0.34 ms
894ebb0 497.45 ms 545.04 ms 47.60 ms

App size

Revision Plain With Sentry Diff
9402883 17.75 MiB 20.12 MiB 2.37 MiB
e42816c 17.75 MiB 20.12 MiB 2.38 MiB
3e4cdf5 17.75 MiB 20.12 MiB 2.37 MiB
77e88fc 17.75 MiB 20.12 MiB 2.37 MiB
8cb898b 17.75 MiB 20.12 MiB 2.37 MiB
2646c98 17.75 MiB 20.12 MiB 2.37 MiB
6b1624f 17.75 MiB 20.12 MiB 2.37 MiB
df05370 17.75 MiB 20.12 MiB 2.37 MiB
e5d5735 17.75 MiB 20.12 MiB 2.37 MiB
894ebb0 17.75 MiB 20.12 MiB 2.37 MiB

Previous results on branch: antonis/feedback-simplify-onaddscreenshot

Startup times

Revision Plain With Sentry Diff
e192eb4 310.48 ms 325.46 ms 14.98 ms
fae3a0a 439.51 ms 496.11 ms 56.60 ms
d1c658f 413.13 ms 414.96 ms 1.82 ms

App size

Revision Plain With Sentry Diff
e192eb4 17.75 MiB 20.12 MiB 2.38 MiB
fae3a0a 17.75 MiB 20.12 MiB 2.38 MiB
d1c658f 17.75 MiB 20.12 MiB 2.38 MiB

@antonis antonis changed the title Feedback UI: Use image uri instead of UInt8Array in onAddScreenshot callback feat(feedback): Use image uri instead of UInt8Array in onAddScreenshot callback Feb 14, 2025
Copy link
Contributor

github-actions bot commented Feb 14, 2025

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

Generated by 🚫 dangerJS against 6ca97ad

Copy link
Contributor

github-actions bot commented Feb 14, 2025

Android (new) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 363.85 ms 366.96 ms 3.11 ms
Size 7.15 MiB 8.39 MiB 1.24 MiB

Baseline results on branch: antonis/feedback-show-screenshot

Startup times

Revision Plain With Sentry Diff
efb4f02+dirty 445.25 ms 444.89 ms -0.36 ms
ae7dd36+dirty 399.65 ms 391.49 ms -8.16 ms
02906ad+dirty 418.55 ms 442.74 ms 24.19 ms

App size

Revision Plain With Sentry Diff
efb4f02+dirty 7.15 MiB 8.39 MiB 1.24 MiB
ae7dd36+dirty 7.15 MiB 8.39 MiB 1.24 MiB
02906ad+dirty 7.15 MiB 8.39 MiB 1.24 MiB

Previous results on branch: antonis/feedback-simplify-onaddscreenshot

Startup times

Revision Plain With Sentry Diff
d1c658f+dirty 415.71 ms 429.39 ms 13.68 ms
e192eb4+dirty 393.41 ms 412.04 ms 18.63 ms

App size

Revision Plain With Sentry Diff
d1c658f+dirty 7.15 MiB 8.39 MiB 1.24 MiB
e192eb4+dirty 7.15 MiB 8.39 MiB 1.24 MiB

Copy link
Contributor

github-actions bot commented Feb 14, 2025

iOS (legacy) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1221.87 ms 1226.36 ms 4.49 ms
Size 2.63 MiB 3.76 MiB 1.12 MiB

Baseline results on branch: feedback-ui

Startup times

Revision Plain With Sentry Diff
e5d5735+dirty 1222.02 ms 1222.22 ms 0.20 ms
8cb898b+dirty 1221.40 ms 1231.78 ms 10.37 ms
77e88fc+dirty 1224.55 ms 1232.41 ms 7.86 ms
9402883+dirty 1219.65 ms 1217.94 ms -1.72 ms
894ebb0+dirty 1224.33 ms 1214.45 ms -9.89 ms
e42816c+dirty 1211.29 ms 1219.65 ms 8.37 ms
0325426+dirty 1228.88 ms 1229.92 ms 1.04 ms
0459aee+dirty 1232.82 ms 1231.19 ms -1.63 ms
6b1624f+dirty 1224.65 ms 1225.65 ms 1.00 ms
269c976+dirty 1210.02 ms 1204.46 ms -5.56 ms

App size

Revision Plain With Sentry Diff
e5d5735+dirty 2.63 MiB 3.69 MiB 1.06 MiB
8cb898b+dirty 2.63 MiB 3.71 MiB 1.08 MiB
77e88fc+dirty 2.63 MiB 3.75 MiB 1.12 MiB
9402883+dirty 2.63 MiB 3.71 MiB 1.07 MiB
894ebb0+dirty 2.63 MiB 3.71 MiB 1.07 MiB
e42816c+dirty 2.63 MiB 3.75 MiB 1.12 MiB
0325426+dirty 2.63 MiB 3.69 MiB 1.06 MiB
0459aee+dirty 2.63 MiB 3.69 MiB 1.06 MiB
6b1624f+dirty 2.63 MiB 3.71 MiB 1.07 MiB
269c976+dirty 2.63 MiB 3.69 MiB 1.06 MiB

Previous results on branch: antonis/feedback-simplify-onaddscreenshot

Startup times

Revision Plain With Sentry Diff
fae3a0a+dirty 1226.61 ms 1225.24 ms -1.36 ms
e192eb4+dirty 1223.02 ms 1230.42 ms 7.40 ms
d1c658f+dirty 1200.16 ms 1199.72 ms -0.44 ms

App size

Revision Plain With Sentry Diff
fae3a0a+dirty 2.63 MiB 3.76 MiB 1.12 MiB
e192eb4+dirty 2.63 MiB 3.75 MiB 1.12 MiB
d1c658f+dirty 2.63 MiB 3.76 MiB 1.12 MiB

Copy link
Contributor

github-actions bot commented Feb 14, 2025

iOS (new) Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1227.71 ms 1231.89 ms 4.18 ms
Size 3.19 MiB 4.32 MiB 1.14 MiB

Baseline results on branch: feedback-ui

Startup times

Revision Plain With Sentry Diff
e5d5735+dirty 1217.78 ms 1221.80 ms 4.02 ms
8cb898b+dirty 1209.39 ms 1207.57 ms -1.82 ms
77e88fc+dirty 1218.79 ms 1220.00 ms 1.21 ms
9402883+dirty 1217.71 ms 1213.02 ms -4.69 ms
894ebb0+dirty 1210.94 ms 1202.08 ms -8.85 ms
e42816c+dirty 1220.08 ms 1222.46 ms 2.38 ms
0325426+dirty 1210.17 ms 1216.37 ms 6.20 ms
0459aee+dirty 1233.67 ms 1239.80 ms 6.12 ms
6b1624f+dirty 1224.12 ms 1220.73 ms -3.39 ms
269c976+dirty 1223.29 ms 1222.90 ms -0.39 ms

App size

Revision Plain With Sentry Diff
e5d5735+dirty 3.19 MiB 4.26 MiB 1.07 MiB
8cb898b+dirty 3.19 MiB 4.28 MiB 1.09 MiB
77e88fc+dirty 3.19 MiB 4.32 MiB 1.13 MiB
9402883+dirty 3.19 MiB 4.27 MiB 1.09 MiB
894ebb0+dirty 3.19 MiB 4.27 MiB 1.09 MiB
e42816c+dirty 3.19 MiB 4.32 MiB 1.13 MiB
0325426+dirty 3.19 MiB 4.26 MiB 1.07 MiB
0459aee+dirty 3.19 MiB 4.26 MiB 1.07 MiB
6b1624f+dirty 3.19 MiB 4.27 MiB 1.09 MiB
269c976+dirty 3.19 MiB 4.26 MiB 1.07 MiB

Previous results on branch: antonis/feedback-simplify-onaddscreenshot

Startup times

Revision Plain With Sentry Diff
fae3a0a+dirty 1245.31 ms 1245.24 ms -0.07 ms
e192eb4+dirty 1219.43 ms 1221.80 ms 2.37 ms
d1c658f+dirty 1229.51 ms 1224.88 ms -4.64 ms

App size

Revision Plain With Sentry Diff
fae3a0a+dirty 3.19 MiB 4.32 MiB 1.14 MiB
e192eb4+dirty 3.19 MiB 4.32 MiB 1.13 MiB
d1c658f+dirty 3.19 MiB 4.32 MiB 1.14 MiB

@antonis antonis changed the title feat(feedback): Use image uri instead of UInt8Array in onAddScreenshot callback feat(feedback): Use only image uri in the onAddScreenshot callback Feb 17, 2025
Copy link
Member

@krystofwoldrich krystofwoldrich left a comment

Choose a reason for hiding this comment

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

Just a small comment about the callback name, otherwise looks good. Thank you.

@antonis
Copy link
Collaborator Author

antonis commented Feb 18, 2025

⚠️ The docs PR needs to be updated with the added styles getsentry/sentry-docs#12503

Updated with getsentry/sentry-docs@48a7972

Base automatically changed from antonis/feedback-show-screenshot to feedback-ui February 18, 2025 14:38
@antonis antonis merged commit 53e13fc into feedback-ui Feb 18, 2025
59 of 60 checks passed
@antonis antonis deleted the antonis/feedback-simplify-onaddscreenshot branch February 18, 2025 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants