Merge pull request #728 from wheresrhys/rhys/express-params

Matchers expect normalizedRequest

docs/docs/@fetch-mock/core/more-routing-methods.md

@@ -95,7 +95,9 @@ If your matcher requires access to the body of the request set this to true; bec
 
 `{Function}`
 
-A function which takes a route definition object as input, and returns a function of the signature `(url, options, request) => Boolean`. See the examples below for more detail. The function is passed the fetchMock instance as a second parameter in case you need to access any config.
+A function which takes a route definition object as input, and returns a function of the signature `(NormalizedRequest) => Boolean`. See the examples below for more detail. The function is passed the fetchMock instance as a second parameter in case you need to access any config.
+
+// TODO at time of writing the NormalizedRequest schema is still evolving, so more detailed docs will emerge soon
 
 ##### Examples
 

docs/docs/@fetch-mock/core/route/response.md

@@ -76,9 +76,9 @@ A `Promise` that resolves to any of the options documented above e.g. `new Promi
 
 `{Function}`
 
-A function that returns any of the options documented above (including `Promise`. The function will be passed the `url` and `options` `fetch` was called with. If `fetch` was called with a `Request` instance, it will be passed `url` and `options` inferred from the `Request` instance, with the original `Request` passed as a third argument.
+A function that is passed a [`CallLog`](/fetch-mock/docs/@fetch-mock/core/CallHistory#calllog-schema) and returns any of the options documented above (including `Promise`).
 
 ### Examples
 
-- `(url, opts) => opts.headers.Authorization ? 200 : 403`
-- `(_, _, request) => request.headers.get('Authorization') ?  200 : 403`
+- `({url, options}) => options.headers.Authorization ? 200 : 403`
+- `({request}) => request.headers.get('Authorization') ?  200 : 403`

packages/core/src/CallHistory.js

@@ -137,12 +137,7 @@ class CallHistory {
 		});
 
 		calls = calls.filter(({ url, options }) => {
-			const {
-				url: normalizedUrl,
-				options: normalizedOptions,
-				request,
-			} = normalizeRequest(url, options, this.config.Request);
-			return matcher(normalizedUrl, normalizedOptions, request);
+			return matcher(normalizeRequest(url, options, this.config.Request));
 		});
 
 		return calls;

packages/core/src/FetchMock.js

@@ -80,6 +80,7 @@ const FetchMock = {
 			requestInit,
 			this.config.Request,
 		);
+
 		/** @type {Promise<any>[]} */
 		const pendingPromises = [];
 		const callLog = { ...normalizedRequest, pendingPromises };

packages/core/src/Matchers.js

@@ -1,6 +1,6 @@
 //@type-check
 /** @typedef {import('./Route').RouteConfig} RouteConfig */
-/** @typedef {import('./RequestUtils').NormalizedRequestOptions} NormalizedRequestOptions */
+/** @typedef {import('./RequestUtils').NormalizedRequest} NormalizedRequest */
 import glob from 'globrex';
 import * as regexparam from 'regexparam';
 import querystring from 'querystring';
@@ -32,7 +32,7 @@ export const isFunctionMatcher = (matcher) => typeof matcher === 'function';
 /** @typedef {string | RegExp | URL} RouteMatcherUrl */
 /** @typedef {function(string): boolean} UrlMatcher */
 /** @typedef {function(string): UrlMatcher} UrlMatcherGenerator */
-/** @typedef {function(string, NormalizedRequestOptions, Request): boolean} RouteMatcherFunction */
+/** @typedef {function(NormalizedRequest): boolean} RouteMatcherFunction */
 /** @typedef {function(RouteConfig): RouteMatcherFunction} MatcherGenerator */
 /** @typedef {RouteMatcherUrl | RouteMatcherFunction} RouteMatcher */
 
@@ -47,19 +47,27 @@ export const isFunctionMatcher = (matcher) => typeof matcher === 'function';
  * @type {Object.<string, UrlMatcherGenerator>}
  */
 const stringMatchers = {
-	begin: (targetString) => (url) => url.indexOf(targetString) === 0,
-	end: (targetString) => (url) =>
-		url.substr(-targetString.length) === targetString,
+	begin:
+		(targetString) =>
+		({ url }) =>
+			url.indexOf(targetString) === 0,
+	end:
+		(targetString) =>
+		({ url }) =>
+			url.substr(-targetString.length) === targetString,
 
 	glob: (targetString) => {
 		const urlRX = glob(targetString);
-		return (url) => urlRX.regex.test(url);
+		return ({ url }) => urlRX.regex.test(url);
 	},
 	express: (targetString) => {
 		const urlRX = regexparam.parse(targetString);
-		return (url) => urlRX.pattern.test(getPath(url));
+		return ({ url }) => urlRX.pattern.test(getPath(url));
 	},
-	path: (targetString) => (url) => getPath(url) === targetString,
+	path:
+		(targetString) =>
+		({ url }) =>
+			getPath(url) === targetString,
 };
 /**
  * @type {MatcherGenerator}
@@ -69,7 +77,7 @@ const getHeaderMatcher = ({ headers: expectedHeaders }) => {
 		return;
 	}
 	const expectation = normalizeHeaders(expectedHeaders);
-	return (url, { headers = {} }) => {
+	return ({ options: { headers = {} } }) => {
 		// TODO do something to handle multi value headers
 		const lowerCaseHeaders = normalizeHeaders(headers);
 		return Object.keys(expectation).every(
@@ -84,7 +92,7 @@ const getMethodMatcher = ({ method: expectedMethod }) => {
 	if (!expectedMethod) {
 		return;
 	}
-	return (url, { method }) => {
+	return ({ options: { method } = {} }) => {
 		const actualMethod = method ? method.toLowerCase() : 'get';
 		return expectedMethod === actualMethod;
 	};
@@ -98,7 +106,7 @@ const getQueryStringMatcher = ({ query: passedQuery }) => {
 	}
 	const expectedQuery = querystring.parse(querystring.stringify(passedQuery));
 	const keys = Object.keys(expectedQuery);
-	return (url) => {
+	return ({ url }) => {
 		const query = querystring.parse(getQuery(url));
 		return keys.every((key) => {
 			if (Array.isArray(query[key])) {
@@ -129,7 +137,7 @@ const getParamsMatcher = ({ params: expectedParams, url: matcherUrl }) => {
 		}
 		const expectedKeys = Object.keys(expectedParams);
 		const re = regexparam.parse(matcherUrl.replace(/^express:/, ''));
-		return (url) => {
+		return ({ url }) => {
 			const vals = re.pattern.exec(getPath(url)) || [];
 			vals.shift();
 			/** @type {Object.<string,string>} */
@@ -148,7 +156,8 @@ const getParamsMatcher = ({ params: expectedParams, url: matcherUrl }) => {
 const getBodyMatcher = (route) => {
 	const { body: expectedBody } = route;
 
-	return (url, { body, method = 'get' }) => {
+	return ({ url, options: { body, method = 'get' } }) => {
+		console.log({ url, body, method });
 		if (method.toLowerCase() === 'get') {
 			// GET requests don’t send a body so the body matcher should be ignored for them
 			return true;
@@ -185,7 +194,7 @@ const getFullUrlMatcher = (route, matcherUrl, query) => {
 		route.url = expectedUrl;
 	}
 
-	return (url) => {
+	return ({ url }) => {
 		if (query && expectedUrl.indexOf('?')) {
 			return getPath(url) === getPath(expectedUrl);
 		}
@@ -208,7 +217,7 @@ const getUrlMatcher = (route) => {
 	}
 
 	if (matcherUrl instanceof RegExp) {
-		return (url) => matcherUrl.test(url);
+		return ({ url }) => matcherUrl.test(url);
 	}
 	if (matcherUrl instanceof URL) {
 		if (matcherUrl.href) {

packages/core/src/RequestUtils.js

@@ -53,7 +53,7 @@ const isRequest = (urlOrRequest, Request) =>
  * @param {typeof Request} Request
  * @returns {NormalizedRequest}
  */
-export function normalizeRequest(urlOrRequest, options, Request) {
+export function normalizeRequest(urlOrRequest, options = {}, Request) {
 	if (isRequest(urlOrRequest, Request)) {
 		/** @type {NormalizedRequestOptions} */
 		const derivedOptions = {

packages/core/src/Route.js

@@ -148,8 +148,8 @@ class Route {
 			}));
 		this.config.usesBody = activeMatchers.some(({ usesBody }) => usesBody);
 		/** @type {RouteMatcherFunction} */
-		this.matcher = (url, options = {}, request) =>
-			activeMatchers.every(({ matcher }) => matcher(url, options, request));
+		this.matcher = (normalizedRequest) =>
+			activeMatchers.every(({ matcher }) => matcher(normalizedRequest));
 	}
 	/**
 	 * @returns {void}

packages/core/src/Router.js

@@ -100,7 +100,6 @@ function shouldSendAsObject(responseInput) {
  * @returns
  */
 const resolveUntilResponseConfig = async (response, normalizedRequest) => {
-	const { url, options, request } = normalizedRequest;
 	// We want to allow things like
 	// - function returning a Promise for a response
 	// - delaying (using a timeout Promise) a function's execution to generate
@@ -111,7 +110,7 @@ const resolveUntilResponseConfig = async (response, normalizedRequest) => {
 	//eslint-disable-next-line no-constant-condition
 	while (true) {
 		if (typeof response === 'function') {
-			response = response(url, options, request);
+			response = response(normalizedRequest);
 		} else if (isPromise(response)) {
 			response = await response; // eslint-disable-line  no-await-in-loop
 		} else {
@@ -164,7 +163,7 @@ export default class Router {
 				}
 				normalizedRequest.signal.addEventListener('abort', abort);
 			}
-
+			console.log(this.routes);
 			if (this.needsToReadBody(request)) {
 				options.body = await options.body;
 			}
@@ -173,7 +172,7 @@ export default class Router {
 				? [...this.routes, this.fallbackRoute]
 				: this.routes;
 			const route = routesToTry.find((route) =>
-				route.matcher(url, options, request),
+				route.matcher(normalizedRequest),
 			);
 
 			if (route) {

packages/core/src/__tests__/CallHistory.test.js

@@ -231,7 +231,7 @@ describe('CallHistory', () => {
 				});
 
 				describe('filtering with a matcher', () => {
-					//TODO write a test that just makes it clear this is contracted out to Route
+					// TODO write a test that just makes it clear this is contracted out to Route
 					// spy on route constructor, and then on matcher for that route
 					it('should be able to filter with a url matcher', async () => {
 						fm.catch();

packages/core/src/__tests__/FetchMock/response-construction.test.js

@@ -197,7 +197,7 @@ describe('response generation', () => {
 	});
 
 	it('construct a response based on the request', async () => {
-		fm.route('*', (url, opts) => url + opts.headers.header);
+		fm.route('*', ({ url, options }) => url + options.headers.header);
 		const res = await fm.fetchHandler('http://a.com/', {
 			headers: { header: 'val' },
 		});
@@ -206,7 +206,7 @@ describe('response generation', () => {
 	});
 
 	it('construct a response based on a Request instance', async () => {
-		fm.route('*', (url, opts, request) => request.json().then(({ a }) => a));
+		fm.route('*', ({ request }) => request.json().then(({ a }) => a));
 		const res = await fm.fetchHandler(
 			new fm.config.Request('http://a.com', {
 				body: JSON.stringify({ a: 'b' }),

packages/core/src/__tests__/FetchMock/response-negotiation.test.js

@@ -9,7 +9,7 @@ describe('response negotiation', () => {
 	});
 
 	it('function', async () => {
-		fm.route('*', (url) => url);
+		fm.route('*', ({ url }) => url);
 		const res = await fm.fetchHandler('http://a.com/');
 		expect(res.status).toEqual(200);
 		expect(await res.text()).toEqual('http://a.com/');
@@ -27,7 +27,7 @@ describe('response negotiation', () => {
 		expect(res.status).toEqual(300);
 	});
 	it('function that returns a Promise for a body', async () => {
-		fm.route('*', (url) => Promise.resolve(`test: ${url}`));
+		fm.route('*', ({ url }) => Promise.resolve(`test: ${url}`));
 		const res = await fm.fetchHandler('http://a.com/');
 		expect(res.status).toEqual(200);
 		expect(await res.text()).toEqual('test: http://a.com/');
@@ -36,7 +36,7 @@ describe('response negotiation', () => {
 	it('Promise for a function that returns a response', async () => {
 		fm.route(
 			'http://a.com/',
-			Promise.resolve((url) => `test: ${url}`),
+			Promise.resolve(({ url }) => `test: ${url}`),
 		);
 		const res = await fm.fetchHandler('http://a.com/');
 		expect(res.status).toEqual(200);
@@ -79,7 +79,7 @@ describe('response negotiation', () => {
 	});
 
 	it('pass values to delayed function', async () => {
-		fm.route('*', (url) => `delayed: ${url}`, {
+		fm.route('*', ({ url }) => `delayed: ${url}`, {
 			delay: 10,
 		});
 		const req = fm.fetchHandler('http://a.com/');