Integrations: add created and updated fields to model (#11067)

* Integrations: add created and updated fields to model

* Set fields as nullable

* Add data migration

* Format

Author: stsewd

readthedocs/integrations/migrations/0011_add_created_and_updated_fields.py

@@ -0,0 +1,40 @@
+# Generated by Django 4.2.9 on 2024-01-25 17:46
+
+import django.utils.timezone
+import django_extensions.db.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("integrations", "0010_remove_old_jsonfields"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="integration",
+            options={"get_latest_by": "modified"},
+        ),
+        migrations.AddField(
+            model_name="integration",
+            name="created",
+            field=django_extensions.db.fields.CreationDateTimeField(
+                auto_now_add=True,
+                default=django.utils.timezone.now,
+                verbose_name="created",
+                null=True,
+                blank=True,
+            ),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="integration",
+            name="modified",
+            field=django_extensions.db.fields.ModificationDateTimeField(
+                auto_now=True,
+                verbose_name="modified",
+                null=True,
+                blank=True,
+            ),
+        ),
+    ]

readthedocs/integrations/migrations/0012_migrate_timestamp_fields.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.9 on 2024-01-29 19:16
+
+from django.db import migrations
+from django.utils import timezone
+
+
+def forwards_func(apps, schema_editor):
+    Integration = apps.get_model("integrations", "Integration")
+    Integration.objects.filter(created=None).update(created=timezone.now())
+    Integration.objects.filter(modified=None).update(modified=timezone.now())
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("integrations", "0011_add_created_and_updated_fields"),
+    ]
+
+    operations = [migrations.RunPython(forwards_func)]

readthedocs/integrations/models.py

@@ -1,18 +1,16 @@
 """Integration models for external services."""
-
 import json
 import re
 import uuid
 
-from django.contrib.contenttypes.fields import (
-    GenericForeignKey,
-    GenericRelation,
-)
+from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation
 from django.contrib.contenttypes.models import ContentType
 from django.db import models, transaction
 from django.utils.crypto import get_random_string
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
+from django_extensions.db.fields import CreationDateTimeField, ModificationDateTimeField
+from django_extensions.db.models import TimeStampedModel
 from pygments import highlight
 from pygments.formatters import HtmlFormatter
 from pygments.lexers import JsonLexer
@@ -262,7 +260,7 @@ def create(self, **kwargs):
         return obj
 
 
-class Integration(models.Model):
+class Integration(TimeStampedModel):
 
     """Inbound webhook integration for projects."""
 
@@ -280,6 +278,19 @@ class Integration(models.Model):
 
     INTEGRATIONS = WEBHOOK_INTEGRATIONS
 
+    # Overridden from TimeStampedModel just to allow null values.
+    # TODO: remove after deploy.
+    created = CreationDateTimeField(
+        _("created"),
+        null=True,
+        blank=True,
+    )
+    modified = ModificationDateTimeField(
+        _("modified"),
+        null=True,
+        blank=True,
+    )
+
     project = models.ForeignKey(
         Project,
         related_name="integrations",