models: Use Django native JSONField

[nijel]

Proposed changes

It was introduced in Django 3.1 and social_django already requires Django 3.2.

Fixes #464
Fixes #209

Types of changes

Please check the type of change your PR introduces:

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Code style update (PEP8, lint, formatting, renaming, etc)
• Refactoring (no functional changes, no api changes)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Build related changes (build process, tests runner, etc)
• Other (please describe):

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

• Lint and unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works

Other information

Any other information that is important to this PR such as screenshots of how
the component looks before and after the change.

[codecov]

Codecov Report

Merging #465 (191c1c9) into master (8d0a205) will increase coverage by 0.16%.
The diff coverage is 54.54%.

@@            Coverage Diff             @@
##           master     #465      +/-   ##
==========================================
+ Coverage   93.66%   93.83%   +0.16%     
==========================================
  Files          35       39       +4     
  Lines        1121     1119       -2     
  Branches      130      130              
==========================================
  Hits         1050     1050              
+ Misses         45       44       -1     
+ Partials       26       25       -1     

Flag	Coverage Δ
unittests	93.83% <54.54%> (+0.16%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
social_django/fields.py	30.00% <33.33%> (-13.34%)	⬇️
...ocial_django/migrations/0013_migrate_extra_data.py	33.33% <33.33%> (ø)
...o/migrations/0012_usersocialauth_extra_data_new.py	100.00% <100.00%> (ø)
...igrations/0014_remove_usersocialauth_extra_data.py	100.00% <100.00%> (ø)
...rename_extra_data_new_usersocialauth_extra_data.py	100.00% <100.00%> (ø)
social_django/models.py	100.00% <100.00%> (ø)

[ShaheedHaque]

I have tested the branch. First, I ran the old code and verified that the extra_data was a string:

>>> from social_django.models import UserSocialAuth
>>> UserSocialAuth.objects.all()[0].extra_data
'{"auth_time": 1686390682, "session_index": "_dWXC7z0-o8ffbl8Dm-bPV8B3bxVpeHvp", "name_id": "auth0|62ce80da6379e9972defbebe", "idp_name": "28361fbf-666b-4ae2-b5f1-0366258f78bc", "idp_display_name": "Acme - auth0.com", "idp_logo": "https://login.paiyroll.com/static/images/paiyroll.001.png"}'
>>> type(UserSocialAuth.objects.all()[0].extra_data)
<class 'str'>

I then ran the migrations from this commit, and the extra_data is now, correctly, a dict:

>>> from social_django.models import UserSocialAuth
>>> UserSocialAuth.objects.all()[0].extra_data
{'name_id': 'auth0|62ce80da6379e9972defbebe', 'idp_logo': 'https://login.paiyroll.com/static/images/paiyroll.001.png', 'idp_name': '28361fbf-666b-4ae2-b5f1-0366258f78bc', 'auth_time': 1686390682, 'session_index': '_dWXC7z0-o8ffbl8Dm-bPV8B3bxVpeHvp', 'idp_display_name': 'Acme - auth0.com'}
>>> type(UserSocialAuth.objects.all()[0].extra_data)
<class 'dict'>

Finally, I ran our system test which caught the issue, and it now passes.

So, this change LGTM: thanks!

[rib3]

Would it be possible to cut (and publish) a release with this change?

[parberge]

Couldn't find any information about this in the release, so I'll ask here:

Does this mean we should remove SOCIAL_AUTH_JSONFIELD_ENABLED from settings if we update to 5.3.0?
Also I wonder if https://python-social-auth.readthedocs.io/en/latest/configuration/django.html#json-field-support should be updated as well?

I see 5.2.0 is still the "latest" according to releases here on github. But on pypi it's 5.3.0

[nijel]

Does this mean we should remove SOCIAL_AUTH_JSONFIELD_ENABLED from settings if we update to 5.3.0?

Once you upgrade, it is still used during the migration.

Also I wonder if https://python-social-auth.readthedocs.io/en/latest/configuration/django.html#json-field-support should be updated as well?

Yes it should, contributions are welcome.

I see 5.2.0 is still the "latest" according to releases here on github. But on pypi it's 5.3.0

I forgot to tick “Set as the latest release”, fixed now.