release: v0.6.13

* Fixes request resend wrong decoding.
* Adds CommandNotFound exception.
* Catchs all exceptions when reading the request.

Co-Authored-by: Lauren-D <[email protected]>

CHANGES.rst

@@ -16,6 +16,18 @@
 
 Changes
 =======
+Version 0.6.13 (released 2021-08-25)
+
+**Bug fix:**
+
+* Fixes request resend wrong decoding.
+
+**Minor change:**
+
+* Adds CommandNotFound exception.
+* Catchs all exceptions when reading the request.
+
+
 Version 0.6.12 (released 2021-08-24)
 
 **Bug fix:**

invenio_sip2/actions/actions.py

@@ -127,8 +127,12 @@ def __str__(self):
     def execute(self, message, client):
         """Execute action."""
         last_response_message = client.last_response_message
+        request_msg = last_response_message.get('_sip2')
+        # strip the line terminator
+        request_msg = \
+            request_msg[:len(request_msg) - len(acs_system.line_terminator)]
         return Message(
-            request=last_response_message.get('_sip2')
+            request=request_msg
         )
 
 

invenio_sip2/api.py

@@ -24,6 +24,7 @@
 from flask import current_app
 from pycountry import languages
 
+from .errors import CommandNotFound
 from .helpers import MessageTypeFixedField, MessageTypeVariableField
 from .models import SelfcheckLanguage
 from .proxies import current_sip2 as acs_system
@@ -88,10 +89,16 @@ def __init__(self, **kwargs):
 
         if hasattr(self, 'request'):
             self.message_text = self.request
-            self.message_type = acs_system.sip2_message_types.get_by_command(
-                self.message_text[:2]
-            )
-            self._parse_request()
+            try:
+                self.message_type = acs_system.sip2_message_types.\
+                    get_by_command(self.message_text[:2])
+                self._parse_request()
+            except CommandNotFound as err:
+                description = '{err} - request: {request}'.format(
+                    err=err.description,
+                    request=self.message_text
+                )
+                raise CommandNotFound(message=description)
 
     def __str__(self):
         """String representation of Message object."""

invenio_sip2/errors.py

@@ -58,6 +58,15 @@ def __init__(self, message=None, **kwargs):
         super().__init__(**kwargs)
 
 
+class CommandNotFound(Exception):
+    """Command not found."""
+
+    def __init__(self, message=None, **kwargs):
+        """Initialize exception."""
+        self.description = message
+        super().__init__(**kwargs)
+
+
 # Server
 class ServerMessageError(Exception):
     """Server message error."""

invenio_sip2/ext.py

@@ -30,6 +30,7 @@
 
 from . import config, handlers
 from .actions.actions import Action
+from .errors import CommandNotFound
 from .helpers import MessageTypeFixedField, MessageTypeVariableField
 from .models import SupportedMessages
 from .utils import convert_bool_to_char
@@ -282,10 +283,11 @@ def __init__(self, message_type_config):
             self.message_types[command] = _MessageType(command, **message_type)
 
     def get_by_command(self, command):
-        command = self.message_types.get(command)
-        if command:
-            return command
-        raise NotImplementedError
+        try:
+            return self.message_types[command]
+        except Exception:
+            err_msg = f"Command '{command}' not found"
+            raise CommandNotFound(message=err_msg)
 
 
 class _MessageType(object):

invenio_sip2/server.py

@@ -25,6 +25,7 @@
 from flask import current_app
 
 from .api import Message
+from .errors import CommandNotFound
 from .proxies import current_logger as logger
 from .proxies import current_sip2
 from .records.record import Client, Server
@@ -73,6 +74,12 @@ def run(self):
                         message = key.data
                         try:
                             message.process_events(mask)
+                        except CommandNotFound as err:
+                            logger.error(
+                                err.description,
+                                exc_info=True
+                            )
+                            message.close()
                         except RuntimeError as e:
                             logger.debug(
                                 f'message cannot be processed: {e}',
@@ -181,34 +188,42 @@ def _read(self):
             pass
         else:
             if data:
+                log_prefix = f'request from {self.client.terminal} ' \
+                    f'({self.client.get("ip_address")}, ' \
+                    f'{self.client.get("socket")})'
                 request_msg = data.decode(encoding=self.message_encoding)
                 # strip the line terminator
                 request_msg = \
                     request_msg[:len(request_msg) - len(self.line_terminator)]
-                self.request = Message(request=request_msg)
-
-                request = self.request.dumps() if logger.level == \
-                    logging.DEBUG else request_msg
-
-                logger.info(f'request from {self.client.terminal} '
-                            f'({self.client.get("ip_address")}, '
-                            f'{self.client.get("socket")}): {request}')
-
-                if self.validate_message(request_msg):
-                    self._recv_buffer += data
-                else:
-                    logger.error(
-                        f'invalid checksum for: {request_msg}',
-                        exc_info=True
-                    )
-                    # prepare request selcheck resend message
-                    self.response = Message(
-                        message_type=current_sip2.sip2_message_types
-                        .get_by_command('96')
-                    )
-                    # Set selector to listen for write events
-                    self._set_selector_events_mask("w")
+                try:
+                    self.request = Message(request=request_msg)
+                    request = self.request.dumps() if logger.level == \
+                        logging.DEBUG else request_msg
+
+                    logger.info(f'{log_prefix}: {request}')
 
+                    if self.validate_message(request_msg):
+                        self._recv_buffer += data
+                    else:
+                        logger.error(
+                            f'invalid checksum for: {request_msg}',
+                            exc_info=True
+                        )
+                        # prepare request selcheck resend message
+                        self.response = Message(
+                            message_type=current_sip2.sip2_message_types
+                            .get_by_command('96')
+                        )
+                        # Set selector to listen for write events
+                        self._set_selector_events_mask("w")
+                except CommandNotFound as e:
+                    raise CommandNotFound(
+                        message='{prefix} - {description}'.format(
+                            prefix=log_prefix, description=e.description))
+                except Exception as err:
+                    logger.info('{prefix} - {request}'.format(
+                        prefix=log_prefix, request=request_msg))
+                    raise Exception(err)
             else:
                 raise RuntimeError("Peer closed.")
 

invenio_sip2/version.py

@@ -23,4 +23,4 @@
 
 from __future__ import absolute_import, print_function
 
-__version__ = '0.6.12'
+__version__ = '0.6.13'