tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rejig LogStringHandler (#30706)

Browse Source 
* Rejig LogStringHandler

* Fix session logs

* Fix properly

* comments

* IAsType support

* Fix mind logs

* Fix mind logging AGAIN

---------

Co-authored-by: PJB3005 <pieterjan.briers+git@gmail.com>
This commit is contained in:
Leon Friedrich
2025-09-06 00:22:49 +12:00
committed by GitHub
parent f45bf4590f
commit 828b1f2044
17 changed files with 413 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files

205
Content.Shared/Administration/Logs/LogStringHandler.cs
View File

@@ -1,29 +1,33 @@
using System.Runtime.CompilerServices;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.CompilerServices;
using Robust.Shared.Player;
using Robust.Shared.Toolshed.TypeParsers;
namespace Content.Shared.Administration.Logs;
[InterpolatedStringHandler]
[SuppressMessage("ReSharper", "MethodOverloadWithOptionalParameter")]
public ref struct LogStringHandler
{
public readonly ISharedAdminLogManager Logger;
private DefaultInterpolatedStringHandler _handler;
public readonly Dictionary<string, object?> Values;
public LogStringHandler(int literalLength, int formattedCount)
public LogStringHandler(int literalLength, int formattedCount, ISharedAdminLogManager logger, out bool isEnabled)
{
isEnabled = logger.Enabled;
if (!isEnabled)
{
Values = default!;
Logger = default!;
return;
}
_handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount);
Values = new Dictionary<string, object?>();
}
public LogStringHandler(int literalLength, int formattedCount, IFormatProvider? provider)
{
_handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount, provider);
Values = new Dictionary<string, object?>();
}
public LogStringHandler(int literalLength, int formattedCount, IFormatProvider? provider, Span<char> initialBuffer)
{
_handler = new DefaultInterpolatedStringHandler(literalLength, formattedCount, provider, initialBuffer);
Values = new Dictionary<string, object?>();
// TODO LOGGING Dictionary pool?
Values = new Dictionary<string, object?>(formattedCount);
Logger = logger;
}
private void AddFormat<T>(string? format, T value, string? argument = null)
@@ -31,15 +35,13 @@ public ref struct LogStringHandler
if (format == null)
{
if (argument == null)
{
return;
}
format = argument[0] == '@' ? argument[1..] : argument;
}
if (Values.TryAdd(format, value) ||
Values[format] == (object?) value)
if (Values.TryAdd(Logger.ConvertName(format), value)
|| Values[format] is T val && val.Equals(value) )
{
return;
}
@@ -48,7 +50,8 @@ public ref struct LogStringHandler
var i = 2;
format = $"{originalFormat}_{i}";
while (!Values.TryAdd(format, value))
while (!Values.TryAdd(Logger.ConvertName(format), value)
|| Values[format] is T val2 && val2.Equals(value))
{
format = $"{originalFormat}_{i}";
i++;
@@ -60,30 +63,176 @@ public ref struct LogStringHandler
_handler.AppendLiteral(value);
}
#region EntityUid
public void AppendFormatted(EntityUid value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(EntityUid value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(EntityUid value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(EntityUid value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
public void AppendFormatted(EntityUid? value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(EntityUid? value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(EntityUid? value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(EntityUid? value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
#endregion
#region NetEntity
public void AppendFormatted(NetEntity value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(NetEntity value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(NetEntity value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(NetEntity value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
public void AppendFormatted(NetEntity? value, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), argument);
}
public void AppendFormatted(NetEntity? value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), format, argument);
}
public void AppendFormatted(NetEntity? value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, argument);
}
public void AppendFormatted(NetEntity? value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
AppendFormatted(Logger.EntityManager.ToPrettyString(value), alignment, format, argument);
}
#endregion
#region Player
public void AppendFormatted(ICommonSession? value, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value);
}
public void AppendFormatted(ICommonSession? value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value, format);
}
public void AppendFormatted(ICommonSession? value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value, alignment);
}
public void AppendFormatted(ICommonSession? value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
SerializablePlayer? player = value == null ? null : new(value, Logger.EntityManager);
AddFormat(null, player, argument);
_handler.AppendFormatted(value, alignment, format);
}
#endregion
#region Generic
public void AppendFormatted<T>(T value, [CallerArgumentExpression("value")] string? argument = null)
{
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), argument);
return;
}
AddFormat(null, value, argument);
_handler.AppendFormatted(value);
}
public void AppendFormatted<T>(T value, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), format, argument);
return;
}
AddFormat(format, value, argument);
_handler.AppendFormatted(value, format);
}
public void AppendFormatted<T>(T value, int alignment, [CallerArgumentExpression("value")] string? argument = null)
{
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), alignment, argument);
return;
}
AddFormat(null, value, argument);
_handler.AppendFormatted(value, alignment);
}
public void AppendFormatted<T>(T value, int alignment, string? format, [CallerArgumentExpression("value")] string? argument = null)
{
if (value is IAsType<EntityUid> ent)
{
AppendFormatted(ent.AsType(), alignment, format, argument);
return;
}
AddFormat(format, value, argument);
_handler.AppendFormatted(value, alignment, format);
}
#endregion
public void AppendFormatted(ReadOnlySpan<char> value)
{
_handler.AppendFormatted(value);
@@ -116,7 +265,23 @@ public ref struct LogStringHandler
public string ToStringAndClear()
{
Values.Clear();
return _handler.ToStringAndClear();
}
}
public readonly struct SerializablePlayer
{
public readonly Guid UserId;
public readonly EntityUid? Uid;
public readonly string? Name;
public SerializablePlayer(ICommonSession player, IEntityManager entityManager)
{
UserId = player.UserId.UserId;
if (player.AttachedEntity is not {} uid)
return;
Uid = uid;
Name = entityManager.GetComponentOrNull<MetaDataComponent>(uid)?.EntityName;
}
}