Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove TealData checks #1406

Merged
merged 24 commits into from
Nov 15, 2024
Merged

Remove TealData checks #1406

merged 24 commits into from
Nov 15, 2024

Conversation

llrs-roche
Copy link
Contributor

@llrs-roche llrs-roche commented Nov 11, 2024

Pull Request

Fixes #1386

Copy link
Contributor

github-actions bot commented Nov 11, 2024

✅ All contributors have signed the CLA
Posted by the CLA Assistant Lite bot.

@llrs-roche
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@llrs-roche
Copy link
Contributor Author

About removing ui and server checks for datasets arguments from module :

#server

It previously only was a warning, I converted it to an error. This should push users to using data instead.

ui

Currently it errors even if it is not used:

current> fa <- module(ui = function(id, data){paste("ha")})
[ERROR] 2024-11-11 12:35:02.0155 pid:10492 token:[] teal In 'module(ui = function(id, data) "ha")': Called from module(label = "module", ...)
UI with `data` or `datasets` argument is no longer accepted.
If some UI inputs depend on data, please move the logic to your server instead.
Possible solutions are renderUI() or updateXyzInput() functions.
Error in module(ui = function(id, data) { : 
  Called from module(label = "module", ...)
  UI with `data` or `datasets` argument is no longer accepted.
  If some UI inputs depend on data, please move the logic to your server instead.
  Possible solutions are renderUI() or updateXyzInput() functions.

If we remove it, it will be silently swallowed by the ... :

removed> devtools::load_all(".")
ℹ Loading teal
[INFO] 2024-11-11 12:35:27.2540 pid:10492 token:[] teal You are using teal version 0.15.2.9084
removed> fa <- module(ui = function(id, data){paste("ha")})
removed> 

I kept it, I think it can be removed when the dataset check for server is also removed.
I assume that as they already were a warning and an error they are not in use by any application on teal.gallery, tmc or tmg.

While checking this I realize that the teal package (not sure about the other packages) is a mix of usages of rlang deprecate_soft, deprecate_stop and warn and stop. Maybe this should be tackled to simplify messages to the user?

There is also the .deprecate_tdata_msg function used by several others. I am not sure if these are also up for removal or not. According to the warning we should remove them too.

@llrs-roche llrs-roche marked this pull request as ready for review November 11, 2024 11:55
Copy link
Contributor

github-actions bot commented Nov 11, 2024

Unit Tests Summary

  1 files   25 suites   9m 9s ⏱️
265 tests 261 ✅ 4 💤 0 ❌
520 runs  516 ✅ 4 💤 0 ❌

Results for commit 2d1080a.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Nov 11, 2024

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
module_teal 💚 $73.81$ $-1.35$ $0$ $0$ $0$ $0$

Results for commit 2d36e14

♻️ This comment has been updated with latest results.

NEWS.md Outdated Show resolved Hide resolved
R/modules.R Outdated Show resolved Hide resolved
@m7pr
Copy link
Contributor

m7pr commented Nov 11, 2024

@llrs-roche left you 2 comments.
Also R CMD CHECK is failing so that was not ready for the review yet

NEWS.md Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Nov 14, 2024

badge

Code Coverage Summary

Filename                          Stmts    Miss  Cover    Missing
------------------------------  -------  ------  -------  ----------------------------------------------------------------------------------------------------------------------------------------
R/checkmate.R                        24       0  100.00%
R/dummy_functions.R                  47      11  76.60%   27, 29, 41, 52-59
R/get_rcode_utils.R                  12       0  100.00%
R/include_css_js.R                   22      17  22.73%   12-38, 76-82
R/init.R                             99      42  57.58%   150-159, 161, 173-194, 219-222, 229-235, 238-239, 241
R/landing_popup_module.R             25      25  0.00%    61-87
R/module_bookmark_manager.R         158     127  19.62%   47-68, 88-138, 143-144, 156, 203, 238-315
R/module_data_summary.R             203      39  80.79%   26-54, 68, 78, 219, 224, 238, 269-273
R/module_filter_data.R               64       2  96.88%   22-23
R/module_filter_manager.R           230      57  75.22%   56-62, 73-82, 90-95, 108-112, 117-118, 291-314, 340, 367, 379, 386-387
R/module_init_data.R                 74       0  100.00%
R/module_nested_tabs.R              236      91  61.44%   40-142, 174, 199-201, 320, 360
R/module_snapshot_manager.R         216     146  32.41%   89-95, 104-113, 121-133, 152-153, 170-180, 184-199, 201-208, 215-230, 234-238, 240-246, 249-262, 265-273, 304-318, 321-332, 335-341, 355
R/module_teal_data.R                149      10  93.29%   41-48, 84, 135-136
R/module_teal_lockfile.R            131      44  66.41%   32-36, 44-56, 59-61, 75, 85-87, 99-101, 109-118, 121, 123, 125-126, 160-161
R/module_teal_with_splash.R          12      12  0.00%    22-38
R/module_teal.R                     190      87  54.21%   48-143, 158, 184-185, 217
R/module_transform_data.R            54      32  40.74%   17-52
R/modules.R                         280      72  74.29%   173-177, 232-235, 356-376, 384, 534-540, 553-562, 578-626, 659, 671-679
R/reporter_previewer_module.R        19       2  89.47%   30, 34
R/show_rcode_modal.R                 24      24  0.00%    17-42
R/tdata.R                            14      14  0.00%    19-61
R/teal_data_module-eval_code.R       24       0  100.00%
R/teal_data_module-within.R           7       0  100.00%
R/teal_data_module.R                 58       0  100.00%
R/teal_data_utils.R                  10       0  100.00%
R/teal_reporter.R                    68       6  91.18%   69, 77, 125-126, 129, 146
R/teal_slices-store.R                29       0  100.00%
R/teal_slices.R                      63       0  100.00%
R/TealAppDriver.R                   353     353  0.00%    52-735
R/utils.R                           225      37  83.56%   378-426
R/validate_inputs.R                  32       0  100.00%
R/validations.R                      58      37  36.21%   110-377
R/zzz.R                              15      11  26.67%   4-18
TOTAL                              3225    1298  59.75%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  -------
R/init.R         -9      -8  +3.87%
TOTAL            -9      -8  +0.14%

Results for commit: 2d1080a

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

R/modules.R Outdated Show resolved Hide resolved
R/modules.R Outdated Show resolved Hide resolved
@llrs-roche
Copy link
Contributor Author

To summarize the changes after the discussion: I only removed TealData checks on module.
There is the tdata.R file with hard deprecated related functions that I haven't removed.

modules ui and server formals: Not modified, waiting for guidelines to decide how to proceed.

Copy link
Contributor

@gogonzo gogonzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@llrs-roche llrs-roche enabled auto-merge (squash) November 15, 2024 13:37
@llrs-roche llrs-roche merged commit 1767e03 into main Nov 15, 2024
28 checks passed
@llrs-roche llrs-roche deleted the 1386_deprecate branch November 15, 2024 13:37
@github-actions github-actions bot locked and limited conversation to collaborators Nov 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Review Deprecated Functions
4 participants