feat: node is warming up

Author: acha-bill

openapi/SwarmCommon.yaml

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

pkg/api/api.go

@@ -50,10 +50,10 @@ import (
 	"github.com/ethersphere/bee/v2/pkg/settlement/swap/erc20"
 	"github.com/ethersphere/bee/v2/pkg/status"
 	"github.com/ethersphere/bee/v2/pkg/steward"
-	storage "github.com/ethersphere/bee/v2/pkg/storage"
+	"github.com/ethersphere/bee/v2/pkg/storage"
 	"github.com/ethersphere/bee/v2/pkg/storageincentives"
 	"github.com/ethersphere/bee/v2/pkg/storageincentives/staking"
-	storer "github.com/ethersphere/bee/v2/pkg/storer"
+	"github.com/ethersphere/bee/v2/pkg/storer"
 	"github.com/ethersphere/bee/v2/pkg/swarm"
 	"github.com/ethersphere/bee/v2/pkg/topology"
 	"github.com/ethersphere/bee/v2/pkg/topology/lightnode"
@@ -220,6 +220,7 @@ type Service struct {
 	redistributionAgent *storageincentives.Agent
 
 	statusService *status.Service
+	warmupTime    time.Time
 }
 
 func (s *Service) SetP2P(p2p p2p.DebugService) {
@@ -387,6 +388,10 @@ func (s *Service) SetProbe(probe *Probe) {
 	s.probe = probe
 }
 
+func (s *Service) SetWarmupTime(t time.Time) {
+	s.warmupTime = t
+}
+
 // Close hangs up running websockets on shutdown.
 func (s *Service) Close() error {
 	s.logger.Info("api shutting down")

pkg/api/api_test.go

@@ -135,6 +135,7 @@ type testServerOptions struct {
 	FullAPIDisabled     bool
 	ChequebookDisabled  bool
 	SwapDisabled        bool
+	WarmupTime          time.Duration
 }
 
 func newTestServer(t *testing.T, o testServerOptions) (*http.Client, *websocket.Conn, string, *chanStorer) {
@@ -225,6 +226,7 @@ func newTestServer(t *testing.T, o testServerOptions) (*http.Client, *websocket.
 
 	s.SetSwarmAddress(&o.Overlay)
 	s.SetProbe(o.Probe)
+	s.SetWarmupTime(time.Now().Add(o.WarmupTime))
 
 	noOpTracer, tracerCloser, _ := tracing.NewTracer(&tracing.Options{
 		Enabled: false,

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:             time.Now().Before(s.warmupTime),
 	})
 }
 

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{
@@ -67,6 +69,7 @@ func TestGetStatus(t *testing.T) {
 		client, _, _, _ := newTestServer(t, testServerOptions{
 			BeeMode:    mode,
 			NodeStatus: statusSvc,
+			WarmupTime: time.Second,
 		})
 
 		jsonhttptest.Request(t, client, http.MethodGet, url, http.StatusOK,

pkg/node/node.go

@@ -461,7 +461,7 @@ func NewBee(
 
 		apiService.Mount()
 		apiService.SetProbe(probe)
-
+		apiService.SetWarmupTime(time.Now().Add(o.WarmupTime))
 		apiService.SetSwarmAddress(&swarmAddress)
 
 		apiServer := &http.Server{