happy-dom 7.7.1 → 7.8.0

package/src/cookie/Cookie.ts

@@ -0,0 +1,158 @@
+const CookiePairRegex = /([^=]+)(?:=([\s\S]*))?/;
+
+/**
+ * Cookie.
+ */
+export default class Cookie {
+	private pairs: { [key: string]: string } = {};
+	//
+	public key = '';
+	public value = '';
+	public size = 0;
+	// Optional
+	public domain = '';
+	public path = '';
+	public expriesOrMaxAge: Date = null;
+	public httpOnly = false;
+	public secure = false;
+	public sameSite = '';
+
+	/**
+	 * Constructor.
+	 *
+	 * @param cookie Cookie.
+	 */
+	constructor(cookie: string) {
+		let match: RegExpExecArray | null;
+
+		const parts = cookie.split(';').filter(Boolean);
+
+		// Part[0] is the key-value pair.
+		match = new RegExp(CookiePairRegex).exec(parts[0]);
+		if (!match) {
+			throw new Error(`Invalid cookie: ${cookie}`);
+		}
+		this.key = match[1].trim();
+		this.value = match[2];
+		// Set key is empty if match[2] is undefined.
+		if (!match[2]) {
+			this.value = this.key;
+			this.key = '';
+		}
+		this.pairs[this.key] = this.value;
+		this.size = this.key.length + this.value.length;
+		// Attribute.
+		for (const part of parts.slice(1)) {
+			match = new RegExp(CookiePairRegex).exec(part);
+			if (!match) {
+				throw new Error(`Invalid cookie: ${part}`);
+			}
+			const key = match[1].trim();
+			const value = match[2];
+
+			switch (key.toLowerCase()) {
+				case 'expires':
+					this.expriesOrMaxAge = new Date(value);
+					break;
+				case 'max-age':
+					this.expriesOrMaxAge = new Date(parseInt(value, 10) * 1000 + Date.now());
+					break;
+				case 'domain':
+					this.domain = value;
+					break;
+				case 'path':
+					this.path = value.startsWith('/') ? value : `/${value}`;
+					break;
+				case 'httponly':
+					this.httpOnly = true;
+					break;
+				case 'secure':
+					this.secure = true;
+					break;
+				case 'samesite':
+					this.sameSite = value;
+					break;
+				default:
+					continue; // Skip.
+			}
+			// Skip unknown key-value pair.
+			if (
+				['expires', 'max-age', 'domain', 'path', 'httponly', 'secure', 'samesite'].indexOf(
+					key.toLowerCase()
+				) === -1
+			) {
+				continue;
+			}
+			this.pairs[key] = value;
+		}
+	}
+
+	/**
+	 * Returns a raw string of the cookie.
+	 */
+	public rawString(): string {
+		return Object.keys(this.pairs)
+			.map((key) => {
+				if (key) {
+					return `${key}=${this.pairs[key]}`;
+				}
+				return this.pairs[key];
+			})
+			.join('; ');
+	}
+
+	/**
+	 *
+	 */
+	public cookieString(): string {
+		if (this.key) {
+			return `${this.key}=${this.value}`;
+		}
+		return this.value;
+	}
+
+	/**
+	 *
+	 */
+	public isExpired(): boolean {
+		// If the expries/maxage is set, then determine whether it is expired.
+		if (this.expriesOrMaxAge && this.expriesOrMaxAge.getTime() < Date.now()) {
+			return true;
+		}
+		// If the expries/maxage is not set, it's a session-level cookie that will expire when the browser is closed.
+		// (it's never expired in happy-dom)
+		return false;
+	}
+
+	/**
+	 *
+	 */
+	public isHttpOnly(): boolean {
+		return this.httpOnly;
+	}
+
+	/**
+	 *
+	 */
+	public isSecure(): boolean {
+		return this.secure;
+	}
+
+	/**
+	 * Parse a cookie string.
+	 *
+	 * @param cookieString
+	 */
+	public static parse(cookieString: string): Cookie {
+		return new Cookie(cookieString);
+	}
+
+	/**
+	 * Stringify a Cookie object.
+	 *
+	 * @param cookie
+	 */
+	public static stringify(cookie: Cookie): string {
+		return cookie.toString();
+	}
+}

