Inspect Flows

View Source

Flow inspection works on canonical %Jido.Flow{} values. It does not run Actions.

Validate Structure Or Targets

{:ok, flow} = Jido.Flow.validate(flow)
{:ok, flow} = Jido.Flow.validate_executable(flow)

validate/1 checks schemas, components, expressions, references, dependencies, and cycles. It is inert and does not check module contracts.

validate_executable/1 also checks each Action and child Flow contract. It still does not execute work.

Read Dependencies

{:ok, dependencies} = Jido.Flow.dependencies(flow)

dependencies["publish"]
#=> %{
#=>   needs: ["approve"],
#=>   references: ["render"],
#=>   effective: ["approve", "render"]
#=> }

needs is explicit author order. references is derived from result references. effective is their sorted union.

Explain A Flow

{:ok, explanation} = Jido.Flow.explain(flow)

The explanation is versioned canonical inspection data. It contains Flow metadata, normalized components, dependencies, output, and semantic identity. It is useful for tooling and review. It is not the stored JSON format.

Compare Semantic Identity

{:ok, identity} = Jido.Flow.semantic_identity(flow)

identity.digest
identity.uuid

Identity uses the canonical semantic form. Runtime compilation data and DSL source locations do not change it. The identity version is 3.

Version 3 hashes canonical values directly, so references remain distinct from literal maps with the same fields. Semantic digests, compilation digests, and derived item and iteration IDs change from version 2. Recompute stored identity values from the canonical Flow. Stored document versions and Jido.Flow.to_map/1 inspection data are unchanged.

Get A Semantic Map

semantic_map = Jido.Flow.to_map(flow)

This deterministic map keeps component declaration order and module values. It is useful for inspection and comparison inside the VM. Use Jido.Flow.Codec for portable storage.

Inspect Native Compilation

{:ok, compiled} = Jido.Flow.compile(flow)

compiled.workflow
compiled.component_index
compiled.output
compiled.source_map
compiled.compilation_digest

Jido.Flow.Compiled is derived runtime data. Treat its fields and native Runic graph as inspection and execution data, not authoring data.