QC-1086 added cycle handling to Aggregators

Author: Michal Tichák

Framework/CMakeLists.txt

@@ -5,7 +5,7 @@ configure_file("include/QualityControl/Version.h.in"
                "${CMAKE_CURRENT_BINARY_DIR}/include/QualityControl/Version.h"
                @ONLY)
 
- # ---- Library for IL ----
+# ---- Library for IL ----
 add_library(O2QualityControlInfoLogger STATIC
   src/QcInfoLogger.cxx
 )
@@ -135,7 +135,8 @@ add_library(O2QualityControl
   src/RootFileStorage.cxx
   src/ReductorHelpers.cxx
   src/KafkaPoller.cxx
-  src/FlagHelpers.cxx)
+  src/FlagHelpers.cxx
+  src/ObjectMetadataKeysHelpers.cxx)
 
 target_include_directories(
   O2QualityControl
@@ -263,7 +264,7 @@ endforeach()
 
 # ---- Tests ----
 
-add_executable(o2-qc-test-core 
+add_executable(o2-qc-test-core
                test/testActivity.cxx
                test/testActivityHelpers.cxx
                test/testAggregatorInterface.cxx
@@ -353,7 +354,7 @@ foreach(i RANGE ${count})
   get_filename_component(test_name ${test} NAME)
   string(REGEX REPLACE ".cxx" "" test_name ${test_name})
   string(REPLACE " " ";" arg "${arg}") # make list of string (arguments) out of
-                                       # one string
+  # one string
 
   add_executable(${test_name} ${test})
   set_property(TARGET ${test_name}

Framework/include/QualityControl/ObjectMetadataKeysHelpers.h

@@ -0,0 +1,29 @@
+// Copyright 2025 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file   ObjectMetadataKeysHelpers.h
+/// \author Michal Tichak
+///
+
+#include <optional>
+#include <string>
+
+namespace o2::quality_control::repository::metadata_keys
+{
+/**
+ * \brief Parses metadata value stored under metadata_keys::cycle
+ * @param cycleStr string expecting unsigned number
+ * @return if parsing fails (eg. too big of a number, string wasn't a number) it returns nullopt
+ *
+ */
+std::optional<unsigned long> parseCycle(const std::string& cycleStr);
+} // namespace o2::quality_control::repository::metadata_keys

Framework/include/QualityControl/Quality.h

@@ -18,6 +18,7 @@
 #define QC_CORE_QUALITY_H
 
 #include <Rtypes.h>
+#include <optional>
 #include <string>
 #include <map>
 #include <vector>
@@ -105,6 +106,9 @@ class Quality
   /// \brief Get metadata
   /// \return the value corresponding to the key if it was found, default value otherwise
   std::string getMetadata(const std::string& key, const std::string& defaultValue) const;
+  /// \brief Get metadata
+  /// \return the value corresponding to the key if it was found, nulopt otherwise
+  std::optional<std::string> getMetadataOpt(const std::string&) const;
 
   /// \brief Associate the Quality with a new flag and an optional comment
   /// \return reference to *this
@@ -121,7 +125,7 @@ class Quality
   std::map<std::string, std::string> mUserMetadata;
   std::vector<std::pair<FlagType, std::string>> mFlags;
 
-  ClassDef(Quality, 2);
+  ClassDef(Quality, 3);
 };
 
 } // namespace o2::quality_control::core

Framework/include/QualityControl/QualityObject.h

@@ -14,6 +14,7 @@
 
 // std
 #include <map>
+#include <optional>
 #include <string>
 #include <vector>
 // ROOT
@@ -107,6 +108,9 @@ class QualityObject : public TObject
   /// \brief Get a metadata
   /// \return the value corresponding to the key if it was found, default value otherwise
   std::string getMetadata(std::string key, std::string defaultValue) const;
+  /// \brief Get a metadata
+  /// \return the value corresponding to the key if it was found, nullopt otherwise
+  std::optional<std::string> getMetadataOpt(const std::string& key) const;
 
   /// \brief Build the path to this object.
   /// Build the path to this object as it will appear in the GUI.
@@ -145,7 +149,7 @@ class QualityObject : public TObject
   std::vector<std::string> mMonitorObjectsNames;
   Activity mActivity;
 
-  ClassDefOverride(QualityObject, 6);
+  ClassDefOverride(QualityObject, 7);
 };
 
 using QualityObjectsType = std::vector<std::shared_ptr<QualityObject>>;

Framework/src/Aggregator.cxx

@@ -16,8 +16,11 @@
 
 #include "QualityControl/Aggregator.h"
 #include "QualityControl/AggregatorSpec.h"
+#include "QualityControl/ObjectMetadataKeys.h"
+#include "QualityControl/QualityObject.h"
 #include "QualityControl/RootClassFactory.h"
 #include "QualityControl/AggregatorInterface.h"
+#include "QualityControl/ObjectMetadataKeysHelpers.h"
 #include "QualityControl/UpdatePolicyType.h"
 #include "QualityControl/ActivityHelpers.h"
 #include "QualityControl/Activity.h"
@@ -106,6 +109,21 @@ QualityObjectsMapType Aggregator::filter(QualityObjectsMapType& qoMap)
   return result;
 }
 
