Adding headers to chaoshandleroptions

Author: nikithauc

package-lock.json

@@ -61,7 +61,7 @@
         "pre-build": "npm run setVersion",
         "build": "npm run pre-build && npm run build:cjs && npm run build:es && rollup -c",
         "test": "npm run test:cjs && npm run test:esm",
-        "test:development": "tsc --p test/tsconfig-test-cjs.json &&  mocha  'lib/test/development/**/*.js' --require  isomorphic-fetch",
+        "test:development": "tsc --p test/tsconfig-test-cjs.json &&  mocha  'lib/test/development/**/*.js' --require  isomorphic-fetch --grep PageIterator",
         "lint": "tslint --project ./tsconfig-cjs.json -c tslint.json",
         "format:css": "prettier --write \"**/*.css\"",
         "format:html": "prettier --write \"**/*.html\"",

package.json

@@ -12,4 +12,4 @@
  * @module Version
  */
 
-export const PACKAGE_VERSION = "2.2.0-Preview.1";
+export const PACKAGE_VERSION = "2.1.0-Preview.2";

src/Version.ts

@@ -67,20 +67,21 @@ export class ChaosHandler implements Middleware {
 	 * @param {string} requestDate - date of the request
 	 * @returns response Header
 	 */
-	private createResponseHeaders(statusCode: number, requestID: string, requestDate: string) {
-		const responseHeader: Headers = new Headers();
+	private createResponseHeaders(chaosHandlerOptions: ChaosHandlerOptions, requestID: string, requestDate: string) {
 
+		const responseHeader: Headers = chaosHandlerOptions.headers ? new Headers(chaosHandlerOptions.headers) : new Headers();
 		responseHeader.append("Cache-Control", "no-store");
 		responseHeader.append("request-id", requestID);
 		responseHeader.append("client-request-id", requestID);
 		responseHeader.append("x-ms-ags-diagnostic", "");
 		responseHeader.append("Date", requestDate);
 		responseHeader.append("Strict-Transport-Security", "");
 
-		if (statusCode === 429) {
+		if (chaosHandlerOptions.statusCode === 429) {
 			// throttling case has to have a timeout scenario
 			responseHeader.append("retry-after", "300");
 		}
+
 		return responseHeader;
 	}
 
@@ -94,14 +95,14 @@ export class ChaosHandler implements Middleware {
 	 * @param {any?} requestBody - the request body to be returned for the request
 	 * @returns response body
 	 */
-	private createResponseBody(statusCode: number, statusMessage: string, requestID: string, requestDate: string, responseBody?: any) {
-		if (responseBody) {
-			return responseBody;
+	private createResponseBody(options: ChaosHandlerOptions, requestID: string, requestDate: string) {
+		if (options.responseBody) {
+			return options.responseBody;
 		}
 		let body: any;
-		if (statusCode >= 400) {
-			const codeMessage: string = httpStatusCode[statusCode];
-			const errMessage: string = statusMessage;
+		if (options.statusCode >= 400) {
+			const codeMessage: string = httpStatusCode[options.statusCode];
+			const errMessage: string = options.statusMessage;
 
 			body = {
 				error: {
@@ -135,8 +136,8 @@ export class ChaosHandler implements Middleware {
 
 			requestID = generateUUID();
 			requestDate = new Date();
-			responseHeader = this.createResponseHeaders(chaosHandlerOptions.statusCode, requestID, requestDate.toString());
-			responseBody = this.createResponseBody(chaosHandlerOptions.statusCode, chaosHandlerOptions.statusMessage, requestID, requestDate.toString(), chaosHandlerOptions.responseBody);
+			responseHeader = this.createResponseHeaders(chaosHandlerOptions, requestID, requestDate.toString());
+			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);
 		} catch (error) {

src/middleware/ChaosHandler.ts

@@ -55,6 +55,13 @@ export class ChaosHandlerOptions implements MiddlewareOptions {
 	 */
 	public responseBody: any;
 
+	/**
+	 * The response body to be returned in the response
+	 *
+	 * @public
+	 */
+	public headers: Headers;
+
 	/**
 	 * @public
 	 * @constructor
@@ -66,12 +73,13 @@ export class ChaosHandlerOptions implements MiddlewareOptions {
 	 * @param {any?} responseBody - The response body to be returned in the response
 	 * @returns An instance of ChaosHandlerOptions
 	 */
-	public constructor(chaosStrategy: ChaosStrategy = ChaosStrategy.RANDOM, statusMessage: string = "Some error Happened", statusCode?: number, chaosPercentage?: number, responseBody?: any) {
+	public constructor(chaosStrategy: ChaosStrategy = ChaosStrategy.RANDOM, statusMessage: string = "Some error Happened", statusCode?: number, chaosPercentage?: number, responseBody?: any, headers?:Headers) {
 		this.chaosStrategy = chaosStrategy;
 		this.statusCode = statusCode;
 		this.statusMessage = statusMessage;
 		this.chaosPercentage = chaosPercentage !== undefined ? chaosPercentage : 10;
 		this.responseBody = responseBody;
+		this.headers = headers
 		if (this.chaosPercentage > 100) {
 			throw new Error("Error Pecentage can not be more than 100");
 		}

src/middleware/options/ChaosHandlerOptions.ts

@@ -27,24 +27,28 @@ describe("ChaosHandler.ts", () => {
 
 	describe("createResponseHeaders", () => {
 		it("Should have request-id for every random statusCode", () => {
-			const responseHeader = chaosHandler["createResponseHeaders"](204, "xxxxxxxxxxxxxxxx", new Date().toString());
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "testStatusCode", 204);
+			const responseHeader = chaosHandler["createResponseHeaders"](options, "xxxxxxxxxxxxxxxx", new Date().toString());
 			assert.isDefined(responseHeader.get("request-id"));
 		});
 
 		it("Should have retry-after for 429 case", () => {
-			const responseHeader = chaosHandler["createResponseHeaders"](429, "xxxxxxxxxxxxxxxx", new Date().toString());
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "testStatusCode", 429);
+			const responseHeader = chaosHandler["createResponseHeaders"](options, "xxxxxxxxxxxxxxxx", new Date().toString());
 			assert.isDefined(responseHeader.get("retry-after"));
 		});
 	});
 
 	describe("createResponseBody", () => {
 		it("Should return error in response body for error scenarios", () => {
-			const responseBody = chaosHandler["createResponseBody"](404, "Not Found", "xxxxxxxxxxxxxx", new Date().toString());
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Not Found", 404);
+			const responseBody = chaosHandler["createResponseBody"](options, "xxxxxxxxxxxxxx", new Date().toString());
 			assert.isDefined(responseBody["error"]);
 		});
 
 		it("Should return empty response body for success scenarios", () => {
-			const responseBody = chaosHandler["createResponseBody"](200, "Not Found", "xxxxxxxxxxxxxx", new Date().toString());
+			const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Not Found", 200);
+			const responseBody = chaosHandler["createResponseBody"](options, "xxxxxxxxxxxxxx", new Date().toString());
 			assert.equal(Object.keys(responseBody).length, 0);
 		});
 	});

test/common/middleware/ChaosHandler.ts

@@ -11,12 +11,13 @@ import { assert } from "chai";
 
 import { getClient } from "../test-helper";
 
-import { ChaosHandler } from "../../../src/middleware/ChaosHandler";
+import { CgithaosHandler } from "../../../src/middleware/ChaosHandler";
 import { ChaosHandlerOptions } from "../../../src/middleware/options/ChaosHandlerOptions";
+
 import { ChaosStrategy } from "../../../src/middleware/options/ChaosStrategy";
-import { GraphRequestOptions, PageIterator, PageIteratorCallback } from "../../../src/tasks/PageIterator";
 import { Client, ClientOptions } from "../../../src";
 
+import { GraphRequestOptions, PageIterator, PageIteratorCallback } from "../../../src/tasks/PageIterator";
 const client = getClient();
 describe("PageIterator", ()=> {
 	const pstHeader = { Prefer: 'outlook.timezone= "pacific standard time"' };
@@ -96,31 +97,31 @@ describe("PageIterator", ()=> {
 	}).timeout(30 * 1000);
 
 	// TODO - Temporariliy commenting this test. 
-	// it("setting middleware with pageIterator", async () => {
-	// 	const middleware = new ChaosHandler();
-	// 	const getPageCollection = () => {
-	// 		return {
-	// 			value: [],
-	// 			"@odata.nextLink": "nextURL",
-	// 			additionalContent: "additional content",
-	// 		};
-	// 	};
-	// 	const clientOptions: ClientOptions = {
-	// 		middleware,
-	// 	};
-	// 	const responseBody = { value: [{ event1: "value1" }, { event2: "value2" }] };
-	// 	let counter = 1;
-	// 	const callback: PageIteratorCallback = (data) => {
-	// 		assert.equal(data["event" + counter], "value" + counter);
-	// 		counter++;
-	// 		return true;
-	// 	};
-
-	// 	const middlewareOptions = [new ChaosHandlerOptions(ChaosStrategy.MANUAL, "middleware options for pageIterator", 200, 0, responseBody)];
-	// 	const requestOptions = { middlewareOptions };
-
-	// 	const client = Client.initWithMiddleware(clientOptions);
-	// 	const pageIterator = new PageIterator(client, getPageCollection(), callback, requestOptions);
-	// 	await pageIterator.iterate();
-	// });
+	it("setting middleware with pageIterator", async () => {
+		const middleware = new ChaosHandler();
+		const getPageCollection = () => {
+			return {
+				value: [],
+				"@odata.nextLink": "nextURL",
+				additionalContent: "additional content",
+			};
+		};
+		const clientOptions: ClientOptions = {
+			middleware,
+		};
+		const responseBody = { value: [{ event1: "value1" }, { event2: "value2" }] };
+		let counter = 1;
+		const callback: PageIteratorCallback = (data) => {
+			assert.equal(data["event" + counter], "value" + counter);
+			counter++;
+			return true;
+		};
+
+		const middlewareOptions = [new ChaosHandlerOptions(ChaosStrategy.MANUAL, "middleware options for pageIterator", 200, 0, JSON.stringify(responseBody), new Headers({ 'Content-Type' : 'application/json','content-length':'100'}))];
+		const requestOptions = { middlewareOptions };
+
+		const client = Client.initWithMiddleware(clientOptions);
+		const pageIterator = new PageIterator(client, getPageCollection(), callback, requestOptions);
+		await pageIterator.iterate();
+	});
 });