add NodeDiscovery to fetch alive node information (#81)

* add NodeDiscovery to fetch alive node information

* update generated java and python code

* psi node register serviceMeta to gateway

* model service register service inforamtion

* support update-meta at runtime

* fix fetch psi file when use_psi is false

Author: cyjseagull

.github/workflows/cpp_toolkit_workflow.yml

@@ -39,12 +39,6 @@ jobs:
         with:
           toolchain: nightly-2022-07-28
           override: true
-      - name: Prepare python
-        if: runner.os == 'Windows'
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.8'
-          cache: 'pip'
       - name: Prepare vcpkg
         if: runner.os != 'Windows'
         uses: friendlyanon/setup-vcpkg@v1
@@ -70,7 +64,7 @@ jobs:
       - name: Build for windows
         if: runner.os == 'Windows'
         run: |
-          mkdir -p cpp/build && cd cpp/build && cmake -G "Visual Studio 16 2019" -A x64 -DBUILD_PYTHON=ON -DCMAKE_BUILD_TYPE=Release -DTESTS=OFF -DBUILD_WEDPR_TOOLKIT=ON -DVCPKG_TARGET_TRIPLET=x64-windows-static -DVCPKG_HOST_TRIPLET=x64-windows-static  -DCMAKE_TOOLCHAIN_FILE=c:/vcpkg/scripts/buildsystems/vcpkg.cmake .. && MSBuild /version && MSBuild WeDPR-Component.sln /p:Configuration=Release /p:Platform=x64
+          mkdir -p cpp/build && cd cpp/build && cmake -G "Visual Studio 16 2019" -A x64 -DBUILD_PYTHON=OFF -DCMAKE_BUILD_TYPE=Release -DTESTS=OFF -DBUILD_WEDPR_TOOLKIT=ON -DVCPKG_TARGET_TRIPLET=x64-windows-static -DVCPKG_HOST_TRIPLET=x64-windows-static  -DCMAKE_TOOLCHAIN_FILE=c:/vcpkg/scripts/buildsystems/vcpkg.cmake .. && MSBuild /version && MSBuild WeDPR-Component.sln /p:Configuration=Release /p:Platform=x64
       - name: Build for linux
         if: runner.os == 'Linux'
         run: |

cpp/ppc-framework/front/FrontConfig.h

@@ -77,13 +77,17 @@ class FrontConfig
 
     std::vector<std::string>& mutableComponents() { return m_components; }
 
+    std::string const meta() const { return m_meta; }
+    void setMeta(std::string meta) { m_meta = std::move(meta); }
+
 protected:
     ppc::protocol::GrpcConfig::Ptr m_grpcConfig;
     ppc::protocol::EndPoint m_selfEndPoint;
     int m_threadPoolSize;
     std::string m_nodeID;
     std::string m_gatewayGrpcTarget;
     std::vector<std::string> m_components;
+    std::string m_meta;
 };
 
 class FrontConfigBuilder

cpp/ppc-framework/front/IFront.h

@@ -19,6 +19,7 @@
  */
 #pragma once
 #include "FrontConfig.h"
+#include "INodeDiscovery.h"
 #include "ppc-framework/protocol/Handler.h"
 #include "ppc-framework/protocol/INodeInfo.h"
 #include "ppc-framework/protocol/Message.h"
@@ -256,10 +257,14 @@ class IFront : virtual public IFrontClient
     virtual void registerComponent(std::string const& component) = 0;
     virtual void unRegisterComponent(std::string const& component) = 0;
 
+    virtual void updateMetaInfo(std::string const& meta) = 0;
+
     // get the target nodeList according to the routeInfo
     virtual std::vector<std::string> selectNodesByRoutePolicy(
         int16_t routeType, ppc::protocol::MessageOptionalHeader::Ptr const& routeInfo) = 0;
 
