Merge pull request #275 from xmidt-org/denopink/feat/fx-integration

feat: integrate uber fx

Author: denopink

.gitignore

@@ -10,6 +10,7 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+*.html
 coverage*
 report.json
 

anclafx/provide.go

@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2025 Comcast Cable Communications Management, LLC
+// SPDX-License-Identifier: Apache-2.0
+package anclafx
+
+import (
+	"github.com/xmidt-org/ancla"
+	"github.com/xmidt-org/ancla/chrysom"
+	"go.uber.org/fx"
+)
+
+const Module = "ancla"
+
+func Provide() fx.Option {
+	return fx.Module(
+		Module,
+		fx.Invoke(chrysom.ProvideStartListenerClient),
+		fx.Provide(
+			ancla.ProvideService,
+			ancla.ProvideListener,
+			ancla.ProvideDefaultListenerWatchers,
+			chrysom.ProvideBasicClient,
+			chrysom.ProvideDefaultListenerReader,
+			chrysom.ProvideListenerClient,
+		),
+		chrysom.ProvideMetrics(),
+	)
+}

anclafx/provide_test.go

@@ -0,0 +1,78 @@
+// SPDX-FileCopyrightText: 2025 Comcast Cable Communications Management, LLC
+// SPDX-License-Identifier: Apache-2.0
+package anclafx_test
+
+import (
+	"context"
+	"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/touchstone"
+	"go.uber.org/fx"
+	"go.uber.org/fx/fxtest"
+	"go.uber.org/zap"
+)
+
+type out struct {
+	fx.Out
+
+	Factory           *touchstone.Factory
+	BasicClientConfig chrysom.BasicClientConfig
+	GetLogger         chrysom.GetLogger
+	SetLogger         chrysom.SetLogger
+}
+
+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, zap.NewNop(), pr),
+		BasicClientConfig: chrysom.BasicClientConfig{
+			Address: "example.com",
+			Bucket:  "bucket-name",
+		},
+		GetLogger: func(context.Context) *zap.Logger { return zap.NewNop() },
+		SetLogger: func(context.Context, *zap.Logger) context.Context { return context.Background() },
+	}, nil
+}
+
+func TestProvide(t *testing.T) {
+	t.Run("Test anclafx.Provide() defaults", func(t *testing.T) {
+		var (
+			svc ancla.Service
+			bc  *chrysom.BasicClient
+			l   *chrysom.ListenerClient
+		)
+
+		app := fxtest.New(t,
+			anclafx.Provide(),
+			fx.Provide(
+				provideDefaults,
+			),
+			fx.Populate(
+				&svc,
+				&bc,
+				&l,
+			),
+		)
+
+		require := require.New(t)
+		require.NotNil(app)
+		require.NoError(app.Err())
+		app.RequireStart()
+		require.NotNil(svc)
+		require.NotNil(bc)
+		require.NotNil(l)
+		app.RequireStop()
+	})
+}

chrysom/basicClient.go

@@ -11,6 +11,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"time"
 
 	"github.com/xmidt-org/ancla/auth"
 	"github.com/xmidt-org/ancla/model"
@@ -41,6 +42,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")
 )
 
 // BasicClientConfig contains config data for the client that will be used to
