service

type AutofailoverManager interface {
	// returns HealthInfo if the service considers itself overall
	// healthy and error otherwise
	HealthCheck() (*HealthInfo, error)
	// returns nil if the auto failover is safe from the service
	// perspective for the NodeID's passed, and error otherwise
	IsSafe(nodeUUIDs []NodeID) error
}

type BucketConfigParams struct {
	Config string `json:"config"`
	// Skip any heavy-weight validation - just parse the config and add the
	// service's params.
	JustReturnParams bool `json:"justReturnParams"`
}

type BucketConfigValidationError struct {
	Error   string `json:"error"`
	Message string `json:"message"`
}

type BucketConfigValidationSuccess struct {
	RequiresRestart bool   `json:"requiresRestart"`
	Value           any    `json:"value"`
	Visibility      string `json:"visibility"`
}

type BucketConfigurationManager interface {
	ValidateBucketConfig(ValidateBucketConfigParams) (*BucketValidationResult, error)
}

type BucketValidationResult struct {
	// Result should map to the same format given by memcached.
	// Named and included as a sub-field of the result such that we can add
	// to this payload if ever we need to in the future.
	//
	// The mapped type should be either BucketConfigValidationSuccess or
	// BucketConfigValidationError.
	Result map[string]any `json:"validationResult"`
}

type Cancel <-chan struct{}

type CancelTaskReq struct {
	ID  string   `json:"id"`
	Rev Revision `json:"rev,omitempty"`
}

type DefragmentedUtilizationInfo map[string]map[string]interface{}

type DefragmentedUtilizationReply struct {
	Info *DefragmentedUtilizationInfo
}

type GetCurrentTopologyReq struct {
	Rev     Revision `json:"rev,omitempty"`
	Timeout int64    `json:"timeout,omitempty"`
}

type GetTaskListReq struct {
	Rev     Revision `json:"rev,omitempty"`
	Timeout int64    `json:"timeout,omitempty"`
}

type HealthInfo struct {
	// number of the disk failures encountered since the
	// start of the service executable
	DiskFailures int `json:"diskFailures"`
}

type HibernationManager interface {
	PreparePause(params PauseParams) error
	Pause(params PauseParams) error

	PrepareResume(params ResumeParams) error
	Resume(params ResumeParams) error
}

type InfoManager interface {
	GetParams() *map[string]interface{}
}

type Manager interface {
	GetNodeInfo() (*NodeInfo, error)
	Shutdown() error

	GetTaskList(rev Revision, cancel Cancel) (*TaskList, error)
	CancelTask(id string, rev Revision) error

	GetCurrentTopology(rev Revision, cancel Cancel) (*Topology, error)

	PrepareTopologyChange(change TopologyChange) error
	StartTopologyChange(change TopologyChange) error
}

type NodeID string

type NodeInfo struct {
	NodeID   NodeID      `json:"nodeId"`
	Priority Priority    `json:"priority"`
	Opaque   interface{} `json:"opaque"`
}

type PauseParams struct {
	ID                string `json:"id"`
	Bucket            string `json:"bucket"`
	RemotePath        string `json:"remotePath"`
	BlobStorageRegion string `json:"blobStorageRegion"`
	RateLimit         uint64 `json:"rateLimit"`
}

type Priority int64

type RecoveryType string

type ResumeParams struct {
	ID                string `json:"id"`
	Bucket            string `json:"bucket"`
	RemotePath        string `json:"remotePath"`
	BlobStorageRegion string `json:"blobStorageRegion"`
	DryRun            bool   `json:"dryRun"`
	RateLimit         uint64 `json:"rateLimit"`
}

type Revision []byte

type ServerlessManager interface {
	// returns projected utilization stats if the service would
	// be defragmented
	GetDefragmentedUtilization() (*DefragmentedUtilizationInfo, error)
}

type Task struct {
	Rev Revision `json:"rev"`

	ID           string     `json:"id"`
	Type         TaskType   `json:"type"`
	Status       TaskStatus `json:"status"`
	IsCancelable bool       `json:"isCancelable"`

	Progress         float64            `json:"progress"`
	DetailedProgress map[NodeID]float64 `json:"detailedProgress,omitempty"`

	Description  string `json:"description,omitempty"`
	ErrorMessage string `json:"errorMessage,omitempty"`

	Extra map[string]interface{} `json:"extra"`
}

type TaskList struct {
	Rev   Revision `json:"rev"`
	Tasks []Task   `json:"tasks"`
}

type TaskStatus string

type TaskType string

type Topology struct {
	Rev   Revision `json:"rev"`
	Nodes []NodeID `json:"nodes"`

	IsBalanced bool     `json:"isBalanced"`
	Messages   []string `json:"messages,omitempty"`
}

type TopologyChange struct {
	ID                 string   `json:"id"`
	CurrentTopologyRev Revision `json:"currentTopologyRev"`

	Type TopologyChangeType `json:"type"`

	KeepNodes []struct {
		NodeInfo     NodeInfo     `json:"nodeInfo"`
		RecoveryType RecoveryType `json:"recoveryType"`
	} `json:"keepNodes"`

	EjectNodes []NodeInfo `json:"ejectNodes"`
}

type TopologyChangeType string

type ValidateBucketConfigParams struct {
	// Parsed form of BucketConfigParams.Config
	ParsedParams     map[string]string
	JustReturnParams bool
}

type Void *struct{}