From 691731f10a0fc4f65559ee8914c240074b3d2bec Mon Sep 17 00:00:00 2001
From: Timo Stamm <ts@timostamm.de>
Date: Wed, 15 Feb 2023 21:58:14 +0100
Subject: [PATCH] Use lowercase keys for gRPC-web trailers appended to the
 response body (#461)

As a partial solution to #453, lower-case keys when appending gRPC-Web
trailers to the response body. This is uncontroversial, since it only
affects a portion of the wire format specific to gRPC-Web.

This does _not_ address trailers-only responses or standard response
headers, which the gRPC-Web specification seems to also demand in
lowercase.

---------

Co-authored-by: Akshay Shah <akshay@akshayshah.org>
---
 protocol_grpc.go      | 11 +++++++++++
 protocol_grpc_test.go | 20 ++++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/protocol_grpc.go b/protocol_grpc.go
index 4b5e4492..a102dcdd 100644
--- a/protocol_grpc.go
+++ b/protocol_grpc.go
@@ -582,6 +582,17 @@ type grpcMarshaler struct {
 func (m *grpcMarshaler) MarshalWebTrailers(trailer http.Header) *Error {
 	raw := m.envelopeWriter.bufferPool.Get()
 	defer m.envelopeWriter.bufferPool.Put(raw)
+	for key, values := range trailer {
+		// Per the Go specification, keys inserted during iteration may be produced
+		// later in the iteration or may be skipped. For safety, avoid mutating the
+		// map if the key is already lower-cased.
+		lower := strings.ToLower(key)
+		if key == lower {
+			continue
+		}
+		delete(trailer, key)
+		trailer[lower] = values
+	}
 	if err := trailer.Write(raw); err != nil {
 		return errorf(CodeInternal, "format trailers: %w", err)
 	}
diff --git a/protocol_grpc_test.go b/protocol_grpc_test.go
index 726e9e24..8391a1f0 100644
--- a/protocol_grpc_test.go
+++ b/protocol_grpc_test.go
@@ -174,3 +174,23 @@ func TestGRPCPercentEncoding(t *testing.T) {
 	roundtrip(`foo%bar`)
 	roundtrip("fiancée")
 }
+
+func TestGRPCWebTrailerMarshalling(t *testing.T) {
+	t.Parallel()
+	responseWriter := httptest.NewRecorder()
+	marshaler := grpcMarshaler{
+		envelopeWriter: envelopeWriter{
+			writer:     responseWriter,
+			bufferPool: newBufferPool(),
+		},
+	}
+	trailer := http.Header{}
+	trailer.Add("grpc-status", "0")
+	trailer.Add("Grpc-Message", "Foo")
+	trailer.Add("User-Provided", "bar")
+	err := marshaler.MarshalWebTrailers(trailer)
+	assert.Nil(t, err)
+	responseWriter.Body.Next(5) // skip flags and message length
+	marshalled := responseWriter.Body.String()
+	assert.Equal(t, marshalled, "grpc-message: Foo\r\ngrpc-status: 0\r\nuser-provided: bar\r\n")
+}