Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

zilencer: Add mechanism to update RemoteRealm when Realm is changed. 

This requires a migration to allow RemoteRealmAuditLog.remote_id to be
NULL, and to add a RemoteRealmAuditLog.remote_realm.
This commit is contained in:
Mateusz Mandera 2023-11-08 20:02:10 +01:00 committed by Tim Abbott
parent 76e0511481
commit 1312c7ccd7
5 changed files with 144 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
zerver/models.py
View File

@ -4795,6 +4795,11 @@ class AbstractRealmAuditLog(models.Model):
REMOTE_SERVER_PLAN_TYPE_CHANGED = 10204
REMOTE_SERVER_DEACTIVATED = 10201
# This value is for RemoteRealmAuditLog entries tracking changes to the
# RemoteRealm model resulting from modified realm information sent to us
# via send_analytics_to_push_bouncer.
REMOTE_REALM_VALUE_UPDATED = 20001
event_type = models.PositiveSmallIntegerField()
# event_types synced from on-prem installations to Zulip Cloud when

68
zerver/tests/test_push_notifications.py
View File

@ -27,6 +27,7 @@ from analytics.lib.counts import CountStat, LoggingCountStat
from analytics.models import InstallationCount, RealmCount
from zerver.actions.message_delete import do_delete_messages
from zerver.actions.message_flags import do_mark_stream_messages_as_read, do_update_message_flags
from zerver.actions.realm_settings import do_deactivate_realm
from zerver.actions.user_groups import check_add_user_group
from zerver.actions.user_settings import do_change_user_setting, do_regenerate_api_key
from zerver.actions.user_topics import do_set_user_topic_visibility_policy
@ -1044,9 +1045,64 @@ class AnalyticsBouncerTest(BouncerTestCase):
],
)
# Modify a realm and verify the remote realm data that should get updated, get updated.
zephyr_realm = get_realm("zephyr")
zephyr_original_host = zephyr_realm.host
zephyr_realm.string_id = "zephyr2"
# date_created can't be updated.
original_date_created = zephyr_realm.date_created
zephyr_realm.date_created = now()
zephyr_realm.save()
# Deactivation is synced.
do_deactivate_realm(zephyr_realm, acting_user=None)
send_analytics_to_push_bouncer()
check_counts(3, 3, 1, 1, 4)
zephyr_remote_realm = RemoteRealm.objects.get(uuid=zephyr_realm.uuid)
self.assertEqual(zephyr_remote_realm.host, zephyr_realm.host)
self.assertEqual(zephyr_remote_realm.realm_date_created, original_date_created)
self.assertEqual(zephyr_remote_realm.realm_deactivated, True)
# Verify the RemoteRealmAuditLog entries created.
remote_audit_logs = (
RemoteRealmAuditLog.objects.filter(
event_type=RemoteRealmAuditLog.REMOTE_REALM_VALUE_UPDATED
)
.order_by("id")
.values("event_type", "remote_id", "realm_id", "extra_data")
)
self.assertEqual(
list(remote_audit_logs),
[
dict(
event_type=RemoteRealmAuditLog.REMOTE_REALM_VALUE_UPDATED,
remote_id=None,
realm_id=zephyr_realm.id,
extra_data={
"attr_name": "host",
"old_value": zephyr_original_host,
"new_value": zephyr_realm.host,
},
),
dict(
event_type=RemoteRealmAuditLog.REMOTE_REALM_VALUE_UPDATED,
remote_id=None,
realm_id=zephyr_realm.id,
extra_data={
"attr_name": "realm_deactivated",
"old_value": False,
"new_value": True,
},
),
],
)
# Test having no new rows
send_analytics_to_push_bouncer()
check_counts(3, 2, 1, 1, 1)
check_counts(4, 3, 1, 1, 4)
# Test only having new RealmCount rows
RealmCount.objects.create(
@ -1062,14 +1118,14 @@ class AnalyticsBouncerTest(BouncerTestCase):
value=9,
)
send_analytics_to_push_bouncer()
check_counts(4, 3, 3, 1, 1)
check_counts(5, 4, 3, 1, 4)
# Test only having new InstallationCount rows
InstallationCount.objects.create(
property=realm_stat.property, end_time=end_time + datetime.timedelta(days=1), value=6
)
send_analytics_to_push_bouncer()
check_counts(5, 4, 3, 2, 1)
check_counts(6, 5, 3, 2, 4)
# Test only having new RealmAuditLog rows
# Non-synced event
@ -1081,7 +1137,7 @@ class AnalyticsBouncerTest(BouncerTestCase):
extra_data={"data": "foo"},
)
send_analytics_to_push_bouncer()
check_counts(6, 4, 3, 2, 1)
check_counts(7, 5, 3, 2, 4)
# Synced event
RealmAuditLog.objects.create(
realm=user.realm,
@ -1093,7 +1149,7 @@ class AnalyticsBouncerTest(BouncerTestCase):
},
)
send_analytics_to_push_bouncer()
check_counts(7, 5, 3, 2, 2)
check_counts(8, 6, 3, 2, 5)
# Now create an InstallationCount with a property that's not supposed
# to be tracked by the remote server - since the bouncer itself tracks
@ -1112,7 +1168,7 @@ class AnalyticsBouncerTest(BouncerTestCase):
)
# The analytics endpoint call counts increase by 1, but the actual RemoteCounts remain unchanged,
# since syncing the data failed.
check_counts(8, 6, 3, 2, 2)
check_counts(9, 7, 3, 2, 5)
forbidden_installation_count.delete()
(realm_count_data, installation_count_data, realmauditlog_data) = build_analytics_data(

25
zilencer/migrations/0034_remoterealmauditlog_remote_realm_and_more.py Normal file
View File

@ -0,0 +1,25 @@
# Generated by Django 4.2.6 on 2023-11-08 23:17
import django.db.models.deletion
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
("zilencer", "0033_remoterealm"),
]
operations = [
migrations.AddField(
model_name="remoterealmauditlog",
name="remote_realm",
field=models.ForeignKey(
null=True, on_delete=django.db.models.deletion.CASCADE, to="zilencer.remoterealm"
),
),
migrations.AlterField(
model_name="remoterealmauditlog",
name="remote_id",
field=models.IntegerField(null=True),
),
]

