From ac62e83958330e4d3e02867090b20fbc1458dbf4 Mon Sep 17 00:00:00 2001 From: mariagrimaldi Date: Tue, 8 Dec 2020 11:44:36 -0400 Subject: [PATCH 01/20] feat: remove edX branding on account deletion --- .../student_account/components/StudentAccountDeletion.jsx | 8 +------- .../components/StudentAccountDeletionModal.jsx | 8 +------- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/lms/static/js/student_account/components/StudentAccountDeletion.jsx b/lms/static/js/student_account/components/StudentAccountDeletion.jsx index 1341faa9ee73..e4fc4b3f4b91 100644 --- a/lms/static/js/student_account/components/StudentAccountDeletion.jsx +++ b/lms/static/js/student_account/components/StudentAccountDeletion.jsx @@ -38,13 +38,7 @@ export class StudentAccountDeletion extends React.Component { render() { const { deletionModalOpen, socialAuthConnected, isActive } = this.state; - const loseAccessText = StringUtils.interpolate( - gettext('You may also lose access to verified certificates and other program credentials like MicroMasters certificates. If you want to make a copy of these for your records before proceeding with deletion, follow the instructions for {htmlStart}printing or downloading a certificate{htmlEnd}.'), - { - htmlStart: '', - htmlEnd: '', - }, - ); + const loseAccessText = gettext('You may also lose access to verified certificates and other program credentials. You can make a copy of these for your records before proceeding with deletion.') const showError = socialAuthConnected || !isActive; diff --git a/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx b/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx index e2a83c61ff12..8d9f86f21f78 100644 --- a/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx +++ b/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx @@ -94,13 +94,7 @@ class StudentAccountDeletionConfirmationModal extends React.Component { validationMessage, } = this.state; const { onClose } = this.props; - const loseAccessText = StringUtils.interpolate( - gettext('You may also lose access to verified certificates and other program credentials like MicroMasters certificates. If you want to make a copy of these for your records before proceeding with deletion, follow the instructions for {htmlStart}printing or downloading a certificate{htmlEnd}.'), - { - htmlStart: '', - htmlEnd: '', - }, - ); + const loseAccessText = gettext('You may also lose access to verified certificates and other program credentials. You can make a copy of these for your records before proceeding with deletion.') const noteDeletion = StringUtils.interpolate( gettext('You have selected “Delete my account.” Deletion of your account and personal data is permanent and cannot be undone. {platformName} will not be able to recover your account or the data that is deleted.'), From 99147d25e7b5986fe2c065a9f04771929a3b6795 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Tue, 23 Jan 2024 16:11:49 -0400 Subject: [PATCH 02/20] refactor: address PR reviews --- .../student_account/components/StudentAccountDeletion.jsx | 8 +++----- .../components/StudentAccountDeletionModal.jsx | 4 +++- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lms/static/js/student_account/components/StudentAccountDeletion.jsx b/lms/static/js/student_account/components/StudentAccountDeletion.jsx index e4fc4b3f4b91..93544c11664c 100644 --- a/lms/static/js/student_account/components/StudentAccountDeletion.jsx +++ b/lms/static/js/student_account/components/StudentAccountDeletion.jsx @@ -107,11 +107,9 @@ export class StudentAccountDeletion extends React.Component { {bodyDeletion} {bodyDeletion2}

-

+

+ {loseAccessText} +

{bodyDeletion2}

{/* eslint-disable-next-line react/no-danger */} -

+

+ {loseAccessText} +

)} From acd2a917409fde08058ea0891a5bf591a8c79f57 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Wed, 21 Feb 2024 13:31:57 -0400 Subject: [PATCH 03/20] refactor: address PR reviews --- .../js/student_account/components/StudentAccountDeletion.jsx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lms/static/js/student_account/components/StudentAccountDeletion.jsx b/lms/static/js/student_account/components/StudentAccountDeletion.jsx index 93544c11664c..e108f0924034 100644 --- a/lms/static/js/student_account/components/StudentAccountDeletion.jsx +++ b/lms/static/js/student_account/components/StudentAccountDeletion.jsx @@ -107,9 +107,7 @@ export class StudentAccountDeletion extends React.Component { {bodyDeletion} {bodyDeletion2}

-

- {loseAccessText} -

+

{loseAccessText}

Date: Wed, 21 Feb 2024 15:02:29 -0400 Subject: [PATCH 04/20] refactor: address PR reviews --- .../components/StudentAccountDeletionModal.jsx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx b/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx index b8d7f712025a..dceffc9ff4c4 100644 --- a/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx +++ b/lms/static/js/student_account/components/StudentAccountDeletionModal.jsx @@ -162,9 +162,7 @@ class StudentAccountDeletionConfirmationModal extends React.Component { {bodyDeletion2}

{/* eslint-disable-next-line react/no-danger */} -

- {loseAccessText} -

+

{loseAccessText}

)} From c0020a87691d0962028770e6ba987887ea643548 Mon Sep 17 00:00:00 2001 From: Blue Date: Mon, 26 Feb 2024 10:21:49 +0500 Subject: [PATCH 05/20] fix: replace username with name in contact us form (#34252) Description: Replace username with name in contact us form VAN-1822 --- .../support/static/support/jsx/logged_in_user.jsx | 6 ++++-- lms/templates/support/contact_us.html | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/lms/djangoapps/support/static/support/jsx/logged_in_user.jsx b/lms/djangoapps/support/static/support/jsx/logged_in_user.jsx index 974ddb28efce..e6cac8116842 100644 --- a/lms/djangoapps/support/static/support/jsx/logged_in_user.jsx +++ b/lms/djangoapps/support/static/support/jsx/logged_in_user.jsx @@ -131,13 +131,14 @@ function LoggedInUser({

{StringUtils.interpolate( - gettext('What can we help you with, {username}?'), - { username: userInformation.username }, + gettext('What can we help you with, {fullName}?'), + { fullName: userInformation.fullName }, )}

@@ -176,6 +177,7 @@ LoggedInUser.propTypes = { reDirectUser: PropTypes.func.isRequired, userInformation: PropTypes.shape({ course_id: PropTypes.string, + fullName: PropTypes.string, username: PropTypes.string, email: PropTypes.string, // eslint-disable-next-line react/forbid-prop-types diff --git a/lms/templates/support/contact_us.html b/lms/templates/support/contact_us.html index 4a93d6023829..05cbe4f9f5e3 100644 --- a/lms/templates/support/contact_us.html +++ b/lms/templates/support/contact_us.html @@ -41,6 +41,7 @@ % if user.is_authenticated: context['user'] = { + 'fullName': "${user.profile.name | n, js_escaped_string}", 'username': "${user.username | n, js_escaped_string}", 'email': "${user.email | n, js_escaped_string}", 'course_id': "${course_id | n, js_escaped_string}" From c61df904c1d2a5f523f1da44460c21e17ec087ee Mon Sep 17 00:00:00 2001 From: ayesha waris <73840786+ayesha-waris@users.noreply.github.com> Date: Mon, 26 Feb 2024 16:21:18 +0500 Subject: [PATCH 06/20] fix: Error message does not show when user clicks Dismiss button (#34277) --- cms/templates/course_outline.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cms/templates/course_outline.html b/cms/templates/course_outline.html index fbcb2941b24f..b3eca807e076 100644 --- a/cms/templates/course_outline.html +++ b/cms/templates/course_outline.html @@ -90,7 +90,7 @@

${_("This course was created as a re-run. Some manual
  • - + ${_("Dismiss")} From 653596232178cfd7e12bd9df93b2e94b480c7e82 Mon Sep 17 00:00:00 2001 From: MueezKhan246 Date: Mon, 26 Feb 2024 12:57:58 +0000 Subject: [PATCH 07/20] feat: Upgrade Python dependency edx-enterprise added management command to clear out excessive records for API log table Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master` --- requirements/constraints.txt | 2 +- requirements/edx/base.txt | 2 +- requirements/edx/development.txt | 2 +- requirements/edx/doc.txt | 2 +- requirements/edx/testing.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/requirements/constraints.txt b/requirements/constraints.txt index 11f9834b517f..1b8782391173 100644 --- a/requirements/constraints.txt +++ b/requirements/constraints.txt @@ -23,7 +23,7 @@ click>=8.0,<9.0 # The team that owns this package will manually bump this package rather than having it pulled in automatically. # This is to allow them to better control its deployment and to do it in a process that works better # for them. -edx-enterprise==4.12.2 +edx-enterprise==4.12.3 # Stay on LTS version, remove once this is added to common constraint Django<5.0 diff --git a/requirements/edx/base.txt b/requirements/edx/base.txt index 984440da48d0..4f7c75aafe05 100644 --- a/requirements/edx/base.txt +++ b/requirements/edx/base.txt @@ -476,7 +476,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.2 +edx-enterprise==4.12.3 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/kernel.in diff --git a/requirements/edx/development.txt b/requirements/edx/development.txt index fcd82da8e190..fed68ad0d6d5 100644 --- a/requirements/edx/development.txt +++ b/requirements/edx/development.txt @@ -750,7 +750,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.2 +edx-enterprise==4.12.3 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/doc.txt diff --git a/requirements/edx/doc.txt b/requirements/edx/doc.txt index 20ce9f32cfa8..244c9cca718d 100644 --- a/requirements/edx/doc.txt +++ b/requirements/edx/doc.txt @@ -550,7 +550,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.2 +edx-enterprise==4.12.3 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/base.txt diff --git a/requirements/edx/testing.txt b/requirements/edx/testing.txt index 4319294d232c..ee1fc9864146 100644 --- a/requirements/edx/testing.txt +++ b/requirements/edx/testing.txt @@ -576,7 +576,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.2 +edx-enterprise==4.12.3 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/base.txt From 35020961833e58c3e4972622404f8ae566032d26 Mon Sep 17 00:00:00 2001 From: Tim McCormack Date: Mon, 26 Feb 2024 17:10:59 -0500 Subject: [PATCH 08/20] chore: Update org to openedx for move-affected repos (#34297) See https://github.com/edx/edx-arch-experiments/issues/558 --- lms/envs/common.py | 2 +- requirements/edx/kernel.in | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index cfbdd70132b1..2ff6621a0d19 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -1036,7 +1036,7 @@ # .. if user is registering before enrollment start date or after enrollment end date # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2022-06-06 - # .. toggle_tickets: 'https://github.com/edx/edx-platform/pull/29538' + # .. toggle_tickets: 'https://github.com/openedx/edx-platform/pull/29538' 'DISABLE_ALLOWED_ENROLLMENT_IF_ENROLLMENT_CLOSED': False, # .. toggle_name: FEATURES['SEND_LEARNING_CERTIFICATE_LIFECYCLE_EVENTS_TO_BUS'] diff --git a/requirements/edx/kernel.in b/requirements/edx/kernel.in index 3139561ff819..1f2b7a6c5bfb 100644 --- a/requirements/edx/kernel.in +++ b/requirements/edx/kernel.in @@ -159,4 +159,4 @@ user-util # Functionality for retiring users (GDPR com webob web-fragments # Provides the ability to render fragments of web pages XBlock[django] # Courseware component architecture -xss-utils # https://github.com/edx/edx-platform/pull/20633 Fix XSS via Translations +xss-utils # https://github.com/openedx/edx-platform/pull/20633 Fix XSS via Translations From 7fec28dea48c7a315dc8f56af6b50ab5cd0b2a3a Mon Sep 17 00:00:00 2001 From: Awais Ansari <79941147+awais-ansari@users.noreply.github.com> Date: Tue, 27 Feb 2024 12:22:15 +0500 Subject: [PATCH 09/20] fix: newline and alignment bug in survey option mobile view (#34295) --- lms/static/sass/lms-course.scss | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lms/static/sass/lms-course.scss b/lms/static/sass/lms-course.scss index b9ef46bacc44..a089484ac098 100644 --- a/lms/static/sass/lms-course.scss +++ b/lms/static/sass/lms-course.scss @@ -25,6 +25,12 @@ } } -.percentage { - white-space: nowrap; +@media only screen and (max-width: 767px) { + .survey-table .survey-option .visible-mobile-only { + width: calc(100% - 21px) !important; + } + + .survey-percentage .percentage { + width: 54px !important; + } } From a110fc79d5c1cbe6a4507ac41209a063e8e950bd Mon Sep 17 00:00:00 2001 From: Saad Yousaf Date: Fri, 2 Feb 2024 12:41:30 +0500 Subject: [PATCH 10/20] feat: add notification for course updates --- cms/djangoapps/contentstore/config/waffle.py | 13 ++++ .../contentstore/course_info_model.py | 18 +++-- cms/djangoapps/contentstore/utils.py | 29 ++++++++ cms/djangoapps/contentstore/views/course.py | 4 +- .../notifications/audience_filters.py | 1 + .../notifications/base_notification.py | 29 +++++++- .../core/djangoapps/notifications/models.py | 2 +- .../notifications/tests/test_views.py | 71 +++++++++++++++++-- .../core/djangoapps/notifications/utils.py | 26 +++---- 9 files changed, 165 insertions(+), 28 deletions(-) diff --git a/cms/djangoapps/contentstore/config/waffle.py b/cms/djangoapps/contentstore/config/waffle.py index 8f431fa49327..b10566bb04cb 100644 --- a/cms/djangoapps/contentstore/config/waffle.py +++ b/cms/djangoapps/contentstore/config/waffle.py @@ -53,3 +53,16 @@ # .. toggle_warning: Flag course_experience.relative_dates should also be active for relative dates functionalities to work. # .. toggle_tickets: https://openedx.atlassian.net/browse/AA-844 CUSTOM_RELATIVE_DATES = CourseWaffleFlag(f'{WAFFLE_NAMESPACE}.custom_relative_dates', __name__) + + +# .. toggle_name: studio.enable_course_update_notifications +# .. toggle_implementation: CourseWaffleFlag +# .. toggle_default: False +# .. toggle_description: Waffle flag to enable course update notifications. +# .. toggle_use_cases: temporary, open_edx +# .. toggle_creation_date: 14-Feb-2024 +# .. toggle_target_removal_date: 14-Mar-2024 +ENABLE_COURSE_UPDATE_NOTIFICATIONS = CourseWaffleFlag( + f'{WAFFLE_NAMESPACE}.enable_course_update_notifications', + __name__ +) diff --git a/cms/djangoapps/contentstore/course_info_model.py b/cms/djangoapps/contentstore/course_info_model.py index 8f59998e716c..77a6a00c4b58 100644 --- a/cms/djangoapps/contentstore/course_info_model.py +++ b/cms/djangoapps/contentstore/course_info_model.py @@ -19,7 +19,8 @@ from django.http import HttpResponseBadRequest from django.utils.translation import gettext as _ -from cms.djangoapps.contentstore.utils import track_course_update_event +from cms.djangoapps.contentstore.config.waffle import ENABLE_COURSE_UPDATE_NOTIFICATIONS +from cms.djangoapps.contentstore.utils import track_course_update_event, send_course_update_notification from openedx.core.lib.xblock_utils import get_course_update_items from xmodule.html_block import CourseInfoBlock # lint-amnesty, pylint: disable=wrong-import-order from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order @@ -43,7 +44,7 @@ def get_course_updates(location, provided_id, user_id): return _get_visible_update(course_update_items) -def update_course_updates(location, update, passed_id=None, user=None): +def update_course_updates(location, update, passed_id=None, user=None, request_method=None): """ Either add or update the given course update. Add: @@ -86,8 +87,17 @@ def update_course_updates(location, update, passed_id=None, user=None): # update db record save_course_update_items(location, course_updates, course_update_items, user) - # track course update event - track_course_update_event(location.course_key, user, course_update_dict) + + if request_method == "POST": + # track course update event + track_course_update_event(location.course_key, user, course_update_dict) + + # send course update notification + if ENABLE_COURSE_UPDATE_NOTIFICATIONS.is_enabled(location.course_key): + send_course_update_notification( + location.course_key, course_update_dict["content"], user, + ) + # remove status key if "status" in course_update_dict: del course_update_dict["status"] diff --git a/cms/djangoapps/contentstore/utils.py b/cms/djangoapps/contentstore/utils.py index c72a7e3c3aa0..e186b0754a64 100644 --- a/cms/djangoapps/contentstore/utils.py +++ b/cms/djangoapps/contentstore/utils.py @@ -4,6 +4,7 @@ from __future__ import annotations import configparser import logging +import re from collections import defaultdict from contextlib import contextmanager from datetime import datetime, timezone @@ -22,6 +23,9 @@ from opaque_keys.edx.locator import LibraryLocator from openedx_events.content_authoring.data import DuplicatedXBlockData from openedx_events.content_authoring.signals import XBLOCK_DUPLICATED +from openedx_events.learning.data import CourseNotificationData +from openedx_events.learning.signals import COURSE_NOTIFICATION_REQUESTED + from milestones import api as milestones_api from pytz import UTC from xblock.fields import Scope @@ -62,6 +66,7 @@ from openedx.core.djangoapps.site_configuration.models import SiteConfiguration from openedx.core.djangoapps.models.course_details import CourseDetails from openedx.core.lib.courses import course_image_url +from openedx.core.lib.html_to_text import html_to_text from openedx.features.content_type_gating.models import ContentTypeGatingConfig from openedx.features.content_type_gating.partitions import CONTENT_TYPE_GATING_SCHEME from openedx.features.course_experience.waffle import ENABLE_COURSE_ABOUT_SIDEBAR_HTML @@ -1951,3 +1956,27 @@ def track_course_update_event(course_key, user, event_data=None): context = contexts.course_context_from_course_id(course_key) with tracker.get_tracker().context(event_name, context): tracker.emit(event_name, event_data) + + +def send_course_update_notification(course_key, content, user): + """ + Send course update notification + """ + text_content = re.sub(r"(\s| |//)+", " ", html_to_text(content)) + course = modulestore().get_course(course_key) + extra_context = { + 'author_id': user.id, + 'course_name': course.display_name, + } + notification_data = CourseNotificationData( + course_key=course_key, + content_context={ + "course_update_content": text_content, + **extra_context, + }, + notification_type="course_update", + content_url=f"{settings.LMS_BASE}/courses/{str(course_key)}/course/updates", + app_name="updates", + audience_filters={}, + ) + COURSE_NOTIFICATION_REQUESTED.send_event(course_notification_data=notification_data) diff --git a/cms/djangoapps/contentstore/views/course.py b/cms/djangoapps/contentstore/views/course.py index eac3c1048d7a..053514123825 100644 --- a/cms/djangoapps/contentstore/views/course.py +++ b/cms/djangoapps/contentstore/views/course.py @@ -1016,7 +1016,9 @@ def course_info_update_handler(request, course_key_string, provided_id=None): # can be either and sometimes django is rewriting one to the other: elif request.method in ('POST', 'PUT'): try: - return JsonResponse(update_course_updates(usage_key, request.json, provided_id, request.user)) + return JsonResponse(update_course_updates( + usage_key, request.json, provided_id, request.user, request.method + )) except: # lint-amnesty, pylint: disable=bare-except return HttpResponseBadRequest( "Failed to save", diff --git a/openedx/core/djangoapps/notifications/audience_filters.py b/openedx/core/djangoapps/notifications/audience_filters.py index fe9a047f78ca..9bd18a90c637 100644 --- a/openedx/core/djangoapps/notifications/audience_filters.py +++ b/openedx/core/djangoapps/notifications/audience_filters.py @@ -104,6 +104,7 @@ def filter(self, enrollment_modes): return CourseEnrollment.objects.filter( course_id=self.course_key, mode__in=enrollment_modes, + is_active=True, ).values_list('user_id', flat=True) diff --git a/openedx/core/djangoapps/notifications/base_notification.py b/openedx/core/djangoapps/notifications/base_notification.py index 510d2b9125de..1942da5f5c2a 100644 --- a/openedx/core/djangoapps/notifications/base_notification.py +++ b/openedx/core/djangoapps/notifications/base_notification.py @@ -161,7 +161,24 @@ }, 'email_template': '', 'filters': [FILTER_AUDIT_EXPIRED_USERS_WITH_NO_ROLE] - } + }, + 'course_update': { + 'notification_app': 'updates', + 'name': 'course_update', + 'is_core': False, + 'info': '', + 'web': True, + 'email': True, + 'push': True, + 'non_editable': [], + 'content_template': _('<{p}>You have a new course update: ' + '<{strong}>{course_update_content}'), + 'content_context': { + 'course_update_content': 'Course update', + }, + 'email_template': '', + 'filters': [FILTER_AUDIT_EXPIRED_USERS_WITH_NO_ROLE] + }, } COURSE_NOTIFICATION_APPS = { @@ -173,7 +190,15 @@ 'core_email': True, 'core_push': True, 'non_editable': ['web'] - } + }, + 'updates': { + 'enabled': True, + 'core_info': _('Notifications for new announcements and updates from the course team.'), + 'core_web': True, + 'core_email': True, + 'core_push': True, + 'non_editable': [] + }, } diff --git a/openedx/core/djangoapps/notifications/models.py b/openedx/core/djangoapps/notifications/models.py index 1014683f062c..1fae970a404e 100644 --- a/openedx/core/djangoapps/notifications/models.py +++ b/openedx/core/djangoapps/notifications/models.py @@ -21,7 +21,7 @@ NOTIFICATION_CHANNELS = ['web', 'push', 'email'] # Update this version when there is a change to any course specific notification type or app. -COURSE_NOTIFICATION_CONFIG_VERSION = 6 +COURSE_NOTIFICATION_CONFIG_VERSION = 7 def get_course_notification_preference_config(): diff --git a/openedx/core/djangoapps/notifications/tests/test_views.py b/openedx/core/djangoapps/notifications/tests/test_views.py index 45040e6b0638..2c44f4804c1f 100644 --- a/openedx/core/djangoapps/notifications/tests/test_views.py +++ b/openedx/core/djangoapps/notifications/tests/test_views.py @@ -249,13 +249,47 @@ def _expected_api_response(self, course=None): 'info': 'Notifications for responses and comments on your posts, and the ones you’re ' 'following, including endorsements to your responses and on your posts.' }, - 'new_discussion_post': {'web': False, 'email': False, 'push': False, 'info': ''}, - 'new_question_post': {'web': False, 'email': False, 'push': False, 'info': ''}, - 'content_reported': {'web': True, 'email': True, 'push': True, 'info': ''}, + 'new_discussion_post': { + 'web': False, + 'email': False, + 'push': False, + 'info': '' + }, + 'new_question_post': { + 'web': False, + 'email': False, + 'push': False, + 'info': '' + }, + 'content_reported': { + 'web': True, + 'email': True, + 'push': True, + 'info': '' + }, }, 'non_editable': { 'core': ['web'] } + }, + 'updates': { + 'enabled': True, + 'core_notification_types': [], + 'notification_types': { + 'course_update': { + 'web': True, + 'email': True, + 'push': True, + 'info': '' + }, + 'core': { + 'web': True, + 'email': True, + 'push': True, + 'info': 'Notifications for new announcements and updates from the course team.' + } + }, + 'non_editable': {} } } } @@ -293,8 +327,8 @@ def test_get_user_notification_preference(self, mock_emit): @mock.patch.dict(COURSE_NOTIFICATION_TYPES, { **COURSE_NOTIFICATION_TYPES, **{ - 'new_question_post': { - 'name': 'new_question_post', + 'content_reported': { + 'name': 'content_reported', 'visible_to': [FORUM_ROLE_MODERATOR, FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_ADMINISTRATOR] } } @@ -318,7 +352,9 @@ def test_get_user_notification_preference_with_visibility_settings(self, role, m response = self.client.get(self.path) self.assertEqual(response.status_code, status.HTTP_200_OK) + expected_response = self._expected_api_response() + if not role: expected_response = remove_notifications_with_visibility_settings(expected_response) @@ -474,6 +510,27 @@ def _expected_api_response(self, course=None): 'non_editable': { 'core': ['web'] } + }, + 'updates': { + 'enabled': True, + 'core_notification_types': [ + + ], + 'notification_types': { + 'course_update': { + 'web': True, + 'email': True, + 'push': True, + 'info': '' + }, + 'core': { + 'web': True, + 'email': True, + 'push': True, + 'info': 'Notifications for new announcements and updates from the course team.' + } + }, + 'non_editable': {} } } } @@ -742,7 +799,7 @@ def test_get_unseen_notifications_count_with_show_notifications_tray(self, show_ self.assertEqual(response.status_code, 200) self.assertEqual(response.data['count'], 4) self.assertEqual(response.data['count_by_app_name'], { - 'App Name 1': 2, 'App Name 2': 1, 'App Name 3': 1, 'discussion': 0}) + 'App Name 1': 2, 'App Name 2': 1, 'App Name 3': 1, 'discussion': 0, 'updates': 0}) self.assertEqual(response.data['show_notifications_tray'], show_notifications_tray_enabled) def test_get_unseen_notifications_count_for_unauthenticated_user(self): @@ -763,7 +820,7 @@ def test_get_unseen_notifications_count_for_user_with_no_notifications(self): self.assertEqual(response.status_code, 200) self.assertEqual(response.data['count'], 0) - self.assertEqual(response.data['count_by_app_name'], {'discussion': 0}) + self.assertEqual(response.data['count_by_app_name'], {'discussion': 0, 'updates': 0}) def test_get_expiry_days_in_count_view(self): """ diff --git a/openedx/core/djangoapps/notifications/utils.py b/openedx/core/djangoapps/notifications/utils.py index 05d9e4ecd264..c3ce819c0011 100644 --- a/openedx/core/djangoapps/notifications/utils.py +++ b/openedx/core/djangoapps/notifications/utils.py @@ -121,19 +121,19 @@ def filter_out_visible_notifications( :param user_forum_roles: List of forum roles for the user :return: Updated user preferences dictionary """ - for key in user_preferences: - if 'notification_types' in user_preferences[key]: - # Iterate over the types to remove and pop them from the dictionary - for notification_type, is_visible_to in notifications_with_visibility.items(): - is_visible = False - for role in is_visible_to: - if role in user_forum_roles: - is_visible = True - break - if is_visible: - continue - - user_preferences[key]['notification_types'].pop(notification_type) + discussion_user_preferences = user_preferences.get('discussion', {}) + if 'notification_types' in discussion_user_preferences: + # Iterate over the types to remove and pop them from the dictionary + for notification_type, is_visible_to in notifications_with_visibility.items(): + is_visible = False + for role in is_visible_to: + if role in user_forum_roles: + is_visible = True + break + if is_visible: + continue + + discussion_user_preferences['notification_types'].pop(notification_type) return user_preferences From 383f5d636ae724244f8f34c1e3a8f6183ccdd034 Mon Sep 17 00:00:00 2001 From: Zainab Amir Date: Tue, 27 Feb 2024 03:20:15 -0800 Subject: [PATCH 11/20] feat: update account verification email context (#34294) --- common/djangoapps/student/views/management.py | 16 +++++++++++----- .../djangoapps/user_authn/tests/test_tasks.py | 3 ++- .../core/djangoapps/user_authn/views/register.py | 2 +- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/common/djangoapps/student/views/management.py b/common/djangoapps/student/views/management.py index 2b0c21bfbf99..eac799c5e1f0 100644 --- a/common/djangoapps/student/views/management.py +++ b/common/djangoapps/student/views/management.py @@ -172,14 +172,14 @@ def index(request, extra_context=None, user=AnonymousUser()): return render_to_response('index.html', context) -def compose_activation_email(user, user_registration=None, route_enabled=False, profile_name='', redirect_url=None): +def compose_activation_email( + user, user_registration=None, route_enabled=False, profile_name='', redirect_url=None, registration_flow=False +): """ Construct all the required params for the activation email through celery task """ - registration_flow = True if user_registration is None: - registration_flow = False user_registration = Registration.objects.get(user=user) message_context = generate_activation_email_context(user, user_registration) @@ -190,6 +190,7 @@ def compose_activation_email(user, user_registration=None, route_enabled=False, 'routed_user_email': user.email, 'routed_profile_name': profile_name, 'registration_flow': registration_flow, + 'is_enterprise_learner': is_enterprise_learner(user), }) if route_enabled: @@ -225,7 +226,9 @@ def _get_activation_confirmation_link(activation_key, redirect_url=None): return urllib.parse.urlunparse((scheme, netloc, path, params, query, fragment)) -def compose_and_send_activation_email(user, profile, user_registration=None, redirect_url=None): +def compose_and_send_activation_email( + user, profile, user_registration=None, redirect_url=None, registration_flow=False, +): """ Construct all the required params and send the activation email through celery task @@ -235,10 +238,13 @@ def compose_and_send_activation_email(user, profile, user_registration=None, red profile: profile object of the current logged-in user user_registration: registration of the current logged-in user redirect_url: The URL to redirect to after successful activation + registration_flow: Is the request coming from registration workflow """ route_enabled = settings.FEATURES.get('REROUTE_ACTIVATION_EMAIL') - msg = compose_activation_email(user, user_registration, route_enabled, profile.name, redirect_url) + msg = compose_activation_email( + user, user_registration, route_enabled, profile.name, redirect_url, registration_flow + ) from_address = configuration_helpers.get_value('ACTIVATION_EMAIL_FROM_ADDRESS') or ( configuration_helpers.get_value('email_from_address', settings.DEFAULT_FROM_EMAIL) ) diff --git a/openedx/core/djangoapps/user_authn/tests/test_tasks.py b/openedx/core/djangoapps/user_authn/tests/test_tasks.py index 7598448412ab..80516f20a39c 100644 --- a/openedx/core/djangoapps/user_authn/tests/test_tasks.py +++ b/openedx/core/djangoapps/user_authn/tests/test_tasks.py @@ -42,7 +42,8 @@ def test_ComposeEmail(self): assert self.msg.context['routed_user'] == self.student.username assert self.msg.context['routed_user_email'] == self.student.email assert self.msg.context['routed_profile_name'] == '' - assert self.msg.context['registration_flow'] is True + assert self.msg.context['registration_flow'] is False + assert self.msg.context['is_enterprise_learner'] is False @mock.patch('time.sleep', mock.Mock(return_value=None)) @mock.patch('openedx.core.djangoapps.user_authn.tasks.log') diff --git a/openedx/core/djangoapps/user_authn/views/register.py b/openedx/core/djangoapps/user_authn/views/register.py index c7889d96a7e4..a0e56fb43862 100644 --- a/openedx/core/djangoapps/user_authn/views/register.py +++ b/openedx/core/djangoapps/user_authn/views/register.py @@ -247,7 +247,7 @@ def create_account_with_params(request, params): # pylint: disable=too-many-sta else: redirect_to, root_url = get_next_url_for_login_page(request, include_host=True) redirect_url = get_redirect_url_with_host(root_url, redirect_to) - compose_and_send_activation_email(user, profile, registration, redirect_url) + compose_and_send_activation_email(user, profile, registration, redirect_url, True) if settings.FEATURES.get('ENABLE_DISCUSSION_EMAIL_DIGEST'): try: From fca51419f8facbcb0e6eaad7750bafee23f92509 Mon Sep 17 00:00:00 2001 From: Moeez Zahid Date: Tue, 27 Feb 2024 19:30:21 +0500 Subject: [PATCH 12/20] refactor: Increase size for mobile config singelton value (#34288) Co-authored-by: Abdul Moeez Zahid --- .../0005_alter_mobileconfig_value.py | 18 ++++++++++++++++++ lms/djangoapps/mobile_api/models.py | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 lms/djangoapps/mobile_api/migrations/0005_alter_mobileconfig_value.py diff --git a/lms/djangoapps/mobile_api/migrations/0005_alter_mobileconfig_value.py b/lms/djangoapps/mobile_api/migrations/0005_alter_mobileconfig_value.py new file mode 100644 index 000000000000..21390296d630 --- /dev/null +++ b/lms/djangoapps/mobile_api/migrations/0005_alter_mobileconfig_value.py @@ -0,0 +1,18 @@ +# Generated by Django 4.2.10 on 2024-02-23 06:14 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('mobile_api', '0004_mobileconfig'), + ] + + operations = [ + migrations.AlterField( + model_name='mobileconfig', + name='value', + field=models.CharField(max_length=1000), + ), + ] diff --git a/lms/djangoapps/mobile_api/models.py b/lms/djangoapps/mobile_api/models.py index ba6f73721456..c80126996ace 100644 --- a/lms/djangoapps/mobile_api/models.py +++ b/lms/djangoapps/mobile_api/models.py @@ -110,7 +110,7 @@ class MobileConfig(TimeStampedModel): .. no_pii: """ name = models.CharField(max_length=255) - value = models.CharField(max_length=255) + value = models.CharField(max_length=1000) class Meta: app_label = "mobile_api" From a497ff2bd21d487bdcbc5c2e944cda758fd48d2e Mon Sep 17 00:00:00 2001 From: alex-sheehan-edx Date: Tue, 27 Feb 2024 15:35:12 +0000 Subject: [PATCH 13/20] feat: Upgrade Python dependency edx-enterprise edx enterprise version bump 4.12.4 Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master` --- requirements/constraints.txt | 2 +- requirements/edx/base.txt | 2 +- requirements/edx/development.txt | 2 +- requirements/edx/doc.txt | 2 +- requirements/edx/testing.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/requirements/constraints.txt b/requirements/constraints.txt index 1b8782391173..e8c92a4a3fc3 100644 --- a/requirements/constraints.txt +++ b/requirements/constraints.txt @@ -23,7 +23,7 @@ click>=8.0,<9.0 # The team that owns this package will manually bump this package rather than having it pulled in automatically. # This is to allow them to better control its deployment and to do it in a process that works better # for them. -edx-enterprise==4.12.3 +edx-enterprise==4.12.4 # Stay on LTS version, remove once this is added to common constraint Django<5.0 diff --git a/requirements/edx/base.txt b/requirements/edx/base.txt index 4f7c75aafe05..4fc911d74c43 100644 --- a/requirements/edx/base.txt +++ b/requirements/edx/base.txt @@ -476,7 +476,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.3 +edx-enterprise==4.12.4 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/kernel.in diff --git a/requirements/edx/development.txt b/requirements/edx/development.txt index fed68ad0d6d5..78a4bfb532ea 100644 --- a/requirements/edx/development.txt +++ b/requirements/edx/development.txt @@ -750,7 +750,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.3 +edx-enterprise==4.12.4 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/doc.txt diff --git a/requirements/edx/doc.txt b/requirements/edx/doc.txt index 244c9cca718d..c06a83d0b185 100644 --- a/requirements/edx/doc.txt +++ b/requirements/edx/doc.txt @@ -550,7 +550,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.3 +edx-enterprise==4.12.4 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/base.txt diff --git a/requirements/edx/testing.txt b/requirements/edx/testing.txt index ee1fc9864146..6fcc7f7adab3 100644 --- a/requirements/edx/testing.txt +++ b/requirements/edx/testing.txt @@ -576,7 +576,7 @@ edx-drf-extensions==10.2.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.12.3 +edx-enterprise==4.12.4 # via # -c requirements/edx/../constraints.txt # -r requirements/edx/base.txt From 56d4b47f2d8c90725ef76b415366312a1aaf6307 Mon Sep 17 00:00:00 2001 From: jansenk Date: Tue, 27 Feb 2024 12:09:25 -0800 Subject: [PATCH 14/20] feat: add list endpoint for course reset enabled enrollments --- lms/djangoapps/support/models.py | 20 ++ lms/djangoapps/support/tests/factories.py | 29 ++ lms/djangoapps/support/tests/test_views.py | 264 +++++++++++++++++++ lms/djangoapps/support/urls.py | 7 + lms/djangoapps/support/views/course_reset.py | 100 +++++++ 5 files changed, 420 insertions(+) create mode 100644 lms/djangoapps/support/tests/factories.py create mode 100644 lms/djangoapps/support/views/course_reset.py diff --git a/lms/djangoapps/support/models.py b/lms/djangoapps/support/models.py index 7915d1aa91f1..9fa254fe6ecc 100644 --- a/lms/djangoapps/support/models.py +++ b/lms/djangoapps/support/models.py @@ -28,6 +28,14 @@ class CourseResetCourseOptIn(TimeStampedModel): def __str__(self): return f'{self.course_id} - {"ACTIVE" if self.active else "INACTIVE"}' + @staticmethod + def all_active(): + return CourseResetCourseOptIn.objects.filter(active=True) + + @staticmethod + def all_active_course_ids(): + return [course.course_id for course in CourseResetCourseOptIn.all_active()] + class CourseResetAudit(TimeStampedModel): """ @@ -57,3 +65,15 @@ class CourseResetStatus(TextChoices): default=CourseResetStatus.ENQUEUED, ) completed_at = DateTimeField(default=None, null=True, blank=True) + + def status_message(self): + """ Return a string message about the status of this audit """ + if self.status == self.CourseResetStatus.FAILED: + return f"Failed on {self.modified}" + if self.status == self.CourseResetStatus.ENQUEUED: + return f"Enqueued - Created {self.created} by {self.reset_by.username}" + if self.status == self.CourseResetStatus.COMPLETE: + return f"Completed on {self.completed_at} by {self.reset_by.username}" + if self.status == self.CourseResetStatus.IN_PROGRESS: + return f"In progress - Started on {self.modified} by {self.reset_by.username}" + return self.status diff --git a/lms/djangoapps/support/tests/factories.py b/lms/djangoapps/support/tests/factories.py new file mode 100644 index 000000000000..93f68b11b3c7 --- /dev/null +++ b/lms/djangoapps/support/tests/factories.py @@ -0,0 +1,29 @@ +""" Factories for course reset models """ +import factory +from factory.django import DjangoModelFactory +from common.djangoapps.student.tests.factories import CourseEnrollmentFactory, UserFactory + + +from lms.djangoapps.support.models import ( + CourseResetCourseOptIn, + CourseResetAudit +) + + +class CourseResetCourseOptInFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring + class Meta: + model = CourseResetCourseOptIn + + course_id = None + active = True + + +class CourseResetAuditFactory(DjangoModelFactory): # lint-amnesty, pylint: disable=missing-class-docstring + class Meta: + model = CourseResetAudit + + course = factory.SubFactory(CourseResetCourseOptInFactory) + course_enrollment = factory.SubFactory(CourseEnrollmentFactory) + reset_by = factory.SubFactory(UserFactory) + status = CourseResetAudit.CourseResetStatus.ENQUEUED + completed_at = None diff --git a/lms/djangoapps/support/tests/test_views.py b/lms/djangoapps/support/tests/test_views.py index 51d847d21802..6338935470f4 100644 --- a/lms/djangoapps/support/tests/test_views.py +++ b/lms/djangoapps/support/tests/test_views.py @@ -54,7 +54,9 @@ from common.djangoapps.third_party_auth.tests.factories import SAMLProviderConfigFactory from common.test.utils import disable_signal from lms.djangoapps.program_enrollments.tests.factories import ProgramCourseEnrollmentFactory, ProgramEnrollmentFactory +from lms.djangoapps.support.models import CourseResetAudit from lms.djangoapps.support.serializers import ProgramEnrollmentSerializer +from lms.djangoapps.support.tests.factories import CourseResetCourseOptInFactory, CourseResetAuditFactory from lms.djangoapps.verify_student.models import VerificationDeadline from lms.djangoapps.verify_student.services import IDVerificationService from lms.djangoapps.verify_student.tests.factories import SSOVerificationFactory @@ -2067,3 +2069,265 @@ def test_verified_in_another_course(self): # assert that most recent enrollment (current status) has other_course_approved status self.assertEqual(response_data['current_status']['onboarding_status'], 'other_course_approved') self.assertEqual(response_data['current_status']['course_id'], self.course_id) + + +@ddt.ddt +class TestResetCourseViewGET(SupportViewTestCase): + """ Tests for the list endpoint for course reset """ + + def _url(self, username): + """ Helper to generate URL """ + return reverse("support:course_reset", kwargs={'username_or_email': username}) + + def setUp(self): + """ + Set permissions, create an open course and learner, enroll learner and opt into course reset + """ + super().setUp() + SupportStaffRole().add_users(self.user) + self.now = datetime.now().replace(tzinfo=UTC) + + self.course = CourseFactory.create( + start=self.now - timedelta(days=90), + end=self.now + timedelta(days=90), + ) + self.course_id = str(self.course.id) + self.course_overview = CourseOverview.get_from_id(self.course.id) + self.learner = UserFactory.create() + self.enrollment = CourseEnrollmentFactory.create(user=self.learner, course_id=self.course.id) + self.opt_in = CourseResetCourseOptInFactory.create(course_id=self.course.id) + + def assert_course_ids(self, expected_course_ids, learner=None): + """ Helper that asserts the course ids that will be returned from the listing endpoint """ + learner = learner or self.learner + response = self.client.get(self._url(learner)) + self.assertEqual(response.status_code, 200) + + actual_course_ids = [course['course_id'] for course in response.json()] + self.assertEqual(expected_course_ids, actual_course_ids) + + def test_no_enrollments(self): + """ When a learner has no enrollments, the endpoint should return an empty list """ + no_enrollment_learner = UserFactory.create() + self.assert_course_ids([], learner=no_enrollment_learner) + + def test_not_opted_in(self): + """ + If a learner is enrolled in a course that is not opted into the course reset feature, + it will not be returned by the endpoint + """ + non_opted_in_course = CourseFactory.create() + enrollment = CourseEnrollmentFactory.create(user=self.learner, course_id=non_opted_in_course.id) + self.assert_course_ids([self.course_id]) + + def test_deactivated_opt_in(self): + """ + If a learner is enrolled in a course that has opted in, but that opt-in is + deactivated, it will not be returned from the endpoint + """ + response = self.client.get(self._url(self.learner)) + self.assert_course_ids([self.course_id]) + + self.opt_in.active = False + self.opt_in.save() + + self.assert_course_ids([]) + + def test_deactivated_enrollment(self): + """ + If a learner's enrollment in an opted in course is deactivated, + the course will not be returned by the endpoint + """ + response = self.client.get(self._url(self.learner)) + self.assert_course_ids([self.course_id]) + + self.enrollment.is_active = False + self.enrollment.save() + + self.assert_course_ids([]) + + def assertResponse(self, expected_response, learner=None): + """ Helper to assert the contents of the response from the listing endpoint """ + learner = learner or self.learner + response = self.client.get(self._url(learner)) + self.assertEqual(response.status_code, 200) + + actual_response = response.json() + self.assertEqual(expected_response, actual_response) + return actual_response + + def test_course_not_started(self): + """ If a course is opted in but has not started, it should not be resettable """ + self.course_overview.start = self.now + timedelta(days=10) + self.course_overview.end = self.now + timedelta(days=11) + self.course_overview.save() + self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course_overview.display_name, + 'can_reset': False, + 'status': 'Course Not Started' + }]) + + def test_course_ended(self): + """ If a course is opted in but has ended, it should not be resettable """ + self.course_overview.start = self.now - timedelta(days=11) + self.course_overview.end = self.now - timedelta(days=10) + self.course_overview.save() + self.assertResponse([ + { + 'course_id': self.course_id, + 'display_name': self.course_overview.display_name, + 'can_reset': False, + 'status': 'Course Ended' + } + ]) + + @patch('lms.djangoapps.support.views.course_reset.user_has_passing_grade_in_course', return_value=True) + def test_user_has_passing_grade(self, _): + """ If a course is opted in but the learner has a passing grade, it should not be resettable """ + self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course_overview.display_name, + 'can_reset': False, + 'status': 'Learner Has Passing Grade' + }]) + + @patch('lms.djangoapps.support.views.course_reset.user_has_passing_grade_in_course', return_value=True) + def test_ended_with_passing_grade(self, _): + """ + If a course has ended and the learner has a passing grade, + the passing grade message should override the ended message + """ + self.course_overview.start = self.now - timedelta(days=11) + self.course_overview.end = self.now - timedelta(days=10) + self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course_overview.display_name, + 'can_reset': False, + 'status': 'Learner Has Passing Grade' + }]) + + def test_available_course(self): + """ If a course is opted in and had nothing stopping it from being reset, it should be resettable """ + self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course.display_name, + 'can_reset': True, + 'status': 'Available' + }]) + + @ddt.unpack + @ddt.data( + (CourseResetAudit.CourseResetStatus.ENQUEUED, False), + (CourseResetAudit.CourseResetStatus.IN_PROGRESS, False), + (CourseResetAudit.CourseResetStatus.FAILED, True), + (CourseResetAudit.CourseResetStatus.COMPLETE, False), + ) + def test_audit(self, audit_status, expected_can_reset): + """ + If a course enrollment has a CourseResetAudit associated with it, + it should not be resettable unless the audit is FAILED + """ + audit = CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=audit_status, + ) + self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course.display_name, + 'can_reset': expected_can_reset, + 'status': audit.status_message() + }]) + + def test_multiple_courses(self): + """ Test for the behavior of multiple courses """ + courses = [CourseFactory.create(start=self.course.start, end=self.course.end) for _ in range(4)] + for course in courses: + CourseEnrollmentFactory.create(course_id=course.id, user=self.learner) + CourseResetCourseOptInFactory.create(course_id=course.id) + other_courses = [CourseFactory.create(start=self.course.start, end=self.course.end) for _ in range(4)] + for course in other_courses: + CourseEnrollmentFactory.create(course_id=course.id, user=self.learner) + + expected_response = [{ + 'course_id': self.course_id, + 'display_name': self.course.display_name, + 'can_reset': True, + 'status': 'Available' + }] + for course in courses: + expected_response.append({ + 'course_id': str(course.id), + 'display_name': course.display_name, + 'can_reset': True, + 'status': 'Available' + }) + + self.assertResponse(expected_response) + + def test_multiple_audits(self): + """ + If you have multiple audits for an enrollment (should only happen if process fails) + the information returned should be for the most recent ONLY + """ + daysago = lambda x: self.now - timedelta(days=x) + CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=CourseResetAudit.CourseResetStatus.FAILED, + created=daysago(3), + modified=daysago(3), + ) + CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=CourseResetAudit.CourseResetStatus.FAILED, + created=daysago(2), + modified=daysago(2), + ) + most_recent_audit = CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=CourseResetAudit.CourseResetStatus.IN_PROGRESS, + ) + + response = self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course.display_name, + 'can_reset': False, + 'status': most_recent_audit.status_message() + }]) + + def test_multiple_failed_audits(self): + """ + If you have multiple audits for an enrollment and the most recent was a failure, + you should still be able to reset the course + """ + daysago = lambda x: self.now - timedelta(days=x) + CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=CourseResetAudit.CourseResetStatus.FAILED, + created=daysago(3), + modified=daysago(3), + ) + CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=CourseResetAudit.CourseResetStatus.FAILED, + created=daysago(2), + modified=daysago(2), + ) + most_recent_audit = CourseResetAuditFactory.create( + course=self.opt_in, + course_enrollment=self.enrollment, + status=CourseResetAudit.CourseResetStatus.FAILED, + ) + + response = self.assertResponse([{ + 'course_id': self.course_id, + 'display_name': self.course.display_name, + 'can_reset': True, + 'status': most_recent_audit.status_message() + }]) diff --git a/lms/djangoapps/support/urls.py b/lms/djangoapps/support/urls.py index 6cce0afbf9d1..02d8be8519fe 100644 --- a/lms/djangoapps/support/urls.py +++ b/lms/djangoapps/support/urls.py @@ -8,6 +8,7 @@ from .views.certificate import CertificatesSupportView from .views.contact_us import ContactUsView from .views.course_entitlements import EntitlementSupportView +from .views.course_reset import CourseResetAPIView from .views.enrollments import EnrollmentSupportListView, EnrollmentSupportView from .views.feature_based_enrollments import FeatureBasedEnrollmentsSupportView, FeatureBasedEnrollmentSupportAPIView from .views.index import index @@ -24,6 +25,7 @@ ) from .views.onboarding_status import OnboardingView + COURSE_ENTITLEMENTS_VIEW = EntitlementSupportView.as_view() app_name = 'support' @@ -84,4 +86,9 @@ r'onboarding_status/(?P[\w.@+-]+)?$', OnboardingView.as_view(), name='onboarding_status' ), + re_path( + r'course_reset/(?P[\w.@+-]+)?$', + CourseResetAPIView.as_view(), + name='course_reset' + ), ] diff --git a/lms/djangoapps/support/views/course_reset.py b/lms/djangoapps/support/views/course_reset.py new file mode 100644 index 000000000000..b274d4a97fa1 --- /dev/null +++ b/lms/djangoapps/support/views/course_reset.py @@ -0,0 +1,100 @@ +""" Views for the course reset feature """ + +from rest_framework.response import Response +from django.contrib.auth import get_user_model +from django.utils.decorators import method_decorator +from rest_framework.views import APIView +from rest_framework.permissions import IsAuthenticated + + +from common.djangoapps.student.models import CourseEnrollment, get_user_by_username_or_email +from common.djangoapps.student.helpers import user_has_passing_grade_in_course +from lms.djangoapps.support.decorators import require_support_permission +from lms.djangoapps.support.models import ( + CourseResetCourseOptIn, + CourseResetAudit +) + +User = get_user_model() + + +def can_enrollment_be_reset(course_enrollment): + """ + Args: enrollment (CourseEnrollment) + Returns: tuple (boolean, string) + [0]: whether or not the course can be reset + [1]: a status message to present to the learner + or None if there is nothing notable about the enrollment and it can be reset + """ + course_overview = course_enrollment.course_overview + if not course_overview.has_started(): + return False, "Course Not Started" + if course_overview.has_ended(): + return False, "Course Ended" + if user_has_passing_grade_in_course(course_enrollment): + return False, "Learner Has Passing Grade" + + try: + audit = course_enrollment.courseresetaudit_set.latest('modified') + except CourseResetAudit.DoesNotExist: + return True, None + + audit_status_message = audit.status_message() + if audit.status == CourseResetAudit.CourseResetStatus.FAILED: + return True, audit_status_message + return False, audit_status_message + + +class CourseResetAPIView(APIView): + """ + A view to handle requests related to the course reset feature. + GET: List applicable courses, their statuses, and if they can be reset + POST: Reset a course for the given learner + """ + + permission_classes = ( + IsAuthenticated, + ) + + @method_decorator(require_support_permission) + def get(self, request, username_or_email): + """ + List the enrollments for this user that are in courses that have opted into the + course reset feature, including information about past resets or resets in progress, and + whether or not the reset will be allowed to be done for each returned enrollment + + returns a list of dicts with the format [ + { + 'course_id': + 'display_name': + 'status': + 'can_reset': (boolean) + } + ] + """ + try: + user = get_user_by_username_or_email(username_or_email) + except User.DoesNotExist: + return Response([]) + all_enabled_resettable_course_ids = CourseResetCourseOptIn.all_active_course_ids() + course_enrollments = CourseEnrollment.objects.filter( + is_active=True, + user=user, + course__id__in=all_enabled_resettable_course_ids + ).select_related("course").prefetch_related("courseresetaudit_set") + + result = [] + for course_enrollment in course_enrollments: + course_overview = course_enrollment.course_overview + can_reset, status_message = can_enrollment_be_reset(course_enrollment) + result.append({ + 'course_id': str(course_overview.id), + 'display_name': course_overview.display_name, + 'can_reset': can_reset, + 'status': status_message if status_message else "Available" + }) + return Response(result) + + @method_decorator(require_support_permission) + def post(self, request, username_or_email): + """ Other Ticket """ From 3a2b6dd8fcc909fd9128f81750f52650ba8ff906 Mon Sep 17 00:00:00 2001 From: Danyal Faheem <138459282+Danyal-Faheem@users.noreply.github.com> Date: Wed, 28 Feb 2024 10:14:08 +0500 Subject: [PATCH 15/20] fix: hide help button in unauthenticated studio header (#34249) Co-authored-by: Zia Fazal --- cms/templates/widgets/header.html | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cms/templates/widgets/header.html b/cms/templates/widgets/header.html index fc143797d87d..8b14398fc378 100644 --- a/cms/templates/widgets/header.html +++ b/cms/templates/widgets/header.html @@ -360,9 +360,11 @@

    ${_("Account Navigation")}

      + % if settings.FEATURES.get('ENABLE_HELP_LINK'):
    1. ${_("Help")}
      2. + % endif % if static.get_value('ALLOW_PUBLIC_ACCOUNT_CREATION', settings.FEATURES.get('ALLOW_PUBLIC_ACCOUNT_CREATION')) and settings.FEATURES.get('SHOW_REGISTRATION_LINKS', True):

    +
    +<% if (enableHideFromTOCUI) { %> +
    + +

    <%- gettext('It is visible to learners, ensuring that all learners can view its contents.') %>

    +
    +
    + <% if (!xblockInfo.isVertical()) { %> + +

    <%- gettext('It is intentionally hidden from standard navigation, ensuring that only individuals with the link can view its contents.') %>

    + <% if (hideFromTOC) { %> +

    + <%- gettext('If you make this section visible in the table of content, learners will be able to see its content.') %> +

    + <% } %> + <% } %> +
    +<% } %>
    + + <% if (enableHideFromTOCUI) { %> +

    <%- gettext('It is intentionally hidden from learners, ensuring that only the course staff can view its contents.') %>

    + <% } %> <% if (hasExplicitStaffLock && !ancestorLocked) { %>

    <% if (xblockInfo.isVertical()) { %> @@ -20,6 +48,7 @@ <%- interpolate(message, { xblockType: xblockType }, true) %> <% } %>

    - <% } %> + <% } %> +
    diff --git a/xmodule/modulestore/inheritance.py b/xmodule/modulestore/inheritance.py index 489365e80e0d..4c5a14b769cb 100644 --- a/xmodule/modulestore/inheritance.py +++ b/xmodule/modulestore/inheritance.py @@ -240,6 +240,13 @@ class InheritanceMixin(XBlockMixin): scope=Scope.settings ) + hide_from_toc = Boolean( + display_name=_("Hide from Table of Contents"), + help=_("Enter true or false. If true, this block will be hidden from the Table of Contents."), + default=False, + scope=Scope.settings + ) + @property def close_date(self): """