models

type BaseIPCMessage struct {
	// ID message ID
	ID string `json:"id" validate:"required"`
	// Type message type
	Type IPCMessageTypeEnum `json:"type" validate:"required,ipc_msg_type"`
	// Sender name of the sending entity
	Sender string `json:"sender" validate:"required"`
	// Timestamp message timestamp
	Timestamp time.Time `json:"timestamp"`
}

type IPCMessageExecuteInstance struct {
	BaseIPCMessage
	// InstanceID ID of the task execution instance referenced
	InstanceID string `json:"instance_id" validate:"required"`
	// Disposition for an EXECUTE_FAILED message, whether the failure is retryable. Nil (the only
	// value for non-failure messages, and the default for a failure) is treated as retryable.
	Disposition *TaskFailureDispositionENUM `json:"disposition,omitempty" validate:"omitempty,task_failure_disposition"`
}

type IPCMessageQueueError struct{ goutils.BaseError }

type IPCMessageSystemTask struct {
	BaseIPCMessage
	// TaskID ID of the task referenced
	TaskID string `json:"task_id" validate:"required"`
}

type IPCMessageTypeEnum string

type IPCMessageWorkflow struct {
	BaseIPCMessage
	// WorkflowID ID of the workflow referenced
	WorkflowID string `json:"workflow_id" validate:"required"`
}

type IPCMessageWorkflowRevive struct {
	BaseIPCMessage
	// WorkflowID ID of the workflow to revive
	WorkflowID string `json:"workflow_id" validate:"required"`
	// NewDeadline optional new workflow deadline
	NewDeadline *time.Time `json:"new_deadline,omitempty"`
}

type IPCMessageWorkflowStep struct {
	BaseIPCMessage
	// StepID ID of the workflow step referenced
	StepID string `json:"step_id" validate:"required"`
}

type IPCMessageWorkflowStepExecUpdate struct {
	BaseIPCMessage
	// StepID ID of the workflow step referenced
	StepID string `json:"step_id" validate:"required"`
	// NewStepState the resolved new step state. The workflow_step_state macro accepts any step
	// state; the reducer additionally enforces that it is a terminal outcome
	// (COMPLETE/FAILED/TIMED_OUT/CANCELLED) at handling time.
	NewStepState WorkflowStepStateENUM `json:"new_step_state" validate:"required,workflow_step_state"`
}

type IPCMessageWorkflowStepTaskUpdate struct {
	BaseIPCMessage
	// TaskID ID of the task whose terminal event drove this update
	TaskID string `json:"task_id" validate:"required"`
	// NewStepState the resolved new step state. The workflow_step_state macro accepts any step
	// state; the reducer additionally enforces that it is a terminal outcome
	// (COMPLETE/FAILED/TIMED_OUT/CANCELLED) at handling time.
	NewStepState WorkflowStepStateENUM `json:"new_step_state" validate:"required,workflow_step_state"`
}

type NewWorkflowParameter struct {
	// Name of the workflow
	Name string `json:"name" validate:"required"`

	// Metadata relating to the workflow
	Metadata interface{} `json:"metadata,omitempty"`

	// Deadline the workflow must be completed by this deadline
	Deadline time.Time `json:"deadline" validate:"required"`

	// Steps of the workflow keyed by each step's name
	Steps map[string]NewWorkflowStepParameter `json:"steps" validate:"required,gte=1,dive"`
}

type NewWorkflowStepParameter struct {
	// Name of the workflow step
	Name string `json:"name" validate:"required"`

	// Type workflow step type which indicates which processor should run the step
	Type string `json:"type" validate:"required"`

	// Parameters optional parameters needed for processing the step
	Parameters interface{} `json:"parameters,omitempty"`

	// Metadata relating to the workflow step
	Metadata interface{} `json:"metadata,omitempty"`

	// RetryParams retry parameters in case of failure
	RetryParams TaskRetryParameters `json:"retry_params" validate:"required"`

	// ParentSteps parent steps this step depends on. Parent steps are specified by name.
	ParentSteps map[string]bool `json:"parent_steps"`
}

type NonRecoverableError struct{ goutils.BaseError }

