BAF-1256 # Module Gateway - QUIC Integration

CMLibStorage.cmake

@@ -1,3 +1,7 @@
+FIND_PACKAGE(CMLIB REQUIRED COMPONENTS CMCONF)
+
+CMCONF_INIT_SYSTEM(FLEET_PROTOCOL)
+
 SET(STORAGE_LIST DEP)
 
 SET(STORAGE_LIST_DEP "https://github.com/bacpack-system/package-tracker.git")

CMakeLists.txt

@@ -6,13 +6,17 @@ FIND_PACKAGE(CMLIB
         REQUIRED
 )
 
-SET(BRINGAUTO_MODULE_GATEWAY_VERSION 1.3.4)
+SET(BRINGAUTO_MODULE_GATEWAY_VERSION 1.4.0)
+
+SET(MODULE_GATEWAY_MINIMUM_LOGGER_VERBOSITY "DEBUG" CACHE STRING "Minimum logger verbosity level for module-gateway")
 
 CMDEF_COMPILE_DEFINITIONS(
-        ALL "MODULE_GATEWAY_VERSION=\"${BRINGAUTO_MODULE_GATEWAY_VERSION}\""
+        ALL
+        "MODULE_GATEWAY_VERSION=\"${BRINGAUTO_MODULE_GATEWAY_VERSION}\""
+        "MODULE_GATEWAY_MINIMUM_LOGGER_VERBOSITY=\"${MODULE_GATEWAY_MINIMUM_LOGGER_VERBOSITY}\""
 )
 SET(CMAKE_INSTALL_RPATH "$ORIGIN/../${CMDEF_LIBRARY_INSTALL_DIR}")
-SET(CMAKE_CXX_STANDARD 20)
+SET(CMAKE_CXX_STANDARD 23)
 
 INCLUDE(CheckPIESupported)
 CHECK_PIE_SUPPORTED()
@@ -43,13 +47,17 @@ SET(Protobuf_USE_STATIC_LIBS ON)
 
 FIND_PACKAGE(Boost 1.74 REQUIRED CONFIG)
 FIND_PACKAGE(Protobuf 3.21.12 REQUIRED)
-FIND_PACKAGE(cxxopts 3.0.0 REQUIRED)
-FIND_PACKAGE(nlohmann_json 3.2.0 REQUIRED)
+FIND_PACKAGE(cxxopts 3.1.1 REQUIRED)
+FIND_PACKAGE(nlohmann_json 3.10.5 REQUIRED)
 FIND_PACKAGE(PahoMqttCpp REQUIRED)
 FIND_PACKAGE(eclipse-paho-mqtt-c REQUIRED)
 FIND_PACKAGE(libbringauto_logger 2.0.0 REQUIRED)
 FIND_PACKAGE(fleet-protocol-interface 2.0.0 REQUIRED)
 FIND_PACKAGE(ZLIB 1.2.11 REQUIRED)
+FIND_PACKAGE(fleet-protocol-cxx-helpers-static 1.2.0 REQUIRED)
+FIND_PACKAGE(aeron 1.48.6 REQUIRED)
+FIND_PACKAGE(async-function-execution-shared 1.0.0 REQUIRED)
+FIND_PACKAGE(msquic CONFIG REQUIRED)
 
 FILE(GLOB_RECURSE source_files "source/*")
 ADD_LIBRARY(module-gateway-lib STATIC "${source_files}")
@@ -67,6 +75,9 @@ TARGET_LINK_LIBRARIES(module-gateway-lib PUBLIC
                         eclipse-paho-mqtt-c::paho-mqtt3as
                         PahoMqttCpp::paho-mqttpp3
                         ZLIB::ZLIB
+                        fleet-protocol-cxx-helpers-static::fleet-protocol-cxx-helpers-static
+                        async-function-execution-shared::async-function-execution-shared
+                        msquic
                         ${CMAKE_DL_LIBS}
 )
 

Dockerfile

@@ -14,7 +14,7 @@ RUN cmake .. -DCMAKE_BUILD_TYPE=Release -DBRINGAUTO_GET_PACKAGES_ONLY=ON
 
 FROM bringauto/cpp-build-environment:latest AS mission_module_builder
 
-ARG MISSION_MODULE_VERSION=v1.2.12
+ARG MISSION_MODULE_VERSION=v1.2.13
 
 # Install mission module dependencies
 WORKDIR /home/bringauto/modules/

README.md

