Un-deprecate `Plumber$run(swaggerCallback=, debug=)` and add `Plumber$run(docs=,quiet=)` #765

jcheng5 · 2021-02-07T00:01:17Z

To better support headless running scenarios. Specifically, I'm creating unit tests for plumbertableau that do not involve using an additional process.

Minimal reproducible example

# Messages printed, swagger UI launched
pr() %>% pr_run()

# No messages printed, no swagger UI launched
pr() %>% pr_run(swaggerCallback = NULL, quiet = TRUE)

PR task list:

Update NEWS
Add tests
Update documentation with devtools::document()

To better support headless running scenarios

meztez · 2021-02-07T04:29:23Z

This would probably work too

pr() %>% pr_set_docs_callback(NULL) %>% pr_run(quiet = TRUE)

It made realize options_plumber needs to handle deprecated option plumber.swagger.url so we could do

options_plumber(docs.callback = NULL) # Whole session
pr() %>% pr_run(quiet = TRUE)

As it is we still default to it when initializing the router.

I liked the idea of distanciating the package from the swagger ui by using more general names.

schloerke · 2021-02-08T15:57:55Z

@jcheng5 @meztez has a fix for the docs.callback option for a global session. (PR fix: #766). I'd prefer to not un-deprecate pr_run(swaggerCallback=) and use pr_set_docs_callback(NULL) instead.

Would Connect ever want access to pr_run(quiet=)? Do you think we should allow users to ever receive the httpuv server to do as they please?

If no, then it seems like an appropriate place to put the quiet= argument (and end of the PR). If yes, then we should prolly make a pr_set_httpuv(quiet = FALSE, sync = TRUE) like method to do this before the pr_run() call.

quiet to turn off printing
method to switch between httpuv::runServer(), httpuv::startServer(), or return the server before starting. This parameter will take more implementation thought to make sure all existing assumptions (such as any on.exit() call) are covered.

While we do not need to implement the method parameter. I'd like to put the quiet parameter in an appropriate spot with room to grow.

schloerke · 2021-02-11T18:32:04Z

Talking more with @wch, the httpuv methods and alterations would prolly be done best with a method outside of pr_run().

Might be good to add a pr_build() which preps the plumber router and pr_run() would wrap pr_build() and then call httpuv::runServer(). For the concept of using different httpuv methods, it would require an update to httpuv such as adding a app$onAppStop(fn) (similar to app$onWSClose()).

tl/dr; Put quiet in pr_run(quiet=) and httpuv related things could be added in new methods.

meztez · 2021-02-11T18:34:09Z

Running an headless plumber would make a lot of people happy.

schloerke

I believe this should revert the swaggerCallback changes and also insert ... so that quiet must be full named.

schloerke · 2021-02-11T18:32:50Z

R/plumber.R

+    #' @param swaggerCallback An optional single-argument function that is
+    #'   called back with the URL to an OpenAPI user interface when one becomes
+    #'   ready. If missing, defaults to `$setDocsCallback()`.


Suggested change

#' @param swaggerCallback An optional single-argument function that is

#' called back with the URL to an OpenAPI user interface when one becomes

#' ready. If missing, defaults to `$setDocsCallback()`.

#' @param swaggerCallback Deprecated. See `$setDocsCallback()`

schloerke · 2021-02-11T18:33:05Z

R/plumber.R

    #' @importFrom lifecycle deprecated
    run = function(
      host = '127.0.0.1',
      port = getOption('plumber.port', NULL),
      swagger = deprecated(),
      debug = deprecated(),
-      swaggerCallback = deprecated()
+      swaggerCallback,


Add in ...

Suggested change

swaggerCallback,

swaggerCallback = deprecated(),

...,

schloerke · 2021-02-11T18:33:50Z

R/plumber.R

+      if (missing(swaggerCallback)) {
+        swaggerCallback <- private$docs_callback


Suggested change

if (missing(swaggerCallback)) {

swaggerCallback <- private$docs_callback

if (lifecycle::is_present(swaggerCallback)) {

lifecycle::deprecate_warn("1.0.0", "run(swaggerCallback = )", "setDocsCallback(callback = )")

self$setDocsCallback(swaggerCallback)

R/plumber.R

schloerke · 2021-02-11T18:34:21Z

R/pr.R

+#' @param swaggerCallback An optional single-argument function that is called
+#'   back with the URL to an OpenAPI user interface when one becomes ready. If
+#'   missing, defaults to `$setDocsCallback()`.


Suggested change

#' @param swaggerCallback An optional single-argument function that is called

#' back with the URL to an OpenAPI user interface when one becomes ready. If

#' missing, defaults to `$setDocsCallback()`.

R/pr.R

schloerke · 2021-02-11T18:38:25Z

R/pr.R

@@ -488,11 +492,15 @@ pr_filter <- function(pr,
 #' @export
 pr_run <- function(pr,
                   host = '127.0.0.1',
-                   port = getOption('plumber.port', NULL)
+                   port = getOption('plumber.port', NULL),
+                   swaggerCallback,


Suggested change

swaggerCallback,

...,

R/pr.R

schloerke · 2021-02-11T18:40:21Z

NEWS.md

@@ -23,6 +23,8 @@ plumber 1.0.0.9999 Development version

 * OpenAPI Specification can be set using a file path. (@meztez #696)

+* Added `quiet = TRUE` to `Plumber$run()` to suppress routine startup messages. (@jcheng5 #765)


Suggested change

* Added `quiet = TRUE` to `Plumber$run()` to suppress routine startup messages. (@jcheng5 #765)

* Added `quiet = TRUE` to `pr_run()` and `Plumber$run()` to suppress routine startup messages. (@jcheng5 #765)

* master: Add `PlumberEndpoint$setPath(path)` (#770) Setting `plumber.docs.callback` to `NULL` will also set legacy `plumber.swagger.url` (#766) Update Hosting vignette to swap RStudio Connect and Digital Ocean (#774) Use `pak` for GHA (#771)

`debug`, `swaggerCallback`, and `docs` Add `...` and check that it is empty

schloerke · 2021-02-26T20:56:03Z

I am going to resolve all requested changes above as they are not to be used.

NEWS.md

R/pr.R

jcheng5 · 2021-03-01T19:00:26Z

LGTM!

* master: Un-deprecate `Plumber$run(swaggerCallback=, debug=)` and add `Plumber$run(docs=,quiet=)` (#765) Add `PlumberEndpoint$setPath(path)` (#770) Setting `plumber.docs.callback` to `NULL` will also set legacy `plumber.swagger.url` (#766) Update Hosting vignette to swap RStudio Connect and Digital Ocean (#774) Use `pak` for GHA (#771) Clarify parameters documentation on when plumber perform type conversion (#756) fix brew cask install actions (#761)

jcheng5 added 4 commits February 6, 2021 16:00

Un-deprecate run(swaggerCallback=), add run(quiet=) param

574ec13

To better support headless running scenarios

Add pr_run(quiet=), update news

b642e2e

Add unit test

b795633

Add pr_run(swaggerCallback=)

2aa507f

jcheng5 marked this pull request as ready for review February 7, 2021 00:40

schloerke added this to the v1.1.0 milestone Feb 8, 2021

schloerke requested changes Feb 11, 2021

View reviewed changes

schloerke mentioned this pull request Feb 11, 2021

Add pr_build() and pr_run_bg() commands #769

Open

2 tasks

schloerke added 4 commits February 26, 2021 10:25

Merge branch 'master' into run-headless

45536d5

* master: Add `PlumberEndpoint$setPath(path)` (#770) Setting `plumber.docs.callback` to `NULL` will also set legacy `plumber.swagger.url` (#766) Update Hosting vignette to swap RStudio Connect and Digital Ocean (#774) Use `pak` for GHA (#771)

Use rlang to leverage rlang::missing_arg() and friends

0f9de8a

Do not permanently alter router given $run() parameters

6a2af47

`debug`, `swaggerCallback`, and `docs` Add `...` and check that it is empty

Test that the router is not permanently updated by $run() parameters

fc33270

schloerke changed the title ~~Un-deprecate run(swaggerCallback=), add run(quiet=) param~~ Un-deprecate Plumber$run(swaggerCallback=, debug=) and add Plumber$run(docs=,quiet=) Feb 26, 2021

schloerke added 5 commits February 26, 2021 15:45

Pass through debug

07430f4

Delay the retrieval of debug value until run time. Provide good fallback

f43ce6c

Actually restore options altered in test

a8948f5

Test swaggerCallback option can be set after init

755b71f

Test that debug does not ask for interactive() unless it is unset

d12bd19

schloerke mentioned this pull request Feb 26, 2021

Leverage rlang in codebase #775

Open

schloerke added 5 commits March 1, 2021 10:04

Update NEWS.md

8a0240b

Use mockery package instead of global counters

8f172bc

Update test-plumber-run.R

274b530

clean up

ae6c7d8

Use testthat, not mockr

077aa53

jcheng5 commented Mar 1, 2021

View reviewed changes

NEWS.md Outdated Show resolved Hide resolved

Update NEWS.md

e32103f

jcheng5 commented Mar 1, 2021

View reviewed changes

R/pr.R Outdated Show resolved Hide resolved

Spelling

a0b0825

document

e90deca

schloerke merged commit 364fcce into master Mar 1, 2021

schloerke deleted the run-headless branch March 1, 2021 22:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Un-deprecate `Plumber$run(swaggerCallback=, debug=)` and add `Plumber$run(docs=,quiet=)` #765

Un-deprecate `Plumber$run(swaggerCallback=, debug=)` and add `Plumber$run(docs=,quiet=)` #765

jcheng5 commented Feb 7, 2021 •

edited

Loading

meztez commented Feb 7, 2021

schloerke commented Feb 8, 2021

schloerke commented Feb 11, 2021

meztez commented Feb 11, 2021

schloerke left a comment

schloerke Feb 11, 2021

schloerke Feb 11, 2021

schloerke Feb 11, 2021

schloerke Feb 11, 2021

schloerke Feb 11, 2021

schloerke Feb 11, 2021

schloerke commented Feb 26, 2021

jcheng5 commented Mar 1, 2021

		if (missing(swaggerCallback)) {
		swaggerCallback <- private$docs_callback

-      if (missing(swaggerCallback)) {
-        swaggerCallback <- private$docs_callback
+      if (lifecycle::is_present(swaggerCallback)) {
+        lifecycle::deprecate_warn("1.0.0", "run(swaggerCallback = )", "setDocsCallback(callback = )")
+        self$setDocsCallback(swaggerCallback)

	#' @param swaggerCallback An optional single-argument function that is called
	#' back with the URL to an OpenAPI user interface when one becomes ready. If
	#' missing, defaults to `$setDocsCallback()`.

		@@ -23,6 +23,8 @@ plumber 1.0.0.9999 Development version

		* OpenAPI Specification can be set using a file path. (@meztez #696)

		* Added `quiet = TRUE` to `Plumber$run()` to suppress routine startup messages. (@jcheng5 #765)

	* Added `quiet = TRUE` to `Plumber$run()` to suppress routine startup messages. (@jcheng5 #765)
	* Added `quiet = TRUE` to `pr_run()` and `Plumber$run()` to suppress routine startup messages. (@jcheng5 #765)

Un-deprecate Plumber$run(swaggerCallback=, debug=) and add Plumber$run(docs=,quiet=) #765

Un-deprecate Plumber$run(swaggerCallback=, debug=) and add Plumber$run(docs=,quiet=) #765

Conversation

jcheng5 commented Feb 7, 2021 • edited Loading

Minimal reproducible example

meztez commented Feb 7, 2021

schloerke commented Feb 8, 2021

schloerke commented Feb 11, 2021

meztez commented Feb 11, 2021

schloerke left a comment

Choose a reason for hiding this comment

schloerke Feb 11, 2021

Choose a reason for hiding this comment

schloerke Feb 11, 2021

Choose a reason for hiding this comment

schloerke Feb 11, 2021

Choose a reason for hiding this comment

schloerke Feb 11, 2021

Choose a reason for hiding this comment

schloerke Feb 11, 2021

Choose a reason for hiding this comment

schloerke Feb 11, 2021

Choose a reason for hiding this comment

schloerke commented Feb 26, 2021

jcheng5 commented Mar 1, 2021

Un-deprecate `Plumber$run(swaggerCallback=, debug=)` and add `Plumber$run(docs=,quiet=)` #765

Un-deprecate `Plumber$run(swaggerCallback=, debug=)` and add `Plumber$run(docs=,quiet=)` #765

jcheng5 commented Feb 7, 2021 •

edited

Loading