probo/pkg/riskmanagement/mermaid.go

// Copyright (c) 2026 Probo Inc <hello@probo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

package riskmanagement

import (
	"context"
	"fmt"
	"strings"

	"go.gearno.de/kit/pg"
	"go.probo.inc/probo/pkg/coredata"
	"go.probo.inc/probo/pkg/gid"
)

func (s *Service) BuildScopeMermaidChart(ctx context.Context, scope coredata.Scoper, scopeID gid.GID) (string, error) {
	var (
		nodes      coredata.RiskAssessmentNodes
		boundaries coredata.RiskAssessmentBoundaries
		processes  coredata.RiskAssessmentProcesses
		threats    coredata.RiskAssessmentThreats
	)

	err := s.pg.WithConn(ctx, func(ctx context.Context, conn pg.Querier) error {
		if err := nodes.LoadAllByRiskAssessmentScopeID(ctx, conn, scope, scopeID); err != nil {
			return fmt.Errorf("cannot load nodes: %w", err)
		}

		if err := boundaries.LoadAllByRiskAssessmentScopeID(ctx, conn, scope, scopeID); err != nil {
			return fmt.Errorf("cannot load boundaries: %w", err)
		}

		if err := processes.LoadAllByRiskAssessmentScopeID(ctx, conn, scope, scopeID); err != nil {
			return fmt.Errorf("cannot load processes: %w", err)
		}

		if err := threats.LoadAllByRiskAssessmentScopeID(ctx, conn, scope, scopeID); err != nil {
			return fmt.Errorf("cannot load threats: %w", err)
		}

		return nil
	})
	if err != nil {
		return "", err
	}

	return buildScopeMermaidChart(nodes, boundaries, processes, threats), nil
}