@@ -29,10 +29,17 @@ connection is broken and as soon as the connection is up, then error aggregated
 - [cmlib](https://github.com/cmakelib/cmakelib)
 
 - [protobuf](https://github.com/protocolbuffers/protobuf/tree/main/src) >= v3.21.12
-- [cxxopts](https://github.com/jarro2783/cxxopts) >= v3.0.0
-- [boost](https://github.com/boostorg/boost) >= v1.74.0
-- [nlohmann-json](https://github.com/nlohmann/json) >= v3.2.0
-- [ba-logger](https://github.com/bringauto/ba-logger) >= v1.2.0
+- [cxxopts](https://github.com/jarro2783/cxxopts) >= v3.1.1
+- [boost](https://github.com/boostorg/boost) >= v1.86.0
+- [nlohmann-json](https://github.com/nlohmann/json) >= v3.10.5/
+- [pahomqtt](https://github.com/eclipse-paho/paho.mqtt.c) >= v1.3.9
+- [pahomqttcpp](https://github.com/eclipse-paho/paho.mqtt.cpp) >= v1.3.2
+- [zlib](https://github.com/madler/zlib) >= v1.2.11
+- [ba-logger](https://github.com/bringauto/ba-logger) >= v2.0.0
+- [fleet-protocol-interface](https://github.com/bringauto/fleet-protocol) >= v2.0.0
+- [fleet-protocol-cpp](https://github.com/bringauto/fleet-protocol-cpp) >= v1.1.1
+- [aeron](https://github.com/aeron-io/aeron) >= v1.48.6
+- [async-function-execution](https://github.com/bringauto/async-function-execution) >= 0.1.0
 - g++ >= 10 or other compiler with c++20 support
 
 ## Build
@@ -50,7 +57,7 @@ make
 
 ### Arguments
 
-* required arguments:
+* Required arguments:
   * `-c <string> | --config-path=<string>`path to json configuration file ([Configs Readme](./configs/README.md))
 * All arguments:
   * `-h | --help` print help
@@ -77,6 +84,10 @@ make
 * BRINGAUTO_SYSTEM_DEP=ON/OFF
   - DEFAULT: OFF
 
+* MODULE_GATEWAY_MINIMUM_LOGGER_VERBOSITY=DEBUG/INFO/WARNING/ERROR/CRITICAL
+  - DEFAULT: DEBUG
+  - sets the minimum logger verbosity on compile level to improve performance
+
 
 * CURRENTLY UNUSED
   * BRINGAUTO_SAMPLES=ON/OFF

cmake/Dependencies.cmake

@@ -3,13 +3,15 @@ SET(CMAKE_FIND_USE_CMAKE_SYSTEM_PATH FALSE)
 BA_PACKAGE_LIBRARY(protobuf                 v4.21.12)
 BA_PACKAGE_LIBRARY(fleet-protocol-interface v2.0.0 NO_DEBUG ON)
 BA_PACKAGE_LIBRARY(nlohmann-json            v3.10.5 NO_DEBUG ON)
-BA_PACKAGE_LIBRARY(cxxopts                  v3.0.5 NO_DEBUG ON)
+BA_PACKAGE_LIBRARY(cxxopts                  v3.1.1 NO_DEBUG ON)
 BA_PACKAGE_LIBRARY(boost                    v1.86.0)
-BA_PACKAGE_LIBRARY(ba-logger                v2.0.0
-)
+BA_PACKAGE_LIBRARY(ba-logger                v2.0.0)
 BA_PACKAGE_LIBRARY(pahomqttc                v1.3.9)
 BA_PACKAGE_LIBRARY(pahomqttcpp              v1.3.2)
 BA_PACKAGE_LIBRARY(zlib                     v1.2.11 OUTPUT_PATH_VAR ZLIB_DIR)
+BA_PACKAGE_LIBRARY(fleet-protocol-cpp       v1.2.0)
+BA_PACKAGE_LIBRARY(aeron                    v1.48.6)
+BA_PACKAGE_LIBRARY(async-function-execution v1.0.0)
 
 IF (BRINGAUTO_TESTS)
     BA_PACKAGE_LIBRARY(gtest v1.12.1)

include/bringauto/common_utils/EnumUtils.hpp

@@ -1,7 +1,9 @@
 #pragma once
 
+#include <bringauto/external_client/connection/ConnectionState.hpp>
 #include <bringauto/structures/ExternalConnectionSettings.hpp>
 #include <bringauto/logging/LoggerVerbosity.hpp>
+#include <bringauto/settings/Constants.hpp>
 
 
 
@@ -24,10 +26,22 @@ class EnumUtils {
 	/**
 	 * @brief Converts protocol type to string
 	 *
-	 * @param toEnum structures::ProtocolType
-	 * @return std::string
+	 * @param toString structures::ProtocolType
+	 * @return std::string_view
 	 */
-	static std::string protocolTypeToString(structures::ProtocolType toString);
+	static constexpr std::string_view protocolTypeToString(structures::ProtocolType toString) {
+		switch(toString) {
+			case structures::ProtocolType::MQTT:
+				return settings::Constants::MQTT;
+			case structures::ProtocolType::QUIC:
+				return settings::Constants::QUIC;
+			case structures::ProtocolType::DUMMY:
+				return settings::Constants::DUMMY;
+			case structures::ProtocolType::INVALID:
+			default:
+				return "";
+		}
+	};
 
 	/**
 	 * @brief Converts string to logger verbosity
@@ -41,10 +55,50 @@ class EnumUtils {
 	 * @brief Converts logger verbosity to string
 	 *
 	 * @param verbosity logging::LoggerVerbosity
-	 * @return std::string
+	 * @return std::string_view
 	 */
-	static std::string loggerVerbosityToString(logging::LoggerVerbosity verbosity);
+	static constexpr std::string_view loggerVerbosityToString(logging::LoggerVerbosity verbosity) {
+		switch(verbosity) {
+			case logging::LoggerVerbosity::Debug:
+				return settings::Constants::LOG_LEVEL_DEBUG;
+			case logging::LoggerVerbosity::Info:
+				return settings::Constants::LOG_LEVEL_INFO;
+			case logging::LoggerVerbosity::Warning:
+				return settings::Constants::LOG_LEVEL_WARNING;
+			case logging::LoggerVerbosity::Error:
+				return settings::Constants::LOG_LEVEL_ERROR;
+			case logging::LoggerVerbosity::Critical:
+				return settings::Constants::LOG_LEVEL_CRITICAL;
+			default:
+				return settings::Constants::LOG_LEVEL_INVALID;
+		}
+	};
 
-};
+	/**
+	 * @brief Converts connection state to string
+	 *
+	 * @param state external_client::connection::ConnectionState
+	 * @return std::string_view
+	 */
+	static constexpr std::string_view connectionStateToString(
+		external_client::connection::ConnectionState state
+	) {
+		using enum external_client::connection::ConnectionState;
 
+		switch (state) {
+			case NOT_INITIALIZED:
+				return settings::Constants::LOG_CONNECTION_STATE_NOT_INITIALIZED;
+			case NOT_CONNECTED:
+				return settings::Constants::LOG_CONNECTION_STATE_NOT_CONNECTED;
+			case CONNECTING:
+				return settings::Constants::LOG_CONNECTION_STATE_CONNECTING;
+			case CONNECTED:
+				return settings::Constants::LOG_CONNECTION_STATE_CONNECTED;
+			case CLOSING:
+				return settings::Constants::LOG_CONNECTION_STATE_CLOSING;
+			default:
+				return settings::Constants::LOG_UNKNOWN;
+		}
+	}
+	};
 }

include/bringauto/common_utils/ProtobufUtils.hpp

@@ -5,8 +5,6 @@
 
 #include <InternalProtocol.pb.h>
 #include <ExternalProtocol.pb.h>
-#include <fleet_protocol/common_headers/device_management.h>
-#include <fleet_protocol/common_headers/memory_management.h>
 
 
 
@@ -37,7 +35,7 @@ class ProtobufUtils {
 											   const InternalProtocol::DeviceConnectResponse_ResponseType &resType);
 
 	/**
-	 * @brief Create a Internal Server Command message
+	 * @brief Create an Internal Server Command message
 	 *
 	 * @param device Protobuf message Device
 	 * @param command command data
@@ -47,7 +45,7 @@ class ProtobufUtils {
 																			   const modules::Buffer &command);
 
 	/**
-	 * @brief Create a Internal Client Status message
+	 * @brief Create an Internal Client Status message
 	 *
 	 * @param device Protobuf message Device
 	 * @param status status data
@@ -67,7 +65,7 @@ class ProtobufUtils {
 															 const modules::Buffer &status);
 
 	/**
-	 * @brief Create a External Client Connect message
+	 * @brief Create an External Client Connect message
 	 *
 	 * @param sessionId session identification
 	 * @param company name of the company
@@ -81,7 +79,7 @@ class ProtobufUtils {
 																		const std::vector<structures::DeviceIdentification> &devices);
 
 	/**
-	 * @brief Create a External Client Status message
+	 * @brief Create an External Client Status message
 	 *
 	 * @param sessionId session identification
 	 * @param deviceState state of the device
@@ -97,7 +95,7 @@ class ProtobufUtils {
 																	   const modules::Buffer &errorMessage = modules::Buffer {});
 
 	/**
-	 * @brief Create a External Client Command Response object
+	 * @brief Create an External Client Command Response object
 	 *
 	 * @param sessionId session identification
 	 * @param type command response message type
@@ -114,15 +112,15 @@ class ProtobufUtils {
 	 * @param status status to be copied 
 	 * @param buffer buffer to copy to
 	 */
-	static void copyStatusToBuffer(const InternalProtocol::DeviceStatus &status, modules::Buffer &buffer);
+	static void copyStatusToBuffer(const InternalProtocol::DeviceStatus &status, const modules::Buffer &buffer);
 
 	/**
 	 * @brief Copy command data from DeviceCommand to a Buffer
 	 * 
 	 * @param command command to be copied 
 	 * @param buffer buffer to copy to
 	 */
-	static void copyCommandToBuffer(const InternalProtocol::DeviceCommand &command, modules::Buffer &buffer);
+	static void copyCommandToBuffer(const InternalProtocol::DeviceCommand &command, const modules::Buffer &buffer);
 
 };
 }

include/bringauto/external_client/ErrorAggregator.hpp

@@ -1,13 +1,8 @@
 #pragma once
 
-#include <bringauto/modules/ModuleManagerLibraryHandler.hpp>
-
-#include <fleet_protocol/common_headers/memory_management.h>
-#include <fleet_protocol/common_headers/device_management.h>
-
+#include <bringauto/modules/IModuleManagerLibraryHandler.hpp>
 #include <bringauto/structures/DeviceIdentification.hpp>
 
-#include <functional>
 #include <filesystem>
 #include <unordered_map>
 
@@ -30,7 +25,7 @@ class ErrorAggregator {
 	 * @return OK if initialization was successful
 	 * @return NOT_OK if an error occurred
 	 */
-	int init_error_aggregator(const std::shared_ptr <modules::ModuleManagerLibraryHandler> &library);
+	int init_error_aggregator(const std::shared_ptr <modules::IModuleManagerLibraryHandler> &library);
 
 	/**
 	 * @short Clean up.
@@ -108,15 +103,15 @@ class ErrorAggregator {
 	 *
 	 * @see fleet-protocol/lib/common_headers/include/device_management.h
 	 */
-	int is_device_type_supported(unsigned int device_type);
+	int is_device_type_supported(unsigned int device_type) const;
 
 private:
 	struct DeviceState {
 		modules::Buffer errorMessage {};
 		modules::Buffer lastStatus {};
 	};
 
-	std::shared_ptr <modules::ModuleManagerLibraryHandler> module_ {};
+	std::shared_ptr <modules::IModuleManagerLibraryHandler> module_ {};
 
 	/**
 	 * @brief Map of devices states, key is device identification converted to string

include/bringauto/external_client/ExternalClient.hpp

@@ -20,9 +20,9 @@ namespace bringauto::external_client {
 class ExternalClient {
 public:
 
-	ExternalClient(std::shared_ptr<structures::GlobalContext> &context,
+	ExternalClient(const std::shared_ptr<structures::GlobalContext> &context,
 				   structures::ModuleLibrary &moduleLibrary,
-				   std::shared_ptr<structures::AtomicQueue<structures::InternalClientMessage>> &toExternalQueue);
+				   const std::shared_ptr<structures::AtomicQueue<structures::InternalClientMessage>> &toExternalQueue);
 
 	/**
 	 * @brief Initialize connections, error aggregators
@@ -54,7 +54,7 @@ class ExternalClient {
 	void handleAggregatedMessages();
 
 	/**
-	 * @brief Handle commands messages from from an external server
+	 * @brief Handle commands messages from an external server
 	 */
 	void handleCommands();
 
@@ -68,18 +68,18 @@ class ExternalClient {
 	/**
 	 * @brief Send aggregated status message to the external server
 	 *
-	 * @param deviceStatus aggregated status message ready to send
+	 * @param internalMessage aggregated status message ready to send
 	 * @return reconnect expected if true, reconnect not expected if false
 	 */
-	bool sendStatus(const structures::InternalClientMessage &deviceStatus);
+	bool sendStatus(const structures::InternalClientMessage &internalMessage);
 
 	bool insideConnectSequence_ { false };
 
 	/**
 	 * @brief Map of external connections, key is number from settings
 	 * - map is needed because of the possibility of multiple modules connected to one external server
 	 */
-	std::map<unsigned int, std::reference_wrapper<connection::ExternalConnection>> externalConnectionMap_ {};
+	std::unordered_map<unsigned int, std::reference_wrapper<connection::ExternalConnection>> externalConnectionMap_ {};
 	/// List of external connections, each device can have its own connection or multiple devices can share one connection
 	std::list<connection::ExternalConnection> externalConnectionsList_ {};
 	/// Queue for  messages from module handler to external client to be sent to external server

include/bringauto/external_client/connection/ConnectionState.hpp

@@ -18,6 +18,10 @@ enum class ConnectionState {
 	/**
 	 * CONNECTED - Client is connected to the External server
 	 */
-	CONNECTED
+	CONNECTED,
+	/**
+	 * CLOSING - Client closing connection to the External server
+	 */
+	CLOSING
 };
 }