Merge pull request #13 from open-craft/agrendalath/bb-9241-refactor-keys

feat: replace UUID with LearningPathKey

Author: Agrendalath

.gitignore

@@ -29,8 +29,11 @@ pip-log.txt
 .coverage
 .coverage.*
 .tox
+.ruff_cache
 coverage.xml
 htmlcov/
+pii_report/
+default.db
 
 # Virtual environments
 /venv/
@@ -63,5 +66,7 @@ docs/learning_paths.*.rst
 # Private requirements
 requirements/private.in
 requirements/private.txt
-.idea
-default.db
+
+# IDEs
+.vscode/
+.idea/

CHANGELOG.rst

@@ -16,6 +16,14 @@ Unreleased
 
 *
 
+0.3.0 - 2025-04-03
+******************
+
+Changed
+=======
+
+* Replaced Learning Path UUID with LearningPathKey.
+
 0.2.3 - 2025-03-31
 ******************
 
@@ -38,7 +46,7 @@ Added
 Added
 =====
 
-* Pathway progress API
+* Progress API
 
 0.2.0 - 2024-01-23
 ******************

docs/conf.py

@@ -516,10 +516,10 @@ def get_version(*file_paths):
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.8", None),
+    "python": ("https://docs.python.org/3.11", None),
     "django": (
-        "https://docs.djangoproject.com/en/3.2/",
-        "https://docs.djangoproject.com/en/3.2/_objects/",
+        "https://docs.djangoproject.com/en/4.2/",
+        "https://docs.djangoproject.com/en/4.2/_objects/",
     ),
     "model_utils": ("https://django-model-utils.readthedocs.io/en/latest/", None),
 }

learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.2.3"
+__version__ = "0.3.0"

learning_paths/admin.py

@@ -104,14 +104,16 @@ class LearningPathAdmin(admin.ModelAdmin):
     search_fields = [
         "slug",
         "display_name",
+        "key",
     ]
     list_display = (
-        "uuid",
+        "key",
         "slug",
         "display_name",
         "level",
         "duration_in_days",
     )
+    readonly_fields = ("key",)
 
     inlines = [
         LearningPathStepInline,
@@ -120,6 +122,12 @@ class LearningPathAdmin(admin.ModelAdmin):
         LearningPathGradingCriteriaInline,
     ]
 
+    def get_readonly_fields(self, request, obj=None):
+        """Make key read-only only for existing objects."""
+        if obj:  # Editing an existing object.
+            return self.readonly_fields
+        return ()  # Allow all fields during creation.
+
     def save_related(self, request, form, formsets, change):
         """Save related objects and enroll users in the learning path."""
         super().save_related(request, form, formsets, change)
@@ -144,7 +152,7 @@ class EnrolledUsersAdmin(admin.ModelAdmin):
     search_fields = [
         "id",
         "user__username",
-        "learning_path__uuid",
+        "learning_path__key",
         "learning_path__slug",
         "learning_path__display_name",
     ]

learning_paths/api/v1/serializers.py

@@ -72,7 +72,7 @@ class Meta:
 
 # pylint: disable=abstract-method
 class LearningPathProgressSerializer(serializers.Serializer):
-    learning_path_id = serializers.UUIDField()
+    learning_path_key = serializers.CharField()
     progress = serializers.FloatField()
     required_completion = serializers.FloatField()
 
@@ -82,7 +82,7 @@ class LearningPathGradeSerializer(serializers.Serializer):
     Serializer for learning path grade.
     """
 
-    learning_path_id = serializers.UUIDField()
+    learning_path_key = serializers.CharField()
     grade = serializers.FloatField()
     required_grade = serializers.FloatField()
 

learning_paths/api/v1/tests/factories.py

@@ -5,6 +5,7 @@
 from django.contrib import auth
 from factory.fuzzy import FuzzyText
 
+from learning_paths.keys import LearningPathKey
 from learning_paths.models import (
     LearningPath,
     LearningPathEnrollment,
@@ -30,22 +31,25 @@ class Meta:
         model = User
 
 
-class LearnerPathwayFactory(factory.django.DjangoModelFactory):
+class LearningPathFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = LearningPath
 
+    key = factory.Sequence(
+        lambda n: LearningPathKey.from_string(f"path-v1:test+number{n}+run+group")
+    )
     uuid = factory.Faker("uuid4")
     display_name = FuzzyText()
     slug = FuzzyText()
     description = FuzzyText()
     sequential = False
 
 
-class LearnerPathGradingCriteriaFactory(factory.django.DjangoModelFactory):
+class LearningPathGradingCriteriaFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = LearningPathGradingCriteria
 
-    learning_path = factory.SubFactory(LearnerPathwayFactory)
+    learning_path = factory.SubFactory(LearningPathFactory)
     required_completion = 0.80
     required_grade = 0.75
 
@@ -56,7 +60,7 @@ class LearningPathEnrollmentFactory(factory.django.DjangoModelFactory):
     """
 
     user = factory.SubFactory(UserFactory)
