Improves console output readability. Closes #68 (#117)

* Updates VSCode settings to build sln
* Improves console output readability. Closes #68
* Adds default logLevel value
* Renames mocks.json to responses.json in the default config
* Renames sample responses
* Adds empty responses.json file to include with the Proxy
* Updates mocks message for readability
* Exposes logLevel as CLI option
* Adds responses.sample.json to output
* Changes port and logLevel options to nullable

Author: waldekmastykarz

.vscode/tasks.json

@@ -7,7 +7,7 @@
       "type": "process",
       "args": [
         "build",
-        "${workspaceFolder}/msgraph-developer-proxy/msgraph-developer-proxy.csproj",
+        "${workspaceFolder}/msgraph-developer-proxy.sln",
         "/property:GenerateFullPaths=true",
         "/consoleloggerparameters:NoSummary"
       ],
@@ -19,7 +19,7 @@
       "type": "process",
       "args": [
         "publish",
-        "${workspaceFolder}/msgraph-developer-proxy/msgraph-developer-proxy.csproj",
+        "${workspaceFolder}/msgraph-developer-proxy.sln",
         "/property:GenerateFullPaths=true",
         "/consoleloggerparameters:NoSummary"
       ],
@@ -33,7 +33,7 @@
         "watch",
         "run",
         "--project",
-        "${workspaceFolder}/msgraph-developer-proxy/msgraph-developer-proxy.csproj"
+        "${workspaceFolder}/msgraph-developer-proxy.sln"
       ],
       "problemMatcher": "$msCompile"
     }

msgraph-developer-proxy-abstractions/ILogger.cs

@@ -1,10 +1,48 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
+using System.Runtime.Serialization;
+using Titanium.Web.Proxy.EventArguments;
 
 namespace Microsoft.Graph.DeveloperProxy.Abstractions;
 
+public enum MessageType {
+    Normal,
+    InterceptedRequest,
+    PassedThrough,
+    Warning,
+    Tip,
+    Failed,
+    Chaos,
+    Mocked
+}
+
+public class LoggingContext {
+    public SessionEventArgs Session { get; }
+
+    public LoggingContext(SessionEventArgs session)
+    {
+        Session = session;
+    }
+}
+
+public enum LogLevel {
+    [EnumMember(Value = "debug")]
+    Debug,
+    [EnumMember(Value = "info")]
+    Info,
+    [EnumMember(Value = "warn")]
+    Warn,
+    [EnumMember(Value = "error")]
+    Error
+}
+
 public interface ILogger {
-    public void Log(string message);
+    public LogLevel LogLevel { get; set; }
+
+    public void LogRequest(string[] message, MessageType messageType, LoggingContext? context = null);
+
+    // Logging methods for non-traffic related messages
+    public void LogInfo(string message);
     public void LogWarn(string message);
     public void LogError(string message);
     public void LogDebug(string message);

msgraph-developer-proxy-plugins/Guidance/SdkGuidancePlugin.cs renamed to msgraph-developer-proxy-plugins/Guidance/GraphSdkGuidancePlugin.cs

@@ -42,7 +42,7 @@ private void OnAfterResponse(object? sender, ProxyResponseArgs e) {
             && _urlsToWatch is not null 
             && e.HasRequestUrlMatch(_urlsToWatch) 
             && WarnNoSdk(request)) {
-            _logger?.LogWarn(MessageUtils.BuildUseSdkMessage(request));
+            _logger?.LogRequest(MessageUtils.BuildUseSdkMessage(request), MessageType.Tip, new LoggingContext(e.Session));
         }
     }
 

msgraph-developer-proxy-plugins/Guidance/SelectGuidancePlugin.cs renamed to msgraph-developer-proxy-plugins/Guidance/GraphSelectGuidancePlugin.cs

@@ -38,7 +38,7 @@ public void Register(IPluginEvents pluginEvents,
     private void AfterResponse(object? sender, ProxyResponseArgs e) {
         Request request = e.Session.HttpClient.Request;
         if (_urlsToWatch is not null && e.HasRequestUrlMatch(_urlsToWatch) && WarnNoSelect(request))
-            _logger?.LogWarn(BuildUseSelectMessage(request));
+            _logger?.LogRequest(BuildUseSelectMessage(request), MessageType.Warning, new LoggingContext(e.Session));
     }
 
     private static bool WarnNoSelect(Request request) =>
@@ -47,5 +47,5 @@ private static bool WarnNoSelect(Request request) =>
         && !request.Url.Contains("$select", StringComparison.OrdinalIgnoreCase);
 
     private static string GetSelectParameterGuidanceUrl() => "https://learn.microsoft.com/graph/query-parameters#select-parameter";
-    private static string BuildUseSelectMessage(Request r) => $"To improve performance of your application, use the $select parameter when calling {r.RequestUriString}. More info at {GetSelectParameterGuidanceUrl()}";
+    private static string[] BuildUseSelectMessage(Request r) => new[] { $"To improve performance of your application, use the $select parameter.", $"More info at {GetSelectParameterGuidanceUrl()}" };
 }

