happy-dom 8.8.0 → 9.0.0

package/src/fetch/multipart/MultipartReader.ts

@@ -0,0 +1,217 @@
+import DOMException from '../../exception/DOMException';
+import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum';
+import File from '../../file/File';
+import FormData from '../../form-data/FormData';
+
+enum MultiparParserStateEnum {
+	boundary = 0,
+	headerStart = 2,
+	header = 3,
+	data = 5
+}
+
+const CHARACTER_CODE = {
+	lf: 10,
+	cr: 13
+};
+
+/**
+ * Multipart reader.
+ *
+ * Based on:
+ * https://github.com/node-fetch/node-fetch/blob/main/src/utils/multipart-parser.js (MIT)
+ */
+export default class MultipartReader {
+	private formData = new FormData();
+	private boundary: Uint8Array;
+	private boundaryIndex = 0;
+	private state = MultiparParserStateEnum.boundary;
+	private data: {
+		contentDisposition: { [key: string]: string } | null;
+		value: number[];
+		contentType: string | null;
+		header: string;
+	} = {
+		contentDisposition: null,
+		value: [],
+		contentType: null,
+		header: ''
+	};
+
+	/**
+	 * Constructor.
+	 *
+	 * @param formData Form data.
+	 * @param boundary Boundary.
+	 */
+	constructor(boundary: string) {
+		const boundaryHeader = `--${boundary}`;
+		this.boundary = new Uint8Array(boundaryHeader.length);
+
+		for (let i = 0, max = boundaryHeader.length; i < max; i++) {
+			this.boundary[i] = boundaryHeader.charCodeAt(i);
+		}
+	}
+
+	/**
+	 * Appends data.
+	 *
+	 * @param data Data.
+	 */
+	public write(data: Uint8Array): void {
+		let char: number;
+		let nextChar: number;
+
+		for (let i = 0, max = data.length; i < max; i++) {
+			char = data[i];
+			nextChar = data[i + 1];
+
+			switch (this.state) {
+				case MultiparParserStateEnum.boundary:
+					if (char === this.boundary[this.boundaryIndex]) {
+						this.boundaryIndex++;
+					} else {
+						this.boundaryIndex = 0;
+					}
+
+					if (this.boundaryIndex === this.boundary.length) {
+						this.state = MultiparParserStateEnum.headerStart;
+						this.boundaryIndex = 0;
+					}
+
+					break;
+
+				case MultiparParserStateEnum.headerStart:
+					if (nextChar !== CHARACTER_CODE.cr && nextChar !== CHARACTER_CODE.lf) {
+						this.data.header = '';
+						this.state =
+							data[i - 2] === CHARACTER_CODE.lf
+								? MultiparParserStateEnum.data
+								: MultiparParserStateEnum.header;
+					}
+
+					break;
+
+				case MultiparParserStateEnum.header:
+					if (char === CHARACTER_CODE.cr) {
+						if (this.data.header) {
+							const headerParts = this.data.header.split(':');
+							const headerName = headerParts[0].toLowerCase();
+							const headerValue = headerParts[1].trim();
+
+							switch (headerName) {
+								case 'content-disposition':
+									this.data.contentDisposition = this.getContentDisposition(headerValue);
+									break;
+								case 'content-type':
+									this.data.contentType = headerValue;
+									break;
+							}
+						}
+
+						this.state = MultiparParserStateEnum.headerStart;
+					} else {
+						this.data.header += String.fromCharCode(char);
+					}
+
+					break;
+
+				case MultiparParserStateEnum.data:
+					if (char === this.boundary[this.boundaryIndex]) {
+						this.boundaryIndex++;
+					} else {
+						this.boundaryIndex = 0;
+					}
+
+					if (this.boundaryIndex === this.boundary.length) {
+						this.state = MultiparParserStateEnum.headerStart;
+
+						if (this.data.value.length) {
+							this.appendFormData(
+								this.data.contentDisposition.name,
+								Buffer.from(this.data.value.slice(0, -(this.boundary.length + 1))),
+								this.data.contentDisposition.filename,
+								this.data.contentType
+							);
+
+							this.data.value = [];
+							this.data.contentDisposition = null;
+							this.data.contentType = null;
+						}
+
+						this.boundaryIndex = 0;
+					} else {
+						this.data.value.push(char);
+					}
+
+					break;
+			}
+		}
+	}
+
+	/**
+	 * Ends the stream.
+	 *
+	 * @returns Form data.
+	 */
+	public end(): FormData {
+		if (this.state !== MultiparParserStateEnum.data) {
+			throw new DOMException(
+				`Unexpected end of multipart stream. Expected state to be "${MultiparParserStateEnum.data}" but got "${this.state}".`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+
+		this.appendFormData(
+			this.data.contentDisposition.name,
+			Buffer.from(this.data.value.slice(0, -2)),
+			this.data.contentDisposition.filename,
+			this.data.contentType
+		);
+
+		return this.formData;
+	}
+
+	/**
+	 * Appends data.
+	 *
+	 * @param key Key.
+	 * @param value value.
+	 * @param filename Filename.
+	 * @param type Type.
+	 */
+	private appendFormData(key: string, value: Buffer, filename?: string, type?: string): void {
+		if (!value.length) {
+			return;
+		}
+
+		if (filename) {
+			this.formData.append(
+				key,
+				new File([value], filename, {
+					type
+				})
+			);
+		} else {
+			this.formData.append(key, value.toString());
+		}
+	}
+
+	/**
+	 * Returns content disposition.
+	 *
+	 * @param headerValue Header value.
+	 * @returns Content disposition.
+	 */
+	private getContentDisposition(headerValue: string): { [key: string]: string } {
+		const regex = /([a-z]+) *= *"([^"]+)"/g;
+		const contentDisposition: { [key: string]: string } = {};
+		let match: RegExpExecArray;
+
+		while ((match = regex.exec(headerValue))) {
+			contentDisposition[match[1]] = match[2];
+		}
+
+		return contentDisposition;
+	}
+}

