app

Documentation

Index

• Constants
• Variables
• type State
  • func (s *State) Close() error
  • func (s *State) RandomReplica() *pgxpool.Pool

Constants

const (
	PostgresAppUrlEnvKey = "POSTGRES_APP_URL"
	RepositoryBaseEnvKey = "REPOSITORY_BASE"
	AuthorizationHeader  = "authorization"
	IDHeader             = "x-grokloc-id"
	TokenRequestHeader   = "x-grokloc-token-request" // #nosec G101
	MaxBodySize          = 8192
	APIPath              = "/api/"
)

Variables

var ErrorBody = fmt.Errorf("body malformed or exceeds %v bytes", MaxBodySize)

var ErrorEnvVar = errors.New("missing or malformed environment variable")

var ErrorInadequateAuthorization = errors.New("inadequate authorization provided")

Types

type State

type State struct {
	// Level describes the environment the State is set in
	Level env.Level

	// Logger is the default state logger
	Logger *slog.Logger

	// APIVersion is the expected runtime supported api version
	APIVersion string

	// Master is a pool of conns to the master db
	Master *pgxpool.Pool

	// Replicas is a pool of conns to the replica dbs
	Replicas []*pgxpool.Pool

	// ConnTimeout is a timeout to acquire a db conn
	ConnTimeout time.Duration

	// ExecTimeout is a timeout for executing a db query
	ExecTimeout time.Duration

	// Argon2Config for password hashing
	Argon2Config argon2.Config

	// RepositoryBase is the path where checked out repos are found
	RepositoryBase string

	// SigningKey signs JWTs
	SigningKey []byte

	// VersionKey maps key ids to database encryption keys
	VersionKey *security.VersionKey

	// DefaultRole is the environment role default for models instance
	DefaultRole models.Role

	// Root user
	Root *user.User

	// Root org
	Org *org.Org
}

State contains all references and values that must be available for the duration of an app run.

func (*State) Close

func (s *State) Close() error

Close performs any post-use tasks.

func (*State) RandomReplica

func (s *State) RandomReplica() *pgxpool.Pool

RandomReplica selects a random replica.