Add a way to report rpc-errors from a plugin #562
Conversation
cminyard
force-pushed
the
add-plugin-rpc-err
branch
3 times, most recently
from
9dc4b28 to
71baf6f
Compare
cminyard
force-pushed
the
add-plugin-rpc-err
branch
from
dc066d7 to
587cea8
Compare
Add plugin_rpc_err(), which works something like clixon_err, but it saves error information from a plugin for reporting rpc-errors that need to be returned. Signed-off-by: Corey Minyard <corey@minyard.net>
The error return wasn't properly being generated in the statedata case. Signed-off-by: Corey Minyard <corey@minyard.net>
An XML version was needed, and it had much in common with the netconf_common_xml() function, so make a common XML function for generating rpc-error output. Signed-off-by: Corey Minyard <corey@minyard.net>
The handling of an error from validate_commit() for the rpc_err changes was incorrect. If cbret has data in it, use that for the return error. Signed-off-by: Corey Minyard <corey@minyard.net>
cminyard
force-pushed
the
add-plugin-rpc-err
branch
from
587cea8 to
4ef43a1
Compare
There was a lot of duplicated code, consolidate the error handling into a couple of functions. This simplifies things some, and makes the rpc_err changes less intrusive. Signed-off-by: Corey Minyard <corey@minyard.net>
Tack it on to the other transaction error tests and use the same infrastructure. Signed-off-by: Corey Minyard <corey@minyard.net>
There was a problem hiding this comment.
This is very useful, thank you for your contribution.
A final comment is that it needs documentation and examples.
Please add PR either in https://clixon-docs.readthedocs.io/en/latest/plugins.html or https://clixon-docs.readthedocs.io/en/latest/errors.html
apps/backend/backend_commit.c
Outdated
| _plugin_rpc_err_tag = n_tag; | ||
| _plugin_rpc_err_info = n_info; | ||
| _plugin_rpc_err_severity = n_severity; | ||
| _plugin_rpc_err_message = n_message; |
There was a problem hiding this comment.
How is these memory freed on exit?
If you run pattern=./test_transaction.sh ./mem.sh backend this memory is still active.
Yes, one could say that it is freed on exit anyway, but for cleanness, and detecting other memory errors, and in a remote case that one runs several handles in different threads, all heap memory should be freed before exit.
The most basic way is to make a separate free function and call it in backend_terminate().
But if you add the memory to the handle or make it generic to all plugins, it will be slightly different.
There was a problem hiding this comment.
It's now handled with clicon_data_cvec_xxx(), so it should be ok now, right? I don't see how that's freed, though.
The netconf_common_xml() was a strict subset of netconf_common_rpc_err_xml(), so just replace it. Signed-off-by: Corey Minyard <corey@minyard.net>
Move all parameter declarations to their own line. Add some missing comments. Rename cbret to xret for an cxobj. Signed-off-by: Corey Minyard <corey@minyard.net>
Get ready for moving the data into clixon_handle. Signed-off-by: Corey Minyard <corey@minyard.net>
Store it in a cvec in the clixon_data. Signed-off-by: Corey Minyard <corey@minyard.net>
It was in the backend, but it could be useful for other plugins, so move it to clixon_plugin.c Signed-off-by: Corey Minyard <corey@minyard.net>
It was checking the wrong variable. Signed-off-by: Corey Minyard <corey@minyard.net>
Add plugin_rpc_err(), which works something like clixon_err, but it saves error information from a plugin for reporting rpc-errors that need to be returned.
This is an RFC, would this be ok?