func buildScopeMermaidChart(
	nodes coredata.RiskAssessmentNodes,
	boundaries coredata.RiskAssessmentBoundaries,
	processes coredata.RiskAssessmentProcesses,
	threats coredata.RiskAssessmentThreats,
) string {
	if len(nodes) == 0 && len(boundaries) == 0 {
		return ""
	}

	nodeAlias := make(map[gid.GID]string, len(nodes))
	for i, n := range nodes {
		nodeAlias[n.ID] = fmt.Sprintf("n%d", i)
	}

	boundaryAlias := make(map[gid.GID]string, len(boundaries))
	for i, bnd := range boundaries {
		boundaryAlias[bnd.ID] = fmt.Sprintf("b%d", i)
	}

	// Group boundaries by their parent so nested boundaries become nested subgraphs.
	childBoundaries := make(map[gid.GID]coredata.RiskAssessmentBoundaries)

	var rootBoundaries coredata.RiskAssessmentBoundaries

	for _, bnd := range boundaries {
		if bnd.ParentBoundaryID != nil {
			if _, ok := boundaryAlias[*bnd.ParentBoundaryID]; ok {
				childBoundaries[*bnd.ParentBoundaryID] = append(childBoundaries[*bnd.ParentBoundaryID], bnd)
				continue
			}
		}

		rootBoundaries = append(rootBoundaries, bnd)
	}

	// Group nodes by the boundary that contains them; nodes without a
	// boundary (or referencing an unknown one) are rendered at the top level.
	nodesByBoundary := make(map[gid.GID]coredata.RiskAssessmentNodes)

	var rootNodes coredata.RiskAssessmentNodes

	for _, n := range nodes {
		if n.BoundaryID != nil {
			if _, ok := boundaryAlias[*n.BoundaryID]; ok {
				nodesByBoundary[*n.BoundaryID] = append(nodesByBoundary[*n.BoundaryID], n)
				continue
			}
		}

		rootNodes = append(rootNodes, n)
	}

	var b strings.Builder
	b.WriteString("flowchart LR\n")

	// class statements must live at the flowchart level, not inside a
	// subgraph block, so collect them and emit once all shapes are written.
	var classLines []string

	emitNode := func(n *coredata.RiskAssessmentNode, indent string) {
		id := nodeAlias[n.ID]
		fmt.Fprintf(&b, "%s%s\n", indent, mermaidNodeShape(n.NodeType, id, n.Name))
		classLines = append(classLines, fmt.Sprintf("  class %s %s", id, mermaidNodeClass(n.NodeType)))
	}

	var emitBoundary func(bnd *coredata.RiskAssessmentBoundary, indent string)

	emitBoundary = func(bnd *coredata.RiskAssessmentBoundary, indent string) {
		alias := boundaryAlias[bnd.ID]
		fmt.Fprintf(&b, "%ssubgraph %s[\"%s\"]\n", indent, alias, escapeMermaidLabel(bnd.Name))

		inner := indent + "  "
		for _, child := range childBoundaries[bnd.ID] {
			emitBoundary(child, inner)
		}

		for _, n := range nodesByBoundary[bnd.ID] {
			emitNode(n, inner)
		}

		fmt.Fprintf(&b, "%send\n", indent)

		classLines = append(classLines, fmt.Sprintf("  class %s nodeBoundary", alias))
	}

	for _, bnd := range rootBoundaries {
		emitBoundary(bnd, "  ")
	}

	for _, n := range rootNodes {
		emitNode(n, "  ")
	}

	for _, line := range classLines {
		b.WriteString(line + "\n")
	}

	for _, p := range processes {
		src, srcOK := nodeAlias[p.SourceNodeID]

		dst, dstOK := nodeAlias[p.TargetNodeID]
		if !srcOK || !dstOK {
			continue
		}

		fmt.Fprintf(&b, "  %s -- \"%s\" --> %s\n", src, escapeMermaidLabel(p.Name), dst)
	}

	processTarget := make(map[gid.GID]gid.GID, len(processes))
	for _, p := range processes {
		processTarget[p.ID] = p.TargetNodeID
	}

	for i, t := range threats {
		target, ok := processTarget[t.ProcessID]
		if !ok {
			continue
		}

		targetAlias, ok := nodeAlias[target]
		if !ok {
			continue
		}

		tid := fmt.Sprintf("t%d", i)
		label := escapeMermaidLabel(fmt.Sprintf("%s (%s)", t.Name, t.Category))
		fmt.Fprintf(&b, "  %s{{\"%s\"}}\n", tid, label)
		fmt.Fprintf(&b, "  class %s nodeThreat\n", tid)
		fmt.Fprintf(&b, "  %s -.-> %s\n", tid, targetAlias)
	}

	b.WriteString("  classDef nodeEntity fill:#dbeafe,stroke:#1d4ed8,color:#1e3a8a\n")
	b.WriteString("  classDef nodeBoundary fill:#ffffff,stroke:#b45309,color:#78350f\n")
	b.WriteString("  classDef nodeAsset fill:#e5e7eb,stroke:#374151,color:#111827\n")
	b.WriteString("  classDef nodeData fill:#dcfce7,stroke:#15803d,color:#14532d\n")
	b.WriteString("  classDef nodeThreat fill:#fee2e2,stroke:#b91c1c,color:#7f1d1d\n")

	return strings.TrimRight(b.String(), "\n")
}

func mermaidNodeShape(t coredata.RiskAssessmentNodeType, id, name string) string {
	label := `"` + escapeMermaidLabel(name) + `"`

	switch t {
	case coredata.RiskAssessmentNodeTypeEntity:
		return fmt.Sprintf("%s([%s])", id, label)
	case coredata.RiskAssessmentNodeTypeData:
		return fmt.Sprintf("%s[(%s)]", id, label)
	case coredata.RiskAssessmentNodeTypeAsset:
		fallthrough
	default:
		return fmt.Sprintf("%s[%s]", id, label)
	}
}

func mermaidNodeClass(t coredata.RiskAssessmentNodeType) string {
	switch t {
	case coredata.RiskAssessmentNodeTypeEntity:
		return "nodeEntity"
	case coredata.RiskAssessmentNodeTypeData:
		return "nodeData"
	case coredata.RiskAssessmentNodeTypeAsset:
		fallthrough
	default:
		return "nodeAsset"
	}
}

var mermaidLabelReplacer = strings.NewReplacer(
	"&", "&amp;",
	`"`, "#quot;",
	"<", "&lt;",
	">", "&gt;",
	"\r\n", " ",
	"\n", " ",
)

func escapeMermaidLabel(s string) string {
	return mermaidLabelReplacer.Replace(s)
}