rstudio/plumber

Add `is_running()` method

Open

#910 创建于 2023年6月29日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)R (1,437 star) (257 fork)batch import
difficulty: intermediateeffort: mediumhelp wanted

描述

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.

贡献者指南

技术栈
无
领域
apibackend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
R programmingPlumber package internalsR6 classes
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
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.