feat: expose keycloak global_id on the users/me serializer

drf_lint_baseline.json

@@ -4,6 +4,6 @@
   "channels/serializers.py:136:24:ORM002",
   "profiles/serializers.py:136:31:ORM002",
   "profiles/serializers.py:196:16:ORM002",
-  "profiles/serializers.py:418:15:ORM001",
-  "profiles/serializers.py:419:27:ORM001"
+  "profiles/serializers.py:419:15:ORM001",
+  "profiles/serializers.py:420:27:ORM001"
 ]

frontends/api/src/test-utils/factories/user.ts

@@ -33,6 +33,7 @@ const user: PartialFactory<User> = (overrides = {}): User => {
       // @ts-expect-error API Response can include anonymous user
       id: null,
       username: "",
+      global_id: null,
     }
   }
 
@@ -44,6 +45,7 @@ const user: PartialFactory<User> = (overrides = {}): User => {
     is_learning_path_editor: false,
     username: faker.internet.username(),
     is_authenticated: true,
+    global_id: faker.string.uuid(),
     ...overrides,
     profile: profile(overrides?.profile ?? {}),
   }

openapi/specs/v0.yaml

@@ -5731,6 +5731,10 @@ components:
         username:
           type: string
           readOnly: true
+        global_id:
+          type: string
+          readOnly: true
+          nullable: true
         profile:
           $ref: '#/components/schemas/Profile'
         first_name:
@@ -5750,6 +5754,7 @@ components:
           readOnly: true
       required:
       - first_name
+      - global_id
       - id
       - is_article_editor
       - is_authenticated

profiles/serializers.py

@@ -383,6 +383,7 @@ class Meta:
         fields = (
             "id",
             "username",
+            "global_id",
             "profile",
             "email",
             "first_name",
@@ -391,7 +392,7 @@ class Meta:
             "is_learning_path_editor",
             "is_authenticated",
         )
-        read_only_fields = ("id", "username", "is_authenticated")
+        read_only_fields = ("id", "username", "global_id", "is_authenticated")
 
 
 class ProgramCertificateSerializer(serializers.ModelSerializer):

profiles/serializers_test.py

@@ -38,6 +38,7 @@ def test_serialize_user(user):
     assert UserSerializer(user).data == {
         "id": user.id,
         "username": user.username,
+        "global_id": user.global_id,
         "first_name": user.first_name,
         "last_name": user.last_name,
         "is_learning_path_editor": False,
@@ -90,6 +91,7 @@ def test_serialize_create_user(db, mocker):
     assert UserSerializer(instance=user).data == {
         "id": user.id,
         "username": user.username,
+        "global_id": user.global_id,
         "first_name": user.first_name,
         "last_name": user.last_name,
         "is_learning_path_editor": False,

profiles/views_test.py

@@ -39,6 +39,7 @@ def test_list_users(staff_client, staff_user):
         {
             "id": staff_user.id,
             "username": staff_user.username,
+            "global_id": staff_user.global_id,
             "first_name": staff_user.first_name,
             "last_name": staff_user.last_name,
             "is_learning_path_editor": True,
@@ -98,6 +99,7 @@ def test_get_user(staff_client, user):
     assert resp.json() == {
         "id": user.id,
         "username": user.username,
+        "global_id": user.global_id,
         "first_name": user.first_name,
         "last_name": user.last_name,
         "is_article_editor": True,
@@ -188,6 +190,7 @@ def test_patch_user(staff_client, user, email, email_optin, toc_optin):
     assert resp.json() == {
         "id": user.id,
         "username": user.username,
+        "global_id": user.global_id,
         "first_name": user.first_name,
         "last_name": user.last_name,
         "is_learning_path_editor": True,
@@ -390,6 +393,7 @@ def test_get_user_by_me(mocker, client, user, is_anonymous):
         assert resp.json() == {
             "id": None,
             "username": "",
+            "global_id": None,
             "is_learning_path_editor": False,
             "is_article_editor": False,
             "is_authenticated": False,
@@ -398,6 +402,7 @@ def test_get_user_by_me(mocker, client, user, is_anonymous):
         assert resp.json() == {
             "id": user.id,
             "username": user.username,
+            "global_id": user.global_id,
             "first_name": user.first_name,
             "last_name": user.last_name,
             "is_learning_path_editor": False,