R/HomebrewGA.R

In tdsmith/HomebrewGA: Analytics reports for Homebrew

#' Google Analytics processing code for the Homebrew package manager.
#'
#' @docType package
#' @name HomebrewGA
#' @import dplyr
NULL

#' Google Analytics profile ID for the Homebrew profile.
#' @keywords internal
HOMEBREW_PROFILE_ID = "120682403"

.onLoad = function(...) {
  authorize()
}

#' Authorize against the Google Apps API and cache the result.
#'
#' The authorization token is stored during each session in a hidden
#' environment; see help for RGA::authorize for details. Uses a HomebrewGA
#' application ID and secret.
#' @seealso \code{\link[RGA]{authorize}}
#' @export
authorize = function() {
  RGA::authorize(
    cache=path.expand("~/.config/HomebrewGA"),
    client.id="359112247345-q8niiacq2n9h5d5napdhgi01k6oijlou.apps.googleusercontent.com",
    client.secret="_jq5IxkGszRUhHW_hM0hoDzC")
}

#' Generate a cache token for today's analytics results.
todays_cache_token = function() {
  Sys.time() %>% as.POSIXlt(tz="UTC") %>% as.Date %>% as.character
}

private_fetch_install_invocations = function(
  start.date, end.date, cache.token) {
  df = RGA::get_ga(
    profileId=HOMEBREW_PROFILE_ID,
    start.date=start.date,
    end.date=end.date,
    metrics="ga:totalEvents",
    dimensions="ga:date,ga:eventCategory,ga:eventAction,ga:eventLabel",
    sort="-ga:totalEvents",
    filters="ga:eventCategory==install",
    samplingLevel="HIGHER_PRECISION",
    include.empty.rows="FALSE"
  )
  # Fixed more holistically by https://github.com/Homebrew/brew/pull/659
  df$eventAction = stringr::str_replace(df$eventAction, "--c 11", "--c++11")
  df$eventAction = stringr::str_replace(df$eventAction, "gtk 3", "gtk+3")
  df
}

#' Fetch from GA a list and count of unique `install` invocations.
#' @export
fetch_install_invocations = function(start.date="30daysAgo", end.date="yesterday") {
  R.cache::memoizedCall(
    private_fetch_install_invocations,
    start.date=start.date,
    end.date=end.date,
    cache.token=todays_cache_token()
  )
}

private_fetch_build_errors = function(start.date, end.date, cache.token) {
  RGA::get_ga(
    profileId=HOMEBREW_PROFILE_ID,
    start.date=start.date,
    end.date=end.date,
    metrics="ga:totalEvents",
    dimensions="ga:date,ga:eventCategory,ga:eventAction,ga:eventLabel",
    sort="-ga:totalEvents",
    filters="ga:eventCategory==BuildError",
    samplingLevel="HIGHER_PRECISION",
    include.empty.rows="FALSE"
  )
}

#' Fetch from GA a list and count of build failures.
#' @export
fetch_build_errors = function(start.date="30daysAgo", end.date="yesterday") {
  R.cache::memoizedCall(
    private_fetch_build_errors,
    start.date=start.date,
    end.date=end.date,
    cache.token=todays_cache_token()
  )
}

#' Count the number of times each package was installed.
#'
#' Returns a data.frame with columns `package` and `n` counting the absolute
#' number of times each package was installed.
#' @param df Output of `fetch_install_invocations`.
#' @seealso \code{\link{fetch_install_invocations}}
#' @export
popularity_by_package = function(df) {
  invocations = stringr::str_split(df$eventAction, " ")
  df$package = sapply(invocations, function(x) x[[1]])
  df %>% count(package, wt=totalEvents)
}

#' Describes how often a package was installed with a given option.
#'
#' Returns a data.frame with columns `package`, `option`, and `count`.
#' If a package is installed with multiple options, it is counted as an
#' installation for each of the options; grouping by package and summing counts
#' will overestimate the total number of package installations.
#'
#' @param df Output of `fetch_install_invocations`.
#' @seealso \code{\link{fetch_install_invocations}}
#' @export
install_invocations_by_package = function(df) {
  invocations = stringr::str_split(df$eventAction, " ")
  package_names = invocations %>%
    sapply(function(x) x[[1]]) %>%
    unique

  # Create a list of lists for packages and their arguments, to look like:
  # options_by_package[["gd"]][["none"]] = x,
  # options_by_package[["gd"]][["--universal"]] = y, ...
  options_by_package = replicate(length(package_names), list())
  names(options_by_package) = package_names
  for(i in seq_along(invocations)) {
    package_name = invocations[[i]][[1]]
    nargs = length(invocations[[i]])
    if(nargs == 1) {
      options_by_package[[package_name]][["none"]] = df[i, "totalEvents"]
    } else {
      for(j in 2:nargs) {
        arg = invocations[[i]][[j]]
        prior = if(exists(arg, options_by_package[[package_name]])) options_by_package[[package_name]][[arg]] else 0
        options_by_package[[package_name]][[arg]] = prior + df[i, "totalEvents"]
      }
    }
  }

  # Crush into a data.frame
  package_name_col = names(options_by_package) %>%
    sapply(function(x) rep.int(x, length(options_by_package[[x]]))) %>%
    unlist(use.names=FALSE)
  option_col = options_by_package %>% sapply(function(x) names(x)) %>% unlist(use.names=FALSE)
  count_col = options_by_package %>% unlist(use.names=FALSE)
  data.frame(package=package_name_col, option=option_col, count=count_col)
}

#' Normalize macOS version string.
#' @export
normalize_macos_version = function(x) {
  stringr::str_replace(x, ".*(10\\.\\d+(\\.\\d+)?)[^\\d]*", "\\1")
}

#' Extract the major and minor version from a version string.
#' @export
major_minor = function(x) {
  stringr::str_replace(x, "^(\\d+\\.\\d+).*", "\\1")
}