xctx

Documentation

Overview

Package xctx provides typed context helpers for request-scoped execution metadata. Context values are for cancellation, deadlines, and request metadata; application state should remain in explicit action parameters.

Index

• Variables
• func AddTrace(ctx context.Context, event string)
• func ClientIPFrom(ctx context.Context) string
• func CloneForAsync(ctx context.Context) context.Context
• func EndpointFrom(ctx context.Context) string
• func FeaturesFrom(ctx context.Context) []string
• func FromClaims(scope *RequestScope, claims map[string]any)
• func HasAnyRole(ctx context.Context, allowed ...string) bool
• func HasFeature(ctx context.Context, feature string) bool
• func HasPermission(ctx context.Context, perm string) bool
• func HasRole(ctx context.Context, required string) bool
• func PermissionsFrom(ctx context.Context) []string
• func RequestIDFrom(ctx context.Context) string
• func TenantIDFrom(ctx context.Context) string
• func TraceIDFrom(ctx context.Context) string
• func UserIDFrom(ctx context.Context) string
• func WithClientIP(ctx context.Context, ip string) context.Context
• func WithEndpoint(ctx context.Context, endpoint string) context.Context
• func WithEventPublisher(ctx context.Context, pub EventPublisher) context.Context
• func WithFeatures(ctx context.Context, features []string) context.Context
• func WithPermissions(ctx context.Context, perms []string) context.Context
• func WithRequestID(ctx context.Context, id string) context.Context
• func WithRoles(ctx context.Context, roles []string) context.Context
• func WithScope(ctx context.Context, s *RequestScope) context.Context
• func WithTenantID(ctx context.Context, id string) context.Context
• func WithTraceID(ctx context.Context, id string) context.Context
• func WithUserID(ctx context.Context, id string) context.Context
• type EventPublisher
  • func EventPublisherFrom(ctx context.Context) (EventPublisher, bool)
• type Key
  • func NewKey[T any](name string) Key[T]
  • func (k Key[T]) From(ctx context.Context) (T, bool)
  • func (k Key[T]) MustFrom(ctx context.Context) T
  • func (k Key[T]) With(ctx context.Context, val T) context.Context
• type RequestScope
  • func NewScope(parent context.Context) (context.Context, *RequestScope, func())
  • func ScopeFrom(ctx context.Context) *RequestScope
  • func (s *RequestScope) Reset()

Variables

var TenantDB = NewKey[any]("tenant_db")

TenantDB is the context key for the active tenant's DB connection or transaction handle.

Functions

func AddTrace

func AddTrace(ctx context.Context, event string)

func ClientIPFrom

func ClientIPFrom(ctx context.Context) string

func CloneForAsync

func CloneForAsync(ctx context.Context) context.Context

func EndpointFrom

func EndpointFrom(ctx context.Context) string

func FeaturesFrom

func FeaturesFrom(ctx context.Context) []string

func FromClaims

func FromClaims(scope *RequestScope, claims map[string]any)

func HasAnyRole

func HasAnyRole(ctx context.Context, allowed ...string) bool

func HasFeature

func HasFeature(ctx context.Context, feature string) bool

func HasPermission

func HasPermission(ctx context.Context, perm string) bool

func HasRole

func HasRole(ctx context.Context, required string) bool

func PermissionsFrom

func PermissionsFrom(ctx context.Context) []string

func RequestIDFrom

func RequestIDFrom(ctx context.Context) string

func TenantIDFrom

func TenantIDFrom(ctx context.Context) string

func TraceIDFrom

func TraceIDFrom(ctx context.Context) string

func UserIDFrom

func UserIDFrom(ctx context.Context) string

func WithClientIP

func WithClientIP(ctx context.Context, ip string) context.Context

func WithEndpoint

func WithEndpoint(ctx context.Context, endpoint string) context.Context

func WithEventPublisher

func WithEventPublisher(ctx context.Context, pub EventPublisher) context.Context

WithEventPublisher injects an event bus or outbox publisher into the context.

func WithFeatures

func WithFeatures(ctx context.Context, features []string) context.Context

func WithPermissions

func WithPermissions(ctx context.Context, perms []string) context.Context

func WithRequestID

func WithRequestID(ctx context.Context, id string) context.Context

func WithRoles

func WithRoles(ctx context.Context, roles []string) context.Context

func WithScope

func WithScope(ctx context.Context, s *RequestScope) context.Context

func WithTenantID

func WithTenantID(ctx context.Context, id string) context.Context

func WithTraceID

func WithTraceID(ctx context.Context, id string) context.Context

func WithUserID

func WithUserID(ctx context.Context, id string) context.Context

Types

type EventPublisher

type EventPublisher interface {
	PublishEvent(ctx context.Context, subject string, payload any) error
}

EventPublisher defines the contract for transactional or in-memory event publishing.

func EventPublisherFrom

func EventPublisherFrom(ctx context.Context) (EventPublisher, bool)

EventPublisherFrom retrieves the event publisher from context.

type Key

type Key[T any] struct {
	// contains filtered or unexported fields
}

Key is a typed context key.

func NewKey

func NewKey[T any](name string) Key[T]

func (Key[T]) From

func (k Key[T]) From(ctx context.Context) (T, bool)

func (Key[T]) MustFrom

func (k Key[T]) MustFrom(ctx context.Context) T

func (Key[T]) With

func (k Key[T]) With(ctx context.Context, val T) context.Context

type RequestScope

type RequestScope struct {
	RequestID   string
	Endpoint    string
	UserID      string
	TenantID    string
	TraceID     string
	Role        string
	Roles       []string
	Permissions []string
	Features    []string
	ClientIP    string
	TraceEvents []string
}

RequestScope holds all cross-cutting data for a single request.

func NewScope

func NewScope(parent context.Context) (context.Context, *RequestScope, func())

func ScopeFrom

func ScopeFrom(ctx context.Context) *RequestScope

func (*RequestScope) Reset

func (s *RequestScope) Reset()