strawberry

type AgentInfo struct {
	StrawberryRoot     ypath.Path
	Hostname           string
	Stage              string
	Proxy              string
	Family             string
	OperationNamespace string
	// RobotUsername is needed for a temporary workaround to add the robot to the operation acl.
	//
	// TODO(dakovalkov): remove after YT-17557
	RobotUsername         string
	DefaultNetworkProject *string
	ClusterURL            string
}

type ClusterInitializer interface {
	// InitializeCluster does all the custom cluster initialization.
	InitializeCluster() error

	// ACONamespace is an identifier for the access control nodes namespace.
	ACONamespace() string
}

type ClusterInitializerFactory = func(l log.Logger, ytc yt.Client, root ypath.Path) ClusterInitializer

type Controller interface {
	// Prepare builds all necessary operation spec fields.
	Prepare(ctx context.Context, oplet *Oplet) (
		spec map[string]any,
		description map[string]any,
		annotation map[string]any,
		err error)

	// Family returns short lowercase_with_underscore identifier which is included to all vanilla
	// operation annotations started by this strawberry controller. This allows efficient operation
	// filtering using YT list_operations API.
	Family() string

	// Root returns path to the cypress directory containing strawberry nodes.
	Root() ypath.Path

	ParseSpeclet(specletYson yson.RawValue) (parsedSpeclet any, err error)

	// UpdateState updates the controller's state.
	// Returns true if the state has been changed and all oplets should be restarted.
	UpdateState() (changed bool, err error)

	// DescribeOptions returns human-readable descriptors for controller-related speclet options.
	// Some options can be missing in the result if they are not intended to be visible through user interfaces.
	//
	// Given speclet should have suitable type for the specific controller.
	// Otherwise, DescribeOptions may panic.
	DescribeOptions(parsedSpeclet any) []OptionGroupDescriptor

	// GetOpBriefAttributes returns map with controller-related speclet options,
	// which can be requested from API.
	//
	// Given speclet should have suitable type for the specific controller.
	// Otherwise, GetOpBriefAttributes may panic.
	GetOpBriefAttributes(parsedSpeclet any) map[string]any
}

type ControllerFactory struct {
	Ctor   func(l log.Logger, ytc yt.Client, root ypath.Path, cluster string, config yson.RawValue) Controller
	Config yson.RawValue
	// TODO(max): extra commands is actually of type []api.CmdDescriptor, but we can't import it here
	// without creating a circular dependency. Come up with a better solution.
	ExtraCommands any
}

type FieldDiff struct {
	OldValue any `yson:"old_value" json:"old_value"`
	NewValue any `yson:"new_value" json:"new_value"`
}

type InfoState struct {
	Error      *string `yson:"error,omitempty"`
	Controller struct {
		Address string `yson:"address"`
	} `yson:"controller"`

	YTOpStartTime  yson.Time `yson:"yt_op_start_time,omitempty"`
	YTOpFinishTime yson.Time `yson:"yt_op_finish_time,omitempty"`
}

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

type OpletBriefInfo struct {
	State                           OpletState           `yson:"state" json:"state"`
	Health                          OpletHealth          `yson:"health" json:"health"`
	HealthReason                    string               `yson:"health_reason" json:"health_reason"`
	SpecletDiff                     map[string]FieldDiff `yson:"speclet_diff,omitempty" json:"speclet_diff,omitempty"`
	YTOperation                     YTOperationBriefInfo `yson:"yt_operation,omitempty" json:"yt_operation,omitempty"`
	Creator                         string               `yson:"creator,omitempty" json:"creator,omitempty"`
	Pool                            string               `yson:"pool,omitempty" json:"pool,omitempty"`
	Stage                           string               `yson:"stage" json:"stage"`
	CreationTime                    *yson.Time           `yson:"creation_time,omitempty" json:"creation_time,omitempty"`
	StrawberryStateModificationTime *yson.Time           `yson:"strawberry_state_modification_time,omitempty" json:"strawberry_state_modification_time,omitempty"`
	SpecletModificationTime         *yson.Time           `yson:"speclet_modification_time,omitempty" json:"speclet_modification_time,omitempty"`
	IncarnationIndex                int                  `yson:"incarnation_index" json:"incarnation_index"`
	CtlAttributes                   map[string]any       `yson:"ctl_attributes" json:"ctl_attributes"`
	Error                           string               `yson:"error,omitempty" json:"error,omitempty"`
}

