Move resource path in the URL path instead of query string

Signed-off-by: tdruez <[email protected]>

Author: tdruez

scanpipe/templates/scanpipe/resource_tree.html

@@ -32,7 +32,7 @@
             {% if resource.is_file %}
               hx-get="{% url 'resource_detail' project.slug resource.path %}"
             {% else %}
-              hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ path }}"
+              hx-get="{% url 'project_resource_tree_table' project.slug path %}"
             {% endif %}
             hx-trigger="load"
             hx-target="this">

scanpipe/templates/scanpipe/tree/resource_left_pane_tree.html

@@ -10,7 +10,7 @@
             class="is-flex is-align-items-center folder-meta is-clickable"
             data-folder-click
             data-path="{{ node.path }}"
-            hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ node.path }}"
+            hx-get="{% url 'project_resource_tree_table' project.slug node.path %}"
             hx-target="#right-pane"
             hx-push-url="{% url 'project_resource_tree' project.slug node.path %}">
             <span class="icon is-small mr-2">

scanpipe/templates/scanpipe/tree/resource_path_breadcrumb.html

@@ -15,7 +15,7 @@
             href="{% url 'project_resource_tree' project.slug subpath %}"
             class="expand-in-tree"
             data-path="{{ subpath }}"
-            hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ subpath }}"
+            hx-get="{% url 'project_resource_tree_table' project.slug subpath %}"
             hx-target="#right-pane"
             hx-push-url="{% url 'project_resource_tree' project.slug subpath %}">
             {{ segment }}

scanpipe/templates/scanpipe/tree/resource_table.html

@@ -14,7 +14,7 @@
           <tr
             class="expand-in-tree is-clickable"
             data-path="{{ parent_path }}"
-            hx-get="{% url 'project_resource_tree_table' project.slug %}{% if parent_path %}?path={{ parent_path }}{% endif %}"
+            hx-get="{% url 'project_resource_tree_table' project.slug parent_path %}"
             hx-target="#right-pane"
             hx-push-url="{% url 'project_resource_tree' project.slug parent_path %}">
             <td colspan="5">
@@ -43,7 +43,7 @@
                     class="expand-in-tree"
                     href="{% url 'project_resource_tree' project.slug resource.path %}"
                     data-path="{{ resource.path }}"
-                    hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ resource.path }}"
+                    hx-get="{% url 'project_resource_tree_table' project.slug resource.path %}"
                     hx-target="#right-pane"
                     hx-push-url="{% url 'project_resource_tree' project.slug resource.path %}">
                     {{ resource.name }}
@@ -84,7 +84,7 @@
       {% if page_obj.has_previous %}
         <a
           class="pagination-previous"
-          hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ path }}&page={{ page_obj.previous_page_number }}"
+          hx-get="{% url 'project_resource_tree_table' project.slug path %}?page={{ page_obj.previous_page_number }}"
           hx-target="#right-pane"
           hx-push-url="{% url 'project_resource_tree' project.slug path %}?page={{ page_obj.previous_page_number }}">
           Previous
@@ -93,7 +93,7 @@
       {% if page_obj.has_next %}
         <a
           class="pagination-next"
-          hx-get="{% url 'project_resource_tree_table' project.slug %}?path={{ path }}&page={{ page_obj.next_page_number }}"
+          hx-get="{% url 'project_resource_tree_table' project.slug path%}?page={{ page_obj.next_page_number }}"
           hx-target="#right-pane"
           hx-push-url="{% url 'project_resource_tree' project.slug path %}?page={{ page_obj.next_page_number }}">
           Next page

scanpipe/tests/test_views.py

@@ -1644,22 +1644,26 @@ def test_scanpipe_views_resource_tree_children_path(self):
         self.assertTrue(dir1.has_children)
 
     def test_scanpipe_views_project_resource_tree_table_view_with_path_directory(self):
-        make_resource_directory(self.project1, path="parent")
-        make_resource_file(self.project1, path="parent/child1.txt")
-        make_resource_file(self.project1, path="parent/child2.py")
+        resource1 = make_resource_directory(self.project1, path="parent+special&chars")
+        make_resource_file(self.project1, path="parent+special&chars/child1.txt")
+        make_resource_file(self.project1, path="parent+special&chars/child2.py")
 
         url = reverse(
-            "project_resource_tree_table", kwargs={"slug": self.project1.slug}
+            "project_resource_tree_table",
+            kwargs={"slug": self.project1.slug, "path": resource1.path},
         )
