refactor: Use util::Result class for wallet loading #25722
Draft
+1,374
−818
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
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. Code Coverage & BenchmarksFor details see: https://corecheck.dev/bitcoin/bitcoin/pulls/25722. ReviewsSee the guideline for information on the review process. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
This was referenced Jul 27, 2022
ryanofsky
force-pushed
the
pr/bresult-load
branch
from
bc4172e to
a09c21c
Compare
ryanofsky
force-pushed
the
pr/bresult-load
branch
from
a09c21c to
e7457d0
Compare
Suggested by Martin Leitner-Ankerl <[email protected]> bitcoin#25722 (comment) Co-authored-by: Martin Leitner-Ankerl <[email protected]>
The util::ResultPtr class is a wrapper for util::Result providing syntax sugar to make it less awkward to use with returned pointers. Instead of needing to be deferenced twice with **result or (*result)->member, it only needs to be dereferenced once with *result or result->member. Also when it is used in a boolean context, instead of evaluating to true when there is no error and the pointer is null, it evaluates to false so it is straightforward to determine whether the result points to something. This PR is only partial a solution to bitcoin#26004 because while it makes it easier to check for null pointer values, it does not make it impossible to return a null pointer value inside a successful result. It would be possible to enforce that successful results always contain non-null pointers by using a not_null type (bitcoin#24423) in combination with ResultPtr, though.
-BEGIN VERIFY SCRIPT- git grep -l DatabaseStatus src | xargs sed -i s/DatabaseStatus/DatabaseError/g sed -i '/^ SUCCESS,$/d' src/wallet/db.h -END VERIFY SCRIPT-
ryanofsky
added a commit
to ryanofsky/bitcoin
that referenced
this pull request
Dec 6, 2024
Add util::Result support for returning warning messages and multiple errors, not just a single error string. This provides a way for functions to report errors and warnings in a standard way, and simplifies interfaces. The functionality is unit tested here, and put to use in followup PR bitcoin#25722
ryanofsky
added a commit
to ryanofsky/bitcoin
that referenced
this pull request
Dec 6, 2024
Suggested by Martin Leitner-Ankerl <[email protected]> bitcoin#25722 (comment) Co-authored-by: Martin Leitner-Ankerl <[email protected]>
ryanofsky
force-pushed
the
pr/bresult-load
branch
from
830570f to
e2376f9
Compare
This was referenced Dec 6, 2024
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.
This is based on #25665 + #26022. The non-base commits are:
7665903504c1Add temporary ResultExtract helper for porting to util::Resultc59404ce7406refactor: Use util::Result class in wallet/sqlitecf327bffdca3refactor: Use util::Result class in wallet/bdbfcb41875c379refactor: Use util::Result class in wallet/migrate5ff81d94502arefactor: Use util::Result class in wallet::MakeDatabase0afd7b55f857refactor: Use util::Result class in wallet/dump3faa53122d45refactor: Use util::Result class in wallet/salvage9319a3709b0crefactor: Use util::Result class in wallet/wallettoolda907cbf01b6refactor: Use util::Result class in wallet/walletfeace0a12121refactor: Use util::Result class in wallet/load04185045dcf2refactor: Use util::Result class in wallet/rpc3d657ccd02adrefactor: Use util::Result class in wallet/interfacesab0476db30e1refactor: Use util::Result class in wallet/testf193dfd14ebdDrop temporary ResultExtract helper for porting to util::Resulte2376f9847c8scripted-diff: replace wallet DatabaseStatus with DatabaseErrorWallet loading functions up and down the stack have lots of error and warning parameters, and return error information in different ways. This PR makes them uniformly return
util::Result, without changing behavior.