feat: add scheme configuration (#159)

Signed-off-by: sivchari <shibuuuu5@gmail.com>

Author: sivchari

Makefile

@@ -46,4 +46,4 @@ coverage:
 .PHONY: e2e
 e2e:
 	go test -v -race ./test/e2e/... \
-		-args -api-key=${API_KEY} -api-key-server=${API_KEY_SERVER} -host=${HOST} -port=${PORT}
+		-args -api-key=${API_KEY} -api-key-server=${API_KEY_SERVER} -host=${HOST} -port=${PORT} -scheme=${SCHEME}

pkg/bucketeer/api/api.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"bytes"
+	"crypto/tls"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -20,10 +21,13 @@ const (
 )
 
 func (c *client) GetEvaluation(req *model.GetEvaluationRequest) (*model.GetEvaluationResponse, int, error) {
-	url := fmt.Sprintf("https://%s%s",
+	url := fmt.Sprintf(
+		"%s://%s%s",
+		c.scheme,
 		c.host,
 		evaluationAPI,
 	)
+
 	resp, size, err := c.sendHTTPRequest(
 		url,
 		req,
@@ -39,7 +43,9 @@ func (c *client) GetEvaluation(req *model.GetEvaluationRequest) (*model.GetEvalu
 }
 
 func (c *client) RegisterEvents(req *model.RegisterEventsRequest) (*model.RegisterEventsResponse, int, error) {
-	url := fmt.Sprintf("https://%s%s",
+	url := fmt.Sprintf(
+		"%s://%s%s",
+		c.scheme,
 		c.host,
 		registerEventAPI,
 	)
@@ -58,7 +64,9 @@ func (c *client) RegisterEvents(req *model.RegisterEventsRequest) (*model.Regist
 }
 
 func (c *client) GetFeatureFlags(req *model.GetFeatureFlagsRequest) (*model.GetFeatureFlagsResponse, int, error) {
-	url := fmt.Sprintf("https://%s%s",
+	url := fmt.Sprintf(
+		"%s://%s%s",
+		c.scheme,
 		c.host,
 		featureFlagsAPI,
 	)
@@ -77,7 +85,9 @@ func (c *client) GetFeatureFlags(req *model.GetFeatureFlagsRequest) (*model.GetF
 }
 
 func (c *client) GetSegmentUsers(req *model.GetSegmentUsersRequest) (*model.GetSegmentUsersResponse, int, error) {
-	url := fmt.Sprintf("https://%s%s",
+	url := fmt.Sprintf(
+		"%s://%s%s",
+		c.scheme,
 		c.host,
 		segmentUsersAPI,
 	)
@@ -95,7 +105,7 @@ func (c *client) GetSegmentUsers(req *model.GetSegmentUsersRequest) (*model.GetS
 	return &gfr, size, nil
 }
 
-func (c *client) sendHTTPRequest(url string, body interface{}) ([]byte, int, error) {
+func (c *client) sendHTTPRequest(url string, body any) ([]byte, int, error) {
 	encoded, err := json.Marshal(body)
 	if err != nil {
 		return nil, 0, err
@@ -109,6 +119,13 @@ func (c *client) sendHTTPRequest(url string, body interface{}) ([]byte, int, err
 	client := &http.Client{
 		Timeout: 60 * time.Second,
 	}
+	if c.scheme == "http" {
+		client.Transport = &http.Transport{
+			// This setting is for developing on local machines.
+			// In production, it's not recommended to specify c.scheme as "http".
+			TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, //nolint:gosec
+		}
+	}
 	resp, err := client.Do(req)
 	if err != nil {
 		return nil, 0, err

pkg/bucketeer/api/client.go

@@ -2,9 +2,17 @@
 package api
 
 import (
+	"errors"
+
 	"github.com/bucketeer-io/go-server-sdk/pkg/bucketeer/model"
 )
 
+var (
+	ErrEmptyAPIKey   = errors.New("api key must not be empty")
+	ErrInvalidScheme = errors.New("scheme must be http or https")
+	ErrEmptyHost     = errors.New("host must not be empty")
+)
+
 // Client is the client interface for the Bucketeer APIGateway service.
 type Client interface {
 	GetEvaluation(req *model.GetEvaluationRequest) (*model.GetEvaluationResponse, int, error)
@@ -15,6 +23,7 @@ type Client interface {
 
 type client struct {
 	apiKey string
+	scheme string
 	host   string
 }
 
@@ -23,17 +32,36 @@ type ClientConfig struct {
 	// APIKey is the key to use the Bucketeer APIGateway service.
 	APIKey string
 
+	// Scheme is the scheme of the target service. This must be "http" or "https".
+	Scheme string
+
 	// Host is the host name of the target service, e.g. api.example.com.
 	Host string
 }
 
+// Validate validates the ClientConfig.
+func (c *ClientConfig) Validate() error {
+	if c.APIKey == "" {
+		return ErrEmptyAPIKey
+	}
+	if c.Scheme != "http" && c.Scheme != "https" {
+		return ErrInvalidScheme
+	}
+	if c.Host == "" {
+		return ErrEmptyHost
+	}
+	return nil
+}
+
 // NewClient creates a new Client.
-//
-// NewClient returns error if failed to dial gRPC.
 func NewClient(conf *ClientConfig) (Client, error) {
 	client := &client{
+		scheme: string(conf.Scheme),
 		apiKey: conf.APIKey,
 		host:   conf.Host,
 	}
+	if err := conf.Validate(); err != nil {
+		return nil, err
+	}
 	return client, nil
 }

pkg/bucketeer/option.go

@@ -14,6 +14,7 @@ type options struct {
 	cachePollingInterval  time.Duration
 	tag                   string
 	apiKey                string
+	scheme                string
 	host                  string
 	port                  int
 	eventQueueCapacity    int
@@ -29,6 +30,7 @@ var defaultOptions = options{
 	cachePollingInterval:  1 * time.Minute,
 	tag:                   "",
 	apiKey:                "",
+	scheme:                "https",
 	host:                  "",
 	port:                  443,
 	eventQueueCapacity:    100_000,
@@ -72,6 +74,13 @@ func WithAPIKey(apiKey string) Option {
 	}
 }
 
+// WithScheme sets scheme to use Bucketeer service. (Default: "https")
+func WithScheme(scheme string) Option {
+	return func(opts *options) {
+		opts.scheme = scheme
+	}
+}
+
 // WithHost sets host name for the Bucketeer service. (Default: "")
 func WithHost(host string) Option {
 	return func(opts *options) {

pkg/bucketeer/option_test.go

@@ -15,6 +15,7 @@ func TestWithOptions(t *testing.T) {
 	cachePollingInterval := 30 * time.Second
 	tag := "go-server"
 	apiKey := "apiKey"
+	scheme := "http"
 	host := "host"
 	port := 8443
 	eventQueueCapacity := 100
@@ -29,6 +30,7 @@ func TestWithOptions(t *testing.T) {
 		WithCachePollingInterval(cachePollingInterval),
 		WithTag(tag),
 		WithAPIKey(apiKey),
+		WithScheme(scheme),
 		WithHost(host),
 		WithPort(port),
 		WithEventQueueCapacity(eventQueueCapacity),
@@ -47,6 +49,7 @@ func TestWithOptions(t *testing.T) {
 	assert.Equal(t, cachePollingInterval, dopts.cachePollingInterval)
 	assert.Equal(t, tag, dopts.tag)
 	assert.Equal(t, apiKey, dopts.apiKey)
+	assert.Equal(t, scheme, dopts.scheme)
 	assert.Equal(t, host, dopts.host)
 	assert.Equal(t, port, dopts.port)
 	assert.Equal(t, eventQueueCapacity, dopts.eventQueueCapacity)

pkg/bucketeer/sdk.go

@@ -147,7 +147,11 @@ func NewSDK(ctx context.Context, opts ...Option) (SDK, error) {
 		ErrorLogger:    dopts.errorLogger,
 	}
 	loggers := log.NewLoggers(loggerConf)
-	client, err := api.NewClient(&api.ClientConfig{APIKey: dopts.apiKey, Host: dopts.host})
+	client, err := api.NewClient(&api.ClientConfig{
+		APIKey: dopts.apiKey,
+		Scheme: dopts.scheme,
+		Host:   dopts.host,
+	})
 	if err != nil {
 		return nil, fmt.Errorf("bucketeer: failed to new api client: %w", err)
 	}

test/e2e/api_test.go

@@ -222,6 +222,7 @@ func newAPIClient(t *testing.T, apiKey string) api.Client {
 	conf := &api.ClientConfig{
 		APIKey: apiKey,
 		Host:   *host,
+		Scheme: *scheme,
 	}
 	client, err := api.NewClient(conf)
 	assert.NoError(t, err)

test/e2e/main_test.go

@@ -49,5 +49,6 @@ var (
 	apiKey       = flag.String("api-key", "", "API key for the Bucketeer service")
 	apiKeyServer = flag.String("api-key-server", "", "API key for Server SDK")
 	host         = flag.String("host", "", "Host name of the Bucketeer service, e.g. api-dev.bucketeer.jp")
+	scheme       = flag.String("scheme", "https", "Scheme of the Bucketeer service, e.g. https")
 	port         = flag.Int("port", 443, "Port number of the Bucketeer service, e.g. 443")
 )

test/e2e/sdk_local_evaluation_test.go

@@ -278,6 +278,7 @@ func newLocalSDK(t *testing.T, ctx context.Context) bucketeer.SDK {
 		bucketeer.WithTag(tag),
 		bucketeer.WithAPIKey(*apiKeyServer),
 		bucketeer.WithHost(*host),
+		bucketeer.WithScheme(*scheme),
 		bucketeer.WithPort(*port),
 		bucketeer.WithEventQueueCapacity(100),
 		bucketeer.WithNumEventFlushWorkers(3),

test/e2e/sdk_test.go

@@ -597,6 +597,7 @@ func newSDK(t *testing.T, ctx context.Context) bucketeer.SDK {
 		bucketeer.WithTag(tag),
 		bucketeer.WithAPIKey(*apiKey),
 		bucketeer.WithHost(*host),
+		bucketeer.WithScheme(*scheme),
 		bucketeer.WithPort(*port),
 		bucketeer.WithEventQueueCapacity(100),
 		bucketeer.WithNumEventFlushWorkers(3),