From a47db7ec18fd1241f483c7aa387ac4b245ad8935 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 17 Nov 2026 21:43:46 +1100 Subject: [PATCH] Handle transition errors which occur after valid transition (#13303) --- .../InvenTree/generic/states/api_helpers.py | 42 +++++++++++++++++-- src/backend/InvenTree/order/test_api.py | 31 ++++++++++++++ 2 files changed, 69 insertions(+), 4 deletions(-) diff --git a/src/backend/InvenTree/generic/states/api_helpers.py b/src/backend/InvenTree/generic/states/api_helpers.py index 431bb97589..950aa1cac6 100644 --- a/src/backend/InvenTree/generic/states/api_helpers.py +++ b/src/backend/InvenTree/generic/states/api_helpers.py @@ -6,6 +6,7 @@ import inspect from typing import Any from django.apps import apps +from django.core.exceptions import ObjectDoesNotExist from django.core.exceptions import ValidationError as DjangoValidationError from django.db import transaction from django.utils.translation import gettext_lazy as _ @@ -51,13 +52,32 @@ def current_state(instance: Any, field_name: str | None = None) -> str | None: return getattr(instance, field_name, None) +def _is_transition_target(meta: Any, state: Any) -> bool: + """Return True if ``state`` is a target state of the transition described by ``meta``. + + Args: + meta: The django-fsm metadata of a transition method (or None). + state: The current state value of the instance. + """ + if meta is None or state is None: + return False + + for transition in getattr(meta, 'transitions', {}).values(): + # Unwrap State proxies (e.g. DEFERRABLE) which carry their real target + target = getattr(transition.target, 'target', transition.target) + if target is not None and target == state: + return True + + return False + + def transition_error( instance: Any, transition_name: str, exc: Exception ) -> dict[str, Any]: """Build the error body for a refused transition. Args: - instance: The instance the transition was attempted on, still in its source state. + instance: The instance the transition was attempted on. transition_name: Name of the transition function that refused. exc: The ``ValidationError`` the FSM raised. @@ -68,6 +88,16 @@ def transition_error( field = getattr(meta, 'field', None) if meta is not None else None field_name = field if isinstance(field, str) else getattr(field, 'name', None) + # django-fsm sets the state field to the target *before* the instance is saved. + # If the save fails (e.g. a validation plugin rejects it), the database change is + # rolled back but the in-memory instance still carries the target state. + # Re-read the state so the response reflects where the object actually is. + if field_name and getattr(instance, 'pk', None) is not None: + try: + instance.refresh_from_db(fields=[field_name]) + except ObjectDoesNotExist: # pragma: no cover + pass + state = current_state(instance, field_name) info = next( ( @@ -83,9 +113,13 @@ def transition_error( reason: str | None = None if info is None: - detail = ( - f"Transition '{transition_name}' is not available from state '{state}'." - ) + # Only replace the model's message for a genuinely unreachable transition. + # When the instance already sits in the target state (e.g. completing an order + # which is already complete), the model's own "already ..." message is clearer. + if not _is_transition_target(meta, state): + detail = ( + f"Transition '{transition_name}' is not available from state '{state}'." + ) elif info.blocked: reason = info.blocking_reason detail = reason or detail diff --git a/src/backend/InvenTree/order/test_api.py b/src/backend/InvenTree/order/test_api.py index 54c0102d9d..9ae3364253 100644 --- a/src/backend/InvenTree/order/test_api.py +++ b/src/backend/InvenTree/order/test_api.py @@ -825,6 +825,37 @@ class PurchaseOrderTest(OrderTest): self.assertEqual(po.status, PurchaseOrderStatus.COMPLETE) + # Completing again must report the order as already complete, + # rather than a generic "transition not available" message + response = self.post(url, {'accept_incomplete': True}, expected_code=400) + self.assertEqual(response.data['detail'], 'Purchase Order is already Complete') + + def test_po_complete_rejected_on_save(self): + """A validation error raised while saving the completed order is reported as-is. + + Regression test: django-fsm sets the status to the target before the save, so a + save-time rejection (e.g. from a validation plugin) was previously reported as + "Transition 'complete_order' is not available from state '30'", hiding the cause. + """ + po = models.PurchaseOrder.objects.get(pk=3) + self.assertEqual(po.status, PurchaseOrderStatus.PLACED) + + url = reverse('api-po-complete', kwargs={'pk': po.pk}) + self.assignRole('purchase_order.add') + + with mock.patch.object( + models.PurchaseOrder, + 'run_plugin_validation', + side_effect=ValidationError('Rejected by plugin'), + ): + response = self.post(url, {'accept_incomplete': True}, expected_code=400) + + self.assertEqual(response.data['detail'], 'Rejected by plugin') + self.assertEqual(response.data['state'], PurchaseOrderStatus.PLACED.value) + + po.refresh_from_db() + self.assertEqual(po.status, PurchaseOrderStatus.PLACED) + def test_po_complete_stale_instance_is_noop(self): """A second completion attempt with a stale order instance must be a no-op.