Canvas options (QC-253) (#434)

* Allow to add or update metadata in MO

* CCDB json retrieval: also return the metadata

* Let user set drawOptions and displayHints

Author: Barthelemy

Framework/include/QualityControl/DatabaseInterface.h

@@ -92,18 +92,21 @@ class DatabaseInterface
   /**
    * \brief Look up a monitor object and return it in JSON format.
    * Look up a monitor object and return it in JSON format if found or an empty string if not.
+   * The headers associated with the object are added to the JSON object under the key "metadata".
    * @deprecated
    */
   virtual std::string retrieveMOJson(std::string taskName, std::string objectName, long timestamp = -1) = 0;
   /**
    * \brief Look up a quality object and return it in JSON format.
    * Look up a quality object and return it in JSON format if found or an empty string if not.
+   * The headers associated with the object are added to the JSON object under the key "metadata".
    * @deprecated
    */
   virtual std::string retrieveQOJson(std::string qoPath, long timestamp = -1) = 0;
   /**
    * \brief Look up an object and return it in JSON format.
    * Look up an object and return it in JSON format if found or an empty string if not.
+   * The headers associated with the object are added to the JSON object under the key "metadata".
    * \param path the path of the object
    * \param timestamp the timestamp to query the object
    * \param metadata filters under the form of key-value pairs to select data
@@ -112,6 +115,7 @@ class DatabaseInterface
   /**
    * \brief Look up an object and return it in JSON format.
    * Look up an object and return it in JSON format if found or an empty string if not.
+   * The headers associated with the object are added to the JSON object under the key "metadata".
    * A default timestamp of -1 is used, usually meaning to use the current timestamp.
    * \param path the path to the object
    */

Framework/include/QualityControl/MonitorObject.h

@@ -95,6 +95,8 @@ class MonitorObject : public TObject
   void updateMetadata(std::string key, std::string value);
   /// \brief Get the full map of user's metadata
   const std::map<std::string, std::string>& getMetadataMap() const;
+  /// \brief Update the value of metadata or add it if it does not exist yet.
+  void addOrUpdateMetadata(std::string key, std::string value);
 
   void Draw(Option_t* option) override;
   TObject* DrawClone(Option_t* option) const override;

Framework/include/QualityControl/ObjectsManager.h

@@ -49,6 +49,9 @@ class ObjectsManager
   explicit ObjectsManager(TaskConfig& taskConfig, bool noDiscovery = false);
   virtual ~ObjectsManager();
 
+  static const std::string gDrawOptionsKey;
+  static const std::string gDisplayHintsKey;
+
   /**
    * Start publishing the object obj, i.e. it will be pushed forward in the workflow at regular intervals.
    * The ownership remains to the caller.
@@ -98,6 +101,38 @@ class ObjectsManager
    */
   void addMetadata(const std::string& objectName, const std::string& key, const std::string& value);
 
+  /**
+   * \brief Set default draw options for this object.
+   * If possible, the object will be drawn with these options (in the ROOT sense).
+   * See for example https://root.cern/doc/master/classTHistPainter.html#HP01
+   * E.g. manager->setDefaultDRawOptions("histo1", "colz");
+   * @param objectName Name of the object affected by these drawOptions.
+   * @param options The list of options.
+   * @throw ObjectNotFoundError if object is not found.
+   */
+  void setDefaultDrawOptions(const std::string& objectName, const std::string& options);
+
+  /**
+   * See setDefaultDrawOptions(const std::string& objectName, const std::string& hioptionsnts).
+   */
+  void setDefaultDrawOptions(TObject* obj, const std::string& options);
+
+  /**
+   * \brief Indicate how to display this object.
+   * A number of options can be set on a canvas to influence the way the object is displayed.
+   * For drawOptions, use setDefaultDrawOptions, for others such as logarithmic scale or grid, use this method.
+   * Currently supported by QCG: logx, logy, logz, gridx, gridy, gridz
+   * @param objectName Name of the object affected by these drawOptions.
+   * @param options The list of hints.
+   * @throw ObjectNotFoundError if object is not found.
+   */
+  void setDisplayHint(const std::string& objectName, const std::string& hints);
+
+  /**
+   * See setDisplayHint(const std::string& objectName, const std::string& hints).
+   */
+  void setDisplayHint(TObject* obj, const std::string& hints);
+
   /**
    * Get the number of objects that have been published.
    * @return an int with the number of objects.

Framework/src/CcdbDatabase.cxx

@@ -31,16 +31,21 @@
 #include <chrono>
 #include <sstream>
 #include <unordered_set>
-
+// boost
 #include <boost/algorithm/string.hpp>
 #include <boost/property_tree/json_parser.hpp>
 #include <boost/property_tree/ptree.hpp>
 #include <boost/foreach.hpp>
+// misc
+#include "rapidjson/document.h"
+#include "rapidjson/stringbuffer.h"
+#include "rapidjson/writer.h"
 
 using namespace std::chrono;
 using namespace AliceO2::Common;
 using namespace o2::quality_control::core;
 using namespace std;
+using namespace rapidjson;
 
 namespace o2::quality_control::repository
 {
@@ -244,12 +249,15 @@ std::string CcdbDatabase::retrieveMOJson(std::string taskName, std::string objec
 std::string CcdbDatabase::retrieveJson(std::string path, long timestamp, const std::map<std::string, std::string>& metadata)
 {
   map<string, string> headers;
-  auto tobj = retrieveTObject(path, metadata, timestamp, &headers);
+  Document jsonDocument;
 
+  // Get object
+  auto* tobj = retrieveTObject(path, metadata, timestamp, &headers);
   if (tobj == nullptr) {
     return std::string();
   }
 
+  // Convert object to JSON string
   TObject* toConvert = nullptr;
   if (tobj->IsA() == MonitorObject::Class()) { // a full MO -> pre-v0.25
     std::shared_ptr<MonitorObject> mo(dynamic_cast<MonitorObject*>(tobj));
@@ -267,7 +275,26 @@ std::string CcdbDatabase::retrieveJson(std::string path, long timestamp, const s
   TString json = TBufferJSON::ConvertToJSON(toConvert);
   delete toConvert;
 
-  return json.Data();
+  // Prepare JSON document and add metadata
+  if (jsonDocument.Parse(json.Data()).HasParseError()) {
+    ILOG(Error) << "Unable to parse the JSON returned by TBufferJSON for object " << path << ENDM;
+    return std::string();
+  }
+  rapidjson::Document::AllocatorType& allocator = jsonDocument.GetAllocator();
+  rapidjson::Value object(rapidjson::Type::kObjectType);
+  for (auto const& [key, value] : headers) {
+    rapidjson::Value k(key.c_str(), allocator);
+    rapidjson::Value v(value.c_str(), allocator);
+    object.AddMember(k, v, allocator);
+  }
+  jsonDocument.AddMember("metadata", object, allocator);
+
+  // Convert to string
+  StringBuffer buffer;
+  buffer.Clear();
+  Writer<rapidjson::StringBuffer> writer(buffer);
+  jsonDocument.Accept(writer);
+  return strdup(buffer.GetString());
 }
 
 void CcdbDatabase::disconnect()

Framework/src/MonitorObject.cxx

@@ -86,6 +86,15 @@ void MonitorObject::updateMetadata(std::string key, std::string value)
   }
 }
 
+void MonitorObject::addOrUpdateMetadata(std::string key, std::string value)
+{
+  if (mUserMetadata.count(key) > 0) {
+    mUserMetadata[key] = value;
+  } else {
+    mUserMetadata.insert({ key, value });
+  }
+}
+
 std::string MonitorObject::getPath() const
 {
   string path = "qc/" + getDetectorName() + "/" + getTaskName() + "/" + getName();

Framework/src/ObjectsManager.cxx

@@ -28,6 +28,9 @@ using namespace std;
 namespace o2::quality_control::core
 {
 
+const std::string ObjectsManager::gDrawOptionsKey = "drawOptions";
+const std::string ObjectsManager::gDisplayHintsKey = "displayHints";
+
 ObjectsManager::ObjectsManager(TaskConfig& taskConfig, bool noDiscovery) : mTaskConfig(taskConfig), mUpdateServiceDiscovery(false)
 {
   mMonitorObjects = std::make_unique<MonitorObjectCollection>();
@@ -125,4 +128,28 @@ int ObjectsManager::getNumberPublishedObjects()
   return mMonitorObjects->GetLast() + 1; // GetLast returns the index
 }
 
+void ObjectsManager::setDefaultDrawOptions(const std::string& objectName, const std::string& options)
+{
+  MonitorObject* mo = getMonitorObject(objectName);
+  mo->addOrUpdateMetadata(gDrawOptionsKey, options);
+}
+
+void ObjectsManager::setDefaultDrawOptions(TObject* obj, const std::string& options)
+{
+  MonitorObject* mo = getMonitorObject(obj->GetName());
+  mo->addOrUpdateMetadata(gDrawOptionsKey, options);
+}
+
+void ObjectsManager::setDisplayHint(const std::string& objectName, const std::string& hints)
+{
+  MonitorObject* mo = getMonitorObject(objectName);
+  mo->addOrUpdateMetadata(gDisplayHintsKey, hints);
+}
+
+void ObjectsManager::setDisplayHint(TObject* obj, const std::string& hints)
+{
+  MonitorObject* mo = getMonitorObject(obj->GetName());
+  mo->addOrUpdateMetadata(gDisplayHintsKey, hints);
+}
+
 } // namespace o2::quality_control::core

Framework/test/testCcdbDatabase.cxx

@@ -26,6 +26,7 @@
 
 #include <boost/test/unit_test.hpp>
 #include <TH1F.h>
+#include "rapidjson/document.h"
 
 namespace utf = boost::unit_test;
 
@@ -38,6 +39,7 @@ namespace
 using namespace o2::quality_control::core;
 using namespace o2::quality_control::repository;
 using namespace std;
+using namespace rapidjson;
 
 const std::string CCDB_ENDPOINT = "ccdb-test.cern.ch:8080";
 
@@ -207,6 +209,15 @@ BOOST_AUTO_TEST_CASE(ccdb_retrieve_json, *utf::depends_on("ccdb_store"))
   auto json4 = f.backend->retrieveQOJson(qualityPath);
   BOOST_CHECK(!json3.empty());
   BOOST_CHECK_EQUAL(json3, json4);
+
+  Document jsonDocument;
+  jsonDocument.Parse(json.c_str());
+  BOOST_CHECK(jsonDocument["_typename"].IsString());
+  BOOST_CHECK_EQUAL(jsonDocument["_typename"].GetString(), "TH1F");
+  BOOST_CHECK(jsonDocument.FindMember("metadata") != jsonDocument.MemberEnd());
+  const Value& metadataNode = jsonDocument["metadata"];
+  BOOST_CHECK(metadataNode.IsObject());
+  BOOST_CHECK(metadataNode.FindMember("qc_task_name") != jsonDocument.MemberEnd());
 }
 
 BOOST_AUTO_TEST_CASE(ccdb_retrieve_mo_json, *utf::depends_on("ccdb_store"))

Framework/test/testObjectsManager.cxx

@@ -126,4 +126,27 @@ BOOST_AUTO_TEST_CASE(metadata_test)
   BOOST_CHECK_EQUAL(objectsManager.getMonitorObject("content")->getMetadataMap().at("aaa"), "bbb");
 }
 
+BOOST_AUTO_TEST_CASE(drawOptions_test)
+{
+  TaskConfig config;
+  config.taskName = "test";
+  config.consulUrl = "http://consul-test.cern.ch:8500";
+  ObjectsManager objectsManager(config, true);
+
+  TH1F h("histo", "h", 100, 0, 99);
+  objectsManager.startPublishing(&h);
+
+  BOOST_CHECK_THROW(objectsManager.getMonitorObject("histo")->getMetadataMap().at(ObjectsManager::gDrawOptionsKey), out_of_range);
+  objectsManager.setDefaultDrawOptions(&h, "colz");
+  BOOST_CHECK_EQUAL(objectsManager.getMonitorObject("histo")->getMetadataMap().at(ObjectsManager::gDrawOptionsKey), "colz");
+  objectsManager.setDefaultDrawOptions("histo", "alp lego1");
+  BOOST_CHECK_EQUAL(objectsManager.getMonitorObject("histo")->getMetadataMap().at(ObjectsManager::gDrawOptionsKey), "alp lego1");
+
+  BOOST_CHECK_THROW(objectsManager.getMonitorObject("histo")->getMetadataMap().at(ObjectsManager::gDisplayHintsKey), out_of_range);
+  objectsManager.setDisplayHint(&h, "logx");
+  BOOST_CHECK_EQUAL(objectsManager.getMonitorObject("histo")->getMetadataMap().at(ObjectsManager::gDisplayHintsKey), "logx");
+  objectsManager.setDisplayHint("histo", "gridy logy");
+  BOOST_CHECK_EQUAL(objectsManager.getMonitorObject("histo")->getMetadataMap().at(ObjectsManager::gDisplayHintsKey), "gridy logy");
+}
+
 } // namespace o2::quality_control::core