missinterpret.flows.workflow — io.github.missinterpret/flows 1.0.7

load clj

(load workflow)

(load flow-catalog
      {:workflow/keys [defer-load lazy-load args force log-fn] :as rt-args})

Loads and connects the flows in the workflow definition adding the manifold source/sink making it compatible with run unless either defer-load and lazy-load are true.

Note: The force option will always load the workflow definition.

run clj

(run workflow)

(run {:workflow/keys [expand take-range return-vector return-error schema
                      log-fn]
      :or {expand false take-range nil}
      :as workflow}
     runtime-arg)

Executes a loaded workflow returning the results.

Options:

• expand If the runtime argument is a seq the contents of the seq are individually added.

• return-n Returns exactly n values from the workflow results or fails if unable to do so.

• return-nth Returns the nth value of the result if it is a seq, fails if unable to do so.

• repeat-n Injects n copies of the runtime argument.

• put-timeout Sets the amount of time run will wait before considering the operation failed.

• take-timeout Sets the amount of time run will wait before considering the operation failed.

• return-error Returns an anomaly instead of throwing an exception.

validate-schema clj

(validate-schema integrity {:workflow/keys [schema]})

Validates the 'linearized' workflow's schema integrity against the schema arguments.

returns: Invalid: [{integrity map}] Integrity data otherwise

workflow-factory clj

(workflow-factory workflow)

(workflow-factory workflow flow-args)

(workflow-factory flow-catalog
                  {:workflow/keys [definition id schema expand order log-fn]
                   :or {id nil expand false order :linear}
                   :as arg-wf}
                  {:flows/keys [source sink] :as factory-args})

Converts a workflow definition into an entity which is ready for stream operations by using the returned :workflow/source and :workflow/sink arguments.

Topology

Determines the order of flow execution of the definition. The topology is linear unless another ordering is imposed.

Options

• :id Adds the id to the workflow
• :order Sets the topology of the execution order

:linear (default) The topology is in the order provided by the definition vector :interceptor The call stack will match the interceptor-chain calling order when :flow/before-fn and/or :flow/after-fn exist in any of the definitions flows.

• :expand Passes all the results from a sequential value into the downstream flow individually.