feat: add c4 visualizer

NikiforovAll · Jul 31, 2024 · 251c7bb · 251c7bb
1 parent c6f4fa3
commit 251c7bb
Show file tree

Hide file tree

Showing 20 changed files with 226 additions and 91 deletions.
diff --git a/src/Dependify.Cli/Commands/ScanCommand.cs b/src/Dependify.Cli/Commands/ScanCommand.cs
@@ -4,7 +4,6 @@ namespace Dependify.Cli.Commands;
 using Dependify.Cli.Formatters;
 using Dependify.Core;
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 using Microsoft.Extensions.Logging;
 
 internal class ScanCommand(
@@ -129,17 +128,17 @@ private void PrintResult(DependencyGraph graph, ScanCommandSettings settings, st
 
                 var type = node.Type switch
                 {
-                    "Project" => "[aquamarine3]Project[/]",
-                    "Solution" => "[red3]Solution[/]",
-                    "Package" => "[skyblue1]Package[/]",
+                    NodeConstants.Project => "[aquamarine3]Project[/]",
+                    NodeConstants.Solution => "[red3]Solution[/]",
+                    NodeConstants.Package => "[skyblue1]Package[/]",
                     _ => "Unknown"
                 };
 
                 var packagesCountLabel = settings.IncludePackages!.Value
                     ? $"/[royalblue1]{descendants.OfType<PackageReferenceNode>().Count()}[/]"
                     : string.Empty;
 
-                var descendantsLabel = node.Type is not "Package"
+                var descendantsLabel = node.Type is not NodeConstants.Package
                     ? $"[darkgreen]{descendants.OfType<ProjectReferenceNode>().Count()}{packagesCountLabel}[/]"
                     : string.Empty;
 

diff --git a/src/Dependify.Cli/Commands/ShowCommand.cs b/src/Dependify.Cli/Commands/ShowCommand.cs
@@ -5,7 +5,6 @@ namespace Dependify.Cli.Commands;
 using Dependify.Cli.Formatters;
 using Dependify.Core;
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 using Microsoft.Extensions.Logging;
 
 internal class ShowCommand(

diff --git a/src/Dependify.Cli/Formatters/JsonOutputFormatter.cs b/src/Dependify.Cli/Formatters/JsonOutputFormatter.cs
@@ -1,54 +1,25 @@
 namespace Dependify.Cli.Formatters;
 
-using System.Text.Json;
-using System.Text.Json.Serialization;
-using System.Text.Json.Serialization.Metadata;
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
+using Dependify.Core.Serializers;
 
 internal class JsonOutputFormatter(TextWriter textWriter) : IOutputFormatter
 {
-    private static readonly JsonSerializerOptions JsonOptions =
-        new()
-        {
-            WriteIndented = true,
-            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-            TypeInfoResolver = new PolymorphicTypeResolver()
-        };
-
     public void Dispose() => textWriter.Dispose();
 
     public void Write<T>(T data)
     {
-        textWriter.WriteLine(JsonSerializer.Serialize(data, JsonOptions));
-
-        textWriter.Flush();
-    }
+        var graph = data as DependencyGraph;
 
-    internal class PolymorphicTypeResolver : DefaultJsonTypeInfoResolver
-    {
-        public override JsonTypeInfo GetTypeInfo(Type type, JsonSerializerOptions options)
+        if (graph is null)
         {
-            var jsonTypeInfo = base.GetTypeInfo(type, options);
-
-            var baseType = typeof(Node);
-            if (jsonTypeInfo.Type == baseType)
-            {
-                jsonTypeInfo.PolymorphismOptions = new JsonPolymorphismOptions
-                {
-                    TypeDiscriminatorPropertyName = "$type",
-                    IgnoreUnrecognizedTypeDiscriminators = true,
-                    UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FailSerialization,
-                    DerivedTypes =
-                    {
-                        new JsonDerivedType(typeof(SolutionReferenceNode), nameof(SolutionReferenceNode)),
-                        new JsonDerivedType(typeof(ProjectReferenceNode), nameof(ProjectReferenceNode)),
-                        new JsonDerivedType(typeof(PackageReferenceNode), nameof(PackageReferenceNode)),
-                    }
-                };
-            }
-
-            return jsonTypeInfo;
+            textWriter.WriteLine(JsonGraphSerializer.Serialize(data));
+        }
+        else
+        {
+            textWriter.WriteLine(JsonGraphSerializer.ToString(data as DependencyGraph));
         }
+
+        textWriter.Flush();
     }
 }
diff --git a/...li/Formatters/JsonOutputFormatter copy.cs → ....Cli/Formatters/MermaidOutputFormatter.cs b/...li/Formatters/JsonOutputFormatter copy.cs → ....Cli/Formatters/MermaidOutputFormatter.cs
diff --git a/src/Dependify.Core/FileProviderProjectLocator.cs b/src/Dependify.Core/FileProviderProjectLocator.cs
@@ -1,7 +1,6 @@
 namespace Dependify.Core;
 
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 using Microsoft.Extensions.FileProviders;
 using Microsoft.Extensions.Logging;
 

diff --git a/src/Dependify.Core/Graph/DependencyGraph.cs b/src/Dependify.Core/Graph/DependencyGraph.cs
@@ -27,16 +27,18 @@ public IEnumerable<Node> FindAscendants(Node node)
         return this.Edges.Where(edge => edge.End == node).Select(edge => edge.Start).Distinct();
     }
 
-    public DependencyGraph SubGraph(Node node, Func<Node, bool>? filter = default)
+    public DependencyGraph SubGraph(Node node, Predicate<Node>? filter = default)
     {
         var nodes = this.FindAllDescendants(node, filter).Concat([node]).ToList();
 
+        // TODO: bug - fix, filter?.Invoke(edge.End) == true
+
         var edges = this.Edges.Where(edge => nodes.Contains(edge.Start) && filter?.Invoke(edge.End) == true).ToList();
 
         return new DependencyGraph(node, nodes, edges);
     }
 
-    private IEnumerable<Node> FindAllDescendants(Node node, Func<Node, bool>? filter = default)
+    private IEnumerable<Node> FindAllDescendants(Node node, Predicate<Node>? filter = default)
     {
         var nodes = new List<Node>();
 

diff --git a/src/Dependify.Core/Graph/Node.cs b/src/Dependify.Core/Graph/Node.cs
@@ -2,7 +2,6 @@
 
 using System.Text.Json.Serialization;
 
-
 public abstract record Node
 {
     public string Id { get; protected set; } = default!;
@@ -14,3 +13,12 @@ public abstract record Node
 
     public abstract string Type { get; }
 }
+
+public static class NodeConstants
+{
+    public const string Project = "Project";
+
+    public const string Solution = "Solution";
+
+    public const string Package = "Package";
+}
diff --git a/src/Dependify.Core/Graph/PackageReferenceNode.cs b/src/Dependify.Core/Graph/PackageReferenceNode.cs
@@ -1,7 +1,4 @@
-namespace Depends.Core.Graph;
-
-using Dependify.Core.Graph;
-
+namespace Dependify.Core.Graph;
 public sealed record PackageReferenceNode : Node
 {
     public PackageReferenceNode(string name, string? version = default)
@@ -15,6 +12,6 @@ public PackageReferenceNode(string name, string? version = default)
         this.Path = $"https://www.nuget.org/packages/{name}/{version}";
     }
 
-    public override string Type { get; } = "Package";
+    public override string Type { get; } = NodeConstants.Package;
     public string? Version { get; }
 }
diff --git a/src/Dependify.Core/Graph/ProjectReferenceNode.cs b/src/Dependify.Core/Graph/ProjectReferenceNode.cs
@@ -1,7 +1,6 @@
-namespace Depends.Core.Graph;
+namespace Dependify.Core.Graph;
 
 using Dependify.Core;
-using Dependify.Core.Graph;
 
 public sealed record ProjectReferenceNode : Node
 {
@@ -17,5 +16,5 @@ public ProjectReferenceNode(string path)
         this.Id = file.Name;
     }
 
-    public override string Type { get; } = "Project";
+    public override string Type { get; } = NodeConstants.Project;
 }
diff --git a/src/Dependify.Core/Graph/SolutionReferenceNode.cs b/src/Dependify.Core/Graph/SolutionReferenceNode.cs
@@ -1,10 +1,11 @@
-namespace Depends.Core.Graph;
+namespace Dependify.Core.Graph;
 
 using Dependify.Core;
-using Dependify.Core.Graph;
 
 public sealed record SolutionReferenceNode : Node
 {
+    public bool IsEmpty => this.Id == "<default>";
+
     public SolutionReferenceNode(string? path = default)
     {
         if (!string.IsNullOrWhiteSpace(path))
@@ -16,9 +17,9 @@ public SolutionReferenceNode(string? path = default)
         }
         else
         {
-            this.Id = "<empty>";
+            this.Id = "<default>";
         }
     }
 
-    public override string Type { get; } = "Solution";
+    public override string Type { get; } = NodeConstants.Solution;
 }
