actions: better language management

* Adds decorator to inject language from the current patron session or client.
* Sends the language to action handler when if possible.
* Bumps dependencies.

Co-Authored-by: Lauren-D <laurent.dubois@itld-solutions.be>

Author: lauren-d

invenio_sip2/actions/actions.py

@@ -21,7 +21,11 @@
 
 from invenio_sip2.actions.base import Action
 from invenio_sip2.api import Message
-from invenio_sip2.decorators import add_sequence_number, check_selfcheck_authentication
+from invenio_sip2.decorators import (
+    add_sequence_number,
+    check_selfcheck_authentication,
+    extract_and_add_language_parameter,
+)
 from invenio_sip2.errors import SelfcheckCirculationError, SelfcheckError
 from invenio_sip2.handlers import (
     authorize_patron_handler,
@@ -88,17 +92,22 @@ class AutomatedCirculationSystemStatus(Action):
     """Action to get status from automated circulation system."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client):
+    def execute(self, message, client, language):
         """Execute automated circulation system status action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
         # TODO : calculate system status from remote app
         status = system_status_handler(
-            client.remote_app, client.terminal, institution_id=client.institution_id
+            client.remote_app,
+            client.terminal,
+            institution_id=client.institution_id,
+            language=language,
         )
         current_logger.debug(
             f"[AutomatedCirculationSystemStatus]: " f"handler response: {status}"
@@ -163,22 +172,29 @@ class PatronEnable(Action):
     """Action to enable patron on automated circulation system."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client):
+    def execute(self, message, client, language):
         """Execute enable patron action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
         patron_id = message.get_field_value("patron_id")
-
         is_valid_patron = validate_patron_handler(
-            client.remote_app, patron_id, institution_id=client.institution_id
+            client.remote_app,
+            patron_id,
+            institution_id=client.institution_id,
+            language=language,
         )
 
         enabled_patron = enable_patron_handler(
-            client.remote_app, patron_id, institution_id=client.institution_id
+            client.remote_app,
+            patron_id,
+            institution_id=client.institution_id,
+            language=language,
         )
         current_logger.debug(f"[PatronEnable]: handler response: {enabled_patron}")
         # prepare message based on required fields
@@ -223,17 +239,22 @@ class PatronStatus(Action):
     """Action to get patron status from automated circulation system."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client):
+    def execute(self, message, client, language):
         """Execute patron status action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
         patron_id = message.get_field_value("patron_id")
         patron_status = patron_status_handler(
-            client.remote_app, patron_id, institution_id=client.institution_id
+            client.remote_app,
+            patron_id,
+            institution_id=client.institution_id,
+            language=language,
         )
         current_logger.debug(f"[PatronStatus]: handler response: {patron_status}")
         response_message = self.prepare_message_response(
@@ -265,19 +286,23 @@ def execute(self, message, client):
         """
         patron_id = message.get_field_value("patron_id")
         patron_account = patron_handler(
-            client.remote_app, patron_id, institution_id=client.institution_id
+            client.remote_app,
+            patron_id,
+            institution_id=client.institution_id,
+            language=message.i18n_language,
         )
         current_logger.debug(f"[PatronInformation]: handler response: {patron_account}")
         # TODO: better way to begin session
         # start patron session
+        patron_language = patron_account.get("language", message.i18n_language)
         client["patron_session"] = {
             "patron_id": patron_id,
-            "language": message.i18n_language,
+            "language": patron_language,
         }
         # prepare message based on required fields
         response_message = self.prepare_message_response(
             patron_status=str(patron_account.get("patron_status")),
-            language=get_language_code(patron_account.get("language")),
+            language=get_language_code(patron_language),
             transaction_date=acs_system.sip2_current_date,
             hold_items_count=str(patron_account.hold_items_count),
             overdue_items_count=str(patron_account.overdue_items_count),
@@ -350,19 +375,16 @@ class ItemInformation(Action):
     """Action to get item information from automated circulation system."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client):
+    def execute(self, message, client, language):
         """Execute item information action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
-        patron_session = client.get_current_patron_session()
-        if patron_session:
-            language = patron_session.get("language")
-        else:
-            language = client.library_language
         item_identifier = message.get_field_value("item_id")
         item_information = item_handler(
             client.remote_app,
@@ -401,12 +423,14 @@ class BlockPatron(Action):
     """Action to block patron."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute block patron action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
         # TODO: implements action
@@ -417,21 +441,17 @@ class Checkin(Action):
     """Action to checkin an item."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute checkin action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
-        patron_session = client.get_current_patron_session()
-        if patron_session:
-            language = patron_session.get("language")
-        else:
-            language = client.library_language
         item_id = message.get_field_value("item_id")
-
         try:
             # TODO: give the client to reduce the number of parameters.
             checkin = checkin_handler(
@@ -478,19 +498,16 @@ class Checkout(Action):
     """Action to checkout an item."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute checkout action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
-        patron_session = client.get_current_patron_session()
-        if patron_session:
-            language = patron_session.get("language")
-        else:
-            language = client.library_language
         item_id = message.get_field_value("item_id")
         patron_id = message.get_field_value("patron_id")
 
@@ -537,19 +554,16 @@ class FeePaid(Action):
     """Action to paid fee."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute fee paid action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
-        patron_session = client.get_current_patron_session()
-        if patron_session:
-            language = patron_session.get("language")
-        else:
-            language = client.library_language
         patron_id = message.get_field_value("patron_id")
         try:
             fee_paid = fee_paid_handler(
@@ -591,15 +605,16 @@ class Hold(Action):
     """Action to hold an item."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute hold action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
-        patron_session = client.get_current_patron_session()
         item_id = message.get_field_value("item_id")
         patron_id = message.get_field_value("patron_id")
 
@@ -611,7 +626,7 @@ def execute(self, message, client, **kwargs):
                 patron_id=patron_id,
                 institution_id=client.institution_id,
                 terminal=client.terminal,
-                language=patron_session.get("language"),
+                language=language,
             )
         except SelfcheckCirculationError as error:
             hold = error.data
@@ -647,15 +662,16 @@ class Renew(Action):
     """Action to renew an item."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute renew action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
-        patron_session = client.get_current_patron_session()
         item_id = message.get_field_value("item_id")
         patron_id = message.get_field_value("patron_id")
 
@@ -667,7 +683,7 @@ def execute(self, message, client, **kwargs):
                 patron_id=patron_id,
                 intitution_id=client.institution_id,
                 terminal=client.terminal,
-                language=patron_session.get("language"),
+                language=language,
             )
         except SelfcheckCirculationError as error:
             renew = error.data
@@ -707,12 +723,14 @@ class RenewAll(Action):
     """Action to renew all items."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute renew all action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
         # TODO: implements action
@@ -723,12 +741,14 @@ class ItemStatusUpdate(Action):
     """Action to update item status."""
 
     @check_selfcheck_authentication
+    @extract_and_add_language_parameter
     @add_sequence_number
-    def execute(self, message, client, **kwargs):
+    def execute(self, message, client, language, **kwargs):
         """Execute item status action.
 
         :param message: message receive from the client
         :param client: the client
+        :param language: the client language
         :return: message class representing the response of the current action
         """
         # TODO: implements action

invenio_sip2/decorators.py

@@ -67,3 +67,36 @@ def wrapper(*args, **kwargs):
         return result
 
     return wrapper
+
+
+def extract_and_add_language_parameter(func):
+    """Decorator to extract and add language.
+
+    Extracts the language from the client and injects it into the wrapped
+    function as a `language` argument.
+    """
+
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        # Try to retrieve the `client` argument:
+        # 1. from keyword arguments
+        # 2. or from positional arguments by looking for an object
+        #    that has a method named `get_current_patron_session`
+        client = kwargs.get("client") or next(
+            (a for a in args if hasattr(a, "get_current_patron_session")), None
+        )
+
+        if client is None:
+            raise ValueError("Client not found")
+
+        # Try to get the language from the patron session first,
+        # otherwise fall back to the client's `library_language`
+        patron_session = client.get_current_patron_session()
+        language = (patron_session or {}).get("language") or client.get(
+            "library_language"
+        )
+
+        # Call the original function, injecting the language
+        return func(*args, language=language, **kwargs)
+
+    return wrapper