[json validator] Optimize message validator by loading only once for all Charge Point instances (either as client or as connected client)

Author: c-jimenez

schemas/SignedFirmwareStatusNotificationResponse.json

@@ -6,5 +6,4 @@
   "type": "object",
   "properties": {},
   "additionalProperties": false
-  }
 }

src/centralsystem/CentralSystem.cpp

@@ -69,6 +69,7 @@ CentralSystem::CentralSystem(const ocpp::config::ICentralSystemConfig&        st
       m_database(),
       m_internal_config(m_database),
       m_messages_converter(),
+      m_messages_validator(),
       m_ws_server(),
       m_rpc_server(),
       m_uptime_timer(*m_timer_pool.get(), "Uptime timer"),
@@ -164,31 +165,40 @@ bool CentralSystem::start()
     {
         LOG_INFO << "Starting OCPP stack v" << OPEN_OCPP_VERSION << " - Listen URL : " << m_stack_config.listenUrl();
 
-        // Start uptime counter
-        m_uptime = 0;
-        m_internal_config.setKey(START_DATE_KEY, DateTime::now().str());
-        m_uptime_timer.start(std::chrono::seconds(1u));
-
-        // Allocate resources
-        m_ws_server  = std::unique_ptr<ocpp::websockets::IWebsocketServer>(ocpp::websockets::WebsocketFactory::newServer());
-        m_rpc_server = std::make_unique<ocpp::rpc::RpcServer>(*m_ws_server, "ocpp1.6");
-        m_rpc_server->registerServerListener(*this);
-
-        // Configure websocket link
-        ocpp::websockets::IWebsocketServer::Credentials credentials;
-        credentials.http_basic_authent                        = m_stack_config.httpBasicAuthent();
-        credentials.tls12_cipher_list                         = m_stack_config.tlsv12CipherList();
-        credentials.tls13_cipher_list                         = m_stack_config.tlsv13CipherList();
-        credentials.ecdh_curve                                = m_stack_config.tlsEcdhCurve();
-        credentials.server_certificate                        = m_stack_config.tlsServerCertificate();
-        credentials.server_certificate_private_key            = m_stack_config.tlsServerCertificatePrivateKey();
-        credentials.server_certificate_private_key_passphrase = m_stack_config.tlsServerCertificatePrivateKeyPassphrase();
-        credentials.server_certificate_ca                     = m_stack_config.tlsServerCertificateCa();
-        credentials.client_certificate_authent                = m_stack_config.tlsClientCertificateAuthent();
-        credentials.encoded_pem_certificates                  = false;
-
-        // Start listening
-        ret = m_rpc_server->start(m_stack_config.listenUrl(), credentials, m_stack_config.webSocketPingInterval());
+        // Load validator
+        ret = m_messages_validator.load(m_stack_config.jsonSchemasPath());
+        if (ret)
+        {
+            // Start uptime counter
+            m_uptime = 0;
+            m_internal_config.setKey(START_DATE_KEY, DateTime::now().str());
+            m_uptime_timer.start(std::chrono::seconds(1u));
+
+            // Allocate resources
+            m_ws_server  = std::unique_ptr<ocpp::websockets::IWebsocketServer>(ocpp::websockets::WebsocketFactory::newServer());
+            m_rpc_server = std::make_unique<ocpp::rpc::RpcServer>(*m_ws_server, "ocpp1.6");
+            m_rpc_server->registerServerListener(*this);
+
+            // Configure websocket link
+            ocpp::websockets::IWebsocketServer::Credentials credentials;
+            credentials.http_basic_authent                        = m_stack_config.httpBasicAuthent();
+            credentials.tls12_cipher_list                         = m_stack_config.tlsv12CipherList();
+            credentials.tls13_cipher_list                         = m_stack_config.tlsv13CipherList();
+            credentials.ecdh_curve                                = m_stack_config.tlsEcdhCurve();
+            credentials.server_certificate                        = m_stack_config.tlsServerCertificate();
+            credentials.server_certificate_private_key            = m_stack_config.tlsServerCertificatePrivateKey();
+            credentials.server_certificate_private_key_passphrase = m_stack_config.tlsServerCertificatePrivateKeyPassphrase();
+            credentials.server_certificate_ca                     = m_stack_config.tlsServerCertificateCa();
+            credentials.client_certificate_authent                = m_stack_config.tlsClientCertificateAuthent();
+            credentials.encoded_pem_certificates                  = false;
+
+            // Start listening
+            ret = m_rpc_server->start(m_stack_config.listenUrl(), credentials, m_stack_config.webSocketPingInterval());
+        }
+        else
+        {
+            LOG_ERROR << "Unable to load all the messages validators";
+        }
     }
     else
     {
@@ -252,7 +262,7 @@ void CentralSystem::rpcClientConnected(const std::string& chargepoint_id, std::s
 
     // Instanciate proxy
     std::shared_ptr<ICentralSystem::IChargePoint> chargepoint(
-        new ChargePointProxy(*this, chargepoint_id, client, m_stack_config.jsonSchemasPath(), m_messages_converter, m_stack_config));
+        new ChargePointProxy(*this, chargepoint_id, client, m_messages_validator, m_messages_converter, m_stack_config));
 
     // Notify connection
     m_events_handler.chargePointConnected(chargepoint);

src/centralsystem/CentralSystem.h

@@ -23,6 +23,7 @@ along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
 #include "ICentralSystem.h"
 #include "InternalConfigManager.h"
 #include "MessagesConverter.h"
+#include "MessagesValidator.h"
 #include "RpcServer.h"
 #include "Timer.h"
 
@@ -95,6 +96,8 @@ class CentralSystem : public ICentralSystem, public ocpp::rpc::RpcServer::IListe
 
     /** @brief Messages converter */
     ocpp::messages::MessagesConverter m_messages_converter;
+    /** @brief Messages validator */
+    ocpp::messages::MessagesValidator m_messages_validator;
 
     /** @brief Websocket server */
     std::unique_ptr<ocpp::websockets::IWebsocketServer> m_ws_server;

src/centralsystem/chargepoint/ChargePointProxy.cpp

@@ -58,13 +58,13 @@ namespace centralsystem
 ChargePointProxy::ChargePointProxy(ICentralSystem&                               central_system,
                                    const std::string&                            identifier,
                                    std::shared_ptr<ocpp::rpc::RpcServer::Client> rpc,
-                                   const std::string&                            schemas_path,
+                                   const ocpp::messages::MessagesValidator&      messages_validator,
                                    ocpp::messages::MessagesConverter&            messages_converter,
                                    const ocpp::config::ICentralSystemConfig&     stack_config)
     : m_central_system(central_system),
       m_identifier(identifier),
       m_rpc(rpc),
-      m_msg_dispatcher(schemas_path),
+      m_msg_dispatcher(messages_validator),
       m_msg_sender(*m_rpc, messages_converter, stack_config.callRequestTimeout()),
       m_handler(m_identifier, messages_converter, m_msg_dispatcher, stack_config)
 {

src/centralsystem/chargepoint/ChargePointProxy.h

@@ -23,6 +23,7 @@ along with OpenOCPP. If not, see <http://www.gnu.org/licenses/>.
 #include "GenericMessageSender.h"
 #include "ICentralSystem.h"
 #include "MessageDispatcher.h"
+#include "MessagesValidator.h"
 #include "RpcServer.h"
 
 #include <memory>
@@ -41,14 +42,14 @@ class ChargePointProxy : public ICentralSystem::IChargePoint, public ocpp::rpc::
      * @param central_system Central System instance associated to the charge point
      * @param identifier Charge point's identifier
      * @param rpc RPC connection with the charge point
-     * @param schemas_path Path to the JSON schemas needed to validate payloads
+     * @param messages_validator JSON schemas needed to validate payloads
      * @param messages_converter Converter from/to OCPP to/from JSON messages
      * @param stack_config Stack configuration
      */
     ChargePointProxy(ICentralSystem&                               central_system,
                      const std::string&                            identifier,
                      std::shared_ptr<ocpp::rpc::RpcServer::Client> rpc,
-                     const std::string&                            schemas_path,
+                     const ocpp::messages::MessagesValidator&      messages_validator,
                      ocpp::messages::MessagesConverter&            messages_converter,
                      const ocpp::config::ICentralSystemConfig&     stack_config);
     /** @brief Destructor */