Improve TFW lib layout

lib/tfw/networking/__init__.py

@@ -1,6 +1,8 @@
 # Copyright (C) 2018 Avatao.com Innovative Learning Kft.
 # All Rights Reserved. See LICENSE file for details.
 
+from .serialization import serialize_tfw_msg, deserialize_tfw_msg, with_deserialize_tfw_msg, message_bytes
+from .server_connector import ServerUplinkConnector, ServerDownlinkConnector, ServerConnector
+from .event_handler_connector import EventHandlerConnector
 from .message_sender import MessageSender
-from .event_handlers.server_connector import ServerUplinkConnector as TFWServerConnector
-from .server.tfw_server import TFWServer
+from .scope import Scope

lib/tfw/networking/event_handler_connector.py

@@ -4,11 +4,12 @@
 import zmq
 from zmq.eventloop.zmqstream import ZMQStream
 
-from tfw.networking.zmq_connector_base import ZMQConnectorBase
-from tfw.networking.serialization import serialize_tfw_msg, with_deserialize_tfw_msg
 from tfw.config import TFWENV
 from tfw.config.logs import logging
 
+from .serialization import serialize_tfw_msg, with_deserialize_tfw_msg
+from .zmq_connector_base import ZMQConnectorBase
+
 LOG = logging.getLogger(__name__)
 
 

lib/tfw/networking/event_handlers/__init__.py

@@ -1,2 +0,0 @@
-# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
-# All Rights Reserved. See LICENSE file for details.

lib/tfw/networking/fsm_aware.py

@@ -1,46 +0,0 @@
-# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
-# All Rights Reserved. See LICENSE file for details.
-
-from tfw.crypto import KeyManager, verify_message
-
-from tfw.config.logs import logging
-
-LOG = logging.getLogger(__name__)
-
-
-class FSMAware:
-    """
-    Base class for stuff that has to be aware of the framework FSM.
-    This is done by processing 'fsm_update' messages.
-    """
-    def __init__(self):
-        self.fsm_state = None
-        self.fsm_in_accepted_state = False
-        self.fsm_event_log = []
-        self._auth_key = KeyManager().auth_key
-
-    def update_fsm_data(self, message):
-        if message['key'] == 'fsm_update' and verify_message(self._auth_key, message):
-            self._handle_fsm_update(message)
-            return True
-        return False
-
-    def _handle_fsm_update(self, message):
-        try:
-            update_data = message['data']
-            new_state = update_data['current_state']
-            if self.fsm_state != new_state:
-                self.handle_fsm_step(**update_data)
-            self.fsm_state = new_state
-            self.fsm_in_accepted_state = update_data['in_accepted_state']
-            self.fsm_event_log.append(update_data)
-        except KeyError:
-            LOG.error('Invalid fsm_update message received!')
-
-    def handle_fsm_step(self, **kwargs):
-        """
-        Called in case the TFW FSM has stepped.
-
-        :param kwargs: fsm_update 'data' field
-        """
-        pass

lib/tfw/networking/message_sender.py

@@ -1,7 +1,7 @@
 # Copyright (C) 2018 Avatao.com Innovative Learning Kft.
 # All Rights Reserved. See LICENSE file for details.
 
-from tfw.networking.event_handlers.server_connector import ServerUplinkConnector
+from .server_connector import ServerUplinkConnector
 
 
 class MessageSender:

lib/tfw/networking/scope.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class Scope(Enum):
+    ZMQ = 'zmq'
+    WEBSOCKET = 'websocket'
+    BROADCAST = 'broadcast'

lib/tfw/networking/server/__init__.py

@@ -1,2 +0,0 @@
-# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
-# All Rights Reserved. See LICENSE file for details.

lib/tfw/networking/server/tfw_server.py

