BREAKING CHANGE: [#1154] Makes the types for Happy DOM strict (#1842)

Author: capricorn86

package-lock.json

@@ -33,7 +33,7 @@
 		"semver": "^7.3.5",
 		"turbo": "^1.11.3",
 		"typescript": "^5.8.3",
-		"vitest": "^2.1.9"
+		"vitest": "^3.2.2"
 	},
 	"happyLintChanged": {
 		"rules": [

package.json

@@ -76,12 +76,10 @@
 		"test:bun": "bun test ./test/bun/Bun.test.js"
 	},
 	"dependencies": {
-		"happy-dom": "^0.0.0"
+		"happy-dom": "^0.0.0",
+		"@types/node": "^20.0.0"
 	},
 	"devDependencies": {
-		"@typescript-eslint/eslint-plugin": "^5.16.0",
-		"@typescript-eslint/parser": "^5.16.0",
-		"@types/node": "^20.0.0",
 		"typescript": "^5.8.3",
 		"lit": "^3.3.0",
 		"react": "^18.2.0",

packages/global-registrator/package.json

@@ -7,7 +7,7 @@ const IGNORE_LIST = ['constructor', 'undefined', 'NaN', 'global', 'globalThis'];
  *
  */
 export default class GlobalRegistrator {
-	static #registered: { [key: string | symbol]: PropertyDescriptor } | null = null;
+	static #registered: { [key: string | symbol]: PropertyDescriptor | null } | null = null;
 
 	/**
 	 * Returns the registered state.
@@ -57,7 +57,7 @@ export default class GlobalRegistrator {
 
 					// If the property is the window object, replace it with the global object
 					if (windowPropertyDescriptor.value === window) {
-						window[key] = globalThis;
+						(<any>window)[key] = globalThis;
 						windowPropertyDescriptor.value = globalThis;
 					}
 
@@ -77,9 +77,9 @@ export default class GlobalRegistrator {
 			this.#registered[key] = null;
 
 			// If the property is the window object, replace it with the global object
-			if (propertyDescriptor.value === window) {
-				window[key] = globalThis;
-				propertyDescriptor.value = globalThis;
+			if (propertyDescriptor!.value === window) {
+				(<any>window)[key] = globalThis;
+				propertyDescriptor!.value = globalThis;
 			}
 
 			Object.defineProperty(globalThis, key, {
@@ -89,7 +89,7 @@ export default class GlobalRegistrator {
 		}
 
 		// Set owner window on document to global
-		globalThis.document[PropertySymbol.defaultView] = globalThis;
+		(<any>globalThis).document[PropertySymbol.defaultView] = globalThis;
 	}
 
 	/**
@@ -102,13 +102,13 @@ export default class GlobalRegistrator {
 			);
 		}
 
-		const happyDOM = globalThis.happyDOM;
+		const happyDOM = (<any>globalThis).happyDOM;
 
 		for (const key of Object.keys(this.#registered)) {
 			if (this.#registered[key] !== null) {
 				Object.defineProperty(globalThis, key, this.#registered[key]);
 			} else {
-				delete globalThis[key];
+				delete (<any>globalThis)[key];
 			}
 		}
 

packages/global-registrator/src/GlobalRegistrator.ts

@@ -13,8 +13,11 @@
 		"resolveJsonModule": true,
 		"noUnusedLocals": true,
 		"noUnusedParameters": true,
-		"removeComments": false,
+        "noImplicitReturns": false,
+        "noImplicitAny" : true,
+        "removeComments": false,
 		"preserveConstEnums": true,
+        "strict": true,
 		"sourceMap": true,
 		"skipLibCheck": true,
 		"baseUrl": ".",

packages/global-registrator/tsconfig.json

@@ -77,15 +77,15 @@
 		"test:debug": "vitest run --inspect-brk --no-file-parallelism"
 	},
 	"dependencies": {
-		"webidl-conversions": "^7.0.0",
-		"whatwg-mimetype": "^3.0.0"
+		"whatwg-mimetype": "^3.0.0",
+		"@types/whatwg-mimetype": "^3.0.2",
+		"@types/node": "^20.0.0"
 	},
 	"devDependencies": {
-		"@types/node": "^20.0.0",
-		"@vitest/ui": "^2.1.4",
+		"@vitest/ui": "^3.2.3",
 		"@webref/css": "6.6.2",
 		"typescript": "^5.8.3",
-		"vitest": "^2.1.9"
+		"vitest": "^3.2.2"
 	},
 	"engines": {
 		"node": ">=20.0.0"

packages/happy-dom/package.json

@@ -24,8 +24,8 @@ export default class AsyncTaskManager {
 	}> = [];
 	private aborted = false;
 	private destroyed = false;
+	#debugTimeout: NodeJS.Timeout | null = null;
 	#browserFrame: IBrowserFrame;
-	#debugTimeout: NodeJS.Timeout | null;
 
 	/**
 	 * Constructor.
@@ -89,8 +89,8 @@ export default class AsyncTaskManager {
 			this.waitUntilCompleteTimer = null;
 		}
 		this.runningTimers.push(timerID);
-		if (this.#browserFrame.page?.context?.browser?.settings?.debug?.traceWaitUntilComplete > 0) {
-			this.debugTrace.set(timerID, new Error().stack);
+		if (this.#browserFrame.page.context.browser.settings.debug.traceWaitUntilComplete > 0) {
+			this.debugTrace.set(timerID, new Error().stack!);
 		}
 	}
 
@@ -109,7 +109,7 @@ export default class AsyncTaskManager {
 			this.runningTimers.splice(index, 1);
 			this.resolveWhenComplete();
 		}
-		if (this.#browserFrame.page?.context?.browser?.settings?.debug?.traceWaitUntilComplete > 0) {
+		if (this.#browserFrame.page.context.browser.settings.debug.traceWaitUntilComplete > 0) {
 			this.debugTrace.delete(timerID);
 		}
 	}
@@ -129,8 +129,8 @@ export default class AsyncTaskManager {
 			this.waitUntilCompleteTimer = null;
 		}
 		this.runningImmediates.push(immediateID);
-		if (this.#browserFrame.page?.context?.browser?.settings?.debug?.traceWaitUntilComplete > 0) {
-			this.debugTrace.set(immediateID, new Error().stack);
+		if (this.#browserFrame.page.context.browser.settings.debug.traceWaitUntilComplete > 0) {
+			this.debugTrace.set(immediateID, new Error().stack!);
 		}
 	}
 
@@ -149,7 +149,7 @@ export default class AsyncTaskManager {
 			this.runningImmediates.splice(index, 1);
 			this.resolveWhenComplete();
 		}
-		if (this.#browserFrame.page?.context?.browser?.settings?.debug?.traceWaitUntilComplete > 0) {
+		if (this.#browserFrame.page.context.browser.settings.debug.traceWaitUntilComplete > 0) {
 			this.debugTrace.delete(immediateID);
 		}
 	}
@@ -176,8 +176,8 @@ export default class AsyncTaskManager {
 		const taskID = this.newTaskID();
 		this.runningTasks[taskID] = abortHandler ? abortHandler : () => {};
 		this.runningTaskCount++;
-		if (this.#browserFrame.page?.context?.browser?.settings?.debug?.traceWaitUntilComplete > 0) {
-			this.debugTrace.set(taskID, new Error().stack);
+		if (this.#browserFrame.page.context.browser.settings.debug.traceWaitUntilComplete > 0) {
+			this.debugTrace.set(taskID, new Error().stack!);
 		}
 		return taskID;
 	}
@@ -196,7 +196,7 @@ export default class AsyncTaskManager {
 			this.runningTaskCount--;
 			this.resolveWhenComplete();
 		}
-		if (this.#browserFrame.page?.context?.browser?.settings?.debug?.traceWaitUntilComplete > 0) {
+		if (this.#browserFrame.page.context.browser.settings.debug.traceWaitUntilComplete > 0) {
 			this.debugTrace.delete(taskID);
 		}
 	}
@@ -260,7 +260,7 @@ export default class AsyncTaskManager {
 	 * Applies debugging.
 	 */
 	private applyDebugging(): void {
-		const debug = this.#browserFrame.page?.context?.browser?.settings?.debug;
+		const debug = this.#browserFrame.page.context.browser.settings.debug;
 		if (!debug?.traceWaitUntilComplete || debug.traceWaitUntilComplete < 1) {
 			return;
 		}

packages/happy-dom/src/async-task-manager/AsyncTaskManager.ts

@@ -33,6 +33,15 @@ export default class Browser implements IBrowser {
 		this.contexts = [new BrowserContext(this)];
 	}
 
+	/**
+	 * Returns true if the browser is closed.
+	 *
+	 * @returns True if the browser is closed.
+	 */
+	public get closed(): boolean {
+		return this.contexts.length === 0;
+	}
+
 	/**
 	 * Returns the default context.
 	 *
@@ -49,8 +58,12 @@ export default class Browser implements IBrowser {
 	 * Aborts all ongoing operations and destroys the browser.
 	 */
 	public async close(): Promise<void> {
-		await Promise.all(this.contexts.slice().map((context) => context.close()));
+		if (this.contexts.length === 0) {
+			return;
+		}
+		const contexts = this.contexts;
 		(<BrowserContext[]>this.contexts) = [];
+		await Promise.all(contexts.map((context) => context.close()));
 	}
 
 	/**

packages/happy-dom/src/browser/Browser.ts

@@ -17,6 +17,7 @@ export default class BrowserContext implements IBrowserContext {
 	public readonly cookieContainer: ICookieContainer = new CookieContainer();
 	public readonly responseCache: IResponseCache = new ResponseCache();
 	public readonly preflightResponseCache: IPreflightResponseCache = new PreflightResponseCache();
+	public readonly closed: boolean = false;
 
 	/**
 	 * Constructor.
@@ -31,25 +32,31 @@ export default class BrowserContext implements IBrowserContext {
 	 * Aborts all ongoing operations and destroys the context.
 	 */
 	public async close(): Promise<void> {
-		if (!this.browser) {
+		if (this.closed) {
 			return;
 		}
+
+		if (this.browser.contexts[0] === this) {
+			throw new Error(
+				'Cannot close the default context. Use `browser.close()` to close the browser instead.'
+			);
+		}
+
+		(<boolean>this.closed) = true;
+
 		await Promise.all(this.pages.slice().map((page) => page.close()));
+
 		const browser = this.browser;
 		const index = browser.contexts.indexOf(this);
+
 		if (index !== -1) {
 			browser.contexts.splice(index, 1);
 		}
+
 		(<BrowserPage[]>this.pages) = [];
-		(<Browser | null>this.browser) = null;
-		(<ICookieContainer | null>this.cookieContainer) = null;
+		this.cookieContainer.clearCookies();
 		this.responseCache.clear();
 		this.preflightResponseCache.clear();
-		(<ResponseCache | null>this.responseCache) = null;
-		(<PreflightResponseCache | null>this.preflightResponseCache) = null;
-		if (browser.contexts.length === 0) {
-			browser.close();
-		}
 	}
 
 	/**

packages/happy-dom/src/browser/BrowserContext.ts

@@ -23,7 +23,8 @@ export default class BrowserFrame implements IBrowserFrame {
 	public readonly parentFrame: BrowserFrame | null = null;
 	public readonly page: BrowserPage;
 	public readonly window: BrowserWindow;
-	public [PropertySymbol.asyncTaskManager] = new AsyncTaskManager(this);
+	public readonly closed: boolean = false;
+	public [PropertySymbol.asyncTaskManager]: AsyncTaskManager = new AsyncTaskManager(this);
 	public [PropertySymbol.listeners]: { navigation: Array<() => void> } = { navigation: [] };
 	public [PropertySymbol.openerFrame]: IBrowserFrame | null = null;
 	public [PropertySymbol.openerWindow]: BrowserWindow | CrossOriginBrowserWindow | null = null;