diff --git a/.github/workflows/unit-test-shards.json b/.github/workflows/unit-test-shards.json index 0acc1ebdc8fa..784f607f06ba 100644 --- a/.github/workflows/unit-test-shards.json +++ b/.github/workflows/unit-test-shards.json @@ -238,6 +238,7 @@ "cms/djangoapps/cms_user_tasks/", "cms/djangoapps/course_creators/", "cms/djangoapps/export_course_metadata/", + "cms/djangoapps/maintenance/", "cms/djangoapps/models/", "cms/djangoapps/pipeline_js/", "cms/djangoapps/xblock_config/", diff --git a/cms/djangoapps/contentstore/migrations/0010_publishableentitylink_downstream_parent_usage_key.py b/cms/djangoapps/contentstore/migrations/0010_publishableentitylink_downstream_parent_usage_key.py new file mode 100644 index 000000000000..bcc9a7cb2ccd --- /dev/null +++ b/cms/djangoapps/contentstore/migrations/0010_publishableentitylink_downstream_parent_usage_key.py @@ -0,0 +1,30 @@ +# Generated by Django 4.2.18 on 2025-02-19 23:32 + +from django.db import migrations +from opaque_keys.edx.django.models import UsageKeyField +from opaque_keys.edx.keys import UsageKey + + +class Migration(migrations.Migration): + + dependencies = [ + ('contentstore', '0009_learningcontextlinksstatus_publishableentitylink'), + ] + + operations = [ + migrations.AddField( + model_name='publishableentitylink', + name='downstream_parent_usage_key', + field=UsageKeyField( + db_index=True, + # Adds a default invalid value to the field to prevent the migration from failing + default=UsageKey.from_string('block-v1:edX+DemoX+Demo_Course+type@vertical+block@invalid'), + max_length=255 + ), + ), + migrations.AlterField( + model_name='publishableentitylink', + name='downstream_parent_usage_key', + field=UsageKeyField(db_index=True, max_length=255), + ), + ] diff --git a/cms/djangoapps/contentstore/models.py b/cms/djangoapps/contentstore/models.py index 6a1750b8e1c8..d9b1972b14bb 100644 --- a/cms/djangoapps/contentstore/models.py +++ b/cms/djangoapps/contentstore/models.py @@ -7,6 +7,7 @@ from config_models.models import ConfigurationModel from django.db import models +from django.db.models import QuerySet from django.db.models.fields import IntegerField, TextField from django.utils.translation import gettext_lazy as _ from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField @@ -105,6 +106,8 @@ class PublishableEntityLink(models.Model): # A downstream entity can only link to single upstream entity # whereas an entity can be upstream for multiple downstream entities. downstream_usage_key = UsageKeyField(max_length=255, unique=True) + # Search by parent key (i.e., unit key) + downstream_parent_usage_key = UsageKeyField(max_length=255, db_index=True) # Search by course/downstream key downstream_context_key = CourseKeyField(max_length=255, db_index=True) version_synced = models.IntegerField() @@ -115,6 +118,25 @@ class PublishableEntityLink(models.Model): def __str__(self): return f"{self.upstream_usage_key}->{self.downstream_usage_key}" + @property + def upstream_version(self) -> int | None: + """ + Returns upstream block version number if available. + """ + version_num = None + if hasattr(self.upstream_block, 'published'): + if hasattr(self.upstream_block.published, 'version'): + if hasattr(self.upstream_block.published.version, 'version_num'): + version_num = self.upstream_block.published.version.version_num + return version_num + + @property + def upstream_context_title(self) -> str: + """ + Returns upstream context title. + """ + return self.upstream_block.learning_package.title + class Meta: verbose_name = _("Publishable Entity Link") verbose_name_plural = _("Publishable Entity Links") @@ -127,6 +149,7 @@ def update_or_create( upstream_usage_key: UsageKey, upstream_context_key: str, downstream_usage_key: UsageKey, + downstream_parent_usage_key: UsageKey, downstream_context_key: CourseKey, version_synced: int, version_declined: int | None = None, @@ -141,6 +164,7 @@ def update_or_create( 'upstream_usage_key': upstream_usage_key, 'upstream_context_key': upstream_context_key, 'downstream_usage_key': downstream_usage_key, + 'downstream_parent_usage_key': downstream_parent_usage_key, 'downstream_context_key': downstream_context_key, 'version_synced': version_synced, 'version_declined': version_declined, @@ -170,6 +194,27 @@ def update_or_create( link.save() return link + @classmethod + def get_by_downstream_context(cls, downstream_context_key: CourseKey) -> QuerySet["PublishableEntityLink"]: + """ + Get all links for given downstream context, preselects related published version and learning package. + """ + return cls.objects.filter( + downstream_context_key=downstream_context_key + ).select_related( + "upstream_block__published__version", + "upstream_block__learning_package" + ) + + @classmethod + def get_by_upstream_usage_key(cls, upstream_usage_key: UsageKey) -> QuerySet["PublishableEntityLink"]: + """ + Get all downstream context keys for given upstream usage key + """ + return cls.objects.filter( + upstream_usage_key=upstream_usage_key, + ) + class LearningContextLinksStatusChoices(models.TextChoices): """ diff --git a/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py b/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py index 6e102bab44a1..83bc02b685e4 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py +++ b/cms/djangoapps/contentstore/rest_api/v2/serializers/__init__.py @@ -1,3 +1,4 @@ """Module for v2 serializers.""" +from cms.djangoapps.contentstore.rest_api.v2.serializers.downstreams import PublishableEntityLinksSerializer from cms.djangoapps.contentstore.rest_api.v2.serializers.home import CourseHomeTabSerializerV2 diff --git a/cms/djangoapps/contentstore/rest_api/v2/serializers/downstreams.py b/cms/djangoapps/contentstore/rest_api/v2/serializers/downstreams.py new file mode 100644 index 000000000000..930408040e67 --- /dev/null +++ b/cms/djangoapps/contentstore/rest_api/v2/serializers/downstreams.py @@ -0,0 +1,28 @@ +""" +Serializers for upstream -> downstream entity links. +""" + +from rest_framework import serializers + +from cms.djangoapps.contentstore.models import PublishableEntityLink + + +class PublishableEntityLinksSerializer(serializers.ModelSerializer): + """ + Serializer for publishable entity links. + """ + upstream_context_title = serializers.CharField(read_only=True) + upstream_version = serializers.IntegerField(read_only=True) + ready_to_sync = serializers.SerializerMethodField() + + def get_ready_to_sync(self, obj): + """Calculate ready_to_sync field""" + return bool( + obj.upstream_version and + obj.upstream_version > (obj.version_synced or 0) and + obj.upstream_version > (obj.version_declined or 0) + ) + + class Meta: + model = PublishableEntityLink + exclude = ['upstream_block', 'uuid'] diff --git a/cms/djangoapps/contentstore/rest_api/v2/urls.py b/cms/djangoapps/contentstore/rest_api/v2/urls.py index 3e653d07fbcf..4c58ad9c57b1 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/urls.py +++ b/cms/djangoapps/contentstore/rest_api/v2/urls.py @@ -3,7 +3,8 @@ from django.conf import settings from django.urls import path, re_path -from cms.djangoapps.contentstore.rest_api.v2.views import home, downstreams +from cms.djangoapps.contentstore.rest_api.v2.views import downstreams, home + app_name = "v2" urlpatterns = [ @@ -23,6 +24,16 @@ downstreams.DownstreamView.as_view(), name="downstream" ), + re_path( + f'^upstreams/{settings.COURSE_KEY_PATTERN}$', + downstreams.UpstreamListView.as_view(), + name='upstream-list' + ), + re_path( + f'^upstream/{settings.USAGE_KEY_PATTERN}/downstream-contexts$', + downstreams.DownstreamContextListView.as_view(), + name='downstream-context-list' + ), re_path( fr'^downstreams/{settings.USAGE_KEY_PATTERN}/sync$', downstreams.SyncFromUpstreamView.as_view(), diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py b/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py index 46e67e87ea0c..c7fa62c2c082 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py @@ -40,6 +40,11 @@ 400: Downstream block is not linked to upstream content. 404: Downstream block not found or user lacks permission to edit it. + /api/contentstore/v2/upstream/{usage_key_string}/downstream-contexts + + GET: List all downstream contexts (Courses) linked to a library block. + 200: A list of Course IDs and their display names and URLs. + # NOT YET IMPLEMENTED -- Will be needed for full Libraries Relaunch in ~Teak. /api/contentstore/v2/downstreams /api/contentstore/v2/downstreams?course_id=course-v1:A+B+C&ready_to_sync=true @@ -58,23 +63,36 @@ """ import logging +from itertools import groupby from attrs import asdict as attrs_asdict from django.contrib.auth.models import User # pylint: disable=imported-auth-user +from django.utils.translation import gettext_lazy as _ from opaque_keys import InvalidKeyError -from opaque_keys.edx.keys import UsageKey +from opaque_keys.edx.keys import CourseKey, UsageKey from rest_framework.exceptions import NotFound, ValidationError from rest_framework.request import Request from rest_framework.response import Response from rest_framework.views import APIView from xblock.core import XBlock +from cms.djangoapps.contentstore.helpers import import_static_assets_for_library_sync +from cms.djangoapps.contentstore.models import PublishableEntityLink +from cms.djangoapps.contentstore.rest_api.v2.serializers import PublishableEntityLinksSerializer +from cms.djangoapps.contentstore.utils import reverse_course_url, reverse_usage_url from cms.lib.xblock.upstream_sync import ( - UpstreamLink, UpstreamLinkException, NoUpstream, BadUpstream, BadDownstream, - fetch_customizable_fields, sync_from_upstream, decline_sync, sever_upstream_link + BadDownstream, + BadUpstream, + NoUpstream, + UpstreamLink, + UpstreamLinkException, + decline_sync, + fetch_customizable_fields, + sever_upstream_link, + sync_from_upstream, ) -from cms.djangoapps.contentstore.helpers import import_static_assets_for_library_sync -from common.djangoapps.student.auth import has_studio_write_access, has_studio_read_access +from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access +from openedx.core.djangoapps.content.course_overviews.models import CourseOverview from openedx.core.lib.api.view_utils import ( DeveloperErrorViewMixin, view_auth_classes, @@ -82,7 +100,6 @@ from xmodule.modulestore.django import modulestore from xmodule.modulestore.exceptions import ItemNotFoundError - logger = logging.getLogger(__name__) @@ -111,6 +128,97 @@ class _AuthenticatedRequest(Request): # ... +@view_auth_classes() +class UpstreamListView(DeveloperErrorViewMixin, APIView): + """ + Serves course->library publishable entity links + """ + def get(self, request: _AuthenticatedRequest, course_key_string: str): + """ + Fetches publishable entity links for given course key + """ + try: + course_key = CourseKey.from_string(course_key_string) + except InvalidKeyError as exc: + raise ValidationError(detail=f"Malformed course key: {course_key_string}") from exc + links = PublishableEntityLink.get_by_downstream_context(downstream_context_key=course_key) + serializer = PublishableEntityLinksSerializer(links, many=True) + return Response(serializer.data) + + +@view_auth_classes() +class DownstreamContextListView(DeveloperErrorViewMixin, APIView): + """ + Serves library block->course->container links + """ + def get(self, request: _AuthenticatedRequest, usage_key_string: str) -> Response: + """ + Fetches downstream links for given publishable entity + """ + try: + usage_key = UsageKey.from_string(usage_key_string) + except InvalidKeyError as exc: + raise ValidationError(detail=f"Malformed usage key: {usage_key_string}") from exc + + links = ( + PublishableEntityLink + .get_by_upstream_usage_key(upstream_usage_key=usage_key) + .order_by("downstream_context_key", "downstream_parent_usage_key") + .values("downstream_usage_key", "downstream_context_key", "downstream_parent_usage_key") + ) + + context_key_list = set(link["downstream_context_key"] for link in links) + + courses_display_name = dict( + CourseOverview.objects.filter(id__in=context_key_list).values_list('id', 'display_name') + ) + + result = [] + for context_key, links_by_context in groupby(links, lambda x: x["downstream_context_key"]): + if context_key not in courses_display_name: + raise BadDownstream(_("Course {context_key} not found").format(context_key=context_key)) + + course_link = { + "id": str(context_key), + "display_name": courses_display_name[context_key], + "url": reverse_course_url("course_handler", context_key), + "containers": [] + } + + for parent_key, links_by_unit in groupby(links_by_context, lambda x: x["downstream_parent_usage_key"]): + try: + parent = modulestore().get_item(parent_key) + + parent_link = { + "id": str(parent_key), + "display_name": parent.display_name, + "url": reverse_usage_url("container_handler", parent_key), + "links": [] + } + + for downstream_link in links_by_unit: + parent_link["links"].append({ + "id": str(downstream_link["downstream_usage_key"]), + }) + + # Don't include empty containers + if parent_link["links"]: + course_link["containers"].append(parent_link) + + except ItemNotFoundError: + logger.exception( + "Unit %s not found in course %s", + parent_key, + context_key + ) + + # Don't include empty courses + if course_link["containers"]: + result.append(course_link) + + return Response(result) + + @view_auth_classes(is_authenticated=True) class DownstreamView(DeveloperErrorViewMixin, APIView): """ diff --git a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py index 31877b9153d5..d3a707599ce7 100644 --- a/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py +++ b/cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstreams.py @@ -1,21 +1,25 @@ """ Unit tests for /api/contentstore/v2/downstreams/* JSON APIs. """ +from datetime import datetime, timezone from unittest.mock import patch + from django.conf import settings +from freezegun import freeze_time from cms.djangoapps.contentstore.helpers import StaticFileNotices -from cms.lib.xblock.upstream_sync import UpstreamLink, BadUpstream +from cms.lib.xblock.upstream_sync import BadUpstream, UpstreamLink from common.djangoapps.student.tests.factories import UserFactory +from openedx.core.djangoapps.content.course_overviews.tests.factories import CourseOverviewFactory from xmodule.modulestore.django import modulestore from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory, BlockFactory +from xmodule.modulestore.tests.factories import BlockFactory, CourseFactory from .. import downstreams as downstreams_views - MOCK_LIB_KEY = "lib:OpenedX:CSPROB3" -MOCK_UPSTREAM_REF = "lb:OpenedX:CSPROB3:html:843b4c73-1e2d-4ced-a0ff-24e503cdb3e4" +MOCK_UPSTREAM_REF = "lb:OpenedX:CSPROB3:video:843b4c73-1e2d-4ced-a0ff-24e503cdb3e4" +MOCK_HTML_UPSTREAM_REF = "lb:OpenedX:CSPROB3:html:843b4c73-1e2d-4ced-a0ff-24e503cdb3e4" MOCK_UPSTREAM_LINK = "{mfe_url}/library/{lib_key}/components?usageKey={usage_key}".format( mfe_url=settings.COURSE_AUTHORING_MICROFRONTEND_URL, lib_key=MOCK_LIB_KEY, @@ -38,24 +42,47 @@ def _get_upstream_link_bad(_downstream): raise BadUpstream(MOCK_UPSTREAM_ERROR) -class _DownstreamViewTestMixin: +class _BaseDownstreamViewTestMixin: """ Shared data and error test cases. """ - def setUp(self): """ Create a simple course with one unit and two videos, one of which is linked to an "upstream". """ super().setUp() + self.now = datetime.now(timezone.utc) + freezer = freeze_time(self.now) + self.addCleanup(freezer.stop) + freezer.start() + self.maxDiff = 2000 self.course = CourseFactory.create() + CourseOverviewFactory.create(id=self.course.id, display_name=self.course.display_name) chapter = BlockFactory.create(category='chapter', parent=self.course) sequential = BlockFactory.create(category='sequential', parent=chapter) - unit = BlockFactory.create(category='vertical', parent=sequential) - self.regular_video_key = BlockFactory.create(category='video', parent=unit).usage_key + self.unit = BlockFactory.create(category='vertical', parent=sequential) + self.regular_video_key = BlockFactory.create(category='video', parent=self.unit).usage_key self.downstream_video_key = BlockFactory.create( - category='video', parent=unit, upstream=MOCK_UPSTREAM_REF, upstream_version=123, + category='video', parent=self.unit, upstream=MOCK_UPSTREAM_REF, upstream_version=123, ).usage_key + self.downstream_html_key = BlockFactory.create( + category='html', parent=self.unit, upstream=MOCK_HTML_UPSTREAM_REF, upstream_version=1, + ).usage_key + + self.another_course = CourseFactory.create(display_name="Another Course") + CourseOverviewFactory.create(id=self.another_course.id, display_name=self.another_course.display_name) + another_chapter = BlockFactory.create(category="chapter", parent=self.another_course) + another_sequential = BlockFactory.create(category="sequential", parent=another_chapter) + self.another_unit = BlockFactory.create(category="vertical", parent=another_sequential) + self.another_video_keys = [] + for _ in range(3): + # Adds 3 videos linked to the same upstream + self.another_video_keys.append( + BlockFactory.create( + category="video", parent=self.another_unit, upstream=MOCK_UPSTREAM_REF, upstream_version=123, + ).usage_key + ) + self.fake_video_key = self.course.id.make_usage_key("video", "NoSuchVideo") self.superuser = UserFactory(username="superuser", password="password", is_staff=True, is_superuser=True) self.learner = UserFactory(username="learner", password="password") @@ -63,6 +90,11 @@ def setUp(self): def call_api(self, usage_key_string): raise NotImplementedError + +class SharedErrorTestCases(_BaseDownstreamViewTestMixin): + """ + Shared error test cases. + """ def test_404_downstream_not_found(self): """ Do we raise 404 if the specified downstream block could not be loaded? @@ -82,7 +114,7 @@ def test_404_downstream_not_accessible(self): assert "not found" in response.data["developer_message"] -class GetDownstreamViewTest(_DownstreamViewTestMixin, SharedModuleStoreTestCase): +class GetDownstreamViewTest(SharedErrorTestCases, SharedModuleStoreTestCase): """ Test that `GET /api/v2/contentstore/downstreams/...` inspects a downstream's link to an upstream. """ @@ -128,7 +160,7 @@ def test_200_no_upstream(self): assert response.data['upstream_link'] is None -class PutDownstreamViewTest(_DownstreamViewTestMixin, SharedModuleStoreTestCase): +class PutDownstreamViewTest(SharedErrorTestCases, SharedModuleStoreTestCase): """ Test that `PUT /api/v2/contentstore/downstreams/...` edits a downstream's link to an upstream. """ @@ -185,7 +217,7 @@ def test_400(self, sync: str): assert video_after.upstream is None -class DeleteDownstreamViewTest(_DownstreamViewTestMixin, SharedModuleStoreTestCase): +class DeleteDownstreamViewTest(SharedErrorTestCases, SharedModuleStoreTestCase): """ Test that `DELETE /api/v2/contentstore/downstreams/...` severs a downstream's link to an upstream. """ @@ -214,7 +246,7 @@ def test_204_no_upstream(self, mock_sever): assert mock_sever.call_count == 1 -class _DownstreamSyncViewTestMixin(_DownstreamViewTestMixin): +class _DownstreamSyncViewTestMixin(SharedErrorTestCases): """ Shared tests between the /api/contentstore/v2/downstreams/.../sync endpoints. """ @@ -277,3 +309,101 @@ def test_204(self, mock_decline_sync): response = self.call_api(self.downstream_video_key) assert response.status_code == 204 assert mock_decline_sync.call_count == 1 + + +class GetUpstreamViewTest(_BaseDownstreamViewTestMixin, SharedModuleStoreTestCase): + """ + Test that `GET /api/v2/contentstore/upstreams/...` returns list of links in given downstream context i.e. course. + """ + def call_api(self, usage_key_string): + return self.client.get(f"/api/contentstore/v2/upstreams/{usage_key_string}") + + def test_200_all_upstreams(self): + """ + Returns all upstream links for given course + """ + self.client.login(username="superuser", password="password") + response = self.call_api(self.course.id) + assert response.status_code == 200 + data = response.json() + date_format = self.now.isoformat().split("+")[0] + 'Z' + expected = [ + { + 'created': date_format, + 'downstream_context_key': str(self.course.id), + 'downstream_usage_key': str(self.downstream_video_key), + 'downstream_parent_usage_key': str(self.unit.usage_key), + 'id': 1, + 'ready_to_sync': False, + 'updated': date_format, + 'upstream_context_key': MOCK_LIB_KEY, + 'upstream_usage_key': MOCK_UPSTREAM_REF, + 'upstream_version': None, + 'version_declined': None, + 'version_synced': 123 + }, + { + 'created': date_format, + 'downstream_context_key': str(self.course.id), + 'downstream_usage_key': str(self.downstream_html_key), + 'downstream_parent_usage_key': str(self.unit.usage_key), + 'id': 2, + 'ready_to_sync': False, + 'updated': date_format, + 'upstream_context_key': MOCK_LIB_KEY, + 'upstream_usage_key': MOCK_HTML_UPSTREAM_REF, + 'upstream_version': None, + 'version_declined': None, + 'version_synced': 1, + }, + ] + self.assertListEqual(data, expected) + + +class GetDownstreamContextsTest(_BaseDownstreamViewTestMixin, SharedModuleStoreTestCase): + """ + Test that `GET /api/v2/contentstore/upstream/:usage_key/downstream-contexts returns list of + link contexts (i.e. courses) in given upstream entity (i.e. library block). + """ + def call_api(self, usage_key_string): + return self.client.get(f"/api/contentstore/v2/upstream/{usage_key_string}/downstream-contexts") + + def test_200_downstream_context_list(self): + """ + Returns all downstream courses for given library block + """ + self.client.login(username="superuser", password="password") + response = self.call_api(MOCK_UPSTREAM_REF) + assert response.status_code == 200 + data = response.json() + expected = [ + { + "id": str(self.course.id), + "display_name": str(self.course.display_name), + "url": f"/course/{str(self.course.id)}", + "containers": [ + { + "id": str(self.unit.usage_key), + "display_name": str(self.unit.display_name), + "url": f"/container/{str(self.unit.usage_key)}", + "links": [ + {"id": str(self.downstream_video_key)}, + ], + }, + ], + }, + { + "id": str(self.another_course.id), + "display_name": str(self.another_course.display_name), + "url": f"/course/{str(self.another_course.id)}", + "containers": [ + { + "id": str(self.another_unit.usage_key), + "display_name": str(self.another_unit.display_name), + "url": f"/container/{str(self.another_unit.usage_key)}", + "links": [{"id": str(key)} for key in self.another_video_keys], + }, + ], + }, + ] + self.assertListEqual(data, expected) diff --git a/cms/djangoapps/contentstore/utils.py b/cms/djangoapps/contentstore/utils.py index 79d8f757a7d1..5a828c098aa2 100644 --- a/cms/djangoapps/contentstore/utils.py +++ b/cms/djangoapps/contentstore/utils.py @@ -523,6 +523,18 @@ def get_custom_pages_url(course_locator) -> str: return custom_pages_url +def get_course_libraries_url(course_locator) -> str: + """ + Gets course authoring microfrontend URL for custom pages view. + """ + url = None + if libraries_v2_enabled(): + mfe_base_url = get_course_authoring_url(course_locator) + if mfe_base_url: + url = f'{mfe_base_url}/course/{course_locator}/libraries' + return url + + def get_taxonomy_list_url() -> str | None: """ Gets course authoring microfrontend URL for taxonomy list page view. @@ -2359,7 +2371,7 @@ def get_xblock_render_context(request, block): return "" -def create_or_update_xblock_upstream_link(xblock, course_key: str | CourseKey, created: datetime | None = None): +def create_or_update_xblock_upstream_link(xblock, course_key: str | CourseKey, created: datetime | None = None) -> None: """ Create or update upstream->downstream link in database for given xblock. """ @@ -2375,8 +2387,9 @@ def create_or_update_xblock_upstream_link(xblock, course_key: str | CourseKey, c lib_component, upstream_usage_key=xblock.upstream, upstream_context_key=str(upstream_usage_key.context_key), - downstream_context_key=course_key, downstream_usage_key=xblock.usage_key, + downstream_parent_usage_key=xblock.parent, + downstream_context_key=course_key, version_synced=xblock.upstream_version, version_declined=xblock.upstream_version_declined, created=created, diff --git a/cms/djangoapps/maintenance/__init__.py b/cms/djangoapps/maintenance/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/cms/djangoapps/maintenance/tests.py b/cms/djangoapps/maintenance/tests.py new file mode 100644 index 000000000000..51f776b00afa --- /dev/null +++ b/cms/djangoapps/maintenance/tests.py @@ -0,0 +1,194 @@ +""" +Tests for the maintenance app views. +""" + + +import ddt +from django.conf import settings +from django.urls import reverse + +from common.djangoapps.student.tests.factories import AdminFactory, UserFactory +from openedx.features.announcements.models import Announcement +from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order + +from .views import MAINTENANCE_VIEWS + +# This list contains URLs of all maintenance app views. +MAINTENANCE_URLS = [reverse(view['url']) for view in MAINTENANCE_VIEWS.values()] + + +class TestMaintenanceIndex(ModuleStoreTestCase): + """ + Tests for maintenance index view. + """ + + def setUp(self): + super().setUp() + self.user = AdminFactory() + login_success = self.client.login(username=self.user.username, password=self.TEST_PASSWORD) + self.assertTrue(login_success) + self.view_url = reverse('maintenance:maintenance_index') + + def test_maintenance_index(self): + """ + Test that maintenance index view lists all the maintenance app views. + """ + response = self.client.get(self.view_url) + self.assertContains(response, 'Maintenance', status_code=200) + + # Check that all the expected links appear on the index page. + for url in MAINTENANCE_URLS: + self.assertContains(response, url, status_code=200) + + +@ddt.ddt +class MaintenanceViewTestCase(ModuleStoreTestCase): + """ + Base class for maintenance view tests. + """ + view_url = '' + + def setUp(self): + super().setUp() + self.user = AdminFactory() + login_success = self.client.login(username=self.user.username, password=self.TEST_PASSWORD) + self.assertTrue(login_success) + + def verify_error_message(self, data, error_message): + """ + Verify the response contains error message. + """ + response = self.client.post(self.view_url, data=data, HTTP_X_REQUESTED_WITH='XMLHttpRequest') + self.assertContains(response, error_message, status_code=200) + + def tearDown(self): + """ + Reverse the setup. + """ + self.client.logout() + super().tearDown() + + +@ddt.ddt +class MaintenanceViewAccessTests(MaintenanceViewTestCase): + """ + Tests for access control of maintenance views. + """ + @ddt.data(*MAINTENANCE_URLS) + def test_require_login(self, url): + """ + Test that maintenance app requires user login. + """ + # Log out then try to retrieve the page + self.client.logout() + response = self.client.get(url) + + # Expect a redirect to the login page + redirect_url = '{login_url}?next={original_url}'.format( + login_url=settings.LOGIN_URL, + original_url=url, + ) + + # Studio login redirects to LMS login + self.assertRedirects(response, redirect_url, target_status_code=302) + + @ddt.data(*MAINTENANCE_URLS) + def test_global_staff_access(self, url): + """ + Test that all maintenance app views are accessible to global staff user. + """ + response = self.client.get(url) + self.assertEqual(response.status_code, 200) + + @ddt.data(*MAINTENANCE_URLS) + def test_non_global_staff_access(self, url): + """ + Test that all maintenance app views are not accessible to non-global-staff user. + """ + user = UserFactory(username='test', email='test@example.com', password=self.TEST_PASSWORD) + login_success = self.client.login(username=user.username, password=self.TEST_PASSWORD) + self.assertTrue(login_success) + + response = self.client.get(url) + self.assertContains( + response, + f'Must be {settings.PLATFORM_NAME} staff to perform this action.', + status_code=403 + ) + + +@ddt.ddt +class TestAnnouncementsViews(MaintenanceViewTestCase): + """ + Tests for the announcements edit view. + """ + + def setUp(self): + super().setUp() + self.admin = AdminFactory.create( + email='staff@edx.org', + username='admin', + password=self.TEST_PASSWORD + ) + self.client.login(username=self.admin.username, password=self.TEST_PASSWORD) + self.non_staff_user = UserFactory.create( + email='test@edx.org', + username='test', + password=self.TEST_PASSWORD + ) + + def test_index(self): + """ + Test create announcement view + """ + url = reverse("maintenance:announcement_index") + response = self.client.get(url) + self.assertContains(response, '
') + + def test_create(self): + """ + Test create announcement view + """ + url = reverse("maintenance:announcement_create") + self.client.post(url, {"content": "Test Create Announcement", "active": True}) + result = Announcement.objects.filter(content="Test Create Announcement").exists() + self.assertTrue(result) + + def test_edit(self): + """ + Test edit announcement view + """ + announcement = Announcement.objects.create(content="test") + announcement.save() + url = reverse("maintenance:announcement_edit", kwargs={"pk": announcement.pk}) + response = self.client.get(url) + self.assertContains(response, '
') + self.client.post(url, {"content": "Test Edit Announcement", "active": True}) + announcement = Announcement.objects.get(pk=announcement.pk) + self.assertEqual(announcement.content, "Test Edit Announcement") + + def test_delete(self): + """ + Test delete announcement view + """ + announcement = Announcement.objects.create(content="Test Delete") + announcement.save() + url = reverse("maintenance:announcement_delete", kwargs={"pk": announcement.pk}) + self.client.post(url) + result = Announcement.objects.filter(content="Test Edit Announcement").exists() + self.assertFalse(result) + + def _test_403(self, viewname, kwargs=None): + url = reverse("maintenance:%s" % viewname, kwargs=kwargs) + response = self.client.get(url) + self.assertEqual(response.status_code, 403) + + def test_authorization(self): + self.client.login(username=self.non_staff_user, password=self.TEST_PASSWORD) + announcement = Announcement.objects.create(content="Test Delete") + announcement.save() + + self._test_403("announcement_index") + self._test_403("announcement_create") + self._test_403("announcement_edit", {"pk": announcement.pk}) + self._test_403("announcement_delete", {"pk": announcement.pk}) diff --git a/cms/djangoapps/maintenance/urls.py b/cms/djangoapps/maintenance/urls.py new file mode 100644 index 000000000000..2937727bfa39 --- /dev/null +++ b/cms/djangoapps/maintenance/urls.py @@ -0,0 +1,23 @@ +""" +URLs for the maintenance app. +""" + +from django.urls import path, re_path + +from .views import ( + AnnouncementCreateView, + AnnouncementDeleteView, + AnnouncementEditView, + AnnouncementIndexView, + MaintenanceIndexView +) + +app_name = 'cms.djangoapps.maintenance' + +urlpatterns = [ + path('', MaintenanceIndexView.as_view(), name='maintenance_index'), + re_path(r'^announcements/(?P\d+)?$', AnnouncementIndexView.as_view(), name='announcement_index'), + path('announcements/create', AnnouncementCreateView.as_view(), name='announcement_create'), + re_path(r'^announcements/edit/(?P\d+)?$', AnnouncementEditView.as_view(), name='announcement_edit'), + path('announcements/delete/', AnnouncementDeleteView.as_view(), name='announcement_delete'), +] diff --git a/cms/djangoapps/maintenance/views.py b/cms/djangoapps/maintenance/views.py new file mode 100644 index 000000000000..1ec0f9c5cff2 --- /dev/null +++ b/cms/djangoapps/maintenance/views.py @@ -0,0 +1,190 @@ +""" +Views for the maintenance app. +""" + + +import logging + +from django.core.validators import ValidationError +from django.urls import reverse, reverse_lazy +from django.utils.decorators import method_decorator +from django.utils.translation import gettext as _ +from django.views.generic import View +from django.views.generic.edit import CreateView, DeleteView, UpdateView +from django.views.generic.list import ListView +from opaque_keys.edx.keys import CourseKey + +from common.djangoapps.edxmako.shortcuts import render_to_response +from common.djangoapps.util.json_request import JsonResponse +from common.djangoapps.util.views import require_global_staff +from openedx.features.announcements.forms import AnnouncementForm +from openedx.features.announcements.models import Announcement +from xmodule.modulestore import ModuleStoreEnum # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order + +log = logging.getLogger(__name__) + +# This dict maintains all the views that will be used Maintenance app. +MAINTENANCE_VIEWS = { + 'announcement_index': { + 'url': 'maintenance:announcement_index', + 'name': _('Edit Announcements'), + 'slug': 'announcement_index', + 'description': _( + 'This view shows the announcement editor to create or alter announcements that are shown on the right' + 'side of the dashboard.' + ), + }, +} + + +COURSE_KEY_ERROR_MESSAGES = { + 'empty_course_key': _('Please provide course id.'), + 'invalid_course_key': _('Invalid course key.'), + 'course_key_not_found': _('No matching course found.') +} + + +class MaintenanceIndexView(View): + """ + Index view for maintenance dashboard, used by global staff. + + This view lists some commands/tasks that can be used to dry run or execute directly. + """ + + @method_decorator(require_global_staff) + def get(self, request): + """Render the maintenance index view. """ + return render_to_response('maintenance/index.html', { + 'views': MAINTENANCE_VIEWS, + }) + + +class MaintenanceBaseView(View): + """ + Base class for Maintenance views. + """ + + template = 'maintenance/container.html' + + def __init__(self, view=None): + super().__init__() + self.context = { + 'view': view if view else '', + 'form_data': {}, + 'error': False, + 'msg': '' + } + + def render_response(self): + """ + A short method to render_to_response that renders response. + """ + if self.request.headers.get('x-requested-with') == 'XMLHttpRequest': + return JsonResponse(self.context) + return render_to_response(self.template, self.context) + + @method_decorator(require_global_staff) + def get(self, request): + """ + Render get view. + """ + return self.render_response() + + def validate_course_key(self, course_key, branch=ModuleStoreEnum.BranchName.draft): + """ + Validates the course_key that would be used by maintenance app views. + + Arguments: + course_key (string): a course key + branch: a course locator branch, default value is ModuleStoreEnum.BranchName.draft . + values can be either ModuleStoreEnum.BranchName.draft or ModuleStoreEnum.BranchName.published. + + Returns: + course_usage_key (CourseLocator): course usage locator + """ + if not course_key: + raise ValidationError(COURSE_KEY_ERROR_MESSAGES['empty_course_key']) + + course_usage_key = CourseKey.from_string(course_key) + + if not modulestore().has_course(course_usage_key): + raise ItemNotFoundError(COURSE_KEY_ERROR_MESSAGES['course_key_not_found']) + + # get branch specific locator + course_usage_key = course_usage_key.for_branch(branch) + + return course_usage_key + + +class AnnouncementBaseView(View): + """ + Base view for Announcements pages + """ + + @method_decorator(require_global_staff) + def dispatch(self, request, *args, **kwargs): + return super().dispatch(request, *args, **kwargs) + + +class AnnouncementIndexView(ListView, MaintenanceBaseView): + """ + View for viewing the announcements shown on the dashboard, used by the global staff. + """ + model = Announcement + object_list = Announcement.objects.order_by('-active') + context_object_name = 'announcement_list' + paginate_by = 8 + + def __init__(self): + super().__init__(MAINTENANCE_VIEWS['announcement_index']) + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context['view'] = MAINTENANCE_VIEWS['announcement_index'] + return context + + @method_decorator(require_global_staff) + def get(self, request, *args, **kwargs): + context = self.get_context_data() + return render_to_response(self.template, context) + + +class AnnouncementEditView(UpdateView, AnnouncementBaseView): + """ + View for editing an announcement. + """ + model = Announcement + form_class = AnnouncementForm + success_url = reverse_lazy('maintenance:announcement_index') + template_name = '/maintenance/_announcement_edit.html' + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context['action_url'] = reverse('maintenance:announcement_edit', kwargs={'pk': context['announcement'].pk}) + return context + + +class AnnouncementCreateView(CreateView, AnnouncementBaseView): + """ + View for creating an announcement. + """ + model = Announcement + form_class = AnnouncementForm + success_url = reverse_lazy('maintenance:announcement_index') + template_name = '/maintenance/_announcement_edit.html' + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context['action_url'] = reverse('maintenance:announcement_create') + return context + + +class AnnouncementDeleteView(DeleteView, AnnouncementBaseView): + """ + View for deleting an announcement. + """ + model = Announcement + success_url = reverse_lazy('maintenance:announcement_index') + template_name = '/maintenance/_announcement_delete.html' diff --git a/cms/envs/common.py b/cms/envs/common.py index a39e06565166..2f81a43d984b 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -1699,6 +1699,8 @@ # New (Learning-Core-based) XBlock runtime 'openedx.core.djangoapps.xblock.apps.StudioXBlockAppConfig', + # Maintenance tools + 'cms.djangoapps.maintenance', 'openedx.core.djangoapps.util.apps.UtilConfig', # Tracking diff --git a/cms/static/js/views/xblock_editor.js b/cms/static/js/views/xblock_editor.js index 40ab22d022fc..52d08dc76fb4 100644 --- a/cms/static/js/views/xblock_editor.js +++ b/cms/static/js/views/xblock_editor.js @@ -78,7 +78,7 @@ function($, _, gettext, BaseView, XBlockView, MetadataView, MetadataCollection) el: metadataEditor, collection: new MetadataCollection(models) }); - if (xblock.setMetadataEditor) { + if (xblock && xblock.setMetadataEditor) { xblock.setMetadataEditor(metadataView); } } diff --git a/cms/static/sass/_build-v1.scss b/cms/static/sass/_build-v1.scss index 7aedd0c6b8a3..178f6b167473 100644 --- a/cms/static/sass/_build-v1.scss +++ b/cms/static/sass/_build-v1.scss @@ -77,6 +77,7 @@ @import 'views/group-configuration'; @import 'views/video-upload'; @import 'views/certificates'; +@import 'views/maintenance'; // +Base - Contexts // ==================== diff --git a/cms/static/sass/views/_maintenance.scss b/cms/static/sass/views/_maintenance.scss new file mode 100644 index 000000000000..58d1b7494751 --- /dev/null +++ b/cms/static/sass/views/_maintenance.scss @@ -0,0 +1,104 @@ +.maintenance-header { + text-align: center; + margin-top: 50px; + + h2 { + margin-bottom: 10px; + } +} + +.maintenance-content { + padding: 3rem 0; + + .maintenance-list { + max-width: 1280px; + margin: 0 auto; + + .view-list-container { + padding: 10px 15px; + background-color: #fff; + border-bottom: 1px solid #ddd; + + &:hover { + background-color: #fafafa; + } + + .view-name { + display: inline-block; + width: 20%; + float: left; + } + + .view-desc { + display: inline-block; + width: 80%; + font-size: 15px; + } + } + } + + .maintenance-form { + width: 60%; + margin: auto; + + .result-list { + height: calc(100vh - 200px); + overflow: auto; + } + + .result { + box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.2); + margin-top: 15px; + padding: 15px 30px; + background: #f9f9f9; + } + + li { + font-size: 13px; + line-height: 9px; + } + + .actions { + text-align: right; + } + + .field-radio div { + display: inline-block; + margin-right: 10px; + } + + div.error { + color: #f00; + margin-top: 10px; + font-size: 13px; + } + + div.head-output { + font-size: 13px; + margin-bottom: 10px; + } + + div.main-output { + color: #0a0; + font-size: 15px; + } + } + + .announcement-container { + width: 100%; + text-align: center; + + .announcement-item { + display: inline-block; + max-width: 300px; + min-width: 300px; + margin: 15px; + + .announcement-content { + background-color: $body-bg; + text-align: center; + padding: 22px 33px; + } + } + } +} diff --git a/cms/templates/maintenance/_announcement_delete.html b/cms/templates/maintenance/_announcement_delete.html new file mode 100644 index 000000000000..0397ef5a0bf8 --- /dev/null +++ b/cms/templates/maintenance/_announcement_delete.html @@ -0,0 +1,40 @@ +<%page expression_filter="h"/> +<%inherit file="base.html" /> +<%namespace name='static' file='../static_content.html'/> +<%! +from django.utils.translation import gettext as _ +from openedx.core.djangolib.markup import HTML, Text +%> +<%block name="title">${_('Delete Announcement')} +<%block name="viewtitle"> +

