ctx: change signatures of GetReqHeaders and GetRespHeaders (#2650)

* ctx: change signatures of GetReqHeaders and GetRespHeaders * fix middlewares
gofiber · Sep 28, 2023 · a9447a5 · a9447a5
1 parent c0988de
commit a9447a5
Show file tree

Hide file tree

Showing 7 changed files with 103 additions and 26 deletions.
diff --git a/ctx.go b/ctx.go
@@ -651,10 +651,11 @@ func (c *Ctx) GetRespHeader(key string, defaultValue ...string) string {
 // GetReqHeaders returns the HTTP request headers.
 // Returned value is only valid within the handler. Do not store any references.
 // Make copies or use the Immutable setting instead.
-func (c *Ctx) GetReqHeaders() map[string]string {
-	headers := make(map[string]string)
+func (c *Ctx) GetReqHeaders() map[string][]string {
+	headers := make(map[string][]string)
 	c.Request().Header.VisitAll(func(k, v []byte) {
-		headers[c.app.getString(k)] = c.app.getString(v)
+		key := c.app.getString(k)
+		headers[key] = append(headers[key], c.app.getString(v))
 	})
 
 	return headers
@@ -663,10 +664,11 @@ func (c *Ctx) GetReqHeaders() map[string]string {
 // GetRespHeaders returns the HTTP response headers.
 // Returned value is only valid within the handler. Do not store any references.
 // Make copies or use the Immutable setting instead.
-func (c *Ctx) GetRespHeaders() map[string]string {
-	headers := make(map[string]string)
+func (c *Ctx) GetRespHeaders() map[string][]string {
+	headers := make(map[string][]string)
 	c.Response().Header.VisitAll(func(k, v []byte) {
-		headers[c.app.getString(k)] = c.app.getString(v)
+		key := c.app.getString(k)
+		headers[key] = append(headers[key], c.app.getString(v))
 	})
 
 	return headers

diff --git a/ctx_test.go b/ctx_test.go
@@ -5117,12 +5117,39 @@ func Test_Ctx_GetRespHeaders(t *testing.T) {
 
 	c.Set("test", "Hello, World 👋!")
 	c.Set("foo", "bar")
+	c.Response().Header.Set("multi", "one")
+	c.Response().Header.Add("multi", "two")
 	c.Response().Header.Set(HeaderContentType, "application/json")
 
-	utils.AssertEqual(t, c.GetRespHeaders(), map[string]string{
-		"Content-Type": "application/json",
-		"Foo":          "bar",
-		"Test":         "Hello, World 👋!",
+	utils.AssertEqual(t, c.GetRespHeaders(), map[string][]string{
+		"Content-Type": {"application/json"},
+		"Foo":          {"bar"},
+		"Multi":        {"one", "two"},
+		"Test":         {"Hello, World 👋!"},
+	})
+}
+
+func Benchmark_Ctx_GetRespHeaders(b *testing.B) {
+	app := New()
+	c := app.AcquireCtx(&fasthttp.RequestCtx{})
+	defer app.ReleaseCtx(c)
+
+	c.Response().Header.Set("test", "Hello, World 👋!")
+	c.Response().Header.Set("foo", "bar")
+	c.Response().Header.Set(HeaderContentType, "application/json")
+
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	var headers map[string][]string
+	for n := 0; n < b.N; n++ {
+		headers = c.GetRespHeaders()
+	}
+
+	utils.AssertEqual(b, headers, map[string][]string{
+		"Content-Type": {"application/json"},
+		"Foo":          {"bar"},
+		"Test":         {"Hello, World 👋!"},
 	})
 }
 
@@ -5133,14 +5160,41 @@ func Test_Ctx_GetReqHeaders(t *testing.T) {
 	c := app.AcquireCtx(&fasthttp.RequestCtx{})
 	defer app.ReleaseCtx(c)
 
+	c.Request().Header.Set("test", "Hello, World 👋!")
+	c.Request().Header.Set("foo", "bar")
+	c.Request().Header.Set("multi", "one")
+	c.Request().Header.Add("multi", "two")
+	c.Request().Header.Set(HeaderContentType, "application/json")
+
+	utils.AssertEqual(t, c.GetReqHeaders(), map[string][]string{
+		"Content-Type": {"application/json"},
+		"Foo":          {"bar"},
+		"Test":         {"Hello, World 👋!"},
+		"Multi":        {"one", "two"},
+	})
+}
+
+func Benchmark_Ctx_GetReqHeaders(b *testing.B) {
+	app := New()
+	c := app.AcquireCtx(&fasthttp.RequestCtx{})
+	defer app.ReleaseCtx(c)
+
 	c.Request().Header.Set("test", "Hello, World 👋!")
 	c.Request().Header.Set("foo", "bar")
 	c.Request().Header.Set(HeaderContentType, "application/json")
 
-	utils.AssertEqual(t, c.GetReqHeaders(), map[string]string{
-		"Content-Type": "application/json",
-		"Foo":          "bar",
-		"Test":         "Hello, World 👋!",
+	b.ReportAllocs()
+	b.ResetTimer()
+
+	var headers map[string][]string
+	for n := 0; n < b.N; n++ {
+		headers = c.GetReqHeaders()
+	}
+
+	utils.AssertEqual(b, headers, map[string][]string{
+		"Content-Type": {"application/json"},
+		"Foo":          {"bar"},
+		"Test":         {"Hello, World 👋!"},
 	})
 }
 

diff --git a/docs/api/ctx.md b/docs/api/ctx.md
@@ -554,7 +554,7 @@ app.Get("/", func(c *fiber.Ctx) error {
 Returns the HTTP request headers.
 
 ```go title="Signature"
-func (c *Ctx) GetReqHeaders() map[string]string
+func (c *Ctx) GetReqHeaders() map[string][]string
 ```
 
 > _Returned value is only valid within the handler. Do not store any references.  
@@ -589,7 +589,7 @@ app.Get("/", func(c *fiber.Ctx) error {
 Returns the HTTP response headers.
 
 ```go title="Signature"
-func (c *Ctx) GetRespHeaders() map[string]string
+func (c *Ctx) GetRespHeaders() map[string][]string
 ```
 
 > _Returned value is only valid within the handler. Do not store any references.  

diff --git a/middleware/idempotency/idempotency.go b/middleware/idempotency/idempotency.go
@@ -45,8 +45,10 @@ func New(config ...Config) fiber.Handler {
 
 			_ = c.Status(res.StatusCode)
 
-			for header, val := range res.Headers {
-				c.Set(header, val)
+			for header, vals := range res.Headers {
+				for _, val := range vals {
+					c.Context().Response.Header.Add(header, val)
+				}
 			}
 
 			if len(res.Body) != 0 {
@@ -122,7 +124,7 @@ func New(config ...Config) fiber.Handler {
 				res.Headers = headers
 			} else {
 				// Filter
-				res.Headers = make(map[string]string)
+				res.Headers = make(map[string][]string)
 				for h := range headers {
 					if _, ok := keepResponseHeadersMap[utils.ToLower(h)]; ok {
 						res.Headers[h] = headers[h]

diff --git a/middleware/idempotency/response.go b/middleware/idempotency/response.go
@@ -4,7 +4,7 @@ package idempotency
 type response struct {
 	StatusCode int `msg:"sc"`
 
-	Headers map[string]string `msg:"hs"`
+	Headers map[string][]string `msg:"hs"`
 
 	Body []byte `msg:"b"`
 }
diff --git a/middleware/idempotency/response_msgp.go b/middleware/idempotency/response_msgp.go
diff --git a/middleware/logger/tags.go b/middleware/logger/tags.go
@@ -102,7 +102,7 @@ func createTagMap(cfg *Config) map[string]LogFunc {
 		TagReqHeaders: func(output Buffer, c *fiber.Ctx, data *Data, extraParam string) (int, error) {
 			reqHeaders := make([]string, 0)
 			for k, v := range c.GetReqHeaders() {
-				reqHeaders = append(reqHeaders, k+"="+v)
+				reqHeaders = append(reqHeaders, k+"="+strings.Join(v, ","))
 			}
 			return output.Write([]byte(strings.Join(reqHeaders, "&")))
 		},