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

@@ -4,6 +4,7 @@ package anclafx
 
 import (
 	"github.com/xmidt-org/ancla"
+	"github.com/xmidt-org/ancla/chrysom"
 	"go.uber.org/fx"
 )
 
@@ -12,8 +13,14 @@ 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,
+		),
+		chrysom.ProvideMetrics(),
 	)
 }

anclafx/provide_test.go

@@ -0,0 +1,62 @@
+// SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC
+// SPDX-License-Identifier: Apache-2.0
+package anclafx_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"github.com/xmidt-org/ancla"
+	"github.com/xmidt-org/ancla/anclafx"
+	"github.com/xmidt-org/ancla/chrysom"
+	"github.com/xmidt-org/sallust"
+	"github.com/xmidt-org/touchstone"
+	"go.uber.org/fx"
+	"go.uber.org/fx/fxtest"
+)
+
+type out struct {
+	fx.Out
+
+	Factory           *touchstone.Factory
+	BasicClientConfig chrysom.BasicClientConfig
+}
+
+func provideDefaults() (out, error) {
+	cfg := touchstone.Config{
+		DefaultNamespace: "n",
+		DefaultSubsystem: "s",
+	}
+	_, pr, err := touchstone.New(cfg)
+	if err != nil {
+		return out{}, err
+	}
+
+	return out{
+		Factory: touchstone.NewFactory(cfg, sallust.Default(), pr),
+		BasicClientConfig: chrysom.BasicClientConfig{
+			Address: "example.com",
+			Bucket:  "bucket-name",
+		},
+	}, nil
+}
+
+func TestProvide(t *testing.T) {
+	t.Run("Test anclafx.Provide() defaults", func(t *testing.T) {
+		var svc *ancla.ClientService
+		app := fxtest.New(t,
+			anclafx.Provide(),
+			fx.Provide(
+				provideDefaults,
+			),
+			fx.Populate(&svc),
+		)
+
+		require := require.New(t)
+		require.NotNil(app)
+		require.NoError(app.Err())
+		app.RequireStart()
+		require.NotNil(svc)
+		app.RequireStop()
+	})
+}

chrysom/basicClient.go

@@ -11,8 +11,10 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"time"
 
 	"github.com/xmidt-org/ancla/model"
+	"github.com/xmidt-org/arrange/arrangehttp"
 	"github.com/xmidt-org/sallust"
 	"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,13 +55,16 @@ 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
+	HTTPClient arrangehttp.ClientConfig
 
 	// 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.
