Fix comments

src/app/CliArgs.cpp

@@ -47,7 +47,6 @@ CliArgs::parse(int argc, char const* argv[])
         ("conf,c", po::value<std::string>()->default_value(defaultConfigPath), "configuration file")
         ("ng-web-server,w", "Use ng-web-server")
         ("migrate", po::value<std::string>(),"start migration helper")
-        ("migrate_rollback", po::value<std::string>(),"rollback the given migration")
     ;
     // clang-format on
     po::positional_options_description positional;
@@ -72,13 +71,8 @@ CliArgs::parse(int argc, char const* argv[])
     if (parsed.count("migrate") != 0u) {
         auto const opt = parsed["migrate"].as<std::string>();
         if (opt == "status")
-            return Action{Action::Migrate{std::move(configPath), MigratorApplication::Cmd::status()}};
-        return Action{Action::Migrate{std::move(configPath), MigratorApplication::Cmd::migration(opt)}};
-    }
-
-    if (parsed.count("migrate_rollback") != 0u) {
-        auto const opt = parsed["migrate_rollback"].as<std::string>();
-        return Action{Action::Migrate{std::move(configPath), MigratorApplication::Cmd::rollback(opt)}};
+            return Action{Action::Migrate{std::move(configPath), MigrateSubCmd::status()}};
+        return Action{Action::Migrate{std::move(configPath), MigrateSubCmd::migration(opt)}};
     }
 
     return Action{Action::Run{.configPath = std::move(configPath), .useNgWebServer = parsed.count("ng-web-server") != 0}

src/app/CliArgs.hpp

@@ -56,7 +56,7 @@ class CliArgs {
         /** @brief Migration action. */
         struct Migrate {
             std::string configPath;
-            MigratorApplication::Cmd subCmd;
+            MigrateSubCmd subCmd;
         };
 
         /**

src/data/BackendInterface.hpp

@@ -45,7 +45,6 @@
 #include <string>
 #include <thread>
 #include <type_traits>
-#include <unordered_set>
 #include <utility>
 #include <vector>
 
@@ -550,13 +549,14 @@ class BackendInterface {
     ) const;
 
     /**
-     * @brief Database-specific implementation of fetching the migrated features.
+     * @brief Fetches the status of migrator by name.
      *
+     * @param migratorName The name of the migrator
      * @param yield The coroutine context
-     * @return The name of migrated features on success; nullopt otherwise
+     * @return The status of the migrator if found; nullopt otherwise
      */
-    virtual std::optional<std::unordered_set<std::string>>
-    fetchMigratedFeatures(boost::asio::yield_context yield) const = 0;
+    virtual std::optional<std::string>
+    fetchMigratorStatus(std::string const& migratorName, boost::asio::yield_context yield) const = 0;
 
     /**
      * @brief Synchronously fetches the ledger range from DB.
@@ -683,6 +683,15 @@ class BackendInterface {
     bool
     finishWrites(std::uint32_t ledgerSequence);
 
+    /**
+     *@brief Mark the migration status of a migrator as Migrated in the database
+     *
+     *@param migratorName The name of the migrator
+     *@param status The status to set
+     */
+    virtual void
+    writeMigratorStatus(std::string const& migratorName, std::string const& status) = 0;
+
     /**
      * @return true if database is overwhelmed; false otherwise
      */

src/data/CassandraBackend.hpp

@@ -838,26 +838,24 @@ class BasicCassandraBackend : public BackendInterface {
         return results;
     }
 
-    std::optional<std::unordered_set<std::string>>
-    fetchMigratedFeatures(boost::asio::yield_context yield) const override
+    std::optional<std::string>
+    fetchMigratorStatus(std::string const& migratorName, boost::asio::yield_context yield) const override
     {
-        auto const res = executor_.read(yield, schema_->selectMigratedFeatures);
+        auto const res = executor_.read(yield, schema_->selectMigratorStatus, Text(migratorName));
         if (not res) {
-            LOG(log_.error()) << "Could not fetch migrated features: " << res.error();
+            LOG(log_.error()) << "Could not fetch migrator status: " << res.error();
             return {};
         }
 
-        std::unordered_set<std::string> features;
         auto const& results = res.value();
         if (not results) {
-            LOG(log_.warn()) << "No migrated features in database";
-            return features;
+            return {};
         }
 
-        for (auto [feature] : extract<std::string>(results))
-            features.insert(std::move(feature));
+        for (auto [statusString] : extract<std::string>(results))
+            return statusString;
 
-        return features;
+        return {};
     }
 
     void
@@ -987,6 +985,14 @@ class BasicCassandraBackend : public BackendInterface {
         // probably was used in PG to start a transaction or smth.
     }
 
+    void
+    writeMigratorStatus(std::string const& migratorName, std::string const& status) override
+    {
+        executor_.writeSync(
+            schema_->insertMigratorStatus, data::cassandra::Text{migratorName}, data::cassandra::Text(status)
+        );
+    }
+
     bool
     isTooBusy() const override
     {

src/data/README.md

@@ -263,14 +263,14 @@ CREATE TABLE clio.nf_token_transactions (
 
 The `nf_token_transactions` table serves as the NFT counterpart to `account_tx`, inspired by the same motivations and fulfilling a similar role within this context. It drives the `nft_history` API.
 
-### migrated_features
+### migrator_status
 
 ```
-CREATE TABLE clio.migrated_features (
-	status TEXT, 	  				# The migration status of the feature
-	feature_name TEXT,				# The name of the feature
-	PRIMARY KEY (status, feature_name)
-	) 
+CREATE TABLE clio.migrator_status (
+    migrator_name TEXT,     # The name of the migrator
+    status TEXT,            # The status of the migrator
+    PRIMARY KEY (migrator_name)
+) 
 ```
 
-The `migrated_features` table stores the status of the migration of features in this database. If a feature's status is `migrated`, it means this database has finished data migration for this feature. The feature name is the name of the feature that has been migrated. Now the status can only be `migrated`. 
+The `migrator_status` table stores the status of the migratior in this database. If a migrator's status is `migrated`, it means this database has finished data migration for this migrator.

src/data/cassandra/Schema.hpp

@@ -274,12 +274,12 @@ class Schema {
             R"(
            CREATE TABLE IF NOT EXISTS {}
                   ( 
-                    status TEXT,
-                    feature_name TEXT,
-                    PRIMARY KEY (status, feature_name)
+                   migrator_name TEXT,
+                          status TEXT,
+                         PRIMARY KEY (migrator_name)
                   ) 
             )",
-            qualifiedTableName(settingsProvider_.get(), "migrated_features")
+            qualifiedTableName(settingsProvider_.get(), "migrator_status")
         ));
 
         return statements;
@@ -478,6 +478,17 @@ class Schema {
             ));
         }();
 
