From 3e65bd83f81339c1a16cd2dc5a25effd303e5bef Mon Sep 17 00:00:00 2001 From: Jarvis Date: Fri, 30 Oct 2026 16:01:18 +0800 Subject: [PATCH] fix(runtime): correct once listener lifecycle --- packages/taro-runtime/src/dom/event-target.ts | 14 +- .../taro-runtime/tests/event-once.spec.ts | 141 ++++++++++++++++++ 2 files changed, 143 insertions(+), 12 deletions(-) create mode 100644 packages/taro-runtime/tests/event-once.spec.ts diff --git a/packages/taro-runtime/src/dom/event-target.ts b/packages/taro-runtime/src/dom/event-target.ts index 62118077d384..8bdc388ef283 100644 --- a/packages/taro-runtime/src/dom/event-target.ts +++ b/packages/taro-runtime/src/dom/event-target.ts @@ -24,18 +24,6 @@ export class TaroEventTarget { isOnce = Boolean(options.once) } - if (isOnce) { - const wrapper = function () { - handler.apply(this, arguments) // this 指向 Element - this.removeEventListener(type, wrapper) - } - this.addEventListener(type, wrapper, { - ...(options as AddEventListenerOptions), - once: false - }) - return - } - process.env.NODE_ENV !== 'production' && warn(isCapture, 'Taro 暂未实现 event 的 capture 特性。') // 某些框架,如 PReact 有委托的机制,handler 始终是同一个函数 @@ -44,6 +32,8 @@ export class TaroEventTarget { // 因此每次绑定事件都新建一个函数,如果带来了性能问题,可以把这段逻辑抽取到 PReact 插件中。 const oldHandler = handler handler = function () { + // Remove this registration before invoking user code, including reentrant or throwing callbacks. + if (isOnce) this.removeEventListener(type, handler) return oldHandler.apply(this, arguments) // this 指向 Element } ;(handler as any).oldHandler = oldHandler diff --git a/packages/taro-runtime/tests/event-once.spec.ts b/packages/taro-runtime/tests/event-once.spec.ts new file mode 100644 index 000000000000..90c19be1cef4 --- /dev/null +++ b/packages/taro-runtime/tests/event-once.spec.ts @@ -0,0 +1,141 @@ +import { describe, expect, test, vi } from 'vitest' + +import { createEvent, document } from '../src/index' + +describe('DOM once listeners', () => { + test('can be cancelled using the original callback', () => { + const node = document.createElement('div') + const callback = vi.fn() + node.addEventListener('tap', callback, { once: true }) + node.removeEventListener('tap', callback) + node.dispatchEvent(createEvent('tap')) + expect(callback).not.toHaveBeenCalled() + }) + + test('is removed before synchronous reentry', () => { + const node = document.createElement('div') + const callback = vi.fn(() => { + if (callback.mock.calls.length === 1) node.dispatchEvent(createEvent('tap')) + }) + node.addEventListener('tap', callback, { once: true }) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(1) + }) + + test('stays removed when the callback throws', () => { + const node = document.createElement('div') + const error = new Error('callback error') + const callback = vi.fn(() => { throw error }) + node.addEventListener('tap', callback, { once: true }) + expect(() => node.dispatchEvent(createEvent('tap'))).toThrow(error) + expect(() => node.dispatchEvent(createEvent('tap'))).not.toThrow() + expect(callback).toHaveBeenCalledTimes(1) + }) + + test('preserves the listener receiver and event argument', () => { + const node = document.createElement('div') + const event = createEvent('tap') + const callback = vi.fn() + node.addEventListener('tap', callback, { once: true }) + node.dispatchEvent(event) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(1) + expect(callback).toHaveBeenCalledWith(event) + expect(callback.mock.contexts).toEqual([node]) + }) + + test('removes its own registration when a persistent listener uses the same callback', () => { + const node = document.createElement('div') + const callback = vi.fn() + node.addEventListener('tap', callback) + node.addEventListener('tap', callback, { once: true }) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(2) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(3) + node.removeEventListener('tap', callback) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(3) + }) + + test('cancelling a once listener preserves other listeners and event types', () => { + const node = document.createElement('div') + const once = vi.fn() + const persistent = vi.fn() + node.addEventListener('tap', once, { once: true }) + node.addEventListener('tap', persistent) + node.addEventListener('change', once, { once: true }) + node.removeEventListener('tap', once) + node.dispatchEvent(createEvent('tap')) + expect(persistent).toHaveBeenCalledTimes(1) + expect(once).not.toHaveBeenCalled() + node.dispatchEvent(createEvent('change')) + expect(once).toHaveBeenCalledTimes(1) + }) + + test('preserves independent once registrations of the same callback', () => { + const node = document.createElement('div') + const callback = vi.fn() + node.addEventListener('tap', callback, { once: true }) + node.addEventListener('tap', callback, { once: true }) + node.dispatchEvent(createEvent('tap')) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(2) + }) + + test('supports registering the callback again from inside itself', () => { + const node = document.createElement('div') + const callback = vi.fn(() => { + if (callback.mock.calls.length === 1) node.addEventListener('tap', callback, { once: true }) + }) + node.addEventListener('tap', callback, { once: true }) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(1) + node.dispatchEvent(createEvent('tap')) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(2) + }) + + test('normalizes event names for cancellation', () => { + const node = document.createElement('div') + const callback = vi.fn() + node.addEventListener('TAP', callback, { once: true }) + node.removeEventListener('Tap', callback) + node.dispatchEvent(createEvent('tap')) + expect(callback).not.toHaveBeenCalled() + }) + + test('can cancel both regionchange aliases using the original callback', () => { + const node = document.createElement('map') + const callback = vi.fn() + node.addEventListener('regionchange', callback, { once: true }) + node.removeEventListener('regionchange', callback) + node.dispatchEvent(createEvent('begin')) + node.dispatchEvent(createEvent('end')) + expect(callback).not.toHaveBeenCalled() + }) + + test('keeps begin and end once lifetimes independent for regionchange', () => { + const node = document.createElement('map') + const callback = vi.fn() + node.addEventListener('regionchange', callback, { once: true }) + node.dispatchEvent(createEvent('begin')) + node.dispatchEvent(createEvent('begin')) + node.dispatchEvent(createEvent('end')) + node.dispatchEvent(createEvent('end')) + expect(callback).toHaveBeenCalledTimes(2) + expect(callback.mock.calls.map(([event]) => event.type)).toEqual(['begin', 'end']) + }) + + test('preserves persistent listeners when once is false', () => { + const node = document.createElement('div') + const callback = vi.fn() + node.addEventListener('tap', callback, { once: false }) + node.dispatchEvent(createEvent('tap')) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(2) + node.removeEventListener('tap', callback) + node.dispatchEvent(createEvent('tap')) + expect(callback).toHaveBeenCalledTimes(2) + }) +})