@@ -85,6 +91,16 @@ const (
 // Items is a slice of model.Item(s) .
 type Items []model.Item
 
+// ProvideBasicClient provides a new BasicClient.
+func ProvideBasicClient(config BasicClientConfig) (*BasicClient, error) {
+	client, err := NewBasicClient(config)
+	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) {
@@ -93,14 +109,17 @@ func NewBasicClient(config BasicClientConfig) (*BasicClient, error) {
 		return nil, err
 	}
 
-	clientStore := &BasicClient{
-		client:       config.HTTPClient,
+	client, err := config.HTTPClient.NewClient()
+	if err != nil {
+		return nil, err
+	}
+
+	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 +273,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         *http.Client
 		ExpectedErr    error
 		ExpectedConfig *BasicClientConfig
 	}
 
 	allDefaultsCaseConfig := &BasicClientConfig{
-		HTTPClient: http.DefaultClient,
-		Address:    "http://awesome-argus-hostname.io",
-		Bucket:     "bucket-name",
+		Address: "example.com",
+		Bucket:  "bucket-name",
 	}
-	myAmazingClient := &http.Client{Timeout: time.Hour}
 	allDefinedCaseConfig := &BasicClientConfig{
-		HTTPClient: myAmazingClient,
-		Address:    "http://legit-argus-hostname.io",
-		Bucket:     "amazing-bucket",
+		Address: "example.com",
+		Bucket:  "amazing-bucket",
 	}
 
 	tcs := []testCase{
@@ -60,24 +57,23 @@ func TestValidateBasicConfig(t *testing.T) {
 		{
 			Description: "No bucket",
 			Input: &BasicClientConfig{
-				Address: "http://awesome-argus-hostname.io",
+				Address: "example.com",
 			},
 			ExpectedErr: ErrBucketEmpty,
 		},
 		{
 			Description: "All default values",
 			Input: &BasicClientConfig{
-				Address: "http://awesome-argus-hostname.io",
+				Address: "example.com",
 				Bucket:  "bucket-name",
 			},
 			ExpectedConfig: allDefaultsCaseConfig,
 		},
 		{
 			Description: "All defined",
 			Input: &BasicClientConfig{
-				Address:    "http://legit-argus-hostname.io",
-				Bucket:     "amazing-bucket",
-				HTTPClient: myAmazingClient,
+				Address: "example.com",
+				Bucket:  "amazing-bucket",
 			},
 			ExpectedConfig: allDefinedCaseConfig,
 		},
@@ -113,15 +109,15 @@ func TestSendRequest(t *testing.T) {
 		{
 			Description: "New Request fails",
 			Method:      "what method?",
-			URL:         "http://argus-hostname.io",
+			URL:         "example.com",
 			ExpectedErr: errNewRequestFailure,
 			MockAuth:    "",
 			MockError:   nil,
 		},
 		{
 			Description: "Auth acquirer fails",
 			Method:      http.MethodGet,
-			URL:         "http://argus-hostname.io",
+			URL:         "example.com",
 			MockError:   errFails,
 			MockAuth:    "",
 			ExpectedErr: ErrAuthAcquirerFailure,
@@ -137,7 +133,20 @@ func TestSendRequest(t *testing.T) {
 		{
 			Description: "Happy path",
 			Method:      http.MethodPut,
-			URL:         "http://argus-hostname.io",
+			URL:         "example.com",
+			Body:        []byte("testing"),
+			Owner:       "HappyCaseOwner",
+			ExpectedResponse: response{
+				Code: http.StatusOK,
+				Body: []byte("testing"),
+			},
+			MockError: nil,
+			MockAuth:  "basic xyz",
+		},
+		{
+			Description: "Happy path with default http client",
+			Method:      http.MethodPut,
+			URL:         "example.com",
 			Body:        []byte("testing"),
 			Owner:       "HappyCaseOwner",
 			ExpectedResponse: response{
@@ -166,17 +175,16 @@ func TestSendRequest(t *testing.T) {
 			defer server.Close()
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    "http://argus-hostname.io",
-				Bucket:     "bucket-name",
+				Address: "example.com",
+				Bucket:  "bucket-name",
 			})
 
 			acquirer.On("Acquire").Return(tc.MockAuth, tc.MockError)
 			client.auth = acquirer
 
 			var URL = server.URL
 			if tc.ClientDoFails {
-				URL = "http://should-definitely-fail.net"
+				URL = ""
 			}
 
 			assert.Nil(err)
@@ -278,9 +286,8 @@ func TestGetItems(t *testing.T) {
 			}))
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    server.URL,
-				Bucket:     bucket,
+				Address: server.URL,
+				Bucket:  bucket,
 			})
 
 			require.Nil(err)
@@ -434,9 +441,8 @@ func TestPushItem(t *testing.T) {
 			}))
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    server.URL,
-				Bucket:     bucket,
+				Address: server.URL,
+				Bucket:  bucket,
 			})
 
 			acquirer.On("Acquire").Return(tc.MockAuth, tc.MockError)
@@ -547,9 +553,8 @@ func TestRemoveItem(t *testing.T) {
 			}))
 
 			client, err := NewBasicClient(BasicClientConfig{
-				HTTPClient: server.Client(),
-				Address:    server.URL,
-				Bucket:     bucket,
+				Address: server.URL,
+				Bucket:  bucket,
 			})
 
 			acquirer.On("Acquire").Return(tc.MockAuth, tc.MockError)