Skip to content

Run iri_to_uri on header values #11439

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

Merged
merged 3 commits into from
Jun 25, 2024
Merged

Run iri_to_uri on header values #11439

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4bb313
Run iri_to_uri on header values
ericholscher Jun 25, 2024
c850490
Escape in the right place
ericholscher Jun 25, 2024
1f71e20
Remove _convert_to_charset logic and fix test
ericholscher Jun 25, 2024
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
3 changes: 2 additions & 1 deletion readthedocs/proxito/middleware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from django.shortcuts import redirect
from django.urls import reverse
from django.utils.deprecation import MiddlewareMixin
from django.utils.encoding import iri_to_uri
from django.utils.html import escape

from readthedocs.builds.models import Version
Expand Down Expand Up @@ -382,7 +383,7 @@ def add_resolver_headers(self, request, response):
mime_encode=True,
)

response["X-RTD-Resolver-Filename"] = header_value
response["X-RTD-Resolver-Filename"] = iri_to_uri(header_value)
except BadHeaderError:
# Skip adding the header because it fails validation
log.info(
Expand Down
23 changes: 23 additions & 0 deletions readthedocs/proxito/tests/test_headers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,29 @@ def test_serve_headers_with_path(self):
"/proxito/media/html/project/latest/guides/jupyter/gallery.html",
)

# refs https://read-the-docs.sentry.io/issues/5019718893/
def test_serve_headers_with_unicode(self):
r = self.client.get(
"/en/latest/tutorial_1installation.htmlReview%20of%20Failures%20of%0BReview%20of%20Failures%20of%0BPhotovoltaic%20Moduleshotovoltaic%20Modules",
secure=True,
headers={"host": "project.dev.readthedocs.io"},
)
self.assertEqual(r.status_code, 200)
self.assertEqual(r["Cache-Tag"], "project,project:latest")
self.assertEqual(r["X-RTD-Domain"], "project.dev.readthedocs.io")
self.assertEqual(r["X-RTD-Project"], "project")
self.assertEqual(r["X-RTD-Project-Method"], "public_domain")
self.assertEqual(r["X-RTD-Version"], "latest")
self.assertEqual(r["X-RTD-version-Method"], "path")
self.assertEqual(
r["X-RTD-Resolver-Filename"],
"/tutorial_1installation.htmlReview%20of%20Failures%20of%0BReview%20of%20Failures%20of%0BPhotovoltaic%20Moduleshotovoltaic%20Modules",
)
self.assertEqual(
r["X-RTD-Path"],
"/proxito/media/html/project/latest/tutorial_1installation.htmlReview%20of%20Failures%20of%0BReview%20of%20Failures%20of%0BPhotovoltaic%20Moduleshotovoltaic%20Modules",
)

def test_subproject_serve_headers(self):
r = self.client.get(
"/projects/subproject/en/latest/",
Expand Down