Skip to content

Commit

Permalink
Bug 1867556 [wpt PR 43455] - DOM: Observable EventTarget integration …
Browse files Browse the repository at this point in the history
…1/N, a=testonly

Automatic update from web-platform-tests
DOM: Observable EventTarget integration 1/N

This CL implements "limited" and "leaky" EventTarget integration with
the Observable API. See below for what "limited" and "leaky" mean.
Concretely, this involves introducing the `on()` method to the
EventTarget interface, so that all EventTargets can return Observables
that listen for events. This is the part that really makes Observables a
"better addEventListener()".

This is the first instance of a natively-constructed Observable, as
opposed to a JS-constructed Observable. This means the subscription
callback passed to the Observable constructor is not just a JS callback
function with user-defined code, but instead is a C++ delegate class,
called `SubscribeDelegate` which has its first concrete implementation
provided by EventTarget (in event_target.cc). The concrete
implementation of this interface that this CL introduces, adds an event
listener to the given EventTarget, upon subscription. The events are
forwarded to the Subscriber's `next()` method. This is what unlocks
more ergonomic event handling with the composable Observable primitive
and all of its (coming) operators.

1. The EventTarget integration is considered "limited" because we do not
support any of the `AddEventListenerOptions` yet, as of this CL. A
subsequent CL will add support for a more restricted version of the
`AddEventListenerOptions`, called `ObservableEventListenerOptions`,
which does not include a `once` option, or an `AbortSignal`, since
Observable operators and subscription is responsible for managing those
aspects. Concretely, an `ObservableEventListenerOptions` will
resolve to an `AddEventListenerOptionsResolved` accordingly. See:
 - WICG/observable#66
 - WICG/observable#67
 - WICG/observable#65

2. The EventTarget integration is considered "leaky" as of this CL,
because there is currently no way to remove an event listener added by
an EventTarget-vended Observable. This will come in a subsequent CL,
which will pass the test that is currently failing in this CL. See
WICG/observable#75 for discussion about
tying the subscription termination to removing an event listener.
From a technical perspective, this is pretty easy — it involves adding
an abort algorithm to `Subscriber#signal` (which has already been wired
up properly by now!) that removes the given per-Subscription
`ObservableEventListener` NativeEventListener from the associated
EventTarget. That implementation has already been sketched out in
https://crrev.com/c/4262153 and the design doc. It will included in a
follow-up CL, to reduce the complexity of this one.

For WPTs:
Co-authored-by: benbenlesh.com

R=masonfchromium.org

Bug: 1485981
Change-Id: Iafeddb0894b8eed2be1d95c181fc44d7650c0d47
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5073394
Reviewed-by: Mason Freed <masonfchromium.org>
Commit-Queue: Dominic Farolino <domchromium.org>
Cr-Commit-Position: refs/heads/main{#1237501}

--

wpt-commits: aeeea4221bce5c44edeb8adad0296bbd68a4af71
wpt-pr: 43455

UltraBlame original commit: 152cc51982905b4522338a38f9542e691a6a93e3
  • Loading branch information
marco-c committed Dec 16, 2023
1 parent 3fa6f5a commit 3b96217
Show file tree
Hide file tree
Showing 3 changed files with 816 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -615,3 +615,229 @@ document
"
)
;
promise_test
(
async
t
=
>
{
window
.
results
=
[
]
;
const
contentWin
=
await
loadIframeAndReturnContentWindow
(
)
;
contentWin
.
eval
(
const
parentResults
=
parent
.
results
;
const
event_target
=
new
EventTarget
(
)
;
/
/
Set
up
two
event
listeners
both
of
which
will
mutate
|
parentResults
|
:
/
/
1
.
A
traditional
event
listener
/
/
2
.
An
observable
event_target
.
addEventListener
(
'
customevent
'
e
=
>
parentResults
.
push
(
e
)
)
;
const
source
=
event_target
.
on
(
'
customevent
'
)
;
source
.
subscribe
(
e
=
>
parentResults
.
push
(
e
)
)
;
/
/
Detach
the
iframe
and
fire
an
event
at
the
event
target
.
The
parent
will
/
/
confirm
that
the
observable
'
s
next
handler
did
not
get
invoked
because
/
/
the
window
is
detached
.
const
event
=
new
Event
(
'
customevent
'
)
;
window
.
frameElement
.
remove
(
)
;
parentResults
.
push
(
'
detached
'
)
;
event_target
.
dispatchEvent
(
event
)
;
)
;
assert_array_equals
(
results
[
"
detached
"
]
"
Subscribe
callback
is
never
invoked
"
)
;
}
"
Observable
from
EventTarget
does
not
get
notified
for
events
in
detached
documents
"
)
;
Loading

0 comments on commit 3b96217

Please sign in to comment.