Feat: Screenshots on reports #576

ueman · 2021-08-31T11:28:05Z

📜 Description

💡 Motivation and Context

Closes #556

💚 How did you test it?

📝 Checklist

🔮 Next steps

ueman · 2021-08-31T11:29:08Z

Example: https://sentry.io/organizations/sentry-sdks/issues/2613488099/?project=5428562

codecov-commenter · 2021-08-31T11:32:19Z

Codecov Report

Base: 89.90% // Head: 89.90% // No change to project coverage 👍

Coverage data is based on head (8169028) compared to base (870f5eb).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #576   +/-   ##
=======================================
  Coverage   89.90%   89.90%           
=======================================
  Files         106      106           
  Lines        3388     3388           
=======================================
  Hits         3046     3046           
  Misses        342      342

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

marandaneto · 2021-08-31T11:46:34Z

looks like the macOS hang again https://github.com/getsentry/sentry-dart/pull/576/checks?check_run_id=3472320682

ueman · 2021-08-31T11:52:47Z

looks like the macOS hang again https://github.com/getsentry/sentry-dart/pull/576/checks?check_run_id=3472320682

Ahhh, I really dislike that error :(

ueman · 2021-08-31T13:55:02Z

flutter/lib/src/screenshot/sentry_screenshot.dart

+  void dispose() {
+    hub.configureScope((scope) {
+      // The following doesn't work
+      // scope.attachements.remove(ScreenshotAttachment());


How are Attachments supposed to be removed?

Scope#clearAttachments()

But that clears all Attachments, I just want to remove the Screenshot attachement.

yep, that's how it works for all the list, either you clean them all or just add a new one, and all of them are sent.
a new idea came up before which is a parameter of adding an attachment, like addAttachment(attachment, onlyOnce: true)
as soon as its sent and onlyOnce is true, the attachment remove itself from the list

ueman · 2021-08-31T13:56:12Z

flutter/lib/src/screenshot/sentry_screenshot.dart

+  FutureOr<Uint8List> get bytes async {
+    //return await createScreenshot() ?? Uint8List.fromList([]);
+    final instance = SchedulerBinding.instance;
+    if (instance == null) {
+      return Uint8List.fromList([]);
+    }
+
+    final _completer = Completer<Uint8List?>();
+    // We add an post frame callback because we aren't able to take a screenshot
+    // if there's currently a draw in process.
+    instance.addPostFrameCallback((timeStamp) async {
+      final image = await createScreenshot();
+      _completer.complete(image);
+    });
+    return await _completer.future ?? Uint8List.fromList([]);
+  }


I'm pretty sure this is needed, though in a test it works without this. Maybe it also works on a device without this?

I'd say that we should keep the callback then, since the chances of an error happening during the draw process is quite high

ueman · 2021-08-31T13:56:33Z

flutter/lib/src/screenshot/sentry_screenshot.dart

+        final bytes = await image.toByteData(format: ui.ImageByteFormat.png);
+        return bytes?.buffer.asUint8List();
+      }
+    } catch (_) {}


This should be logged somehow

ueman · 2021-08-31T13:57:24Z

flutter/lib/src/screenshot/sentry_screenshot.dart

+/// Remarks:
+/// - Depending on the place where it's used, you might have a transparent
+///   background.
+/// - Platform Views currently can't be captured.


There's this issue: flutter/flutter#25306

Also this: flutter/flutter#83856

is flutter/flutter#83856 a blocker?

I wouldn't say so but it's definitly not nice. Most Flutter apps I've seen don't have a lot of platform views, so it should be fine for most users.

ueman · 2021-08-31T13:57:37Z

flutter/lib/src/screenshot/sentry_screenshot.dart

+      final renderObject = _gloablKey.currentContext?.findRenderObject();
+
+      if (renderObject is RenderRepaintBoundary) {
+        final image = await renderObject.toImage(pixelRatio: 1);


Add an option for this

marandaneto · 2021-08-31T14:04:51Z

flutter/lib/src/screenshot/sentry_screenshot.dart

    if (instance == null) {
-      _completer.complete(null);
-      return await _completer.future ?? Uint8List.fromList([]);
+      return Uint8List.fromList([]);


maybe we allow returning null then? it does not make sense to return an array of nothing, unless we filter out before adding the attachment if the array is empty or not

That would require all Attachments to allow returning null. Is that acceptable?

yeah not nice, but we should filter attachments with 0 bytes before adding to the envelope

marandaneto · 2021-10-20T09:32:36Z

draft of the spec btw https://github.com/getsentry/develop/pull/422/files

eshopekstore

@

# Conflicts: # flutter/example/lib/main.dart # flutter/lib/sentry_flutter.dart

github-actions · 2022-10-18T09:22:52Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

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

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Screenshots on reports ([#576](https://github.com/getsentry/sentry-dart/pull/576))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against 8169028

github-actions · 2022-10-18T09:32:40Z

Android Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	288.82 ms	332.56 ms	43.74 ms
Size	5.94 MiB	6.92 MiB	1005.82 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`eb1a7c1`	332.98 ms	381.55 ms	48.57 ms
`322aa66`	284.98 ms	341.76 ms	56.78 ms
`633cf2e`	289.36 ms	340.38 ms	51.02 ms
`9c5aec6`	287.33 ms	320.94 ms	33.61 ms
`870f5eb`	329.45 ms	369.29 ms	39.84 ms
`6d317ea`	303.46 ms	356.06 ms	52.60 ms
`72dfc83`	298.62 ms	340.14 ms	41.52 ms
`4efee31`	308.92 ms	368.68 ms	59.76 ms
`49a149b`	301.96 ms	344.51 ms	42.55 ms
`1c6eb5b`	350.69 ms	393.86 ms	43.17 ms

App size

Revision	Plain	With Sentry	Diff
`eb1a7c1`	5.94 MiB	6.92 MiB	1005.76 KiB
`322aa66`	5.94 MiB	6.92 MiB	1005.75 KiB
`633cf2e`	5.94 MiB	6.92 MiB	1001.53 KiB
`9c5aec6`	5.94 MiB	6.92 MiB	1001.61 KiB
`870f5eb`	5.94 MiB	6.92 MiB	1005.77 KiB
`6d317ea`	5.94 MiB	6.92 MiB	1001.74 KiB
`72dfc83`	5.94 MiB	6.92 MiB	1001.71 KiB
`4efee31`	5.94 MiB	6.92 MiB	1003.76 KiB
`49a149b`	5.94 MiB	6.92 MiB	1001.54 KiB
`1c6eb5b`	5.94 MiB	6.92 MiB	1001.53 KiB

github-actions · 2022-10-18T09:41:13Z

iOS Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1276.96 ms	1306.33 ms	29.37 ms
Size	8.15 MiB	9.13 MiB	1000.14 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`1c6eb5b`	1277.85 ms	1285.71 ms	7.86 ms
`322aa66`	1251.68 ms	1275.52 ms	23.84 ms
`9c5aec6`	1266.51 ms	1274.65 ms	8.14 ms
`21845e2`	1279.37 ms	1298.81 ms	19.45 ms
`4efee31`	1270.33 ms	1285.75 ms	15.42 ms
`49a149b`	1296.47 ms	1320.20 ms	23.73 ms
`56810ff`	1267.59 ms	1293.48 ms	25.89 ms
`870f5eb`	1267.78 ms	1286.86 ms	19.08 ms
`633cf2e`	1257.96 ms	1275.73 ms	17.77 ms
`3e5ee37`	1248.25 ms	1265.38 ms	17.13 ms

App size

Revision	Plain	With Sentry	Diff
`1c6eb5b`	8.15 MiB	9.12 MiB	986.27 KiB
`322aa66`	8.15 MiB	9.12 MiB	992.53 KiB
`9c5aec6`	8.15 MiB	9.12 MiB	986.23 KiB
`21845e2`	8.15 MiB	9.12 MiB	991.34 KiB
`4efee31`	8.15 MiB	9.12 MiB	991.35 KiB
`49a149b`	8.15 MiB	9.12 MiB	986.26 KiB
`56810ff`	8.15 MiB	9.12 MiB	987.35 KiB
`870f5eb`	8.15 MiB	9.13 MiB	1000.08 KiB
`633cf2e`	8.15 MiB	9.12 MiB	986.26 KiB
`3e5ee37`	8.15 MiB	9.12 MiB	986.23 KiB

ueman · 2022-10-24T15:25:53Z

Closing in favor of #1088

wip

5017027

ueman added 3 commits August 31, 2021 15:39

Documentation

10b1100

add screenshot to scope

b0be556

visibility foo

be23c31

ueman commented Aug 31, 2021

View reviewed changes

marandaneto reviewed Aug 31, 2021

View reviewed changes

ueman added the flutter flutter label Oct 6, 2021

marandaneto mentioned this pull request Oct 20, 2021

Feat: Add tracing for routes #611

Closed

5 tasks

eshopekstore reviewed Dec 12, 2021

View reviewed changes

ueman mentioned this pull request Jan 21, 2022

Add a way to remove an attachment from the scope #711

Closed

ueman mentioned this pull request Jul 25, 2022

Support screenshot feature (via attachments) #556

Closed

denrase self-assigned this Oct 18, 2022

denrase added 2 commits October 18, 2022 10:55

Merge branch 'main' into feat/screenshot

faa1ec3

# Conflicts: # flutter/example/lib/main.dart # flutter/lib/sentry_flutter.dart

fix compile issue

8169028

ueman closed this Oct 24, 2022

denrase mentioned this pull request Oct 25, 2022

Feat: Screenshot Attachment #1088

Merged

5 tasks

marandaneto deleted the feat/screenshot branch January 13, 2023 12:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Screenshots on reports #576

Feat: Screenshots on reports #576

ueman commented Aug 31, 2021

ueman commented Aug 31, 2021

codecov-commenter commented Aug 31, 2021 •

edited

Loading

marandaneto commented Aug 31, 2021

ueman commented Aug 31, 2021

ueman Aug 31, 2021

marandaneto Oct 20, 2021

ueman Oct 20, 2021

marandaneto Oct 20, 2021

ueman Jan 21, 2022

ueman Aug 31, 2021

marandaneto Oct 20, 2021

ueman Aug 31, 2021

ueman Aug 31, 2021

ueman Aug 31, 2021

marandaneto Oct 20, 2021

ueman Oct 20, 2021

ueman Aug 31, 2021

marandaneto Aug 31, 2021

ueman Aug 31, 2021

marandaneto Oct 20, 2021

marandaneto commented Oct 20, 2021

eshopekstore left a comment

github-actions bot commented Oct 18, 2022

github-actions bot commented Oct 18, 2022

Baseline results on branch: main

Startup times

App size

github-actions bot commented Oct 18, 2022

Baseline results on branch: main

Startup times

App size

ueman commented Oct 24, 2022

Feat: Screenshots on reports #576

Feat: Screenshots on reports #576

Conversation

ueman commented Aug 31, 2021

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

ueman commented Aug 31, 2021

codecov-commenter commented Aug 31, 2021 • edited Loading

Codecov Report

marandaneto commented Aug 31, 2021

ueman commented Aug 31, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marandaneto commented Oct 20, 2021

eshopekstore left a comment

Choose a reason for hiding this comment

@

github-actions bot commented Oct 18, 2022

Instructions and example for changelog

github-actions bot commented Oct 18, 2022

Android Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

github-actions bot commented Oct 18, 2022

iOS Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

ueman commented Oct 24, 2022

codecov-commenter commented Aug 31, 2021 •

edited

Loading