rstudio/plumber

Add `is_running()` method

Open

#910 aberto em 29 de jun. de 2023

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)R (257 forks)batch import
difficulty: intermediateeffort: mediumhelp wanted

Métricas do repositório

Stars
 (1.437 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
O código principal do roteador do Plumber provavelmente está em uma classe R6 (por exemplo, `PlumberRouter`). Procure por um sinalizador `running` ou `active` na classe do roteador, como nos arquivos `R/plumber.R` ou `R/router.R`. A função `get current router()` pode precisar ser implementada para suportar servidores não bloqueantes. Revise os métodos existentes, como `print()` ou `run()`, para entender o gerenciamento de estado. O PR deve modificar a classe do roteador para definir um sinalizador quando `run()` for chamado e limpá lo na saída, e então adicionar o método `is running()` que verifica o sinalizador.
Pilha de tecnologia
None
Domain
apibackend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
R programmingPlumber package internalsR6 classes
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40