R/appReset.R

In periscope2: Enterprise Streamlined 'shiny' Application Framework Using 'bs4Dash'

# -------------------------------------
# -- Application Reset Button Module --
# -- Reload Application Session      --
# -------------------------------------

#' appResetButton module UI function
#'
#' Creates a toggle button to reset application session. Upon pressing on the
#'  button, its state is flipped to cancel application reload with application
#'  and console warning messages indicating that the application will be
#'  reloaded.
#'
#'  User can either resume reloading application session or cancel reloading
#'  process which will also generate application and console messages to
#'  indicate reloading status and result.
#'
#'
#' @param id character id for the object
#'
#' @return an html div with prettyToggle button
#'
#' @section Button Features:
#' \itemize{
#'     \item Initial state label is "Application Reset" with warning status
#'     \item Reloading state label is "Cancel Application Reset" with danger
#'           status
#' }
#'
#'
#' @section Shiny Usage:
#' Call this function at any place in UI section.
#'
#' It is paired with a call to \code{appReset(id, ...)}
#' in server
#'
#'
#' @examples
#' if (interactive()) {
#'    library(shiny)
#'    library(periscope2)
#'    shinyApp(
#'      ui = fluidPage(fluidRow(column(12, appResetButton(id = "appResetId")))),
#'      server = function(input, output) {
#'        appReset(id = "appResetId", logger = "")
#'    })
#' }
#'
#'
#' @export
#' @seealso \link[periscope2]{appReset}
#' @seealso \link[periscope2]{downloadFile}
#' @seealso \link[periscope2]{downloadFile_ValidateTypes}
#' @seealso \link[periscope2]{downloadFile_AvailableTypes}
#' @seealso \link[periscope2]{downloadablePlot}
#' @seealso \link[periscope2]{downloadFileButton}
#' @seealso \link[periscope2]{downloadableTable}
#' @seealso \link[periscope2]{logViewerOutput}
appResetButton <- function(id) {
    ns <- shiny::NS(id)

    shiny::div(shinyWidgets::prettyToggle(ns("resetButton"),
                                          label_off  = "Reset Application",
                                          label_on   = "Cancel Application Reset",
                                          shape      = "round",
                                          value      = FALSE,
                                          status_off = "warning",
                                          status_on  = "danger",
                                          width      = "90%",
                                          fill       = TRUE),
               shiny::span(class = "invisible",
                           shinyWidgets::prettyToggle(ns("resetPending"),
                                                      value      = FALSE,
                                                      label_off  = NULL,
                                                      label_on   = NULL))
    )
}


#' appReset module server function
#'
#' Server-side function for the appResetButton  This is a custom
#' high-functionality button for session reload. The server function is used to
#'  provide module configurations.
#'
#' @param id             Character represents the ID of the Module's UI element (the same id used in \code{appResetButton}
#' @param reset_wait     Integer represents the period to wait before session reload in milliseconds (default = 5000)
#' @param alert_location Character represents div ID or selector to display module related messages (default = "bodyAlert")
#' @param logger         logger to use
#'
#' @return nothing, function will display a warning message in the app then reload the whole application
#'
#'
#' @section Shiny Usage:
#' This function is not called directly by consumers - it is accessed in
#' server_local.R (or similar file) using the same id provided in \code{appResetButton}:
#'
#' \strong{\code{appReset(id = "appResetId", logger = ss_userAction.Log)}}
#'
#' @examples
#' if (interactive()) {
#'    library(shiny)
#'    library(periscope2)
#'    shinyApp(
#'      ui = fluidPage(fluidRow(column(12, appResetButton(id = "appResetId")))),
#'      server = function(input, output) {
#'        appReset(id = "appResetId", logger = "")
#'    })
#' }
#'
#' @export
#'
#' @seealso \link[periscope2]{appResetButton}
#' @seealso \link[periscope2]{downloadFile}
#' @seealso \link[periscope2]{downloadFile_ValidateTypes}
#' @seealso \link[periscope2]{downloadFile_AvailableTypes}
#' @seealso \link[periscope2]{downloadablePlot}
#' @seealso \link[periscope2]{downloadFileButton}
#' @seealso \link[periscope2]{downloadableTable}
#' @seealso \link[periscope2]{logViewerOutput}
appReset <- function(id,
                     reset_wait     = 5000,
                     alert_location = "bodyAlert",
                     logger) {
    shiny::moduleServer(
        id,
        function(input, output, session) {
            shiny::observe({
                if (!(alert_location %in% c("bodyAlert", "headerAlert", "footerAlert", "leftAlert", "rightAlert"))) {
                    logwarn("Alert location must be one of standard alert values: 'bodyAlert', 'headerAlert', 'footerAlert', 'leftAlert', 'rightAlert'", logger = logger)
                    logwarn("Setting alert location to 'bodyAlert'")
                }

                pending  <- shiny::isolate(input$resetPending)
                waittime <- reset_wait

                if (!is.null(pending)) {
                    closeResetAlert(alert_location)
                    if (input$resetButton && !(pending)) {
                        # reset initially requested
                        logwarn(paste("Application Reset requested by user. ",
                                      "Resetting in ", (waittime / 1000),
                                      "seconds."),
                                logger = logger)
                        createPSAlert(
                            selector = paste0("#", alert_location),
                            options  = list(status   = "danger",
                                            title    = "Reset Application",
                                            closable = TRUE,
                                            content  = paste("The application will be reset in",
                                                             (waittime / 1000),
                                                             "seconds if you do not cancel below.")))
                        shinyWidgets::updatePrettyToggle(session,
                                                         "resetPending",
                                                         value = TRUE)
                        shiny::invalidateLater(waittime, session)
                    } else if (!input$resetButton && pending) {
                        # reset cancelled by pushing the button again
                        loginfo("Application Reset cancelled by user.",
                                logger = logger)
                        createPSAlert(
                            selector = paste0("#", alert_location),
                            options  = list(status   = "success",
                                            title    = "Reset Application",
                                            closable = TRUE,
                                            content  = "The application reset was canceled."))

                        shinyWidgets::updatePrettyToggle(session,
                                                         "resetPending",
                                                         value = FALSE)
                    } else if (pending) {
                        # reset timed out
                        logwarn("Application Reset", logger = logger)
                        session$reload()
                    }
                }
            })
        })
}