Skip to content

Make env variable optional #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 4, 2025
Merged

Make env variable optional #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
919d21a
Make env variable optional
Mar 4, 2025
908fc8f
Add more tests for all specific situations
Mar 4, 2025
5d1bc56
Use different handler
Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 7 additions & 15 deletions Runtime/Model/JsonData/Annotations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,18 @@ public class Annotations
/// </summary>
internal static Dictionary<string, string> _environmentVariablesCache;

/// <summary>
/// Determinate if static helper should load environment variables or not.
/// </summary>
internal static bool VariablesLoaded;

/// <summary>
/// Loaded environment variables
/// </summary>
public static Dictionary<string, string> EnvironmentVariablesCache
{
get
{
if (VariablesLoaded == false)
{
_environmentVariablesCache = SetEnvironmentVariables();
VariablesLoaded = true;
}
return _environmentVariablesCache;
}
set
{
_environmentVariablesCache = value;
_environmentVariablesCache = SetEnvironmentVariables(value);
}
}

Expand Down Expand Up @@ -78,10 +68,9 @@ public Annotations(Exception exception, int gameObjectDepth)
Exception = exception;
}

private static Dictionary<string, string> SetEnvironmentVariables()
private static Dictionary<string, string> SetEnvironmentVariables(IDictionary environmentVariables)
{
var result = new Dictionary<string, string>();
var environmentVariables = Environment.GetEnvironmentVariables();
if (environmentVariables == null)
{
return result;
Expand All @@ -104,7 +93,10 @@ private static Dictionary<string, string> SetEnvironmentVariables()
public BacktraceJObject ToJson()
{
var annotations = new BacktraceJObject();
annotations.Add("Environment Variables", new BacktraceJObject(EnvironmentVariables));
if (EnvironmentVariables != null)
{
annotations.Add("Environment Variables", new BacktraceJObject(EnvironmentVariables));
}

if (Exception != null)
{
Expand Down Expand Up @@ -203,4 +195,4 @@ private BacktraceJObject GetJObject(Component gameObject, string parentName = ""
});
}
}
}
}
60 changes: 42 additions & 18 deletions Tests/Runtime/ClientSendTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
using NUnit.Framework;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
using UnityEngine.TestTools;

Expand All @@ -29,7 +31,7 @@ public void Setup()
public void Cleanup()
{
client.RequestHandler = null;
Annotations.VariablesLoaded = false;
Annotations.EnvironmentVariablesCache = null;
}

[UnityTest]
Expand Down Expand Up @@ -108,6 +110,9 @@ public IEnumerator PiiTests_ShouldModifyEnvironmentVariable_IntegrationShouldUse

var environmentVariableKey = "foo";
var expectedValue = "bar";
Annotations.EnvironmentVariablesCache = Environment.GetEnvironmentVariables()
.Cast<DictionaryEntry>()
.ToDictionary(entry => (string)entry.Key, entry => entry.Value as string);
Annotations.EnvironmentVariablesCache[environmentVariableKey] = expectedValue;

client.BeforeSend = (BacktraceData data) =>
Expand All @@ -124,31 +129,19 @@ public IEnumerator PiiTests_ShouldModifyEnvironmentVariable_IntegrationShouldUse
yield return null;
}


[UnityTest]
public IEnumerator PiiTests_ShouldRemoveEnvironmentVariableValue_IntegrationShouldUseModifiedEnvironmentVariables()
public IEnumerator PiiTests_ShouldNotIncludeEnvironmentVariable_IntegrationShouldSkipEnvironmentVariables()
{
var trigger = false;
var exception = new Exception("custom exception message");

var environmentVariableKey = "USERNAME";
var expectedValue = "%USERNAME%";
if (!Annotations.EnvironmentVariablesCache.ContainsKey(environmentVariableKey))
{
Annotations.EnvironmentVariablesCache[environmentVariableKey] = "fake user name";
}

var defaultUserName = Annotations.EnvironmentVariablesCache[environmentVariableKey];
Annotations.EnvironmentVariablesCache[environmentVariableKey] = expectedValue;

client.BeforeSend = (BacktraceData data) =>
client.RequestHandler = (string url, BacktraceData data) =>
{
var actualValue = data.Annotation.EnvironmentVariables[environmentVariableKey];
Assert.AreEqual(expectedValue, actualValue);
Assert.AreNotEqual(defaultUserName, actualValue);
trigger = true;
return data;
Assert.IsNull(data.Annotation.EnvironmentVariables);
return new BacktraceResult();
};

client.Send(exception);
yield return WaitForFrame.Wait();

Expand Down Expand Up @@ -180,5 +173,36 @@ public IEnumerator PiiTests_ShouldRemoveEnvironmentVariables_AnnotationsShouldnt
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%";
if (!Annotations.EnvironmentVariablesCache.ContainsKey(environmentVariableKey))
{
Annotations.EnvironmentVariablesCache[environmentVariableKey] = "fake user name";
}

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 WaitForFrame.Wait();

Assert.IsTrue(trigger);
yield return null;
}
}
}
Loading