@@ -1,28 +0,0 @@
-# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
-# All Rights Reserved. See LICENSE file for details.
-
-from tornado.web import Application
-
-from tfw.networking.server.zmq_websocket_proxy import ZMQWebSocketProxy
-from tfw.networking.server.event_handler_connector import EventHandlerConnector
-from tfw.config.logs import logging
-
-LOG = logging.getLogger(__name__)
-
-
-class TFWServer:
-    """
-    This class handles the proxying of messages between the frontend and event handers.
-    It proxies messages from the "/ws" route to all event handlers subscribed to a ZMQ
-    SUB socket.
-    """
-    def __init__(self):
-        self._event_handler_connector = EventHandlerConnector()
-        self.application = Application([(
-            r'/ws', ZMQWebSocketProxy, {
-                'event_handler_connector': self._event_handler_connector,
-            }
-        )])
-
-    def listen(self, port):
-        self.application.listen(port)

lib/tfw/networking/server/zmq_websocket_proxy.py

@@ -1,72 +0,0 @@
-# Copyright (C) 2018 Avatao.com Innovative Learning Kft.
-# All Rights Reserved. See LICENSE file for details.
-
-import json
-
-from tornado.websocket import WebSocketHandler
-
-from tfw.networking.event_handlers.server_connector import Scope
-from tfw.config.logs import logging
-
-LOG = logging.getLogger(__name__)
-
-
-class ZMQWebSocketProxy(WebSocketHandler):
-    # pylint: disable=abstract-method
-    instances = set()
-
-    def initialize(self, **kwargs): # pylint: disable=arguments-differ
-        self.event_handler_connector = kwargs['event_handler_connector']
-        self.tfw_router = TFWRouter(self.send_to_zmq, self.send_to_websockets)
-
-    def send_to_zmq(self, message):
-        self.event_handler_connector.send_message(message)
-
-    @staticmethod
-    def send_to_websockets(message):
-        for instance in ZMQWebSocketProxy.instances:
-            instance.write_message(message)
-
-    def prepare(self):
-        ZMQWebSocketProxy.instances.add(self)
-
-    def on_close(self):
-        ZMQWebSocketProxy.instances.remove(self)
-
-    def open(self, *args, **kwargs):
-        LOG.debug('WebSocket connection initiated!')
-        self.event_handler_connector.register_callback(self.zmq_callback)
-
-    def zmq_callback(self, message):
-        LOG.debug('Received on ZMQ pull socket: %s', message)
-        self.tfw_router.route(message)
-
-    def on_message(self, message):
-        message = json.loads(message)
-        LOG.debug('Received on WebSocket: %s', message)
-        self.tfw_router.route(message)
-
-    # much secure, very cors, wow
-    def check_origin(self, origin):
-        return True
-
-
-class TFWRouter:
-    def __init__(self, send_to_zmq, send_to_websockets):
-        self.send_to_zmq = send_to_zmq
-        self.send_to_websockets = send_to_websockets
-
-    def route(self, message):
-        scope = Scope(message.get('scope', 'zmq'))
-
-        routing_table = {
-            Scope.ZMQ: self.send_to_zmq,
-            Scope.WEBSOCKET: self.send_to_websockets,
-            Scope.BROADCAST: self.broadcast
-        }
-        action = routing_table[scope]
-        action(message)
-
-    def broadcast(self, message):
-        self.send_to_zmq(message)
-        self.send_to_websockets(message)

lib/tfw/networking/server_connector.py

@@ -2,16 +2,17 @@
 # All Rights Reserved. See LICENSE file for details.
 
 from functools import partial
-from enum import Enum
 
 import zmq
 from zmq.eventloop.zmqstream import ZMQStream
 
-from tfw.networking.zmq_connector_base import ZMQConnectorBase
-from tfw.networking.serialization import serialize_tfw_msg, with_deserialize_tfw_msg
 from tfw.config import TFWENV
 from tfw.config.logs import logging
 
+from .scope import Scope
+from .serialization import serialize_tfw_msg, with_deserialize_tfw_msg
+from .zmq_connector_base import ZMQConnectorBase
+
 LOG = logging.getLogger(__name__)
 
 
@@ -34,12 +35,6 @@ class ServerDownlinkConnector(ZMQConnectorBase):
         self._zmq_sub_stream.close()
 
 
-class Scope(Enum):
-    ZMQ = 'zmq'
-    WEBSOCKET = 'websocket'
-    BROADCAST = 'broadcast'
-
-
 class ServerUplinkConnector(ZMQConnectorBase):
     def __init__(self, zmq_context=None):
         super(ServerUplinkConnector, self).__init__(zmq_context)