kit

Apr 24, 2024

Changes in this version

type WorkerConfig

+ ScheduleDefaultRetry *int

Apr 16, 2024

Changes in this version

type EnqueuerConfig

+ TaskDefaultRetry *int

Apr 5, 2024

Changes in this version

type HTTPClientConfig

+ RaiseForStatus *bool

Apr 5, 2024

Changes in this version

+ var ErrHTTPClientRateLimited = errors.New("http client rate limited (%s)")

type HTTPClientConfig

+ BaseURL *string

+ Headers *map[string]string

Jan 28, 2024

Changes in this version

type Migrator

+ func (self *Migrator) Version(ctx context.Context) (int, bool, error)

Jan 20, 2024

Changes in this version

+ var ErrHTTPClientBadStatus = errors.New("http client bad status code (%d)")

Jan 20, 2024

Changes in this version

+ var ErrDatabaseUnexpectedEffect = errors.New("database affected %d out of %d expected rows")

Jan 18, 2024

Changes in this version

+ var ErrErrorHandlerGeneric = errors.New("error handler failed")

+ var ErrHTTPClientGeneric = errors.New("http client failed")

+ var ErrHTTPClientTimedOut = errors.New("http client timed out")

+ var ErrHTTPServerGeneric = errors.New("http server failed")

+ var ErrHTTPServerTimedOut = errors.New("http server timed out")

+ var ErrRunnerGeneric = errors.New("runner failed")

+ var ErrRunnerTimedOut = errors.New("runner timed out")

+ var HTTPErrClientGeneric = NewHTTPError("ERR_CLIENT_GENERIC", http.StatusBadRequest)

+ var HTTPErrInvalidRequest = NewHTTPError("ERR_INVALID_REQUEST", http.StatusBadRequest)

+ var HTTPErrNotFound = NewHTTPError("ERR_NOT_FOUND", http.StatusNotFound)

+ var HTTPErrRequestTimeout = NewHTTPError("ERR_REQUEST_TIMEOUT", http.StatusGatewayTimeout)

+ var HTTPErrServerGeneric = NewHTTPError("ERR_SERVER_GENERIC", http.StatusInternalServerError)

+ var HTTPErrServerUnavailable = NewHTTPError("ERR_SERVER_UNAVAILABLE", http.StatusServiceUnavailable)

+ var HTTPErrUnauthorized = NewHTTPError("ERR_UNAUTHORIZED", http.StatusUnauthorized)

type CacheConfig

+ DialTimeout *time.Duration

+ Host string

+ MaxConnIdleTime *time.Duration

+ MaxConnLifeTime *time.Duration

+ MaxConns *int

+ MinConns *int

+ Password string

+ Port int

+ ReadTimeout *time.Duration

+ SSLMode bool

+ WriteTimeout *time.Duration

type DatabaseConfig

+ Database string

+ DefaultIsolationLevel *IsolationLevel

+ DialTimeout *time.Duration

+ Host string

+ MaxConnIdleTime *time.Duration

+ MaxConnLifeTime *time.Duration

+ MaxConns *int

+ MinConns *int

+ Password string

+ Port int

+ SSLMode string

+ Service string

+ StatementTimeout *time.Duration

+ User string

+ type ErrorHandler struct

+ func NewErrorHandler(observer *Observer, config ErrorHandlerConfig) *ErrorHandler

+ func (self *ErrorHandler) HandleCommand(next RunnerHandler) RunnerHandler

+ func (self *ErrorHandler) HandleRequest(err error, ctx echo.Context)

+ func (self *ErrorHandler) HandleTask(ctx context.Context, _ *asynq.Task, err error)

+ type ErrorHandlerConfig struct

+ Environment Environment

+ MinStatusCodeToLog *int

+ type HTTPClient struct

+ func NewHTTPClient(observer *Observer, config HTTPClientConfig) *HTTPClient

+ func (self *HTTPClient) Close(ctx context.Context) error

+ func (self *HTTPClient) Do(request *http.Request) (*http.Response, error)

+ func (self *HTTPClient) Request(ctx context.Context, method string, url string, body io.Reader, ...) (*http.Response, error)

+ type HTTPClientConfig struct

+ AllowedRedirects *int

+ DefaultRetry *RetryConfig