-    learning_path = factory.SubFactory(LearnerPathwayFactory)
+    learning_path = factory.SubFactory(LearningPathFactory)
     is_active = True
     enrolled_at = factory.LazyFunction(lambda: datetime.now(timezone.utc))
 

learning_paths/api/v1/tests/test_serializers.py

@@ -47,6 +47,7 @@ def test_data(self):
         Tests LearningPathProgress serializer data.
         """
         learning_path = LearningPath.objects.create(
+            key="path-v1:test+test+test+test",
             uuid="817190bc-7bf1-4d95-aa43-bec5f58c2276",
             slug="learn-slug",
             display_name="My Test Learning Path",
@@ -55,7 +56,7 @@ def test_data(self):
             sequential=False,
         )
         progress_data = {
-            "learning_path_id": learning_path.uuid,
+            "learning_path_key": str(learning_path.key),
             "progress": 0.25,
             "required_completion": 0.80,
         }
@@ -70,6 +71,7 @@ def test_data(self):
         Tests LearningPathGrade serializer data.
         """
         learning_path = LearningPath.objects.create(
+            key="path-v1:OpenedX+DemoX+DemoRun+DemoGroup",
             uuid="817190bc-7bf1-4d95-aa43-bec5f58c2276",
             slug="learn-slug",
             display_name="My Test Learning Path",
@@ -78,7 +80,7 @@ def test_data(self):
             sequential=False,
         )
         grade_data = {
-            "learning_path_id": learning_path.uuid,
+            "learning_path_key": str(learning_path.key),
             "grade": 0.25,
             "required_grade": 0.80,
         }

learning_paths/api/v1/tests/test_views.py

