fix(load): use status endpoint to check for CommittedDepth (#456)

* fix(load): use status endpoint to check for CommittedDepth

* fix(load): use status endpoint to check for CommittedDepth

* fix(load): improve log msg

* fix(load): replace storage radius with committed depth

* fix(lint): resolve misspelled

Author: gacevicljubisa

config/config.yaml

@@ -372,7 +372,8 @@ checks:
       duration: 12h
       downloader-count: 3
       uploader-count: 2
-      max-storage-radius: 2
+      max-committed-depth: 2
+      committed-depth-check-wait: 5m
       upload-groups:
         - bee
       download-groups:

config/public-testnet.yaml

@@ -137,7 +137,8 @@ checks:
       uploader-count: 2
       downloader-count: 0
       max-use-batch: 1h
-      max-storage-radius: 3
+      max-committed-depth: 3
+      committed-depth-check-wait: 5m
       upload-groups:
         - bee-1
         - bee-2

config/staging.yaml

@@ -57,7 +57,8 @@ checks:
       uploader-count: 2
       downloader-count: 0
       max-use-batch: 1h
-      max-storage-radius: 3
+      max-committed-depth: 3
+      committed-depth-check-wait: 5m
       upload-groups:
         - bee-1
         - bee-2

pkg/bee/api/api.go

@@ -49,18 +49,19 @@ type Client struct {
 	Act         *ActService
 	Bytes       *BytesService
 	Chunks      *ChunksService
-	Files       *FilesService
 	Dirs        *DirsService
-	Pinning     *PinningService
-	Tags        *TagsService
-	PSS         *PSSService
-	SOC         *SOCService
-	Stewardship *StewardshipService
+	Feed        *FeedService
+	Files       *FilesService
 	Node        *NodeService
 	PingPong    *PingPongService
+	Pinning     *PinningService
 	Postage     *PostageService
+	PSS         *PSSService
+	SOC         *SOCService
 	Stake       *StakingService
-	Feed        *FeedService
+	Status      *StatusService
+	Stewardship *StewardshipService
+	Tags        *TagsService
 }
 
 // ClientOptions holds optional parameters for the Client.
@@ -86,21 +87,24 @@ func NewClient(baseURL *url.URL, o *ClientOptions) (c *Client) {
 func newClient(httpClient *http.Client) (c *Client) {
 	c = &Client{httpClient: httpClient}
 	c.service.client = c
+
 	c.Act = (*ActService)(&c.service)
 	c.Bytes = (*BytesService)(&c.service)
 	c.Chunks = (*ChunksService)(&c.service)
-	c.Files = (*FilesService)(&c.service)
 	c.Dirs = (*DirsService)(&c.service)
-	c.Pinning = (*PinningService)(&c.service)
-	c.Tags = (*TagsService)(&c.service)
-	c.PSS = (*PSSService)(&c.service)
-	c.SOC = (*SOCService)(&c.service)
-	c.Stewardship = (*StewardshipService)(&c.service)
+	c.Feed = (*FeedService)(&c.service)
+	c.Files = (*FilesService)(&c.service)
 	c.Node = (*NodeService)(&c.service)
 	c.PingPong = (*PingPongService)(&c.service)
+	c.Pinning = (*PinningService)(&c.service)
 	c.Postage = (*PostageService)(&c.service)
+	c.PSS = (*PSSService)(&c.service)
+	c.SOC = (*SOCService)(&c.service)
 	c.Stake = (*StakingService)(&c.service)
-	c.Feed = (*FeedService)(&c.service)
+	c.Status = (*StatusService)(&c.service)
+	c.Stewardship = (*StewardshipService)(&c.service)
+	c.Tags = (*TagsService)(&c.service)
+
 	return c
 }
 

pkg/bee/api/status.go

@@ -0,0 +1,31 @@
+package api
+
+import (
+	"context"
+	"net/http"
+)
+
+type StatusService service
+
+type StatusResponse struct {
+	Overlay                 string  `json:"overlay"`
+	Proximity               uint    `json:"proximity"`
+	BeeMode                 string  `json:"beeMode"`
+	ReserveSize             uint64  `json:"reserveSize"`
+	ReserveSizeWithinRadius uint64  `json:"reserveSizeWithinRadius"`
+	PullsyncRate            float64 `json:"pullsyncRate"`
+	StorageRadius           uint8   `json:"storageRadius"`
+	ConnectedPeers          uint64  `json:"connectedPeers"`
+	NeighborhoodSize        uint64  `json:"neighborhoodSize"`
+	RequestFailed           bool    `json:"requestFailed,omitempty"`
+	BatchCommitment         uint64  `json:"batchCommitment"`
+	IsReachable             bool    `json:"isReachable"`
+	LastSyncedBlock         uint64  `json:"lastSyncedBlock"`
+	CommittedDepth          uint8   `json:"committedDepth"`
+}
+
+// Ping pings given node
+func (s *StatusService) Status(ctx context.Context) (resp *StatusResponse, err error) {
+	err = s.client.requestJSON(ctx, http.MethodGet, "/status", nil, &resp)
+	return
+}

pkg/bee/client.go

@@ -960,3 +960,7 @@ func (c *Client) UpdateFeedWithReference(ctx context.Context, signer crypto.Sign
 func (c *Client) FindFeedUpdate(ctx context.Context, signer crypto.Signer, topic []byte, o *api.DownloadOptions) (*api.FindFeedUpdateResponse, error) {
 	return c.api.Feed.FindUpdate(ctx, signer, topic, o)
 }
+
+func (c *Client) Status(ctx context.Context) (*api.StatusResponse, error) {
+	return c.api.Status.Status(ctx)
+}

pkg/check/smoke/load.go

@@ -48,15 +48,15 @@ func (c *LoadCheck) Run(ctx context.Context, cluster orchestration.Cluster, opts
 		return errors.New("no uploaders requested, quiting")
 	}
 
-	if o.MaxStorageRadius == 0 {
-		return errors.New("max storage radius is not set")
+	if o.MaxCommittedDepth == 0 {
+		return errors.New("max committed depth is not set")
 	}
 
 	c.logger.Infof("random seed: %v", o.RndSeed)
 	c.logger.Infof("content size: %v", o.ContentSize)
 	c.logger.Infof("max batch lifespan: %v", o.MaxUseBatch)
-	c.logger.Infof("max storage radius: %v", o.MaxStorageRadius)
-	c.logger.Infof("storage radius check wait time: %v", o.StorageRadiusCheckWait)
+	c.logger.Infof("max committed depth: %v", o.MaxCommittedDepth)
+	c.logger.Infof("committed depth check wait time: %v", o.CommittedDepthCheckWait)
 
 	clients, err := cluster.NodesClients(ctx)
 	if err != nil {
@@ -116,7 +116,7 @@ func (c *LoadCheck) Run(ctx context.Context, cluster orchestration.Cluster, opts
 					default:
 					}
 
-					if !c.checkStorageRadius(ctx, test.clients[txName], o.MaxStorageRadius, o.StorageRadiusCheckWait) {
+					if !c.checkcommittedDepth(ctx, test.clients[txName], o.MaxCommittedDepth, o.CommittedDepthCheckWait) {
 						return
 					}
 
@@ -231,21 +231,21 @@ func (c *LoadCheck) Run(ctx context.Context, cluster orchestration.Cluster, opts
 	return nil
 }
 
-func (c *LoadCheck) checkStorageRadius(ctx context.Context, client *bee.Client, maxRadius uint8, wait time.Duration) bool {
+func (c *LoadCheck) checkcommittedDepth(ctx context.Context, client *bee.Client, maxDepth uint8, wait time.Duration) bool {
 	for {
-		rs, err := client.ReserveState(ctx)
+		statusResp, err := client.Status(ctx)
 		if err != nil {
 			c.logger.Infof("error getting state: %v", err)
 			return false
 		}
-		if rs.StorageRadius < maxRadius {
+		if statusResp.CommittedDepth < maxDepth {
 			return true
 		}
-		c.logger.Infof("waiting %v for StorageRadius to decrease. Current: %d, Max: %d", wait, rs.StorageRadius, maxRadius)
+		c.logger.Infof("waiting %v for CommittedDepth to decrease. Current: %d, Max: %d", wait, statusResp.CommittedDepth, maxDepth)
 
 		select {
 		case <-ctx.Done():
-			c.logger.Infof("context done in StorageRadius check: %v", ctx.Err())
+			c.logger.Infof("context done while waiting for CommittedDepth to decrease: %v", ctx.Err())
 			return false
 		case <-time.After(wait):
 		}

pkg/check/smoke/smoke.go

@@ -29,33 +29,33 @@ type Options struct {
 	UploadTimeout   time.Duration
 	DownloadTimeout time.Duration
 	// load test params
-	UploaderCount          int
-	UploadGroups           []string
-	DownloaderCount        int
-	DownloadGroups         []string
-	MaxUseBatch            time.Duration
-	MaxStorageRadius       uint8
-	StorageRadiusCheckWait time.Duration
-	IterationWait          time.Duration
+	UploaderCount           int
+	UploadGroups            []string
+	DownloaderCount         int
+	DownloadGroups          []string
+	MaxUseBatch             time.Duration
+	MaxCommittedDepth       uint8
+	CommittedDepthCheckWait time.Duration
+	IterationWait           time.Duration
 }
 
 // NewDefaultOptions returns new default options
 func NewDefaultOptions() Options {
 	return Options{
-		ContentSize:            5000000,
-		RndSeed:                time.Now().UnixNano(),
-		PostageAmount:          50_000_000,
-		PostageDepth:           24,
-		TxOnErrWait:            10 * time.Second,
-		RxOnErrWait:            10 * time.Second,
-		NodesSyncWait:          time.Minute,
-		Duration:               12 * time.Hour,
-		UploadTimeout:          60 * time.Minute,
-		DownloadTimeout:        60 * time.Minute,
-		MaxUseBatch:            12 * time.Hour,
-		MaxStorageRadius:       2,
-		StorageRadiusCheckWait: 5 * time.Minute,
-		IterationWait:          5 * time.Minute,
+		ContentSize:             5000000,
+		RndSeed:                 time.Now().UnixNano(),
+		PostageAmount:           50_000_000,
+		PostageDepth:            24,
+		TxOnErrWait:             10 * time.Second,
+		RxOnErrWait:             10 * time.Second,
+		NodesSyncWait:           time.Minute,
+		Duration:                12 * time.Hour,
+		UploadTimeout:           60 * time.Minute,
+		DownloadTimeout:         60 * time.Minute,
+		MaxUseBatch:             12 * time.Hour,
+		MaxCommittedDepth:       2,
+		CommittedDepthCheckWait: 5 * time.Minute,
+		IterationWait:           5 * time.Minute,
 	}
 }
 

pkg/config/check.go

@@ -407,22 +407,22 @@ var Checks = map[string]CheckType{
 		NewAction: smoke.NewLoadCheck,
 		NewOptions: func(checkGlobalConfig CheckGlobalConfig, check Check) (interface{}, error) {
 			checkOpts := new(struct {
-				ContentSize            *int64         `yaml:"content-size"`
-				RndSeed                *int64         `yaml:"rnd-seed"`
-				PostageAmount          *int64         `yaml:"postage-amount"`
-				PostageDepth           *uint64        `yaml:"postage-depth"`
-				GasPrice               *string        `yaml:"gas-price"`
-				TxOnErrWait            *time.Duration `yaml:"tx-on-err-wait"`
-				RxOnErrWait            *time.Duration `yaml:"rx-on-err-wait"`
-				NodesSyncWait          *time.Duration `yaml:"nodes-sync-wait"`
-				Duration               *time.Duration `yaml:"duration"`
-				UploaderCount          *int           `yaml:"uploader-count"`
-				UploadGroups           *[]string      `yaml:"upload-groups"`
-				DownloaderCount        *int           `yaml:"downloader-count"`
-				DownloadGroups         *[]string      `yaml:"download-groups"`
-				MaxUseBatch            *time.Duration `yaml:"max-use-batch"`
-				MaxStorageRadius       *uint8         `yaml:"max-storage-radius"`
-				StorageRadiusCheckWait *time.Duration `yaml:"storage-radius-check-wait"`
+				ContentSize             *int64         `yaml:"content-size"`
+				RndSeed                 *int64         `yaml:"rnd-seed"`
+				PostageAmount           *int64         `yaml:"postage-amount"`
+				PostageDepth            *uint64        `yaml:"postage-depth"`
+				GasPrice                *string        `yaml:"gas-price"`
+				TxOnErrWait             *time.Duration `yaml:"tx-on-err-wait"`
+				RxOnErrWait             *time.Duration `yaml:"rx-on-err-wait"`
+				NodesSyncWait           *time.Duration `yaml:"nodes-sync-wait"`
+				Duration                *time.Duration `yaml:"duration"`
+				UploaderCount           *int           `yaml:"uploader-count"`
+				UploadGroups            *[]string      `yaml:"upload-groups"`
+				DownloaderCount         *int           `yaml:"downloader-count"`
+				DownloadGroups          *[]string      `yaml:"download-groups"`
+				MaxUseBatch             *time.Duration `yaml:"max-use-batch"`
+				MaxCommittedDepth       *uint8         `yaml:"max-committed-depth"`
+				CommittedDepthCheckWait *time.Duration `yaml:"committed-depth-check-wait"`
 			})
 			if err := check.Options.Decode(checkOpts); err != nil {
 				return nil, fmt.Errorf("decoding check %s options: %w", check.Type, err)