core/consensus: rename ShouldRun

core/consensus/component.go

@@ -155,7 +155,7 @@ type instanceIO struct {
 
 // MarkParticipated marks the instance as participated.
 // It returns an error if the instance was already marked as participated.
-func (io *instanceIO) MarkParticipated() error {
+func (io instanceIO) MarkParticipated() error {
 	select {
 	case <-io.participated:
 		return errors.New("already participated")
@@ -168,7 +168,7 @@ func (io *instanceIO) MarkParticipated() error {
 
 // MarkProposed marks the instance as proposed.
 // It returns an error if the instance was already marked as proposed.
-func (io *instanceIO) MarkProposed() error {
+func (io instanceIO) MarkProposed() error {
 	select {
 	case <-io.proposed:
 		return errors.New("already proposed")
@@ -179,10 +179,9 @@ func (io *instanceIO) MarkProposed() error {
 	return nil
 }
 
-// ShouldRun checks the current status of the instance.
-// If the instance is not already running, it returns true and marks the instance as running.
-// It returns false if the instance is already running.
-func (io *instanceIO) ShouldRun() bool {
+// MaybeStart returns true if the instance wasn't running and has been started by this call,
+// otherwise it returns false if the instance was started in the past and is either running now or has completed.
+func (io instanceIO) MaybeStart() bool {
 	select {
 	case <-io.running:
 		return false
@@ -367,7 +366,7 @@ func (c *Component) propose(ctx context.Context, duty core.Duty, value proto.Mes
 		}
 	}()
 
-	if !inst.ShouldRun() { // Participate was already called, instance is running.
+	if !inst.MaybeStart() { // Participate was already called, instance is running.
 		return <-inst.errCh
 	}
 
@@ -392,7 +391,7 @@ func (c *Component) Participate(ctx context.Context, duty core.Duty) error {
 		return errors.Wrap(err, "participate consensus", z.Any("duty", duty))
 	}
 
-	if !inst.ShouldRun() {
+	if !inst.MaybeStart() {
 		return nil // Instance already running.
 	}
 

core/consensus/component_internal_test.go

@@ -454,14 +454,14 @@ func TestComponentHandle(t *testing.T) {
 	}
 }
 
-func TestInstanceIO_ShouldRun(t *testing.T) {
-	t.Run("ShouldRun for new instance", func(t *testing.T) {
+func TestInstanceIO_MaybeStart(t *testing.T) {
+	t.Run("MaybeStart for new instance", func(t *testing.T) {
 		inst1 := newInstanceIO()
-		require.True(t, inst1.ShouldRun())
-		require.False(t, inst1.ShouldRun())
+		require.True(t, inst1.MaybeStart())
+		require.False(t, inst1.MaybeStart())
 	})
 
-	t.Run("ShouldRun after handle", func(t *testing.T) {
+	t.Run("MaybeStart after handle", func(t *testing.T) {
 		var c Component
 		c.deadliner = testDeadliner{}
 		c.mutable.instances = make(map[core.Duty]instanceIO)
@@ -483,8 +483,8 @@ func TestInstanceIO_ShouldRun(t *testing.T) {
 
 		inst, ok := c.mutable.instances[duty]
 		require.True(t, ok)
-		require.True(t, inst.ShouldRun())
-		require.False(t, inst.ShouldRun())
+		require.True(t, inst.MaybeStart())
+		require.False(t, inst.MaybeStart())
 	})
 
 	t.Run("Call Propose after handle", func(t *testing.T) {
@@ -512,14 +512,14 @@ func TestInstanceIO_ShouldRun(t *testing.T) {
 
 		pubkey := testutil.RandomCorePubKey(t)
 
-		// Propose should internally mark instance as running by calling inst.ShouldRun().
+		// Propose should internally mark instance as running by calling inst.MaybeStart().
 		err = c.Propose(ctx, duty, core.UnsignedDataSet{pubkey: testutil.RandomCoreAttestationData(t)})
 		require.Error(t, err) // It should return an error as no peers are specified.
 
-		// Check if ShouldRun is called before.
+		// Check if MaybeStart is called before.
 		inst, ok := c.mutable.instances[duty]
 		require.True(t, ok)
-		require.False(t, inst.ShouldRun())
+		require.False(t, inst.MaybeStart())
 	})
 }