pennersr / django-allauth / 5967431319

96%

push

github

fix(providers): Avoid loading Django user models before apps are ready

To register a custom Provider, users subclass
`allauth.socialaccount.providers.base.ProviderAccount`. Their subclass
is then registered using
`allauth.socialaccount.providers.registry.register(MyProvider)`.

The registration must happen before the `allauth.socialaccount` app
models are ready, as the `SocialApp.provider` choices come from the
registry. Otherwise, a Django migration is created because at the time
of the import of `allauth.socialaccount.models`, the registry was empty,
but when the models are ready (and Django can check migrations) the
registry contains the custom provider.

Below is an example stack trace to illustrate the issue:
```
  File "/home/freitafr/dev/itou/itou/allauth_adapters/peamu/provider.py", line 1, in <module>
    from allauth.socialaccount.providers.base import ProviderAccount
  File "/home/freitafr/dev/django-allauth/allauth/socialaccount/providers/base/__init__.py", line 2, in <module>
    from .provider import Provider, ProviderAccount, ProviderException  # noqa
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/freitafr/dev/django-allauth/allauth/socialaccount/providers/base/provider.py", line 3, in <module>
    from allauth.account.models import EmailAddress
  File "/home/freitafr/dev/django-allauth/allauth/account/models.py", line 12, in <module>
    from .adapter import get_adapter
  File "/home/freitafr/dev/django-allauth/allauth/account/adapter.py", line 16, in <module>
    from django.contrib.auth.models import AbstractUser
  File "/home/freitafr/dev/itou/.venv/lib/python3.11/site-packages/django/contrib/auth/models.py", line 3, in <module>
    from django.contrib.auth.base_user import AbstractBaseUser, BaseUserManager
  File "/home/freitafr/dev/itou/.venv/lib/python3.11/site-packages/django/contrib/auth/base_user.py", line 57, in <module>
    class AbstractBaseUser(models.Model):
  File "/home/freitafr/de... (continued)

2 of 2 new or added lines in 1 file covered. (100.0%)

12909 of 14137 relevant lines covered (91.31%)

18.23 hits per line