actions: Split out zerver.actions.muted_users.

Signed-off-by: Anders Kaseorg <anders@zulip.com>

zerver/actions/muted_users.py

@@ -0,0 +1,49 @@
+import datetime
+from typing import Optional
+
+import orjson
+from django.utils.timezone import now as timezone_now
+
+from zerver.actions.message_flags import do_mark_muted_user_messages_as_read
+from zerver.lib.user_mutes import add_user_mute, get_user_mutes
+from zerver.models import MutedUser, RealmAuditLog, UserProfile
+from zerver.tornado.django_api import send_event
+
+
+def do_mute_user(
+    user_profile: UserProfile,
+    muted_user: UserProfile,
+    date_muted: Optional[datetime.datetime] = None,
+) -> None:
+    if date_muted is None:
+        date_muted = timezone_now()
+    add_user_mute(user_profile, muted_user, date_muted)
+    do_mark_muted_user_messages_as_read(user_profile, muted_user)
+    event = dict(type="muted_users", muted_users=get_user_mutes(user_profile))
+    send_event(user_profile.realm, event, [user_profile.id])
+
+    RealmAuditLog.objects.create(
+        realm=user_profile.realm,
+        acting_user=user_profile,
+        modified_user=user_profile,
+        event_type=RealmAuditLog.USER_MUTED,
+        event_time=date_muted,
+        extra_data=orjson.dumps({"muted_user_id": muted_user.id}).decode(),
+    )
+
+
+def do_unmute_user(mute_object: MutedUser) -> None:
+    user_profile = mute_object.user_profile
+    muted_user = mute_object.muted_user
+    mute_object.delete()
+    event = dict(type="muted_users", muted_users=get_user_mutes(user_profile))
+    send_event(user_profile.realm, event, [user_profile.id])
+
+    RealmAuditLog.objects.create(
+        realm=user_profile.realm,
+        acting_user=user_profile,
+        modified_user=user_profile,
+        event_type=RealmAuditLog.USER_UNMUTED,
+        event_time=timezone_now(),
+        extra_data=orjson.dumps({"unmuted_user_id": muted_user.id}).decode(),
+    )

zerver/lib/actions.py

@@ -14,10 +14,7 @@ from typing_extensions import TypedDict
 
 from confirmation.models import Confirmation, create_confirmation_link, generate_key
 from zerver.actions.custom_profile_fields import do_remove_realm_custom_profile_fields
