onboarding: Don't show introduce zulip view modals to existing users.

We don't want to show one-time modals introducing 'Inbox' and
'Recent conversations' views to existing users.

When a user views a modal, we mark it as read by storing a row
in the 'OnboardingStep' model. Once marked as read, the user will
no longer see the modal.

This commit adds a migration to create
two rows per user (mark them as read) in OnboardingStep model.
This commit is contained in:
Prakhar Pratyush
2024-03-11 13:09:56 +05:30
committed by Tim Abbott
parent ad3603c0aa
commit de53e372dd

View File

@@ -0,0 +1,75 @@
# Generated by Django 4.2.10 on 2024-03-11 04:43
from django.db import connection, migrations
from django.db.backends.base.schema import BaseDatabaseSchemaEditor
from django.db.migrations.state import StateApps
from django.db.models import Q
from django.utils.timezone import now as timezone_now
from psycopg2.sql import SQL
def mark_introduce_zulip_view_modals_as_read(
apps: StateApps, schema_editor: BaseDatabaseSchemaEditor
) -> None:
with connection.cursor() as cursor:
cursor.execute(
SQL(
"SELECT MAX(id) FROM zerver_userprofile WHERE is_bot = False AND is_mirror_dummy = False;"
)
)
(max_id,) = cursor.fetchone()
if max_id is None:
return
BATCH_SIZE = 10000
lower_id_bound = 0
timestamp_value = timezone_now()
while lower_id_bound < max_id:
upper_id_bound = min(lower_id_bound + BATCH_SIZE, max_id)
with connection.cursor() as cursor:
query = SQL("""
INSERT INTO zerver_onboardingstep (user_id, onboarding_step, timestamp)
SELECT id, step, %(timestamp_value)s
FROM zerver_userprofile
CROSS JOIN UNNEST(%(step_names)s) step
WHERE is_bot = False
AND is_mirror_dummy = False
AND id > %(lower_id_bound)s AND id <= %(upper_id_bound)s;
""")
cursor.execute(
query,
{
"timestamp_value": timestamp_value,
"step_names": ["intro_inbox_view_modal", "intro_recent_view_modal"],
"lower_id_bound": lower_id_bound,
"upper_id_bound": upper_id_bound,
},
)
print(f"Processed {upper_id_bound} / {max_id}")
lower_id_bound = lower_id_bound + BATCH_SIZE
def mark_introduce_zulip_view_modals_as_unread(
apps: StateApps, schema_editor: BaseDatabaseSchemaEditor
) -> None:
OnboardingStep = apps.get_model("zerver", "OnboardingStep")
OnboardingStep.objects.filter(
Q(onboarding_step="intro_inbox_view_modal") | Q(onboarding_step="intro_recent_view_modal")
).delete()
class Migration(migrations.Migration):
atomic = False
dependencies = [
("zerver", "0500_realm_zulip_update_announcements_stream"),
]
operations = [
migrations.RunPython(
mark_introduce_zulip_view_modals_as_read,
reverse_code=mark_introduce_zulip_view_modals_as_unread,
),
]