Version 3.1.2 - PII changes

konraddysput · web-flow · commit 3a348bbee407 · 2020-10-15T17:47:19.000+02:00
## Version 3.1.2
- `BacktraceData` allows to edit list of environment variables collected by `BacktraceAnnotations`
- `SourceCode` object description for PII purpose
` `Annotations` class exposes EnvironmentVariableCache dictionary - dictionary that stores environment variables collected by library. For example - to replace `USERNAME` environment variable collected by Backtrace library with random string you can easily edit annotations environment varaible and Backtrace-Untiy will reuse them on report creation.

* public environment variables + pii tests

* Version update

* Updated description for BacktraceData SourceCode integration

* Allow user to edit source code integration text

* more unit tests + better changelog description
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,23 @@
 # Backtrace Unity Release Notes
 
+## Version 3.1.2
+- `BacktraceData` allows to edit list of environment variables collected by `BacktraceAnnotations`
+- `SourceCode` object description for PII purpose
+` `Annotations` class exposes EnvironmentVariableCache dictionary - dictionary that stores environment variables collected by library. For example - to replace `USERNAME` environment variable collected by Backtrace library with random string you can easily edit annotations environment varaible and Backtrace-Untiy will reuse them on report creation.
+
+```csharp
+Annotations.EnvironmentVariablesCache["USERNAME"] = "%USERNAME%";
+```
+
+Also you can still use BeforeSend event to edit collected diagnostic data:
+```csharp
+  client.BeforeSend = (BacktraceData data) =>
+  {
+      data.Annotation.EnvironmentVariables["USERNAME"] = "%USERNAME%";
+      return data;
+  }
+```
+
 ## Version 3.1.1
 - Prevent erroneously extending backtraceClient attributes with backtraceReport attributes.
 - Removed randomly generated path to assembly from callstacks.
diff --git a/Runtime/Model/BacktraceData.cs b/Runtime/Model/BacktraceData.cs
@@ -45,7 +45,7 @@ public class BacktraceData
         /// <summary>
         /// Version of the C# library
         /// </summary>
-        public const string AgentVersion = "3.1.1";
+        public const string AgentVersion = "3.1.2";
 
         /// <summary>
         /// Application thread details
@@ -63,7 +63,7 @@ public class BacktraceData
         public string[] Classifier;
 
         /// <summary>
-        /// Source code information - right now we support source code only for BacktraceUnhandledException exceptions.
+        /// Source code information.
         /// </summary>
         public BacktraceSourceCode SourceCode;
 
