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

Author: konraddysput

Android/lib/arm64-v8a/libbacktrace-native.so

@@ -64,7 +64,6 @@ public override void OnInspectorGUI()
                  serializedObject.FindProperty("SendUnhandledGameCrashesOnGameStartup"),
                  new GUIContent(BacktraceConfigurationLabels.LABEL_SEND_UNHANDLED_GAME_CRASHES_ON_STARTUP));
 #endif
-
                 EditorGUILayout.PropertyField(
                        serializedObject.FindProperty("ReportFilterType"),
                        new GUIContent(BacktraceConfigurationLabels.LABEL_REPORT_FILTER));
@@ -93,6 +92,13 @@ public override void OnInspectorGUI()
                     EditorGUILayout.HelpBox("Please insert value greater or equal -1", MessageType.Error);
                 }
             }
+
+#if UNITY_ANDROID || UNITY_IOS
+            EditorGUILayout.PropertyField(
+                serializedObject.FindProperty("AttachmentPaths"),
+                new GUIContent(BacktraceConfigurationLabels.LABEL_REPORT_ATTACHMENTS));
+#endif
+
 #if !UNITY_SWITCH
             SerializedProperty enabled = serializedObject.FindProperty("Enabled");
             EditorGUILayout.PropertyField(enabled, new GUIContent(BacktraceConfigurationLabels.LABEL_ENABLE_DATABASE));

Android/lib/arm64-v8a/libcrashpad_handler.so

@@ -18,6 +18,7 @@ internal static class BacktraceConfigurationLabels
             "(Early access) Send Out of memory exceptions to Backtrace";
 #endif
 #endif
+        internal static string LABEL_REPORT_ATTACHMENTS = "Report attachment paths";
         internal static string CAPTURE_NATIVE_CRASHES = "Capture native crashes";
         internal static string LABEL_REPORT_FILTER = "Filter reports";
         internal static string LABEL_NUMBER_OF_LOGS = "Collect last n game logs";

Android/lib/armeabi-v7a/libbacktrace-native.so

@@ -31,6 +31,11 @@ public class BacktraceClient : MonoBehaviour, IBacktraceClient
 
         internal readonly Stack<BacktraceReport> BackgroundExceptions = new Stack<BacktraceReport>();
 
+        /// <summary>
+        /// Client report attachments
+        /// </summary>
+        private List<string> _clientReportAttachments;
+
         /// <summary>
         /// Attribute object accessor
         /// </summary>
@@ -50,6 +55,26 @@ public string this[string index]
             }
         }
 
+        /// <summary>
+        /// Add attachment to managed reports.
+        /// Note: this option won't add attachment to your native reports. You can add attachments to
+        /// native reports only on BacktraceClient initialization.
+        /// </summary>
+        /// <param name="pathToAttachment">Path to attachment</param>
+        public void AddAttachment(string pathToAttachment)
+        {
+            _clientReportAttachments.Add(pathToAttachment);
+        }
+
+        /// <summary>
+        /// Returns list of defined path to attachments stored by Backtrace client.
+        /// </summary>
+        /// <returns>List of client attachments</returns>
+        public List<string> GetAttachments()
+        {
+            return _clientReportAttachments;
+        }
+
         /// <summary>
         /// Set client attributes that will be included in every report
         /// </summary>
@@ -271,6 +296,7 @@ internal ReportLimitWatcher ReportLimitWatcher
         /// </summary>
         /// <param name="configuration">Backtrace configuration scriptable object</param>
         /// <param name="attributes">Client side attributes</param>
+        /// param name="attachments">List of attachments </param>
         /// <param name="gameObjectName">game object name</param>
         /// <returns>Backtrace client</returns>
         public static BacktraceClient Initialize(BacktraceConfiguration configuration, Dictionary<string, string> attributes = null, string gameObjectName = "BacktraceClient")
