state-flow.core — nubank/state-flow 1.12.1

add-desc-and-meta clj macro

(add-desc-and-meta [fname & rest] desc meta)

as-step-fn clj

(as-step-fn flow)

Transform a flow step into a state transition function

description->string clj

(description->string description)

flow clj macro

(flow description & flows)

Defines a flow

get-description clj

(get-description)

pop-meta clj

probe clj

(probe state check-fn)

(probe state
       check-fn
       {:keys [sleep-time times-to-try]
        :or {sleep-time sleep-time times-to-try times-to-try}})

evaluates state repeatedly with check-fn until check-fn succeeds or we try too many times

push-meta clj

(push-meta description)

retry clj

(retry times pred? lazy-seq)

Tries at most n times, returns a vector with true and first element that succeeded or false and result of the first try

run clj

(run flow initial-state)

run! clj

(run! flow initial-state)

Like run, but prints a log and throws error when flow fails with an exception

run* clj

(run* {:keys [init cleanup runner]
       :or {init (constantly {}) cleanup identity runner run!}}
      flow)

Run a flow with specified parameters

Receives optional parameter maps init, a function with no arguments that returns the initial state. cleanup, function receiving the final state to perform cleanup if necessary runner, function that will receive a flow and an initial state and execute the flow

sleep-time clj

times-to-try clj

update-description clj

(update-description old new)

verify clj macro

(verify desc left-value right-value)

If left-value is a state, do fact probing. Otherwise, regular fact checking. Push and pop descriptions (same behaviour of flow)

verify-probe clj macro

(verify-probe desc state right-value metadata)

Given a fact description, a state and a right-value, returns a State that runs left up to times-to-retry times every sleep-time ms until left-value equals right value.