Fix client state test cleanup #1864
Merged
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 test `test_process_client_handling_stream_request_latest_voters_snapshot` occasionally fails currently in an inconsistent manner. This tests doesn't match the cleanup steps of the other tests. As a result it makes this test susceptible to async task scheduling differences between runs. In general the tasks being tested are considered "critical" and so such failures need to result in a `panic!` if they occur. However, with async-std's tasks such panics cannot be easily intercepted / caught, especially with how they are spawned by the program with `InternalClientMessageProcessingTask::new`. So if the channels that supply the task with the information coming in get `drop`ed and then the task attempts to consume them, a panic will result. The solution to this is to cancel the task as part of the test before the channels are dropped. This will ensure that the task itself no longer gets scheduled, and the panic is avoided.
Ayiga
requested review from
nomaxg,
philippecamacho,
ImJeremyHe,
sveitser,
jbearer,
tbro and
imabdulbasit
as code owners
|
CI run for ubuntu non-nix job: https://github.com/EspressoSystems/espresso-sequencer/actions/runs/10388163442 This doesn't run on PRs. |
sveitser
approved these changes
Aug 14, 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.
Closes #1862
This PR:
Adds a cleanup step to the
test_process_client_handling_stream_request_latest_voters_snapshotfunction in order to ensure that apanic!can be avoided in the test cleanup.