Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APIv2(ledger_entry) : check error #4630

Merged
merged 9 commits into from
Sep 8, 2023
Merged

APIv2(ledger_entry) : check error #4630

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ea60e8c
Fix "check" field to be string as per doc
PeterChen13579 Jul 19, 2023
190d750
Merge branch 'develop' into ledgerEntryInvParams
PeterChen13579 Jul 19, 2023
467f170
Merge remote-tracking branch 'upstream/develop' into ledgerEntryInvPa…
PeterChen13579 Jul 20, 2023
1669834
Added check for "nft_page", "index" "directory"
PeterChen13579 Jul 20, 2023
faafa99
add changes in comments
PeterChen13579 Jul 26, 2023
5d05d44
quick fix
PeterChen13579 Aug 15, 2023
65b1274
Change to try/catch block
PeterChen13579 Aug 17, 2023
13c09b3
Merge branch 'develop' into ledgerEntryInvParams
intelliot Sep 7, 2023
1c8748f
Merge branch 'develop' into ledgerEntryInvParams
intelliot Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/ripple/rpc/handlers/LedgerEntry.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,12 @@ doLedgerEntry(RPC::JsonContext& context)
{
expectedType = ltCHECK;

if (!uNodeIndex.parseHex(context.params[jss::check].asString()))
if (!context.params[jss::check].isString() && context.apiVersion > 1u)
intelliot marked this conversation as resolved.
Show resolved Hide resolved
{
uNodeIndex = beast::zero;
jvResult[jss::error] = "invalidParams";
}
else if (!uNodeIndex.parseHex(context.params[jss::check].asString()))
{
uNodeIndex = beast::zero;
jvResult[jss::error] = "malformedRequest";
Expand Down
33 changes: 25 additions & 8 deletions src/test/rpc/LedgerRPC_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1226,15 +1226,32 @@ class LedgerRPC_test : public beast::unit_test::suite
// "features" is not an option supported by ledger_entry.
Json::Value jvParams;
jvParams[jss::api_version] = apiVersion;
jvParams[jss::features] = ledgerHash;
jvParams[jss::ledger_hash] = ledgerHash;
Json::Value const jrr =
env.rpc("json", "ledger_entry", to_string(jvParams))[jss::result];
{
jvParams[jss::features] = ledgerHash;
jvParams[jss::ledger_hash] = ledgerHash;
Json::Value const jrr = env.rpc(
"json", "ledger_entry", to_string(jvParams))[jss::result];

if (apiVersion < 2u)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: why is apiVersion checked with < 2u in this file compared > 1u? seems better to keep consistent throughout codebase (if most files have already established some standard)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the test file, it is specifically checking results for apiVersion < 2u and apiVersion other than that (>=2) , while in non-test files, the new error codes only execute if apiVersion is greater than 1. There is a guideline already established here:

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't have access to that doc, but thanks for elaboration. If you don't mind sharing it, my email is [email protected]

Is > 1u in non-test file equivalent to >= 2u in test file? These seem to always be equivalent expressions since it is impossible to have decimal (1.5) here, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea > 1u in non-test file is equivalent to >= 2u in test file.

checkErrorValue(jrr, "unknownOption", "");
else
checkErrorValue(jrr, "invalidParams", "");
}
// invalid check input
{
Json::Value checkParams;
checkParams[jss::owner] = "rhigTLJJyXXSRUyRCQtqi1NoAZZzZnS4KU";
checkParams[jss::ledger_index] = "validated";
jvParams[jss::check] = checkParams;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're reusing the jvParams from the previous test here, so that contains features, etc. To guarantee that you're testing what you expect to be testing, start with a new jvParams.


Json::Value const jrr = env.rpc(
"json", "ledger_entry", to_string(jvParams))[jss::result];

if (apiVersion < 2u)
checkErrorValue(jrr, "unknownOption", "");
else
checkErrorValue(jrr, "invalidParams", "");
if (apiVersion < 2u)
checkErrorValue(jrr, "internal", "Internal error.");
else
checkErrorValue(jrr, "invalidParams", "");
}
}

/// @brief ledger RPC requests as a way to drive
Expand Down