BugFix: Support different plugins to have the same name

Author: chhy2009

docs/en/plugin_management.md

@@ -92,6 +92,9 @@ tPPC-Cpp framework provides a set of solutions for plugin dependency management.
     public:
     /// @brief get the collection of plugins that this plugin depends on
     ///        dependent plugins need to be initialized first
+    /// @note If there are cases of dependencies with the same name (possible in cases where the types are
+    ///       different), the plugin_name needs to follow the following format: 'plugin_name#plugin_type', where
+    ///       plugin_name is the name of the plugin and plugin_type is the corresponding index of the plugin type.
     virtual void GetDependencies(std::vector<std::string>& plugin_names) const {}
     };
     ```

docs/zh/plugin_management.md

@@ -92,6 +92,9 @@ tPPC-Cpp 框架提供了一套插件依赖管理的方案：
     public:
     /// @brief get the collection of plugins that this plugin depends on
     ///        dependent plugins need to be initialized first
+    /// @note If there are cases of dependencies with the same name (possible in cases where the types are
+    ///       different), the plugin_name needs to follow the following format: 'plugin_name#plugin_type', where
+    ///       plugin_name is the name of the plugin and plugin_type is the corresponding index of the plugin type.
     virtual void GetDependencies(std::vector<std::string>& plugin_names) const {}
     };
     ```

trpc/client/client_context.h

