2576954b51
# What this PR does - drop `GET /api/internal/v1/shift_swaps/<id>/shifts` endpoint in favour of adding a `shifts` property to the response schema for all shift swap endpoints (expect `GET /api/internal/v1/shift_swaps` (ie. list all)) - Update the Slack message layout: <img width="590" alt="Screenshot 2023-08-01 at 17 28 44" src="https://github.com/grafana/oncall/assets/9406895/84a51614-5dd6-48ec-ae81-fef4bc32fec9"> **Note**: about the highlighted lines. This is a small issue w/ the `ShiftSwapRequest.shifts` method. @matiasb is already helping out here 🙏 **Other stuff** - adds some type hints related to the code I was working around with - slightly refactor `apps.slack.utils.format_datetime_to_slack` to make it more generic for the use case in this PR ## 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)
90 lines
3.3 KiB
Python
90 lines
3.3 KiB
Python
import datetime
|
|
|
|
from django.utils import timezone
|
|
from rest_framework import serializers
|
|
|
|
from apps.schedules.models import OnCallSchedule, ShiftSwapRequest
|
|
from common.api_helpers.custom_fields import OrganizationFilteredPrimaryKeyRelatedField, TimeZoneAwareDatetimeField
|
|
from common.api_helpers.mixins import EagerLoadingMixin
|
|
|
|
|
|
class ShiftSwapRequestListSerializer(EagerLoadingMixin, serializers.ModelSerializer):
|
|
id = serializers.CharField(read_only=True, source="public_primary_key")
|
|
schedule = OrganizationFilteredPrimaryKeyRelatedField(queryset=OnCallSchedule.objects)
|
|
|
|
created_at = TimeZoneAwareDatetimeField(read_only=True)
|
|
updated_at = TimeZoneAwareDatetimeField(read_only=True)
|
|
|
|
swap_start = TimeZoneAwareDatetimeField()
|
|
swap_end = TimeZoneAwareDatetimeField()
|
|
|
|
beneficiary = serializers.CharField(read_only=True, source="beneficiary.public_primary_key")
|
|
benefactor = serializers.SerializerMethodField(read_only=True)
|
|
|
|
SELECT_RELATED = [
|
|
"schedule",
|
|
"beneficiary",
|
|
"benefactor",
|
|
]
|
|
|
|
class Meta:
|
|
model = ShiftSwapRequest
|
|
fields = [
|
|
"id",
|
|
"created_at",
|
|
"updated_at",
|
|
"status",
|
|
"schedule",
|
|
"swap_start",
|
|
"swap_end",
|
|
"description",
|
|
"beneficiary",
|
|
"benefactor",
|
|
]
|
|
read_only_fields = [
|
|
"status",
|
|
]
|
|
|
|
def get_benefactor(self, obj: ShiftSwapRequest) -> str | None:
|
|
return obj.benefactor.public_primary_key if obj.benefactor else None
|
|
|
|
|
|
class ShiftSwapRequestSerializer(ShiftSwapRequestListSerializer):
|
|
class Meta(ShiftSwapRequestListSerializer.Meta):
|
|
fields = ShiftSwapRequestListSerializer.Meta.fields + [
|
|
"shifts",
|
|
]
|
|
read_only_fields = ShiftSwapRequestListSerializer.Meta.read_only_fields + [
|
|
"shifts",
|
|
]
|
|
|
|
@staticmethod
|
|
def validate_start_and_end_times(swap_start: datetime.datetime, swap_end: datetime.datetime) -> None:
|
|
if timezone.now() > swap_start:
|
|
raise serializers.ValidationError("swap_start must be a datetime in the future")
|
|
if swap_start > swap_end:
|
|
raise serializers.ValidationError("swap_end must occur after swap_start")
|
|
|
|
def validate(self, data):
|
|
swap_start = data.get("swap_start", None)
|
|
swap_end = data.get("swap_end", None)
|
|
|
|
if self.partial: # self.partial is true when it's a "partial update" aka PATCH
|
|
# if any time related field is specified then we will enforce that they must all be specified
|
|
time_fields = [swap_start, swap_end]
|
|
any_time_fields_specified = any(time_fields)
|
|
all_time_fields_specified = all(time_fields)
|
|
|
|
if any_time_fields_specified and not all_time_fields_specified:
|
|
raise serializers.ValidationError(
|
|
"when doing a partial update on time related fields, both start and end times must be specified"
|
|
)
|
|
elif all_time_fields_specified:
|
|
self.validate_start_and_end_times(swap_start, swap_end)
|
|
else:
|
|
self.validate_start_and_end_times(swap_start, swap_end)
|
|
|
|
# TODO: we should validate that the beneficiary actually has shifts for the specified schedule
|
|
# between swap_start and swap_end
|
|
|
|
return data
|