refactor(socialaccount): Uniform SocialAccount.to_str()

Squashed commit of the following:

commit b23a8a7
Author: David D Lowe <[email protected]>
Date:   Fri Jul 19 14:24:06 2024 +0100

    fix(socialaccount): Make base to_str method look at more keys

commit 90c8b48
Author: David D Lowe <[email protected]>
Date:   Fri Jul 19 14:11:56 2024 +0100

    fix(socialaccount): make QuickBooks' to_str ignore emailVerified

commit 7651401
Author: David D Lowe <[email protected]>
Date:   Fri Jul 19 14:02:58 2024 +0100

    fix(socialaccount): Make base to_str more resilient

    It can now handle extra_data values that are not dictionaries without
    throwing an exception, and it only returns an `email`, `username` and
    `name` value if it is a string.

commit 34576ba
Author: David D Lowe <[email protected]>
Date:   Fri Jul 19 13:56:23 2024 +0100

    fix(socialaccount): Fully store extra_data of Edmodo account

commit c71090d
Author: David D Lowe <[email protected]>
Date:   Fri Jul 19 13:55:12 2024 +0100

    fix(socialaccount): Fully store extra_data of Amazon Cognito account

commit 3fdca2e
Author: David D Lowe <[email protected]>
Date:   Tue Jul 16 14:25:16 2024 +0100

    fix(socialaccount): Ensure AppleAccount's to_str handles private email

commit 0ea8b75
Author: David D Lowe <[email protected]>
Date:   Tue Jul 16 14:15:43 2024 +0100

    fix: Use f-string

commit 6e449db
Author: David D Lowe <[email protected]>
Date:   Tue Jul 16 14:04:02 2024 +0100

    fix(socialaccount): Delete superflous to_str method implementations

    These classes are all subclasses of ProviderAccount, which provides a
    default to_str implementation. If the subclass's to_str implementation
    does not differ enough from the to_str method of its parent class, then
    delete it.

commit 5b58d17
Author: David D Lowe <[email protected]>
Date:   Wed Jul 3 16:04:50 2024 +0100

    fix(socialaccount): make to_str return unique ID

    The view allauth.socialaccount.views.connections displays a list of
    social accounts to the user. Instead of using the display name of a
    social account, which may not be unique, use the unique username or
    email address instead. That way, accounts with identical display names
    can be distinguished from each other.

    Fixes #3906

commit bc78638
Author: David D Lowe <[email protected]>
Date:   Tue Jul 2 06:27:36 2024 +0100

    fix(socialaccount): store email and name in extra_data

    All providers should store email, first name and last name in the
    SocialAccount's extra_data field, if possible. It is not enough to store
    this information in the User instance, as there may be multiple social
    accounts associated with that user, with differing email addresses,
    first names and last names.

    Most providers already implemented this functionality. This commit fixes
    AmazonCognito, Edmodo and MediaWiki.

Author: pennersr

AUTHORS

@@ -48,6 +48,7 @@ Daniel Eriksson
 Daniel Widerin
 David Ascher
 David Cain
+David D. Lowe
 David Evans
 David Friedman
 David Hummel

ChangeLog.rst

@@ -23,6 +23,16 @@ Note worthy changes
 - Headless: You can now alter the user data payload by overriding the newly
   introduced ``serialize_user()`` adapter method.
 
+- Ensured that email address, given name and family name fields are stored in
+  the SocialAccount instance. This information was not previously saved in
+  Amazon Cognito, Edmodo, and MediaWiki SocialAccount instances.
+
+- When multiple third-party accounts of the same provider were connected, the
+  third-party account connections overview did not always provide a clear
+  recognizable distinction between those accounts. Now, the
+  ``SocialAccount.__str__()`` has been altered to return the unique username or
+  email address, rather than a non-unique display name.
+
 
 Backwards incompatible changes
 ------------------------------

allauth/socialaccount/providers/agave/provider.py

@@ -10,10 +10,6 @@ def get_profile_url(self):
     def get_avatar_url(self):
         return self.account.extra_data.get("avatar_url", "dflt")
 
