runtimectx

Documentation

Index

• Constants
• Variables
• func GetMailClient(ctx context.Context) (mail.EmailClient, error)
• func GetNow() time.Time
• func GetOAuthConfig(ctx context.Context) (*config.AuthConfig, error)
• func GetPrivateKey(ctx context.Context) (*rsa.PrivateKey, error)
• func GetRequestHeaders(ctx context.Context) (map[string][]string, error)
• func GetSecret(ctx context.Context, secret string) (string, error)
• func GetSecrets(ctx context.Context) map[string]string
• func GetStorage(ctx context.Context) (storage.Storer, error)
• func HasStorage(ctx context.Context) bool
• func WithEnv(ctx context.Context, env KeelEnv) context.Context
• func WithMailClient(ctx context.Context, client mail.EmailClient) context.Context
• func WithOAuthConfig(ctx context.Context, config *config.AuthConfig) context.Context
• func WithPrivateKey(ctx context.Context, privateKey *rsa.PrivateKey) context.Context
• func WithRequestHeaders(ctx context.Context, headers map[string][]string) context.Context
• func WithSecrets(ctx context.Context, secrets map[string]string) context.Context
• func WithStorage(ctx context.Context, svc storage.Storer) context.Context
• type EnvKeyContextType
• type KeelEnv
  • func GetEnv(ctx context.Context) KeelEnv

Constants

const (
	ContextIdentityField        = "identity"
	ContextIsAuthenticatedField = "isAuthenticated"
	ContextNowField             = "now"
	ContextEnvField             = "env"
	ContextSecretField          = "secret"
)

const ContextTarget string = "ctx"

const (
	SecretContextKey secretContextKey = "secret"
)

Variables

var ContextFieldTypes = map[string]proto.Type{
	ContextIdentityField:        proto.Type_TYPE_MODEL,
	ContextIsAuthenticatedField: proto.Type_TYPE_BOOL,
	ContextNowField:             proto.Type_TYPE_DATETIME,
	ContextEnvField:             proto.Type_TYPE_OBJECT,
	ContextSecretField:          proto.Type_TYPE_SECRET,
}

Functions

func GetMailClient

func GetMailClient(ctx context.Context) (mail.EmailClient, error)

func GetNow

func GetNow() time.Time

func GetOAuthConfig

func GetOAuthConfig(ctx context.Context) (*config.AuthConfig, error)

func GetPrivateKey

func GetPrivateKey(ctx context.Context) (*rsa.PrivateKey, error)

func GetRequestHeaders

func GetRequestHeaders(ctx context.Context) (map[string][]string, error)

func GetSecret

func GetSecret(ctx context.Context, secret string) (string, error)

func GetSecrets

func GetSecrets(ctx context.Context) map[string]string

func GetStorage

func GetStorage(ctx context.Context) (storage.Storer, error)

GetStorage will return the Storer service from the context

func HasStorage

func HasStorage(ctx context.Context) bool

HasStorage checks if the context has a Storer service

func WithEnv

func WithEnv(ctx context.Context, env KeelEnv) context.Context

func WithMailClient

func WithMailClient(ctx context.Context, client mail.EmailClient) context.Context

func WithOAuthConfig

func WithOAuthConfig(ctx context.Context, config *config.AuthConfig) context.Context

func WithPrivateKey

func WithPrivateKey(ctx context.Context, privateKey *rsa.PrivateKey) context.Context

func WithRequestHeaders

func WithRequestHeaders(ctx context.Context, headers map[string][]string) context.Context

func WithSecrets

func WithSecrets(ctx context.Context, secrets map[string]string) context.Context

func WithStorage

func WithStorage(ctx context.Context, svc storage.Storer) context.Context

WithStorage adds the given storage service to the context

Types

type EnvKeyContextType

type EnvKeyContextType string

type KeelEnv

type KeelEnv string

const (
	// The Test environment denotes any Keel environment that isn't production or staging. So this includes the
	// runtime inside of the Keel Test Framework runner, as well as the runtime locally (e.g 'keel run' in the CLI)
	KeelEnvTest       KeelEnv = "test"
	KeelEnvProduction KeelEnv = "production"
)

func GetEnv

func GetEnv(ctx context.Context) KeelEnv