package/src/fetch/types/IHeaders.ts

@@ -0,0 +1,80 @@
+/**
+ * Fetch headers.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Headers
+ */
+export default interface IHeaders extends Iterable<[string, string]> {
+	/**
+	 * Appends a new value onto an existing header inside a Headers object, or adds the header if it does not already exist.
+	 *
+	 * @param name Name.
+	 * @param value Value.
+	 */
+	append(name: string, value: string): void;
+
+	/**
+	 * Removes an header.
+	 *
+	 * @param name Name.
+	 */
+	delete(name: string): void;
+
+	/**
+	 * Returns header value.
+	 *
+	 * @param name Name.
+	 * @returns Value.
+	 */
+	get(name: string): string | null;
+
+	/**
+	 * Sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.
+	 *
+	 * @param name Name.
+	 * @param value Value.
+	 */
+	set(name: string, value: string): void;
+
+	/**
+	 * Returns whether an Headers object contains a certain key.
+	 *
+	 * @param name Name.
+	 * @returns "true" if the Headers object contains the key.
+	 */
+	has(name: string): boolean;
+
+	/**
+	 * Executes a callback function once per each key/value pair in the Headers object.
+	 *
+	 * @param callback Callback.
+	 */
+	forEach(callback: (name: string, value: string, object: IHeaders) => void): void;
+
+	/**
+	 * Returns an iterator, allowing you to go through all keys of the key/value pairs contained in this object.
+	 *
+	 * @returns Iterator.
+	 */
+	keys(): IterableIterator<string>;
+
+	/**
+	 * Returns an iterator, allowing you to go through all values of the key/value pairs contained in this object.
+	 *
+	 * @returns Iterator.
+	 */
+	values(): IterableIterator<string>;
+
+	/**
+	 * Returns an iterator, allowing you to go through all key/value pairs contained in this object.
+	 *
+	 * @returns Iterator.
+	 */
+	entries(): IterableIterator<[string, string]>;
+
+	/**
+	 * Iterator.
+	 *
+	 * @returns Iterator.
+	 */
+	[Symbol.iterator](): IterableIterator<[string, string]>;
+}