type NotificationEvent struct {
	// ID audit event ID (subscribers dedupe on this — production is at-least-once)
	ID string `json:"id" validate:"required"`
	// EventType system event type
	EventType SystemEventTypeENUM `json:"type" validate:"required,system_event_type"`
	// CreatedAt when the audit event was recorded
	CreatedAt time.Time `json:"created_at"`
	// Creator opaque identity of the event's creator, when the event has one
	Creator *string `json:"creator,omitempty"`
	// SubjectType type of the subject the event is about (e.g. "task"), when derivable
	SubjectType *string `json:"subject_type,omitempty"`
	// SubjectID ID of the subject the event is about, when derivable
	SubjectID *string `json:"subject_id,omitempty"`
	// Metadata the event's typed metadata, as recorded on the audit row
	Metadata json.RawMessage `json:"metadata,omitempty"`
}

type NotificationProducerConfig struct {
	// PollIntervalSecs interval, in seconds, between audit-log polls
	PollIntervalSecs int `mapstructure:"pollIntervalSecs" json:"pollIntervalSecs" validate:"required,gte=1"`
	// BatchSize max number of un-broadcast events to process per poll
	BatchSize int `mapstructure:"batchSize" json:"batchSize" validate:"required,gte=1"`
	// EmitFirehose when true, publish every event on the `notify:all` firehose channel
	EmitFirehose bool `mapstructure:"emitFirehose" json:"emitFirehose"`
	// EmitTypeChan when true, publish every event on its `notify:type:<type>` channel
	EmitTypeChan bool `mapstructure:"emitTypeChan" json:"emitTypeChan"`
	// EmitCreator when true, publish creator-bearing events on their `notify:creator:<creator>`
	// and `notify:creator:<creator>:type:<type>` channels
	EmitCreator bool `mapstructure:"emitCreator" json:"emitCreator"`
}

type NotifyConsumerError struct{ goutils.BaseError }

type NotifyProducerError struct{ goutils.BaseError }

type OnFatalCB func(reporter string, err error, timestamp time.Time)

type ProvisioningError struct{ goutils.BaseError }

type RetryParam struct {
	// InitialDelaySec initial delay seconds
	InitialDelaySec int `mapstructure:"initDelaySec" json:"initDelaySec" validate:"gte=1"`
	// MaxRetries max number of retry allowed for failed execution. `-1` is infinite.
	MaxRetries int `mapstructure:"maxRetries" json:"maxRetries" validate:"gte=-1"`
	// MaxDelaySec max delay seconds
	MaxDelaySec *int `mapstructure:"maxDelaySec,omitempty" json:"maxDelaySec,omitempty" validate:"omitempty,gte=1"`
}

type StepExecutionError struct{ goutils.BaseError }

type StepPreprocessError struct{ goutils.BaseError }

type SystemEventAudit struct {
	// ID audit entry ID
	ID string `json:"id" gorm:"column:id;primaryKey;unique" validate:"required"`
	// EventType system event type
	EventType SystemEventTypeENUM `json:"type" gorm:"column:type;not null" validate:"required,system_event_type"`
	// Metadata a metadata relating to the event
	Metadata datatypes.JSON `json:"metadata,omitempty" gorm:"column:metadata;default:null"`
	// CreatedAt entry creation timestamp
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt entry update timestamp
	UpdatedAt time.Time `json:"updated_at"`
	// BroadcastAt when the notification producer broadcast this event. NULL until
	// broadcast. The producer's work-queue marker: SELECT … WHERE broadcast_at IS NULL.
	BroadcastAt *time.Time `json:"broadcast_at,omitempty" gorm:"column:broadcast_at;index;default:null"`
}

type SystemEventEngineFailedTask struct {
	// TaskID ID of the task that was failed
	TaskID string `json:"task_id" validate:"required"`
	// InstanceID ID of the execution instance the engine failed to operate on
	InstanceID string `json:"instance_id" validate:"required"`
	// Reason human-readable reason the engine reported the failure
	Reason string `json:"reason"`
	// Creator opaque identity of the task's creator; the notification routing key.
	// Denormalized here so the producer can route from the audit row alone (no joins).
	Creator string `json:"creator" validate:"required"`
}