+std::optional<unsigned long> getMaxCycle(const QualityObjectsMapType& qoMap)
+{
+  std::optional<unsigned long> max{};
+  for (const auto& [_, qo] : qoMap) {
+    auto cycle = qo->getMetadataOpt(repository::metadata_keys::cycle);
+    if (cycle.has_value()) {
+      auto parsedCycle = repository::metadata_keys::parseCycle(cycle.value());
+      if (parsedCycle) {
+        max = std::max(parsedCycle.value(), max.value_or(0));
+      }
+    }
+  }
+  return max;
+}
+
 QualityObjectsType Aggregator::aggregate(QualityObjectsMapType& qoMap, const Activity& defaultActivity)
 {
   auto filtered = filter(qoMap);
@@ -133,7 +151,8 @@ QualityObjectsType Aggregator::aggregate(QualityObjectsMapType& qoMap, const Act
     }
   }
 
-  auto results = mAggregatorInterface->aggregate(filtered);
+  const auto maxCycle = getMaxCycle(filtered);
+  const auto results = mAggregatorInterface->aggregate(filtered);
   QualityObjectsType qualityObjects;
   for (auto const& [qualityName, quality] : results) {
     qualityObjects.emplace_back(std::make_shared<QualityObject>(
@@ -142,6 +161,9 @@ QualityObjectsType Aggregator::aggregate(QualityObjectsMapType& qoMap, const Act
       mAggregatorConfig.detectorName,
       UpdatePolicyTypeUtils::ToString(mAggregatorConfig.policyType)));
     qualityObjects.back()->setActivity(resultActivity);
+    if (maxCycle.has_value()) {
+      qualityObjects.back()->addMetadata(repository::metadata_keys::cycle, std::to_string(maxCycle.value()));
+    }
   }
   return qualityObjects;
 }

Framework/src/Check.cxx

@@ -166,14 +166,14 @@ QualityObjectsType Check::check(std::map<std::string, std::shared_ptr<MonitorObj
       }));
     ILOG(Debug, Devel) << "Check '" << mCheckConfig.name << "', quality '" << quality << "'" << ENDM;
     std::vector<std::string> monitorObjectsNames;
