fix(clihttp): add the missing Providers function (#210)

* fix: add clihttp Providers

* fix: add clihttp Providers

* fix: add clihttp Providers

* fix: add clihttp Providers

Author: Reasno

clihttp/dependency.go

@@ -0,0 +1,36 @@
+package clihttp
+
+import (
+	"fmt"
+
+	"github.com/DoNewsCode/core/contract"
+	"github.com/DoNewsCode/core/di"
+	"github.com/opentracing/opentracing-go"
+)
+
+/*
+Providers provides the http client as a dependency.
+Depends On:
+	opentracing.Tracer
+Provides:
+	*clihttp.Client
+*/
+func Providers(options ...ProvidersOptionFunc) di.Deps {
+	var p providersOption
+	for _, f := range options {
+		f(&p)
+	}
+	return di.Deps{
+		func(tracer opentracing.Tracer, populator contract.DIPopulator) (*Client, error) {
+			if p.clientConstructor != nil {
+				doer, err := p.clientConstructor(ClientArgs{populator})
+				if err != nil {
+					return nil, fmt.Errorf("contructing contract.HttpDoer: %w", err)
+				}
+				return NewClient(tracer, append(p.clientOptions, WithDoer(doer))...), nil
+			}
+			return NewClient(tracer, p.clientOptions...), nil
+		},
+		di.Bind(new(*Client), new(contract.HttpDoer)),
+	}
+}

clihttp/dependency_option.go

@@ -0,0 +1,32 @@
+package clihttp
+
+import "github.com/DoNewsCode/core/contract"
+
+type providersOption struct {
+	clientConstructor func(args ClientArgs) (contract.HttpDoer, error)
+	clientOptions     []Option
+}
+
+// ClientArgs is the constructor argument for WithClientConstructor. See WithClientConstructor for usage.
+type ClientArgs struct {
+	Populator contract.DIPopulator
+}
+
+// ProvidersOptionFunc is the type of functional providersOption for Providers. Use this type to change how Providers work.
+type ProvidersOptionFunc func(options *providersOption)
+
+// WithClientConstructor instructs the Providers to accept an alternative
+// constructor for the contract.HttpDoer to be wrapped by clihttp.NewClient.
+func WithClientConstructor(f func(args ClientArgs) (contract.HttpDoer, error)) ProvidersOptionFunc {
+	return func(options *providersOption) {
+		options.clientConstructor = f
+	}
+}
+
+// WithClientOption instructs the Providers to accept additional options for the
+// NewClient call, such as WithRequestLogThreshold.
+func WithClientOption(options ...Option) ProvidersOptionFunc {
+	return func(providerOption *providersOption) {
+		providerOption.clientOptions = options
+	}
+}

clihttp/dependency_test.go

@@ -0,0 +1,60 @@
+package clihttp_test
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/DoNewsCode/core"
+	"github.com/DoNewsCode/core/clihttp"
+	"github.com/DoNewsCode/core/contract"
+	"github.com/DoNewsCode/core/observability"
+	"github.com/stretchr/testify/assert"
+)
+
+type mockDoer bool
+
+func (m *mockDoer) Do(req *http.Request) (*http.Response, error) {
+	*m = true
+	resp := http.Response{}
+	return &resp, nil
+}
+
+func TestProviders(t *testing.T) {
+	t.Run("no panic", func(t *testing.T) {
+		c := core.Default()
+		c.Provide(observability.Providers())
+		c.Provide(clihttp.Providers())
+		c.Invoke(func(client *clihttp.Client) {})
+		c.Invoke(func(client contract.HttpDoer) {})
+	})
+	t.Run("panic", func(t *testing.T) {
+		defer func() {
+			if r := recover(); r != nil {
+				return
+			}
+			t.Fatal("test should panic")
+		}()
+		c := core.Default()
+		c.Provide(clihttp.Providers())
+		c.Invoke(func(client *clihttp.Client) {})
+	})
+	t.Run("replace doer", func(t *testing.T) {
+		var mock mockDoer
+		c := core.Default()
+		c.Provide(observability.Providers())
+		c.Provide(clihttp.Providers(clihttp.WithClientConstructor(func(args clihttp.ClientArgs) (contract.HttpDoer, error) {
+			return &mock, nil
+		})))
+		c.Invoke(func(client *clihttp.Client) {
+			req, _ := http.NewRequest(http.MethodGet, "", nil)
+			client.Do(req)
+			assert.True(t, bool(mock))
+		})
+	})
+	t.Run("additional options", func(t *testing.T) {
+		c := core.Default()
+		c.Provide(observability.Providers())
+		c.Provide(clihttp.Providers(clihttp.WithClientOption(clihttp.WithRequestLogThreshold(10))))
+		c.Invoke(func(client *clihttp.Client) {})
+	})
+}

leader/dependency.go

@@ -19,7 +19,7 @@ Providers returns a set of dependency providers for *Election and *Status.
 		contract.ConfigAccessor
 		contract.Dispatcher
 		contract.DIPopulator
-	Provide:
+	Provides:
 		Election *Election
 		Status   *Status
 */