feature: [#1540] Adds support for sending AbortSignal as option to EventTarget.addEventListener (#1739)

Co-authored-by: David Ortner <[email protected]>

Author: karpiuMG

packages/happy-dom/src/event/EventTarget.ts

@@ -45,6 +45,7 @@ export default class EventTarget {
 	 * @param listener Listener.
 	 * @param options An object that specifies characteristics about the event listener.(currently only once)
 	 * @param options.once
+	 * @param options.signal An AbortSignal. The listener will be removed when the given AbortSignal object's abort() method is called.
 	 */
 	public addEventListener(
 		type: string,
@@ -71,6 +72,12 @@ export default class EventTarget {
 
 		listeners.push(listener);
 		listenerOptions.push(options);
+
+		if (options.signal && !options.signal.aborted) {
+			options.signal.addEventListener('abort', () => {
+				this.removeEventListener(type, listener);
+			});
+		}
 	}
 
 	/**

packages/happy-dom/src/event/IEventListenerOptions.ts

@@ -1,8 +1,10 @@
+import AbortSignal from 'src/fetch/AbortSignal.js';
+
 export default interface IEventListenerOptions {
 	once?: boolean;
 
 	// TODO: Not implemented yet.
 	capture?: boolean;
 	passive?: boolean;
-	signal?: unknown;
+	signal?: AbortSignal;
 }

packages/happy-dom/test/fetch/AbortController.test.ts

@@ -1,6 +1,6 @@
 import Event from '../../src/event/Event.js';
 import AbortController from '../../src/fetch/AbortController.js';
-import { describe, it, expect, beforeEach } from 'vitest';
+import { describe, it, expect, beforeEach, vi } from 'vitest';
 import BrowserWindow from '../../src/window/BrowserWindow.js';
 import Window from '../../src/window/Window.js';
 
@@ -26,5 +26,22 @@ describe('AbortController', () => {
 			expect(signal.reason).toBe(reason);
 			expect((<Event>(<unknown>triggeredEvent)).type).toBe('abort');
 		});
+
+		it('Does not trigger abort event listener if the listener signal is aborted', () => {
+			const controller = new window.AbortController();
+			const callbackCtrl = new window.AbortController();
+			const signal = controller.signal;
+			const callbackMock = vi.fn();
+
+			signal.addEventListener('abort', (event: Event) => callbackMock(), {
+				signal: callbackCtrl.signal
+			});
+
+			callbackCtrl.abort();
+			controller.abort();
+
+			expect(signal.aborted).toBe(true);
+			expect(callbackMock).toBeCalledTimes(0);
+		});
 	});
 });