fix: Screenshot Capture #2240
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,85 @@ | ||
| using System; | ||
| using System.Collections; | ||
| using System.Threading; | ||
| using Sentry.Extensibility; | ||
| using Sentry.Internal; | ||
| using UnityEngine; | ||
|
|
||
| namespace Sentry.Unity; | ||
|
|
||
| public class ScreenshotEventProcessor : ISentryEventProcessor | ||
| { | ||
| private readonly SentryUnityOptions _options; | ||
| private readonly ISentryMonoBehaviour _sentryMonoBehaviour; | ||
| private volatile int _isCapturingScreenshot; | ||
|
|
||
| public ScreenshotEventProcessor(SentryUnityOptions sentryOptions) : this(sentryOptions, SentryMonoBehaviour.Instance) { } | ||
|
|
||
| internal ScreenshotEventProcessor(SentryUnityOptions sentryOptions, ISentryMonoBehaviour sentryMonoBehaviour) | ||
| { | ||
| _options = sentryOptions; | ||
| _sentryMonoBehaviour = sentryMonoBehaviour; | ||
| } | ||
|
|
||
| public SentryEvent Process(SentryEvent @event) | ||
| { | ||
| // Only ever capture one screenshot per frame | ||
| if (Interlocked.CompareExchange(ref _isCapturingScreenshot, 1, 0) == 0) | ||
| { | ||
| _sentryMonoBehaviour.StartCoroutine(CaptureScreenshotCoroutine(@event.EventId)); | ||
|
bitsandfoxes marked this conversation as resolved.
|
||
| } | ||
|
|
||
| return @event; | ||
| } | ||
|
|
||
| internal IEnumerator CaptureScreenshotCoroutine(SentryId eventId) | ||
| { | ||
| _options.LogDebug("Screenshot capture triggered. Waiting for End of Frame."); | ||
|
|
||
|
bitsandfoxes marked this conversation as resolved.
|
||
| // WaitForEndOfFrame does not work in headless mode so we're making it configurable for CI. | ||
| // See https://docs.unity3d.com/6000.1/Documentation/ScriptReference/WaitForEndOfFrame.html | ||
| yield return WaitForEndOfFrame(); | ||
|
|
||
| try | ||
| { | ||
| if (_options.BeforeCaptureScreenshotInternal?.Invoke() is false) | ||
| { | ||
| yield break; | ||
| } | ||
|
|
||
| var screenshotBytes = CaptureScreenshot(_options); | ||
| if (screenshotBytes.Length == 0) | ||
| { | ||
| _options.LogWarning("Screenshot capture returned empty data for event {0}", eventId); | ||
| yield break; | ||
| } | ||
|
|
||
| var attachment = new SentryAttachment( | ||
| AttachmentType.Default, | ||
| new ByteAttachmentContent(screenshotBytes), | ||
| "screenshot.jpg", | ||
| "image/jpeg"); | ||
|
|
||
| _options.LogDebug("Screenshot captured for event {0}", eventId); | ||
|
|
||
| CaptureAttachment(eventId, attachment); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| _options.LogError(e, "Failed to capture screenshot."); | ||
| } | ||
| finally | ||
| { | ||
| Interlocked.Exchange(ref _isCapturingScreenshot, 0); | ||
| } | ||
| } | ||
|
|
||
| internal virtual byte[] CaptureScreenshot(SentryUnityOptions options) | ||
| => SentryScreenshot.Capture(options); | ||
|
|
||
| internal virtual void CaptureAttachment(SentryId eventId, SentryAttachment attachment) | ||
| => (Sentry.SentrySdk.CurrentHub as Hub)?.CaptureAttachment(eventId, attachment); | ||
|
|
||
| internal virtual YieldInstruction WaitForEndOfFrame() | ||
| => new WaitForEndOfFrame(); | ||
|
Comment on lines
+77
to
+84
Contributor
Author
There was a problem hiding this comment. I'm making these virtual so I can create a |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule sentry-dotnet
updated
18 files
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With Unity 6 integration tests seem to fail to have their proper identifier set, causing the build to fail. We're setting this now explicitly in the
Builder.csand making use of the hardcoded name here.