R/RSeleniumTools_remoteDrivers.R

In bedantaguru/fisher: A robotic fisher in making

# Client should be able to change following things in web-browsers
# - Proxy
# - Best known settings for remote access
# - Headless mode (equivalent)
# - Download folder
#  KFL
# - Add-on / plugins (as applicable)
#

rst_remotedriver <- function(
  browser="chrome",
  # Web browser configurations
  # 1.Customized and unified configurations
  # 1.1 Proxy
  proxy = FALSE, proxy_host = "localhost", proxy_port = 8888L,
  # 1.2 Best known settings for remote access
  best_known_settings = TRUE,
  # 1.3 Headless mode (equivalent)
  headless = FALSE,
  # 1.4 Download folder
  download_capture = FALSE, download_folder = ".",
  # 1.5 No password save options or any notification /location etc
  no_frills = TRUE,
  # 2. Additional configuration if required
  browser_config = NULL,
  # 3. Documented Arguments (whichever are configurable)
  remoteServerAddr = "localhost",
  version = "", platform = "ANY", javascript = TRUE,
  # 4. For running without any configurations
  vanilla = FALSE,
  # 5. Pass config as list (which can be used later to call this function)
  get_config_list_only = FALSE,
  # 6. No running only arguments
  no_run_only_args = FALSE,
  # 7. Further argument
  ...
){
  # As per the documentation of remoteDriver-class {RSelenium} Documented
  # objects are remoteDriver is a generator object. To define a new remoteDriver
  # class method 'new' is called. The slots (default value) that are user
  # defined are: remoteServerAddr(localhost), port(4444), browserName(firefox),
  # version(""), platform(ANY), javascript(TRUE). See examples for more
  # information on use.
  #
  # From the code :
  # remoteServerAddr = "localhost",
  # port = 4444,
  # browserName = "firefox",
  # path = "/wd/hub",
  # version = "",
  # platform = "ANY",
  # javascript = TRUE,
  # nativeEvents = TRUE,
  # extraCapabilities = list()
  #
  # Among these only remoteServerAddr, version, platform and javascript is
  # configurable (if wanted) (rest are set by {fisher} or defined alternatively)
  browser <- wap_valid_browser(browser)

  if(get_config_list_only){
    cnfl <- list(browser=browser,
                 proxy = proxy,
                 proxy_host = proxy_host,
                 proxy_port = proxy_port,
                 best_known_settings = best_known_settings,
                 headless = headless,
                 download_capture = download_capture,
                 download_folder = download_folder,
                 no_frills = no_frills,
                 browser_config = browser_config,
                 remoteServerAddr = remoteServerAddr,
                 version = version,
                 platform = platform,
                 javascript = javascript,
                 vanilla = vanilla)
    if(!missing(...)){
      #  not much tested :-)
      cnfl$`...` <- list(...)
    }
    # exit without doing anything else
    return(cnfl)
  }

  if(!exists("s_port", envir = rst_wdman_selenium_info_env)){
    stop("Kindly make sure selenium is running / correctly setup",
         call. = FALSE)
  }

  if(exists("s_handle", envir = rst_wdman_selenium_info_env)){
    if(!rst_wdman_selenium_info_env$s_handle$process$is_alive()){
      stop("Kindly make sure selenium is running (it seems it is stopped)",
           call. = FALSE)
    }
  }else{
    # can not check state of selenium
    # this can be intentional or non-intentional
    cat("\nCan not check state of selenium.\n")
  }

  # soo big name! making small
  rst_wsrcbn <-rst_webdriver_selenium_remote_client_browser_names

  ecaps <- list()

  if(!vanilla){
    # this browser settings
    tbs <- rst_remotedriver_specific_config(
      browser = browser,
      proxy = proxy, proxy_host = proxy_host, proxy_port = proxy_port,
      best_known_settings = best_known_settings,
      headless = headless, download_capture = download_capture,
      download_folder = download_folder,
      no_frills = no_frills)

    ecaps <- tbs

    if(!is.null(browser_config)){
      ecaps <- wap_browser_config_appender(
        browser,
        tbs, browser_config
      )
    }

  }


  if(no_run_only_args){

    list(
      func = RSelenium::remoteDriver,
      args = list(
        remoteServerAddr = remoteServerAddr,
        port = rst_wdman_selenium_info_env$s_port,
        browserName = rst_wsrcbn$browser_name_client[
          rst_wsrcbn$browser_name_short==browser],
        extraCapabilities = ecaps,
        version = version,
        platform = platform,
        javascript = javascript
      )
    )

  }else{

    RSelenium::remoteDriver(
      remoteServerAddr = remoteServerAddr,
      port = rst_wdman_selenium_info_env$s_port,
      browserName = rst_wsrcbn$browser_name_client[
        rst_wsrcbn$browser_name_short==browser],
      extraCapabilities = ecaps,
      version = version,
      platform = platform,
      javascript = javascript,
      ...)

  }

}



rst_remotedriver_check <- function(rd){
  # # detailed
  # msg <- utils::capture.output(
  #   tryCatch(rd$getPageSource(), error = function(e) {
  #     tryCatch(rd$errorDetails()$message, error = function(e) "")
  #   }), type = "message")

  chk <- TRUE

  msg <- utils::capture.output({
    chk <- tryCatch({
      ch <- rd$getPageSource()
      ch <- unlist(ch)
      is.character(ch)
    }, error = function(e) {
      FALSE
    })
  }, type = "message")

  chk2 <- any(grepl("not reachable", tolower(msg)))

  if(!is.logical(chk)){
    chk <- !chk2
  }

  if(length(chk)!=1){
    chk <- !chk2
  }

  chk

}