Remove deadline clock in POA and replace with tokio time functions. #2109
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
Dentosal
previously approved these changes
Aug 20, 2024
xgreenx
reviewed
Aug 20, 2024
xgreenx
reviewed
Aug 20, 2024
crates/services/consensus_module/poa/src/service_test/trigger_tests.rs
Outdated
Show resolved
Hide resolved
Rewrite test to avoid being time based. Remove reset of `last_block_created` in `into_task` of POA
xgreenx
previously approved these changes
Aug 20, 2024
MitchTurner
reviewed
Aug 20, 2024
| @@ -194,6 +200,60 @@ async fn interval_trigger_produces_blocks_periodically() -> anyhow::Result<()> { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| // In case of error during block creation, the block should be retried after a delay of 1 second. | |||
| #[tokio::test(start_paused = true)] | |||
| async fn retry_block_creation_in_case_error() -> anyhow::Result<()> { | |||
There was a problem hiding this comment.
I know the other tests in this file don't do this yet, but can we add a given/when/then to clearly mark the SUT, the conditions, and the expected result?
It's not super clear here anyway, since we don't get to handle the service directly (which I would assume is the SUT here). But at least say:
given: a service that just failed to commit a block
when: we wait for 2 seconds
then: the service succeeds at committing a block
| @@ -194,6 +200,60 @@ async fn interval_trigger_produces_blocks_periodically() -> anyhow::Result<()> { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| // In case of error during block creation, the block should be retried after a delay of 1 second. | |||
| #[tokio::test(start_paused = true)] | |||
| async fn retry_block_creation_in_case_error() -> anyhow::Result<()> { | |||
There was a problem hiding this comment.
[nit]: I don't think all the comments are necessary.
For example, the comment above the test name could just be the test name. I don't mind verbose test names:
async fn service__if_commit_result_fails_then_retry_commit_result_after_trigger_durationI think the comments above the expect_commit_results are good. But a lot of the other comments are redundant.
There was a problem hiding this comment.
Ok, I removed the others comments !
xgreenx
previously approved these changes
Aug 20, 2024
xgreenx
approved these changes
Aug 20, 2024
MitchTurner
approved these changes
Aug 20, 2024
Merged
xgreenx
added a commit
that referenced
this pull request
Aug 20, 2024
## Version v0.34.0 ### Added - [2051](#2051): Add support for AWS KMS signing for the PoA consensus module. The new key can be specified with `--consensus-aws-kms AWS_KEY_ARN`. - [2092](#2092): Allow iterating by keys in rocksdb, and other storages. - [2096](#2096): GraphQL endpoint to fetch blob byte code by its blob ID. ### Changed - [2106](#2106): Remove deadline clock in POA and replace with tokio time functions. #### Breaking - [2051](#2051): Misdocumented `CONSENSUS_KEY` environ variable has been removed, use `CONSENSUS_KEY_SECRET` instead. Also raises MSRV to `1.79.0`. ### Fixed - [2106](#2106): Handle the case when nodes with overriding start on the fresh network. - [2105](#2105): Fixed the rollback functionality to work with empty gas price database. ## What's Changed * doc: refine the transaction example in the README by @mmyyrroonn in #2072 * AWS KMS block signing support and Rust 1.79 by @Dentosal in #2051 * feat(iterators): allow key-only iteration by @rymnc in #2092 * feat: graphql endpoint to fetch the blob byte code by its blob ID by @netrome in #2096 * Small improvements for tests to make them more stable by @xgreenx in #2103 * Fixed the rollback functionality to work with empty gas price database by @xgreenx in #2105 * Bump wasmtime version by @Dentosal in #2089 * Handle the case when nodes with overriding start on the fresh network by @xgreenx in #2106 * Remove deadline clock in POA and replace with tokio time functions. by @AurelienFT in #2109 ## New Contributors * @mmyyrroonn made their first contribution in #2072 **Full Changelog**: v0.33.0...v0.34.0
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.
Linked Issues/PRs
Closes #1917
Description
This PR removes the DeadlineClock structure and his usage in POA. It's replaced by a mechanism using Tokio features.
This changes avoid the service to hangs up on an error, it will now wait and retry a block production
Checklist
Before requesting review
After merging, notify other teams