diff --git a/src/Dependify.Core/MsBuildService.cs b/src/Dependify.Core/MsBuildService.cs
@@ -2,7 +2,6 @@ namespace Dependify.Core;
 
 using Buildalyzer;
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 using Microsoft.Build.Construction;
 using Microsoft.Extensions.Logging;
 

diff --git a/src/Dependify.Core/ProjectLocator.cs b/src/Dependify.Core/ProjectLocator.cs
@@ -1,7 +1,6 @@
 namespace Dependify.Core;
 
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 using Microsoft.Extensions.Logging;
 
 public class ProjectLocator(ILogger<ProjectLocator> logger)

diff --git a/src/Dependify.Core/Serializers/GraphVizSerializer.cs b/src/Dependify.Core/Serializers/GraphVizSerializer.cs
@@ -2,7 +2,6 @@ namespace Dependify.Core.Serializers;
 
 using System.CodeDom.Compiler;
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 
 public static class GraphvizSerializer
 {

diff --git a/src/Dependify.Core/Serializers/JsonGraphSerializer.cs b/src/Dependify.Core/Serializers/JsonGraphSerializer.cs
@@ -0,0 +1,53 @@
+namespace Dependify.Core.Serializers;
+
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Text.Json.Serialization.Metadata;
+using Dependify.Core.Graph;
+
+public static class JsonGraphSerializer
+{
+    private static readonly JsonSerializerOptions JsonOptions =
+        new()
+        {
+            WriteIndented = true,
+            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
+            TypeInfoResolver = new PolymorphicTypeResolver()
+        };
+
+    public static string Serialize<T>(T value) => JsonSerializer.Serialize(value, JsonOptions);
+
+    public static string ToString(DependencyGraph graph)
+    {
+        ArgumentNullException.ThrowIfNull(graph);
+
+        return JsonSerializer.Serialize(graph, JsonOptions);
+    }
+
+    internal class PolymorphicTypeResolver : DefaultJsonTypeInfoResolver
+    {
+        public override JsonTypeInfo GetTypeInfo(Type type, JsonSerializerOptions options)
+        {
+            var jsonTypeInfo = base.GetTypeInfo(type, options);
+
+            var baseType = typeof(Node);
+            if (jsonTypeInfo.Type == baseType)
+            {
+                jsonTypeInfo.PolymorphismOptions = new JsonPolymorphismOptions
+                {
+                    TypeDiscriminatorPropertyName = "$type",
+                    IgnoreUnrecognizedTypeDiscriminators = true,
+                    UnknownDerivedTypeHandling = JsonUnknownDerivedTypeHandling.FailSerialization,
+                    DerivedTypes =
+                    {
+                        new JsonDerivedType(typeof(SolutionReferenceNode), nameof(SolutionReferenceNode)),
+                        new JsonDerivedType(typeof(ProjectReferenceNode), nameof(ProjectReferenceNode)),
+                        new JsonDerivedType(typeof(PackageReferenceNode), nameof(PackageReferenceNode)),
+                    }
+                };
+            }
+
+            return jsonTypeInfo;
+        }
+    }
+}
diff --git a/src/Dependify.Core/Serializers/MermaidC4Serializer.cs b/src/Dependify.Core/Serializers/MermaidC4Serializer.cs
@@ -0,0 +1,60 @@
+namespace Dependify.Core.Serializers;
+
+using System.CodeDom.Compiler;
+using Dependify.Core.Graph;
+
+public static class MermaidC4Serializer
+{
+    public static string ToString(DependencyGraph graph)
+    {
+        ArgumentNullException.ThrowIfNull(graph);
+
+        using var stringWriter = new StringWriter();
+        using var writer = new IndentedTextWriter(stringWriter);
+
+        writer.WriteLine("C4Component");
+        writer.WriteLine($"title {graph.Root.Id}");
+
+        var projects = graph.Nodes.Where(n => n.Type == NodeConstants.Project);
+
+        foreach (var project in projects)
+        {
+            writer.WriteLine($"Container_Boundary({project.Id}, \"{project.Id}\", \"\", \"\") {{");
+            writer.Indent++;
+
+            writer.WriteLine($"Component({project.Id}, \"{project.Id}\", \"Project\", \"\")");
+
+            var packages = graph.FindDescendants(project).OfType<PackageReferenceNode>();
+
+            if (packages.Any())
+            {
+                writer.WriteLine($"Container_Boundary(Packages.{project.Id}, \"Packages\", \"\", \"\") {{");
+                writer.Indent++;
+
+                foreach (var component in packages)
+                {
+                    writer.WriteLine($"Component({component.Id}, \"{component.Id}\", \"Package\", \"\")");
+                    writer.WriteLine(
+                        $"UpdateElementStyle({component.Id}, $fontColor=\"white\", $bgColor=\"grey\", $borderColor=\"#99CB0E\")"
+                    );
+                }
+                writer.Indent--;
+                writer.WriteLine("}");
+            }
+
+            writer.Indent--;
+            writer.WriteLine("}");
+        }
+
+        foreach (var project in projects)
+        {
+            foreach (var child in graph.FindDescendants(project).OfType<ProjectReferenceNode>())
+            {
+                writer.WriteLine($"Rel({project.Id}, {child.Id}, \"\")");
+            }
+        }
+
+        writer.Flush();
+        return stringWriter.ToString();
+    }
+}
diff --git a/src/Dependify.Core/Serializers/MermaidSerializer.cs b/src/Dependify.Core/Serializers/MermaidSerializer.cs
@@ -2,7 +2,6 @@ namespace Dependify.Core.Serializers;
 
 using System.CodeDom.Compiler;
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 
 public static class MermaidSerializer
 {

diff --git a/src/Dependify.Core/SolutionRegistry.cs b/src/Dependify.Core/SolutionRegistry.cs
@@ -1,7 +1,6 @@
 namespace Dependify.Core;
 
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 
 public class SolutionRegistry(FileProviderProjectLocator projectLocator, MsBuildService buildService)
 {
@@ -23,6 +22,7 @@ public void LoadRegistry()
 
             this.Solutions.Add(solution);
         }
+
         this.Nodes = nodes;
     }
 
@@ -38,7 +38,12 @@ public Task LoadSolutionsAsync(MsBuildConfig msBuildConfig, CancellationToken ca
 
                 var solution = this.Solutions[i];
 
-                var dependencyGraph = this.buildService.AnalyzeReferences(solution, msBuildConfig);
+                var dependencyGraph = solution.IsEmpty
+                    ? this.buildService.AnalyzeReferences(
+                        this.Nodes.OfType<ProjectReferenceNode>().ToList(),
+                        msBuildConfig
+                    )
+                    : this.buildService.AnalyzeReferences(solution, msBuildConfig);
 
                 // TODO: add cache lookup for already loaded solutions
                 this.solutionGraphs.Add(solution, dependencyGraph);

diff --git a/src/Dependify.Core/Utils.cs b/src/Dependify.Core/Utils.cs
@@ -1,7 +1,6 @@
 namespace Dependify.Core;
 
 using Dependify.Core.Graph;
-using Depends.Core.Graph;
 
 public static class Utils
 {