Dash R 0.9.1 release #272

HammadTheOne · 2021-10-03T17:36:42Z

This PR merges in the changes from dev to master and updates the package, including the DESCRIPTION and CHANGELOG, in preparation for the Dash R 1.0 release to Github and CRAN.

Update CHANGELOG with updates based on commit history.
Run checks and update package for CRAN submission.

@daattali

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Relocate metadata fixup logic from config.yml to R script

* Testing initial implementation * More testing * Callback Context Updates * Updating callback context logic * Fixing callback returns * Adding callback args conditional * Cleanup and additional changes to callback value conditionals * Comment cleanup * Added PMC callback validation, removed unnecessary code * Update R/dependencies.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update R/dependencies.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update R/dependencies.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update R/dependencies.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Added build to gitignore * Updated dependencies.R * Update boilerplate docs and add wildcard symbols * Drying up validation code and applying symbol logic * Update test to use symbols * Cleaned up code and added allsmaller test example * Cleaning up redundant code * Update FUNDING.yml * Updated callback_args logic and example * Adding basic unittests, updated validation * Fixed response for MATCH callbacks * Added integration test and updated examples for docs * Added additional integration test * Formatting and cleanup * update docs * Update to-do app * Add comments to examples * Change empy vector to character type. Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update boilerplate text. Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update tests/integration/callbacks/test_pattern_matching.py Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update tests/integration/callbacks/test_pattern_matching.py Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update tests/integration/callbacks/test_pattern_matching.py Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update tests/integration/callbacks/test_pattern_matching.py Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update tests/integration/callbacks/test_pattern_matching.py Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update tests/testthat/test-wildcards.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Update wildcards_test.R Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> * Removed triple colon syntax * Use seq_along and remove unnecessary unittest * Update CHANGELOG.md * Update CHANGELOG.md * Add support for arbitrary and sorted keys * Whitespace deleted * Added integration tests * Fixing test output * Fixing flakiness * Update test_pattern_matching.py * Update test_pattern_matching.py * Updating boilerplate text and test with generalized keys * Minor test fixes Co-authored-by: Ryan Patrick Kyle <rpkyle@users.noreply.github.com> Co-authored-by: Nicolas Kruchten <nicolas@plot.ly> Co-authored-by: rpkyle <ryan@plotly.com>

* Fixing NULL error with glue interpolation * Update utils.R * Update utils.R

* bump dash-renderer to v1.8.2 * Update CHANGELOG.md * add note about update to dash-renderer * Fixing flaky test

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

* Update setCallbackContext * Adding graphs test * Slight fix * bump version and update CHANGELOG * Less flaky test Co-authored-by: rpkyle <ryan@plotly.com>

daattali · 2021-10-07T02:58:33Z

