Adds client-request-id guidance. Closes #209 (#223)

Author: waldekmastykarz

msgraph-developer-proxy-plugins/Guidance/GraphClientRequestIdGuidancePlugin.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 GraphClientRequestIdGuidancePlugin : BaseProxyPlugin
+{
+  public override string Name => nameof(GraphClientRequestIdGuidancePlugin);
+
+  public override void Register(IPluginEvents pluginEvents,
+                          IProxyContext context,
+                          ISet<Regex> urlsToWatch,
+                          IConfigurationSection? configSection = null)
+  {
+    base.Register(pluginEvents, context, urlsToWatch, configSection);
+
+    pluginEvents.BeforeRequest += BeforeRequest;
+  }
+
+  private void BeforeRequest(object? sender, ProxyRequestArgs e)
+  {
+    Request request = e.Session.HttpClient.Request;
+    if (_urlsToWatch is not null && e.HasRequestUrlMatch(_urlsToWatch) && WarnNoClientRequestId(request))
+    {
+      _logger?.LogRequest(BuildAddClientRequestIdMessage(request), MessageType.Warning, new LoggingContext(e.Session));
+
+      if (!ProxyUtils.IsSdkRequest(request))
+      {
+        _logger?.LogRequest(MessageUtils.BuildUseSdkMessage(request), MessageType.Tip, new LoggingContext(e.Session));
+      }
+    }
+  }
+
+  private static bool WarnNoClientRequestId(Request request) =>
+      ProxyUtils.IsGraphRequest(request) &&
+      !request.Headers.HeaderExists("client-request-id");
+
+  private static string GetClientRequestIdGuidanceUrl() => "https://aka.ms/graph/proxy/guidance/client-request-id";
+  private static string[] BuildAddClientRequestIdMessage(Request r) => new[] {
+    $"To help Microsoft investigate errors, to each request to Microsoft Graph",
+    "add the client-request-id header with a unique GUID.",
+    $"More info at {GetClientRequestIdGuidanceUrl()}" };
+}

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

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

msgraph-developer-proxy-plugins/MessageUtils.cs

@@ -6,7 +6,13 @@
 namespace Microsoft.Graph.DeveloperProxy.Plugins;
 
 internal class MessageUtils {
-    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[] BuildUseSdkForErrorsMessage(Request r) => new[] { "To handle API errors more easily, use the Microsoft Graph SDK.", $"More info at {GetMoveToSdkUrl(r)}" };
+
+    public static string[] BuildUseSdkMessage(Request r) => new[] {
+        "To more easily follow best practices for working with Microsoft Graph, ",
+        "use the Microsoft 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/RandomErrors/GraphRandomErrorPlugin.cs

@@ -165,7 +165,7 @@ private void UpdateProxyResponse(ProxyRequestArgs ev, HttpStatusCode 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) ? "" : String.Join(' ', MessageUtils.BuildUseSdkMessage(r)) : "")}";
+    private static string BuildApiErrorMessage(Request r) => $"Some error was generated by the proxy. {(ProxyUtils.IsGraphRequest(r) ? ProxyUtils.IsSdkRequest(r) ? "" : String.Join(' ', MessageUtils.BuildUseSdkForErrorsMessage(r)) : "")}";
 
     private string BuildThrottleKey(Request r) => $"{r.Method}-{r.Url}";
 

msgraph-developer-proxy/appsettings.json

@@ -41,6 +41,21 @@
         "https://microsoftgraph.chinacloudapi.cn/beta/*"
       ]
     },
+    {
+      "name": "GraphClientRequestIdGuidancePlugin",
+      "enabled": true,
+      "pluginPath": "GraphProxyPlugins\\msgraph-developer-proxy-plugins.dll",
+      "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/*"
+      ]
+    },
     {
       "name": "MockResponsePlugin",
       "enabled": true,