pluginhost

type ArtifactRef struct {
	PackageID        string
	Version          string
	ArtifactPath     string
	ArtifactSHA256   string
	EntrypointPath   string
	EntrypointSHA256 string
	ManifestPath     string
	ManifestSHA256   string
	// MigrationIndexSHA256 and Migrations describe the verified migration
	// index of the release; Migrations is empty when it declares no steps.
	MigrationIndexSHA256 string
	Migrations           []MigrationStep
	// Storage is set when the signed manifest declares kernel.storage.v1.
	// Only such releases run their migration index through the kernel's
	// migration ledger when the host starts.
	Storage bool
}

type DispatchInput struct {
	PackageID        string
	Version          string
	Generation       uint64
	RequestID        string
	IdempotencyKey   string
	RouteID          string
	Method           string
	Body             []byte
	PrincipalJSON    []byte
	Metadata         RequestMetadata
	BridgeCapability []byte
	Deadline         time.Time
	// BridgeBody is the body the bridge capability retains for the
	// kernel's legacy handler when the host reads another one: the request
	// as the client sent it, while Body has its node secrets sealed. Nil
	// retains Body.
	BridgeBody []byte
	// SealedRequest names the request's sealed secrets; the capability
	// carries it so that KernelNodeOps resolves them for this request only.
	SealedRequest string
}

type DispatchOutput struct {
	StatusCode  uint32
	Body        []byte
	Headers     []Header
	OperationID string
	FailureCode string
}

type DrainResult struct {
	Drained  bool
	InFlight uint64
}

type Header struct {
	Name  string
	Value string
}

type HostHealth struct {
	Healthy     bool
	LeaseID     string
	DetailsJSON string
}

type HostStats struct {
	PackageID  string
	Version    string
	Generation uint64
	// State is one of the HostState* constants.
	State string
	// Starts counts host processes that became healthy, explicit and
	// watchdog starts alike.
	Starts uint64
	// UnexpectedExits counts host exits not caused by Drain, Stop,
	// replacement, or Shutdown.
	UnexpectedExits uint64
	// Restarts counts watchdog restart attempts, successful or not.
	Restarts uint64
	// Failures counts how often the restart budget was exhausted and the
	// host was marked failed.
	Failures uint64
	// HealthDetailsJSON is the details document of the host's last successful
	// Health call made by PollHealth, and HealthCheckedAt its time.
	HealthDetailsJSON string
	HealthCheckedAt   time.Time
}

type HostStatsProvider interface {
	Stats() []HostStats
}

type Manager interface {
	Start(context.Context, ArtifactRef, uint64) error
	Dispatch(context.Context, DispatchInput) (DispatchOutput, error)
	Health(context.Context, string, string, uint64) (HostHealth, error)
	Drain(context.Context, string, string, uint64, time.Time) error
	Stop(context.Context, string, string, uint64) error
	Rollback(context.Context, string, string, uint64) error
}

type ManagerConfig struct {
	RuntimeDir     string
	StartupTimeout time.Duration
	BridgeFactory  packagebridge.SessionFactory
	// MaxResponseBytes is plugins.control_host_max_response_bytes. It is
	// passed to hosts as ANIX_CONTROL_HOST_MAX_RESPONSE_BYTES and bounds the
	// kernel client's receive size. Zero selects the 1 MiB default.
	MaxResponseBytes int64
	// PackageEnvironment adds "NAME=value" entries to one package's local
	// host environment, for secrets that package alone needs (the identity
	// key-encryption key). Hosts otherwise inherit nothing from the kernel.
	PackageEnvironment map[string][]string
}

type MigrationCheckpointRecorder func(context.Context, MigrationOutput) error

type MigrationInput struct {
	PackageID   string
	Version     string
	MigrationID string
	Checkpoint  string
	Generation  uint64
	// BridgeCapability is minted only by Supervisor and is never caller-owned.
	BridgeCapability []byte
	Deadline         time.Time
}

type MigrationManager interface {
	Migrate(context.Context, MigrationInput, MigrationCheckpointRecorder) (MigrationOutput, error)
}

type MigrationOutput struct {
	Checkpoint       string
	ValidationDigest string
	Complete         bool
	FailureCode      string
	HealthLeaseID    string
	HealthGeneration uint64
}

type MigrationStep struct {
	ID     string
	Path   string
	SHA256 string
}

type RemoteConfig struct {
	Instances RemoteInstances
	// TLS is the kernel's client identity for dialing modules.
	TLS     moduletls.Source
	Cluster string
	// IsRemote reports whether a package's installation runs remotely.
	IsRemote func(ctx context.Context, packageID string) (bool, error)
	// BindTimeout bounds how long Start waits for a healthy instance.
	BindTimeout time.Duration
}

type RemoteInstances interface {
	Instances(packageID string, generation uint64) []packagebridge.BoundInstance
}

type RequestMetadata struct {
	Path                             string              `json:"path,omitempty"`
	Query                            map[string][]string `json:"query,omitempty"`
	Headers                          map[string][]string `json:"headers,omitempty"`
	PathParams                       map[string]string   `json:"path_params,omitempty"`
	ClientIP                         string              `json:"client_ip,omitempty"`
	UserAgent                        string              `json:"user_agent,omitempty"`
	NodeID                           uint                `json:"node_id,omitempty"`
	TrustedAgentWebSocketAuth        bool                `json:"trusted_agent_websocket_auth,omitempty"`
	TrustedAgentWebSocketForwardNode bool                `json:"trusted_agent_websocket_forward_node,omitempty"`
	// Host and TLS describe the original request address as
	// internal/requestorigin resolves it: the Host header and whether the
	// connection was TLS, or X-Forwarded-Host/Proto when the peer is a
	// trusted reverse proxy (server.trusted_proxies). Host is kept only when
	// it is a plain host[:port] (validPackageRequestHost). They are never request metadata JSON
	// keys, because hosts built with the v4.0.0 SDK reject unknown keys. The
	// kernel's bridge snapshot carries them as "host" and "tls", and package
	// hosts receive them as the DispatchRequest and WebSocketOpen fields
	// request_host and request_scheme, which older hosts skip.
	Host string `json:"-"`
	TLS  bool   `json:"-"`
}

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

type WebSocketClose struct {
	Code   uint32
	Reason string
}

type WebSocketFrame struct {
	Data  []byte
	Close *WebSocketClose
}

type WebSocketInput struct {
	PackageID        string
	Version          string
	Generation       uint64
	RouteID          string
	PrincipalJSON    []byte
	Metadata         RequestMetadata
	RequestID        string
	IdempotencyKey   string
	BridgeCapability []byte
	Deadline         time.Time
}

type WebSocketManager interface {
	OpenWebSocket(context.Context, WebSocketInput) (*WebSocketRelay, error)
}

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