feat: OPTIC-184: Remove is_deleted field from User model and manager (#…

…5125)

* feat: OPTIC-184: Remove is_deleted field from User model and manager

* Rewrite history as manager no longer exists

* Add migration to remove no longer needed manager from users

* Remove reference to deleted manager from migration

* Add documentation to note removal of manager

label_studio/users/admin.py

@@ -15,10 +15,6 @@ class UserAdminShort(UserAdmin):
 
     add_fieldsets = ((None, {'fields': ('email', 'password1', 'password2')}),)
 
-    def get_queryset(self, request):
-        # Use the with_deleted method to include soft-deleted users in the queryset
-        return User.with_deleted.all()
-
     def __init__(self, *args, **kwargs):
         super(UserAdminShort, self).__init__(*args, **kwargs)
 

label_studio/users/migrations/0001_squashed_0009_auto_20210219_1237.py

@@ -12,7 +12,7 @@
 
 def add_tokens(apps, schema_editor):
     User = apps.get_model('users', 'User')
-    all_users = User.with_deleted.all()
+    all_users = User.objects.all()
 
     for user_one in all_users:
         if not hasattr(user_one, 'auth_token'):
@@ -67,9 +67,6 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'users',
                 'db_table': 'htx_user',
             },
-            managers=[
-                ('with_deleted', users.models.UserManagerWithDeleted()),
-            ],
         ),
         migrations.RunPython(add_tokens),
         # migrations.RunPython(add_users),  # TODO: flag:ent

label_studio/users/migrations/0008_alter_user_managers.py

@@ -16,7 +16,8 @@ class Migration(migrations.Migration):
             name='user',
             managers=[
                 ('objects', django.db.models.manager.Manager()),
-                ('with_deleted', users.models.UserManagerWithDeleted()),
+                # Previously, this migration contained an addition of UserManagerWithDeleted, which has since been
+                # removed in order to avoid referencing a non-existent manager.
             ],
         ),
     ]

label_studio/users/migrations/0009_auto_20231201_0001.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.2.23 on 2023-12-01 00:01
+
+from django.db import migrations
+import users.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0008_alter_user_managers'),
+    ]
+
+    operations = [
+        migrations.AlterModelManagers(
+            name='user',
+            managers=[
+                ('objects', users.models.UserManager()),
+            ],
+        ),
+        migrations.RemoveField(
+            model_name='user',
+            name='is_deleted',
+        ),
+    ]

label_studio/users/models.py

@@ -26,8 +26,8 @@
 year = models.IntegerField(_('year'), choices=YEAR_CHOICES, default=datetime.datetime.now().year)
 
 
-class UserManagerWithDeleted(BaseUserManager):
-    use_in_migrations: bool = True
+class UserManager(BaseUserManager):
+    use_in_migrations = True
 
     def _create_user(self, email, password, **extra_fields):
         """
@@ -61,15 +61,6 @@ def create_superuser(self, email, password, **extra_fields):
         return self._create_user(email, password, **extra_fields)
 
 
-class UserManager(UserManagerWithDeleted):
-    use_in_migrations: bool = False
-
-    def get_queryset(self):
-        qs = super().get_queryset()
-        qs = qs.filter(is_deleted=False)
-        return qs
-
-
 class UserLastActivityMixin(models.Model):
     last_activity = models.DateTimeField(_('last activity'), default=timezone.now, editable=False)
 
@@ -109,12 +100,6 @@ class User(UserMixin, AbstractBaseUser, PermissionsMixin, UserLastActivityMixin)
         default=True,
         help_text=_('Designates whether to treat this user as active. Unselect this instead of deleting accounts.'),
     )
-    is_deleted = models.BooleanField(
-        _('deleted'),
-        default=False,
-        db_index=True,
-        help_text=_('Designates whether to treat this user as deleted. Select this instead of deleting accounts.'),
-    )
 
     date_joined = models.DateTimeField(_('date joined'), default=timezone.now)
 
@@ -129,7 +114,6 @@ class User(UserMixin, AbstractBaseUser, PermissionsMixin, UserLastActivityMixin)
     )
 
     objects = UserManager()
-    with_deleted = UserManagerWithDeleted()
 
     EMAIL_FIELD = 'email'
     USERNAME_FIELD = 'email'