-    def to_str(self):
-        dflt = super(AgaveAccount, self).to_str()
-        return self.account.extra_data.get("name", dflt)
-
 
 class AgaveProvider(OAuth2Provider):
     id = "agave"

allauth/socialaccount/providers/agave/tests.py

@@ -29,3 +29,6 @@ def get_mocked_response(self):
         }
         """,
         )
+
+    def get_expected_to_str(self):
+        return "jdoe"

allauth/socialaccount/providers/amazon/provider.py

@@ -4,8 +4,7 @@
 
 
 class AmazonAccount(ProviderAccount):
-    def to_str(self):
-        return self.account.extra_data.get("name", super(AmazonAccount, self).to_str())
+    pass
 
 
 class AmazonProvider(OAuth2Provider):

allauth/socialaccount/providers/amazon/tests.py

@@ -19,3 +19,6 @@ def get_mocked_response(self):
                     }
         }""",
         )
+
+    def get_expected_to_str(self):
+        return "[email protected]"

allauth/socialaccount/providers/amazon_cognito/provider.py

@@ -10,11 +10,6 @@
 
 
 class AmazonCognitoAccount(ProviderAccount):
-    def to_str(self):
-        dflt = super(AmazonCognitoAccount, self).to_str()
-
-        return self.account.extra_data.get("username", dflt)
-
     def get_avatar_url(self):
         return self.account.extra_data.get("picture")
 
@@ -54,23 +49,15 @@ def extract_email_addresses(self, data):
         )
 
     def extract_extra_data(self, data):
-        return {
-            "address": data.get("address"),
-            "birthdate": data.get("birthdate"),
-            "gender": data.get("gender"),
-            "locale": data.get("locale"),
-            "middlename": data.get("middlename"),
-            "nickname": data.get("nickname"),
-            "phone_number": data.get("phone_number"),
-            "phone_number_verified": convert_to_python_bool_if_value_is_json_string_bool(
-                data.get("phone_number_verified")
-            ),
-            "picture": data.get("picture"),
-            "preferred_username": data.get("preferred_username"),
-            "profile": data.get("profile"),
-            "website": data.get("website"),
-            "zoneinfo": data.get("zoneinfo"),
-        }
+        ret = dict(data)
+        phone_number_verified = data.get("phone_number_verified")
+        if phone_number_verified is not None:
+            ret["phone_number_verified"] = (
+                convert_to_python_bool_if_value_is_json_string_bool(
+                    "phone_number_verified"
+                )
+            )
+        return ret
 
     @classmethod
     def get_slug(cls):

allauth/socialaccount/providers/amazon_cognito/tests.py

@@ -39,9 +39,11 @@ class AmazonCognitoTestCase(OAuth2TestsMixin, TestCase):
 
     def get_mocked_response(self):
         mocked_payload = json.dumps(_get_mocked_claims())
-
         return MockedResponse(status_code=200, content=mocked_payload)
 
+    def get_expected_to_str(self):
+        return "johndoe"
+
     @override_settings(SOCIALACCOUNT_PROVIDERS={"amazon_cognito": {}})
     def test_oauth2_adapter_raises_if_domain_settings_is_missing(
         self,

allauth/socialaccount/providers/angellist/provider.py

@@ -12,10 +12,6 @@ def get_profile_url(self):
     def get_avatar_url(self):
         return self.account.extra_data.get("image")
 
-    def to_str(self):
-        dflt = super(AngelListAccount, self).to_str()
-        return self.account.extra_data.get("name", dflt)
-
 
 class AngelListProvider(OAuth2Provider):
     id = "angellist"

allauth/socialaccount/providers/angellist/tests.py

@@ -23,3 +23,6 @@ def get_mocked_response(self):
 "email"]}
 """,
         )
+
+    def get_expected_to_str(self):
+        return "[email protected]"

allauth/socialaccount/providers/apple/provider.py

@@ -9,10 +9,26 @@
 from allauth.socialaccount.providers.oauth2.provider import OAuth2Provider
 
 
+class AppleAccount(ProviderAccount):
+    def to_str(self):
+        email = self.account.extra_data.get("email")
+        if email and not email.lower().endswith("@privaterelay.appleid.com"):
+            return email
+
+        name = self.account.extra_data.get("name") or {}
+        if name.get("firstName") or name.get("lastName"):
+            full_name = f"{name['firstName'] or ''} {name['lastName'] or ''}"
+            full_name = full_name.strip()
+            if full_name:
+                return full_name
+
+        return super().to_str()
+
+
 class AppleProvider(OAuth2Provider):
     id = "apple"
     name = "Apple"
-    account_class = ProviderAccount
+    account_class = AppleAccount
     oauth2_adapter_class = AppleOAuth2Adapter
     supports_token_authentication = True
 

allauth/socialaccount/providers/apple/tests.py

@@ -170,6 +170,9 @@ def get_mocked_response(self):
             200, KEY_SERVER_RESP_JSON, {"content-type": "application/json"}
         )
 
+    def get_expected_to_str(self):
+        return "A B"
+
     def get_complete_parameters(self, auth_request_params):
         """
         Add apple specific response parameters which they include in the

