rstudio/plumber

Add `is_running()` method

Open

#910 geöffnet am 29. Juni 2023

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)R (257 Forks)batch import
difficulty: intermediateeffort: mediumhelp wanted

Repository-Metriken

Stars
 (1.437 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Der Kerncode für den Router von Plumber befindet sich wahrscheinlich in einer R6 Klasse (z. B. `PlumberRouter`). Suchen Sie nach einem `running` oder `active` Flag in der Router Klasse, z. B. in den Dateien `R/plumber.R` oder `R/router.R`. Die Funktion `get current router()` muss möglicherweise implementiert werden, um nicht blockierende Server zu unterstützen. Überprüfen Sie vorhandene Methoden wie `print()` oder `run()`, um die Zustandsverwaltung zu verstehen. Der PR sollte die Router Klasse so ändern, dass ein Flag gesetzt wird, wenn `run()` aufgerufen wird, und bei Beendigung gelöscht wird, und dann die Methode `is running()` hinzufügen, die das Flag überprüft.
Tech Stack
Keine
Domain
apibackend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
R programmingPlumber package internalsR6 classes
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40