Skip to content

Commit

Permalink
Add Tests for availability enable check
Browse files Browse the repository at this point in the history
  • Loading branch information
Siddharth More authored and Siddharth More committed May 2, 2024
1 parent dc3a8a5 commit 93593e5
Show file tree
Hide file tree
Showing 9 changed files with 116 additions and 46 deletions.
16 changes: 8 additions & 8 deletions disperser/cmd/dataapi/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ type Config struct {
BLSOperatorStateRetrieverAddr string
EigenDAServiceManagerAddr string

AvailabilityCheck bool
DisperserHostname string
ChurnerHostname string
BatcherHealthEndpt string
EigenDASvcAvailabilityCheck bool
DisperserHostname string
ChurnerHostname string
BatcherHealthEndpt string

TxnTimeout time.Duration
}
Expand Down Expand Up @@ -83,10 +83,10 @@ func NewConfig(ctx *cli.Context) (Config, error) {
HTTPPort: ctx.GlobalString(flags.MetricsHTTPPort.Name),
EnableMetrics: ctx.GlobalBool(flags.EnableMetricsFlag.Name),
},
AvailabilityCheck: ctx.GlobalBool(flags.EnableAvailabilityCheckFlag.Name),
DisperserHostname: ctx.GlobalString(flags.DisperserHostnameFlag.Name),
ChurnerHostname: ctx.GlobalString(flags.ChurnerHostnameFlag.Name),
BatcherHealthEndpt: ctx.GlobalString(flags.BatcherHealthEndptFlag.Name),
EigenDASvcAvailabilityCheck: ctx.GlobalBool(flags.EnableDASvcAvailabilityCheckFlag.Name),
DisperserHostname: ctx.GlobalString(flags.DisperserHostnameFlag.Name),
ChurnerHostname: ctx.GlobalString(flags.ChurnerHostnameFlag.Name),
BatcherHealthEndpt: ctx.GlobalString(flags.BatcherHealthEndptFlag.Name),

