Files
UnrealEngine/Engine/Source/Programs/Shared/EpicGames.Horde/Issues/Handlers/SanitizerIssueHandler.cs
2025-05-18 13:04:45 +08:00

87 lines
3.2 KiB
C#

// Copyright Epic Games, Inc. All Rights Reserved.
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using EpicGames.Core;
using Microsoft.Extensions.Logging;
namespace EpicGames.Horde.Issues.Handlers
{
/// <summary>
/// Instance of a specific Thread Sanitizer error
/// </summary>
[IssueHandler]
public class SanitizerIssueHandler : IssueHandler
{
static readonly Utf8String s_summaryReasonAnnotation = new Utf8String("SummaryReason");
static readonly Utf8String s_summarySourceFileAnnotation = new Utf8String("SummarySourceFile");
static readonly Utf8String s_sanitizerNameAnnotation = new Utf8String("SanitizerName");
readonly List<IssueEventGroup> _issues = new List<IssueEventGroup>();
/// <inheritdoc/>
public override int Priority => 10;
/// <summary>
/// Log value describing the thread sanitizer error summary reason
/// </summary>
public static LogValue SanitizerName => new LogValue(s_sanitizerNameAnnotation, "");
/// <summary>
/// Log value describing the thread sanitizer error summary reason
/// </summary>
public static LogValue SummaryReason => new LogValue(s_summaryReasonAnnotation, "");
/// <summary>
/// Log value describing the thread sanitizer error summary source file
/// </summary>
public static LogValue SummarySourceFile => new LogValue(s_summarySourceFileAnnotation, "");
static bool FindAnnotation(IssueEvent issueEvent, Utf8String annotation, ref string result)
{
foreach (JsonProperty property in issueEvent.Lines.SelectMany(x => x.FindPropertiesOfType(annotation)))
{
JsonElement value;
if (property.Value.TryGetProperty(LogEventPropertyName.Text.Span, out value) && value.ValueKind == JsonValueKind.String)
{
result = value.GetString() ?? "";
return true;
}
}
return false;
}
/// <inheritdoc/>
public override bool HandleEvent(IssueEvent issueEvent)
{
EventId? eventId = issueEvent.EventId;
if (eventId == KnownLogEvents.Sanitizer_Thread || eventId == KnownLogEvents.Sanitizer_Address)
{
string summaryReason = "error";
string summaryFile = "";
string sanitizerName = "";
FindAnnotation(issueEvent, s_summaryReasonAnnotation, ref summaryReason);
FindAnnotation(issueEvent, s_summarySourceFileAnnotation, ref summaryFile);
FindAnnotation(issueEvent, s_sanitizerNameAnnotation, ref sanitizerName);
string fingerprint = $"{sanitizerName}Sanitizer:{summaryReason}:{summaryFile}";
IssueEventGroup issue = new IssueEventGroup(fingerprint, $"{{Meta:{s_sanitizerNameAnnotation}}}Sanitizer found '{{Meta:{s_summaryReasonAnnotation}}}' in {{Meta:{s_summarySourceFileAnnotation}}}", IssueChangeFilter.Code);
issue.Keys.Add(sanitizerName, IssueKeyType.None);
issue.Metadata.Add(s_sanitizerNameAnnotation.ToString(), sanitizerName);
issue.Keys.Add(summaryReason, IssueKeyType.Note);
issue.Metadata.Add(s_summaryReasonAnnotation.ToString(), summaryReason);
issue.Keys.AddSourceFile(summaryFile, IssueKeyType.File);
issue.Metadata.Add(s_summarySourceFileAnnotation.ToString(), summaryFile);
issue.Events.Add(issueEvent);
_issues.Add(issue);
return true;
}
return false;
}
/// <inheritdoc/>
public override IEnumerable<IssueEventGroup> GetIssues() => _issues;
}
}