-from zerver.actions.message_flags import (
+from zerver.actions.message_flags import do_update_mobile_push_notification
-    do_mark_muted_user_messages_as_read,
-    do_update_mobile_push_notification,
-)
 from zerver.actions.message_send import (
     filter_presence_idle_user_ids,
     get_recipient_info,
@@ -76,7 +73,6 @@ from zerver.lib.types import EditHistoryEvent
 from zerver.lib.user_counts import realm_user_count_by_role
 from zerver.lib.user_groups import create_system_user_groups_for_realm
 from zerver.lib.user_message import UserMessageLite, bulk_insert_ums
-from zerver.lib.user_mutes import add_user_mute, get_user_mutes
 from zerver.lib.user_topics import get_users_muting_topic, remove_topic_mute
 from zerver.lib.widget import is_widget_message
 from zerver.models import (
@@ -84,7 +80,6 @@ from zerver.models import (
     Attachment,
     DefaultStream,
     Message,
-    MutedUser,
     Reaction,
     Realm,
     RealmAuditLog,
@@ -1775,45 +1770,6 @@ def email_not_system_bot(email: str) -> None:
         )
 
 
-def do_mute_user(
-    user_profile: UserProfile,
-    muted_user: UserProfile,
-    date_muted: Optional[datetime.datetime] = None,
-) -> None:
-    if date_muted is None:
-        date_muted = timezone_now()
-    add_user_mute(user_profile, muted_user, date_muted)
-    do_mark_muted_user_messages_as_read(user_profile, muted_user)
-    event = dict(type="muted_users", muted_users=get_user_mutes(user_profile))
-    send_event(user_profile.realm, event, [user_profile.id])
-
-    RealmAuditLog.objects.create(
-        realm=user_profile.realm,
-        acting_user=user_profile,
-        modified_user=user_profile,
-        event_type=RealmAuditLog.USER_MUTED,
-        event_time=date_muted,
-        extra_data=orjson.dumps({"muted_user_id": muted_user.id}).decode(),
-    )
-
-
-def do_unmute_user(mute_object: MutedUser) -> None:
-    user_profile = mute_object.user_profile
-    muted_user = mute_object.muted_user
-    mute_object.delete()
-    event = dict(type="muted_users", muted_users=get_user_mutes(user_profile))
-    send_event(user_profile.realm, event, [user_profile.id])
-
-    RealmAuditLog.objects.create(
-        realm=user_profile.realm,
-        acting_user=user_profile,
-        modified_user=user_profile,
-        event_type=RealmAuditLog.USER_UNMUTED,
-        event_time=timezone_now(),
-        extra_data=orjson.dumps({"unmuted_user_id": muted_user.id}).decode(),
-    )
-
-
 @transaction.atomic(durable=True)
 def do_add_realm_domain(
     realm: Realm, domain: str, allow_subdomains: bool, *, acting_user: Optional[UserProfile]

zerver/tests/test_events.py

@@ -46,6 +46,7 @@ from zerver.actions.invites import (
     do_revoke_user_invite,
 )
 from zerver.actions.message_flags import do_update_message_flags
+from zerver.actions.muted_users import do_mute_user, do_unmute_user
 from zerver.actions.presence import do_update_user_presence, do_update_user_status
 from zerver.actions.reactions import do_add_reaction, do_remove_reaction
 from zerver.actions.realm_emoji import check_add_realm_emoji, do_remove_realm_emoji
@@ -99,7 +100,6 @@ from zerver.lib.actions import (
     do_change_realm_plan_type,
     do_deactivate_realm,
     do_delete_messages,
-    do_mute_user,
     do_remove_realm_domain,
     do_set_realm_authentication_methods,
     do_set_realm_message_editing,
@@ -107,7 +107,6 @@ from zerver.lib.actions import (
     do_set_realm_property,
     do_set_realm_signup_notifications_stream,
     do_set_realm_user_default_setting,
-    do_unmute_user,
     do_update_embedded_data,
     do_update_message,
 )

zerver/tests/test_import_export.py

@@ -16,6 +16,7 @@ from zerver.actions.custom_profile_fields import (
     do_update_user_custom_profile_data_if_changed,
     try_add_realm_custom_profile_field,
 )
+from zerver.actions.muted_users import do_mute_user
 from zerver.actions.presence import do_update_user_presence, do_update_user_status
 from zerver.actions.reactions import check_add_reaction, do_add_reaction
 from zerver.actions.realm_emoji import check_add_realm_emoji
@@ -25,7 +26,7 @@ from zerver.actions.user_activity import do_update_user_activity, do_update_user
 from zerver.actions.user_topics import do_mute_topic
 from zerver.actions.users import do_deactivate_user
 from zerver.lib import upload
-from zerver.lib.actions import do_change_realm_plan_type, do_mute_user
+from zerver.lib.actions import do_change_realm_plan_type
 from zerver.lib.avatar_hash import user_avatar_path
 from zerver.lib.bot_config import set_bot_config
 from zerver.lib.bot_lib import StateHandler

zerver/tests/test_muting_users.py

@@ -153,7 +153,7 @@ class MutedUsersTests(ZulipTestCase):
             result = self.api_post(hamlet, url)
             self.assert_json_success(result)
 
-        with mock.patch("zerver.lib.actions.timezone_now", return_value=mute_time):
+        with mock.patch("zerver.actions.muted_users.timezone_now", return_value=mute_time):
             # To test that `RealmAuditLog` entry has correct `event_time`.
             url = f"/api/v1/users/me/muted_users/{cordelia.id}"
             result = self.api_delete(hamlet, url)

zerver/tests/test_users.py

@@ -15,6 +15,7 @@ from confirmation.models import Confirmation
 from zerver.actions.create_user import do_create_user, do_reactivate_user
 from zerver.actions.invites import do_create_multiuse_invite_link, do_invite_users
 from zerver.actions.message_send import get_recipient_info
+from zerver.actions.muted_users import do_mute_user
 from zerver.actions.users import (
     change_user_is_active,
     do_change_can_create_users,
@@ -22,7 +23,7 @@ from zerver.actions.users import (
     do_deactivate_user,
     do_delete_user,
 )
-from zerver.lib.actions import do_mute_user, do_set_realm_property
+from zerver.lib.actions import do_set_realm_property
 from zerver.lib.avatar import avatar_url, get_gravatar_url
 from zerver.lib.bulk_create import create_users
 from zerver.lib.create_user import copy_default_settings

zerver/views/muting.py

@@ -6,8 +6,8 @@ from django.http import HttpRequest, HttpResponse
 from django.utils.timezone import now as timezone_now
 from django.utils.translation import gettext as _
 
+from zerver.actions.muted_users import do_mute_user, do_unmute_user
 from zerver.actions.user_topics import do_mute_topic, do_unmute_topic
-from zerver.lib.actions import do_mute_user, do_unmute_user
 from zerver.lib.exceptions import JsonableError
 from zerver.lib.request import REQ, has_request_variables
 from zerver.lib.response import json_success