Simplify the XLSX output code for CodebaseRelation list view #858

Signed-off-by: Thomas Druez <[email protected]>

scanpipe/api/serializers.py

@@ -385,9 +385,11 @@ class CodebaseRelationSerializer(serializers.ModelSerializer):
  class Meta:
  model = CodebaseRelation
  fields = [
- "from_resource",
  "to_resource",
+ "status",
  "map_type",
+ "score",
+ "from_resource",
  ]
 
 

scanpipe/models.py

@@ -2251,6 +2251,17 @@ class Meta:
  def __str__(self):
  return f"{self.from_resource.pk} > {self.to_resource.pk} using {self.map_type}"
 
+ @property
+ def status(self):
+ return self.to_resource.status
+
+ @property
+ def score(self):
+ score = self.extra_data.get("path_score", "")
+ if diff_ratio := self.extra_data.get("diff_ratio", ""):
+ score += f" diff_ratio: {diff_ratio}"
+ return score
+
 
 class VulnerabilityMixin(models.Model):
  """Add the vulnerability related fields and methods."""

scanpipe/templates/scanpipe/includes/pagination_header_relations.html

@@ -2,7 +2,9 @@
 {% load humanize %}
 
 {% block paginator_count %}
- {{ paginator.count|intcomma }} relations
+ <span style="vertical-align: middle">
+ {{ paginator.count|intcomma }} relations
+ </span>
  <a href="{% url 'project_resources' project.slug %}?tag=to&relation_map_type=none&status=_EMPTY_" target="_blank" class="button is-small is-info is-outlined">
  <span>Un-mapped <strong>to/</strong> resources</span>
  <span class="icon">

scanpipe/views.py

@@ -25,7 +25,6 @@
 import json
 import operator
 from collections import Counter
-from collections import namedtuple
 from contextlib import suppress
 from pathlib import Path
 
@@ -1228,12 +1227,6 @@ class ProjectErrorListView(
  ]
 
 
-RelationRow = namedtuple(
- "RelationRow",
- field_names=["to_resource", "status", "map_type", "score", "from_resource"],
-)
-
-
 class CodebaseRelationListView(
  ConditionalLoginRequired,
  ProjectRelatedViewMixin,
@@ -1250,7 +1243,10 @@ class CodebaseRelationListView(
  "to_resource",
  queryset=unordered_resources.only("path", "is_text", "status"),
  ),
- Prefetch("from_resource", queryset=unordered_resources.only("path", "is_text")),
+ Prefetch(
+ "from_resource",
+ queryset=unordered_resources.only("path", "is_text", "status"),
+ ),
  ]
  paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("relation", 100)
  table_columns = [
@@ -1272,36 +1268,6 @@ def get_filterset_kwargs(self, filterset_class):
  kwargs.update({"project": self.project})
  return kwargs
 
- @staticmethod
- def get_rows(qs):
- for relation in qs:
- score = relation.extra_data.get("path_score", "")
- if diff_ratio := relation.extra_data.get("diff_ratio", ""):
- score += f" diff_ratio: {diff_ratio}"
- yield RelationRow(
- relation.to_resource.path,
- relation.to_resource.status,
- relation.map_type,
- score,
- relation.from_resource.path,
- )
-
- def export_xlsx_file_response(self):
- filtered_qs = self.filterset.qs
- output_file = io.BytesIO()
-
- with xlsxwriter.Workbook(output_file) as workbook:
- output._add_xlsx_worksheet(
- workbook=workbook,
- worksheet_name="RELATIONS",
- rows=self.get_rows(qs=filtered_qs),
- fields=RelationRow._fields,
- )
-
- filename = f"{self.project.name}_{self.model._meta.model_name}.xlsx"
- output_file.seek(0)
- return FileResponse(output_file, as_attachment=True, filename=filename)
-
 
 class CodebaseResourceDetailsView(
  ConditionalLoginRequired,