Adds the beta support guidance. Closes #86 (#120)

* Adds the beta support guidance. Closes #86

Author: waldekmastykarz

msgraph-developer-proxy-abstractions/ProxyUtils.cs

@@ -13,6 +13,10 @@ public static bool IsGraphRequest(Request request) =>
 
     public static bool IsSdkRequest(Request request) => request.Headers.HeaderExists("SdkVersion");
 
+    public static bool IsGraphBetaRequest(Request request) => 
+        IsGraphRequest(request) &&
+        request.RequestUri.AbsolutePath.Contains("/beta/", StringComparison.OrdinalIgnoreCase);
+
     /// <summary>
     /// Utiliy to build HTTP respopnse headers consistent with Microsoft Graph
     /// </summary>

msgraph-developer-proxy-plugins/Guidance/GraphBetaSupportGuidancePlugin.cs

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.Extensions.Configuration;
+using Microsoft.Graph.DeveloperProxy.Abstractions;
+using System.Text.RegularExpressions;
+using Titanium.Web.Proxy.Http;
+
+namespace Microsoft.Graph.DeveloperProxy.Plugins.Guidance;
+
+public class GraphBetaSupportGuidancePlugin : IProxyPlugin {
+    private ISet<Regex>? _urlsToWatch;
+    private ILogger? _logger;
+    public string Name => nameof(GraphBetaSupportGuidancePlugin);
+
+    public void Register(IPluginEvents pluginEvents,
+                            IProxyContext context,
+                            ISet<Regex> urlsToWatch,
+                            IConfigurationSection? configSection = null) {
+        if (pluginEvents is null) {
+            throw new ArgumentNullException(nameof(pluginEvents));
+        }
+
+        if (context is null || context.Logger is null) {
+            throw new ArgumentException($"{nameof(context)} must not be null and must supply a non-null Logger", nameof(context));
+        }
+
+        if (urlsToWatch is null || urlsToWatch.Count == 0) {
+            throw new ArgumentException($"{nameof(urlsToWatch)} cannot be null or empty", nameof(urlsToWatch));
+        }
+
+        _urlsToWatch = urlsToWatch;
+        _logger = context.Logger;
+
+        pluginEvents.AfterResponse += AfterResponse;
+    }
+
+    private void AfterResponse(object? sender, ProxyResponseArgs e) {
+        Request request = e.Session.HttpClient.Request;
+        if (_urlsToWatch is not null &&
+            e.HasRequestUrlMatch(_urlsToWatch) &&
+            ProxyUtils.IsGraphBetaRequest(request))
+            _logger?.LogRequest(BuildBetaSupportMessage(request), MessageType.Warning, new LoggingContext(e.Session));
+    }
+
+    private static string GetBetaSupportGuidanceUrl() => "https://learn.microsoft.com/graph/versioning-and-support#beta-version";
+    private static string[] BuildBetaSupportMessage(Request r) => new[] { $"Don't use beta APIs in production because they can change or be deprecated.", $"More info at {GetBetaSupportGuidanceUrl()}" };
+}

msgraph-developer-proxy/ProxyCommandHandler.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 using Microsoft.Extensions.Configuration;
@@ -16,6 +16,7 @@ public class ProxyCommandHandler : ICommandHandler {
     private readonly PluginEvents _pluginEvents;
     private readonly ISet<Regex> _urlsToWatch;
     private readonly ILogger _logger;
+
     public ProxyCommandHandler(Option<int?> port,
                                Option<LogLevel?> logLevel,
                                PluginEvents pluginEvents,

msgraph-developer-proxy/ProxyHost.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation.
+// Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
 using Microsoft.Graph.DeveloperProxy.Abstractions;
@@ -15,7 +15,7 @@ public ProxyHost() {
         _portOption = new Option<int?>("--port", "The port for the proxy server to listen on");
         _portOption.AddAlias("-p");
         _portOption.ArgumentHelpName = "port";
-
+        
         _logLevelOption = new Option<LogLevel?>("--logLevel", $"Level of messages to log. Allowed values: {string.Join(", ", Enum.GetNames(typeof(LogLevel)))}");
         _logLevelOption.ArgumentHelpName = "logLevel";
         _logLevelOption.AddValidator(input => {

msgraph-developer-proxy/appsettings.json

@@ -14,6 +14,20 @@
         "https://microsoftgraph.chinacloudapi.cn/beta/*"
       ]
     },
+    {
+      "pluginPath": "GraphProxyPlugins\\msgraph-developer-proxy-plugins.dll",
+      "name": "GraphBetaSupportGuidancePlugin",
+      "urlsToWatch": [
+        "https://graph.microsoft.com/v1.0/*",
+        "https://graph.microsoft.com/beta/*",
+        "https://graph.microsoft.us/v1.0/*",
+        "https://graph.microsoft.us/beta/*",
+        "https://dod-graph.microsoft.us/v1.0/*",
+        "https://dod-graph.microsoft.us/beta/*",
+        "https://microsoftgraph.chinacloudapi.cn/v1.0/*",
+        "https://microsoftgraph.chinacloudapi.cn/beta/*"
+      ]
+    },
     {
       "pluginPath": "GraphProxyPlugins\\msgraph-developer-proxy-plugins.dll",
       "name": "GraphSdkGuidancePlugin",