Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Fix bug that caused days with logs not to advance correctly

Roland Geider46b93c07956c
diff --git a/wger/manager/management/commands/reset-routine-cache.py b/wger/manager/management/commands/reset-routine-cache.py
new file mode 100644
index 000000000..eb6f43a64
--- /dev/null
+++ b/wger/manager/management/commands/reset-routine-cache.py
@@ -0,0 +1,42 @@
+# This file is part of wger Workout Manager.
+#
+# wger Workout Manager is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# wger Workout Manager is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# Standard Library
+from typing import Any
+
+# Django
+from django.core.management.base import BaseCommand
+
+# Third Party
+from tqdm import tqdm
+
+# wger
+from wger.manager.helpers import reset_routine_cache
+from wger.manager.models import Routine
+
+
+class Command(BaseCommand):
+ help = 'Resets the cache for all routines.'
+
+ def handle(self, *args, **options):
+ total_routines = Routine.objects.count()
+ self.stdout.write(f'Updating cache for {total_routines} routines...')
+
+ with tqdm(total=total_routines, unit='routine', unit_scale=True) as pbar:
+ routine: Routine
+ for routine in Routine.objects.all():
+ reset_routine_cache(routine)
+ _ = routine.date_sequence
+ pbar.update(1)
+
+ self.stdout.write(self.style.SUCCESS('Successfully updated cache for all routines!'))
diff --git a/wger/manager/models/day.py b/wger/manager/models/day.py
index 3e7437390..6bea637d8 100644
--- a/wger/manager/models/day.py
+++ b/wger/manager/models/day.py
@@ -15,7 +15,6 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Standard Library
-import datetime
from typing import List
# Django
@@ -122,24 +121,6 @@ class Day(models.Model):
"""
return self.routine
- def can_proceed(self, date: datetime.date) -> bool:
- """
- Checks whether the user can proceed to the next day in the sequence
-
- This is possible if
- - the day doesn't require logs
- - the day requires logs, and they exist
- - the date is in the future (used e.g. for calendars where we assume we will proceed)
- """
- if (
- not self.need_logs_to_advance
- # or self.workoutsession_set.filter(date=date).exists()
- or date > datetime.date.today()
- ):
- return True
-
- return False
-
def get_slots_gym_mode(self, iteration: int) -> List[SlotData]:
"""
Return the sets for this day
diff --git a/wger/manager/models/routine.py b/wger/manager/models/routine.py
index 7f3fc6c93..426a583e1 100644
--- a/wger/manager/models/routine.py
+++ b/wger/manager/models/routine.py
@@ -32,6 +32,7 @@ from django.core.exceptions import ValidationError
from django.db import models
from django.db.models import Prefetch
from django.urls import reverse
+from django.utils import timezone
from django.utils.translation import gettext_lazy as _
# wger
@@ -167,10 +168,8 @@ class Routine(models.Model):
@property
def label_dict(self) -> dict[datetime.date, str]:
- out = {}
- labels = self.labels.all()
-
- for label in labels:
+ out = defaultdict(str)
+ for label in self.labels.all():
for i in range(label.start_offset, label.end_offset + 1):
out[self.start + datetime.timedelta(days=i)] = label.label
@@ -233,78 +232,83 @@ class Routine(models.Model):
.order_by('order')
)
+ if not days:
+ return []
+
# Precompute session dates from prefetched logs
- day_session_map = defaultdict(set)
+ workout_session_map = defaultdict(set)
for day in days:
for session in day.workoutsession_set.all():
- day_session_map[day.id].add(session.date)
+ workout_session_map[day.id].add(session.date)
# Main sequence generation logic
- delta = datetime.timedelta(days=1)
+ labels = self.label_dict
current_date = self.start
days_list = list(days)
- days_count = len(days_list)
- counter = Counter()
- skip_until = None
+ nr_of_days = len(days_list)
+ iteration_counter = Counter()
sequence = []
+ is_first = True
+ day_index = 0
- if not days_list:
- return []
+ for day in days:
+ iteration_counter[day.id] = 1
- current_day = days_list[0]
- index = 0
+ while current_date <= self.end:
+ current_day = days_list[day_index]
+ previous_date = current_date - datetime.timedelta(days=1)
+
+ # Checks whether the user can proceed to the next day in the sequence
+ #
+ # This is possible if
+ # - the day doesn't require logs
+ # - the day requires logs, and they exist. Note that we check for logs on the previous
+ # day, since when a user logs a session for a day, the advancement should happen on
+ # the next day, not immediately.
+ # - the date is in the future (used e.g. for calendars where we assume we will proceed)
+ has_session = previous_date in workout_session_map[current_day.id]
+ can_proceed = (
+ not current_day.need_logs_to_advance
+ or (current_day.need_logs_to_advance and has_session)
+ or current_date > timezone.localdate()
+ )
- # Precompute label dates
- label_dates = defaultdict(str)
- for label in self.labels.all():
- for i in range(label.start_offset, label.end_offset + 1):
- label_dates[self.start + datetime.timedelta(days=i)] = label.label
+ if can_proceed and not is_first:
+ iteration_counter[current_day.id] += 1
+ day_index = (day_index + 1) % nr_of_days
+ current_day = days_list[day_index]
- while current_date <= self.end:
- if skip_until:
- if current_date >= skip_until:
- skip_until = None
- else:
+ # If fit_in_week is set we need to fill the rest of the week with placeholders
+ if self.fit_in_week and nr_of_days % 7 != 0 and day_index == 0 and not is_first:
+ days_to_monday = 7 - current_date.weekday()
+ for i in range(days_to_monday):
+ placeholder_date = current_date + datetime.timedelta(days=i)
+ if placeholder_date > self.end:
+ break
sequence.append(
WorkoutDayData(
- iteration=counter[current_day],
- date=current_date,
+ date=placeholder_date,
day=None,
- label=label_dates.get(current_date),
+ label=labels.get(placeholder_date),
+ # This is ugly, but we don't want to advance the iteration
+ iteration=iteration_counter[current_day.id] - 1,
)
)
- current_date += delta
+ current_date += datetime.timedelta(days=days_to_monday)
+ if current_date > self.end:
continue
- counter[current_day] += 1
- index = (index + 1) % days_count
-
- # Handle week filling logic
- if self.fit_in_week and days_count % 7 != 0 and index == 0:
- days_to_monday = 7 - current_date.weekday()
- skip_until = current_date + datetime.timedelta(days=days_to_monday)
-
- # Check if day can proceed using prefetched session dates
- has_session = current_date in day_session_map[current_day.id]
- can_proceed = (
- not current_day.need_logs_to_advance
- or has_session
- or current_date > datetime.date.today()
- )
-
+ # Add day data and advance the date
sequence.append(
WorkoutDayData(
- iteration=counter[current_day],
+ iteration=iteration_counter[current_day.id],
date=current_date,
day=current_day,
- label=label_dates.get(current_date),
+ label=labels.get(current_date),
)
)
-
- if can_proceed:
- current_day = days_list[index]
-
- current_date += delta
+ current_date += datetime.timedelta(days=1)
+ is_first = False
cache.set(cache_key, sequence, settings.WGER_SETTINGS['ROUTINE_CACHE_TTL'])
return sequence
@@ -315,7 +319,7 @@ class Routine(models.Model):
the results for "today"
"""
if date is None:
- date = datetime.date.today()
+ date = timezone.localdate()
for data in self.date_sequence:
if data.date == date:
@@ -332,7 +336,7 @@ class Routine(models.Model):
if iteration is None:
for data in self.date_sequence:
- if data.date == datetime.date.today():
+ if data.date == timezone.localdate():
iteration = data.iteration
break
diff --git a/wger/manager/tests/test_day.py b/wger/manager/tests/test_day.py
index 6f4005748..1174e043d 100644
--- a/wger/manager/tests/test_day.py
+++ b/wger/manager/tests/test_day.py
@@ -13,17 +13,13 @@
# You should have received a copy of the GNU Affero General Public License
# Standard Library
-import datetime
from dataclasses import asdict
from decimal import Decimal
# wger
from wger.core.tests.base_testcase import WgerTestCase
from wger.manager.dataclasses import SetConfigData
-from wger.manager.models import (
- Day,
- WorkoutLog,
-)
+from wger.manager.models import Day
class DaySlotTestCase(WgerTestCase):
@@ -215,47 +211,3 @@ class DayModelTestCase(WgerTestCase):
day.name = 'foo'
day.save()
self.assertEqual(day.slots.count(), 3)
-
- def test_can_proceed_future(self):
- """
- Test that can_proceed returns true when the date is in the future
- """
-
- day = Day.objects.get(pk=1)
- self.assertTrue(day.can_proceed(date=datetime.date.today() + datetime.timedelta(days=1)))
-
- def test_can_proceed_present(self):
- """
- Test that can_proceed returns true when need_logs_to_advance is false
- """
-
- day = Day.objects.get(pk=1)
- day.need_logs_to_advance = False
- self.assertTrue(day.can_proceed(date=datetime.date.today()))
-
- def test_can_proceed_no_logs(self):
- """
- Test that can_proceed returns false when need_logs_to_advance is true and there are no logs
- """
-
- day = Day.objects.get(pk=1)
- day.need_logs_to_advance = True
- self.assertFalse(day.can_proceed(date=datetime.date.today()))
-
- def test_can_proceed(self):
- """
- Test that can_proceed returns true when need_logs_to_advance is true and there are logs
- """
-
- day = Day.objects.get(pk=1)
- day.need_logs_to_advance = True
- WorkoutLog.objects.create(
- date=datetime.datetime.now(),
- weight_unit_id=1,
- repetitions_unit_id=1,
- user=day.routine.user,
- repetitions=1,
- weight=1,
- exercise_id=1,
- )
- self.assertFalse(day.can_proceed(date=datetime.date.today()))
diff --git a/wger/manager/tests/test_routine.py b/wger/manager/tests/test_routine.py
index dfb36bf90..bd2f9ed05 100644
--- a/wger/manager/tests/test_routine.py
+++ b/wger/manager/tests/test_routine.py
@@ -32,6 +32,9 @@ class RoutineTestCase(WgerTestCase):
Test the different day and date functions
"""
+ maxDiff = None
+ """Show full diff on assert failures"""
+
routine: Routine
day1: Day
day2: Day
@@ -66,12 +69,29 @@ class RoutineTestCase(WgerTestCase):
Label(routine=self.routine, start_offset=0, end_offset=3, label='First label').save()
Label(routine=self.routine, start_offset=4, end_offset=5, label='Second label').save()
+ def test_labels(self):
+ """
+ Test that the labels are correctly assigned to their dates
+ """
+
+ self.assertEqual(
+ self.routine.label_dict,
+ {
+ datetime.date(2024, 1, 1): 'First label',
+ datetime.date(2024, 1, 2): 'First label',
+ datetime.date(2024, 1, 3): 'First label',
+ datetime.date(2024, 1, 4): 'First label',
+ datetime.date(2024, 1, 5): 'Second label',
+ datetime.date(2024, 1, 6): 'Second label',
+ },
+ )
+
def test_date_sequences(self):
"""
Test that the days are correctly outputted in a sequence
"""
- self.assertEqual(
+ self.assertListEqual(
self.routine.date_sequence,
[
WorkoutDayData(
@@ -137,13 +157,249 @@ class RoutineTestCase(WgerTestCase):
],
)
+ def test_date_sequences_need_logs_to_advance_no_session(self):
+ """
+ Test that days do not advance if they have the need_logs_to_advance flag set
+ and there are no logs
+ """
+
+ # Arrange
+ today = datetime.date.today()
+ start = today - datetime.timedelta(days=5)
+ self.routine.start = start
+ self.routine.end = today + datetime.timedelta(weeks=3)
+ self.day1.need_logs_to_advance = True
+ self.day1.save()
+ WorkoutSession.objects.all().delete()
+ Label.objects.all().delete()
+
+ # Assert
+ sequence = self.routine.date_sequence
+
+ # The first day does not advance
+ self.assertEqual(
+ sequence[0],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start,
+ ),
+ )
+ self.assertEqual(
+ sequence[1],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=1),
+ ),
+ )
+ self.assertEqual(
+ sequence[2],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=2),
+ ),
+ )
+ self.assertEqual(
+ sequence[3],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=3),
+ ),
+ )
+ self.assertEqual(
+ sequence[4],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=4),
+ ),
+ )
+ self.assertEqual(
+ sequence[5],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=5),
+ ),
+ )
+
+ # For dates in the future, the days always advance
+ self.assertEqual(
+ sequence[6],
+ WorkoutDayData(
+ day=self.day2,
+ iteration=1,
+ date=start + datetime.timedelta(days=6),
+ ),
+ )
+ self.assertEqual(
+ sequence[7],
+ WorkoutDayData(
+ day=self.day3,
+ iteration=1,
+ date=start + datetime.timedelta(days=7),
+ ),
+ )
+ self.assertEqual(
+ sequence[8],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=2,
+ date=start + datetime.timedelta(days=8),
+ ),
+ )
+ self.assertEqual(
+ sequence[9],
+ WorkoutDayData(
+ day=self.day2,
+ iteration=2,
+ date=start + datetime.timedelta(days=9),
+ ),
+ )
+ self.assertEqual(
+ sequence[10],
+ WorkoutDayData(
+ day=self.day3,
+ iteration=2,
+ date=start + datetime.timedelta(days=10),
+ ),
+ )
+ self.assertEqual(
+ sequence[11],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=3,
+ date=start + datetime.timedelta(days=11),
+ ),
+ )
+
+ def test_date_sequences_need_logs_to_advance_session_available(self):
+ """
+ Test that days only advance if they have the need_logs_to_advance flag set
+ and there are is a session
+ """
+
+ # Arrange
+ today = datetime.date.today()
+ start = today - datetime.timedelta(days=5)
+
+ self.routine.start = start
+ self.routine.end = today + datetime.timedelta(days=10)
+ self.day1.need_logs_to_advance = True
+ self.day1.save()
+
+ Label.objects.all().delete()
+ WorkoutSession.objects.all().delete()
+ WorkoutSession.objects.create(
+ day=self.day1,
+ routine=self.routine,
+ date=start + datetime.timedelta(days=2),
+ user=self.routine.user,
+ )
+
+ # Assert
+ sequence = self.routine.date_sequence
+ self.assertEqual(
+ sequence[0],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start,
+ ),
+ )
+ self.assertEqual(
+ sequence[1],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=1),
+ ),
+ )
+
+ # Session saved on this day
+ self.assertEqual(
+ sequence[2],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=start + datetime.timedelta(days=2),
+ ),
+ )
+
+ # Day can advance
+ self.assertEqual(
+ sequence[3],
+ WorkoutDayData(
+ day=self.day2,
+ iteration=1,
+ date=start + datetime.timedelta(days=3),
+ ),
+ )
+ self.assertEqual(
+ sequence[4],
+ WorkoutDayData(
+ day=self.day3,
+ iteration=1,
+ date=start + datetime.timedelta(days=4),
+ ),
+ )
+ self.assertEqual(
+ sequence[5],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=2,
+ date=start + datetime.timedelta(days=5),
+ ),
+ )
+
+ # For dates in the future, the days always advance
+ self.assertEqual(
+ sequence[6],
+ WorkoutDayData(
+ day=self.day2,
+ iteration=2,
+ date=start + datetime.timedelta(days=6),
+ ),
+ )
+ self.assertEqual(
+ sequence[7],
+ WorkoutDayData(
+ day=self.day3,
+ iteration=2,
+ date=start + datetime.timedelta(days=7),
+ ),
+ )
+ self.assertEqual(
+ sequence[8],
+ WorkoutDayData(
+ day=self.day1,
+ iteration=3,
+ date=start + datetime.timedelta(days=8),
+ ),
+ )
+ self.assertEqual(
+ sequence[9],
+ WorkoutDayData(
+ day=self.day2,
+ iteration=3,
+ date=start + datetime.timedelta(days=9),
+ ),
+ )
+
def test_date_sequence_week_skip(self):
"""
Test that the fit_in_week flag works
"""
+
+ # Arrange
self.routine.fit_in_week = True
+ self.routine.end = datetime.date(2024, 1, 12)
self.routine.save()
+ # Assert
self.assertListEqual(
self.routine.date_sequence,
[
@@ -188,26 +444,32 @@ class RoutineTestCase(WgerTestCase):
day=None,
iteration=1,
date=datetime.date(2024, 1, 7),
- label=None,
),
- # Monday
+ # Monday, start the cycle again
WorkoutDayData(
day=self.day1,
iteration=2,
date=datetime.date(2024, 1, 8),
- label=None,
),
WorkoutDayData(
day=self.day2,
iteration=2,
date=datetime.date(2024, 1, 9),
- label=None,
),
WorkoutDayData(
day=self.day3,
iteration=2,
date=datetime.date(2024, 1, 10),
- label=None,
+ ),
+ WorkoutDayData(
+ day=None,
+ iteration=2,
+ date=datetime.date(2024, 1, 11),
+ ),
+ WorkoutDayData(
+ day=None,
+ iteration=2,
+ date=datetime.date(2024, 1, 12),
),
],
)
@@ -221,98 +483,6 @@ class RoutineTestCase(WgerTestCase):
WorkoutDayData(day=self.day1, iteration=3, date=datetime.date(2024, 1, 7)),
)
- def test_date_sequences_logs(self):
- """
- Test that the days are correctly outputted in a sequence
-
- Day one needs logs to advance, till then it will be repeated
- """
-
- # Arrange
- self.day1.need_logs_to_advance = True
- self.day1.save()
-
- dates = [
- datetime.date(2024, 1, 4),
- datetime.date(2024, 1, 7),
- ]
-
- for date in dates:
- session = WorkoutSession(
- user_id=1,
- date=date,
- day=self.day1,
- routine_id=1,
- )
- session.save()
-
- # Assert
- self.assertEqual(
- self.routine.date_sequence,
- [
- WorkoutDayData(
- day=self.day1,
- iteration=1,
- date=datetime.date(2024, 1, 1),
- label='First label',
- ),
- WorkoutDayData(
- day=self.day1,
- iteration=2,
- date=datetime.date(2024, 1, 2),
- label='First label',
- ),
- WorkoutDayData(
- day=self.day1,
- iteration=3,
- date=datetime.date(2024, 1, 3),
- label='First label',
- ),
- WorkoutDayData(
- day=self.day1,
- iteration=4,
- date=datetime.date(2024, 1, 4),
- label='First label',
- ),
- WorkoutDayData(
- day=self.day2,
- iteration=1,
- date=datetime.date(2024, 1, 5),
- label='Second label',
- ),
- WorkoutDayData(
- day=self.day3,
- iteration=1,
- date=datetime.date(2024, 1, 6),
- label='Second label',
- ),
- WorkoutDayData(
- day=self.day1,
- iteration=5,
- date=datetime.date(2024, 1, 7),
- label=None,
- ),
- WorkoutDayData(
- day=self.day2,
- iteration=2,
- date=datetime.date(2024, 1, 8),
- label=None,
- ),
- WorkoutDayData(
- day=self.day3,
- iteration=2,
- date=datetime.date(2024, 1, 9),
- label=None,
- ),
- WorkoutDayData(
- day=self.day1,
- iteration=6,
- date=datetime.date(2024, 1, 10),
- label=None,
- ),
- ],
- )
-
class RoutineApiTestCase(ApiBaseResourceTestCase):
"""