Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions packages/taro-runtime/src/dom/event-target.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 始终是同一个函数
Expand All @@ -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
Expand Down
141 changes: 141 additions & 0 deletions packages/taro-runtime/tests/event-once.spec.ts
Original file line number Diff line number Diff line change
@@ -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)
})
})
Loading