1850682 - Add a base RootBiDiModule class

Status: RESOLVED FIXED

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

Description

[Julian Descottes [:jdescottes]]

Similar to the WindowGlobalBiDiModule, we could create a base class for all webdriver-bidi root modules.

One of the APIs which could live there is hasListener or isListeningForEvent, which would be a shortcut for

this.messageHandler.eventsDispatcher.hasListener(eventName, contextInfo);

Comment 1

[Dan]

Hi, is this still up for grap. I will like to work on the issue.

Comment 2

[Julian Descottes [:jdescottes]]

(In reply to Dan from comment #1)

Hi, is this still up for grap. I will like to work on the issue.

Hi Dan! Yes sure this is still available.

The goal is to create a new base class similar to WindowGlobalBiDiModule, but called RootBiDiModule. You can create it under remote/webdriver-bidi/modules/ as well. Make sure to register it in the corresponding jar.mn.

We have other bugs to add more methods to this RootBidiModule class, but you can still start with the hasListener method suggested above.
Now one thing to note is that we need to be careful with public methods on BiDi modules, because they all become part of the API exposed to WebDriver clients. We need to prefix it with _ to avoid this, so please name it _hasListener.

Then all the modules under remote/webdriver-bidi/modules/root should extend this new class. And the network module can start using the new _hasListener method.

The bug will automatically be assigned to you when you submit a patch, you can take a look at the doc at https://firefox-source-docs.mozilla.org/setup/index.html to get started, and don't hesitate to ask here or on matrix if you have any question.

Comment 3

[Dan]

Yeah, thanks for the response @(In reply to Julian Descottes [:jdescottes] from comment #2)

(In reply to Dan from comment #1)

Hi, is this still up for grap. I will like to work on the issue.

Hi Dan! Yes sure this is still available.

The goal is to create a new base class similar to WindowGlobalBiDiModule, but called RootBiDiModule. You can create it under remote/webdriver-bidi/modules/ as well. Make sure to register it in the corresponding jar.mn.

We have other bugs to add more methods to this RootBidiModule class, but you can still start with the hasListener method suggested above.
Now one thing to note is that we need to be careful with public methods on BiDi modules, because they all become part of the API exposed to WebDriver clients. We need to prefix it with _ to avoid this, so please name it _hasListener.

Then all the modules under remote/webdriver-bidi/modules/root should extend this new class. And the network module can start using the new _hasListener method.

The bug will automatically be assigned to you when you submit a patch, you can take a look at the doc at https://firefox-source-docs.mozilla.org/setup/index.html to get started, and don't hesitate to ask here or on matrix if you have any question.

Thanks for the response.

Comment 4

[Dan]

Attachment: WIP: Bug 1850682 - Add a base RootBiDiModule class - 'Julian Descottes'

Comment 5

[Dan]

Attachment: Bug 1850682 - Add a base RootBiDiModule class

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a3e21ef9974f
Add a base RootBiDiModule class r=webdriver-reviewers,jdescottes

Comment 7

[pstanciu]

https://hg.mozilla.org/mozilla-central/rev/a3e21ef9974f