chore: Add fields to issue_version and profile tables, and create new sticky table (#6198)

* chore: added fields in issue_version and profile tables and created a new sticky table

* chore: removed point in issue version

* chore: add imports in init

---------

Co-authored-by: sainath <sainath@sainaths-MacBook-Pro.local>

Author: gurusainath

apiserver/plane/db/migrations/0087_remove_issueversion_description_and_more.py

@@ -0,0 +1,112 @@
+# Generated by Django 4.2.17 on 2024-12-13 10:09
+
+from django.conf import settings
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+import plane.db.models.user
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('db', '0086_issueversion_alter_teampage_unique_together_and_more'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='issueversion',
+            name='description',
+        ),
+        migrations.RemoveField(
+            model_name='issueversion',
+            name='description_binary',
+        ),
+        migrations.RemoveField(
+            model_name='issueversion',
+            name='description_html',
+        ),
+        migrations.RemoveField(
+            model_name='issueversion',
+            name='description_stripped',
+        ),
+        migrations.AddField(
+            model_name='issueversion',
+            name='activity',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='versions', to='db.issueactivity'),
+        ),
+        migrations.AddField(
+            model_name='profile',
+            name='is_mobile_onboarded',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='profile',
+            name='mobile_onboarding_step',
+            field=models.JSONField(default=plane.db.models.user.get_mobile_default_onboarding),
+        ),
+        migrations.AddField(
+            model_name='profile',
+            name='mobile_timezone_auto_set',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AlterField(
+            model_name='issueversion',
+            name='owned_by',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='issue_versions', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.CreateModel(
+            name='Sticky',
+            fields=[
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Created At')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='Last Modified At')),
+                ('deleted_at', models.DateTimeField(blank=True, null=True, verbose_name='Deleted At')),
+                ('id', models.UUIDField(db_index=True, default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True)),
+                ('name', models.TextField()),
+                ('description', models.JSONField(blank=True, default=dict)),
+                ('description_html', models.TextField(blank=True, default='<p></p>')),
+                ('description_stripped', models.TextField(blank=True, null=True)),
+                ('description_binary', models.BinaryField(null=True)),
+                ('logo_props', models.JSONField(default=dict)),
+                ('color', models.CharField(blank=True, max_length=255, null=True)),
+                ('background_color', models.CharField(blank=True, max_length=255, null=True)),
+                ('created_by', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(class)s_created_by', to=settings.AUTH_USER_MODEL, verbose_name='Created By')),
+                ('owner', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='stickies', to=settings.AUTH_USER_MODEL)),
+                ('updated_by', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(class)s_updated_by', to=settings.AUTH_USER_MODEL, verbose_name='Last Modified By')),
+                ('workspace', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='stickies', to='db.workspace')),
+            ],
+            options={
+                'verbose_name': 'Sticky',
+                'verbose_name_plural': 'Stickies',
+                'db_table': 'stickies',
+                'ordering': ('-created_at',),
+            },
+        ),
+        migrations.CreateModel(
+            name='IssueDescriptionVersion',
+            fields=[
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Created At')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='Last Modified At')),
+                ('deleted_at', models.DateTimeField(blank=True, null=True, verbose_name='Deleted At')),
+                ('id', models.UUIDField(db_index=True, default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True)),
+                ('description_binary', models.BinaryField(null=True)),
+                ('description_html', models.TextField(blank=True, default='<p></p>')),
+                ('description_stripped', models.TextField(blank=True, null=True)),
+                ('description_json', models.JSONField(blank=True, default=dict)),
+                ('last_saved_at', models.DateTimeField(default=django.utils.timezone.now)),
+                ('created_by', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(class)s_created_by', to=settings.AUTH_USER_MODEL, verbose_name='Created By')),
+                ('issue', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='description_versions', to='db.issue')),
+                ('owned_by', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='issue_description_versions', to=settings.AUTH_USER_MODEL)),
+                ('project', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='project_%(class)s', to='db.project')),
+                ('updated_by', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='%(class)s_updated_by', to=settings.AUTH_USER_MODEL, verbose_name='Last Modified By')),
+                ('workspace', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='workspace_%(class)s', to='db.workspace')),
+            ],
+            options={
+                'verbose_name': 'Issue Description Version',
+                'verbose_name_plural': 'Issue Description Versions',
+                'db_table': 'issue_description_versions',
+            },
+        ),
+    ]

apiserver/plane/db/models/__init__.py

@@ -41,6 +41,8 @@
     IssueSequence,
     IssueSubscriber,
     IssueVote,
