feat(flagd): Added WithGrpcDialOptionsOverride provider option (#638)

cupofcat · web-flow · commit fe904bb054be · 2025-02-22T09:02:34.000-05:00
Signed-off-by: Maks Osowski &lt;maks@google.com&gt;
diff --git a/providers/flagd/README.md b/providers/flagd/README.md
@@ -144,6 +144,27 @@ openfeature.SetProvider(flagd.NewProvider(
     ))
 ```
 
+### gRPC DialOptions override
+
+The `GrpcDialOptionsOverride` is meant for connection of the in-process resolver to a Sync API implementation on a host/port,
+that might require special credentials or headers.
+
+```go
+creds := customSync.CreateCredentials(...)
+
+dialOptions := []grpc.DialOption{
+        grpc.WithTransportCredentials(creds.TransportCredentials()),
+        grpc.WithPerRPCCredentials(creds.PerRPCCredentials()),
+        grpc.WithAuthority(...),
+    }
+
+openfeature.SetProvider(flagd.NewProvider(
+        flagd.WithInProcessResolver(),
+        flagd.WithHost("example.com/flagdSyncApi"), flagd.WithPort(443),
+        flagd.WithGrpcDialOptionsOverride(dialOptions),
+    ))
+```
+
 ## Supported Events
 
 The flagd provider emits `PROVIDER_READY`, `PROVIDER_ERROR` and `PROVIDER_CONFIGURATION_CHANGED` events.
diff --git a/providers/flagd/pkg/configuration.go b/providers/flagd/pkg/configuration.go
@@ -8,6 +8,7 @@ import (
 	"github.com/go-logr/logr"
 	"github.com/open-feature/flagd/core/pkg/sync"
 	"github.com/open-feature/go-sdk-contrib/providers/flagd/internal/cache"
+	"google.golang.org/grpc"
 )
 
 type ResolverType string
@@ -58,6 +59,7 @@ type providerConfiguration struct {
 	TLSEnabled                       bool
 	CustomSyncProvider               sync.ISync
 	CustomSyncProviderUri            string
+	GrpcDialOptionsOverride          []grpc.DialOption
 
 	log logr.Logger
 }
diff --git a/providers/flagd/pkg/provider.go b/providers/flagd/pkg/provider.go
@@ -13,6 +13,7 @@ import (
 	process "github.com/open-feature/go-sdk-contrib/providers/flagd/pkg/service/in_process"
 	rpcService "github.com/open-feature/go-sdk-contrib/providers/flagd/pkg/service/rpc"
 	of "github.com/open-feature/go-sdk/openfeature"
+	"google.golang.org/grpc"
 )
 
 const (
@@ -78,15 +79,16 @@ func NewProvider(opts ...ProviderOption) *Provider {
 			provider.providerConfiguration.EventStreamConnectionMaxAttempts)
 	} else {
 		service = process.NewInProcessService(process.Configuration{
-			Host:                  provider.providerConfiguration.Host,
-			Port:                  provider.providerConfiguration.Port,
-			ProviderID:            provider.providerConfiguration.ProviderID,
-			Selector:              provider.providerConfiguration.Selector,
-			TargetUri:             provider.providerConfiguration.TargetUri,
-			TLSEnabled:            provider.providerConfiguration.TLSEnabled,
-			OfflineFlagSource:     provider.providerConfiguration.OfflineFlagSourcePath,
-			CustomSyncProvider:    provider.providerConfiguration.CustomSyncProvider,
-			CustomSyncProviderUri: provider.providerConfiguration.CustomSyncProviderUri,
+			Host:                    provider.providerConfiguration.Host,
+			Port:                    provider.providerConfiguration.Port,
+			ProviderID:              provider.providerConfiguration.ProviderID,
+			Selector:                provider.providerConfiguration.Selector,
+			TargetUri:               provider.providerConfiguration.TargetUri,
+			TLSEnabled:              provider.providerConfiguration.TLSEnabled,
+			OfflineFlagSource:       provider.providerConfiguration.OfflineFlagSourcePath,
+			CustomSyncProvider:      provider.providerConfiguration.CustomSyncProvider,
+			CustomSyncProviderUri:   provider.providerConfiguration.CustomSyncProviderUri,
+			GrpcDialOptionsOverride: provider.providerConfiguration.GrpcDialOptionsOverride,
 		})
 	}
 
@@ -356,3 +358,13 @@ func WithCustomSyncProviderAndUri(customSyncProvider sync.ISync, customSyncProvi
 		p.providerConfiguration.CustomSyncProviderUri = customSyncProviderUri
 	}
 }
+
+// WithGrpcDialOptionsOverride provides a set of custom grps.DialOption that will fully override the gRPC dial options used by
+// the InProcess resolver with gRPC syncer. All the other provider options that also set dial options (e.g. WithTLS, or WithCertificatePath)
+// will be silently ignored.
+// This is only useful with inProcess resolver type
+func WithGrpcDialOptionsOverride(grpcDialOptionsOverride []grpc.DialOption) ProviderOption {
+	return func(p *Provider) {
+		p.providerConfiguration.GrpcDialOptionsOverride = grpcDialOptionsOverride
+	}
+}
diff --git a/providers/flagd/pkg/provider_test.go b/providers/flagd/pkg/provider_test.go
@@ -1,6 +1,7 @@
 package flagd
 
 import (
+	"reflect"
 	"testing"
 
 	"github.com/open-feature/flagd/core/pkg/sync"
@@ -9,29 +10,36 @@ import (
 	process "github.com/open-feature/go-sdk-contrib/providers/flagd/pkg/service/in_process"
 	of "github.com/open-feature/go-sdk/openfeature"
 	"go.uber.org/mock/gomock"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
 )
 
 func TestNewProvider(t *testing.T) {
 	customSyncProvider := process.NewDoNothingCustomSyncProvider()
+	gRPCDialOptionOverride := []grpc.DialOption{
+		grpc.WithTransportCredentials(insecure.NewCredentials()),
+		grpc.WithAuthority("test-authority"),
+	}
 
 	tests := []struct {
-		name                        string
-		expectedResolver            ResolverType
-		expectPort                  uint16
-		expectHost                  string
-		expectTargetUri             string
-		expectCacheType             cache.Type
-		expectCertPath              string
-		expectMaxRetries            int
-		expectCacheSize             int
-		expectOtelIntercept         bool
-		expectSocketPath            string
-		expectTlsEnabled            bool
-		expectProviderID            string
-		expectSelector              string
-		expectCustomSyncProvider    sync.ISync
-		expectCustomSyncProviderUri string
-		options                     []ProviderOption
+		name                          string
+		expectedResolver              ResolverType
+		expectPort                    uint16
+		expectHost                    string
+		expectTargetUri               string
+		expectCacheType               cache.Type
+		expectCertPath                string
+		expectMaxRetries              int
+		expectCacheSize               int
+		expectOtelIntercept           bool
+		expectSocketPath              string
+		expectTlsEnabled              bool
+		expectProviderID              string
+		expectSelector                string
+		expectCustomSyncProvider      sync.ISync
+		expectCustomSyncProviderUri   string
+		expectGrpcDialOptionsOverride []grpc.DialOption
+		options                       []ProviderOption
 	}{
 		{
 			name:                        "default construction",
@@ -173,6 +181,20 @@ func TestNewProvider(t *testing.T) {
 				WithCustomSyncProvider(customSyncProvider),
 			},
 		},
+		{
+			name:                          "with gRPC DialOptions override with in-process resolver",
+			expectedResolver:              inProcess,
+			expectHost:                    defaultHost,
+			expectPort:                    defaultInProcessPort,
+			expectCacheType:               defaultCache,
+			expectCacheSize:               defaultMaxCacheSize,
+			expectMaxRetries:              defaultMaxEventStreamRetries,
+			expectGrpcDialOptionsOverride: gRPCDialOptionOverride,
+			options: []ProviderOption{
+				WithInProcessResolver(),
+				WithGrpcDialOptionsOverride(gRPCDialOptionOverride),
+			},
+		},
 		{
 			name:             "with selector and providerID with in-process resolver",
 			expectedResolver: inProcess,
@@ -295,6 +317,18 @@ func TestNewProvider(t *testing.T) {
 					test.expectCustomSyncProviderUri, config.CustomSyncProviderUri)
 			}
 
+			if test.expectGrpcDialOptionsOverride != nil {
+				if config.GrpcDialOptionsOverride == nil {
+					t.Errorf("incorrent configuration GrpcDialOptionsOverride, expected %v, got nil", config.GrpcDialOptionsOverride)
+				} else if !reflect.DeepEqual(config.GrpcDialOptionsOverride, test.expectGrpcDialOptionsOverride) {
+					t.Errorf("incorrent configuration GrpcDialOptionsOverride, expected %v, got %v", test.expectGrpcDialOptionsOverride, config.GrpcDialOptionsOverride)
+				}
+			} else {
+				if config.GrpcDialOptionsOverride != nil {
+					t.Errorf("incorrent configuration GrpcDialOptionsOverride, expected nil, got %v", config.GrpcDialOptionsOverride)
+				}
+			}
+
 			// this line will fail linting if this provider is no longer compatible with the openfeature sdk
 			var _ of.FeatureProvider = flagdProvider
 		})
diff --git a/providers/flagd/pkg/service/in_process/service.go b/providers/flagd/pkg/service/in_process/service.go
@@ -7,6 +7,8 @@ import (
 	"regexp"
 	parallel "sync"
 
+	googlegrpc "google.golang.org/grpc"
+
 	"github.com/open-feature/flagd/core/pkg/evaluator"
 	"github.com/open-feature/flagd/core/pkg/logger"
 	"github.com/open-feature/flagd/core/pkg/model"
@@ -33,15 +35,16 @@ type InProcess struct {
 }
 
 type Configuration struct {
-	Host                  any
-	Port                  any
-	TargetUri             string
-	ProviderID            string
-	Selector              string
-	TLSEnabled            bool
-	OfflineFlagSource     string
-	CustomSyncProvider    sync.ISync
-	CustomSyncProviderUri string
+	Host                    any
+	Port                    any
+	TargetUri               string
+	ProviderID              string
+	Selector                string
+	TLSEnabled              bool
+	OfflineFlagSource       string
+	CustomSyncProvider      sync.ISync
+	CustomSyncProviderUri   string
+	GrpcDialOptionsOverride []googlegrpc.DialOption
 }
 
 func NewInProcessService(cfg Configuration) *InProcess {
@@ -301,12 +304,13 @@ func makeSyncProvider(cfg Configuration, log *logger.Logger) (sync.ISync, string
 	log.Info("operating in in-process mode with flags sourced from " + uri)
 
 	return &grpc.Sync{
-		CredentialBuilder: &credentials.CredentialBuilder{},
-		Logger:            log,
-		Secure:            cfg.TLSEnabled,
-		ProviderID:        cfg.ProviderID,
-		Selector:          cfg.Selector,
-		URI:               uri,
+		CredentialBuilder:       &credentials.CredentialBuilder{},
+		GrpcDialOptionsOverride: cfg.GrpcDialOptionsOverride,
+		Logger:                  log,
+		Secure:                  cfg.TLSEnabled,
+		ProviderID:              cfg.ProviderID,
+		Selector:                cfg.Selector,
+		URI:                     uri,
 	}, uri
 }
 

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ import (`
`8`	`8`	`"github.com/go-logr/logr"`
`9`	`9`	`"github.com/open-feature/flagd/core/pkg/sync"`
`10`	`10`	`"github.com/open-feature/go-sdk-contrib/providers/flagd/internal/cache"`
	`11`	`+ "google.golang.org/grpc"`
`11`	`12`	`)`
`12`	`13`
`13`	`14`	`type ResolverType string`
`@@ -58,6 +59,7 @@ type providerConfiguration struct {`
`58`	`59`	`TLSEnabled bool`
`59`	`60`	`CustomSyncProvider sync.ISync`
`60`	`61`	`CustomSyncProviderUri string`
	`62`	`+ GrpcDialOptionsOverride []grpc.DialOption`
`61`	`63`
`62`	`64`	`log logr.Logger`
`63`	`65`	`}`