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

audit-logs: Add generic property changed for Customer and CustomerPlan. 

Change audit logs for changing a Customer or CustomerPlan property
to use a generic event type and specify the property name in the
extra data.
This commit is contained in:
Lauryn Menard 2024-01-12 17:38:55 +01:00 committed by Tim Abbott
parent bafa476fd3
commit f27b6d896a
4 changed files with 47 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
analytics/tests/test_support_views.py
View File

@ -32,7 +32,12 @@ if TYPE_CHECKING:
import uuid
from zilencer.models import RemoteRealm, RemoteZulipServer, RemoteZulipServerAuditLog
from zilencer.models import (
RemoteRealm,
RemoteRealmAuditLog,
RemoteZulipServer,
RemoteZulipServerAuditLog,
)
class TestRemoteServerSupportEndpoint(ZulipTestCase):
@ -365,6 +370,17 @@ class TestRemoteServerSupportEndpoint(ZulipTestCase):
)
plan.refresh_from_db()
self.assertEqual(plan.end_date, datetime(2040, 1, 1, tzinfo=timezone.utc))
audit_log = RemoteRealmAuditLog.objects.filter(
event_type=RemoteRealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED
).last()
assert audit_log is not None
expected_extra_data = {
"old_value": "2050-02-01T00:00:00Z",
"new_value": "2040-01-01T00:00:00Z",
"property": "end_date",
"plan_id": plan.id,
}
self.assertEqual(audit_log.extra_data, expected_extra_data)
result = self.client_post(
"/activity/remote/support",

46
corporate/lib/stripe.py
View File

@ -578,8 +578,8 @@ class AuditLogEventType(Enum):
CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN = 8
CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN = 9
BILLING_ENTITY_PLAN_TYPE_CHANGED = 10
MINIMUM_LICENSES_CHANGED = 11
CUSTOMER_PLAN_END_DATE_CHANGED = 12
CUSTOMER_PROPERTY_CHANGED = 11
CUSTOMER_PLAN_PROPERTY_CHANGED = 12
class PlanTierChangeType(Enum):
@ -1119,11 +1119,12 @@ class BillingSession(ABC):
customer.save(update_fields=["minimum_licenses"])
self.write_to_audit_log(
event_type=AuditLogEventType.MINIMUM_LICENSES_CHANGED,
event_type=AuditLogEventType.CUSTOMER_PROPERTY_CHANGED,
event_time=timezone_now(),
extra_data={
"old_minimum_licenses": previous_minimum_license_count,
"new_minimum_licenses": new_minimum_license_count,
"old_value": previous_minimum_license_count,
"new_value": new_minimum_license_count,
"property": "minimum_licenses",
},
)
if previous_minimum_license_count is None:
@ -1180,13 +1181,18 @@ class BillingSession(ABC):
if plan is not None:
assert plan.end_date is not None
assert plan.status == CustomerPlan.ACTIVE
old_end_date = plan.end_date.strftime("%Y-%m-%d")
old_end_date = plan.end_date
plan.end_date = new_end_date
plan.save(update_fields=["end_date"])
self.write_to_audit_log(
event_type=AuditLogEventType.CUSTOMER_PLAN_END_DATE_CHANGED,
event_type=AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED,
event_time=timezone_now(),
extra_data={"old_end_date": old_end_date, "new_end_date": end_date_string},
extra_data={
"old_value": old_end_date,
"new_value": new_end_date,
"plan_id": plan.id,
"property": "end_date",
},
)
return f"Current plan for {self.billing_entity_display_name} updated to end on {end_date_string}."
raise SupportRequestError(
@ -3034,16 +3040,16 @@ class RealmBillingSession(BillingSession):
return RealmAuditLog.CUSTOMER_PLAN_CREATED
elif event_type is AuditLogEventType.DISCOUNT_CHANGED:
return RealmAuditLog.REALM_DISCOUNT_CHANGED
elif event_type is AuditLogEventType.MINIMUM_LICENSES_CHANGED:
return RealmAuditLog.CUSTOMER_MINIMUM_LICENSES_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PROPERTY_CHANGED:
return RealmAuditLog.CUSTOMER_PROPERTY_CHANGED
elif event_type is AuditLogEventType.SPONSORSHIP_APPROVED:
return RealmAuditLog.REALM_SPONSORSHIP_APPROVED
elif event_type is AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED:
return RealmAuditLog.REALM_SPONSORSHIP_PENDING_STATUS_CHANGED
elif event_type is AuditLogEventType.BILLING_MODALITY_CHANGED:
return RealmAuditLog.REALM_BILLING_MODALITY_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PLAN_END_DATE_CHANGED:
return RealmAuditLog.CUSTOMER_PLAN_END_DATE_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED:
return RealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.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:
@ -3394,16 +3400,16 @@ class RemoteRealmBillingSession(BillingSession):
return RemoteRealmAuditLog.CUSTOMER_PLAN_CREATED
elif event_type is AuditLogEventType.DISCOUNT_CHANGED: # nocoverage
return RemoteRealmAuditLog.REMOTE_SERVER_DISCOUNT_CHANGED
elif event_type is AuditLogEventType.MINIMUM_LICENSES_CHANGED:
return RemoteRealmAuditLog.CUSTOMER_MINIMUM_LICENSES_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PROPERTY_CHANGED:
return RemoteRealmAuditLog.CUSTOMER_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.SPONSORSHIP_APPROVED:
return RemoteRealmAuditLog.REMOTE_SERVER_SPONSORSHIP_APPROVED
elif event_type is AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_SPONSORSHIP_PENDING_STATUS_CHANGED
elif event_type is AuditLogEventType.BILLING_MODALITY_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_BILLING_MODALITY_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PLAN_END_DATE_CHANGED:
return RemoteRealmAuditLog.CUSTOMER_PLAN_END_DATE_CHANGED
elif event_type is AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED:
return RemoteRealmAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED
elif event_type is AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED:
return RemoteRealmAuditLog.REMOTE_SERVER_PLAN_TYPE_CHANGED
elif (
@ -3808,16 +3814,16 @@ class RemoteServerBillingSession(BillingSession):
return RemoteZulipServerAuditLog.CUSTOMER_PLAN_CREATED
elif event_type is AuditLogEventType.DISCOUNT_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_DISCOUNT_CHANGED # nocoverage
elif event_type is AuditLogEventType.MINIMUM_LICENSES_CHANGED:
return RemoteZulipServerAuditLog.CUSTOMER_MINIMUM_LICENSES_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PROPERTY_CHANGED:
return RemoteZulipServerAuditLog.CUSTOMER_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.SPONSORSHIP_APPROVED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_SPONSORSHIP_APPROVED
elif event_type is AuditLogEventType.SPONSORSHIP_PENDING_STATUS_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_SPONSORSHIP_PENDING_STATUS_CHANGED
elif event_type is AuditLogEventType.BILLING_MODALITY_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_BILLING_MODALITY_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PLAN_END_DATE_CHANGED:
return RemoteZulipServerAuditLog.CUSTOMER_PLAN_END_DATE_CHANGED # nocoverage
elif event_type is AuditLogEventType.CUSTOMER_PLAN_PROPERTY_CHANGED:
return RemoteZulipServerAuditLog.CUSTOMER_PLAN_PROPERTY_CHANGED # nocoverage
elif event_type is AuditLogEventType.BILLING_ENTITY_PLAN_TYPE_CHANGED:
return RemoteZulipServerAuditLog.REMOTE_SERVER_PLAN_TYPE_CHANGED
elif (

4
corporate/tests/test_stripe.py
View File

@ -5424,10 +5424,10 @@ class TestSupportBillingHelpers(StripeTestCase):
message = billing_session.process_support_view_request(support_view_request)
self.assertEqual("Minimum licenses for zulip changed to 25 from 0.", message)
realm_audit_log = RealmAuditLog.objects.filter(
event_type=RealmAuditLog.CUSTOMER_MINIMUM_LICENSES_CHANGED
event_type=RealmAuditLog.CUSTOMER_PROPERTY_CHANGED
).last()
assert realm_audit_log is not None
expected_extra_data = {"old_minimum_licenses": None, "new_minimum_licenses": 25}
expected_extra_data = {"old_value": None, "new_value": 25, "property": "minimum_licenses"}
self.assertEqual(realm_audit_log.extra_data, expected_extra_data)
self.login_user(user)

4
zerver/models/realm_audit_logs.py
View File

@ -101,8 +101,8 @@ class AbstractRealmAuditLog(models.Model):
CUSTOMER_PLAN_CREATED = 502
CUSTOMER_SWITCHED_FROM_MONTHLY_TO_ANNUAL_PLAN = 503
CUSTOMER_SWITCHED_FROM_ANNUAL_TO_MONTHLY_PLAN = 504
CUSTOMER_MINIMUM_LICENSES_CHANGED = 505
CUSTOMER_PLAN_END_DATE_CHANGED = 506
CUSTOMER_PROPERTY_CHANGED = 505
CUSTOMER_PLAN_PROPERTY_CHANGED = 506
STREAM_CREATED = 601
STREAM_DEACTIVATED = 602