manifest/me.ahoo.wow.manifest/FrameworkErrors

FrameworkErrors

The framework's error codes and the HTTP status each is answered with: the one table the Manifest's top-level errors (Manifest.errors) and the edge's problem+json answers both read.

The query codes are answered by the query routes (POST /{context}/{aggregate}/{model}/query).

The call code (CALL_COMMAND_FORBIDDEN) is answered by the internal port alone, to a service's synchronous call.

This table is the framework's codes as the JSON contract states them, each with its HTTP status and description; the codes the modules produce are wow-api's FrameworkCodes, which this module cannot depend on, and a test of this module checks that the two name the same set. A domain rejection's code is not here: it is answered with DOMAIN_REJECTION_STATUS unless the host configures another status for it.

The TypeScript client's code table (@ahoo-wang/wow-client, FrameworkErrorCodes) is checked against this one through the snapshot framework-errors.json of this module's tests: changing a code or a status here changes that snapshot, and the client's test fails until its table follows.

Properties

AGGREGATE_DELETED

const val AGGREGATE_DELETED: String

AGGREGATE_EXISTS

const val AGGREGATE_EXISTS: String

AGGREGATE_FORBIDDEN

const val AGGREGATE_FORBIDDEN: String

AGGREGATE_NOT_FOUND

const val AGGREGATE_NOT_FOUND: String

AGGREGATE_VERSION_MISMATCH

const val AGGREGATE_VERSION_MISMATCH: String

ALL

val ALL: List<ErrorManifest>

Every framework code, in the order of the status table, each with what a retry may do.

AUTH_FORBIDDEN

const val AUTH_FORBIDDEN: String

AUTH_UNAUTHENTICATED

const val AUTH_UNAUTHENTICATED: String

BY_CODE

val BY_CODE: Map<String, ErrorManifest>

ALL by code.

CALL_COMMAND_FORBIDDEN

const val CALL_COMMAND_FORBIDDEN: String

COMMAND_BUSY

const val COMMAND_BUSY: String

COMMAND_CONTENDED

const val COMMAND_CONTENDED: String

COMMAND_FAILED

const val COMMAND_FAILED: String

COMMAND_INVALID

const val COMMAND_INVALID: String

COMMAND_MALFORMED

const val COMMAND_MALFORMED: String

COMMAND_REFUSED

const val COMMAND_REFUSED: String

COMMAND_REQUEST_ID_REUSED

const val COMMAND_REQUEST_ID_REUSED: String

COMMAND_UNDECLARED_EVENT

const val COMMAND_UNDECLARED_EVENT: String

COMMAND_UNHANDLED

const val COMMAND_UNHANDLED: String

COMMAND_UNKNOWN

const val COMMAND_UNKNOWN: String

DOMAIN_REJECTION_STATUS

const val DOMAIN_REJECTION_STATUS: Int = 422

The status of a domain rejection, a code the domain chose, unless the host configures another for the code.

INTERNAL_ERROR_STATUS

const val INTERNAL_ERROR_STATUS: Int = 500

The status of a framework code ALL does not list.

LEDGER_STALE

const val LEDGER_STALE: String

NODE_CLOSING

const val NODE_CLOSING: String

NODE_STANDBY

const val NODE_STANDBY: String

PEER_UNAVAILABLE

const val PEER_UNAVAILABLE: String

PRECONDITION_FAILED_STATUS

const val PRECONDITION_FAILED_STATUS: Int = 412

The status of AGGREGATE_VERSION_MISMATCH when the request carried If-Match.

PREFIX

const val PREFIX: String

The prefix every framework code, and no domain code, starts with.

QUERY_BUSY

const val QUERY_BUSY: String

QUERY_DATASET_NOT_FOUND

const val QUERY_DATASET_NOT_FOUND: String

QUERY_DATASET_UNAVAILABLE

const val QUERY_DATASET_UNAVAILABLE: String

QUERY_FAILED

const val QUERY_FAILED: String

QUERY_INVALID

const val QUERY_INVALID: String

QUERY_MALFORMED

const val QUERY_MALFORMED: String

QUERY_MIN_VERSION_NOT_REACHED

const val QUERY_MIN_VERSION_NOT_REACHED: String

QUERY_NOT_FOUND

const val QUERY_NOT_FOUND: String

QUERY_TIMEOUT

const val QUERY_TIMEOUT: String

QUERY_TOO_MANY_GROUPS

const val QUERY_TOO_MANY_GROUPS: String

REQUEST_MALFORMED

const val REQUEST_MALFORMED: String

RETRY_AFTER_SECONDS

const val RETRY_AFTER_SECONDS: Int = 1

The Retry-After of every framework code a retry may get past: a store restarting or failing over, a busy lane or a closing node is back within seconds, and a client that waits a second spreads its retries rather than repeating them at once.

RETRY_ATTEMPTS

const val RETRY_ATTEMPTS: Int = 5

How often a client sends a request at most, the first time included, by default, when a retry may get past its error: the Kotlin client's RetryPolicy.DEFAULT and the TypeScript client's resumes alike.

RETRY_BACKOFF_MILLIS

const val RETRY_BACKOFF_MILLIS: Int = 200

The wait before a client's first retry without a Retry-After, doubled at each attempt, by default.

RETRY_MAX_WAIT_SECONDS

const val RETRY_MAX_WAIT_SECONDS: Int = 5

The longest wait before a retry, by default: a backoff stops doubling there, a longer Retry-After fails.

ROUTE_MALFORMED

const val ROUTE_MALFORMED: String

SCHEDULE_JOB_INVALID

const val SCHEDULE_JOB_INVALID: String

SCHEDULE_NOT_DUE

const val SCHEDULE_NOT_DUE: String

STORAGE_UNAVAILABLE

const val STORAGE_UNAVAILABLE: String

SUBSCRIPTION_PARKED

const val SUBSCRIPTION_PARKED: String

TITLES

val TITLES: Map<String, String>

The short title of each framework code, a problem's title (RFC 9457): a summary that is the same for every occurrence of the code. A code's description in ALL explains it further, in the Manifest and the reference.

WAIT_INVALID

const val WAIT_INVALID: String

WAIT_TIMEOUT

const val WAIT_TIMEOUT: String

Functions

problemOf

@JvmStatic

@JvmOverloads

fun problemOf(code: String, message: String, result: CommandResult? = null, cause: Throwable? = null): WowProblemException

The exception of a request a boundary did not carry out for the framework code, said as message: its status, retry and Retry-After as ALL declares them, a code it does not list a 500 no retry gets past. Each boundary (the in-process clients and queries, a client's transport) maps its own failures with it, once.