-    unsigned long maxCycle{};
+    std::optional<unsigned long> maxCycle{};
     for (const auto& [moName, mo] : moMapToCheck) {
       monitorObjectsNames.emplace_back(moName);
       if (const auto cycle = mo->getMetadata(repository::metadata_keys::cycle)) {
         const auto& cycleStr = cycle.value();
         unsigned long cycleVal{};
         if (const auto fromCharsRed = std::from_chars(cycleStr.c_str(), cycleStr.c_str() + cycleStr.size(), cycleVal); fromCharsRed.ec == std::errc()) {
-          maxCycle = std::max(cycleVal, maxCycle);
+          maxCycle = std::max(cycleVal, maxCycle.value_or(0));
         } else {
           ILOG(Warning, Support) << "metadata " << repository::metadata_keys::cycle << " with value " << cycleStr << " couldn't be parsed for a reason: "
                                  << std::make_error_code(fromCharsRed.ec).message() << ENDM;
@@ -190,8 +190,8 @@ QualityObjectsType Check::check(std::map<std::string, std::shared_ptr<MonitorObj
       monitorObjectsNames));
 
     qualityObjects.back()->setActivity(commonActivity);
-    if (maxCycle > 0) {
-      qualityObjects.back()->addMetadata(repository::metadata_keys::cycle, std::to_string(maxCycle));
+    if (maxCycle.has_value()) {
+      qualityObjects.back()->addMetadata(repository::metadata_keys::cycle, std::to_string(maxCycle.value()));
     }
     beautify(moMapToCheck, quality);
   }

Framework/src/MonitorObject.cxx

@@ -19,7 +19,6 @@
 #include "QualityControl/RepoPathUtils.h"
 #include "QualityControl/QcInfoLogger.h"
 
-#include <iostream>
 #include <iterator>
 #include <optional>
 

Framework/src/MonitorObjectCollection.cxx

@@ -18,36 +18,25 @@
 #include "QualityControl/MonitorObject.h"
 #include "QualityControl/ObjectMetadataKeys.h"
 #include "QualityControl/QcInfoLogger.h"
+#include "QualityControl/ObjectMetadataKeysHelpers.h"
 
 #include <Mergers/MergerAlgorithm.h>
 #include <TNamed.h>
 #include <optional>
 #include <string>
-#include <charconv>
 
 using namespace o2::mergers;
 
 namespace o2::quality_control::core
 {
 
-std::optional<unsigned long> parseCycle(const std::string& cycleStr)
-{
-  unsigned long cycleVal{};
-  if (auto parse_res = std::from_chars(cycleStr.c_str(), cycleStr.c_str() + cycleStr.size(), cycleVal); parse_res.ec != std::errc{}) {
-    ILOG(Warning, Support) << "failed to decypher " << repository::metadata_keys::cycle << " metadata with value " << cycleStr
-                           << ", with std::errc " << std::make_error_code(parse_res.ec).message() << ENDM;
-    return std::nullopt;
-  }
-  return cycleVal;
-}
-
 void mergeCycles(MonitorObject* targetMO, MonitorObject* otherMO)
 {
   const auto otherCycle = otherMO->getMetadata(repository::metadata_keys::cycle);
   const auto targetCycle = targetMO->getMetadata(repository::metadata_keys::cycle);
   if (otherCycle.has_value() && targetCycle.has_value()) {
-    const auto targetCycleParsed = parseCycle(targetCycle.value());
-    const auto otherCycleParsed = parseCycle(otherCycle.value());
+    const auto targetCycleParsed = repository::metadata_keys::parseCycle(targetCycle.value());
+    const auto otherCycleParsed = repository::metadata_keys::parseCycle(otherCycle.value());
 
     if (targetCycleParsed && otherCycleParsed) {
       targetMO->addOrUpdateMetadata(repository::metadata_keys::cycle, std::to_string(std::max(targetCycleParsed.value(), otherCycleParsed.value())));

Framework/src/ObjectMetadataKeysHelpers.cxx

@@ -0,0 +1,35 @@
+// Copyright 2025 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+///
+/// \file   ObjectMetadataKeysHelpers.cxx
+/// \author Michal Tichak
+///
+
+#include <charconv>
+#include "QualityControl/ObjectMetadataKeysHelpers.h"
+#include "QualityControl/ObjectMetadataKeys.h"
+#include "QualityControl/QcInfoLogger.h"
+
+namespace o2::quality_control::repository::metadata_keys
+{
+std::optional<unsigned long> parseCycle(const std::string& cycleStr)
+{
+  unsigned long cycleVal{};
+  if (auto parse_res = std::from_chars(cycleStr.c_str(), cycleStr.c_str() + cycleStr.size(), cycleVal);
+      parse_res.ec != std::errc{}) {
+    ILOG(Warning, Support) << "failed to decypher " << repository::metadata_keys::cycle << " metadata with value " << cycleStr
+                           << ", with std::errc " << std::make_error_code(parse_res.ec).message() << ENDM;
+    return std::nullopt;
+  }
+  return cycleVal;
+}
+} // namespace o2::quality_control::repository::metadata_keys

Framework/src/Quality.cxx

@@ -15,8 +15,8 @@
 ///
 
 #include "QualityControl/Quality.h"
+#include <optional>
 #include <ostream>
-#include <iostream>
 #include <utility>
 #include <Common/Exceptions.h>
 #include <boost/algorithm/string.hpp>
@@ -93,6 +93,14 @@ std::string Quality::getMetadata(const std::string& key, const std::string& defa
   return mUserMetadata.count(key) > 0 ? mUserMetadata.at(key) : defaultValue;
 }
 
+std::optional<std::string> Quality::getMetadataOpt(const std::string& key) const
+{
+  if (auto found = mUserMetadata.find(key); found != mUserMetadata.end()) {
+    return found->second;
+  }
+  return std::nullopt;
+}
+
 Quality& Quality::addFlag(const FlagType& flag, std::string comment)
 {
   if (isWorseThan(Quality::Medium) && !flag.getBad()) {