R/ui_elements.R

In Appsilon/shiny.stats: 'Shiny' App Usage Telemetry

#' Function that adds telemetry HTML elements to UI
#'
#' @param id (optional) string with id representing the namespace
#' @return A `shiny.tag` object to be included in the UI of a Shiny app.
#'
#' @export
use_telemetry <- function(id = "") {

  checkmate::assert_string(id, null.ok = TRUE)
  shiny_namespace <- ""
  if (!is.null(id) && !identical(trimws(id), "")) {
    shiny_namespace <- shiny::NS(trimws(id), "")
  }
  # Only inject error script for versions of Shiny that don't yet support `onUnhandledError`
  track_error_script <- if (!("onUnhandledError" %in% ls(getNamespace("shiny")))) {
    shiny::tags$script(
      shiny::HTML(
        glue::glue("
  $(document).on('shiny:error', function(event) {{
    var errorData = {{
      output_id: event.name,
      message: event.error.message,
      type: 'error'
    }};
    Shiny.setInputValue(
      '{shiny_namespace}track_error_telemetry_js',
      errorData,
      {{priority: 'event'}}
    );
  }});
  "
        )
      )
    )
  } else {
    NULL
  }
  shiny::singleton(shiny::tagList(
    shiny::tags$script(
      type = "text/javascript",
      shiny::HTML(paste0("
  $(document).on('shiny:sessioninitialized', function(event) {
    var br_ver = (function(){
      var ua= navigator.userAgent, tem, M;
      M = ua.match(/(opera|chrome|safari|firefox|msie|trident(?=\\/))\\/?\\s*(\\d+)/i) || [];
      if (/trident/i.test(M[1])) {
        tem = /\\brv[ :]+(\\d+)/g.exec(ua) || [];
        return 'IE '+(tem[1] || '');
      }
      if (M[1]=== 'Chrome') {
        tem= ua.match(/\\b(OPR|Edge)\\/(\\d+)/);
        if(tem!= null) return tem.slice(1).join(' ').replace('OPR', 'Opera');
      }
      M = M[2]? [M[1], M[2]]: [navigator.appName, navigator.appVersion, '-?'];
      if((tem= ua.match(/version\\/(\\d+)/i))!= null) M.splice(1, 1, tem[1]);
      return M.join(' ');
    })();
  ", glue::glue("Shiny.setInputValue(\"{shiny_namespace}browser_version\", br_ver);"), "});"))
    ),
    htmltools::htmlDependency(
      name = "js-cookie",
      version = "3.0.5",
      src = "js/js-cookie-v3.0.5",
      package = "shiny.telemetry",
      script = "js.cookie.min.js"
    ),
    htmltools::htmlDependency(
      name = "manage-cookie",
      version = "1.0.0",
      src = "js",
      package = "shiny.telemetry",
      script = "manage-cookies.js"
    ),
    track_error_script
  )
  )
}