[WEB-5312] migration: work item comments (#8072)

* migration: description field on issue_comment
sync: issue_comment and description

* fix: update if description already exists for the IssueComment

* feat: management command to copy IssueComment to Description

* fix: description creation order

* chore: add while loop

* fix: move write outside loop

* chore: change sync logic
chore: test cases

* chore: removed deleted_at filter and added order_by in management command

* fix: description_id

* migration: added parent_id for IssueComment

* fix: update update_by_id

* fix: use ChangeTrackerMixin in save

* chore: add docstring
fix: remove self.pk check
chore: wrap the description creation logic in transaction.atomic()

* fix: tests

* fix: use super save method

* fix: mulitple if conditions

* fix: update updated_at

Author: sangeethailango

apps/api/plane/db/management/commands/copy_issue_comment_to_description.py

@@ -0,0 +1,49 @@
+# Django imports
+from django.core.management.base import BaseCommand
+from django.db import transaction
+
+# Module imports
+from plane.db.models import Description
+from plane.db.models import IssueComment
+
+
+class Command(BaseCommand):
+    help = "Create Description records for existing IssueComment"
+
+    def handle(self, *args, **kwargs):
+        batch_size = 500
+
+        while True:
+            comments = list(
+                IssueComment.objects.filter(description_id__isnull=True).order_by("created_at")[:batch_size]
+            )
+
+            if not comments:
+                break
+
+            with transaction.atomic():
+                descriptions = [
+                    Description(
+                        created_at=comment.created_at,
+                        updated_at=comment.updated_at,
+                        description_json=comment.comment_json,
+                        description_html=comment.comment_html,
+                        description_stripped=comment.comment_stripped,
+                        project_id=comment.project_id,
+                        created_by_id=comment.created_by_id,
+                        updated_by_id=comment.updated_by_id,
+                        workspace_id=comment.workspace_id,
+                    )
+                    for comment in comments
+                ]
+
+                created_descriptions = Description.objects.bulk_create(descriptions)
+
+                comments_to_update = []
+                for comment, description in zip(comments, created_descriptions):
+                    comment.description_id = description.id
+                    comments_to_update.append(comment)
+
+                IssueComment.objects.bulk_update(comments_to_update, ["description_id"])
+
+        self.stdout.write(self.style.SUCCESS("Successfully Copied IssueComment to Description"))

apps/api/plane/db/migrations/0109_issuecomment_description_and_parent_id.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.22 on 2025-11-06 08:28
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('db', '0108_alter_issueactivity_issue_comment'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='issuecomment',
+            name='description',
+            field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='issue_comment_description', to='db.description'),
+        ),
+        migrations.AddField(
+            model_name='issuecomment',
+            name='parent',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='parent_issue_comment', to='db.issuecomment'),
+        ),
+    ]

apps/api/plane/db/models/issue.py

@@ -17,6 +17,8 @@
 from plane.utils.exception_logger import log_exception
 from .project import ProjectBaseModel
 from plane.utils.uuid import convert_uuid_to_integer
+from .description import Description
+from plane.db.mixins import ChangeTrackerMixin
 
 
 def get_default_properties():
@@ -442,10 +444,13 @@ def __str__(self):
         return str(self.issue)
 
 
-class IssueComment(ProjectBaseModel):
+class IssueComment(ChangeTrackerMixin, ProjectBaseModel):
     comment_stripped = models.TextField(verbose_name="Comment", blank=True)
     comment_json = models.JSONField(blank=True, default=dict)
     comment_html = models.TextField(blank=True, default="<p></p>")
+    description = models.OneToOneField(
+        "db.Description", on_delete=models.CASCADE, related_name="issue_comment_description", null=True
+    )
     attachments = ArrayField(models.URLField(), size=10, blank=True, default=list)
     issue = models.ForeignKey(Issue, on_delete=models.CASCADE, related_name="issue_comments")
     # System can also create comment
@@ -463,10 +468,60 @@ class IssueComment(ProjectBaseModel):
     external_source = models.CharField(max_length=255, null=True, blank=True)
     external_id = models.CharField(max_length=255, blank=True, null=True)
     edited_at = models.DateTimeField(null=True, blank=True)
+    parent = models.ForeignKey(
+        "self", on_delete=models.CASCADE, null=True, blank=True, related_name="parent_issue_comment"
+    )
+
+    TRACKED_FIELDS = ["comment_stripped", "comment_json", "comment_html"]
 
     def save(self, *args, **kwargs):
+        """
+        Custom save method for IssueComment that manages the associated Description model.
+
+        This method handles creation and updates of both the comment and its description in a
+        single atomic transaction to ensure data consistency.
+        """
+
         self.comment_stripped = strip_tags(self.comment_html) if self.comment_html != "" else ""
-        return super(IssueComment, self).save(*args, **kwargs)
+        is_creating = self._state.adding
+
+        # Prepare description defaults
+        description_defaults = {
+            "workspace_id": self.workspace_id,
+            "project_id": self.project_id,
+            "created_by_id": self.created_by_id,
+            "updated_by_id": self.updated_by_id,
+            "description_stripped": self.comment_stripped,
+            "description_json": self.comment_json,
+            "description_html": self.comment_html,
+        }
+
+        with transaction.atomic():
+            super(IssueComment, self).save(*args, **kwargs)
+
+            if is_creating or not self.description_id:
+                # Create new description for new comment
+                description = Description.objects.create(**description_defaults)
+                self.description_id = description.id
+                super(IssueComment, self).save(update_fields=["description_id"])
+            else:
+                field_mapping = {
+                    "comment_html": "description_html",
+                    "comment_stripped": "description_stripped",
+                    "comment_json": "description_json",
+                }
+
+                changed_fields = {
+                    desc_field: getattr(self, comment_field)
+                    for comment_field, desc_field in field_mapping.items()
+                    if self.has_changed(comment_field)
+                }
+
+                # Update description only if comment fields changed
+                if changed_fields and self.description_id:
+                    Description.objects.filter(pk=self.description_id).update(
+                        **changed_fields, updated_by_id=self.updated_by_id, updated_at=self.updated_at
+                    )
 
     class Meta:
         verbose_name = "Issue Comment"