karabo.cpp 3.0.2__tar.gz → 3.0.5__tar.gz

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/CMakeLists.txt

@@ -37,9 +37,6 @@ install(DIRECTORY extern/build/include/
         PATTERN "boost/fusion"        EXCLUDE
         PATTERN "boost/geometry"      EXCLUDE
         PATTERN "boost/spirit"        EXCLUDE
-        PATTERN "boost/mpl"           EXCLUDE
-        PATTERN "boost/preprocessor"  EXCLUDE
-        PATTERN "boost/math"          EXCLUDE
         PATTERN "boost/wave"          EXCLUDE
         PATTERN "boost/beast"         EXCLUDE
         PATTERN "boost/qvm"           EXCLUDE

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: karabo.cpp
-Version: 3.0.2
+Version: 3.0.5
 Summary: Karabo's C++ API and Python bindings thereof
 Keywords: Karabo,SCADA,async,control system
 Author-Email: European XFEL GmbH <opensource@xfel.eu>
@@ -13,7 +13,7 @@ Project-URL: Homepage, https://github.com/European-XFEL/Karabo
 Project-URL: Bug Reports, https://github.com/European-XFEL/Karabo/issues
 Project-URL: Source, https://github.com/European-XFEL/Karabo
 Requires-Python: ==3.12.*
-Requires-Dist: karabo-native==3.0.2
+Requires-Dist: karabo-native==3.0.5
 Description-Content-Type: text/markdown
 
 # Karabo SCADA Framework - C++ API and Service Devices

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/extern/build.sh

@@ -64,6 +64,19 @@ checkReturnCode() {
     fi
 }
 
+add_conan_mirrors() {
+    # Setup mirrors for conan to look for
+    for mirror in "${!CONAN_MIRRORS[@]}"; do
+        mirror_url="${CONAN_MIRRORS[$mirror]}"
+        if conan remote list | grep -q "$mirror_url"; then
+            echo "Remote $mirror is already added."
+        else
+            echo "Adding remote $mirror with URL $mirror_url"
+            safeRunCommandQuiet conan remote add "$mirror" "$mirror_url"
+        fi
+    done
+}
+
 safeRunCommand() {
     typeset cmnd="$*"
     typeset ret_code
@@ -99,6 +112,7 @@ install_python() {
     # create default build profile
     safeRunCommandQuiet "conan profile detect --force"
 
+    add_conan_mirrors
     # configure prefix paths
     local folder_opts="--deployer=karabo_deployer --deployer-folder=$INSTALL_PREFIX --output-folder=$INSTALL_PREFIX/conan_toolchain"
     # build python if not found in conan cache
@@ -131,12 +145,6 @@ install_python() {
         safeRunCommandQuiet "conan remote update conancenter --url https://center2.conan.io"
     fi
 
-    # Some dependencies, like libpng specify minimum required versions of cmake to be older than
-    # "3.5" - starting with cmake "4.X", the minimum cmake version must be at least "3.5".
-    # Details at https://cmake.org/cmake/help/v4.0/release/4.0.html#id14
-    # Setting the environment variable below allows passing the cmake check.
-    export CMAKE_POLICY_VERSION_MINIMUM="3.5"
-
     safeRunCommandQuiet "conan install conanfile-bootstrap.txt $folder_opts $build_opts $profile_opts"
 
     # ensure that python can always find its libpython.so
@@ -164,6 +172,7 @@ install_from_deps() {
     # create default build profile
     safeRunCommandQuiet "$INSTALL_PREFIX/bin/conan profile detect --force"
 
+        add_conan_mirrors
         # export local conan recipes (for packages where no public recipe exists
         # we keep custom conan recipes in extern/resources/<pkg_name>)
         safeRunCommandQuiet "$INSTALL_PREFIX/bin/conan export ./resources/daemontools/conanfile.py --name daemontools-encore --version $DAEMONTOOLS_VERSION --user karabo --channel $CONAN_RECIPE_CHANNEL"
@@ -268,6 +277,12 @@ else
    conan --version
 fi
 
+# Some dependencies, like libpng specify minimum required versions of cmake to be older than
+# "3.5" - starting with cmake "4.X", the minimum cmake version must be at least "3.5".
+# Details at https://cmake.org/cmake/help/v4.0/release/4.0.html#id14
+# Setting the environment variable below allows passing the cmake check.
+export CMAKE_POLICY_VERSION_MINIMUM="3.5"
+
 # python download and install to allow full bootstrap
 # install framework python dependencies via pip
 check_for $INSTALL_PREFIX/bin/python

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/extern/conanfile.txt

@@ -18,11 +18,11 @@ zeromq/4.3.2
 
 
 # patch-any
-libpng/1.6.37
+libpng/1.6.50
 libxslt/1.1.34
 libxml2/2.11.6
 patchelf/0.13
-pugixml/1.10
+pugixml/1.15
 
 # minor-any
 boost/1.88.0

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["scikit-build-core"]
 build-backend = "scikit_build_core.build"
 
 [project]
-version = "3.0.2"
+version = "3.0.5"
 name = "karabo.cpp"
 description = "Karabo's C++ API and Python bindings thereof"
 readme = "README.md"
@@ -38,7 +38,7 @@ classifiers = [
 # For an analysis of this field vs pip's requirements files see:
 # https://packaging.python.org/discussions/install-requires-vs-requirements/
 dependencies = [
-  "karabo-native==3.0.2",
+  "karabo-native==3.0.5",
   ]
 
 
@@ -130,5 +130,5 @@ before-build = "pip3 install conan==2.19.0 && pip3 install numpy==2.0.1 && pytho
 
 test-requires = ["pytest"]
 # these are minimally required for a C++ server to start
-before-test = "mkdir /karabo && mkdir /karabo/var && mkdir /karabo/var/data && mkdir /karabo/plugins && pip install karabo.native==3.0.2 --index-url 'https://gitlab-ci-token:glcbt-64_-qct2EHsCdkA1roMoozd@git.xfel.eu/api/v4/projects/5003/packages/pypi/simple' --extra-index-url https://pypi.org"
+before-test = "mkdir /karabo && mkdir /karabo/var && mkdir /karabo/var/data && mkdir /karabo/plugins && pip install karabo.native==3.0.5 --index-url 'https://gitlab-ci-token:glcbt-64_L2Hdjy_gxsx7hWFg_pWT@git.xfel.eu/api/v4/projects/5003/packages/pypi/simple' --extra-index-url https://pypi.org"
 test-command = "KARABO=/karabo KARABO_BROKER=amqp://xfel:karabo@exfl-broker-1:5672 pytest {project}/wheel_tests"

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/CMakeLists.txt

@@ -66,10 +66,10 @@ endif()
 # Extracts KARABO_VERSION from the appropriate Git tag, writes to
 # a file to be used by the Karabo Framework at build time.
 message(STATUS "Resolving Karabo Version from Git repository")
-set(KARABO_VERSION "3.0.2")
+set(KARABO_VERSION "3.0.5")
 set(KARABO_VERSION_MAJOR "3")
 set(KARABO_VERSION_MINOR "0")
-set(KARABO_VERSION_PATCH "2")
+set(KARABO_VERSION_PATCH "5")
 message(STATUS "Karabo Version: ${KARABO_VERSION}")
 message(STATUS "Karabo Version Major: ${KARABO_VERSION_MAJOR}")
 message(STATUS "Karabo Version Minor: ${KARABO_VERSION_MINOR}")

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/core/Device.cc

@@ -158,10 +158,7 @@ namespace karabo {
             ALARM_ELEMENT(expected)
                   .key("alarmCondition")
                   .displayedName("Alarm condition")
-                  .description(
-                        "The current alarm condition of the device. "
-                        "Evaluates to the highest condition on any"
-                        " property if not set manually.")
+                  .description("The current alarm condition of the device.")
                   .initialValue(AlarmCondition::NONE)
                   .commit();
 

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/core/DeviceClient.cc

@@ -58,7 +58,6 @@ namespace karabo {
         // See also OutputChannel::initializeServerConnection(...)
         const int kMaxCompleteInitializationAttempts = 2500;
 
-        // TODO: Move this to a constant of ConfigurationManager device once it becomes part of the Framework.
         const std::string DEFAULT_CONFIG_MANAGER_ID("KaraboConfigurationManager");
 
         void DeviceClient::initServiceDeviceIds(const Hash& serviceDeviceIds) {
@@ -81,8 +80,7 @@ namespace karabo {
               m_internalTimeout(3000),
               m_topologyInitialized(false),
               m_ageingTimer(karabo::net::EventLoop::getIOService()),
-              m_getOlder(false) // Sic! To start aging in setAgeing below.
-              ,
+              m_getOlder(false), // Sic! To start aging in setAgeing below.
               m_signalsChangedTimer(karabo::net::EventLoop::getIOService()),
               m_runSignalsChangedTimer(false),
               m_signalsChangedInterval(-1),
@@ -119,8 +117,7 @@ namespace karabo {
               m_internalTimeout(2000),
               m_topologyInitialized(false),
               m_ageingTimer(karabo::net::EventLoop::getIOService()),
-              m_getOlder(false) // Sic! To start aging in setAgeing below.
-              ,
+              m_getOlder(false), // Sic! To start aging in setAgeing below.
               m_signalsChangedTimer(karabo::net::EventLoop::getIOService()),
               m_runSignalsChangedTimer(false),
               m_signalsChangedInterval(-1),
@@ -203,18 +200,15 @@ namespace karabo {
                   bind_weak(&karabo::core::DeviceClient::_slotClassSchema, this, _1, _2, _3), "_slotClassSchema");
             p->registerSlot<Schema, string>(bind_weak(&karabo::core::DeviceClient::_slotSchemaUpdated, this, _1, _2),
                                             "_slotSchemaUpdated");
+            // We hook our methods to the existing (in SignalSlotable) slots for instance monitoring
             p->registerSlot<string, Hash>(bind_weak(&karabo::core::DeviceClient::_slotInstanceNew, this, _1, _2),
-                                          "_slotInstanceNew");
+                                          "slotInstanceNew");
             p->registerSlot<string, Hash>(bind_weak(&karabo::core::DeviceClient::_slotInstanceGone, this, _1, _2),
-                                          "_slotInstanceGone");
+                                          "slotInstanceGone");
             p->registerSlot<string, Hash>(bind_weak(&karabo::core::DeviceClient::_slotInstanceUpdated, this, _1, _2),
-                                          "_slotInstanceUpdated");
+                                          "slotInstanceUpdated");
+            // A slot to follow logger map updates
             p->registerSlot<Hash>(bind_weak(&karabo::core::DeviceClient::_slotLoggerMap, this, _1), "_slotLoggerMap");
-
-            // No advantage from asyncConnect since connecting to one's own signal is just a call chain:
-            p->connect("", "signalInstanceNew", "_slotInstanceNew");
-            p->connect("", "signalInstanceGone", "_slotInstanceGone");
-            p->connect("", "signalInstanceUpdated", "_slotInstanceUpdated");
         }
 
 
@@ -380,11 +374,11 @@ namespace karabo {
                     //
                     // As a workaround, we try to clarify the situation:
                     // - Take care that we do not track the instance.
-                    // - Trigger a call to our slotPingAnswer that will then trigger "signalInstanceNew" (but only
+                    // - Trigger a call to our slotDiscoverAnswer that will then trigger "slotInstanceNew" (but only
                     //   if instance is untracked).
                     if (auto sigSlot = m_signalSlotable.lock()) {
                         const bool wasTracked = sigSlot->eraseTrackedInstance(instanceId);
-                        sigSlot->call(instanceId, "slotPing", 0);
+                        sigSlot->call(instanceId, "slotDiscover", 0);
                         KARABO_LOG_FRAMEWORK_WARN << getInstanceId() << ": Received instance update from '"
                                                   << instanceId << "' although it is not in runtime description"
                                                   << (wasTracked ? " (but was tracked!)" : "")

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/data/schema/BaseElement.cc

@@ -28,8 +28,9 @@ void karabo::data::checkPropertyPath(const std::string& name) {
         throw KARABO_PARAMETER_EXCEPTION(("Bad (sub-)key '" + name) += "': empty");
     }
     // '/' is special: only allowed for backward compatibility in metro devices of DA group
+    // `@` is required for mangling with other control systems
     constexpr char allowedCharacters[] =
-          ".0123456789_/"
+          ".0123456789_/@"
           "abcdefghijklmnopqrstuvwxyz"
           "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
     assert(allowedCharacters[0] == karabo::data::Hash::k_defaultSep);

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/devices/DataLoggerManager.cc

@@ -682,7 +682,7 @@ namespace karabo {
                 remote().enableInstanceTracking();
 
                 // Publish logger map read from disc. Do that as late as possible in the initialization procedure
-                // to give those interested the chance to register their slots after we sent signalInstanceNew.
+                // to give those interested the chance to register their slots after we sent slotInstanceNew.
                 {
                     std::lock_guard<std::mutex> lock(
                           m_loggerMapMutex); // m_loggerMap must not be changed while we process it

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/net/AmqpClient.cc

@@ -570,11 +570,14 @@ namespace karabo::net {
                                           << static_cast<int>(m_channelStatus);
                 break;
             case ChannelStatus::CREATE_QUEUE: {
-                m_channel->declareQueue(m_queue, AMQP::autodelete, m_queueArgs)
+                // auto-delete: deleted when last consumer is finished using it
+                // exclusive: can be accessed only from our connection, deleted when that closes
+                m_channel->declareQueue(m_queue, AMQP::autodelete + AMQP::exclusive, m_queueArgs)
                       .onSuccess([wSelf](const std::string& name, int msgCount, int consumerCount) {
                           if (auto self = wSelf.lock()) {
                               if (consumerCount > 0) {
                                   // Queue already exists, but we need a unique one for us - attach timestamp
+                                  // (since queue is exclusive, happens only for same id using same connection)
                                   KARABO_LOG_FRAMEWORK_INFO_C("AmqpClient")
                                         << "Queue " << self->m_queue
                                         << " already has a consumer, append some bytes from clock and try again.";
@@ -601,15 +604,33 @@ namespace karabo::net {
                       }) // end of success handler
                       .onError([wSelf](const char* message) {
                           if (auto self = wSelf.lock()) {
-                              const std::string queue(self->m_instanceId == self->m_queue ? "" : self->m_queue + " ");
-                              KARABO_LOG_FRAMEWORK_WARN_C("AmqpClient")
-                                    << self->m_instanceId << ": Declaring queue " << queue << "failed: " << message;
-                              // reset channel
-                              self->m_channel.reset();
-                              self->m_channelStatus = ChannelStatus::REQUEST;
-                              AsyncHandler callback;
-                              callback.swap(self->m_channelPreparationCallback);
-                              callback(make_error_code(AmqpCppErrc::eCreateQueueError));
+                              const std::string_view msg(message);
+                              constexpr auto np = std::string::npos;
+                              if (msg.find("RESOURCE_LOCKED") != np && msg.find("cannot obtain exclusive") != np) {
+                                  KARABO_LOG_FRAMEWORK_INFO
+                                        << "Queue " << self->m_queue
+                                        << " already created, append some bytes from clock and try again. "
+                                        << "Will recreate channel (was " << (self->m_channel->usable() ? "" : "not ")
+                                        << "OK)."; // should be not OK
+                                  std::ostringstream oss;
+                                  oss << ":" << std::hex << std::chrono::steady_clock::now().time_since_epoch().count();
+                                  self->m_queue += oss.str();
+                                  self->m_channelStatus = ChannelStatus::CREATE;
+                                  AsyncHandler callback;
+                                  callback.swap(self->m_channelPreparationCallback);
+                                  self->asyncPrepareChannel(std::move(callback));
+                              } else {
+                                  const std::string queue(self->m_instanceId == self->m_queue ? ""
+                                                                                              : self->m_queue + " ");
+                                  KARABO_LOG_FRAMEWORK_WARN << self->m_instanceId << ": Declaring queue " << queue
+                                                            << "failed: " << message;
+                                  // reset channel
+                                  self->m_channel.reset();
+                                  self->m_channelStatus = ChannelStatus::REQUEST;
+                                  AsyncHandler callback;
+                                  callback.swap(self->m_channelPreparationCallback);
+                                  callback(make_error_code(AmqpCppErrc::eCreateQueueError));
+                              }
                           }
                       }); // end of failure handler
             } break;

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/tests/data/schema/Schema_Test.cc

@@ -1377,7 +1377,7 @@ void Schema_Test::testInvalidNodes() {
                          karabo::data::ParameterException);
 
     // Various characters are forbidden:
-    constexpr char forbidden[] = "()[]<>`~!@#$%^&*-+=|\\:;'\",? ";
+    constexpr char forbidden[] = "()[]<>`~!#$%^&*-+=|\\:;'\",? ";
     const std::string valid("valid");
     std::string invalid(valid + " ");
     for (size_t i = 0; i < sizeof(forbidden) / sizeof(forbidden[0]); ++i) {
@@ -1403,7 +1403,7 @@ void Schema_Test::testInvalidNodes() {
     constexpr char validCharacters[] =
           "abcdefghijklmnopqrstuvwxyz/" // tolerate `/`
           "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-          "0123456789_";
+          "0123456789_@";
     CPPUNIT_ASSERT_NO_THROW(INT8_ELEMENT(schema).key(validCharacters).readOnly().commit());
 }
 

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/tests/net/Amqp_Test.cc

@@ -756,9 +756,19 @@ void Amqp_Test::testClientSameId() {
     CPPUNIT_ASSERT_EQUAL('x', bob2ReadData->front());
 
     //***************************************************************
-    // Now stress testing with many clients with same id created in 'parallel' (well, one after another in the single
-    // threaded io context of the connection, but the channel creation and subscription steps will be interleaved).
-    // That will trigger different code paths that avoid queue id collisions in different steps.
+    // Now stress testing with many clients with same id created in 'parallel'.
+    // We use a second connection for every other client: even our exclusive queues could be used by different clients
+    // using the same connection, so we trigger different code paths that avoid queue id collisions in different steps.
+    // And we will have one thread for each connection's io_context, so even more concurrency than just interleaved
+    // channel creation and subscription.
+    net::AmqpConnection::Pointer connection2(std::make_shared<net::AmqpConnection>(m_defaultBrokers));
+    auto done2 = std::make_shared<std::promise<boost::system::error_code>>();
+    auto fut2 = done2->get_future();
+    connection2->asyncConnect([done2](const boost::system::error_code ec) { done2->set_value(ec); });
+    CPPUNIT_ASSERT_EQUAL(std::future_status::ready, fut2.wait_for(m_timeout));
+    const boost::system::error_code ec2 = fut2.get();
+    CPPUNIT_ASSERT_EQUAL_MESSAGE(ec2.message(), static_cast<int>(boost::system::errc::success), ec2.value());
+
     const int numClients = 20;
 
     // First create the clients
@@ -768,7 +778,8 @@ void Amqp_Test::testClientSameId() {
         auto readHandler = [i, receivedFlags](const std::shared_ptr<std::vector<char>>& data,
                                               const std::string& exchange,
                                               const std::string& routingKey) { ++(receivedFlags->at(i)); };
-        clients.push_back(std::make_shared<net::AmqpClient>(connection, prefix + "alice", AMQP::Table(), readHandler));
+        const net::AmqpConnection::Pointer& conn = (i % 2 ? connection : connection2);
+        clients.push_back(std::make_shared<net::AmqpClient>(conn, prefix + "alice", AMQP::Table(), readHandler));
     }
 
     // Now let them all subscribe (and thus create channel, queue and consumer) in parallel

{karabo_cpp-3.0.2 → karabo_cpp-3.0.5}/src/karabo/xms/SignalSlotable.cc

@@ -935,12 +935,6 @@ namespace karabo {
             // Listener for heartbeats
             KARABO_SLOT(slotHeartbeat, string /*instanceId*/, Hash /*heartbeatInfo*/)
 
-            KARABO_SIGNAL("signalInstanceNew", string, Hash);
-
-            KARABO_SIGNAL("signalInstanceGone", string, Hash);
-
-            KARABO_SIGNAL("signalInstanceUpdated", string, Hash);
-
             // Global instance new notification
             KARABO_SLOT(slotInstanceNew, string /*instanceId*/, Hash /*instanceInfo*/)
 
@@ -1006,8 +1000,6 @@ namespace karabo {
                 addTrackedInstance(instanceId, instanceInfo);
             }
 
-            emit("signalInstanceNew", instanceId, instanceInfo);
-
             reconnectSignals(instanceId);
 
             reconnectInputChannels(instanceId);
@@ -1029,8 +1021,6 @@ namespace karabo {
             if (m_trackAllInstances) {
                 eraseTrackedInstance(instanceId);
             }
-
-            emit("signalInstanceGone", instanceId, instanceInfo);
         }
 
 
@@ -1042,7 +1032,6 @@ namespace karabo {
                 // Merge the new instanceInfo (ignoring case of a shrunk instanceInfo...)
                 addTrackedInstance(instanceId, instanceInfo);
             }
-            emit("signalInstanceUpdated", instanceId, instanceInfo); // after addTrackedInstance(..)?
         }
 
 
@@ -1199,7 +1188,8 @@ namespace karabo {
         void SignalSlotable::slotDiscoverAnswer(const std::string& instanceId, const karabo::data::Hash& instanceInfo) {
             if (!hasTrackedInstance(instanceId)) {
                 KARABO_LOG_FRAMEWORK_DEBUG << "Got ping answer from instanceId " << instanceId;
-                emit("signalInstanceNew", instanceId, instanceInfo);
+                // Treat as if it is new (to e.g. call the DeviceClient hook for "slotInstanceNew")
+                call(std::string(), "slotInstanceNew", instanceId, instanceInfo);
             } else {
                 KARABO_LOG_FRAMEWORK_DEBUG << "Got ping answer from instanceId (but already tracked) " << instanceId;
             }
@@ -1271,13 +1261,12 @@ namespace karabo {
                 } else {
                     KARABO_LOG_FRAMEWORK_WARN << "Could not connect slot '" << slotFunction << "' to (non-existing?) "
                                               << "signal '" << signalInstanceId << "." << signalFunction << "'. Will "
-                                              << "try again if '" << signalInstanceId << "' sends signalInstanceNew.";
+                                              << "try again if '" << signalInstanceId << "' calls slotInstanceNew.";
                 }
             } else {
                 KARABO_LOG_FRAMEWORK_WARN << m_instanceId << " has no slot '" << slotFunction << "', so cannot connect"
                                           << " to signal '" << signalInstanceId << "." << signalFunction
-                                          << "'. Will try again if '" << signalInstanceId
-                                          << "' sends signalInstanceNew.";
+                                          << "'. Will try again if '" << signalInstanceId << "' calls slotInstanceNew.";
             }
 
             return false;
@@ -1792,7 +1781,7 @@ namespace karabo {
                     for (size_t i = 0; i < deadOnes.size(); ++i) {
                         KARABO_LOG_FRAMEWORK_WARN << m_instanceId << ": Instance \"" << deadOnes[i].first
                                                   << "\" silently disappeared (no heartbeats received anymore)";
-                        emit("signalInstanceGone", deadOnes[i].first, deadOnes[i].second);
+                        call(std::string(), "slotInstanceGone", deadOnes[i].first, deadOnes[i].second);
                         eraseTrackedInstance(deadOnes[i].first);
                     }
                 }