1936770 - Implement "script.realmCreated" and "script.realmDestroyed" events for worker realms

Status: RESOLVED FIXED

(Remote Protocol :: WebDriver BiDi, task, P2)

Description

[Julian Descottes [:jdescottes]]

We should emit script.realmCreated events when a worker realm is registered.

This should be handled in a script module in the process layer.

Comment 1

[Julian Descottes [:jdescottes]]

Attachment: Bug 1936770 - [remote] Allow to emit an event for several related contexts

Comment 2

[Julian Descottes [:jdescottes]]

Attachment: Bug 1936770 - [wdspec] Avoid while(true) in worker scripts for bidi tests

Comment 3

[Julian Descottes [:jdescottes]]

Attachment: Bug 1936770 - [bidi] Add script.realmCreated and realmDestroyed events for worker realms

Comment 4

[Julian Descottes [:jdescottes]]

I don't think it makes sense to keep Bug 1936769 as a separate bug, let's handle both events at the same time and let me summarize a bit the status.

First off, with the events, we don't actually end up creating WorkerRealm instances. This will only happen in actual worker modules / message handlers when we start handling script.evaluate.

Then, to correctly support shared and service workers - which can have more than 1 related context - we need to adapt our logic to match several browsing contexts to a single context descriptor. This is actually spelled out in the spec in the event is enabled algorithm which takes an array of navigables as parameter. In order to enable this, a few event-related APIs are modified to support matching several browsing context ids. A dedicated browser mochitest is added to check this.

However at the moment, we don't have a way to retrieve relevant browsing context ids for shared and service workers. For shared workers, this is blocked on Bug 2014206. For service workers I will need to file a follow up, but if DevTools serves as prior art, the way we addressed it at that time was to also retrieve service worker subscriptions, and based on the controlled url guess which browsing contexts are controlled by it.

Based on this I suggest to align with the current wdspec tests we have:

• check that dedicated workers can be received globally / per context / per user context
• check that shared and service workers can be received globally

On the topic of tests, the wdspec tests currently use while(true){} as shared worker script, which seems to prevent Firefox from destroying the worker on navigation. I'm not sure why, but this doesn't like a webdriver issue and it should not be our main test for this feature.

Comment 5

[Julian Descottes [:jdescottes]]

Attachment: Bug 1936770 - [wdspec] Additional tests for script.realmCreated/realmDestroyed for dedicated workers

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/c91fea99a7ea
https://hg.mozilla.org/integration/autoland/rev/754cf8e1faaf
[remote] Allow to emit an event for several related contexts r=Sasha
https://github.com/mozilla-firefox/firefox/commit/84b37bd34e57
https://hg.mozilla.org/integration/autoland/rev/f50aea94abd5
[bidi] Add script.realmCreated and realmDestroyed events for worker realms r=Sasha
https://github.com/mozilla-firefox/firefox/commit/a99c9f69f18d
https://hg.mozilla.org/integration/autoland/rev/62ab06d5607e
[wdspec] Avoid while(true) in worker scripts for bidi tests r=Sasha
https://github.com/mozilla-firefox/firefox/commit/fd70244aa55b
https://hg.mozilla.org/integration/autoland/rev/0e7579a04f41
[wdspec] Additional tests for script.realmCreated/realmDestroyed for dedicated workers r=Sasha

Comment 8

[Web Platform Test Sync Bot [:wpt-sync] (Matrix: #interop:mozilla.org)]

Created web-platform-tests PR https://github.com/web-platform-tests/wpt/pull/57788 for changes under testing/web-platform/tests

Comment 9

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/754cf8e1faaf
https://hg.mozilla.org/mozilla-central/rev/f50aea94abd5
https://hg.mozilla.org/mozilla-central/rev/62ab06d5607e
https://hg.mozilla.org/mozilla-central/rev/0e7579a04f41

Comment 10

[Web Platform Test Sync Bot [:wpt-sync] (Matrix: #interop:mozilla.org)]

Upstream PR merged by moz-wptsync-bot