Add dynamic websockets support

Signed-off-by: Nijat K <nijat.khanbabayev@gmail.com>

Author: NeejWeej

cpp/csp/adapters/websocket/CMakeLists.txt

@@ -1,20 +1,26 @@
 csp_autogen( csp.adapters.websocket_types websocket_types WEBSOCKET_HEADER WEBSOCKET_SOURCE )
 
 set(WS_CLIENT_HEADER_FILES
+        WebsocketClientTypes.h
         ClientAdapterManager.h
         ClientInputAdapter.h
         ClientOutputAdapter.h
         ClientHeaderUpdateAdapter.h
+        ClientConnectionRequestAdapter.h
         WebsocketEndpoint.h
+        WebsocketEndpointManager.h
         ${WEBSOCKET_HEADER} 
 )
 
 set(WS_CLIENT_SOURCE_FILES
+        WebsocketClientTypes.cpp
         ClientAdapterManager.cpp
         ClientInputAdapter.cpp
         ClientOutputAdapter.cpp
         ClientHeaderUpdateAdapter.cpp
+        ClientConnectionRequestAdapter.cpp
         WebsocketEndpoint.cpp
+        WebsocketEndpointManager.cpp
         ${WS_CLIENT_HEADER_FILES}
         ${WEBSOCKET_SOURCE}
 )

cpp/csp/adapters/websocket/ClientAdapterManager.cpp

@@ -1,124 +1,59 @@
 #include <csp/adapters/websocket/ClientAdapterManager.h>
 
-namespace csp {
-
-INIT_CSP_ENUM( adapters::websocket::ClientStatusType,
-               "ACTIVE",
-               "GENERIC_ERROR",
-               "CONNECTION_FAILED",
-               "CLOSED",
-               "MESSAGE_SEND_FAIL",
-);
-
-}
-
-// With TLS
 namespace csp::adapters::websocket {
 
 ClientAdapterManager::ClientAdapterManager( Engine* engine, const Dictionary & properties ) 
 : AdapterManager( engine ), 
-    m_active( false ), 
-    m_shouldRun( false ), 
-    m_endpoint( std::make_unique<WebsocketEndpoint>( properties ) ),
-    m_inputAdapter( nullptr ), 
-    m_outputAdapter( nullptr ),
-    m_updateAdapter( nullptr ),
-    m_thread( nullptr ), 
-    m_properties( properties ) 
-{ };
+  m_properties( properties )
+{ }
 
 ClientAdapterManager::~ClientAdapterManager()
-{ };
+{ }
 
-void ClientAdapterManager::start( DateTime starttime, DateTime endtime )
-{
-    AdapterManager::start( starttime, endtime );
-
-    m_shouldRun = true;
-    m_endpoint -> setOnOpen(
-        [ this ]() {
-            m_active = true;
-            pushStatus( StatusLevel::INFO, ClientStatusType::ACTIVE, "Connected successfully" );
-        }
-    );
-    m_endpoint -> setOnFail(
-        [ this ]( const std::string& reason ) {
-            std::stringstream ss;
-            ss << "Connection Failure: " << reason;
-            m_active = false;
-            pushStatus( StatusLevel::ERROR, ClientStatusType::CONNECTION_FAILED, ss.str() );
-        } 
-    );
-    if( m_inputAdapter ) {
-        m_endpoint -> setOnMessage(
-            [ this ]( void* c, size_t t ) {
-                PushBatch batch( m_engine -> rootEngine() );
-                m_inputAdapter -> processMessage( c, t, &batch );
-            }
-        );
-    } else {
-        // if a user doesn't call WebsocketAdapterManager.subscribe, no inputadapter will be created
-        // but we still need something to avoid on_message_cb not being set in the endpoint.
-        m_endpoint -> setOnMessage( []( void* c, size_t t ){} );
-    }
-    m_endpoint -> setOnClose(
-        [ this ]() {
-            m_active = false;
-            pushStatus( StatusLevel::INFO, ClientStatusType::CLOSED, "Connection closed" );
-        }
-    );
-    m_endpoint -> setOnSendFail(
-        [ this ]( const std::string& s ) {
-            std::stringstream ss;
-            ss << "Failed to send: " << s;
-            pushStatus( StatusLevel::ERROR, ClientStatusType::MESSAGE_SEND_FAIL, ss.str() );
-        }
-    );
+WebsocketEndpointManager* ClientAdapterManager::getWebsocketManager(){
+    if( m_endpointManager == nullptr )
+        return nullptr;
+    return m_endpointManager.get();
+}
 
-    m_thread = std::make_unique<std::thread>( [ this ]() { 
-        while( m_shouldRun )
-        {
-            m_endpoint -> run();
-            m_active = false;
-            if( m_shouldRun ) sleep( m_properties.get<TimeDelta>( "reconnect_interval" ) );
-        }
-    });
-};
+void ClientAdapterManager::start(DateTime starttime, DateTime endtime) {
+    AdapterManager::start(starttime, endtime);
+    if (m_endpointManager != nullptr)
+        m_endpointManager -> start(starttime, endtime);
+}
 
 void ClientAdapterManager::stop() {
     AdapterManager::stop();
-
-    m_shouldRun=false; 
-    if( m_active ) m_endpoint->stop();
-    if( m_thread ) m_thread->join();
-};
+    if (m_endpointManager != nullptr)
+        m_endpointManager -> stop();
+}
 
 PushInputAdapter* ClientAdapterManager::getInputAdapter(CspTypePtr & type, PushMode pushMode, const Dictionary & properties)
