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

billing: Rename AuditLogEventType to BillingSessionEventType. 

This enum class is used only in billing code for mapping billing
actions to audit log event types, so the class name should clearly
reflect that.
This commit is contained in:
Lauryn Menard 2024-08-29 20:48:40 +02:00 committed by Tim Abbott
parent 48b60db4a4
commit c0100a3c4c
2 changed files with 76 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
corporate/lib/stripe.py
View File

@ -7,7 +7,7 @@ from collections.abc import Callable, Generator
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime, timedelta, timezone from datetime import datetime, timedelta, timezone
from decimal import Decimal from decimal import Decimal
from enum import Enum from enum import Enum, IntEnum
from functools import wraps from functools import wraps
from typing import Any, Literal, TypedDict, TypeVar from typing import Any, Literal, TypedDict, TypeVar
from urllib.parse import urlencode, urljoin from urllib.parse import urlencode, urljoin
@ -601,7 +601,7 @@ class SupportViewRequest(TypedDict, total=False):
sent_invoice_id: str | None sent_invoice_id: str | None
class AuditLogEventType(Enum): class BillingSessionEventType(IntEnum):
STRIPE_CUSTOMER_CREATED = 1 STRIPE_CUSTOMER_CREATED = 1
STRIPE_CARD_CHANGED = 2 STRIPE_CARD_CHANGED = 2
CUSTOMER_PLAN_CREATED = 3 CUSTOMER_PLAN_CREATED = 3
@ -623,7 +623,7 @@ class PlanTierChangeType(Enum):
class BillingSessionAuditLogEventError(Exception): class BillingSessionAuditLogEventError(Exception):
def __init__(self, event_type: AuditLogEventType) -> None: def __init__(self, event_type: BillingSessionEventType) -> None:
self.message = f"Unknown audit log event type: {event_type}" self.message = f"Unknown audit log event type: {event_type}"
super().__init__(self.message) super().__init__(self.message)
@ -741,13 +741,13 @@ class BillingSession(ABC):
pass pass
@abstractmethod @abstractmethod
def get_audit_log_event(self, event_type: AuditLogEventType) -> int: def get_audit_log_event(self, event_type: BillingSessionEventType) -> int:
pass pass
@abstractmethod @abstractmethod
def write_to_audit_log( def write_to_audit_log(
self, self,
event_type: AuditLogEventType, event_type: BillingSessionEventType,
event_time: datetime, event_time: datetime,
*, *,
background_update: bool = False, background_update: bool = False,
@ -1094,7 +1094,7 @@ class BillingSession(ABC):
) )
event_time = timestamp_to_datetime(stripe_customer.created) event_time = timestamp_to_datetime(stripe_customer.created)
with transaction.atomic(): with transaction.atomic():
self.write_to_audit_log(AuditLogEventType.STRIPE_CUSTOMER_CREATED, event_time) self.write_to_audit_log(BillingSessionEventType.STRIPE_CUSTOMER_CREATED, event_time)
customer = self.update_or_create_customer(stripe_customer.id) customer = self.update_or_create_customer(stripe_customer.id)
return customer return customer
@ -1105,7 +1105,7 @@ class BillingSession(ABC):
stripe.Customer.modify( stripe.Customer.modify(
stripe_customer_id, invoice_settings={"default_payment_method": payment_method} stripe_customer_id, invoice_settings={"default_payment_method": payment_method}
) )
self.write_to_audit_log(AuditLogEventType.STRIPE_CARD_CHANGED, timezone_now()) self.write_to_audit_log(BillingSessionEventType.STRIPE_CARD_CHANGED, timezone_now())
if pay_invoices: if pay_invoices:
for stripe_invoice in stripe.Invoice.list( for stripe_invoice in stripe.Invoice.list(
collection_method="charge_automatically", collection_method="charge_automatically",
@ -1323,7 +1323,7 @@ class BillingSession(ABC):
self.apply_discount_to_plan(next_plan, customer) self.apply_discount_to_plan(next_plan, customer)
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.DISCOUNT_CHANGED, event_type=BillingSessionEventType.DISCOUNT_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={ extra_data={
"old_monthly_discounted_price": old_monthly_discounted_price, "old_monthly_discounted_price": old_monthly_discounted_price,
@ -1364,7 +1364,7 @@ class BillingSession(ABC):
customer.save(update_fields=["minimum_licenses"]) customer.save(update_fields=["minimum_licenses"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PROPERTY_CHANGED, event_type=BillingSessionEventType.CUSTOMER_PROPERTY_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={ extra_data={
"old_value": previous_minimum_license_count, "old_value": previous_minimum_license_count,
@ -1403,7 +1403,7 @@ class BillingSession(ABC):
) )
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PROPERTY_CHANGED, event_type=BillingSessionEventType.CUSTOMER_PROPERTY_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={ extra_data={
"old_value": previous_required_plan_tier, "old_value": previous_required_plan_tier,
@ -1485,7 +1485,7 @@ class BillingSession(ABC):
**fixed_price_plan_params, **fixed_price_plan_params,
) )
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data=fixed_price_plan_params, extra_data=fixed_price_plan_params,
) )
@ -1520,7 +1520,7 @@ class BillingSession(ABC):
**fixed_price_plan_params, **fixed_price_plan_params,
) )
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data=fixed_price_plan_params, extra_data=fixed_price_plan_params,
) )
@ -1533,7 +1533,7 @@ class BillingSession(ABC):
customer.sponsorship_pending = sponsorship_pending customer.sponsorship_pending = sponsorship_pending
customer.save(update_fields=["sponsorship_pending"]) customer.save(update_fields=["sponsorship_pending"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED, event_type=BillingSessionEventType.SPONSORSHIP_PENDING_STATUS_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={"sponsorship_pending": sponsorship_pending}, extra_data={"sponsorship_pending": sponsorship_pending},
) )
@ -1554,7 +1554,7 @@ class BillingSession(ABC):
plan.charge_automatically = charge_automatically plan.charge_automatically = charge_automatically
plan.save(update_fields=["charge_automatically"]) plan.save(update_fields=["charge_automatically"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.BILLING_MODALITY_CHANGED, event_type=BillingSessionEventType.BILLING_MODALITY_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={"charge_automatically": charge_automatically}, extra_data={"charge_automatically": charge_automatically},
) )
@ -1613,7 +1613,7 @@ class BillingSession(ABC):
def write_to_audit_log_plan_property_changed(extra_data: dict[str, Any]) -> None: def write_to_audit_log_plan_property_changed(extra_data: dict[str, Any]) -> None:
extra_data["plan_id"] = plan.id extra_data["plan_id"] = plan.id
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED, event_type=BillingSessionEventType.CUSTOMER_PLAN_PROPERTY_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data=extra_data, extra_data=extra_data,
) )
@ -1885,7 +1885,7 @@ class BillingSession(ABC):
) )
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=event_time, event_time=event_time,
extra_data=plan_params, extra_data=plan_params,
) )
@ -2093,7 +2093,7 @@ class BillingSession(ABC):
if schedule == CustomerPlan.BILLING_SCHEDULE_ANNUAL: if schedule == CustomerPlan.BILLING_SCHEDULE_ANNUAL:
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN, event_type=BillingSessionEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={ extra_data={
"monthly_plan_id": plan.id, "monthly_plan_id": plan.id,
@ -2102,7 +2102,7 @@ class BillingSession(ABC):
) )
else: else:
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN, event_type=BillingSessionEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={ extra_data={
"annual_plan_id": plan.id, "annual_plan_id": plan.id,
@ -2248,7 +2248,7 @@ class BillingSession(ABC):
) )
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN, event_type=BillingSessionEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN,
event_time=event_time, event_time=event_time,
extra_data={ extra_data={
"monthly_plan_id": plan.id, "monthly_plan_id": plan.id,
@ -2293,7 +2293,7 @@ class BillingSession(ABC):
) )
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN, event_type=BillingSessionEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN,
event_time=event_time, event_time=event_time,
extra_data={ extra_data={
"annual_plan_id": plan.id, "annual_plan_id": plan.id,
@ -3684,7 +3684,7 @@ class BillingSession(ABC):
legacy_plan.invoiced_through = ledger_entry legacy_plan.invoiced_through = ledger_entry
legacy_plan.save(update_fields=["invoiced_through"]) legacy_plan.save(update_fields=["invoiced_through"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=legacy_plan_anchor, event_time=legacy_plan_anchor,
extra_data=legacy_plan_params, extra_data=legacy_plan_params,
) )
@ -3739,7 +3739,7 @@ class BillingSession(ABC):
community_plan.invoiced_through = ledger_entry community_plan.invoiced_through = ledger_entry
community_plan.save(update_fields=["invoiced_through"]) community_plan.save(update_fields=["invoiced_through"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=now, event_time=now,
extra_data=community_plan_params, extra_data=community_plan_params,
) )
@ -3825,28 +3825,28 @@ class RealmBillingSession(BillingSession):
return get_latest_seat_count(self.realm) return get_latest_seat_count(self.realm)
@override @override
def get_audit_log_event(self, event_type: AuditLogEventType) -> int: def get_audit_log_event(self, event_type: BillingSessionEventType) -> int:
if event_type is AuditLogEventType.STRIPE_CUSTOMER_CREATED: if event_type is BillingSessionEventType.STRIPE_CUSTOMER_CREATED:
return RealmAuditLog.STRIPE_CUSTOMER_CREATED return RealmAuditLog.STRIPE_CUSTOMER_CREATED
elif event_type is AuditLogEventType.STRIPE_CARD_CHANGED: elif event_type is BillingSessionEventType.STRIPE_CARD_CHANGED:
return RealmAuditLog.STRIPE_CARD_CHANGED return RealmAuditLog.STRIPE_CARD_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PLAN_CREATED: elif event_type is BillingSessionEventType.CUSTOMER_PLAN_CREATED:
return RealmAuditLog.CUSTOMER_PLAN_CREATED return RealmAuditLog.CUSTOMER_PLAN_CREATED
elif event_type is AuditLogEventType.DISCOUNT_CHANGED: elif event_type is BillingSessionEventType.DISCOUNT_CHANGED:
return RealmAuditLog.REALM_DISCOUNT_CHANGED return RealmAuditLog.REALM_DISCOUNT_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PROPERTY_CHANGED: elif event_type is BillingSessionEventType.CUSTOMER_PROPERTY_CHANGED:
return RealmAuditLog.CUSTOMER_PROPERTY_CHANGED return RealmAuditLog.CUSTOMER_PROPERTY_CHANGED
elif event_type is AuditLogEventType.SPONSORSHIP_APPROVED: elif event_type is BillingSessionEventType.SPONSORSHIP_APPROVED:
return RealmAuditLog.REALM_SPONSORSHIP_APPROVED return RealmAuditLog.REALM_SPONSORSHIP_APPROVED
elif event_type is AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED: elif event_type is BillingSessionEventType.SPONSORSHIP_PENDING_STATUS_CHANGED:
return RealmAuditLog.REALM_SPONSORSHIP_PENDING_STATUS_CHANGED return RealmAuditLog.REALM_SPONSORSHIP_PENDING_STATUS_CHANGED
elif event_type is AuditLogEventType.BILLING_MODALITY_CHANGED: elif event_type is BillingSessionEventType.BILLING_MODALITY_CHANGED:
return RealmAuditLog.REALM_BILLING_MODALITY_CHANGED return RealmAuditLog.REALM_BILLING_MODALITY_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED: elif event_type is BillingSessionEventType.CUSTOMER_PLAN_PROPERTY_CHANGED:
return RealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED # nocoverage return RealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN: elif event_type is BillingSessionEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN:
return RealmAuditLog.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN return RealmAuditLog.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN
elif event_type is AuditLogEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN: elif event_type is BillingSessionEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN:
return RealmAuditLog.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN return RealmAuditLog.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN
else: else:
raise BillingSessionAuditLogEventError(event_type) raise BillingSessionAuditLogEventError(event_type)
@ -3854,7 +3854,7 @@ class RealmBillingSession(BillingSession):
@override @override
def write_to_audit_log( def write_to_audit_log(
self, self,
event_type: AuditLogEventType, event_type: BillingSessionEventType,
event_time: datetime, event_time: datetime,
*, *,
background_update: bool = False, background_update: bool = False,
@ -3985,7 +3985,7 @@ class RealmBillingSession(BillingSession):
customer.sponsorship_pending = False customer.sponsorship_pending = False
customer.save(update_fields=["sponsorship_pending"]) customer.save(update_fields=["sponsorship_pending"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.SPONSORSHIP_APPROVED, event_time=timezone_now() event_type=BillingSessionEventType.SPONSORSHIP_APPROVED, event_time=timezone_now()
) )
notification_bot = get_system_bot(settings.NOTIFICATION_BOT, self.realm.id) notification_bot = get_system_bot(settings.NOTIFICATION_BOT, self.realm.id)
for user in self.realm.get_human_billing_admin_and_realm_owner_users(): for user in self.realm.get_human_billing_admin_and_realm_owner_users():
@ -4201,33 +4201,33 @@ class RemoteRealmBillingSession(BillingSession):
) )
@override @override
def get_audit_log_event(self, event_type: AuditLogEventType) -> int: def get_audit_log_event(self, event_type: BillingSessionEventType) -> int:
if event_type is AuditLogEventType.STRIPE_CUSTOMER_CREATED: if event_type is BillingSessionEventType.STRIPE_CUSTOMER_CREATED:
return RemoteRealmAuditLog.STRIPE_CUSTOMER_CREATED return RemoteRealmAuditLog.STRIPE_CUSTOMER_CREATED
elif event_type is AuditLogEventType.STRIPE_CARD_CHANGED: elif event_type is BillingSessionEventType.STRIPE_CARD_CHANGED:
return RemoteRealmAuditLog.STRIPE_CARD_CHANGED return RemoteRealmAuditLog.STRIPE_CARD_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PLAN_CREATED: elif event_type is BillingSessionEventType.CUSTOMER_PLAN_CREATED:
return RemoteRealmAuditLog.CUSTOMER_PLAN_CREATED return RemoteRealmAuditLog.CUSTOMER_PLAN_CREATED
elif event_type is AuditLogEventType.DISCOUNT_CHANGED: elif event_type is BillingSessionEventType.DISCOUNT_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_DISCOUNT_CHANGED return RemoteRealmAuditLog.REMOTE_SERVER_DISCOUNT_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PROPERTY_CHANGED: elif event_type is BillingSessionEventType.CUSTOMER_PROPERTY_CHANGED:
return RemoteRealmAuditLog.CUSTOMER_PROPERTY_CHANGED # nocoverage return RemoteRealmAuditLog.CUSTOMER_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.SPONSORSHIP_APPROVED: elif event_type is BillingSessionEventType.SPONSORSHIP_APPROVED:
return RemoteRealmAuditLog.REMOTE_SERVER_SPONSORSHIP_APPROVED return RemoteRealmAuditLog.REMOTE_SERVER_SPONSORSHIP_APPROVED
elif event_type is AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED: elif event_type is BillingSessionEventType.SPONSORSHIP_PENDING_STATUS_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_SPONSORSHIP_PENDING_STATUS_CHANGED return RemoteRealmAuditLog.REMOTE_SERVER_SPONSORSHIP_PENDING_STATUS_CHANGED
elif event_type is AuditLogEventType.BILLING_MODALITY_CHANGED: elif event_type is BillingSessionEventType.BILLING_MODALITY_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_BILLING_MODALITY_CHANGED # nocoverage return RemoteRealmAuditLog.REMOTE_SERVER_BILLING_MODALITY_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED: elif event_type is BillingSessionEventType.CUSTOMER_PLAN_PROPERTY_CHANGED:
return RemoteRealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED return RemoteRealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED
elif event_type is AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED: elif event_type is BillingSessionEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_PLAN_TYPE_CHANGED return RemoteRealmAuditLog.REMOTE_SERVER_PLAN_TYPE_CHANGED
elif ( elif (
event_type is AuditLogEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN event_type is BillingSessionEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN
): # nocoverage ): # nocoverage
return RemoteRealmAuditLog.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN return RemoteRealmAuditLog.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN
elif ( elif (
event_type is AuditLogEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN event_type is BillingSessionEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN
): # nocoverage ): # nocoverage
return RemoteRealmAuditLog.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN return RemoteRealmAuditLog.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN
else: # nocoverage else: # nocoverage
@ -4236,7 +4236,7 @@ class RemoteRealmBillingSession(BillingSession):
@override @override
def write_to_audit_log( def write_to_audit_log(
self, self,
event_type: AuditLogEventType, event_type: BillingSessionEventType,
event_time: datetime, event_time: datetime,
*, *,
background_update: bool = False, background_update: bool = False,
@ -4344,7 +4344,7 @@ class RemoteRealmBillingSession(BillingSession):
self.remote_realm.plan_type = plan_type self.remote_realm.plan_type = plan_type
self.remote_realm.save(update_fields=["plan_type"]) self.remote_realm.save(update_fields=["plan_type"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED, event_type=BillingSessionEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={"old_value": old_plan_type, "new_value": plan_type}, extra_data={"old_value": old_plan_type, "new_value": plan_type},
background_update=background_update, background_update=background_update,
@ -4375,7 +4375,7 @@ class RemoteRealmBillingSession(BillingSession):
customer.sponsorship_pending = False customer.sponsorship_pending = False
customer.save(update_fields=["sponsorship_pending"]) customer.save(update_fields=["sponsorship_pending"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.SPONSORSHIP_APPROVED, event_time=timezone_now() event_type=BillingSessionEventType.SPONSORSHIP_APPROVED, event_time=timezone_now()
) )
emailed_string = "" emailed_string = ""
billing_emails = list( billing_emails = list(
@ -4431,7 +4431,7 @@ class RemoteRealmBillingSession(BillingSession):
self.remote_realm.plan_type = new_plan_type self.remote_realm.plan_type = new_plan_type
self.remote_realm.save(update_fields=["plan_type"]) self.remote_realm.save(update_fields=["plan_type"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED, event_type=BillingSessionEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={"old_value": old_plan_type, "new_value": new_plan_type}, extra_data={"old_value": old_plan_type, "new_value": new_plan_type},
background_update=background_update, background_update=background_update,
@ -4644,33 +4644,33 @@ class RemoteServerBillingSession(BillingSession):
) )
@override @override
def get_audit_log_event(self, event_type: AuditLogEventType) -> int: def get_audit_log_event(self, event_type: BillingSessionEventType) -> int:
if event_type is AuditLogEventType.STRIPE_CUSTOMER_CREATED: if event_type is BillingSessionEventType.STRIPE_CUSTOMER_CREATED:
return RemoteZulipServerAuditLog.STRIPE_CUSTOMER_CREATED return RemoteZulipServerAuditLog.STRIPE_CUSTOMER_CREATED
elif event_type is AuditLogEventType.STRIPE_CARD_CHANGED: elif event_type is BillingSessionEventType.STRIPE_CARD_CHANGED:
return RemoteZulipServerAuditLog.STRIPE_CARD_CHANGED return RemoteZulipServerAuditLog.STRIPE_CARD_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PLAN_CREATED: elif event_type is BillingSessionEventType.CUSTOMER_PLAN_CREATED:
return RemoteZulipServerAuditLog.CUSTOMER_PLAN_CREATED return RemoteZulipServerAuditLog.CUSTOMER_PLAN_CREATED
elif event_type is AuditLogEventType.DISCOUNT_CHANGED: elif event_type is BillingSessionEventType.DISCOUNT_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_DISCOUNT_CHANGED # nocoverage return RemoteZulipServerAuditLog.REMOTE_SERVER_DISCOUNT_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PROPERTY_CHANGED: elif event_type is BillingSessionEventType.CUSTOMER_PROPERTY_CHANGED:
return RemoteZulipServerAuditLog.CUSTOMER_PROPERTY_CHANGED # nocoverage return RemoteZulipServerAuditLog.CUSTOMER_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.SPONSORSHIP_APPROVED: elif event_type is BillingSessionEventType.SPONSORSHIP_APPROVED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_SPONSORSHIP_APPROVED return RemoteZulipServerAuditLog.REMOTE_SERVER_SPONSORSHIP_APPROVED
elif event_type is AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED: elif event_type is BillingSessionEventType.SPONSORSHIP_PENDING_STATUS_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_SPONSORSHIP_PENDING_STATUS_CHANGED return RemoteZulipServerAuditLog.REMOTE_SERVER_SPONSORSHIP_PENDING_STATUS_CHANGED
elif event_type is AuditLogEventType.BILLING_MODALITY_CHANGED: elif event_type is BillingSessionEventType.BILLING_MODALITY_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_BILLING_MODALITY_CHANGED # nocoverage return RemoteZulipServerAuditLog.REMOTE_SERVER_BILLING_MODALITY_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED: elif event_type is BillingSessionEventType.CUSTOMER_PLAN_PROPERTY_CHANGED:
return RemoteZulipServerAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED # nocoverage return RemoteZulipServerAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED: elif event_type is BillingSessionEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_PLAN_TYPE_CHANGED return RemoteZulipServerAuditLog.REMOTE_SERVER_PLAN_TYPE_CHANGED
elif ( elif (
event_type is AuditLogEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN event_type is BillingSessionEventType.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN
): # nocoverage ): # nocoverage
return RemoteZulipServerAuditLog.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN return RemoteZulipServerAuditLog.CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN
elif ( elif (
event_type is AuditLogEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN event_type is BillingSessionEventType.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN
): # nocoverage ): # nocoverage
return RemoteZulipServerAuditLog.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN return RemoteZulipServerAuditLog.CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN
else: # nocoverage else: # nocoverage
@ -4679,7 +4679,7 @@ class RemoteServerBillingSession(BillingSession):
@override @override
def write_to_audit_log( def write_to_audit_log(
self, self,
event_type: AuditLogEventType, event_type: BillingSessionEventType,
event_time: datetime, event_time: datetime,
*, *,
background_update: bool = False, background_update: bool = False,
@ -4783,7 +4783,7 @@ class RemoteServerBillingSession(BillingSession):
self.remote_server.plan_type = plan_type self.remote_server.plan_type = plan_type
self.remote_server.save(update_fields=["plan_type"]) self.remote_server.save(update_fields=["plan_type"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED, event_type=BillingSessionEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={"old_value": old_plan_type, "new_value": plan_type}, extra_data={"old_value": old_plan_type, "new_value": plan_type},
background_update=background_update, background_update=background_update,
@ -4824,7 +4824,7 @@ class RemoteServerBillingSession(BillingSession):
customer.sponsorship_pending = False customer.sponsorship_pending = False
customer.save(update_fields=["sponsorship_pending"]) customer.save(update_fields=["sponsorship_pending"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.SPONSORSHIP_APPROVED, event_time=timezone_now() event_type=BillingSessionEventType.SPONSORSHIP_APPROVED, event_time=timezone_now()
) )
billing_emails = list( billing_emails = list(
RemoteServerBillingUser.objects.filter(remote_server=self.remote_server).values_list( RemoteServerBillingUser.objects.filter(remote_server=self.remote_server).values_list(
@ -4858,7 +4858,7 @@ class RemoteServerBillingSession(BillingSession):
self.remote_server.plan_type = new_plan_type self.remote_server.plan_type = new_plan_type
self.remote_server.save(update_fields=["plan_type"]) self.remote_server.save(update_fields=["plan_type"])
self.write_to_audit_log( self.write_to_audit_log(
event_type=AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED, event_type=BillingSessionEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED,
event_time=timezone_now(), event_time=timezone_now(),
extra_data={"old_value": old_plan_type, "new_value": new_plan_type}, extra_data={"old_value": old_plan_type, "new_value": new_plan_type},
background_update=background_update, background_update=background_update,

12
corporate/tests/test_stripe.py
View File

@ -31,9 +31,9 @@ from corporate.lib.stripe import (
MAX_INVOICED_LICENSES, MAX_INVOICED_LICENSES,
MIN_INVOICED_LICENSES, MIN_INVOICED_LICENSES,
STRIPE_API_VERSION, STRIPE_API_VERSION,
AuditLogEventType,
BillingError, BillingError,
BillingSessionAuditLogEventError, BillingSessionAuditLogEventError,
BillingSessionEventType,
InitialUpgradeRequest, InitialUpgradeRequest,
InvalidBillingScheduleError, InvalidBillingScheduleError,
InvalidTierError, InvalidTierError,
@ -6007,7 +6007,7 @@ class TestRealmBillingSession(StripeTestCase):
def test_get_audit_log_error(self) -> None: def test_get_audit_log_error(self) -> None:
user = self.example_user("hamlet") user = self.example_user("hamlet")
billing_session = RealmBillingSession(user) billing_session = RealmBillingSession(user)
fake_audit_log = typing.cast(AuditLogEventType, 0) fake_audit_log = typing.cast(BillingSessionEventType, 0)
with self.assertRaisesRegex( with self.assertRaisesRegex(
BillingSessionAuditLogEventError, "Unknown audit log event type: 0" BillingSessionAuditLogEventError, "Unknown audit log event type: 0"
): ):
@ -6107,7 +6107,7 @@ class TestRemoteServerBillingSession(StripeTestCase):
contact_email="email@example.com", contact_email="email@example.com",
) )
billing_session = RemoteServerBillingSession(remote_server) billing_session = RemoteServerBillingSession(remote_server)
fake_audit_log = typing.cast(AuditLogEventType, 0) fake_audit_log = typing.cast(BillingSessionEventType, 0)
with self.assertRaisesRegex( with self.assertRaisesRegex(
BillingSessionAuditLogEventError, "Unknown audit log event type: 0" BillingSessionAuditLogEventError, "Unknown audit log event type: 0"
): ):
@ -6626,7 +6626,7 @@ class TestRemoteBillingWriteAuditLog(StripeTestCase):
# This "ordinary billing" event type value gets translated by write_to_audit_log # This "ordinary billing" event type value gets translated by write_to_audit_log
# into a RemoteRealmBillingSession.CUSTOMER_PLAN_CREATED or # into a RemoteRealmBillingSession.CUSTOMER_PLAN_CREATED or
# RemoteServerBillingSession.CUSTOMER_PLAN_CREATED value. # RemoteServerBillingSession.CUSTOMER_PLAN_CREATED value.
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=event_time, event_time=event_time,
) )
audit_log = audit_log_model.objects.latest("id") audit_log = audit_log_model.objects.latest("id")
@ -6636,7 +6636,7 @@ class TestRemoteBillingWriteAuditLog(StripeTestCase):
session = session_class(remote_object, remote_billing_user=remote_user) session = session_class(remote_object, remote_billing_user=remote_user)
session.write_to_audit_log( session.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=event_time, event_time=event_time,
) )
audit_log = audit_log_model.objects.latest("id") audit_log = audit_log_model.objects.latest("id")
@ -6648,7 +6648,7 @@ class TestRemoteBillingWriteAuditLog(StripeTestCase):
remote_object, remote_billing_user=None, support_staff=support_admin remote_object, remote_billing_user=None, support_staff=support_admin
) )
session.write_to_audit_log( session.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_CREATED, event_type=BillingSessionEventType.CUSTOMER_PLAN_CREATED,
event_time=event_time, event_time=event_time,
) )
audit_log = audit_log_model.objects.latest("id") audit_log = audit_log_model.objects.latest("id")