Use feature flag for otp and add indexes

Author: sumit4613

Makefile

@@ -8,6 +8,6 @@ migrate:
 	@echo "Migrating..."
 	python manage.py migrate
 
-create_migration:
+migrations:
 	@echo "Creating migration..."
 	python manage.py makemigrations

TODO.md

@@ -4,3 +4,4 @@
 - 3 Failed attempts and block user for 24 hours.
 - Throttle OTP generation
 - OTP support via third party services
+- Support multiple offers with expiry and use the latest offer to give points

accounts/admin.py

@@ -1,3 +1,19 @@
 from django.contrib import admin
 
+from accounts.models import User, OTPValidation
+
+
 # Register your models here.
+@admin.register(User)
+class UserAdmin(admin.ModelAdmin):
+    list_display = ("username", "email", "is_staff", "is_active", "is_superuser", "created_at")
+    list_filter = ("is_active", "is_superuser")
+    search_fields = ("username",)
+
+
+@admin.register(OTPValidation)
+class OTPValidationAdmin(admin.ModelAdmin):
+    list_display = ("destination", "otp", "valid_until", "is_validated")
+    list_filter = ("is_validated",)
+    search_fields = ("destination",)
+

accounts/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.1.5 on 2023-01-16 09:13
+# Generated by Django 4.1.5 on 2023-01-22 18:13
 
 import django.contrib.auth.models
 from django.db import migrations, models