6
zilencer/models.py
View File

@ -142,9 +142,13 @@ class RemoteRealmAuditLog(AbstractRealmAuditLog):
"""
server = models.ForeignKey(RemoteZulipServer, on_delete=models.CASCADE)
# For pre-8.0 servers, we might only have the realm ID.
realm_id = models.IntegerField()
# With newer servers, we can link to the RemoteRealm object.
remote_realm = models.ForeignKey(RemoteRealm, on_delete=models.CASCADE, null=True)
# The remote_id field lets us deduplicate data from the remote server
remote_id = models.IntegerField()
remote_id = models.IntegerField(null=True)
@override
def __str__(self) -> str:

53
zilencer/views.py
View File

@ -507,12 +507,10 @@ def update_remote_realm_data_for_server(
server: RemoteZulipServer, server_realms_info: List[Dict[str, Any]]
) -> None:
uuids = [realm["uuid"] for realm in server_realms_info]
already_registered_uuids = set(
str(uuid)
for uuid in RemoteRealm.objects.filter(uuid__in=uuids, server=server).values_list(
"uuid", flat=True
)
)
already_registered_remote_realms = RemoteRealm.objects.filter(uuid__in=uuids, server=server)
already_registered_uuids = {
str(remote_realm.uuid) for remote_realm in already_registered_remote_realms
}
new_remote_realms = [
RemoteRealm(
@ -532,6 +530,49 @@ def update_remote_realm_data_for_server(
except IntegrityError:
raise JsonableError(_("Duplicate registration detected."))
uuid_to_realm_dict = {str(realm["uuid"]): realm for realm in server_realms_info}
remote_realms_to_update = []
remote_realm_audit_logs = []
now = timezone_now()
# Update RemoteRealm entries, for which the corresponding realm's info has changed
# (for the attributes that make sense to sync like this).
for remote_realm in already_registered_remote_realms:
modified = False
realm = uuid_to_realm_dict[str(remote_realm.uuid)]
for remote_realm_attr, realm_dict_key in [
("host", "host"),
("realm_deactivated", "deactivated"),
]:
old_value = getattr(remote_realm, remote_realm_attr)
new_value = realm[realm_dict_key]
if old_value == new_value:
continue
setattr(remote_realm, remote_realm_attr, new_value)
remote_realm_audit_logs.append(
RemoteRealmAuditLog(
server=server,
remote_id=None,
remote_realm=remote_realm,
realm_id=realm["id"],
event_type=RemoteRealmAuditLog.REMOTE_REALM_VALUE_UPDATED,
event_time=now,
extra_data={
"attr_name": remote_realm_attr,
"old_value": old_value,
"new_value": new_value,
},
)
)
modified = True
if modified:
remote_realms_to_update.append(remote_realm)
RemoteRealm.objects.bulk_update(remote_realms_to_update, ["host", "realm_deactivated"])
RemoteRealmAuditLog.objects.bulk_create(remote_realm_audit_logs)
@has_request_variables
def remote_server_post_analytics(