clconnect

Documentation

Overview

Package clconnect provides generic fx dependency for standard ConnectRPC services.

Index

• Variables
• func New[RO, RW any](cfg Config, logs *zap.Logger, ro RO, roc ConstructHandler[RO], rw RW, ...) http.Handler
• func Provide[RO, RW any](name string) fx.Option
• func ProvideEntTransactors[TX EntModelTx, MC EntModelClient[TX]]() fx.Option
• func ProvidePgxTransactors() fx.Option
• func TestProvide[RO, RW, ROC, ROW any](name string) fx.Option
• type Config
• type ConstructClient
• type ConstructHandler
• type EntModelClient
• type EntModelTx
• type EntROTransactor
  • func NewEntROTransactor[TX EntModelTx, MC EntModelClient[TX]](logs *zap.Logger, mc MC) *EntROTransactor[TX, MC]
• type EntRWTransactor
  • func NewEntRWTransactor[TX EntModelTx, MC EntModelClient[TX]](logs *zap.Logger, mc MC) *EntRWTransactor[TX, MC]
• type Logger
  • func NewLogger(cfg Config, logs *zap.Logger) *Logger
• type PgxROTransacter
  • func NewPgxROTransacter(cfg Config, logs *zap.Logger, ro *pgxpool.Pool) *PgxROTransacter
• type PgxRWTransacter
  • func NewPgxRWTransacter(cfg Config, logs *zap.Logger, rw *pgxpool.Pool) *PgxRWTransacter
• type ROTransacter
• type RWTransacter
• type Recoverer
  • func NewRecoverer(cfg Config, logs *zap.Logger) *Recoverer

Variables

var ErrServerPanic = errors.New("server panic")

ErrServerPanic is returned when the server panicked.

Functions

func New

func New[RO, RW any](
	cfg Config,
	logs *zap.Logger,
	ro RO, roc ConstructHandler[RO],
	rw RW, rwc ConstructHandler[RW],

	valr *validate.Interceptor,
	logr *Logger,
	rcvr *Recoverer,
	rotx ROTransacter,
	rwtx RWTransacter,
) http.Handler

New inits an http handler for the full RPC api.

func Provide

func Provide[RO, RW any](name string) fx.Option

Provide the package components for the DI container.

func ProvideEntTransactors

func ProvideEntTransactors[TX EntModelTx, MC EntModelClient[TX]]() fx.Option

ProvideEntTransactors provides the RO transactor.

func ProvidePgxTransactors

func ProvidePgxTransactors() fx.Option

ProvidePgxTransactors provides transactors for pgx transactions.

func TestProvide

func TestProvide[RO, RW, ROC, ROW any](name string) fx.Option

TestProvide provides dependencies for testing.

Types

type Config

type Config struct {
	// disables stack trace information in error details
	DisableStackTraceErrorDetails bool `env:"DISABLE_STACK_TRACE_ERROR_DETAILS"`
}

Config configures the components.

type ConstructClient

type ConstructClient[SC any] func(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SC

ConstructClient is a funct signature that constructs a client.

type ConstructHandler

type ConstructHandler[SH any] func(svc SH, opts ...connect.HandlerOption) (string, http.Handler)

ConstructHandler defines the type for constructing a connectrpc service handler.

type EntModelClient

type EntModelClient[TX EntModelTx] interface {
	BeginTx(ctx context.Context, opts *entsql.TxOptions) (TX, error)
}

EntModelClient is a generic type to constraint the model client to those generated by Ent.

type EntModelTx

type EntModelTx interface {
	Commit() error
	Rollback() error
}

EntModelTx is a generic type to constraint the tx to those generated by Ent.

type EntROTransactor

type EntROTransactor[TX EntModelTx, MC EntModelClient[TX]] struct {
	connect.Interceptor
	// contains filtered or unexported fields
}

EntROTransactor provides an ent tx to the context.

func NewEntROTransactor

func NewEntROTransactor[TX EntModelTx, MC EntModelClient[TX]](logs *zap.Logger, mc MC) *EntROTransactor[TX, MC]

NewEntROTransactor its a RO transactor for the model client type.

type EntRWTransactor

type EntRWTransactor[TX EntModelTx, MC EntModelClient[TX]] struct {
	connect.Interceptor
	// contains filtered or unexported fields
}

EntRWTransactor provides an ent tx to the context.

func NewEntRWTransactor

func NewEntRWTransactor[TX EntModelTx, MC EntModelClient[TX]](logs *zap.Logger, mc MC) *EntRWTransactor[TX, MC]

NewEntRWTransactor its a RW transactor for the model client type.

type Logger

type Logger struct {
	connect.Interceptor
	// contains filtered or unexported fields
}

Logger logs RPC calls as an interceptor.

func NewLogger

func NewLogger(cfg Config, logs *zap.Logger) *Logger

NewLogger inits the logger.

type PgxROTransacter

type PgxROTransacter struct {
	connect.Interceptor
	// contains filtered or unexported fields
}

PgxROTransacter provides a database transaction in the context.

func NewPgxROTransacter

func NewPgxROTransacter(cfg Config, logs *zap.Logger, ro *pgxpool.Pool) *PgxROTransacter

NewPgxROTransacter inits the Transacter.

type PgxRWTransacter

type PgxRWTransacter struct {
	connect.Interceptor
	// contains filtered or unexported fields
}

PgxRWTransacter provides a database transaction in the context.

func NewPgxRWTransacter

func NewPgxRWTransacter(cfg Config, logs *zap.Logger, rw *pgxpool.Pool) *PgxRWTransacter

NewPgxRWTransacter inits the Transacter.

type ROTransacter

type ROTransacter interface {
	connect.Interceptor
	// contains filtered or unexported methods
}

ROTransacter is an interceptor that add read-only transactions to the context.

type RWTransacter

type RWTransacter interface {
	connect.Interceptor
	// contains filtered or unexported methods
}

RWTransacter is an interceptor that add read-write transactions to the context.

type Recoverer

type Recoverer struct {
	// contains filtered or unexported fields
}

Recoverer allows recovering from panics.

func NewRecoverer

func NewRecoverer(cfg Config, logs *zap.Logger) *Recoverer

NewRecoverer inits the recoverer.