+    IssueVersion,
+    IssueDescriptionVersion,
 )
 from .module import Module, ModuleIssue, ModuleLink, ModuleMember, ModuleUserProperties
 from .notification import EmailNotificationLog, Notification, UserNotificationPreference
@@ -68,15 +70,6 @@
     WorkspaceUserProperties,
 )
 
-
-
-
-
-
-
-
-
-
 from .favorite import UserFavorite
 
 from .issue_type import IssueType
@@ -86,3 +79,5 @@
 from .label import Label
 
 from .device import Device, DeviceSession
+
+from .sticky import Sticky

apiserver/plane/db/models/issue.py

@@ -15,6 +15,7 @@
 from plane.utils.html_processor import strip_tags
 from plane.db.mixins import SoftDeletionManager
 from plane.utils.exception_logger import log_exception
+from .base import BaseModel
 from .project import ProjectBaseModel
 
 
@@ -660,24 +661,18 @@ def __str__(self):
 
 
 class IssueVersion(ProjectBaseModel):
-    issue = models.ForeignKey(
-        "db.Issue", on_delete=models.CASCADE, related_name="versions"
-    )
     PRIORITY_CHOICES = (
         ("urgent", "Urgent"),
         ("high", "High"),
         ("medium", "Medium"),
         ("low", "Low"),
         ("none", "None"),
     )
+
     parent = models.UUIDField(blank=True, null=True)
     state = models.UUIDField(blank=True, null=True)
     estimate_point = models.UUIDField(blank=True, null=True)
     name = models.CharField(max_length=255, verbose_name="Issue Name")
-    description = models.JSONField(blank=True, default=dict)
-    description_html = models.TextField(blank=True, default="<p></p>")
-    description_stripped = models.TextField(blank=True, null=True)
-    description_binary = models.BinaryField(null=True)
     priority = models.CharField(
         max_length=30,
         choices=PRIORITY_CHOICES,
@@ -686,22 +681,36 @@ class IssueVersion(ProjectBaseModel):
     )
     start_date = models.DateField(null=True, blank=True)
     target_date = models.DateField(null=True, blank=True)
+    assignees = ArrayField(models.UUIDField(), blank=True, default=list)
     sequence_id = models.IntegerField(default=1, verbose_name="Issue Sequence ID")
+    labels = ArrayField(models.UUIDField(), blank=True, default=list)
     sort_order = models.FloatField(default=65535)
     completed_at = models.DateTimeField(null=True)
     archived_at = models.DateField(null=True)
     is_draft = models.BooleanField(default=False)
     external_source = models.CharField(max_length=255, null=True, blank=True)
     external_id = models.CharField(max_length=255, blank=True, null=True)
     type = models.UUIDField(blank=True, null=True)
-    last_saved_at = models.DateTimeField(default=timezone.now)
-    owned_by = models.UUIDField()
-    assignees = ArrayField(models.UUIDField(), blank=True, default=list)
-    labels = ArrayField(models.UUIDField(), blank=True, default=list)
     cycle = models.UUIDField(null=True, blank=True)
     modules = ArrayField(models.UUIDField(), blank=True, default=list)
-    properties = models.JSONField(default=dict)
-    meta = models.JSONField(default=dict)
+    properties = models.JSONField(default=dict)  # issue properties
+    meta = models.JSONField(default=dict)  # issue meta
+    last_saved_at = models.DateTimeField(default=timezone.now)
+
+    issue = models.ForeignKey(
+        "db.Issue", on_delete=models.CASCADE, related_name="versions"
+    )
+    activity = models.ForeignKey(
+        "db.IssueActivity",
+        on_delete=models.SET_NULL,
+        null=True,
+        related_name="versions",
+    )
+    owned_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="issue_versions",
+    )
 
     class Meta:
         verbose_name = "Issue Version"
@@ -721,36 +730,86 @@ def log_issue_version(cls, issue, user):
 
             Module = apps.get_model("db.Module")
             CycleIssue = apps.get_model("db.CycleIssue")
