From 889004f1eba31aa3a5069e1dcbe79896d05720b0 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Tue, 19 Apr 2022 19:03:47 -0400 Subject: move deprecation code into namespace --- src/SMAPI/Framework/DeprecationManager.cs | 171 ------------------------------ 1 file changed, 171 deletions(-) delete mode 100644 src/SMAPI/Framework/DeprecationManager.cs (limited to 'src/SMAPI/Framework/DeprecationManager.cs') diff --git a/src/SMAPI/Framework/DeprecationManager.cs b/src/SMAPI/Framework/DeprecationManager.cs deleted file mode 100644 index 37a5c8ef..00000000 --- a/src/SMAPI/Framework/DeprecationManager.cs +++ /dev/null @@ -1,171 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Diagnostics; -using System.Linq; -using System.Text; - -namespace StardewModdingAPI.Framework -{ - /// Manages deprecation warnings. - internal class DeprecationManager - { - /********* - ** Fields - *********/ - /// The deprecations which have already been logged (as 'mod name::noun phrase::version'). - private readonly HashSet LoggedDeprecations = new(StringComparer.OrdinalIgnoreCase); - - /// Encapsulates monitoring and logging for a given module. - private readonly IMonitor Monitor; - - /// Tracks the installed mods. - private readonly ModRegistry ModRegistry; - - /// The queued deprecation warnings to display. - private readonly IList QueuedWarnings = new List(); - - - /********* - ** Public methods - *********/ - /// Construct an instance. - /// Encapsulates monitoring and logging for a given module. - /// Tracks the installed mods. - public DeprecationManager(IMonitor monitor, ModRegistry modRegistry) - { - this.Monitor = monitor; - this.ModRegistry = modRegistry; - } - - /// Get a mod for the closest assembly registered as a source of deprecation warnings. - /// Returns the source name, or null if no registered assemblies were found. - public IModMetadata? GetModFromStack() - { - return this.ModRegistry.GetFromStack(); - } - - /// Get a mod from its unique ID. - /// The mod's unique ID. - public IModMetadata? GetMod(string modId) - { - return this.ModRegistry.Get(modId); - } - - /// Log a deprecation warning. - /// The mod which used the deprecated code, if known. - /// A noun phrase describing what is deprecated. - /// The SMAPI version which deprecated it. - /// How deprecated the code is. - public void Warn(IModMetadata? source, string nounPhrase, string version, DeprecationLevel severity) - { - // ignore if already warned - if (!this.MarkWarned(source, nounPhrase, version)) - return; - - // queue warning - var stack = new StackTrace(skipFrames: 1); // skip this method - this.QueuedWarnings.Add(new DeprecationWarning(source, nounPhrase, version, severity, stack)); - } - - /// A placeholder method used to track deprecated code for which a separate warning will be shown. - /// The SMAPI version which deprecated it. - /// How deprecated the code is. - public void PlaceholderWarn(string version, DeprecationLevel severity) { } - - /// Print any queued messages. - public void PrintQueued() - { - foreach (DeprecationWarning warning in this.QueuedWarnings.OrderBy(p => p.ModName).ThenBy(p => p.NounPhrase)) - { - // build message - string message = $"{warning.ModName} uses deprecated code ({warning.NounPhrase} is deprecated since SMAPI {warning.Version})."; - - // get log level - LogLevel level; - switch (warning.Level) - { - case DeprecationLevel.Notice: - level = LogLevel.Trace; - break; - - case DeprecationLevel.Info: - level = LogLevel.Debug; - break; - - case DeprecationLevel.PendingRemoval: - level = LogLevel.Warn; - break; - - default: - throw new NotSupportedException($"Unknown deprecation level '{warning.Level}'."); - } - - // log message - if (level == LogLevel.Trace) - this.Monitor.Log($"{message}\n{this.GetSimplifiedStackTrace(warning.StackTrace, warning.Mod)}", level); - else - { - this.Monitor.Log(message, level); - this.Monitor.Log(this.GetSimplifiedStackTrace(warning.StackTrace, warning.Mod), LogLevel.Debug); - } - } - - this.QueuedWarnings.Clear(); - } - - - /********* - ** Private methods - *********/ - /// Mark a deprecation warning as already logged. - /// The mod which used the deprecated code. - /// A noun phrase describing what is deprecated (e.g. "the Extensions.AsInt32 method"). - /// The SMAPI version which deprecated it. - /// Returns whether the deprecation was successfully marked as warned. Returns false if it was already marked. - private bool MarkWarned(IModMetadata? source, string nounPhrase, string version) - { - string key = $"{source?.DisplayName ?? ""}::{nounPhrase}::{version}"; - if (this.LoggedDeprecations.Contains(key)) - return false; - this.LoggedDeprecations.Add(key); - return true; - } - - /// Get the simplest stack trace which shows where in the mod the deprecated code was called from. - /// The stack trace. - /// The mod for which to show a stack trace. - private string GetSimplifiedStackTrace(StackTrace stack, IModMetadata? mod) - { - // unknown mod, show entire stack trace - if (mod == null) - return stack.ToString(); - - // get frame info - var frames = stack - .GetFrames() - .Select(frame => (Frame: frame, Mod: this.ModRegistry.GetFrom(frame))) - .ToArray(); - var modIds = new HashSet( - from frame in frames - let id = frame.Mod?.Manifest.UniqueID - where id != null - select id - ); - - // can't filter to the target mod - if (modIds.Count != 1 || !modIds.Contains(mod.Manifest.UniqueID)) - return stack.ToString(); - - // get stack frames for the target mod, plus one for context - var framesStartingAtMod = frames.SkipWhile(p => p.Mod == null).ToArray(); - var displayFrames = framesStartingAtMod.TakeWhile(p => p.Mod != null).ToArray(); - displayFrames = displayFrames.Concat(framesStartingAtMod.Skip(displayFrames.Length).Take(1)).ToArray(); - - // build stack trace - StringBuilder str = new(); - foreach (var frame in displayFrames) - str.Append(new StackTrace(frame.Frame)); - return str.ToString().TrimEnd(); - } - } -} -- cgit