@microsoft/microsoft-graph-client/src/middleware/ChaosHandler.ts

Microsoft Graph Client Library

/**
 * -------------------------------------------------------------------------------------------
 * Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.
 * See License in the project root for license information.
 * -------------------------------------------------------------------------------------------
 */

/**
 * @module ChaosHandler
 */

import { Context } from "../IContext";
import { RequestMethod } from "../RequestMethod";
import { Middleware } from "./IMiddleware";
import { MiddlewareControl } from "./MiddlewareControl";
import { generateUUID } from "./MiddlewareUtil";
import { httpStatusCode, methodStatusCode } from "./options/ChaosHandlerData";
import { ChaosHandlerOptions } from "./options/ChaosHandlerOptions";
import { ChaosStrategy } from "./options/ChaosStrategy";

/**
 * Class representing ChaosHandler
 * @class
 * Class
 * @implements Middleware
 */
export class ChaosHandler implements Middleware {
	/**
	 * A member holding options to customize the handler behavior
	 *
	 * @private
	 */
	private options: ChaosHandlerOptions;

	/**
	 * container for the manual map that has been written by the client
	 *
	 * @private
	 */
	private manualMap: Map<string, Map<string, number>>;

	/**
	 * @private
	 * A member to hold next middleware in the middleware chain
	 */
	private nextMiddleware: Middleware;

	/**
	 * @public
	 * @constructor
	 * To create an instance of Testing Handler
	 * @param {ChaosHandlerOptions} [options = new ChaosHandlerOptions()] - The testing handler options instance
	 * @param manualMap - The Map passed by user containing url-statusCode info
	 * @returns An instance of Testing Handler
	 */
	public constructor(options: ChaosHandlerOptions = new ChaosHandlerOptions(), manualMap?: Map<string, Map<string, number>>) {
		this.options = options;
		this.manualMap = manualMap;
	}

	/**
	 * Generates responseHeader
	 * @private
	 * @param {ChaosHandlerOptions} chaosHandlerOptions - The ChaosHandlerOptions object
	 * @param {string} requestID - request id
	 * @param {string} requestDate - date of the request
	 * @returns response Header
	 */
	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 (chaosHandlerOptions.statusCode === 429) {
			// throttling case has to have a timeout scenario
			responseHeader.append("retry-after", "3");
		}