+ Timeout time.Duration

+ type HTTPError struct

+ func NewHTTPError(code string, status int) HTTPError

+ func (self *HTTPError) Redact()

+ func (self HTTPError) Cause(err error) *HTTPError

+ func (self HTTPError) Code() string

+ func (self HTTPError) Error() string

+ func (self HTTPError) Format(format fmt.State, verb rune)

+ func (self HTTPError) Has(err error) bool

+ func (self HTTPError) Is(err error) bool

+ func (self HTTPError) MarshalJSON() ([]byte, error)

+ func (self HTTPError) MarshalText() ([]byte, error)

+ func (self HTTPError) Status() int

+ func (self HTTPError) String() string

+ func (self HTTPError) Unwrap() error

+ type HTTPServer struct

+ func NewHTTPServer(observer *Observer, serializer *Serializer, binder *Binder, renderer *Renderer, ...) *HTTPServer

+ func (self *HTTPServer) Close(ctx context.Context) error

+ func (self *HTTPServer) Default(middleware ...echo.MiddlewareFunc) *echo.Group

+ func (self *HTTPServer) Host(host string, middleware ...echo.MiddlewareFunc) *echo.Group

+ func (self *HTTPServer) Run(ctx context.Context) error

+ func (self *HTTPServer) Use(middleware ...echo.MiddlewareFunc)

+ type HTTPServerConfig struct

+ Environment Environment

+ Port int

+ RequestBodyMaxSize *int

+ RequestFileMaxSize *int

+ RequestFilePattern *string

+ RequestHeaderMaxSize *int

+ RequestIPExtractor *func(*http.Request) string

+ RequestKeepAliveTimeout *time.Duration

+ RequestReadHeaderTimeout *time.Duration

+ RequestReadTimeout *time.Duration

+ ResponseWriteTimeout *time.Duration

+ type IsolationLevel int

+ var IsoLvlReadCommitted IsolationLevel

+ var IsoLvlReadUncommitted IsolationLevel = 0

+ var IsoLvlRepeatableRead IsolationLevel

+ var IsoLvlSerializable IsolationLevel

type LocalizerConfig

+ LocaleFilePattern *string

type LoggerConfig

+ Service string

type Observer

+ func (self Observer) TraceClientRequest(ctx context.Context, request *http.Request) (context.Context, func())

+ func (self Observer) TraceCommand(ctx context.Context, command *cli.Context) (context.Context, func())

+ func (self Observer) TraceServerRequest(ctx context.Context, request *http.Request) (context.Context, func())

type ObserverConfig

+ Gilk *ObserverGilkConfig

+ Sentry *ObserverSentryConfig

+ Service string

type RendererConfig

+ TemplateFilePattern *string

+ type RetryConfig struct

+ Attempts int

+ InitialDelay time.Duration

+ LimitDelay time.Duration

+ Retriables []error

+ type Runner struct

+ func NewRunner(observer *Observer, errorHandler *ErrorHandler, config RunnerConfig) *Runner

+ func (self *Runner) Close(ctx context.Context) error

+ func (self *Runner) Register(command string, handler RunnerHandler, args any, description ...string)

+ func (self *Runner) Run(ctx context.Context) error

+ func (self *Runner) Use(middleware ...func(RunnerHandler) RunnerHandler)

+ type RunnerConfig struct

+ Release string

+ Service string

+ type RunnerHandler func(context.Context, *cli.Context) error

type WorkerConfig

+ Concurrency *int

+ Queues map[string]int

+ StopTimeout *time.Duration

+ StrictPriority *bool

+ TimeZone *time.Location

Dec 29, 2023

Changes in this version

type EnqueuerConfig

+ CacheSSLMode bool

type WorkerConfig

+ CacheSSLMode bool

Dec 29, 2023

Changes in this version

type CacheConfig

+ CacheSSLMode bool

Dec 28, 2023

Changes in this version

type CacheConfig

+ CacheLocalConfig *CacheLocalConfig

+ type CacheLocalConfig struct

+ Size int

+ TTL time.Duration

Sep 14, 2023

Changes in this version

type Observer

+ func (self Observer) TraceTask(ctx context.Context, task *asynq.Task) (context.Context, func())

Feb 19, 2023

Changes in this version

