+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "retries": [ + { + "name": "retry-five-times", + "maxAttempts": 5 + } + ], + "errors": { + "definitions": [ + { + "name": "service-not-available-error", + "type": "https://serverlessworkflow.io/spec/errors/communication", + "status": 503, + "title": "Service Not Available", + "detail": "Failed to contact service, even after multiple retries" + } + ], + "handlers": [ + { + "name": "handle-503", + "when": [ + { + "status": 503 + } + ], + "retry": "retry-five-times", + "then": { + "throw": { + "refName": "service-not-available-error" + } + } + } + ], + "policies": [ + { + "name": "fault-tolerance-policy", + "handlers": [ + { + "refName": "handle-503" + } + ] + } + ] + } +} +``` + + | ++ +```yaml +retries: + - name: retry-five-times + maxAttempts: 5 +errors: + definitions: + - name: service-not-available-error + type: https://serverlessworkflow.io/spec/errors/communication + status: 503 + title: Service Not Available + detail: Failed to contact service, even after multiple retries + handlers: + - name: handle-503 + when: + - status: 503 + retry: retry-five-times + then: + throw: + refName: service-not-available-error + policies: + - name: fault-tolerance-policy + handlers: + - refName: handle-503 +``` + + | +
@@ -4294,8 +4404,11 @@ If it is set to `continue`, if the parent workflow completes, the subflow execut ```json { - "errorRef": "Item not in inventory", - "transition": "IssueRefundToCustomer" + "instance": "/states/0/actions/0", + "type": "https://example.com/errors#timeout", + "status": 504, + "title": "Function Timeout", + "detail": "The function 'my-function' timed out." } ``` @@ -4303,8 +4416,11 @@ If it is set to `continue`, if the parent workflow completes, the subflow execut
+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "type": "https://example.com/errors#timeout", + "status": 504 +} +``` + + | ++ +```yaml +type: "https://example.com/errors#timeout" +status: 504 +``` + + | +
+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "errors": { + "handlers": [ + { + "name": "handle-invalid-error", + "when": [ + { "error": "invalid" }, + { "status": 404 }, + { "status": 403 } + ], + "then": { + "transition": "my-state" + } + }, + { + "name": "handle-timeout-error", + "when": [ + { "status": 503 } + ], + "retry": "my-retry-policy", + "then": { + "transition": "my-state" + } + } + ] + } +} +``` + + | ++ +```yaml +errors: + handlers: + - name: 'handle-invalid-error' + when: + - type: 'invalid' + - status: 404 + - status: 403 + then: + transition: 'my-state' + - name: 'handle-timeout-error' + when: + - status: 503 + retry: 'my-retry-policy' + then: + transition: 'my-state' +``` + + | +
+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "errors": { + "policies": [ + { + "name": "my-retry-policy", + "handlers": [ + { + "refName": "handle-timeout-error" + }, + { + "when": [ + { "status": 503 } + ], + "retry": "my-retry-policy" + } + ] + } + ] + } +} +``` + + | ++ +```yaml +errors: + policies: + - name: 'my-retry-policy' + handlers: + - refName: 'handle-timeout-error' + - when: + - status: 503 + retry: 'my-retry-policy' +``` + + | +
+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "errors": { + "policies": [ + { + "name": "my-retry-policy", + "handlers": [ + { + "refName": "handle-timeout-error" + }, + { + "when": [ + { "status": 503 } + ], + "retry": "my-retry-policy" + } + ] + } + ] + } +} +``` + + | ++ +```yaml +errors: + policies: + - name: 'my-retry-policy' + handlers: + - refName: 'handle-timeout-error' + - when: + - status: 503 + retry: 'my-retry-policy' +``` + + | +
+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "when": [ + { + "status": 503 + } + ], + "then": { + "transition": "my-state" + } +} +``` + + | ++ +```yaml +when: + - status: 503 +then: + transition: 'my-state' +``` + + | +
+ +
| JSON | +YAML | +
|---|---|
| + +```json +{ + "throw": { + "type": "https://serverlessworkflow.io/spec/errors/runtime", + "status": 400, + "detail": "${ $CONST.localizedErrorDetail }" + } +} +``` + + | ++ +```yaml +throw: + type: https://serverlessworkflow.io/spec/errors/runtime + status: 400 + detail: ${ $CONST.localizedErrorDetail } +``` + + | +
| JSON | -YAML | -
|---|---|
| +In ServerlessWorkflow, you have the flexibility to define error handling strategies using error handlers, policies, and outcome definitions. -```json -{ -"errors": "file://documents/reusable/errors.json" -} -``` +Errors can be configured at both the state and action levels, allowing you to tailor error handling to specific components within your workflow. - | -+When choosing an error handling strategy, consider your workflow requirements and strike a balance between simplicity, maintainability, and flexibility. Choose the approach that best fits the needs of your workflow to ensure effective error management. -```yaml -errors: file://documents/reusable/errors.json -``` +##### Inline Error Handling - | -
| ```yaml -errors: - - name: Service not found error - code: '404' - description: Server has not found anything matching the provided service endpoint - information +actions: + - name: my-action + functionRef: my-function + onErrors: + - when: + - status: 503 + retry: retry-five-times ``` |
| ```yaml -retries: - - name: first-retry-strategy - delay: PT1M - maxAttempts: 5 - - name: second-retry-strategy - delay: PT10M - maxAttempts: 10 - +errors: + definitions: + - name: service-not-available-error + type: https://serverlessworkflow.io/spec/errors/communication + status: 503 + title: Service Not Available + detail: Failed to contact service, even after multiple retries + handlers: + - name: handle-503 + when: + - status: 503 + retry: retry-five-times + then: + throw: + refName: service-not-available-error +states: + - name: my-state + type: operation + actions: + - name: my-action + functionRef: my-function + onErrors: + - refName: handle-503 ``` |
| ```yaml -actions: - - functionRef: my-first-function - retryRef: first-retry-strategy - nonRetryableErrors: - - SomeErrorOne - - SomeErrorTwo - - functionRef: my-second-function - retryRef: second-retry-strategy - nonRetryableErrors: - - SomeErrorTwo - - SomeErrorThree - - functionRef: my-third-function +errors: + definitions: + - name: service-not-available-error + type: https://serverlessworkflow.io/spec/errors/communication + status: 503 + title: Service Not Available + detail: Failed to contact service, even after multiple retries + handlers: + - name: handle-503 + when: + - status: 503 + retry: retry-five-times + then: + throw: + refName: service-not-available-error + policy: + - name: fault-tolerance + handlers: + - refName: handle-503 +states: + - name: my-state + type: operation + actions: + - name: my-action + functionRef: my-function + onErrors: fault-tolerance ``` |
| JSON | -YAML | -
|---|---|
| +#### Error Outcomes -```json -{ -"retries": [ - { - "name": "first-retry-strategy", - "delay": "PT1M", - "maxAttempts": 5 - }, - { - "name": "second-retry-strategy", - "delay": "PT10M", - "maxAttempts": 10 - }, - { - "name": "no-retry-strategy", - "maxAttempts": 1 - } -] -} -``` +Error outcomes in ServerlessWorkflow provide a flexible mechanism for defining the behavior of the workflow after handling errors. They enable precise error handling strategies tailored to the workflow's requirements, ensuring that errors are managed effectively and workflows can gracefully recover from unexpected situations. - | -+The `compensate` outcome triggers workflow compensation. This outcome allows workflows to execute compensation logic to undo any previously completed actions and restore the system to a consistent state before proceeding to the current state's outcome. It ensures that workflows can recover from errors and maintain data integrity. -```yaml -retries: - - name: first-retry-strategy - delay: PT1M - maxAttempts: 5 - - name: second-retry-strategy - delay: PT10M - maxAttempts: 10 - - name: no-retry-strategy - maxAttempts: 1 +The `end` outcome ends the workflow immediately after handling the error. This outcome is useful when errors indicate unrecoverable situations or when workflows should terminate gracefully after encountering specific errors. -``` +The `transition` outcome instructs the workflow to transition to the specified state when the error is handled. This outcome is particularly useful for redirecting the workflow to alternative paths or recovery mechanisms based on the encountered error. - | -
| JSON | -YAML | -
|---|---|
| +#### Error Bubbling -```json -{ - "actions": [ - { - "functionRef": "my-first-function", - "retryRef": "first-retry-strategy", - "nonRetryableErrors": ["SomeErrorOne", "SomeErrorTwo"] - }, - { - "functionRef": "my-second-function", - "retryRef": "second-retry-strategy", - "nonRetryableErrors": ["SomeErrorTwo", "SomeErrorThree"] - }, - { - "functionRef": "my-thrid-function" - }, - { - "functionRef": "my-fourth-function", - "retryRef": "no-retry-strategy" - } - ] -} -``` - - | -+Error bubbling within ServerlessWorkflow describes the process by which an unhandled or rethrown error propagates or "bubbles up" from its current location to its parent component, typically the state in which it originated. This mechanism ensures that errors are managed and handled effectively within the workflow hierarchy, maintaining consistent error handling and workflow behavior. -```yaml -actions: - - functionRef: my-first-function - retryRef: first-retry-strategy - nonRetryableErrors: - - SomeErrorOne - - SomeErrorTwo - - functionRef: my-second-function - retryRef: second-retry-strategy - nonRetryableErrors: - - SomeErrorTwo - - SomeErrorThree - - functionRef: my-third-function - - functionRef: my-fourth-function - retryRef: no-retry-strategy - -``` +When an error arises within a workflow, it initially occurs at the lowest level of execution, such as within an action. If the error remains unhandled or uncaught at this level, it ascends through the workflow's structure until it reaches the parent component of the location where the error originated. If the error persists and is not addressed at the state level, it ultimately terminates the workflow. - | -