-
Notifications
You must be signed in to change notification settings - Fork 33
/
context.go
executable file
·69 lines (62 loc) · 2.06 KB
/
context.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
// Copyright 2022 Google LLC. All Rights Reserved.
//
// 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 dcl
import (
"context"
"fmt"
glog "github.com/golang/glog"
)
// ReqCtxKey is the key type for storing values in the context.
// Context requires custom type key.
type ReqCtxKey string
// Keys used in context Value.
const (
DoNotLogRequestsKey ReqCtxKey = "DoNotLogRequestsKey"
APIRequestIDKey ReqCtxKey = "APIRequestIDKey"
)
// APIRequestID returns the RequestID for the API call.
// APIRequestID is supposed to be used in log to help with debugging
// Since we do not want explicit error handling everywhere we are logging, so not throwing error.
// Its okay to print empty requestID in worse scenario.
func APIRequestID(ctx context.Context) string {
val := ctx.Value(APIRequestIDKey)
if val == nil {
return ""
}
requestID, ok := val.(string)
if !ok {
glog.Warning("Could not convert APIRequestID val to string")
return ""
}
return requestID
}
// ShouldLogRequest returns true if the request should be logged.
func ShouldLogRequest(ctx context.Context) (bool, error) {
val := ctx.Value(DoNotLogRequestsKey)
if val == nil {
return true, nil
}
doNotLog, ok := val.(bool)
if !ok {
return false, fmt.Errorf("could not convert DoNotLogRequests value to bool")
}
return !doNotLog, nil
}
// ContextWithRequestID adds APIRequestID to ctx if APIRequestID is not present.
func ContextWithRequestID(ctx context.Context) context.Context {
if APIRequestID(ctx) != "" {
return ctx
}
return context.WithValue(ctx, APIRequestIDKey, CreateAPIRequestID())
}