R/meh.R

In avucoh/DIVE: Data Integration and Visual Exploration

#' Modal Error Handling
#'
#' Bring up a modal dialog for application errors
#'
#' Module code will summon a modal dialog to display an error when execution fails,
#' something is seriously not allowed, etc.
#' This defaults to a generic user-facing message of
#' "Sorry, something went wrong. Try again later or let us know about the issue.",
#' which can be configured through \code{base::options(DIVE.error.modal.mg = altmessage)}.
#' When the \code{dev_mode} option is set, the original error will also be displayed.
#' The footer can optionally contain a link to where the user can file issues, etc.,
#' configured with \code{base::options(DIVE.error.modal.footer = ui)}.
#'
#' @param msg User-facing message that can contain HTML for formatting.
#' @param error Forwarded error messsage to be shown depending on \code{dev_mode} option.
#' @param footer Bottom part of the modal dialog, which by default contains nothing unless
#' set with \code{base::options(DIVE.error.modal.footer = ui)}. See details for intended uses.
meh <- function(msg =  getOption("DIVE.error.modal.msg"),
                error = NULL,
                footer = getOption("DIVE.error.modal.footer")) {
  showModal(modalDialog(
    shiny::HTML(msg),
    if(dev_mode()) paste("Error:", error) else "",
    footer = footer,
    easyClose = TRUE,
    fade = FALSE
  ))
}

#' Get and set app dev mode
#'
#' Control the display of error messages in \code{\link{meh}} and of certain other UI
#'
#' Aside from \code{\link{meh}}, other modules that use this setting are:
#' \itemize{
#'   \item \code{\link{matchResultServer}}: intermediate results are only downloadable in dev mode
#'}
#'
#' @param setting TRUE or FALSE, passed to \code{base::options} \code{DIVE.dev.mode}.
#' @export
dev_mode <- function(setting = NULL) {
  if(is.null(setting)) getOption("DIVE.dev.mode", default = FALSE) else { options(DIVE.dev.mode = setting) }
}