- adds support for multi-valued headers

CHANGELOG.md

@@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+## [0.15.0] - 2022-12-15
+
+### Added
+
+- Added support for multi-valued request headers.
+
 ## [0.14.0] - 2022-10-28
 
 ### Changed

authentication/api_key_authentication_provider.go

@@ -83,7 +83,7 @@ func (p *ApiKeyAuthenticationProvider) AuthenticateRequest(ctx context.Context,
 		url.RawQuery = query.Encode()
 		request.SetUri(*url)
 	case HEADER_KEYLOCATION:
-		request.Headers[p.parameterName] = p.apiKey
+		request.Headers.Add(p.parameterName, p.apiKey)
 	}
 
 	return nil

authentication/api_key_authentication_provider_test.go

@@ -42,7 +42,7 @@ func TestItAddsInQueryParameters(t *testing.T) {
 	resultUri, err := request.GetUri()
 	assert.Nil(t, err)
 	assert.Equal(t, "https://localhost?param=key", resultUri.String())
-	assert.Equal(t, "", request.Headers["param"])
+	assert.False(t, request.Headers.ContainsKey("param"))
 }
 
 func TestItAddsInQueryParametersWithOtherParameters(t *testing.T) {
@@ -57,7 +57,7 @@ func TestItAddsInQueryParametersWithOtherParameters(t *testing.T) {
 	resultUri, err := request.GetUri()
 	assert.Nil(t, err)
 	assert.Equal(t, "https://localhost?param=key&param1=value1", resultUri.String())
-	assert.Equal(t, "", request.Headers["param"])
+	assert.False(t, request.Headers.ContainsKey("param"))
 }
 
 func TestItAddsInHeader(t *testing.T) {
@@ -71,5 +71,5 @@ func TestItAddsInHeader(t *testing.T) {
 	resultUri, err := request.GetUri()
 	assert.Nil(t, err)
 	assert.Equal(t, "https://localhost", resultUri.String())
-	assert.Equal(t, "key", request.Headers["param"])
+	assert.Equal(t, "key", request.Headers.Get("param")[0])
 }

authentication/base_bearer_token_authentication_provider.go

@@ -27,17 +27,17 @@ func (provider *BaseBearerTokenAuthenticationProvider) AuthenticateRequest(ctx c
 		return errors.New("request is nil")
 	}
 	if request.Headers == nil {
-		request.Headers = make(map[string]string)
+		request.Headers = abs.NewRequestHeaders()
 	}
 	if provider.accessTokenProvider == nil {
 		return errors.New("this class needs to be initialized with an access token provider")
 	}
 	if len(additionalAuthenticationContext) > 0 &&
 		additionalAuthenticationContext[claimsKey] != nil &&
-		request.Headers[authorizationHeader] != "" {
-		request.Headers[authorizationHeader] = ""
+		request.Headers.ContainsKey(authorizationHeader) {
+		request.Headers.Remove(authorizationHeader)
 	}
-	if request.Headers[authorizationHeader] == "" {
+	if request.Headers.ContainsKey(authorizationHeader) {
 		uri, err := request.GetUri()
 		if err != nil {
 			return err
@@ -47,7 +47,7 @@ func (provider *BaseBearerTokenAuthenticationProvider) AuthenticateRequest(ctx c
 			return err
 		}
 		if token != "" {
-			request.Headers[authorizationHeader] = "Bearer " + token
+			request.Headers.Add(authorizationHeader, "Bearer "+token)
 		}
 	}
 

request_headers.go

@@ -0,0 +1,119 @@
+package abstractions
+
+import "strings"
+
+//RequestHeaders represents a collection of request headers
+type RequestHeaders struct {
+	headers map[string]map[string]struct{}
+}
+
+//NewRequestHeaders creates a new RequestHeaders
+func NewRequestHeaders() *RequestHeaders {
+	return &RequestHeaders{
+		headers: make(map[string]map[string]struct{}),
+	}
+}
+
+func (r *RequestHeaders) normalizeHeaderKey(key string) string {
+	return strings.ToLower(strings.Trim(key, " "))
+}
+
+type void struct{}
+
+var voidInstance void
+
+//Add adds a new header or append a new value to an existing header
+func (r *RequestHeaders) Add(key string, value string, additionalValues ...string) {
+	normalizedKey := r.normalizeHeaderKey(key)
+	if normalizedKey == "" || value == "" {
+		return
+	}
+	if r.headers == nil {
+		r.headers = make(map[string]map[string]struct{})
+	}
+	if r.headers[normalizedKey] == nil {
+		r.headers[normalizedKey] = make(map[string]struct{})
+	}
+	r.headers[normalizedKey][value] = voidInstance
+	for _, v := range additionalValues {
+		r.headers[normalizedKey][v] = voidInstance
+	}
+}
+
+//Get returns the values for the specific header
+func (r *RequestHeaders) Get(key string) []string {
+	if r.headers == nil {
+		return nil
+	}
+	normalizedKey := r.normalizeHeaderKey(key)
+	if r.headers[normalizedKey] == nil {
+		return make([]string, 0)
+	}
+	values := make([]string, 0, len(r.headers[normalizedKey]))
+	for k := range r.headers[normalizedKey] {
+		values = append(values, k)
+	}
+	return values
+}
+
+//Remove removes the specific header and all its values
+func (r *RequestHeaders) Remove(key string) {
+	if r.headers == nil {
+		return
+	}
+	normalizedKey := r.normalizeHeaderKey(key)
+	delete(r.headers, normalizedKey)
+}
+
+//RemoveValue remove the value for the specific header
+func (r *RequestHeaders) RemoveValue(key string, value string) {
+	if r.headers == nil {
+		return
+	}
+	normalizedKey := r.normalizeHeaderKey(key)
+	if r.headers[normalizedKey] == nil {
+		return
+	}
+	delete(r.headers[normalizedKey], value)
+	if len(r.headers[normalizedKey]) == 0 {
+		delete(r.headers, normalizedKey)
+	}
+}
+
+//ContainsKey check if the key exists in the headers
+func (r *RequestHeaders) ContainsKey(key string) bool {
+	if r.headers == nil {
+		return false
+	}
+	normalizedKey := r.normalizeHeaderKey(key)
+	return r.headers[normalizedKey] != nil
+}
+
+//Clear clear all headers
+func (r *RequestHeaders) Clear() {
+	r.headers = nil
+}
+
+//AddAll adds all headers from the other RequestHeaders
+func (r *RequestHeaders) AddAll(other *RequestHeaders) {
+	if other == nil || other.headers == nil {
+		return
+	}
+	for k, v := range other.headers {
+		for k2 := range v {
+			r.Add(k, k2)
+		}
+	}
+}
+
+//ListKeys returns all the keys in the headers
+func (r *RequestHeaders) ListKeys() []string {
+	if r.headers == nil {
+		return make([]string, 0)
+	}
+	keys := make([]string, 0, len(r.headers))
+	for k := range r.headers {
+		keys = append(keys, k)
+	}
+	return keys
+}

request_headers_test.go

@@ -0,0 +1,81 @@
+package abstractions
+
+import (
+	"testing"
+
+	assert "github.com/stretchr/testify/assert"
+)
+
+func TestItFollowsDefensivePrograming(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance.Add("", "")
+	assert.False(t, instance.ContainsKey(""))
+	instance.Add("key", "")
+	assert.False(t, instance.ContainsKey("key"))
+	instance.Remove("")
+	instance.RemoveValue("", "")
+	instance.RemoveValue("key", "")
+	instance.AddAll(nil)
+
+	instance = &RequestHeaders{}
+	assert.NotNil(t, instance)
+	instance.Get("key")
+	instance.Remove("key")
+	instance.ListKeys()
+	instance.RemoveValue("key", "value")
+	instance.Add("key", "value")
+
+}
+
+func TestIdAdds(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance.Add("key", "value")
+	assert.True(t, instance.ContainsKey("key"))
+	assert.Equal(t, "value", instance.Get("key")[0])
+}
+
+func TestItRemoves(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance.Add("key", "value")
+	assert.True(t, instance.ContainsKey("key"))
+	instance.Remove("key")
+	assert.False(t, instance.ContainsKey("key"))
+}
+func TestItRemovesValue(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance.Add("key", "value", "value2")
+	assert.True(t, instance.ContainsKey("key"))
+	instance.RemoveValue("key", "value")
+	assert.True(t, instance.ContainsKey("key"))
+	assert.Equal(t, "value2", instance.Get("key")[0])
+}
+func TestItClears(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance.Add("key", "value")
+	assert.True(t, instance.ContainsKey("key"))
+	instance.Clear()
+	assert.False(t, instance.ContainsKey("key"))
+}
+func TestItAddsAll(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance2 := NewRequestHeaders()
+	instance2.Add("key", "value")
+	assert.False(t, instance.ContainsKey("key"))
+	instance.AddAll(instance2)
+	assert.True(t, instance.ContainsKey("key"))
+	assert.Equal(t, "value", instance.Get("key")[0])
+}
+
+func TestIdListKeys(t *testing.T) {
+	instance := NewRequestHeaders()
+	assert.NotNil(t, instance)
+	instance.Add("key", "value")
+	assert.True(t, instance.ContainsKey("key"))
+	assert.Equal(t, "key", instance.ListKeys()[0])
+}

request_information.go

@@ -25,7 +25,7 @@ type RequestInformation struct {
 	Method HttpMethod
 	uri    *u.URL
 	// The Request Headers.
-	Headers map[string]string
+	Headers *RequestHeaders
 	// The Query Parameters of the request.
 	QueryParameters map[string]string
 	// The Request Body.
@@ -42,7 +42,7 @@ const raw_url_key = "request-raw-url"
 // NewRequestInformation creates a new RequestInformation object with default values.
 func NewRequestInformation() *RequestInformation {
 	return &RequestInformation{
-		Headers:         make(map[string]string),
+		Headers:         NewRequestHeaders(),
 		QueryParameters: make(map[string]string),
 		options:         make(map[string]RequestOption),
 		PathParameters:  make(map[string]string),
@@ -151,7 +151,9 @@ const binaryContentType = "application/octet-steam"
 // SetStreamContent sets the request body to a binary stream.
 func (request *RequestInformation) SetStreamContent(content []byte) {
 	request.Content = content
-	request.Headers[contentTypeHeader] = binaryContentType
+	if request.Headers != nil {
+		request.Headers.Add(contentTypeHeader, binaryContentType)
+	}
 }
 
 func (request *RequestInformation) setContentAndContentType(writer s.SerializationWriter, contentType string) error {
@@ -162,7 +164,9 @@ func (request *RequestInformation) setContentAndContentType(writer s.Serializati
 		return errors.New("content cannot be nil")
 	}
 	request.Content = content
-	request.Headers[contentTypeHeader] = contentType
+	if request.Headers != nil {
+		request.Headers.Add(contentTypeHeader, contentType)
+	}
 	return nil
 }
 
@@ -476,16 +480,3 @@ func (request *RequestInformation) AddQueryParameters(source interface{}) {
 		}
 	}
 }
-
-// AddRequestHeaders adds request headers to the request.
-func (request *RequestInformation) AddRequestHeaders(headersToAdd map[string]string) {
-	if len(headersToAdd) == 0 {
-		return
-	}
-	if len(request.Headers) == 0 {
-		request.Headers = make(map[string]string, len(headersToAdd))
-	}
-	for key, value := range headersToAdd {
-		request.Headers[key] = value
-	}
-}