rstudio/plumber

Add `is_running()` method

Open

#910 ouverte le 29 juin 2023

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)R (257 forks)batch import
difficulty: intermediateeffort: mediumhelp wanted

Métriques du dépôt

Stars
 (1 437 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Le code principal du routeur de Plumber se trouve probablement dans une classe R6 (par exemple `PlumberRouter`). Cherchez un indicateur `running` ou `active` dans la classe du routeur, par exemple dans les fichiers `R/plumber.R` ou `R/router.R`. La fonction `get current router()` devra peut être être implémentée pour prendre en charge les serveurs non bloquants. Examinez les méthodes existantes comme `print()` ou `run()` pour comprendre la gestion de l'état. La PR doit modifier la classe du routeur pour définir un indicateur lorsque `run()` est appelé et le réinitialiser à la sortie, puis ajouter la méthode `is running()` qui vérifie cet indicateur.
Stack technique
Aucun
Domaine
apibackend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
R programmingPlumber package internalsR6 classes
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40