happy-dom 16.8.1 → 20.0.2

package/src/fetch/Request.ts

@@ -1,6 +1,6 @@
 import * as PropertySymbol from '../PropertySymbol.js';
 import IRequestInit from './types/IRequestInit.js';
-import URL from '../url/URL.js';
+import { URL } from 'url';
 import DOMExceptionNameEnum from '../exception/DOMExceptionNameEnum.js';
 import IRequestInfo from './types/IRequestInfo.js';
 import Headers from './Headers.js';
@@ -18,6 +18,7 @@ import FormData from '../form-data/FormData.js';
 import MultipartFormDataParser from './multipart/MultipartFormDataParser.js';
 import BrowserWindow from '../window/BrowserWindow.js';
 import WindowBrowserContext from '../window/WindowBrowserContext.js';
+import IRequestMode from './types/IRequestMode.js';
 
 /**
  * Fetch request.
@@ -32,17 +33,19 @@ export default class Request implements Request {
 	protected declare [PropertySymbol.window]: BrowserWindow;
 
 	// Public properties
-	public readonly method: string;
-	public readonly body: ReadableStream | null;
-	public readonly headers: Headers;
-	public readonly redirect: IRequestRedirect;
-	public readonly referrerPolicy: IRequestReferrerPolicy;
-	public readonly signal: AbortSignal;
-	public readonly bodyUsed: boolean = false;
-	public readonly credentials: IRequestCredentials;
+	public [PropertySymbol.method]: string;
+	public [PropertySymbol.body]: ReadableStream | null;
+	public [PropertySymbol.mode]: IRequestMode = 'cors';
+	public [PropertySymbol.headers]: Headers;
+	public [PropertySymbol.redirect]: IRequestRedirect;
+	public [PropertySymbol.referrerPolicy]: IRequestReferrerPolicy;
+	public [PropertySymbol.signal]: AbortSignal;
+	public [PropertySymbol.bodyUsed]: boolean = false;
+	public [PropertySymbol.credentials]: IRequestCredentials;
 
 	// Internal properties
 	public [PropertySymbol.aborted]: boolean = false;
+	public [PropertySymbol.error]: Error | null = null;
 	public [PropertySymbol.contentLength]: number | null = null;
 	public [PropertySymbol.contentType]: string | null = null;
 	public [PropertySymbol.referrer]: '' | 'no-referrer' | 'client' | URL = 'client';
@@ -64,24 +67,48 @@ export default class Request implements Request {
 			);
 		}
 
-		if (!input) {
+		if (typeof input !== `string` && !input) {
 			throw new window.TypeError(
 				`Failed to contruct 'Request': 1 argument required, only 0 present.`
 			);
 		}
 
-		this.method = (init?.method || (<Request>input).method || 'GET').toUpperCase();
+		this[PropertySymbol.method] = (init?.method || (<Request>input).method || 'GET').toUpperCase();
+
+		if (init?.mode) {
+			switch (init.mode) {
+				case 'navigate':
+				case 'websocket':
+					throw new window.DOMException(
+						`Failed to construct 'Request': Cannot construct a Request with a RequestInit whose mode member is set as '${init.mode}'.`,
+						DOMExceptionNameEnum.securityError
+					);
+				case 'same-origin':
+				case 'no-cors':
+				case 'cors':
+					this[PropertySymbol.mode] = init.mode;
+					break;
+				default:
+					throw new window.DOMException(
+						`Failed to construct 'Request': The provided value '${init.mode}' is not a valid enum value of type RequestMode.`,
+						DOMExceptionNameEnum.syntaxError
+					);
+			}
+		} else if (input instanceof Request) {
+			this[PropertySymbol.mode] = input.mode;
+		}
 
 		const { stream, buffer, contentType, contentLength } = FetchBodyUtility.getBodyStream(
 			input instanceof Request && (input[PropertySymbol.bodyBuffer] || input.body)
 				? input[PropertySymbol.bodyBuffer] || FetchBodyUtility.cloneBodyStream(window, input)
-				: init?.body
+				: (init?.body ?? null)
 		);
 
 		this[PropertySymbol.bodyBuffer] = buffer;
-		this.body = stream;
-		this.credentials = init?.credentials || (<Request>input).credentials || 'same-origin';
-		this.headers = new Headers(init?.headers || (<Request>input).headers || {});
+		this[PropertySymbol.body] = stream;
+		this[PropertySymbol.credentials] =
+			init?.credentials || (<Request>input).credentials || 'same-origin';
+		this[PropertySymbol.headers] = new Headers(init?.headers || (<Request>input).headers || {});
 
 		FetchRequestHeaderUtility.removeForbiddenHeaders(this.headers);
 
@@ -100,11 +127,12 @@ export default class Request implements Request {
 			this[PropertySymbol.contentType] = input[PropertySymbol.contentType];
 		}
 
-		this.redirect = init?.redirect || (<Request>input).redirect || 'follow';
-		this.referrerPolicy = <IRequestReferrerPolicy>(
+		this[PropertySymbol.redirect] = init?.redirect || (<Request>input).redirect || 'follow';
+		this[PropertySymbol.referrerPolicy] = <IRequestReferrerPolicy>(
 			(init?.referrerPolicy || (<Request>input).referrerPolicy || '').toLowerCase()
 		);
-		this.signal = init?.signal || (<Request>input).signal || new window.AbortSignal();
+		this[PropertySymbol.signal] =
+			init?.signal || (<Request>input).signal || new window.AbortSignal();
 		this[PropertySymbol.referrer] = FetchRequestReferrerUtility.getInitialReferrer(
 			window,
 			init?.referrer !== null && init?.referrer !== undefined
@@ -142,6 +170,87 @@ export default class Request implements Request {
 		FetchRequestValidationUtility.validateRedirect(this.redirect);
 	}
 
+	/**
+	 * Returns method.
+	 *
+	 * @returns Method.
+	 */
+	public get method(): string {
+		return this[PropertySymbol.method];
+	}
+
+	/**
+	 * Returns body.
+	 *
+	 * @returns Body.
+	 */
+	public get body(): ReadableStream | null {
+		return this[PropertySymbol.body];
+	}
+
+	/**
+	 * Returns mode.
+	 *
+	 * @returns Mode.
+	 */
+	public get mode(): IRequestMode {
+		return this[PropertySymbol.mode];
+	}
+
+	/**
+	 * Returns headers.
+	 *
+	 * @returns Headers.
+	 */
+	public get headers(): Headers {
+		return this[PropertySymbol.headers];
+	}
+
+	/**
+	 * Returns redirect.
+	 *
+	 * @returns Redirect.
+	 */
+	public get redirect(): IRequestRedirect {
+		return this[PropertySymbol.redirect];
+	}
+
+	/**
+	 * Returns referrer policy.
+	 *
+	 * @returns Referrer policy.
+	 */
+	public get referrerPolicy(): IRequestReferrerPolicy {
+		return this[PropertySymbol.referrerPolicy];
+	}
+
+	/**
+	 * Returns signal.
+	 *
+	 * @returns Signal.
+	 */
+	public get signal(): AbortSignal {
+		return this[PropertySymbol.signal];
+	}
+
+	/**
+	 * Returns body used.
+	 *
+	 * @returns Body used.
+	 */
+	public get bodyUsed(): boolean {
+		return this[PropertySymbol.bodyUsed];
+	}
+
+	/**
+	 * Returns credentials.
+	 *
+	 * @returns Credentials.
+	 */
+	public get credentials(): IRequestCredentials {
+		return this[PropertySymbol.credentials];
+	}
+
 	/**
 	 * Returns referrer.
 	 *
@@ -185,27 +294,25 @@ export default class Request implements Request {
 	public async arrayBuffer(): Promise<ArrayBuffer> {
 		const window = this[PropertySymbol.window];
 
-		if (this.bodyUsed) {
+		if (this[PropertySymbol.bodyUsed]) {
 			throw new window.DOMException(
 				`Body has already been used for "${this.url}".`,
 				DOMExceptionNameEnum.invalidStateError
 			);
 		}
 
-		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager();
+		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager()!;
 
-		(<boolean>this.bodyUsed) = true;
+		this[PropertySymbol.bodyUsed] = true;
 
 		const taskID = asyncTaskManager.startTask(() => {
-			if (this.body) {
-				this.body[PropertySymbol.aborted] = true;
-			}
+			this[PropertySymbol.aborted] = true;
 			this.signal[PropertySymbol.abort]();
 		});
 		let buffer: Buffer;
 
 		try {
-			buffer = await FetchBodyUtility.consumeBodyStream(window, this.body);
+			buffer = await FetchBodyUtility.consumeBodyStream(window, this);
 		} catch (error) {
 			asyncTaskManager.endTask(taskID);
 			throw error;
@@ -213,7 +320,9 @@ export default class Request implements Request {
 
 		asyncTaskManager.endTask(taskID);
 
-		return buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength);
+		return <ArrayBuffer>(
+			buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength)
+		);
 	}
 
 	/**
@@ -236,27 +345,25 @@ export default class Request implements Request {
 	public async buffer(): Promise<Buffer> {
 		const window = this[PropertySymbol.window];
 
-		if (this.bodyUsed) {
+		if (this[PropertySymbol.bodyUsed]) {
 			throw new window.DOMException(
 				`Body has already been used for "${this.url}".`,
 				DOMExceptionNameEnum.invalidStateError
 			);
 		}
 
-		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager();
+		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager()!;
 
-		(<boolean>this.bodyUsed) = true;
+		this[PropertySymbol.bodyUsed] = true;
 
 		const taskID = asyncTaskManager.startTask(() => {
-			if (this.body) {
-				this.body[PropertySymbol.aborted] = true;
-			}
+			this[PropertySymbol.aborted] = true;
 			this.signal[PropertySymbol.abort]();
 		});
 		let buffer: Buffer;
 
 		try {
-			buffer = await FetchBodyUtility.consumeBodyStream(window, this.body);
+			buffer = await FetchBodyUtility.consumeBodyStream(window, this);
 		} catch (error) {
 			asyncTaskManager.endTask(taskID);
 			throw error;
@@ -275,27 +382,25 @@ export default class Request implements Request {
 	public async text(): Promise<string> {
 		const window = this[PropertySymbol.window];
 
-		if (this.bodyUsed) {
+		if (this[PropertySymbol.bodyUsed]) {
 			throw new window.DOMException(
 				`Body has already been used for "${this.url}".`,
 				DOMExceptionNameEnum.invalidStateError
 			);
 		}
 
-		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager();
+		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager()!;
 
-		(<boolean>this.bodyUsed) = true;
+		this[PropertySymbol.bodyUsed] = true;
 
 		const taskID = asyncTaskManager.startTask(() => {
-			if (this.body) {
-				this.body[PropertySymbol.aborted] = true;
-			}
+			this[PropertySymbol.aborted] = true;
 			this.signal[PropertySymbol.abort]();
 		});
 		let buffer: Buffer;
 
 		try {
-			buffer = await FetchBodyUtility.consumeBodyStream(window, this.body);
+			buffer = await FetchBodyUtility.consumeBodyStream(window, this);
 		} catch (error) {
 			asyncTaskManager.endTask(taskID);
 			throw error;
@@ -323,33 +428,28 @@ export default class Request implements Request {
 	 */
 	public async formData(): Promise<FormData> {
 		const window = this[PropertySymbol.window];
-		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager();
+		const asyncTaskManager = new WindowBrowserContext(window).getAsyncTaskManager()!;
+
 		const contentType = this[PropertySymbol.contentType];
 
-		if (/multipart/i.test(contentType)) {
-			if (this.bodyUsed) {
+		if (this.body && contentType && /multipart/i.test(contentType)) {
+			if (this[PropertySymbol.bodyUsed]) {
 				throw new window.DOMException(
 					`Body has already been used for "${this.url}".`,
 					DOMExceptionNameEnum.invalidStateError
 				);
 			}
 
-			(<boolean>this.bodyUsed) = true;
+			this[PropertySymbol.bodyUsed] = true;
 
 			const taskID = asyncTaskManager.startTask(() => {
-				if (this.body) {
-					this.body[PropertySymbol.aborted] = true;
-				}
+				this[PropertySymbol.aborted] = true;
 				this.signal[PropertySymbol.abort]();
 			});
 			let formData: FormData;
 
 			try {
-				const result = await MultipartFormDataParser.streamToFormData(
-					window,
-					this.body,
-					contentType
-				);
+				const result = await MultipartFormDataParser.streamToFormData(window, this, contentType);
 				formData = result.formData;
 			} catch (error) {
 				asyncTaskManager.endTask(taskID);

package/src/fetch/ResourceFetch.ts

@@ -1,41 +1,95 @@
 import BrowserWindow from '../window/BrowserWindow.js';
 import URL from '../url/URL.js';
-import IBrowserFrame from '../browser/types/IBrowserFrame.js';
 import Fetch from './Fetch.js';
 import SyncFetch from './SyncFetch.js';
+import IRequestCredentials from './types/IRequestCredentials.js';
+import WindowBrowserContext from '../window/WindowBrowserContext.js';
+import PreloadUtility from './preload/PreloadUtility.js';
+import * as PropertySymbol from '../PropertySymbol.js';
+import IRequestReferrerPolicy from './types/IRequestReferrerPolicy.js';
+import IResourceFetchResponse from './types/IResourceFetchResponse.js';
 
 /**
  * Helper class for performing fetch of resources.
  */
 export default class ResourceFetch {
 	private window: BrowserWindow;
-	#browserFrame: IBrowserFrame;
 
 	/**
 	 * Constructor.
 	 *
-	 * @param options Options.
-	 * @param options.browserFrame Browser frame.
-	 * @param options.window Window.
+	 * @param window Window.
 	 */
-	constructor(options: { browserFrame: IBrowserFrame; window: BrowserWindow }) {
-		this.#browserFrame = options.browserFrame;
-		this.window = options.window;
+	constructor(window: BrowserWindow) {
+		this.window = window;
 	}
 
 	/**
 	 * Returns resource data asynchronously.
 	 *
 	 * @param url URL.
+	 * @param destination Destination.
+	 * @param [options]
+	 * @param [options.credentials] Credentials.
+	 * @param options.referrerPolicy
 	 * @returns Response.
 	 */
-	public async fetch(url: string): Promise<string> {
+	public async fetch(
+		url: string | URL,
+		destination: 'script' | 'style' | 'module',
+		options?: { credentials?: IRequestCredentials; referrerPolicy?: IRequestReferrerPolicy }
+	): Promise<IResourceFetchResponse> {
+		const browserFrame = new WindowBrowserContext(this.window).getBrowserFrame();
+
+		if (!browserFrame) {
+			return {
+				content: '',
+				virtualServerFile: null
+			};
+		}
+
+		// Preloaded resource
+		if (destination === 'script' || destination === 'style') {
+			const preloadKey = PreloadUtility.getKey({
+				url: String(url),
+				destination,
+				mode: 'cors',
+				credentialsMode: options?.credentials || 'same-origin'
+			});
+			const preloadEntry = this.window.document[PropertySymbol.preloads].get(preloadKey);
+
+			if (preloadEntry) {
+				this.window.document[PropertySymbol.preloads].delete(preloadKey);
+
+				const response = preloadEntry.response || (await preloadEntry.onResponseAvailable());
+
+				if (response && !response.ok) {
+					throw new this.window.DOMException(
+						`Failed to perform request to "${
+							new URL(url, this.window.location.href).href
+						}". Status ${preloadEntry.response?.status || '0'} ${preloadEntry.response?.statusText || 'Unknown'}.`
+					);
+				}
+
+				return {
+					content: preloadEntry.response?.[PropertySymbol.buffer]?.toString() || '',
+					virtualServerFile: preloadEntry.response?.[PropertySymbol.virtualServerFile] || null
+				};
+			}
+		}
+
 		const fetch = new Fetch({
-			browserFrame: this.#browserFrame,
+			browserFrame,
 			window: this.window,
 			url,
-			disableSameOriginPolicy: true
+			disableSameOriginPolicy: destination === 'script' || destination === 'style',
+			disablePreload: true,
+			init: {
+				credentials: options?.credentials,
+				referrerPolicy: options?.referrerPolicy
+			}
 		});
+
 		const response = await fetch.send();
 
 		if (!response.ok) {
@@ -46,21 +100,76 @@ export default class ResourceFetch {
 			);
 		}
 
-		return await response.text();
+		return {
+			content: await response.text(),
+			virtualServerFile: response[PropertySymbol.virtualServerFile] || null
+		};
 	}
 
 	/**
 	 * Returns resource data synchronously.
 	 *
 	 * @param url URL.
+	 * @param destination Destination.
+	 * @param [options] Options.
+	 * @param [options.credentials] Credentials.
+	 * @param [options.referrerPolicy] Referrer policy.
 	 * @returns Response.
 	 */
-	public fetchSync(url: string): string {
+	public fetchSync(
+		url: string,
+		destination: 'script' | 'style' | 'module',
+		options?: { credentials?: IRequestCredentials; referrerPolicy?: IRequestReferrerPolicy }
+	): IResourceFetchResponse {
+		const browserFrame = new WindowBrowserContext(this.window).getBrowserFrame();
+
+		if (!browserFrame) {
+			return {
+				content: '',
+				virtualServerFile: null
+			};
+		}
+
+		// Preloaded resource
+		if (destination === 'script' || destination === 'style') {
+			const preloadKey = PreloadUtility.getKey({
+				url: String(url),
+				destination,
+				mode: 'cors',
+				credentialsMode: options?.credentials || 'same-origin'
+			});
+			const preloadEntry = this.window.document[PropertySymbol.preloads].get(preloadKey);
+
+			// We will only use this if the fetch for the resource is complete as it is async and this request is sync.
+			if (preloadEntry && preloadEntry.response) {
+				this.window.document[PropertySymbol.preloads].delete(preloadKey);
+
+				const response = preloadEntry.response;
+
+				if (!response.ok) {
+					throw new this.window.DOMException(
+						`Failed to perform request to "${
+							new URL(url, this.window.location.href).href
+						}". Status ${preloadEntry.response.status} ${preloadEntry.response.statusText}.`
+					);
+				}
+
+				return {
+					content: preloadEntry.response?.[PropertySymbol.buffer]?.toString() || '',
+					virtualServerFile: preloadEntry.response?.[PropertySymbol.virtualServerFile] || null
+				};
+			}
+		}
+
 		const fetch = new SyncFetch({
-			browserFrame: this.#browserFrame,
+			browserFrame,
 			window: this.window,
 			url,
-			disableSameOriginPolicy: true
+			disableSameOriginPolicy: true,
+			init: {
+				credentials: options?.credentials,
+				referrerPolicy: options?.referrerPolicy
+			}
 		});
 
 		const response = fetch.send();
@@ -73,6 +182,9 @@ export default class ResourceFetch {
 			);
 		}
 
-		return response.body.toString();
+		return {
+			content: response.body?.toString() || '',
+			virtualServerFile: response[PropertySymbol.virtualServerFile] || null
+		};
 	}
 }

package/src/fetch/Response.ts

@@ -43,6 +43,9 @@ export default class Response implements Response {
 	public readonly headers: Headers;
 	public [PropertySymbol.cachedResponse]: ICachedResponse | null = null;
 	public [PropertySymbol.buffer]: Buffer | null = null;
+	public [PropertySymbol.virtualServerFile]: string | null = null;
+	public [PropertySymbol.aborted]: boolean = false;
+	public [PropertySymbol.error]: Error | null = null;
 
 	/**
 	 * Constructor.
@@ -119,13 +122,11 @@ export default class Response implements Response {
 
 		if (!buffer) {
 			const taskID = asyncTaskManager.startTask(() => {
-				if (this.body) {
-					this.body[PropertySymbol.aborted] = true;
-				}
+				this[PropertySymbol.aborted] = true;
 			});
 
 			try {
-				buffer = await FetchBodyUtility.consumeBodyStream(window, this.body);
+				buffer = await FetchBodyUtility.consumeBodyStream(window, this);
 			} catch (error) {
 				asyncTaskManager.endTask(taskID);
 				throw error;
@@ -136,7 +137,9 @@ export default class Response implements Response {
 
 		this.#storeBodyInCache(buffer);
 
-		return buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength);
+		return <ArrayBuffer>(
+			buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength)
+		);
 	}
 
 	/**
@@ -181,12 +184,10 @@ export default class Response implements Response {
 
 		if (!buffer) {
 			const taskID = asyncTaskManager.startTask(() => {
-				if (this.body) {
-					this.body[PropertySymbol.aborted] = true;
-				}
+				this[PropertySymbol.aborted] = true;
 			});
 			try {
-				buffer = await FetchBodyUtility.consumeBodyStream(window, this.body);
+				buffer = await FetchBodyUtility.consumeBodyStream(window, this);
 			} catch (error) {
 				asyncTaskManager.endTask(taskID);
 				throw error;
@@ -229,12 +230,10 @@ export default class Response implements Response {
 
 		if (!buffer) {
 			const taskID = asyncTaskManager.startTask(() => {
-				if (this.body) {
-					this.body[PropertySymbol.aborted] = true;
-				}
+				this[PropertySymbol.aborted] = true;
 			});
 			try {
-				buffer = await FetchBodyUtility.consumeBodyStream(window, this.body);
+				buffer = await FetchBodyUtility.consumeBodyStream(window, this);
 			} catch (error) {
 				asyncTaskManager.endTask(taskID);
 				throw error;
@@ -274,7 +273,7 @@ export default class Response implements Response {
 		const asyncTaskManager = browserFrame[PropertySymbol.asyncTaskManager];
 		const contentType = this.headers.get('Content-Type');
 
-		if (/multipart/i.test(contentType)) {
+		if (contentType && this.body && /multipart/i.test(contentType)) {
 			if (this.bodyUsed) {
 				throw new window.DOMException(
 					`Body has already been used for "${this.url}".`,
@@ -285,19 +284,13 @@ export default class Response implements Response {
 			(<boolean>this.bodyUsed) = true;
 
 			const taskID = browserFrame[PropertySymbol.asyncTaskManager].startTask(() => {
-				if (this.body) {
-					this.body[PropertySymbol.aborted] = true;
-				}
+				this[PropertySymbol.aborted] = true;
 			});
 			let formData: FormData;
 			let buffer: Buffer;
 
 			try {
-				const result = await MultipartFormDataParser.streamToFormData(
-					window,
-					this.body,
-					contentType
-				);
+				const result = await MultipartFormDataParser.streamToFormData(window, this, contentType);
 				formData = result.formData;
 				buffer = result.buffer;
 			} catch (error) {
@@ -359,6 +352,8 @@ export default class Response implements Response {
 	 * @param buffer Buffer.
 	 */
 	#storeBodyInCache(buffer: Buffer): void {
+		this[PropertySymbol.buffer] = buffer;
+
 		if (this[PropertySymbol.cachedResponse]?.response?.waitingForBody) {
 			this[PropertySymbol.cachedResponse].response.body = buffer;
 			this[PropertySymbol.cachedResponse].response.waitingForBody = false;