chore(member merge): create temporary verification code model (#94382)

Create a model for storing the verification codes used during the manual
merge process (for users who have multiple accounts with the same email
address). We will delete this model after the work to enforce unique
primary email addresses is completed.

Author: mifu67

migrations_lockfile.txt

@@ -25,7 +25,7 @@ preprod: 0010_actual_drop_preprod_artifact_analysis_file_id_col
 
 replays: 0006_add_bulk_delete_job
 
-sentry: 0940_auditlog_json_field
+sentry: 0941_create_temporary_verification_code_table
 
 social_auth: 0003_social_auth_json_field
 

src/sentry/migrations/0941_create_temporary_verification_code_table.py

@@ -0,0 +1,70 @@
+# Generated by Django 5.2.1 on 2025-07-01 20:14
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+import sentry.db.models.fields.bounded
+import sentry.db.models.fields.foreignkey
+import sentry.users.models.user_merge_verification_code
+from sentry.new_migrations.migrations import CheckedMigration
+
+
+class Migration(CheckedMigration):
+    # This flag is used to mark that a migration shouldn't be automatically run in production.
+    # This should only be used for operations where it's safe to run the migration after your
+    # code has deployed. So this should not be used for most operations that alter the schema
+    # of a table.
+    # Here are some things that make sense to mark as post deployment:
+    # - Large data migrations. Typically we want these to be run manually so that they can be
+    #   monitored and not block the deploy for a long period of time while they run.
+    # - Adding indexes to large tables. Since this can take a long time, we'd generally prefer to
+    #   run this outside deployments so that we don't block them. Note that while adding an index
+    #   is a schema change, it's completely safe to run the operation after the code has deployed.
+    # Once deployed, run these manually via: https://develop.sentry.dev/database-migrations/#migration-deployment
+
+    is_post_deployment = False
+
+    dependencies = [
+        ("sentry", "0940_auditlog_json_field"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="UserMergeVerificationCode",
+            fields=[
+                (
+                    "id",
+                    sentry.db.models.fields.bounded.BoundedBigAutoField(
+                        primary_key=True, serialize=False
+                    ),
+                ),
+                ("date_updated", models.DateTimeField(auto_now=True)),
+                ("date_added", models.DateTimeField(auto_now_add=True)),
+                (
+                    "token",
+                    models.CharField(
+                        default=sentry.users.models.user_merge_verification_code.generate_token,
+                        max_length=64,
+                    ),
+                ),
+                (
+                    "expires_at",
+                    models.DateTimeField(
+                        default=sentry.users.models.user_merge_verification_code.generate_expires_at
+                    ),
+                ),
+                (
+                    "user",
+                    sentry.db.models.fields.foreignkey.FlexibleForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                        unique=True,
+                    ),
+                ),
+            ],
+            options={
+                "db_table": "sentry_user_verification_codes_temp",
+            },
+        ),
+    ]

src/sentry/users/models/__init__.py

@@ -3,6 +3,7 @@
 from sentry.users.models.identity import Identity
 from sentry.users.models.lostpasswordhash import LostPasswordHash
 from sentry.users.models.user import User
+from sentry.users.models.user_merge_verification_code import UserMergeVerificationCode
 from sentry.users.models.useremail import UserEmail
 from sentry.users.models.userip import UserIP
 from sentry.users.models.userpermission import UserPermission
@@ -16,6 +17,7 @@
     "User",
     "UserEmail",
     "UserIP",
+    "UserMergeVerificationCode",
     "UserPermission",
     "UserRole",
 )

src/sentry/users/models/user_merge_verification_code.py

@@ -0,0 +1,58 @@
+import secrets
+from datetime import datetime, timedelta
+
+from django.conf import settings
+from django.db import models
+from django.utils import timezone
+
+from sentry.backup.scopes import RelocationScope
+from sentry.db.models import FlexibleForeignKey, control_silo_model, sane_repr
+from sentry.db.models.base import DefaultFieldsModel
+from sentry.users.models.user import User
+from sentry.users.services.user.model import RpcUser
+
+TOKEN_MINUTES_VALID = 30
+
+
+def generate_token() -> str:
+    return secrets.token_hex(nbytes=32)
+
+
+def generate_expires_at() -> datetime:
+    return timezone.now() + timedelta(minutes=TOKEN_MINUTES_VALID)
+
+
+@control_silo_model
+class UserMergeVerificationCode(DefaultFieldsModel):
+    """
+    A temporary model used to store verification codes for users who are manually
+    merging their accounts with the same primary email address. We will remove this
+    table after the work around merging users with the same primary email is complete.
+    """
+
+    __relocation_scope__ = RelocationScope.Excluded
+
+    user = FlexibleForeignKey(settings.AUTH_USER_MODEL, unique=True)
+    token = models.CharField(max_length=64, default=generate_token)
+    expires_at = models.DateTimeField(default=generate_expires_at)
+
+    class Meta:
+        app_label = "sentry"
+        db_table = "sentry_user_verification_codes_temp"
+
+    __repr__ = sane_repr("user_id", "token")
+
+    def regenerate_token(self) -> None:
+        self.token = generate_token()
+        self.refresh_expires_at()
+
+    def refresh_expires_at(self) -> None:
+        now = timezone.now()
+        self.expires_at = now + timedelta(minutes=TOKEN_MINUTES_VALID)
+
+    def is_valid(self) -> bool:
+        return timezone.now() < self.expires_at
+
+    @classmethod
+    def send_email(cls, user: User | RpcUser, token: str) -> None:
+        pass

tests/sentry/users/models/test_user_merge_verification_code.py

@@ -0,0 +1,32 @@
+from datetime import UTC, datetime, timedelta
+
+from sentry.testutils.cases import TestCase
+from sentry.testutils.helpers.datetime import freeze_time
+from sentry.testutils.silo import control_silo_test
+from sentry.users.models import UserMergeVerificationCode
+from sentry.users.models.user_merge_verification_code import TOKEN_MINUTES_VALID
+
+
+@control_silo_test
+class TestUserMergeVerificationCode(TestCase):
+    @freeze_time()
+    def test_regenerate_token(self):
+        code = UserMergeVerificationCode(user=self.user)
+        token = code.token
+        code.expires_at = datetime(2025, 3, 14, 5, 32, 21, tzinfo=UTC)
+        code.save()
+
+        code.regenerate_token()
+        assert code.token != token
+        assert code.expires_at == datetime.now(UTC) + timedelta(minutes=TOKEN_MINUTES_VALID)
+
+    @freeze_time()
+    def test_expires_at(self):
+        code = UserMergeVerificationCode(user=self.user)
+        code.expires_at = datetime(2025, 3, 14, 5, 32, 21, tzinfo=UTC)
+        code.save()
+
+        assert not code.is_valid()
+
+        code.regenerate_token()
+        assert code.is_valid()