varnish / varnish/libvmod-tinykvm
Simplify the callback APIs
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 12
- Forks
- 2
- Avg merge
- 1h 9m
- Merged PRs (30d)
- 1
Description
The callback API is currently consuming extra codespace. I want to remove some of it to keep only the request-based APIs. There is currently an on_get, an on_post and an on_request callback. The simplified version is to only keep on_request which covers both on_get and on_post. Typical simple programs would actually use on_get and on_post differently but adding features and making sure that everything works is harder when there so many codepaths.
A lot of documentation and tests are depending on the "old" API though, so this one will have to be slow and sure.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the callback API definitions and all documentation and tests that reference on_get, on_post, and on_request. Review how each callback is used before changing anything. Done means the API keeps only on_request, documentation and tests no longer depend on the old callbacks, and the full test suite passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100