Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

zilencer: Sync communities directory fields from uploaded realm data.

Prakhar Pratyushe45560dfcfc4
diff --git a/zerver/tests/test_zilencer_analytics.py b/zerver/tests/test_zilencer_analytics.py
index 2ee0c9830e1..a41dfa76d1a 100644
--- a/zerver/tests/test_zilencer_analytics.py
+++ b/zerver/tests/test_zilencer_analytics.py
@@ -1534,4 +1534,79 @@ class AdvertiseRealmDataTest(BouncerTestCase):
)
self.assert_json_success(result)
- # TODO: Extend it when implementing bouncer side of this feature.
+ @activate_push_notification_service()
+ @responses.activate
+ @override_settings(ZULIP_SERVICE_ADVERTISE_REALMS=True)
+ def test_directory_fields_synced_to_remote_realm(self) -> None:
+ self.add_mock_response()
+ realm = get_realm("zulip")
+
+ # Nothing is synced while the realm is not asking to be advertised.
+ self.assertFalse(realm.want_advertise_in_communities_directory)
+ send_server_data_to_push_bouncer(consider_usage_statistics=False)
+ remote_realm = RemoteRealm.objects.get(uuid=realm.uuid)
+ self.assertFalse(remote_realm.communities_directory_listing_requested)
+ self.assertEqual(remote_realm.description, "")
+ self.assertEqual(remote_realm.icon_url, "")
+
+ # Now the realm is asking to be advertised.
+ do_set_realm_property(
+ realm, "want_advertise_in_communities_directory", True, acting_user=None
+ )
+ do_set_realm_property(realm, "description", "A place to talk about Zulip", acting_user=None)
+ do_set_realm_property(realm, "invite_required", False, acting_user=None)
+ send_server_data_to_push_bouncer(consider_usage_statistics=False)
+
+ remote_realm.refresh_from_db()
+ self.assertTrue(remote_realm.communities_directory_listing_requested)
+ self.assertEqual(remote_realm.description, "A place to talk about Zulip")
+ # The bouncer fetches this URL, so it always has to be absolute.
+ self.assertTrue(remote_realm.icon_url.startswith(("http://", "https://")))
+ self.assertFalse(remote_realm.invite_required)
+ self.assertFalse(remote_realm.emails_restricted_to_domains)
+ self.assertTrue(remote_realm.has_web_public_streams)
+ self.assertFalse(remote_realm.is_demo_organization)
+
+ # Later edits are synced too.
+ do_set_realm_property(realm, "description", "An edited description", acting_user=None)
+ do_set_realm_property(realm, "invite_required", True, acting_user=None)
+ send_server_data_to_push_bouncer(consider_usage_statistics=False)
+
+ remote_realm.refresh_from_db()
+ self.assertEqual(remote_realm.description, "An edited description")
+ self.assertTrue(remote_realm.invite_required)
+ self.assertEqual(
+ [
+ audit_log.extra_data
+ for audit_log in RemoteRealmAuditLog.objects.filter(
+ remote_realm=remote_realm,
+ event_type=AuditLogEventType.REMOTE_REALM_VALUE_UPDATED,
+ ).order_by("id")
+ if audit_log.extra_data["attr_name"] in ("description", "invite_required")
+ ],
+ [
+ {
+ "attr_name": "description",
+ "old_value": "",
+ "new_value": "A place to talk about Zulip",
+ },
+ {"attr_name": "invite_required", "old_value": True, "new_value": False},
+ {
+ "attr_name": "description",
+ "old_value": "A place to talk about Zulip",
+ "new_value": "An edited description",
+ },
+ {"attr_name": "invite_required", "old_value": False, "new_value": True},
+ ],
+ )
+
+ # Opting out stops syncing. The values bouncer last saw are kept.
+ do_set_realm_property(
+ realm, "want_advertise_in_communities_directory", False, acting_user=None
+ )
+ do_set_realm_property(realm, "description", "Final edit", acting_user=None)
+ send_server_data_to_push_bouncer(consider_usage_statistics=False)
+
+ remote_realm.refresh_from_db()
+ self.assertFalse(remote_realm.communities_directory_listing_requested)
+ self.assertEqual(remote_realm.description, "An edited description")
diff --git a/zilencer/views.py b/zilencer/views.py
index 09c430720ac..00d4715920f 100644
--- a/zilencer/views.py
+++ b/zilencer/views.py
@@ -75,6 +75,7 @@ from zerver.lib.push_notifications import (
from zerver.lib.queue import queue_event_on_commit
from zerver.lib.rate_limiter import rate_limit_endpoint_absolute, rate_limit_request_by_ip
from zerver.lib.remote_server import (
+ AdvertiseRealmData,
InstallationCountDataForAnalytics,
RealmAuditLogDataForAnalytics,
RealmCountDataForAnalytics,
@@ -1224,6 +1225,29 @@ def ensure_devices_set_remote_realm(
RemotePushDeviceToken.objects.bulk_update(devices_to_update, ["remote_realm"])
+def get_communities_directory_fields(
+ advertise_realm_data: AdvertiseRealmData | None,
+) -> dict[str, str | bool]:
+ """The RemoteRealm values mirroring what a realm publishes about itself for
+ the communities directory.
+
+ A realm that is not asking to be listed uploads none of this, so there is
+ nothing to sync; we keep the values we last saw, which nothing reads while
+ communities_directory_listing_requested is False.
+ """
+ if advertise_realm_data is None:
+ return {}
+
+ return {
+ "description": advertise_realm_data.description or "",
+ "icon_url": advertise_realm_data.icon_url,
+ "invite_required": advertise_realm_data.invite_required,
+ "emails_restricted_to_domains": advertise_realm_data.emails_restricted_to_domains,
+ "has_web_public_streams": advertise_realm_data.has_web_public_streams,
+ "is_demo_organization": advertise_realm_data.is_demo_organization,
+ }
+
+
def update_remote_realm_data_for_server(
server: RemoteZulipServer, server_realms_info: list[RealmDataForAnalytics]
) -> None:
@@ -1261,6 +1285,8 @@ def update_remote_realm_data_for_server(
name=realm.name,
authentication_methods=realm.authentication_methods,
is_system_bot_realm=realm.is_system_bot_realm,
+ communities_directory_listing_requested=realm.advertise_realm_data is not None,
+ **get_communities_directory_fields(realm.advertise_realm_data),
)
for realm in server_realms_info
if realm.uuid not in already_registered_uuids
@@ -1293,6 +1319,13 @@ def update_remote_realm_data_for_server(
("authentication_methods", realm.authentication_methods),
("realm_deactivated", realm.deactivated),
("is_system_bot_realm", realm.is_system_bot_realm),
+ # Uploading no directory data at all is how a realm, or its
+ # server, says it no longer wants to be advertised.
+ (
+ "communities_directory_listing_requested",
+ realm.advertise_realm_data is not None,
+ ),
+ *get_communities_directory_fields(realm.advertise_realm_data).items(),
]:
old_value = getattr(remote_realm, remote_realm_attr)
@@ -1344,6 +1377,13 @@ def update_remote_realm_data_for_server(
"org_type",
"is_system_bot_realm",
"realm_locally_deleted",
+ "communities_directory_listing_requested",
+ "description",
+ "icon_url",
+ "invite_required",
+ "emails_restricted_to_domains",
+ "has_web_public_streams",
+ "is_demo_organization",
],
)
RemoteRealmAuditLog.objects.bulk_create(remote_realm_audit_logs)