cloud/tasks/scheduler.go - main - githubmirror/nbs

cloud/tasks/scheduler.go
128 строк4 KB
Sergei
issue-1559: [Disk Manager] Add GetTaskError method to scheduler, verify filesystem scrubbing (#5685)
09 апр 2026, 12:53
09 апр 2026, 12:538b801f5
package tasks

import (
	"context"
	"time"

	"github.com/golang/protobuf/proto"
	"github.com/ydb-platform/nbs/cloud/tasks/operation"
)

////////////////////////////////////////////////////////////////////////////////

type TaskSchedule struct {
	ScheduleInterval time.Duration
	MaxTasksInflight int

	// Crontab params.
	// Schedules task every day - only 'hour' and 'min' are supported.
	// Hours and minutes are specified in UTC.
	UseCrontab bool // If set, ScheduleInterval is ignored.
	Hour       int  // (0 - 23)
	Min        int  // (0 - 59)
}

////////////////////////////////////////////////////////////////////////////////

type Scheduler interface {
	// Requires "idempotency-key" header in ctx metadata.
	// Returns id of the task.
	ScheduleTask(
		ctx context.Context,
		taskType string,
		description string,
		request proto.Message,
	) (string, error)

	// Requires "idempotency-key" header in ctx metadata.
	// The task will be executed by a worker in certain zone.
	// Returns id of the task.
	ScheduleZonalTask(
		ctx context.Context,
		taskType string,
		description string,
		zoneID string,
		request proto.Message,
	) (string, error)

	// Requires "idempotency-key" header in ctx metadata.
	// Returns id of the task.
	//
	// Such task cannot be cancelled via CancelTask, it also ignores
	// NonRetriableError and does not enforce a retry limit for RetriableError.
	//
	// A task can end in only two ways:
	// * If it encounters a NonCancellableError, it finishes with a "cancelled"
	//   status without invoking any cancel function.
	// * Otherwise, it completes successfully.
	//
	// This behaviour is useful for cleanup tasks
	// (e.g., DeleteDisk, DeleteFilesystem)
	//
	// If zoneID is empty, the task is not zonal
	ScheduleNonCancellableTask(
		ctx context.Context,
		taskType string,
		description string,
		zoneID string,
		request proto.Message,
	) (string, error)

	ScheduleRegularTasks(
		ctx context.Context,
		taskType string,
		schedule TaskSchedule,
	)

	// Marks task as cancelled.
	// Returns true if it's already cancelling (or cancelled).
	// Returns false if it has successfully finished.
	CancelTask(ctx context.Context, taskID string) (bool, error)

	// Interrupts execution if waited task has no result yet.
	// Execution will be resumed when result is ready.
	// Returns task response.
	// Returns error if task is cancelling.
	WaitTask(
		ctx context.Context,
		execCtx ExecutionContext,
		taskID string,
	) (proto.Message, error)

	// Synchronously waits until any of the given tasks is finished.
	// Returns finished tasks ids.
	// Returns error if any of the given tasks finishes with error.
	WaitAnyTasks(ctx context.Context, taskIDs []string) ([]string, error)

	// Synchronously waits until task is finished successfully or cancelled.
	WaitTaskEnded(ctx context.Context, taskID string) error

	// Same as WaitTaskEnded but with adjustable timeout.
	WaitTaskEndedWithTimeout(
		ctx context.Context,
		taskID string,
		timeout time.Duration,
	) error

	GetTaskMetadata(ctx context.Context, taskID string) (proto.Message, error)

	SendEvent(ctx context.Context, taskID string, event int64) error

	// TODO: Does it belong here?
	GetOperation(ctx context.Context, taskID string) (*operation.Operation, error)

	// Used in tests.
	// Returns task error if task has finished with error, nil otherwise.
	GetTaskError(ctx context.Context, taskID string) error

	// Used in tests.
	// Synchronously waits for task response.
	WaitTaskSync(
		ctx context.Context,
		taskID string,
		timeout time.Duration,
	) (proto.Message, error)

	// Schedules no-op task. Used for testing.
	ScheduleBlankTask(ctx context.Context) (string, error)
}