+ var ErrEnqueuerGeneric = NewError("enqueuer failed")

+ var ErrEnqueuerTimedOut = NewError("enqueuer timed out")

+ var ErrWorkerGeneric = NewError("worker failed")

+ var ErrWorkerTimedOut = NewError("worker timed out")

+ type Enqueuer struct

+ func NewEnqueuer(observer Observer, config EnqueuerConfig) *Enqueuer

+ func (self *Enqueuer) Close(ctx context.Context) error

+ func (self *Enqueuer) Enqueue(ctx context.Context, task string, params interface{}, options ...asynq.Option) error

+ type EnqueuerConfig struct

+ CacheDialTimeout *time.Duration

+ CacheHost string

+ CacheMaxConns *int

+ CachePassword string

+ CachePort int

+ CacheReadTimeout *time.Duration

+ CacheWriteTimeout *time.Duration

type Worker

+ func NewWorker(observer Observer, config WorkerConfig) *Worker

+ func (self *Worker) Close(ctx context.Context) error

+ func (self *Worker) Register(task string, handler func(context.Context, *asynq.Task) error)

+ func (self *Worker) Run(ctx context.Context) error

+ func (self *Worker) Schedule(task string, params interface{}, cron string, options ...asynq.Option)

+ func (self *Worker) Use(middleware ...asynq.MiddlewareFunc)

+ type WorkerConfig struct

+ CacheDialTimeout *time.Duration

+ CacheHost string

+ CacheMaxConns *int

+ CachePassword string

+ CachePort int

+ CacheReadTimeout *time.Duration

+ CacheWriteTimeout *time.Duration

+ WorkerConcurrency *int

+ WorkerQueues map[string]int

+ WorkerStopTimeout *time.Duration

+ WorkerStrictPriority *bool

+ WorkerTimeZone *time.Location

Sep 8, 2022

Changes in this version

type Server

+ func (self *Server) Default(middleware ...echo.MiddlewareFunc) *echo.Group

Sep 3, 2022

Changes in this version

type ServerConfig

+ RequestIPExtractor *func(*http.Request) string

Sep 3, 2022

Changes in this version

+ type Environment string

+ var EnvIntegration Environment = "ci"

+ type Level int

Aug 25, 2022

Changes in this version

+ func Env(env string) _environment

+ func Key(key string) _key

+ func Lvl(lvl int) _level

Aug 22, 2022

Changes in this version

+ var EnvDevelopment _environment = "dev"

+ var EnvProduction _environment = "prod"

+ var ErrBinderGeneric = NewError("binder failed")

+ var ErrCacheGeneric = NewError("cache failed")

+ var ErrCacheMiss = NewError("cache key not found")

+ var ErrCacheTimedOut = NewError("cache timed out")

+ var ErrCacheUnhealthy = NewError("cache unhealthy")

+ var ErrDatabaseGeneric = NewError("database failed")

+ var ErrDatabaseIntegrityViolation = NewError("database integrity constraint violation")

+ var ErrDatabaseNoRows = NewError("database no rows in result set")

+ var ErrDatabaseTimedOut = NewError("database timed out")

+ var ErrDatabaseTransactionFailed = NewError("database transaction failed")

+ var ErrDatabaseUnhealthy = NewError("database unhealthy")

+ var ErrDeadlineExceeded = NewError("deadline exceeded")

+ var ErrExceptionHandlerGeneric = NewError("error handler failed")

+ var ErrLocalizerGeneric = NewError("localizer failed")

+ var ErrLoggerGeneric = NewError("logger failed")

+ var ErrLoggerTimedOut = NewError("logger timed out")

+ var ErrMigratorGeneric = NewError("migrator failed")

+ var ErrMigratorTimedOut = NewError("migrator timed out")

+ var ErrObserverGeneric = NewError("observer failed")

+ var ErrObserverTimedOut = NewError("observer timed out")

+ var ErrRendererGeneric = NewError("renderer failed")

+ var ErrSerializerGeneric = NewError("serializer failed")

+ var ErrServerGeneric = NewError("server failed")

+ var ErrServerTimedOut = NewError("server timed out")

+ var ExcClientGeneric = NewException(http.StatusBadRequest, "ERR_CLIENT_GENERIC")