@@ -390,7 +390,7 @@ class ClientContext : public RefCounted<ClientContext> {
   /// The request will be send directly to the address of remote service instance set by user after this function
   /// is called by user. The naming selector will be ignored.
   void SetAddr(const std::string& ip, uint16_t port) {
-    endpoint_info_.addr.ip = std::move(ip);
+    endpoint_info_.addr.ip = ip;
     endpoint_info_.addr.port = port;
     endpoint_info_.addr.addr_type =
         ip.find(':') != std::string::npos ? NodeAddr::AddrType::kIpV6 : NodeAddr::AddrType::kIpV4;

trpc/common/plugin.h

@@ -58,6 +58,9 @@ class Plugin : public RefCounted<Plugin> {
 
   /// @brief get the collection of plugins that this plugin depends on
   ///        dependent plugins need to be initialized first
+  /// @note If there are cases of dependencies with the same name (possible in cases where the types are
+  ///       different), the plugin_name needs to follow the following format: 'plugin_name#plugin_type', where
+  ///       plugin_name is the name of the plugin and plugin_type is the corresponding index of the plugin type.
   virtual void GetDependencies(std::vector<std::string>& plugin_names) const {}
 
   /// @brief init plugin

trpc/common/trpc_plugin.cc

@@ -161,7 +161,7 @@ void TrpcPlugin::InitPlugin(PluginInfo& plugin_info) {
   plugin_info.plugin->GetDependencies(dep_plugin_names);
   if (!dep_plugin_names.empty()) {
     for (const auto& name : dep_plugin_names) {
-      auto it = plugins_.find(name);
+      auto it = FindPlugin(name);
       if (it == plugins_.end()) {
         TRPC_FMT_ERROR("plugin `{}` dependence plugin `{}` not found.", plugin_info.plugin->Name(), name);
         TRPC_ASSERT(false);
@@ -200,7 +200,7 @@ void TrpcPlugin::StartPlugin(PluginInfo& plugin_info) {
   plugin_info.plugin->GetDependencies(dep_plugin_names);
   if (!dep_plugin_names.empty()) {
     for (const auto& name : dep_plugin_names) {
-      auto it = plugins_.find(name);
+      auto it = FindPlugin(name);
       TRPC_ASSERT(it != plugins_.end());
 
       StartPlugin(it->second);
@@ -261,7 +261,7 @@ void TrpcPlugin::StopPlugin(PluginInfo& plugin_info) {
   std::vector<std::string>& reverse_dep_plugin_names = plugins_reverse_deps_[plugin_info.plugin->Name()];
   if (!reverse_dep_plugin_names.empty()) {
     for (const auto& name : reverse_dep_plugin_names) {
-      auto it = plugins_.find(name);
+      auto it = FindPlugin(name);
       TRPC_ASSERT(it != plugins_.end());
 
       StopPlugin(it->second);
@@ -293,7 +293,7 @@ void TrpcPlugin::DestroyPlugin(PluginInfo& plugin_info) {
   std::vector<std::string>& reverse_dep_plugin_names = plugins_reverse_deps_[plugin_info.plugin->Name()];
   if (!reverse_dep_plugin_names.empty()) {
     for (const auto& name : reverse_dep_plugin_names) {
-      auto it = plugins_.find(name);
+      auto it = FindPlugin(name);
       TRPC_ASSERT(it != plugins_.end());
 
       DestroyPlugin(it->second);
@@ -305,6 +305,56 @@ void TrpcPlugin::DestroyPlugin(PluginInfo& plugin_info) {
   plugin_info.is_destroyed = true;
 }
 
+std::unordered_map<std::string, TrpcPlugin::PluginInfo>::iterator TrpcPlugin::FindPlugin(const std::string& name) {
+  auto it = plugins_.find(name);
+  if (it != plugins_.end()) {
+    return it;
+  }
+
+  std::unordered_map<std::string, TrpcPlugin::PluginInfo>::iterator match_it = plugins_.end();
+  bool already_match = false;
+  auto new_name = name + "#";
+  for (it = plugins_.begin(); it != plugins_.end(); ++it) {
+    auto& plugin_name = it->first;
+    if (!plugin_name.compare(0, new_name.size(), new_name)) {
+      if (already_match) {
+        TRPC_FMT_ERROR("Find multiple match {} plugins, you need specify the dependencies with the plugin_type", name);
+        TRPC_ASSERT(false && "Find multiple match plugins");
+      } else {
+        already_match = true;
+        match_it = it;
+      }
+    }
+  }
+
+  return match_it;
+}
+
+bool TrpcPlugin::IsDepPluginNameValid(const std::vector<std::string>& dep_plugin_names) {
+  bool ret = true;
+  for (auto& plugin_name : dep_plugin_names) {
+    auto pos = plugin_name.find_first_of("#");
+    if (pos == std::string::npos) {
+      continue;
+    }
+
+    // If it contains '#', then the string at the end should be PluginType.
+    auto str = plugin_name.substr(pos + 1);
+    try {
+      auto plugin_type = std::stoi(str);
+      if (plugin_type > static_cast<int>(PluginType::kUnspecified)) {
+        ret = false;
+        TRPC_FMT_ERROR("dependent plugin name {} invalid", plugin_name);
+      }
+    } catch (const std::exception&) {
+      ret = false;
+      TRPC_FMT_ERROR("dependent plugin name {} invalid", plugin_name);
+    }
+  }
+
+  return ret;
+}
+
 bool TrpcPlugin::RegisterServerCodec(const ServerCodecPtr& codec) {
   std::scoped_lock<std::mutex> lock(mutex_);
 

trpc/common/trpc_plugin.h

@@ -165,6 +165,8 @@ class TrpcPlugin {
   void StopPlugin(PluginInfo& plugin_info);
   void DestroyPlugins();
   void DestroyPlugin(PluginInfo& plugin_info);
+  std::unordered_map<std::string, PluginInfo>::iterator FindPlugin(const std::string& name);
+  bool IsDepPluginNameValid(const std::vector<std::string>& dep_plugin_names);
 
   template <typename T>
   bool AddPlugins(const std::unordered_map<std::string, T>& plugins) {
@@ -174,12 +176,15 @@ class TrpcPlugin {
       plugin_info.is_inited = false;
       plugin_info.is_destroyed = false;
 
-      plugins_.emplace(it.second->Name(), std::move(plugin_info));
+      std::string plugin_name = it.second->Name() + "#" + std::to_string(static_cast<int>(it.second->Type()));
+      plugins_.emplace(plugin_name, std::move(plugin_info));
 
       std::vector<std::string> dep_plugin_names;
       it.second->GetDependencies(dep_plugin_names);
+      // Check if the dependent plugin name is valid
+      TRPC_ASSERT(IsDepPluginNameValid(dep_plugin_names) && "Dependent plugin name invalid");
       for (auto& dep_plugin_name : dep_plugin_names) {
-        plugins_reverse_deps_[dep_plugin_name].push_back(it.second->Name());
+        plugins_reverse_deps_[dep_plugin_name].push_back(plugin_name);
       }
     }
 

trpc/naming/common/constants.h

@@ -18,5 +18,6 @@ namespace trpc::naming {
 /// Key of instance's metadata
 constexpr char kNodeSetName[] = "internal-set-name";
 constexpr char kNodeContainerName[] = "container_name";
+constexpr char kNodeInstanceId[] = "instance_id";
 
 }  // namespace trpc::naming

trpc/naming/selector_workflow.cc

@@ -159,7 +159,7 @@ void SelectorWorkFlow::SetBackupRequestAddrs(const ClientContextPtr& context,
     extend_addr.addr.port = ins.port;
     extend_addr.addr.addr_type = ins.is_ipv6 ? NodeAddr::AddrType::kIpV6 : NodeAddr::AddrType::kIpV4;
     if (has_metadata_) {
-      // extend_addr.metadata["instance_id"] = std::move(ins.meta["instance_id"]);
+      extend_addr.metadata[naming::kNodeInstanceId] = std::move(ins.meta[naming::kNodeInstanceId]);
       extend_addr.metadata[naming::kNodeSetName] = std::move(ins.meta[naming::kNodeSetName]);
       extend_addr.metadata[naming::kNodeContainerName] = std::move(ins.meta[naming::kNodeContainerName]);
     }