type SystemEventInvalidTaskIPCMessage struct {
	// Receiver name of the IPC message receiver that rejected the message (e.g. "scheduler"
	// for the scheduler; the worker's config.Name for a task Receiver)
	Receiver string `json:"receiver" validate:"required"`
	// RawMessage the raw message payload as received, if it was readable
	RawMessage string `json:"raw_message"`
	// Reason human-readable reason the message was rejected
	Reason string `json:"reason"`
}

type SystemEventTaskEvents struct {
	// TaskID task ID
	TaskID string `json:"task_id" validate:"required"`
	// Creator opaque identity of the task's creator; the notification routing key.
	// Denormalized here so the producer can route from the audit row alone (no joins).
	Creator string `json:"creator" validate:"required"`
}

type SystemEventTypeENUM string

type SystemEventWorkflowEvents struct {
	// WorkflowID workflow ID; also the notification subject (subject:workflow:<id>).
	WorkflowID string `json:"workflow_id" validate:"required"`
	// Creator opaque identity of the workflow's creator; the notification routing key.
	// Denormalized here so the producer can route from the audit row alone (no joins).
	Creator string `json:"creator" validate:"required"`
}

type SystemEventWorkflowStepEvents struct {
	// StepID workflow step ID
	StepID string `json:"step_id" validate:"required"`
	// WorkflowID parent workflow ID; also the notification subject (subject:workflow:<id>).
	WorkflowID string `json:"workflow_id" validate:"required"`
	// Creator opaque identity of the parent workflow's creator; the notification routing key.
	// Denormalized here so the producer can route from the audit row alone (no joins).
	Creator string `json:"creator" validate:"required"`
}

type Task struct {
	// ID task ID
	ID string `json:"id" gorm:"column:id;primaryKey;unique" validate:"required"`

	// TaskName name of the task being executed. This is used to locate the execution processor
	// for this task name
	TaskName string `json:"name" gorm:"column:name;not null" validate:"required"`

	// Creator opaque identity of the entity that created this task. Set by the
	// submitting Client. tasking never interprets it; multi-tenancy/isolation is
	// the embedding application's responsibility.
	Creator string `json:"creator" gorm:"column:creator;index" validate:"required"`

	// TaskScheduleClass execution scheduling class of the task
	TaskScheduleClass TaskScheduleClassENUM `json:"schedule_class" gorm:"column:schedule_class;not null" validate:"required,task_schedule_class"`

	// TaskState state of the task
	TaskState TaskStateENUM `json:"state" gorm:"column:state;not null" validate:"required,task_state"`

	// Parameters optional parameters needed for processing the task
	Parameters datatypes.JSON `json:"parameters,omitempty" gorm:"column:parameters;default:null"`

	// Metadata a metadata relating to the task
	Metadata datatypes.JSON `json:"metadata,omitempty" gorm:"column:metadata;default:null"`

	// TargetRunTime for scheduled one-shot tasks, when this task must run
	TargetRunTime *time.Time `json:"target_runtime,omitempty" gorm:"column:target_runtime;default:null"`

	// Deadline if specified, the task must be completed by this deadline
	Deadline *time.Time `json:"deadline,omitempty" gorm:"column:deadline;default:null"`

	// RetryParams retry parameters in case of failure
	RetryParams TaskRetryParameters `json:"retry_params" gorm:"column:retry_params;not null" validate:"required"`

	// CreatedAt entry creation timestamp
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt entry update timestamp
	UpdatedAt time.Time `json:"updated_at"`
}

type TaskClientConfig struct {
	// SchedulerQueue scheduler IPC queue name
	SchedulerQueue string `mapstructure:"schedulerQueue" json:"schedulerQueue" validate:"required"`
	// TaskQueues task execution queue configurations
	TaskQueues []TaskQueueConfig `mapstructure:"taskQueues,omitempty" json:"taskQueues,omitempty" validate:"omitempty,gte=1,dive"`
}

type TaskClientError struct{ goutils.BaseError }

