feat: Add functionality to export proto files #475
+109
−13
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,11 +6,13 @@ import ( | |
| "fmt" | ||
| "io" | ||
| "os" | ||
| "path/filepath" | ||
| "sync" | ||
|
|
||
| "github.com/golang/protobuf/proto" //lint:ignore SA1019 we have to import this because it appears in exported API | ||
| "github.com/jhump/protoreflect/desc" | ||
| "github.com/jhump/protoreflect/desc/protoparse" | ||
| "github.com/jhump/protoreflect/desc/protoprint" | ||
| "github.com/jhump/protoreflect/dynamic" | ||
| "github.com/jhump/protoreflect/grpcreflect" | ||
| "google.golang.org/grpc/codes" | ||
|
|
@@ -258,19 +260,9 @@ func reflectionSupport(err error) error { | |
| // given output. The output will include descriptors for all files in which the | ||
| // symbols are defined as well as their transitive dependencies. | ||
| func WriteProtoset(out io.Writer, descSource DescriptorSource, symbols ...string) error { | ||
| filenames, fds, err := getFileDescriptors(symbols, descSource) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // now expand that to include transitive dependencies in topologically sorted | ||
| // order (such that file always appears after its dependencies) | ||
|
|
@@ -302,3 +294,75 @@ func addFilesToSet(allFiles []*descriptorpb.FileDescriptorProto, expanded map[st | |
| } | ||
| return append(allFiles, fd.AsFileDescriptorProto()) | ||
| } | ||
|
|
||
| // WriteProtoFiles will use the given descriptor source to resolve all the given | ||
| // symbols and write proto files with their definitions to the given output directory. | ||
| func WriteProtoFiles(outProtoDirPath string, descSource DescriptorSource, symbols ...string) error { | ||
| filenames, fds, err := getFileDescriptors(symbols, descSource) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // now expand that to include transitive dependencies in topologically sorted | ||
| // order (such that file always appears after its dependencies) | ||
| expandedFiles := make(map[string]struct{}, len(fds)) | ||
| allFilesSlice := make([]*desc.FileDescriptor, 0, len(fds)) | ||
| for _, filename := range filenames { | ||
| allFilesSlice = addFilesToFileDescriptorList(allFilesSlice, expandedFiles, fds[filename]) | ||
| } | ||
| pr := protoprint.Printer{} | ||
| // now we can serialize to files | ||
| for _, fd := range allFilesSlice { | ||
| fdFQName := fd.GetFullyQualifiedName() | ||
| dirPath := filepath.Dir(fdFQName) | ||
| outFilepath := filepath.Join(outProtoDirPath, dirPath) | ||
| if err := os.MkdirAll(outFilepath, 0755); err != nil { | ||
| return fmt.Errorf("failed to create directory %q: %v", outFilepath, err) | ||
| } | ||
| fileName := filepath.Base(fdFQName) | ||
| filePath := filepath.Join(outFilepath, fileName) | ||
| f, err := os.Create(filePath) | ||
| if err != nil { | ||
| if f != nil { | ||
| _ = f.Close() | ||
| } | ||
| return fmt.Errorf("failed to create file %q: %v", filePath, err) | ||
| } | ||
|
There was a problem hiding this comment. immediately after this block, you should probably There was a problem hiding this comment. you can't defer in a for loop. See number 2: https://blog.learngoprogramming.com/gotchas-of-defer-in-go-1-8d070894cb01 There was a problem hiding this comment. You have to scope it sometimes: for _, fd := range allFilesSlice {
fdFQName := fd.GetFullyQualifiedName()
dirPath := filepath.Dir(fdFQName)
outFilepath := filepath.Join(outProtoDirPath, dirPath)
if err := os.MkdirAll(outFilepath, 0755); err != nil {
return fmt.Errorf("failed to create directory %q: %v", outFilepath, err)
}
fileName := filepath.Base(fdFQName)
filePath := filepath.Join(outFilepath, fileName)
err := func() error {
f, err := os.Create(filePath)
if err != nil {
return fmt.Errorf("failed to create")
}
defer f.Close()
if err := pr.PrintProtoFile(fd, f); err != nil {
return fmt.Errorf("failed to write")
}
if err := f.Close(); err != nil {
return fmt.Errorf("failed to close")
}
return nil
}()
if err != nil {
return fmt.Errorf("file %q: %w", filePath, err)
}
}
return nil |
||
| if err := pr.PrintProtoFile(fd, f); err != nil { | ||
| _ = f.Close() | ||
| return fmt.Errorf("failed to write file %q: %v", filePath, err) | ||
| } | ||
| _ = f.Close() | ||
|
There was a problem hiding this comment. You actually want to error check the close as well. Something like: err = pr.PrintProtoFile(fd, f)
if err == nil {
err = f.Close()
}
// do the error check nowyou also don't need the final close if you deferred close earlier |
||
| } | ||
| return nil | ||
| } | ||
|
There was a problem hiding this comment. Let's do one more pass on this, I have a few changes:
func writeProtoFile(outProtoDirPath string, fd *desc.FileDescriptor, pr *protoprint.Printer) error {
outFile := filepath.Join(outProtoDirPath, fd.GetFullyQualifiedName())
outDir := filepath.Dir(outFile)
if err := os.MkdirAll(outDir, 0777); err != nil {
return fmt.Errorf("failed to create directory %q: %w", outDir, err)
}
f, err := os.Create(outFile)
if err != nil {
return fmt.Errorf("failed to create proto file %q: %w", outFile, err)
}
defer f.Close()
if err := pr.PrintProtoFile(fd, f); err != nil {
return fmt.Errorf("failed to write proto file %q: %w", outFile, err)
}
return nil
} |
||
|
|
||
| func getFileDescriptors(symbols []string, descSource DescriptorSource) ([]string, map[string]*desc.FileDescriptor, error) { | ||
| // compute set of file descriptors | ||
| filenames := make([]string, 0, len(symbols)) | ||
| fds := make(map[string]*desc.FileDescriptor, len(symbols)) | ||
| for _, sym := range symbols { | ||
| d, err := descSource.FindSymbol(sym) | ||
| if err != nil { | ||
| return nil, nil, fmt.Errorf("failed to find descriptor for %q: %v", sym, err) | ||
| } | ||
| fd := d.GetFile() | ||
| if _, ok := fds[fd.GetName()]; !ok { | ||
| fds[fd.GetName()] = fd | ||
| filenames = append(filenames, fd.GetName()) | ||
| } | ||
| } | ||
| return filenames, fds, nil | ||
| } | ||
|
|
||
| func addFilesToFileDescriptorList(allFiles []*desc.FileDescriptor, expanded map[string]struct{}, fd *desc.FileDescriptor) []*desc.FileDescriptor { | ||
| if _, ok := expanded[fd.GetName()]; ok { | ||
| // already seen this one | ||
| return allFiles | ||
| } | ||
| expanded[fd.GetName()] = struct{}{} | ||
| // add all dependencies first | ||
| for _, dep := range fd.GetDependencies() { | ||
| allFiles = addFilesToFileDescriptorList(allFiles, expanded, dep) | ||
| } | ||
| return append(allFiles, fd) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you should be able to omit this block, if err is non-nil, f will be nil
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
solved