Attachment support #68

konraddysput · 2021-03-11T14:29:47Z

Why

As a user I would like to upload attachments when:

ANR,
Crash,
Exception,
Unhandled exception,
happened. With attachment support, we can have more insights about a game state when the specific situation in my game occurred.

This pull request allows our users to set up attachment support for managed and native reports. To achieve that users can initialize Backtrace Client integration with the list of paths to attachments that they would like to send to us. Attachments will be included in every Backtrace report. In addition to that on iOS when OOM, Crash occurred, we're generating crash/oom attributes but also we store attachments. In the next session when we want to send attachments to Backtrace, old attachments and new attachments will be available in the OOM/Crash report.

Limitations

We can initialize native attachments only on game startup - unfortunately, we can't add more attachments later.
User is responsible for attachment size - application might crash because of attachment size - for example when user wants to upload 5GB of data to Backtrace as an attachment.

Updates:

This diff updates the backtrace-android native library available in unity and the backtrace-cocoa (objective-c) library.

Testing strategy

In all my tests I used:

single file (.txt)
multiple files (.txt and .jpg)
files that don't exist with files that exist on the hard drive

Native test

iOS

Attachments are available on app crash

Set paths to attachments
Crash app
Relaunch Game
Check the Backtrace report in Backtrace and validate if attachments from the previous session and current session are available.

OOM reports contain attachment paths

Set paths to attachments
Simulate memory warning
Crash app via OOM script OR by using special workarounds.
Check if the OOM report has attachments from the previous session and from the current session.

ANR reports contain attachment paths

Set paths to attachments
Generate ANR on the managed layer,
Check if the ANR report has attachments set by the user in the current session

Android

Generate android Crash

Set paths to attachments
Crash app
Check the Backtrace report in Backtrace and validate if attachments are available.

ANR reports contain attachment paths

Set paths to attachments
Generate ANR on the managed layer,
Check if the ANR report has attachments set by the user in the current session

Managed tests

Send exception/unhandled exception/message and see if attachments are available

Set the path to the attachment
Generate an exception/unhandled exception/message
Check the Backtrace report in Backtrace to see if

…just iOS integration code - code should now compile on iOS

Runtime/BacktraceClient.cs

rqbacktrace

Looks good to me, thank you!

Runtime/BacktraceClient.cs

vlussenburg

The .so files look empty (0 bytes) in the diff - is that right?

Runtime/BacktraceClient.cs

Runtime/Native/iOS/NativeClient.cs

vlussenburg

Although 'boring getter setter logic' this should be unit tested.

Runtime/Native/iOS/NativeClient.cs

Runtime/BacktraceClient.cs

…s/backtrace-unity into feature/attachment-support

Dautery91

@konraddysput - looks great overall. The only feedback is to change that tooltip (see my comment). Thanks!

Dautery91 · 2021-03-15T16:10:48Z

Runtime/Model/BacktraceConfiguration.cs

        [Tooltip("If the database is unable to send its record, this setting specifies the maximum number of retries before the system gives up")]
        public int RetryLimit = 3;

+        [Tooltip("If the database is unable to send its record, this setting specifies the maximum number of retries before the system gives up")]


I think you copy / pasted the tool tip from the above. Make sure you update it to reflect the real use of the AttachmentPaths field @konraddysput

ah good catch. Thanks

Dautery91 · 2021-03-15T16:19:18Z

Editor/BacktraceConfigurationEditor.cs

+#if UNITY_ANDROID || UNITY_IOS
+            EditorGUILayout.PropertyField(
+                serializedObject.FindProperty("AttachmentPaths"),
+                new GUIContent(BacktraceConfigurationLabels.LABEL_REPORT_ATTACHMENTS));


@konraddysput does this end up exposing the array as we discussed in the editor? (The default foldout arrow thing?) If so, this is good for now! Side note - as a part of the work I am doing, I am going to try to come up with some custom property drawers to make these easier to use

Yes it does - I hope we can make it prettier soon!

Dautery91

Looks good, thanks for making the change!

