internal

Documentation

Index

• Variables
• func BuildAPIURL(subpaths ...string) string
• func NewAppConfig() error
• func NewErrorWithLocf(code models.ErrorCode, loc []string, format string, a ...any) error
• func NewErrorf(code models.ErrorCode, format string, a ...any) error
• func SetupSwaggerUI(url string, specPath, swaggerUIDir string) error
• func WrapErrorWithLocf(orig error, code models.ErrorCode, loc []string, format string, ...) error
• func WrapErrorf(orig error, code models.ErrorCode, format string, a ...any) error
• type AppConfig
• type AppEnv
  • func (e *AppEnv) Decode(value string) error
• type Decoder
• type Error
  • func (e *Error) Cause() error
  • func (e *Error) Code() models.ErrorCode
  • func (e *Error) Error() string
  • func (e *Error) Loc() []string
  • func (e *Error) Unwrap() error
• type OIDCConfig
• type PostgresConfig
• type RedisConfig
• type SuperAdminConfig

Variables

var (
	ProjectNameByID = map[models.ProjectID]models.ProjectName{
		1: models.ProjectNameDemo,
		2: models.ProjectNameDemoTwo,
	}
	ProjectIDByName = map[models.ProjectName]models.ProjectID{
		models.ProjectNameDemo:    1,
		models.ProjectNameDemoTwo: 2,
	}
)

var (
	DemoKanbanStepsNameByID = map[models.KanbanStepID]models.DemoKanbanSteps{
		1: models.DemoKanbanStepsDisabled,
		2: models.DemoKanbanStepsReceived,
		3: models.DemoKanbanStepsUnderReview,
		4: models.DemoKanbanStepsWorkInProgress,
	}
	DemoKanbanStepsIDByName = map[models.DemoKanbanSteps]models.KanbanStepID{
		models.DemoKanbanStepsDisabled:       1,
		models.DemoKanbanStepsReceived:       2,
		models.DemoKanbanStepsUnderReview:    3,
		models.DemoKanbanStepsWorkInProgress: 4,
	}
)

var (
	DemoWorkItemTypesNameByID = map[models.WorkItemTypeID]models.DemoWorkItemTypes{
		1: models.DemoWorkItemTypesType1,
	}
	DemoWorkItemTypesIDByName = map[models.DemoWorkItemTypes]models.WorkItemTypeID{
		models.DemoWorkItemTypesType1: 1,
	}
)

var (
	DemoTwoKanbanStepsNameByID = map[models.KanbanStepID]models.DemoTwoKanbanSteps{
		5: models.DemoTwoKanbanStepsReceived,
	}
	DemoTwoKanbanStepsIDByName = map[models.DemoTwoKanbanSteps]models.KanbanStepID{
		models.DemoTwoKanbanStepsReceived: 5,
	}
)

var (
	DemoTwoWorkItemTypesNameByID = map[models.WorkItemTypeID]models.DemoTwoWorkItemTypes{
		2: models.DemoTwoWorkItemTypesType1,
		3: models.DemoTwoWorkItemTypesType2,
		4: models.DemoTwoWorkItemTypesAnotherType,
	}
	DemoTwoWorkItemTypesIDByName = map[models.DemoTwoWorkItemTypes]models.WorkItemTypeID{
		models.DemoTwoWorkItemTypesType1:       2,
		models.DemoTwoWorkItemTypesType2:       3,
		models.DemoTwoWorkItemTypesAnotherType: 4,
	}
)

var DemoKanbanStepsStepOrderByID = map[models.KanbanStepID]int{
	1: 0,
	2: 1,
	3: 2,
	4: 3,
}

var DemoTwoKanbanStepsStepOrderByID = map[models.KanbanStepID]int{
	5: 1,
}

Functions

func BuildAPIURL

func BuildAPIURL(subpaths ...string) string

BuildAPIURL returns a fully-qualified URL with the given path elements accounting for reverse proxy configuration.

func NewAppConfig

func NewAppConfig() error

NewAppConfig initializes app config from current environment variables. config can be replaced with subsequent calls.

func NewErrorWithLocf

func NewErrorWithLocf(code models.ErrorCode, loc []string, format string, a ...any) error

