service

package
v1.8.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 21, 2024 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const (
	EnvNameDebugMode = "DEBUG_MODE"

	DefaultContinueAsNewPageSizeInBytes = 1024 * 1024

	// HttpStatusCodeSpecial4xxError1 is for poll timeout, RPC worker execution error
	HttpStatusCodeSpecial4xxError1 = 420
	// HttpStatusCodeSpecial4xxError2 is for RPC acquire locking failure
	HttpStatusCodeSpecial4xxError2 = 450

	TaskQueue = "Interpreter_DEFAULT"

	StateStartApi        = "/api/v1/workflowState/start"
	StateDecideApi       = "/api/v1/workflowState/decide"
	WorkflowWorkerRpcApi = "/api/v1/workflowWorker/rpc"

	GetDataObjectsWorkflowQueryType      = "GetDataObjects"
	GetSearchAttributesWorkflowQueryType = "GetSearchAttributes"
	GetCurrentTimerInfosQueryType        = "GetCurrentTimerInfos"
	ContinueAsNewDumpQueryType           = "ContinueAsNewDump"
	DebugDumpQueryType                   = "DebugNewDump"
	PrepareRpcQueryType                  = "PrepareRpcQueryType"

	ExecuteOptimisticLockingRpcUpdateType = "ExecuteOptimisticLockingRpcUpdate"

	SearchAttributeGlobalVersion     = "IwfGlobalWorkflowVersion"
	SearchAttributeExecutingStateIds = "IwfExecutingStateIds"
	SearchAttributeIwfWorkflowType   = "IwfWorkflowType"

	BackendTypeCadence  BackendType = "cadence"
	BackendTypeTemporal BackendType = "temporal"

	IwfSystemConstPrefix = "__IwfSystem_"

	SkipTimerSignalChannelName       = IwfSystemConstPrefix + "SkipTimerChannel"
	FailWorkflowSignalChannelName    = IwfSystemConstPrefix + "FailWorkflowChannel"
	UpdateConfigSignalChannelName    = IwfSystemConstPrefix + "UpdateWorkflowConfig"
	ExecuteRpcSignalChannelName      = IwfSystemConstPrefix + "ExecuteRpc"
	StateCompletionSignalChannelName = IwfSystemConstPrefix + "StateCompletion"

	WorkerUrlMemoKey            = IwfSystemConstPrefix + "WorkerUrl"
	UseMemoForDataAttributesKey = IwfSystemConstPrefix + "UseMemoForDataAttributes"
)
View Source
const (
	GracefulCompletingWorkflowStateId = "_SYS_GRACEFUL_COMPLETING_WORKFLOW"
	ForceCompletingWorkflowStateId    = "_SYS_FORCE_COMPLETING_WORKFLOW"
	ForceFailingWorkflowStateId       = "_SYS_FORCE_FAILING_WORKFLOW"
	DeadEndWorkflowStateId            = "_SYS_DEAD_END"
)

Variables

Functions

This section is empty.

Types

type BackendType

type BackendType string

type BasicInfo added in v1.5.0

type BasicInfo struct {
	IwfWorkflowType string `json:"iwfWorkflowType,omitempty"`

	IwfWorkerUrl string `json:"iwfWorkerUrl,omitempty"`
}

type ContinueAsNewDumpResponse added in v1.5.0

type ContinueAsNewDumpResponse struct {
	StatesToStartFromBeginning []iwfidl.StateMovement              // StatesToStartFromBeginning means they haven't started in the previous run
	StateExecutionsToResume    map[string]StateExecutionResumeInfo // stateExeId to StateExecutionResumeInfo
	InterStateChannelReceived  map[string][]*iwfidl.EncodedObject
	SignalsReceived            map[string][]*iwfidl.EncodedObject
	StateExecutionCounterInfo  StateExecutionCounterInfo
	StateOutputs               []iwfidl.StateCompletionOutput
	StaleSkipTimerSignals      []StaleSkipTimerSignal

	DataObjects      []iwfidl.KeyValue
	SearchAttributes []iwfidl.SearchAttribute
}

type ContinueAsNewInput added in v1.5.0

type ContinueAsNewInput struct {
	PreviousInternalRunId string `json:"previousInternalRunId"` // for loading from previous run
}

type DebugDumpResponse added in v1.5.0

type DebugDumpResponse struct {
	Config iwfidl.WorkflowConfig
}

type ExecuteRpcSignalRequest added in v1.5.0

type ExecuteRpcSignalRequest struct {
	RpcInput                    *iwfidl.EncodedObject
	RpcOutput                   *iwfidl.EncodedObject
	UpsertDataObjects           []iwfidl.KeyValue
	UpsertSearchAttributes      []iwfidl.SearchAttribute
	StateDecision               *iwfidl.StateDecision
	RecordEvents                []iwfidl.KeyValue
	InterStateChannelPublishing []iwfidl.InterStateChannelPublishing
}

type FailWorkflowSignalRequest added in v1.5.0

type FailWorkflowSignalRequest struct {
	Reason string
}

type GetCurrentTimerInfosQueryResponse added in v1.2.0

type GetCurrentTimerInfosQueryResponse struct {
	StateExecutionCurrentTimerInfos map[string][]*TimerInfo // key is stateExecutionId
}

type GetDataObjectsQueryRequest

type GetDataObjectsQueryRequest struct {
	Keys []string
}

type GetDataObjectsQueryResponse

type GetDataObjectsQueryResponse struct {
	DataObjects []iwfidl.KeyValue
}

type InternalTimerStatus added in v1.2.0

