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.

user_counts: Add helper for updating billing records.

Sahil Batra19e95369c29c
diff --git a/zerver/actions/create_user.py b/zerver/actions/create_user.py
index fafad3a2ae3..a7d5ae1f07d 100644
--- a/zerver/actions/create_user.py
+++ b/zerver/actions/create_user.py
@@ -33,11 +33,14 @@ from zerver.lib.email_notifications import enqueue_welcome_emails, send_account_
from zerver.lib.exceptions import JsonableError
from zerver.lib.invites import notify_invites_changed
from zerver.lib.mention import silent_mention_syntax_for_user
-from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
from zerver.lib.send_email import clear_scheduled_invitation_emails
from zerver.lib.streams import can_access_stream_history
from zerver.lib.subscription_info import bulk_get_subscriber_peer_info
-from zerver.lib.user_counts import realm_user_count, realm_user_count_by_role
+from zerver.lib.user_counts import (
+ realm_user_count,
+ realm_user_count_by_role,
+ update_billing_records_if_needed,
+)
from zerver.lib.user_groups import get_system_user_group_for_user
from zerver.lib.users import (
can_access_delivery_email,
@@ -528,9 +531,6 @@ def do_create_user(
add_initial_stream_subscriptions: bool = True,
external_auth_id_dict: dict[str, str] | None = None,
) -> UserProfile:
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
user_profile = create_user(
email=email,
password=password,
@@ -615,11 +615,7 @@ def do_create_user(
event_time=event_time,
acting_user=acting_user,
)
- maybe_enqueue_audit_log_upload(user_profile.realm)
-
- if settings.BILLING_ENABLED:
- billing_session = RealmBillingSession(user=user_profile, realm=user_profile.realm)
- billing_session.update_license_ledger_if_needed(event_time)
+ update_billing_records_if_needed(user_profile.realm, user=user_profile, event_time=event_time)
# Note that for bots, the caller will send an additional event
# with bot-specific info like services.
@@ -683,9 +679,6 @@ def do_activate_mirror_dummy_user(
"""
assert user_profile.is_mirror_dummy
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
with transaction.atomic(savepoint=False):
change_user_is_active(user_profile, True)
user_profile.is_mirror_dummy = False
@@ -707,10 +700,9 @@ def do_activate_mirror_dummy_user(
RealmAuditLog.ROLE_COUNT: realm_user_count_by_role(user_profile.realm),
},
)
- maybe_enqueue_audit_log_upload(user_profile.realm)
- if settings.BILLING_ENABLED:
- billing_session = RealmBillingSession(user=user_profile, realm=user_profile.realm)
- billing_session.update_license_ledger_if_needed(event_time)
+ update_billing_records_if_needed(
+ user_profile.realm, user=user_profile, event_time=event_time
+ )
notify_created_user(user_profile, [])
@@ -739,8 +731,6 @@ def do_reactivate_user(user_profile: UserProfile, *, acting_user: UserProfile |
RealmAuditLog.ROLE_COUNT: realm_user_count_by_role(user_profile.realm),
},
)
- maybe_enqueue_audit_log_upload(user_profile.realm)
-
bot_owner_changed = False
if (
user_profile.is_bot
@@ -764,11 +754,7 @@ def do_reactivate_user(user_profile: UserProfile, *, acting_user: UserProfile |
)
bot_owner_changed = True
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
- billing_session = RealmBillingSession(user=user_profile, realm=user_profile.realm)
- billing_session.update_license_ledger_if_needed(event_time)
+ update_billing_records_if_needed(user_profile.realm, user=user_profile, event_time=event_time)
event = dict(
type="realm_user", op="update", person=dict(user_id=user_profile.id, is_active=True)
diff --git a/zerver/actions/realm_settings.py b/zerver/actions/realm_settings.py
index 0994f1b11a0..f6ae79ba3b2 100644
--- a/zerver/actions/realm_settings.py
+++ b/zerver/actions/realm_settings.py
@@ -27,7 +27,7 @@ from zerver.lib.timestamp import datetime_to_timestamp, timestamp_to_datetime
from zerver.lib.timezone import canonicalize_timezone
from zerver.lib.types import UserGroupMembersData
from zerver.lib.upload import delete_message_attachments
-from zerver.lib.user_counts import realm_user_count_by_role
+from zerver.lib.user_counts import realm_user_count_by_role, update_billing_records_if_needed
from zerver.lib.user_groups import (
convert_to_user_group_members_dict,
get_group_setting_value_for_api,
@@ -285,15 +285,7 @@ def do_change_realm_permission_group_setting(
},
)
- from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
-
- maybe_enqueue_audit_log_upload(realm)
-
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
- billing_session = RealmBillingSession(user=acting_user, realm=realm)
- billing_session.update_license_ledger_if_needed(event_time)
+ update_billing_records_if_needed(realm, user=acting_user, event_time=event_time)
def parse_and_set_setting_value_if_required(
diff --git a/zerver/actions/user_groups.py b/zerver/actions/user_groups.py
index 78c5fc7cd0b..ada1cf56bc9 100644
--- a/zerver/actions/user_groups.py
+++ b/zerver/actions/user_groups.py
@@ -3,7 +3,6 @@ from datetime import datetime
from typing import TypedDict
import django.db.utils
-from django.conf import settings
from django.db import transaction
from django.utils.timezone import now as timezone_now
from django.utils.translation import gettext as _
@@ -20,7 +19,7 @@ from zerver.lib.streams import (
)
from zerver.lib.timestamp import datetime_to_timestamp
from zerver.lib.types import UserGroupMembersData, UserGroupMembersDict
-from zerver.lib.user_counts import realm_user_count_by_role
+from zerver.lib.user_counts import realm_user_count_by_role, update_billing_records_if_needed
from zerver.lib.user_groups import (
convert_to_user_group_members_dict,
get_group_setting_value_for_api,
@@ -389,18 +388,10 @@ def bulk_add_members_to_user_groups(
},
)
- from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
-
- maybe_enqueue_audit_log_upload(realm)
-
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
- # acting_user is None for changes made by promote_new_full_members,
- # and a support admin from another realm for changes made via
- # /support; RealmBillingSession accepts both.
- billing_session = RealmBillingSession(user=acting_user, realm=realm)
- billing_session.update_license_ledger_if_needed(now)
+ # acting_user is None for changes made by promote_new_full_members, and
+ # a support admin from another realm for changes made via /support;
+ # RealmBillingSession accepts both.
+ update_billing_records_if_needed(realm, user=acting_user, event_time=now)
subscriber_ids_for_streams = get_user_ids_for_streams({stream.id for stream in streams})
new_stream_metadata_user_ids = bulk_can_access_stream_metadata_user_ids(streams)
@@ -490,18 +481,10 @@ def bulk_remove_members_from_user_groups(
},
)
- from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
-
- maybe_enqueue_audit_log_upload(realm)
-
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
- # acting_user is None for changes made by promote_new_full_members,
- # and a support admin from another realm for changes made via
- # /support; RealmBillingSession accepts both.
- billing_session = RealmBillingSession(user=acting_user, realm=realm)
- billing_session.update_license_ledger_if_needed(now)
+ # acting_user is None for changes made by promote_new_full_members, and
+ # a support admin from another realm for changes made via /support;
+ # RealmBillingSession accepts both.
+ update_billing_records_if_needed(realm, user=acting_user, event_time=now)
for user_group in user_groups:
do_send_user_group_members_update_event("remove_members", user_group, user_profile_ids)
@@ -586,18 +569,10 @@ def add_subgroups_to_user_group(
},
)
- from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
-
- maybe_enqueue_audit_log_upload(realm)
-
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
- # acting_user is None for changes made by promote_new_full_members,
- # and a support admin from another realm for changes made via
- # /support; RealmBillingSession accepts both.
- billing_session = RealmBillingSession(user=acting_user, realm=realm)
- billing_session.update_license_ledger_if_needed(now)
+ # acting_user is None for changes made by promote_new_full_members, and
+ # a support admin from another realm for changes made via /support;
+ # RealmBillingSession accepts both.
+ update_billing_records_if_needed(realm, user=acting_user, event_time=now)
subscriber_ids_for_streams = get_user_ids_for_streams({stream.id for stream in streams})
new_stream_metadata_user_ids = bulk_can_access_stream_metadata_user_ids(streams)
@@ -686,18 +661,10 @@ def remove_subgroups_from_user_group(
},
)
- from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
-
- maybe_enqueue_audit_log_upload(realm)
-
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
- # acting_user is None for changes made by promote_new_full_members,
- # and a support admin from another realm for changes made via
- # /support; RealmBillingSession accepts both.
- billing_session = RealmBillingSession(user=acting_user, realm=realm)
- billing_session.update_license_ledger_if_needed(now)
+ # acting_user is None for changes made by promote_new_full_members, and
+ # a support admin from another realm for changes made via /support;
+ # RealmBillingSession accepts both.
+ update_billing_records_if_needed(realm, user=acting_user, event_time=now)
do_send_subgroups_update_event("remove_subgroups", user_group, subgroup_ids)
diff --git a/zerver/actions/users.py b/zerver/actions/users.py
index 6019d51a8db..caf4e66ba67 100644
--- a/zerver/actions/users.py
+++ b/zerver/actions/users.py
@@ -2,7 +2,6 @@ from collections import defaultdict
from email.headerregistry import Address
from typing import Any
-from django.conf import settings
from django.contrib.auth.tokens import PasswordResetTokenGenerator, default_token_generator
from django.db import transaction
from django.db.models import Q
@@ -30,7 +29,6 @@ from zerver.lib.cache import bot_dict_fields, flush_user_profile
from zerver.lib.create_user import create_user_profile
from zerver.lib.event_types import BotServicesOutgoing
from zerver.lib.invites import revoke_invites_generated_by_user
-from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
from zerver.lib.send_email import FromAddress, clear_scheduled_emails, send_email
from zerver.lib.sessions import delete_user_sessions
from zerver.lib.soft_deactivation import queue_soft_reactivation
@@ -47,7 +45,7 @@ from zerver.lib.streams import (
)
from zerver.lib.subscription_info import bulk_get_subscriber_peer_info
from zerver.lib.types import UserGroupMembersData, UserProfileChangeDict
-from zerver.lib.user_counts import realm_user_count_by_role
+from zerver.lib.user_counts import realm_user_count_by_role, update_billing_records_if_needed
from zerver.lib.user_groups import (
convert_to_user_group_members_dict,
get_system_user_group_for_user,
@@ -479,9 +477,6 @@ def do_deactivate_user(
if not user_profile.is_active:
return
- if settings.BILLING_ENABLED:
- from corporate.lib.stripe import RealmBillingSession
-
if _cascade:
# We need to deactivate bots before the target user, to ensure
# that a failure partway through this function cannot result
@@ -536,10 +531,9 @@ def do_deactivate_user(
RealmAuditLog.ROLE_COUNT: realm_user_count_by_role(user_profile.realm),
},
)
- maybe_enqueue_audit_log_upload(user_profile.realm)
- if settings.BILLING_ENABLED:
- billing_session = RealmBillingSession(user=user_profile, realm=user_profile.realm)
- billing_session.update_license_ledger_if_needed(event_time)
+ update_billing_records_if_needed(
+ user_profile.realm, user=user_profile, event_time=event_time
+ )
transaction.on_commit(lambda: delete_user_sessions(user_profile))
@@ -712,22 +706,20 @@ def do_change_user_role(
)
role_changed_audit_log.save(update_fields=["extra_data"])
- maybe_enqueue_audit_log_upload(user_profile.realm)
# A guest becoming a non-guest or vice versa changes the number of licenses
# regardless of any group, since guests are counted at a discount. Any other
# role change only matters if it moved the user in or out of
# realm.workplace_users_group, which the swap between the role based system
# groups above does when either of them is that group or inside it.
- if settings.BILLING_ENABLED and (
- UserProfile.ROLE_GUEST in [old_value, value]
+ update_billing_records_if_needed(
+ user_profile.realm,
+ user=user_profile,
+ event_time=timezone_now(),
+ user_count_may_have_changed=UserProfile.ROLE_GUEST in [old_value, value]
or check_any_group_used_for_workplace_users_group(
user_profile.realm, [old_system_group, system_group]
- )
- ):
- from corporate.lib.stripe import RealmBillingSession
-
- billing_session = RealmBillingSession(user=user_profile, realm=user_profile.realm)
- billing_session.update_license_ledger_if_needed(timezone_now())
+ ),
+ )
send_stream_events_for_role_update(user_profile, previously_accessible_streams)
diff --git a/zerver/lib/user_counts.py b/zerver/lib/user_counts.py
index 0615d82b01e..b66f0a979df 100644
--- a/zerver/lib/user_counts.py
+++ b/zerver/lib/user_counts.py
@@ -1,5 +1,7 @@
+from datetime import datetime
from typing import Any
+from django.conf import settings
from django.db.models import Count
from zerver.lib.user_groups import get_recursive_group_members
@@ -87,3 +89,23 @@ def realm_user_count_by_role(realm: Realm) -> dict[str, Any]:
RealmAuditLog.ROLE_COUNT_HUMANS: human_counts,
RealmAuditLog.ROLE_COUNT_BOTS: bot_count,
}
+
+
+def update_billing_records_if_needed(
+ realm: Realm,
+ *,
+ user: UserProfile | None,
+ event_time: datetime,
+ user_count_may_have_changed: bool = True,
+) -> None:
+ # Imported here because zerver.lib.remote_server imports
+ # zerver.actions.realm_settings, which imports this module.
+ from zerver.lib.remote_server import maybe_enqueue_audit_log_upload
+
+ maybe_enqueue_audit_log_upload(realm)
+
+ if settings.BILLING_ENABLED and user_count_may_have_changed:
+ from corporate.lib.stripe import RealmBillingSession
+
+ billing_session = RealmBillingSession(user=user, realm=realm)
+ billing_session.update_license_ledger_if_needed(event_time)