Improved progress bar display before diagram generation starts (#415)

Author: bkryza

src/common/generators/generators.h

@@ -484,6 +484,11 @@ auto make_generator(const std::string &name,
                runtime_config]() mutable -> std::unique_ptr<diagram_model> {
         try {
             std::unique_ptr<diagram_model> model;
+
+            if (indicator) {
+                indicator->update(name);
+            }
+
             auto progress_fun = [&indicator, &name]() {
                 if (indicator)
                     indicator->increment(name);

src/common/generators/progress_indicator.cc

@@ -86,6 +86,30 @@ void progress_indicator::add_progress_bar(
     progress_bars_mutex_.unlock();
 }
 
+void json_logger_progress_indicator::update(const std::string &name)
+{
+    inja::json j;
+    j["diagram_name"] = name;
+
+    progress_bars_mutex_.lock();
+
+    if (progress_bar_index_.count(name) == 0) {
+        progress_bars_mutex_.unlock();
+        return;
+    }
+
+    auto &p = progress_bar_index_.at(name);
+
+    j["progress"] = p.progress;
+    j["max"] = p.max;
+    j["status"] = "ongoing";
+
+    progress_bars_mutex_.unlock();
+
+    spdlog::get("json-progress-logger")
+        ->log(spdlog::level::info, "{}", j.dump());
+}
+
 void json_logger_progress_indicator::increment(const std::string &name)
 {
     inja::json j;
@@ -112,6 +136,27 @@ void json_logger_progress_indicator::increment(const std::string &name)
         ->log(spdlog::level::info, "{}", j.dump());
 }
 
+void progress_indicator::update(const std::string &name)
+{
+    const auto kASTTraverseProgressPercent = 95U;
+
+    progress_bars_mutex_.lock();
+
+    if (progress_bar_index_.count(name) == 0) {
+        progress_bars_mutex_.unlock();
+        return;
+    }
+
+    auto &p = progress_bar_index_.at(name);
+    auto &bar = progress_bars_[p.index];
+
+    bar.set_progress((p.progress * kASTTraverseProgressPercent) / p.max);
+    bar.set_option(indicators::option::PostfixText{
+        fmt::format("{}/{}", p.progress, p.max)});
+
+    progress_bars_mutex_.unlock();
+}
+
 void progress_indicator::increment(const std::string &name)
 {
     const auto kASTTraverseProgressPercent = 95U;

src/common/generators/progress_indicator.h

@@ -59,6 +59,13 @@ class progress_indicator_base {
      */
     virtual void increment(const std::string &name) = 0;
 
+    /**
+     * Update the display of the progress bar without modifying progress.
+     *
+     * @param name Name of the progress ba*
+     */
+    virtual void update(const std::string &name) = 0;
+
     /**
      * Stop all the progress bars.
      */
@@ -92,6 +99,8 @@ class json_logger_progress_indicator : public progress_indicator_base {
     void add_progress_bar(
         const std::string &name, size_t max, indicators::Color color) override;
 
+    void update(const std::string &name) override;
+
     void increment(const std::string &name) override;
 
     void stop() override { }
@@ -115,6 +124,8 @@ class progress_indicator : public progress_indicator_base {
     void add_progress_bar(
         const std::string &name, size_t max, indicators::Color color) override;
 
+    void update(const std::string &name) override;
+
     void increment(const std::string &name) override;
 
     void stop() override;