msgraph-developer-proxy-plugins/MessageUtils.cs

@@ -1,13 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-using Microsoft.Graph.DeveloperProxy.Abstractions;
 using Titanium.Web.Proxy.Http;
 
 namespace Microsoft.Graph.DeveloperProxy.Plugins;
 
 internal class MessageUtils {
-    public static string BuildUseSdkMessage(Request r) => $"To handle API errors more easily, use the Graph SDK. More info at {GetMoveToSdkUrl(r)}";
+    public static string[] BuildUseSdkMessage(Request r) => new[] { "To handle API errors more easily, use the Graph SDK.", $"More info at {GetMoveToSdkUrl(r)}" };
 
     public static string GetMoveToSdkUrl(Request request) {
         // TODO: return language-specific guidance links based on the language detected from the User-Agent

msgraph-developer-proxy-plugins/MockResponses/MockResponsePlugin.cs

@@ -169,5 +169,7 @@ private void ProcessMockResponse(SessionEventArgs e, MockResponse matchingRespon
             }
             e.GenericResponse(body ?? string.Empty, statusCode, headers);
         }
+
+        _logger?.LogRequest(new[] { $"{matchingResponse.ResponseCode ?? 200} ${matchingResponse.Url}" }, MessageType.Mocked, new LoggingContext(e));
     }
 }

msgraph-developer-proxy-plugins/MockResponses/MockResponsesLoader.cs

