Merge branch 'master' into ttqureshi/enable-lti

Author: ttqureshi

cms/djangoapps/contentstore/course_group_config.py

@@ -12,23 +12,21 @@
 from cms.djangoapps.contentstore.utils import reverse_usage_url
 from common.djangoapps.util.db import MYSQL_MAX_INT, generate_int_id
 from lms.lib.utils import get_parent_unit
+# Re-exported for backward compatibility - other modules import these from here
+from openedx.core.djangoapps.course_groups.constants import (  # pylint: disable=unused-import
+    COHORT_SCHEME,
+    CONTENT_GROUP_CONFIGURATION_DESCRIPTION,
+    CONTENT_GROUP_CONFIGURATION_NAME,
+    ENROLLMENT_SCHEME,
+    RANDOM_SCHEME,
+)
 from openedx.core.djangoapps.course_groups.partition_scheme import get_cohorted_user_partition
 from xmodule.partitions.partitions import MINIMUM_UNUSED_PARTITION_ID, ReadOnlyUserPartitionError, UserPartition  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.partitions.partitions_service import get_all_partitions_for_course  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.split_test_block import get_split_user_partitions  # lint-amnesty, pylint: disable=wrong-import-order
 
 MINIMUM_GROUP_ID = MINIMUM_UNUSED_PARTITION_ID
 
-RANDOM_SCHEME = "random"
-COHORT_SCHEME = "cohort"
-ENROLLMENT_SCHEME = "enrollment_track"
-
-CONTENT_GROUP_CONFIGURATION_DESCRIPTION = _(
-    'The groups in this configuration can be mapped to cohorts in the Instructor Dashboard.'
-)
-
-CONTENT_GROUP_CONFIGURATION_NAME = _('Content Groups')
-
 log = logging.getLogger(__name__)
 
 

lms/djangoapps/bulk_email/signals.py

@@ -7,6 +7,7 @@
 from eventtracking import tracker
 
 from common.djangoapps.student.models import CourseEnrollment
+from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 from openedx.core.djangoapps.user_api.accounts.signals import USER_RETIRE_MAILINGS
 from edx_ace.signals import ACE_MESSAGE_SENT
 
@@ -27,7 +28,14 @@ def force_optout_all(sender, **kwargs):  # lint-amnesty, pylint: disable=unused-
         raise TypeError('Expected a User type, but received None.')
 
     for enrollment in CourseEnrollment.objects.filter(user=user):
-        Optout.objects.get_or_create(user=user, course_id=enrollment.course.id)
+        try:
+            Optout.objects.get_or_create(user=user, course_id=enrollment.course.id)
+        except CourseOverview.DoesNotExist:
+            log.warning(
+                f"CourseOverview not found for enrollment {enrollment.id} (user: {user.id}), "
+                f"skipping optout creation. This may mean the course was deleted."
+            )
+            continue
 
 
 @receiver(ACE_MESSAGE_SENT)

lms/djangoapps/bulk_email/tests/test_signals.py

@@ -10,9 +10,11 @@
 from django.core.management import call_command
 from django.urls import reverse
 
+from common.djangoapps.student.models import CourseEnrollment
 from common.djangoapps.student.tests.factories import AdminFactory, CourseEnrollmentFactory, UserFactory
 from lms.djangoapps.bulk_email.models import BulkEmailFlag, Optout
 from lms.djangoapps.bulk_email.signals import force_optout_all
+from opaque_keys.edx.keys import CourseKey
 from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase  # lint-amnesty, pylint: disable=wrong-import-order
 from xmodule.modulestore.tests.factories import CourseFactory  # lint-amnesty, pylint: disable=wrong-import-order
 
@@ -85,3 +87,41 @@ def test_optout_course(self):
         assert len(mail.outbox) == 1
         assert len(mail.outbox[0].to) == 1
         assert mail.outbox[0].to[0] == self.instructor.email
