mirror of
https://github.com/inventree/InvenTree.git
synced 2026-11-19 22:47:48 +00:00
[UI] Show consuming build orders in child stock items (#13208)
* Show consuming build orders in child stock items * Reference PR in changelog and API version notes * Clarify stock reference test setup and assertions * Use optional build details for consumed stock * Include consuming build references in stock exports * Make stock prefetch test portable to MySQL
This commit is contained in:
1 parent
5e7bf4f92d
commit
6c363d4a32
9 files changed
+444
-5
No files matched your search
@@ -1,11 +1,14 @@
|
||||
"""InvenTree API version information."""
|
||||
|
||||
# InvenTree API version
|
||||
INVENTREE_API_VERSION = 574
|
||||
INVENTREE_API_VERSION = 575
|
||||
"""Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
|
||||
|
||||
INVENTREE_API_TEXT = """
|
||||
|
||||
v575 -> 2026-11-10 : https://github.com/inventree/InvenTree/pull/13208
|
||||
- Adds optional read-only "consumed_by_detail" to the StockItem API
|
||||
|
||||
v574 -> 2026-11-07 : https://github.com/inventree/InvenTree/pull/13169
|
||||
- breaking: Basic authentication can now be disabled - controlled with INVENTREE_BASIC_AUTH_ENABLED
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
"""Build summaries for related objects without importing stock serializers."""
|
||||
|
||||
from generic.states.fields import InvenTreeCustomStatusSerializerMixin
|
||||
from InvenTree.serializers import InvenTreeModelSerializer
|
||||
|
||||
from .models import Build
|
||||
|
||||
|
||||
class BuildBriefSerializer(
|
||||
InvenTreeCustomStatusSerializerMixin, InvenTreeModelSerializer
|
||||
):
|
||||
"""Serialize build identity and status for related-object detail fields."""
|
||||
|
||||
class Meta:
|
||||
"""Serializer options."""
|
||||
|
||||
model = Build
|
||||
fields = ['pk', 'reference', 'title', 'status', 'status_custom_key']
|
||||
read_only_fields = fields
|
||||
@@ -1113,6 +1113,7 @@ class StockOutputOptions(OutputConfiguration):
|
||||
InvenTreeOutputOption('supplier_part_detail'),
|
||||
InvenTreeOutputOption('location_detail'),
|
||||
InvenTreeOutputOption('tests'),
|
||||
InvenTreeOutputOption('consumed_by_detail'),
|
||||
]
|
||||
|
||||
|
||||
|
||||
@@ -29,6 +29,7 @@ import part.serializers as part_serializers
|
||||
import stock.filters
|
||||
import stock.status_codes
|
||||
from audit.helpers import audit_event, write_batched
|
||||
from build.serializers_brief import BuildBriefSerializer
|
||||
from common.settings import get_global_setting
|
||||
from generic.states.fields import InvenTreeCustomStatusSerializerMixin
|
||||
from importer.registry import register_importer
|
||||
@@ -325,6 +326,7 @@ class StockItemSerializer(
|
||||
SKIP_CREATE_FIELDS = ['duplicate']
|
||||
|
||||
export_child_fields = [
|
||||
'consumed_by_detail.reference',
|
||||
'part_detail.name',
|
||||
'part_detail.description',
|
||||
'part_detail.IPN',
|
||||
@@ -353,6 +355,7 @@ class StockItemSerializer(
|
||||
'belongs_to',
|
||||
'build',
|
||||
'consumed_by',
|
||||
'consumed_by_detail',
|
||||
'customer',
|
||||
'delete_on_deplete',
|
||||
'expiry_date',
|
||||
@@ -686,6 +689,18 @@ class StockItemSerializer(
|
||||
help_text=_('Purchase currency of this stock item')
|
||||
)
|
||||
|
||||
consumed_by_detail = OptionalField(
|
||||
serializer_class=BuildBriefSerializer,
|
||||
serializer_kwargs={
|
||||
'label': _('Consumed By'),
|
||||
'source': 'consumed_by',
|
||||
'read_only': True,
|
||||
'allow_null': True,
|
||||
},
|
||||
default_include=False,
|
||||
prefetch_fields=['consumed_by'],
|
||||
)
|
||||
|
||||
purchase_order_reference = serializers.CharField(
|
||||
source='purchase_order.reference', read_only=True, allow_null=True
|
||||
)
|
||||
|
||||
@@ -1260,15 +1260,147 @@ class StockItemListTest(StockAPITestCase):
|
||||
self.assertIn(stock_1.pk, ids)
|
||||
self.assertIn(stock_2.pk, ids)
|
||||
|
||||
def test_consumed_by_detail(self):
|
||||
"""Consuming build details are optional, nullable, and read-only."""
|
||||
self.assignRole('build.view')
|
||||
assembly = Part.objects.create(name='Reference assembly', assembly=True)
|
||||
part = Part.objects.first()
|
||||
parent = StockItem.objects.create(part=part, quantity=10)
|
||||
builds = [
|
||||
build.models.Build.objects.create(
|
||||
part=assembly, quantity=1, title=f'Consuming build {index}'
|
||||
)
|
||||
for index in range(2)
|
||||
]
|
||||
consuming_builds = [*builds, None]
|
||||
children = [
|
||||
StockItem.objects.create(
|
||||
part=part, quantity=1, parent=parent, consumed_by=build_order
|
||||
)
|
||||
for build_order in consuming_builds
|
||||
]
|
||||
params = {'parent': parent.pk}
|
||||
for options in [params, {**params, 'consumed_by_detail': False}]:
|
||||
for record in self.get(self.list_url, options).data:
|
||||
self.assertNotIn('consumed_by_detail', record)
|
||||
self.assertNotIn('consumed_by_reference', record)
|
||||
|
||||
response = self.get(self.list_url, {**params, 'consumed_by_detail': True})
|
||||
records = {item['pk']: item for item in response.data}
|
||||
self.assertEqual(set(records), {item.pk for item in children})
|
||||
for item, build_order in zip(children, consuming_builds, strict=True):
|
||||
detail = records[item.pk]['consumed_by_detail']
|
||||
self.assertEqual(
|
||||
records[item.pk]['consumed_by'], build_order.pk if build_order else None
|
||||
)
|
||||
if build_order:
|
||||
self.assertEqual(detail['pk'], build_order.pk)
|
||||
self.assertEqual(detail['reference'], build_order.reference)
|
||||
self.assertEqual(detail['title'], build_order.title)
|
||||
self.assertEqual(detail['status'], build_order.status)
|
||||
else:
|
||||
self.assertIsNone(detail)
|
||||
|
||||
detail_url = reverse('api-stock-detail', kwargs={'pk': children[0].pk})
|
||||
self.assertNotIn('consumed_by_detail', self.get(detail_url).data)
|
||||
detail = self.get(detail_url, {'consumed_by_detail': True}).data
|
||||
self.assertEqual(detail['consumed_by_detail']['reference'], builds[0].reference)
|
||||
|
||||
original_reference = builds[0].reference
|
||||
self.patch(
|
||||
detail_url, {'consumed_by_detail': {'reference': 'Cannot overwrite'}}
|
||||
)
|
||||
builds[0].refresh_from_db()
|
||||
self.assertEqual(builds[0].reference, original_reference)
|
||||
self.assertEqual(
|
||||
StockItem.objects.get(pk=children[0].pk).consumed_by_id, builds[0].pk
|
||||
)
|
||||
|
||||
# Requesting the field must not bypass build view permissions.
|
||||
self.clearRoles()
|
||||
self.assignRole('stock.view')
|
||||
response = self.get(self.list_url, {**params, 'consumed_by_detail': True})
|
||||
for record in response.data:
|
||||
self.assertNotIn('consumed_by_detail', record)
|
||||
self.assertNotIn(
|
||||
'consumed_by_detail',
|
||||
self.get(detail_url, {'consumed_by_detail': True}).data,
|
||||
)
|
||||
|
||||
def test_consumed_by_detail_export(self):
|
||||
"""Export consuming references only when requested and permitted."""
|
||||
self.assignRole('build.view')
|
||||
assembly = Part.objects.create(name='Export assembly', assembly=True)
|
||||
build_order = build.models.Build.objects.create(part=assembly, quantity=1)
|
||||
part = Part.objects.first()
|
||||
parent = StockItem.objects.create(part=part, quantity=10)
|
||||
consumed = StockItem.objects.create(
|
||||
part=part, quantity=1, parent=parent, consumed_by=build_order
|
||||
)
|
||||
unconsumed = StockItem.objects.create(part=part, quantity=1, parent=parent)
|
||||
filters = {'parent': parent.pk}
|
||||
params = {**filters, 'consumed_by_detail': True}
|
||||
header = 'Consumed By.Reference'
|
||||
|
||||
with self.export_data(self.list_url, params=params) as data_file:
|
||||
rows = self.process_csv(data_file, required_cols=[header], required_rows=2)
|
||||
records = {int(row['ID']): row for row in rows}
|
||||
self.assertEqual(records[consumed.pk][header], build_order.reference)
|
||||
self.assertEqual(records[unconsumed.pk][header], '')
|
||||
|
||||
for options in [filters, {**filters, 'consumed_by_detail': False}]:
|
||||
with self.export_data(self.list_url, params=options) as data_file:
|
||||
self.process_csv(data_file, excluded_cols=[header], required_rows=2)
|
||||
|
||||
self.clearRoles()
|
||||
self.assignRole('stock.view')
|
||||
with self.export_data(self.list_url, params=params) as data_file:
|
||||
self.process_csv(data_file, excluded_cols=[header], required_rows=2)
|
||||
|
||||
def test_consumed_by_detail_prefetch(self):
|
||||
"""Optional details prefetch builds even without StockApiMixin annotations."""
|
||||
from stock.serializers import StockItemSerializer
|
||||
|
||||
assembly = Part.objects.create(name='Prefetch assembly', assembly=True)
|
||||
builds = [
|
||||
build.models.Build.objects.create(part=assembly, quantity=1)
|
||||
for _ in range(10)
|
||||
]
|
||||
StockItem.objects.bulk_create([
|
||||
StockItem(part=assembly, quantity=1, consumed_by=build_order)
|
||||
for build_order in builds
|
||||
])
|
||||
queryset = StockItem.objects.filter(consumed_by__in=builds)
|
||||
serializer = StockItemSerializer(consumed_by_detail=True)
|
||||
self.assertIn('consumed_by', serializer.prefetch_list)
|
||||
self.assertNotIn('consumed_by', StockItemSerializer().prefetch_list)
|
||||
with self.assertNumQueries(2):
|
||||
prefetched = list(serializer.prefetch_queryset(queryset))
|
||||
references = [item.consumed_by.reference for item in prefetched]
|
||||
self.assertCountEqual(
|
||||
references, [build_order.reference for build_order in builds]
|
||||
)
|
||||
|
||||
def test_query_count(self):
|
||||
"""Test that the number of queries required to fetch stock items is reasonable."""
|
||||
# Create a bunch of StockItem objects
|
||||
prt = Part.objects.first()
|
||||
|
||||
assembly = Part.objects.create(name='Query assembly', assembly=True)
|
||||
builds = [
|
||||
build.models.Build.objects.create(part=assembly, quantity=1)
|
||||
for _ in range(10)
|
||||
]
|
||||
# Include consuming builds so missing prefetches exceed the query budget.
|
||||
StockItem.objects.bulk_create([
|
||||
StockItem(part=prt, quantity=1) for _ in range(100)
|
||||
StockItem(part=prt, quantity=1, consumed_by=bo)
|
||||
for bo in builds
|
||||
for _ in range(10)
|
||||
])
|
||||
|
||||
self.assignRole('build.view')
|
||||
self.get(self.list_url, {'consumed_by_detail': True}, max_query_count=35)
|
||||
|
||||
# List *all* stock items
|
||||
self.get(self.list_url, {}, max_query_count=35)
|
||||
|
||||
@@ -2085,6 +2217,7 @@ class StockItemTest(StockAPITestCase):
|
||||
|
||||
def test_output_options(self):
|
||||
"""Test the output options for StockItemt detail."""
|
||||
self.assignRole('build.view')
|
||||
self.run_output_test(
|
||||
reverse('api-stock-detail', kwargs={'pk': 1}),
|
||||
[
|
||||
@@ -2093,6 +2226,7 @@ class StockItemTest(StockAPITestCase):
|
||||
'supplier_part_detail',
|
||||
'location_detail',
|
||||
'tests',
|
||||
'consumed_by_detail',
|
||||
],
|
||||
)
|
||||
|
||||
|
||||
Reference in new issue
Block a user