Derive protocol_html from protocol_ws.

Author: evoskuil

include/bitcoin/node/full_node.hpp

@@ -164,7 +164,6 @@ class BCN_API full_node
     /// Attach server sessions (base net doesn't specialize or start these).
     virtual session_web::ptr attach_web_session() NOEXCEPT;
     virtual session_explore::ptr attach_explore_session() NOEXCEPT;
-    virtual session_websocket::ptr attach_websocket_session() NOEXCEPT;
     virtual session_bitcoind::ptr attach_bitcoind_session() NOEXCEPT;
     virtual session_electrum::ptr attach_electrum_session() NOEXCEPT;
     virtual session_stratum_v1::ptr attach_stratum_v1_session() NOEXCEPT;
@@ -179,7 +178,6 @@ class BCN_API full_node
 private:
     void start_web(const code& ec, const result_handler& handler) NOEXCEPT;
     void start_explore(const code& ec, const result_handler& handler) NOEXCEPT;
-    void start_websocket(const code& ec, const result_handler& handler) NOEXCEPT;
     void start_bitcoind(const code& ec, const result_handler& handler) NOEXCEPT;
     void start_electrum(const code& ec, const result_handler& handler) NOEXCEPT;
     void start_stratum_v1(const code& ec, const result_handler& handler) NOEXCEPT;

include/bitcoin/node/protocols/protocol_html.hpp

