fairy

README

Fairy

Fairy contains several general tools for easier and simpler development.

• Swappable cache
  • Redis
  • In-memory
  • Memcached
• Swappable pubsub
  • Redis
  • RabbitMQ
  • NSQ
• Struct modification and validation
• Logging & http middleware logging
• Error stack tracing

All these tools are simplified version of the original ones and for general use. Your case may need a more complex one but I hope these tools can help you or at least become a reference for your own tools.

Good luck.

---

Installation

go get github.com/rl404/fairy

Usage

Please go to the documentation or example folder.

License

MIT License

Copyright (c) 2021 Axel

Documentation

Overview

Package fairy contains several general tools for easier and simpler development.

Index

• Variables
• func HandlerFuncWithLog(logger Logger, next http.HandlerFunc) http.HandlerFunc
• func HandlerWithLog(logger Logger, next http.Handler) http.Handler
• func MiddlewareWithLog(logger Logger) func(http.Handler) http.Handler
• type CacheType
• type Cacher
  • func NewCache(cacheType CacheType, address string, password string, ...) (Cacher, error)
• type Channel
• type ErrStacker
  • func NewErrStacker() ErrStacker
• type LogLevel
• type LogType
• type Logger
  • func NewLog(logType LogType, level LogLevel, jsonFormat bool, color bool) (Logger, error)
• type PubSub
  • func NewPubSub(pubsubType PubsubType, address string, password string) (PubSub, error)
• type PubsubType
• type Validator
  • func NewValidator(mod bool) Validator

Variables

var ErrInvalidCacheType = errors.New("invalid cache type")

ErrInvalidCacheType is error for invalid cache type.

var ErrInvalidLogType = errors.New("invalid log type")

ErrInvalidLogType is error for invalid log type.

var ErrInvalidPubsubType = errors.New("invalid pubsub type")

ErrInvalidPubsubType is error for invalid pubsub type.

Functions

func HandlerFuncWithLog

func HandlerFuncWithLog(logger Logger, next http.HandlerFunc) http.HandlerFunc

HandlerFuncWithLog is http handler func with log.

func HandlerWithLog

func HandlerWithLog(logger Logger, next http.Handler) http.Handler

HandlerWithLog is http handler with log. Also includes error stack tracing feature if you use it.

func MiddlewareWithLog

func MiddlewareWithLog(logger Logger) func(http.Handler) http.Handler

MiddlewareWithLog is http middleware that will log the request and response.

Types

type CacheType

type CacheType int8

CacheType is type for cache.

const (
	NoCache CacheType = iota
	InMemory
	RedisCache
	Memcache
)

Available types for cache.

type Cacher

type Cacher interface {
	// Get data from cache. The returned value will be
	// assigned to param `data`. Param `data` should
	// be a pointer just like when using json.Unmarshal.
	Get(key string, data interface{}) error
	// Save data to cache. Set and Get should be using
	// the same encoding method. For example, json.Marshal
	// for Set and json.Unmarshal for Get.
	Set(key string, data interface{}) error
	// Delete data from cache.
	Delete(key string) error
	// Close cache connection.
	Close() error
}

Cacher is caching interface.

See usage example in example folder.

func NewCache

func NewCache(cacheType CacheType, address string, password string, expiredTime time.Duration) (Cacher, error)

NewCache to create new cache client depends on the type.

type Channel

type Channel interface {
	// Read and process incoming message. Param `data` should
	// be a pointer just like when using json.Unmarshal.
	Read(data interface{}) (<-chan interface{}, <-chan error)
	// Close subscription.
	Close() error
}

Channel is channel interface.

See usage example in example folder.

type ErrStacker

type ErrStacker interface {
	// Init the context so it can be used for stack.
	Init(ctx context.Context) context.Context
	// Wrap the error and put it in the error stack.
	Wrap(ctx context.Context, err error, errs ...error) error
	// Get the error stack.
	Get(ctx context.Context) interface{}
}

ErrStacker is error stack interface.

See usage example in example folder.

func NewErrStacker

func NewErrStacker() ErrStacker

NewErrStacker to create new error stack.

type LogLevel

type LogLevel int8

LogLevel is level of log that will be printed. Will print level that is higher than your chosen one.

const (
	TraceLevel LogLevel = iota - 1
	DebugLevel
	InfoLevel
	WarnLevel
	ErrorLevel
	FatalLevel
	PanicLevel
	Disabled
)

Available log level.

type LogType

type LogType int8

LogType is type for logging library.

const (
	NoLog LogType = iota
	BuiltIn
	Zerolog
	Logrus
)

Available types for logging.

type Logger

type Logger interface {
	Trace(format string, args ...interface{})
	Debug(format string, args ...interface{})
	Info(format string, args ...interface{})
	Warn(format string, args ...interface{})
	Error(format string, args ...interface{})
	Fatal(format string, args ...interface{})
	Panic(format string, args ...interface{})

	// General log with key value.
	Log(fields map[string]interface{})
}

Logger is logging interface.

See usage example in example folder.

func NewLog

func NewLog(logType LogType, level LogLevel, jsonFormat bool, color bool) (Logger, error)

NewLog to create new log client depends on the type. Color is not working in json format.

type PubSub

type PubSub interface {
	// Publish message to specific topic/channel.
	// Data will be encoded first before publishing.
	Publish(topic string, data interface{}) error
	// Subscribe to specific topic/channel.
	Subscribe(topic string) (interface{}, error)
	// Close pubsub client connection.
	Close() error
}

PubSub is pubsub interface.

For subscribe function, you have to convert the return type to Channel.

See usage example in example folder.

func NewPubSub

func NewPubSub(pubsubType PubsubType, address string, password string) (PubSub, error)

NewPubSub to create new pubsub client depends on the type.

type PubsubType

type PubsubType int8

PubsubType is type for pubsub.

const (
	RedisPubsub PubsubType = iota + 1
	RabbitMQ
	NSQ
)

Available types for pubsub.

type Validator

type Validator interface {
	// Register custom modifier.
	RegisterModifier(name string, fn func(in string) (out string)) error
	// Modify struct field value according to modifier tag.
	// Param `data` should be a pointer.
	Modify(data interface{}) error

	// Register custom validator.
	RegisterValidator(name string, fn func(value interface{}, param ...string) (ok bool)) error
	// Register error message handler.
	RegisterValidatorError(name string, fn func(field string, param ...string) (msg error)) error
	// Validate struct field value according to validator tag.
	// Param `data` should be a pointer.
	Validate(data interface{}) error
}

Validator is validating interface.

See usage example in example folder.

func NewValidator

func NewValidator(mod bool) Validator

NewValidator to create new validator. Pass true if you want to modify the data automatically before validate.