feat: [ACI-940, ACI-941] implement keypaths exclusion logic

credentials/apps/badges/tests/test_utils.py

@@ -2,12 +2,13 @@
 
 from attr import asdict
 from datetime import datetime
+from django.conf import settings
 from unittest.mock import patch
 
 from openedx_events.learning.data import UserData, UserPersonalData, CourseData, CoursePassingStatusData
 
 from credentials.apps.badges.checks import badges_checks
-from credentials.apps.badges.utils import extract_payload, keypath, get_user_data
+from credentials.apps.badges.utils import extract_payload, keypath, get_user_data, get_event_type_keypaths
 
 
 class TestKeypath(unittest.TestCase):
@@ -124,3 +125,17 @@ def test_badges_checks_non_empty_events(self, mock_get_badging_event_types):
         mock_get_badging_event_types.return_value = ["event1", "event2"]
         errors = badges_checks()
         self.assertEqual(len(errors), 0)
+
+
+class TestGetEventTypeKeypaths(unittest.TestCase):
+    def setUp(self):
+        self.EVENT_TYPE = "org.openedx.learning.course.passing.status.updated.v1"
+
+    def test_get_event_type_keypaths(self):
+        event_type_keypaths = get_event_type_keypaths(self.EVENT_TYPE)
+        self.assertIsNotNone(event_type_keypaths)
+        self.assertIn("status", event_type_keypaths)
+        self.assertIn("course.display_name", event_type_keypaths)
+
+        for excluded_keypath in settings.BADGES_CONFIG.get("EXCLUDED_KEY_PATHS", []):
+            self.assertNotIn(excluded_keypath, event_type_keypaths)

credentials/apps/badges/utils.py

@@ -123,15 +123,23 @@ def get_data_keypaths(data):
         keypaths = []
         for field in attr.fields(data):
             if attr.has(field.type):
-                keypaths += [f"{field.name}.{keypath}" for keypath in get_data_keypaths(field.type)]
+                keypaths += [
+                    f"{field.name}.{keypath}"
+                    for keypath in get_data_keypaths(field.type)
+                ]
             else:
                 keypaths.append(field.name)
         return keypaths
 
     keypaths = []
     for field in attr.fields(data):
         if attr.has(field.type):
-            keypaths += [f"{field.name}.{keypath}" for keypath in get_data_keypaths(field.type)]
+            keypaths += [
+                f"{field.name}.{keypath}"
+                for keypath in get_data_keypaths(field.type)
+                if f"{field.name}.{keypath}"
+                not in settings.BADGES_CONFIG.get("EXCLUDED_KEY_PATHS", [])
+            ]
         else:
             keypaths.append(field.name)
     return keypaths

credentials/settings/base.py

@@ -609,4 +609,11 @@
         "CREDLY_SANDBOX_API_BASE_URL": "https://sandbox-api.credly.com/v1/",
         "USE_SANDBOX": False,
     },
+    "EXCLUDED_KEY_PATHS": [
+        "user.id",
+        "user.is_active",
+        "user.pii.username",
+        "user.pii.email",
+        "user.pii.name",
+    ]
 }