|
1 | 1 | // Licensed to the .NET Foundation under one or more agreements. |
2 | 2 | // The .NET Foundation licenses this file to you under the MIT license. |
3 | 3 |
|
4 | | -#nullable disable |
| 4 | +using System.Runtime.CompilerServices; |
5 | 5 |
|
6 | 6 | namespace Microsoft.DotNet.Cli.Commands.Test; |
7 | 7 |
|
8 | 8 | internal static class Logger |
9 | 9 | { |
| 10 | + [InterpolatedStringHandler] |
| 11 | + internal readonly struct LoggerInterpolatedStringHandler |
| 12 | + { |
| 13 | + /// <summary>The handler we use to perform the formatting.</summary> |
| 14 | + private readonly StringBuilder.AppendInterpolatedStringHandler _stringBuilderHandler; |
| 15 | + private readonly StringBuilder? _stringBuilder; |
| 16 | + |
| 17 | + public LoggerInterpolatedStringHandler(int literalLength, int formattedCount, out bool shouldAppend) |
| 18 | + { |
| 19 | + shouldAppend = Logger.TraceEnabled; |
| 20 | + if (shouldAppend) |
| 21 | + { |
| 22 | + _stringBuilder = new StringBuilder(); |
| 23 | + _stringBuilderHandler = new(literalLength, formattedCount, _stringBuilder); |
| 24 | + } |
| 25 | + } |
| 26 | + |
| 27 | + public override string ToString() |
| 28 | + => _stringBuilder?.ToString() ?? string.Empty; |
| 29 | + |
| 30 | + public void AppendLiteral(string value) => _stringBuilderHandler!.AppendLiteral(value); |
| 31 | + |
| 32 | + public void AppendFormatted<T>(T value) => _stringBuilderHandler.AppendFormatted<T>(value); |
| 33 | + |
| 34 | + public void AppendFormatted<T>(T value, string? format) => _stringBuilderHandler.AppendFormatted<T>(value, format); |
| 35 | + |
| 36 | + public void AppendFormatted<T>(T value, int alignment) => _stringBuilderHandler.AppendFormatted<T>(value, alignment); |
| 37 | + |
| 38 | + public void AppendFormatted<T>(T value, int alignment, string? format) => _stringBuilderHandler.AppendFormatted<T>(value, alignment, format); |
| 39 | + |
| 40 | + public void AppendFormatted(ReadOnlySpan<char> value) => _stringBuilderHandler.AppendFormatted(value); |
| 41 | + |
| 42 | + public void AppendFormatted(ReadOnlySpan<char> value, int alignment = 0, string? format = null) => _stringBuilderHandler.AppendFormatted(value, alignment, format); |
| 43 | + |
| 44 | + public void AppendFormatted(string? value) => _stringBuilderHandler.AppendFormatted(value); |
| 45 | + |
| 46 | + public void AppendFormatted(string? value, int alignment = 0, string? format = null) => _stringBuilderHandler.AppendFormatted(value, alignment, format); |
| 47 | + |
| 48 | + public void AppendFormatted(object? value, int alignment = 0, string? format = null) => _stringBuilderHandler.AppendFormatted(value, alignment, format); |
| 49 | + } |
| 50 | + |
10 | 51 | public static bool TraceEnabled { get; private set; } |
11 | | - private static readonly string _traceFilePath; |
| 52 | + private static readonly string? _traceFilePath; |
12 | 53 | private static readonly object _lock = new(); |
13 | 54 |
|
14 | 55 | static Logger() |
15 | 56 | { |
16 | 57 | _traceFilePath = Environment.GetEnvironmentVariable(CliConstants.TestTraceLoggingEnvVar); |
17 | 58 | TraceEnabled = !string.IsNullOrEmpty(_traceFilePath); |
18 | 59 |
|
19 | | - string directoryPath = Path.GetDirectoryName(_traceFilePath); |
| 60 | + string? directoryPath = Path.GetDirectoryName(_traceFilePath); |
20 | 61 | if (!string.IsNullOrEmpty(directoryPath)) |
21 | 62 | { |
22 | 63 | Directory.CreateDirectory(directoryPath); |
23 | 64 | } |
24 | 65 | } |
25 | 66 |
|
26 | | - public static void LogTrace(Func<string> messageLog) |
| 67 | + /// <summary> |
| 68 | + /// Use this overload carefully for performance reasons. |
| 69 | + /// We don't want the argument to have expensive calculations. |
| 70 | + /// </summary> |
| 71 | + /// <param name="message"></param> |
| 72 | + public static void LogTrace(string message) |
27 | 73 | { |
28 | | - if (!TraceEnabled) |
| 74 | + if (TraceEnabled) |
29 | 75 | { |
30 | | - return; |
| 76 | + LogTraceCore(message); |
31 | 77 | } |
| 78 | + } |
32 | 79 |
|
| 80 | + public static void LogTrace(ref LoggerInterpolatedStringHandler handler) |
| 81 | + { |
| 82 | + if (TraceEnabled) |
| 83 | + { |
| 84 | + LogTraceCore(handler.ToString()); |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + public static void LogTrace<T>(T arg, Func<T, string> messageGetter) |
| 89 | + { |
| 90 | + if (TraceEnabled) |
| 91 | + { |
| 92 | + LogTraceCore(messageGetter(arg)); |
| 93 | + } |
| 94 | + } |
| 95 | + |
| 96 | + private static void LogTraceCore(string message) |
| 97 | + { |
33 | 98 | try |
34 | 99 | { |
35 | | - string message = $"[dotnet test - {DateTimeOffset.UtcNow:MM/dd/yyyy HH:mm:ss.fff}]{messageLog()}"; |
| 100 | + message = $"[dotnet test - {DateTimeOffset.UtcNow:MM/dd/yyyy HH:mm:ss.fff}]{message}"; |
36 | 101 |
|
37 | 102 | lock (_lock) |
38 | 103 | { |
39 | | - using StreamWriter logFile = File.AppendText(_traceFilePath); |
| 104 | + using StreamWriter logFile = File.AppendText(_traceFilePath!); |
40 | 105 | logFile.WriteLine(message); |
41 | 106 | } |
42 | 107 | } |
|
0 commit comments