FIxes linting

Author: hendoxc

pkg/chipingress/batch/client.go

@@ -4,11 +4,12 @@ import (
 	"context"
 	"time"
 
-	"github.com/smartcontractkit/chainlink-common/pkg/chipingress"
 	"go.uber.org/zap"
+
+	"github.com/smartcontractkit/chainlink-common/pkg/chipingress"
 )
 
-type BatchClient struct {
+type Client struct {
 	client             chipingress.Client
 	batchSize          int
 	maxConcurrentSends chan struct{}
@@ -19,11 +20,10 @@ type BatchClient struct {
 	log                *zap.SugaredLogger
 }
 
-type Opt func(*BatchClient)
+type Opt func(*Client)
 
-func NewBatchClient(client chipingress.Client, opts ...Opt) (*BatchClient, error) {
-
-	c := &BatchClient{
+func NewBatchClient(client chipingress.Client, opts ...Opt) (*Client, error) {
+	c := &Client{
 		client:             client,
 		batchSize:          1,
 		maxConcurrentSends: make(chan struct{}, 1),
@@ -40,9 +40,8 @@ func NewBatchClient(client chipingress.Client, opts ...Opt) (*BatchClient, error
 	return c, nil
 }
 
-func (b *BatchClient) Start(ctx context.Context) {
+func (b *Client) Start(ctx context.Context) {
 	go func() {
-
 		batch := make([]*chipingress.CloudEventPb, 0, b.batchSize)
 		timer := time.NewTimer(b.batchTimeout)
 		timer.Stop()
@@ -57,7 +56,6 @@ func (b *BatchClient) Start(ctx context.Context) {
 				b.flush(batch)
 				return
 			case event := <-b.messageBuffer:
-
 				if len(batch) == 0 {
 					timer.Reset(b.batchTimeout)
 				}
@@ -81,7 +79,7 @@ func (b *BatchClient) Start(ctx context.Context) {
 	}()
 }
 
-func (b *BatchClient) Stop() {
+func (b *Client) Stop() {
 	close(b.shutdownChan)
 	// wait for pending sends by getting all semaphore slots
 	for range cap(b.maxConcurrentSends) {
@@ -92,8 +90,7 @@ func (b *BatchClient) Stop() {
 // QueueMessage queues a single message to the batch client.
 // Returns immediately with no blocking - drops message if channel is full.
 // Returns true if message was queued, false if it was dropped.
-func (b *BatchClient) QueueMessage(event *chipingress.CloudEventPb) bool {
-
+func (b *Client) QueueMessage(event *chipingress.CloudEventPb) bool {
 	if event == nil {
 		return false
 	}
@@ -106,8 +103,7 @@ func (b *BatchClient) QueueMessage(event *chipingress.CloudEventPb) bool {
 	}
 }
 
-func (b *BatchClient) sendBatch(ctx context.Context, events []*chipingress.CloudEventPb) {
-
+func (b *Client) sendBatch(ctx context.Context, events []*chipingress.CloudEventPb) {
 	if len(events) == 0 {
 		return
 	}
@@ -123,8 +119,7 @@ func (b *BatchClient) sendBatch(ctx context.Context, events []*chipingress.Cloud
 	}()
 }
 
-func (b *BatchClient) flush(batch []*chipingress.CloudEventPb) {
-
+func (b *Client) flush(batch []*chipingress.CloudEventPb) {
 	if len(batch) == 0 {
 		return
 	}
@@ -136,31 +131,31 @@ func (b *BatchClient) flush(batch []*chipingress.CloudEventPb) {
 }
 
 func WithBatchSize(batchSize int) Opt {
-	return func(c *BatchClient) {
+	return func(c *Client) {
 		c.batchSize = batchSize
 	}
 }
 
 func WithMaxConcurrentSends(maxConcurrentSends int) Opt {
-	return func(c *BatchClient) {
+	return func(c *Client) {
 		c.maxConcurrentSends = make(chan struct{}, maxConcurrentSends)
 	}
 }
 
 func WithBatchTimeout(batchTimeout time.Duration) Opt {
-	return func(c *BatchClient) {
+	return func(c *Client) {
 		c.batchTimeout = batchTimeout
 	}
 }
 
 func WithCompressionType(compressionType string) Opt {
-	return func(c *BatchClient) {
+	return func(c *Client) {
 		c.compressionType = compressionType
 	}
 }
 
 func WithMessageBuffer(messageBufferSize int) Opt {
-	return func(c *BatchClient) {
+	return func(c *Client) {
 		c.messageBuffer = make(chan *chipingress.CloudEventPb, messageBufferSize)
 	}
 }

pkg/chipingress/batch/client_test.go

@@ -6,15 +6,15 @@ import (
 	"testing"
 	"time"
 
-	"github.com/smartcontractkit/chainlink-common/pkg/chipingress"
-	"github.com/smartcontractkit/chainlink-common/pkg/chipingress/mocks"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
+
+	"github.com/smartcontractkit/chainlink-common/pkg/chipingress"
+	"github.com/smartcontractkit/chainlink-common/pkg/chipingress/mocks"
 )
 
 func TestNewBatchClient(t *testing.T) {
-
 	t.Run("NewBatchClient", func(t *testing.T) {
 		client, err := NewBatchClient(nil)
 		require.NoError(t, err)
@@ -53,9 +53,7 @@ func TestNewBatchClient(t *testing.T) {
 }
 
 func TestQueueMessage(t *testing.T) {
-
 	t.Run("successfully queues a message", func(t *testing.T) {
-
 		client, err := NewBatchClient(nil, WithMessageBuffer(5))
 		require.NoError(t, err)
 
@@ -67,7 +65,7 @@ func TestQueueMessage(t *testing.T) {
 
 		client.QueueMessage(event)
 
-		assert.Equal(t, 1, len(client.messageBuffer))
+		assert.Len(t, client.messageBuffer, 1)
 
 		received := <-client.messageBuffer
 		assert.Equal(t, event.Id, received.Id)
@@ -76,7 +74,6 @@ func TestQueueMessage(t *testing.T) {
 	})
 
 	t.Run("drops message if buffer is full", func(t *testing.T) {
-
 		client, err := NewBatchClient(nil, WithMessageBuffer(1))
 		require.NoError(t, err)
 		require.NotNil(t, client)
@@ -90,7 +87,7 @@ func TestQueueMessage(t *testing.T) {
 		client.QueueMessage(event)
 		client.QueueMessage(event)
 
-		assert.Equal(t, 1, len(client.messageBuffer))
+		assert.Len(t, client.messageBuffer, 1)
 
 		received := <-client.messageBuffer
 		assert.Equal(t, event.Id, received.Id)
@@ -103,14 +100,12 @@ func TestQueueMessage(t *testing.T) {
 		require.NoError(t, err)
 
 		client.QueueMessage(nil)
-		assert.Equal(t, 0, len(client.messageBuffer))
+		assert.Empty(t, client.messageBuffer)
 	})
 }
 
 func TestSendBatch(t *testing.T) {
-
 	t.Run("successfully sends a batch", func(t *testing.T) {
-
 		mockClient := mocks.NewClient(t)
 		done := make(chan struct{})
 
@@ -150,7 +145,6 @@ func TestSendBatch(t *testing.T) {
 	})
 
 	t.Run("doesn't publish empty batch", func(t *testing.T) {
-
 		mockClient := mocks.NewClient(t)
 
 		client, err := NewBatchClient(mockClient, WithMessageBuffer(5))
@@ -208,7 +202,6 @@ func TestSendBatch(t *testing.T) {
 }
 
 func TestStart(t *testing.T) {
-
 	t.Run("batch size trigger", func(t *testing.T) {
 		mockClient := mocks.NewClient(t)
 		done := make(chan struct{})
@@ -366,7 +359,6 @@ func TestStart(t *testing.T) {
 	})
 
 	t.Run("no flush when batch is empty", func(t *testing.T) {
-
 		mockClient := mocks.NewClient(t)
 
 		client, err := NewBatchClient(mockClient, WithBatchSize(10), WithBatchTimeout(5*time.Second))
@@ -385,7 +377,6 @@ func TestStart(t *testing.T) {
 	})
 
 	t.Run("multiple batches via size trigger", func(t *testing.T) {
-
 		mockClient := mocks.NewClient(t)
 		done := make(chan struct{})
 		callCount := 0

pkg/chipingress/go.mod

@@ -36,4 +36,5 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
+// Retracted due to initial development versions
 retract [v1.0.0, v1.0.1]