type TaskDefinition struct {
	// TaskName task name
	TaskName string `mapstructure:"name" json:"name" validate:"required"`
	// Retry the retry parameters to apply to this task name
	Retry RetryParam `mapstructure:"retry" json:"retry" validate:"required"`
	// Processor the task execution processor for this task name. Behavior rather than data, so it
	// is excluded from serialization - the application supplies it in code, not in a config file.
	Processor TaskExecutionProcessor `mapstructure:"-" json:"-" validate:"required"`
}

type TaskExecution struct {
	// ID task execution instance ID
	ID string `json:"id" gorm:"column:id;primaryKey;unique" validate:"required"`

	// TaskID the parent task ID
	TaskID string `json:"task_id" gorm:"column:task_id;not null" validate:"required"`

	// ExecutionClass execution instance scheduling class
	ExecutionClass TaskExecutionClassENUM `json:"execution_class" gorm:"column:execution_class;not null" validate:"required,task_execute_class"`
	// ExecutionState execution instance state type
	ExecutionState TaskExecutionStateENUM `json:"state" gorm:"column:state;not null" validate:"required,task_execute_state"`

	// TerminalState the terminal state the execution instance reached before it was
	// finalized: one of Processed, Failed, or Cancelled. Nil until the instance ends.
	// Because every ended instance is moved to FINALIZED, `ExecutionState` alone can no
	// longer report the outcome; this field preserves it.
	TerminalState *TaskExecutionStateENUM `json:"terminal_state,omitempty" gorm:"column:terminal_state;default:null" validate:"omitempty,task_execute_state"`
	// TerminatedAt the timestamp when the execution instance reached its terminal state.
	// Nil until the instance ends.
	TerminatedAt *time.Time `json:"terminated_at,omitempty" gorm:"column:terminated_at;default:null"`

	// TargetEnqueueTime target time to enqueue instance for worker to pickup
	//
	// This can't dictate when the task will execute, rather when it will be queue to execute
	TargetEnqueueTime *time.Time `json:"execute_at,omitempty" gorm:"column:execute_at;default:null"`

	// ExecutionWorkerName the worker which acquired the execution instance for processing
	ExecutionWorkerName *string `json:"worker_name,omitempty" gorm:"column:worker_name;default:null;" validate:"omitempty"`

	// RetryParentExecutionID for retry type execution instance, the original
	// execution instance ID
	RetryParentExecutionID *string `json:"retry_parent_id,omitempty" gorm:"column:retry_parent_id;default:null;" validate:"omitempty"`

	// ErrorMessage in case of processing failure, the error message
	ErrorMessage *string `json:"error_msg,omitempty" gorm:"column:error_msg;default:null;" validate:"omitempty"`

	// FailureDisposition in case of processing failure, whether the failure is retryable. Nil
	// until the instance fails, and a nil value is treated as retryable. Set to NON_RETRYABLE
	// when a processor returned a NonRecoverableError, so the scheduler (and the maintenance
	// backstop, which reads this persisted value) skips the retry.
	FailureDisposition *TaskFailureDispositionENUM `` /* 130-byte string literal not displayed */

	// Deadline if specified, the execution instance must be completed by this deadline
	Deadline *time.Time `json:"deadline,omitempty" gorm:"column:deadline;default:null"`

	// CreatedAt entry creation timestamp
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt entry update timestamp
	UpdatedAt time.Time `json:"updated_at"`
}

type TaskExecutionClassENUM string

type TaskExecutionError struct{ goutils.BaseError }

type TaskExecutionProcessor interface {
	/*
		ProcessTaskExecution process a task specific to this processor

			@param ctx context.Context - execution context
			@param taskEntry Task - task entry
			@param executeEntry TaskExecution - task execution instance
	*/
	ProcessTaskExecution(ctx context.Context, taskEntry Task, executeEntry TaskExecution) error
}

type TaskExecutionStateENUM string

type TaskExecutorError struct{ goutils.BaseError }

type TaskFailureDispositionENUM string

type TaskMaintenanceError struct{ goutils.BaseError }

type TaskParameterExecuteWorkflowStep struct {
	// StepID the workflow step to execute
	StepID string `json:"step_id" validate:"required"`
}

