servicebase

type FileMode fs.FileMode

type GRPCConfig struct {
	ListenConfig
	DisableMetrics   bool                `json:"disable_metrics"`
	EnableReflection bool                `json:"enable_reflection"`
	Options          []grpc.ServerOption `json:"-"` // TODO: Make this configurable from JSON/command line
	// contains filtered or unexported fields
}

type GetHealthResponse struct {
	Status       HealthStatus                  `json:"status"`
	Message      string                        `json:"message"`
	Dependencies map[string]*GetHealthResponse `json:"dependencies"`
}

type HTTPConfig struct {
	ListenConfig
	PathPrefix        string        `json:"path_prefix,omitempty"`
	DisableXFF        bool          `json:"disable_xff,omitempty"`
	DisableMetrics    bool          `json:"disable_metrics"`
	DisableHealth     bool          `json:"disable_health"`
	ReadHeaderTimeout time.Duration `json:"read_header_timeout"`
	// contains filtered or unexported fields
}

type HTTPHealthResponse struct {
	Status HTTPHealthStatus `json:"status"`
	Notes  []string         `json:"notes,omitempty"`
	Output string           `json:"output,omitempty"`
}

type HTTPHealthStatus string

type HealthCheckable interface {
	GetHealth(ctx context.Context) (*GetHealthResponse, error)
}

type HealthStatus string

type ListenConfig struct {
	Enabled           bool     `json:"enabled"`
	BindAddress       string   `json:"bind_address,omitempty"`
	BindNetwork       string   `json:"bind_network,omitempty"`
	SocketPermissions FileMode `json:"socket_permissions,omitempty"`
	// contains filtered or unexported fields
}

type LogFormat string

type Metrics struct {
	Registry *prometheus.Registry
	// contains filtered or unexported fields
}

type Service interface {
	HealthCheckable

	Close(ctx context.Context) error
}

type ServiceConfig struct {
	LogLevel         slog.Level    `json:"log_level,omitempty"`
	LogFormat        string        `json:"log_format,omitempty"`
	ShutdownTimeout  time.Duration `json:"shutdown_timeout"`
	HTTP             HTTPConfig    `json:"http"`
	GRPC             GRPCConfig    `json:"grpc"`
	DisableRequestID bool          `json:"disable_request_id"`
	// contains filtered or unexported fields
}

type ServiceFactory func(ctx context.Context, params ServiceParameters) (Service, error)

type ServiceParameters struct {
	Logger  *slog.Logger
	Metrics Metrics

	// ServiceRouter is the top-level HTTP router, without the path prefix applied.
	ServiceRouter *mux.Router

	// ApplicationRouter is the application-level HTTP router, with the path prefix applied.
	ApplicationRouter *mux.Router

	// GRPCRegistrar is the GRPC service registrar.
	GRPCRegistrar grpc.ServiceRegistrar
}