fix: enums added for course and library with util to get content details

Author: marslanabdulrauf

src/ol_openedx_git_auto_export/ol_openedx_git_auto_export/admin.py

@@ -7,6 +7,11 @@
 from django.db.models import Q
 from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2
 
+from ol_openedx_git_auto_export.constants import (
+    LIBRARY_V1_PREFIX,
+    LIBRARY_V2_PREFIX,
+    ContentType,
+)
 from ol_openedx_git_auto_export.models import ContentGitRepository
 
 
@@ -19,22 +24,22 @@ class ContentTypeFilter(SimpleListFilter):
     def lookups(self, request, model_admin):  # noqa: ARG002
         """Return filter options."""
         return (
-            ("course", "Course"),
-            ("library", "Library"),
+            (ContentType.COURSE.value, ContentType.COURSE.display_name),
+            (ContentType.LIBRARY.value, ContentType.LIBRARY.display_name),
         )
 
     def queryset(self, request, queryset):  # noqa: ARG002
         """Filter the queryset based on the selected content type."""
-        if self.value() == "course":
+        if self.value() == ContentType.COURSE.value:
             # Filter for courses (exclude libraries)
-            return queryset.exclude(content_key__startswith="library-v1:").exclude(
-                content_key__startswith="lib:"  # lib v2
+            return queryset.exclude(content_key__startswith=LIBRARY_V1_PREFIX).exclude(
+                content_key__startswith=LIBRARY_V2_PREFIX
             )
-        elif self.value() == "library":
+        elif self.value() == ContentType.LIBRARY.value:
             # Filter for libraries
             return queryset.filter(
-                Q(content_key__startswith="library-v1:")
-                | Q(content_key__startswith="lib:")  # lib v2
+                Q(content_key__startswith=LIBRARY_V1_PREFIX)
+                | Q(content_key__startswith=LIBRARY_V2_PREFIX)
             )
         return queryset
 
@@ -61,8 +66,8 @@ class ContentGitRepositoryAdmin(admin.ModelAdmin):
     def content_type_display(self, obj):
         """Display whether the content is a course or library."""
         if isinstance(obj.content_key, (LibraryLocator, LibraryLocatorV2)):
-            return "Library"
-        return "Course"
+            return ContentType.LIBRARY.display_name
+        return ContentType.COURSE.display_name
 
     def has_delete_permission(self, request, obj=None):  # noqa: ARG002
         """

src/ol_openedx_git_auto_export/ol_openedx_git_auto_export/constants.py

@@ -1,3 +1,22 @@
+from enum import StrEnum
+
+
+class ContentType(StrEnum):
+    """Enumeration for content types (Course or Library)."""
+
+    COURSE = "course"
+    LIBRARY = "library"
+
+    @property
+    def display_name(self):
+        """Return the human-readable display name."""
+        return self.value.capitalize()
+
+
+# Library key prefixes for different versions
+LIBRARY_V1_PREFIX = "library-v1:"
+LIBRARY_V2_PREFIX = "lib:"
+
 ENABLE_GIT_AUTO_EXPORT = "ENABLE_GIT_AUTO_EXPORT"
 ENABLE_AUTO_GITHUB_REPO_CREATION = "ENABLE_AUTO_GITHUB_REPO_CREATION"
 GITHUB_ORG = "GITHUB_ORG"

src/ol_openedx_git_auto_export/ol_openedx_git_auto_export/migrations/0002_contentgitrepository.py

@@ -1,5 +1,6 @@
 # Generated migration for renaming CourseGitRepository to ContentGitRepository
 
+import opaque_keys.edx.django.models
 from django.db import migrations
 
 
@@ -13,4 +14,16 @@ class Migration(migrations.Migration):
             old_name="CourseGitRepository",
             new_name="ContentGitRepository",
         ),
+        migrations.RenameField(
+            model_name="contentgitrepository",
+            old_name="course_key",
+            new_name="content_key",
+        ),
+        migrations.AlterField(
+            model_name="contentgitrepository",
+            name="content_key",
+            field=opaque_keys.edx.django.models.LearningContextKeyField(
+                max_length=255, primary_key=True, serialize=False
+            ),
+        ),
     ]

src/ol_openedx_git_auto_export/ol_openedx_git_auto_export/migrations/0003_migrate_course_to_content_repo.py

@@ -11,13 +11,11 @@
 from cms.djangoapps.contentstore.git_export_utils import GitExportError, export_to_git
 from django.conf import settings
 from opaque_keys.edx.keys import LearningContextKey
-from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2
-from openedx.core.djangoapps.content_libraries.api import get_library
 from rest_framework import status
-from xmodule.modulestore.django import modulestore
 
 from ol_openedx_git_auto_export.models import ContentGitRepository
 from ol_openedx_git_auto_export.utils import (
+    get_content_info,
     github_repo_name_format,
     is_auto_repo_creation_enabled,
 )
@@ -36,65 +34,57 @@ def async_export_to_git(content_key_string, user=None):
     # Parse as LearningContextKey to support all learning contexts
     try:
         content_key = LearningContextKey.from_string(content_key_string)
-        is_v1_library = isinstance(content_key, LibraryLocator)
-        is_v2_library = isinstance(content_key, LibraryLocatorV2)
+        content_info = get_content_info(content_key)
     except Exception:
         LOGGER.exception("Failed to parse content key: %s", content_key_string)
         return
 
-    # Get the content module (course or library)
-    if is_v2_library:
-        # V2 libraries use content_libraries API
-        content_module = get_library(content_key)
-        content_type = "library"
-    elif is_v1_library:
-        # V1 libraries use modulestore
-        content_module = modulestore().get_library(content_key)
-        content_type = "library"
-    else:
-        content_module = modulestore().get_course(content_key)
-        content_type = "course"
-
     try:
         content_repo = ContentGitRepository.objects.get(content_key=content_key)
 
         if content_repo.is_export_enabled:
             LOGGER.info(
                 "Starting async %s content export to git (%s id: %s)",
-                content_type,
-                content_type,
-                content_module.id if hasattr(content_module, "id") else content_key,
+                content_info["content_type"],
+                content_info["content_type"],
+                content_info["content_module"].id
+                if hasattr(content_info["content_module"], "id")
+                else content_key,
             )
             # Use unified export_to_git that handles both courses and libraries
             export_to_git(content_key, content_repo.git_url, user=user)
         else:
             LOGGER.info(
                 "Git export is disabled for %s %s. Skipping export.",
-                content_type,
+                content_info["content_type"],
                 content_key_string,
             )
     except GitExportError:
         LOGGER.exception(
             "Failed async %s content export to git (%s id: %s)",
-            content_type,
-            content_type,
-            content_module.id if hasattr(content_module, "id") else content_key,
+            content_info["content_type"],
+            content_info["content_type"],
+            content_info["content_module"].id
+            if hasattr(content_info["content_module"], "id")
+            else content_key,
         )
     except ContentGitRepository.DoesNotExist:
         LOGGER.exception(
             "Git repository does not exist for %s %s. "
             "Creating repository and exporting content.",
-            content_type,
+            content_info["content_type"],
             content_key_string,
         )
-        if is_auto_repo_creation_enabled(is_library=is_v1_library or is_v2_library):
+        if is_auto_repo_creation_enabled(is_library=content_info["is_library"]):
             async_create_github_repo.delay(str(content_key), export_content=True)
     except Exception:
         LOGGER.exception(
             "Unknown error occurred during async %s content export to git (%s id: %s)",
-            content_type,
-            content_type,
-            content_module.id if hasattr(content_module, "id") else content_key,
+            content_info["content_type"],
+            content_info["content_type"],
+            content_info["content_module"].id
+            if hasattr(content_info["content_module"], "id")
+            else content_key,
         )
 
 
@@ -120,40 +110,28 @@ def async_create_github_repo(self, content_key_str, export_content=False):  # no
     # Parse as LearningContextKey to support all learning contexts
     try:
         content_key = LearningContextKey.from_string(content_key_str)
-        is_v1_library = isinstance(content_key, LibraryLocator)
-        is_v2_library = isinstance(content_key, LibraryLocatorV2)
+        content_info = get_content_info(content_key)
     except Exception:
         LOGGER.exception("Failed to parse content key: %s", content_key_str)
         return False, f"Invalid content key: {content_key_str}"
 
-    content_type = "library" if is_v1_library or is_v2_library else "course"
     content_id_slugified = github_repo_name_format(str(content_key))
-
     response_msg = ""
 
     # Check if repository already exists
     if ContentGitRepository.objects.filter(content_key=content_key).exists():
-        response_msg = f"GitHub repository already exists for {content_type} {content_key}. Skipping creation."  # noqa: E501
+        response_msg = f"GitHub repository already exists for {content_info['content_type']} {content_key}. Skipping creation."  # noqa: E501
         LOGGER.info(response_msg)
         return False, response_msg
 
-    # Get the content module (course or library)
-    if is_v2_library:
-        # V2 libraries use content_libraries API
-        content_module = get_library(content_key)
-        url_path = f"library/{content_key_str}"
-    elif is_v1_library:
-        # V1 libraries use modulestore
-        content_module = modulestore().get_library(content_key)
-        url_path = f"library/{content_key_str}"
-    else:
-        content_module = modulestore().get_course(content_key)
-        url_path = f"course/{content_key_str}"
+    # Determine URL path based on content type
+    url_path = f"{content_info['content_type']}/{content_key_str}"
 
-    if is_v2_library:
-        display_name = content_module.title
+    # Get display name (v2 libraries use 'title', others use 'display_name')
+    if content_info["is_v2_library"]:
+        display_name = content_info["content_module"].title
     else:
-        display_name = content_module.display_name
+        display_name = content_info["content_module"].display_name
 
     url = f"{settings.GITHUB_ORG_API_URL}/repos"
     # https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api?apiVersion=2022-11-28
@@ -174,15 +152,15 @@ def async_create_github_repo(self, content_key_str, export_content=False):  # no
     }
     response = requests.post(url, headers=headers, json=payload, timeout=30)
     if response.status_code != status.HTTP_201_CREATED:
-        response_msg = f"Failed to create GitHub repository for {content_type} {content_key}: {response.json()}"  # noqa: E501
+        response_msg = f"Failed to create GitHub repository for {content_info['content_type']} {content_key}: {response.json()}"  # noqa: E501
         LOGGER.error(response_msg)
 
         # Retry the task if we haven't exceeded max retries
         max_retries = self.retry_kwargs.get("max_retries", 3)
         if self.request.retries < max_retries:
             LOGGER.info(
                 "Retrying GitHub repository creation for %s %s (attempt %d/%d)",
-                content_type,
+                content_info["content_type"],
                 content_key,
                 self.request.retries + 1,
                 max_retries,
@@ -202,14 +180,14 @@ def async_create_github_repo(self, content_key_str, export_content=False):  # no
         )
         LOGGER.info(
             "GitHub repository created for %s %s: %s",
-            content_type,
+            content_info["content_type"],
             content_key,
             ssh_url,
         )
     else:
         response_msg = f"""
             Failed to retrieve SSH URL from GitHub response
-            for {content_type} {content_key}.
+            for {content_info["content_type"]} {content_key}.
             Response data: {repo_data}
         """
         LOGGER.error(response_msg)

src/ol_openedx_git_auto_export/ol_openedx_git_auto_export/tasks.py

@@ -9,7 +9,7 @@
 from django.conf import settings
 from django.contrib.auth.models import User
 from django.core.exceptions import ImproperlyConfigured
-from opaque_keys.edx.locator import LibraryLocatorV2
+from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2
 from openedx.core.djangoapps.content_libraries.api import get_library
 from xmodule.modulestore.django import modulestore
 
@@ -19,11 +19,53 @@
     ENABLE_GIT_AUTO_EXPORT,
     ENABLE_GIT_AUTO_LIBRARY_EXPORT,
     REPOSITORY_NAME_MAX_LENGTH,
+    ContentType,
 )
 
 log = logging.getLogger(__name__)
 
 
+def get_content_info(content_key):
+    """
+    Get information about a content item (course or library).
+
+    Args:
+        content_key: A LearningContextKey
+
+    Returns:
+        dict: Dictionary containing:
+            - content_type: The ContentType enum value (str)
+            - content_module: The actual course/library object
+            - is_v1_library: Boolean flag
+            - is_v2_library: Boolean flag
+            - is_library: Boolean flag (True if v1 or v2 library)
+    """
+    is_v1_library = isinstance(content_key, LibraryLocator)
+    is_v2_library = isinstance(content_key, LibraryLocatorV2)
+
+    # Get the content module based on type
+    if is_v2_library:
+        # V2 libraries use content_libraries API
+        content_module = get_library(content_key)
+        content_type = ContentType.LIBRARY.value
+    elif is_v1_library:
+        # V1 libraries use modulestore
+        content_module = modulestore().get_library(content_key)
+        content_type = ContentType.LIBRARY.value
+    else:
+        # Courses use modulestore
+        content_module = modulestore().get_course(content_key)
+        content_type = ContentType.COURSE.value
+
+    return {
+        "content_type": content_type,
+        "content_module": content_module,
+        "is_v1_library": is_v1_library,
+        "is_v2_library": is_v2_library,
+        "is_library": is_v1_library or is_v2_library,
+    }
+
+
 def get_publisher_username(course_module):
     """
     Return the username of the user who published the course.