type OpletHealth string

type OpletOptions struct {
	AgentInfo
	Alias        string
	Controller   Controller
	Logger       log.Logger
	UserClient   yt.Client
	SystemClient yt.Client
}

type OpletState string

type OptionDescriptor struct {
	Title        string     `yson:"title" json:"title"`
	Name         string     `yson:"name" json:"name"`
	Type         OptionType `yson:"type" json:"type"`
	CurrentValue any        `yson:"current_value,omitempty" json:"current_value,omitempty"`
	DefaultValue any        `yson:"default_value,omitempty" json:"default_value,omitempty"`
	MinValue     any        `yson:"min_value,omitempty" json:"min_value,omitempty"`
	MaxValue     any        `yson:"max_value,omitempty" json:"max_value,omitempty"`
	Choices      []any      `yson:"choices,omitempty" json:"choices,omitempty"`
	Description  string     `yson:"description,omitempty" json:"description,omitempty"`
}

type OptionGroupDescriptor struct {
	Title   string             `yson:"title" json:"title"`
	Options []OptionDescriptor `yson:"options" json:"options"`

	// Hidden indicates that the option group consists of non-important or rarely used options
	// and these options should be hidden in UI if possible (e.g. under a cut element).
	Hidden bool `yson:"hidden" json:"hidden"`
}

type OptionType string

type PersistentState struct {
	YTOpID    yt.OperationID    `yson:"yt_operation_id"`
	YTOpState yt.OperationState `yson:"yt_operation_state"`

	IncarnationIndex int `yson:"incarnation_index"`

	// YTOpSpeclet is an unparsed speclet with which current yt operation is started.
	YTOpSpeclet yson.RawValue `yson:"yt_op_strawberry_speclet,omitempty"`
	// YTOpSpecletRevision is a revision of the speclet node with which current yt operation is started.
	YTOpSpecletRevision yt.Revision `yson:"yt_op_speclet_revision,omitempty"`
	// YTOpACL is the last set ACL of the current yt operation.
	YTOpACL []yt.ACE `yson:"yt_op_acl,omitempty"`
	// YTOpPool is the last set pool of the current yt operation.
	YTOpPool *string `yson:"yt_op_pool,omitempty"`

	// SpecletRevision is a revision of the last seen speclet node.
	SpecletRevision yt.Revision `yson:"speclet_revision"`

	// BackoffDuration is a duration during which oplet passes will be skipped after a failed pass.
	// It is increased after every failed pass and is reset after an successful pass.
	BackoffDuration time.Duration `yson:"backoff_duration"`
	// BackoffUntil is a time point until which oplet passes will be skipped due to previously failed passes.
	BackoffUntil time.Time `yson:"backoff_until"`

	// Creator is a user who created the strawberry operation.
	// Creator will automatically gain access to the strawberry operation when the access control object is created.
	Creator string `yson:"creator"`
}

type RestartRequiredOptions struct {
	Stage          *string      `yson:"stage"`
	NetworkProject *string      `yson:"network_project"`
	PreemptionMode *string      `yson:"preemption_mode"`
	LayerPaths     []ypath.Path `yson:"layer_paths"`
}

type Speclet struct {
	RestartRequiredOptions
	Active                 *bool   `yson:"active"`
	Family                 *string `yson:"family"`
	RestartOnSpecletChange *bool   `yson:"restart_on_speclet_change"`
	// MinSpecletRevision is a minimum speclet revision with which an operation does not require a force restart.
	// If the speclet revision of the running yt operation is less than that,
	// it will be restarted despite the RestartOnSpecletChange option.
	MinSpecletRevision yt.Revision `yson:"min_speclet_revision"`

	Pool *string `yson:"pool"`
}

type YTOperationBriefInfo struct {
	ID         yt.OperationID    `yson:"id,omitempty" json:"id,omitempty"`
	URL        string            `yson:"url,omitempty" json:"url,omitempty"`
	State      yt.OperationState `yson:"state,omitempty" json:"state,omitempty"`
	StartTime  *yson.Time        `yson:"start_time,omitempty" json:"start_time,omitempty"`
	FinishTime *yson.Time        `yson:"finish_time,omitempty" json:"finish_time,omitempty"`
}