claims: manage missing data for claim notification

* Closes #3379.
* Checks if all requires data are available to render the claim
  notification content. If not, return a specific exception to specify
  the missing data.

Co-Authored-by: Renaud Michotte <[email protected]>

Author: zannkukai

rero_ils/modules/commons/exceptions.py

@@ -20,7 +20,7 @@
 
 
 class RecordNotFound(Exception):
-    """Record con't be found into Invenio."""
+    """Record can't be found into Invenio."""
 
     def __init__(self, record_cls, record_pid):
         """Initialization method.
@@ -31,6 +31,24 @@ def __init__(self, record_cls, record_pid):
         self.record_cls = record_cls
         self.record_pid = record_pid
 
-    def __str__(self):
+    def __repr__(self):
         """String representation of the exception."""
         return f'{self.record_cls.__name__}#{self.record_pid} not found'
+
+
+class MissingDataException(KeyError):
+    """Exception when a data is missing."""
+
+    def __init__(self, missing_data):
+        """Initialization method.
+
+        :param missing_data: list of missing data field names.
+        :type missing_data: str|list<str>
+        """
+        if not isinstance(missing_data, list):
+            missing_data = [missing_data]
+        self.missing_data = missing_data
+
+    def __repr__(self):
+        """String representation of the exception."""
+        return f'Missing data :: {", ".join(self.missing_data)}'

rero_ils/modules/items/dumpers.py

@@ -20,6 +20,7 @@
 
 from invenio_records.dumpers import Dumper as InvenioRecordsDumper
 
+from rero_ils.modules.commons.exceptions import MissingDataException
 from rero_ils.modules.documents.dumpers import \
     TitleDumper as DocumentTitleDumper
 from rero_ils.modules.holdings.api import Holding
@@ -82,19 +83,23 @@ class ClaimIssueNotificationDumper(InvenioRecordsDumper):
 
     def dump(self, record, data):
         """Dump an item issue for claim notification generation."""
-        assert record.is_issue, 'record must be an `ItemIssue` resource'
-        assert (holding := record.holding), \
-            'record must be related to an existing `Holding`'
+        if not record.is_issue:
+            raise TypeError('record must be an `ItemIssue` resource')
+        if not (holding := record.holding):
+            raise MissingDataException('item.holding')
+        if not (vendor := holding.vendor):
+            raise MissingDataException('item.holding.vendor')
 
         data.update({
-            'vendor': holding.vendor.dumps(
+            'vendor': vendor.dumps(
                 dumper=VendorClaimIssueNotificationDumper()),
-            'document': holding.document.dumps(dumper=DocumentTitleDumper()),
+            'document': holding.document.dumps(
+                dumper=DocumentTitleDumper()),
             'library': holding.library.dumps(
                 dumper=LibrarySerialClaimNotificationDumper()),
-            'holdings': holding.dumps(dumper=ClaimIssueHoldingDumper()),
+            'holdings': holding.dumps(
+                dumper=ClaimIssueHoldingDumper()),
             'enumerationAndChronology': record.enumerationAndChronology,
             'claim_counter': record.claims_count
         })
-
         return {k: v for k, v in data.items() if v is not None}

rero_ils/modules/items/views/api_views.py

@@ -52,6 +52,7 @@
 from ..models import ItemCirculationAction
 from ..permissions import late_issue_management as late_issue_management_action
 from ..utils import get_recipient_suggestions, item_pid_to_object
+from ...commons.exceptions import MissingDataException
 
 api_blueprint = Blueprint(
     'api_item',
@@ -572,7 +573,11 @@ def claim_notification_preview(item_pid):
     if not record.is_issue:
         abort(400, 'Item isn\'t an issue')
 
-    issue_data = record.dumps(dumper=ClaimIssueNotificationDumper())
+    try:
+        issue_data = record.dumps(dumper=ClaimIssueNotificationDumper())
+    except (TypeError, MissingDataException) as exp:
+        abort(500, str(exp))
+
     # update the claims issue counter ::
     #   As this is preview for next claim, we need to add 1 to the returned
     #   claim counter

rero_ils/modules/libraries/dumpers.py

@@ -20,6 +20,7 @@
 
 from invenio_records.dumpers import Dumper as InvenioRecordsDumper
 
+from rero_ils.modules.commons.exceptions import MissingDataException
 from rero_ils.modules.libraries.models import LibraryAddressType
 
 
@@ -55,6 +56,9 @@ def dump(self, record, data):
         :param record: The record to dump.
         :param data: The initial dump data passed in by ``record.dumps()``.
         """
