Exception source code (#19)

* Include source code to the exception/message reports

* Changelog update + version update

* Removed redundant function

Author: konraddysput

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Backtrace Unity Release Notes
 
+## Version 2.1.5
+
+- Added exception source code information to exception and message type of reports.
+
 ## Version 2.1.4
 
 - `EnvironmentVariable` class now will handle correctly nullable key/values,

Runtime/Model/BacktraceData.cs

@@ -174,18 +174,13 @@ public static BacktraceData Deserialize(string json)
         /// </summary>
         private void SetThreadInformations()
         {
-            var faultingThread = 
-                Report.Exception is BacktraceUnhandledException 
-                && string.IsNullOrEmpty(Report.Exception.StackTrace)
-                ? false
-                : true;
+            var faultingThread = !(Report.Exception is BacktraceUnhandledException
+                && string.IsNullOrEmpty(Report.Exception.StackTrace));
+
             ThreadData = new ThreadData(Report.DiagnosticStack, faultingThread);
             ThreadInformations = ThreadData.ThreadInformations;
             MainThread = ThreadData.MainThread;
-            if (Report.Exception is BacktraceUnhandledException)
-            {
-                SourceCode = (Report.Exception as BacktraceUnhandledException).SourceCode;
-            }
+            SourceCode = Report.SourceCode;
         }
 
         /// <summary>
@@ -211,7 +206,7 @@ private void SetReportInformation()
             LangVersion = "Mono";
 #endif
 
-            AgentVersion = "2.1.4";
+            AgentVersion = "2.1.5";
             Classifier = Report.ExceptionTypeReport ? new[] { Report.Classifier } : null;
         }
     }

Runtime/Model/BacktraceReport.cs

@@ -80,6 +80,11 @@ public class BacktraceReport
         [JsonProperty(PropertyName = "minidumpFile")]
         internal string MinidumpFile { get; private set; }
 
+        /// <summary>
+        /// Source code
+        /// </summary>
+        public BacktraceSourceCode SourceCode = null;
+
         /// <summary>
         /// Convert Backtrace report to JSON
         /// </summary>
@@ -171,6 +176,9 @@ public BacktraceReport(
             : this(null as Exception, attributes, attachmentPaths)
         {
             Message = message;
+            // analyse stack trace information in both constructor 
+            // to include error message in both source code properties.
+            SetStacktraceInformation();
         }
 
         /// <summary>
@@ -192,9 +200,9 @@ public BacktraceReport(
             {
                 Message = exception.Message;
                 SetReportFingerPrintForEmptyStackTrace();
+                SetStacktraceInformation();
             }
             Classifier = ExceptionTypeReport ? exception.GetType().Name : string.Empty;
-            SetStacktraceInformation();
         }
 
         /// <summary>
@@ -249,8 +257,9 @@ internal static Dictionary<string, object> ConcatAttributes(
 
         internal void SetStacktraceInformation()
         {
-            var stacktrace = new BacktraceStackTrace(Exception);
+            var stacktrace = new BacktraceStackTrace(Message, Exception);
             DiagnosticStack = stacktrace.StackFrames;
+            SourceCode = stacktrace.SourceCode;
         }
         /// <summary>
         /// create a copy of BacktraceReport for inner exception object inside exception

Runtime/Model/BacktraceStackFrame.cs

@@ -165,5 +165,10 @@ private string GetMethodName(StackFrame frame)
             string fullMethodName = string.Format("{0}.{1}()", method.DeclaringType == null ? null : method.DeclaringType.ToString(), methodName);
             return fullMethodName;
         }
+
+        public override string ToString()
+        {
+            return string.Format("{0} (at {1}:{2})", FunctionName, Library, Line);
+        }
     }
 }

Runtime/Model/BacktraceStackTrace.cs

