Poc Headers improvements

Signed-off-by: Antonia Trifonova [email protected]

Author: Trifonova.Antonia

protocol/headers.go

@@ -12,10 +12,13 @@
 package protocol
 
 import (
+	"encoding/json"
 	"fmt"
 	"strconv"
 	"strings"
 	"time"
+
+	"github.com/google/uuid"
 )
 
 const (
@@ -72,15 +75,16 @@ const (
 	HeaderContentType = "content-type"
 )
 
-// Headers represents all Ditto-specific headers along with additional HTTP/etc. headers
+// Headers represents all Ditto-specific headers along with additional HTTP/etc. Headers
 // that can be applied depending on the transport used.
-// For the pre-defined headers, the values are in the row type. The getter methods are provided
-// to get the header value in specified type.
+//
+// The header values in this map should be serialized.
+// The provided getter methods returns the header values which is associated with this definition's key.
 // See https://www.eclipse.org/ditto/protocol-specification.html
 type Headers map[string]interface{}
 
 // CorrelationID returns the 'correlation-id' header value if it is presented.
-// If the header value is not presented, the CorrelationID returns empty string.
+// If the header value is not presented, the 'correlation-id' header value will be generated in UUID format.
 //
 // If there are two headers differing only in capitalization CorrelationID returns the first value.
 // To use the provided key to get the value, access the map directly.
@@ -90,10 +94,10 @@ func (h Headers) CorrelationID() string {
 			return v.(string)
 		}
 	}
-	return ""
+	return uuid.New().String()
 }
 
-// Timeout returns the 'timeout' header value if it is presented
+// Timeout returns the 'timeout' header value if it is presented.
 // The default and maximum value is duration of 60 seconds.
 // If the header value is not presented, the Timout returns the default value.
 //
@@ -134,7 +138,7 @@ func parseTimeout(timeout string) (time.Duration, error) {
 				t = time.Duration(i) * time.Second
 			}
 		}
-		if t >= 0 && t < time.Hour {
+		if t >= 0 && t <= 60*time.Second {
 			return t, nil
 		}
 	}
@@ -284,7 +288,7 @@ func (h Headers) ReplyTo() string {
 }
 
 // Version returns the 'version' header value if it is presented.
-// If the header value is not presented, the Version returns 0.
+// If the header value is not presented, the Version returns 2.
 //
 // If there are two headers differing only in capitalization, the Version returns the first value.
 // To use the provided key to get the value, access the map directly.
@@ -294,7 +298,7 @@ func (h Headers) Version() int64 {
 			return v.(int64)
 		}
 	}
-	return 0
+	return 2
 }
 
 // ContentType returns the 'content-type' header value if it is presented.
@@ -325,44 +329,26 @@ func (h Headers) Generic(id string) interface{} {
 	return nil
 }
 
-// // MarshalJSON marshels Headers.
-// func (h *Headers) MarshalJSON() ([]byte, error) {
-// 	// TODO validation
-// 	// convert - timeout - ditto timeout string
-// 	// error for invalid values
-// 	return json.Marshal(h.Values)
-// }
-
-// UnmarshalJSON unmarshels Headers.
-// func (h *Headers) UnmarshalJSON(data []byte) error {
-// 	var m map[string]interface{}
-
-// 	if err := json.Unmarshal(data, &m); err != nil {
-// 		return err
-// 	}
-
-// 	for k := range m {
-// 		// TODO for all headers
-// 		// error for ivalid values
-// 		if strings.EqualFold(k, HeaderTimeout) && m[k] != nil {
-// 			m[k] = parseTimeout(m[k].(string))
-// 		}
-// 	}
-
-// 	h.Values = m
-
-// 	return nil
-// }
-
 // UnmarshalJSON unmarshels Headers.
-// func (h *Headers) UnmarshalJSON(data []byte) error {
-// 	temp := make(map[string]interface{})
-// 	if err := json.Unmarshal(data, &temp); err != nil {
-// 		return err
-// 	}
-// 	*h = temp
-// 	return nil
-// }
+//
+// The header names are case-insensitive and case-preserving.
+// If there is the same header name as the provided and the difference is
+// in capitalization the new header name will be set.
+func (h *Headers) UnmarshalJSON(data []byte) error {
+	temp := make(map[string]interface{})
+	if err := json.Unmarshal(data, &temp); err != nil {
+		return err
+	}
+	for k := range temp {
+		for k1 := range *h {
+			if strings.EqualFold(k, k1) {
+				delete(*h, k1)
+			}
+		}
+	}
+	*h = temp
+	return nil
+}
 
 // With sets new Headers to the existing.
 func (h Headers) With(opts ...HeaderOpt) Headers {

protocol/headers_opts.go

@@ -13,6 +13,7 @@ package protocol
 
 import (
 	"strconv"
+	"strings"
 	"time"
 )
 
@@ -188,8 +189,17 @@ func WithContentType(contentType string) HeaderOpt {
 }
 
 // WithGeneric sets the value of the provided key header.
+//
+// The header names are case-insensitive and case-preserving.
+// If there is the same header name as the provided and the difference is
+// in capitalization the new header name will be set.
 func WithGeneric(headerID string, value interface{}) HeaderOpt {
 	return func(headers Headers) error {
+		for k := range headers {
+			if strings.EqualFold(k, headerID) {
+				delete(headers, k)
+			}
+		}
 		headers[headerID] = value
 		return nil
 	}

protocol/headers_test.go

@@ -30,9 +30,7 @@ func TestHeadersCorrelationID(t *testing.T) {
 		},
 		"test_without_correlation_id": {
 			testHeader: Headers{},
-			want:       "",
 		},
-
 		"test_empty_correlation_id": {
 			testHeader: Headers{HeaderCorrelationID: ""},
 			want:       "",
@@ -42,7 +40,11 @@ func TestHeadersCorrelationID(t *testing.T) {
 	for testName, testCase := range tests {
 		t.Run(testName, func(t *testing.T) {
 			got := testCase.testHeader.CorrelationID()
-			internal.AssertEqual(t, testCase.want, got)
+			if testCase.testHeader[HeaderCorrelationID] == nil {
+				internal.AssertNotNil(t, got)
+			} else {
+				internal.AssertEqual(t, testCase.want, got)
+			}
 		})
 	}
 }
@@ -367,7 +369,7 @@ func TestHeadersVersion(t *testing.T) {
 		},
 		"test_without_version": {
 			testHeader: Headers{},
-			want:       0,
+			want:       2,
 		},
 	}
 
@@ -509,3 +511,16 @@ func TestCaseInsensitiveKey(t *testing.T) {
 	json.Unmarshal([]byte(data), &envelope.Headers)
 	internal.AssertEqual(t, "correlation-id-3", envelope.Headers["correlation-iD"])
 }
+
+func TestCasePreservedKey(t *testing.T) {
+	headers := Headers{HeaderCorrelationID: "correlation-id-1"}
+
+	data := `{
+	    "correlation-iD":"correlation-id-2"
+	}`
+
+	want := Headers{"correlation-iD": "correlation-id-2"}
+
+	headers.UnmarshalJSON([]byte(data))
+	internal.AssertEqual(t, want, headers)
+}