Skip to content
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

Jump to bottom

Fixed #22315 -- str/bytes mismatch in staticfiles #2463

Closed
wants to merge 1 commit into from
Closed

Fixed #22315 -- str/bytes mismatch in staticfiles #2463

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions django/contrib/staticfiles/storage.py
View file
Open in desktop
Expand Up @@ -292,7 +292,7 @@ def __init__(self, *args, **kwargs):
def read_manifest(self):
try:
with self.open(self.manifest_name) as manifest:
return manifest.read()
return manifest.read().decode('utf-8')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this use settings.FILE_CHARSET instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so: JSON is mandated to be UTF-8

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but I found this: "JSON text SHALL be encoded in Unicode. The default encoding is UTF-8."
http://www.ietf.org/rfc/rfc4627.txt

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see -- thanks. I still think that given that Django controls both ends of the process it should use UTF-8 anyway. But on reflection, we should explicitly encode as UTF-8 when saving as well. I'll update the patch.

except IOError:
return None

Expand All @@ -319,7 +319,8 @@ def post_process(self, *args, **kwargs):
payload = {'paths': self.hashed_files, 'version': self.manifest_version}
if self.exists(self.manifest_name):
self.delete(self.manifest_name)
self._save(self.manifest_name, ContentFile(json.dumps(payload)))
contents = json.dumps(payload).encode('utf-8')
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually redundant as ContentFile will run this through force_bytes which would encode it as UTF-8 anyway, but perhaps it's better to be explicit.

self._save(self.manifest_name, ContentFile(contents))


class _MappingCache(object):
Expand Down
4 changes: 4 additions & 0 deletions tests/staticfiles_tests/tests.py
View file
Open in desktop
Expand Up @@ -662,6 +662,10 @@ def test_loaded_cache(self):
storage.staticfiles_storage.manifest_version,
force_text(manifest_content))

def test_parse_cache(self):
hashed_files = storage.staticfiles_storage.hashed_files
manifest = storage.staticfiles_storage.load_manifest()
self.assertEqual(hashed_files, manifest)

# we set DEBUG to False here since the template tag wouldn't work otherwise
@override_settings(**dict(
Expand Down