unit test for invalid hostname

Author: nikithauc

src/GraphRequestUtil.ts

@@ -72,21 +72,21 @@ export const isGraphURL = (url: string): boolean => {
 /**
  * Checks if the url is for one of the custom hosts provided during client initialization
  * @param {string} url - The url to be verified
- * @param {Set} customHostNames - The url to be verified
+ * @param {Set} customHosts - The url to be verified
  * @returns {boolean} - Returns true if the url is a for a custom host
  */
-export const isCustomHost = (url: string, customHostNames: Set<string>): boolean => {
-	customHostNames.forEach((x) => isCustomHostValid(x));
-	return isValidEndpoint(url, customHostNames);
+export const isCustomHost = (url: string, customHosts: Set<string>): boolean => {
+	customHosts.forEach((host) => isCustomHostValid(host));
+	return isValidEndpoint(url, customHosts);
 };
 
 /**
  * Checks if the url is for one of the provided hosts.
  * @param {string} url - The url to be verified
- * @param {Set<string>} allowedHostNames - A set of hostnames.
+ * @param {Set<string>} allowedHosts - A set of hosts.
  * @returns {boolean} - Returns true is for one of the provided endpoints.
  */
-const isValidEndpoint = (url: string, allowedHostNames: Set<string> = GRAPH_URLS): boolean => {
+const isValidEndpoint = (url: string, allowedHosts: Set<string> = GRAPH_URLS): boolean => {
 	// Valid Graph URL pattern - https://graph.microsoft.com/{version}/{resource}?{query-parameters}
 	// Valid Graph URL example - https://graph.microsoft.com/v1.0/
 	url = url.toLowerCase();
@@ -101,19 +101,23 @@ const isValidEndpoint = (url: string, allowedHostNames: Set<string> = GRAPH_URLS
 		if (endOfHostStrPos !== -1) {
 			if (startofPortNoPos !== -1 && startofPortNoPos < endOfHostStrPos) {
 				hostName = url.substring(0, startofPortNoPos);
-				return allowedHostNames.has(hostName);
+				return allowedHosts.has(hostName);
 			}
 			// Parse out the host
 			hostName = url.substring(0, endOfHostStrPos);
-			return allowedHostNames.has(hostName);
+			return allowedHosts.has(hostName);
 		}
 	}
 
 	return false;
 };
 
-const isCustomHostValid = (hostName: string) => {
-	if (hostName.indexOf("/") !== -1) {
-		throw new GraphClientError("Please add only hostnames to the CustomHosts config");
+/**
+ * Throws error if the string is not a valid host/hostname and contains other url parts.
+ * @param {string} url - The host to be verified
+ */
+const isCustomHostValid = (host: string) => {
+	if (host.indexOf("/") !== -1) {
+		throw new GraphClientError("Please add only hosts or hostnames to the CustomHosts config. If the url is `http://example.com:3000/`, host is `example:3000`");
 	}
 };

test/common/core/Client.ts

@@ -175,6 +175,37 @@ describe("Client.ts", () => {
 
 			assert.equal(context.options.headers["Authorization"], `Bearer ${accessToken}`);
 		});
+
+		it("Pass invalid custom hosts", async () => {
+			try {
+				// eslint-disable-next-line @typescript-eslint/no-unused-vars
+				const accessToken = "DUMMY_TOKEN";
+				const provider: AuthProvider = (done) => {
+					done(null, "DUMMY_TOKEN");
+				};
+
+				const options = new ChaosHandlerOptions(ChaosStrategy.MANUAL, "Testing chained middleware array", 200, 100, "");
+				const chaosHandler = new ChaosHandler(options);
+
+				const authHandler = new AuthenticationHandler(new CustomAuthenticationProvider(provider));
+
+				const telemetry = new TelemetryHandler();
+				const middleware = [authHandler, telemetry, chaosHandler];
+
+				const customHost = "https://test_custom";
+				const customHosts = new Set<string>([customHost]);
+				const client = Client.initWithMiddleware({ middleware, customHosts });
+
+				// eslint-disable-next-line @typescript-eslint/no-unused-vars
+				const response = await client.api(`https://${customHost}/v1.0/me`).get();
+
+				throw new Error("Test fails - Error expected when custom host is not valid");
+			} catch (error) {
+				assert.isDefined(error);
+				assert.isDefined(error.message);
+				assert.equal(error.message, "Please add only hosts or hostnames to the CustomHosts config. If the url is `http://example.com:3000/`, host is `example:3000`");
+			}
+		});
 	});
 
 	describe("init", () => {