+
+    @patch('lms.djangoapps.bulk_email.signals.log.warning')
+    def test_optout_handles_missing_course_overview(self, mock_log_warning):
+        """
+        Test that force_optout_all gracefully handles CourseEnrollments
+        with missing CourseOverview records
+        """
+        # Create a course key for a course that doesn't exist in CourseOverview
+        nonexistent_course_key = CourseKey.from_string('course-v1:TestX+Missing+2023')
+
+        # Create an enrollment with a course_id that doesn't have a CourseOverview
+        CourseEnrollment.objects.create(
+            user=self.student,
+            course_id=nonexistent_course_key,
+            mode='honor'
+        )
+
+        # Verify the orphaned enrollment exists
+        assert CourseEnrollment.objects.filter(
+            user=self.student,
+            course_id=nonexistent_course_key
+        ).exists()
+
+        force_optout_all(sender=self.__class__, user=self.student)
+
+        # Verify that a warning was logged for the missing CourseOverview
+        mock_log_warning.assert_called()
+        call_args = mock_log_warning.call_args[0][0]
+        assert "CourseOverview not found for enrollment" in call_args
+        assert f"user: {self.student.id}" in call_args
+        assert "skipping optout creation" in call_args
+
+        # Verify that optouts were created for valid courses only
+        valid_course_optouts = Optout.objects.filter(user=self.student, course_id=self.course.id)
+        missing_course_optouts = Optout.objects.filter(user=self.student, course_id=nonexistent_course_key)
+
+        assert valid_course_optouts.count() == 1
+        assert missing_course_optouts.count() == 0

openedx/core/djangoapps/course_groups/constants.py

@@ -0,0 +1,13 @@
+"""
+Constants for course groups.
+"""
+from django.utils.translation import gettext_lazy as _
+
+COHORT_SCHEME = 'cohort'
+RANDOM_SCHEME = 'random'
+ENROLLMENT_SCHEME = 'enrollment_track'
+
+CONTENT_GROUP_CONFIGURATION_NAME = _('Content Groups')
+CONTENT_GROUP_CONFIGURATION_DESCRIPTION = _(
+    'Use this group configuration to control access to content.'
+)

openedx/core/djangoapps/course_groups/rest_api/__init__.py

