feat: [1502] Add the possibility to intercept sync requests

packages/happy-dom/src/browser/types/IBrowserSettings.ts

@@ -1,6 +1,6 @@
 import BrowserErrorCaptureEnum from '../enums/BrowserErrorCaptureEnum.js';
 import BrowserNavigationCrossOriginPolicyEnum from '../enums/BrowserNavigationCrossOriginPolicyEnum.js';
-import IAsyncRequestInterceptor from '../../fetch/types/IAsyncRequestInterceptor.js';
+import IFetchInterceptor from '../../fetch/types/IFetchInterceptor.js';
 
 /**
  * Browser settings.
@@ -42,9 +42,7 @@ export default interface IBrowserSettings {
 		 */
 		disableSameOriginPolicy: boolean;
 
-		intercept?: {
-			asyncFetch?: IAsyncRequestInterceptor;
-		};
+		interceptor?: IFetchInterceptor;
 	};
 
 	/**

packages/happy-dom/src/browser/types/IOptionalBrowserSettings.ts

@@ -1,6 +1,6 @@
 import BrowserErrorCaptureEnum from '../enums/BrowserErrorCaptureEnum.js';
 import BrowserNavigationCrossOriginPolicyEnum from '../enums/BrowserNavigationCrossOriginPolicyEnum.js';
-import IAsyncRequestInterceptor from '../../fetch/types/IAsyncRequestInterceptor.js';
+import IFetchInterceptor from '../../fetch/types/IFetchInterceptor.js';
 
 export default interface IOptionalBrowserSettings {
 	/** Disables JavaScript evaluation. */
