feat: bulk modulestore migration [FC-0097] (#37381)

- Adds the task, python api, and rest api view for bulk migration.
- Refactor the code to share code between single migration and bulk migration.

Author: ChrisChV

cms/djangoapps/modulestore_migrator/api.py

@@ -15,6 +15,7 @@
 
 __all__ = (
     "start_migration_to_library",
+    "start_bulk_migration_to_library",
     "is_successfully_migrated",
     "get_migration_info",
 )
@@ -46,7 +47,6 @@ def start_migration_to_library(
     return tasks.migrate_from_modulestore.delay(
         user_id=user.id,
         source_pk=source.id,
-        target_package_pk=target_package_id,
         target_library_key=str(target_library_key),
         target_collection_pk=target_collection_id,
         composition_level=composition_level,
@@ -56,6 +56,52 @@ def start_migration_to_library(
     )
 
 
+def start_bulk_migration_to_library(
+    *,
+    user: AuthUser,
+    source_key_list: list[LearningContextKey],
+    target_library_key: LibraryLocatorV2,
+    target_collection_slug_list: list[str | None] | None = None,
+    create_collections: bool = False,
+    composition_level: str,
+    repeat_handling_strategy: str,
+    preserve_url_slugs: bool,
+    forward_source_to_target: bool,
+) -> AsyncResult:
+    """
+    Import a list of courses or legacy libraries into a V2 library (or, a collections within a V2 library).
+    """
+    target_library = get_library(target_library_key)
+    # get_library ensures that the library is connected to a learning package.
+    target_package_id: int = target_library.learning_package_id  # type: ignore[assignment]
+
+    sources_pks: list[int] = []
+    for source_key in source_key_list:
+        source, _ = ModulestoreSource.objects.get_or_create(key=source_key)
+        sources_pks.append(source.id)
+
+    target_collection_pks: list[int | None] = []
+    if target_collection_slug_list:
+        for target_collection_slug in target_collection_slug_list:
+            if target_collection_slug:
+                target_collection_id = get_collection(target_package_id, target_collection_slug).id
+                target_collection_pks.append(target_collection_id)
+            else:
+                target_collection_pks.append(None)
+
+    return tasks.bulk_migrate_from_modulestore.delay(
+        user_id=user.id,
+        sources_pks=sources_pks,
+        target_library_key=str(target_library_key),
+        target_collection_pks=target_collection_pks,
+        create_collections=create_collections,
+        composition_level=composition_level,
+        repeat_handling_strategy=repeat_handling_strategy,
+        preserve_url_slugs=preserve_url_slugs,
+        forward_source_to_target=forward_source_to_target,
+    )
+
+
 def is_successfully_migrated(source_key: CourseKey | LibraryLocator) -> bool:
     """
     Check if the source course/library has been migrated successfully.

cms/djangoapps/modulestore_migrator/migrations/0002_alter_modulestoremigration_task_status.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.24 on 2025-09-29 20:28
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('user_tasks', '0004_url_textfield'),
+        ('modulestore_migrator', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='modulestoremigration',
+            name='task_status',
+            field=models.ForeignKey(help_text='Tracks the status of the task which is executing this migration. In a bulk migration, the same task can be multiple migrations', on_delete=django.db.models.deletion.RESTRICT, related_name='migrations', to='user_tasks.usertaskstatus'),
+        ),
+    ]

cms/djangoapps/modulestore_migrator/models.py

@@ -107,10 +107,14 @@ class ModulestoreMigration(models.Model):
     )
 
     ## MIGRATION ARTIFACTS
-    task_status = models.OneToOneField(
+    task_status = models.ForeignKey(
         UserTaskStatus,
         on_delete=models.RESTRICT,
-        help_text=_("Tracks the status of the task which is executing this migration"),
+        help_text=_(
+            "Tracks the status of the task which is executing this migration. "
+            "In a bulk migration, the same task can be multiple migrations"
+        ),
+        related_name="migrations",
     )
     change_log = models.ForeignKey(
         DraftChangeLog,

cms/djangoapps/modulestore_migrator/rest_api/v1/serializers.py

@@ -12,17 +12,17 @@
 from cms.djangoapps.modulestore_migrator.models import ModulestoreMigration
 
 
-class ModulestoreMigrationSerializer(serializers.ModelSerializer):
+class ModulestoreMigrationSerializer(serializers.Serializer):
     """
-    Serializer for the course to library import creation API.
+    Serializer for the course or legacylibrary to library V2 import creation API.
     """
 
     source = serializers.CharField(  # type: ignore[assignment]
         help_text="The source course or legacy library key to import from.",
         required=True,
     )
     target = serializers.CharField(
-        help_text="The target library key to import into.",
+        help_text="The target library V2 key to import into.",
         required=True,
     )
     composition_level = serializers.ChoiceField(
@@ -54,18 +54,6 @@ class ModulestoreMigrationSerializer(serializers.ModelSerializer):
         default=False,
     )
 
-    class Meta:
-        model = ModulestoreMigration
-        fields = [
-            'source',
-            'target',
-            'target_collection_slug',
-            'composition_level',
-            'repeat_handling_strategy',
-            'preserve_url_slugs',
-            'forward_source_to_target',
-        ]
-
     def get_fields(self):
         fields = super().get_fields()
         request = self.context.get('request')
@@ -100,19 +88,74 @@ def get_forward_source_to_target(self, obj: ModulestoreMigration):
 
     def to_representation(self, instance):
         """
-        Override to customize the serialized representation."""
+        Override to customize the serialized representation.
+        """
         data = super().to_representation(instance)
         # Custom logic for forward_source_to_target during serialization
         data['forward_source_to_target'] = self.get_forward_source_to_target(instance)
         return data
 
 
+class BulkModulestoreMigrationSerializer(ModulestoreMigrationSerializer):
+    """
+    Serializer for a bulk migration (of several courses or legacy libraries) to a V2 library.
+    """
+    sources = serializers.ListField(
+        child=serializers.CharField(),
+        help_text="The list of sources course or legacy library keys to import from.",
+        required=True,
+    )
+
+    target_collection_slug_list = serializers.ListField(
+        child=serializers.CharField(),
+        help_text="The list of target collection slugs within the library to import into. Optional.",
+        required=False,
+        allow_empty=True,
+        default=None,
+    )
+
+    create_collections = serializers.BooleanField(
+        help_text=(
+            "If true and `target_collection_slug_list` is not set, "
+            "create the collections in the library where the import will be made"
+        ),
+        required=False,
+        default=False,
+    )
+
+    def get_fields(self):
+        fields = super().get_fields()
+        fields.pop("source", None)
+        fields.pop("target_collection_slug", None)
+        return fields
+
+    def validate_sources(self, value):
+        """
+        Validate all the source key format
+        """
+        validated_sources = []
+        for v in value:
+            try:
+                validated_sources.append(LearningContextKey.from_string(v))
+            except InvalidKeyError as exc:
+                raise serializers.ValidationError(f"Invalid source key: {str(exc)}") from exc
+        return validated_sources
+
+    def to_representation(self, instance):
+        """
+        Override to customize the serialized representation.
+        """
+        if isinstance(instance, list):
+            return [super().to_representation(obj) for obj in instance]
+        return super().to_representation(instance)
+
+
 class StatusWithModulestoreMigrationSerializer(StatusSerializer):
     """
     Serializer for the import task status.
     """
 
-    parameters = ModulestoreMigrationSerializer(source='modulestoremigration')
+    parameters = ModulestoreMigrationSerializer(source='migrations', many=True)
 
     class Meta:
         model = StatusSerializer.Meta.model

cms/djangoapps/modulestore_migrator/rest_api/v1/urls.py

@@ -3,9 +3,10 @@
 """
 
 from rest_framework.routers import SimpleRouter
-from .views import MigrationViewSet
+from .views import MigrationViewSet, BulkMigrationViewSet
 
 ROUTER = SimpleRouter()
-ROUTER.register(r'migrations', MigrationViewSet)
+ROUTER.register(r'migrations', MigrationViewSet, basename='migrations')
+ROUTER.register(r'bulk_migration', BulkMigrationViewSet, basename='bulk-migration')
 
 urlpatterns = ROUTER.urls