+ var ExcInvalidRequest = NewException(http.StatusBadRequest, "ERR_INVALID_REQUEST")

+ var ExcNotFound = NewException(http.StatusNotFound, "ERR_NOT_FOUND")

+ var ExcRequestTimeout = NewException(http.StatusGatewayTimeout, "ERR_REQUEST_TIMEOUT")

+ var ExcServerGeneric = NewException(http.StatusInternalServerError, "ERR_SERVER_GENERIC")

+ var ExcServerUnavailable = NewException(http.StatusServiceUnavailable, "ERR_SERVER_UNAVAILABLE")

+ var ExcUnauthorized = NewException(http.StatusUnauthorized, "ERR_UNAUTHORIZED")

+ var KeyBase _key = "kit:"

+ var KeyDatabaseTransaction _key = KeyBase + "database:transaction"

+ var KeyLocalizerLocale _key = KeyBase + "localizer:locale"

+ var KeyTraceID _key = KeyBase + "trace:id"

+ var LvlDebug _level = -4

+ var LvlError _level = -1

+ var LvlInfo _level = -3

+ var LvlNone _level

+ var LvlTrace _level = -5

+ var LvlWarn _level = -2

+ var Utils = _utils

+ func NewError(message string) func() *Error

+ func NewException(status int, code string) func() *Exception

+ type API interface

+ type Binder struct

+ func NewBinder(observer Observer, config BinderConfig) *Binder

+ func (self *Binder) Bind(i interface{}, c echo.Context) error

+ type BinderConfig struct

+ type CLI interface

+ type Cache struct

+ func NewCache(ctx context.Context, observer Observer, config CacheConfig) (*Cache, error)

+ func (self *Cache) Close(ctx context.Context) error

+ func (self *Cache) Delete(ctx context.Context, key string) error

+ func (self *Cache) Get(ctx context.Context, key string, dest interface{}) error

+ func (self *Cache) Health(ctx context.Context) error

+ func (self *Cache) Set(ctx context.Context, key string, value interface{}, ttl *time.Duration) error

+ type CacheConfig struct

+ CacheAcquireTimeout *time.Duration

+ CacheDialTimeout *time.Duration

+ CacheHost string

+ CacheMaxConnIdleTime *time.Duration

+ CacheMaxConnLifeTime *time.Duration

+ CacheMaxConns *int

+ CacheMinConns *int

+ CachePassword string

+ CachePort int

+ CacheReadTimeout *time.Duration

+ CacheWriteTimeout *time.Duration

+ RetryConfig *CacheRetryConfig

+ type CacheRetryConfig struct

+ Attempts int

+ InitialDelay time.Duration

+ LimitDelay time.Duration

+ type Command interface

+ type Database struct

+ func NewDatabase(ctx context.Context, observer Observer, config DatabaseConfig) (*Database, error)

+ func (self *Database) Close(ctx context.Context) error

+ func (self *Database) Exec(ctx context.Context, stmt *sqlf.Stmt) (int, error)

+ func (self *Database) Health(ctx context.Context) error

+ func (self *Database) Query(ctx context.Context, stmt *sqlf.Stmt) error

+ func (self *Database) Transaction(ctx context.Context, fn func(ctx context.Context) error) error

+ type DatabaseConfig struct

+ AppName string

+ DatabaseHost string

+ DatabaseMaxConnIdleTime *time.Duration

+ DatabaseMaxConnLifeTime *time.Duration

+ DatabaseMaxConns *int

+ DatabaseMinConns *int

+ DatabaseName string

+ DatabasePassword string

+ DatabasePort int

+ DatabaseSSLMode string

+ DatabaseUser string

+ RetryConfig *DatabaseRetryConfig

+ type DatabaseRetryConfig struct

+ Attempts int

+ InitialDelay time.Duration

+ LimitDelay time.Duration

+ type Entity interface

+ type Error struct

+ func (self *Error) With(message string) *Error

+ func (self *Error) Withf(message string, args ...interface{}) *Error

+ func (self *Error) Wrap(err error) *Error

+ func (self *Error) WrapAs(err error) *Error

+ func (self *Error) WrapAsWithDepth(depth int, err error) *Error

+ func (self *Error) WrapWithDepth(depth int, err error) *Error

