workflows

type Client struct {
	Jobs     JobClient
	Clusters ClusterClient
	// contains filtered or unexported fields
}

type ClientOption func(*clientConfig)

type Cluster struct {
	// Slug is the unique identifier of the cluster within the namespace.
	Slug string
	// Name is the label name of the cluster.
	Name string
	// Deletable is true when the cluster can be deleted.
	Deletable bool
}

type ClusterClient interface {
	// Create creates a new cluster with the given name.
	Create(ctx context.Context, name string) (*Cluster, error)

	// Get returns a cluster by its slug.
	Get(ctx context.Context, slug string) (*Cluster, error)

	// Delete deletes a cluster by its slug.
	Delete(ctx context.Context, slug string) error

	// List returns a list of all available clusters.
	List(ctx context.Context) ([]*Cluster, error)
}

type ExecutableTask interface {
	Execute(ctx context.Context) error
}

type ExplicitlyIdentifiableTask interface {
	Identifier() TaskIdentifier
}

type Job struct {
	// ID is the unique identifier of the job.
	ID uuid.UUID
	// Name is the name of the job.
	Name string
	// Canceled indicates whether the job has been canceled.
	Canceled bool
	// State is the current state of the job.
	State JobState
	// SubmittedAt is the time the job was submitted.
	SubmittedAt time.Time
	// StartedAt is the time the job started running.
	StartedAt time.Time
	// TaskSummaries is the task summaries of the job.
	TaskSummaries []*TaskSummary
	// AutomationID is the ID of the automation that submitted the job.
	AutomationID uuid.UUID
	// Progress is a list of progress indicators for the job.
	Progress []*ProgressIndicator
}

type JobClient interface {
	// Submit submits a job to a cluster.
	//
	// Options:
	//   - job.WithMaxRetries: sets the maximum number of times a job can be automatically retried. Defaults to 0.
	//   - job.WithClusterSlug: sets the cluster slug of the cluster where the job will be executed. Defaults to the default cluster.
	//
	// Documentation: https://docs.tilebox.com/workflows/concepts/jobs#submission
	Submit(ctx context.Context, jobName string, tasks []Task, options ...job.SubmitOption) (*Job, error)

	// Get returns a job by its ID.
	Get(ctx context.Context, jobID uuid.UUID) (*Job, error)

	// Retry retries a job.
	//
	// Returns the number of rescheduled tasks.
	//
	// Documentation: https://docs.tilebox.com/workflows/concepts/jobs#retry-handling
	Retry(ctx context.Context, jobID uuid.UUID) (int64, error)

	// Cancel cancels a job.
	//
	// Documentation: https://docs.tilebox.com/workflows/concepts/jobs#cancellation
	Cancel(ctx context.Context, jobID uuid.UUID) error

	// Query returns a list of all jobs within the given interval.
	//
	// Options:
	//   - job.WithTemporalExtent: specifies the time or ID interval for which jobs should be queried (Required)
	//   - job.WithAutomationID: specifies the automation ID to filter jobs by. Only jobs submitted by the specified
	//  automation will be returned. (Optional)
	//
	// The jobs are lazily loaded and returned as a sequence.
	// The output sequence can be transformed into a slice using Collect.
	Query(ctx context.Context, options ...job.QueryOption) iter.Seq2[*Job, error]
}

type JobService interface {
	SubmitJob(ctx context.Context, req *workflowsv1.SubmitJobRequest) (*workflowsv1.Job, error)
	GetJob(ctx context.Context, jobID uuid.UUID) (*workflowsv1.Job, error)
	RetryJob(ctx context.Context, jobID uuid.UUID) (*workflowsv1.RetryJobResponse, error)
	CancelJob(ctx context.Context, jobID uuid.UUID) error
	QueryJobs(ctx context.Context, filters *workflowsv1.QueryFilters, page *tileboxv1.Pagination) (*workflowsv1.QueryJobsResponse, error)
}

type JobState int32

type ProgressIndicator struct {
	Label string
	Total uint64
	Done  uint64
}

type ProgressTracker interface {
	// Add a given amount of total work to be done to the progress indicator.
	Add(context.Context, uint64) error

	// Done marks a given amount of work as done.
	Done(context.Context, uint64) error
}

type Task interface{}

type TaskIdentifier interface {
	Name() string
	Version() string
	Display() string
}

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

type TaskService interface {
	NextTask(ctx context.Context, computedTask *workflowsv1.ComputedTask, nextTaskToRun *workflowsv1.NextTaskToRun) (*workflowsv1.NextTaskResponse, error)
	TaskFailed(ctx context.Context, taskID uuid.UUID, display string, cancelJob bool, progressUpdates []*workflowsv1.Progress) (*workflowsv1.TaskStateResponse, error)
	ExtendTaskLease(ctx context.Context, taskID uuid.UUID, requestedLease time.Duration) (*workflowsv1.TaskLease, error)
}

type TaskState int32

type TaskSummary struct {
	// ID is the unique identifier of the task.
	ID uuid.UUID
	// Display is the label message of the task.
	Display string
	// State is the state of the task.
	State TaskState
	// ParentID is the ID of the parent task.
	ParentID uuid.UUID
	// StartedAt is the time the task started.
	StartedAt time.Time
	// StoppedAt is the time the task stopped.
	StoppedAt time.Time
}

type WorkflowService interface {
	CreateCluster(ctx context.Context, name string) (*workflowsv1.Cluster, error)
	GetCluster(ctx context.Context, slug string) (*workflowsv1.Cluster, error)
	DeleteCluster(ctx context.Context, slug string) error
	ListClusters(ctx context.Context) (*workflowsv1.ListClustersResponse, error)
}