feat(ofrep): add header, base URI, and timeout options (#794)

Signed-off-by: Roman Dmytrenko <[email protected]>
Co-authored-by: Sahid Velji <[email protected]>

Author: erka

providers/ofrep/README.md

@@ -9,7 +9,6 @@ Use OFREP provider with the latest OpenFeature Go SDK
 
 ```sh
 go get github.com/open-feature/go-sdk-contrib/providers/ofrep
-go get github.com/open-feature/go-sdk
 ```
 
 ## Usage
@@ -31,14 +30,16 @@ openfeature.SetProvider(ofrepProvider)
 You can configure the provider using following configuration options,
 
 | Configuration option | Details                                                                                                                 |
-|----------------------|-------------------------------------------------------------------------------------------------------------------------|
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | WithApiKeyAuth       | Set the token to be used with "X-API-Key" header                                                                        |
 | WithBearerToken      | Set the token to be used with "Bearer" HTTP Authorization schema                                                        |
-| WithClient           | Provider a custom, pre-configured http.Client for OFREP service communication                                           |
+| WithClient           | Provide a custom, pre-configured http.Client for OFREP service communication                                            |
 | WithHeaderProvider   | Register a custom header provider for OFREP calls. You may utilize this for custom authentication/authorization headers |
+| WithHeader           | Set a custom header to be used for authorization                                                                        |
+| WithBaseURI          | Set the base URI of the OFREP service                                                                                   |
+| WithTimeout          | Set the timeout for the http client used for communication with the OFREP service (ignored if custom client is used)    |
 
-
-For example, consider below example which set bearer token and provider a customized http client,
+For example, consider below example which sets bearer token and provides a customized http client,
 
 ```go
 provider := ofrep.NewProvider(
@@ -47,4 +48,4 @@ provider := ofrep.NewProvider(
     ofrep.WithClient(&http.Client{
         Timeout: 1 * time.Second,
     }))
-```
+```

providers/ofrep/go.sum

@@ -1,14 +1,8 @@
 github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
 github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
-github.com/open-feature/go-sdk v1.15.1 h1:TC3FtHtOKlGlIbSf3SEpxXVhgTd/bCbuc39XHIyltkw=
-github.com/open-feature/go-sdk v1.15.1/go.mod h1:2WAFYzt8rLYavcubpCoiym3iSCXiHdPB6DxtMkv2wyo=
-github.com/open-feature/go-sdk v1.16.0 h1:5NCHYv5slvNBIZhYXAzAufo0OI59OACZ5tczVqSE+Tg=
-github.com/open-feature/go-sdk v1.16.0/go.mod h1:EIF40QcoYT1VbQkMPy2ZJH4kvZeY+qGUXAorzSWgKSo=
 github.com/open-feature/go-sdk v1.17.0 h1:/OUBBw5d9D61JaNZZxb2Nnr5/EJrEpjtKCTY3rspJQk=
 github.com/open-feature/go-sdk v1.17.0/go.mod h1:lPxPSu1UnZ4E3dCxZi5gV3et2ACi8O8P+zsTGVsDZUw=
-go.uber.org/mock v0.5.2 h1:LbtPTcP8A5k9WPXj54PPPbjcI4Y6lhyOZXn+VS7wNko=
-go.uber.org/mock v0.5.2/go.mod h1:wLlUxC2vVTPTaE3UD51E0BGOAElKrILxhVSDYQLld5o=
 go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y=
 go.uber.org/mock v0.6.0/go.mod h1:KiVJ4BqZJaMj4svdfmHM0AUx4NJYO8ZNpPnZn1Z+BBU=
-golang.org/x/text v0.26.0 h1:P42AVeLghgTYr4+xUnTRKDMqpar+PtX7KWuNQL21L8M=
-golang.org/x/text v0.26.0/go.mod h1:QK15LZJUUQVJxhz7wXgxSy/CJaTFjd0G+YLonydOVQA=
+golang.org/x/text v0.30.0 h1:yznKA/E9zq54KzlzBEAWn1NXSQ8DIp/NYMy88xJjl4k=
+golang.org/x/text v0.30.0/go.mod h1:yDdHFIX9t+tORqspjENWgzaCVXgk0yYnYuSZ8UzzBVM=

providers/ofrep/internal/evaluate/flags_test.go

@@ -359,7 +359,7 @@ func genericValidator[T knownTypes](test testDefinition[T], resolvedValue T, rea
 		}
 
 		if !reflect.DeepEqual(test.defaultValue, resolvedValue) {
-			t.Errorf("expected deafault value %v, but got %v", test.defaultValue, resolvedValue)
+			t.Errorf("expected default value %v, but got %v", test.defaultValue, resolvedValue)
 		}
 
 		if reason != of.ErrorReason {

providers/ofrep/internal/evaluate/resolver.go

@@ -31,13 +31,13 @@ func NewOutboundResolver(cfg outbound.Configuration) *OutboundResolver {
 func (g *OutboundResolver) resolveSingle(ctx context.Context, key string, evalCtx map[string]any) (*successDto, *of.ResolutionError) {
 	b, err := json.Marshal(requestFrom(evalCtx))
 	if err != nil {
-		resErr := of.NewGeneralResolutionError(fmt.Sprintf("context marshelling error: %v", err))
+		resErr := of.NewGeneralResolutionError(fmt.Sprintf("context marshelling error: %v", err), err)
 		return nil, &resErr
 	}
 
 	rsp, err := g.client.Single(ctx, key, b)
 	if err != nil {
-		resErr := of.NewGeneralResolutionError(fmt.Sprintf("ofrep request error: %v", err))
+		resErr := of.NewGeneralResolutionError(fmt.Sprintf("ofrep request error: %v", err), err)
 		return nil, &resErr
 	}
 
@@ -47,7 +47,7 @@ func (g *OutboundResolver) resolveSingle(ctx context.Context, key string, evalCt
 		var success evaluationSuccess
 		err := json.Unmarshal(rsp.Data, &success)
 		if err != nil {
-			resErr := of.NewParseErrorResolutionError(fmt.Sprintf("error parsing the response: %v", err))
+			resErr := of.NewParseErrorResolutionError(fmt.Sprintf("error parsing the response: %v", err), err)
 			return nil, &resErr
 		}
 		return toSuccessDto(success)
@@ -82,7 +82,7 @@ func parseError400(data []byte) *of.ResolutionError {
 	var evalError evaluationError
 	err := json.Unmarshal(data, &evalError)
 	if err != nil {
-		resErr := of.NewGeneralResolutionError(fmt.Sprintf("error parsing error payload: %v", err))
+		resErr := of.NewGeneralResolutionError(fmt.Sprintf("error parsing error payload: %v", err), err)
 		return &resErr
 	}
 
@@ -127,7 +127,7 @@ func parseError500(data []byte) *of.ResolutionError {
 
 	err := json.Unmarshal(data, &evalError)
 	if err != nil {
-		resErr = of.NewGeneralResolutionError(fmt.Sprintf("error parsing error payload: %v", err))
+		resErr = of.NewGeneralResolutionError(fmt.Sprintf("error parsing error payload: %v", err), err)
 	} else {
 		resErr = of.NewGeneralResolutionError(evalError.ErrorDetails)
 	}

providers/ofrep/internal/outbound/http.go

@@ -21,6 +21,7 @@ type Configuration struct {
 	BaseURI   string
 	Callbacks []HeaderCallback
 	Client    *http.Client
+	Timeout   time.Duration
 }
 
 type Resolution struct {
@@ -39,7 +40,7 @@ type Outbound struct {
 func NewHttp(cfg Configuration) *Outbound {
 	if cfg.Client == nil {
 		cfg.Client = &http.Client{
-			Timeout: 10 * time.Second,
+			Timeout: cfg.Timeout,
 		}
 	}
 
@@ -62,6 +63,8 @@ func (h *Outbound) Single(ctx context.Context, key string, payload []byte) (*Res
 		return nil, &resErr
 	}
 
+	req.Header.Set("Content-Type", "application/json")
+
 	for _, callback := range h.headerProvider {
 		req.Header.Set(callback())
 	}

providers/ofrep/provider.go

@@ -4,12 +4,15 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"time"
 
 	"github.com/open-feature/go-sdk-contrib/providers/ofrep/internal/evaluate"
 	"github.com/open-feature/go-sdk-contrib/providers/ofrep/internal/outbound"
 	"github.com/open-feature/go-sdk/openfeature"
 )
 
+var _ openfeature.FeatureProvider = &Provider{}
+
 // Provider implementation for OFREP
 type Provider struct {
 	evaluator Evaluator
@@ -22,6 +25,7 @@ type Option func(*outbound.Configuration)
 func NewProvider(baseUri string, options ...Option) *Provider {
 	cfg := outbound.Configuration{
 		BaseURI: baseUri,
+		Timeout: 10 * time.Second,
 	}
 
 	for _, option := range options {
@@ -98,3 +102,27 @@ func WithClient(client *http.Client) func(configuration *outbound.Configuration)
 		configuration.Client = client
 	}
 }
+
+// WithHeader allows to set a custom header
+func WithHeader(key, value string) func(*outbound.Configuration) {
+	return func(c *outbound.Configuration) {
+		c.Callbacks = append(c.Callbacks, func() (string, string) {
+			return key, value
+		})
+	}
+}
+
+// WithBaseURI allows to override the base URI of the OFREP service
+func WithBaseURI(baseURI string) func(*outbound.Configuration) {
+	return func(c *outbound.Configuration) {
+		c.BaseURI = baseURI
+	}
+}
+
+// WithTimeout allows to configure the timeout for the http client used for communication with the OFREP service.
+// This option is ignored if a custom client is provided via WithClient.
+func WithTimeout(timeout time.Duration) func(*outbound.Configuration) {
+	return func(c *outbound.Configuration) {
+		c.Timeout = timeout
+	}
+}

providers/ofrep/provider_test.go

@@ -62,6 +62,42 @@ func TestConfigurations(t *testing.T) {
 			t.Errorf("expected value %s, but got %s", "TOKEN", v)
 		}
 	})
+
+	t.Run("validate custom header", func(t *testing.T) {
+		c := outbound.Configuration{}
+
+		WithHeader("X-Custom-Header", "CustomValue")(&c)
+
+		h, v := c.Callbacks[0]()
+
+		if h != "X-Custom-Header" {
+			t.Errorf("expected header %s, but got %s", "X-Custom-Header", h)
+		}
+
+		if v != "CustomValue" {
+			t.Errorf("expected value %s, but got %s", "CustomValue", v)
+		}
+	})
+
+	t.Run("validate base URI override", func(t *testing.T) {
+		c := outbound.Configuration{BaseURI: "http://initial.example.com"}
+
+		WithBaseURI("http://override.example.com")(&c)
+
+		if c.BaseURI != "http://override.example.com" {
+			t.Errorf("expected BaseURI %s, but got %s", "http://override.example.com", c.BaseURI)
+		}
+	})
+
+	t.Run("validate timeout configuration", func(t *testing.T) {
+		c := outbound.Configuration{}
+
+		WithTimeout(5 * time.Second)(&c)
+
+		if c.Timeout != 5*time.Second {
+			t.Errorf("expected Timeout %v, but got %v", 5*time.Second, c.Timeout)
+		}
+	})
 }
 
 func TestWiringE2E(t *testing.T) {