README
¶
Collector
This package contains code to support compiling protos
ProtoCompiler
A ProtoCompiler is given a root and produces the file descriptor for each file in the tree. It does this by traversing the file system, starting at the root and for each file:
- Collects the imports, using an injected Collector
- Runs
protoc, using an injected ProtocExecutor, and writes the output to atmpfile - Aggregates the file descriptors produced by
protoc
Collector
A collector is responsible for traversing a tree of files, opening and parsing each. A collector uses an ImportsExtractor to parse these files and aggregate a full list of imports in the tree.
ProtocExecutor
DefaultProtocExecutor
This is the default implementation used during codegen. It is builds the protoc command and executes it
OpenApiProtocExecutor
This is the protoc implementation used by our protoc tool during schemagen.
ImportsExtractor
An ImportsExtractor is responsible for reading the imports from a proto file.
SynchronizedImportsExtractor
When extracting imports for a single file, we must walk the entire dependency tree. Since we do this for each file, it's possible that we are walking the same paths repeatedly. Therefore, we support this implementation, which only allows a single in flight request per file, and then memoizes the results.
Documentation
¶
Index ¶
- Variables
- func NewCollector(customImports, commonImports []string) *collector
- func NewProtoCompiler(collector Collector, executor ProtocExecutor) *protoCompiler
- type Collector
- type DefaultProtocExecutor
- type ImportsExtractor
- type ImportsFetcher
- type OpenApiProtocExecutor
- type ProtoCompiler
- type ProtocExecutor
Constants ¶
This section is empty.
Variables ¶
var ( FetchImportsTimeout = func(filename string) error { return eris.Errorf("Timed out while fetching imports for proto file: [%s]", filename) } )
Functions ¶
func NewCollector ¶
func NewCollector(customImports, commonImports []string) *collector
func NewProtoCompiler ¶ added in v0.18.5
func NewProtoCompiler(collector Collector, executor ProtocExecutor) *protoCompiler
Types ¶
type DefaultProtocExecutor ¶ added in v0.19.0
type DefaultProtocExecutor struct {
// The output directory
OutputDir string
// whether or not to do a regular go-proto generate while collecting descriptors
ShouldCompileFile func(string) bool
// arguments for go_out=
CustomGoArgs []string
// custom plugins
// each will append a <plugin>_out= directive to protoc command
CustomPlugins []string
}
type ImportsExtractor ¶ added in v0.18.5
type ImportsExtractor interface {
FetchImportsForFile(protoFile string, importsFetcher ImportsFetcher) ([]string, error)
}
func NewSynchronizedImportsExtractor ¶ added in v0.18.5
func NewSynchronizedImportsExtractor() ImportsExtractor
type ImportsFetcher ¶ added in v0.18.5
type OpenApiProtocExecutor ¶ added in v0.19.0
type OpenApiProtocExecutor struct {
OutputDir string
// Whether to include descriptions in validation schemas
IncludeDescriptionsInSchema bool
// Whether to assign Enum fields the `x-kubernetes-int-or-string` property
// which allows the value to either be an integer or a string
EnumAsIntOrString bool
// A list of messages (core.solo.io.Status) whose validation schema should
// not be generated
MessagesWithEmptySchema []string
}
type ProtoCompiler ¶ added in v0.18.5
type ProtoCompiler interface {
CompileDescriptorsFromRoot(root string, skipDirs []string) ([]*model.DescriptorWithPath, error)
}
Source Files