Shinytest2因renderUI自动ID导致JSON对比失败的解决问询

问题描述 #

使用shinytest2做Shiny应用自动化测试时，会碰到嵌套renderUI()生成随机动态ID的问题——每次运行测试，这些ID（比如out63cdc91c431ff1ea）都会变化，导致JSON快照对比失败。原本以为设置AppDriver$new()的seed参数能解决（shinytest中有效），但实际没用，因为seed只作用于最外层renderUI()，嵌套的内层会生成新的响应上下文，不受seed控制。

测试脚本精简版 #

library(shinytest2)
test_that("{shinytest2} recording: test-good", {
    print("Running test-good")
    app <- AppDriver$new(
        variant = platform_variant(), 
        name = "test-good", 
        seed = 1234,
        load_timeout = 1e+05)

    app$set_inputs(sidebarmenuid = "tabClientCount")
    app$wait_for_idle(500) # wait until whole application is idle for 500ms
    app$expect_values()
})

控制台报错 #

Failure (test-good.R:20:1): {shinytest2} recording: test-good
Snapshot of file to 'good/test-good-001.json' has changed

相关renderUI代码 #

headerGeneric <- function(tabTitle, extraHTML = NULL) {
  renderUI({
    if(valid_file() == 1) {
      list(h2(tabTitle),
           h4(strong("Date Range of Current File: "),
            paste(
             format(Project0$start_date, "%m-%d-%Y"),
             "to",
             format(Project0$end_date, "%m-%d-%Y")
           )),
           extraHTML
      )
    } else {
      h4("This is blank until your data has been validated.")
    }
  })
}

output$headerClientCounts <- headerGeneric("Client Counts Report", 
    renderUI({   
      organization <- Project0 %>%
        filter(ProjectName == input$currentProviderList) %>%
        pull(OrganizationName)

      h4(organization, "|", input$currentProviderList)
    })
  )

解决方案 #

方案1：为嵌套UI手动指定固定ID #

renderUI()本身不支持直接传入ID，但可以通过拆分嵌套结构，用uiOutput()配合固定ID来替代内层的renderUI()，让ID稳定可控。

修改后的代码示例：

# 重构headerGeneric，接收静态UI或带固定ID的uiOutput
headerGeneric <- function(tabTitle, extraUI = NULL) {
  renderUI({
    if(valid_file() == 1) {
      list(h2(tabTitle),
           h4(strong("Date Range of Current File: "),
              paste(
                format(Project0$start_date, "%m-%d-%Y"),
                "to",
                format(Project0$end_date, "%m-%d-%Y")
              )),
           extraUI
      )
    } else {
      h4("This is blank until your data has been validated.")
    }
  })
}

# 单独定义内层UI的output，使用固定ID
output$orgProviderHeader <- renderUI({   
  organization <- Project0 %>%
    filter(ProjectName == input$currentProviderList) %>%
    pull(OrganizationName)
  
  h4(organization, "|", input$currentProviderList)
})

# 调用headerGeneric时传入带固定ID的uiOutput
output$headerClientCounts <- headerGeneric("Client Counts Report", 
                                           uiOutput("orgProviderHeader")
)

这样内层UI由固定ID的uiOutput渲染，不会生成随机ID，测试快照对比就能稳定通过。

方案2：在测试中忽略动态ID差异 #

如果不想修改应用代码，可以在expect_values()中通过参数过滤动态ID相关的差异：

方式1：用exclude参数匹配动态ID

app$expect_values(
  # 匹配headerClientCounts下所有以out开头的动态子元素
  exclude = list(output = list(headerClientCounts = list("out*")))
)

方式2：用transform预处理快照数据

直接提取UI内容，忽略ID元数据：

app$expect_values(
  transform = function(value) {
    if (!is.null(value$output$headerClientCounts)) {
      # 只保留HTML内容，丢弃动态ID相关的键值对
      value$output$headerClientCounts <- lapply(value$output$headerClientCounts, function(x) x$html)
    }
    value
  }
)

关键说明 #

• shinytest2的seed仅控制最外层Shiny上下文的随机ID生成，嵌套renderUI()会创建独立上下文，不受外层seed影响。
• 优先选择方案1，它让应用结构更清晰，测试稳定性更高；方案2适合快速临时解决，无需改动应用代码。

内容的提问来源于stack exchange，提问作者Alex Silverman