+ ${_('Delete Announcement')} +

+ + +<%block name="viewcontent"> +
+
+
+ +
+
+ +
+
+ ## xss-lint: disable=mako-invalid-html-filter + ${object.content | n} +
+
+
+ +
+
+
+
+ diff --git a/cms/templates/maintenance/_announcement_edit.html b/cms/templates/maintenance/_announcement_edit.html new file mode 100644 index 000000000000..a9bee1c6fce2 --- /dev/null +++ b/cms/templates/maintenance/_announcement_edit.html @@ -0,0 +1,50 @@ +<%page expression_filter="h"/> +<%inherit file="base.html" /> +<%namespace name='static' file='../static_content.html'/> +<%! +from django.utils.translation import gettext as _ +from openedx.core.djangolib.markup import HTML, Text +%> +<%block name="title">${_('Edit Announcement')} +<%block name="viewtitle"> +

+ ${_('Edit Announcement')} +

+ + +<%block name="viewcontent"> +
+
+
+
+ +
+ ## xss-lint: disable=mako-invalid-html-filter + ${form.as_p() | n} +
+
+ +
+
+
+
+
+ + +<%block name="header_extras"> + + + diff --git a/cms/templates/maintenance/_announcement_index.html b/cms/templates/maintenance/_announcement_index.html new file mode 100644 index 000000000000..68713c9986cc --- /dev/null +++ b/cms/templates/maintenance/_announcement_index.html @@ -0,0 +1,59 @@ +<%page expression_filter="h"/> +<%namespace name='static' file='../static_content.html'/> +<%! +from django.urls import reverse +from django.utils.translation import gettext as _ + +from openedx.core.djangolib.markup import HTML, Text + +%> +
+
+
+ % for announcement in announcement_list: +
+
+ ## xss-lint: disable=mako-invalid-html-filter + ${announcement.content | n} +
+ +
+ + % if announcement.active: + Active
+
+ % endfor +
+
+ + + + % if is_paginated: + % if page_obj.has_previous(): + + + + % endif + + % if page_obj.has_next(): + + + + % endif + % endif +
+
+
diff --git a/cms/templates/maintenance/base.html b/cms/templates/maintenance/base.html new file mode 100644 index 000000000000..6979797a629c --- /dev/null +++ b/cms/templates/maintenance/base.html @@ -0,0 +1,21 @@ +<%page expression_filter="h"/> +<%inherit file="../base.html" /> +<%def name='online_help_token()'><% return 'maintenance' %> +<%namespace name='static' file='../static_content.html'/> +<%! +from django.urls import reverse +from django.utils.translation import gettext as _ +%> +<%block name="content"> +
+
+