+        PreparedStatement insertMigratorStatus = [this]() {
+            return handle_.get().prepare(fmt::format(
+                R"(
+                INSERT INTO {}
+                       (migrator_name, status)
+                VALUES (?, ?)
+                )",
+                qualifiedTableName(settingsProvider_.get(), "migrator_status")
+            ));
+        }();
+
         //
         // Select queries
         //
@@ -781,14 +792,14 @@ class Schema {
             ));
         }();
 
-        PreparedStatement selectMigratedFeatures = [this]() {
+        PreparedStatement selectMigratorStatus = [this]() {
             return handle_.get().prepare(fmt::format(
                 R"(
-                SELECT feature_name
+                SELECT status
                   FROM {}
-                WHERE status = 'migrated'
+                 WHERE migrator_name = ?
                 )",
-                qualifiedTableName(settingsProvider_.get(), "migrated_features")
+                qualifiedTableName(settingsProvider_.get(), "migrator_status")
             ));
         }();
     };

src/data/cassandra/Types.hpp

@@ -75,15 +75,6 @@ struct Text {
     explicit Text(std::string text) : text{std::move(text)}
     {
     }
-
-    /**
-     * @brief Construct a new Text object from char const* type
-     *
-     * @param text The text to wrap
-     */
-    explicit Text(char const* text) : text{text}
-    {
-    }
 };
 
 class Handle;

