#3882 post-rustfmt cleanups #3895
Open
Conversation
This file contains hidden or 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
|
I've assigned @valentinewallace as a reviewer! |
dunxen
reviewed
Jun 27, 2025
Having tons of `.node.get_our_nod_id()` spewn across all our tests doesn't help readability, so here we replace some further cases of it with local variables in `async_signer_tests.rs`.
Having tons of `.node.get_our_nod_id()` spewn across all our tests doesn't help readability, so here we replace some further cases of it with local variables in `functional_test_utils.rs`.
Calling a macro within a method expression is somewhat annoying to read, and due to `rustfmt` expansion, calling a `handle_*` method with a `get_event_msg` macro as the second argument tends to be substantially less readable than just breaking the mess out into its own variable.
In some cases `rustfmt` makes long boolean expressions fairly difficult to parse. Here we clean up a specific case in `functional_test_utils.rs` which was recently exposed.
`rustfmt` loves to make expressions vertical by putting each method parameter on its own line. In cases where each method parameter is actually doing something, this can be fine, but in some cases we have a few method parameters that are straightforward and shouldn't be the readers focus, mixed with one or two parameters which are key. Here, we clean up a regular instance of this in calls to `check_closed_event` in `shutdown_tests.rs`. It breaks out the `ClosureReason` (the thing that usually is being tested for) from the remaining parameters, which are fairly straightforward and not the important points, leaving the rest of `check_closed_event` on one line. This also fixes some instances where `rustfmt` refused to format code entirely.
`rustfmt` loves to make expressions vertical by putting each method parameter on its own line. In cases where each method parameter is actually doing something, this can be fine, but in some cases we have a few method parameters that are straightforward and shouldn't be the readers focus, mixed with one or two parameters which are key. Here, we clean up a regular instance of this in calls to `send_payment_with_route` in `priv_short_conf_tests.rs` and `shutdown_tests.rs`. In these tests, the fact that we're sending a payment along a route picked on a previous line is important, but the specific parameters of the payment are not. Thus, condensing the calls onto a single line by breaking out some parameters into variables enables the reader to more easily skim past useless details.
`rustfmt` loves to make expressions vertical by putting each method parameter on its own line. In cases where each method parameter is actually doing something, this can be fine, but in some cases we have a few method parameters that are straightforward and shouldn't be the readers focus, mixed with one or two parameters which are key. Here, we clean up a regular instance of this in calls to `peer_connected` in `priv_short_conf_tests.rs` and `shutdown_tests.rs`. In these tests, the fact that we're reconnecting is important, but the specific features in the `Init` message are not. Thus, condensing the calls onto two lines by breaking the init message out into a variable enables the reader to more easily skim past useless details.
`rustfmt` loves to make expressions vertical by putting each method parameter or `.` subexpression on its own line. In cases where each method parameter or `.` subexpression is actually doing something, this can be fine, but in some cases we have a few method parameters that are straightforward and shouldn't be the readers focus, mixed with one or two parameters which are key or a few subexpressions which simply do rote variable indexing or locking. Here we clean up various `rustfmt` verticality that exposes unimportant details of tests and test utils, making it easier for the reader to skim past them by introducing additional variables.
The last few commits made various cleanups to some tests files, which we re-`rustfmt` here.
TheBlueMatt
force-pushed
the
2025-06-3882-followups
branch
from
4725228 to
4aa6d39
Compare
|
Ha, sorry about that. |
dunxen
approved these changes
Jun 27, 2025
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.
No description provided.