Self hosted FLOSS fitness/workout, nutrition and weight tracker
Start adding caching to routine calculations
Roland Geiderf7d22e248537
diff --git a/wger/manager/api/views.py b/wger/manager/api/views.pyindex dea482507..d73041546 100644--- a/wger/manager/api/views.py+++ b/wger/manager/api/views.py@@ -20,6 +20,8 @@ import jsonfrom datetime import datetime# Django+from django.conf import settings+from django.core.cache import cachefrom django.shortcuts import get_object_or_404# Third Party@@ -46,7 +48,6 @@ from wger.manager.api.serializers import (SetNrConfigSerializer,SlotConfigSerializer,SlotSerializer,- SlotStructureSerializer,WeightConfigSerializer,WorkoutDayDataDisplayModeSerializer,WorkoutDayDataGymModeSerializer,@@ -74,6 +75,7 @@ from wger.manager.models import (WorkoutLog,WorkoutSession,)+from wger.utils.cache import CacheKeyMapperfrom wger.utils.viewsets import WgerOwnerObjectModelViewSetfrom wger.weight.helpers import process_log_entries@@ -122,11 +124,17 @@ class RoutineViewSet(viewsets.ModelViewSet):"""Return the day sequence of the routine"""- return Response(- WorkoutDayDataDisplayModeSerializer(self.get_object().date_sequence, many=True).data- )+ cache_key = CacheKeyMapper.get_routine_api_date_sequence_key(pk)+ cached_data = cache.get(cache_key)+ if cached_data is not None:+ return Response(cached_data)++ out = WorkoutDayDataDisplayModeSerializer(self.get_object().date_sequence, many=True).data+ cache.set(cache_key, out, settings.WGER_SETTINGS['ROUTINE_CACHE_TTL'])- @action(detail=True, url_path='date-sequence-gym-mode')+ return Response(out)++ @action(detail=True, url_path='date-sequence-gym')def date_sequence_gym_mode(self, request, pk):"""Return the day sequence of the routine@@ -135,33 +143,39 @@ class RoutineViewSet(viewsets.ModelViewSet):WorkoutDayDataGymModeSerializer(self.get_object().date_sequence, many=True).data)- @action(detail=True, url_path='current-day-display-mode')+ @action(detail=True, url_path='current-day-display')def current_day_display_mode(self, request, pk):"""Return current day of the routine"""return Response(WorkoutDayDataDisplayModeSerializer(self.get_object().data_for_day()).data)- @action(detail=True, url_path='current-day-gym-mode')+ @action(detail=True, url_path='current-day-gym')def current_day_gym_mode(self, request, pk):"""Return current day of the routine"""return Response(WorkoutDayDataGymModeSerializer(self.get_object().data_for_day()).data)- @action(detail=True, url_path='current-iteration-display-mode')+ @action(detail=True, url_path='current-iteration-display')def current_iteration_display_mode(self, request, pk):"""Return current day of the routine"""- return Response(- WorkoutDayDataDisplayModeSerializer(- self.get_object().data_for_iteration(),- many=True,- ).data- )+ cache_key = CacheKeyMapper.get_routine_api_current_iteration_display_key(pk)+ cached_data = cache.get(cache_key)+ if cached_data is not None:+ return Response(cached_data)++ out = WorkoutDayDataDisplayModeSerializer(+ self.get_object().data_for_iteration(),+ many=True,+ ).data++ cache.set(cache_key, out, settings.WGER_SETTINGS['ROUTINE_CACHE_TTL'])+ return Response(out)- @action(detail=True, url_path='current-iteration-gym-mode')+ @action(detail=True, url_path='current-iteration-gym')def current_iteration_gym_mode(self, request, pk):"""Return current day of the routine@@ -175,7 +189,15 @@ class RoutineViewSet(viewsets.ModelViewSet):"""Return full object structure of the routine."""- return Response(RoutineStructureSerializer(self.get_object()).data)+ cache_key = CacheKeyMapper.get_routine_api_structure_key(pk)+ cached_data = cache.get(cache_key)+ if cached_data is not None:+ return Response(cached_data)++ out = RoutineStructureSerializer(self.get_object()).data++ cache.set(cache_key, out, settings.WGER_SETTINGS['ROUTINE_CACHE_TTL'])+ return Response(out)@action(detail=True, url_path='logs')def logs(self, request, pk):@@ -456,7 +478,6 @@ class RoutineDayViewSet(WgerOwnerObjectModelViewSet):'name','description','is_rest',- 'last_day_in_week','need_logs_to_advance',)diff --git a/wger/manager/helpers.py b/wger/manager/helpers.pyindex 0b28e13fa..8cf9d4df4 100644--- a/wger/manager/helpers.py+++ b/wger/manager/helpers.py@@ -20,6 +20,7 @@ import datetimefrom calendar import HTMLCalendar# Django+from django.core.cache import cachefrom django.urls import reversefrom django.utils.translation import gettext as _@@ -36,6 +37,8 @@ from reportlab.platypus import ()# wger+from wger.manager.models import Routine+from wger.utils.cache import CacheKeyMapperfrom wger.utils.pdf import (header_colour,row_color,@@ -269,3 +272,11 @@ class WorkoutCalendar(HTMLCalendar):Renders a day cell"""return f'<td class="{cssclass}" style="vertical-align: middle;">{body}</td>'+++def reset_routine_cache(instance: Routine):+ """Resets all caches related to a routine"""+ cache.delete(CacheKeyMapper.get_routine_date_sequence_key(instance.id))+ cache.delete(CacheKeyMapper.get_routine_api_date_sequence_key(instance.id))+ cache.delete(CacheKeyMapper.get_routine_api_current_iteration_display_key(instance.id))+ cache.delete(CacheKeyMapper.get_routine_api_structure_key(instance.id))diff --git a/wger/manager/migrations/0018_flexible_routines.py b/wger/manager/migrations/0018_flexible_routines.pyindex 49e14270c..7754b03bc 100644--- a/wger/manager/migrations/0018_flexible_routines.py+++ b/wger/manager/migrations/0018_flexible_routines.py@@ -260,7 +260,7 @@ class Migration(migrations.Migration):('fit_in_week',models.BooleanField(default=False),- )+ ),],options={'ordering': ['-created'],diff --git a/wger/manager/models/abstract_config.py b/wger/manager/models/abstract_config.pyindex d4c63758a..656d0ecb2 100644--- a/wger/manager/models/abstract_config.py+++ b/wger/manager/models/abstract_config.py@@ -17,9 +17,6 @@# Djangofrom django.db import models-# wger-from wger.utils.context_processor import processor-class OperationChoices(models.TextChoices):PLUS = '+'@@ -62,7 +59,6 @@ class AbstractChangeConfig(models.Model):choices=OperationChoices.choices,max_length=1,default=OperationChoices.REPLACE,- null=True,)"""The operation"""@@ -70,7 +66,6 @@ class AbstractChangeConfig(models.Model):choices=StepChoices.choices,max_length=10,default=StepChoices.ABSOLUTE,- null=False,)"""The step by which the change will happen"""@@ -104,12 +99,12 @@ class AbstractChangeConfig(models.Model):# Override values for replaceif self.replace:self.need_log_to_apply = False- self.step = None+ self.step = 'abs'super().save(**kwargs)def get_owner_object(self):"""- Config has no owner information+ Get owner information"""return self.slot_config.slot.day.routinediff --git a/wger/manager/models/routine.py b/wger/manager/models/routine.pyindex 4a8f71e11..07c767231 100644--- a/wger/manager/models/routine.py+++ b/wger/manager/models/routine.py@@ -20,7 +20,9 @@ from collections import Counterfrom typing import List# Django+from django.conf import settingsfrom django.contrib.auth.models import User+from django.core.cache import cachefrom django.core.exceptions import ValidationErrorfrom django.db import modelsfrom django.urls import reverse@@ -28,6 +30,7 @@ from django.utils.translation import gettext_lazy as _# wgerfrom wger.manager.dataclasses import WorkoutDayData+from wger.utils.cache import CacheKeyMapperclass Routine(models.Model):@@ -153,6 +156,11 @@ class Routine(models.Model):If a day needs logs to continue it will be repeated until the user adds one."""+ cache_key = CacheKeyMapper.get_routine_date_sequence_key(self.id)+ cached_data = cache.get(cache_key)+ if cached_data is not None:+ return cached_data+labels = self.label_dictdelta = datetime.timedelta(days=1)current_date = self.start@@ -207,6 +215,7 @@ class Routine(models.Model):current_date += delta+ cache.set(cache_key, out, settings.WGER_SETTINGS['ROUTINE_CACHE_TTL'])return outdef data_for_day(self, date=None) -> WorkoutDayData | None:diff --git a/wger/manager/models/slot_config.py b/wger/manager/models/slot_config.pyindex 24541e703..4a2fb8f7e 100644--- a/wger/manager/models/slot_config.py+++ b/wger/manager/models/slot_config.py@@ -47,6 +47,10 @@ class SetType(models.TextChoices):JUMP = 'jump'+#+# TODO: rename to SlowEntry!+#+class SlotConfig(models.Model):"""Set configuration for an exercise (weight, reps, etc.)diff --git a/wger/manager/signals.py b/wger/manager/signals.pyindex 30f727385..dbc86e1a6 100644--- a/wger/manager/signals.py+++ b/wger/manager/signals.py@@ -15,11 +15,28 @@# You should have received a copy of the GNU Affero General Public License# Django-from django.db.models.signals import post_save+from django.db.models.signals import (+ post_save,+ pre_delete,+ pre_save,+)# wgerfrom wger.gym.helpers import get_user_last_activity+from wger.manager.helpers import reset_routine_cachefrom wger.manager.models import (+ Day,+ MaxRepsConfig,+ MaxRestConfig,+ MaxWeightConfig,+ RepsConfig,+ RestConfig,+ RiRConfig,+ Routine,+ SetsConfig,+ Slot,+ SlotConfig,+ WeightConfig,WorkoutLog,WorkoutSession,)@@ -35,5 +52,79 @@ def update_activity_cache(sender, instance, **kwargs):user.usercache.save()+def update_cache_routine(sender, instance: Routine, **kwargs):+ reset_routine_cache(instance)+++def update_cache_day(sender, instance: Day, **kwargs):+ reset_routine_cache(instance.routine)+++def update_cache_slot(sender, instance: Slot, **kwargs):+ reset_routine_cache(instance.day.routine)+++def update_cache_slot_config(sender, instance: SlotConfig, **kwargs):+ reset_routine_cache(instance.slot.day.routine)+++def update_cache_weight_config(sender, instance: WeightConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_max_weight_config(sender, instance: MaxWeightConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_reps_config(sender, instance: RepsConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_max_reps_config(sender, instance: MaxRepsConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_sets_config(sender, instance: SetsConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_rest_config(sender, instance: RestConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_max_rest_config(sender, instance: MaxRestConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)+++def update_cache_rir_config(sender, instance: RiRConfig, **kwargs):+ reset_routine_cache(instance.slot_config.slot.day.routine)++post_save.connect(update_activity_cache, sender=WorkoutSession)post_save.connect(update_activity_cache, sender=WorkoutLog)++pre_save.connect(update_cache_routine, sender=Routine)+pre_save.connect(update_cache_day, sender=Day)+pre_save.connect(update_cache_slot, sender=Slot)+pre_save.connect(update_cache_slot_config, sender=SlotConfig)+pre_save.connect(update_cache_weight_config, sender=WeightConfig)+pre_save.connect(update_cache_max_weight_config, sender=MaxWeightConfig)+pre_save.connect(update_cache_reps_config, sender=RepsConfig)+pre_save.connect(update_cache_max_reps_config, sender=MaxRepsConfig)+pre_save.connect(update_cache_sets_config, sender=SetsConfig)+pre_save.connect(update_cache_rest_config, sender=RestConfig)+pre_save.connect(update_cache_max_rest_config, sender=MaxRestConfig)+pre_save.connect(update_cache_rir_config, sender=RiRConfig)++pre_delete.connect(update_cache_routine, sender=Routine)+pre_delete.connect(update_cache_day, sender=Day)+pre_delete.connect(update_cache_slot, sender=Slot)+pre_delete.connect(update_cache_slot_config, sender=SlotConfig)+pre_delete.connect(update_cache_weight_config, sender=WeightConfig)+pre_delete.connect(update_cache_max_weight_config, sender=MaxWeightConfig)+pre_delete.connect(update_cache_reps_config, sender=RepsConfig)+pre_delete.connect(update_cache_max_reps_config, sender=MaxRepsConfig)+pre_delete.connect(update_cache_sets_config, sender=SetsConfig)+pre_delete.connect(update_cache_rest_config, sender=RestConfig)+pre_delete.connect(update_cache_max_rest_config, sender=MaxRestConfig)+pre_delete.connect(update_cache_rir_config, sender=RiRConfig)diff --git a/wger/settings_global.py b/wger/settings_global.pyindex 190408139..80c8245bc 100644--- a/wger/settings_global.py+++ b/wger/settings_global.py@@ -541,6 +541,7 @@ WGER_SETTINGS = {'EMAIL_FROM': 'wger Workout Manager <[email protected]>','EXERCISE_CACHE_TTL': 3600,'INGREDIENT_CACHE_TTL': 604800, # one week+ 'ROUTINE_CACHE_TTL': 4 * 604800, # one month'MIN_ACCOUNT_AGE_TO_TRUST': 21,'SYNC_EXERCISES_CELERY': False,'SYNC_EXERCISE_IMAGES_CELERY': False,diff --git a/wger/utils/cache.py b/wger/utils/cache.pyindex 77b2fa60e..dfb05f7af 100644--- a/wger/utils/cache.py+++ b/wger/utils/cache.py@@ -52,12 +52,15 @@ class CacheKeyMapper:Simple class for mapping the cache keys of different objects"""- # Keys used by the cacheLANGUAGE_CACHE_KEY = 'language-{0}'INGREDIENT_CACHE_KEY = 'ingredient-{0}'WORKOUT_LOG_LIST = 'workout-log-hash-{0}'NUTRITION_CACHE_KEY = 'nutrition-cache-log-{0}'EXERCISE_API_KEY = 'base-uuid-{0}'+ ROUTINE_DATE_SEQUENCE_KEY = 'routine-date-sequence-{0}'+ ROUTINE_API_DATE_SEQUENCE_DISPLAY_KEY = 'routine-api-date-sequence-display{0}'+ ROUTINE_API_CURRENT_ITERATION_DISPLAY_KEY = 'routine-api-current-iteration-sequence-display{0}'+ ROUTINE_API_STRUCTURE_KEY = 'routine-api-structure-{0}'def get_pk(self, param):"""@@ -96,5 +99,21 @@ class CacheKeyMapper:"""return cls.EXERCISE_API_KEY.format(base_uuid)+ @classmethod+ def get_routine_date_sequence_key(cls, id: int):+ return cls.ROUTINE_DATE_SEQUENCE_KEY.format(id)++ @classmethod+ def get_routine_api_date_sequence_key(cls, id: int):+ return cls.ROUTINE_API_DATE_SEQUENCE_DISPLAY_KEY.format(id)++ @classmethod+ def get_routine_api_current_iteration_display_key(cls, id: int):+ return cls.ROUTINE_API_CURRENT_ITERATION_DISPLAY_KEY.format(id)++ @classmethod+ def get_routine_api_structure_key(cls, id: int):+ return cls.ROUTINE_API_STRUCTURE_KEY.format(id)+cache_mapper = CacheKeyMapper()