stellar#5412: moved PublisherConfig to cdp package

sreuland · Sep 25, 2024 · 68f7f43 · 68f7f43
1 parent 3414d24
commit 68f7f43
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 23 deletions.
diff --git a/ingest/cdp/producer.go b/ingest/cdp/producer.go
@@ -6,6 +6,7 @@ import (
 	"math"
 	"time"
 
+	"github.com/prometheus/client_golang/prometheus"
 	"github.com/stellar/go/ingest/ledgerbackend"
 	"github.com/stellar/go/support/datastore"
 	"github.com/stellar/go/support/errors"
@@ -50,6 +51,20 @@ func DefaultBufferedStorageBackendConfig(ledgersPerFile uint32) ledgerbackend.Bu
 	}
 }
 
+type PublisherConfig struct {
+	// Registry, optional, include to capture buffered storage backend metrics
+	Registry *prometheus.Registry
+	// RegistryNamespace, optional, include to emit buffered storage backend
+	// under this namespace
+	RegistryNamespace string
+	// BufferedStorageConfig, required
+	BufferedStorageConfig ledgerbackend.BufferedStorageBackendConfig
+	//DataStoreConfig, required
+	DataStoreConfig datastore.DataStoreConfig
+	// Log, optional, if nil uses go default logger
+	Log *log.Entry
+}
+
 // PublishFromBufferedStorageBackend is asynchronous.
 // Proceeds to create an internal instance of BufferedStorageBackend
 // using provided configs and emit ledgers asynchronously to the provided
@@ -76,7 +91,7 @@ func DefaultBufferedStorageBackendConfig(ledgersPerFile uint32) ledgerbackend.Bu
 // is unbounded, then the channel is never closed until an error
 // or caller cancels.
 func PublishFromBufferedStorageBackend(ledgerRange ledgerbackend.Range,
-	publisherConfig ledgerbackend.PublisherConfig,
+	publisherConfig PublisherConfig,
 	ctx context.Context,
 	callback func(xdr.LedgerCloseMeta) error) chan error {
 

diff --git a/ingest/cdp/producer_test.go b/ingest/cdp/producer_test.go
@@ -55,7 +55,7 @@ func TestBSBProducerFn(t *testing.T) {
 	ledgerRange := ledgerbackend.BoundedRange(startLedger, endLedger)
 	mockDataStore := createMockdataStore(t, startLedger, endLedger, 64000)
 	dsConfig := datastore.DataStoreConfig{}
-	pubConfig := ledgerbackend.PublisherConfig{
+	pubConfig := PublisherConfig{
 		DataStoreConfig:       dsConfig,
 		BufferedStorageConfig: DefaultBufferedStorageBackendConfig(1),
 	}
@@ -107,7 +107,7 @@ func TestBSBProducerFn(t *testing.T) {
 func TestBSBProducerFnDataStoreError(t *testing.T) {
 	ctx := context.Background()
 	ledgerRange := ledgerbackend.BoundedRange(uint32(2), uint32(3))
-	pubConfig := ledgerbackend.PublisherConfig{
+	pubConfig := PublisherConfig{
 		DataStoreConfig:       datastore.DataStoreConfig{},
 		BufferedStorageConfig: ledgerbackend.BufferedStorageBackendConfig{},
 	}
@@ -141,7 +141,7 @@ func TestBSBProducerFnDataStoreError(t *testing.T) {
 func TestBSBProducerFnConfigError(t *testing.T) {
 	ctx := context.Background()
 	ledgerRange := ledgerbackend.BoundedRange(uint32(2), uint32(3))
-	pubConfig := ledgerbackend.PublisherConfig{
+	pubConfig := PublisherConfig{
 		DataStoreConfig:       datastore.DataStoreConfig{},
 		BufferedStorageConfig: ledgerbackend.BufferedStorageBackendConfig{},
 	}
@@ -173,7 +173,7 @@ func TestBSBProducerFnConfigError(t *testing.T) {
 
 func TestBSBProducerFnInvalidRange(t *testing.T) {
 	ctx := context.Background()
-	pubConfig := ledgerbackend.PublisherConfig{
+	pubConfig := PublisherConfig{
 		DataStoreConfig:       datastore.DataStoreConfig{},
 		BufferedStorageConfig: DefaultBufferedStorageBackendConfig(1),
 	}
@@ -210,7 +210,7 @@ func TestBSBProducerFnInvalidRange(t *testing.T) {
 
 func TestBSBProducerFnGetLedgerError(t *testing.T) {
 	ctx := context.Background()
-	pubConfig := ledgerbackend.PublisherConfig{
+	pubConfig := PublisherConfig{
 		DataStoreConfig:       datastore.DataStoreConfig{},
 		BufferedStorageConfig: DefaultBufferedStorageBackendConfig(1),
 	}
@@ -252,7 +252,7 @@ func TestBSBProducerFnGetLedgerError(t *testing.T) {
 
 func TestBSBProducerFnCallbackError(t *testing.T) {
 	ctx := context.Background()
-	pubConfig := ledgerbackend.PublisherConfig{
+	pubConfig := PublisherConfig{
 		DataStoreConfig:       datastore.DataStoreConfig{},
 		BufferedStorageConfig: DefaultBufferedStorageBackendConfig(1),
 	}

diff --git a/ingest/ledgerbackend/buffered_storage_backend.go b/ingest/ledgerbackend/buffered_storage_backend.go
@@ -9,10 +9,8 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
-	"github.com/prometheus/client_golang/prometheus"
 
 	"github.com/stellar/go/support/datastore"
-	"github.com/stellar/go/support/log"
 	"github.com/stellar/go/xdr"
 )
 
@@ -66,20 +64,6 @@ func NewBufferedStorageBackend(config BufferedStorageBackendConfig, dataStore da
 	return bsBackend, nil
 }
 
-type PublisherConfig struct {
-	// Registry, optional, include to capture buffered storage backend metrics
-	Registry *prometheus.Registry
-	// RegistryNamespace, optional, include to emit buffered storage backend
-	// under this namespace
-	RegistryNamespace string
-	// BufferedStorageConfig, required
-	BufferedStorageConfig BufferedStorageBackendConfig
-	//DataStoreConfig, required
-	DataStoreConfig datastore.DataStoreConfig
-	// Log, optional, if nil uses go default logger
-	Log *log.Entry
-}
-
 // GetLatestLedgerSequence returns the most recent ledger sequence number available in the buffer.
 func (bsb *BufferedStorageBackend) GetLatestLedgerSequence(ctx context.Context) (uint32, error) {
 	bsb.bsBackendLock.RLock()