diff --git a/Runtime/Model/BacktraceSourceCode.cs b/Runtime/Model/BacktraceSourceCode.cs
@@ -3,21 +3,39 @@
 
 namespace Backtrace.Unity.Model
 {
+    /// <summary>
+    /// Source code panel - in Unity integration, Backtrace-Unity stores unity Engine
+    /// logs in the Source Code integration.
+    /// </summary>
     public class BacktraceSourceCode
     {
-        public string Id = Guid.NewGuid().ToString();
+        /// <summary>
+        /// Source code id - integration uses id to assign source code to first stack frame
+        /// </summary>
+        public readonly string Id = Guid.NewGuid().ToString();
+        /// <summary>
+        /// Default source code type
+        /// </summary>
         public readonly string Type = "Text";
+        /// <summary>
+        /// Default source code title
+        /// </summary>
         public readonly string Title = "Log File";
 
-        public bool HighlightLine = false;
-        public string Text { get; set; }
+        /// <summary>
+        /// Required source code option -  we don't want to hightlight any line
+        /// </summary>
+        public readonly bool HighlightLine = false;
 
-        public BacktraceSourceCode()
-        {
-            Type = "Text";
-            Title = "Log File";
-        }
+        /// <summary>
+        /// Unity engine text
+        /// </summary>
+        public string Text { get; set; }
 
+        /// <summary>
+        /// Convert Source code integration into JSON object
+        /// </summary>
+        /// <returns>Source code BacktraceJObject</returns>
         internal BacktraceJObject ToJson()
         {
             var json = new BacktraceJObject();
diff --git a/Runtime/Model/JsonData/Annotations.cs b/Runtime/Model/JsonData/Annotations.cs
@@ -5,47 +5,23 @@
 using System.Text.RegularExpressions;
 using UnityEngine;
 using UnityEngine.SceneManagement;
-
 namespace Backtrace.Unity.Model.JsonData
 {
     /// <summary>
     /// Get report annotations - environment variables
     /// </summary>
     public class Annotations
     {
-
-        private static Dictionary<string, string> _variables;
-
-        /// <summary>
-        /// System environment values dictionary
-        /// </summary>
-        internal static Dictionary<string, string> Variables
-        {
-            get
-            {
-                if (_variables == null)
-                {
-                    _variables = new Dictionary<string, string>();
-                    foreach (DictionaryEntry variable in Environment.GetEnvironmentVariables())
-                    {
-                        _variables.Add(variable.Key.ToString(), Regex.Escape(variable.Value.ToString() ?? "NULL"));
-                    }
-                }
-
-                return _variables;
-            }
-        }
-
+        public static Dictionary<string, string> EnvironmentVariablesCache { get; set; } = SetEnvironmentVariables();
+        public Dictionary<string, string> EnvironmentVariables { get; set; } = EnvironmentVariablesCache;
         /// <summary>
         /// Set maximum number of game objects in Backtrace report
         /// </summary>
         private readonly int _gameObjectDepth;
-
         /// <summary>
         /// Exception object
         /// </summary>
-        private Exception _exception { get; set; }
-
+        public Exception Exception { get; set; }
         public Annotations()
         {
         }
@@ -57,37 +33,43 @@ public Annotations()
         public Annotations(Exception exception, int gameObjectDepth)
         {
             _gameObjectDepth = gameObjectDepth;
-            _exception = exception;
+            Exception = exception;
+        }
+        private static Dictionary<string, string> SetEnvironmentVariables()
+        {
+            var environmentVariables = new Dictionary<string, string>();
+            foreach (DictionaryEntry variable in Environment.GetEnvironmentVariables())
+            {
+                environmentVariables.Add(variable.Key.ToString(), Regex.Escape(variable.Value.ToString() ?? "NULL"));
+            }
+            return environmentVariables;
         }
-
         public BacktraceJObject ToJson()
         {
             var annotations = new BacktraceJObject();
             var envVariables = new BacktraceJObject();
-
-            foreach (var envVariable in Variables)
+            if (EnvironmentVariables != null)
             {
-                envVariables[envVariable.Key] = envVariable.Value;
+                foreach (var envVariable in EnvironmentVariables)
+                {
+                    envVariables[envVariable.Key] = envVariable.Value;
+                }
+                annotations["Environment Variables"] = envVariables;
             }
-            annotations["Environment Variables"] = envVariables;
-
-            if (_exception != null)
+            if (Exception != null)
             {
                 annotations["Exception properties"] = new BacktraceJObject()
                 {
-                    ["message"] = _exception.Message,
-                    ["stackTrace"] = _exception.StackTrace,
-                    ["type"] = _exception.GetType().FullName,
-                    ["source"] = _exception.Source
+                    ["message"] = Exception.Message,
+                    ["stackTrace"] = Exception.StackTrace,
+                    ["type"] = Exception.GetType().FullName,
+                    ["source"] = Exception.Source
                 };
             }
-
             if (_gameObjectDepth > -1)
             {
                 var activeScene = SceneManager.GetActiveScene();
-
                 var gameObjects = new List<BacktraceJObject>();
-
                 var rootObjects = new List<GameObject>();
                 activeScene.GetRootGameObjects(rootObjects);
                 foreach (var gameObject in rootObjects)
@@ -96,11 +78,8 @@ public BacktraceJObject ToJson()
                 }
                 annotations["Game objects"] = gameObjects;
             }
-
-
             return annotations;
         }
-
         private BacktraceJObject ConvertGameObject(GameObject gameObject, int depth = 0)
         {
             if (gameObject == null)
@@ -109,7 +88,6 @@ private BacktraceJObject ConvertGameObject(GameObject gameObject, int depth = 0)
             }
             var jGameObject = GetJObject(gameObject);
             var innerObjects = new List<BacktraceJObject>();
-
             foreach (var childObject in gameObject.transform)
             {
                 var transformChildObject = childObject as Component;
@@ -122,7 +100,6 @@ private BacktraceJObject ConvertGameObject(GameObject gameObject, int depth = 0)
             jGameObject["children"] = innerObjects;
             return jGameObject;
         }
-
         private BacktraceJObject ConvertGameObject(Component gameObject, string parentName, int depth)
         {
             if (_gameObjectDepth > 0 && depth > _gameObjectDepth)
@@ -135,8 +112,6 @@ private BacktraceJObject ConvertGameObject(Component gameObject, string parentNa
                 return result;
             }
             var innerObjects = new List<BacktraceJObject>();
-
-
             foreach (var childObject in gameObject.transform)
             {
                 var transformChildObject = childObject as Component;
@@ -149,7 +124,6 @@ private BacktraceJObject ConvertGameObject(Component gameObject, string parentNa
             result["children"] = innerObjects;
             return result;
         }
-
         private BacktraceJObject GetJObject(GameObject gameObject, string parentName = "")
         {
             var o = new BacktraceJObject();
@@ -166,7 +140,6 @@ private BacktraceJObject GetJObject(GameObject gameObject, string parentName = "
             o["parnetName"] = string.IsNullOrEmpty(parentName) ? "root object" : parentName;
             return o;
         }
-
         private BacktraceJObject GetJObject(Component gameObject, string parentName = "")
         {
             var o = new BacktraceJObject();
@@ -180,4 +153,4 @@ private BacktraceJObject GetJObject(Component gameObject, string parentName = ""
             return o;
         }
     }
-}
+}
diff --git a/Tests/Runtime/ClientSendTests.cs b/Tests/Runtime/ClientSendTests.cs
@@ -1,4 +1,5 @@
 ﻿using Backtrace.Unity.Model;
+using Backtrace.Unity.Model.JsonData;
 using NUnit.Framework;
 using System;
 using System.Collections;
@@ -71,5 +72,132 @@ public IEnumerator SendReport_MessageReport_ValidSend()
             Assert.IsTrue(trigger);
             yield return null;
         }
+
+        [UnityTest]
+        public IEnumerator PiiTests_ShouldRemoveEnvironmentVariables_AnnotationsShouldntBeAvailable()
+        {
+            var trigger = false;
+            var exception = new Exception("custom exception message");
+            client.BeforeSend = (BacktraceData data) =>
+             {
+                 Assert.IsNotNull(data.Annotation.EnvironmentVariables);
+                 data.Annotation.EnvironmentVariables = null;
+                 return data;
+             };
+
+            client.RequestHandler = (string url, BacktraceData data) =>
+            {
+                trigger = true;
+                Assert.IsNull(data.Annotation.EnvironmentVariables);
+                return new BacktraceResult();
+            };
+            client.Send(exception);
+
+            yield return new WaitForEndOfFrame();
+            Assert.IsTrue(trigger);
+            yield return null;
+        }
+
+        [UnityTest]
+        public IEnumerator PiiTests_ShouldChangeApplicationDataPath_ApplicationDataPathDoesntHaveUserNameAnymore()
+        {
+            var trigger = false;
+            var exception = new Exception("custom exception message");
+            var expectedDataPath = "/some/path";
+            client.BeforeSend = (BacktraceData data) =>
+            {
+                Assert.IsNotNull(data.Attributes.Attributes["application.data_path"]);
+                data.Attributes.Attributes["application.data_path"] = expectedDataPath;
+                return data;
+            };
+            client.RequestHandler = (string url, BacktraceData data) =>
+            {
+                trigger = true;
+                Assert.AreEqual(expectedDataPath, data.Attributes.Attributes["application.data_path"]);
+                return new BacktraceResult();
+            };
+            client.Send(exception);
+
+            yield return new WaitForEndOfFrame();
+            Assert.IsTrue(trigger);
+            yield return null;
+        }
+
+        [UnityTest]
+        public IEnumerator PiiTests_ShouldChangeSourceCodeIntegration_SourceCodeTextDoesntHaveUserNameAnymore()
+        {
+            var trigger = false;
+            var exception = new Exception("custom exception message");
+            var sourceCodeTestString = "source-code-test-string";
+            client.BeforeSend = (BacktraceData data) =>
+            {
+                Assert.IsNotNull(data.SourceCode);
+                Assert.IsNotEmpty(data.SourceCode.Text);
+                data.SourceCode.Text = sourceCodeTestString;
+                return data;
+            };
+            client.RequestHandler = (string url, BacktraceData data) =>
+            {
+                trigger = true;
+                Assert.AreEqual(sourceCodeTestString, data.SourceCode.Text);
+                return new BacktraceResult();
+            };
+            client.Send(exception);
+
+            yield return new WaitForEndOfFrame();
+            Assert.IsTrue(trigger);
+            yield return null;
+        }
+
+        [UnityTest]
+        public IEnumerator PiiTests_ShouldModifyEnvironmentVariable_IntegrationShouldUseModifiedEnvironmentVariables()
+        {
+            var trigger = false;
+            var exception = new Exception("custom exception message");
+
+            var environmentVariableKey = "foo";
+            var expectedValue = "bar";
+            Annotations.EnvironmentVariablesCache[environmentVariableKey] = expectedValue;
+
+            client.BeforeSend = (BacktraceData data) =>
+            {
+                var actualValue = data.Annotation.EnvironmentVariables[environmentVariableKey];
+                Assert.AreEqual(expectedValue, actualValue);
+                trigger = true;
+                return data;
+            };
+            client.Send(exception);
+
+            yield return new WaitForEndOfFrame();
+            Assert.IsTrue(trigger);
+            yield return null;
+        }
+
+
+        [UnityTest]
+        public IEnumerator PiiTests_ShouldRemoveEnvironmentVariableValue_IntegrationShouldUseModifiedEnvironmentVariables()
+        {
+            var trigger = false;
+            var exception = new Exception("custom exception message");
+
+            var environmentVariableKey = "USERNAME";
+            var expectedValue = "%USERNAME%";
+            var defaultUserName = Annotations.EnvironmentVariablesCache[environmentVariableKey];
+            Annotations.EnvironmentVariablesCache[environmentVariableKey] = expectedValue;
+
+            client.BeforeSend = (BacktraceData data) =>
+            {
+                var actualValue = data.Annotation.EnvironmentVariables[environmentVariableKey];
+                Assert.AreEqual(expectedValue, actualValue);
+                Assert.AreNotEqual(defaultUserName, actualValue);
+                trigger = true;
+                return data;
+            };
+            client.Send(exception);
+
+            yield return new WaitForEndOfFrame();
+            Assert.IsTrue(trigger);
+            yield return null;
+        }
     }
 }
diff --git a/package.json b/package.json
