Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat!: remove cs_comments_service support for forum's search APIs

Browse Source 
This will force the use of the new v2 forum's APIs for searching.
This commit is contained in:
Ali-Salman29
2025-06-24 15:48:12 +02:00
committed by David Ormsbee
parent 3806f9f4f0
commit e0fbb96ee7
10 changed files with 2778 additions and 2046 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
openedx/core/djangoapps/django_comment_common/comment_client/thread.py
View File

@@ -56,42 +56,28 @@ class Thread(models.Model):
utils.strip_blank(utils.strip_none(query_params))
)
if query_params.get('text'):
url = cls.url(action='search')
else:
url = cls.url(action='get_all', params=utils.extract(params, 'commentable_id'))
if params.get('commentable_id'):
del params['commentable_id']
# Convert user_id and author_id to strings if present
for field in ['user_id', 'author_id']:
if value := params.get(field):
params[field] = str(value)
if is_forum_v2_enabled(utils.get_course_key(query_params['course_id'])):
if query_params.get('text'):
search_params = utils.strip_none(params)
if user_id := search_params.get('user_id'):
search_params['user_id'] = str(user_id)
if group_ids := search_params.get('group_ids'):
search_params['group_ids'] = [int(group_id) for group_id in group_ids.split(',')]
elif group_id := search_params.get('group_id'):
search_params['group_ids'] = [int(group_id)]
search_params.pop('group_id', None)
if commentable_ids := search_params.get('commentable_ids'):
search_params['commentable_ids'] = commentable_ids.split(',')
elif commentable_id := search_params.get('commentable_id'):
search_params['commentable_ids'] = [commentable_id]
search_params.pop('commentable_id', None)
response = forum_api.search_threads(**search_params)
else:
if user_id := params.get('user_id'):
params['user_id'] = str(user_id)
response = forum_api.get_user_threads(**params)
# Handle commentable_ids/commentable_id conversion
if commentable_ids := params.get('commentable_ids'):
params['commentable_ids'] = commentable_ids.split(',')
elif commentable_id := params.get('commentable_id'):
params['commentable_ids'] = [commentable_id]
params.pop('commentable_id', None)
params = utils.clean_forum_params(params)
if query_params.get('text'): # Handle group_ids/group_id conversion
if group_ids := params.get('group_ids'):
params['group_ids'] = [int(group_id) for group_id in group_ids.split(',')]
elif group_id := params.get('group_id'):
params['group_ids'] = [int(group_id)]
params.pop('group_id', None)
response = forum_api.search_threads(**params)
else:
response = utils.perform_request(
'get',
url,
params,
metric_tags=['course_id:{}'.format(query_params['course_id'])],
metric_action='thread.search',
paged_results=True
)
response = forum_api.get_user_threads(**params)
if query_params.get('text'):
search_query = query_params['text']
@@ -124,7 +110,6 @@ class Thread(models.Model):
total_results=total_results
)
)
return utils.CommentClientPaginatedResult(
collection=response.get('collection', []),
page=response.get('page', 1),

22
openedx/core/djangoapps/django_comment_common/comment_client/user.py
View File

@@ -181,7 +181,7 @@ class User(models.Model):
user_id = params.pop("user_id", None)
if "text" in params:
params.pop("text")
response = forum_api.get_user_subscriptions(user_id, str(course_key), params)
response = forum_api.get_user_subscriptions(user_id, str(course_key), utils.clean_forum_params(params))
else:
response = utils.perform_request(
'get',
@@ -218,21 +218,17 @@ class User(models.Model):
if is_forum_v2_enabled(course_key):
group_ids = [retrieve_params['group_id']] if 'group_id' in retrieve_params else []
is_complete = retrieve_params['complete']
params = utils.clean_forum_params({
"user_id": self.attributes["id"],
"group_ids": group_ids,
"course_id": course_id,
"complete": is_complete
})
try:
response = forum_api.get_user(
self.attributes["id"],
group_ids=group_ids,
course_id=course_id,
complete=is_complete
)
response = forum_api.get_user(**params)
except ForumV2RequestError as e:
self.save({"course_id": course_id})
response = forum_api.get_user(
self.attributes["id"],
group_ids=group_ids,
course_id=course_id,
complete=is_complete
)
response = forum_api.get_user(**params)
else:
try:
response = utils.perform_request(

17
openedx/core/djangoapps/django_comment_common/comment_client/utils.py
View File

@@ -103,6 +103,23 @@ def perform_request(method, url, data_or_params=None, raw=False,
return data
def clean_forum_params(params):
"""Convert string booleans to actual booleans and remove None values and empty lists from forum parameters."""
result = {}
for k, v in params.items():
if v is not None and v != []:
if isinstance(v, str):
if v.lower() == 'true':
result[k] = True
elif v.lower() == 'false':
result[k] = False
else:
result[k] = v
else:
result[k] = v
return result
class CommentClientError(Exception):
pass