tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-04-15 00:12:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Enhance ExceptionFormatter for AOT compatibility by adding fallback handling for stack frames.

Browse Source
This commit is contained in:
Phil Scott 2024-11-21 22:14:20 -05:00 committed by Patrik Svensson
parent 835143d95f
commit b2689be3ed
1 changed files with 28 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
src/Spectre.Console/Widgets/Exceptions/ExceptionFormatter.cs
View File

@ -1,11 +1,10 @@
namespace Spectre.Console; namespace Spectre.Console;
// ExceptionFormatter relies heavily on reflection of types unknown until runtime. // ExceptionFormatter relies heavily on reflection of types unknown until runtime.
// We'll suppress these warnings, but alert the user this method is not supported.
[UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2026:RequiresUnreferencedCode")] [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2026:RequiresUnreferencedCode")]
[UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2070:RequiresUnreferencedCode")] [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2070:RequiresUnreferencedCode")]
[UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2075:RequiresUnreferencedCode")] [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2075:RequiresUnreferencedCode")]
[RequiresDynamicCode(AotWarning)] [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL3050:RequiresUnreferencedCode")]
internal static class ExceptionFormatter internal static class ExceptionFormatter
{ {
public const string AotWarning = "ExceptionFormatter is currently not supported for AOT."; public const string AotWarning = "ExceptionFormatter is currently not supported for AOT.";
@ -27,13 +26,6 @@ internal static class ExceptionFormatter
throw new ArgumentNullException(nameof(exception)); throw new ArgumentNullException(nameof(exception));
} }
// fallback to default ToString() if someone in an AOT is insisting on using this method
var stackTrace = new StackTrace(exception, fNeedFileInfo: false);
if (stackTrace.GetFrame(0)?.GetMethod() is null)
{
return new Text(exception.ToString());
}
return new Rows(GetMessage(exception, settings), GetStackFrames(exception, settings)).Expand(); return new Rows(GetMessage(exception, settings), GetStackFrames(exception, settings)).Expand();
} }
@ -71,8 +63,16 @@ internal static class ExceptionFormatter
} }
var stackTrace = new StackTrace(ex, fNeedFileInfo: true); var stackTrace = new StackTrace(ex, fNeedFileInfo: true);
var frames = stackTrace var allFrames = stackTrace.GetFrames();
.GetFrames() if (allFrames[0]?.GetMethod() == null)
{
// if we can't easily get the method for the frame, then we are in AOT
// fallback to using ToString method of each frame.
WriteAotFrames(grid, stackTrace.GetFrames(), styles);
return grid;
}
var frames = allFrames
.FilterStackFrames() .FilterStackFrames()
.ToList(); .ToList();
@ -133,6 +133,23 @@ internal static class ExceptionFormatter
return grid; return grid;
} }
private static void WriteAotFrames(Grid grid, StackFrame?[] frames, ExceptionStyle styles)
{
foreach (var stackFrame in frames)
{
if (stackFrame == null)
{
continue;
}
var s = stackFrame.ToString();
s = s.Replace(" in file:line:column <filename unknown>:0:0", string.Empty).TrimEnd();
grid.AddRow(
$"[{styles.Dimmed.ToMarkup()}]at[/]",
s.EscapeMarkup());
}
}
private static void AppendParameters(StringBuilder builder, MethodBase? method, ExceptionSettings settings) private static void AppendParameters(StringBuilder builder, MethodBase? method, ExceptionSettings settings)
{ {
var typeColor = settings.Style.ParameterType.ToMarkup(); var typeColor = settings.Style.ParameterType.ToMarkup();