server

Documentation

Index

• Constants
• Variables
• type ClientRequest
• type ExecutionController
  • func NewExecutionController(engine hotplex.HotPlexClient, logger *slog.Logger) *ExecutionController
  • func (c *ExecutionController) Execute(ctx context.Context, req ExecutionRequest, cb event.Callback) error
• type ExecutionRequest
• type HealthHandler
  • func NewHealthHandler() *HealthHandler
  • func (h *HealthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HealthResponse
• type HotPlexWSHandler
  • func NewHotPlexWSHandler(engine hotplex.HotPlexClient, logger *slog.Logger, cors *SecurityConfig) *HotPlexWSHandler
  • func (h *HotPlexWSHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type LiveHandler
  • func NewLiveHandler() *LiveHandler
  • func (h *LiveHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type MetricsHandler
  • func NewMetricsHandler() *MetricsHandler
  • func (h *MetricsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type OpenCodeHTTPHandler
  • func NewOpenCodeHTTPHandler(engine hotplex.HotPlexClient, logger *slog.Logger, cors *SecurityConfig) *OpenCodeHTTPHandler
  • func (s *OpenCodeHTTPHandler) RegisterRoutes(r *mux.Router)
• type ReadyHandler
  • func NewReadyHandler(engineReady func() bool) *ReadyHandler
  • func (h *ReadyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type SecurityConfig
  • func NewSecurityConfig(logger *slog.Logger) *SecurityConfig
  • func (c *SecurityConfig) AddAPIKey(key string)
  • func (c *SecurityConfig) AddOrigin(origin string)
  • func (c *SecurityConfig) CheckOrigin() func(r *http.Request) bool
  • func (c *SecurityConfig) IsAPIKeyEnabled() bool
  • func (c *SecurityConfig) ListOrigins() []string
  • func (c *SecurityConfig) RemoveAPIKey(key string)
  • func (c *SecurityConfig) RemoveOrigin(origin string)
• type ServerResponse

Constants

const (
	EnvAllowedOrigins = "HOTPLEX_ALLOWED_ORIGINS"
	EnvAPIKey         = "HOTPLEX_API_KEY"  // Single API key (for simplicity)
	EnvAPIKeys        = "HOTPLEX_API_KEYS" // Multiple API keys (comma-separated)
)

Environment variable names

Variables

var DefaultAllowedOrigins = []string{
	"http://localhost:3000",
	"http://localhost:8080",
	"http://127.0.0.1:3000",
	"http://127.0.0.1:8080",
}

DefaultAllowedOrigins are used when no environment variable is set.

Types

type ClientRequest

type ClientRequest struct {
	RequestID    int    `json:"request_id,omitempty"`   // Optional request ID for request-response correlation
	Type         string `json:"type"`                   // "execute", "stop", "stats", "version"
	SessionID    string `json:"session_id"`             // Provide session_id to hot-multiplex
	Prompt       string `json:"prompt,omitempty"`       // The user input (for "execute")
	Instructions string `json:"instructions,omitempty"` // Per-task instructions (for "execute")
	WorkDir      string `json:"work_dir,omitempty"`     // Working directory for CLI (for "execute")
	Reason       string `json:"reason,omitempty"`       // Reason for stopping (for "stop")
}

ClientRequest represents the JSON payload expected from the WebSocket client.

type ExecutionController

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

ExecutionController orchestrates engine executions for all protocol handlers. It resolves DRY violations by centralizing context timeouts, Config building, and engine invocation.

func NewExecutionController

func NewExecutionController(engine hotplex.HotPlexClient, logger *slog.Logger) *ExecutionController

NewExecutionController creates a new ExecutionController.

func (*ExecutionController) Execute

func (c *ExecutionController) Execute(ctx context.Context, req ExecutionRequest, cb event.Callback) error

Execute orchestrates the engine execution.

type ExecutionRequest

type ExecutionRequest struct {
	SessionID    string
	Prompt       string
	Instructions string
	WorkDir      string
	Timeout      time.Duration
}

ExecutionRequest represents a protocol-agnostic execution request.

type HealthHandler

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

HealthHandler provides HTTP endpoints for health checking and metrics.

func NewHealthHandler

func NewHealthHandler() *HealthHandler

NewHealthHandler creates a new HealthHandler.

func (*HealthHandler) ServeHTTP

func (h *HealthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP handles /health requests.

type HealthResponse

type HealthResponse struct {
	Status    telemetry.HealthStatus `json:"status"`
	Timestamp string                 `json:"timestamp"`
	Uptime    string                 `json:"uptime"`
	Checks    map[string]bool        `json:"checks,omitempty"`
}

HealthResponse represents the health check response.

type HotPlexWSHandler

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

HotPlexWSHandler manages a WebSocket connection to a HotPlex Engine.

func NewHotPlexWSHandler

func NewHotPlexWSHandler(engine hotplex.HotPlexClient, logger *slog.Logger, cors *SecurityConfig) *HotPlexWSHandler

NewHotPlexWSHandler creates a new handler with security configuration.

func (*HotPlexWSHandler) ServeHTTP

func (h *HotPlexWSHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP upgrades the HTTP connection and starts the read loop.

type LiveHandler

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

LiveHandler handles /health/live requests (Kubernetes liveness probe).

func NewLiveHandler

func NewLiveHandler() *LiveHandler

NewLiveHandler creates a new LiveHandler.

func (*LiveHandler) ServeHTTP

func (h *LiveHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type MetricsHandler

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

MetricsHandler handles /metrics requests (Prometheus format).

func NewMetricsHandler

func NewMetricsHandler() *MetricsHandler

NewMetricsHandler creates a new MetricsHandler.

func (*MetricsHandler) ServeHTTP

func (h *MetricsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type OpenCodeHTTPHandler

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

OpenCodeHTTPHandler implements a server compatible with OpenCode's HTTP/SSE protocol.

func NewOpenCodeHTTPHandler

func NewOpenCodeHTTPHandler(engine hotplex.HotPlexClient, logger *slog.Logger, cors *SecurityConfig) *OpenCodeHTTPHandler

NewOpenCodeHTTPHandler creates a new OpenCodeHTTPHandler instance.

func (*OpenCodeHTTPHandler) RegisterRoutes

func (s *OpenCodeHTTPHandler) RegisterRoutes(r *mux.Router)

RegisterRoutes registers the OpenCode compatibility routes to a router.

type ReadyHandler

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

ReadyHandler handles /health/ready requests (Kubernetes readiness probe).

func NewReadyHandler

func NewReadyHandler(engineReady func() bool) *ReadyHandler

NewReadyHandler creates a new ReadyHandler.

func (*ReadyHandler) ServeHTTP

func (h *ReadyHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type SecurityConfig

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

SecurityConfig holds the allowed origins and API key for WebSocket security validation.

func NewSecurityConfig

func NewSecurityConfig(logger *slog.Logger) *SecurityConfig

NewSecurityConfig creates a new SecurityConfig from environment variables. - HOTPLEX_ALLOWED_ORIGINS: Comma-separated list of allowed origins (defaults to localhost) - HOTPLEX_API_KEY: Single API key for authentication - HOTPLEX_API_KEYS: Multiple API keys (comma-separated, takes precedence over HOTPLEX_API_KEY)

func (*SecurityConfig) AddAPIKey

func (c *SecurityConfig) AddAPIKey(key string)

AddAPIKey adds a new API key at runtime.

func (*SecurityConfig) AddOrigin

func (c *SecurityConfig) AddOrigin(origin string)

AddOrigin adds a new allowed origin at runtime.

func (*SecurityConfig) CheckOrigin

func (c *SecurityConfig) CheckOrigin() func(r *http.Request) bool

CheckOrigin returns a function suitable for websocket.Upgrader.CheckOrigin. It validates both Origin header and API key (if enabled).

func (*SecurityConfig) IsAPIKeyEnabled

func (c *SecurityConfig) IsAPIKeyEnabled() bool

IsAPIKeyEnabled returns whether API key authentication is enabled.

func (*SecurityConfig) ListOrigins

func (c *SecurityConfig) ListOrigins() []string

ListOrigins returns a copy of the current allowed origins.

func (*SecurityConfig) RemoveAPIKey

func (c *SecurityConfig) RemoveAPIKey(key string)

RemoveAPIKey removes an API key.

func (*SecurityConfig) RemoveOrigin

func (c *SecurityConfig) RemoveOrigin(origin string)

RemoveOrigin removes an origin from the allowed list.

type ServerResponse

type ServerResponse struct {
	RequestID int    `json:"request_id,omitempty"` // Echo back request_id for correlation
	Event     string `json:"event"`
	Data      any    `json:"data"`
}

ServerResponse represents the JSON payload sent to the WebSocket client.