forked from cisco-app-networking/networkservicemesh
-
Notifications
You must be signed in to change notification settings - Fork 0
/
context.go
295 lines (265 loc) · 9.51 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
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
// Copyright (c) 2019 Cisco and/or its affiliates.
//
// 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 common
import (
"context"
"github.com/networkservicemesh/networkservicemesh/pkg/tools/spanhelper"
"github.com/networkservicemesh/networkservicemesh/sdk/monitor/connectionmonitor"
"github.com/sirupsen/logrus"
"github.com/networkservicemesh/networkservicemesh/controlplane/api/registry"
"github.com/networkservicemesh/networkservicemesh/controlplane/pkg/model"
"github.com/networkservicemesh/networkservicemesh/controlplane/api/connection"
)
// ContextKeyType - a type object for context values.
type ContextKeyType string
const (
clientConnectionKey ContextKeyType = "ClientConnection"
modelConnectionKey ContextKeyType = "ModelConnection"
monitorServerKey ContextKeyType = "ConnectionMonitor"
logKey ContextKeyType = "Log"
forwarderKey ContextKeyType = "Forwarder"
endpointKey ContextKeyType = "Endpoint"
endpointConnectionKey ContextKeyType = "EndpointConnection"
originalSpan ContextKeyType = "OriginalSpan"
ignoredEndpoints ContextKeyType = "IgnoredEndpoints"
workspaceName ContextKeyType = "WorkspaceName"
remoteMechanisms ContextKeyType = "RemoteMechanisms"
)
// WithClientConnection -
// Wraps 'parent' in a new Context that has the ClientConnection
// provided in:
// connection *connection.Connection
// using Context.Value(...) and returns the result.
// Note: any previously existing ClientConnection will be overwritten.
//
// Recommended use: in any Request or Close call that creates a ClientConnection, call:
// ctx = WithClientConnection(ctx)
// to ensure that the ctx has a ClientConnection
// In any Request or Close call that consumes a ClientConnection, call:
// connectionMap := ClientConnection(ctx)
// to retrieve the ClientConnection from the context.Context
func WithClientConnection(parent context.Context, connection *connection.Connection) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, clientConnectionKey, connection)
}
// ClientConnection -
// Returns a ClientConnection from:
// ctx context.Context
// If any is present, otherwise nil
func ClientConnection(ctx context.Context) *connection.Connection {
conn := ctx.Value(clientConnectionKey)
if conn == nil {
return nil
}
return conn.(*connection.Connection)
}
// WithLog -
// Provides a FieldLogger in context
func WithLog(parent context.Context, log logrus.FieldLogger) context.Context {
if parent == nil {
parent = context.TODO()
}
return context.WithValue(parent, logKey, log)
}
// Log - return FieldLogger from context
func Log(ctx context.Context) logrus.FieldLogger {
if rv, ok := ctx.Value(logKey).(logrus.FieldLogger); ok {
return rv
}
return logrus.New()
}
// WithConnectionMonitor -
// Wraps 'parent' in a new Context that has the local connection Monitor
// using Context.Value(...) and returns the result.
// Note: any previously existing ConnectionMonitor will be overwritten.
//
func WithConnectionMonitor(parent context.Context, monitorServer connectionmonitor.MonitorServer) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, monitorServerKey, monitorServer)
}
// ConnectionMonitor -
// Returns a ConnectionMonitor from:
// ctx context.Context
// If any is present, otherwise nil
func ConnectionMonitor(ctx context.Context) connectionmonitor.MonitorServer {
value := ctx.Value(monitorServerKey)
if value == nil {
return nil
}
return value.(connectionmonitor.MonitorServer)
}
// WithModelConnection -
// Wraps 'parent' in a new Context that has the model connection
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithModelConnection(parent context.Context, connection *model.ClientConnection) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, modelConnectionKey, connection)
}
// ModelConnection -
// Returns a ModelConnection from:
// ctx context.Context
// If any is present, otherwise nil
func ModelConnection(ctx context.Context) *model.ClientConnection {
conn := ctx.Value(modelConnectionKey)
if conn == nil {
return nil
}
return conn.(*model.ClientConnection)
}
// WithRemoteMechanisms -
// Wraps 'parent' in a new Context that has the remote mechanisms
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithRemoteMechanisms(parent context.Context, mechanisms []*connection.Mechanism) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, remoteMechanisms, mechanisms)
}
// RemoteMechanisms -
// Returns a Mechanism from:
// ctx context.Context
// If any is present, otherwise nil
func RemoteMechanisms(ctx context.Context) []*connection.Mechanism {
value := ctx.Value(remoteMechanisms)
if value == nil {
return nil
}
return value.([]*connection.Mechanism)
}
// WithForwarder -
// Wraps 'parent' in a new Context that has the forwarder selected
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithForwarder(parent context.Context, dp *model.Forwarder) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, forwarderKey, dp)
}
// Forwarder - Return forwarder
//
func Forwarder(ctx context.Context) *model.Forwarder {
value := ctx.Value(forwarderKey)
if value == nil {
return nil
}
return value.(*model.Forwarder)
}
// WithEndpoint -
// Wraps 'parent' in a new Context that has the endpoint selected
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithEndpoint(parent context.Context, endpoint *registry.NSERegistration) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, endpointKey, endpoint)
}
// Endpoint - Return selected endpoint object
func Endpoint(ctx context.Context) *registry.NSERegistration {
value := ctx.Value(endpointKey)
if value == nil {
return nil
}
return value.(*registry.NSERegistration)
}
// WithEndpointConnection -
// Wraps 'parent' in a new Context that has endpoint connection object
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithEndpointConnection(parent context.Context, connection *connection.Connection) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, endpointConnectionKey, connection)
}
// EndpointConnection - Return endpoint connection object
func EndpointConnection(ctx context.Context) *connection.Connection {
value := ctx.Value(endpointConnectionKey)
if value == nil {
return nil
}
return value.(*connection.Connection)
}
// WithOriginalSpan -
// Wraps 'parent' in a new Context that has the original opentracing Span.
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithOriginalSpan(parent context.Context, span spanhelper.SpanHelper) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, originalSpan, span)
}
// OriginalSpan - Return forwarder
func OriginalSpan(ctx context.Context) spanhelper.SpanHelper {
value := ctx.Value(originalSpan)
if value == nil {
return nil
}
return value.(spanhelper.SpanHelper)
}
// WithIgnoredEndpoints -
// Wraps 'parent' in a new Context that has the map of ignored endpoints
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithIgnoredEndpoints(parent context.Context, endpoints map[registry.EndpointNSMName]*registry.NSERegistration) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, ignoredEndpoints, endpoints)
}
// IgnoredEndpoints - Return a map of ignored endpoints or empty map.
// key == endpointname + ":" + NetworkServiceManager.Url
func IgnoredEndpoints(ctx context.Context) map[registry.EndpointNSMName]*registry.NSERegistration {
value := ctx.Value(ignoredEndpoints)
if value == nil {
return map[registry.EndpointNSMName]*registry.NSERegistration{}
}
return value.(map[registry.EndpointNSMName]*registry.NSERegistration)
}
// WithWorkspaceName -
// Wraps 'parent' in a new Context that has the workspace name;
// using Context.Value(...) and returns the result.
// Note: any previously existing value will be overwritten.
//
func WithWorkspaceName(parent context.Context, name string) context.Context {
if parent == nil {
parent = context.Background()
}
return context.WithValue(parent, workspaceName, name)
}
// WorkspaceName - Return a workspace name
func WorkspaceName(ctx context.Context) string {
value := ctx.Value(workspaceName)
if value == nil {
return ""
}
return value.(string)
}