package/src/cookie/CookieJar.ts

@@ -0,0 +1,82 @@
+import Location from 'src/location/Location';
+import Cookie from './Cookie';
+
+/**
+ * CookieJar.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie.
+ */
+export default class CookieJar {
+	private cookies: Cookie[] = [];
+
+	/**
+	 * Validate cookie.
+	 *
+	 * @param cookie
+	 */
+	private validateCookie(cookie: Cookie): boolean {
+		if (cookie.key.toLowerCase().startsWith('__secure-') && !cookie.isSecure()) {
+			return false;
+		}
+		if (
+			cookie.key.toLowerCase().startsWith('__host-') &&
+			(!cookie.isSecure() || cookie.path !== '/' || cookie.domain)
+		) {
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * Set cookie.
+	 *
+	 * @param cookieString
+	 */
+	public setCookiesString(cookieString: string): void {
+		if (!cookieString) {
+			return;
+		}
+		const newCookie = new Cookie(cookieString);
+		if (!this.validateCookie(newCookie)) {
+			return;
+		}
+		this.cookies
+			.filter((cookie) => cookie.key === newCookie.key)
+			.forEach((cookie) => {
+				this.cookies.splice(this.cookies.indexOf(cookie), 1);
+			});
+		this.cookies.push(newCookie);
+	}
+
+	/**
+	 * Get cookie.
+	 *
+	 * @param location Location.
+	 * @param fromDocument If true, the caller is a document.
+	 * @returns Cookie string.
+	 */
+	public getCookiesString(location: Location, fromDocument: boolean): string {
+		const cookies = this.cookies.filter((cookie) => {
+			// Skip when use document.cookie and the cookie is httponly.
+			if (fromDocument && cookie.isHttpOnly()) {
+				return false;
+			}
+			if (cookie.isExpired()) {
+				return false;
+			}
+			if (cookie.isSecure() && location.protocol !== 'https:') {
+				return false;
+			}
+			if (cookie.domain && !location.hostname.endsWith(cookie.domain)) {
+				return false;
+			}
+			if (cookie.path && !location.pathname.startsWith(cookie.path)) {
+				return false;
+			}
+			// TODO: check SameSite.
+			return true;
+		});
+		return cookies.map((cookie) => cookie.cookieString()).join('; ');
+	}
+}

package/src/event/IEventListener.ts

@@ -7,7 +7,7 @@ export default interface IEventListener {
 	/**
 	 * Handles event.
 	 *
-	 * @param type Event type.
+	 * @param event Event.
 	 */
 	handleEvent(event: Event): void;
 }

package/src/exception/DOMExceptionNameEnum.ts

@@ -8,6 +8,9 @@ enum DOMExceptionNameEnum {
 	invalidNodeTypeError = 'InvalidNodeTypeError',
 	invalidCharacterError = 'InvalidCharacterError',
 	notFoundError = 'NotFoundError',
-	domException = 'DOMException'
+	securityError = 'SecurityError',
+	networkError = 'NetworkError',
+	domException = 'DOMException',
+	invalidAccessError = 'InvalidAccessError'
 }
 export default DOMExceptionNameEnum;

package/src/fetch/FetchHandler.ts

@@ -4,27 +4,63 @@ import IDocument from '../nodes/document/IDocument';
 import IResponse from './IResponse';
 import Response from './Response';
 import NodeFetch from 'node-fetch';
+import Request from './Request';
+import RequestInfo from './RequestInfo';
+import { URL } from 'url';
 
 /**
  * Helper class for performing fetch.
  */
 export default class FetchHandler {
 	/**
-	 * Returns resource data asynchonously.
+	 * Returns resource data asynchronously.
 	 *
 	 * @param document Document.
 	 * @param url URL to resource.
 	 * @param [init] Init.
 	 * @returns Response.
 	 */
-	public static fetch(document: IDocument, url: string, init?: IRequestInit): Promise<IResponse> {
-		// We want to only load NodeFetch when it is needed to improve performance and not have direct dependencies to server side packages.
+	public static fetch(
+		document: IDocument,
+		url: RequestInfo,
+		init?: IRequestInit
+	): Promise<IResponse> {
 		const taskManager = document.defaultView.happyDOM.asyncTaskManager;
+		const requestInit = { ...init, headers: { ...init?.headers } };
+		const cookie = document.defaultView.document.cookie;
+		const referer = document.defaultView.location.origin;
+
+		requestInit.headers['user-agent'] = document.defaultView.navigator.userAgent;
+
+		// We need set referer to solve anti-hotlinking.
+		// And the browser will set the referer to the origin of the page.
+		// Referer is "null" when the URL is set to "about:blank".
+		// This is also how the browser behaves.
+		if (referer !== 'null') {
+			requestInit.headers['referer'] = referer;
+		}
+
+		if (cookie) {
+			requestInit.headers['set-cookie'] = cookie;
+		}
+
+		let request;
+
+		if (typeof url === 'string') {
+			request = new Request(RelativeURL.getAbsoluteURL(document.defaultView.location, url));
+		} else if (url instanceof URL) {
+			// URLs are always absolute, no need for getAbsoluteURL.
+			request = new Request(url);
+		} else {
+			request = new Request(RelativeURL.getAbsoluteURL(document.defaultView.location, url.url), {
+				...url
+			});
+		}
 
 		return new Promise((resolve, reject) => {
 			const taskID = taskManager.startTask();
 
-			NodeFetch(RelativeURL.getAbsoluteURL(document.defaultView.location, url), init)
+			NodeFetch(request, requestInit)
 				.then((response) => {
 					if (taskManager.getTaskCount() === 0) {
 						reject(new Error('Failed to complete fetch request. Task was canceled.'));

package/src/fetch/RequestInfo.ts

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

package/src/fetch/ResourceFetchHandler.ts

@@ -7,7 +7,7 @@ import IDocument from '../nodes/document/IDocument';
  */
 export default class ResourceFetchHandler {
 	/**
-	 * Returns resource data asynchonously.
+	 * Returns resource data asynchronously.
 	 *
 	 * @param document Document.
 	 * @param url URL.
@@ -24,7 +24,7 @@ export default class ResourceFetchHandler {
 	}
 
 	/**
-	 * Returns resource data synchonously.
+	 * Returns resource data synchronously.
 	 *
 	 * @param document Document.
 	 * @param url URL.
@@ -32,16 +32,18 @@ export default class ResourceFetchHandler {
 	 */
 	public static fetchSync(document: IDocument, url: string): string {
 		// We want to only load SyncRequest when it is needed to improve performance and not have direct dependencies to server side packages.
-		const absoluteURL = RelativeURL.getAbsoluteURL(document.defaultView.location, url);
-		const syncRequest = require('sync-request');
-		const response = syncRequest('GET', absoluteURL);
+		const absoluteURL = RelativeURL.getAbsoluteURL(document.defaultView.location, url).href;
 
-		if (response.isError()) {
+		const xhr = new document.defaultView.XMLHttpRequest();
+		xhr.open('GET', absoluteURL, false);
+		xhr.send();
+
+		if (xhr.status !== 200) {
 			throw new DOMException(
-				`Failed to perform request to "${absoluteURL}". Status code: ${response.statusCode}`
+				`Failed to perform request to "${absoluteURL}". Status code: ${xhr.status}`
 			);
 		}
 
-		return response.getBody().toString();
+		return xhr.responseText;
 	}
 }

package/src/index.ts

@@ -4,7 +4,7 @@ import Window from './window/Window';
 import DataTransfer from './event/DataTransfer';
 import DataTransferItem from './event/DataTransferItem';
 import DataTransferItemList from './event/DataTransferItemList';
-import URL from './location/URL';
+import { URL, URLSearchParams } from 'url';
 import Location from './location/Location';
 import MutationObserver from './mutation-observer/MutationObserver';
 import ResizeObserver from './resize-observer/ResizeObserver';
@@ -115,7 +115,6 @@ import CSSMediaRule from './css/rules/CSSMediaRule';
 import CSSStyleRule from './css/rules/CSSStyleRule';
 import Storage from './storage/Storage';
 import DOMRect from './nodes/element/DOMRect';
-import { URLSearchParams } from 'url';
 import Selection from './selection/Selection';
 import Range from './range/Range';
 import HTMLDialogElement from './nodes/html-dialog-element/HTMLDialogElement';

package/src/location/Location.ts

@@ -1,4 +1,4 @@
-import URL from './URL';
+import { URL } from 'url';
 
 /**
  *
@@ -8,7 +8,7 @@ export default class Location extends URL {
 	 * Constructor.
 	 */
 	constructor() {
-		super('');
+		super('about:blank');
 	}
 
 	/**
@@ -17,7 +17,7 @@ export default class Location extends URL {
 	 * @param url URL.
 	 */
 	public replace(url: string): void {
-		this.parse(url);
+		this.href = url;
 	}
 
 	/**

package/src/location/RelativeURL.ts

@@ -1,4 +1,5 @@
 import Location from './Location';
+import { URL } from 'url';
 
 /**
  * Helper class for getting the URL relative to a Location object.
@@ -10,19 +11,7 @@ export default class RelativeURL {
 	 * @param location Location.
 	 * @param url URL.
 	 */
-	public static getAbsoluteURL(location: Location, url: string): string {
-		if (url.startsWith('/')) {
-			return location.origin + url;
-		}
-
-		if (!url.startsWith('https://') && !url.startsWith('http://')) {
-			let pathname = location.pathname;
-			if (pathname.endsWith('/')) {
-				pathname = pathname.slice(0, -1);
-			}
-			return location.origin + pathname + '/' + url;
-		}
-
-		return url;
+	public static getAbsoluteURL(location: Location, url: string): URL {
+		return new URL(url, location.href);
 	}
 }

package/src/nodes/document/Document.ts

@@ -19,7 +19,7 @@ import QuerySelector from '../../query-selector/QuerySelector';
 import IDocument from './IDocument';
 import CSSStyleSheet from '../../css/CSSStyleSheet';
 import DOMException from '../../exception/DOMException';
-import CookieUtility from '../../cookie/CookieUtility';
+import CookieJar from '../../cookie/CookieJar';
 import IElement from '../element/IElement';
 import IHTMLScriptElement from '../html-script-element/IHTMLScriptElement';
 import IHTMLElement from '../html-element/IHTMLElement';
@@ -63,10 +63,12 @@ export default class Document extends Node implements IDocument {
 
 	// Used as an unique identifier which is updated whenever the DOM gets modified.
 	public _cacheID = 0;
+	// Public in order to be accessible by the fetch and xhr.
+	public _cookie = new CookieJar();
 
 	protected _isFirstWrite = true;
 	protected _isFirstWriteAfterOpen = false;
-	private _cookie = '';
+
 	private _selection: Selection = null;
 
 	// Events
@@ -183,7 +185,6 @@ export default class Document extends Node implements IDocument {
 	/**
 	 * Creates an instance of Document.
 	 *
-	 * @param defaultView Default view.
 	 */
 	constructor() {
 		super();
@@ -258,7 +259,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Cookie.
 	 */
 	public get cookie(): string {
-		return this._cookie;
+		return this._cookie.getCookiesString(this.defaultView.location, true);
 	}
 
 	/**
@@ -267,7 +268,7 @@ export default class Document extends Node implements IDocument {
 	 * @param cookie Cookie string.
 	 */
 	public set cookie(cookie: string) {
-		this._cookie = CookieUtility.getCookieString(this.defaultView.location, this._cookie, cookie);
+		this._cookie.setCookiesString(cookie);
 	}
 
 	/**
@@ -404,6 +405,24 @@ export default class Document extends Node implements IDocument {
 		return this.defaultView.location.href;
 	}
 
+	/**
+	 * Returns URL.
+	 *
+	 * @returns the URL of the current document.
+	 * */
+	public get URL(): string {
+		return this.defaultView.location.href;
+	}
+
+	/**
+	 * Returns document URI.
+	 *
+	 * @returns the URL of the current document.
+	 * */
+	public get documentURI(): string {
+		return this.URL;
+	}
+
 	/**
 	 * Inserts a set of Node objects or DOMString objects after the last child of the ParentNode. DOMString objects are inserted as equivalent Text nodes.
 	 *
@@ -866,7 +885,6 @@ export default class Document extends Node implements IDocument {
 	 *
 	 * @param node Node to import.
 	 * @param [deep=false] Set to "true" if the clone should be deep.
-	 * @param Imported Node.
 	 */
 	public importNode(node: INode, deep = false): INode {
 		if (!(node instanceof Node)) {

package/src/nodes/document/IDocument.ts

@@ -39,6 +39,8 @@ export default interface IDocument extends IParentNode {
 	readonly readyState: DocumentReadyStateEnum;
 	readonly charset: string;
 	readonly characterSet: string;
+	readonly URL: string;
+	readonly documentURI: string;
 	cookie: string;
 
 	// Events

package/src/nodes/html-link-element/HTMLLinkElement.ts

@@ -196,7 +196,8 @@ export default class HTMLLinkElement extends HTMLElement implements IHTMLLinkEle
 			href !== null &&
 			rel &&
 			rel.toLowerCase() === 'stylesheet' &&
-			this.isConnected
+			this.isConnected &&
+			!this.ownerDocument.defaultView.happyDOM.settings.disableCSSFileLoading
 		) {
 			(<Document>this.ownerDocument)._readyStateManager.startTask();
 			ResourceFetchHandler.fetch(this.ownerDocument, href)
@@ -255,7 +256,11 @@ export default class HTMLLinkElement extends HTMLElement implements IHTMLLinkEle
 
 		super._connectToNode(parentNode);
 
-		if (isConnected !== isParentConnected && this._evaluateCSS) {
+		if (
+			isConnected !== isParentConnected &&
+			this._evaluateCSS &&
+			!this.ownerDocument.defaultView.happyDOM.settings.disableCSSFileLoading
+		) {
 			const href = this.getAttributeNS(null, 'href');
 			const rel = this.getAttributeNS(null, 'rel');
 

package/src/nodes/html-script-element/HTMLScriptElement.ts

@@ -193,7 +193,7 @@ export default class HTMLScriptElement extends HTMLElement implements IHTMLScrip
 
 			if (src !== null) {
 				ScriptUtility.loadExternalScript(this);
-			} else {
+			} else if (!this.ownerDocument.defaultView.happyDOM.settings.disableJavaScriptEvaluation) {
 				const textContent = this.textContent;
 				const type = this.getAttributeNS(null, 'type');
 				if (

package/src/nodes/html-script-element/ScriptUtility.ts

@@ -18,6 +18,14 @@ export default class ScriptUtility {
 	public static async loadExternalScript(element: HTMLScriptElement): Promise<void> {
 		const src = element.getAttributeNS(null, 'src');
 		const async = element.getAttributeNS(null, 'async') !== null;
+
+		if (
+			element.ownerDocument.defaultView.happyDOM.settings.disableJavaScriptFileLoading ||
+			element.ownerDocument.defaultView.happyDOM.settings.disableJavaScriptEvaluation
+		) {
+			return;
+		}
+
 		if (async) {
 			let code = null;
 			(<Document>element.ownerDocument)._readyStateManager.startTask();

package/src/window/IHappyDOMSettings.ts

@@ -0,0 +1,9 @@
+/**
+ * Happy DOM settings.
+ */
+export default interface IHappyDOMSettings {
+	disableJavaScriptEvaluation: boolean;
+	disableJavaScriptFileLoading: boolean;
+	disableCSSFileLoading: boolean;
+	enableFileSystemHttpRequests: boolean;
+}