allauth/socialaccount/providers/asana/tests.py

@@ -15,3 +15,6 @@ def get_mocked_response(self):
 {"id": 3133777, "name": "Personal Projects"}], "email": "[email protected]",
 "name": "Test Name", "id": 43748387}}""",
         )
+
+    def get_expected_to_str(self):
+        return "[email protected]"

allauth/socialaccount/providers/atlassian/provider.py

@@ -8,10 +8,6 @@ class AtlassianAccount(ProviderAccount):
     def get_profile_url(self):
         return self.account.extra_data.get("picture")
 
-    def to_str(self):
-        dflt = super().to_str()
-        return self.account.extra_data.get("name", dflt)
-
 
 class AtlassianProvider(OAuth2Provider):
     id = "atlassian"

allauth/socialaccount/providers/atlassian/tests.py

@@ -28,3 +28,6 @@ def get_mocked_response(self):
             }
         }"""
         return MockedResponse(200, response_data)
+
+    def get_expected_to_str(self):
+        return "[email protected]"

allauth/socialaccount/providers/auth0/provider.py

@@ -7,10 +7,6 @@ class Auth0Account(ProviderAccount):
     def get_avatar_url(self):
         return self.account.extra_data.get("picture")
 
-    def to_str(self):
-        dflt = super(Auth0Account, self).to_str()
-        return self.account.extra_data.get("name", dflt)
-
 
 class Auth0Provider(OAuth2Provider):
     id = "auth0"

allauth/socialaccount/providers/auth0/tests.py

@@ -20,3 +20,6 @@ def get_mocked_response(self):
             }
         """,
         )
+
+    def get_expected_to_str(self):
+        return "[email protected]"

allauth/socialaccount/providers/authentiq/provider.py

@@ -50,10 +50,6 @@ def get_profile_url(self):
     def get_avatar_url(self):
         return self.account.extra_data.get("picture")
 
-    def to_str(self):
-        dflt = super(AuthentiqAccount, self).to_str()
-        return self.account.extra_data.get("name", dflt)
-
 
 class AuthentiqProvider(OAuth2Provider):
     id = "authentiq"

allauth/socialaccount/providers/authentiq/tests.py

@@ -27,6 +27,9 @@ def get_mocked_response(self):
             ),
         )
 
+    def get_expected_to_str(self):
+        return "[email protected]"
+
     @override_settings(
         SOCIALACCOUNT_QUERY_EMAIL=False,
     )

allauth/socialaccount/providers/baidu/tests.py

@@ -14,3 +14,6 @@ def get_mocked_response(self):
 {"portrait": "78c0e9839de59bbde7859ccf43",
 "uname": "\u90dd\u56fd\u715c", "uid": "3225892368"}""",
         )
+
+    def get_expected_to_str(self):
+        return "\u90dd\u56fd\u715c"

allauth/socialaccount/providers/base/provider.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Dict, Optional
 
 from django.core.exceptions import ImproperlyConfigured, PermissionDenied
 
@@ -144,7 +144,8 @@ def extract_uid(self, data):
     def extract_extra_data(self, data):
         """
         Extracts fields from `data` that will be stored in
-        `SocialAccount`'s `extra_data` JSONField.
+        `SocialAccount`'s `extra_data` JSONField, such as email address, first
+        name, last name, and phone number.
 
         :return: any JSON-serializable Python structure.
         """