-        response = self.client.get(url + "?path=parent")
+        response = self.client.get(url)
 
         self.assertEqual(200, response.status_code)
-        self.assertEqual("parent", response.context["path"])
+        self.assertEqual(resource1.path, response.context["path"])
         resources = list(response.context["resources"])
         self.assertEqual(2, len(resources))
 
         resource_paths = [r.path for r in resources]
-        self.assertEqual(["parent/child1.txt", "parent/child2.py"], resource_paths)
+        self.assertEqual(
+            ["parent+special&chars/child1.txt", "parent+special&chars/child2.py"],
+            resource_paths,
+        )
 
     def test_scanpipe_views_project_resource_tree_view_with_path_file(self):
         resource = make_resource_file(self.project1, path="specific_file.txt")
@@ -1678,10 +1682,10 @@ def test_scanpipe_views_project_resource_tree_table_view_empty_directory(self):
         make_resource_directory(self.project1, path="empty_dir")
 
         url = reverse(
-            "project_resource_tree_table", kwargs={"slug": self.project1.slug}
+            "project_resource_tree_table",
+            kwargs={"slug": self.project1.slug, "path": "empty_dir"},
         )
-        response = self.client.get(url + "?path=empty_dir")
-
+        response = self.client.get(url)
         self.assertEqual(200, response.status_code)
         self.assertEqual("empty_dir", response.context["path"])
         resources = list(response.context["resources"])
@@ -1695,17 +1699,18 @@ def test_scanpipe_views_project_resource_tree_table_view_pagination(self):
         make_resource_file(self.project1, path="parent/file3.txt", parent_path="parent")
 
         url = reverse(
-            "project_resource_tree_table", kwargs={"slug": self.project1.slug}
+            "project_resource_tree_table",
+            kwargs={"slug": self.project1.slug, "path": "parent"},
         )
 
-        response = self.client.get(url + "?path=parent")
+        response = self.client.get(url)
         self.assertEqual(200, response.status_code)
         self.assertTrue(response.context["is_paginated"])
         self.assertEqual(1, response.context["page_obj"].number)
         self.assertTrue(response.context["page_obj"].has_next())
         self.assertFalse(response.context["page_obj"].has_previous())
 
-        response = self.client.get(url + "?path=parent&page=2")
+        response = self.client.get(url + "?page=2")
         self.assertEqual(200, response.status_code)
         self.assertEqual(2, response.context["page_obj"].number)
         self.assertFalse(response.context["page_obj"].has_next())

scanpipe/urls.py

@@ -141,6 +141,11 @@
         views.ProjectResourceTreeView.as_view(),
         name="project_resource_tree",
     ),
+    path(
+        "project/<slug:slug>/resource_tree_table/<path:path>/",
+        views.ProjectResourceTreeTableView.as_view(),
+        name="project_resource_tree_table",
+    ),
     path(
         "project/<slug:slug>/resource_tree_table/",
         views.ProjectResourceTreeTableView.as_view(),

scanpipe/views.py

@@ -2740,7 +2740,7 @@ class ProjectResourceTreeView(ConditionalLoginRequired, generic.DetailView):
     def get(self, request, *args, **kwargs):
         slug = self.kwargs.get("slug")
         project = get_object_or_404(Project, slug=slug)
-        path = self.kwargs.get("path")
+        path = self.kwargs.get("path", "")
         parent_path = path if request.GET.get("tree_panel") == "true" else ""
 
         children = (
@@ -2781,7 +2781,7 @@ class ProjectResourceTreeTableView(
     context_object_name = "resources"
 
     def get_queryset(self):
-        path = self.request.GET.get("path", "")
+        path = self.kwargs.get("path", "")
         return (
             super()
             .get_queryset()
@@ -2800,7 +2800,7 @@ def get_queryset(self):
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        path = self.request.GET.get("path", "")
+        path = self.kwargs.get("path", "")
         context["path"] = path
 
         segments = path.strip("/").split("/")