Refactored base data provider according to comments

Author: UlyanaAndrukhiv

engine/access/rest/websockets/data_providers/base_provider.go

@@ -8,37 +8,23 @@ import (
 	"github.com/onflow/flow-go/engine/access/subscription"
 )
 
-// BaseDataProvider defines the basic interface for a data provider. It provides methods
-// for retrieving the provider's unique ID, topic, and a method to close the provider.
-type BaseDataProvider interface {
-	// ID returns the unique identifier of the data provider.
-	ID() uuid.UUID
-	// Topic returns the topic associated with the data provider.
-	Topic() string
-	// Close terminates the data provider.
-	Close() error
-}
-
-var _ BaseDataProvider = (*BaseDataProviderImpl)(nil)
-
-// BaseDataProviderImpl is the concrete implementation of the BaseDataProvider interface.
-// It holds common objects for the provider.
-type BaseDataProviderImpl struct {
+// baseDataProvider holds common objects for the provider
+type baseDataProvider struct {
 	id           uuid.UUID
 	topic        string
 	cancel       context.CancelFunc
 	send         chan<- interface{}
 	subscription subscription.Subscription
 }
 
-// NewBaseDataProviderImpl creates a new instance of BaseDataProviderImpl.
-func NewBaseDataProviderImpl(
+// newBaseDataProvider creates a new instance of baseDataProvider.
+func newBaseDataProvider(
 	topic string,
 	cancel context.CancelFunc,
 	send chan<- interface{},
 	subscription subscription.Subscription,
-) *BaseDataProviderImpl {
-	return &BaseDataProviderImpl{
+) *baseDataProvider {
+	return &baseDataProvider{
 		id:           uuid.New(),
 		topic:        topic,
 		cancel:       cancel,
@@ -48,17 +34,19 @@ func NewBaseDataProviderImpl(
 }
 
 // ID returns the unique identifier of the data provider.
-func (b *BaseDataProviderImpl) ID() uuid.UUID {
+func (b *baseDataProvider) ID() uuid.UUID {
 	return b.id
 }
 
 // Topic returns the topic associated with the data provider.
-func (b *BaseDataProviderImpl) Topic() string {
+func (b *baseDataProvider) Topic() string {
 	return b.topic
 }
 
 // Close terminates the data provider.
-func (b *BaseDataProviderImpl) Close() error {
+//
+// No errors are expected during normal operations.
+func (b *baseDataProvider) Close() error {
 	b.cancel()
 	return nil
 }

engine/access/rest/websockets/data_providers/block_digests_provider.go

@@ -15,7 +15,7 @@ import (
 
 // BlockDigestsDataProvider is responsible for providing block digests
 type BlockDigestsDataProvider struct {
-	*BaseDataProviderImpl
+	*baseDataProvider
 
 	logger zerolog.Logger
 	api    access.API
@@ -44,7 +44,7 @@ func NewBlockDigestsDataProvider(
 	}
 
 	subCtx, cancel := context.WithCancel(ctx)
-	p.BaseDataProviderImpl = NewBaseDataProviderImpl(
+	p.baseDataProvider = newBaseDataProvider(
 		topic,
 		cancel,
 		send,

engine/access/rest/websockets/data_providers/block_headers_provider.go

@@ -15,7 +15,7 @@ import (
 
 // BlockHeadersDataProvider is responsible for providing block headers
 type BlockHeadersDataProvider struct {
-	*BaseDataProviderImpl
+	*baseDataProvider
 
 	logger zerolog.Logger
 	api    access.API
@@ -44,7 +44,7 @@ func NewBlockHeadersDataProvider(
 	}
 
 	subCtx, cancel := context.WithCancel(ctx)
-	p.BaseDataProviderImpl = NewBaseDataProviderImpl(
+	p.baseDataProvider = newBaseDataProvider(
 		topic,
 		cancel,
 		send,

engine/access/rest/websockets/data_providers/blocks_provider.go

@@ -24,7 +24,7 @@ type BlocksArguments struct {
 
 // BlocksDataProvider is responsible for providing blocks
 type BlocksDataProvider struct {
-	*BaseDataProviderImpl
+	*baseDataProvider
 
 	logger zerolog.Logger
 	api    access.API
@@ -53,7 +53,7 @@ func NewBlocksDataProvider(
 	}
 
 	subCtx, cancel := context.WithCancel(ctx)
-	p.BaseDataProviderImpl = NewBaseDataProviderImpl(
+	p.baseDataProvider = newBaseDataProvider(
 		topic,
 		cancel,
 		send,

engine/access/rest/websockets/data_providers/data_provider.go

@@ -1,9 +1,20 @@
 package data_providers
 
+import (
+	"github.com/google/uuid"
+)
+
 // The DataProvider is the interface abstracts of the actual data provider used by the WebSocketCollector.
+// It provides methods for retrieving the provider's unique ID, topic, and a methods to close and run the provider.
 type DataProvider interface {
-	BaseDataProvider
-
+	// ID returns the unique identifier of the data provider.
+	ID() uuid.UUID
+	// Topic returns the topic associated with the data provider.
+	Topic() string
+	// Close terminates the data provider.
+	//
+	// No errors are expected during normal operations.
+	Close() error
 	// Run starts processing the subscription and handles responses.
 	//
 	// No errors are expected during normal operations.