@@ -16,8 +16,23 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name="OTPValidation",
+            name="User",
             fields=[
+                ("password", models.CharField(max_length=128, verbose_name="password")),
+                (
+                    "last_login",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="last login"
+                    ),
+                ),
+                (
+                    "is_superuser",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Designates that this user has all permissions without explicitly assigning them.",
+                        verbose_name="superuser status",
+                    ),
+                ),
                 (
                     "id",
                     models.UUIDField(
@@ -30,57 +45,28 @@ class Migration(migrations.Migration):
                 ("created_at", models.DateTimeField(auto_now_add=True, db_index=True)),
                 ("modified_at", models.DateTimeField(auto_now=True)),
                 (
-                    "otp",
-                    models.CharField(blank=True, max_length=6, null=True, verbose_name="OTP"),
-                ),
-                (
-                    "valid_until",
-                    models.DateTimeField(
-                        default=django.utils.timezone.now,
-                        help_text="The timestamp of the moment of expiry of the saved token.",
-                    ),
-                ),
-                (
-                    "destination",
+                    "username",
                     models.CharField(
-                        db_index=True,
-                        max_length=10,
-                        unique=True,
-                        verbose_name="OTP Generated For",
+                        max_length=10, unique=True, verbose_name="Mobile Number"
                     ),
                 ),
-                ("is_validated", models.BooleanField(default=False)),
-                (
-                    "validate_attempt",
-                    models.IntegerField(default=3, verbose_name="Attempted Validation"),
-                ),
-                (
-                    "otp_reactive_at",
-                    models.DateTimeField(blank=True, null=True, verbose_name="OTP Reactive At"),
-                ),
-                ("extra_data", models.JSONField(blank=True, null=True)),
+                ("email", models.EmailField(blank=True, max_length=255, null=True)),
+                ("name", models.CharField(blank=True, max_length=255, null=True)),
+                ("is_active", models.BooleanField(default=True)),
+                ("is_staff", models.BooleanField(default=False)),
             ],
             options={
-                "ordering": ["-created_at"],
-                "abstract": False,
+                "verbose_name": "User",
+                "verbose_name_plural": "Users",
+                "ordering": ("-created_at",),
             },
+            managers=[
+                ("objects", django.contrib.auth.models.UserManager()),
+            ],
         ),
         migrations.CreateModel(
-            name="User",
+            name="OTPValidation",
             fields=[
-                ("password", models.CharField(max_length=128, verbose_name="password")),
-                (
-                    "last_login",
-                    models.DateTimeField(blank=True, null=True, verbose_name="last login"),
-                ),
-                (
-                    "is_superuser",
-                    models.BooleanField(
-                        default=False,
-                        help_text="Designates that this user has all permissions without explicitly assigning them.",
-                        verbose_name="superuser status",
-                    ),
-                ),
                 (
                     "id",
                     models.UUIDField(
@@ -93,42 +79,77 @@ class Migration(migrations.Migration):
                 ("created_at", models.DateTimeField(auto_now_add=True, db_index=True)),
                 ("modified_at", models.DateTimeField(auto_now=True)),
                 (
-                    "username",
-                    models.CharField(max_length=10, unique=True, verbose_name="Mobile Number"),
+                    "otp",
+                    models.CharField(
+                        blank=True, max_length=6, null=True, verbose_name="OTP"
+                    ),
+                ),
+                (
+                    "valid_until",
+                    models.DateTimeField(
+                        default=django.utils.timezone.now,
+                        help_text="The timestamp of the moment of expiry of the saved token.",
+                    ),
                 ),
-                ("email", models.EmailField(blank=True, max_length=255, null=True)),
-                ("name", models.CharField(blank=True, max_length=255, null=True)),
-                ("is_active", models.BooleanField(default=True)),
-                ("is_staff", models.BooleanField(default=False)),
                 (
-                    "groups",
-                    models.ManyToManyField(
-                        blank=True,
-                        help_text="The groups this user belongs to. A user will get all permissions granted to each of their groups.",
-                        related_name="user_set",
-                        related_query_name="user",
-                        to="auth.group",
-                        verbose_name="groups",
+                    "destination",
+                    models.CharField(
+                        max_length=10, unique=True, verbose_name="OTP Generated For"
                     ),
                 ),
+                ("is_validated", models.BooleanField(default=False)),
+                (
+                    "validate_attempt",
+                    models.IntegerField(default=3, verbose_name="Attempted Validation"),
+                ),
                 (
-                    "user_permissions",
-                    models.ManyToManyField(
-                        blank=True,
-                        help_text="Specific permissions for this user.",
-                        related_name="user_set",
-                        related_query_name="user",
-                        to="auth.permission",
-                        verbose_name="user permissions",
+                    "otp_reactive_at",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="OTP Reactive At"
                     ),
                 ),
+                ("extra_data", models.JSONField(blank=True, null=True)),
             ],
             options={
-                "verbose_name": "User",
-                "verbose_name_plural": "Users",
+                "verbose_name": "OTP Validation",
+                "verbose_name_plural": "OTP Validations",
+                "ordering": ["-created_at"],
             },
-            managers=[
-                ("objects", django.contrib.auth.models.UserManager()),
-            ],
+        ),
+        migrations.AddIndex(
+            model_name="otpvalidation",
+            index=models.Index(
+                fields=["destination"], name="accounts_ot_destina_e42df1_idx"
+            ),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="groups",
+            field=models.ManyToManyField(
+                blank=True,
+                help_text="The groups this user belongs to. A user will get all permissions granted to each of their groups.",
+                related_name="user_set",
+                related_query_name="user",
+                to="auth.group",
+                verbose_name="groups",
+            ),
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="user_permissions",
+            field=models.ManyToManyField(
+                blank=True,
+                help_text="Specific permissions for this user.",
+                related_name="user_set",
+                related_query_name="user",
+                to="auth.permission",
+                verbose_name="user permissions",
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="user",
+            index=models.Index(
+                fields=["username"], name="accounts_us_usernam_c0ea66_idx"
+            ),
         ),
     ]

accounts/models.py

@@ -40,6 +40,8 @@ def save(self, *args, **kwargs):
     class Meta:
         verbose_name = _("User")
         verbose_name_plural = _("Users")
+        ordering = ("-created_at",)
+        indexes = [models.Index(fields=["username"])]
 
 
 class OTPValidation(TimeStampedModel):
@@ -52,7 +54,6 @@ class OTPValidation(TimeStampedModel):
     destination = models.CharField(
         verbose_name=_("OTP Generated For"),
         max_length=10,
-        db_index=True,
         unique=True,
     )
     is_validated = models.BooleanField(default=False)
@@ -64,6 +65,12 @@ class OTPValidation(TimeStampedModel):
     def __str__(self):
         return self.destination
 
+    class Meta:
+        ordering = ["-created_at"]
+        verbose_name = _("OTP Validation")
+        verbose_name_plural = _("OTP Validations")
+        indexes = [models.Index(fields=["destination"])]
+
     def generate_otp(self, length=6, valid_secs=600) -> None:
         """
         Generates a token of the specified length, then sets it on the model

core/constants.py

@@ -0,0 +1,8 @@
+class RequestType:
+    """Request types for the API."""
+
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    DELETE = "DELETE"

core/flags.py

@@ -0,0 +1,14 @@
+from flags.state import flag_enabled
+
+
+class FlagSources:
+    ENABLE_OTP: str = "ENABLE_OTP"
+
+    @classmethod
+    def otp_enabled(cls) -> bool:
+        return flag_enabled(cls.ENABLE_OTP)
+
+    def get_flags(self, sources=None):
+        return {
+            self.ENABLE_OTP: [],
+        }

requirements.txt

@@ -8,4 +8,6 @@ djangorestframework==3.14.0
 pytailwindcss==0.1.4
 requests==2.28.1
 pre-commit==2.21.0
-django-environ==0.9.0
+django-environ==0.9.0
+django-flags==5.0.12
+sentry-sdk==1.13.0

rewardme/settings.py

@@ -62,6 +62,7 @@
     "rest_framework",
     "django_extensions",
     "simple_history",
+    "flags",
 ]
 
 
@@ -144,7 +145,7 @@
 
 LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = "UTC"
+TIME_ZONE = "Asia/Kolkata"
 
 USE_I18N = True
 
@@ -175,3 +176,23 @@
 # Simple History
 SIMPLE_HISTORY_HISTORY_ID_USE_UUID = True
 SIMPLE_HISTORY_HISTORY_CHANGE_REASON_USE_TEXT_FIELD = True
+
+# Flags
+FLAG_SOURCES = (
+    "core.flags.FlagSources",
+    "flags.sources.SettingsFlagsSource",
+    "flags.sources.DatabaseFlagsSource",
+)
+
+# Sentry
+if USE_SENTRY := env.bool('USE_SENTRY', default=False):
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+
+    sentry_sdk.init(
+        dsn=env('SENTRY_DSN'),
+        integrations=[DjangoIntegration()],
+        traces_sample_rate=env.float('SENTRY_TRACES_SAMPLE_RATE', default=0.1),
+        send_default_pii=True,
+        release=env('SENTRY_RELEASE'),
+    )

sample.env

@@ -7,4 +7,8 @@ USE_SQLITE=True
 DB_NAME=
 DB_USER=
 DB_PASSWORD=
-DB_HOST=
+DB_HOST=
+USE_SENTRY=
+SENTRY_DSN=
+SENTRY_SAMPLE_RATE=
+SENTRY_RELEASE