@@ -1,28 +1,45 @@
-using Backtrace.Unity.Common;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.Reflection;
+using System.Linq;
 
 namespace Backtrace.Unity.Model
 {
     /// <summary>
     /// Backtrace stack trace
     /// </summary>
-    public class BacktraceStackTrace
+    internal class BacktraceStackTrace
     {
         /// <summary>
         /// Stack trace frames
         /// </summary>
-        public List<BacktraceStackFrame> StackFrames = new List<BacktraceStackFrame>();
+        public readonly List<BacktraceStackFrame> StackFrames = new List<BacktraceStackFrame>();
+
+        public BacktraceSourceCode SourceCode = null;
 
         /// <summary>
         /// Current exception
         /// </summary>
         private readonly Exception _exception;
-        public BacktraceStackTrace(Exception exception)
+
+        /// <summary>
+        /// Report message
+        /// </summary>
+        private readonly string _message;
+
+        /// <summary>
+        /// Report stack trace
+        /// </summary>
+        private string _stackTrace = string.Empty;
+
+        public BacktraceStackTrace(string message, Exception exception)
         {
+            _message = message;
             _exception = exception;
+            if (exception != null)
+            {
+                _stackTrace = exception.StackTrace;
+            }
             Initialize();
         }
 
@@ -35,11 +52,12 @@ private void Initialize()
                 {
                     var current = _exception as BacktraceUnhandledException;
                     StackFrames.InsertRange(0, current.StackFrames);
+                    SourceCode = current.SourceCode;
+                    return;
                 }
                 else
                 {
                     var exceptionStackTrace = new StackTrace(_exception, true);
-
                     var exceptionFrames = exceptionStackTrace.GetFrames();
                     SetStacktraceInformation(exceptionFrames, true);
                 }
@@ -51,7 +69,12 @@ private void Initialize()
                 //reverse frame order
                 var frames = stackTrace.GetFrames();
                 SetStacktraceInformation(frames, generateExceptionInformation);
+                if (StackFrames.Any())
+                {
+                    _stackTrace = string.Join("\n", StackFrames.Select(n => n.ToString()));
+                }
             }
+            CreateUnhandledExceptionLogInformation();
         }
 
         private void SetStacktraceInformation(StackFrame[] frames, bool generatedByException = false)
@@ -78,5 +101,29 @@ private void SetStacktraceInformation(StackFrame[] frames, bool generatedByExcep
                 startingIndex++;
             }
         }
+
+
+        /// <summary>
+        /// Assign source code information to first stack frame of unhandled exception report
+        /// </summary>
+        private void CreateUnhandledExceptionLogInformation()
+        {
+            // we can't assign source code to any stack frame.
+            if (!StackFrames.Any())
+            {
+                return;
+            }
+
+            SourceCode = new BacktraceSourceCode()
+            {
+                Text = string.Format("Unity exception information\nMessage: {0}\nStack trace: {1}", _message, _stackTrace)
+            };
+            // assign log information to first stack frame
+            if (StackFrames.Count == 0)
+            {
+                return;
+            }
+            StackFrames.First().SourceCode = SourceCode.Id.ToString();
+        }
     }
 }

Runtime/Model/BacktraceUnhandledException.cs

@@ -51,7 +51,7 @@ public BacktraceUnhandledException(string message, string stacktrace) : base(mes
             } else
             {
                 _stacktrace = string.Empty;
-                var backtraceStackTrace = new BacktraceStackTrace(null);
+                var backtraceStackTrace = new BacktraceStackTrace(message, null);
                 StackFrames = backtraceStackTrace.StackFrames;
             }
             CreateUnhandledExceptionLogInformation();

Tests/Runtime/BacktraceStackTraceTests.cs

@@ -114,7 +114,7 @@ public IEnumerator TestReportStackTrace_StackTraceShouldIncludeEnvironmentStackT
         [UnityTest]
         public IEnumerator TestStackTraceCreation_EmptyStackTrace_ValidStackTraceObject()
         {
-            var backtraceStackTrace = new BacktraceStackTrace(new Exception());
+            var backtraceStackTrace = new BacktraceStackTrace(string.Empty, new Exception());
             Assert.IsTrue(backtraceStackTrace.StackFrames.Count == 0);
             yield return null;
         }
@@ -134,7 +134,7 @@ public IEnumerator TestStackTraceCreation_UnityEngineException_ValidStackTraceOb
 
                 string message = "message";
                 var exception = new BacktraceUnhandledException(message, stackTrace);
-                var backtraceStackTrace = new BacktraceStackTrace(exception);
+                var backtraceStackTrace = new BacktraceStackTrace(string.Empty, exception);
 
                 //skip first frame
                 int startIndex = exception.Header ? 1 : 0;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "io.backtrace.unity",
   "displayName": "Backtrace",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "unity": "2017.1",
   "description": "Backtrace's integration with Unity games allows customers to capture and report handled and unhandled Unity exceptions to their Backtrace instance, instantly offering the ability to prioritize and debug software errors.",
   "keywords": [