harden against API misuse
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 61
- Forks
- 35
- Avg merge
- 21m
- Merged PRs (30d)
- 2
Description
see https://github.com/rsyslog/rsyslog/issues/1822
Libfastjson API permits to access sublevel elements inside a tree, but will fail upon free of upper level elements if sub-level have been removed. This has been inherited from json-c and cannot totally be changed. However, it is often source of confusion and results in hard to find bugs.
We should try to harden the code so that it makes it easier to detect and report API misuse.
Contributor guide
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 reading the linked rsyslog issue and the libfastjson API behavior for tree sublevels and upper-level frees. Determine how removed sublevels currently lead to invalid cleanup, then define and validate a way for API misuse to be detected and reported without changing the inherited behavior more than necessary.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- api
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100