+ func (self Error) Error() string

+ func (self Error) Is(err error) bool

+ func (self Error) Unwrap() error

+ type Exception struct

+ func (self *Exception) Cause(err error) *Exception

+ func (self *Exception) CauseAs(err error) *Exception

+ func (self *Exception) Redact()

+ func (self *Exception) With(message string) *Exception

+ func (self *Exception) Withf(message string, args ...interface{}) *Exception

+ func (self Exception) Code() string

+ func (self Exception) Error() string

+ func (self Exception) Is(err error) bool

+ func (self Exception) MarshalJSON() ([]byte, error)

+ func (self Exception) Status() int

+ func (self Exception) Unwrap() error

+ type ExceptionHandler struct

+ func NewExceptionHandler(observer Observer, config ExceptionHandlerConfig) *ExceptionHandler

+ func (self *ExceptionHandler) Handle(err error, ctx echo.Context)

+ type ExceptionHandlerConfig struct

+ Environment _environment

+ type Localizer struct

+ func NewLocalizer(observer Observer, config LocalizerConfig) (*Localizer, error)

+ func (self *Localizer) Refresh() error

+ func (self Localizer) GetLocale(ctx context.Context) language.Tag

+ func (self Localizer) Localize(ctx context.Context, copy string, i ...interface{}) string

+ func (self Localizer) SetLocale(ctx context.Context, locale language.Tag) context.Context

+ type LocalizerConfig struct

+ DefaultLocale language.Tag

+ LocaleExtensions *regexp.Regexp

+ LocalesPath *string

+ type Logger struct

+ func NewLogger(config LoggerConfig) *Logger

+ func (self *Logger) Header() string

+ func (self *Logger) SetHeader(h string)

+ func (self *Logger) SetLevel(l _level)

+ func (self *Logger) SetOutput(w io.Writer)

+ func (self *Logger) SetPrefix(p string)

+ func (self *Logger) SetVerbose(v bool)

+ func (self Logger) Close(ctx context.Context) error

+ func (self Logger) Debug(i ...interface{})

+ func (self Logger) Debugf(format string, i ...interface{})

+ func (self Logger) Error(i ...interface{})

+ func (self Logger) Errorf(format string, i ...interface{})

+ func (self Logger) Fatal(i ...interface{})

+ func (self Logger) Fatalf(format string, i ...interface{})

+ func (self Logger) Flush(ctx context.Context) error

+ func (self Logger) Info(i ...interface{})

+ func (self Logger) Infof(format string, i ...interface{})

+ func (self Logger) Level() _level

+ func (self Logger) Logger() *zerolog.Logger

+ func (self Logger) Output() io.Writer

+ func (self Logger) Panic(i ...interface{})

+ func (self Logger) Panicf(format string, i ...interface{})

+ func (self Logger) Prefix() string

+ func (self Logger) Print(i ...interface{})

+ func (self Logger) Printf(format string, i ...interface{})

+ func (self Logger) Verbose() bool

+ func (self Logger) Warn(i ...interface{})

+ func (self Logger) Warnf(format string, i ...interface{})

+ func (self Logger) WithLevel(level _level, i ...interface{})

+ func (self Logger) WithLevelf(level _level, format string, i ...interface{})

+ type LoggerConfig struct

+ AppName string

+ Level _level

+ SkipFrameCount *int

+ type Middleware interface

+ type Migrator struct

+ func NewMigrator(ctx context.Context, observer Observer, config MigratorConfig) (*Migrator, error)

+ func (self *Migrator) Apply(ctx context.Context, schemaVersion int) error

+ func (self *Migrator) Assert(ctx context.Context, schemaVersion int) error

+ func (self *Migrator) Close(ctx context.Context) error

+ func (self *Migrator) Rollback(ctx context.Context, schemaVersion int) error

+ type MigratorConfig struct

+ DatabaseHost string

+ DatabaseName string

+ DatabasePassword string

+ DatabasePort int

+ DatabaseSSLMode string

+ DatabaseUser string

+ MigrationsPath *string

+ RetryConfig *MigratorRetryConfig

+ type MigratorRetryConfig struct

+ Attempts int

+ InitialDelay time.Duration

+ LimitDelay time.Duration

+ type Model interface

+ type Observer struct

