Sebastienlevert/fix chaos handler random (#429)

* Fixing ChaosHandler with interactive scenarios

* Fixing manual strategy and collapse ifs

* Removing unnecessary async in ChaodHandler tests

* Update src/middleware/ChaosHandler.ts

Co-authored-by: Nikitha Chettiar <[email protected]>

Co-authored-by: Nikitha Chettiar <[email protected]>

Author: sebastienlevert

src/middleware/ChaosHandler.ts

@@ -77,7 +77,7 @@ export class ChaosHandler implements Middleware {
 
 		if (chaosHandlerOptions.statusCode === 429) {
 			// throttling case has to have a timeout scenario
-			responseHeader.append("retry-after", "300");
+			responseHeader.append("retry-after", "3");
 		}
 
 		return responseHeader;
@@ -129,7 +129,7 @@ export class ChaosHandler implements Middleware {
 		const responseHeader = this.createResponseHeaders(chaosHandlerOptions, requestID, requestDate.toString());
 		const responseBody = this.createResponseBody(chaosHandlerOptions, requestID, requestDate.toString());
 		const init: any = { url: requestURL, status: chaosHandlerOptions.statusCode, statusText: chaosHandlerOptions.statusMessage, headers: responseHeader };
-		context.response = new Response(responseBody, init);
+		context.response = new Response(typeof responseBody === "string" ? responseBody : JSON.stringify(responseBody), init);
 	}
 
 	/**
@@ -141,10 +141,10 @@ export class ChaosHandler implements Middleware {
 	 */
 	private async sendRequest(chaosHandlerOptions: ChaosHandlerOptions, context: Context): Promise<void> {
 		this.setStatusCode(chaosHandlerOptions, context.request as string, context.options.method as RequestMethod);
-		if (!chaosHandlerOptions.statusCode) {
-			await this.nextMiddleware.execute(context);
-		} else {
+		if ((chaosHandlerOptions.chaosStrategy === ChaosStrategy.MANUAL && !this.nextMiddleware) || Math.floor(Math.random() * 100) < chaosHandlerOptions.chaosPercentage) {
 			this.createResponse(chaosHandlerOptions, context);
+		} else if (this.nextMiddleware) {
+			await this.nextMiddleware.execute(context);
 		}
 	}
 
@@ -209,9 +209,7 @@ export class ChaosHandler implements Middleware {
 			}
 		} else {
 			// Handling the case of Random here
-			if (Math.floor(Math.random() * 100) < chaosHandlerOptions.chaosPercentage) {
-				chaosHandlerOptions.statusCode = this.getRandomStatusCode(requestMethod);
-			}
+			chaosHandlerOptions.statusCode = this.getRandomStatusCode(requestMethod);
 			// else statusCode would be undefined
 		}
 	}

test/common/core/Client.ts

@@ -75,7 +75,7 @@ describe("Client.ts", () => {
 			};
 			const authHandler = new AuthenticationHandler(new CustomAuthenticationProvider(provider));
 			const responseBody = "Test response body";
-			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Testing middleware array", 200, 0, responseBody);
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Testing middleware array", 200, 100, responseBody);
 			const middlewareArray = [authHandler, new ChaosHandler(options)];
 			const client = Client.initWithMiddleware({ middleware: middlewareArray });
 
@@ -90,7 +90,7 @@ describe("Client.ts", () => {
 			const authHandler = new AuthenticationHandler(new CustomAuthenticationProvider(provider));
 
 			const responseBody = "Test response body";
-			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Testing chained middleware array", 200, 0, responseBody);
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Testing chained middleware array", 200, 100, responseBody);
 			const chaosHandler = new ChaosHandler(options);
 			const telemetryHandler = new TelemetryHandler();
 

test/common/middleware/ChaosHandler.ts

@@ -71,7 +71,7 @@ describe("ChaosHandler.ts", () => {
 		});
 	});
 
-	describe("sendRequest", async () => {
+	describe("sendRequest", () => {
 		const cxt: Context = {
 			request: "https://graph.microsoft.com/v1.0/me",
 			options: {
@@ -80,19 +80,19 @@ describe("ChaosHandler.ts", () => {
 		};
 
 		const manualMap: Map<string, Map<string, number>> = new Map([["/me", new Map([["GET", 500]])]]);
-		const tempManualOptions: ChaosHandlerOptions = new ChaosHandlerOptions(ChaosStrategy.MANUAL);
+		const tempManualOptions: ChaosHandlerOptions = new ChaosHandlerOptions(ChaosStrategy.MANUAL, undefined, undefined, 100);
 		const tempChaosHandler = new ChaosHandler(tempManualOptions, manualMap);
 
 		const dummyHTTPHandler = new DummyHTTPMessageHandler();
 		const handler = new ChaosHandler();
 		handler.setNext(dummyHTTPHandler);
 
-		it("Should return a response after creating it", async () => {
+		it("Should return a response after creating it", () => {
 			tempChaosHandler["sendRequest"](tempManualOptions, cxt);
 			assert.isDefined(cxt.response);
 		});
 
-		it("Should send the request to the graph", async () => {
+		it("Should send the request to the graph", () => {
 			handler["sendRequest"](new ChaosHandlerOptions(ChaosStrategy.RANDOM, "I generated the error", undefined, 100), cxt);
 			assert.isDefined(cxt.response);
 		});
@@ -215,7 +215,7 @@ describe("ChaosHandler.ts", () => {
 		});
 	});
 
-	describe("execute", async () => {
+	describe("execute", () => {
 		const manualMap: Map<string, Map<string, number>> = new Map([
 			[
 				"/me",
@@ -233,7 +233,7 @@ describe("ChaosHandler.ts", () => {
 		tempChaosHandlerRandom.setNext(dummyHTTPHandler);
 		tempChaosHandlerManual.setNext(dummyHTTPHandler);
 
-		it("Should return response for Default Case", async () => {
+		it("Should return response for Default Case", () => {
 			const options = new ChaosHandlerOptions(ChaosStrategy.RANDOM);
 			const cxt: Context = {
 				request: "https://graph.microsoft.com/v1.0/me",
@@ -245,7 +245,7 @@ describe("ChaosHandler.ts", () => {
 			assert.isDefined(tempChaosHandlerDefault["execute"](cxt));
 		});
 
-		it("Should return response for Random case", async () => {
+		it("Should return response for Random case", () => {
 			const cxt: Context = {
 				request: "https://graph.microsoft.com/v1.0/me",
 				options: {
@@ -255,7 +255,7 @@ describe("ChaosHandler.ts", () => {
 			assert.isDefined(tempChaosHandlerRandom["execute"](cxt));
 		});
 
-		it("Should return response for Manual Global case", async () => {
+		it("Should return response for Manual Global case", () => {
 			const cxt: Context = {
 				request: "https://graph.microsoft.com/v1.0/me",
 				options: {
@@ -265,7 +265,7 @@ describe("ChaosHandler.ts", () => {
 			assert.isDefined(tempChaosHandlerManual["execute"](cxt));
 		});
 
-		it("Should return response for Manual Request Level case", async () => {
+		it("Should return response for Manual Request Level case", () => {
 			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Manual Request level case", 200);
 			const cxt: Context = {
 				request: "https://graph.microsoft.com/v1.0/me",
@@ -276,5 +276,17 @@ describe("ChaosHandler.ts", () => {
 			};
 			assert.isDefined(tempChaosHandlerManual["execute"](cxt));
 		});
+
+		it("Should return response for Manual Request Level case 100%", () => {
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Manual Request level case", 429, 100);
+			const cxt: Context = {
+				request: "https://graph.microsoft.com/v1.0/me",
+				options: {
+					method: "GET",
+				},
+				middlewareControl: new MiddlewareControl([options]),
+			};
+			assert.isDefined(tempChaosHandlerManual["execute"](cxt));
+		});
 	});
 });