-{
-    if (m_inputAdapter == nullptr)
-    {
-        m_inputAdapter = m_engine -> createOwnedObject<ClientInputAdapter>(
-            // m_engine,
-            type,
-            pushMode,
-            properties    
-        );
-    }
-    return m_inputAdapter;
-};
+{   
+    if (m_endpointManager == nullptr)
+        m_endpointManager = std::make_unique<WebsocketEndpointManager>(this, m_properties, m_engine);
+    return m_endpointManager -> getInputAdapter( type, pushMode, properties );
+}
 
-OutputAdapter* ClientAdapterManager::getOutputAdapter()
+OutputAdapter* ClientAdapterManager::getOutputAdapter( const Dictionary & properties )
 {
-    if (m_outputAdapter == nullptr) m_outputAdapter = m_engine -> createOwnedObject<ClientOutputAdapter>(*m_endpoint);
-
-    return m_outputAdapter;
+    if (m_endpointManager == nullptr)
+        m_endpointManager = std::make_unique<WebsocketEndpointManager>(this, m_properties, m_engine);
+    return m_endpointManager -> getOutputAdapter( properties );
 }
 
 OutputAdapter * ClientAdapterManager::getHeaderUpdateAdapter()
 {
-    if (m_updateAdapter == nullptr) m_updateAdapter = m_engine -> createOwnedObject<ClientHeaderUpdateOutputAdapter>( m_endpoint -> getProperties() );
+   if (m_endpointManager == nullptr)
+        m_endpointManager = std::make_unique<WebsocketEndpointManager>(this, m_properties, m_engine);
+    return m_endpointManager -> getHeaderUpdateAdapter();
+}
 
-    return m_updateAdapter;
+OutputAdapter * ClientAdapterManager::getConnectionRequestAdapter( const Dictionary & properties )
+{
+    if (m_endpointManager == nullptr)
+        m_endpointManager = std::make_unique<WebsocketEndpointManager>(this, m_properties, m_engine);
+    return m_endpointManager -> getConnectionRequestAdapter( properties );
 }
 
 DateTime ClientAdapterManager::processNextSimTimeSlice( DateTime time )

cpp/csp/adapters/websocket/ClientAdapterManager.h

