chore: refactor codes that write clickable link

Author: filzrev

src/BenchmarkDotNet/Helpers/ConsoleHelper.cs

@@ -17,51 +17,29 @@ internal static class ConsoleHelper
     private const string ST = ESC + @"\";     // String Terminator
 
     /// <summary>
-    /// Write clickable link to console.
-    /// If console doesn't support OSC 8 hyperlinks. It writes plain link.
+    /// Try to gets clickable link text for console.
+    /// If console doesn't support clickable link, it returns false.
     /// </summary>
-    public static void WriteLineAsClickableLink(ILogger consoleLogger, string link, string? linkCaption = null, LogKind logKind = LogKind.Info, string prefixText = "", string suffixText = "")
+    public static bool TryGetClickableLink(string link, string? linkCaption, out string result)
     {
-        if (prefixText != "")
-            consoleLogger.Write(logKind, prefixText);
-
-        WriteAsClickableLink(consoleLogger, link, linkCaption, logKind);
-
-        // On Windows Terminal environment.
-        // It need to write extra space to avoid link style corrupted issue that occurred when window resized.
-        if (IsWindowsTerminal.Value && IsClickableLinkSupported.Value && suffixText == "")
-            suffixText = " ";
-
-        if (suffixText != "")
-            consoleLogger.Write(logKind, suffixText);
-
-        consoleLogger.WriteLine();
-    }
-
-    /// <summary>
-    /// Write clickable link to console.
-    /// If console doesn't support OSC 8 hyperlinks. It writes plain link.
-    /// </summary>
-    public static void WriteAsClickableLink(ILogger consoleLogger, string link, string? linkCaption = null, LogKind logKind = LogKind.Info)
-    {
-        if (consoleLogger.Id != nameof(ConsoleLogger))
-            throw new NotSupportedException("This method is expected logger that has ConsoleLogger id.");
-
-        // If clickable link supported. Write clickable link with OSC8.
-        if (IsClickableLinkSupported.Value)
+        if (!IsClickableLinkSupported)
         {
-            consoleLogger.Write(logKind, @$"{OSC8}{link}{ST}{linkCaption ?? link}{OSC8}{ST}");
-            return;
+            result = "";
+            return false;
         }
 
-        // Write link as plain text. (linkCaption is ignored)
-        consoleLogger.Write(logKind, link);
+        result = @$"{OSC8}{link}{ST}{linkCaption ?? link}{OSC8}{ST}";
+        return true;
     }
 
-    private static readonly Lazy<bool> IsWindowsTerminal = new(()
+    public static bool IsWindowsTerminal => _isWindowsTerminal.Value;
+
+    public static bool IsClickableLinkSupported => _isClickableLinkSupported.Value;
+
+    private static readonly Lazy<bool> _isWindowsTerminal = new(()
         => Environment.GetEnvironmentVariable("WT_SESSION") != null);
 
-    private static readonly Lazy<bool> IsClickableLinkSupported = new(() =>
+    private static readonly Lazy<bool> _isClickableLinkSupported = new(() =>
     {
         if (Console.IsOutputRedirected)
             return false;
@@ -114,7 +92,6 @@ public static void WriteAsClickableLink(ILogger consoleLogger, string link, stri
     [SupportedOSPlatform("windows")]
     private static bool IsVirtualTerminalProcessingEnabled()
     {
-        // Try to get Virtual Terminal Processing enebled or not.
         const uint STD_OUTPUT_HANDLE = unchecked((uint)-11);
         IntPtr handle = NativeMethods.GetStdHandle(STD_OUTPUT_HANDLE);
         if (handle == IntPtr.Zero)

src/BenchmarkDotNet/Loggers/CompositeLogger.cs

@@ -62,12 +62,9 @@ public void Flush()
             }
         }
 
-        /// <summary>
-        /// Try to gets logger that has id of ConsoleLogger.
-        /// </summary>
-        public bool TryGetConsoleLogger([NotNullWhen(true)] out ILogger? consoleLogger)
+        public bool TryGetConsoleLogger([NotNullWhen(true)] out IConsoleLogger? consoleLogger)
         {
-            consoleLogger = loggers.FirstOrDefault(x => x.Id == nameof(ConsoleLogger));
+            consoleLogger = loggers.OfType<IConsoleLogger>().SingleOrDefault();
             return consoleLogger != null;
         }
     }

src/BenchmarkDotNet/Loggers/ConsoleLogger.cs

@@ -9,7 +9,7 @@
 
 namespace BenchmarkDotNet.Loggers
 {
-    public sealed class ConsoleLogger : ILogger
+    public sealed class ConsoleLogger : ILogger, IConsoleLogger
     {
         private const ConsoleColor DefaultColor = ConsoleColor.Gray;
 

src/BenchmarkDotNet/Loggers/IConsoleLogger.cs

@@ -0,0 +1,48 @@
+using BenchmarkDotNet.Helpers;
+using System.Text;
+
+namespace BenchmarkDotNet.Loggers;
+
+/// <summary>
+/// Marker interface for logger that support clickable link with ANSI escape sequence.
+/// </summary>
+internal interface IConsoleLogger : ILogger
+{
+}
+
+/// <summary>
+/// ExtensionMethods for IConsoleLogger interface.
+/// </summary>
+internal static class IConsoleLoggerExtensions
+{
+    /// <summary>
+    /// Write clickable link to console.
+    /// If console doesn't support clickable link. It writes plain link.
+    /// </summary>
+    public static void WriteLineLink(this IConsoleLogger logger, string link, string? linkCaption = null, LogKind logKind = LogKind.Info, string prefixText = "", string suffixText = "")
+    {
+        var sb = new StringBuilder();
+
+        if (prefixText != "")
+            sb.Append(prefixText);
+
+        if (ConsoleHelper.TryGetClickableLink(link, linkCaption, out var linkText))
+        {
+            sb.Append(linkText);
+
+            // Temporary workaround for Windows Terminal.
+            // To avoid link style corruption issue when output ends with a clickable link and window is resized.
+            if (ConsoleHelper.IsWindowsTerminal && suffixText == "")
+                sb.Append(' ');
+        }
+        else
+        {
+            sb.Append(link); // Write plain link.
+        }
+
+        if (suffixText != "")
+            sb.Append(suffixText);
+
+        logger.WriteLine(logKind, sb.ToString());
+    }
+}

src/BenchmarkDotNet/Running/BenchmarkRunnerClean.cs

@@ -202,8 +202,9 @@ internal static Summary[] Run(BenchmarkRunInfo[] benchmarkRunInfos)
 
                         consoleLogger.WriteLine();
                         consoleLogger.WriteLineHeader("// * Benchmark LogFile *");
-                        ConsoleHelper.WriteLineAsClickableLink(consoleLogger, artifactDirectoryFullPath);
-                        ConsoleHelper.WriteLineAsClickableLink(consoleLogger, logFileFullPath, linkCaption: logFileRelativePath, prefixText: "  ");
+                        consoleLogger.WriteLineLink(artifactDirectoryFullPath);
+                        consoleLogger.WriteLineLink(logFileFullPath, linkCaption: logFileRelativePath, prefixText: "  ");
+                        consoleLogger.Flush();
                     }
 
                     eventProcessor.OnEndRunStage();