Report fingerprint (#20)

* Include source code to the exception/message reports

* Menu changes

* Deduplicaiton UI improvements + UI tooltips + UI headers + collapsible menu

* Added Jason feedback

* Normalized error message

* Change log and readme update + library version update

* changed tooltips

* Docs update

Author: konraddysput

CHANGELOG.md

@@ -1,117 +1,120 @@
-# 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,
-- `BacktraceAttributes` handle correctly nullable values.
-
-## Version 2.1.3
-
-- `BacktraceUnhandledException` will generate environment stack trace if Unity stack trace is empty. BacktraceReport will still generate normalized fingerprint for unhandled exception without stack trace.
-- `BacktraceUnhandledException` will provide information from Unity Error logger in source code property, which should improve error analysis in web debugger.
-- `BacktraceAttributes` won't try to collect `Annotations` anymore.
-- `Annotations` won't use ComplexAttributes property anymore.
-
-## Version 2.1.2
-
-- `BacktraceReport` will generate report fingerprint for exceptions without stack trace.
-- Changed game object depth default property value.
-- Added Exception information to the Annotation object.
-
-## Version 2.1.1
-
-- UPM modifications - fixed editor assembly definition,
-- Hiding Documentation and Scripts folders
-- Added Mac and Rider files to .gitignore
-- Moved Backtrace Configuration create menu deeper into the hierarchy
-
-## Version 2.1.0
-
-- UPM support - changed project structure and divide Backtrae-unity plugin into assemblies.
-
-## Version 2.0.5
-
-- Unity compatibility patch - .NET2.0, .NET 3.5 support (https://github.com/backtrace-labs/backtrace-unity/pull/10).
-- Untiy .NET Standard 2.0 support.
-- Expose minidump type option to Backtrace Client configuration in the UI.
-- Changed values of LangVersion to Mono or IL2CPP, depending on which is deployed.
-- Changed `Game object depth` property - default to `-1`, which means not to include Game Objects Hierarchy as an Annotation in the error report. Set the value to `1` to collect one level deep of Gane Object hierarchy, `2` to collect two levels deep, and so on. Setting the value to `0` will collect the full depth, which may be rather large if you have a lot of children.
-
-## Version 2.0.4
-
-- Added Game object depth property that allows developer to filter game object childrens in Backtrace report
-- Changed "Destroy client on new scene load" label. Now: "Destroy client on new scene load (false - Backtrace managed),
-- added namespaces to `XmlNodeConverter` class,
-- Added correct path to source file in `BacktraceUnhnandledException`,
-- Changed line endings in `BacktraceDatabase`, `ReportLimitWatcher`, `BacktraceClient` files,
-- Changed `ReactTransform` casting to `Component` in `Annotations` class. With this change Backtrace library should correctly send all game objects to Backtrace,
-- Changed a way how we guess game assets directory.
-
-## Version 2.0.3
-
-- Annotations object will validate game object before converting it.
-
-## Version 2.0.2
-
-- Fixed invalid cast for nested game objects in Backtrace Attributes,
-- BacktraceClient will print message only once per report rate limit hit per 1 minute.
-- `BacktraceDatabase` `Send` method will check client rate limit after each send.
-- `BacktraceClient` and `BacktraceDatabase` won't generate warning on `Disabled` event.
-
-## Version 2.0.1
-
-- `BacktraceApi` won't print anymore Error message when Backtrace-integration cannot send data to Backtrace. Now `BacktraceApi` will print warning instead.
-
-## Version 2.0.0
-
-- Backtrace-Unity plugin will set `"Destroy object on new scene"` by default to false.
-- Backtrace stack trace improvements,
-- `BacktraceDatabase` retry method now respect correctly `BacktraceDatabase` `retryInterval` property,
-- New `Backtrace Configuration` won't override existing `Backtrace Configuration` in configuration directory.
-- Backtrace-Unity plugin tests now won't override some files in Backtrace-Database unit tests,
-- Backtrace-Unity plugin now allows you to setup client side deduplication rules via `Fingerprint`. By using this field you can limit reporting of an error that occurs many times over a few frames.
-- Backtrace report limit watcher feature now will validate limits before BacktraceReport creation.
-- `BacktraceClient` and `BacktraceDatabase` now expose `Reload` method. You can use this method do dynamically change `BacktraceClient`/`BacktraceDatabase` configurations.
-
-## Version 1.1.5 - 09.01.2019
-
-- Added support to DontDestroyOnLoad property. Right now users might use this property to store `BacktraceClient`/`BacktraceDatabase` instances between all game scenes.
-- Added more attributes to `BacktraceReport` object,
-- Added scene game objects information to `BacktraceReport` annotations.
-
-## Version 1.1.4 - 27.08.2019
-
-- Added support for servies under proxy (removed backtrace.sp conditions)
-
-## Version 1.1.3 - 07.06.2019
-
-- Removed error log when unity-plugin receive status code: 200 on attachment upload.
-
-## Version 1.1.2 - 06.06.2019
-
-- Changed a way how Unity-plugin upload attachments to Backtrace via `submit.backtrace.io`
-
-## Version 1.1.1 - 28.03.2019
-
-- Detailed log information when Unity plugin cannot send data to Backtrace,
-- Unhandled exception condition that wont catch exceptions that starts with string : `[Backtrace]::`,
-- Added support for system stack frames,
-- Line ending fix.
-
-## Version 1.1.0 - 06.03.2019
-
-- Support for multiple types of Attribute types - string, char, enum, int, float, double....
-- Support for submit.backtrace.io
-- If you send exception, `BacktraceReport` will generate stack trace based on exception stack trace. We will no longer include environment stack trace in exception reports,
-- `BacktraceDatabase` fix for `FirstOrDefault` invalid read,
-- Fixed duplicated global exception handler,
-- Fixed typo in debug Attribute,
-- Fixed stack trace in `BacktraceUnhandledException` object,
-
-## Version 1.0.0 - 21.11.2018
-
-First Backtrace-Unity plugin version
+# Backtrace Unity Release Notes
+
+## Version 2.1.5
+
+- Backtrace Unity plugin UI improvements - added tooltips, headers and collapsible menu for advanced options.
+- Changed Client-side deduplication menu,
+- `BacktraceClient` now allows you to choose what type of fingerprint Backtrace should generate for reports without stack trace. `Use normalized exception message` allows you to use a normalized exception message to generate fingerprint, instead of stack trace.
+- 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,
+- `BacktraceAttributes` handle correctly nullable values.
+
+## Version 2.1.3
+
+- `BacktraceUnhandledException` will generate environment stack trace if Unity stack trace is empty. BacktraceReport will still generate normalized fingerprint for unhandled exception without stack trace.
+- `BacktraceUnhandledException` will provide information from Unity Error logger in source code property, which should improve error analysis in web debugger.
+- `BacktraceAttributes` won't try to collect `Annotations` anymore.
+- `Annotations` won't use ComplexAttributes property anymore.
+
+## Version 2.1.2
+
+- `BacktraceReport` will generate report fingerprint for exceptions without stack trace.
+- Changed game object depth default property value.
+- Added Exception information to the Annotation object.
+
+## Version 2.1.1
+
+- UPM modifications - fixed editor assembly definition,
+- Hiding Documentation and Scripts folders
+- Added Mac and Rider files to .gitignore
+- Moved Backtrace Configuration create menu deeper into the hierarchy
+
+## Version 2.1.0
+
+- UPM support - changed project structure and divide Backtrae-unity plugin into assemblies.
+
+## Version 2.0.5
+
+- Unity compatibility patch - .NET2.0, .NET 3.5 support (https://github.com/backtrace-labs/backtrace-unity/pull/10).
+- Untiy .NET Standard 2.0 support.
+- Expose minidump type option to Backtrace Client configuration in the UI.
+- Changed values of LangVersion to Mono or IL2CPP, depending on which is deployed.
+- Changed `Game object depth` property - default to `-1`, which means not to include Game Objects Hierarchy as an Annotation in the error report. Set the value to `1` to collect one level deep of Gane Object hierarchy, `2` to collect two levels deep, and so on. Setting the value to `0` will collect the full depth, which may be rather large if you have a lot of children.
+
+## Version 2.0.4
+
+- Added Game object depth property that allows developer to filter game object childrens in Backtrace report
+- Changed "Destroy client on new scene load" label. Now: "Destroy client on new scene load (false - Backtrace managed),
+- added namespaces to `XmlNodeConverter` class,
+- Added correct path to source file in `BacktraceUnhnandledException`,
+- Changed line endings in `BacktraceDatabase`, `ReportLimitWatcher`, `BacktraceClient` files,
+- Changed `ReactTransform` casting to `Component` in `Annotations` class. With this change Backtrace library should correctly send all game objects to Backtrace,
+- Changed a way how we guess game assets directory.
+
+## Version 2.0.3
+
+- Annotations object will validate game object before converting it.
+
+## Version 2.0.2
+
+- Fixed invalid cast for nested game objects in Backtrace Attributes,
+- BacktraceClient will print message only once per report rate limit hit per 1 minute.
+- `BacktraceDatabase` `Send` method will check client rate limit after each send.
+- `BacktraceClient` and `BacktraceDatabase` won't generate warning on `Disabled` event.
+
+## Version 2.0.1
+
+- `BacktraceApi` won't print anymore Error message when Backtrace-integration cannot send data to Backtrace. Now `BacktraceApi` will print warning instead.
+
+## Version 2.0.0
+
+- Backtrace-Unity plugin will set `"Destroy object on new scene"` by default to false.
+- Backtrace stack trace improvements,
+- `BacktraceDatabase` retry method now respect correctly `BacktraceDatabase` `retryInterval` property,
+- New `Backtrace Configuration` won't override existing `Backtrace Configuration` in configuration directory.
+- Backtrace-Unity plugin tests now won't override some files in Backtrace-Database unit tests,
+- Backtrace-Unity plugin now allows you to setup client-side deduplication rules via `Fingerprint`. By using this field you can limit reporting of an error that occurs many times over a few frames.
+- Backtrace report limit watcher feature now will validate limits before BacktraceReport creation.
+- `BacktraceClient` and `BacktraceDatabase` now expose `Reload` method. You can use this method do dynamically change `BacktraceClient`/`BacktraceDatabase` configurations.
+
+## Version 1.1.5 - 09.01.2019
+
+- Added support to DontDestroyOnLoad property. Right now users might use this property to store `BacktraceClient`/`BacktraceDatabase` instances between all game scenes.
+- Added more attributes to `BacktraceReport` object,
+- Added scene game objects information to `BacktraceReport` annotations.
+
+## Version 1.1.4 - 27.08.2019
+
+- Added support for servies under proxy (removed backtrace.sp conditions)
+
+## Version 1.1.3 - 07.06.2019
+
+- Removed error log when unity-plugin receive status code: 200 on attachment upload.
+
+## Version 1.1.2 - 06.06.2019
+
+- Changed a way how Unity-plugin upload attachments to Backtrace via `submit.backtrace.io`
+
+## Version 1.1.1 - 28.03.2019
+
+- Detailed log information when Unity plugin cannot send data to Backtrace,
+- Unhandled exception condition that wont catch exceptions that starts with string : `[Backtrace]::`,
+- Added support for system stack frames,
+- Line ending fix.
+
+## Version 1.1.0 - 06.03.2019
+
+- Support for multiple types of Attribute types - string, char, enum, int, float, double....
+- Support for submit.backtrace.io
+- If you send exception, `BacktraceReport` will generate stack trace based on exception stack trace. We will no longer include environment stack trace in exception reports,
+- `BacktraceDatabase` fix for `FirstOrDefault` invalid read,
+- Fixed duplicated global exception handler,
+- Fixed typo in debug Attribute,
+- Fixed stack trace in `BacktraceUnhandledException` object,
+
+## Version 1.0.0 - 21.11.2018
+
+First Backtrace-Unity plugin version

Editor/BacktraceClientConfigurationEditor.cs

@@ -1,50 +1,32 @@
 using Backtrace.Unity.Model;
-using Backtrace.Unity.Types;
-using System.IO;
 using UnityEditor;
-using UnityEngine;
 
 namespace Backtrace.Unity.Editor
 {
     [CustomEditor(typeof(BacktraceClientConfiguration))]
     public class BacktraceClientConfigurationEditor : UnityEditor.Editor
     {
-        public const string LABEL_SERVER_URL = "Server Address";
-        public const string LABEL_REPORT_PER_MIN = "Reports per minute";
-        public const string LABEL_HANDLE_UNHANDLED_EXCEPTION = "Handle unhandled exceptions";
-
-#if UNITY_2018_4_OR_NEWER
-        public const string LABEL_IGNORE_SSL_VALIDATION = "Ignore SSL validation";
-#endif
-        public const string LABEL_MINIDUMP_SUPPORT = "Minidump type";
-        public const string LABEL_DEDUPLICATION_RULES = "Deduplication rules";
-        public const string LABEL_GAME_OBJECT_DEPTH = "Game object depth limit";
-
-        public const string LABEL_DESTROY_CLIENT_ON_SCENE_LOAD = "Destroy client on new scene load (false - Backtrace managed)";
-
-
         public override void OnInspectorGUI()
         {
             var settings = (BacktraceClientConfiguration)target;
 
-            settings.ServerUrl = EditorGUILayout.TextField(LABEL_SERVER_URL, settings.ServerUrl);
+            settings.ServerUrl = EditorGUILayout.TextField(BacktraceConfigurationLabels.LABEL_SERVER_URL, settings.ServerUrl);
             settings.UpdateServerUrl();
             if (!settings.ValidateServerUrl())
             {
                 EditorGUILayout.HelpBox("Detected different pattern of url. Please make sure you passed valid Backtrace url", MessageType.Warning);
             }
 
-            settings.DestroyOnLoad = EditorGUILayout.Toggle(LABEL_DESTROY_CLIENT_ON_SCENE_LOAD, settings.DestroyOnLoad);
-            settings.ReportPerMin = EditorGUILayout.IntField(LABEL_REPORT_PER_MIN, settings.ReportPerMin);
-            settings.HandleUnhandledExceptions = EditorGUILayout.Toggle(LABEL_HANDLE_UNHANDLED_EXCEPTION, settings.HandleUnhandledExceptions);
+            settings.DestroyOnLoad = EditorGUILayout.Toggle(BacktraceConfigurationLabels.LABEL_DESTROY_CLIENT_ON_SCENE_LOAD, settings.DestroyOnLoad);
+            settings.ReportPerMin = EditorGUILayout.IntField(BacktraceConfigurationLabels.LABEL_REPORT_PER_MIN, settings.ReportPerMin);
+            settings.HandleUnhandledExceptions = EditorGUILayout.Toggle(BacktraceConfigurationLabels.LABEL_HANDLE_UNHANDLED_EXCEPTION, settings.HandleUnhandledExceptions);
 
 #if UNITY_2018_4_OR_NEWER
-            settings.IgnoreSslValidation = EditorGUILayout.Toggle(LABEL_IGNORE_SSL_VALIDATION, settings.IgnoreSslValidation);
+            settings.IgnoreSslValidation = EditorGUILayout.Toggle(BacktraceConfigurationLabels.LABEL_IGNORE_SSL_VALIDATION, settings.IgnoreSslValidation);
 #else
             settings.IgnoreSslValidation = false;
 #endif
-            settings.DeduplicationStrategy = (DeduplicationStrategy)EditorGUILayout.EnumPopup(LABEL_DEDUPLICATION_RULES, settings.DeduplicationStrategy);
-            settings.GameObjectDepth = EditorGUILayout.IntField(LABEL_GAME_OBJECT_DEPTH, settings.GameObjectDepth);
+            settings.GameObjectDepth = EditorGUILayout.IntField(BacktraceConfigurationLabels.LABEL_GAME_OBJECT_DEPTH, settings.GameObjectDepth);
         }
     }
 

Editor/BacktraceClientEditor.cs

@@ -1,6 +1,5 @@
 using Backtrace.Unity.Model;
 using UnityEditor;
-using UnityEngine;
 
 namespace Backtrace.Unity.Editor
 {