eb0f465970
# What this PR does
This PR:
- adds a new method
`apps.schedules.ical_utils.get_cached_oncall_users_for_multiple_schedules`.
In short this method basically adds a layer of caching on top of
`apps.schedules.ical_utils.get_oncall_users_for_multiple_schedules`. We
store one cache value for each schedule. Cache results are stored for 15
minutes. To me this feels like a good balance between improving
performance + returning stale results. Cache values are stored as:
- key = `f"schedule_{schedule.public_primary_key}_oncall_users"`
- value = `[user.public_primary_key for user in
schedule.currently_oncall_users]`
- adds a `DELETE /alertgroups/<id>` internal API endpoint (needed by
Grafana Incident for the Add Responders integration)
- updates the `is_currently_oncall` query parameter for the `GET /users`
internal API endpoint to return ALL users when the query param value `==
"all"`
## Which issue(s) this PR fixes
https://github.com/grafana/oncall-private/issues/2264
## 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)
85 lines
3.4 KiB
Python
85 lines
3.4 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.mixins import PublicPrimaryKeyMixin
|
|
|
|
|
|
class TeamViewSet(
|
|
PublicPrimaryKeyMixin,
|
|
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="null", 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)
|