From 05d3d9350d1ce9b50ea82938a4d02b11e59b5c1d Mon Sep 17 00:00:00 2001 From: Tayrtahn Date: Sat, 24 May 2025 18:47:47 -0400 Subject: [PATCH] Cleanup logging in guidebook embeds (#37794) --- Content.Client/Guidebook/Controls/GuideEntityEmbed.xaml.cs | 6 +++++- .../Guidebook/Controls/GuideMicrowaveEmbed.xaml.cs | 4 ++-- .../Guidebook/Controls/GuideMicrowaveGroupEmbed.cs | 6 +++++- .../Guidebook/Controls/GuideReagentEmbed.xaml.cs | 7 +++++-- .../Guidebook/Controls/GuideReagentGroupEmbed.xaml.cs | 6 +++++- .../Guidebook/Controls/GuideTechDisciplineEmbed.xaml.cs | 6 +++++- .../Guidebook/Controls/GuideTechnologyEmbed.xaml.cs | 7 +++++-- Content.Client/Guidebook/Controls/GuidebookWindow.xaml.cs | 4 ++-- 8 files changed, 34 insertions(+), 12 deletions(-) diff --git a/Content.Client/Guidebook/Controls/GuideEntityEmbed.xaml.cs b/Content.Client/Guidebook/Controls/GuideEntityEmbed.xaml.cs index d0b39abb37..fee397b27d 100644 --- a/Content.Client/Guidebook/Controls/GuideEntityEmbed.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuideEntityEmbed.xaml.cs @@ -28,12 +28,15 @@ public sealed partial class GuideEntityEmbed : BoxContainer, IDocumentTag { [Dependency] private readonly IEntityManager _entityManager = default!; [Dependency] private readonly IEntitySystemManager _systemManager = default!; + [Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly IUserInterfaceManager _ui = default!; private readonly TagSystem _tagSystem; private readonly ExamineSystem _examineSystem; private readonly GuidebookSystem _guidebookSystem; + private readonly ISawmill _sawmill; + public bool Interactive; public Entity? Sprite => View.Entity == null || View.Sprite == null @@ -53,6 +56,7 @@ public sealed partial class GuideEntityEmbed : BoxContainer, IDocumentTag _tagSystem = _systemManager.GetEntitySystem(); _examineSystem = _systemManager.GetEntitySystem(); _guidebookSystem = _systemManager.GetEntitySystem(); + _sawmill = _logManager.GetSawmill("guidebook.entity"); MouseFilter = MouseFilterMode.Stop; } @@ -135,7 +139,7 @@ public sealed partial class GuideEntityEmbed : BoxContainer, IDocumentTag { if (!args.TryGetValue("Entity", out var proto)) { - Logger.Error("Entity embed tag is missing entity prototype argument"); + _sawmill.Error("Entity embed tag is missing entity prototype argument"); control = null; return false; } diff --git a/Content.Client/Guidebook/Controls/GuideMicrowaveEmbed.xaml.cs b/Content.Client/Guidebook/Controls/GuideMicrowaveEmbed.xaml.cs index da93fb46fd..d6f20d5a25 100644 --- a/Content.Client/Guidebook/Controls/GuideMicrowaveEmbed.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuideMicrowaveEmbed.xaml.cs @@ -24,7 +24,7 @@ public sealed partial class GuideMicrowaveEmbed : PanelContainer, IDocumentTag, [Dependency] private readonly IPrototypeManager _prototype = default!; [Dependency] private readonly ILogManager _logManager = default!; - private ISawmill _sawmill = default!; + private readonly ISawmill _sawmill = default!; public IPrototype? RepresentedPrototype { get; private set; } @@ -34,7 +34,7 @@ public sealed partial class GuideMicrowaveEmbed : PanelContainer, IDocumentTag, IoCManager.InjectDependencies(this); MouseFilter = MouseFilterMode.Stop; - _sawmill = _logManager.GetSawmill("guidemicrowaveembed"); + _sawmill = _logManager.GetSawmill("guidebook.microwave"); } public GuideMicrowaveEmbed(string recipe) : this() diff --git a/Content.Client/Guidebook/Controls/GuideMicrowaveGroupEmbed.cs b/Content.Client/Guidebook/Controls/GuideMicrowaveGroupEmbed.cs index 098e99459c..7c2a0ecfe1 100644 --- a/Content.Client/Guidebook/Controls/GuideMicrowaveGroupEmbed.cs +++ b/Content.Client/Guidebook/Controls/GuideMicrowaveGroupEmbed.cs @@ -15,12 +15,16 @@ namespace Content.Client.Guidebook.Controls; [UsedImplicitly] public sealed partial class GuideMicrowaveGroupEmbed : BoxContainer, IDocumentTag { + [Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly IPrototypeManager _prototype = default!; + private readonly ISawmill _sawmill; + public GuideMicrowaveGroupEmbed() { Orientation = LayoutOrientation.Vertical; IoCManager.InjectDependencies(this); + _sawmill = _logManager.GetSawmill("guidebook.microwave_group"); MouseFilter = MouseFilterMode.Stop; } @@ -34,7 +38,7 @@ public sealed partial class GuideMicrowaveGroupEmbed : BoxContainer, IDocumentTa control = null; if (!args.TryGetValue("Group", out var group)) { - Logger.Error("Microwave group embed tag is missing group argument"); + _sawmill.Error("Microwave group embed tag is missing group argument"); return false; } diff --git a/Content.Client/Guidebook/Controls/GuideReagentEmbed.xaml.cs b/Content.Client/Guidebook/Controls/GuideReagentEmbed.xaml.cs index 78cd765bdb..29569e40e6 100644 --- a/Content.Client/Guidebook/Controls/GuideReagentEmbed.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuideReagentEmbed.xaml.cs @@ -25,9 +25,11 @@ namespace Content.Client.Guidebook.Controls; public sealed partial class GuideReagentEmbed : BoxContainer, IDocumentTag, ISearchableControl, IPrototypeRepresentationControl { [Dependency] private readonly IEntitySystemManager _systemManager = default!; + [Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly IPrototypeManager _prototype = default!; private readonly ChemistryGuideDataSystem _chemistryGuideData; + private readonly ISawmill _sawmill; public IPrototype? RepresentedPrototype { get; private set; } @@ -35,6 +37,7 @@ public sealed partial class GuideReagentEmbed : BoxContainer, IDocumentTag, ISea { RobustXamlLoader.Load(this); IoCManager.InjectDependencies(this); + _sawmill = _logManager.GetSawmill("guidebook.reagent"); _chemistryGuideData = _systemManager.GetEntitySystem(); MouseFilter = MouseFilterMode.Stop; } @@ -64,13 +67,13 @@ public sealed partial class GuideReagentEmbed : BoxContainer, IDocumentTag, ISea control = null; if (!args.TryGetValue("Reagent", out var id)) { - Logger.Error("Reagent embed tag is missing reagent prototype argument"); + _sawmill.Error("Reagent embed tag is missing reagent prototype argument"); return false; } if (!_prototype.TryIndex(id, out var reagent)) { - Logger.Error($"Specified reagent prototype \"{id}\" is not a valid reagent prototype"); + _sawmill.Error($"Specified reagent prototype \"{id}\" is not a valid reagent prototype"); return false; } diff --git a/Content.Client/Guidebook/Controls/GuideReagentGroupEmbed.xaml.cs b/Content.Client/Guidebook/Controls/GuideReagentGroupEmbed.xaml.cs index 0c9356eccb..5373034b42 100644 --- a/Content.Client/Guidebook/Controls/GuideReagentGroupEmbed.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuideReagentGroupEmbed.xaml.cs @@ -17,12 +17,16 @@ namespace Content.Client.Guidebook.Controls; [UsedImplicitly, GenerateTypedNameReferences] public sealed partial class GuideReagentGroupEmbed : BoxContainer, IDocumentTag { + [Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly IPrototypeManager _prototype = default!; + private readonly ISawmill _sawmill; + public GuideReagentGroupEmbed() { RobustXamlLoader.Load(this); IoCManager.InjectDependencies(this); + _sawmill = _logManager.GetSawmill("guidebook.reagent_group"); MouseFilter = MouseFilterMode.Stop; } @@ -42,7 +46,7 @@ public sealed partial class GuideReagentGroupEmbed : BoxContainer, IDocumentTag control = null; if (!args.TryGetValue("Group", out var group)) { - Logger.Error("Reagent group embed tag is missing group argument"); + _sawmill.Error("Reagent group embed tag is missing group argument"); return false; } diff --git a/Content.Client/Guidebook/Controls/GuideTechDisciplineEmbed.xaml.cs b/Content.Client/Guidebook/Controls/GuideTechDisciplineEmbed.xaml.cs index 88d264cb05..a01f2a8f17 100644 --- a/Content.Client/Guidebook/Controls/GuideTechDisciplineEmbed.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuideTechDisciplineEmbed.xaml.cs @@ -17,12 +17,16 @@ namespace Content.Client.Guidebook.Controls; [UsedImplicitly, GenerateTypedNameReferences] public sealed partial class GuideTechDisciplineEmbed : BoxContainer, IDocumentTag { + [Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly IPrototypeManager _prototype = default!; + private readonly ISawmill _sawmill; + public GuideTechDisciplineEmbed() { RobustXamlLoader.Load(this); IoCManager.InjectDependencies(this); + _sawmill = _logManager.GetSawmill("guidebook.tech_discipline"); MouseFilter = MouseFilterMode.Stop; } @@ -42,7 +46,7 @@ public sealed partial class GuideTechDisciplineEmbed : BoxContainer, IDocumentTa control = null; if (!args.TryGetValue("Discipline", out var group)) { - Logger.Error("Technology discipline embed tag is missing discipline argument"); + _sawmill.Error("Technology discipline embed tag is missing discipline argument"); return false; } diff --git a/Content.Client/Guidebook/Controls/GuideTechnologyEmbed.xaml.cs b/Content.Client/Guidebook/Controls/GuideTechnologyEmbed.xaml.cs index d61cc2d961..7d205f7cea 100644 --- a/Content.Client/Guidebook/Controls/GuideTechnologyEmbed.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuideTechnologyEmbed.xaml.cs @@ -22,10 +22,12 @@ namespace Content.Client.Guidebook.Controls; public sealed partial class GuideTechnologyEmbed : BoxContainer, IDocumentTag, ISearchableControl { [Dependency] private readonly IEntitySystemManager _systemManager = default!; + [Dependency] private readonly ILogManager _logManager = default!; [Dependency] private readonly IPrototypeManager _prototype = default!; private readonly ResearchSystem _research; private readonly SpriteSystem _sprite; + private readonly ISawmill _sawmill; public GuideTechnologyEmbed() { @@ -33,6 +35,7 @@ public sealed partial class GuideTechnologyEmbed : BoxContainer, IDocumentTag, I IoCManager.InjectDependencies(this); _research = _systemManager.GetEntitySystem(); _sprite = _systemManager.GetEntitySystem(); + _sawmill = _logManager.GetSawmill("guidebook.technology"); MouseFilter = MouseFilterMode.Stop; } @@ -61,13 +64,13 @@ public sealed partial class GuideTechnologyEmbed : BoxContainer, IDocumentTag, I control = null; if (!args.TryGetValue("Technology", out var id)) { - Logger.Error("Technology embed tag is missing technology prototype argument"); + _sawmill.Error("Technology embed tag is missing technology prototype argument"); return false; } if (!_prototype.TryIndex(id, out var technology)) { - Logger.Error($"Specified technology prototype \"{id}\" is not a valid technology prototype"); + _sawmill.Error($"Specified technology prototype \"{id}\" is not a valid technology prototype"); return false; } diff --git a/Content.Client/Guidebook/Controls/GuidebookWindow.xaml.cs b/Content.Client/Guidebook/Controls/GuidebookWindow.xaml.cs index 13ee0c87e7..677105df00 100644 --- a/Content.Client/Guidebook/Controls/GuidebookWindow.xaml.cs +++ b/Content.Client/Guidebook/Controls/GuidebookWindow.xaml.cs @@ -31,7 +31,7 @@ public sealed partial class GuidebookWindow : FancyWindow, ILinkClickHandler, IA { RobustXamlLoader.Load(this); IoCManager.InjectDependencies(this); - _sawmill = Logger.GetSawmill("Guidebook"); + _sawmill = Logger.GetSawmill("guidebook"); Tree.OnSelectedItemChanged += OnSelectionChanged; @@ -225,7 +225,7 @@ public sealed partial class GuidebookWindow : FancyWindow, ILinkClickHandler, IA { // TODO GUIDEBOOK Maybe allow duplicate entries? // E.g., for adding medicine under both chemicals & the chemist job - Logger.Error($"Adding duplicate guide entry: {id}"); + _sawmill.Error($"Adding duplicate guide entry: {id}"); return null; }