rstudio/plumber

Add ability to register a plumb block method

Open

#763 opened on Feb 5, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)R (1,437 stars) (257 forks)batch import
effort: mediumhelp wanted

Description

https://github.com/rstudio/plumber/blob/5d2070089849e05bb356537de266c2464b544a5f/R/plumb-block.R#L16-L243

☝️ has a lot of repetitive behaviors and is closed off to other developers.

It would be great if plumber (and others) could register the functions (similar to parsers and serializers) and allow them to parse a block independently.

Example:

#* @mycustomplumbertag key value value2

Thoughts:

  • Only a single line should be attempt at one time. (This is current behavior)
  • Once a block parser is a hit, the remaining block parsers should not attempted.
  • Don't know what should be supplied or be returned from the block parsers. There is a lot of global state that is currently being altered in the function above. This state should be continued throughout the block's parsing.
  • Should we be allowed to overwrite? Maybe a verbose argument? (like the parsers and serializers)
  • "block parser" or "plumb block" is a confusing name. Need a better one.

Contributor guide

Tech stack
None
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
R programmingPlumber package internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Review the linked file `R/plumb block.R` to understand the current repetitive behavior. Consider how other plumber components like parsers and serializers register functions. The issue raises questions about single line parsing, hit logic, global state, and naming; these need resolution before implementation. Look for similar registration patterns in the codebase or existing issues for guidance.