mirror of
https://github.com/zulip/zulip.git
synced 2025-10-24 16:43:57 +00:00
avatars: Serve /user_avatars/ through Django, which offloads to nginx.
Moving `/user_avatars/` to being served partially through Django removes the need for the `no_serve_uploads` nginx reconfiguring when switching between S3 and local backends. This is important because a subsequent commit will move S3 attachments to being served through nginx, which would make `no_serve_uploads` entirely nonsensical of a name. Serve the files through Django, with an offload for the actual image response to an internal nginx route. In development, serve the files directly in Django. We do _not_ mark the contents as immutable for caching purposes, since the path for avatar images is hashed only by their user-id and a salt, and as such are reused when a user's avatar is updated.
This commit is contained in:
committed by
Alex Vandiver
parent
f0f4aa66e0
commit
ed6d62a9e7
@@ -8,6 +8,7 @@ import urllib
|
||||
from io import StringIO
|
||||
from unittest import mock
|
||||
from unittest.mock import patch
|
||||
from urllib.parse import urlparse
|
||||
|
||||
import botocore.exceptions
|
||||
import orjson
|
||||
@@ -1853,6 +1854,39 @@ class LocalStorageTest(UploadSerializeMixin, ZulipTestCase):
|
||||
path_id = re.sub("/user_uploads/", "", response_dict["uri"])
|
||||
self.assertTrue(delete_message_image(path_id))
|
||||
|
||||
def test_avatar_url_local(self) -> None:
|
||||
self.login("hamlet")
|
||||
with get_test_image_file("img.png") as image_file:
|
||||
result = self.client_post("/json/users/me/avatar", {"file": image_file})
|
||||
|
||||
response_dict = self.assert_json_success(result)
|
||||
self.assertIn("avatar_url", response_dict)
|
||||
base = "/user_avatars/"
|
||||
url = self.assert_json_success(result)["avatar_url"]
|
||||
self.assertEqual(base, url[: len(base)])
|
||||
|
||||
# That URL is accessible when logged out
|
||||
self.logout()
|
||||
result = self.client_get(url)
|
||||
self.assertEqual(result.status_code, 200)
|
||||
|
||||
# We get a resized avatar from it
|
||||
image_data = read_test_image_file("img.png")
|
||||
resized_avatar = resize_avatar(image_data)
|
||||
assert isinstance(result, StreamingHttpResponse)
|
||||
self.assertEqual(resized_avatar, b"".join(result.streaming_content))
|
||||
|
||||
with self.settings(DEVELOPMENT=False):
|
||||
# In production, this is an X-Accel-Redirect to the
|
||||
# on-disk content, which nginx serves
|
||||
result = self.client_get(url)
|
||||
self.assertEqual(result.status_code, 200)
|
||||
internal_redirect_path = urlparse(url).path.replace(
|
||||
"/user_avatars/", "/internal/user_avatars/"
|
||||
)
|
||||
self.assertEqual(result["X-Accel-Redirect"], internal_redirect_path)
|
||||
self.assertEqual(b"", result.content)
|
||||
|
||||
def test_ensure_avatar_image_local(self) -> None:
|
||||
user_profile = self.example_user("hamlet")
|
||||
file_path = user_avatar_path(user_profile)
|
||||
@@ -2099,6 +2133,25 @@ class S3Test(ZulipTestCase):
|
||||
body = f"First message ...[zulip.txt](http://{hamlet.realm.host}" + uri + ")"
|
||||
self.send_stream_message(hamlet, "Denmark", body, "test")
|
||||
|
||||
@use_s3_backend
|
||||
def test_user_avatars_redirect(self) -> None:
|
||||
create_s3_buckets(settings.S3_AVATAR_BUCKET)[0]
|
||||
self.login("hamlet")
|
||||
with get_test_image_file("img.png") as image_file:
|
||||
result = self.client_post("/json/users/me/avatar", {"file": image_file})
|
||||
|
||||
response_dict = self.assert_json_success(result)
|
||||
self.assertIn("avatar_url", response_dict)
|
||||
base = f"https://{settings.S3_AVATAR_BUCKET}.s3.amazonaws.com/"
|
||||
url = self.assert_json_success(result)["avatar_url"]
|
||||
self.assertEqual(base, url[: len(base)])
|
||||
|
||||
# Try hitting the equivalent `/user_avatars` endpoint
|
||||
wrong_url = "/user_avatars/" + url[len(base) :]
|
||||
result = self.client_get(wrong_url)
|
||||
self.assertEqual(result.status_code, 301)
|
||||
self.assertEqual(result["Location"], url)
|
||||
|
||||
@use_s3_backend
|
||||
def test_upload_avatar_image(self) -> None:
|
||||
bucket = create_s3_buckets(settings.S3_AVATAR_BUCKET)[0]
|
||||
|
||||
Reference in New Issue
Block a user