// Copyright (c) Microsoft. All rights reserved.
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using Microsoft.Shared.Diagnostics;
namespace Microsoft.Agents.AI.Workflows;
///
/// Provides visualization utilities for workflows using Graphviz DOT format.
///
public static class WorkflowVisualizer
{
///
/// Export the workflow as a DOT format digraph string.
///
/// A string representation of the workflow in DOT format.
public static string ToDotString(this Workflow workflow)
{
Throw.IfNull(workflow);
var lines = new List
{
"digraph Workflow {",
" rankdir=TD;", // Top to bottom layout
" node [shape=box, style=filled, fillcolor=lightblue];",
" edge [color=black, arrowhead=vee];",
""
};
// Emit the top-level workflow nodes/edges
EmitWorkflowDigraph(workflow, lines, " ");
// Emit sub-workflows hosted by WorkflowExecutor as nested clusters
EmitSubWorkflowsDigraph(workflow, lines, " ");
lines.Add("}");
return string.Join("\n", lines);
}
///
/// Converts the specified into a Mermaid.js diagram representation.
///
/// This method generates a textual representation of the workflow in the Mermaid.js format,
/// which can be used to visualize workflows as diagrams. The output is formatted with indentation for
/// readability.
/// The workflow to be converted into a Mermaid.js diagram. Cannot be null.
/// A string containing the Mermaid.js representation of the workflow.
public static string ToMermaidString(this Workflow workflow)
{
List lines = ["flowchart TD"];
EmitWorkflowMermaid(workflow, lines, " ");
return string.Join("\n", lines);
}
#region Private Implementation
private static void EmitWorkflowDigraph(Workflow workflow, List lines, string indent, string? ns = null)
{
string MapId(string id) => ns != null ? $"{ns}/{id}" : id;
// Add start node
var startExecutorId = workflow.StartExecutorId;
lines.Add($"{indent}\"{MapId(startExecutorId)}\" [fillcolor=lightgreen, label=\"{startExecutorId}\\n(Start)\"];");
// Add other executor nodes
foreach (var executorId in workflow.ExecutorBindings.Keys)
{
if (executorId != startExecutorId)
{
lines.Add($"{indent}\"{MapId(executorId)}\" [label=\"{executorId}\"];");
}
}
// Compute and emit fan-in nodes
var fanInDescriptors = ComputeFanInDescriptors(workflow);
if (fanInDescriptors.Count > 0)
{
lines.Add("");
foreach (var (nodeId, _, _) in fanInDescriptors)
{
lines.Add($"{indent}\"{MapId(nodeId)}\" [shape=ellipse, fillcolor=lightgoldenrod, label=\"fan-in\"];");
}
}
// Emit fan-in edges
foreach (var (nodeId, sources, target) in fanInDescriptors)
{
foreach (var src in sources)
{
lines.Add($"{indent}\"{MapId(src)}\" -> \"{MapId(nodeId)}\";");
}
lines.Add($"{indent}\"{MapId(nodeId)}\" -> \"{MapId(target)}\";");
}
// Emit normal edges
foreach (var (src, target, isConditional, label) in ComputeNormalEdges(workflow))
{
// Build edge attributes
var attributes = new List();
// Add style for conditional edges
if (isConditional)
{
attributes.Add("style=dashed");
}
// Add label (custom label or default "conditional" for conditional edges)
if (label != null)
{
attributes.Add($"label=\"{EscapeDotLabel(label)}\"");
}
else if (isConditional)
{
attributes.Add("label=\"conditional\"");
}
// Combine attributes
var attrString = attributes.Count > 0 ? $" [{string.Join(", ", attributes)}]" : "";
lines.Add($"{indent}\"{MapId(src)}\" -> \"{MapId(target)}\"{attrString};");
}
}
private static void EmitSubWorkflowsDigraph(Workflow workflow, List lines, string indent)
{
foreach (var kvp in workflow.ExecutorBindings)
{
var execId = kvp.Key;
var registration = kvp.Value;
// Check if this is a WorkflowExecutor with a nested workflow
if (TryGetNestedWorkflow(registration, out var nestedWorkflow))
{
var subgraphId = $"cluster_{ComputeShortHash(execId)}";
lines.Add($"{indent}subgraph {subgraphId} {{");
lines.Add($"{indent} label=\"sub-workflow: {execId}\";");
lines.Add($"{indent} style=dashed;");
// Emit the nested workflow inside this cluster using a namespace
EmitWorkflowDigraph(nestedWorkflow, lines, $"{indent} ", execId);
// Recurse into deeper nested sub-workflows
EmitSubWorkflowsDigraph(nestedWorkflow, lines, $"{indent} ");
lines.Add($"{indent}}}");
}
}
}
private static void EmitWorkflowMermaid(Workflow workflow, List lines, string indent, string? ns = null)
{
// Build a mapping from raw IDs to Mermaid-safe node aliases that preserve
// as much of the original ID as possible for readability.
// Mermaid node IDs cannot contain spaces, dots, pipes, or most special characters.
var aliasMap = new Dictionary();
var usedAliases = new HashSet(StringComparer.Ordinal);
string GetSafeId(string id)
{
var key = ns != null ? $"{ns}/{id}" : id;
if (!aliasMap.TryGetValue(key, out var alias))
{
alias = SanitizeMermaidNodeId(key);
// Handle collisions by appending a numeric suffix
if (!usedAliases.Add(alias))
{
var i = 2;
while (!usedAliases.Add($"{alias}_{i}"))
{
if (i >= 10_000)
{
throw new InvalidOperationException($"Unable to generate a unique Mermaid node ID for '{key}'.");
}
i++;
}
alias = $"{alias}_{i}";
}
aliasMap[key] = alias;
}
return alias;
}
// Add start node
var startExecutorId = workflow.StartExecutorId;
lines.Add($"{indent}{GetSafeId(startExecutorId)}[\"{EscapeMermaidLabel(startExecutorId)} (Start)\"];");
// Add other executor nodes
foreach (var executorId in workflow.ExecutorBindings.Keys)
{
if (executorId != startExecutorId)
{
lines.Add($"{indent}{GetSafeId(executorId)}[\"{EscapeMermaidLabel(executorId)}\"];");
}
}
// Compute and emit fan-in nodes
var fanInDescriptors = ComputeFanInDescriptors(workflow);
if (fanInDescriptors.Count > 0)
{
lines.Add("");
foreach (var (nodeId, _, _) in fanInDescriptors)
{
lines.Add($"{indent}{GetSafeId(nodeId)}((fan-in))");
}
}
// Emit fan-in edges
foreach (var (nodeId, sources, target) in fanInDescriptors)
{
foreach (var src in sources)
{
lines.Add($"{indent}{GetSafeId(src)} --> {GetSafeId(nodeId)};");
}
lines.Add($"{indent}{GetSafeId(nodeId)} --> {GetSafeId(target)};");
}
// Emit normal edges
foreach (var (src, target, isConditional, label) in ComputeNormalEdges(workflow))
{
if (isConditional)
{
string effectiveLabel = label != null ? EscapeMermaidLabel(label) : "conditional";
// Conditional edge, with user label or default
lines.Add($"{indent}{GetSafeId(src)} -. {effectiveLabel} .-> {GetSafeId(target)};");
}
else if (label != null)
{
// Regular edge with label
lines.Add($"{indent}{GetSafeId(src)} -->|{EscapeMermaidLabel(label)}| {GetSafeId(target)};");
}
else
{
// Regular edge without label
lines.Add($"{indent}{GetSafeId(src)} --> {GetSafeId(target)};");
}
}
}
private static List<(string NodeId, List Sources, string Target)> ComputeFanInDescriptors(Workflow workflow)
{
var result = new List<(string, List, string)>();
var seen = new HashSet();
foreach (var edgeGroup in workflow.Edges.Values.SelectMany(x => x))
{
if (edgeGroup.Kind == EdgeKind.FanIn && edgeGroup.FanInEdgeData != null)
{
var fanInData = edgeGroup.FanInEdgeData;
var target = fanInData.SinkId;
var sources = fanInData.SourceIds.ToList();
var digest = ComputeFanInDigest(target, sources);
var nodeId = $"fan_in_{target}_{digest}";
// Avoid duplicates - the same fan-in edge group might appear in multiple source executor lists
if (seen.Add(nodeId))
{
result.Add((nodeId, sources.OrderBy(x => x, StringComparer.Ordinal).ToList(), target));
}
}
}
return result;
}
private static List<(string Source, string Target, bool IsConditional, string? Label)> ComputeNormalEdges(Workflow workflow)
{
var edges = new List<(string, string, bool, string?)>();
foreach (var edgeGroup in workflow.Edges.Values.SelectMany(x => x))
{
if (edgeGroup.Kind == EdgeKind.FanIn)
{
continue;
}
switch (edgeGroup.Kind)
{
case EdgeKind.Direct when edgeGroup.DirectEdgeData != null:
var directData = edgeGroup.DirectEdgeData;
var isConditional = directData.Condition != null;
var label = directData.Label;
edges.Add((directData.SourceId, directData.SinkId, isConditional, label));
break;
case EdgeKind.FanOut when edgeGroup.FanOutEdgeData != null:
var fanOutData = edgeGroup.FanOutEdgeData;
foreach (var sinkId in fanOutData.SinkIds)
{
edges.Add((fanOutData.SourceId, sinkId, false, fanOutData.Label));
}
break;
}
}
return edges;
}
private static string ComputeFanInDigest(string target, List sources)
{
var sortedSources = sources.OrderBy(x => x, StringComparer.Ordinal).ToList();
var input = target + "|" + string.Join("|", sortedSources);
return ComputeShortHash(input);
}
private static string ComputeShortHash(string input)
{
#if !NET
using var sha256 = SHA256.Create();
var hash = sha256.ComputeHash(Encoding.UTF8.GetBytes(input));
return BitConverter.ToString(hash).Replace("-", "").Substring(0, 8).ToUpperInvariant();
#else
var hash = SHA256.HashData(Encoding.UTF8.GetBytes(input));
return Convert.ToHexString(hash).Substring(0, 8);
#endif
}
private static bool TryGetNestedWorkflow(ExecutorBinding binding, [NotNullWhen(true)] out Workflow? workflow)
{
if (binding.RawValue is Workflow subWorkflow)
{
workflow = subWorkflow;
return true;
}
workflow = null;
return false;
}
///
/// Converts a raw node ID into a Mermaid-safe identifier that preserves as much
/// of the original text as possible. ASCII letters, digits, and underscores are kept
/// as-is (including existing consecutive underscores). All other characters (including
/// non-ASCII letters) are replaced with underscores, with consecutive invalid characters
/// collapsed into a single underscore. A leading digit gets a prefix.
///
private static string SanitizeMermaidNodeId(string id)
{
Throw.IfNull(id);
var sb = new StringBuilder(id.Length);
bool lastWasUnderscore = false;
foreach (var ch in id)
{
bool isAsciiSafe = (ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') || (ch >= '0' && ch <= '9') || ch == '_';
if (isAsciiSafe)
{
sb.Append(ch);
lastWasUnderscore = ch == '_';
}
else if (!lastWasUnderscore)
{
sb.Append('_');
lastWasUnderscore = true;
}
}
// Trim trailing underscore
while (sb.Length > 0 && sb[sb.Length - 1] == '_')
{
sb.Length--;
}
// Mermaid IDs must not start with a digit
if (sb.Length > 0 && sb[0] >= '0' && sb[0] <= '9')
{
sb.Insert(0, "n_");
}
// Guard against empty result (e.g. id was all special chars)
return sb.Length == 0 ? "node" : sb.ToString();
}
// Helper method to escape special characters in DOT labels
private static string EscapeDotLabel(string label)
{
return label.Replace("\"", "\\\"").Replace("\n", "\\n");
}
// Helper method to escape special characters in Mermaid labels
private static string EscapeMermaidLabel(string label)
{
return label
.Replace("&", "&") // Must be first to avoid double-escaping
.Replace("|", "|") // Pipe breaks Mermaid delimiter syntax
.Replace("\"", """) // Quote character
.Replace("<", "<") // Less than
.Replace(">", ">") // Greater than
.Replace("\n", "
") // Newline to HTML break
.Replace("\r", ""); // Remove carriage return
}
#endregion
}