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

raccoongang · Apr 24, 2024 · ccdc59c · ccdc59c
1 parent 04aeae2
commit ccdc59c
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/credentials/apps/badges/utils.py b/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["EXCLUDED_KEY_PATHS"]
+            ]
         else:
             keypaths.append(field.name)
     return keypaths
diff --git a/credentials/settings/base.py b/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",
+    ]
 }