package/src/fetch/types/IRequest.ts

@@ -0,0 +1,65 @@
+import IHeaders from './IHeaders';
+import IBlob from '../../file/IBlob';
+import AbortSignal from '../AbortSignal';
+import Stream from 'stream';
+import IRequestReferrerPolicy from './IRequestReferrerPolicy';
+import IRequestRedirect from './IRequestRedirect';
+import IRequestCredentials from './IRequestCredentials';
+
+/**
+ * Fetch request.
+ */
+export default interface IRequest {
+	readonly headers: IHeaders;
+	readonly method: string;
+	readonly redirect: IRequestRedirect;
+	readonly referrer: string;
+	readonly url: string;
+	readonly body: Stream.Readable | null;
+	readonly bodyUsed: boolean;
+	readonly referrerPolicy: IRequestReferrerPolicy;
+	readonly signal: AbortSignal | null;
+	readonly credentials: IRequestCredentials;
+
+	/**
+	 * Returns array buffer.
+	 *
+	 * @returns Array buffer.
+	 */
+	arrayBuffer(): Promise<ArrayBuffer>;
+
+	/**
+	 * Returns blob.
+	 *
+	 * @returns Blob.
+	 */
+	blob(): Promise<IBlob>;
+
+	/**
+	 * Returns buffer.
+	 *
+	 * @returns Buffer.
+	 */
+	buffer(): Promise<Buffer>;
+
+	/**
+	 * Returns text.
+	 *
+	 * @returns Text.
+	 */
+	text(): Promise<string>;
+
+	/**
+	 * Returns json.
+	 *
+	 * @returns JSON.
+	 */
+	json(): Promise<string>;
+
+	/**
+	 * Clones request.
+	 *
+	 * @returns Clone.
+	 */
+	clone(): IRequest;
+}

package/src/fetch/types/IRequestBody.ts

@@ -0,0 +1,15 @@
+import { URLSearchParams } from 'url';
+import FormData from '../../form-data/FormData';
+import Blob from '../../file/Blob';
+
+type IRequestBody =
+	| ArrayBuffer
+	| ArrayBufferView
+	| NodeJS.ReadableStream
+	| string
+	| URLSearchParams
+	| Blob
+	| FormData
+	| null;
+
+export default IRequestBody;

package/src/fetch/types/IRequestCredentials.ts

@@ -0,0 +1,2 @@
+type IRequestCredentials = 'omit' | 'same-origin' | 'include';
+export default IRequestCredentials;

package/src/fetch/types/IRequestInfo.ts

@@ -0,0 +1,6 @@
+import { URL } from 'url';
+import IRequest from './IRequest';
+
+type IRequestInfo = IRequest | string | URL;
+
+export default IRequestInfo;

package/src/fetch/types/IRequestInit.ts

@@ -0,0 +1,21 @@
+import IHeadersInit from './IHeadersInit';
+import AbortSignal from '../AbortSignal';
+import { URL } from 'url';
+import IRequestReferrerPolicy from './IRequestReferrerPolicy';
+import IRequestRedirect from './IRequestRedirect';
+import IRequestBody from './IRequestBody';
+import IRequestCredentials from './IRequestCredentials';
+
+/**
+ * Fetch request init.
+ */
+export default interface IRequestInit {
+	body?: IRequestBody;
+	headers?: IHeadersInit;
+	method?: string;
+	redirect?: IRequestRedirect;
+	signal?: AbortSignal | null;
+	referrer?: '' | 'no-referrer' | 'client' | string | URL;
+	credentials?: IRequestCredentials;
+	referrerPolicy?: IRequestReferrerPolicy;
+}

package/src/fetch/types/IRequestRedirect.ts

@@ -0,0 +1,3 @@
+type IRequestRedirect = 'follow' | 'error' | 'manual';
+
+export default IRequestRedirect;

package/src/fetch/types/IRequestReferrerPolicy.ts

