Skip to content

fix: serve JSON and text downloads inline so they open in the browser #2217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MGpromax wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: serve JSON and text downloads inline so they open in the browser #2217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions scanpipe/tests/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,18 @@ def test_scanpipe_views_project_details_download_output_view(self):
response.headers["Content-Disposition"],
)

def test_scanpipe_views_project_details_download_output_view_json_inline(self):
# https://github.com/aboutcode-org/scancode.io/issues/2210
json_file = self.project1.output_path / "results.json"
json_file.write_text('{"headers": []}')
url = reverse("project_download_output", args=[self.project1.slug, "results.json"])
response = self.client.get(url)
self.assertEqual("application/json", response.headers["Content-Type"])
self.assertEqual(
'inline; filename="results.json"',
response.headers["Content-Disposition"],
)

def test_scanpipe_views_project_details_delete_input_view(self):
random_uuid = str(uuid.uuid4())
url = reverse("project_delete_input", args=[self.project1.slug, random_uuid])
Expand Down
6 changes: 5 additions & 1 deletion scanpipe/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1532,7 +1532,11 @@ def download_project_file(request, slug, filename, path_type):
if not file_path.exists():
raise Http404(f"{file_path} not found")

return FileResponse(file_path.open("rb"), as_attachment=True)
# JSON and plain text render safely in browsers: serve those inline so
# that e.g. JSON results open directly in the browser instead of always
# forcing a download.
as_attachment = file_path.suffix not in (".json", ".txt")
return FileResponse(file_path.open("rb"), as_attachment=as_attachment)


@conditional_login_required
Expand Down