@@ -2,8 +2,9 @@
 #define _IN_CSP_ADAPTERS_WEBSOCKETS_CLIENT_ADAPTERMGR_H
 
 #include <csp/adapters/websocket/WebsocketEndpoint.h>
+#include <csp/adapters/websocket/WebsocketEndpointManager.h>
+#include <csp/adapters/websocket/WebsocketClientTypes.h>
 #include <csp/adapters/websocket/ClientInputAdapter.h>
-#include <csp/adapters/websocket/ClientOutputAdapter.h>
 #include <csp/adapters/websocket/ClientHeaderUpdateAdapter.h>
 #include <csp/core/Enum.h>
 #include <csp/core/Hash.h>
@@ -15,30 +16,15 @@
 #include <chrono>
 #include <iomanip>
 #include <iostream>
+#include <vector>
+#include <unordered_set>
 
 
 namespace csp::adapters::websocket {
 
 using namespace csp;
 
-struct WebsocketClientStatusTypeTraits
-{
-    enum _enum : unsigned char
-    {
-        ACTIVE = 0,
-        GENERIC_ERROR = 1,
-        CONNECTION_FAILED = 2,
-        CLOSED = 3,
-        MESSAGE_SEND_FAIL = 4,
-
-        NUM_TYPES
-    };
-
-protected:
-    _enum m_value;
-};
-
-using ClientStatusType = Enum<WebsocketClientStatusTypeTraits>;
+class WebsocketEndpointManager;
 
 class ClientAdapterManager final : public AdapterManager
 {
@@ -57,23 +43,17 @@ class ClientAdapterManager final : public AdapterManager
 
     void stop() override;
 
+    WebsocketEndpointManager* getWebsocketManager();
     PushInputAdapter * getInputAdapter( CspTypePtr & type, PushMode pushMode, const Dictionary & properties );
-    OutputAdapter * getOutputAdapter();
+    OutputAdapter * getOutputAdapter( const Dictionary & properties );
     OutputAdapter * getHeaderUpdateAdapter();
+    OutputAdapter * getConnectionRequestAdapter( const Dictionary & properties );
 
     DateTime processNextSimTimeSlice( DateTime time ) override;
 
 private:
-    // need some client info
-    
-    bool m_active;
-    bool m_shouldRun;
-    std::unique_ptr<WebsocketEndpoint> m_endpoint;
-    ClientInputAdapter* m_inputAdapter;
-    ClientOutputAdapter* m_outputAdapter;
-    ClientHeaderUpdateOutputAdapter* m_updateAdapter;
-    std::unique_ptr<std::thread> m_thread;
     Dictionary m_properties;
+    std::unique_ptr<WebsocketEndpointManager> m_endpointManager;
 };
 
 }

cpp/csp/adapters/websocket/ClientConnectionRequestAdapter.cpp

@@ -0,0 +1,48 @@
+#include <csp/adapters/websocket/ClientConnectionRequestAdapter.h>
+#include <csp/python/Conversions.h>
+#include <Python.h>
+
+namespace csp::adapters::websocket {
+
+ClientConnectionRequestAdapter::ClientConnectionRequestAdapter(
+    Engine * engine,
+    WebsocketEndpointManager * websocketManager,
+    bool is_subscribe,
+    size_t caller_id,
+    boost::asio::strand<boost::asio::io_context::executor_type>& strand
+
+) : OutputAdapter( engine ),  
+    m_websocketManager( websocketManager ),
+    m_strand( strand ),
+    m_isSubscribe( is_subscribe ),
+    m_callerId( caller_id ),
+    m_checkPerformed( is_subscribe ? false : true )  // we only need to check for pruned input adapters
+{}
+
+void ClientConnectionRequestAdapter::executeImpl()
+{
+    // One-time check for pruned status
+    if (unlikely(!m_checkPerformed)) {
+        m_isPruned = m_websocketManager->adapterPruned(m_callerId);
+        m_checkPerformed = true;
+    }
+
+    // Early return if pruned
+    if (unlikely(m_isPruned))
+        return;
+
+    auto raw_val = input()->lastValueTyped<PyObject*>();
+    auto val = python::fromPython<std::vector<Dictionary>>(raw_val);
+
+    // We intentionally post here, we want the thread running
+    // the strand to handle the connection request. We want to keep
+    // all updates to internal data structures at graph run-time
+    // to that thread.
+    boost::asio::post(m_strand, [this, val=std::move(val)]() {
+        for(const auto& conn_req: val) {
+            m_websocketManager->handleConnectionRequest(conn_req, m_callerId, m_isSubscribe);
+        }
+    });
+};
+
+}

