backend

Documentation

Index

• func RequestIDFromCtx(ctx context.Context) (string, bool)
• func RequestLogger(l *logrus.Logger, debugPaths ...string) func(http.Handler) http.Handler
• func SecurityHeaders() func(http.Handler) http.Handler
• func UserIDFromCtx(ctx context.Context) (string, bool)
• func WithUserID(ctx context.Context, uid string) context.Context
• type Config
• type MonitoringConfig
• type PublicCat
  • func ToPublicCat(c storage.Cat) PublicCat
• type PublicRecord
  • func ToPublicRecord(r storage.Record) PublicRecord
• type Server
  • func NewServer(cfg Config) (*Server, error)
  • func (s *Server) AuditMiddleware(next http.Handler) http.Handler
  • func (s *Server) JWTAuth(next http.Handler) http.Handler
  • func (s *Server) LogAudit(r *http.Request, targetType, targetID, status, delta string)
  • func (s *Server) RequireAuth(next http.Handler) http.Handler

Functions

func RequestIDFromCtx

func RequestIDFromCtx(ctx context.Context) (string, bool)

func RequestLogger

func RequestLogger(l *logrus.Logger, debugPaths ...string) func(http.Handler) http.Handler

RequestLogger logs basic request info.

func SecurityHeaders

func SecurityHeaders() func(http.Handler) http.Handler

SecurityHeaders adds common security-related headers to all responses.

func UserIDFromCtx

func UserIDFromCtx(ctx context.Context) (string, bool)

func WithUserID

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

Types

type Config

type Config struct {
	Store           *storage.Store
	Logger          *logrus.Logger
	Version         string
	CORSAllowOrigin []string
	Monitoring      MonitoringConfig

	JWTSecret  string
	AccessTTL  time.Duration
	RefreshTTL time.Duration

	OAuth        oauth.Config
	BotAPIKey    string
	SessionStore sessions.SessionStore

	DevLoginEnabled bool
	SkipWorkers     bool
}

type MonitoringConfig

type MonitoringConfig struct {
	MetricsEndpoint string
	HealthzEndpoint string
}

type PublicCat

type PublicCat struct {
	ID            string                `json:"id"`
	Name          string                `json:"name"`
	Description   string                `json:"description,omitempty"`
	Condition     int                   `json:"condition"`
	NeedAttention bool                  `json:"need_attention"`
	Tags          []storage.Tag         `json:"tags,omitempty"`
	LastSeen      *time.Time            `json:"last_seen,omitempty"`
	Locations     []storage.CatLocation `json:"locations,omitempty"`
	Images        []storage.Image       `json:"images,omitempty"`
	Likes         int64                 `json:"likes"`
	Liked         bool                  `json:"liked"`
	CreatedAt     time.Time             `json:"created_at"`
	Records       any                   `json:"records,omitempty"`
}

func ToPublicCat

func ToPublicCat(c storage.Cat) PublicCat

type PublicRecord

type PublicRecord struct {
	ID        string     `json:"id"`
	Type      string     `json:"type"`
	Timestamp time.Time  `json:"timestamp"`
	DoneAt    *time.Time `json:"done_at,omitempty"`
}

func ToPublicRecord

func ToPublicRecord(r storage.Record) PublicRecord

type Server

type Server struct {
	Router chi.Router
	// contains filtered or unexported fields
}

func NewServer

func NewServer(cfg Config) (*Server, error)

func (*Server) AuditMiddleware

func (s *Server) AuditMiddleware(next http.Handler) http.Handler

AuditMiddleware logs mutations to the AuditLog table.

func (*Server) JWTAuth

func (s *Server) JWTAuth(next http.Handler) http.Handler

func (*Server) LogAudit

func (s *Server) LogAudit(r *http.Request, targetType, targetID, status, delta string)

func (*Server) RequireAuth

func (s *Server) RequireAuth(next http.Handler) http.Handler

RequireAuth middleware ensures user is authenticated.