From 584cc238f199828611b283bdc060597fda60741a Mon Sep 17 00:00:00 2001
From: tdruez <tdruez@nexb.com>
Date: Mon, 29 Jul 2024 13:18:49 +0400
Subject: [PATCH] Add a dependency tree view based on d3.js #1145

Signed-off-by: tdruez <tdruez@nexb.com>
---
 .../templates/scanpipe/dependency_list.html   |  6 +++
 .../scanpipe/project_dependency_tree.html     | 44 +++++++++++++++++++
 scanpipe/urls.py                              |  5 +++
 scanpipe/views.py                             | 31 +++++++++++++
 4 files changed, 86 insertions(+)
 create mode 100644 scanpipe/templates/scanpipe/project_dependency_tree.html

diff --git a/scanpipe/templates/scanpipe/dependency_list.html b/scanpipe/templates/scanpipe/dependency_list.html
index 51ba0821f..92a3de0b6 100644
--- a/scanpipe/templates/scanpipe/dependency_list.html
+++ b/scanpipe/templates/scanpipe/dependency_list.html
@@ -16,6 +16,12 @@
   </div>
 
   <div class="container is-fluid mb-3">
+    <a href="{% url 'project_dependency_tree' project.slug %}" class="is-pulled-right">
+      <span class="icon">
+        <i class="fa-solid fa-sitemap"></i>
+      </span>
+      <span>View the dependency tree</span>
+    </a>
     <table class="table is-bordered is-striped is-narrow is-hoverable is-fullwidth">
       {% include 'scanpipe/includes/list_view_thead.html' %}
       <tbody>
diff --git a/scanpipe/templates/scanpipe/project_dependency_tree.html b/scanpipe/templates/scanpipe/project_dependency_tree.html
new file mode 100644
index 000000000..17251af27
--- /dev/null
+++ b/scanpipe/templates/scanpipe/project_dependency_tree.html
@@ -0,0 +1,44 @@
+{% extends "scanpipe/base.html" %}
+
+{% block title %}ScanCode.io: {{ project.name }} - Dependency tree{% endblock %}
+
+{% block content %}
+  <div id="content-header" class="container is-max-widescreen mb-3">
+    {% include 'scanpipe/includes/navbar_header.html' %}
+    <section class="mx-5">
+      <div class="is-flex is-justify-content-space-between">
+        {% include 'scanpipe/includes/breadcrumb.html' with linked_project=True current="Dependency tree" %}
+      </div>
+    </section>
+  </div>
+
+  <div class="container is-fluid mb-3">
+    <div id="tree"></div>
+  </div>
+{% endblock %}
+
+{% block scripts %}
+  <script src="https://d3js.org/d3.v7.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/@observablehq/plot@0.6"></script>
+  {{ dependency_tree|json_script:"dependency_tree" }}
+  <script>
+    const data = JSON.parse(document.getElementById("dependency_tree").textContent);
+
+    const plot = Plot.plot({
+      axis: null,
+      margin: 10,
+      marginLeft: 40,
+      marginRight: 160,
+      width: 928 * 2,
+      height: 1800 * 2,
+      marks: [
+        Plot.tree(d3.hierarchy(data).leaves(), {
+          path: (node) => node.ancestors().reverse().map(({ data: { name } }) => name).join("|"),
+          delimiter: "|"
+        })
+      ]
+    });
+
+    document.getElementById("tree").appendChild(plot);
+  </script>
+{% endblock %}
\ No newline at end of file
diff --git a/scanpipe/urls.py b/scanpipe/urls.py
index ce3e37fbc..8bebb60f5 100644
--- a/scanpipe/urls.py
+++ b/scanpipe/urls.py
@@ -71,6 +71,11 @@
         views.DiscoveredDependencyListView.as_view(),
         name="project_dependencies",
     ),
+    path(
+        "project/<slug:slug>/dependency_tree/",
+        views.ProjectDependencyTreeView.as_view(),
+        name="project_dependency_tree",
+    ),
     path(
         "project/<slug:slug>/relations/",
         views.CodebaseRelationListView.as_view(),
diff --git a/scanpipe/views.py b/scanpipe/views.py
index e092079d3..2a7e932e7 100644
--- a/scanpipe/views.py
+++ b/scanpipe/views.py
@@ -2281,3 +2281,34 @@ def get_object(self, queryset=None):
             return licenses[key]
         except KeyError:
             raise Http404(f"License {key} not found.")
+
+
+class ProjectDependencyTreeView(ConditionalLoginRequired, generic.DetailView):
+    model = Project
+    template_name = "scanpipe/project_dependency_tree.html"
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["dependency_tree"] = self.get_dependency_tree(project=self.object)
+        return context
+
+    def get_dependency_tree(self, project):
+        root_packages = project.discoveredpackages.root_packages()
+        project_children = [self.get_node(package) for package in root_packages]
+
+        project_tree = {
+            "name": project.name,
+            "children": project_children,
+        }
+
+        return project_tree
+
+    def get_node(self, package):
+        node = {"name": str(package)}
+        children = [
+            self.get_node(child_package)
+            for child_package in package.children_packages.all()
+        ]
+        if children:
+            node["children"] = children
+        return node