-
Notifications
You must be signed in to change notification settings - Fork 874
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Check SDK versions via version check call (#2365)
- Loading branch information
Showing
7 changed files
with
225 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2022 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package interceptor | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync" | ||
|
|
||
| "go.temporal.io/server/common/headers" | ||
| "go.temporal.io/version/check" | ||
| "google.golang.org/grpc" | ||
| ) | ||
|
|
||
| type sdkNameVersion struct { | ||
| name string | ||
| version string | ||
| } | ||
|
|
||
| type SDKVersionInterceptor struct { | ||
| sdkInfoSet map[sdkNameVersion]struct{} | ||
| lock sync.RWMutex | ||
| maxSetSize int | ||
| } | ||
|
|
||
| const defaultMaxSetSize = 100 | ||
|
|
||
| // NewSDKVersionInterceptor creates a new SDKVersionInterceptor with default max set size | ||
| func NewSDKVersionInterceptor() *SDKVersionInterceptor { | ||
| return &SDKVersionInterceptor{ | ||
| sdkInfoSet: make(map[sdkNameVersion]struct{}), | ||
| maxSetSize: defaultMaxSetSize, | ||
| } | ||
| } | ||
|
|
||
| // Intercept a grpc request | ||
| func (vi *SDKVersionInterceptor) Intercept( | ||
| ctx context.Context, | ||
| req interface{}, | ||
| info *grpc.UnaryServerInfo, | ||
| handler grpc.UnaryHandler, | ||
| ) (interface{}, error) { | ||
| sdkName, sdkVersion := headers.GetClientNameAndVersion(ctx) | ||
| if sdkName != "" && sdkVersion != "" { | ||
| vi.RecordSDKInfo(sdkName, sdkVersion) | ||
| } | ||
| return handler(ctx, req) | ||
| } | ||
|
|
||
| // RecordSDKInfo records name and version tuple in memory | ||
| func (vi *SDKVersionInterceptor) RecordSDKInfo(name, version string) { | ||
| info := sdkNameVersion{name, version} | ||
|
|
||
| vi.lock.RLock() | ||
| overCap := len(vi.sdkInfoSet) >= vi.maxSetSize | ||
| _, found := vi.sdkInfoSet[info] | ||
| vi.lock.RUnlock() | ||
|
|
||
| if !overCap && !found { | ||
| vi.lock.Lock() | ||
| vi.sdkInfoSet[info] = struct{}{} | ||
| vi.lock.Unlock() | ||
| } | ||
| } | ||
|
|
||
| // GetAndResetSDKInfo gets all recorded name, version tuples and resets internal records | ||
| func (vi *SDKVersionInterceptor) GetAndResetSDKInfo() []check.SDKInfo { | ||
| vi.lock.Lock() | ||
| currSet := vi.sdkInfoSet | ||
| vi.sdkInfoSet = make(map[sdkNameVersion]struct{}) | ||
| vi.lock.Unlock() | ||
|
|
||
| sdkInfo := make([]check.SDKInfo, 0, len(currSet)) | ||
| for k := range currSet { | ||
| sdkInfo = append(sdkInfo, check.SDKInfo{Name: k.name, Version: k.version}) | ||
| } | ||
| return sdkInfo | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2022 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Copyright (c) 2020 Uber Technologies, Inc. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package interceptor | ||
|
|
||
| import ( | ||
| "context" | ||
| "sort" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "go.temporal.io/server/common/headers" | ||
| ) | ||
|
|
||
| func TestSDKVersionRecorder(t *testing.T) { | ||
| interceptor := &SDKVersionInterceptor{ | ||
| sdkInfoSet: make(map[sdkNameVersion]struct{}), | ||
| maxSetSize: 2, | ||
| } | ||
|
|
||
| sdkVersion := "1.10.1" | ||
|
|
||
| // Record first tuple | ||
| ctx := headers.SetVersionsForTests(context.Background(), sdkVersion, headers.ClientNameGoSDK, headers.SupportedServerVersions, headers.AllFeatures) | ||
| interceptor.Intercept(ctx, nil, nil, func(ctx context.Context, req interface{}) (interface{}, error) { | ||
| return nil, nil | ||
| }) | ||
|
|
||
| // Record second tuple | ||
| ctx = headers.SetVersionsForTests(context.Background(), sdkVersion, headers.ClientNameTypeScriptSDK, headers.SupportedServerVersions, headers.AllFeatures) | ||
| interceptor.Intercept(ctx, nil, nil, func(ctx context.Context, req interface{}) (interface{}, error) { | ||
| return nil, nil | ||
| }) | ||
|
|
||
| // Do not record when over capacity | ||
| ctx = headers.SetVersionsForTests(context.Background(), sdkVersion, headers.ClientNameJavaSDK, headers.SupportedServerVersions, headers.AllFeatures) | ||
| interceptor.Intercept(ctx, nil, nil, func(ctx context.Context, req interface{}) (interface{}, error) { | ||
| return nil, nil | ||
| }) | ||
|
|
||
| // Empty SDK version should not be recorded | ||
| ctx = headers.SetVersionsForTests(context.Background(), "", headers.ClientNameGoSDK, headers.SupportedServerVersions, headers.AllFeatures) | ||
| interceptor.Intercept(ctx, nil, nil, func(ctx context.Context, req interface{}) (interface{}, error) { | ||
| return nil, nil | ||
| }) | ||
|
|
||
| // Empty SDK name should not be recorded | ||
| ctx = headers.SetVersionsForTests(context.Background(), sdkVersion, "", headers.SupportedServerVersions, headers.AllFeatures) | ||
| interceptor.Intercept(ctx, nil, nil, func(ctx context.Context, req interface{}) (interface{}, error) { | ||
| return nil, nil | ||
| }) | ||
|
|
||
| info := interceptor.GetAndResetSDKInfo() | ||
| sort.SliceStable(info, func(i, j int) bool { | ||
| return info[i].Name < info[j].Name | ||
| }) | ||
| assert.Equal(t, 2, len(info)) | ||
| assert.Equal(t, headers.ClientNameGoSDK, info[0].Name) | ||
| assert.Equal(t, sdkVersion, info[0].Version) | ||
| assert.Equal(t, headers.ClientNameTypeScriptSDK, info[1].Name) | ||
| assert.Equal(t, sdkVersion, info[1].Version) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters