Self hosted FLOSS fitness/workout, nutrition and weight tracker
Cache the generated OpenAPI schema
Roland Geiderff34000ec501
diff --git a/wger/core/tests/api/test_schema.py b/wger/core/tests/api/test_schema.pyindex 6df4a6f35..a4f1047a6 100644--- a/wger/core/tests/api/test_schema.py+++ b/wger/core/tests/api/test_schema.py@@ -13,12 +13,25 @@# 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+from unittest.mock import patch+# Django-from django.test import SimpleTestCase+from django.core.cache import cache+from django.test import (+ SimpleTestCase,+ override_settings,+)+from django.utils import translation# Third Partyfrom drf_spectacular.generators import SchemaGenerator+# wger+from wger.utils.api_schema import CachedSchemaGenerator+from wger.utils.cache import CacheKeyMapper+from wger.version import get_version_with_git+class SchemaPaginationTestCase(SimpleTestCase):"""@@ -58,3 +71,88 @@ class SchemaPaginationTestCase(SimpleTestCase):paginated.append(f'{method} {path}')self.assertEqual(paginated, [])+++class SchemaCacheTestCase(SimpleTestCase):+ """+ The caching of the generated schema+ """++ SCHEMA = {'openapi': '3.0.3'}++ def setUp(self):+ cache.clear()++ @patch.object(SchemaGenerator, 'get_schema')+ def test_repeated_requests_reuse_the_cached_schema(self, generate):+ """+ The schema is generated once and served from the cache afterwards+ """+ generate.return_value = self.SCHEMA++ with translation.override('en'):+ first = CachedSchemaGenerator().get_schema(public=True)+ second = CachedSchemaGenerator().get_schema(public=True)++ self.assertEqual(generate.call_count, 1)+ self.assertEqual(first, self.SCHEMA)+ self.assertEqual(second, self.SCHEMA)++ @patch.object(SchemaGenerator, 'get_schema')+ def test_explicit_version_is_not_cached(self, generate):+ """+ A version passed by the caller never reaches a cache key+ """+ generate.return_value = self.SCHEMA++ with translation.override('en'):+ CachedSchemaGenerator(api_version='whatever').get_schema(public=True)+ CachedSchemaGenerator(api_version='whatever').get_schema(public=True)++ self.assertEqual(generate.call_count, 2)+ key = CacheKeyMapper.api_schema_key(get_version_with_git(), 'en')+ self.assertIsNone(cache.get(key))++ @patch.object(SchemaGenerator, 'get_schema')+ def test_unknown_language_is_not_cached(self, generate):+ """+ A language outside of settings.LANGUAGES never reaches a cache key+ """+ generate.return_value = self.SCHEMA++ with translation.override('not-a-language'):+ CachedSchemaGenerator().get_schema(public=True)+ CachedSchemaGenerator().get_schema(public=True)++ self.assertEqual(generate.call_count, 2)++ @override_settings(DEBUG=True)+ @patch.object(SchemaGenerator, 'get_schema')+ def test_debug_always_generates(self, generate):+ """+ During development the schema follows the code, not the version stamp+ """+ generate.return_value = self.SCHEMA++ with translation.override('en'):+ CachedSchemaGenerator().get_schema(public=True)+ CachedSchemaGenerator().get_schema(public=True)++ self.assertEqual(generate.call_count, 2)++ @patch.object(SchemaGenerator, 'get_schema')+ def test_languages_are_cached_separately(self, generate):+ """+ Each language gets its own entry, the descriptions in the schema are+ translated+ """+ generate.return_value = self.SCHEMA++ for language in ('en', 'de'):+ with translation.override(language):+ CachedSchemaGenerator().get_schema(public=True)++ self.assertEqual(generate.call_count, 2)+ for language in ('en', 'de'):+ key = CacheKeyMapper.api_schema_key(get_version_with_git(), language)+ self.assertEqual(cache.get(key), self.SCHEMA)diff --git a/wger/urls.py b/wger/urls.pyindex 3ac9c8cfd..7f85a97e2 100644--- a/wger/urls.py+++ b/wger/urls.py@@ -48,6 +48,7 @@ from wger.measurements.api import views as measurements_api_viewsfrom wger.nutrition.api import views as nutrition_api_viewsfrom wger.trophies.api import views as trophies_api_viewsfrom wger.utils import oidc_auth+from wger.utils.api_schema import CachedSchemaGeneratorfrom wger.utils.generic_views import TextTemplateViewfrom wger.weight.api import views as weight_api_views@@ -372,7 +373,7 @@ urlpatterns += [# which requires context only the GET handler provides, and crash with 500.path('api/v2/schema',- SpectacularAPIView.as_view(),+ SpectacularAPIView.as_view(generator_class=CachedSchemaGenerator),name='schema',),path(diff --git a/wger/utils/api_schema.py b/wger/utils/api_schema.pyindex 1d4e97b31..909b948ba 100644--- a/wger/utils/api_schema.py+++ b/wger/utils/api_schema.py@@ -12,9 +12,19 @@## You should have received a copy of the GNU Affero General Public License+# Django+from django.conf import settings+from django.core.cache import cache+from django.utils.translation import get_language+# Third Party+from drf_spectacular.generators import SchemaGeneratorfrom rest_framework import serializers+# wger+from wger.utils.cache import CacheKeyMapper+from wger.version import get_version_with_git+class ThumbnailsSerializer(serializers.Serializer):"""@@ -70,3 +80,29 @@ def strip_patch_defaults(result, generator, **kwargs):field.pop('default', None)return result+++class CachedSchemaGenerator(SchemaGenerator):+ """+ Serves the generated schema out of the cache.++ Only wired into the view, not into DEFAULT_GENERATOR_CLASS: the spectacular+ management command has to keep generating from the current code.+ """++ def get_schema(self, request=None, public=False):+ language = get_language()++ # An explicit ?version= is passed through unfiltered while+ # ALLOWED_VERSIONS is empty, so its value is caller-controlled and must+ # not reach a cache key.+ if settings.DEBUG or self.api_version or language not in dict(settings.LANGUAGES):+ return super().get_schema(request=request, public=public)++ key = CacheKeyMapper.api_schema_key(get_version_with_git(), language)+ schema = cache.get(key)+ if schema is None:+ schema = super().get_schema(request=request, public=public)+ cache.set(key, schema)++ return schemadiff --git a/wger/utils/cache.py b/wger/utils/cache.pyindex 525a7f317..debbf3c66 100644--- a/wger/utils/cache.py+++ b/wger/utils/cache.py@@ -49,6 +49,13 @@ class CacheKeyMapper:"""return f'nutrition-cache-log-{self.get_pk(params)}'+ @classmethod+ def api_schema_key(cls, build: str, language: str) -> str:+ """+ get the cache key of the generated OpenAPI schema+ """+ return f'api-schema-{build}-{language}'+@classmethoddef get_exercise_api_key(cls, base_uuid: str):"""