		return responseHeader;
	}

	/**
	 * Generates responseBody
	 * @private
	 * @param {ChaosHandlerOptions} chaosHandlerOptions - The ChaosHandlerOptions object
	 * @param {string} requestID - request id
	 * @param {string} requestDate - date of the request
	 *  * @returns response body
	 */
	private createResponseBody(chaosHandlerOptions: ChaosHandlerOptions, requestID: string, requestDate: string) {
		if (chaosHandlerOptions.responseBody) {
			return chaosHandlerOptions.responseBody;
		}
		let body: any;
		if (chaosHandlerOptions.statusCode >= 400) {
			const codeMessage: string = httpStatusCode[chaosHandlerOptions.statusCode];
			const errMessage: string = chaosHandlerOptions.statusMessage;

			body = {
				error: {
					code: codeMessage,
					message: errMessage,
					innerError: {
						"request-id": requestID,
						date: requestDate,
					},
				},
			};
		} else {
			body = {};
		}
		return body;
	}

	/**
	 * creates a response
	 * @private
	 * @param {ChaosHandlerOptions} chaosHandlerOptions - The ChaosHandlerOptions object
	 * @param {Context} context - Contains the context of the request
	 */
	private createResponse(chaosHandlerOptions: ChaosHandlerOptions, context: Context) {
		const requestURL = context.request as string;
		const requestID = generateUUID();
		const requestDate = new Date();
		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(typeof responseBody === "string" ? responseBody : JSON.stringify(responseBody), init);
	}

	/**
	 * Decides whether to send the request to the graph or not
	 * @private
	 * @param {ChaosHandlerOptions} chaosHandlerOptions - A ChaosHandlerOptions object
	 * @param {Context} context - Contains the context of the request
	 * @returns nothing
	 */
	private async sendRequest(chaosHandlerOptions: ChaosHandlerOptions, context: Context): Promise<void> {
		this.setStatusCode(chaosHandlerOptions, context.request as string, context.options.method as RequestMethod);
		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);
		}
	}

	/**
	 * Fetches a random status code for the RANDOM mode from the predefined array
	 * @private
	 * @param {string} requestMethod - the API method for the request
	 * @returns a random status code from a given set of status codes
	 */
	private getRandomStatusCode(requestMethod: RequestMethod): number {
		const statusCodeArray: number[] = methodStatusCode[requestMethod] as number[];
		return statusCodeArray[Math.floor(Math.random() * statusCodeArray.length)];
	}

	/**
	 * To fetch the relative URL out of the complete URL using a predefined regex pattern
	 * @private
	 * @param {string} urlMethod - the complete URL
	 * @returns the string as relative URL
	 */
	private getRelativeURL(urlMethod: string): string {
		const pattern = /https?:\/\/graph\.microsoft\.com\/[^/]+(.+?)(\?|$)/;
		let relativeURL: string;
		if (pattern.exec(urlMethod) !== null) {
			relativeURL = pattern.exec(urlMethod)[1];
		}
		return relativeURL;
	}

	/**
	 * To fetch the status code from the map(if needed), then returns response by calling createResponse
	 * @private
	 * @param {ChaosHandlerOptions} chaosHandlerOptions - The ChaosHandlerOptions object
	 * @param {string} requestURL - the URL for the request
	 * @param {string} requestMethod - the API method for the request
	 */
	private setStatusCode(chaosHandlerOptions: ChaosHandlerOptions, requestURL: string, requestMethod: RequestMethod) {
		if (chaosHandlerOptions.chaosStrategy === ChaosStrategy.MANUAL) {
			if (chaosHandlerOptions.statusCode === undefined) {
				// manual mode with no status code, can be a global level or request level without statusCode
				const relativeURL: string = this.getRelativeURL(requestURL);
				if (this.manualMap.get(relativeURL) !== undefined) {
					// checking Manual Map for exact match
					if (this.manualMap.get(relativeURL).get(requestMethod) !== undefined) {
						chaosHandlerOptions.statusCode = this.manualMap.get(relativeURL).get(requestMethod);
					}
					// else statusCode would be undefined
				} else {
					// checking for regex match if exact match doesn't work
					this.manualMap.forEach((value: Map<string, number>, key: string) => {
						const regexURL = new RegExp(key + "$");
						if (regexURL.test(relativeURL)) {
							if (this.manualMap.get(key).get(requestMethod) !== undefined) {
								chaosHandlerOptions.statusCode = this.manualMap.get(key).get(requestMethod);
							}
							// else statusCode would be undefined
						}
					});
				}

				// Case of redirection or request url not in map ---> statusCode would be undefined
			}
		} else {
			// Handling the case of Random here
			chaosHandlerOptions.statusCode = this.getRandomStatusCode(requestMethod);
			// else statusCode would be undefined
		}
	}

	/**
	 * To get the options for execution of the middleware
	 * @private
	 * @param {Context} context - The context object
	 * @returns options for middleware execution
	 */
	private getOptions(context: Context): ChaosHandlerOptions {
		let options: ChaosHandlerOptions;
		if (context.middlewareControl instanceof MiddlewareControl) {
			options = context.middlewareControl.getMiddlewareOptions(ChaosHandlerOptions) as ChaosHandlerOptions;
		}
		if (typeof options === "undefined") {
			options = Object.assign(new ChaosHandlerOptions(), this.options);
		}

		return options;
	}

	/**
	 * To execute the current middleware
	 * @public
	 * @async
	 * @param {Context} context - The context object of the request
	 * @returns A Promise that resolves to nothing
	 */
	public async execute(context: Context): Promise<void> {
		const chaosHandlerOptions: ChaosHandlerOptions = this.getOptions(context);
		return await this.sendRequest(chaosHandlerOptions, context);
	}

	/**
	 * @public
	 * To set the next middleware in the chain
	 * @param {Middleware} next - The middleware instance
	 * @returns Nothing
	 */
	public setNext(next: Middleware): void {
		this.nextMiddleware = next;
	}
}