-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add features files to the set of standard imports (#295)
The "standard imports" (made available to compile operations using `protocompile.WithStandardImports`) are files that would be included with `protoc`, if a user were instead compiling with `protoc`. As of v26.1, `protoc` now includes two new files: "goole/protobuf/cpp_features.proto" and "google/protobuf/java_features.proto". But these are _not_ generated to Go code into packages in the Protobuf runtime, unlike all of the other well-known imports. So, for these, we embed binary-encoded file descriptors. Notably `protoc` does **not** include "google/protobuf/go_features.proto". However, that file _is_ part of the Go Protobuf runtime, with its generated code being available via the `google.golang.org/protobuf/types/gofeaturespb` package. So we also make that file available via `protocompile.WithStandardImports` (even though `protoc` doesn't include it).
- Loading branch information
Showing
9 changed files
with
176 additions
and
3 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
|
|
||
| � | ||
| "google/protobuf/cpp_features.protopb google/protobuf/descriptor.proto"_ | ||
| CppFeaturesP | ||
| legacy_closed_enum (B"���� true�� | ||
| false�RlegacyClosedEnum:? | ||
| cpp.google.protobuf.FeatureSet� ( 2.pb.CppFeaturesRcpp |
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 @@ | ||
| // 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 featuresext provides file descriptors for the | ||
| // "google/protobuf/cpp_features.proto" and "google/protobuf/java_features.proto" | ||
| // standard import files. Unlike the other standard/well-known | ||
| // imports, these files have no standard Go package in their | ||
| // runtime with generated code. So in order to make them available | ||
| // as "standard imports" to compiler users, we must embed these | ||
| // descriptors into a Go package. | ||
| package featuresext | ||
|
|
||
| import ( | ||
| _ "embed" | ||
| "fmt" | ||
| "sync" | ||
|
|
||
| "google.golang.org/protobuf/proto" | ||
| "google.golang.org/protobuf/reflect/protodesc" | ||
| "google.golang.org/protobuf/reflect/protoreflect" | ||
| "google.golang.org/protobuf/reflect/protoregistry" | ||
| "google.golang.org/protobuf/types/descriptorpb" | ||
| ) | ||
|
|
||
| var ( | ||
| //go:embed cpp_features.protoset | ||
| cppFeatures []byte | ||
|
|
||
| //go:embed java_features.protoset | ||
| javaFeatures []byte | ||
|
|
||
| initOnce sync.Once | ||
| initCppFeatures protoreflect.FileDescriptor | ||
| initCppErr error | ||
| initJavaFeatures protoreflect.FileDescriptor | ||
| initJavaErr error | ||
| ) | ||
|
|
||
| func initDescriptors() { | ||
| initOnce.Do(func() { | ||
| initCppFeatures, initCppErr = buildDescriptor("google/protobuf/cpp_features.proto", cppFeatures) | ||
| initJavaFeatures, initJavaErr = buildDescriptor("google/protobuf/java_features.proto", javaFeatures) | ||
| }) | ||
| } | ||
|
|
||
| func CppFeaturesDescriptor() (protoreflect.FileDescriptor, error) { | ||
| initDescriptors() | ||
| return initCppFeatures, initCppErr | ||
| } | ||
|
|
||
| func JavaFeaturesDescriptor() (protoreflect.FileDescriptor, error) { | ||
| initDescriptors() | ||
| return initJavaFeatures, initJavaErr | ||
| } | ||
|
|
||
| func buildDescriptor(name string, data []byte) (protoreflect.FileDescriptor, error) { | ||
| var files descriptorpb.FileDescriptorSet | ||
| err := proto.Unmarshal(data, &files) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to load descriptor for %q: %w", name, err) | ||
| } | ||
| if len(files.File) != 1 { | ||
| return nil, fmt.Errorf("failed to load descriptor for %q: expected embedded descriptor set to contain exactly one file but it instead has %d", name, len(files.File)) | ||
| } | ||
| if files.File[0].GetName() != name { | ||
| return nil, fmt.Errorf("failed to load descriptor for %q: embedded descriptor contains wrong file %q", name, files.File[0].GetName()) | ||
| } | ||
| descriptor, err := protodesc.NewFile(files.File[0], protoregistry.GlobalFiles) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to load descriptor for %q: %w", name, err) | ||
| } | ||
| return descriptor, nil | ||
| } |
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,37 @@ | ||
| // 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 featuresext | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "google.golang.org/protobuf/reflect/protoreflect" | ||
| ) | ||
|
|
||
| func TestFeaturesExt(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| file, err := CppFeaturesDescriptor() | ||
| require.NoError(t, err) | ||
| assert.Equal(t, protoreflect.FullName("pb"), file.Package()) | ||
| assert.NotNil(t, file.Extensions().ByName("cpp")) | ||
|
|
||
| file, err = JavaFeaturesDescriptor() | ||
| require.NoError(t, err) | ||
| assert.Equal(t, protoreflect.FullName("pb"), file.Package()) | ||
| assert.NotNil(t, file.Extensions().ByName("java")) | ||
| } |
Binary file not shown.
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