major refactor of ledger_entry source code and tests
#5237
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #5237 +/- ##
=========================================
+ Coverage 77.9% 78.1% +0.3%
=========================================
Files 791 791
Lines 68006 67658 -348
Branches 8352 8205 -147
=========================================
- Hits 52962 52861 -101
+ Misses 15044 14797 -247
... and 27 files with indirect coverage changes |
mvadari
force-pushed
the
refactor-ledger-entry2
branch
10 times, most recently
from
6008f56 to
ee2b76f
Compare
oleks-rip
reviewed
Jan 22, 2025
| @@ -672,7 +672,8 @@ Value::isConvertibleTo(ValueType other) const | |||
| (other == intValue && value_.real_ >= minInt && | |||
| value_.real_ <= maxInt) || | |||
| (other == uintValue && value_.real_ >= 0 && | |||
| value_.real_ <= maxUInt) || | |||
| value_.real_ <= maxUInt && | |||
| static_cast<int>(value_.real_) == value_.real_) || | |||
There was a problem hiding this comment.
You should avoid using == with float point. Consider something like std::fabs(round(value_.real_) - value_.real_) < 1e-10
oleks-rip
reviewed
Jan 22, 2025
| @@ -385,20 +385,23 @@ ledgerFromRequest(T& ledger, JsonContext& context) | |||
| return getLedger(ledger, ledgerHash, context); | |||
| } | |||
|
|
|||
| auto const index = indexValue.asString(); | |||
| if (indexValue.isConvertibleTo(Json::stringValue)) | |||
There was a problem hiding this comment.
Do we support both forms index: 3 and index: "3" ?
oleks-rip
reviewed
Jan 22, 2025
| std::uint32_t iVal; | ||
| if (beast::lexicalCastChecked(iVal, index)) | ||
| return getLedger(ledger, iVal, context); | ||
| std::uint32_t iVal; |
oleks-rip
reviewed
Jan 22, 2025
| @@ -36,820 +37,591 @@ | |||
|
|
|||
| namespace ripple { | |||
|
|
|||
| static STArray | |||
| parseAuthorizeCredentials(Json::Value const& jv) | |||
| static Expected<uint256, Json::Value> | |||
There was a problem hiding this comment.
The moving of the functions makes this change near impossible to review. Consider to make as few differences as possible. Could you please add the new functions to the end of the file and use forward declaration when you need them.
mvadari
force-pushed
the
refactor-ledger-entry2
branch
from
ee2b76f to
d895d4a
Compare
mvadari
force-pushed
the
refactor-ledger-entry2
branch
from
d895d4a to
29c7ef9
Compare
mvadari
force-pushed
the
refactor-ledger-entry2
branch
from
29c7ef9 to
72ed5e2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
High Level Overview of Change
This PR is a major refactor of
LedgerEntry.cpp. It adds a number of helper functions to make the code easier to maintain.It also splits up the
ledgerandledger_entrytests into different files, and cleans up theledger_entrytests to make them easier to write and maintain.This refactor also caught a few bugs in some of the other RPC processing, so those are fixed along the way.
Context of Change
The
ledger_entrycode wasn't very readable and was hard to extend whenever a new ledger type was created.Type of Change
API Impact
There are some error code changes. They are made as minimal as possible. The test changes should make it clear what the error code changes are.
Notes for Reviewers
The code has been cleaned up into 3 commits. Reviewing will probably be easier if these commits are reviewed separately, as the overall diff for the tests is very difficult to follow.
ledgerandledger_entrytests are split up, and theledger_entrytests are all moved toLedgerEntry_test.cpp. No actual code changes, just moving code around.Test Plan
Tests pass and have better coverage.