06933a696a
# What this PR does This PR adds support for routing alerts based on labels. https://www.loom.com/share/4401de6e3c4945d5b8961fe43ee373c9 Additionally: - improve the typing around the `get_object` method that is inherited by [`PublicPrimaryKeyMixin.get_object`](https://github.com/grafana/oncall/blob/dev/engine/common/api_helpers/mixins.py#L153) in most of our models. `PublicPrimaryKeyMixin` is generic, so it can be more strongly typed when it is being subclassed, which results in better typing of the `get_object` method in child classes - I decided to do this because I started looking into this task via the [`AlertReceiveChannelView.send_demo_alert` method/endpoint](https://github.com/grafana/oncall/blob/dev/engine/apps/api/views/alert_receive_channel.py#L242). Within that method, `instance` is not typed because the inherited `get_object` method is not typed.. I digress 😄 - improve typing around `Alert.create` and `apps.integrations.tasks.create_alert` functions - make `Alert.render_group_data` more DRY by extracting some logic out into `Alert._apply_jinja_template_to_alert_payload_and_labels` - deduplicate the logic of `value.strip().lower() in ["1", "true", "ok"]` into a shared function, `common.jinja_templater.apply_jinja_template.templated_value_is_truthy` Closes https://github.com/grafana/oncall-private/issues/2490 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required) - [x] Documentation added (or `pr:no public docs` PR label added if not required) (will be done in #3762)
86 lines
3.5 KiB
Python
86 lines
3.5 KiB
Python
from django.utils.functional import cached_property
|
|
from rest_framework import mixins, viewsets
|
|
from rest_framework.filters import SearchFilter
|
|
from rest_framework.permissions import IsAuthenticated
|
|
from rest_framework.response import Response
|
|
|
|
from apps.api.permissions import RBACPermission
|
|
from apps.api.serializers.team import TeamLongSerializer, TeamSerializer
|
|
from apps.auth_token.auth import PluginAuthentication
|
|
from apps.mobile_app.auth import MobileAppAuthTokenAuthentication
|
|
from apps.schedules.ical_utils import get_cached_oncall_users_for_multiple_schedules
|
|
from apps.user_management.models import Team
|
|
from common.api_helpers.filters import NO_TEAM_VALUE
|
|
from common.api_helpers.mixins import PublicPrimaryKeyMixin
|
|
|
|
|
|
class TeamViewSet(
|
|
PublicPrimaryKeyMixin[Team],
|
|
mixins.ListModelMixin,
|
|
mixins.RetrieveModelMixin,
|
|
mixins.UpdateModelMixin,
|
|
viewsets.GenericViewSet,
|
|
):
|
|
authentication_classes = (
|
|
MobileAppAuthTokenAuthentication,
|
|
PluginAuthentication,
|
|
)
|
|
permission_classes = (IsAuthenticated, RBACPermission)
|
|
rbac_permissions = {
|
|
"list": [RBACPermission.Permissions.OTHER_SETTINGS_READ],
|
|
"retrieve": [RBACPermission.Permissions.OTHER_SETTINGS_READ],
|
|
"update": [RBACPermission.Permissions.OTHER_SETTINGS_WRITE],
|
|
}
|
|
|
|
serializer_class = TeamSerializer
|
|
filter_backends = [SearchFilter]
|
|
search_fields = ["name"]
|
|
|
|
def get_queryset(self):
|
|
return self.request.user.available_teams
|
|
|
|
def _is_long_request(self) -> bool:
|
|
return self.request.query_params.get("short", "true").lower() == "false"
|
|
|
|
@cached_property
|
|
def schedules_with_oncall_users(self):
|
|
"""
|
|
The result of this method is cached and is reused for the whole lifetime of a request,
|
|
since self.get_serializer_context() is called multiple times for every instance in the queryset.
|
|
"""
|
|
team_ids = [t.id for t in self.filter_queryset(self.get_queryset())]
|
|
team_schedules = self.request.user.organization.oncall_schedules.filter(team__id__in=team_ids)
|
|
return get_cached_oncall_users_for_multiple_schedules(team_schedules)
|
|
|
|
def get_serializer_context(self):
|
|
context = super().get_serializer_context()
|
|
context.update(
|
|
{"schedules_with_oncall_users": self.schedules_with_oncall_users if self._is_long_request() else {}}
|
|
)
|
|
return context
|
|
|
|
def get_serializer_class(self):
|
|
return TeamLongSerializer if self._is_long_request() else TeamSerializer
|
|
|
|
def list(self, request, *args, **kwargs):
|
|
general_team = [Team(public_primary_key=NO_TEAM_VALUE, name="No team", email=None, avatar_url=None)]
|
|
queryset = self.filter_queryset(self.get_queryset())
|
|
|
|
if self.request.query_params.get("only_include_notifiable_teams", "false") == "true":
|
|
queryset = queryset.filter(
|
|
pk__in=self.request.user.organization.get_notifiable_direct_paging_integrations()
|
|
.filter(team__isnull=False)
|
|
.values_list("team__pk", flat=True)
|
|
)
|
|
|
|
queryset = queryset.order_by("name")
|
|
|
|
teams = list(queryset)
|
|
if self.request.query_params.get("include_no_team", "true") != "false":
|
|
# Adds general team to the queryset in a way that it always shows up first (even when not searched for).
|
|
queryset = general_team + teams
|
|
else:
|
|
queryset = teams
|
|
|
|
serializer = self.get_serializer(queryset, many=True)
|
|
return Response(serializer.data)
|