+ + ${_('Maintenance Dashboard')} + +

+ <%block name="viewtitle"> + +
+<%block name="viewcontent"> + diff --git a/cms/templates/maintenance/container.html b/cms/templates/maintenance/container.html new file mode 100644 index 000000000000..319a57bfe995 --- /dev/null +++ b/cms/templates/maintenance/container.html @@ -0,0 +1,25 @@ +<%page expression_filter="h"/> +<%inherit file="base.html" /> +<%namespace name='static' file='../static_content.html'/> +<%! +from django.urls import reverse +from openedx.core.djangolib.js_utils import js_escaped_string +%> +<%block name="title">${view['name']} +<%block name="viewtitle"> +

+ ${view['name']} +

+ + +<%block name="viewcontent"> +
+ <%include file="_${view['slug']}.html"/> +
+ + +<%block name="requirejs"> + require(["js/maintenance/${view['slug'] | n, js_escaped_string}"], function(MaintenanceFactory) { + MaintenanceFactory("${reverse(view['url']) | n, js_escaped_string}"); + }); + diff --git a/cms/templates/maintenance/index.html b/cms/templates/maintenance/index.html new file mode 100644 index 000000000000..293cb90b4a9c --- /dev/null +++ b/cms/templates/maintenance/index.html @@ -0,0 +1,20 @@ +<%page expression_filter="h"/> +<%inherit file="base.html" /> +<%namespace name='static' file='../static_content.html'/> +<%! +from django.utils.translation import gettext as _ +from django.urls import reverse +%> +<%block name="title">${_('Maintenance Dashboard')} +<%block name="viewcontent"> +
+
    + % for view in views.values(): +
  • + ${view['name']} + ${view['description']} +
    • + % endfor +
+
+ diff --git a/cms/templates/widgets/header.html b/cms/templates/widgets/header.html index 941fe8d5e6a6..af50a3c321a9 100644 --- a/cms/templates/widgets/header.html +++ b/cms/templates/widgets/header.html @@ -8,7 +8,7 @@ from urllib.parse import quote_plus from common.djangoapps.student.auth import has_studio_advanced_settings_access from cms.djangoapps.contentstore import toggles - from cms.djangoapps.contentstore.utils import get_pages_and_resources_url, get_course_outline_url, get_updates_url, get_files_uploads_url, get_video_uploads_url, get_schedule_details_url, get_grading_url, get_advanced_settings_url, get_import_url, get_export_url, get_studio_home_url, get_course_team_url, get_optimizer_url + from cms.djangoapps.contentstore.utils import get_pages_and_resources_url, get_course_outline_url, get_course_libraries_url, get_updates_url, get_files_uploads_url, get_video_uploads_url, get_schedule_details_url, get_grading_url, get_advanced_settings_url, get_import_url, get_export_url, get_studio_home_url, get_course_team_url, get_optimizer_url from openedx.core.djangoapps.discussions.config.waffle import ENABLE_PAGES_AND_RESOURCES_MICROFRONTEND from openedx.core.djangoapps.lang_pref.api import header_language_selector_is_enabled, released_languages %> @@ -67,6 +67,7 @@

import_mfe_enabled = toggles.use_new_import_page(context_course.id) export_mfe_enabled = toggles.use_new_export_page(context_course.id) optimizer_enabled = toggles.enable_course_optimizer(context_course.id) + libraries_v2_enabled = toggles.libraries_v2_enabled() %>

@@ -104,6 +105,11 @@