@@ -0,0 +1,11 @@
+type IRequestReferrerPolicy =
+	| ''
+	| 'no-referrer'
+	| 'no-referrer-when-downgrade'
+	| 'same-origin'
+	| 'origin'
+	| 'strict-origin'
+	| 'origin-when-cross-origin'
+	| 'strict-origin-when-cross-origin'
+	| 'unsafe-url';
+export default IRequestReferrerPolicy;

package/src/fetch/types/IResponse.ts

@@ -0,0 +1,27 @@
+import IHeaders from './IHeaders';
+import IBlob from 'src/file/IBlob';
+import Stream from 'stream';
+
+/**
+ * Fetch response.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Response/Response
+ */
+export default interface IResponse {
+	readonly headers: IHeaders;
+	readonly ok: boolean;
+	readonly redirected: boolean;
+	readonly status: number;
+	readonly statusText: string;
+	readonly type: 'basic' | 'cors' | 'default' | 'error' | 'opaque' | 'opaqueredirect';
+	readonly url: string;
+	readonly body: Stream.Readable | null;
+	readonly bodyUsed: boolean;
+
+	arrayBuffer(): Promise<ArrayBuffer>;
+	blob(): Promise<IBlob>;
+	buffer(): Promise<Buffer>;
+	json(): Promise<unknown>;
+	text(): Promise<string>;
+	clone(): IResponse;
+}

package/src/fetch/types/IResponseBody.ts

@@ -0,0 +1,15 @@
+import { URLSearchParams } from 'url';
+import FormData from '../../form-data/FormData';
+import Blob from '../../file/Blob';
+
+type IResponseBody =
+	| ArrayBuffer
+	| ArrayBufferView
+	| NodeJS.ReadableStream
+	| string
+	| URLSearchParams
+	| Blob
+	| FormData
+	| null;
+
+export default IResponseBody;

package/src/fetch/types/IResponseInit.ts

@@ -0,0 +1,10 @@
+import IHeadersInit from './IHeadersInit';
+
+/**
+ * Response init.
+ */
+export default interface IResponseInit {
+	headers?: IHeadersInit | undefined;
+	status?: number | undefined;
+	statusText?: string | undefined;
+}

package/src/fetch/utilities/FetchBodyUtility.ts