Don't namespace dash:: inside the dash package - it's redundant and confusing (I saw a few such cases in /tests/manual/ and in documentation, there might be others)
I would prefer to combine all the HTML components (htmlDiv, htmlBr, etc) into one file, and similarly all the interactive components (dcc*) into another file. This way will dramatically reduc ethe number of source files clutter
I suggest updating the DESCRIPTION to use testthat version >3.0.0 , and then removing all context() calls from the test files (it's deprecated)
The tests/circleci/fixup_metadata.R file should either be removed or moved to an appropriate folder
In the dashCoreComponents package, the second argument of many components was value. Now the arguments are alphabetical and value has been moved to the last. This is a breaking change, and I strongly believe it should be fixed because having value as the second argument makes sense so that you don't have to always explicitly name it. @alexcjohnson @jackparmer this is now an issue with this package but this package is affected - where should I open an issue for this?

The check that all states come after all inputs can be removed using the new flexible callback syntax

dashR/R/utils.R

Lines 378 to 381 in 5c80285

    
           # Verify that 'input' parameters always precede 'state', if present 
        
           if (!(valid_seq(params))) { 
        
             stop(sprintf("Strict ordering of callback handler parameters is required. Please ensure that input parameters precede all state parameters."), call. = FALSE) 
        
           }

This is perhaps not directly related to this PR, but should be fixed: using input() instead of output() inside callbacks works. It shouldn't. There should be a check that anything supplied to the callback outputs is actually of class "output"

Let me know when the package is ready for re-testing

daattali · 2021-10-07T21:32:04Z

DESCRIPTION

@@ -25,7 +25,7 @@ Imports:
  rlang,
  utils
 Suggests:
-  testthat,
+  testthat (>= 3.1.0),


I didn't even know there was a 3.1.0! Looks like it only got released a couple days ago. I think 3.0.0 would be just fine too

Suggested change

testthat (>= 3.1.0),

testthat (>= 3.0.0),

daattali · 2021-10-07T22:31:47Z

I see that all dash:: have been removed 👍 Similarly, in test files the dash::: can/should be removed

HammadTheOne · 2021-10-08T20:21:20Z

Don't namespace dash:: inside the dash package - it's redundant and confusing (I saw a few such cases in /tests/manual/ and in documentation, there might be others)

Fixed in d419517 and 3aa7abd.

I would prefer to combine all the HTML components (htmlDiv, htmlBr, etc) into one file, and similarly all the interactive components (dcc*) into another file. This way will dramatically reduce the number of source files clutter

Concatenated components into package R scripts in cb93cdb. Note, this change requires the merge of plotly/dash#1798 to make this a streamlined process, and also address the NAMESPACE generation with devtools::document(). I'd also like to rebuild the package one more time with the npm run update command once that PR is merged to update the component packages.

I suggest updating the DESCRIPTION to use testthat version >3.0.0 , and then removing all context() calls from the test files (it's deprecated)

Updated in aff9b99.

The tests/circleci/fixup_metadata.R file should either be removed or moved to an appropriate folder

Removed in 0ad3b24.

In the dashCoreComponents package, the second argument of many components was value. Now the arguments are alphabetical and value has been moved to the last. This is a breaking change, and I strongly believe it should be fixed because having value as the second argument makes sense so that you don't have to always explicitly name it. @alexcjohnson @jackparmer this is now an issue with this package but this package is affected - where should I open an issue for this?

I think the most appropriate repo for this issue would be in dash, with a label for dashCoreComponents.

The check that all states come after all inputs can be removed using the new flexible callback syntax

Removed in 68427b3.

This is perhaps not directly related to this PR, but should be fixed: using input() instead of output() inside callbacks works. It shouldn't. There should be a check that anything supplied to the callback outputs is actually of class "output"

Fixed with 68427b3.

daattali

Suggestions/comments below. There are also still a few dash::: - in the test-components.R test file

daattali · 2021-10-09T03:43:37Z

DESCRIPTION

@@ -25,7 +25,7 @@ Imports:
  rlang,
  utils
 Suggests:
-  testthat,
+  testthat (>= 3.1.0),


Suggested change

testthat (>= 3.1.0),

testthat (>= 3.0.0),

daattali · 2021-10-09T03:46:23Z

R/utils.R

+  if (!is.list(output[[1]])){output <- list(output)}
+  invalid_outputs <- vapply(output, function(x) {
+    !any(c('output', 'state') %in% attr(x, "class"))
+  }, FUN.VALUE=logical(1))
+


Are we sure this is the correct behaviour? I think outputs must only be of class "output", not "state"

daattali · 2021-10-09T03:46:56Z

R/utils.R

+   # Verify that output contains no elements that are not either members of 'output' or 'state' classes
+  if (any(invalid_outputs)) {
+    stop(sprintf("Callback outputs must be outputs or states. Please verify formatting of callback outputs."), call. = FALSE)


If my above comment is correct, then this needs to update too

HammadTheOne · 2021-10-09T22:35:16Z

Thanks for the sharp eye and feedback @daattali! I think I've removed all the references to the internal dash namespace now, and I've updated the broken tests (which were setting a named list for the output instead of calling the output function itself).

At Jack's suggestion, I'm also going to be adding the Dash Bootstrap Components library into the Dash R namespace. I'll do that in a separate PR, we're already pushing the scope of this one a little far.

daattali · 2021-10-10T00:28:19Z

Awesome!

Do the CI checks run the unit tests, and that's why they failed previously? It looks like there's a build step in CircleCI , I assume that part of that includes running the tests, but I'm not able to see it since I don't have access to that account.

I think this PR is ready except for the breaking change of the order of parameters to dcc components changed. I think we should wait until we decide what to do about that, whether we'll fix it directly at the R level or higher up the chain

* Adding dbc to dashR namespace * updated gitignore * Adding dbc docs and updating gulpfile * Updating test with dbc * Moved misc tests and added dbc snapshot * Fixing test * fixing id * Fixed export and test

HammadTheOne · 2021-10-13T05:43:29Z

@daattali I've reverted the prop order to the original unsorted order for the time being. We can talk about that more in detail next week, but if everything else looks good I think this should be ready to merge at this point.

daattali · 2021-10-13T18:53:39Z

I'll test it again soon will let you know today

rpkyle and others added 30 commits August 3, 2020 13:27

contribute test script

e5b0cfe

remove version updating in DESCRIPTION

a242d49

fix EOL

f1b81d6

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Merge pull request #222 from plotly/212-untangle-dashr-build

4d234cb

Relocate metadata fixup logic from config.yml to R script

Add support for user-defined server routes (#225)

4e4ccb1

Provide support for script and stylesheet attributes (#226)

5bd1bbb

Authenticate on pulls from Docker Hub (#231)

3f862f9

Add support for callback graph improvements and timing (#224)

3a3ee2f

Update CHANGELOG.md

766e3a8

Fixing Null error with glue::glue interpolation (#233)

03ed383

* Fixing NULL error with glue interpolation * Update utils.R * Update utils.R

Update CHANGELOG.md

5b31534

Update dash-renderer to v1.8.2 (#234)

2fdd157

* bump dash-renderer to v1.8.2 * Update CHANGELOG.md * add note about update to dash-renderer * Fixing flaky test

bump package version to v0.8.0

bb9fc6a

Update R/dash.R

314ced8

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Update tests/testthat/test-wildcards.R

3f9f9f1

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Update DESCRIPTION

e093463

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Merge branch 'master' into dev

6ee2702

add PMC example

b477fe0

update documentation

6fffb44

update CHANGELOG release date

b4ca5f9

Merge branch 'dev' of github.com:plotly/dashR into dev

24b491a

🔨 PMC docs refactor

c120ab2

Update tests/integration/callbacks/test_pattern_matching.py

56d1dc0

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Update tests/integration/callbacks/test_pattern_matching.py

226f949

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

Update tests/integration/callbacks/test_pattern_matching.py

fd5f3da

Co-authored-by: HammadTheOne <30986043+HammadTheOne@users.noreply.github.com>

add import of glue

c3a34b6

add glue to imports.R

877f463

fix line length issue

b238a57

Fix setCallbackContext for wildcard and ordinary inputs (#237)

ff858ac

* Update setCallbackContext * Adding graphs test * Slight fix * bump version and update CHANGELOG * Less flaky test Co-authored-by: rpkyle <ryan@plotly.com>

HammadTheOne added 3 commits October 7, 2021 15:19

Remove references to dash namespace within package

d419517

Update testthat and remove deprecated context calls

aff9b99

Removed fixup_metadata.R

0ad3b24

daattali reviewed Oct 7, 2021

View reviewed changes

HammadTheOne added 4 commits October 8, 2021 13:33

Removing more dash namespace references

3aa7abd

Concatenating component function files

e934ca0

Updating checks

68427b3

Merging components into package R files

cb93cdb

Fixing check

3b440da

daattali reviewed Oct 9, 2021

View reviewed changes

HammadTheOne added 7 commits October 9, 2021 13:08

More package cleanup

318d7cf

testthat 3.0.0

6a1886a

Rebuilding package

950b90d

Fixed conditional for multiple outputs

dade919

Fix no_update test

bce3387

Fixing callback_instrumentation test

68343eb

Fixing unit test

27b98b3

HammadTheOne and others added 2 commits October 12, 2021 15:49

Added DBC to Dash R package (#273)

bde703b

* Adding dbc to dashR namespace * updated gitignore * Adding dbc docs and updating gulpfile * Updating test with dbc * Moved misc tests and added dbc snapshot * Fixing test * fixing id * Fixed export and test

Reverting sorted prop order

3c5e5e0

HammadTheOne added 2 commits October 13, 2021 13:46

Checks updates

582fd92

Re-running test

f71ec43

HammadTheOne merged commit f0a2826 into master Oct 13, 2021

HammadTheOne changed the title ~~Dash R 0.6.0 release~~ Dash R 0.9.1 release Oct 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dash R 0.9.1 release #272

Dash R 0.9.1 release #272

HammadTheOne commented Oct 3, 2021 •

edited

daattali commented Oct 7, 2021

daattali Oct 7, 2021

daattali Oct 9, 2021

daattali commented Oct 7, 2021

HammadTheOne commented Oct 8, 2021 •

edited

daattali left a comment •

edited

daattali Oct 9, 2021

daattali Oct 9, 2021

daattali Oct 9, 2021

HammadTheOne commented Oct 9, 2021

daattali commented Oct 10, 2021

HammadTheOne commented Oct 13, 2021 •

edited

daattali commented Oct 13, 2021

Dash R 0.9.1 release #272

Dash R 0.9.1 release #272

Conversation

HammadTheOne commented Oct 3, 2021 • edited

daattali commented Oct 7, 2021

daattali Oct 7, 2021

Choose a reason for hiding this comment

daattali Oct 9, 2021

Choose a reason for hiding this comment

daattali commented Oct 7, 2021

HammadTheOne commented Oct 8, 2021 • edited

daattali left a comment • edited

Choose a reason for hiding this comment

daattali Oct 9, 2021

Choose a reason for hiding this comment

daattali Oct 9, 2021

Choose a reason for hiding this comment

daattali Oct 9, 2021

Choose a reason for hiding this comment

HammadTheOne commented Oct 9, 2021

daattali commented Oct 10, 2021

HammadTheOne commented Oct 13, 2021 • edited

daattali commented Oct 13, 2021

HammadTheOne commented Oct 3, 2021 •

edited

HammadTheOne commented Oct 8, 2021 •

edited

daattali left a comment •

edited

HammadTheOne commented Oct 13, 2021 •

edited