feat: add isWarmingUp to status response

Author: acha-bill

openapi/SwarmCommon.yaml

@@ -932,6 +932,8 @@ components:
           type: integer
         committedDepth:
           type: integer
+        isWarmingUp:
+          type: boolean
 
     StatusPeersResponse:
       type: object

pkg/api/status.go

@@ -31,6 +31,7 @@ type statusSnapshotResponse struct {
 	IsReachable             bool    `json:"isReachable"`
 	LastSyncedBlock         uint64  `json:"lastSyncedBlock"`
 	CommittedDepth          uint8   `json:"committedDepth"`
+	IsWarmingUp             bool    `json:"isWarmingUp"`
 }
 
 type statusResponse struct {
@@ -96,6 +97,7 @@ func (s *Service) statusGetHandler(w http.ResponseWriter, _ *http.Request) {
 		IsReachable:             ss.IsReachable,
 		LastSyncedBlock:         ss.LastSyncedBlock,
 		CommittedDepth:          uint8(ss.CommittedDepth),
+		IsWarmingUp:             ss.IsWarmingUp,
 	})
 }
 

pkg/api/status_test.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"net/http"
 	"testing"
+	"time"
 
 	"github.com/ethersphere/bee/v2/pkg/api"
 	"github.com/ethersphere/bee/v2/pkg/jsonhttp"
@@ -41,6 +42,7 @@ func TestGetStatus(t *testing.T) {
 			IsReachable:             true,
 			LastSyncedBlock:         6092500,
 			CommittedDepth:          1,
+			IsWarmingUp:             true,
 		}
 
 		ssMock := &statusSnapshotMock{
@@ -53,14 +55,7 @@ func TestGetStatus(t *testing.T) {
 			committedDepth:          ssr.CommittedDepth,
 		}
 
-		statusSvc := status.NewService(
-			log.Noop,
-			nil,
-			new(topologyPeersIterNoopMock),
-			mode.String(),
-			ssMock,
-			ssMock,
-		)
+		statusSvc := status.NewService(log.Noop, nil, new(topologyPeersIterNoopMock), mode.String(), ssMock, ssMock, time.Second)
 
 		statusSvc.SetSync(ssMock)
 
@@ -78,15 +73,8 @@ func TestGetStatus(t *testing.T) {
 		t.Parallel()
 
 		client, _, _, _ := newTestServer(t, testServerOptions{
-			BeeMode: api.DevMode,
-			NodeStatus: status.NewService(
-				log.Noop,
-				nil,
-				new(topologyPeersIterNoopMock),
-				"",
-				nil,
-				nil,
-			),
+			BeeMode:    api.DevMode,
+			NodeStatus: status.NewService(log.Noop, nil, new(topologyPeersIterNoopMock), "", nil, nil, 0),
 		})
 
 		jsonhttptest.Request(t, client, http.MethodGet, url, http.StatusBadRequest,

pkg/node/node.go

@@ -912,7 +912,7 @@ func NewBee(
 
 	validStamp := postage.ValidStamp(batchStore)
 
-	nodeStatus := status.NewService(logger, p2ps, kad, beeNodeMode.String(), batchStore, localStore)
+	nodeStatus := status.NewService(logger, p2ps, kad, beeNodeMode.String(), batchStore, localStore, warmupTime)
 	if err = p2ps.AddProtocol(nodeStatus.Protocol()); err != nil {
 		return nil, fmt.Errorf("status service: %w", err)
 	}

pkg/status/internal/pb/status.pb.go

@@ -26,4 +26,5 @@ message Snapshot {
   uint64 ReserveSizeWithinRadius = 9;
   uint64 LastSyncedBlock = 10;
   uint32 CommittedDepth = 11;
+  bool IsWarmingUp = 12;
 }

pkg/status/internal/pb/status.proto

@@ -7,6 +7,7 @@ package status
 import (
 	"context"
 	"fmt"
+	"time"
 
 	"github.com/ethersphere/bee/v2/pkg/log"
 	"github.com/ethersphere/bee/v2/pkg/p2p"
@@ -22,7 +23,7 @@ const loggerName = "status"
 
 const (
 	protocolName    = "status"
-	protocolVersion = "1.1.2"
+	protocolVersion = "1.1.3"
 	streamName      = "status"
 )
 
@@ -57,24 +58,19 @@ type Service struct {
 	reserve    Reserve
 	sync       SyncReporter
 	chainState postage.ChainStateGetter
+	warmupTime time.Time
 }
 
 // NewService creates a new status service.
-func NewService(
-	logger log.Logger,
-	streamer p2p.Streamer,
-	topology topologyDriver,
-	beeMode string,
-	chainState postage.ChainStateGetter,
-	reserve Reserve,
-) *Service {
+func NewService(logger log.Logger, streamer p2p.Streamer, topology topologyDriver, beeMode string, chainState postage.ChainStateGetter, reserve Reserve, warmupDur time.Duration) *Service {
 	return &Service{
 		logger:         logger.WithName(loggerName).Register(),
 		streamer:       streamer,
 		topologyDriver: topology,
 		beeMode:        beeMode,
 		chainState:     chainState,
 		reserve:        reserve,
+		warmupTime:     time.Now().Add(warmupDur),
 	}
 }
 
@@ -132,6 +128,7 @@ func (s *Service) LocalSnapshot() (*Snapshot, error) {
 		IsReachable:             s.topologyDriver.IsReachable(),
 		LastSyncedBlock:         s.chainState.GetChainState().Block,
 		CommittedDepth:          uint32(committedDepth),
+		IsWarmingUp:             time.Now().Before(s.warmupTime),
 	}, nil
 }
 

pkg/status/status.go

@@ -40,20 +40,13 @@ func TestStatus(t *testing.T) {
 
 	peersIterMock := new(topologyPeersIterNoopMock)
 
-	peer1 := status.NewService(
-		log.Noop,
-		nil,
-		peersIterMock,
-		want.BeeMode,
-		sssMock,
-		sssMock,
-	)
+	peer1 := status.NewService(log.Noop, nil, peersIterMock, want.BeeMode, sssMock, sssMock, 0)
 
 	peer1.SetSync(sssMock)
 
 	recorder := streamtest.New(streamtest.WithProtocols(peer1.Protocol()))
 
-	peer2 := status.NewService(log.Noop, recorder, peersIterMock, "", nil, nil)
+	peer2 := status.NewService(log.Noop, recorder, peersIterMock, "", nil, nil, 0)
 
 	address := swarm.MustParseHexAddress("ca1e9f3938cc1425c6061b96ad9eb93e134dfe8734ad490164ef20af9d1cf59c")
 
@@ -120,18 +113,11 @@ func TestStatusLightNode(t *testing.T) {
 
 	peersIterMock := new(topologyPeersIterNoopMock)
 
-	peer1 := status.NewService(
-		log.Noop,
-		nil,
-		peersIterMock,
-		want.BeeMode,
-		sssMock,
-		nil,
-	)
+	peer1 := status.NewService(log.Noop, nil, peersIterMock, want.BeeMode, sssMock, nil, 0)
 
 	recorder := streamtest.New(streamtest.WithProtocols(peer1.Protocol()))
 
-	peer2 := status.NewService(log.Noop, recorder, peersIterMock, "", nil, nil)
+	peer2 := status.NewService(log.Noop, recorder, peersIterMock, "", nil, nil, 0)
 
 	address := swarm.MustParseHexAddress("ca1e9f3938cc1425c6061b96ad9eb93e134dfe8734ad490164ef20af9d1cf59c")