[FAB-14462] Stop eviction check when chain halts

This change set stop the eviction once-per-10-seconds check
when the chain is halted.

Change-Id: Ifa51419a731fa2ea19046e2cb1e49e60c5af4aba
Signed-off-by: yacovm <yacovm@il.ibm.com>

Author: yacovm

integration/e2e/etcdraft_reconfig_test.go

@@ -540,6 +540,7 @@ var _ = Describe("EndToEnd reconfiguration and onboarding", func() {
 			Eventually(ordererRunner.Err(), time.Minute, time.Second).Should(evictionDetection)
 
 			By("Ensuring all blocks are pulled up to the block that evicts the OSN")
+			Eventually(ordererRunner.Err(), time.Minute, time.Second).Should(gbytes.Say("Periodic check is stopping. channel=testchannel"))
 			Eventually(ordererRunner.Err(), time.Minute, time.Second).Should(gbytes.Say("Pulled all blocks up to eviction block. channel=testchannel"))
 
 			By("Killing the evicted orderer")

orderer/consensus/etcdraft/chain.go

@@ -174,6 +174,8 @@ type Chain struct {
 	logger  *flogging.FabricLogger
 
 	migrationStatus migration.Status // The consensus-type migration status
+
+	periodicChecker *PeriodicCheck
 }
 
 // NewChain constructs a chain object.
@@ -320,13 +322,13 @@ func (c *Chain) Start() {
 
 	es := c.newEvictionSuspector()
 
-	evictionFromChain := &PeriodicCheck{
+	c.periodicChecker = &PeriodicCheck{
+		Logger:        c.logger,
 		Report:        es.confirmSuspicion,
 		CheckInterval: time.Second * 10,
 		Condition:     c.suspectEviction,
 	}
-
-	evictionFromChain.Run()
+	c.periodicChecker.Run()
 }
 
 // detectMigration detects if the orderer restarts right after consensus-type migration,
@@ -781,6 +783,7 @@ func (c *Chain) serveRequest() {
 			}
 
 			c.logger.Infof("Stop serving requests")
+			c.periodicChecker.Stop()
 			return
 		}
 	}

orderer/consensus/etcdraft/util.go

@@ -11,6 +11,7 @@ import (
 	"encoding/pem"
 	"fmt"
 	"sync"
+	"sync/atomic"
 	"time"
 
 	"github.com/golang/protobuf/proto"
@@ -395,25 +396,40 @@ func ConfChange(raftMetadata *etcdraft.RaftMetadata, confState *raftpb.ConfState
 // PeriodicCheck checks periodically a condition, and reports
 // the cumulative consecutive period the condition was fulfilled.
 type PeriodicCheck struct {
+	Logger              *flogging.FabricLogger
 	CheckInterval       time.Duration
 	Condition           func() bool
 	Report              func(cumulativePeriod time.Duration)
 	conditionHoldsSince time.Time
 	once                sync.Once // Used to prevent double initialization
+	stopped             uint32
 }
 
 // Run runs the PeriodicCheck
 func (pc *PeriodicCheck) Run() {
 	pc.once.Do(pc.check)
 }
 
+// Stop stops the periodic checks
+func (pc *PeriodicCheck) Stop() {
+	pc.Logger.Info("Periodic check is stopping.")
+	atomic.AddUint32(&pc.stopped, 1)
+}
+
+func (pc *PeriodicCheck) shouldRun() bool {
+	return atomic.LoadUint32(&pc.stopped) == 0
+}
+
 func (pc *PeriodicCheck) check() {
 	if pc.Condition() {
 		pc.conditionFulfilled()
 	} else {
 		pc.conditionNotFulfilled()
 	}
 
+	if !pc.shouldRun() {
+		return
+	}
 	time.AfterFunc(pc.CheckInterval, pc.check)
 }
 

orderer/consensus/etcdraft/util_test.go

@@ -296,6 +296,7 @@ func TestPeriodicCheck(t *testing.T) {
 	}
 
 	check := &PeriodicCheck{
+		Logger:        flogging.MustGetLogger("test"),
 		Condition:     condition,
 		CheckInterval: time.Millisecond,
 		Report:        report,
@@ -346,6 +347,13 @@ func TestPeriodicCheck(t *testing.T) {
 	// so the countdown has been reset when the condition was reset
 	firstReport = <-reports
 	g.Expect(lastReport).To(gomega.BeNumerically(">", firstReport))
+	// Stop the periodic check.
+	check.Stop()
+	checkCountAfterStop := atomic.LoadUint32(&checkNum)
+	// Wait 50 times the check interval.
+	time.Sleep(check.CheckInterval * 50)
+	// Ensure that we cease checking the condition, hence the PeriodicCheck is stopped.
+	g.Expect(atomic.LoadUint32(&checkNum)).To(gomega.BeNumerically("<", checkCountAfterStop+2))
 }
 
 func TestEvictionSuspector(t *testing.T) {