happy-dom 13.4.0 → 13.5.0

package/src/fetch/multipart/MultipartFormDataParser.ts

@@ -1,9 +1,10 @@
 import FormData from '../../form-data/FormData.js';
+import { ReadableStream } from 'stream/web';
 import * as PropertySymbol from '../../PropertySymbol.js';
-import Stream from 'stream';
 import MultipartReader from './MultipartReader.js';
 import DOMException from '../../exception/DOMException.js';
 import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum.js';
+import { Buffer } from 'buffer';
 
 /**
  * Multipart form data factory.
@@ -20,7 +21,7 @@ export default class MultipartFormDataParser {
 	 * @returns Form data.
 	 */
 	public static async streamToFormData(
-		body: Stream.Readable,
+		body: ReadableStream,
 		contentType: string
 	): Promise<{ formData: FormData; buffer: Buffer }> {
 		if (!/multipart/i.test(contentType)) {
@@ -39,35 +40,17 @@ export default class MultipartFormDataParser {
 			);
 		}
 
+		const bodyReader = body.getReader();
 		const reader = new MultipartReader(match[1] || match[2]);
 		const chunks = [];
 		let buffer: Buffer;
-		let bytes = 0;
+		const bytes = 0;
 
-		try {
-			for await (const chunk of body) {
-				reader.write(chunk);
-				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
-			);
-		}
+		let readResult = await bodyReader.read();
 
-		if (
-			(<Stream.Readable>body).readableEnded === false ||
-			(<Stream.Readable>body)['_readableState']?.ended === false
-		) {
-			throw new DOMException(
-				`Premature close of server response.`,
-				DOMExceptionNameEnum.invalidStateError
-			);
+		while (!readResult.done) {
+			reader.write(readResult.value);
+			readResult = await bodyReader.read();
 		}
 
 		try {
@@ -96,7 +79,7 @@ export default class MultipartFormDataParser {
 		contentType: string;
 		contentLength: number;
 		buffer: Buffer;
-		stream: Stream.Readable;
+		stream: ReadableStream;
 	} {
 		const boundary = '----HappyDOMFormDataBoundary' + Math.random().toString(36);
 		const chunks: Buffer[] = [];
@@ -132,7 +115,12 @@ export default class MultipartFormDataParser {
 			contentType: `multipart/form-data; boundary=${boundary}`,
 			contentLength: buffer.length,
 			buffer,
-			stream: Stream.Readable.from(buffer)
+			stream: new ReadableStream({
+				start(controller) {
+					controller.enqueue(buffer);
+					controller.close();
+				}
+			})
 		};
 	}
 

package/src/fetch/types/IRequest.ts

@@ -1,7 +1,7 @@
 import IHeaders from './IHeaders.js';
 import IBlob from '../../file/IBlob.js';
 import AbortSignal from '../AbortSignal.js';
-import Stream from 'stream';
+import { ReadableStream } from 'stream/web';
 import IRequestReferrerPolicy from './IRequestReferrerPolicy.js';
 import IRequestRedirect from './IRequestRedirect.js';
 import IRequestCredentials from './IRequestCredentials.js';
@@ -16,7 +16,7 @@ export default interface IRequest {
 	readonly redirect: IRequestRedirect;
 	readonly referrer: string;
 	readonly url: string;
-	readonly body: Stream.Readable | null;
+	readonly body: ReadableStream | null;
 	readonly bodyUsed: boolean;
 	readonly referrerPolicy: IRequestReferrerPolicy;
 	readonly signal: AbortSignal | null;

package/src/fetch/types/IRequestBody.ts

@@ -1,12 +1,12 @@
 import { URLSearchParams } from 'url';
 import FormData from '../../form-data/FormData.js';
 import Blob from '../../file/Blob.js';
-import Stream from 'stream';
+import { ReadableStream } from 'stream/web';
 
 type IRequestBody =
 	| ArrayBuffer
 	| ArrayBufferView
-	| Stream.Readable
+	| ReadableStream
 	| string
 	| URLSearchParams
 	| Blob

package/src/fetch/types/IResponse.ts

@@ -1,6 +1,6 @@
 import IHeaders from './IHeaders.js';
 import IBlob from '../../file/IBlob.js';
-import Stream from 'stream';
+import { ReadableStream } from 'stream/web';
 import { Buffer } from 'buffer';
 
 /**
@@ -16,7 +16,7 @@ export default interface IResponse {
 	readonly statusText: string;
 	readonly type: 'basic' | 'cors' | 'default' | 'error' | 'opaque' | 'opaqueredirect';
 	readonly url: string;
-	readonly body: Stream.Readable | null;
+	readonly body: ReadableStream | null;
 	readonly bodyUsed: boolean;
 
 	arrayBuffer(): Promise<ArrayBuffer>;

package/src/fetch/types/IResponseBody.ts

@@ -1,12 +1,12 @@
+import { ReadableStream } from 'stream/web';
 import { URLSearchParams } from 'url';
 import FormData from '../../form-data/FormData.js';
 import Blob from '../../file/Blob.js';
-import Stream from 'stream';
 
 type IResponseBody =
 	| ArrayBuffer
 	| ArrayBufferView
-	| Stream.Readable
+	| ReadableStream
 	| string
 	| URLSearchParams
 	| Blob

package/src/fetch/utilities/FetchBodyUtility.ts

@@ -1,6 +1,6 @@
 import MultipartFormDataParser from '../multipart/MultipartFormDataParser.js';
+import { ReadableStream } from 'stream/web';
 import * as PropertySymbol from '../../PropertySymbol.js';
-import Stream from 'stream';
 import { URLSearchParams } from 'url';
 import FormData from '../../form-data/FormData.js';
 import Blob from '../../file/Blob.js';
@@ -14,6 +14,24 @@ import { Buffer } from 'buffer';
  * Fetch body utility.
  */
 export default class FetchBodyUtility {
+	/**
+	 * Wraps a given value in a browser ReadableStream.
+	 *
+	 * This method creates a ReadableStream and immediately enqueues and closes it
+	 * with the provided value, useful for stream API compatibility.
+	 *
+	 * @param value The value to be wrapped in a ReadableStream.
+	 * @returns ReadableStream
+	 */
+	public static toReadableStream(value): ReadableStream {
+		return new ReadableStream({
+			start(controller) {
+				controller.enqueue(value);
+				controller.close();
+			}
+		});
+	}
+
 	/**
 	 * Parses body and returns stream and type.
 	 *
@@ -26,7 +44,7 @@ export default class FetchBodyUtility {
 	public static getBodyStream(body: IRequestBody | IResponseBody): {
 		contentType: string;
 		contentLength: number | null;
-		stream: Stream.Readable;
+		stream: ReadableStream | null;
 		buffer: Buffer | null;
 	} {
 		if (body === null || body === undefined) {
@@ -35,7 +53,7 @@ export default class FetchBodyUtility {
 			const buffer = Buffer.from(body.toString());
 			return {
 				buffer,
-				stream: Stream.Readable.from(Buffer.from(buffer)),
+				stream: this.toReadableStream(buffer),
 				contentType: 'application/x-www-form-urlencoded;charset=UTF-8',
 				contentLength: buffer.length
 			};
@@ -43,14 +61,14 @@ export default class FetchBodyUtility {
 			const buffer = (<Blob>body)[PropertySymbol.buffer];
 			return {
 				buffer,
-				stream: Stream.Readable.from(buffer),
-				contentType: (<Blob>body).type,
+				stream: this.toReadableStream(buffer),
+				contentType: body.type,
 				contentLength: body.size
 			};
 		} else if (Buffer.isBuffer(body)) {
 			return {
 				buffer: body,
-				stream: Stream.Readable.from(body),
+				stream: this.toReadableStream(body),
 				contentType: null,
 				contentLength: body.length
 			};
@@ -58,7 +76,7 @@ export default class FetchBodyUtility {
 			const buffer = Buffer.from(body);
 			return {
 				buffer,
-				stream: Stream.Readable.from(buffer),
+				stream: this.toReadableStream(buffer),
 				contentType: null,
 				contentLength: body.byteLength
 			};
@@ -66,14 +84,14 @@ export default class FetchBodyUtility {
 			const buffer = Buffer.from(body.buffer, body.byteOffset, body.byteLength);
 			return {
 				buffer,
-				stream: Stream.Readable.from(buffer),
+				stream: this.toReadableStream(buffer),
 				contentType: null,
 				contentLength: body.byteLength
 			};
-		} else if (body instanceof Stream.Stream) {
+		} else if (body instanceof ReadableStream) {
 			return {
 				buffer: null,
-				stream: <Stream.Readable>body,
+				stream: body,
 				contentType: null,
 				contentLength: null
 			};
@@ -84,7 +102,7 @@ export default class FetchBodyUtility {
 		const buffer = Buffer.from(String(body));
 		return {
 			buffer,
-			stream: Stream.Readable.from(buffer),
+			stream: this.toReadableStream(buffer),
 			contentType: 'text/plain;charset=UTF-8',
 			contentLength: buffer.length
 		};
@@ -102,9 +120,9 @@ export default class FetchBodyUtility {
 	 * @returns New stream.
 	 */
 	public static cloneBodyStream(requestOrResponse: {
-		body: Stream.Readable;
+		body: ReadableStream;
 		bodyUsed: boolean;
-	}): Stream.Readable {
+	}): ReadableStream {
 		if (requestOrResponse.bodyUsed) {
 			throw new DOMException(
 				`Failed to clone body stream of request: Request body is already used.`,
@@ -112,17 +130,15 @@ export default class FetchBodyUtility {
 			);
 		}
 
-		const p1 = new Stream.PassThrough();
-		const p2 = new Stream.PassThrough();
-
-		requestOrResponse.body.pipe(p1);
-		requestOrResponse.body.pipe(p2);
+		// Uses the tee() method to clone the ReadableStream
+		const [stream1, stream2] = requestOrResponse.body.tee();
 
-		// Sets the body of the cloned request/response to the first pass through stream.
-		(<Stream.Readable>requestOrResponse.body) = p1;
+		// Sets the body of the cloned request to the first pass through stream.
+		// TODO: check id this is required as request should be read only object
+		<ReadableStream>requestOrResponse.body == stream1;
 
-		// Returns the clone.
-		return p2;
+		// Returns the other stream as the clone
+		return stream2;
 	}
 
 	/**
@@ -135,18 +151,29 @@ export default class FetchBodyUtility {
 	 * @param body Body stream.
 	 * @returns Promise.
 	 */
-	public static async consumeBodyStream(body: Stream.Readable | null): Promise<Buffer> {
-		if (body === null || !(body instanceof Stream.Stream)) {
+	public static async consumeBodyStream(body: ReadableStream | null): Promise<Buffer> {
+		if (body === null || !(body instanceof ReadableStream)) {
 			return Buffer.alloc(0);
 		}
 
+		if (body[PropertySymbol.error]) {
+			throw body[PropertySymbol.error];
+		}
+
+		const reader = body.getReader();
 		const chunks = [];
 		let bytes = 0;
 
 		try {
-			for await (const chunk of body) {
+			let readResult = await reader.read();
+			while (!readResult.done) {
+				if (body[PropertySymbol.error]) {
+					throw body[PropertySymbol.error];
+				}
+				const chunk = readResult.value;
 				bytes += chunk.length;
 				chunks.push(chunk);
+				readResult = await reader.read();
 			}
 		} catch (error) {
 			if (error instanceof DOMException) {
@@ -158,16 +185,6 @@ export default class FetchBodyUtility {
 			);
 		}
 
-		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(''));

package/src/window/BrowserWindow.ts

@@ -113,6 +113,7 @@ import ProcessingInstruction from '../nodes/processing-instruction/ProcessingIns
 import RequestInfo from '../fetch/types/IRequestInfo.js';
 import FileList from '../nodes/html-input-element/FileList.js';
 import Stream from 'stream';
+import { ReadableStream } from 'stream/web';
 import FormData from '../form-data/FormData.js';
 import AbortController from '../fetch/AbortController.js';
 import AbortSignal from '../fetch/AbortSignal.js';
@@ -383,7 +384,7 @@ export default class BrowserWindow extends EventTarget implements IBrowserWindow
 	};
 	public readonly XMLHttpRequestUpload = XMLHttpRequestUpload;
 	public readonly XMLHttpRequestEventTarget = XMLHttpRequestEventTarget;
-	public readonly ReadableStream = Stream.Readable;
+	public readonly ReadableStream = ReadableStream;
 	public readonly WritableStream = Stream.Writable;
 	public readonly TransformStream = Stream.Transform;
 	public readonly AbortController = AbortController;

package/src/window/IBrowserWindow.ts

@@ -116,6 +116,7 @@ import ProcessingInstruction from '../nodes/processing-instruction/ProcessingIns
 import RequestInfo from '../fetch/types/IRequestInfo.js';
 import FileList from '../nodes/html-input-element/FileList.js';
 import Stream from 'stream';
+import { ReadableStream } from 'stream/web';
 import { webcrypto } from 'crypto';
 import FormData from '../form-data/FormData.js';
 import AbortController from '../fetch/AbortController.js';
@@ -361,7 +362,7 @@ export default interface IBrowserWindow extends IEventTarget, INodeJSGlobal {
 	readonly XMLHttpRequestUpload: typeof XMLHttpRequestUpload;
 	readonly XMLHttpRequestEventTarget: typeof XMLHttpRequestEventTarget;
 	readonly FileList: typeof FileList;
-	readonly ReadableStream: typeof Stream.Readable;
+	readonly ReadableStream: typeof ReadableStream;
 	readonly WritableStream: typeof Stream.Writable;
 	readonly TransformStream: typeof Stream.Transform;
 	readonly FormData: typeof FormData;