Requests Debugger Tool

Set the environment variables for host and port before initializing the WebDriver

// default port: 9687
System.getProperties().put("http.proxyHost", "localhost");
System.getProperties().put("http.proxyPort", "9687");
// Initialize WebDriver

Set the WebDriver Proxy

// default port: 9687
var driver = new webdriver.Builder()
  .usingServer('https://hub-cloud.browserstack.com/wd/hub')
  .withCapabilities(capabilities)
  .usingWebDriverProxy("http://localhost:9687")
  .build();

• For client bindings 3.10 and above, add this in your test script:

  HttpCommandExecutor commandExecutor = new HttpCommandExecutor(new Uri("https://BROWSERSTACK_USERNAME:BROWSERSTACK_ACCESS_KEY@hub-cloud.browserstack.com/wd/hub/"), TimeSpan.FromSeconds(60));
  commandExecutor.Proxy = new WebProxy("http://localhost:9687", false);
  // add caps, for e.g.
  // ChromeOptions options = new ChromeOptions();
  // options.AddAdditionalCapability("browser", "Chrome",true);
  IWebDriver driver = new RemoteWebDriver(commandExecutor, options.ToCapabilities());
  

• Add these proxy parameters in your project config file (for client bindings till 3.9.1), i.e. app.config

<!--default port: 9687-->
<?xml version="1.0" encoding="utf-8"?>
<configuration>  
  <system.net>  
    <defaultProxy enabled="true">  
      <proxy  
        proxyaddress="http://localhost:9687"  
        bypassonlocal="false"  
      />  
    </defaultProxy>  
  </system.net>  
</configuration>

Environment variables can’t be used since Python doesn’t read from them. It requires modifying the client binding code. Follow the below steps to modify the client binding code:

• Locate the client binding code in your system, that is, search for selenium folder in python/site-packages. Refer the link to search for python modules in your system.
• Navigate to selenium/webdriver/remote/ directory and open remote_connection.py file in your editor.
• Search for the line http = urllib3.PoolManager(timeout=self._timeout) and change it to http = urllib3.ProxyManager('localhost:9687').
• Save the file. Now your test script shall route its requests via the Requests Debugger tool.

Set environment variable in your test script before initializing the WebDriver

# default port: 9687
ENV['http_proxy'] = 'localhost:9687'
# Initialize WebDriver

• It includes the logs of requests being passed via the Requests Debugger tool.
• Example:

TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Request Start] [INFO] POST https://<URL>/wd/hub/status, {"headers":{"......."}}
TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Request End] [INFO] POST https://<URL>/wd/hub/status, {"data":"{\"key\": \"value\"}"}
TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Tool Request - Retries Left: 1] [INFO] POST https://<URL>/wd/hub/status, {"method":"POST","headers":{".......","Proxy-Authorization":"Basic AaBbCcDdEeFfGg==","X-Requests-Debugger":"2::UNIQUE_IDENTIFIER"},"host":"<EXTERNAL_PROXY_URL>","port":"3130","path":"https://<URL>/wd/hub/status","data":"{\"key\": \"value\"}"}
TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Tool Request - Retries Left: 1] [ERROR] POST https://<URL>/wd/hub/status, {"errorMessage":"Error: getaddrinfo ENOTFOUND <EXTERNAL_PROXY_URL> <EXTERNAL_PROXY_URL>:3130"}
TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Tool Request - Retries Left: 0] [ERROR] POST https://<URL>/wd/hub/status, {"errorMessage":"Error: getaddrinfo ENOTFOUND <EXTERNAL_PROXY_URL> <EXTERNAL_PROXY_URL>:3130"}
TIMESTAMP_IN_UTC [#2::UNIQUE_IDENTIFIER] [Response End] [ERROR] POST https://<URL>/wd/hub/status, Status Code: 500, {"message":"Error: getaddrinfo ENOTFOUND <EXTERNAL_PROXY_URL> <EXTERNAL_PROXY_URL>:3130. Request Failed At Requests Debugger","error":"Request Failed At Requests Debugger"}

• It consists logs of all the connectivity checks which are performed in terms of reachability with BrowserStack components, that is, Hub and Rails.
• The report includes HTTP and HTTPS requests to BrowserStack components and their status.
• New checks are appended whenever a request fails.

• It consists of the load and usage stats of user’s CPU while booting up the Requests Debugger tool. It lists down the top 10 processes which were using the highest CPU at that moment. For windows, it only includes the loadPercentage.

• It consists of the memory stats of the user’s machine while booting up the Requests Debugger tool. It includes:
  • Total Memory
  • Free Memory
  • Used Memory
  • Swap Total
  • Swap Free
  • Swap Used

• It consists the list of connections/sockets being established/listening via the user’s machine.
• It also includes the report of ping checks with Hub and Rails.
• New stats are appended whenever a request fails.

• It includes any unexpected errors that occur while using the tool.