collector

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:

1. Collects the imports, using an injected Collector
2. Runs protoc, using an injected ProtocExecutor, and writes the output to a tmp file
3. 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
  • func (d *DefaultProtocExecutor) Execute(protoFile string, toFile string, imports []string) error
• type ImportsExtractor
  • func NewSynchronizedImportsExtractor() ImportsExtractor
• type ImportsFetcher
• type OpenApiProtocExecutor
  • func (o *OpenApiProtocExecutor) Execute(protoFile string, toFile string, imports []string) error
• type ProtoCompiler
• type ProtocExecutor

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

func NewProtoCompiler(collector Collector, executor ProtocExecutor) *protoCompiler

Types

type Collector

type Collector interface {
	CollectImportsForFile(root, protoFile string) ([]string, error)
}

type DefaultProtocExecutor

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
}

func (*DefaultProtocExecutor) Execute

func (d *DefaultProtocExecutor) Execute(protoFile string, toFile string, imports []string) error

type ImportsExtractor

type ImportsExtractor interface {
	FetchImportsForFile(protoFile string, importsFetcher ImportsFetcher) ([]string, error)
}

func NewSynchronizedImportsExtractor

func NewSynchronizedImportsExtractor() ImportsExtractor

type ImportsFetcher

type ImportsFetcher func(file string) ([]string, error)

type OpenApiProtocExecutor

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

	// Whether to exclude kubebuilder markers and validations (such as PreserveUnknownFields, MinItems, default, and all CEL rules)
	// Type and Required markers will be included regardless
	DisableKubeMarkers bool
}

func (*OpenApiProtocExecutor) Execute

func (o *OpenApiProtocExecutor) Execute(protoFile string, toFile string, imports []string) error

type ProtoCompiler

type ProtoCompiler interface {
	CompileDescriptorsFromRoot(root string, skipDirs []string) ([]*model.DescriptorWithPath, error)
}

type ProtocExecutor

type ProtocExecutor interface {
	Execute(protoFile string, toFile string, imports []string) error
}