1708633 - Add port forwarding for the Remote Agent when testing mobile builds on Android

Status: RESOLVED FIXED

(Testing :: geckodriver, enhancement, P2)

Description

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Port forwarding only works for Marionette at the moment. But to easily use the Remote Agent on Android its port also needs to be reachable by the host machine.

A simple call like device.forward_port(host_port, AGENT_PORT)?; would be enough similar to how we set it for Marionette:

https://searchfox.org/mozilla-central/source/testing/geckodriver/src/android.rs#159

Also in the drop handler we will have to remove the forward.

The port will announced in the webSocketUrl capability, which is BiDi conformant, or via moz:debuggerAddress that is used for allowing CDP access. And if one of those is set the forward has to be created, whereby webSocketUrl has precedence.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Before implementing the forward it would be good to have the WebSocket support landed in Remote Protocol.

Comment 2

[Henrik Skupin [:whimboo][⌚️UTC+2]]

It would still be good to have it as part of the 0.30 release of geckodriver. When working on it we should clearly also update the moz:debuggerAddress capability, which would need the exact same forwarding.

Comment 3

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Here some updates of the latest state: Setting up the port forwarding is actually easy, but there is a problem with the HTTP host header, which is not rewritten for the port changes. That results in httpd.js bailing out because it runs on a different port on the device. I tried to find some resources in how to get adb to also update HTTP headers, but as it looks like that level of the TCP stack is not supported.

As such the easiest solution here should be to have the same port used on the host machine and the device / emulator. We could try to find a free port on both devices, or support a new command line argument like --websocket-port to allow consumers to specify a port to use. If not set we could default to 9222. By having such an argument we might also have to move the --remote-debugging-port argument handling out of capabilities, and pass capabiities to the AndroidHandler.

James, what do you think?

Comment 4

[Henrik Skupin [:whimboo][⌚️UTC+2]]

As discussed with James on Elements we will use the --websocket-port approach for now. That means some refactoring is required because the firefox arguments can no longer be set in capabilities.rs. Further we also have to take the moz:debuggerAddress capability into account for it.

Comment 5

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Attachment: Bug 1708633 - [geckodriver] Forward WebSocket connection for Firefox on Android.

Depends on D120380

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ff1c62fc3f13
[geckodriver] Forward WebSocket connection for Firefox on Android. r=webdriver-reviewers,jgraham

Comment 7

[Atila Butkovits]

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