@@ -11,9 +11,9 @@
     LearningPathProgressSerializer,
 )
 from learning_paths.api.v1.tests.factories import (
-    LearnerPathGradingCriteriaFactory,
-    LearnerPathwayFactory,
     LearningPathEnrollmentFactory,
+    LearningPathFactory,
+    LearningPathGradingCriteriaFactory,
     UserFactory,
 )
 from learning_paths.api.v1.views import (
@@ -26,7 +26,7 @@
 class LearningPathAsProgramTests(APITestCase):
     def setUp(self):
         super().setUp()
-        self.learning_paths = LearnerPathwayFactory.create_batch(5)
+        self.learning_paths = LearningPathFactory.create_batch(5)
         self.user = UserFactory()
         self.client.force_authenticate(user=self.user)
 
@@ -51,8 +51,8 @@ def setUp(self):
         super().setUp()
         self.user = UserFactory()
         self.client.force_authenticate(user=self.user)
-        self.learning_path = LearnerPathwayFactory.create()
-        self.grading_criteria = LearnerPathGradingCriteriaFactory.create(
+        self.learning_path = LearningPathFactory.create()
+        self.grading_criteria = LearningPathGradingCriteriaFactory.create(
             learning_path=self.learning_path,
             required_completion=0.80,
             required_grade=0.75,
@@ -65,16 +65,16 @@ def test_learning_path_progress_success(
         """
         Test retrieving progress for a learning path.
         """
-        url = reverse("learning-path-progress", args=[self.learning_path.uuid])
+        url = reverse("learning-path-progress", args=[self.learning_path.key])
         request = APIRequestFactory().get(url, format="json")
         view = LearningPathUserProgressView.as_view()
         force_authenticate(request, user=self.user)
-        response = view(request, learning_path_uuid=self.learning_path.uuid)
+        response = view(request, learning_path_key_str=str(self.learning_path.key))
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
         expected_data = {
-            "learning_path_id": str(self.learning_path.uuid),
+            "learning_path_key": str(self.learning_path.key),
             "progress": 0.75,
             "required_completion": 0.80,
         }
@@ -88,8 +88,8 @@ def setUp(self) -> None:
         super().setUp()
         self.staff_user = UserFactory(is_staff=True)
         self.client.force_authenticate(user=self.staff_user)
-        self.learning_path = LearnerPathwayFactory.create()
-        self.grading_criteria = LearnerPathGradingCriteriaFactory.create(
+        self.learning_path = LearningPathFactory.create()
+        self.grading_criteria = LearningPathGradingCriteriaFactory.create(
             learning_path=self.learning_path,
             required_completion=0.80,
             required_grade=0.75,
@@ -100,7 +100,7 @@ def test_learning_path_grade_grading_criteria_not_found(self):
         Test that the grade view returns 404 if grading criteria are not found.
         """
         self.grading_criteria.delete()
-        url = reverse("learning-path-grade", args=[self.learning_path.uuid])
+        url = reverse("learning-path-grade", args=[self.learning_path.key])
         response = self.client.get(url)
 
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
@@ -120,7 +120,7 @@ def test_learning_path_grade_success(
         """
         Test retrieving grade for a learning path.
         """
-        url = reverse("learning-path-grade", args=[self.learning_path.uuid])
+        url = reverse("learning-path-grade", args=[self.learning_path.key])
         response = self.client.get(url)
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
@@ -134,8 +134,8 @@ def setUp(self) -> None:
         self.staff = UserFactory(is_staff=True)
         self.learner = UserFactory()
         self.another_learner = UserFactory()
-        self.learning_path = LearnerPathwayFactory.create()
-        self.url = f"/api/learning_paths/v1/{self.learning_path.uuid}/enrollments/"
+        self.learning_path = LearningPathFactory.create()
+        self.url = f"/api/learning_paths/v1/{self.learning_path.key}/enrollments/"
 
     def test_get_with_username_for_staff(self):
         """
@@ -289,9 +289,7 @@ def test_enrollment_returns_404_for_invalid_user_or_learning_path(self):
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
 
         # Test invalid learning_path_id
-        url = reverse(
-            "learning-path-enrollments", args=["2ac8a3cc-e492-4ce9-88a3-cce4922ce9df"]
-        )
+        url = reverse("learning-path-enrollments", args=["path-v1:this+does+not+exist"])
         response = self.client.post(url)
         self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
 
@@ -490,8 +488,8 @@ def setUp(self):
         self.admin_user = UserFactory(is_staff=True, is_superuser=True)
         self.client.force_authenticate(user=self.admin_user)
 
-        self.learning_path1 = LearnerPathwayFactory()
-        self.learning_path2 = LearnerPathwayFactory()
+        self.learning_path1 = LearningPathFactory()
+        self.learning_path2 = LearningPathFactory()
 
         self.user1 = UserFactory(email="user1@example.com")
         self.user2 = UserFactory(email="user2@example.com")
@@ -503,11 +501,11 @@ def _call_api(self, payload):
     def test_bulk_enrollment_success(self):
         """
         GIVEN valid payload from staff user
-        WHEN then uuids and emails are valid
+        WHEN then keys and emails are valid
         THEN create necessary enrollments and enrollment allowed objects.
         """
         payload = {
-            "learning_paths": f"{self.learning_path1.uuid},{self.learning_path2.uuid}",
+            "learning_paths": f"{self.learning_path1.key},{self.learning_path2.key}",
             "emails": "user1@example.com,user2@example.com,new_user@example.com",
         }
         response = self._call_api(payload)
@@ -549,11 +547,11 @@ def test_bulk_enrollment_success(self):
     def test_bulk_enrollment_with_invalid_learning_path(self):
         """
         GIVEN valid payload from staff user
-        WHEN the learning path uuid is invalid
+        WHEN the learning path key is invalid
         THEN no enrollments are created.
         """
         payload = {
-            "learning_paths": "invalid-path-uuid",
+            "learning_paths": "invalid-path-key",
             "emails": "user1@example.com,user2@example.com",
         }
         response = self._call_api(payload)
@@ -569,7 +567,7 @@ def test_bulk_enrollment_with_invalid_and_valid_emails(self):
         THEN no enrollments are created for the invalid email.
         """
         payload = {
-            "learning_paths": f"{self.learning_path1.uuid}",
+            "learning_paths": f"{self.learning_path1.key}",
             "emails": "user1@example.com,invalid_email",
         }
         response = self._call_api(payload)
@@ -600,7 +598,7 @@ def test_bulk_enrollment_unauthenticated(self):
         """
         self.client.logout()
         payload = {
-            "learning_paths": f"{self.learning_path1.uuid}",
+            "learning_paths": f"{self.learning_path1.key}",
             "emails": "user1@example.com",
         }
         # Un-authenticates
@@ -623,7 +621,7 @@ def test_bulk_enrollment_returned_counts_reflect_only_new_ones(self):
         )
 
         payload = {
-            "learning_paths": f"{self.learning_path1.uuid}",
+            "learning_paths": f"{self.learning_path1.key}",
             "emails": self.user1.email,
         }
 
@@ -644,7 +642,7 @@ def test_re_enrollment(self):
         )
 
         payload = {
-            "learning_paths": f"{self.learning_path1.uuid}",
+            "learning_paths": f"{self.learning_path1.key}",
             "emails": self.user1.email,
         }