commonground-api-common 2.5.4__tar.gz → 2.6.0__tar.gz

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/CHANGELOG.rst

@@ -2,6 +2,24 @@
 Change history
 ==============
 
+2.6.0 (2025-04-07)
+------------------
+
+**New features**
+
+* [open-zaak/open-zaak#1970] Add several DRF hyperlinked field classes that cache the results of ``reverse()`` to
+  avoid running the same logic multiple times. This can improve performance for serialization
+  with hyperlinked fields by quite a bit, especially for list operations
+
+    * ``vng_api_common.serializers.CachedHyperlinkedIdentityField``
+    * ``vng_api_common.serializers.CachedHyperlinkedRelatedField``
+    * ``vng_api_common.serializers.CachedNestedHyperlinkedRelatedField``
+
+2.5.5 (2025-03-21)
+------------------
+
+* [maykinmedia/open-api-framework#59] Remove ``SITE_DOMAIN`` default value and update docs
+
 2.5.4 (2025-03-20)
 ------------------
 

{commonground_api_common-2.5.4/commonground_api_common.egg-info → commonground_api_common-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.5.4
+Version: 2.6.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0/commonground_api_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commonground-api-common
-Version: 2.5.4
+Version: 2.6.0
 Summary: Commonground API tooling
 Home-page: https://github.com/maykinmedia/commonground-api-common
 Author: Maykin Media, VNG-Realisatie

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/commonground_api_common.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ commonground_api_common.egg-info/requires.txt
 commonground_api_common.egg-info/top_level.txt
 tests/test_autorisatie_validation.py
 tests/test_cache_headers.py
+tests/test_cached_hyperlinkrelatedfields.py
 tests/test_check_query_params.py
 tests/test_checks.py
 tests/test_choices.py

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = commonground-api-common
-version = 2.5.4
+version = 2.6.0
 description = Commonground API tooling
 long_description = file: README.rst
 url = https://github.com/maykinmedia/commonground-api-common

commonground_api_common-2.6.0/tests/test_cached_hyperlinkrelatedfields.py

@@ -0,0 +1,127 @@
+from unittest.mock import patch
+
+from django.urls import reverse
+
+import pytest
+from rest_framework.reverse import reverse
+
+from testapp.factories import GroupFactory, PersonFactory
+
+
+@pytest.mark.django_db
+def test_cached_hyperlinkedrelatedfield(api_client):
+    """
+    Caching is applied to the base URI for each view in CachedHyperlinkedRelatedField,
+    but this cache must be only be applied within the same requests, to ensure that
+    requests with different HTTP_HOSTs show the correct domain in their responses
+    """
+    group = GroupFactory.create(name="group1")
+    person = PersonFactory.create(
+        name="John Doe", address_street="Foo", address_number="1", group=group
+    )
+
+    response = api_client.get(reverse("person-detail", kwargs={"pk": person.pk}))
+
+    expected = {
+        "url": f"http://testserver{reverse('person-detail', kwargs={'pk': person.pk})}",
+        "address": {"street": "Foo", "number": "1"},
+        "name": "John Doe",
+        "group_name": "group1",
+        "group_url": f"http://testserver{reverse('group-detail', kwargs={'pk': group.pk})}",
+    }
+
+    assert response.data == expected
+
+    response = api_client.get(
+        reverse("person-detail", kwargs={"pk": person.pk}), HTTP_HOST="different.local"
+    )
+
+    expected = {
+        "url": f"http://different.local{reverse('person-detail', kwargs={'pk': person.pk})}",
+        "address": {"street": "Foo", "number": "1"},
+        "name": "John Doe",
+        "group_name": "group1",
+        "group_url": f"http://different.local{reverse('group-detail', kwargs={'pk': group.pk})}",
+    }
+
+    assert response.data == expected
+
+
+@pytest.mark.django_db
+def test_cached_nested_hyperlinkedrelatedfield(api_client):
+    """
+    Caching is applied to the base URI for each view in CachedNestedHyperlinkedRelatedField,
+    but this cache must be only be applied within the same requests, to ensure that
+    requests with different HTTP_HOSTs show the correct domain in their responses
+    """
+    group = GroupFactory.create(name="group1")
+    person1 = PersonFactory.create(
+        name="John Doe", address_street="Foo", address_number="1", group=group
+    )
+    person2 = PersonFactory.create(
+        name="Jane Doe", address_street="Bar", address_number="2", group=group
+    )
+
+    with patch("rest_framework.relations.reverse", side_effect=reverse) as mock_reverse:
+        response = api_client.get(reverse("group-detail", kwargs={"pk": group.pk}))
+
+        # Without caching 6 calls would be made to reverse, caching reduces this to 3
+        # (one for each view)
+        assert mock_reverse.call_count == 3
+        assert mock_reverse.call_args_list[0].args == ("person-detail",)
+        assert mock_reverse.call_args_list[1].args == ("group-detail",)
+        assert mock_reverse.call_args_list[2].args == ("nested-person-detail",)
+
+    expected = {
+        "persons": [
+            {
+                "url": f"http://testserver{reverse('person-detail', kwargs={'pk': person1.pk})}",
+                "address": {"street": "Foo", "number": "1"},
+                "name": "John Doe",
+                "group_name": "group1",
+                "group_url": f"http://testserver{reverse('group-detail', kwargs={'pk': group.pk})}",
+            },
+            {
+                "url": f"http://testserver{reverse('person-detail', kwargs={'pk': person2.pk})}",
+                "address": {"street": "Bar", "number": "2"},
+                "name": "Jane Doe",
+                "group_name": "group1",
+                "group_url": f"http://testserver{reverse('group-detail', kwargs={'pk': group.pk})}",
+            },
+        ],
+        "nested_persons": [
+            f"http://testserver{reverse('nested-person-detail', kwargs={'group_pk': group.pk, 'pk': person1.pk})}",
+            f"http://testserver{reverse('nested-person-detail', kwargs={'group_pk': group.pk, 'pk': person2.pk})}",
+        ],
+    }
+
+    assert response.data == expected
+
+    response = api_client.get(
+        reverse("group-detail", kwargs={"pk": group.pk}), HTTP_HOST="different.local"
+    )
+
+    expected = {
+        "persons": [
+            {
+                "url": f"http://different.local{reverse('person-detail', kwargs={'pk': person1.pk})}",
+                "address": {"street": "Foo", "number": "1"},
+                "name": "John Doe",
+                "group_name": "group1",
+                "group_url": f"http://different.local{reverse('group-detail', kwargs={'pk': group.pk})}",
+            },
+            {
+                "url": f"http://different.local{reverse('person-detail', kwargs={'pk': person2.pk})}",
+                "address": {"street": "Bar", "number": "2"},
+                "name": "Jane Doe",
+                "group_name": "group1",
+                "group_url": f"http://different.local{reverse('group-detail', kwargs={'pk': group.pk})}",
+            },
+        ],
+        "nested_persons": [
+            f"http://different.local{reverse('nested-person-detail', kwargs={'group_pk': group.pk, 'pk': person1.pk})}",
+            f"http://different.local{reverse('nested-person-detail', kwargs={'group_pk': group.pk, 'pk': person2.pk})}",
+        ],
+    }
+
+    assert response.data == expected

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/tests/test_gegevensgroepen.py

@@ -1,3 +1,5 @@
+from rest_framework.test import APIRequestFactory
+
 from testapp.models import Group, Person
 from testapp.serializers import PersonSerializer, PersonSerializer2
 
@@ -93,7 +95,11 @@ def test_assignment_missing_optional_key():
 
 def test_nullable_gegevensgroep():
     person = Person(name="bla", address_street="", address_number="")
-    output = PersonSerializer().to_representation(instance=person)
+    factory = APIRequestFactory()
+    request = factory.get("/persons")
+    output = PersonSerializer(context={"request": request}).to_representation(
+        instance=person
+    )
     assert output["address"] == {
         "street": "",
         "number": "",

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/tests/test_nested_serializer_validation.py

@@ -43,7 +43,7 @@ def test_create_invalid_params():
     """
     serializer = GroupSerializer(
         data={
-            "person": [
+            "persons": [
                 {
                     "name": "john",
                     "address": {"street": "Keizersgracht", "number": "416"},
@@ -59,17 +59,17 @@ def test_create_invalid_params():
 
     validation_errors = list(get_validation_errors(serializer.errors))
 
-    assert validation_errors[0]["name"] == "person.1.address.street"
+    assert validation_errors[0]["name"] == "persons.1.address.street"
     assert validation_errors[0]["code"] == "required"
 
-    assert validation_errors[1]["name"] == "person.2.name"
+    assert validation_errors[1]["name"] == "persons.2.name"
     assert validation_errors[1]["code"] == "required"
 
 
 def test_create_valid():
     serializer = GroupSerializer(
         data={
-            "person": [
+            "persons": [
                 {
                     "name": "test",
                     "address": {"street": "Keizersgracht", "number": "117"},

commonground_api_common-2.6.0/vng_api_common/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.6.0"

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/vng_api_common/authorizations/utils.py

@@ -12,6 +12,7 @@ def generate_jwt(client_id, secret, user_id, user_representation):
             secret=secret,
             user_id=user_id,
             user_representation=user_representation,
+            jwt_valid_for=5 * 60,
         )
     )
     return f"Bearer {auth._token}"

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/vng_api_common/conf/api.py

@@ -15,7 +15,6 @@ __all__ = [
     "NOTIFICATIONS_KANAAL",
     "REDOC_SETTINGS",
     "SECURITY_DEFINITION_NAME",
-    "SITE_DOMAIN",
 ]
 
 API_VERSION = "1.0.0-rc1"  # semantic version
@@ -99,5 +98,3 @@ COMMON_SPEC = f"https://raw.githubusercontent.com/{vng_repo}/feature/{vng_branch
 JWT_LEEWAY = 0  # default in PyJWT
 
 COMMONGROUND_API_COMMON_GET_DOMAIN = "vng_api_common.utils.get_site_domain"
-
-SITE_DOMAIN = "example.com"

{commonground_api_common-2.5.4 → commonground_api_common-2.6.0}/vng_api_common/serializers.py

@@ -1,13 +1,17 @@
 import datetime
 import inspect
 from collections import OrderedDict
+from functools import reduce
 from typing import List, Optional, Tuple, Union
 
 from django.db import models, transaction
+from django.db.models import Model
 from django.utils.translation import gettext_lazy as _
 
 import isodate
 from rest_framework import fields, serializers
+from rest_framework.request import Request
+from rest_framework_nested.relations import NestedHyperlinkedRelatedField
 
 from .choices import TextChoicesWithDescriptions
 from .descriptors import GegevensGroepType
@@ -164,11 +168,11 @@ class GegevensGroepSerializer(
 
     Usage::
 
-    >>> class VerlengingSerializer(GegevensGroepSerializer):
-    ...     class Meta:
-    ...         model = Zaak
-    ...         gegevensgroep = 'verlenging'
-    >>>
+        >>> class VerlengingSerializer(GegevensGroepSerializer):
+        ...     class Meta:
+        ...         model = Zaak
+        ...         gegevensgroep = 'verlenging'
+        >>>
 
     Where ``Zaak.verlenging`` is a :class:``GegevensGroepType``.
     """
@@ -275,7 +279,77 @@ class NestedGegevensGroepMixin:
         return super().update(instance, validated_data)
 
 
-class LengthHyperlinkedRelatedField(serializers.HyperlinkedRelatedField):
+def get_nested_fk_attribute(instance, relation_path):
+    """
+    Retrieves an attribute from a nested foreign key relation.
+
+    Args:
+    - instance: The model instance (e.g., Book).
+    - relation_path: A string with the relation path, e.g., 'author__publisher__name'.
+
+    Returns:
+    - The value of the nested attribute or None if not found.
+    """
+    relations = relation_path.split("__")
+
+    return reduce(
+        lambda obj, attr: getattr(obj, attr, None) if obj else None, relations, instance
+    )
+
+
+class CacheMixin:
+    """
+    Mixin for Hyperlinked DRF fields to cache the base URI per view, to avoid
+    having to recalculate this for each related object that has to be serialized
+
+    This cache is stored on the field instance itself, so it's reset between requests
+    """
+
+    lookup_url_kwarg = ""  # Should be defined on `HyperlinkedRelatedField`
+    identifier_placeholder = "id-placeholder"
+
+    def get_extra_reverse_kwargs(self) -> dict[str, str]:
+        """
+        Hook to inject extra kwargs to be passed to `reverse()`
+        """
+        return {}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self._reverse_cache = {}
+
+    def get_url(
+        self, obj: Model, view_name: str, request: Request, format: str | None
+    ) -> str | None:
+        # Unsaved objects will not yet have a valid URL.
+        if hasattr(obj, "pk") and obj.pk in (None, ""):
+            return None
+
+        base_url = self._reverse_cache.get(view_name)
+
+        if base_url is None:
+            # If not cached, compute and cache it for this request cycle
+            try:
+                # Insert placeholders for identifiers, these will be replaced by
+                # real identifiers later on
+                kwargs = {self.lookup_url_kwarg: self.identifier_placeholder}
+                kwargs.update(self.get_extra_reverse_kwargs())
+
+                base_url = self.reverse(
+                    view_name, kwargs=kwargs, request=request, format=format
+                )
+                self._reverse_cache[view_name] = base_url
+            except Exception as e:
+                raise ValueError(f"Could not resolve reverse for {view_name}: {e}")
+
+        url = base_url.replace(
+            self.identifier_placeholder, str(getattr(obj, self.lookup_url_kwarg))
+        )
+        return url
+
+
+class LengthHyperlinkedRelatedField(CacheMixin, serializers.HyperlinkedRelatedField):
     default_error_messages = {
         "max_length": _("Ensure this field has no more than {max_length} characters."),
         "min_length": _("Ensure this field has at least {min_length} characters."),
@@ -296,3 +370,40 @@ class LengthHyperlinkedRelatedField(serializers.HyperlinkedRelatedField):
             self.fail("min_length", max_length=self.min_length, length=len(data))
 
         return super().to_internal_value(data)
+
+
+class CachedHyperlinkedRelatedField(CacheMixin, serializers.HyperlinkedRelatedField):
+    """
+    Subclass of ``serializers.HyperlinkedRelatedField`` that applies caching in
+    ``.get_url()`` to ``reverse()`` calls to improve serialization performance
+    """
+
+
+class CachedHyperlinkedIdentityField(CacheMixin, serializers.HyperlinkedIdentityField):
+    """
+    Subclass of ``serializers.HyperlinkedIdentityField`` that applies caching in
+    ``.get_url()`` to ``reverse()`` calls to improve serialization performance
+    """
+
+
+class CachedNestedHyperlinkedRelatedField(CacheMixin, NestedHyperlinkedRelatedField):
+    """
+    Subclass of ``serializers.HyperlinkedIdentityField`` that applies caching in
+    ``.get_url()`` to ``reverse()`` calls to improve serialization performance
+    """
+
+    def get_extra_reverse_kwargs(self) -> dict[str, str]:
+        return self.parent_lookup_kwargs
+
+    def get_url(
+        self, obj: Model, view_name: str, request: Request, format: str | None
+    ) -> str | None:
+        url = super().get_url(obj, view_name, request, format)
+
+        if not url:
+            return None
+
+        # Replace the placeholder from the cached base URI with the actual identifier
+        for k, v in self.parent_lookup_kwargs.items():
+            url = url.replace(v, str(get_nested_fk_attribute(obj, v)))
+        return url

commonground_api_common-2.5.4/vng_api_common/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.5.4"