forked from bufbuild/protocompile
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Slight improvement to walk package (bufbuild#287)
I added benchmarks, in the hopes of finding a more efficient way to traverse descriptor protos, from `walk.DescriptorProtos`. The main cost is the way the fully-qualified names are computed/allocated as it traverses the descriptor hierarchy. While I did not come up with any meaningful improvements there, I was able to improve the other walk function (`walk.Descriptors`), by making fewer interface method calls, memoizing the results of the various accessors. This improves throughput, consistently taking about 15% less time per operation.
- Loading branch information
Showing
3 changed files
with
178 additions
and
54 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,45 @@ | ||
| // Copyright 2020-2024 Buf Technologies, Inc. | ||
| // | ||
| // 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 walk | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "google.golang.org/protobuf/proto" | ||
| "google.golang.org/protobuf/reflect/protodesc" | ||
| "google.golang.org/protobuf/reflect/protoreflect" | ||
| "google.golang.org/protobuf/types/descriptorpb" | ||
| ) | ||
|
|
||
| func BenchmarkDescriptors(b *testing.B) { | ||
| file := (*descriptorpb.FileDescriptorProto)(nil).ProtoReflect().Descriptor().ParentFile() | ||
| for i := 0; i < b.N; i++ { | ||
| err := Descriptors(file, func(_ protoreflect.Descriptor) error { | ||
| return nil | ||
| }) | ||
| require.NoError(b, err) | ||
| } | ||
| } | ||
|
|
||
| func BenchmarkDescriptorProtos(b *testing.B) { | ||
| file := protodesc.ToFileDescriptorProto((*descriptorpb.FileDescriptorProto)(nil).ProtoReflect().Descriptor().ParentFile()) | ||
| for i := 0; i < b.N; i++ { | ||
| err := DescriptorProtos(file, func(_ protoreflect.FullName, _ proto.Message) error { | ||
| return nil | ||
| }) | ||
| require.NoError(b, err) | ||
| } | ||
| } |
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,78 @@ | ||
| // Copyright 2020-2024 Buf Technologies, Inc. | ||
| // | ||
| // 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 walk | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "google.golang.org/protobuf/proto" | ||
| "google.golang.org/protobuf/reflect/protodesc" | ||
| "google.golang.org/protobuf/reflect/protoreflect" | ||
| "google.golang.org/protobuf/types/descriptorpb" | ||
| ) | ||
|
|
||
| func TestDescriptorProtosEnterAndExit(t *testing.T) { | ||
| t.Parallel() | ||
| file := protodesc.ToFileDescriptorProto((*descriptorpb.FileDescriptorProto)(nil).ProtoReflect().Descriptor().ParentFile()) | ||
| nameStack := []string{file.GetPackage()} | ||
| err := DescriptorProtosEnterAndExit( | ||
| file, | ||
| func(fullName protoreflect.FullName, message proto.Message) error { | ||
| switch d := message.(type) { | ||
| case *descriptorpb.DescriptorProto: | ||
| expected := joinNames(nameStack[len(nameStack)-1], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| case *descriptorpb.FieldDescriptorProto: | ||
| expected := joinNames(nameStack[len(nameStack)-1], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| case *descriptorpb.OneofDescriptorProto: | ||
| expected := joinNames(nameStack[len(nameStack)-1], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| case *descriptorpb.EnumDescriptorProto: | ||
| expected := joinNames(nameStack[len(nameStack)-1], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| case *descriptorpb.EnumValueDescriptorProto: | ||
| // we look at the NEXT to last item on stack because enums are | ||
| // defined not in the enum but in its enclosing scope | ||
| expected := joinNames(nameStack[len(nameStack)-2], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| case *descriptorpb.ServiceDescriptorProto: | ||
| expected := joinNames(nameStack[len(nameStack)-1], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| case *descriptorpb.MethodDescriptorProto: | ||
| expected := joinNames(nameStack[len(nameStack)-1], d.GetName()) | ||
| assert.Equal(t, expected, string(fullName)) | ||
| default: | ||
| t.Fatalf("unknown descriptor type: %T", d) | ||
| } | ||
| nameStack = append(nameStack, string(fullName)) | ||
| return nil | ||
| }, | ||
| func(name protoreflect.FullName, message proto.Message) error { | ||
| nameStack = nameStack[:len(nameStack)-1] | ||
| return nil | ||
| }, | ||
| ) | ||
| require.NoError(t, err) | ||
| } | ||
|
|
||
| func joinNames(prefix, name string) string { | ||
| if len(prefix) == 0 { | ||
| return name | ||
| } | ||
| return prefix + "." + name | ||
| } |