Merge pull request #956 from wheresrhys/rhys/host-matcher

Rhys/host matcher

Author: wheresrhys

.github/ISSUE_TEMPLATE/new-issue.md

@@ -56,6 +56,12 @@ Match a url ending with a string, e.g. `"end:.jpg"`
 
 Match a url including a string, e.g. `"include:site.com/api"`
 
+### host:...
+
+`{String}`
+
+Match a url which has a given host, e.g. `"host:a.b.com"`
+
 ### path:...
 
 `{String}`

docs/docs/API/route/matcher.md

@@ -49,7 +49,10 @@ You can use the names you gave your routes to check if they have been called.
 
 ```js
 assert(fetchMock.callHistory.called('good get'));
-assert(fetchMock.callHistory.lastCall('good get').queryParams.get('search'), 'needle');
+assert(
+	fetchMock.callHistory.lastCall('good get').queryParams.get('search'),
+	'needle',
+);
 ```
 
 ## Tearing down your mock

docs/docs/Usage/quickstart.md

@@ -4,14 +4,20 @@ import glob from 'glob-to-regexp';
 import * as regexparam from 'regexparam';
 import { isSubsetOf } from './IsSubsetOf.js';
 import { dequal as isEqual } from 'dequal';
-import { normalizeHeaders, getPath, normalizeUrl } from './RequestUtils.js';
+import {
+	normalizeHeaders,
+	getPath,
+	getHost,
+	normalizeUrl,
+} from './RequestUtils.js';
 
 export type URLMatcherObject = {
 	begin?: string;
 	end?: string;
 	include?: string;
 	glob?: string;
 	express?: string;
+	host?: string;
 	path?: string;
 	regexp?: RegExp;
 };
@@ -80,6 +86,9 @@ const stringMatchers: { [key: string]: UrlMatcherGenerator } = {
 			return path === targetString || path === dotlessTargetString;
 		};
 	},
+	host: (targetString) => {
+		return ({ url }) => targetString === getHost(url);
+	},
 };
 const getHeaderMatcher: MatcherGenerator = ({ headers: expectedHeaders }) => {
 	if (!expectedHeaders) {

packages/fetch-mock/src/Matchers.ts

@@ -125,6 +125,15 @@ export function getPath(url: string): string {
 	return u.pathname;
 }
 
+export function getHost(url: string): string | null {
+	if (absoluteUrlRX.test(url)) {
+		return new URL(url).host;
+	} else if ('location' in globalThis) {
+		return globalThis.location.host;
+	}
+	return null;
+}
+
 export function getQuery(url: string): string {
 	const u = absoluteUrlRX.test(url)
 		? new URL(url)

packages/fetch-mock/src/RequestUtils.ts

@@ -39,6 +39,18 @@ describe('url matching', () => {
 		expect(route.matcher({ url: 'http://a.com/paths' })).toBe(true);
 	});
 
+	it('match host: keyword', () => {
+		const route = new Route({
+			url: 'host:a.b.com',
+			response: 200,
+		});
+
+		expect(route.matcher({ url: 'http://b.com/path' })).toBe(false);
+		expect(route.matcher({ url: 'http://a.com/path' })).toBe(false);
+		expect(route.matcher({ url: 'http://a.b.com/path' })).toBe(true);
+		expect(route.matcher({ url: 'https://a.b.com/path' })).toBe(true);
+	});
+
 	it('match end: keyword', () => {
 		const route = new Route({ url: 'end:com/path', response: 200 });
 		expect(route.matcher({ url: 'http://a.com/paths' })).toBe(false);
@@ -332,12 +344,22 @@ describe('url matching', () => {
 						});
 						expect(route.matcher({ url: 'image.jpg' })).toBe(true);
 					});
+
+					it('not match host: keyword', () => {
+						const route = new Route({
+							url: 'host:a.com',
+							response: 200,
+						});
+
+						expect(route.matcher({ url: '/path' })).toBe(false);
+					});
 				});
 			}
 
 			describe('when in browser environment', () => {
 				let location;
 				let origin;
+				let host;
 				beforeAll(() => {
 					if (!isBrowser) {
 						const dom = new JSDOM(``, {
@@ -347,6 +369,7 @@ describe('url matching', () => {
 					}
 					location = globalThis.location.href;
 					origin = globalThis.location.origin;
+					host = globalThis.location.host;
 				});
 				afterAll(() => {
 					if (!isBrowser) {
@@ -388,6 +411,15 @@ describe('url matching', () => {
 					const route = new Route({ url: '/image.jpg', response: 200 });
 					expect(route.matcher({ url: `${origin}/image.jpg` })).toBe(true);
 				});
+
+				it('match host: keyword', () => {
+					const route = new Route({
+						url: `host:${host}`,
+						response: 200,
+					});
+
+					expect(route.matcher({ url: '/path' })).toBe(true);
+				});
 			});
 		});
 	});