refactor: simplify inner dependences and structure for easier setup with and without fx

- add ability for clients to setup an ancla client with only `anclafx.Provide()`
- simplify calls to setup ancla without fx
- simplify inner dependences and structure

Author: denopink

anclafx/provide.go

@@ -3,7 +3,10 @@
 package anclafx
 
 import (
+	"github.com/prometheus/client_golang/prometheus"
 	"github.com/xmidt-org/ancla"
+	"github.com/xmidt-org/ancla/chrysom"
+	"github.com/xmidt-org/touchstone"
 	"go.uber.org/fx"
 )
 
@@ -12,8 +15,25 @@ const Module = "ancla"
 func Provide() fx.Option {
 	return fx.Module(
 		Module,
-		ancla.ProvideMetrics(),
-		ancla.ProvideListener(),
-		ancla.ProvideService(),
+		fx.Invoke(chrysom.ProvideStartListenerClient),
+		fx.Provide(
+			ancla.ProvideListener,
+			ancla.ProvideService,
+			chrysom.ProvideBasicClient,
+			chrysom.ProvideDefaultListenerReader,
+			chrysom.ProvideListenerClient,
+		),
+		touchstone.Gauge(
+			prometheus.GaugeOpts{
+				Name: chrysom.WebhookListSizeGaugeName,
+				Help: chrysom.WebhookListSizeGaugeHelp,
+			}),
+		touchstone.CounterVec(
+			prometheus.CounterOpts{
+				Name: chrysom.PollsTotalCounterName,
+				Help: chrysom.PollsTotalCounterHelp,
+			},
+			chrysom.OutcomeLabel,
+		),
 	)
 }

chrysom/basicClient.go

@@ -11,9 +11,11 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"time"
 
 	"github.com/xmidt-org/ancla/model"
 	"github.com/xmidt-org/sallust"
+	"go.uber.org/fx"
 	"go.uber.org/zap"
 )
 