+            IssueAssignee = apps.get_model("db.IssueAssignee")
+            IssueLabel = apps.get_model("db.IssueLabel")
 
             cycle_issue = CycleIssue.objects.filter(issue=issue).first()
 
             cls.objects.create(
                 issue=issue,
-                parent=issue.parent,
-                state=issue.state,
-                point=issue.point,
-                estimate_point=issue.estimate_point,
+                parent=issue.parent_id,
+                state=issue.state_id,
+                estimate_point=issue.estimate_point_id,
                 name=issue.name,
-                description=issue.description,
-                description_html=issue.description_html,
-                description_stripped=issue.description_stripped,
-                description_binary=issue.description_binary,
                 priority=issue.priority,
                 start_date=issue.start_date,
                 target_date=issue.target_date,
+                assignees=list(
+                    IssueAssignee.objects.filter(issue=issue).values_list(
+                        "assignee_id", flat=True
+                    )
+                ),
                 sequence_id=issue.sequence_id,
+                labels=list(
+                    IssueLabel.objects.filter(issue=issue).values_list(
+                        "label_id", flat=True
+                    )
+                ),
                 sort_order=issue.sort_order,
                 completed_at=issue.completed_at,
                 archived_at=issue.archived_at,
                 is_draft=issue.is_draft,
                 external_source=issue.external_source,
                 external_id=issue.external_id,
-                type=issue.type,
-                last_saved_at=issue.last_saved_at,
-                assignees=issue.assignees,
-                labels=issue.labels,
-                cycle=cycle_issue.cycle if cycle_issue else None,
-                modules=Module.objects.filter(issue=issue).values_list("id", flat=True),
+                type=issue.type_id,
+                cycle=cycle_issue.cycle_id if cycle_issue else None,
+                modules=list(
+                    Module.objects.filter(issue=issue).values_list("id", flat=True)
+                ),
+                properties={},
+                meta={},
+                last_saved_at=timezone.now(),
+                owned_by=user,
+            )
+            return True
+        except Exception as e:
+            log_exception(e)
+            return False
+
+
+class IssueDescriptionVersion(ProjectBaseModel):
+    issue = models.ForeignKey(
+        "db.Issue", on_delete=models.CASCADE, related_name="description_versions"
+    )
+    description_binary = models.BinaryField(null=True)
+    description_html = models.TextField(blank=True, default="<p></p>")
+    description_stripped = models.TextField(blank=True, null=True)
+    description_json = models.JSONField(default=dict, blank=True)
+    last_saved_at = models.DateTimeField(default=timezone.now)
+    owned_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        related_name="issue_description_versions",
+    )
+
+    class Meta:
+        verbose_name = "Issue Description Version"
+        verbose_name_plural = "Issue Description Versions"
+        db_table = "issue_description_versions"
+
+    @classmethod
+    def log_issue_description_version(cls, issue, user):
+        try:
+            """
+            Log the issue description version
+            """
+            cls.objects.create(
+                issue=issue,
+                description_binary=issue.description_binary,
+                description_html=issue.description_html,
+                description_stripped=issue.description_stripped,
+                description_json=issue.description,
+                last_saved_at=timezone.now(),
                 owned_by=user,
             )
             return True

apiserver/plane/db/models/sticky.py

@@ -0,0 +1,32 @@
+# Django imports
+from django.conf import settings
+from django.db import models
+
+# Module imports
+from .base import BaseModel
+
+
+class Sticky(BaseModel):
+    name = models.TextField()
+
+    description = models.JSONField(blank=True, default=dict)
+    description_html = models.TextField(blank=True, default="<p></p>")
+    description_stripped = models.TextField(blank=True, null=True)
+    description_binary = models.BinaryField(null=True)
+
+    logo_props = models.JSONField(default=dict)
+    color = models.CharField(max_length=255, blank=True, null=True)
+    background_color = models.CharField(max_length=255, blank=True, null=True)
+
+    workspace = models.ForeignKey(
+        "db.Workspace", on_delete=models.CASCADE, related_name="stickies"
+    )
+    owner = models.ForeignKey(
+        settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="stickies"
+    )
+
+    class Meta:
+        verbose_name = "Sticky"
+        verbose_name_plural = "Stickies"
+        db_table = "stickies"
+        ordering = ("-created_at",)

apiserver/plane/db/models/user.py

@@ -26,6 +26,14 @@ def get_default_onboarding():
     }
 
 
+def get_mobile_default_onboarding():
+    return {
+        "profile_complete": False,
+        "workspace_create": False,
+        "workspace_join": False,
+    }
+
+
 class User(AbstractBaseUser, PermissionsMixin):
     id = models.UUIDField(
         default=uuid.uuid4, unique=True, editable=False, db_index=True, primary_key=True
@@ -178,6 +186,10 @@ class Profile(TimeAuditModel):
     billing_address = models.JSONField(null=True)
     has_billing_address = models.BooleanField(default=False)
     company_name = models.CharField(max_length=255, blank=True)
+    # mobile
+    is_mobile_onboarded = models.BooleanField(default=False)
+    mobile_onboarding_step = models.JSONField(default=get_mobile_default_onboarding)
+    mobile_timezone_auto_set = models.BooleanField(default=False)
 
     class Meta:
         verbose_name = "Profile"