adding sdk hint to error message response and powershell sample setup script

Author: gavinbarron

msgraph-chaos-proxy/ChaosEngine.cs

@@ -72,6 +72,7 @@ public class ChaosEngine {
         private ProxyServer? _proxyServer;
         private ExplicitProxyEndPoint? _explicitEndPoint;
         private readonly Dictionary<string, DateTime> _throttledRequests;
+        private readonly ConsoleColor _color;
 
         public ChaosEngine(ChaosProxyConfiguration config) {
             _config = config ?? throw new ArgumentNullException(nameof(config));
@@ -84,6 +85,8 @@ public ChaosEngine(ChaosProxyConfiguration config) {
                     _methodStatusCode[k] = _methodStatusCode[k].Where(e => _config.AllowedErrors.Any(a => (int)e == a)).ToArray();
                 }
             }
+
+            _color = Console.ForegroundColor;
         }
 
         public async Task Run(CancellationToken? cancellationToken) {
@@ -214,16 +217,17 @@ private void HandleGraphRequest(SessionEventArgs e) {
 
                 FailResponse(e, responseComponents, failMode);
                 if (!IsSdkRequest(e.HttpClient.Request)) {
-                    var color = Console.ForegroundColor;
                     Console.ForegroundColor = ConsoleColor.Green;
-                    Console.Error.WriteLine($"\tTIP: To handle API errors more easily, use the Graph SDK. More info at {GetMoveToSdkUrl(e.HttpClient.Request)}");
-                    Console.ForegroundColor = color;
+                    Console.Error.WriteLine($"\tTIP: {BuildUseSdkMessage(e.HttpClient.Request)}");
+                    Console.ForegroundColor = _color;
                 }
             }
             if (!responseComponents.ResponseIsComplete)
                 UpdateProxyResponse(e, responseComponents, matchingResponse);
         }
 
+        private static string BuildUseSdkMessage(Request r) => $"To handle API errors more easily, use the Graph SDK. More info at {GetMoveToSdkUrl(r)}";
+
         private void FailResponse(SessionEventArgs e, ResponseComponents r, FailMode failMode) {
             if (failMode == FailMode.Throttled) {
                 r.ErrorStatus = HttpStatusCode.TooManyRequests;
@@ -327,7 +331,7 @@ private void UpdateProxyResponse(SessionEventArgs e, ResponseComponents response
                 responseComponents.Body = JsonSerializer.Serialize(new ErrorResponseBody(
                     new ErrorResponseError {
                         Code = new Regex("([A-Z])").Replace(responseComponents.ErrorStatus.ToString(), m => { return $" {m.Groups[1]}"; }).Trim(),
-                        Message = "Some error happened",
+                        Message = BuildApiErrorMessage(e.HttpClient.Request),
                         InnerError = new ErrorResponseInnerError {
                             RequestId = responseComponents.RequestId,
                             Date = responseComponents.RequestDate
@@ -339,6 +343,8 @@ private void UpdateProxyResponse(SessionEventArgs e, ResponseComponents response
             e.GenericResponse(responseComponents.Body ?? string.Empty, responseComponents.ErrorStatus, responseComponents.Headers);
         }
 
+        private string BuildApiErrorMessage(Request r) => $"Some error was generated by the proxy. {(IsSdkRequest(r) ? "" : BuildUseSdkMessage(r))}";  
+
         private string BuildThrottleKey(Request r) => $"{r.Method}-{r.Url}";
 
         // Modify response

samples/.gitignore

@@ -1,3 +1,4 @@
 dist
 .parcel-cache
 env.js
+env_esm.js

samples/readme.md

@@ -18,10 +18,16 @@ We highly recommend that you use a Microsoft 365 Developer Tenant with content p
 
 ## <a id="appreg">Configure Azure AD App Registration</a>
 
-There are two ways which you can configur the App Registration required for the samples to work correctly, through automatation using a bash script or manually through Azure Portal.
+There are two ways which you can configure the App Registration required for the samples to work correctly, through automatation using a bash script or manually through Azure Portal.
 
 ### <a id="script">Script</a>
 
+If using PowerShell:
+```powershell
+.\scripts\setup.ps1
+```
+
+If using a Linux/Mac terminal:
 ```shell
 $ > chmod +x /scripts/setup.sh
 $ > ./scripts/setup.sh

samples/scripts/setup.ps1

@@ -0,0 +1,18 @@
+# login
+Write-Output "Sign in to Microsoft 365..."
+npx -p @pnp/cli-microsoft365 -- m365 login --authType browser
+
+# create AAD app
+Write-Output "Creating AAD app..."
+$appId = npx -p @pnp/cli-microsoft365 -- "m365 aad app add --name Graph-Chaos-Proxy-Samples --multitenant --redirectUris http://localhost:5500/withsdk.html,http://localhost:5500/nosdk.html --apisDelegated https://graph.microsoft.com/User.Read.All,https://graph.microsoft.com/Presence.Read.All --platform spa --query appId -o text"
+
+Write-Output "AppId: $appId"
+
+# write app to env.js
+Write-Output "Writing app to env.js..."
+"const appId = '$appId';" | Out-File .\env.js
+
+# write app to env_esm.js
+"export const appId = '$appId';" | Out-File .\env_esm.js
+
+Write-Output "DONE"