Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(pubsublite): add client library metadata to headers (#3458)
Adds client library version and other properties to gRPC stream metadata for debugging purposes
- Loading branch information
Showing
9 changed files
with
356 additions
and
17 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // Copyright 2020 Google LLC | ||
| // | ||
| // 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 | ||
| // | ||
| // https://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 | ||
|
|
||
| package wire | ||
|
|
||
| import ( | ||
| "encoding/base64" | ||
| "testing" | ||
|
|
||
| "cloud.google.com/go/internal/testutil" | ||
| "github.com/golang/protobuf/proto" | ||
| "google.golang.org/protobuf/types/known/structpb" | ||
| ) | ||
|
|
||
| func TestPubsubMetadataAddClientInfo(t *testing.T) { | ||
| for _, tc := range []struct { | ||
| desc string | ||
| framework FrameworkType | ||
| libraryVersion func() (version, bool) | ||
| wantClientInfo *structpb.Struct | ||
| }{ | ||
| { | ||
| desc: "minimal", | ||
| libraryVersion: func() (version, bool) { | ||
| return version{}, false | ||
| }, | ||
| wantClientInfo: &structpb.Struct{ | ||
| Fields: map[string]*structpb.Value{ | ||
| "language": stringValue("GOLANG"), | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| desc: "cps shim", | ||
| framework: FrameworkCloudPubSubShim, | ||
| libraryVersion: func() (version, bool) { | ||
| return version{}, false | ||
| }, | ||
| wantClientInfo: &structpb.Struct{ | ||
| Fields: map[string]*structpb.Value{ | ||
| "language": stringValue("GOLANG"), | ||
| "framework": stringValue("CLOUD_PUBSUB_SHIM"), | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| desc: "version valid", | ||
| framework: FrameworkCloudPubSubShim, | ||
| libraryVersion: func() (version, bool) { | ||
| return version{Major: "1", Minor: "2"}, true | ||
| }, | ||
| wantClientInfo: &structpb.Struct{ | ||
| Fields: map[string]*structpb.Value{ | ||
| "language": stringValue("GOLANG"), | ||
| "framework": stringValue("CLOUD_PUBSUB_SHIM"), | ||
| "major_version": stringValue("1"), | ||
| "minor_version": stringValue("2"), | ||
| }, | ||
| }, | ||
| }, | ||
| } { | ||
| t.Run(tc.desc, func(t *testing.T) { | ||
| metadata := newPubsubMetadata() | ||
| metadata.doAddClientInfo(tc.framework, tc.libraryVersion) | ||
|
|
||
| b, err := base64.StdEncoding.DecodeString(metadata["x-goog-pubsub-context"]) | ||
| if err != nil { | ||
| t.Errorf("Failed to decode base64 pubsub context header: %v", err) | ||
| return | ||
| } | ||
| gotClientInfo := new(structpb.Struct) | ||
| if err := proto.Unmarshal(b, gotClientInfo); err != nil { | ||
| t.Errorf("Failed to unmarshal pubsub context structpb: %v", err) | ||
| return | ||
| } | ||
| if diff := testutil.Diff(gotClientInfo, tc.wantClientInfo); diff != "" { | ||
| t.Errorf("Pubsub context structpb: got: -, want: +\n%s", diff) | ||
| } | ||
| }) | ||
| } | ||
| } |
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,66 @@ | ||
| // Copyright 2020 Google LLC | ||
| // | ||
| // 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 | ||
| // | ||
| // https://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 | ||
|
|
||
| // +build go1.12 | ||
|
|
||
| package wire | ||
|
|
||
| import ( | ||
| "runtime/debug" | ||
| "strconv" | ||
| "strings" | ||
| ) | ||
|
|
||
| const pubsubLiteModulePath = "cloud.google.com/go/pubsublite" | ||
|
|
||
| type version struct { | ||
| Major string | ||
| Minor string | ||
| } | ||
|
|
||
| // libraryVersion attempts to determine the pubsublite module version. | ||
| func libraryVersion() (version, bool) { | ||
| if buildInfo, ok := debug.ReadBuildInfo(); ok { | ||
| return pubsubliteModuleVersion(buildInfo) | ||
| } | ||
| return version{}, false | ||
| } | ||
|
|
||
| // pubsubliteModuleVersion extracts the module version from BuildInfo embedded | ||
| // in the binary. Only applies to binaries built with module support. | ||
| func pubsubliteModuleVersion(buildInfo *debug.BuildInfo) (version, bool) { | ||
| for _, dep := range buildInfo.Deps { | ||
| if dep.Path == pubsubLiteModulePath { | ||
| return parseModuleVersion(dep.Version) | ||
| } | ||
| } | ||
| return version{}, false | ||
| } | ||
|
|
||
| func parseModuleVersion(value string) (v version, ok bool) { | ||
| if strings.HasPrefix(value, "v") { | ||
| value = value[1:] | ||
| } | ||
| components := strings.Split(value, ".") | ||
| if len(components) >= 2 { | ||
| if _, err := strconv.ParseInt(components[0], 10, 32); err != nil { | ||
| return | ||
| } | ||
| if _, err := strconv.ParseInt(components[1], 10, 32); err != nil { | ||
| return | ||
| } | ||
| v = version{Major: components[0], Minor: components[1]} | ||
| ok = true | ||
| } | ||
| return | ||
| } |
Oops, something went wrong.