serve

Documentation

Overview

Package serve implements the "jig serve" command, serving GRPC services via an evaluator.

Index

• func NewFS(vfs ...fs.FS) fs.FS
• func NewFSFromDirs(dirs ...string) fs.FS
• type Evaluator
  • func JsonnetEvaluator() Evaluator
• type EvaluatorFunc
  • func (ef EvaluatorFunc) Evaluate(method, input string, vfs fs.FS) (output string, err error)
• type Option
  • func WithFileDescriptorSets(fds ...*descriptorpb.FileDescriptorSet) Option
  • func WithLogger(logger log.Logger) Option
  • func WithProtosets(protosets ...string) Option
• type Server
  • func NewServer(eval Evaluator, vfs fs.FS, options ...Option) (*Server, error)
  • func (s *Server) ListenAndServe(listenAddr string) error
  • func (s *Server) Serve(lis net.Listener) error
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) SetHTTPHandler(handler http.Handler)
  • func (s *Server) Stop()
  • func (s *Server) UnknownHandler(srv interface{}, ss grpc.ServerStream) error
• type TestServer
  • func NewTestServer(eval Evaluator, vfs fs.FS, options ...Option) *TestServer
  • func NewUnstartedTestServer(eval Evaluator, vfs fs.FS, options ...Option) *TestServer
  • func (ts *TestServer) Addr() string
  • func (ts *TestServer) Start()

Functions

func NewFS

func NewFS(vfs ...fs.FS) fs.FS

NewFS combines the top level directories of multiple fs.FS.

func NewFSFromDirs

func NewFSFromDirs(dirs ...string) fs.FS

NewFSFromDirs combines the top level directories of multiple directories.

Types

type Evaluator

type Evaluator interface {
	Evaluate(method, input string, vfs fs.FS) (output string, err error)
}

func JsonnetEvaluator

func JsonnetEvaluator() Evaluator

type EvaluatorFunc

type EvaluatorFunc func(method, input string, vfs fs.FS) (output string, err error)

func (EvaluatorFunc) Evaluate

func (ef EvaluatorFunc) Evaluate(method, input string, vfs fs.FS) (output string, err error)

type Option

type Option func(s *Server) error

Option is a functional option to configure Server

func WithFileDescriptorSets

func WithFileDescriptorSets(fds ...*descriptorpb.FileDescriptorSet) Option

func WithLogger

func WithLogger(logger log.Logger) Option

func WithProtosets

func WithProtosets(protosets ...string) Option

type Server

type Server struct {
	Files *registry.Files
	// contains filtered or unexported fields
}

func NewServer

func NewServer(eval Evaluator, vfs fs.FS, options ...Option) (*Server, error)

NewServer creates a new Server for given evaluator, e.g. Jsonnet and data Directories.

func (*Server) ListenAndServe

func (s *Server) ListenAndServe(listenAddr string) error

func (*Server) Serve

func (s *Server) Serve(lis net.Listener) error

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) SetHTTPHandler

func (s *Server) SetHTTPHandler(handler http.Handler)

SetHTTPHandler sets a http.Handler to be called for non-grpc traffic. It must be called before Serve or ListenAndServe are called.

func (*Server) Stop

func (s *Server) Stop()

func (*Server) UnknownHandler

func (s *Server) UnknownHandler(srv interface{}, ss grpc.ServerStream) error

UnknownHandler handles gRPC method calls that are not statically implemented. It is registered as the UnknownServiceHandler of the grpc server.

UnknownHandler can be called from a non-grpc.Server entry point, possibly a HTTP server or even an internal dispatch bypassing the network. In order for this handler to know which method is being invoked, the `srv` argument can be (ab)used to pass the full name of the method. In this case the dynamic type of `srv` must be `protoreflect.FullName` and it must contain the fully-qualified method name (pkg.service.method).

Alternatively, the stream context (ss.Context()) must contain a grpc.ServerTransportStream, retrievable with grpc.ServerTransportStreamFromContext(), on which the `Method()` method will be called to find the method name. This should return the method as a HTTP path (/pkg.service/method), as is done by grpc.Server.

type TestServer

type TestServer struct {
	Server
	// contains filtered or unexported fields
}

func NewTestServer

func NewTestServer(eval Evaluator, vfs fs.FS, options ...Option) *TestServer

NewTestServer starts and returns a new TestServer. The caller should call Stop when finished, to shut it down.

func NewUnstartedTestServer

func NewUnstartedTestServer(eval Evaluator, vfs fs.FS, options ...Option) *TestServer

NewTestServer starts and returns a new TestServer. The caller should call Stop when finished, to shut it down.

func (*TestServer) Addr

func (ts *TestServer) Addr() string

func (*TestServer) Start

func (ts *TestServer) Start()