happy-dom 16.6.0 → 16.7.1

package/src/cookie/DefaultCookie.ts

@@ -0,0 +1,17 @@
+import CookieSameSiteEnum from './enums/CookieSameSiteEnum.js';
+import ICookie from './ICookie.js';
+
+export default <ICookie>{
+	// Required
+	key: null,
+	originURL: null,
+
+	// Optional
+	value: null,
+	domain: '',
+	path: '',
+	expires: null,
+	httpOnly: false,
+	secure: false,
+	sameSite: CookieSameSiteEnum.lax
+};

package/src/cookie/ICookie.ts

@@ -3,10 +3,8 @@ import CookieSameSiteEnum from './enums/CookieSameSiteEnum.js';
 export default interface ICookie {
 	// Required
 	key: string;
-	value: string | null;
 	originURL: URL;
-
-	// Optional
+	value: string | null;
 	domain: string;
 	path: string;
 	expires: Date | null;

package/src/cookie/ICookieContainer.ts

@@ -22,5 +22,5 @@ export default interface ICookieContainer {
 	 * @param [httpOnly] "true" if only http cookies should be returned.
 	 * @returns Cookies.
 	 */
-	getCookies(url: URL | null, httpOnly: boolean): ICookie[];
+	getCookies(url: URL | null, httpOnly?: boolean): ICookie[];
 }

package/src/cookie/IOptionalCookie.ts

@@ -0,0 +1,16 @@
+import CookieSameSiteEnum from './enums/CookieSameSiteEnum.js';
+
+export default interface IOptionalCookie {
+	// Required
+	key: string;
+	originURL: URL;
+
+	// Optional
+	value?: string | null;
+	domain?: string;
+	path?: string;
+	expires?: Date | null;
+	httpOnly?: boolean;
+	secure?: boolean;
+	sameSite?: CookieSameSiteEnum;
+}

package/src/cookie/urilities/CookieStringUtility.ts

@@ -1,6 +1,7 @@
 import CookieSameSiteEnum from '../enums/CookieSameSiteEnum.js';
 import URL from '../../url/URL.js';
 import ICookie from '../ICookie.js';
+import DefaultCookie from '../DefaultCookie.js';
 
 /**
  * Cookie string.
@@ -20,20 +21,12 @@ export default class CookieStringUtility {
 		const key = index !== -1 ? part.slice(0, index).trim() : part.trim();
 		const value = index !== -1 ? part.slice(index + 1).trim() : null;
 
-		const cookie: ICookie = {
+		const cookie: ICookie = Object.assign({}, DefaultCookie, {
 			// Required
 			key,
 			value,
-			originURL,
-
-			// Optional
-			domain: '',
-			path: '',
-			expires: null,
-			httpOnly: false,
-			secure: false,
-			sameSite: CookieSameSiteEnum.lax
-		};
+			originURL
+		});
 
 		// Invalid if key is empty.
 		if (!cookie.key) {

package/src/fetch/Fetch.ts

@@ -8,6 +8,8 @@ import HTTP, { IncomingMessage } from 'http';
 import HTTPS from 'https';
 import Zlib from 'zlib';
 import URL from '../url/URL.js';
+import FS from 'fs';
+import Path from 'path';
 import { Socket } from 'net';
 import Stream from 'stream';
 import DataURIParser from './data-uri/DataURIParser.js';
@@ -27,6 +29,7 @@ import FetchHTTPSCertificate from './certificate/FetchHTTPSCertificate.js';
 import { Buffer } from 'buffer';
 import FetchBodyUtility from './utilities/FetchBodyUtility.js';
 import IFetchInterceptor from './types/IFetchInterceptor.js';
+import VirtualServerUtility from './utilities/VirtualServerUtility.js';
 
 const LAST_CHUNK = Buffer.from('0\r\n\r\n');
 
@@ -51,7 +54,7 @@ export default class Fetch {
 	private nodeResponse: IncomingMessage | null = null;
 	private response: Response | null = null;
 	private responseHeaders: Headers | null = null;
-	private interceptor?: IFetchInterceptor;
+	private interceptor: IFetchInterceptor | null;
 	private request: Request;
 	private redirectCount = 0;
 	private disableCache: boolean;
@@ -111,17 +114,27 @@ export default class Fetch {
 	 */
 	public async send(): Promise<Response> {
 		FetchRequestReferrerUtility.prepareRequest(new URL(this.#window.location.href), this.request);
-		const beforeRequestResponse = this.interceptor?.beforeAsyncRequest
-			? await this.interceptor.beforeAsyncRequest({
-					request: this.request,
-					window: this.#window
-				})
-			: undefined;
-		if (beforeRequestResponse instanceof Response) {
-			return beforeRequestResponse;
+
+		if (this.interceptor?.beforeAsyncRequest) {
+			const taskID = this.#browserFrame[PropertySymbol.asyncTaskManager].startTask();
+			const response = await this.interceptor.beforeAsyncRequest({
+				request: this.request,
+				window: this.#window
+			});
+			this.#browserFrame[PropertySymbol.asyncTaskManager].endTask(taskID);
+			if (response instanceof Response) {
+				return response;
+			}
 		}
+
 		FetchRequestValidationUtility.validateSchema(this.request);
 
+		const virtualServerResponse = await this.getVirtualServerResponse();
+
+		if (virtualServerResponse) {
+			return virtualServerResponse;
+		}
+
 		if (this.request.signal.aborted) {
 			throw new this.#window.DOMException(
 				'The operation was aborted.',
@@ -171,7 +184,7 @@ export default class Fetch {
 			const compliesWithCrossOriginPolicy = await this.compliesWithCrossOriginPolicy();
 
 			if (!compliesWithCrossOriginPolicy) {
-				this.#window.console.warn(
+				this.#browserFrame?.page?.console.warn(
 					`Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at "${this.request.url}".`
 				);
 				throw new this.#window.DOMException(
@@ -270,6 +283,62 @@ export default class Fetch {
 		return response;
 	}
 
+	/**
+	 * Returns virtual server response.
+	 *
+	 * @returns Response.
+	 */
+	private async getVirtualServerResponse(): Promise<Response | null> {
+		const filePath = VirtualServerUtility.getFilepath(this.#window, this.request.url);
+
+		if (!filePath) {
+			return null;
+		}
+
+		if (this.request.method !== 'GET') {
+			this.#browserFrame?.page?.console.error(
+				`${this.request.method} ${this.request.url} 404 (Not Found)`
+			);
+			return VirtualServerUtility.getNotFoundResponse(this.#window);
+		}
+
+		const taskID = this.#browserFrame[PropertySymbol.asyncTaskManager].startTask();
+		let buffer: Buffer;
+
+		try {
+			const stat = await FS.promises.stat(filePath);
+			buffer = await FS.promises.readFile(
+				stat.isDirectory() ? Path.join(filePath, 'index.html') : filePath
+			);
+		} catch (error) {
+			this.#browserFrame?.page?.console.error(
+				`${this.request.method} ${this.request.url} 404 (Not Found)`
+			);
+
+			this.#browserFrame[PropertySymbol.asyncTaskManager].endTask(taskID);
+
+			return VirtualServerUtility.getNotFoundResponse(this.#window);
+		}
+
+		this.#browserFrame[PropertySymbol.asyncTaskManager].endTask(taskID);
+
+		const body = new this.#window.ReadableStream({
+			start(controller) {
+				setTimeout(() => {
+					controller.enqueue(buffer);
+					controller.close();
+				});
+			}
+		});
+
+		const response = new this.#window.Response(body);
+
+		response[PropertySymbol.buffer] = buffer;
+		(<string>response.url) = this.request.url;
+
+		return response;
+	}
+
 	/**
 	 * Checks if the request complies with the Cross-Origin policy.
 	 *
@@ -410,7 +479,17 @@ export default class Fetch {
 						})
 					: undefined;
 				this.#browserFrame[PropertySymbol.asyncTaskManager].endTask(taskID);
-				resolve(interceptedResponse instanceof Response ? interceptedResponse : response);
+				const returnResponse =
+					interceptedResponse instanceof Response ? interceptedResponse : response;
+
+				// The browser outputs errors to the console when the response is not ok.
+				if (returnResponse instanceof Response && !returnResponse.ok) {
+					this.#browserFrame?.page?.console.error(
+						`${this.request.method} ${this.request.url} ${returnResponse.status} (${returnResponse.statusText})`
+					);
+				}
+
+				resolve(returnResponse);
 			};
 			this.reject = (error: Error): void => {
 				this.#browserFrame[PropertySymbol.asyncTaskManager].endTask(taskID);
@@ -517,7 +596,7 @@ export default class Fetch {
 	 */
 	private onError(error: Error): void {
 		this.finalizeRequest();
-		this.#window.console.error(error);
+		this.#browserFrame?.page?.console.error(error);
 		this.reject(
 			new this.#window.DOMException(
 				`Failed to execute "fetch()" on "Window" with URL "${this.request.url}": ${error.message}`,

package/src/fetch/SyncFetch.ts

@@ -3,6 +3,8 @@ import * as PropertySymbol from '../PropertySymbol.js';
 import IRequestInfo from './types/IRequestInfo.js';
 import DOMExceptionNameEnum from '../exception/DOMExceptionNameEnum.js';
 import URL from '../url/URL.js';
+import FS from 'fs';
+import Path from 'path';
 import Request from './Request.js';
 import IBrowserFrame from '../browser/types/IBrowserFrame.js';
 import BrowserWindow from '../window/BrowserWindow.js';
@@ -21,6 +23,7 @@ import FetchResponseRedirectUtility from './utilities/FetchResponseRedirectUtili
 import FetchCORSUtility from './utilities/FetchCORSUtility.js';
 import Fetch from './Fetch.js';
 import IFetchInterceptor from './types/IFetchInterceptor.js';
+import VirtualServerUtility from './utilities/VirtualServerUtility.js';
 
 interface ISyncHTTPResponse {
 	error: string;
@@ -96,6 +99,7 @@ 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,
@@ -105,8 +109,15 @@ export default class SyncFetch {
 		if (typeof beforeRequestResponse === 'object') {
 			return beforeRequestResponse;
 		}
+
 		FetchRequestValidationUtility.validateSchema(this.request);
 
+		const virtualServerResponse = this.getVirtualServerResponse();
+
+		if (virtualServerResponse) {
+			return virtualServerResponse;
+		}
+
 		if (this.request.signal.aborted) {
 			throw new this.#window.DOMException(
 				'The operation was aborted.',
@@ -256,6 +267,47 @@ export default class SyncFetch {
 		};
 	}
 
+	/**
+	 * Returns virtual server response.
+	 *
+	 * @returns Response.
+	 */
+	private getVirtualServerResponse(): ISyncResponse | null {
+		const filePath = VirtualServerUtility.getFilepath(this.#window, this.request.url);
+
+		if (!filePath) {
+			return null;
+		}
+
+		if (this.request.method !== 'GET') {
+			this.#browserFrame?.page?.console.error(
+				`${this.request.method} ${this.request.url} 404 (Not Found)`
+			);
+			return VirtualServerUtility.getNotFoundSyncResponse(this.#window);
+		}
+
+		let buffer: Buffer;
+		try {
+			const stat = FS.statSync(filePath);
+			buffer = FS.readFileSync(stat.isDirectory() ? Path.join(filePath, 'index.html') : filePath);
+		} catch {
+			this.#browserFrame?.page?.console.error(
+				`${this.request.method} ${this.request.url} 404 (Not Found)`
+			);
+			return VirtualServerUtility.getNotFoundSyncResponse(this.#window);
+		}
+
+		return {
+			status: 200,
+			statusText: '',
+			ok: true,
+			url: this.request.url,
+			redirected: false,
+			headers: new this.#window.Headers(),
+			body: buffer
+		};
+	}
+
 	/**
 	 * Checks if the request complies with the Cross-Origin policy.
 	 *
@@ -443,7 +495,14 @@ export default class SyncFetch {
 					request: this.request
 				})
 			: undefined;
-		return typeof interceptedResponse === 'object' ? interceptedResponse : redirectedResponse;
+		const returnResponse =
+			typeof interceptedResponse === 'object' ? interceptedResponse : redirectedResponse;
+		if (!returnResponse.ok) {
+			this.#browserFrame?.page?.console.error(
+				`${this.request.method} ${this.request.url} ${returnResponse.status} (${returnResponse.statusText})`
+			);
+		}
+		return returnResponse;
 	}
 
 	/**

package/src/fetch/types/IVirtualServer.ts

@@ -0,0 +1,7 @@
+/**
+ * Virtual server used for simulating a server that reads from the file system.
+ */
+export default interface IVirtualServer {
+	url: string | RegExp;
+	directory: string;
+}

package/src/fetch/utilities/VirtualServerUtility.ts

@@ -0,0 +1,89 @@
+import BrowserWindow from '../../window/BrowserWindow.js';
+import WindowBrowserContext from '../../window/WindowBrowserContext.js';
+import Path from 'path';
+import Response from '../Response.js';
+import ISyncResponse from '../types/ISyncResponse.js';
+
+const NOT_FOUND_HTML =
+	'<html><head><title>Happy DOM Virtual Server - 404 Not Found</title></head><body><h1>Happy DOM Virtual Server - 404 Not Found</h1></body></html>';
+
+/**
+ * Virtual server utility.
+ */
+export default class VirtualServerUtility {
+	/**
+	 * Returns the filesystem path for a request URL if it matches a virtual server.
+	 *
+	 * @param window Window.
+	 * @param requestURL Request URL.
+	 */
+	public static getFilepath(window: BrowserWindow, requestURL: string): string | null {
+		const browserSettings = new WindowBrowserContext(window).getSettings();
+		if (!browserSettings || !browserSettings.fetch.virtualServers) {
+			return null;
+		}
+		for (const virtualServer of browserSettings.fetch.virtualServers) {
+			let baseURL: URL;
+			if (typeof virtualServer.url === 'string') {
+				const url = new URL(
+					virtualServer.url[virtualServer.url.length - 1] === '/'
+						? virtualServer.url.slice(0, -1)
+						: virtualServer.url,
+					window.location.origin
+				);
+				if (requestURL.startsWith(url.href)) {
+					baseURL = url;
+				}
+			} else if (virtualServer.url instanceof RegExp) {
+				const match = requestURL.match(virtualServer.url);
+				if (match) {
+					baseURL = new URL(
+						match[0][match[0].length - 1] === '/' ? match[0].slice(0, -1) : match[0],
+						window.location.origin
+					);
+				}
+			}
+			if (baseURL) {
+				const path = requestURL.slice(baseURL.href.length).split('?')[0].split('#')[0];
+				return Path.join(Path.resolve(virtualServer.directory), path.replaceAll('/', Path.sep));
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Returns a 404 response.
+	 *
+	 * @param window Window.
+	 * @returns 404 response.
+	 */
+	public static getNotFoundResponse(window: BrowserWindow): Response {
+		return new window.Response(NOT_FOUND_HTML, {
+			status: 404,
+			statusText: 'Not Found',
+			headers: {
+				'Content-Type': 'text/html'
+			}
+		});
+	}
+
+	/**
+	 * Returns a 404 response.
+	 *
+	 * @param window Window.
+	 * @returns 404 response.
+	 */
+	public static getNotFoundSyncResponse(window: BrowserWindow): ISyncResponse {
+		return <ISyncResponse>{
+			status: 404,
+			statusText: 'Not Found',
+			ok: false,
+			url: null,
+			redirected: false,
+			headers: new window.Headers({
+				'Content-Type': 'text/html'
+			}),
+			body: Buffer.from(NOT_FOUND_HTML)
+		};
+	}
+}

package/src/index.ts

@@ -16,6 +16,7 @@ import VirtualConsole from './console/VirtualConsole.js';
 import VirtualConsolePrinter from './console/VirtualConsolePrinter.js';
 import VirtualConsoleLogLevelEnum from './console/enums/VirtualConsoleLogLevelEnum.js';
 import VirtualConsoleLogTypeEnum from './console/enums/VirtualConsoleLogTypeEnum.js';
+import CookieSameSiteEnum from './cookie/enums/CookieSameSiteEnum.js';
 import CSSRule from './css/CSSRule.js';
 import CSSStyleSheet from './css/CSSStyleSheet.js';
 import CSSStyleDeclaration from './css/declaration/CSSStyleDeclaration.js';
@@ -28,6 +29,8 @@ import CSSStyleRule from './css/rules/CSSStyleRule.js';
 import CSSSupportsRule from './css/rules/CSSSupportsRule.js';
 import CustomElementRegistry from './custom-element/CustomElementRegistry.js';
 import DOMParser from './dom-parser/DOMParser.js';
+import DOMRect from './dom/DOMRect.js';
+import DOMRectReadOnly from './dom/DOMRectReadOnly.js';
 import DataTransfer from './event/DataTransfer.js';
 import DataTransferItem from './event/DataTransferItem.js';
 import DataTransferItemList from './event/DataTransferItemList.js';
@@ -74,8 +77,6 @@ import Comment from './nodes/comment/Comment.js';
 import DocumentFragment from './nodes/document-fragment/DocumentFragment.js';
 import DocumentType from './nodes/document-type/DocumentType.js';
 import Document from './nodes/document/Document.js';
-import DOMRect from './dom/DOMRect.js';
-import DOMRectReadOnly from './dom/DOMRectReadOnly.js';
 import Element from './nodes/element/Element.js';
 import HTMLCollection from './nodes/element/HTMLCollection.js';
 import HTMLAnchorElement from './nodes/html-anchor-element/HTMLAnchorElement.js';
@@ -188,10 +189,12 @@ import type IBrowserFrame from './browser/types/IBrowserFrame.js';
 import type IBrowserPage from './browser/types/IBrowserPage.js';
 import type IBrowserSettings from './browser/types/IBrowserSettings.js';
 import type IOptionalBrowserSettings from './browser/types/IOptionalBrowserSettings.js';
+import type ICookie from './cookie/ICookie.js';
+import type IOptionalCookie from './cookie/IOptionalCookie.js';
 import type IEventInit from './event/IEventInit.js';
-import type TEventListener from './event/TEventListener.js';
 import type ITouchInit from './event/ITouchInit.js';
 import type IUIEventInit from './event/IUIEventInit.js';
+import type TEventListener from './event/TEventListener.js';
 import type IAnimationEventInit from './event/events/IAnimationEventInit.js';
 import type IClipboardEventInit from './event/events/IClipboardEventInit.js';
 import type ICustomEventInit from './event/events/ICustomEventInit.js';
@@ -206,10 +209,9 @@ import type IProgressEventInit from './event/events/IProgressEventInit.js';
 import type ISubmitEventInit from './event/events/ISubmitEventInit.js';
 import type ITouchEventInit from './event/events/ITouchEventInit.js';
 import type IWheelEventInit from './event/events/IWheelEventInit.js';
+import type IVirtualServer from './fetch/types/IVirtualServer.js';
 
 export type {
-	IFetchInterceptor,
-	ISyncResponse,
 	IAnimationEventInit,
 	IBrowser,
 	IBrowserContext,
@@ -217,10 +219,11 @@ export type {
 	IBrowserPage,
 	IBrowserSettings,
 	IClipboardEventInit,
+	ICookie,
 	ICustomEventInit,
 	IErrorEventInit,
 	IEventInit,
-	TEventListener,
+	IFetchInterceptor,
 	IFocusEventInit,
 	IHashChangeEventInit,
 	IInputEventInit,
@@ -228,12 +231,16 @@ export type {
 	IMediaQueryListInit,
 	IMouseEventInit,
 	IOptionalBrowserSettings,
+	IOptionalCookie,
 	IProgressEventInit,
 	ISubmitEventInit,
+	ISyncResponse,
 	ITouchEventInit,
 	ITouchInit,
 	IUIEventInit,
-	IWheelEventInit
+	IVirtualServer,
+	IWheelEventInit,
+	TEventListener
 };
 
 export {
@@ -253,6 +260,7 @@ export {
 	ClipboardEvent,
 	ClipboardItem,
 	Comment,
+	CookieSameSiteEnum,
 	CSSContainerRule,
 	CSSFontFaceRule,
 	CSSKeyframeRule,