@@ -313,9 +339,24 @@ public static BacktraceClient Initialize(BacktraceConfiguration configuration, D
         /// <param name="gameObjectName">game object name</param>
         /// <returns>Backtrace client</returns>
         public static BacktraceClient Initialize(string url, string databasePath, Dictionary<string, string> attributes = null, string gameObjectName = "BacktraceClient")
+        {
+            return Initialize(url, databasePath, attributes, null, gameObjectName);
+        }
+
+        /// <summary>
+        /// Initialize new Backtrace integration with database path. Note - database path will be auto created by Backtrace Unity plugin
+        /// </summary>
+        /// <param name="url">Server url</param>
+        /// <param name="databasePath">Database path</param>
+        /// <param name="attributes">Client side attributes</param>
+        /// <param name="attachments">Paths to attachments that Backtrace client will include in managed/native reports</param>
+        /// <param name="gameObjectName">game object name</param>
+        /// <returns>Backtrace client</returns>
+        public static BacktraceClient Initialize(string url, string databasePath, Dictionary<string, string> attributes = null, string[] attachments = null, string gameObjectName = "BacktraceClient")
         {
             var configuration = ScriptableObject.CreateInstance<BacktraceConfiguration>();
             configuration.ServerUrl = url;
+            configuration.AttachmentPaths = attachments;
             configuration.Enabled = true;
             configuration.DatabasePath = databasePath;
             configuration.CreateDatabase = true;
@@ -330,9 +371,23 @@ public static BacktraceClient Initialize(string url, string databasePath, Dictio
         /// <param name="gameObjectName">game object name</param>
         /// <returns>Backtrace client</returns>
         public static BacktraceClient Initialize(string url, Dictionary<string, string> attributes = null, string gameObjectName = "BacktraceClient")
+        {
+            return Initialize(url, attributes, new string[0], gameObjectName);
+        }
+
+        /// <summary>
+        /// Initialize new Backtrace integration
+        /// </summary>
+        /// <param name="url">Server url</param>
+        /// <param name="attributes">Client side attributes</param>
+        /// <param name="attachments">Paths to attachments that Backtrace client will include in managed/native reports</param>
+        /// <param name="gameObjectName">game object name</param>
+        /// <returns>Backtrace client</returns>
+        public static BacktraceClient Initialize(string url, Dictionary<string, string> attributes = null, string[] attachments = null, string gameObjectName = "BacktraceClient")
         {
             var configuration = ScriptableObject.CreateInstance<BacktraceConfiguration>();
             configuration.ServerUrl = url;
+            configuration.AttachmentPaths = attachments;
             configuration.Enabled = false;
             return Initialize(configuration, attributes, gameObjectName);
         }
@@ -358,7 +413,7 @@ public void Refresh()
             _current = Thread.CurrentThread;
             CaptureUnityMessages();
             _reportLimitWatcher = new ReportLimitWatcher(Convert.ToUInt32(Configuration.ReportPerMin));
-
+            _clientReportAttachments = Configuration.GetAttachmentPaths();
 
             BacktraceApi = new BacktraceApi(
                 credentials: new BacktraceCredentials(Configuration.GetValidServerUrl()),
@@ -668,6 +723,7 @@ private BacktraceData SetupBacktraceData(BacktraceReport report)
                 : _backtraceLogManager.ToSourceCode();
 
             report.AssignSourceCodeToReport(sourceCode);
+            report.AttachmentPaths.AddRange(_clientReportAttachments);
 
             // pass copy of dictionary to prevent overriding client attributes
             var result = report.ToBacktraceData(null, GameObjectDepth);

Android/lib/armeabi-v7a/libcrashpad_handler.so

@@ -0,0 +1,66 @@
+using System;
+using System.IO;
+using UnityEngine;
+
+[assembly: System.Runtime.CompilerServices.InternalsVisibleTo("Backtrace.Unity.Tests.Runtime")]
+namespace Backtrace.Unity.Common
+{
+    internal static class ClientPathHelper
+    {
+        /// <summary>
+        /// Parse Backtrace client path string to full path
+        /// </summary>
+        /// <param name="path">Backtrace path with interpolated string and other Backtrace's improvements</param>
+        /// <returns>Full path to Backtrace file/directory</returns>
+        internal static string GetFulLPath(string path)
+        {
+            if (string.IsNullOrEmpty(path))
+            {
+                return string.Empty;
+            }
+
+            return path.ParseInterpolatedString().GetFullPath();
+        }
+
+        private static string ParseInterpolatedString(this string path)
+        {
+            // check if string has any interpolated substring 
+            var interpolationStart = path.IndexOf("${");
+            if (interpolationStart == -1)
+            {
+                return path;
+            }
+            var interpolationEnd = path.IndexOf('}', interpolationStart);
+            if (interpolationEnd == -1)
+            {
+                return path;
+            }
+            var interpolationValue = path.Substring(interpolationStart, interpolationEnd - interpolationStart + 1);
+            if (string.IsNullOrEmpty(interpolationValue))
+            {
+                return path;
+            }
+
+            switch (interpolationValue.ToLower())
+            {
+                case "${application.persistentdatapath}":
+                    return path.Replace(interpolationValue, Application.persistentDataPath);
+                case "${application.datapath}":
+                    return path.Replace(interpolationValue, Application.dataPath);
+                default:
+                    return path;
+            }
+
+        }
+
+        private static string GetFullPath(this string path)
+        {
+            if (!Path.IsPathRooted(path))
+            {
+                path = Path.Combine(Application.persistentDataPath, path);
+            }
+            return Path.GetFullPath(path);
+
+        }
+    }
+}