iotaledger / iota / 17963609663

63%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(consensus): extract `dag_state` mutation from computation (#8061)

# Description of change

This pull request refactors the `BlockManager` to improve modularity and
maintainability by extracting the block suspension logic into a new
`BlockSuspender` struct and module. The changes enhance code
organization, reduce the complexity of `BlockManager`, and make the
suspension logic more reusable and testable.

### Key Changes:
1. **New `BlockSuspender` Module/Struct**:
- Created `src/block_manager/block_suspender.rs` to encapsulate block
suspension logic, including the `SuspendedBlockHeader` struct and
methods for accepting, suspending, and un-suspending headers.
- Manages suspended block headers, missing ancestors, and missing blocks
in a dedicated `BlockSuspender` struct.

2. **BlockManager Refactoring**:
- Renamed `block_manager.rs` to `block_manager/mod.rs` to support the
new module structure with `block_suspender.rs`.
- Replaced suspension-related fields in `BlockManager`
(`suspended_block_headers`, `missing_ancestors`, `missing_blocks`) with
a single `block_suspender: BlockSuspender` field.
- Simplified `try_accept_block_headers_internal` by delegating to
`BlockSuspender::accept_or_suspend_received_headers`.
- Added `find_missing_ancestors` and
`filter_out_already_processed_and_sort` helper methods to handle block
filtering and ancestor lookup.

3. **BlockHeader Enhancements**:
- Added `PartialOrd`, `PartialEq`, `Ord`, and `Eq` derive macros to
`BlockHeader`, `BlockHeaderV1`, `SignedBlockHeader`, and
`VerifiedBlockHeader` in `block_header.rs` to ensure consistent ordering
and comparison for `BTreeMap` and `BTreeSet` operations in
`BlockSuspender`.

4. **Test Updates**:
- Added `evaluate_block_headers` helper function that evaluates which
blocks should be suspended, and which should be missing, based on a list
of `block_headers` seen so far. Used in randomized test
`test_randomized_dag_and_decision_sequence` to make sure that after each
iterat... (continued)

Run Details

352 of 362 new or added lines in 4 files covered. (97.24%)

1207 existing lines in 48 files now uncovered.

230475 of 350353 relevant lines covered (65.78%)

2387220.98 hits per line