errors

Documentation

Index

• Constants
• Variables
• func CheckIfFatal(err error) error
• func Errorf(format string, a ...any) error
• func Fn() string
• func IsNotFound(err error) bool
• func IsWorkflowFatal(err error) bool
• type ErrWorkflowFatal
  • func (e ErrWorkflowFatal) Error() string

Constants

const TraceLevel = -41 // TraceLevel specifies a custom level for trace logging.

const VerboseLevel = -51 // VerboseLevel specifies a custom level vor verbose logging.

Variables

var (
	ErrClosing                        = errors.New("SHAR server is shutting down")                                                               // ErrClosing si-gnifies SHAR server is shutting down.
	ErrExecutionNotFound              = errors.New("execution not found")                                                                        // ErrExecutionNotFound - execution not found.
	ErrProcessInstanceNotFound        = errors.New("process instance not found")                                                                 // ErrProcessInstanceNotFound - process instance not found.
	ErrWorkflowNotFound               = errors.New("workflow not found")                                                                         // ErrWorkflowNotFound - workflow not found.
	ErrWorkflowVersionNotFound        = errors.New("workflow version not found")                                                                 // ErrWorkflowVersionNotFound - workflow version not found.
	ErrElementNotFound                = errors.New("element not found")                                                                          // ErrElementNotFound - element not found.
	ErrStateNotFound                  = errors.New("state not found")                                                                            // ErrStateNotFound - state not found.
	ErrJobNotFound                    = errors.New("job not found")                                                                              // ErrJobNotFound - job not found.
	ErrMissingCorrelation             = errors.New("missing correlation key")                                                                    // ErrMissingCorrelation - missing correllation key.
	ErrFatalBadDuration               = &ErrWorkflowFatal{Err: errors.New("timer embargo value could not be evaluated to an int or a duration")} // ErrFatalBadDuration - the timer embargo value could not be evaluated to an int or a duration
	ErrWorkflowErrorNotFound          = errors.New("workflow error number not found")                                                            // ErrWorkflowErrorNotFound - the workflow error thrown is not recognised.
	ErrUndefinedVariable              = errors.New("undefined variable")                                                                         // ErrUndefinedVariable - a variable was referred to in the workflow that hasn't been declared.
	ErrMissingErrorCode               = errors.New("missing error code")                                                                         // ErrMissingErrorCode - no workflow error code was provided.
	ErrBadlyQuotedIdentifier          = errors.New("identifier not correctly quoted")                                                            // ErrBadlyQuotedIdentifier - an identifier was not correctgly formatted.
	ErrMessageSenderAlreadyRegistered = errors.New("message sender already registered")                                                          // ErrMessageSenderAlreadyRegistered - a message sender with this signature was already registered.
	ErrServiceTaskAlreadyRegistered   = errors.New("service task already registered")                                                            // ErrServiceTaskAlreadyRegistered - a service task with this signature was already registered.
	ErrFailedToParseISO8601           = errors.New("parse Duration string")                                                                      // ErrFailedToParseISO8601 - string cound not be parsed into an ISO 8601 duration.
	ErrBadTimerEventDefinition        = errors.New("found timerEventDefinition, but it had no time or Duration specified")                       // ErrBadTimerEventDefinition - no timer defined of a timer event.
	ErrBadTimeCycle                   = errors.New("time cycle was not in the correct format")                                                   // ErrBadTimeCycle - time cycle was not specified correctly.
	ErrCorrelationFail                = errors.New("find correlation message")                                                                   // ErrCorrelationFail - could not correlate the workflow message.
	ErrMissingID                      = errors.New("missing id")                                                                                 // ErrMissingID - could not validate the id in the model
	ErrMissingServiceTaskDefinition   = errors.New("missing service task definition")                                                            // ErrMissingServiceTaskDefinition - could not find the definition for the service task.
	ErrExtractingVar                  = errors.New("extract var")                                                                                // ErrExtractingVar - failod to extract client variable.
	ErrExpectedVar                    = errors.New("workflow expects variable")                                                                  // ErrExpectedVar - a variable was expected by workflow that was not provided.
	ErrCancelFailed                   = errors.New("cancel workflow instance")                                                                   // ErrCancelFailed - an attempt to cancel a workflow instance failed.
	ErrInvalidState                   = errors.New("invalid cancellation state")                                                                 // ErrInvalidState - an attempt was made to p[erform an action witrh an invalid cancellation state.
	ErrApiAuthZFail                   = errors.New("authorize API call")                                                                         // ErrApiAuthZFail - an attempt was made to call an API that failed an authorization check.
	ErrApiAuthNFail                   = errors.New("authenticate API call")                                                                      // ErrApiAuthNFail - an attempt was made to call an API that failed an authentication check.
	ErrLint                           = errors.New("linter returned errors")                                                                     // ErrLint - linter returned errors.
	ErrGatewayInstanceNotFound        = errors.New("find gateway instance")                                                                      // ErrGatewayInstanceNotFound - failed to find gateway instance.
	ErrProcessNotFound                = errors.New("process not found")                                                                          // ErrProcessNotFound - failed to find process.
	ErrDeprecateServiceTaskInUse      = errors.New("attempt to deprecate service task in use")                                                   // ErrDeprecateServiceTaskInUse - the service task is in use.
)

Functions

func CheckIfFatal

func CheckIfFatal(err error) error

CheckIfFatal will return *ErrWorkflowFatal if the error is obviously unrecoverable

func Errorf

func Errorf(format string, a ...any) error

Errorf will return a formatted error, marking it fatal if the error is obviously unrecoverable

func Fn

func Fn() string

Fn - obtains the calling function for use in error handling. ** CAUTION - This is inefficient, and should only be used for fatal errors and errors that are not expected to occur during normal operation **

func IsNotFound

func IsNotFound(err error) bool

IsNotFound will return true if the error is a SHAR or NATS not found error type

func IsWorkflowFatal

func IsWorkflowFatal(err error) bool

IsWorkflowFatal is a quick test to check whether the error contains ErrWorkflowFatal

Types

type ErrWorkflowFatal

type ErrWorkflowFatal struct {
	Err error
}

ErrWorkflowFatal signifies that the workflow must terminate

func (ErrWorkflowFatal) Error

func (e ErrWorkflowFatal) Error() string

Error returns the string version of the ErrWorkflowFatal error