events: add stop propagation flag to Event.stopImmediatePropagation

mikemadest · targos · commit 96566fc696fa · 2024-05-12T21:21:56.000+02:00
Spec mention stopImmediatePropagation should set both flags: "stop propagation" and "stop immediate propagation". So the second is not supported by Node.js as there is no hierarchy and bubbling, but the flags are both present as well as stopPropagation. It would makes sense to follow specs on that. Refs: https://dom.spec.whatwg.org/#dom-event-stopimmediatepropagation PR-URL: #39463 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
diff --git a/lib/internal/event_target.js b/lib/internal/event_target.js
@@ -168,6 +168,10 @@ class Event {
   stopImmediatePropagation() {
     if (!isEvent(this))
       throw new ERR_INVALID_THIS('Event');
+    // Spec mention "stopImmediatePropagation should set both "stop propagation"
+    // and "stop immediate propagation" flags"
+    // cf: from https://dom.spec.whatwg.org/#dom-event-stopimmediatepropagation
+    this.stopPropagation();
     this[kStop] = true;
   }
 
diff --git a/test/parallel/test-eventtarget.js b/test/parallel/test-eventtarget.js
@@ -345,7 +345,9 @@ let asyncTest = Promise.resolve();
 {
   const target = new EventTarget();
   const event = new Event('foo');
+  strictEqual(event.cancelBubble, false);
   event.stopImmediatePropagation();
+  strictEqual(event.cancelBubble, true);
   target.addEventListener('foo', common.mustNotCall());
   target.dispatchEvent(event);
 }

Original file line number	Diff line number	Diff line change
`@@ -345,7 +345,9 @@ let asyncTest = Promise.resolve();`
`345`	`345`	`{`
`346`	`346`	`const target = new EventTarget();`
`347`	`347`	`const event = new Event('foo');`
	`348`	`+ strictEqual(event.cancelBubble, false);`
`348`	`349`	`event.stopImmediatePropagation();`
	`350`	`+ strictEqual(event.cancelBubble, true);`
`349`	`351`	`target.addEventListener('foo', common.mustNotCall());`
`350`	`352`	`target.dispatchEvent(event);`
`351`	`353`	`}`