+ func NewObserver(ctx context.Context, config ObserverConfig) (*Observer, error)

+ func (self Observer) Close(ctx context.Context) error

+ func (self Observer) Debug(ctx context.Context, i ...interface{})

+ func (self Observer) Debugf(ctx context.Context, format string, i ...interface{})

+ func (self Observer) Error(ctx context.Context, i ...interface{})

+ func (self Observer) Errorf(ctx context.Context, format string, i ...interface{})

+ func (self Observer) Fatal(ctx context.Context, i ...interface{})

+ func (self Observer) Fatalf(ctx context.Context, format string, i ...interface{})

+ func (self Observer) Flush(ctx context.Context) error

+ func (self Observer) GetTrace(ctx context.Context) xid.ID

+ func (self Observer) Info(ctx context.Context, i ...interface{})

+ func (self Observer) Infof(ctx context.Context, format string, i ...interface{})

+ func (self Observer) Metric()

+ func (self Observer) Panic(ctx context.Context, i ...interface{})

+ func (self Observer) Panicf(ctx context.Context, format string, i ...interface{})

+ func (self Observer) Print(ctx context.Context, i ...interface{})

+ func (self Observer) Printf(ctx context.Context, format string, i ...interface{})

+ func (self Observer) SetTrace(ctx context.Context, traceID xid.ID) context.Context

+ func (self Observer) TraceQuery(ctx context.Context, sql string, args ...interface{}) (context.Context, func())

+ func (self Observer) TraceRequest(ctx context.Context, request *http.Request) (context.Context, func())

+ func (self Observer) TraceSpan(ctx context.Context, name ...string) (context.Context, func())

+ func (self Observer) Warn(ctx context.Context, i ...interface{})

+ func (self Observer) Warnf(ctx context.Context, format string, i ...interface{})

+ func (self Observer) WithLevel(ctx context.Context, level _level, i ...interface{})

+ func (self Observer) WithLevelf(ctx context.Context, level _level, format string, i ...interface{})

+ type ObserverConfig struct

+ AppName string

+ Environment _environment

+ GilkConfig *ObserverGilkConfig

+ Level _level

+ Release string

+ RetryConfig *ObserverRetryConfig

+ SentryConfig *ObserverSentryConfig

+ type ObserverGilkConfig struct

+ Port int

+ type ObserverRetryConfig struct

+ Attempts int

+ InitialDelay time.Duration

+ LimitDelay time.Duration

+ type ObserverSentryConfig struct

+ Dsn string

+ type Payload interface

+ type Renderer struct

+ func NewRenderer(observer Observer, config RendererConfig) (*Renderer, error)

+ func (self *Renderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error

+ func (self *Renderer) RenderBytes(template string, data interface{}) ([]byte, error)

+ func (self *Renderer) RenderString(template string, data interface{}) (string, error)

+ func (self *Renderer) RenderWriter(w io.Writer, template string, data interface{}) error

+ type RendererConfig struct

+ TemplateExtensions *regexp.Regexp

+ TemplatesPath *string

+ type Repository interface

+ type Serializer struct

+ func NewSerializer(observer Observer, config SerializerConfig) *Serializer

+ func (self *Serializer) Deserialize(c echo.Context, i interface{}) error

+ func (self *Serializer) Serialize(c echo.Context, i interface{}, indent string) error

+ type SerializerConfig struct

+ type Server struct

+ func NewServer(observer Observer, serializer Serializer, binder Binder, renderer Renderer, ...) *Server

+ func (self *Server) Close(ctx context.Context) error

+ func (self *Server) Host(host string, middleware ...echo.MiddlewareFunc) *echo.Group

+ func (self *Server) Run() error

+ func (self *Server) Use(middleware ...echo.MiddlewareFunc)

+ type ServerConfig struct

+ AppPort int

+ Environment _environment

+ RequestBodyMaxSize *int

+ RequestFileMaxSize *int

+ RequestHeaderMaxSize *int

+ RequestKeepAliveTimeout *time.Duration

+ RequestReadHeaderTimeout *time.Duration

+ RequestReadTimeout *time.Duration

+ ResponseWriteTimeout *time.Duration

+ type Service interface

+ type Task interface

+ type Usecase interface

+ type View interface

+ type Worker interface