rstudio/plumber

Set plumber options through env

Open

#933 opened on Nov 24, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)R (1,437 stars) (257 forks)batch import
difficulty: intermediateeffort: lowhelp wantedtype: enhancement

Description

User @slodge proposed to set plumber options through env variable.

Read an option value, if null, check for an ENV variable?

This would allow some of the API behaviors to change without redeploying code. I can see this to be useful in at least a couple scenario like activating debug with redeploying, changing secret.

Current user probably have some kind of options setting mechanism in place within their API, but it would be pretty "dope" to have it available before you know you need it.

I think this should be extended to all plumber options with a proper naming scheme like "PLUMBER_XXX_", replacing the dot in the option name with an underscore and having all caps?

Contributor guide

Tech stack
r
Domain
backendapi
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-3 hours
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.
needs investigation
Prerequisites
Basic knowledge of RFamiliarity with plumber package
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Explore plumber's option system: how options are currently set (likely via `options()` or a config file). Implement a fallback mechanism that reads an environment variable when an option is NULL. Use a naming scheme like `PLUMBER OPTION NAME` where dots are replaced with underscores (e.g., `plumber.debug` becomes `PLUMBER DEBUG`). Check the plumber source code for the list of options and consider consistency across all options. Review any user comments for additional requirements.