type InternalTimerStatus string
const (
	TimerPending InternalTimerStatus = "Pending"
	TimerFired   InternalTimerStatus = "Fired"
	TimerSkipped InternalTimerStatus = "Skipped"
)

type InterpreterWorkflowInput

type InterpreterWorkflowInput struct {
	IwfWorkflowType string `json:"iwfWorkflowType,omitempty"`

	IwfWorkerUrl string `json:"iwfWorkerUrl,omitempty"`

	StartStateId *string `json:"startStateId,omitempty"`

	WaitForCompletionStateExecutionIds []string `json:"waitForCompletionStateExecutionIds,omitempty"`

	StateInput iwfidl.EncodedObject `json:"stateInput,omitempty"`

	StateOptions iwfidl.WorkflowStateOptions `json:"stateOptions,omitempty"`

	InitSearchAttributes []iwfidl.SearchAttribute `json:"initSearchAttributes,omitempty"`

	UseMemoForDataAttributes bool `json:"useMemoForDataAttributes"`

	Config iwfidl.WorkflowConfig `json:"config,omitempty"`

	// IsResumeFromContinueAsNew indicate this is input for continueAsNew
	// when true, will ignore StartStateId, StateInput, StateOptions, InitSearchAttributes
	IsResumeFromContinueAsNew bool `json:"isResumeFromContinueAsNew"`

	ContinueAsNewInput ContinueAsNewInput `json:"continueAsNewInput"`

	WorkflowExecutionTimeout time.Duration
}

type InterpreterWorkflowOutput

type InterpreterWorkflowOutput struct {
	StateCompletionOutputs []iwfidl.StateCompletionOutput `json:"stateCompletionOutputs,omitempty"`
}

type PrepareRpcQueryRequest added in v1.5.0

type PrepareRpcQueryRequest struct {
	DataObjectsLoadingPolicy       *iwfidl.PersistenceLoadingPolicy
	CachedDataObjectsLoadingPolicy *iwfidl.PersistenceLoadingPolicy
	SearchAttributesLoadingPolicy  *iwfidl.PersistenceLoadingPolicy
}

type PrepareRpcQueryResponse added in v1.5.0

type PrepareRpcQueryResponse struct {
	DataObjects              []iwfidl.KeyValue
	SearchAttributes         []iwfidl.SearchAttribute
	WorkflowRunId            string
	WorkflowStartedTimestamp int64
	IwfWorkflowType          string
	IwfWorkerUrl             string
}

type SkipTimerSignalRequest added in v1.2.0

type SkipTimerSignalRequest struct {
	StateExecutionId string
	CommandId        string
	CommandIndex     int
}

type StaleSkipTimerSignal added in v1.5.0

type StaleSkipTimerSignal struct {
	StateExecutionId  string
	TimerCommandId    string
	TimerCommandIndex int
}

type StateDecideActivityInput

type StateDecideActivityInput struct {
	IwfWorkerUrl string
	Request      iwfidl.WorkflowStateDecideRequest
}

type StateExecutionCompletedCommands added in v1.5.0

type StateExecutionCompletedCommands struct {
	CompletedTimerCommands             map[int]InternalTimerStatus   `json:"completedTimerCommands"`
	CompletedSignalCommands            map[int]*iwfidl.EncodedObject `json:"completedSignalCommands"`
	CompletedInterStateChannelCommands map[int]*iwfidl.EncodedObject `json:"completedInterStateChannelCommands"`
}

type StateExecutionCounterInfo added in v1.3.0

type StateExecutionCounterInfo struct {
	StateIdStartedCount            map[string]int // for stateExecutionId
	StateIdCurrentlyExecutingCount map[string]int // for sys search attribute ExecutingStateIds
	TotalCurrentlyExecutingCount   int            // for "dead end"
}

type StateExecutionResumeInfo added in v1.5.0

type StateExecutionResumeInfo struct {
	StateExecutionId                string                          `json:"stateExecutionId"`
	State                           iwfidl.StateMovement            `json:"state"`
	StateExecutionCompletedCommands StateExecutionCompletedCommands `json:"stateExecutionCompletedCommands"`
	CommandRequest                  iwfidl.CommandRequest           `json:"commandRequest"`
	StateExecutionLocals            []iwfidl.KeyValue               `json:"stateExecutionLocals"`
}

type StateExecutionStatus added in v1.5.0

type StateExecutionStatus string
const CompletedStateExecutionStatus StateExecutionStatus = "Completed" // this will process as normal
const ExecuteApiFailedAndProceed StateExecutionStatus = "ExecuteApiFailedAndProceed" // this will proceed to a different state
const FailureStateExecutionStatus StateExecutionStatus = "Failure"
const WaitingCommandsStateExecutionStatus StateExecutionStatus = "WaitingCommands" // this will put the state into a special pending queue for continueAsNew from waiting command

type StateStartActivityInput

type StateStartActivityInput struct {
	IwfWorkerUrl string
	Request      iwfidl.WorkflowStateStartRequest
}

type TimerInfo added in v1.2.0

type TimerInfo struct {
	CommandId                  string
	FiringUnixTimestampSeconds int64
	Status                     InternalTimerStatus
}

func ValidateTimerSkipRequest added in v1.2.0

func ValidateTimerSkipRequest(stateExeTimerInfos map[string][]*TimerInfo, stateExeId, timerId string, timerIdx int) (*TimerInfo, bool)

ValidateTimerSkipRequest validates if the skip timer request is valid return true if it's valid, along with the timer pointer use timerIdx if timerId is not empty

type WaitForStateCompletionWorkflowOutput added in v1.8.0

type WaitForStateCompletionWorkflowOutput struct {
	StateCompletionOutput iwfidl.StateCompletionOutput `json:"stateCompletionOutput,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL