rename AdminCmd to JobType

vesoft-inc · Mar 17, 2022 · c8f10c3 · c8f10c3
1 parent a57acd0
commit c8f10c3
Show file tree

Hide file tree

Showing 39 changed files with 284 additions and 293 deletions.
diff --git a/src/clients/meta/MetaClient.cpp b/src/clients/meta/MetaClient.cpp
@@ -1149,10 +1149,10 @@ PartitionID MetaClient::partId(int32_t numParts, const VertexID id) const {
 }
 
 folly::Future<StatusOr<cpp2::AdminJobResult>> MetaClient::submitJob(
-    cpp2::AdminJobOp op, cpp2::AdminCmd cmd, std::vector<std::string> paras) {
+    cpp2::JobOp op, cpp2::JobType type, std::vector<std::string> paras) {
   cpp2::AdminJobReq req;
   req.op_ref() = op;
-  req.cmd_ref() = cmd;
+  req.type_ref() = type;
   req.paras_ref() = std::move(paras);
   folly::Promise<StatusOr<cpp2::AdminJobResult>> promise;
   auto future = promise.getFuture();

diff --git a/src/clients/meta/MetaClient.h b/src/clients/meta/MetaClient.h
@@ -252,8 +252,8 @@ class MetaClient {
     listener_ = nullptr;
   }
 
-  folly::Future<StatusOr<cpp2::AdminJobResult>> submitJob(cpp2::AdminJobOp op,
-                                                          cpp2::AdminCmd cmd,
+  folly::Future<StatusOr<cpp2::AdminJobResult>> submitJob(cpp2::JobOp op,
+                                                          cpp2::JobType type,
                                                           std::vector<std::string> paras);
 
   // Operations for parts

diff --git a/src/graph/executor/admin/SubmitJobExecutor.cpp b/src/graph/executor/admin/SubmitJobExecutor.cpp
@@ -20,12 +20,12 @@ folly::Future<Status> SubmitJobExecutor::execute() {
 
   auto *sjNode = asNode<SubmitJob>(node());
   auto jobOp = sjNode->jobOp();
-  auto cmd = sjNode->cmd();
+  auto jobType = sjNode->jobType();
   auto params = sjNode->params();
 
   return qctx()
       ->getMetaClient()
-      ->submitJob(jobOp, cmd, params)
+      ->submitJob(jobOp, jobType, params)
       .via(runner())
       .thenValue([jobOp, this](StatusOr<meta::cpp2::AdminJobResult> &&resp) {
         SCOPED_TIMER(&execTime_);
@@ -40,10 +40,10 @@ folly::Future<Status> SubmitJobExecutor::execute() {
       });
 }
 
-StatusOr<DataSet> SubmitJobExecutor::buildResult(meta::cpp2::AdminJobOp jobOp,
+StatusOr<DataSet> SubmitJobExecutor::buildResult(meta::cpp2::JobOp jobOp,
                                                  meta::cpp2::AdminJobResult &&resp) {
   switch (jobOp) {
-    case meta::cpp2::AdminJobOp::ADD: {
+    case meta::cpp2::JobOp::ADD: {
       nebula::DataSet v({"New Job Id"});
       DCHECK(resp.job_id_ref().has_value());
       if (!resp.job_id_ref().has_value()) {
@@ -52,7 +52,7 @@ StatusOr<DataSet> SubmitJobExecutor::buildResult(meta::cpp2::AdminJobOp jobOp,
       v.emplace_back(nebula::Row({*resp.job_id_ref()}));
       return v;
     }
-    case meta::cpp2::AdminJobOp::RECOVER: {
+    case meta::cpp2::JobOp::RECOVER: {
       nebula::DataSet v({"Recovered job num"});
       DCHECK(resp.recovered_job_num_ref().has_value());
       if (!resp.recovered_job_num_ref().has_value()) {
@@ -61,7 +61,7 @@ StatusOr<DataSet> SubmitJobExecutor::buildResult(meta::cpp2::AdminJobOp jobOp,
       v.emplace_back(nebula::Row({*resp.recovered_job_num_ref()}));
       return v;
     }
-    case meta::cpp2::AdminJobOp::SHOW: {
+    case meta::cpp2::JobOp::SHOW: {
       DCHECK(resp.job_desc_ref().has_value());
       if (!resp.job_desc_ref().has_value()) {
         return Status::Error("Response unexpected.");
@@ -73,7 +73,7 @@ StatusOr<DataSet> SubmitJobExecutor::buildResult(meta::cpp2::AdminJobOp jobOp,
       auto &jobDesc = *resp.job_desc_ref();
       return buildShowResultData(jobDesc.front(), *resp.get_task_desc());
     }
-    case meta::cpp2::AdminJobOp::SHOW_All: {
+    case meta::cpp2::JobOp::SHOW_All: {
       nebula::DataSet v({"Job Id", "Command", "Status", "Start Time", "Stop Time"});
       DCHECK(resp.job_desc_ref().has_value());
       if (!resp.job_desc_ref().has_value()) {
@@ -83,15 +83,15 @@ StatusOr<DataSet> SubmitJobExecutor::buildResult(meta::cpp2::AdminJobOp jobOp,
       for (const auto &jobDesc : jobsDesc) {
         v.emplace_back(nebula::Row({
             jobDesc.get_id(),
-            apache::thrift::util::enumNameSafe(jobDesc.get_cmd()),
+            apache::thrift::util::enumNameSafe(jobDesc.get_type()),
             apache::thrift::util::enumNameSafe(jobDesc.get_status()),
             convertJobTimestampToDateTime(jobDesc.get_start_time()),
             convertJobTimestampToDateTime(jobDesc.get_stop_time()),
         }));
       }
       return v;
     }
-    case meta::cpp2::AdminJobOp::STOP: {
+    case meta::cpp2::JobOp::STOP: {
       nebula::DataSet v({"Result"});
       v.emplace_back(nebula::Row({"Job stopped"}));
       return v;
@@ -109,16 +109,16 @@ Value SubmitJobExecutor::convertJobTimestampToDateTime(int64_t timestamp) {
 
 nebula::DataSet SubmitJobExecutor::buildShowResultData(
     const nebula::meta::cpp2::JobDesc &jd, const std::vector<nebula::meta::cpp2::TaskDesc> &td) {
-  if (jd.get_cmd() == meta::cpp2::AdminCmd::DATA_BALANCE ||
-      jd.get_cmd() == meta::cpp2::AdminCmd::ZONE_BALANCE) {
+  if (jd.get_type() == meta::cpp2::JobType::DATA_BALANCE ||
+      jd.get_type() == meta::cpp2::JobType::ZONE_BALANCE) {
     nebula::DataSet v(
         {"Job Id(spaceId:partId)", "Command(src->dst)", "Status", "Start Time", "Stop Time"});
     const auto &paras = jd.get_paras();
     size_t index = std::stoul(paras.back());
     uint32_t total = paras.size() - index - 1, succeeded = 0, failed = 0, inProgress = 0,
              invalid = 0;
     v.emplace_back(Row({jd.get_id(),
-                        apache::thrift::util::enumNameSafe(jd.get_cmd()),
+                        apache::thrift::util::enumNameSafe(jd.get_type()),
                         apache::thrift::util::enumNameSafe(jd.get_status()),
                         convertJobTimestampToDateTime(jd.get_start_time()).toString(),
                         convertJobTimestampToDateTime(jd.get_stop_time()).toString()}));
@@ -155,7 +155,7 @@ nebula::DataSet SubmitJobExecutor::buildShowResultData(
     nebula::DataSet v({"Job Id(TaskId)", "Command(Dest)", "Status", "Start Time", "Stop Time"});
     v.emplace_back(nebula::Row({
         jd.get_id(),
-        apache::thrift::util::enumNameSafe(jd.get_cmd()),
+        apache::thrift::util::enumNameSafe(jd.get_type()),
         apache::thrift::util::enumNameSafe(jd.get_status()),
         convertJobTimestampToDateTime(jd.get_start_time()),
         convertJobTimestampToDateTime(jd.get_stop_time()),

diff --git a/src/graph/executor/admin/SubmitJobExecutor.h b/src/graph/executor/admin/SubmitJobExecutor.h
@@ -20,7 +20,7 @@ class SubmitJobExecutor final : public Executor {
 
  private:
   FRIEND_TEST(JobTest, JobFinishTime);
-  StatusOr<DataSet> buildResult(meta::cpp2::AdminJobOp jobOp, meta::cpp2::AdminJobResult &&resp);
+  StatusOr<DataSet> buildResult(meta::cpp2::JobOp jobOp, meta::cpp2::AdminJobResult &&resp);
   Value convertJobTimestampToDateTime(int64_t timestamp);
   nebula::DataSet buildShowResultData(const nebula::meta::cpp2::JobDesc &jd,
                                       const std::vector<nebula::meta::cpp2::TaskDesc> &td);

diff --git a/src/graph/executor/test/JobTest.cpp b/src/graph/executor/test/JobTest.cpp
@@ -30,10 +30,10 @@ TEST_F(JobTest, JobFinishTime) {
 
     auto qctx = std::make_unique<QueryContext>();
     auto submitJob = SubmitJob::make(
-        qctx.get(), nullptr, meta::cpp2::AdminJobOp::SHOW, meta::cpp2::AdminCmd::UNKNOWN, {});
+        qctx.get(), nullptr, meta::cpp2::JobOp::SHOW, meta::cpp2::JobType::UNKNOWN, {});
     auto submitJobExe = std::make_unique<SubmitJobExecutor>(submitJob, qctx.get());
 
-    auto status = submitJobExe->buildResult(meta::cpp2::AdminJobOp::SHOW, std::move(resp));
+    auto status = submitJobExe->buildResult(meta::cpp2::JobOp::SHOW, std::move(resp));
     EXPECT_TRUE(status.ok());
     auto result = std::move(status).value();
     EXPECT_EQ(result.rows.size(), 2);
@@ -53,10 +53,10 @@ TEST_F(JobTest, JobFinishTime) {
 
     auto qctx = std::make_unique<QueryContext>();
     auto submitJob = SubmitJob::make(
-        qctx.get(), nullptr, meta::cpp2::AdminJobOp::SHOW_All, meta::cpp2::AdminCmd::UNKNOWN, {});
+        qctx.get(), nullptr, meta::cpp2::JobOp::SHOW_All, meta::cpp2::JobType::UNKNOWN, {});
     auto submitJobExe = std::make_unique<SubmitJobExecutor>(submitJob, qctx.get());
 
-    auto status = submitJobExe->buildResult(meta::cpp2::AdminJobOp::SHOW_All, std::move(resp));
+    auto status = submitJobExe->buildResult(meta::cpp2::JobOp::SHOW_All, std::move(resp));
     EXPECT_TRUE(status.ok());
     auto result = std::move(status).value();
     EXPECT_EQ(result.rows.size(), 1);

diff --git a/src/graph/planner/plan/Admin.cpp b/src/graph/planner/plan/Admin.cpp
@@ -176,7 +176,7 @@ std::unique_ptr<PlanNodeDescription> ListRoles::explain() const {
 std::unique_ptr<PlanNodeDescription> SubmitJob::explain() const {
   auto desc = SingleDependencyNode::explain();
   addDescription("operation", apache::thrift::util::enumNameSafe(op_), desc.get());
-  addDescription("command", apache::thrift::util::enumNameSafe(cmd_), desc.get());
+  addDescription("command", apache::thrift::util::enumNameSafe(type_), desc.get());
   addDescription("parameters", folly::toJson(util::toJson(params_)), desc.get());
   return desc;
 }

diff --git a/src/graph/planner/plan/Admin.h b/src/graph/planner/plan/Admin.h
@@ -908,21 +908,21 @@ class SubmitJob final : public SingleDependencyNode {
  public:
   static SubmitJob* make(QueryContext* qctx,
                          PlanNode* dep,
-                         meta::cpp2::AdminJobOp op,
-                         meta::cpp2::AdminCmd cmd,
+                         meta::cpp2::JobOp op,
+                         meta::cpp2::JobType cmd,
                          const std::vector<std::string>& params) {
     return qctx->objPool()->add(new SubmitJob(qctx, dep, op, cmd, params));
   }
 
   std::unique_ptr<PlanNodeDescription> explain() const override;
 
  public:
-  meta::cpp2::AdminJobOp jobOp() const {
+  meta::cpp2::JobOp jobOp() const {
     return op_;
   }
 
-  meta::cpp2::AdminCmd cmd() const {
-    return cmd_;
+  meta::cpp2::JobType jobType() const {
+    return type_;
   }
 
   const std::vector<std::string>& params() const {
@@ -932,14 +932,14 @@ class SubmitJob final : public SingleDependencyNode {
  private:
   SubmitJob(QueryContext* qctx,
             PlanNode* dep,
-            meta::cpp2::AdminJobOp op,
-            meta::cpp2::AdminCmd cmd,
+            meta::cpp2::JobOp op,
+            meta::cpp2::JobType type,
             const std::vector<std::string>& params)
-      : SingleDependencyNode(qctx, Kind::kSubmitJob, dep), op_(op), cmd_(cmd), params_(params) {}
+      : SingleDependencyNode(qctx, Kind::kSubmitJob, dep), op_(op), type_(type), params_(params) {}
 
  private:
-  meta::cpp2::AdminJobOp op_;
-  meta::cpp2::AdminCmd cmd_;
+  meta::cpp2::JobOp op_;
+  meta::cpp2::JobType type_;
   const std::vector<std::string> params_;
 };
 

diff --git a/src/graph/validator/AdminJobValidator.cpp b/src/graph/validator/AdminJobValidator.cpp
@@ -11,21 +11,21 @@ namespace nebula {
 namespace graph {
 
 Status AdminJobValidator::validateImpl() {
-  if (sentence_->getCmd() == meta::cpp2::AdminCmd::DATA_BALANCE ||
-      sentence_->getCmd() == meta::cpp2::AdminCmd::ZONE_BALANCE) {
+  if (sentence_->getJobType() == meta::cpp2::JobType::DATA_BALANCE ||
+      sentence_->getJobType() == meta::cpp2::JobType::ZONE_BALANCE) {
     return Status::SemanticError("Data balance not support");
   }
-  if (sentence_->getOp() == meta::cpp2::AdminJobOp::ADD) {
-    auto cmd = sentence_->getCmd();
+  if (sentence_->getOp() == meta::cpp2::JobOp::ADD) {
+    auto jobType = sentence_->getJobType();
     if (requireSpace()) {
       const auto &spaceInfo = vctx_->whichSpace();
       auto spaceId = spaceInfo.id;
       const auto &spaceName = spaceInfo.name;
       sentence_->addPara(spaceName);
 
-      if (cmd == meta::cpp2::AdminCmd::REBUILD_TAG_INDEX ||
-          cmd == meta::cpp2::AdminCmd::REBUILD_EDGE_INDEX) {
-        auto ret = cmd == meta::cpp2::AdminCmd::REBUILD_TAG_INDEX
+      if (jobType == meta::cpp2::JobType::REBUILD_TAG_INDEX ||
+          jobType == meta::cpp2::JobType::REBUILD_EDGE_INDEX) {
+        auto ret = jobType == meta::cpp2::JobType::REBUILD_TAG_INDEX
                        ? qctx()->indexMng()->getTagIndexes(spaceId)
                        : qctx()->indexMng()->getEdgeIndexes(spaceId);
         if (!ret.ok()) {
@@ -60,7 +60,7 @@ Status AdminJobValidator::validateImpl() {
 
 Status AdminJobValidator::toPlan() {
   auto *doNode = SubmitJob::make(
-      qctx_, nullptr, sentence_->getOp(), sentence_->getCmd(), sentence_->getParas());
+      qctx_, nullptr, sentence_->getOp(), sentence_->getJobType(), sentence_->getParas());
   root_ = doNode;
   tail_ = root_;
   return Status::OK();

diff --git a/src/graph/validator/AdminJobValidator.h b/src/graph/validator/AdminJobValidator.h
@@ -28,31 +28,31 @@ class AdminJobValidator final : public Validator {
 
   bool requireSpace() const {
     switch (sentence_->getOp()) {
-      case meta::cpp2::AdminJobOp::ADD:
-        switch (sentence_->getCmd()) {
+      case meta::cpp2::JobOp::ADD:
+        switch (sentence_->getJobType()) {
           // All jobs are space-level, except for the jobs that need to be refactored.
-          case meta::cpp2::AdminCmd::REBUILD_TAG_INDEX:
-          case meta::cpp2::AdminCmd::REBUILD_EDGE_INDEX:
-          case meta::cpp2::AdminCmd::REBUILD_FULLTEXT_INDEX:
-          case meta::cpp2::AdminCmd::STATS:
-          case meta::cpp2::AdminCmd::COMPACT:
-          case meta::cpp2::AdminCmd::FLUSH:
-          case meta::cpp2::AdminCmd::DATA_BALANCE:
-          case meta::cpp2::AdminCmd::LEADER_BALANCE:
-          case meta::cpp2::AdminCmd::ZONE_BALANCE:
+          case meta::cpp2::JobType::REBUILD_TAG_INDEX:
+          case meta::cpp2::JobType::REBUILD_EDGE_INDEX:
+          case meta::cpp2::JobType::REBUILD_FULLTEXT_INDEX:
+          case meta::cpp2::JobType::STATS:
+          case meta::cpp2::JobType::COMPACT:
+          case meta::cpp2::JobType::FLUSH:
+          case meta::cpp2::JobType::DATA_BALANCE:
+          case meta::cpp2::JobType::LEADER_BALANCE:
+          case meta::cpp2::JobType::ZONE_BALANCE:
             return true;
           // TODO: download and ingest need to be refactored to use the rpc protocol.
           // Currently they are using their own validator
-          case meta::cpp2::AdminCmd::DOWNLOAD:
-          case meta::cpp2::AdminCmd::INGEST:
-          case meta::cpp2::AdminCmd::UNKNOWN:
+          case meta::cpp2::JobType::DOWNLOAD:
+          case meta::cpp2::JobType::INGEST:
+          case meta::cpp2::JobType::UNKNOWN:
             return false;
         }
         break;
-      case meta::cpp2::AdminJobOp::SHOW_All:
-      case meta::cpp2::AdminJobOp::SHOW:
-      case meta::cpp2::AdminJobOp::STOP:
-      case meta::cpp2::AdminJobOp::RECOVER:
+      case meta::cpp2::JobOp::SHOW_All:
+      case meta::cpp2::JobOp::SHOW:
+      case meta::cpp2::JobOp::STOP:
+      case meta::cpp2::JobOp::RECOVER:
         return true;
     }
     return false;

diff --git a/src/interface/meta.thrift b/src/interface/meta.thrift
@@ -220,21 +220,15 @@ struct AlterSpaceReq {
 }
 
 // Job related data structures
-enum AdminJobOp {
+enum JobOp {
     ADD         = 0x01,
     SHOW_All    = 0x02,
     SHOW        = 0x03,
     STOP        = 0x04,
     RECOVER     = 0x05,
 } (cpp.enum_strict)
 
-struct AdminJobReq {
-    1: AdminJobOp       op,
-    2: AdminCmd         cmd,
-    3: list<binary>     paras,
-}
-
-enum AdminCmd {
+enum JobType {
     COMPACT                  = 0,
     FLUSH                    = 1,
     REBUILD_TAG_INDEX        = 2,
@@ -249,6 +243,12 @@ enum AdminCmd {
     UNKNOWN                  = 99,
 } (cpp.enum_strict)
 
+struct AdminJobReq {
+    1: JobOp            op,
+    2: JobType          type,
+    3: list<binary>     paras,
+}
+
 enum JobStatus {
     QUEUE           = 0x01,
     RUNNING         = 0x02,
@@ -260,7 +260,7 @@ enum JobStatus {
 
 struct JobDesc {
     1: i32              id,
-    2: AdminCmd         cmd,
+    2: JobType          type,
     3: list<string>     paras,
     4: JobStatus        status,
     5: i64              start_time,

diff --git a/src/interface/storage.thrift b/src/interface/storage.thrift
@@ -817,7 +817,7 @@ struct ListClusterInfoReq {
 
 struct AddTaskRequest {
     // Task distributed to storage to execute, e.g. flush, compact, stats, etc.
-    1: meta.AdminCmd                        cmd
+    1: meta.JobType                         job_type
     2: i32                                  job_id
     3: i32                                  task_id
     4: TaskPara                             para

diff --git a/src/meta/processors/admin/AdminClient.cpp b/src/meta/processors/admin/AdminClient.cpp
@@ -755,7 +755,7 @@ folly::Future<StatusOr<bool>> AdminClient::blockingWrites(const std::set<GraphSp
 }
 
 folly::Future<StatusOr<bool>> AdminClient::addTask(
-    cpp2::AdminCmd cmd,
+    cpp2::JobType type,
     int32_t jobId,
     int32_t taskId,
     GraphSpaceID spaceId,
@@ -767,7 +767,7 @@ folly::Future<StatusOr<bool>> AdminClient::addTask(
   auto adminAddr = Utils::getAdminAddrFromStoreAddr(host);
 
   storage::cpp2::AddTaskRequest req;
-  req.cmd_ref() = cmd;
+  req.job_type_ref() = type;
   req.job_id_ref() = jobId;
   req.task_id_ref() = taskId;
 

diff --git a/src/meta/processors/admin/AdminClient.h b/src/meta/processors/admin/AdminClient.h
@@ -216,7 +216,7 @@ class AdminClient {
    * @param parts
    * @return folly::Future<StatusOr<bool>> Return true if succeed, else return an error status
    */
-  virtual folly::Future<StatusOr<bool>> addTask(cpp2::AdminCmd cmd,
+  virtual folly::Future<StatusOr<bool>> addTask(cpp2::JobType jobType,
                                                 int32_t jobId,
                                                 int32_t taskId,
                                                 GraphSpaceID spaceId,