Merge pull request #3 from base-org/setup-archiver-api

Enable HTTP Healthcheck for Archvier

Author: danyalprout

api/flags/flags.go

@@ -12,7 +12,7 @@ const EnvVarPrefix = "BLOB_API"
 
 var (
 	ListenAddressFlag = &cli.StringFlag{
-		Name:    "api-list-address",
+		Name:    "api-listen-address",
 		Usage:   "The address to list for new requests on",
 		EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "LISTEN_ADDRESS"),
 		Value:   "0.0.0.0:8000",

archiver/cmd/main.go

@@ -66,7 +66,9 @@ func Main() cliapp.LifecycleAction {
 			return nil, err
 		}
 
+		api := service.NewAPI(m, l)
+
 		l.Info("Initializing Archiver Service")
-		return service.NewService(l, cfg, storageClient, beaconClient, m)
+		return service.NewService(l, cfg, api, storageClient, beaconClient, m)
 	}
 }

archiver/flags/config.go

@@ -18,6 +18,7 @@ type ArchiverConfig struct {
 	StorageConfig common.StorageConfig
 	PollInterval  time.Duration
 	OriginBlock   geth.Hash
+	ListenAddr    string
 }
 
 func (c ArchiverConfig) Check() error {
@@ -37,6 +38,10 @@ func (c ArchiverConfig) Check() error {
 		return fmt.Errorf("invalid origin block")
 	}
 
+	if c.ListenAddr == "" {
+		return fmt.Errorf("archiver listen address must be set")
+	}
+
 	return nil
 }
 
@@ -49,5 +54,6 @@ func ReadConfig(cliCtx *cli.Context) ArchiverConfig {
 		StorageConfig: common.NewStorageConfig(cliCtx),
 		PollInterval:  pollInterval,
 		OriginBlock:   geth.HexToHash(cliCtx.String(ArchiverOriginBlock.Name)),
+		ListenAddr:    cliCtx.String(ArchiverListenAddrFlag.Name),
 	}
 }

archiver/flags/flags.go

@@ -19,10 +19,16 @@ var (
 	}
 	ArchiverOriginBlock = &cli.StringFlag{
 		Name:     "archiver-origin-block",
-		Usage:    "The lastest block hash that the archiver will walk back to",
+		Usage:    "The latest block hash that the archiver will walk back to",
 		Required: true,
 		EnvVars:  opservice.PrefixEnvVar(EnvVarPrefix, "ORIGIN_BLOCK"),
 	}
+	ArchiverListenAddrFlag = &cli.StringFlag{
+		Name:    "archiver-listen-address",
+		Usage:   "The address to list for new requests on",
+		EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "LISTEN_ADDRESS"),
+		Value:   "0.0.0.0:8000",
+	}
 )
 
 func init() {
@@ -31,7 +37,7 @@ func init() {
 	flags = append(flags, common.CLIFlags(EnvVarPrefix)...)
 	flags = append(flags, opmetrics.CLIFlags(EnvVarPrefix)...)
 	flags = append(flags, oplog.CLIFlags(EnvVarPrefix)...)
-	flags = append(flags, ArchiverPollIntervalFlag, ArchiverOriginBlock)
+	flags = append(flags, ArchiverPollIntervalFlag, ArchiverOriginBlock, ArchiverListenAddrFlag)
 
 	Flags = flags
 }

archiver/service/archiver.go

@@ -3,6 +3,7 @@ package service
 import (
 	"context"
 	"errors"
+	"fmt"
 	"sync/atomic"
 	"time"
 
@@ -27,14 +28,15 @@ type BeaconClient interface {
 	client.BeaconBlockHeadersProvider
 }
 
-func NewService(l log.Logger, cfg flags.ArchiverConfig, dataStoreClient storage.DataStore, client BeaconClient, m metrics.Metricer) (*ArchiverService, error) {
+func NewService(l log.Logger, cfg flags.ArchiverConfig, api *API, dataStoreClient storage.DataStore, client BeaconClient, m metrics.Metricer) (*ArchiverService, error) {
 	return &ArchiverService{
 		log:             l,
 		cfg:             cfg,
 		dataStoreClient: dataStoreClient,
 		metrics:         m,
 		stopCh:          make(chan struct{}),
 		beaconClient:    client,
+		api:             api,
 	}, nil
 }
 
@@ -47,6 +49,7 @@ type ArchiverService struct {
 	metricsServer   *httputil.HTTPServer
 	cfg             flags.ArchiverConfig
 	metrics         metrics.Metricer
+	api             *API
 }
 
 func (a *ArchiverService) Start(ctx context.Context) error {
@@ -61,6 +64,13 @@ func (a *ArchiverService) Start(ctx context.Context) error {
 		a.metricsServer = srv
 	}
 
+	srv, err := httputil.StartHTTPServer(a.cfg.ListenAddr, a.api.router)
+	if err != nil {
+		return fmt.Errorf("failed to start Archiver API server: %w", err)
+	}
+
+	a.log.Info("Archiver API server started", "address", srv.Addr().String())
+
 	currentBlob, _, err := a.persistBlobsForBlockToS3(ctx, "head")
 	if err != nil {
 		a.log.Error("failed to seed archiver with initial block", "err", err)

archiver/service/archiver_test.go

@@ -21,10 +21,11 @@ func setup(t *testing.T, beacon *beacontest.StubBeaconClient) (*ArchiverService,
 	l := testlog.Logger(t, log.LvlInfo)
 	fs := storagetest.NewTestFileStorage(t, l)
 	m := metrics.NewMetrics()
+
 	svc, err := NewService(l, flags.ArchiverConfig{
 		PollInterval: 5 * time.Second,
 		OriginBlock:  blobtest.OriginBlock,
-	}, fs, beacon, m)
+	}, NewAPI(m, l), fs, beacon, m)
 	require.NoError(t, err)
 	return svc, fs
 }