snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

analytics/models.py

@@ -0,0 +1,158 @@
+from datetime import datetime
+
+from django.db import models
+from django.db.models import Q, UniqueConstraint
+from typing_extensions import override
+
+from zerver.lib.timestamp import floor_to_day
+from zerver.models import Realm, Stream, UserProfile
+
+
+class FillState(models.Model):
+    property = models.CharField(max_length=40, unique=True)
+    end_time = models.DateTimeField()
+
+    # Valid states are {DONE, STARTED}
+    DONE = 1
+    STARTED = 2
+    state = models.PositiveSmallIntegerField()
+
+    @override
+    def __str__(self) -> str:
+        return f"{self.property} {self.end_time} {self.state}"
+
+
+# The earliest/starting end_time in FillState
+# We assume there is at least one realm
+def installation_epoch() -> datetime:
+    earliest_realm_creation = Realm.objects.aggregate(models.Min("date_created"))[
+        "date_created__min"
+    ]
+    return floor_to_day(earliest_realm_creation)
+
+
+class BaseCount(models.Model):
+    # Note: When inheriting from BaseCount, you may want to rearrange
+    # the order of the columns in the migration to make sure they
+    # match how you'd like the table to be arranged.
+    property = models.CharField(max_length=32)
+    subgroup = models.CharField(max_length=16, null=True)
+    end_time = models.DateTimeField()
+    value = models.BigIntegerField()
+
+    class Meta:
+        abstract = True
+
+
+class InstallationCount(BaseCount):
+    class Meta:
+        # Handles invalid duplicate InstallationCount data
+        constraints = [
+            UniqueConstraint(
+                fields=["property", "subgroup", "end_time"],
+                condition=Q(subgroup__isnull=False),
+                name="unique_installation_count",
+            ),
+            UniqueConstraint(
+                fields=["property", "end_time"],
+                condition=Q(subgroup__isnull=True),
+                name="unique_installation_count_null_subgroup",
+            ),
+        ]
+
+    @override
+    def __str__(self) -> str:
+        return f"{self.property} {self.subgroup} {self.value}"
+
+
+class RealmCount(BaseCount):
+    realm = models.ForeignKey(Realm, on_delete=models.CASCADE)
+
+    class Meta:
+        # Handles invalid duplicate RealmCount data
+        constraints = [
+            UniqueConstraint(
+                fields=["realm", "property", "subgroup", "end_time"],
+                condition=Q(subgroup__isnull=False),
+                name="unique_realm_count",
+            ),
+            UniqueConstraint(
+                fields=["realm", "property", "end_time"],
+                condition=Q(subgroup__isnull=True),
+                name="unique_realm_count_null_subgroup",
+            ),
+        ]
+        indexes = [
+            models.Index(
+                fields=["property", "end_time"],
+                name="analytics_realmcount_property_end_time_3b60396b_idx",
+            )
+        ]
+
+    @override
+    def __str__(self) -> str:
+        return f"{self.realm!r} {self.property} {self.subgroup} {self.value}"
+
+
+class UserCount(BaseCount):
+    user = models.ForeignKey(UserProfile, on_delete=models.CASCADE)
+    realm = models.ForeignKey(Realm, on_delete=models.CASCADE)
+
+    class Meta:
+        # Handles invalid duplicate UserCount data
+        constraints = [
+            UniqueConstraint(
+                fields=["user", "property", "subgroup", "end_time"],
+                condition=Q(subgroup__isnull=False),
+                name="unique_user_count",
+            ),
+            UniqueConstraint(
+                fields=["user", "property", "end_time"],
+                condition=Q(subgroup__isnull=True),
+                name="unique_user_count_null_subgroup",
+            ),
+        ]
+        # This index dramatically improves the performance of
+        # aggregating from users to realms
+        indexes = [
+            models.Index(
+                fields=["property", "realm", "end_time"],
+                name="analytics_usercount_property_realm_id_end_time_591dbec1_idx",
+            )
+        ]
+
+    @override
+    def __str__(self) -> str:
+        return f"{self.user!r} {self.property} {self.subgroup} {self.value}"
+
+
+class StreamCount(BaseCount):
+    stream = models.ForeignKey(Stream, on_delete=models.CASCADE)
+    realm = models.ForeignKey(Realm, on_delete=models.CASCADE)
+
+    class Meta:
+        # Handles invalid duplicate StreamCount data
+        constraints = [
+            UniqueConstraint(
+                fields=["stream", "property", "subgroup", "end_time"],
+                condition=Q(subgroup__isnull=False),
+                name="unique_stream_count",
+            ),
+            UniqueConstraint(
+                fields=["stream", "property", "end_time"],
+                condition=Q(subgroup__isnull=True),
+                name="unique_stream_count_null_subgroup",
+            ),
+        ]
+        # This index dramatically improves the performance of
+        # aggregating from streams to realms
+        indexes = [
+            models.Index(
+                fields=["property", "realm", "end_time"],
+                name="analytics_streamcount_property_realm_id_end_time_155ae930_idx",
+            )
+        ]
+
+    @override
+    def __str__(self) -> str:
+        return f"{self.stream!r} {self.property} {self.subgroup} {self.value} {self.id}"