1859328 - Add emitEventForBrowsingContext method to a base RootBiDiModule class

Status: RESOLVED FIXED

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

Description

[Alexandra Borovova [:Sasha]]

A lot of browsingContext events are sent from the parent process and in order to do this we always write the same code:

// This event is emitted from the parent process but for a given browsing
// context. Set the event's contextInfo to the message handler corresponding
// to this browsing context.
const contextInfo = {
  contextId: browsingContextId,
  type: lazy.WindowGlobalMessageHandler.type,
};
this.emitEvent(
   eventName,
   eventPayload,
   contextInfo
 );

This code could me moved to a method in the base RootBiDiModule class. The proposed name of this method is emitBrowsingContextEvent.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+2] (away 10/03 - 10/13)]

Hm, isn't that specific to the browsing context module and a general helper there would be a better place?

Comment 2

[Julian Descottes [:jdescottes]]

(In reply to Henrik Skupin [:whimboo][⌚️UTC+2] from comment #1)

Hm, isn't that specific to the browsing context module and a general helper there would be a better place?

Re-reading the method name I suggested I thought "it's probably misleading", and looks like I was right :)

A better name would probably be emitEventForBrowsingContext. It's basically for any parent process module which needs to emit an event for a specific context. Eg network module can also use it.

Comment 3

[Alexandra Borovova [:Sasha]]

As soon as dependency bug1850682 is fixed, we should set this bug as mentored.

Comment 4

[Dan]

Hi @jdescottes, I will like to work on this next.

Comment 5

[Dan]

Attachment: Bug 1859328 - Add emitEventForBrowsingContext method to a base RootBiDiModule class - 'Julian Descottes'

Comment 6

[Julian Descottes [:jdescottes]]

Thanks for picking this up!

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4295f0e486ca
Add emitEventForBrowsingContext method to a base RootBiDiModule class - 'Julian Descottes' r=webdriver-reviewers,jdescottes

Comment 8

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/4295f0e486ca

Comment 9

[Henrik Skupin [:whimboo][⌚️UTC+2] (away 10/03 - 10/13)]

Great work, Dan! It's fantastic to see us starting to share methods across the different BiDi root module classes. If you're interested in continuing, please let us know or join us on Matrix in the #webdriver channel. This will help us find a suitable next bug for you, if you haven't already found one, and allow you to learn and contribute more. Thanks!