happy-dom 12.10.3 → 13.0.0

package/src/fetch/utilities/FetchRequestReferrerUtility.ts

@@ -1,9 +1,10 @@
 import URL from '../../url/URL.js';
-import IRequest from '../types/IRequest.js';
-import IDocument from '../../nodes/document/IDocument.js';
+import * as PropertySymbol from '../../PropertySymbol.js';
+import IBrowserWindow from '../../window/IBrowserWindow.js';
 import { isIP } from 'net';
 import Headers from '../Headers.js';
 import IRequestReferrerPolicy from '../types/IRequestReferrerPolicy.js';
+import Request from '../Request.js';
 
 const REQUEST_REFERRER_UNSUPPORTED_PROTOCOL_REGEXP = /^(about|blob|data):$/;
 const REFERRER_POLICIES: IRequestReferrerPolicy[] = [
@@ -22,6 +23,71 @@ const REFERRER_POLICIES: IRequestReferrerPolicy[] = [
  * Fetch referrer utility.
  */
 export default class FetchRequestReferrerUtility {
+	/**
+	 * Prepares the request before being sent.
+	 *
+	 * @param originURL Origin URL.
+	 * @param request Request.
+	 */
+	public static prepareRequest(originURL: URL, request: Request): void {
+		if (!request.referrerPolicy) {
+			(<string>request.referrerPolicy) = 'strict-origin-when-cross-origin';
+		}
+
+		if (request.referrer && request.referrer !== 'no-referrer') {
+			request[PropertySymbol.referrer] = this.getSentReferrer(originURL, request);
+		} else {
+			request[PropertySymbol.referrer] = 'no-referrer';
+		}
+	}
+
+	/**
+	 * Returns initial referrer.
+	 *
+	 * @param window Window.
+	 * @param referrer Referrer.
+	 * @returns Initial referrer.
+	 */
+	public static getInitialReferrer(
+		window: IBrowserWindow,
+		referrer: '' | 'no-referrer' | 'client' | string | URL
+	): '' | 'no-referrer' | 'client' | URL {
+		if (referrer === '' || referrer === 'no-referrer' || referrer === 'client') {
+			return referrer;
+		} else if (referrer) {
+			const referrerURL = referrer instanceof URL ? referrer : new URL(referrer, window.location);
+			return referrerURL.origin === window.location.origin ? referrerURL : 'client';
+		}
+
+		return 'client';
+	}
+
+	/**
+	 * Returns referrer policy from header.
+	 *
+	 * @see https://w3c.github.io/webappsec-referrer-policy/#parse-referrer-policy-from-header
+	 * @param headers Response headers
+	 * @returns Policy.
+	 */
+	public static getReferrerPolicyFromHeader(headers: Headers): IRequestReferrerPolicy {
+		const referrerPolicyHeader = headers.get('Referrer-Policy');
+
+		if (!referrerPolicyHeader) {
+			return '';
+		}
+
+		const policyTokens = referrerPolicyHeader.split(/[,\s]+/);
+		let policy: IRequestReferrerPolicy = '';
+
+		for (const token of policyTokens) {
+			if (token && REFERRER_POLICIES.includes(<IRequestReferrerPolicy>token)) {
+				policy = <IRequestReferrerPolicy>token;
+			}
+		}
+
+		return policy;
+	}
+
 	/**
 	 * Returns the request referrer to be used as the value for the "Referer" header.
 	 *
@@ -29,23 +95,21 @@ export default class FetchRequestReferrerUtility {
 	 * https://github.com/node-fetch/node-fetch/blob/main/src/utils/referrer.js (MIT)
 	 *
 	 * @see https://w3c.github.io/webappsec-referrer-policy/#determine-requests-referrer
-	 * @param document Document.
+	 * @param originURL Origin URL.
 	 * @param request Request.
 	 * @returns Request referrer.
 	 */
-	public static getSentReferrer(
-		document: IDocument,
-		request: IRequest
+	private static getSentReferrer(
+		originURL: URL,
+		request: Request
 	): '' | 'no-referrer' | 'client' | URL {
-		if (request.referrer === 'about:client' && document.defaultView.location.origin === 'null') {
+		if (request.referrer === 'about:client' && originURL.origin === 'null') {
 			return 'no-referrer';
 		}
 
 		const requestURL = new URL(request.url);
 		const referrerURL =
-			request.referrer === 'about:client'
-				? new URL(document.defaultView.location.href)
-				: new URL(request.referrer);
+			request.referrer === 'about:client' ? new URL(originURL.href) : new URL(request.referrer);
 
 		if (REQUEST_REFERRER_UNSUPPORTED_PROTOCOL_REGEXP.test(referrerURL.protocol)) {
 			return 'no-referrer';
@@ -110,53 +174,6 @@ export default class FetchRequestReferrerUtility {
 		return 'no-referrer';
 	}
 
-	/**
-	 * Returns initial referrer.
-	 *
-	 * @param document Document.
-	 * @param referrer Referrer.
-	 * @returns Initial referrer.
-	 */
-	public static getInitialReferrer(
-		document: IDocument,
-		referrer: '' | 'no-referrer' | 'client' | string | URL
-	): '' | 'no-referrer' | 'client' | URL {
-		if (referrer === '' || referrer === 'no-referrer' || referrer === 'client') {
-			return referrer;
-		} else if (referrer) {
-			const referrerURL = referrer instanceof URL ? referrer : new URL(referrer, document.location);
-			return referrerURL.origin === document.location.origin ? referrerURL : 'client';
-		}
-
-		return 'client';
-	}
-
-	/**
-	 * Returns referrer policy from header.
-	 *
-	 * @see https://w3c.github.io/webappsec-referrer-policy/#parse-referrer-policy-from-header
-	 * @param headers Response headers
-	 * @returns Policy.
-	 */
-	public static getReferrerPolicyFromHeader(headers: Headers): IRequestReferrerPolicy {
-		const referrerPolicyHeader = headers.get('Referrer-Policy');
-
-		if (!referrerPolicyHeader) {
-			return '';
-		}
-
-		const policyTokens = referrerPolicyHeader.split(/[,\s]+/);
-		let policy: IRequestReferrerPolicy = '';
-
-		for (const token of policyTokens) {
-			if (token && REFERRER_POLICIES.includes(<IRequestReferrerPolicy>token)) {
-				policy = <IRequestReferrerPolicy>token;
-			}
-		}
-
-		return policy;
-	}
-
 	/**
 	 * Returns "true" if the request's referrer is potentially trustworthy.
 	 *

package/src/fetch/utilities/FetchRequestValidationUtility.ts

@@ -1,9 +1,10 @@
 import DOMException from '../../exception/DOMException.js';
+import * as PropertySymbol from '../../PropertySymbol.js';
 import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum.js';
 import IRequestReferrerPolicy from '../types/IRequestReferrerPolicy.js';
 import IRequestRedirect from '../types/IRequestRedirect.js';
 import URL from '../../url/URL.js';
-import IRequest from '../types/IRequest.js';
+import Request from '../Request.js';
 
 const VALID_REFERRER_POLICIES = [
 	'',
@@ -19,17 +20,44 @@ const VALID_REFERRER_POLICIES = [
 
 const VALID_REDIRECTS = ['error', 'manual', 'follow'];
 
+const SUPPORTED_SCHEMAS = ['data:', 'http:', 'https:'];
+
+const FORBIDDEN_REQUEST_METHODS = ['TRACE', 'TRACK', 'CONNECT'];
+const REQUEST_METHOD_REGEXP = /^[A-Z]+$/;
+
 /**
  * Fetch request validation utility.
  */
 export default class FetchRequestValidationUtility {
+	/**
+	 * Validates request method.
+	 *
+	 * @throws DOMException
+	 * @param request Request.
+	 */
+	public static validateMethod(request: Request): void {
+		if (!request.method || FORBIDDEN_REQUEST_METHODS.includes(request.method)) {
+			throw new DOMException(
+				`'${request.method || ''}' is not a valid HTTP method.`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+
+		if (!REQUEST_METHOD_REGEXP.test(request.method)) {
+			throw new DOMException(
+				`'${request.method}' HTTP method is unsupported.`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+	}
+
 	/**
 	 * Validates request body.
 	 *
 	 * @throws DOMException
 	 * @param request Request.
 	 */
-	public static validateBody(request: IRequest): void {
+	public static validateBody(request: Request): void {
 		if (request.body && (request.method === 'GET' || request.method === 'HEAD')) {
 			throw new DOMException(
 				`Request with GET/HEAD method cannot have body.`,
@@ -79,4 +107,22 @@ export default class FetchRequestValidationUtility {
 			throw new DOMException(`Invalid redirect "${redirect}".`, DOMExceptionNameEnum.syntaxError);
 		}
 	}
+
+	/**
+	 * Validates request redirect.
+	 *
+	 * @throws DOMException
+	 * @param request
+	 * @param redirect Redirect.
+	 */
+	public static validateSchema(request: Request): void {
+		if (!SUPPORTED_SCHEMAS.includes(request[PropertySymbol.url].protocol)) {
+			throw new DOMException(
+				`Failed to fetch from "${request.url}": URL scheme "${request[
+					PropertySymbol.url
+				].protocol.replace(/:$/, '')}" is not supported.`,
+				DOMExceptionNameEnum.notSupportedError
+			);
+		}
+	}
 }

package/src/fetch/utilities/FetchResponseHeaderUtility.ts

@@ -0,0 +1,47 @@
+import IBrowserFrame from '../../browser/types/IBrowserFrame.js';
+import CookieStringUtility from '../../cookie/urilities/CookieStringUtility.js';
+import Headers from '../Headers.js';
+
+/**
+ * Fetch request validation utility.
+ */
+export default class FetchResponseHeaderUtility {
+	/**
+	 * Appends headers to response.
+	 *
+	 * @param nodeResponse HTTP request.
+	 * @param options
+	 * @param options.browserFrame
+	 * @param options.requestURL
+	 * @param options.rawHeaders
+	 * @returns Headers.
+	 */
+	public static parseResponseHeaders(options: {
+		browserFrame: IBrowserFrame;
+		requestURL: URL;
+		rawHeaders: string[];
+	}): Headers {
+		const headers = new Headers();
+		let key = null;
+
+		for (const header of options.rawHeaders) {
+			if (!key) {
+				key = header;
+			} else {
+				const lowerName = key.toLowerCase();
+				// Handles setting cookie headers to the document.
+				// "Set-Cookie" and "Set-Cookie2" are not allowed in response headers according to spec.
+				if (lowerName === 'set-cookie' || lowerName === 'set-cookie2') {
+					options.browserFrame.page.context.cookieContainer.addCookies([
+						CookieStringUtility.stringToCookie(options.requestURL, header)
+					]);
+				} else {
+					headers.append(key, header);
+				}
+				key = null;
+			}
+		}
+
+		return headers;
+	}
+}

package/src/fetch/utilities/FetchResponseRedirectUtility.ts

@@ -0,0 +1,27 @@
+const REDIRECT_STATUS_CODES = [301, 302, 303, 307, 308];
+const MAX_REDIRECT_COUNT = 20;
+
+/**
+ * Fetch request validation utility.
+ */
+export default class FetchResponseRedirectUtility {
+	/**
+	 * Returns "true" if redirect.
+	 *
+	 * @param statusCode Status code.
+	 * @returns "true" if redirect.
+	 */
+	public static isRedirect(statusCode: number): boolean {
+		return REDIRECT_STATUS_CODES.includes(statusCode);
+	}
+
+	/**
+	 * Returns "true" if max redirects is reached.
+	 *
+	 * @param redirectCount Redirect count.
+	 * @returns "true" if max redirects is reached.
+	 */
+	public static isMaxRedirectsReached(redirectCount: number): boolean {
+		return redirectCount >= MAX_REDIRECT_COUNT;
+	}
+}

package/src/fetch/utilities/SyncFetchScriptBuilder.ts

@@ -0,0 +1,71 @@
+import FetchHTTPSCertificate from '../certificate/FetchHTTPSCertificate.js';
+
+/**
+ * Synchronous fetch script builder.
+ */
+export default class SyncFetchScriptBuilder {
+	/**
+	 * Sends a synchronous request.
+	 *
+	 * @param request Request.
+	 * @param request.url
+	 * @param request.method
+	 * @param request.headers
+	 * @param request.body
+	 * @returns Script.
+	 */
+	public static getScript(request: {
+		url: URL;
+		method: string;
+		headers: { [name: string]: string };
+		body?: Buffer | null;
+	}): string {
+		const sortedHeaders = {};
+		const headerNames = Object.keys(request.headers).sort();
+		for (const name of headerNames) {
+			sortedHeaders[name] = request.headers[name];
+		}
+
+		return `
+                const sendRequest = require('http${
+									request.url.protocol === 'https:' ? 's' : ''
+								}').request;
+                const options = ${JSON.stringify(
+									{
+										method: request.method,
+										headers: sortedHeaders,
+										agent: false,
+										rejectUnauthorized: true,
+										key: request.url.protocol === 'https:' ? FetchHTTPSCertificate.key : undefined,
+										cert: request.url.protocol === 'https:' ? FetchHTTPSCertificate.cert : undefined
+									},
+									null,
+									4
+								)};
+                const request = sendRequest('${request.url.href}', options, (incomingMessage) => {
+                    let data = Buffer.alloc(0);
+                    incomingMessage.on('data', (chunk) => {
+                        data = Buffer.concat([data, Buffer.from(chunk)]);
+                    });
+                    incomingMessage.on('end', () => {
+                        console.log(JSON.stringify({
+                            error: null,
+                            incomingMessage: {
+                                statusCode: incomingMessage.statusCode,
+                                statusMessage: incomingMessage.statusMessage,
+                                rawHeaders: incomingMessage.rawHeaders,
+                                data: data.toString('base64')
+                            }
+                        }));
+                    });
+                    incomingMessage.on('error', (error) => {
+                        console.log(JSON.stringify({ error: error.message, incomingMessage: null }));
+                    });
+                });
+                request.write(Buffer.from('${
+									request.body ? request.body.toString('base64') : ''
+								}', 'base64'));
+                request.end();
+            `;
+	}
+}

package/src/file/Blob.ts

@@ -1,4 +1,5 @@
 import IBlob from './IBlob.js';
+import * as PropertySymbol from '../PropertySymbol.js';
 
 /**
  * Reference:
@@ -8,8 +9,8 @@ import IBlob from './IBlob.js';
  * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/file-api/Blob-impl.js (MIT licensed).
  */
 export default class Blob implements IBlob {
-	public _buffer: Buffer = null;
 	public readonly type: string = '';
+	public [PropertySymbol.buffer]: Buffer = null;
 
 	/**
 	 * Constructor.
@@ -31,7 +32,7 @@ export default class Blob implements IBlob {
 				if (bit instanceof ArrayBuffer) {
 					buffer = Buffer.from(new Uint8Array(bit));
 				} else if (bit instanceof Blob) {
-					buffer = bit._buffer;
+					buffer = bit[PropertySymbol.buffer];
 				} else if (bit instanceof Buffer) {
 					buffer = bit;
 				} else if (ArrayBuffer.isView(bit)) {
@@ -44,7 +45,7 @@ export default class Blob implements IBlob {
 			}
 		}
 
-		this._buffer = Buffer.concat(buffers);
+		this[PropertySymbol.buffer] = Buffer.concat(buffers);
 
 		if (options && options.type && options.type.match(/^[\u0020-\u007E]*$/)) {
 			this.type = String(options.type).toLowerCase();
@@ -57,7 +58,7 @@ export default class Blob implements IBlob {
 	 * @returns Size.
 	 */
 	public get size(): number {
-		return this._buffer.length;
+		return this[PropertySymbol.buffer].length;
 	}
 
 	/**
@@ -100,12 +101,12 @@ export default class Blob implements IBlob {
 
 		const span = Math.max(relativeEnd - relativeStart, 0);
 
-		const buffer = this._buffer;
+		const buffer = this[PropertySymbol.buffer];
 		const slicedBuffer = buffer.slice(relativeStart, relativeStart + span);
 
 		const blob = new Blob([], { type: relativeContentType });
 
-		(<Buffer>blob._buffer) = slicedBuffer;
+		(<Buffer>blob[PropertySymbol.buffer]) = slicedBuffer;
 
 		return blob;
 	}
@@ -123,7 +124,7 @@ export default class Blob implements IBlob {
 	 *
 	 */
 	public async arrayBuffer(): Promise<ArrayBuffer> {
-		return new Uint8Array(this._buffer).buffer;
+		return new Uint8Array(this[PropertySymbol.buffer]).buffer;
 	}
 
 	/**
@@ -132,7 +133,7 @@ export default class Blob implements IBlob {
 	 * @returns Text.
 	 */
 	public async text(): Promise<string> {
-		return this._buffer.toString();
+		return this[PropertySymbol.buffer].toString();
 	}
 
 	/**

package/src/file/FileReader.ts

@@ -1,6 +1,7 @@
 import WhatwgMIMEType from 'whatwg-mimetype';
+import * as PropertySymbol from '../PropertySymbol.js';
 import WhatwgEncoding from 'whatwg-encoding';
-import IDocument from '../nodes/document/IDocument.js';
+import IBrowserWindow from '../window/IBrowserWindow.js';
 import ProgressEvent from '../event/events/ProgressEvent.js';
 import DOMException from '../exception/DOMException.js';
 import DOMExceptionNameEnum from '../exception/DOMExceptionNameEnum.js';
@@ -18,8 +19,6 @@ import FileReaderEventTypeEnum from './FileReaderEventTypeEnum.js';
  * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/file-api/FileReader-impl.js (MIT licensed).
  */
 export default class FileReader extends EventTarget {
-	// Owner document is set by a sub-class in the Window constructor
-	public static _ownerDocument: IDocument = null;
 	public readonly error: Error = null;
 	public readonly result: Buffer | ArrayBuffer | string = null;
 	public readonly readyState: number = FileReaderReadyStateEnum.empty;
@@ -29,17 +28,19 @@ export default class FileReader extends EventTarget {
 	public readonly onloadstart: (event: ProgressEvent) => void = null;
 	public readonly onloadend: (event: ProgressEvent) => void = null;
 	public readonly onprogress: (event: ProgressEvent) => void = null;
-	public readonly _ownerDocument: IDocument = null;
-	private _isTerminated = false;
-	private _loadTimeout: NodeJS.Timeout = null;
-	private _parseTimeout: NodeJS.Timeout = null;
+	#isTerminated = false;
+	#loadTimeout: NodeJS.Timeout | null = null;
+	#parseTimeout: NodeJS.Timeout | null = null;
+	readonly #window: IBrowserWindow;
 
 	/**
 	 * Constructor.
+	 *
+	 * @param window Window.
 	 */
-	constructor() {
+	constructor(window: IBrowserWindow) {
 		super();
-		this._ownerDocument = (<typeof FileReader>this.constructor)._ownerDocument;
+		this.#window = window;
 	}
 
 	/**
@@ -48,7 +49,7 @@ export default class FileReader extends EventTarget {
 	 * @param blob Blob.
 	 */
 	public readAsArrayBuffer(blob: Blob): void {
-		this._readFile(blob, FileReaderFormatEnum.buffer);
+		this.#readFile(blob, FileReaderFormatEnum.buffer);
 	}
 
 	/**
@@ -57,7 +58,7 @@ export default class FileReader extends EventTarget {
 	 * @param blob Blob.
 	 */
 	public readAsBinaryString(blob: Blob): void {
-		this._readFile(blob, FileReaderFormatEnum.binaryString);
+		this.#readFile(blob, FileReaderFormatEnum.binaryString);
 	}
 
 	/**
@@ -66,7 +67,7 @@ export default class FileReader extends EventTarget {
 	 * @param blob Blob.
 	 */
 	public readAsDataURL(blob: Blob): void {
-		this._readFile(blob, FileReaderFormatEnum.dataURL);
+		this.#readFile(blob, FileReaderFormatEnum.dataURL);
 	}
 
 	/**
@@ -76,7 +77,7 @@ export default class FileReader extends EventTarget {
 	 * @param [encoding] Encoding.
 	 */
 	public readAsText(blob: Blob, encoding: string = null): void {
-		this._readFile(
+		this.#readFile(
 			blob,
 			FileReaderFormatEnum.text,
 			WhatwgEncoding.labelToName(encoding) || 'UTF-8'
@@ -87,10 +88,8 @@ export default class FileReader extends EventTarget {
 	 * Aborts the file reader.
 	 */
 	public abort(): void {
-		const window = this._ownerDocument.defaultView;
-
-		window.clearTimeout(this._loadTimeout);
-		window.clearTimeout(this._parseTimeout);
+		this.#window.clearTimeout(this.#loadTimeout);
+		this.#window.clearTimeout(this.#parseTimeout);
 
 		if (
 			this.readyState === FileReaderReadyStateEnum.empty ||
@@ -105,7 +104,7 @@ export default class FileReader extends EventTarget {
 			(<Buffer | ArrayBuffer | string>this.result) = null;
 		}
 
-		this._isTerminated = true;
+		this.#isTerminated = true;
 		this.dispatchEvent(new ProgressEvent(FileReaderEventTypeEnum.abort));
 		this.dispatchEvent(new ProgressEvent(FileReaderEventTypeEnum.loadend));
 	}
@@ -117,9 +116,7 @@ export default class FileReader extends EventTarget {
 	 * @param format Format.
 	 * @param [encoding] Encoding.
 	 */
-	private _readFile(blob: Blob, format: FileReaderFormatEnum, encoding: string = null): void {
-		const window = this._ownerDocument.defaultView;
-
+	#readFile(blob: Blob, format: FileReaderFormatEnum, encoding: string = null): void {
 		if (this.readyState === FileReaderReadyStateEnum.loading) {
 			throw new DOMException(
 				'The object is in an invalid state.',
@@ -129,15 +126,15 @@ export default class FileReader extends EventTarget {
 
 		(<number>this.readyState) = FileReaderReadyStateEnum.loading;
 
-		this._loadTimeout = window.setTimeout(() => {
-			if (this._isTerminated) {
-				this._isTerminated = false;
+		this.#loadTimeout = this.#window.setTimeout(() => {
+			if (this.#isTerminated) {
+				this.#isTerminated = false;
 				return;
 			}
 
 			this.dispatchEvent(new ProgressEvent(FileReaderEventTypeEnum.loadstart));
 
-			let data = blob._buffer;
+			let data = blob[PropertySymbol.buffer];
 			if (!data) {
 				data = Buffer.alloc(0);
 			}
@@ -150,9 +147,9 @@ export default class FileReader extends EventTarget {
 				})
 			);
 
-			this._parseTimeout = window.setTimeout(() => {
-				if (this._isTerminated) {
-					this._isTerminated = false;
+			this.#parseTimeout = this.#window.setTimeout(() => {
+				if (this.#isTerminated) {
+					this.#isTerminated = false;
 					return;
 				}