renamed trace FollowerExtendCertified to trace.FollowerExtendProtocolState

Author: Alexander Hentschel

engine/common/follower/compliance_core.go

@@ -264,7 +264,7 @@ func (c *ComplianceCore) processCertifiedBlocks(ctx context.Context, blocks Cert
 
 	// Step 2 & 3: extend protocol state with connected certified blocks and forward them to consensus follower
 	for _, certifiedBlock := range connectedBlocks {
-		s, _ := c.tracer.StartBlockSpan(ctx, certifiedBlock.ID(), trace.FollowerExtendCertified)
+		s, _ := c.tracer.StartBlockSpan(ctx, certifiedBlock.ID(), trace.FollowerExtendProtocolState)
 		err = c.state.ExtendCertified(ctx, certifiedBlock.Block, certifiedBlock.QC)
 		s.End()
 		if err != nil {

module/trace/constants.go

@@ -56,7 +56,7 @@ const (
 	FollowerProcessFinalizedBlock  SpanName = "follower.processFinalizedBlock"
 	FollowerProcessCertifiedBlocks SpanName = "follower.processCertifiedBlocks"
 	FollowerExtendPendingTree      SpanName = "follower.extendPendingTree"
-	FollowerExtendCertified        SpanName = "follower.extendCertified"
+	FollowerExtendProtocolState    SpanName = "follower.extendProtocolState"
 
 	// Collection Node
 	//

state/protocol/badger/mutator.go

@@ -109,16 +109,19 @@ func NewFullConsensusState(
 //
 //	candidate.View == certifyingQC.View && candidate.ID() == certifyingQC.BlockID
 //
-// NOTE: this function expects that `certifyingQC` has been validated.
+// Caution:
+//   - This function expects that `certifyingQC` has been validated.
+//   - The parent block must already be stored.
+//
 // No errors are expected during normal operations.
 func (m *FollowerState) ExtendCertified(ctx context.Context, candidate *flow.Block, certifyingQC *flow.QuorumCertificate) error {
 	span, ctx := m.tracer.StartSpanFromContext(ctx, trace.ProtoStateMutatorHeaderExtend)
 	defer span.End()
 
-	blockID := candidate.ID()
 	// check if candidate block has been already processed
-	processed, err := m.checkBlockAlreadyProcessed(blockID)
-	if err != nil || processed {
+	blockID := candidate.ID()
+	isDuplicate, err := m.checkBlockAlreadyProcessed(blockID)
+	if err != nil || isDuplicate {
 		return err
 	}
 
@@ -163,8 +166,8 @@ func (m *ParticipantState) Extend(ctx context.Context, candidate *flow.Block) er
 	defer span.End()
 
 	// check if candidate block has been already processed
-	processed, err := m.checkBlockAlreadyProcessed(candidate.ID())
-	if err != nil || processed {
+	isDuplicate, err := m.checkBlockAlreadyProcessed(candidate.ID())
+	if err != nil || isDuplicate {
 		return err
 	}
 
@@ -256,7 +259,7 @@ func (m *FollowerState) headerExtend(candidate *flow.Block) error {
 	return nil
 }
 
-// checkBlockAlreadyProcessed checks if block with given blockID has been added to the protocol state.
+// checkBlockAlreadyProcessed checks if block has been added to the protocol state.
 // Returns:
 // * (true, nil) - block has been already processed.
 // * (false, nil) - block has not been processed.
@@ -273,7 +276,7 @@ func (m *FollowerState) checkBlockAlreadyProcessed(blockID flow.Identifier) (boo
 	return true, nil
 }
 
-// checkOutdatedExtension checks whether candidate block is
+// checkOutdatedExtension checks whether given block is
 // valid in the context of the entire state. For this, the block needs to
 // directly connect, through its ancestors, to the last finalized block.
 // Expected errors during normal operations:

state/protocol/badger/mutator_test.go

@@ -1941,8 +1941,8 @@ func TestExtendBlockProcessable(t *testing.T) {
 	})
 }
 
-// TestFollowerHeaderExtendBlockNotConnected tests adding orphan block to the finalized state
-// add 2 blocks, where:
+// TestFollowerHeaderExtendBlockNotConnected tests adding an orphaned block to the follower state.
+// Specifically, we add 2 blocks, where:
 // first block is added and then finalized;
 // second block is a sibling to the finalized block
 // The Follower should accept this block since tracking of orphan blocks is implemented by another component.
@@ -1971,8 +1971,8 @@ func TestFollowerHeaderExtendBlockNotConnected(t *testing.T) {
 	})
 }
 
-// TestParticipantHeaderExtendBlockNotConnected tests adding orphan block to the finalized state
-// add 2 blocks, where:
+// TestParticipantHeaderExtendBlockNotConnected tests adding an orphaned block to the consensus participant state.
+// Specifically, we add 2 blocks, where:
 // first block is added and then finalized;
 // second block is a sibling to the finalized block
 // The Participant should reject this block as an outdated chain extension