kwill.anomkit — dev.kwill/anomkit 1.0.3

Utility functions for working with anomaly maps.

! clj/s

(! anomaly)

Throw anomaly as an ExceptionInfo.

?! clj/s

(?! x)

(?! x & {:keys [extra-data]})

Throw x if it is an anomaly, else x.

anomaly clj/s

(anomaly category)

(anomaly category message)

(anomaly category message data)

(anomaly category message data cause-ex)

Returns an anomaly map constructed from category and, optionally, message.

anomaly? clj/s

(anomaly? x)

Returns true if x is an anomaly.

busy clj/s

(busy message)

(busy message data)

(busy message data cause-ex)

backoff and retry

busy! clj/s

(busy! message)

(busy! message data)

(busy! message data cause-ex)

backoff and retry, throwing

busy? clj/s

(busy? x)

categories clj/s

Set of all anomaly categories.

category clj/s

(category x)

Returns the anomaly category of x.

category->http-status clj/s

A default mapping from anomaly category to an HTTP status code. Note that a single category can map to multiple HTTP status codes.

category-from-http-status clj/s

(category-from-http-status http-status)

(category-from-http-status http-status default-category)

conflict clj/s

(conflict message)

(conflict message data)

(conflict message data cause-ex)

coordinate with callee

conflict! clj/s

(conflict! message)

(conflict! message data)

(conflict! message data cause-ex)

coordinate with callee, throwing

conflict? clj/s

(conflict? x)

default-ex->anomaly-converters clj/s

default-ex-anomaly clj/s

(default-ex-anomaly {:keys [throwable]})

ex clj/s

(ex anomaly)

ex->anomaly clj/s

(ex->anomaly throwable)

(ex->anomaly throwable {:keys [converters default-converter]})

Returns an anomaly map from the given throwable. Optionally takes an argument map of the following keys: converters: Seq of functions where each function takes a map containing the throwable under the :throwable key and returns an anomaly map or nil if no anomaly can be produced from the converter. Defaults to default-ex->anomaly-converters. default-converter: The converter function called when no converter in :converters returns an anomaly map. Defaults to default-ex-anomaly.

ex-type->anomaly clj/s multimethod

fault clj/s

(fault message)

(fault message data)

(fault message data cause-ex)

fix callee bug

fault! clj/s

(fault! message)

(fault! message data)

(fault! message data cause-ex)

fix callee bug, throwing

fault? clj/s

(fault? x)

forbidden clj/s

(forbidden message)

(forbidden message data)

(forbidden message data cause-ex)

fix caller creds

forbidden! clj/s

(forbidden! message)

(forbidden! message data)

(forbidden! message data cause-ex)

fix caller creds, throwing

forbidden? clj/s

(forbidden? x)

http-status->category clj/s

Map of HTTP status code to anomaly category.

incorrect clj/s

(incorrect message)

(incorrect message data)

(incorrect message data cause-ex)

fix caller bug

incorrect! clj/s

(incorrect! message)

(incorrect! message data)

(incorrect! message data cause-ex)

fix caller bug

incorrect? clj/s

(incorrect? x)

interrupted clj/s

(interrupted message)

(interrupted message data)

(interrupted message data cause-ex)

stop interrupting

interrupted! clj/s

(interrupted! message)

(interrupted! message data)

(interrupted! message data cause-ex)

stop interrupting, throwing

interrupted? clj/s

(interrupted? x)

message clj/s

(message x)

Returns the anomaly message of x.

not-found clj/s

(not-found message)

(not-found message data)

(not-found message data cause-ex)

fix caller noun

not-found! clj/s

(not-found! message)

(not-found! message data)

(not-found! message data cause-ex)

fix caller noun, throwing

not-found? clj/s

(not-found? x)

public-data clj/s

(public-data anom-data)

Returns a map of the public data from anom-data.

retryable-categories clj/s

Set of anomaly categories that are retryable.

retryable? clj/s

(retryable? anomaly)

Returns true if a replay of the same activity might reasonably lead to a different outcome.

some clj/s

(some x)

Returns x when x is an anomaly, else nil.

unavailable clj/s

(unavailable message)

(unavailable message data)

(unavailable message data cause-ex)

make sure callee healthy

unavailable! clj/s

(unavailable! message)

(unavailable! message data)

(unavailable! message data cause-ex)

make sure callee healthy, throwing

unavailable? clj/s

(unavailable? x)

unsupported clj/s

(unsupported message)

(unsupported message data)

(unsupported message data cause-ex)

fix caller verb

unsupported! clj/s

(unsupported! message)

(unsupported! message data)

(unsupported! message data cause-ex)

fix caller verb, throwing

unsupported? clj/s

(unsupported? x)

with-ex clj/s

(with-ex anomaly ex)

Associates ex with the anomaly.

with-public-ks clj/s

(with-public-ks anom-data ks)

Adds ks to the set of public keys for anom-data.