NewErrorWithLocf instantiates a new error with error location.

func NewErrorf

func NewErrorf(code models.ErrorCode, format string, a ...any) error

NewErrorf instantiates a new error.

func SetupSwaggerUI

func SetupSwaggerUI(url string, specPath, swaggerUIDir string) error

SetupSwaggerUI sets url in the Swagger docs to the endpoint where specPath is served.

func WrapErrorWithLocf

func WrapErrorWithLocf(orig error, code models.ErrorCode, loc []string, format string, a ...interface{}) error

WrapErrorWithLocf accumulates a given path in loc.

func WrapErrorf

func WrapErrorf(orig error, code models.ErrorCode, format string, a ...any) error

WrapErrorf returns a wrapped error.

Types

type AppConfig

type AppConfig struct {
	Postgres   PostgresConfig
	Redis      RedisConfig
	OIDC       OIDCConfig
	SuperAdmin SuperAdminConfig

	Domain                string `env:"DOMAIN"`
	APIPort               string `env:"API_PORT"`
	APIVersion            string `env:"API_VERSION"`
	ReverseProxyAPIPrefix string `env:"REVERSE_PROXY_API_PREFIX"`
	ProjectPrefix         string `env:"PROJECT_PREFIX"`
	AppEnv                AppEnv `env:"APP_ENV"`
	SigningKey            string `env:"SIGNING_KEY"`
	BuildVersion          string `env:"BUILD_VERSION,-"`
	CookieDomain          string `env:"COOKIE_DOMAIN"`
	LoginCookieKey        string `env:"LOGIN_COOKIE_KEY"`

	ScopePolicyPath string `env:"SCOPE_POLICY_PATH"`
	RolePolicyPath  string `env:"ROLE_POLICY_PATH"`
}

AppConfig contains app settings.

var (

	// Config returns the app global config initialized from environment variables.
	// [Read] locks not needed if there are no writes involved. Config is only populated at startup so there won't be any more writes.
	Config *AppConfig
)

type AppEnv

type AppEnv string

const (
	AppEnvDev  AppEnv = "dev"
	AppEnvProd AppEnv = "prod"
	AppEnvCI   AppEnv = "ci"
	AppEnvE2E  AppEnv = "e2e"
)

func (*AppEnv) Decode

func (e *AppEnv) Decode(value string) error

Decode decodes an env var value.

type Decoder

type Decoder interface {
	Decode(value string) error
}

type Error

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

Error represents an error that could be wrapping another error, It includes a code for determining what triggered the error.

func (*Error) Cause

func (e *Error) Cause() error

Cause returns the root error cause in the chain.

func (*Error) Code

func (e *Error) Code() models.ErrorCode

Code returns the code representing this error.

func (*Error) Error

func (e *Error) Error() string

Error returns the message, when wrapping errors the wrapped error is returned.

func (*Error) Loc

func (e *Error) Loc() []string

Loc returns the accumulated error location.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns the wrapped error, if any.

type OIDCConfig

type OIDCConfig struct {
	ClientID     string `env:"OIDC_CLIENT_ID"`
	ClientSecret string `env:"OIDC_CLIENT_SECRET"`
	Issuer       string `env:"OIDC_ISSUER"`
	Scopes       string `env:"OIDC_SCOPES"`
	Domain       string `env:"OIDC_DOMAIN"`
}

type PostgresConfig

type PostgresConfig struct {
	// Port represents the db port to use in the application, depending on setup (dockerized or not).
	Port         int    `env:"DB_PORT"`
	User         string `env:"POSTGRES_USER"`
	Password     string `env:"POSTGRES_PASSWORD"`
	Server       string `env:"POSTGRES_SERVER"`
	DB           string `env:"POSTGRES_DB"`
	TraceEnabled bool   `env:"POSTGRES_TRACE,false"`
}

type RedisConfig

type RedisConfig struct {
	DB   int    `env:"REDIS_DB"`
	Host string `env:"REDIS_HOST"`
}

type SuperAdminConfig

type SuperAdminConfig struct {
	DefaultEmail string `env:"DEFAULT_SUPERADMIN_EMAIL"`
}