rstudio/plumber

Add `is_running()` method

Open

#910 opened on Jun 29, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)R (1,437 stars) (257 forks)batch import
difficulty: intermediateeffort: mediumhelp wanted

Description

From @nbenn in https://community.rstudio.com/t/determine-whether-code-is-being-run-as-part-of-a-plumber-api/169128

I am looking for a reliable way of determining if code is being run "under" plumber. Something like what I believe shiny::isRunning() provides.

Thanks!

I'd like for it to take pr as a value and have it default to something like get_current_router() (or something) that possibly returns the currently running server and checks for a flag.

Could also have a method to return currently running plumber routers (if non-blocking) is implemented. And then the length of the routers could be checked for > 0.

Contributor guide

Tech stack
None
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
R programmingPlumber package internalsR6 classes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The core code for Plumber's router is likely in an R6 class (e.g., `PlumberRouter`). Look for a `running` or `active` flag in the router class, such as in `R/plumber.R` or `R/router.R`. The `get current router()` function may need to be implemented to support non blocking servers. Review existing methods like `print()` or `run()` to understand state management. The PR should modify the router class to set a flag when `run()` is called and clear it on exit, then add `is running()` method that checks the flag.