type TaskPostprocessError struct{ goutils.BaseError }

type TaskPreprocessError struct{ goutils.BaseError }

type TaskQueueConfig struct {
	// Name of the task queue
	Name string `mapstructure:"name" json:"name" validate:"required"`
	// Workers number of workers to process tasks from the queue in parallel
	Workers int `mapstructure:"workers" json:"workers" validate:"required,gte=1"`
	// BufferRequests number of requests a receiver can locally buffer for execution
	BufferRequests int `mapstructure:"bufferRequests" json:"bufferRequests" validate:"required,gte=1"`
	// SupportedTasks list of tasks supported by the task queue
	SupportedTasks []TaskDefinition `mapstructure:"tasks" json:"tasks" validate:"required,gte=1,dive"`
}

type TaskReceiverConfig struct {
	// Name of the task receiver
	Name string `mapstructure:"name" json:"name" validate:"required"`
	// TaskQueues task execution queue configurations
	TaskQueues []TaskQueueConfig `mapstructure:"taskQueues" json:"taskQueues" validate:"required,gte=1,dive"`
	// SchedulerQueue scheduler IPC queue name
	SchedulerQueue string `mapstructure:"schedulerQueue" json:"schedulerQueue" validate:"required"`
}

type TaskReceiverError struct{ goutils.BaseError }

type TaskRetryParameters struct {
	// MaxRetries max number of retry allowed for failed execution. `-1` is infinite.
	MaxRetries int `json:"max_retries" validate:"gte=-1"`

	// InitialDelaySec initial delay seconds
	InitialDelaySec int `json:"initial_delay" validate:"gte=1"`

	// MaxDelaySec max delay seconds
	MaxDelaySec *int `json:"max_delay,omitempty" validate:"omitempty,gte=1"`

	// Factor multiplicative factor or base
	Factor float64 `json:"factor" validate:"gte=1"`
}

type TaskScheduleClassENUM string

type TaskSchedulerConfig struct {
	// MaintenanceTimerIntSecs maintenance timer interval in seconds
	MaintenanceTimerIntSecs int `mapstructure:"maintenanceTimerIntSecs" json:"maintenanceTimerIntSecs" validate:"required,gte=10"`
	// SchedulerQueue scheduler IPC queue name
	SchedulerQueue string `mapstructure:"schedulerQueue" json:"schedulerQueue" validate:"required"`
	// TaskQueues task execution queue configurations
	TaskQueues []TaskQueueConfig `mapstructure:"taskQueues" json:"taskQueues" validate:"required,gte=1,dive"`
}

type TaskSchedulerError struct{ goutils.BaseError }

type TaskStateENUM string

type Workflow struct {
	// ID workflow ID
	ID string `json:"id" gorm:"column:id;primaryKey;unique" validate:"required"`

	// Name of the workflow
	Name string `json:"name" gorm:"column:name;not null;" validate:"required"`

	// Creator opaque identity of the entity that created this workflow. Set by the
	// submitting Client. tasking never interprets it; it is the routing key for the
	// workflow's audit events and notifications, so a creator can subscribe to the
	// workflows they created. Multi-tenancy/isolation is the embedding application's
	// responsibility.
	Creator string `json:"creator" gorm:"column:creator;index" validate:"required"`

	// State state of the workflow
	State WorkflowStateENUM `json:"state" gorm:"column:state;not null" validate:"required,workflow_state"`

	// Metadata relating to the workflow
	Metadata datatypes.JSON `json:"metadata,omitempty" gorm:"column:metadata;default:null"`

	// Deadline the workflow must be completed by this deadline
	Deadline time.Time `json:"deadline" gorm:"column:deadline;not null" validate:"required"`

	// StartedAt when the workflow started
	StartedAt *time.Time `json:"started_at,omitempty" gorm:"column:started_at;default:null"`

	// StoppedAt when the workflow reached termination points (i.e. completed or cancelled)
	StoppedAt *time.Time `json:"stopped_at,omitempty" gorm:"column:stopped_at;default:null"`

	// CreatedAt entry creation timestamp
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt entry update timestamp
	UpdatedAt time.Time `json:"updated_at"`
}

