README
¶
run_task_background Task
Description
The run_task_background task facilitates the concurrent execution of a foreground task and a background task, with configurable dependencies and outcomes. This task is essential for simulating complex scenarios involving parallel processes.
Task Behavior
- The task initiates both the foreground and background tasks simultaneously.
- It continuously monitors the status and result of both tasks.
- Upon completion of the foreground task, the
run_task_backgroundtask also completes, and the background task is cancelled if it's still running. - The result of the
run_task_backgroundtask mirrors the result of the foreground task. For instance, if the foreground task updates its result to "success", therun_task_backgroundtask will also set its result to "success". - The behavior following the completion of the background task is configurable based on the
onBackgroundCompletesetting.
Configuration Parameters
-
foregroundTask:
The task that runs in the foreground. This is the primary task and is defined as per the standard task definition format. -
backgroundTask:
The task that runs in the background concurrently with the foreground task. It is also defined following the standard task definition format. -
newVariableScope:
Determines if a new variable scope should be created for the foreground task. Iffalse, the current scope is passed through. The background task always operates in a new variable scope, which inherits from the parent but does not propagate changes upwards. Default:false. -
exitOnForegroundSuccess:
If set totrue, therun_task_backgroundtask will exit with a success result when the foreground task's result is set to "success". Note that this does not necessarily mean the foreground task has completed. If still running, both the background and foreground tasks will be cancelled. Default:false. -
exitOnForegroundFailure:
Iftrue, the task exits with a failure result when the foreground task's result is set to "failure". This does not imply the foreground task's completion. Both the background and foreground tasks will be cancelled if they are still running. Default:false. -
onBackgroundComplete:
Specifies the action to take when the background task completes first. Options are:ignore(default): No action is taken.fail: Exits the task with a failure result.succeed/success: Exits the task with a success result.failOrIgnore: Exits with a failure result if the background task fails, otherwise no action is taken.
Defaults
Default settings for the run_task_background task:
- name: run_task_background
config:
foregroundTask: {}
backgroundTask: {}
newVariableScope: false
exitOnForegroundSuccess: false
exitOnForegroundFailure: false
onBackgroundComplete: "ignore"
Outputs
This task does not produce any outputs.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "run_task_background" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Runs foreground and background task with configurable dependencies.", Category: "flow-control", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{}, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
ForegroundTask *helper.RawMessageMasked `yaml:"foregroundTask" json:"foregroundTask" require:"A" desc:"The primary task to execute in the foreground."`
BackgroundTask *helper.RawMessageMasked `yaml:"backgroundTask" json:"backgroundTask" desc:"The task to execute in the background while foreground runs."`
NewVariableScope bool `yaml:"newVariableScope" json:"newVariableScope" desc:"If true, create a new variable scope for child tasks."`
// When to complete (based on foreground task result)
// These allow early exit even if foreground task hasn't returned yet
ExitOnForegroundSuccess bool `yaml:"exitOnForegroundSuccess" json:"exitOnForegroundSuccess" desc:"If true, exit immediately when foreground task succeeds."`
ExitOnForegroundFailure bool `yaml:"exitOnForegroundFailure" json:"exitOnForegroundFailure" desc:"If true, exit immediately when foreground task fails."`
// What happens if background task completes first
// "ignore" (default) - do nothing
// "fail" - exit with failure
// "succeed" / "success" - exit with success
// "failOrIgnore" - exit with failure if background task failed, ignore on success
OnBackgroundComplete string `` /* 149-byte string literal not displayed */
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files