+    virtual INodeDiscovery::Ptr const getNodeDiscovery() = 0;
+
 private:
     ppc::protocol::ReceiveMsgFunc populateErrorCallback(ErrorCallback::Ptr errorCallback)
     {

cpp/ppc-framework/front/INodeDiscovery.h

@@ -0,0 +1,39 @@
+/**
+ *  Copyright (C) 2023 WeDPR.
+ *  SPDX-License-Identifier: Apache-2.0
+ *  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.
+ *
+ * @file INodeDiscovery.h
+ * @author: yujiechen
+ * @date 2024-11-06
+ */
+#pragma once
+#include "ppc-framework/protocol/INodeInfo.h"
+#include <memory>
+
+namespace ppc::front
+{
+class INodeDiscovery
+{
+public:
+    using Ptr = std::shared_ptr<INodeDiscovery>;
+    INodeDiscovery() = default;
+    virtual ~INodeDiscovery() = default;
+
+    virtual void start() = 0;
+    virtual void stop() = 0;
+
+    // Note: use std::shared_ptr here for swig wrapper
+    virtual std::vector<std::shared_ptr<ppc::protocol::INodeInfo>> getAliveNodeList() const = 0;
+};
+}  // namespace ppc::front

cpp/ppc-framework/gateway/IGateway.h

@@ -79,6 +79,8 @@ class IGateway
     // get the target nodeList according to the routeInfo
     virtual std::vector<std::string> selectNodesByRoutePolicy(ppc::protocol::RouteType routeType,
         ppc::protocol::MessageOptionalHeader::Ptr const& routeInfo) = 0;
+
+    virtual std::vector<ppc::protocol::INodeInfo::Ptr> getAliveNodeList() const = 0;
 };
 
 }  // namespace ppc::gateway

cpp/ppc-framework/protocol/INodeInfo.h

@@ -61,10 +61,12 @@ class INodeInfo
 
     virtual bool equal(INodeInfo::Ptr const& info)
     {
-        return (nodeID().toBytes() == info->nodeID().toBytes()) &&
-               (copiedComponents() == info->copiedComponents());
+        return (nodeID().toBytes() == info->nodeID().toBytes()) && (endPoint() == info->endPoint());
     }
 
+    virtual std::string meta() const = 0;
+    // the node meta information
+    virtual void setMeta(std::string const& meta) = 0;
     virtual void toJson(Json::Value& jsonObject) const = 0;
 };
 class INodeInfoFactory
@@ -93,7 +95,7 @@ inline std::string printNodeInfo(INodeInfo::Ptr const& nodeInfo)
     {
         components = components + it + ",";
     }
-    stringstream << LOG_KV("components", components);
+    stringstream << LOG_KV("components", components) << LOG_KV("meta", nodeInfo->meta());
     return stringstream.str();
 }
 }  // namespace ppc::protocol

cpp/ppc-framework/protocol/Protocol.h

@@ -481,18 +481,4 @@ struct FileInfo
         return oss.str();
     }
 };
-
-const std::string FRONT_NAME = "Front";
-const std::string FRONT_SERVANT_NAME = "FrontServiceObj";
-const std::string FRONT_SERVICE_NAME = "FrontService";
-
-const std::string GATEWAY_NAME = "Gateway";
-const std::string GATEWAY_SERVANT_NAME = "GatewayServiceObj";
-const std::string GATEWAY_SERVICE_NAME = "GatewayService";
-
-inline std::string getPrxDesc(std::string const& _serviceName, std::string const& _objName)
-{
-    return _serviceName + "." + _objName;
-}
-
 }  // namespace ppc::protocol

cpp/ppc-framework/protocol/RouteType.h

@@ -54,4 +54,4 @@ inline std::ostream& operator<<(std::ostream& _out, RouteType const& _type)
     }
     return _out;
 }
-}  // namespace ppc::protocol
+}  // namespace ppc::protocol

cpp/ppc-framework/protocol/ServiceType.h

@@ -0,0 +1,29 @@
+/**
+ *  Copyright (C) 2023 WeDPR.
+ *  SPDX-License-Identifier: Apache-2.0
+ *  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.
+ *
+ * @file ServiceType.h
+ * @author: yujiechen
+ * @date 2024-11-07
+ */
+
+#pragma once
+#include <sstream>
+#include <string>
+
+namespace ppc::protocol
+{
+const static std::string PSI_SERVICE_TYPE = "PSI";
+const static std::string MPC_SERVICE_TYPE = "MPC";
+}  // namespace ppc::protocol

cpp/wedpr-helper/ppc-tools/src/config/PPCConfig.cpp

@@ -156,7 +156,6 @@ void PPCConfig::loadFrontConfig(bool requireTransport,
     // the components
     auto components = pt.get<std::string>("transport.components", "");
     boost::split(m_frontConfig->mutableComponents(), components, boost::is_any_of(","));
-
     PPCConfig_LOG(INFO) << LOG_DESC("loadFrontConfig") << printFrontDesc(m_frontConfig);
 }