circulation: self-checkout of MISSING items marks them as CAN_CIRCULATE

Author: JakobMiesner

invenio_app_ils/circulation/api.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2018-2020 CERN.
+# Copyright (C) 2018-2025 CERN.
 #
 # invenio-app-ils is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -78,9 +78,9 @@ def _validate_delivery(delivery):
             )
 
 
-def _set_item_to_can_circulate(item_pid):
+def _set_item_to_can_circulate(item_pid_value):
     """Change the item status to CAN_CIRCULATE."""
-    item = Item.get_record_by_pid(item_pid["value"])
+    item = Item.get_record_by_pid(item_pid_value)
     if item["status"] != "CAN_CIRCULATE":
         item["status"] = "CAN_CIRCULATE"
         item.commit()
@@ -245,7 +245,7 @@ def checkout_loan(
         _validate_delivery(optional_delivery)
 
     if force:
-        _set_item_to_can_circulate(item_pid)
+        _set_item_to_can_circulate(item_pid["value"])
 
     return _checkout_loan(
         item_pid,
@@ -256,14 +256,19 @@ def checkout_loan(
     )
 
 
-def _ensure_item_loanable_via_self_checkout(item_pid):
+def _ensure_item_loanable_via_self_checkout(item_pid_value):
     """Self-checkout: return loanable item or raise when not loanable.
 
     Implements the self-checkout rules to loan an item.
     """
-    item = current_app_ils.item_record_cls.get_record_by_pid(item_pid)
+    item = current_app_ils.item_record_cls.get_record_by_pid(item_pid_value)
     item_dict = item.replace_refs()
 
+    if item_dict["status"] == "MISSING":
+        _set_item_to_can_circulate(item_pid_value)
+        item = current_app_ils.item_record_cls.get_record_by_pid(item_pid_value)
+        item_dict = item.replace_refs()
+
     if item_dict["status"] != "CAN_CIRCULATE":
         raise ItemCannotCirculateError()
 

tests/api/circulation/test_loan_checkout.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2018-2020 CERN.
+# Copyright (C) 2018-2025 CERN.
 #
 # invenio-app-ils is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -249,15 +249,29 @@ def test_self_checkout_search(app, client, json_headers, users, testdata):
     assert res.status_code == 400
 
     # test that an error is returned when the item cannot circulate
-    missing_item_barcode = "123456789-1"
+    in_binding_item_barcode = "123456789-74"
     url = url_for("invenio_app_ils_circulation.loan_self_checkout")
-    res = client.get(f"{url}?barcode={missing_item_barcode}", headers=json_headers)
+    res = client.get(f"{url}?barcode={in_binding_item_barcode}", headers=json_headers)
     assert res.status_code == 400
     # assert that the payload will contain the key error with a msg
     response = res.get_json()
     assert LoanSelfCheckoutItemInvalidStatus.description in response["message"]
     assert LoanSelfCheckoutItemInvalidStatus.supportCode in response["supportCode"]
 
+    # test that no error is returned when the item is marked as missing
+    missing_item_barcode = "123456789-1"
+    missing_item_pid = "itemid-1"
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(f"{url}?barcode={missing_item_barcode}", headers=json_headers)
+    assert res.status_code == 200
+
+    # assert item is no longer marked as missing
+    response = res.get_json()
+    item_pid = response["metadata"]["pid"]
+    assert item_pid == missing_item_pid
+    item = Item.get_record_by_pid(item_pid)
+    assert item["status"] == "CAN_CIRCULATE"
+
     # create a loan on the same patron, and another one on another patron
     user_login(client, "librarian", users)
     url = url_for("invenio_app_ils_circulation.loan_checkout")
@@ -326,6 +340,7 @@ def _create_request(patron, document_pid):
         current_search.flush_and_refresh(index="*")
 
     def _self_checkout(patron, item_pid, document_pid):
+        url = url_for("invenio_app_ils_circulation.loan_self_checkout")
         params = deepcopy(NEW_LOAN)
         params["document_pid"] = document_pid
         params["item_pid"] = dict(type="pitmid", value=item_pid)
@@ -394,3 +409,14 @@ def _self_checkout(patron, item_pid, document_pid):
     assert res.status_code == 202
     response = res.get_json()
     assert response["metadata"]["delivery"]["method"] == "SELF-CHECKOUT"
+
+    # test self-checkout with item marked as missing raises no error and marks the item as CAN_CIRCULATE
+    missing_item_pid = "itemid-1"
+    app.config["ILS_SELF_CHECKOUT_ENABLED"] = True
+    patron2 = user_login(client, "patron2", users)
+    res = _self_checkout(patron2, missing_item_pid, "docid-1")
+    assert res.status_code == 202
+    response = res.get_json()
+    assert response["metadata"]["delivery"]["method"] == "SELF-CHECKOUT"
+    item = Item.get_record_by_pid(missing_item_pid)
+    assert item["status"] == "CAN_CIRCULATE"

tests/data/items.json

@@ -289,5 +289,16 @@
     "medium": "NOT_SPECIFIED",
     "status": "CAN_CIRCULATE",
     "document": {}
+  },
+  {
+    "pid": "itemid-74",
+    "created_by": { "type": "script", "value": "demo" },
+    "barcode": "123456789-74",
+    "document_pid": "docid-17",
+    "internal_location_pid": "ilocid-1",
+    "circulation_restriction": "NO_RESTRICTION",
+    "medium": "NOT_SPECIFIED",
+    "status": "IN_BINDING",
+    "document": {}
   }
 ]