Fix failing integration test by osenan · Pull Request #88 · insightsengineering/teal.picks

osenan · 2026-06-03T14:49:08Z

There was a failing integration test in the badge test.
To fix it, it was changed the way we click the input and check if the expected content is there or not. I reused the testing functions of tmc. Actually, we can keep them on teal.picks and reuse them in modules packages. In that case, we probably would need to place the function within R folder.
Please run the test:
testthat::test_file("tests/testthat/test-badge_dropdown.R")

To make it sure now the test are passed.

github-actions · 2026-06-03T14:55:03Z

Code Coverage Summary

Filename                  Stmts    Miss  Cover    Missing
----------------------  -------  ------  -------  --------------------------------------------------------------
R/as_picks.R                140      21  85.00%   64, 168-172, 183-187, 202-208, 230-232
R/assertion.R                 5       0  100.00%
R/call_utils.R              147      22  85.03%   23-28, 65, 132-138, 261, 281-282, 285-289, 294
R/helper-shinytest2.R       167       6  96.41%   18, 22, 31, 35, 323, 355
R/helpers.R                   9       0  100.00%
R/interaction.R              42       1  97.62%   105
R/module_merge.R            257       2  99.22%   328, 609
R/module_picks.R            324      23  92.90%   76-82, 101, 138-139, 328-330, 332-336, 474, 522, 560, 572, 580
R/picks.R                   183       1  99.45%   339
R/print.R                    36       2  94.44%   50, 58
R/resolver.R                141      15  89.36%   110-118, 284-289
R/tidyselect-helpers.R       29       0  100.00%
R/tm_merge.R                 54       0  100.00%
R/ui_containers.R            55       0  100.00%
R/zzz.R                       5       5  0.00%    3-11
TOTAL                      1594      98  93.85%

Diff against main

Filename                 Stmts    Miss  Cover
---------------------  -------  ------  --------
R/helper-shinytest2.R     +167      +6  +96.41%
R/picks.R                   -8       0  -0.02%
R/ui_containers.R           -2       0  +100.00%
TOTAL                     +157      +6  +0.25%

Results for commit: 875b709

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

github-actions · 2026-06-03T14:55:28Z

Unit Tests Summary

1 files 12 suites 33s ⏱️
279 tests 264 ✅ 15 💤 0 ❌
416 runs 400 ✅ 16 💤 0 ❌

Results for commit 875b709.

♻️ This comment has been updated with latest results.

github-actions · 2026-06-03T14:55:57Z

Unit Test Performance Difference

Test Suite	$Status$	Time on `main`	$±Time$	$±Tests$	$±Skipped$	$±Failures$	$±Errors$
helper-shinytest2	👶		$+15.98$	$+6$	$0$	$0$	$0$

Additional test case details

Test Suite	$Status$	Time on `main`	$±Time$	Test Case
badge_dropdown	👶		$+0.05$	shinytest2_badge_dropdown_badge_dropdown_is_toggled_when_clicking_and_updates_when_selecting_different_values
badge_dropdown	👶		$+0.01$	shinytest2_badge_dropdown_badge_fixed_is_visible_with_a_lock_icon_and_the_dropdown_is_not_toggleable
badge_dropdown	💀	$0.16$	$-0.16$	shinytest2_badge_dropdown_is_visible_when_clicking_on_it_multiple_times
helper-shinytest2	👶		$+4.61$	shinytest2_helper_exports_app_driver_expect_picks_visible_and_hidden_reflect_badge_state
helper-shinytest2	👶		$+6.16$	shinytest2_helper_exports_app_driver_set_teal_picks_slot_updates_the_selected_value
helper-shinytest2	👶		$+5.21$	shinytest2_helper_exports_app_driver_teal_picks_exports_returns_exported_module_values
picks	💀	$0.01$	$-0.01$	variables_allow_clear_attribute_sets_allow_clear_manually_to_FALSE
picks	💀	$0.01$	$-0.01$	variables_allow_clear_attribute_sets_allow_clear_manually_to_TRUE

Results for commit 9a1b820

♻️ This comment has been updated with latest results.

m7pr · 2026-06-08T07:23:58Z

