Debugging remotely in Chrome within a Selenium grid

Question

Debugging remotely in Chrome within a Selenium grid

Currently, I am managing a selenium-grid setup that consists of multiple chrome instances. The selenium grid is spread across 2 Windows machines with several nodes. The test executions are carried out from a separate machine that connects to the grid. In order to utilize remote debugging functionality, it is necessary for me to establish connections from the executing machine (which can access the session host and the drivers' debugUrl) to the other machines and ultimately the chrome instances.

However, Chrome strictly prohibits any connection that is not local.

I have come across solutions where individuals have used tunneling or port forwarding, but these methods seem suitable only for single instance setups. Operating within a grid environment means I do not have static ports or rules in place for consistent forwarding.

In my specific scenario, the grid is created automatically and is not a continuously running system.

If anyone has any valuable insights on how to resolve this issue, I would greatly appreciate it.

google-chrome selenium google-chrome-devtools selenium-chromedriver selenium-grid2

Answer 1

Answer №1

I came across a solution on my own and wanted to share it. I will provide snippets of code instead of the entire code to give hints, as it can be quite extensive. An experienced developer should find this information sufficient.

To target the correct browser and access its remote-debug websocket, I created a custom servlet for my nodes.

Here is the servlet:

public class DebugServlet extends RegistryBasedServlet

The servlet is registered through node.json like so:

"servlets" :["com.....ui.util.DebugServlet"],

To access the node (on the appropriate machine), I request the selenium session using the following method:

"http://" + hubHost + ":" + hubPort + "/grid/api/testsession?session=" + sessionId

Where the "sessionId" can be obtained from chromedriver.

From the JSON response received, we can extract the node information of the session, particularly the URL.

url = JSONUtil.get(response.getBody(), "proxyId")

Now we can call the servlet of the correct host and provide the WebSocket URL for the browser and any necessary data. For example, adding a default network header for BasicAuth in my case.

url+ "/extra/DebugServlet"

With the header specified in Java (which can also include parameters or other HTTP provided options):

new BasicHeader("BrowserUrl", webSocketDebuggerUrl), new BasicHeader("Name", name),
                new BasicHeader("Value", value)

In the servlet, we extract the data and establish a WebSocket connection to the browser with the given URL to make our calls.

In the servlet:

public static final String networkDebugging = "{\"id\": 1,\"method\": \"Network.enable\",\"params\": {\"maxTotalBufferSize\": 10000000,\"maxResourceBufferSize\": 5000000 }}";

public static final String addHeader = "{\"id\": 2,\"method\": \"Network.setExtraHTTPHeaders\",\"params\": { \"headers\": {\"${key}\": \"${value}\"}}}";


ws.connect();
ws.setAutoFlush(true);
ws.sendText(networkDebugging);

String payload = TemplateUtil.replace(addHeader, name, value);
ws.sendText(payload);

Answer 2

I came across a solution on my own and wanted to share it. I will provide snippets of code instead of the entire code to give hints, as it can be quite extensive. An experienced developer should find this information sufficient.

To target the correct browser and access its remote-debug websocket, I created a custom servlet for my nodes.

Here is the servlet:

public class DebugServlet extends RegistryBasedServlet

The servlet is registered through node.json like so:

"servlets" :["com.....ui.util.DebugServlet"],

To access the node (on the appropriate machine), I request the selenium session using the following method:

"http://" + hubHost + ":" + hubPort + "/grid/api/testsession?session=" + sessionId

Where the "sessionId" can be obtained from chromedriver.

From the JSON response received, we can extract the node information of the session, particularly the URL.

url = JSONUtil.get(response.getBody(), "proxyId")

Now we can call the servlet of the correct host and provide the WebSocket URL for the browser and any necessary data. For example, adding a default network header for BasicAuth in my case.

url+ "/extra/DebugServlet"

With the header specified in Java (which can also include parameters or other HTTP provided options):

new BasicHeader("BrowserUrl", webSocketDebuggerUrl), new BasicHeader("Name", name),
                new BasicHeader("Value", value)

In the servlet, we extract the data and establish a WebSocket connection to the browser with the given URL to make our calls.

In the servlet:

public static final String networkDebugging = "{\"id\": 1,\"method\": \"Network.enable\",\"params\": {\"maxTotalBufferSize\": 10000000,\"maxResourceBufferSize\": 5000000 }}";

public static final String addHeader = "{\"id\": 2,\"method\": \"Network.setExtraHTTPHeaders\",\"params\": { \"headers\": {\"${key}\": \"${value}\"}}}";


ws.connect();
ws.setAutoFlush(true);
ws.sendText(networkDebugging);

String payload = TemplateUtil.replace(addHeader, name, value);
ws.sendText(payload);

Debugging remotely in Chrome within a Selenium grid

Answer №1

Similar questions

I seem to be facing some issues with SkipException in testNG. Can anyone provide guidance on what might be

Refreshing frequency and reattempts when using selenium on a webpage

Are there alternative, more dependable methods for executing a click command on an element in Headless Chrome using Selenium?

Encountering a null pointer exception when attempting to declare a WebElementFacade within a page object

Selenium testing with Python on a React.js frontend results in an outdated error message appearing when attempting to enter text into an input field

adjusting the request process in scrapy

FileDetector feature in Selenium for Java RemoteWebDriver

Extracting information from Trading View with the help of Selenium

Can a string be separated into an array using Selenium IDE?

Discovering text within HTML tags without any separators using PHP and Selenium

I attempted to access the website through selenium using this code, but to my surprise, the site shut down immediately upon opening

We are encountering a 503 error while working with AWS Lambda and Python Selenium

Automating Jenkins interfaces using selenium automation techniques

Incorporating an HTML file into the manifest.json file

When attempting to capture an element screenshot as PNG, a TypeError occurs indicating that the 'bytes' object is not callable

Selenium tips: Tricks to get past Cloudflare's bot protection

My code is encountering the issue of "element click intercepted" when not using WebDriverWait. On the other hand, when utilizing WebDriverWait, the error message states that 'None

Angular4 ChromeDriver Selenium Protractor

Unable to maximize windows in Firefox on Windows and Chrome on macOS

Using selenium, you can easily download a file without needing the direct URL