@@ -0,0 +1,175 @@
+import MultipartFormDataParser from '../multipart/MultipartFormDataParser';
+import Stream from 'stream';
+import { URLSearchParams } from 'url';
+import FormData from '../../form-data/FormData';
+import Blob from '../../file/Blob';
+import DOMException from '../../exception/DOMException';
+import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum';
+import IRequestBody from '../types/IRequestBody';
+import IResponseBody from '../types/IResponseBody';
+import Request from '../Request';
+
+/**
+ * Fetch body utility.
+ */
+export default class FetchBodyUtility {
+	/**
+	 * Parses body and returns stream and type.
+	 *
+	 * Based on:
+	 * https://github.com/node-fetch/node-fetch/blob/main/src/body.js (MIT)
+	 *
+	 * @param body Body.
+	 * @returns Stream and type.
+	 */
+	public static getBodyStream(body: IRequestBody | IResponseBody): {
+		contentType: string;
+		contentLength: number | null;
+		stream: Stream.Readable;
+		buffer: Buffer | null;
+	} {
+		if (body === null || body === undefined) {
+			return { stream: null, buffer: null, contentType: null, contentLength: null };
+		} else if (body instanceof URLSearchParams) {
+			const buffer = Buffer.from(body.toString());
+			return {
+				buffer,
+				stream: Stream.Readable.from(Buffer.from(buffer)),
+				contentType: 'application/x-www-form-urlencoded;charset=UTF-8',
+				contentLength: buffer.length
+			};
+		} else if (body instanceof Blob) {
+			const buffer = (<Blob>body)._buffer;
+			return {
+				buffer,
+				stream: Stream.Readable.from(buffer),
+				contentType: (<Blob>body).type,
+				contentLength: body.size
+			};
+		} else if (Buffer.isBuffer(body)) {
+			return {
+				buffer: body,
+				stream: Stream.Readable.from(body),
+				contentType: null,
+				contentLength: body.length
+			};
+		} else if (body instanceof ArrayBuffer) {
+			const buffer = Buffer.from(body);
+			return {
+				buffer,
+				stream: Stream.Readable.from(buffer),
+				contentType: null,
+				contentLength: body.byteLength
+			};
+		} else if (ArrayBuffer.isView(body)) {
+			const buffer = Buffer.from(body.buffer, body.byteOffset, body.byteLength);
+			return {
+				buffer,
+				stream: Stream.Readable.from(buffer),
+				contentType: null,
+				contentLength: body.byteLength
+			};
+		} else if (body instanceof Stream.Stream) {
+			return {
+				buffer: null,
+				stream: <Stream.Readable>body,
+				contentType: null,
+				contentLength: null
+			};
+		} else if (body instanceof FormData) {
+			return MultipartFormDataParser.formDataToStream(body);
+		}
+
+		const buffer = Buffer.from(String(body));
+		return {
+			buffer,
+			stream: Stream.Readable.from(buffer),
+			contentType: 'text/plain;charset=UTF-8',
+			contentLength: buffer.length
+		};
+	}
+
+	/**
+	 * Clones a request body stream.
+	 *
+	 * @param request Request.
+	 * @returns Stream.
+	 */
+	public static cloneRequestBodyStream(request: Request): Stream.Readable {
+		if (request.bodyUsed) {
+			throw new DOMException(
+				`Failed to clone body stream of request: Request body is already used.`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+
+		const p1 = new Stream.PassThrough();
+		const p2 = new Stream.PassThrough();
+
+		request.body.pipe(p1);
+		request.body.pipe(p2);
+
+		// Sets the body of the cloned request to the first pass through stream.
+		(<Stream.Readable>request.body) = p1;
+
+		// Returns the clone.
+		return p2;
+	}
+
+	/**
+	 * Consume and convert an entire Body to a Buffer.
+	 *
+	 * Based on:
+	 * https://github.com/node-fetch/node-fetch/blob/main/src/body.js (MIT)
+	 *
+	 * @see https://fetch.spec.whatwg.org/#concept-body-consume-body
+	 * @param body Body stream.
+	 * @returns Promise.
+	 */
+	public static async consumeBodyStream(body: Stream.Readable | null): Promise<Buffer> {
+		if (body === null || !(body instanceof Stream.Stream)) {
+			return Buffer.alloc(0);
+		}
+
+		const chunks = [];
+		let bytes = 0;
+
+		try {
+			for await (const chunk of body) {
+				bytes += chunk.length;
+				chunks.push(chunk);
+			}
+		} catch (error) {
+			if (error instanceof DOMException) {
+				throw error;
+			}
+			throw new DOMException(
+				`Failed to read response body. Error: ${error.message}.`,
+				DOMExceptionNameEnum.encodingError
+			);
+		}
+
+		if (
+			(<Stream.Readable>body).readableEnded === false ||
+			(<Stream.Readable>body)['_readableState']?.ended === false
+		) {
+			throw new DOMException(
+				`Premature close of server response.`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+
+		try {
+			if (typeof chunks[0] === 'string') {
+				return Buffer.from(chunks.join(''));
+			}
+
+			return Buffer.concat(chunks, bytes);
+		} catch (error) {
+			throw new DOMException(
+				`Could not create Buffer from response body. Error: ${error.message}.`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+	}
+}

package/src/fetch/utilities/FetchCORSUtility.ts

@@ -0,0 +1,18 @@
+/**
+ * Fetch CORS utility.
+ */
+export default class FetchCORSUtility {
+	/**
+	 * Validates request headers.
+	 *
+	 * @param originURL Origin URL.
+	 * @param targetURL Target URL.
+	 */
+	public static isCORS(originURL, targetURL): boolean {
+		return (
+			(originURL.hostname !== targetURL.hostname &&
+				!originURL.hostname.endsWith(targetURL.hostname)) ||
+			originURL.protocol !== targetURL.protocol
+		);
+	}
+}