@@ -20,7 +20,7 @@ public MockResponsesLoader(ILogger logger, MockResponseConfiguration configurati
 
     public void LoadResponses() {
         if (!File.Exists(_responsesFilePath)) {
-            _logger.LogWarn($"Unable to find {_configuration.MocksFile}, no mocks will be provided");
+            _logger.LogWarn($"File {_configuration.MocksFile} not found in the current directory. No mocks will be provided");
             _configuration.Responses = Array.Empty<MockResponse>();
             return;
         }
@@ -31,7 +31,7 @@ public void LoadResponses() {
             IEnumerable<MockResponse>? configResponses = responsesConfig?.Responses;
             if (configResponses is not null) {
                 _configuration.Responses = configResponses;
-                _logger.Log($"Mock responses for {configResponses.Count()} url patterns loaded from from {_configuration.MocksFile}");
+                _logger.LogInfo($"Mock responses for {configResponses.Count()} url patterns loaded from from {_configuration.MocksFile}");
             }
         }
         catch (Exception ex) {

msgraph-developer-proxy-plugins/RandomErrors/RandomErrorPlugin.cs

@@ -20,7 +20,7 @@ internal enum FailMode {
     PassThru
 }
 
-public class RandomErrorConfguration {
+public class RandomErrorConfiguration {
     public int Rate { get; set; } = 0;
     public List<int> AllowedErrors { get; set; } = new();
 }
@@ -30,62 +30,62 @@ public class RandomErrorPlugin : IProxyPlugin {
     private ILogger? _logger;
     private readonly Option<int?> _rate;
     private readonly Option<IEnumerable<int>> _allowedErrors;
-    private readonly RandomErrorConfguration _configuration = new();
+    private readonly RandomErrorConfiguration _configuration = new();
 
     public string Name => nameof(RandomErrorPlugin);
 
     private const int retryAfterInSeconds = 5;
     private readonly Dictionary<string, HttpStatusCode[]> _methodStatusCode = new()
     {
-            {
-                "GET", new[] {
-                    HttpStatusCode.TooManyRequests,
-                    HttpStatusCode.InternalServerError,
-                    HttpStatusCode.BadGateway,
-                    HttpStatusCode.ServiceUnavailable,
-                    HttpStatusCode.GatewayTimeout
-                }
-            },
-            {
-                "POST", new[] {
-                    HttpStatusCode.TooManyRequests,
-                    HttpStatusCode.InternalServerError,
-                    HttpStatusCode.BadGateway,
-                    HttpStatusCode.ServiceUnavailable,
-                    HttpStatusCode.GatewayTimeout,
-                    HttpStatusCode.InsufficientStorage
-                }
-            },
-            {
-                "PUT", new[] {
-                    HttpStatusCode.TooManyRequests,
-                    HttpStatusCode.InternalServerError,
-                    HttpStatusCode.BadGateway,
-                    HttpStatusCode.ServiceUnavailable,
-                    HttpStatusCode.GatewayTimeout,
-                    HttpStatusCode.InsufficientStorage
-                }
-            },
-            {
-                "PATCH", new[] {
-                    HttpStatusCode.TooManyRequests,
-                    HttpStatusCode.InternalServerError,
-                    HttpStatusCode.BadGateway,
-                    HttpStatusCode.ServiceUnavailable,
-                    HttpStatusCode.GatewayTimeout
-                }
-            },
-            {
-                "DELETE", new[] {
-                    HttpStatusCode.TooManyRequests,
-                    HttpStatusCode.InternalServerError,
-                    HttpStatusCode.BadGateway,
-                    HttpStatusCode.ServiceUnavailable,
-                    HttpStatusCode.GatewayTimeout,
-                    HttpStatusCode.InsufficientStorage
-                }
+        {
+            "GET", new[] {
+                HttpStatusCode.TooManyRequests,
+                HttpStatusCode.InternalServerError,
+                HttpStatusCode.BadGateway,
+                HttpStatusCode.ServiceUnavailable,
+                HttpStatusCode.GatewayTimeout
             }
-        };
+        },
+        {
+            "POST", new[] {
+                HttpStatusCode.TooManyRequests,
+                HttpStatusCode.InternalServerError,
+                HttpStatusCode.BadGateway,
+                HttpStatusCode.ServiceUnavailable,
+                HttpStatusCode.GatewayTimeout,
+                HttpStatusCode.InsufficientStorage
+            }
+        },
+        {
+            "PUT", new[] {
+                HttpStatusCode.TooManyRequests,
+                HttpStatusCode.InternalServerError,
+                HttpStatusCode.BadGateway,
+                HttpStatusCode.ServiceUnavailable,
+                HttpStatusCode.GatewayTimeout,
+                HttpStatusCode.InsufficientStorage
+            }
+        },
+        {
+            "PATCH", new[] {
+                HttpStatusCode.TooManyRequests,
+                HttpStatusCode.InternalServerError,
+                HttpStatusCode.BadGateway,
+                HttpStatusCode.ServiceUnavailable,
+                HttpStatusCode.GatewayTimeout
+            }
+        },
+        {
+            "DELETE", new[] {
+                HttpStatusCode.TooManyRequests,
+                HttpStatusCode.InternalServerError,
+                HttpStatusCode.BadGateway,
+                HttpStatusCode.ServiceUnavailable,
+                HttpStatusCode.GatewayTimeout,
+                HttpStatusCode.InsufficientStorage
+            }
+        }
+    };
 
     private readonly Dictionary<string, DateTime> _throttledRequests;
     private readonly Random _random;
@@ -115,7 +115,7 @@ private FailMode ShouldFail(ProxyRequestArgs e) {
         string key = BuildThrottleKey(r);
         if (_throttledRequests.TryGetValue(key, out DateTime retryAfterDate)) {
             if (retryAfterDate > DateTime.Now) {
-                _logger?.LogError($"Calling {r.Url} again before waiting for the Retry-After period. Request will be throttled");
+                _logger?.LogRequest(new[] { $"Calling {r.Url} again before waiting for the Retry-After period.", "Request will be throttled" }, MessageType.Failed, new LoggingContext(e.Session));
                 // update the retryAfterDate to extend the throttling window to ensure that brute forcing won't succeed.
                 _throttledRequests[key] = retryAfterDate.AddSeconds(retryAfterInSeconds);
                 return FailMode.Throttled;
@@ -164,7 +164,7 @@ private void UpdateProxyResponse(ProxyRequestArgs ev, HttpStatusCode errorStatus
                 }
             })
         );
-        _logger?.Log($"\tFailed {request.Url} with {errorStatus}");
+        _logger?.LogRequest(new[] { $"{(int)errorStatus} {errorStatus.ToString()}" }, MessageType.Chaos, new LoggingContext(ev.Session));
         session.GenericResponse(body ?? string.Empty, errorStatus, headers);
     }
     private static string BuildApiErrorMessage(Request r) => $"Some error was generated by the proxy. {(ProxyUtils.IsGraphRequest(r) ? ProxyUtils.IsSdkRequest(r) ? "" : MessageUtils.BuildUseSdkMessage(r) : "")}";
@@ -220,7 +220,7 @@ private void OnRequest(object? sender, ProxyRequestArgs e) {
             var failMode = ShouldFail(e);
 
             if (failMode == FailMode.PassThru && _configuration.Rate != 100) {
-                _logger?.Log($"\tPassed through {session.HttpClient.Request.Url}");
+                _logger?.LogRequest(new[] { "Passed through" }, MessageType.PassedThrough, new LoggingContext(e.Session));
                 return;
             }
             FailResponse(e, failMode);