@@ -36,9 +36,7 @@ export default interface IOptionalBrowserSettings {
 		 */
 		disableSameOriginPolicy?: boolean;
 
-		intercept?: {
-			asyncFetch?: IAsyncRequestInterceptor;
-		};
+		interceptor?: IFetchInterceptor;
 	};
 
 	/**

packages/happy-dom/src/fetch/Fetch.ts

@@ -26,7 +26,7 @@ import FetchResponseHeaderUtility from './utilities/FetchResponseHeaderUtility.j
 import FetchHTTPSCertificate from './certificate/FetchHTTPSCertificate.js';
 import { Buffer } from 'buffer';
 import FetchBodyUtility from './utilities/FetchBodyUtility.js';
-import IAsyncRequestInterceptor from './types/IAsyncRequestInterceptor.js';
+import IFetchInterceptor from './types/IFetchInterceptor.js';
 
 const LAST_CHUNK = Buffer.from('0\r\n\r\n');
 
@@ -51,7 +51,7 @@ export default class Fetch {
 	private nodeResponse: IncomingMessage | null = null;
 	private response: Response | null = null;
 	private responseHeaders: Headers | null = null;
-	private requestInterceptor?: IAsyncRequestInterceptor;
+	private interceptor?: IFetchInterceptor;
 	private request: Request;
 	private redirectCount = 0;
 	private disableCache: boolean;
@@ -101,8 +101,7 @@ export default class Fetch {
 			options.disableSameOriginPolicy ??
 			this.#browserFrame.page.context.browser.settings.fetch.disableSameOriginPolicy ??
 			false;
-		this.requestInterceptor =
-			this.#browserFrame.page.context.browser.settings.fetch.intercept?.asyncFetch;
+		this.interceptor = this.#browserFrame.page.context.browser.settings.fetch.interceptor;
 	}
 
 	/**
@@ -112,11 +111,14 @@ export default class Fetch {
 	 */
 	public async send(): Promise<Response> {
 		FetchRequestReferrerUtility.prepareRequest(new URL(this.#window.location.href), this.request);
-		const beforeSendResponse = this.requestInterceptor?.beforeSend
-			? await this.requestInterceptor?.beforeSend(this.request, this.#window)
+		const beforeRequestResponse = this.interceptor?.beforeAsyncRequest
+			? await this.interceptor?.beforeAsyncRequest({
+					request: this.request,
+					window: this.#window
+				})
 			: undefined;
-		if (beforeSendResponse instanceof Response) {
-			return beforeSendResponse;
+		if (beforeRequestResponse instanceof Response) {
+			return beforeRequestResponse;
 		}
 		FetchRequestValidationUtility.validateSchema(this.request);
 

packages/happy-dom/src/fetch/SyncFetch.ts

@@ -20,6 +20,7 @@ import Zlib from 'zlib';
 import FetchResponseRedirectUtility from './utilities/FetchResponseRedirectUtility.js';
 import FetchCORSUtility from './utilities/FetchCORSUtility.js';
 import Fetch from './Fetch.js';
+import IFetchInterceptor from "./types/IFetchInterceptor.js";
 
 interface ISyncHTTPResponse {
 	error: string;
@@ -39,6 +40,7 @@ export default class SyncFetch {
 	private redirectCount = 0;
 	private disableCache: boolean;
 	private disableSameOriginPolicy: boolean;
+	private interceptor?: IFetchInterceptor;
 	#browserFrame: IBrowserFrame;
 	#window: BrowserWindow;
 	#unfilteredHeaders: Headers | null = null;
@@ -84,6 +86,7 @@ export default class SyncFetch {
 			options.disableSameOriginPolicy ??
 			this.#browserFrame.page.context.browser.settings.fetch.disableSameOriginPolicy ??
 			false;
+		this.interceptor = this.#browserFrame.page.context.browser.settings.fetch.interceptor;
 	}
 
 	/**
@@ -93,6 +96,15 @@ export default class SyncFetch {
 	 */
 	public send(): ISyncResponse {
 		FetchRequestReferrerUtility.prepareRequest(new URL(this.#window.location.href), this.request);
+		const beforeRequestResponse = this.interceptor?.beforeSyncRequest
+			? this.interceptor?.beforeSyncRequest({
+					request: this.request,
+					window: this.#window
+			})
+			: undefined;
+		if (typeof beforeRequestResponse === 'object') {
+			return beforeRequestResponse;
+		}
 		FetchRequestValidationUtility.validateSchema(this.request);
 
 		if (this.request.signal.aborted) {

packages/happy-dom/src/fetch/types/IFetchInterceptor.ts

@@ -0,0 +1,60 @@
+import Request from '../Request.js';
+import BrowserWindow from '../../window/BrowserWindow.js';
+import Response from '../Response.js';
+import ISyncResponse from './ISyncResponse.js';
+
+export default interface IFetchInterceptor {
+	/**
+	 * Hook dispatched before making an async request.
+	 * It can be used for modifying the request, providing a response without making a request or for logging.
+	 *
+	 * @param context Contains the request and the window from where the request was made.
+	 *
+	 * @returns Promise that can resolve to a response to be used instead of sending out the response.
+	 */
+	beforeAsyncRequest?: (context: {
+		request: Request;
+		window: BrowserWindow;
+	}) => Promise<Response | void>;
+
+	/**
+	 * Hook dispatched before making an sync request.
+	 * It can be used for modifying the request, providing a response without making a request or for logging.
+	 *
+	 * @param context Contains the request and the window from where the request was made.
+	 *
+	 * @returns Promise that can resolve to a response to be used instead of sending out the response.
+	 */
+	beforeSyncRequest?: (context: {
+		request: Request;
+		window: BrowserWindow;
+	}) => ISyncResponse | void;
+
+	/**
+	 * Hook dispatched after receiving an async response.
+	 * It can be used for modifying or replacing the response and logging.
+	 *
+	 * @param context Contains the request, response and the window from where the request was made.
+	 *
+	 * @returns Promise that can resolve to a response to be used instead of sending out the response.
+	 */
+	afterAsyncResponse?: (context: {
+		request: Request;
+		response: Response;
+		window: BrowserWindow;
+	}) => Promise<Response | void>;
+
+	/**
+	 * Hook dispatched after receiving a sync response.
+	 * It can be used for modifying or replacing the response and logging
+	 *
+	 * @param context Contains the request, response and the window from where the request was made.
+	 *
+	 * @returns Promise that can resolve to a response to be used instead of sending out the response.
+	 */
+	afterSyncResponse?: (context: {
+		request: Request;
+		response: Response;
+		window: BrowserWindow;
+	}) => Promise<Response | void>;
+}

packages/happy-dom/src/index.ts

@@ -57,7 +57,7 @@ import AbortSignal from './fetch/AbortSignal.js';
 import Headers from './fetch/Headers.js';
 import Request from './fetch/Request.js';
 import Response from './fetch/Response.js';
-import IAsyncRequestInterceptor from './fetch/types/IAsyncRequestInterceptor.js';
+import IFetchInterceptor from './fetch/types/IFetchInterceptor.js';
 import Blob from './file/Blob.js';
 import File from './file/File.js';
 import FileReader from './file/FileReader.js';
@@ -207,7 +207,7 @@ import type ITouchEventInit from './event/events/ITouchEventInit.js';
 import type IWheelEventInit from './event/events/IWheelEventInit.js';
 
 export type {
-	IAsyncRequestInterceptor,
+	IFetchInterceptor,
 	IAnimationEventInit,
 	IBrowser,
 	IBrowserContext,

packages/happy-dom/test/fetch/Fetch.test.ts

@@ -1364,18 +1364,15 @@ describe('Fetch', () => {
 			);
 		});
 
-		it('Uses intercepted response when beforeSend returns a Response', async () => {
+		it('Should use intercepted response and not send the request when beforeAsyncRequest returns a Response', async () => {
 			const originURL = 'https://localhost:8080/';
-			const responseText = 'some text';
 			const window = new Window({
 				url: originURL,
 				settings: {
 					fetch: {
-						intercept: {
-							asyncFetch: {
-								async beforeSend(_request, window) {
-									return new window.Response('intercepted text');
-								}
+						interceptor: {
+							async beforeAsyncRequest({ window }) {
+								return new window.Response('intercepted text');
 							}
 						}
 					}
@@ -1385,31 +1382,7 @@ describe('Fetch', () => {
 
 			mockModule('https', {
 				request: () => {
-					return {
-						end: () => {},
-						on: (event: string, callback: (response: HTTP.IncomingMessage) => void) => {
-							if (event === 'response') {
-								async function* generate(): AsyncGenerator<string> {
-									yield responseText;
-								}
-
-								const response = <HTTP.IncomingMessage>Stream.Readable.from(generate());
-
-								response.statusCode = 200;
-								response.statusMessage = 'OK';
-								response.headers = {};
-								response.rawHeaders = [
-									'content-type',
-									'text/html',
-									'content-length',
-									String(responseText.length)
-								];
-
-								callback(response);
-							}
-						},
-						setTimeout: () => {}
-					};
+					fail('No request should be made when beforeAsyncRequest returns a Response');
 				}
 			});
 
@@ -1418,18 +1391,16 @@ describe('Fetch', () => {
 			expect(await response.text()).toBe('intercepted text');
 		});
 
-		it('Makes a normal request when before does not return a Response', async () => {
+		it('Should make a normal request when before does not return a Response', async () => {
 			const originURL = 'https://localhost:8080/';
 			const responseText = 'some text';
 			const window = new Window({
 				url: originURL,
 				settings: {
 					fetch: {
-						intercept: {
-							asyncFetch: {
-								async beforeSend() {
-									return undefined;
-								}
+						interceptor: {
+							async beforeAsyncRequest() {
+								return undefined;
 							}
 						}
 					}