@@ -59,6 +61,10 @@ type BasicClientConfig struct {
 	// Auth provides the mechanism to add auth headers to outgoing requests.
 	// (Optional) If not provided, no auth headers are added.
 	Auth auth.Decorator
+
+	// 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.

chrysom/basicClient_test.go

@@ -54,34 +54,30 @@ func TestValidateBasicConfig(t *testing.T) {
 		{
 			Description: "No address",
 			Input: &BasicClientConfig{
-				HTTPClient: http.DefaultClient,
-				Bucket:     "bucket-name",
+				Bucket: "bucket-name",
 			},
 			ExpectedErr: ErrAddressEmpty,
 		},
 		{
 			Description: "No bucket",
 			Input: &BasicClientConfig{
-				HTTPClient: http.DefaultClient,
-				Address:    "example.com",
+				Address: "example.com",
 			},
 			ExpectedErr: ErrBucketEmpty,
 		},
 		{
 			Description: "All default values",
 			Input: &BasicClientConfig{
-				HTTPClient: http.DefaultClient,
-				Address:    "example.com",
-				Bucket:     "bucket-name",
+				Address: "example.com",
+				Bucket:  "bucket-name",
 			},
 			ExpectedConfig: allDefaultsCaseConfig,
 		},
 		{
 			Description: "All defined",
 			Input: &BasicClientConfig{
-				HTTPClient: http.DefaultClient,
-				Address:    "example.com",
-				Bucket:     "amazing-bucket",
+				Address: "example.com",
+				Bucket:  "amazing-bucket",
 			},
 			ExpectedConfig: allDefinedCaseConfig,
 		},
@@ -121,7 +117,7 @@ func TestSendRequest(t *testing.T) {
 			ExpectedErr: errNewRequestFailure,
 		},
 		{
-			Description: "Auth acquirer fails",
+			Description: "Auth decorator fails",
 			Method:      http.MethodGet,
 			URL:         "example.com",
 			MockError:   errFails,

chrysom/fx.go

@@ -0,0 +1,105 @@
+// SPDX-FileCopyrightText: 2025 Comcast Cable Communications Management, LLC
+// SPDX-License-Identifier: Apache-2.0
+
+package chrysom
+
+import (
+	"context"
+	"errors"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/xmidt-org/touchstone"
+	"go.uber.org/fx"
+	"go.uber.org/zap"
+)
+
+// GetLogger returns a logger from the given context.
+type GetLogger func(context.Context) *zap.Logger
+
+// SetLogger embeds the `Listener.logger` in outgoing request contexts for `Listener.Update` calls.
+type SetLogger func(context.Context, *zap.Logger) context.Context
+
+type BasicClientIn struct {
+	fx.In
+
+	// Ancla Client config.
+	Config BasicClientConfig
+	// GetLogger returns a logger from the given context.
+	GetLogger GetLogger
+}
+
+// ProvideBasicClient provides a new BasicClient.
+func ProvideBasicClient(in BasicClientIn) (*BasicClient, error) {
+	client, err := NewBasicClient(in.Config, in.GetLogger)
+	if err != nil {
+		return nil, errors.Join(errFailedConfig, err)
+	}
+
+	return client, nil
+}
+
+// ListenerConfig contains config data for polling the Argus client.
+type ListenerClientIn struct {
+	fx.In
+
+	// Listener fetches a copy of all items within a bucket on
+	// an interval based on `BasicClientConfig.PullInterval`.
+	// (Optional). If not provided, listening won't be enabled for this client.
+	Listener Listener
+	// Config configures the ancla client and its listeners.
+	Config BasicClientConfig
+	// PollsTotalCounter measures the number of polls (and their success/failure outcomes) to fetch new items.
+	PollsTotalCounter *prometheus.CounterVec `name:"chrysom_polls_total"`
+	// Reader is the DB interface used to fetch new items using `GeItems`.
+	Reader Reader
+	// GetLogger returns a logger from the given context.
+	GetLogger GetLogger
+	// SetLogger embeds the `Listener.logger` in outgoing request contexts for `Listener.Update` calls.
+	SetLogger SetLogger
+}
+
+// ProvideListenerClient provides a new ListenerClient.
+func ProvideListenerClient(in ListenerClientIn) (*ListenerClient, error) {
+	client, err := NewListenerClient(in.Listener, in.GetLogger, in.SetLogger, in.Config.PullInterval, in.PollsTotalCounter, in.Reader)
+	if err != nil {
+		return nil, errors.Join(err, errFailedConfig)
+	}
+
+	return client, nil
+}
+
+func ProvideDefaultListenerReader(client *BasicClient) Reader {
+	return client
+}
+
+type StartListenerIn struct {
+	fx.In
+
+	Listener *ListenerClient
+	LC       fx.Lifecycle
+}
+
+// ProvideStartListenerClient starts the Argus listener client service.
+func ProvideStartListenerClient(in StartListenerIn) error {
+	in.Listener.Start(context.Background())
+	in.LC.Append(fx.StopHook(in.Listener.Stop))
+
+	return nil
+}
+
+func ProvideMetrics() fx.Option {
+	return fx.Options(
+		touchstone.Gauge(
+			prometheus.GaugeOpts{
+				Name: WebhookListSizeGaugeName,
+				Help: WebhookListSizeGaugeHelp,
+			}),
+		touchstone.CounterVec(
+			prometheus.CounterOpts{
+				Name: PollsTotalCounterName,
+				Help: PollsTotalCounterHelp,
+			},
+			OutcomeLabel,
+		),
+	)
+}