utils

Documentation

Overview

Package utils [general utility functions for the db1000n app]

Index

• Variables
• func CheckCountry(countriesToAvoid []string, strictCountryCheck bool) (bool, string)
• func CheckCountryOrFail(cfg *CountryCheckerConfig) string
• func Decode(input interface{}, output interface{}) error
• func Decrypt(cfg []byte) ([]byte, error)
• func GetEncryptionKeys() ([]string, error)
• func GetEnvBoolDefault(key string, defaultValue bool) bool
• func GetEnvDurationDefault(key string, defaultValue time.Duration) time.Duration
• func GetEnvIntDefault(key string, defaultValue int) int
• func GetEnvStringDefault(key, defaultValue string) string
• func IsEncrypted(cfg []byte) bool
• func NonNilDurationOrDefault(d *time.Duration, dflt time.Duration) time.Duration
• func NonNilIntOrDefault(i *int, dflt int) int
• func PanicHandler(logger *zap.Logger)
• func ReportStatistics(traffic int64, clientID string) error
• func Sleep(ctx context.Context, t time.Duration) bool
• func Unmarshal(input []byte, output interface{}, format string) error
• type BackoffConfig
  • func DefaultBackoffConfig() BackoffConfig
• type BackoffController
  • func NewBackoffController(c *BackoffConfig) BackoffController
  • func (c BackoffController) GetTimeout() time.Duration
  • func (c *BackoffController) Increment() *BackoffController
  • func (c *BackoffController) Reset()
• type Counter
  • func (c *Counter) Next() bool
• type CountryCheckerConfig
  • func NewCountryCheckerConfigWithFlags() *CountryCheckerConfig
• type ProxyFunc
  • func GetProxyFunc(proxyURLs string, timeout time.Duration) ProxyFunc

Variables

var EncryptionKeys = `/45pB920B6DFNwCB/n4rYUio3AVMawrdtrFnjTSIzL4=`

EncryptionKeys random 32 byte key encoded into base64 string. Used by default for configs

Functions

func CheckCountry

func CheckCountry(countriesToAvoid []string, strictCountryCheck bool) (bool, string)

CheckCountry checks which country the app is running from and whether it is in the blacklist.

func CheckCountryOrFail

func CheckCountryOrFail(cfg *CountryCheckerConfig) string

CheckCountryOrFail checks the country of client origin by IP and exits the program if it is in the blacklist.

func Decode

func Decode(input interface{}, output interface{}) error

Decode is an alias to a mapstructure.NewDecoder({Squash: true}).Decode()

func Decrypt

func Decrypt(cfg []byte) ([]byte, error)

Decrypt decrypts config using EncryptionKeys

func GetEncryptionKeys

func GetEncryptionKeys() ([]string, error)

GetEncryptionKeys returns list of encryption keys from ENCRYPTION_KEYS env variable name or default value

func GetEnvBoolDefault

func GetEnvBoolDefault(key string, defaultValue bool) bool

GetEnvBoolDefault returns environment variable or default value if no env varible is present

func GetEnvDurationDefault

func GetEnvDurationDefault(key string, defaultValue time.Duration) time.Duration

GetEnvDurationDefault returns environment variable or default value if no env varible is present

func GetEnvIntDefault

func GetEnvIntDefault(key string, defaultValue int) int

GetEnvIntDefault returns environment variable or default value if no env varible is present

func GetEnvStringDefault

func GetEnvStringDefault(key, defaultValue string) string

GetEnvStringDefault returns environment variable or default value if no env varible is present

func IsEncrypted

func IsEncrypted(cfg []byte) bool

IsEncrypted returns true if cfg encrypted with age tool (https://github.com/FiloSottile/age)

func NonNilDurationOrDefault

func NonNilDurationOrDefault(d *time.Duration, dflt time.Duration) time.Duration

func NonNilIntOrDefault

func NonNilIntOrDefault(i *int, dflt int) int

func PanicHandler

func PanicHandler(logger *zap.Logger)

PanicHandler just stub it in the beginning of every major module invocation to prevent single module failure from crashing the whole app

func ReportStatistics

func ReportStatistics(traffic int64, clientID string) error

ReportStatistics sends basic usage events to google analytics

func Sleep

func Sleep(ctx context.Context, t time.Duration) bool

func Unmarshal

func Unmarshal(input []byte, output interface{}, format string) error

Types

type BackoffConfig

type BackoffConfig struct {
	Multiplier int           `mapstructure:"backoff_multiplier"`
	Limit      int           `mapstructure:"backoff_limit"`
	Timeout    time.Duration `mapstructure:"backoff_timeout"`
}

func DefaultBackoffConfig

func DefaultBackoffConfig() BackoffConfig

type BackoffController

type BackoffController struct {
	BackoffConfig
	// contains filtered or unexported fields
}

func NewBackoffController

func NewBackoffController(c *BackoffConfig) BackoffController

func (BackoffController) GetTimeout

func (c BackoffController) GetTimeout() time.Duration

func (*BackoffController) Increment

func (c *BackoffController) Increment() *BackoffController

func (*BackoffController) Reset

func (c *BackoffController) Reset()

type Counter

type Counter struct {
	Count int `mapstructure:"count,omitempty"`
	// contains filtered or unexported fields
}

func (*Counter) Next

func (c *Counter) Next() bool

type CountryCheckerConfig

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

func NewCountryCheckerConfigWithFlags

func NewCountryCheckerConfigWithFlags() *CountryCheckerConfig

NewGlobalConfigWithFlags returns a GlobalConfig initialized with command line flags.

type ProxyFunc

type ProxyFunc func(network, addr string) (net.Conn, error)

func GetProxyFunc

func GetProxyFunc(proxyURLs string, timeout time.Duration) ProxyFunc