15195518464

Committed 22 May 2025 07:48PM CUT coverage: 95.927% (-0.1%) from 96.07%

Build # 15195518464

Build Type

push

github

Committed by

web-flow

Commit Message

Docs: Refine sanitizer documentation (#41434)

Co-authored-by: Julien Déramond <juderamond@gmail.com>

Run Details

664 of 726 branches covered (91.46%)

Branch coverage included in aggregate %.

2021 of 2073 relevant lines covered (97.49%)

339.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.95

/js/src/dom/event-handler.js

/**
 * --------------------------------------------------------------------------
 * Bootstrap dom/event-handler.js
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
 * --------------------------------------------------------------------------
 */

import { getjQuery } from '../util/index.js'

/**
 * Constants
 */

const namespaceRegex = /[^.]*(?=\..*)\.|.*/
const stripNameRegex = /\..*/
const stripUidRegex = /::\d+$/
const eventRegistry = {} // Events storage
let uidEvent = 1
const customEvents = {
  mouseenter: 'mouseover',
  mouseleave: 'mouseout'
}

const nativeEvents = new Set([
  'click',
  'dblclick',
  'mouseup',
  'mousedown',
  'contextmenu',
  'mousewheel',
  'DOMMouseScroll',
  'mouseover',
  'mouseout',
  'mousemove',
  'selectstart',
  'selectend',
  'keydown',
  'keypress',
  'keyup',
  'orientationchange',
  'touchstart',
  'touchmove',
  'touchend',
  'touchcancel',
  'pointerdown',
  'pointermove',
  'pointerup',
  'pointerleave',
  'pointercancel',
  'gesturestart',
  'gesturechange',
  'gestureend',
  'focus',
  'blur',
  'change',
  'reset',
  'select',
  'submit',
  'focusin',
  'focusout',
  'load',
  'unload',
  'beforeunload',
  'resize',
  'move',
  'DOMContentLoaded',
  'readystatechange',
  'error',
  'abort',
  'scroll'
])

/**
 * Private methods
 */

function makeEventUid(element, uid) {
  return (uid && `${uid}::${uidEvent++}`) || element.uidEvent || uidEvent++
}

function getElementEvents(element) {
  const uid = makeEventUid(element)

  element.uidEvent = uid
  eventRegistry[uid] = eventRegistry[uid] || {}

  return eventRegistry[uid]
}

function bootstrapHandler(element, fn) {
  return function handler(event) {
    hydrateObj(event, { delegateTarget: element })

    if (handler.oneOff) {
      EventHandler.off(element, event.type, fn)
    }

    return fn.apply(element, [event])
  }
}

function bootstrapDelegationHandler(element, selector, fn) {
  return function handler(event) {
    const domElements = element.querySelectorAll(selector)

    for (let { target } = event; target && target !== this; target = target.parentNode) {
      for (const domElement of domElements) {
        if (domElement !== target) {
          continue
        }

        hydrateObj(event, { delegateTarget: target })

        if (handler.oneOff) {
          EventHandler.off(element, event.type, selector, fn)
        }

        return fn.apply(target, [event])
      }
    }
  }
}

function findHandler(events, callable, delegationSelector = null) {
  return Object.values(events)
    .find(event => event.callable === callable && event.delegationSelector === delegationSelector)
}

function normalizeParameters(originalTypeEvent, handler, delegationFunction) {
  const isDelegated = typeof handler === 'string'
  // TODO: tooltip passes `false` instead of selector, so we need to check
  const callable = isDelegated ? delegationFunction : (handler || delegationFunction)
  let typeEvent = getTypeEvent(originalTypeEvent)

  if (!nativeEvents.has(typeEvent)) {
    typeEvent = originalTypeEvent
  }

  return [isDelegated, callable, typeEvent]
}

function addHandler(element, originalTypeEvent, handler, delegationFunction, oneOff) {
  if (typeof originalTypeEvent !== 'string' || !element) {
    return
  }

  let [isDelegated, callable, typeEvent] = normalizeParameters(originalTypeEvent, handler, delegationFunction)

  // in case of mouseenter or mouseleave wrap the handler within a function that checks for its DOM position
  // this prevents the handler from being dispatched the same way as mouseover or mouseout does
  if (originalTypeEvent in customEvents) {
    const wrapFunction = fn => {
      return function (event) {
        if (!event.relatedTarget || (event.relatedTarget !== event.delegateTarget && !event.delegateTarget.contains(event.relatedTarget))) {
          return fn.call(this, event)
        }
      }
    }

    callable = wrapFunction(callable)
  }

  const events = getElementEvents(element)
  const handlers = events[typeEvent] || (events[typeEvent] = {})
  const previousFunction = findHandler(handlers, callable, isDelegated ? handler : null)

  if (previousFunction) {
    previousFunction.oneOff = previousFunction.oneOff && oneOff

    return
  }

  const uid = makeEventUid(callable, originalTypeEvent.replace(namespaceRegex, ''))
  const fn = isDelegated ?
    bootstrapDelegationHandler(element, handler, callable) :
    bootstrapHandler(element, callable)

  fn.delegationSelector = isDelegated ? handler : null
  fn.callable = callable
  fn.oneOff = oneOff
  fn.uidEvent = uid
  handlers[uid] = fn

  element.addEventListener(typeEvent, fn, isDelegated)
}

function removeHandler(element, events, typeEvent, handler, delegationSelector) {
  const fn = findHandler(events[typeEvent], handler, delegationSelector)

  if (!fn) {
    return
  }

  element.removeEventListener(typeEvent, fn, Boolean(delegationSelector))
  delete events[typeEvent][fn.uidEvent]
}

function removeNamespacedHandlers(element, events, typeEvent, namespace) {
  const storeElementEvent = events[typeEvent] || {}

  for (const [handlerKey, event] of Object.entries(storeElementEvent)) {
    if (handlerKey.includes(namespace)) {
      removeHandler(element, events, typeEvent, event.callable, event.delegationSelector)
    }
  }
}

function getTypeEvent(event) {
  // allow to get the native events from namespaced events ('click.bs.button' --> 'click')
  event = event.replace(stripNameRegex, '')
  return customEvents[event] || event
}

const EventHandler = {
  on(element, event, handler, delegationFunction) {
    addHandler(element, event, handler, delegationFunction, false)
  },

  one(element, event, handler, delegationFunction) {
    addHandler(element, event, handler, delegationFunction, true)
  },

  off(element, originalTypeEvent, handler, delegationFunction) {
    if (typeof originalTypeEvent !== 'string' || !element) {
      return
    }

    const [isDelegated, callable, typeEvent] = normalizeParameters(originalTypeEvent, handler, delegationFunction)
    const inNamespace = typeEvent !== originalTypeEvent
    const events = getElementEvents(element)
    const storeElementEvent = events[typeEvent] || {}
    const isNamespace = originalTypeEvent.startsWith('.')

    if (typeof callable !== 'undefined') {
      // Simplest case: handler is passed, remove that listener ONLY.
      if (!Object.keys(storeElementEvent).length) {
        return
      }

      removeHandler(element, events, typeEvent, callable, isDelegated ? handler : null)
      return
    }

    if (isNamespace) {
      for (const elementEvent of Object.keys(events)) {
        removeNamespacedHandlers(element, events, elementEvent, originalTypeEvent.slice(1))
      }
    }

    for (const [keyHandlers, event] of Object.entries(storeElementEvent)) {
      const handlerKey = keyHandlers.replace(stripUidRegex, '')

      if (!inNamespace || originalTypeEvent.includes(handlerKey)) {
        removeHandler(element, events, typeEvent, event.callable, event.delegationSelector)
      }
    }
  },

  trigger(element, event, args) {
    if (typeof event !== 'string' || !element) {
      return null
    }

    const $ = getjQuery()
    const typeEvent = getTypeEvent(event)
    const inNamespace = event !== typeEvent

    let jQueryEvent = null
    let bubbles = true
    let nativeDispatch = true
    let defaultPrevented = false

    if (inNamespace && $) {
      jQueryEvent = $.Event(event, args)

      $(element).trigger(jQueryEvent)
      bubbles = !jQueryEvent.isPropagationStopped()
      nativeDispatch = !jQueryEvent.isImmediatePropagationStopped()
      defaultPrevented = jQueryEvent.isDefaultPrevented()
    }

    const evt = hydrateObj(new Event(event, { bubbles, cancelable: true }), args)

    if (defaultPrevented) {
      evt.preventDefault()
    }

    if (nativeDispatch) {
      element.dispatchEvent(evt)
    }

    if (evt.defaultPrevented && jQueryEvent) {
      jQueryEvent.preventDefault()
    }

    return evt
  }
}

function hydrateObj(obj, meta = {}) {
  for (const [key, value] of Object.entries(meta)) {
    try {
      obj[key] = value
    } catch {
      Object.defineProperty(obj, key, {
        configurable: true,
        get() {
          return value
        }
      })
    }
  }

  return obj
}

export default EventHandler

1	/**
2	* --------------------------------------------------------------------------
3	* Bootstrap dom/event-handler.js
4	* Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
5	* --------------------------------------------------------------------------
6	*/
7
8	import { getjQuery } from '../util/index.js'
9
10	/**
11	* Constants
12	*/
13
14	const namespaceRegex = /[^.](?=\..)\.\|.*/	18✔
15	const stripNameRegex = /\..*/	18✔
16	const stripUidRegex = /::\d+$/	18✔
17	const eventRegistry = {} // Events storage	18✔
18	let uidEvent = 1	18✔
19	const customEvents = {	18✔
20	mouseenter: 'mouseover',
21	mouseleave: 'mouseout'
22	}
23
24	const nativeEvents = new Set([	18✔
25	'click',
26	'dblclick',
27	'mouseup',
28	'mousedown',
29	'contextmenu',
30	'mousewheel',
31	'DOMMouseScroll',
32	'mouseover',
33	'mouseout',
34	'mousemove',
35	'selectstart',
36	'selectend',
37	'keydown',
38	'keypress',
39	'keyup',
40	'orientationchange',
41	'touchstart',
42	'touchmove',
43	'touchend',
44	'touchcancel',
45	'pointerdown',
46	'pointermove',
47	'pointerup',
48	'pointerleave',
49	'pointercancel',
50	'gesturestart',
51	'gesturechange',
52	'gestureend',
53	'focus',
54	'blur',
55	'change',
56	'reset',
57	'select',
58	'submit',
59	'focusin',
60	'focusout',
61	'load',
62	'unload',
63	'beforeunload',
64	'resize',
65	'move',
66	'DOMContentLoaded',
67	'readystatechange',
68	'error',
69	'abort',
70	'scroll'
71	])
72
73	/**
74	* Private methods
75	*/
76
77	function makeEventUid(element, uid) {
78	return (uid && `${uid}::${uidEvent++}`) \|\| element.uidEvent \|\| uidEvent++	4,864✔
79	}
80
81	function getElementEvents(element) {
82	const uid = makeEventUid(element)	3,190✔
83
84	element.uidEvent = uid	3,190✔
85	eventRegistry[uid] = eventRegistry[uid] \|\| {}	3,190✔
86
87	return eventRegistry[uid]	3,190✔
88	}
89
90	function bootstrapHandler(element, fn) {
91	return function handler(event) {	1,644✔
92	hydrateObj(event, { delegateTarget: element })	701✔
93
94	if (handler.oneOff) {	701✔
95	EventHandler.off(element, event.type, fn)	21✔
96	}
97
98	return fn.apply(element, [event])	701✔
99	}
100	}
101
102	function bootstrapDelegationHandler(element, selector, fn) {
103	return function handler(event) {	30✔
104	const domElements = element.querySelectorAll(selector)	1,944✔
105
106	for (let { target } = event; target && target !== this; target = target.parentNode) {	1,944✔
107	for (const domElement of domElements) {	9,153✔
108	if (domElement !== target) {	459✔
109	continue	306✔
110	}
111
112	hydrateObj(event, { delegateTarget: target })	153✔
113
114	if (handler.oneOff) {	153✔
115	EventHandler.off(element, event.type, selector, fn)	1✔
116	}
117
118	return fn.apply(target, [event])	153✔
119	}
120	}
121	}
122	}
123
124	function findHandler(events, callable, delegationSelector = null) {	×
125	return Object.values(events)	3,249✔
126	.find(event => event.callable === callable && event.delegationSelector === delegationSelector)	3,258✔
127	}
128
129	function normalizeParameters(originalTypeEvent, handler, delegationFunction) {
130	const isDelegated = typeof handler === 'string'	3,190✔
131	// TODO: tooltip passes `false` instead of selector, so we need to check
132	const callable = isDelegated ? delegationFunction : (handler \|\| delegationFunction)	3,190✔
133	let typeEvent = getTypeEvent(originalTypeEvent)	3,190✔
134
135	if (!nativeEvents.has(typeEvent)) {	3,190✔
136	typeEvent = originalTypeEvent	182✔
137	}
138
139	return [isDelegated, callable, typeEvent]	3,190✔
140	}
141
142	function addHandler(element, originalTypeEvent, handler, delegationFunction, oneOff) {
143	if (typeof originalTypeEvent !== 'string' \|\| !element) {	2,801✔
144	return	112✔
145	}
146
147	let [isDelegated, callable, typeEvent] = normalizeParameters(originalTypeEvent, handler, delegationFunction)	2,689✔
148
149	// in case of mouseenter or mouseleave wrap the handler within a function that checks for its DOM position
150	// this prevents the handler from being dispatched the same way as mouseover or mouseout does
151	if (originalTypeEvent in customEvents) {	2,689✔
152	const wrapFunction = fn => {	5✔
153	return function (event) {	5✔
154	if (!event.relatedTarget \|\| (event.relatedTarget !== event.delegateTarget && !event.delegateTarget.contains(event.relatedTarget))) {	25✔
155	return fn.call(this, event)	9✔
156	}
157	}
158	}
159
160	callable = wrapFunction(callable)	5✔
161	}
162
163	const events = getElementEvents(element)	2,689✔
164	const handlers = events[typeEvent] \|\| (events[typeEvent] = {})	2,689✔
165	const previousFunction = findHandler(handlers, callable, isDelegated ? handler : null)	2,689✔
166
167	if (previousFunction) {	2,689✔
168	previousFunction.oneOff = previousFunction.oneOff && oneOff	1,015!
169
170	return	1,015✔
171	}
172
173	const uid = makeEventUid(callable, originalTypeEvent.replace(namespaceRegex, ''))	1,674✔
174	const fn = isDelegated ?	1,674✔
175	bootstrapDelegationHandler(element, handler, callable) :	1,674✔
176	bootstrapHandler(element, callable)
177
178	fn.delegationSelector = isDelegated ? handler : null	1,674✔
179	fn.callable = callable	1,674✔
180	fn.oneOff = oneOff	1,674✔
181	fn.uidEvent = uid	1,674✔
182	handlers[uid] = fn	1,674✔
183
184	element.addEventListener(typeEvent, fn, isDelegated)	1,674✔
185	}
186
187	function removeHandler(element, events, typeEvent, handler, delegationSelector) {
188	const fn = findHandler(events[typeEvent], handler, delegationSelector)	560✔
189
190	if (!fn) {	560!
191	return	×
192	}
193
194	element.removeEventListener(typeEvent, fn, Boolean(delegationSelector))	560✔
195	delete events[typeEvent][fn.uidEvent]	560✔
196	}
197
198	function removeNamespacedHandlers(element, events, typeEvent, namespace) {
199	const storeElementEvent = events[typeEvent] \|\| {}	304!
200
201	for (const [handlerKey, event] of Object.entries(storeElementEvent)) {	304✔
202	if (handlerKey.includes(namespace)) {	340✔
203	removeHandler(element, events, typeEvent, event.callable, event.delegationSelector)	177✔
204	}
205	}
206	}
207
208	function getTypeEvent(event) {
209	// allow to get the native events from namespaced events ('click.bs.button' --> 'click')
210	event = event.replace(stripNameRegex, '')	12,819✔
211	return customEvents[event] \|\| event	12,819✔
212	}
213
214	const EventHandler = {	18✔
215	on(element, event, handler, delegationFunction) {
216	addHandler(element, event, handler, delegationFunction, false)	2,771✔
217	},
218
219	one(element, event, handler, delegationFunction) {
220	addHandler(element, event, handler, delegationFunction, true)	30✔
221	},
222
223	off(element, originalTypeEvent, handler, delegationFunction) {
224	if (typeof originalTypeEvent !== 'string' \|\| !element) {	509✔
225	return	8✔
226	}
227
228	const [isDelegated, callable, typeEvent] = normalizeParameters(originalTypeEvent, handler, delegationFunction)	501✔
229	const inNamespace = typeEvent !== originalTypeEvent	501✔
230	const events = getElementEvents(element)	501✔
231	const storeElementEvent = events[typeEvent] \|\| {}	501✔
232	const isNamespace = originalTypeEvent.startsWith('.')	501✔
233
234	if (typeof callable !== 'undefined') {	501✔
235	// Simplest case: handler is passed, remove that listener ONLY.
236	if (!Object.keys(storeElementEvent).length) {	346!
237	return	×
238	}
239
240	removeHandler(element, events, typeEvent, callable, isDelegated ? handler : null)	346✔
241	return	346✔
242	}
243
244	if (isNamespace) {	155✔
245	for (const elementEvent of Object.keys(events)) {	116✔
246	removeNamespacedHandlers(element, events, elementEvent, originalTypeEvent.slice(1))	304✔
247	}
248	}
249
250	for (const [keyHandlers, event] of Object.entries(storeElementEvent)) {	155✔
251	const handlerKey = keyHandlers.replace(stripUidRegex, '')	38✔
252
253	if (!inNamespace \|\| originalTypeEvent.includes(handlerKey)) {	38✔
254	removeHandler(element, events, typeEvent, event.callable, event.delegationSelector)	37✔
255	}
256	}
257	},
258
259	trigger(element, event, args) {
260	if (typeof event !== 'string' \|\| !element) {	9,629!
261	return null	×
262	}
263
264	const $ = getjQuery()	9,629✔
265	const typeEvent = getTypeEvent(event)	9,629✔
266	const inNamespace = event !== typeEvent	9,629✔
267
268	let jQueryEvent = null	9,629✔
269	let bubbles = true	9,629✔
270	let nativeDispatch = true	9,629✔
271	let defaultPrevented = false	9,629✔
272
273	if (inNamespace && $) {	9,629!
274	jQueryEvent = $.Event(event, args)	×
275
276	$(element).trigger(jQueryEvent)	×
277	bubbles = !jQueryEvent.isPropagationStopped()	×
278	nativeDispatch = !jQueryEvent.isImmediatePropagationStopped()	×
279	defaultPrevented = jQueryEvent.isDefaultPrevented()	×
280	}
281
282	const evt = hydrateObj(new Event(event, { bubbles, cancelable: true }), args)	9,629✔
283
284	if (defaultPrevented) {	9,629!
285	evt.preventDefault()	×
286	}
287
288	if (nativeDispatch) {	9,629✔
289	element.dispatchEvent(evt)	9,629✔
290	}
291
292	if (evt.defaultPrevented && jQueryEvent) {	9,629!
293	jQueryEvent.preventDefault()	×
294	}
295
296	return evt	9,629✔
297	}
298	}
299
300	function hydrateObj(obj, meta = {}) {	9,146✔
301	for (const [key, value] of Object.entries(meta)) {	10,483✔
302	try {	1,507✔
303	obj[key] = value	1,507✔
304	} catch {
305	Object.defineProperty(obj, key, {	1✔
306	configurable: true,
307	get() {
308	return value	1✔
309	}
310	})
311	}
312	}
313
314	return obj	10,483✔
315	}
316
317	export default EventHandler

twbs / bootstrap / 15195518464

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous