hash length hardwired in objects

Author: Michal Tichák

Framework/include/QualityControl/AggregatorRunner.h

@@ -82,6 +82,10 @@ struct AggregatorSource;
 /// \author Barthélémy von Haller
 class AggregatorRunner : public framework::Task
 {
+  /// \brief Number of bytes in data description used for hashing of AggregatorRunner names. See HashDataDescription.h for details
+  static constexpr size_t descriptionHashLength = 4;
+  static_assert(descriptionHashLength <= o2::header::DataDescription::size);
+
  public:
   /// Constructor
   /**
@@ -109,7 +113,7 @@ class AggregatorRunner : public framework::Task
   static framework::DataProcessorLabel getLabel() { return { "qc-aggregator" }; }
   static std::string createAggregatorRunnerIdString() { return "qc-aggregator"; };
   static std::string createAggregatorRunnerName();
-  static header::DataDescription createAggregatorRunnerDataDescription(const std::string& aggregatorName, size_t hashSize = 4);
+  static header::DataDescription createAggregatorRunnerDataDescription(const std::string& aggregatorName);
 
   /// \brief Compute the detector name to be used in the infologger for this runner.
   /// Compute the detector name to be used in the infologger for this runner.

Framework/include/QualityControl/Check.h

@@ -43,6 +43,10 @@ struct CheckSpec;
 /// \author Rafal Pacholek
 class Check
 {
+  /// \brief Number of bytes in data description used for hashing of Check descrition names. See HashDataDescription.h for details
+  static constexpr size_t descriptionHashLength = 4;
+  static_assert(descriptionHashLength <= o2::header::DataDescription::size);
+
  public:
   /// Constructor
   /**
@@ -73,7 +77,7 @@ class Check
   void endOfActivity(const core::Activity& activity);
 
   // TODO: Unique Input string
-  static o2::header::DataDescription createCheckDataDescription(const std::string& checkName, size_t hash_length = 4);
+  static o2::header::DataDescription createCheckDataDescription(const std::string& checkName);
 
   UpdatePolicyType getUpdatePolicyType() const;
   std::vector<std::string> getObjectsNames() const;

Framework/include/QualityControl/HashDataDescription.h

@@ -17,11 +17,21 @@
 
 #include <Headers/DataHeader.h>
 
-namespace o2::common::hash
+namespace o2::quality_control::core
 {
 
-o2::header::DataDescription createDataDescription(const std::string& name, size_t hash_length = 4);
+/// \brief Creates DataDescription from given name.
+///
+/// If the length of the name is <= 16 (hardcoded in DataDescription) it creates DataDescription from the original name.
+/// However, if the length of the name is > 16, it will create hash of the whole name and replace ending hashLength of bytes
+/// of the name with hexa representation of computed hash.
+/// eg.: name == "veryLongNameThatIsLongerThan16B" with hashLengh == 4 will result in "veryLongNameABCD", where ABCD
+/// is the hash create inside the function
+///
+/// \param name - name which should cut and hashed
+/// \param hashLenght - number of bytes which will overwrite the end of the name
+o2::header::DataDescription createDataDescription(const std::string& name, size_t hashLength);
 
-} // namespace o2::common::hash
+} // namespace o2::quality_control::core
 
 #endif

Framework/include/QualityControl/PostProcessingDevice.h

@@ -36,6 +36,10 @@ struct PostProcessingRunnerConfig;
 /// \author Piotr Konopka
 class PostProcessingDevice : public framework::Task
 {
+  /// \brief Number of bytes in data description used for hashing DataDescription. See HashDataDescription.h for details
+  static constexpr size_t descriptionHashLength = 4;
+  static_assert(descriptionHashLength <= o2::header::DataDescription::size);
+
  public:
   /// \brief Constructor
   ///
@@ -60,7 +64,7 @@ class PostProcessingDevice : public framework::Task
   /// \brief Unified DataOrigin for Post-processing tasks
   static header::DataOrigin createPostProcessingDataOrigin(const std::string& detectorCode);
   /// \brief Unified DataDescription naming scheme for all Post-processing tasks
-  static header::DataDescription createPostProcessingDataDescription(const std::string& taskName, size_t hashLength = 4);
+  static header::DataDescription createPostProcessingDataDescription(const std::string& taskName);
 
  private:
   /// \brief Callback for CallbackService::Id::Start (DPL) a.k.a. RUN transition (FairMQ)
@@ -78,4 +82,4 @@ class PostProcessingDevice : public framework::Task
 
 } // namespace o2::quality_control::postprocessing
 
-#endif //QUALITYCONTROL_POSTPROCESSINGDEVICE_H
+#endif // QUALITYCONTROL_POSTPROCESSINGDEVICE_H

Framework/include/QualityControl/TaskRunner.h

@@ -77,6 +77,10 @@ class ObjectsManager;
 /// \author Barthelemy von Haller
 class TaskRunner : public framework::Task
 {
+  /// \brief Number of bytes in data description used for hashing of Task names. See HashDataDescription.h for details
+  static constexpr size_t taskDescriptionHashLength = 4;
+  static_assert(taskDescriptionHashLength <= o2::header::DataDescription::size);
+
  public:
   /// \brief Constructor
   ///
@@ -108,7 +112,7 @@ class TaskRunner : public framework::Task
   /// \brief Unified DataOrigin for Quality Control tasks
   static header::DataOrigin createTaskDataOrigin(const std::string& detectorCode, bool movingWindows = false);
   /// \brief Unified DataDescription naming scheme for all tasks
-  static header::DataDescription createTaskDataDescription(const std::string& taskName, size_t hash_size = 4);
+  static header::DataDescription createTaskDataDescription(const std::string& taskName);
   /// \brief Unified DataDescription naming scheme for all timers
   static header::DataDescription createTimerDataDescription(const std::string& taskName);
 

Framework/src/AggregatorRunner.cxx

@@ -130,12 +130,12 @@ void AggregatorRunner::prepareInputs()
   }
 }
 
-header::DataDescription AggregatorRunner::createAggregatorRunnerDataDescription(const std::string& aggregatorName, size_t hashSize)
+header::DataDescription AggregatorRunner::createAggregatorRunnerDataDescription(const std::string& aggregatorName)
 {
   if (aggregatorName.empty()) {
     BOOST_THROW_EXCEPTION(FatalException() << errinfo_details("Empty taskName for task's data description"));
   }
-  return common::hash::createDataDescription(aggregatorName, hashSize);
+  return quality_control::core::createDataDescription(aggregatorName, AggregatorRunner::descriptionHashLength);
 }
 
 std::string AggregatorRunner::createAggregatorRunnerName()

Framework/src/Check.cxx

@@ -44,13 +44,13 @@ namespace o2::quality_control::checker
 {
 
 /// Static functions
-o2::header::DataDescription Check::createCheckDataDescription(const std::string& checkName, size_t hashLength)
+o2::header::DataDescription Check::createCheckDataDescription(const std::string& checkName)
 {
   if (checkName.empty()) {
     BOOST_THROW_EXCEPTION(FatalException() << errinfo_details("Empty checkName for check's data description"));
   }
 
-  return common::hash::createDataDescription(checkName, hashLength);
+  return quality_control::core::createDataDescription(checkName, Check::descriptionHashLength);
 }
 
 /// Members

Framework/src/HashDataDescription.cxx

@@ -14,7 +14,10 @@
 
 #include "QualityControl/HashDataDescription.h"
 
-namespace o2::common::hash
+namespace o2::quality_control::core
+{
+
+namespace hash
 {
 
 // creates hash of input string and returns hexadecimal representation
@@ -25,6 +28,8 @@ auto to_hexa(const std::string& input, size_t hash_length) -> std::string
   return std::move(ss).str().substr(0, hash_length);
 };
 
+} // namespace hash
+
 o2::header::DataDescription createDataDescription(const std::string& name, size_t hashLength)
 {
   o2::header::DataDescription description{};
@@ -42,4 +47,4 @@ o2::header::DataDescription createDataDescription(const std::string& name, size_
   }
 }
 
-} // namespace o2::common::hash
+} // namespace o2::quality_control::core

Framework/src/PostProcessingDevice.cxx

@@ -96,13 +96,13 @@ header::DataOrigin PostProcessingDevice::createPostProcessingDataOrigin(const st
   return origin;
 }
 
-header::DataDescription PostProcessingDevice::createPostProcessingDataDescription(const std::string& taskName, size_t hashLength)
+header::DataDescription PostProcessingDevice::createPostProcessingDataDescription(const std::string& taskName)
 {
   if (taskName.empty()) {
     BOOST_THROW_EXCEPTION(FatalException() << errinfo_details("Empty taskName for pp-task's data description"));
   }
 
-  return common::hash::createDataDescription(taskName, hashLength);
+  return quality_control::core::createDataDescription(taskName, PostProcessingDevice::descriptionHashLength);
 }
 
 void PostProcessingDevice::start(ServiceRegistryRef services)

Framework/src/TaskRunner.cxx

@@ -292,13 +292,13 @@ header::DataOrigin TaskRunner::createTaskDataOrigin(const std::string& detectorC
   return origin;
 }
 
-header::DataDescription TaskRunner::createTaskDataDescription(const std::string& taskName, size_t hashSize)
+header::DataDescription TaskRunner::createTaskDataDescription(const std::string& taskName)
 {
   if (taskName.empty()) {
     BOOST_THROW_EXCEPTION(FatalException() << errinfo_details("Empty taskName for task's data description"));
   }
 
-  return common::hash::createDataDescription(taskName, hashSize);
+  return quality_control::core::createDataDescription(taskName, TaskRunner::taskDescriptionHashLength);
 }
 
 header::DataDescription TaskRunner::createTimerDataDescription(const std::string& taskName)