+}
+
+# Badge label may prefix variables with dataset (e.g. "ADLB BNRIND").
+.teal_picks_strip_ds_prefix_vec <- function(x) { # nolint: object_length_linter.


this is not used in this package yet

yes, removed here

m7pr · 2026-06-08T07:24:10Z

+# Wait until a Shiny input has a non-empty DOM value (e.g. after `updateSelectInput`).
+# Caller must supply the full Shiny input ID (without leading "#").
+# Uses one [`AppDriver$wait_for_js()`] instead of polling `wait_for_idle()`.
+wait_until_nonempty_active_module_input <- function(app_driver, input_id) { # nolint: object_length_linter.


this is not used in this package yet

yes, removed here

m7pr

@osenan maybe rethink which functions do we really need in this package - 2 are not used at all

osenan · 2026-06-17T10:58:55Z

Hi, my initial intention was to port every testing function developed in tmc to be maintained in teal.picks and then reused in tmc and other module packages. That is why I copied the full script. But let's go step by step, I have removed the non used functions. Most of them are already used only for the tests in teal.picks

averissimo

Looks good overall, but maybe we should move the new functions to the R folder (either as private or exported).

This way we can re-use them in other packages without too much repeated code.

Left some other housecleaning comments as well ;)

averissimo · 2026-06-22T10:58:01Z

If we add this functions here we should make them available in the R/ folder instead.

This would reduce redundant code in tmc/tmg/...

I think we can export the JS API with a app_driver or shinytest2 prefix. Or other naming convention

app_driver_get_teal_picks_slot

app_driver_set_teal_picks_slot

app_driver_click_teal_picks_summary_badge

Is any other function being used?

Maybe add a checkmate::assert_class(app_driver, "AppDriver") to those functions just in case

I agree that adding them to the R folder is the best idea. I suggest not to export them but to export them using getFromNamespace

I agree that adding them to the R folder is the best idea. I suggest not to export them but to export them using getFromNamespace

Ok, sounds good!.

This has a downside of reducing the test coverage.

Can you add some coverage for the basic functions to have some coverage of the file?

Thanks

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

averissimo

Overall looks good. Left 2 minor comments and a request to increase coverage of the new file

I wonder if we should use trim the name when using it outside the package.

That would be best to keep it simple and have an easy migration/cleanup

averissimo · 2026-06-25T00:11:52Z

-teal_picks_exports <- function(app_driver, pick_id) {
+#' Read all teal.picks exported values for a module namespace.
+#'
+#' The module namespace is inferred from the summary badge id in the DOM,


Use backticks around DOM to avoid adding it to wordlist.

Suggested change

#' The module namespace is inferred from the summary badge id in the DOM,

#' The module namespace is inferred from the summary badge id in the `DOM`,

Changed and rerun documentation in a single commit

averissimo · 2026-06-25T00:14:21Z

+#' @return Called expectation result.
 #' @keywords internal
-expect_visible <- function(selector, app_driver, timeout) {
+app_driver_expect_visible <- function(selector, app_driver, timeout) {


I'm not sure this is the best location for this function.

This is used across many packages, would teal be better? WDYT?

Initially, I agreed with your suggestion. I was looking again at the function code. This function has a bad name that is confusing. It calls an internal selector that is teal.picks specific. I think the best solution is to rename the function and keep it in teal.picks

osenan · 2026-06-25T08:47:01Z

Many thanks for the review! I agree with your suggestions, they improve the quality of the change. I will update this PR and improve the coverage.

osenan · 2026-06-25T13:26:16Z

+    withr::with_envvar(c(NOT_CRAN = "true"), {
+      skip_on_cran()


These two lines are strange.. But I could not make covr "see" the tests and at the same time have safety that they would be skipped on CRAN without them. As they are testing functions is not possible to test them if not in a e2e test. That creates the inconvenience that locally the test will be executed even if env var TESTING_DEPTH is set to 1. But when I tried to add skip_if_to_deep(5) at the beginning of the script it was not seen by covr again.

osenan · 2026-06-25T13:41:37Z

Thanks for the review @averissimo , I have applied your changes. The biggest has been to increase the coverage. As it was an e2e test, I had to do a weird change for covr to see it. Additionally, I have removed warnings in the badge test using the warning class implemented in this package.

tests: completely refactor e2e test to correctly click badge

df342d0

osenan requested a review from a team June 3, 2026 14:49

m7pr reviewed Jun 8, 2026

View reviewed changes

fix: remove unused testing functions

479114f

osenan requested a review from m7pr June 17, 2026 10:59

averissimo reviewed Jun 22, 2026

View reviewed changes

averissimo self-assigned this Jun 22, 2026

osenan and others added 6 commits June 22, 2026 15:21

Update tests/testthat/test-badge_dropdown.R

8ec09b5

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

Update tests/testthat/test-badge_dropdown.R

2c70921

Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>

refactor: include helper testing functinos in R directory

8dc8c8e

docs: add missing internal documentation files

c1a27e9

Merge branch 'updated-helper-functions' into fix-badge-test@main

c2adb49

chore: update wordlist

0a3e647

osenan requested a review from averissimo June 23, 2026 08:32

averissimo approved these changes Jun 25, 2026

View reviewed changes

chore: remove unnecessary word in WORDLIST

2ce31bb

osenan added 5 commits June 25, 2026 11:24

chore: rename functions to avoid confusion with function usage

524bdd3

feat: execute tests when calling covr package but not in CRAN checks

a294918

refactor: remove skip if to deep to see if CI coverage is improved

8f29e10

chore: add function to package documentation index

4575e16

chore: add function to package documentation index

875b709

osenan commented Jun 25, 2026

View reviewed changes

	#' The module namespace is inferred from the summary badge id in the DOM,
	#' The module namespace is inferred from the summary badge id in the `DOM`,

Uh oh!

Conversation

osenan commented Jun 3, 2026

Uh oh!

github-actions Bot commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Diff against main

Uh oh!

github-actions Bot commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Tests Summary

Uh oh!

github-actions Bot commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Performance Difference

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m7pr left a comment

Choose a reason for hiding this comment

Uh oh!

osenan commented Jun 17, 2026

Uh oh!

averissimo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

averissimo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

osenan Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

osenan commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

osenan commented Jun 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jun 3, 2026 •

edited

Loading

github-actions Bot commented Jun 3, 2026 •

edited

Loading

github-actions Bot commented Jun 3, 2026 •

edited

Loading

averissimo left a comment •

edited

Loading

osenan Jun 25, 2026 •

edited

Loading

osenan commented Jun 25, 2026 •

edited

Loading