grpc/service/options.go

594 lines
12 KiB
Go
Raw Normal View History

2020-01-22 13:02:06 +00:00
package service
import (
"context"
"crypto/tls"
"crypto/x509"
"embed"
2020-01-22 13:02:06 +00:00
"fmt"
"io/ioutil"
"net"
"strings"
2020-01-22 13:02:06 +00:00
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"github.com/improbable-eng/grpc-web/go/grpcweb"
2020-01-22 13:02:06 +00:00
"github.com/jinzhu/gorm"
2021-09-30 14:56:51 +00:00
"github.com/rs/cors"
"go.uber.org/multierr"
2020-01-22 13:02:06 +00:00
"google.golang.org/grpc"
2021-07-17 20:40:06 +00:00
"go.linka.cloud/grpc/certs"
"go.linka.cloud/grpc/interceptors"
2021-07-17 20:40:06 +00:00
"go.linka.cloud/grpc/registry"
"go.linka.cloud/grpc/transport"
2021-07-17 20:40:06 +00:00
"go.linka.cloud/grpc/utils/addr"
2020-01-22 13:02:06 +00:00
)
/*
GLOBAL OPTIONS:
--client value Client for go-micro; rpc [$MICRO_CLIENT]
--client_request_timeout value Sets the client request timeout. e.g 500ms, 5s, 1m. Default: 5s [$MICRO_CLIENT_REQUEST_TIMEOUT]
--client_retries value Sets the client retries. Default: 1 (default: 1) [$MICRO_CLIENT_RETRIES]
--client_pool_size value Sets the client connection pool size. Default: 1 (default: 0) [$MICRO_CLIENT_POOL_SIZE]
--client_pool_ttl value Sets the client connection pool ttl. e.g 500ms, 5s, 1m. Default: 1m [$MICRO_CLIENT_POOL_TTL]
--help, -h show help
--secure SECURE
--ca_cert CA_CERT
--server_cert SERVER_CERT
--server_key SERVER_KEY
2020-01-22 13:02:06 +00:00
--register_ttl REGISTER_TTL
--register_interval REGISTER_INTERVAL
--server_address SERVER_ADDRESS
2020-01-22 13:02:06 +00:00
--server_name SERVER_NAME
--broker BROKER
2020-01-22 13:02:06 +00:00
--broker_address BROKER_ADDRESS
--registry REGISTRY
2020-01-22 13:02:06 +00:00
--registry_address REGISTRY_ADDRESS
--db_path DB_PATH
2020-01-22 13:02:06 +00:00
*/
type RegisterGatewayFunc func(ctx context.Context, mux *runtime.ServeMux, cc grpc.ClientConnInterface) error
2020-01-22 13:02:06 +00:00
type Options interface {
Context() context.Context
Name() string
Version() string
2020-01-22 13:02:06 +00:00
Address() string
Reflection() bool
Health() bool
2020-01-22 13:02:06 +00:00
CACert() string
Cert() string
Key() string
TLSConfig() *tls.Config
Secure() bool
Registry() registry.Registry
2020-01-22 13:02:06 +00:00
DB() *gorm.DB
2020-01-22 13:02:06 +00:00
BeforeStart() []func() error
AfterStart() []func() error
BeforeStop() []func() error
AfterStop() []func() error
2020-01-22 13:02:06 +00:00
ServerOpts() []grpc.ServerOption
ServerInterceptors() []grpc.UnaryServerInterceptor
StreamServerInterceptors() []grpc.StreamServerInterceptor
2020-01-22 13:02:06 +00:00
ClientInterceptors() []grpc.UnaryClientInterceptor
StreamClientInterceptors() []grpc.StreamClientInterceptor
2021-09-30 14:56:51 +00:00
Cors() cors.Options
Mux() ServeMux
GRPCWeb() bool
GRPCWebPrefix() string
GRPCWebOpts() []grpcweb.Option
Gateway() bool
GatewayPrefix() string
GatewayOpts() []runtime.ServeMuxOption
2021-09-30 14:56:51 +00:00
// TODO(adphi): metrics + tracing
Default()
2020-01-22 13:02:06 +00:00
}
func NewOptions() *options {
return &options{
ctx: context.Background(),
address: ":0",
health: true,
2020-01-22 13:02:06 +00:00
}
}
func (o *options) Default() {
2020-01-22 13:02:06 +00:00
if o.ctx == nil {
o.ctx = context.Background()
}
if o.address == "" {
o.address = "0.0.0.0:0"
}
if o.transport == nil {
o.transport = &grpc.Server{}
}
2021-09-30 14:56:51 +00:00
2020-01-22 13:02:06 +00:00
}
type Option func(*options)
func WithName(name string) Option {
return func(o *options) {
o.name = name
}
}
func WithVersion(version string) Option {
return func(o *options) {
o.version = version
}
}
func WithRegistry(registry registry.Registry) Option {
return func(o *options) {
o.registry = registry
}
}
// WithContext specifies a context for the service.
2020-01-22 13:02:06 +00:00
// Can be used to signal shutdown of the service.
// Can be used for extra option values.
func WithContext(ctx context.Context) Option {
return func(o *options) {
o.ctx = ctx
}
}
// WithAddress sets the address of the server
2020-01-22 13:02:06 +00:00
func WithAddress(addr string) Option {
return func(o *options) {
o.address = addr
}
}
func WithReflection(r bool) Option {
return func(o *options) {
o.reflection = r
}
}
func WithHealth(h bool) Option {
return func(o *options) {
o.health = h
}
}
func WithSecure(s bool) Option {
return func(o *options) {
o.secure = s
}
}
2020-01-22 13:02:06 +00:00
func WithGRPCServerOpts(opts ...grpc.ServerOption) Option {
return func(o *options) {
o.serverOpts = append(o.serverOpts, opts...)
}
}
func WithCACert(path string) Option {
return func(o *options) {
o.caCert = path
}
}
func WithCert(path string) Option {
return func(o *options) {
o.cert = path
}
}
func WithKey(path string) Option {
return func(o *options) {
o.key = path
}
}
2020-03-03 13:54:53 +00:00
func WithDB(dialect string, args ...interface{}) Option {
db, err := gorm.Open(dialect, args...)
2020-01-22 13:02:06 +00:00
return func(o *options) {
o.db = db
o.error = multierr.Append(o.error, err)
2020-01-22 13:02:06 +00:00
}
}
func WithTLSConfig(conf *tls.Config) Option {
return func(o *options) {
o.tlsConfig = conf
2020-01-22 13:02:06 +00:00
}
}
func WithBeforeStart(fn ...func() error) Option {
return func(o *options) {
o.beforeStart = append(o.beforeStart, fn...)
}
}
func WithBeforeStop(fn ...func() error) Option {
return func(o *options) {
o.beforeStop = append(o.beforeStop, fn...)
}
}
func WithAfterStart(fn ...func() error) Option {
return func(o *options) {
o.afterStart = append(o.afterStart, fn...)
}
}
func WithAfterStop(fn ...func() error) Option {
return func(o *options) {
o.afterStop = append(o.afterStop, fn...)
}
}
func WithInterceptors(i ...interceptors.Interceptors) Option {
return func(o *options) {
for _, v := range i {
o.unaryServerInterceptors = append(o.unaryServerInterceptors, v.UnaryServerInterceptor())
o.streamServerInterceptors = append(o.streamServerInterceptors, v.StreamServerInterceptor())
o.unaryClientInterceptors = append(o.unaryClientInterceptors, v.UnaryClientInterceptor())
o.streamClientInterceptors = append(o.streamClientInterceptors, v.StreamClientInterceptor())
}
}
}
func WithServerInterceptors(i ...interceptors.ServerInterceptors) Option {
return func(o *options) {
for _, v := range i {
o.unaryServerInterceptors = append(o.unaryServerInterceptors, v.UnaryServerInterceptor())
o.streamServerInterceptors = append(o.streamServerInterceptors, v.StreamServerInterceptor())
}
}
}
func WithClientInterceptors(i ...interceptors.ClientInterceptors) Option {
return func(o *options) {
for _, v := range i {
o.unaryClientInterceptors = append(o.unaryClientInterceptors, v.UnaryClientInterceptor())
o.streamClientInterceptors = append(o.streamClientInterceptors, v.StreamClientInterceptor())
}
}
}
2020-01-22 13:02:06 +00:00
func WithUnaryClientInterceptor(i ...grpc.UnaryClientInterceptor) Option {
return func(o *options) {
o.unaryClientInterceptors = append(o.unaryClientInterceptors, i...)
2020-01-22 13:02:06 +00:00
}
}
// WithUnaryServerInterceptor adds unary Wrapper interceptors to the options passed into the server
2020-01-22 13:02:06 +00:00
func WithUnaryServerInterceptor(i ...grpc.UnaryServerInterceptor) Option {
return func(o *options) {
o.unaryServerInterceptors = append(o.unaryServerInterceptors, i...)
2020-01-22 13:02:06 +00:00
}
}
func WithStreamServerInterceptor(i ...grpc.StreamServerInterceptor) Option {
return func(o *options) {
o.streamServerInterceptors = append(o.streamServerInterceptors, i...)
}
}
func WithStreamClientInterceptor(i ...grpc.StreamClientInterceptor) Option {
return func(o *options) {
o.streamClientInterceptors = append(o.streamClientInterceptors, i...)
}
}
// WithSubscriberInterceptor adds subscriber interceptors to the options passed into the server
2020-01-22 13:02:06 +00:00
func WithSubscriberInterceptor(w ...interface{}) Option {
return func(o *options) {
}
}
2021-09-30 14:56:51 +00:00
func WithCors(opts cors.Options) Option {
return func(o *options) {
o.cors = opts
}
}
func WithMux(mux ServeMux) Option {
return func(o *options) {
o.mux = mux
}
}
func WithMiddlewares(m ...Middleware) Option {
return func(o *options) {
o.middlewares = m
}
}
func WithGRPCWeb(b bool) Option {
return func(o *options) {
o.grpcWeb = b
}
}
func WithGRPCWebPrefix(prefix string) Option {
return func(o *options) {
o.grpcWebPrefix = strings.TrimSuffix(prefix, "/")
}
}
func WithGRPCWebOpts(opts ...grpcweb.Option) Option {
return func(o *options) {
o.grpcWebOpts = opts
}
}
func WithGateway(fn RegisterGatewayFunc) Option {
return func(o *options) {
o.gateway = fn
}
}
func WithGatewayPrefix(prefix string) Option {
return func(o *options) {
o.gatewayPrefix = strings.TrimSuffix(prefix, "/")
}
}
func WithGatewayOpts(opts ...runtime.ServeMuxOption) Option {
return func(o *options) {
o.gatewayOpts = opts
}
}
// WithReactUI add static single page app serving to the http server
// subpath is the path in the read-only file embed.FS to use as root to serve
// static content
func WithReactUI(fs embed.FS, subpath string) Option {
return func(o *options) {
o.reactUI = fs
o.reactUISubPath = subpath
o.hasReactUI = true
}
}
2020-01-22 13:02:06 +00:00
type options struct {
ctx context.Context
name string
version string
address string
reflection bool
health bool
2020-01-22 13:02:06 +00:00
secure bool
caCert string
cert string
key string
tlsConfig *tls.Config
db *gorm.DB
transport transport.Transport
registry registry.Registry
2020-01-22 13:02:06 +00:00
beforeStart []func() error
afterStart []func() error
beforeStop []func() error
afterStop []func() error
serverOpts []grpc.ServerOption
unaryServerInterceptors []grpc.UnaryServerInterceptor
2020-01-22 13:02:06 +00:00
streamServerInterceptors []grpc.StreamServerInterceptor
unaryClientInterceptors []grpc.UnaryClientInterceptor
2020-01-22 13:02:06 +00:00
streamClientInterceptors []grpc.StreamClientInterceptor
2020-03-03 13:54:53 +00:00
mux ServeMux
middlewares []Middleware
grpcWeb bool
grpcWebOpts []grpcweb.Option
grpcWebPrefix string
gateway RegisterGatewayFunc
gatewayOpts []runtime.ServeMuxOption
2021-09-30 14:56:51 +00:00
cors cors.Options
reactUI embed.FS
reactUISubPath string
hasReactUI bool
error error
gatewayPrefix string
2020-01-22 13:02:06 +00:00
}
func (o *options) Name() string {
return o.name
}
func (o *options) Version() string {
return o.version
}
2020-01-22 13:02:06 +00:00
func (o *options) Context() context.Context {
return o.ctx
}
func (o *options) Address() string {
return o.address
}
func (o *options) Registry() registry.Registry {
return o.registry
}
func (o *options) Reflection() bool {
return o.reflection
}
func (o *options) Health() bool {
return o.health
}
2020-01-22 13:02:06 +00:00
func (o *options) CACert() string {
return o.caCert
}
func (o *options) Cert() string {
return o.cert
}
func (o *options) Key() string {
return o.key
}
func (o *options) TLSConfig() *tls.Config {
2020-01-22 13:02:06 +00:00
return o.tlsConfig
}
func (o *options) Secure() bool {
return o.secure
}
2020-01-22 13:02:06 +00:00
func (o *options) DB() *gorm.DB {
return o.db
}
func (o *options) BeforeStart() []func() error {
return o.beforeStart
}
func (o *options) AfterStart() []func() error {
return o.afterStart
}
func (o *options) BeforeStop() []func() error {
return o.beforeStop
}
func (o *options) AfterStop() []func() error {
return o.afterStop
}
func (o *options) ServerOpts() []grpc.ServerOption {
return o.serverOpts
}
func (o *options) ServerInterceptors() []grpc.UnaryServerInterceptor {
return o.unaryServerInterceptors
2020-01-22 13:02:06 +00:00
}
func (o *options) StreamServerInterceptors() []grpc.StreamServerInterceptor {
return o.streamServerInterceptors
}
func (o *options) ClientInterceptors() []grpc.UnaryClientInterceptor {
return o.unaryClientInterceptors
2020-01-22 13:02:06 +00:00
}
func (o *options) StreamClientInterceptors() []grpc.StreamClientInterceptor {
return o.streamClientInterceptors
}
2021-09-30 14:56:51 +00:00
func (o *options) Cors() cors.Options {
return o.cors
}
func (o *options) Mux() ServeMux {
return o.mux
}
func (o *options) GRPCWeb() bool {
return o.grpcWeb
}
func (o *options) GRPCWebPrefix() string {
return o.grpcWebPrefix
}
func (o *options) GRPCWebOpts() []grpcweb.Option {
return o.grpcWebOpts
}
func (o *options) Gateway() bool {
return o.gateway != nil
}
func (o *options) GatewayPrefix() string {
return o.gatewayPrefix
}
func (o *options) GatewayOpts() []runtime.ServeMuxOption {
return o.gatewayOpts
}
2020-01-22 13:02:06 +00:00
func (o *options) parseTLSConfig() error {
if o.tlsConfig != nil {
return nil
}
if !o.hasTLSConfig() {
if !o.secure {
return nil
}
var hosts []string
if host, _, err := net.SplitHostPort(o.address); err == nil {
if len(host) == 0 {
hosts = addr.IPs()
} else {
hosts = []string{host}
}
}
for i, h := range hosts {
a, err := addr.Extract(h)
if err != nil {
return err
}
hosts[i] = a
}
// generate a certificate
cert, err := certs.New(hosts...)
if err != nil {
return err
}
o.tlsConfig = &tls.Config{
Certificates: []tls.Certificate{cert},
ClientAuth: tls.NoClientCert,
}
2020-01-22 13:02:06 +00:00
return nil
}
caCert, err := ioutil.ReadFile(o.caCert)
if err != nil {
return err
}
caCertPool := x509.NewCertPool()
ok := caCertPool.AppendCertsFromPEM(caCert)
if !ok {
return fmt.Errorf("failed to load CA Cert from %s", o.caCert)
}
cert, err := tls.LoadX509KeyPair(o.cert, o.key)
if err != nil {
return err
}
o.tlsConfig = &tls.Config{
2020-01-22 13:02:06 +00:00
Certificates: []tls.Certificate{cert},
RootCAs: caCertPool,
2020-01-22 13:02:06 +00:00
}
return nil
}
func (o *options) hasTLSConfig() bool {
return o.caCert != "" && o.cert != "" && o.key != "" && o.tlsConfig == nil
2020-01-22 13:02:06 +00:00
}