omit default values for read-only child serializers (#13340)

This commit is contained in:
Oliver authored and GitHub committed 2026-11-21 09:59:00 +11:00
1 parent 9d7aeb4d3c
commit 371ac83bbb
2 files changed
+62 -3

No files matched your search

+26 -2
View File
@@ -285,6 +285,23 @@ class InvenTreeMetadata(SimpleMetadata):
return field_value
@staticmethod
def is_read_only_serializer(serializer) -> bool:
"""Return True if the serializer (or any of its parents) is read-only.
A nested serializer declared with read_only=True (including the child of a
read-only ListSerializer) cannot accept input data.
"""
node = serializer
while node is not None:
if getattr(node, 'read_only', False):
return True
node = getattr(node, 'parent', None)
return False
def get_serializer_info(self, serializer):
"""Override get_serializer_info so that we can add 'default' values to any fields whose Meta.model specifies a default value."""
self.serializer = serializer
@@ -328,12 +345,19 @@ class InvenTreeMetadata(SimpleMetadata):
'label': 'verbose_name',
}
# Default values are only meaningful for writable serializers.
# Nested read-only serializers (e.g. 'build_detail') cannot accept input,
# and computing their defaults can be expensive (e.g. generating the next reference).
include_defaults = not self.is_read_only_serializer(serializer)
try:
model_class = serializer.Meta.model
model_fields = model_meta.get_field_info(model_class)
if model_default_func := getattr(model_class, 'api_defaults', None):
model_default_func = getattr(model_class, 'api_defaults', None)
if include_defaults and model_default_func:
model_default_values = model_default_func(request=request) or {}
else:
model_default_values = {}
@@ -347,7 +371,7 @@ class InvenTreeMetadata(SimpleMetadata):
if name in write_only_fields:
serializer_info[name]['write_only'] = True
if field.has_default():
if include_defaults and field.has_default():
default = field.default
if callable(default):
+36 -1
View File
@@ -12,7 +12,7 @@ from django_q.models import OrmQ
from rest_framework import status
from audit.models import AuditLogEntry
from build.models import Build, BuildItem, BuildLine
from build.models import Build, BuildItem, BuildLine, generate_next_build_reference
from build.status_codes import BuildStatus
from common.models import Note
from common.settings import set_global_setting
@@ -1315,6 +1315,11 @@ class BuildListTest(BuildAPITest):
for key in ['model', 'api_url', 'pk_field']:
self.assertIn(key, field)
# Default values are provided for the (writable) top-level serializer
post = data['actions']['POST']
self.assertEqual(post['reference']['default'], generate_next_build_reference())
self.assertEqual(post['issued_by']['default'], self.user.pk)
def test_detail_fields(self):
"""Test inclusion of detail fields."""
# Test without extra detail fields
@@ -1874,6 +1879,36 @@ class BuildOutputCancelTest(BuildAPITest):
class BuildLineTests(BuildAPITest):
"""Unit tests for the BuildLine API endpoints."""
def test_options_nested_defaults(self):
"""Nested read-only serializers do not report (expensive) default values.
Computing the default 'reference' for each nested Build serializer
previously required multiple database queries per nested instance.
"""
url = reverse('api-build-line-list')
data = self.options(
url,
data={'allocations': True, 'part_detail': True, 'bom_item_detail': True},
expected_code=200,
max_query_count=40,
).data
build_detail = data['actions']['GET']['build_detail']
self.assertEqual(build_detail['type'], 'nested object')
# Model-derived defaults (Build.api_defaults / model field defaults) are skipped
for name in ['reference', 'issued_by', 'status', 'priority']:
self.assertIn(name, build_detail['children'])
self.assertNotIn('default', build_detail['children'][name])
# Nested serializers within a read-only list serializer are also excluded
allocation = data['actions']['GET']['allocations']['child']['children']
for name in ['quantity']:
self.assertIn(name, allocation)
self.assertNotIn('default', allocation[name])
def test_consumed_read_only(self):
"""The 'consumed' quantity cannot be changed via the BuildLine API.