Differential D5659
Reword confusing warning message in RPC linter Authored by jasonbcox on Apr 2 2020, 19:25.
Details
It's easy to come across this message by simply forgetting to add an entry This patch clarifies both the intent and reason for the warning, and suggests possible fixes. Add this line to commands in src/rpc/avalanche.cpp: Add this line to the table in src/rpc/client.cpp: Example output: >>> Lint for /home/jasonbcox/projects/bitcoin-abc:
Warning (RPC_MAPPING_WARNING) RPC mapping warning
In order to keep a consistent API, arguments of the same name are
expected to either both be string-typed or converted from JSON. But there
was a conversion mismatch: ["'getavalanchekey' has argument 'nodeid' of
type 'string'", "'disconnectnode' has argument 'nodeid' of type 'JSON'"].
Common root causes for this warning: 1) The command and/or argument are
missing from the conversion table in 'src/rpc/client.cpp'. 2) Arguments
of the same name are being converted from JSON for some commands, but not
for others. Consider renaming arguments such that one name is used for
strings and the other for conversions from JSON.
Diff Detail
Event TimelineComment Actions
This should not be part of the error message. Would something like disconnectnode does X, while getavalanchekey does Y. really be too much to ask for? Also a mention of rpc/client.cpp somewhere so one doesn't need a phd is archeology to figure out what's up? Comment Actions I can fix that up some more, ya. The true/false thing is stupid. See the example message in the test plan. It indeed names rpc/client.cpp as you said. |