${_("Course" ${_("Outline")} % endif + % if libraries_v2_enabled: +
  • + ${_("Libraries")} +
    • + % endif % if not updates_mfe_enabled:
  • ${_("Updates")} diff --git a/cms/templates/widgets/user_dropdown.html b/cms/templates/widgets/user_dropdown.html index 3fc0934b0db7..0ec00257ffe1 100644 --- a/cms/templates/widgets/user_dropdown.html +++ b/cms/templates/widgets/user_dropdown.html @@ -21,6 +21,11 @@

    + % if GlobalStaff().has_user(user): +
  • + ${_("Maintenance")} +
    • + % endif diff --git a/cms/urls.py b/cms/urls.py index 58503f9ed92f..50781b4bb3b5 100644 --- a/cms/urls.py +++ b/cms/urls.py @@ -276,6 +276,8 @@ certificates_list_handler, name='certificates_list_handler') ] +# Maintenance Dashboard +urlpatterns.append(path('maintenance/', include('cms.djangoapps.maintenance.urls', namespace='maintenance'))) if settings.DEBUG: try: diff --git a/common/templates/xblock_v2/xblock_iframe.html b/common/templates/xblock_v2/xblock_iframe.html index 57ff4684ddbd..add3c46bce55 100644 --- a/common/templates/xblock_v2/xblock_iframe.html +++ b/common/templates/xblock_v2/xblock_iframe.html @@ -35,23 +35,43 @@ @@ -269,6 +289,82 @@ // const passElement = isStudioView && (window as any).$ ? (window as any).$(element) : element; const blockJS = new InitFunction(runtime, element, data) || {}; blockJS.element = element; + + if (['MetadataOnlyEditingDescriptor', 'SequenceDescriptor'].includes(data['xmodule-type'])) { + // The xmodule type `MetadataOnlyEditingDescriptor` and `SequenceDescriptor` renders a `
    ` with + // the block metadata in the `data-metadata` attribute. But is necessary + // to call `XBlockEditorView.xblockReady()` to run the scripts to build the + // editor using the metadata. + require(['{{ cms_root_url }}/static/studio/js/views/xblock_editor.js'], function(XBlockEditorView) { + var editorView = new XBlockEditorView({ + el: element, + xblock: blockJS, + }); + // To render block using metadata + editorView.xblockReady(blockJS); + + // Adding cancel and save buttons + var xblockActions = ` +
    + +
    + `; + element.innerHTML += xblockActions; + + const views = editorView.getMetadataEditor().views; + Object.values(views).forEach(view => { + const uniqueId = view.uniqueId; + const input = element.querySelector(`#${uniqueId}`); + if (input) { + input.addEventListener("input", function(event) { + view.model.setValue(event.target.value); + }); + } + }); + + // Adding cancel functionality + $('.cancel-button', element).bind('click', function() { + runtime.notify('cancel', {}); + event.preventDefault(); + }); + + // Adding save functionality + $('.save-button', element).bind('click', function() { + //event.preventDefault(); + var error_message_div = $('.xblock-editor-error-message', element); + const modifiedData = editorView.getChangedMetadata(); + + error_message_div.html(); + error_message_div.css('display', 'none'); + + var handlerUrl = runtime.handlerUrl(element, 'studio_submit'); + + runtime.notify('save', {state: 'start', message: gettext("Saving")}); + + $.post(handlerUrl, JSON.stringify(modifiedData)).done(function(response) { + if (response.result === 'success') { + runtime.notify('save', {state: 'end'}) + window.location.reload(false); + } else { + runtime.notify('error', { + 'title': 'Error saving changes', + 'message': response.message, + }); + error_message_div.html('Error: '+response.message); + error_message_div.css('display', 'block'); + } + }); + }); + }); + } + callback(blockJS); } else { const blockJS = { element }; diff --git a/docs/conf.py b/docs/conf.py index ec416f1c19e6..dfee5aec0a41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -112,7 +112,6 @@ # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' # The master toctree document. master_doc = 'index' diff --git a/docs/docs_settings.py b/docs/docs_settings.py index d5164edfa1e1..3b4cafed857a 100644 --- a/docs/docs_settings.py +++ b/docs/docs_settings.py @@ -38,6 +38,13 @@ "cms.djangoapps.xblock_config.apps.XBlockConfig", "lms.djangoapps.lti_provider", "openedx.core.djangoapps.content.search", + "openedx.core.djangoapps.content_libraries", + "openedx.core.djangoapps.content_staging", + "openedx.core.djangoapps.bookmarks", + "openedx.core.djangoapps.discussions", + "openedx.core.djangoapps.theming", + "lms.djangoapps.program_enrollments", + "push_notifications", ] ) diff --git a/docs/lms-openapi.yaml b/docs/lms-openapi.yaml index ad3a4fc40db4..664c8fed03df 100644 --- a/docs/lms-openapi.yaml +++ b/docs/lms-openapi.yaml @@ -122,105 +122,6 @@ paths: in: path required: true type: string - /bookmarks/v1/bookmarks/: - get: - operationId: bookmarks_v1_bookmarks_list - summary: Get a paginated list of bookmarks for a user. - description: |- - The list can be filtered by passing parameter "course_id=" - to only include bookmarks from a particular course. - - The bookmarks are always sorted in descending order by creation date. - - Each page in the list contains 10 bookmarks by default. The page - size can be altered by passing parameter "page_size=". - - To include the optional fields pass the values in "fields" parameter - as a comma separated list. Possible values are: - - * "display_name" - * "path" - - **Example Requests** - - GET /api/bookmarks/v1/bookmarks/?course_id={course_id1}&fields=display_name,path - parameters: - - name: page - in: query - description: A page number within the paginated result set. - required: false - type: integer - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - - name: course_id - in: query - description: The id of the course to limit the list - type: string - - name: fields - in: query - description: 'The fields to return: display_name, path.' - type: string - responses: - '200': - description: '' - tags: - - bookmarks - post: - operationId: bookmarks_v1_bookmarks_create - summary: Create a new bookmark for a user. - description: |- - The POST request only needs to contain one parameter "usage_id". - - Http400 is returned if the format of the request is not correct, - the usage_id is invalid or a block corresponding to the usage_id - could not be found. - - **Example Requests** - - POST /api/bookmarks/v1/bookmarks/ - Request data: {"usage_id": } - parameters: [] - responses: - '201': - description: '' - tags: - - bookmarks - parameters: [] - /bookmarks/v1/bookmarks/{username},{usage_id}/: - get: - operationId: bookmarks_v1_bookmarks_read - summary: Get a specific bookmark for a user. - description: |- - **Example Requests** - - GET /api/bookmarks/v1/bookmarks/{username},{usage_id}?fields=display_name,path - parameters: [] - responses: - '200': - description: '' - tags: - - bookmarks - delete: - operationId: bookmarks_v1_bookmarks_delete - description: DELETE /api/bookmarks/v1/bookmarks/{username},{usage_id} - parameters: [] - responses: - '204': - description: '' - tags: - - bookmarks - parameters: - - name: username - in: path - required: true - type: string - - name: usage_id - in: path - required: true - type: string /bulk_enroll/v1/bulk_enroll: post: operationId: bulk_enroll_v1_bulk_enroll_create @@ -1848,114 +1749,6 @@ paths: in: path required: true type: string - /course_live/course/{course_id}/: - get: - operationId: course_live_course_read - summary: Handle HTTP/GET requests - description: Handle HTTP/GET requests - parameters: - - name: course_id - in: path - description: The course for which to get provider list - type: string - required: true - responses: - '200': - description: '' - schema: - $ref: '#/definitions/CourseLiveConfiguration' - '401': - description: The requester is not authenticated. - '403': - description: The requester cannot access the specified course. - '404': - description: The requested course does not exist. - tags: - - course_live - post: - operationId: course_live_course_create - summary: Handle HTTP/POST requests - description: Handle HTTP/POST requests - parameters: - - name: course_id - in: path - description: The course for which to get provider list - type: string - required: true - - name: lti_1p1_client_key - in: path - description: The LTI provider's client key - type: string - required: true - - name: lti_1p1_client_secret - in: path - description: The LTI provider's client secretL - type: string - required: true - - name: lti_1p1_launch_url - in: path - description: The LTI provider's launch URL - type: string - required: true - - name: provider_type - in: path - description: The LTI provider's launch URL - type: string - required: true - - name: lti_config - in: query - description: 'The lti_config object with required additional parameters ' - type: object - responses: - '200': - description: '' - schema: - $ref: '#/definitions/CourseLiveConfiguration' - '400': - description: Required parameters are missing. - '401': - description: The requester is not authenticated. - '403': - description: The requester cannot access the specified course. - '404': - description: The requested course does not exist. - tags: - - course_live - parameters: - - name: course_id - in: path - required: true - type: string - /course_live/iframe/{course_id}/: - get: - operationId: course_live_iframe_read - description: Handle HTTP/GET requests - parameters: [] - responses: - '200': - description: '' - tags: - - course_live - parameters: - - name: course_id - in: path - required: true - type: string - /course_live/providers/{course_id}/: - get: - operationId: course_live_providers_read - description: A view for retrieving Program live IFrame . - parameters: [] - responses: - '200': - description: '' - tags: - - course_live - parameters: - - name: course_id - in: path - required: true - type: string /course_modes/v1/courses/{course_id}/: get: operationId: course_modes_v1_courses_read @@ -3143,168 +2936,6 @@ paths: in: path required: true type: string - /courseware/celebration/{course_key_string}: - post: - operationId: courseware_celebration_create - description: Handle a POST request. - parameters: [] - responses: - '201': - description: '' - tags: - - courseware - parameters: - - name: course_key_string - in: path - required: true - type: string - /courseware/course/{course_key_string}: - get: - operationId: courseware_course_read - summary: '**Use Cases**' - description: |- - Request details for a course - - **Example Requests** - - GET /api/courseware/course/{course_key} - - **Response Values** - - Body consists of the following fields: - - * access_expiration: An object detailing when access to this course will expire - * expiration_date: (str) When the access expires, in ISO 8601 notation - * masquerading_expired_course: (bool) Whether this course is expired for the masqueraded user - * upgrade_deadline: (str) Last chance to upgrade, in ISO 8601 notation (or None if can't upgrade anymore) - * upgrade_url: (str) Upgrade linke (or None if can't upgrade anymore) - * celebrations: An object detailing which celebrations to render - * first_section: (bool) If the first section celebration should render - Note: Also uses information from frontend so this value is not final - * streak_length_to_celebrate: (int) The streak length to celebrate for the learner - * streak_discount_enabled: (bool) If the frontend should render an upgrade discount for hitting the streak - * weekly_goal: (bool) If the weekly goal celebration should render - * course_goals: - * selected_goal: - * days_per_week: (int) The number of days the learner wants to learn per week - * subscribed_to_reminders: (bool) Whether the learner wants email reminders about their goal - * weekly_learning_goal_enabled: Flag indicating if this feature is enabled for this call - * effort: A textual description of the weekly hours of effort expected - in the course. - * end: Date the course ends, in ISO 8601 notation - * enrollment: Enrollment status of authenticated user - * mode: `audit`, `verified`, etc - * is_active: boolean - * enrollment_end: Date enrollment ends, in ISO 8601 notation - * enrollment_start: Date enrollment begins, in ISO 8601 notation - * entrance_exam_data: An object containing information about the course's entrance exam - * entrance_exam_current_score: (float) The users current score on the entrance exam - * entrance_exam_enabled: (bool) If the course has an entrance exam - * entrance_exam_id: (str) The block id for the entrance exam if enabled. Will be a section (chapter) - * entrance_exam_minimum_score_pct: (float) The minimum score a user must receive on the entrance exam - to unlock the remainder of the course. Returned as a float (i.e. 0.7 for 70%) - * entrance_exam_passed: (bool) Indicates if the entrance exam has been passed - * id: A unique identifier of the course; a serialized representation - of the opaque key identifying the course. - * language: The language code for the course - * media: An object that contains named media items. Included here: - * course_image: An image to show for the course. Represented - as an object with the following fields: - * uri: The location of the image - * name: Name of the course - * offer: An object detailing upgrade discount information - * code: (str) Checkout code - * expiration_date: (str) Expiration of offer, in ISO 8601 notation - * original_price: (str) Full upgrade price without checkout code; includes currency symbol - * discounted_price: (str) Upgrade price with checkout code; includes currency symbol - * percentage: (int) Amount of discount - * upgrade_url: (str) Checkout URL - * org: Name of the organization that owns the course - * related_programs: A list of objects that contains program data related to the given course including: - * progress: An object containing program progress: - * complete: (int) Number of complete courses in the program (a course is completed if the user has - earned a certificate for any of the nested course runs) - * in_progress: (int) Number of courses in the program that are in progress (a course is in progress if - the user has enrolled in any of the nested course runs) - * not_started: (int) Number of courses in the program that have not been started - * slug: (str) The program type - * title: (str) The title of the program - * url: (str) The link to the program's landing page - * uuid: (str) A unique identifier of the program - * short_description: A textual description of the course - * start: Date the course begins, in ISO 8601 notation - * start_display: Readably formatted start of the course - * start_type: Hint describing how `start_display` is set. One of: - * `"string"`: manually set by the course author - * `"timestamp"`: generated from the `start` timestamp - * `"empty"`: no start date is specified - * pacing: Course pacing. Possible values: instructor, self - * user_timezone: User's chosen timezone setting (or null for browser default) - * user_has_passing_grade: Whether or not the effective user's grade is equal to or above the courses minimum - passing grade - * course_exit_page_is_active: Flag for the learning mfe on whether or not the course exit page should display - * certificate_data: data regarding the effective user's certificate for the given course - * verify_identity_url: URL for a learner to verify their identity. Only returned for learners enrolled in a - verified mode. Will update to reverify URL if necessary. - * linkedin_add_to_profile_url: URL to add the effective user's certificate to a LinkedIn Profile. - * user_needs_integrity_signature: Whether the user needs to sign the integrity agreement for the course - * learning_assistant_enabled: Whether the Xpert Learning Assistant is enabled for the requesting user - - **Parameters:** - - requested_fields (optional) comma separated list: - If set, then only those fields will be returned. - username (optional) username to masquerade as (if requesting user is staff) - - **Returns** - - * 200 on success with above fields. - * 400 if an invalid parameter was sent or the username was not provided - for an authenticated request. - * 403 if a user who does not have permission to masquerade as - another user specifies a username other than their own. - * 404 if the course is not available or cannot be seen. - parameters: [] - responses: - '200': - description: '' - tags: - - courseware - parameters: - - name: course_key_string - in: path - required: true - type: string - /courseware/resume/{course_key_string}: - get: - operationId: courseware_resume_read - description: Return response to a GET request. - parameters: [] - responses: - '200': - description: '' - tags: - - courseware - parameters: - - name: course_key_string - in: path - required: true - type: string - /courseware/sequence/{usage_key_string}: - get: - operationId: courseware_sequence_read - description: Return response to a GET request. - parameters: [] - responses: - '200': - description: '' - tags: - - courseware - parameters: - - name: usage_key_string - in: path - required: true - type: string /credit/v1/courses/: get: operationId: credit_v1_courses_list @@ -5614,520 +5245,17 @@ paths: description: A unique integer value identifying this Experiment Key-Value Pair. required: true type: integer - /grades/v1/courses/: + /instructor_task/v1/schedules/{course_id}/bulk_email/: get: - operationId: grades_v1_courses_list - description: Gets a course progress status. + operationId: instructor_task_v1_schedules_bulk_email_list + description: Read only view to list all scheduled bulk email messages for a + course-run. parameters: - - name: cursor + - name: page in: query - description: The pagination cursor value. + description: A page number within the paginated result set. required: false - type: string - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - grades - parameters: [] - /grades/v1/courses/{course_id}/: - get: - operationId: grades_v1_courses_read - description: Gets a course progress status. - parameters: [] - responses: - '200': - description: '' - tags: - - grades - parameters: - - name: course_id - in: path - required: true - type: string - /grades/v1/gradebook/{course_id}/: - get: - operationId: grades_v1_gradebook_read - description: |- - Checks for course author access for the given course by the requesting user. - Calls the view function if has access, otherwise raises a 403. - parameters: [] - responses: - '200': - description: '' - tags: - - grades - parameters: - - name: course_id - in: path - required: true - type: string - /grades/v1/gradebook/{course_id}/bulk-update: - post: - operationId: grades_v1_gradebook_bulk-update_create - description: |- - Checks for course author access for the given course by the requesting user. - Calls the view function if has access, otherwise raises a 403. - parameters: [] - responses: - '201': - description: '' - tags: - - grades - parameters: - - name: course_id - in: path - required: true - type: string - /grades/v1/gradebook/{course_id}/grading-info: - get: - operationId: grades_v1_gradebook_grading-info_list - description: |- - Checks for course author access for the given course by the requesting user. - Calls the view function if has access, otherwise raises a 403. - parameters: - - name: page - in: query - description: A page number within the paginated result set. - required: false - type: integer - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - grades - parameters: - - name: course_id - in: path - required: true - type: string - /grades/v1/policy/courses/{course_id}/: - get: - operationId: grades_v1_policy_courses_read - summary: '**Use Case**' - description: |- - Get the course grading policy. - - **Example requests**: - - GET /api/grades/v1/policy/courses/{course_id}/ - - **Response Values** - - * assignment_type: The type of the assignment, as configured by course - staff. For example, course staff might make the assignment types Homework, - Quiz, and Exam. - - * count: The number of assignments of the type. - - * dropped: Number of assignments of the type that are dropped. - - * weight: The weight, or effect, of the assignment type on the learner's - final grade. - parameters: - - name: page - in: query - description: A page number within the paginated result set. - required: false - type: integer - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - grades - parameters: - - name: course_id - in: path - required: true - type: string - /grades/v1/section_grades_breakdown/: - get: - operationId: grades_v1_section_grades_breakdown_list - summary: '**Use Cases**' - description: |- - Get a list of all grades for all sections, optionally filtered by a course ID or list of usernames. - - **Example Requests** - - GET /api/grades/v1/section_grades_breakdown - - GET /api/grades/v1/section_grades_breakdown?course_id={course_id} - - GET /api/grades/v1/section_grades_breakdown?username={username},{username},{username} - - GET /api/grades/v1/section_grades_breakdown?course_id={course_id}&username={username} - - **Query Parameters for GET** - - * course_id: Filters the result to course grade status for the course corresponding to the - given course ID. The value must be URL encoded. Optional. - - * username: List of comma-separated usernames. Filters the result to the course grade status - of the given users. Optional. - - * page_size: Number of results to return per page. Optional. - - **Response Values** - - If the request for information about the course grade status is successful, an HTTP 200 "OK" response - is returned. - - The HTTP 200 response has the following values. - - * results: A list of the course grading status matching the request. - - * course_id: Course ID of the course in the course grading status. - - * user: Username of the user in the course enrollment. - - * passed: Boolean flag for user passing the course. - - * current_grade: An integer representing the current grade of the course. - - * section_breakdown: A summary of each course section's grade. - - A dictionary in the section_breakdown list has the following keys: - * percent: A float percentage for the section. - * label: A short string identifying the section. Preferably fixed-length. E.g. "HW 3". - * detail: A string explanation of the score. E.g. "Homework 1 - Ohms Law - 83% (5/6)" - * category: A string identifying the category. - * prominent: A boolean value indicating that this section should be displayed as more prominent - than other items. - - * next: The URL to the next page of results, or null if this is the - last page. - - * previous: The URL to the next page of results, or null if this - is the first page. - - If the user is not logged in, a 401 error is returned. - - If the user is not global staff, a 403 error is returned. - - If the specified course_id is not valid or any of the specified usernames - are not valid, a 400 error is returned. - - If the specified course_id does not correspond to a valid course or if all the specified - usernames do not correspond to valid users, an HTTP 200 "OK" response is returned with an - empty 'results' field. - parameters: - - name: cursor - in: query - description: The pagination cursor value. - required: false - type: string - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - grades - parameters: [] - /grades/v1/submission_history/{course_id}/: - get: - operationId: grades_v1_submission_history_read - description: |- - Get submission history details. This submission history is related to only - ProblemBlock and it doesn't support LegacyLibraryContentBlock or ContentLibraries - as of now. - - **Usecases**: - - Users with GlobalStaff status can retrieve everyone's submission history. - - **Example Requests**: - - GET /api/grades/v1/submission_history/{course_id} - GET /api/grades/v1/submission_history/{course_id}/?username={username} - - **Query Parameters for GET** - - * course_id: Course id to retrieve submission history. - * username: Single username for which this view will retrieve the submission history details. - - **Response Values**: - - If there's an error while getting the submission history an empty response will - be returned. - The submission history response has the following attributes: - - * Results: A list of submission history: - * course_id: Course id - * course_name: Course name - * user: Username - * problems: List of problems - * location: problem location - * name: problem's display name - * submission_history: List of submission history - * state: State of submission. - * grade: Grade. - * max_grade: Maximum possible grade. - * data: problem's data. - parameters: [] - responses: - '200': - description: '' - tags: - - grades - parameters: - - name: course_id - in: path - required: true - type: string - /grades/v1/subsection/{subsection_id}/: - get: - operationId: grades_v1_subsection_read - description: |- - Returns subection grade data, override grade data and a history of changes made to - a specific users specific subsection grade. - parameters: [] - responses: - '200': - description: '' - tags: - - grades - parameters: - - name: subsection_id - in: path - required: true - type: string - /instructor/v1/reports/{course_id}: - get: - operationId: instructor_v1_reports_read - summary: List report CSV files that are available for download for this course. - description: |- - **Use Cases** - - Lists reports available for download - - **Example Requests**: - - GET /api/instructor/v1/reports/{course_id} - - **Response Values** - ```json - { - "downloads": [ - { - "url": "https://1.mock.url", - "link": "mock_file_name_1", - "name": "mock_file_name_1" - } - ] - } - ``` - - The report name will depend on the type of report generated. For example a - problem responses report for an entire course might be called: - - edX_DemoX_Demo_Course_student_state_from_block-v1_edX+DemoX+Demo_Course+type@course+block@course_2021-04-30-0918.csv - parameters: - - name: course_id - in: path - description: ID for the course whose reports need to be listed. - type: string - required: true - - name: report_name - in: query - description: Filter results to only return details of for the report with - the specified name. - type: string - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ReportDownloadsList' - '401': - description: The requesting user is not authenticated. - '403': - description: The requesting user lacks access to the course. - '404': - description: The requested course does not exist. - tags: - - instructor - parameters: - - name: course_id - in: path - required: true - type: string - /instructor/v1/reports/{course_id}/generate/problem_responses: - post: - operationId: instructor_v1_reports_generate_problem_responses_create - summary: Initiate generation of a CSV file containing all student answers - description: |- - to a given problem. - - **Example requests** - - POST /api/instructor/v1/reports/{course_id}/generate/problem_responses { - "problem_locations": [ - "{usage_key1}", - "{usage_key2}", - "{usage_key3}" - ] - } - POST /api/instructor/v1/reports/{course_id}/generate/problem_responses { - "problem_locations": ["{usage_key}"], - "problem_types_filter": ["problem"] - } - - **POST Parameters** - - A POST request can include the following parameters: - - * problem_location: A list of usage keys for the blocks to include in - the report. If the location is a block that contains other blocks, - (such as the course, section, subsection, or unit blocks) then all - blocks under that block will be included in the report. - * problem_types_filter: Optional. A comma-separated list of block types - to include in the report. If set, only blocks of the specified types - will be included in the report. - - To get data on all the poll and survey blocks in a course, you could - POST the usage key of the course for `problem_location`, and - "poll, survey" as the value for `problem_types_filter`. - - - **Example Response:** - If initiation is successful (or generation task is already running): - ```json - { - "status": "The problem responses report is being created. ...", - "task_id": "4e49522f-31d9-431a-9cff-dd2a2bf4c85a" - } - ``` - - Responds with BadRequest if any of the provided problem locations are faulty. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/ProblemResponseReportPostParams' - - name: course_id - in: path - description: ID of the course for which report is to be generate. - type: string - required: true - responses: - '200': - description: '' - schema: - $ref: '#/definitions/ProblemResponsesReportStatus' - '400': - description: The provided parameters were invalid. Make sure you've provided - at least one valid usage key for `problem_locations`. - '401': - description: The requesting user is not authenticated. - '403': - description: The requesting user lacks access to the course. - tags: - - instructor - parameters: - - name: course_id - in: path - required: true - type: string - /instructor/v1/tasks/{course_id}: - get: - operationId: instructor_v1_tasks_read - summary: List instructor tasks filtered by `course_id`. - description: |- - **Use Cases** - - Lists currently running instructor tasks - - **Parameters** - - With no arguments, lists running tasks. - - `problem_location_str` lists task history for problem - - `problem_location_str` and `unique_student_identifier` lists task - history for problem AND student (intersection) - - **Example Requests**: - - GET /courses/{course_id}/instructor/api/v0/tasks - - **Response Values** - ```json - { - "tasks": [ - { - "status": "Incomplete", - "task_type": "grade_problems", - "task_id": "2519ff31-22d9-4a62-91e2-55495895b355", - "created": "2019-01-15T18:00:15.902470+00:00", - "task_input": "{}", - "duration_sec": "unknown", - "task_message": "No status information available", - "requester": "staff", - "task_state": "PROGRESS" - } - ] - } - ``` - parameters: - - name: course_id - in: path - description: ID for the course whose tasks need to be listed. - type: string - required: true - - name: problem_location_str - in: query - description: Filter instructor tasks to this problem location. - type: string - - name: unique_student_identifier - in: query - description: Filter tasks to a singe problem and a single student. Must be - used in combination with `problem_location_str`. - type: string - responses: - '200': - description: '' - schema: - $ref: '#/definitions/InstructorTasksList' - '401': - description: The requesting user is not authenticated. - '403': - description: The requesting user lacks access to the course. - '404': - description: The requested course does not exist. - tags: - - instructor - parameters: - - name: course_id - in: path - required: true - type: string - /instructor_task/v1/schedules/{course_id}/bulk_email/: - get: - operationId: instructor_task_v1_schedules_bulk_email_list - description: Read only view to list all scheduled bulk email messages for a - course-run. - parameters: - - name: page - in: query - description: A page number within the paginated result set. - required: false - type: integer + type: integer - name: page_size in: query description: Number of results to return per page. @@ -6549,23 +5677,6 @@ paths: tags: - mfe_config parameters: [] - /mfe_context: - get: - operationId: mfe_context_list - description: |- - Returns - - dynamic registration fields - - dynamic optional fields - - the context for third party auth providers - - user country code - - the currently running pipeline. - parameters: [] - responses: - '200': - description: '' - tags: - - mfe_context - parameters: [] /mobile/{api_version}/course_info/blocks/: get: operationId: mobile_course_info_blocks_list @@ -7134,6 +6245,18 @@ paths: tags: - notifications parameters: [] + /notifications/configurations/: + get: + operationId: notifications_configurations_list + description: API view for getting the aggregate notification preferences for + the current user. + parameters: [] + responses: + '200': + description: '' + tags: + - notifications + parameters: [] /notifications/configurations/{course_key_string}: get: operationId: notifications_configurations_read @@ -7309,6 +6432,17 @@ paths: in: path required: true type: string + /notifications/preferences/update-all/: + post: + operationId: notifications_preferences_update-all_create + description: Update all notification preferences for the current user. + parameters: [] + responses: + '201': + description: '' + tags: + - notifications + parameters: [] /notifications/preferences/update/{username}/{patch}/: get: operationId: notifications_preferences_update_read @@ -7789,410 +6923,97 @@ paths: description: |- Organization view to: - list organization data (GET .../) - - retrieve single organization (GET .../) - - create or update an organization via the PUT endpoint (PUT .../) - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Organization' - tags: - - organizations - put: - operationId: organizations_v0_organizations_update - summary: We perform both Update and Create action via the PUT method. - description: |- - The 'active' field may not be specified via the HTTP API, since it - is always assumed to be True. So: - (1) new organizations created through the API are always Active, and - (2) existing organizations updated through the API always end up Active, - regardless of whether or not they were previously active. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Organization' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Organization' - tags: - - organizations - patch: - operationId: organizations_v0_organizations_partial_update - description: We disable PATCH because all updates and creates should use the - PUT action above. - parameters: - - name: data - in: body - required: true - schema: - $ref: '#/definitions/Organization' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/Organization' - tags: - - organizations - parameters: - - name: short_name - in: path - description: Unique, short string identifier for organization. Please do not - use spaces or special characters. Only allowed special characters are period - (.), hyphen (-) and underscore (_). - required: true - type: string - pattern: '[^/+]+' - /profile_images/v1/{username}/remove: - post: - operationId: profile_images_v1_remove_create - description: POST /api/profile_images/v1/{username}/remove - parameters: [] - responses: - '201': - description: '' - tags: - - profile_images - parameters: - - name: username - in: path - required: true - type: string - /profile_images/v1/{username}/upload: - post: - operationId: profile_images_v1_upload_create - description: POST /api/profile_images/v1/{username}/upload - parameters: [] - responses: - '201': - description: '' - consumes: - - multipart/form-data - - application/x-www-form-urlencoded - tags: - - profile_images - parameters: - - name: username - in: path - required: true - type: string - /program_enrollments/v1/integration-reset: - post: - operationId: program_enrollments_v1_integration-reset_create - description: Reset enrollment and user data for organization - parameters: [] - responses: - '201': - description: '' - tags: - - program_enrollments - parameters: [] - /program_enrollments/v1/programs/enrollments/: - get: - operationId: program_enrollments_v1_programs_enrollments_list - description: How to respond to a GET request to this endpoint - parameters: [] - responses: - '200': - description: '' - tags: - - program_enrollments - parameters: [] - /program_enrollments/v1/programs/readonly_access/: - get: - operationId: program_enrollments_v1_programs_readonly_access_list - description: How to respond to a GET request to this endpoint - parameters: [] - responses: - '200': - description: '' - tags: - - program_enrollments - parameters: [] - /program_enrollments/v1/programs/{program_uuid}/courses/{course_id}/enrollments/: - get: - operationId: program_enrollments_v1_programs_courses_enrollments_list - description: Get a list of students enrolled in a course within a program. - parameters: - - name: cursor - in: query - description: The pagination cursor value. - required: false - type: string - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - program_enrollments - post: - operationId: program_enrollments_v1_programs_courses_enrollments_create - description: Enroll a list of students in a course in a program - parameters: [] - responses: - '201': - description: '' - tags: - - program_enrollments - put: - operationId: program_enrollments_v1_programs_courses_enrollments_update - description: Create or Update the program course enrollments of a list of learners - parameters: [] - responses: - '200': - description: '' - tags: - - program_enrollments - patch: - operationId: program_enrollments_v1_programs_courses_enrollments_partial_update - description: Modify the program course enrollments of a list of learners - parameters: [] - responses: - '200': - description: '' - tags: - - program_enrollments - parameters: - - name: program_uuid - in: path - required: true - type: string - - name: course_id - in: path - required: true - type: string - /program_enrollments/v1/programs/{program_uuid}/courses/{course_id}/grades/: - get: - operationId: program_enrollments_v1_programs_courses_grades_list - description: Defines the GET list endpoint for ProgramCourseGrade objects. - parameters: - - name: cursor - in: query - description: The pagination cursor value. - required: false - type: string - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - program_enrollments - parameters: - - name: program_uuid - in: path - required: true - type: string - - name: course_id - in: path - required: true - type: string - /program_enrollments/v1/programs/{program_uuid}/enrollments/: - get: - operationId: program_enrollments_v1_programs_enrollments_list - description: Defines the GET list endpoint for ProgramEnrollment objects. - parameters: - - name: cursor - in: query - description: The pagination cursor value. - required: false - type: string - - name: page_size - in: query - description: Number of results to return per page. - required: false - type: integer - responses: - '200': - description: '' - tags: - - program_enrollments - post: - operationId: program_enrollments_v1_programs_enrollments_create - description: Create program enrollments for a list of learners + - retrieve single organization (GET .../) + - create or update an organization via the PUT endpoint (PUT .../) parameters: [] responses: - '201': + '200': description: '' + schema: + $ref: '#/definitions/Organization' tags: - - program_enrollments + - organizations put: - operationId: program_enrollments_v1_programs_enrollments_update - description: Create/update program enrollments for a list of learners - parameters: [] + operationId: organizations_v0_organizations_update + summary: We perform both Update and Create action via the PUT method. + description: |- + The 'active' field may not be specified via the HTTP API, since it + is always assumed to be True. So: + (1) new organizations created through the API are always Active, and + (2) existing organizations updated through the API always end up Active, + regardless of whether or not they were previously active. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Organization' responses: '200': description: '' + schema: + $ref: '#/definitions/Organization' tags: - - program_enrollments + - organizations patch: - operationId: program_enrollments_v1_programs_enrollments_partial_update - description: Update program enrollments for a list of learners - parameters: [] + operationId: organizations_v0_organizations_partial_update + description: We disable PATCH because all updates and creates should use the + PUT action above. + parameters: + - name: data + in: body + required: true + schema: + $ref: '#/definitions/Organization' responses: '200': description: '' + schema: + $ref: '#/definitions/Organization' tags: - - program_enrollments + - organizations parameters: - - name: program_uuid + - name: short_name in: path + description: Unique, short string identifier for organization. Please do not + use spaces or special characters. Only allowed special characters are period + (.), hyphen (-) and underscore (_). required: true type: string - /program_enrollments/v1/programs/{program_uuid}/overview/: - get: - operationId: program_enrollments_v1_programs_overview_read - description: |- - A view for getting data associated with a user's course enrollments - as part of a program enrollment. + pattern: '[^/+]+' + /profile_images/v1/{username}/remove: + post: + operationId: profile_images_v1_remove_create + description: POST /api/profile_images/v1/{username}/remove parameters: [] responses: - '200': + '201': description: '' - schema: - $ref: '#/definitions/CourseRunOverviewList' tags: - - program_enrollments + - profile_images parameters: - - name: program_uuid + - name: username in: path required: true type: string - /program_enrollments/v1/users/{username}/programs/{program_uuid}/courses: - get: - operationId: program_enrollments_v1_users_programs_courses_list - summary: Get an overview of each of a user's course enrollments associated with - a program. - description: |- - This endpoint exists to get an overview of each course-run enrollment - that a user has for course-runs within a given program. - Fields included are the title, upcoming due dates, etc. - This API endpoint is intended for use with the - [Program Learner Portal MFE](https://github.com/openedx/frontend-app-learner-portal-programs). - - It is important to note that the set of enrollments that this endpoint returns - is different than a user's set of *program-course-run enrollments*. - Specifically, this endpoint may include course runs that are *within* - the specified program but were not *enrolled in* via the specified program. - - **Example Response:** - ```json - { - "next": null, - "previous": null, - "results": [ - { - "course_run_id": "edX+AnimalsX+Aardvarks", - "display_name": "Astonishing Aardvarks", - "course_run_url": "https://courses.edx.org/courses/course-v1:edX+AnimalsX+Aardvarks/course/", - "start_date": "2017-02-05T05:00:00Z", - "end_date": "2018-02-05T05:00:00Z", - "course_run_status": "completed" - "emails_enabled": true, - "due_dates": [ - { - "name": "Introduction: What even is an aardvark?", - "url": "https://courses.edx.org/courses/course-v1:edX+AnimalsX+Aardvarks/jump_to/ - block-v1:edX+AnimalsX+Aardvarks+type@chapter+block@1414ffd5143b4b508f739b563ab468b7", - "date": "2017-05-01T05:00:00Z" - }, - { - "name": "Quiz: Aardvark or Anteater?", - "url": "https://courses.edx.org/courses/course-v1:edX+AnimalsX+Aardvarks/jump_to/ - block-v1:edX+AnimalsX+Aardvarks+type@sequential+block@edx_introduction", - "date": "2017-03-05T00:00:00Z" - } - ], - "micromasters_title": "Animals", - "certificate_download_url": "https://courses.edx.org/certificates/123" - }, - { - "course_run_id": "edX+AnimalsX+Baboons", - "display_name": "Breathtaking Baboons", - "course_run_url": "https://courses.edx.org/courses/course-v1:edX+AnimalsX+Baboons/course/", - "start_date": "2018-02-05T05:00:00Z", - "end_date": null, - "course_run_status": "in_progress" - "emails_enabled": false, - "due_dates": [], - "micromasters_title": "Animals", - "certificate_download_url": "https://courses.edx.org/certificates/123", - "resume_course_run_url": "https://courses.edx.org/courses/course-v1:edX+AnimalsX+Baboons/jump_to/ - block-v1:edX+AnimalsX+Baboons+type@sequential+block@edx_introduction" - } - ] - } - ``` - parameters: - - name: cursor - in: query - description: The pagination cursor value. - required: false - type: string - - name: page_size - in: query - description: Number of results to return per page. Defaults to 10. Maximum - is 25. - type: integer - - name: username - in: path - description: The username of the user for which enrollment overviews will - be fetched. For now, this must be the requesting user; otherwise, 403 will - be returned. In the future, global staff users may be able to supply other - usernames. - type: string - required: true - - name: program_uuid - in: path - description: UUID of a program. Enrollments will be returned for course runs - in this program. - type: string - required: true + /profile_images/v1/{username}/upload: + post: + operationId: profile_images_v1_upload_create + description: POST /api/profile_images/v1/{username}/upload + parameters: [] responses: - '200': + '201': description: '' - schema: - $ref: '#/definitions/PageOfCourseRunOverview' - '401': - description: The requester is not authenticated. - '403': - description: The requester cannot access the specified program and/or the - requester may not retrieve this data for the specified user. - '404': - description: The requested program does not exist. + consumes: + - multipart/form-data + - application/x-www-form-urlencoded tags: - - program_enrollments + - profile_images parameters: - name: username in: path required: true type: string - - name: program_uuid - in: path - required: true - type: string - /send_account_activation_email: - post: - operationId: send_account_activation_email_create - description: Returns status code. - parameters: [] - responses: - '201': - description: '' - tags: - - send_account_activation_email - parameters: [] /team/v0/bulk_team_membership/{course_id}: get: operationId: team_v0_bulk_team_membership_read @@ -8574,23 +7395,6 @@ paths: in: path required: true type: string - /third_party_auth_context: - get: - operationId: third_party_auth_context_list - description: |- - Returns - - dynamic registration fields - - dynamic optional fields - - the context for third party auth providers - - user country code - - the currently running pipeline. - parameters: [] - responses: - '200': - description: '' - tags: - - third_party_auth_context - parameters: [] /toggles/v0/state/: get: operationId: toggles_v0_state_list @@ -8602,54 +7406,6 @@ paths: tags: - toggles parameters: [] - /user/v1/account/password_reset/: - get: - operationId: user_v1_account_password_reset_list - description: HTTP end-point for GETting a description of the password reset - form. - parameters: [] - responses: - '200': - description: '' - tags: - - user - parameters: [] - /user/v1/account/password_reset/token/validate/: - post: - operationId: user_v1_account_password_reset_token_validate_create - description: HTTP end-point to validate password reset token. - parameters: [] - responses: - '201': - description: '' - tags: - - user - parameters: [] - /user/v1/account/registration/: - get: - operationId: user_v1_account_registration_list - description: HTTP end-points for creating a new user. - parameters: [] - responses: - '200': - description: '' - tags: - - user - post: - operationId: user_v1_account_registration_create - summary: Create the user's account. - description: |- - You must send all required form fields with the request. - - You can optionally send a "course_id" param to indicate in analytics - events that the user registered while enrolling in a particular course. - parameters: [] - responses: - '201': - description: '' - tags: - - user - parameters: [] /user/v1/accounts: get: operationId: user_v1_accounts_list @@ -9399,165 +8155,45 @@ paths: description: '' schema: required: - - count - - results - type: object - properties: - count: - type: integer - next: - type: string - format: uri - x-nullable: true - previous: - type: string - format: uri - x-nullable: true - results: - type: array - items: - $ref: '#/definitions/user_api.User' - tags: - - user - parameters: [] - /user/v1/users/{id}/: - get: - operationId: user_v1_users_read - description: DRF class for interacting with the User ORM object - parameters: [] - responses: - '200': - description: '' - schema: - $ref: '#/definitions/user_api.User' - tags: - - user - parameters: - - name: id - in: path - description: A unique integer value identifying this user. - required: true - type: integer - /user/v1/validation/registration: - post: - operationId: user_v1_validation_registration_create - summary: POST /api/user/v1/validation/registration/ - description: |- - Expects request of the form - ``` - { - "name": "Dan the Validator", - "username": "mslm", - "email": "mslm@gmail.com", - "confirm_email": "mslm@gmail.com", - "password": "password123", - "country": "PK" - } - ``` - where each key is the appropriate form field name and the value is - user input. One may enter individual inputs if needed. Some inputs - can get extra verification checks if entered along with others, - like when the password may not equal the username. - parameters: [] - responses: - '201': - description: '' - tags: - - user - parameters: [] - /user/v2/account/registration/: - get: - operationId: user_v2_account_registration_list - description: HTTP end-points for creating a new user. - parameters: [] - responses: - '200': - description: '' - tags: - - user - post: - operationId: user_v2_account_registration_create - summary: Create the user's account. - description: |- - You must send all required form fields with the request. - - You can optionally send a "course_id" param to indicate in analytics - events that the user registered while enrolling in a particular course. - parameters: [] - responses: - '201': - description: '' - tags: - - user - parameters: [] - /user/{api_version}/account/login_session/: - get: - operationId: user_account_login_session_list - description: HTTP end-points for logging in users. - parameters: [] - responses: - '200': - description: '' - tags: - - user - post: - operationId: user_account_login_session_create - summary: POST /user/{api_version}/account/login_session/ - description: Returns 200 on success, and a detailed error message otherwise. - parameters: - - name: data - in: body - required: true - schema: - type: object - properties: - email: - type: string - password: - type: string - responses: - '200': - description: '' - schema: - type: object - properties: - success: - type: boolean - value: - type: string - error_code: - type: string - '400': - description: '' - schema: - type: object - properties: - success: - type: boolean - value: - type: string - error_code: - type: string - '403': - description: '' - schema: + - count + - results type: object properties: - success: - type: boolean - value: + count: + type: integer + next: type: string - error_code: + format: uri + x-nullable: true + previous: type: string + format: uri + x-nullable: true + results: + type: array + items: + $ref: '#/definitions/user_api.User' + tags: + - user + parameters: [] + /user/v1/users/{id}/: + get: + operationId: user_v1_users_read + description: DRF class for interacting with the User ORM object + parameters: [] + responses: + '200': + description: '' + schema: + $ref: '#/definitions/user_api.User' tags: - user - security: - - csrf: [] parameters: - - name: api_version + - name: id in: path + description: A unique integer value identifying this user. required: true - type: string + type: integer /user_tours/discussion_tours/{tour_id}/: get: operationId: user_tours_discussion_tours_read @@ -9817,6 +8453,26 @@ paths: tags: - val parameters: [] + /val/v0/videos/video-transcripts/: + post: + operationId: val_v0_videos_video-transcripts_create + description: Creates a video transcript instance with the given information. + parameters: [] + responses: + '201': + description: '' + tags: + - val + delete: + operationId: val_v0_videos_video-transcripts_delete + description: Delete a video transcript instance with the given information. + parameters: [] + responses: + '204': + description: '' + tags: + - val + parameters: [] /val/v0/videos/video-transcripts/create/: post: operationId: val_v0_videos_video-transcripts_create_create @@ -9827,6 +8483,15 @@ paths: description: '' tags: - val + delete: + operationId: val_v0_videos_video-transcripts_create_delete + description: Delete a video transcript instance with the given information. + parameters: [] + responses: + '204': + description: '' + tags: + - val parameters: [] /val/v0/videos/{edx_video_id}: get: @@ -9955,6 +8620,21 @@ paths: in: path required: true type: string + /xblock/v2/xblocks/{usage_key}/olx/: + get: + operationId: xblock_v2_xblocks_olx_list + description: Get the OLX (XML serialization) of the specified XBlock + parameters: [] + responses: + '200': + description: '' + tags: + - xblock + parameters: + - name: usage_key + in: path + required: true + type: string /xblock/v2/xblocks/{usage_key}/view/{view_name}/: get: operationId: xblock_v2_xblocks_view_read @@ -10054,6 +8734,25 @@ paths: in: path required: true type: string + /xblock/v2/xblocks/{usage_key}@{version}/olx/: + get: + operationId: xblock_v2_xblocks_olx_list + description: Get the OLX (XML serialization) of the specified XBlock + parameters: [] + responses: + '200': + description: '' + tags: + - xblock + parameters: + - name: usage_key + in: path + required: true + type: string + - name: version + in: path + required: true + type: string /xblock/v2/xblocks/{usage_key}@{version}/view/{view_name}/: get: operationId: xblock_v2_xblocks_view_read @@ -10841,65 +9540,6 @@ definitions: disable_progress_graph: title: Disable progress graph type: boolean - Lti: - required: - - lti_config - type: object - properties: - lti_1p1_client_key: - title: Lti 1p1 client key - description: Client key provided by the LTI tool provider. - type: string - maxLength: 255 - lti_1p1_client_secret: - title: Lti 1p1 client secret - description: Client secret provided by the LTI tool provider. - type: string - maxLength: 255 - lti_1p1_launch_url: - title: Lti 1p1 launch url - description: The URL of the external tool that initiates the launch. - type: string - maxLength: 255 - version: - title: Version - type: string - enum: - - lti_1p1 - - lti_1p3 - lti_config: - title: Lti config - type: object - CourseLiveConfiguration: - required: - - provider_type - type: object - properties: - course_key: - title: Course key - type: string - readOnly: true - minLength: 1 - provider_type: - title: LTI provider - description: The LTI provider's id - type: string - maxLength: 50 - minLength: 1 - enabled: - title: Enabled - description: If disabled, the LTI in the associated course will be disabled. - type: boolean - lti_configuration: - $ref: '#/definitions/Lti' - pii_sharing_allowed: - title: Pii sharing allowed - type: string - readOnly: true - free_tier: - title: Free tier - description: True, if LTI credential are provided by Org globally - type: boolean course_modes.CourseMode: required: - course_id @@ -11759,151 +10399,6 @@ definitions: type: string format: date-time readOnly: true - ReportDownload: - description: Report Download - required: - - url - - name - - link - type: object - properties: - url: - title: Url - description: URL from which report can be downloaded. - type: string - format: uri - minLength: 1 - name: - title: Name - description: Name of report. - type: string - minLength: 1 - link: - title: Link - description: HTML anchor tag that contains the name and link. - type: string - minLength: 1 - ReportDownloadsList: - required: - - downloads - type: object - properties: - downloads: - description: List of report downloads - type: array - items: - $ref: '#/definitions/ReportDownload' - ProblemResponseReportPostParams: - required: - - problem_locations - type: object - properties: - problem_locations: - description: 'A list of usage keys for the blocks to include in the report. ' - type: array - items: - description: A usage key location for a section or a problem. If the location - is a block that contains other blocks, (such as the course, section, subsection, - or unit blocks) then all blocks under that block will be included in the - report. - type: string - minLength: 1 - problem_types_filter: - description: 'A list of problem/block types to generate the report for. This - field can be omitted if the report should include details of allblock types. ' - type: array - items: - type: string - minLength: 1 - ProblemResponsesReportStatus: - required: - - status - - task_id - type: object - properties: - status: - title: Status - description: User-friendly text describing current status of report generation. - type: string - minLength: 1 - task_id: - title: Task id - description: A unique id for the report generation task. It can be used to - query the latest report generation status. - type: string - format: uuid - InstructorTask: - required: - - status - - task_type - - task_id - - created - - task_input - - requester - - task_state - - duration_sec - - task_message - type: object - properties: - status: - title: Status - description: Current status of task. - type: string - minLength: 1 - task_type: - title: Task type - description: Identifies the kind of task being performed, e.g. rescoring. - type: string - minLength: 1 - task_id: - title: Task id - description: The celery ID for the task. - type: string - minLength: 1 - created: - title: Created - description: The date and time when the task was created. - type: string - format: date-time - task_input: - title: Task input - description: The input parameters for the task. The format and content of - this data will depend on the kind of task being performed. For instanceit - may contain the problem locations for a problem resources task. - type: object - additionalProperties: - type: string - x-nullable: true - requester: - title: Requester - description: The username of the user who initiated this task. - type: string - minLength: 1 - task_state: - title: Task state - description: The last knows state of the celery task. - type: string - minLength: 1 - duration_sec: - title: Duration sec - description: Task duration information, if known - type: string - minLength: 1 - task_message: - title: Task message - description: User-friendly task status information, if available. - type: string - minLength: 1 - InstructorTasksList: - required: - - tasks - type: object - properties: - tasks: - description: List of instructor tasks. - type: array - items: - $ref: '#/definitions/InstructorTask' ScheduledBulkEmail: required: - task @@ -12072,6 +10567,11 @@ definitions: format: uri maxLength: 200 x-nullable: true + course_id: + title: Course id + type: string + maxLength: 255 + x-nullable: true last_read: title: Last read type: string @@ -12161,132 +10661,6 @@ definitions: title: Logo url type: string minLength: 1 - DueDate: - required: - - name - - url - - date - type: object - properties: - name: - title: Name - type: string - minLength: 1 - url: - title: Url - type: string - minLength: 1 - date: - title: Date - type: string - format: date-time - CourseRunOverview: - required: - - course_run_id - - display_name - - course_run_url - - start_date - - end_date - - course_run_status - - due_dates - type: object - properties: - course_run_id: - title: Course run id - description: ID for the course run. - type: string - minLength: 1 - display_name: - title: Display name - description: Display name of the course run. - type: string - minLength: 1 - resume_course_run_url: - title: Resume course run url - description: The absolute url that takes the user back to their position in - the course run; if absent, user has not made progress in the course. - type: string - minLength: 1 - course_run_url: - title: Course run url - description: The absolute url for the course run. - type: string - minLength: 1 - start_date: - title: Start date - description: Start date for the course run; null if no start date. - type: string - format: date-time - end_date: - title: End date - description: End date for the course run; null if no end date. - type: string - format: date-time - course_run_status: - title: Course run status - description: The user's status of the course run. - type: string - enum: - - in_progress - - upcoming - - completed - emails_enabled: - title: Emails enabled - description: Boolean representing whether emails are enabled for the course;if - absent, the bulk email feature is either not enable at the platformlevel - or is not enabled for the course; if True or False, bulk emailfeature is - enabled, and value represents whether or not user wantsto receive emails. - type: boolean - due_dates: - description: List of subsection due dates for the course run. Due dates are - only returned if the course run is in progress. - type: array - items: - $ref: '#/definitions/DueDate' - micromasters_title: - title: Micromasters title - description: Title of the MicroMasters program that the course run is a part - of; if absent, the course run is not a part of a MicroMasters program. - type: string - minLength: 1 - certificate_download_url: - title: Certificate download url - description: URL to download a certificate, if available; if absent, certificate - is not downloadable. - type: string - minLength: 1 - CourseRunOverviewList: - required: - - course_runs - type: object - properties: - course_runs: - type: array - items: - $ref: '#/definitions/CourseRunOverview' - PageOfCourseRunOverview: - required: - - results - type: object - properties: - previous: - title: Previous - description: Link to the previous page or results, or null if this is the - first. - type: string - format: uri - minLength: 1 - next: - title: Next - description: Link to the next page of results, or null if this is the last. - type: string - format: uri - minLength: 1 - results: - description: The list of result objects on this page. - type: array - items: - $ref: '#/definitions/CourseRunOverview' UserMapping: type: object properties: diff --git a/lms/djangoapps/instructor/enrollment.py b/lms/djangoapps/instructor/enrollment.py index 544b60a08ebe..d16343b6ed7c 100644 --- a/lms/djangoapps/instructor/enrollment.py +++ b/lms/djangoapps/instructor/enrollment.py @@ -4,7 +4,6 @@ Does not include any access control, be sure to check access before calling. """ - import json import logging from contextlib import ExitStack, contextmanager @@ -16,8 +15,7 @@ from django.template.loader import render_to_string from django.urls import reverse from django.utils.translation import override as override_language -from edx_ace import ace, presentation -from edx_ace.channel.django_email import DjangoEmailChannel +from edx_ace import ace from edx_ace.recipient import Recipient from eventtracking import tracker from submissions import api as sub_api # installed from the edx-submissions repository @@ -61,6 +59,7 @@ class EmailEnrollmentState: """ Store the complete enrollment state of an email in a class """ + def __init__(self, course_id, email): # N.B. retired users are not a concern here because they should be # handled at a higher level (i.e. in enroll_email). Besides, this @@ -434,10 +433,10 @@ def _reset_module_attempts(studentmodule): def _fire_score_changed_for_block( - course_id, - student, - block, - module_state_key, + course_id, + student, + block, + module_state_key, ): """ Fires a PROBLEM_RAW_SCORE_CHANGED event for the given module. @@ -592,19 +591,17 @@ def send_mail_to_student(student, param_dict, language=None): user_context=param_dict, ) - render_msg = presentation.render(DjangoEmailChannel, message) - if not render_msg.body_html.count(student) and message_type == 'allowed_enroll': - log.error( - { - 'message': 'Email template does not contain required email address', - 'email_address': student, - 'message_type': message_type, - 'render_msg': render_msg.body, - 'count': render_msg.body_html.count(student), - 'lms_user_id': lms_user_id, - **param_dict - } - ) + if message_type == 'allowed_enroll': + log_data = { + 'message': 'allowed_enroll email data log', + 'message_type': message_type, + 'student': student, + 'recipient': message.recipient.email_address, + 'context_email': message.context.get('email_address'), + 'lms_user_id': lms_user_id, + **param_dict + } + log.error(log_data) ace.send(message) diff --git a/lms/djangoapps/instructor/views/api.py b/lms/djangoapps/instructor/views/api.py index 161aba783ef8..82c6df9048a8 100644 --- a/lms/djangoapps/instructor/views/api.py +++ b/lms/djangoapps/instructor/views/api.py @@ -1706,22 +1706,31 @@ def post(self, request, course_id): return JsonResponse({"status": success_status}) -@transaction.non_atomic_requests -@require_POST -@ensure_csrf_cookie -@cache_control(no_cache=True, no_store=True, must_revalidate=True) -@require_course_permission(permissions.EXAM_RESULTS) -@common_exceptions_400 -def get_proctored_exam_results(request, course_id): +@method_decorator(cache_control(no_cache=True, no_store=True, must_revalidate=True), name='dispatch') +@method_decorator(transaction.non_atomic_requests, name='dispatch') +class GetProctoredExamResults(DeveloperErrorViewMixin, APIView): """ - get the proctored exam resultsreport for the particular course. + get the proctored exam results report for the particular course. """ - course_key = CourseKey.from_string(course_id) - report_type = _('proctored exam results') - task_api.submit_proctored_exam_results_report(request, course_key) - success_status = SUCCESS_MESSAGE_TEMPLATE.format(report_type=report_type) - return JsonResponse({"status": success_status}) + permission_classes = (IsAuthenticated, permissions.InstructorPermission) + permission_name = permissions.EXAM_RESULTS + + @method_decorator(ensure_csrf_cookie) + @method_decorator(transaction.non_atomic_requests) + def post(self, request, course_id): + """ + get the proctored exam results report for the particular course. + """ + try: + course_key = CourseKey.from_string(course_id) + report_type = _('proctored exam results') + task_api.submit_proctored_exam_results_report(request, course_key) + success_status = SUCCESS_MESSAGE_TEMPLATE.format(report_type=report_type) + return JsonResponse({"status": success_status}) + except (AlreadyRunningError, QueueConnectionError, AttributeError) as error: + # Return a 400 status code with the error message + return JsonResponse({"error": str(error)}, status=400) @method_decorator(cache_control(no_cache=True, no_store=True, must_revalidate=True), name='dispatch') diff --git a/lms/djangoapps/instructor/views/api_urls.py b/lms/djangoapps/instructor/views/api_urls.py index 62ca62834236..920c2e7a1ce0 100644 --- a/lms/djangoapps/instructor/views/api_urls.py +++ b/lms/djangoapps/instructor/views/api_urls.py @@ -57,7 +57,7 @@ path('show_student_extensions', api.ShowStudentExtensions.as_view(), name='show_student_extensions'), # proctored exam downloads... - path('get_proctored_exam_results', api.get_proctored_exam_results, name='get_proctored_exam_results'), + path('get_proctored_exam_results', api.GetProctoredExamResults.as_view(), name='get_proctored_exam_results'), # Grade downloads... path('list_report_downloads', api.ListReportDownloads.as_view(), name='list_report_downloads'), diff --git a/lms/static/sass/_build-lms-v1.scss b/lms/static/sass/_build-lms-v1.scss index 90c5077c1f38..4d64e6768515 100644 --- a/lms/static/sass/_build-lms-v1.scss +++ b/lms/static/sass/_build-lms-v1.scss @@ -67,6 +67,7 @@ // features @import 'features/bookmarks-v1'; +@import "features/announcements"; @import 'features/_unsupported-browser-alert'; @import 'features/content-type-gating'; @import 'features/course-duration-limits'; diff --git a/lms/static/sass/features/_announcements.scss b/lms/static/sass/features/_announcements.scss new file mode 100644 index 000000000000..0c3c01fe6077 --- /dev/null +++ b/lms/static/sass/features/_announcements.scss @@ -0,0 +1,28 @@ +// lms - features - announcements +// ==================== +.announcements-list { + display: inline-block; + width: 100%; + + .announcement { + background-color: $course-profile-bg; + align-content: center; + text-align: center; + padding: 22px 33px; + margin-bottom: 15px; + } + + .announcement-button { + display: inline-block; + padding: 3px 10px; + font-size: 0.75rem; + } + + .prev { + float: left; + } + + .next { + float: right; + } +} diff --git a/openedx/features/announcements/apps.py b/openedx/features/announcements/apps.py new file mode 100644 index 000000000000..4bf964cae51b --- /dev/null +++ b/openedx/features/announcements/apps.py @@ -0,0 +1,32 @@ +""" +Announcements Application Configuration +""" + + +from django.apps import AppConfig +from edx_django_utils.plugins import PluginURLs, PluginSettings + +from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType + + +class AnnouncementsConfig(AppConfig): + """ + Application Configuration for Announcements + """ + name = 'openedx.features.announcements' + + plugin_app = { + PluginURLs.CONFIG: { + ProjectType.LMS: { + PluginURLs.NAMESPACE: 'announcements', + PluginURLs.REGEX: '^announcements/', + PluginURLs.RELATIVE_PATH: 'urls', + } + }, + PluginSettings.CONFIG: { + ProjectType.LMS: { + SettingsType.COMMON: {PluginSettings.RELATIVE_PATH: 'settings.common'}, + SettingsType.TEST: {PluginSettings.RELATIVE_PATH: 'settings.test'}, + } + } + } diff --git a/openedx/features/announcements/forms.py b/openedx/features/announcements/forms.py new file mode 100644 index 000000000000..879101ca37d0 --- /dev/null +++ b/openedx/features/announcements/forms.py @@ -0,0 +1,20 @@ +""" +Forms for the Announcement Editor +""" + + +from django import forms + +from .models import Announcement + + +class AnnouncementForm(forms.ModelForm): + """ + Form for editing Announcements + """ + content = forms.CharField(widget=forms.Textarea, label='', required=False) + active = forms.BooleanField(initial=True, required=False) + + class Meta: + model = Announcement + fields = ['content', 'active'] diff --git a/openedx/features/announcements/models.py b/openedx/features/announcements/models.py new file mode 100644 index 000000000000..f58f61165db6 --- /dev/null +++ b/openedx/features/announcements/models.py @@ -0,0 +1,22 @@ +""" +Models for Announcements +""" + + +from django.db import models + + +class Announcement(models.Model): + """ + Site-wide announcements to be displayed on the dashboard + + .. no_pii: + """ + class Meta: + app_label = 'announcements' + + content = models.CharField(max_length=1000, null=False, default="lorem ipsum") + active = models.BooleanField(default=True) + + def __str__(self): + return self.content diff --git a/openedx/features/announcements/settings/__init__.py b/openedx/features/announcements/settings/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/openedx/features/announcements/settings/common.py b/openedx/features/announcements/settings/common.py new file mode 100644 index 000000000000..1a1a5ca497ab --- /dev/null +++ b/openedx/features/announcements/settings/common.py @@ -0,0 +1,21 @@ +"""Common settings for Announcements""" + + +def plugin_settings(settings): + """ + Common settings for Announcements + .. toggle_name: FEATURES['ENABLE_ANNOUNCEMENTS'] + .. toggle_implementation: SettingDictToggle + .. toggle_default: False + .. toggle_description: This feature can be enabled to show system wide announcements + on the sidebar of the learner dashboard. Announcements can be created by Global Staff + users on maintenance dashboard of studio. Maintenance dashboard can accessed at + https://{studio.domain}/maintenance + .. toggle_warning: TinyMCE is needed to show an editor in the studio. + .. toggle_use_cases: open_edx + .. toggle_creation_date: 2017-11-08 + .. toggle_tickets: https://github.com/openedx/edx-platform/pull/16496 + """ + settings.FEATURES['ENABLE_ANNOUNCEMENTS'] = False + # Configure number of announcements to show per page + settings.FEATURES['ANNOUNCEMENTS_PER_PAGE'] = 5 diff --git a/openedx/features/announcements/settings/test.py b/openedx/features/announcements/settings/test.py new file mode 100644 index 000000000000..47d57ca3dcbf --- /dev/null +++ b/openedx/features/announcements/settings/test.py @@ -0,0 +1,8 @@ +"""Test settings for Announcements""" + + +def plugin_settings(settings): + """ + Test settings for Announcements + """ + settings.FEATURES['ENABLE_ANNOUNCEMENTS'] = True diff --git a/openedx/features/announcements/static/announcements/jsx/Announcements.jsx b/openedx/features/announcements/static/announcements/jsx/Announcements.jsx new file mode 100644 index 000000000000..9d370883352c --- /dev/null +++ b/openedx/features/announcements/static/announcements/jsx/Announcements.jsx @@ -0,0 +1,141 @@ +// eslint-disable-next-line max-classes-per-file +import React from 'react'; +import ReactDOM from 'react-dom'; +import PropTypes from 'prop-types'; +import {Button} from '@edx/paragon'; +import $ from 'jquery'; + +class AnnouncementSkipLink extends React.Component { + constructor(props) { + super(props); + this.state = { + count: 0 + }; + $.get('/announcements/page/1') + .then(data => { + this.setState({ + count: data.count + }); + }); + } + + render() { + return (
    {'Skip to list of ' + this.state.count + ' announcements'}
    ); + } +} + +// eslint-disable-next-line react/prefer-stateless-function +class Announcement extends React.Component { + render() { + return ( +
    + ); + } +} + +Announcement.propTypes = { + content: PropTypes.string.isRequired, +}; + +class AnnouncementList extends React.Component { + constructor(props) { + super(props); + this.state = { + page: 1, + announcements: [], + // eslint-disable-next-line react/no-unused-state + num_pages: 0, + has_prev: false, + has_next: false, + start_index: 0, + end_index: 0, + }; + } + + retrievePage(page) { + $.get('/announcements/page/' + page) + .then(data => { + this.setState({ + announcements: data.announcements, + has_next: data.next, + has_prev: data.prev, + // eslint-disable-next-line react/no-unused-state + num_pages: data.num_pages, + count: data.count, + start_index: data.start_index, + end_index: data.end_index, + page: page + }); + }); + } + + renderPrevPage() { + this.retrievePage(this.state.page - 1); + } + + renderNextPage() { + this.retrievePage(this.state.page + 1); + } + + // eslint-disable-next-line react/no-deprecated, react/sort-comp + componentWillMount() { + this.retrievePage(this.state.page); + } + + render() { + var children = this.state.announcements.map( + // eslint-disable-next-line react/no-array-index-key + (announcement, index) => + ); + if (this.state.has_prev) { + var prev_button = ( +
    +
    + ); + } + if (this.state.has_next) { + var next_button = ( +
    +
    + ); + } + return ( +
    + {children} + {prev_button} + {next_button} +
    + ); + } +} + +export default class AnnouncementsView { + constructor() { + ReactDOM.render( + , + document.getElementById('announcements'), + ); + ReactDOM.render( + , + document.getElementById('announcements-skip'), + ); + } +} + +export {AnnouncementsView, AnnouncementList, AnnouncementSkipLink}; diff --git a/openedx/features/announcements/static/announcements/jsx/Announcements.test.jsx b/openedx/features/announcements/static/announcements/jsx/Announcements.test.jsx new file mode 100644 index 000000000000..3ec55f392889 --- /dev/null +++ b/openedx/features/announcements/static/announcements/jsx/Announcements.test.jsx @@ -0,0 +1,25 @@ +import React from 'react'; +import renderer from 'react-test-renderer'; +import testAnnouncements from './test-announcements.json'; + +import {AnnouncementSkipLink, AnnouncementList} from './Announcements'; + +describe('Announcements component', () => { + test('render skip link', () => { + const component = renderer.create( + , + ); + component.root.instance.setState({count: 10}); + const tree = component.toJSON(); + expect(tree).toMatchSnapshot(); + }); + + test('render test announcements', () => { + const component = renderer.create( + , + ); + component.root.instance.setState(testAnnouncements); + const tree = component.toJSON(); + expect(tree).toMatchSnapshot(); + }); +}); diff --git a/openedx/features/announcements/static/announcements/jsx/__snapshots__/Announcements.test.jsx.snap b/openedx/features/announcements/static/announcements/jsx/__snapshots__/Announcements.test.jsx.snap new file mode 100644 index 000000000000..bbf9bfaaaa69 --- /dev/null +++ b/openedx/features/announcements/static/announcements/jsx/__snapshots__/Announcements.test.jsx.snap @@ -0,0 +1,78 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Announcements component render skip link 1`] = ` +
    + Skip to list of 10 announcements +
    +`; + +exports[`Announcements component render test announcements 1`] = ` +
    +
    +
    Announcement 2", + } + } + /> +
    +
    +
    +
    +
    + + + 1 - 5) of 6 + +
    +
    +`; diff --git a/openedx/features/announcements/static/announcements/jsx/test-announcements.json b/openedx/features/announcements/static/announcements/jsx/test-announcements.json new file mode 100644 index 000000000000..d23d39303020 --- /dev/null +++ b/openedx/features/announcements/static/announcements/jsx/test-announcements.json @@ -0,0 +1,17 @@ +{ + "announcements": [ + {"content": "Test Announcement 1"}, + {"content": "Bold Announcement 2"}, + {"content": "Test Announcement 3"}, + {"content": "Test Announcement 4"}, + {"content": "Test Announcement 5"}, + {"content": "Test Announcement 6"} + ], + "has_next": true, + "has_prev": false, + "num_pages": 2, + "count": 6, + "start_index": 1, + "end_index": 5, + "page": 1 +} diff --git a/openedx/features/announcements/tests/__init__.py b/openedx/features/announcements/tests/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/openedx/features/announcements/tests/test_announcements.py b/openedx/features/announcements/tests/test_announcements.py new file mode 100644 index 000000000000..10c608b4a6cd --- /dev/null +++ b/openedx/features/announcements/tests/test_announcements.py @@ -0,0 +1,95 @@ +""" +Unit tests for the announcements feature. +""" + +import json +from unittest.mock import patch + +from django.conf import settings +from django.test import TestCase +from django.test.client import Client +from django.urls import reverse + +from common.djangoapps.student.tests.factories import AdminFactory +from openedx.core.djangolib.testing.utils import skip_unless_lms +from openedx.features.announcements.models import Announcement + +TEST_ANNOUNCEMENTS = [ + ("Active Announcement", True), + ("Inactive Announcement", False), + ("Another Test Announcement", True), + ("Formatted Announcement", True), + ("Other Formatted Announcement", True), +] + + +@skip_unless_lms +class TestGlobalAnnouncements(TestCase): + """ + Test Announcements in LMS + """ + + @classmethod + def setUpTestData(cls): + super().setUpTestData() + Announcement.objects.bulk_create([ + Announcement(content=content, active=active) + for content, active in TEST_ANNOUNCEMENTS + ]) + + def setUp(self): + super().setUp() + self.client = Client() + self.admin = AdminFactory.create( + email='staff@edx.org', + username='admin', + password='pass' + ) + self.client.login(username=self.admin.username, password='pass') + + @patch.dict(settings.FEATURES, {'ENABLE_ANNOUNCEMENTS': False}) + def test_feature_flag_disabled(self): + """Ensures that the default settings effectively disables the feature""" + response = self.client.get('/dashboard') + self.assertNotContains(response, 'AnnouncementsView') + self.assertNotContains(response, '
    Formatted Announcement") diff --git a/openedx/features/announcements/urls.py b/openedx/features/announcements/urls.py new file mode 100644 index 000000000000..0f0ad3a33960 --- /dev/null +++ b/openedx/features/announcements/urls.py @@ -0,0 +1,13 @@ +""" +Defines URLs for announcements in the LMS. +""" +from django.contrib.auth.decorators import login_required +from django.urls import path + +from .views import AnnouncementsJSONView + +urlpatterns = [ + path('page/', login_required(AnnouncementsJSONView.as_view()), + name='page', + ), +] diff --git a/openedx/features/announcements/views.py b/openedx/features/announcements/views.py new file mode 100644 index 000000000000..b6657c29cc12 --- /dev/null +++ b/openedx/features/announcements/views.py @@ -0,0 +1,37 @@ +""" +Views to show announcements. +""" + + +from django.conf import settings +from django.http import JsonResponse +from django.views.generic.list import ListView + +from .models import Announcement + + +class AnnouncementsJSONView(ListView): + """ + View returning a page of announcements for the dashboard + """ + model = Announcement + object_list = Announcement.objects.filter(active=True) + paginate_by = settings.FEATURES.get('ANNOUNCEMENTS_PER_PAGE', 5) + + def get(self, request, *args, **kwargs): + """ + Return active announcements as json + """ + context = self.get_context_data() + + announcements = [{"content": announcement.content} for announcement in context['object_list']] + result = { + "announcements": announcements, + "next": context['page_obj'].has_next(), + "prev": context['page_obj'].has_previous(), + "start_index": context['page_obj'].start_index(), + "end_index": context['page_obj'].end_index(), + "count": context['paginator'].count, + "num_pages": context['paginator'].num_pages, + } + return JsonResponse(result) diff --git a/requirements/edx/base.txt b/requirements/edx/base.txt index 331f89caf5a5..8b5b24ac9fca 100644 --- a/requirements/edx/base.txt +++ b/requirements/edx/base.txt @@ -1278,7 +1278,7 @@ xblock-utils==4.0.0 # via # edx-sga # xblock-poll -xblocks-contrib==0.1.0 +xblocks-contrib==0.2.0 # via -r requirements/edx/bundled.in xmlsec==1.3.14 # via python3-saml diff --git a/requirements/edx/development.txt b/requirements/edx/development.txt index 343379f4d88d..c912344e06a5 100644 --- a/requirements/edx/development.txt +++ b/requirements/edx/development.txt @@ -2273,7 +2273,7 @@ xblock-utils==4.0.0 # -r requirements/edx/testing.txt # edx-sga # xblock-poll -xblocks-contrib==0.1.0 +xblocks-contrib==0.2.0 # via # -r requirements/edx/doc.txt # -r requirements/edx/testing.txt diff --git a/requirements/edx/doc.txt b/requirements/edx/doc.txt index a64db0a23c2d..215460d3c3b5 100644 --- a/requirements/edx/doc.txt +++ b/requirements/edx/doc.txt @@ -1600,7 +1600,7 @@ xblock-utils==4.0.0 # -r requirements/edx/base.txt # edx-sga # xblock-poll -xblocks-contrib==0.1.0 +xblocks-contrib==0.2.0 # via -r requirements/edx/base.txt xmlsec==1.3.14 # via diff --git a/requirements/edx/testing.txt b/requirements/edx/testing.txt index 7dc0924921bb..9849c87ed861 100644 --- a/requirements/edx/testing.txt +++ b/requirements/edx/testing.txt @@ -1689,7 +1689,7 @@ xblock-utils==4.0.0 # -r requirements/edx/base.txt # edx-sga # xblock-poll -xblocks-contrib==0.1.0 +xblocks-contrib==0.2.0 # via -r requirements/edx/base.txt xmlsec==1.3.14 # via diff --git a/setup.py b/setup.py index 3ccfe7734e33..3b8f8c59498d 100644 --- a/setup.py +++ b/setup.py @@ -138,6 +138,7 @@ ], "lms.djangoapp": [ "ace_common = openedx.core.djangoapps.ace_common.apps:AceCommonConfig", + "announcements = openedx.features.announcements.apps:AnnouncementsConfig", "content_libraries = openedx.core.djangoapps.content_libraries.apps:ContentLibrariesConfig", "course_apps = openedx.core.djangoapps.course_apps.apps:CourseAppsConfig", "course_live = openedx.core.djangoapps.course_live.apps:CourseLiveConfig", @@ -156,6 +157,7 @@ "program_enrollments = lms.djangoapps.program_enrollments.apps:ProgramEnrollmentsConfig", ], "cms.djangoapp": [ + "announcements = openedx.features.announcements.apps:AnnouncementsConfig", "ace_common = openedx.core.djangoapps.ace_common.apps:AceCommonConfig", "bookmarks = openedx.core.djangoapps.bookmarks.apps:BookmarksConfig", "course_live = openedx.core.djangoapps.course_live.apps:CourseLiveConfig", diff --git a/webpack.common.config.js b/webpack.common.config.js index c9b69eef4292..4eea3b5da9b6 100644 --- a/webpack.common.config.js +++ b/webpack.common.config.js @@ -133,6 +133,7 @@ module.exports = Merge.smart({ CourseSock: './openedx/features/course_experience/static/course_experience/js/CourseSock.js', Currency: './openedx/features/course_experience/static/course_experience/js/currency.js', + AnnouncementsView: './openedx/features/announcements/static/announcements/jsx/Announcements.jsx', CookiePolicyBanner: './common/static/js/src/CookiePolicyBanner.jsx', // Common @@ -193,19 +194,19 @@ module.exports = Merge.smart({ multiple: [ { search: defineHeader, replace: '' }, { search: defineFooter, replace: '' }, - { + { search: /(\/\* RequireJS) \*\//g, replace(match, p1, offset, string) { return p1; } }, - { + { search: /\/\* Webpack/g, replace(match, p1, offset, string) { return match + ' */'; } }, - { + { search: /text!(.*?\.underscore)/g, replace(match, p1, offset, string) { return p1; @@ -656,13 +657,13 @@ module.exports = Merge.smart({ // We used to have node: { fs: 'empty' } in this file, // that is no longer supported. Adding this based on the recommendation in // https://stackoverflow.com/questions/64361940/webpack-error-configuration-node-has-an-unknown-property-fs - // + // // With this uncommented tests fail // Tests failed in the following suites: // * lms javascript // * xmodule-webpack javascript // Error: define cannot be used indirect - // + // // fallback: { // fs: false // } diff --git a/xmodule/tests/test_word_cloud.py b/xmodule/tests/test_word_cloud.py index 6c928465262b..9fbd02a612db 100644 --- a/xmodule/tests/test_word_cloud.py +++ b/xmodule/tests/test_word_cloud.py @@ -6,6 +6,7 @@ from django.test import TestCase from fs.memoryfs import MemoryFS from lxml import etree +from webob import Request from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator from webob.multidict import MultiDict from xblock.field_data import DictFieldData @@ -115,3 +116,29 @@ def test_indexibility(self): {'content_type': 'Word Cloud', 'content': {'display_name': 'Word Cloud Block', 'instructions': 'Enter some random words that comes to your mind'}} + + def test_studio_submit_handler(self): + """ + Test studio_submint handler + """ + TEST_SUBMIT_DATA = { + 'display_name': "New Word Cloud", + 'instructions': "This is a Test", + 'num_inputs': 5, + 'num_top_words': 10, + 'display_student_percents': 'False', + } + module_system = get_test_system() + block = WordCloudBlock(module_system, DictFieldData(self.raw_field_data), Mock()) + body = json.dumps(TEST_SUBMIT_DATA) + request = Request.blank('/') + request.method = 'POST' + request.body = body.encode('utf-8') + res = block.handle('studio_submit', request) + assert json.loads(res.body.decode('utf8')) == {'result': 'success'} + + assert block.display_name == TEST_SUBMIT_DATA['display_name'] + assert block.instructions == TEST_SUBMIT_DATA['instructions'] + assert block.num_inputs == TEST_SUBMIT_DATA['num_inputs'] + assert block.num_top_words == TEST_SUBMIT_DATA['num_top_words'] + assert block.display_student_percents == (TEST_SUBMIT_DATA['display_student_percents'] == "True") diff --git a/xmodule/word_cloud_block.py b/xmodule/word_cloud_block.py index 37e82400df78..f83cda8c0c83 100644 --- a/xmodule/word_cloud_block.py +++ b/xmodule/word_cloud_block.py @@ -315,6 +315,26 @@ def index_dictionary(self): return xblock_body + @XBlock.json_handler + def studio_submit(self, submissions, suffix=''): # pylint: disable=unused-argument + """ + Change the settings for this XBlock given by the Studio user + """ + if 'display_name' in submissions: + self.display_name = submissions['display_name'] + if 'instructions' in submissions: + self.instructions = submissions['instructions'] + if 'num_inputs' in submissions: + self.num_inputs = submissions['num_inputs'] + if 'num_top_words' in submissions: + self.num_top_words = submissions['num_top_words'] + if 'display_student_percents' in submissions: + self.display_student_percents = submissions['display_student_percents'] == 'True' + + return { + 'result': 'success', + } + WordCloudBlock = ( _ExtractedWordCloudBlock if settings.USE_EXTRACTED_WORD_CLOUD_BLOCK