Include ProjectMessages in the JSON output headers section #1659 (#1662)

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

Author: tdruez

CHANGELOG.rst

@@ -16,6 +16,9 @@ v34.10.2 (unreleased)
 - Add the ability to export filtered QuerySet of a FilterView into the JSON format.
   https://github.com/aboutcode-org/scancode.io/pull/1572
 
+- Include ``ProjectMessage`` records in the JSON output ``headers`` section.
+  https://github.com/aboutcode-org/scancode.io/issues/1659
+
 v34.10.1 (2025-03-26)
 ---------------------
 

scanpipe/pipes/output.py

@@ -224,11 +224,15 @@ def encode(data):
         return json.dumps(data, indent=2, cls=DjangoJSONEncoder)
 
     def get_headers(self, project):
+        from scanpipe.api.serializers import ProjectMessageSerializer
         from scanpipe.api.serializers import RunSerializer
 
         runs = project.runs.all()
         runs = RunSerializer(runs, many=True, exclude_fields=("url", "project"))
 
+        messages = project.projectmessages.all()
+        messages = ProjectMessageSerializer(messages, many=True)
+
         other_tools = [f"pkg:pypi/scancode-toolkit@{scancode_toolkit_version}"]
 
         headers = {
@@ -242,6 +246,7 @@ def get_headers(self, project):
             "settings": project.settings,
             "input_sources": project.get_inputs_with_source(),
             "runs": runs.data,
+            "messages": messages.data,
             "extra_data": project.extra_data,
         }
         yield self.encode(headers)

scanpipe/tests/data/asgiref/asgiref-3.3.0_load_inventory_expected.json

@@ -26,6 +26,7 @@
           "execution_time": null
         }
       ],
+      "messages": [],
       "extra_data": {}
     }
   ],

scanpipe/tests/data/asgiref/asgiref-3.3.0_scanpipe_output.json

@@ -42,6 +42,7 @@
           "execution_time": null
         }
       ],
+      "messages": [],
       "extra_data": {}
     }
   ],