refactor(interactive): Add error handling for adhoc queries (#4188)

We Introduce boost::leaf for lightweight error handling in the
Interactive Ad Hoc Query Service.
For each operator, we refactor it returns a `bl::result` value, allowing
the error to be caught and returned at the most outside, i.e.
`adhoc_app.cc`.

In this PR, we only wrap the errors about `UNSUPPORTED` `UNIMPLEMENTED`
and `BAD_REQUET` at operator level. For lower level errors, we still let
it crash.

TBD:
- GAE depends on boost::leaf via vineyard, but we don't want to depend
on vineyard, so a new submodule is introduced, is this ok?

Fix #4189 


We will continue to resolve these `UNSUPPORTED` and `UNIMPLEMENTED`
errors, by covering all combination of all params and operators in
physical plan.
TODO #4190

.devcontainer/devcontainer.json

@@ -4,7 +4,7 @@
 {
 	"name": "GraphScope",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:latest",
+	"image": "registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.24.2-amd64",
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
     "features": {

.github/workflows/interactive.yml

@@ -28,7 +28,7 @@ jobs:
     runs-on: ubuntu-20.04
     if: ${{ github.repository == 'alibaba/GraphScope' }}
     container:
-      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.23.0
+      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.24.2-amd64
     steps:
     - uses: actions/checkout@v4
 
@@ -121,7 +121,6 @@ jobs:
         GS_TEST_DIR: ${{ github.workspace }}/gstest
         FLEX_DATA_DIR: ${{ github.workspace }}/flex/interactive/examples/modern_graph
         TMP_INTERACTIVE_WORKSPACE: /tmp/temp_workspace
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         rm -rf ${TMP_INTERACTIVE_WORKSPACE}
         cd ${GITHUB_WORKSPACE}/flex/build/
@@ -137,7 +136,6 @@ jobs:
       env: 
         FLEX_DATA_DIR: ${{ github.workspace }}/flex/interactive/examples/modern_graph
         TMP_INTERACTIVE_WORKSPACE: /tmp/temp_workspace
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         cd ${GITHUB_WORKSPACE}/flex/interactive/sdk/
 
@@ -210,7 +208,6 @@ jobs:
         TMP_INTERACTIVE_WORKSPACE: /tmp/temp_workspace
         PLUGIN_DIR: /tmp/temp_workspace/data/modern_graph/plugins
         FLEX_DATA_DIR: ${{ github.workspace }}/flex/interactive/examples/modern_graph
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         rm -rf ${TMP_INTERACTIVE_WORKSPACE}
         cd ${GITHUB_WORKSPACE}/flex/build/
@@ -271,7 +268,6 @@ jobs:
         GS_TEST_DIR: ${{ github.workspace }}/gstest
         HOME : /home/graphscope/
         INTERACTIVE_WORKSPACE: /tmp/interactive_workspace
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         cd ${GITHUB_WORKSPACE}/flex/tests/hqps/
         export ENGINE_TYPE=hiactor
@@ -285,7 +281,6 @@ jobs:
         GS_TEST_DIR: ${{ github.workspace }}/gstest
         HOME : /home/graphscope/
         INTERACTIVE_WORKSPACE: /tmp/interactive_workspace
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         cd ${GITHUB_WORKSPACE}/flex/tests/hqps/
         export ENGINE_TYPE=hiactor
@@ -299,7 +294,6 @@ jobs:
         GS_TEST_DIR: ${{ github.workspace }}/gstest
         HOME : /home/graphscope/
         INTERACTIVE_WORKSPACE: /tmp/interactive_workspace
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         cd ${GITHUB_WORKSPACE}/flex/tests/hqps/
         export ENGINE_TYPE=hiactor
@@ -313,7 +307,6 @@ jobs:
         GS_TEST_DIR: ${{ github.workspace }}/gstest
         HOME : /home/graphscope/
         INTERACTIVE_WORKSPACE: /tmp/interactive_workspace
-        LD_LIBRARY_PATH: /usr/local/lib
       run: |
         cd ${GITHUB_WORKSPACE}/flex/tests/hqps/
         export ENGINE_TYPE=hiactor
@@ -353,7 +346,7 @@ jobs:
   test-cmake-options:
     runs-on: ubuntu-20.04
     container:
-      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.23.0
+      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.24.2-amd64
     strategy:
       matrix:
         BUILD_TEST: [ON, OFF]
@@ -373,7 +366,7 @@ jobs:
   test-AOCC-compilation:
     runs-on: ubuntu-20.04
     container:
-      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.23.0
+      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.24.2-amd64
     steps:
     - uses: actions/checkout@v4
 
@@ -402,7 +395,7 @@ jobs:
     runs-on: ubuntu-20.04
     if: ${{ github.repository == 'alibaba/GraphScope' }}
     container:
-      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.23.0
+      image: registry.cn-hongkong.aliyuncs.com/graphscope/graphscope-dev:v0.24.2-amd64
     steps:
     - uses: actions/checkout@v4
 

flex/CMakeLists.txt

@@ -125,6 +125,7 @@ find_package(Boost REQUIRED COMPONENTS system filesystem
              # required by folly
              context program_options regex thread date_time)
 add_definitions("-DBOOST_BIND_GLOBAL_PLACEHOLDERS")
+include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
 
 #find hiactor----------------------------------------------------------------------
 find_package(Hiactor)

flex/bin/adhoc_runner.cc

@@ -23,6 +23,7 @@
 #include "flex/engines/graph_db/runtime/adhoc/runtime.h"
 
 namespace bpo = boost::program_options;
+namespace bl = boost::leaf;
 
 std::string read_pb(const std::string& filename) {
   std::ifstream file(filename, std::ios::binary);
@@ -74,6 +75,32 @@ void load_params(const std::string& filename,
   }
 }
 
+gs::runtime::Context eval_plan(
+    const physical::PhysicalPlan& plan, gs::ReadTransaction& txn,
+    const std::map<std::string, std::string>& params) {
+  gs::runtime::Context ctx;
+  {
+    ctx = bl::try_handle_all(
+        [&plan, &txn, &params]() {
+          return gs::runtime::runtime_eval(plan, txn, params);
+        },
+        [&ctx](const gs::Status& err) {
+          LOG(FATAL) << "Error in execution: " << err.error_message();
+          return ctx;
+        },
+        [&](const bl::error_info& err) {
+          LOG(FATAL) << "boost leaf error: " << err.error().value() << ", "
+                     << err.exception()->what();
+          return ctx;
+        },
+        [&]() {
+          LOG(FATAL) << "Unknown error in execution";
+          return ctx;
+        });
+  }
+  return ctx;
+}
+
 int main(int argc, char** argv) {
   bpo::options_description desc("Usage:");
   desc.add_options()("help", "Display help message")(
@@ -158,7 +185,7 @@ int main(int argc, char** argv) {
   double t1 = -grape::GetCurrentTime();
   for (int i = 0; i < query_num; ++i) {
     auto& m = map[i % params_num];
-    auto ctx = gs::runtime::runtime_eval(pb, txn, m);
+    auto ctx = eval_plan(pb, txn, m);
     gs::Encoder output(outputs[i]);
     gs::runtime::eval_sink(ctx, txn, output);
   }
@@ -167,7 +194,7 @@ int main(int argc, char** argv) {
   double t2 = -grape::GetCurrentTime();
   for (int i = 0; i < query_num; ++i) {
     auto& m = map[i % params_num];
-    auto ctx = gs::runtime::runtime_eval(pb, txn, m);
+    auto ctx = eval_plan(pb, txn, m);
     outputs[i].clear();
     gs::Encoder output(outputs[i]);
     gs::runtime::eval_sink(ctx, txn, output);
@@ -177,7 +204,7 @@ int main(int argc, char** argv) {
   double t3 = -grape::GetCurrentTime();
   for (int i = 0; i < query_num; ++i) {
     auto& m = map[i % params_num];
-    auto ctx = gs::runtime::runtime_eval(pb, txn, m);
+    auto ctx = eval_plan(pb, txn, m);
     outputs[i].clear();
     gs::Encoder output(outputs[i]);
     gs::runtime::eval_sink(ctx, txn, output);

flex/engines/graph_db/app/adhoc_app.cc

@@ -1,10 +1,27 @@
-#include "flex/engines/graph_db/app/adhoc_app.h"
+/** Copyright 2020 Alibaba Group Holding Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * 	http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
+#include "flex/engines/graph_db/app/adhoc_app.h"
 #include "flex/engines/graph_db/runtime/adhoc/operators/operators.h"
 #include "flex/engines/graph_db/runtime/adhoc/runtime.h"
-
 #include "flex/proto_generated_gie/physical.pb.h"
 
+#include <string>
+
+namespace bl = boost::leaf;
+
 namespace gs {
 
 bool AdhocReadApp::Query(const GraphDBSession& graph, Decoder& input,
@@ -20,7 +37,35 @@ bool AdhocReadApp::Query(const GraphDBSession& graph, Decoder& input,
 
   LOG(INFO) << "plan: " << plan.DebugString();
 
-  auto ctx = runtime::runtime_eval(plan, txn, {});
+  gs::runtime::Context ctx;
+  gs::Status status = gs::Status::OK();
+  {
+    ctx = bl::try_handle_all(
+        [&plan, &txn]() { return runtime::runtime_eval(plan, txn, {}); },
+        [&ctx, &status](const gs::Status& err) {
+          status = err;
+          return ctx;
+        },
+        [&](const bl::error_info& err) {
+          status = gs::Status(
+              gs::StatusCode::INTERNAL_ERROR,
+              "BOOST LEAF Error: " + std::to_string(err.error().value()) +
+                  ", Exception: " + err.exception()->what());
+          return ctx;
+        },
+        [&]() {
+          status = gs::Status(gs::StatusCode::UNKNOWN, "Unknown error");
+          return ctx;
+        });
+  }
+
+  if (!status.ok()) {
+    LOG(ERROR) << "Error: " << status.ToString();
+    // We encode the error message to the output, so that the client can
+    // get the error message.
+    output.put_string(status.ToString());
+    return false;
+  }
 
   runtime::eval_sink(ctx, txn, output);
 

flex/engines/graph_db/database/graph_db_session.cc

@@ -166,10 +166,20 @@ Result<std::vector<char>> GraphDBSession::Eval(const std::string& input) {
       std::chrono::duration_cast<std::chrono::microseconds>(end - start)
           .count());
   ++query_num_;
-  return Result<std::vector<char>>(
-      StatusCode::QUERY_FAILED,
-      "Query failed for procedure id:" + std::to_string((int) type),
-      result_buffer);
+  // When query failed, we assume the user may put the error message in the
+  // output buffer.
+  // For example, for adhoc_app.cc, if the query failed, the error info will
+  // be put in the output buffer.
+  if (result_buffer.size() > 0) {
+    return Result<std::vector<char>>(
+        StatusCode::QUERY_FAILED,
+        std::string{result_buffer.data(), result_buffer.size()}, result_buffer);
+  } else {
+    return Result<std::vector<char>>(
+        StatusCode::QUERY_FAILED,
+        "Query failed for procedure id:" + std::to_string((int) type),
+        result_buffer);
+  }
 }
 
 void GraphDBSession::GetAppInfo(Encoder& result) { db_.GetAppInfo(result); }

flex/engines/graph_db/runtime/CMakeLists.txt

@@ -6,6 +6,7 @@ install_flex_target(runtime_common)
 file(GLOB_RECURSE ADHOC_SOURCES "adhoc/*.cc")
 add_library(runtime_adhoc SHARED ${ADHOC_SOURCES})
 target_link_libraries(runtime_adhoc runtime_common)
+target_link_libraries(runtime_adhoc Boost::headers)
 install_flex_target(runtime_adhoc)
 
 

flex/engines/graph_db/runtime/adhoc/operators/dedup.cc

@@ -21,8 +21,8 @@ namespace gs {
 
 namespace runtime {
 
-Context eval_dedup(const algebra::Dedup& opr, const ReadTransaction& txn,
-                   Context&& ctx) {
+bl::result<Context> eval_dedup(const algebra::Dedup& opr,
+                               const ReadTransaction& txn, Context&& ctx) {
   std::vector<size_t> keys;
   std::vector<std::function<RTAny(size_t)>> vars;
   int keys_num = opr.keys_size();

flex/engines/graph_db/runtime/adhoc/operators/edge_expand.cc

@@ -23,10 +23,10 @@ namespace gs {
 
 namespace runtime {
 
-Context eval_edge_expand(const physical::EdgeExpand& opr,
-                         const ReadTransaction& txn, Context&& ctx,
-                         const std::map<std::string, std::string>& params,
-                         const physical::PhysicalOpr_MetaData& meta) {
+bl::result<Context> eval_edge_expand(
+    const physical::EdgeExpand& opr, const ReadTransaction& txn, Context&& ctx,
+    const std::map<std::string, std::string>& params,
+    const physical::PhysicalOpr_MetaData& meta) {
   int v_tag;
   if (!opr.has_v_tag()) {
     v_tag = -1;
@@ -49,7 +49,9 @@ Context eval_edge_expand(const physical::EdgeExpand& opr,
   if (opr.expand_opt() ==
       physical::EdgeExpand_ExpandOpt::EdgeExpand_ExpandOpt_VERTEX) {
     if (query_params.has_predicate()) {
-      LOG(FATAL) << "not support";
+      LOG(ERROR) << "edge expand vertex with predicate is not supported";
+      RETURN_UNSUPPORTED_ERROR(
+          "edge expand vertex with predicate is not supported");
     } else {
       EdgeExpandParams eep;
       eep.v_tag = v_tag;
@@ -82,7 +84,12 @@ Context eval_edge_expand(const physical::EdgeExpand& opr,
                                                        eep);
     }
   } else {
-    LOG(FATAL) << "not support";
+    LOG(ERROR) << "EdgeExpand with expand_opt: " << opr.expand_opt()
+               << " is "
+                  "not supported";
+    RETURN_UNSUPPORTED_ERROR(
+        "EdgeExpand with expand_opt is not supported: " +
+        std::to_string(static_cast<int>(opr.expand_opt())));
   }
   return ctx;
 }

flex/engines/graph_db/runtime/adhoc/operators/get_v.cc

@@ -39,9 +39,9 @@ VOpt parse_opt(const physical::GetV_VOpt& opt) {
   }
 }
 
-Context eval_get_v(const physical::GetV& opr, const ReadTransaction& txn,
-                   Context&& ctx,
-                   const std::map<std::string, std::string>& params) {
+bl::result<Context> eval_get_v(
+    const physical::GetV& opr, const ReadTransaction& txn, Context&& ctx,
+    const std::map<std::string, std::string>& params) {
   int tag = -1;
   if (opr.has_tag()) {
     tag = opr.tag().value();
@@ -76,7 +76,8 @@ Context eval_get_v(const physical::GetV& opr, const ReadTransaction& txn,
     }
   }
 
-  LOG(FATAL) << "not support";
+  LOG(ERROR) << "Unsupported GetV operation: " << opr.DebugString();
+  RETURN_UNSUPPORTED_ERROR("Unsupported GetV operation: " + opr.DebugString());
   return ctx;
 }