fix(jsdom): reuse abort signals if possible (#9090)

Author: sheremet-va

packages/vitest/src/integrations/env/jsdom.ts

@@ -307,10 +307,22 @@ function createCompatUtils(window: DOMWindow): CompatUtils {
 }
 
 function patchAddEventListener(window: DOMWindow) {
+  const abortControllers = new WeakMap<AbortSignal, AbortController>()
   const JSDOMAbortSignal = window.AbortSignal
   const JSDOMAbortController = window.AbortController
   const originalAddEventListener = window.EventTarget.prototype.addEventListener
 
+  function getJsdomAbortController(signal: AbortSignal) {
+    if (!abortControllers.has(signal)) {
+      const jsdomAbortController = new JSDOMAbortController()
+      signal.addEventListener('abort', () => {
+        jsdomAbortController.abort(signal.reason)
+      })
+      abortControllers.set(signal, jsdomAbortController)
+    }
+    return abortControllers.get(signal)!
+  }
+
   window.EventTarget.prototype.addEventListener = function addEventListener(
     type: string,
     callback: EventListenerOrEventListenerObject | null,
@@ -328,10 +340,7 @@ function patchAddEventListener(window: DOMWindow) {
 
         // use jsdom-native abort controller instead and forward the
         // previous one with `addEventListener`
-        const jsdomAbortController = new JSDOMAbortController()
-        signal.addEventListener('abort', () => {
-          jsdomAbortController.abort(signal.reason)
-        })
+        const jsdomAbortController = getJsdomAbortController(signal)
 
         jsdomCompatOptions.signal = jsdomAbortController.signal
         return originalAddEventListener.call(this, type, callback, jsdomCompatOptions)

test/core/test/environments/jsdom.spec.ts

@@ -1,5 +1,6 @@
 // @vitest-environment jsdom
 
+import { setMaxListeners } from 'node:events'
 import { stripVTControlCharacters } from 'node:util'
 import { processError } from '@vitest/utils/error'
 import { describe, expect, test, vi } from 'vitest'
@@ -203,6 +204,28 @@ test('DOM APIs accept AbortController', () => {
   expect(spy).toHaveBeenCalledTimes(1)
 })
 
+test('can pass down the same abort signal many times without a warning', ({ onTestFinished }) => {
+  const controller = new AbortController()
+  const signal = controller.signal
+  setMaxListeners(5, signal)
+
+  const emitWarning = vi.spyOn(process, 'emitWarning').mockImplementation(() => {})
+  onTestFinished(() => emitWarning.mockRestore())
+
+  const element = document.createElement('div')
+  document.body.append(element)
+
+  for (let i = 0; i < 20; i++) {
+    element.addEventListener('click', () => {}, {
+      signal,
+    })
+  }
+
+  expect(emitWarning).not.toHaveBeenCalledWith(expect.objectContaining({
+    message: expect.stringContaining('Possible EventTarget memory leak detected.'),
+  }))
+})
+
 test('atob and btoa are available', () => {
   expect(atob('aGVsbG8gd29ybGQ=')).toBe('hello world')
   expect(btoa('hello world')).toBe('aGVsbG8gd29ybGQ=')