@@ -35,6 +37,7 @@ var (
 	errReadingBodyFailure = errors.New("failed while reading http response body")
 	errJSONUnmarshal      = errors.New("failed unmarshaling JSON response payload")
 	errJSONMarshal        = errors.New("failed marshaling item as JSON payload")
+	errFailedConfig       = errors.New("ancla configuration error")
 )
 
 const (
@@ -52,18 +55,18 @@ type BasicClientConfig struct {
 	// Bucket partition to be used by this client.
 	Bucket string
 
-	// HTTPClient refers to the client that will be used to send requests.
-	// (Optional) Defaults to http.DefaultClient.
-	HTTPClient *http.Client
-
 	// Auth provides the mechanism to add auth headers to outgoing requests.
 	// (Optional) If not provided, no auth headers are added.
 	Auth Acquirer
+
+	// PullInterval is how often listeners should get updates.
+	// (Optional). Defaults to 5 seconds.
+	PullInterval time.Duration
 }
 
 // BasicClient is the client used to make requests to Argus.
 type BasicClient struct {
-	client       *http.Client
+	client       HTTPClient
 	auth         Acquirer
 	storeBaseURL string
 	bucket       string
@@ -85,22 +88,46 @@ const (
 // Items is a slice of model.Item(s) .
 type Items []model.Item
 
+type HTTPClient interface {
+	Do(*http.Request) (*http.Response, error)
+}
+
+type BasicClientIn struct {
+	fx.In
+
+	BasicClientConfig BasicClientConfig
+	// (Optional) Defaults to http.DefaultClient.
+	HTTPClient HTTPClient
+}
+
+// ProvideBasicClient provides a new BasicClient.
+func ProvideBasicClient(in BasicClientIn) (*BasicClient, error) {
+	client, err := NewBasicClient(in.BasicClientConfig, in.HTTPClient)
+	if err != nil {
+		return nil, errors.Join(errFailedConfig, err)
+	}
+
+	return client, nil
+}
+
 // NewBasicClient creates a new BasicClient that can be used to
 // make requests to Argus.
-func NewBasicClient(config BasicClientConfig) (*BasicClient, error) {
+func NewBasicClient(config BasicClientConfig, client HTTPClient) (*BasicClient, error) {
 	err := validateBasicConfig(&config)
 	if err != nil {
 		return nil, err
 	}
 
-	clientStore := &BasicClient{
-		client:       config.HTTPClient,
+	if client == nil {
+		client = http.DefaultClient
+	}
+
+	return &BasicClient{
+		client:       client,
 		auth:         config.Auth,
 		bucket:       config.Bucket,
 		storeBaseURL: config.Address + storeAPIPath,
-	}
-
-	return clientStore, nil
+	}, nil
 }
 
 // GetItems fetches all items that belong to a given owner.
@@ -254,9 +281,5 @@ func validateBasicConfig(config *BasicClientConfig) error {
 		return ErrBucketEmpty
 	}
 
-	if config.HTTPClient == nil {
-		config.HTTPClient = http.DefaultClient
-	}
-
 	return nil
 }

chrysom/basicClient_test.go

@@ -13,7 +13,6 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"testing"
-	"time"
 
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/stretchr/testify/assert"
@@ -33,20 +32,18 @@ func TestValidateBasicConfig(t *testing.T) {
 	type testCase struct {
 		Description    string
 		Input          *BasicClientConfig
+		Client         HTTPClient
 		ExpectedErr    error
 		ExpectedConfig *BasicClientConfig
 	}
 
 	allDefaultsCaseConfig := &BasicClientConfig{
-		HTTPClient: http.DefaultClient,
-		Address:    "http://awesome-argus-hostname.io",
-		Bucket:     "bucket-name",
+		Address: "http://awesome-argus-hostname.io",
+		Bucket:  "bucket-name",
 	}
-	myAmazingClient := &http.Client{Timeout: time.Hour}
 	allDefinedCaseConfig := &BasicClientConfig{
-		HTTPClient: myAmazingClient,
-		Address:    "http://legit-argus-hostname.io",
-		Bucket:     "amazing-bucket",
+		Address: "http://legit-argus-hostname.io",
+		Bucket:  "amazing-bucket",
 	}
 
 	tcs := []testCase{
@@ -75,9 +72,8 @@ func TestValidateBasicConfig(t *testing.T) {
 		{
 			Description: "All defined",
 			Input: &BasicClientConfig{
-				Address:    "http://legit-argus-hostname.io",
-				Bucket:     "amazing-bucket",
-				HTTPClient: myAmazingClient,
+				Address: "http://legit-argus-hostname.io",
+				Bucket:  "amazing-bucket",
 			},
 			ExpectedConfig: allDefinedCaseConfig,
 		},
@@ -103,6 +99,7 @@ func TestSendRequest(t *testing.T) {
 		URL              string
 		Body             []byte
 		ClientDoFails    bool
+		NilHTTPClient    bool
 		ExpectedResponse response
 		ExpectedErr      error
 		MockError        error
@@ -147,6 +144,20 @@ func TestSendRequest(t *testing.T) {
 			MockError: nil,
 			MockAuth:  "basic xyz",
 		},
+		{
+			Description: "Happy path with default http client",
+			Method:      http.MethodPut,
+			URL:         "http://argus-hostname.io",
+			Body:        []byte("testing"),
+			Owner:       "HappyCaseOwner",
+			ExpectedResponse: response{
+				Code: http.StatusOK,
+				Body: []byte("testing"),
+			},
+			MockError:     nil,
+			MockAuth:      "basic xyz",
+			NilHTTPClient: true,
+		},
 	}
 	for _, tc := range tcs {
 		t.Run(tc.Description, func(t *testing.T) {
@@ -165,11 +176,15 @@ func TestSendRequest(t *testing.T) {
 			server := httptest.NewServer(echoHandler)
 			defer server.Close()
 
+			var httpClient HTTPClient = server.Client()
+			if tc.NilHTTPClient {
+				httpClient = nil
+			}
+
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    "http://argus-hostname.io",
-				Bucket:     "bucket-name",
-			})
+				Address: "http://argus-hostname.io",
+				Bucket:  "bucket-name",
+			}, httpClient)
 
 			acquirer.On("Acquire").Return(tc.MockAuth, tc.MockError)
 			client.auth = acquirer
@@ -278,10 +293,9 @@ func TestGetItems(t *testing.T) {
 			}))
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    server.URL,
-				Bucket:     bucket,
-			})
+				Address: server.URL,
+				Bucket:  bucket,
+			}, server.Client())
 
 			require.Nil(err)
 
@@ -434,10 +448,9 @@ func TestPushItem(t *testing.T) {
 			}))
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    server.URL,
-				Bucket:     bucket,
-			})
+				Address: server.URL,
+				Bucket:  bucket,
+			}, server.Client())
 
 			acquirer.On("Acquire").Return(tc.MockAuth, tc.MockError)
 			client.auth = acquirer
@@ -547,10 +560,9 @@ func TestRemoveItem(t *testing.T) {
 			}))
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    server.URL,
-				Bucket:     bucket,
-			})
+				Address: server.URL,
+				Bucket:  bucket,
+			}, server.Client())
 
 			acquirer.On("Acquire").Return(tc.MockAuth, tc.MockError)
 			client.auth = acquirer