src/migration/CMakeLists.txt

@@ -1,8 +1,8 @@
 add_library(clio_migration)
 
 target_sources(
-  clio_migration PRIVATE MigrationApplication.cpp MigrationManagerFactory.cpp cassandra/ObjectsAdapter.cpp
-                         cassandra/TransactionsAdapter.cpp
+  clio_migration PRIVATE MigrationApplication.cpp impl/MigrationManagerFactory.cpp MigratorStatus.cpp
+                         cassandra/impl/ObjectsAdapter.cpp cassandra/impl/TransactionsAdapter.cpp
 )
 
 target_link_libraries(clio_migration PRIVATE clio_util clio_etl)

src/migration/MigrationApplication.cpp

@@ -19,8 +19,9 @@
 
 #include "migration/MigrationApplication.hpp"
 
-#include "migration/MigrationManagerFactory.hpp"
-#include "migration/MigrationManagerInterface.hpp"
+#include "migration/MigratiorStatus.hpp"
+#include "migration/impl/MigrationManagerFactory.hpp"
+#include "migration/impl/MigrationManagerInterface.hpp"
 #include "util/OverloadSet.hpp"
 #include "util/config/Config.hpp"
 #include "util/log/Logger.hpp"
@@ -35,21 +36,20 @@
 
 namespace app {
 
-MigratorApplication::MigratorApplication(util::Config const& config, Cmd command) : cmd_(std::move(command))
+MigratorApplication::MigratorApplication(util::Config const& config, MigrateSubCmd command) : cmd_(std::move(command))
 {
     PrometheusService::init(config);
 
-    migrationManager_ = migration::makeMigrationManager(config);
+    migrationManager_ = migration::impl::makeMigrationManager(config);
 }
 
 int
 MigratorApplication::run()
 {
     return std::visit(
         util::OverloadSet{
-            [this](Cmd::Status const&) { return printStatus(); },
-            [this](Cmd::Migration const& cmdBundle) { return migrate(cmdBundle.migratorName); },
-            [this](Cmd::Rollback const& cmdBundle) { return rollback(cmdBundle.migratorName); }
+            [this](MigrateSubCmd::Status const&) { return printStatus(); },
+            [this](MigrateSubCmd::Migration const& cmdBundle) { return migrate(cmdBundle.migratorName); }
         },
         cmd_.state
     );
@@ -66,8 +66,8 @@ MigratorApplication::printStatus()
     }
 
     for (auto const& [migrator, status] : allMigratorsStatus) {
-        std::cout << "Migrator: " << migrator << " - "
-                  << (status == migration::MigratorStatus::Migrated ? "migrated" : "not migrated") << std::endl;
+        std::cout << "Migrator: " << migrator << " - " << migrationManager_->getMigratorDescriptionByName(migrator)
+                  << " - " << status.toString() << std::endl;
     }
     return EXIT_SUCCESS;
 }
@@ -94,26 +94,4 @@ MigratorApplication::migrate(std::string const& migratorName)
     return EXIT_SUCCESS;
 }
 
-int
-MigratorApplication::rollback(std::string const& migratorName)
-{
-    auto const status = migrationManager_->getMigratorStatusByName(migratorName);
-    if (status == migration::MigratorStatus::NotMigrated) {
-        std::cout << "Migrator " << migratorName << " yet not migrated" << std::endl;
-        printStatus();
-        return EXIT_SUCCESS;
-    }
-
-    if (status == migration::MigratorStatus::NotKnown) {
-        std::cout << "Migrator " << migratorName << " not found" << std::endl;
-        printStatus();
-        return EXIT_FAILURE;
-    }
-
-    std::cout << "Running rollback for " << migratorName << std::endl;
-    migrationManager_->runRollback(migratorName);
-    std::cout << "Rollback for " << migratorName << " finished" << std::endl;
-    return EXIT_SUCCESS;
-}
-
 }  // namespace app