oncall-engine/engine/apps/api/serializers
Vadim Stepanov eada4a4355
Fix duplicate orders for user notification policies (#2278)
# What this PR does

Fixes an issue when multiple user notification policies have duplicated
order values, leading to the following unexpected behaviours:
1. Not possible to rearrange notification policies that have duplicated
orders.
2. The notification system only executes the first policy from each
order group. For example, if there are policies with orders `[0, 0, 0,
0]`, only the first policy will be executed, and all others will be
skipped. So the user will see four policies in the UI, while only one of
them will be actually executed.

This PR fixes the issue by adding a unique index on `(user_id,
important, order)` for `UserNotificationPolicy` model. However, it's not
possible to add that unique index using the ordering library that we use
due to it's implementation details.
I added a new abstract Django model `OrderedModel` that's able to work
with such unique indices + under concurrent load.

Important info on this new `OrderedModel` abstract model:
- Orders are unique on the DB level
- Orders are allowed to be non-consecutive, for example order sequence
`[100, 150, 400]` is valid
- When deleting an instance, orders of other instances don't change.
This is a notable difference from the library we use. I think it's
better to only delete the instance without changing any other orders,
because it reduces the number of dependencies between instances (e.g.
Terraform drift will be much smaller this way if a policy is deleted via
the web UI).

## Which issue(s) this PR fixes

Related to https://github.com/grafana/oncall-private/issues/1680

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-06-21 11:13:56 +00:00
..
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
alert.py add several new database columns + emit two new Django signals (#1522) 2023-04-14 09:15:57 +02:00
alert_group.py add channel__team to internal api serializer select_related (#1805) 2023-04-20 18:30:49 +02:00
alert_receive_channel.py Add inbound email field to private api (#2287) 2023-06-20 21:54:07 +08:00
alerts_field_cache_buster_mixin.py add several new database columns + emit two new Django signals (#1522) 2023-04-14 09:15:57 +02:00
channel_filter.py Add telegram details field (#2255) 2023-06-15 23:52:01 +08:00
custom_button.py use CustomURLValidator in custom_button (#1398) 2023-03-23 12:21:17 +00:00
custom_serializers.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
escalation_chain.py Add alert group filter by escalation chain (#1535) 2023-03-14 14:38:18 +00:00
escalation_policy.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
integration_heartbeat.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
live_setting.py Allow no-auth SMTP connection for email notifications (#759) 2022-11-03 16:18:37 +00:00
on_call_shifts.py Changed web schedule updates to sync refresh ical (#2279) 2023-06-20 15:01:35 +00:00
organization.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
organization_slack_settings.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
paging.py Teams redesign (#1528) 2023-03-22 00:57:20 +08:00
public_api_token.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
resolution_note.py Optimize alert group list view (#299) 2022-07-27 14:14:59 +03:00
schedule_base.py Add support for web overrides to Terraform schedules (#1222) 2023-03-10 16:21:50 +00:00
schedule_calendar.py Add support for web overrides to Terraform schedules (#1222) 2023-03-10 16:21:50 +00:00
schedule_ical.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
schedule_polymorphic.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
schedule_reminder.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
schedule_web.py Add support for web overrides to Terraform schedules (#1222) 2023-03-10 16:21:50 +00:00
slack_channel.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
slack_user_identity.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
team.py Teams redesign (#1528) 2023-03-22 00:57:20 +08:00
telegram.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user.py remove legacy permission strings (#2269) 2023-06-16 10:00:14 +00:00
user_group.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_notification_policy.py Fix duplicate orders for user notification policies (#2278) 2023-06-21 11:13:56 +00:00
webhook.py Webhooks 2 hide secrets (#2104) 2023-06-06 07:59:12 +00:00