Self hosted FLOSS fitness/workout, nutrition and weight tracker
Keep the pre-2.7 session fields working through the serializer
Roland Geider366ac8a06e49
diff --git a/wger/manager/api/serializers.py b/wger/manager/api/serializers.pyindex 37662cd87..41faaa7ee 100644--- a/wger/manager/api/serializers.py+++ b/wger/manager/api/serializers.py@@ -13,6 +13,12 @@# You should have received a copy of the GNU Affero General Public License# along with Workout Manager. If not, see <http://www.gnu.org/licenses/>.+# Standard Library+import datetime++# Django+from django.utils import timezone+# Third Partyfrom rest_framework import serializers@@ -423,7 +429,15 @@ class WorkoutSessionSerializer(serializers.ModelSerializer):Workout session serializer"""+ # Deprecated, remove in 2.8. Derived from datetime_start/datetime_end on read+ # and translated back on write, so that clients written against the pre-2.7+ # API keep working, including PowerSync uploads that were queued by an older+ # app version and only drain after the update.+ LEGACY_FIELDS = ('date', 'time_start', 'time_end')+date = serializers.SerializerMethodField()+ time_start = serializers.SerializerMethodField()+ time_end = serializers.SerializerMethodField()class Meta:model = WorkoutSession@@ -434,17 +448,79 @@ class WorkoutSessionSerializer(serializers.ModelSerializer):'date','notes','impression',+ 'time_start',+ 'time_end','datetime_start','datetime_end',)- def get_date(self, obj):- if obj.datetime_start:- # Django- from django.utils import timezone+ def get_date(self, obj: WorkoutSession) -> datetime.date | None:+ start = self._local_start(obj)+ return start.date() if start else None++ def get_time_start(self, obj: WorkoutSession) -> datetime.time | None:+ start = self._local_start(obj)+ return start.time() if start else None++ def get_time_end(self, obj: WorkoutSession) -> datetime.time | None:+ return timezone.localtime(obj.datetime_end).time() if obj.datetime_end else None++ @staticmethod+ def _local_start(obj: WorkoutSession) -> datetime.datetime | None:+ return timezone.localtime(obj.datetime_start) if obj.datetime_start else None++ def to_internal_value(self, data):+ return super().to_internal_value(self._translate_legacy_input(data))++ def _translate_legacy_input(self, data):+ """+ Compose datetime_start/datetime_end out of the deprecated triple++ Only components the request did not send are taken from the instance, so+ a PATCH that just sets time_end keeps the day and start time it had. Values+ sent in the new format always win.+ """+ if not any(key in data for key in self.LEGACY_FIELDS):+ return data++ data = data.copy()+ date = self._legacy_value('date', data, serializers.DateField)+ time_start = self._legacy_value('time_start', data, serializers.TimeField)+ time_end = self._legacy_value('time_end', data, serializers.TimeField)++ local_start = self._local_start(self.instance) if self.instance else None+ if date is None:+ date = local_start.date() if local_start else timezone.localdate()+ if 'time_start' not in data:+ time_start = local_start.time() if local_start else datetime.time()+ if 'time_end' not in data and self.instance and self.instance.datetime_end:+ time_end = timezone.localtime(self.instance.datetime_end).time()++ if 'datetime_start' not in data:+ data['datetime_start'] = timezone.make_aware(+ datetime.datetime.combine(date, time_start or datetime.time())+ )+ if 'datetime_end' not in data:+ end = None+ if time_end:+ end = timezone.make_aware(datetime.datetime.combine(date, time_end))+ if time_start and time_end < time_start:+ end += datetime.timedelta(days=1)+ data['datetime_end'] = end++ return data++ @staticmethod+ def _legacy_value(key, data, field_class):+ """Parse one deprecated value, reporting errors under its own key"""++ if data.get(key) in (None, ''):+ return None- return timezone.localtime(obj.datetime_start).date()- return None+ try:+ return field_class().to_internal_value(data[key])+ except serializers.ValidationError as e:+ raise serializers.ValidationError({key: e.detail})class OwnerScopedSessionField(serializers.PrimaryKeyRelatedField):diff --git a/wger/manager/tests/test_powersync.py b/wger/manager/tests/test_powersync.pyindex 4ed35740e..1a16b140c 100644--- a/wger/manager/tests/test_powersync.py+++ b/wger/manager/tests/test_powersync.py@@ -12,6 +12,15 @@## You should have received a copy of the GNU Affero General Public License+# Standard Library+import datetime++# Django+from django.utils import timezone++# Third Party+from rest_framework import status+# wgerfrom wger.core.tests import powersync_base_testfrom wger.manager.models import (@@ -91,6 +100,36 @@ class WorkoutSessionPowerSyncTestCase(powersync_base_test.PowerSyncResourceTestCfk_ownership = (('routine', ROUTINE_OTHER),)+ def test_create_with_deprecated_fields(self):+ """+ A push queued by an app version that predates 2.7 still lands on the day+ and time it was recorded on+ """++ self.authenticate()+ response = self.push(+ 'PUT',+ {+ 'id': 'bbbbbbbb-bbbb-bbbb-bbbb-000000000098',+ 'date': '2030-01-15',+ 'time_start': '23:00:00',+ 'time_end': '01:30:00',+ 'routine': ROUTINE_OWNED,+ 'impression': '2',+ },+ )+ self.assertEqual(response.status_code, status.HTTP_200_OK)++ session = WorkoutSession.objects.get(pk='bbbbbbbb-bbbb-bbbb-bbbb-000000000098')+ self.assertEqual(+ session.datetime_start,+ timezone.make_aware(datetime.datetime(2030, 1, 15, 23, 0)),+ )+ self.assertEqual(+ session.datetime_end,+ timezone.make_aware(datetime.datetime(2030, 1, 16, 1, 30)),+ )+class RoutinePowerSyncTestCase(powersync_base_test.PowerSyncBaseTestCase,diff --git a/wger/manager/tests/test_workout_session.py b/wger/manager/tests/test_workout_session.pyindex 44280dbf8..ace90a2c2 100644--- a/wger/manager/tests/test_workout_session.py+++ b/wger/manager/tests/test_workout_session.py@@ -16,10 +16,15 @@import datetime# Django+from django.urls import reversefrom django.utils import timezone+# Third Party+from rest_framework import status+# wgerfrom wger.core.tests import api_base_test+from wger.core.tests.base_testcase import WgerTestCasefrom wger.manager.models import WorkoutSession@@ -38,3 +43,164 @@ class WorkoutSessionApiTestCase(api_base_test.ApiBaseResourceTestCase):'datetime_start': timezone.make_aware(datetime.datetime(2014, 1, 25, 10, 0)),'datetime_end': timezone.make_aware(datetime.datetime(2014, 1, 25, 13, 0)),}+++class WorkoutSessionLegacyFieldsTestCase(WgerTestCase):+ """+ Test the deprecated date/time_start/time_end fields of the session API+ """++ SESSION = 'bbbbbbbb-bbbb-bbbb-bbbb-000000000005'+ ROUTINE = 3++ def setUp(self):+ super().setUp()+ self.user_login('test')++ def test_read_derives_the_deprecated_triple(self):+ """The deprecated fields are derived from the new ones, in local time"""++ session = WorkoutSession.objects.get(pk=self.SESSION)+ start = timezone.localtime(session.datetime_start)+ end = timezone.localtime(session.datetime_end)++ response = self.client.get(reverse('workoutsession-detail', kwargs={'pk': self.SESSION}))++ self.assertEqual(response.json()['date'], start.date().isoformat())+ self.assertEqual(response.json()['time_start'], start.time().isoformat())+ self.assertEqual(response.json()['time_end'], end.time().isoformat())++ def test_create_with_the_deprecated_triple(self):+ """The deprecated fields are composed into datetime_start/datetime_end"""++ response = self.client.post(+ reverse('workoutsession-list'),+ data={+ 'routine': self.ROUTINE,+ 'impression': '2',+ 'date': '2025-03-12',+ 'time_start': '10:00',+ 'time_end': '11:30',+ },+ )+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)++ session = WorkoutSession.objects.get(pk=response.json()['id'])+ self.assertEqual(+ session.datetime_start,+ timezone.make_aware(datetime.datetime(2025, 3, 12, 10, 0)),+ )+ self.assertEqual(+ session.datetime_end,+ timezone.make_aware(datetime.datetime(2025, 3, 12, 11, 30)),+ )++ def test_create_over_midnight_ends_on_the_next_day(self):+ """An end time before the start time means the session ended the day after"""++ response = self.client.post(+ reverse('workoutsession-list'),+ data={+ 'routine': self.ROUTINE,+ 'impression': '2',+ 'date': '2025-03-10',+ 'time_start': '23:00',+ 'time_end': '01:30',+ },+ )+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)++ session = WorkoutSession.objects.get(pk=response.json()['id'])+ self.assertEqual(+ session.datetime_start,+ timezone.make_aware(datetime.datetime(2025, 3, 10, 23, 0)),+ )+ self.assertEqual(+ session.datetime_end,+ timezone.make_aware(datetime.datetime(2025, 3, 11, 1, 30)),+ )++ def test_create_without_a_start_time_starts_at_midnight(self):+ """A session without times covers the day it was logged on"""++ response = self.client.post(+ reverse('workoutsession-list'),+ data={'routine': self.ROUTINE, 'impression': '2', 'date': '2025-03-12'},+ )+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)++ session = WorkoutSession.objects.get(pk=response.json()['id'])+ self.assertEqual(+ session.datetime_start,+ timezone.make_aware(datetime.datetime(2025, 3, 12, 0, 0)),+ )+ self.assertIsNone(session.datetime_end)++ def test_patch_time_end_keeps_day_and_start(self):+ """Closing a session takes the day and start time from the stored session"""++ session = WorkoutSession.objects.get(pk=self.SESSION)+ start = session.datetime_start++ response = self.client.patch(+ reverse('workoutsession-detail', kwargs={'pk': self.SESSION}),+ data={'time_end': '12:30'},+ content_type='application/json',+ )+ self.assertEqual(response.status_code, status.HTTP_200_OK)++ session.refresh_from_db()+ self.assertEqual(session.datetime_start, start)+ self.assertEqual(+ timezone.localtime(session.datetime_end),+ timezone.make_aware(+ datetime.datetime.combine(+ timezone.localtime(start).date(),+ datetime.time(12, 30),+ )+ ),+ )++ def test_the_new_fields_win(self):+ """A request that sends both formats is not overwritten by the deprecated one"""++ response = self.client.post(+ reverse('workoutsession-list'),+ data={+ 'routine': self.ROUTINE,+ 'impression': '2',+ 'date': '2020-01-01',+ 'time_start': '08:00',+ 'datetime_start': '2025-03-12T10:00:00Z',+ },+ )+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)++ session = WorkoutSession.objects.get(pk=response.json()['id'])+ self.assertEqual(+ session.datetime_start,+ datetime.datetime(2025, 3, 12, 10, 0, tzinfo=datetime.timezone.utc),+ )++ def test_untouched_when_no_deprecated_field_is_sent(self):+ """A request without the deprecated fields leaves the timestamps alone"""++ session = WorkoutSession.objects.get(pk=self.SESSION)++ response = self.client.patch(+ reverse('workoutsession-detail', kwargs={'pk': self.SESSION}),+ data={'notes': 'Only the notes change'},+ content_type='application/json',+ )+ self.assertEqual(response.status_code, status.HTTP_200_OK)++ session.refresh_from_db()+ self.assertEqual(session.notes, 'Only the notes change')+ self.assertEqual(+ session.datetime_start,+ datetime.datetime(2025, 11, 1, 10, 0, tzinfo=datetime.timezone.utc),+ )+ self.assertEqual(+ session.datetime_end,+ datetime.datetime(2025, 11, 1, 10, 15, tzinfo=datetime.timezone.utc),+ )