Development/batch jsonrpc (#926)

* JsonRpcMuxer: initial version

* JsonRpcMuxer: only allow one websocket connection

* JsonRpcMuxer: adding a queue wait time timeout.

* JsonRpcMuxer: update module name to Plugin_JsonRpcMuxer

* JsonRpcMuxer: Use workerpool to invoke messages.

* JsonRpcMuxer: enhance error handling for inbound WebSocket messages

* JsonRpcMuxer: improve error handling and add batch size configuration

* JsonRpcMuxer: add timeout handling for batch processing and enhance logging

* JsonRpcMuxer: add max batch size and concurrent batch limit configuration

* JsonRpcMuxer: add configuration options for batch processing parameters

* JsonRpcMuxer: fix race condition

* JsonRpcMuxer: move common validation logic to one method

* JsonRpcMuxer: Adding python tests that I used

* JsonRpcMuxer: Add batch cleanup + added tests for it.

* JsonRpcMuxer: fast burst stress test.

* JsonRpcMuxer: split HTTP/WS tests.

* JsonRpcMuxer: make direct websocket to plugin optional

* JsonRpcMuxer: move some websocket only code within the #ifdef

* JsonRpcMuxer: refactor to support both parallel and  sequential processing

* JsonRpcMuxer: Refactor Batch/Job design

* JsonRpcMuxer: Use a job only as a minion to to work

* JsonRpcMuxer: Limit logging

* JsonRpcMuxer: Add missing initialization

* JsonRpcMuxer: fix string consistency

* JsonRpcMuxer: Refactor Batch public interface

* JsonRpcMuxer: Update tests

* JsonRpcMuxer: Add readme

* JsonRpcMuxer: Remove WebSocket connection support

* JsonRpcMuxer: Update default max wait time for batch completion to Core::infinite

* JsonRpcMuxer: Optimize batch processing by removing response lock and introducing finishing state

* JsonRpcMuxer: Added explicit memory ordering to allow better CPU optimizations

* JsonRpcMuxer: Replace std::map with std::unordered_map to improve performance

* JsonRpcMuxer: Implement lock-free batch release

* JsonRpcMuxer: Fixed race condition in batch slot claiming

* Update Readme.md

* JsonRpcMuxer: Add lost Lock

* JsonRpcMuxer: Remove atomics, just use good ols fashion locks

* JsonRpcMuxer: Update error codes for batch processing

* JsonRpcMuxer: Enhance stress tests with timing metrics and error handling

* JsonRpcMuxer: Refactor batch processing.

* JsonRpcMuxer: Increase max batch size and concurrent batches in test configuration

* JsonRpcMuxer: Fix Sequential batch handling

* JsonRpcMuxer: Update README

* JsonRpcMuxer: Fix typo in test method name and enhance error handling for invalid requests

---------

Co-authored-by: Pierre Wielders <[email protected]>

Author: bramoosterhuis

CMakeLists.txt

@@ -37,6 +37,7 @@ option(PLUGIN_DICTIONARY "Include Dictionary plugin" OFF)
 option(PLUGIN_DOGGO "Include watchdog plugin" OFF)
 option(PLUGIN_IOCONNECTOR "Include IOConnector plugin" OFF)
 option(PLUGIN_INPUTSWITCH "Include InputSwitch plugin" OFF)
+option(PLUGIN_JSONRPCMUXER "Include JsonRpcMuxer plugin capable to execute batched jsonRPC messages" OFF)
 option(PLUGIN_FIRMWARECONTROL "Include FirmwareControl Plugin" OFF)
 option(PLUGIN_PROCESSMONITOR "Include Process Monitor plugin" OFF)
 option(PLUGIN_LANGUAGEADMINISTRATOR "Include LanguageAdministrator plugin" OFF)
@@ -158,6 +159,10 @@ if(PLUGIN_INPUTSWITCH)
     add_subdirectory(InputSwitch)
 endif()
 
+if(PLUGIN_JSONRPCMUXER)
+    add_subdirectory(JsonRpcMuxer)
+endif()
+
 if(PLUGIN_SICONTROL)
     add_subdirectory (SIControl)
 endif(PLUGIN_SICONTROL)

JsonRpcMuxer/CMakeLists.txt

@@ -0,0 +1,63 @@
+# If not stated otherwise in this file or this component's LICENSE file the
+# following copyright and licenses apply:
+#
+# Copyright 2020 Metrological
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+project(JsonRpcMuxer)
+
+cmake_minimum_required(VERSION 3.15)
+
+find_package(Thunder)
+
+project_version(1.0.0)
+
+set(MODULE_NAME ${NAMESPACE}${PROJECT_NAME})
+
+message("Setup ${MODULE_NAME} v${PROJECT_VERSION}")
+
+set(PLUGIN_JSONRPCMUXER_STARTMODE "Activated" CACHE STRING "Automatically start JsonRpcMuxer plugin")
+set(PLUGIN_JSONRPCMUXER_MAX_CONCURRENT_JOBS 0 CACHE STRING "Maximum number of concurrent WorkerPool jobs")
+set(PLUGIN_JSONRPCMUXER_MAX_BATCH_SIZE 0 CACHE STRING "Maximum requests per batch")
+
+if(BUILD_REFERENCE)
+    add_definitions(-DBUILD_REFERENCE=${BUILD_REFERENCE})
+endif()
+
+find_package(${NAMESPACE}Plugins REQUIRED)
+find_package(CompileSettingsDebug CONFIG REQUIRED)
+
+add_library(${MODULE_NAME} SHARED 
+    JsonRpcMuxer.cpp
+    Module.cpp)
+
+target_compile_definitions(${MODULE_NAME} PRIVATE
+    PLUGIN_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}
+    PLUGIN_VERSION_MINOR=${PROJECT_VERSION_MINOR}
+    PLUGIN_VERSION_PATCH=${PROJECT_VERSION_PATCH}
+)
+
+set_target_properties(${MODULE_NAME} PROPERTIES
+        CXX_STANDARD 11
+        CXX_STANDARD_REQUIRED YES)
+
+target_link_libraries(${MODULE_NAME} 
+    PRIVATE
+        CompileSettingsDebug::CompileSettingsDebug
+        ${NAMESPACE}Plugins::${NAMESPACE}Plugins)
+
+install(TARGETS ${MODULE_NAME} 
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/${STORAGE_DIRECTORY}/plugins COMPONENT ${NAMESPACE}_Runtime)
+
+write_config()

JsonRpcMuxer/JsonRpcMuxer.conf.in

@@ -0,0 +1,9 @@
+startmode = "@PLUGIN_JSONRPCMUXER_STARTMODE@"
+
+configuration = JSON()
+
+if @PLUGIN_JSONRPCMUXER_MAX_CONCURRENT_JOBS@:
+    configuration.add("maxconcurrentjobs", "@PLUGIN_JSONRPCMUXER_MAX_CONCURRENT_JOBS@")
+
+if @PLUGIN_JSONRPCMUXER_MAX_BATCH_SIZE@:
+    configuration.add("maxbatchsize", "@PLUGIN_JSONRPCMUXER_MAX_BATCH_SIZE@")