Skip to content

Determine library name based on the namespace/function name #175

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 1 commit into from
Nov 10, 2022
Merged

Determine library name based on the namespace/function name #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions Runtime/Model/BacktraceUnhandledException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,19 @@ private BacktraceStackFrame SetJITStackTraceInformation(string frameString)
{
stackFrame.FunctionName = frameString;
}

if (!string.IsNullOrEmpty(stackFrame.FunctionName))
{
var libraryNameSeparator = stackFrame.FunctionName.IndexOf(':');
if (libraryNameSeparator != -1)
{
stackFrame.Library = stackFrame.FunctionName.Substring(0, libraryNameSeparator).Trim();
stackFrame.FunctionName = stackFrame.FunctionName.Substring(++libraryNameSeparator).Trim();
} else
{
stackFrame.Library = "native";
}
}
return stackFrame;

}
Expand Down Expand Up @@ -412,6 +425,10 @@ private BacktraceStackFrame SetDefaultStackTraceInformation(string frameString,
result.Library = null;
}
}
if (string.IsNullOrEmpty(result.Library))
{
result.Library = result.FunctionName.Substring(0, result.FunctionName.LastIndexOf(".", result.FunctionName.IndexOf("(")));
}
}
return result;
}
Expand Down
33 changes: 30 additions & 3 deletions Tests/Runtime/BacktraceStackTraceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,8 +517,12 @@ public void JITStackTrace_ShouldParseCorrectlyJITStackTrace_StackTraceObjectIsGe
{

var simpleFunctionName = "GetStacktrace";
var functionNameWithWrappedManagedPrefix = "UnityEngine.DebugLogHandler:Internal_Log";
var functioNamewithMonoJitCodePrefix = "ServerGameManager:SendInitialiseNetObjectToClient";
var libraryNameWithWrappedManagedPrefix = "UnityEngine.DebugLogHandler";
var functionNameWithWrappedManagedPrefix = "Internal_Log";
var stackFrameWithManagedPrefix = string.Format("{0}:{1}", libraryNameWithWrappedManagedPrefix, functionNameWithWrappedManagedPrefix);
var libraryNamewithMonoJitCodePrefix = "ServerGameManager";
var functioNamewithMonoJitCodePrefix = "SendInitialiseNetObjectToClient";
var stackFrameWithMonoJitCodePrefix = string.Format("{0}:{1}", libraryNamewithMonoJitCodePrefix, functioNamewithMonoJitCodePrefix);
var jitStackTrace = string.Format(@"#0 {0} (int)
#1 DebugStringToFile(DebugStringToFileData const&)
#2 DebugLogHandler_CUSTOM_Internal_Log(LogType, LogOption, ScriptingBackendNativeStringPtrOpaque*, ScriptingBackendNativeObjectPtrOpaque*)
Expand All @@ -530,15 +534,17 @@ public void JITStackTrace_ShouldParseCorrectlyJITStackTrace_StackTraceObjectIsGe
#8 (Mono JIT Code) FG.Common.UnityNetworkMessageHandler:HandleAndFreeInboundGameMessage (FG.Common.MessageEnvelope)
#9 (Mono JIT Code) FG.Common.UnityNetworkMessageHandler:PeekAndHandleMessage (UnityEngine.Networking.NetworkMessage,FG.Common.GameConnection)
#10 (Mono JIT Code) FG.Common.FG_UnityInternetNetworkManager:ServerHandleMessageReceived (UnityEngine.Networking.NetworkMessage)",
simpleFunctionName, functionNameWithWrappedManagedPrefix, functioNamewithMonoJitCodePrefix);
simpleFunctionName, stackFrameWithManagedPrefix, stackFrameWithMonoJitCodePrefix);


var backtraceUnhandledException = new BacktraceUnhandledException("foo", jitStackTrace);

Assert.AreEqual(11, backtraceUnhandledException.StackFrames.Count);
Assert.AreEqual(backtraceUnhandledException.StackFrames[0].FunctionName, simpleFunctionName);
Assert.AreEqual(backtraceUnhandledException.StackFrames[3].FunctionName, functionNameWithWrappedManagedPrefix);
Assert.AreEqual(backtraceUnhandledException.StackFrames[3].Library, libraryNameWithWrappedManagedPrefix);
Assert.AreEqual(backtraceUnhandledException.StackFrames[4].FunctionName, functioNamewithMonoJitCodePrefix);
Assert.AreEqual(backtraceUnhandledException.StackFrames[4].Library, libraryNamewithMonoJitCodePrefix);
}

[Test]
Expand Down Expand Up @@ -566,6 +572,27 @@ public void XboxStackTrace_ShouldIgnoreAndroidFrames_ShouldSetCsharpExtensionCor
Assert.IsTrue(frame.FunctionName.StartsWith("Unity.Entities."));
}
}
[Test]
public void LibraryName_ShouldCorrectlyFindLibraryNameOnProductionBuild_LibraryNameAvailable()
{
var defaultLibraryNamespace = "UnitTestLibrary";
var additionalLibraryName = "AdditionalLibraryName";
var genericLibraryName = "Generic+WithPlus";
var stackTrace = string.Format(@"{0}.{1}.get_PlayerResults () (at <00000000000000000000000000000000>:0)
{0}.{2}.DoSomething (Session.Parameter session, System.Boolean test) (at <00000000000000000000000000000000>:0)
{0}.Generator`2[TOwner,TSignal].ProcessSignal () (at <00000000000000000000000000000000>:0)
{0}.OtherGenerator`2[TOwner,TSignal].Update () (at <00000000000000000000000000000000>:0)
{0}.State.OnUpdate () (at <00000000000000000000000000000000>:0)
{0}.DifferentState.StateUpdate () (at <00000000000000000000000000000000>:0)
{0}.State+InnerState_Active.Update (Advanced.Parameter.State state) (at <00000000000000000000000000000000>:0)",
defaultLibraryNamespace, additionalLibraryName, genericLibraryName);

var backtraceUnhandledException = new BacktraceUnhandledException("foo", stackTrace);

Assert.AreEqual(backtraceUnhandledException.StackFrames[0].Library, string.Format("{0}.{1}", defaultLibraryNamespace, additionalLibraryName));
Assert.AreEqual(backtraceUnhandledException.StackFrames[1].Library, string.Format("{0}.{1}", defaultLibraryNamespace, genericLibraryName));

}

internal string ConvertStackTraceToString(List<SampleStackFrame> data)
{
Expand Down