pkg/billing: require Logger for NewWorkflowClient (#1385)

Author: jmank88

pkg/billing/workflow_client.go

@@ -53,11 +53,9 @@ type workflowConfig struct {
 type WorkflowClientOpt func(*workflowConfig)
 
 func defaultWorkflowConfig() workflowConfig {
-	loggerInst, _ := logger.New()
 	// By default, no JWT manager is set and we fallback to insecure creds.
 	return workflowConfig{
 		transportCredentials: insecure.NewCredentials(),
-		log:                  loggerInst,
 		tlsCert:              "",
 		// Default to "localhost" if not overridden.
 		serverName:   "localhost",
@@ -71,12 +69,6 @@ func WithWorkflowTransportCredentials(creds credentials.TransportCredentials) Wo
 	}
 }
 
-func WithWorkflowLogger(l logger.Logger) WorkflowClientOpt {
-	return func(cfg *workflowConfig) {
-		cfg.log = l
-	}
-}
-
 // WithJWTGenerator sets the JWT generator for authentication.
 func WithJWTGenerator(jwtGenerator auth.JWTGenerator) WorkflowClientOpt {
 	return func(cfg *workflowConfig) {
@@ -98,15 +90,15 @@ func WithServerName(name string) WorkflowClientOpt {
 }
 
 // NewWorkflowClient creates a new workflow client with JWT signing enabled.
-func NewWorkflowClient(address string, opts ...WorkflowClientOpt) (WorkflowClient, error) {
+func NewWorkflowClient(lggr logger.Logger, address string, opts ...WorkflowClientOpt) (WorkflowClient, error) {
 	cfg := defaultWorkflowConfig()
 	for _, opt := range opts {
 		opt(&cfg)
 	}
 
 	wc := &workflowClient{
 		address:      address,
-		logger:       cfg.log,
+		logger:       logger.Named(lggr, "WorkflowClient"),
 		tlsCert:      cfg.tlsCert,
 		creds:        cfg.transportCredentials,
 		serverName:   cfg.serverName,

pkg/billing/workflow_client_test.go

@@ -16,8 +16,8 @@ import (
 	"google.golang.org/grpc/metadata"
 	"google.golang.org/protobuf/types/known/emptypb"
 
-	"github.com/smartcontractkit/chainlink-common/pkg/nodeauth/jwt/mocks"
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
+	"github.com/smartcontractkit/chainlink-common/pkg/nodeauth/jwt/mocks"
 	pb "github.com/smartcontractkit/chainlink-protos/billing/go"
 )
 
@@ -30,7 +30,6 @@ func (d MockRequest) String() string {
 	return d.Field
 }
 
-
 // ---------- Test Server Implementation ----------
 
 // testWorkflowServer implements pb.WorkflowServiceServer for testing.
@@ -101,11 +100,10 @@ func TestIntegration_GRPCWithCerts(t *testing.T) {
 	mockJWT.EXPECT().CreateJWTForRequest(&pb.GetRateCardRequest{WorkflowOwner: "test-account", WorkflowRegistryAddress: "0x..", ChainSelector: 1}).Return("test.jwt.token", nil).Once()
 
 	lggr := logger.Test(t)
-	wc, err := NewWorkflowClient(addr,
+	wc, err := NewWorkflowClient(lggr, addr,
 		WithWorkflowTransportCredentials(clientCreds), // Provided but may be overridden by TLS cert.
 		WithWorkflowTLSCert(string(certBytes)),
 		WithJWTGenerator(mockJWT),
-		WithWorkflowLogger(lggr),
 		WithServerName("localhost"),
 	)
 	require.NoError(t, err)
@@ -153,9 +151,8 @@ func TestIntegration_GRPC_Insecure(t *testing.T) {
 	addr := lis.Addr().String()
 	lggr := logger.Test(t)
 
-	wc, err := NewWorkflowClient(addr,
+	wc, err := NewWorkflowClient(lggr, addr,
 		WithWorkflowTransportCredentials(insecure.NewCredentials()),
-		WithWorkflowLogger(lggr),
 		WithServerName("localhost"),
 	)
 
@@ -170,9 +167,8 @@ func TestIntegration_GRPC_Insecure(t *testing.T) {
 // Test that NewWorkflowClient fails when given an invalid address.
 func TestNewWorkflowClient_InvalidAddress(t *testing.T) {
 	lggr := logger.Test(t)
-	wc, err := NewWorkflowClient("invalid-address",
+	wc, err := NewWorkflowClient(lggr, "invalid-address",
 		WithWorkflowTransportCredentials(insecure.NewCredentials()),
-		WithWorkflowLogger(lggr),
 		WithServerName("localhost"),
 	)
 
@@ -196,9 +192,8 @@ func TestWorkflowClient_CloseTwice(t *testing.T) {
 
 	addr := lis.Addr().String()
 	lggr := logger.Test(t)
-	wc, err := NewWorkflowClient(addr,
+	wc, err := NewWorkflowClient(lggr, addr,
 		WithWorkflowTransportCredentials(insecure.NewCredentials()),
-		WithWorkflowLogger(lggr),
 		WithServerName("localhost"),
 	)
 	require.NoError(t, err)
@@ -215,9 +210,8 @@ func TestWorkflowClient_CloseTwice(t *testing.T) {
 func TestWorkflowClient_DialUnreachable(t *testing.T) {
 	lggr := logger.Test(t)
 	unreachableAddr := "192.0.2.1:12345" // Reserved for documentation.
-	wc, err := NewWorkflowClient(unreachableAddr,
+	wc, err := NewWorkflowClient(lggr, unreachableAddr,
 		WithWorkflowTransportCredentials(insecure.NewCredentials()),
-		WithWorkflowLogger(lggr),
 		WithServerName("localhost"),
 	)
 
@@ -240,7 +234,7 @@ func TestWorkflowClient_AddJWTAuthToContext(t *testing.T) {
 	mockJWT.EXPECT().CreateJWTForRequest(req).Return(expectedToken, nil).Once()
 
 	wc := &workflowClient{
-		logger:     logger.Test(t),
+		logger:       logger.Test(t),
 		jwtGenerator: mockJWT,
 	}
 
@@ -263,7 +257,7 @@ func TestWorkflowClient_NoSigningKey(t *testing.T) {
 	ctx := context.Background()
 	req := MockRequest{Field: "test"}
 	wc := &workflowClient{
-		logger: logger.Test(t),
+		logger:       logger.Test(t),
 		jwtGenerator: nil,
 	}
 	newCtx, err := wc.addJWTAuth(ctx, req)
@@ -281,7 +275,7 @@ func TestWorkflowClient_VerifySignature_Invalid(t *testing.T) {
 	mockJWT.EXPECT().CreateJWTForRequest(req).Return("", fmt.Errorf("mock JWT creation error")).Once()
 
 	wc := &workflowClient{
-		logger:     logger.Test(t),
+		logger:       logger.Test(t),
 		jwtGenerator: mockJWT,
 	}
 
@@ -300,7 +294,7 @@ func TestWorkflowClient_RepeatedSign(t *testing.T) {
 	mockJWT.EXPECT().CreateJWTForRequest(req).Return(expectedToken, nil).Times(2)
 
 	wc := &workflowClient{
-		logger:     logger.Test(t),
+		logger:       logger.Test(t),
 		jwtGenerator: mockJWT,
 	}
 
@@ -319,4 +313,4 @@ func TestWorkflowClient_RepeatedSign(t *testing.T) {
 	require.True(t, ok)
 
 	assert.Equal(t, md1["authorization"], md2["authorization"], "Expected same authorization header for same request")
-}
+}