-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
util.go
462 lines (418 loc) · 15.2 KB
/
util.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
/*
Copyright 2021 The Dapr Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1
import (
"context"
"encoding/base64"
"net/http"
"strconv"
"strings"
"go.opencensus.io/trace"
"go.opencensus.io/trace/propagation"
epb "google.golang.org/genproto/googleapis/rpc/errdetails"
spb "google.golang.org/genproto/googleapis/rpc/status"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
grpc_status "google.golang.org/grpc/status"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/reflect/protoreflect"
diag "github.com/dapr/dapr/pkg/diagnostics"
diag_utils "github.com/dapr/dapr/pkg/diagnostics/utils"
internalv1pb "github.com/dapr/dapr/pkg/proto/internals/v1"
)
const (
// GRPCContentType is the MIME media type for grpc.
GRPCContentType = "application/grpc"
// JSONContentType is the MIME media type for JSON.
JSONContentType = "application/json"
// ProtobufContentType is the MIME media type for Protobuf.
ProtobufContentType = "application/x-protobuf"
// ContentTypeHeader is the header key of content-type.
ContentTypeHeader = "content-type"
// DaprHeaderPrefix is the prefix if metadata is defined by non user-defined http headers.
DaprHeaderPrefix = "dapr-"
// gRPCBinaryMetadata is the suffix of grpc metadata binary value.
gRPCBinaryMetadataSuffix = "-bin"
// W3C trace correlation headers.
traceparentHeader = "traceparent"
tracestateHeader = "tracestate"
tracebinMetadata = "grpc-trace-bin"
// DestinationIDHeader is the header carrying the value of the invoked app id.
DestinationIDHeader = "destination-app-id"
// ErrorInfo metadata value is limited to 64 chars
// https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto#L126
maxMetadataValueLen = 63
// ErrorInfo metadata for HTTP response.
errorInfoDomain = "dapr.io"
errorInfoHTTPCodeMetadata = "http.code"
errorInfoHTTPErrorMetadata = "http.error_message"
)
// DaprInternalMetadata is the metadata type to transfer HTTP header and gRPC metadata
// from user app to Dapr.
type DaprInternalMetadata map[string]*internalv1pb.ListStringValue
// IsJSONContentType returns true if contentType is the mime media type for JSON.
func IsJSONContentType(contentType string) bool {
return strings.HasPrefix(strings.ToLower(contentType), JSONContentType)
}
// MetadataToInternalMetadata converts metadata to dapr internal metadata map.
func MetadataToInternalMetadata(md map[string][]string) DaprInternalMetadata {
internalMD := DaprInternalMetadata{}
for k, values := range md {
listValue := internalv1pb.ListStringValue{}
if strings.HasSuffix(k, gRPCBinaryMetadataSuffix) {
// binary key requires base64 encoded.
for _, val := range values {
listValue.Values = append(listValue.Values, base64.StdEncoding.EncodeToString([]byte(val)))
}
} else {
listValue.Values = append(listValue.Values, values...)
}
internalMD[k] = &listValue
}
return internalMD
}
// isPermanentHTTPHeader checks whether hdr belongs to the list of
// permanent request headers maintained by IANA.
// http://www.iana.org/assignments/message-headers/message-headers.xml
func isPermanentHTTPHeader(hdr string) bool {
switch hdr {
case
"Accept",
"Accept-Charset",
"Accept-Language",
"Accept-Ranges",
// Connection-specific header fields such as Connection and Keep-Alive are prohibited in HTTP/2.
// See https://tools.ietf.org/html/rfc7540#section-8.1.2.2.
"Connection",
"Keep-Alive",
"Proxy-Connection",
"Transfer-Encoding",
"Upgrade",
"Cache-Control",
"Content-Type",
// Remove content-length header since it represents http1.1 payload size,
// not the sum of the h2 DATA frame payload lengths.
// See https://httpwg.org/specs/rfc7540.html#malformed.
"Content-Length",
"Cookie",
"Date",
"Expect",
"From",
"Host",
"If-Match",
"If-Modified-Since",
"If-None-Match",
"If-Schedule-Tag-Match",
"If-Unmodified-Since",
"Max-Forwards",
"Origin",
"Pragma",
"Referer",
"Via",
"Warning":
return true
}
return false
}
// InternalMetadataToGrpcMetadata converts internal metadata map to gRPC metadata.
func InternalMetadataToGrpcMetadata(ctx context.Context, internalMD DaprInternalMetadata, httpHeaderConversion bool) metadata.MD {
var traceparentValue, tracestateValue, grpctracebinValue string
md := metadata.MD{}
for k, listVal := range internalMD {
keyName := strings.ToLower(k)
// get both the trace headers for HTTP/GRPC and continue
switch keyName {
case traceparentHeader:
traceparentValue = listVal.Values[0]
continue
case tracestateHeader:
tracestateValue = listVal.Values[0]
continue
case tracebinMetadata:
grpctracebinValue = listVal.Values[0]
continue
case DestinationIDHeader:
continue
}
if httpHeaderConversion && isPermanentHTTPHeader(k) {
keyName = strings.ToLower(DaprHeaderPrefix + keyName)
}
if strings.HasSuffix(k, gRPCBinaryMetadataSuffix) {
// decoded base64 encoded key binary
for _, val := range listVal.Values {
decoded, err := base64.StdEncoding.DecodeString(val)
if err == nil {
md.Append(keyName, string(decoded))
}
}
} else {
md.Append(keyName, listVal.Values...)
}
}
if IsGRPCProtocol(internalMD) {
processGRPCToGRPCTraceHeader(ctx, md, grpctracebinValue)
} else {
// if httpProtocol, then pass HTTP traceparent and HTTP tracestate header values, attach it in grpc-trace-bin header
processHTTPToGRPCTraceHeader(ctx, md, traceparentValue, tracestateValue)
}
return md
}
// IsGRPCProtocol checks if metadata is originated from gRPC API.
func IsGRPCProtocol(internalMD DaprInternalMetadata) bool {
originContentType := ""
if val, ok := internalMD[ContentTypeHeader]; ok {
originContentType = val.Values[0]
}
return strings.HasPrefix(originContentType, GRPCContentType)
}
func reservedGRPCMetadataToDaprPrefixHeader(key string) string {
// https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md
if key == ":method" || key == ":scheme" || key == ":path" || key == ":authority" {
return DaprHeaderPrefix + key[1:]
}
if strings.HasPrefix(key, "grpc-") {
return DaprHeaderPrefix + key
}
return key
}
// InternalMetadataToHTTPHeader converts internal metadata pb to HTTP headers.
func InternalMetadataToHTTPHeader(ctx context.Context, internalMD DaprInternalMetadata, setHeader func(string, string)) {
var traceparentValue, tracestateValue, grpctracebinValue string
for k, listVal := range internalMD {
keyName := strings.ToLower(k)
// get both the trace headers for HTTP/GRPC and continue
switch keyName {
case traceparentHeader:
traceparentValue = listVal.Values[0]
continue
case tracestateHeader:
tracestateValue = listVal.Values[0]
continue
case tracebinMetadata:
grpctracebinValue = listVal.Values[0]
continue
case DestinationIDHeader:
continue
}
if len(listVal.Values) == 0 || strings.HasSuffix(keyName, gRPCBinaryMetadataSuffix) || keyName == ContentTypeHeader {
continue
}
setHeader(reservedGRPCMetadataToDaprPrefixHeader(keyName), listVal.Values[0])
}
if IsGRPCProtocol(internalMD) {
// if grpcProtocol, then get grpc-trace-bin value, and attach it in HTTP traceparent and HTTP tracestate header
processGRPCToHTTPTraceHeaders(ctx, grpctracebinValue, setHeader)
} else {
processHTTPToHTTPTraceHeaders(ctx, traceparentValue, tracestateValue, setHeader)
}
}
// HTTPStatusFromCode converts a gRPC error code into the corresponding HTTP response status.
// https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go#L15
// See: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
func HTTPStatusFromCode(code codes.Code) int {
switch code {
case codes.OK:
return http.StatusOK
case codes.Canceled:
return http.StatusRequestTimeout
case codes.Unknown:
return http.StatusInternalServerError
case codes.InvalidArgument:
return http.StatusBadRequest
case codes.DeadlineExceeded:
return http.StatusGatewayTimeout
case codes.NotFound:
return http.StatusNotFound
case codes.AlreadyExists:
return http.StatusConflict
case codes.PermissionDenied:
return http.StatusForbidden
case codes.Unauthenticated:
return http.StatusUnauthorized
case codes.ResourceExhausted:
return http.StatusTooManyRequests
case codes.FailedPrecondition:
// Note, this deliberately doesn't translate to the similarly named '412 Precondition Failed' HTTP response status.
return http.StatusBadRequest
case codes.Aborted:
return http.StatusConflict
case codes.OutOfRange:
return http.StatusBadRequest
case codes.Unimplemented:
return http.StatusNotImplemented
case codes.Internal:
return http.StatusInternalServerError
case codes.Unavailable:
return http.StatusServiceUnavailable
case codes.DataLoss:
return http.StatusInternalServerError
}
return http.StatusInternalServerError
}
// CodeFromHTTPStatus converts http status code to gRPC status code
// See: https://github.com/grpc/grpc/blob/master/doc/http-grpc-status-mapping.md
func CodeFromHTTPStatus(httpStatusCode int) codes.Code {
switch httpStatusCode {
case http.StatusRequestTimeout:
return codes.Canceled
case http.StatusInternalServerError:
return codes.Unknown
case http.StatusBadRequest:
return codes.Internal
case http.StatusGatewayTimeout:
return codes.DeadlineExceeded
case http.StatusNotFound:
return codes.NotFound
case http.StatusConflict:
return codes.AlreadyExists
case http.StatusForbidden:
return codes.PermissionDenied
case http.StatusUnauthorized:
return codes.Unauthenticated
case http.StatusTooManyRequests:
return codes.ResourceExhausted
case http.StatusNotImplemented:
return codes.Unimplemented
case http.StatusServiceUnavailable:
return codes.Unavailable
}
if httpStatusCode >= 200 && httpStatusCode < 300 {
return codes.OK
}
return codes.Unknown
}
// ErrorFromHTTPResponseCode converts http response code to gRPC status error.
func ErrorFromHTTPResponseCode(code int, detail string) error {
grpcCode := CodeFromHTTPStatus(code)
if grpcCode == codes.OK {
return nil
}
httpStatusText := http.StatusText(code)
respStatus := grpc_status.New(grpcCode, httpStatusText)
// Truncate detail string longer than 64 characters
if len(detail) >= maxMetadataValueLen {
detail = detail[:maxMetadataValueLen]
}
resps, err := respStatus.WithDetails(
&epb.ErrorInfo{
Reason: httpStatusText,
Domain: errorInfoDomain,
Metadata: map[string]string{
errorInfoHTTPCodeMetadata: strconv.Itoa(code),
errorInfoHTTPErrorMetadata: detail,
},
},
)
if err != nil {
resps = respStatus
}
return resps.Err()
}
// ErrorFromInternalStatus converts internal status to gRPC status error.
func ErrorFromInternalStatus(internalStatus *internalv1pb.Status) error {
respStatus := &spb.Status{
Code: internalStatus.GetCode(),
Message: internalStatus.GetMessage(),
Details: internalStatus.GetDetails(),
}
return grpc_status.ErrorProto(respStatus)
}
func processGRPCToHTTPTraceHeaders(ctx context.Context, traceContext string, setHeader func(string, string)) {
// attach grpc-trace-bin value in traceparent and tracestate header
decoded, _ := base64.StdEncoding.DecodeString(traceContext)
sc, ok := propagation.FromBinary(decoded)
if !ok {
span := diag_utils.SpanFromContext(ctx)
sc = span.SpanContext()
}
diag.SpanContextToHTTPHeaders(sc, setHeader)
}
func processHTTPToHTTPTraceHeaders(ctx context.Context, traceparentValue, traceStateValue string, setHeader func(string, string)) {
if traceparentValue == "" {
span := diag_utils.SpanFromContext(ctx)
diag.SpanContextToHTTPHeaders(span.SpanContext(), setHeader)
} else {
setHeader(traceparentHeader, traceparentValue)
if traceStateValue != "" {
setHeader(tracestateHeader, traceStateValue)
}
}
}
func processHTTPToGRPCTraceHeader(ctx context.Context, md metadata.MD, traceparentValue, traceStateValue string) {
var sc trace.SpanContext
var ok bool
if sc, ok = diag.SpanContextFromW3CString(traceparentValue); ok {
sc.Tracestate = diag.TraceStateFromW3CString(traceStateValue)
} else {
span := diag_utils.SpanFromContext(ctx)
sc = span.SpanContext()
}
// Workaround for lack of grpc-trace-bin support in OpenTelemetry (unlike OpenCensus), tracking issue https://github.com/open-telemetry/opentelemetry-specification/issues/639
// grpc-dotnet client adheres to OpenTelemetry Spec which only supports http based traceparent header in gRPC path
// TODO : Remove this workaround fix once grpc-dotnet supports grpc-trace-bin header. Tracking issue https://github.com/dapr/dapr/issues/1827
diag.SpanContextToHTTPHeaders(sc, func(header, value string) {
md.Set(header, value)
})
md.Set(tracebinMetadata, string(propagation.Binary(sc)))
}
func processGRPCToGRPCTraceHeader(ctx context.Context, md metadata.MD, grpctracebinValue string) {
if grpctracebinValue == "" {
span := diag_utils.SpanFromContext(ctx)
sc := span.SpanContext()
// Workaround for lack of grpc-trace-bin support in OpenTelemetry (unlike OpenCensus), tracking issue https://github.com/open-telemetry/opentelemetry-specification/issues/639
// grpc-dotnet client adheres to OpenTelemetry Spec which only supports http based traceparent header in gRPC path
// TODO : Remove this workaround fix once grpc-dotnet supports grpc-trace-bin header. Tracking issue https://github.com/dapr/dapr/issues/1827
diag.SpanContextToHTTPHeaders(sc, func(header, value string) {
md.Set(header, value)
})
md.Set(tracebinMetadata, string(propagation.Binary(sc)))
} else {
decoded, err := base64.StdEncoding.DecodeString(grpctracebinValue)
if err == nil {
// Workaround for lack of grpc-trace-bin support in OpenTelemetry (unlike OpenCensus), tracking issue https://github.com/open-telemetry/opentelemetry-specification/issues/639
// grpc-dotnet client adheres to OpenTelemetry Spec which only supports http based traceparent header in gRPC path
// TODO : Remove this workaround fix once grpc-dotnet supports grpc-trace-bin header. Tracking issue https://github.com/dapr/dapr/issues/1827
if sc, ok := propagation.FromBinary(decoded); ok {
diag.SpanContextToHTTPHeaders(sc, func(header, value string) {
md.Set(header, value)
})
}
md.Set(tracebinMetadata, string(decoded))
}
}
}
func cloneBytes(data []byte) []byte {
if data == nil {
return nil
}
cloneData := make([]byte, len(data))
copy(cloneData, data)
return cloneData
}
// ProtobufToJSON serializes Protobuf message to json format.
func ProtobufToJSON(message protoreflect.ProtoMessage) ([]byte, error) {
marshaler := protojson.MarshalOptions{
Indent: "",
UseProtoNames: false,
EmitUnpopulated: false,
}
return marshaler.Marshal(message)
}
// WithCustomGRPCMetadata applies a metadata map to the outgoing context metadata.
func WithCustomGRPCMetadata(ctx context.Context, md map[string]string) context.Context {
for k, v := range md {
// Uppercase keys will be converted to lowercase.
ctx = metadata.AppendToOutgoingContext(ctx, k, v)
}
return ctx
}