update course sync

Author: asadali145

src/ol_openedx_course_propagator/BUILD

@@ -0,0 +1,26 @@
+python_sources(
+    name="ol_openedx_course_sync_source",
+    dependencies=[
+        "src/ol_openedx_course_sync/migrations:ol_openedx_course_sync_migrations",
+        "//:external_dependencies#edx-opaque-keys",
+        "//:external_dependencies#celery",
+    ],
+)
+
+python_distribution(
+    name="ol_openedx_course_sync_package",
+    dependencies=[":ol_openedx_course_sync_source"],
+    provides=setup_py(
+        name="ol-openedx-course-sync",
+        version="0.1.0",
+        description="An edX plugin to sync changes in a course to its child courses",
+        license="BSD-3-Clause",
+        author="MIT Office of Digital Learning",
+        entry_points={
+            "lms.djangoapp": [],
+            "cms.djangoapp": [
+                "ol_openedx_course_sync=ol_openedx_course_sync.apps:OLOpenEdxCourseSyncConfig",
+            ],
+        },
+    ),
+)

src/ol_openedx_course_propagator/__init__.py

@@ -1,7 +1,7 @@
 edX Username Changer
 =======================
 
-A plugin to enable course updates propagation to the child/rerun courses.
+A plugin to enable course updates sync to the target/rerun courses.
 
 Version Compatibility
 ---------------------

src/ol_openedx_course_propagator/models.py

@@ -0,0 +1,3 @@
+# pylint: disable=missing-module-docstring
+__version__ = 0.1
+default_app_config = "ol_openedx_course_sync.apps.OLOpenEdxCourseSyncConfig"

src/ol_openedx_course_propagator/signals.py

@@ -0,0 +1,18 @@
+"""
+Django admin pages for ol-openedx-course-sync plugin
+"""
+
+from django.contrib import admin
+from ol_openedx_course_sync.models import CourseSyncParentOrg, CourseSyncMap
+
+
+class CourseSyncParentOrgAdmin(admin.ModelAdmin):
+    list_display = ("organization",)
+
+
+class CourseSyncMapAdmin(admin.ModelAdmin):
+    list_display = ("source_course", "target_courses")
+
+
+admin.site.register(CourseSyncParentOrg, CourseSyncParentOrgAdmin)
+admin.site.register(CourseSyncMap, CourseSyncMapAdmin)

src/ol_openedx_course_sync/BUILD

@@ -1,13 +1,15 @@
 """
-App configuration for ol-openedx-course-propagator plugin
+App configuration for ol-openedx-course-sync plugin
 """
 
 from django.apps import AppConfig
+from edx_django_utils.plugins import PluginSignals
+from openedx.core.djangoapps.plugins.constants import ProjectType
 
 
-class OLOpenEdxCoursePropagatorConfig(AppConfig):
-    name = "ol_openedx_course_propagator"
-    verbose_name = "Open edX Course Propagator"
+class OLOpenEdxCourseSyncConfig(AppConfig):
+    name = "ol_openedx_course_sync"
+    verbose_name = "Open edX Course Sync"
 
     plugin_app = {
         PluginSignals.CONFIG: {
@@ -16,7 +18,7 @@ class OLOpenEdxCoursePropagatorConfig(AppConfig):
                     {
                         PluginSignals.RECEIVER_FUNC_NAME: "listen_for_course_publish",
                         PluginSignals.SIGNAL_PATH: "xmodule.modulestore.django.COURSE_PUBLISHED",  # noqa: E501
-                        PluginSignals.DISPATCH_UID: "ol_openedx_course_propagator.signals.listen_for_course_publish",  # noqa: E501
+                        PluginSignals.DISPATCH_UID: "ol_openedx_course_sync.signals.listen_for_course_publish",  # noqa: E501
                     }
                 ],
             },

src/ol_openedx_course_propagator/LICENCE.txt renamed to src/ol_openedx_course_sync/LICENCE.txt

@@ -0,0 +1,30 @@
+# Generated by Django 4.2.20 on 2025-05-12 12:19
+
+from django.db import migrations, models
+import opaque_keys.edx.django.models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CourseSyncMap',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('source_course', opaque_keys.edx.django.models.CourseKeyField(max_length=255)),
+                ('target_courses', models.TextField(blank=True, help_text='Comma separated list of target course keys', null=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='CourseSyncParentOrg',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('organization', models.CharField(max_length=255, unique=True)),
+            ],
+        ),
+    ]

src/ol_openedx_course_propagator/README.rst renamed to src/ol_openedx_course_sync/README.rst