cpp/csp/adapters/websocket/ClientConnectionRequestAdapter.h

@@ -0,0 +1,45 @@
+#ifndef _IN_CSP_ADAPTERS_WEBSOCKETS_CLIENT_CONNECTIONREQUESTADAPTER_H
+#define _IN_CSP_ADAPTERS_WEBSOCKETS_CLIENT_CONNECTIONREQUESTADAPTER_H
+
+#include <csp/adapters/websocket/ClientAdapterManager.h>
+#include <csp/engine/Dictionary.h>
+#include <csp/engine/OutputAdapter.h>
+#include <csp/adapters/utils/MessageWriter.h>
+#include <csp/adapters/websocket/csp_autogen/websocket_types.h>
+
+namespace csp::adapters::websocket
+{
+using namespace csp::autogen;
+
+class ClientAdapterManager;
+class WebsocketEndpointManager;
+
+class ClientConnectionRequestAdapter final: public OutputAdapter
+{
+public:
+    ClientConnectionRequestAdapter(
+        Engine * engine,
+        WebsocketEndpointManager * websocketManager,
+        bool isSubscribe,
+        size_t callerId,
+        boost::asio::strand<boost::asio::io_context::executor_type>& strand
+    );
+
+    void executeImpl() override;
+
+    const char * name() const override { return "WebsocketClientConnectionRequestAdapter"; }
+
+private:
+    WebsocketEndpointManager* m_websocketManager;
+    boost::asio::strand<boost::asio::io_context::executor_type>& m_strand;
+    bool m_isSubscribe;
+    size_t m_callerId;
+    bool m_checkPerformed;
+    bool m_isPruned{false};
+
+};
+
+}
+
+
+#endif

cpp/csp/adapters/websocket/ClientHeaderUpdateAdapter.cpp

@@ -2,19 +2,27 @@
 
 namespace csp::adapters::websocket {
 
+class WebsocketEndpointManager;
+
 ClientHeaderUpdateOutputAdapter::ClientHeaderUpdateOutputAdapter(
     Engine * engine,
-    Dictionary& properties
-) : OutputAdapter( engine ), m_properties( properties )
+    WebsocketEndpointManager * mgr,
+    boost::asio::strand<boost::asio::io_context::executor_type>& strand
+) : OutputAdapter( engine ), m_mgr( mgr ), m_strand( strand )
 { };
 
 void ClientHeaderUpdateOutputAdapter::executeImpl()
 {
-    DictionaryPtr headers = m_properties.get<DictionaryPtr>("headers");
-    for( auto& update : input() -> lastValueTyped<std::vector<WebsocketHeaderUpdate::Ptr>>() )
-    { 
-        if( update -> key_isSet() && update -> value_isSet() ) headers->update( update->key(), update->value() ); 
+    Dictionary headers;
+    for (auto& update : input()->lastValueTyped<std::vector<WebsocketHeaderUpdate::Ptr>>()) {
+        if (update->key_isSet() && update->value_isSet()) {
+            headers.update(update->key(), update->value());
+        }
     }
+    boost::asio::post(m_strand, [this, headers=std::move(headers)]() {
+        auto endpoint = m_mgr -> getNonDynamicEndpoint();
+        endpoint -> updateHeaders(std::move(headers));
+    });
 };
 
 }