mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			297 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			297 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
from datetime import timedelta
 | 
						|
from typing import Any, Dict, List, Mapping, Optional, Type
 | 
						|
from unittest import mock
 | 
						|
 | 
						|
from django.core.management.base import BaseCommand
 | 
						|
from django.utils.timezone import now as timezone_now
 | 
						|
 | 
						|
from analytics.lib.counts import COUNT_STATS, CountStat, do_drop_all_analytics_tables
 | 
						|
from analytics.lib.fixtures import generate_time_series_data
 | 
						|
from analytics.lib.time_utils import time_range
 | 
						|
from analytics.models import (
 | 
						|
    BaseCount,
 | 
						|
    FillState,
 | 
						|
    InstallationCount,
 | 
						|
    RealmCount,
 | 
						|
    StreamCount,
 | 
						|
    UserCount,
 | 
						|
)
 | 
						|
from zerver.lib.actions import STREAM_ASSIGNMENT_COLORS, do_change_user_role
 | 
						|
from zerver.lib.create_user import create_user
 | 
						|
from zerver.lib.timestamp import floor_to_day
 | 
						|
from zerver.models import Client, Realm, Recipient, Stream, Subscription, UserProfile
 | 
						|
 | 
						|
 | 
						|
class Command(BaseCommand):
 | 
						|
    help = """Populates analytics tables with randomly generated data."""
 | 
						|
 | 
						|
    DAYS_OF_DATA = 100
 | 
						|
    random_seed = 26
 | 
						|
 | 
						|
    def generate_fixture_data(
 | 
						|
        self,
 | 
						|
        stat: CountStat,
 | 
						|
        business_hours_base: float,
 | 
						|
        non_business_hours_base: float,
 | 
						|
        growth: float,
 | 
						|
        autocorrelation: float,
 | 
						|
        spikiness: float,
 | 
						|
        holiday_rate: float = 0,
 | 
						|
        partial_sum: bool = False,
 | 
						|
    ) -> List[int]:
 | 
						|
        self.random_seed += 1
 | 
						|
        return generate_time_series_data(
 | 
						|
            days=self.DAYS_OF_DATA,
 | 
						|
            business_hours_base=business_hours_base,
 | 
						|
            non_business_hours_base=non_business_hours_base,
 | 
						|
            growth=growth,
 | 
						|
            autocorrelation=autocorrelation,
 | 
						|
            spikiness=spikiness,
 | 
						|
            holiday_rate=holiday_rate,
 | 
						|
            frequency=stat.frequency,
 | 
						|
            partial_sum=partial_sum,
 | 
						|
            random_seed=self.random_seed,
 | 
						|
        )
 | 
						|
 | 
						|
    def handle(self, *args: Any, **options: Any) -> None:
 | 
						|
        # TODO: This should arguably only delete the objects
 | 
						|
        # associated with the "analytics" realm.
 | 
						|
        do_drop_all_analytics_tables()
 | 
						|
 | 
						|
        # This also deletes any objects with this realm as a foreign key
 | 
						|
        Realm.objects.filter(string_id="analytics").delete()
 | 
						|
 | 
						|
        # Because we just deleted a bunch of objects in the database
 | 
						|
        # directly (rather than deleting individual objects in Django,
 | 
						|
        # in which case our post_save hooks would have flushed the
 | 
						|
        # individual objects from memcached for us), we need to flush
 | 
						|
        # memcached in order to ensure deleted objects aren't still
 | 
						|
        # present in the memcached cache.
 | 
						|
        from zerver.apps import flush_cache
 | 
						|
 | 
						|
        flush_cache(None)
 | 
						|
 | 
						|
        installation_time = timezone_now() - timedelta(days=self.DAYS_OF_DATA)
 | 
						|
        last_end_time = floor_to_day(timezone_now())
 | 
						|
        realm = Realm.objects.create(
 | 
						|
            string_id="analytics", name="Analytics", date_created=installation_time
 | 
						|
        )
 | 
						|
        with mock.patch("zerver.lib.create_user.timezone_now", return_value=installation_time):
 | 
						|
            shylock = create_user(
 | 
						|
                "shylock@analytics.ds",
 | 
						|
                "Shylock",
 | 
						|
                realm,
 | 
						|
                full_name="Shylock",
 | 
						|
                role=UserProfile.ROLE_REALM_ADMINISTRATOR,
 | 
						|
            )
 | 
						|
        do_change_user_role(shylock, UserProfile.ROLE_REALM_ADMINISTRATOR, acting_user=None)
 | 
						|
        stream = Stream.objects.create(name="all", realm=realm, date_created=installation_time)
 | 
						|
        recipient = Recipient.objects.create(type_id=stream.id, type=Recipient.STREAM)
 | 
						|
        stream.recipient = recipient
 | 
						|
        stream.save(update_fields=["recipient"])
 | 
						|
 | 
						|
        # Subscribe shylock to the stream to avoid invariant failures.
 | 
						|
        # TODO: This should use subscribe_users_to_streams from populate_db.
 | 
						|
        subs = [
 | 
						|
            Subscription(
 | 
						|
                recipient=recipient, user_profile=shylock, color=STREAM_ASSIGNMENT_COLORS[0]
 | 
						|
            ),
 | 
						|
        ]
 | 
						|
        Subscription.objects.bulk_create(subs)
 | 
						|
 | 
						|
        def insert_fixture_data(
 | 
						|
            stat: CountStat, fixture_data: Mapping[Optional[str], List[int]], table: Type[BaseCount]
 | 
						|
        ) -> None:
 | 
						|
            end_times = time_range(
 | 
						|
                last_end_time, last_end_time, stat.frequency, len(list(fixture_data.values())[0])
 | 
						|
            )
 | 
						|
            if table == InstallationCount:
 | 
						|
                id_args: Dict[str, Any] = {}
 | 
						|
            if table == RealmCount:
 | 
						|
                id_args = {"realm": realm}
 | 
						|
            if table == UserCount:
 | 
						|
                id_args = {"realm": realm, "user": shylock}
 | 
						|
            if table == StreamCount:
 | 
						|
                id_args = {"stream": stream, "realm": realm}
 | 
						|
 | 
						|
            for subgroup, values in fixture_data.items():
 | 
						|
                table.objects.bulk_create(
 | 
						|
                    table(
 | 
						|
                        property=stat.property,
 | 
						|
                        subgroup=subgroup,
 | 
						|
                        end_time=end_time,
 | 
						|
                        value=value,
 | 
						|
                        **id_args,
 | 
						|
                    )
 | 
						|
                    for end_time, value in zip(end_times, values)
 | 
						|
                    if value != 0
 | 
						|
                )
 | 
						|
 | 
						|
        stat = COUNT_STATS["1day_actives::day"]
 | 
						|
        realm_data: Mapping[Optional[str], List[int]] = {
 | 
						|
            None: self.generate_fixture_data(stat, 0.08, 0.02, 3, 0.3, 6, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data: Mapping[Optional[str], List[int]] = {
 | 
						|
            None: self.generate_fixture_data(stat, 0.8, 0.2, 4, 0.3, 6, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["7day_actives::day"]
 | 
						|
        realm_data = {
 | 
						|
            None: self.generate_fixture_data(stat, 0.2, 0.07, 3, 0.3, 6, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data = {
 | 
						|
            None: self.generate_fixture_data(stat, 2, 0.7, 4, 0.3, 6, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["realm_active_humans::day"]
 | 
						|
        realm_data = {
 | 
						|
            None: self.generate_fixture_data(stat, 0.8, 0.08, 3, 0.5, 3, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data = {
 | 
						|
            None: self.generate_fixture_data(stat, 1, 0.3, 4, 0.5, 3, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["active_users_audit:is_bot:day"]
 | 
						|
        realm_data = {
 | 
						|
            "false": self.generate_fixture_data(stat, 1, 0.2, 3.5, 0.8, 2, partial_sum=True),
 | 
						|
            "true": self.generate_fixture_data(stat, 0.3, 0.05, 3, 0.3, 2, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data = {
 | 
						|
            "false": self.generate_fixture_data(stat, 3, 1, 4, 0.8, 2, partial_sum=True),
 | 
						|
            "true": self.generate_fixture_data(stat, 1, 0.4, 4, 0.8, 2, partial_sum=True),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["messages_sent:is_bot:hour"]
 | 
						|
        user_data: Mapping[Optional[str], List[int]] = {
 | 
						|
            "false": self.generate_fixture_data(stat, 2, 1, 1.5, 0.6, 8, holiday_rate=0.1),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, user_data, UserCount)
 | 
						|
        realm_data = {
 | 
						|
            "false": self.generate_fixture_data(stat, 35, 15, 6, 0.6, 4),
 | 
						|
            "true": self.generate_fixture_data(stat, 15, 15, 3, 0.4, 2),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data = {
 | 
						|
            "false": self.generate_fixture_data(stat, 350, 150, 6, 0.6, 4),
 | 
						|
            "true": self.generate_fixture_data(stat, 150, 150, 3, 0.4, 2),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["messages_sent:message_type:day"]
 | 
						|
        user_data = {
 | 
						|
            "public_stream": self.generate_fixture_data(stat, 1.5, 1, 3, 0.6, 8),
 | 
						|
            "private_message": self.generate_fixture_data(stat, 0.5, 0.3, 1, 0.6, 8),
 | 
						|
            "huddle_message": self.generate_fixture_data(stat, 0.2, 0.2, 2, 0.6, 8),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, user_data, UserCount)
 | 
						|
        realm_data = {
 | 
						|
            "public_stream": self.generate_fixture_data(stat, 30, 8, 5, 0.6, 4),
 | 
						|
            "private_stream": self.generate_fixture_data(stat, 7, 7, 5, 0.6, 4),
 | 
						|
            "private_message": self.generate_fixture_data(stat, 13, 5, 5, 0.6, 4),
 | 
						|
            "huddle_message": self.generate_fixture_data(stat, 6, 3, 3, 0.6, 4),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data = {
 | 
						|
            "public_stream": self.generate_fixture_data(stat, 300, 80, 5, 0.6, 4),
 | 
						|
            "private_stream": self.generate_fixture_data(stat, 70, 70, 5, 0.6, 4),
 | 
						|
            "private_message": self.generate_fixture_data(stat, 130, 50, 5, 0.6, 4),
 | 
						|
            "huddle_message": self.generate_fixture_data(stat, 60, 30, 3, 0.6, 4),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        website, created = Client.objects.get_or_create(name="website")
 | 
						|
        old_desktop, created = Client.objects.get_or_create(name="desktop app Linux 0.3.7")
 | 
						|
        android, created = Client.objects.get_or_create(name="ZulipAndroid")
 | 
						|
        iOS, created = Client.objects.get_or_create(name="ZulipiOS")
 | 
						|
        react_native, created = Client.objects.get_or_create(name="ZulipMobile")
 | 
						|
        API, created = Client.objects.get_or_create(name="API: Python")
 | 
						|
        zephyr_mirror, created = Client.objects.get_or_create(name="zephyr_mirror")
 | 
						|
        unused, created = Client.objects.get_or_create(name="unused")
 | 
						|
        long_webhook, created = Client.objects.get_or_create(name="ZulipLooooooooooongNameWebhook")
 | 
						|
 | 
						|
        stat = COUNT_STATS["messages_sent:client:day"]
 | 
						|
        user_data = {
 | 
						|
            website.id: self.generate_fixture_data(stat, 2, 1, 1.5, 0.6, 8),
 | 
						|
            zephyr_mirror.id: self.generate_fixture_data(stat, 0, 0.3, 1.5, 0.6, 8),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, user_data, UserCount)
 | 
						|
        realm_data = {
 | 
						|
            website.id: self.generate_fixture_data(stat, 30, 20, 5, 0.6, 3),
 | 
						|
            old_desktop.id: self.generate_fixture_data(stat, 5, 3, 8, 0.6, 3),
 | 
						|
            android.id: self.generate_fixture_data(stat, 5, 5, 2, 0.6, 3),
 | 
						|
            iOS.id: self.generate_fixture_data(stat, 5, 5, 2, 0.6, 3),
 | 
						|
            react_native.id: self.generate_fixture_data(stat, 5, 5, 10, 0.6, 3),
 | 
						|
            API.id: self.generate_fixture_data(stat, 5, 5, 5, 0.6, 3),
 | 
						|
            zephyr_mirror.id: self.generate_fixture_data(stat, 1, 1, 3, 0.6, 3),
 | 
						|
            unused.id: self.generate_fixture_data(stat, 0, 0, 0, 0, 0),
 | 
						|
            long_webhook.id: self.generate_fixture_data(stat, 5, 5, 2, 0.6, 3),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        installation_data = {
 | 
						|
            website.id: self.generate_fixture_data(stat, 300, 200, 5, 0.6, 3),
 | 
						|
            old_desktop.id: self.generate_fixture_data(stat, 50, 30, 8, 0.6, 3),
 | 
						|
            android.id: self.generate_fixture_data(stat, 50, 50, 2, 0.6, 3),
 | 
						|
            iOS.id: self.generate_fixture_data(stat, 50, 50, 2, 0.6, 3),
 | 
						|
            react_native.id: self.generate_fixture_data(stat, 5, 5, 10, 0.6, 3),
 | 
						|
            API.id: self.generate_fixture_data(stat, 50, 50, 5, 0.6, 3),
 | 
						|
            zephyr_mirror.id: self.generate_fixture_data(stat, 10, 10, 3, 0.6, 3),
 | 
						|
            unused.id: self.generate_fixture_data(stat, 0, 0, 0, 0, 0),
 | 
						|
            long_webhook.id: self.generate_fixture_data(stat, 50, 50, 2, 0.6, 3),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, installation_data, InstallationCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["messages_in_stream:is_bot:day"]
 | 
						|
        realm_data = {
 | 
						|
            "false": self.generate_fixture_data(stat, 30, 5, 6, 0.6, 4),
 | 
						|
            "true": self.generate_fixture_data(stat, 20, 2, 3, 0.2, 3),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        stream_data: Mapping[Optional[str], List[int]] = {
 | 
						|
            "false": self.generate_fixture_data(stat, 10, 7, 5, 0.6, 4),
 | 
						|
            "true": self.generate_fixture_data(stat, 5, 3, 2, 0.4, 2),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, stream_data, StreamCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 | 
						|
 | 
						|
        stat = COUNT_STATS["messages_read::hour"]
 | 
						|
        user_data = {
 | 
						|
            None: self.generate_fixture_data(stat, 7, 3, 2, 0.6, 8, holiday_rate=0.1),
 | 
						|
        }
 | 
						|
        insert_fixture_data(stat, user_data, UserCount)
 | 
						|
        realm_data = {None: self.generate_fixture_data(stat, 50, 35, 6, 0.6, 4)}
 | 
						|
        insert_fixture_data(stat, realm_data, RealmCount)
 | 
						|
        FillState.objects.create(
 | 
						|
            property=stat.property, end_time=last_end_time, state=FillState.DONE
 | 
						|
        )
 |