R/wait.R

In sixtyfour: Humane Interface to Amazon Web Services

#' wait fxn generator
#' @param fun (function) a function to check status of something;
#' must return a single boolean, e.g., `aws_db_cluster_status` or
#' `aws_db_instance_status`
#' @param message (character) the message to print at the beginning
#' of `cli::cli_progress_bar`
#' @keywords internal
wait_until <- function(fun, message) {
  function(id, sleep = 2, status_target = "available") {
    cli::cli_alert_info(c(
      "Waiting for instance status: {.emph {status_target}}",
      " (to not wait set `wait=FALSE`)"
    ))
    options(cli.spinner = "simpleDots")
    on.exit(options(cli.spinner = NULL), add = TRUE)
    cli::cli_progress_bar(format = "{cli::pb_spin} {message}") # nolint
    is_not_available <- TRUE
    while (is_not_available) {
      status <- fun(id)
      if (status == "not found") break
      cli::cli_progress_update()
      Sys.sleep(sleep)
      if (status == status_target) {
        is_not_available <- FALSE
      }
    }
  }
}

#' Wait for a Redshift cluster to have a certain status
#'
#' @importFrom cli cli_progress_bar cli_progress_update pb_spin
#' @param id (character) an RDS instance identifier, or a Redshift
#' cluster identifier. required
#' @param sleep (integer/numeric) number of seconds to wait between
#' checks of the cluster status (i.e., http requests)
#' @param status_target (character) status to wait for. default: "available"
#' @return nothing, exits if there's an error, or if the while
#' loop completes
#' @keywords internal
wait_for_cluster <- wait_until(
  aws_db_cluster_status,
  "Redshift cluster initializing"
)

#' Wait for an RDS instance to have a certain status
#'
#' @inheritParams wait_for_cluster
#' @return nothing, exits if there's an error, or if the while
#' loop completes
#' @keywords internal
wait_for_instance <- wait_until(
  aws_db_instance_status,
  "RDS instance initializing"
)