Errors

Error codes and what they mean.

This page documents known errors that may be encountered when using Resonate and how to troubleshoot them.

If you believe your issue is not covered here, reach out in Discord to discuss.

Known errors will likely have an error code associated with them and a short error message.

Troubleshooting steps are categorized by error code ranges:

Server request errors (40000-49999)
Server errors (50000-59999)
Python SDK errors (1000-1099)
TypeScript SDK errors (1100-1199)

Server request errors#

These are known errors you may encounter when making requests to the Resonate Server API.

Range: 40000-49999

Request errors signify problems with the request. Generally, retrying the request will not resolve the issue.

Error Schema

When an error occurs, the response body will contain the following information.

code

{
  "error": {
    "code": 5002,
    "message": "failed to update promise",
    "details": [
      {
        "@type": "ServerError",
        "message": "attempt to write a readonly database",
        "domain": "server",
        "metadata": {
          "url": "https://docs.resonatehq.io/reference/error-codes#5002"
        }
      }
    ]
  }
}

The code field can be used to programmatically identify the error. The message and details provide a human readable description of what went wrong.

The details provide structured diagnostic data such as the originating subsystem and links to documentation which can assist in debugging and troubleshooting.

If the problem persists, open a GitHub issue with details, including the error code and steps to reproduce. Or reach out via Discord for support.

40000#

There was a validation error affecting one or more fields.

40300#

The promise has already been resolved. Once a promise is resolved it can no longer be modified.

40301#

The promise has already been rejected. Once a promise is rejected it can no longer be modified.

40302#

The promise has already been canceled. Once a promise is canceled it can no longer be modified.

40303#

The promise has already timed out. Once a promise is timed out it can no longer be modified.

40304#

The lock has already been acquired. Once a lock is acquired it can no longer be acquired.

40305#

The task has already been claimed. Once a task has been claimed it can no longer be claimed.

40306#

The task has already been completed. Once a task has been completed it can no longer be claimed.

40307#

A task was attempted to be claimed with the wrong counter.

40308#

A task was attempted to be claimed or completed, but the task is in an invalid state.

40400#

A promise with the provided id could not be found.

40401#

A schedule with the provided id could not be found.

40402#

A lock with the provided id could not be found.

40403#

A task with the provided id could not be found.

40404#

A promise with the provided id does not specify a required recv.

40900#

A promise with the provided id already exists.

40901#

A schedule with the provided id already exists. |

Server errors#

These are

Range: 50000-59999

Server errors represent transient or systemic problems that prevent the request from being processed. Retrying the request may resolve the issue.

If the problem persists, open a GitHub issue with details, including the error code and steps to reproduce. Or reach out via Discord for support.

50000#

An unknown internal server error occurred. Please open an issue.

50001#

There was a failure related to the echo subsystem.

50002#

There was a failure related to the match subsystem.

50003#

There was a failure related to the queue subsystem.

50004#

There was a failure related to the store subsystem.

50300#

The system is shutting down.

50301#

The API submission queue is full. Please try again later.

50302#

The AIO submission queue is full. Please try again later.

50303#

The scheduler queue is full. Please try again later.

Python SDK errors#

Range: 1000 - 1099

These are known errors you may encounter when using the Python SDK.

SDK update required

And update is required to the Python SDK to support these error codes.

TypeScript SDK errors#

Range: 1100 - 1199

These are known errors you may encounter when using the TypeScript SDK.

If the problem persists, open a GitHub issue with details, including the error code and steps to reproduce. Or reach out via Discord for support.

1100#

REGISTRY_VERSION_INVALID

Function version must be greater than zero (x provided)

1101#

REGISTRY_NAME_REQUIRED

Function name is required

1102#

REGISTRY_FUNCTION_ALREADY_REGISTERED

Function 'x' (version y) is already registered [under 'u']

1103#

REGISTRY_FUNCTION_NOT_REGISTERED

Function 'x' (version y) is not registered. Will drop.

1104#

DEPENDENCY_ALREADY_REGISTERED

Dependency 'x' is already registered

1105#

DEPENDENCY_NOT_REGISTERED

Dependency 'x' is not registered. Will drop.

1106#

ENCODING_ARGS_UNENCODEABLE

Function arguments cannot be encoded.

1199#

SERVER_ERROR

An error occurred on the server. Please check for additional error codes for more details.