happy-dom 9.1.9 → 9.2.0

package/src/cookie/Cookie.ts

@@ -1,61 +1,54 @@
-const CookiePairRegex = /([^=]+)(?:=([\s\S]*))?/;
+import DOMException from '../exception/DOMException';
+import DOMExceptionNameEnum from '../exception/DOMExceptionNameEnum';
+import CookieSameSiteEnum from './CookieSameSiteEnum';
+import { URL } from 'url';
 
 /**
  * Cookie.
  */
 export default class Cookie {
-	private pairs: { [key: string]: string } = {};
-	//
+	// Required
 	public key = '';
-	public value = '';
-	public size = 0;
+	public value: string | null = null;
+	public originURL: URL;
+
 	// Optional
 	public domain = '';
 	public path = '';
-	public expriesOrMaxAge: Date = null;
+	public expires: Date | null = null;
 	public httpOnly = false;
 	public secure = false;
-	public sameSite = '';
+	public sameSite: CookieSameSiteEnum = CookieSameSiteEnum.lax;
 
 	/**
 	 * Constructor.
 	 *
+	 * @param originURL Origin URL.
 	 * @param cookie Cookie.
 	 */
-	constructor(cookie: string) {
-		let match: RegExpExecArray | null;
+	constructor(originURL, cookie: string) {
+		const parts = cookie.split(';');
+		const [key, value] = parts.shift().split('=');
 
-		const parts = cookie.split(';').filter(Boolean);
+		this.originURL = originURL;
+		this.key = key.trim();
+		this.value = value !== undefined ? value : null;
 
-		// 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] && parts[0][this.key.length] !== '=') {
-			this.value = this.key;
-			this.key = '';
+		if (!this.key) {
+			throw new DOMException(`Invalid cookie: ${cookie}.`, DOMExceptionNameEnum.syntaxError);
 		}
-		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()) {
+		for (const part of parts) {
+			const keyAndValue = part.split('=');
+			const key = keyAndValue[0].trim().toLowerCase();
+			const value = keyAndValue[1];
+
+			switch (key) {
 				case 'expires':
-					this.expriesOrMaxAge = new Date(value);
+					this.expires = new Date(value);
 					break;
 				case 'max-age':
-					this.expriesOrMaxAge = new Date(parseInt(value, 10) * 1000 + Date.now());
+					this.expires = new Date(parseInt(value, 10) * 1000 + Date.now());
 					break;
 				case 'domain':
 					this.domain = value;
@@ -70,53 +63,42 @@ export default class Cookie {
 					this.secure = true;
 					break;
 				case 'samesite':
-					this.sameSite = value;
+					switch (value.toLowerCase()) {
+						case 'strict':
+							this.sameSite = CookieSameSiteEnum.strict;
+							break;
+						case 'lax':
+							this.sameSite = CookieSameSiteEnum.lax;
+							break;
+						case 'none':
+							this.sameSite = CookieSameSiteEnum.none;
+					}
 					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('; ');
-	}
-
-	/**
+	 * Returns cookie string.
 	 *
+	 * @returns Cookie string.
 	 */
-	public cookieString(): string {
-		if (this.key) {
+	public toString(): string {
+		if (this.value !== null) {
 			return `${this.key}=${this.value}`;
 		}
-		return this.value;
+
+		return this.key;
 	}
 
 	/**
+	 * Returns "true" if expired.
 	 *
+	 * @returns "true" if expired.
 	 */
 	public isExpired(): boolean {
 		// If the expries/maxage is set, then determine whether it is expired.
-		if (this.expriesOrMaxAge && this.expriesOrMaxAge.getTime() < Date.now()) {
+		if (this.expires && this.expires.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.
@@ -125,34 +107,19 @@ export default class Cookie {
 	}
 
 	/**
+	 * Validate cookie.
 	 *
+	 * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#cookie_prefixes
+	 * @returns "true" if valid.
 	 */
-	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();
+	public validate(): boolean {
+		const lowerKey = this.key.toLowerCase();
+		if (lowerKey.startsWith('__secure-') && !this.secure) {
+			return false;
+		}
+		if (lowerKey.startsWith('__host-') && (!this.secure || this.path !== '/' || this.domain)) {
+			return false;
+		}
+		return true;
 	}
 }

package/src/cookie/CookieJar.ts

@@ -1,5 +1,6 @@
-import Location from 'src/location/Location';
 import Cookie from './Cookie';
+import CookieSameSiteEnum from './CookieSameSiteEnum';
+import { URL } from 'url';
 
 /**
  * CookieJar.
@@ -11,72 +12,70 @@ export default class CookieJar {
 	private cookies: Cookie[] = [];
 
 	/**
-	 * Validate cookie.
+	 * Adds cookie string.
 	 *
-	 * @param cookie
+	 * @param originURL Origin URL.
+	 * @param cookieString Cookie string.
 	 */
-	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 {
+	public addCookieString(originURL: URL, cookieString: string): void {
 		if (!cookieString) {
 			return;
 		}
-		const newCookie = new Cookie(cookieString);
-		if (!this.validateCookie(newCookie)) {
+
+		const newCookie = new Cookie(originURL, cookieString);
+
+		if (!newCookie.validate()) {
 			return;
 		}
-		this.cookies
-			.filter((cookie) => cookie.key === newCookie.key)
-			.forEach((cookie) => {
-				this.cookies.splice(this.cookies.indexOf(cookie), 1);
-			});
-		this.cookies.push(newCookie);
+
+		for (let i = 0, max = this.cookies.length; i < max; i++) {
+			if (
+				this.cookies[i].key === newCookie.key &&
+				this.cookies[i].originURL.hostname === newCookie.originURL.hostname &&
+				// Cookies with or without values are treated differently in the browser.
+				// Therefore, the cookie should only be replaced if either both has a value or if both has no value.
+				// The cookie value is null if it has no value set.
+				// This is a bit unlogical, so it would be nice with a link to the spec here.
+				typeof this.cookies[i].value === typeof newCookie.value
+			) {
+				this.cookies.splice(i, 1);
+				break;
+			}
+		}
+
+		if (!newCookie.isExpired()) {
+			this.cookies.push(newCookie);
+		}
 	}
 
 	/**
-	 * Get cookie.
+	 * Get cookie string.
 	 *
-	 * @param location Location.
+	 * @param targetURL Target URL.
 	 * @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;
+	public getCookieString(targetURL: URL, fromDocument: boolean): string {
+		let cookieString = '';
+
+		for (const cookie of this.cookies) {
+			if (
+				(!fromDocument || !cookie.httpOnly) &&
+				!cookie.isExpired() &&
+				(!cookie.secure || targetURL.protocol === 'https:') &&
+				(!cookie.domain || targetURL.hostname.endsWith(cookie.domain)) &&
+				(!cookie.path || targetURL.pathname.startsWith(cookie.path)) &&
+				// @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value
+				((cookie.sameSite === CookieSameSiteEnum.none && cookie.secure) ||
+					cookie.originURL.hostname === targetURL.hostname)
+			) {
+				if (cookieString) {
+					cookieString += '; ';
+				}
+				cookieString += cookie.toString();
 			}
-			// TODO: Check same site behaviour.
-			return true;
-		});
-		return cookies.map((cookie) => cookie.cookieString()).join('; ');
+		}
+
+		return cookieString;
 	}
 }

package/src/cookie/CookieSameSiteEnum.ts

@@ -0,0 +1,6 @@
+enum CookieSameSiteEnum {
+	strict = 'Strict',
+	lax = 'Lax',
+	none = 'None'
+}
+export default CookieSameSiteEnum;

package/src/fetch/Fetch.ts

@@ -16,6 +16,7 @@ import { Socket } from 'net';
 import Stream from 'stream';
 import DataURIParser from './data-uri/DataURIParser';
 import FetchCORSUtility from './utilities/FetchCORSUtility';
+import CookieJar from '../cookie/CookieJar';
 
 const SUPPORTED_SCHEMAS = ['data:', 'http:', 'https:'];
 const REDIRECT_STATUS_CODES = [301, 302, 303, 307, 308];
@@ -557,7 +558,10 @@ export default class Fetch {
 			this.request.credentials === 'include' ||
 			(this.request.credentials === 'same-origin' && !isCORS)
 		) {
-			const cookie = document.defaultView.document.cookie;
+			const cookie = document.defaultView.document._cookie.getCookieString(
+				this.ownerDocument.defaultView.location,
+				false
+			);
 			if (cookie) {
 				headers.set('Cookie', cookie);
 			}
@@ -614,13 +618,7 @@ export default class Fetch {
 				// Handles setting cookie headers to the document.
 				// "set-cookie" and "set-cookie2" are not allowed in response headers according to spec.
 				if (lowerKey === 'set-cookie' || lowerKey === 'set-cookie2') {
-					const isCORS = FetchCORSUtility.isCORS(this.ownerDocument.location, this.request._url);
-					if (
-						this.request.credentials === 'include' ||
-						(this.request.credentials === 'same-origin' && !isCORS)
-					) {
-						this.ownerDocument.cookie = header;
-					}
+					(<CookieJar>this.ownerDocument['_cookie']).addCookieString(this.request._url, header);
 				} else {
 					headers.append(key, header);
 				}

package/src/nodes/document/Document.ts

@@ -290,7 +290,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Cookie.
 	 */
 	public get cookie(): string {
-		return this._cookie.getCookiesString(this.defaultView.location, true);
+		return this._cookie.getCookieString(this.defaultView.location, true);
 	}
 
 	/**
@@ -299,7 +299,7 @@ export default class Document extends Node implements IDocument {
 	 * @param cookie Cookie string.
 	 */
 	public set cookie(cookie: string) {
-		this._cookie.setCookiesString(cookie);
+		this._cookie.addCookieString(this.defaultView.location, cookie);
 	}
 
 	/**

package/src/nodes/element/Dataset.ts

@@ -0,0 +1,105 @@
+import Element from '../element/Element';
+
+/**
+ * Storage type for a dataset proxy.
+ */
+type DatasetRecord = Record<string, string>;
+
+/**
+ * Dataset helper proxy.
+ *
+ * Reference:
+ * https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset
+ */
+export default class Dataset {
+	public readonly proxy: DatasetRecord;
+
+	/**
+	 * @param element The parent element.
+	 */
+	constructor(element: Element) {
+		// Build the initial dataset record from all data attributes.
+		const dataset: DatasetRecord = {};
+		const attributes = element._attributes;
+		for (const name of Object.keys(attributes)) {
+			if (name.startsWith('data-')) {
+				const key = Dataset.kebabToCamelCase(name.replace('data-', ''));
+				dataset[key] = attributes[name].value;
+			}
+		}
+
+		// Documentation for Proxy:
+		// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
+		this.proxy = new Proxy(dataset, {
+			get(dataset: DatasetRecord, key: string): string {
+				const name = 'data-' + Dataset.camelCaseToKebab(key);
+				if (name in attributes) {
+					return (dataset[key] = attributes[name].value);
+				}
+				delete dataset[key];
+				return undefined;
+			},
+			set(dataset: DatasetRecord, key: string, value: string): boolean {
+				element.setAttribute('data-' + Dataset.camelCaseToKebab(key), value);
+				dataset[key] = value;
+				return true;
+			},
+			deleteProperty(dataset: DatasetRecord, key: string): boolean {
+				const name = 'data-' + Dataset.camelCaseToKebab(key);
+				const result1 = delete attributes[name];
+				const result2 = delete dataset[key];
+				return result1 && result2;
+			},
+			ownKeys(dataset: DatasetRecord): string[] {
+				// According to Mozilla we have to update the dataset object (target) to contain the same keys as what we return:
+				// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy/Proxy/ownKeys
+				// "The result List must contain the keys of all non-configurable own properties of the target object."
+				const keys = [];
+				const deleteKeys = [];
+				for (const name of Object.keys(attributes)) {
+					if (name.startsWith('data-')) {
+						const key = Dataset.kebabToCamelCase(name.replace('data-', ''));
+						keys.push(key);
+						dataset[key] = attributes[name].value;
+						if (!dataset[key]) {
+							deleteKeys.push(key);
+						}
+					}
+				}
+				for (const key of deleteKeys) {
+					delete dataset[key];
+				}
+				return keys;
+			},
+			has(_dataset: DatasetRecord, key: string): boolean {
+				return !!attributes['data-' + Dataset.camelCaseToKebab(key)];
+			}
+		});
+	}
+
+	/**
+	 * Transforms a kebab cased string to camel case.
+	 *
+	 * @param text Text string.
+	 * @returns Camel cased string.
+	 */
+	public static kebabToCamelCase(text: string): string {
+		const parts = text.split('-');
+		for (let i = 0, max = parts.length; i < max; i++) {
+			parts[i] = i > 0 ? parts[i].charAt(0).toUpperCase() + parts[i].slice(1) : parts[i];
+		}
+		return parts.join('');
+	}
+
+	/**
+	 * Transforms a camel cased string to kebab case.
+	 *
+	 * @param text Text string.
+	 * @returns Kebab cased string.
+	 */
+	public static camelCaseToKebab(text: string): string {
+		return text
+			.toString()
+			.replace(/[A-Z]+(?![a-z])|[A-Z]/g, ($, ofs) => (ofs ? '-' : '') + $.toLowerCase());
+	}
+}

package/src/nodes/html-element/HTMLElement.ts

@@ -4,7 +4,7 @@ import CSSStyleDeclaration from '../../css/declaration/CSSStyleDeclaration';
 import IAttr from '../attr/IAttr';
 import FocusEvent from '../../event/events/FocusEvent';
 import PointerEvent from '../../event/events/PointerEvent';
-import DatasetUtility from './DatasetUtility';
+import Dataset from '../element/Dataset';
 import NodeTypeEnum from '../node/NodeTypeEnum';
 import DOMException from '../../exception/DOMException';
 import Event from '../../event/Event';
@@ -28,7 +28,7 @@ export default class HTMLElement extends Element implements IHTMLElement {
 	public readonly clientWidth = 0;
 
 	private _style: CSSStyleDeclaration = null;
-	private _dataset: { [key: string]: string } = null;
+	private _dataset: Dataset = null;
 
 	// Events
 	public oncopy: (event: Event) => void | null = null;
@@ -216,72 +216,7 @@ export default class HTMLElement extends Element implements IHTMLElement {
 	 * @returns Data set.
 	 */
 	public get dataset(): { [key: string]: string } {
-		if (this._dataset) {
-			return this._dataset;
-		}
-
-		const dataset: { [key: string]: string } = {};
-		const attributes = this._attributes;
-
-		for (const name of Object.keys(attributes)) {
-			if (name.startsWith('data-')) {
-				const key = DatasetUtility.kebabToCamelCase(name.replace('data-', ''));
-				dataset[key] = attributes[name].value;
-			}
-		}
-
-		// Documentation for Proxy:
-		// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
-		this._dataset = new Proxy(dataset, {
-			get: (dataset: { [key: string]: string }, key: string): string => {
-				const name = 'data-' + DatasetUtility.camelCaseToKebab(key);
-				if (this._attributes[name]) {
-					dataset[key] = this._attributes[name].value;
-					return this._attributes[name].value;
-				}
-				if (dataset[key] !== undefined) {
-					delete dataset[key];
-				}
-				return undefined;
-			},
-			set: (dataset: { [key: string]: string }, key: string, value: string): boolean => {
-				this.setAttribute('data-' + DatasetUtility.camelCaseToKebab(key), value);
-				dataset[key] = value;
-				return true;
-			},
-			deleteProperty: (dataset: { [key: string]: string }, key: string) => {
-				const name = 'data-' + DatasetUtility.camelCaseToKebab(key);
-				const result1 = delete attributes[name];
-				const result2 = delete dataset[key];
-				return result1 && result2;
-			},
-			ownKeys: (dataset: { [key: string]: string }) => {
-				// According to Mozilla we have to update the dataset object (target) to contain the same keys as what we return:
-				// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy/Proxy/ownKeys
-				// "The result List must contain the keys of all non-configurable own properties of the target object."
-				const keys = [];
-				const deleteKeys = [];
-				for (const name of Object.keys(attributes)) {
-					if (name.startsWith('data-')) {
-						const key = DatasetUtility.kebabToCamelCase(name.replace('data-', ''));
-						keys.push(key);
-						dataset[key] = attributes[name].value;
-						if (!dataset[key]) {
-							deleteKeys.push(key);
-						}
-					}
-				}
-				for (const key of deleteKeys) {
-					delete dataset[key];
-				}
-				return keys;
-			},
-			has: (_dataset: { [key: string]: string }, key: string) => {
-				return !!attributes['data-' + DatasetUtility.camelCaseToKebab(key)];
-			}
-		});
-
-		return this._dataset;
+		return (this._dataset ??= new Dataset(this)).proxy;
 	}
 
 	/**

package/src/nodes/svg-element/SVGElement.ts

@@ -4,6 +4,7 @@ import ISVGElement from './ISVGElement';
 import ISVGSVGElement from './ISVGSVGElement';
 import IAttr from '../attr/IAttr';
 import Event from '../../event/Event';
+import Dataset from '../element/Dataset';
 
 /**
  * SVG Element.
@@ -21,6 +22,7 @@ export default class SVGElement extends Element implements ISVGElement {
 	public onunload: (event: Event) => void | null = null;
 
 	private _style: CSSStyleDeclaration = null;
+	private _dataset: Dataset = null;
 
 	/**
 	 * Returns viewport.
@@ -54,13 +56,7 @@ export default class SVGElement extends Element implements ISVGElement {
 	 * @returns Data set.
 	 */
 	public get dataset(): { [key: string]: string } {
-		const dataset = {};
-		for (const name of Object.keys(this._attributes)) {
-			if (name.startsWith('data-')) {
-				dataset[name.replace('data-', '')] = this._attributes[name].value;
-			}
-		}
-		return dataset;
+		return (this._dataset ??= new Dataset(this)).proxy;
 	}
 
 	/**

package/src/xml-http-request/XMLHttpRequest.ts

@@ -558,7 +558,7 @@ export default class XMLHttpRequest extends XMLHttpRequestEventTarget {
 			accept: '*/*',
 			referer: location.href,
 			'user-agent': navigator.userAgent,
-			cookie: document.cookie
+			cookie: document._cookie.getCookieString(location, false)
 		};
 	}
 
@@ -973,13 +973,17 @@ export default class XMLHttpRequest extends XMLHttpRequestEventTarget {
 	 * @param headers String array.
 	 */
 	private _setCookies(headers: string[] | HTTP.IncomingHttpHeaders): void {
+		const originURL = new URL(this._settings.url, this._ownerDocument.defaultView.location);
 		for (const header of ['set-cookie', 'set-cookie2']) {
 			if (Array.isArray(headers[header])) {
 				for (const cookie of headers[header]) {
-					this._ownerDocument.defaultView.document._cookie.setCookiesString(cookie);
+					this._ownerDocument.defaultView.document._cookie.addCookieString(originURL, cookie);
 				}
 			} else if (headers[header]) {
-				this._ownerDocument.defaultView.document._cookie.setCookiesString(headers[header]);
+				this._ownerDocument.defaultView.document._cookie.addCookieString(
+					originURL,
+					headers[header]
+				);
 			}
 		}
 	}

package/lib/nodes/html-element/DatasetUtility.d.ts

@@ -1,20 +0,0 @@
-/**
- * Dataset utility.
- */
-export default class DatasetUtility {
-    /**
-     * Transforms a kebab cased string to camel case.
-     *
-     * @param text Text string.
-     * @returns Camel cased string.
-     */
-    static kebabToCamelCase(text: string): string;
-    /**
-     * Transforms a camel cased string to kebab case.
-     *
-     * @param text Text string.
-     * @returns Kebab cased string.
-     */
-    static camelCaseToKebab(text: string): string;
-}
-//# sourceMappingURL=DatasetUtility.d.ts.map

package/lib/nodes/html-element/DatasetUtility.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DatasetUtility.d.ts","sourceRoot":"","sources":["../../../src/nodes/html-element/DatasetUtility.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAClC;;;;;OAKG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQpD;;;;;OAKG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAKpD"}