239 logger::log_shiny_input_change (#590)

Similar to
insightsengineering/teal.modules.general#239
and motivated by
insightsengineering/teal.modules.general#239 (comment)

DESCRIPTION

@@ -41,7 +41,7 @@ Imports:
     htmltools (>= 0.5.4),
     jsonlite,
     lifecycle (>= 0.2.0),
-    logger (>= 0.2.0),
+    logger (>= 0.3.0),
     methods,
     plotly (>= 4.9.2.2),
     R6 (>= 2.2.0),

NEWS.md

@@ -3,6 +3,9 @@
 ### Bug fixes
 * Fix error while creating the filter choices when the data has a factor with a level containing an empty string ("").
 
+### Enhancements
+* Added `logger` functionality for logging changes in shiny inputs. `logger` was added to Imports.
+
 # teal.slice 0.5.1
 
 ### Bug fixes

R/FilterState.R

@@ -207,6 +207,7 @@ FilterState <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("FilterState$server initializing module for slice: { private$get_id() } ")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
           private$server_summary("summary")
           if (private$is_fixed()) {
             private$server_inputs_fixed("inputs")
@@ -745,6 +746,7 @@ FilterState <- R6::R6Class( # nolint
     # @return `NULL`, invisibly.
     keep_na_srv = function(id) {
       moduleServer(id, function(input, output, session) {
+        if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
         # 1. renderUI is used here as an observer which triggers only if output is visible
         #  and if the reactive changes - reactive triggers only if the output is visible.
         # 2. We want to trigger change of the labels only if reactive count changes (not underlying data)

R/FilterStateChoices.R

@@ -412,6 +412,7 @@ ChoicesFilterState <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("ChoicesFilterState$server_inputs initializing, id: { private$get_id() }")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
           # 1. renderUI is used here as an observer which triggers only if output is visible
           #  and if the reactive changes - reactive triggers only if the output is visible.

R/FilterStateDate.R

@@ -323,6 +323,7 @@ DateFilterState <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("DateFilterState$server initializing, id: { private$get_id() }")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
           # this observer is needed in the situation when teal_slice$selected has been
           # changed directly by the api - then it's needed to rerender UI element

R/FilterStateDatettime.R

@@ -385,6 +385,7 @@ DatetimeFilterState <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("DatetimeFilterState$server initializing, id: { private$get_id() }")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
           # this observer is needed in the situation when teal_slice$selected has been
           # changed directly by the api - then it's needed to rerender UI element
           # to show relevant values

R/FilterStateExpr.R

@@ -168,6 +168,7 @@ FilterStateExpr <- R6::R6Class( # nolint
       moduleServer(
         id = id,
         function(input, output, session) {
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
           private$server_summary("summary")
 
           private$destroy_shiny <- function() {

R/FilterStateLogical.R

@@ -297,6 +297,7 @@ LogicalFilterState <- R6::R6Class( # nolint
           non_missing_values <- reactive(Filter(Negate(is.na), private$x_reactive()))
           output$trigger_visible <- renderUI({
             logger::log_trace("LogicalFilterState$server@1 updating count labels, id: { private$get_id() }")
+            if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
             countsnow <- if (!is.null(private$x_reactive())) {
               unname(table(factor(non_missing_values(), levels = private$get_choices())))

R/FilterStateRange.R

@@ -692,6 +692,7 @@ RangeFilterState <- R6::R6Class( # nolint
     # @return `NULL`.
     keep_inf_srv = function(id) {
       moduleServer(id, function(input, output, session) {
+        if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
         # 1. renderUI is used here as an observer which triggers only if output is visible
         #  and if the reactive changes - reactive triggers only if the output is visible.
         # 2. We want to trigger change of the labels only if reactive count changes (not underlying data)

R/FilterStates.R

@@ -431,6 +431,7 @@ FilterStates <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("FilterStates$srv_add initializing, dataname: { private$dataname }")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
           # available choices to display
           avail_column_choices <- reactive({

R/FilterStatesSE.R

@@ -157,6 +157,7 @@ SEFilterStates <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("SEFilterState$srv_add initializing, dataname: { private$dataname }")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
           row_data <- SummarizedExperiment::rowData(data)
           col_data <- SummarizedExperiment::colData(data)

R/FilteredData.R

@@ -606,6 +606,7 @@ FilteredData <- R6::R6Class( # nolint
       checkmate::assert_function(active_datanames)
       moduleServer(id, function(input, output, session) {
         logger::log_trace("FilteredData$srv_active initializing")
+        if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
         private$srv_available_filters("available_filters")
 
@@ -717,6 +718,7 @@ FilteredData <- R6::R6Class( # nolint
       checkmate::assert_class(active_datanames, "reactive")
       moduleServer(id, function(input, output, session) {
         logger::log_trace("FilteredData$srv_add initializing")
+        if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
         observeEvent(input$minimise_filter_add_vars, {
           shinyjs::toggle("filter_add_vars_contents")
           toggle_icon(session$ns("minimise_filter_add_vars"), c("fa-angle-right", "fa-angle-down"))
@@ -808,6 +810,7 @@ FilteredData <- R6::R6Class( # nolint
         id = id,
         function(input, output, session) {
           logger::log_trace("FilteredData$srv_filter_overview initializing")
+          if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
 
           observeEvent(input$minimise_filter_overview, {
             shinyjs::toggle("filters_overview_contents")
@@ -989,6 +992,7 @@ FilteredData <- R6::R6Class( # nolint
     # the appropriate filter state id.
     srv_available_filters = function(id) {
       moduleServer(id, function(input, output, session) {
+        if (shiny::isRunning()) logger::log_shiny_input_changes(input, namespace = "teal.slice")
         slices_available <- self$get_available_teal_slices()
         slices_interactive <- reactive(
           Filter(function(slice) isFALSE(slice$fixed), slices_available())