TxnTimeout: ctx.GlobalDuration(flags.TxnTimeoutFlag.Name),
}
Expand Down
8 changes: 4 additions & 4 deletions disperser/cmd/dataapi/flags/flags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ var (
Required: true,
EnvVar: common.PrefixEnvVar(envVarPrefix, "ENABLE_METRICS"),
}
EnableAvailabilityCheckFlag = cli.BoolFlag{
Name: common.PrefixFlag(FlagPrefix, "enable-availability-check"),
Usage: "start availability check",
EnableDASvcAvailabilityCheckFlag = cli.BoolFlag{
Name: common.PrefixFlag(FlagPrefix, "enable-eigenda-svc-availability-check"),
Usage: "start eigenda services availability check",
Required: true,
EnvVar: common.PrefixEnvVar(envVarPrefix, "CHECK_AVAILABILITY"),
}
Expand Down Expand Up @@ -176,7 +176,7 @@ var requiredFlags = []cli.Flag{
AllowOriginsFlag,
EjectionTokenFlag,
EnableMetricsFlag,
EnableAvailabilityCheckFlag,
EnableDASvcAvailabilityCheckFlag,
DisperserHostnameFlag,
ChurnerHostnameFlag,
BatcherHealthEndptFlag,
Expand Down
16 changes: 8 additions & 8 deletions disperser/cmd/dataapi/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ func RunDataApi(ctx *cli.Context) error {
metrics = dataapi.NewMetrics(blobMetadataStore, config.MetricsConfig.HTTPPort, logger)
server = dataapi.NewServer(
dataapi.Config{
ServerMode: config.ServerMode,
SocketAddr: config.SocketAddr,
AllowOrigins: config.AllowOrigins,
AvailabilityCheck: config.AvailabilityCheck,
DisperserHostname: config.DisperserHostname,
ChurnerHostname: config.ChurnerHostname,
BatcherHealthEndpt: config.BatcherHealthEndpt,
EjectionToken: config.EjectionToken,
ServerMode: config.ServerMode,
SocketAddr: config.SocketAddr,
AllowOrigins: config.AllowOrigins,
DisperserHostname: config.DisperserHostname,
ChurnerHostname: config.ChurnerHostname,
BatcherHealthEndpt: config.BatcherHealthEndpt,
EjectionToken: config.EjectionToken,
EigenDASvcAvailabilityCheck: config.EigenDASvcAvailabilityCheck,
},
sharedStorage,
promClient,
Expand Down
16 changes: 8 additions & 8 deletions disperser/dataapi/config.go
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package dataapi

type Config struct {
SocketAddr string
ServerMode string
AllowOrigins []string
AvailabilityCheck bool
DisperserHostname string
ChurnerHostname string
BatcherHealthEndpt string
EjectionToken string
SocketAddr string
ServerMode string
AllowOrigins []string
DisperserHostname string
ChurnerHostname string
BatcherHealthEndpt string
EjectionToken string
EigenDASvcAvailabilityCheck bool
}
6 changes: 3 additions & 3 deletions disperser/dataapi/docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ const docTemplate = `{
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"503": {
"501": {
"description": "error: Service unavailable or checker not initialized",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
Expand Down Expand Up @@ -296,7 +296,7 @@ const docTemplate = `{
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"503": {
"501": {
"description": "error: Service unavailable or checker not initialized",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
Expand Down Expand Up @@ -340,7 +340,7 @@ const docTemplate = `{
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"503": {
"501": {
"description": "error: Service unavailable or checker not initialized",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
Expand Down
6 changes: 3 additions & 3 deletions disperser/dataapi/docs/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"503": {
"501": {
"description": "error: Service unavailable or checker not initialized",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
Expand Down Expand Up @@ -292,7 +292,7 @@
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"503": {
"501": {
"description": "error: Service unavailable or checker not initialized",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
Expand Down Expand Up @@ -336,7 +336,7 @@
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"503": {
"501": {
"description": "error: Service unavailable or checker not initialized",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
Expand Down
6 changes: 3 additions & 3 deletions disperser/dataapi/docs/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ paths:
description: 'error: Server error'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
"503":
"501":
description: 'error: Service unavailable or checker not initialized'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
Expand Down Expand Up @@ -425,7 +425,7 @@ paths:
description: 'error: Server error'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
"503":
"501":
description: 'error: Service unavailable or checker not initialized'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
Expand Down Expand Up @@ -455,7 +455,7 @@ paths:
description: 'error: Server error'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
"503":
"501":
description: 'error: Service unavailable or checker not initialized'
schema:
$ref: '#/definitions/dataapi.ErrorResponse'
Expand Down
22 changes: 14 additions & 8 deletions disperser/dataapi/server.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ func NewServer(
grpcConn = &GRPCDialerSkipTLS{}
}

if config.AvailabilityCheck {
if config.EigenDASvcAvailabilityCheck {

if eigenDAGRPCServiceChecker == nil {

Expand Down Expand Up @@ -259,7 +259,7 @@ func (s *server) Start() error {
metrics.GET("/throughput", s.FetchMetricsThroughputHandler)
metrics.GET("/non-signers", s.FetchNonSigners)
metrics.GET("/operator-nonsigning-percentage", s.FetchOperatorsNonsigningPercentageHandler)
if s.eigenDAHttpServiceChecker != nil {
if s.eigenDAHttpServiceChecker != nil && s.eigenDAGRPCServiceChecker != nil {
metrics.GET("/disperser-service-availability", s.FetchDisperserServiceAvailability)
metrics.GET("/churner-service-availability", s.FetchChurnerServiceAvailability)
metrics.GET("/batcher-service-availability", s.FetchBatcherAvailability)
Expand Down Expand Up @@ -721,12 +721,14 @@ func (s *server) OperatorPortCheck(c *gin.Context) {
// @Failure 400 {object} ErrorResponse "error: Bad request"
// @Failure 404 {object} ErrorResponse "error: Not found"
// @Failure 500 {object} ErrorResponse "error: Server error"
// @Failure 503 {object} ErrorResponse "error: Service unavailable or checker not initialized"
// @Failure 501 {object} ErrorResponse "error: Service unavailable or checker not initialized"
// @Router /metrics/disperser-service-availability [get]
func (s *server) FetchDisperserServiceAvailability(c *gin.Context) {

if s.eigenDAGRPCServiceChecker == nil {
errorResponse(c, errors.New("service availability check is not enabled"))
c.JSON(http.StatusNotImplemented, gin.H{
"error": "service availability check not enabled",
})
}

timer := prometheus.NewTimer(prometheus.ObserverFunc(func(f float64) {
Expand Down Expand Up @@ -782,12 +784,14 @@ func (s *server) FetchDisperserServiceAvailability(c *gin.Context) {
// @Failure 400 {object} ErrorResponse "error: Bad request"
// @Failure 404 {object} ErrorResponse "error: Not found"
// @Failure 500 {object} ErrorResponse "error: Server error"
// @Failure 503 {object} ErrorResponse "error: Service unavailable or checker not initialized"
// @Failure 501 {object} ErrorResponse "error: Service unavailable or checker not initialized"
// @Router /metrics/churner-service-availability [get]
func (s *server) FetchChurnerServiceAvailability(c *gin.Context) {

if s.eigenDAGRPCServiceChecker == nil {
errorResponse(c, errors.New("service availability check is not enabled"))
c.JSON(http.StatusNotImplemented, gin.H{
"error": "service availability check not enabled",
})
}

timer := prometheus.NewTimer(prometheus.ObserverFunc(func(f float64) {
Expand Down Expand Up @@ -843,12 +847,14 @@ func (s *server) FetchChurnerServiceAvailability(c *gin.Context) {
// @Failure 400 {object} ErrorResponse "error: Bad request"
// @Failure 404 {object} ErrorResponse "error: Not found"
// @Failure 500 {object} ErrorResponse "error: Server error"
// @Failure 503 {object} ErrorResponse "error: Service unavailable or checker not initialized"
// @Failure 501 {object} ErrorResponse "error: Service unavailable or checker not initialized"
// @Router /metrics/batcher-service-availability [get]
func (s *server) FetchBatcherAvailability(c *gin.Context) {

if s.eigenDAHttpServiceChecker == nil {
errorResponse(c, errors.New("service availability check is not enabled"))
c.JSON(http.StatusNotImplemented, gin.H{
"error": "service availability check is not enabled",
})
}

timer := prometheus.NewTimer(prometheus.ObserverFunc(func(f float64) {
Expand Down
66 changes: 65 additions & 1 deletion disperser/dataapi/server_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ var (
mockSubgraphApi = &subgraphmock.MockSubgraphApi{}
subgraphClient = dataapi.NewSubgraphClient(mockSubgraphApi, mockLogger)

config = dataapi.Config{ServerMode: "test", SocketAddr: ":8080", AllowOrigins: []string{"*"}, DisperserHostname: "localhost:32007", ChurnerHostname: "localhost:32009", EjectionToken: "deadbeef"}
config = dataapi.Config{ServerMode: "test", SocketAddr: ":8080", AllowOrigins: []string{"*"}, DisperserHostname: "localhost:32007", ChurnerHostname: "localhost:32009", EjectionToken: "deadbeef", EigenDASvcAvailabilityCheck: true}

mockTx = &coremock.MockTransactor{}
metrics = dataapi.NewMetrics(nil, "9001", mockLogger)
Expand Down Expand Up @@ -570,6 +570,34 @@ func TestCheckBatcherHealthExpectNotServing(t *testing.T) {
assert.Equal(t, "NOT_SERVING", serviceData.ServiceStatus)
}

func TestFetchBatcherServiceAvailabilityDisableHandler(t *testing.T) {
r := setUpRouter()
daSvcDisableConfig := dataapi.Config{ServerMode: "test", SocketAddr: ":8080", AllowOrigins: []string{"*"}, DisperserHostname: "localhost:32007", ChurnerHostname: "localhost:32009", EjectionToken: "deadbeef", EigenDASvcAvailabilityCheck: false}

testDataApiServer = dataapi.NewServer(daSvcDisableConfig, blobstore, prometheusClient, dataapi.NewSubgraphClient(mockSubgraphApi, mockLogger), mockTx, mockChainState, nil, mockLogger, metrics, nil, nil, nil)

r.GET("/v1/metrics/batcher-service-availability", testDataApiServer.FetchBatcherAvailability)

w := httptest.NewRecorder()
req := httptest.NewRequest(http.MethodGet, "/v1/metrics/batcher-service-availability", nil)
r.ServeHTTP(w, req)

res := w.Result()
defer res.Body.Close()

data, err := io.ReadAll(res.Body)
assert.NoError(t, err)

var response dataapi.ServiceAvailabilityResponse
err = json.Unmarshal(data, &response)
assert.NoError(t, err)
assert.NotNil(t, response)

fmt.Printf("Response: %v\n", response)

assert.Equal(t, http.StatusNotImplemented, res.StatusCode)
}

func TestFetchDisperserServiceAvailabilityHandler(t *testing.T) {
r := setUpRouter()

Expand Down Expand Up @@ -608,6 +636,42 @@ func TestFetchDisperserServiceAvailabilityHandler(t *testing.T) {
assert.Equal(t, grpc_health_v1.HealthCheckResponse_SERVING.String(), serviceData.ServiceStatus)
}

func TestFetchDisperserServiceAvailabilityDisableHandler(t *testing.T) {
r := setUpRouter()

mockHealthCheckService := NewMockHealthCheckService()
mockHealthCheckService.AddResponse("Disperser", &grpc_health_v1.HealthCheckResponse{
Status: grpc_health_v1.HealthCheckResponse_SERVING,
})

daSvcDisableConfig := dataapi.Config{ServerMode: "test", SocketAddr: ":8080", AllowOrigins: []string{"*"}, DisperserHostname: "localhost:32007", ChurnerHostname: "localhost:32009", EjectionToken: "deadbeef", EigenDASvcAvailabilityCheck: false}

testDataApiServer = dataapi.NewServer(daSvcDisableConfig, blobstore, prometheusClient, dataapi.NewSubgraphClient(mockSubgraphApi, mockLogger), mockTx, mockChainState, nil, mockLogger, metrics, nil, nil, nil)

r.GET("/v1/metrics/disperser-service-availability", testDataApiServer.FetchDisperserServiceAvailability)

w := httptest.NewRecorder()
req := httptest.NewRequest(http.MethodGet, "/v1/metrics/disperser-service-availability", nil)
r.ServeHTTP(w, req)

res := w.Result()
defer res.Body.Close()

data, err := io.ReadAll(res.Body)
assert.NoError(t, err)

var response dataapi.ServiceAvailabilityResponse
err = json.Unmarshal(data, &response)
assert.NoError(t, err)
assert.NotNil(t, response)

fmt.Printf("Response: %v\n", response)

assert.Equal(t, http.StatusNotImplemented, res.StatusCode)
assert.Equal(t, 0, response.Meta.Size)
assert.Equal(t, 0, len(response.Data))
}

func TestChurnerServiceAvailabilityHandler(t *testing.T) {
r := setUpRouter()

Expand Down

0 comments on commit 93593e5

Please sign in to comment.