+        if 'serial_acquisition_settings' not in record:
+            raise MissingDataException('library.serial_acquisition_settings')
+
         data.update({
             'name': record.get('name'),
             'address': record.get_address(LibraryAddressType.MAIN_ADDRESS),

tests/api/items/test_items_issue.py

@@ -23,8 +23,10 @@
 from utils import VerifyRecordPermissionPatch, flush_index, get_csv, \
     get_json, parse_csv, postdata
 
+from rero_ils.modules.commons.exceptions import MissingDataException
 from rero_ils.modules.holdings.api import Holding
 from rero_ils.modules.items.api import Item
+from rero_ils.modules.items.dumpers import ClaimIssueNotificationDumper
 from rero_ils.modules.notifications.api import Notification, \
     NotificationsSearch
 from rero_ils.modules.notifications.models import RecipientType
@@ -90,6 +92,7 @@ def test_issues_claim_notifications(
     #   1) call with unknown item --> return 404
     #   2) call with a standard item --> return 400
     #   3) simulate a template rendering error --> return 500
+    #   4) missing data --> return 500
     #   4) call with an issue item --> return 200
     for pid, ret_code in [('dummy_pid', 404), (item.pid, 400)]:
         url = url_for('api_item.claim_notification_preview', item_pid=pid)
@@ -104,6 +107,14 @@ def test_issues_claim_notifications(
         assert response.status_code == 500
         assert 'my_error' in response.json['message']
 
+    with mock.patch.object(
+        ClaimIssueNotificationDumper, 'dump',
+        mock.MagicMock(side_effect=MissingDataException('Test!'))
+    ):
+        response = client.get(url)
+        assert response.status_code == 500
+        assert 'Test!' in response.json['message']
+
     response = client.get(url)
     assert response.status_code == 200
     assert all(field in response.json

tests/ui/items/test_items_dumpers.py

@@ -19,8 +19,14 @@
 """Items Record dumper tests."""
 from copy import deepcopy
 
+import pytest
+
+from rero_ils.modules.commons.exceptions import MissingDataException
 from rero_ils.modules.holdings.api import Holding
-from rero_ils.modules.items.dumpers import ItemCirculationDumper
+from rero_ils.modules.items.dumpers import ClaimIssueNotificationDumper, \
+    ItemCirculationDumper
+from rero_ils.modules.items.models import TypeOfItem
+from rero_ils.modules.utils import get_ref_for_pid
 
 
 def test_item_circulation_dumper(item_lib_martigny):
@@ -52,3 +58,21 @@ def test_item_circulation_dumper(item_lib_martigny):
 
     # RESET HOLDING RECORD
     holdings.update(original_holding_data, dbcommit=True, reindex=True)
+
+
+def test_claim_issue_dumper(item_lib_martigny):
+    """Test claim issue notification dumper."""
+    with pytest.raises(TypeError):
+        item_lib_martigny.dumps(dumper=ClaimIssueNotificationDumper())
+
+    item_lib_martigny['type'] = TypeOfItem.ISSUE
+    holding = item_lib_martigny.holding
+    holding.pop('vendor', None)
+    with pytest.raises(MissingDataException) as exc:
+        item_lib_martigny.dumps(dumper=ClaimIssueNotificationDumper())
+    assert 'item.holding.vendor' in str(exc)
+
+    item_lib_martigny['holding']['$ref'] = get_ref_for_pid('hold', 'dummy')
+    with pytest.raises(MissingDataException) as exc:
+        item_lib_martigny.dumps(dumper=ClaimIssueNotificationDumper())
+    assert 'item.holding' in str(exc)

tests/ui/libraries/test_libraries_dumpers.py

@@ -17,12 +17,15 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """Library Record dumpers."""
+import pytest
+
+from rero_ils.modules.commons.exceptions import MissingDataException
 from rero_ils.modules.libraries.dumpers import \
     LibraryAcquisitionNotificationDumper, LibrarySerialClaimNotificationDumper
 
 
-def test_library_serial_claim_dumper(lib_martigny, lib_saxon):
-    """Test serial claim library dumper."""
+def test_library_serial_dumpers(lib_martigny, lib_saxon):
+    """Test serial library dumpers."""
 
     # Acquisition dumper
     dump_data = lib_martigny.dumps(LibraryAcquisitionNotificationDumper())
@@ -37,7 +40,6 @@ def test_library_serial_claim_dumper(lib_martigny, lib_saxon):
     assert data['address']
     assert data['shipping_informations']
     assert data['billing_informations']
-    data = lib_saxon.dumps(LibrarySerialClaimNotificationDumper())
-    assert data['address']
-    assert 'shipping_informations' not in data
-    assert 'billing_informations' not in data
+    with pytest.raises(MissingDataException) as exc:
+        lib_saxon.dumps(LibrarySerialClaimNotificationDumper())
+    assert 'library.serial_acquisition_settings' in str(exc)