@@ -249,9 +250,31 @@ def get_brand(self):
     def __str__(self):
         return self.to_str()
 
+    def get_user_data(self) -> Optional[Dict]:
+        """Typically, the ``extra_data`` directly contains user related keys.
+        For some providers, however, they are nested below a different key. In
+        that case, you can override this method so that the base ``__str__()``
+        will still be able to find the data.
+        """
+        ret = self.account.extra_data
+        if not isinstance(ret, dict):
+            ret = None
+        return ret
+
     def to_str(self):
         """
-        This did not use to work in the past due to py2 compatibility:
+        Returns string representation of this social account. This is the
+        unique identifier of the account, such as its username or its email
+        address. It should be meaningful to human beings, which means a numeric
+        ID number is rarely the appropriate representation here.
+
+        Subclasses are meant to override this method.
+
+        Users will see the string representation of their social accounts in
+        the page rendered by the allauth.socialaccount.views.connections view.
+
+        The following code did not use to work in the past due to py2
+        compatibility:
 
             class GoogleAccount(ProviderAccount):
                 def __str__(self):
@@ -261,4 +284,70 @@ def __str__(self):
         So we have this method `to_str` that can be overridden in a conventional
         fashion, without having to worry about it.
         """
+        user_data = self.get_user_data()
+        if user_data:
+            combi_values = {}
+            tbl = [
+                # Prefer username -- it's the most human recognizable & unique.
+                (
+                    None,
+                    [
+                        "username",
+                        "userName",
+                        "user_name",
+                        "login",
+                        "handle",
+                    ],
+                ),
+                # Second best is email
+                (None, ["email", "Email", "mail", "email_address"]),
+                (
+                    None,
+                    [
+                        "name",
+                        "display_name",
+                        "displayName",
+                        "Display_Name",
+                        "nickname",
+                    ],
+                ),
+                # Use the full name
+                (None, ["full_name", "fullName"]),
+                # Alternatively, try to assemble a full name ourselves.
+                (
+                    "first_name",
+                    [
+                        "first_name",
+                        "firstname",
+                        "firstName",
+                        "First_Name",
+                        "given_name",
+                        "givenName",
+                    ],
+                ),
+                (
+                    "last_name",
+                    [
+                        "last_name",
+                        "lastname",
+                        "lastName",
+                        "Last_Name",
+                        "family_name",
+                        "familyName",
+                        "surname",
+                    ],
+                ),
+            ]
+            for store_as, variants in tbl:
+                for key in variants:
+                    value = user_data.get(key)
+                    if isinstance(value, str):
+                        value = value.strip()
+                        if value and not store_as:
+                            return value
+                        combi_values[store_as] = value
+            first_name = combi_values.get("first_name") or ""
+            last_name = combi_values.get("last_name") or ""
+            if first_name or last_name:
+                return f"{first_name} {last_name}".strip()
         return self.get_brand()["name"]

allauth/socialaccount/providers/basecamp/provider.py

@@ -9,9 +9,8 @@ class BasecampAccount(ProviderAccount):
     def get_avatar_url(self):
         return None
 
-    def to_str(self):
-        dflt = super(BasecampAccount, self).to_str()
-        return self.account.extra_data.get("name", dflt)
+    def get_user_data(self):
+        return self.account.extra_data.get("identity", {})
 
 
 class BasecampProvider(OAuth2Provider):

allauth/socialaccount/providers/basecamp/tests.py

@@ -41,3 +41,6 @@ def get_mocked_response(self):
             ]
         }""",
         )
+
+    def get_expected_to_str(self):
+        return "[email protected]"

allauth/socialaccount/providers/battlenet/tests.py

@@ -18,6 +18,9 @@ def get_mocked_response(self):
         data = {"battletag": self._battletag, "id": self._uid}
         return MockedResponse(200, json.dumps(data))
 
+    def get_expected_to_str(self):
+        return self._battletag
+
     def test_valid_response_no_battletag(self):
         data = {"id": 12345}
         response = MockedResponse(200, json.dumps(data))