…se-positive anrs (#69) * Background thread support (#67) * Background thread support * Fixed exception flow * Removed renamed file * Detect false-positive ANRs report and prevent ANR watchdog from sending them (#66) * Detect false-positive ANRs report and prevent ANR watchdog from sending them + anr thread improvements * Fixed typos + better documentation - added Samy's advices * Attachment support (#68) * Attachment support on Android - iOS shouldn't compile * Updated the latest version of backtrace-android libraries and also adjust iOS integration code - code should now compile on iOS * Native attachment support * Attachment improvements * Updated label * Native client updates * Android libraries * Version update * 3.4.0-rc1 * Prevents from reading empty attachments * Arabic language support (#70) * Fixed invalid date in log manager when calendar is unsupported * Use single method to generate UTC timestamps + move it from extension code to static class to avoid unnecessary allocation * Fixed line endings * Updated native library * Removed debug logs from native library * Updated library version * Added invariant culture to rest of the code * native library update * Fixed issue in the readme file * Correct attachment name (#73) * Correct attachment name * Moved constants to const variables * Prepare for final release * Fixed typo in function name * Changelog change

konraddysput added 3 commits March 10, 2021 12:56

Attachment support on Android - iOS shouldn't compile

d1822d1

Updated the latest version of backtrace-android libraries and also ad…

5e231ea

…just iOS integration code - code should now compile on iOS

Native attachment support

200083a

konraddysput requested review from Dautery91, jasoncdavis0, rqbacktrace and vlussenburg March 11, 2021 14:30

konraddysput self-assigned this Mar 11, 2021

konraddysput added the enhancement New feature or request label Mar 11, 2021

rqbacktrace reviewed Mar 11, 2021

View reviewed changes

Runtime/BacktraceClient.cs Outdated Show resolved Hide resolved

rqbacktrace reviewed Mar 11, 2021

View reviewed changes

Runtime/BacktraceClient.cs Outdated Show resolved Hide resolved

rqbacktrace approved these changes Mar 11, 2021

View reviewed changes

Runtime/BacktraceClient.cs Outdated Show resolved Hide resolved

vlussenburg reviewed Mar 11, 2021

View reviewed changes

Runtime/BacktraceClient.cs Outdated Show resolved Hide resolved

vlussenburg reviewed Mar 11, 2021

View reviewed changes

Runtime/Native/iOS/NativeClient.cs Outdated Show resolved Hide resolved

vlussenburg suggested changes Mar 11, 2021

View reviewed changes

Runtime/Native/iOS/NativeClient.cs Outdated Show resolved Hide resolved

Runtime/BacktraceClient.cs Outdated Show resolved Hide resolved

Runtime/BacktraceClient.cs Outdated Show resolved Hide resolved

konraddysput added 2 commits March 15, 2021 13:48

Attachment improvements

e21d7d4

Merge branch 'feature/attachment-support' of github.com:backtrace-lab…

c67333c

…s/backtrace-unity into feature/attachment-support

vlussenburg approved these changes Mar 15, 2021

View reviewed changes

jasoncdavis0 approved these changes Mar 15, 2021

View reviewed changes

Dautery91 suggested changes Mar 15, 2021

View reviewed changes

Updated label

71cf178

Dautery91 self-requested a review March 15, 2021 16:27

Dautery91 approved these changes Mar 15, 2021

View reviewed changes

Native client updates

7c4574e

Base automatically changed from release/3.3.4 to release/3.4.0 March 15, 2021 18:20

konraddysput added 2 commits March 15, 2021 19:26

Merge branch 'release/3.4.0' into feature/attachment-support

e0b011e

Android libraries

31966d3

konraddysput merged commit 1014e10 into release/3.4.0 Mar 15, 2021

konraddysput deleted the feature/attachment-support branch April 7, 2021 09:06

Attachment support #68

Attachment support #68

Uh oh!

Conversation

konraddysput commented Mar 11, 2021

Why

Updates:

Testing strategy

Native test

iOS

Android

Managed tests

Uh oh!

Uh oh!

Uh oh!

rqbacktrace left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vlussenburg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vlussenburg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dautery91 left a comment

Choose a reason for hiding this comment

Uh oh!

Dautery91 Mar 15, 2021

Choose a reason for hiding this comment

Uh oh!

konraddysput Mar 15, 2021

Choose a reason for hiding this comment

Uh oh!

Dautery91 Mar 15, 2021

Choose a reason for hiding this comment

Uh oh!

konraddysput Mar 15, 2021

Choose a reason for hiding this comment

Uh oh!

Dautery91 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants