Skip to content

Commit

Permalink
Merge pull request #33295 from raccoongang/rg/feat/FC0031/add_profile…
Browse files Browse the repository at this point in the history 
…_image_to_api_discussion

feat: [FC-0031] Add field profile_image to CommentSerializer
Feanil Patel authored Nov 16, 2023
2 parents c6b36a8 + e27f674 commit 942a241
Showing 5 changed files with 93 additions and 0 deletions.
6 changes: 6 additions & 0 deletions lms/djangoapps/discussion/rest_api/serializers.py
View file
Original file line number Diff line number Diff line change
@@ -41,6 +41,7 @@
from openedx.core.djangoapps.django_comment_common.comment_client.user import User as CommentClientUser
from openedx.core.djangoapps.django_comment_common.comment_client.utils import CommentClientRequestError
from openedx.core.djangoapps.django_comment_common.models import CourseDiscussionSettings
from openedx.core.djangoapps.user_api.accounts.api import get_profile_images
from openedx.core.lib.api.serializers import CourseKeyField

User = get_user_model()
@@ -502,6 +503,7 @@ class CommentSerializer(_ContentSerializer):
child_count = serializers.IntegerField(read_only=True)
children = serializers.SerializerMethodField(required=False)
abuse_flagged_any_user = serializers.SerializerMethodField(required=False)
profile_image = serializers.SerializerMethodField(read_only=True)

non_updatable_fields = NON_UPDATABLE_COMMENT_FIELDS

@@ -584,6 +586,10 @@ def get_abuse_flagged_any_user(self, obj):
if _validate_privileged_access(self.context):
return len(obj.get("abuse_flaggers", [])) > 0

def get_profile_image(self, obj):
request = self.context["request"]
return get_profile_images(request.user.profile, request.user, request)

def validate(self, attrs):
"""
Ensure that parent_id identifies a comment that is actually in the
35 changes: 35 additions & 0 deletions lms/djangoapps/discussion/rest_api/tests/test_api.py
View file
Original file line number Diff line number Diff line change
@@ -1478,6 +1478,13 @@ def test_discussion_content(self):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
},
{
"id": "test_comment_2",
@@ -1505,6 +1512,13 @@ def test_discussion_content(self):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
},
]
actual_comments = self.get_comment_list(
@@ -2252,6 +2266,13 @@ def test_success(self, parent_id, mock_emit):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}
assert actual == expected
expected_url = (
@@ -2352,6 +2373,13 @@ def test_success_in_black_out_with_user_access(self, parent_id, mock_emit):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}
assert actual == expected
expected_url = (
@@ -3188,6 +3216,13 @@ def test_basic(self, parent_id):
"can_delete": True,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}
assert actual == expected
assert parsed_body(httpretty.last_request()) == {
7 changes: 7 additions & 0 deletions lms/djangoapps/discussion/rest_api/tests/test_serializers.py
View file
Original file line number Diff line number Diff line change
@@ -448,6 +448,13 @@ def test_basic(self):
"can_delete": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}

assert self.serialize(comment) == expected
28 changes: 28 additions & 0 deletions lms/djangoapps/discussion/rest_api/tests/test_views.py
View file
Original file line number Diff line number Diff line change
@@ -1972,6 +1972,13 @@ def expected_response_comment(self, overrides=None):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}
response_data.update(overrides or {})
return response_data
@@ -2398,6 +2405,13 @@ def test_basic(self):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}
response = self.client.post(
self.url,
@@ -2490,6 +2504,13 @@ def expected_response_data(self, overrides=None):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}
response_data.update(overrides or {})
return response_data
@@ -2680,6 +2701,13 @@ def test_basic(self):
"anonymous_to_peers": False,
"last_edit": None,
"edit_by_label": None,
"profile_image": {
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
},
}

response = self.client.get(self.url)
17 changes: 17 additions & 0 deletions openedx/core/djangoapps/user_api/accounts/api.py
View file
Original file line number Diff line number Diff line change
@@ -524,6 +524,23 @@ def get_email_existence_validation_error(email):
return _validate(_validate_email_doesnt_exist, errors.AccountEmailAlreadyExists, email)


def get_profile_images(user_profile, user, request=None):
"""
Returns metadata about a user's profile image.
The output is a dict that looks like:
{
"has_image": False,
"image_url_full": "http://testserver/static/default_500.png",
"image_url_large": "http://testserver/static/default_120.png",
"image_url_medium": "http://testserver/static/default_50.png",
"image_url_small": "http://testserver/static/default_30.png",
}
"""
return AccountLegacyProfileSerializer.get_profile_image(user_profile, user, request)


def _get_user_and_profile(username):
"""
Helper method to return the legacy user and profile objects based on username.

0 comments on commit 942a241

Please sign in to comment.