Make our JSON APIs a public interface sd-json.h #32628
Conversation
|
This is v257 material, in case this wasn't clear. |
github-actions
bot
added
udev
network
journal
nspawn
resolve
login
documentation
systemctl
build-system
tests
sd-boot/sd-stub/bootctl
coredump
sleep
meson
hibernate-resume
busctl
repart
userdb
tpm2
sysupdate
vmspawn
nsresource
mountfsd
please-review
|
Important An -rc1 tag has been created and a release is being prepared, so please note that PRs introducing new features and APIs will be held back until the new version has been released. |
yuwata
added
the
ci-fails/needs-rework 🔥
github-actions
bot
removed
the
ci-fails/needs-rework 🔥
bluca
added
ci-fails/needs-rework 🔥
|
Code coverage at 81% is good, but there's a few spots missing that looks like should be covered: Could you please add unit tests to cover these? Then test-wise we should be in a good spot. https://coveralls.io/builds/67280970/source?filename=src%2Fshared%2Fjson.c#L3354 |
github-actions
bot
added
please-review
Sure, here you go |
nice - mind splitting that out in a separate PR? It can be merged immediately then |
too lazy for that. all the symbols changed names. |
bluca
added
ci-fails/needs-rework 🔥
github-actions
bot
added
please-review
The functions more or less do the same thing. Merge them. This makes json_dispatch_path() the common resulting implementation. it learnt: 1. Will reset the path to NULL if specified as null in JSON 2. Depending on the JSON_SAFE flag will insist on normalized path or not With this the two implementations are identical, except for the differences now toggable via JSON_SAFE flag
This is preparation for making our Varlink API a public API. Since our Varlink API is built on top of our JSON API we need to make that public first (it's a nice API, but JSON APIs there are already enough, this is purely about the Varlink angle). I made most of the json.h APIs public, and just placed them in sd-json.h. Sometimes I wasn't so sure however, since the underlying data structures would have to be made public too. If in doubt I didn#t risk it, and moved the relevant API to src/libsystemd/sd-json/json-util.h instead (without any sd_* symbol prefixes). This is mostly a giant search/replace patch.
The flag is fairly generic these days and just selects a slightly stricter validation, with details depending on the selected dispatch function. Hence, let's give it more precise name, in particular one that mirrors the SD_JSON_RELAXED flag nicely (which does the opposite: relaxes parsing)
This is preparation for making our Varlink API a public API. Since our Varlink API is built on top of our JSON API we need to make that public first (it's a nice API, but JSON APIs there are already enough, this is purely about the Varlink angle).