@@ -28,9 +28,12 @@ namespace libbitcoin {
 namespace node {
 
 /// Abstract base for HTML protocols, thread safe.
+/// To keep inheritance simple this derives from protocol_ws, which in turn
+/// derives from protocol_http (as required). So any html server is able to
+/// operate as a websocket server.
 class BCN_API protocol_html
   : public node::protocol,
-    public network::protocol_http,
+    public network::protocol_ws,
     protected network::tracker<protocol_html>
 {
 public:
@@ -43,7 +46,7 @@ class BCN_API protocol_html
         const network::channel::ptr& channel,
         const options_t& options) NOEXCEPT
       : node::protocol(session, channel),
-        network::protocol_http(session, channel, options),
+        network::protocol_ws(session, channel, options),
         options_(options),
         network::tracker<protocol_html>(session->log)
     {

include/bitcoin/node/sessions/sessions.hpp

@@ -34,7 +34,6 @@ namespace node {
 /// Alias server sessions, all derived from node::session.
 using session_web = session_server<protocol_web>;
 using session_explore = session_server<protocol_explore>;
-using session_websocket = session_server<protocol_ws>;
 using session_bitcoind = session_server<protocol_bitcoind>;
 using session_electrum = session_server<protocol_electrum>;
 using session_stratum_v1 = session_server<protocol_stratum_v1>;

include/bitcoin/node/settings.hpp

@@ -126,7 +126,7 @@ class BCN_API settings
     /// html (http/s) document server settings (has directory/default).
     /// This is for web servers that expose a local file system directory.
     struct html_server
-      : public network::settings::http_server
+      : public network::settings::websocket_server
     {
         // embedded_pages reference precludes copy.
         DELETE_COPY(html_server);
@@ -138,6 +138,9 @@ class BCN_API settings
         /// This is a reference to the caller's resource (retained instance).
         const embedded_pages& pages;
 
+        /// Set false to disable http->websocket http upgrade processing.
+        bool websocket{ true };
+
         /// Directory to serve.
         std::filesystem::path path{};
 
@@ -163,12 +166,9 @@ class BCN_API settings
     /// native admin web interface, isolated (http/s, stateless html)
     server::settings::html_server web;
 
-    /// native RESTful block explorer (http/s, stateless html/json)
+    /// native RESTful block explorer (http/s, stateless html/websocket)
     server::settings::html_server explore;
 
-    /// native websocket query interface (http/s->tcp/s, json, handshake)
-    network::settings::websocket_server socket{ "socket" };
-
     /// bitcoind compat interface (http/s, stateless json-rpc-v2)
     network::settings::http_server bitcoind{ "bitcoind" };
 

src/full_node.cpp

@@ -145,21 +145,6 @@ void full_node::start_explore(const code& ec,
     }
 
     attach_explore_session()->start(
-        std::bind(&full_node::start_websocket, this, _1, handler));
-}
-
-void full_node::start_websocket(const code& ec,
-    const result_handler& handler) NOEXCEPT
-{
-    BC_ASSERT(stranded());
-
-    if (ec)
-    {
-        handler(ec);
-        return;
-    }
-
-    attach_websocket_session()->start(
         std::bind(&full_node::start_bitcoind, this, _1, handler));
 }
 
@@ -545,11 +530,6 @@ session_explore::ptr full_node::attach_explore_session() NOEXCEPT
     return net::attach<session_explore>(*this, config_.server.explore);
 }
 
-session_websocket::ptr full_node::attach_websocket_session() NOEXCEPT
-{
-    return net::attach<session_websocket>(*this, config_.server.socket);
-}
-
 session_bitcoind::ptr full_node::attach_bitcoind_session() NOEXCEPT
 {
     return net::attach<session_bitcoind>(*this, config_.server.bitcoind);

src/parser.cpp

@@ -83,7 +83,6 @@ parser::parser(system::chain::selection context,
     // admin
     configured.server.web.binds.emplace_back(asio::address{}, 8080_u16);
     configured.server.explore.binds.emplace_back(asio::address{}, 8180_u16);
-    configured.server.socket.binds.emplace_back(asio::address{}, 8280_u16);
     configured.server.bitcoind.binds.emplace_back(asio::address{}, 8380_u16);
     configured.server.electrum.binds.emplace_back(asio::address{}, 8480_u16);
     configured.server.stratum_v1.binds.emplace_back(asio::address{}, 8580_u16);
@@ -865,42 +864,10 @@ options_metadata parser::load_settings() THROWS
         value<std::string>(&configured.server.explore.default_),
         "The path of the default source page, defaults to 'index.html'."
     )
-
-    /* [socket] */
-    ////(
-    ////    "socket.secure",
-    ////    value<bool>(&configured.network.socket.secure),
-    ////    "Require transport layer security, defaults to 'false' (not implemented)."
-    ////)
-    (
-        "socket.bind",
-        value<network::config::authorities>(&configured.server.socket.binds),
-        "IP address to bind, multiple allowed, defaults to '0.0.0.0:8280' (all IPv4)."
-    )
     (
-        "socket.connections",
-        value<uint16_t>(&configured.server.socket.connections),
-        "The required maximum number of connections, defaults to '0'."
-    )
-    (
-        "socket.inactivity_minutes",
-        value<uint32_t>(&configured.server.socket.inactivity_minutes),
-        "The idle timeout (http keep-alive), defaults to '10'."
-    )
-    (
-        "socket.expiration_minutes",
-        value<uint32_t>(&configured.server.socket.expiration_minutes),
-        "The idle timeout (http keep-alive), defaults to '60'."
-    )
-    (
-        "socket.server",
-        value<std::string>(&configured.server.socket.server),
-        "The server name (http header), defaults to '" BC_HTTP_SERVER_NAME "'."
-    )
-    (
-        "socket.host",
-        value<network::config::endpoints>(&configured.server.socket.hosts),
-        "The host name (http verification), multiple allowed, defaults to empty (disabled)."
+        "explore.websocket",
+        value<bool>(&configured.server.explore.websocket),
+        "Enable websocket interface, defaults to true."
     )
 
     /* [bitcoind] */

src/settings.cpp

@@ -175,7 +175,7 @@ bool settings::embedded_pages::enabled() const NOEXCEPT
 // settings::html_server
 settings::html_server::html_server(const std::string_view& logging_name,
     const embedded_pages& embedded) NOEXCEPT
-  : network::settings::http_server(logging_name),
+  : network::settings::websocket_server(logging_name),
     pages(embedded)
 {
 }

test/settings.cpp

@@ -112,6 +112,7 @@ BOOST_AUTO_TEST_CASE(server__html_server__defaults__expected)
     BOOST_REQUIRE(instance.pages.ecma().empty());
     BOOST_REQUIRE(instance.pages.font().empty());
     BOOST_REQUIRE(instance.pages.icon().empty());
+    BOOST_REQUIRE(instance.websocket);
     BOOST_REQUIRE(instance.path.empty());
     BOOST_REQUIRE_EQUAL(instance.default_, "index.html");
     BOOST_REQUIRE(instance.origins.empty());
@@ -149,6 +150,7 @@ BOOST_AUTO_TEST_CASE(server__web_server__defaults__expected)
     BOOST_REQUIRE(server.pages.font().empty());
     BOOST_REQUIRE(server.pages.icon().empty());
     BOOST_REQUIRE(server.path.empty());
+    BOOST_REQUIRE(server.websocket);
     BOOST_REQUIRE_EQUAL(server.default_, "index.html");
     BOOST_REQUIRE(server.origins.empty());
     BOOST_REQUIRE(server.origin_names().empty());
@@ -185,35 +187,13 @@ BOOST_AUTO_TEST_CASE(server__explore_server__defaults__expected)
     BOOST_REQUIRE(server.pages.font().empty());
     BOOST_REQUIRE(server.pages.icon().empty());
     BOOST_REQUIRE(server.path.empty());
+    BOOST_REQUIRE(server.websocket);
     BOOST_REQUIRE_EQUAL(server.default_, "index.html");
     BOOST_REQUIRE(server.origins.empty());
     BOOST_REQUIRE(server.origin_names().empty());
 }
 
-BOOST_AUTO_TEST_CASE(server__websocket_server__defaults__expected)
-{
-    const server::settings::embedded_pages web{};
-    const server::settings::embedded_pages explorer{};
-    const server::settings instance{ selection::none, explorer, web };
-    const auto& server = instance.socket;
-
-    // tcp_server
-    BOOST_REQUIRE_EQUAL(server.name, "socket");
-    BOOST_REQUIRE(!server.secure);
-    BOOST_REQUIRE(server.binds.empty());
-    BOOST_REQUIRE_EQUAL(server.connections, 0u);
-    BOOST_REQUIRE_EQUAL(server.inactivity_minutes, 10u);
-    BOOST_REQUIRE_EQUAL(server.expiration_minutes, 60u);
-    BOOST_REQUIRE(!server.enabled());
-    BOOST_REQUIRE(server.inactivity() == minutes(10));
-    BOOST_REQUIRE(server.expiration() == minutes(60));
-
-    // http_server
-    BOOST_REQUIRE_EQUAL(server.server, "libbitcoin/4.0");
-    BOOST_REQUIRE(server.hosts.empty());
-    BOOST_REQUIRE(server.host_names().empty());
-}
-
+// TODO: could add websocket under bitcoind as a custom property.
 BOOST_AUTO_TEST_CASE(server__bitcoind_server__defaults__expected)
 {
     const server::settings::embedded_pages web{};