type WorkflowClientConfig struct {
	// SchedulerQueue workflow scheduler IPC queue name
	SchedulerQueue string `mapstructure:"schedulerQueue" json:"schedulerQueue" validate:"required"`
}

type WorkflowClientError struct{ goutils.BaseError }

type WorkflowSchedulerConfig struct {
	// MaintenanceTimerIntSecs maintenance timer interval in seconds
	MaintenanceTimerIntSecs int `mapstructure:"maintenanceTimerIntSecs" json:"maintenanceTimerIntSecs" validate:"required,gte=10"`
	// SchedulerQueue scheduler IPC queue name
	SchedulerQueue string `mapstructure:"schedulerQueue" json:"schedulerQueue" validate:"required"`
}

type WorkflowSchedulerError struct{ goutils.BaseError }

type WorkflowStateENUM string

type WorkflowStep struct {
	// ID workflow step ID
	ID string `json:"id" gorm:"column:id;primaryKey;unique" validate:"required"`

	// Name of the workflow step.
	Name string `json:"name" gorm:"column:name;not null;index:unique_step_in_workflow,unique;" validate:"required"`

	// WorkflowID parent workflow ID
	WorkflowID string `json:"workflow_id" gorm:"column:workflow_id;not null;index:unique_step_in_workflow,unique;" validate:"required"`

	// Creator opaque identity of the entity that created the parent workflow. Denormalized
	// from the workflow so step audit events can route without a join. Set at definition.
	Creator string `json:"creator" gorm:"column:creator;index" validate:"required"`

	// Type workflow step type which indicates which processor should run the step
	Type string `json:"type" gorm:"column:type;not null" validate:"required"`

	// State state of the workflow step
	State WorkflowStepStateENUM `json:"state" gorm:"column:state;not null" validate:"required,workflow_step_state"`

	// UserRestarted whether the user has revived this step (pure metadata, not a state)
	UserRestarted bool `json:"user_restarted" gorm:"column:user_restarted;not null;default:false"`

	// Parents steps this step depends on
	Parents WorkflowStepParents `json:"parents" gorm:"column:parents;not null"`

	// Parameters optional parameters needed for processing the step
	Parameters datatypes.JSON `json:"parameters,omitempty" gorm:"column:parameters;default:null"`

	// Metadata a metadata relating to the workflow step
	Metadata datatypes.JSON `json:"metadata,omitempty" gorm:"column:metadata;default:null"`

	// RetryParams retry parameters in case of failure
	RetryParams TaskRetryParameters `json:"retry_params" gorm:"column:retry_params;not null" validate:"required"`

	// Deadline the workflow step must be completed by this deadline
	Deadline time.Time `json:"deadline" gorm:"column:deadline;not null" validate:"required"`

	// StartedAt when the workflow step started
	StartedAt *time.Time `json:"started_at,omitempty" gorm:"column:started_at;default:null"`

	// StoppedAt when the workflow step reached termination points (i.e. completed or cancelled)
	StoppedAt *time.Time `json:"stopped_at,omitempty" gorm:"column:stopped_at;default:null"`

	// CreatedAt entry creation timestamp
	CreatedAt time.Time `json:"created_at"`
	// UpdatedAt entry update timestamp
	UpdatedAt time.Time `json:"updated_at"`
}

type WorkflowStepExecution struct {
	// Task the task which executed the workflow step
	Task Task `json:"task"`
	// Executions the execution attempts that task made, oldest first
	Executions []TaskExecution `json:"executions"`
}

type WorkflowStepParents struct {
	// ParentStepNames name of the parent steps
	ParentStepNames []string `json:"parents,omitempty"`
}

type WorkflowStepProcessor interface {
	/*
		ProcessTaskExecution process a workflow step of a particular Type.

			@param ctx context.Context - execution context
			@param workflowEntry Workflow - workflow entry
			@param stepEntry WorkflowStep - workflow step entry
	*/
	ProcessWorkflowStep(ctx context.Context, workflowEntry Workflow, stepEntry WorkflowStep) error
}

type WorkflowStepStateENUM string