@@ -0,0 +1 @@
+python_sources(name="ol_openedx_course_sync_migrations")

src/ol_openedx_course_sync/__init__.py

@@ -0,0 +1,29 @@
+from django.db import models
+from model_utils.models import TimeStampedModel
+from opaque_keys.edx.django.models import (
+    CourseKeyField,
+)
+
+class CourseSyncParentOrg(models.Model):
+    """
+    Model for source course organizations
+
+    Any source course that is part of this organization will sync changes with the child/rerun courses.
+    This model will help us exclude any organizations, where we don't want to sync source course.
+    """
+    organization = models.CharField(max_length=255, unique=True)
+
+
+class CourseSyncMap(models.Model):
+    """
+    Model to keep track of source and target courses.
+
+    Any changes in the source course sync with the target courses. Target courses are autopopulated
+    for all the reruns of source courses that are part of any organization added in `CourseSyncParentOrg`.
+    """
+    source_course = CourseKeyField(max_length=255)
+    target_courses = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Comma separated list of target course keys"
+    )

src/ol_openedx_course_sync/admin.py

@@ -0,0 +1,69 @@
+"""
+Signal handlers ol-openedx-course-sync plugin
+"""
+import logging
+
+from xmodule.modulestore.django import modulestore
+from xmodule.modulestore import ModuleStoreEnum
+from opaque_keys.edx.locator import CourseLocator
+from xmodule.modulestore.django import SignalHandler
+from django.dispatch import receiver
+
+from ol_openedx_course_sync.models import CourseSyncParentOrg, CourseSyncMap
+from ol_openedx_course_sync.tasks import async_course_sync
+from django.db.models.signals import post_save
+from common.djangoapps.course_action_state.models import CourseRerunState
+
+log = logging.getLogger(__name__)
+
+
+@receiver(SignalHandler.course_published)
+def listen_for_course_publish(
+    sender,  # noqa: ARG001
+    course_key,
+    **kwargs,  # noqa: ARG001
+):
+    """
+    Copy course content from source course to destination course.
+    """
+    if not CourseSyncParentOrg.objects.filter(organization=course_key.org).exists():
+        return
+
+    course_sync_map = CourseSyncMap.objects.filter(
+        source_course=course_key
+    ).first()
+    if course_sync_map and course_sync_map.target_courses:
+        source_course = str(course_sync_map.source_course)
+        user_id = 2
+        for target_course_key in course_sync_map.target_courses.split(","):
+            # Call the async task to copy the course content
+            async_course_sync.delay(user_id, source_course, target_course_key)
+    else:
+        log.warning(
+            "No mapping found for course %s. Skipping copy.", course_key.id
+        )
+        return
+
+
+@receiver(post_save, sender=CourseRerunState)
+def listen_for_course_rerun_state_post_save(sender, instance, **kwargs):
+    """
+    Updates target courses in `CourseSyncMap`
+    """
+    if not instance.state == "succeeded":
+        return
+
+    if not CourseSyncParentOrg.objects.filter(organization=instance.source_course_key.org).exists():
+        return
+
+    # If source key is a child of any other course, we won't make it parent
+    if CourseSyncMap.objects.filter(target_courses__contains=str(instance.source_course_key)).exists():
+        return
+
+    course_sync_map, _ = CourseSyncMap.objects.get_or_create(
+        source_course=instance.source_course_key
+    )
+    target_courses = course_sync_map.target_courses.split(",") if course_sync_map.target_courses else []
+    target_courses.append(str(instance.course_key))
+    course_sync_map.target_courses = ",".join(target_courses)
+    course_sync_map.save()

src/ol_openedx_course_propagator/apps.py renamed to src/ol_openedx_course_sync/apps.py

@@ -1,14 +1,22 @@
+"""
+Tasks for the ol-openedx-course-sync plugin.
+"""
 from celery import shared_task  # pylint: disable=import-error
 from celery.utils.log import get_task_logger
 from cms.djangoapps.contentstore.git_export_utils import GitExportError, export_to_git
 from opaque_keys.edx.keys import CourseKey
 from xmodule.modulestore.django import modulestore
+from opaque_keys.edx.locator import CourseLocator
+from xmodule.modulestore.django import SignalHandler
 
 LOGGER = get_task_logger(__name__)
 
 
 @shared_task
-def async_course_propagator(user_id, source_course_id, dest_course_id):
+def async_course_sync(user_id, source_course_id, dest_course_id):
+    """
+    Syncs course content from source course to destination course.
+    """
     module_store = modulestore()
     source_course_key = CourseLocator.from_string(source_course_id)
     source_course_draft = source_course_key.for_branch("draft-branch")