/
ctx.go
657 lines (528 loc) · 18 KB
/
ctx.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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
// Copyright 2022 ByteDance Ltd. and/or its affiliates
// SPDX-License-Identifier: MIT
package utils
import (
"context"
"fmt"
"net/http"
"strings"
"sync"
"github.com/byted-apaas/server-common-go/constants"
exp "github.com/byted-apaas/server-common-go/exceptions"
"github.com/byted-apaas/server-common-go/structs"
)
func SetTenantToCtx(ctx context.Context, tenant *structs.Tenant) context.Context {
return context.WithValue(ctx, constants.CtxKeyTenant, tenant)
}
func GetTenantFromCtx(ctx context.Context) (*structs.Tenant, error) {
tenant := structs.Tenant{}
err := Decode(ctx.Value(constants.CtxKeyTenant), &tenant)
if err != nil {
return nil, exp.InternalError("decode tenant failed, err: %+v", err)
}
return &tenant, nil
}
func GetTenantIDFromCtx(ctx context.Context) int64 {
tenant, err := GetTenantFromCtx(ctx)
if err != nil {
return 0
}
return tenant.ID
}
func SetFaaSLaneIDCtx(ctx context.Context, laneID string) context.Context {
return context.WithValue(ctx, constants.CtxKeyLaneID, laneID)
}
func SetFaaSEnvIDCtx(ctx context.Context, envID string) context.Context {
return context.WithValue(ctx, constants.CtxKeyEnvID, envID)
}
func SetFaaSEnvTypeCtx(ctx context.Context, envType int64) context.Context {
return context.WithValue(ctx, constants.CtxKeyEnvType, envType)
}
func GetFaaSLaneIDFromCtx(ctx context.Context) string {
cast, ok := ctx.Value(constants.CtxKeyLaneID).(string)
if ok {
return cast
}
return ""
}
func GetFaaSEnvIDFromCtx(ctx context.Context) string {
cast, ok := ctx.Value(constants.CtxKeyEnvID).(string)
if ok {
return cast
}
return ""
}
// GetEnvTypeFromCtx
func GetFaaSEnvTypeFromCtx(ctx context.Context) int64 {
cast, ok := ctx.Value(constants.CtxKeyEnvType).(int64)
if ok {
return cast
}
return int64(0)
}
func SetAppInfoToCtx(ctx context.Context, appInfo *structs.AppInfo) context.Context {
return context.WithValue(ctx, constants.CtxKeyApp, appInfo)
}
func GetAppInfoFromCtx(ctx context.Context) (*structs.AppInfo, error) {
appInfo := structs.AppInfo{}
err := Decode(ctx.Value(constants.CtxKeyApp), &appInfo)
if err != nil {
return nil, exp.InternalError("Decode appInfo failed, err: %+v", err)
}
return &appInfo, nil
}
func SetEventInfoToCtx(ctx context.Context, appInfo *structs.EventInfo) context.Context {
return context.WithValue(ctx, constants.CtxKeyEvent, appInfo)
}
func GetEventInfoFromCtx(ctx context.Context) (*structs.EventInfo, error) {
eventInfo := structs.EventInfo{}
err := Decode(ctx.Value(constants.CtxKeyEvent), &eventInfo)
if err != nil {
return nil, exp.InternalError("Decode eventInfo failed, err: %+v", err)
}
return &eventInfo, nil
}
func GetNamespaceFromCtx(ctx context.Context) string {
tenant, err := GetTenantFromCtx(ctx)
if err != nil {
return ""
}
return tenant.Namespace
}
func SetUserIDToCtx(ctx context.Context, userID int64) context.Context {
return context.WithValue(ctx, constants.CtxKeyUser, userID)
}
func GetUserIDFromCtx(ctx context.Context) int64 {
cast, ok := ctx.Value(constants.CtxKeyUser).(int64)
if !ok {
return -1
}
return cast
}
func SetTTEnvToCtx(ctx context.Context, ttEnv string) context.Context {
return context.WithValue(ctx, constants.CtxKeyTTEnv, ttEnv)
}
func GetTTEnvFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyTTEnv).(string)
return cast
}
func SetKEnvToCtx(ctx context.Context, kEnv string) context.Context {
return context.WithValue(ctx, constants.CtxKeyKEnv, kEnv)
}
func SetLogIDToCtx(ctx context.Context, logID string) context.Context {
return context.WithValue(ctx, constants.CtxKeyLogID, logID)
}
func GetLogIDFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyLogID).(string)
return cast
}
func SetSourceTypeToCtx(ctx context.Context, sourceType int) context.Context {
return context.WithValue(ctx, constants.CtxKeySourceType, sourceType)
}
func GetSourceTypeFromCtx(ctx context.Context) int {
cast, _ := ctx.Value(constants.CtxKeySourceType).(int)
return cast
}
func SetTriggerTypeToCtx(ctx context.Context, triggerType string) context.Context {
return context.WithValue(ctx, constants.CtxKeyTriggerType, triggerType)
}
func GetTriggerTypeFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyTriggerType).(string)
return cast
}
func SetDebugTypeToCtx(ctx context.Context, debugType int) context.Context {
return context.WithValue(ctx, constants.CtxKeyDebugType, debugType)
}
func GetDebugTypeFromCtx(ctx context.Context) int {
cast, _ := ctx.Value(constants.CtxKeyDebugType).(int)
return cast
}
func SetFuncAPINameToCtx(ctx context.Context, funcAPIName string) context.Context {
return context.WithValue(ctx, constants.CtxKeyFunctionAPIName, funcAPIName)
}
func GetFuncAPINameFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyFunctionAPIName).(string)
return cast
}
func SetFunctionNameToCtx(ctx context.Context, functionName string) context.Context {
return context.WithValue(ctx, constants.CtxKeyFunctionName, functionName)
}
func GetFunctionNameFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyFunctionName).(string)
return cast
}
func SetTriggerTaskIDToCtx(ctx context.Context, taskID int64) context.Context {
return context.WithValue(ctx, constants.CtxKeyTriggerTaskID, taskID)
}
func GetTriggerTaskIDFromCtx(ctx context.Context) int64 {
cast, _ := ctx.Value(constants.CtxKeyTriggerTaskID).(int64)
return cast
}
func SetDistributedMaskToCtx(ctx context.Context, mask string) context.Context {
return context.WithValue(ctx, constants.CtxKeyDistributedMask, mask)
}
func GetDistributedMaskFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyDistributedMask).(string)
return cast
}
func SetLoopMaskToCtx(ctx context.Context, mask []string) context.Context {
return context.WithValue(ctx, constants.CtxKeyLoopMask, mask)
}
func GetLoopMaskFromCtx(ctx context.Context) []string {
cast, _ := ctx.Value(constants.CtxKeyLoopMask).([]string)
return cast
}
func SetApiTimeoutToCtx(ctx context.Context, timeout map[string]int64) context.Context {
return context.WithValue(ctx, constants.CtxKeyAPITimeoutMap, timeout)
}
func GetApiTimeoutFromCtx(ctx context.Context) map[string]int64 {
cast, _ := ctx.Value(constants.CtxKeyAPITimeoutMap).(map[string]int64)
return cast
}
func SetInnerAPIPSMToCtx(ctx context.Context, psm string) context.Context {
return context.WithValue(ctx, constants.CtxKeyInnerAPIPSM, psm)
}
func GetInnerAPIPSMFromCtx(ctx context.Context) string {
if ctx == nil {
return ""
}
domain, _ := ctx.Value(constants.CtxKeyInnerAPIPSM).(string)
return domain
}
func SetEnvBoeToCtx(ctx context.Context, boe string) context.Context {
return context.WithValue(ctx, constants.CtxKeyEnvBoe, boe)
}
func GetEnvBoeFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyEnvBoe).(string)
return cast
}
func SetApiTimeoutMethodToCtx(ctx context.Context, method string) context.Context {
return context.WithValue(ctx, constants.CtxKeyAPITimeoutMethod, method)
}
func SetUserContext(ctx context.Context, userCtx structs.UserContext) context.Context {
return context.WithValue(ctx, constants.CtxUserContext, userCtx)
}
func GetUserContext(ctx context.Context) (res structs.UserContext) {
if ctx == nil {
return
}
userCtx := structs.UserContext{}
err := Decode(ctx.Value(constants.CtxUserContext), &userCtx)
if err != nil {
fmt.Printf("Decode userCtx failed, err: %+v", err)
}
return userCtx
}
func SetUserContextMap(ctx context.Context, userCtxMap map[string]interface{}) context.Context {
return context.WithValue(ctx, constants.CtxUserContextMap, userCtxMap)
}
func GetUserContextMap(ctx context.Context) (res map[string]interface{}) {
defer func() {
if res == nil {
res = make(map[string]interface{})
}
}()
if ctx == nil {
return
}
res, _ = ctx.Value(constants.CtxUserContextMap).(map[string]interface{})
return res
}
func SetAPaaSLaneToCtx(ctx context.Context, lane string) context.Context {
return context.WithValue(ctx, constants.CtxKeyAPaaSLane, lane)
}
func GetAPaaSLaneFromCtx(ctx context.Context) string {
cast, _ := ctx.Value(constants.CtxKeyAPaaSLane).(string)
return cast
}
func SetAPaaSPersistFaaSMapToCtx(ctx context.Context, aPaaSPersistFaaSMap map[string]string) context.Context {
return context.WithValue(ctx, constants.PersistFaaSKeySummarized, aPaaSPersistFaaSMap)
}
var aPaaSPersistMutex sync.Mutex
func GetAPaaSPersistFaaSMapFromCtx(ctx context.Context) (copyRes map[string]string) {
copyRes = map[string]string{}
if ctx == nil {
return
}
aPaaSPersistMutex.Lock()
defer aPaaSPersistMutex.Unlock()
res, _ := ctx.Value(constants.PersistFaaSKeySummarized).(map[string]string)
// copy 是为了避免出现 map 并发读写的问题
for k, v := range res {
copyRes[k] = v
}
return
}
func WithAPaaSPersistFaaSValue(ctx context.Context, key, value string) context.Context {
m := GetAPaaSPersistFaaSMapFromCtx(ctx)
aPaaSPersistMutex.Lock()
defer aPaaSPersistMutex.Unlock()
key = strings.TrimPrefix(key, constants.APAAS_PERSIST_FAAS_PREFIX)
m[constants.APAAS_PERSIST_FAAS_PREFIX+key] = value
return SetAPaaSPersistFaaSMapToCtx(ctx, m)
}
func GetAPaaSPersistFaaSValueFromCtx(ctx context.Context, key string) string {
m := GetAPaaSPersistFaaSMapFromCtx(ctx)
if value, ok := m[key]; ok {
return value
}
return ""
}
func GetAPaaSPersistFaaSMapStr(ctx context.Context) string {
m := GetAPaaSPersistFaaSMapFromCtx(ctx)
res, _ := json.Marshal(m)
return string(res)
}
func SetAPaaSPersistHeader(ctx context.Context, header http.Header) {
if ctx == nil {
return
}
if persistHeader, ok := ctx.Value(constants.PersistAPaaSKeySummarized).(map[string]string); ok {
for key, value := range persistHeader {
header.Add(key, value)
}
}
}
func SetUserAndAuthTypeToCtx(ctx context.Context, authType *string) context.Context {
return SetUserAndMixAuthTypeToCtx(ctx, authType, false)
}
// SetUserAndMixAuthTypeToCtx 设置鉴权方式
// - 接口级配置优先级高于函数级
// - 函数级配置
// - oql 接口使用 system 和 mix_user_system
// - 除 oql 之外的接口使用 system 和 user
func SetUserAndMixAuthTypeToCtx(ctx context.Context, authType *string, isMix bool) context.Context {
if authType == nil || *authType == "" {
authType = GetGlobalAuthType()
}
userID := GetUserIDFromCtx(ctx)
ctx = context.WithValue(ctx, constants.HttpHeaderKeyUser, fmt.Sprintf("%d", userID))
if authType != nil {
if userID == -1 || *authType == constants.AuthTypeSystem {
ctx = context.WithValue(ctx, constants.AuthTypeKey, constants.AuthTypeSystem)
} else if *authType == constants.AuthTypeUser {
if isMix {
ctx = context.WithValue(ctx, constants.AuthTypeKey, constants.AuthTypeMixUserSystem)
} else {
ctx = context.WithValue(ctx, constants.AuthTypeKey, constants.AuthTypeUser)
}
} else if *authType == constants.AuthTypeMixUserSystem {
ctx = context.WithValue(ctx, constants.AuthTypeKey, constants.AuthTypeMixUserSystem)
}
}
return ctx
}
func SetUserAndMixAuthTypeToHeaders(ctx context.Context, headers map[string][]string, isMix bool) map[string][]string {
if headers == nil {
headers = make(map[string][]string)
}
authType, ok := ctx.Value(constants.AuthTypeKey).(string)
if !ok || authType == "" {
if v := GetGlobalAuthType(); v != nil && *v != "" {
authType = *v
}
}
userID := GetUserIDFromCtx(ctx)
headers[constants.HttpHeaderKeyUser] = []string{fmt.Sprintf("%d", userID)}
if authType != "" {
if userID == -1 || authType == constants.AuthTypeSystem {
headers[constants.HTTPHeaderKeyAuthType] = []string{constants.AuthTypeSystem}
} else if authType == constants.AuthTypeUser {
if isMix {
headers[constants.HTTPHeaderKeyAuthType] = []string{constants.AuthTypeMixUserSystem}
} else {
headers[constants.HTTPHeaderKeyAuthType] = []string{constants.AuthTypeUser}
}
} else if authType == constants.AuthTypeMixUserSystem {
headers[constants.HTTPHeaderKeyAuthType] = []string{constants.AuthTypeMixUserSystem}
}
}
return headers
}
func SetUserAndAuthTypeToHeaders(ctx context.Context, headers map[string][]string) map[string][]string {
return SetUserAndMixAuthTypeToHeaders(ctx, headers, false)
}
// SetFunctionMetaConfToCtx 提供给框架层使用
func SetFunctionMetaConfToCtx(ctx context.Context, metaConf map[string]string) context.Context {
if ctx == nil {
ctx = context.Background()
}
apiNameToMetaConf := map[string]*structs.FunctionMeta{}
for apiName, conf := range metaConf {
functionMeta := structs.FunctionMeta{}
err := json.Unmarshal([]byte(conf), &functionMeta)
if err != nil {
fmt.Printf("SetFunctionMetaConfToCtx failed, err: %+v\n", err)
return ctx
}
apiNameToMetaConf[strings.ToLower(apiName)] = &functionMeta
}
return context.WithValue(ctx, constants.CtxKeyFunctionMetaConf, apiNameToMetaConf)
}
func GetFunctionMetaConfFromCtx(ctx context.Context, apiName string) *structs.FunctionMeta {
if ctx == nil {
return nil
}
apiNameToFuncMeta := map[string]*structs.FunctionMeta{}
err := Decode(ctx.Value(constants.CtxKeyFunctionMetaConf), &apiNameToFuncMeta)
if err != nil {
fmt.Printf("Decode metaConf failed, err: %+v", err)
return nil
}
conf, _ := apiNameToFuncMeta[strings.ToLower(apiName)]
return conf
}
func GetCurFunctionMetaConfFromCtx(ctx context.Context) *structs.FunctionMeta {
if ctx == nil {
return nil
}
return GetFunctionMetaConfFromCtx(ctx, strings.ToLower(GetFuncAPINameFromCtx(ctx)))
}
// 参数对应的无权限字段
func GetParamUnauthFieldMapFromCtx(ctx context.Context) (keyToUnauthFields map[string]interface{}) {
if ctx == nil {
return nil
}
userContext := GetUserContext(ctx)
return userContext.Permission.UnauthFields
}
func GetParamUnauthFieldByKey(ctx context.Context, key string) (unauthFields interface{}) {
return GetParamUnauthFieldMapFromCtx(ctx)[key]
}
func GetParamUnauthFieldRecordByKey(ctx context.Context, key string) (unauthFields []string) {
return ParseStrList(GetParamUnauthFieldMapFromCtx(ctx)[key])
}
func GetParamUnauthFieldRecordListByKey(ctx context.Context, key string) (unauthFieldsList [][]string) {
return ParseStrsList(GetParamUnauthFieldMapFromCtx(ctx)[key])
}
// RecordUnauthField 记录对应的无权限字段
type RecordUnauthField = map[string]map[int64][]string
func SetRecordUnauthField(ctx context.Context, unauthFieldMap RecordUnauthField) context.Context {
return context.WithValue(ctx, constants.CtxKeyUnauthFieldMap, unauthFieldMap)
}
func GetRecordUnauthField(ctx context.Context) (objToRecordIDToUnauthFields RecordUnauthField) {
if ctx == nil {
return nil
}
unauthField := RecordUnauthField{}
err := Decode(ctx.Value(constants.CtxKeyUnauthFieldMap), &unauthField)
if err != nil {
fmt.Printf("Decode unauthField failed, err: %+v", err)
return unauthField
}
return unauthField
}
func GetRecordUnauthFieldByObject(ctx context.Context, objectAPIName string) (recordIDToUnauthFields map[int64][]string) {
if ctx == nil {
return nil
}
// 加锁,避免并发读写问题
unauthFieldMapMutex.Lock()
defer unauthFieldMapMutex.Unlock()
recordIDToUnauthFields, _ = GetRecordUnauthField(ctx)[objectAPIName]
if recordIDToUnauthFields == nil {
return nil
}
// 深 copy 避免后续 map 的并发读写问题
result := map[int64][]string{}
for recordID, unauthFields := range recordIDToUnauthFields {
result[recordID] = append([]string{}, unauthFields...)
}
return result
}
func GetRecordUnauthFieldByObjectAndRecordID(ctx context.Context, objectAPIName string, recordID int64) (unauthFields []string) {
if ctx == nil {
return nil
}
unauthFields, _ = GetRecordUnauthFieldByObject(ctx, objectAPIName)[recordID]
return unauthFields
}
var unauthFieldMapMutex sync.Mutex
func WriteUnauthFieldMapWithLock(ctx context.Context, objectAPIName string, recordID int64, unauthFields []string) {
unauthFieldMapMutex.Lock()
defer unauthFieldMapMutex.Unlock()
unauthFieldMap := GetRecordUnauthField(ctx)
if unauthFieldMap == nil {
return
}
if v, ok := unauthFieldMap[objectAPIName]; !ok || v == nil {
unauthFieldMap[objectAPIName] = map[int64][]string{}
}
unauthFieldMap[objectAPIName][recordID] = unauthFields
}
func GetSDKConf(ctx context.Context) *structs.SDKConf {
if ctx == nil {
return nil
}
sdkConfStr, ok := ctx.Value(constants.CtxKeySDKConf).(string)
if !ok || sdkConfStr == "" {
return nil
}
sdkConf := structs.SDKConf{}
err := JsonUnmarshalBytes([]byte(sdkConfStr), &sdkConf)
if err != nil {
return nil
}
return &sdkConf
}
func GetSDKTransientConf(ctx context.Context) *structs.SDKTransientConf {
sdkConf := GetSDKConf(ctx)
if sdkConf == nil {
return nil
}
return sdkConf.TransientConf
}
func GetMeshDestReqTimeout(ctx context.Context) int64 {
conf := GetSDKTransientConf(ctx)
if conf != nil && conf.MeshDestReqTimeout > 0 {
return conf.MeshDestReqTimeout
}
return constants.DefaultMeshDestReqTimeout
}
func IsCloseMesh(ctx context.Context) bool {
transientConf := GetSDKTransientConf(ctx)
if transientConf == nil {
return false
}
return transientConf.IsCloseMesh
}
func GetTraceHeader(ctx context.Context) map[string]string {
traceHeader := map[string]string{}
if ctx == nil {
return traceHeader
}
if traceParent, ok := ctx.Value("traceparent").(string); ok && traceParent != "" {
traceHeader["traceparent"] = traceParent
}
if traceState, ok := ctx.Value("tracestate").(string); ok && traceState != "" {
traceHeader["tracestate"] = traceState
}
return traceHeader
}
type RuntimeType string
const (
RuntimeTypeRuntime RuntimeType = "0" // 运行态
RuntimeTypeCloudDebug RuntimeType = "1" // 云端调试
RuntimeTypeLocalDebug RuntimeType = "2" // 本地调试
)
func SetRuntimeType(ctx context.Context, runtimeType string) context.Context {
if ctx == nil {
ctx = context.Background()
}
return context.WithValue(ctx, constants.CtxKeyRuntimeType, runtimeType)
}
func GetRuntimeType(ctx context.Context) RuntimeType {
if ctx == nil {
ctx = context.Background()
}
if runtimeType, ok := ctx.Value(constants.CtxKeyRuntimeType).(string); ok {
return RuntimeType(runtimeType)
}
return RuntimeTypeRuntime
}
func IsRuntime(ctx context.Context) bool {
if ctx == nil {
ctx = context.Background()
}
return GetRuntimeType(ctx) == RuntimeTypeRuntime
}