@@ -0,0 +1,172 @@
+swagger: '2.0'
+info:
+  title: Content Groups API v2
+  version: 2.0.0
+  description: |
+    REST API for managing content group configurations.
+
+    Content groups allow course authors to restrict access to specific
+    course content based on cohort membership.
+
+host: courses.example.com
+basePath: /
+schemes:
+  - https
+
+securityDefinitions:
+  JWTAuth:
+    type: apiKey
+    in: header
+    name: Authorization
+    description: JWT token authentication.
+
+security:
+  - JWTAuth: []
+
+tags:
+  - name: Content Groups
+    description: Content group configuration management
+
+parameters:
+  CourseId:
+    name: course_id
+    in: path
+    required: true
+    type: string
+    description: The course key (e.g., course-v1:org+course+run)
+  ConfigurationId:
+    name: configuration_id
+    in: path
+    required: true
+    type: integer
+    description: The ID of the content group configuration
+
+paths:
+  /api/cohorts/v2/courses/{course_id}/group_configurations:
+    get:
+      tags:
+        - Content Groups
+      summary: List content group configurations
+      description: |
+        Returns all content group configurations (scheme='cohort') for a course.
+        If no content group exists, an empty one is automatically created.
+      operationId: listGroupConfigurations
+      produces:
+        - application/json
+      parameters:
+        - $ref: '#/parameters/CourseId'
+      responses:
+        200:
+          description: Content groups retrieved successfully
+          schema:
+            $ref: '#/definitions/ContentGroupsListResponse'
+        400:
+          description: Invalid course key
+        401:
+          description: Authentication required
+        403:
+          description: User lacks instructor permission
+        404:
+          description: Course not found
+
+  /api/cohorts/v2/courses/{course_id}/group_configurations/{configuration_id}:
+    get:
+      tags:
+        - Content Groups
+      summary: Get content group configuration details
+      description: |
+        Retrieve a specific content group configuration by ID.
+        Only returns configurations with scheme='cohort'.
+      operationId: getGroupConfiguration
+      produces:
+        - application/json
+      parameters:
+        - $ref: '#/parameters/CourseId'
+        - $ref: '#/parameters/ConfigurationId'
+      responses:
+        200:
+          description: Configuration retrieved successfully
+          schema:
+            $ref: '#/definitions/ContentGroupConfiguration'
+        400:
+          description: Invalid course key
+        401:
+          description: Authentication required
+        403:
+          description: User lacks instructor permission
+        404:
+          description: Configuration not found
+
+definitions:
+  Group:
+    type: object
+    properties:
+      id:
+        type: integer
+        description: Unique identifier for the group
+      name:
+        type: string
+        description: Display name of the group
+      version:
+        type: integer
+        description: Version number of the group
+      usage:
+        type: array
+        items:
+          type: object
+        description: List of content blocks using this group
+
+  ContentGroupConfiguration:
+    type: object
+    properties:
+      id:
+        type: integer
+        description: Unique identifier for the configuration
+      name:
+        type: string
+        description: Display name (typically "Content Groups")
+      scheme:
+        type: string
+        enum: [cohort]
+        description: Partition scheme type
+      description:
+        type: string
+        description: Human-readable description
+      parameters:
+        type: object
+        description: Additional configuration parameters
+      groups:
+        type: array
+        items:
+          $ref: '#/definitions/Group'
+        description: List of groups in this configuration
+      active:
+        type: boolean
+        description: Whether this configuration is active
+      version:
+        type: integer
+        description: Version number of the configuration
+      read_only:
+        type: boolean
+        description: Whether this configuration is system-managed
+
+  ContentGroupsListResponse:
+    type: object
+    properties:
+      all_group_configurations:
+        type: array
+        items:
+          $ref: '#/definitions/ContentGroupConfiguration'
+        description: List of content group configurations
+      should_show_enrollment_track:
+        type: boolean
+        description: Whether enrollment track groups should be displayed
+      should_show_experiment_groups:
+        type: boolean
+        description: Whether experiment groups should be displayed
+      group_configuration_url:
+        type: string
+        description: Base URL for accessing individual configurations
+      course_outline_url:
+        type: string
+        description: URL to the course outline

openedx/core/djangoapps/course_groups/rest_api/docs/content-groups-api-v2-spec.yaml

@@ -0,0 +1,45 @@
+"""
+Serializers for content group configurations REST API.
+"""
+from rest_framework import serializers
+
+
+class GroupSerializer(serializers.Serializer):
+    """
+    Serializer for a single group within a content group configuration.
+    """
+    id = serializers.IntegerField()
+    name = serializers.CharField(max_length=255)
+    version = serializers.IntegerField()
+    usage = serializers.ListField(
+        child=serializers.DictField(),
+        required=False,
+        default=list
+    )
+
+
+class ContentGroupConfigurationSerializer(serializers.Serializer):
+    """
+    Serializer for a content group configuration (UserPartition with scheme='cohort').
+    """
+    id = serializers.IntegerField()
+    name = serializers.CharField(max_length=255)
+    scheme = serializers.CharField()
+    description = serializers.CharField(allow_blank=True)
+    parameters = serializers.DictField()
+    groups = GroupSerializer(many=True)
+    active = serializers.BooleanField()
+    version = serializers.IntegerField()
+    is_read_only = serializers.BooleanField(required=False, default=False)
+
+
+class ContentGroupsListResponseSerializer(serializers.Serializer):
+    """
+    Response serializer for listing all content groups.
+    """
+    all_group_configurations = ContentGroupConfigurationSerializer(many=True)
+    should_show_enrollment_track = serializers.BooleanField()
+    should_show_experiment_groups = serializers.BooleanField()
+    context_course = serializers.JSONField(required=False, allow_null=True)
+    group_configuration_url = serializers.CharField()
+    course_outline_url = serializers.CharField()

openedx/core/djangoapps/course_groups/rest_api/serializers.py

@@ -0,0 +1,3 @@
+"""
+Tests for Content Groups REST API v2.
+"""