Added support for Django user without UUID field as user.id

Author: oscarychen

README.md

@@ -28,6 +28,12 @@ urlpatterns = [
 
 In Django settings, include the following:
 ```python
+
+INSTALLED_APPS = [
+    ...,
+    'rest_framework_microservice',
+]
+
 REST_FRAMEWORK = {
     'DEFAULT_AUTHENTICATION_CLASSES': (
         'rest_framework_simplejwt.authentication.JWTTokenUserAuthentication',
@@ -122,6 +128,7 @@ REST_FRAMEWORK_MICROSERVICE = {
     "CUSTOM_TOKEN_CALLABLE_ATTRIBUTES": [],
     "COOKIE_SALT": "extra",
     "USER_SERIALIZER_CLASS": None,
+    "USER_MODEL_UUID_FIELD": None,
 }
 ```
 
@@ -170,6 +177,11 @@ Salt to be used when signing cookie.
 Defaults to None. If specified, the default view serializers will try to add a user object representing the user.
 The content of the user object is defined by ``USER_SERIALIZER_CLASS``.
 
+``USER_MODEL_UUID_FIELD``
+-------------------------
+Defaults to None. Used to specify a field on the Django user model that can be used to store UUID from IDP.
+
+
 Customizing token claims
 ========================
 

make_package_migrations.py

@@ -14,12 +14,13 @@
     INSTALLED_APPS=(
         'django.contrib.contenttypes',
         'django.contrib.auth',
-        'django_microservice',
+        'rest_framework_microservice',
     ),
+    SECRET_KEY="NA"
 )
 
 django.setup()
-call_command('makemigrations', )
+call_command('makemigrations', 'rest_framework_microservice')
 
 print('''
 Finished generating migrations.

rest_framework_microservice/apps.py

@@ -2,4 +2,5 @@
 
 
 class RestFrameworkMicroserviceConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
     name = 'rest_framework_microservice'

rest_framework_microservice/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.0.3 on 2022-04-04 00:00
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Idp',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('uuid', models.UUIDField()),
+                ('user', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='idp', to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+        migrations.AddIndex(
+            model_name='idp',
+            index=models.Index(fields=['uuid'], name='rest_framew_uuid_a01bb5_idx'),
+        ),
+    ]

rest_framework_microservice/migrations/__init__.py

@@ -1,4 +1,7 @@
 from rest_framework_simplejwt.models import TokenUser
+from django.db import models
+from django.contrib.auth import get_user_model
+
 
 class CustomTokenUser(TokenUser):
     """
@@ -9,4 +12,12 @@ class CustomTokenUser(TokenUser):
     # TODO: No longer needed in newer version of djangorestframework-simplejwt
     # See: https://github.com/jazzband/djangorestframework-simplejwt/pull/528
     def __getattr__(self, attr_name):
-        return self.token.get(attr_name, None)
+        return self.token.get(attr_name, None)
+
+
+class Idp(models.Model):
+    user = models.OneToOneField(get_user_model(), on_delete=models.CASCADE, related_name="idp")
+    uuid = models.UUIDField()
+
+    class Meta:
+        indexes = [models.Index(fields=['uuid'])]

rest_framework_microservice/models.py

@@ -15,7 +15,7 @@
 from django.core.exceptions import ObjectDoesNotExist
 from rest_framework.response import Response
 from .social_auth.aws_cognito import decode_token
-
+from .models import Idp
 
 def add_custom_token_claims(token, user):
     """Append custom token claims specified using settings."""
@@ -145,15 +145,19 @@ def validate(self, attrs):
         if id_token.get('email_verified') is False:
             raise APIException("Email not verified.")
 
+        user_defaults = {
+            "username": id_token["cognito:username"],
+            "first_name": id_token.get("given_name"),
+            "last_name": id_token.get("family_name"),
+        }
+
+        if rest_microservice_settings.USER_MODEL_UUID_FIELD is not None:
+            user_defaults[rest_microservice_settings.USER_MODEL_UUID_FIELD] = id_token['sub']
+
+        user, created = get_user_model().objects.get_or_create(email=id_token["email"], defaults=user_defaults)
 
-        user, created = get_user_model().objects.get_or_create(
-            email=id_token["email"],
-            defaults={
-                "id": id_token['sub'],
-                "username": id_token["cognito:username"],
-                "first_name": id_token.get("given_name"),
-                "last_name": id_token.get("family_name"),
-            })
+        if rest_microservice_settings.USER_MODEL_UUID_FIELD is None:
+            Idp.objects.update_or_create(user=user, defaults={"uuid": id_token['sub']})
 
         refresh = self.get_token(user)
         data = {

rest_framework_microservice/serializers.py

@@ -17,6 +17,7 @@
     "CUSTOM_TOKEN_CALLABLE_ATTRIBUTES": [],
     "COOKIE_SALT": "extra",
     "USER_SERIALIZER_CLASS": None,
+    "USER_MODEL_UUID_FIELD": None,
 }
 
 IMPORT_STRINGS = [

rest_framework_microservice/settings.py

@@ -1,6 +1,6 @@
 [metadata]
 name = django-rest-microservice
-version = 1.0.3
+version = 1.1
 description = Facilitating microservice architecture in Django REST framework
 long_description = file: README.md
 url = https://github.com/oscarychen/django-rest-microservice